.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
-.TH MAN\-PAGES 7 2013\-02\-24 Linux "Linux Programmer's Manual"
+.TH MAN\-PAGES 7 2013\-06\-21 Linux "Linux Programmer's Manual"
.SH 名前
man\-pages \- Linux の man ページを書く際の決まり事
.SH 書式
\fBman\fP [\fIsection\fP] \fItitle\fP
.SH 説明
-This page describes the conventions that should be employed when writing man
-pages for the Linux \fIman\-pages\fP project, which documents the user\-space API
-provided by the Linux kernel and the GNU C library. The project thus
-provides most of the pages in Section 2, as well as many of the pages that
-appear in Sections 3, 4, 5, and 7 of the man pages on a Linux system. The
-conventions described on this page may also be useful for authors writing
-man pages for other projects.
+このページでは、 Linux \fIman\-pages\fP プロジェクトのマニュアルページを書く際に 従うべき決まり事について説明する。 Linux
+\fIman\-pages\fP プロジェクトは Linux カーネルおよび GNU C ライブラリが提供するユーザ空間 API
+のドキュメント作成を行っている。Linux システムのマニュアルページのセクション 2 のページのほとんどと、セクション 3, 4, 5, 7
+の多くのページが、このプロジェクトにより提供されている。このページで説明されている決まり事は、他のプロジェクトの
+マニュアルページを書く作者にも役立つことだろう。
.SS マニュアルページのセクション
.PP
マニュアルのセクションは、習慣的に以下のような定義が用いられている:
.\" SECURITY,
.\" AUTHORS sections are discouraged
.\" AUTHORS [Discouraged]
-\fB名前\fP
-\fB書式\fP
-設定 [通常はセクション 4 のみ]
-\fB説明\fP
-オプション [通常はセクション 1, 8 のみ]
-終了ステータス [通常はセクション 1, 8 のみ]
-返り値 [通常はセクション 2, 3 のみ]
-エラー [たいていはセクション 2, 3 のみ]
-環境変数
-ファイル
-バージョン [通常はセクション 2, 3 のみ]
-準拠
-注意/備考
-バグ
-例
-\fB関連項目\fP
+\fBNAME\fP
+\fBSYNOPSIS\fP
+CONFIGURATION [Normally only in Section 4]
+\fBDESCRIPTION\fP
+OPTIONS [Normally only in Sections 1, 8]
+EXIT STATUS [Normally only in Sections 1, 8]
+RETURN VALUE [Normally only in Sections 2, 3]
+ERRORS [Typically only in Sections 2, 3]
+ENVIRONMENT
+FILES
+ATTRIBUTES [Normally only in Sections 2, 3]
+VERSIONS [Normally only in Sections 2, 3]
+CONFORMING TO
+NOTES
+BUGS
+EXAMPLE
+\fBSEE ALSO\fP
.fi
.in
以下のリストでは、上記のセクションのそれぞれの内容について 詳しく説明する。
.TP 14
\fB名前 (NAME)\fP
-The name of this manual page. See \fBman\fP(7) for important details of the
-line(s) that should follow the \fB.SH NAME\fP command. All words in this line
-(including the word immediately following the "\e\-") should be in lowercase,
-except where English or technical terminological convention dictates
-otherwise.
+マニュアルページの名前。 \fB.SH NAME\fP コマンドの後に続ける行の重要な情報については \fBman\fP(7) を参照。この行のすべての単語は
+("\e\-" の直後の単語も含め) 小文字にすべきである。但し、英語や技術用語の慣例として別の記載をする場合はこの限りではない。
.TP
\fB書式 (SYNOPSIS)\fP
コマンドや関数のインターフェースを簡潔に記述する。 コマンドに対しては、コマンドや引き数 (オプション) の文法を書く。
多くのプログラムではデフォルトのインストール先は \fI/usr/local\fP である。したがってベースとなるマニュアルページでも
\fI/usr/local\fP が使われていることが多いだろう。
.TP
+\fBATTRIBUTES\fP
+A summary of various attributes of the function(s) documented on this page,
+broken into subsections. The following subsections are defined:
+.sp
+.RS
+.TP
+\fBMultithreading (see pthreads(7))\fP
+This subsection notes attributes relating to multithreaded applications:
+.RS
+.IP * 3
+Whether the function is thread\-safe.
+.IP *
+Whether the function is a cancellation point.
+.IP *
+Whether the function is async\-cancel\-safe.
+.RE
+.IP
+Details of these attributes can be found in \fBpthreads\fP(7).
+.RE
+.TP
\fBバージョン (VERSIONS)\fP
システムコールやライブラリ関数が登場したり、動作の重要な変更が行われた、 Linux カーネルや glibc のバージョンについての簡潔な概要。
一般に、全ての新しいインターフェイスは、マニュアルページに 「バージョン」の節を設けるべきである。
関連するマニュアルページを、コンマ区切りのリストで、 セクション番号順に、セクション内ではアルファベット順で記載する。 可能なら関連する他の文書も書く。
慣習では、このセクションは最後に置く。 リストの末尾にピリオドを置かないこと。
.IP
-Where the SEE ALSO list contains many long manual page names, to improve the
-visual result of the output, it may be useful to employ the \fI.ad l\fP (don't
-right justify) and \fI.nh\fP (don't hyphenate) directives. Hyphenation of
-individual page names can be prevented by preceding words with the string
-"\e%".
+関連項目のリストに長いマニュアルページ名が多く含まれる場合には、出力を見やすくするために \fI.ad l\fP (右揃えをしない) や \fI.nh\fP
+(ハイフンによる折り返しをしない) を活用するとよい。個々のページ名のハイフンによる折り返しは、単語の前に "\e%" を付けることで防ぐことができる。
.SS フォントの慣習
.PP
関数に対しては、引き数には常にイタリック体を用いる。 「たとえ書式 (SYNOPSIS) セクションであっても、このルールに従う」
(相互参照にセクション番号を含めておくと、 \fBman2html\fP といったツールがページ間のハイパーリンクを適切に生成できる。)
.SS "綴り (spelling)"
リリース 2.59 からだが、 \fIman\-pages\fP はアメリカ英語の綴りの慣習に従っている。 新しいページやパッチは全てこの慣習に従って下さい。
-.SS Capitalization
-In subsection ("SS") headings capitalize the first word in heading, but
-otherwise use lower case, except where English usage (e.g., proper nouns) or
-programming language requirements (e.g., identifier names) dictate
-otherwise.
+.SS 大文字表記
+サブセクション ("SS") 見出しでは、最初の単語だけ先頭文字を大文字にし、残りの単語は小文字にすること。但し、英語の用法 (例えば、固有名詞)
+やプログラミング言語の要件 (例えば、識別子の名前) などで別の表記をする場合はこの限りではない。
.SS サンプルプログラムとシェルのセッション
マニュアルページには、システムコールやライブラリ関数の使い方を示す サンプルプログラムを含めることができる。 その際には、以下の点に留意すべきである。
.TP 3
\fBman\fP(1), \fBman2html\fP(1), \fBgroff\fP(7), \fBgroff_man\fP(7), \fBman\fP(7),
\fBmdoc\fP(7)
.SH この文書について
-この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
+この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
である。プロジェクトの説明とバグ報告に関する情報は
http://www.kernel.org/doc/man\-pages/ に書かれている。
OSDN Git Service
