J.2.工具集

以下工具用于处理文档。如前所述,有些可能是可选的。

  • DocBook DTD

    • 这是 DocBook 本身的定义。我们目前使用的是 4.2 版;您不能使用更高或更低的版本。您需要 DocBook DTD 的 XML 变体,而不是 SGML 变体。
  • DocBook XSL 样式表

    • 这些包含将 DocBook 源转换为其他格式(例如 HTML)的处理说明。

当前最低要求的版本是 1.77.0,但是建议使用最新的可用版本以获得最佳效果。

  • Libxml2 xmllint

    • 该库及其包含的xmllint工具用于处理 XML。许多开发人员已经安装了 Libxml2,因为在构建 PostgreSQL 代码时也会使用它。但是请注意,xmllint可能需要从单独的子软件包中安装。
  • Libxslt xsltproc

    • xsltproc是 XSLT 处理器,即使用 XSLT 样式表将 XML 转换为其他格式的程序。
  • FOP

    • 这是一个用于将 XML 转换为 PDF 的程序。

我们已经记录了处理各种文档所需的各种工具的几种安装方法的经验。这些将在下面描述。这些工具可能还有其他打包的发行版。请将包裹状态报告给文档邮件列表,我们将在此处提供该信息。

您可以不必在本地安装 DocBook XML 和 DocBook XSLT 样式表,因为所需的文件将从 Internet 下载并本地缓存。如果您的 os 软件包仅提供了旧版本(尤其是样式表),或者根本没有软件包,则实际上这可能是首选解决方案。有关更多信息,请参见xmllintxsltproc--nonet选项。

J.2.1. 在 Fedora,RHEL 和衍生产品上安装

要安装所需的软件包,请使用:

yum install docbook-dtds docbook-style-xsl fop libxslt

J.2.2. 在 FreeBSD 上安装

要使用pkg安装必需的软件包,请使用:

pkg install docbook-xml docbook-xsl fop libxslt

当从doc目录构建文档时,您将需要使用gmake,因为提供的 makefile 不适合 FreeBSD 的make

J.2.3. Debian 软件包

有可用于 Debian GNU/Linux 的全套文档工具包。要安装,只需使用:

apt-get install docbook-xml docbook-xsl fop libxml2-utils xsltproc

J.2.4. macOS

在 macOS 上,您可以构建 HTML 和 man 文档而无需额外安装。如果要生成 PDF 或要安装 DocBook 的本地副本,则可以从首选的程序包 Management 器中获取。

如果您使用 MacPorts,则可以通过以下步骤进行设置:

sudo port install docbook-xml-4.2 docbook-xsl fop

如果您使用自制软件,请使用以下命令:

brew install docbook docbook-xsl fop

J.2.5. 通过配置检测

在生成文档之前,需要像在构建 PostgreSQL 程序本身一样运行configure脚本。在运行即将结束时检查输出,它应该看起来像这样:

checking for xmllint... xmllint
checking for DocBook XML V4.2... yes
checking for dbtoepub... dbtoepub
checking for xsltproc... xsltproc
checking for fop... fop

如果未找到xmllint,则将跳过以下某些测试。