Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / 17

J.3. 使用 Make 构建文档 #

J.3.1. HTML
J.3.2. 手册页
J.3.3. PDF
J.3.4. 语法检查

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

J.3.1. HTML #

若要构建HTML版本的文档

doc/src/sgml$ make html

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

若要使用 html 中使用的样式表而不是默认的简单样式来生成 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