Yasumichi Akahoshi
yasum****@vinel*****
2011年 5月 11日 (水) 22:30:32 JST
赤星です。 >> EXECUTABLE should accept `--help' and `--version' options and produce >> output on stdout although alternatives may be specified using: > >> 引数 EXECUTABLE には、マニュアル作成の対象とするコマンドを指定する。 >> 指定するコマンドは、--help や --version というオプションを受け入れて、 >> 標準出力にメッセージを表示するようになっているべきである。もっとも、 >> 以下のオプションを使えば、--help や --version に相当する別の >> オプションを指定することが可能だ。 > >> としてみました。長南さんの懸念の解決にはなってないかと思いますが、 >> 引数 EXECUTABLE が存在するんだなという風にユーザーを誘導する >> ぐらいにはなるのかなという気はします。 > > これでもよいと思います。ただ、わたしとしては、読者の読解力に > 頼ることは、できるだけしない方がよいと思います。別に言い方を > するなら、後方参照をやるのならば、すでに出現した言葉を (たとえば > 「書式」を) 使うか、「上記」といった言葉を使って、明示的に > やった方が、読者の誤解や混乱を避けられると思います。そんなわけで、 > わたしは、「マニュアル作成の対象になるコマンド (上記書式の > EXECUTABLE)」(あるいは、ここからカッコを取り除いて、後方参照を > まったくしないもの) の方を支持します。微妙ですが、カッコ内に > 「(すなわち、引数の EXECUTABLE)」と「すなわち」を入れる手は > あるかもしれません。とは言え、決定権は言うまでもなく赤星さんに > あります。ご自由に選んでください。 発想を変えてみました。若干、原文の流れと異なってしまいますがオプションの説明に入る前に EXECUTABLE とは何かを説明し、のちの説明では EXECUTABLE を省きました。 > それに、前からですが、フッタの日付が文字化けしています。 > 現在はこんなメッセージが出ています。 > > troff: warning: can't find character with input code 156 > troff: warning: can't find character with input code 136 > > もっとも、この help2man は次期バージョン用なのでしょうから、 > Vine Seed できちんと動いているのならば、お気になさらないで > よいだろうと思います。 原因を特定できませんが、Vine Linux 5.2 と VineSeed では関連すると思わ れるパッケージのバージョンが大きく異なっています。 ・man -> man-db ・groff ・perl ・glibc この辺のどれかに原因があるような気がします。 現在、6月末ごろを目標に Vine Linux 6.0 のリリース準備が進められていま すが、その際にもご確認いただけたら幸いです。 <STATUS> stat: DP ppkg: help2man page: help2man.1 date: 2011/05/11 mail: yasum****@vinel***** name: Yasumichi Akahoshi </STATUS> .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.39.2. .\"O .TH HELP2MAN "1" "May 2011" "help2man 1.39.2" "User Commands" .TH HELP2MAN "1" "2011年5月" "help2man 1.39.2" "ユーザーコマンド" .\"O .SH NAME .\"O help2man \- generate a simple manual page .SH 名前 help2man \- 簡易マニュアルページの生成 .\"O .SH SYNOPSIS .\"O .B help2man .\"O [\fIOPTION\fR]... \fIEXECUTABLE\fR .SH 書式 .B help2man [\fIOPTION\fR]... \fIEXECUTABLE\fR .\"O .SH DESCRIPTION .\"O `help2man' generates a man page out of `\-\-help' and `\-\-version' output. .SH 説明 `help2man' は `\-\-help' および `\-\-version' の出力を元にマニュアルページを生成する。 .PP 引数 EXECUTABLE には、マニュアル作成の対象とするコマンドを指定する。 .\"O .TP .\"O \fB\-n\fR, \fB\-\-name\fR=\fISTRING\fR .\"O description for the NAME paragraph .TP \fB\-n\fR, \fB\-\-name\fR=\fISTRING\fR 「名前」セクションで使うコマンドの短い説明 .\"O .TP .\"O \fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR .\"O section number for manual page (1, 6, 8) .TP \fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR マニュアルページが所属するセクションの番号 (1, 6, 8) .\"O .TP .\"O \fB\-m\fR, \fB\-\-manual\fR=\fITEXT\fR .\"O name of manual (User Commands, ...) .TP \fB\-m\fR, \fB\-\-manual\fR=\fITEXT\fR マニュアルの種類 (ユーザコマンド, ...) .\"O .TP .\"O \fB\-S\fR, \fB\-\-source\fR=\fITEXT\fR .\"O source of program (FSF, Debian, ...) .TP \fB\-S\fR, \fB\-\-source\fR=\fITEXT\fR プログラムの出自 (FSF, Debian, ...) .\"O .TP .\"O \fB\-L\fR, \fB\-\-locale\fR=\fISTRING\fR .\"O select locale (default "C") .TP \fB\-L\fR, \fB\-\-locale\fR=\fISTRING\fR ロケールを選択する (デフォルトは "C") .\"O .TP .\"O \fB\-i\fR, \fB\-\-include\fR=\fIFILE\fR .\"O include material from `FILE' .TP \fB\-i\fR, \fB\-\-include\fR=\fIFILE\fR `FILE' から原稿を取り込む .\"O .TP .\"O \fB\-I\fR, \fB\-\-opt\-include\fR=\fIFILE\fR .\"O include material from `FILE' if it exists .TP \fB\-I\fR, \fB\-\-opt\-include\fR=\fIFILE\fR `FILE' が存在した場合 `FILE' から原稿を取り込む .\"O .TP .\"O \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR .\"O send output to `FILE' .TP \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR `FILE' へ出力を送る .\"O .TP .\"O \fB\-p\fR, \fB\-\-info\-page\fR=\fITEXT\fR .\"O name of Texinfo manual .TP \fB\-p\fR, \fB\-\-info\-page\fR=\fITEXT\fR Texinfo マニュアルの名前 .\"O .TP .\"O \fB\-N\fR, \fB\-\-no\-info\fR .\"O suppress pointer to Texinfo manual .TP \fB\-N\fR, \fB\-\-no\-info\fR Texinfo マニュアルの紹介を省略する .\"O .TP .\"O \fB\-l\fR, \fB\-\-libtool\fR .\"O exclude the `lt\-' from the program name .TP \fB\-l\fR, \fB\-\-libtool\fR プログラム名から `lt\-' を取り除く .\"O .TP .\"O \fB\-\-help\fR .\"O print this help, then exit .TP \fB\-\-help\fR 簡単な使い方を表示し終了する .\"O .TP .\"O \fB\-\-version\fR .\"O print version number, then exit .TP \fB\-\-version\fR バージョン番号を表示し終了する .\"O .PP .\"O EXECUTABLE should accept `\-\-help' and `\-\-version' options and produce output on .\"O stdout although alternatives may be specified using: .PP マニュアル作成の対象になるコマンドは、\-\-help や \fB\-\-version\fR というオプションを受け入れて、 標準出力にメッセージを表示するようになっているべきである。 もっとも、以下のオプションを使えば、\-\-help や \fB\-\-version\fR に相当する別のオプションを指定することが可能だ。 .\"O .TP .\"O \fB\-h\fR, \fB\-\-help\-option\fR=\fISTRING\fR .\"O help option string .TP \fB\-h\fR, \fB\-\-help\-option\fR=\fISTRING\fR ヘルプ表示オプションの文字列 .\"O .TP .\"O \fB\-v\fR, \fB\-\-version\-option\fR=\fISTRING\fR .\"O version option string .TP \fB\-v\fR, \fB\-\-version\-option\fR=\fISTRING\fR バージョン表示オプションの文字列 .\"O .TP .\"O \fB\-\-version\-string\fR=\fISTRING\fR .\"O version string .TP \fB\-\-version\-string\fR=\fISTRING\fR バージョンとして表示する文字列 .\"O .TP .\"O \fB\-\-no\-discard\-stderr\fR .\"O include stderr when parsing option output .TP \fB\-\-no\-discard\-stderr\fR オプションの出力を解析するときに標準エラー出力を含める .\"O .SH "INCLUDE FILES" .\"O Additional material may be included in the generated output with the .\"O .B \-\-include .\"O and .\"O .B \-\-opt\-include .\"O options. The format is simple: .\"O .\"O [section] .\"O text .\"O .\"O /pattern/ .\"O text .\"O .SH インクルードファイル .B \-\-include や .B \-\-opt\-include オプションを使用すると、生成する出力に追加の原稿を取り込むことができる。ファイルの書式は単純である。 [セクション] 本文 /パターン/ 本文 .\"O Blocks of verbatim *roff text are inserted into the output either at .\"O the start of the given .\"O .BI [ section ] .\"O (case insensitive), or after a paragraph matching .\"O .BI / pattern /\fR. .\"O 本文は *roff のテキストであり、出力中の、指定された .BI [ セクション ] (大文字・小文字は区別されない) の先頭部分や .BI / パターン /\fR. にマッチするパラグラフの直後に、そのままの形で挿入される。 .\"O Patterns use the Perl regular expression syntax and may be followed by .\"O the .\"O .IR i , .\"O .I s .\"O or .\"O .I m .\"O modifiers (see .\"O .BR perlre (1)). .\"O パターンには Perl の正規表現の文法を使用する。修飾子の .IR i , .I s , .I m を後に付けることもできる ( .BR perlre (1) を参照)。 .\"O Lines before the first section or pattern which begin with `\-' are .\"O processed as options. Anything else is silently ignored and may be .\"O used for comments, RCS keywords and the like. .\"O 最初のセクションやパターンより前にある行で、'\-' で始まっている行は、 オプションとして処理される。それ以外は、何もせずに無視されるのでコメントや RCS のキーワードなどに使用することができる。 .\"O The section output order (for those included) is: .\"O .\"O NAME .\"O SYNOPSIS .\"O DESCRIPTION .\"O OPTIONS .\"O ENVIRONMENT .\"O FILES .\"O EXAMPLES .\"O \fIother\fR .\"O AUTHOR .\"O REPORTING BUGS .\"O COPYRIGHT .\"O SEE ALSO .\"O セクションの出力順序: 名前 書式 説明 オプション 環境変数 ファイル 例 \fIその他\fR 作者 バグの報告 著作権 関連項目 .\"O Any .\"O .B [NAME] .\"O or .\"O .B [SYNOPSIS] .\"O sections appearing in the include file will replace what would have .\"O automatically been produced (although you can still override the .\"O former with .\"O .B --name .\"O if required). .\"O インクルードファイルに .B [名前] や .B [書式] というセクションがあれば、そこに記述した内容が、自動的に生成される内容のかわりに出力される。 (もっとも、どうしても必要ならば、前者については、 .B --name オプションを使って、さらに置き換えることができるが。) .\"O Other sections are prepended to the automatically produced output for .\"O the standard sections given above, or included at .\"O .I other .\"O (above) in the order they were encountered in the include file. それ以外のセクションについては、上記の標準的なセクションのために 自動的に生成される出力の前に挿入されるか、あるいは、(上記の) .I その他 の位置に、インクルードファイル中で見つかった順番で取り込まれる。 .\"O .SH AVAILABILITY .\"O The latest version of this distribution is available on-line from: .\"O .\"O ftp://ftp.gnu.org/gnu/help2man/ .SH 入手先 この配布物の最新バージョンは次の場所から入手可能である。 ftp://ftp.gnu.org/gnu/help2man/ .\"O .SH AUTHOR .\"O Written by Brendan O'Dea <bod****@debia*****> .SH 作者 作者は Brendan O'Dea <bod****@debia*****> である。 .\"O .SH "REPORTING BUGS" .\"O Report bugs to <bug\-help****@gnu*****>. .SH バグの報告 バグを発見した場合は <bug\-help****@gnu*****> に報告されたい。 .\"O .SH COPYRIGHT .\"O Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, .\"O 2011 Free Software Foundation, Inc. .\"O .br .\"O This is free software; see the source for copying conditions. There is NO .\"O warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .SH 著作権 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .\"O .SH "SEE ALSO" .\"O The full documentation for .\"O .B help2man .\"O is maintained as a Texinfo manual. If the .\"O .B info .\"O and .\"O .B help2man .\"O programs are properly installed at your site, the command .\"O .IP .\"O .B info help2man .\"O .PP .\"O should give you access to the complete manual. .SH 関連項目 .B help2man の完全なマニュアルは Texinfo マニュアルとして整備されている。もし、 .B info および .B help2man のプログラムが正しくインストールされているならば、コマンド .IP .B info help2man .PP を使用すると完全なマニュアルを読むことができるはずだ。 -- Yasumichi Akahoshi GnuPG fingerprint = 04D4 DB0D 37CB A251 2671 1BAB 2369 F522 E440 9DCF
Fork