help2man.ja.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
   2 .TH HELP2MAN "1" "2018年10月" "help2man 1.47.8" "ユーザーコマンド"
   3 .SH 名前
   4 help2man \- 簡易マニュアルページの生成
   5 .SH 書式
   6 .B help2man
   7 [\fI\,OPTION\/\fR]... \fI\,EXECUTABLE\/\fR
   8 .SH 説明
   9 `help2man' は `\-\-help' および `\-\-version' の出力を元にマニュアルページを生成する。
  10 .PP
  11 引数 EXECUTABLE には、マニュアル作成の対象とするコマンドを指定する。
  12 .TP
  13 \fB\-n\fR, \fB\-\-name\fR=\fI\,STRING\/\fR
  14 「名前」セクションで使うコマンドの短い説明
  15 .TP
  16 \fB\-s\fR, \fB\-\-section\fR=\fI\,SECTION\/\fR
  17 マニュアルページが所属するセクションの番号 (1, 6, 8)
  18 .TP
  19 \fB\-m\fR, \fB\-\-manual\fR=\fI\,TEXT\/\fR
  20 マニュアルの種類 (ユーザコマンド, ...)
  21 .TP
  22 \fB\-S\fR, \fB\-\-source\fR=\fI\,TEXT\/\fR
  23 プログラムの出自 (FSF, Debian, ...)
  24 .TP
  25 \fB\-L\fR, \fB\-\-locale\fR=\fI\,STRING\/\fR
  26 ロケールを選択する (デフォルトは "C")
  27 .TP
  28 \fB\-i\fR, \fB\-\-include\fR=\fI\,FILE\/\fR
  29 `FILE' から原稿を取り込む
  30 .TP
  31 \fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,FILE\/\fR
  32 `FILE' が存在した場合 `FILE' から原稿を取り込む
  33 .TP
  34 \fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
  35 `FILE' へ出力を送る
  36 .TP
  37 \fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEXT\/\fR
  38 Texinfo マニュアルの名前
  39 .TP
  40 \fB\-N\fR, \fB\-\-no\-info\fR
  41 Texinfo マニュアルの紹介を省略する
  42 .TP
  43 \fB\-l\fR, \fB\-\-libtool\fR
  44 プログラム名から `lt\-' を取り除く
  45 .TP
  46 \fB\-\-help\fR
  47 簡単な使い方を表示し終了する
  48 .TP
  49 \fB\-\-version\fR
  50 バージョン番号を表示し終了する
  51 .PP
  52 マニュアル作成の対象になるコマンドは、\-\-help や \fB\-\-version\fR というオプションを受け入れて、
  53 標準出力にメッセージを表示するようになっているべきである。
  54 もっとも、以下のオプションを使えば、\-\-help や \fB\-\-version\fR に相当する別のオプションを指定することが可能だ。
  55 .TP
  56 \fB\-h\fR, \fB\-\-help\-option\fR=\fI\,STRING\/\fR
  57 ヘルプ表示オプションの文字列
  58 .TP
  59 \fB\-v\fR, \fB\-\-version\-option\fR=\fI\,STRING\/\fR
  60 バージョン表示オプションの文字列
  61 .TP
  62 \fB\-\-version\-string\fR=\fI\,STRING\/\fR
  63 バージョンとして表示する文字列
  64 .TP
  65 \fB\-\-no\-discard\-stderr\fR
  66 オプションの出力を解析するときに標準エラー出力を含める
  67 .SH インクルードファイル
  68 .B \-\-include
  69 や
  70 .B \-\-opt\-include
  71 オプションを使用すると、生成する出力に追加の原稿を取り込むことができる。ファイルの書式は単純である。
  72
  73     [セクション]
  74     本文
  75
  76     /パターン/
  77     本文
  78
  79 本文は *roff のテキストであり、出力中の、指定された
  80 .BI [ セクション ]
  81 (大文字・小文字は区別されない) の先頭部分や
  82 .BI / パターン /\fR.
  83 にマッチするパラグラフの直後に、そのままの形で挿入される。
  84
  85 パターンには Perl の正規表現の文法を使用する。修飾子の
  86 .IR i
  87 ,
  88 .I s
  89 ,
  90 .I m
  91 を後に付けることもできる (
  92 .BR perlre (1) を参照)。
  93
  94 最初のセクションやパターンより前にある行で、'\-' で始まっている行は、
  95 オプションとして処理される。それ以外は、何もせずに無視されるのでコメントや
  96 RCS のキーワードなどに使用することができる。
  97
  98 セクションの出力順序:
  99
 100     名前
 101     書式
 102     説明
 103     オプション
 104     環境変数
 105     ファイル
 106     例
 107     \fIその他\fR
 108     作者
 109     バグの報告
 110     著作権
 111     関連項目
 112
 113 インクルードファイルに
 114 .B [名前]
 115 や
 116 .B [書式]
 117 というセクションがあれば、そこに記述した内容が、自動的に生成される内容のかわりに出力される。
 118  (もっとも、どうしても必要ならば、前者については、
 119 .B \-\-name
 120 オプションを使って、さらに置き換えることができるが。)
 121
 122 それ以外のセクションについては、上記の標準的なセクションのために
 123 自動的に生成される出力の前に挿入されるか、あるいは、(上記の)
 124 .I その他
 125 の位置に、インクルードファイル中で見つかった順番で取り込まれる。
 126
 127 デフォルトの出力の代わりに、
 128 .RI [< section ]、
 129 .RI [= section ]
 130 あるいは
 131 .RI [> section ]
 132 という文法を使うことでセクション内での追加の原稿の配置を明示的に要求することができる。
 133 それぞれ追加の原稿を元の文章の前、元の文章の代わりに、
 134 あるいは元の文章の後に配置する。
 135 .SH 入手先
 136 この配布物の最新バージョンは次の場所から入手可能である。
 137
 138     ftp://ftp.gnu.org/gnu/help2man/
 139 .SH 作者
 140 作者は Brendan O'Dea <bod@debian.org> である。
 141 .SH バグの報告
 142 バグを発見した場合は <bug\-help2man@gnu.org> に報告されたい。
 143 .SH 著作権
 144 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
 145 2011, 2012, 2013, 2014, 2015, 2016, 2017 Free Software Foundation, Inc.
 146 .br
 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.
 149 .SH 関連項目
 150 .B help2man
 151 の完全なマニュアルは Texinfo マニュアルとして整備されている。もし、
 152 .B info
 153 および
 154 .B help2man
 155 のプログラムが正しくインストールされているならば、コマンド
 156 .IP
 157 .B info help2man
 158 .PP
 159 を使用すると完全なマニュアルを読むことができるはずだ。