Once you have everything set up, change to the directory
<filename>doc/src/sgml</filename> and run one of the commands
described in the following subsections to build the
documentation. (Remember to use GNU make.)
全ての設定が終了したら、doc/src/sgml
ディレクトリに移動して以下のコマンドの1つを実行してください。
(GNU makeを使うのを忘れずに。)
To build the <acronym>HTML</acronym> version of the documentation: HTML形式の文書を作成するには次のようにします。
doc/src/sgml$
make html
This is also the default target. The output appears in the
subdirectory <filename>html</filename>.
これはデフォルトでの対象です。
出力はhtml
サブディレクトリに作成されます。
To produce HTML documentation with the stylesheet used on <ulink url="https://www.postgresql.org/docs/current/">postgresql.org</ulink> instead of the default simple style use: デフォルトの簡単なスタイルではなくpostgresql.orgで使われているスタイルシートのHTMLの文書を作成するには、次のようにします。
doc/src/sgml$
make STYLE=website html
If the <literal>STYLE=website</literal> option is used, the generated HTML
files include references to stylesheets hosted on <ulink
url="https://www.postgresql.org/docs/current/">postgresql.org</ulink> and
require network access to view.
STYLE=website
オプションが使われると、生成されるHTMLファイルはpostgresql.orgで提供されるスタイルシートへの参照を含み、見るにはネットワークアクセスが必要です。
We use the DocBook XSL stylesheets to
convert <productname>DocBook</productname>
<sgmltag>refentry</sgmltag> pages to *roff output suitable for man
pages. To create the man pages, use the command:
DocBook refentry
ページをマニュアルページに対応した*roff形式に変換するには、DocBook XSLスタイルシートを使用します。
マニュアルページを作成するには次のようにします。
doc/src/sgml$
make man
To produce a PDF rendition of the documentation using <productname>FOP</productname>, you can use one of the following commands, depending on the preferred paper format: FOPを使ってPDF文書を作成したい時は、対象の用紙のサイズに合わせて以下のコマンドの中から1つを選んでください。
For A4 format: A4サイズ:
doc/src/sgml$
make postgres-A4.pdf
For U.S. letter format: U.S.レターサイズ:
doc/src/sgml$
make postgres-US.pdf
Because the PostgreSQL documentation is fairly
big, <productname>FOP</productname> will require a significant amount of
memory. Because of that, on some systems, the build will fail with a
memory-related error message. This can usually be fixed by configuring
Java heap settings in the configuration
file <filename>~/.foprc</filename>, for example:
PostgreSQL文書はかなり大きいので、FOPはかなりの量のメモリを必要とするでしょう。
そのため、システムの中には、メモリに関連するエラーメッセージを出して作成に失敗するものもあるでしょう。
これは、設定ファイル~/.foprc
のJavaヒープ設定を設定することで回避できます。例えば、
# FOP binary distribution FOP_OPTS='-Xmx1500m' # Debian JAVA_ARGS='-Xmx1500m' # Red Hat ADDITIONAL_FLAGS='-Xmx1500m'
There is a minimum amount of memory that is required, and to some extent more memory appears to make things a bit faster. On systems with very little memory (less than 1 GB), the build will either be very slow due to swapping or will not work at all. 必要なメモリの最小量があり、ある程度はメモリが多いほどより速くなるようです。 非常に少ないメモリ(1GB以下)のシステムでは、作成はスワップのために非常に遅くなるか、全く動かないでしょう。
In its default configuration <productname>FOP</productname> will emit an
<literal>INFO</literal> message for each page. The log level can be
changed via <filename>~/.foprc</filename>:
デフォルト設定では、FOPはページごとにINFO
メッセージを発行します。
ログレベルは~/.foprc
で変更できます。
LOGCHOICE=-Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog LOGLEVEL=-Dorg.apache.commons.logging.simplelog.defaultlog=WARN
Other XSL-FO processors can also be used manually, but the automated build process only supports FOP. 他のXSL-FOプロセッサも手動で使えますが、自動化された作成プロセスではFOPだけがサポートされています。
Building the documentation can take very long. But there is a method to just check the correct syntax of the documentation files, which only takes a few seconds: 文書の構築にはとても時間がかかります。 でも文書ファイルの正しい構文だけを検証する方法があります。 以下のように入力します。 ほんの数秒しかかかりません。
doc/src/sgml$
make check