在设置好一切后,切换到目录 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
页面转换为适合 man pages 的 *roff 输出。要创建 man pages,请使用命令
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。
如果您在文档中发现任何不正确、与您对特定功能的体验不符或需要进一步澄清的内容,请使用 此表单 报告文档问题。