[ previous ] [ Contents ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ 11 ] [ 12 ] [ 13 ] [ 14 ] [ next ]
制御ファイルの Description フィールドは、
ユーザがインストールパッケージを選択するとき dselect
によって表示されます。 また、dpkg
が、そのパッケージの情報を表示するとき にも使われます。FTP サイトの
Packages ファイルにも 含まれており、その他に Debian
のウェブページでも使われています。
この Description フィールドはパッケージの簡単な解説で、 それまで使用したことのないプログラムをインストールするかどうかの 判断を助けるものです。パッケージ間の依存関係 (dependency) や競合関係 (conflict) の情報も示されていなければいけません。 そうでないと、ユーザにはなぜ競合関係や依存関係の不具合が 起きているのかが分かりません。
このフィールドのフォーマットは以下の通りです。
Description: 一行の要約
複数行にわたる詳細な解説部分
一行要約の部分は、ふつうはパッケージのリストですが、 出来るだけ情報量が多くなるようにします。そして、すべての パッケージは複数行に渡る詳細な解説部分を持っていなければ いけません。
解説部分の段落の構成行はかならず一文字の空白で 始まります。表示時に継続行はワード単位で折りかえされて 表示されます。最初の空白は表示時には削除されます。
二つかそれ以上の空白で始まる行は、そのままの表示に なります。ディスプレイが水平方向に拡張することが できない場合、表示プログラムは改行をきっちりと行います (つまり、ワード単位の折り返しについて関知しません)。 もし可能であれば、右側に向かって表示が消えることも 許されています。表示時に 0 個または、1、2 個の行頭の 空白が削除されることもあります。この場合の各行の 削除される空白の数はすべての行において同じになります (この結果、インデントは正常に表示されます)。
一つの空白の後に一つのピリオドを含む行は空白行となります。 これは空白行を表示するための唯一の方法です。 以下も参照してください。
一つの空白の後にピリオドといくつかの文字を含む行は 将来の拡張のために用いられる予定です。使用しないで ください。
詳細の解説部分は、少くとも一つの空白から
必ず始まります。制御ファイルと Packages ファイルの中のフィールドは
RFC822 におけるメッセージヘッダの
ように行頭から始まるフィールド名で区切られます。行頭の空白を
忘れた場合、パッケージの作成の時に dpkg-deb [20] が文法エラーを指摘します。
強制的に構築したとしても、dpkg が インストールするのを拒否します。
完全な空行を含んではいけません。 これらは Packages ファイル中のそれぞれのレコードと、 debian/control ファイル中の違うパッケージの区別に 用いられます。そして、これらを パッケージ制御ファイル中で用いることは 禁じられています。これを間違うとどうなるかは、前段落を 参照してください。
一行による要約は簡潔に。もちろん (訳注：半角換算で) 80 文字以下で。80
列ターミナルを使っていて拡張表示を してなければ、dselect は
(訳注：半角換算で) 25 から 49 文字を表示しません。表示は有効な
ディスプレイオプションによります。
パッケージ名を要約 (Synopsis) の行に入れないでください。 入れなくても、表示ソフトウェアはパッケージ名を自動的に 表示するようになっています。多くの場合、ユーザの目に ふれるのはこの要約行だけなので、なるだけ分かりやすい 要約にするようにしてください。
詳細の解説部分はそのパッケージ自体の説明およびその他の システムとの関連 (例えば、Debian System 全体のなかで、 どのパッケージがここに含まれるか、など) について記します。
そのプログラムにもともと付いているアナウンスや README
をそのままこの Description に使用可能な
ことはほとんどありません。だいたい、これらの文章は
そのソフトウェアがどんなふうに使われているのかすでに知っている
ユーザコミュニティ向けに書かれています。けれども、 Debian
システムの場合、そのパッケージが一体どんなことを するのか全く知らない人がこの
Description: フィールドを読んで、
そのパッケージの概略について理解できなければいけません。
要約行および詳細の解説部分、これら両方の部分において、 重要な情報を最初に持ってきてください。実際の表示時に、 要約行または詳細の解説部分の一部しか表示されないことが あります。もっとも、そういう時は、詳細の解説部分全体を 表示することができるようになっているはずです。
もし望むならば、依存関係などの情報も解説部分に含ませることが できます。
タブは使用しないでください。どういう動作をするか分かりません。
フィールド名 Description との同一行の要約部分を 改行して、詳細の解説部分に入らないようにしてください。 解説文全体が正しく表示されなくなるでしょう。そして、 要約文しか表示されないので、そのパッケージがどういうことを するパッケージなのかが分かりにくくなります。
Package: smail
Version: 3.1.29.1-13
Maintainer: Ian Jackson <iwj10@cus.cam.ac.uk>
Recommends: pine | mailx | elm | emacs | mail-user-agent
Suggests: metamail
Depends: cron, libc5
Conflicts: sendmail
Provides: mail-transport-agent
Description: Electronic mail transport system.
Smail is the recommended mail transport agent (MTA) for Debian.
.
An MTA is the innards of the mail system - it takes messages from
user-friendly mailer programs and arranges for them to be delivered
locally or passed on to other systems as required.
.
In order to make use of it you must have one or more user level
mailreader programs such as elm, pine, mailx or Emacs (which has Rmail
and VM as mailreaders) installed. If you wish to send messages other
than just to other users of your system you must also have appropriate
networking support, in the form of IP or UUCP.
[ previous ] [ Contents ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ 11 ] [ 12 ] [ 13 ] [ 14 ] [ next ]
Debian Packaging Manual
version revision 1.13, 2000-08-22ijackson@gnu.ai.mit.edubweaver@debian.orgschwarz@debian.orgsrivasta@debian.orgJ.D.Gilbey@qmw.ac.ukdebian-policy@lists.debian.orgshayase@tky3.3web.ne.jpdebian-doc@debian.or.jp