★PostgreSQLカンファレンス2024 12月6日開催/チケット販売中★
他のバージョンの文書 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

J.3. 文書の構築

全ての設定が終了したら、doc/src/sgmlディレクトリに移動して以下のコマンドの1つを実行してください (GNU makeを使うのを忘れずに)。

J.3.1. HTML

HTML形式の文書を作成するには次のようにします。

doc/src/sgml$ make html

これはデフォルトでの対象です。 出力はhtmlサブディレクトリに作成されます。

デフォルトの簡単なスタイルではなくpostgresql.orgで使われているスタイルシートのHTMLの文書を作成するには、次のようにします。

doc/src/sgml$ make STYLE=website html

STYLE=websiteオプションが使われると、生成されるHTMLファイルはpostgresql.orgで提供されるスタイルシートへの参照を含み、見るにはネットワークアクセスが必要です。

J.3.2. マニュアルページ

DocBook refentryページをマニュアルページに対応した*roff形式に変換するには、DocBook XSLスタイルシートを使用します。 マニュアルページを作成するには次のようにします。

doc/src/sgml$ make man

J.3.3. PDF

FOPを使ってPDF文書を作成したい時は、対象の用紙のサイズに合わせて以下のコマンドの中から1つを選んでください。

  • A4サイズ:

    doc/src/sgml$ make postgres-A4.pdf
    

  • U.S.レターサイズ:

    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'

必要なメモリの最小量があり、ある程度はメモリが多いほどより速くなるようです。 非常に少ないメモリ(1GB以下)のシステムでは、作成はスワップのために非常に遅くなるか、全く動かないでしょう。

他のXSL-FOプロセッサも手動で使えますが、自動化された作成プロセスではFOPだけがサポートされています。

J.3.4. 平文ファイル

より良い表示ツールがない状況で必要とされる場合に備えて、インストールの手順は平文でも配布されています。 INSTALLファイルは第16章と連係していて、異なった内容を説明するためにちょっとした変更が加えられています。 このファイルを生成するには、doc/src/sgmlディレクトリに移動しmake INSTALLと入力します。 テキスト出力の構築には、追加の構築ツールとしてバージョン1.13以降のPandocが必要です。

以前はリリースノートとリグレッションテストの手順も平文で配布されていましたが、打ち切りになりました。

J.3.5. 構文検証

文書の構築にはとても時間がかかります。 でも文書ファイルの正しい構文だけを検証する方法があります。 以下のように入力します。 ほんの数秒しかかかりません。

doc/src/sgml$ make check