マニュアルページのセクション¶

マニュアルのセクションは、習慣的に以下のような定義が用いられている:

1 コマンド (プログラム)

シェルの中からユーザーが実行できるコマンド。

2 システムコール

カーネルが処理しなければならない関数。

3 ライブラリコール

libc の関数の大部分。

4 スペシャルファイル (デバイス)

/dev 以下にあるファイル。

5 ファイルのフォーマットと規約

/etc/passwd などの人が読めるファイルのフォーマット。

6 ゲーム

7 概要、約束事、その他

様々な事柄の概要、慣習、プロトコル、文字集合の規格、その他雑多なこと。

8 システム管理コマンド

mount(8) のような root のみが実行可能なコマンド。

マクロパッケージ¶

新しいマニュアルページは man(7) で説明されている groff an.tmac パッケージを使って記述すべきである。 この方針は一貫性の確保が主な理由である。既存の Linux のマニュアルページ の圧倒的多数がこれらのマクロを使って記述されている。

ソースファイルの配置に関する決まり事¶

マニュアルページのソースコードの 1行の長さは 可能な限り 75文字を越えないようにしてほしい。 こうすることで、パッチをメール本文に載せて送る場合に、 メールクライアントによる行折り返しを回避することができる。

新しい文は行頭から開始する。 これにより、パッチの内容を確認しやすくなる。 パッチは文単位であることが多いからである。

タイトル行¶

man ページの最初の行は TH コマンドにすべきである。

マニュアルページのセクション¶

昔から使われてきたセクション名を以下のリストに示す。 これらを使うと良いだろう。 一般的に、マニュアルページは、少なくとも 色つき のセクションを持つのが望ましい。 新しくマニュアルページを作成する際には、だいたい以下のリストに示した 順序でセクションを配置するようにしてもらいたい。

名前
書式
設定               [通常はセクション 4 のみ]
説明
オプション         [通常はセクション 1, 8 のみ]
終了ステータス     [通常はセクション 1, 8 のみ]
返り値             [通常はセクション 2, 3 のみ]
エラー             [たいていはセクション 2, 3 のみ]
環境変数
ファイル
バージョン         [通常はセクション 2, 3 のみ]
属性               [通常はセクション 2, 3 のみ]
準拠
注意/備考
バグ
例
関連項目

「伝統的に使われてきた見出しが使える場合には、それを使ってほしい。」 この種の一貫性を保つことで、情報を理解しやすくなるからである。 どうしても必要な場合には、理解しやすくなるように独自の見出しを 作ってもよい (特にセクション 4 や 5 のページではこうした方が わかりやすくなる)。ただし、そうする前に、伝統的な見出しを使い、 そのセクション内にサブセクション (.SS) を設けることで 対応できないか考えてほしい。

以下のリストでは、上記のセクションのそれぞれの内容について 詳しく説明する。

名前 (NAME)

このマニュアルページの名前

.SH NAME コマンドの後に続ける行の重要な情報については man(7) を参照。この行のすべての単語は ("\-" の直後の単語も含め) 小文字にすべきである。但し、英語や技術用語の慣例として別の記載をする場合はこの限りではない。

書式 (SYNOPSIS)

コマンドや関数インターフェースの簡潔な概要

コマンドに対しては、コマンドや引き数 (オプション) の文法を書く。 そのまま書くテキストにはボールド体を用い、置き換える引き数には イタリック体を用いる。省略可能なオプションはブラケット ([]) で囲い、 選択肢は縦棒 (|) で区切り、繰り返しには省略符号 (...) を書く。 関数に対しては、必要なデータ宣言や #include 指定を書き、関数宣言を続ける。

ヘッダーファイルから関数 (や変数) の定義を得るために 機能検査マクロ (feature test macro) を定義しなければならない場合、 書式 (SYNOPSIS) に必要な機能検査マクロを記載すべきである。 機能検査マクロについては feature_test_macros(7) で説明されている。

CONFIGURATION

デバイスの設定詳細。

通常、このセクションは 4 章のマニュアルページでのみ登場する。

説明 (DESCRIPTION)

プログラム・関数・フォーマットの動作・目的。

