release/man7/man.7

   1 .\" (C) Copyright 1992-1999 Rickard E. Faith and David A. Wheeler
   2 .\" (faith@cs.unc.edu and dwheeler@ida.org)
   3 .\"
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\"
  24 .\" Modified Sun Jul 25 11:06:05 1993 by Rik Faith (faith@cs.unc.edu)
  25 .\" Modified Sat Jun  8 00:39:52 1996 by aeb
  26 .\" Modified Wed Jun 16 23:00:00 1999 by David A. Wheeler (dwheeler@ida.org)
  27 .\" Modified Thu Jul 15 12:43:28 1999 by aeb
  28 .\" Modified Sun Jan  6 18:26:25 2002 by Martin Schulze <joey@infodrom.org>
  29 .\" Modified Tue Jul 27 20:12:02 2004 by Colin Watson <cjwatson@debian.org>
  30 .\" 2007-05-30, mtk: various rewrites and moved much text to new man-pages.7.
  31 .\"
  32 .\"*******************************************************************
  33 .\"
  34 .\" This file was generated with po4a. Translate the source file.
  35 .\"
  36 .\"*******************************************************************
  37 .TH MAN 7 2011\-10\-05 Linux "Linux Programmer's Manual"
  38 .SH 名前
  39 man \- man ページを整形するマクロ
  40 .SH 書式
  41 \fBgroff \-Tascii \-man\fP \fIfile\fP \&...
  42 .LP
  43 \fBgroff \-Tps \-man\fP \fIfile\fP \&...
  44 .LP
  45 \fBman\fP [\fIsection\fP] \fItitle\fP
  46 .SH 説明
  47 このマニュアルページでは、 \fBgroff an.tmac\fP のマクロパッケージ (\fBman\fP マクロパッケージとも呼ばれることも多い)
  48 について説明する。 このマクロパッケージは、 Linux の man ページを書いたり移植したりするときに、 開発者が用いるものである。
  49 このマクロパッケージはバージョン間での互換性が高く、 man page の移植にあたっては大きな問題はないだろう (但し、NET\-2 BSD
  50 release は例外である。 こちらでは mdoc と呼ばれる全く異なるマクロパッケージが使用されている。 \fBmdoc\fP(7)  を参照)。
  51 .PP
  52 NET\-2 BSD の man ページも、 \fBgroff\fP のオプションとして \fB\-man\fP の代わりに \fB\-mdoc\fP
  53 を指定するだけで、利用することができる。 \fB\-mandoc\fP オプションを使えばどのマクロパッケージが用いられているか
  54 自動的に検出できるので、このオプションを使うのがお薦めである。
  55 .PP
  56 Linux \fIman\-pages\fP プロジェクトのマニュアルページを書く際に 従うべき決まり事については \fBman\-pages\fP(7)  を参照。
  57 .SS タイトル行
  58 man ページの (コメント行を除く) 最初のコマンドは、 以下のようにする必要がある。 コメント行とは \fB.\e"\fP で始まる行のことである。
  59 .RS
  60 .sp
  61 \fB\&.TH\fP \fItitle section date source manual\fP
  62 .sp
  63 .RE
  64 \fBTH\fP に渡す引き数の詳細については \fBman\-pages\fP(7)  を参照。
  65 .PP
  66 なお BSD の mdoc フォーマットのページは \fBTH\fP コマンドではなく \fBDd\fP コマンドから始まる。
  67 .SS セクション
  68 .\" The following doesn't seem to be required (see Debian bug 411303),
  69 .\" If the name contains spaces and appears
  70 .\" on the same line as
  71 .\" .BR \&.SH ,
  72 .\" then place the heading in double quotes.
  73 セクションは \fB\&.SH\fP で始まり、見出し名がそれに続く。
  74
  75 NAME (名前) という見出しだけは必ず置かないといけない。 この見出しは一番最初のセクションにすべきで、見出しの
  76 次の行にはプログラムの説明を一行で書く。
  77 .RS
  78 .sp
  79 \&.SH NAME
  80 .br
  81 item \e\- description
  82 .sp
  83 .RE
  84 このフォーマットに従い、コマンド名に続くシングルダッシュ (\-) の前には必ず
  85 バックスラッシュを置くこと。 この文法は、 \fBmabdb\fP(8) プログラムが
  86 \fBwhatis\fP(1) や \fBapropos\fP(1) コマンド用の短い説明のデータベースを
  87 生成する際に利用される。
  88 .PP
  89 マニュアルページに登場する可能性のあるこれ以外のセクションのリストに ついては \fBman\-pages\fP(7)  を参照。
  90 .SS フォント
  91 タイプフェイスを選択するコマンドは以下のように指定する:
  92 .TP  4
  93 \fB\&.B\fP
  94 ボールド。
  95 .TP
  96 \fB\&.BI\fP
  97 ボールドとイタリックとを交互に (特に関数指定に便利)。
  98 .TP
  99 \fB\&.BR\fP
 100 ボールドとローマンとを交互に (特に他のマニュアルページを参照するときに便利)。
 101 .TP
 102 \fB\&.I\fP
 103 イタリック。
 104 .TP
 105 \fB\&.IB\fP
 106 イタリックとボールドとを交互に。
 107 .TP
 108 \fB\&.IR\fP
 109 イタリックとローマンとを交互に。
 110 .TP
 111 \fB\&.RB\fP
 112 ローマンとボールドとを交互に。
 113 .TP
 114 \fB\&.RI\fP
 115 ローマンとイタリックとを交互に。
 116 .TP
 117 \fB\&.SB\fP
 118 スモールとボールドを交互に。
 119 .TP
 120 \fB\&.SM\fP
 121 スモール (頭字語などに用いる)
 122 .LP
 123 慣例としては、各コマンドは 6 つまでの引き数を持つ事が可能だが、 GNU の実装では制限はないようだ (しかし移植性を保持するためには 引き数は 6
 124 までに限っておくのが良いだろう)。 引き数はスペースで区切られる。 スペースを含んだ引き数を与えるには、ダブルクォートで囲えばよい。
 125 すべての引き数はスペースを取り除いて並べられるので、 \fB\&.BR\fP コマンドを使えば、単語はボールドで、句読点をローマンで表すことができる。
 126 引き数が全く与えられなければ、 そのコマンドは次の行のテキストに適用される。
 127 .SS その他のマクロや文字列
 128 .PP
 129 以下に、他のマクロや定義済みの文字列を示す。 特に記述がない限り、マクロを使うと改行が行われる (テキストの現在の行を終了する)。 多くのマクロは
 130 「優先インデント (prevailing indent)」を設定したり、使用する。 優先インデントの値は、どのマクロからもパラメータ \fIi\fP
 131 によって指定できる (以下に示す)。 マクロでは \fIi\fP を省略することもでき、その場合は現在の優先インデントの値が用いられる。
 132 これにより結果として、インデントされた段落が連続している場合、 インデントの値を再指定しなくてもインデント量を同じにすることができる。 通常の
 133 (インデントされていない) 段落が登場すると、 優先インデントの値はデフォルトの値 (0.5 インチ) にリセットされる。
 134 デフォルトでは、与えたインデントの値は ens 単位である。 インデントの単位には ens や ems を用いるとよい。これらの単位は
 135 フォントサイズが変更されると自動的に調整されるからである。 他の重要なマクロ定義は以下の通り:
 136 .SS 通常の段落
 137 .TP  9m
 138 \fB\&.LP\fP
 139 \fB\&.PP\fP と同じ (新たな段落の開始)。
 140 .TP
 141 \fB\&.P\fP
 142 \fB\&.PP\fP と同じ (新たな段落の開始)。
 143 .TP
 144 \fB\&.PP\fP
 145 新しい段落を開始し、インデントをリセットする。
 146 .SS 相対マージンインデント
 147 .TP  9m
 148 \fB\&.RS\fP\fI i\fP
 149 相対マージンインデント (relative margin indent) を開始する。 左マージンを \fIi\fP だけ右に移動する (\fIi\fP
 150 が省略されると優先インデントの値が用いられる)。 新たな優先インデントは 0.5 インチにセットされる。 結果として、以下の段落は対応する
 151 \fB\&.RE\fP が現れるまでインデントされる。
 152 .TP
 153 \fB\&.RE\fP
 154 相対マージンインデントを終了し、 優先インデントの値を元に戻す。
 155 .SS 段落をインデントするマクロ
 156 .TP  9m
 157 \fB\&.HP\fP\fI i\fP
 158 ぶらさがりインデントの段落を開始する (段落の先頭行は通常の段落の左マージンとなり、 段落の残りの行はインデントされる)。
 159 .TP
 160 \fB\&.IP\fP\fI x i\fP
 161 インデントされた段落。オプションとしてぶらさがりタグをとる。 タグ \fIx\fP が省略されると、以下の段落すべてが \fIi\fP でインデントされる。タグ
 162 \fIx\fP が与えられると、タグはインデントされた段落の前にぶら下げられる (\fB\&.TP\fP
 163 とちょうど同じ。ただしタグを次の行に書く代わりにコマンドに指定する)。 タグが長すぎる場合には、タグに続くテキストは次の行に移動する
 164 (テキストが失われたり混ざったりすることはない)。 箇条書きをするには、 \e(bu (点) あるいは \e(em (ダッシュ)
 165 をタグにしてこのマクロを用いるとよい。番号付きで箇条書きをする場合は、 数字または文字にピリオドを付けたものをタグにすればよい。
 166 こうすれば他のフォーマットへの変換が簡単になる。
 167 .TP
 168 \fB\&.TP\fP\fI i\fP
 169 ぶらさがりタグの段落を開始する。タグは次の行に指定する。 結果は \fB\&.IP\fP コマンドと似たものになる。
 170 .SS ハイパーテキストリンク用のマクロ
 171 (\fBgroff\fP だけでサポートされている機能)  ハイパーテキストリンク用のマクロを使用するためには、 \fBwww.tmac\fP
 172 マクロパッケージをロードする必要がある。 ロードを行うには \fB.mso www.tmac\fP リクエストを使用する。
 173 .TP  9m
 174 \fB\&.URL\fP\fI link url trailer\fP
 175 .\" The following is a kludge to get a paragraph into the listing.
 176 URI (URL)  \fIurl\fP へのハイパーテキストリンクを挿入する。 \fIlink\fP はリンク名のテキストであり、 \fItrailer\fP
 177 の内容はリンクの直後に表示される。 HTML を生成する時に、このマクロは \fB<A
 178 HREF="\fP\fIurl\fP\fB">\fP\fIlink\fP\fB</A>\fP\fItrailer\fP という HTML コマンドに変換される。
 179 .TP
 180 \fB\& \&\fR
 181 .\" The following is a kludge to get a paragraph into the listing.
 182 このマクロや他の関連マクロは新しく、 多くのツールはこれらに対しては何もしないであろう。 (troff を含めた)
 183 多くのツールは未定義のマクロを単に無視するだけ (あるいは最悪でもマクロをテキストとして挿入するだけ)  なので、これらを書いても危険はない。
 184 .TP
 185 \fB\& \&\fR
 186 .\" The following is a kludge to get a paragraph into the listing.
 187 マニュアルページ内で自分で \fBURL\fP マクロを定義して、 \fBgroff\fP 以外の roff ビューアでも表示されるようにするのもいいだろう。
 188 こうすることで、URL も、リンク用のテキストも、(もしあれば) それに続く テキストも、表示できるようになる。
 189 .TP
 190 \fB\& \&\fR
 191 以下に例を挙げる:
 192 .RS 1.5i
 193 \&.de URL
 194 .br
 195 \e\e$2 \e(laURL: \e\e$1 \e(ra\e\e$3
 196 .br
 197 \&..
 198 .br
 199 \&.if \en[.g] .mso www.tmac
 200 .br
 201 \&.TH \fI...\fP
 202 .br
 203 \fI(later in the page)\fP
 204 .br
 205 This software comes from the
 206 .br
 207 \&.URL "http://www.gnu.org/" "GNU Project" " of the"
 208 .br
 209 \&.URL "http://www.fsf.org/" "Free Software Foundation" .
 210 .RE
 211 .\" The following is a kludge to get a paragraph into the listing.
 212 .TP
 213 \fB\& \&\fR
 214 上記の例において、 \fBgroff\fP を使って表示しようとした場合には、 \fBwww.tmac\fP マクロパッケージの URL マクロの定義の方が
 215 ローカルで行われた定義よりも優先される。
 216 .PP
 217 他にもいくつかのリンク用のマクロが用意されている。詳しくは \fBgroff_www\fP(7) を参照のこと。
 218 .SS その他のマクロ
 219 .TP  9m
 220 \fB\&.DT\fP
 221 タブをデフォルトのタブ値 (0.5 インチごと) にリセットする。 改行はしない。
 222 .TP
 223 \fB\&.PD\fP\fI d\fP
 224 パラグラフ間の間隔を引き数にセットする (省略されると d=0.4v となる)。
 225 .TP
 226 \fB\&.SS\fP\fI t\fP
 227 サブヘッダ \fIt\fP (\fB\&.SH\fP のようなものだが、サブセクションのために用いる)。
 228 .SS 定義済みの文字列
 229 \fBman\fP パッケージには、以下のような定義済みの文字列がある:
 230 .IP \e*R
 231 登録シンボル: \*R
 232 .IP \e*S
 233 デフォルトフォントサイズを変更する
 234 .IP \e*(Tm
 235 商標シンボル: \*(Tm
 236 .IP \e*(lq
 237 左に傾いたダブルクォート: \*(lq
 238 .IP \e*(rq
 239 右に傾いたダブルクォート: \*(rq
 240 .SS 安全なサブセット
 241 技術的には \fBman\fP は troff のマクロパッケージだが、実際には多数の別のツールが man ページのファイルを処理しており、それらは
 242 troff の全ての機能を 実装していないこともある。したがって、他のツールでも正しく処理できるように、 troff
 243 のあまり一般的でない機能は、可能ならば用いないのが望ましい。 様々な troff プリプロセッサ も用いないほうが良いだろう (やむを得ない場合は
 244 \fBtbl\fP(1)  は用いても良い。しかし 2 列の表なら、代わりに \fBIP\fP や \fBTP\fP コマンドを用いてみよう)。
 245 計算機能も用いない方が良いだろう。他のツールのほとんどはこれらを処理できない。 他のフォーマットに変換が容易な、単純なコマンドを使うようにしよう。
 246 以下の troff コマンドは、使っても問題ないと考えてよいだろう (多くの場合、変換コマンドによって無視されるかもしれないが)。 \fB\e"\fP,
 247 \&\fB.\fP, \fBad\fP, \fBbp\fP, \fBbr\fP, \fBce\fP, \fBde\fP, \fBds\fP, \fBel\fP, \fBie\fP, \fBif\fP, \fBfi\fP,
 248 \fBft\fP, \fBhy\fP, \fBig\fP, \fBin\fP, \fBna\fP, \fBne\fP, \fBnf\fP, \fBnh\fP, \fBps\fP, \fBso\fP, \fBsp\fP,
 249 \fBti\fP, \fBtr\fP
 250 .PP
 251 troff のエスケープシーケンスの多くも利用できる (これらのエスケープシーケンスは \e で始まる)。
 252 バックスラッシュ文字を通常のテキストとして使いたい場合は \ee とする。 利用できる他のシーケンスには以下のようなものがある (x や xx
 253 は任意の文字, N は任意の数字): \fB\e'\fP, \fB\e`\fP, \fB\e\-\fP, \fB\e.\fP, \fB\e"\fP, \fB\e%\fP, \fB\e*x\fP,
 254 \fB\e*(xx\fP, \fB\e(xx\fP, \fB\e$N\fP, \fB\enx\fP, \fB\en(xx\fP, \fB\efx\fP, \fB\ef(xx\fP.
 255 グラフィックの描画にはエスケープシーケンスは用いないほうが良い。
 256 .PP
 257 \fBbp\fP (改頁) にはオプションパラメータを用いないこと。 \fBsp\fP (垂直スペース) には正の値のみを用いること。 man や mdoc
 258 マクロパッケージにあるマクロと、 名前が同じで機能の異なるマクロを定義 (\fBde\fP)  しないこと。そのような再定義は無視される可能性が高い。
 259 正方向へのインデント (\fBin\fP)  には、負のインデントを対応させること (このマクロの代わりに \fBRS\fP と \fBRE\fP
 260 マクロを使った方がよいのだが)。 条件テスト (\fBif\fP,\fBie\fP)  は状態として \(aqt\(aq または \(aqn\(aq
 261 だけを持つようにすること。 変換 (\fBtr\fP)  には無視できるものだけを使うこと。 フォントの変更 (\fBft\fP と \fB\ef\fP
 262 エスケープシーケンス) には 1, 2, 3, 4, R, I, B, P, CW のみを用いること (ft
 263 コマンドの場合はパラメータを指定しなくてもよい)。
 264 .PP
 265 この制限を越えて機能を用いる場合は、いくつかのツールを使って、 その結果を注意してチェックすること。追加した機能が安全だと
 266 確信したら、この文書の管理者にその安全なコマンドまたはシーケンスを 教えてほしい。リストに追加する。
 267 .SH ファイル
 268 \fI/usr/share/groff/\fP[*/]\fItmac/an.tmac\fP
 269 .br
 270 \fI/usr/man/whatis\fP
 271 .SH 注意
 272 .PP
 273 テキストにはぜひとも完全な URL (または URI) を書くようにすること。 \fBman2html\fP(1)
 274 のようなツールは、これらを自動的にハイパーテキストリンクに変換する。 新たに取り入れられた \fBURL\fP マクロを関連情報へのリンクに用いても良い。
 275 URL を書く場合は、 例えば <http://www.kernelnotes.org> のように完全な形式で書き、 ツールによる
 276 URL 自動検知ができるようにすること。
 277 .PP
 278 これらのファイルを処理するツールは、ファイルをオープンして 最初の空白以外の文字を調べる。行の先頭にピリオド (.)  またはシングルクォート (')
 279 があると、これは troff ベースの ファイル (man や mdoc) であるとみなす。左角括弧 (<) は SGML/XML
 280 ベースのファイル (HTML や Docbook) であるとみなす。 それ以外は単純な ASCII テキスト ("catman" の結果など)
 281 とみなす。
 282 .PP
 283 多くの man ページは、最初の行が \fB\'\e"\fP とスペースで始まっており、
 284 そこにはそのページが処理されるべきプリプロセスを表す文字が書いてある。 troff 以外の変換プログラムへの移植性のため、 \fBtbl\fP(1)  や、
 285 Linux が自動的に検知できるもの以外は使わないようにすることを勧める。 しかし、この情報を記述して、書いたページが他の (より低機能な)
 286 システムでも 扱えるようにしたい場合もあるかも知れない。 以下にこれらの文字によって起動されるプリプロセッサの定義を示す:
 287 .TP  3
 288 \fBe\fP
 289 eqn(1)
 290 .TP
 291 \fBg\fP
 292 grap(1)
 293 .TP
 294 \fBp\fP
 295 pic(1)
 296 .TP
 297 \fBr\fP
 298 refer(1)
 299 .TP
 300 \fBt\fP
 301 tbl(1)
 302 .TP
 303 \fBv\fP
 304 vgrind(1)
 305 .SH バグ
 306 .PP
 307 mdoc や DocBook に比べると、 マクロの多くは書式 (フォントタイプやスペーシングなど) に関するものであり、 意味上のもの
 308 (このテキストは他のページへの参照である、など) ではない (HTML ですら意味的なマーキングに思える)。 このため、 \fBman\fP
 309 フォーマットを他のメディアへ変換したり、 フォーマットを他のメディアで有効なものにしたり、 相互参照を自動的に挿入したりすることが困難になっている。
 310 上に挙げたような安全なサブセットを守れば、 将来別のリファレンスページフォーマットへ変換する作業が簡単になるだろう。
 311 .LP
 312 .\" .SH AUTHORS
 313 .\" .IP \(em 3m
 314 .\" James Clark (jjc@jclark.com) wrote the implementation of the macro package.
 315 .\" .IP \(em
 316 .\" Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
 317 .\" this manual page.
 318 .\" .IP \(em
 319 .\" Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
 320 .\" (which influenced this manual page).
 321 .\" .IP \(em
 322 .\" David A. Wheeler (dwheeler@ida.org) heavily modified this
 323 .\" manual page, such as adding detailed information on sections and macros.
 324 Sun のマクロである \fBTX\fP は定義されていない。
 325 .SH 関連項目
 326 \fBapropos\fP(1), \fBgroff\fP(1), \fBlexgrog\fP(1), \fBman\fP(1), \fBman2html\fP(1),
 327 \fBwhatis\fP(1), \fBgroff_man\fP(7), \fBgroff_www\fP(7), \fBman\-pages\fP(7), \fBmdoc\fP(7),
 328 \fBmdoc.samples\fP(7)