\fBman\fP [\fIsection\fP] \fItitle\fP
.SH 説明
このページでは、 Linux \fIman\-pages\fP プロジェクトのマニュアルページを書く際に 従うべき決まり事について説明する。 Linux
-\fIman\-pages\fP プロジェクトは Linux カーネルおよび GNU C ライブラリが提供するユーザ空間 API
+\fIman\-pages\fP プロジェクトは Linux カーネルおよび GNU C ライブラリが提供するユーザー空間 API
のドキュメント作成を行っている。Linux システムのマニュアルページのセクション 2 のページのほとんどと、セクション 3, 4, 5, 7
の多くのページが、このプロジェクトにより提供されている。このページで説明されている決まり事は、他のプロジェクトの
マニュアルページを書く作者にも役立つことだろう。
マニュアルのセクションは、習慣的に以下のような定義が用いられている:
.TP 10
\fB1 コマンド (プログラム)\fP
-シェルの中からユーザが実行できるコマンド。
+ã\82·ã\82§ã\83«ã\81®ä¸ã\81\8bã\82\89ã\83¦ã\83¼ã\82¶ã\83¼ã\81\8cå®\9fè¡\8cã\81§ã\81\8dã\82\8bã\82³ã\83\9eã\83³ã\83\89ã\80\82
.TP
\fB2 システムコール\fP
カーネルが処理しなければならない関数。
関数に対しては、必要なデータ宣言や \fB#include\fP 指定を書き、関数宣言を続ける。
.\" FIXME . Say something here about compiler options
-ヘッダファイルから関数 (や変数) の定義を得るために 機能検査マクロ (feature test macro) を定義しなければならない場合、 書式
+ã\83\98ã\83\83ã\83\80ã\83¼ã\83\95ã\82¡ã\82¤ã\83«ã\81\8bã\82\89é\96¢æ\95° (ã\82\84å¤\89æ\95°) ã\81®å®\9a義ã\82\92å¾\97ã\82\8bã\81\9fã\82\81ã\81« æ©\9fè\83½æ¤\9cæ\9f»ã\83\9eã\82¯ã\83 (feature test macro) ã\82\92å®\9a義ã\81\97ã\81ªã\81\91ã\82\8cã\81°ã\81ªã\82\89ã\81ªã\81\84å ´å\90\88ã\80\81 æ\9b¸å¼\8f
(SYNOPSIS) に必要な機能検査マクロを記載すべきである。 機能検査マクロについては \fBfeature_test_macros\fP(7)
で説明されている。
.TP
.\" section).
ファイルや標準入力をどのように処理し、標準出力や標準エラー出力を どのように生成するかといったことについて述べる。
内部動作や実装の詳細については省略する (ただしそれが動作の理解にどうしても必要なら別)。 通常の場合について記述する。
-ã\83\97ã\83ã\82°ã\83©ã\83 ã\81®ã\82³ã\83\9eã\83³ã\83\89ã\83©ã\82¤ã\83³ã\83»ã\82ªã\83\97ã\82·ã\83§ã\83³ã\81®èª¬æ\98\8eã\81«ã\81¯ã\80\81 \fBã\82ªã\83\97ã\82·ã\83§ã\83³\fP ã\81®ã\82»ã\82¯ã\82·ã\83§ã\83³ã\82\92ç\94¨ã\81\84ã\82\8bã\80\82
+プログラムのコマンドラインオプションの説明には、 \fBオプション\fP のセクションを用いる。
システムコールやライブラリ関数の新しい動作や新しいフラグについて説明する際は、 変更が取り込まれたカーネルや C
ライブラリのバージョンを注記に入れるように気を付けること。 フラグにこの情報の注記を入れる方法としては、推奨される方法は、 以下のように \fB.TP\fP
フラグの説明...
.RE
.IP
-バージョン情報を入れておくのは、 古いバージョンのカーネルや C ライブラリを使わざるを得ないユーザにとって、 特に有用である
+ã\83\90ã\83¼ã\82¸ã\83§ã\83³æ\83\85å ±ã\82\92å\85¥ã\82\8cã\81¦ã\81\8aã\81\8fã\81®ã\81¯ã\80\81 å\8f¤ã\81\84ã\83\90ã\83¼ã\82¸ã\83§ã\83³ã\81®ã\82«ã\83¼ã\83\8dã\83«ã\82\84 C ã\83©ã\82¤ã\83\96ã\83©ã\83ªã\82\92使ã\82\8fã\81\96ã\82\8bã\82\92å¾\97ã\81ªã\81\84ã\83¦ã\83¼ã\82¶ã\83¼ã\81«ã\81¨ã\81£ã\81¦ã\80\81 ç\89¹ã\81«æ\9c\89ç\94¨ã\81§ã\81\82ã\82\8b
(例えば、組み込みシステムではよくあることである)。
.TP
\fBオプション (OPTIONS)\fP
-ã\83\97ã\83ã\82°ã\83©ã\83 ã\81\8cå\8f\97ã\81\91ä»\98ã\81\91ã\82\8bã\82³ã\83\9eã\83³ã\83\89ã\83©ã\82¤ã\83³ã\83»ã\82ªã\83\97ã\82·ã\83§ã\83³ã\81¨ã\81\9dã\81®å ´å\90\88ã\83\97ã\83ã\82°ã\83©ã\83 ã\81®æ\8c¯è\88\9eã\81\84ã\81\8cã\81©ã\81\86å¤\89ã\82\8fã\82\8bã\81\8bã\81®èª¬æ\98\8eã\80\82
+プログラムが受け付けるコマンドラインオプションとその場合プログラムの振舞いがどう変わるかの説明。
.\" .TP
.\" .B USAGE
Notes)\fP という名前のサブセクション (\fBSS\fP) を設けると便利なこともある。
セクション 2 では、 システムコールに対する C
-ライブラリのラッパー関数とカーネルが提供する素のシステムコールのインタフェースの間で違いがある場合に、その違いを説明する注記を記載する際には \fIC
+ã\83©ã\82¤ã\83\96ã\83©ã\83ªã\81®ã\83©ã\83\83ã\83\91ã\83¼é\96¢æ\95°ã\81¨ã\82«ã\83¼ã\83\8dã\83«ã\81\8cæ\8f\90ä¾\9bã\81\99ã\82\8bç´ ã\81®ã\82·ã\82¹ã\83\86ã\83 ã\82³ã\83¼ã\83«ã\81®ã\82¤ã\83³ã\82¿ã\83¼ã\83\95ã\82§ã\83¼ã\82¹ã\81®é\96\93ã\81§é\81\95ã\81\84ã\81\8cã\81\82ã\82\8bå ´å\90\88ã\81«ã\80\81ã\81\9dã\81®é\81\95ã\81\84ã\82\92説æ\98\8eã\81\99ã\82\8b注è¨\98ã\82\92è¨\98è¼\89ã\81\99ã\82\8bé\9a\9bã\81«ã\81¯ \fIC
ライブラリとカーネル ABI の違い\fP という見出しを使うこと。
.TP
\fBバグ (BUGS)\fP
.PP
ファイル名 (パス名、またはヘッダーファイルへの参照) は常にイタリック体にする (例: \fI<stdio.h>\fP)。 ただし、書式
(SYNOPSIS) セクションは例外で、 インクルードファイルはボールドにする (例: \fB#include <stdio.h>\fP)。
-æ¨\99æº\96ã\81®ã\82¤ã\83³ã\82¯ã\83«ã\83¼ã\83\89ã\83\98ã\83\83ã\83\80ã\83\95ã\82¡ã\82¤ã\83«ã\82\92å\8f\82ç\85§ã\81\99ã\82\8bé\9a\9bã\81¯ã\80\81 é\80\9a常ã\81® C è¨\80èª\9eã\81¨å\90\8cæ§\98ã\81«å±±æ\8b¬å¼§ã\81§ã\83\98ã\83\83ã\83\80ファイルを囲ぬで指定する (例：
+æ¨\99æº\96ã\81®ã\82¤ã\83³ã\82¯ã\83«ã\83¼ã\83\89ã\83\98ã\83\83ã\83\80ã\83¼ã\83\95ã\82¡ã\82¤ã\83«ã\82\92å\8f\82ç\85§ã\81\99ã\82\8bé\9a\9bã\81¯ã\80\81 é\80\9a常ã\81® C è¨\80èª\9eã\81¨å\90\8cæ§\98ã\81«å±±æ\8b¬å¼§ã\81§ã\83\98ã\83\83ã\83\80ã\83¼ファイルを囲ぬで指定する (例：
\fI<stdio.h>\fP)。
.PP
通常、大文字で表現する特殊マクロはボールドで表す (例えば \fBMAXINT\fP)。 例外として NULL はボールドにしない。
.IP * 3
サンプルプログラムは C で記載すること。
.IP *
-サンプルプログラムは、 インタフェースについて文章で簡単に説明できる以上のことを示す場合にだけ
-必要かつ有用である。インタフェースを呼び出す以外に何もしないサンプル プログラムは普通はほとんど役に立たない。
+ã\82µã\83³ã\83\97ã\83«ã\83\97ã\83ã\82°ã\83©ã\83 ã\81¯ã\80\81 ã\82¤ã\83³ã\82¿ã\83¼ã\83\95ã\82§ã\83¼ã\82¹ã\81«ã\81¤ã\81\84ã\81¦æ\96\87ç« ã\81§ç°¡å\8d\98ã\81«èª¬æ\98\8eã\81§ã\81\8dã\82\8b以ä¸\8aã\81®ã\81\93ã\81¨ã\82\92示ã\81\99å ´å\90\88ã\81«ã\81 ã\81\91
+å¿\85è¦\81ã\81\8bã\81¤æ\9c\89ç\94¨ã\81§ã\81\82ã\82\8bã\80\82ã\82¤ã\83³ã\82¿ã\83¼ã\83\95ã\82§ã\83¼ã\82¹ã\82\92å\91¼ã\81³å\87ºã\81\99以å¤\96ã\81«ä½\95ã\82\82ã\81\97ã\81ªã\81\84ã\82µã\83³ã\83\97ã\83« ã\83\97ã\83ã\82°ã\83©ã\83 ã\81¯æ\99®é\80\9aã\81¯ã\81»ã\81¨ã\82\93ã\81©å½¹ã\81«ç«\8bã\81\9fã\81ªã\81\84ã\80\82
.IP *
サンプルプログラムはかなり短めにすること (100行未満が望ましく、50行未満が理想的である)。
.IP *
.IP *
セッションログをスペース 4 つで字下げすること
.IP *
-ユーザの入力文をボールドにして、システムが生成する出力と区別できるようにすること
+ã\83¦ã\83¼ã\82¶ã\83¼ã\81®å\85¥å\8a\9bæ\96\87ã\82\92ã\83\9cã\83¼ã\83«ã\83\89ã\81«ã\81\97ã\81¦ã\80\81ã\82·ã\82¹ã\83\86ã\83 ã\81\8cç\94\9fæ\88\90ã\81\99ã\82\8bå\87ºå\8a\9bã\81¨å\8cºå\88¥ã\81§ã\81\8dã\82\8bã\82\88ã\81\86ã\81«ã\81\99ã\82\8bã\81\93ã\81¨
.PP
サンプルプログラムがどんな風になっていればよいかの例については、 \fBwait\fP(2) と \fBpipe\fP(2) を参照すること。
.SH 例
OSDN Git Service
