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