| HELP2MAN(1) | ユーザーコマンド | HELP2MAN(1) |
名前¶
help2man - 簡易マニュアルページの生成
書式¶
help2man [OPTION]... EXECUTABLE
説明¶
`help2man' は `--help' および `--version' の出力を元にマニュアルページを生成する。
引数 EXECUTABLE には、マニュアル作成の対象とするコマンドを指定する。
- -n, --name=STRING
- 「名前」セクションで使うコマンドの短い説明
- -s, --section=SECTION
- マニュアルページが所属するセクションの番号 (1, 6, 8)
- -m, --manual=TEXT
- マニュアルの種類 (ユーザコマンド, ...)
- -S, --source=TEXT
- プログラムの出自 (FSF, Debian, ...)
- -L, --locale=STRING
- ロケールを選択する (デフォルトは "C")
- -i, --include=FILE
- `FILE' から原稿を取り込む
- -I, --opt-include=FILE
- `FILE' が存在した場合 `FILE' から原稿を取り込む
- -o, --output=FILE
- `FILE' へ出力を送る
- -p, --info-page=TEXT
- Texinfo マニュアルの名前
- -N, --no-info
- Texinfo マニュアルの紹介を省略する
- -l, --libtool
- プログラム名から `lt-' を取り除く
- --help
- 簡単な使い方を表示し終了する
- --version
- バージョン番号を表示し終了する
マニュアル作成の対象になるコマンドは、--help や --version というオプションを受け入れて、 標準出力にメッセージを表示するようになっているべきである。 もっとも、以下のオプションを使えば、--help や --version に相当する別のオプションを指定することが可能だ。
- -h, --help-option=STRING
- ヘルプ表示オプションの文字列
- -v, --version-option=STRING
- バージョン表示オプションの文字列
- --version-string=STRING
- バージョンとして表示する文字列
- --no-discard-stderr
- オプションの出力を解析するときに標準エラー出力を含める
インクルードファイル¶
--include や --opt-include オプションを使用すると、生成する出力に追加の原稿を取り込むことができる。ファイルの書式は単純である。
[セクション]
本文
/パターン/
本文
本文は *roff のテキストであり、出力中の、指定された [セクション] (大文字・小文字は区別されない) の先頭部分や /パターン/. にマッチするパラグラフの直後に、そのままの形で挿入される。
パターンには Perl の正規表現の文法を使用する。修飾子の i , s , m を後に付けることもできる ( perlre(1)を参照)。
最初のセクションやパターンより前にある行で、'-' で始まっている行は、 オプションとして処理される。それ以外は、何もせずに無視されるのでコメントや RCS のキーワードなどに使用することができる。
セクションの出力順序:
名前
書式
説明
オプション
環境変数
ファイル
例
その他
作者
バグの報告
著作権
関連項目
インクルードファイルに
[名前] や [書式]
というセクションがあれば、そこに記述した内容が、自動的に生成される内容のかわりに出力される。
(もっとも、どうしても必要ならば、前者については、
--name
オプションを使って、さらに置き換えることができるが。)
それ以外のセクションについては、上記の標準的なセクションのために 自動的に生成される出力の前に挿入されるか、あるいは、(上記の) その他 の位置に、インクルードファイル中で見つかった順番で取り込まれる。
入手先¶
この配布物の最新バージョンは次の場所から入手可能である。
作者¶
作者は Brendan O'Dea <bod@debian.org> である。
バグの報告¶
バグを発見した場合は <bug-help2man@gnu.org> に報告されたい。
著作権¶
Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
2005, 2009, 2010, 2011, 2012 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.
関連項目¶
help2man の完全なマニュアルは Texinfo マニュアルとして整備されている。もし、 info および help2man のプログラムが正しくインストールされているならば、コマンド
- info help2man
を使用すると完全なマニュアルを読むことができるはずだ。
| 2012年12月 | help2man 1.41.1 |