名前

       po4a-build - 翻訳済みドキュメントのビルド

概要

       po4a-build [-f | --file FILE] [--pot-only]

       po4a-build [-? | -h | --help | --version]

説明

       po4a-build は、未訳を提供するのと同じ簡単さで、翻訳済みドキュメントを提供できるようにすることを意図してい
       ます。

       po4a が POD や DocBook XML として翻訳済み内容を用意すると、po4a-build を使用して最終ドキュメントをビルド
       できます。未訳と翻訳済みの両方の内容は一度の処理でビルドされ、併せて同時に POT ファイルの更新も行われま
       す。

       既存のビルド手順は po4a-build の一回の呼び出しに置き換えられます。po4a-build が参照するシンプルな設定ファ
       イルが使用され、その中には各要素をビルドする方法や、翻訳済みと未訳の内容をインクルードするバイナリパッ
       ケージの指定が記述されます。

       ビルドされた内容は、設定ファイルで指定された BASEDIR の下のパッケージ固有のディレクトリに置かれます。バイ
       ナリパッケージ foo にドイツ語とフランス語の翻訳がある場合、以下のような結果になります:

           BASEDIR/foo/man/man1/foo.1
           BASEDIR/foo/man/de/man1/foo.1
           BASEDIR/foo/man/fr/man1/foo.1

       これにより、同じ位置にインストールするバイナリパッケージに生成した内容をすべて収録するのが簡単になります:

           doc/foo/man/* ./usr/share/man/
           doc/foo/html/* ./usr/share/doc/foo/

       新しい翻訳を追加する際にこの規則を更新する必要はなく、別個のバイナリパッケージ (bar) を追加することによっ
       てそのパッケージの内容を分けておくことが可能となります。

   サポートするフォーマット
       現在、po4a-build は以下の組み合わせをサポートしています:

        1. セクション 1 用 DocBook XML。

        2. セクション 3 用 DocBook XML。

        3. HTML 用 DocBook XML。

        4. セクション 1 用 POD。

        5. セクション 3 用 POD。

        6. セクション 5 用 POD。

        7. セクション 7 用 POD。

       対応しているあらゆるフォーマットにおいて、サポートするあらゆる組み合わせを単一の設定ファイル
       po4a-build.conf で指示し、ただ po4a-build を呼び出すだけで処理させられます。po4a-build.conf(5) を参照して
       ください。

設定

       po4a-build は、パッケージの VCS 最上位ディレクトリに置かれるべき po4a-build.conf をデフォルト設定ファイル
       として使用します (ほかのファイルを使用するには -f オプションを使用してください)。po4a-build.conf(5) を参
       照してください。

       例1 設定例のファイル

       設定例が書かれたファイルは以下の場所にインストールされています:

           /usr/share/doc/po4a/examples/po4a-build.conf.example

   設定ファイルのレイアウト
       設定ファイルは、全般、XML/XSL サポート、POD サポート、HTML サポートの節で構成されます。

       全般には、po4a 設定ファイルの名前や位置 (po4a.config のままにしておくのが最善でしょう) や、ドキュメントの
       PO ファイルがある po ディレクトリ (通常は doc/po)、翻訳を作成する POT ファイルのフルネーム、生成物を出力
       する BASEDIR、パッケージの manpage をセクション 1 ではなくてセクション 3 に格納するかどうか、生成物を格納
       するバイナリパッケージ名が含まれます。

       XML/XSL サポートには、XMLPACKAGES 変数により XSL サポートを使うバイナリパッケージの指定や、xsltproc に渡
       す最上位の DocBook ファイル、XML や DocBook ファイルの位置が含まれます。必要なら XSLFILE を上書きできま
       す。

       POD サポートには、PODPACKAGES 変数により POD サポートを使うバイナリパッケージの指定や、POD ファイルのフル
       ネームが含まれます。

       HTML サポートでは、BASEDIR 以下に作成する未訳と翻訳済みの HTML 内容のサブディレクトリや、HTML を生成する
       DocBook ファイルを指定します。必要なら HTMLXSL を上書きできます。

コマンド

       --pot-only
           POT ファイルの更新のみ行います。--pot-only は、パッケージソースにある全 POT ファイルを収録するパッ
           ケージをサポートすることを意図しています。Autotools を使用したパッケージは、EXTRA_DIST により POT
           ファイルを簡単に追加できますが、単に Makefile を使用したり、特定の VCS ヘルパーを使用したパッケージ
           は、VCS に POT ファイルを追加せずに (生成した) POT ファイルを追加するのは厄介であることがわかりま
           す。面倒で不要な作業を避けるために、po4a-build はビルド開始時に POT ファイルを更新できるようになって
           いて、dpkg-source がそれらをソース tarball に収録します。

           例2 svn-buildpackage の例

           svn-buildpackage は、SVN 属性の useNativeDist や Make ターゲットの native-dist を使用して、この種の追
           加を明示的にサポートしています。

               # POT ファイルをソース tarball に追加
               native-dist: Makefile
                    po4a-build --pot-only

               $ svn propset useNativeDist 1 debian

       -h|--help
           使用方法のメッセージを表示して終了します。

       --version
           print the script version and exit.

オプション

       -f|--file FILE
           po4a-build は、デフォルトの設定ファイル (po4a-build.conf) の代わりにオプションで指定したファイルを使
           用します。

著者

       po4a-build は Neil Williams <codehelp@debian.org> によって書かれました。

       このマニュアルページは Neil Williams <codehelp@debian.org> によって書かれました

PO4A                                               26/08/2017                                      PO4A-BUILD(1)