PostgreSQL 13.1 中文入门教程 PostgreSQL 编译文档

2024-02-25 开发教程 PostgreSQL 13.1 中文入门教程匿名 1℃

一旦你把所有的东西都设置好以后，切换到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版本，可以使用下列命令之一，取决于你喜欢的纸张格式：

因为PostgreSQL文档很大，FOP会要求可观的内存量。因此，在一些系统上，构建过程将会由于内存相关的错误而失败。通常可以通过在配置文件~/.foprc中配置Java的堆设置来解决这类问题，例如：

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

这是所要求的最小内存量，当然更多的内存会让编译过程更快一些。在内存非常小（小于1GB）的系统上，编译过程会因为磁盘交换而非常慢或者根本就不工作。

也可以手工使用其他XSL-FO处理器，但是自动编译过程仅支持FOP。

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

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

编译文档可能会花很长时间。但是有办法只检查文档中的语法，这个过程只需要数秒：

doc/src/sgml$ make check