9.3 9.4 9.5 9.6 10 11 12 13 14
阿里云PostgreSQL 问题报告 纠错本页面

J.3. 编译文档

J.3.1. HTML
J.3.2. 手册页
J.3.3. PDF
J.3.4. Plain Text Files
J.3.5. 语法检查

一旦你把所有的东西都设置好以后,切换到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

J.3.2. 手册页

我们使用 DocBook XSL 样式表来把DocBook refentry页转换成适合于手册页的 *roff 输出。和HTML版本相似,手册页也是以一个 tar 档案被发布的。要创建手册页,使用命令:

doc/src/sgml$ make man

J.3.3. PDF

要使用FOP产生一个本文档的PDF形式,你可以使用下列命令之一, 取决于首选的页面格式:

  • 对于 A4 格式:

    doc/src/sgml$ make postgres-A4.pdf

  • 对于 U.S. 信纸格式:

    doc/src/sgml$ make postgres-US.pdf

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

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

这是所需的最小内存量,并且在一定程度上更多的内存似乎使事情变得更快。 在内存很小(小于1 GB)的系统上,由于交换,构建将会非常缓慢或根本无法工作。

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

J.3.4. Plain Text Files

安装指导也被发布为纯文本,它们被用于那些没有好的阅读工具的情况。INSTALL文件对应于第 16 章,但针对不同的环境做了小幅修改。要重建该文件,切换到目录doc/src/sgml并输入make INSTALL

在过去,发行注记和回归测试指导也被作为纯文本发布,但是事实上已经没有这样做了。

J.3.5. 语法检查

便以文档可能会花很长时间。但是有办法只检查文档中的语法,这个过程只需要数秒:

doc/src/sgml$ make check