J.3.构建文件

完成所有设置后,请转到目录doc/src/sgml并运行以下小节中描述的命令之一来构建文档。 (请记住使用 GNU make.)

J.3.1. HTML

要构建文档的 HTML 版本:

doc/src/sgml$ make html

这也是默认目标。输出出现在子目录html中。

要使用postgresql.org上使用的样式表而不是默认的简单样式来生成 HTML 文档,请使用:

doc/src/sgml$ make STYLE=website html

J.3.2. Manpages

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

doc/src/sgml$ make man

J.3.3. PDF

要使用 FOP 生成文档的 PDF 副本,您可以使用以下命令之一,具体取决于首选的纸张格式:

  • 对于 A4 格式:
doc/src/sgml$ make postgres-A4.pdf
  • 对于美国字母格式:
doc/src/sgml$ make postgres-US.pdf

由于 PostgreSQL 文档很大,因此 FOP 将需要大量内存。因此,在某些系统上,构建将失败,并显示与内存相关的错误消息。通常可以通过在配置文件~/.foprc中配置 Java 堆设置来解决此问题,例如:

# 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并 Importing make INSTALL

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

J.3.5. 语法检查

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

doc/src/sgml$ make check