普通のマニュアルや info
ファイルの他にユーザにとって有用だと思えるような文書がある場合には、
PREFIX/share/doc
の下にインストールしてください。
これは前記と同様 post-install
ターゲットの中から行なうと良いでしょう。
まず、あなたの port のために新しいディレクトリを作ります。
どの port の文書か簡単にわかるような名前にする必要がありますので、
普通は PORTNAME
を使うと良いでしょう。
もちろん、ユーザが異なるバージョンのものを同時に使うことが予想される
port の場合には
PKGNAME
をそのまま使っても構いません。
ユーザが /etc/make.conf
でこの部分を禁止するために
NOPORTDOCS
という変数をセットしている場合には、
これらの文書がインストールされないようにしてください。
こんな具合です。
post-install: .if !defined(NOPORTDOCS) ${MKDIR} ${DOCSDIR} ${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${DOCSDIR} .endif
ここでは、変数をいくつかと、それを
Makefile
で利用した時にどう展開されるかを説明します。
${DATADIR}
は
${PREFIX}/share/${PORTNAME}
に展開されます。
${DOCSDIR}
は
${PREFIX}/share/doc/${PORTNAME}
に展開されます。
${EXAMPLESDIR}
は
${PREFIX}/share/examples/${PORTNAME}
に展開されます。
文書ファイルおよびディレクトリはすべて
pkg-plist
の中に
%%PORTDOCS%%
を頭につけて書く必要があります。
たとえば、次のようにしてください。
%%PORTDOCS%%%%DOCSDIR%%/AUTHORS %%PORTDOCS%%%%DOCSDIR%%/CONTACT %%PORTDOCS%%@dirrm %%DOCSDIR%%
インストール時に pkg-message
ファイルを利用してメッセージを表示することができます。詳細は
pkg-message を使う
のセクションを参照してください。
pkg-message
ファイルを pkg-plist
に加える必要はありません。
本文書、および他の文書は https://download.freebsd.org/ftp/doc/ からダウンロードできます。
FreeBSD に関する質問がある場合には、
ドキュメント を読んだ上で
<questions@FreeBSD.org> まで (英語で) 連絡してください。
本文書に関する質問については、
<doc@FreeBSD.org> まで電子メールを (英語で) 送ってください。