ファイルや標準入力をどのように処理し、標準出力や標準エラー出力を どのように生成するかといったことについて述べる。 内部動作や実装の詳細については省略する (ただしそれが動作の理解にどうしても必要なら別)。 通常の場合について記述する。 プログラムのコマンドラインオプションの説明には、 オプション のセクションを用いる。

システムコールやライブラリ関数の新しい動作や新しいフラグについて説明する際は、 変更が取り込まれたカーネルや C ライブラリのバージョンを注記に入れるように気を付けること。 フラグにこの情報の注記を入れる方法としては、推奨される方法は、 以下のように .TP リストの一部にすることである (この例はシステムコールの新しいフラグの場合)。

バージョン情報を入れておくのは、 古いバージョンのカーネルや C ライブラリを使わざるを得ないユーザーにとって、 特に有用である (例えば、組み込みシステムではよくあることである)。

オプション (OPTIONS)

プログラムが受け付けるコマンドラインオプションとその場合プログラムの振舞いがどう変わるかの説明。

このセクションはセクション 1 と 8 のマニュアルページにだけ登場すべきである。

終了ステータス (EXIT STATUS)

プログラムの終了ステータスの値とそれらの値に対応する状況の一覧。

このセクションはセクション 1 と 8 のマニュアルページにだけ登場すべきである。

返り値 (RETURN VALUE)

セクション 2 と 3 のページの場合、このセクションに ライブラリルーチンが呼び出し元に返す値のリストを記載する。 それらの値が返された場合の状態に対する説明も書く。

エラー (ERRORS)

セクション 2 と 3 のマニュアルページでは、 エラーが発生した場合に errno に設定される可能性がある値のリストを記載する。 リストには、エラーの値とエラーの原因についての情報を書く。

「エラーリストはアルファベット順にすべきである。」

環境変数 (ENVIRONMENT)

プログラムや関数に影響する環境変数の一覧と、それらの影響の説明。

ファイル (FILES)

プログラムや関数が用いるファイルの一覧。 設定ファイル、起動ファイル、プログラムが直接操作するファイルなど。

これらのファイルのファイル名はフルパスで記載し、 ディレクトリの部分はユーザーの好みに合わせて インストール処理で変更できるようにする。 多くのプログラムではデフォルトのインストール先は /usr/local である。したがってベースとなるマニュアルページでも /usr/local が使われていることが多いだろう。

属性 (ATTRIBUTES)

そのページで説明している関数の種々の属性の概要を、サブセクションに分けて説明する。

以下のサブセクションが定義されている。

バージョン (VERSIONS)

システムコールやライブラリ関数が登場したり、動作の重要な変更が行われた、 Linux カーネルや glibc のバージョンについての簡潔な概要。

一般に、全ての新しいインターフェイスは、マニュアルページに 「バージョン」の節を設けるべきである。 残念なことに、多くの既存のマニュアルページにこの情報は含まれていない (これらのページが書かれた時点ではそのようなポリシーはなかったからである)。 これを改善するパッチは歓迎されるが、 新しいコードを書くプログラマの観点からすれば、 おそらくこの情報が重要になるのは、 Linux 2.4 以降で追加されたカーネルインターフェイス (カーネル 2.2 からの変更) と glibc バージョン 2.1 以降で追加されたライブラリ関数 (glibc 2.0 からの変更) についてのみであろう。

syscalls(2) マニュアルページにも、いろいろなシステムコールが初めて登場した カーネルバージョンについての情報が書かれている。

準拠 (CONFORMING TO)

そのマニュアルページで説明している関数やコマンドに関連する標準規格や慣習について説明。

様々な標準を示すのに適した用語は standards(7) に見出しでリストになっている。

セクション 2 や 3 のページでは、このセクションで システムコールや関数が準拠する POSIX.1 のバージョンと、 C99 で規定されているかに触れるべきである。 (SUS, SUSv2, XPG などの他の標準規格や、SVr4 や 4.xBSD の実装標準に ついては、説明しているコールがこれらの規格で規定されており POSIX.1 の現行バージョンで規定されていない場合以外は、 あまり深く気にする必要はない。)

そのコールがどの標準にも基づいていないが、 他のシステムで広く存在する場合は、その旨を記載すること。 そのコールが Linux 固有の場合は、その旨を記載すること。

(そうなっているページが多いが) このセクションの内容が標準のリスト だけの場合、リストの最後にピリオド ('.') を置くこと。

