选择 打开 改范围 完整检索页
受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10
当前 PostgreSQL 版本不在支持生命周期内。
您可以参阅当前版本的对应页面,或其他在上面列出的活跃大版本。

J.3. 使用 Make 构建文档 #

一切设置妥当后,切换到doc/src/sgml目录,并运行后续各小节中介绍的某个命令来构建文档。 (记得使用 GNU make。)

J.3.1. HTML

要构建文档的HTML版本:

doc/src/sgml$ make html

这也是默认目标。输出位于子目录html中。

要生成 HTML 文档,并采用以下站点使用的样式表:postgresql.org,以替代默认的简单样式,请使用:

doc/src/sgml$ make STYLE=website html

如果使用STYLE=website选项,生成的 HTML 文件会引用托管在postgresql.org上的样式表,查看时需要访问网络。

J.3.2. 手册页

我们使用 DocBook XSL 样式表转换DocBook refentry页面,生成适用于手册页的 *roff 输出。要创建手册页,请使用以下命令:

doc/src/sgml$ make man

J.3.3. PDF

要生成 PDF 格式的文档,可以使用FOP,并根据所需纸张格式,选择以下命令之一:

  • 对于 A4 格式:

    doc/src/sgml$ make postgres-A4.pdf
    
  • 对于美国信纸格式:

    doc/src/sgml$ make postgres-US.pdf
    

由于 PostgreSQL 文档相当庞大,FOP需要大量内存。因此,在某些系统上,构建会失败并报告与内存有关的错误。通常可以通过在以下配置文件中调整 Java 堆设置来解决此问题:~/.foprc,例如:

# FOP binary distribution
FOP_OPTS='-Xmx1500m'
# Debian
JAVA_ARGS='-Xmx1500m'
# Red Hat
ADDITIONAL_FLAGS='-Xmx1500m'

所需内存存在一个最低限度,而在一定范围内,更多内存似乎能使构建稍快一些。在内存很少(不足 1 GB)的系统上,构建要么因交换而非常缓慢,要么根本无法进行。

其他 XSL-FO 处理器也可以手动使用,但自动构建过程只支持 FOP。

J.3.4. 纯文本文件

安装说明也以纯文本形式分发,以便在没有更好阅读工具的情况下使用。INSTALL文件对应于Chapter 16,仅为适应不同语境作了一些小改动。要重新创建该文件,请切换到doc/src/sgml目录并输入make INSTALL。构建文本输出还需要Pandoc 1.13 或更新版本作为额外的构建工具。

过去,发布说明和回归测试说明也以纯文本形式分发,但这种做法已经停止。

J.3.5. 语法检查

构建文档可能耗时很长。但有一种方法可以只检查文档文件的语法是否正确,只需几秒钟:

doc/src/sgml$ make check