[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Packaging Manual 第７章
早瀬です。
Packaging Manual 第７章の作業が終りました。
最後に添付しておきますので、よろしくお願いします。
現在、作業中のものは
ii packaging-manua 3.0.0.0 Debian Packaging Manual
のものなのですが、現在ではもう少しバージョンが進んでいるようなので、
そのうちにダウンロードして、最新版へ対応させます。
--
早瀬 茂規 (shayase@xxxxxxxxxxxxxxx)
<!-- ORIG
<chapt id="descriptions"><heading>Descriptions of packages - the
<tt>Description</tt> field
ORIG -->
<chapt id="descriptions"><heading>パッケージの説明文 -
<tt>Description</tt> フィールド
</heading>
<p>
<!-- ORIG
The <tt>Description</tt> control file field is used by
<prgn>dselect</prgn> when the user is selecting which packages
to install and by <prgn>dpkg</prgn> when it displays
information about the status of packages and so forth. It is
included on the FTP site in the <prgn>Packages</prgn> files,
and may also be used by the Debian WWW pages.
ORIG -->
コントロールファイルの <tt>Description</tt> フィールドは、
ユーザがインストールパッケージを選択するとき
<prgn>dselect</prgn> によって表示されます。
また、<prgn>dpkg</prgn> が、そのパッケージの情報を表示するとき
にも使われます。FTP サイトの <prgn>Packages</prgn> ファイルにも
含まれており、その他に Debian のウェブページでも使われています。
</p>
<p>
<!-- ORIG
The description is intended to describe the program to a user
who has never met it before so that they know whether they
want to install it. It should also give information about the
significant dependencies and conflicts between this package
and others, so that the user knows why these dependencies and
conflicts have been declared.
ORIG -->
この Description フィールドはパッケージの簡単な解説で、
それまで使用したことのないプログラムをインストールするかどうかの
判断を助けるものです。パッケージ間の依存関係 (dependency)
や競合関係 (conflict) の情報も示されていなければいけません。
そうでないと、ユーザにはなぜ競合関係や依存関係の不具合が
起きているのかが分かりません。
</p>
<p>
<!-- ORIG
The field's format is as follows:
<example>
Description: <var>single line synopsis</var>
<var>extended description over several lines</var>
</example>
ORIG -->
このフィールドのフォーマットは以下の通りです。
<example>
Description: <var>一行の要約</var>
<var>複数行にわたる詳細な解説部分</var>
</example>
</p>
<p>
<!-- ORIG
The synopsis is often printed in lists of packages and so
forth, and should be as informative as possible. Every
package should also have an extended description.
ORIG -->
一行要約の部分は、ふつうはパッケージのリストですが、
出来るだけ情報量が多くなるようにします。そして、すべての
パッケージは複数行に渡る詳細な解説部分を持っていなければ
いけません。
</p>
<!-- ORIG
<sect><heading>Types of formatting line in the extended
description
ORIG -->
<sect><heading>詳細説明文のフォーマット
</heading>
<p>
<list>
<item>
<p>
<!-- ORIG
Those starting with a single space are part of a
paragraph. Successive lines of this form will be
word-wrapped when displayed. The leading space will
usually be stripped off.
ORIG -->
解説部分の段落の構成行はかならず一文字の空白で
始まります。表示時に継続行はワード単位で折りかえされて
表示されます。最初の空白は表示時には削除されます。
</p>
</item>
<item>
<p>
<!-- ORIG
Those starting with two or more spaces. These will be
displayed verbatim. If the display cannot be panned
horizontally the displaying program will linewrap them
`hard' (ie, without taking account of word breaks).
If it can they will be allowed to trail off to the
right. None, one or two initial spaces may be
deleted, but the number of spaces deleted from each
line will be the same (so that you can have indenting
work correctly, for example).
ORIG -->
二つかそれ以上の空白で始まる行は、そのままの表示に
なります。ディスプレイが水平方向に拡張することが
できない場合、表示プログラムは改行をきっちりと行います
(つまり、ワード単位の折り返しについて関知しません)。
もし可能であれば、右側に向かって表示が消えることも
許されています。表示時に 0 個または、1、2 個の行頭の
空白が削除されることもあります。この場合の各行の
削除される空白の数はすべての行において同じになります
(この結果、インデントは正常に表示されます)。
</p>
</item>
<item>
<!-- ORIG
<p>Those containing a single space followed by a single full stop
character. These are rendered as blank lines. This
is the <em>only</em> way to get a blank line - see
below.</p>
ORIG -->
<p>一つの空白の後に一つのピリオドを含む行は空白行となります。
これは空白行を表示するための<em>唯一の</em>方法です。
以下も参照してください。</p>
</item>
<item>
<p>
<!-- ORIG
Those containing a space, a full stop and some more
characters. These are for future expansion. Do not
use them.</p>
ORIG -->
一つの空白の後にピリオドといくつかの文字を含む行は
将来の拡張のために用いられる予定です。使用しないで
ください。</p>
</item>
</list>
</p>
</sect>
<!-- ORIG
<sect><heading>Notes about writing descriptions
ORIG -->
<sect><heading>説明部分を書く上での留意事項
</heading>
<p>
<!-- ORIG
<em>Always</em> start extended description lines with at least one
whitespace character. Fields in the control file and in the Packages
file are separated by field names starting in the first column, just
as message header fields are in RFC822. Forgetting the whitespace
will cause <prgn>dpkg-deb</prgn>
<footnote>
<p>
Version 0.93.23 or later.
</p>
</footnote> to produce a syntax error when trying to build
the package. If you force it to build anyway
<prgn>dpkg</prgn> will refuse to install the resulting
mess.
ORIG -->
詳細の解説部分は、少くとも一つの空白から
<em>必ず</em>始まります。コントロールファイルと Packages
ファイルの中のフィールドは RFC822 におけるメッセージヘッダの
ように行頭から始まるフィールド名で区切られます。行頭の空白を
忘れた場合、パッケージの作成の時に <prgn>dpkg-deb</prgn>
<footnote>
<p>
バージョン 0.93.23 以降。
</p>
</footnote> が文法エラーを指摘します。
強制的に構築したとしても、<prgn>dpkg</prgn> が
インストールするのを拒否します。
</p>
<p>
<!-- ORIG
<em>Do not</em> include any completely <em>empty</em>
lines. These separate different records in the Packages file
and different packages in the <tt>debian/control</tt> file,
and are forbidden in package control files. See the
previous paragraph for what happens if you get this wrong.
ORIG -->
完全な<em>空</em>行を含んでは<em>いけません</em>。
これらは Packages ファイル中のそれぞれのレコードと、
<tt>debian/control</tt> ファイル中の違うパッケージの区別に
用いられます。そして、これらを
パッケージコントロールファイル中で用いることは
禁じられています。これを間違うとどうなるかは、前段落を
参照してください。
</p>
<p>
<!-- ORIG
The single line synopsis should be kept brief - certainly
under 80 characters. <prgn>dselect</prgn> displays between
25 and 49 characters without panning if you're using an
80-column terminal, depending on what display options are in
effect.
ORIG -->
一行による要約は簡潔に。もちろん (訳注：半角換算で)
80 文字以下で。80 列ターミナルを使っていて拡張表示を
してなければ、<prgn>dselect</prgn> は (訳注：半角換算で)
25 から 49 文字を表示しません。表示は有効な
ディスプレイオプションによります。
</p>
<p>
<!-- ORIG
Do not include the package name in the synopsis line. The
display software knows how to display this already, and you
do not need to state it. Remember that in many situations
the user may only see the synopsis line - make it as
informative as you can.
ORIG -->
パッケージ名を要約 (Synopsis) の行に入れないでください。
入れなくても、表示ソフトウェアはパッケージ名を自動的に
表示するようになっています。多くの場合、ユーザの目に
ふれるのはこの要約行だけなので、なるだけ分かりやすい
要約にするようにしてください。
</p>
<p>
<!-- ORIG
The extended description should describe what the package
does and how it relates to the rest of the system (in terms
of, for example, which subsystem it is which part of).
ORIG -->
詳細の解説部分はそのパッケージ自体の説明およびその他の
システムとの関連 (例えば、Debian System 全体のなかで、
どのパッケージがここに含まれるか、など) について記します。
</p>
<p>
<!-- ORIG
The blurb that comes with a program in its announcements
and/or <prgn>README</prgn> files is rarely suitable for use
in a description. It is usually aimed at people who are
already in the community where the package is used. The
description field needs to make sense to anyone, even people
who have no idea about any of the things the package deals
with.
ORIG -->
そのプログラムにもともと付いているアナウンスや
<prgn>README</prgn> をそのままこの Description に使用可能な
ことはほとんどありません。だいたい、これらの文章は
そのソフトウェアがどんなふうに使われているのかすでに知っている
ユーザコミュニティ向けに書かれています。けれども、
Debian システムの場合、そのパッケージが一体どんなことを
するのか全く知らない人がこの Description: フィールドを読んで、
そのパッケージの概略について理解できなければいけません。
</p>
<p>
<!-- ORIG
Put important information first, both in the synopis and
extended description. Sometimes only the first part of the
synopsis or of the description will be displayed. You can
assume that there will usually be a way to see the whole
extended description.
ORIG -->
要約行および詳細の解説部分、これら両方の部分において、
重要な情報を最初に持ってきてください。実際の表示時に、
要約行または詳細の解説部分の一部しか表示されないことが
あります。もっとも、そういう時は、詳細の解説部分全体を
表示することができるようになっているはずです。
</p>
<p>
<!-- ORIG
You may include information about dependencies and so forth
in the extended description, if you wish.
ORIG -->
もし望むならば、依存関係などの情報も解説部分に含ませることが
できます。
</p>
<p>
<!-- ORIG
Do not use tab characters. Their effect is not predictable.
ORIG -->
タブは使用しないでください。どういう動作をするか分かりません。
</p>
<p>
<!-- ORIG
Do not try to linewrap the summary (the part on the same
line as the field name <tt>Description</tt>) into the
extended description. This will not work correctly when the
full description is displayed, and makes no sense where only
the summary is available.</p>
ORIG -->
フィールド名 <tt>Description</tt> との同一行の要約部分を
改行して、詳細の解説部分に入らないようにしてください。
解説文全体が正しく表示されなくなるでしょう。そして、
要約文しか表示されないので、そのパッケージがどういうことを
するパッケージなのかが分かりにくくなります。</p>
</sect>
<!-- ORIG
<sect><heading>Example description in control file for Smail
ORIG -->
<sect><heading>例：パッケージ Smail のコントロールファイルの説明文
</heading>
<p>
<example>
Package: smail
Version: 3.1.29.1-13
Maintainer: Ian Jackson <iwj10@xxxxxxxxxxxxx>
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.
</example>
</p>
</sect>
</chapt>