This is an archive of past FreeBSD releases; it's part of the FreeBSD Documentation Archive.

package 記述ファイルの作成

2.2. package 記述ファイルの作成

package にするしないに関わらず, どのような port でも三つの記述ファイルが必要です. それは pkg サブディレクトリにある, COMMENT, DESCR, そして PLISTです.

2.2.1. COMMENT

これには, その port についての説明を一行で書きます. package の名前, バージョン番号等は含めないでください. コメントは大文字で始め, 最後のピリオドは付けないでください. たとえば, こんな具合です.

    A cat chasing a mouse all over the screen

2.2.2. DESCR

これは, そのソフトウェアについての少し長い説明を記述します. その port が何をするのかについて, 数段落程度の簡潔な解説があれば十分です.

Note: このファイルは, マニュアルでも使用方法やコンパイル方法についての細かい説明書でもありません. 特に README ファイルやマニュアルページをコピーしようとしてしている場合には注意してください. これらは多くの場合, その port の簡潔な説明になっていなかったり, 扱いにくい形式 (マニュアルページの場合, 行を揃えるために空白が調整されます) になっていたりします. もしこのソフトウェアに公式のウェブサイトがあれば, ここに書いてください. 自動化ツールが正しく動作するように, ウェブサイトのうちの一つには先頭に WWW: を付け加えてください.

このファイルの最後にあなたの名前を書くことが推奨されています. たとえば, こんな具合です.

    This is a port of oneko, in which a cat chases a poor mouse all over
    the screen.
     :
    (うんぬん.)
    
    WWW: http://www.oneko.org/
    
    - Satoshi
    asami@cs.berkeley.edu

2.2.3. PLIST

このファイルには, この port によってインストールされるファイルが列挙されます. このファイルは package を作る際のリストとして使われるため, "パッキングリスト (packing list)" とも呼ばれます. ここに書かれているファイル名は, インストール時のプレフィックス (普通は /usr/local/usr/X11R6) からの相対パスです. MANn 変数を使用する場合 (使用することが推奨されています) には, マニュアルはここに入れないでください.

簡単な例を載せておきましょう.

    bin/oneko
    lib/X11/app-defaults/Oneko
    lib/X11/oneko/cat1.xpm
    lib/X11/oneko/cat2.xpm
    lib/X11/oneko/mouse.xpm
    @dirrm lib/X11/oneko

パッキングリストの詳細については, pkg_create(1) のマニュアルページを参照してください.

Note: すべてのファイルを列挙しなければなりませんが, ディレクトリ名は必要ありません. また, ports がインストール時にディレクトリを作成する場合には @dirrm の行を加えて, その port が削除されるときにそのディレクトリも削除されるようにしてください.

このファイルにはファイル名をアルファベット順に並べるようにします. そうすることで port のアップグレートの際, 確認作業が楽に行なえるようになります.

パッキングリストを手で作るのは, 時にとても退屈な作業になります. もし多数のファイルをインストールする port なら, パッキングリストを自動生成すれば時間の節約になるかも知れません.

FreeBSD ports システムに関する質問は <ports@freebsd.org> へ(英語で),
FreeBSD ports に関する日本語での議論は <ports-jp@jp.FreeBSD.org> へお願いします.
この文書の原文に関するお問い合わせは <doc@freebsd.org> へ(英語で),
日本語訳に関するお問い合わせは <doc-jp@jp.FreeBSD.org> へお願いします.