注意 (NOTES)

その他の注記。

セクション 2 と 3 のマニュアルページでは、 Linux での注意 (Linux Notes) や glibc での注意 (Glibc Notes) という名前のサブセクション (SS) を設けると便利なこともある。

セクション 2 では、 システムコールに対する C ライブラリのラッパー関数とカーネルが提供する素のシステムコールのインターフェースの間で違いがある場合に、その違いを説明する注記を記載する際には C ライブラリとカーネル ABI の違い という見出しを使うこと。

バグ (BUGS)

制限、知られている欠陥や不便な点、その他不思議な動作など。

例 (EXAMPLE)

この関数、ファイル、コマンドをどのように使うかを示す、1〜2 個の例。

サンプルプログラムを書く際の詳細は 以下の「サンプルプログラム」の節を参照のこと。

著者 (AUTHORS)

文書やプログラムの著者の一覧。

著者セクションは極力使用しないこと。 一般的には、著者のリストを各ページに撒き散らさない方がよい (時間がたつと、作者のリストは膨大になる可能性がある)。 マニュアルページを新規に書いたり、大幅に修正を行った場合には、 ソースファイルにコメントとして著作権表示を追加すること。 あなたがデバイスドライバの作者で、バグを報告するためのアドレスを 載せたい場合は、「バグ」セクションの後ろにこのセクションを配置すること。

関連項目 (SEE ALSO)

関連するマニュアルページのコンマ区切りのリスト。 可能なら関連する他の文書も書く。

リストは、 セクション番号順に、セクション内ではアルファベット順で記載する。 このリストの末尾にピリオドを置かないこと。

関連項目のリストに長いマニュアルページ名が多く含まれる場合には、出力を見やすくするために .ad l (右揃えをしない) や .nh (ハイフンによる折り返しをしない) を活用するとよい。個々のページ名のハイフンによる折り返しは、単語の前に "\%" を付けることで防ぐことができる。

FOSS プロジェクトやそのドキュメントは本質的に分散して自律的に行われるので、 「関連項目」セクションに他のプロジェクトが提供するマニュアルページへの参照を含める必要がときとしてあり、多くの場合は含めるのが望ましい場合がある。

性別の区別のない表現の使用¶

可能な限り、マニュアルページの文章では性別の区別のない表現を使用すること。 性別に区別のない単数形の代名詞として "they" ("them", "themself", "their") を使用してもよい。

フォントの慣習¶

関数に対しては、引き数には常にイタリック体を用いる。 「たとえ書式 (SYNOPSIS) セクションであっても、このルールに従う」 関数の他の部分はボールドを指定する:

int myfunction(int argc, char **argv);

引き数名といった変数名はイタリック体を指定すべきである。

