[JM:00270] Re: help2man help2man.1

Zurück zum Archiv-Index

長南洋一 cyoic****@maple*****
2011年 5月 11日 (水) 12:42:02 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)」と「すなわち」を入れる手は
あるかもしれません。とは言え、決定権は言うまでもなく赤星さんに
あります。ご自由に選んでください。

> > すでにご存知かも知れませんが、name of manual や source of program が
> > 何かについては、man 7 man-pages に書いてありました。「タイトル行」を
> > 説明している部分です。もしまだなら、お読みになっておくと、よいと思います。

>  勉強不足で申し訳ありません。読んでみて --name オプションや --source 
> オプションの訳文を修正しました。

こっちについても論じておきます。

--name については、「コマンドの短い」を補足したのですね。
一般的に言って、補足をしなくても十分意味が通じるなら、補足訳は
しない方がよいと思います (補足をしないと意味がわかりにくいときは、
遠慮せずにやるべきですが)。必要なとき以外、できるだけ原文を変え
ないですますのが、翻訳者の良心でしょうから。この場合は、補足して
もよく、しなくてもよいところだと思います。

次に、--source ですが、これで指定した文字列は man ページのフッタの
左下に現れるのですね。すこし例を挙げてみます (日本語マニュアルには
古いものもあるので、LANG=C で調べました)。

  ls(1)           GNU coreutils 8.5
  cat(1)          GNU coreutils 8.5
  gawk(1)         Free Software Foundation
  perl(1)         perl v5.10.1
  nm(1)           binutils-2.20
  read(2)         Linux
  printf(3)       GNU
  null(4)         Linux
  resolv.conf(5)  4th Berkeley Distribution (これは書式が違うかも)
  signal(7)       Linux
  ifconfig(8)     net-tools
  iptables(8)     iptables 1.4.8
  fsck(8)         Linux

coreutils や net-tools が「開発元、配布元」と言えるならば、
「開発元」や「配布元」の方が明解でよいと思います。
でも、man-pages(7) にならって、「出自」にしておく方が、たしかに
無難かもしれません。

> # source は、なんか GNU でも本来の意味が忘れられているんじゃないかという
> # 感じがしましたが…

そうですね。プログラムのバージョンが書いてあったりして。

--manual については、man-pages(7) によれば、title が man ページの
タイトル (つまり、LS とか NULL とか IPTABLES とか) なのに対して、
その man ページが属するマニュアルのグループのタイトルなのですね。
だから、システムコールや関数のこの部分は、「Linux Programmer's Manual」
になる。これもすこし例を挙げてみます。

  ls(1)           User Commands
  gawk(1)         Utility Commands
  perl(1)         Perl Programmers Reference Guide
  nm(1)           GNU Development Tools
  read(2)         Linux Programmer's Manual
  printf(3)       Linux Programmer's Manua
  null(4)         Linux Programmer's Manual
  export(5)       Linux File Formats Manual
  fstab(5)        Linux Programmer's Manual
  signal(7)       Linux Programmer's Manual
  ifconfig(8)     Linux Programmer's Manual
  iptables(8)     iptables 1.4.8
  useradd(8)      System Management Commands
  fsck(8)         MAINTENANCE COMMANDS

 たしかに、man-pages(7) の「マニュアルのタイトル」という表現より、
「マニュアルの種類」の方が適切かもしれません。「マニュアルのグループ」
といった訳はあるかもしれませんが。

> > ついでに、バグ報告の真似事です。
> > Vine 5.2 で help2man-1.39.2-4vl6 を使って見ました。
> > 
> >   help2man -L ja_JP.UTF-8 -o cat.man cat
> >
> > をやってみたのですが、「例」の見出しがちょっと変です。「説明」の
> > 中の小見出しのような形で「Examples:」となっています。
> > それから、「バグの報告」のセクションが独立していません。
> > 
> > Vine Seed なら、こういった問題は生じないのですか。
>
>  おそらく、VineSeed と 5.2 で locale の定義が変わっているのが原因です。
>
>  help2man -L ja_JP.utf8 -o cat.man cat
>
> とするとうまく行きませんでしょうか。ダメであれば、SPEC ファイルの
>
> echo "ja        ja_JP.utf8" >> locales
>
> となっている部分を
>
> echo "ja        ja_JP.UTF-8" >> locales
>
> に修正してビルドしなおす必要があるかもしれません。

両方やってみましたが、変化がありませんでした。

それに、前からですが、フッタの日付が文字化けしています。
現在はこんなメッセージが出ています。

  troff: warning: can't find character with input code 156
  troff: warning: can't find character with input code 136

もっとも、この help2man は次期バージョン用なのでしょうから、
Vine Seed できちんと動いているのならば、お気になさらないで
よいだろうと思います。

-- 
長南洋一




linuxjm-discuss メーリングリストの案内
Zurück zum Archiv-Index