下面的工具用于处理此文档。如标注所示,有些工具可能是可选的。
这是 DocBook 本身的定义。我们目前使用版本 4.5;你不能使用更新或者更早的版本。你需要 DocBook DTD 的XML变体,而不是SGML变体。
这些包含了将 DocBook 源码转换到其他格式(如HTML)所要用的处理指令。
最低要求的版本当前是 1.77.0,但推荐使用最新可用的版本来得到最好的结果。
xmllint
的Libxml2
这个库和它所包含的xmllint
工具被用来处理 XML。
很多开发者将已经安装了Libxml2,因为在编译
PostgreSQL 代码时就已经用到它了。不过要注意,可能需要从一个独立的包中
安装xmllint
。
xsltproc
的Libxslt
xsltproc
是一个XSLT处理器,也就是说它是一个使用XSLT将XML转换成其他格式的程序。
这是一个在其他东西中将XML转换为PDF的程序。
我们已经在文档中记录了几种安装处理此文档所需的各种工具的方法。它们将在下文中描述。也可能有这些工具的其他打包发布。请向文档邮件列表报告那些包的状态,我们就会在这里包括它们的信息。
你可以在本地不安装DocBook XML和DocBook XSLT样式表的情况下开始工作,因为所需的文件将从Internet下载下来并且缓存在本地。
如果你的操作系统包仅提供这些文件的旧版本,或者根本没有可用的包,则这实际上可能是首选解决方案。
如果你想在构建文档时阻止任何访问Internet的尝试,你需要将--nonet
选项传递给xmllint
和xsltproc
;参见下面的示例。
要安装所需的包,可使用:
yum install docbook-dtds docbook-style-xsl fop libxslt
要用pkg
安装所需的包,可以使用:
pkg install docbook-xml docbook-xsl fop libxslt
在从doc
目录构建文档时,你会需要用到gmake
,因为所提供的makefile不适合于FreeBSD的make
。
Debian GNU/Linux也有一整套可以用的文档工具包。要安装,只需简单地使用:
apt-get install docbook-xml docbook-xsl fop libxml2-utils xsltproc
在macOS上,你可以不安装任何额外的东西就编译HTML和man文档。如果你想要编译PDF或者想要安装DocBook的本地拷贝,可以采用你喜欢的包管理器来得到它们。
如果使用MacPorts,下面的命令会帮你准备好一切:
sudo port install docbook-xml-4.5 docbook-xsl fop
如果使用的是Homebrew,就用这个:
brew install docbook docbook-xsl fop
configure
检测
在你能编译文档之前,你需要运行configure
脚本,就像你在编译PostgreSQL程序本身时所作的那样。
检查运行末尾附近的输出;它应该看起来像这样:
checking for xmllint... xmllint checking for xsltproc... xsltproc checking for fop... fop checking for dbtoepub... dbtoepub
如果没有找到xmllint
或 xsltproc
,你将不能构建任何文档。
fop
仅在构建PDF格式的文档时需要。
dbtoepub
仅在构建EPUB格式的文档时需要。
如果需要,你可以告诉configure
到哪里去找这些程序,例如
./configure ... XMLLINT=/opt/local/bin/xmllint ...
另外,如果你想确保xmllint
和xsltproc
不会执行任何网络访问,你可以如下操作
./configure ... XMLLINT="xmllint --nonet" XSLTPROC="xsltproc --nonet" ...