Next: NEWS File, Previous: GNU Manuals, Up: Documentation
マニュアルの表紙は、そのマニュアルで記述されるプログラムやパッケージのバー ジョンを述べるべきだ。マニュアルの一番上の節もまたこの情報を含むべきだ。 もしマニュアルがプログラムより頻繁に、あるいは、無関係に変更されているな ら、それらの場所の両方で、そのマニュアルのバージョン・ナンバーを記述しな さい。
そのマニュアルで記述されるそれぞれのプログラムは、‘program Invocation’とか‘Invoking program’と名付けられた節を持つべきだ。 この節は(もしあれば、その副節と共に)そのプログラムのコマンドラインの引数 とそれの走らせ方(人々がmanページで探し求める情報の類い)を記すべきだ。そ のプログラムが使う、すべてのオプションと引数のテンプレートを含む ‘@example’で始めなさい。
あるいは、項目の名前が上の様式の一つに合う表に項目を書きなさい。これ は、その節の本当の名前とは関係なしに、この目的のための節として、項目が指 し示す節を識別する1。
プログラム名を指定し、そのマニュアルのこれの部分だけを素早く読むための自 動的な機能があるだろう。
もし一つのマニュアルがいくつかのプログラムを記述するなら、それぞれのプロ グラムを記述する節を持つべきだ。
[1] 訳注: 自分でも何書いてるのか意味不明。訂正乞 う。原文: Alternatively, put a menu item in some menu whose item name fits one of the above patterns. This identifies the node which that item points to as the node for this purpose, regardless of the node's actual name.