OSDN Git Service

(split) Import translated manuals from JM CVS Repository.
[linuxjm/LDP_man-pages.git] / 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 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
8 .\"
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
13 .\"
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein.  The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
20 .\" professionally.
21 .\"
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
24 .\"
25 .\" 2007-05-30 created by mtk, using text from old man.7 plus
26 .\" rewrites and additional text.
27 .\"
28 .\" Japanese Version Copyright (c) 2007  Akihiro MOTOKI
29 .\"         all rights reserved.
30 .\" Translated 2007-06-13, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.54
31 .\" Updated 2007-07-04, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.59
32 .\" Updated 2007-09-03, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.64
33 .\" Updated 2008-08-09, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.05
34 .\" 
35 .TH MAN-PAGES 7 2008-10-28 "Linux" "Linux Programmer's Manual"
36 .\"O .SH NAME
37 .SH Ì¾Á°
38 .\"O man-pages \- conventions for writing Linux man pages
39 man-pages \- Linux ¤Î man ¥Ú¡¼¥¸¤ò½ñ¤¯ºÝ¤Î·è¤Þ¤ê»ö
40 .\"O .SH SYNOPSIS
41 .SH ½ñ¼°
42 .B man
43 .RI [ section ]
44 .I title
45 .\"O .SH DESCRIPTION
46 .SH ÀâÌÀ
47 .\"O This page describes the conventions that should be employed
48 .\"O when writing man pages for the Linux \fIman-pages\fP project,
49 .\"O which comprises Sections 2, 3, 4, 5, and 7 of the Linux manual pages.
50 .\"O The conventions described on this page may also be useful
51 .\"O for authors writing man pages for other projects.
52 ¤³¤Î¥Ú¡¼¥¸¤Ç¤Ï¡¢
53 Linux \fIman-pages\fP ¥×¥í¥¸¥§¥¯¥È¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ò½ñ¤¯ºÝ¤Ë
54 ½¾¤¦¤Ù¤­·è¤Þ¤ê»ö¤Ë¤Ä¤¤¤ÆÀâÌÀ¤¹¤ë¡£
55 Linux \fIman-pages\fP ¤Ï Linux ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î
56 ¥»¥¯¥·¥ç¥ó 2, 3, 4, 5, 7 ¤«¤é¹½À®¤µ¤ì¤Æ¤¤¤ë¡£
57 ¤³¤Î¥Ú¡¼¥¸¤ÇÀâÌÀ¤µ¤ì¤Æ¤¤¤ë·è¤Þ¤ê»ö¤Ï¡¢Â¾¤Î¥×¥í¥¸¥§¥¯¥È¤Î
58 ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ò½ñ¤¯ºî¼Ô¤Ë¤âÌòΩ¤Ä¤³¤È¤À¤í¤¦¡£
59 .\"O .SS Sections of the Manual Pages
60 .SS ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î¥»¥¯¥·¥ç¥ó
61 .PP
62 .\"O The manual Sections are traditionally defined as follows:
63 ¥Þ¥Ë¥å¥¢¥ë¤Î¥»¥¯¥·¥ç¥ó¤Ï¡¢½¬´·Åª¤Ë°Ê²¼¤Î¤è¤¦¤ÊÄêµÁ¤¬ÍѤ¤¤é¤ì¤Æ¤¤¤ë:
64 .TP 10
65 .\"O .B 1 Commands (Programs)
66 .\"O Those commands that can be executed by the user from within
67 .\"O a shell.
68 .B 1 ¥³¥Þ¥ó¥É (¥×¥í¥°¥é¥à)
69 ¥·¥§¥ë¤ÎÃ椫¤é¥æ¡¼¥¶¤¬¼Â¹Ô¤Ç¤­¤ë¥³¥Þ¥ó¥É¡£
70 .TP
71 .\"O .B 2 System calls
72 .\"O Those functions which must be performed by the kernel.
73 .B 2 ¥·¥¹¥Æ¥à¥³¡¼¥ë
74 ¥«¡¼¥Í¥ë¤¬½èÍý¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤´Ø¿ô¡£
75 .TP
76 .\"O .B 3 Library calls
77 .\"O Most of the
78 .\"O .I libc
79 .\"O functions.
80 .B 3 ¥é¥¤¥Ö¥é¥ê¥³¡¼¥ë
81 .I libc
82 ¤Î´Ø¿ô¤ÎÂçÉôʬ¡£
83 .TP
84 .\"O .B 4 Special files (devices)
85 .\"O Files found in
86 .\"O .IR /dev .
87 .B 4 ¥¹¥Ú¥·¥ã¥ë¥Õ¥¡¥¤¥ë (¥Ç¥Ð¥¤¥¹)
88 .I /dev
89 °Ê²¼¤Ë¤¢¤ë¥Õ¥¡¥¤¥ë¡£
90 .TP
91 .\"O .B 5 File formats and conventions
92 .\"O The format for
93 .\"O .I /etc/passwd
94 .\"O and other human-readable files.
95 .B 5 ¥Õ¥¡¥¤¥ë¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤Èµ¬Ìó
96 .I /etc/passwd
97 ¤Ê¤É¤Î¿Í¤¬Æɤá¤ë¥Õ¥¡¥¤¥ë¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¡£
98 .TP
99 .\"O .B 6 Games
100 .B 6 ¥²¡¼¥à
101 .TP
102 .\"O .B 7 Conventions and miscellaneous
103 .\"O Overviews of various topics, conventions and protocols,
104 .\"O character set standards, and miscellaneous other things.
105 .B 7 Ìó«»ö¤½¤Î¾
106 ÍÍ¡¹¤Ê»öÊÁ¤Î³µÍס¢´·½¬¡¢¥×¥í¥È¥³¥ë¡¢Ê¸»ú½¸¹ç¤Îµ¬³Ê¡¢¤½¤Î¾»¨Â¿¤Ê¤³¤È¡£
107 .TP
108 .\"O .B 8 System management commands
109 .\"O Commands like
110 .\"O .BR mount (8),
111 .\"O many of which only root can execute.
112 .B 8 ¥·¥¹¥Æ¥à´ÉÍý¥³¥Þ¥ó¥É
113 .BR mount (8)
114 ¤Î¤è¤¦¤Ê root ¤Î¤ß¤¬¼Â¹Ô²Äǽ¤Ê¥³¥Þ¥ó¥É¡£
115 .\" .TP
116 .\"O .\" .B 9 Kernel routines
117 .\"O .\" This is an obsolete manual section.
118 .\"O .\" Once it was thought a good idea to document the Linux kernel here,
119 .\"O .\" but in fact very little has been documented, and the documentation
120 .\"O .\" that exists is outdated already.
121 .\"O .\" There are better sources of
122 .\"O .\" information for kernel developers.
123 .\" .B 9 ¥«¡¼¥Í¥ë¥ë¡¼¥Á¥ó
124 .\" ¤³¤Î¥Þ¥Ë¥å¥¢¥ë¥»¥¯¥·¥ç¥ó¤ÏÇѻߤµ¤ì¤¿¡£
125 .\" ¤«¤Ä¤Æ¤Ï¤³¤³¤Ë Linux ¥«¡¼¥Í¥ë¤Î¥É¥­¥å¥á¥ó¥È¤òÃÖ¤¯¤Î¤¬Îɤ¤¤³¤È¤À¤È
126 .\" ¹Í¤¨¤é¤ì¤Æ¤¤¤¿¡£¤·¤«¤·¡¢Ê¸½ñ²½¤µ¤ì¤¿¤â¤Î¤ÏÈó¾ï¤Ë¾¯¤Ê¤¯¡¢
127 .\" ¤Þ¤¿¤½¤ì¤é¤â¤¹¤Ç¤Ë¸Å¤¤¤â¤Î¤È¤Ê¤Ã¤Æ¤·¤Þ¤Ã¤¿¡£
128 .\" ¥«¡¼¥Í¥ë³«È¯¼Ô¤Ë¤È¤Ã¤Æ¡¢¤â¤Ã¤È¤è¤¤¾ðÊ󸻤¬Â¾¤Ë¤¢¤ë¤À¤í¤¦¡£
129 .\"O .SS Macro package
130 .SS ¥Þ¥¯¥í¥Ñ¥Ã¥±¡¼¥¸
131 .\"O New manual pages should be marked up using the
132 .\"O .B groff an.tmac
133 .\"O package described in
134 .\"O .BR man (7).
135 .\"O This choice is mainly for consistency: the vast majority of
136 .\"O existing Linux manual pages are marked up using these macros.
137 ¿·¤·¤¤¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ï
138 .BR man (7)
139 ¤ÇÀâÌÀ¤µ¤ì¤Æ¤¤¤ë
140 .B groff an.tmac
141 ¥Ñ¥Ã¥±¡¼¥¸¤ò»È¤Ã¤Æµ­½Ò¤¹¤Ù¤­¤Ç¤¢¤ë¡£
142 ¤³¤ÎÊý¿Ë¤Ï°ì´ÓÀ­¤Î³ÎÊݤ¬¼ç¤ÊÍýͳ¤Ç¤¢¤ë¡£´û¸¤Î Linux ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸
143 ¤Î°µÅÝŪ¿¿ô¤¬¤³¤ì¤é¤Î¥Þ¥¯¥í¤ò»È¤Ã¤Æµ­½Ò¤µ¤ì¤Æ¤¤¤ë¡£
144 .\"O .SS Conventions for source file layout
145 .SS ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ÎÇÛÃ֤˴ؤ¹¤ë·è¤Þ¤ê»ö
146 .\"O Please limit source code line length to no more than about 75 characters
147 .\"O wherever possible.
148 .\"O This helps avoid line-wrapping in some mail clients when patches are
149 .\"O submitted inline.
150 ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î¥½¡¼¥¹¥³¡¼¥É¤Î 1¹Ô¤ÎŤµ¤Ï
151 ²Äǽ¤Ê¸Â¤ê 75ʸ»ú¤ò±Û¤¨¤Ê¤¤¤è¤¦¤Ë¤·¤Æ¤Û¤·¤¤¡£
152 ¤³¤¦¤¹¤ë¤³¤È¤Ç¡¢¥Ñ¥Ã¥Á¤ò¥á¡¼¥ëËÜʸ¤ËºÜ¤»¤ÆÁ÷¤ë¾ì¹ç¤Ë¡¢
153 ¥á¡¼¥ë¥¯¥é¥¤¥¢¥ó¥È¤Ë¤è¤ë¹ÔÀÞ¤êÊÖ¤·¤ò²óÈò¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
154
155 .\"O New sentences should be started on new lines.
156 .\"O This makes it easier to see the effect of patches,
157 .\"O which often operate at the level of individual sentences.
158 ¿·¤·¤¤Ê¸¤Ï¹ÔƬ¤«¤é³«»Ï¤¹¤ë¡£
159 ¤³¤ì¤Ë¤è¤ê¡¢¥Ñ¥Ã¥Á¤ÎÆâÍƤò³Îǧ¤·¤ä¤¹¤¯¤Ê¤ë¡£
160 ¥Ñ¥Ã¥Á¤Ïʸñ°Ì¤Ç¤¢¤ë¤³¤È¤¬Â¿¤¤¤«¤é¤Ç¤¢¤ë¡£
161 .\"O .SS Title line
162 .SS ¥¿¥¤¥È¥ë¹Ô
163 .\"O The first command in a man page should be a \fBTH\fP command:
164 man ¥Ú¡¼¥¸¤ÎºÇ½é¤Î¹Ô¤Ï \fBTH\fP ¥³¥Þ¥ó¥É¤Ë¤¹¤Ù¤­¤Ç¤¢¤ë¡£
165 .RS
166 .sp
167 .B \&.TH
168 .I "title section date source manual"
169 .sp
170 .RE
171 .\"O where:
172 ¸Ä¡¹¤ÎÀâÌÀ:
173 .RS
174 .TP 10
175 .I title
176 .\"O The title of the man page, written in all caps (e.g.,
177 .\"O .IR MAN-PAGES ).
178 man ¥Ú¡¼¥¸¤Î¥¿¥¤¥È¥ë¡£Á´ÉôÂçʸ»ú¤Çµ­ºÜ¤¹¤ë (Îã:
179 .IR MAN-PAGES )¡£
180 .TP
181 .I section
182 .\"O The section number in which the man page should be placed (e.g.,
183 .\"O .IR 7 ).
184 man ¥Ú¡¼¥¸¤¬Â°¤¹¤ë¥»¥¯¥·¥ç¥óÈÖ¹æ (Îã:
185 .IR 7 )¡£
186 .TP
187 .I date
188 .\"O The date of the last revision \(em remember to change this every time a
189 .\"O change is made to the man page,
190 .\"O since this is the most general way of doing version control.
191 .\"O Dates should be written in the form YYYY-MM-DD.
192 ºÇ¿·¤Î¥ê¥Ó¥¸¥ç¥ó¤ÎÆüÉÕ \(em man ¥Ú¡¼¥¸¤ËÊѹ¹¤ò²Ã¤¨¤¿¤È¤­¤Ë¤Ï
193 ɬ¤º¤³¤ì¤òÊѹ¹¤¹¤ë¤³¤È¡£
194 ¤³¤ì¤¬ºÇ¤â°ìÈÌŪ¤Ê¥Ð¡¼¥¸¥ç¥ó´ÉÍýÊýË¡¤Ç¤¢¤ë¡£
195 ÆüÉդϠYYYY-MM-DD ¤Î·Á¼°¤Çµ­ºÜ¤¹¤Ù¤­¤Ç¤¢¤ë¡£
196 .TP
197 .I source
198 .\"O The source of the command, function, or system call.
199 ¥³¥Þ¥ó¥É¡¢´Ø¿ô¡¢¥·¥¹¥Æ¥à¥³¡¼¥ë¤Î½Ð¼«¡£
200
201 .\"O For those few \fIman-pages\fP pages in Sections 1 and 8,
202 .\"O probably you just want to write
203 .\"O .IR GNU .
204 ¿ô¾¯¤Ê¤¤¥»¥¯¥·¥ç¥ó 1 ¤È 8 ¤Î¥Ú¡¼¥¸¤Î¾ì¹ç¡¢¤ª¤½¤é¤¯Ã±¤Ë
205 .I GNU
206 ¤È¤À¤±½ñ¤¯¤³¤È¤¬Â¿¤¤¤À¤í¤¦¡£
207
208 .\"O For system calls, just write
209 .\"O .IR "Linux" .
210 .\"O (An earlier practice was to write the version number
211 .\"O of the kernel from which the manual page was being written/checked.
212 .\"O However, this was never done consistently, and so was
213 .\"O probably worse than including no version number.
214 .\"O Henceforth, avoid including a version number.)
215 ¥·¥¹¥Æ¥à¥³¡¼¥ë¤Î¾ì¹ç¡¢Ã±¤Ë
216 .I "Linux"
217 ¤È¤À¤±½ñ¤¯¡£
218 (°ÊÁ°¤Î´·½¬¤Ç¤Ï¡¢¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤òµ­ºÜ¤·¤¿/ÆâÍƤò³Îǧ¤·¤¿¥«¡¼¥Í¥ë¤Î
219 ¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤òµ­ºÜ¤·¤Æ¤¤¤¿¡£¤·¤«¤·¡¢¥Ð¡¼¥¸¥ç¥óÈֹ椬¼ÂºÝ¤ÎÆâÍƤÈ
220 °ìÃפ·¤Æ¤¤¤ë¤³¤È¤Ï¤Ê¤¯¡¢¤½¤Î¤¿¤á¥Ð¡¼¥¸¥ç¥óÈֹ椬¤Ê¤¤¤è¤ê¤â
221 ¤ª¤½¤é¤¯°­¤¤·Á¤Ë¤Ê¤Ã¤Æ¤¤¤¿¡£
222 º£¸å¤Ï¡¢¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤ò´Þ¤á¤ë¤Î¤ÏÈò¤±¤ë¤³¤È¡£)
223
224 .\"O For library calls that are part of glibc or one of the
225 .\"O other common GNU libraries, just use
226 .\"O .IR "GNU C Library" ", " GNU ,
227 .\"O or an empty string.
228 glibc ¤Î¥é¥¤¥Ö¥é¥ê¥³¡¼¥ë¤ä
229 ¤½¤Î¾¤Î°ìÈÌŪ¤Ê GNU ¥é¥¤¥Ö¥é¥ê¤Î¥é¥¤¥Ö¥é¥ê¥³¡¼¥ë¤Î¾ì¹ç¡¢
230 ñ¤Ë
231 .IR "GNU C Library" ", " GNU
232 ¤È½ñ¤¯¤«¡¢¶õ¤Îʸ»úÎó¤ò»È¤¦¡£
233
234 .\"O For Section 4 pages, use
235 .\"O .IR "Linux" .
236 ¥»¥¯¥·¥ç¥ó 4 ¤Î¥Ú¡¼¥¸¤Ç¤Ï
237 .I "Linux"
238 ¤ò»È¤¦¡£
239
240 .\"O In cases of doubt, just write
241 .\"O .IR Linux ", or " GNU .
242 ¤è¤¯¤ï¤«¤é¤Ê¤¤¾ì¹ç¤Ï¡¢
243 .I Linux
244 ¤È¤«
245 .I GNU
246 ¤È½ñ¤¤¤Æ¤ª¤¯¡£
247 .TP
248 .I manual
249 .\"O The title of the manual (e.g., for Section 2 and 3 pages in
250 .\"O the \fIman-pages\fP package, use
251 .\"O .IR "Linux Programmer's Manual" ).
252 ¥Þ¥Ë¥å¥¢¥ë¤Î¥¿¥¤¥È¥ë (Îã:
253 \fIman-pages\fP ¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥¯¥·¥ç¥ó 2 ¤ª¤è¤Ó 3 ¤Î¥Ú¡¼¥¸¤Î¾ì¹ç¤Ë¤Ï¡¢
254 .I "Linux Programmer's Manual"
255 ¤ò»È¤¦¤³¤È)¡£
256 .RE
257 .\"O .SS Sections within a manual page
258 .SS ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î¥»¥¯¥·¥ç¥ó
259 .\"O The list below shows conventional or suggested sections.
260 .\"O Most manual pages should include at least the
261 .\"O .B highlighted
262 .\"O sections.
263 .\"O Arrange a new manual page so that sections
264 .\"O are placed in the order shown in the list.
265 ÀΤ«¤é»È¤ï¤ì¤Æ¤­¤¿¥»¥¯¥·¥ç¥ó̾¤ò°Ê²¼¤Î¥ê¥¹¥È¤Ë¼¨¤¹¡£
266 ¤³¤ì¤é¤ò»È¤¦¤ÈÎɤ¤¤À¤í¤¦¡£
267 °ìÈÌŪ¤Ë¡¢¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ï¡¢¾¯¤Ê¤¯¤È¤â
268 .B ¿§¤Ä¤­
269 ¤Î¥»¥¯¥·¥ç¥ó¤ò»ý¤Ä¤Î¤¬Ë¾¤Þ¤·¤¤¡£
270 ¿·¤·¤¯¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤òºîÀ®¤¹¤ëºÝ¤Ë¤Ï¡¢¤À¤¤¤¿¤¤°Ê²¼¤Î¥ê¥¹¥È¤Ë¼¨¤·¤¿
271 ½ç½ø¤Ç¥»¥¯¥·¥ç¥ó¤òÇÛÃÖ¤¹¤ë¤è¤¦¤Ë¤·¤Æ¤â¤é¤¤¤¿¤¤¡£
272 .in +0.5i
273 .nf
274
275 .\"O \fBNAME\fP
276 \fB̾Á°\fP
277 .\"O \fBSYNOPSIS\fP
278 \fB½ñ¼°\fP
279 .\"O CONFIGURATION      [Normally only in Section 4]
280 ÀßÄê               [Ä̾ï¤Ï¥»¥¯¥·¥ç¥ó 4 ¤Î¤ß]
281 .\"O \fBDESCRIPTION\fP
282 \fBÀâÌÀ\fP
283 .\"O OPTIONS            [Normally only in Sections 1, 8]
284 ¥ª¥×¥·¥ç¥ó         [Ä̾ï¤Ï¥»¥¯¥·¥ç¥ó 1, 8 ¤Î¤ß]
285 .\"O EXIT STATUS        [Normally only in Sections 1, 8]
286 ½ªÎ»¥¹¥Æ¡¼¥¿¥¹     [Ä̾ï¤Ï¥»¥¯¥·¥ç¥ó 1, 8 ¤Î¤ß]
287 .\"O RETURN VALUE       [Normally only in Sections 2, 3]
288 ÊÖ¤êÃÍ             [Ä̾ï¤Ï¥»¥¯¥·¥ç¥ó 2, 3 ¤Î¤ß]
289 .\" May 07: Few current man pages have an ERROR HANDLING section,,,
290 .\"O .\" ERROR HANDLING,
291 .\" ¥¨¥é¡¼½èÍý
292 .\"O ERRORS             [Typically only in Sections 2, 3]
293 ¥¨¥é¡¼             [¤¿¤¤¤Æ¤¤¤Ï¥»¥¯¥·¥ç¥ó 2, 3 ¤Î¤ß]
294 .\" May 07: Almost no current man pages have a USAGE section,,,
295 .\"O .\" USAGE,
296 .\" ÍøÍÑË¡
297 .\"O .\" DIAGNOSTICS,
298 .\" ¿ÇÃÇ¥á¥Ã¥»¡¼¥¸
299 .\" May 07: Almost no current man pages have a SECURITY section,,,
300 .\"O .\" SECURITY,
301 .\" ¥»¥­¥å¥ê¥Æ¥£
302 .\"O ENVIRONMENT
303 ´Ä¶­ÊÑ¿ô
304 .\"O FILES
305 ¥Õ¥¡¥¤¥ë
306 .\"O VERSIONS           [Normally only in Sections 2, 3]
307 ¥Ð¡¼¥¸¥ç¥ó         [Ä̾ï¤Ï¥»¥¯¥·¥ç¥ó 2, 3 ¤Î¤ß]
308 .\"O CONFORMING TO
309 ½àµò
310 .\"O NOTES
311 Ãí°Õ/È÷¹Í
312 .\"O BUGS
313 ¥Ð¥°
314 .\"O EXAMPLE
315 Îã
316 .\"O .\" AUTHORS sections are discouraged
317 .\"O .\" AUTHORS             [Discouraged]
318 .\" Ãø¼Ô ¥»¥¯¥·¥ç¥ó¤ÏÈó¿ä¾©¤Ç¤¢¤ë
319 .\" Ãø¼Ô
320 .\"O \fBSEE ALSO\fP
321 \fB´ØÏ¢¹àÌÜ\fP
322
323 .fi
324 .in
325 .\"O .IR "Where a traditional heading would apply" ", " "please use it" ;
326 .\"O this kind of consistency can make the information easier to understand.
327 .\"O If you must, you can create your own
328 .\"O headings if they make things easier to understand (this can
329 .\"O be especially useful for pages in Sections 4 and 5).
330 .\"O However, before doing this, consider whether you could use the
331 .\"O traditional headings, with some subsections (\fI.SS\fP) within
332 .\"O those sections.
333 ¡ÖÅÁÅýŪ¤Ë»È¤ï¤ì¤Æ¤­¤¿¸«½Ð¤·¤¬»È¤¨¤ë¾ì¹ç¤Ë¤Ï¡¢¤½¤ì¤ò»È¤Ã¤Æ¤Û¤·¤¤¡£¡×
334 ¤³¤Î¼ï¤Î°ì´ÓÀ­¤òÊݤĤ³¤È¤Ç¡¢¾ðÊó¤òÍý²ò¤·¤ä¤¹¤¯¤Ê¤ë¤«¤é¤Ç¤¢¤ë¡£
335 ¤É¤¦¤·¤Æ¤âɬÍפʾì¹ç¤Ë¤Ï¡¢Íý²ò¤·¤ä¤¹¤¯¤Ê¤ë¤è¤¦¤ËÆȼ«¤Î¸«½Ð¤·¤ò
336 ºî¤Ã¤Æ¤â¤è¤¤ (Æä˥»¥¯¥·¥ç¥ó 4 ¤ä 5 ¤Î¥Ú¡¼¥¸¤Ç¤Ï¤³¤¦¤·¤¿Êý¤¬
337 ¤ï¤«¤ê¤ä¤¹¤¯¤Ê¤ë)¡£¤¿¤À¤·¡¢¤½¤¦¤¹¤ëÁ°¤Ë¡¢ÅÁÅýŪ¤Ê¸«½Ð¤·¤ò»È¤¤¡¢
338 ¤½¤Î¥»¥¯¥·¥ç¥óÆâ¤Ë¥µ¥Ö¥»¥¯¥·¥ç¥ó (\fI.SS\fP) ¤òÀߤ±¤ë¤³¤È¤Ç
339 Âбþ¤Ç¤­¤Ê¤¤¤«¹Í¤¨¤Æ¤Û¤·¤¤¡£
340
341 .\"O The following list elaborates on the contents of each of
342 .\"O the above sections.
343 °Ê²¼¤Î¥ê¥¹¥È¤Ç¤Ï¡¢¾åµ­¤Î¥»¥¯¥·¥ç¥ó¤Î¤½¤ì¤¾¤ì¤ÎÆâÍƤˤĤ¤¤Æ
344 ¾Ü¤·¤¯ÀâÌÀ¤¹¤ë¡£
345 .TP 14
346 .\"O .B NAME
347 .B Ì¾Á° (NAME)
348 .\"O The name of this manual page.
349 .\"O See
350 .\"O .BR man (7)
351 .\"O for important details of the line(s) that should follow the
352 .\"O \fB.SH NAME\fP command.
353 ¤½¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î̾Á°¡£
354 \fB.SH NAME\fP ¥³¥Þ¥ó¥É¤Î¹Ô¤¬½¾¤¦¤Ù¤­Âç»ö¤ÊÅÀ¤Ë¤Ä¤¤¤Æ¤Ï
355 .BR man (7)
356 ¤ò»²¾È¤·¤Æ¤Û¤·¤¤¡£
357 .TP
358 .\"O .B SYNOPSIS
359 .B ½ñ¼° (SYNOPSIS)
360 .\"O briefly describes the command or function's interface.
361 .\"O For commands, this shows the syntax of the command and its arguments
362 .\"O (including options);
363 .\"O boldface is used for as-is text and italics are used to
364 .\"O indicate replaceable arguments.
365 .\"O Brackets ([]) surround optional arguments, vertical bars (|)
366 .\"O separate choices, and ellipses (\&...) can be repeated.
367 .\"O For functions, it shows any required data declarations or
368 .\"O .B #include
369 .\"O directives, followed by the function declaration.
370 ¥³¥Þ¥ó¥É¤ä´Ø¿ô¤Î¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹¤ò´Ê·é¤Ëµ­½Ò¤¹¤ë¡£
371 ¥³¥Þ¥ó¥É¤ËÂФ·¤Æ¤Ï¡¢¥³¥Þ¥ó¥É¤ä°ú¤­¿ô (¥ª¥×¥·¥ç¥ó) ¤Îʸˡ¤ò½ñ¤¯¡£
372 ¤½¤Î¤Þ¤Þ½ñ¤¯¥Æ¥­¥¹¥È¤Ë¤Ï¥Ü¡¼¥ë¥ÉÂΤòÍѤ¤¡¢ÃÖ¤­´¹¤¨¤ë°ú¤­¿ô¤Ë¤Ï
373 ¥¤¥¿¥ê¥Ã¥¯ÂΤòÍѤ¤¤ë¡£¾Êά²Äǽ¤Ê¥ª¥×¥·¥ç¥ó¤Ï¥Ö¥é¥±¥Ã¥È ([]) ¤Ç°Ï¤¤¡¢
374 ÁªÂò»è¤Ï½ÄËÀ (|) ¤Ç¶èÀڤꡢ·«¤êÊÖ¤·¤Ë¤Ï¾ÊάÉä¹æ (...) ¤ò½ñ¤¯¡£
375 ´Ø¿ô¤ËÂФ·¤Æ¤Ï¡¢É¬Íפʥǡ¼¥¿Àë¸À¤ä
376 .B #include
377 »ØÄê¤ò½ñ¤­¡¢´Ø¿ôÀë¸À¤ò³¤±¤ë¡£
378
379 .\"O Where a feature test macro must be defined in order to obtain
380 .\"O the declaration of a function (or a variable) from a header file,
381 .\"O then the SYNOPSIS should indicate this, as described in
382 .\"O .BR feature_test_macros (7).
383 ¥Ø¥Ã¥À¥Õ¥¡¥¤¥ë¤«¤é´Ø¿ô (¤äÊÑ¿ô) ¤ÎÄêµÁ¤òÆÀ¤ë¤¿¤á¤Ë
384 µ¡Ç½¸¡ºº¥Þ¥¯¥í (feature test macro) ¤òÄêµÁ¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¾ì¹ç¡¢
385 ½ñ¼° (SYNOPSIS) ¤ËɬÍפʵ¡Ç½¸¡ºº¥Þ¥¯¥í¤òµ­ºÜ¤¹¤Ù¤­¤Ç¤¢¤ë¡£
386 µ¡Ç½¸¡ºº¥Þ¥¯¥í¤Ë¤Ä¤¤¤Æ¤Ï
387 .BR feature_test_macros (7)
388 ¤ÇÀâÌÀ¤µ¤ì¤Æ¤¤¤ë¡£
389 .\" FIXME . Say something here about compiler options
390 .TP
391 .B CONFIGURATION
392 .\"O Configuration details for a device.
393 .\"O This section normally only appears in Section 4 pages.
394 ¥Ç¥Ð¥¤¥¹¤ÎÀßÄê¾ÜºÙ¡£
395 Ä̾¤³¤Î¥»¥¯¥·¥ç¥ó¤Ï 4 ¾Ï¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ç¤Î¤ßÅо줹¤ë¡£
396 .TP
397 .\"O .B DESCRIPTION
398 .B ÀâÌÀ (DESCRIPTION)
399 .\"O gives an explanation of what the program, function, or format does.
400 .\"O Discuss how it interacts with files and standard input, and what it
401 .\"O produces on standard output or standard error.
402 .\"O Omit internals and implementation details unless they're critical for
403 .\"O understanding the interface.
404 .\"O Describe the usual case;
405 .\"O for information on command-line options of a program use the
406 .\"O .B OPTIONS
407 .\"O section.
408 ¥×¥í¥°¥é¥à¡¦´Ø¿ô¡¦¥Õ¥©¡¼¥Þ¥Ã¥È¤ÎÆ°ºî¡¦ÌÜŪ¤òÀâÌÀ¤¹¤ë¡£
409 ¥Õ¥¡¥¤¥ë¤äɸ½àÆþÎϤò¤É¤Î¤è¤¦¤Ë½èÍý¤·¡¢É¸½à½ÐÎϤäɸ½à¥¨¥é¡¼½ÐÎϤò
410 ¤É¤Î¤è¤¦¤ËÀ¸À®¤¹¤ë¤«¤È¤¤¤Ã¤¿¤³¤È¤Ë¤Ä¤¤¤Æ½Ò¤Ù¤ë¡£
411 ÆâÉôÆ°ºî¤ä¼ÂÁõ¤Î¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¾Êά¤¹¤ë
412 (¤¿¤À¤·¤½¤ì¤¬Æ°ºî¤ÎÍý²ò¤Ë¤É¤¦¤·¤Æ¤âɬÍפʤéÊÌ)¡£
413 Ä̾ï¤Î¾ì¹ç¤Ë¤Ä¤¤¤Æµ­½Ò¤¹¤ë¡£
414 ¥×¥í¥°¥é¥à¤Î¥³¥Þ¥ó¥É¥é¥¤¥ó¡¦¥ª¥×¥·¥ç¥ó¤ÎÀâÌÀ¤Ë¤Ï¡¢
415 .B ¥ª¥×¥·¥ç¥ó
416 ¤Î¥»¥¯¥·¥ç¥ó¤òÍѤ¤¤ë¡£
417 .\"O .\" If there is some kind of input grammar or complex set of subcommands,
418 .\"O .\" consider describing them in a separate
419 .\"O .\" .B USAGE
420 .\"O .\" section (and just place an overview in the
421 .\"O .\" .B DESCRIPTION
422 .\"O .\" section).
423 .\" ÆþÎϤˤ¢¤ë¼ï¤Îʸˡ¤¬¤¢¤Ã¤¿¤ê¡¢Ê£»¨¤Ê¥µ¥Ö¥³¥Þ¥ó¥É¤¬¤¢¤ë¾ì¹ç¤Ï¡¢
424 .\" ¤½¤ì¤é¤Ï
425 .\" .B ÍøÍÑË¡
426 .\" ¤Î¥»¥¯¥·¥ç¥ó¤ËʬΥ¤¹¤ë¤³¤È¤ò¹Í¤¨¤ë¤È¤è¤¤
427 .\" .RB ( ÀâÌÀ
428 .\" ¤Î¥»¥¯¥·¥ç¥ó¤Ë¤Ï³µÍפÀ¤±¤òÃÖ¤¯¤è¤¦¤Ë¤¹¤ë)¡£
429 .TP
430 .\"O .B OPTIONS
431 .B ¥ª¥×¥·¥ç¥ó (OPTIONS)
432 .\"O describes the command-line options accepted by a
433 .\"O program and how they change its behavior.
434 .\"O This section should only appear for Section 1 and 8 manual pages.
435 ¥×¥í¥°¥é¥à¤¬¼õ¤±ÉÕ¤±¤ë¥³¥Þ¥ó¥É¥é¥¤¥ó¡¦¥ª¥×¥·¥ç¥ó¤È¡¢
436 ¤½¤Î¾ì¹ç¥×¥í¥°¥é¥à¤Î¿¶Éñ¤¤¤¬¤É¤¦ÊѤï¤ë¤«¤òÀâÌÀ¤¹¤ë¡£
437 ¤³¤Î¥»¥¯¥·¥ç¥ó¤Ï¥»¥¯¥·¥ç¥ó 1 ¤È 8 ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë¤À¤±Åо줹¤Ù¤­¤Ç¤¢¤ë¡£
438 .\" .TP
439 .\"O .\" .B USAGE
440 .\" .B ÍøÍÑË¡ (USAGE)
441 .\"O .\" describes the grammar of any sublanguage this implements.
442 .\" ¥³¥Þ¥ó¥É¤Ê¤É¤¬¼ÂÁõ¤·¤Æ¤¤¤ëÉû¸À¸ì (sublanguage) ¤Îʸˡ¤òµ­½Ò¤¹¤ë¡£
443 .TP
444 .\"O .B EXIT STATUS
445 .B ½ªÎ»¥¹¥Æ¡¼¥¿¥¹ (EXIT STATUS)
446 .\"O lists the possible exit status values of a program and
447 .\"O the conditions that cause these values to be returned.
448 .\"O This section should only appear for Section 1 and 8 manual pages.
449 ¥×¥í¥°¥é¥à¤Î½ªÎ»¥¹¥Æ¡¼¥¿¥¹¤ÎÃͤȡ¢¤½¤ì¤é¤ÎÃͤËÂбþ¤¹¤ë¾õ¶·¤òÎóµó¤¹¤ë¡£
450 ¤³¤Î¥»¥¯¥·¥ç¥ó¤Ï¥»¥¯¥·¥ç¥ó 1 ¤È 8 ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë¤À¤±Åо줹¤Ù¤­¤Ç¤¢¤ë¡£
451 .TP
452 .\"O .B RETURN VALUE
453 .B ÊÖ¤êÃÍ (RETURN VALUE)
454 .\"O For Section 2 and 3 pages, this section gives a
455 .\"O list of the values the library routine will return to the caller
456 .\"O and the conditions that cause these values to be returned.
457 ¥»¥¯¥·¥ç¥ó 2 ¤È 3 ¤Î¥Ú¡¼¥¸¤Î¾ì¹ç¡¢¤³¤Î¥»¥¯¥·¥ç¥ó¤Ë
458 ¥é¥¤¥Ö¥é¥ê¥ë¡¼¥Á¥ó¤¬¸Æ¤Ó½Ð¤·¸µ¤ËÊÖ¤¹ÃͤΥꥹ¥È¤òµ­ºÜ¤¹¤ë¡£
459 ¤½¤ì¤é¤ÎÃͤ¬ÊÖ¤µ¤ì¤¿¾ì¹ç¤Î¾õÂÖ¤ËÂФ¹¤ëÀâÌÀ¤â½ñ¤¯¡£
460 .TP
461 .\"O .B ERRORS
462 .B ¥¨¥é¡¼ (ERRORS)
463 .\"O For Section 2 and 3 manual pages, this is a list of the
464 .\"O values that may be placed in
465 .\"O .I errno
466 .\"O in the event of an error, along with information about the cause
467 .\"O of the errors.
468 .\"O .IR "The error list should be in alphabetical order" .
469 ¥»¥¯¥·¥ç¥ó 2 ¤È 3 ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ç¤Ï¡¢
470 ¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç¤Ë
471 .I errno
472 ¤ËÀßÄꤵ¤ì¤ë²ÄǽÀ­¤¬¤¢¤ëÃͤΥꥹ¥È¤òµ­ºÜ¤¹¤ë¡£
473 ¥ê¥¹¥È¤Ë¤Ï¡¢¥¨¥é¡¼¤ÎÃͤȥ¨¥é¡¼¤Î¸¶°ø¤Ë¤Ä¤¤¤Æ¤Î¾ðÊó¤ò½ñ¤¯¡£
474 ¡Ö¥¨¥é¡¼¥ê¥¹¥È¤Ï¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È½ç¤Ë¤¹¤Ù¤­¤Ç¤¢¤ë¡£¡×
475 .TP
476 .\"O .B ENVIRONMENT
477 .B ´Ä¶­ÊÑ¿ô (ENVIRONMENT)
478 .\"O lists all environment variables that affect the program or function
479 .\"O and how they affect it.
480 ¥×¥í¥°¥é¥à¤ä´Ø¿ô¤Ë±Æ¶Á¤¹¤ë´Ä¶­ÊÑ¿ô¤ò¥ê¥¹¥È¤·¡¢¤½¤ì¤é¤Î¸ú²Ì¤ò½ñ¤¯¡£
481 .TP
482 .\"O .B FILES
483 .B ¥Õ¥¡¥¤¥ë (FILES)
484 .\"O lists the files the program or function uses, such as
485 .\"O configuration files, startup files,
486 .\"O and files the program directly operates on.
487 .\"O Give the full pathname of these files, and use the installation
488 .\"O process to modify the directory part to match user preferences.
489 .\"O For many programs, the default installation location is in
490 .\"O .IR /usr/local ,
491 .\"O so your base manual page should use
492 .\"O .I /usr/local
493 .\"O as the base.
494 ¥×¥í¥°¥é¥à¤ä´Ø¿ô¤¬ÍѤ¤¤ë¥Õ¥¡¥¤¥ë¤òÎóµ­¤¹¤ë¡£
495 Î㤨¤Ð¡¢ÀßÄê¥Õ¥¡¥¤¥ë¡¢µ¯Æ°¥Õ¥¡¥¤¥ë¡¢¥×¥í¥°¥é¥à¤¬Ä¾ÀÜÁàºî¤¹¤ë¥Õ¥¡¥¤¥ë¤Ê¤É¤Ç¤¢¤ë¡£
496 ¤³¤ì¤é¤Î¥Õ¥¡¥¤¥ë¤Î¥Õ¥¡¥¤¥ë̾¤Ï¥Õ¥ë¥Ñ¥¹¤Çµ­ºÜ¤·¡¢
497 ¥Ç¥£¥ì¥¯¥È¥ê¤ÎÉôʬ¤Ï¥æ¡¼¥¶¡¼¤Î¹¥¤ß¤Ë¹ç¤ï¤»¤Æ
498 ¥¤¥ó¥¹¥È¡¼¥ë½èÍý¤ÇÊѹ¹¤Ç¤­¤ë¤è¤¦¤Ë¤¹¤ë¡£
499 ¿¤¯¤Î¥×¥í¥°¥é¥à¤Ç¤Ï¥Ç¥Õ¥©¥ë¥È¤Î¥¤¥ó¥¹¥È¡¼¥ëÀè¤Ï
500 .I /usr/local
501 ¤Ç¤¢¤ë¡£¤·¤¿¤¬¤Ã¤Æ¥Ù¡¼¥¹¤È¤Ê¤ë¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ç¤â
502 .I /usr/local
503 ¤¬»È¤ï¤ì¤Æ¤¤¤ë¤³¤È¤¬Â¿¤¤¤À¤í¤¦¡£
504 .\" May 07: Almost no current man pages have a DIAGNOSTICS section;
505 .\"         "RETURN VALUE" or "EXIT STATUS" is preferred.
506 .\" .TP
507 .\"O .\" .B DIAGNOSTICS
508 .\" .B ¿ÇÃÇ¥á¥Ã¥»¡¼¥¸ (DIAGNOSTICS)
509 .\"O .\" gives an overview of the most common error messages and how to
510 .\"O .\" cope with them.
511 .\"O .\" You don't need to explain system error messages
512 .\"O .\" or fatal signals that can appear during execution of any program
513 .\"O .\" unless they're special in some way to the program.
514 .\" ¤´¤¯°ìÈÌŪ¤Ê¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤Î³µÍפȡ¢
515 .\" ¤½¤ì¤é¤ò¤É¤¦°·¤¦¤«¤Ë¤Ä¤¤¤Æ½Ò¤Ù¤ë¡£¥×¥í¥°¥é¥à¤Î¼Â¹Ô»þ¤Ë¸½¤ì¤ë
516 .\" ¥·¥¹¥Æ¥à¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤äÃ×̿Ū¥·¥°¥Ê¥ë¤òÁ´ÉôÀâÌÀ¤¹¤ëɬÍפϤʤ¤¡£
517 .\" ¤¿¤À¤·¤½¤ì¤é¤¬¥×¥í¥°¥é¥à¤ËÂФ·¤Æ
518 .\" ²¿¤é¤«¤ÎÆüì¤Ê°ÕÌ£¤ò»ý¤Ã¤Æ¤¤¤ë¾ì¹ç¤ÏÊ̤Ǥ¢¤ë¡£
519 .\"
520 .\" May 07: Almost no current man pages have a SECURITY section.
521 .\".TP
522 .\"O .\".B SECURITY
523 .\" .B ¥»¥­¥å¥ê¥Æ¥£ (SECURITY)
524 .\"O .\"discusses security issues and implications.
525 .\"O .\"Warn about configurations or environments that should be avoided,
526 .\"O .\"commands that may have security implications, and so on, especially
527 .\"O .\"if they aren't obvious.
528 .\"O .\"Discussing security in a separate section isn't necessary;
529 .\"O .\"if it's easier to understand, place security information in the
530 .\"O .\"other sections (such as the
531 .\"O .\" .B DESCRIPTION
532 .\"O .\" or
533 .\"O .\" .B USAGE
534 .\"O .\" section).
535 .\"O .\" However, please include security information somewhere!
536 .\" ¥»¥­¥å¥ê¥Æ¥£´ØÏ¢¤ÎÏÃÂꡦÌäÂê¤Ë¤Ä¤¤¤Æ½Ò¤Ù¤ë¡£
537 .\" Èò¤±¤ë¤Ù¤­ÀßÄê¤ä´Ä¶­¡¦¥»¥­¥å¥ê¥Æ¥£¾å¤ÎÌäÂê¤ò°ú¤­µ¯¤³¤¹¥³¥Þ¥ó¥É
538 .\" ¤Ê¤É¤Ë¤Ä¤¤¤Æ·Ù¹ð¤¹¤ë¡£¤½¤ì¤é¤¬ÌÀ¤é¤«¤Ç¤Ê¤¤¾ì¹ç¤Ë¤Ï¡¢¤³¤ì¤ÏÆä˽ÅÍפǤ¢¤ë¡£
539 .\" ¥»¥­¥å¥ê¥Æ¥£¤Ë´Ø¤¹¤ëÏÃÂê¤Ï¡¢É¬¤º¤·¤âÆÈΩ¤·¤¿¥»¥¯¥·¥ç¥ó¤Ë¤¹¤ëɬÍפϤʤ¤¡£
540 .\" ¤â¤·Íý²ò¤·¤ä¤¹¤±¤ì¤Ð¡¢¥»¥­¥å¥ê¥Æ¥£¤Î¾ðÊó¤Ï¾¤Î¥»¥¯¥·¥ç¥ó
541 .\" (Î㤨¤Ð
542 .\" .B ÀâÌÀ
543 .\" ¤ä
544 .\" .B ÍøÍÑË¡
545 .\" ¤Ê¤É) ¤Ë½ñ¤¤¤Æ¤â¤è¤¤¡£
546 .\" ¤·¤«¤·¡¢¥»¥­¥å¥ê¥Æ¥£¤Î¾ðÊó¤Ï¤É¤³¤«¤Ë¤Ï½ñ¤¤¤Æ¤ª¤¤¤Æ¤Û¤·¤¤!
547 .TP
548 .\"O .B VERSIONS
549 .B ¥Ð¡¼¥¸¥ç¥ó (VERSIONS)
550 .\"O A brief summary of the Linux kernel or glibc versions where a
551 .\"O system call or library function appeared,
552 .\"O or changed significantly in its operation.
553 ¥·¥¹¥Æ¥à¥³¡¼¥ë¤ä¥é¥¤¥Ö¥é¥ê´Ø¿ô¤¬Åо줷¤¿¤ê¡¢Æ°ºî¤Î½ÅÍפÊÊѹ¹¤¬¹Ô¤ï¤ì¤¿¡¢
554 Linux ¥«¡¼¥Í¥ë¤ä glibc ¤Î¥Ð¡¼¥¸¥ç¥ó¤Ë¤Ä¤¤¤Æ¤Î´Ê·é¤Ê³µÍס£
555 .\"O As a general rule, every new interface should
556 .\"O include a VERSIONS section in its manual page.
557 .\"O Unfortunately,
558 .\"O many existing manual pages don't include this information
559 .\"O (since there was no policy to do so when they were written).
560 .\"O Patches to remedy this are welcome,
561 .\"O but, from the perspective of programmers writing new code,
562 .\"O this information probably only matters in the case of kernel
563 .\"O interfaces that have been added in Linux 2.4 or later
564 .\"O (i.e., changes since kernel 2.2),
565 .\"O and library functions that have been added to glibc since version 2.1
566 .\"O (i.e., changes since glibc 2.0).
567 °ìÈ̤ˡ¢Á´¤Æ¤Î¿·¤·¤¤¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹¤Ï¡¢¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë
568 ¡Ö¥Ð¡¼¥¸¥ç¥ó¡×¤ÎÀá¤òÀߤ±¤ë¤Ù¤­¤Ç¤¢¤ë¡£
569 »ÄÇ°¤Ê¤³¤È¤Ë¡¢Â¿¤¯¤Î´û¸¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë¤³¤Î¾ðÊó¤Ï´Þ¤Þ¤ì¤Æ¤¤¤Ê¤¤
570 (¤³¤ì¤é¤Î¥Ú¡¼¥¸¤¬½ñ¤«¤ì¤¿»þÅÀ¤Ç¤Ï¤½¤Î¤è¤¦¤Ê¥Ý¥ê¥·¡¼¤Ï¤Ê¤«¤Ã¤¿¤«¤é¤Ç¤¢¤ë)¡£
571 ¤³¤ì¤ò²þÁ±¤¹¤ë¥Ñ¥Ã¥Á¤Ï´¿·Þ¤µ¤ì¤ë¤¬¡¢
572 ¿·¤·¤¤¥³¡¼¥É¤ò½ñ¤¯¥×¥í¥°¥é¥Þ¤Î´ÑÅÀ¤«¤é¤¹¤ì¤Ð¡¢
573 ¤ª¤½¤é¤¯¤³¤Î¾ðÊ󤬽ÅÍפˤʤë¤Î¤Ï¡¢
574 Linux 2.4 °Ê¹ß¤ÇÄɲ䵤줿¥«¡¼¥Í¥ë¥¤¥ó¥¿¡¼¥Õ¥§¥¤¥¹ (¥«¡¼¥Í¥ë 2.2 ¤«¤é¤ÎÊѹ¹) ¤È
575 glibc ¥Ð¡¼¥¸¥ç¥ó 2.1 °Ê¹ß¤ÇÄɲ䵤줿¥é¥¤¥Ö¥é¥ê´Ø¿ô (glibc 2.0 ¤«¤é¤ÎÊѹ¹)
576 ¤Ë¤Ä¤¤¤Æ¤Î¤ß¤Ç¤¢¤í¤¦¡£
577
578 .\"O The
579 .\"O .BR syscalls (2)
580 .\"O manual page also provides information about kernel versions
581 .\"O in which various system calls first appeared.
582 .BR syscalls (2)
583 ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë¤â¡¢¤¤¤í¤¤¤í¤Ê¥·¥¹¥Æ¥à¥³¡¼¥ë¤¬½é¤á¤ÆÅо줷¤¿
584 ¥«¡¼¥Í¥ë¥Ð¡¼¥¸¥ç¥ó¤Ë¤Ä¤¤¤Æ¤Î¾ðÊ󤬽ñ¤«¤ì¤Æ¤¤¤ë¡£
585 .TP
586 .\"O .B CONFORMING TO
587 .B ½àµò (CONFORMING TO)
588 .\"O describes any standards or conventions that relate to the function
589 .\"O or command described by the manual page.
590 .\"O For a page in Section 2 or 3,
591 .\"O this section should note the POSIX.1
592 .\"O version(s) that the call conforms to,
593 .\"O and also whether the call is specified in C99.
594 .\"O (Don't worry too much about other standards like SUS, SUSv2, and XPG,
595 .\"O or the SVr4 and 4.xBSD implementation standards,
596 .\"O unless the call was specified in those standards,
597 .\"O but isn't in the current version of POSIX.1.)
598 .\"O (See
599 .\"O .BR standards (7).)
600 ¤½¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ÇÀâÌÀ¤·¤Æ¤¤¤ë´Ø¿ô¤ä¥³¥Þ¥ó¥É¤Ë´ØÏ¢¤¹¤ë
601 ɸ½àµ¬³Ê¤ä´·½¬¤Ë¤Ä¤¤¤Æµ­ºÜ¤¹¤ë¡£
602 ¥»¥¯¥·¥ç¥ó 2 ¤ä 3 ¤Î¥Ú¡¼¥¸¤Ç¤Ï¡¢¤³¤Î¥»¥¯¥·¥ç¥ó¤Ç
603 ¥·¥¹¥Æ¥à¥³¡¼¥ë¤ä´Ø¿ô¤¬½àµò¤¹¤ë POSIX.1 ¤Î¥Ð¡¼¥¸¥ç¥ó¤È¡¢
604 C99 ¤Çµ¬Äꤵ¤ì¤Æ¤¤¤ë¤«¤Ë¿¨¤ì¤ë¤Ù¤­¤Ç¤¢¤ë¡£
605 (SUS, SUSv2, XPG ¤Ê¤É¤Î¾¤Îɸ½àµ¬³Ê¤ä¡¢SVr4 ¤ä 4.xBSD ¤Î¼ÂÁõɸ½à¤Ë
606 ¤Ä¤¤¤Æ¤Ï¡¢ÀâÌÀ¤·¤Æ¤¤¤ë¥³¡¼¥ë¤¬¤³¤ì¤é¤Îµ¬³Ê¤Çµ¬Äꤵ¤ì¤Æ¤ª¤ê
607 POSIX.1 ¤Î¸½¹Ô¥Ð¡¼¥¸¥ç¥ó¤Çµ¬Äꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç°Ê³°¤Ï¡¢
608 ¤¢¤Þ¤ê¿¼¤¯µ¤¤Ë¤¹¤ëɬÍפϤʤ¤¡£)
609 .RB ( standards (7)
610 »²¾È¡£)
611
612 .\"O If the call is not governed by any standards but commonly
613 .\"O exists on other systems, note them.
614 .\"O If the call is Linux-specific, note this.
615 ¤½¤Î¥³¡¼¥ë¤¬¤É¤Îɸ½à¤Ë¤â´ð¤Å¤¤¤Æ¤¤¤Ê¤¤¤¬¡¢
616 ¾¤Î¥·¥¹¥Æ¥à¤Ç¹­¤¯Â¸ºß¤¹¤ë¾ì¹ç¤Ï¡¢¤½¤Î»Ý¤òµ­ºÜ¤¹¤ë¤³¤È¡£
617 ¤½¤Î¥³¡¼¥ë¤¬ Linux ¸ÇÍ­¤Î¾ì¹ç¤Ï¡¢¤½¤Î»Ý¤òµ­ºÜ¤¹¤ë¤³¤È¡£
618
619 .\"O If this section consists of just a list of standards
620 .\"O (which it commonly does),
621 .\"O terminate the list with a period (\(aq.\(aq).
622 (¤½¤¦¤Ê¤Ã¤Æ¤¤¤ë¥Ú¡¼¥¸¤¬Â¿¤¤¤¬) ¤³¤Î¥»¥¯¥·¥ç¥ó¤ÎÆâÍƤ¬É¸½à¤Î¥ê¥¹¥È
623 ¤À¤±¤Î¾ì¹ç¡¢¥ê¥¹¥È¤ÎºÇ¸å¤Ë¥Ô¥ê¥ª¥É (\(aq.\(aq) ¤òÃÖ¤¯¤³¤È¡£
624 .TP
625 .\"O .B NOTES
626 .B Ãí°Õ (NOTES)
627 .\"O provides miscellaneous notes.
628 .\"O For Section 2 and 3 man pages you may find it useful to include
629 .\"O subsections (\fBSS\fP) named \fILinux Notes\fP and \fIGlibc Notes\fP.
630 ¤½¤Î¾¤ÎÃí°ÕÅÀ¤ò½ñ¤¯¡£
631 ¥»¥¯¥·¥ç¥ó 2 ¤È 3 ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ç¤Ï¡¢
632 \fILinux ¤Ç¤ÎÃí°Õ (Linux Notes)\fP ¤ä \fIglibc ¤Ç¤ÎÃí°Õ (Glibc Notes)\fP
633 ¤È¤¤¤¦Ì¾Á°¤Î¥µ¥Ö¥»¥¯¥·¥ç¥ó (\fBSS\fP) ¤òÀߤ±¤ë¤ÈÊØÍø¤Ê¤³¤È¤â¤¢¤ë¡£
634 .TP
635 .\"O .B BUGS
636 .B ¥Ð¥° (BUGS)
637 .\"O lists limitations, known defects or inconveniences,
638 .\"O and other questionable activities.
639 À©¸Â¡¦ÃΤé¤ì¤Æ¤¤¤ë·ç´Ù¤äÉÔÊؤÊÅÀ¡¢¤½¤Î¾ÉԻ׵ĤÊÆ°ºî¤Ê¤É¤ò½ñ¤¯¡£
640 .TP
641 .\"O .B EXAMPLE
642 .B Îã (EXAMPLE)
643 .\"O provides one or more examples describing how this function, file or
644 .\"O command is used.
645 .\"O For details on writing example programs,
646 .\"O see \fIExample Programs\fP below.
647 ¤³¤Î´Ø¿ô¡¦¥Õ¥¡¥¤¥ë¡¦¥³¥Þ¥ó¥É¤ò¤É¤Î¤è¤¦¤Ë»È¤¦¤«¤ò¼¨¤·¤¿
648 ¤Ò¤È¤Ä¤Þ¤¿¤ÏÊ£¿ô¤ÎÎã¤òµ­½Ò¤¹¤ë¡£
649 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤ò½ñ¤¯ºÝ¤Î¾ÜºÙ¤Ï
650 °Ê²¼¤Î¡Ö¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¡×¤ÎÀá¤ò»²¾È¤Î¤³¤È¡£
651 .TP
652 .\"O .B AUTHORS
653 .B Ãø¼Ô (AUTHORS)
654 .\"O lists authors of the documentation or program.
655 ʸ½ñ¤Þ¤¿¤Ï¥×¥í¥°¥é¥à¤ÎÃø¼Ô¤òÎóµ­¤¹¤ë¡£
656 .\"O \fBUse of an AUTHORS section is strongly discouraged\fP.
657 .B Ãø¼Ô¥»¥¯¥·¥ç¥ó¤Ï¶ËÎÏ»ÈÍѤ·¤Ê¤¤¤³¤È¡£
658 .\"O Generally, it is better not to clutter every page with a list
659 .\"O of (over time potentially numerous) authors;
660 .\"O if you write or significantly amend a page,
661 .\"O add a copyright notice as a comment in the source file.
662 °ìÈÌŪ¤Ë¤Ï¡¢Ãø¼Ô¤Î¥ê¥¹¥È¤ò³Æ¥Ú¡¼¥¸¤Ë»µ¤­»¶¤é¤µ¤Ê¤¤Êý¤¬¤è¤¤
663 (»þ´Ö¤¬¤¿¤Ä¤È¡¢ºî¼Ô¤Î¥ê¥¹¥È¤ÏËÄÂç¤Ë¤Ê¤ë²ÄǽÀ­¤¬¤¢¤ë)¡£
664 ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ò¿·µ¬¤Ë½ñ¤¤¤¿¤ê¡¢ÂçÉý¤Ë½¤Àµ¤ò¹Ô¤Ã¤¿¾ì¹ç¤Ë¤Ï¡¢
665 ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ë¥³¥á¥ó¥È¤È¤·¤ÆÃøºî¸¢É½¼¨¤òÄɲ乤뤳¤È¡£
666 .\"O If you are the author of a device driver and what to include
667 .\"O an address for reporting bugs, place this under the BUGS section.
668 ¤¢¤Ê¤¿¤¬¥Ç¥Ð¥¤¥¹¥É¥é¥¤¥Ð¤Îºî¼Ô¤Ç¡¢¥Ð¥°¤òÊó¹ð¤¹¤ë¤¿¤á¤Î¥¢¥É¥ì¥¹¤ò
669 ºÜ¤»¤¿¤¤¾ì¹ç¤Ï¡¢¡Ö¥Ð¥°¡×¥»¥¯¥·¥ç¥ó¤Î¸å¤í¤Ë¤³¤Î¥»¥¯¥·¥ç¥ó¤òÇÛÃÖ¤¹¤ë¤³¤È¡£
670 .TP
671 .\"O .B SEE ALSO
672 .B ´ØÏ¢¹àÌÜ (SEE ALSO)
673 .\"O provides a comma-separated list of related man pages,
674 .\"O ordered by section number and
675 .\"O then alphabetically by name, possibly followed by
676 .\"O other related pages or documents.
677 .\"O Do not terminate this with a period.
678 ´ØÏ¢¤¹¤ë¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ò¡¢¥³¥ó¥Þ¶èÀÚ¤ê¤Î¥ê¥¹¥È¤Ç¡¢
679 ¥»¥¯¥·¥ç¥óÈÖ¹æ½ç¤Ë¡¢¥»¥¯¥·¥ç¥óÆâ¤Ç¤Ï¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È½ç¤Çµ­ºÜ¤¹¤ë¡£
680 ²Äǽ¤Ê¤é´ØÏ¢¤¹¤ë¾¤Îʸ½ñ¤â½ñ¤¯¡£
681 ´·½¬¤Ç¤Ï¡¢¤³¤Î¥»¥¯¥·¥ç¥ó¤ÏºÇ¸å¤ËÃÖ¤¯¡£
682 ¥ê¥¹¥È¤ÎËöÈø¤Ë¥Ô¥ê¥ª¥É¤òÃÖ¤«¤Ê¤¤¤³¤È¡£
683 .\"O .SS Font conventions
684 .SS ¥Õ¥©¥ó¥È¤Î´·½¬
685 .PP
686 .\"O For functions, the arguments are always specified using italics,
687 .\"O .IR "even in the SYNOPSIS section" ,
688 .\"O where the rest of the function is specified in bold:
689 ´Ø¿ô¤ËÂФ·¤Æ¤Ï¡¢°ú¤­¿ô¤Ë¤Ï¾ï¤Ë¥¤¥¿¥ê¥Ã¥¯ÂΤòÍѤ¤¤ë¡£
690 ¡Ö¤¿¤È¤¨½ñ¼° (SYNOPSIS) ¥»¥¯¥·¥ç¥ó¤Ç¤¢¤Ã¤Æ¤â¡¢¤³¤Î¥ë¡¼¥ë¤Ë½¾¤¦¡×
691 ´Ø¿ô¤Î¾¤ÎÉôʬ¤Ï¥Ü¡¼¥ë¥É¤ò»ØÄꤹ¤ë:
692 .PP
693 .BI "    int myfunction(int " argc ", char **" argv );
694 .PP
695 .\"O Variable names should, like argument names, be specified in italics.
696 °ú¤­¿ô̾¤È¤¤¤Ã¤¿ÊÑ¿ô̾¤Ï¥¤¥¿¥ê¥Ã¥¯ÂΤò»ØÄꤹ¤Ù¤­¤Ç¤¢¤ë¡£
697 .PP
698 .\"O Filenames (whether pathnames, or references to files in the
699 .\"O .I /usr/include
700 .\"O directory)
701 .\"O are always in italics (e.g.,
702 .\"O .IR <stdio.h> ),
703 .\"O except in the SYNOPSIS section, where included files are in bold (e.g.,
704 .\"O .BR "#include <stdio.h>" ).
705 ¥Õ¥¡¥¤¥ë̾ (¥Ñ¥¹Ì¾¡¢¤Þ¤¿¤Ï
706 .I /usr/include
707 ¥Ç¥£¥ì¥¯¥È¥êÆâ¤Î¥Õ¥¡¥¤¥ë¤Ø¤Î»²¾È) ¤Ï¾ï¤Ë¥¤¥¿¥ê¥Ã¥¯ÂΤˤ¹¤ë (Îã:
708 .IR <stdio.h> )¡£
709 ¤¿¤À¤·¡¢½ñ¼° (SYNOPSIS) ¥»¥¯¥·¥ç¥ó¤ÏÎã³°¤Ç¡¢
710 ¥¤¥ó¥¯¥ë¡¼¥É¥Õ¥¡¥¤¥ë¤Ï¥Ü¡¼¥ë¥É¤Ë¤¹¤ë (Îã:
711 .BR "#include <stdio.h>" )¡£
712 .\"O When referring to a standard include file under
713 .\"O .IR /usr/include ,
714 .\"O specify the header file surrounded by angle brackets,
715 .\"O in the usual C way (e.g.,
716 .\"O .IR <stdio.h> ).
717 .I /usr/include
718 °Ê²¼¤Îɸ½à¤Î¥¤¥ó¥¯¥ë¡¼¥É¥Õ¥¡¥¤¥ë¤ò»²¾È¤¹¤ëºÝ¤Ï¡¢
719 Ä̾ï¤Î C ¸À¸ì¤ÈƱÍͤ˻³³ç¸Ì¤Ç¥Ø¥Ã¥À¥Õ¥¡¥¤¥ë¤ò°Ï¤Ì¤Ç»ØÄꤹ¤ë (Î㡧
720 .IR <stdio.h> )¡£
721 .PP
722 .\"O Special macros, which are usually in upper case, are in bold (e.g.,
723 .\"O .BR MAXINT ).
724 .\"O Exception: don't boldface NULL.
725 Ä̾Âçʸ»ú¤Çɽ¸½¤¹¤ëÆüì¥Þ¥¯¥í¤Ï¥Ü¡¼¥ë¥É¤Çɽ¤¹ (Î㤨¤Ð
726 .BR MAXINT )¡£
727 Îã³°¤È¤·¤Æ NULL ¤Ï¥Ü¡¼¥ë¥É¤Ë¤·¤Ê¤¤¡£
728 .PP
729 .\"O When enumerating a list of error codes, the codes are in bold (this list
730 .\"O usually uses the
731 .\"O .B \&.TP
732 .\"O macro).
733 ¥¨¥é¡¼¥³¡¼¥É¤Î¥ê¥¹¥È¤òÎóµó¤¹¤ë»þ¤Ë¤Ï¡¢¥³¡¼¥É¤Ï¥Ü¡¼¥ë¥É¤Çɽ¤¹
734 (¤³¤Î¥ê¥¹¥È¤Ë¤ÏÄ̾ï
735 .B \&.TP
736 ¥Þ¥¯¥í¤òÍѤ¤¤ë)¡£
737 .PP
738 .\"O Complete commands should, if long,
739 .\"O be written as in an indented line on their own, for example
740 ´°Á´¤Ê¥³¥Þ¥ó¥É¤Ï¡¢Ä¹¤¤¾ì¹ç¤Ë¤Ï¡¢Îã¤Ë¼¨¤¹¤è¤¦¤Ë
741 »ú²¼¤²¤·¤¿¹Ô¤Ë¥³¥Þ¥ó¥É¤À¤±¤òµ­ºÜ¤¹¤Ù¤­¤Ç¤¢¤ë¡£
742 .in +4n
743 .nf
744
745 man 7 man-pages
746
747 .fi
748 .in
749 .\"O If the command is short, then it can be included inline in the text,
750 .\"O in italic format, for example,
751 .\"O .IR "man 7 man-pages" .
752 .\"O In this case, it may be worth using nonbreaking spaces
753 .\"O ("\e\ ") at suitable places in the command.
754 .\"O Command options should be written in italics, e.g.,
755 .\"O .IR \-l .
756 ¥³¥Þ¥ó¥É¤¬Ã»¤¤¾ì¹ç¤Ï¡¢
757 .I "man 7 man-pages"
758 ¤Î¤è¤¦¤Ë¥¤¥¿¥ê¥Ã¥¯ÂΤÇʸÃæ¤ËËä¤á¹þ¤ó¤Çµ­ºÜ¤·¤Æ¤â¤è¤¤¡£
759 ¤³¤Î¾ì¹ç¡¢¥³¥Þ¥ó¥ÉÆâ¤ÎŬÀڤʰÌÃ֤ˡ¢²þ¹Ô¤Ç¤­¤Ê¤¤¥¹¥Ú¡¼¥¹ ("\e\ ")
760 ¤ò»È¤¦¤È¤è¤¤¤«¤â¤·¤ì¤Ê¤¤¡£
761 ¥³¥Þ¥ó¥É¥ª¥×¥·¥ç¥ó¤â
762 .I \-l
763 ¤Î¤è¤¦¤Ë¥¤¥¿¥ê¥Ã¥¯ÂΤǵ­ºÜ¤¹¤Ù¤­¤Ç¤¢¤ë¡£
764 .PP
765 .\"O Expressions, if not written on a separate indented line, should
766 .\"O be specified in italics.
767 .\"O Again, the use of nonbreaking spaces may be appropriate
768 .\"O if the expression is inlined with normal text.
769 ¼°¤Ï¡¢ÀìÍѤλú²¼¤²¤·¤¿¹Ô¤Ëµ­ºÜ¤·¤Ê¤¤¾ì¹ç¡¢¥¤¥¿¥ê¥Ã¥¯ÂΤò»ØÄꤹ¤ë¤³¤È¡£
770 ·«¤êÊÖ¤·¤Ë¤Ê¤ë¤¬¡¢¼°¤òÄ̾ï¤ÎʸÃæ¤ËËä¤á¹þ¤à¾ì¹ç¤Ë¤â¡¢
771 ²þ¹Ô¤Ç¤­¤Ê¤¤¥¹¥Ú¡¼¥¹¤ò»È¤¦¤È¤è¤¤¤À¤í¤¦¡£
772 .PP
773 .\"O Any reference to the subject of the current manual page
774 .\"O should be written with the name in bold.
775 .\"O If the subject is a function (i.e., this is a Section 2 or 3 page),
776 .\"O then the name should be followed by a pair of parentheses
777 .\"O in Roman (normal) font.
778 .\"O For example, in the
779 .\"O .BR fcntl (2)
780 .\"O man page, references to the subject of the page would be written as:
781 .\"O .BR fcntl ().
782 .\"O The preferred way to write this in the source file is:
783 ¤½¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ÎÀâÌÀÂоݤؤλ²¾È¤Ï¡¢¥Ü¡¼¥ë¥É¤Ç̾Á°¤òµ­ºÜ¤¹¤ë¡£
784 Âоݤ¬´Ø¿ô (¤Ä¤Þ¤ê¡¢¥»¥¯¥·¥ç¥ó 2 ¤ä 3 ¤Î¥Ú¡¼¥¸) ¤Î¾ì¹ç¡¢
785 ̾Á°¤Î¸å¤í¤Ë¥í¡¼¥Þ¥ó¥Õ¥©¥ó¥È (Ä̾ï¤Î¥Õ¥©¥ó¥È) ¤Ç´Ý³ç¸Ì¤ÎÂФò³¤±¤ë¡£
786 Î㤨¤Ð¡¢
787 .BR fcntl (2)
788 ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ç¤Ï¡¢ÀâÌÀÂоݤؤλ²¾È¤Ï
789 .BR fcntl ()
790 ¤Î¤è¤¦¤Ëµ­ºÜ¤¹¤ë¡£
791 ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ë¤Ï¼¡¤Î¤è¤¦¤Ëµ­ºÜ¤¹¤ë¤Î¤¬Ë¾¤Þ¤·¤¤:
792 .nf
793
794     .BR fcntl ()
795
796 .fi
797 .\"O (Using this format, rather than the use of "\\fB...\\fP()"
798 .\"O makes it easier to write tools that parse man page source files.)
799 ("\\fB...\\fP()" ¤è¤ê¤â¡¢¤³¤Î·Á¼°¤ò»È¤¦¤³¤È¡£
800 ¤³¤ì¤Ë¤è¤ê¡¢¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò²ò¼á¤¹¤ë¥Ä¡¼¥ë¤ò
801 ½ñ¤¯¤Î¤¬´Êñ¤Ë¤Ê¤ë¡£)
802 .PP
803 .\"O Any reference to another man page
804 .\"O should be written with the name in bold,
805 .\"O \fIalways\fP followed by the section number,
806 .\"O formatted in Roman (normal) font, without any
807 .\"O separating spaces (e.g.,
808 .\"O .BR intro (2)).
809 .\"O The preferred way to write this in the source file is:
810 Ê̤Υޥ˥奢¥ë¥Ú¡¼¥¸¤Ø¤Î»²¾È¤Ï¡¢¥Ü¡¼¥ë¥É¤Ç̾Á°¤òµ­ºÜ¤·¡¢
811 ¤½¤ì¤Ë³¤±¤Æ¥»¥¯¥·¥ç¥óÈÖ¹æ¤ò¡Öɬ¤º¡×½ñ¤¯¡£¥»¥¯¥·¥ç¥óÈÖ¹æ¤Ï
812 ¥í¡¼¥Þ¥ó¥Õ¥©¥ó¥È (Ä̾ï¤Î¥Õ¥©¥ó¥È) ¤Ç½ñ¤­¡¢¥¹¥Ú¡¼¥¹¤ÏÆþ¤ì¤Ê¤¤
813 (Îã:
814 .BR intro (2))¡£
815 ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ë¤Ï¼¡¤Î¤è¤¦¤Ëµ­ºÜ¤¹¤ë¤Î¤¬Ë¾¤Þ¤·¤¤:
816 .nf
817
818     .BR intro (2)
819
820 .fi
821 .\"O (Including the section number in cross references lets tools like
822 .\"O .BR man2html (1)
823 .\"O create properly hyperlinked pages.)
824 (Áê¸ß»²¾È¤Ë¥»¥¯¥·¥ç¥óÈÖ¹æ¤ò´Þ¤á¤Æ¤ª¤¯¤È¡¢
825 .B man2html
826 ¤È¤¤¤Ã¤¿¥Ä¡¼¥ë¤¬¥Ú¡¼¥¸´Ö¤Î¥Ï¥¤¥Ñ¡¼¥ê¥ó¥¯¤òŬÀÚ¤ËÀ¸À®¤Ç¤­¤ë¡£)
827 .\"O .SS Spelling
828 .SS ÄÖ¤ê (spelling)
829 .\"O Starting with release 2.59,
830 .\"O .I man-pages
831 .\"O follows American spelling conventions;
832 .\"O please write all new pages and patches according to these conventions.
833 ¥ê¥ê¡¼¥¹ 2.59 ¤«¤é¤À¤¬¡¢
834 .I man-pages
835 ¤Ï¥¢¥á¥ê¥«±Ñ¸ì¤ÎÄÖ¤ê¤Î´·½¬¤Ë½¾¤Ã¤Æ¤¤¤ë¡£
836 ¿·¤·¤¤¥Ú¡¼¥¸¤ä¥Ñ¥Ã¥Á¤ÏÁ´¤Æ¤³¤Î´·½¬¤Ë½¾¤Ã¤Æ²¼¤µ¤¤¡£
837 .\"O .SS Example Programs and Shell Sessions
838 .SS ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤È¥·¥§¥ë¤Î¥»¥Ã¥·¥ç¥ó
839 .\"O Manual pages can include example programs demonstrating how to
840 .\"O use a system call or library function.
841 .\"O However, note the following:
842 ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë¤Ï¡¢¥·¥¹¥Æ¥à¥³¡¼¥ë¤ä¥é¥¤¥Ö¥é¥ê´Ø¿ô¤Î»È¤¤Êý¤ò¼¨¤¹
843 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
844 ¤½¤ÎºÝ¤Ë¤Ï¡¢°Ê²¼¤ÎÅÀ¤Ëα°Õ¤¹¤Ù¤­¤Ç¤¢¤ë¡£
845 .TP 3
846 *
847 .\"O Example programs should be written in C.
848 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï C ¤Çµ­ºÜ¤¹¤ë¤³¤È¡£
849 .TP
850 *
851 .\"O An example program is only necessary and useful if it demonstrates
852 .\"O something beyond what can easily be provided in a textual
853 .\"O description of the interface.
854 .\"O An example program that does nothing
855 .\"O other than call an interface usually serves little purpose.
856 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï¡¢
857 ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ë¤Ä¤¤¤Æʸ¾Ï¤Ç´Êñ¤ËÀâÌÀ¤Ç¤­¤ë°Ê¾å¤Î¤³¤È¤ò¼¨¤¹¾ì¹ç¤Ë¤À¤±
858 ɬÍפ«¤ÄÍ­ÍѤǤ¢¤ë¡£¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ò¸Æ¤Ó½Ð¤¹°Ê³°¤Ë²¿¤â¤·¤Ê¤¤¥µ¥ó¥×¥ë
859 ¥×¥í¥°¥é¥à¤ÏÉáÄ̤ϤۤȤó¤ÉÌò¤ËΩ¤¿¤Ê¤¤¡£
860 .TP
861 *
862 .\"O Example programs should be fairly short (preferably less than 100 lines;
863 .\"O ideally less than 50 lines).
864 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï¤«¤Ê¤êû¤á¤Ë¤¹¤ë¤³¤È
865 (100¹Ô̤Ëþ¤¬Ë¾¤Þ¤·¤¯¡¢50¹Ô̤Ëþ¤¬ÍýÁÛŪ¤Ç¤¢¤ë)¡£
866 .TP
867 *
868 .\"O Example programs should do error checking after system calls and
869 .\"O library function calls.
870 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ç¤Ï¡¢¥·¥¹¥Æ¥à¥³¡¼¥ë¤ä¥é¥¤¥Ö¥é¥ê´Ø¿ô¤ò¸Æ¤Ó½Ð¤·¤¿¸å¤Ç
871 ¥¨¥é¡¼¥Á¥§¥Ã¥¯¤ò¹Ô¤¦¤³¤È¡£
872 .TP
873 *
874 .\"O Example programs should be complete, and compile without
875 .\"O warnings when compiled with \fIcc\ \-Wall\fP.
876 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï´°·ë¤·¤Æ¤¤¤Æ¡¢
877 \fIcc\ \-Wall\fP
878 ¤Ç¥³¥ó¥Ñ¥¤¥ë¤·¤¿ºÝ¤Ë·Ù¹ð¤Ê¤·¤Ç¥³¥ó¥Ñ¥¤¥ë¤Ç¤­¤ë¤³¤È¡£
879 .TP
880 *
881 .\"O Where possible and appropriate, example programs should allow
882 .\"O experimentation, by varying their behavior based on inputs
883 .\"O (ideally from command-line arguments, or alternatively, via
884 .\"O input read by the program).
885 ²Äǽ¤«¤ÄŬÀڤʾì¹ç¤Ë¤Ï¡¢¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ç
886 ÆþÎϤˤè¤êÆ°ºî¤òÊѲ½¤µ¤»¤ë¤Ê¤É¤Î¼Â¸³¤ò¹Ô¤¦¤È¤è¤¤
887 (ÍýÁÛŪ¤Ë¤Ï¡¢¥³¥Þ¥ó¥É¥é¥¤¥ó°ú¤­¿ô¤ä¡¢¥×¥í¥°¥é¥à¤¬Æɤ߹þ¤àÆþÎϥǡ¼¥¿
888 ·Ðͳ¤Ç¡¢Æ°ºî¤òÊѲ½¤µ¤»¤ë¤Î¤¬¤è¤¤)¡£
889 .TP
890 *
891 .\"O Example programs should be laid out according to Kernighan and
892 .\"O Ritchie style, with 4-space indents.
893 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï¡¢K&R (Kernighan and Ritchie) ¥¹¥¿¥¤¥ë¤Ç½ñ¤­¡¢
894 »ú²¼¤²¤Ï¥¹¥Ú¡¼¥¹ 4ʸ»ú¤Ç¹Ô¤¦¡£
895 .\"O (Avoid the use of TAB characters in source code!)
896 (¥½¡¼¥¹¥³¡¼¥É¤Ç TAB Ê¸»ú¤ò»È¤¦¤Î¤ÏÈò¤±¤ë¤³¤È¡£)
897 .PP
898 .\"O For some examples of what example programs should look like, see
899 .\"O .BR wait (2)
900 .\"O and
901 .\"O .BR pipe (2).
902 ¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤¬¤É¤ó¤ÊÉ÷¤Ë¤Ê¤Ã¤Æ¤¤¤ì¤Ð¤è¤¤¤«¤ÎÎã¤Ë¤Ä¤¤¤Æ¤Ï¡¢
903 .BR wait (2)
904 ¤È
905 .BR pipe (2)
906 ¤ò»²¾È¤¹¤ë¤³¤È¡£
907
908 .\"O If you include a shell session demonstrating the use of a program
909 .\"O or other system feature, boldface the user input text,
910 .\"O to distinguish it from output produced by the system.
911 ¥×¥í¥°¥é¥à¤Î»È¤¤Êý¤ä¾¤Î¥·¥¹¥Æ¥à¤ÎÆÃħ¤ò¼¨¤¹¤¿¤á¤Ë¥·¥§¥ë¤Î¥»¥Ã¥·¥ç¥óÎã
912 ¤ò´Þ¤á¤ë¾ì¹ç¡¢¥æ¡¼¥¶¤ÎÆþÎÏʸ¤ò¥Ü¡¼¥ë¥É¤Ë¤·¤Æ¡¢¥·¥¹¥Æ¥à¤¬À¸À®¤¹¤ë
913 ½ÐÎϤȶèÊ̤Ǥ­¤ë¤è¤¦¤Ë¤¹¤ë¤³¤È¡£
914 .\"O .SS Indentation of structure definitions, shell session logs, etc.
915 .SS ¹½Â¤ÂΤÎÄêµÁ¡¢¥·¥§¥ë¤Î¥»¥Ã¥·¥ç¥ó¥í¥°¤Ê¤É¤Î»ú²¼¤²
916 .\"O When structure definitions, shell session logs, etc. are included
917 .\"O in running text, indent them by 4 spaces (i.e., a block enclosed by
918 .\"O .I ".in\ +4n"
919 .\"O and
920 .\"O .IR ".in" ).
921 ¹½Â¤ÂΤÎÄêµÁ¤ä¥·¥§¥ë¤Î¥»¥Ã¥·¥ç¥ó¥í¥°¤Ê¤É¤òËÜʸÃæ¤Ëµ­ºÜ¤¹¤ëºÝ¤Ï¡¢
922 ¥¹¥Ú¡¼¥¹ 4¸Äʬ¤Î»ú²¼¤²¤ò¹Ô¤¦ (¤Ä¤Þ¤ê¡¢¥Ö¥í¥Ã¥¯¤ò
923 .I ".in\ +4n"
924 ¤È
925 .I ".in"
926 ¤Ç°Ï¤à)¡£
927 .\"O .SH EXAMPLE
928 .SH Îã
929 .\"O For canonical examples of how man pages in the
930 .\"O .I man-pages
931 .\"O package should look, see
932 .\"O .BR pipe (2)
933 .\"O and
934 .\"O .BR fcntl (2).
935 .I man-pages
936 ¥Ñ¥Ã¥±¡¼¥¸¤Ë´Þ¤Þ¤ì¤ë¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ÎÂκۤÎɸ½àŪ¤ÊÎã¤Ë¤Ä¤¤¤Æ¤Ï¡¢
937 .BR pipe (2)
938 ¤È
939 .BR fcntl (2)
940 ¤ò»²¾È¤¹¤ë¤³¤È¡£
941 .\"O .SH SEE ALSO
942 .SH ´ØÏ¢¹àÌÜ
943 .BR man (1),
944 .BR man2html (1),
945 .BR groff (7),
946 .BR groff_man (7),
947 .BR man (7),
948 .BR mdoc (7)