[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Debian Policy Manual Chapter 6
おつかれさまです。訳文中心にみてみました。
From: Seiji Kaneko <skaneko@xxxxxxxxxxxx>
Subject: Debian Policy Manual Chapter 6
Date: Sun, 21 May 2000 14:04:58 +0900
> <!-- <chapt><heading>Documentation</heading> -->
> <chapt><heading>文書</heading>
“Documentation”って「文書化」なんですが、章のタイトルとしては
どっちがいいでしょうかね?
> <p><!--
> You must install manual pages in <prgn>nroff</prgn> source
> form, in appropriate places under <tt>/usr/share/man</tt>. You
> should only use sections 1 to 9 (see the FHS for more
> details). You must <em>not</em> install a preformatted `cat
> page'.-->
> マニュアルは <prgn>nroff</prgn>ソース形式で <tt>/usr/share/man</tt>
> の適切な場所にインストールしなければなりません。また、セクションは
> 1 から 9 までのみをつかうべきです (詳しくはFSSTND参照)。フォーマット
> 済みの 'cat' 形式のマニュアルをインストールしては<em>いけません</em>。
<
> /p>
上の行の「</em>。」の後ろに^Mが入っています。
“FSSTND”→“FHS”(原文もそうなってる)。
「nroff ソース形式」は「nroff 形式」と書いても間違えようがないと
思います。で、そこまでいくなら「roff 形式」のほうが一般的かな、と。
> 特定のプログラム、ユーティリティ、関数でマニュアルが存在せず、，
> debuan-bugs で bug として報告済みになっている場合、対応するマ
> ニュアルページは <manref name="undocumented" section="7"> マ
> ニュアルへのシンボリックリンクにしておくべきです．
> このシンボリックリンクは以下のようにして <tt>debian/rules</tt>
> で作成することができます．
「マニュアルが存在せず、」
「シンボリックリンクにしておくべきです。」
「作成することができます。」
右端の文字の話。ほかにもあります。
> <example>
> ln -s ../man7/undocumented.7.gz \
> debian/tmp/usr/man/man[1-9]/the_requested_manpage.[1-9].gz
> </example>
“/usr/share/man/”(原文もそうなってる)
> This manpage claims that the lack of a manpage has been
> reported as a bug, so you may only do this if it really has
> このマニュアルページにはマニュアルの欠如はバグとして既に報告されて
> いると書かれているため、上記のように処理していいのは本当にバグと
> して報告がなされている場合のみです (自分で報告しておいてもかまい
> ません)。
「書かれているため」→「主張していて、そのため」
“claim”なので、ちょっと強めにしてみたかったのですが、どうでしょう。
> いとしていますが、我々はバグとみなします．彼らがバグではない
「みなします。」
> <!-- If one manpage needs to be accessible via several names it
> is better to use a symbolic link than the <tt>.so</tt>
> feature, but there is no need to fiddle with the relevant
> parts of the upstream source to change from <tt>.so</tt> to
> symlinks--don't do it unless it's easy. Do not create hard
> 一つのマニュアルページを複数の名前で参照する必要がある場合は、
> <tt>.so</tt> 機能を使うよりもシンボリックリンクを使う方が望
> ましいのですが、上流のソースの部分を<tt>.so</tt>からシンボリ
> ックリンクへ変更する必要はありません。それが余程簡単で
「…シンボリックリンクを使うほうが望ましいです。ですが、上流のソースが
<tt>.so</tt> 機能を使っている場合、それをシンボリックリンクに変更する
必要はありません。それがよほど簡単で…」
> <tt>/usr/man</tt>です) からの相対参照とすべきです．
「すべきです。」
> <!-- Your package must call <prgn>install-info</prgn> to update the
> Info <tt>dir</tt>
> file, in its post-installation script:-->
> パッケージは info 文書の <tt>dir</tt> ファイルを更新するために
> postinst スクリプト中で <prgn>install-info</prgn> を呼び出さな
> ければなりません。
「info 文書の」→「Info システムの」
> flag takes two arguments; the first is a regular expression
> to match (case-insensitively) against an existing section,
> the second is used when creating a new one.-->
> ことに注意してください。最初の引数は存在しているセクションと一
> 致させる正規表現 (大文字小文字は区別しません) で、もう一つは新
> しいものを作るときに使います。
勝手に追加。
「…もう一つは、最初の引数に一致するセクションがないときに作成する、
新しいセクションとして使います」
> <!-- You must remove the entries in the pre-removal script:-->
> prerm スクリプト中で上記エントリを以下のようにして削除してください。
「prerm スクリプト中では、次のように記述して、エントリを削除するように
してください。」
> <!-- If a package comes with large amounts of documentation which
> many users of the package will not require you should create
> a separate binary package to contain it, so that it does not
> take up disk space on the machines of users who do not need
> or want it installed. -->
> 対象とするパッケージを使う殆どのユーザが必要としないような多量の
> 文書を含むようなパッケージは、そのような文書を収録した独立のパッ
> ケージを作成して、そのような文書を必要としないか、インストール
> したくないユーザがマシンのディスクスペースを消費しなくてもいいよ
> うにしておくべきです。
> </p>
「殆ど」→「ほとんど」
(単に好みです…)
「…独立したパッケージを作成して、必要でないユーザがディスクスペースを
消費しないように、逆に、必要ならインストールできるようにすべきです」
“or want it installed.”は否定じゃないと思うので(違うかも)。
> のことですが、パッケージの作成やインストール方法についてかかれた
> ものを含める必要はありません。
「かかれた」→「書かれた」
> <!-- Former Debian releases placed all additional documentation
> in <tt>/usr/doc/<var>package</var></tt>. To realize a
> smooth migration to
> <tt>/usr/share/doc/<var>package</var></tt>, each package
> した。現在使われている <tt>/usr/share/doc/<var>package</var></tt>
> ディレクトリへのスムーズな移行のために各パッケージは
「移行のために各パッケージは」→「移行のために、各パッケージは」
> <!-- If your package comes with extensive documentation in a
> mark up format that can be converted to various other formats
> you should if possible ship HTML versions in a binary
> package, in the directory
> <tt>/usr/share/doc/<var>appropriate package</var></tt> or its
> subdirectories.-->
> パッケージに各種書式に変換可能なマークアップ形式の詳細文書が付属
> している場合は、バイナリパッケージには可能なかぎり HTML 形式のも
> のを <tt>/usr/share/doc/<var>appropriate package</var></tt>、お
> よびそのサブディレクトリにインストールしてください。<P>
“appropriate package”ですが、ほかのところで単に“package”と
しているので、ここもそうやっていいと思います。
>
> <footnote>
> <p><!-- The rationale: The important thing here is that HTML
> docs should be available in <em>some</em> package, not
> necessarily in the main binary package, though. -->
> 原則論：ここで重要なことは、HTML 形式の文書は<em>一部</em>の
> パッケージに収録されているとしても、main のバイナリパッケージ
> 全部に収録されているわけではないということです。
「原理: HTML 形式の文書は<em>一部</em>のパッケージに収録されているので
あって、必ずしも main のバイナリパッケージ全部に収録されているわけ
ではない。」
> <!-- 脚注の意図不明。バグレポート回避用？ -->
原理というより注意ですよね。
> <!-- Other formats such as PostScript may be provided at your
> option.-->
> PostScriptのような他の形式は自分の好みで提供してください．</p>
「提供してください。」
> <!-- Why "licenses" and not "copyright"? Because
> <tt>/usr/doc/copyright</tt> used to contain all the
> copyright files, plus the four common licenses GPL,
> LGPL, Artistic and BSD. Now individual copyright files
> for packages are no longer in a common directory. Once
> <tt>/usr/doc/copyright</tt> is almost empty it makes
> sense to rename "copyright" to "licenses"-->
> 『ライセンス』であって『著作権』となっていない理由ですが、
“copyright”“licenses”は、ファイル名やディレクトリ名にもなって
いますので、訳と英語を併記したほうがよいでしょう。
> <!-- Why "common-licenses" and not "licenses"? Because if I
> put just "licenses" I'm sure I will receive a bug report
> saying "license foo is not included in the licenses
> directory. They are not all the licenses, just a few
> common ones. I could use /usr/share/doc/common-licenses
> but I think this is too long, and, after all, the GPL
> does not "document" anything, it is merely a license.
> -->
> ディレクトリ名称が "common-licenses" であって "licenses" では
> ないのは、単に "licenses" としておいた場合には「ほげふがライ
> センスがライセンスディレクトリに収録されていない」というバグ
知らない人が調べる場合、「ほげふが」よりは「ほげほげ」「ふがふが」の
ほうが調べやすいかと。よけいなお世話かも。
> レポートを受け取る羽目になることがほとんど確実だからです。ここ
> に置かれるのはライセンス全部、という訳ではなく少数のよく使わ
> れているもののみです。/usr/share/doc/common-licenses でもいい
> んですが、ちょっと長すぎるのと、GPL は結局のところ『ライセンス』
「いいんですが」→「いいのですが」
> Do not use the copyright file as a general <tt>README</tt>
> file. If your package has such a file it should be
> installed in <tt>/usr/share/doc/<var>package</var>/README</tt> or
> <tt>README.Debian</tt> or some other appropriate place.
> copyrightファイルを一般的な <tt>README</tt> として使わないで
> ください。パッケージがそのような <tt>README</tt> ファイルを持
> っている場合は <tt>/usr/share/doc/<var>package</var>/README</tt>、
> あるいは <tt>README.Debian</tt> やその他の適切な場所にインス
> トールされるべきです。
原文からですが、READMEとして使うなと書いてあるのに、その次にREADMEや
README.Debianとしてインストールしろとはどういうことでしょう?
> documentation only. Architecture-specific example files
> should be installed in a directory
> <tt>/usr/lib/<var>package</var>/examples</tt>, and files in
> <tt>/usr/share/doc/<var>package</var>/examples</tt> symlink
> to files in it. Or the latter directory may be a symlink to
> the former. -->
> から各ファイルにシンボリックリンクを張ってください。または、
> <tt>/usr/share/doc/<var>package</var>/examples</tt> が
> <tt>/usr/lib/<var>package</var>/examples</tt> へのシンボリッ
> クリンクであってもかまいません。
「または逆に、<tt>…」
> <!-- Both should be installed compressed using <tt>gzip -9</tt>,
> as they will become large with time even if they start out small.-->
> 両方とも、始めはとても小さいものかもしれませんが時が経てば大き
> くなるので、<tt>gzip -9</tt>を使って圧縮してインストールしてく
> ださい。
> </p>
「しれませんが、時が経てば」
> <!-- If the package has only one changelog which is used both as
> the Debian changelog and the upstream one because there is
> no separate upstream maintainer then that changelog should
> usually be installed as
> <tt>/usr/share/doc/<var>package</var>/changelog.gz</tt>; if
> 上流の開発者が独立に存在していないために Debian changelog と
「上流の開発者とパッケージメンテナが同一人物の場合」…というより、
「Debian専用パッケージのため」ですよね?
--
喜瀬“冬猫”浩＠南国沖縄