release/man7/man-pages.7

   1 .\" (C) Copyright 1992-1999 Rickard E. Faith and David A. Wheeler
   2 .\" (faith@cs.unc.edu and dwheeler@ida.org)
   3 .\" and (C) Copyright 2007 Michael Kerrisk <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" 2007-05-30 created by mtk, using text from old man.7 plus
  26 .\" rewrites and additional text.
  27 .\"
  28 .\"*******************************************************************
  29 .\"
  30 .\" This file was generated with po4a. Translate the source file.
  31 .\"
  32 .\"*******************************************************************
  33 .TH MAN\-PAGES 7 2008\-10\-28 Linux "Linux Programmer's Manual"
  34 .SH 名前
  35 man\-pages \- Linux の man ページを書く際の決まり事
  36 .SH 書式
  37 \fBman\fP [\fIsection\fP] \fItitle\fP
  38 .SH 説明
  39 このページでは、 Linux \fIman\-pages\fP プロジェクトのマニュアルページを書く際に 従うべき決まり事について説明する。 Linux
  40 \fIman\-pages\fP は Linux のマニュアルページの セクション 2, 3, 4, 5, 7 から構成されている。
  41 このページで説明されている決まり事は、他のプロジェクトの マニュアルページを書く作者にも役立つことだろう。
  42 .SS マニュアルページのセクション
  43 .PP
  44 マニュアルのセクションは、習慣的に以下のような定義が用いられている:
  45 .TP  10
  46 \fB1 コマンド (プログラム)\fP
  47 シェルの中からユーザが実行できるコマンド。
  48 .TP
  49 \fB2 システムコール\fP
  50 カーネルが処理しなければならない関数。
  51 .TP
  52 \fB3 ライブラリコール\fP
  53 \fIlibc\fP の関数の大部分。
  54 .TP
  55 \fB4 スペシャルファイル (デバイス)\fP
  56 \fI/dev\fP 以下にあるファイル。
  57 .TP
  58 \fB5 ファイルのフォーマットと規約\fP
  59 \fI/etc/passwd\fP などの人が読めるファイルのフォーマット。
  60 .TP
  61 \fB6 ゲーム\fP
  62 .TP
  63 \fB7 約束事その他\fP
  64 様々な事柄の概要、慣習、プロトコル、文字集合の規格、その他雑多なこと。
  65 .TP
  66 \fB8 システム管理コマンド\fP
  67 .\" .TP
  68 .\" .B 9 Kernel routines
  69 .\" This is an obsolete manual section.
  70 .\" Once it was thought a good idea to document the Linux kernel here,
  71 .\" but in fact very little has been documented, and the documentation
  72 .\" that exists is outdated already.
  73 .\" There are better sources of
  74 .\" information for kernel developers.
  75 \fBmount\fP(8)  のような root のみが実行可能なコマンド。
  76 .SS マクロパッケージ
  77 新しいマニュアルページは \fBman\fP(7)  で説明されている \fBgroff an.tmac\fP パッケージを使って記述すべきである。
  78 この方針は一貫性の確保が主な理由である。既存の Linux のマニュアルページ の圧倒的多数がこれらのマクロを使って記述されている。
  79 .SS ソースファイルの配置に関する決まり事
  80 マニュアルページのソースコードの 1行の長さは 可能な限り 75文字を越えないようにしてほしい。 こうすることで、パッチをメール本文に載せて送る場合に、
  81 メールクライアントによる行折り返しを回避することができる。
  82
  83 新しい文は行頭から開始する。 これにより、パッチの内容を確認しやすくなる。 パッチは文単位であることが多いからである。
  84 .SS タイトル行
  85 man ページの最初の行は \fBTH\fP コマンドにすべきである。
  86 .RS
  87 .sp
  88 \fB\&.TH\fP \fItitle section date source manual\fP
  89 .sp
  90 .RE
  91 個々の説明:
  92 .RS
  93 .TP  10
  94 \fItitle\fP
  95 man ページのタイトル。全部大文字で記載する (例: \fIMAN\-PAGES\fP)。
  96 .TP
  97 \fIsection\fP
  98 man ページが属するセクション番号 (例: \fI7\fP)。
  99 .TP
 100 \fIdate\fP
 101 最新のリビジョンの日付\(emman ページに変更を加えたときには 必ずこれを変更すること。 これが最も一般的なバージョン管理方法である。 日付は
 102 YYYY\-MM\-DD の形式で記載すべきである。
 103 .TP
 104 \fIsource\fP
 105 コマンド、関数、システムコールの出自。
 106
 107 数少ないセクション 1 と 8 のページの場合、おそらく単に \fIGNU\fP とだけ書くことが多いだろう。
 108
 109 システムコールの場合、単に \fILinux\fP とだけ書く。 (以前の慣習では、マニュアルページを記載した/内容を確認したカーネルの
 110 バージョン番号を記載していた。しかし、バージョン番号が実際の内容と 一致していることはなく、そのためバージョン番号がないよりも
 111 おそらく悪い形になっていた。 今後は、バージョン番号を含めるのは避けること。)
 112
 113 glibc のライブラリコールや その他の一般的な GNU ライブラリのライブラリコールの場合、 単に \fIGNU C Library\fP, \fIGNU\fP
 114 と書くか、空の文字列を使う。
 115
 116 セクション 4 のページでは \fILinux\fP を使う。
 117
 118 よくわからない場合は、 \fILinux\fP とか \fIGNU\fP と書いておく。
 119 .TP
 120 \fImanual\fP
 121 マニュアルのタイトル (例: \fIman\-pages\fP パッケージのセクション 2 および 3 のページの場合には、 \fILinux
 122 Programmer's Manual\fP を使うこと)。
 123 .RE
 124 .SS マニュアルページのセクション
 125 昔から使われてきたセクション名を以下のリストに示す。 これらを使うと良いだろう。 一般的に、マニュアルページは、少なくとも \fB色つき\fP
 126 のセクションを持つのが望ましい。 新しくマニュアルページを作成する際には、だいたい以下のリストに示した 順序でセクションを配置するようにしてもらいたい。
 127 .in +0.5i
 128 .nf
 129
 130 .\" May 07: Few current man pages have an ERROR HANDLING section,,,
 131 .\" ERROR HANDLING,
 132 .\" May 07: Almost no current man pages have a USAGE section,,,
 133 .\" USAGE,
 134 .\" DIAGNOSTICS,
 135 .\" May 07: Almost no current man pages have a SECURITY section,,,
 136 .\" SECURITY,
 137 .\" AUTHORS sections are discouraged
 138 .\" AUTHORS             [Discouraged]
 139 \fB名前\fP
 140 \fB書式\fP
 141 設定               [通常はセクション 4 のみ]
 142 \fB説明\fP
 143 オプション         [通常はセクション 1, 8 のみ]
 144 終了ステータス     [通常はセクション 1, 8 のみ]
 145 返り値             [通常はセクション 2, 3 のみ]
 146 エラー             [たいていはセクション 2, 3 のみ]
 147 環境変数
 148 ファイル
 149 バージョン         [通常はセクション 2, 3 のみ]
 150 準拠
 151 注意/備考
 152 バグ
 153 例
 154 \fB関連項目\fP
 155
 156 .fi
 157 .in
 158 「伝統的に使われてきた見出しが使える場合には、それを使ってほしい。」 この種の一貫性を保つことで、情報を理解しやすくなるからである。
 159 どうしても必要な場合には、理解しやすくなるように独自の見出しを 作ってもよい (特にセクション 4 や 5 のページではこうした方が
 160 わかりやすくなる)。ただし、そうする前に、伝統的な見出しを使い、 そのセクション内にサブセクション (\fI.SS\fP) を設けることで
 161 対応できないか考えてほしい。
 162
 163 以下のリストでは、上記のセクションのそれぞれの内容について 詳しく説明する。
 164 .TP  14
 165 \fB名前 (NAME)\fP
 166 そのマニュアルページの名前。 \fB.SH NAME\fP コマンドの行が従うべき大事な点については \fBman\fP(7)  を参照してほしい。
 167 .TP
 168 \fB書式 (SYNOPSIS)\fP
 169 コマンドや関数のインターフェースを簡潔に記述する。 コマンドに対しては、コマンドや引き数 (オプション) の文法を書く。
 170 そのまま書くテキストにはボールド体を用い、置き換える引き数には イタリック体を用いる。省略可能なオプションはブラケット ([]) で囲い、 選択肢は縦棒
 171 (|) で区切り、繰り返しには省略符号 (...) を書く。 関数に対しては、必要なデータ宣言や \fB#include\fP 指定を書き、関数宣言を続ける。
 172
 173 .\" FIXME . Say something here about compiler options
 174 ヘッダファイルから関数 (や変数) の定義を得るために 機能検査マクロ (feature test macro) を定義しなければならない場合、 書式
 175 (SYNOPSIS) に必要な機能検査マクロを記載すべきである。 機能検査マクロについては \fBfeature_test_macros\fP(7)
 176 で説明されている。
 177 .TP
 178 \fBCONFIGURATION\fP
 179 デバイスの設定詳細。 通常、このセクションは 4 章のマニュアルページでのみ登場する。
 180 .TP
 181 \fB説明 (DESCRIPTION)\fP
 182 .\" If there is some kind of input grammar or complex set of subcommands,
 183 .\" consider describing them in a separate
 184 .\" .B USAGE
 185 .\" section (and just place an overview in the
 186 .\" .B DESCRIPTION
 187 .\" section).
 188 プログラム・関数・フォーマットの動作・目的を説明する。 ファイルや標準入力をどのように処理し、標準出力や標準エラー出力を
 189 どのように生成するかといったことについて述べる。 内部動作や実装の詳細については省略する (ただしそれが動作の理解にどうしても必要なら別)。
 190 通常の場合について記述する。 プログラムのコマンドライン・オプションの説明には、 \fBオプション\fP のセクションを用いる。
 191 .TP
 192 \fBオプション (OPTIONS)\fP
 193 .\" .TP
 194 .\" .B USAGE
 195 .\" describes the grammar of any sublanguage this implements.
 196 プログラムが受け付けるコマンドライン・オプションと、 その場合プログラムの振舞いがどう変わるかを説明する。 このセクションはセクション 1 と 8
 197 のマニュアルページにだけ登場すべきである。
 198 .TP
 199 \fB終了ステータス (EXIT STATUS)\fP
 200 プログラムの終了ステータスの値と、それらの値に対応する状況を列挙する。 このセクションはセクション 1 と 8
 201 のマニュアルページにだけ登場すべきである。
 202 .TP
 203 \fB返り値 (RETURN VALUE)\fP
 204 セクション 2 と 3 のページの場合、このセクションに ライブラリルーチンが呼び出し元に返す値のリストを記載する。
 205 それらの値が返された場合の状態に対する説明も書く。
 206 .TP
 207 \fBエラー (ERRORS)\fP
 208 セクション 2 と 3 のマニュアルページでは、 エラーが発生した場合に \fIerrno\fP に設定される可能性がある値のリストを記載する。
 209 リストには、エラーの値とエラーの原因についての情報を書く。 「エラーリストはアルファベット順にすべきである。」
 210 .TP
 211 \fB環境変数 (ENVIRONMENT)\fP
 212 プログラムや関数に影響する環境変数をリストし、それらの効果を書く。
 213 .TP
 214 \fBファイル (FILES)\fP
 215 .\" May 07: Almost no current man pages have a DIAGNOSTICS section;
 216 .\"         "RETURN VALUE" or "EXIT STATUS" is preferred.
 217 .\" .TP
 218 .\" .B DIAGNOSTICS
 219 .\" gives an overview of the most common error messages and how to
 220 .\" cope with them.
 221 .\" You don't need to explain system error messages
 222 .\" or fatal signals that can appear during execution of any program
 223 .\" unless they're special in some way to the program.
 224 .\"
 225 .\" May 07: Almost no current man pages have a SECURITY section.
 226 .\".TP
 227 .\".B SECURITY
 228 .\"discusses security issues and implications.
 229 .\"Warn about configurations or environments that should be avoided,
 230 .\"commands that may have security implications, and so on, especially
 231 .\"if they aren't obvious.
 232 .\"Discussing security in a separate section isn't necessary;
 233 .\"if it's easier to understand, place security information in the
 234 .\"other sections (such as the
 235 .\" .B DESCRIPTION
 236 .\" or
 237 .\" .B USAGE
 238 .\" section).
 239 .\" However, please include security information somewhere!
 240 プログラムや関数が用いるファイルを列記する。 例えば、設定ファイル、起動ファイル、プログラムが直接操作するファイルなどである。
 241 これらのファイルのファイル名はフルパスで記載し、 ディレクトリの部分はユーザーの好みに合わせて インストール処理で変更できるようにする。
 242 多くのプログラムではデフォルトのインストール先は \fI/usr/local\fP である。したがってベースとなるマニュアルページでも
 243 \fI/usr/local\fP が使われていることが多いだろう。
 244 .TP
 245 \fBバージョン (VERSIONS)\fP
 246 システムコールやライブラリ関数が登場したり、動作の重要な変更が行われた、 Linux カーネルや glibc のバージョンについての簡潔な概要。
 247 一般に、全ての新しいインターフェイスは、マニュアルページに 「バージョン」の節を設けるべきである。
 248 残念なことに、多くの既存のマニュアルページにこの情報は含まれていない (これらのページが書かれた時点ではそのようなポリシーはなかったからである)。
 249 これを改善するパッチは歓迎されるが、 新しいコードを書くプログラマの観点からすれば、 おそらくこの情報が重要になるのは、 Linux 2.4
 250 以降で追加されたカーネルインターフェイス (カーネル 2.2 からの変更) と glibc バージョン 2.1 以降で追加されたライブラリ関数
 251 (glibc 2.0 からの変更)  についてのみであろう。
 252
 253 \fBsyscalls\fP(2)  マニュアルページにも、いろいろなシステムコールが初めて登場した カーネルバージョンについての情報が書かれている。
 254 .TP
 255 \fB準拠 (CONFORMING TO)\fP
 256 そのマニュアルページで説明している関数やコマンドに関連する 標準規格や慣習について記載する。 セクション 2 や 3 のページでは、このセクションで
 257 システムコールや関数が準拠する POSIX.1 のバージョンと、 C99 で規定されているかに触れるべきである。 (SUS, SUSv2, XPG
 258 などの他の標準規格や、SVr4 や 4.xBSD の実装標準に ついては、説明しているコールがこれらの規格で規定されており POSIX.1
 259 の現行バージョンで規定されていない場合以外は、 あまり深く気にする必要はない。)  (\fBstandards\fP(7)  参照。)
 260
 261 そのコールがどの標準にも基づいていないが、 他のシステムで広く存在する場合は、その旨を記載すること。 そのコールが Linux
 262 固有の場合は、その旨を記載すること。
 263
 264 (そうなっているページが多いが) このセクションの内容が標準のリスト だけの場合、リストの最後にピリオド (\(aq.\(aq) を置くこと。
 265 .TP
 266 \fB注意 (NOTES)\fP
 267 その他の注意点を書く。 セクション 2 と 3 のマニュアルページでは、 \fILinux での注意 (Linux Notes)\fP や \fIglibc
 268 での注意 (Glibc Notes)\fP という名前のサブセクション (\fBSS\fP) を設けると便利なこともある。
 269 .TP
 270 \fBバグ (BUGS)\fP
 271 制限・知られている欠陥や不便な点、その他不思議な動作などを書く。
 272 .TP
 273 \fB例 (EXAMPLE)\fP
 274 この関数・ファイル・コマンドをどのように使うかを示した ひとつまたは複数の例を記述する。 サンプルプログラムを書く際の詳細は
 275 以下の「サンプルプログラム」の節を参照のこと。
 276 .TP
 277 \fB著者 (AUTHORS)\fP
 278 文書またはプログラムの著者を列記する。 \fB著者セクションは極力使用しないこと。\fP 一般的には、著者のリストを各ページに撒き散らさない方がよい
 279 (時間がたつと、作者のリストは膨大になる可能性がある)。 マニュアルページを新規に書いたり、大幅に修正を行った場合には、
 280 ソースファイルにコメントとして著作権表示を追加すること。 あなたがデバイスドライバの作者で、バグを報告するためのアドレスを
 281 載せたい場合は、「バグ」セクションの後ろにこのセクションを配置すること。
 282 .TP
 283 \fB関連項目 (SEE ALSO)\fP
 284 関連するマニュアルページを、コンマ区切りのリストで、 セクション番号順に、セクション内ではアルファベット順で記載する。 可能なら関連する他の文書も書く。
 285 慣習では、このセクションは最後に置く。 リストの末尾にピリオドを置かないこと。
 286 .SS フォントの慣習
 287 .PP
 288 関数に対しては、引き数には常にイタリック体を用いる。 「たとえ書式 (SYNOPSIS) セクションであっても、このルールに従う」
 289 関数の他の部分はボールドを指定する:
 290 .PP
 291 \fB int myfunction(int \fP\fIargc\fP\fB, char **\fP\fIargv\fP\fB);\fP
 292 .PP
 293 引き数名といった変数名はイタリック体を指定すべきである。
 294 .PP
 295 ファイル名 (パス名、または \fI/usr/include\fP ディレクトリ内のファイルへの参照) は常にイタリック体にする (例:
 296 \fI<stdio.h>\fP)。 ただし、書式 (SYNOPSIS) セクションは例外で、 インクルードファイルはボールドにする (例:
 297 \fB#include <stdio.h>\fP)。 \fI/usr/include\fP 以下の標準のインクルードファイルを参照する際は、 通常の
 298 C 言語と同様に山括弧でヘッダファイルを囲ぬで指定する (例： \fI<stdio.h>\fP)。
 299 .PP
 300 通常、大文字で表現する特殊マクロはボールドで表す (例えば \fBMAXINT\fP)。 例外として NULL はボールドにしない。
 301 .PP
 302 エラーコードのリストを列挙する時には、コードはボールドで表す (このリストには通常 \fB\&.TP\fP マクロを用いる)。
 303 .PP
 304 完全なコマンドは、長い場合には、例に示すように 字下げした行にコマンドだけを記載すべきである。
 305 .in +4n
 306 .nf
 307
 308 man 7 man\-pages
 309
 310 .fi
 311 .in
 312 コマンドが短い場合は、 \fIman 7 man\-pages\fP のようにイタリック体で文中に埋め込んで記載してもよい。
 313 この場合、コマンド内の適切な位置に、改行できないスペース ("\e\ ")  を使うとよいかもしれない。 コマンドオプションも \fI\-l\fP
 314 のようにイタリック体で記載すべきである。
 315 .PP
 316 式は、専用の字下げした行に記載しない場合、イタリック体を指定すること。 繰り返しになるが、式を通常の文中に埋め込む場合にも、
 317 改行できないスペースを使うとよいだろう。
 318 .PP
 319 そのマニュアルページの説明対象への参照は、ボールドで名前を記載する。 対象が関数 (つまり、セクション 2 や 3 のページ) の場合、
 320 名前の後ろにローマンフォント (通常のフォント) で丸括弧の対を続ける。 例えば、 \fBfcntl\fP(2)  のマニュアルページでは、説明対象への参照は
 321 \fBfcntl\fP()  のように記載する。 マニュアルページのソースファイルには次のように記載するのが望ましい:
 322 .nf
 323
 324     .BR fcntl ()
 325
 326 .fi
 327 ("\efB...\efP()" よりも、この形式を使うこと。 これにより、マニュアルページのソースファイルを解釈するツールを 書くのが簡単になる。)
 328 .PP
 329 別のマニュアルページへの参照は、ボールドで名前を記載し、 それに続けてセクション番号を「必ず」書く。セクション番号は ローマンフォント
 330 (通常のフォント) で書き、スペースは入れない (例: \fBintro\fP(2))。 マニュアルページのソースファイルには次のように記載するのが望ましい:
 331 .nf
 332
 333     .BR intro (2)
 334
 335 .fi
 336 (相互参照にセクション番号を含めておくと、 \fBman2html\fP といったツールがページ間のハイパーリンクを適切に生成できる。)
 337 .SS "綴り (spelling)"
 338 リリース 2.59 からだが、 \fIman\-pages\fP はアメリカ英語の綴りの慣習に従っている。 新しいページやパッチは全てこの慣習に従って下さい。
 339 .SS サンプルプログラムとシェルのセッション
 340 マニュアルページには、システムコールやライブラリ関数の使い方を示す サンプルプログラムを含めることができる。 その際には、以下の点に留意すべきである。
 341 .TP  3
 342 *
 343 サンプルプログラムは C で記載すること。
 344 .TP
 345 *
 346 サンプルプログラムは、 インタフェースについて文章で簡単に説明できる以上のことを示す場合にだけ
 347 必要かつ有用である。インタフェースを呼び出す以外に何もしないサンプル プログラムは普通はほとんど役に立たない。
 348 .TP
 349 *
 350 サンプルプログラムはかなり短めにすること (100行未満が望ましく、50行未満が理想的である)。
 351 .TP
 352 *
 353 サンプルプログラムでは、システムコールやライブラリ関数を呼び出した後で エラーチェックを行うこと。
 354 .TP
 355 *
 356 サンプルプログラムは完結していて、 \fIcc\ \-Wall\fP でコンパイルした際に警告なしでコンパイルできること。
 357 .TP
 358 *
 359 可能かつ適切な場合には、サンプルプログラムで 入力により動作を変化させるなどの実験を行うとよい
 360 (理想的には、コマンドライン引き数や、プログラムが読み込む入力データ 経由で、動作を変化させるのがよい)。
 361 .TP
 362 *
 363 サンプルプログラムは、K&R (Kernighan and Ritchie) スタイルで書き、 字下げはスペース 4文字で行う。 (ソースコードで
 364 TAB 文字を使うのは避けること。)
 365 .PP
 366 サンプルプログラムがどんな風になっていればよいかの例については、 \fBwait\fP(2)  と \fBpipe\fP(2)  を参照すること。
 367
 368 プログラムの使い方や他のシステムの特徴を示すためにシェルのセッション例 を含める場合、ユーザの入力文をボールドにして、システムが生成する
 369 出力と区別できるようにすること。
 370 .SS 構造体の定義、シェルのセッションログなどの字下げ
 371 構造体の定義やシェルのセッションログなどを本文中に記載する際は、 スペース 4個分の字下げを行う (つまり、ブロックを \fI.in\ +4n\fP と
 372 \&\fI.in\fP で囲む)。
 373 .SH 例
 374 \fIman\-pages\fP パッケージに含まれるマニュアルページの体裁の標準的な例については、 \fBpipe\fP(2)  と \fBfcntl\fP(2)
 375 を参照すること。
 376 .SH 関連項目
 377 \fBman\fP(1), \fBman2html\fP(1), \fBgroff\fP(7), \fBgroff_man\fP(7), \fBman\fP(7),
 378 \fBmdoc\fP(7)