第9章 マニュアルページ

MAN[1-9LN] 変数に指定したマニュアルは 自動的に pkg-plist に追加されます (つまり、マニュアルを pkg-plist に加えてはいけませんpkg-plist の生成を参照してください)。 また、/etc/make.conf 中の NOMANCOMPRESS の設定に従って、インストール時に マニュアルを自動的に圧縮したり復元したりします。

その port が、シンボリックリンクやハードリンクを用いて、 複数のファイル名を持つマニュアルをインストールする場合には、 それらを識別するために MLINKS 変数を使用しなければなりません。 port によってインストールされたリンクは、 意図したファイルをきちんと指しているかどうか確認するため、 bsd.port.mk によって削除されたり、 再作成されたりします。 MLINKS に指定されたマニュアルも、 pkg-plist に含めてはいけません。

マニュアルをインストール時に圧縮するかどうかを指定するには、 MANCOMPRESSED 変数を使用します。 この変数は yes, no そして maybe の三つの値をとることができます、 yes はマニュアルが既に圧縮されてインストールされていること、 no は圧縮されていないこと、 maybe は既にそのソフトウェアが NOMANCOMPRESS の値に従っていて、 bsd.port.mk は特別なにもする必要がないことを意味します。

USE_IMAKE がセットされていて、 NO_INSTALL_MANPAGES がセットされていなければ、 MANCOMPRESSED は自動的に yes に設定されます。それ以外の場合には、MANCOMPRESSEDno に設定されます。 その port にとって、デフォルトの設定が適切でない場合以外には、 明示的に設定する必要はありません。

PREFIX 以外のディレクトリの下にマニュアルを置くような port では、そのディレクトリを MANPREFIX で指定することができます。 さらに、いくつかの perl モジュールの ports のように、 特定のセクションのマニュアルだけを非標準の場所にインストールする場合、 個々のマニュアルのパスを MANsectPREFIX (ここで sect1-9, L, または N のいずれか) により指定することができます。

マニュアルが言語特有のサブディレクトリに置かれる場合には、 その言語名を MANLANG に設定してください。 この変数のデフォルト値は "" になっています (つまり、英語のみ)。

これは、全部をまとめた例です。

MAN1=           foo.1
MAN3=           bar.3
MAN4=           baz.4
MLINKS=         foo.1 alt-name.8
MANLANG=        "" ja
MAN3PREFIX=     ${PREFIX}/share/foobar
MANCOMPRESSED=  yes

これは、この port により以下の 6 個のファイルがインストールされることを表しています。

${PREFIX}/man/man1/foo.1.gz
${PREFIX}/man/ja/man1/foo.1.gz
${PREFIX}/share/foobar/man/man3/bar.3.gz
${PREFIX}/share/foobar/man/ja/man3/bar.3.gz
${PREFIX}/man/man4/baz.4.gz
${PREFIX}/man/ja/man4/baz.4.gz

さらに ${PREFIX}/man/man8/alt-name.8.gz がこの port によってインストールされるかどうかわかりませんが、 それとは無関係に foo(1) と alt-name(8) のマニュアルページを指すシンボリックリンクが作成されます。

本文書、および他の文書は ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/ からダウンロードできます。

FreeBSD に関する質問がある場合には、 ドキュメント を読んだ上で <questions@FreeBSD.org> まで (英語で) 連絡してください。

本文書に関する質問については、 <doc@FreeBSD.org> まで電子メールを (英語で) 送ってください。