ファイル名 (パス名、またはヘッダーファイルへの参照) は常にイタリック体にする (例: <stdio.h>)。 ただし、書式 (SYNOPSIS) セクションは例外で、 インクルードファイルはボールドにする (例: #include <stdio.h>)。 標準のインクルードヘッダーファイルを参照する際は、 通常の C 言語と同様に山括弧でヘッダーファイルを囲ぬで指定する (例： <stdio.h>)。

通常、大文字で表現する特殊マクロはボールドで表す (例えば MAXINT)。 例外として NULL はボールドにしない。

エラーコードのリストを列挙する時には、コードはボールドで表す (このリストには通常 .TP マクロを用いる)。

完全なコマンドは、長い場合には、例に示すように 字下げした行にコマンドだけを記載し、コマンドの前後には空行を置くべきである。

man 7 man-pages

式は、専用の字下げした行に記載しない場合、イタリック体を指定すること。 繰り返しになるが、式を通常の文中に埋め込む場合にも、 改行できないスペースを使うとよいだろう。

そのマニュアルページの説明対象への参照は、ボールドで名前を記載する。 対象が関数 (つまり、セクション 2 や 3 のページ) の場合、 名前の後ろにローマンフォント (通常のフォント) で丸括弧の対を続ける。 例えば、 fcntl(2) のマニュアルページでは、説明対象への参照は fcntl() のように記載する。 マニュアルページのソースファイルには次のように記載するのが望ましい:

    .BR fcntl ()

別のマニュアルページへの参照は、ボールドで名前を記載し、 それに続けてセクション番号を「必ず」書く。セクション番号は ローマンフォント (通常のフォント) で書き、スペースは入れない (例: intro(2))。 マニュアルページのソースファイルには次のように記載するのが望ましい:

    .BR intro (2)

制御文字は太字で引用符なしで表記すること。 例えば ^X。

綴り (spelling)¶

リリース 2.59 からだが、 man-pages はアメリカ英語の綴りの慣習に従っている (以前はイギリス英語とアメリカ英語が基準もなく混在して使われていた)。 新しいページやパッチは全てこの慣習に従って下さい。

よく知られた綴りの違い以外に、微妙な違いもいくつか見られる。

*

アメリカ英語では "backward", "upward", "toward" を使う傾向にあるが、イギリス英語では "backwards", "upwards", "towards" などを使う方が多い。

BSD バージョン番号¶

BSD バージョン番号の伝統的な表記方法は x.yBSD である (x.y はバージョン番号; 例: 4.2BSD)。 BSD 4.3 といった表記は避けること。

大文字表記¶

サブセクション ("SS") 見出しでは、最初の単語だけ先頭文字を大文字にし、残りの単語は小文字にすること。但し、英語の用法 (例えば、固有名詞) やプログラミング言語の要件 (例えば、識別子の名前) などで別の表記をする場合はこの限りではない。

.SS Unicode under Linux

構造体の定義、シェルのセッションログなどの字下げ、など¶

構造体の定義やシェルのセッションログなどを本文中に記載する際は、 スペース 4個分の字下げを行う (つまり、ブロックを .in +4n と .in で囲む)。

推奨用語¶

以下の表にマニュアルページでの使用が推奨される用語を示す。これらは主にマニュアルページ間での一貫性を保つためである。

以下の修飾子としての複合語におけるハイフンの議論も参照。

使用を避ける用語¶

以下の表にマニュアルページでの使用を避けるべき用語を示す。 推奨される表現も合わせて記載している。 これらは主にマニュアルページ間での一貫性を保つためである。

商標¶

商標については正しい綴りと大文字小文字を使うこと。以下は時々綴りの間違いがある商標の正しい綴りのリストである。

DG/UX
HP-UX
UNIX
UnixWare

NULL, NUL, ヌルポインター、ヌル文字¶

null pointer (ヌルポインター) は何もないものを指すポインターで、通常は定数 NULL で示される。 一方、 NUL は null byte (ヌルバイト、値 0 のバイト) で、 C では文字定数 '\0' と表現される。

ポインターとして推奨される用語は "null pointer" (ヌルポインター) もしくは単に "NULL" である。 "NULL pointer" と記載するのは避けること。

バイトとして推奨される用語は "null byte" (ヌルバイト) である。 "NUL" と記載するのは避けること。 "NUL" は "NULL" と間違われることが非常に多いからである。 また、 "zero byte" (ゼロバイト) と "null character" (ヌル文字) も避けること。 C の文字列を終端するバイトは "the terminating null byte" (終端ヌルバイト)、 文字列の説明として使う場合には "null-terminated" (ヌル終端された) と記載すべきである。 "NUL-terminated" の使用は避けること。

ハイパーリンク¶

ハイパーリンクについては、 .UR/.UE マクロの組を使うこと (groff_man(7) 参照)。ページを以下のようにレンダリングする場合に、このマクロはウェブブラウザーで使用できる正しいハイパーリンクを生成してくれる。

BROWSER=firefox man -H pagename

e.g., i.e., etc., a.k.a. などの使用¶

一般的には、 "e.g.", "i.e.", "etc.", "a.k.a." などの省略形の使用は避けるべきである。 代わりに完全な形の単語を使うこと ("for example" (例えば), "that is" (つまり), "and so on" (〜など), "also known as" (別名))。

これらの省略形の使用が認められる唯一の場所は、 短い括弧で囲まれた余談 ("(e.g., like this one)") の場合である。

ここで記載しているように、これらの省略形では必ずピリオドを入れること。 また、"e.g." と "i.e." では常に後にカンマも付けること。

em によるダッシュ¶

*roff で em によるダッシュ—この部分の両端にある記号—を書くには "\(em" を使う。 (ASCII 端末では em によるダッシュは通常ハイフン 2 つとして表示されるが、別の活版印刷の場合などでは長いダッシュとして表示されることもある。) em によるダッシュの両側にはスペースを置かないこと。

修飾子としての複合語におけるハイフン¶

何かを修飾する際 (すなわち後続の名詞を限定する場合) 複合語にはハイフンを入れること。いくつか例を挙げる。

32-bit value (32 ビット値)
command-line argument (コマンドライン引き数)
floating-point number (浮動小数点数)
run-time check (実行時チェック)
user-space function (ユーザー空間関数)
wide-character string (ワイド文字の文字列)

multi, non, pre, re, sub などとの組み合わせでのハイフン¶

一般的に最近の英語の傾向では、"multi", "non", "pre", "re", "sub" などの接尾辞の後ろにはハイフンを付けない。 これらの接尾辞が単純な接尾語との普通の英語の組み合わせの場合には、 マニュアルページでは基本的にこのルールに従う。 以下のリストに推奨される形式での例をいくつか挙げる。

interprocess
multithreaded
multiprocess
nonblocking
nondefault
nonempty
noninteractive
nonnegative
nonportable
nonzero
preallocated
precreate
prerecorded
reestablished
reinitialize
rearm
reread
subcomponent
subdirectory
subsystem

接尾語が通常の英単語以外 (商標、固有名詞、頭字語、複合語) と組み合わされる場合は、ハイフンを使うこと。以下に例を挙げる。

non-ASCII
non-English
non-NULL
non-real-time

最後に、"re-create" と "recreate" は異なる別の動詞である点に注意すること。たいていの場合、使おうと思っているのは前者であろう。

本当のマイナス文字¶

本当の意味でのマイナス文字が必要な場合は (-1 といった数字や ls -l といった先頭にダッシュのオプションを記載する場合など)、マニュアルページの原文では以下の表記を使うこと。

\-

このガイドラインはサンプルコードの場合にも適用される。

文字定数¶

ASCII と UTF-8 の両方で正しくレンダリングされるシングルクォート (一重引用符) を生成するには、マニュアルページの原文では以下の表記を使うこと。

\(aqC\(aq

ここで C が括弧で囲まれる文字である。このガイドラインはサンプルコードの場合にも適用される。

サンプルプログラムとシェルのセッション¶

マニュアルページには、システムコールやライブラリ関数の使い方を示す サンプルプログラムを含めることができる。 その際には、以下の点に留意すべきである。

• サンプルプログラムは C で記載すること。
• サンプルプログラムは、 インターフェースについて文章で簡単に説明できる以上のことを示す場合にだけ 必要かつ有用である。インターフェースを呼び出す以外に何もしないサンプル プログラムは普通はほとんど役に立たない。
• サンプルプログラムはかなり短めにすること (100行未満が望ましく、50行未満が理想的である)。
• サンプルプログラムでは、システムコールやライブラリ関数を呼び出した後で エラーチェックを行うこと。
• サンプルプログラムは完結していて、 cc -Wall でコンパイルした際に警告なしでコンパイルできること。
• 可能かつ適切な場合には、サンプルプログラムで 入力により動作を変化させるなどの実験を行うとよい (理想的には、コマンドライン引き数や、プログラムが読み込む入力データ 経由で、動作を変化させるのがよい)。
• サンプルプログラムは、K&R (Kernighan and Ritchie) スタイルで書き、 字下げはスペース 4文字で行う。 (ソースコードで TAB 文字を使うのは避けること。)
• 一貫性を保つため、すべてのサンプルプログラムは以下のいずれかで終了すること。

  
  exit(EXIT_SUCCESS);
  exit(EXIT_FAILURE);

  プログラムを終了するのに以下を使うのは避けること。

  
  exit(0);
  exit(1);
  return n;

• プログラムソースの前に説明文がある場合は、プログラムソースの見出しをソースコードの前に付けること。

  .SS プログラムのソース

  説明文がシェルセッションのログを含む場合は必ずこのようにすること。

プログラムの使い方や他のシステムの特徴を示すためにシェルのセッションログを含める場合、

• セッションログをソースコードの前に置くこと
• セッションログをスペース 4 つで字下げすること
• ユーザーの入力文をボールドにして、システムが生成する出力と区別できるようにすること

サンプルプログラムがどんな風になっていればよいかの例については、 wait(2) と pipe(2) を参照すること。