X-Git-Url: http://git.osdn.net/view?p=linuxjm%2FLDP_man-pages.git;a=blobdiff_plain;f=release%2Fman7%2Fman-pages.7;h=c0bbabecfdf27f07b6f0e16d06686e3820adfded;hp=aad882376e2130986e64fb9d5435a8e283dd00f7;hb=bb92023e2caf6dc30bd3a8f07877ec870c853e23;hpb=f5d1a45c05af679fb80706c40816f4ec5152926e diff --git a/release/man7/man-pages.7 b/release/man7/man-pages.7 index aad88237..c0bbabec 100644 --- a/release/man7/man-pages.7 +++ b/release/man7/man-pages.7 @@ -2,6 +2,7 @@ .\" (faith@cs.unc.edu and dwheeler@ida.org) .\" and (C) Copyright 2007 Michael Kerrisk .\" +.\" %%%LICENSE_START(VERBATIM) .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. @@ -21,6 +22,7 @@ .\" .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. +.\" %%%LICENSE_END .\" .\" 2007-05-30 created by mtk, using text from old man.7 plus .\" rewrites and additional text. @@ -30,15 +32,19 @@ .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* -.TH MAN\-PAGES 7 2008\-10\-28 Linux "Linux Programmer's Manual" +.TH MAN\-PAGES 7 2013\-02\-24 Linux "Linux Programmer's Manual" .SH 名前 man\-pages \- Linux の man ページを書く際の決まり事 .SH 書式 \fBman\fP [\fIsection\fP] \fItitle\fP .SH 説明 -このページでは、 Linux \fIman\-pages\fP プロジェクトのマニュアルページを書く際に 従うべき決まり事について説明する。 Linux -\fIman\-pages\fP は Linux のマニュアルページの セクション 2, 3, 4, 5, 7 から構成されている。 -このページで説明されている決まり事は、他のプロジェクトの マニュアルページを書く作者にも役立つことだろう。 +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. .SS マニュアルページのセクション .PP マニュアルのセクションは、習慣的に以下のような定義が用いられている: @@ -60,7 +66,7 @@ man\-pages \- Linux の man ページを書く際の決まり事 .TP \fB6 ゲーム\fP .TP -\fB7 約束事その他\fP +\fB7 概要、約束事、その他\fP 様々な事柄の概要、慣習、プロトコル、文字集合の規格、その他雑多なこと。 .TP \fB8 システム管理コマンド\fP @@ -163,7 +169,11 @@ Programmer's Manual\fP を使うこと)。 以下のリストでは、上記のセクションのそれぞれの内容について 詳しく説明する。 .TP 14 \fB名前 (NAME)\fP -そのマニュアルページの名前。 \fB.SH NAME\fP コマンドの行が従うべき大事な点については \fBman\fP(7) を参照してほしい。 +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. .TP \fB書式 (SYNOPSIS)\fP コマンドや関数のインターフェースを簡潔に記述する。 コマンドに対しては、コマンドや引き数 (オプション) の文法を書く。 @@ -283,6 +293,12 @@ Programmer's Manual\fP を使うこと)。 \fB関連項目 (SEE ALSO)\fP 関連するマニュアルページを、コンマ区切りのリストで、 セクション番号順に、セクション内ではアルファベット順で記載する。 可能なら関連する他の文書も書く。 慣習では、このセクションは最後に置く。 リストの末尾にピリオドを置かないこと。 +.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%". .SS フォントの慣習 .PP 関数に対しては、引き数には常にイタリック体を用いる。 「たとえ書式 (SYNOPSIS) セクションであっても、このルールに従う」 @@ -336,6 +352,11 @@ man 7 man\-pages (相互参照にセクション番号を含めておくと、 \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 サンプルプログラムとシェルのセッション マニュアルページには、システムコールやライブラリ関数の使い方を示す サンプルプログラムを含めることができる。 その際には、以下の点に留意すべきである。 .TP 3 @@ -377,6 +398,6 @@ TAB 文字を使うのは避けること。) \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.41 の一部 +この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man\-pages/ に書かれている。