kmx git

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.42.1.
.TH HELP2MAN "1" "2013年5月" "help2man 1.42.1" "ユーザーコマンド"
.SH 名前
help2man \- 簡易マニュアルページの生成
.SH 書式
.B help2man
[\fIOPTION\fR]... \fIEXECUTABLE\fR
.SH 説明
`help2man' は `\-\-help' および `\-\-version' の出力を元にマニュアルページを生成する。
.PP
引数 EXECUTABLE には、マニュアル作成の対象とするコマンドを指定する。
.TP
\fB\-n\fR, \fB\-\-name\fR=\fISTRING\fR
「名前」セクションで使うコマンドの短い説明
.TP
\fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR
マニュアルページが所属するセクションの番号 (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fITEXT\fR
マニュアルの種類 (ユーザコマンド, ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fITEXT\fR
プログラムの出自 (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fISTRING\fR
ロケールを選択する (デフォルトは "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fIFILE\fR
`FILE' から原稿を取り込む
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fIFILE\fR
`FILE' が存在した場合 `FILE' から原稿を取り込む
.TP
\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
`FILE' へ出力を送る
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fITEXT\fR
Texinfo マニュアルの名前
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
Texinfo マニュアルの紹介を省略する
.TP
\fB\-l\fR, \fB\-\-libtool\fR
プログラム名から `lt\-' を取り除く
.TP
\fB\-\-help\fR
簡単な使い方を表示し終了する
.TP
\fB\-\-version\fR
バージョン番号を表示し終了する
.PP
マニュアル作成の対象になるコマンドは、\-\-help や \fB\-\-version\fR というオプションを受け入れて、
標準出力にメッセージを表示するようになっているべきである。
もっとも、以下のオプションを使えば、\-\-help や \fB\-\-version\fR に相当する別のオプションを指定することが可能だ。
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fISTRING\fR
ヘルプ表示オプションの文字列
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fISTRING\fR
バージョン表示オプションの文字列
.TP
\fB\-\-version\-string\fR=\fISTRING\fR
バージョンとして表示する文字列
.TP
\fB\-\-no\-discard\-stderr\fR
オプションの出力を解析するときに標準エラー出力を含める
.SH インクルードファイル
.B \-\-include
や
.B \-\-opt\-include
オプションを使用すると、生成する出力に追加の原稿を取り込むことができる。ファイルの書式は単純である。

    [セクション]
    本文

    /パターン/
    本文

本文は *roff のテキストであり、出力中の、指定された
.BI [ セクション ]
(大文字・小文字は区別されない) の先頭部分や
.BI / パターン /\fR.
にマッチするパラグラフの直後に、そのままの形で挿入される。

パターンには Perl の正規表現の文法を使用する。修飾子の
.IR i
,
.I s
,
.I m
を後に付けることもできる (
.BR perlre (1) を参照)。

最初のセクションやパターンより前にある行で、'\-' で始まっている行は、
オプションとして処理される。それ以外は、何もせずに無視されるのでコメントや
RCS のキーワードなどに使用することができる。

セクションの出力順序:

    名前
    書式
    説明
    オプション
    環境変数
    ファイル
    例
    \fIその他\fR
    作者
    バグの報告
    著作権
    関連項目

インクルードファイルに
.B [名前]
や
.B [書式]
というセクションがあれば、そこに記述した内容が、自動的に生成される内容のかわりに出力される。
 (もっとも、どうしても必要ならば、前者については、
.B --name
オプションを使って、さらに置き換えることができるが。)

それ以外のセクションについては、上記の標準的なセクションのために
自動的に生成される出力の前に挿入されるか、あるいは、(上記の) 
.I その他
の位置に、インクルードファイル中で見つかった順番で取り込まれる。
.SH 入手先
この配布物の最新バージョンは次の場所から入手可能である。

    ftp://ftp.gnu.org/gnu/help2man/
.SH 作者
作者は Brendan O'Dea <bod@debian.org> である。
.SH バグの報告
バグを発見した場合は <bug\-help2man@gnu.org> に報告されたい。
.SH 著作権
Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
2011, 2012 Free Software Foundation, Inc.
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH 関連項目
.B help2man
の完全なマニュアルは Texinfo マニュアルとして整備されている。もし、
.B info
および
.B help2man
のプログラムが正しくインストールされているならば、コマンド
.IP
.B info help2man
.PP
を使用すると完全なマニュアルを読むことができるはずだ。
gnu/help2man/help2man.ja.1

Commit

help2man.ja.1
