Postgresql 中文操作指南

J.3. Building the Documentation with Make #

设置好一切后,切换到 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

如果使用了 _STYLE=website_选项,生成的 HTML 文件将包含对托管在 postgresql.org上的样式表的引用,并且需要网络访问权限才能查看这些文件。

J.3.2. Manpages #

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

doc/src/sgml$ make man

J.3.3. PDF #

要使用 FOP 制作文档的 PDF 版本,您可以根据首选纸张格式使用以下命令之一:

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

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

需要最少的内存量,而且在某种程度上,更多的内存似乎能让事情更快一些。在内存非常低(少于 1 GB)的系统上,构建速度会因交换而非常慢,甚至根本无法工作。

FOP 在其默认配置中将为每一页发出 INFO 消息。日志级别可通过 ~/.foprc 更改:

LOGCHOICE=-Dorg.apache.commons.logging.Log=​org.apache.commons.logging.impl.SimpleLog
LOGLEVEL=-Dorg.apache.commons.logging.simplelog.defaultlog=WARN

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

J.3.4. Plain Text Files #

安装说明也以纯文本形式分发,以备在无法使用更好的阅读工具的情况下使用。 INSTALL 文件对应于 Chapter 17 ,对其进行了某些小改动以解决不同的上下文。若要重新创建此文件,请切换到目录 doc/src/sgml 并输入 make INSTALL 。生成文本输出需要使用 Pandoc 版本 1.13 或更高版本作为附加的构建工具。

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

J.3.5. Syntax Check #

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

doc/src/sgml$ make check