[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Packaging Manual ch-description.html

芳尾と申します。

Packaging.sgml の第7章 ch-descriptions.html を担当しております。

章の題目のところは訳していますが、セクションの題名は訳しておりません。
これらは、いずれ、最終的に出来上がった段階で統一する必要があるんじゃな
いかと思います。このところはとりまとめのクリスさんにお願いできたらと考
えております。

よろしければ、変な個所の指摘をしてくださるとありがたいです。

私は続いて 8 章、ch-relationships.html の訳に移行したいと思います。

クリスさん、クリスさんのホームページへのアップロード、よろしくお願いい
たします。

ではでは。 ---- Yours, K.S.Yoshio
                mailto:shishamo@xxxxxxxxxxxxxxx
                http://www2.osk.3web.ne.jp/~shishamo


<html><head>
<title>Debian packaging manual - Descriptions of packages - the
Description field</title>
<link rev=made href="mailto:shishamo@xxxxxxxxxxxxxxx";>
</head><body>
<h1>
Debian packaging manual - 第 7 章<br>
パッケージの説明文 - Description フィールド
</h1>

コントロールファイルの<code>Description</code>フィールドは、ユーザがイン
ストールパッケージを選択するとき <kbd>dselect</kbd>によって表示されます。
また、<kbd>dpkg</kbd>が、そのパッケージの情報を表示するときにも使われま
す。FTP サイトの <kbd>Packages</kbd> ファイルにも含まれており、その他に
Debian のウェブページでも使われています。<p>

この Description フィールドはパッケージの簡単な解説で、それまで使用し
たことのないプログラムをインストールするかどうかの判断を助けるものです。
パッケージ間の依存関係 (dependency) や競合関係 (conflict)の情報も示され
ていなければいけません。そうでないと、ユーザにはなぜ競合関係や依存関係の
不具合が起きているのかが分かりません。<p>

このフィールドのフォーマットは以下の通りです。
<pre>Description: <var>一行の要約</var>
 <var>複数行にわたる詳細な解説部分</var></pre><P>

一行要約の部分は、ふつうはパッケージのリストですが、出来るだけ情報量が多
くなるようにします。そして、すべてのパッケージは複数行に渡る詳細な解説部
分を持っていなければいけません。<p>
<hr>
<h2><A name="s7.1">
7.1 Types of formatting line in the extended description
</A></h2>

<ul>
<li>解説部分の段落の構成行はかならず一文字の空白で始まります。表示時に
    継続行はワード単位で折りかえされて表示されます。最初の空白は表示時に
    は削除されます。<p>
<li>二つかそれ以上の空白で始まる行は、そのままの表示になります。ディスプ
    レイが水平方向に拡張することができない場合、表示プログラムは改行をき
    っちりと行います(つまり、ワード単位の折り返しについて関知しません)。
    もし可能であれば、右側に向かって表示が消えることも許されています。表
    示時に 0 個または、1、2個の行頭の空白が削除されることもあります。こ
    の場合の各行の削除される空白の数はすべての行において同じになります
    (この結果、インデントは正常に表示されます)。
    <p>
<li>一つの空白の後に一つのピリオドを含む行は空白行となります。これは空白
    行を表示するための唯一の方法です。以下も参照してください。<p>
<li>一つの空白の後にピリオドといくつかの文字を含む行は将来の拡張のために
    用いられる予定です。使用しないでください。<p>
</ul>

<hr>
<h2><A name="s7.2">
7.2 Notes about writing descriptions
</A></h2>

詳細の解説部分は、少くとも一つの空白から必ず始まります。コントロールファイ
ルとPackages ファイルの中のフィールドは RFC822 におけるメッセージヘッダ
のように行頭から始まるフィールド名で区切られます。ここでは、
<kbd>dpkg-deb</kbd>で、</kbd><A
href="footnotes.html#20"name="fr20">[20]</A>パッケージを作成しようとする
とき、空白があると文法エラーを引き起こすことは忘れください。もし強制的に
構築したとしても、<kbd>dpkg</kbd>がインストールするのを拒否するでしょう。
<p>

完全な空行を含んではいけません。これらは Packages ファイル中のそれぞれの
レコードと、<code>debian/control</code> ファイル中の違うパッケージの区別
に用いられます。そして、これらをパッケージコントロールファイル中で用いる
ことは禁じられています。これを間違うとどうなるかは、前段落を参照してくだ
さい。<p>

一つの行の文法は簡単です。 - 80キャラクタ以下でなければいけません(訳注：
日本語キャラクタだと 40 文字以下)。80列 ターミナルを使っていて拡張表示
をしてなければ、 <kbd>dselect</kbd>は 25 から 49 キャラクタを表示します。
表示は有効なディスプレイオプションによります。<p>

パッケージ名を要約(Synopsis)の行に入れないでください。入れなくても、表示
ソフトウェアはパッケージ名を自動的に表示するようになっています。多くの場
合、ユーザの目にふれるのはこの要約行だけなので、なるだけ分かりやすい要約
にするようにしてください。<p>

詳細の解説部分はそのパッケージ自体の説明およびその他のシステムとの関連 (例
えば、Debian System 全体のなかで、どのパッケージがここに含まれるか、など
)について記します。<p> 

そのプログラムにもともと付いているアナウンスや<kbd>README</kbd>をそのま
まこの Description に使用可能なことはほとんどありません。だいたい、これ
らの文章はそのソフトウェアがどんなふうに使われているのかすでに知っている
ユーザコミュニティ向けに書かれています。けれども、Debian システムの場合、
そのパッケージが一体どんなことをするのか全く知らない人がこの 
Description: フィールドを読んで、そのパッケージの概略について理解できな
ければいけません。<p>

要約行および詳細の解説部分、これら両方の部分において、重要な情報を最初に
持ってきてください。実際の表示時に、要約行または詳細の解説部分の一部しか
表示されないことがあります。もっとも、そういう時は、詳細の解説部分全体を
表示することができるようになっているはずです。<p>

もし望むならば、依存関係などの情報も解説部分に含ませることができます。<p>

タブは使用しないでください。どういう動作をするか分かりません。<p>

フィールド名 <code> Description </code>との同一行の要約部分を改行して、
詳細の解説部分に入らないようにしてください。解説文全体が正しく表示されな
くなるでしょう。そして、要約文しか表示されないので、そのパッケージがどう
いうことをするパッケージなのかが分かりにくくなります。
<hr>
<h2><A name="s7.3">
7.3 Example description in control file for Smail
</A></h2>

<pre>Package: smail
Version: 3.1.29.1-13
Maintainer: Ian Jackson &lt;iwj10@xxxxxxxxxxxxx&gt;
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.</pre>
<hr>
Debian packaging manual
- <A href="index.html#copyright">Copyright .Aゥ1996 Ian Jackson.</A>*B
<br>
<A href="index.html#toc">Contents</A>; <A href="index.html#abstract">abstract</A>; <A href="ch-relationships.html">next</A>; <A href="ch-maintainerscripts.html">back</A>.
<br>
<address>version 1.4.0.21 (dpkg 1.4.0.21), 5 March 1998
<br>
Ian Jackson <A
href="mailto:ijackson@xxxxxxxxxxxxxx";>ijackson@xxxxxxxxxxxxxx</A><br>
Revised: David A. Morris <A
href="mailto:bweaver@debian.org";>bweaver@debian.org</A><br>
日本語訳：芳尾桂<A
href="mailto:shishamo@xxxxxxxxxxxxxxx";>shishamo@xxxxxxxxxxxxxxx</A><br>
</address>
</body></html>