支持的版本: 当前 (17) / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4

J.3. 使用 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. 手册页 #

我们使用 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)的系统上,由于交换,构建要么非常慢,要么根本不起作用。

在其默认配置中,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. 语法检查 #

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

doc/src/sgml$ make check

提交更正

如果您在文档中看到任何不正确、与您使用特定功能的经验不符或需要进一步澄清的内容,请使用 此表格报告文档问题。