The following tools are used to process the documentation. Some might be optional, as noted. 文書を処理する過程で次のようなツールが使われます。 そのうちのいくつかは付記されているように省略しても構いません。
This is the definition of DocBook itself. We currently use version 4.5; you cannot use later or earlier versions. You need the <acronym>XML</acronym> variant of the DocBook DTD, not the <acronym>SGML</acronym> variant. DocBookそのものの定義です。 現在はバージョン4.5を使用しており、これより古いまたは新しいバージョンは使用できません。 DocBook DTDのSGML対応版ではなく、XML対応版が必要です。
These contain the processing instructions for converting the DocBook sources to other formats, such as <acronym>HTML</acronym>. DocBookのソースをHTMLのような他のフォーマットに変換する処理手順が含まれています。
The minimum required version is currently 1.77.0, but it is recommended to use the latest available version for best results. 現在最低必要なバージョンは1.77.0ですが、最良の結果を得るために入手可能な最新の版を使うことをお勧めします。
xmllintのためのLibxml2 #
This library and the <command>xmllint</command> tool it contains are
used for processing XML. Many developers will already
have <application>Libxml2</application> installed, because it is also
used when building the PostgreSQL code. Note, however,
that <command>xmllint</command> might need to be installed from a
separate subpackage.
このライブラリとそこに含まれるxmllintツールはXMLを処理するのに使われます。
PostgreSQLのコードを構築する時にも使われますので、多くの開発者はすでにLibxml2をインストールしているでしょう。
しかしながら、xmllintは別のサブパッケージからインストールする必要があるかもしれないことに注意してください。
xsltprocのためのLibxslt #
<command>xsltproc</command> is an XSLT processor, that is, a program to
convert XML to other formats using XSLT stylesheets.
xsltprocはXSLTプロセッサ、すなわち、XSLTスタイルシートを使ってXMLを他のフォーマットに変換するプログラムです。
This is a program for converting, among other things, XML to PDF. It is needed only if you want to build the documentation in PDF format. これは変換、とりわけXMLからPDFへの変換のためのプログラムです。 PDFフォーマットで文書をビルドする場合にのみ必要です。
We have documented experience with several installation methods for the various tools that are needed to process the documentation. These will be described below. There might be some other packaged distributions for these tools. Please report package status to the documentation mailing list, and we will include that information here. 文書を作成するために必要な様々なツールのインストール方法についての経験をまとめました。 以下に記載します。 これらのツールは別にパッケージ化されて配布されていることも考えられます。 もしそのような配布物を見つけた場合はdocのメーリングリストに報告してください。 そのような情報をここに付け加えたいと思います。
To install the required packages, use: 要求されるパッケージをインストールするには以下のようにしてください。
yum install docbook-dtds docbook-style-xsl libxslt fop
To install the required packages with <command>pkg</command>, use:
pkgで必要なパッケージをインストールするには以下を使います。
pkg install docbook-xml docbook-xsl libxslt fop
When building the documentation from the <filename>doc</filename>
directory you'll need to use <command>gmake</command>, because the
makefile provided is not suitable for FreeBSD's <command>make</command>.
提供されているMakefileはFreeBSDのmake用ではありませんので、docディレクトリから文書を作成するにはgmakeを使うことが必要でしょう。
There is a full set of packages of the documentation tools available for <productname>Debian GNU/Linux</productname>. To install, simply use: Debian GNU/Linux用の文書作成パッケージの一式が揃っています。 インストールには以下を使います。
apt-get install docbook-xml docbook-xsl libxml2-utils xsltproc fop
If you use MacPorts, the following will get you set up: MacPortsを使っているのであれば、以下のようにすれば設定されます。
sudo port install docbook-xml docbook-xsl-nons libxslt fop
If you use Homebrew, use this: Homebrewを使っているのであれば、こちらを使ってください。
brew install docbook docbook-xsl libxslt fop
The Homebrew-supplied programs require the following environment variable to be set. For Intel based machines, use this: Homebrewで提供されたプログラムでは、次の環境変数を設定する必要があります。 Intelベースのマシンの場合は、以下を設定します。
export XML_CATALOG_FILES=/usr/local/etc/xml/catalog
On Apple Silicon based machines, use this: Apple Siliconベースのマシンの場合は、以下を設定します。
export XML_CATALOG_FILES=/opt/homebrew/etc/xml/catalog
Without it, <command>xsltproc</command> will throw errors like this:
設定しなかった場合、xsltprocは次のようなエラーを発生させます。
I/O error : Attempt to load network entity http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd postgres.sgml:21: warning: failed to load external entity "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" ...
While it is possible to use the Apple-provided versions
of <command>xmllint</command> and <command>xsltproc</command>
instead of those from MacPorts or Homebrew, you'll still need
to install the DocBook DTD and stylesheets, and set up a catalog
file that points to them.
Appleが提供するバージョンのxmllintとxsltprocをMacPortsやHomebrewの代わりに使用することは可能ですが、DocBookのDTDとスタイルシートをインストールし、それらを指すカタログファイルを設定する必要があります。
configureによる検出 #
Before you can build the documentation you need to run the
<filename>configure</filename> script, as you would when building
the <productname>PostgreSQL</productname> programs themselves.
Check the output near the end of the run; it should look something
like this:
PostgreSQL本体のプログラムを構築した時のように、文書を構築する際にconfigureスクリプトを実行する必要があります。
実行が終わる近辺の出力を確認してください。次のような感じになっているはずです。
checking for xmllint... xmllint checking for xsltproc... xsltproc checking for fop... fop checking for dbtoepub... dbtoepub
If <filename>xmllint</filename> or <filename>xsltproc</filename> is not
found, you will not be able to build any of the documentation.
<filename>fop</filename> is only needed to build the documentation in
PDF format.
<filename>dbtoepub</filename> is only needed to build the documentation
in EPUB format.
xmllintやxsltprocが見つからない時は、文書の構築はできません。
fopはPDF形式で文書を構築するのにのみ必要です。
dbtoepubはEPUB形式で文書を構築するのにのみ必要です。
If necessary, you can tell <filename>configure</filename> where to find
these programs, for example
必要ならconfigureにどこでこれらのプログラムを見つけられるか教えることができます。例えば、
./configure ... XMLLINT=/opt/local/bin/xmllint ...
If you prefer to build <productname>PostgreSQL</productname> using
Meson, instead run <command>meson setup</command> as described in
<xref linkend="install-meson"/>, and then see
<xref linkend="docguide-build-meson"/>.
Mesonを使ってPostgreSQLを構築したい場合は、17.4で説明されているようにmeson setupを実行し、J.4を参照してください。