1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3.
2 .TH HELP2MAN "1" "2021年3月" "GNU help2man 1.48.3" "ユーザーコマンド"
4 help2man \- 簡易マニュアルページの生成
7 [\fI\,OPTION\/\fR]... \fI\,EXECUTABLE\/\fR
9 `help2man' は `\-\-help' および `\-\-version' の出力を元にマニュアルページを生成する。
11 引数 EXECUTABLE には、マニュアル作成の対象とするコマンドを指定する。
13 \fB\-n\fR, \fB\-\-name\fR=\fI\,STRING\/\fR
16 \fB\-s\fR, \fB\-\-section\fR=\fI\,SECTION\/\fR
17 マニュアルページが所属するセクションの番号 (1, 6, 8)
19 \fB\-m\fR, \fB\-\-manual\fR=\fI\,TEXT\/\fR
20 マニュアルの種類 (ユーザコマンド, ...)
22 \fB\-S\fR, \fB\-\-source\fR=\fI\,TEXT\/\fR
23 プログラムの出自 (FSF, Debian, ...)
25 \fB\-L\fR, \fB\-\-locale\fR=\fI\,STRING\/\fR
26 ロケールを選択する (デフォルトは "C")
28 \fB\-i\fR, \fB\-\-include\fR=\fI\,FILE\/\fR
31 \fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,FILE\/\fR
32 `FILE' が存在した場合 `FILE' から原稿を取り込む
34 \fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
37 \fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEXT\/\fR
40 \fB\-N\fR, \fB\-\-no\-info\fR
43 \fB\-l\fR, \fB\-\-libtool\fR
52 マニュアル作成の対象になるコマンドは、\-\-help や \fB\-\-version\fR というオプションを受け入れて、
53 標準出力にメッセージを表示するようになっているべきである。
54 もっとも、以下のオプションを使えば、\-\-help や \fB\-\-version\fR に相当する別のオプションを指定することが可能だ。
56 \fB\-h\fR, \fB\-\-help\-option\fR=\fI\,STRING\/\fR
59 \fB\-v\fR, \fB\-\-version\-option\fR=\fI\,STRING\/\fR
62 \fB\-\-version\-string\fR=\fI\,STRING\/\fR
65 \fB\-\-no\-discard\-stderr\fR
66 オプションの出力を解析するときに標準エラー出力を含める
71 オプションを使用すると、生成する出力に追加の原稿を取り込むことができる。ファイルの書式は単純である。
79 本文は *roff のテキストであり、出力中の、指定された
81 (大文字・小文字は区別されない) の先頭部分や
83 にマッチするパラグラフの直後に、そのままの形で挿入される。
85 パターンには Perl の正規表現の文法を使用する。修飾子の
94 最初のセクションやパターンより前にある行で、'\-' で始まっている行は、
95 オプションとして処理される。それ以外は、何もせずに無視されるのでコメントや
96 RCS のキーワードなどに使用することができる。
117 というセクションがあれば、そこに記述した内容が、自動的に生成される内容のかわりに出力される。
118 (もっとも、どうしても必要ならば、前者については、
120 オプションを使って、さらに置き換えることができるが。)
122 それ以外のセクションについては、上記の標準的なセクションのために
123 自動的に生成される出力の前に挿入されるか、あるいは、(上記の)
125 の位置に、インクルードファイル中で見つかった順番で取り込まれる。
132 という文法を使うことでセクション内での追加の原稿の配置を明示的に要求することができる。
133 それぞれ追加の原稿を元の文章の前、元の文章の代わりに、
136 この配布物の最新バージョンは次の場所から入手可能である。
138 ftp://ftp.gnu.org/gnu/help2man/
140 作者は Brendan O'Dea <bod@debian.org> である。
142 バグを発見した場合は <bug\-help2man@gnu.org> に報告されたい。
144 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
145 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021 Free Software Foundation, Inc.
147 This is free software; see the source for copying conditions. There is NO
148 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
151 の完全なマニュアルは Texinfo マニュアルとして整備されている。もし、
155 のプログラムが正しくインストールされているならば、コマンド
159 を使用すると完全なマニュアルを読むことができるはずだ。