一旦您完成了所有设置,请切换到目录 doc/src/sgml
并运行以下小节中描述的命令之一来构建文档。(请记住使用 GNU make。)
要构建HTML版本的文档
doc/src/sgml$
make html
这也是默认目标。输出出现在子目录 html
中。
要使用在 postgresql.org 上使用的样式表而不是默认的简单样式生成 HTML 文档,请使用
doc/src/sgml$
make STYLE=website html
如果使用了 STYLE=website
选项,则生成的 HTML 文件包含对 postgresql.org 上托管的样式表的引用,并且需要网络访问才能查看。
我们使用 DocBook XSL 样式表将 DocBook refentry
页面转换为适用于手册页的 *roff 输出。要创建手册页,请使用以下命令
doc/src/sgml$
make man
要使用 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)上,构建要么由于交换而非常缓慢,要么根本无法工作。
在默认配置中,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。
如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符,或者需要进一步澄清,请使用 此表单 报告文档问题。