# J.3.构建文档

J.3.1.HTMLJ.3.2.手册页J.3.3.PDFJ.3.4.纯文本文件J.3.5.语法检查

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

# J.3.1.HTML

要生成文档的HTML版本,请执行以下操作:

doc/src/sgml$ make html

这也是默认目标。输出显示在子目录中html.

使用上使用的样式表生成HTML文档postgresql。组织 (opens new window)使用以下选项代替默认的简单样式:

doc/src/sgml$ make STYLE=website html

如果风格=网站选项时,生成的HTML文件包括对托管在上的样式表的引用postgresql。组织 (opens new window)并且需要网络访问才能查看。

# J.3.2.手册页

我们使用DocBook XSL样式表来转换DocBook参考条目页数至*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将需要大量内存。因此,在某些系统上,构建将失败,并显示与内存相关的错误消息。这通常可以通过在配置文件中配置Java堆设置来解决~/.foprc,例如:

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

所需的内存量是最小的,在某种程度上,更多的内存似乎会让事情变得更快。在内存非常少(小于1GB)的系统上,由于交换,构建速度会非常慢,或者根本无法工作。

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

# J.3.4.纯文本文件

安装说明也以纯文本形式分发,以防在没有更好的阅读工具的情况下需要。这个安装文件对应于第17章,并因应不同的环境作了一些小的改动。要重新创建文件,请切换到目录doc/src/sgml然后进去**制作安装**.生成文本输出需要Pandoc 1.13版或更高版本作为附加生成工具。

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

# J.3.5.语法检查

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

doc/src/sgml$ make check