OSDN Git Service

(split) LDP: Update POT and ja.po to LDP v3.54
[linuxjm/LDP_man-pages.git] / po4a / intro / po / intro.pot
1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2013-09-28 04:06+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
14 "Language: \n"
15 "MIME-Version: 1.0\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18
19 #. type: TH
20 #: build/C/man7/feature_test_macros.7:25
21 #, no-wrap
22 msgid "FEATURE_TEST_MACROS"
23 msgstr ""
24
25 #. type: TH
26 #: build/C/man7/feature_test_macros.7:25 build/C/man7/libc.7:26 build/C/man7/man.7:34 build/C/man7/units.7:26
27 #, no-wrap
28 msgid "2012-08-05"
29 msgstr ""
30
31 #. type: TH
32 #: build/C/man7/feature_test_macros.7:25 build/C/man1/intro.1:28 build/C/man2/intro.2:29 build/C/man3/intro.3:26 build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29 build/C/man7/libc.7:26 build/C/man7/mailaddr.7:27 build/C/man7/man-pages.7:30 build/C/man7/man.7:34 build/C/man7/mdoc.7:44 build/C/man7/operator.7:40 build/C/man5/proc.5:62 build/C/man7/standards.7:26 build/C/man7/suffixes.7:40 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:26 build/C/man7/units.7:26
33 #, no-wrap
34 msgid "Linux"
35 msgstr ""
36
37 #. type: TH
38 #: build/C/man7/feature_test_macros.7:25 build/C/man2/intro.2:29 build/C/man3/intro.3:26 build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29 build/C/man7/libc.7:26 build/C/man7/man-pages.7:30 build/C/man7/man.7:34 build/C/man7/operator.7:40 build/C/man7/posixoptions.7:24 build/C/man5/proc.5:62 build/C/man7/standards.7:26 build/C/man7/suffixes.7:40 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:26 build/C/man7/units.7:26
39 #, no-wrap
40 msgid "Linux Programmer's Manual"
41 msgstr ""
42
43 #. type: Sh
44 #: build/C/man7/feature_test_macros.7:26 build/C/man1/intro.1:29 build/C/man2/intro.2:30 build/C/man3/intro.3:27 build/C/man4/intro.4:27 build/C/man5/intro.5:28 build/C/man6/intro.6:27 build/C/man7/intro.7:29 build/C/man8/intro.8:30 build/C/man7/libc.7:27 build/C/man7/mailaddr.7:29 build/C/man7/man-pages.7:31 build/C/man7/man.7:35 build/C/man7/mdoc.7:45 build/C/man7/operator.7:41 build/C/man7/posixoptions.7:25 build/C/man5/proc.5:63 build/C/man7/standards.7:27 build/C/man7/suffixes.7:41 build/C/man3/undocumented.3:30 build/C/man2/unimplemented.2:27 build/C/man7/units.7:27 build/C/man7/mdoc.samples.7:46
45 #, no-wrap
46 msgid "NAME"
47 msgstr ""
48
49 #. type: Plain text
50 #: build/C/man7/feature_test_macros.7:28
51 msgid "feature_test_macros - feature test macros"
52 msgstr ""
53
54 #. type: Sh
55 #: build/C/man7/feature_test_macros.7:28 build/C/man7/man-pages.7:33 build/C/man7/man.7:37 build/C/man7/mdoc.7:50 build/C/man3/undocumented.3:32 build/C/man2/unimplemented.2:31 build/C/man7/mdoc.samples.7:52
56 #, no-wrap
57 msgid "SYNOPSIS"
58 msgstr ""
59
60 #. type: Plain text
61 #: build/C/man7/feature_test_macros.7:31
62 #, no-wrap
63 msgid "B<#include E<lt>features.hE<gt>>\n"
64 msgstr ""
65
66 #. type: Sh
67 #: build/C/man7/feature_test_macros.7:32 build/C/man1/intro.1:31 build/C/man2/intro.2:32 build/C/man3/intro.3:29 build/C/man4/intro.4:29 build/C/man5/intro.5:30 build/C/man6/intro.6:29 build/C/man7/intro.7:31 build/C/man8/intro.8:32 build/C/man7/libc.7:29 build/C/man7/mailaddr.7:31 build/C/man7/man-pages.7:37 build/C/man7/man.7:49 build/C/man7/mdoc.7:54 build/C/man7/operator.7:43 build/C/man7/posixoptions.7:27 build/C/man5/proc.5:65 build/C/man7/standards.7:29 build/C/man7/suffixes.7:43 build/C/man3/undocumented.3:34 build/C/man2/unimplemented.2:33 build/C/man7/units.7:29 build/C/man7/mdoc.samples.7:54
68 #, no-wrap
69 msgid "DESCRIPTION"
70 msgstr ""
71
72 #. type: Plain text
73 #: build/C/man7/feature_test_macros.7:35
74 msgid ""
75 "Feature test macros allow the programmer to control the definitions that are "
76 "exposed by system header files when a program is compiled."
77 msgstr ""
78
79 #. type: Plain text
80 #: build/C/man7/feature_test_macros.7:43
81 msgid ""
82 "B<NOTE:> In order to be effective, a feature test macro I<must be defined "
83 "before including any header files>.  This can be done either in the "
84 "compilation command (I<cc -DMACRO=value>)  or by defining the macro within "
85 "the source code before including any headers."
86 msgstr ""
87
88 #. type: Plain text
89 #: build/C/man7/feature_test_macros.7:52
90 msgid ""
91 "Some feature test macros are useful for creating portable applications, by "
92 "preventing nonstandard definitions from being exposed.  Other macros can be "
93 "used to expose nonstandard definitions that are not exposed by default.  The "
94 "precise effects of each of the feature test macros described below can be "
95 "ascertained by inspecting the I<E<lt>features.hE<gt>> header file."
96 msgstr ""
97
98 #. type: SS
99 #: build/C/man7/feature_test_macros.7:52
100 #, no-wrap
101 msgid "Specification of feature test macro requirements in manual pages"
102 msgstr ""
103
104 #. type: Plain text
105 #: build/C/man7/feature_test_macros.7:58
106 msgid ""
107 "When a function requires that a feature test macro is defined, the manual "
108 "page SYNOPSIS typically includes a note of the following form (this example "
109 "from the B<acct>(2)  manual page):"
110 msgstr ""
111
112 #. type: Plain text
113 #: build/C/man7/feature_test_macros.7:61
114 msgid "B<#include E<lt>unistd.hE<gt>>"
115 msgstr ""
116
117 #. type: Plain text
118 #: build/C/man7/feature_test_macros.7:63
119 msgid "B<int acct(const char *>I<filename>B<);>"
120 msgstr ""
121
122 #. type: Plain text
123 #: build/C/man7/feature_test_macros.7:68
124 #, no-wrap
125 msgid ""
126 "Feature Test Macro Requirements for glibc (see\n"
127 "B<feature_test_macros>(7)):\n"
128 msgstr ""
129
130 #. type: Plain text
131 #: build/C/man7/feature_test_macros.7:73
132 msgid "B<acct>(): _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE\\ E<lt>\\ 500)"
133 msgstr ""
134
135 #. type: Plain text
136 #: build/C/man7/feature_test_macros.7:84
137 msgid ""
138 "The B<||> means that in order to obtain the declaration of B<acct>(2)  from "
139 "I<E<lt>unistd.hE<gt>>, I<either> of the following macro definitions must be "
140 "made before including any header files:"
141 msgstr ""
142
143 #. type: Plain text
144 #: build/C/man7/feature_test_macros.7:89
145 #, no-wrap
146 msgid ""
147 "#define _BSD_SOURCE\n"
148 "#define _XOPEN_SOURCE        /* or any value E<lt> 500 */\n"
149 msgstr ""
150
151 #. type: Plain text
152 #: build/C/man7/feature_test_macros.7:94
153 msgid ""
154 "Alternatively, equivalent definitions can be included in the compilation "
155 "command:"
156 msgstr ""
157
158 #. type: Plain text
159 #: build/C/man7/feature_test_macros.7:99
160 #, no-wrap
161 msgid ""
162 "cc -D_BSD_SOURCE\n"
163 "cc -D_XOPEN_SOURCE           # Or any value E<lt> 500\n"
164 msgstr ""
165
166 #. type: Plain text
167 #: build/C/man7/feature_test_macros.7:107
168 msgid ""
169 "Note that, as described below, B<some feature test macros are defined by "
170 "default>, so that it may not always be necessary to explicitly specify the "
171 "feature test macro(s) shown in the SYNOPSIS."
172 msgstr ""
173
174 #. type: Plain text
175 #: build/C/man7/feature_test_macros.7:111
176 msgid ""
177 "In a few cases, manual pages use a shorthand for expressing the feature test "
178 "macro requirements (this example from B<readahead>(2)):"
179 msgstr ""
180
181 #. type: Plain text
182 #: build/C/man7/feature_test_macros.7:116
183 #, no-wrap
184 msgid ""
185 "B<#define _GNU_SOURCE>\n"
186 "B<#include E<lt>fcntl.hE<gt>>\n"
187 msgstr ""
188
189 #. type: Plain text
190 #: build/C/man7/feature_test_macros.7:118
191 #, no-wrap
192 msgid ""
193 "B<ssize_t readahead(int >I<fd>B<, off64_t *>I<offset>B<, size_t "
194 ">I<count>B<);>\n"
195 msgstr ""
196
197 #. type: Plain text
198 #: build/C/man7/feature_test_macros.7:124
199 msgid ""
200 "This format is employed in cases where only a single feature test macro can "
201 "be used to expose the function declaration, and that macro is not defined by "
202 "default."
203 msgstr ""
204
205 #. type: SS
206 #: build/C/man7/feature_test_macros.7:124
207 #, no-wrap
208 msgid "Feature test macros understood by glibc"
209 msgstr ""
210
211 #.  The details in glibc 2.0 are simpler, but combining a
212 #.  a description of them with the details in later glibc versions
213 #.  would make for a complicated description.
214 #. type: Plain text
215 #: build/C/man7/feature_test_macros.7:132
216 msgid ""
217 "The following paragraphs explain how feature test macros are handled in "
218 "Linux glibc 2.I<x>, I<x> E<gt> 0."
219 msgstr ""
220
221 #. type: Plain text
222 #: build/C/man7/feature_test_macros.7:134
223 msgid "Linux glibc understands the following feature test macros:"
224 msgstr ""
225
226 #. type: TP
227 #: build/C/man7/feature_test_macros.7:134
228 #, no-wrap
229 msgid "B<__STRICT_ANSI__>"
230 msgstr ""
231
232 #. type: Plain text
233 #: build/C/man7/feature_test_macros.7:144
234 msgid ""
235 "ISO Standard C.  This macro is implicitly defined by B<gcc>(1)  when invoked "
236 "with, for example, the I<-std=c99> or I<-ansi> flag."
237 msgstr ""
238
239 #. type: TP
240 #: build/C/man7/feature_test_macros.7:144
241 #, no-wrap
242 msgid "B<_POSIX_C_SOURCE>"
243 msgstr ""
244
245 #. type: Plain text
246 #: build/C/man7/feature_test_macros.7:147 build/C/man7/feature_test_macros.7:178
247 msgid "Defining this macro causes header files to expose definitions as follows:"
248 msgstr ""
249
250 #. type: IP
251 #: build/C/man7/feature_test_macros.7:148 build/C/man7/feature_test_macros.7:151 build/C/man7/feature_test_macros.7:154 build/C/man7/feature_test_macros.7:158 build/C/man7/feature_test_macros.7:161 build/C/man7/feature_test_macros.7:165 build/C/man7/feature_test_macros.7:179 build/C/man7/feature_test_macros.7:182 build/C/man7/feature_test_macros.7:185 build/C/man7/feature_test_macros.7:189 build/C/man7/feature_test_macros.7:414 build/C/man7/feature_test_macros.7:419 build/C/man7/feature_test_macros.7:425 build/C/man7/feature_test_macros.7:430 build/C/man7/feature_test_macros.7:436 build/C/man7/feature_test_macros.7:441 build/C/man5/proc.5:2645 build/C/man5/proc.5:2647 build/C/man5/proc.5:2649 build/C/man5/proc.5:2652
252 #, no-wrap
253 msgid "\\(bu"
254 msgstr ""
255
256 #. type: Plain text
257 #: build/C/man7/feature_test_macros.7:151
258 msgid "The value 1 exposes definitions conforming to POSIX.1-1990 and ISO C (1990)."
259 msgstr ""
260
261 #. type: Plain text
262 #: build/C/man7/feature_test_macros.7:154
263 msgid "The value 2 or greater additionally exposes definitions for POSIX.2-1992."
264 msgstr ""
265
266 #.  199506L functionality is available only since glibc 2.1
267 #. type: Plain text
268 #: build/C/man7/feature_test_macros.7:158
269 msgid ""
270 "The value 199309L or greater additionally exposes definitions for POSIX.1b "
271 "(real-time extensions)."
272 msgstr ""
273
274 #. type: Plain text
275 #: build/C/man7/feature_test_macros.7:161
276 msgid ""
277 "The value 199506L or greater additionally exposes definitions for POSIX.1c "
278 "(threads)."
279 msgstr ""
280
281 #. type: Plain text
282 #: build/C/man7/feature_test_macros.7:165
283 msgid ""
284 "(Since glibc 2.3.3)  The value 200112L or greater exposes definitions "
285 "corresponding to the POSIX.1-2001 base specification (excluding the XSI "
286 "extension)."
287 msgstr ""
288
289 #. type: Plain text
290 #: build/C/man7/feature_test_macros.7:169
291 msgid ""
292 "(Since glibc 2.10)  The value 200809L or greater exposes definitions "
293 "corresponding to the POSIX.1-2008 base specification (excluding the XSI "
294 "extension)."
295 msgstr ""
296
297 #. type: TP
298 #: build/C/man7/feature_test_macros.7:170
299 #, no-wrap
300 msgid "B<_POSIX_SOURCE>"
301 msgstr ""
302
303 #. type: Plain text
304 #: build/C/man7/feature_test_macros.7:175
305 msgid ""
306 "Defining this obsolete macro with any value is equivalent to defining "
307 "B<_POSIX_C_SOURCE> with the value 1."
308 msgstr ""
309
310 #. type: TP
311 #: build/C/man7/feature_test_macros.7:175
312 #, no-wrap
313 msgid "B<_XOPEN_SOURCE>"
314 msgstr ""
315
316 #. type: Plain text
317 #: build/C/man7/feature_test_macros.7:182
318 msgid ""
319 "Defining with any value exposes definitions conforming to POSIX.1, POSIX.2, "
320 "and XPG4."
321 msgstr ""
322
323 #. type: Plain text
324 #: build/C/man7/feature_test_macros.7:185
325 msgid ""
326 "The value 500 or greater additionally exposes definitions for SUSv2 (UNIX "
327 "98)."
328 msgstr ""
329
330 #. type: Plain text
331 #: build/C/man7/feature_test_macros.7:189
332 msgid ""
333 "(Since glibc 2.2) The value 600 or greater additionally exposes definitions "
334 "for SUSv3 (UNIX 03; i.e., the POSIX.1-2001 base specification plus the XSI "
335 "extension) and C99 definitions."
336 msgstr ""
337
338 #. type: Plain text
339 #: build/C/man7/feature_test_macros.7:193
340 msgid ""
341 "(Since glibc 2.10) The value 700 or greater additionally exposes definitions "
342 "for SUSv4 (i.e., the POSIX.1-2008 base specification plus the XSI "
343 "extension)."
344 msgstr ""
345
346 #. type: TP
347 #: build/C/man7/feature_test_macros.7:194
348 #, no-wrap
349 msgid "B<_XOPEN_SOURCE_EXTENDED>"
350 msgstr ""
351
352 #. type: Plain text
353 #: build/C/man7/feature_test_macros.7:203
354 msgid ""
355 "If this macro is defined, and B<_XOPEN_SOURCE> is defined, then expose "
356 "definitions corresponding to the XPG4v2 (SUSv1) UNIX extensions (UNIX 95).  "
357 "This macro is also implicitly defined if B<_XOPEN_SOURCE> is defined with a "
358 "value of 500 or more."
359 msgstr ""
360
361 #. type: TP
362 #: build/C/man7/feature_test_macros.7:203
363 #, no-wrap
364 msgid "B<_ISOC95_SOURCE>"
365 msgstr ""
366
367 #. type: Plain text
368 #: build/C/man7/feature_test_macros.7:213
369 msgid ""
370 "Exposes ISO C (1990) Amendment 1 definitions (also known as C95).  This "
371 "macro is recognized since glibc 2.12.  The primary change in C95 was support "
372 "for international character sets.  The C95 changes were included in the "
373 "subsequent C99 standard (in other words, B<_ISOC99_SOURCE> implies "
374 "B<_ISOC95_SOURCE>)."
375 msgstr ""
376
377 #. type: TP
378 #: build/C/man7/feature_test_macros.7:213
379 #, no-wrap
380 msgid "B<_ISOC99_SOURCE>"
381 msgstr ""
382
383 #. type: Plain text
384 #: build/C/man7/feature_test_macros.7:222
385 msgid ""
386 "Exposes C99 extensions to ISO C (1990).  This macro is recognized since "
387 "glibc 2.1.3; earlier glibc 2.1.x versions recognized an equivalent macro "
388 "named B<_ISOC9X_SOURCE> (because the C99 standard had not then been "
389 "finalized).  Although the use of the latter macro is obsolete, glibc "
390 "continues to recognize it for backward compatibility."
391 msgstr ""
392
393 #. type: TP
394 #: build/C/man7/feature_test_macros.7:222
395 #, no-wrap
396 msgid "B<_ISOC11_SOURCE>"
397 msgstr ""
398
399 #. type: Plain text
400 #: build/C/man7/feature_test_macros.7:226
401 msgid ""
402 "Exposes declarations consistent with the ISO C11 standard.  This macro is "
403 "recognized since glibc 2.16."
404 msgstr ""
405
406 #. type: TP
407 #: build/C/man7/feature_test_macros.7:226
408 #, no-wrap
409 msgid "B<_LARGEFILE64_SOURCE>"
410 msgstr ""
411
412 #. type: Plain text
413 #: build/C/man7/feature_test_macros.7:247
414 msgid ""
415 "Expose definitions for the alternative API specified by the LFS (Large File "
416 "Summit) as a \"transitional extension\" to the Single UNIX Specification.  "
417 "(See E<.UR http:\\:/\\:/opengroup.org\\:/platform\\:/lfs.html> E<.UE )> The "
418 "alternative API consists of a set of new objects (i.e., functions and types) "
419 "whose names are suffixed with \"64\" (e.g., I<off64_t> versus I<off_t>, "
420 "B<lseek64>()  versus B<lseek>(), etc.).  New programs should not employ this "
421 "interface; instead I<_FILE_OFFSET_BITS=64> should be employed."
422 msgstr ""
423
424 #. type: TP
425 #: build/C/man7/feature_test_macros.7:247
426 #, no-wrap
427 msgid "B<_FILE_OFFSET_BITS>"
428 msgstr ""
429
430 #. type: Plain text
431 #: build/C/man7/feature_test_macros.7:259
432 msgid ""
433 "Defining this macro with the value 64 automatically converts references to "
434 "32-bit functions and data types related to file I/O and filesystem "
435 "operations into references to their 64-bit counterparts.  This is useful for "
436 "performing I/O on large files (E<gt> 2 Gigabytes)  on 32-bit systems.  "
437 "(Defining this macro permits correctly written programs to use large files "
438 "with only a recompilation being required.)  64-bit systems naturally permit "
439 "file sizes greater than 2 Gigabytes, and on those systems this macro has no "
440 "effect."
441 msgstr ""
442
443 #. type: TP
444 #: build/C/man7/feature_test_macros.7:259
445 #, no-wrap
446 msgid "B<_BSD_SOURCE>"
447 msgstr ""
448
449 #. type: Plain text
450 #: build/C/man7/feature_test_macros.7:273
451 msgid ""
452 "Defining this macro with any value causes header files to expose BSD-derived "
453 "definitions.  Defining this macro also causes BSD definitions to be "
454 "preferred in some situations where standards conflict, unless one or more of "
455 "B<_SVID_SOURCE>, B<_POSIX_SOURCE>, B<_POSIX_C_SOURCE>, B<_XOPEN_SOURCE>, "
456 "B<_XOPEN_SOURCE_EXTENDED>, or B<_GNU_SOURCE> is defined, in which case BSD "
457 "definitions are disfavored."
458 msgstr ""
459
460 #. type: TP
461 #: build/C/man7/feature_test_macros.7:273
462 #, no-wrap
463 msgid "B<_SVID_SOURCE>"
464 msgstr ""
465
466 #. type: Plain text
467 #: build/C/man7/feature_test_macros.7:279
468 msgid ""
469 "Defining this macro with any value causes header files to expose System "
470 "V-derived definitions.  (SVID == System V Interface Definition; see "
471 "B<standards>(7).)"
472 msgstr ""
473
474 #. type: TP
475 #: build/C/man7/feature_test_macros.7:279
476 #, no-wrap
477 msgid "B<_ATFILE_SOURCE> (since glibc 2.4)"
478 msgstr ""
479
480 #. type: Plain text
481 #: build/C/man7/feature_test_macros.7:288
482 msgid ""
483 "Defining this macro with any value causes header files to expose "
484 "declarations of a range of functions with the suffix \"at\"; see "
485 "B<openat>(2).  Since glibc 2.10, this macro is also implicitly defined if "
486 "B<_POSIX_C_SOURCE> is defined with a value greater than or equal to 200809L."
487 msgstr ""
488
489 #. type: TP
490 #: build/C/man7/feature_test_macros.7:288
491 #, no-wrap
492 msgid "B<_GNU_SOURCE>"
493 msgstr ""
494
495 #. type: Plain text
496 #: build/C/man7/feature_test_macros.7:310
497 msgid ""
498 "Defining this macro (with any value) is equivalent to defining "
499 "B<_BSD_SOURCE>, B<_SVID_SOURCE>, B<_ATFILE_SOURCE>, B<_LARGEFILE64_SOURCE>, "
500 "B<_ISOC99_SOURCE>, B<_XOPEN_SOURCE_EXTENDED>, B<_POSIX_SOURCE>, "
501 "B<_POSIX_C_SOURCE> with the value 200809L (200112L in glibc versions before "
502 "2.10; 199506L in glibc versions before 2.5; 199309L in glibc versions before "
503 "2.1)  and B<_XOPEN_SOURCE> with the value 700 (600 in glibc versions before "
504 "2.10; 500 in glibc versions before 2.2).  In addition, various GNU-specific "
505 "extensions are also exposed.  Where standards conflict, BSD definitions are "
506 "disfavored."
507 msgstr ""
508
509 #. type: TP
510 #: build/C/man7/feature_test_macros.7:310
511 #, no-wrap
512 msgid "B<_REENTRANT>"
513 msgstr ""
514
515 #. type: Plain text
516 #: build/C/man7/feature_test_macros.7:316
517 msgid ""
518 "Defining this macro exposes definitions of certain reentrant functions.  For "
519 "multithreaded programs, use I<cc\\ -pthread> instead."
520 msgstr ""
521
522 #. type: TP
523 #: build/C/man7/feature_test_macros.7:316
524 #, no-wrap
525 msgid "B<_THREAD_SAFE>"
526 msgstr ""
527
528 #. type: Plain text
529 #: build/C/man7/feature_test_macros.7:321
530 msgid ""
531 "Synonym for B<_REENTRANT>, provided for compatibility with some other "
532 "implementations."
533 msgstr ""
534
535 #. type: TP
536 #: build/C/man7/feature_test_macros.7:321
537 #, no-wrap
538 msgid "B<_FORTIFY_SOURCE> (since glibc 2.3.4)"
539 msgstr ""
540
541 #.  For more detail, see:
542 #.  http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html
543 #.  [PATCH] Object size checking to prevent (some) buffer overflows
544 #.  * From: Jakub Jelinek <jakub at redhat dot com>
545 #.  * To: gcc-patches at gcc dot gnu dot org
546 #.  * Date: Tue, 21 Sep 2004 04:16:40 -0400
547 #. type: Plain text
548 #: build/C/man7/feature_test_macros.7:367
549 msgid ""
550 "Defining this macro causes some lightweight checks to be performed to detect "
551 "some buffer overflow errors when employing various string and memory "
552 "manipulation functions.  Not all buffer overflows are detected, just some "
553 "common cases.  In the current implementation, checks are added for calls to "
554 "B<memcpy>(3), B<mempcpy>(3), B<memmove>(3), B<memset>(3), B<stpcpy>(3), "
555 "B<strcpy>(3), B<strncpy>(3), B<strcat>(3), B<strncat>(3), B<sprintf>(3), "
556 "B<snprintf>(3), B<vsprintf>(3), B<vsnprintf>(3), and B<gets>(3).  If "
557 "B<_FORTIFY_SOURCE> is set to 1, with compiler optimization level 1 (I<gcc\\ "
558 "-O1>)  and above, checks that shouldn't change the behavior of conforming "
559 "programs are performed.  With B<_FORTIFY_SOURCE> set to 2 some more checking "
560 "is added, but some conforming programs might fail.  Some of the checks can "
561 "be performed at compile time, and result in compiler warnings; other checks "
562 "take place at run time, and result in a run-time error if the check fails.  "
563 "Use of this macro requires compiler support, available with B<gcc>(1)  since "
564 "version 4.0."
565 msgstr ""
566
567 #. type: SS
568 #: build/C/man7/feature_test_macros.7:367
569 #, no-wrap
570 msgid "Default definitions, implicit definitions, and combining definitions"
571 msgstr ""
572
573 #. type: Plain text
574 #: build/C/man7/feature_test_macros.7:379
575 msgid ""
576 "If no feature test macros are explicitly defined, then the following feature "
577 "test macros are defined by default: B<_BSD_SOURCE>, B<_SVID_SOURCE>, "
578 "B<_POSIX_SOURCE>, and B<_POSIX_C_SOURCE>=200809L (200112L in glibc versions "
579 "before 2.10; 199506L in glibc versions before 2.4; 199309L in glibc versions "
580 "before 2.1)."
581 msgstr ""
582
583 #. type: Plain text
584 #: build/C/man7/feature_test_macros.7:395
585 msgid ""
586 "If any of B<__STRICT_ANSI__>, B<_ISOC99_SOURCE>, B<_POSIX_SOURCE>, "
587 "B<_POSIX_C_SOURCE>, B<_XOPEN_SOURCE>, B<_XOPEN_SOURCE_EXTENDED>, "
588 "B<_BSD_SOURCE>, or B<_SVID_SOURCE> is explicitly defined, then "
589 "B<_BSD_SOURCE>, and B<_SVID_SOURCE> are not defined by default."
590 msgstr ""
591
592 #. type: Plain text
593 #: build/C/man7/feature_test_macros.7:406
594 msgid ""
595 "If B<_POSIX_SOURCE> and B<_POSIX_C_SOURCE> are not explicitly defined, and "
596 "either B<__STRICT_ANSI__> is not defined or B<_XOPEN_SOURCE> is defined with "
597 "a value of 500 or more, then"
598 msgstr ""
599
600 #. type: IP
601 #: build/C/man7/feature_test_macros.7:407 build/C/man7/feature_test_macros.7:410 build/C/man7/man-pages.7:359 build/C/man7/man-pages.7:361 build/C/man7/man-pages.7:363 build/C/man7/man-pages.7:559 build/C/man7/man-pages.7:562 build/C/man7/man-pages.7:569 build/C/man7/man-pages.7:573 build/C/man7/man-pages.7:577 build/C/man7/man-pages.7:581 build/C/man7/man-pages.7:587 build/C/man5/proc.5:832 build/C/man5/proc.5:836 build/C/man5/proc.5:839 build/C/man5/proc.5:841 build/C/man5/proc.5:844 build/C/man5/proc.5:1320 build/C/man5/proc.5:1323 build/C/man5/proc.5:1335 build/C/man5/proc.5:1338 build/C/man5/proc.5:1342 build/C/man5/proc.5:1345 build/C/man5/proc.5:1348 build/C/man5/proc.5:1351 build/C/man5/proc.5:1354 build/C/man5/proc.5:1357 build/C/man5/proc.5:1360 build/C/man5/proc.5:1363 build/C/man5/proc.5:1367 build/C/man5/proc.5:1370 build/C/man5/proc.5:1373 build/C/man5/proc.5:1376 build/C/man5/proc.5:1379 build/C/man5/proc.5:1382 build/C/man5/proc.5:1385 build/C/man5/proc.5:1396 build/C/man5/proc.5:1402 build/C/man5/proc.5:1406 build/C/man5/proc.5:1411 build/C/man5/proc.5:1416 build/C/man5/proc.5:1421 build/C/man5/proc.5:1426 build/C/man5/proc.5:1431 build/C/man5/proc.5:1436 build/C/man5/proc.5:2426 build/C/man5/proc.5:2430 build/C/man5/proc.5:2433 build/C/man5/proc.5:2438 build/C/man5/proc.5:2632 build/C/man5/proc.5:2636 build/C/man5/proc.5:2642 build/C/man5/proc.5:2681 build/C/man5/proc.5:2687 build/C/man5/proc.5:2689
602 #, no-wrap
603 msgid "*"
604 msgstr ""
605
606 #. type: Plain text
607 #: build/C/man7/feature_test_macros.7:410
608 msgid "B<_POSIX_SOURCE> is defined with the value 1; and"
609 msgstr ""
610
611 #. type: Plain text
612 #: build/C/man7/feature_test_macros.7:413
613 msgid "B<_POSIX_C_SOURCE> is defined with one of the following values:"
614 msgstr ""
615
616 #. type: Plain text
617 #: build/C/man7/feature_test_macros.7:419
618 msgid "2, if B<XOPEN_SOURCE> is defined with a value less than 500;"
619 msgstr ""
620
621 #. type: Plain text
622 #: build/C/man7/feature_test_macros.7:425
623 msgid ""
624 "199506L, if B<XOPEN_SOURCE> is defined with a value greater than or equal to "
625 "500 and less than 600; or"
626 msgstr ""
627
628 #. type: Plain text
629 #: build/C/man7/feature_test_macros.7:430
630 msgid ""
631 "(since glibc 2.4) 200112L, if B<XOPEN_SOURCE> is defined with a value "
632 "greater than or equal to 600 and less than 700."
633 msgstr ""
634
635 #. type: Plain text
636 #: build/C/man7/feature_test_macros.7:436
637 msgid ""
638 "(Since glibc 2.10)  200809L, if B<XOPEN_SOURCE> is defined with a value "
639 "greater than or equal to 700."
640 msgstr ""
641
642 #. type: Plain text
643 #: build/C/man7/feature_test_macros.7:441
644 msgid ""
645 "Older versions of glibc do not know about the values 200112L and 200809L for "
646 "B<_POSIX_C_SOURCE>, and the setting of this macro will depend on the glibc "
647 "version."
648 msgstr ""
649
650 #. type: Plain text
651 #: build/C/man7/feature_test_macros.7:450
652 msgid ""
653 "If B<_XOPEN_SOURCE> is undefined, then the setting of B<_POSIX_C_SOURCE> "
654 "depends on the glibc version: 199506L, in glibc versions before 2.4; "
655 "200112L, in glibc 2.4 to 2.9; and 200809L, since glibc 2.10."
656 msgstr ""
657
658 #. type: Plain text
659 #: build/C/man7/feature_test_macros.7:454
660 msgid "Multiple macros can be defined; the results are additive."
661 msgstr ""
662
663 #. type: SH
664 #: build/C/man7/feature_test_macros.7:454 build/C/man2/intro.2:70 build/C/man3/intro.3:87 build/C/man7/suffixes.7:277
665 #, no-wrap
666 msgid "CONFORMING TO"
667 msgstr ""
668
669 #. type: Plain text
670 #: build/C/man7/feature_test_macros.7:462
671 msgid ""
672 "POSIX.1 specifies B<_POSIX_C_SOURCE>, B<_POSIX_SOURCE>, and "
673 "B<_XOPEN_SOURCE>.  B<_XOPEN_SOURCE_EXTENDED> was specified by XPG4v2 (aka "
674 "SUSv1)."
675 msgstr ""
676
677 #. type: Plain text
678 #: build/C/man7/feature_test_macros.7:466
679 msgid ""
680 "B<_FILE_OFFSET_BITS> is not specified by any standard, but is employed on "
681 "some other implementations."
682 msgstr ""
683
684 #. type: Plain text
685 #: build/C/man7/feature_test_macros.7:476
686 msgid ""
687 "B<_BSD_SOURCE>, B<_SVID_SOURCE>, B<_ATFILE_SOURCE>, B<_GNU_SOURCE>, "
688 "B<_FORTIFY_SOURCE>, B<_REENTRANT>, and B<_THREAD_SAFE> are specific to Linux "
689 "(glibc)."
690 msgstr ""
691
692 #. type: SH
693 #: build/C/man7/feature_test_macros.7:476 build/C/man1/intro.1:48 build/C/man2/intro.2:75 build/C/man3/intro.3:92 build/C/man4/intro.4:33 build/C/man5/intro.5:33 build/C/man6/intro.6:32 build/C/man7/intro.7:36 build/C/man8/intro.8:44 build/C/man7/man.7:479 build/C/man5/proc.5:3517 build/C/man2/unimplemented.2:40
694 #, no-wrap
695 msgid "NOTES"
696 msgstr ""
697
698 #. type: Plain text
699 #: build/C/man7/feature_test_macros.7:483
700 msgid ""
701 "I<E<lt>features.hE<gt>> is a Linux/glibc-specific header file.  Other "
702 "systems have an analogous file, but typically with a different name.  This "
703 "header file is automatically included by other header files as required: it "
704 "is not necessary to explicitly include it in order to employ feature test "
705 "macros."
706 msgstr ""
707
708 #. type: Plain text
709 #: build/C/man7/feature_test_macros.7:495
710 msgid ""
711 "According to which of the above feature test macros are defined, "
712 "I<E<lt>features.hE<gt>> internally defines various other macros that are "
713 "checked by other glibc header files.  These macros have names prefixed by "
714 "two underscores (e.g., B<__USE_MISC>).  Programs should I<never> define "
715 "these macros directly: instead, the appropriate feature test macro(s) from "
716 "the list above should be employed."
717 msgstr ""
718
719 #. type: SH
720 #: build/C/man7/feature_test_macros.7:495 build/C/man7/man-pages.7:607
721 #, no-wrap
722 msgid "EXAMPLE"
723 msgstr ""
724
725 #. type: Plain text
726 #: build/C/man7/feature_test_macros.7:501
727 msgid ""
728 "The program below can be used to explore how the various feature test macros "
729 "are set depending on the glibc version and what feature test macros are "
730 "explicitly set.  The following shell session, on a system with glibc 2.10, "
731 "shows some examples of what we would see:"
732 msgstr ""
733
734 #. type: Plain text
735 #: build/C/man7/feature_test_macros.7:528
736 #, no-wrap
737 msgid ""
738 "$ B<cc ftm.c>\n"
739 "$ B<./a.out>\n"
740 "_POSIX_SOURCE defined\n"
741 "_POSIX_C_SOURCE defined: 200809L\n"
742 "_BSD_SOURCE defined\n"
743 "_SVID_SOURCE defined\n"
744 "_ATFILE_SOURCE defined\n"
745 "$ B<cc -D_XOPEN_SOURCE=500 ftm.c>\n"
746 "$ B<./a.out>\n"
747 "_POSIX_SOURCE defined\n"
748 "_POSIX_C_SOURCE defined: 199506L\n"
749 "_XOPEN_SOURCE defined: 500\n"
750 "$ B<cc -D_GNU_SOURCE ftm.c>\n"
751 "$ B<./a.out>\n"
752 "_POSIX_SOURCE defined\n"
753 "_POSIX_C_SOURCE defined: 200809L\n"
754 "_ISOC99_SOURCE defined\n"
755 "_XOPEN_SOURCE defined: 700\n"
756 "_XOPEN_SOURCE_EXTENDED defined\n"
757 "_LARGEFILE64_SOURCE defined\n"
758 "_BSD_SOURCE defined\n"
759 "_SVID_SOURCE defined\n"
760 "_ATFILE_SOURCE defined\n"
761 "_GNU_SOURCE defined\n"
762 msgstr ""
763
764 #. type: SS
765 #: build/C/man7/feature_test_macros.7:530
766 #, no-wrap
767 msgid "Program source"
768 msgstr ""
769
770 #. type: Plain text
771 #: build/C/man7/feature_test_macros.7:534
772 #, no-wrap
773 msgid "/* ftm.c */\n"
774 msgstr ""
775
776 #. type: Plain text
777 #: build/C/man7/feature_test_macros.7:538
778 #, no-wrap
779 msgid ""
780 "#include E<lt>stdio.hE<gt>\n"
781 "#include E<lt>unistd.hE<gt>\n"
782 "#include E<lt>stdlib.hE<gt>\n"
783 msgstr ""
784
785 #. type: Plain text
786 #: build/C/man7/feature_test_macros.7:545
787 #, no-wrap
788 msgid ""
789 "int\n"
790 "main(int argc, char *argv[])\n"
791 "{\n"
792 "#ifdef _POSIX_SOURCE\n"
793 "    printf(\"_POSIX_SOURCE defined\\en\");\n"
794 "#endif\n"
795 msgstr ""
796
797 #. type: Plain text
798 #: build/C/man7/feature_test_macros.7:549
799 #, no-wrap
800 msgid ""
801 "#ifdef _POSIX_C_SOURCE\n"
802 "    printf(\"_POSIX_C_SOURCE defined: %ldL\\en\", (long) _POSIX_C_SOURCE);\n"
803 "#endif\n"
804 msgstr ""
805
806 #. type: Plain text
807 #: build/C/man7/feature_test_macros.7:553
808 #, no-wrap
809 msgid ""
810 "#ifdef _ISOC99_SOURCE\n"
811 "    printf(\"_ISOC99_SOURCE defined\\en\");\n"
812 "#endif\n"
813 msgstr ""
814
815 #. type: Plain text
816 #: build/C/man7/feature_test_macros.7:557
817 #, no-wrap
818 msgid ""
819 "#ifdef _XOPEN_SOURCE\n"
820 "    printf(\"_XOPEN_SOURCE defined: %d\\en\", _XOPEN_SOURCE);\n"
821 "#endif\n"
822 msgstr ""
823
824 #. type: Plain text
825 #: build/C/man7/feature_test_macros.7:561
826 #, no-wrap
827 msgid ""
828 "#ifdef _XOPEN_SOURCE_EXTENDED\n"
829 "    printf(\"_XOPEN_SOURCE_EXTENDED defined\\en\");\n"
830 "#endif\n"
831 msgstr ""
832
833 #. type: Plain text
834 #: build/C/man7/feature_test_macros.7:565
835 #, no-wrap
836 msgid ""
837 "#ifdef _LARGEFILE64_SOURCE\n"
838 "    printf(\"_LARGEFILE64_SOURCE defined\\en\");\n"
839 "#endif\n"
840 msgstr ""
841
842 #. type: Plain text
843 #: build/C/man7/feature_test_macros.7:569
844 #, no-wrap
845 msgid ""
846 "#ifdef _FILE_OFFSET_BITS\n"
847 "    printf(\"_FILE_OFFSET_BITS defined: %d\\en\", _FILE_OFFSET_BITS);\n"
848 "#endif\n"
849 msgstr ""
850
851 #. type: Plain text
852 #: build/C/man7/feature_test_macros.7:573
853 #, no-wrap
854 msgid ""
855 "#ifdef _BSD_SOURCE\n"
856 "    printf(\"_BSD_SOURCE defined\\en\");\n"
857 "#endif\n"
858 msgstr ""
859
860 #. type: Plain text
861 #: build/C/man7/feature_test_macros.7:577
862 #, no-wrap
863 msgid ""
864 "#ifdef _SVID_SOURCE\n"
865 "    printf(\"_SVID_SOURCE defined\\en\");\n"
866 "#endif\n"
867 msgstr ""
868
869 #. type: Plain text
870 #: build/C/man7/feature_test_macros.7:581
871 #, no-wrap
872 msgid ""
873 "#ifdef _ATFILE_SOURCE\n"
874 "    printf(\"_ATFILE_SOURCE defined\\en\");\n"
875 "#endif\n"
876 msgstr ""
877
878 #. type: Plain text
879 #: build/C/man7/feature_test_macros.7:585
880 #, no-wrap
881 msgid ""
882 "#ifdef _GNU_SOURCE\n"
883 "    printf(\"_GNU_SOURCE defined\\en\");\n"
884 "#endif\n"
885 msgstr ""
886
887 #. type: Plain text
888 #: build/C/man7/feature_test_macros.7:589
889 #, no-wrap
890 msgid ""
891 "#ifdef _REENTRANT\n"
892 "    printf(\"_REENTRANT defined\\en\");\n"
893 "#endif\n"
894 msgstr ""
895
896 #. type: Plain text
897 #: build/C/man7/feature_test_macros.7:593
898 #, no-wrap
899 msgid ""
900 "#ifdef _THREAD_SAFE\n"
901 "    printf(\"_THREAD_SAFE defined\\en\");\n"
902 "#endif\n"
903 msgstr ""
904
905 #. type: Plain text
906 #: build/C/man7/feature_test_macros.7:597
907 #, no-wrap
908 msgid ""
909 "#ifdef _FORTIFY_SOURCE\n"
910 "    printf(\"_FORTIFY_SOURCE defined\\en\");\n"
911 "#endif\n"
912 msgstr ""
913
914 #. type: Plain text
915 #: build/C/man7/feature_test_macros.7:600
916 #, no-wrap
917 msgid ""
918 "    exit(EXIT_SUCCESS);\n"
919 "}\n"
920 msgstr ""
921
922 #. type: Sh
923 #: build/C/man7/feature_test_macros.7:601 build/C/man1/intro.1:302 build/C/man2/intro.2:89 build/C/man3/intro.3:97 build/C/man4/intro.4:38 build/C/man5/intro.5:38 build/C/man7/intro.7:41 build/C/man7/libc.7:99 build/C/man7/mailaddr.7:117 build/C/man7/man-pages.7:614 build/C/man7/man.7:560 build/C/man7/mdoc.7:428 build/C/man7/posixoptions.7:854 build/C/man5/proc.5:3530 build/C/man7/standards.7:272 build/C/man7/suffixes.7:281 build/C/man2/unimplemented.2:64 build/C/man7/mdoc.samples.7:2952
924 #, no-wrap
925 msgid "SEE ALSO"
926 msgstr ""
927
928 #. type: Plain text
929 #: build/C/man7/feature_test_macros.7:604
930 msgid "B<libc>(7), B<standards>(7)"
931 msgstr ""
932
933 #.  But beware: the info libc document is out of date (Jul 07, mtk)
934 #. type: Plain text
935 #: build/C/man7/feature_test_macros.7:608
936 msgid "The section \"Feature Test Macros\" under I<info libc>."
937 msgstr ""
938
939 #. type: Plain text
940 #: build/C/man7/feature_test_macros.7:610
941 msgid "I</usr/include/features.h>"
942 msgstr ""
943
944 #. type: Sh
945 #: build/C/man7/feature_test_macros.7:610 build/C/man1/intro.1:304 build/C/man2/intro.2:112 build/C/man3/intro.3:110 build/C/man4/intro.4:40 build/C/man5/intro.5:40 build/C/man6/intro.6:37 build/C/man7/intro.7:43 build/C/man8/intro.8:49 build/C/man7/libc.7:104 build/C/man7/mailaddr.7:127 build/C/man7/man-pages.7:621 build/C/man7/man.7:572 build/C/man7/mdoc.7:433 build/C/man7/operator.7:65 build/C/man7/posixoptions.7:857 build/C/man5/proc.5:3561 build/C/man7/standards.7:276 build/C/man7/suffixes.7:284 build/C/man3/undocumented.3:183 build/C/man2/unimplemented.2:66 build/C/man7/units.7:130 build/C/man7/mdoc.samples.7:2957
946 #, no-wrap
947 msgid "COLOPHON"
948 msgstr ""
949
950 #. type: Plain text
951 #: build/C/man7/feature_test_macros.7:617 build/C/man1/intro.1:311 build/C/man2/intro.2:119 build/C/man3/intro.3:117 build/C/man4/intro.4:47 build/C/man5/intro.5:47 build/C/man6/intro.6:44 build/C/man7/intro.7:50 build/C/man8/intro.8:56 build/C/man7/libc.7:111 build/C/man7/mailaddr.7:134 build/C/man7/man-pages.7:628 build/C/man7/man.7:579 build/C/man7/operator.7:72 build/C/man7/posixoptions.7:864 build/C/man5/proc.5:3568 build/C/man7/standards.7:283 build/C/man7/suffixes.7:291 build/C/man3/undocumented.3:190 build/C/man2/unimplemented.2:73 build/C/man7/units.7:137
952 msgid ""
953 "This page is part of release 3.54 of the Linux I<man-pages> project.  A "
954 "description of the project, and information about reporting bugs, can be "
955 "found at \\%http://www.kernel.org/doc/man-pages/."
956 msgstr ""
957
958 #. type: TH
959 #: build/C/man1/intro.1:28 build/C/man2/intro.2:29 build/C/man3/intro.3:26 build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29
960 #, no-wrap
961 msgid "INTRO"
962 msgstr ""
963
964 #. type: TH
965 #: build/C/man1/intro.1:28
966 #, no-wrap
967 msgid "2007-11-15"
968 msgstr ""
969
970 #. type: TH
971 #: build/C/man1/intro.1:28 build/C/man7/mailaddr.7:27
972 #, no-wrap
973 msgid "Linux User's Manual"
974 msgstr ""
975
976 #. type: Plain text
977 #: build/C/man1/intro.1:31
978 msgid "intro - introduction to user commands"
979 msgstr ""
980
981 #. type: Plain text
982 #: build/C/man1/intro.1:35
983 msgid ""
984 "Section 1 of the manual describes user commands and tools, for example, file "
985 "manipulation tools, shells, compilers, web browsers, file and image viewers "
986 "and editors, and so on."
987 msgstr ""
988
989 #. type: Plain text
990 #: build/C/man1/intro.1:48
991 msgid ""
992 "All commands yield a status value on termination.  This value can be tested "
993 "(e.g., in most shells the variable I<$?> contains the status of the last "
994 "executed command)  to see whether the command completed successfully.  A "
995 "zero exit status is conventionally used to indicate success, and a nonzero "
996 "status means that the command was unsuccessful.  (Details of the exit status "
997 "can be found in B<wait>(2).)  A nonzero exit status can be in the range 1 to "
998 "255, and some commands use different nonzero status values to indicate the "
999 "reason why the command failed."
1000 msgstr ""
1001
1002 #. type: Plain text
1003 #: build/C/man1/intro.1:52
1004 msgid ""
1005 "Linux is a flavor of UNIX, and as a first approximation all user commands "
1006 "under UNIX work precisely the same under Linux (and FreeBSD and lots of "
1007 "other UNIX-like systems)."
1008 msgstr ""
1009
1010 #. type: Plain text
1011 #: build/C/man1/intro.1:62
1012 msgid ""
1013 "Under Linux there are GUIs (graphical user interfaces), where you can point "
1014 "and click and drag, and hopefully get work done without first reading lots "
1015 "of documentation.  The traditional UNIX environment is a CLI (command line "
1016 "interface), where you type commands to tell the computer what to do.  That "
1017 "is faster and more powerful, but requires finding out what the commands "
1018 "are.  Below a bare minimum, to get started."
1019 msgstr ""
1020
1021 #. type: SS
1022 #: build/C/man1/intro.1:62
1023 #, no-wrap
1024 msgid "Login"
1025 msgstr ""
1026
1027 #. type: Plain text
1028 #: build/C/man1/intro.1:76
1029 msgid ""
1030 "In order to start working, you probably first have to login, that is, give "
1031 "your username and password.  See also B<login>(1).  The program I<login> now "
1032 "starts a I<shell> (command interpreter) for you.  In case of a graphical "
1033 "login, you get a screen with menus or icons and a mouse click will start a "
1034 "shell in a window.  See also B<xterm>(1)."
1035 msgstr ""
1036
1037 #. type: SS
1038 #: build/C/man1/intro.1:76
1039 #, no-wrap
1040 msgid "The shell"
1041 msgstr ""
1042
1043 #. type: Plain text
1044 #: build/C/man1/intro.1:91
1045 msgid ""
1046 "One types commands to the I<shell>, the command interpreter.  It is not "
1047 "built-in, but is just a program and you can change your shell.  Everybody "
1048 "has her own favorite one.  The standard one is called I<sh>.  See also "
1049 "B<ash>(1), B<bash>(1), B<csh>(1), B<zsh>(1), B<chsh>(1)."
1050 msgstr ""
1051
1052 #. type: Plain text
1053 #: build/C/man1/intro.1:93
1054 msgid "A session might go like"
1055 msgstr ""
1056
1057 #. type: Plain text
1058 #: build/C/man1/intro.1:108
1059 #, no-wrap
1060 msgid ""
1061 "B<knuth login: >I<aeb>\n"
1062 "B<Password: >I<********>\n"
1063 "B<% >I<date>\n"
1064 "Tue Aug  6 23:50:44 CEST 2002\n"
1065 "B<% >I<cal>\n"
1066 "     August 2002\n"
1067 "Su Mo Tu We Th Fr Sa\n"
1068 "             1  2  3\n"
1069 " 4  5  6  7  8  9 10\n"
1070 "11 12 13 14 15 16 17\n"
1071 "18 19 20 21 22 23 24\n"
1072 "25 26 27 28 29 30 31\n"
1073 msgstr ""
1074
1075 #. type: Plain text
1076 #: build/C/man1/intro.1:135
1077 #, no-wrap
1078 msgid ""
1079 "B<% >I<ls>\n"
1080 "bin  tel\n"
1081 "B<% >I<ls -l>\n"
1082 "total 2\n"
1083 "drwxrwxr-x   2 aeb       1024 Aug  6 23:51 bin\n"
1084 "-rw-rw-r--   1 aeb         37 Aug  6 23:52 tel\n"
1085 "B<% >I<cat tel>\n"
1086 "maja    0501-1136285\n"
1087 "peter   0136-7399214\n"
1088 "B<% >I<cp tel tel2>\n"
1089 "B<% >I<ls -l>\n"
1090 "total 3\n"
1091 "drwxr-xr-x   2 aeb       1024 Aug  6 23:51 bin\n"
1092 "-rw-r--r--   1 aeb         37 Aug  6 23:52 tel\n"
1093 "-rw-r--r--   1 aeb         37 Aug  6 23:53 tel2\n"
1094 "B<% >I<mv tel tel1>\n"
1095 "B<% >I<ls -l>\n"
1096 "total 3\n"
1097 "drwxr-xr-x   2 aeb       1024 Aug  6 23:51 bin\n"
1098 "-rw-r--r--   1 aeb         37 Aug  6 23:52 tel1\n"
1099 "-rw-r--r--   1 aeb         37 Aug  6 23:53 tel2\n"
1100 "B<% >I<diff tel1 tel2>\n"
1101 "B<% >I<rm tel1>\n"
1102 "B<% >I<grep maja tel2>\n"
1103 "maja    0501-1136285\n"
1104 "B<% >\n"
1105 msgstr ""
1106
1107 #. type: Plain text
1108 #: build/C/man1/intro.1:147
1109 msgid ""
1110 "and here typing Control-D ended the session.  The B<% > here was the command "
1111 "prompt\\(emit is the shell's way of indicating that it is ready for the next "
1112 "command.  The prompt can be customized in lots of ways, and one might "
1113 "include stuff like username, machine name, current directory, time, and so "
1114 "on.  An assignment PS1=\"What next, master? \" would change the prompt as "
1115 "indicated."
1116 msgstr ""
1117
1118 #. type: Plain text
1119 #: build/C/man1/intro.1:153
1120 msgid ""
1121 "We see that there are commands I<date> (that gives date and time), and "
1122 "I<cal> (that gives a calendar)."
1123 msgstr ""
1124
1125 #. type: Plain text
1126 #: build/C/man1/intro.1:169
1127 msgid ""
1128 "The command I<ls> lists the contents of the current directory\\(emit tells "
1129 "you what files you have.  With a I<-l> option it gives a long listing, that "
1130 "includes the owner and size and date of the file, and the permissions people "
1131 "have for reading and/or changing the file.  For example, the file \"tel\" "
1132 "here is 37 bytes long, owned by aeb and the owner can read and write it, "
1133 "others can only read it.  Owner and permissions can be changed by the "
1134 "commands I<chown> and I<chmod>."
1135 msgstr ""
1136
1137 #. type: Plain text
1138 #: build/C/man1/intro.1:176
1139 msgid ""
1140 "The command I<cat> will show the contents of a file.  (The name is from "
1141 "\"concatenate and print\": all files given as parameters are concatenated "
1142 "and sent to \"standard output\", here the terminal screen.)"
1143 msgstr ""
1144
1145 #. type: Plain text
1146 #: build/C/man1/intro.1:183
1147 msgid ""
1148 "The command I<cp> (from \"copy\") will copy a file.  On the other hand, the "
1149 "command I<mv> (from \"move\") only renames it."
1150 msgstr ""
1151
1152 #. type: Plain text
1153 #: build/C/man1/intro.1:188
1154 msgid ""
1155 "The command I<diff> lists the differences between two files.  Here there was "
1156 "no output because there were no differences."
1157 msgstr ""
1158
1159 #. type: Plain text
1160 #: build/C/man1/intro.1:194
1161 msgid ""
1162 "The command I<rm> (from \"remove\") deletes the file, and be careful! it is "
1163 "gone.  No wastepaper basket or anything.  Deleted means lost."
1164 msgstr ""
1165
1166 #. type: Plain text
1167 #: build/C/man1/intro.1:199
1168 msgid ""
1169 "The command I<grep> (from \"g/re/p\") finds occurrences of a string in one "
1170 "or more files.  Here it finds Maja's telephone number."
1171 msgstr ""
1172
1173 #. type: SS
1174 #: build/C/man1/intro.1:199
1175 #, no-wrap
1176 msgid "Pathnames and the current directory"
1177 msgstr ""
1178
1179 #. type: Plain text
1180 #: build/C/man1/intro.1:211
1181 msgid ""
1182 "Files live in a large tree, the file hierarchy.  Each has a I<pathname> "
1183 "describing the path from the root of the tree (which is called /)  to the "
1184 "file.  For example, such a full pathname might be /home/aeb/tel.  Always "
1185 "using full pathnames would be inconvenient, and the name of a file in the "
1186 "current directory may be abbreviated by giving only the last component.  "
1187 "That is why \"/home/aeb/tel\" can be abbreviated to \"tel\" when the current "
1188 "directory is \"/home/aeb\"."
1189 msgstr ""
1190
1191 #. type: Plain text
1192 #: build/C/man1/intro.1:215
1193 msgid "The command I<pwd> prints the current directory."
1194 msgstr ""
1195
1196 #. type: Plain text
1197 #: build/C/man1/intro.1:220
1198 msgid ""
1199 "The command I<cd> changes the current directory.  Try \"cd /\" and \"pwd\" "
1200 "and \"cd\" and \"pwd\"."
1201 msgstr ""
1202
1203 #. type: SS
1204 #: build/C/man1/intro.1:220
1205 #, no-wrap
1206 msgid "Directories"
1207 msgstr ""
1208
1209 #. type: Plain text
1210 #: build/C/man1/intro.1:224
1211 msgid "The command I<mkdir> makes a new directory."
1212 msgstr ""
1213
1214 #. type: Plain text
1215 #: build/C/man1/intro.1:228
1216 msgid ""
1217 "The command I<rmdir> removes a directory if it is empty, and complains "
1218 "otherwise."
1219 msgstr ""
1220
1221 #. type: Plain text
1222 #: build/C/man1/intro.1:240
1223 msgid ""
1224 "The command I<find> (with a rather baroque syntax) will find files with "
1225 "given name or other properties.  For example, \"find . -name tel\" would "
1226 "find the file \"tel\" starting in the present directory (which is called "
1227 "\".\").  And \"find / -name tel\" would do the same, but starting at the "
1228 "root of the tree.  Large searches on a multi-GB disk will be time-consuming, "
1229 "and it may be better to use B<locate>(1)."
1230 msgstr ""
1231
1232 #. type: SS
1233 #: build/C/man1/intro.1:240
1234 #, no-wrap
1235 msgid "Disks and filesystems"
1236 msgstr ""
1237
1238 #. type: Plain text
1239 #: build/C/man1/intro.1:251
1240 msgid ""
1241 "The command I<mount> will attach the filesystem found on some disk (or "
1242 "floppy, or CDROM or so)  to the big filesystem hierarchy.  And I<umount> "
1243 "detaches it again.  The command I<df> will tell you how much of your disk is "
1244 "still free."
1245 msgstr ""
1246
1247 #. type: SS
1248 #: build/C/man1/intro.1:251
1249 #, no-wrap
1250 msgid "Processes"
1251 msgstr ""
1252
1253 #. type: Plain text
1254 #: build/C/man1/intro.1:269
1255 msgid ""
1256 "On a UNIX system many user and system processes run simultaneously.  The one "
1257 "you are talking to runs in the I<foreground>, the others in the "
1258 "I<background>.  The command I<ps> will show you which processes are active "
1259 "and what numbers these processes have.  The command I<kill> allows you to "
1260 "get rid of them.  Without option this is a friendly request: please go "
1261 "away.  And \"kill -9\" followed by the number of the process is an immediate "
1262 "kill.  Foreground processes can often be killed by typing Control-C."
1263 msgstr ""
1264
1265 #. type: SS
1266 #: build/C/man1/intro.1:269
1267 #, no-wrap
1268 msgid "Getting information"
1269 msgstr ""
1270
1271 #. type: Plain text
1272 #: build/C/man1/intro.1:282
1273 msgid ""
1274 "There are thousands of commands, each with many options.  Traditionally "
1275 "commands are documented on I<man pages>, (like this one), so that the "
1276 "command \"man kill\" will document the use of the command \"kill\" (and "
1277 "\"man man\" document the command \"man\").  The program I<man> sends the "
1278 "text through some I<pager>, usually I<less>.  Hit the space bar to get the "
1279 "next page, hit q to quit."
1280 msgstr ""
1281
1282 #. type: Plain text
1283 #: build/C/man1/intro.1:290
1284 msgid ""
1285 "In documentation it is customary to refer to man pages by giving the name "
1286 "and section number, as in B<man>(1).  Man pages are terse, and allow you to "
1287 "find quickly some forgotten detail.  For newcomers an introductory text with "
1288 "more examples and explanations is useful."
1289 msgstr ""
1290
1291 #. type: Plain text
1292 #: build/C/man1/intro.1:294
1293 msgid ""
1294 "A lot of GNU/FSF software is provided with info files.  Type \"info info\" "
1295 "for an introduction on the use of the program \"info\"."
1296 msgstr ""
1297
1298 #
1299 #.  Actual examples? Separate section for each of cat, cp, ...?
1300 #.  gzip, bzip2, tar, rpm
1301 #. type: Plain text
1302 #: build/C/man1/intro.1:302
1303 msgid ""
1304 "Special topics are often treated in HOWTOs.  Look in "
1305 "I</usr/share/doc/howto/en> and use a browser if you find HTML files there."
1306 msgstr ""
1307
1308 #. type: Plain text
1309 #: build/C/man1/intro.1:304 build/C/man4/intro.4:40 build/C/man5/intro.5:40 build/C/man7/intro.7:43
1310 msgid "B<standards>(7)"
1311 msgstr ""
1312
1313 #. type: TH
1314 #: build/C/man2/intro.2:29 build/C/man3/intro.3:26
1315 #, no-wrap
1316 msgid "2010-11-11"
1317 msgstr ""
1318
1319 #. type: Plain text
1320 #: build/C/man2/intro.2:32
1321 msgid "intro - introduction to system calls"
1322 msgstr ""
1323
1324 #. type: Plain text
1325 #: build/C/man2/intro.2:42
1326 msgid ""
1327 "Section 2 of the manual describes the Linux system calls.  A system call is "
1328 "an entry point into the Linux kernel.  Usually, system calls are not invoked "
1329 "directly: instead, most system calls have corresponding C library wrapper "
1330 "functions which perform the steps required (e.g., trapping to kernel mode) "
1331 "in order to invoke the system call.  Thus, making a system call looks the "
1332 "same as invoking a normal library function."
1333 msgstr ""
1334
1335 #. type: Plain text
1336 #: build/C/man2/intro.2:45
1337 msgid "For a list of the Linux system calls, see B<syscalls>(2)."
1338 msgstr ""
1339
1340 #. type: SH
1341 #: build/C/man2/intro.2:45 build/C/man2/unimplemented.2:35
1342 #, no-wrap
1343 msgid "RETURN VALUE"
1344 msgstr ""
1345
1346 #. type: Plain text
1347 #: build/C/man2/intro.2:54
1348 msgid ""
1349 "On error, most system calls return a negative error number (i.e., the "
1350 "negated value of one of the constants described in B<errno>(3)).  The C "
1351 "library wrapper hides this detail from the caller: when a system call "
1352 "returns a negative value, the wrapper copies the absolute value into the "
1353 "I<errno> variable, and returns -1 as the return value of the wrapper."
1354 msgstr ""
1355
1356 #. type: Plain text
1357 #: build/C/man2/intro.2:59
1358 msgid ""
1359 "The value returned by a successful system call depends on the call.  Many "
1360 "system calls return 0 on success, but some can return nonzero values from a "
1361 "successful call.  The details are described in the individual manual pages."
1362 msgstr ""
1363
1364 #. type: Plain text
1365 #: build/C/man2/intro.2:70
1366 msgid ""
1367 "In some cases, the programmer must define a feature test macro in order to "
1368 "obtain the declaration of a system call from the header file specified in "
1369 "the man page SYNOPSIS section.  (Where required, these feature test macros "
1370 "must be defined before including I<any> header files.)  In such cases, the "
1371 "required macro is described in the man page.  For further information on "
1372 "feature test macros, see B<feature_test_macros>(7)."
1373 msgstr ""
1374
1375 #. type: Plain text
1376 #: build/C/man2/intro.2:75 build/C/man3/intro.3:92
1377 msgid ""
1378 "Certain terms and abbreviations are used to indicate UNIX variants and "
1379 "standards to which calls in this section conform.  See B<standards>(7)."
1380 msgstr ""
1381
1382 #. type: SS
1383 #: build/C/man2/intro.2:76
1384 #, no-wrap
1385 msgid "Calling directly"
1386 msgstr ""
1387
1388 #. type: Plain text
1389 #: build/C/man2/intro.2:85
1390 msgid ""
1391 "In most cases, it is unnecessary to invoke a system call directly, but there "
1392 "are times when the Standard C library does not implement a nice wrapper "
1393 "function for you.  In this case, the programmer must manually invoke the "
1394 "system call using B<syscall>(2).  Historically, this was also possible using "
1395 "one of the _syscall macros described in B<_syscall>(2)."
1396 msgstr ""
1397
1398 #. type: SS
1399 #: build/C/man2/intro.2:85 build/C/man3/intro.3:93 build/C/man4/intro.4:34 build/C/man5/intro.5:34 build/C/man6/intro.6:33 build/C/man7/intro.7:37 build/C/man8/intro.8:45
1400 #, no-wrap
1401 msgid "Authors and copyright conditions"
1402 msgstr ""
1403
1404 #. type: Plain text
1405 #: build/C/man2/intro.2:89 build/C/man3/intro.3:97 build/C/man4/intro.4:38 build/C/man5/intro.5:38 build/C/man6/intro.6:37 build/C/man7/intro.7:41 build/C/man8/intro.8:49
1406 msgid ""
1407 "Look at the header of the manual page source for the author(s) and copyright "
1408 "conditions.  Note that these can be different from page to page!"
1409 msgstr ""
1410
1411 #. type: Plain text
1412 #: build/C/man2/intro.2:112
1413 msgid ""
1414 "B<_syscall>(2), B<syscall>(2), B<syscalls>(2), B<errno>(3), B<intro>(3), "
1415 "B<capabilities>(7), B<credentials>(7), B<feature_test_macros>(7), "
1416 "B<mq_overview>(7), B<path_resolution>(7), B<pipe>(7), B<pty>(7), "
1417 "B<sem_overview>(7), B<shm_overview>(7), B<signal>(7), B<socket>(7), "
1418 "B<standards>(7), B<svipc>(7), B<symlink>(7), B<time>(7)"
1419 msgstr ""
1420
1421 #. type: Plain text
1422 #: build/C/man3/intro.3:29
1423 msgid "intro - introduction to library functions"
1424 msgstr ""
1425
1426 #. type: Plain text
1427 #: build/C/man3/intro.3:33
1428 msgid ""
1429 "Section 3 of the manual describes all library functions excluding the "
1430 "library functions (system call wrappers) described in section 2, which "
1431 "implement system calls."
1432 msgstr ""
1433
1434 #. type: Plain text
1435 #: build/C/man3/intro.3:50
1436 msgid ""
1437 "Many of the functions described in the section are part of the Standard C "
1438 "Library (I<libc>).  Some functions are part of other libraries (e.g., the "
1439 "math library, I<libm>, or the real-time library, I<librt>)  in which case "
1440 "the manual page will indicate the linker option needed to link against the "
1441 "required library (e.g., I<-lm> and I<-lrt>, respectively, for the "
1442 "aforementioned libraries)."
1443 msgstr ""
1444
1445 #
1446 #.  There
1447 #.  are various function groups which can be identified by a letter which
1448 #.  is appended to the chapter number:
1449 #.  .IP (3C)
1450 #.  These functions, the functions from chapter 2 and from chapter 3S are
1451 #.  contained in the C standard library libc, which will be used by
1452 #.  .BR cc (1)
1453 #.  by default.
1454 #.  .IP (3S)
1455 #.  These functions are parts of the
1456 #.  .BR stdio (3)
1457 #.  library.  They are contained in the standard C library libc.
1458 #.  .IP (3M)
1459 #.  These functions are contained in the arithmetic library libm.  They are
1460 #.  used by the
1461 #.  .BR f77 (1)
1462 #.  FORTRAN compiler by default, but not by the
1463 #.  .BR cc (1)
1464 #.  C compiler, which needs the option \fI\-lm\fP.
1465 #.  .IP (3F)
1466 #.  These functions are part of the FORTRAN library libF77.  There are no
1467 #.  special compiler flags needed to use these functions.
1468 #.  .IP (3X)
1469 #.  Various special libraries.  The manual pages documenting their functions
1470 #.  specify the library names.
1471 #. type: Plain text
1472 #: build/C/man3/intro.3:87
1473 msgid ""
1474 "In some cases, the programmer must define a feature test macro in order to "
1475 "obtain the declaration of a function from the header file specified in the "
1476 "man page SYNOPSIS section.  (Where required, these feature test macros must "
1477 "be defined before including I<any> header files.)  In such cases, the "
1478 "required macro is described in the man page.  For further information on "
1479 "feature test macros, see B<feature_test_macros>(7)."
1480 msgstr ""
1481
1482 #. type: Plain text
1483 #: build/C/man3/intro.3:110
1484 msgid ""
1485 "B<intro>(2), B<errno>(3), B<capabilities>(7), B<credentials>(7), "
1486 "B<environ>(7), B<feature_test_macros>(7), B<libc>(7), B<math_error>(7), "
1487 "B<path_resolution>(7), B<pthreads>(7), B<signal>(7), B<standards>(7)"
1488 msgstr ""
1489
1490 #. type: TH
1491 #: build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29
1492 #, no-wrap
1493 msgid "2007-10-23"
1494 msgstr ""
1495
1496 #. type: Plain text
1497 #: build/C/man4/intro.4:29
1498 msgid "intro - introduction to special files"
1499 msgstr ""
1500
1501 #. type: Plain text
1502 #: build/C/man4/intro.4:31
1503 msgid "Section 4 of the manual describes special files (devices)."
1504 msgstr ""
1505
1506 #. type: Sh
1507 #: build/C/man4/intro.4:31 build/C/man7/mailaddr.7:113 build/C/man7/man.7:475 build/C/man7/mdoc.7:411 build/C/man7/mdoc.samples.7:2874
1508 #, no-wrap
1509 msgid "FILES"
1510 msgstr ""
1511
1512 #. type: Plain text
1513 #: build/C/man4/intro.4:33
1514 msgid "/dev/* \\(em device files"
1515 msgstr ""
1516
1517 #. type: Plain text
1518 #: build/C/man5/intro.5:30
1519 msgid "intro - introduction to file formats"
1520 msgstr ""
1521
1522 #. type: Plain text
1523 #: build/C/man5/intro.5:33
1524 msgid ""
1525 "Section 5 of the manual describes various file formats and protocols, and "
1526 "the corresponding C structures, if any."
1527 msgstr ""
1528
1529 #. type: Plain text
1530 #: build/C/man6/intro.6:29
1531 msgid "intro - introduction to games"
1532 msgstr ""
1533
1534 #. type: Plain text
1535 #: build/C/man6/intro.6:32
1536 msgid ""
1537 "Section 6 of the manual describes all the games and funny little programs "
1538 "available on the system."
1539 msgstr ""
1540
1541 #. type: Plain text
1542 #: build/C/man7/intro.7:31
1543 msgid "intro - introduction to overview, conventions, and miscellany section"
1544 msgstr ""
1545
1546 #. type: Plain text
1547 #: build/C/man7/intro.7:36
1548 msgid ""
1549 "Section 7 of the manual provides overviews on various topics, and describes "
1550 "conventions and protocols, character set standards, the standard filesystem "
1551 "layout, and miscellaneous other things."
1552 msgstr ""
1553
1554 #. type: Plain text
1555 #: build/C/man8/intro.8:32
1556 msgid "intro - introduction to administration and privileged commands"
1557 msgstr ""
1558
1559 #. type: Plain text
1560 #: build/C/man8/intro.8:37
1561 msgid ""
1562 "Section 8 of the manual describes commands which either can be or are used "
1563 "only by the superuser, like system-administration commands, daemons, and "
1564 "hardware-related commands."
1565 msgstr ""
1566
1567 #. type: Plain text
1568 #: build/C/man8/intro.8:44
1569 msgid ""
1570 "As with the commands in described section 1, the commands described in this "
1571 "section terminate with an exit status that indicates whether the command "
1572 "succeeded or failed.  See B<intro>(1)  for more information."
1573 msgstr ""
1574
1575 #. type: TH
1576 #: build/C/man7/libc.7:26
1577 #, no-wrap
1578 msgid "LIBC"
1579 msgstr ""
1580
1581 #. type: Plain text
1582 #: build/C/man7/libc.7:29
1583 msgid "libc - overview of standard C libraries on Linux"
1584 msgstr ""
1585
1586 #. type: Plain text
1587 #: build/C/man7/libc.7:36
1588 msgid ""
1589 "The term \"libc\" is commonly used as a shorthand for the \"standard C "
1590 "library\", a library of standard functions that can be used by all C "
1591 "programs (and sometimes by programs in other languages).  Because of some "
1592 "history (see below), use of the term \"libc\" to refer to the standard C "
1593 "library is somewhat ambiguous on Linux."
1594 msgstr ""
1595
1596 #. type: SS
1597 #: build/C/man7/libc.7:36
1598 #, no-wrap
1599 msgid "glibc"
1600 msgstr ""
1601
1602 #. type: Plain text
1603 #: build/C/man7/libc.7:54
1604 msgid ""
1605 "By far the most widely used C library on Linux is the GNU C Library E<.UR "
1606 "http://www.gnu.org\\:/software\\:/libc/> E<.UE ,> often referred to as "
1607 "I<glibc>.  This is the C library that is nowadays used in all major Linux "
1608 "distributions.  It is also the C library whose details are documented in the "
1609 "relevant pages of the I<man-pages> project (primarily in Section 3 of the "
1610 "manual).  Documentation of glibc is also available in the glibc manual, "
1611 "available via the command I<info libc>.  Release 1.0 of glibc was made in "
1612 "September 1992.  (There were earlier 0.x releases.)  The next major release "
1613 "of glibc was 2.0, at the beginning of 1997."
1614 msgstr ""
1615
1616 #. type: Plain text
1617 #: build/C/man7/libc.7:61
1618 msgid ""
1619 "The pathname I</lib/libc.so.6> (or something similar) is normally a symbolic "
1620 "link that points to the location of the glibc library, and executing this "
1621 "pathname will cause glibc to display various information about the version "
1622 "installed on your system."
1623 msgstr ""
1624
1625 #. type: SS
1626 #: build/C/man7/libc.7:61
1627 #, no-wrap
1628 msgid "Linux libc"
1629 msgstr ""
1630
1631 #. type: Plain text
1632 #: build/C/man7/libc.7:84
1633 msgid ""
1634 "In the early to mid 1990s, there was for a while I<Linux libc>, a fork of "
1635 "glibc 1.x created by Linux developers who felt that glibc development at the "
1636 "time was not sufficing for the needs of Linux.  Often, this library was "
1637 "referred to (ambiguously) as just \"libc\".  Linux libc released major "
1638 "versions 2, 3, 4, and 5 (as well as many minor versions of those releases).  "
1639 "For a while, Linux libc was the standard C library in many Linux "
1640 "distributions.  However, notwithstanding the original motivations of the "
1641 "Linux libc effort, by the time glibc 2.0 was released, it was clearly "
1642 "superior to Linux libc, and all major Linux distributions that had been "
1643 "using Linux libc soon switched back to glibc.  (Since this switch occurred "
1644 "over a decade ago, I<man-pages> no longer takes care to document Linux libc "
1645 "details.  Nevertheless, the history is visible in vestiges of information "
1646 "about Linux libc that remain in some manual pages, in particular, references "
1647 "to I<libc4> and I<libc5>.)"
1648 msgstr ""
1649
1650 #. type: SS
1651 #: build/C/man7/libc.7:84
1652 #, no-wrap
1653 msgid "Other C libraries"
1654 msgstr ""
1655
1656 #. type: Plain text
1657 #: build/C/man7/libc.7:99
1658 msgid ""
1659 "There are various other less widely used C libraries for Linux.  These "
1660 "libraries are generally smaller than glibc, both in terms of features and "
1661 "memory footprint, and often intended for building small binaries, perhaps "
1662 "targeted at development for embedded Linux systems.  Among such libraries "
1663 "are I<uClibc> (I<http://www.uclibc.org/>)  and I<dietlibc> "
1664 "(I<http://www.fefe.de/dietlibc/>).  Details of these libraries are generally "
1665 "not covered by the I<man-pages> project."
1666 msgstr ""
1667
1668 #. type: Plain text
1669 #: build/C/man7/libc.7:104
1670 msgid "B<syscalls>(2), B<feature_test_macros>(7), B<man-pages>(7), B<standards>(7)"
1671 msgstr ""
1672
1673 #. type: TH
1674 #: build/C/man7/mailaddr.7:27
1675 #, no-wrap
1676 msgid "MAILADDR"
1677 msgstr ""
1678
1679 #. type: TH
1680 #: build/C/man7/mailaddr.7:27
1681 #, no-wrap
1682 msgid "2004-09-15"
1683 msgstr ""
1684
1685 #. type: Plain text
1686 #: build/C/man7/mailaddr.7:31
1687 msgid "mailaddr - mail addressing description"
1688 msgstr ""
1689
1690 #. type: Plain text
1691 #: build/C/man7/mailaddr.7:36
1692 msgid ""
1693 "This manual page gives a brief introduction to SMTP mail addresses, as used "
1694 "on the Internet.  These addresses are in the general format"
1695 msgstr ""
1696
1697 #. type: Plain text
1698 #: build/C/man7/mailaddr.7:38
1699 msgid "  user@domain"
1700 msgstr ""
1701
1702 #. type: Plain text
1703 #: build/C/man7/mailaddr.7:41
1704 msgid ""
1705 "where a domain is a hierarchical dot-separated list of subdomains.  These "
1706 "examples are valid forms of the same address:"
1707 msgstr ""
1708
1709 #. type: Plain text
1710 #: build/C/man7/mailaddr.7:43
1711 msgid "  eric@monet.berkeley.edu"
1712 msgstr ""
1713
1714 #. type: Plain text
1715 #: build/C/man7/mailaddr.7:45
1716 msgid "  Eric Allman E<lt>eric@monet.berkeley.eduE<gt>"
1717 msgstr ""
1718
1719 #. type: Plain text
1720 #: build/C/man7/mailaddr.7:47
1721 msgid "  eric@monet.berkeley.edu (Eric Allman)"
1722 msgstr ""
1723
1724 #. type: Plain text
1725 #: build/C/man7/mailaddr.7:51
1726 msgid ""
1727 "The domain part (\"monet.berkeley.edu\") is a mail-accepting domain.  It can "
1728 "be a host and in the past it usually was, but it doesn't have to be.  The "
1729 "domain part is not case sensitive."
1730 msgstr ""
1731
1732 #. type: Plain text
1733 #: build/C/man7/mailaddr.7:59
1734 msgid ""
1735 "The local part (\"eric\") is often a username, but its meaning is defined by "
1736 "the local software.  Sometimes it is case sensitive, although that is "
1737 "unusual.  If you see a local-part that looks like garbage, it is usually "
1738 "because of a gateway between an internal e-mail system and the net, here are "
1739 "some examples:"
1740 msgstr ""
1741
1742 #. type: Plain text
1743 #: build/C/man7/mailaddr.7:61
1744 msgid "  \"surname/admd=telemail/c=us/o=hp/prmd=hp\"@some.where"
1745 msgstr ""
1746
1747 #. type: Plain text
1748 #: build/C/man7/mailaddr.7:63
1749 msgid "  USER%SOMETHING@some.where"
1750 msgstr ""
1751
1752 #. type: Plain text
1753 #: build/C/man7/mailaddr.7:65
1754 msgid "  machine!machine!name@some.where"
1755 msgstr ""
1756
1757 #. type: Plain text
1758 #: build/C/man7/mailaddr.7:67
1759 msgid "  I2461572@some.where"
1760 msgstr ""
1761
1762 #. type: Plain text
1763 #: build/C/man7/mailaddr.7:71
1764 msgid ""
1765 "(These are, respectively, an X.400 gateway, a gateway to an arbitrary "
1766 "internal mail system that lacks proper internet support, an UUCP gateway, "
1767 "and the last one is just boring username policy.)"
1768 msgstr ""
1769
1770 #. type: Plain text
1771 #: build/C/man7/mailaddr.7:77
1772 msgid ""
1773 "The real-name part (\"Eric Allman\") can either be placed before E<lt>E<gt>, "
1774 "or in () at the end.  (Strictly speaking the two aren't the same, but the "
1775 "difference is beyond the scope of this page.)  The name may have to be "
1776 "quoted using \"\", for example, if it contains \".\":"
1777 msgstr ""
1778
1779 #. type: Plain text
1780 #: build/C/man7/mailaddr.7:79
1781 msgid "  \"Eric P. Allman\" E<lt>eric@monet.berkeley.eduE<gt>"
1782 msgstr ""
1783
1784 #. type: SS
1785 #: build/C/man7/mailaddr.7:79
1786 #, no-wrap
1787 msgid "Abbreviation."
1788 msgstr ""
1789
1790 #. type: Plain text
1791 #: build/C/man7/mailaddr.7:87
1792 msgid ""
1793 "Many mail systems let users abbreviate the domain name.  For instance, users "
1794 "at berkeley.edu may get away with \"eric@monet\" to send mail to Eric "
1795 "Allman.  I<This behavior is deprecated.> Sometimes it works, but you should "
1796 "not depend on it."
1797 msgstr ""
1798
1799 #. type: SS
1800 #: build/C/man7/mailaddr.7:87
1801 #, no-wrap
1802 msgid "Route-addrs."
1803 msgstr ""
1804
1805 #. type: Plain text
1806 #: build/C/man7/mailaddr.7:94
1807 msgid ""
1808 "In the past, sometimes one had to route a message through several hosts to "
1809 "get it to its final destination.  Addresses which show these relays are "
1810 "termed \"route-addrs\".  These use the syntax:"
1811 msgstr ""
1812
1813 #. type: Plain text
1814 #: build/C/man7/mailaddr.7:96
1815 msgid "  E<lt>@hosta,@hostb:user@hostcE<gt>"
1816 msgstr ""
1817
1818 #. type: Plain text
1819 #: build/C/man7/mailaddr.7:101
1820 msgid ""
1821 "This specifies that the message should be sent to hosta, from there to "
1822 "hostb, and finally to hostc.  Many hosts disregard route-addrs and send "
1823 "directly to hostc."
1824 msgstr ""
1825
1826 #. type: Plain text
1827 #: build/C/man7/mailaddr.7:107
1828 msgid ""
1829 "Route-addrs are very unusual now.  They occur sometimes in old mail "
1830 "archives.  It is generally possible to ignore all but the \"user@hostc\" "
1831 "part of the address to determine the actual address."
1832 msgstr ""
1833
1834 #. type: SS
1835 #: build/C/man7/mailaddr.7:107
1836 #, no-wrap
1837 msgid "Postmaster."
1838 msgstr ""
1839
1840 #. type: Plain text
1841 #: build/C/man7/mailaddr.7:113
1842 msgid ""
1843 "Every site is required to have a user or user alias designated "
1844 "\"postmaster\" to which problems with the mail system may be addressed.  The "
1845 "\"postmaster\" address is not case sensitive."
1846 msgstr ""
1847
1848 #. type: Plain text
1849 #: build/C/man7/mailaddr.7:115
1850 msgid "I</etc/aliases>"
1851 msgstr ""
1852
1853 #. type: Plain text
1854 #: build/C/man7/mailaddr.7:117
1855 msgid "I<~/.forward>"
1856 msgstr ""
1857
1858 #. type: Plain text
1859 #: build/C/man7/mailaddr.7:125
1860 msgid ""
1861 "B<binmail>(1), B<mail>(1), B<mconnect>(1), B<aliases>(5), B<forward>(5), "
1862 "B<sendmail>(8), B<vrfy>(8)"
1863 msgstr ""
1864
1865 #. type: Plain text
1866 #: build/C/man7/mailaddr.7:127
1867 msgid "RFC\\ 2822 (Internet Message Format)"
1868 msgstr ""
1869
1870 #. type: TH
1871 #: build/C/man7/man-pages.7:30
1872 #, no-wrap
1873 msgid "MAN-PAGES"
1874 msgstr ""
1875
1876 #. type: TH
1877 #: build/C/man7/man-pages.7:30
1878 #, no-wrap
1879 msgid "2013-07-24"
1880 msgstr ""
1881
1882 #. type: Plain text
1883 #: build/C/man7/man-pages.7:33
1884 msgid "man-pages - conventions for writing Linux man pages"
1885 msgstr ""
1886
1887 #. type: Plain text
1888 #: build/C/man7/man-pages.7:37 build/C/man7/man.7:49
1889 msgid "B<man> [I<section>] I<title>"
1890 msgstr ""
1891
1892 #. type: Plain text
1893 #: build/C/man7/man-pages.7:47
1894 msgid ""
1895 "This page describes the conventions that should be employed when writing man "
1896 "pages for the Linux I<man-pages> project, which documents the user-space API "
1897 "provided by the Linux kernel and the GNU C library.  The project thus "
1898 "provides most of the pages in Section 2, as well as many of the pages that "
1899 "appear in Sections 3, 4, 5, and 7 of the man pages on a Linux system.  The "
1900 "conventions described on this page may also be useful for authors writing "
1901 "man pages for other projects."
1902 msgstr ""
1903
1904 #. type: SS
1905 #: build/C/man7/man-pages.7:47
1906 #, no-wrap
1907 msgid "Sections of the manual pages"
1908 msgstr ""
1909
1910 #. type: Plain text
1911 #: build/C/man7/man-pages.7:50
1912 msgid "The manual Sections are traditionally defined as follows:"
1913 msgstr ""
1914
1915 #. type: TP
1916 #: build/C/man7/man-pages.7:50
1917 #, no-wrap
1918 msgid "B<1 Commands (Programs)>"
1919 msgstr ""
1920
1921 #. type: Plain text
1922 #: build/C/man7/man-pages.7:54
1923 msgid "Those commands that can be executed by the user from within a shell."
1924 msgstr ""
1925
1926 #. type: TP
1927 #: build/C/man7/man-pages.7:54
1928 #, no-wrap
1929 msgid "B<2 System calls>"
1930 msgstr ""
1931
1932 #. type: Plain text
1933 #: build/C/man7/man-pages.7:57
1934 msgid "Those functions which must be performed by the kernel."
1935 msgstr ""
1936
1937 #. type: TP
1938 #: build/C/man7/man-pages.7:57
1939 #, no-wrap
1940 msgid "B<3 Library calls>"
1941 msgstr ""
1942
1943 #. type: Plain text
1944 #: build/C/man7/man-pages.7:62
1945 msgid "Most of the I<libc> functions."
1946 msgstr ""
1947
1948 #. type: TP
1949 #: build/C/man7/man-pages.7:62
1950 #, no-wrap
1951 msgid "B<4 Special files (devices)>"
1952 msgstr ""
1953
1954 #. type: Plain text
1955 #: build/C/man7/man-pages.7:66
1956 msgid "Files found in I</dev>."
1957 msgstr ""
1958
1959 #. type: TP
1960 #: build/C/man7/man-pages.7:66
1961 #, no-wrap
1962 msgid "B<5 File formats and conventions>"
1963 msgstr ""
1964
1965 #. type: Plain text
1966 #: build/C/man7/man-pages.7:71
1967 msgid "The format for I</etc/passwd> and other human-readable files."
1968 msgstr ""
1969
1970 #. type: TP
1971 #: build/C/man7/man-pages.7:71
1972 #, no-wrap
1973 msgid "B<6 Games>"
1974 msgstr ""
1975
1976 #. type: TP
1977 #: build/C/man7/man-pages.7:73
1978 #, no-wrap
1979 msgid "B<7 Overview, conventions, and miscellaneous>"
1980 msgstr ""
1981
1982 #. type: Plain text
1983 #: build/C/man7/man-pages.7:77
1984 msgid ""
1985 "Overviews of various topics, conventions and protocols, character set "
1986 "standards, and miscellaneous other things."
1987 msgstr ""
1988
1989 #. type: TP
1990 #: build/C/man7/man-pages.7:77
1991 #, no-wrap
1992 msgid "B<8 System management commands>"
1993 msgstr ""
1994
1995 #.  .TP
1996 #.  .B 9 Kernel routines
1997 #.  This is an obsolete manual section.
1998 #.  Once it was thought a good idea to document the Linux kernel here,
1999 #.  but in fact very little has been documented, and the documentation
2000 #.  that exists is outdated already.
2001 #.  There are better sources of
2002 #.  information for kernel developers.
2003 #. type: Plain text
2004 #: build/C/man7/man-pages.7:90
2005 msgid "Commands like B<mount>(8), many of which only root can execute."
2006 msgstr ""
2007
2008 #. type: SS
2009 #: build/C/man7/man-pages.7:90
2010 #, no-wrap
2011 msgid "Macro package"
2012 msgstr ""
2013
2014 #. type: Plain text
2015 #: build/C/man7/man-pages.7:97
2016 msgid ""
2017 "New manual pages should be marked up using the B<groff an.tmac> package "
2018 "described in B<man>(7).  This choice is mainly for consistency: the vast "
2019 "majority of existing Linux manual pages are marked up using these macros."
2020 msgstr ""
2021
2022 #. type: SS
2023 #: build/C/man7/man-pages.7:97
2024 #, no-wrap
2025 msgid "Conventions for source file layout"
2026 msgstr ""
2027
2028 #. type: Plain text
2029 #: build/C/man7/man-pages.7:102
2030 msgid ""
2031 "Please limit source code line length to no more than about 75 characters "
2032 "wherever possible.  This helps avoid line-wrapping in some mail clients when "
2033 "patches are submitted inline."
2034 msgstr ""
2035
2036 #. type: Plain text
2037 #: build/C/man7/man-pages.7:106
2038 msgid ""
2039 "New sentences should be started on new lines.  This makes it easier to see "
2040 "the effect of patches, which often operate at the level of individual "
2041 "sentences."
2042 msgstr ""
2043
2044 #. type: SS
2045 #: build/C/man7/man-pages.7:106 build/C/man7/man.7:78
2046 #, no-wrap
2047 msgid "Title line"
2048 msgstr ""
2049
2050 #. type: Plain text
2051 #: build/C/man7/man-pages.7:110
2052 msgid "The first command in a man page should be a B<TH> command:"
2053 msgstr ""
2054
2055 #. type: Plain text
2056 #: build/C/man7/man-pages.7:114 build/C/man7/man.7:85
2057 msgid "B<\\&.TH> I<title section date source manual>"
2058 msgstr ""
2059
2060 #. type: Plain text
2061 #: build/C/man7/man-pages.7:117
2062 msgid "where:"
2063 msgstr ""
2064
2065 #. type: TP
2066 #: build/C/man7/man-pages.7:118
2067 #, no-wrap
2068 msgid "I<title>"
2069 msgstr ""
2070
2071 #. type: Plain text
2072 #: build/C/man7/man-pages.7:122
2073 msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
2074 msgstr ""
2075
2076 #. type: TP
2077 #: build/C/man7/man-pages.7:122
2078 #, no-wrap
2079 msgid "I<section>"
2080 msgstr ""
2081
2082 #. type: Plain text
2083 #: build/C/man7/man-pages.7:126
2084 msgid "The section number in which the man page should be placed (e.g., I<7>)."
2085 msgstr ""
2086
2087 #. type: TP
2088 #: build/C/man7/man-pages.7:126
2089 #, no-wrap
2090 msgid "I<date>"
2091 msgstr ""
2092
2093 #. type: Plain text
2094 #: build/C/man7/man-pages.7:132
2095 msgid ""
2096 "The date of the last revision\\(emremember to change this every time a "
2097 "change is made to the man page, since this is the most general way of doing "
2098 "version control.  Dates should be written in the form YYYY-MM-DD."
2099 msgstr ""
2100
2101 #. type: TP
2102 #: build/C/man7/man-pages.7:132
2103 #, no-wrap
2104 msgid "I<source>"
2105 msgstr ""
2106
2107 #. type: Plain text
2108 #: build/C/man7/man-pages.7:135
2109 msgid "The source of the command, function, or system call."
2110 msgstr ""
2111
2112 #. type: Plain text
2113 #: build/C/man7/man-pages.7:139
2114 msgid ""
2115 "For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
2116 "to write I<GNU>."
2117 msgstr ""
2118
2119 #. type: Plain text
2120 #: build/C/man7/man-pages.7:147
2121 msgid ""
2122 "For system calls, just write I<Linux>.  (An earlier practice was to write "
2123 "the version number of the kernel from which the manual page was being "
2124 "written/checked.  However, this was never done consistently, and so was "
2125 "probably worse than including no version number.  Henceforth, avoid "
2126 "including a version number.)"
2127 msgstr ""
2128
2129 #. type: Plain text
2130 #: build/C/man7/man-pages.7:152
2131 msgid ""
2132 "For library calls that are part of glibc or one of the other common GNU "
2133 "libraries, just use I<GNU C Library>, I<GNU>, or an empty string."
2134 msgstr ""
2135
2136 #. type: Plain text
2137 #: build/C/man7/man-pages.7:155
2138 msgid "For Section 4 pages, use I<Linux>."
2139 msgstr ""
2140
2141 #. type: Plain text
2142 #: build/C/man7/man-pages.7:158
2143 msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
2144 msgstr ""
2145
2146 #. type: TP
2147 #: build/C/man7/man-pages.7:158
2148 #, no-wrap
2149 msgid "I<manual>"
2150 msgstr ""
2151
2152 #. type: Plain text
2153 #: build/C/man7/man-pages.7:163
2154 msgid ""
2155 "The title of the manual (e.g., for Section 2 and 3 pages in the I<man-pages> "
2156 "package, use I<Linux Programmer's Manual>)."
2157 msgstr ""
2158
2159 #. type: SS
2160 #: build/C/man7/man-pages.7:164
2161 #, no-wrap
2162 msgid "Sections within a manual page"
2163 msgstr ""
2164
2165 #. type: Plain text
2166 #: build/C/man7/man-pages.7:171
2167 msgid ""
2168 "The list below shows conventional or suggested sections.  Most manual pages "
2169 "should include at least the B<highlighted> sections.  Arrange a new manual "
2170 "page so that sections are placed in the order shown in the list."
2171 msgstr ""
2172
2173 #.  May 07: Few current man pages have an ERROR HANDLING section,,,
2174 #.  ERROR HANDLING,
2175 #.  May 07: Almost no current man pages have a USAGE section,,,
2176 #.  USAGE,
2177 #.  DIAGNOSTICS,
2178 #.  May 07: Almost no current man pages have a SECURITY section,,,
2179 #.  SECURITY,
2180 #.  AUTHORS sections are discouraged
2181 #.  AUTHORS             [Discouraged]
2182 #. type: Plain text
2183 #: build/C/man7/man-pages.7:200
2184 #, no-wrap
2185 msgid ""
2186 "B<NAME>\n"
2187 "B<SYNOPSIS>\n"
2188 "CONFIGURATION      [Normally only in Section 4]\n"
2189 "B<DESCRIPTION>\n"
2190 "OPTIONS            [Normally only in Sections 1, 8]\n"
2191 "EXIT STATUS        [Normally only in Sections 1, 8]\n"
2192 "RETURN VALUE       [Normally only in Sections 2, 3]\n"
2193 "ERRORS             [Typically only in Sections 2, 3]\n"
2194 "ENVIRONMENT\n"
2195 "FILES\n"
2196 "ATTRIBUTES         [Normally only in Sections 2, 3]\n"
2197 "VERSIONS           [Normally only in Sections 2, 3]\n"
2198 "CONFORMING TO\n"
2199 "NOTES\n"
2200 "BUGS\n"
2201 "EXAMPLE\n"
2202 "B<SEE ALSO>\n"
2203 msgstr ""
2204
2205 #. type: Plain text
2206 #: build/C/man7/man-pages.7:211
2207 msgid ""
2208 "I<Where a traditional heading would apply>, I<please use it>; this kind of "
2209 "consistency can make the information easier to understand.  If you must, you "
2210 "can create your own headings if they make things easier to understand (this "
2211 "can be especially useful for pages in Sections 4 and 5).  However, before "
2212 "doing this, consider whether you could use the traditional headings, with "
2213 "some subsections (I<.SS>) within those sections."
2214 msgstr ""
2215
2216 #. type: Plain text
2217 #: build/C/man7/man-pages.7:214
2218 msgid "The following list elaborates on the contents of each of the above sections."
2219 msgstr ""
2220
2221 #. type: TP
2222 #: build/C/man7/man-pages.7:214
2223 #, no-wrap
2224 msgid "B<NAME>"
2225 msgstr ""
2226
2227 #. type: Plain text
2228 #: build/C/man7/man-pages.7:225
2229 msgid ""
2230 "The name of this manual page.  See B<man>(7)  for important details of the "
2231 "line(s) that should follow the B<.SH NAME> command.  All words in this line "
2232 "(including the word immediately following the \"\\e-\") should be in "
2233 "lowercase, except where English or technical terminological convention "
2234 "dictates otherwise."
2235 msgstr ""
2236
2237 #. type: TP
2238 #: build/C/man7/man-pages.7:225
2239 #, no-wrap
2240 msgid "B<SYNOPSIS>"
2241 msgstr ""
2242
2243 #. type: Plain text
2244 #: build/C/man7/man-pages.7:237
2245 msgid ""
2246 "briefly describes the command or function's interface.  For commands, this "
2247 "shows the syntax of the command and its arguments (including options); "
2248 "boldface is used for as-is text and italics are used to indicate replaceable "
2249 "arguments.  Brackets ([]) surround optional arguments, vertical bars (|)  "
2250 "separate choices, and ellipses (\\&...) can be repeated.  For functions, it "
2251 "shows any required data declarations or B<#include> directives, followed by "
2252 "the function declaration."
2253 msgstr ""
2254
2255 #.  FIXME . Say something here about compiler options
2256 #. type: Plain text
2257 #: build/C/man7/man-pages.7:243
2258 msgid ""
2259 "Where a feature test macro must be defined in order to obtain the "
2260 "declaration of a function (or a variable) from a header file, then the "
2261 "SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
2262 msgstr ""
2263
2264 #. type: TP
2265 #: build/C/man7/man-pages.7:243
2266 #, no-wrap
2267 msgid "B<CONFIGURATION>"
2268 msgstr ""
2269
2270 #. type: Plain text
2271 #: build/C/man7/man-pages.7:247
2272 msgid ""
2273 "Configuration details for a device.  This section normally appears only in "
2274 "Section 4 pages."
2275 msgstr ""
2276
2277 #. type: TP
2278 #: build/C/man7/man-pages.7:247
2279 #, no-wrap
2280 msgid "B<DESCRIPTION>"
2281 msgstr ""
2282
2283 #.  If there is some kind of input grammar or complex set of subcommands,
2284 #.  consider describing them in a separate
2285 #.  .B USAGE
2286 #.  section (and just place an overview in the
2287 #.  .B DESCRIPTION
2288 #.  section).
2289 #. type: Plain text
2290 #: build/C/man7/man-pages.7:264
2291 msgid ""
2292 "gives an explanation of what the program, function, or format does.  Discuss "
2293 "how it interacts with files and standard input, and what it produces on "
2294 "standard output or standard error.  Omit internals and implementation "
2295 "details unless they're critical for understanding the interface.  Describe "
2296 "the usual case; for information on command-line options of a program use the "
2297 "B<OPTIONS> section."
2298 msgstr ""
2299
2300 #. type: Plain text
2301 #: build/C/man7/man-pages.7:272
2302 msgid ""
2303 "When describing new behavior or new flags for a system call or library "
2304 "function, be careful to note the kernel or C library version that introduced "
2305 "the change.  The preferred method of noting this information for flags is as "
2306 "part of a B<.TP> list, in the following form (here, for a new system call "
2307 "flag):"
2308 msgstr ""
2309
2310 #. type: TP
2311 #: build/C/man7/man-pages.7:273
2312 #, no-wrap
2313 msgid "B<XYZ_FLAG> (since Linux 3.7)"
2314 msgstr ""
2315
2316 #. type: Plain text
2317 #: build/C/man7/man-pages.7:276
2318 msgid "Description of flag..."
2319 msgstr ""
2320
2321 #. type: Plain text
2322 #: build/C/man7/man-pages.7:281
2323 msgid ""
2324 "Including version information is especially useful to users who are "
2325 "constrained to using older kernel or C library versions (which is typical in "
2326 "embedded systems, for example)."
2327 msgstr ""
2328
2329 #. type: TP
2330 #: build/C/man7/man-pages.7:281
2331 #, no-wrap
2332 msgid "B<OPTIONS>"
2333 msgstr ""
2334
2335 #.  .TP
2336 #.  .B USAGE
2337 #.  describes the grammar of any sublanguage this implements.
2338 #. type: Plain text
2339 #: build/C/man7/man-pages.7:289
2340 msgid ""
2341 "describes the command-line options accepted by a program and how they change "
2342 "its behavior.  This section should appear only for Section 1 and 8 manual "
2343 "pages."
2344 msgstr ""
2345
2346 #. type: TP
2347 #: build/C/man7/man-pages.7:289
2348 #, no-wrap
2349 msgid "B<EXIT STATUS>"
2350 msgstr ""
2351
2352 #. type: Plain text
2353 #: build/C/man7/man-pages.7:294
2354 msgid ""
2355 "lists the possible exit status values of a program and the conditions that "
2356 "cause these values to be returned.  This section should appear only for "
2357 "Section 1 and 8 manual pages."
2358 msgstr ""
2359
2360 #. type: TP
2361 #: build/C/man7/man-pages.7:294
2362 #, no-wrap
2363 msgid "B<RETURN VALUE>"
2364 msgstr ""
2365
2366 #. type: Plain text
2367 #: build/C/man7/man-pages.7:299
2368 msgid ""
2369 "For Section 2 and 3 pages, this section gives a list of the values the "
2370 "library routine will return to the caller and the conditions that cause "
2371 "these values to be returned."
2372 msgstr ""
2373
2374 #. type: TP
2375 #: build/C/man7/man-pages.7:299
2376 #, no-wrap
2377 msgid "B<ERRORS>"
2378 msgstr ""
2379
2380 #. type: Plain text
2381 #: build/C/man7/man-pages.7:307
2382 msgid ""
2383 "For Section 2 and 3 manual pages, this is a list of the values that may be "
2384 "placed in I<errno> in the event of an error, along with information about "
2385 "the cause of the errors.  I<The error list should be in alphabetical order>."
2386 msgstr ""
2387
2388 #. type: TP
2389 #: build/C/man7/man-pages.7:307
2390 #, no-wrap
2391 msgid "B<ENVIRONMENT>"
2392 msgstr ""
2393
2394 #. type: Plain text
2395 #: build/C/man7/man-pages.7:311
2396 msgid ""
2397 "lists all environment variables that affect the program or function and how "
2398 "they affect it."
2399 msgstr ""
2400
2401 #. type: TP
2402 #: build/C/man7/man-pages.7:311
2403 #, no-wrap
2404 msgid "B<FILES>"
2405 msgstr ""
2406
2407 #.  May 07: Almost no current man pages have a DIAGNOSTICS section;
2408 #.          "RETURN VALUE" or "EXIT STATUS" is preferred.
2409 #.  .TP
2410 #.  .B DIAGNOSTICS
2411 #.  gives an overview of the most common error messages and how to
2412 #.  cope with them.
2413 #.  You don't need to explain system error messages
2414 #.  or fatal signals that can appear during execution of any program
2415 #.  unless they're special in some way to the program.
2416 #
2417 #.  May 07: Almost no current man pages have a SECURITY section.
2418 #. .TP
2419 #. .B SECURITY
2420 #. discusses security issues and implications.
2421 #. Warn about configurations or environments that should be avoided,
2422 #. commands that may have security implications, and so on, especially
2423 #. if they aren't obvious.
2424 #. Discussing security in a separate section isn't necessary;
2425 #. if it's easier to understand, place security information in the
2426 #. other sections (such as the
2427 #.  .B DESCRIPTION
2428 #.  or
2429 #.  .B USAGE
2430 #.  section).
2431 #.  However, please include security information somewhere!
2432 #. type: Plain text
2433 #: build/C/man7/man-pages.7:348
2434 msgid ""
2435 "lists the files the program or function uses, such as configuration files, "
2436 "startup files, and files the program directly operates on.  Give the full "
2437 "pathname of these files, and use the installation process to modify the "
2438 "directory part to match user preferences.  For many programs, the default "
2439 "installation location is in I</usr/local>, so your base manual page should "
2440 "use I</usr/local> as the base."
2441 msgstr ""
2442
2443 #. type: TP
2444 #: build/C/man7/man-pages.7:348
2445 #, no-wrap
2446 msgid "B<ATTRIBUTES>"
2447 msgstr ""
2448
2449 #. type: Plain text
2450 #: build/C/man7/man-pages.7:353
2451 msgid ""
2452 "A summary of various attributes of the function(s) documented on this page, "
2453 "broken into subsections.  The following subsections are defined:"
2454 msgstr ""
2455
2456 #. type: TP
2457 #: build/C/man7/man-pages.7:355
2458 #, no-wrap
2459 msgid "B<Multithreading (see pthreads(7))>"
2460 msgstr ""
2461
2462 #. type: Plain text
2463 #: build/C/man7/man-pages.7:358
2464 msgid "This subsection notes attributes relating to multithreaded applications:"
2465 msgstr ""
2466
2467 #. type: Plain text
2468 #: build/C/man7/man-pages.7:361
2469 msgid "Whether the function is thread-safe."
2470 msgstr ""
2471
2472 #. type: Plain text
2473 #: build/C/man7/man-pages.7:363
2474 msgid "Whether the function is a cancellation point."
2475 msgstr ""
2476
2477 #. type: Plain text
2478 #: build/C/man7/man-pages.7:365
2479 msgid "Whether the function is async-cancel-safe."
2480 msgstr ""
2481
2482 #. type: Plain text
2483 #: build/C/man7/man-pages.7:369
2484 msgid "Details of these attributes can be found in B<pthreads>(7)."
2485 msgstr ""
2486
2487 #. type: TP
2488 #: build/C/man7/man-pages.7:370
2489 #, no-wrap
2490 msgid "B<VERSIONS>"
2491 msgstr ""
2492
2493 #. type: Plain text
2494 #: build/C/man7/man-pages.7:387
2495 msgid ""
2496 "A brief summary of the Linux kernel or glibc versions where a system call or "
2497 "library function appeared, or changed significantly in its operation.  As a "
2498 "general rule, every new interface should include a VERSIONS section in its "
2499 "manual page.  Unfortunately, many existing manual pages don't include this "
2500 "information (since there was no policy to do so when they were written).  "
2501 "Patches to remedy this are welcome, but, from the perspective of programmers "
2502 "writing new code, this information probably matters only in the case of "
2503 "kernel interfaces that have been added in Linux 2.4 or later (i.e., changes "
2504 "since kernel 2.2), and library functions that have been added to glibc since "
2505 "version 2.1 (i.e., changes since glibc 2.0)."
2506 msgstr ""
2507
2508 #. type: Plain text
2509 #: build/C/man7/man-pages.7:392
2510 msgid ""
2511 "The B<syscalls>(2)  manual page also provides information about kernel "
2512 "versions in which various system calls first appeared."
2513 msgstr ""
2514
2515 #. type: TP
2516 #: build/C/man7/man-pages.7:392
2517 #, no-wrap
2518 msgid "B<CONFORMING TO>"
2519 msgstr ""
2520
2521 #. type: Plain text
2522 #: build/C/man7/man-pages.7:406
2523 msgid ""
2524 "describes any standards or conventions that relate to the function or "
2525 "command described by the manual page.  For a page in Section 2 or 3, this "
2526 "section should note the POSIX.1 version(s) that the call conforms to, and "
2527 "also whether the call is specified in C99.  (Don't worry too much about "
2528 "other standards like SUS, SUSv2, and XPG, or the SVr4 and 4.xBSD "
2529 "implementation standards, unless the call was specified in those standards, "
2530 "but isn't in the current version of POSIX.1.)  (See B<standards>(7).)"
2531 msgstr ""
2532
2533 #. type: Plain text
2534 #: build/C/man7/man-pages.7:410
2535 msgid ""
2536 "If the call is not governed by any standards but commonly exists on other "
2537 "systems, note them.  If the call is Linux-specific, note this."
2538 msgstr ""
2539
2540 #. type: Plain text
2541 #: build/C/man7/man-pages.7:414
2542 msgid ""
2543 "If this section consists of just a list of standards (which it commonly "
2544 "does), terminate the list with a period (\\(aq.\\(aq)."
2545 msgstr ""
2546
2547 #. type: TP
2548 #: build/C/man7/man-pages.7:414
2549 #, no-wrap
2550 msgid "B<NOTES>"
2551 msgstr ""
2552
2553 #. type: Plain text
2554 #: build/C/man7/man-pages.7:419
2555 msgid ""
2556 "provides miscellaneous notes.  For Section 2 and 3 man pages you may find it "
2557 "useful to include subsections (B<SS>) named I<Linux Notes> and I<Glibc "
2558 "Notes>."
2559 msgstr ""
2560
2561 #. type: TP
2562 #: build/C/man7/man-pages.7:419
2563 #, no-wrap
2564 msgid "B<BUGS>"
2565 msgstr ""
2566
2567 #. type: Plain text
2568 #: build/C/man7/man-pages.7:423
2569 msgid ""
2570 "lists limitations, known defects or inconveniences, and other questionable "
2571 "activities."
2572 msgstr ""
2573
2574 #. type: TP
2575 #: build/C/man7/man-pages.7:423
2576 #, no-wrap
2577 msgid "B<EXAMPLE>"
2578 msgstr ""
2579
2580 #. type: Plain text
2581 #: build/C/man7/man-pages.7:429
2582 msgid ""
2583 "provides one or more examples describing how this function, file or command "
2584 "is used.  For details on writing example programs, see I<Example Programs> "
2585 "below."
2586 msgstr ""
2587
2588 #. type: TP
2589 #: build/C/man7/man-pages.7:429
2590 #, no-wrap
2591 msgid "B<AUTHORS>"
2592 msgstr ""
2593
2594 #. type: Plain text
2595 #: build/C/man7/man-pages.7:439
2596 msgid ""
2597 "lists authors of the documentation or program.  B<Use of an AUTHORS section "
2598 "is strongly discouraged>.  Generally, it is better not to clutter every page "
2599 "with a list of (over time potentially numerous) authors; if you write or "
2600 "significantly amend a page, add a copyright notice as a comment in the "
2601 "source file.  If you are the author of a device driver and want to include "
2602 "an address for reporting bugs, place this under the BUGS section."
2603 msgstr ""
2604
2605 #. type: TP
2606 #: build/C/man7/man-pages.7:439
2607 #, no-wrap
2608 msgid "B<SEE ALSO>"
2609 msgstr ""
2610
2611 #. type: Plain text
2612 #: build/C/man7/man-pages.7:446
2613 msgid ""
2614 "provides a comma-separated list of related man pages, ordered by section "
2615 "number and then alphabetically by name, possibly followed by other related "
2616 "pages or documents.  Do not terminate this with a period."
2617 msgstr ""
2618
2619 #. type: Plain text
2620 #: build/C/man7/man-pages.7:457
2621 msgid ""
2622 "Where the SEE ALSO list contains many long manual page names, to improve the "
2623 "visual result of the output, it may be useful to employ the I<.ad l> (don't "
2624 "right justify)  and I<.nh> (don't hyphenate)  directives.  Hyphenation of "
2625 "individual page names can be prevented by preceding words with the string "
2626 "\"\\e%\"."
2627 msgstr ""
2628
2629 #. type: SS
2630 #: build/C/man7/man-pages.7:457
2631 #, no-wrap
2632 msgid "Font conventions"
2633 msgstr ""
2634
2635 #. type: Plain text
2636 #: build/C/man7/man-pages.7:462
2637 msgid ""
2638 "For functions, the arguments are always specified using italics, I<even in "
2639 "the SYNOPSIS section>, where the rest of the function is specified in bold:"
2640 msgstr ""
2641
2642 #. type: Plain text
2643 #: build/C/man7/man-pages.7:464
2644 msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
2645 msgstr ""
2646
2647 #. type: Plain text
2648 #: build/C/man7/man-pages.7:466
2649 msgid "Variable names should, like argument names, be specified in italics."
2650 msgstr ""
2651
2652 #. type: Plain text
2653 #: build/C/man7/man-pages.7:479
2654 msgid ""
2655 "Filenames (whether pathnames, or references to files in the I</usr/include> "
2656 "directory)  are always in italics (e.g., I<E<lt>stdio.hE<gt>>), except in "
2657 "the SYNOPSIS section, where included files are in bold (e.g., B<#include "
2658 "E<lt>stdio.hE<gt>>).  When referring to a standard include file under "
2659 "I</usr/include>, specify the header file surrounded by angle brackets, in "
2660 "the usual C way (e.g., I<E<lt>stdio.hE<gt>>)."
2661 msgstr ""
2662
2663 #. type: Plain text
2664 #: build/C/man7/man-pages.7:483
2665 msgid ""
2666 "Special macros, which are usually in upper case, are in bold (e.g., "
2667 "B<MAXINT>).  Exception: don't boldface NULL."
2668 msgstr ""
2669
2670 #. type: Plain text
2671 #: build/C/man7/man-pages.7:488
2672 msgid ""
2673 "When enumerating a list of error codes, the codes are in bold (this list "
2674 "usually uses the B<\\&.TP> macro)."
2675 msgstr ""
2676
2677 #. type: Plain text
2678 #: build/C/man7/man-pages.7:491
2679 msgid ""
2680 "Complete commands should, if long, be written as in an indented line on "
2681 "their own, for example"
2682 msgstr ""
2683
2684 #. type: Plain text
2685 #: build/C/man7/man-pages.7:495
2686 #, no-wrap
2687 msgid "man 7 man-pages\n"
2688 msgstr ""
2689
2690 #. type: Plain text
2691 #: build/C/man7/man-pages.7:505
2692 msgid ""
2693 "If the command is short, then it can be included inline in the text, in "
2694 "italic format, for example, I<man 7 man-pages>.  In this case, it may be "
2695 "worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
2696 "command.  Command options should be written in italics, e.g., I<-l>."
2697 msgstr ""
2698
2699 #. type: Plain text
2700 #: build/C/man7/man-pages.7:510
2701 msgid ""
2702 "Expressions, if not written on a separate indented line, should be specified "
2703 "in italics.  Again, the use of nonbreaking spaces may be appropriate if the "
2704 "expression is inlined with normal text."
2705 msgstr ""
2706
2707 #. type: Plain text
2708 #: build/C/man7/man-pages.7:521
2709 msgid ""
2710 "Any reference to the subject of the current manual page should be written "
2711 "with the name in bold.  If the subject is a function (i.e., this is a "
2712 "Section 2 or 3 page), then the name should be followed by a pair of "
2713 "parentheses in Roman (normal) font.  For example, in the B<fcntl>(2)  man "
2714 "page, references to the subject of the page would be written as: "
2715 "B<fcntl>().  The preferred way to write this in the source file is:"
2716 msgstr ""
2717
2718 #. type: Plain text
2719 #: build/C/man7/man-pages.7:524
2720 #, no-wrap
2721 msgid "    .BR fcntl ()\n"
2722 msgstr ""
2723
2724 #. type: Plain text
2725 #: build/C/man7/man-pages.7:528
2726 msgid ""
2727 "(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
2728 "easier to write tools that parse man page source files.)"
2729 msgstr ""
2730
2731 #. type: Plain text
2732 #: build/C/man7/man-pages.7:537
2733 msgid ""
2734 "Any reference to another man page should be written with the name in bold, "
2735 "I<always> followed by the section number, formatted in Roman (normal) font, "
2736 "without any separating spaces (e.g., B<intro>(2)).  The preferred way to "
2737 "write this in the source file is:"
2738 msgstr ""
2739
2740 #. type: Plain text
2741 #: build/C/man7/man-pages.7:540
2742 #, no-wrap
2743 msgid "    .BR intro (2)\n"
2744 msgstr ""
2745
2746 #. type: Plain text
2747 #: build/C/man7/man-pages.7:545
2748 msgid ""
2749 "(Including the section number in cross references lets tools like "
2750 "B<man2html>(1)  create properly hyperlinked pages.)"
2751 msgstr ""
2752
2753 #. type: SS
2754 #: build/C/man7/man-pages.7:545
2755 #, no-wrap
2756 msgid "Spelling"
2757 msgstr ""
2758
2759 #. type: Plain text
2760 #: build/C/man7/man-pages.7:550
2761 msgid ""
2762 "Starting with release 2.59, I<man-pages> follows American spelling "
2763 "conventions; please write all new pages and patches according to these "
2764 "conventions."
2765 msgstr ""
2766
2767 #. type: SS
2768 #: build/C/man7/man-pages.7:550
2769 #, no-wrap
2770 msgid "Capitalization"
2771 msgstr ""
2772
2773 #. type: Plain text
2774 #: build/C/man7/man-pages.7:555
2775 msgid ""
2776 "In subsection (\"SS\") headings capitalize the first word in heading, but "
2777 "otherwise use lower case, except where English usage (e.g., proper nouns) or "
2778 "programming language requirements (e.g., identifier names) dictate "
2779 "otherwise."
2780 msgstr ""
2781
2782 #. type: SS
2783 #: build/C/man7/man-pages.7:555
2784 #, no-wrap
2785 msgid "Example programs and shell sessions"
2786 msgstr ""
2787
2788 #. type: Plain text
2789 #: build/C/man7/man-pages.7:559
2790 msgid ""
2791 "Manual pages can include example programs demonstrating how to use a system "
2792 "call or library function.  However, note the following:"
2793 msgstr ""
2794
2795 #. type: Plain text
2796 #: build/C/man7/man-pages.7:562
2797 msgid "Example programs should be written in C."
2798 msgstr ""
2799
2800 #. type: Plain text
2801 #: build/C/man7/man-pages.7:569
2802 msgid ""
2803 "An example program is necessary and useful only if it demonstrates something "
2804 "beyond what can easily be provided in a textual description of the "
2805 "interface.  An example program that does nothing other than call an "
2806 "interface usually serves little purpose."
2807 msgstr ""
2808
2809 #. type: Plain text
2810 #: build/C/man7/man-pages.7:573
2811 msgid ""
2812 "Example programs should be fairly short (preferably less than 100 lines; "
2813 "ideally less than 50 lines)."
2814 msgstr ""
2815
2816 #. type: Plain text
2817 #: build/C/man7/man-pages.7:577
2818 msgid ""
2819 "Example programs should do error checking after system calls and library "
2820 "function calls."
2821 msgstr ""
2822
2823 #. type: Plain text
2824 #: build/C/man7/man-pages.7:581
2825 msgid ""
2826 "Example programs should be complete, and compile without warnings when "
2827 "compiled with I<cc\\ -Wall>."
2828 msgstr ""
2829
2830 #. type: Plain text
2831 #: build/C/man7/man-pages.7:587
2832 msgid ""
2833 "Where possible and appropriate, example programs should allow "
2834 "experimentation, by varying their behavior based on inputs (ideally from "
2835 "command-line arguments, or alternatively, via input read by the program)."
2836 msgstr ""
2837
2838 #. type: Plain text
2839 #: build/C/man7/man-pages.7:592
2840 msgid ""
2841 "Example programs should be laid out according to Kernighan and Ritchie "
2842 "style, with 4-space indents.  (Avoid the use of TAB characters in source "
2843 "code!)"
2844 msgstr ""
2845
2846 #. type: Plain text
2847 #: build/C/man7/man-pages.7:597
2848 msgid ""
2849 "For some examples of what example programs should look like, see B<wait>(2)  "
2850 "and B<pipe>(2)."
2851 msgstr ""
2852
2853 #. type: Plain text
2854 #: build/C/man7/man-pages.7:601
2855 msgid ""
2856 "If you include a shell session demonstrating the use of a program or other "
2857 "system feature, boldface the user input text, to distinguish it from output "
2858 "produced by the system."
2859 msgstr ""
2860
2861 #. type: SS
2862 #: build/C/man7/man-pages.7:601
2863 #, no-wrap
2864 msgid "Indentation of structure definitions, shell session logs, etc."
2865 msgstr ""
2866
2867 #. type: Plain text
2868 #: build/C/man7/man-pages.7:607
2869 msgid ""
2870 "When structure definitions, shell session logs, and so on are included in "
2871 "running text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ "
2872 "+4n> and I<.in>)."
2873 msgstr ""
2874
2875 #. type: Plain text
2876 #: build/C/man7/man-pages.7:614
2877 msgid ""
2878 "For canonical examples of how man pages in the I<man-pages> package should "
2879 "look, see B<pipe>(2)  and B<fcntl>(2)."
2880 msgstr ""
2881
2882 #. type: Plain text
2883 #: build/C/man7/man-pages.7:621
2884 msgid ""
2885 "B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
2886 "B<mdoc>(7)"
2887 msgstr ""
2888
2889 #. type: TH
2890 #: build/C/man7/man.7:34
2891 #, no-wrap
2892 msgid "MAN"
2893 msgstr ""
2894
2895 #. type: Plain text
2896 #: build/C/man7/man.7:37
2897 msgid "man - macros to format man pages"
2898 msgstr ""
2899
2900 #. type: Plain text
2901 #: build/C/man7/man.7:41
2902 msgid "B<groff -Tascii -man> I<file> \\&..."
2903 msgstr ""
2904
2905 #. type: Plain text
2906 #: build/C/man7/man.7:45
2907 msgid "B<groff -Tps -man> I<file> \\&..."
2908 msgstr ""
2909
2910 #. type: Plain text
2911 #: build/C/man7/man.7:62
2912 msgid ""
2913 "This manual page explains the B<groff an.tmac> macro package (often called "
2914 "the B<man> macro package).  This macro package should be used by developers "
2915 "when writing or porting man pages for Linux.  It is fairly compatible with "
2916 "other versions of this macro package, so porting man pages should not be a "
2917 "major problem (exceptions include the NET-2 BSD release, which uses a "
2918 "totally different macro package called mdoc; see B<mdoc>(7))."
2919 msgstr ""
2920
2921 #. type: Plain text
2922 #: build/C/man7/man.7:74
2923 msgid ""
2924 "Note that NET-2 BSD mdoc man pages can be used with B<groff> simply by "
2925 "specifying the B<-mdoc> option instead of the B<-man> option.  Using the "
2926 "B<-mandoc> option is, however, recommended, since this will automatically "
2927 "detect which macro package is in use."
2928 msgstr ""
2929
2930 #. type: Plain text
2931 #: build/C/man7/man.7:78
2932 msgid ""
2933 "For conventions that should be employed when writing man pages for the Linux "
2934 "I<man-pages> package, see B<man-pages>(7)."
2935 msgstr ""
2936
2937 #. type: Plain text
2938 #: build/C/man7/man.7:81
2939 msgid ""
2940 "The first command in a man page (after comment lines, that is, lines that "
2941 "start with B<.\\e\">) should be"
2942 msgstr ""
2943
2944 #. type: Plain text
2945 #: build/C/man7/man.7:91
2946 msgid ""
2947 "For details of the arguments that should be supplied to the B<TH> command, "
2948 "see B<man-pages>(7)."
2949 msgstr ""
2950
2951 #. type: Plain text
2952 #: build/C/man7/man.7:97
2953 msgid ""
2954 "Note that BSD mdoc-formatted pages begin with the B<Dd> command, not the "
2955 "B<TH> command."
2956 msgstr ""
2957
2958 #. type: SS
2959 #: build/C/man7/man.7:97
2960 #, no-wrap
2961 msgid "Sections"
2962 msgstr ""
2963
2964 #.  The following doesn't seem to be required (see Debian bug 411303),
2965 #.  If the name contains spaces and appears
2966 #.  on the same line as
2967 #.  .BR \&.SH ,
2968 #.  then place the heading in double quotes.
2969 #. type: Plain text
2970 #: build/C/man7/man.7:106
2971 msgid "Sections are started with B<\\&.SH> followed by the heading name."
2972 msgstr ""
2973
2974 #. type: Plain text
2975 #: build/C/man7/man.7:109
2976 msgid ""
2977 "The only mandatory heading is NAME, which should be the first section and be "
2978 "followed on the next line by a one-line description of the program:"
2979 msgstr ""
2980
2981 #. type: Plain text
2982 #: build/C/man7/man.7:112
2983 msgid "\\&.SH NAME"
2984 msgstr ""
2985
2986 #. type: Plain text
2987 #: build/C/man7/man.7:114
2988 msgid "item \\e- description"
2989 msgstr ""
2990
2991 #. type: Plain text
2992 #: build/C/man7/man.7:128
2993 msgid ""
2994 "It is extremely important that this format is followed, and that there is a "
2995 "backslash before the single dash which follows the item name.  This syntax "
2996 "is used by the B<mandb>(8)  program to create a database of short "
2997 "descriptions for the B<whatis>(1)  and B<apropos>(1)  commands.  (See "
2998 "B<lexgrog>(1)  for further details on the syntax of the NAME section.)"
2999 msgstr ""
3000
3001 #. type: Plain text
3002 #: build/C/man7/man.7:131
3003 msgid ""
3004 "For a list of other sections that might appear in a manual page, see "
3005 "B<man-pages>(7)."
3006 msgstr ""
3007
3008 #. type: SS
3009 #: build/C/man7/man.7:131
3010 #, no-wrap
3011 msgid "Fonts"
3012 msgstr ""
3013
3014 #. type: Plain text
3015 #: build/C/man7/man.7:133
3016 msgid "The commands to select the type face are:"
3017 msgstr ""
3018
3019 #. type: TP
3020 #: build/C/man7/man.7:133
3021 #, no-wrap
3022 msgid "B<\\&.B>"
3023 msgstr ""
3024
3025 #. type: Plain text
3026 #: build/C/man7/man.7:136
3027 msgid "Bold"
3028 msgstr ""
3029
3030 #. type: TP
3031 #: build/C/man7/man.7:136
3032 #, no-wrap
3033 msgid "B<\\&.BI>"
3034 msgstr ""
3035
3036 #. type: Plain text
3037 #: build/C/man7/man.7:140
3038 msgid ""
3039 "Bold alternating with italics (especially useful for function "
3040 "specifications)"
3041 msgstr ""
3042
3043 #. type: TP
3044 #: build/C/man7/man.7:140
3045 #, no-wrap
3046 msgid "B<\\&.BR>"
3047 msgstr ""
3048
3049 #. type: Plain text
3050 #: build/C/man7/man.7:145
3051 msgid ""
3052 "Bold alternating with Roman (especially useful for referring to other manual "
3053 "pages)"
3054 msgstr ""
3055
3056 #. type: TP
3057 #: build/C/man7/man.7:145
3058 #, no-wrap
3059 msgid "B<\\&.I>"
3060 msgstr ""
3061
3062 #. type: Plain text
3063 #: build/C/man7/man.7:148
3064 msgid "Italics"
3065 msgstr ""
3066
3067 #. type: TP
3068 #: build/C/man7/man.7:148
3069 #, no-wrap
3070 msgid "B<\\&.IB>"
3071 msgstr ""
3072
3073 #. type: Plain text
3074 #: build/C/man7/man.7:151
3075 msgid "Italics alternating with bold"
3076 msgstr ""
3077
3078 #. type: TP
3079 #: build/C/man7/man.7:151
3080 #, no-wrap
3081 msgid "B<\\&.IR>"
3082 msgstr ""
3083
3084 #. type: Plain text
3085 #: build/C/man7/man.7:154
3086 msgid "Italics alternating with Roman"
3087 msgstr ""
3088
3089 #. type: TP
3090 #: build/C/man7/man.7:154
3091 #, no-wrap
3092 msgid "B<\\&.RB>"
3093 msgstr ""
3094
3095 #. type: Plain text
3096 #: build/C/man7/man.7:157
3097 msgid "Roman alternating with bold"
3098 msgstr ""
3099
3100 #. type: TP
3101 #: build/C/man7/man.7:157
3102 #, no-wrap
3103 msgid "B<\\&.RI>"
3104 msgstr ""
3105
3106 #. type: Plain text
3107 #: build/C/man7/man.7:160
3108 msgid "Roman alternating with italics"
3109 msgstr ""
3110
3111 #. type: TP
3112 #: build/C/man7/man.7:160
3113 #, no-wrap
3114 msgid "B<\\&.SB>"
3115 msgstr ""
3116
3117 #. type: Plain text
3118 #: build/C/man7/man.7:163
3119 msgid "Small alternating with bold"
3120 msgstr ""
3121
3122 #. type: TP
3123 #: build/C/man7/man.7:163
3124 #, no-wrap
3125 msgid "B<\\&.SM>"
3126 msgstr ""
3127
3128 #. type: Plain text
3129 #: build/C/man7/man.7:166
3130 msgid "Small (useful for acronyms)"
3131 msgstr ""
3132
3133 #. type: Plain text
3134 #: build/C/man7/man.7:179
3135 msgid ""
3136 "Traditionally, each command can have up to six arguments, but the GNU "
3137 "implementation removes this limitation (you might still want to limit "
3138 "yourself to 6 arguments for portability's sake).  Arguments are delimited by "
3139 "spaces.  Double quotes can be used to specify an argument which contains "
3140 "spaces.  All of the arguments will be printed next to each other without "
3141 "intervening spaces, so that the B<\\&.BR> command can be used to specify a "
3142 "word in bold followed by a mark of punctuation in Roman.  If no arguments "
3143 "are given, the command is applied to the following line of text."
3144 msgstr ""
3145
3146 #. type: SS
3147 #: build/C/man7/man.7:179
3148 #, no-wrap
3149 msgid "Other macros and strings"
3150 msgstr ""
3151
3152 #. type: Plain text
3153 #: build/C/man7/man.7:199
3154 msgid ""
3155 "Below are other relevant macros and predefined strings.  Unless noted "
3156 "otherwise, all macros cause a break (end the current line of text).  Many of "
3157 "these macros set or use the \"prevailing indent.\" The \"prevailing indent\" "
3158 "value is set by any macro with the parameter I<i> below; macros may omit "
3159 "I<i> in which case the current prevailing indent will be used.  As a result, "
3160 "successive indented paragraphs can use the same indent without respecifying "
3161 "the indent value.  A normal (nonindented) paragraph resets the prevailing "
3162 "indent value to its default value (0.5 inches).  By default a given indent "
3163 "is measured in ens; try to use ens or ems as units for indents, since these "
3164 "will automatically adjust to font size changes.  The other key macro "
3165 "definitions are:"
3166 msgstr ""
3167
3168 #. type: SS
3169 #: build/C/man7/man.7:199
3170 #, no-wrap
3171 msgid "Normal paragraphs"
3172 msgstr ""
3173
3174 #. type: TP
3175 #: build/C/man7/man.7:200
3176 #, no-wrap
3177 msgid "B<\\&.LP>"
3178 msgstr ""
3179
3180 #. type: Plain text
3181 #: build/C/man7/man.7:205 build/C/man7/man.7:210
3182 msgid "Same as B<\\&.PP> (begin a new paragraph)."
3183 msgstr ""
3184
3185 #. type: TP
3186 #: build/C/man7/man.7:205
3187 #, no-wrap
3188 msgid "B<\\&.P>"
3189 msgstr ""
3190
3191 #. type: TP
3192 #: build/C/man7/man.7:210
3193 #, no-wrap
3194 msgid "B<\\&.PP>"
3195 msgstr ""
3196
3197 #. type: Plain text
3198 #: build/C/man7/man.7:213
3199 msgid "Begin a new paragraph and reset prevailing indent."
3200 msgstr ""
3201
3202 #. type: SS
3203 #: build/C/man7/man.7:213
3204 #, no-wrap
3205 msgid "Relative margin indent"
3206 msgstr ""
3207
3208 #. type: TP
3209 #: build/C/man7/man.7:214
3210 #, no-wrap
3211 msgid "B<\\&.RS>I< i>"
3212 msgstr ""
3213
3214 #. type: Plain text
3215 #: build/C/man7/man.7:225
3216 msgid ""
3217 "Start relative margin indent: moves the left margin I<i> to the right (if "
3218 "I<i> is omitted, the prevailing indent value is used).  A new prevailing "
3219 "indent is set to 0.5 inches.  As a result, all following paragraph(s) will "
3220 "be indented until the corresponding B<\\&.RE>."
3221 msgstr ""
3222
3223 #. type: TP
3224 #: build/C/man7/man.7:225
3225 #, no-wrap
3226 msgid "B<\\&.RE>"
3227 msgstr ""
3228
3229 #. type: Plain text
3230 #: build/C/man7/man.7:229
3231 msgid ""
3232 "End relative margin indent and restores the previous value of the prevailing "
3233 "indent."
3234 msgstr ""
3235
3236 #. type: SS
3237 #: build/C/man7/man.7:229
3238 #, no-wrap
3239 msgid "Indented paragraph macros"
3240 msgstr ""
3241
3242 #. type: TP
3243 #: build/C/man7/man.7:230
3244 #, no-wrap
3245 msgid "B<\\&.HP>I< i>"
3246 msgstr ""
3247
3248 #. type: Plain text
3249 #: build/C/man7/man.7:235
3250 msgid ""
3251 "Begin paragraph with a hanging indent (the first line of the paragraph is at "
3252 "the left margin of normal paragraphs, and the rest of the paragraph's lines "
3253 "are indented)."
3254 msgstr ""
3255
3256 #. type: TP
3257 #: build/C/man7/man.7:235
3258 #, no-wrap
3259 msgid "B<\\&.IP>I< x i>"
3260 msgstr ""
3261
3262 #. type: Plain text
3263 #: build/C/man7/man.7:256
3264 msgid ""
3265 "Indented paragraph with optional hanging tag.  If the tag I<x> is omitted, "
3266 "the entire following paragraph is indented by I<i>.  If the tag I<x> is "
3267 "provided, it is hung at the left margin before the following indented "
3268 "paragraph (this is just like B<\\&.TP> except the tag is included with the "
3269 "command instead of being on the following line).  If the tag is too long, "
3270 "the text after the tag will be moved down to the next line (text will not be "
3271 "lost or garbled).  For bulleted lists, use this macro with \\e(bu (bullet) "
3272 "or \\e(em (em dash)  as the tag, and for numbered lists, use the number or "
3273 "letter followed by a period as the tag; this simplifies translation to other "
3274 "formats."
3275 msgstr ""
3276
3277 #. type: TP
3278 #: build/C/man7/man.7:256
3279 #, no-wrap
3280 msgid "B<\\&.TP>I< i>"
3281 msgstr ""
3282
3283 #. type: Plain text
3284 #: build/C/man7/man.7:263
3285 msgid ""
3286 "Begin paragraph with hanging tag.  The tag is given on the next line, but "
3287 "its results are like those of the B<\\&.IP> command."
3288 msgstr ""
3289
3290 #. type: SS
3291 #: build/C/man7/man.7:263
3292 #, no-wrap
3293 msgid "Hypertext link macros"
3294 msgstr ""
3295
3296 #. type: Plain text
3297 #: build/C/man7/man.7:273
3298 msgid ""
3299 "(Feature supported with B<groff> only.)  In order to use hypertext link "
3300 "macros, it is necessary to load the B<www.tmac> macro package.  Use the "
3301 "request B<.mso www.tmac> to do this."
3302 msgstr ""
3303
3304 #. type: TP
3305 #: build/C/man7/man.7:273
3306 #, no-wrap
3307 msgid "B<\\&.URL>I< url link trailer>"
3308 msgstr ""
3309
3310 #.  The following is a kludge to get a paragraph into the listing.
3311 #. type: Plain text
3312 #: build/C/man7/man.7:286
3313 msgid ""
3314 "Inserts a hypertext link to the URI (URL)  I<url>, with I<link> as the text "
3315 "of the link.  The I<trailer> will be printed immediately afterward.  When "
3316 "generating HTML this should translate into the HTML command B<E<lt>A "
3317 "HREF=\">I<url>B<\"E<gt>>I<link>B<E<lt>/AE<gt>>I<trailer>B<.>"
3318 msgstr ""
3319
3320 #.  The following is a kludge to get a paragraph into the listing.
3321 #. type: Plain text
3322 #: build/C/man7/man.7:293
3323 msgid ""
3324 "This and other related macros are new, and many tools won't do anything with "
3325 "them, but since many tools (including troff) will simply ignore undefined "
3326 "macros (or at worst insert their text) these are safe to insert."
3327 msgstr ""
3328
3329 #.  The following is a kludge to get a paragraph into the listing.
3330 #. type: Plain text
3331 #: build/C/man7/man.7:302
3332 msgid ""
3333 "It can be useful to define your own B<URL> macro in manual pages for the "
3334 "benefit of those viewing it with a roff viewer other than B<groff>.  That "
3335 "way, the URL, link text, and trailer text (if any) are still visible."
3336 msgstr ""
3337
3338 #. type: Plain text
3339 #: build/C/man7/man.7:305
3340 msgid "Here's an example:"
3341 msgstr ""
3342
3343 #. type: Plain text
3344 #: build/C/man7/man.7:307
3345 msgid "\\&.de URL"
3346 msgstr ""
3347
3348 #. type: Plain text
3349 #: build/C/man7/man.7:309
3350 msgid "\\e\\e$2 \\e(laURL: \\e\\e$1 \\e(ra\\e\\e$3"
3351 msgstr ""
3352
3353 #. type: Plain text
3354 #: build/C/man7/man.7:311
3355 msgid "\\&.."
3356 msgstr ""
3357
3358 #. type: Plain text
3359 #: build/C/man7/man.7:313
3360 msgid "\\&.if \\en[.g] .mso www.tmac"
3361 msgstr ""
3362
3363 #. type: Plain text
3364 #: build/C/man7/man.7:316
3365 msgid "\\&.TH I<...>"
3366 msgstr ""
3367
3368 #. type: Plain text
3369 #: build/C/man7/man.7:318
3370 msgid "I<(later in the page)>"
3371 msgstr ""
3372
3373 #. type: Plain text
3374 #: build/C/man7/man.7:320
3375 msgid "This software comes from the"
3376 msgstr ""
3377
3378 #. type: Plain text
3379 #: build/C/man7/man.7:322
3380 msgid "\\&.URL \"http://www.gnu.org/\" \"GNU Project\" \" of the\""
3381 msgstr ""
3382
3383 #. type: Plain text
3384 #: build/C/man7/man.7:324
3385 msgid "\\&.URL \"http://www.fsf.org/\" \"Free Software Foundation\" ."
3386 msgstr ""
3387
3388 #. type: Plain text
3389 #: build/C/man7/man.7:334
3390 msgid ""
3391 "In the above, if B<groff> is being used, the B<www.tmac> macro package's "
3392 "definition of the URL macro will supersede the locally defined one."
3393 msgstr ""
3394
3395 #. type: Plain text
3396 #: build/C/man7/man.7:339
3397 msgid ""
3398 "A number of other link macros are available.  See B<groff_www>(7)  for more "
3399 "details."
3400 msgstr ""
3401
3402 #. type: SS
3403 #: build/C/man7/man.7:339
3404 #, no-wrap
3405 msgid "Miscellaneous macros"
3406 msgstr ""
3407
3408 #. type: TP
3409 #: build/C/man7/man.7:340
3410 #, no-wrap
3411 msgid "B<\\&.DT>"
3412 msgstr ""
3413
3414 #. type: Plain text
3415 #: build/C/man7/man.7:344
3416 msgid "Reset tabs to default tab values (every 0.5 inches); does not cause a break."
3417 msgstr ""
3418
3419 #. type: TP
3420 #: build/C/man7/man.7:344
3421 #, no-wrap
3422 msgid "B<\\&.PD>I< d>"
3423 msgstr ""
3424
3425 #. type: Plain text
3426 #: build/C/man7/man.7:349
3427 msgid ""
3428 "Set inter-paragraph vertical distance to d (if omitted, d=0.4v); does not "
3429 "cause a break."
3430 msgstr ""
3431
3432 #. type: TP
3433 #: build/C/man7/man.7:349
3434 #, no-wrap
3435 msgid "B<\\&.SS>I< t>"
3436 msgstr ""
3437
3438 #. type: Plain text
3439 #: build/C/man7/man.7:356
3440 msgid ""
3441 "Subheading I<t> (like B<\\&.SH>, but used for a subsection inside a "
3442 "section)."
3443 msgstr ""
3444
3445 #. type: SS
3446 #: build/C/man7/man.7:356
3447 #, no-wrap
3448 msgid "Predefined strings"
3449 msgstr ""
3450
3451 #. type: Plain text
3452 #: build/C/man7/man.7:360
3453 msgid "The B<man> package has the following predefined strings:"
3454 msgstr ""
3455
3456 #. type: IP
3457 #: build/C/man7/man.7:360
3458 #, no-wrap
3459 msgid "\\e*R"
3460 msgstr ""
3461
3462 #. type: Plain text
3463 #: build/C/man7/man.7:362
3464 msgid "Registration Symbol: \\*R"
3465 msgstr ""
3466
3467 #. type: IP
3468 #: build/C/man7/man.7:362
3469 #, no-wrap
3470 msgid "\\e*S"
3471 msgstr ""
3472
3473 #. type: Plain text
3474 #: build/C/man7/man.7:364
3475 msgid "Change to default font size"
3476 msgstr ""
3477
3478 #. type: IP
3479 #: build/C/man7/man.7:364
3480 #, no-wrap
3481 msgid "\\e*(Tm"
3482 msgstr ""
3483
3484 #. type: Plain text
3485 #: build/C/man7/man.7:366
3486 msgid "Trademark Symbol: \\*(Tm"
3487 msgstr ""
3488
3489 #. type: IP
3490 #: build/C/man7/man.7:366
3491 #, no-wrap
3492 msgid "\\e*(lq"
3493 msgstr ""
3494
3495 #. type: Plain text
3496 #: build/C/man7/man.7:368
3497 msgid "Left angled double quote: ``"
3498 msgstr ""
3499
3500 #. type: IP
3501 #: build/C/man7/man.7:368
3502 #, no-wrap
3503 msgid "\\e*(rq"
3504 msgstr ""
3505
3506 #. type: Plain text
3507 #: build/C/man7/man.7:370
3508 msgid "Right angled double quote: ''"
3509 msgstr ""
3510
3511 #. type: SS
3512 #: build/C/man7/man.7:370
3513 #, no-wrap
3514 msgid "Safe subset"
3515 msgstr ""
3516
3517 #. type: Plain text
3518 #: build/C/man7/man.7:414
3519 msgid ""
3520 "Although technically B<man> is a troff macro package, in reality a large "
3521 "number of other tools process man page files that don't implement all of "
3522 "troff's abilities.  Thus, it's best to avoid some of troff's more exotic "
3523 "abilities where possible to permit these other tools to work correctly.  "
3524 "Avoid using the various troff preprocessors (if you must, go ahead and use "
3525 "B<tbl>(1), but try to use the B<IP> and B<TP> commands instead for "
3526 "two-column tables).  Avoid using computations; most other tools can't "
3527 "process them.  Use simple commands that are easy to translate to other "
3528 "formats.  The following troff macros are believed to be safe (though in many "
3529 "cases they will be ignored by translators): B<\\e\">, B<.>, B<ad>, B<bp>, "
3530 "B<br>, B<ce>, B<de>, B<ds>, B<el>, B<ie>, B<if>, B<fi>, B<ft>, B<hy>, B<ig>, "
3531 "B<in>, B<na>, B<ne>, B<nf>, B<nh>, B<ps>, B<so>, B<sp>, B<ti>, B<tr>."
3532 msgstr ""
3533
3534 #. type: Plain text
3535 #: build/C/man7/man.7:437
3536 msgid ""
3537 "You may also use many troff escape sequences (those sequences beginning with "
3538 "\\e).  When you need to include the backslash character as normal text, use "
3539 "\\ee.  Other sequences you may use, where x or xx are any characters and N "
3540 "is any digit, include: B<\\e'>, B<\\e`>, B<\\e->, B<\\e.>, B<\\e\">, "
3541 "B<\\e%>, B<\\e*x>, B<\\e*(xx>, B<\\e(xx>, B<\\e$N>, B<\\enx>, B<\\en(xx>, "
3542 "B<\\efx>, and B<\\ef(xx>.  Avoid using the escape sequences for drawing "
3543 "graphics."
3544 msgstr ""
3545
3546 #. type: Plain text
3547 #: build/C/man7/man.7:468
3548 msgid ""
3549 "Do not use the optional parameter for B<bp> (break page).  Use only positive "
3550 "values for B<sp> (vertical space).  Don't define a macro (B<de>)  with the "
3551 "same name as a macro in this or the mdoc macro package with a different "
3552 "meaning; it's likely that such redefinitions will be ignored.  Every "
3553 "positive indent (B<in>)  should be paired with a matching negative indent "
3554 "(although you should be using the B<RS> and B<RE> macros instead).  The "
3555 "condition test (B<if,ie>)  should only have \\(aqt\\(aq or \\(aqn\\(aq as "
3556 "the condition.  Only translations (B<tr>)  that can be ignored should be "
3557 "used.  Font changes (B<ft> and the B<\\ef> escape sequence)  should only "
3558 "have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have "
3559 "no parameters)."
3560 msgstr ""
3561
3562 #. type: Plain text
3563 #: build/C/man7/man.7:475
3564 msgid ""
3565 "If you use capabilities beyond these, check the results carefully on several "
3566 "tools.  Once you've confirmed that the additional capability is safe, let "
3567 "the maintainer of this document know about the safe command or sequence that "
3568 "should be added to this list."
3569 msgstr ""
3570
3571 #. type: Plain text
3572 #: build/C/man7/man.7:477
3573 msgid "I</usr/share/groff/>[*/]I<tmac/an.tmac>"
3574 msgstr ""
3575
3576 #. type: Plain text
3577 #: build/C/man7/man.7:479
3578 msgid "I</usr/man/whatis>"
3579 msgstr ""
3580
3581 #. type: Plain text
3582 #: build/C/man7/man.7:493
3583 msgid ""
3584 "By all means include full URLs (or URIs) in the text itself; some tools such "
3585 "as B<man2html>(1)  can automatically turn them into hypertext links.  You "
3586 "can also use the new B<URL> macro to identify links to related information.  "
3587 "If you include URLs, use the full URL (e.g., E<.UR "
3588 "http://www.kernelnotes.org> E<.UE )> to ensure that tools can automatically "
3589 "find the URLs."
3590 msgstr ""
3591
3592 #. type: Plain text
3593 #: build/C/man7/man.7:502
3594 msgid ""
3595 "Tools processing these files should open the file and examine the first "
3596 "nonwhitespace character.  A period (.) or single quote (') at the beginning "
3597 "of a line indicates a troff-based file (such as man or mdoc).  A left angle "
3598 "bracket (E<lt>) indicates an SGML/XML-based file (such as HTML or Docbook).  "
3599 "Anything else suggests simple ASCII text (e.g., a \"catman\" result)."
3600 msgstr ""
3601
3602 #. type: Plain text
3603 #: build/C/man7/man.7:513
3604 msgid ""
3605 "Many man pages begin with B<\\'\\e\"> followed by a space and a list of "
3606 "characters, indicating how the page is to be preprocessed.  For "
3607 "portability's sake to non-troff translators we recommend that you avoid "
3608 "using anything other than B<tbl>(1), and Linux can detect that "
3609 "automatically.  However, you might want to include this information so your "
3610 "man page can be handled by other (less capable) systems.  Here are the "
3611 "definitions of the preprocessors invoked by these characters:"
3612 msgstr ""
3613
3614 #. type: TP
3615 #: build/C/man7/man.7:513
3616 #, no-wrap
3617 msgid "B<e>"
3618 msgstr ""
3619
3620 #. type: Plain text
3621 #: build/C/man7/man.7:516
3622 msgid "eqn(1)"
3623 msgstr ""
3624
3625 #. type: TP
3626 #: build/C/man7/man.7:516
3627 #, no-wrap
3628 msgid "B<g>"
3629 msgstr ""
3630
3631 #. type: Plain text
3632 #: build/C/man7/man.7:519
3633 msgid "grap(1)"
3634 msgstr ""
3635
3636 #. type: TP
3637 #: build/C/man7/man.7:519
3638 #, no-wrap
3639 msgid "B<p>"
3640 msgstr ""
3641
3642 #. type: Plain text
3643 #: build/C/man7/man.7:522
3644 msgid "pic(1)"
3645 msgstr ""
3646
3647 #. type: TP
3648 #: build/C/man7/man.7:522
3649 #, no-wrap
3650 msgid "B<r>"
3651 msgstr ""
3652
3653 #. type: Plain text
3654 #: build/C/man7/man.7:525
3655 msgid "refer(1)"
3656 msgstr ""
3657
3658 #. type: TP
3659 #: build/C/man7/man.7:525
3660 #, no-wrap
3661 msgid "B<t>"
3662 msgstr ""
3663
3664 #. type: Plain text
3665 #: build/C/man7/man.7:528
3666 msgid "tbl(1)"
3667 msgstr ""
3668
3669 #. type: TP
3670 #: build/C/man7/man.7:528
3671 #, no-wrap
3672 msgid "B<v>"
3673 msgstr ""
3674
3675 #. type: Plain text
3676 #: build/C/man7/man.7:531
3677 msgid "vgrind(1)"
3678 msgstr ""
3679
3680 #. type: Sh
3681 #: build/C/man7/man.7:531 build/C/man7/suffixes.7:279 build/C/man7/mdoc.samples.7:2883
3682 #, no-wrap
3683 msgid "BUGS"
3684 msgstr ""
3685
3686 #. type: Plain text
3687 #: build/C/man7/man.7:544
3688 msgid ""
3689 "Most of the macros describe formatting (e.g., font type and spacing) instead "
3690 "of marking semantic content (e.g., this text is a reference to another "
3691 "page), compared to formats like mdoc and DocBook (even HTML has more "
3692 "semantic markings).  This situation makes it harder to vary the B<man> "
3693 "format for different media, to make the formatting consistent for a given "
3694 "media, and to automatically insert cross-references.  By sticking to the "
3695 "safe subset described above, it should be easier to automate transitioning "
3696 "to a different reference page format in the future."
3697 msgstr ""
3698
3699 #.  .SH AUTHORS
3700 #.  .IP \(em 3m
3701 #.  James Clark (jjc@jclark.com) wrote the implementation of the macro package.
3702 #.  .IP \(em
3703 #.  Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
3704 #.  this manual page.
3705 #.  .IP \(em
3706 #.  Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
3707 #.  (which influenced this manual page).
3708 #.  .IP \(em
3709 #.  David A. Wheeler (dwheeler@ida.org) heavily modified this
3710 #.  manual page, such as adding detailed information on sections and macros.
3711 #. type: Plain text
3712 #: build/C/man7/man.7:560
3713 msgid "The Sun macro B<TX> is not implemented."
3714 msgstr ""
3715
3716 #. type: Plain text
3717 #: build/C/man7/man.7:572
3718 msgid ""
3719 "B<apropos>(1), B<groff>(1), B<lexgrog>(1), B<man>(1), B<man2html>(1), "
3720 "B<whatis>(1), B<groff_man>(7), B<groff_www>(7), B<man-pages>(7), B<mdoc>(7), "
3721 "B<mdoc.samples>(7)"
3722 msgstr ""
3723
3724 #. type: Dd
3725 #: build/C/man7/mdoc.7:42
3726 #, no-wrap
3727 msgid "July 11, 1999"
3728 msgstr ""
3729
3730 #. type: Dt
3731 #: build/C/man7/mdoc.7:43
3732 #, no-wrap
3733 msgid "MDOC 7"
3734 msgstr ""
3735
3736 #. type: Plain text
3737 #: build/C/man7/mdoc.7:47
3738 msgid "E<.Nm mdoc>"
3739 msgstr ""
3740
3741 #. type: Nd
3742 #: build/C/man7/mdoc.7:47
3743 #, no-wrap
3744 msgid "quick reference guide for the"
3745 msgstr ""
3746
3747 #. type: Plain text
3748 #: build/C/man7/mdoc.7:50
3749 msgid "E<.Nm \\-mdoc> macro package"
3750 msgstr ""
3751
3752 #. type: Plain text
3753 #: build/C/man7/mdoc.7:54
3754 msgid "E<.Nm groff> E<.Fl m Ns Ar doc> E<.Ar files ...>"
3755 msgstr ""
3756
3757 #. type: Plain text
3758 #: build/C/man7/mdoc.7:66
3759 msgid ""
3760 "The E<.Nm \\-mdoc> package is a set of content-based and domain-based macros "
3761 "used to format the E<.Bx> man pages.  The macro names and their meanings are "
3762 "listed below for quick reference; for a detailed explanation on using the "
3763 "package, see the tutorial sampler E<.Xr mdoc.samples 7>."
3764 msgstr ""
3765
3766 #. type: Plain text
3767 #: build/C/man7/mdoc.7:71
3768 msgid ""
3769 "Note that this is not the usual macro package for Linux documentation, "
3770 "although it is used for documentation of several widely used programs; see "
3771 "E<.Xr man 7>."
3772 msgstr ""
3773
3774 #. type: Plain text
3775 #: build/C/man7/mdoc.7:80
3776 msgid ""
3777 "The macros are described in two groups, the first includes the structural "
3778 "and physical page layout macros.  The second contains the manual and general "
3779 "text domain macros which differentiate the E<.Nm \\-mdoc> package from other "
3780 "E<.Xr troff> formatting packages."
3781 msgstr ""
3782
3783 #. type: Sh
3784 #: build/C/man7/mdoc.7:80 build/C/man7/mdoc.samples.7:1811
3785 #, no-wrap
3786 msgid "PAGE STRUCTURE DOMAIN"
3787 msgstr ""
3788
3789 #. type: Ss
3790 #: build/C/man7/mdoc.7:81
3791 #, no-wrap
3792 msgid "Title Macros"
3793 msgstr ""
3794
3795 #. type: Plain text
3796 #: build/C/man7/mdoc.7:84
3797 msgid ""
3798 "To create a valid manual page, these three macros, in this order, are "
3799 "required:"
3800 msgstr ""
3801
3802 #. type: It
3803 #: build/C/man7/mdoc.7:85
3804 #, no-wrap
3805 msgid "Li \"\\&.Dd  \" Ar \"Month day, year\""
3806 msgstr ""
3807
3808 #. type: Plain text
3809 #: build/C/man7/mdoc.7:87
3810 msgid "Document date."
3811 msgstr ""
3812
3813 #. type: It
3814 #: build/C/man7/mdoc.7:87
3815 #, no-wrap
3816 msgid "Li \"\\&.Dt  \" Ar \"DOCUMENT_TITLE [section] [volume]\""
3817 msgstr ""
3818
3819 #. type: Plain text
3820 #: build/C/man7/mdoc.7:89
3821 msgid "Title, in upper case."
3822 msgstr ""
3823
3824 #. type: It
3825 #: build/C/man7/mdoc.7:89
3826 #, no-wrap
3827 msgid "Li \"\\&.Os  \" Ar \"OPERATING_SYSTEM [version/release]\""
3828 msgstr ""
3829
3830 #. type: Plain text
3831 #: build/C/man7/mdoc.7:92
3832 msgid "Operating system E<.Pq Tn BSD>."
3833 msgstr ""
3834
3835 #. type: Ss
3836 #: build/C/man7/mdoc.7:93
3837 #, no-wrap
3838 msgid "Page Layout Macros"
3839 msgstr ""
3840
3841 #. type: Plain text
3842 #: build/C/man7/mdoc.7:95
3843 msgid "Section headers, paragraph breaks, lists and displays."
3844 msgstr ""
3845
3846 #. type: It
3847 #: build/C/man7/mdoc.7:96
3848 #, no-wrap
3849 msgid "Li \\&.Sh"
3850 msgstr ""
3851
3852 #. type: Plain text
3853 #: build/C/man7/mdoc.7:99
3854 msgid "Section Headers.  Valid headers, in the order of presentation:"
3855 msgstr ""
3856
3857 #. type: It
3858 #: build/C/man7/mdoc.7:100
3859 #, no-wrap
3860 msgid "Ar NAME"
3861 msgstr ""
3862
3863 #. type: Plain text
3864 #: build/C/man7/mdoc.7:108
3865 msgid ""
3866 "Name section, should include the E<.Ql \\&.Nm> or E<.Ql \\&.Fn> and the "
3867 "E<.Ql \\&.Nd> macros."
3868 msgstr ""
3869
3870 #. type: It
3871 #: build/C/man7/mdoc.7:108
3872 #, no-wrap
3873 msgid "Ar SYNOPSIS"
3874 msgstr ""
3875
3876 #. type: Plain text
3877 #: build/C/man7/mdoc.7:110
3878 msgid "Usage."
3879 msgstr ""
3880
3881 #. type: It
3882 #: build/C/man7/mdoc.7:110
3883 #, no-wrap
3884 msgid "Ar DESCRIPTION"
3885 msgstr ""
3886
3887 #. type: Plain text
3888 #: build/C/man7/mdoc.7:113
3889 msgid "General description, should include options and parameters."
3890 msgstr ""
3891
3892 #. type: It
3893 #: build/C/man7/mdoc.7:113
3894 #, no-wrap
3895 msgid "Ar RETURN VALUE"
3896 msgstr ""
3897
3898 #. type: Plain text
3899 #: build/C/man7/mdoc.7:115
3900 msgid "Sections two and three function calls."
3901 msgstr ""
3902
3903 #. type: It
3904 #: build/C/man7/mdoc.7:115
3905 #, no-wrap
3906 msgid "Ar ENVIRONMENT"
3907 msgstr ""
3908
3909 #. type: Plain text
3910 #: build/C/man7/mdoc.7:117
3911 msgid "Describe environment variables."
3912 msgstr ""
3913
3914 #. type: It
3915 #: build/C/man7/mdoc.7:117
3916 #, no-wrap
3917 msgid "Ar FILES"
3918 msgstr ""
3919
3920 #. type: Plain text
3921 #: build/C/man7/mdoc.7:119
3922 msgid "Files associated with the subject."
3923 msgstr ""
3924
3925 #. type: It
3926 #: build/C/man7/mdoc.7:119
3927 #, no-wrap
3928 msgid "Ar EXAMPLES"
3929 msgstr ""
3930
3931 #. type: Plain text
3932 #: build/C/man7/mdoc.7:121
3933 msgid "Examples and suggestions."
3934 msgstr ""
3935
3936 #. type: It
3937 #: build/C/man7/mdoc.7:121
3938 #, no-wrap
3939 msgid "Ar DIAGNOSTICS"
3940 msgstr ""
3941
3942 #. type: Plain text
3943 #: build/C/man7/mdoc.7:123
3944 msgid "Normally used for section four device interface diagnostics."
3945 msgstr ""
3946
3947 #. type: It
3948 #: build/C/man7/mdoc.7:123
3949 #, no-wrap
3950 msgid "Ar ERRORS"
3951 msgstr ""
3952
3953 #. type: Plain text
3954 #: build/C/man7/mdoc.7:126
3955 msgid "Sections two and three error and signal handling."
3956 msgstr ""
3957
3958 #. type: It
3959 #: build/C/man7/mdoc.7:126
3960 #, no-wrap
3961 msgid "Ar SEE ALSO"
3962 msgstr ""
3963
3964 #. type: Plain text
3965 #: build/C/man7/mdoc.7:128
3966 msgid "Cross references and citations."
3967 msgstr ""
3968
3969 #. type: It
3970 #: build/C/man7/mdoc.7:128
3971 #, no-wrap
3972 msgid "Ar CONFORMING TO"
3973 msgstr ""
3974
3975 #. type: Plain text
3976 #: build/C/man7/mdoc.7:130
3977 msgid "Conformance to standards if applicable."
3978 msgstr ""
3979
3980 #. type: It
3981 #: build/C/man7/mdoc.7:130
3982 #, no-wrap
3983 msgid "Ar HISTORY"
3984 msgstr ""
3985
3986 #. type: Plain text
3987 #: build/C/man7/mdoc.7:133
3988 msgid "If a standard is not applicable, the history of the subject should be given."
3989 msgstr ""
3990
3991 #. type: It
3992 #: build/C/man7/mdoc.7:133
3993 #, no-wrap
3994 msgid "Ar BUGS"
3995 msgstr ""
3996
3997 #. type: Plain text
3998 #: build/C/man7/mdoc.7:135
3999 msgid "Gotchas and caveats."
4000 msgstr ""
4001
4002 #. type: It
4003 #: build/C/man7/mdoc.7:135
4004 #, no-wrap
4005 msgid "Ar other"
4006 msgstr ""
4007
4008 #. type: Plain text
4009 #: build/C/man7/mdoc.7:138
4010 msgid "Customized headers may be added at the authors discretion."
4011 msgstr ""
4012
4013 #. type: It
4014 #: build/C/man7/mdoc.7:139
4015 #, no-wrap
4016 msgid "Li \\&.Ss"
4017 msgstr ""
4018
4019 #. type: Plain text
4020 #: build/C/man7/mdoc.7:141
4021 msgid "Subsection Headers."
4022 msgstr ""
4023
4024 #. type: It
4025 #: build/C/man7/mdoc.7:141
4026 #, no-wrap
4027 msgid "Li \\&.Pp"
4028 msgstr ""
4029
4030 #. type: Plain text
4031 #: build/C/man7/mdoc.7:144
4032 msgid "Paragraph Break.  Vertical space (one line)."
4033 msgstr ""
4034
4035 #. type: It
4036 #: build/C/man7/mdoc.7:144 build/C/man7/mdoc.samples.7:2200
4037 #, no-wrap
4038 msgid "Li \\&.D1"
4039 msgstr ""
4040
4041 #. type: Plain text
4042 #: build/C/man7/mdoc.7:147
4043 msgid "(D-one) Display-one Indent and display one text line."
4044 msgstr ""
4045
4046 #. type: It
4047 #: build/C/man7/mdoc.7:147 build/C/man7/mdoc.samples.7:2208
4048 #, no-wrap
4049 msgid "Li \\&.Dl"
4050 msgstr ""
4051
4052 #. type: Plain text
4053 #: build/C/man7/mdoc.7:150
4054 msgid "(D-ell) Display-one literal.  Indent and display one line of literal text."
4055 msgstr ""
4056
4057 #. type: It
4058 #: build/C/man7/mdoc.7:150 build/C/man7/mdoc.samples.7:2228
4059 #, no-wrap
4060 msgid "Li \\&.Bd"
4061 msgstr ""
4062
4063 #. type: Plain text
4064 #: build/C/man7/mdoc.7:153
4065 msgid "Begin-display block.  Display options:"
4066 msgstr ""
4067
4068 #. type: It
4069 #: build/C/man7/mdoc.7:154 build/C/man7/mdoc.samples.7:2248
4070 #, no-wrap
4071 msgid "Fl ragged"
4072 msgstr ""
4073
4074 #. type: Plain text
4075 #: build/C/man7/mdoc.7:156
4076 msgid "Unjustified (ragged edges)."
4077 msgstr ""
4078
4079 #. type: It
4080 #: build/C/man7/mdoc.7:156 build/C/man7/mdoc.samples.7:2251
4081 #, no-wrap
4082 msgid "Fl filled"
4083 msgstr ""
4084
4085 #. type: Plain text
4086 #: build/C/man7/mdoc.7:158
4087 msgid "Justified."
4088 msgstr ""
4089
4090 #. type: It
4091 #: build/C/man7/mdoc.7:158 build/C/man7/mdoc.samples.7:2255
4092 #, no-wrap
4093 msgid "Fl literal"
4094 msgstr ""
4095
4096 #. type: Plain text
4097 #: build/C/man7/mdoc.7:160
4098 msgid "Literal text or code."
4099 msgstr ""
4100
4101 #. type: It
4102 #: build/C/man7/mdoc.7:160
4103 #, no-wrap
4104 msgid "Fl file Ar name"
4105 msgstr ""
4106
4107 #. type: Plain text
4108 #: build/C/man7/mdoc.7:164
4109 msgid "Read in named E<.Ar file> and display."
4110 msgstr ""
4111
4112 #. type: It
4113 #: build/C/man7/mdoc.7:164 build/C/man7/mdoc.samples.7:2267
4114 #, no-wrap
4115 msgid "Fl offset Ar string"
4116 msgstr ""
4117
4118 #. type: Plain text
4119 #: build/C/man7/mdoc.7:169
4120 msgid "Offset display.  Acceptable E<.Ar string> values:"
4121 msgstr ""
4122
4123 #. type: It
4124 #: build/C/man7/mdoc.7:170 build/C/man7/mdoc.samples.7:2275
4125 #, no-wrap
4126 msgid "Ar left"
4127 msgstr ""
4128
4129 #. type: Plain text
4130 #: build/C/man7/mdoc.7:172
4131 msgid "Align block on left (default)."
4132 msgstr ""
4133
4134 #. type: It
4135 #: build/C/man7/mdoc.7:172 build/C/man7/mdoc.samples.7:2279
4136 #, no-wrap
4137 msgid "Ar center"
4138 msgstr ""
4139
4140 #. type: Plain text
4141 #: build/C/man7/mdoc.7:174
4142 msgid "Approximate center margin."
4143 msgstr ""
4144
4145 #. type: It
4146 #: build/C/man7/mdoc.7:174 build/C/man7/mdoc.samples.7:2284
4147 #, no-wrap
4148 msgid "Ar indent"
4149 msgstr ""
4150
4151 #. type: Plain text
4152 #: build/C/man7/mdoc.7:176
4153 msgid "Six constant width spaces (a tab)."
4154 msgstr ""
4155
4156 #. type: It
4157 #: build/C/man7/mdoc.7:176 build/C/man7/mdoc.samples.7:2293
4158 #, no-wrap
4159 msgid "Ar indent-two"
4160 msgstr ""
4161
4162 #. type: Plain text
4163 #: build/C/man7/mdoc.7:178
4164 msgid "Two tabs."
4165 msgstr ""
4166
4167 #. type: It
4168 #: build/C/man7/mdoc.7:178 build/C/man7/mdoc.samples.7:2295
4169 #, no-wrap
4170 msgid "Ar right"
4171 msgstr ""
4172
4173 #. type: Plain text
4174 #: build/C/man7/mdoc.7:181
4175 msgid "Left aligns block 2 inches from right."
4176 msgstr ""
4177
4178 #. type: It
4179 #: build/C/man7/mdoc.7:181
4180 #, no-wrap
4181 msgid "Ar xx Ns Cm n"
4182 msgstr ""
4183
4184 #. type: Plain text
4185 #: build/C/man7/mdoc.7:188
4186 msgid ""
4187 "Where E<.Ar xx> is a number from E<.No \\&4 Ns Cm n> to E<.No \\&9\\&9 Ns Cm "
4188 "n>."
4189 msgstr ""
4190
4191 #. type: It
4192 #: build/C/man7/mdoc.7:188
4193 #, no-wrap
4194 msgid "Ar Aa"
4195 msgstr ""
4196
4197 #. type: Plain text
4198 #: build/C/man7/mdoc.7:192
4199 msgid "Where E<.Ar Aa> is a callable macro name."
4200 msgstr ""
4201
4202 #. type: It
4203 #: build/C/man7/mdoc.7:192
4204 #, no-wrap
4205 msgid "Ar string"
4206 msgstr ""
4207
4208 #. type: Plain text
4209 #: build/C/man7/mdoc.7:196
4210 msgid "The width of E<.Ar string> is used."
4211 msgstr ""
4212
4213 #. type: It
4214 #: build/C/man7/mdoc.7:198
4215 #, no-wrap
4216 msgid "Li \\&.Ed"
4217 msgstr ""
4218
4219 #. type: Plain text
4220 #: build/C/man7/mdoc.7:200
4221 msgid "End-display (matches \\&.Bd)."
4222 msgstr ""
4223
4224 #. type: It
4225 #: build/C/man7/mdoc.7:200
4226 #, no-wrap
4227 msgid "Li \\&.Bl"
4228 msgstr ""
4229
4230 #. type: Plain text
4231 #: build/C/man7/mdoc.7:204
4232 msgid "Begin-list.  Create lists or columns.  Options:"
4233 msgstr ""
4234
4235 #. type: It
4236 #: build/C/man7/mdoc.7:205
4237 #, no-wrap
4238 msgid "Ar List-types"
4239 msgstr ""
4240
4241 #. type: It
4242 #: build/C/man7/mdoc.7:207
4243 #, no-wrap
4244 msgid "Fl bullet Ta \"Bullet Item List\""
4245 msgstr ""
4246
4247 #. type: It
4248 #: build/C/man7/mdoc.7:208
4249 #, no-wrap
4250 msgid "Fl item Ta \"Unlabeled List\""
4251 msgstr ""
4252
4253 #. type: It
4254 #: build/C/man7/mdoc.7:209
4255 #, no-wrap
4256 msgid "Fl enum Ta \"Enumerated List\""
4257 msgstr ""
4258
4259 #. type: It
4260 #: build/C/man7/mdoc.7:210
4261 #, no-wrap
4262 msgid "Fl tag Ta \"Tag Labeled List\""
4263 msgstr ""
4264
4265 #. type: It
4266 #: build/C/man7/mdoc.7:211
4267 #, no-wrap
4268 msgid "Fl diag Ta \"Diagnostic List\""
4269 msgstr ""
4270
4271 #. type: It
4272 #: build/C/man7/mdoc.7:212
4273 #, no-wrap
4274 msgid "Fl hang Ta \"Hanging Labeled List\""
4275 msgstr ""
4276
4277 #. type: It
4278 #: build/C/man7/mdoc.7:213
4279 #, no-wrap
4280 msgid "Fl ohang Ta \"Overhanging Labeled List\""
4281 msgstr ""
4282
4283 #. type: It
4284 #: build/C/man7/mdoc.7:214
4285 #, no-wrap
4286 msgid "Fl inset Ta \"Inset or Run-on Labeled List\""
4287 msgstr ""
4288
4289 #. type: It
4290 #: build/C/man7/mdoc.7:216
4291 #, no-wrap
4292 msgid "List-parameters"
4293 msgstr ""
4294
4295 #. type: It
4296 #: build/C/man7/mdoc.7:218
4297 #, no-wrap
4298 msgid "Fl offset"
4299 msgstr ""
4300
4301 #. type: Plain text
4302 #: build/C/man7/mdoc.7:222
4303 msgid "(All lists.) See E<.Ql \\&.Bd> begin-display above."
4304 msgstr ""
4305
4306 #. type: It
4307 #: build/C/man7/mdoc.7:222
4308 #, no-wrap
4309 msgid "Fl width"
4310 msgstr ""
4311
4312 #. type: Plain text
4313 #: build/C/man7/mdoc.7:229
4314 msgid "E<.Pf ( Fl tag> and E<.Fl hang> lists only.)  See E<.Ql \\&.Bd>."
4315 msgstr ""
4316
4317 #. type: It
4318 #: build/C/man7/mdoc.7:229
4319 #, no-wrap
4320 msgid "Fl compact"
4321 msgstr ""
4322
4323 #. type: Plain text
4324 #: build/C/man7/mdoc.7:232
4325 msgid "(All lists.)  Suppresses blank lines."
4326 msgstr ""
4327
4328 #. type: It
4329 #: build/C/man7/mdoc.7:234
4330 #, no-wrap
4331 msgid "Li \\&.El"
4332 msgstr ""
4333
4334 #. type: Plain text
4335 #: build/C/man7/mdoc.7:236
4336 msgid "End-list."
4337 msgstr ""
4338
4339 #. type: It
4340 #: build/C/man7/mdoc.7:236
4341 #, no-wrap
4342 msgid "Li \\&.It"
4343 msgstr ""
4344
4345 #. type: Plain text
4346 #: build/C/man7/mdoc.7:238
4347 msgid "List item."
4348 msgstr ""
4349
4350 #. type: Sh
4351 #: build/C/man7/mdoc.7:239
4352 #, no-wrap
4353 msgid "MANUAL AND GENERAL TEXT DOMAIN MACROS"
4354 msgstr ""
4355
4356 #. type: Plain text
4357 #: build/C/man7/mdoc.7:243
4358 msgid ""
4359 "The manual and general text domain macros are special in that most of them "
4360 "are parsed for callable macros for example:"
4361 msgstr ""
4362
4363 #. type: It
4364 #: build/C/man7/mdoc.7:244
4365 #, no-wrap
4366 msgid "Li \"\\&.Op Fl s Ar file\""
4367 msgstr ""
4368
4369 #. type: Plain text
4370 #: build/C/man7/mdoc.7:247
4371 msgid "Produces E<.Op Fl s Ar file>"
4372 msgstr ""
4373
4374 #. type: Plain text
4375 #: build/C/man7/mdoc.7:265
4376 msgid ""
4377 "In this example, the option enclosure macro E<.Ql \\&.Op> is parsed, and "
4378 "calls the callable content macro E<.Ql \\&Fl> which operates on the argument "
4379 "E<.Ql s> and then calls the callable content macro E<.Ql \\&Ar> which "
4380 "operates on the argument E<.Ql file>.  Some macros may be callable, but are "
4381 "not parsed and vice versa.  These macros are indicated in the E<.Em parsed> "
4382 "and E<.Em callable> columns below."
4383 msgstr ""
4384
4385 #. type: Plain text
4386 #: build/C/man7/mdoc.7:267
4387 msgid "Unless stated, manual domain macros share a common syntax:"
4388 msgstr ""
4389
4390 #. type: Dl
4391 #: build/C/man7/mdoc.7:268
4392 #, no-wrap
4393 msgid "\\&.Va argument [\\ .\\ ,\\ ;\\ :\\ (\\ )\\ [\\ ]\\ argument ...\\ ]"
4394 msgstr ""
4395
4396 #. type: Plain text
4397 #: build/C/man7/mdoc.7:288
4398 msgid ""
4399 "E<.Sy Note>: Opening and closing punctuation characters are recognized as "
4400 "such only if they are presented one at a time.  The string E<.Ql \"),\"> is "
4401 "not recognized as punctuation and will be output with a leading white space "
4402 "and in what ever font the calling macro uses.  The argument list E<.Ql \"] ) "
4403 ",\"> is recognized as three sequential closing punctuation characters and a "
4404 "leading white space is not output between the characters and the previous "
4405 "argument (if any).  The special meaning of a punctuation character may be "
4406 "escaped with the string E<.Ql \\e&>.  For example the following string,"
4407 msgstr ""
4408
4409 #. type: It
4410 #: build/C/man7/mdoc.7:289
4411 #, no-wrap
4412 msgid "Li \"\\&.Ar file1\\ , file2\\ , file3\\ )\\ .\""
4413 msgstr ""
4414
4415 #. type: Plain text
4416 #: build/C/man7/mdoc.7:292
4417 msgid "Produces E<.Ar file1 , file2 , file3>)."
4418 msgstr ""
4419
4420 #. type: Ss
4421 #: build/C/man7/mdoc.7:294
4422 #, no-wrap
4423 msgid "Manual Domain Macros"
4424 msgstr ""
4425
4426 #. type: It
4427 #: build/C/man7/mdoc.7:296 build/C/man7/mdoc.7:321
4428 #, no-wrap
4429 msgid "Em \"Name\tParsed\tCallable\tDescription\""
4430 msgstr ""
4431
4432 #. type: It
4433 #: build/C/man7/mdoc.7:297
4434 #, no-wrap
4435 msgid "Li \\&Ad Ta Yes Ta Yes Ta \"Address. (This macro may be deprecated.)\""
4436 msgstr ""
4437
4438 #. type: It
4439 #: build/C/man7/mdoc.7:298
4440 #, no-wrap
4441 msgid "Li \\&An Ta Yes Ta Yes Ta \"Author name.\""
4442 msgstr ""
4443
4444 #. type: It
4445 #: build/C/man7/mdoc.7:299
4446 #, no-wrap
4447 msgid "Li \\&Ar Ta Yes Ta Yes Ta \"Command-line argument.\""
4448 msgstr ""
4449
4450 #. type: It
4451 #: build/C/man7/mdoc.7:300
4452 #, no-wrap
4453 msgid ""
4454 "Li \\&Cd Ta \\&No Ta \\&No Ta \"Configuration declaration (section four "
4455 "only).\""
4456 msgstr ""
4457
4458 #. type: It
4459 #: build/C/man7/mdoc.7:301
4460 #, no-wrap
4461 msgid "Li \\&Cm Ta Yes Ta Yes Ta \"Command-line argument modifier.\""
4462 msgstr ""
4463
4464 #. type: It
4465 #: build/C/man7/mdoc.7:302
4466 #, no-wrap
4467 msgid "Li \\&Dv Ta Yes Ta Yes Ta \"Defined variable (source code).\""
4468 msgstr ""
4469
4470 #. type: It
4471 #: build/C/man7/mdoc.7:303
4472 #, no-wrap
4473 msgid "Li \\&Er Ta Yes Ta Yes Ta \"Error number (source code).\""
4474 msgstr ""
4475
4476 #. type: It
4477 #: build/C/man7/mdoc.7:304
4478 #, no-wrap
4479 msgid "Li \\&Ev Ta Yes Ta Yes Ta \"Environment variable.\""
4480 msgstr ""
4481
4482 #. type: It
4483 #: build/C/man7/mdoc.7:305
4484 #, no-wrap
4485 msgid "Li \\&Fa Ta Yes Ta Yes Ta \"Function argument.\""
4486 msgstr ""
4487
4488 #. type: It
4489 #: build/C/man7/mdoc.7:306
4490 #, no-wrap
4491 msgid "Li \\&Fd Ta Yes Ta Yes Ta \"Function declaration.\""
4492 msgstr ""
4493
4494 #. type: It
4495 #: build/C/man7/mdoc.7:307
4496 #, no-wrap
4497 msgid "Li \\&Fn Ta Yes Ta Yes Ta \"Function call (also .Fo and .Fc).\""
4498 msgstr ""
4499
4500 #. type: It
4501 #: build/C/man7/mdoc.7:308
4502 #, no-wrap
4503 msgid "Li \\&Ic Ta Yes Ta Yes Ta \"Interactive command.\""
4504 msgstr ""
4505
4506 #. type: It
4507 #: build/C/man7/mdoc.7:309
4508 #, no-wrap
4509 msgid "Li \\&Li Ta Yes Ta Yes Ta \"Literal text.\""
4510 msgstr ""
4511
4512 #. type: It
4513 #: build/C/man7/mdoc.7:310
4514 #, no-wrap
4515 msgid "Li \\&Nm Ta Yes Ta Yes Ta \"Command name.\""
4516 msgstr ""
4517
4518 #. type: It
4519 #: build/C/man7/mdoc.7:311
4520 #, no-wrap
4521 msgid "Li \\&Op Ta Yes Ta Yes Ta \"Option (also .Oo and .Oc).\""
4522 msgstr ""
4523
4524 #. type: It
4525 #: build/C/man7/mdoc.7:312
4526 #, no-wrap
4527 msgid "Li \\&Ot Ta Yes Ta Yes Ta \"Old style function type (Fortran only).\""
4528 msgstr ""
4529
4530 #. type: It
4531 #: build/C/man7/mdoc.7:313
4532 #, no-wrap
4533 msgid "Li \\&Pa Ta Yes Ta Yes Ta \"Pathname or filename.\""
4534 msgstr ""
4535
4536 #. type: It
4537 #: build/C/man7/mdoc.7:314
4538 #, no-wrap
4539 msgid "Li \\&St Ta Yes Ta Yes Ta \"Standards (\\-p1003.2, \\-p1003.1 or \\-ansiC)\""
4540 msgstr ""
4541
4542 #. type: It
4543 #: build/C/man7/mdoc.7:315
4544 #, no-wrap
4545 msgid "Li \\&Va Ta Yes Ta Yes Ta \"Variable name.\""
4546 msgstr ""
4547
4548 #. type: It
4549 #: build/C/man7/mdoc.7:316
4550 #, no-wrap
4551 msgid "Li \\&Vt Ta Yes Ta Yes Ta \"Variable type (Fortran only).\""
4552 msgstr ""
4553
4554 #. type: It
4555 #: build/C/man7/mdoc.7:317
4556 #, no-wrap
4557 msgid "Li \\&Xr Ta Yes Ta Yes Ta \"Manual Page Cross Reference.\""
4558 msgstr ""
4559
4560 #. type: Ss
4561 #: build/C/man7/mdoc.7:319
4562 #, no-wrap
4563 msgid "General Text Domain Macros"
4564 msgstr ""
4565
4566 #. type: It
4567 #: build/C/man7/mdoc.7:322
4568 #, no-wrap
4569 msgid "Li \\&%A Ta Yes Ta \\&No Ta \"Reference author.\""
4570 msgstr ""
4571
4572 #. type: It
4573 #: build/C/man7/mdoc.7:323
4574 #, no-wrap
4575 msgid "Li \\&%B Ta Yes Ta Yes Ta \"Reference book title.\""
4576 msgstr ""
4577
4578 #. type: It
4579 #: build/C/man7/mdoc.7:324
4580 #, no-wrap
4581 msgid "Li \\&%\\&C Ta \\&No Ta \\&No Ta \"Reference place of publishing (city).\""
4582 msgstr ""
4583
4584 #. type: It
4585 #: build/C/man7/mdoc.7:325
4586 #, no-wrap
4587 msgid "Li \\&%\\&D Ta \\&No Ta \\&No Ta \"Reference date.\""
4588 msgstr ""
4589
4590 #. type: It
4591 #: build/C/man7/mdoc.7:326
4592 #, no-wrap
4593 msgid "Li \\&%J Ta Yes Ta Yes Ta \"Reference journal title.\""
4594 msgstr ""
4595
4596 #. type: It
4597 #: build/C/man7/mdoc.7:327
4598 #, no-wrap
4599 msgid "Li \\&%N Ta \\&No Ta \\&No Ta \"Reference issue number.\""
4600 msgstr ""
4601
4602 #. type: It
4603 #: build/C/man7/mdoc.7:328
4604 #, no-wrap
4605 msgid "Li \\&%\\&O Ta \\&No Ta \\&No Ta \"Reference optional information.\""
4606 msgstr ""
4607
4608 #. type: It
4609 #: build/C/man7/mdoc.7:329
4610 #, no-wrap
4611 msgid "Li \\&%P Ta \\&No Ta \\&No Ta \"Reference page number(s).\""
4612 msgstr ""
4613
4614 #. type: It
4615 #: build/C/man7/mdoc.7:330
4616 #, no-wrap
4617 msgid "Li \\&%R Ta \\&No Ta \\&No Ta \"Reference report Name.\""
4618 msgstr ""
4619
4620 #. type: It
4621 #: build/C/man7/mdoc.7:331
4622 #, no-wrap
4623 msgid "Li \\&%T Ta Yes Ta Yes Ta \"Reference article title.\""
4624 msgstr ""
4625
4626 #. type: It
4627 #: build/C/man7/mdoc.7:332
4628 #, no-wrap
4629 msgid "Li \\&%V Ta \\&No Ta \\&No Ta \"Reference volume.\""
4630 msgstr ""
4631
4632 #. type: It
4633 #: build/C/man7/mdoc.7:333
4634 #, no-wrap
4635 msgid "Li \\&Ac Ta Yes Ta Yes Ta \"Angle close quote.\""
4636 msgstr ""
4637
4638 #. type: It
4639 #: build/C/man7/mdoc.7:334
4640 #, no-wrap
4641 msgid "Li \\&Ao Ta Yes Ta Yes Ta \"Angle open quote.\""
4642 msgstr ""
4643
4644 #. type: It
4645 #: build/C/man7/mdoc.7:335
4646 #, no-wrap
4647 msgid "Li \\&Ap Ta Yes Ta Yes Ta Apostrophe."
4648 msgstr ""
4649
4650 #. type: It
4651 #: build/C/man7/mdoc.7:336
4652 #, no-wrap
4653 msgid "Li \\&Aq Ta Yes Ta Yes Ta \"Angle quote.\""
4654 msgstr ""
4655
4656 #. type: It
4657 #: build/C/man7/mdoc.7:337
4658 #, no-wrap
4659 msgid "Li \\&At Ta \\&No Ta \\&No Ta Tn \"AT&T UNIX\""
4660 msgstr ""
4661
4662 #. type: It
4663 #: build/C/man7/mdoc.7:338
4664 #, no-wrap
4665 msgid "Li \\&Bc Ta Yes Ta Yes Ta \"Bracket close quote.\""
4666 msgstr ""
4667
4668 #. type: It
4669 #: build/C/man7/mdoc.7:339
4670 #, no-wrap
4671 msgid "Li \\&Bf Ta \\&No Ta \\&No Ta \"Begin font mode.\""
4672 msgstr ""
4673
4674 #. type: It
4675 #: build/C/man7/mdoc.7:340
4676 #, no-wrap
4677 msgid "Li \\&Bo Ta Yes Ta Yes Ta \"Bracket open quote.\""
4678 msgstr ""
4679
4680 #. type: It
4681 #: build/C/man7/mdoc.7:341
4682 #, no-wrap
4683 msgid "Li \\&Bq Ta Yes Ta Yes Ta \"Bracket quote.\""
4684 msgstr ""
4685
4686 #. type: It
4687 #: build/C/man7/mdoc.7:342
4688 #, no-wrap
4689 msgid "Li \\&Bx Ta Yes Ta Yes Ta Bx ."
4690 msgstr ""
4691
4692 #. type: It
4693 #: build/C/man7/mdoc.7:343
4694 #, no-wrap
4695 msgid "Li \\&Db Ta \\&No Ta \\&No Ta \"Debug (default is \\*qoff\\*q)\""
4696 msgstr ""
4697
4698 #. type: It
4699 #: build/C/man7/mdoc.7:344
4700 #, no-wrap
4701 msgid "Li \\&Dc Ta Yes Ta Yes Ta \"Double close quote.\""
4702 msgstr ""
4703
4704 #. type: It
4705 #: build/C/man7/mdoc.7:345
4706 #, no-wrap
4707 msgid "Li \\&Do Ta Yes Ta Yes Ta \"Double open quote.\""
4708 msgstr ""
4709
4710 #. type: It
4711 #: build/C/man7/mdoc.7:346
4712 #, no-wrap
4713 msgid "Li \\&Dq Ta Yes Ta Yes Ta \"Double quote.\""
4714 msgstr ""
4715
4716 #. type: It
4717 #: build/C/man7/mdoc.7:347
4718 #, no-wrap
4719 msgid "Li \\&Ec Ta Yes Ta Yes Ta \"Enclose string close quote.\""
4720 msgstr ""
4721
4722 #. type: It
4723 #: build/C/man7/mdoc.7:348
4724 #, no-wrap
4725 msgid "Li \\&Ef Ta \\&No Ta \\&No Ta \"End font mode.\""
4726 msgstr ""
4727
4728 #. type: It
4729 #: build/C/man7/mdoc.7:349
4730 #, no-wrap
4731 msgid "Li \\&Em Ta Yes Ta Yes Ta \"Emphasis (traditional English).\""
4732 msgstr ""
4733
4734 #. type: It
4735 #: build/C/man7/mdoc.7:350
4736 #, no-wrap
4737 msgid "Li \\&Eo Ta Yes Ta Yes Ta \"Enclose string open quote.\""
4738 msgstr ""
4739
4740 #. type: It
4741 #: build/C/man7/mdoc.7:351
4742 #, no-wrap
4743 msgid "Li \\&Fx Ta \\&No Ta \\&No Ta Tn \"FreeBSD operating system\""
4744 msgstr ""
4745
4746 #. type: It
4747 #: build/C/man7/mdoc.7:352
4748 #, no-wrap
4749 msgid "Li \\&No Ta Yes Ta Yes Ta \"Normal text (no-op).\""
4750 msgstr ""
4751
4752 #. type: It
4753 #: build/C/man7/mdoc.7:353
4754 #, no-wrap
4755 msgid "Li \\&Ns Ta Yes Ta Yes Ta \"No space.\""
4756 msgstr ""
4757
4758 #. type: It
4759 #: build/C/man7/mdoc.7:354
4760 #, no-wrap
4761 msgid "Li \\&Pc Ta Yes Ta Yes Ta \"Parenthesis close quote.\""
4762 msgstr ""
4763
4764 #. type: It
4765 #: build/C/man7/mdoc.7:355
4766 #, no-wrap
4767 msgid "Li \\&Pf Ta Yes Ta \\&No Ta \"Prefix string.\""
4768 msgstr ""
4769
4770 #. type: It
4771 #: build/C/man7/mdoc.7:356
4772 #, no-wrap
4773 msgid "Li \\&Po Ta Yes Ta Yes Ta \"Parenthesis open quote.\""
4774 msgstr ""
4775
4776 #. type: It
4777 #: build/C/man7/mdoc.7:357
4778 #, no-wrap
4779 msgid "Li \\&Pq Ta Yes Ta Yes Ta \"Parentheses quote.\""
4780 msgstr ""
4781
4782 #. type: It
4783 #: build/C/man7/mdoc.7:358
4784 #, no-wrap
4785 msgid "Li \\&Qc Ta Yes Ta Yes Ta \"Straight Double close quote.\""
4786 msgstr ""
4787
4788 #. type: It
4789 #: build/C/man7/mdoc.7:359
4790 #, no-wrap
4791 msgid "Li \\&Ql Ta Yes Ta Yes Ta \"Quoted literal.\""
4792 msgstr ""
4793
4794 #. type: It
4795 #: build/C/man7/mdoc.7:360
4796 #, no-wrap
4797 msgid "Li \\&Qo Ta Yes Ta Yes Ta \"Straight Double open quote.\""
4798 msgstr ""
4799
4800 #. type: It
4801 #: build/C/man7/mdoc.7:361
4802 #, no-wrap
4803 msgid "Li \\&Qq Ta Yes Ta Yes Ta \"Straight Double quote.\""
4804 msgstr ""
4805
4806 #. type: It
4807 #: build/C/man7/mdoc.7:362
4808 #, no-wrap
4809 msgid "Li \\&Re Ta \\&No Ta \\&No Ta \"Reference end.\""
4810 msgstr ""
4811
4812 #. type: It
4813 #: build/C/man7/mdoc.7:363
4814 #, no-wrap
4815 msgid "Li \\&Rs Ta \\&No Ta \\&No Ta \"Reference start.\""
4816 msgstr ""
4817
4818 #. type: It
4819 #: build/C/man7/mdoc.7:364
4820 #, no-wrap
4821 msgid ""
4822 "Li \\&Rv Ta \\&No Ta \\&No Ta \"Return values (sections two and three "
4823 "only).\""
4824 msgstr ""
4825
4826 #. type: It
4827 #: build/C/man7/mdoc.7:365
4828 #, no-wrap
4829 msgid "Li \\&Sc Ta Yes Ta Yes Ta \"Single close quote.\""
4830 msgstr ""
4831
4832 #. type: It
4833 #: build/C/man7/mdoc.7:366
4834 #, no-wrap
4835 msgid "Li \\&So Ta Yes Ta Yes Ta \"Single open quote.\""
4836 msgstr ""
4837
4838 #. type: It
4839 #: build/C/man7/mdoc.7:367
4840 #, no-wrap
4841 msgid "Li \\&Sq Ta Yes Ta Yes Ta \"Single quote.\""
4842 msgstr ""
4843
4844 #. type: It
4845 #: build/C/man7/mdoc.7:368
4846 #, no-wrap
4847 msgid "Li \\&Sm Ta \\&No Ta \\&No Ta \"Space mode (default is \\*qon\\*q)\""
4848 msgstr ""
4849
4850 #. type: It
4851 #: build/C/man7/mdoc.7:369
4852 #, no-wrap
4853 msgid "Li \\&Sx Ta Yes Ta Yes Ta \"Section Cross Reference.\""
4854 msgstr ""
4855
4856 #. type: It
4857 #: build/C/man7/mdoc.7:370
4858 #, no-wrap
4859 msgid "Li \\&Sy Ta Yes Ta Yes Ta \"Symbolic (traditional English).\""
4860 msgstr ""
4861
4862 #. type: It
4863 #: build/C/man7/mdoc.7:371
4864 #, no-wrap
4865 msgid "Li \\&Tn Ta Yes Ta Yes Ta \"Trade or type name (small Caps).\""
4866 msgstr ""
4867
4868 #. type: It
4869 #: build/C/man7/mdoc.7:372
4870 #, no-wrap
4871 msgid "Li \\&Ux Ta Yes Ta Yes Ta Ux"
4872 msgstr ""
4873
4874 #. type: It
4875 #: build/C/man7/mdoc.7:373
4876 #, no-wrap
4877 msgid "Li \\&Xc Ta Yes Ta Yes Ta \"Extend argument list close.\""
4878 msgstr ""
4879
4880 #. type: It
4881 #: build/C/man7/mdoc.7:374
4882 #, no-wrap
4883 msgid "Li \\&Xo Ta Yes Ta Yes Ta \"Extend argument list open.\""
4884 msgstr ""
4885
4886 #. type: Plain text
4887 #: build/C/man7/mdoc.7:388
4888 msgid ""
4889 "Macro names ending in E<.Ql q> quote remaining items on the argument list.  "
4890 "Macro names ending in E<.Ql o> begin a quote which may span more than one "
4891 "line of input and are close quoted with the matching macro name ending in "
4892 "E<.Ql c>.  Enclosure macros may be nested and are limited to eight "
4893 "arguments."
4894 msgstr ""
4895
4896 #. type: Plain text
4897 #: build/C/man7/mdoc.7:400
4898 msgid ""
4899 "Note: the extended argument list macros E<.Pf ( Ql \\&.Xo>, E<.Ql \\&.Xc>)  "
4900 "and the function enclosure macros E<.Pf ( Ql \\&.Fo>, E<.Ql \\&.Fc>)  are "
4901 "irregular.  The extended list macros are used when the number of macro "
4902 "arguments would exceed the E<.Xr troff> limitation of nine arguments."
4903 msgstr ""
4904
4905 #.  The following does not apply on Linux:
4906 #.  .Sh CONFIGURATION
4907 #.  For site specific configuration of the macro package,
4908 #.  see the file
4909 #.  .Pa /usr/src/share/tmac/README .
4910 #. type: Plain text
4911 #: build/C/man7/mdoc.7:411
4912 msgid ""
4913 "The macros UR (starting a URI/URL hypertext reference), UE (ending one), and "
4914 "UN (identifying a target for a reference) are also available.  See E<.Xr man "
4915 "7> for more information on these macros."
4916 msgstr ""
4917
4918 #. type: It
4919 #: build/C/man7/mdoc.7:413
4920 #, no-wrap
4921 msgid "Pa doc.tmac"
4922 msgstr ""
4923
4924 #. type: Plain text
4925 #: build/C/man7/mdoc.7:415
4926 msgid "Manual and general text domain macros."
4927 msgstr ""
4928
4929 #. type: It
4930 #: build/C/man7/mdoc.7:415
4931 #, no-wrap
4932 msgid "Pa tmac/doc-common"
4933 msgstr ""
4934
4935 #. type: Plain text
4936 #: build/C/man7/mdoc.7:417
4937 msgid "Common structural macros and definitions."
4938 msgstr ""
4939
4940 #. type: It
4941 #: build/C/man7/mdoc.7:417
4942 #, no-wrap
4943 msgid "Pa tmac/doc-nroff"
4944 msgstr ""
4945
4946 #. type: Plain text
4947 #: build/C/man7/mdoc.7:421
4948 msgid "Site dependent E<.Xr nroff> style file."
4949 msgstr ""
4950
4951 #. type: It
4952 #: build/C/man7/mdoc.7:421
4953 #, no-wrap
4954 msgid "Pa tmac/doc-ditroff"
4955 msgstr ""
4956
4957 #. type: Plain text
4958 #: build/C/man7/mdoc.7:425
4959 msgid "Site dependent E<.Xr troff> style file."
4960 msgstr ""
4961
4962 #. type: It
4963 #: build/C/man7/mdoc.7:425
4964 #, no-wrap
4965 msgid "Pa tmac/doc-syms"
4966 msgstr ""
4967
4968 #. type: Plain text
4969 #: build/C/man7/mdoc.7:427
4970 msgid "Special defines (such as the standards macro)."
4971 msgstr ""
4972
4973 #. type: Plain text
4974 #: build/C/man7/mdoc.7:433
4975 msgid "E<.Xr groff_mdoc 7>, E<.Xr mdoc.samples 7>, E<.Xr man 7>, E<.Xr man-pages 7>"
4976 msgstr ""
4977
4978 #. type: Plain text
4979 #: build/C/man7/mdoc.7:440 build/C/man7/mdoc.samples.7:2964
4980 msgid ""
4981 "This page is part of release 3.54 of the Linux E<.Em man-pages> project.  A "
4982 "description of the project, and information about reporting bugs, can be "
4983 "found at \\%http://www.kernel.org/doc/man\\-pages/."
4984 msgstr ""
4985
4986 #. type: TH
4987 #: build/C/man7/operator.7:40
4988 #, no-wrap
4989 msgid "OPERATOR"
4990 msgstr ""
4991
4992 #. type: TH
4993 #: build/C/man7/operator.7:40
4994 #, no-wrap
4995 msgid "2011-09-09"
4996 msgstr ""
4997
4998 #. type: Plain text
4999 #: build/C/man7/operator.7:43
5000 msgid "operator - C operator precedence and order of evaluation"
5001 msgstr ""
5002
5003 #. type: Plain text
5004 #: build/C/man7/operator.7:45
5005 msgid "This manual page lists C operators and their precedence in evaluation."
5006 msgstr ""
5007
5008 #. type: Plain text
5009 #: build/C/man7/operator.7:63
5010 #, no-wrap
5011 msgid ""
5012 "B<Operator                             Associativity>\n"
5013 "() [] -E<gt> .                           left to right\n"
5014 "! ~ ++ -- + - (type) * & sizeof      right to left\n"
5015 "* / %                                left to right\n"
5016 "+ -                                  left to right\n"
5017 "E<lt>E<lt> E<gt>E<gt>                                left to right\n"
5018 "E<lt> E<lt>= E<gt> E<gt>=                            left to right\n"
5019 "== !=                                left to right\n"
5020 "&                                    left to right\n"
5021 "^                                    left to right\n"
5022 "|                                    left to right\n"
5023 "&&                                   left to right\n"
5024 "||                                   left to right\n"
5025 "?:                                   right to left\n"
5026 "= += -= *= /= %= E<lt>E<lt>= E<gt>E<gt>= &= ^= |=    right to left\n"
5027 ",                                    left to right\n"
5028 msgstr ""
5029
5030 #. type: TH
5031 #: build/C/man7/posixoptions.7:24
5032 #, no-wrap
5033 msgid "POSIXOPTIONS"
5034 msgstr ""
5035
5036 #. type: TH
5037 #: build/C/man7/posixoptions.7:24
5038 #, no-wrap
5039 msgid "2007-12-21"
5040 msgstr ""
5041
5042 #. type: Plain text
5043 #: build/C/man7/posixoptions.7:27
5044 msgid "posixoptions - optional parts of the POSIX standard"
5045 msgstr ""
5046
5047 #. type: Plain text
5048 #: build/C/man7/posixoptions.7:41
5049 msgid ""
5050 "The POSIX standard (the information below is from POSIX.1-2001)  describes a "
5051 "set of behaviors and interfaces for a compliant system.  However, many "
5052 "interfaces are optional and there are feature test macros to test the "
5053 "availability of interfaces at compile time, and functions B<sysconf>(3), "
5054 "B<fpathconf>(3), B<pathconf>(3), B<confstr>(3)  to do this at run time.  "
5055 "From shell scripts one can use B<getconf>(1).  For more detail, see "
5056 "B<sysconf>(3)."
5057 msgstr ""
5058
5059 #. type: Plain text
5060 #: build/C/man7/posixoptions.7:48
5061 msgid ""
5062 "We give the name of the POSIX abbreviation, the option, the name of the "
5063 "B<sysconf>(3)  parameter used to inquire about the option, and possibly a "
5064 "very short description.  Much more precise detail can be found in the POSIX "
5065 "standard itself, versions of which can nowadays be accessed freely on the "
5066 "web."
5067 msgstr ""
5068
5069 #. type: SS
5070 #: build/C/man7/posixoptions.7:48
5071 #, no-wrap
5072 msgid "ADV - _POSIX_ADVISORY_INFO - _SC_ADVISORY_INFO"
5073 msgstr ""
5074
5075 #. type: Plain text
5076 #: build/C/man7/posixoptions.7:50
5077 msgid "The following advisory functions are present:"
5078 msgstr ""
5079
5080 #. type: Plain text
5081 #: build/C/man7/posixoptions.7:58
5082 #, no-wrap
5083 msgid ""
5084 "I<posix_fadvise>(),\n"
5085 "I<posix_fallocate>(),\n"
5086 "I<posix_memalign>(),\n"
5087 "I<posix_madvise>().\n"
5088 msgstr ""
5089
5090 #. type: SS
5091 #: build/C/man7/posixoptions.7:61
5092 #, no-wrap
5093 msgid "AIO - _POSIX_ASYNCHRONOUS_IO - _SC_ASYNCHRONOUS_IO"
5094 msgstr ""
5095
5096 #. type: Plain text
5097 #: build/C/man7/posixoptions.7:66
5098 msgid ""
5099 "The header I<E<lt>aio.hE<gt>> is present.  The following functions are "
5100 "present:"
5101 msgstr ""
5102
5103 #. type: Plain text
5104 #: build/C/man7/posixoptions.7:78
5105 #, no-wrap
5106 msgid ""
5107 "I<aio_cancel>(),\n"
5108 "I<aio_error>(),\n"
5109 "I<aio_fsync>(),\n"
5110 "I<aio_read>(),\n"
5111 "I<aio_return>(),\n"
5112 "I<aio_suspend>(),\n"
5113 "I<aio_write>(),\n"
5114 "I<lio_listio>().\n"
5115 msgstr ""
5116
5117 #. type: SS
5118 #: build/C/man7/posixoptions.7:81
5119 #, no-wrap
5120 msgid "BAR - _POSIX_BARRIERS - _SC_BARRIERS"
5121 msgstr ""
5122
5123 #. type: Plain text
5124 #: build/C/man7/posixoptions.7:88 build/C/man7/posixoptions.7:458
5125 msgid ""
5126 "This option implies the B<_POSIX_THREADS> and "
5127 "B<_POSIX_THREAD_SAFE_FUNCTIONS> options.  The following functions are "
5128 "present:"
5129 msgstr ""
5130
5131 #. type: Plain text
5132 #: build/C/man7/posixoptions.7:97
5133 #, no-wrap
5134 msgid ""
5135 "I<pthread_barrier_destroy>(),\n"
5136 "I<pthread_barrier_init>(),\n"
5137 "I<pthread_barrier_wait>(),\n"
5138 "I<pthread_barrierattr_destroy>(),\n"
5139 "I<pthread_barrierattr_init>().\n"
5140 msgstr ""
5141
5142 #.  .SS "BE"
5143 #.  Batch environment.
5144 #.  .SS "CD"
5145 #.  C development.
5146 #. type: SS
5147 #: build/C/man7/posixoptions.7:104
5148 #, no-wrap
5149 msgid "--- - POSIX_CHOWN_RESTRICTED"
5150 msgstr ""
5151
5152 #.  What about lchown() ?
5153 #. type: Plain text
5154 #: build/C/man7/posixoptions.7:112
5155 msgid ""
5156 "If this option is in effect (as it always is under POSIX.1-2001)  then only "
5157 "root may change the owner of a file, and nonroot can set the group of a file "
5158 "only to one of the groups it belongs to.  This affects the functions "
5159 "I<chown>(), I<fchown>()."
5160 msgstr ""
5161
5162 #. type: SS
5163 #: build/C/man7/posixoptions.7:112
5164 #, no-wrap
5165 msgid "CS - _POSIX_CLOCK_SELECTION - _SC_CLOCK_SELECTION"
5166 msgstr ""
5167
5168 #. type: Plain text
5169 #: build/C/man7/posixoptions.7:117
5170 msgid ""
5171 "This option implies the B<_POSIX_TIMERS> option.  The following functions "
5172 "are present:"
5173 msgstr ""
5174
5175 #. type: Plain text
5176 #: build/C/man7/posixoptions.7:124
5177 #, no-wrap
5178 msgid ""
5179 "I<pthread_condattr_getclock>(),\n"
5180 "I<pthread_condattr_setclock>(),\n"
5181 "I<clock_nanosleep>().\n"
5182 msgstr ""
5183
5184 #. type: Plain text
5185 #: build/C/man7/posixoptions.7:132
5186 msgid ""
5187 "If B<CLOCK_REALTIME> is changed by the function I<clock_settime>(), then "
5188 "this affects all timers set for an absolute time."
5189 msgstr ""
5190
5191 #. type: SS
5192 #: build/C/man7/posixoptions.7:132
5193 #, no-wrap
5194 msgid "CPT - _POSIX_CPUTIME - _SC_CPUTIME"
5195 msgstr ""
5196
5197 #.  .SS "FD"
5198 #.  Fortran development
5199 #.  .SS "FR"
5200 #.  Fortran runtime
5201 #. type: Plain text
5202 #: build/C/man7/posixoptions.7:145
5203 msgid ""
5204 "The clockID CLOCK_PROCESS_CPUTIME_ID is supported.  The initial value of "
5205 "this clock is 0 for each process.  This option implies the B<_POSIX_TIMERS> "
5206 "option.  The function I<clock_getcpuclockid>()  is present."
5207 msgstr ""
5208
5209 #. type: SS
5210 #: build/C/man7/posixoptions.7:145
5211 #, no-wrap
5212 msgid "--- - _POSIX_FILE_LOCKING - _SC_FILE_LOCKING"
5213 msgstr ""
5214
5215 #.  .SS "MX"
5216 #.  IEC 60559 Floating-Point Option.
5217 #. type: Plain text
5218 #: build/C/man7/posixoptions.7:148 build/C/man7/posixoptions.7:238
5219 msgid "This option has been deleted.  Not in final XPG6."
5220 msgstr ""
5221
5222 #. type: SS
5223 #: build/C/man7/posixoptions.7:148
5224 #, no-wrap
5225 msgid "FSC - _POSIX_FSYNC - _SC_FSYNC"
5226 msgstr ""
5227
5228 #. type: Plain text
5229 #: build/C/man7/posixoptions.7:152
5230 msgid "The function I<fsync>()  is present."
5231 msgstr ""
5232
5233 #. type: SS
5234 #: build/C/man7/posixoptions.7:152
5235 #, no-wrap
5236 msgid "IP6 - _POSIX_IPV6 - _SC_IPV6"
5237 msgstr ""
5238
5239 #. type: Plain text
5240 #: build/C/man7/posixoptions.7:154
5241 msgid "Internet Protocol Version 6 is supported."
5242 msgstr ""
5243
5244 #. type: SS
5245 #: build/C/man7/posixoptions.7:154
5246 #, no-wrap
5247 msgid "--- - _POSIX_JOB_CONTROL - _SC_JOB_CONTROL"
5248 msgstr ""
5249
5250 #. type: Plain text
5251 #: build/C/man7/posixoptions.7:158
5252 msgid ""
5253 "If this option is in effect (as it always is under POSIX.1-2001)  then the "
5254 "system implements POSIX-style job control, and the following functions are "
5255 "present:"
5256 msgstr ""
5257
5258 #. type: Plain text
5259 #: build/C/man7/posixoptions.7:169
5260 #, no-wrap
5261 msgid ""
5262 "I<setpgid>(),\n"
5263 "I<tcdrain>(),\n"
5264 "I<tcflush>(),\n"
5265 "I<tcgetpgrp>(),\n"
5266 "I<tcsendbreak>(),\n"
5267 "I<tcsetattr>(),\n"
5268 "I<tcsetpgrp>().\n"
5269 msgstr ""
5270
5271 #. type: SS
5272 #: build/C/man7/posixoptions.7:171
5273 #, no-wrap
5274 msgid "MF - _POSIX_MAPPED_FILES - _SC_MAPPED_FILES"
5275 msgstr ""
5276
5277 #. type: Plain text
5278 #: build/C/man7/posixoptions.7:180
5279 msgid ""
5280 "Shared memory is supported.  The include file I<E<lt>sys/mman.hE<gt>> is "
5281 "present.  The following functions are present: I<mmap>(), I<msync>(), "
5282 "I<munmap>()."
5283 msgstr ""
5284
5285 #. type: SS
5286 #: build/C/man7/posixoptions.7:180
5287 #, no-wrap
5288 msgid "ML - _POSIX_MEMLOCK - _SC_MEMLOCK"
5289 msgstr ""
5290
5291 #. type: Plain text
5292 #: build/C/man7/posixoptions.7:186
5293 msgid ""
5294 "Shared memory can be locked into core.  The functions I<mlockall>(), "
5295 "I<munlockall>()  are present."
5296 msgstr ""
5297
5298 #. type: SS
5299 #: build/C/man7/posixoptions.7:186
5300 #, no-wrap
5301 msgid "MR/MLR - _POSIX_MEMLOCK_RANGE - _SC_MEMLOCK_RANGE"
5302 msgstr ""
5303
5304 #. type: Plain text
5305 #: build/C/man7/posixoptions.7:192
5306 msgid ""
5307 "More precisely, ranges can be locked into core.  The functions I<mlock>(), "
5308 "I<munlock>()  are present."
5309 msgstr ""
5310
5311 #. type: SS
5312 #: build/C/man7/posixoptions.7:192
5313 #, no-wrap
5314 msgid "MPR - _POSIX_MEMORY_PROTECTION - _SC_MEMORY_PROTECTION"
5315 msgstr ""
5316
5317 #. type: Plain text
5318 #: build/C/man7/posixoptions.7:196
5319 msgid "The function I<mprotect>()  is present."
5320 msgstr ""
5321
5322 #. type: SS
5323 #: build/C/man7/posixoptions.7:196
5324 #, no-wrap
5325 msgid "MSG - _POSIX_MESSAGE_PASSING - _SC_MESSAGE_PASSING"
5326 msgstr ""
5327
5328 #. type: Plain text
5329 #: build/C/man7/posixoptions.7:201
5330 msgid ""
5331 "The include file I<E<lt>mqueue.hE<gt>> is present.  The following functions "
5332 "are present:"
5333 msgstr ""
5334
5335 #. type: Plain text
5336 #: build/C/man7/posixoptions.7:213
5337 #, no-wrap
5338 msgid ""
5339 "I<mq_close>(),\n"
5340 "I<mq_getattr>(),\n"
5341 "I<mq_notify>(),\n"
5342 "I<mq_open>(),\n"
5343 "I<mq_receive>(),\n"
5344 "I<mq_send>(),\n"
5345 "I<mq_setattr>(),\n"
5346 "I<mq_unlink>().\n"
5347 msgstr ""
5348
5349 #. type: SS
5350 #: build/C/man7/posixoptions.7:216
5351 #, no-wrap
5352 msgid "MON - _POSIX_MONOTONIC_CLOCK - _SC_MONOTONIC_CLOCK"
5353 msgstr ""
5354
5355 #. type: Plain text
5356 #: build/C/man7/posixoptions.7:223
5357 msgid ""
5358 "B<CLOCK_MONOTONIC> is supported.  This option implies the B<_POSIX_TIMERS> "
5359 "option.  Affected functions are"
5360 msgstr ""
5361
5362 #. type: Plain text
5363 #: build/C/man7/posixoptions.7:231
5364 #, no-wrap
5365 msgid ""
5366 "I<aio_suspend>(),\n"
5367 "I<clock_getres>(),\n"
5368 "I<clock_gettime>(),\n"
5369 "I<clock_settime>(),\n"
5370 "I<timer_create>().\n"
5371 msgstr ""
5372
5373 #. type: SS
5374 #: build/C/man7/posixoptions.7:233
5375 #, no-wrap
5376 msgid "--- - _POSIX_MULTI_PROCESS - _SC_MULTI_PROCESS"
5377 msgstr ""
5378
5379 #. type: SS
5380 #: build/C/man7/posixoptions.7:238
5381 #, no-wrap
5382 msgid "--- - _POSIX_NO_TRUNC"
5383 msgstr ""
5384
5385 #. type: Plain text
5386 #: build/C/man7/posixoptions.7:245
5387 msgid ""
5388 "If this option is in effect (as it always is under POSIX.1-2001)  then "
5389 "pathname components longer than B<NAME_MAX> are not truncated, but give an "
5390 "error.  This property may be dependent on the path prefix of the component."
5391 msgstr ""
5392
5393 #. type: SS
5394 #: build/C/man7/posixoptions.7:245
5395 #, no-wrap
5396 msgid "PIO - _POSIX_PRIORITIZED_IO - _SC_PRIORITIZED_IO"
5397 msgstr ""
5398
5399 #. type: Plain text
5400 #: build/C/man7/posixoptions.7:248
5401 msgid ""
5402 "This option says that one can specify priorities for asynchronous I/O.  This "
5403 "affects the functions"
5404 msgstr ""
5405
5406 #. type: Plain text
5407 #: build/C/man7/posixoptions.7:254
5408 #, no-wrap
5409 msgid ""
5410 "I<aio_read>(),\n"
5411 "I<aio_write>().\n"
5412 msgstr ""
5413
5414 #. type: SS
5415 #: build/C/man7/posixoptions.7:256
5416 #, no-wrap
5417 msgid "PS - _POSIX_PRIORITY_SCHEDULING - _SC_PRIORITY_SCHEDULING"
5418 msgstr ""
5419
5420 #. type: Plain text
5421 #: build/C/man7/posixoptions.7:261
5422 msgid ""
5423 "The include file I<E<lt>sched.hE<gt>> is present.  The following functions "
5424 "are present:"
5425 msgstr ""
5426
5427 #. type: Plain text
5428 #: build/C/man7/posixoptions.7:273
5429 #, no-wrap
5430 msgid ""
5431 "I<sched_get_priority_max>(),\n"
5432 "I<sched_get_priority_min>(),\n"
5433 "I<sched_getparam>(),\n"
5434 "I<sched_getscheduler>(),\n"
5435 "I<sched_rr_get_interval>(),\n"
5436 "I<sched_setparam>(),\n"
5437 "I<sched_setscheduler>(),\n"
5438 "I<sched_yield>().\n"
5439 msgstr ""
5440
5441 #. type: Plain text
5442 #: build/C/man7/posixoptions.7:279
5443 msgid ""
5444 "If also B<_POSIX_SPAWN> is in effect, then the following functions are "
5445 "present:"
5446 msgstr ""
5447
5448 #. type: Plain text
5449 #: build/C/man7/posixoptions.7:287 build/C/man7/posixoptions.7:449
5450 #, no-wrap
5451 msgid ""
5452 "I<posix_spawnattr_getschedparam>(),\n"
5453 "I<posix_spawnattr_getschedpolicy>(),\n"
5454 "I<posix_spawnattr_setschedparam>(),\n"
5455 "I<posix_spawnattr_setschedpolicy>().\n"
5456 msgstr ""
5457
5458 #. type: SS
5459 #: build/C/man7/posixoptions.7:289
5460 #, no-wrap
5461 msgid "RS - _POSIX_RAW_SOCKETS"
5462 msgstr ""
5463
5464 #. type: Plain text
5465 #: build/C/man7/posixoptions.7:294
5466 msgid ""
5467 "Raw sockets are supported.  Affected functions are I<getsockopt>(), "
5468 "I<setsockopt>()."
5469 msgstr ""
5470
5471 #. type: SS
5472 #: build/C/man7/posixoptions.7:294
5473 #, no-wrap
5474 msgid "--- - _POSIX_READER_WRITER_LOCKS - _SC_READER_WRITER_LOCKS"
5475 msgstr ""
5476
5477 #. type: Plain text
5478 #: build/C/man7/posixoptions.7:302
5479 msgid ""
5480 "This option implies the B<_POSIX_THREADS> option.  Conversely, under "
5481 "POSIX.1-2001 the B<_POSIX_THREADS> option implies this option."
5482 msgstr ""
5483
5484 #. type: Plain text
5485 #: build/C/man7/posixoptions.7:304
5486 #, no-wrap
5487 msgid "The following functions are present:\n"
5488 msgstr ""
5489
5490 #. type: Plain text
5491 #: build/C/man7/posixoptions.7:315
5492 #, no-wrap
5493 msgid ""
5494 "I<pthread_rwlock_destroy>(),\n"
5495 "I<pthread_rwlock_init>(),\n"
5496 "I<pthread_rwlock_rdlock>(),\n"
5497 "I<pthread_rwlock_tryrdlock>(),\n"
5498 "I<pthread_rwlock_trywrlock>(),\n"
5499 "I<pthread_rwlock_unlock>(),\n"
5500 "I<pthread_rwlock_wrlock>(),\n"
5501 "I<pthread_rwlockattr_destroy>(),\n"
5502 "I<pthread_rwlockattr_init>().\n"
5503 msgstr ""
5504
5505 #. type: SS
5506 #: build/C/man7/posixoptions.7:317
5507 #, no-wrap
5508 msgid "RTS - _POSIX_REALTIME_SIGNALS - _SC_REALTIME_SIGNALS"
5509 msgstr ""
5510
5511 #. type: Plain text
5512 #: build/C/man7/posixoptions.7:320
5513 msgid "Realtime signals are supported.  The following functions are present:"
5514 msgstr ""
5515
5516 #. type: Plain text
5517 #: build/C/man7/posixoptions.7:327
5518 #, no-wrap
5519 msgid ""
5520 "I<sigqueue>(),\n"
5521 "I<sigtimedwait>(),\n"
5522 "I<sigwaitinfo>().\n"
5523 msgstr ""
5524
5525 #. type: SS
5526 #: build/C/man7/posixoptions.7:330
5527 #, no-wrap
5528 msgid "--- - _POSIX_REGEXP - _SC_REGEXP"
5529 msgstr ""
5530
5531 #. type: Plain text
5532 #: build/C/man7/posixoptions.7:334
5533 msgid ""
5534 "If this option is in effect (as it always is under POSIX.1-2001)  then POSIX "
5535 "regular expressions are supported and the following functions are present:"
5536 msgstr ""
5537
5538 #. type: Plain text
5539 #: build/C/man7/posixoptions.7:342
5540 #, no-wrap
5541 msgid ""
5542 "I<regcomp>(),\n"
5543 "I<regerror>(),\n"
5544 "I<regexec>(),\n"
5545 "I<regfree>().\n"
5546 msgstr ""
5547
5548 #. type: SS
5549 #: build/C/man7/posixoptions.7:345
5550 #, no-wrap
5551 msgid "--- - _POSIX_SAVED_IDS - _SC_SAVED_IDS"
5552 msgstr ""
5553
5554 #. type: Plain text
5555 #: build/C/man7/posixoptions.7:349
5556 msgid ""
5557 "If this option is in effect (as it always is under POSIX.1-2001)  then a "
5558 "process has a saved set-user-ID and a saved set-group-ID.  Affected "
5559 "functions are"
5560 msgstr ""
5561
5562 #. type: Plain text
5563 #: build/C/man7/posixoptions.7:359
5564 #, no-wrap
5565 msgid ""
5566 "I<exec>(),\n"
5567 "I<kill>(),\n"
5568 "I<seteuid>(),\n"
5569 "I<setegid>(),\n"
5570 "I<setgid>(),\n"
5571 "I<setuid>().\n"
5572 msgstr ""
5573
5574 #.  .SS "SD"
5575 #.  Software development
5576 #. type: SS
5577 #: build/C/man7/posixoptions.7:364
5578 #, no-wrap
5579 msgid "SEM - _POSIX_SEMAPHORES - _SC_SEMAPHORES"
5580 msgstr ""
5581
5582 #. type: Plain text
5583 #: build/C/man7/posixoptions.7:369
5584 msgid ""
5585 "The include file I<E<lt>semaphore.hE<gt>> is present.  The following "
5586 "functions are present:"
5587 msgstr ""
5588
5589 #. type: Plain text
5590 #: build/C/man7/posixoptions.7:382
5591 #, no-wrap
5592 msgid ""
5593 "I<sem_close>(),\n"
5594 "I<sem_destroy>(),\n"
5595 "I<sem_getvalue>(),\n"
5596 "I<sem_init>(),\n"
5597 "I<sem_open>(),\n"
5598 "I<sem_post>(),\n"
5599 "I<sem_trywait>(),\n"
5600 "I<sem_unlink>(),\n"
5601 "I<sem_wait>().\n"
5602 msgstr ""
5603
5604 #. type: SS
5605 #: build/C/man7/posixoptions.7:385
5606 #, no-wrap
5607 msgid "SHM - _POSIX_SHARED_MEMORY_OBJECTS - _SC_SHARED_MEMORY_OBJECTS"
5608 msgstr ""
5609
5610 #. type: Plain text
5611 #: build/C/man7/posixoptions.7:387 build/C/man7/posixoptions.7:703 build/C/man7/posixoptions.7:719 build/C/man7/posixoptions.7:833
5612 msgid "The following functions are present:"
5613 msgstr ""
5614
5615 #. type: Plain text
5616 #: build/C/man7/posixoptions.7:395
5617 #, no-wrap
5618 msgid ""
5619 "I<mmap>(),\n"
5620 "I<munmap>(),\n"
5621 "I<shm_open>(),\n"
5622 "I<shm_unlink>().\n"
5623 msgstr ""
5624
5625 #. type: SS
5626 #: build/C/man7/posixoptions.7:398
5627 #, no-wrap
5628 msgid "--- - _POSIX_SHELL - _SC_SHELL"
5629 msgstr ""
5630
5631 #. type: Plain text
5632 #: build/C/man7/posixoptions.7:403
5633 msgid ""
5634 "If this option is in effect (as it always is under POSIX.1-2001), the "
5635 "function I<system>()  is present."
5636 msgstr ""
5637
5638 #. type: SS
5639 #: build/C/man7/posixoptions.7:403
5640 #, no-wrap
5641 msgid "SPN - _POSIX_SPAWN - _SC_SPAWN"
5642 msgstr ""
5643
5644 #. type: Plain text
5645 #: build/C/man7/posixoptions.7:413
5646 msgid ""
5647 "This option describes support for process creation in a context where it is "
5648 "difficult or impossible to use I<fork>(), for example, because no MMU is "
5649 "present.  If B<_POSIX_SPAWN> is in effect, then the include file "
5650 "I<E<lt>spawn.hE<gt>> and the following functions are present:"
5651 msgstr ""
5652
5653 #. type: Plain text
5654 #: build/C/man7/posixoptions.7:434
5655 #, no-wrap
5656 msgid ""
5657 "I<posix_spawn>(),\n"
5658 "I<posix_spawn_file_actions_addclose>(),\n"
5659 "I<posix_spawn_file_actions_adddup2>(),\n"
5660 "I<posix_spawn_file_actions_addopen>(),\n"
5661 "I<posix_spawn_file_actions_destroy>(),\n"
5662 "I<posix_spawn_file_actions_init>(),\n"
5663 "I<posix_spawnattr_destroy>(),\n"
5664 "I<posix_spawnattr_getsigdefault>(),\n"
5665 "I<posix_spawnattr_getflags>(),\n"
5666 "I<posix_spawnattr_getpgroup>(),\n"
5667 "I<posix_spawnattr_getsigmask>(),\n"
5668 "I<posix_spawnattr_init>(),\n"
5669 "I<posix_spawnattr_setsigdefault>(),\n"
5670 "I<posix_spawnattr_setflags>(),\n"
5671 "I<posix_spawnattr_setpgroup>(),\n"
5672 "I<posix_spawnattr_setsigmask>(),\n"
5673 "I<posix_spawnp>().\n"
5674 msgstr ""
5675
5676 #. type: Plain text
5677 #: build/C/man7/posixoptions.7:441
5678 msgid ""
5679 "If also B<_POSIX_PRIORITY_SCHEDULING> is in effect, then the following "
5680 "functions are present:"
5681 msgstr ""
5682
5683 #. type: SS
5684 #: build/C/man7/posixoptions.7:451
5685 #, no-wrap
5686 msgid "SPI - _POSIX_SPIN_LOCKS - _SC_SPIN_LOCKS"
5687 msgstr ""
5688
5689 #. type: Plain text
5690 #: build/C/man7/posixoptions.7:467
5691 #, no-wrap
5692 msgid ""
5693 "I<pthread_spin_destroy>(),\n"
5694 "I<pthread_spin_init>(),\n"
5695 "I<pthread_spin_lock>(),\n"
5696 "I<pthread_spin_trylock>(),\n"
5697 "I<pthread_spin_unlock>().\n"
5698 msgstr ""
5699
5700 #. type: SS
5701 #: build/C/man7/posixoptions.7:470
5702 #, no-wrap
5703 msgid "SS - _POSIX_SPORADIC_SERVER - _SC_SPORADIC_SERVER"
5704 msgstr ""
5705
5706 #. type: Plain text
5707 #: build/C/man7/posixoptions.7:478
5708 msgid ""
5709 "The scheduling policy B<SCHED_SPORADIC> is supported.  This option implies "
5710 "the B<_POSIX_PRIORITY_SCHEDULING> option.  Affected functions are"
5711 msgstr ""
5712
5713 #. type: Plain text
5714 #: build/C/man7/posixoptions.7:484
5715 #, no-wrap
5716 msgid ""
5717 "I<sched_setparam>(),\n"
5718 "I<sched_setscheduler>().\n"
5719 msgstr ""
5720
5721 #. type: SS
5722 #: build/C/man7/posixoptions.7:487
5723 #, no-wrap
5724 msgid "SIO - _POSIX_SYNCHRONIZED_IO - _SC_SYNCHRONIZED_IO"
5725 msgstr ""
5726
5727 #. type: Plain text
5728 #: build/C/man7/posixoptions.7:493
5729 msgid "Affected functions are I<open>(), I<msync>(), I<fsync>(), I<fdatasync>()."
5730 msgstr ""
5731
5732 #. type: SS
5733 #: build/C/man7/posixoptions.7:493
5734 #, no-wrap
5735 msgid "TSA - _POSIX_THREAD_ATTR_STACKADDR - _SC_THREAD_ATTR_STACKADDR"
5736 msgstr ""
5737
5738 #. type: Plain text
5739 #: build/C/man7/posixoptions.7:495 build/C/man7/posixoptions.7:508 build/C/man7/posixoptions.7:539 build/C/man7/posixoptions.7:550 build/C/man7/posixoptions.7:585 build/C/man7/posixoptions.7:602
5740 msgid "Affected functions are"
5741 msgstr ""
5742
5743 #. type: Plain text
5744 #: build/C/man7/posixoptions.7:503
5745 #, no-wrap
5746 msgid ""
5747 "I<pthread_attr_getstack>(),\n"
5748 "I<pthread_attr_getstackaddr>(),\n"
5749 "I<pthread_attr_setstack>(),\n"
5750 "I<pthread_attr_setstackaddr>().\n"
5751 msgstr ""
5752
5753 #. type: SS
5754 #: build/C/man7/posixoptions.7:506
5755 #, no-wrap
5756 msgid "TSS - _POSIX_THREAD_ATTR_STACKSIZE - _SC_THREAD_ATTR_STACKSIZE"
5757 msgstr ""
5758
5759 #. type: Plain text
5760 #: build/C/man7/posixoptions.7:516
5761 #, no-wrap
5762 msgid ""
5763 "I<pthread_attr_getstack>(),\n"
5764 "I<pthread_attr_getstacksize>(),\n"
5765 "I<pthread_attr_setstack>(),\n"
5766 "I<pthread_attr_setstacksize>().\n"
5767 msgstr ""
5768
5769 #. type: SS
5770 #: build/C/man7/posixoptions.7:519
5771 #, no-wrap
5772 msgid "TCT - _POSIX_THREAD_CPUTIME - _SC_THREAD_CPUTIME"
5773 msgstr ""
5774
5775 #. type: Plain text
5776 #: build/C/man7/posixoptions.7:525
5777 msgid ""
5778 "The clockID CLOCK_THREAD_CPUTIME_ID is supported.  This option implies the "
5779 "B<_POSIX_TIMERS> option.  Affected functions are"
5780 msgstr ""
5781
5782 #. type: Plain text
5783 #: build/C/man7/posixoptions.7:534
5784 #, no-wrap
5785 msgid ""
5786 "I<pthread_getcpuclockid>(),\n"
5787 "I<clock_getres>(),\n"
5788 "I<clock_gettime>(),\n"
5789 "I<clock_settime>(),\n"
5790 "I<timer_create>().\n"
5791 msgstr ""
5792
5793 #. type: SS
5794 #: build/C/man7/posixoptions.7:537
5795 #, no-wrap
5796 msgid "TPI - _POSIX_THREAD_PRIO_INHERIT - _SC_THREAD_PRIO_INHERIT"
5797 msgstr ""
5798
5799 #. type: Plain text
5800 #: build/C/man7/posixoptions.7:545
5801 #, no-wrap
5802 msgid ""
5803 "I<pthread_mutexattr_getprotocol>(),\n"
5804 "I<pthread_mutexattr_setprotocol>().\n"
5805 msgstr ""
5806
5807 #. type: SS
5808 #: build/C/man7/posixoptions.7:548
5809 #, no-wrap
5810 msgid "TPP - _POSIX_THREAD_PRIO_PROTECT - _SC_THREAD_PRIO_PROTECT"
5811 msgstr ""
5812
5813 #. type: Plain text
5814 #: build/C/man7/posixoptions.7:560
5815 #, no-wrap
5816 msgid ""
5817 "I<pthread_mutex_getprioceiling>(),\n"
5818 "I<pthread_mutex_setprioceiling>(),\n"
5819 "I<pthread_mutexattr_getprioceiling>(),\n"
5820 "I<pthread_mutexattr_getprotocol>(),\n"
5821 "I<pthread_mutexattr_setprioceiling>(),\n"
5822 "I<pthread_mutexattr_setprotocol>().\n"
5823 msgstr ""
5824
5825 #. type: SS
5826 #: build/C/man7/posixoptions.7:563
5827 #, no-wrap
5828 msgid "TPS - _POSIX_THREAD_PRIORITY_SCHEDULING - _SC_THREAD_PRIORITY_SCHEDULING"
5829 msgstr ""
5830
5831 #. type: Plain text
5832 #: build/C/man7/posixoptions.7:567
5833 msgid ""
5834 "If this option is in effect, the different threads inside a process can run "
5835 "with different priorities and/or different schedulers.  Affected functions "
5836 "are"
5837 msgstr ""
5838
5839 #. type: Plain text
5840 #: build/C/man7/posixoptions.7:580
5841 #, no-wrap
5842 msgid ""
5843 "I<pthread_attr_getinheritsched>(),\n"
5844 "I<pthread_attr_getschedpolicy>(),\n"
5845 "I<pthread_attr_getscope>(),\n"
5846 "I<pthread_attr_setinheritsched>(),\n"
5847 "I<pthread_attr_setschedpolicy>(),\n"
5848 "I<pthread_attr_setscope>(),\n"
5849 "I<pthread_getschedparam>(),\n"
5850 "I<pthread_setschedparam>(),\n"
5851 "I<pthread_setschedprio>().\n"
5852 msgstr ""
5853
5854 #. type: SS
5855 #: build/C/man7/posixoptions.7:583
5856 #, no-wrap
5857 msgid "TSH - _POSIX_THREAD_PROCESS_SHARED - _SC_THREAD_PROCESS_SHARED"
5858 msgstr ""
5859
5860 #. type: Plain text
5861 #: build/C/man7/posixoptions.7:597
5862 #, no-wrap
5863 msgid ""
5864 "I<pthread_barrierattr_getpshared>(),\n"
5865 "I<pthread_barrierattr_setpshared>(),\n"
5866 "I<pthread_condattr_getpshared>(),\n"
5867 "I<pthread_condattr_setpshared>(),\n"
5868 "I<pthread_mutexattr_getpshared>(),\n"
5869 "I<pthread_mutexattr_setpshared>(),\n"
5870 "I<pthread_rwlockattr_getpshared>(),\n"
5871 "I<pthread_rwlockattr_setpshared>().\n"
5872 msgstr ""
5873
5874 #. type: SS
5875 #: build/C/man7/posixoptions.7:600
5876 #, no-wrap
5877 msgid "TSF - _POSIX_THREAD_SAFE_FUNCTIONS - _SC_THREAD_SAFE_FUNCTIONS"
5878 msgstr ""
5879
5880 #. type: Plain text
5881 #: build/C/man7/posixoptions.7:625
5882 #, no-wrap
5883 msgid ""
5884 "I<readdir_r>(),\n"
5885 "I<getgrgid_r>(),\n"
5886 "I<getgrnam_r>(),\n"
5887 "I<getpwnam_r>(),\n"
5888 "I<getpwuid_r>(),\n"
5889 "I<flockfile>(),\n"
5890 "I<ftrylockfile>(),\n"
5891 "I<funlockfile>(),\n"
5892 "I<getc_unlocked>(),\n"
5893 "I<getchar_unlocked>(),\n"
5894 "I<putc_unlocked>(),\n"
5895 "I<putchar_unlocked>(),\n"
5896 "I<rand_r>(),\n"
5897 "I<strerror_r>(),\n"
5898 "I<strtok_r>(),\n"
5899 "I<asctime_r>(),\n"
5900 "I<ctime_r>(),\n"
5901 "I<gmtime_r>(),\n"
5902 "I<localtime_r>().\n"
5903 msgstr ""
5904
5905 #. type: SS
5906 #: build/C/man7/posixoptions.7:628
5907 #, no-wrap
5908 msgid "TSP - _POSIX_THREAD_SPORADIC_SERVER - _SC_THREAD_SPORADIC_SERVER"
5909 msgstr ""
5910
5911 #. type: Plain text
5912 #: build/C/man7/posixoptions.7:633
5913 msgid ""
5914 "This option implies the B<_POSIX_THREAD_PRIORITY_SCHEDULING> option.  "
5915 "Affected functions are"
5916 msgstr ""
5917
5918 #. type: Plain text
5919 #: build/C/man7/posixoptions.7:640
5920 #, no-wrap
5921 msgid ""
5922 "I<sched_getparam>(),\n"
5923 "I<sched_setparam>(),\n"
5924 "I<sched_setscheduler>().\n"
5925 msgstr ""
5926
5927 #. type: SS
5928 #: build/C/man7/posixoptions.7:643
5929 #, no-wrap
5930 msgid "THR - _POSIX_THREADS - _SC_THREADS"
5931 msgstr ""
5932
5933 #. type: Plain text
5934 #: build/C/man7/posixoptions.7:646
5935 msgid ""
5936 "Basic support for POSIX threads is available.  The following functions are "
5937 "present:"
5938 msgstr ""
5939
5940 #. type: Plain text
5941 #: build/C/man7/posixoptions.7:698
5942 #, no-wrap
5943 msgid ""
5944 "I<pthread_atfork>(),\n"
5945 "I<pthread_attr_destroy>(),\n"
5946 "I<pthread_attr_getdetachstate>(),\n"
5947 "I<pthread_attr_getschedparam>(),\n"
5948 "I<pthread_attr_init>(),\n"
5949 "I<pthread_attr_setdetachstate>(),\n"
5950 "I<pthread_attr_setschedparam>(),\n"
5951 "I<pthread_cancel>(),\n"
5952 "I<pthread_cleanup_push>(),\n"
5953 "I<pthread_cleanup_pop>(),\n"
5954 "I<pthread_cond_broadcast>(),\n"
5955 "I<pthread_cond_destroy>(),\n"
5956 "I<pthread_cond_init>(),\n"
5957 "I<pthread_cond_signal>(),\n"
5958 "I<pthread_cond_timedwait>(),\n"
5959 "I<pthread_cond_wait>(),\n"
5960 "I<pthread_condattr_destroy>(),\n"
5961 "I<pthread_condattr_init>(),\n"
5962 "I<pthread_create>(),\n"
5963 "I<pthread_detach>(),\n"
5964 "I<pthread_equal>(),\n"
5965 "I<pthread_exit>(),\n"
5966 "I<pthread_getspecific>(),\n"
5967 "I<pthread_join>(),\n"
5968 "I<pthread_key_create>(),\n"
5969 "I<pthread_key_delete>(),\n"
5970 "I<pthread_mutex_destroy>(),\n"
5971 "I<pthread_mutex_init>(),\n"
5972 "I<pthread_mutex_lock>(),\n"
5973 "I<pthread_mutex_trylock>(),\n"
5974 "I<pthread_mutex_unlock>(),\n"
5975 "I<pthread_mutexattr_destroy>(),\n"
5976 "I<pthread_mutexattr_init>(),\n"
5977 "I<pthread_once>(),\n"
5978 "I<pthread_rwlock_destroy>(),\n"
5979 "I<pthread_rwlock_init>(),\n"
5980 "I<pthread_rwlock_rdlock>(),\n"
5981 "I<pthread_rwlock_tryrdlock>(),\n"
5982 "I<pthread_rwlock_trywrlock>(),\n"
5983 "I<pthread_rwlock_unlock>(),\n"
5984 "I<pthread_rwlock_wrlock>(),\n"
5985 "I<pthread_rwlockattr_destroy>(),\n"
5986 "I<pthread_rwlockattr_init>(),\n"
5987 "I<pthread_self>(),\n"
5988 "I<pthread_setcancelstate>(),\n"
5989 "I<pthread_setcanceltype>(),\n"
5990 "I<pthread_setspecific>(),\n"
5991 "I<pthread_testcancel>().\n"
5992 msgstr ""
5993
5994 #. type: SS
5995 #: build/C/man7/posixoptions.7:701
5996 #, no-wrap
5997 msgid "TMO - _POSIX_TIMEOUTS - _SC_TIMEOUTS"
5998 msgstr ""
5999
6000 #. type: Plain text
6001 #: build/C/man7/posixoptions.7:714
6002 #, no-wrap
6003 msgid ""
6004 "I<mq_timedreceive>(),\n"
6005 "I<mq_timedsend>(),\n"
6006 "I<pthread_mutex_timedlock>(),\n"
6007 "I<pthread_rwlock_timedrdlock>(),\n"
6008 "I<pthread_rwlock_timedwrlock>(),\n"
6009 "I<sem_timedwait>(),\n"
6010 "I<posix_trace_timedgetnext_event>().\n"
6011 msgstr ""
6012
6013 #. type: SS
6014 #: build/C/man7/posixoptions.7:717
6015 #, no-wrap
6016 msgid "TMR - _POSIX_TIMERS - _SC_TIMERS"
6017 msgstr ""
6018
6019 #. type: Plain text
6020 #: build/C/man7/posixoptions.7:732
6021 #, no-wrap
6022 msgid ""
6023 "I<clock_getres>(),\n"
6024 "I<clock_gettime>(),\n"
6025 "I<clock_settime>(),\n"
6026 "I<nanosleep>(),\n"
6027 "I<timer_create>(),\n"
6028 "I<timer_delete>(),\n"
6029 "I<timer_gettime>(),\n"
6030 "I<timer_getoverrun>(),\n"
6031 "I<timer_settime>().\n"
6032 msgstr ""
6033
6034 #. type: SS
6035 #: build/C/man7/posixoptions.7:735
6036 #, no-wrap
6037 msgid "TRC - _POSIX_TRACE - _SC_TRACE"
6038 msgstr ""
6039
6040 #. type: Plain text
6041 #: build/C/man7/posixoptions.7:738
6042 msgid "POSIX tracing is available.  The following functions are present:"
6043 msgstr ""
6044
6045 #. type: Plain text
6046 #: build/C/man7/posixoptions.7:773
6047 #, no-wrap
6048 msgid ""
6049 "I<posix_trace_attr_destroy>(),\n"
6050 "I<posix_trace_attr_getclockres>(),\n"
6051 "I<posix_trace_attr_getcreatetime>(),\n"
6052 "I<posix_trace_attr_getgenversion>(),\n"
6053 "I<posix_trace_attr_getmaxdatasize>(),\n"
6054 "I<posix_trace_attr_getmaxsystemeventsize>(),\n"
6055 "I<posix_trace_attr_getmaxusereventsize>(),\n"
6056 "I<posix_trace_attr_getname>(),\n"
6057 "I<posix_trace_attr_getstreamfullpolicy>(),\n"
6058 "I<posix_trace_attr_getstreamsize>(),\n"
6059 "I<posix_trace_attr_init>(),\n"
6060 "I<posix_trace_attr_setmaxdatasize>(),\n"
6061 "I<posix_trace_attr_setname>(),\n"
6062 "I<posix_trace_attr_setstreamsize>(),\n"
6063 "I<posix_trace_attr_setstreamfullpolicy>(),\n"
6064 "I<posix_trace_clear>(),\n"
6065 "I<posix_trace_create>(),\n"
6066 "I<posix_trace_event>(),\n"
6067 "I<posix_trace_eventid_equal>(),\n"
6068 "I<posix_trace_eventid_get_name>(),\n"
6069 "I<posix_trace_eventid_open>(),\n"
6070 "I<posix_trace_eventtypelist_getnext_id>(),\n"
6071 "I<posix_trace_eventtypelist_rewind>(),\n"
6072 "I<posix_trace_flush>(),\n"
6073 "I<posix_trace_get_attr>(),\n"
6074 "I<posix_trace_get_status>(),\n"
6075 "I<posix_trace_getnext_event>(),\n"
6076 "I<posix_trace_shutdown>(),\n"
6077 "I<posix_trace_start>(),\n"
6078 "I<posix_trace_stop>(),\n"
6079 "I<posix_trace_trygetnext_event>().\n"
6080 msgstr ""
6081
6082 #. type: SS
6083 #: build/C/man7/posixoptions.7:776
6084 #, no-wrap
6085 msgid "TEF - _POSIX_TRACE_EVENT_FILTER - _SC_TRACE_EVENT_FILTER"
6086 msgstr ""
6087
6088 #. type: Plain text
6089 #: build/C/man7/posixoptions.7:781 build/C/man7/posixoptions.7:816
6090 msgid ""
6091 "This option implies the B<_POSIX_TRACE> option.  The following functions are "
6092 "present:"
6093 msgstr ""
6094
6095 #. type: Plain text
6096 #: build/C/man7/posixoptions.7:793
6097 #, no-wrap
6098 msgid ""
6099 "I<posix_trace_eventset_add>(),\n"
6100 "I<posix_trace_eventset_del>(),\n"
6101 "I<posix_trace_eventset_empty>(),\n"
6102 "I<posix_trace_eventset_fill>(),\n"
6103 "I<posix_trace_eventset_ismember>(),\n"
6104 "I<posix_trace_get_filter>(),\n"
6105 "I<posix_trace_set_filter>(),\n"
6106 "I<posix_trace_trid_eventid_open>().\n"
6107 msgstr ""
6108
6109 #. type: SS
6110 #: build/C/man7/posixoptions.7:796
6111 #, no-wrap
6112 msgid "TRI - _POSIX_TRACE_INHERIT - _SC_TRACE_INHERIT"
6113 msgstr ""
6114
6115 #. type: Plain text
6116 #: build/C/man7/posixoptions.7:802
6117 msgid ""
6118 "Tracing children of the traced process is supported.  This option implies "
6119 "the B<_POSIX_TRACE> option.  The following functions are present:"
6120 msgstr ""
6121
6122 #. type: Plain text
6123 #: build/C/man7/posixoptions.7:808
6124 #, no-wrap
6125 msgid ""
6126 "I<posix_trace_attr_getinherited>(),\n"
6127 "I<posix_trace_attr_setinherited>().\n"
6128 msgstr ""
6129
6130 #. type: SS
6131 #: build/C/man7/posixoptions.7:811
6132 #, no-wrap
6133 msgid "TRL - _POSIX_TRACE_LOG - _SC_TRACE_LOG"
6134 msgstr ""
6135
6136 #. type: Plain text
6137 #: build/C/man7/posixoptions.7:828
6138 #, no-wrap
6139 msgid ""
6140 "I<posix_trace_attr_getlogfullpolicy>(),\n"
6141 "I<posix_trace_attr_getlogsize>(),\n"
6142 "I<posix_trace_attr_setlogfullpolicy>(),\n"
6143 "I<posix_trace_attr_setlogsize>(),\n"
6144 "I<posix_trace_close>(),\n"
6145 "I<posix_trace_create_withlog>(),\n"
6146 "I<posix_trace_open>(),\n"
6147 "I<posix_trace_rewind>().\n"
6148 msgstr ""
6149
6150 #. type: SS
6151 #: build/C/man7/posixoptions.7:831
6152 #, no-wrap
6153 msgid "TYM - _POSIX_TYPED_MEMORY_OBJECTS - _SC_TYPED_MEMORY_OBJECT"
6154 msgstr ""
6155
6156 #. type: Plain text
6157 #: build/C/man7/posixoptions.7:840
6158 #, no-wrap
6159 msgid ""
6160 "I<posix_mem_offset>(),\n"
6161 "I<posix_typed_mem_get_info>(),\n"
6162 "I<posix_typed_mem_open>().\n"
6163 msgstr ""
6164
6165 #. type: SS
6166 #: build/C/man7/posixoptions.7:843
6167 #, no-wrap
6168 msgid "--- - _POSIX_VDISABLE"
6169 msgstr ""
6170
6171 #. type: Plain text
6172 #: build/C/man7/posixoptions.7:847
6173 msgid ""
6174 "Always present (probably 0).  Value to set a changeable special control "
6175 "character to indicate that it is disabled."
6176 msgstr ""
6177
6178 #. type: SH
6179 #: build/C/man7/posixoptions.7:847
6180 #, no-wrap
6181 msgid "XOPEN EXTENSIONS"
6182 msgstr ""
6183
6184 #.  To be described.
6185 #. type: Plain text
6186 #: build/C/man7/posixoptions.7:854
6187 msgid ""
6188 "B<_XOPEN_CRYPT>, B<_XOPEN_LEGACY>, B<_XOPEN_REALTIME>, "
6189 "B<_XOPEN_REALTIME_THREADS>, B<_XOPEN_UNIX>."
6190 msgstr ""
6191
6192 #. type: Plain text
6193 #: build/C/man7/posixoptions.7:857
6194 msgid "B<sysconf>(3), B<standards>(7)"
6195 msgstr ""
6196
6197 #. type: TH
6198 #: build/C/man5/proc.5:62
6199 #, no-wrap
6200 msgid "PROC"
6201 msgstr ""
6202
6203 #. type: TH
6204 #: build/C/man5/proc.5:62
6205 #, no-wrap
6206 msgid "2013-09-04"
6207 msgstr ""
6208
6209 #. type: Plain text
6210 #: build/C/man5/proc.5:65
6211 msgid "proc - process information pseudo-filesystem"
6212 msgstr ""
6213
6214 #. type: Plain text
6215 #: build/C/man5/proc.5:74
6216 msgid ""
6217 "The I<proc> filesystem is a pseudo-filesystem which provides an interface to "
6218 "kernel data structures.  It is commonly mounted at I</proc>.  Most of it is "
6219 "read-only, but some files allow kernel variables to be changed."
6220 msgstr ""
6221
6222 #. type: Plain text
6223 #: build/C/man5/proc.5:78
6224 msgid ""
6225 "The following list describes many of the files and directories under the "
6226 "I</proc> hierarchy."
6227 msgstr ""
6228
6229 #. type: TP
6230 #: build/C/man5/proc.5:79
6231 #, no-wrap
6232 msgid "I</proc/[pid]>"
6233 msgstr ""
6234
6235 #.  FIXME Describe /proc/[pid]/attr and
6236 #.        /proc/[pid]/task/[tid]/attr
6237 #.        This is a directory
6238 #.        Added in ???
6239 #.        CONFIG_SECURITY
6240 #. type: Plain text
6241 #: build/C/man5/proc.5:91
6242 msgid ""
6243 "There is a numerical subdirectory for each running process; the subdirectory "
6244 "is named by the process ID.  Each such subdirectory contains the following "
6245 "pseudo-files and directories."
6246 msgstr ""
6247
6248 #. type: TP
6249 #: build/C/man5/proc.5:91
6250 #, no-wrap
6251 msgid "I</proc/[pid]/auxv> (since 2.6.0-test7)"
6252 msgstr ""
6253
6254 #. type: Plain text
6255 #: build/C/man5/proc.5:98
6256 msgid ""
6257 "This contains the contents of the ELF interpreter information passed to the "
6258 "process at exec time.  The format is one I<unsigned long> ID plus one "
6259 "I<unsigned long> value for each entry.  The last entry contains two zeros."
6260 msgstr ""
6261
6262 #. type: TP
6263 #: build/C/man5/proc.5:98
6264 #, no-wrap
6265 msgid "I</proc/[pid]/cgroup> (since Linux 2.6.24)"
6266 msgstr ""
6267
6268 #.        Info in Documentation/cgroups/cgroups.txt
6269 #. type: Plain text
6270 #: build/C/man5/proc.5:104
6271 msgid ""
6272 "This file describes control groups to which the process/task belongs.  For "
6273 "each cgroup hierarchy there is one entry containing colon-separated fields "
6274 "of the form:"
6275 msgstr ""
6276
6277 #. type: Plain text
6278 #: build/C/man5/proc.5:108
6279 #, no-wrap
6280 msgid "CW<    5:cpuacct,cpu,cpuset:/daemons>\n"
6281 msgstr ""
6282
6283 #. type: Plain text
6284 #: build/C/man5/proc.5:112
6285 msgid "The colon-separated fields are, from left to right:"
6286 msgstr ""
6287
6288 #. type: IP
6289 #: build/C/man5/proc.5:113
6290 #, no-wrap
6291 msgid "1."
6292 msgstr ""
6293
6294 #. type: Plain text
6295 #: build/C/man5/proc.5:115
6296 msgid "hierarchy ID number"
6297 msgstr ""
6298
6299 #. type: IP
6300 #: build/C/man5/proc.5:115
6301 #, no-wrap
6302 msgid "2."
6303 msgstr ""
6304
6305 #. type: Plain text
6306 #: build/C/man5/proc.5:117
6307 msgid "set of subsystems bound to the hierarchy"
6308 msgstr ""
6309
6310 #. type: IP
6311 #: build/C/man5/proc.5:117
6312 #, no-wrap
6313 msgid "3."
6314 msgstr ""
6315
6316 #. type: Plain text
6317 #: build/C/man5/proc.5:119
6318 msgid "control group in the hierarchy to which the process belongs"
6319 msgstr ""
6320
6321 #
6322 #.  FIXME Describe /proc/[pid]/clear_refs
6323 #.        Added in 2.6.22
6324 #.        "Clears page referenced bits shown in smaps output"
6325 #.        write-only
6326 #.        CONFIG_PROC_PAGE_MONITOR
6327 #. type: Plain text
6328 #: build/C/man5/proc.5:130
6329 msgid ""
6330 "This file is present only if the B<CONFIG_CGROUPS> kernel configuration "
6331 "option is enabled."
6332 msgstr ""
6333
6334 #. type: TP
6335 #: build/C/man5/proc.5:130
6336 #, no-wrap
6337 msgid "I</proc/[pid]/cmdline>"
6338 msgstr ""
6339
6340 #.  In 2.3.26, this also used to be true if the process was swapped out.
6341 #. type: Plain text
6342 #: build/C/man5/proc.5:140
6343 msgid ""
6344 "This holds the complete command line for the process, unless the process is "
6345 "a zombie.  In the latter case, there is nothing in this file: that is, a "
6346 "read on this file will return 0 characters.  The command-line arguments "
6347 "appear in this file as a set of strings separated by null bytes "
6348 "(\\(aq\\e0\\(aq), with a further null byte after the last string."
6349 msgstr ""
6350
6351 #. type: TP
6352 #: build/C/man5/proc.5:140
6353 #, no-wrap
6354 msgid "I</proc/[pid]/coredump_filter> (since kernel 2.6.23)"
6355 msgstr ""
6356
6357 #. type: Plain text
6358 #: build/C/man5/proc.5:144 build/C/man5/proc.5:2809 build/C/man5/proc.5:2813
6359 msgid "See B<core>(5)."
6360 msgstr ""
6361
6362 #. type: TP
6363 #: build/C/man5/proc.5:144
6364 #, no-wrap
6365 msgid "I</proc/[pid]/cpuset> (since kernel 2.6.12)"
6366 msgstr ""
6367
6368 #.  and/proc/[pid]/task/[tid]/cpuset
6369 #. type: Plain text
6370 #: build/C/man5/proc.5:149
6371 msgid "See B<cpuset>(7)."
6372 msgstr ""
6373
6374 #. type: TP
6375 #: build/C/man5/proc.5:149
6376 #, no-wrap
6377 msgid "I</proc/[pid]/cwd>"
6378 msgstr ""
6379
6380 #. type: Plain text
6381 #: build/C/man5/proc.5:154
6382 msgid ""
6383 "This is a symbolic link to the current working directory of the process.  To "
6384 "find out the current working directory of process 20, for instance, you can "
6385 "do this:"
6386 msgstr ""
6387
6388 #. type: Plain text
6389 #: build/C/man5/proc.5:158
6390 #, no-wrap
6391 msgid "$B< cd /proc/20/cwd; /bin/pwd>\n"
6392 msgstr ""
6393
6394 #. type: Plain text
6395 #: build/C/man5/proc.5:169
6396 msgid ""
6397 "Note that the I<pwd> command is often a shell built-in, and might not work "
6398 "properly.  In B<bash>(1), you may use I<pwd\\ -P>."
6399 msgstr ""
6400
6401 #.  The following was still true as at kernel 2.6.13
6402 #.  FIXME Describe /proc/[pid]/seccomp
6403 #.        Added in 2.6.12
6404 #.  FIXME Describe /proc/[pid]/sessionid
6405 #.        Added in 2.6.25; read-only; only readable by real UID
6406 #.        CONFIG_AUDITSYSCALL
6407 #.  FIXME Describe /proc/[pid]/sched
6408 #.        Added in 2.6.23
6409 #.        CONFIG_SCHED_DEBUG, and additional fields if CONFIG_SCHEDSTATS
6410 #.        Displays various scheduling parameters
6411 #.        This file can be written, to reset stats
6412 #.  FIXME Describe /proc/[pid]/schedstats and
6413 #.        /proc/[pid]/task/[tid]/schedstats
6414 #.        Added in 2.6.9
6415 #.        CONFIG_SCHEDSTATS
6416 #. type: Plain text
6417 #: build/C/man5/proc.5:175 build/C/man5/proc.5:956
6418 msgid ""
6419 "In a multithreaded process, the contents of this symbolic link are not "
6420 "available if the main thread has already terminated (typically by calling "
6421 "B<pthread_exit>(3))."
6422 msgstr ""
6423
6424 #. type: TP
6425 #: build/C/man5/proc.5:175
6426 #, no-wrap
6427 msgid "I</proc/[pid]/environ>"
6428 msgstr ""
6429
6430 #. type: Plain text
6431 #: build/C/man5/proc.5:181
6432 msgid ""
6433 "This file contains the environment for the process.  The entries are "
6434 "separated by null bytes (\\(aq\\e0\\(aq), and there may be a null byte at "
6435 "the end.  Thus, to print out the environment of process 1, you would do:"
6436 msgstr ""
6437
6438 #. type: Plain text
6439 #: build/C/man5/proc.5:186
6440 #, no-wrap
6441 msgid "$B< strings /proc/1/environ>\n"
6442 msgstr ""
6443
6444 #. type: TP
6445 #: build/C/man5/proc.5:189
6446 #, no-wrap
6447 msgid "I</proc/[pid]/exe>"
6448 msgstr ""
6449
6450 #.  The following was still true as at kernel 2.6.13
6451 #. type: Plain text
6452 #: build/C/man5/proc.5:204
6453 msgid ""
6454 "Under Linux 2.2 and later, this file is a symbolic link containing the "
6455 "actual pathname of the executed command.  This symbolic link can be "
6456 "dereferenced normally; attempting to open it will open the executable.  You "
6457 "can even type I</proc/[pid]/exe> to run another copy of the same executable "
6458 "as is being run by process [pid].  In a multithreaded process, the contents "
6459 "of this symbolic link are not available if the main thread has already "
6460 "terminated (typically by calling B<pthread_exit>(3))."
6461 msgstr ""
6462
6463 #. type: Plain text
6464 #: build/C/man5/proc.5:212
6465 msgid ""
6466 "Under Linux 2.0 and earlier I</proc/[pid]/exe> is a pointer to the binary "
6467 "which was executed, and appears as a symbolic link.  A B<readlink>(2)  call "
6468 "on this file under Linux 2.0 returns a string in the format:"
6469 msgstr ""
6470
6471 #. type: Plain text
6472 #: build/C/man5/proc.5:214
6473 #, no-wrap
6474 msgid "    [device]:inode\n"
6475 msgstr ""
6476
6477 #. type: Plain text
6478 #: build/C/man5/proc.5:217
6479 msgid ""
6480 "For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, MFM, "
6481 "etc. drives) minor 01 (first partition on the first drive)."
6482 msgstr ""
6483
6484 #. type: Plain text
6485 #: build/C/man5/proc.5:222
6486 msgid "B<find>(1)  with the I<-inum> option can be used to locate the file."
6487 msgstr ""
6488
6489 #. type: TP
6490 #: build/C/man5/proc.5:222
6491 #, no-wrap
6492 msgid "I</proc/[pid]/fd/>"
6493 msgstr ""
6494
6495 #. type: Plain text
6496 #: build/C/man5/proc.5:228
6497 msgid ""
6498 "This is a subdirectory containing one entry for each file which the process "
6499 "has open, named by its file descriptor, and which is a symbolic link to the "
6500 "actual file.  Thus, 0 is standard input, 1 standard output, 2 standard "
6501 "error, etc."
6502 msgstr ""
6503
6504 #. type: Plain text
6505 #: build/C/man5/proc.5:235
6506 msgid ""
6507 "For file descriptors for pipes and sockets, the entries will be symbolic "
6508 "links whose content is the file type with the inode.  A B<readlink>(2)  call "
6509 "on this file returns a string in the format:"
6510 msgstr ""
6511
6512 #. type: Plain text
6513 #: build/C/man5/proc.5:237
6514 #, no-wrap
6515 msgid "    type:[inode]\n"
6516 msgstr ""
6517
6518 #. type: Plain text
6519 #: build/C/man5/proc.5:244
6520 msgid ""
6521 "For example, I<socket:[2248868]> will be a socket and its inode is 2248868.  "
6522 "For sockets, that inode can be used to find more information in one of the "
6523 "files under I</proc/net/>."
6524 msgstr ""
6525
6526 #. type: Plain text
6527 #: build/C/man5/proc.5:254
6528 msgid ""
6529 "For file descriptors that have no corresponding inode (e.g., file "
6530 "descriptors produced by B<epoll_create>(2), B<eventfd>(2), "
6531 "B<inotify_init>(2), B<signalfd>(2), and B<timerfd>(2)), the entry will be a "
6532 "symbolic link with contents of the form"
6533 msgstr ""
6534
6535 #. type: Plain text
6536 #: build/C/man5/proc.5:256
6537 #, no-wrap
6538 msgid "    anon_inode:E<lt>file-typeE<gt>\n"
6539 msgstr ""
6540
6541 #. type: Plain text
6542 #: build/C/man5/proc.5:260
6543 msgid "In some cases, the I<file-type> is surrounded by square brackets."
6544 msgstr ""
6545
6546 #. type: Plain text
6547 #: build/C/man5/proc.5:264
6548 msgid ""
6549 "For example, an epoll file descriptor will have a symbolic link whose "
6550 "content is the string I<anon_inode:[eventpoll]>."
6551 msgstr ""
6552
6553 #. The following was still true as at kernel 2.6.13
6554 #. type: Plain text
6555 #: build/C/man5/proc.5:270
6556 msgid ""
6557 "In a multithreaded process, the contents of this directory are not available "
6558 "if the main thread has already terminated (typically by calling "
6559 "B<pthread_exit>(3))."
6560 msgstr ""
6561
6562 #. type: Plain text
6563 #: build/C/man5/proc.5:283
6564 msgid ""
6565 "Programs that will take a filename as a command-line argument, but will not "
6566 "take input from standard input if no argument is supplied, or that write to "
6567 "a file named as a command-line argument, but will not send their output to "
6568 "standard output if no argument is supplied, can nevertheless be made to use "
6569 "standard input or standard out using I</proc/[pid]/fd>.  For example, "
6570 "assuming that I<-i> is the flag designating an input file and I<-o> is the "
6571 "flag designating an output file:"
6572 msgstr ""
6573
6574 #. type: Plain text
6575 #: build/C/man5/proc.5:287
6576 #, no-wrap
6577 msgid "$B< foobar -i /proc/self/fd/0 -o /proc/self/fd/1 ...>\n"
6578 msgstr ""
6579
6580 #.  The following is not true in my tests (MTK):
6581 #.  Note that this will not work for
6582 #.  programs that seek on their files, as the files in the fd directory
6583 #.  are not seekable.
6584 #. type: Plain text
6585 #: build/C/man5/proc.5:295
6586 msgid "and you have a working filter."
6587 msgstr ""
6588
6589 #. type: Plain text
6590 #: build/C/man5/proc.5:305
6591 msgid ""
6592 "I</proc/self/fd/N> is approximately the same as I</dev/fd/N> in some UNIX "
6593 "and UNIX-like systems.  Most Linux MAKEDEV scripts symbolically link "
6594 "I</dev/fd> to I</proc/self/fd>, in fact."
6595 msgstr ""
6596
6597 #. type: Plain text
6598 #: build/C/man5/proc.5:319
6599 msgid ""
6600 "Most systems provide symbolic links I</dev/stdin>, I</dev/stdout>, and "
6601 "I</dev/stderr>, which respectively link to the files I<0>, I<1>, and I<2> in "
6602 "I</proc/self/fd>.  Thus the example command above could be written as:"
6603 msgstr ""
6604
6605 #. type: Plain text
6606 #: build/C/man5/proc.5:323
6607 #, no-wrap
6608 msgid "$B< foobar -i /dev/stdin -o /dev/stdout ...>\n"
6609 msgstr ""
6610
6611 #. type: TP
6612 #: build/C/man5/proc.5:328
6613 #, no-wrap
6614 msgid "I</proc/[pid]/fdinfo/> (since kernel 2.6.22)"
6615 msgstr ""
6616
6617 #. type: Plain text
6618 #: build/C/man5/proc.5:334
6619 msgid ""
6620 "This is a subdirectory containing one entry for each file which the process "
6621 "has open, named by its file descriptor.  The contents of each file can be "
6622 "read to obtain information about the corresponding file descriptor, for "
6623 "example:"
6624 msgstr ""
6625
6626 #. type: Plain text
6627 #: build/C/man5/proc.5:340
6628 #, no-wrap
6629 msgid ""
6630 "$B< cat /proc/12015/fdinfo/4>\n"
6631 "pos:    1000\n"
6632 "flags:  01002002\n"
6633 msgstr ""
6634
6635 #. type: Plain text
6636 #: build/C/man5/proc.5:351
6637 msgid ""
6638 "The I<pos> field is a decimal number showing the current file offset.  The "
6639 "I<flags> field is an octal number that displays the file access mode and "
6640 "file status flags (see B<open>(2))."
6641 msgstr ""
6642
6643 #. type: Plain text
6644 #: build/C/man5/proc.5:353
6645 msgid "The files in this directory are readable only by the owner of the process."
6646 msgstr ""
6647
6648 #. type: TP
6649 #: build/C/man5/proc.5:353
6650 #, no-wrap
6651 msgid "I</proc/[pid]/io> (since kernel 2.6.20)"
6652 msgstr ""
6653
6654 #.  commit 7c3ab7381e79dfc7db14a67c6f4f3285664e1ec2
6655 #. type: Plain text
6656 #: build/C/man5/proc.5:357
6657 msgid "This file contains I/O statistics for the process, for example:"
6658 msgstr ""
6659
6660 #. type: Plain text
6661 #: build/C/man5/proc.5:368
6662 #, no-wrap
6663 msgid ""
6664 "#B< cat /proc/3828/io>\n"
6665 "rchar: 323934931\n"
6666 "wchar: 323929600\n"
6667 "syscr: 632687\n"
6668 "syscw: 632675\n"
6669 "read_bytes: 0\n"
6670 "write_bytes: 323932160\n"
6671 "cancelled_write_bytes: 0\n"
6672 msgstr ""
6673
6674 #. type: Plain text
6675 #: build/C/man5/proc.5:372 build/C/man5/proc.5:1319
6676 msgid "The fields are as follows:"
6677 msgstr ""
6678
6679 #. type: TP
6680 #: build/C/man5/proc.5:373
6681 #, no-wrap
6682 msgid "I<rchar>: characters read"
6683 msgstr ""
6684
6685 #. type: Plain text
6686 #: build/C/man5/proc.5:383
6687 msgid ""
6688 "The number of bytes which this task has caused to be read from storage.  "
6689 "This is simply the sum of bytes which this process passed to B<read>(2)  and "
6690 "similar system calls.  It includes things such as terminal I/O and is "
6691 "unaffected by whether or not actual physical disk I/O was required (the read "
6692 "might have been satisfied from pagecache)."
6693 msgstr ""
6694
6695 #. type: TP
6696 #: build/C/man5/proc.5:383
6697 #, no-wrap
6698 msgid "I<wchar>: characters written"
6699 msgstr ""
6700
6701 #. type: Plain text
6702 #: build/C/man5/proc.5:389
6703 msgid ""
6704 "The number of bytes which this task has caused, or shall cause to be written "
6705 "to disk.  Similar caveats apply here as with I<rchar>."
6706 msgstr ""
6707
6708 #. type: TP
6709 #: build/C/man5/proc.5:389
6710 #, no-wrap
6711 msgid "I<syscr>: read syscalls"
6712 msgstr ""
6713
6714 #. type: Plain text
6715 #: build/C/man5/proc.5:396
6716 msgid ""
6717 "Attempt to count the number of read I/O operations\\(emthat is, system calls "
6718 "such as B<read>(2)  and B<pread>(2)."
6719 msgstr ""
6720
6721 #. type: TP
6722 #: build/C/man5/proc.5:396
6723 #, no-wrap
6724 msgid "I<syscw>: write syscalls"
6725 msgstr ""
6726
6727 #. type: Plain text
6728 #: build/C/man5/proc.5:403
6729 msgid ""
6730 "Attempt to count the number of write I/O operations\\(emthat is, system "
6731 "calls such as B<write>(2)  and B<pwrite>(2)."
6732 msgstr ""
6733
6734 #. type: TP
6735 #: build/C/man5/proc.5:403
6736 #, no-wrap
6737 msgid "I<read_bytes>: bytes read"
6738 msgstr ""
6739
6740 #. type: Plain text
6741 #: build/C/man5/proc.5:408
6742 msgid ""
6743 "Attempt to count the number of bytes which this process really did cause to "
6744 "be fetched from the storage layer.  This is accurate for block-backed "
6745 "filesystems."
6746 msgstr ""
6747
6748 #. type: TP
6749 #: build/C/man5/proc.5:408
6750 #, no-wrap
6751 msgid "I<write_bytes>: bytes written"
6752 msgstr ""
6753
6754 #. type: Plain text
6755 #: build/C/man5/proc.5:412
6756 msgid ""
6757 "Attempt to count the number of bytes which this process caused to be sent to "
6758 "the storage layer."
6759 msgstr ""
6760
6761 #. type: TP
6762 #: build/C/man5/proc.5:412
6763 #, no-wrap
6764 msgid "I<cancelled_write_bytes>:"
6765 msgstr ""
6766
6767 #. type: Plain text
6768 #: build/C/man5/proc.5:426
6769 msgid ""
6770 "The big inaccuracy here is truncate.  If a process writes 1MB to a file and "
6771 "then deletes the file, it will in fact perform no writeout.  But it will "
6772 "have been accounted as having caused 1MB of write.  In other words: this "
6773 "field represents the number of bytes which this process caused to not "
6774 "happen, by truncating pagecache.  A task can cause \"negative\" I/O too.  If "
6775 "this task truncates some dirty pagecache, some I/O which another task has "
6776 "been accounted for (in its I<write_bytes>)  will not be happening."
6777 msgstr ""
6778
6779 #. type: Plain text
6780 #: build/C/man5/proc.5:434
6781 msgid ""
6782 "I<Note>: In the current implementation, things are a bit racy on 32-bit "
6783 "systems: if process A reads process B's I</proc/[pid]/io> while process B is "
6784 "updating one of these 64-bit counters, process A could see an intermediate "
6785 "result."
6786 msgstr ""
6787
6788 #. type: TP
6789 #: build/C/man5/proc.5:435
6790 #, no-wrap
6791 msgid "I</proc/[pid]/limits> (since kernel 2.6.24)"
6792 msgstr ""
6793
6794 #.  commit 3036e7b490bf7878c6dae952eec5fb87b1106589
6795 #. type: Plain text
6796 #: build/C/man5/proc.5:445
6797 msgid ""
6798 "This file displays the soft limit, hard limit, and units of measurement for "
6799 "each of the process's resource limits (see B<getrlimit>(2)).  Up to and "
6800 "including Linux 2.6.35, this file is protected to allow reading only by the "
6801 "real UID of the process.  Since Linux 2.6.36, this file is readable by all "
6802 "users on the system."
6803 msgstr ""
6804
6805 #. type: TP
6806 #: build/C/man5/proc.5:445
6807 #, no-wrap
6808 msgid "I</proc/[pid]/map_files/> (since kernel 3.3)"
6809 msgstr ""
6810
6811 #.  commit 640708a2cff7f81e246243b0073c66e6ece7e53e
6812 #. type: Plain text
6813 #: build/C/man5/proc.5:455
6814 msgid ""
6815 "This subdirectory contains entries corresponding to memory-mapped files (see "
6816 "B<mmap>(2)).  Entries are named by memory region start and end address pair "
6817 "(expressed as hexadecimal numbers), and are symbolic links to the mapped "
6818 "files themselves.  Here is an example, with the output wrapped and "
6819 "reformatted to fit on an 80-column display:"
6820 msgstr ""
6821
6822 #. type: Plain text
6823 #: build/C/man5/proc.5:462
6824 #, no-wrap
6825 msgid ""
6826 "$B< ls -l /proc/self/map_files/>\n"
6827 "lr--------. 1 root root 64 Apr 16 21:31\n"
6828 "            3252e00000-3252e20000 -E<gt> /usr/lib64/ld-2.15.so\n"
6829 "\\&...\n"
6830 msgstr ""
6831
6832 #. type: Plain text
6833 #: build/C/man5/proc.5:476
6834 msgid ""
6835 "Although these entries are present for memory regions that were mapped with "
6836 "the B<MAP_FILE> flag, the way anonymous shared memory (regions created with "
6837 "the B<MAP_ANON | MAP_SHARED> flags)  is implemented in Linux means that such "
6838 "regions also appear on this directory.  Here is an example where the target "
6839 "file is the deleted I</dev/zero> one:"
6840 msgstr ""
6841
6842 #. type: Plain text
6843 #: build/C/man5/proc.5:482
6844 #, no-wrap
6845 msgid ""
6846 "lrw-------. 1 root root 64 Apr 16 21:33\n"
6847 "            7fc075d2f000-7fc075e6f000 -E<gt> /dev/zero (deleted)\n"
6848 msgstr ""
6849
6850 #. type: Plain text
6851 #: build/C/man5/proc.5:488
6852 msgid ""
6853 "This directory appears only if the B<CONFIG_CHECKPOINT_RESTORE> kernel "
6854 "configuration option is enabled."
6855 msgstr ""
6856
6857 #. type: TP
6858 #: build/C/man5/proc.5:488
6859 #, no-wrap
6860 msgid "I</proc/[pid]/maps>"
6861 msgstr ""
6862
6863 #. type: Plain text
6864 #: build/C/man5/proc.5:495
6865 msgid ""
6866 "A file containing the currently mapped memory regions and their access "
6867 "permissions.  See B<mmap>(2)  for some further information about memory "
6868 "mappings."
6869 msgstr ""
6870
6871 #. type: Plain text
6872 #: build/C/man5/proc.5:497
6873 msgid "The format of the file is:"
6874 msgstr ""
6875
6876 #. type: Plain text
6877 #: build/C/man5/proc.5:522
6878 #, no-wrap
6879 msgid ""
6880 "I<address           perms offset  dev   inode       pathname>\n"
6881 "00400000-00452000 r-xp 00000000 08:02 173521      /usr/bin/dbus-daemon\n"
6882 "00651000-00652000 r--p 00051000 08:02 173521      /usr/bin/dbus-daemon\n"
6883 "00652000-00655000 rw-p 00052000 08:02 173521      /usr/bin/dbus-daemon\n"
6884 "00e03000-00e24000 rw-p 00000000 00:00 0           [heap]\n"
6885 "00e24000-011f7000 rw-p 00000000 00:00 0           [heap]\n"
6886 "\\&...\n"
6887 "35b1800000-35b1820000 r-xp 00000000 08:02 135522  /usr/lib64/ld-2.15.so\n"
6888 "35b1a1f000-35b1a20000 r--p 0001f000 08:02 135522  /usr/lib64/ld-2.15.so\n"
6889 "35b1a20000-35b1a21000 rw-p 00020000 08:02 135522  /usr/lib64/ld-2.15.so\n"
6890 "35b1a21000-35b1a22000 rw-p 00000000 00:00 0\n"
6891 "35b1c00000-35b1dac000 r-xp 00000000 08:02 135870  /usr/lib64/libc-2.15.so\n"
6892 "35b1dac000-35b1fac000 ---p 001ac000 08:02 135870  /usr/lib64/libc-2.15.so\n"
6893 "35b1fac000-35b1fb0000 r--p 001ac000 08:02 135870  /usr/lib64/libc-2.15.so\n"
6894 "35b1fb0000-35b1fb2000 rw-p 001b0000 08:02 135870  /usr/lib64/libc-2.15.so\n"
6895 "\\&...\n"
6896 "f2c6ff8c000-7f2c7078c000 rw-p 00000000 00:00 0    [stack:986]\n"
6897 "\\&...\n"
6898 "7fffb2c0d000-7fffb2c2e000 rw-p 00000000 00:00 0   [stack]\n"
6899 "7fffb2d48000-7fffb2d49000 r-xp 00000000 00:00 0   [vdso]\n"
6900 msgstr ""
6901
6902 #. type: Plain text
6903 #: build/C/man5/proc.5:531
6904 msgid ""
6905 "The I<address> field is the address space in the process that the mapping "
6906 "occupies.  The I<perms> field is a set of permissions:"
6907 msgstr ""
6908
6909 #. type: Plain text
6910 #: build/C/man5/proc.5:539
6911 #, no-wrap
6912 msgid ""
6913 "r = read\n"
6914 "w = write\n"
6915 "x = execute\n"
6916 "s = shared\n"
6917 "p = private (copy on write)\n"
6918 msgstr ""
6919
6920 #. type: Plain text
6921 #: build/C/man5/proc.5:552
6922 msgid ""
6923 "The I<offset> field is the offset into the file/whatever; I<dev> is the "
6924 "device (major:minor); I<inode> is the inode on that device.  0 indicates "
6925 "that no inode is associated with the memory region, as would be the case "
6926 "with BSS (uninitialized data)."
6927 msgstr ""
6928
6929 #. type: Plain text
6930 #: build/C/man5/proc.5:562
6931 msgid ""
6932 "The I<pathname> field will usually be the file that is backing the mapping.  "
6933 "For ELF files, you can easily coordinate with the I<offset> field by looking "
6934 "at the Offset field in the ELF program headers (I<readelf\\ -l>)."
6935 msgstr ""
6936
6937 #. type: Plain text
6938 #: build/C/man5/proc.5:564
6939 msgid "There are additional helpful pseudo-paths:"
6940 msgstr ""
6941
6942 #. type: TP
6943 #: build/C/man5/proc.5:565
6944 #, no-wrap
6945 msgid "I<[stack]>"
6946 msgstr ""
6947
6948 #. type: Plain text
6949 #: build/C/man5/proc.5:568
6950 msgid "The initial process's (also known as the main thread's) stack."
6951 msgstr ""
6952
6953 #. type: TP
6954 #: build/C/man5/proc.5:568
6955 #, no-wrap
6956 msgid "I<[stack:E<lt>tidE<gt>]> (since Linux 3.4)"
6957 msgstr ""
6958
6959 #.  commit b76437579d1344b612cf1851ae610c636cec7db0
6960 #. type: Plain text
6961 #: build/C/man5/proc.5:577
6962 msgid ""
6963 "A thread's stack (where the I<E<lt>tidE<gt>> is a thread ID).  It "
6964 "corresponds to the I</proc/[pid]/task/[tid]/> path."
6965 msgstr ""
6966
6967 #. type: TP
6968 #: build/C/man5/proc.5:577
6969 #, no-wrap
6970 msgid "I<[vdso]>"
6971 msgstr ""
6972
6973 #. type: Plain text
6974 #: build/C/man5/proc.5:580
6975 msgid "The virtual dynamically linked shared object."
6976 msgstr ""
6977
6978 #. type: TP
6979 #: build/C/man5/proc.5:580
6980 #, no-wrap
6981 msgid "I<[heap]>"
6982 msgstr ""
6983
6984 #. type: Plain text
6985 #: build/C/man5/proc.5:583
6986 msgid "The process's heap."
6987 msgstr ""
6988
6989 #. type: Plain text
6990 #: build/C/man5/proc.5:598
6991 msgid ""
6992 "If the I<pathname> field is blank, this is an anonymous mapping as obtained "
6993 "via the B<mmap>(2)  function.  There is no easy way to coordinate this back "
6994 "to a process's source, short of running it through B<gdb>(1), B<strace>(1), "
6995 "or similar."
6996 msgstr ""
6997
6998 #. type: Plain text
6999 #: build/C/man5/proc.5:600
7000 msgid "Under Linux 2.0 there is no field giving pathname."
7001 msgstr ""
7002
7003 #. type: TP
7004 #: build/C/man5/proc.5:600
7005 #, no-wrap
7006 msgid "I</proc/[pid]/mem>"
7007 msgstr ""
7008
7009 #. type: Plain text
7010 #: build/C/man5/proc.5:607
7011 msgid ""
7012 "This file can be used to access the pages of a process's memory through "
7013 "B<open>(2), B<read>(2), and B<lseek>(2)."
7014 msgstr ""
7015
7016 #. type: TP
7017 #: build/C/man5/proc.5:607
7018 #, no-wrap
7019 msgid "I</proc/[pid]/mountinfo> (since Linux 2.6.26)"
7020 msgstr ""
7021
7022 #.  This info adapted from Documentation/filesystems/proc.txt
7023 #. type: Plain text
7024 #: build/C/man5/proc.5:612
7025 msgid ""
7026 "This file contains information about mount points.  It contains lines of the "
7027 "form:"
7028 msgstr ""
7029
7030 #. type: Plain text
7031 #: build/C/man5/proc.5:617
7032 #, no-wrap
7033 msgid ""
7034 "CW<36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root "
7035 "rw,errors=continue\n"
7036 "(1)(2)(3)   (4)   (5)      (6)      (7)   (8) (9)   (10)         (11)>\n"
7037 msgstr ""
7038
7039 #. type: Plain text
7040 #: build/C/man5/proc.5:621
7041 msgid "The numbers in parentheses are labels for the descriptions below:"
7042 msgstr ""
7043
7044 #. type: TP
7045 #: build/C/man5/proc.5:622 build/C/man5/proc.5:715
7046 #, no-wrap
7047 msgid "(1)"
7048 msgstr ""
7049
7050 #. type: Plain text
7051 #: build/C/man5/proc.5:626
7052 msgid "mount ID: unique identifier of the mount (may be reused after B<umount>(2))."
7053 msgstr ""
7054
7055 #. type: TP
7056 #: build/C/man5/proc.5:626 build/C/man5/proc.5:719
7057 #, no-wrap
7058 msgid "(2)"
7059 msgstr ""
7060
7061 #. type: Plain text
7062 #: build/C/man5/proc.5:629
7063 msgid "parent ID: ID of parent mount (or of self for the top of the mount tree)."
7064 msgstr ""
7065
7066 #. type: TP
7067 #: build/C/man5/proc.5:629 build/C/man5/proc.5:722
7068 #, no-wrap
7069 msgid "(3)"
7070 msgstr ""
7071
7072 #. type: Plain text
7073 #: build/C/man5/proc.5:635
7074 msgid "major:minor: value of I<st_dev> for files on filesystem (see B<stat>(2))."
7075 msgstr ""
7076
7077 #. type: TP
7078 #: build/C/man5/proc.5:635 build/C/man5/proc.5:725
7079 #, no-wrap
7080 msgid "(4)"
7081 msgstr ""
7082
7083 #. type: Plain text
7084 #: build/C/man5/proc.5:638
7085 msgid "root: root of the mount within the filesystem."
7086 msgstr ""
7087
7088 #. type: TP
7089 #: build/C/man5/proc.5:638
7090 #, no-wrap
7091 msgid "(5)"
7092 msgstr ""
7093
7094 #. type: Plain text
7095 #: build/C/man5/proc.5:641
7096 msgid "mount point: mount point relative to the process's root."
7097 msgstr ""
7098
7099 #. type: TP
7100 #: build/C/man5/proc.5:641
7101 #, no-wrap
7102 msgid "(6)"
7103 msgstr ""
7104
7105 #. type: Plain text
7106 #: build/C/man5/proc.5:644
7107 msgid "mount options: per-mount options."
7108 msgstr ""
7109
7110 #. type: TP
7111 #: build/C/man5/proc.5:644
7112 #, no-wrap
7113 msgid "(7)"
7114 msgstr ""
7115
7116 #. type: Plain text
7117 #: build/C/man5/proc.5:647
7118 msgid "optional fields: zero or more fields of the form \"tag[:value]\"."
7119 msgstr ""
7120
7121 #. type: TP
7122 #: build/C/man5/proc.5:647
7123 #, no-wrap
7124 msgid "(8)"
7125 msgstr ""
7126
7127 #. type: Plain text
7128 #: build/C/man5/proc.5:650
7129 msgid "separator: marks the end of the optional fields."
7130 msgstr ""
7131
7132 #. type: TP
7133 #: build/C/man5/proc.5:650
7134 #, no-wrap
7135 msgid "(9)"
7136 msgstr ""
7137
7138 #. type: Plain text
7139 #: build/C/man5/proc.5:653
7140 msgid "filesystem type: name of filesystem in the form \"type[.subtype]\"."
7141 msgstr ""
7142
7143 #. type: TP
7144 #: build/C/man5/proc.5:653
7145 #, no-wrap
7146 msgid "(10)"
7147 msgstr ""
7148
7149 #. type: Plain text
7150 #: build/C/man5/proc.5:656
7151 msgid "mount source: filesystem-specific information or \"none\"."
7152 msgstr ""
7153
7154 #. type: TP
7155 #: build/C/man5/proc.5:656
7156 #, no-wrap
7157 msgid "(11)"
7158 msgstr ""
7159
7160 #. type: Plain text
7161 #: build/C/man5/proc.5:659
7162 msgid "super options: per-super block options."
7163 msgstr ""
7164
7165 #. type: Plain text
7166 #: build/C/man5/proc.5:663
7167 msgid ""
7168 "Parsers should ignore all unrecognized optional fields.  Currently the "
7169 "possible optional fields are:"
7170 msgstr ""
7171
7172 #. type: TP
7173 #: build/C/man5/proc.5:664
7174 #, no-wrap
7175 msgid "shared:X"
7176 msgstr ""
7177
7178 #. type: Plain text
7179 #: build/C/man5/proc.5:667
7180 msgid "mount is shared in peer group X"
7181 msgstr ""
7182
7183 #. type: TP
7184 #: build/C/man5/proc.5:667
7185 #, no-wrap
7186 msgid "master:X"
7187 msgstr ""
7188
7189 #. type: Plain text
7190 #: build/C/man5/proc.5:670
7191 msgid "mount is slave to peer group X"
7192 msgstr ""
7193
7194 #. type: TP
7195 #: build/C/man5/proc.5:670
7196 #, no-wrap
7197 msgid "propagate_from:X"
7198 msgstr ""
7199
7200 #. type: Plain text
7201 #: build/C/man5/proc.5:673
7202 msgid "mount is slave and receives propagation from peer group X (*)"
7203 msgstr ""
7204
7205 #. type: TP
7206 #: build/C/man5/proc.5:673
7207 #, no-wrap
7208 msgid "unbindable"
7209 msgstr ""
7210
7211 #. type: Plain text
7212 #: build/C/man5/proc.5:676
7213 msgid "mount is unbindable"
7214 msgstr ""
7215
7216 #. type: Plain text
7217 #: build/C/man5/proc.5:683
7218 msgid ""
7219 "(*) X is the closest dominant peer group under the process's root.  If X is "
7220 "the immediate master of the mount, or if there is no dominant peer group "
7221 "under the same root, then only the \"master:X\" field is present and not the "
7222 "\"propagate_from:X\" field."
7223 msgstr ""
7224
7225 #. type: Plain text
7226 #: build/C/man5/proc.5:687
7227 msgid ""
7228 "For more information on mount propagation see: "
7229 "I<Documentation/filesystems/sharedsubtree.txt> in the Linux kernel source "
7230 "tree."
7231 msgstr ""
7232
7233 #. type: TP
7234 #: build/C/man5/proc.5:687
7235 #, no-wrap
7236 msgid "I</proc/[pid]/mounts> (since Linux 2.4.19)"
7237 msgstr ""
7238
7239 #. type: Plain text
7240 #: build/C/man5/proc.5:702
7241 msgid ""
7242 "This is a list of all the filesystems currently mounted in the process's "
7243 "mount namespace.  The format of this file is documented in B<fstab>(5).  "
7244 "Since kernel version 2.6.15, this file is pollable: after opening the file "
7245 "for reading, a change in this file (i.e., a filesystem mount or unmount) "
7246 "causes B<select>(2)  to mark the file descriptor as readable, and B<poll>(2)  "
7247 "and B<epoll_wait>(2)  mark the file as having an error condition."
7248 msgstr ""
7249
7250 #. type: TP
7251 #: build/C/man5/proc.5:702
7252 #, no-wrap
7253 msgid "I</proc/[pid]/mountstats> (since Linux 2.6.17)"
7254 msgstr ""
7255
7256 #. type: Plain text
7257 #: build/C/man5/proc.5:707
7258 msgid ""
7259 "This file exports information (statistics, configuration information)  about "
7260 "the mount points in the process's name space.  Lines in this file have the "
7261 "form:"
7262 msgstr ""
7263
7264 #. type: Plain text
7265 #: build/C/man5/proc.5:711
7266 #, no-wrap
7267 msgid ""
7268 "device /dev/sda7 mounted on /home with fstype ext3 [statistics]\n"
7269 "(       1      )            ( 2 )             (3 ) (4)\n"
7270 msgstr ""
7271
7272 #. type: Plain text
7273 #: build/C/man5/proc.5:714
7274 msgid "The fields in each line are:"
7275 msgstr ""
7276
7277 #. type: Plain text
7278 #: build/C/man5/proc.5:719
7279 msgid ""
7280 "The name of the mounted device (or \"nodevice\" if there is no corresponding "
7281 "device)."
7282 msgstr ""
7283
7284 #. type: Plain text
7285 #: build/C/man5/proc.5:722
7286 msgid "The mount point within the filesystem tree."
7287 msgstr ""
7288
7289 #. type: Plain text
7290 #: build/C/man5/proc.5:725
7291 msgid "The filesystem type."
7292 msgstr ""
7293
7294 #. type: Plain text
7295 #: build/C/man5/proc.5:730
7296 msgid ""
7297 "Optional statistics and configuration information.  Currently (as at Linux "
7298 "2.6.26), only NFS filesystems export information via this field."
7299 msgstr ""
7300
7301 #. type: Plain text
7302 #: build/C/man5/proc.5:733
7303 msgid "This file is readable only by the owner of the process."
7304 msgstr ""
7305
7306 #. type: TP
7307 #: build/C/man5/proc.5:733
7308 #, no-wrap
7309 msgid "I</proc/[pid]/ns/> (since Linux 3.0)"
7310 msgstr ""
7311
7312 #.  See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f
7313 #. type: Plain text
7314 #: build/C/man5/proc.5:741
7315 msgid ""
7316 "This is a subdirectory containing one entry for each namespace that supports "
7317 "being manipulated by B<setns>(2).  For information about namespaces, see "
7318 "B<clone>(2)."
7319 msgstr ""
7320
7321 #. type: TP
7322 #: build/C/man5/proc.5:741
7323 #, no-wrap
7324 msgid "I</proc/[pid]/ns/ipc> (since Linux 3.0)"
7325 msgstr ""
7326
7327 #. type: Plain text
7328 #: build/C/man5/proc.5:749
7329 msgid ""
7330 "Bind mounting this file (see B<mount>(2))  to somewhere else in the "
7331 "filesystem keeps the IPC namespace of the process specified by I<pid> alive "
7332 "even if all processes currently in the namespace terminate."
7333 msgstr ""
7334
7335 #. type: Plain text
7336 #: build/C/man5/proc.5:758
7337 msgid ""
7338 "Opening this file returns a file handle for the IPC namespace of the process "
7339 "specified by I<pid>.  As long as this file descriptor remains open, the IPC "
7340 "namespace will remain alive, even if all processes in the namespace "
7341 "terminate.  The file descriptor can be passed to B<setns>(2)."
7342 msgstr ""
7343
7344 #. type: TP
7345 #: build/C/man5/proc.5:758
7346 #, no-wrap
7347 msgid "I</proc/[pid]/ns/net> (since Linux 3.0)"
7348 msgstr ""
7349
7350 #. type: Plain text
7351 #: build/C/man5/proc.5:766
7352 msgid ""
7353 "Bind mounting this file (see B<mount>(2))  to somewhere else in the "
7354 "filesystem keeps the network namespace of the process specified by I<pid> "
7355 "alive even if all processes in the namespace terminate."
7356 msgstr ""
7357
7358 #. type: Plain text
7359 #: build/C/man5/proc.5:775
7360 msgid ""
7361 "Opening this file returns a file handle for the network namespace of the "
7362 "process specified by I<pid>.  As long as this file descriptor remains open, "
7363 "the network namespace will remain alive, even if all processes in the "
7364 "namespace terminate.  The file descriptor can be passed to B<setns>(2)."
7365 msgstr ""
7366
7367 #. type: TP
7368 #: build/C/man5/proc.5:775
7369 #, no-wrap
7370 msgid "I</proc/[pid]/ns/uts> (since Linux 3.0)"
7371 msgstr ""
7372
7373 #. type: Plain text
7374 #: build/C/man5/proc.5:783
7375 msgid ""
7376 "Bind mounting this file (see B<mount>(2))  to somewhere else in the "
7377 "filesystem keeps the UTS namespace of the process specified by I<pid> alive "
7378 "even if all processes currently in the namespace terminate."
7379 msgstr ""
7380
7381 #. type: Plain text
7382 #: build/C/man5/proc.5:792
7383 msgid ""
7384 "Opening this file returns a file handle for the UTS namespace of the process "
7385 "specified by I<pid>.  As long as this file descriptor remains open, the UTS "
7386 "namespace will remain alive, even if all processes in the namespace "
7387 "terminate.  The file descriptor can be passed to B<setns>(2)."
7388 msgstr ""
7389
7390 #. type: TP
7391 #: build/C/man5/proc.5:792
7392 #, no-wrap
7393 msgid "I</proc/[pid]/numa_maps> (since Linux 2.6.14)"
7394 msgstr ""
7395
7396 #. type: Plain text
7397 #: build/C/man5/proc.5:796
7398 msgid "See B<numa>(7)."
7399 msgstr ""
7400
7401 #. type: TP
7402 #: build/C/man5/proc.5:796
7403 #, no-wrap
7404 msgid "I</proc/[pid]/oom_adj> (since Linux 2.6.11)"
7405 msgstr ""
7406
7407 #. type: Plain text
7408 #: build/C/man5/proc.5:809
7409 msgid ""
7410 "This file can be used to adjust the score used to select which process "
7411 "should be killed in an out-of-memory (OOM) situation.  The kernel uses this "
7412 "value for a bit-shift operation of the process's I<oom_score> value: valid "
7413 "values are in the range -16 to +15, plus the special value -17, which "
7414 "disables OOM-killing altogether for this process.  A positive score "
7415 "increases the likelihood of this process being killed by the OOM-killer; a "
7416 "negative score decreases the likelihood."
7417 msgstr ""
7418
7419 #. type: Plain text
7420 #: build/C/man5/proc.5:817
7421 msgid ""
7422 "The default value for this file is 0; a new process inherits its parent's "
7423 "I<oom_adj> setting.  A process must be privileged (B<CAP_SYS_RESOURCE>)  to "
7424 "update this file."
7425 msgstr ""
7426
7427 #. type: Plain text
7428 #: build/C/man5/proc.5:820
7429 msgid ""
7430 "Since Linux 2.6.36, use of this file is deprecated in favor of "
7431 "I</proc/[pid]/oom_score_adj>."
7432 msgstr ""
7433
7434 #. type: TP
7435 #: build/C/man5/proc.5:820
7436 #, no-wrap
7437 msgid "I</proc/[pid]/oom_score> (since Linux 2.6.11)"
7438 msgstr ""
7439
7440 #.  See mm/oom_kill.c::badness() in the 2.6.25 sources
7441 #.  See mm/oom_kill.c::badness() in the 2.6.25 sources
7442 #. type: Plain text
7443 #: build/C/man5/proc.5:831
7444 msgid ""
7445 "This file displays the current score that the kernel gives to this process "
7446 "for the purpose of selecting a process for the OOM-killer.  A higher score "
7447 "means that the process is more likely to be selected by the OOM-killer.  The "
7448 "basis for this score is the amount of memory used by the process, with "
7449 "increases (+) or decreases (-) for factors including:"
7450 msgstr ""
7451
7452 #. type: Plain text
7453 #: build/C/man5/proc.5:836
7454 msgid "whether the process creates a lot of children using B<fork>(2)  (+);"
7455 msgstr ""
7456
7457 #. type: Plain text
7458 #: build/C/man5/proc.5:839
7459 msgid ""
7460 "whether the process has been running a long time, or has used a lot of CPU "
7461 "time (-);"
7462 msgstr ""
7463
7464 #. type: Plain text
7465 #: build/C/man5/proc.5:841
7466 msgid "whether the process has a low nice value (i.e., E<gt> 0) (+);"
7467 msgstr ""
7468
7469 #.  More precisely, if it has CAP_SYS_ADMIN or CAP_SYS_RESOURCE
7470 #. type: Plain text
7471 #: build/C/man5/proc.5:844
7472 msgid "whether the process is privileged (-); and"
7473 msgstr ""
7474
7475 #.  More precisely, if it has CAP_SYS_RAWIO
7476 #. type: Plain text
7477 #: build/C/man5/proc.5:847
7478 msgid "whether the process is making direct hardware access (-)."
7479 msgstr ""
7480
7481 #. type: Plain text
7482 #: build/C/man5/proc.5:856
7483 msgid ""
7484 "The I<oom_score> also reflects the adjustment specified by the "
7485 "I<oom_score_adj> or I<oom_adj> setting for the process."
7486 msgstr ""
7487
7488 #. type: TP
7489 #: build/C/man5/proc.5:856
7490 #, no-wrap
7491 msgid "I</proc/[pid]/oom_score_adj> (since Linux 2.6.36)"
7492 msgstr ""
7493
7494 #.  Text taken from 3.7 Documentation/filesystems/proc.txt
7495 #. type: Plain text
7496 #: build/C/man5/proc.5:861
7497 msgid ""
7498 "This file can be used to adjust the badness heuristic used to select which "
7499 "process gets killed in out-of-memory conditions."
7500 msgstr ""
7501
7502 #. type: Plain text
7503 #: build/C/man5/proc.5:870
7504 msgid ""
7505 "The badness heuristic assigns a value to each candidate task ranging from 0 "
7506 "(never kill) to 1000 (always kill) to determine which process is targeted.  "
7507 "The units are roughly a proportion along that range of allowed memory the "
7508 "process may allocate from, based on an estimation of its current memory and "
7509 "swap use.  For example, if a task is using all allowed memory, its badness "
7510 "score will be 1000.  If it is using half of its allowed memory, its score "
7511 "will be 500."
7512 msgstr ""
7513
7514 #. type: Plain text
7515 #: build/C/man5/proc.5:873
7516 msgid ""
7517 "There is an additional factor included in the badness score: root processes "
7518 "are given 3% extra memory over other tasks."
7519 msgstr ""
7520
7521 #. type: Plain text
7522 #: build/C/man5/proc.5:887
7523 msgid ""
7524 "The amount of \"allowed\" memory depends on the context in which the "
7525 "OOM-killer was called.  If it is due to the memory assigned to the "
7526 "allocating task's cpuset being exhausted, the allowed memory represents the "
7527 "set of mems assigned to that cpuset (see B<cpuset>(7)).  If it is due to a "
7528 "mempolicy's node(s) being exhausted, the allowed memory represents the set "
7529 "of mempolicy nodes.  If it is due to a memory limit (or swap limit) being "
7530 "reached, the allowed memory is that configured limit.  Finally, if it is due "
7531 "to the entire system being out of memory, the allowed memory represents all "
7532 "allocatable resources."
7533 msgstr ""
7534
7535 #. type: Plain text
7536 #: build/C/man5/proc.5:900
7537 msgid ""
7538 "The value of I<oom_score_adj> is added to the badness score before it is "
7539 "used to determine which task to kill.  Acceptable values range from -1000 "
7540 "(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX).  This allows user space to "
7541 "control the preference for OOM-killing, ranging from always preferring a "
7542 "certain task or completely disabling it from OOM-killing.  The lowest "
7543 "possible value, -1000, is equivalent to disabling OOM-killing entirely for "
7544 "that task, since it will always report a badness score of 0."
7545 msgstr ""
7546
7547 #. type: Plain text
7548 #: build/C/man5/proc.5:912
7549 msgid ""
7550 "Consequently, it is very simple for user space to define the amount of "
7551 "memory to consider for each task.  Setting a I<oom_score_adj> value of +500, "
7552 "for example, is roughly equivalent to allowing the remainder of tasks "
7553 "sharing the same system, cpuset, mempolicy, or memory controller resources "
7554 "to use at least 50% more memory.  A value of -500, on the other hand, would "
7555 "be roughly equivalent to discounting 50% of the task's allowed memory from "
7556 "being considered as scoring against the task."
7557 msgstr ""
7558
7559 #. type: Plain text
7560 #: build/C/man5/proc.5:919
7561 msgid ""
7562 "For backward compatibility with previous kernels, I</proc/[pid]/oom_adj> can "
7563 "still be used to tune the badness score.  Its value is scaled linearly with "
7564 "I<oom_score_adj>."
7565 msgstr ""
7566
7567 #.  FIXME Describe /proc/[pid]/pagemap
7568 #.        Added in 2.6.25
7569 #.        CONFIG_PROC_PAGE_MONITOR
7570 #. type: Plain text
7571 #: build/C/man5/proc.5:928
7572 msgid ""
7573 "Writing to I</proc/[pid]/oom_score_adj> or I</proc/[pid]/oom_adj> will "
7574 "change the other with its scaled value."
7575 msgstr ""
7576
7577 #. type: TP
7578 #: build/C/man5/proc.5:928
7579 #, no-wrap
7580 msgid "I</proc/[pid]/root>"
7581 msgstr ""
7582
7583 #. type: Plain text
7584 #: build/C/man5/proc.5:936
7585 msgid ""
7586 "UNIX and Linux support the idea of a per-process root of the filesystem, set "
7587 "by the B<chroot>(2)  system call.  This file is a symbolic link that points "
7588 "to the process's root directory, and behaves as exe, fd/*, etc. do."
7589 msgstr ""
7590
7591 #. type: TP
7592 #: build/C/man5/proc.5:956
7593 #, no-wrap
7594 msgid "I</proc/[pid]/smaps> (since Linux 2.6.14)"
7595 msgstr ""
7596
7597 #.        CONFIG_PROC_PAGE_MONITOR
7598 #. type: Plain text
7599 #: build/C/man5/proc.5:961
7600 msgid ""
7601 "This file shows memory consumption for each of the process's mappings.  For "
7602 "each of mappings there is a series of lines such as the following:"
7603 msgstr ""
7604
7605 #. type: Plain text
7606 #: build/C/man5/proc.5:971
7607 #, no-wrap
7608 msgid ""
7609 "08048000-080bc000 r-xp 00000000 03:02 13130      /bin/bash\n"
7610 "Size:               464 kB\n"
7611 "Rss:                424 kB\n"
7612 "Shared_Clean:       424 kB\n"
7613 "Shared_Dirty:         0 kB\n"
7614 "Private_Clean:        0 kB\n"
7615 "Private_Dirty:        0 kB\n"
7616 msgstr ""
7617
7618 #. type: Plain text
7619 #: build/C/man5/proc.5:981
7620 msgid ""
7621 "The first of these lines shows the same information as is displayed for the "
7622 "mapping in I</proc/[pid]/maps>.  The remaining lines show the size of the "
7623 "mapping, the amount of the mapping that is currently resident in RAM, the "
7624 "number of clean and dirty shared pages in the mapping, and the number of "
7625 "clean and dirty private pages in the mapping."
7626 msgstr ""
7627
7628 #. type: Plain text
7629 #: build/C/man5/proc.5:986
7630 msgid ""
7631 "This file is present only if the B<CONFIG_MMU> kernel configuration option "
7632 "is enabled."
7633 msgstr ""
7634
7635 #. type: TP
7636 #: build/C/man5/proc.5:986
7637 #, no-wrap
7638 msgid "I</proc/[pid]/stat>"
7639 msgstr ""
7640
7641 #. type: Plain text
7642 #: build/C/man5/proc.5:993
7643 msgid ""
7644 "Status information about the process.  This is used by B<ps>(1).  It is "
7645 "defined in I</usr/src/linux/fs/proc/array.c>."
7646 msgstr ""
7647
7648 #. type: Plain text
7649 #: build/C/man5/proc.5:997
7650 msgid "The fields, in order, with their proper B<scanf>(3)  format specifiers, are:"
7651 msgstr ""
7652
7653 #. type: TP
7654 #: build/C/man5/proc.5:998
7655 #, no-wrap
7656 msgid "I<pid> %d"
7657 msgstr ""
7658
7659 #. type: Plain text
7660 #: build/C/man5/proc.5:1001
7661 msgid "(1) The process ID."
7662 msgstr ""
7663
7664 #. type: TP
7665 #: build/C/man5/proc.5:1001
7666 #, no-wrap
7667 msgid "I<comm> %s"
7668 msgstr ""
7669
7670 #. type: Plain text
7671 #: build/C/man5/proc.5:1005
7672 msgid ""
7673 "(2) The filename of the executable, in parentheses.  This is visible whether "
7674 "or not the executable is swapped out."
7675 msgstr ""
7676
7677 #. type: TP
7678 #: build/C/man5/proc.5:1005
7679 #, no-wrap
7680 msgid "I<state> %c"
7681 msgstr ""
7682
7683 #. type: Plain text
7684 #: build/C/man5/proc.5:1011
7685 msgid ""
7686 "(3) One character from the string \"RSDZTW\" where R is running, S is "
7687 "sleeping in an interruptible wait, D is waiting in uninterruptible disk "
7688 "sleep, Z is zombie, T is traced or stopped (on a signal), and W is paging."
7689 msgstr ""
7690
7691 #. type: TP
7692 #: build/C/man5/proc.5:1011
7693 #, no-wrap
7694 msgid "I<ppid> %d"
7695 msgstr ""
7696
7697 #. type: Plain text
7698 #: build/C/man5/proc.5:1014
7699 msgid "(4) The PID of the parent."
7700 msgstr ""
7701
7702 #. type: TP
7703 #: build/C/man5/proc.5:1014
7704 #, no-wrap
7705 msgid "I<pgrp> %d"
7706 msgstr ""
7707
7708 #. type: Plain text
7709 #: build/C/man5/proc.5:1017
7710 msgid "(5) The process group ID of the process."
7711 msgstr ""
7712
7713 #. type: TP
7714 #: build/C/man5/proc.5:1017
7715 #, no-wrap
7716 msgid "I<session> %d"
7717 msgstr ""
7718
7719 #. type: Plain text
7720 #: build/C/man5/proc.5:1020
7721 msgid "(6) The session ID of the process."
7722 msgstr ""
7723
7724 #. type: TP
7725 #: build/C/man5/proc.5:1020
7726 #, no-wrap
7727 msgid "I<tty_nr> %d"
7728 msgstr ""
7729
7730 #. type: Plain text
7731 #: build/C/man5/proc.5:1026
7732 msgid ""
7733 "(7) The controlling terminal of the process.  (The minor device number is "
7734 "contained in the combination of bits 31 to 20 and 7 to 0; the major device "
7735 "number is in bits 15 to 8.)"
7736 msgstr ""
7737
7738 #. type: TP
7739 #: build/C/man5/proc.5:1026
7740 #, no-wrap
7741 msgid "I<tpgid> %d"
7742 msgstr ""
7743
7744 #.  This field and following, up to and including wchan added 0.99.1
7745 #. type: Plain text
7746 #: build/C/man5/proc.5:1031
7747 msgid ""
7748 "(8) The ID of the foreground process group of the controlling terminal of "
7749 "the process."
7750 msgstr ""
7751
7752 #. type: TP
7753 #: build/C/man5/proc.5:1031
7754 #, no-wrap
7755 msgid "I<flags> %u (%lu before Linux 2.6.22)"
7756 msgstr ""
7757
7758 #. type: Plain text
7759 #: build/C/man5/proc.5:1038
7760 msgid ""
7761 "(9) The kernel flags word of the process.  For bit meanings, see the PF_* "
7762 "defines in the Linux kernel source file I<include/linux/sched.h>.  Details "
7763 "depend on the kernel version."
7764 msgstr ""
7765
7766 #. type: TP
7767 #: build/C/man5/proc.5:1038
7768 #, no-wrap
7769 msgid "I<minflt> %lu"
7770 msgstr ""
7771
7772 #. type: Plain text
7773 #: build/C/man5/proc.5:1042
7774 msgid ""
7775 "(10) The number of minor faults the process has made which have not required "
7776 "loading a memory page from disk."
7777 msgstr ""
7778
7779 #. type: TP
7780 #: build/C/man5/proc.5:1042
7781 #, no-wrap
7782 msgid "I<cminflt> %lu"
7783 msgstr ""
7784
7785 #. type: Plain text
7786 #: build/C/man5/proc.5:1046
7787 msgid ""
7788 "(11) The number of minor faults that the process's waited-for children have "
7789 "made."
7790 msgstr ""
7791
7792 #. type: TP
7793 #: build/C/man5/proc.5:1046
7794 #, no-wrap
7795 msgid "I<majflt> %lu"
7796 msgstr ""
7797
7798 #. type: Plain text
7799 #: build/C/man5/proc.5:1050
7800 msgid ""
7801 "(12) The number of major faults the process has made which have required "
7802 "loading a memory page from disk."
7803 msgstr ""
7804
7805 #. type: TP
7806 #: build/C/man5/proc.5:1050
7807 #, no-wrap
7808 msgid "I<cmajflt> %lu"
7809 msgstr ""
7810
7811 #. type: Plain text
7812 #: build/C/man5/proc.5:1054
7813 msgid ""
7814 "(13) The number of major faults that the process's waited-for children have "
7815 "made."
7816 msgstr ""
7817
7818 #. type: TP
7819 #: build/C/man5/proc.5:1054
7820 #, no-wrap
7821 msgid "I<utime> %lu"
7822 msgstr ""
7823
7824 #. type: Plain text
7825 #: build/C/man5/proc.5:1063
7826 msgid ""
7827 "(14) Amount of time that this process has been scheduled in user mode, "
7828 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>).  This includes "
7829 "guest time, I<guest_time> (time spent running a virtual CPU, see below), so "
7830 "that applications that are not aware of the guest time field do not lose "
7831 "that time from their calculations."
7832 msgstr ""
7833
7834 #. type: TP
7835 #: build/C/man5/proc.5:1063
7836 #, no-wrap
7837 msgid "I<stime> %lu"
7838 msgstr ""
7839
7840 #. type: Plain text
7841 #: build/C/man5/proc.5:1068
7842 msgid ""
7843 "(15) Amount of time that this process has been scheduled in kernel mode, "
7844 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
7845 msgstr ""
7846
7847 #. type: TP
7848 #: build/C/man5/proc.5:1068
7849 #, no-wrap
7850 msgid "I<cutime> %ld"
7851 msgstr ""
7852
7853 #. type: Plain text
7854 #: build/C/man5/proc.5:1078
7855 msgid ""
7856 "(16) Amount of time that this process's waited-for children have been "
7857 "scheduled in user mode, measured in clock ticks (divide by "
7858 "I<sysconf(_SC_CLK_TCK)>).  (See also B<times>(2).)  This includes guest "
7859 "time, I<cguest_time> (time spent running a virtual CPU, see below)."
7860 msgstr ""
7861
7862 #. type: TP
7863 #: build/C/man5/proc.5:1078
7864 #, no-wrap
7865 msgid "I<cstime> %ld"
7866 msgstr ""
7867
7868 #. type: Plain text
7869 #: build/C/man5/proc.5:1084
7870 msgid ""
7871 "(17) Amount of time that this process's waited-for children have been "
7872 "scheduled in kernel mode, measured in clock ticks (divide by "
7873 "I<sysconf(_SC_CLK_TCK)>)."
7874 msgstr ""
7875
7876 #. type: TP
7877 #: build/C/man5/proc.5:1084
7878 #, no-wrap
7879 msgid "I<priority> %ld"
7880 msgstr ""
7881
7882 #. type: Plain text
7883 #: build/C/man5/proc.5:1101
7884 msgid ""
7885 "(18) (Explanation for Linux 2.6)  For processes running a real-time "
7886 "scheduling policy (I<policy> below; see B<sched_setscheduler>(2)), this is "
7887 "the negated scheduling priority, minus one; that is, a number in the range "
7888 "-2 to -100, corresponding to real-time priorities 1 to 99.  For processes "
7889 "running under a non-real-time scheduling policy, this is the raw nice value "
7890 "(B<setpriority>(2))  as represented in the kernel.  The kernel stores nice "
7891 "values as numbers in the range 0 (high) to 39 (low), corresponding to the "
7892 "user-visible nice range of -20 to 19."
7893 msgstr ""
7894
7895 #.  And back in kernel 1.2 days things were different again.
7896 #. type: Plain text
7897 #: build/C/man5/proc.5:1105
7898 msgid ""
7899 "Before Linux 2.6, this was a scaled value based on the scheduler weighting "
7900 "given to this process."
7901 msgstr ""
7902
7903 #. type: TP
7904 #: build/C/man5/proc.5:1105
7905 #, no-wrap
7906 msgid "I<nice> %ld"
7907 msgstr ""
7908
7909 #.  Back in kernel 1.2 days things were different.
7910 #.  .TP
7911 #.  \fIcounter\fP %ld
7912 #.  The current maximum size in jiffies of the process's next timeslice,
7913 #.  or what is currently left of its current timeslice, if it is the
7914 #.  currently running process.
7915 #.  .TP
7916 #.  \fItimeout\fP %u
7917 #.  The time in jiffies of the process's next timeout.
7918 #.  timeout was removed sometime around 2.1/2.2
7919 #. type: Plain text
7920 #: build/C/man5/proc.5:1120
7921 msgid ""
7922 "(19) The nice value (see B<setpriority>(2)), a value in the range 19 (low "
7923 "priority) to -20 (high priority)."
7924 msgstr ""
7925
7926 #. type: TP
7927 #: build/C/man5/proc.5:1120
7928 #, no-wrap
7929 msgid "I<num_threads> %ld"
7930 msgstr ""
7931
7932 #. type: Plain text
7933 #: build/C/man5/proc.5:1125
7934 msgid ""
7935 "(20) Number of threads in this process (since Linux 2.6).  Before kernel "
7936 "2.6, this field was hard coded to 0 as a placeholder for an earlier removed "
7937 "field."
7938 msgstr ""
7939
7940 #. type: TP
7941 #: build/C/man5/proc.5:1125
7942 #, no-wrap
7943 msgid "I<itrealvalue> %ld"
7944 msgstr ""
7945
7946 #. type: Plain text
7947 #: build/C/man5/proc.5:1132
7948 msgid ""
7949 "(21) The time in jiffies before the next B<SIGALRM> is sent to the process "
7950 "due to an interval timer.  Since kernel 2.6.17, this field is no longer "
7951 "maintained, and is hard coded as 0."
7952 msgstr ""
7953
7954 #. type: TP
7955 #: build/C/man5/proc.5:1132
7956 #, no-wrap
7957 msgid "I<starttime> %llu (was %lu before Linux 2.6)"
7958 msgstr ""
7959
7960 #. type: Plain text
7961 #: build/C/man5/proc.5:1138
7962 msgid ""
7963 "(22) The time the process started after system boot.  In kernels before "
7964 "Linux 2.6, this value was expressed in jiffies.  Since Linux 2.6, the value "
7965 "is expressed in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
7966 msgstr ""
7967
7968 #. type: TP
7969 #: build/C/man5/proc.5:1138
7970 #, no-wrap
7971 msgid "I<vsize> %lu"
7972 msgstr ""
7973
7974 #. type: Plain text
7975 #: build/C/man5/proc.5:1141
7976 msgid "(23) Virtual memory size in bytes."
7977 msgstr ""
7978
7979 #. type: TP
7980 #: build/C/man5/proc.5:1141
7981 #, no-wrap
7982 msgid "I<rss> %ld"
7983 msgstr ""
7984
7985 #. type: Plain text
7986 #: build/C/man5/proc.5:1148
7987 msgid ""
7988 "(24) Resident Set Size: number of pages the process has in real memory.  "
7989 "This is just the pages which count toward text, data, or stack space.  This "
7990 "does not include pages which have not been demand-loaded in, or which are "
7991 "swapped out."
7992 msgstr ""
7993
7994 #. type: TP
7995 #: build/C/man5/proc.5:1148
7996 #, no-wrap
7997 msgid "I<rsslim> %lu"
7998 msgstr ""
7999
8000 #. type: Plain text
8001 #: build/C/man5/proc.5:1155
8002 msgid ""
8003 "(25) Current soft limit in bytes on the rss of the process; see the "
8004 "description of B<RLIMIT_RSS> in B<getrlimit>(2)."
8005 msgstr ""
8006
8007 #. type: TP
8008 #: build/C/man5/proc.5:1155
8009 #, no-wrap
8010 msgid "I<startcode> %lu"
8011 msgstr ""
8012
8013 #. type: Plain text
8014 #: build/C/man5/proc.5:1158
8015 msgid "(26) The address above which program text can run."
8016 msgstr ""
8017
8018 #. type: TP
8019 #: build/C/man5/proc.5:1158
8020 #, no-wrap
8021 msgid "I<endcode> %lu"
8022 msgstr ""
8023
8024 #. type: Plain text
8025 #: build/C/man5/proc.5:1161
8026 msgid "(27) The address below which program text can run."
8027 msgstr ""
8028
8029 #. type: TP
8030 #: build/C/man5/proc.5:1161
8031 #, no-wrap
8032 msgid "I<startstack> %lu"
8033 msgstr ""
8034
8035 #. type: Plain text
8036 #: build/C/man5/proc.5:1164
8037 msgid "(28) The address of the start (i.e., bottom) of the stack."
8038 msgstr ""
8039
8040 #. type: TP
8041 #: build/C/man5/proc.5:1164
8042 #, no-wrap
8043 msgid "I<kstkesp> %lu"
8044 msgstr ""
8045
8046 #. type: Plain text
8047 #: build/C/man5/proc.5:1168
8048 msgid ""
8049 "(29) The current value of ESP (stack pointer), as found in the kernel stack "
8050 "page for the process."
8051 msgstr ""
8052
8053 #. type: TP
8054 #: build/C/man5/proc.5:1168
8055 #, no-wrap
8056 msgid "I<kstkeip> %lu"
8057 msgstr ""
8058
8059 #. type: Plain text
8060 #: build/C/man5/proc.5:1171
8061 msgid "(30) The current EIP (instruction pointer)."
8062 msgstr ""
8063
8064 #. type: TP
8065 #: build/C/man5/proc.5:1171
8066 #, no-wrap
8067 msgid "I<signal> %lu"
8068 msgstr ""
8069
8070 #. type: Plain text
8071 #: build/C/man5/proc.5:1177
8072 msgid ""
8073 "(31) The bitmap of pending signals, displayed as a decimal number.  "
8074 "Obsolete, because it does not provide information on real-time signals; use "
8075 "I</proc/[pid]/status> instead."
8076 msgstr ""
8077
8078 #. type: TP
8079 #: build/C/man5/proc.5:1177
8080 #, no-wrap
8081 msgid "I<blocked> %lu"
8082 msgstr ""
8083
8084 #. type: Plain text
8085 #: build/C/man5/proc.5:1183
8086 msgid ""
8087 "(32) The bitmap of blocked signals, displayed as a decimal number.  "
8088 "Obsolete, because it does not provide information on real-time signals; use "
8089 "I</proc/[pid]/status> instead."
8090 msgstr ""
8091
8092 #. type: TP
8093 #: build/C/man5/proc.5:1183
8094 #, no-wrap
8095 msgid "I<sigignore> %lu"
8096 msgstr ""
8097
8098 #. type: Plain text
8099 #: build/C/man5/proc.5:1189
8100 msgid ""
8101 "(33) The bitmap of ignored signals, displayed as a decimal number.  "
8102 "Obsolete, because it does not provide information on real-time signals; use "
8103 "I</proc/[pid]/status> instead."
8104 msgstr ""
8105
8106 #. type: TP
8107 #: build/C/man5/proc.5:1189
8108 #, no-wrap
8109 msgid "I<sigcatch> %lu"
8110 msgstr ""
8111
8112 #. type: Plain text
8113 #: build/C/man5/proc.5:1195
8114 msgid ""
8115 "(34) The bitmap of caught signals, displayed as a decimal number.  Obsolete, "
8116 "because it does not provide information on real-time signals; use "
8117 "I</proc/[pid]/status> instead."
8118 msgstr ""
8119
8120 #. type: TP
8121 #: build/C/man5/proc.5:1195
8122 #, no-wrap
8123 msgid "I<wchan> %lu"
8124 msgstr ""
8125
8126 #. type: Plain text
8127 #: build/C/man5/proc.5:1205
8128 msgid ""
8129 "(35) This is the \"channel\" in which the process is waiting.  It is the "
8130 "address of a system call, and can be looked up in a namelist if you need a "
8131 "textual name.  (If you have an up-to-date I</etc/psdatabase>, then try I<ps "
8132 "-l> to see the WCHAN field in action.)"
8133 msgstr ""
8134
8135 #. type: TP
8136 #: build/C/man5/proc.5:1205
8137 #, no-wrap
8138 msgid "I<nswap> %lu"
8139 msgstr ""
8140
8141 #.  nswap was added in 2.0
8142 #. type: Plain text
8143 #: build/C/man5/proc.5:1210
8144 msgid "(36)  Number of pages swapped (not maintained)."
8145 msgstr ""
8146
8147 #. type: TP
8148 #: build/C/man5/proc.5:1210
8149 #, no-wrap
8150 msgid "I<cnswap> %lu"
8151 msgstr ""
8152
8153 #.  cnswap was added in 2.0
8154 #. type: Plain text
8155 #: build/C/man5/proc.5:1215
8156 msgid "(37)  Cumulative I<nswap> for child processes (not maintained)."
8157 msgstr ""
8158
8159 #. type: TP
8160 #: build/C/man5/proc.5:1215
8161 #, no-wrap
8162 msgid "I<exit_signal> %d (since Linux 2.1.22)"
8163 msgstr ""
8164
8165 #. type: Plain text
8166 #: build/C/man5/proc.5:1218
8167 msgid "(38) Signal to be sent to parent when we die."
8168 msgstr ""
8169
8170 #. type: TP
8171 #: build/C/man5/proc.5:1218
8172 #, no-wrap
8173 msgid "I<processor> %d (since Linux 2.2.8)"
8174 msgstr ""
8175
8176 #. type: Plain text
8177 #: build/C/man5/proc.5:1221
8178 msgid "(39) CPU number last executed on."
8179 msgstr ""
8180
8181 #. type: TP
8182 #: build/C/man5/proc.5:1221
8183 #, no-wrap
8184 msgid "I<rt_priority> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
8185 msgstr ""
8186
8187 #. type: Plain text
8188 #: build/C/man5/proc.5:1227
8189 msgid ""
8190 "(40) Real-time scheduling priority, a number in the range 1 to 99 for "
8191 "processes scheduled under a real-time policy, or 0, for non-real-time "
8192 "processes (see B<sched_setscheduler>(2))."
8193 msgstr ""
8194
8195 #. type: TP
8196 #: build/C/man5/proc.5:1227
8197 #, no-wrap
8198 msgid "I<policy> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
8199 msgstr ""
8200
8201 #. type: Plain text
8202 #: build/C/man5/proc.5:1233
8203 msgid ""
8204 "(41) Scheduling policy (see B<sched_setscheduler>(2)).  Decode using the "
8205 "SCHED_* constants in I<linux/sched.h>."
8206 msgstr ""
8207
8208 #. type: TP
8209 #: build/C/man5/proc.5:1233
8210 #, no-wrap
8211 msgid "I<delayacct_blkio_ticks> %llu (since Linux 2.6.18)"
8212 msgstr ""
8213
8214 #. type: Plain text
8215 #: build/C/man5/proc.5:1236
8216 msgid "(42) Aggregated block I/O delays, measured in clock ticks (centiseconds)."
8217 msgstr ""
8218
8219 #. type: TP
8220 #: build/C/man5/proc.5:1236
8221 #, no-wrap
8222 msgid "I<guest_time> %lu (since Linux 2.6.24)"
8223 msgstr ""
8224
8225 #. type: Plain text
8226 #: build/C/man5/proc.5:1241
8227 msgid ""
8228 "(43) Guest time of the process (time spent running a virtual CPU for a guest "
8229 "operating system), measured in clock ticks (divide by "
8230 "I<sysconf(_SC_CLK_TCK)>)."
8231 msgstr ""
8232
8233 #. type: TP
8234 #: build/C/man5/proc.5:1241
8235 #, no-wrap
8236 msgid "I<cguest_time> %ld (since Linux 2.6.24)"
8237 msgstr ""
8238
8239 #. type: Plain text
8240 #: build/C/man5/proc.5:1245
8241 msgid ""
8242 "(44) Guest time of the process's children, measured in clock ticks (divide "
8243 "by I<sysconf(_SC_CLK_TCK)>)."
8244 msgstr ""
8245
8246 #. type: TP
8247 #: build/C/man5/proc.5:1246
8248 #, no-wrap
8249 msgid "I</proc/[pid]/statm>"
8250 msgstr ""
8251
8252 #. type: Plain text
8253 #: build/C/man5/proc.5:1250
8254 msgid ""
8255 "Provides information about memory usage, measured in pages.  The columns "
8256 "are:"
8257 msgstr ""
8258
8259 #.  (not including libs; broken, includes data segment)
8260 #.  (including libs; broken, includes library text)
8261 #. type: Plain text
8262 #: build/C/man5/proc.5:1264
8263 #, no-wrap
8264 msgid ""
8265 "size       (1) total program size\n"
8266 "           (same as VmSize in I</proc/[pid]/status>)\n"
8267 "resident   (2) resident set size\n"
8268 "           (same as VmRSS in I</proc/[pid]/status>)\n"
8269 "share      (3) shared pages (i.e., backed by a file)\n"
8270 "text       (4) text (code)\n"
8271 "lib        (5) library (unused in Linux 2.6)\n"
8272 "data       (6) data + stack\n"
8273 "dt         (7) dirty pages (unused in Linux 2.6)\n"
8274 msgstr ""
8275
8276 #. type: TP
8277 #: build/C/man5/proc.5:1266
8278 #, no-wrap
8279 msgid "I</proc/[pid]/status>"
8280 msgstr ""
8281
8282 #. type: Plain text
8283 #: build/C/man5/proc.5:1274
8284 msgid ""
8285 "Provides much of the information in I</proc/[pid]/stat> and "
8286 "I</proc/[pid]/statm> in a format that's easier for humans to parse.  Here's "
8287 "an example:"
8288 msgstr ""
8289
8290 #. type: Plain text
8291 #: build/C/man5/proc.5:1315
8292 #, no-wrap
8293 msgid ""
8294 "$B< cat /proc/$$/status>\n"
8295 "Name:   bash\n"
8296 "State:  S (sleeping)\n"
8297 "Tgid:   3515\n"
8298 "Pid:    3515\n"
8299 "PPid:   3452\n"
8300 "TracerPid:      0\n"
8301 "Uid:    1000    1000    1000    1000\n"
8302 "Gid:    100     100     100     100\n"
8303 "FDSize: 256\n"
8304 "Groups: 16 33 100\n"
8305 "VmPeak:     9136 kB\n"
8306 "VmSize:     7896 kB\n"
8307 "VmLck:         0 kB\n"
8308 "VmHWM:      7572 kB\n"
8309 "VmRSS:      6316 kB\n"
8310 "VmData:     5224 kB\n"
8311 "VmStk:        88 kB\n"
8312 "VmExe:       572 kB\n"
8313 "VmLib:      1708 kB\n"
8314 "VmPTE:        20 kB\n"
8315 "Threads:        1\n"
8316 "SigQ:   0/3067\n"
8317 "SigPnd: 0000000000000000\n"
8318 "ShdPnd: 0000000000000000\n"
8319 "SigBlk: 0000000000010000\n"
8320 "SigIgn: 0000000000384004\n"
8321 "SigCgt: 000000004b813efb\n"
8322 "CapInh: 0000000000000000\n"
8323 "CapPrm: 0000000000000000\n"
8324 "CapEff: 0000000000000000\n"
8325 "CapBnd: ffffffffffffffff\n"
8326 "Cpus_allowed:   00000001\n"
8327 "Cpus_allowed_list:      0\n"
8328 "Mems_allowed:   1\n"
8329 "Mems_allowed_list:      0\n"
8330 "voluntary_ctxt_switches:        150\n"
8331 "nonvoluntary_ctxt_switches:     545\n"
8332 msgstr ""
8333
8334 #. type: Plain text
8335 #: build/C/man5/proc.5:1323
8336 msgid "I<Name>: Command run by this process."
8337 msgstr ""
8338
8339 #. type: Plain text
8340 #: build/C/man5/proc.5:1335
8341 msgid ""
8342 "I<State>: Current state of the process.  One of \"R (running)\", \"S "
8343 "(sleeping)\", \"D (disk sleep)\", \"T (stopped)\", \"T (tracing stop)\", \"Z "
8344 "(zombie)\", or \"X (dead)\"."
8345 msgstr ""
8346
8347 #. type: Plain text
8348 #: build/C/man5/proc.5:1338
8349 msgid "I<Tgid>: Thread group ID (i.e., Process ID)."
8350 msgstr ""
8351
8352 #. type: Plain text
8353 #: build/C/man5/proc.5:1342
8354 msgid "I<Pid>: Thread ID (see B<gettid>(2))."
8355 msgstr ""
8356
8357 #. type: Plain text
8358 #: build/C/man5/proc.5:1345
8359 msgid "I<PPid>: PID of parent process."
8360 msgstr ""
8361
8362 #. type: Plain text
8363 #: build/C/man5/proc.5:1348
8364 msgid "I<TracerPid>: PID of process tracing this process (0 if not being traced)."
8365 msgstr ""
8366
8367 #. type: Plain text
8368 #: build/C/man5/proc.5:1351
8369 msgid "I<Uid>, I<Gid>: Real, effective, saved set, and filesystem UIDs (GIDs)."
8370 msgstr ""
8371
8372 #. type: Plain text
8373 #: build/C/man5/proc.5:1354
8374 msgid "I<FDSize>: Number of file descriptor slots currently allocated."
8375 msgstr ""
8376
8377 #. type: Plain text
8378 #: build/C/man5/proc.5:1357
8379 msgid "I<Groups>: Supplementary group list."
8380 msgstr ""
8381
8382 #. type: Plain text
8383 #: build/C/man5/proc.5:1360
8384 msgid "I<VmPeak>: Peak virtual memory size."
8385 msgstr ""
8386
8387 #. type: Plain text
8388 #: build/C/man5/proc.5:1363
8389 msgid "I<VmSize>: Virtual memory size."
8390 msgstr ""
8391
8392 #. type: Plain text
8393 #: build/C/man5/proc.5:1367
8394 msgid "I<VmLck>: Locked memory size (see B<mlock>(3))."
8395 msgstr ""
8396
8397 #. type: Plain text
8398 #: build/C/man5/proc.5:1370
8399 msgid "I<VmHWM>: Peak resident set size (\"high water mark\")."
8400 msgstr ""
8401
8402 #. type: Plain text
8403 #: build/C/man5/proc.5:1373
8404 msgid "I<VmRSS>: Resident set size."
8405 msgstr ""
8406
8407 #. type: Plain text
8408 #: build/C/man5/proc.5:1376
8409 msgid "I<VmData>, I<VmStk>, I<VmExe>: Size of data, stack, and text segments."
8410 msgstr ""
8411
8412 #. type: Plain text
8413 #: build/C/man5/proc.5:1379
8414 msgid "I<VmLib>: Shared library code size."
8415 msgstr ""
8416
8417 #. type: Plain text
8418 #: build/C/man5/proc.5:1382
8419 msgid "I<VmPTE>: Page table entries size (since Linux 2.6.10)."
8420 msgstr ""
8421
8422 #. type: Plain text
8423 #: build/C/man5/proc.5:1385
8424 msgid "I<Threads>: Number of threads in process containing this thread."
8425 msgstr ""
8426
8427 #. type: Plain text
8428 #: build/C/man5/proc.5:1396
8429 msgid ""
8430 "I<SigQ>: This field contains two slash-separated numbers that relate to "
8431 "queued signals for the real user ID of this process.  The first of these is "
8432 "the number of currently queued signals for this real user ID, and the second "
8433 "is the resource limit on the number of queued signals for this process (see "
8434 "the description of B<RLIMIT_SIGPENDING> in B<getrlimit>(2))."
8435 msgstr ""
8436
8437 #. type: Plain text
8438 #: build/C/man5/proc.5:1402
8439 msgid ""
8440 "I<SigPnd>, I<ShdPnd>: Number of signals pending for thread and for process "
8441 "as a whole (see B<pthreads>(7)  and B<signal>(7))."
8442 msgstr ""
8443
8444 #. type: Plain text
8445 #: build/C/man5/proc.5:1406
8446 msgid ""
8447 "I<SigBlk>, I<SigIgn>, I<SigCgt>: Masks indicating signals being blocked, "
8448 "ignored, and caught (see B<signal>(7))."
8449 msgstr ""
8450
8451 #. type: Plain text
8452 #: build/C/man5/proc.5:1411
8453 msgid ""
8454 "I<CapInh>, I<CapPrm>, I<CapEff>: Masks of capabilities enabled in "
8455 "inheritable, permitted, and effective sets (see B<capabilities>(7))."
8456 msgstr ""
8457
8458 #. type: Plain text
8459 #: build/C/man5/proc.5:1416
8460 msgid ""
8461 "I<CapBnd>: Capability Bounding set (since kernel 2.6.26, see "
8462 "B<capabilities>(7))."
8463 msgstr ""
8464
8465 #. type: Plain text
8466 #: build/C/man5/proc.5:1421
8467 msgid ""
8468 "I<Cpus_allowed>: Mask of CPUs on which this process may run (since Linux "
8469 "2.6.24, see B<cpuset>(7))."
8470 msgstr ""
8471
8472 #. type: Plain text
8473 #: build/C/man5/proc.5:1426
8474 msgid ""
8475 "I<Cpus_allowed_list>: Same as previous, but in \"list format\" (since Linux "
8476 "2.6.26, see B<cpuset>(7))."
8477 msgstr ""
8478
8479 #. type: Plain text
8480 #: build/C/man5/proc.5:1431
8481 msgid ""
8482 "I<Mems_allowed>: Mask of memory nodes allowed to this process (since Linux "
8483 "2.6.24, see B<cpuset>(7))."
8484 msgstr ""
8485
8486 #. type: Plain text
8487 #: build/C/man5/proc.5:1436
8488 msgid ""
8489 "I<Mems_allowed_list>: Same as previous, but in \"list format\" (since Linux "
8490 "2.6.26, see B<cpuset>(7))."
8491 msgstr ""
8492
8493 #. type: Plain text
8494 #: build/C/man5/proc.5:1439
8495 msgid ""
8496 "I<voluntary_context_switches>, I<nonvoluntary_context_switches>: Number of "
8497 "voluntary and involuntary context switches (since Linux 2.6.23)."
8498 msgstr ""
8499
8500 #. type: TP
8501 #: build/C/man5/proc.5:1440
8502 #, no-wrap
8503 msgid "I</proc/[pid]/task> (since Linux 2.6.0-test6)"
8504 msgstr ""
8505
8506 #. type: Plain text
8507 #: build/C/man5/proc.5:1471
8508 msgid ""
8509 "This is a directory that contains one subdirectory for each thread in the "
8510 "process.  The name of each subdirectory is the numerical thread ID "
8511 "(I<[tid]>)  of the thread (see B<gettid>(2)).  Within each of these "
8512 "subdirectories, there is a set of files with the same names and contents as "
8513 "under the I</proc/[pid]> directories.  For attributes that are shared by all "
8514 "threads, the contents for each of the files under the I<task/[tid]> "
8515 "subdirectories will be the same as in the corresponding file in the parent "
8516 "I</proc/[pid]> directory (e.g., in a multithreaded process, all of the "
8517 "I<task/[tid]/cwd> files will have the same value as the I</proc/[pid]/cwd> "
8518 "file in the parent directory, since all of the threads in a process share a "
8519 "working directory).  For attributes that are distinct for each thread, the "
8520 "corresponding files under I<task/[tid]> may have different values (e.g., "
8521 "various fields in each of the I<task/[tid]/status> files may be different "
8522 "for each thread)."
8523 msgstr ""
8524
8525 #.  The following was still true as at kernel 2.6.13
8526 #. type: Plain text
8527 #: build/C/man5/proc.5:1478
8528 msgid ""
8529 "In a multithreaded process, the contents of the I</proc/[pid]/task> "
8530 "directory are not available if the main thread has already terminated "
8531 "(typically by calling B<pthread_exit>(3))."
8532 msgstr ""
8533
8534 #. type: TP
8535 #: build/C/man5/proc.5:1478
8536 #, no-wrap
8537 msgid "I</proc/apm>"
8538 msgstr ""
8539
8540 #. type: Plain text
8541 #: build/C/man5/proc.5:1483
8542 msgid ""
8543 "Advanced power management version and battery information when B<CONFIG_APM> "
8544 "is defined at kernel compilation time."
8545 msgstr ""
8546
8547 #. type: TP
8548 #: build/C/man5/proc.5:1483
8549 #, no-wrap
8550 msgid "I</proc/bus>"
8551 msgstr ""
8552
8553 #. type: Plain text
8554 #: build/C/man5/proc.5:1486
8555 msgid "Contains subdirectories for installed busses."
8556 msgstr ""
8557
8558 #. type: TP
8559 #: build/C/man5/proc.5:1486
8560 #, no-wrap
8561 msgid "I</proc/bus/pccard>"
8562 msgstr ""
8563
8564 #. type: Plain text
8565 #: build/C/man5/proc.5:1491
8566 msgid ""
8567 "Subdirectory for PCMCIA devices when B<CONFIG_PCMCIA> is set at kernel "
8568 "compilation time."
8569 msgstr ""
8570
8571 #. type: TP
8572 #: build/C/man5/proc.5:1491
8573 #, no-wrap
8574 msgid "I</proc/bus/pccard/drivers>"
8575 msgstr ""
8576
8577 #. type: TP
8578 #: build/C/man5/proc.5:1493
8579 #, no-wrap
8580 msgid "I</proc/bus/pci>"
8581 msgstr ""
8582
8583 #. type: Plain text
8584 #: build/C/man5/proc.5:1499
8585 msgid ""
8586 "Contains various bus subdirectories and pseudo-files containing information "
8587 "about PCI busses, installed devices, and device drivers.  Some of these "
8588 "files are not ASCII."
8589 msgstr ""
8590
8591 #. type: TP
8592 #: build/C/man5/proc.5:1499
8593 #, no-wrap
8594 msgid "I</proc/bus/pci/devices>"
8595 msgstr ""
8596
8597 #. type: Plain text
8598 #: build/C/man5/proc.5:1506
8599 msgid ""
8600 "Information about PCI devices.  They may be accessed through B<lspci>(8)  "
8601 "and B<setpci>(8)."
8602 msgstr ""
8603
8604 #. type: TP
8605 #: build/C/man5/proc.5:1506
8606 #, no-wrap
8607 msgid "I</proc/cmdline>"
8608 msgstr ""
8609
8610 #. type: Plain text
8611 #: build/C/man5/proc.5:1513
8612 msgid ""
8613 "Arguments passed to the Linux kernel at boot time.  Often done via a boot "
8614 "manager such as B<lilo>(8)  or B<grub>(8)."
8615 msgstr ""
8616
8617 #. type: TP
8618 #: build/C/man5/proc.5:1513
8619 #, no-wrap
8620 msgid "I</proc/config.gz> (since Linux 2.6)"
8621 msgstr ""
8622
8623 #. type: Plain text
8624 #: build/C/man5/proc.5:1531
8625 msgid ""
8626 "This file exposes the configuration options that were used to build the "
8627 "currently running kernel, in the same format as they would be shown in the "
8628 "I<.config> file that resulted when configuring the kernel (using I<make "
8629 "xconfig>, I<make config>, or similar).  The file contents are compressed; "
8630 "view or search them using B<zcat>(1), B<zgrep>(1), etc.  As long as no "
8631 "changes have been made to the following file, the contents of "
8632 "I</proc/config.gz> are the same as those provided by :"
8633 msgstr ""
8634
8635 #. type: Plain text
8636 #: build/C/man5/proc.5:1535
8637 #, no-wrap
8638 msgid "cat /lib/modules/$(uname -r)/build/.config\n"
8639 msgstr ""
8640
8641 #. type: Plain text
8642 #: build/C/man5/proc.5:1541
8643 msgid ""
8644 "I</proc/config.gz> is provided only if the kernel is configured with "
8645 "B<CONFIG_IKCONFIG_PROC>."
8646 msgstr ""
8647
8648 #. type: TP
8649 #: build/C/man5/proc.5:1541
8650 #, no-wrap
8651 msgid "I</proc/cpuinfo>"
8652 msgstr ""
8653
8654 #. type: Plain text
8655 #: build/C/man5/proc.5:1553
8656 msgid ""
8657 "This is a collection of CPU and system architecture dependent items, for "
8658 "each supported architecture a different list.  Two common entries are "
8659 "I<processor> which gives CPU number and I<bogomips>; a system constant that "
8660 "is calculated during kernel initialization.  SMP machines have information "
8661 "for each CPU.  The B<lscpu>(1)  command gathers its information from this "
8662 "file."
8663 msgstr ""
8664
8665 #. type: TP
8666 #: build/C/man5/proc.5:1553
8667 #, no-wrap
8668 msgid "I</proc/devices>"
8669 msgstr ""
8670
8671 #. type: Plain text
8672 #: build/C/man5/proc.5:1557
8673 msgid ""
8674 "Text listing of major numbers and device groups.  This can be used by "
8675 "MAKEDEV scripts for consistency with the kernel."
8676 msgstr ""
8677
8678 #. type: TP
8679 #: build/C/man5/proc.5:1557
8680 #, no-wrap
8681 msgid "I</proc/diskstats> (since Linux 2.5.69)"
8682 msgstr ""
8683
8684 #. type: Plain text
8685 #: build/C/man5/proc.5:1563
8686 msgid ""
8687 "This file contains disk I/O statistics for each disk device.  See the Linux "
8688 "kernel source file I<Documentation/iostats.txt> for further information."
8689 msgstr ""
8690
8691 #. type: TP
8692 #: build/C/man5/proc.5:1563
8693 #, no-wrap
8694 msgid "I</proc/dma>"
8695 msgstr ""
8696
8697 #. type: Plain text
8698 #: build/C/man5/proc.5:1567
8699 msgid ""
8700 "This is a list of the registered I<ISA> DMA (direct memory access)  channels "
8701 "in use."
8702 msgstr ""
8703
8704 #. type: TP
8705 #: build/C/man5/proc.5:1567
8706 #, no-wrap
8707 msgid "I</proc/driver>"
8708 msgstr ""
8709
8710 #. type: Plain text
8711 #: build/C/man5/proc.5:1570 build/C/man5/proc.5:1598
8712 msgid "Empty subdirectory."
8713 msgstr ""
8714
8715 #. type: TP
8716 #: build/C/man5/proc.5:1570
8717 #, no-wrap
8718 msgid "I</proc/execdomains>"
8719 msgstr ""
8720
8721 #. type: Plain text
8722 #: build/C/man5/proc.5:1573
8723 msgid "List of the execution domains (ABI personalities)."
8724 msgstr ""
8725
8726 #. type: TP
8727 #: build/C/man5/proc.5:1573
8728 #, no-wrap
8729 msgid "I</proc/fb>"
8730 msgstr ""
8731
8732 #. type: Plain text
8733 #: build/C/man5/proc.5:1578
8734 msgid ""
8735 "Frame buffer information when B<CONFIG_FB> is defined during kernel "
8736 "compilation."
8737 msgstr ""
8738
8739 #. type: TP
8740 #: build/C/man5/proc.5:1578
8741 #, no-wrap
8742 msgid "I</proc/filesystems>"
8743 msgstr ""
8744
8745 #. type: Plain text
8746 #: build/C/man5/proc.5:1588
8747 msgid ""
8748 "A text listing of the filesystems which are supported by the kernel, namely "
8749 "filesystems which were compiled into the kernel or whose kernel modules are "
8750 "currently loaded.  (See also B<filesystems>(5).)  If a filesystem is marked "
8751 "with \"nodev\", this means that it does not require a block device to be "
8752 "mounted (e.g., virtual filesystem, network filesystem)."
8753 msgstr ""
8754
8755 #. type: Plain text
8756 #: build/C/man5/proc.5:1595
8757 msgid ""
8758 "Incidentally, this file may be used by B<mount>(8)  when no filesystem is "
8759 "specified and it didn't manage to determine the filesystem type.  Then "
8760 "filesystems contained in this file are tried (excepted those that are marked "
8761 "with \"nodev\")."
8762 msgstr ""
8763
8764 #. type: TP
8765 #: build/C/man5/proc.5:1595
8766 #, no-wrap
8767 msgid "I</proc/fs>"
8768 msgstr ""
8769
8770 #. type: TP
8771 #: build/C/man5/proc.5:1598
8772 #, no-wrap
8773 msgid "I</proc/ide>"
8774 msgstr ""
8775
8776 #. type: Plain text
8777 #: build/C/man5/proc.5:1604
8778 msgid ""
8779 "This directory exists on systems with the IDE bus.  There are directories "
8780 "for each IDE channel and attached device.  Files include:"
8781 msgstr ""
8782
8783 #. type: Plain text
8784 #: build/C/man5/proc.5:1617
8785 #, no-wrap
8786 msgid ""
8787 "cache              buffer size in KB\n"
8788 "capacity           number of sectors\n"
8789 "driver             driver version\n"
8790 "geometry           physical and logical geometry\n"
8791 "identify           in hexadecimal\n"
8792 "media              media type\n"
8793 "model              manufacturer's model number\n"
8794 "settings           drive settings\n"
8795 "smart_thresholds   in hexadecimal\n"
8796 "smart_values       in hexadecimal\n"
8797 msgstr ""
8798
8799 #. type: Plain text
8800 #: build/C/man5/proc.5:1623
8801 msgid ""
8802 "The B<hdparm>(8)  utility provides access to this information in a friendly "
8803 "format."
8804 msgstr ""
8805
8806 #. type: TP
8807 #: build/C/man5/proc.5:1623
8808 #, no-wrap
8809 msgid "I</proc/interrupts>"
8810 msgstr ""
8811
8812 #. type: Plain text
8813 #: build/C/man5/proc.5:1633
8814 msgid ""
8815 "This is used to record the number of interrupts per CPU per IO device.  "
8816 "Since Linux 2.6.24, for the i386 and x86_64 architectures, at least, this "
8817 "also includes interrupts internal to the system (that is, not associated "
8818 "with a device as such), such as NMI (nonmaskable interrupt), LOC (local "
8819 "timer interrupt), and for SMP systems, TLB (TLB flush interrupt), RES "
8820 "(rescheduling interrupt), CAL (remote function call interrupt), and possibly "
8821 "others.  Very easy to read formatting, done in ASCII."
8822 msgstr ""
8823
8824 #. type: TP
8825 #: build/C/man5/proc.5:1633
8826 #, no-wrap
8827 msgid "I</proc/iomem>"
8828 msgstr ""
8829
8830 #. type: Plain text
8831 #: build/C/man5/proc.5:1636
8832 msgid "I/O memory map in Linux 2.4."
8833 msgstr ""
8834
8835 #. type: TP
8836 #: build/C/man5/proc.5:1636
8837 #, no-wrap
8838 msgid "I</proc/ioports>"
8839 msgstr ""
8840
8841 #. type: Plain text
8842 #: build/C/man5/proc.5:1640
8843 msgid ""
8844 "This is a list of currently registered Input-Output port regions that are in "
8845 "use."
8846 msgstr ""
8847
8848 #. type: TP
8849 #: build/C/man5/proc.5:1640
8850 #, no-wrap
8851 msgid "I</proc/kallsyms> (since Linux 2.5.71)"
8852 msgstr ""
8853
8854 #. type: Plain text
8855 #: build/C/man5/proc.5:1648
8856 msgid ""
8857 "This holds the kernel exported symbol definitions used by the B<modules>(X)  "
8858 "tools to dynamically link and bind loadable modules.  In Linux 2.5.47 and "
8859 "earlier, a similar file with slightly different syntax was named I<ksyms>."
8860 msgstr ""
8861
8862 #. type: TP
8863 #: build/C/man5/proc.5:1648
8864 #, no-wrap
8865 msgid "I</proc/kcore>"
8866 msgstr ""
8867
8868 #. type: Plain text
8869 #: build/C/man5/proc.5:1657
8870 msgid ""
8871 "This file represents the physical memory of the system and is stored in the "
8872 "ELF core file format.  With this pseudo-file, and an unstripped kernel "
8873 "(I</usr/src/linux/vmlinux>)  binary, GDB can be used to examine the current "
8874 "state of any kernel data structures."
8875 msgstr ""
8876
8877 #. type: Plain text
8878 #: build/C/man5/proc.5:1660
8879 msgid "The total length of the file is the size of physical memory (RAM) plus 4KB."
8880 msgstr ""
8881
8882 #. type: TP
8883 #: build/C/man5/proc.5:1660
8884 #, no-wrap
8885 msgid "I</proc/kmsg>"
8886 msgstr ""
8887
8888 #. type: Plain text
8889 #: build/C/man5/proc.5:1672
8890 msgid ""
8891 "This file can be used instead of the B<syslog>(2)  system call to read "
8892 "kernel messages.  A process must have superuser privileges to read this "
8893 "file, and only one process should read this file.  This file should not be "
8894 "read if a syslog process is running which uses the B<syslog>(2)  system call "
8895 "facility to log kernel messages."
8896 msgstr ""
8897
8898 #. type: Plain text
8899 #: build/C/man5/proc.5:1676
8900 msgid "Information in this file is retrieved with the B<dmesg>(1)  program."
8901 msgstr ""
8902
8903 #. type: TP
8904 #: build/C/man5/proc.5:1676
8905 #, no-wrap
8906 msgid "I</proc/ksyms> (Linux 1.1.23-2.5.47)"
8907 msgstr ""
8908
8909 #. type: Plain text
8910 #: build/C/man5/proc.5:1680
8911 msgid "See I</proc/kallsyms>."
8912 msgstr ""
8913
8914 #. type: TP
8915 #: build/C/man5/proc.5:1680
8916 #, no-wrap
8917 msgid "I</proc/loadavg>"
8918 msgstr ""
8919
8920 #. type: Plain text
8921 #: build/C/man5/proc.5:1695
8922 msgid ""
8923 "The first three fields in this file are load average figures giving the "
8924 "number of jobs in the run queue (state R)  or waiting for disk I/O (state D) "
8925 "averaged over 1, 5, and 15 minutes.  They are the same as the load average "
8926 "numbers given by B<uptime>(1)  and other programs.  The fourth field "
8927 "consists of two numbers separated by a slash (/).  The first of these is the "
8928 "number of currently runnable kernel scheduling entities (processes, "
8929 "threads).  The value after the slash is the number of kernel scheduling "
8930 "entities that currently exist on the system.  The fifth field is the PID of "
8931 "the process that was most recently created on the system."
8932 msgstr ""
8933
8934 #. type: TP
8935 #: build/C/man5/proc.5:1695
8936 #, no-wrap
8937 msgid "I</proc/locks>"
8938 msgstr ""
8939
8940 #. type: Plain text
8941 #: build/C/man5/proc.5:1701
8942 msgid ""
8943 "This file shows current file locks (B<flock>(2) and B<fcntl>(2))  and leases "
8944 "(B<fcntl>(2))."
8945 msgstr ""
8946
8947 #. type: TP
8948 #: build/C/man5/proc.5:1701
8949 #, no-wrap
8950 msgid "I</proc/malloc> (only up to and including Linux 2.2)"
8951 msgstr ""
8952
8953 #.  It looks like this only ever did something back in 1.0 days
8954 #. type: Plain text
8955 #: build/C/man5/proc.5:1707
8956 msgid ""
8957 "This file is present only if B<CONFIG_DEBUG_MALLOC> was defined during "
8958 "compilation."
8959 msgstr ""
8960
8961 #. type: TP
8962 #: build/C/man5/proc.5:1707
8963 #, no-wrap
8964 msgid "I</proc/meminfo>"
8965 msgstr ""
8966
8967 #. type: Plain text
8968 #: build/C/man5/proc.5:1723
8969 msgid ""
8970 "This file reports statistics about memory usage on the system.  It is used "
8971 "by B<free>(1)  to report the amount of free and used memory (both physical "
8972 "and swap)  on the system as well as the shared memory and buffers used by "
8973 "the kernel.  Each line of the file consists of a parameter name, followed by "
8974 "a colon, the value of the parameter, and an option unit of measurement "
8975 "(e.g., \"kB\").  The list below describes the parameter names and the format "
8976 "specifier required to read the field value.  Except as noted below, all of "
8977 "the fields have been present since at least Linux 2.6.0.  Some fileds are "
8978 "displayed only if the kernel was configured with various options; those "
8979 "dependencies are noted in the list."
8980 msgstr ""
8981
8982 #. type: TP
8983 #: build/C/man5/proc.5:1724
8984 #, no-wrap
8985 msgid "I<MemTotal> %lu"
8986 msgstr ""
8987
8988 #. type: Plain text
8989 #: build/C/man5/proc.5:1728
8990 msgid ""
8991 "Total usable RAM (i.e. physical RAM minus a few reserved bits and the kernel "
8992 "binary code)."
8993 msgstr ""
8994
8995 #. type: TP
8996 #: build/C/man5/proc.5:1728
8997 #, no-wrap
8998 msgid "I<MemFree> %lu"
8999 msgstr ""
9000
9001 #. type: Plain text
9002 #: build/C/man5/proc.5:1732
9003 msgid "The sum of I<LowFree>+I<HighFree>."
9004 msgstr ""
9005
9006 #. type: TP
9007 #: build/C/man5/proc.5:1732
9008 #, no-wrap
9009 msgid "I<Buffers> %lu"
9010 msgstr ""
9011
9012 #. type: Plain text
9013 #: build/C/man5/proc.5:1736
9014 msgid ""
9015 "Relatively temporary storage for raw disk blocks that shouldn't get "
9016 "tremendously large (20MB or so)."
9017 msgstr ""
9018
9019 #. type: TP
9020 #: build/C/man5/proc.5:1736
9021 #, no-wrap
9022 msgid "I<Cached> %lu"
9023 msgstr ""
9024
9025 #. type: Plain text
9026 #: build/C/man5/proc.5:1741
9027 msgid ""
9028 "In-memory cache for files read from the disk (the page cache).  Doesn't "
9029 "include I<SwapCached>."
9030 msgstr ""
9031
9032 #. type: TP
9033 #: build/C/man5/proc.5:1741
9034 #, no-wrap
9035 msgid "I<SwapCached> %lu"
9036 msgstr ""
9037
9038 #. type: Plain text
9039 #: build/C/man5/proc.5:1749
9040 msgid ""
9041 "Memory that once was swapped out, is swapped back in but still also is in "
9042 "the swap file.  (If memory pressure is high, these pages don't need to be "
9043 "swapped out again because they are already in the swap file.  This saves "
9044 "I/O.)"
9045 msgstr ""
9046
9047 #. type: TP
9048 #: build/C/man5/proc.5:1749
9049 #, no-wrap
9050 msgid "I<Active> %lu"
9051 msgstr ""
9052
9053 #. type: Plain text
9054 #: build/C/man5/proc.5:1753
9055 msgid ""
9056 "Memory that has been used more recently and usually not reclaimed unless "
9057 "absolutely necessary."
9058 msgstr ""
9059
9060 #. type: TP
9061 #: build/C/man5/proc.5:1753
9062 #, no-wrap
9063 msgid "I<Inactive> %lu"
9064 msgstr ""
9065
9066 #. type: Plain text
9067 #: build/C/man5/proc.5:1757
9068 msgid ""
9069 "Memory which has been less recently used.  It is more eligible to be "
9070 "reclaimed for other purposes."
9071 msgstr ""
9072
9073 #. type: TP
9074 #: build/C/man5/proc.5:1757
9075 #, no-wrap
9076 msgid "I<Active(anon)> %lu (since Linux 2.6.28)"
9077 msgstr ""
9078
9079 #. type: Plain text
9080 #: build/C/man5/proc.5:1760 build/C/man5/proc.5:1763 build/C/man5/proc.5:1766 build/C/man5/proc.5:1769 build/C/man5/proc.5:1834
9081 msgid "[To be documented.]"
9082 msgstr ""
9083
9084 #. type: TP
9085 #: build/C/man5/proc.5:1760
9086 #, no-wrap
9087 msgid "I<Inactive(anon)> %lu (since Linux 2.6.28)"
9088 msgstr ""
9089
9090 #. type: TP
9091 #: build/C/man5/proc.5:1763
9092 #, no-wrap
9093 msgid "I<Active(file)> %lu (since Linux 2.6.28)"
9094 msgstr ""
9095
9096 #. type: TP
9097 #: build/C/man5/proc.5:1766
9098 #, no-wrap
9099 msgid "I<Inactive(file)> %lu (since Linux 2.6.28)"
9100 msgstr ""
9101
9102 #. type: TP
9103 #: build/C/man5/proc.5:1769
9104 #, no-wrap
9105 msgid "I<Unevictable> %lu (since Linux 2.6.28)"
9106 msgstr ""
9107
9108 #. type: Plain text
9109 #: build/C/man5/proc.5:1774 build/C/man5/proc.5:1779
9110 msgid ""
9111 "(From Linux 2.6.28 to 2.6.30, B<CONFIG_UNEVICTABLE_LRU> was required.)  [To "
9112 "be documented.]"
9113 msgstr ""
9114
9115 #. type: TP
9116 #: build/C/man5/proc.5:1774
9117 #, no-wrap
9118 msgid "I<Mlocked> %lu (since Linux 2.6.28)"
9119 msgstr ""
9120
9121 #. type: TP
9122 #: build/C/man5/proc.5:1779
9123 #, no-wrap
9124 msgid "I<HighTotal> %lu"
9125 msgstr ""
9126
9127 #. type: Plain text
9128 #: build/C/man5/proc.5:1788
9129 msgid ""
9130 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.)  Total amount "
9131 "of highmem.  Highmem is all memory above ~860MB of physical memory.  Highmem "
9132 "areas are for use by user-space programs, or for the page cache.  The kernel "
9133 "must use tricks to access this memory, making it slower to access than "
9134 "lowmem."
9135 msgstr ""
9136
9137 #. type: TP
9138 #: build/C/man5/proc.5:1788
9139 #, no-wrap
9140 msgid "I<HighFree> %lu"
9141 msgstr ""
9142
9143 #. type: Plain text
9144 #: build/C/man5/proc.5:1792
9145 msgid ""
9146 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.)  Amount of free "
9147 "highmem."
9148 msgstr ""
9149
9150 #. type: TP
9151 #: build/C/man5/proc.5:1792
9152 #, no-wrap
9153 msgid "I<LowTotal> %lu"
9154 msgstr ""
9155
9156 #. type: Plain text
9157 #: build/C/man5/proc.5:1804
9158 msgid ""
9159 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.)  Total amount "
9160 "of lowmem.  Lowmem is memory which can be used for everything that highmem "
9161 "can be used for, but it is also available for the kernel's use for its own "
9162 "data structures.  Among many other things, it is where everything from "
9163 "I<Slab> is allocated.  Bad things happen when you're out of lowmem."
9164 msgstr ""
9165
9166 #. type: TP
9167 #: build/C/man5/proc.5:1804
9168 #, no-wrap
9169 msgid "I<LowFree> %lu"
9170 msgstr ""
9171
9172 #. type: Plain text
9173 #: build/C/man5/proc.5:1808
9174 msgid ""
9175 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.)  Amount of free "
9176 "lowmem."
9177 msgstr ""
9178
9179 #. type: TP
9180 #: build/C/man5/proc.5:1808
9181 #, no-wrap
9182 msgid "I<MmapCopy> %lu (since Linux 2.6.29)"
9183 msgstr ""
9184
9185 #. type: Plain text
9186 #: build/C/man5/proc.5:1813
9187 msgid "(B<CONFIG_MMU> is required.)  [To be documented.]"
9188 msgstr ""
9189
9190 #. type: TP
9191 #: build/C/man5/proc.5:1813
9192 #, no-wrap
9193 msgid "I<SwapTotal> %lu"
9194 msgstr ""
9195
9196 #. type: Plain text
9197 #: build/C/man5/proc.5:1816
9198 msgid "Total amount of swap space available."
9199 msgstr ""
9200
9201 #. type: TP
9202 #: build/C/man5/proc.5:1816
9203 #, no-wrap
9204 msgid "I<SwapFree> %lu"
9205 msgstr ""
9206
9207 #. type: Plain text
9208 #: build/C/man5/proc.5:1819
9209 msgid "Amount of swap space that is currently unused."
9210 msgstr ""
9211
9212 #. type: TP
9213 #: build/C/man5/proc.5:1819
9214 #, no-wrap
9215 msgid "I<Dirty> %lu"
9216 msgstr ""
9217
9218 #. type: Plain text
9219 #: build/C/man5/proc.5:1822
9220 msgid "Memory which is waiting to get written back to the disk."
9221 msgstr ""
9222
9223 #. type: TP
9224 #: build/C/man5/proc.5:1822
9225 #, no-wrap
9226 msgid "I<Writeback> %lu"
9227 msgstr ""
9228
9229 #. type: Plain text
9230 #: build/C/man5/proc.5:1825
9231 msgid "Memory which is actively being written back to the disk."
9232 msgstr ""
9233
9234 #. type: TP
9235 #: build/C/man5/proc.5:1825
9236 #, no-wrap
9237 msgid "I<AnonPages> %lu (since Linux 2.6.18)"
9238 msgstr ""
9239
9240 #. type: Plain text
9241 #: build/C/man5/proc.5:1828
9242 msgid "Non-file backed pages mapped into user-space page tables."
9243 msgstr ""
9244
9245 #. type: TP
9246 #: build/C/man5/proc.5:1828
9247 #, no-wrap
9248 msgid "I<Mapped> %lu"
9249 msgstr ""
9250
9251 #. type: Plain text
9252 #: build/C/man5/proc.5:1831
9253 msgid "Files which have been mmaped, such as libraries."
9254 msgstr ""
9255
9256 #. type: TP
9257 #: build/C/man5/proc.5:1831
9258 #, no-wrap
9259 msgid "I<Shmem> %lu (since Linux 2.6.32)"
9260 msgstr ""
9261
9262 #. type: TP
9263 #: build/C/man5/proc.5:1834
9264 #, no-wrap
9265 msgid "I<Slab> %lu"
9266 msgstr ""
9267
9268 #. type: Plain text
9269 #: build/C/man5/proc.5:1837
9270 msgid "In-kernel data structures cache."
9271 msgstr ""
9272
9273 #. type: TP
9274 #: build/C/man5/proc.5:1837
9275 #, no-wrap
9276 msgid "I<SReclaimable> %lu (since Linux 2.6.19)"
9277 msgstr ""
9278
9279 #. type: Plain text
9280 #: build/C/man5/proc.5:1842
9281 msgid "Part of I<Slab>, that might be reclaimed, such as caches."
9282 msgstr ""
9283
9284 #. type: TP
9285 #: build/C/man5/proc.5:1842
9286 #, no-wrap
9287 msgid "I<SUnreclaim> %lu (since Linux 2.6.19)"
9288 msgstr ""
9289
9290 #. type: Plain text
9291 #: build/C/man5/proc.5:1847
9292 msgid "Part of I<Slab>, that cannot be reclaimed on memory pressure."
9293 msgstr ""
9294
9295 #. type: TP
9296 #: build/C/man5/proc.5:1847
9297 #, no-wrap
9298 msgid "I<KernelStack> %lu (since Linux 2.6.32)"
9299 msgstr ""
9300
9301 #. type: Plain text
9302 #: build/C/man5/proc.5:1850
9303 msgid "Amount of memory allocated to kernel stacks."
9304 msgstr ""
9305
9306 #. type: TP
9307 #: build/C/man5/proc.5:1850
9308 #, no-wrap
9309 msgid "I<PageTables> %lu (since Linux 2.6.18)"
9310 msgstr ""
9311
9312 #. type: Plain text
9313 #: build/C/man5/proc.5:1853
9314 msgid "Amount of memory dedicated to the lowest level of page tables."
9315 msgstr ""
9316
9317 #. type: TP
9318 #: build/C/man5/proc.5:1853
9319 #, no-wrap
9320 msgid "I<Quicklists> %lu (since Linux 2.6.27)"
9321 msgstr ""
9322
9323 #. type: Plain text
9324 #: build/C/man5/proc.5:1857
9325 msgid "(B<CONFIG_QUICKLIST> is required.)  [To be documented.]"
9326 msgstr ""
9327
9328 #. type: TP
9329 #: build/C/man5/proc.5:1857
9330 #, no-wrap
9331 msgid "I<NFS_Unstable> %lu (since Linux 2.6.18)"
9332 msgstr ""
9333
9334 #. type: Plain text
9335 #: build/C/man5/proc.5:1860
9336 msgid "NFS pages sent to the server, but not yet committed to stable storage."
9337 msgstr ""
9338
9339 #. type: TP
9340 #: build/C/man5/proc.5:1860
9341 #, no-wrap
9342 msgid "I<Bounce> %lu (since Linux 2.6.18)"
9343 msgstr ""
9344
9345 #. type: Plain text
9346 #: build/C/man5/proc.5:1863
9347 msgid "Memory used for block device \"bounce buffers\"."
9348 msgstr ""
9349
9350 #. type: TP
9351 #: build/C/man5/proc.5:1863
9352 #, no-wrap
9353 msgid "I<WritebackTmp> %lu (since Linux 2.6.26)"
9354 msgstr ""
9355
9356 #. type: Plain text
9357 #: build/C/man5/proc.5:1866
9358 msgid "Memory used by FUSE for temporary writeback buffers."
9359 msgstr ""
9360
9361 #. type: TP
9362 #: build/C/man5/proc.5:1866
9363 #, no-wrap
9364 msgid "I<CommitLimit> %lu (since Linux 2.6.10)"
9365 msgstr ""
9366
9367 #. type: Plain text
9368 #: build/C/man5/proc.5:1877
9369 msgid ""
9370 "Based on the overcommit ratio ('vm.overcommit_ratio'), this is the total "
9371 "amount of memory currently available to be allocated on the system.  This "
9372 "limit is adhered to only if strict overcommit accounting is enabled (mode 2 "
9373 "in I</proc/sys/vm/overcommit_ratio>).  The I<CommitLimit> is calculated "
9374 "using the following formula:"
9375 msgstr ""
9376
9377 #. type: Plain text
9378 #: build/C/man5/proc.5:1879
9379 #, no-wrap
9380 msgid "    CommitLimit = (overcommit_ratio * Physical RAM) + Swap\n"
9381 msgstr ""
9382
9383 #. type: Plain text
9384 #: build/C/man5/proc.5:1889
9385 msgid ""
9386 "For example, on a system with 1GB of physical RAM and 7GB of swap with a "
9387 "I<overcommit_ratio> of 30, this formula yields a I<CommitLimit> of 7.3GB.  "
9388 "For more details, see the memory overcommit documentation in the kernel "
9389 "source file I<Documentation/vm/overcommit-accounting>."
9390 msgstr ""
9391
9392 #. type: TP
9393 #: build/C/man5/proc.5:1889
9394 #, no-wrap
9395 msgid "I<Committed_AS> %lu"
9396 msgstr ""
9397
9398 #. type: Plain text
9399 #: build/C/man5/proc.5:1909
9400 msgid ""
9401 "The amount of memory presently allocated on the system.  The committed "
9402 "memory is a sum of all of the memory which has been allocated by processes, "
9403 "even if it has not been \"used\" by them as of yet.  A process which "
9404 "allocates 1GB of memory (using B<malloc>(3)  or similar), but touches only "
9405 "300MB of that memory will show up as using only 300MB of memory even if it "
9406 "has the address space allocated for the entire 1GB.  This 1GB is memory "
9407 "which has been \"committed\" to by the VM and can be used at any time by the "
9408 "allocating application.  With strict overcommit enabled on the system (mode "
9409 "2 I</proc/sys/vm/overcommit_memory>), allocations which would exceed the "
9410 "I<CommitLimit> (detailed above) will not be permitted.  This is useful if "
9411 "one needs to guarantee that processes will not fail due to lack of memory "
9412 "once that memory has been successfully allocated."
9413 msgstr ""
9414
9415 #. type: TP
9416 #: build/C/man5/proc.5:1909
9417 #, no-wrap
9418 msgid "I<VmallocTotal> %lu"
9419 msgstr ""
9420
9421 #. type: Plain text
9422 #: build/C/man5/proc.5:1912
9423 msgid "Total size of vmalloc memory area."
9424 msgstr ""
9425
9426 #. type: TP
9427 #: build/C/man5/proc.5:1912
9428 #, no-wrap
9429 msgid "I<VmallocUsed> %lu"
9430 msgstr ""
9431
9432 #. type: Plain text
9433 #: build/C/man5/proc.5:1915
9434 msgid "Amount of vmalloc area which is used."
9435 msgstr ""
9436
9437 #. type: TP
9438 #: build/C/man5/proc.5:1915
9439 #, no-wrap
9440 msgid "I<VmallocChunk> %lu"
9441 msgstr ""
9442
9443 #. type: Plain text
9444 #: build/C/man5/proc.5:1918
9445 msgid "Largest contiguous block of vmalloc area which is free."
9446 msgstr ""
9447
9448 #. type: TP
9449 #: build/C/man5/proc.5:1918
9450 #, no-wrap
9451 msgid "I<HardwareCorrupted> %lu (since Linux 2.6.32)"
9452 msgstr ""
9453
9454 #. type: Plain text
9455 #: build/C/man5/proc.5:1922
9456 msgid "(B<CONFIG_MEMORY_FAILURE> is required.)  [To be documented.]"
9457 msgstr ""
9458
9459 #. type: TP
9460 #: build/C/man5/proc.5:1922
9461 #, no-wrap
9462 msgid "I<AnonHugePages> %lu (since Linux 2.6.38)"
9463 msgstr ""
9464
9465 #. type: Plain text
9466 #: build/C/man5/proc.5:1926
9467 msgid ""
9468 "(B<CONFIG_TRANSPARENT_HUGEPAGE> is required.)  Non-file backed huge pages "
9469 "mapped into user-space page tables."
9470 msgstr ""
9471
9472 #. type: TP
9473 #: build/C/man5/proc.5:1926
9474 #, no-wrap
9475 msgid "I<HugePages_Total> %lu"
9476 msgstr ""
9477
9478 #. type: Plain text
9479 #: build/C/man5/proc.5:1930
9480 msgid "(B<CONFIG_HUGETLB_PAGE> is required.)  The size of the pool of huge pages."
9481 msgstr ""
9482
9483 #. type: TP
9484 #: build/C/man5/proc.5:1930
9485 #, no-wrap
9486 msgid "I<HugePages_Free> %lu"
9487 msgstr ""
9488
9489 #. type: Plain text
9490 #: build/C/man5/proc.5:1934
9491 msgid ""
9492 "(B<CONFIG_HUGETLB_PAGE> is required.)  The number of huge pages in the pool "
9493 "that are not yet allocated."
9494 msgstr ""
9495
9496 #. type: TP
9497 #: build/C/man5/proc.5:1934
9498 #, no-wrap
9499 msgid "I<HugePages_Rsvd> %lu (since Linux 2.6.17)"
9500 msgstr ""
9501
9502 #. type: Plain text
9503 #: build/C/man5/proc.5:1943
9504 msgid ""
9505 "(B<CONFIG_HUGETLB_PAGE> is required.)  This is the number of huge pages for "
9506 "which a commitment to allocate from the pool has been made, but no "
9507 "allocation has yet been made.  These reserved huge pages guarantee that an "
9508 "application will be able to allocate a huge page from the pool of huge pages "
9509 "at fault time."
9510 msgstr ""
9511
9512 #. type: TP
9513 #: build/C/man5/proc.5:1943
9514 #, no-wrap
9515 msgid "I<HugePages_Surp> %lu (since Linux 2.6.24)"
9516 msgstr ""
9517
9518 #. type: Plain text
9519 #: build/C/man5/proc.5:1951
9520 msgid ""
9521 "(B<CONFIG_HUGETLB_PAGE> is required.)  This is the number of huge pages in "
9522 "the pool above the value in I</proc/sys/vm/nr_hugepages>.  The maximum "
9523 "number of surplus huge pages is controlled by "
9524 "I</proc/sys/vm/nr_overcommit_hugepages>."
9525 msgstr ""
9526
9527 #. type: TP
9528 #: build/C/man5/proc.5:1951
9529 #, no-wrap
9530 msgid "I<Hugepagesize> %lu"
9531 msgstr ""
9532
9533 #. type: Plain text
9534 #: build/C/man5/proc.5:1955
9535 msgid "(B<CONFIG_HUGETLB_PAGE> is required.)  The size of huge pages."
9536 msgstr ""
9537
9538 #. type: TP
9539 #: build/C/man5/proc.5:1956
9540 #, no-wrap
9541 msgid "I</proc/modules>"
9542 msgstr ""
9543
9544 #. type: Plain text
9545 #: build/C/man5/proc.5:1961
9546 msgid ""
9547 "A text list of the modules that have been loaded by the system.  See also "
9548 "B<lsmod>(8)."
9549 msgstr ""
9550
9551 #. type: TP
9552 #: build/C/man5/proc.5:1961
9553 #, no-wrap
9554 msgid "I</proc/mounts>"
9555 msgstr ""
9556
9557 #. type: Plain text
9558 #: build/C/man5/proc.5:1971
9559 msgid ""
9560 "Before kernel 2.4.19, this file was a list of all the filesystems currently "
9561 "mounted on the system.  With the introduction of per-process mount "
9562 "namespaces in Linux 2.4.19, this file became a link to I</proc/self/mounts>, "
9563 "which lists the mount points of the process's own mount namespace.  The "
9564 "format of this file is documented in B<fstab>(5)."
9565 msgstr ""
9566
9567 #. type: TP
9568 #: build/C/man5/proc.5:1971
9569 #, no-wrap
9570 msgid "I</proc/mtrr>"
9571 msgstr ""
9572
9573 #. type: Plain text
9574 #: build/C/man5/proc.5:1977
9575 msgid ""
9576 "Memory Type Range Registers.  See the Linux kernel source file "
9577 "I<Documentation/mtrr.txt> for details."
9578 msgstr ""
9579
9580 #. type: TP
9581 #: build/C/man5/proc.5:1977
9582 #, no-wrap
9583 msgid "I</proc/net>"
9584 msgstr ""
9585
9586 #. type: Plain text
9587 #: build/C/man5/proc.5:1987
9588 msgid ""
9589 "various net pseudo-files, all of which give the status of some part of the "
9590 "networking layer.  These files contain ASCII structures and are, therefore, "
9591 "readable with B<cat>(1).  However, the standard B<netstat>(8)  suite "
9592 "provides much cleaner access to these files."
9593 msgstr ""
9594
9595 #. type: TP
9596 #: build/C/man5/proc.5:1987
9597 #, no-wrap
9598 msgid "I</proc/net/arp>"
9599 msgstr ""
9600
9601 #. type: Plain text
9602 #: build/C/man5/proc.5:1993
9603 msgid ""
9604 "This holds an ASCII readable dump of the kernel ARP table used for address "
9605 "resolutions.  It will show both dynamically learned and preprogrammed ARP "
9606 "entries.  The format is:"
9607 msgstr ""
9608
9609 #. type: Plain text
9610 #: build/C/man5/proc.5:2000
9611 #, no-wrap
9612 msgid ""
9613 "CW<IP address     HW type   Flags     HW address          Mask   Device\n"
9614 "192.168.0.50   0x1       0x2       00:50:BF:25:68:F3   *      eth0\n"
9615 "192.168.0.250  0x1       0xc       00:00:00:00:00:00   *      eth0>\n"
9616 msgstr ""
9617
9618 #. type: Plain text
9619 #: build/C/man5/proc.5:2012
9620 msgid ""
9621 "Here \"IP address\" is the IPv4 address of the machine and the \"HW type\" "
9622 "is the hardware type of the address from RFC\\ 826.  The flags are the "
9623 "internal flags of the ARP structure (as defined in "
9624 "I</usr/include/linux/if_arp.h>)  and the \"HW address\" is the data link "
9625 "layer mapping for that IP address if it is known."
9626 msgstr ""
9627
9628 #. type: TP
9629 #: build/C/man5/proc.5:2012
9630 #, no-wrap
9631 msgid "I</proc/net/dev>"
9632 msgstr ""
9633
9634 #. type: Plain text
9635 #: build/C/man5/proc.5:2023
9636 msgid ""
9637 "The dev pseudo-file contains network device status information.  This gives "
9638 "the number of received and sent packets, the number of errors and collisions "
9639 "and other basic statistics.  These are used by the B<ifconfig>(8)  program "
9640 "to report device status.  The format is:"
9641 msgstr ""
9642
9643 #. type: Plain text
9644 #: build/C/man5/proc.5:2033
9645 #, no-wrap
9646 msgid ""
9647 "CW<Inter-|   Receive                                                |  "
9648 "Transmit\n"
9649 " face |bytes    packets errs drop fifo frame compressed multicast|bytes    "
9650 "packets errs drop fifo colls carrier compressed\n"
9651 "    lo: 2776770   11307    0    0    0     0          0         0  2776770   "
9652 "11307    0    0    0     0       0          0\n"
9653 "  eth0: 1215645    2751    0    0    0     0          0         0  1782404    "
9654 "4324    0    0    0   427       0          0\n"
9655 "  ppp0: 1622270    5552    1    0    0     0          0         0   354130    "
9656 "5669    0    0    0     0       0          0\n"
9657 "  tap0:    7714      81    0    0    0     0          0         0     7714      "
9658 "81    0    0    0     0       0          0>\n"
9659 msgstr ""
9660
9661 #. type: TP
9662 #: build/C/man5/proc.5:2042
9663 #, no-wrap
9664 msgid "I</proc/net/dev_mcast>"
9665 msgstr ""
9666
9667 #. type: Plain text
9668 #: build/C/man5/proc.5:2046
9669 msgid "Defined in I</usr/src/linux/net/core/dev_mcast.c>:"
9670 msgstr ""
9671
9672 #. type: Plain text
9673 #: build/C/man5/proc.5:2052
9674 #, no-wrap
9675 msgid ""
9676 "indx interface_name  dmi_u dmi_g dmi_address\n"
9677 "2    eth0            1     0     01005e000001\n"
9678 "3    eth1            1     0     01005e000001\n"
9679 "4    eth2            1     0     01005e000001\n"
9680 msgstr ""
9681
9682 #. type: TP
9683 #: build/C/man5/proc.5:2054
9684 #, no-wrap
9685 msgid "I</proc/net/igmp>"
9686 msgstr ""
9687
9688 #. type: Plain text
9689 #: build/C/man5/proc.5:2059
9690 msgid ""
9691 "Internet Group Management Protocol.  Defined in "
9692 "I</usr/src/linux/net/core/igmp.c>."
9693 msgstr ""
9694
9695 #. type: TP
9696 #: build/C/man5/proc.5:2059
9697 #, no-wrap
9698 msgid "I</proc/net/rarp>"
9699 msgstr ""
9700
9701 #. type: Plain text
9702 #: build/C/man5/proc.5:2069
9703 msgid ""
9704 "This file uses the same format as the I<arp> file and contains the current "
9705 "reverse mapping database used to provide B<rarp>(8)  reverse address lookup "
9706 "services.  If RARP is not configured into the kernel, this file will not be "
9707 "present."
9708 msgstr ""
9709
9710 #. type: TP
9711 #: build/C/man5/proc.5:2069
9712 #, no-wrap
9713 msgid "I</proc/net/raw>"
9714 msgstr ""
9715
9716 #.  .TP
9717 #.  .I /proc/net/route
9718 #.  No information, but looks similar to
9719 #.  .BR route (8).
9720 #. type: Plain text
9721 #: build/C/man5/proc.5:2089
9722 msgid ""
9723 "Holds a dump of the RAW socket table.  Much of the information is not of use "
9724 "apart from debugging.  The \"sl\" value is the kernel hash slot for the "
9725 "socket, the \"local_address\" is the local address and protocol number "
9726 "pair.  \\&\"St\" is the internal status of the socket.  The \"tx_queue\" and "
9727 "\"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
9728 "memory usage.  The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
9729 "used by RAW.  The \"uid\" field holds the effective UID of the creator of "
9730 "the socket."
9731 msgstr ""
9732
9733 #. type: TP
9734 #: build/C/man5/proc.5:2089
9735 #, no-wrap
9736 msgid "I</proc/net/snmp>"
9737 msgstr ""
9738
9739 #. type: Plain text
9740 #: build/C/man5/proc.5:2094
9741 msgid ""
9742 "This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP "
9743 "management information bases for an SNMP agent."
9744 msgstr ""
9745
9746 #. type: TP
9747 #: build/C/man5/proc.5:2094
9748 #, no-wrap
9749 msgid "I</proc/net/tcp>"
9750 msgstr ""
9751
9752 #. type: Plain text
9753 #: build/C/man5/proc.5:2110
9754 msgid ""
9755 "Holds a dump of the TCP socket table.  Much of the information is not of use "
9756 "apart from debugging.  The \"sl\" value is the kernel hash slot for the "
9757 "socket, the \"local_address\" is the local address and port number pair.  "
9758 "The \"rem_address\" is the remote address and port number pair (if "
9759 "connected).  \\&\"St\" is the internal status of the socket.  The "
9760 "\"tx_queue\" and \"rx_queue\" are the outgoing and incoming data queue in "
9761 "terms of kernel memory usage.  The \"tr\", \"tm-E<gt>when\", and \"rexmits\" "
9762 "fields hold internal information of the kernel socket state and are only "
9763 "useful for debugging.  The \"uid\" field holds the effective UID of the "
9764 "creator of the socket."
9765 msgstr ""
9766
9767 #. type: TP
9768 #: build/C/man5/proc.5:2110
9769 #, no-wrap
9770 msgid "I</proc/net/udp>"
9771 msgstr ""
9772
9773 #. type: Plain text
9774 #: build/C/man5/proc.5:2126
9775 msgid ""
9776 "Holds a dump of the UDP socket table.  Much of the information is not of use "
9777 "apart from debugging.  The \"sl\" value is the kernel hash slot for the "
9778 "socket, the \"local_address\" is the local address and port number pair.  "
9779 "The \"rem_address\" is the remote address and port number pair (if "
9780 "connected). \"St\" is the internal status of the socket.  The \"tx_queue\" "
9781 "and \"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
9782 "memory usage.  The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
9783 "used by UDP.  The \"uid\" field holds the effective UID of the creator of "
9784 "the socket.  The format is:"
9785 msgstr ""
9786
9787 #. type: Plain text
9788 #: build/C/man5/proc.5:2134
9789 #, no-wrap
9790 msgid ""
9791 "CW<sl  local_address rem_address   st tx_queue rx_queue tr rexmits  "
9792 "tm-E<gt>when uid\n"
9793 " 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 "
9794 "0\n"
9795 " 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 "
9796 "0\n"
9797 " 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 "
9798 "0>\n"
9799 msgstr ""
9800
9801 #. type: TP
9802 #: build/C/man5/proc.5:2137
9803 #, no-wrap
9804 msgid "I</proc/net/unix>"
9805 msgstr ""
9806
9807 #. type: Plain text
9808 #: build/C/man5/proc.5:2142
9809 msgid ""
9810 "Lists the UNIX domain sockets present within the system and their status.  "
9811 "The format is:"
9812 msgstr ""
9813
9814 #. type: Plain text
9815 #: build/C/man5/proc.5:2148
9816 #, no-wrap
9817 msgid ""
9818 "CW<Num RefCount Protocol Flags    Type St Path\n"
9819 " 0: 00000002 00000000 00000000 0001 03\n"
9820 " 1: 00000001 00000000 00010000 0001 01 /dev/printer>\n"
9821 msgstr ""
9822
9823 #. type: Plain text
9824 #: build/C/man5/proc.5:2160
9825 msgid ""
9826 "Here \"Num\" is the kernel table slot number, \"RefCount\" is the number of "
9827 "users of the socket, \"Protocol\" is currently always 0, \"Flags\" represent "
9828 "the internal kernel flags holding the status of the socket.  Currently, type "
9829 "is always \"1\" (UNIX domain datagram sockets are not yet supported in the "
9830 "kernel).  \\&\"St\" is the internal state of the socket and Path is the "
9831 "bound path (if any) of the socket."
9832 msgstr ""
9833
9834 #. type: TP
9835 #: build/C/man5/proc.5:2160
9836 #, no-wrap
9837 msgid "I</proc/partitions>"
9838 msgstr ""
9839
9840 #. type: Plain text
9841 #: build/C/man5/proc.5:2164
9842 msgid ""
9843 "Contains the major and minor numbers of each partition as well as the number "
9844 "of 1024-byte blocks and the partition name."
9845 msgstr ""
9846
9847 #. type: TP
9848 #: build/C/man5/proc.5:2164
9849 #, no-wrap
9850 msgid "I</proc/pci>"
9851 msgstr ""
9852
9853 #. type: Plain text
9854 #: build/C/man5/proc.5:2168
9855 msgid ""
9856 "This is a listing of all PCI devices found during kernel initialization and "
9857 "their configuration."
9858 msgstr ""
9859
9860 #.  FIXME /proc/sched_debug
9861 #.  .TP
9862 #.  .IR /proc/sched_debug " (since Linux 2.6.23)"
9863 #.  See also /proc/[pid]/sched
9864 #. type: Plain text
9865 #: build/C/man5/proc.5:2184
9866 msgid ""
9867 "This file has been deprecated in favor of a new I</proc> interface for PCI "
9868 "(I</proc/bus/pci>).  It became optional in Linux 2.2 (available with "
9869 "B<CONFIG_PCI_OLD_PROC> set at kernel compilation).  It became once more "
9870 "nonoptionally enabled in Linux 2.4.  Next, it was deprecated in Linux 2.6 "
9871 "(still available with B<CONFIG_PCI_LEGACY_PROC> set), and finally removed "
9872 "altogether since Linux 2.6.17."
9873 msgstr ""
9874
9875 #. type: TP
9876 #: build/C/man5/proc.5:2184
9877 #, no-wrap
9878 msgid "I</proc/profile> (since Linux 2.4)"
9879 msgstr ""
9880
9881 #. type: Plain text
9882 #: build/C/man5/proc.5:2196
9883 msgid ""
9884 "This file is present only if the kernel was booted with the I<profile=1> "
9885 "command-line option.  It exposes kernel profiling information in a binary "
9886 "format for use by B<readprofile>(1).  Writing (e.g., an empty string) to "
9887 "this file resets the profiling counters; on some architectures, writing a "
9888 "binary integer \"profiling multiplier\" of size I<sizeof(int)> sets the "
9889 "profiling interrupt frequency."
9890 msgstr ""
9891
9892 #. type: TP
9893 #: build/C/man5/proc.5:2196
9894 #, no-wrap
9895 msgid "I</proc/scsi>"
9896 msgstr ""
9897
9898 #. type: Plain text
9899 #: build/C/man5/proc.5:2206
9900 msgid ""
9901 "A directory with the I<scsi> mid-level pseudo-file and various SCSI "
9902 "low-level driver directories, which contain a file for each SCSI host in "
9903 "this system, all of which give the status of some part of the SCSI IO "
9904 "subsystem.  These files contain ASCII structures and are, therefore, "
9905 "readable with B<cat>(1)."
9906 msgstr ""
9907
9908 #. type: Plain text
9909 #: build/C/man5/proc.5:2209
9910 msgid ""
9911 "You can also write to some of the files to reconfigure the subsystem or "
9912 "switch certain features on or off."
9913 msgstr ""
9914
9915 #. type: TP
9916 #: build/C/man5/proc.5:2209
9917 #, no-wrap
9918 msgid "I</proc/scsi/scsi>"
9919 msgstr ""
9920
9921 #. type: Plain text
9922 #: build/C/man5/proc.5:2215
9923 msgid ""
9924 "This is a listing of all SCSI devices known to the kernel.  The listing is "
9925 "similar to the one seen during bootup.  scsi currently supports only the "
9926 "I<add-single-device> command which allows root to add a hotplugged device to "
9927 "the list of known devices."
9928 msgstr ""
9929
9930 #. type: Plain text
9931 #: build/C/man5/proc.5:2217
9932 msgid "The command"
9933 msgstr ""
9934
9935 #. type: Plain text
9936 #: build/C/man5/proc.5:2221
9937 #, no-wrap
9938 msgid "echo \\(aqscsi add-single-device 1 0 5 0\\(aq E<gt> /proc/scsi/scsi\n"
9939 msgstr ""
9940
9941 #. type: Plain text
9942 #: build/C/man5/proc.5:2229
9943 msgid ""
9944 "will cause host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0.  "
9945 "If there is already a device known on this address or the address is "
9946 "invalid, an error will be returned."
9947 msgstr ""
9948
9949 #. type: TP
9950 #: build/C/man5/proc.5:2229
9951 #, no-wrap
9952 msgid "I</proc/scsi/[drivername]>"
9953 msgstr ""
9954
9955 #. type: Plain text
9956 #: build/C/man5/proc.5:2239
9957 msgid ""
9958 "I<[drivername]> can currently be NCR53c7xx, aha152x, aha1542, aha1740, "
9959 "aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, "
9960 "scsi_debug, seagate, t128, u15-24f, ultrastore, or wd7000.  These "
9961 "directories show up for all drivers that registered at least one SCSI HBA.  "
9962 "Every directory contains one file per registered host.  Every host-file is "
9963 "named after the number the host was assigned during initialization."
9964 msgstr ""
9965
9966 #. type: Plain text
9967 #: build/C/man5/proc.5:2242
9968 msgid ""
9969 "Reading these files will usually show driver and host configuration, "
9970 "statistics, etc."
9971 msgstr ""
9972
9973 #. type: Plain text
9974 #: build/C/man5/proc.5:2249
9975 msgid ""
9976 "Writing to these files allows different things on different hosts.  For "
9977 "example, with the I<latency> and I<nolatency> commands, root can switch on "
9978 "and off command latency measurement code in the eata_dma driver.  With the "
9979 "I<lockup> and I<unlock> commands, root can control bus lockups simulated by "
9980 "the scsi_debug driver."
9981 msgstr ""
9982
9983 #. type: TP
9984 #: build/C/man5/proc.5:2249
9985 #, no-wrap
9986 msgid "I</proc/self>"
9987 msgstr ""
9988
9989 #. type: Plain text
9990 #: build/C/man5/proc.5:2257
9991 msgid ""
9992 "This directory refers to the process accessing the I</proc> filesystem, and "
9993 "is identical to the I</proc> directory named by the process ID of the same "
9994 "process."
9995 msgstr ""
9996
9997 #. type: TP
9998 #: build/C/man5/proc.5:2257
9999 #, no-wrap
10000 msgid "I</proc/slabinfo>"
10001 msgstr ""
10002
10003 #. type: Plain text
10004 #: build/C/man5/proc.5:2266
10005 msgid ""
10006 "Information about kernel caches.  Since Linux 2.6.16 this file is present "
10007 "only if the B<CONFIG_SLAB> kernel configuration option is enabled.  The "
10008 "columns in I</proc/slabinfo> are:"
10009 msgstr ""
10010
10011 #. type: Plain text
10012 #: build/C/man5/proc.5:2276
10013 #, no-wrap
10014 msgid ""
10015 "cache-name\n"
10016 "num-active-objs\n"
10017 "total-objs\n"
10018 "object-size\n"
10019 "num-active-slabs\n"
10020 "total-slabs\n"
10021 "num-pages-per-slab\n"
10022 msgstr ""
10023
10024 #. type: Plain text
10025 #: build/C/man5/proc.5:2282
10026 msgid "See B<slabinfo>(5)  for details."
10027 msgstr ""
10028
10029 #. type: TP
10030 #: build/C/man5/proc.5:2282
10031 #, no-wrap
10032 msgid "I</proc/stat>"
10033 msgstr ""
10034
10035 #. type: Plain text
10036 #: build/C/man5/proc.5:2288
10037 msgid ""
10038 "kernel/system statistics.  Varies with architecture.  Common entries "
10039 "include:"
10040 msgstr ""
10041
10042 #. type: TP
10043 #: build/C/man5/proc.5:2289
10044 #, no-wrap
10045 msgid "I<cpu  3357 0 4313 1362393>"
10046 msgstr ""
10047
10048 #.  1024 on Alpha and ia64
10049 #. type: Plain text
10050 #: build/C/man5/proc.5:2297
10051 msgid ""
10052 "The amount of time, measured in units of USER_HZ (1/100ths of a second on "
10053 "most architectures, use I<sysconf(_SC_CLK_TCK)> to obtain the right value), "
10054 "that the system spent in various states:"
10055 msgstr ""
10056
10057 #. type: TP
10058 #: build/C/man5/proc.5:2298
10059 #, no-wrap
10060 msgid "I<user>"
10061 msgstr ""
10062
10063 #. type: Plain text
10064 #: build/C/man5/proc.5:2301
10065 msgid "(1) Time spent in user mode."
10066 msgstr ""
10067
10068 #. type: TP
10069 #: build/C/man5/proc.5:2301
10070 #, no-wrap
10071 msgid "I<nice>"
10072 msgstr ""
10073
10074 #. type: Plain text
10075 #: build/C/man5/proc.5:2304
10076 msgid "(2) Time spent in user mode with low priority (nice)."
10077 msgstr ""
10078
10079 #. type: TP
10080 #: build/C/man5/proc.5:2304
10081 #, no-wrap
10082 msgid "I<system>"
10083 msgstr ""
10084
10085 #. type: Plain text
10086 #: build/C/man5/proc.5:2307
10087 msgid "(3) Time spent in system mode."
10088 msgstr ""
10089
10090 #. type: TP
10091 #: build/C/man5/proc.5:2307
10092 #, no-wrap
10093 msgid "I<idle>"
10094 msgstr ""
10095
10096 #.  FIXME Actually, the following info about the /proc/stat 'cpu' field
10097 #.        does not seem to be quite right (at least in 2.6.12 or 3.6):
10098 #.        the idle time in /proc/uptime does not quite match this value
10099 #. type: Plain text
10100 #: build/C/man5/proc.5:2317
10101 msgid ""
10102 "(4) Time spent in the idle task.  This value should be USER_HZ times the "
10103 "second entry in the I</proc/uptime> pseudo-file."
10104 msgstr ""
10105
10106 #. type: TP
10107 #: build/C/man5/proc.5:2317
10108 #, no-wrap
10109 msgid "I<iowait> (since Linux 2.5.41)"
10110 msgstr ""
10111
10112 #. type: Plain text
10113 #: build/C/man5/proc.5:2320
10114 msgid "(5) Time waiting for I/O to complete."
10115 msgstr ""
10116
10117 #. type: TP
10118 #: build/C/man5/proc.5:2320
10119 #, no-wrap
10120 msgid "I<irq> (since Linux 2.6.0-test4)"
10121 msgstr ""
10122
10123 #. type: Plain text
10124 #: build/C/man5/proc.5:2323
10125 msgid "(6) Time servicing interrupts."
10126 msgstr ""
10127
10128 #. type: TP
10129 #: build/C/man5/proc.5:2323
10130 #, no-wrap
10131 msgid "I<softirq> (since Linux 2.6.0-test4)"
10132 msgstr ""
10133
10134 #. type: Plain text
10135 #: build/C/man5/proc.5:2326
10136 msgid "(7) Time servicing softirqs."
10137 msgstr ""
10138
10139 #. type: TP
10140 #: build/C/man5/proc.5:2326
10141 #, no-wrap
10142 msgid "I<steal> (since Linux 2.6.11)"
10143 msgstr ""
10144
10145 #. type: Plain text
10146 #: build/C/man5/proc.5:2330
10147 msgid ""
10148 "(8) Stolen time, which is the time spent in other operating systems when "
10149 "running in a virtualized environment"
10150 msgstr ""
10151
10152 #. type: TP
10153 #: build/C/man5/proc.5:2330
10154 #, no-wrap
10155 msgid "I<guest> (since Linux 2.6.24)"
10156 msgstr ""
10157
10158 #.  See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de
10159 #. type: Plain text
10160 #: build/C/man5/proc.5:2335
10161 msgid ""
10162 "(9) Time spent running a virtual CPU for guest operating systems under the "
10163 "control of the Linux kernel."
10164 msgstr ""
10165
10166 #. type: TP
10167 #: build/C/man5/proc.5:2335
10168 #, no-wrap
10169 msgid "I<guest_nice> (since Linux 2.6.33)"
10170 msgstr ""
10171
10172 #.  commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797
10173 #. type: Plain text
10174 #: build/C/man5/proc.5:2340
10175 msgid ""
10176 "(10) Time spent running a niced guest (virtual CPU for guest operating "
10177 "systems under the control of the Linux kernel)."
10178 msgstr ""
10179
10180 #. type: TP
10181 #: build/C/man5/proc.5:2341
10182 #, no-wrap
10183 msgid "I<page 5741 1808>"
10184 msgstr ""
10185
10186 #. type: Plain text
10187 #: build/C/man5/proc.5:2345
10188 msgid ""
10189 "The number of pages the system paged in and the number that were paged out "
10190 "(from disk)."
10191 msgstr ""
10192
10193 #. type: TP
10194 #: build/C/man5/proc.5:2345
10195 #, no-wrap
10196 msgid "I<swap 1 0>"
10197 msgstr ""
10198
10199 #. type: Plain text
10200 #: build/C/man5/proc.5:2348
10201 msgid "The number of swap pages that have been brought in and out."
10202 msgstr ""
10203
10204 #.  FIXME The following is not the full picture for the 'intr' of
10205 #.        /proc/stat on 2.6:
10206 #. type: TP
10207 #: build/C/man5/proc.5:2348
10208 #, no-wrap
10209 msgid "I<intr 1462898>"
10210 msgstr ""
10211
10212 #. type: Plain text
10213 #: build/C/man5/proc.5:2356
10214 msgid ""
10215 "This line shows counts of interrupts serviced since boot time, for each of "
10216 "the possible system interrupts.  The first column is the total of all "
10217 "interrupts serviced; each subsequent column is the total for a particular "
10218 "interrupt."
10219 msgstr ""
10220
10221 #. type: TP
10222 #: build/C/man5/proc.5:2356
10223 #, no-wrap
10224 msgid "I<disk_io: (2,0):(31,30,5764,1,2) (3,0):>..."
10225 msgstr ""
10226
10227 #. type: Plain text
10228 #: build/C/man5/proc.5:2359
10229 msgid ""
10230 "(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, "
10231 "blks_written)"
10232 msgstr ""
10233
10234 #. type: Plain text
10235 #: build/C/man5/proc.5:2361
10236 msgid "(Linux 2.4 only)"
10237 msgstr ""
10238
10239 #. type: TP
10240 #: build/C/man5/proc.5:2361
10241 #, no-wrap
10242 msgid "I<ctxt 115315>"
10243 msgstr ""
10244
10245 #. type: Plain text
10246 #: build/C/man5/proc.5:2364
10247 msgid "The number of context switches that the system underwent."
10248 msgstr ""
10249
10250 #. type: TP
10251 #: build/C/man5/proc.5:2364
10252 #, no-wrap
10253 msgid "I<btime 769041601>"
10254 msgstr ""
10255
10256 #. type: Plain text
10257 #: build/C/man5/proc.5:2367
10258 msgid "boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
10259 msgstr ""
10260
10261 #. type: TP
10262 #: build/C/man5/proc.5:2367
10263 #, no-wrap
10264 msgid "I<processes 86031>"
10265 msgstr ""
10266
10267 #. type: Plain text
10268 #: build/C/man5/proc.5:2370
10269 msgid "Number of forks since boot."
10270 msgstr ""
10271
10272 #. type: TP
10273 #: build/C/man5/proc.5:2370
10274 #, no-wrap
10275 msgid "I<procs_running 6>"
10276 msgstr ""
10277
10278 #. type: Plain text
10279 #: build/C/man5/proc.5:2374
10280 msgid "Number of processes in runnable state.  (Linux 2.5.45 onward.)"
10281 msgstr ""
10282
10283 #. type: TP
10284 #: build/C/man5/proc.5:2374
10285 #, no-wrap
10286 msgid "I<procs_blocked 2>"
10287 msgstr ""
10288
10289 #. type: Plain text
10290 #: build/C/man5/proc.5:2378
10291 msgid ""
10292 "Number of processes blocked waiting for I/O to complete.  (Linux 2.5.45 "
10293 "onward.)"
10294 msgstr ""
10295
10296 #. type: TP
10297 #: build/C/man5/proc.5:2379
10298 #, no-wrap
10299 msgid "I</proc/swaps>"
10300 msgstr ""
10301
10302 #. type: Plain text
10303 #: build/C/man5/proc.5:2384
10304 msgid "Swap areas in use.  See also B<swapon>(8)."
10305 msgstr ""
10306
10307 #. type: TP
10308 #: build/C/man5/proc.5:2384
10309 #, no-wrap
10310 msgid "I</proc/sys>"
10311 msgstr ""
10312
10313 #. type: Plain text
10314 #: build/C/man5/proc.5:2392
10315 msgid ""
10316 "This directory (present since 1.3.57) contains a number of files and "
10317 "subdirectories corresponding to kernel variables.  These variables can be "
10318 "read and sometimes modified using the I</proc> filesystem, and the "
10319 "(deprecated)  B<sysctl>(2)  system call."
10320 msgstr ""
10321
10322 #. type: TP
10323 #: build/C/man5/proc.5:2392
10324 #, no-wrap
10325 msgid "I</proc/sys/abi> (since Linux 2.4.10)"
10326 msgstr ""
10327
10328 #.  On some systems, it is not present.
10329 #. type: Plain text
10330 #: build/C/man5/proc.5:2399
10331 msgid ""
10332 "This directory may contain files with application binary information.  See "
10333 "the Linux kernel source file I<Documentation/sysctl/abi.txt> for more "
10334 "information."
10335 msgstr ""
10336
10337 #. type: TP
10338 #: build/C/man5/proc.5:2399
10339 #, no-wrap
10340 msgid "I</proc/sys/debug>"
10341 msgstr ""
10342
10343 #. type: Plain text
10344 #: build/C/man5/proc.5:2402 build/C/man5/proc.5:3239
10345 msgid "This directory may be empty."
10346 msgstr ""
10347
10348 #. type: TP
10349 #: build/C/man5/proc.5:2402
10350 #, no-wrap
10351 msgid "I</proc/sys/dev>"
10352 msgstr ""
10353
10354 #. type: Plain text
10355 #: build/C/man5/proc.5:2408
10356 msgid ""
10357 "This directory contains device-specific information (e.g., "
10358 "I<dev/cdrom/info>).  On some systems, it may be empty."
10359 msgstr ""
10360
10361 #. type: TP
10362 #: build/C/man5/proc.5:2408
10363 #, no-wrap
10364 msgid "I</proc/sys/fs>"
10365 msgstr ""
10366
10367 #. type: Plain text
10368 #: build/C/man5/proc.5:2412
10369 msgid ""
10370 "This directory contains the files and subdirectories for kernel variables "
10371 "related to filesystems."
10372 msgstr ""
10373
10374 #. type: TP
10375 #: build/C/man5/proc.5:2412
10376 #, no-wrap
10377 msgid "I</proc/sys/fs/binfmt_misc>"
10378 msgstr ""
10379
10380 #. type: Plain text
10381 #: build/C/man5/proc.5:2417
10382 msgid ""
10383 "Documentation for files in this directory can be found in the Linux kernel "
10384 "sources in I<Documentation/binfmt_misc.txt>."
10385 msgstr ""
10386
10387 #. type: TP
10388 #: build/C/man5/proc.5:2417
10389 #, no-wrap
10390 msgid "I</proc/sys/fs/dentry-state> (since Linux 2.2)"
10391 msgstr ""
10392
10393 #. type: Plain text
10394 #: build/C/man5/proc.5:2425
10395 msgid ""
10396 "This file contains information about the status of the directory cache "
10397 "(dcache).  The file contains six numbers, I<nr_dentry>, I<nr_unused>, "
10398 "I<age_limit> (age in seconds), I<want_pages> (pages requested by system) and "
10399 "two dummy values."
10400 msgstr ""
10401
10402 #. type: Plain text
10403 #: build/C/man5/proc.5:2430
10404 msgid ""
10405 "I<nr_dentry> is the number of allocated dentries (dcache entries).  This "
10406 "field is unused in Linux 2.2."
10407 msgstr ""
10408
10409 #. type: Plain text
10410 #: build/C/man5/proc.5:2433
10411 msgid "I<nr_unused> is the number of unused dentries."
10412 msgstr ""
10413
10414 #.  looks like this is unused in kernels 2.2 to 2.6
10415 #. type: Plain text
10416 #: build/C/man5/proc.5:2438
10417 msgid ""
10418 "I<age_limit> is the age in seconds after which dcache entries can be "
10419 "reclaimed when memory is short."
10420 msgstr ""
10421
10422 #.  looks like this is unused in kernels 2.2 to 2.6
10423 #. type: Plain text
10424 #: build/C/man5/proc.5:2443
10425 msgid ""
10426 "I<want_pages> is nonzero when the kernel has called shrink_dcache_pages() "
10427 "and the dcache isn't pruned yet."
10428 msgstr ""
10429
10430 #. type: TP
10431 #: build/C/man5/proc.5:2444
10432 #, no-wrap
10433 msgid "I</proc/sys/fs/dir-notify-enable>"
10434 msgstr ""
10435
10436 #. type: Plain text
10437 #: build/C/man5/proc.5:2453
10438 msgid ""
10439 "This file can be used to disable or enable the I<dnotify> interface "
10440 "described in B<fcntl>(2)  on a system-wide basis.  A value of 0 in this file "
10441 "disables the interface, and a value of 1 enables it."
10442 msgstr ""
10443
10444 #. type: TP
10445 #: build/C/man5/proc.5:2453
10446 #, no-wrap
10447 msgid "I</proc/sys/fs/dquot-max>"
10448 msgstr ""
10449
10450 #. type: Plain text
10451 #: build/C/man5/proc.5:2460
10452 msgid ""
10453 "This file shows the maximum number of cached disk quota entries.  On some "
10454 "(2.4) systems, it is not present.  If the number of free cached disk quota "
10455 "entries is very low and you have some awesome number of simultaneous system "
10456 "users, you might want to raise the limit."
10457 msgstr ""
10458
10459 #. type: TP
10460 #: build/C/man5/proc.5:2460
10461 #, no-wrap
10462 msgid "I</proc/sys/fs/dquot-nr>"
10463 msgstr ""
10464
10465 #. type: Plain text
10466 #: build/C/man5/proc.5:2464
10467 msgid ""
10468 "This file shows the number of allocated disk quota entries and the number of "
10469 "free disk quota entries."
10470 msgstr ""
10471
10472 #. type: TP
10473 #: build/C/man5/proc.5:2464
10474 #, no-wrap
10475 msgid "I</proc/sys/fs/epoll> (since Linux 2.6.28)"
10476 msgstr ""
10477
10478 #. type: Plain text
10479 #: build/C/man5/proc.5:2473
10480 msgid ""
10481 "This directory contains the file I<max_user_watches>, which can be used to "
10482 "limit the amount of kernel memory consumed by the I<epoll> interface.  For "
10483 "further details, see B<epoll>(7)."
10484 msgstr ""
10485
10486 #. type: TP
10487 #: build/C/man5/proc.5:2473
10488 #, no-wrap
10489 msgid "I</proc/sys/fs/file-max>"
10490 msgstr ""
10491
10492 #. type: Plain text
10493 #: build/C/man5/proc.5:2486
10494 msgid ""
10495 "This file defines a system-wide limit on the number of open files for all "
10496 "processes.  (See also B<setrlimit>(2), which can be used by a process to set "
10497 "the per-process limit, B<RLIMIT_NOFILE>, on the number of files it may "
10498 "open.)  If you get lots of error messages in the kernel log about running "
10499 "out of file handles (look for \"VFS: file-max limit E<lt>numberE<gt> "
10500 "reached\"), try increasing this value:"
10501 msgstr ""
10502
10503 #. type: Plain text
10504 #: build/C/man5/proc.5:2492
10505 #, no-wrap
10506 msgid "CW<    echo 100000 E<gt> /proc/sys/fs/file-max>\n"
10507 msgstr ""
10508
10509 #. type: Plain text
10510 #: build/C/man5/proc.5:2499
10511 msgid ""
10512 "The kernel constant B<NR_OPEN> imposes an upper limit on the value that may "
10513 "be placed in I<file-max>."
10514 msgstr ""
10515
10516 #. type: Plain text
10517 #: build/C/man5/proc.5:2505
10518 msgid "Privileged processes (B<CAP_SYS_ADMIN>)  can override the I<file-max> limit."
10519 msgstr ""
10520
10521 #. type: TP
10522 #: build/C/man5/proc.5:2505
10523 #, no-wrap
10524 msgid "I</proc/sys/fs/file-nr>"
10525 msgstr ""
10526
10527 #. type: Plain text
10528 #: build/C/man5/proc.5:2524
10529 msgid ""
10530 "This (read-only) file contains three numbers: the number of allocated file "
10531 "handles (i.e., the number of files presently opened); the number of free "
10532 "file handles; and the maximum number of file handles (i.e., the same value "
10533 "as I</proc/sys/fs/file-max>).  If the number of allocated file handles is "
10534 "close to the maximum, you should consider increasing the maximum.  Before "
10535 "Linux 2.6, the kernel allocated file handles dynamically, but it didn't free "
10536 "them again.  Instead the free file handles were kept in a list for "
10537 "reallocation; the \"free file handles\" value indicates the size of that "
10538 "list.  A large number of free file handles indicates that there was a past "
10539 "peak in the usage of open file handles.  Since Linux 2.6, the kernel does "
10540 "deallocate freed file handles, and the \"free file handles\" value is always "
10541 "zero."
10542 msgstr ""
10543
10544 #. type: TP
10545 #: build/C/man5/proc.5:2524
10546 #, no-wrap
10547 msgid "I</proc/sys/fs/inode-max> (only present until Linux 2.2)"
10548 msgstr ""
10549
10550 #. type: Plain text
10551 #: build/C/man5/proc.5:2533
10552 msgid ""
10553 "This file contains the maximum number of in-memory inodes.  This value "
10554 "should be 3-4 times larger than the value in I<file-max>, since I<stdin>, "
10555 "I<stdout> and network sockets also need an inode to handle them.  When you "
10556 "regularly run out of inodes, you need to increase this value."
10557 msgstr ""
10558
10559 #. type: Plain text
10560 #: build/C/man5/proc.5:2537
10561 msgid ""
10562 "Starting with Linux 2.4, there is no longer a static limit on the number of "
10563 "inodes, and this file is removed."
10564 msgstr ""
10565
10566 #. type: TP
10567 #: build/C/man5/proc.5:2537
10568 #, no-wrap
10569 msgid "I</proc/sys/fs/inode-nr>"
10570 msgstr ""
10571
10572 #. type: Plain text
10573 #: build/C/man5/proc.5:2541
10574 msgid "This file contains the first two values from I<inode-state>."
10575 msgstr ""
10576
10577 #. type: TP
10578 #: build/C/man5/proc.5:2541
10579 #, no-wrap
10580 msgid "I</proc/sys/fs/inode-state>"
10581 msgstr ""
10582
10583 #. type: Plain text
10584 #: build/C/man5/proc.5:2549
10585 msgid ""
10586 "This file contains seven numbers: I<nr_inodes>, I<nr_free_inodes>, "
10587 "I<preshrink>, and four dummy values (always zero)."
10588 msgstr ""
10589
10590 #.  This can be slightly more than
10591 #.  .I inode-max
10592 #.  because Linux allocates them one page full at a time.
10593 #. type: Plain text
10594 #: build/C/man5/proc.5:2557
10595 msgid ""
10596 "I<nr_inodes> is the number of inodes the system has allocated.  "
10597 "I<nr_free_inodes> represents the number of free inodes."
10598 msgstr ""
10599
10600 #. type: Plain text
10601 #: build/C/man5/proc.5:2565
10602 msgid ""
10603 "I<preshrink> is nonzero when the I<nr_inodes> E<gt> I<inode-max> and the "
10604 "system needs to prune the inode list instead of allocating more; since Linux "
10605 "2.4, this field is a dummy value (always zero)."
10606 msgstr ""
10607
10608 #. type: TP
10609 #: build/C/man5/proc.5:2565
10610 #, no-wrap
10611 msgid "I</proc/sys/fs/inotify> (since Linux 2.6.13)"
10612 msgstr ""
10613
10614 #. type: Plain text
10615 #: build/C/man5/proc.5:2574
10616 msgid ""
10617 "This directory contains files I<max_queued_events>, I<max_user_instances>, "
10618 "and I<max_user_watches>, that can be used to limit the amount of kernel "
10619 "memory consumed by the I<inotify> interface.  For further details, see "
10620 "B<inotify>(7)."
10621 msgstr ""
10622
10623 #. type: TP
10624 #: build/C/man5/proc.5:2574
10625 #, no-wrap
10626 msgid "I</proc/sys/fs/lease-break-time>"
10627 msgstr ""
10628
10629 #. type: Plain text
10630 #: build/C/man5/proc.5:2583
10631 msgid ""
10632 "This file specifies the grace period that the kernel grants to a process "
10633 "holding a file lease (B<fcntl>(2))  after it has sent a signal to that "
10634 "process notifying it that another process is waiting to open the file.  If "
10635 "the lease holder does not remove or downgrade the lease within this grace "
10636 "period, the kernel forcibly breaks the lease."
10637 msgstr ""
10638
10639 #. type: TP
10640 #: build/C/man5/proc.5:2583
10641 #, no-wrap
10642 msgid "I</proc/sys/fs/leases-enable>"
10643 msgstr ""
10644
10645 #. type: Plain text
10646 #: build/C/man5/proc.5:2590
10647 msgid ""
10648 "This file can be used to enable or disable file leases (B<fcntl>(2))  on a "
10649 "system-wide basis.  If this file contains the value 0, leases are disabled.  "
10650 "A nonzero value enables leases."
10651 msgstr ""
10652
10653 #. type: TP
10654 #: build/C/man5/proc.5:2590
10655 #, no-wrap
10656 msgid "I</proc/sys/fs/mqueue> (since Linux 2.6.6)"
10657 msgstr ""
10658
10659 #. type: Plain text
10660 #: build/C/man5/proc.5:2598
10661 msgid ""
10662 "This directory contains files I<msg_max>, I<msgsize_max>, and I<queues_max>, "
10663 "controlling the resources used by POSIX message queues.  See "
10664 "B<mq_overview>(7)  for details."
10665 msgstr ""
10666
10667 #. type: TP
10668 #: build/C/man5/proc.5:2598
10669 #, no-wrap
10670 msgid "I</proc/sys/fs/overflowgid> and I</proc/sys/fs/overflowuid>"
10671 msgstr ""
10672
10673 #. type: Plain text
10674 #: build/C/man5/proc.5:2608
10675 msgid ""
10676 "These files allow you to change the value of the fixed UID and GID.  The "
10677 "default is 65534.  Some filesystems support only 16-bit UIDs and GIDs, "
10678 "although in Linux UIDs and GIDs are 32 bits.  When one of these filesystems "
10679 "is mounted with writes enabled, any UID or GID that would exceed 65535 is "
10680 "translated to the overflow value before being written to disk."
10681 msgstr ""
10682
10683 #. type: TP
10684 #: build/C/man5/proc.5:2608
10685 #, no-wrap
10686 msgid "I</proc/sys/fs/pipe-max-size> (since Linux 2.6.35)"
10687 msgstr ""
10688
10689 #. type: Plain text
10690 #: build/C/man5/proc.5:2622
10691 msgid ""
10692 "The value in this file defines an upper limit for raising the capacity of a "
10693 "pipe using the B<fcntl>(2)  B<F_SETPIPE_SZ> operation.  This limit applies "
10694 "only to unprivileged processes.  The default value for this file is "
10695 "1,048,576.  The value assigned to this file may be rounded upward, to "
10696 "reflect the value actually employed for a convenient implementation.  To "
10697 "determine the rounded-up value, display the contents of this file after "
10698 "assigning a value to it.  The minimum value that can be assigned to this "
10699 "file is the system page size."
10700 msgstr ""
10701
10702 #. type: TP
10703 #: build/C/man5/proc.5:2622
10704 #, no-wrap
10705 msgid "I</proc/sys/fs/protected_hardlinks> (since Linux 3.6)"
10706 msgstr ""
10707
10708 #.  commit 800179c9b8a1e796e441674776d11cd4c05d61d7
10709 #. type: Plain text
10710 #: build/C/man5/proc.5:2631
10711 msgid ""
10712 "When the value in this file is 0, no restrictions are placed on the creation "
10713 "of hard links (i.e., this is the historical behaviour before Linux 3.6).  "
10714 "When the value in this file is 1, a hard link can be created to a target "
10715 "file only if one of the following conditions is true:"
10716 msgstr ""
10717
10718 #. type: Plain text
10719 #: build/C/man5/proc.5:2636
10720 msgid "The caller has the B<CAP_FOWNER> capability."
10721 msgstr ""
10722
10723 #. type: Plain text
10724 #: build/C/man5/proc.5:2642
10725 msgid ""
10726 "The filesystem UID of the process creating the link matches the owner (UID) "
10727 "of the target file (as described in B<credentials>(7), a process's "
10728 "filesystem UID is normally the same as its effective UID)."
10729 msgstr ""
10730
10731 #. type: Plain text
10732 #: build/C/man5/proc.5:2644
10733 msgid "All of the following conditions are true:"
10734 msgstr ""
10735
10736 #. type: Plain text
10737 #: build/C/man5/proc.5:2647
10738 msgid "the target is a regular file;"
10739 msgstr ""
10740
10741 #. type: Plain text
10742 #: build/C/man5/proc.5:2649
10743 msgid "the target file does not have its set-user-ID permission bit enabled;"
10744 msgstr ""
10745
10746 #. type: Plain text
10747 #: build/C/man5/proc.5:2652
10748 msgid ""
10749 "the target file does not have both its set-group-ID and group-executable "
10750 "permission bits enabled; and"
10751 msgstr ""
10752
10753 #. type: Plain text
10754 #: build/C/man5/proc.5:2656
10755 msgid ""
10756 "the caller has permission to read and write the target file (either via the "
10757 "file's permissions mask or because it has suitable capabilities)."
10758 msgstr ""
10759
10760 #. type: Plain text
10761 #: build/C/man5/proc.5:2672
10762 msgid ""
10763 "The default value in this file is 0.  Setting the value to 1 prevents a "
10764 "longstanding class of security issues caused by hard-link-based "
10765 "time-of-check, time-of-use races, most commonly seen in world-writable "
10766 "directories such as I</tmp>.  The common method of exploiting this flaw is "
10767 "to cross privilege boundaries when following a given hard link (i.e., a root "
10768 "process follows a hard link created by another user).  Additionally, on "
10769 "systems without separated partitions, this stops unauthorized users from "
10770 "\"pinning\" vulnerable set-user-ID and set-group-ID files against being "
10771 "upgraded by the administrator, or linking to special files."
10772 msgstr ""
10773
10774 #. type: TP
10775 #: build/C/man5/proc.5:2672
10776 #, no-wrap
10777 msgid "I</proc/sys/fs/protected_symlinks> (since Linux 3.6)"
10778 msgstr ""
10779
10780 #.  commit 800179c9b8a1e796e441674776d11cd4c05d61d7
10781 #. type: Plain text
10782 #: build/C/man5/proc.5:2680
10783 msgid ""
10784 "When the value in this file is 0, no restrictions are placed on following "
10785 "symbolic links (i.e., this is the historical behaviour before Linux 3.6).  "
10786 "When the value in this file is 1, symbolic links are followed only in the "
10787 "following circumstances:"
10788 msgstr ""
10789
10790 #. type: Plain text
10791 #: build/C/man5/proc.5:2687
10792 msgid ""
10793 "the filesystem UID of the process following the link matches the owner (UID) "
10794 "of the symbolic link (as described in B<credentials>(7), a process's "
10795 "filesystem UID is normally the same as its effective UID);"
10796 msgstr ""
10797
10798 #. type: Plain text
10799 #: build/C/man5/proc.5:2689
10800 msgid "the link is not in a sticky world-writable directory; or"
10801 msgstr ""
10802
10803 #. type: Plain text
10804 #: build/C/man5/proc.5:2691
10805 msgid "the symbolic link and and its parent directory have the same owner (UID)"
10806 msgstr ""
10807
10808 #. type: Plain text
10809 #: build/C/man5/proc.5:2698
10810 msgid ""
10811 "A system call that fails to follow a symbolic link because of the above "
10812 "restrictions returns the error B<EACCES> in I<errno>."
10813 msgstr ""
10814
10815 #. type: Plain text
10816 #: build/C/man5/proc.5:2702
10817 msgid ""
10818 "The default value in this file is 0.  Setting the value to 1 avoids a "
10819 "longstanding class of security issues based on time-of-check, time-of-use "
10820 "races when accessing symbolic links."
10821 msgstr ""
10822
10823 #. type: TP
10824 #: build/C/man5/proc.5:2702
10825 #, no-wrap
10826 msgid "I</proc/sys/fs/suid_dumpable> (since Linux 2.6.13)"
10827 msgstr ""
10828
10829 #.  The following is based on text from Documentation/sysctl/kernel.txt
10830 #. type: Plain text
10831 #: build/C/man5/proc.5:2708
10832 msgid ""
10833 "The value in this file determines whether core dump files are produced for "
10834 "set-user-ID or otherwise protected/tainted binaries.  Three different "
10835 "integer values can be specified:"
10836 msgstr ""
10837
10838 #. type: TP
10839 #: build/C/man5/proc.5:2709
10840 #, no-wrap
10841 msgid "I<0\\ (default)>"
10842 msgstr ""
10843
10844 #. type: Plain text
10845 #: build/C/man5/proc.5:2718
10846 msgid ""
10847 "This provides the traditional (pre-Linux 2.6.13) behavior.  A core dump will "
10848 "not be produced for a process which has changed credentials (by calling "
10849 "B<seteuid>(2), B<setgid>(2), or similar, or by executing a set-user-ID or "
10850 "set-group-ID program)  or whose binary does not have read permission "
10851 "enabled."
10852 msgstr ""
10853
10854 #. type: TP
10855 #: build/C/man5/proc.5:2718
10856 #, no-wrap
10857 msgid "I<1\\ (\"debug\")>"
10858 msgstr ""
10859
10860 #. type: Plain text
10861 #: build/C/man5/proc.5:2725
10862 msgid ""
10863 "All processes dump core when possible.  The core dump is owned by the "
10864 "filesystem user ID of the dumping process and no security is applied.  This "
10865 "is intended for system debugging situations only.  Ptrace is unchecked."
10866 msgstr ""
10867
10868 #. type: TP
10869 #: build/C/man5/proc.5:2725
10870 #, no-wrap
10871 msgid "I<2\\ (\"suidsafe\")>"
10872 msgstr ""
10873
10874 #. type: Plain text
10875 #: build/C/man5/proc.5:2734
10876 msgid ""
10877 "Any binary which normally would not be dumped (see \"0\" above)  is dumped "
10878 "readable by root only.  This allows the user to remove the core dump file "
10879 "but not to read it.  For security reasons core dumps in this mode will not "
10880 "overwrite one another or other files.  This mode is appropriate when "
10881 "administrators are attempting to debug problems in a normal environment."
10882 msgstr ""
10883
10884 #.  9520628e8ceb69fa9a4aee6b57f22675d9e1b709
10885 #.  54b501992dd2a839e94e76aa392c392b55080ce8
10886 #. type: Plain text
10887 #: build/C/man5/proc.5:2745
10888 msgid ""
10889 "Additionally, since Linux 3.6, I</proc/sys/kernel/core_pattern> must either "
10890 "be an absolute pathname or a pipe command, as detailed in B<core>(5).  "
10891 "Warnings will be written to the kernel log if I<core_pattern> does not "
10892 "follow these rules, and no core dump will be produced."
10893 msgstr ""
10894
10895 #. type: TP
10896 #: build/C/man5/proc.5:2746
10897 #, no-wrap
10898 msgid "I</proc/sys/fs/super-max>"
10899 msgstr ""
10900
10901 #. type: Plain text
10902 #: build/C/man5/proc.5:2757
10903 msgid ""
10904 "This file controls the maximum number of superblocks, and thus the maximum "
10905 "number of mounted filesystems the kernel can have.  You need increase only "
10906 "I<super-max> if you need to mount more filesystems than the current value in "
10907 "I<super-max> allows you to."
10908 msgstr ""
10909
10910 #. type: TP
10911 #: build/C/man5/proc.5:2757
10912 #, no-wrap
10913 msgid "I</proc/sys/fs/super-nr>"
10914 msgstr ""
10915
10916 #. type: Plain text
10917 #: build/C/man5/proc.5:2761
10918 msgid "This file contains the number of filesystems currently mounted."
10919 msgstr ""
10920
10921 #. type: TP
10922 #: build/C/man5/proc.5:2761
10923 #, no-wrap
10924 msgid "I</proc/sys/kernel>"
10925 msgstr ""
10926
10927 #. type: Plain text
10928 #: build/C/man5/proc.5:2765
10929 msgid ""
10930 "This directory contains files controlling a range of kernel parameters, as "
10931 "described below."
10932 msgstr ""
10933
10934 #. type: TP
10935 #: build/C/man5/proc.5:2765
10936 #, no-wrap
10937 msgid "I</proc/sys/kernel/acct>"
10938 msgstr ""
10939
10940 #. type: Plain text
10941 #: build/C/man5/proc.5:2789
10942 msgid ""
10943 "This file contains three numbers: I<highwater>, I<lowwater>, and "
10944 "I<frequency>.  If BSD-style process accounting is enabled these values "
10945 "control its behavior.  If free space on filesystem where the log lives goes "
10946 "below I<lowwater> percent accounting suspends.  If free space gets above "
10947 "I<highwater> percent accounting resumes.  I<frequency> determines how often "
10948 "the kernel checks the amount of free space (value is in seconds).  Default "
10949 "values are 4, 2 and 30.  That is, suspend accounting if 2% or less space is "
10950 "free; resume it if 4% or more space is free; consider information about "
10951 "amount of free space valid for 30 seconds."
10952 msgstr ""
10953
10954 #. type: TP
10955 #: build/C/man5/proc.5:2789
10956 #, no-wrap
10957 msgid "I</proc/sys/kernel/cap_last_cap> (since Linux 3.2)"
10958 msgstr ""
10959
10960 #. type: Plain text
10961 #: build/C/man5/proc.5:2793
10962 msgid "See B<capabilities>(7)."
10963 msgstr ""
10964
10965 #. type: TP
10966 #: build/C/man5/proc.5:2793
10967 #, no-wrap
10968 msgid "I</proc/sys/kernel/cap-bound> (from Linux 2.2 to 2.6.24)"
10969 msgstr ""
10970
10971 #. type: Plain text
10972 #: build/C/man5/proc.5:2805
10973 msgid ""
10974 "This file holds the value of the kernel I<capability bounding set> "
10975 "(expressed as a signed decimal number).  This set is ANDed against the "
10976 "capabilities permitted to a process during B<execve>(2).  Starting with "
10977 "Linux 2.6.25, the system-wide capability bounding set disappeared, and was "
10978 "replaced by a per-thread bounding set; see B<capabilities>(7)."
10979 msgstr ""
10980
10981 #. type: TP
10982 #: build/C/man5/proc.5:2805
10983 #, no-wrap
10984 msgid "I</proc/sys/kernel/core_pattern>"
10985 msgstr ""
10986
10987 #. type: TP
10988 #: build/C/man5/proc.5:2809
10989 #, no-wrap
10990 msgid "I</proc/sys/kernel/core_uses_pid>"
10991 msgstr ""
10992
10993 #. type: TP
10994 #: build/C/man5/proc.5:2813
10995 #, no-wrap
10996 msgid "I</proc/sys/kernel/ctrl-alt-del>"
10997 msgstr ""
10998
10999 #. type: Plain text
11000 #: build/C/man5/proc.5:2828
11001 msgid ""
11002 "This file controls the handling of Ctrl-Alt-Del from the keyboard.  When the "
11003 "value in this file is 0, Ctrl-Alt-Del is trapped and sent to the B<init>(8)  "
11004 "program to handle a graceful restart.  When the value is greater than zero, "
11005 "Linux's reaction to a Vulcan Nerve Pinch (tm) will be an immediate reboot, "
11006 "without even syncing its dirty buffers.  Note: when a program (like dosemu) "
11007 "has the keyboard in \"raw\" mode, the ctrl-alt-del is intercepted by the "
11008 "program before it ever reaches the kernel tty layer, and it's up to the "
11009 "program to decide what to do with it."
11010 msgstr ""
11011
11012 #. type: TP
11013 #: build/C/man5/proc.5:2828
11014 #, no-wrap
11015 msgid "I</proc/sys/kernel/dmesg_restrict> (since Linux 2.6.37)"
11016 msgstr ""
11017
11018 #.  commit 620f6e8e855d6d447688a5f67a4e176944a084e8
11019 #. type: Plain text
11020 #: build/C/man5/proc.5:2841
11021 msgid ""
11022 "The value in this file determines who can see kernel syslog contents.  A "
11023 "value of 0 in this file imposes no restrictions.  If the value is 1, only "
11024 "privileged users can read the kernel syslog.  (See B<syslog>(2)  for more "
11025 "details.)  Since Linux 3.4, only users with the B<CAP_SYS_ADMIN> capability "
11026 "may change the value in this file."
11027 msgstr ""
11028
11029 #. type: TP
11030 #: build/C/man5/proc.5:2841
11031 #, no-wrap
11032 msgid "I</proc/sys/kernel/domainname> and I</proc/sys/kernel/hostname>"
11033 msgstr ""
11034
11035 #. type: Plain text
11036 #: build/C/man5/proc.5:2849
11037 msgid ""
11038 "can be used to set the NIS/YP domainname and the hostname of your box in "
11039 "exactly the same way as the commands B<domainname>(1)  and B<hostname>(1), "
11040 "that is:"
11041 msgstr ""
11042
11043 #. type: Plain text
11044 #: build/C/man5/proc.5:2854
11045 #, no-wrap
11046 msgid ""
11047 "#B< echo \\(aqdarkstar\\(aq E<gt> /proc/sys/kernel/hostname>\n"
11048 "#B< echo \\(aqmydomain\\(aq E<gt> /proc/sys/kernel/domainname>\n"
11049 msgstr ""
11050
11051 #. type: Plain text
11052 #: build/C/man5/proc.5:2858
11053 msgid "has the same effect as"
11054 msgstr ""
11055
11056 #. type: Plain text
11057 #: build/C/man5/proc.5:2863
11058 #, no-wrap
11059 msgid ""
11060 "#B< hostname \\(aqdarkstar\\(aq>\n"
11061 "#B< domainname \\(aqmydomain\\(aq>\n"
11062 msgstr ""
11063
11064 #. type: Plain text
11065 #: build/C/man5/proc.5:2876
11066 msgid ""
11067 "Note, however, that the classic darkstar.frop.org has the hostname "
11068 "\"darkstar\" and DNS (Internet Domain Name Server)  domainname \"frop.org\", "
11069 "not to be confused with the NIS (Network Information Service) or YP (Yellow "
11070 "Pages) domainname.  These two domain names are in general different.  For a "
11071 "detailed discussion see the B<hostname>(1)  man page."
11072 msgstr ""
11073
11074 #. type: TP
11075 #: build/C/man5/proc.5:2876
11076 #, no-wrap
11077 msgid "I</proc/sys/kernel/hotplug>"
11078 msgstr ""
11079
11080 #. type: Plain text
11081 #: build/C/man5/proc.5:2882
11082 msgid ""
11083 "This file contains the path for the hotplug policy agent.  The default value "
11084 "in this file is I</sbin/hotplug>."
11085 msgstr ""
11086
11087 #. type: TP
11088 #: build/C/man5/proc.5:2882
11089 #, no-wrap
11090 msgid "I</proc/sys/kernel/htab-reclaim>"
11091 msgstr ""
11092
11093 #. type: Plain text
11094 #: build/C/man5/proc.5:2890
11095 msgid ""
11096 "(PowerPC only) If this file is set to a nonzero value, the PowerPC htab (see "
11097 "kernel file I<Documentation/powerpc/ppc_htab.txt>)  is pruned each time the "
11098 "system hits the idle loop."
11099 msgstr ""
11100
11101 #. type: TP
11102 #: build/C/man5/proc.5:2890
11103 #, no-wrap
11104 msgid "I</proc/sys/kernel/kptr_restrict> (since Linux 2.6.38)"
11105 msgstr ""
11106
11107 #.  455cd5ab305c90ffc422dd2e0fb634730942b257
11108 #.  commit 411f05f123cbd7f8aa1edcae86970755a6e2a9d9
11109 #.  commit 620f6e8e855d6d447688a5f67a4e176944a084e8
11110 #. type: Plain text
11111 #: build/C/man5/proc.5:2915
11112 msgid ""
11113 "The value in this file determines whether kernel addresses are exposed via "
11114 "I</proc> files and other interfaces.  A value of 0 in this file imposes no "
11115 "restrictions.  If the value is 1, kernel pointers printed using the I<%pK> "
11116 "format specifier will be replaced with zeros unless the user has the "
11117 "B<CAP_SYSLOG> capability.  If the value is 2, kernel pointers printed using "
11118 "the I<%pK> format specifier will be replaced with zeros regardless of the "
11119 "user's capabilities.  The initial default value for this file was 1, but the "
11120 "default was changed to 0 in Linux 2.6.39.  Since Linux 3.4, only users with "
11121 "the B<CAP_SYS_ADMIN> capability can change the value in this file."
11122 msgstr ""
11123
11124 #. type: TP
11125 #: build/C/man5/proc.5:2915
11126 #, no-wrap
11127 msgid "I</proc/sys/kernel/l2cr>"
11128 msgstr ""
11129
11130 #. type: Plain text
11131 #: build/C/man5/proc.5:2922
11132 msgid ""
11133 "(PowerPC only) This file contains a flag that controls the L2 cache of G3 "
11134 "processor boards.  If 0, the cache is disabled.  Enabled if nonzero."
11135 msgstr ""
11136
11137 #. type: TP
11138 #: build/C/man5/proc.5:2922
11139 #, no-wrap
11140 msgid "I</proc/sys/kernel/modprobe>"
11141 msgstr ""
11142
11143 #. type: Plain text
11144 #: build/C/man5/proc.5:2935
11145 msgid ""
11146 "This file contains the path for the kernel module loader.  The default value "
11147 "is I</sbin/modprobe>.  The file is present only if the kernel is built with "
11148 "the B<CONFIG_MODULES> (B<CONFIG_KMOD> in Linux 2.6.26 and earlier)  option "
11149 "enabled.  It is described by the Linux kernel source file "
11150 "I<Documentation/kmod.txt> (present only in kernel 2.4 and earlier)."
11151 msgstr ""
11152
11153 #. type: TP
11154 #: build/C/man5/proc.5:2935
11155 #, no-wrap
11156 msgid "I</proc/sys/kernel/modules_disabled> (since Linux 2.6.31)"
11157 msgstr ""
11158
11159 #.  3d43321b7015387cfebbe26436d0e9d299162ea1
11160 #.  From Documentation/sysctl/kernel.txt
11161 #. type: Plain text
11162 #: build/C/man5/proc.5:2947
11163 msgid ""
11164 "A toggle value indicating if modules are allowed to be loaded in an "
11165 "otherwise modular kernel.  This toggle defaults to off (0), but can be set "
11166 "true (1).  Once true, modules can be neither loaded nor unloaded, and the "
11167 "toggle cannot be set back to false.  The file is present only if the kernel "
11168 "is built with the B<CONFIG_MODULES> option enabled."
11169 msgstr ""
11170
11171 #. type: TP
11172 #: build/C/man5/proc.5:2947
11173 #, no-wrap
11174 msgid "I</proc/sys/kernel/msgmax>"
11175 msgstr ""
11176
11177 #. type: Plain text
11178 #: build/C/man5/proc.5:2952
11179 msgid ""
11180 "This file defines a system-wide limit specifying the maximum number of bytes "
11181 "in a single message written on a System V message queue."
11182 msgstr ""
11183
11184 #. type: TP
11185 #: build/C/man5/proc.5:2952
11186 #, no-wrap
11187 msgid "I</proc/sys/kernel/msgmni> (since Linux 2.4)"
11188 msgstr ""
11189
11190 #. type: Plain text
11191 #: build/C/man5/proc.5:2956
11192 msgid ""
11193 "This file defines the system-wide limit on the number of message queue "
11194 "identifiers."
11195 msgstr ""
11196
11197 #. type: TP
11198 #: build/C/man5/proc.5:2956
11199 #, no-wrap
11200 msgid "I</proc/sys/kernel/msgmnb>"
11201 msgstr ""
11202
11203 #. type: Plain text
11204 #: build/C/man5/proc.5:2965
11205 msgid ""
11206 "This file defines a system-wide parameter used to initialize the "
11207 "I<msg_qbytes> setting for subsequently created message queues.  The "
11208 "I<msg_qbytes> setting specifies the maximum number of bytes that may be "
11209 "written to the message queue."
11210 msgstr ""
11211
11212 #. type: TP
11213 #: build/C/man5/proc.5:2965
11214 #, no-wrap
11215 msgid "I</proc/sys/kernel/ostype> and I</proc/sys/kernel/osrelease>"
11216 msgstr ""
11217
11218 #. type: Plain text
11219 #: build/C/man5/proc.5:2970
11220 msgid "These files give substrings of I</proc/version>."
11221 msgstr ""
11222
11223 #. type: TP
11224 #: build/C/man5/proc.5:2970
11225 #, no-wrap
11226 msgid "I</proc/sys/kernel/overflowgid> and I</proc/sys/kernel/overflowuid>"
11227 msgstr ""
11228
11229 #. type: Plain text
11230 #: build/C/man5/proc.5:2976
11231 msgid ""
11232 "These files duplicate the files I</proc/sys/fs/overflowgid> and "
11233 "I</proc/sys/fs/overflowuid>."
11234 msgstr ""
11235
11236 #. type: TP
11237 #: build/C/man5/proc.5:2976
11238 #, no-wrap
11239 msgid "I</proc/sys/kernel/panic>"
11240 msgstr ""
11241
11242 #. type: Plain text
11243 #: build/C/man5/proc.5:2985
11244 msgid ""
11245 "This file gives read/write access to the kernel variable I<panic_timeout>.  "
11246 "If this is zero, the kernel will loop on a panic; if nonzero it indicates "
11247 "that the kernel should autoreboot after this number of seconds.  When you "
11248 "use the software watchdog device driver, the recommended setting is 60."
11249 msgstr ""
11250
11251 #. type: TP
11252 #: build/C/man5/proc.5:2985
11253 #, no-wrap
11254 msgid "I</proc/sys/kernel/panic_on_oops> (since Linux 2.5.68)"
11255 msgstr ""
11256
11257 #. type: Plain text
11258 #: build/C/man5/proc.5:2997
11259 msgid ""
11260 "This file controls the kernel's behavior when an oops or BUG is "
11261 "encountered.  If this file contains 0, then the system tries to continue "
11262 "operation.  If it contains 1, then the system delays a few seconds (to give "
11263 "klogd time to record the oops output)  and then panics.  If the "
11264 "I</proc/sys/kernel/panic> file is also nonzero then the machine will be "
11265 "rebooted."
11266 msgstr ""
11267
11268 #. type: TP
11269 #: build/C/man5/proc.5:2997
11270 #, no-wrap
11271 msgid "I</proc/sys/kernel/pid_max> (since Linux 2.5.34)"
11272 msgstr ""
11273
11274 #.  Prior to 2.6.10, pid_max could also be raised above 32768 on 32-bit
11275 #.  platforms, but this broke /proc/[pid]
11276 #.  See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2
11277 #. type: Plain text
11278 #: build/C/man5/proc.5:3013
11279 msgid ""
11280 "This file specifies the value at which PIDs wrap around (i.e., the value in "
11281 "this file is one greater than the maximum PID).  The default value for this "
11282 "file, 32768, results in the same range of PIDs as on earlier kernels.  On "
11283 "32-bit platforms, 32768 is the maximum value for I<pid_max>.  On 64-bit "
11284 "systems, I<pid_max> can be set to any value up to 2^22 (B<PID_MAX_LIMIT>, "
11285 "approximately 4 million)."
11286 msgstr ""
11287
11288 #. type: TP
11289 #: build/C/man5/proc.5:3013
11290 #, no-wrap
11291 msgid "I</proc/sys/kernel/powersave-nap> (PowerPC only)"
11292 msgstr ""
11293
11294 #. type: Plain text
11295 #: build/C/man5/proc.5:3019
11296 msgid ""
11297 "This file contains a flag.  If set, Linux-PPC will use the \"nap\" mode of "
11298 "powersaving, otherwise the \"doze\" mode will be used."
11299 msgstr ""
11300
11301 #. type: TP
11302 #: build/C/man5/proc.5:3019
11303 #, no-wrap
11304 msgid "I</proc/sys/kernel/printk>"
11305 msgstr ""
11306
11307 #. type: Plain text
11308 #: build/C/man5/proc.5:3045
11309 msgid ""
11310 "The four values in this file are I<console_loglevel>, "
11311 "I<default_message_loglevel>, I<minimum_console_level>, and "
11312 "I<default_console_loglevel>.  These values influence I<printk()> behavior "
11313 "when printing or logging error messages.  See B<syslog>(2)  for more info on "
11314 "the different loglevels.  Messages with a higher priority than "
11315 "I<console_loglevel> will be printed to the console.  Messages without an "
11316 "explicit priority will be printed with priority I<default_message_level>.  "
11317 "I<minimum_console_loglevel> is the minimum (highest) value to which "
11318 "I<console_loglevel> can be set.  I<default_console_loglevel> is the default "
11319 "value for I<console_loglevel>."
11320 msgstr ""
11321
11322 #. type: TP
11323 #: build/C/man5/proc.5:3045
11324 #, no-wrap
11325 msgid "I</proc/sys/kernel/pty> (since Linux 2.6.4)"
11326 msgstr ""
11327
11328 #. type: Plain text
11329 #: build/C/man5/proc.5:3051
11330 msgid ""
11331 "This directory contains two files relating to the number of UNIX 98 "
11332 "pseudoterminals (see B<pts>(4))  on the system."
11333 msgstr ""
11334
11335 #. type: TP
11336 #: build/C/man5/proc.5:3051
11337 #, no-wrap
11338 msgid "I</proc/sys/kernel/pty/max>"
11339 msgstr ""
11340
11341 #. type: Plain text
11342 #: build/C/man5/proc.5:3054
11343 msgid "This file defines the maximum number of pseudoterminals."
11344 msgstr ""
11345
11346 #. type: TP
11347 #: build/C/man5/proc.5:3054
11348 #, no-wrap
11349 msgid "I</proc/sys/kernel/pty/nr>"
11350 msgstr ""
11351
11352 #. type: Plain text
11353 #: build/C/man5/proc.5:3058
11354 msgid "This read-only file indicates how many pseudoterminals are currently in use."
11355 msgstr ""
11356
11357 #. type: TP
11358 #: build/C/man5/proc.5:3058
11359 #, no-wrap
11360 msgid "I</proc/sys/kernel/random>"
11361 msgstr ""
11362
11363 #. type: Plain text
11364 #: build/C/man5/proc.5:3066
11365 msgid ""
11366 "This directory contains various parameters controlling the operation of the "
11367 "file I</dev/random>.  See B<random>(4)  for further information."
11368 msgstr ""
11369
11370 #. type: TP
11371 #: build/C/man5/proc.5:3066
11372 #, no-wrap
11373 msgid "I</proc/sys/kernel/real-root-dev>"
11374 msgstr ""
11375
11376 #. type: Plain text
11377 #: build/C/man5/proc.5:3070
11378 msgid ""
11379 "This file is documented in the Linux kernel source file "
11380 "I<Documentation/initrd.txt>."
11381 msgstr ""
11382
11383 #. type: TP
11384 #: build/C/man5/proc.5:3070
11385 #, no-wrap
11386 msgid "I</proc/sys/kernel/reboot-cmd> (Sparc only) "
11387 msgstr ""
11388
11389 #. type: Plain text
11390 #: build/C/man5/proc.5:3076
11391 msgid ""
11392 "This file seems to be a way to give an argument to the SPARC ROM/Flash boot "
11393 "loader.  Maybe to tell it what to do after rebooting?"
11394 msgstr ""
11395
11396 #. type: TP
11397 #: build/C/man5/proc.5:3076
11398 #, no-wrap
11399 msgid "I</proc/sys/kernel/rtsig-max>"
11400 msgstr ""
11401
11402 #. type: Plain text
11403 #: build/C/man5/proc.5:3083
11404 msgid ""
11405 "(Only in kernels up to and including 2.6.7; see B<setrlimit>(2))  This file "
11406 "can be used to tune the maximum number of POSIX real-time (queued) signals "
11407 "that can be outstanding in the system."
11408 msgstr ""
11409
11410 #. type: TP
11411 #: build/C/man5/proc.5:3083
11412 #, no-wrap
11413 msgid "I</proc/sys/kernel/rtsig-nr>"
11414 msgstr ""
11415
11416 #. type: Plain text
11417 #: build/C/man5/proc.5:3087
11418 msgid ""
11419 "(Only in kernels up to and including 2.6.7.)  This file shows the number "
11420 "POSIX real-time signals currently queued."
11421 msgstr ""
11422
11423 #. type: TP
11424 #: build/C/man5/proc.5:3087
11425 #, no-wrap
11426 msgid "I</proc/sys/kernel/sched_rr_timeslice_ms> (since Linux 3.9)"
11427 msgstr ""
11428
11429 #. type: Plain text
11430 #: build/C/man5/proc.5:3091
11431 msgid "See B<sched_rr_get_interval>(2)."
11432 msgstr ""
11433
11434 #. type: TP
11435 #: build/C/man5/proc.5:3091
11436 #, no-wrap
11437 msgid "I</proc/sys/kernel/sem> (since Linux 2.4)"
11438 msgstr ""
11439
11440 #. type: Plain text
11441 #: build/C/man5/proc.5:3095
11442 msgid ""
11443 "This file contains 4 numbers defining limits for System V IPC semaphores.  "
11444 "These fields are, in order:"
11445 msgstr ""
11446
11447 #. type: IP
11448 #: build/C/man5/proc.5:3096
11449 #, no-wrap
11450 msgid "SEMMSL"
11451 msgstr ""
11452
11453 #. type: Plain text
11454 #: build/C/man5/proc.5:3098
11455 msgid "The maximum semaphores per semaphore set."
11456 msgstr ""
11457
11458 #. type: IP
11459 #: build/C/man5/proc.5:3098
11460 #, no-wrap
11461 msgid "SEMMNS"
11462 msgstr ""
11463
11464 #. type: Plain text
11465 #: build/C/man5/proc.5:3100
11466 msgid "A system-wide limit on the number of semaphores in all semaphore sets."
11467 msgstr ""
11468
11469 #. type: IP
11470 #: build/C/man5/proc.5:3100
11471 #, no-wrap
11472 msgid "SEMOPM"
11473 msgstr ""
11474
11475 #. type: Plain text
11476 #: build/C/man5/proc.5:3104
11477 msgid ""
11478 "The maximum number of operations that may be specified in a B<semop>(2)  "
11479 "call."
11480 msgstr ""
11481
11482 #. type: IP
11483 #: build/C/man5/proc.5:3104
11484 #, no-wrap
11485 msgid "SEMMNI"
11486 msgstr ""
11487
11488 #. type: Plain text
11489 #: build/C/man5/proc.5:3106
11490 msgid "A system-wide limit on the maximum number of semaphore identifiers."
11491 msgstr ""
11492
11493 #. type: TP
11494 #: build/C/man5/proc.5:3107
11495 #, no-wrap
11496 msgid "I</proc/sys/kernel/sg-big-buff>"
11497 msgstr ""
11498
11499 #. type: Plain text
11500 #: build/C/man5/proc.5:3118
11501 msgid ""
11502 "This file shows the size of the generic SCSI device (sg) buffer.  You can't "
11503 "tune it just yet, but you could change it at compile time by editing "
11504 "I<include/scsi/sg.h> and changing the value of B<SG_BIG_BUFF>.  However, "
11505 "there shouldn't be any reason to change this value."
11506 msgstr ""
11507
11508 #. type: TP
11509 #: build/C/man5/proc.5:3118
11510 #, no-wrap
11511 msgid "I</proc/sys/kernel/shm_rmid_forced> (since Linux 3.1)"
11512 msgstr ""
11513
11514 #.  commit b34a6b1da371ed8af1221459a18c67970f7e3d53
11515 #.  See also Documentation/sysctl/kernel.txt
11516 #. type: Plain text
11517 #: build/C/man5/proc.5:3127
11518 msgid ""
11519 "If this file is set to 1, all System V shared memory segments will be marked "
11520 "for destruction as soon as the number of attached processes falls to zero; "
11521 "in other words, it is no longer possible to create shared memory segments "
11522 "that exist independently of any attached process."
11523 msgstr ""
11524
11525 #. type: Plain text
11526 #: build/C/man5/proc.5:3139
11527 msgid ""
11528 "The effect is as though a B<shmctl>(2)  B<IPC_RMID> is performed on all "
11529 "existing segments as well as all segments created in the future (until this "
11530 "file is reset to 0).  Note that existing segments that are attached to no "
11531 "process will be immediately destroyed when this file is set to 1.  Setting "
11532 "this option will also destroy segments that were created, but never "
11533 "attached, upon termination of the process that created the segment with "
11534 "B<shmget>(2)."
11535 msgstr ""
11536
11537 #. type: Plain text
11538 #: build/C/man5/proc.5:3147
11539 msgid ""
11540 "Setting this file to 1 provides a way of ensuring that all System V shared "
11541 "memory segments are counted against the resource usage and resource limits "
11542 "(see the description of B<RLIMIT_AS> in B<getrlimit>(2))  of at least one "
11543 "process."
11544 msgstr ""
11545
11546 #. type: Plain text
11547 #: build/C/man5/proc.5:3154
11548 msgid ""
11549 "Because setting this file to 1 produces behavior that is nonstandard and "
11550 "could also break existing applications, the default value in this file is "
11551 "0.  Only set this file to 1 if you have a good understanding of the "
11552 "semantics of the applications using System V shared memory on your system."
11553 msgstr ""
11554
11555 #. type: TP
11556 #: build/C/man5/proc.5:3154
11557 #, no-wrap
11558 msgid "I</proc/sys/kernel/shmall>"
11559 msgstr ""
11560
11561 #. type: Plain text
11562 #: build/C/man5/proc.5:3159
11563 msgid ""
11564 "This file contains the system-wide limit on the total number of pages of "
11565 "System V shared memory."
11566 msgstr ""
11567
11568 #. type: TP
11569 #: build/C/man5/proc.5:3159
11570 #, no-wrap
11571 msgid "I</proc/sys/kernel/shmmax>"
11572 msgstr ""
11573
11574 #. type: Plain text
11575 #: build/C/man5/proc.5:3169
11576 msgid ""
11577 "This file can be used to query and set the run-time limit on the maximum "
11578 "(System V IPC) shared memory segment size that can be created.  Shared "
11579 "memory segments up to 1GB are now supported in the kernel.  This value "
11580 "defaults to B<SHMMAX>."
11581 msgstr ""
11582
11583 #. type: TP
11584 #: build/C/man5/proc.5:3169
11585 #, no-wrap
11586 msgid "I</proc/sys/kernel/shmmni> (since Linux 2.4)"
11587 msgstr ""
11588
11589 #. type: Plain text
11590 #: build/C/man5/proc.5:3174
11591 msgid ""
11592 "This file specifies the system-wide maximum number of System V shared memory "
11593 "segments that can be created."
11594 msgstr ""
11595
11596 #. type: TP
11597 #: build/C/man5/proc.5:3174
11598 #, no-wrap
11599 msgid "I</proc/sys/kernel/sysrq>"
11600 msgstr ""
11601
11602 #. type: Plain text
11603 #: build/C/man5/proc.5:3183
11604 msgid ""
11605 "This file controls the functions allowed to be invoked by the SysRq key.  By "
11606 "default, the file contains 1 meaning that every possible SysRq request is "
11607 "allowed (in older kernel versions, SysRq was disabled by default, and you "
11608 "were required to specifically enable it at run-time, but this is not the "
11609 "case any more).  Possible values in this file are:"
11610 msgstr ""
11611
11612 #. type: Plain text
11613 #: build/C/man5/proc.5:3195
11614 #, no-wrap
11615 msgid ""
11616 "   0 - disable sysrq completely\n"
11617 "   1 - enable all functions of sysrq\n"
11618 "  E<gt>1 - bit mask of allowed sysrq functions, as follows:\n"
11619 "          2 - enable control of console logging level\n"
11620 "          4 - enable control of keyboard (SAK, unraw)\n"
11621 "          8 - enable debugging dumps of processes etc.\n"
11622 "         16 - enable sync command\n"
11623 "         32 - enable remount read-only\n"
11624 "         64 - enable signalling of processes (term, kill, oom-kill)\n"
11625 "        128 - allow reboot/poweroff\n"
11626 "        256 - allow nicing of all real-time tasks\n"
11627 msgstr ""
11628
11629 #. type: Plain text
11630 #: build/C/man5/proc.5:3201
11631 msgid ""
11632 "This file is present only if the B<CONFIG_MAGIC_SYSRQ> kernel configuration "
11633 "option is enabled.  For further details see the Linux kernel source file "
11634 "I<Documentation/sysrq.txt>."
11635 msgstr ""
11636
11637 #. type: TP
11638 #: build/C/man5/proc.5:3201
11639 #, no-wrap
11640 msgid "I</proc/sys/kernel/version>"
11641 msgstr ""
11642
11643 #. type: Plain text
11644 #: build/C/man5/proc.5:3204
11645 msgid "This file contains a string like:"
11646 msgstr ""
11647
11648 #. type: Plain text
11649 #: build/C/man5/proc.5:3206
11650 #, no-wrap
11651 msgid "    #5 Wed Feb 25 21:49:24 MET 1998\n"
11652 msgstr ""
11653
11654 #. type: Plain text
11655 #: build/C/man5/proc.5:3210
11656 msgid ""
11657 "The \"#5\" means that this is the fifth kernel built from this source base "
11658 "and the date behind it indicates the time the kernel was built."
11659 msgstr ""
11660
11661 #. type: TP
11662 #: build/C/man5/proc.5:3210
11663 #, no-wrap
11664 msgid "I</proc/sys/kernel/threads-max> (since Linux 2.3.11)"
11665 msgstr ""
11666
11667 #. type: Plain text
11668 #: build/C/man5/proc.5:3214
11669 msgid ""
11670 "This file specifies the system-wide limit on the number of threads (tasks) "
11671 "that can be created on the system."
11672 msgstr ""
11673
11674 #. type: TP
11675 #: build/C/man5/proc.5:3214
11676 #, no-wrap
11677 msgid "I</proc/sys/kernel/zero-paged> (PowerPC only) "
11678 msgstr ""
11679
11680 #. type: Plain text
11681 #: build/C/man5/proc.5:3220
11682 msgid ""
11683 "This file contains a flag.  When enabled (nonzero), Linux-PPC will pre-zero "
11684 "pages in the idle loop, possibly speeding up get_free_pages."
11685 msgstr ""
11686
11687 #. type: TP
11688 #: build/C/man5/proc.5:3220
11689 #, no-wrap
11690 msgid "I</proc/sys/net>"
11691 msgstr ""
11692
11693 #. type: Plain text
11694 #: build/C/man5/proc.5:3227
11695 msgid ""
11696 "This directory contains networking stuff.  Explanations for some of the "
11697 "files under this directory can be found in B<tcp>(7)  and B<ip>(7)."
11698 msgstr ""
11699
11700 #. type: TP
11701 #: build/C/man5/proc.5:3227
11702 #, no-wrap
11703 msgid "I</proc/sys/net/core/somaxconn>"
11704 msgstr ""
11705
11706 #. type: Plain text
11707 #: build/C/man5/proc.5:3236
11708 msgid ""
11709 "This file defines a ceiling value for the I<backlog> argument of "
11710 "B<listen>(2); see the B<listen>(2)  manual page for details."
11711 msgstr ""
11712
11713 #. type: TP
11714 #: build/C/man5/proc.5:3236
11715 #, no-wrap
11716 msgid "I</proc/sys/proc>"
11717 msgstr ""
11718
11719 #. type: TP
11720 #: build/C/man5/proc.5:3239
11721 #, no-wrap
11722 msgid "I</proc/sys/sunrpc>"
11723 msgstr ""
11724
11725 #. type: Plain text
11726 #: build/C/man5/proc.5:3244
11727 msgid ""
11728 "This directory supports Sun remote procedure call for network filesystem "
11729 "(NFS).  On some systems, it is not present."
11730 msgstr ""
11731
11732 #. type: TP
11733 #: build/C/man5/proc.5:3244
11734 #, no-wrap
11735 msgid "I</proc/sys/vm>"
11736 msgstr ""
11737
11738 #. type: Plain text
11739 #: build/C/man5/proc.5:3248
11740 msgid ""
11741 "This directory contains files for memory management tuning, buffer and cache "
11742 "management."
11743 msgstr ""
11744
11745 #. type: TP
11746 #: build/C/man5/proc.5:3248
11747 #, no-wrap
11748 msgid "I</proc/sys/vm/drop_caches> (since Linux 2.6.16)"
11749 msgstr ""
11750
11751 #. type: Plain text
11752 #: build/C/man5/proc.5:3256
11753 msgid ""
11754 "Writing to this file causes the kernel to drop clean caches, dentries, and "
11755 "inodes from memory, causing that memory to become free.  This can be useful "
11756 "for memory management testing and performing reproducible filesystem "
11757 "benchmarks.  Because writing to this file causes the benefits of caching to "
11758 "be lost, it can degrade overall system performance."
11759 msgstr ""
11760
11761 #. type: Plain text
11762 #: build/C/man5/proc.5:3258
11763 msgid "To free pagecache, use:"
11764 msgstr ""
11765
11766 #. type: Plain text
11767 #: build/C/man5/proc.5:3260
11768 #, no-wrap
11769 msgid "    echo 1 E<gt> /proc/sys/vm/drop_caches\n"
11770 msgstr ""
11771
11772 #. type: Plain text
11773 #: build/C/man5/proc.5:3262
11774 msgid "To free dentries and inodes, use:"
11775 msgstr ""
11776
11777 #. type: Plain text
11778 #: build/C/man5/proc.5:3264
11779 #, no-wrap
11780 msgid "    echo 2 E<gt> /proc/sys/vm/drop_caches\n"
11781 msgstr ""
11782
11783 #. type: Plain text
11784 #: build/C/man5/proc.5:3266
11785 msgid "To free pagecache, dentries and inodes, use:"
11786 msgstr ""
11787
11788 #. type: Plain text
11789 #: build/C/man5/proc.5:3268
11790 #, no-wrap
11791 msgid "    echo 3 E<gt> /proc/sys/vm/drop_caches\n"
11792 msgstr ""
11793
11794 #. type: Plain text
11795 #: build/C/man5/proc.5:3274
11796 msgid ""
11797 "Because writing to this file is a nondestructive operation and dirty objects "
11798 "are not freeable, the user should run B<sync>(8)  first."
11799 msgstr ""
11800
11801 #. type: TP
11802 #: build/C/man5/proc.5:3274
11803 #, no-wrap
11804 msgid "I</proc/sys/vm/legacy_va_layout> (since Linux 2.6.9)"
11805 msgstr ""
11806
11807 #.  The following is from Documentation/filesystems/proc.txt
11808 #. type: Plain text
11809 #: build/C/man5/proc.5:3279
11810 msgid ""
11811 "If nonzero, this disables the new 32-bit memory-mapping layout; the kernel "
11812 "will use the legacy (2.4) layout for all processes."
11813 msgstr ""
11814
11815 #. type: TP
11816 #: build/C/man5/proc.5:3279
11817 #, no-wrap
11818 msgid "I</proc/sys/vm/memory_failure_early_kill> (since Linux 2.6.32)"
11819 msgstr ""
11820
11821 #.  The following is based on the text in Documentation/sysctl/vm.txt
11822 #. type: Plain text
11823 #: build/C/man5/proc.5:3291
11824 msgid ""
11825 "Control how to kill processes when an uncorrected memory error (typically a "
11826 "2-bit error in a memory module)  that cannot be handled by the kernel is "
11827 "detected in the background by hardware.  In some cases (like the page still "
11828 "having a valid copy on disk), the kernel will handle the failure "
11829 "transparently without affecting any applications.  But if there is no other "
11830 "up-to-date copy of the data, it will kill processes to prevent any data "
11831 "corruptions from propagating."
11832 msgstr ""
11833
11834 #. type: Plain text
11835 #: build/C/man5/proc.5:3293
11836 msgid "The file has one of the following values:"
11837 msgstr ""
11838
11839 #. type: IP
11840 #: build/C/man5/proc.5:3294 build/C/man5/proc.5:3331
11841 #, no-wrap
11842 msgid "1:"
11843 msgstr ""
11844
11845 #. type: Plain text
11846 #: build/C/man5/proc.5:3299
11847 msgid ""
11848 "Kill all processes that have the corrupted-and-not-reloadable page mapped as "
11849 "soon as the corruption is detected.  Note this is not supported for a few "
11850 "types of pages, like kernel internally allocated data or the swap cache, but "
11851 "works for the majority of user pages."
11852 msgstr ""
11853
11854 #. type: IP
11855 #: build/C/man5/proc.5:3299 build/C/man5/proc.5:3333
11856 #, no-wrap
11857 msgid "0:"
11858 msgstr ""
11859
11860 #. type: Plain text
11861 #: build/C/man5/proc.5:3302
11862 msgid ""
11863 "Only unmap the corrupted page from all processes and kill only a process "
11864 "that tries to access it."
11865 msgstr ""
11866
11867 #. type: Plain text
11868 #: build/C/man5/proc.5:3313
11869 msgid ""
11870 "The kill is performed using a B<SIGBUS> signal with I<si_code> set to "
11871 "B<BUS_MCEERR_AO>.  Processes can handle this if they want to; see "
11872 "B<sigaction>(2)  for more details."
11873 msgstr ""
11874
11875 #. type: Plain text
11876 #: build/C/man5/proc.5:3316
11877 msgid ""
11878 "This feature is active only on architectures/platforms with advanced machine "
11879 "check handling and depends on the hardware capabilities."
11880 msgstr ""
11881
11882 #. type: Plain text
11883 #: build/C/man5/proc.5:3323
11884 msgid ""
11885 "Applications can override the I<memory_failure_early_kill> setting "
11886 "individually with the B<prctl>(2)  B<PR_MCE_KILL> operation."
11887 msgstr ""
11888
11889 #. type: Plain text
11890 #: build/C/man5/proc.5:3326 build/C/man5/proc.5:3339
11891 msgid "Only present if the kernel was configured with B<CONFIG_MEMORY_FAILURE>."
11892 msgstr ""
11893
11894 #. type: TP
11895 #: build/C/man5/proc.5:3326
11896 #, no-wrap
11897 msgid "I</proc/sys/vm/memory_failure_recovery> (since Linux 2.6.32)"
11898 msgstr ""
11899
11900 #.  The following is based on the text in Documentation/sysctl/vm.txt
11901 #. type: Plain text
11902 #: build/C/man5/proc.5:3330
11903 msgid "Enable memory failure recovery (when supported by the platform)"
11904 msgstr ""
11905
11906 #. type: Plain text
11907 #: build/C/man5/proc.5:3333
11908 msgid "Attempt recovery."
11909 msgstr ""
11910
11911 #. type: Plain text
11912 #: build/C/man5/proc.5:3335
11913 msgid "Always panic on a memory failure."
11914 msgstr ""
11915
11916 #. type: TP
11917 #: build/C/man5/proc.5:3339
11918 #, no-wrap
11919 msgid "I</proc/sys/vm/oom_dump_tasks> (since Linux 2.6.25)"
11920 msgstr ""
11921
11922 #.  The following is from Documentation/sysctl/vm.txt
11923 #. type: Plain text
11924 #: build/C/man5/proc.5:3354
11925 msgid ""
11926 "Enables a system-wide task dump (excluding kernel threads) to be produced "
11927 "when the kernel performs an OOM-killing.  The dump includes the following "
11928 "information for each task (thread, process): thread ID, real user ID, thread "
11929 "group ID (process ID), virtual memory size, resident set size, the CPU that "
11930 "the task is scheduled on, oom_adj score (see the description of "
11931 "I</proc/[pid]/oom_adj>), and command name.  This is helpful to determine why "
11932 "the OOM-killer was invoked and to identify the rogue task that caused it."
11933 msgstr ""
11934
11935 #. type: Plain text
11936 #: build/C/man5/proc.5:3360
11937 msgid ""
11938 "If this contains the value zero, this information is suppressed.  On very "
11939 "large systems with thousands of tasks, it may not be feasible to dump the "
11940 "memory state information for each one.  Such systems should not be forced to "
11941 "incur a performance penalty in OOM situations when the information may not "
11942 "be desired."
11943 msgstr ""
11944
11945 #. type: Plain text
11946 #: build/C/man5/proc.5:3363
11947 msgid ""
11948 "If this is set to nonzero, this information is shown whenever the OOM-killer "
11949 "actually kills a memory-hogging task."
11950 msgstr ""
11951
11952 #. type: Plain text
11953 #: build/C/man5/proc.5:3365 build/C/man5/proc.5:3386
11954 msgid "The default value is 0."
11955 msgstr ""
11956
11957 #. type: TP
11958 #: build/C/man5/proc.5:3365
11959 #, no-wrap
11960 msgid "I</proc/sys/vm/oom_kill_allocating_task> (since Linux 2.6.24)"
11961 msgstr ""
11962
11963 #.  The following is from Documentation/sysctl/vm.txt
11964 #. type: Plain text
11965 #: build/C/man5/proc.5:3370
11966 msgid ""
11967 "This enables or disables killing the OOM-triggering task in out-of-memory "
11968 "situations."
11969 msgstr ""
11970
11971 #. type: Plain text
11972 #: build/C/man5/proc.5:3375
11973 msgid ""
11974 "If this is set to zero, the OOM-killer will scan through the entire tasklist "
11975 "and select a task based on heuristics to kill.  This normally selects a "
11976 "rogue memory-hogging task that frees up a large amount of memory when "
11977 "killed."
11978 msgstr ""
11979
11980 #. type: Plain text
11981 #: build/C/man5/proc.5:3379
11982 msgid ""
11983 "If this is set to nonzero, the OOM-killer simply kills the task that "
11984 "triggered the out-of-memory condition.  This avoids a possibly expensive "
11985 "tasklist scan."
11986 msgstr ""
11987
11988 #. type: Plain text
11989 #: build/C/man5/proc.5:3384
11990 msgid ""
11991 "If I</proc/sys/vm/panic_on_oom> is nonzero, it takes precedence over "
11992 "whatever value is used in I</proc/sys/vm/oom_kill_allocating_task>."
11993 msgstr ""
11994
11995 #. type: TP
11996 #: build/C/man5/proc.5:3386
11997 #, no-wrap
11998 msgid "I</proc/sys/vm/overcommit_memory>"
11999 msgstr ""
12000
12001 #. type: Plain text
12002 #: build/C/man5/proc.5:3390
12003 msgid "This file contains the kernel virtual memory accounting mode.  Values are:"
12004 msgstr ""
12005
12006 #. type: Plain text
12007 #: build/C/man5/proc.5:3393
12008 msgid "0: heuristic overcommit (this is the default)"
12009 msgstr ""
12010
12011 #. type: Plain text
12012 #: build/C/man5/proc.5:3395
12013 msgid "1: always overcommit, never check"
12014 msgstr ""
12015
12016 #. type: Plain text
12017 #: build/C/man5/proc.5:3397
12018 msgid "2: always check, never overcommit"
12019 msgstr ""
12020
12021 #. type: Plain text
12022 #: build/C/man5/proc.5:3411
12023 msgid ""
12024 "In mode 0, calls of B<mmap>(2)  with B<MAP_NORESERVE> are not checked, and "
12025 "the default check is very weak, leading to the risk of getting a process "
12026 "\"OOM-killed\".  Under Linux 2.4 any nonzero value implies mode 1.  In mode "
12027 "2 (available since Linux 2.6), the total virtual address space on the system "
12028 "is limited to (SS + RAM*(r/100)), where SS is the size of the swap space, "
12029 "and RAM is the size of the physical memory, and r is the contents of the "
12030 "file I</proc/sys/vm/overcommit_ratio>."
12031 msgstr ""
12032
12033 #. type: TP
12034 #: build/C/man5/proc.5:3411
12035 #, no-wrap
12036 msgid "I</proc/sys/vm/overcommit_ratio>"
12037 msgstr ""
12038
12039 #. type: Plain text
12040 #: build/C/man5/proc.5:3415
12041 msgid "See the description of I</proc/sys/vm/overcommit_memory>."
12042 msgstr ""
12043
12044 #. type: TP
12045 #: build/C/man5/proc.5:3415
12046 #, no-wrap
12047 msgid "I</proc/sys/vm/panic_on_oom> (since Linux 2.6.18)"
12048 msgstr ""
12049
12050 #.  The following is adapted from Documentation/sysctl/vm.txt
12051 #. type: Plain text
12052 #: build/C/man5/proc.5:3420
12053 msgid "This enables or disables a kernel panic in an out-of-memory situation."
12054 msgstr ""
12055
12056 #. type: Plain text
12057 #: build/C/man5/proc.5:3425
12058 msgid ""
12059 "If this file is set to the value 0, the kernel's OOM-killer will kill some "
12060 "rogue process.  Usually, the OOM-killer is able to kill a rogue process and "
12061 "the system will survive."
12062 msgstr ""
12063
12064 #. type: Plain text
12065 #: build/C/man5/proc.5:3440
12066 msgid ""
12067 "If this file is set to the value 1, then the kernel normally panics when "
12068 "out-of-memory happens.  However, if a process limits allocations to certain "
12069 "nodes using memory policies (B<mbind>(2)  B<MPOL_BIND>)  or cpusets "
12070 "(B<cpuset>(7))  and those nodes reach memory exhaustion status, one process "
12071 "may be killed by the OOM-killer.  No panic occurs in this case: because "
12072 "other nodes' memory may be free, this means the system as a whole may not "
12073 "have reached an out-of-memory situation yet."
12074 msgstr ""
12075
12076 #. type: Plain text
12077 #: build/C/man5/proc.5:3443
12078 msgid ""
12079 "If this file is set to the value 2, the kernel always panics when an "
12080 "out-of-memory condition occurs."
12081 msgstr ""
12082
12083 #. type: Plain text
12084 #: build/C/man5/proc.5:3447
12085 msgid ""
12086 "The default value is 0.  1 and 2 are for failover of clustering.  Select "
12087 "either according to your policy of failover."
12088 msgstr ""
12089
12090 #. type: TP
12091 #: build/C/man5/proc.5:3447
12092 #, no-wrap
12093 msgid "I</proc/sys/vm/swappiness>"
12094 msgstr ""
12095
12096 #.  The following is from Documentation/sysctl/vm.txt
12097 #. type: Plain text
12098 #: build/C/man5/proc.5:3455
12099 msgid ""
12100 "The value in this file controls how aggressively the kernel will swap memory "
12101 "pages.  Higher values increase aggressiveness, lower values decrease "
12102 "aggressiveness.  The default value is 60."
12103 msgstr ""
12104
12105 #. type: TP
12106 #: build/C/man5/proc.5:3455
12107 #, no-wrap
12108 msgid "I</proc/sysrq-trigger> (since Linux 2.4.21)"
12109 msgstr ""
12110
12111 #. type: Plain text
12112 #: build/C/man5/proc.5:3464
12113 msgid ""
12114 "Writing a character to this file triggers the same SysRq function as typing "
12115 "ALT-SysRq-E<lt>characterE<gt> (see the description of "
12116 "I</proc/sys/kernel/sysrq>).  This file is normally writable only by "
12117 "I<root>.  For further details see the Linux kernel source file "
12118 "I<Documentation/sysrq.txt>."
12119 msgstr ""
12120
12121 #. type: TP
12122 #: build/C/man5/proc.5:3464
12123 #, no-wrap
12124 msgid "I</proc/sysvipc>"
12125 msgstr ""
12126
12127 #. type: Plain text
12128 #: build/C/man5/proc.5:3477
12129 msgid ""
12130 "Subdirectory containing the pseudo-files I<msg>, I<sem> and I<shm>.  These "
12131 "files list the System V Interprocess Communication (IPC) objects "
12132 "(respectively: message queues, semaphores, and shared memory)  that "
12133 "currently exist on the system, providing similar information to that "
12134 "available via B<ipcs>(1).  These files have headers and are formatted (one "
12135 "IPC object per line)  for easy understanding.  B<svipc>(7)  provides further "
12136 "background on the information shown by these files."
12137 msgstr ""
12138
12139 #. type: TP
12140 #: build/C/man5/proc.5:3477
12141 #, no-wrap
12142 msgid "I</proc/tty>"
12143 msgstr ""
12144
12145 #. type: Plain text
12146 #: build/C/man5/proc.5:3481
12147 msgid ""
12148 "Subdirectory containing the pseudo-files and subdirectories for tty drivers "
12149 "and line disciplines."
12150 msgstr ""
12151
12152 #. type: TP
12153 #: build/C/man5/proc.5:3481
12154 #, no-wrap
12155 msgid "I</proc/uptime>"
12156 msgstr ""
12157
12158 #. type: Plain text
12159 #: build/C/man5/proc.5:3485
12160 msgid ""
12161 "This file contains two numbers: the uptime of the system (seconds), and the "
12162 "amount of time spent in idle process (seconds)."
12163 msgstr ""
12164
12165 #. type: TP
12166 #: build/C/man5/proc.5:3485
12167 #, no-wrap
12168 msgid "I</proc/version>"
12169 msgstr ""
12170
12171 #. type: Plain text
12172 #: build/C/man5/proc.5:3494
12173 msgid ""
12174 "This string identifies the kernel version that is currently running.  It "
12175 "includes the contents of I</proc/sys/kernel/ostype>, "
12176 "I</proc/sys/kernel/osrelease> and I</proc/sys/kernel/version>.  For example:"
12177 msgstr ""
12178
12179 #. type: Plain text
12180 #: build/C/man5/proc.5:3498
12181 #, no-wrap
12182 msgid "CW<Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994>\n"
12183 msgstr ""
12184
12185 #. type: TP
12186 #: build/C/man5/proc.5:3509
12187 #, no-wrap
12188 msgid "I</proc/vmstat> (since Linux 2.6)"
12189 msgstr ""
12190
12191 #. type: Plain text
12192 #: build/C/man5/proc.5:3512
12193 msgid "This file displays various virtual memory statistics."
12194 msgstr ""
12195
12196 #. type: TP
12197 #: build/C/man5/proc.5:3512
12198 #, no-wrap
12199 msgid "I</proc/zoneinfo> (since Linux 2.6.13)"
12200 msgstr ""
12201
12202 #.  FIXME more should be said about /proc/zoneinfo
12203 #. type: Plain text
12204 #: build/C/man5/proc.5:3517
12205 msgid ""
12206 "This file display information about memory zones.  This is useful for "
12207 "analyzing virtual memory behavior."
12208 msgstr ""
12209
12210 #. type: Plain text
12211 #: build/C/man5/proc.5:3524
12212 msgid ""
12213 "Many strings (i.e., the environment and command line) are in the internal "
12214 "format, with subfields terminated by null bytes (\\(aq\\e0\\(aq), so you may "
12215 "find that things are more readable if you use I<od -c> or I<tr \"\\e000\" "
12216 "\"\\en\"> to read them.  Alternatively, I<echo \\`cat E<lt>fileE<gt>\\`> "
12217 "works well."
12218 msgstr ""
12219
12220 #.  .SH ACKNOWLEDGEMENTS
12221 #.  The material on /proc/sys/fs and /proc/sys/kernel is closely based on
12222 #.  kernel source documentation files written by Rik van Riel.
12223 #. type: Plain text
12224 #: build/C/man5/proc.5:3530
12225 msgid ""
12226 "This manual page is incomplete, possibly inaccurate, and is the kind of "
12227 "thing that needs to be updated very often."
12228 msgstr ""
12229
12230 #. type: Plain text
12231 #: build/C/man5/proc.5:3556
12232 msgid ""
12233 "B<cat>(1), B<dmesg>(1), B<find>(1), B<free>(1), B<ps>(1), B<tr>(1), "
12234 "B<uptime>(1), B<chroot>(2), B<mmap>(2), B<readlink>(2), B<syslog>(2), "
12235 "B<slabinfo>(5), B<hier>(7), B<time>(7), B<arp>(8), B<hdparm>(8), "
12236 "B<ifconfig>(8), B<init>(8), B<lsmod>(8), B<lspci>(8), B<mount>(8), "
12237 "B<netstat>(8), B<procinfo>(8), B<route>(8), B<sysctl>(8)"
12238 msgstr ""
12239
12240 #. type: Plain text
12241 #: build/C/man5/proc.5:3561
12242 msgid ""
12243 "The Linux kernel source files: I<Documentation/filesystems/proc.txt> and "
12244 "I<Documentation/sysctl/vm.txt>."
12245 msgstr ""
12246
12247 #. type: TH
12248 #: build/C/man7/standards.7:26
12249 #, no-wrap
12250 msgid "STANDARDS"
12251 msgstr ""
12252
12253 #. type: TH
12254 #: build/C/man7/standards.7:26
12255 #, no-wrap
12256 msgid "2013-09-06"
12257 msgstr ""
12258
12259 #. type: Plain text
12260 #: build/C/man7/standards.7:29
12261 msgid "standards - C and UNIX Standards"
12262 msgstr ""
12263
12264 #. type: Plain text
12265 #: build/C/man7/standards.7:33
12266 msgid ""
12267 "The CONFORMING TO section that appears in many manual pages identifies "
12268 "various standards to which the documented interface conforms.  The following "
12269 "list briefly describes these standards."
12270 msgstr ""
12271
12272 #. type: TP
12273 #: build/C/man7/standards.7:33
12274 #, no-wrap
12275 msgid "B<V7>"
12276 msgstr ""
12277
12278 #. type: Plain text
12279 #: build/C/man7/standards.7:36
12280 msgid "Version 7, the ancestral UNIX from Bell Labs."
12281 msgstr ""
12282
12283 #. type: TP
12284 #: build/C/man7/standards.7:36
12285 #, no-wrap
12286 msgid "B<4.2BSD>"
12287 msgstr ""
12288
12289 #. type: Plain text
12290 #: build/C/man7/standards.7:45
12291 msgid ""
12292 "This is an implementation standard defined by the 4.2 release of the "
12293 "I<Berkeley Software Distribution>, released by the University of California "
12294 "at Berkeley.  This was the first Berkeley release that contained a TCP/IP "
12295 "stack and the sockets API.  4.2BSD was released in 1983."
12296 msgstr ""
12297
12298 #. type: Plain text
12299 #: build/C/man7/standards.7:54
12300 msgid ""
12301 "Earlier major BSD releases included I<3BSD> (1980), I<4BSD> (1980), and "
12302 "I<4.1BSD> (1981)."
12303 msgstr ""
12304
12305 #. type: TP
12306 #: build/C/man7/standards.7:54
12307 #, no-wrap
12308 msgid "B<4.3BSD>"
12309 msgstr ""
12310
12311 #. type: Plain text
12312 #: build/C/man7/standards.7:57
12313 msgid "The successor to 4.2BSD, released in 1986."
12314 msgstr ""
12315
12316 #. type: TP
12317 #: build/C/man7/standards.7:57
12318 #, no-wrap
12319 msgid "B<4.4BSD>"
12320 msgstr ""
12321
12322 #. type: Plain text
12323 #: build/C/man7/standards.7:61
12324 msgid ""
12325 "The successor to 4.3BSD, released in 1993.  This was the last major Berkeley "
12326 "release."
12327 msgstr ""
12328
12329 #. type: TP
12330 #: build/C/man7/standards.7:61
12331 #, no-wrap
12332 msgid "B<System V>"
12333 msgstr ""
12334
12335 #. type: Plain text
12336 #: build/C/man7/standards.7:68
12337 msgid ""
12338 "This is an implementation standard defined by AT&T's milestone 1983 release "
12339 "of its commercial System V (five) release.  The previous major AT&T release "
12340 "was I<System III>, released in 1981."
12341 msgstr ""
12342
12343 #. type: TP
12344 #: build/C/man7/standards.7:68
12345 #, no-wrap
12346 msgid "B<System V release 2 (SVr2)>"
12347 msgstr ""
12348
12349 #. type: Plain text
12350 #: build/C/man7/standards.7:75
12351 msgid ""
12352 "This was the next System V release, made in 1985.  The SVr2 was formally "
12353 "described in the I<System V Interface Definition version 1> (I<SVID 1>)  "
12354 "published in 1985."
12355 msgstr ""
12356
12357 #. type: TP
12358 #: build/C/man7/standards.7:75
12359 #, no-wrap
12360 msgid "B<System V release 3 (SVr3)>"
12361 msgstr ""
12362
12363 #. type: Plain text
12364 #: build/C/man7/standards.7:81
12365 msgid ""
12366 "This was the successor to SVr2, released in 1986.  This release was formally "
12367 "described in the I<System V Interface Definition version 2> (I<SVID 2>)."
12368 msgstr ""
12369
12370 #. type: TP
12371 #: build/C/man7/standards.7:81
12372 #, no-wrap
12373 msgid "B<System V release 4 (SVr4)>"
12374 msgstr ""
12375
12376 #. type: Plain text
12377 #: build/C/man7/standards.7:91
12378 msgid ""
12379 "This was the successor to SVr3, released in 1989.  This version of System V "
12380 "is described in the \"Programmer's Reference Manual: Operating System API "
12381 "(Intel processors)\" (Prentice-Hall 1992, ISBN 0-13-951294-2)  This release "
12382 "was formally described in the I<System V Interface Definition version 3> "
12383 "(I<SVID 3>), and is considered the definitive System V release."
12384 msgstr ""
12385
12386 #. type: TP
12387 #: build/C/man7/standards.7:91
12388 #, no-wrap
12389 msgid "B<SVID 4>"
12390 msgstr ""
12391
12392 #. type: Plain text
12393 #: build/C/man7/standards.7:97
12394 msgid ""
12395 "System V Interface Definition version 4, issued in 1995.  Available online "
12396 "at E<.UR http://www.sco.com\\:/developers\\:/devspecs/> E<.UE .>"
12397 msgstr ""
12398
12399 #. type: TP
12400 #: build/C/man7/standards.7:97
12401 #, no-wrap
12402 msgid "B<C89>"
12403 msgstr ""
12404
12405 #. type: Plain text
12406 #: build/C/man7/standards.7:111
12407 msgid ""
12408 "This was the first C language standard, ratified by ANSI (American National "
12409 "Standards Institute) in 1989 (I<X3.159-1989>).  Sometimes this is known as "
12410 "I<ANSI C>, but since C99 is also an ANSI standard, this term is ambiguous.  "
12411 "This standard was also ratified by ISO (International Standards "
12412 "Organization) in 1990 (I<ISO/IEC 9899:1990>), and is thus occasionally "
12413 "referred to as I<ISO C90>."
12414 msgstr ""
12415
12416 #. type: TP
12417 #: build/C/man7/standards.7:111
12418 #, no-wrap
12419 msgid "B<C99>"
12420 msgstr ""
12421
12422 #. type: Plain text
12423 #: build/C/man7/standards.7:118
12424 msgid ""
12425 "This revision of the C language standard was ratified by ISO in 1999 "
12426 "(I<ISO/IEC 9899:1999>).  Available online at E<.UR "
12427 "http://www.open-std.org\\:/jtc1\\:/sc22\\:/wg14\\:/www\\:/standards> E<.UE "
12428 ".>"
12429 msgstr ""
12430
12431 #. type: TP
12432 #: build/C/man7/standards.7:118
12433 #, no-wrap
12434 msgid "B<POSIX.1-1990>"
12435 msgstr ""
12436
12437 #. type: Plain text
12438 #: build/C/man7/standards.7:124
12439 msgid ""
12440 "\"Portable Operating System Interface for Computing Environments\".  IEEE "
12441 "1003.1-1990 part 1, ratified by ISO in 1990 (I<ISO/IEC 9945-1:1990>).  The "
12442 "term \"POSIX\" was coined by Richard Stallman."
12443 msgstr ""
12444
12445 #. type: TP
12446 #: build/C/man7/standards.7:124
12447 #, no-wrap
12448 msgid "B<POSIX.2>"
12449 msgstr ""
12450
12451 #. type: Plain text
12452 #: build/C/man7/standards.7:129
12453 msgid ""
12454 "IEEE Std 1003.2-1992, describing commands and utilities, ratified by ISO in "
12455 "1993 (I<ISO/IEC 9945-2:1993>)."
12456 msgstr ""
12457
12458 #. type: TP
12459 #: build/C/man7/standards.7:129
12460 #, no-wrap
12461 msgid "B<POSIX.1b> (formerly known as I<POSIX.4>)"
12462 msgstr ""
12463
12464 #. type: Plain text
12465 #: build/C/man7/standards.7:135
12466 msgid ""
12467 "IEEE Std 1003.1b-1993 describing real-time facilities for portable operating "
12468 "systems, ratified by ISO in 1996 (I<ISO/IEC 9945-1:1996>)."
12469 msgstr ""
12470
12471 #. type: TP
12472 #: build/C/man7/standards.7:135
12473 #, no-wrap
12474 msgid "B<POSIX.1c>"
12475 msgstr ""
12476
12477 #. type: Plain text
12478 #: build/C/man7/standards.7:138
12479 msgid "IEEE Std 1003.1c-1995 describing the POSIX threads interfaces."
12480 msgstr ""
12481
12482 #. type: TP
12483 #: build/C/man7/standards.7:138
12484 #, no-wrap
12485 msgid "B<POSIX.1d>"
12486 msgstr ""
12487
12488 #. type: Plain text
12489 #: build/C/man7/standards.7:141
12490 msgid "IEEE Std 1003.1c-1999 describing additional real-time extensions."
12491 msgstr ""
12492
12493 #. type: TP
12494 #: build/C/man7/standards.7:141
12495 #, no-wrap
12496 msgid "B<POSIX.1g>"
12497 msgstr ""
12498
12499 #. type: Plain text
12500 #: build/C/man7/standards.7:144
12501 msgid "IEEE Std 1003.1g-2000 describing networking APIs (including sockets)."
12502 msgstr ""
12503
12504 #. type: TP
12505 #: build/C/man7/standards.7:144
12506 #, no-wrap
12507 msgid "B<POSIX.1j>"
12508 msgstr ""
12509
12510 #. type: Plain text
12511 #: build/C/man7/standards.7:147
12512 msgid "IEEE Std 1003.1j-2000 describing advanced real-time extensions."
12513 msgstr ""
12514
12515 #. type: TP
12516 #: build/C/man7/standards.7:147
12517 #, no-wrap
12518 msgid "B<POSIX.1-1996>"
12519 msgstr ""
12520
12521 #. type: Plain text
12522 #: build/C/man7/standards.7:150
12523 msgid "A 1996 revision of POSIX.1 which incorporated POSIX.1b and POSIX.1c."
12524 msgstr ""
12525
12526 #. type: TP
12527 #: build/C/man7/standards.7:150
12528 #, no-wrap
12529 msgid "B<XPG3>"
12530 msgstr ""
12531
12532 #. type: Plain text
12533 #: build/C/man7/standards.7:157
12534 msgid ""
12535 "Released in 1989, this was the first significant release of the I<X/Open "
12536 "Portability Guide>, produced by the X/Open Company, a multivendor "
12537 "consortium.  This multivolume guide was based on the POSIX standards."
12538 msgstr ""
12539
12540 #. type: TP
12541 #: build/C/man7/standards.7:157
12542 #, no-wrap
12543 msgid "B<XPG4>"
12544 msgstr ""
12545
12546 #. type: Plain text
12547 #: build/C/man7/standards.7:160
12548 msgid "A revision of the X/Open Portability Guide, released in 1992."
12549 msgstr ""
12550
12551 #. type: TP
12552 #: build/C/man7/standards.7:160
12553 #, no-wrap
12554 msgid "B<XPG4v2>"
12555 msgstr ""
12556
12557 #. type: Plain text
12558 #: build/C/man7/standards.7:167
12559 msgid ""
12560 "A 1994 revision of XPG4.  This is also referred to as I<Spec 1170>, where "
12561 "1170 referred to the number of interfaces defined by this standard."
12562 msgstr ""
12563
12564 #. type: TP
12565 #: build/C/man7/standards.7:167
12566 #, no-wrap
12567 msgid "B<SUS (SUSv1)>"
12568 msgstr ""
12569
12570 #. type: Plain text
12571 #: build/C/man7/standards.7:175
12572 msgid ""
12573 "Single UNIX Specification.  This was a repackaging of XPG4v2 and other "
12574 "X/Open standards (X/Open Curses Issue 4 version 2, X/Open Networking Service "
12575 "(XNS) Issue 4).  Systems conforming to this standard can be branded I<UNIX "
12576 "95>."
12577 msgstr ""
12578
12579 #. type: TP
12580 #: build/C/man7/standards.7:175
12581 #, no-wrap
12582 msgid "B<SUSv2>"
12583 msgstr ""
12584
12585 #. type: Plain text
12586 #: build/C/man7/standards.7:186
12587 msgid ""
12588 "Single UNIX Specification version 2.  Sometimes also referred to as "
12589 "I<XPG5>.  This standard appeared in 1997.  Systems conforming to this "
12590 "standard can be branded I<UNIX 98>.  See also E<.UR "
12591 "http://www.UNIX-systems.org\\:/version2/> E<.UE .)>"
12592 msgstr ""
12593
12594 #. type: TP
12595 #: build/C/man7/standards.7:186
12596 #, no-wrap
12597 msgid "B<POSIX.1-2001, SUSv3>"
12598 msgstr ""
12599
12600 #. type: Plain text
12601 #: build/C/man7/standards.7:198
12602 msgid ""
12603 "This was a 2001 revision and consolidation of the POSIX.1, POSIX.2, and SUS "
12604 "standards into a single document, conducted under the auspices of the Austin "
12605 "group E<.UR http://www.opengroup.org\\:/austin/> E<.UE .> The standard is "
12606 "available online at E<.UR http://www.unix-systems.org\\:/version3/> E<.UE ,> "
12607 "and the interfaces that it describes are also available in the Linux manual "
12608 "pages package under sections 1p and 3p (e.g., \"man 3p open\")."
12609 msgstr ""
12610
12611 #. type: Plain text
12612 #: build/C/man7/standards.7:211
12613 msgid ""
12614 "The standard defines two levels of conformance: I<POSIX conformance>, which "
12615 "is a baseline set of interfaces required of a conforming system; and I<XSI "
12616 "Conformance>, which additionally mandates a set of interfaces (the \"XSI "
12617 "extension\") which are only optional for POSIX conformance.  XSI-conformant "
12618 "systems can be branded I<UNIX 03>.  (XSI conformance constitutes the "
12619 "I<Single UNIX Specification version 3> (I<SUSv3>).)"
12620 msgstr ""
12621
12622 #. type: Plain text
12623 #: build/C/man7/standards.7:213
12624 msgid "The POSIX.1-2001 document is broken into four parts:"
12625 msgstr ""
12626
12627 #. type: Plain text
12628 #: build/C/man7/standards.7:216
12629 msgid "B<XBD>: Definitions, terms and concepts, header file specifications."
12630 msgstr ""
12631
12632 #. type: Plain text
12633 #: build/C/man7/standards.7:220
12634 msgid ""
12635 "B<XSH>: Specifications of functions (i.e., system calls and library "
12636 "functions in actual implementations)."
12637 msgstr ""
12638
12639 #. type: Plain text
12640 #: build/C/man7/standards.7:224
12641 msgid ""
12642 "B<XCU>: Specifications of commands and utilities (i.e., the area formerly "
12643 "described by POSIX.2)."
12644 msgstr ""
12645
12646 #. type: Plain text
12647 #: build/C/man7/standards.7:227
12648 msgid "B<XRAT>: Informative text on the other parts of the standard."
12649 msgstr ""
12650
12651 #. type: Plain text
12652 #: build/C/man7/standards.7:231
12653 msgid ""
12654 "POSIX.1-2001 is aligned with C99, so that all of the library functions "
12655 "standardized in C99 are also standardized in POSIX.1-2001."
12656 msgstr ""
12657
12658 #. type: Plain text
12659 #: build/C/man7/standards.7:238
12660 msgid ""
12661 "Two Technical Corrigenda (minor fixes and improvements)  of the original "
12662 "2001 standard have occurred: TC1 in 2003 (referred to as I<POSIX.1-2003>), "
12663 "and TC2 in 2004 (referred to as I<POSIX.1-2004>)."
12664 msgstr ""
12665
12666 #. type: TP
12667 #: build/C/man7/standards.7:238
12668 #, no-wrap
12669 msgid "B<POSIX.1-2008, SUSv4>"
12670 msgstr ""
12671
12672 #. type: Plain text
12673 #: build/C/man7/standards.7:242
12674 msgid "Work on the next revision of POSIX.1/SUS was completed and ratified in 2008."
12675 msgstr ""
12676
12677 #. type: Plain text
12678 #: build/C/man7/standards.7:251
12679 msgid ""
12680 "The changes in this revision are not as large as those that occurred for "
12681 "POSIX.1-2001/SUSv3, but a number of new interfaces are added and various "
12682 "details of existing specifications are modified.  Many of the interfaces "
12683 "that were optional in POSIX.1-2001 become mandatory in the 2008 revision of "
12684 "the standard.  A few interfaces that are present in POSIX.1-2001 are marked "
12685 "as obsolete in POSIX.1-2008, or removed from the standard altogether."
12686 msgstr ""
12687
12688 #. type: Plain text
12689 #: build/C/man7/standards.7:259
12690 msgid ""
12691 "The revised standard is broken into the same four parts as POSIX.1-2001, and "
12692 "again there are two levels of conformance: the baseline I<POSIX "
12693 "Conformance>, and I<XSI Conformance>, which mandates an additional set of "
12694 "interfaces beyond those in the base specification."
12695 msgstr ""
12696
12697 #. type: Plain text
12698 #: build/C/man7/standards.7:263
12699 msgid ""
12700 "In general, where the CONFORMING TO section of a manual page lists "
12701 "POSIX.1-2001, it can be assumed that the interface also conforms to "
12702 "POSIX.1-2008, unless otherwise noted."
12703 msgstr ""
12704
12705 #. type: Plain text
12706 #: build/C/man7/standards.7:268
12707 msgid ""
12708 "Technical Corrigenda 1 (minor fixes and improvements)  of this standard was "
12709 "released in 2013 (referred to as I<POSIX.1-2013>)."
12710 msgstr ""
12711
12712 #. type: Plain text
12713 #: build/C/man7/standards.7:272
12714 msgid ""
12715 "Further information can be found on the Austin group web site, E<.UR "
12716 "http://www.opengroup.org\\:/austin/> E<.UE .>"
12717 msgstr ""
12718
12719 #. type: Plain text
12720 #: build/C/man7/standards.7:276
12721 msgid "B<feature_test_macros>(7), B<libc>(7), B<posixoptions>(7)"
12722 msgstr ""
12723
12724 #. type: TH
12725 #: build/C/man7/suffixes.7:40
12726 #, no-wrap
12727 msgid "SUFFIXES"
12728 msgstr ""
12729
12730 #. type: TH
12731 #: build/C/man7/suffixes.7:40
12732 #, no-wrap
12733 msgid "2000-11-16"
12734 msgstr ""
12735
12736 #. type: Plain text
12737 #: build/C/man7/suffixes.7:43
12738 msgid "suffixes - list of file suffixes"
12739 msgstr ""
12740
12741 #. type: Plain text
12742 #: build/C/man7/suffixes.7:51
12743 msgid ""
12744 "It is customary to indicate the contents of a file with the file suffix, "
12745 "which consists of a period, followed by one or more letters.  Many standard "
12746 "utilities, such as compilers, use this to recognize the type of file they "
12747 "are dealing with.  The B<make>(1)  utility is driven by rules based on file "
12748 "suffix."
12749 msgstr ""
12750
12751 #. type: Plain text
12752 #: build/C/man7/suffixes.7:54
12753 msgid ""
12754 "Following is a list of suffixes which are likely to be found on a Linux "
12755 "system."
12756 msgstr ""
12757
12758 #. type: tbl table
12759 #: build/C/man7/suffixes.7:59
12760 #, no-wrap
12761 msgid "Suffix\tFile type\n"
12762 msgstr ""
12763
12764 #. type: tbl table
12765 #: build/C/man7/suffixes.7:60
12766 #, no-wrap
12767 msgid " ,v\tfiles for RCS (Revision Control System)\n"
12768 msgstr ""
12769
12770 #. type: tbl table
12771 #: build/C/man7/suffixes.7:61
12772 #, no-wrap
12773 msgid " -\tbackup file\n"
12774 msgstr ""
12775
12776 #. type: tbl table
12777 #: build/C/man7/suffixes.7:62
12778 #, no-wrap
12779 msgid " .C\tC++ source code, equivalent to I<.cc>\n"
12780 msgstr ""
12781
12782 #. type: tbl table
12783 #: build/C/man7/suffixes.7:63
12784 #, no-wrap
12785 msgid " .F\tFortran source with B<cpp>(1) directives\n"
12786 msgstr ""
12787
12788 #. type: tbl table
12789 #: build/C/man7/suffixes.7:64
12790 #, no-wrap
12791 msgid "\tor file compressed using freeze\n"
12792 msgstr ""
12793
12794 #. type: tbl table
12795 #: build/C/man7/suffixes.7:65
12796 #, no-wrap
12797 msgid " .S\tassembler source with B<cpp>(1) directives\n"
12798 msgstr ""
12799
12800 #. type: tbl table
12801 #: build/C/man7/suffixes.7:66
12802 #, no-wrap
12803 msgid " .Y\tfile compressed using yabba\n"
12804 msgstr ""
12805
12806 #. type: tbl table
12807 #: build/C/man7/suffixes.7:67
12808 #, no-wrap
12809 msgid " .Z\tfile compressed using B<compress>(1)\n"
12810 msgstr ""
12811
12812 #. type: tbl table
12813 #: build/C/man7/suffixes.7:68
12814 #, no-wrap
12815 msgid " .[0-9]+gf\tTeX generic font files\n"
12816 msgstr ""
12817
12818 #. type: tbl table
12819 #: build/C/man7/suffixes.7:69
12820 #, no-wrap
12821 msgid " .[0-9]+pk\tTeX packed font files\n"
12822 msgstr ""
12823
12824 #. type: tbl table
12825 #: build/C/man7/suffixes.7:70
12826 #, no-wrap
12827 msgid " .[1-9]\tmanual page for the corresponding section\n"
12828 msgstr ""
12829
12830 #. type: tbl table
12831 #: build/C/man7/suffixes.7:71
12832 #, no-wrap
12833 msgid " .[1-9][a-z]\tmanual page for section plus subsection\n"
12834 msgstr ""
12835
12836 #. type: tbl table
12837 #: build/C/man7/suffixes.7:72
12838 #, no-wrap
12839 msgid " .a\tstatic object code library\n"
12840 msgstr ""
12841
12842 #. type: tbl table
12843 #: build/C/man7/suffixes.7:73
12844 #, no-wrap
12845 msgid " .ad\tX application default resource file\n"
12846 msgstr ""
12847
12848 #. type: tbl table
12849 #: build/C/man7/suffixes.7:74
12850 #, no-wrap
12851 msgid " .ada\tAda source (may be body, spec, or combination)\n"
12852 msgstr ""
12853
12854 #. type: tbl table
12855 #: build/C/man7/suffixes.7:75
12856 #, no-wrap
12857 msgid " .adb\tAda body source\n"
12858 msgstr ""
12859
12860 #. type: tbl table
12861 #: build/C/man7/suffixes.7:76
12862 #, no-wrap
12863 msgid " .ads\tAda spec source\n"
12864 msgstr ""
12865
12866 #. type: tbl table
12867 #: build/C/man7/suffixes.7:77
12868 #, no-wrap
12869 msgid " .afm\tPostScript font metrics\n"
12870 msgstr ""
12871
12872 #. type: tbl table
12873 #: build/C/man7/suffixes.7:78
12874 #, no-wrap
12875 msgid " .al\tPerl autoload file\n"
12876 msgstr ""
12877
12878 #. type: tbl table
12879 #: build/C/man7/suffixes.7:79
12880 #, no-wrap
12881 msgid " .am\tB<automake>(1) input file\n"
12882 msgstr ""
12883
12884 #. type: tbl table
12885 #: build/C/man7/suffixes.7:80
12886 #, no-wrap
12887 msgid " .arc\tB<arc>(1) archive\n"
12888 msgstr ""
12889
12890 #. type: tbl table
12891 #: build/C/man7/suffixes.7:81
12892 #, no-wrap
12893 msgid " .arj\tB<arj>(1) archive\n"
12894 msgstr ""
12895
12896 #. type: tbl table
12897 #: build/C/man7/suffixes.7:82
12898 #, no-wrap
12899 msgid " .asc\tPGP ASCII-armored data\n"
12900 msgstr ""
12901
12902 #. type: tbl table
12903 #: build/C/man7/suffixes.7:83
12904 #, no-wrap
12905 msgid " .asm\t(GNU) assembler source file\n"
12906 msgstr ""
12907
12908 #. type: tbl table
12909 #: build/C/man7/suffixes.7:84
12910 #, no-wrap
12911 msgid " .au\tAudio sound file\n"
12912 msgstr ""
12913
12914 #. type: tbl table
12915 #: build/C/man7/suffixes.7:85
12916 #, no-wrap
12917 msgid " .aux\tLaTeX auxiliary file\n"
12918 msgstr ""
12919
12920 #. type: tbl table
12921 #: build/C/man7/suffixes.7:86
12922 #, no-wrap
12923 msgid " .avi\t(msvideo) movie\n"
12924 msgstr ""
12925
12926 #. type: tbl table
12927 #: build/C/man7/suffixes.7:87
12928 #, no-wrap
12929 msgid " .awk\tAWK language program\n"
12930 msgstr ""
12931
12932 #. type: tbl table
12933 #: build/C/man7/suffixes.7:88
12934 #, no-wrap
12935 msgid " .b\tLILO boot loader image\n"
12936 msgstr ""
12937
12938 #. type: tbl table
12939 #: build/C/man7/suffixes.7:89
12940 #, no-wrap
12941 msgid " .bak\tbackup file\n"
12942 msgstr ""
12943
12944 #. type: tbl table
12945 #: build/C/man7/suffixes.7:90
12946 #, no-wrap
12947 msgid " .bash\tB<bash>(1) shell script\n"
12948 msgstr ""
12949
12950 #. type: tbl table
12951 #: build/C/man7/suffixes.7:91
12952 #, no-wrap
12953 msgid " .bb\tbasic block list data produced by\n"
12954 msgstr ""
12955
12956 #. type: tbl table
12957 #: build/C/man7/suffixes.7:92 build/C/man7/suffixes.7:94
12958 #, no-wrap
12959 msgid "\tgcc -ftest-coverage\n"
12960 msgstr ""
12961
12962 #. type: tbl table
12963 #: build/C/man7/suffixes.7:93
12964 #, no-wrap
12965 msgid " .bbg\tbasic block graph data produced by\n"
12966 msgstr ""
12967
12968 #. type: tbl table
12969 #: build/C/man7/suffixes.7:95
12970 #, no-wrap
12971 msgid " .bbl\tBibTeX output\n"
12972 msgstr ""
12973
12974 #. type: tbl table
12975 #: build/C/man7/suffixes.7:96
12976 #, no-wrap
12977 msgid " .bdf\tX font file\n"
12978 msgstr ""
12979
12980 #. type: tbl table
12981 #: build/C/man7/suffixes.7:97
12982 #, no-wrap
12983 msgid " .bib\tTeX bibliographic database, BibTeX input\n"
12984 msgstr ""
12985
12986 #. type: tbl table
12987 #: build/C/man7/suffixes.7:98
12988 #, no-wrap
12989 msgid " .bm\tbitmap source\n"
12990 msgstr ""
12991
12992 #. type: tbl table
12993 #: build/C/man7/suffixes.7:99
12994 #, no-wrap
12995 msgid " .bmp\tbitmap\n"
12996 msgstr ""
12997
12998 #. type: tbl table
12999 #: build/C/man7/suffixes.7:100
13000 #, no-wrap
13001 msgid " .bz2\tfile compressed using B<bzip2>(1)\n"
13002 msgstr ""
13003
13004 #. type: tbl table
13005 #: build/C/man7/suffixes.7:101
13006 #, no-wrap
13007 msgid " .c\tC source\n"
13008 msgstr ""
13009
13010 #. type: tbl table
13011 #: build/C/man7/suffixes.7:102
13012 #, no-wrap
13013 msgid " .cat\tmessage catalog files\n"
13014 msgstr ""
13015
13016 #. type: tbl table
13017 #: build/C/man7/suffixes.7:103
13018 #, no-wrap
13019 msgid " .cc\tC++ source\n"
13020 msgstr ""
13021
13022 #. type: tbl table
13023 #: build/C/man7/suffixes.7:104
13024 #, no-wrap
13025 msgid " .cf\tconfiguration file\n"
13026 msgstr ""
13027
13028 #. type: tbl table
13029 #: build/C/man7/suffixes.7:105
13030 #, no-wrap
13031 msgid " .cfg\tconfiguration file\n"
13032 msgstr ""
13033
13034 #. type: tbl table
13035 #: build/C/man7/suffixes.7:106
13036 #, no-wrap
13037 msgid " .cgi\tWWW content generating script or program\n"
13038 msgstr ""
13039
13040 #. type: tbl table
13041 #: build/C/man7/suffixes.7:107
13042 #, no-wrap
13043 msgid " .cls\tLaTeX Class definition\n"
13044 msgstr ""
13045
13046 #. type: tbl table
13047 #: build/C/man7/suffixes.7:108
13048 #, no-wrap
13049 msgid " .class\tJava compiled byte-code\n"
13050 msgstr ""
13051
13052 #. type: tbl table
13053 #: build/C/man7/suffixes.7:109
13054 #, no-wrap
13055 msgid " .conf\tconfiguration file\n"
13056 msgstr ""
13057
13058 #. type: tbl table
13059 #: build/C/man7/suffixes.7:110
13060 #, no-wrap
13061 msgid " .config\tconfiguration file\n"
13062 msgstr ""
13063
13064 #. type: tbl table
13065 #: build/C/man7/suffixes.7:111
13066 #, no-wrap
13067 msgid " .cpp\tequivalent to I<.cc>\n"
13068 msgstr ""
13069
13070 #. type: tbl table
13071 #: build/C/man7/suffixes.7:112
13072 #, no-wrap
13073 msgid " .csh\tB<csh>(1) shell script\n"
13074 msgstr ""
13075
13076 #. type: tbl table
13077 #: build/C/man7/suffixes.7:113
13078 #, no-wrap
13079 msgid " .cxx\tequivalent to I<.cc>\n"
13080 msgstr ""
13081
13082 #. type: tbl table
13083 #: build/C/man7/suffixes.7:114
13084 #, no-wrap
13085 msgid " .dat\tdata file\n"
13086 msgstr ""
13087
13088 #. type: tbl table
13089 #: build/C/man7/suffixes.7:115
13090 #, no-wrap
13091 msgid " .deb\tDebian software package\n"
13092 msgstr ""
13093
13094 #. type: tbl table
13095 #: build/C/man7/suffixes.7:116
13096 #, no-wrap
13097 msgid " .def\tModula-2 source for definition modules\n"
13098 msgstr ""
13099
13100 #. type: tbl table
13101 #: build/C/man7/suffixes.7:117
13102 #, no-wrap
13103 msgid " .def\tother definition files\n"
13104 msgstr ""
13105
13106 #. type: tbl table
13107 #: build/C/man7/suffixes.7:118
13108 #, no-wrap
13109 msgid " .desc\tinitial part of mail message unpacked with\n"
13110 msgstr ""
13111
13112 #. type: tbl table
13113 #: build/C/man7/suffixes.7:119
13114 #, no-wrap
13115 msgid "\tB<munpack>(1)\n"
13116 msgstr ""
13117
13118 #. type: tbl table
13119 #: build/C/man7/suffixes.7:120
13120 #, no-wrap
13121 msgid " .diff\tfile differences (B<diff>(1) command output)\n"
13122 msgstr ""
13123
13124 #. type: tbl table
13125 #: build/C/man7/suffixes.7:121
13126 #, no-wrap
13127 msgid " .dir\tdbm data base directory file\n"
13128 msgstr ""
13129
13130 #. type: tbl table
13131 #: build/C/man7/suffixes.7:122
13132 #, no-wrap
13133 msgid " .doc\tdocumentation file\n"
13134 msgstr ""
13135
13136 #. type: tbl table
13137 #: build/C/man7/suffixes.7:123
13138 #, no-wrap
13139 msgid " .dsc\tDebian Source Control (source package)\n"
13140 msgstr ""
13141
13142 #. type: tbl table
13143 #: build/C/man7/suffixes.7:124
13144 #, no-wrap
13145 msgid " .dtx\tLaTeX package source file\n"
13146 msgstr ""
13147
13148 #. type: tbl table
13149 #: build/C/man7/suffixes.7:125
13150 #, no-wrap
13151 msgid " .dvi\tTeX's device independent output\n"
13152 msgstr ""
13153
13154 #. type: tbl table
13155 #: build/C/man7/suffixes.7:126
13156 #, no-wrap
13157 msgid " .el\tEmacs-Lisp source\n"
13158 msgstr ""
13159
13160 #. type: tbl table
13161 #: build/C/man7/suffixes.7:127
13162 #, no-wrap
13163 msgid " .elc\tcompiled Emacs-Lisp source\n"
13164 msgstr ""
13165
13166 #. type: tbl table
13167 #: build/C/man7/suffixes.7:128
13168 #, no-wrap
13169 msgid " .eps\tencapsulated PostScript\n"
13170 msgstr ""
13171
13172 #. type: tbl table
13173 #: build/C/man7/suffixes.7:129
13174 #, no-wrap
13175 msgid " .exp\tExpect source code\n"
13176 msgstr ""
13177
13178 #. type: tbl table
13179 #: build/C/man7/suffixes.7:130
13180 #, no-wrap
13181 msgid " .f\tFortran source\n"
13182 msgstr ""
13183
13184 #. type: tbl table
13185 #: build/C/man7/suffixes.7:131
13186 #, no-wrap
13187 msgid " .f77\tFortran 77 source\n"
13188 msgstr ""
13189
13190 #. type: tbl table
13191 #: build/C/man7/suffixes.7:132
13192 #, no-wrap
13193 msgid " .f90\tFortran 90 source\n"
13194 msgstr ""
13195
13196 #. type: tbl table
13197 #: build/C/man7/suffixes.7:133
13198 #, no-wrap
13199 msgid " .fas\tprecompiled Common-Lisp\n"
13200 msgstr ""
13201
13202 #. type: tbl table
13203 #: build/C/man7/suffixes.7:134
13204 #, no-wrap
13205 msgid " .fi\tFortran include files\n"
13206 msgstr ""
13207
13208 #. type: tbl table
13209 #: build/C/man7/suffixes.7:135
13210 #, no-wrap
13211 msgid " .fig\tFIG image file (used by B<xfig>(1))\n"
13212 msgstr ""
13213
13214 #. type: tbl table
13215 #: build/C/man7/suffixes.7:136
13216 #, no-wrap
13217 msgid " .fmt\tTeX format file\n"
13218 msgstr ""
13219
13220 #. type: tbl table
13221 #: build/C/man7/suffixes.7:137
13222 #, no-wrap
13223 msgid " .gif\tCompuserve Graphics Image File format\n"
13224 msgstr ""
13225
13226 #. type: tbl table
13227 #: build/C/man7/suffixes.7:138
13228 #, no-wrap
13229 msgid " .gmo\tGNU format message catalog\n"
13230 msgstr ""
13231
13232 #. type: tbl table
13233 #: build/C/man7/suffixes.7:139
13234 #, no-wrap
13235 msgid " .gsf\tGhostscript fonts\n"
13236 msgstr ""
13237
13238 #. type: tbl table
13239 #: build/C/man7/suffixes.7:140
13240 #, no-wrap
13241 msgid " .gz\tfile compressed using B<gzip>(1)\n"
13242 msgstr ""
13243
13244 #. type: tbl table
13245 #: build/C/man7/suffixes.7:141
13246 #, no-wrap
13247 msgid " .h\tC or C++ header files\n"
13248 msgstr ""
13249
13250 #. type: tbl table
13251 #: build/C/man7/suffixes.7:142
13252 #, no-wrap
13253 msgid " .help\thelp file\n"
13254 msgstr ""
13255
13256 #. type: tbl table
13257 #: build/C/man7/suffixes.7:143
13258 #, no-wrap
13259 msgid " .hf\tequivalent to I<.help>\n"
13260 msgstr ""
13261
13262 #. type: tbl table
13263 #: build/C/man7/suffixes.7:144
13264 #, no-wrap
13265 msgid " .hlp\tequivalent to I<.help>\n"
13266 msgstr ""
13267
13268 #. type: tbl table
13269 #: build/C/man7/suffixes.7:145
13270 #, no-wrap
13271 msgid " .htm\tpoor man's I<.html>\n"
13272 msgstr ""
13273
13274 #. type: tbl table
13275 #: build/C/man7/suffixes.7:146
13276 #, no-wrap
13277 msgid " .html\tHTML document used with the World Wide Web\n"
13278 msgstr ""
13279
13280 #. type: tbl table
13281 #: build/C/man7/suffixes.7:147
13282 #, no-wrap
13283 msgid " .hqx\t7-bit encoded Macintosh file\n"
13284 msgstr ""
13285
13286 #. type: tbl table
13287 #: build/C/man7/suffixes.7:148
13288 #, no-wrap
13289 msgid " .i\tC source after preprocessing\n"
13290 msgstr ""
13291
13292 #. type: tbl table
13293 #: build/C/man7/suffixes.7:149
13294 #, no-wrap
13295 msgid " .icon\tbitmap source\n"
13296 msgstr ""
13297
13298 #. type: tbl table
13299 #: build/C/man7/suffixes.7:150
13300 #, no-wrap
13301 msgid " .idx\treference or datum-index file for hypertext\n"
13302 msgstr ""
13303
13304 #. type: tbl table
13305 #: build/C/man7/suffixes.7:151
13306 #, no-wrap
13307 msgid "\tor database system\n"
13308 msgstr ""
13309
13310 #. type: tbl table
13311 #: build/C/man7/suffixes.7:152
13312 #, no-wrap
13313 msgid " .image\tbitmap source\n"
13314 msgstr ""
13315
13316 #. type: tbl table
13317 #: build/C/man7/suffixes.7:153
13318 #, no-wrap
13319 msgid " .in\tconfiguration template, especially for GNU Autoconf\n"
13320 msgstr ""
13321
13322 #. type: tbl table
13323 #: build/C/man7/suffixes.7:154
13324 #, no-wrap
13325 msgid " .info\tfiles for the Emacs info browser\n"
13326 msgstr ""
13327
13328 #. type: tbl table
13329 #: build/C/man7/suffixes.7:155
13330 #, no-wrap
13331 msgid " .info-[0-9]+\tsplit info files\n"
13332 msgstr ""
13333
13334 #. type: tbl table
13335 #: build/C/man7/suffixes.7:156
13336 #, no-wrap
13337 msgid " .ins\tLaTeX package install file for docstrip\n"
13338 msgstr ""
13339
13340 #. type: tbl table
13341 #: build/C/man7/suffixes.7:157
13342 #, no-wrap
13343 msgid " .itcl\titcl source code;\n"
13344 msgstr ""
13345
13346 #. type: tbl table
13347 #: build/C/man7/suffixes.7:158
13348 #, no-wrap
13349 msgid "\titcl ([incr Tcl]) is an OO extension of tcl\n"
13350 msgstr ""
13351
13352 #. type: tbl table
13353 #: build/C/man7/suffixes.7:159
13354 #, no-wrap
13355 msgid " .java\ta Java source file\n"
13356 msgstr ""
13357
13358 #. type: tbl table
13359 #: build/C/man7/suffixes.7:160
13360 #, no-wrap
13361 msgid " .jpeg\tJoint Photographic Experts Group format\n"
13362 msgstr ""
13363
13364 #. type: tbl table
13365 #: build/C/man7/suffixes.7:161
13366 #, no-wrap
13367 msgid " .jpg\tpoor man's I<.jpeg>\n"
13368 msgstr ""
13369
13370 #. type: tbl table
13371 #: build/C/man7/suffixes.7:162
13372 #, no-wrap
13373 msgid " .kmap\tB<lyx>(1) keymap\n"
13374 msgstr ""
13375
13376 #. type: tbl table
13377 #: build/C/man7/suffixes.7:163
13378 #, no-wrap
13379 msgid " .l\tequivalent to I<.lex> or I<.lisp>\n"
13380 msgstr ""
13381
13382 #. type: tbl table
13383 #: build/C/man7/suffixes.7:164
13384 #, no-wrap
13385 msgid " .lex\tB<lex>(1) or B<flex>(1) files\n"
13386 msgstr ""
13387
13388 #. type: tbl table
13389 #: build/C/man7/suffixes.7:165
13390 #, no-wrap
13391 msgid " .lha\tlharc archive\n"
13392 msgstr ""
13393
13394 #. type: tbl table
13395 #: build/C/man7/suffixes.7:166
13396 #, no-wrap
13397 msgid " .lib\tCommon-Lisp library\n"
13398 msgstr ""
13399
13400 #. type: tbl table
13401 #: build/C/man7/suffixes.7:167
13402 #, no-wrap
13403 msgid " .lisp\tLisp source\n"
13404 msgstr ""
13405
13406 #. type: tbl table
13407 #: build/C/man7/suffixes.7:168
13408 #, no-wrap
13409 msgid " .ln\tfiles for use with B<lint>(1)\n"
13410 msgstr ""
13411
13412 #. type: tbl table
13413 #: build/C/man7/suffixes.7:169
13414 #, no-wrap
13415 msgid " .log\tlog file, in particular produced by TeX\n"
13416 msgstr ""
13417
13418 #. type: tbl table
13419 #: build/C/man7/suffixes.7:170
13420 #, no-wrap
13421 msgid " .lsm\tLinux Software Map entry\n"
13422 msgstr ""
13423
13424 #. type: tbl table
13425 #: build/C/man7/suffixes.7:171
13426 #, no-wrap
13427 msgid " .lsp\tCommon-Lisp source\n"
13428 msgstr ""
13429
13430 #. type: tbl table
13431 #: build/C/man7/suffixes.7:172
13432 #, no-wrap
13433 msgid " .lzh\tlharc archive\n"
13434 msgstr ""
13435
13436 #. type: tbl table
13437 #: build/C/man7/suffixes.7:173
13438 #, no-wrap
13439 msgid " .m\tObjective-C source code\n"
13440 msgstr ""
13441
13442 #. type: tbl table
13443 #: build/C/man7/suffixes.7:174
13444 #, no-wrap
13445 msgid " .m4\tB<m4>(1) source\n"
13446 msgstr ""
13447
13448 #. type: tbl table
13449 #: build/C/man7/suffixes.7:175
13450 #, no-wrap
13451 msgid " .mac\tmacro files for various programs\n"
13452 msgstr ""
13453
13454 #. type: tbl table
13455 #: build/C/man7/suffixes.7:176
13456 #, no-wrap
13457 msgid " .man\tmanual page (usually source rather than formatted)\n"
13458 msgstr ""
13459
13460 #. type: tbl table
13461 #: build/C/man7/suffixes.7:177
13462 #, no-wrap
13463 msgid " .map\tmap files for various programs\n"
13464 msgstr ""
13465
13466 #. type: tbl table
13467 #: build/C/man7/suffixes.7:178
13468 #, no-wrap
13469 msgid " .me\tNroff source using the me macro package\n"
13470 msgstr ""
13471
13472 #. type: tbl table
13473 #: build/C/man7/suffixes.7:179
13474 #, no-wrap
13475 msgid " .mf\tMetafont (font generator for TeX) source\n"
13476 msgstr ""
13477
13478 #. type: tbl table
13479 #: build/C/man7/suffixes.7:180
13480 #, no-wrap
13481 msgid " .mgp\tMagicPoint file\n"
13482 msgstr ""
13483
13484 #. type: tbl table
13485 #: build/C/man7/suffixes.7:181
13486 #, no-wrap
13487 msgid " .mm\tsources for B<groff>(1) in mm - format\n"
13488 msgstr ""
13489
13490 #. type: tbl table
13491 #: build/C/man7/suffixes.7:182
13492 #, no-wrap
13493 msgid " .mo\tMessage catalog binary file\n"
13494 msgstr ""
13495
13496 #. type: tbl table
13497 #: build/C/man7/suffixes.7:183
13498 #, no-wrap
13499 msgid " .mod\tModula-2 source for implementation modules\n"
13500 msgstr ""
13501
13502 #. type: tbl table
13503 #: build/C/man7/suffixes.7:184
13504 #, no-wrap
13505 msgid " .mov\t(quicktime) movie\n"
13506 msgstr ""
13507
13508 #. type: tbl table
13509 #: build/C/man7/suffixes.7:185
13510 #, no-wrap
13511 msgid " .mp\tMetapost source\n"
13512 msgstr ""
13513
13514 #. type: tbl table
13515 #: build/C/man7/suffixes.7:186
13516 #, no-wrap
13517 msgid " .mp2\tMPEG Layer 2 (audio) file\n"
13518 msgstr ""
13519
13520 #. type: tbl table
13521 #: build/C/man7/suffixes.7:187
13522 #, no-wrap
13523 msgid " .mp3\tMPEG Layer 3 (audio) file\n"
13524 msgstr ""
13525
13526 #. type: tbl table
13527 #: build/C/man7/suffixes.7:188
13528 #, no-wrap
13529 msgid " .mpeg\tmovie file\n"
13530 msgstr ""
13531
13532 #. type: tbl table
13533 #: build/C/man7/suffixes.7:189
13534 #, no-wrap
13535 msgid " .o\tobject file\n"
13536 msgstr ""
13537
13538 #. type: tbl table
13539 #: build/C/man7/suffixes.7:190
13540 #, no-wrap
13541 msgid " .old\told or backup file\n"
13542 msgstr ""
13543
13544 #. type: tbl table
13545 #: build/C/man7/suffixes.7:191
13546 #, no-wrap
13547 msgid " .orig\tbackup (original) version of a file, from B<patch>(1)\n"
13548 msgstr ""
13549
13550 #. type: tbl table
13551 #: build/C/man7/suffixes.7:192
13552 #, no-wrap
13553 msgid " .out\toutput file, often executable program (a.out)\n"
13554 msgstr ""
13555
13556 #. type: tbl table
13557 #: build/C/man7/suffixes.7:193
13558 #, no-wrap
13559 msgid " .p\tPascal source\n"
13560 msgstr ""
13561
13562 #. type: tbl table
13563 #: build/C/man7/suffixes.7:194
13564 #, no-wrap
13565 msgid " .pag\tdbm data base data file\n"
13566 msgstr ""
13567
13568 #. type: tbl table
13569 #: build/C/man7/suffixes.7:195
13570 #, no-wrap
13571 msgid " .patch\tfile differences for B<patch>(1)\n"
13572 msgstr ""
13573
13574 #. type: tbl table
13575 #: build/C/man7/suffixes.7:196
13576 #, no-wrap
13577 msgid " .pbm\tportable bitmap format\n"
13578 msgstr ""
13579
13580 #. type: tbl table
13581 #: build/C/man7/suffixes.7:197
13582 #, no-wrap
13583 msgid " .pcf\tX11 font files\n"
13584 msgstr ""
13585
13586 #. type: tbl table
13587 #: build/C/man7/suffixes.7:198
13588 #, no-wrap
13589 msgid " .pdf\tAdobe Portable Data Format\n"
13590 msgstr ""
13591
13592 #. type: tbl table
13593 #: build/C/man7/suffixes.7:199
13594 #, no-wrap
13595 msgid "\t(use Acrobat/B<acroread> or B<xpdf>)\n"
13596 msgstr ""
13597
13598 #. type: tbl table
13599 #: build/C/man7/suffixes.7:200
13600 #, no-wrap
13601 msgid " .perl\tPerl source (see .ph, .pl and .pm)\n"
13602 msgstr ""
13603
13604 #. type: tbl table
13605 #: build/C/man7/suffixes.7:201
13606 #, no-wrap
13607 msgid " .pfa\tPostScript font definition files, ASCII format\n"
13608 msgstr ""
13609
13610 #. type: tbl table
13611 #: build/C/man7/suffixes.7:202
13612 #, no-wrap
13613 msgid " .pfb\tPostScript font definition files, binary format\n"
13614 msgstr ""
13615
13616 #. type: tbl table
13617 #: build/C/man7/suffixes.7:203
13618 #, no-wrap
13619 msgid " .pgm\tportable greymap format\n"
13620 msgstr ""
13621
13622 #. type: tbl table
13623 #: build/C/man7/suffixes.7:204
13624 #, no-wrap
13625 msgid " .pgp\tPGP binary data\n"
13626 msgstr ""
13627
13628 #. type: tbl table
13629 #: build/C/man7/suffixes.7:205
13630 #, no-wrap
13631 msgid " .ph\tPerl header file\n"
13632 msgstr ""
13633
13634 #. type: tbl table
13635 #: build/C/man7/suffixes.7:206
13636 #, no-wrap
13637 msgid " .php\tPHP program file\n"
13638 msgstr ""
13639
13640 #. type: tbl table
13641 #: build/C/man7/suffixes.7:207
13642 #, no-wrap
13643 msgid " .php3\tPHP3 program file\n"
13644 msgstr ""
13645
13646 #. type: tbl table
13647 #: build/C/man7/suffixes.7:208
13648 #, no-wrap
13649 msgid " .pid\tFile to store daemon PID (e.g., crond.pid)\n"
13650 msgstr ""
13651
13652 #. type: tbl table
13653 #: build/C/man7/suffixes.7:209
13654 #, no-wrap
13655 msgid " .pl\tTeX property list file or Perl library file\n"
13656 msgstr ""
13657
13658 #. type: tbl table
13659 #: build/C/man7/suffixes.7:210
13660 #, no-wrap
13661 msgid " .pm\tPerl module\n"
13662 msgstr ""
13663
13664 #. type: tbl table
13665 #: build/C/man7/suffixes.7:211
13666 #, no-wrap
13667 msgid " .png\tPortable Network Graphics file\n"
13668 msgstr ""
13669
13670 #. type: tbl table
13671 #: build/C/man7/suffixes.7:212
13672 #, no-wrap
13673 msgid " .po\tMessage catalog source\n"
13674 msgstr ""
13675
13676 #. type: tbl table
13677 #: build/C/man7/suffixes.7:213
13678 #, no-wrap
13679 msgid " .pod\tB<perldoc>(1) file\n"
13680 msgstr ""
13681
13682 #. type: tbl table
13683 #: build/C/man7/suffixes.7:214
13684 #, no-wrap
13685 msgid " .ppm\tportable pixmap format\n"
13686 msgstr ""
13687
13688 #. type: tbl table
13689 #: build/C/man7/suffixes.7:215
13690 #, no-wrap
13691 msgid " .pr\tbitmap source\n"
13692 msgstr ""
13693
13694 #. type: tbl table
13695 #: build/C/man7/suffixes.7:216
13696 #, no-wrap
13697 msgid " .ps\tPostScript file\n"
13698 msgstr ""
13699
13700 #. type: tbl table
13701 #: build/C/man7/suffixes.7:217
13702 #, no-wrap
13703 msgid " .py\tPython source\n"
13704 msgstr ""
13705
13706 #. type: tbl table
13707 #: build/C/man7/suffixes.7:218
13708 #, no-wrap
13709 msgid " .pyc\tcompiled python\n"
13710 msgstr ""
13711
13712 #. type: tbl table
13713 #: build/C/man7/suffixes.7:219
13714 #, no-wrap
13715 msgid " .qt\tquicktime movie\n"
13716 msgstr ""
13717
13718 #. type: tbl table
13719 #: build/C/man7/suffixes.7:220
13720 #, no-wrap
13721 msgid " .r\tRATFOR source (obsolete)\n"
13722 msgstr ""
13723
13724 #. type: tbl table
13725 #: build/C/man7/suffixes.7:221
13726 #, no-wrap
13727 msgid " .rej\tpatches that B<patch>(1) couldn't apply\n"
13728 msgstr ""
13729
13730 #. type: tbl table
13731 #: build/C/man7/suffixes.7:222
13732 #, no-wrap
13733 msgid " .rpm\tRPM software package\n"
13734 msgstr ""
13735
13736 #. type: tbl table
13737 #: build/C/man7/suffixes.7:223
13738 #, no-wrap
13739 msgid " .rtf\tRich Text Format file\n"
13740 msgstr ""
13741
13742 #. type: tbl table
13743 #: build/C/man7/suffixes.7:224
13744 #, no-wrap
13745 msgid " .rules\trules for something\n"
13746 msgstr ""
13747
13748 #. type: tbl table
13749 #: build/C/man7/suffixes.7:225
13750 #, no-wrap
13751 msgid " .s\tassembler source\n"
13752 msgstr ""
13753
13754 #. type: tbl table
13755 #: build/C/man7/suffixes.7:226
13756 #, no-wrap
13757 msgid " .sa\tstub libraries for a.out shared libraries\n"
13758 msgstr ""
13759
13760 #. type: tbl table
13761 #: build/C/man7/suffixes.7:227
13762 #, no-wrap
13763 msgid " .sc\tB<sc>(1) spreadsheet commands\n"
13764 msgstr ""
13765
13766 #. type: tbl table
13767 #: build/C/man7/suffixes.7:228
13768 #, no-wrap
13769 msgid " .scm\tScheme source code\n"
13770 msgstr ""
13771
13772 #. type: tbl table
13773 #: build/C/man7/suffixes.7:229
13774 #, no-wrap
13775 msgid " .sed\tsed source file\n"
13776 msgstr ""
13777
13778 #. type: tbl table
13779 #: build/C/man7/suffixes.7:230
13780 #, no-wrap
13781 msgid " .sgml\tSGML source file\n"
13782 msgstr ""
13783
13784 #. type: tbl table
13785 #: build/C/man7/suffixes.7:231
13786 #, no-wrap
13787 msgid " .sh\tB<sh>(1) scripts\n"
13788 msgstr ""
13789
13790 #. type: tbl table
13791 #: build/C/man7/suffixes.7:232
13792 #, no-wrap
13793 msgid " .shar\tarchive created by the B<shar>(1) utility\n"
13794 msgstr ""
13795
13796 #. type: tbl table
13797 #: build/C/man7/suffixes.7:233
13798 #, no-wrap
13799 msgid " .so\tShared library or dynamically loadable object\n"
13800 msgstr ""
13801
13802 #. type: tbl table
13803 #: build/C/man7/suffixes.7:234
13804 #, no-wrap
13805 msgid " .sql\tSQL source\n"
13806 msgstr ""
13807
13808 #. type: tbl table
13809 #: build/C/man7/suffixes.7:235
13810 #, no-wrap
13811 msgid " .sqml\tSQML schema or query program\n"
13812 msgstr ""
13813
13814 #. type: tbl table
13815 #: build/C/man7/suffixes.7:236
13816 #, no-wrap
13817 msgid " .sty\tLaTeX style files\n"
13818 msgstr ""
13819
13820 #. type: tbl table
13821 #: build/C/man7/suffixes.7:237
13822 #, no-wrap
13823 msgid " .sym\tModula-2 compiled definition modules\n"
13824 msgstr ""
13825
13826 #. type: tbl table
13827 #: build/C/man7/suffixes.7:238
13828 #, no-wrap
13829 msgid " .tar\tarchive created by the B<tar>(1) utility\n"
13830 msgstr ""
13831
13832 #. type: tbl table
13833 #: build/C/man7/suffixes.7:239
13834 #, no-wrap
13835 msgid " .tar.Z\ttar(1) archive compressed with B<compress>(1)\n"
13836 msgstr ""
13837
13838 #. type: tbl table
13839 #: build/C/man7/suffixes.7:240
13840 #, no-wrap
13841 msgid " .tar.bz2\ttar(1) archive compressed with B<bzip2>(1)\n"
13842 msgstr ""
13843
13844 #. type: tbl table
13845 #: build/C/man7/suffixes.7:241
13846 #, no-wrap
13847 msgid " .tar.gz\ttar(1) archive compressed with B<gzip>(1)\n"
13848 msgstr ""
13849
13850 #. type: tbl table
13851 #: build/C/man7/suffixes.7:242
13852 #, no-wrap
13853 msgid " .taz\ttar(1) archive compressed with B<compress>(1)\n"
13854 msgstr ""
13855
13856 #. type: tbl table
13857 #: build/C/man7/suffixes.7:243
13858 #, no-wrap
13859 msgid " .tcl\ttcl source code\n"
13860 msgstr ""
13861
13862 #. type: tbl table
13863 #: build/C/man7/suffixes.7:244
13864 #, no-wrap
13865 msgid " .tex\tTeX or LaTeX source\n"
13866 msgstr ""
13867
13868 #. type: tbl table
13869 #: build/C/man7/suffixes.7:245
13870 #, no-wrap
13871 msgid " .texi\tequivalent to I<.texinfo>\n"
13872 msgstr ""
13873
13874 #. type: tbl table
13875 #: build/C/man7/suffixes.7:246
13876 #, no-wrap
13877 msgid " .texinfo\tTexinfo documentation source\n"
13878 msgstr ""
13879
13880 #. type: tbl table
13881 #: build/C/man7/suffixes.7:247
13882 #, no-wrap
13883 msgid " .text\ttext file\n"
13884 msgstr ""
13885
13886 #. type: tbl table
13887 #: build/C/man7/suffixes.7:248
13888 #, no-wrap
13889 msgid " .tfm\tTeX font metric file\n"
13890 msgstr ""
13891
13892 #. type: tbl table
13893 #: build/C/man7/suffixes.7:249
13894 #, no-wrap
13895 msgid " .tgz\ttar archive compressed with B<gzip>(1)\n"
13896 msgstr ""
13897
13898 #. type: tbl table
13899 #: build/C/man7/suffixes.7:250
13900 #, no-wrap
13901 msgid " .tif\tpoor man's I<.tiff>\n"
13902 msgstr ""
13903
13904 #. type: tbl table
13905 #: build/C/man7/suffixes.7:251
13906 #, no-wrap
13907 msgid " .tiff\tTagged Image File Format\n"
13908 msgstr ""
13909
13910 #. type: tbl table
13911 #: build/C/man7/suffixes.7:252
13912 #, no-wrap
13913 msgid " .tk\ttcl/tk script\n"
13914 msgstr ""
13915
13916 #. type: tbl table
13917 #: build/C/man7/suffixes.7:253
13918 #, no-wrap
13919 msgid " .tmp\ttemporary file\n"
13920 msgstr ""
13921
13922 #. type: tbl table
13923 #: build/C/man7/suffixes.7:254
13924 #, no-wrap
13925 msgid " .tmpl\ttemplate files\n"
13926 msgstr ""
13927
13928 #. type: tbl table
13929 #: build/C/man7/suffixes.7:255
13930 #, no-wrap
13931 msgid " .txt\tequivalent to I<.text>\n"
13932 msgstr ""
13933
13934 #. type: tbl table
13935 #: build/C/man7/suffixes.7:256
13936 #, no-wrap
13937 msgid " .uu\tequivalent to I<.uue>\n"
13938 msgstr ""
13939
13940 #. type: tbl table
13941 #: build/C/man7/suffixes.7:257
13942 #, no-wrap
13943 msgid " .uue\tbinary file encoded with B<uuencode>(1)\n"
13944 msgstr ""
13945
13946 #. type: tbl table
13947 #: build/C/man7/suffixes.7:258
13948 #, no-wrap
13949 msgid " .vf\tTeX virtual font file\n"
13950 msgstr ""
13951
13952 #. type: tbl table
13953 #: build/C/man7/suffixes.7:259
13954 #, no-wrap
13955 msgid " .vpl\tTeX virtual property list file\n"
13956 msgstr ""
13957
13958 #. type: tbl table
13959 #: build/C/man7/suffixes.7:260
13960 #, no-wrap
13961 msgid " .w\tSilvio Levi's CWEB\n"
13962 msgstr ""
13963
13964 #. type: tbl table
13965 #: build/C/man7/suffixes.7:261
13966 #, no-wrap
13967 msgid " .wav\twave sound file\n"
13968 msgstr ""
13969
13970 #. type: tbl table
13971 #: build/C/man7/suffixes.7:262
13972 #, no-wrap
13973 msgid " .web\tDonald Knuth's WEB\n"
13974 msgstr ""
13975
13976 #. type: tbl table
13977 #: build/C/man7/suffixes.7:263
13978 #, no-wrap
13979 msgid " .wml\tSource file for Web Meta Language\n"
13980 msgstr ""
13981
13982 #. type: tbl table
13983 #: build/C/man7/suffixes.7:264
13984 #, no-wrap
13985 msgid " .xbm\tX11 bitmap source\n"
13986 msgstr ""
13987
13988 #. type: tbl table
13989 #: build/C/man7/suffixes.7:265
13990 #, no-wrap
13991 msgid " .xcf\tGIMP graphic\n"
13992 msgstr ""
13993
13994 #. type: tbl table
13995 #: build/C/man7/suffixes.7:266
13996 #, no-wrap
13997 msgid " .xml\teXtended Markup Language file\n"
13998 msgstr ""
13999
14000 #. type: tbl table
14001 #: build/C/man7/suffixes.7:267
14002 #, no-wrap
14003 msgid " .xpm\tX11 pixmap source\n"
14004 msgstr ""
14005
14006 #. type: tbl table
14007 #: build/C/man7/suffixes.7:268
14008 #, no-wrap
14009 msgid " .xs\tPerl xsub file produced by h2xs\n"
14010 msgstr ""
14011
14012 #. type: tbl table
14013 #: build/C/man7/suffixes.7:269
14014 #, no-wrap
14015 msgid " .xsl\tXSL stylesheet\n"
14016 msgstr ""
14017
14018 #. type: tbl table
14019 #: build/C/man7/suffixes.7:270
14020 #, no-wrap
14021 msgid " .y\tB<yacc>(1) or B<bison>(1) (parser generator) files\n"
14022 msgstr ""
14023
14024 #. type: tbl table
14025 #: build/C/man7/suffixes.7:271
14026 #, no-wrap
14027 msgid " .z\tFile compressed using B<pack>(1) (or an old B<gzip>(1))\n"
14028 msgstr ""
14029
14030 #. type: tbl table
14031 #: build/C/man7/suffixes.7:272
14032 #, no-wrap
14033 msgid " .zip\tB<zip>(1) archive\n"
14034 msgstr ""
14035
14036 #. type: tbl table
14037 #: build/C/man7/suffixes.7:273
14038 #, no-wrap
14039 msgid " .zoo\tB<zoo>(1) archive\n"
14040 msgstr ""
14041
14042 #. type: tbl table
14043 #: build/C/man7/suffixes.7:274
14044 #, no-wrap
14045 msgid " ~\tEmacs or B<patch>(1) backup file\n"
14046 msgstr ""
14047
14048 #. type: tbl table
14049 #: build/C/man7/suffixes.7:275
14050 #, no-wrap
14051 msgid " rc\tstartup (`run control') file, e.g., I<.newsrc>\n"
14052 msgstr ""
14053
14054 #. type: Plain text
14055 #: build/C/man7/suffixes.7:279
14056 msgid "General UNIX conventions."
14057 msgstr ""
14058
14059 #. type: Plain text
14060 #: build/C/man7/suffixes.7:281
14061 msgid "This list is not exhaustive."
14062 msgstr ""
14063
14064 #. type: Plain text
14065 #: build/C/man7/suffixes.7:284
14066 msgid "B<file>(1), B<make>(1)"
14067 msgstr ""
14068
14069 #. type: TH
14070 #: build/C/man3/undocumented.3:29
14071 #, no-wrap
14072 msgid "UNDOCUMENTED"
14073 msgstr ""
14074
14075 #. type: TH
14076 #: build/C/man3/undocumented.3:29
14077 #, no-wrap
14078 msgid "2012-12-21"
14079 msgstr ""
14080
14081 #. type: Plain text
14082 #: build/C/man3/undocumented.3:32
14083 msgid "none - undocumented library functions"
14084 msgstr ""
14085
14086 #. type: Plain text
14087 #: build/C/man3/undocumented.3:34
14088 msgid "Undocumented library functions"
14089 msgstr ""
14090
14091 #. type: Plain text
14092 #: build/C/man3/undocumented.3:37
14093 msgid ""
14094 "This man page mentions those library functions which are implemented in the "
14095 "standard libraries but not yet documented in man pages."
14096 msgstr ""
14097
14098 #. type: SS
14099 #: build/C/man3/undocumented.3:37
14100 #, no-wrap
14101 msgid "Solicitation"
14102 msgstr ""
14103
14104 #. type: Plain text
14105 #: build/C/man3/undocumented.3:43
14106 msgid ""
14107 "If you have information about these functions, please look in the source "
14108 "code, write a man page (using a style similar to that of the other Linux "
14109 "section 3 man pages), and send it to B<mtk.manpages@gmail.com> for inclusion "
14110 "in the next man page release."
14111 msgstr ""
14112
14113 #. type: SS
14114 #: build/C/man3/undocumented.3:43
14115 #, no-wrap
14116 msgid "The list"
14117 msgstr ""
14118
14119 #.  .BR chflags (3),
14120 #.  .BR fattach (3),
14121 #.  .BR fchflags (3),
14122 #.  .BR fclean (3),
14123 #.  .BR fdetach (3),
14124 #.  .BR obstack stuff (3),
14125 #. type: Plain text
14126 #: build/C/man3/undocumented.3:183
14127 msgid ""
14128 "B<authdes_create>(3), B<authdes_getucred>(3), B<authdes_pk_create>(3), "
14129 "B<clntunix_create>(3), B<creat64>(3), B<dn_skipname>(3), B<fcrypt>(3), "
14130 "B<fp_nquery>(3), B<fp_query>(3), B<fp_resstat>(3), B<freading>(3), "
14131 "B<freopen64>(3), B<fseeko64>(3), B<ftello64>(3), B<ftw64>(3), B<fwscanf>(3), "
14132 "B<get_avphys_pages>(3), B<getdirentries64>(3), B<getmsg>(3), "
14133 "B<getnetname>(3), B<get_nprocs>(3), B<get_nprocs_conf>(3), "
14134 "B<get_phys_pages>(3), B<getpublickey>(3), B<getsecretkey>(3), "
14135 "B<h_errlist>(3), B<host2netname>(3), B<hostalias>(3), B<inet_nsap_addr>(3), "
14136 "B<inet_nsap_ntoa>(3), B<init_des>(3), B<libc_nls_init>(3), B<lio_listio>(3), "
14137 "B<mstats>(3), B<netname2host>(3), B<netname2user>(3), B<nlist>(3), "
14138 "B<obstack_free>(3), B<parse_printf_format>(3), B<p_cdname>(3), "
14139 "B<p_cdnname>(3), B<p_class>(3), B<p_fqname>(3), B<p_option>(3), "
14140 "B<p_query>(3), B<printf_size>(3), B<printf_size_info>(3), B<p_rr>(3), "
14141 "B<p_time>(3), B<p_type>(3), B<putlong>(3), B<putshort>(3), "
14142 "B<re_compile_fastmap>(3), B<re_compile_pattern>(3), "
14143 "B<register_printf_function>(3), B<re_match>(3), B<re_match_2>(3), "
14144 "B<re_rx_search>(3), B<re_search>(3), B<re_search_2>(3), "
14145 "B<re_set_registers>(3), B<re_set_syntax>(3), B<res_send_setqhook>(3), "
14146 "B<res_send_setrhook>(3), B<ruserpass>(3), B<setfileno>(3), "
14147 "B<sethostfile>(3), B<svc_exit>(3), B<svcudp_enablecache>(3), B<tell>(3), "
14148 "B<tr_break>(3), B<tzsetwall>(3), B<ufc_dofinalperm>(3), B<ufc_doit>(3), "
14149 "B<user2netname>(3), B<vlimit>(3), B<vtimes>(3), B<wcschrnul>(3), "
14150 "B<wcsftime>(3), B<wscanf>(3), B<xdr_authdes_cred>(3), "
14151 "B<xdr_authdes_verf>(3), B<xdr_cryptkeyarg>(3), B<xdr_cryptkeyres>(3), "
14152 "B<xdr_datum>(3), B<xdr_des_block>(3), B<xdr_domainname>(3), "
14153 "B<xdr_getcredres>(3), B<xdr_keybuf>(3), B<xdr_keystatus>(3), "
14154 "B<xdr_mapname>(3), B<xdr_netnamestr>(3), B<xdr_netobj>(3), B<xdr_passwd>(3), "
14155 "B<xdr_peername>(3), B<xdr_rmtcall_args>(3), B<xdr_rmtcallres>(3), "
14156 "B<xdr_unixcred>(3), B<xdr_yp_buf>(3), B<xdr_yp_inaddr>(3), "
14157 "B<xdr_ypbind_binding>(3), B<xdr_ypbind_resp>(3), B<xdr_ypbind_resptype>(3), "
14158 "B<xdr_ypbind_setdom>(3), B<xdr_ypdelete_args>(3), B<xdr_ypmaplist>(3), "
14159 "B<xdr_ypmaplist_str>(3), B<xdr_yppasswd>(3), B<xdr_ypreq_key>(3), "
14160 "B<xdr_ypreq_nokey>(3), B<xdr_ypresp_all>(3), B<xdr_ypresp_all_seq>(3), "
14161 "B<xdr_ypresp_key_val>(3), B<xdr_ypresp_maplist>(3), B<xdr_ypresp_master>(3), "
14162 "B<xdr_ypresp_order>(3), B<xdr_ypresp_val>(3), B<xdr_ypstat>(3), "
14163 "B<xdr_ypupdate_args>(3), B<yp_all>(3), B<yp_bind>(3), B<yperr_string>(3), "
14164 "B<yp_first>(3), B<yp_get_default_domain>(3), B<yp_maplist>(3), "
14165 "B<yp_master>(3), B<yp_match>(3), B<yp_next>(3), B<yp_order>(3), "
14166 "B<ypprot_err>(3), B<yp_unbind>(3), B<yp_update>(3)"
14167 msgstr ""
14168
14169 #. type: TH
14170 #: build/C/man2/unimplemented.2:26
14171 #, no-wrap
14172 msgid "UNIMPLEMENTED"
14173 msgstr ""
14174
14175 #. type: TH
14176 #: build/C/man2/unimplemented.2:26
14177 #, no-wrap
14178 msgid "2013-02-12"
14179 msgstr ""
14180
14181 #. type: Plain text
14182 #: build/C/man2/unimplemented.2:31
14183 msgid ""
14184 "afs_syscall, break, fattach, fdetach, ftime, getmsg, getpmsg, gtty, "
14185 "isastream, lock, madvise1, mpx, prof, profil, putmsg, putpmsg, security, "
14186 "stty, tuxcall, ulimit, vserver - unimplemented system calls"
14187 msgstr ""
14188
14189 #. type: Plain text
14190 #: build/C/man2/unimplemented.2:33
14191 msgid "Unimplemented system calls."
14192 msgstr ""
14193
14194 #. type: Plain text
14195 #: build/C/man2/unimplemented.2:35
14196 msgid "These system calls are not implemented in the Linux kernel."
14197 msgstr ""
14198
14199 #. type: Plain text
14200 #: build/C/man2/unimplemented.2:40
14201 msgid "These system calls always return -1 and set I<errno> to B<ENOSYS>."
14202 msgstr ""
14203
14204 #. type: Plain text
14205 #: build/C/man2/unimplemented.2:47
14206 msgid ""
14207 "Note that B<ftime>(3), B<profil>(3)  and B<ulimit>(3)  are implemented as "
14208 "library functions."
14209 msgstr ""
14210
14211 #. type: Plain text
14212 #: build/C/man2/unimplemented.2:56
14213 msgid ""
14214 "Some system calls, like B<alloc_hugepages>(2), B<free_hugepages>(2), "
14215 "B<ioperm>(2), B<iopl>(2), and B<vm86>(2)  exist only on certain "
14216 "architectures."
14217 msgstr ""
14218
14219 #. type: Plain text
14220 #: build/C/man2/unimplemented.2:64
14221 msgid ""
14222 "Some system calls, like B<ipc>(2), B<create_module>(2), B<init_module>(2), "
14223 "and B<delete_module>(2)  exist only when the Linux kernel was built with "
14224 "support for them."
14225 msgstr ""
14226
14227 #. type: Plain text
14228 #: build/C/man2/unimplemented.2:66
14229 msgid "B<syscalls>(2)"
14230 msgstr ""
14231
14232 #. type: TH
14233 #: build/C/man7/units.7:26
14234 #, no-wrap
14235 msgid "UNITS"
14236 msgstr ""
14237
14238 #. type: Plain text
14239 #: build/C/man7/units.7:29
14240 msgid "units, kilo, kibi, mega, mebi, giga, gibi - decimal and binary prefixes"
14241 msgstr ""
14242
14243 #. type: SS
14244 #: build/C/man7/units.7:30
14245 #, no-wrap
14246 msgid "Decimal prefixes"
14247 msgstr ""
14248
14249 #. type: Plain text
14250 #: build/C/man7/units.7:34
14251 msgid ""
14252 "The SI system of units uses prefixes that indicate powers of ten.  A "
14253 "kilometer is 1000 meter, and a megawatt is 1000000 watt.  Below the standard "
14254 "prefixes."
14255 msgstr ""
14256
14257 #. type: tbl table
14258 #: build/C/man7/units.7:37 build/C/man7/units.7:79
14259 #, no-wrap
14260 msgid "Prefix\tName\tValue\n"
14261 msgstr ""
14262
14263 #. type: tbl table
14264 #: build/C/man7/units.7:38
14265 #, no-wrap
14266 msgid "y\tyocto\t10^-24 = 0.000000000000000000000001\n"
14267 msgstr ""
14268
14269 #. type: tbl table
14270 #: build/C/man7/units.7:39
14271 #, no-wrap
14272 msgid "z\tzepto\t10^-21 = 0.000000000000000000001\n"
14273 msgstr ""
14274
14275 #. type: tbl table
14276 #: build/C/man7/units.7:40
14277 #, no-wrap
14278 msgid "a\tatto\t10^-18 = 0.000000000000000001\n"
14279 msgstr ""
14280
14281 #. type: tbl table
14282 #: build/C/man7/units.7:41
14283 #, no-wrap
14284 msgid "f\tfemto\t10^-15 = 0.000000000000001\n"
14285 msgstr ""
14286
14287 #. type: tbl table
14288 #: build/C/man7/units.7:42
14289 #, no-wrap
14290 msgid "p\tpico\t10^-12 = 0.000000000001\n"
14291 msgstr ""
14292
14293 #. type: tbl table
14294 #: build/C/man7/units.7:43
14295 #, no-wrap
14296 msgid "n\tnano\t10^-9  = 0.000000001\n"
14297 msgstr ""
14298
14299 #. type: tbl table
14300 #: build/C/man7/units.7:44
14301 #, no-wrap
14302 msgid "\\(mc\tmicro\t10^-6  = 0.000001\n"
14303 msgstr ""
14304
14305 #. type: tbl table
14306 #: build/C/man7/units.7:45
14307 #, no-wrap
14308 msgid "m\tmilli\t10^-3  = 0.001\n"
14309 msgstr ""
14310
14311 #. type: tbl table
14312 #: build/C/man7/units.7:46
14313 #, no-wrap
14314 msgid "c\tcenti\t10^-2  = 0.01\n"
14315 msgstr ""
14316
14317 #. type: tbl table
14318 #: build/C/man7/units.7:47
14319 #, no-wrap
14320 msgid "d\tdeci\t10^-1  = 0.1\n"
14321 msgstr ""
14322
14323 #. type: tbl table
14324 #: build/C/man7/units.7:48
14325 #, no-wrap
14326 msgid "da\tdeka\t10^ 1  = 10\n"
14327 msgstr ""
14328
14329 #. type: tbl table
14330 #: build/C/man7/units.7:49
14331 #, no-wrap
14332 msgid "h\thecto\t10^ 2  = 100\n"
14333 msgstr ""
14334
14335 #. type: tbl table
14336 #: build/C/man7/units.7:50
14337 #, no-wrap
14338 msgid "k\tkilo\t10^ 3  = 1000\n"
14339 msgstr ""
14340
14341 #. type: tbl table
14342 #: build/C/man7/units.7:51
14343 #, no-wrap
14344 msgid "M\tmega\t10^ 6  = 1000000\n"
14345 msgstr ""
14346
14347 #. type: tbl table
14348 #: build/C/man7/units.7:52
14349 #, no-wrap
14350 msgid "G\tgiga\t10^ 9  = 1000000000\n"
14351 msgstr ""
14352
14353 #. type: tbl table
14354 #: build/C/man7/units.7:53
14355 #, no-wrap
14356 msgid "T\ttera\t10^12  = 1000000000000\n"
14357 msgstr ""
14358
14359 #. type: tbl table
14360 #: build/C/man7/units.7:54
14361 #, no-wrap
14362 msgid "P\tpeta\t10^15  = 1000000000000000\n"
14363 msgstr ""
14364
14365 #. type: tbl table
14366 #: build/C/man7/units.7:55
14367 #, no-wrap
14368 msgid "E\texa\t10^18  = 1000000000000000000\n"
14369 msgstr ""
14370
14371 #. type: tbl table
14372 #: build/C/man7/units.7:56
14373 #, no-wrap
14374 msgid "Z\tzetta\t10^21  = 1000000000000000000000\n"
14375 msgstr ""
14376
14377 #. type: tbl table
14378 #: build/C/man7/units.7:57
14379 #, no-wrap
14380 msgid "Y\tyotta\t10^24  = 1000000000000000000000000\n"
14381 msgstr ""
14382
14383 #. type: Plain text
14384 #: build/C/man7/units.7:64
14385 msgid ""
14386 "The symbol for micro is the Greek letter mu, often written u in an ASCII "
14387 "context where this Greek letter is not available.  See also"
14388 msgstr ""
14389
14390 #. type: Plain text
14391 #: build/C/man7/units.7:68
14392 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/prefixes.html> E<.UE>"
14393 msgstr ""
14394
14395 #. type: SS
14396 #: build/C/man7/units.7:69
14397 #, no-wrap
14398 msgid "Binary prefixes"
14399 msgstr ""
14400
14401 #. type: Plain text
14402 #: build/C/man7/units.7:76
14403 msgid ""
14404 "The binary prefixes resemble the decimal ones, but have an additional "
14405 "\\(aqi\\(aq (and \"Ki\" starts with a capital \\(aqK\\(aq).  The names are "
14406 "formed by taking the first syllable of the names of the decimal prefix with "
14407 "roughly the same size, followed by \"bi\" for \"binary\"."
14408 msgstr ""
14409
14410 #. type: tbl table
14411 #: build/C/man7/units.7:80
14412 #, no-wrap
14413 msgid "Ki\tkibi\t2^10 = 1024\n"
14414 msgstr ""
14415
14416 #. type: tbl table
14417 #: build/C/man7/units.7:81
14418 #, no-wrap
14419 msgid "Mi\tmebi\t2^20 = 1048576\n"
14420 msgstr ""
14421
14422 #. type: tbl table
14423 #: build/C/man7/units.7:82
14424 #, no-wrap
14425 msgid "Gi\tgibi\t2^30 = 1073741824\n"
14426 msgstr ""
14427
14428 #. type: tbl table
14429 #: build/C/man7/units.7:83
14430 #, no-wrap
14431 msgid "Ti\ttebi\t2^40 = 1099511627776\n"
14432 msgstr ""
14433
14434 #. type: tbl table
14435 #: build/C/man7/units.7:84
14436 #, no-wrap
14437 msgid "Pi\tpebi\t2^50 = 1125899906842624\n"
14438 msgstr ""
14439
14440 #. type: tbl table
14441 #: build/C/man7/units.7:85
14442 #, no-wrap
14443 msgid "Ei\texbi\t2^60 = 1152921504606846976\n"
14444 msgstr ""
14445
14446 #. type: Plain text
14447 #: build/C/man7/units.7:90
14448 msgid "See also"
14449 msgstr ""
14450
14451 #. type: Plain text
14452 #: build/C/man7/units.7:93
14453 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/binary.html> E<.UE>"
14454 msgstr ""
14455
14456 #. type: SS
14457 #: build/C/man7/units.7:93
14458 #, no-wrap
14459 msgid "Discussion"
14460 msgstr ""
14461
14462 #. type: Plain text
14463 #: build/C/man7/units.7:98
14464 msgid ""
14465 "Before these binary prefixes were introduced, it was fairly common to use "
14466 "k=1000 and K=1024, just like b=bit, B=byte.  Unfortunately, the M is capital "
14467 "already, and cannot be capitalized to indicate binary-ness."
14468 msgstr ""
14469
14470 #. type: Plain text
14471 #: build/C/man7/units.7:109
14472 msgid ""
14473 "At first that didn't matter too much, since memory modules and disks came in "
14474 "sizes that were powers of two, so everyone knew that in such contexts "
14475 "\"kilobyte\" and \"megabyte\" meant 1024 and 1048576 bytes, respectively.  "
14476 "What originally was a sloppy use of the prefixes \"kilo\" and \"mega\" "
14477 "started to become regarded as the \"real true meaning\" when computers were "
14478 "involved.  But then disk technology changed, and disk sizes became arbitrary "
14479 "numbers.  After a period of uncertainty all disk manufacturers settled on "
14480 "the standard, namely k=1000, M=1000k, G=1000M."
14481 msgstr ""
14482
14483 #.  also common: 14.4k modem
14484 #. type: Plain text
14485 #: build/C/man7/units.7:116
14486 msgid ""
14487 "The situation was messy: in the 14k4 modems, k=1000; in the 1.44MB "
14488 "diskettes, M=1024000; etc.  In 1998 the IEC approved the standard that "
14489 "defines the binary prefixes given above, enabling people to be precise and "
14490 "unambiguous."
14491 msgstr ""
14492
14493 #. type: Plain text
14494 #: build/C/man7/units.7:118
14495 msgid "Thus, today, MB = 1000000B and MiB = 1048576B."
14496 msgstr ""
14497
14498 #. type: Plain text
14499 #: build/C/man7/units.7:122
14500 msgid ""
14501 "In the free software world programs are slowly being changed to conform.  "
14502 "When the Linux kernel boots and says"
14503 msgstr ""
14504
14505 #. type: Plain text
14506 #: build/C/man7/units.7:126
14507 #, no-wrap
14508 msgid "hda: 120064896 sectors (61473 MB) w/2048KiB Cache\n"
14509 msgstr ""
14510
14511 #. type: Plain text
14512 #: build/C/man7/units.7:130
14513 msgid "the MB are megabytes and the KiB are kibibytes."
14514 msgstr ""
14515
14516 #.  Copyright (c) 1990, 1993
14517 #.      The Regents of the University of California.  All rights reserved.
14518 #
14519 #.  %%%LICENSE_START(BSD_4_CLAUSE_UCB)
14520 #.  Redistribution and use in source and binary forms, with or without
14521 #.  modification, are permitted provided that the following conditions
14522 #.  are met:
14523 #.  1. Redistributions of source code must retain the above copyright
14524 #.     notice, this list of conditions and the following disclaimer.
14525 #.  2. Redistributions in binary form must reproduce the above copyright
14526 #.     notice, this list of conditions and the following disclaimer in the
14527 #.     documentation and/or other materials provided with the distribution.
14528 #.  3. All advertising materials mentioning features or use of this software
14529 #.     must display the following acknowledgement:
14530 #.      This product includes software developed by the University of
14531 #.      California, Berkeley and its contributors.
14532 #.  4. Neither the name of the University nor the names of its contributors
14533 #.     may be used to endorse or promote products derived from this software
14534 #.     without specific prior written permission.
14535 #
14536 #.  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
14537 #.  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14538 #.  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14539 #.  ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
14540 #.  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
14541 #.  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
14542 #.  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
14543 #.  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
14544 #.  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
14545 #.  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
14546 #.  SUCH DAMAGE.
14547 #.  %%%LICENSE_END
14548 #
14549 #.      @(#)mdoc.samples.7      8.2 (Berkeley) 12/30/93
14550 #.      $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $
14551 #
14552 #.  This tutorial sampler invokes every macro in the package several
14553 #.  times and is guaranteed to give a worst case performance
14554 #.  for an already extremely slow package.
14555 #
14556 #.  String \*(Pu was not defined, probably means punctuation
14557 #. type: ds Pu
14558 #: build/C/man7/mdoc.samples.7:42
14559 #, no-wrap
14560 msgid "[ .,:;()[]?! ]"
14561 msgstr ""
14562
14563 #. type: Dd
14564 #: build/C/man7/mdoc.samples.7:43
14565 #, no-wrap
14566 msgid "December 30, 1993"
14567 msgstr ""
14568
14569 #. type: Dt
14570 #: build/C/man7/mdoc.samples.7:45
14571 #, no-wrap
14572 msgid "MDOC.SAMPLES 7"
14573 msgstr ""
14574
14575 #. type: Plain text
14576 #: build/C/man7/mdoc.samples.7:48
14577 msgid "E<.Nm mdoc.samples>"
14578 msgstr ""
14579
14580 #. type: Nd
14581 #: build/C/man7/mdoc.samples.7:48
14582 #, no-wrap
14583 msgid "tutorial sampler for writing"
14584 msgstr ""
14585
14586 #. type: Plain text
14587 #: build/C/man7/mdoc.samples.7:52
14588 msgid "E<.Bx> manuals with E<.Nm \\-mdoc>"
14589 msgstr ""
14590
14591 #. type: Plain text
14592 #: build/C/man7/mdoc.samples.7:54
14593 msgid "E<.Nm man mdoc.samples>"
14594 msgstr ""
14595
14596 #. type: Plain text
14597 #: build/C/man7/mdoc.samples.7:100
14598 msgid ""
14599 "A tutorial sampler for writing E<.Bx> manual pages with the E<.Nm \\-mdoc> "
14600 "macro package, a E<.Em content Ns \\-based> and E<.Em domain Ns \\-based> "
14601 "formatting package for E<.Xr troff 1>.  Its predecessor, the E<.Xr \\-man 7> "
14602 "package, addressed page layout leaving the manipulation of fonts and other "
14603 "typesetting details to the individual author.  In E<.Nm \\-mdoc>, page "
14604 "layout macros make up the E<.Em \"page structure domain\"> which consists of "
14605 "macros for titles, section headers, displays and lists.  Essentially items "
14606 "which affect the physical position of text on a formatted page.  In addition "
14607 "to the page structure domain, there are two more domains, the manual domain "
14608 "and the general text domain.  The general text domain is defined as macros "
14609 "which perform tasks such as quoting or emphasizing pieces of text.  The "
14610 "manual domain is defined as macros that are a subset of the day to day "
14611 "informal language used to describe commands, routines and related E<.Bx> "
14612 "files.  Macros in the manual domain handle command names, command-line "
14613 "arguments and options, function names, function parameters, pathnames, "
14614 "variables, cross references to other manual pages, and so on.  These domain "
14615 "items have value for both the author and the future user of the manual "
14616 "page.  It is hoped the consistency gained across the manual set will provide "
14617 "easier translation to future documentation tools."
14618 msgstr ""
14619
14620 #. type: Plain text
14621 #: build/C/man7/mdoc.samples.7:107
14622 msgid ""
14623 "Throughout the E<.Ux> manual pages, a manual entry is simply referred to as "
14624 "a man page, regardless of actual length and without sexist intention."
14625 msgstr ""
14626
14627 #. type: Sh
14628 #: build/C/man7/mdoc.samples.7:107
14629 #, no-wrap
14630 msgid "GETTING STARTED"
14631 msgstr ""
14632
14633 #. type: Plain text
14634 #: build/C/man7/mdoc.samples.7:113
14635 msgid ""
14636 "Since a tutorial document is normally read when a person desires to use the "
14637 "material immediately, the assumption has been made that the user of this "
14638 "document may be impatient.  The material presented in the remained of this "
14639 "document is outlined as follows:"
14640 msgstr ""
14641
14642 #. type: Plain text
14643 #: build/C/man7/mdoc.samples.7:116
14644 msgid "E<.Tn \"TROFF IDIOSYNCRASIES\">"
14645 msgstr ""
14646
14647 #. type: It
14648 #: build/C/man7/mdoc.samples.7:117
14649 #, no-wrap
14650 msgid "\"Macro Usage\" ."
14651 msgstr ""
14652
14653 #. type: It
14654 #: build/C/man7/mdoc.samples.7:118
14655 #, no-wrap
14656 msgid "\"Passing Space Characters in an Argument\" ."
14657 msgstr ""
14658
14659 #. type: It
14660 #: build/C/man7/mdoc.samples.7:119
14661 #, no-wrap
14662 msgid "\"Trailing Blank Space Characters (a warning)\" ."
14663 msgstr ""
14664
14665 #. type: It
14666 #: build/C/man7/mdoc.samples.7:120
14667 #, no-wrap
14668 msgid "\"Escaping Special Characters\" ."
14669 msgstr ""
14670
14671 #. type: Plain text
14672 #: build/C/man7/mdoc.samples.7:124
14673 msgid "E<.Tn \"THE ANATOMY OF A MAN PAGE\">"
14674 msgstr ""
14675
14676 #. type: It
14677 #: build/C/man7/mdoc.samples.7:125
14678 #, no-wrap
14679 msgid "\"A manual page template\" ."
14680 msgstr ""
14681
14682 #. type: Plain text
14683 #: build/C/man7/mdoc.samples.7:129
14684 msgid "E<.Tn \"TITLE MACROS\">."
14685 msgstr ""
14686
14687 #. type: Plain text
14688 #: build/C/man7/mdoc.samples.7:131
14689 msgid "E<.Tn \"INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS\">."
14690 msgstr ""
14691
14692 #. type: It
14693 #: build/C/man7/mdoc.samples.7:132
14694 #, no-wrap
14695 msgid "\"What's in a name...\" ."
14696 msgstr ""
14697
14698 #. type: It
14699 #: build/C/man7/mdoc.samples.7:133
14700 #, no-wrap
14701 msgid "\"General Syntax\" ."
14702 msgstr ""
14703
14704 #. type: Plain text
14705 #: build/C/man7/mdoc.samples.7:137
14706 msgid "E<.Tn \"MANUAL DOMAIN\">"
14707 msgstr ""
14708
14709 #. type: It
14710 #: build/C/man7/mdoc.samples.7:138
14711 #, no-wrap
14712 msgid "Addresses ."
14713 msgstr ""
14714
14715 #. type: It
14716 #: build/C/man7/mdoc.samples.7:139
14717 #, no-wrap
14718 msgid "\"Author name\" ."
14719 msgstr ""
14720
14721 #. type: It
14722 #: build/C/man7/mdoc.samples.7:140
14723 #, no-wrap
14724 msgid "Arguments ."
14725 msgstr ""
14726
14727 #. type: It
14728 #: build/C/man7/mdoc.samples.7:141
14729 #, no-wrap
14730 msgid "\"Configuration Declarations (section four only)\" ."
14731 msgstr ""
14732
14733 #. type: It
14734 #: build/C/man7/mdoc.samples.7:142
14735 #, no-wrap
14736 msgid "\"Command Modifier\" ."
14737 msgstr ""
14738
14739 #. type: It
14740 #: build/C/man7/mdoc.samples.7:143
14741 #, no-wrap
14742 msgid "\"Defined Variables\" ."
14743 msgstr ""
14744
14745 #. type: It
14746 #: build/C/man7/mdoc.samples.7:144
14747 #, no-wrap
14748 msgid "\"Errno's (Section two only)\" ."
14749 msgstr ""
14750
14751 #. type: It
14752 #: build/C/man7/mdoc.samples.7:145
14753 #, no-wrap
14754 msgid "\"Environment Variables\" ."
14755 msgstr ""
14756
14757 #. type: It
14758 #: build/C/man7/mdoc.samples.7:146
14759 #, no-wrap
14760 msgid "\"Function Argument\" ."
14761 msgstr ""
14762
14763 #. type: It
14764 #: build/C/man7/mdoc.samples.7:147
14765 #, no-wrap
14766 msgid "\"Function Declaration\" ."
14767 msgstr ""
14768
14769 #. type: It
14770 #: build/C/man7/mdoc.samples.7:148
14771 #, no-wrap
14772 msgid "Flags ."
14773 msgstr ""
14774
14775 #. type: It
14776 #: build/C/man7/mdoc.samples.7:149
14777 #, no-wrap
14778 msgid "\"Functions (library routines)\" ."
14779 msgstr ""
14780
14781 #. type: It
14782 #: build/C/man7/mdoc.samples.7:150
14783 #, no-wrap
14784 msgid "\"Function Types\" ."
14785 msgstr ""
14786
14787 #.  .It "Header File (including source code)" .
14788 #. type: It
14789 #: build/C/man7/mdoc.samples.7:152
14790 #, no-wrap
14791 msgid "\"Interactive Commands\" ."
14792 msgstr ""
14793
14794 #. type: It
14795 #: build/C/man7/mdoc.samples.7:153
14796 #, no-wrap
14797 msgid "Names ."
14798 msgstr ""
14799
14800 #. type: It
14801 #: build/C/man7/mdoc.samples.7:154
14802 #, no-wrap
14803 msgid "Options ."
14804 msgstr ""
14805
14806 #. type: It
14807 #: build/C/man7/mdoc.samples.7:155
14808 #, no-wrap
14809 msgid "Pathnames ."
14810 msgstr ""
14811
14812 #. type: It
14813 #: build/C/man7/mdoc.samples.7:156
14814 #, no-wrap
14815 msgid "Variables ."
14816 msgstr ""
14817
14818 #. type: It
14819 #: build/C/man7/mdoc.samples.7:157
14820 #, no-wrap
14821 msgid "\"Cross References\" ."
14822 msgstr ""
14823
14824 #. type: Plain text
14825 #: build/C/man7/mdoc.samples.7:161
14826 msgid "E<.Tn \"GENERAL TEXT DOMAIN\">"
14827 msgstr ""
14828
14829 #. type: It
14830 #: build/C/man7/mdoc.samples.7:162
14831 #, no-wrap
14832 msgid "\"AT&T Macro\" ."
14833 msgstr ""
14834
14835 #. type: It
14836 #: build/C/man7/mdoc.samples.7:163
14837 #, no-wrap
14838 msgid "\"BSD Macro\" ."
14839 msgstr ""
14840
14841 #. type: It
14842 #: build/C/man7/mdoc.samples.7:164
14843 #, no-wrap
14844 msgid "\"FreeBSD Macro\" ."
14845 msgstr ""
14846
14847 #. type: It
14848 #: build/C/man7/mdoc.samples.7:165
14849 #, no-wrap
14850 msgid "\"UNIX Macro\" ."
14851 msgstr ""
14852
14853 #. type: It
14854 #: build/C/man7/mdoc.samples.7:166
14855 #, no-wrap
14856 msgid "Enclosure/Quoting Macros"
14857 msgstr ""
14858
14859 #. type: It
14860 #: build/C/man7/mdoc.samples.7:168
14861 #, no-wrap
14862 msgid "\"Angle Bracket Quote/Enclosure\" ."
14863 msgstr ""
14864
14865 #. type: It
14866 #: build/C/man7/mdoc.samples.7:169
14867 #, no-wrap
14868 msgid "\"Bracket Quotes/Enclosure\" ."
14869 msgstr ""
14870
14871 #. type: It
14872 #: build/C/man7/mdoc.samples.7:170
14873 #, no-wrap
14874 msgid "\"Double Quote macro/Enclosure\" ."
14875 msgstr ""
14876
14877 #. type: It
14878 #: build/C/man7/mdoc.samples.7:171
14879 #, no-wrap
14880 msgid "\"Parenthesis Quote/Enclosure\" ."
14881 msgstr ""
14882
14883 #. type: It
14884 #: build/C/man7/mdoc.samples.7:172
14885 #, no-wrap
14886 msgid "\"Single Quotes/Enclosure\" ."
14887 msgstr ""
14888
14889 #. type: It
14890 #: build/C/man7/mdoc.samples.7:173
14891 #, no-wrap
14892 msgid "\"Prefix Macro\" ."
14893 msgstr ""
14894
14895 #. type: It
14896 #: build/C/man7/mdoc.samples.7:175
14897 #, no-wrap
14898 msgid "\"No\\-Op or Normal Text Macro\" ."
14899 msgstr ""
14900
14901 #. type: It
14902 #: build/C/man7/mdoc.samples.7:176
14903 #, no-wrap
14904 msgid "\"No Space Macro\" ."
14905 msgstr ""
14906
14907 #. type: It
14908 #: build/C/man7/mdoc.samples.7:177
14909 #, no-wrap
14910 msgid "\"Section Cross References\" ."
14911 msgstr ""
14912
14913 #. type: It
14914 #: build/C/man7/mdoc.samples.7:178
14915 #, no-wrap
14916 msgid "\"References and Citations\" ."
14917 msgstr ""
14918
14919 #. type: It
14920 #: build/C/man7/mdoc.samples.7:179
14921 #, no-wrap
14922 msgid "Return Values (sections two and three only)"
14923 msgstr ""
14924
14925 #. type: It
14926 #: build/C/man7/mdoc.samples.7:180
14927 #, no-wrap
14928 msgid "\"Trade Names (Acronyms and Type Names)\" ."
14929 msgstr ""
14930
14931 #. type: It
14932 #: build/C/man7/mdoc.samples.7:181
14933 #, no-wrap
14934 msgid "\"Extended  Arguments\" ."
14935 msgstr ""
14936
14937 #. type: Plain text
14938 #: build/C/man7/mdoc.samples.7:185
14939 msgid "E<.Tn \"PAGE STRUCTURE DOMAIN\">"
14940 msgstr ""
14941
14942 #. type: It
14943 #: build/C/man7/mdoc.samples.7:186
14944 #, no-wrap
14945 msgid "\"Section Headers\" ."
14946 msgstr ""
14947
14948 #. type: It
14949 #: build/C/man7/mdoc.samples.7:187
14950 #, no-wrap
14951 msgid "\"Paragraphs and Line Spacing\" ."
14952 msgstr ""
14953
14954 #. type: It
14955 #: build/C/man7/mdoc.samples.7:188
14956 #, no-wrap
14957 msgid "Keeps ."
14958 msgstr ""
14959
14960 #. type: It
14961 #: build/C/man7/mdoc.samples.7:189
14962 #, no-wrap
14963 msgid "Displays ."
14964 msgstr ""
14965
14966 #. type: It
14967 #: build/C/man7/mdoc.samples.7:190
14968 #, no-wrap
14969 msgid "\"Font Modes (Emphasis, Literal, and Symbolic)\" ."
14970 msgstr ""
14971
14972 #. type: It
14973 #: build/C/man7/mdoc.samples.7:191
14974 #, no-wrap
14975 msgid "\"Lists and Columns\" ."
14976 msgstr ""
14977
14978 #. type: Plain text
14979 #: build/C/man7/mdoc.samples.7:195
14980 msgid "E<.Tn \"PREDEFINED STRINGS\">"
14981 msgstr ""
14982
14983 #. type: Plain text
14984 #: build/C/man7/mdoc.samples.7:197
14985 msgid "E<.Tn \"DIAGNOSTICS\">"
14986 msgstr ""
14987
14988 #. type: Plain text
14989 #: build/C/man7/mdoc.samples.7:199
14990 msgid "E<.Tn \"FORMATTING WITH GROFF, TROFF AND NROFF\">"
14991 msgstr ""
14992
14993 #. type: Plain text
14994 #: build/C/man7/mdoc.samples.7:201
14995 msgid "E<.Tn \"BUGS\">"
14996 msgstr ""
14997
14998 #. type: Sh
14999 #: build/C/man7/mdoc.samples.7:203
15000 #, no-wrap
15001 msgid "TROFF IDIOSYNCRASIES"
15002 msgstr ""
15003
15004 #. type: Plain text
15005 #: build/C/man7/mdoc.samples.7:217
15006 msgid ""
15007 "The E<.Nm \\-mdoc> package attempts to simplify the process of writing a man "
15008 "page.  Theoretically, one should not have to learn the dirty details of "
15009 "E<.Xr troff 1> to use E<.Nm \\-mdoc>; however, there are a few limitations "
15010 "which are unavoidable and best gotten out of the way.  And, too, be "
15011 "forewarned, this package is E<.Em not> fast."
15012 msgstr ""
15013
15014 #. type: Ss
15015 #: build/C/man7/mdoc.samples.7:217
15016 #, no-wrap
15017 msgid "Macro Usage"
15018 msgstr ""
15019
15020 #. type: Plain text
15021 #: build/C/man7/mdoc.samples.7:242
15022 msgid ""
15023 "As in E<.Xr troff 1>, a macro is called by placing a E<.Ql \\&.> (dot "
15024 "character)  at the beginning of a line followed by the two character name "
15025 "for the macro.  Arguments may follow the macro separated by spaces.  It is "
15026 "the dot character at the beginning of the line which causes E<.Xr troff 1> "
15027 "to interpret the next two characters as a macro name.  To place a E<.Ql "
15028 "\\&.> (dot character)  at the beginning of a line in some context other than "
15029 "a macro invocation, precede the E<.Ql \\&.> (dot) with the E<.Ql \\e&> "
15030 "escape sequence.  The E<.Ql \\e&> translates literally to a zero width "
15031 "space, and is never displayed in the output."
15032 msgstr ""
15033
15034 #. type: Plain text
15035 #: build/C/man7/mdoc.samples.7:257
15036 msgid ""
15037 "In general, E<.Xr troff 1> macros accept up to nine arguments, any extra "
15038 "arguments are ignored.  Most macros in E<.Nm \\-mdoc> accept nine arguments "
15039 "and, in limited cases, arguments may be continued or extended on the next "
15040 "line (See E<.Sx Extensions>).  A few macros handle quoted arguments (see "
15041 "E<.Sx Passing Space Characters in an Argument> below)."
15042 msgstr ""
15043
15044 #. type: Plain text
15045 #: build/C/man7/mdoc.samples.7:284
15046 msgid ""
15047 "Most of the E<.Nm \\-mdoc> general text domain and manual domain macros are "
15048 "special in that their argument lists are E<.Em parsed> for callable macro "
15049 "names.  This means an argument on the argument list which matches a general "
15050 "text or manual domain macro name and is determined to be callable will be "
15051 "executed or called when it is processed.  In this case the argument, "
15052 "although the name of a macro, is not preceded by a E<.Ql \\&.> (dot).  It is "
15053 "in this manner that many macros are nested; for example the option macro, "
15054 "E<.Ql \\&.Op>, may E<.Em call> the flag and argument macros, E<.Ql \\&Fl> "
15055 "and E<.Ql \\&Ar>, to specify an optional flag with an argument:"
15056 msgstr ""
15057
15058 #. type: It
15059 #: build/C/man7/mdoc.samples.7:285
15060 #, no-wrap
15061 msgid "Op Fl s Ar bytes"
15062 msgstr ""
15063
15064 #. type: Plain text
15065 #: build/C/man7/mdoc.samples.7:288
15066 msgid "is produced by E<.Li \\&.Op \\&Fl s \\&Ar bytes>"
15067 msgstr ""
15068
15069 #. type: Plain text
15070 #: build/C/man7/mdoc.samples.7:295
15071 msgid ""
15072 "To prevent a two character string from being interpreted as a macro name, "
15073 "precede the string with the escape sequence E<.Ql \\e&>:"
15074 msgstr ""
15075
15076 #. type: It
15077 #: build/C/man7/mdoc.samples.7:296
15078 #, no-wrap
15079 msgid "Op \\&Fl s \\&Ar bytes"
15080 msgstr ""
15081
15082 #. type: Plain text
15083 #: build/C/man7/mdoc.samples.7:299
15084 msgid "is produced by E<.Li \\&.Op \\e&Fl s \\e&Ar bytes>"
15085 msgstr ""
15086
15087 #. type: Plain text
15088 #: build/C/man7/mdoc.samples.7:320
15089 msgid ""
15090 "Here the strings E<.Ql \\&Fl> and E<.Ql \\&Ar> are not interpreted as "
15091 "macros.  Macros whose argument lists are parsed for callable arguments are "
15092 "referred to as parsed and macros which may be called from an argument list "
15093 "are referred to as callable throughout this document and in the companion "
15094 "quick reference manual E<.Xr mdoc 7>.  This is a technical E<.Em faux pas> "
15095 "as almost all of the macros in E<.Nm \\-mdoc> are parsed, but as it was "
15096 "cumbersome to constantly refer to macros as being callable and being able to "
15097 "call other macros, the term parsed has been used."
15098 msgstr ""
15099
15100 #. type: Ss
15101 #: build/C/man7/mdoc.samples.7:320
15102 #, no-wrap
15103 msgid "Passing Space Characters in an Argument"
15104 msgstr ""
15105
15106 #. type: Plain text
15107 #: build/C/man7/mdoc.samples.7:338
15108 msgid ""
15109 "Sometimes it is desirable to give as one argument a string containing one or "
15110 "more blank space characters.  This may be necessary to defeat the nine "
15111 "argument limit or to specify arguments to macros which expect particular "
15112 "arrangement of items in the argument list.  For example, the function macro "
15113 "E<.Ql \\&.Fn> expects the first argument to be the name of a function and "
15114 "any remaining arguments to be function parameters.  As E<.Tn \"ANSI C\"> "
15115 "stipulates the declaration of function parameters in the parenthesized "
15116 "parameter list, each parameter is guaranteed to be at minimum a two word "
15117 "string.  For example, E<.Fa int foo>."
15118 msgstr ""
15119
15120 #. type: Plain text
15121 #: build/C/man7/mdoc.samples.7:353
15122 msgid ""
15123 "There are two possible ways to pass an argument which contains an embedded "
15124 "space.  E<.Em Implementation note>: Unfortunately, the most convenient way "
15125 "of passing spaces in between quotes by reassigning individual arguments "
15126 "before parsing was fairly expensive speed wise and space wise to implement "
15127 "in all the macros for E<.Tn AT&T> E<.Xr troff>.  It is not expensive for "
15128 "E<.Xr groff> but for the sake of portability, has been limited to the "
15129 "following macros which need it the most:"
15130 msgstr ""
15131
15132 #. type: It
15133 #: build/C/man7/mdoc.samples.7:355
15134 #, no-wrap
15135 msgid "Li \\&Cd"
15136 msgstr ""
15137
15138 #. type: Plain text
15139 #: build/C/man7/mdoc.samples.7:358
15140 msgid "Configuration declaration (section 4 E<.Sx SYNOPSIS>)"
15141 msgstr ""
15142
15143 #. type: It
15144 #: build/C/man7/mdoc.samples.7:358
15145 #, no-wrap
15146 msgid "Li \\&Bl"
15147 msgstr ""
15148
15149 #. type: Plain text
15150 #: build/C/man7/mdoc.samples.7:360
15151 msgid "Begin list (for the width specifier)."
15152 msgstr ""
15153
15154 #. type: It
15155 #: build/C/man7/mdoc.samples.7:360
15156 #, no-wrap
15157 msgid "Li \\&Em"
15158 msgstr ""
15159
15160 #. type: Plain text
15161 #: build/C/man7/mdoc.samples.7:362
15162 msgid "Emphasized text."
15163 msgstr ""
15164
15165 #. type: It
15166 #: build/C/man7/mdoc.samples.7:362
15167 #, no-wrap
15168 msgid "Li \\&Fn"
15169 msgstr ""
15170
15171 #. type: Plain text
15172 #: build/C/man7/mdoc.samples.7:364
15173 msgid "Functions (sections two and four)."
15174 msgstr ""
15175
15176 #. type: It
15177 #: build/C/man7/mdoc.samples.7:364
15178 #, no-wrap
15179 msgid "Li \\&It"
15180 msgstr ""
15181
15182 #. type: Plain text
15183 #: build/C/man7/mdoc.samples.7:366
15184 msgid "List items."
15185 msgstr ""
15186
15187 #. type: It
15188 #: build/C/man7/mdoc.samples.7:366
15189 #, no-wrap
15190 msgid "Li \\&Li"
15191 msgstr ""
15192
15193 #. type: Plain text
15194 #: build/C/man7/mdoc.samples.7:368
15195 msgid "Literal text."
15196 msgstr ""
15197
15198 #. type: It
15199 #: build/C/man7/mdoc.samples.7:368
15200 #, no-wrap
15201 msgid "Li \\&Sy"
15202 msgstr ""
15203
15204 #. type: Plain text
15205 #: build/C/man7/mdoc.samples.7:370
15206 msgid "Symbolic text."
15207 msgstr ""
15208
15209 #. type: It
15210 #: build/C/man7/mdoc.samples.7:370
15211 #, no-wrap
15212 msgid "Li \\&%B"
15213 msgstr ""
15214
15215 #. type: Plain text
15216 #: build/C/man7/mdoc.samples.7:372
15217 msgid "Book titles."
15218 msgstr ""
15219
15220 #. type: It
15221 #: build/C/man7/mdoc.samples.7:372
15222 #, no-wrap
15223 msgid "Li \\&%J"
15224 msgstr ""
15225
15226 #. type: Plain text
15227 #: build/C/man7/mdoc.samples.7:374
15228 msgid "Journal names."
15229 msgstr ""
15230
15231 #. type: It
15232 #: build/C/man7/mdoc.samples.7:374
15233 #, no-wrap
15234 msgid "Li \\&%O"
15235 msgstr ""
15236
15237 #. type: Plain text
15238 #: build/C/man7/mdoc.samples.7:376
15239 msgid "Optional notes for a reference."
15240 msgstr ""
15241
15242 #. type: It
15243 #: build/C/man7/mdoc.samples.7:376
15244 #, no-wrap
15245 msgid "Li \\&%R"
15246 msgstr ""
15247
15248 #. type: Plain text
15249 #: build/C/man7/mdoc.samples.7:378
15250 msgid "Report title (in a reference)."
15251 msgstr ""
15252
15253 #. type: It
15254 #: build/C/man7/mdoc.samples.7:378
15255 #, no-wrap
15256 msgid "Li \\&%T"
15257 msgstr ""
15258
15259 #. type: Plain text
15260 #: build/C/man7/mdoc.samples.7:380
15261 msgid "Title of article in a book or journal."
15262 msgstr ""
15263
15264 #. type: Plain text
15265 #: build/C/man7/mdoc.samples.7:397
15266 msgid ""
15267 "One way of passing a string containing blank spaces is to use the hard or "
15268 "unpaddable space character E<.Ql \\e\\ >, that is, a blank space preceded by "
15269 "the escape character E<.Ql \\e>.  This method may be used with any macro but "
15270 "has the side effect of interfering with the adjustment of text over the "
15271 "length of a line.  E<.Xr Troff> sees the hard space as if it were any other "
15272 "printable character and cannot split the string into blank or newline "
15273 "separated pieces as one would expect.  The method is useful for strings "
15274 "which are not expected to overlap a line boundary.  For example:"
15275 msgstr ""
15276
15277 #. type: It
15278 #: build/C/man7/mdoc.samples.7:398
15279 #, no-wrap
15280 msgid "Fn fetch char\\ *str"
15281 msgstr ""
15282
15283 #. type: Plain text
15284 #: build/C/man7/mdoc.samples.7:401
15285 msgid "is created by E<.Ql \\&.Fn fetch char\\e *str>"
15286 msgstr ""
15287
15288 #. type: It
15289 #: build/C/man7/mdoc.samples.7:401
15290 #, no-wrap
15291 msgid "Fn fetch \"char *str\""
15292 msgstr ""
15293
15294 #. type: Plain text
15295 #: build/C/man7/mdoc.samples.7:404
15296 msgid "can also be created by E<.Ql \\&.Fn fetch \"\\*qchar *str\\*q\">"
15297 msgstr ""
15298
15299 #. type: Plain text
15300 #: build/C/man7/mdoc.samples.7:413
15301 msgid ""
15302 "If the E<.Ql \\e> or quotes were omitted, E<.Ql \\&.Fn> would see three "
15303 "arguments and the result would be:"
15304 msgstr ""
15305
15306 #. type: Dl
15307 #: build/C/man7/mdoc.samples.7:414
15308 #, no-wrap
15309 msgid "Fn fetch char *str"
15310 msgstr ""
15311
15312 #. type: Plain text
15313 #: build/C/man7/mdoc.samples.7:420
15314 msgid ""
15315 "For an example of what happens when the parameter list overlaps a newline "
15316 "boundary, see the E<.Sx BUGS> section."
15317 msgstr ""
15318
15319 #. type: Ss
15320 #: build/C/man7/mdoc.samples.7:420
15321 #, no-wrap
15322 msgid "Trailing Blank Space Characters"
15323 msgstr ""
15324
15325 #. type: Plain text
15326 #: build/C/man7/mdoc.samples.7:433
15327 msgid ""
15328 "E<.Xr Troff> can be confused by blank space characters at the end of a "
15329 "line.  It is a wise preventive measure to globally remove all blank spaces "
15330 "from E<lt>blank-spaceE<gt>E<lt>end-of-lineE<gt> character sequences.  Should "
15331 "the need arise to force a blank character at the end of a line, it may be "
15332 "forced with an unpaddable space and the E<.Ql \\e&> escape character.  For "
15333 "example, E<.Ql string\\e\\ \\e&>."
15334 msgstr ""
15335
15336 #. type: Ss
15337 #: build/C/man7/mdoc.samples.7:433
15338 #, no-wrap
15339 msgid "Escaping Special Characters"
15340 msgstr ""
15341
15342 #. type: Plain text
15343 #: build/C/man7/mdoc.samples.7:445
15344 msgid ""
15345 "Special characters like the newline character E<.Ql \\en>, are handled by "
15346 "replacing the E<.Ql \\e> with E<.Ql \\ee> (e.g., E<.Ql \\een>)  to preserve "
15347 "the backslash."
15348 msgstr ""
15349
15350 #. type: Sh
15351 #: build/C/man7/mdoc.samples.7:445
15352 #, no-wrap
15353 msgid "THE ANATOMY OF A MAN PAGE"
15354 msgstr ""
15355
15356 #. type: Plain text
15357 #: build/C/man7/mdoc.samples.7:452
15358 msgid ""
15359 "The body of a man page is easily constructed from a basic template found in "
15360 "the file E<.Pa /usr/share/misc/mdoc.template>.  Several example man pages "
15361 "can also be found in E<.Pa /usr/share/examples/mdoc>."
15362 msgstr ""
15363
15364 #. type: Ss
15365 #: build/C/man7/mdoc.samples.7:453
15366 #, no-wrap
15367 msgid "A manual page template"
15368 msgstr ""
15369
15370 #. type: Plain text
15371 #: build/C/man7/mdoc.samples.7:484
15372 #, no-wrap
15373 msgid ""
15374 "\\&.\\e\" The following requests are required for all man pages.\n"
15375 "\\&.Dd Month day, year\n"
15376 "\\&.Os OPERATING_SYSTEM [version/release]\n"
15377 "\\&.Dt DOCUMENT_TITLE [section number] [volume]\n"
15378 "\\&.Sh NAME\n"
15379 "\\&.Nm name\n"
15380 "\\&.Nd one line description of name\n"
15381 "\\&.Sh SYNOPSIS\n"
15382 "\\&.Sh DESCRIPTION\n"
15383 "\\&.\\e\" The following requests should be uncommented and\n"
15384 "\\&.\\e\" used where appropriate.  This next request is\n"
15385 "\\&.\\e\" for sections 2 and 3 function return values only.\n"
15386 "\\&.\\e\" .Sh RETURN VALUE\n"
15387 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
15388 "\\&.\\e\" .Sh ENVIRONMENT\n"
15389 "\\&.\\e\" .Sh FILES\n"
15390 "\\&.\\e\" .Sh EXAMPLES\n"
15391 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
15392 "\\&.\\e\"     (command return values (to shell) and\n"
15393 "\\&.\\e\"\t  fprintf/stderr type diagnostics)\n"
15394 "\\&.\\e\" .Sh DIAGNOSTICS\n"
15395 "\\&.\\e\" The next request is for sections 2 and 3 error\n"
15396 "\\&.\\e\" and signal handling only.\n"
15397 "\\&.\\e\" .Sh ERRORS\n"
15398 "\\&.\\e\" .Sh SEE ALSO\n"
15399 "\\&.\\e\" .Sh CONFORMING TO\n"
15400 "\\&.\\e\" .Sh HISTORY\n"
15401 "\\&.\\e\" .Sh AUTHORS\n"
15402 "\\&.\\e\" .Sh BUGS\n"
15403 msgstr ""
15404
15405 #. type: Plain text
15406 #: build/C/man7/mdoc.samples.7:498
15407 msgid ""
15408 "The first items in the template are the macros E<.Pq Li \\&.Dd , \\&.Os , "
15409 "\\&.Dt>; the document date, the operating system the man page or subject "
15410 "source is developed or modified for, and the man page title E<.Pq Em in "
15411 "upper case> along with the section of the manual the page belongs in.  These "
15412 "macros identify the page, and are discussed below in E<.Sx TITLE MACROS>."
15413 msgstr ""
15414
15415 #. type: Plain text
15416 #: build/C/man7/mdoc.samples.7:517
15417 msgid ""
15418 "The remaining items in the template are section headers E<.Pq Li \\&.Sh>; of "
15419 "which E<.Sx NAME>, E<.Sx SYNOPSIS> and E<.Sx DESCRIPTION> are mandatory.  "
15420 "The headers are discussed in E<.Sx PAGE STRUCTURE DOMAIN>, after "
15421 "presentation of E<.Sx MANUAL DOMAIN>.  Several content macros are used to "
15422 "demonstrate page layout macros; reading about content macros before page "
15423 "layout macros is recommended."
15424 msgstr ""
15425
15426 #. type: Sh
15427 #: build/C/man7/mdoc.samples.7:517
15428 #, no-wrap
15429 msgid "TITLE MACROS"
15430 msgstr ""
15431
15432 #. type: Plain text
15433 #: build/C/man7/mdoc.samples.7:526
15434 msgid ""
15435 "The title macros are the first portion of the page structure domain, but are "
15436 "presented first and separate for someone who wishes to start writing a man "
15437 "page yesterday.  Three header macros designate the document title or manual "
15438 "page title, the operating system, and the date of authorship.  These macros "
15439 "are one called once at the very beginning of the document and are used to "
15440 "construct the headers and footers only."
15441 msgstr ""
15442
15443 #. type: It
15444 #: build/C/man7/mdoc.samples.7:527
15445 #, no-wrap
15446 msgid "Li \\&.Dt DOCUMENT_TITLE section# [volume]"
15447 msgstr ""
15448
15449 #.  .Cl
15450 #.  USD UNIX User's Supplementary Documents
15451 #.  .Cl
15452 #.  PS1 UNIX Programmer's Supplementary Documents
15453 #. type: Plain text
15454 #: build/C/man7/mdoc.samples.7:541
15455 msgid ""
15456 "The document title is the subject of the man page and must be in E<.Tn "
15457 "CAPITALS> due to troff limitations.  The section number may be 1,\\ ...,\\ "
15458 "8, and if it is specified, the volume title may be omitted.  A volume title "
15459 "may be arbitrary or one of the following:"
15460 msgstr ""
15461
15462 #. type: It
15463 #: build/C/man7/mdoc.samples.7:543
15464 #, no-wrap
15465 msgid "Li \"AMD\tUNIX Ancestral Manual Documents\""
15466 msgstr ""
15467
15468 #. type: It
15469 #: build/C/man7/mdoc.samples.7:544
15470 #, no-wrap
15471 msgid "Li \"SMM\tUNIX System Manager's Manual\""
15472 msgstr ""
15473
15474 #. type: It
15475 #: build/C/man7/mdoc.samples.7:545
15476 #, no-wrap
15477 msgid "Li \"URM\tUNIX Reference Manual\""
15478 msgstr ""
15479
15480 #. type: It
15481 #: build/C/man7/mdoc.samples.7:546
15482 #, no-wrap
15483 msgid "Li \"PRM\tUNIX Programmer's Manual\""
15484 msgstr ""
15485
15486 #.  .Cl
15487 #.  MMI UNIX Manual Master Index
15488 #.  .Cl
15489 #.  CON UNIX Contributed Software Manual
15490 #.  .Cl
15491 #.  LOC UNIX Local Manual
15492 #. type: Plain text
15493 #: build/C/man7/mdoc.samples.7:562
15494 msgid ""
15495 "The default volume labeling is E<.Li URM> for sections 1, 6, and 7; E<.Li "
15496 "SMM> for section 8; E<.Li PRM> for sections 2, 3, 4, and 5."
15497 msgstr ""
15498
15499 #. type: It
15500 #: build/C/man7/mdoc.samples.7:562
15501 #, no-wrap
15502 msgid "Li \\&.Os operating_system release#"
15503 msgstr ""
15504
15505 #. type: Plain text
15506 #: build/C/man7/mdoc.samples.7:575
15507 msgid ""
15508 "The name of the operating system should be the common acronym, for example, "
15509 "E<.Tn BSD> or E<.Tn FreeBSD> or E<.Tn ATT>.  The release should be the "
15510 "standard release nomenclature for the system specified, for example, 4.3, "
15511 "4.3+Tahoe, V.3, V.4.  Unrecognized arguments are displayed as given in the "
15512 "page footer.  For instance, a typical footer might be:"
15513 msgstr ""
15514
15515 #. type: Dl
15516 #: build/C/man7/mdoc.samples.7:576
15517 #, no-wrap
15518 msgid "\\&.Os 4.3BSD"
15519 msgstr ""
15520
15521 #. type: Plain text
15522 #: build/C/man7/mdoc.samples.7:579
15523 msgid "or"
15524 msgstr ""
15525
15526 #. type: Dl
15527 #: build/C/man7/mdoc.samples.7:579
15528 #, no-wrap
15529 msgid "\\&.Os FreeBSD 2.2"
15530 msgstr ""
15531
15532 #. type: Plain text
15533 #: build/C/man7/mdoc.samples.7:582
15534 msgid "or for a locally produced set"
15535 msgstr ""
15536
15537 #. type: Dl
15538 #: build/C/man7/mdoc.samples.7:583
15539 #, no-wrap
15540 msgid "\\&.Os CS Department"
15541 msgstr ""
15542
15543 #. type: Plain text
15544 #: build/C/man7/mdoc.samples.7:598
15545 msgid ""
15546 "The Berkeley default, E<.Ql \\&.Os> without an argument, has been defined as "
15547 "E<.Tn BSD> in the site-specific file E<.Pa "
15548 "/usr/share/tmac/mdoc/doc-common>.  It really should default to E<.Tn "
15549 "LOCAL>.  Note, if the E<.Ql \\&.Os> macro is not present, the bottom left "
15550 "corner of the page will be ugly."
15551 msgstr ""
15552
15553 #. type: It
15554 #: build/C/man7/mdoc.samples.7:598
15555 #, no-wrap
15556 msgid "Li \\&.Dd month day, year"
15557 msgstr ""
15558
15559 #. type: Plain text
15560 #: build/C/man7/mdoc.samples.7:600
15561 msgid "The date should be written formally:"
15562 msgstr ""
15563
15564 #. type: Dl
15565 #: build/C/man7/mdoc.samples.7:602
15566 #, no-wrap
15567 msgid "January 25, 1989"
15568 msgstr ""
15569
15570 #. type: Sh
15571 #: build/C/man7/mdoc.samples.7:604
15572 #, no-wrap
15573 msgid "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
15574 msgstr ""
15575
15576 #. type: Ss
15577 #: build/C/man7/mdoc.samples.7:605
15578 #, no-wrap
15579 msgid "What's in a name..."
15580 msgstr ""
15581
15582 #. type: Plain text
15583 #: build/C/man7/mdoc.samples.7:622
15584 msgid ""
15585 "The manual domain macro names are derived from the day to day informal "
15586 "language used to describe commands, subroutines and related files.  Slightly "
15587 "different variations of this language are used to describe the three "
15588 "different aspects of writing a man page.  First, there is the description of "
15589 "E<.Nm \\-mdoc> macro request usage.  Second is the description of a E<.Ux> "
15590 "command E<.Em with> E<.Nm \\-mdoc> macros and third, the description of a "
15591 "command to a user in the verbal sense; that is, discussion of a command in "
15592 "the text of a man page."
15593 msgstr ""
15594
15595 #. type: Plain text
15596 #: build/C/man7/mdoc.samples.7:627
15597 msgid ""
15598 "In the first case, E<.Xr troff 1> macros are themselves a type of command; "
15599 "the general syntax for a troff command is:"
15600 msgstr ""
15601
15602 #. type: Plain text
15603 #: build/C/man7/mdoc.samples.7:629
15604 #, no-wrap
15605 msgid "\\&.Va argument1 argument2 ... argument9\n"
15606 msgstr ""
15607
15608 #. type: Plain text
15609 #: build/C/man7/mdoc.samples.7:643
15610 msgid ""
15611 "The E<.Ql \\&.Va> is a macro command or request, and anything following it "
15612 "is an argument to be processed.  In the second case, the description of a "
15613 "E<.Ux> command using the content macros is a bit more involved; a typical "
15614 "E<.Sx SYNOPSIS> command line might be displayed as:"
15615 msgstr ""
15616
15617 #. type: Plain text
15618 #: build/C/man7/mdoc.samples.7:647
15619 #, no-wrap
15620 msgid ""
15621 "E<.Nm filter>\n"
15622 "E<.Op Fl flag>\n"
15623 "E<.Ar infile outfile>\n"
15624 msgstr ""
15625
15626 #. type: Plain text
15627 #: build/C/man7/mdoc.samples.7:667
15628 msgid ""
15629 "Here, E<.Nm filter> is the command name and the bracketed string E<.Fl flag> "
15630 "is a E<.Em flag> argument designated as optional by the option brackets.  In "
15631 "E<.Nm \\-mdoc> terms, E<.Ar infile> and E<.Ar outfile> are called E<.Em "
15632 "arguments>.  The macros which formatted the above example:"
15633 msgstr ""
15634
15635 #. type: Plain text
15636 #: build/C/man7/mdoc.samples.7:671
15637 #, no-wrap
15638 msgid ""
15639 "\\&.Nm filter\n"
15640 "\\&.Op \\&Fl flag\n"
15641 "\\&.Ar infile outfile\n"
15642 msgstr ""
15643
15644 #. type: Plain text
15645 #: build/C/man7/mdoc.samples.7:685
15646 msgid ""
15647 "In the third case, discussion of commands and command syntax includes both "
15648 "examples above, but may add more detail.  The arguments E<.Ar infile> and "
15649 "E<.Ar outfile> from the example above might be referred to as E<.Em "
15650 "operands> or E<.Em file arguments>.  Some command-line argument lists are "
15651 "quite long:"
15652 msgstr ""
15653
15654 #. type: It
15655 #: build/C/man7/mdoc.samples.7:686
15656 #, no-wrap
15657 msgid "Nm make"
15658 msgstr ""
15659
15660 #. type: Plain text
15661 #: build/C/man7/mdoc.samples.7:699
15662 msgid ""
15663 "E<.Op Fl eiknqrstv> E<.Op Fl D Ar variable> E<.Op Fl d Ar flags> E<.Op Fl f "
15664 "Ar makefile> E<.Bk -words> E<.Op Fl I Ar directory> E<.Ek> E<.Op Fl j Ar "
15665 "max_jobs> E<.Op Ar variable=value> E<.Bk -words> E<.Op Ar target ...> E<.Ek>"
15666 msgstr ""
15667
15668 #. type: Plain text
15669 #: build/C/man7/mdoc.samples.7:725
15670 msgid ""
15671 "Here one might talk about the command E<.Nm make> and qualify the argument "
15672 "E<.Ar makefile>, as an argument to the flag, E<.Fl f>, or discuss the "
15673 "optional file operand E<.Ar target>.  In the verbal context, such detail can "
15674 "prevent confusion, however the E<.Nm \\-mdoc> package does not have a macro "
15675 "for an argument E<.Em to> a flag.  Instead the E<.Ql \\&Ar> argument macro "
15676 "is used for an operand or file argument like E<.Ar target> as well as an "
15677 "argument to a flag like E<.Ar variable>.  The make command line was produced "
15678 "from:"
15679 msgstr ""
15680
15681 #. type: Plain text
15682 #: build/C/man7/mdoc.samples.7:737
15683 #, no-wrap
15684 msgid ""
15685 "\\&.Nm make\n"
15686 "\\&.Op Fl eiknqrstv\n"
15687 "\\&.Op Fl D Ar variable\n"
15688 "\\&.Op Fl d Ar flags\n"
15689 "\\&.Op Fl f Ar makefile\n"
15690 "\\&.Op Fl I Ar directory\n"
15691 "\\&.Op Fl j Ar max_jobs\n"
15692 "\\&.Op Ar variable=value\n"
15693 "\\&.Bk -words\n"
15694 "\\&.Op Ar target ...\n"
15695 "\\&.Ek\n"
15696 msgstr ""
15697
15698 #. type: Plain text
15699 #: build/C/man7/mdoc.samples.7:745
15700 msgid "The E<.Ql \\&.Bk> and E<.Ql \\&.Ek> macros are explained in E<.Sx Keeps>."
15701 msgstr ""
15702
15703 #. type: Ss
15704 #: build/C/man7/mdoc.samples.7:745
15705 #, no-wrap
15706 msgid "General Syntax"
15707 msgstr ""
15708
15709 #. type: Plain text
15710 #: build/C/man7/mdoc.samples.7:768
15711 msgid ""
15712 "The manual domain and general text domain macros share a similar syntax with "
15713 "a few minor deviations: E<.Ql \\&.Ar>, E<.Ql \\&.Fl>, E<.Ql \\&.Nm>, and "
15714 "E<.Ql \\&.Pa> differ only when called without arguments; E<.Ql \\&.Fn> and "
15715 "E<.Ql \\&.Xr> impose an order on their argument lists and the E<.Ql \\&.Op> "
15716 "and E<.Ql \\&.Fn> macros have nesting limitations.  All content macros are "
15717 "capable of recognizing and properly handling punctuation, provided each "
15718 "punctuation character is separated by a leading space.  If a request is "
15719 "given:"
15720 msgstr ""
15721
15722 #. type: Dl
15723 #: build/C/man7/mdoc.samples.7:769
15724 #, no-wrap
15725 msgid "\\&.Li sptr, ptr),"
15726 msgstr ""
15727
15728 #. type: Plain text
15729 #: build/C/man7/mdoc.samples.7:772 build/C/man7/mdoc.samples.7:782
15730 msgid "The result is:"
15731 msgstr ""
15732
15733 #. type: Dl
15734 #: build/C/man7/mdoc.samples.7:773
15735 #, no-wrap
15736 msgid "Li sptr, ptr),"
15737 msgstr ""
15738
15739 #. type: Plain text
15740 #: build/C/man7/mdoc.samples.7:778
15741 msgid ""
15742 "The punctuation is not recognized and all is output in the literal font. If "
15743 "the punctuation is separated by a leading white space:"
15744 msgstr ""
15745
15746 #. type: Dl
15747 #: build/C/man7/mdoc.samples.7:779
15748 #, no-wrap
15749 msgid "\\&.Li \"sptr , ptr ) ,\""
15750 msgstr ""
15751
15752 #. type: Dl
15753 #: build/C/man7/mdoc.samples.7:783
15754 #, no-wrap
15755 msgid "Li sptr , ptr ) ,"
15756 msgstr ""
15757
15758 #. type: Plain text
15759 #: build/C/man7/mdoc.samples.7:787
15760 msgid ""
15761 "The punctuation is now recognized and is output in the default font "
15762 "distinguishing it from the strings in literal font."
15763 msgstr ""
15764
15765 #. type: Plain text
15766 #: build/C/man7/mdoc.samples.7:796
15767 msgid ""
15768 "To remove the special meaning from a punctuation character escape it with "
15769 "E<.Ql \\e&>.  E<.Xr Troff> is limited as a macro language, and has "
15770 "difficulty when presented with a string containing a member of the "
15771 "mathematical, logical or quotation set:"
15772 msgstr ""
15773
15774 #. type: Plain text
15775 #: build/C/man7/mdoc.samples.7:798
15776 #, no-wrap
15777 msgid "\\&{+,\\-,/,*,\\&%,E<lt>,E<gt>,E<lt>=,E<gt>=,=,==,&,`,',\"}\n"
15778 msgstr ""
15779
15780 #. type: Plain text
15781 #: build/C/man7/mdoc.samples.7:810
15782 msgid ""
15783 "The problem is that E<.Xr troff> may assume it is supposed to actually "
15784 "perform the operation or evaluation suggested by the characters.  To prevent "
15785 "the accidental evaluation of these characters, escape them with E<.Ql "
15786 "\\e&>.  Typical syntax is shown in the first content macro displayed below, "
15787 "E<.Ql \\&.Ad>."
15788 msgstr ""
15789
15790 #. type: Sh
15791 #: build/C/man7/mdoc.samples.7:810
15792 #, no-wrap
15793 msgid "MANUAL DOMAIN"
15794 msgstr ""
15795
15796 #. type: Ss
15797 #: build/C/man7/mdoc.samples.7:811
15798 #, no-wrap
15799 msgid "Address Macro"
15800 msgstr ""
15801
15802 #. type: Plain text
15803 #: build/C/man7/mdoc.samples.7:814
15804 msgid ""
15805 "The address macro identifies an address construct of the form "
15806 "addr1[,addr2[,addr3]]."
15807 msgstr ""
15808
15809 #. type: Dl
15810 #: build/C/man7/mdoc.samples.7:815
15811 #, no-wrap
15812 msgid "Usage: .Ad address ... \\*(Pu"
15813 msgstr ""
15814
15815 #. type: It
15816 #: build/C/man7/mdoc.samples.7:817
15817 #, no-wrap
15818 msgid "Li \\&.Ad addr1"
15819 msgstr ""
15820
15821 #. type: Plain text
15822 #: build/C/man7/mdoc.samples.7:819
15823 msgid "E<.Ad addr1>"
15824 msgstr ""
15825
15826 #. type: It
15827 #: build/C/man7/mdoc.samples.7:819
15828 #, no-wrap
15829 msgid "Li \\&.Ad addr1\\ ."
15830 msgstr ""
15831
15832 #. type: Plain text
15833 #: build/C/man7/mdoc.samples.7:821
15834 msgid "E<.Ad addr1>."
15835 msgstr ""
15836
15837 #. type: It
15838 #: build/C/man7/mdoc.samples.7:821
15839 #, no-wrap
15840 msgid "Li \\&.Ad addr1\\ , file2"
15841 msgstr ""
15842
15843 #. type: Plain text
15844 #: build/C/man7/mdoc.samples.7:823
15845 msgid "E<.Ad addr1 , file2>"
15846 msgstr ""
15847
15848 #. type: It
15849 #: build/C/man7/mdoc.samples.7:823
15850 #, no-wrap
15851 msgid "Li \\&.Ad f1\\ , f2\\ , f3\\ :"
15852 msgstr ""
15853
15854 #. type: Plain text
15855 #: build/C/man7/mdoc.samples.7:825
15856 msgid "E<.Ad f1 , f2 , f3>:"
15857 msgstr ""
15858
15859 #. type: It
15860 #: build/C/man7/mdoc.samples.7:825
15861 #, no-wrap
15862 msgid "Li \\&.Ad addr\\ )\\ )\\ ,"
15863 msgstr ""
15864
15865 #. type: Plain text
15866 #: build/C/man7/mdoc.samples.7:827
15867 msgid "E<.Ad addr>)),"
15868 msgstr ""
15869
15870 #. type: Plain text
15871 #: build/C/man7/mdoc.samples.7:834
15872 msgid ""
15873 "It is an error to call E<.Ql \\&.Ad> without arguments.  E<.Ql \\&.Ad> is "
15874 "callable by other macros and is parsed."
15875 msgstr ""
15876
15877 #. type: Ss
15878 #: build/C/man7/mdoc.samples.7:834
15879 #, no-wrap
15880 msgid "Author Name"
15881 msgstr ""
15882
15883 #. type: Plain text
15884 #: build/C/man7/mdoc.samples.7:841
15885 msgid ""
15886 "The E<.Ql \\&.An> macro is used to specify the name of the author of the "
15887 "item being documented, or the name of the author of the actual manual page.  "
15888 "Any remaining arguments after the name information are assumed to be "
15889 "punctuation."
15890 msgstr ""
15891
15892 #. type: Dl
15893 #: build/C/man7/mdoc.samples.7:842
15894 #, no-wrap
15895 msgid "Usage: .An author_name \\*(Pu"
15896 msgstr ""
15897
15898 #. type: It
15899 #: build/C/man7/mdoc.samples.7:844
15900 #, no-wrap
15901 msgid "Li \\&.An Joe\\ Author"
15902 msgstr ""
15903
15904 #. type: Plain text
15905 #: build/C/man7/mdoc.samples.7:846
15906 msgid "E<.An Joe Author>"
15907 msgstr ""
15908
15909 #. type: It
15910 #: build/C/man7/mdoc.samples.7:846
15911 #, no-wrap
15912 msgid "Li \\&.An Joe\\ Author\\ ,"
15913 msgstr ""
15914
15915 #. type: Plain text
15916 #: build/C/man7/mdoc.samples.7:848
15917 msgid "E<.An Joe\\ Author>,"
15918 msgstr ""
15919
15920 #. type: It
15921 #: build/C/man7/mdoc.samples.7:848
15922 #, no-wrap
15923 msgid "Li \\&.An Joe\\ Author\\ \\&Aq\\ nobody@FreeBSD.ORG"
15924 msgstr ""
15925
15926 #. type: Plain text
15927 #: build/C/man7/mdoc.samples.7:850
15928 msgid "E<.An Joe Author Aq nobody@FreeBSD.ORG>"
15929 msgstr ""
15930
15931 #. type: It
15932 #: build/C/man7/mdoc.samples.7:850
15933 #, no-wrap
15934 msgid "Li \\&.An Joe\\ Author\\ )\\ )\\ ,"
15935 msgstr ""
15936
15937 #. type: Plain text
15938 #: build/C/man7/mdoc.samples.7:852
15939 msgid "E<.An Joe Author>)),"
15940 msgstr ""
15941
15942 #. type: Plain text
15943 #: build/C/man7/mdoc.samples.7:861
15944 msgid ""
15945 "The E<.Ql \\&.An> macro is parsed and is callable.  It is an error to call "
15946 "E<.Ql \\&.An> without any arguments."
15947 msgstr ""
15948
15949 #. type: Ss
15950 #: build/C/man7/mdoc.samples.7:861
15951 #, no-wrap
15952 msgid "Argument Macro"
15953 msgstr ""
15954
15955 #. type: Plain text
15956 #: build/C/man7/mdoc.samples.7:866
15957 msgid ""
15958 "The E<.Ql \\&.Ar> argument macro may be used whenever a command-line "
15959 "argument is referenced."
15960 msgstr ""
15961
15962 #. type: Dl
15963 #: build/C/man7/mdoc.samples.7:867
15964 #, no-wrap
15965 msgid "Usage: .Ar argument ... \\*(Pu"
15966 msgstr ""
15967
15968 #. type: It
15969 #: build/C/man7/mdoc.samples.7:869
15970 #, no-wrap
15971 msgid "Li \\&.Ar"
15972 msgstr ""
15973
15974 #. type: Plain text
15975 #: build/C/man7/mdoc.samples.7:871
15976 msgid "E<.Ar>"
15977 msgstr ""
15978
15979 #. type: It
15980 #: build/C/man7/mdoc.samples.7:871
15981 #, no-wrap
15982 msgid "Li \\&.Ar file1"
15983 msgstr ""
15984
15985 #. type: Plain text
15986 #: build/C/man7/mdoc.samples.7:873
15987 msgid "E<.Ar file1>"
15988 msgstr ""
15989
15990 #. type: It
15991 #: build/C/man7/mdoc.samples.7:873
15992 #, no-wrap
15993 msgid "Li \\&.Ar file1\\ ."
15994 msgstr ""
15995
15996 #. type: Plain text
15997 #: build/C/man7/mdoc.samples.7:875
15998 msgid "E<.Ar file1>."
15999 msgstr ""
16000
16001 #. type: It
16002 #: build/C/man7/mdoc.samples.7:875
16003 #, no-wrap
16004 msgid "Li \\&.Ar file1 file2"
16005 msgstr ""
16006
16007 #. type: Plain text
16008 #: build/C/man7/mdoc.samples.7:877
16009 msgid "E<.Ar file1 file2>"
16010 msgstr ""
16011
16012 #. type: It
16013 #: build/C/man7/mdoc.samples.7:877
16014 #, no-wrap
16015 msgid "Li \\&.Ar f1 f2 f3\\ :"
16016 msgstr ""
16017
16018 #. type: Plain text
16019 #: build/C/man7/mdoc.samples.7:879
16020 msgid "E<.Ar f1 f2 f3>:"
16021 msgstr ""
16022
16023 #. type: It
16024 #: build/C/man7/mdoc.samples.7:879
16025 #, no-wrap
16026 msgid "Li \\&.Ar file\\ )\\ )\\ ,"
16027 msgstr ""
16028
16029 #. type: Plain text
16030 #: build/C/man7/mdoc.samples.7:881
16031 msgid "E<.Ar file>)),"
16032 msgstr ""
16033
16034 #. type: Plain text
16035 #: build/C/man7/mdoc.samples.7:891
16036 msgid ""
16037 "If E<.Ql \\&.Ar> is called without arguments E<.Ql \\&Ar> is assumed.  The "
16038 "E<.Ql \\&.Ar> macro is parsed and is callable."
16039 msgstr ""
16040
16041 #. type: Ss
16042 #: build/C/man7/mdoc.samples.7:891
16043 #, no-wrap
16044 msgid "Configuration Declaration (section four only)"
16045 msgstr ""
16046
16047 #. type: Plain text
16048 #: build/C/man7/mdoc.samples.7:898
16049 msgid ""
16050 "The E<.Ql \\&.Cd> macro is used to demonstrate a E<.Xr config 8> declaration "
16051 "for a device interface in a section four manual.  This macro accepts quoted "
16052 "arguments (double quotes only)."
16053 msgstr ""
16054
16055 #. type: It
16056 #: build/C/man7/mdoc.samples.7:900
16057 #, no-wrap
16058 msgid "Cd \"device le0 at scode?\""
16059 msgstr ""
16060
16061 #. type: Plain text
16062 #: build/C/man7/mdoc.samples.7:903
16063 msgid "produced by: E<.Ql \".Cd device le0 at scode?\">."
16064 msgstr ""
16065
16066 #. type: Ss
16067 #: build/C/man7/mdoc.samples.7:904
16068 #, no-wrap
16069 msgid "Command Modifier"
16070 msgstr ""
16071
16072 #. type: Plain text
16073 #: build/C/man7/mdoc.samples.7:918
16074 msgid ""
16075 "The command modifier is identical to the E<.Ql \\&.Fl> (flag) command with "
16076 "the exception the E<.Ql \\&.Cm> macro does not assert a dash in front of "
16077 "every argument.  Traditionally flags are marked by the preceding dash, some "
16078 "commands or subsets of commands do not use them.  Command modifiers may also "
16079 "be specified in conjunction with interactive commands such as editor "
16080 "commands.  See E<.Sx Flags>."
16081 msgstr ""
16082
16083 #. type: Ss
16084 #: build/C/man7/mdoc.samples.7:918
16085 #, no-wrap
16086 msgid "Defined Variables"
16087 msgstr ""
16088
16089 #. type: Plain text
16090 #: build/C/man7/mdoc.samples.7:922
16091 msgid ""
16092 "A variable which is defined in an include file is specified by the macro "
16093 "E<.Ql \\&.Dv>."
16094 msgstr ""
16095
16096 #. type: Dl
16097 #: build/C/man7/mdoc.samples.7:923
16098 #, no-wrap
16099 msgid "Usage: .Dv defined_variable ... \\*(Pu"
16100 msgstr ""
16101
16102 #. type: It
16103 #: build/C/man7/mdoc.samples.7:925
16104 #, no-wrap
16105 msgid "Li \".Dv MAXHOSTNAMELEN\""
16106 msgstr ""
16107
16108 #. type: Plain text
16109 #: build/C/man7/mdoc.samples.7:927
16110 msgid "E<.Dv MAXHOSTNAMELEN>"
16111 msgstr ""
16112
16113 #. type: It
16114 #: build/C/man7/mdoc.samples.7:927
16115 #, no-wrap
16116 msgid "Li \".Dv TIOCGPGRP )\""
16117 msgstr ""
16118
16119 #. type: Plain text
16120 #: build/C/man7/mdoc.samples.7:929
16121 msgid "E<.Dv TIOCGPGRP>)"
16122 msgstr ""
16123
16124 #. type: Plain text
16125 #: build/C/man7/mdoc.samples.7:936
16126 msgid ""
16127 "It is an error to call E<.Ql \\&.Dv> without arguments.  E<.Ql \\&.Dv> is "
16128 "parsed and is callable."
16129 msgstr ""
16130
16131 #. type: Ss
16132 #: build/C/man7/mdoc.samples.7:936
16133 #, no-wrap
16134 msgid "Errno's (Section two only)"
16135 msgstr ""
16136
16137 #. type: Plain text
16138 #: build/C/man7/mdoc.samples.7:948
16139 msgid ""
16140 "The E<.Ql \\&.Er> errno macro specifies the error return value for section "
16141 "two library routines.  The second example below shows E<.Ql \\&.Er> used "
16142 "with the E<.Ql \\&.Bq> general text domain macro, as it would be used in a "
16143 "section two manual page."
16144 msgstr ""
16145
16146 #. type: Dl
16147 #: build/C/man7/mdoc.samples.7:949
16148 #, no-wrap
16149 msgid "Usage: .Er ERRNOTYPE ... \\*(Pu"
16150 msgstr ""
16151
16152 #. type: It
16153 #: build/C/man7/mdoc.samples.7:951
16154 #, no-wrap
16155 msgid "Li \\&.Er ENOENT"
16156 msgstr ""
16157
16158 #. type: Plain text
16159 #: build/C/man7/mdoc.samples.7:953
16160 msgid "E<.Er ENOENT>"
16161 msgstr ""
16162
16163 #. type: It
16164 #: build/C/man7/mdoc.samples.7:953
16165 #, no-wrap
16166 msgid "Li \\&.Er ENOENT\\ )\\ ;"
16167 msgstr ""
16168
16169 #. type: Plain text
16170 #: build/C/man7/mdoc.samples.7:955
16171 msgid "E<.Er ENOENT>);"
16172 msgstr ""
16173
16174 #. type: It
16175 #: build/C/man7/mdoc.samples.7:955
16176 #, no-wrap
16177 msgid "Li \\&.Bq \\&Er ENOTDIR"
16178 msgstr ""
16179
16180 #. type: Plain text
16181 #: build/C/man7/mdoc.samples.7:957
16182 msgid "E<.Bq Er ENOTDIR>"
16183 msgstr ""
16184
16185 #. type: Plain text
16186 #: build/C/man7/mdoc.samples.7:965
16187 msgid ""
16188 "It is an error to call E<.Ql \\&.Er> without arguments.  The E<.Ql \\&.Er> "
16189 "macro is parsed and is callable."
16190 msgstr ""
16191
16192 #. type: Ss
16193 #: build/C/man7/mdoc.samples.7:965
16194 #, no-wrap
16195 msgid "Environment Variables"
16196 msgstr ""
16197
16198 #. type: Plain text
16199 #: build/C/man7/mdoc.samples.7:969
16200 msgid "The E<.Ql \\&.Ev> macro specifies an environment variable."
16201 msgstr ""
16202
16203 #. type: Dl
16204 #: build/C/man7/mdoc.samples.7:970
16205 #, no-wrap
16206 msgid "Usage: .Ev argument ... \\*(Pu"
16207 msgstr ""
16208
16209 #. type: It
16210 #: build/C/man7/mdoc.samples.7:972
16211 #, no-wrap
16212 msgid "Li \\&.Ev DISPLAY"
16213 msgstr ""
16214
16215 #. type: Plain text
16216 #: build/C/man7/mdoc.samples.7:974
16217 msgid "E<.Ev DISPLAY>"
16218 msgstr ""
16219
16220 #. type: It
16221 #: build/C/man7/mdoc.samples.7:974
16222 #, no-wrap
16223 msgid "Li \\&.Ev PATH\\ ."
16224 msgstr ""
16225
16226 #. type: Plain text
16227 #: build/C/man7/mdoc.samples.7:976
16228 msgid "E<.Ev PATH>."
16229 msgstr ""
16230
16231 #. type: It
16232 #: build/C/man7/mdoc.samples.7:976
16233 #, no-wrap
16234 msgid "Li \\&.Ev PRINTER\\ )\\ )\\ ,"
16235 msgstr ""
16236
16237 #. type: Plain text
16238 #: build/C/man7/mdoc.samples.7:978
16239 msgid "E<.Ev PRINTER>)),"
16240 msgstr ""
16241
16242 #. type: Plain text
16243 #: build/C/man7/mdoc.samples.7:986
16244 msgid ""
16245 "It is an error to call E<.Ql \\&.Ev> without arguments.  The E<.Ql \\&.Ev> "
16246 "macro is parsed and is callable."
16247 msgstr ""
16248
16249 #. type: Ss
16250 #: build/C/man7/mdoc.samples.7:986
16251 #, no-wrap
16252 msgid "Function Argument"
16253 msgstr ""
16254
16255 #. type: Plain text
16256 #: build/C/man7/mdoc.samples.7:1005
16257 msgid ""
16258 "The E<.Ql \\&.Fa> macro is used to refer to function arguments (parameters)  "
16259 "outside of the E<.Sx SYNOPSIS> section of the manual or inside the E<.Sx "
16260 "SYNOPSIS> section should a parameter list be too long for the E<.Ql \\&.Fn> "
16261 "macro and the enclosure macros E<.Ql \\&.Fo> and E<.Ql \\&.Fc> must be "
16262 "used.  E<.Ql \\&.Fa> may also be used to refer to structure members."
16263 msgstr ""
16264
16265 #. type: Dl
16266 #: build/C/man7/mdoc.samples.7:1006
16267 #, no-wrap
16268 msgid "Usage: .Fa function_argument ... \\*(Pu"
16269 msgstr ""
16270
16271 #. type: It
16272 #: build/C/man7/mdoc.samples.7:1008
16273 #, no-wrap
16274 msgid "Li \\&.Fa d_namlen\\ )\\ )\\ ,"
16275 msgstr ""
16276
16277 #. type: Plain text
16278 #: build/C/man7/mdoc.samples.7:1010
16279 msgid "E<.Fa d_namlen>)),"
16280 msgstr ""
16281
16282 #. type: It
16283 #: build/C/man7/mdoc.samples.7:1010
16284 #, no-wrap
16285 msgid "Li \\&.Fa iov_len"
16286 msgstr ""
16287
16288 #. type: Plain text
16289 #: build/C/man7/mdoc.samples.7:1012
16290 msgid "E<.Fa iov_len>"
16291 msgstr ""
16292
16293 #. type: Plain text
16294 #: build/C/man7/mdoc.samples.7:1019
16295 msgid ""
16296 "It is an error to call E<.Ql \\&.Fa> without arguments.  E<.Ql \\&.Fa> is "
16297 "parsed and is callable."
16298 msgstr ""
16299
16300 #. type: Ss
16301 #: build/C/man7/mdoc.samples.7:1019
16302 #, no-wrap
16303 msgid "Function Declaration"
16304 msgstr ""
16305
16306 #. type: Plain text
16307 #: build/C/man7/mdoc.samples.7:1030
16308 msgid ""
16309 "The E<.Ql \\&.Fd> macro is used in the E<.Sx SYNOPSIS> section with section "
16310 "two or three functions.  The E<.Ql \\&.Fd> macro does not call other macros "
16311 "and is not callable by other macros."
16312 msgstr ""
16313
16314 #. type: Dl
16315 #: build/C/man7/mdoc.samples.7:1031
16316 #, no-wrap
16317 msgid "Usage: .Fd include_file (or defined variable)"
16318 msgstr ""
16319
16320 #. type: Plain text
16321 #: build/C/man7/mdoc.samples.7:1042
16322 msgid ""
16323 "In the E<.Sx SYNOPSIS> section a E<.Ql \\&.Fd> request causes a line break "
16324 "if a function has already been presented and a break has not occurred.  This "
16325 "leaves a nice vertical space in between the previous function call and the "
16326 "declaration for the next function."
16327 msgstr ""
16328
16329 #. type: Ss
16330 #: build/C/man7/mdoc.samples.7:1042
16331 #, no-wrap
16332 msgid "Flags"
16333 msgstr ""
16334
16335 #. type: Plain text
16336 #: build/C/man7/mdoc.samples.7:1055
16337 msgid ""
16338 "The E<.Ql \\&.Fl> macro handles command-line flags.  It prepends a dash, "
16339 "E<.Ql \\->, to the flag.  For interactive command flags, which are not "
16340 "prepended with a dash, the E<.Ql \\&.Cm> (command modifier)  macro is "
16341 "identical, but without the dash."
16342 msgstr ""
16343
16344 #. type: Dl
16345 #: build/C/man7/mdoc.samples.7:1056
16346 #, no-wrap
16347 msgid "Usage: .Fl argument ... \\*(Pu"
16348 msgstr ""
16349
16350 #. type: It
16351 #: build/C/man7/mdoc.samples.7:1058
16352 #, no-wrap
16353 msgid "Li \\&.Fl"
16354 msgstr ""
16355
16356 #. type: Plain text
16357 #: build/C/man7/mdoc.samples.7:1060
16358 msgid "E<.Fl>"
16359 msgstr ""
16360
16361 #. type: It
16362 #: build/C/man7/mdoc.samples.7:1060
16363 #, no-wrap
16364 msgid "Li \\&.Fl cfv"
16365 msgstr ""
16366
16367 #. type: Plain text
16368 #: build/C/man7/mdoc.samples.7:1062
16369 msgid "E<.Fl cfv>"
16370 msgstr ""
16371
16372 #. type: It
16373 #: build/C/man7/mdoc.samples.7:1062
16374 #, no-wrap
16375 msgid "Li \\&.Fl cfv\\ ."
16376 msgstr ""
16377
16378 #. type: Plain text
16379 #: build/C/man7/mdoc.samples.7:1064
16380 msgid "E<.Fl cfv>."
16381 msgstr ""
16382
16383 #. type: It
16384 #: build/C/man7/mdoc.samples.7:1064
16385 #, no-wrap
16386 msgid "Li \\&.Fl s v t"
16387 msgstr ""
16388
16389 #. type: Plain text
16390 #: build/C/man7/mdoc.samples.7:1066
16391 msgid "E<.Fl s v t>"
16392 msgstr ""
16393
16394 #. type: It
16395 #: build/C/man7/mdoc.samples.7:1066
16396 #, no-wrap
16397 msgid "Li \\&.Fl -\\ ,"
16398 msgstr ""
16399
16400 #. type: Plain text
16401 #: build/C/man7/mdoc.samples.7:1068
16402 msgid "E<.Fl ->,"
16403 msgstr ""
16404
16405 #. type: It
16406 #: build/C/man7/mdoc.samples.7:1068
16407 #, no-wrap
16408 msgid "Li \\&.Fl xyz\\ )\\ ,"
16409 msgstr ""
16410
16411 #. type: Plain text
16412 #: build/C/man7/mdoc.samples.7:1070
16413 msgid "E<.Fl xyz>),"
16414 msgstr ""
16415
16416 #. type: Plain text
16417 #: build/C/man7/mdoc.samples.7:1082
16418 msgid ""
16419 "The E<.Ql \\&.Fl> macro without any arguments results in a dash representing "
16420 "I<stdin>/I<stdout>.  Note that giving E<.Ql \\&.Fl> a single dash, will "
16421 "result in two dashes.  The E<.Ql \\&.Fl> macro is parsed and is callable."
16422 msgstr ""
16423
16424 #. type: Ss
16425 #: build/C/man7/mdoc.samples.7:1082
16426 #, no-wrap
16427 msgid "Functions (library routines)"
16428 msgstr ""
16429
16430 #. type: Plain text
16431 #: build/C/man7/mdoc.samples.7:1084
16432 msgid "The .Fn macro is modeled on ANSI C conventions."
16433 msgstr ""
16434
16435 #. type: Plain text
16436 #: build/C/man7/mdoc.samples.7:1086
16437 #, no-wrap
16438 msgid "Usage: .Fn [type] function [[type] parameters ... \\*(Pu]\n"
16439 msgstr ""
16440
16441 #. type: It
16442 #: build/C/man7/mdoc.samples.7:1088
16443 #, no-wrap
16444 msgid "Li \"\\&.Fn getchar\""
16445 msgstr ""
16446
16447 #. type: Plain text
16448 #: build/C/man7/mdoc.samples.7:1090
16449 msgid "E<.Fn getchar>"
16450 msgstr ""
16451
16452 #. type: It
16453 #: build/C/man7/mdoc.samples.7:1090
16454 #, no-wrap
16455 msgid "Li \"\\&.Fn strlen ) ,\""
16456 msgstr ""
16457
16458 #. type: Plain text
16459 #: build/C/man7/mdoc.samples.7:1092
16460 msgid "E<.Fn strlen>),"
16461 msgstr ""
16462
16463 #. type: It
16464 #: build/C/man7/mdoc.samples.7:1092
16465 #, no-wrap
16466 msgid "Li \\&.Fn \"\\*qint align\\*q\" \"\\*qconst * char *sptrs\\*q\" ,"
16467 msgstr ""
16468
16469 #. type: Plain text
16470 #: build/C/man7/mdoc.samples.7:1094
16471 msgid "E<.Fn \"int align\" \"const * char *sptrs\">,"
16472 msgstr ""
16473
16474 #. type: Plain text
16475 #: build/C/man7/mdoc.samples.7:1107
16476 msgid ""
16477 "It is an error to call E<.Ql \\&.Fn> without any arguments.  The E<.Ql "
16478 "\\&.Fn> macro is parsed and is callable, note that any call to another macro "
16479 "signals the end of the E<.Ql \\&.Fn> call (it will close-parenthesis at that "
16480 "point)."
16481 msgstr ""
16482
16483 #. type: Plain text
16484 #: build/C/man7/mdoc.samples.7:1121
16485 msgid ""
16486 "For functions that have more than eight parameters (and this is rare), the "
16487 "macros E<.Ql \\&.Fo> (function open)  and E<.Ql \\&.Fc> (function close)  "
16488 "may be used with E<.Ql \\&.Fa> (function argument)  to get around the "
16489 "limitation.  For example:"
16490 msgstr ""
16491
16492 #. type: Plain text
16493 #: build/C/man7/mdoc.samples.7:1133
16494 #, no-wrap
16495 msgid ""
16496 "\\&.Fo \"int res_mkquery\"\n"
16497 "\\&.Fa \"int op\"\n"
16498 "\\&.Fa \"char *dname\"\n"
16499 "\\&.Fa \"int class\"\n"
16500 "\\&.Fa \"int type\"\n"
16501 "\\&.Fa \"char *data\"\n"
16502 "\\&.Fa \"int datalen\"\n"
16503 "\\&.Fa \"struct rrec *newrr\"\n"
16504 "\\&.Fa \"char *buf\"\n"
16505 "\\&.Fa \"int buflen\"\n"
16506 "\\&.Fc\n"
16507 msgstr ""
16508
16509 #. type: Plain text
16510 #: build/C/man7/mdoc.samples.7:1136 build/C/man7/mdoc.samples.7:2480
16511 msgid "Produces:"
16512 msgstr ""
16513
16514 #. type: Plain text
16515 #: build/C/man7/mdoc.samples.7:1148
16516 #, no-wrap
16517 msgid ""
16518 "E<.Fo \"int res_mkquery\">\n"
16519 "E<.Fa \"int op\">\n"
16520 "E<.Fa \"char *dname\">\n"
16521 "E<.Fa \"int class\">\n"
16522 "E<.Fa \"int type\">\n"
16523 "E<.Fa \"char *data\">\n"
16524 "E<.Fa \"int datalen\">\n"
16525 "E<.Fa \"struct rrec *newrr\">\n"
16526 "E<.Fa \"char *buf\">\n"
16527 "E<.Fa \"int buflen\">\n"
16528 "E<.Fc>\n"
16529 msgstr ""
16530
16531 #. type: Plain text
16532 #: build/C/man7/mdoc.samples.7:1171
16533 msgid ""
16534 "The E<.Ql \\&.Fo> and E<.Ql \\&.Fc> macros are parsed and are callable.  In "
16535 "the E<.Sx SYNOPSIS> section, the function will always begin at the beginning "
16536 "of line.  If there is more than one function presented in the E<.Sx "
16537 "SYNOPSIS> section and a function type has not been given, a line break will "
16538 "occur, leaving a nice vertical space between the current function name and "
16539 "the one prior.  At the moment, E<.Ql \\&.Fn> does not check its word "
16540 "boundaries against troff line lengths and may split across a newline "
16541 "ungracefully.  This will be fixed in the near future."
16542 msgstr ""
16543
16544 #. type: Ss
16545 #: build/C/man7/mdoc.samples.7:1171
16546 #, no-wrap
16547 msgid "Function Type"
16548 msgstr ""
16549
16550 #. type: Plain text
16551 #: build/C/man7/mdoc.samples.7:1182
16552 msgid ""
16553 "This macro is intended for the E<.Sx SYNOPSIS> section.  It may be used "
16554 "anywhere else in the man page without problems, but its main purpose is to "
16555 "present the function type in kernel normal form for the E<.Sx SYNOPSIS> of "
16556 "sections two and three (it causes a line break allowing the function name to "
16557 "appear on the next line)."
16558 msgstr ""
16559
16560 #. type: Dl
16561 #: build/C/man7/mdoc.samples.7:1183
16562 #, no-wrap
16563 msgid "Usage: .Ft type ... \\*(Pu"
16564 msgstr ""
16565
16566 #. type: It
16567 #: build/C/man7/mdoc.samples.7:1185
16568 #, no-wrap
16569 msgid "Li \\&.Ft struct stat"
16570 msgstr ""
16571
16572 #. type: Plain text
16573 #: build/C/man7/mdoc.samples.7:1187
16574 msgid "E<.Ft struct stat>"
16575 msgstr ""
16576
16577 #. type: Plain text
16578 #: build/C/man7/mdoc.samples.7:1192
16579 msgid "The E<.Ql \\&.Ft> request is not callable by other macros."
16580 msgstr ""
16581
16582 #. type: Ss
16583 #: build/C/man7/mdoc.samples.7:1192
16584 #, no-wrap
16585 msgid "Interactive Commands"
16586 msgstr ""
16587
16588 #. type: Plain text
16589 #: build/C/man7/mdoc.samples.7:1196
16590 msgid "The E<.Ql \\&.Ic> macro designates an interactive or internal command."
16591 msgstr ""
16592
16593 #. type: Dl
16594 #: build/C/man7/mdoc.samples.7:1197
16595 #, no-wrap
16596 msgid "Usage: .Ic argument ... \\*(Pu"
16597 msgstr ""
16598
16599 #. type: It
16600 #: build/C/man7/mdoc.samples.7:1199
16601 #, no-wrap
16602 msgid "Li \\&.Ic :wq"
16603 msgstr ""
16604
16605 #. type: Plain text
16606 #: build/C/man7/mdoc.samples.7:1201
16607 msgid "E<.Ic :wq>"
16608 msgstr ""
16609
16610 #. type: It
16611 #: build/C/man7/mdoc.samples.7:1201
16612 #, no-wrap
16613 msgid "Li \\&.Ic do while {...}"
16614 msgstr ""
16615
16616 #. type: Plain text
16617 #: build/C/man7/mdoc.samples.7:1203
16618 msgid "E<.Ic do while {...}>"
16619 msgstr ""
16620
16621 #. type: It
16622 #: build/C/man7/mdoc.samples.7:1203
16623 #, no-wrap
16624 msgid "Li \\&.Ic setenv\\ , unsetenv"
16625 msgstr ""
16626
16627 #. type: Plain text
16628 #: build/C/man7/mdoc.samples.7:1205
16629 msgid "E<.Ic setenv , unsetenv>"
16630 msgstr ""
16631
16632 #. type: Plain text
16633 #: build/C/man7/mdoc.samples.7:1213
16634 msgid ""
16635 "It is an error to call E<.Ql \\&.Ic> without arguments.  The E<.Ql \\&.Ic> "
16636 "macro is parsed and is callable."
16637 msgstr ""
16638
16639 #. type: Ss
16640 #: build/C/man7/mdoc.samples.7:1213
16641 #, no-wrap
16642 msgid "Name Macro"
16643 msgstr ""
16644
16645 #. type: Plain text
16646 #: build/C/man7/mdoc.samples.7:1249
16647 msgid ""
16648 "The E<.Ql \\&.Nm> macro is used for the document title or subject name.  It "
16649 "has the peculiarity of remembering the first argument it was called with, "
16650 "which should always be the subject name of the page.  When called without "
16651 "arguments, E<.Ql \\&.Nm> regurgitates this initial name for the sole purpose "
16652 "of making less work for the author.  Note: a section two or three document "
16653 "function name is addressed with the E<.Ql \\&.Nm> in the E<.Sx NAME> "
16654 "section, and with E<.Ql \\&.Fn> in the E<.Sx SYNOPSIS> and remaining "
16655 "sections.  For interactive commands, such as the E<.Ql while> command "
16656 "keyword in E<.Xr csh 1>, the E<.Ql \\&.Ic> macro should be used.  While the "
16657 "E<.Ql \\&.Ic> is nearly identical to E<.Ql \\&.Nm>, it can not recall the "
16658 "first argument it was invoked with."
16659 msgstr ""
16660
16661 #. type: Dl
16662 #: build/C/man7/mdoc.samples.7:1250
16663 #, no-wrap
16664 msgid "Usage: .Nm argument ... \\*(Pu"
16665 msgstr ""
16666
16667 #. type: It
16668 #: build/C/man7/mdoc.samples.7:1252
16669 #, no-wrap
16670 msgid "Li \\&.Nm mdoc.sample"
16671 msgstr ""
16672
16673 #. type: Plain text
16674 #: build/C/man7/mdoc.samples.7:1254
16675 msgid "E<.Nm mdoc.sample>"
16676 msgstr ""
16677
16678 #. type: It
16679 #: build/C/man7/mdoc.samples.7:1254
16680 #, no-wrap
16681 msgid "Li \\&.Nm \\e-mdoc"
16682 msgstr ""
16683
16684 #. type: Plain text
16685 #: build/C/man7/mdoc.samples.7:1256
16686 msgid "E<.Nm \\-mdoc>."
16687 msgstr ""
16688
16689 #. type: It
16690 #: build/C/man7/mdoc.samples.7:1256
16691 #, no-wrap
16692 msgid "Li \\&.Nm foo\\ )\\ )\\ ,"
16693 msgstr ""
16694
16695 #. type: Plain text
16696 #: build/C/man7/mdoc.samples.7:1258
16697 msgid "E<.Nm foo>)),"
16698 msgstr ""
16699
16700 #. type: It
16701 #: build/C/man7/mdoc.samples.7:1258
16702 #, no-wrap
16703 msgid "Li \\&.Nm"
16704 msgstr ""
16705
16706 #. type: Plain text
16707 #: build/C/man7/mdoc.samples.7:1260
16708 msgid "E<.Nm>"
16709 msgstr ""
16710
16711 #. type: Plain text
16712 #: build/C/man7/mdoc.samples.7:1265
16713 msgid "The E<.Ql \\&.Nm> macro is parsed and is callable."
16714 msgstr ""
16715
16716 #. type: Ss
16717 #: build/C/man7/mdoc.samples.7:1265
16718 #, no-wrap
16719 msgid "Options"
16720 msgstr ""
16721
16722 #. type: Plain text
16723 #: build/C/man7/mdoc.samples.7:1277
16724 msgid ""
16725 "The E<.Ql \\&.Op> macro places option brackets around the any remaining "
16726 "arguments on the command line, and places any trailing punctuation outside "
16727 "the brackets.  The macros E<.Ql \\&.Oc> and E<.Ql \\&.Oo> may be used across "
16728 "one or more lines."
16729 msgstr ""
16730
16731 #. type: Dl
16732 #: build/C/man7/mdoc.samples.7:1278
16733 #, no-wrap
16734 msgid "Usage: .Op options ... \\*(Pu"
16735 msgstr ""
16736
16737 #. type: It
16738 #: build/C/man7/mdoc.samples.7:1280
16739 #, no-wrap
16740 msgid "Li \\&.Op"
16741 msgstr ""
16742
16743 #. type: Plain text
16744 #: build/C/man7/mdoc.samples.7:1282
16745 msgid "E<.Op>"
16746 msgstr ""
16747
16748 #. type: It
16749 #: build/C/man7/mdoc.samples.7:1282
16750 #, no-wrap
16751 msgid "Li \".Op Fl k\""
16752 msgstr ""
16753
16754 #. type: Plain text
16755 #: build/C/man7/mdoc.samples.7:1284
16756 msgid "E<.Op Fl k>"
16757 msgstr ""
16758
16759 #. type: It
16760 #: build/C/man7/mdoc.samples.7:1284
16761 #, no-wrap
16762 msgid "Li \".Op Fl k ) .\""
16763 msgstr ""
16764
16765 #. type: Plain text
16766 #: build/C/man7/mdoc.samples.7:1286
16767 msgid "E<.Op Fl k>)."
16768 msgstr ""
16769
16770 #. type: It
16771 #: build/C/man7/mdoc.samples.7:1286
16772 #, no-wrap
16773 msgid "Li \".Op Fl k Ar kookfile\""
16774 msgstr ""
16775
16776 #. type: Plain text
16777 #: build/C/man7/mdoc.samples.7:1288
16778 msgid "E<.Op Fl k Ar kookfile>"
16779 msgstr ""
16780
16781 #. type: It
16782 #: build/C/man7/mdoc.samples.7:1288
16783 #, no-wrap
16784 msgid "Li \".Op Fl k Ar kookfile ,\""
16785 msgstr ""
16786
16787 #. type: Plain text
16788 #: build/C/man7/mdoc.samples.7:1290
16789 msgid "E<.Op Fl k Ar kookfile>,"
16790 msgstr ""
16791
16792 #. type: It
16793 #: build/C/man7/mdoc.samples.7:1290
16794 #, no-wrap
16795 msgid "Li \".Op Ar objfil Op Ar corfil\""
16796 msgstr ""
16797
16798 #. type: Plain text
16799 #: build/C/man7/mdoc.samples.7:1292
16800 msgid "E<.Op Ar objfil Op Ar corfil>"
16801 msgstr ""
16802
16803 #. type: It
16804 #: build/C/man7/mdoc.samples.7:1292
16805 #, no-wrap
16806 msgid "Li \".Op Fl c Ar objfil Op Ar corfil ,\""
16807 msgstr ""
16808
16809 #. type: Plain text
16810 #: build/C/man7/mdoc.samples.7:1294
16811 msgid "E<.Op Fl c Ar objfil Op Ar corfil>,"
16812 msgstr ""
16813
16814 #. type: It
16815 #: build/C/man7/mdoc.samples.7:1294
16816 #, no-wrap
16817 msgid "Li \\&.Op word1 word2"
16818 msgstr ""
16819
16820 #. type: Plain text
16821 #: build/C/man7/mdoc.samples.7:1296
16822 msgid "E<.Op word1 word2>"
16823 msgstr ""
16824
16825 #. type: Plain text
16826 #: build/C/man7/mdoc.samples.7:1303
16827 msgid "The E<.Ql \\&.Oc> and E<.Ql \\&.Oo> macros:"
16828 msgstr ""
16829
16830 #. type: Plain text
16831 #: build/C/man7/mdoc.samples.7:1309
16832 #, no-wrap
16833 msgid ""
16834 "\\&.Oo\n"
16835 "\\&.Op \\&Fl k \\&Ar kilobytes\n"
16836 "\\&.Op \\&Fl i \\&Ar interval\n"
16837 "\\&.Op \\&Fl c \\&Ar count\n"
16838 "\\&.Oc\n"
16839 msgstr ""
16840
16841 #. type: Plain text
16842 #: build/C/man7/mdoc.samples.7:1317
16843 msgid ""
16844 "Produce: E<.Oo> E<.Op Fl k Ar kilobytes> E<.Op Fl i Ar interval> E<.Op Fl c "
16845 "Ar count> E<.Oc>"
16846 msgstr ""
16847
16848 #. type: Plain text
16849 #: build/C/man7/mdoc.samples.7:1324
16850 msgid ""
16851 "The macros E<.Ql \\&.Op>, E<.Ql \\&.Oc> and E<.Ql \\&.Oo> are parsed and are "
16852 "callable."
16853 msgstr ""
16854
16855 #. type: Ss
16856 #: build/C/man7/mdoc.samples.7:1324
16857 #, no-wrap
16858 msgid "Pathnames"
16859 msgstr ""
16860
16861 #. type: Plain text
16862 #: build/C/man7/mdoc.samples.7:1328
16863 msgid "The E<.Ql \\&.Pa> macro formats pathnames or filenames."
16864 msgstr ""
16865
16866 #. type: Dl
16867 #: build/C/man7/mdoc.samples.7:1329
16868 #, no-wrap
16869 msgid "Usage: .Pa pathname \\*(Pu"
16870 msgstr ""
16871
16872 #. type: It
16873 #: build/C/man7/mdoc.samples.7:1331
16874 #, no-wrap
16875 msgid "Li \\&.Pa /usr/share"
16876 msgstr ""
16877
16878 #. type: Plain text
16879 #: build/C/man7/mdoc.samples.7:1333
16880 msgid "E<.Pa /usr/share>"
16881 msgstr ""
16882
16883 #. type: It
16884 #: build/C/man7/mdoc.samples.7:1333
16885 #, no-wrap
16886 msgid "Li \\&.Pa /tmp/fooXXXXX\\ )\\ ."
16887 msgstr ""
16888
16889 #. type: Plain text
16890 #: build/C/man7/mdoc.samples.7:1335
16891 msgid "E<.Pa /tmp/fooXXXXX>)."
16892 msgstr ""
16893
16894 #. type: Plain text
16895 #: build/C/man7/mdoc.samples.7:1340
16896 msgid "The E<.Ql \\&.Pa> macro is parsed and is callable."
16897 msgstr ""
16898
16899 #. type: Ss
16900 #: build/C/man7/mdoc.samples.7:1340
16901 #, no-wrap
16902 msgid "Variables"
16903 msgstr ""
16904
16905 #. type: Plain text
16906 #: build/C/man7/mdoc.samples.7:1342
16907 msgid "Generic variable reference:"
16908 msgstr ""
16909
16910 #. type: Dl
16911 #: build/C/man7/mdoc.samples.7:1343
16912 #, no-wrap
16913 msgid "Usage: .Va variable ... \\*(Pu"
16914 msgstr ""
16915
16916 #. type: It
16917 #: build/C/man7/mdoc.samples.7:1345
16918 #, no-wrap
16919 msgid "Li \\&.Va count"
16920 msgstr ""
16921
16922 #. type: Plain text
16923 #: build/C/man7/mdoc.samples.7:1347
16924 msgid "E<.Va count>"
16925 msgstr ""
16926
16927 #. type: It
16928 #: build/C/man7/mdoc.samples.7:1347
16929 #, no-wrap
16930 msgid "Li \\&.Va settimer ,"
16931 msgstr ""
16932
16933 #. type: Plain text
16934 #: build/C/man7/mdoc.samples.7:1349
16935 msgid "E<.Va settimer>,"
16936 msgstr ""
16937
16938 #. type: It
16939 #: build/C/man7/mdoc.samples.7:1349
16940 #, no-wrap
16941 msgid "Li \\&.Va int\\ *prt\\ )\\ :"
16942 msgstr ""
16943
16944 #. type: Plain text
16945 #: build/C/man7/mdoc.samples.7:1351
16946 msgid "E<.Va int\\ *prt>):"
16947 msgstr ""
16948
16949 #. type: It
16950 #: build/C/man7/mdoc.samples.7:1351
16951 #, no-wrap
16952 msgid "Li \\&.Va char\\ s\\ ]\\ )\\ )\\ ,"
16953 msgstr ""
16954
16955 #. type: Plain text
16956 #: build/C/man7/mdoc.samples.7:1353
16957 msgid "E<.Va char\\ s>])),"
16958 msgstr ""
16959
16960 #. type: Plain text
16961 #: build/C/man7/mdoc.samples.7:1361
16962 msgid ""
16963 "It is an error to call E<.Ql \\&.Va> without any arguments.  The E<.Ql "
16964 "\\&.Va> macro is parsed and is callable."
16965 msgstr ""
16966
16967 #. type: Ss
16968 #: build/C/man7/mdoc.samples.7:1361
16969 #, no-wrap
16970 msgid "Manual Page Cross References"
16971 msgstr ""
16972
16973 #. type: Plain text
16974 #: build/C/man7/mdoc.samples.7:1369
16975 msgid ""
16976 "The E<.Ql \\&.Xr> macro expects the first argument to be a manual page name, "
16977 "and the second argument, if it exists, to be either a section page number or "
16978 "punctuation.  Any remaining arguments are assumed to be punctuation."
16979 msgstr ""
16980
16981 #. type: Dl
16982 #: build/C/man7/mdoc.samples.7:1370
16983 #, no-wrap
16984 msgid "Usage: .Xr man_page [1,...,8] \\*(Pu"
16985 msgstr ""
16986
16987 #. type: It
16988 #: build/C/man7/mdoc.samples.7:1372
16989 #, no-wrap
16990 msgid "Li \\&.Xr mdoc"
16991 msgstr ""
16992
16993 #. type: Plain text
16994 #: build/C/man7/mdoc.samples.7:1374
16995 msgid "E<.Xr mdoc>"
16996 msgstr ""
16997
16998 #. type: It
16999 #: build/C/man7/mdoc.samples.7:1374
17000 #, no-wrap
17001 msgid "Li \\&.Xr mdoc\\ ,"
17002 msgstr ""
17003
17004 #. type: Plain text
17005 #: build/C/man7/mdoc.samples.7:1376
17006 msgid "E<.Xr mdoc>,"
17007 msgstr ""
17008
17009 #. type: It
17010 #: build/C/man7/mdoc.samples.7:1376
17011 #, no-wrap
17012 msgid "Li \\&.Xr mdoc 7"
17013 msgstr ""
17014
17015 #. type: Plain text
17016 #: build/C/man7/mdoc.samples.7:1378
17017 msgid "E<.Xr mdoc 7>"
17018 msgstr ""
17019
17020 #. type: It
17021 #: build/C/man7/mdoc.samples.7:1378
17022 #, no-wrap
17023 msgid "Li \\&.Xr mdoc 7\\ )\\ )\\ ,"
17024 msgstr ""
17025
17026 #. type: Plain text
17027 #: build/C/man7/mdoc.samples.7:1380
17028 msgid "E<.Xr mdoc 7>)),"
17029 msgstr ""
17030
17031 #. type: Plain text
17032 #: build/C/man7/mdoc.samples.7:1389
17033 msgid ""
17034 "The E<.Ql \\&.Xr> macro is parsed and is callable.  It is an error to call "
17035 "E<.Ql \\&.Xr> without any arguments."
17036 msgstr ""
17037
17038 #. type: Sh
17039 #: build/C/man7/mdoc.samples.7:1389
17040 #, no-wrap
17041 msgid "GENERAL TEXT DOMAIN"
17042 msgstr ""
17043
17044 #. type: Ss
17045 #: build/C/man7/mdoc.samples.7:1390
17046 #, no-wrap
17047 msgid "AT&T Macro"
17048 msgstr ""
17049
17050 #. type: Plain text
17051 #: build/C/man7/mdoc.samples.7:1393
17052 #, no-wrap
17053 msgid "Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \\*(Pu\n"
17054 msgstr ""
17055
17056 #. type: It
17057 #: build/C/man7/mdoc.samples.7:1395
17058 #, no-wrap
17059 msgid "Li .At"
17060 msgstr ""
17061
17062 #. type: Plain text
17063 #: build/C/man7/mdoc.samples.7:1397
17064 msgid "E<.At>"
17065 msgstr ""
17066
17067 #. type: It
17068 #: build/C/man7/mdoc.samples.7:1397
17069 #, no-wrap
17070 msgid "Li \".At v6 .\""
17071 msgstr ""
17072
17073 #. type: Plain text
17074 #: build/C/man7/mdoc.samples.7:1399
17075 msgid "E<.At v6>."
17076 msgstr ""
17077
17078 #. type: Plain text
17079 #: build/C/man7/mdoc.samples.7:1409
17080 msgid ""
17081 "The E<.Ql \\&.At> macro is E<.Em not> parsed and E<.Em not> callable It "
17082 "accepts at most two arguments."
17083 msgstr ""
17084
17085 #. type: Ss
17086 #: build/C/man7/mdoc.samples.7:1409
17087 #, no-wrap
17088 msgid "BSD Macro"
17089 msgstr ""
17090
17091 #. type: Dl
17092 #: build/C/man7/mdoc.samples.7:1410
17093 #, no-wrap
17094 msgid "Usage: .Bx [Version/release] ... \\*(Pu"
17095 msgstr ""
17096
17097 #. type: It
17098 #: build/C/man7/mdoc.samples.7:1412
17099 #, no-wrap
17100 msgid "Li .Bx"
17101 msgstr ""
17102
17103 #. type: Plain text
17104 #: build/C/man7/mdoc.samples.7:1414
17105 msgid "E<.Bx>"
17106 msgstr ""
17107
17108 #. type: It
17109 #: build/C/man7/mdoc.samples.7:1414
17110 #, no-wrap
17111 msgid "Li \".Bx 4.3 .\""
17112 msgstr ""
17113
17114 #. type: Plain text
17115 #: build/C/man7/mdoc.samples.7:1416
17116 msgid "E<.Bx 4.3>."
17117 msgstr ""
17118
17119 #. type: Plain text
17120 #: build/C/man7/mdoc.samples.7:1421
17121 msgid "The E<.Ql \\&.Bx> macro is parsed and is callable."
17122 msgstr ""
17123
17124 #. type: Ss
17125 #: build/C/man7/mdoc.samples.7:1421
17126 #, no-wrap
17127 msgid "FreeBSD Macro"
17128 msgstr ""
17129
17130 #. type: Plain text
17131 #: build/C/man7/mdoc.samples.7:1424
17132 #, no-wrap
17133 msgid "Usage: .Fx Version.release ... \\*(Pu\n"
17134 msgstr ""
17135
17136 #. type: It
17137 #: build/C/man7/mdoc.samples.7:1426
17138 #, no-wrap
17139 msgid "Li \".Fx 2.2 .\""
17140 msgstr ""
17141
17142 #. type: Plain text
17143 #: build/C/man7/mdoc.samples.7:1428
17144 msgid "E<.Fx 2.2>."
17145 msgstr ""
17146
17147 #. type: Plain text
17148 #: build/C/man7/mdoc.samples.7:1438
17149 msgid ""
17150 "The E<.Ql \\&.Fx> macro is E<.Em not> parsed and E<.Em not> callable It "
17151 "accepts at most two arguments."
17152 msgstr ""
17153
17154 #. type: Ss
17155 #: build/C/man7/mdoc.samples.7:1438
17156 #, no-wrap
17157 msgid "UNIX Macro"
17158 msgstr ""
17159
17160 #. type: Dl
17161 #: build/C/man7/mdoc.samples.7:1439
17162 #, no-wrap
17163 msgid "Usage: .Ux ... \\*(Pu"
17164 msgstr ""
17165
17166 #. type: It
17167 #: build/C/man7/mdoc.samples.7:1441
17168 #, no-wrap
17169 msgid "Li .Ux"
17170 msgstr ""
17171
17172 #. type: Plain text
17173 #: build/C/man7/mdoc.samples.7:1443
17174 msgid "E<.Ux>"
17175 msgstr ""
17176
17177 #. type: Plain text
17178 #: build/C/man7/mdoc.samples.7:1448
17179 msgid "The E<.Ql \\&.Ux> macro is parsed and is callable."
17180 msgstr ""
17181
17182 #. type: Ss
17183 #: build/C/man7/mdoc.samples.7:1448
17184 #, no-wrap
17185 msgid "Enclosure and Quoting Macros"
17186 msgstr ""
17187
17188 #. type: Plain text
17189 #: build/C/man7/mdoc.samples.7:1470
17190 msgid ""
17191 "The concept of enclosure is similar to quoting.  The object being to enclose "
17192 "one or more strings between a pair of characters like quotes or "
17193 "parentheses.  The terms quoting and enclosure are used interchangeably "
17194 "throughout this document.  Most of the one line enclosure macros end in "
17195 "small letter E<.Ql q> to give a hint of quoting, but there are a few "
17196 "irregularities.  For each enclosure macro there is also a pair of open and "
17197 "close macros which end in small letters E<.Ql o> and E<.Ql c> respectively.  "
17198 "These can be used across one or more lines of text and while they have "
17199 "nesting limitations, the one line quote macros can be used inside of them."
17200 msgstr ""
17201
17202 #. type: Plain text
17203 #: build/C/man7/mdoc.samples.7:1483
17204 #, no-wrap
17205 msgid ""
17206 "E<.Em \" Quote\t Close\t Open\tFunction\tResult\">\n"
17207 "\\&.Aq\t.Ac\t.Ao\tAngle Bracket Enclosure\tE<lt>stringE<gt>\n"
17208 "\\&.Bq\t.Bc\t.Bo\tBracket Enclosure\t[string]\n"
17209 "\\&.Dq\t.Dc\t.Do\tDouble Quote\t``string''\n"
17210 "\t.Ec\t.Eo\tEnclose String (in XX)\tXXstringXX\n"
17211 "\\&.Pq\t.Pc\t.Po\tParenthesis Enclosure\t(string)\n"
17212 "\\&.Ql\t\t\tQuoted Literal\t`st' or string\n"
17213 "\\&.Qq\t.Qc\t.Qo\tStraight Double Quote\t\"string\"\n"
17214 "\\&.Sq\t.Sc\t.So\tSingle Quote\t`string'\n"
17215 msgstr ""
17216
17217 #. type: Plain text
17218 #: build/C/man7/mdoc.samples.7:1494
17219 msgid ""
17220 "Except for the irregular macros noted below, all of the quoting macros are "
17221 "parsed and callable.  All handle punctuation properly, as long as it is "
17222 "presented one character at a time and separated by spaces.  The quoting "
17223 "macros examine opening and closing punctuation to determine whether it comes "
17224 "before or after the enclosing string This makes some nesting possible."
17225 msgstr ""
17226
17227 #. type: It
17228 #: build/C/man7/mdoc.samples.7:1495
17229 #, no-wrap
17230 msgid "Li \\&.Ec , \\&.Eo"
17231 msgstr ""
17232
17233 #. type: Plain text
17234 #: build/C/man7/mdoc.samples.7:1498
17235 msgid ""
17236 "These macros expect the first argument to be the opening and closing strings "
17237 "respectively."
17238 msgstr ""
17239
17240 #. type: It
17241 #: build/C/man7/mdoc.samples.7:1498
17242 #, no-wrap
17243 msgid "Li \\&.Ql"
17244 msgstr ""
17245
17246 #. type: Plain text
17247 #: build/C/man7/mdoc.samples.7:1511
17248 msgid ""
17249 "The quoted literal macro behaves differently for E<.Xr troff> than E<.Xr "
17250 "nroff>.  If formatted with E<.Xr nroff>, a quoted literal is always quoted.  "
17251 "If formatted with troff, an item is quoted only if the width of the item is "
17252 "less than three constant width characters.  This is to make short strings "
17253 "more visible where the font change to literal (constant width) is less "
17254 "noticeable."
17255 msgstr ""
17256
17257 #. type: It
17258 #: build/C/man7/mdoc.samples.7:1511
17259 #, no-wrap
17260 msgid "Li \\&.Pf"
17261 msgstr ""
17262
17263 #. type: Plain text
17264 #: build/C/man7/mdoc.samples.7:1513
17265 msgid "The prefix macro is not callable, but it is parsed:"
17266 msgstr ""
17267
17268 #. type: It
17269 #: build/C/man7/mdoc.samples.7:1514
17270 #, no-wrap
17271 msgid "Li \".Pf ( Fa name2\""
17272 msgstr ""
17273
17274 #. type: Plain text
17275 #: build/C/man7/mdoc.samples.7:1517
17276 msgid "becomes E<.Pf ( Fa name2>."
17277 msgstr ""
17278
17279 #. type: Plain text
17280 #: build/C/man7/mdoc.samples.7:1522
17281 msgid "The E<.Ql \\&.Ns> (no space) macro performs the analogous suffix function."
17282 msgstr ""
17283
17284 #. type: Plain text
17285 #: build/C/man7/mdoc.samples.7:1526
17286 msgid "Examples of quoting:"
17287 msgstr ""
17288
17289 #. type: It
17290 #: build/C/man7/mdoc.samples.7:1527
17291 #, no-wrap
17292 msgid "Li \\&.Aq"
17293 msgstr ""
17294
17295 #. type: Plain text
17296 #: build/C/man7/mdoc.samples.7:1529
17297 msgid "E<.Aq>"
17298 msgstr ""
17299
17300 #. type: It
17301 #: build/C/man7/mdoc.samples.7:1529
17302 #, no-wrap
17303 msgid "Li \\&.Aq \\&Ar ctype.h\\ )\\ ,"
17304 msgstr ""
17305
17306 #. type: Plain text
17307 #: build/C/man7/mdoc.samples.7:1531
17308 msgid "E<.Aq Ar ctype.h>),"
17309 msgstr ""
17310
17311 #. type: It
17312 #: build/C/man7/mdoc.samples.7:1531
17313 #, no-wrap
17314 msgid "Li \\&.Bq"
17315 msgstr ""
17316
17317 #. type: Plain text
17318 #: build/C/man7/mdoc.samples.7:1533
17319 msgid "E<.Bq>"
17320 msgstr ""
17321
17322 #. type: It
17323 #: build/C/man7/mdoc.samples.7:1533
17324 #, no-wrap
17325 msgid "Li \\&.Bq \\&Em Greek \\&, French \\&."
17326 msgstr ""
17327
17328 #. type: Plain text
17329 #: build/C/man7/mdoc.samples.7:1535
17330 msgid "E<.Bq Em Greek , French>."
17331 msgstr ""
17332
17333 #. type: It
17334 #: build/C/man7/mdoc.samples.7:1535
17335 #, no-wrap
17336 msgid "Li \\&.Dq"
17337 msgstr ""
17338
17339 #. type: Plain text
17340 #: build/C/man7/mdoc.samples.7:1537
17341 msgid "E<.Dq>"
17342 msgstr ""
17343
17344 #. type: It
17345 #: build/C/man7/mdoc.samples.7:1537
17346 #, no-wrap
17347 msgid "Li \".Dq string abc .\""
17348 msgstr ""
17349
17350 #. type: Plain text
17351 #: build/C/man7/mdoc.samples.7:1539
17352 msgid "E<.Dq string abc>."
17353 msgstr ""
17354
17355 #. type: It
17356 #: build/C/man7/mdoc.samples.7:1539
17357 #, no-wrap
17358 msgid "Li \".Dq \\'^[A-Z]\\'\""
17359 msgstr ""
17360
17361 #. type: Plain text
17362 #: build/C/man7/mdoc.samples.7:1541
17363 msgid "E<.Dq \\'^[A-Z]\\'>"
17364 msgstr ""
17365
17366 #. type: It
17367 #: build/C/man7/mdoc.samples.7:1541
17368 #, no-wrap
17369 msgid "Li \"\\&.Ql man mdoc\""
17370 msgstr ""
17371
17372 #. type: Plain text
17373 #: build/C/man7/mdoc.samples.7:1543
17374 msgid "E<.Ql man mdoc>"
17375 msgstr ""
17376
17377 #. type: It
17378 #: build/C/man7/mdoc.samples.7:1543
17379 #, no-wrap
17380 msgid "Li \\&.Qq"
17381 msgstr ""
17382
17383 #. type: Plain text
17384 #: build/C/man7/mdoc.samples.7:1545
17385 msgid "E<.Qq>"
17386 msgstr ""
17387
17388 #. type: It
17389 #: build/C/man7/mdoc.samples.7:1545
17390 #, no-wrap
17391 msgid "Li \"\\&.Qq string ) ,\""
17392 msgstr ""
17393
17394 #. type: Plain text
17395 #: build/C/man7/mdoc.samples.7:1547
17396 msgid "E<.Qq string>),"
17397 msgstr ""
17398
17399 #. type: It
17400 #: build/C/man7/mdoc.samples.7:1547
17401 #, no-wrap
17402 msgid "Li \"\\&.Qq string Ns ),\""
17403 msgstr ""
17404
17405 #. type: Plain text
17406 #: build/C/man7/mdoc.samples.7:1549
17407 msgid "E<.Qq string Ns ),>"
17408 msgstr ""
17409
17410 #. type: It
17411 #: build/C/man7/mdoc.samples.7:1549
17412 #, no-wrap
17413 msgid "Li \\&.Sq"
17414 msgstr ""
17415
17416 #. type: Plain text
17417 #: build/C/man7/mdoc.samples.7:1551
17418 msgid "E<.Sq>"
17419 msgstr ""
17420
17421 #. type: It
17422 #: build/C/man7/mdoc.samples.7:1551
17423 #, no-wrap
17424 msgid "Li \"\\&.Sq string\""
17425 msgstr ""
17426
17427 #. type: Plain text
17428 #: build/C/man7/mdoc.samples.7:1553
17429 msgid "E<.Sq string>"
17430 msgstr ""
17431
17432 #. type: Plain text
17433 #: build/C/man7/mdoc.samples.7:1570
17434 msgid ""
17435 "For a good example of nested enclosure macros, see the E<.Ql \\&.Op> option "
17436 "macro.  It was created from the same underlying enclosure macros as those "
17437 "presented in the list above.  The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> extended "
17438 "argument list macros were also built from the same underlying routines and "
17439 "are a good example of E<.Nm \\-mdoc> macro usage at its worst."
17440 msgstr ""
17441
17442 #. type: Ss
17443 #: build/C/man7/mdoc.samples.7:1570
17444 #, no-wrap
17445 msgid "No\\-Op or Normal Text Macro"
17446 msgstr ""
17447
17448 #. type: Plain text
17449 #: build/C/man7/mdoc.samples.7:1578
17450 msgid ""
17451 "The macro E<.Ql \\&.No> is a hack for words in a macro command line which "
17452 "should E<.Em not> be formatted and follows the conventional syntax for "
17453 "content macros."
17454 msgstr ""
17455
17456 #. type: Ss
17457 #: build/C/man7/mdoc.samples.7:1578
17458 #, no-wrap
17459 msgid "No Space Macro"
17460 msgstr ""
17461
17462 #. type: Plain text
17463 #: build/C/man7/mdoc.samples.7:1584
17464 msgid ""
17465 "The E<.Ql \\&.Ns> macro eliminates unwanted spaces in between macro "
17466 "requests.  It is useful for old style argument lists where there is no space "
17467 "between the flag and argument:"
17468 msgstr ""
17469
17470 #. type: It
17471 #: build/C/man7/mdoc.samples.7:1585
17472 #, no-wrap
17473 msgid "Li \".Op Fl I Ns Ar directory\""
17474 msgstr ""
17475
17476 #. type: Plain text
17477 #: build/C/man7/mdoc.samples.7:1588
17478 msgid "produces E<.Op Fl I Ns Ar directory>"
17479 msgstr ""
17480
17481 #. type: Plain text
17482 #: build/C/man7/mdoc.samples.7:1599
17483 msgid ""
17484 "Note: the E<.Ql \\&.Ns> macro always invokes the E<.Ql \\&.No> macro after "
17485 "eliminating the space unless another macro name follows it.  The macro E<.Ql "
17486 "\\&.Ns> is parsed and is callable."
17487 msgstr ""
17488
17489 #. type: Ss
17490 #: build/C/man7/mdoc.samples.7:1599
17491 #, no-wrap
17492 msgid "Section Cross References"
17493 msgstr ""
17494
17495 #. type: Plain text
17496 #: build/C/man7/mdoc.samples.7:1605
17497 msgid ""
17498 "The E<.Ql \\&.Sx> macro designates a reference to a section header within "
17499 "the same document.  It is parsed and is callable."
17500 msgstr ""
17501
17502 #. type: It
17503 #: build/C/man7/mdoc.samples.7:1607
17504 #, no-wrap
17505 msgid "Li \\&.Sx FILES"
17506 msgstr ""
17507
17508 #. type: Plain text
17509 #: build/C/man7/mdoc.samples.7:1609
17510 msgid "E<.Sx FILES>"
17511 msgstr ""
17512
17513 #. type: Ss
17514 #: build/C/man7/mdoc.samples.7:1610
17515 #, no-wrap
17516 msgid "References and Citations"
17517 msgstr ""
17518
17519 #. type: Plain text
17520 #: build/C/man7/mdoc.samples.7:1614
17521 msgid ""
17522 "The following macros make a modest attempt to handle references.  At best, "
17523 "the macros make it convenient to manually drop in a subset of refer style "
17524 "references."
17525 msgstr ""
17526
17527 #. type: It
17528 #: build/C/man7/mdoc.samples.7:1616
17529 #, no-wrap
17530 msgid "Li .Rs"
17531 msgstr ""
17532
17533 #. type: Plain text
17534 #: build/C/man7/mdoc.samples.7:1621
17535 msgid ""
17536 "Reference Start.  Causes a line break and begins collection of reference "
17537 "information until the reference end macro is read."
17538 msgstr ""
17539
17540 #. type: It
17541 #: build/C/man7/mdoc.samples.7:1621
17542 #, no-wrap
17543 msgid "Li .Re"
17544 msgstr ""
17545
17546 #. type: Plain text
17547 #: build/C/man7/mdoc.samples.7:1624
17548 msgid "Reference End.  The reference is printed."
17549 msgstr ""
17550
17551 #. type: It
17552 #: build/C/man7/mdoc.samples.7:1624
17553 #, no-wrap
17554 msgid "Li .%A"
17555 msgstr ""
17556
17557 #. type: Plain text
17558 #: build/C/man7/mdoc.samples.7:1626
17559 msgid "Reference author name, one name per invocation."
17560 msgstr ""
17561
17562 #. type: It
17563 #: build/C/man7/mdoc.samples.7:1626
17564 #, no-wrap
17565 msgid "Li .%B"
17566 msgstr ""
17567
17568 #. type: Plain text
17569 #: build/C/man7/mdoc.samples.7:1628
17570 msgid "Book title."
17571 msgstr ""
17572
17573 #. type: It
17574 #: build/C/man7/mdoc.samples.7:1628
17575 #, no-wrap
17576 msgid "Li .\\&%C"
17577 msgstr ""
17578
17579 #. type: Plain text
17580 #: build/C/man7/mdoc.samples.7:1630
17581 msgid "City/place."
17582 msgstr ""
17583
17584 #. type: It
17585 #: build/C/man7/mdoc.samples.7:1630
17586 #, no-wrap
17587 msgid "Li .\\&%D"
17588 msgstr ""
17589
17590 #. type: Plain text
17591 #: build/C/man7/mdoc.samples.7:1632
17592 msgid "Date."
17593 msgstr ""
17594
17595 #. type: It
17596 #: build/C/man7/mdoc.samples.7:1632
17597 #, no-wrap
17598 msgid "Li .%J"
17599 msgstr ""
17600
17601 #. type: Plain text
17602 #: build/C/man7/mdoc.samples.7:1634
17603 msgid "Journal name."
17604 msgstr ""
17605
17606 #. type: It
17607 #: build/C/man7/mdoc.samples.7:1634
17608 #, no-wrap
17609 msgid "Li .%N"
17610 msgstr ""
17611
17612 #. type: Plain text
17613 #: build/C/man7/mdoc.samples.7:1636
17614 msgid "Issue number."
17615 msgstr ""
17616
17617 #. type: It
17618 #: build/C/man7/mdoc.samples.7:1636
17619 #, no-wrap
17620 msgid "Li .%O"
17621 msgstr ""
17622
17623 #. type: Plain text
17624 #: build/C/man7/mdoc.samples.7:1638
17625 msgid "Optional information."
17626 msgstr ""
17627
17628 #. type: It
17629 #: build/C/man7/mdoc.samples.7:1638
17630 #, no-wrap
17631 msgid "Li .%P"
17632 msgstr ""
17633
17634 #. type: Plain text
17635 #: build/C/man7/mdoc.samples.7:1640
17636 msgid "Page number."
17637 msgstr ""
17638
17639 #. type: It
17640 #: build/C/man7/mdoc.samples.7:1640
17641 #, no-wrap
17642 msgid "Li .%R"
17643 msgstr ""
17644
17645 #. type: Plain text
17646 #: build/C/man7/mdoc.samples.7:1642
17647 msgid "Report name."
17648 msgstr ""
17649
17650 #. type: It
17651 #: build/C/man7/mdoc.samples.7:1642
17652 #, no-wrap
17653 msgid "Li .%T"
17654 msgstr ""
17655
17656 #. type: Plain text
17657 #: build/C/man7/mdoc.samples.7:1644
17658 msgid "Title of article."
17659 msgstr ""
17660
17661 #. type: It
17662 #: build/C/man7/mdoc.samples.7:1644
17663 #, no-wrap
17664 msgid "Li .%V"
17665 msgstr ""
17666
17667 #. type: Plain text
17668 #: build/C/man7/mdoc.samples.7:1646
17669 msgid "Volume(s)."
17670 msgstr ""
17671
17672 #. type: Plain text
17673 #: build/C/man7/mdoc.samples.7:1657
17674 msgid ""
17675 "The macros beginning with E<.Ql %> are not callable, and are parsed only for "
17676 "the trade name macro which returns to its caller.  (And not very predictably "
17677 "at the moment either.)  The purpose is to allow trade names to be pretty "
17678 "printed in E<.Xr troff Ns / Ns Xr ditroff> output."
17679 msgstr ""
17680
17681 #. type: Ss
17682 #: build/C/man7/mdoc.samples.7:1657
17683 #, no-wrap
17684 msgid "Return Values"
17685 msgstr ""
17686
17687 #. type: Plain text
17688 #: build/C/man7/mdoc.samples.7:1663
17689 msgid ""
17690 "The E<.Ql \\&.Rv> macro generates text for use in the E<.Sx RETURN VALUE> "
17691 "section."
17692 msgstr ""
17693
17694 #. type: Dl
17695 #: build/C/man7/mdoc.samples.7:1664
17696 #, no-wrap
17697 msgid "Usage: .Rv [-std function]"
17698 msgstr ""
17699
17700 #. type: Plain text
17701 #: build/C/man7/mdoc.samples.7:1668
17702 msgid "E<.Ql \\&.Rv -std atexit> will generate the following text:"
17703 msgstr ""
17704
17705 #.  fake section 3 to avoid error message from Rv
17706 #. .ds cH 3
17707 #. type: ds section
17708 #: build/C/man7/mdoc.samples.7:1671
17709 #, no-wrap
17710 msgid "3"
17711 msgstr ""
17712
17713 #.  and back to 7 again
17714 #. .ds cH 7
17715 #. type: Plain text
17716 #: build/C/man7/mdoc.samples.7:1675
17717 msgid "E<.Rv -std atexit>"
17718 msgstr ""
17719
17720 #. type: ds section
17721 #: build/C/man7/mdoc.samples.7:1675
17722 #, no-wrap
17723 msgid "7"
17724 msgstr ""
17725
17726 #. type: Plain text
17727 #: build/C/man7/mdoc.samples.7:1680
17728 msgid "The E<.Fl std> option is valid only for manual page sections 2 and 3."
17729 msgstr ""
17730
17731 #. type: Ss
17732 #: build/C/man7/mdoc.samples.7:1680
17733 #, no-wrap
17734 msgid "Trade Names (or Acronyms and Type Names)"
17735 msgstr ""
17736
17737 #. type: Plain text
17738 #: build/C/man7/mdoc.samples.7:1683
17739 msgid ""
17740 "The trade name macro is generally a small caps macro for all upper case "
17741 "words longer than two characters."
17742 msgstr ""
17743
17744 #. type: Dl
17745 #: build/C/man7/mdoc.samples.7:1684
17746 #, no-wrap
17747 msgid "Usage: .Tn symbol ... \\*(Pu"
17748 msgstr ""
17749
17750 #. type: It
17751 #: build/C/man7/mdoc.samples.7:1686
17752 #, no-wrap
17753 msgid "Li \\&.Tn DEC"
17754 msgstr ""
17755
17756 #. type: Plain text
17757 #: build/C/man7/mdoc.samples.7:1688
17758 msgid "E<.Tn DEC>"
17759 msgstr ""
17760
17761 #. type: It
17762 #: build/C/man7/mdoc.samples.7:1688
17763 #, no-wrap
17764 msgid "Li \\&.Tn ASCII"
17765 msgstr ""
17766
17767 #. type: Plain text
17768 #: build/C/man7/mdoc.samples.7:1690
17769 msgid "E<.Tn ASCII>"
17770 msgstr ""
17771
17772 #. type: Plain text
17773 #: build/C/man7/mdoc.samples.7:1696
17774 msgid "The E<.Ql \\&.Tn> macro is parsed and is callable by other macros."
17775 msgstr ""
17776
17777 #. type: Ss
17778 #: build/C/man7/mdoc.samples.7:1696
17779 #, no-wrap
17780 msgid "Extended Arguments"
17781 msgstr ""
17782
17783 #. type: Plain text
17784 #: build/C/man7/mdoc.samples.7:1708
17785 msgid ""
17786 "The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> macros allow one to extend an argument "
17787 "list on a macro boundary.  Argument lists cannot be extended within a macro "
17788 "which expects all of its arguments on one line such as E<.Ql \\&.Op>."
17789 msgstr ""
17790
17791 #. type: Plain text
17792 #: build/C/man7/mdoc.samples.7:1712
17793 msgid ""
17794 "Here is an example of E<.Ql \\&.Xo> using the space mode macro to turn "
17795 "spacing off:"
17796 msgstr ""
17797
17798 #. type: Plain text
17799 #: build/C/man7/mdoc.samples.7:1718
17800 #, no-wrap
17801 msgid ""
17802 "\\&.Sm off\n"
17803 "\\&.It Xo Sy I Ar operation\n"
17804 "\\&.No \\een Ar count No \\een\n"
17805 "\\&.Xc\n"
17806 "\\&.Sm on\n"
17807 msgstr ""
17808
17809 #. type: Plain text
17810 #: build/C/man7/mdoc.samples.7:1721 build/C/man7/mdoc.samples.7:1742 build/C/man7/mdoc.samples.7:1766
17811 msgid "Produces"
17812 msgstr ""
17813
17814 #. type: Plain text
17815 #: build/C/man7/mdoc.samples.7:1724 build/C/man7/mdoc.samples.7:1745
17816 #, no-wrap
17817 msgid "E<.Sm off>\n"
17818 msgstr ""
17819
17820 #. type: It
17821 #: build/C/man7/mdoc.samples.7:1724
17822 #, no-wrap
17823 msgid "Xo Sy I Ar operation"
17824 msgstr ""
17825
17826 #. type: Plain text
17827 #: build/C/man7/mdoc.samples.7:1728
17828 #, no-wrap
17829 msgid ""
17830 "E<.No \\en Ar count No \\en>\n"
17831 "E<.Xc>\n"
17832 "E<.Sm on>\n"
17833 msgstr ""
17834
17835 #. type: Plain text
17836 #: build/C/man7/mdoc.samples.7:1732
17837 msgid "Another one:"
17838 msgstr ""
17839
17840 #. type: Plain text
17841 #: build/C/man7/mdoc.samples.7:1739
17842 #, no-wrap
17843 msgid ""
17844 "\\&.Sm off\n"
17845 "\\&.It Cm S No \\&/ Ar old_pattern Xo\n"
17846 "\\&.No \\&/ Ar new_pattern\n"
17847 "\\&.No \\&/ Op Cm g\n"
17848 "\\&.Xc\n"
17849 "\\&.Sm on\n"
17850 msgstr ""
17851
17852 #. type: It
17853 #: build/C/man7/mdoc.samples.7:1745
17854 #, no-wrap
17855 msgid "Cm S No \\&/ Ar old_pattern Xo"
17856 msgstr ""
17857
17858 #. type: Plain text
17859 #: build/C/man7/mdoc.samples.7:1750
17860 #, no-wrap
17861 msgid ""
17862 "E<.No \\&/ Ar new_pattern>\n"
17863 "E<.No \\&/ Op Cm g>\n"
17864 "E<.Xc>\n"
17865 "E<.Sm on>\n"
17866 msgstr ""
17867
17868 #. type: Plain text
17869 #: build/C/man7/mdoc.samples.7:1757
17870 msgid ""
17871 "Another example of E<.Ql \\&.Xo> and using enclosure macros: Test the value "
17872 "of a variable."
17873 msgstr ""
17874
17875 #. type: Plain text
17876 #: build/C/man7/mdoc.samples.7:1763
17877 #, no-wrap
17878 msgid ""
17879 "\\&.It Xo\n"
17880 "\\&.Ic .ifndef\n"
17881 "\\&.Oo \\e&! Oc Ns Ar variable\n"
17882 "\\&.Op Ar operator variable ...\n"
17883 "\\&.Xc\n"
17884 msgstr ""
17885
17886 #. type: It
17887 #: build/C/man7/mdoc.samples.7:1768
17888 #, no-wrap
17889 msgid "Xo"
17890 msgstr ""
17891
17892 #. type: Plain text
17893 #: build/C/man7/mdoc.samples.7:1773
17894 #, no-wrap
17895 msgid ""
17896 "E<.Ic .ifndef>\n"
17897 "E<.Oo \\&! Oc Ns Ar variable>\n"
17898 "E<.Op Ar operator variable ...>\n"
17899 "E<.Xc>\n"
17900 msgstr ""
17901
17902 #. type: Plain text
17903 #: build/C/man7/mdoc.samples.7:1811
17904 msgid ""
17905 "All of the above examples have used the E<.Ql \\&.Xo> macro on the argument "
17906 "list of the E<.Ql \\&.It> (list-item)  macro.  The extend macros are not "
17907 "used very often, and when they are it is usually to extend the list-item "
17908 "argument list.  Unfortunately, this is also where the extend macros are the "
17909 "most finicky.  In the first two examples, spacing was turned off; in the "
17910 "third, spacing was desired in part of the output but not all of it.  To make "
17911 "these macros work in this situation make sure the E<.Ql \\&.Xo> and E<.Ql "
17912 "\\&.Xc> macros are placed as shown in the third example.  If the E<.Ql "
17913 "\\&.Xo> macro is not alone on the E<.Ql \\&.It> argument list, spacing will "
17914 "be unpredictable.  The E<.Ql \\&.Ns> (no space macro)  must not occur as the "
17915 "first or last macro on a line in this situation.  Out of 900 manual pages "
17916 "(about 1500 actual pages)  currently released with E<.Bx> only fifteen use "
17917 "the E<.Ql \\&.Xo> macro."
17918 msgstr ""
17919
17920 #. type: Ss
17921 #: build/C/man7/mdoc.samples.7:1812
17922 #, no-wrap
17923 msgid "Section Headers"
17924 msgstr ""
17925
17926 #. type: Plain text
17927 #: build/C/man7/mdoc.samples.7:1825
17928 msgid ""
17929 "The first three E<.Ql \\&.Sh> section header macros list below are required "
17930 "in every man page.  The remaining section headers are recommended at the "
17931 "discretion of the author writing the manual page.  The E<.Ql \\&.Sh> macro "
17932 "can take up to nine arguments.  It is parsed and but is not callable."
17933 msgstr ""
17934
17935 #. type: It
17936 #: build/C/man7/mdoc.samples.7:1826
17937 #, no-wrap
17938 msgid "\\&.Sh NAME"
17939 msgstr ""
17940
17941 #. type: Plain text
17942 #: build/C/man7/mdoc.samples.7:1846
17943 msgid ""
17944 "The E<.Ql \\&.Sh NAME> macro is mandatory.  If not specified, the headers, "
17945 "footers and page layout defaults will not be set and things will be rather "
17946 "unpleasant.  The E<.Sx NAME> section consists of at least three items.  The "
17947 "first is the E<.Ql \\&.Nm> name macro naming the subject of the man page.  "
17948 "The second is the Name Description macro, E<.Ql \\&.Nd>, which separates the "
17949 "subject name from the third item, which is the description.  The description "
17950 "should be the most terse and lucid possible, as the space available is "
17951 "small."
17952 msgstr ""
17953
17954 #. type: It
17955 #: build/C/man7/mdoc.samples.7:1846
17956 #, no-wrap
17957 msgid "\\&.Sh SYNOPSIS"
17958 msgstr ""
17959
17960 #. type: Plain text
17961 #: build/C/man7/mdoc.samples.7:1878
17962 msgid ""
17963 "The E<.Sx SYNOPSIS> section describes the typical usage of the subject of a "
17964 "man page.  The macros required are either E<.Ql \".Nm\">, E<.Ql \".Cd\">, "
17965 "E<.Ql \".Fn\">, (and possibly E<.Ql \".Fo\">, E<.Ql \".Fc\">, E<.Ql "
17966 "\".Fd\">, E<.Ql \".Ft\"> macros).  The function name macro E<.Ql \".Fn\"> is "
17967 "required for manual page sections 2 and 3, the command and general name "
17968 "macro E<.Ql \\&.Nm> is required for sections 1, 5, 6, 7, 8.  Section 4 "
17969 "manuals require a E<.Ql \".Nm\">, E<.Ql \".Fd\"> or a E<.Ql \".Cd\"> "
17970 "configuration device usage macro.  Several other macros may be necessary to "
17971 "produce the synopsis line as shown below:"
17972 msgstr ""
17973
17974 #. type: Plain text
17975 #: build/C/man7/mdoc.samples.7:1885
17976 #, no-wrap
17977 msgid ""
17978 "E<.Nm cat>\n"
17979 "E<.Op Fl benstuv>\n"
17980 "E<.Op Fl>\n"
17981 "E<.Ar>\n"
17982 msgstr ""
17983
17984 #. type: Plain text
17985 #: build/C/man7/mdoc.samples.7:1888
17986 msgid "The following macros were used:"
17987 msgstr ""
17988
17989 #. type: Dl
17990 #: build/C/man7/mdoc.samples.7:1889
17991 #, no-wrap
17992 msgid "\\&.Nm cat"
17993 msgstr ""
17994
17995 #. type: Dl
17996 #: build/C/man7/mdoc.samples.7:1890
17997 #, no-wrap
17998 msgid "\\&.Op \\&Fl benstuv"
17999 msgstr ""
18000
18001 #. type: Dl
18002 #: build/C/man7/mdoc.samples.7:1891
18003 #, no-wrap
18004 msgid "\\&.Op \\&Fl"
18005 msgstr ""
18006
18007 #. type: Dl
18008 #: build/C/man7/mdoc.samples.7:1892
18009 #, no-wrap
18010 msgid "\\&.Ar"
18011 msgstr ""
18012
18013 #. type: Plain text
18014 #: build/C/man7/mdoc.samples.7:1903
18015 msgid ""
18016 "E<.Sy Note>: The macros E<.Ql \\&.Op>, E<.Ql \\&.Fl>, and E<.Ql \\&.Ar> "
18017 "recognize the pipe bar character E<.Ql \\*(Ba>, so a command line such as:"
18018 msgstr ""
18019
18020 #. type: Dl
18021 #: build/C/man7/mdoc.samples.7:1904
18022 #, no-wrap
18023 msgid ".Op Fl a | Fl b"
18024 msgstr ""
18025
18026 #. type: Plain text
18027 #: build/C/man7/mdoc.samples.7:1913
18028 msgid ""
18029 "will not go orbital.  E<.Xr Troff> normally interprets a \\*(Ba as a special "
18030 "operator.  See E<.Sx PREDEFINED STRINGS> for a usable \\*(Ba character in "
18031 "other situations."
18032 msgstr ""
18033
18034 #. type: It
18035 #: build/C/man7/mdoc.samples.7:1914
18036 #, no-wrap
18037 msgid "\\&.Sh DESCRIPTION"
18038 msgstr ""
18039
18040 #. type: Plain text
18041 #: build/C/man7/mdoc.samples.7:1931
18042 msgid ""
18043 "In most cases the first text in the E<.Sx DESCRIPTION> section is a brief "
18044 "paragraph on the command, function or file, followed by a lexical list of "
18045 "options and respective explanations.  To create such a list, the E<.Ql "
18046 "\\&.Bl> begin-list, E<.Ql \\&.It> list-item and E<.Ql \\&.El> end-list "
18047 "macros are used (see E<.Sx Lists and Columns> below)."
18048 msgstr ""
18049
18050 #. type: Plain text
18051 #: build/C/man7/mdoc.samples.7:1940
18052 msgid ""
18053 "The following E<.Ql \\&.Sh> section headers are part of the preferred manual "
18054 "page layout and must be used appropriately to maintain consistency.  They "
18055 "are listed in the order in which they would be used."
18056 msgstr ""
18057
18058 #. type: It
18059 #: build/C/man7/mdoc.samples.7:1941
18060 #, no-wrap
18061 msgid "\\&.Sh ENVIRONMENT"
18062 msgstr ""
18063
18064 #. type: Plain text
18065 #: build/C/man7/mdoc.samples.7:1947
18066 msgid ""
18067 "The E<.Sx ENVIRONMENT> section should reveal any related environment "
18068 "variables and clues to their behavior and/or usage."
18069 msgstr ""
18070
18071 #. type: It
18072 #: build/C/man7/mdoc.samples.7:1947
18073 #, no-wrap
18074 msgid "\\&.Sh EXAMPLES"
18075 msgstr ""
18076
18077 #. type: Plain text
18078 #: build/C/man7/mdoc.samples.7:1954
18079 msgid ""
18080 "There are several ways to create examples.  See the E<.Sx EXAMPLES> section "
18081 "below for details."
18082 msgstr ""
18083
18084 #. type: It
18085 #: build/C/man7/mdoc.samples.7:1954
18086 #, no-wrap
18087 msgid "\\&.Sh FILES"
18088 msgstr ""
18089
18090 #. type: Plain text
18091 #: build/C/man7/mdoc.samples.7:1961
18092 msgid ""
18093 "Files which are used or created by the man page subject should be listed via "
18094 "the E<.Ql \\&.Pa> macro in the E<.Sx FILES> section."
18095 msgstr ""
18096
18097 #. type: It
18098 #: build/C/man7/mdoc.samples.7:1961
18099 #, no-wrap
18100 msgid "\\&.Sh SEE ALSO"
18101 msgstr ""
18102
18103 #. type: Plain text
18104 #: build/C/man7/mdoc.samples.7:1975
18105 msgid ""
18106 "References to other material on the man page topic and cross references to "
18107 "other relevant man pages should be placed in the E<.Sx SEE ALSO> section.  "
18108 "Cross references are specified using the E<.Ql \\&.Xr> macro.  Cross "
18109 "references in the E<.Sx SEE ALSO> section should be sorted by section "
18110 "number, and then placed in alphabetical order and comma separated.  For "
18111 "example:"
18112 msgstr ""
18113
18114 #. type: Plain text
18115 #: build/C/man7/mdoc.samples.7:1980
18116 msgid "E<.Xr ls 1>, E<.Xr ps 1>, E<.Xr group 5>, E<.Xr passwd 5>."
18117 msgstr ""
18118
18119 #. type: Plain text
18120 #: build/C/man7/mdoc.samples.7:1984
18121 msgid "At this time E<.Xr refer 1> style references are not accommodated."
18122 msgstr ""
18123
18124 #. type: It
18125 #: build/C/man7/mdoc.samples.7:1984
18126 #, no-wrap
18127 msgid "\\&.Sh CONFORMING TO"
18128 msgstr ""
18129
18130 #. type: Plain text
18131 #: build/C/man7/mdoc.samples.7:1996
18132 msgid ""
18133 "If the command, library function or file adheres to a specific "
18134 "implementation such as E<.St -p1003.2> or E<.St -ansiC> this should be noted "
18135 "here.  If the command does not adhere to any standard, its history should be "
18136 "noted in the E<.Sx HISTORY> section."
18137 msgstr ""
18138
18139 #. type: It
18140 #: build/C/man7/mdoc.samples.7:1996
18141 #, no-wrap
18142 msgid "\\&.Sh HISTORY"
18143 msgstr ""
18144
18145 #. type: Plain text
18146 #: build/C/man7/mdoc.samples.7:1999
18147 msgid ""
18148 "Any command which does not adhere to any specific standards should be "
18149 "outlined historically in this section."
18150 msgstr ""
18151
18152 #. type: It
18153 #: build/C/man7/mdoc.samples.7:1999
18154 #, no-wrap
18155 msgid "\\&.Sh AUTHORS"
18156 msgstr ""
18157
18158 #. type: Plain text
18159 #: build/C/man7/mdoc.samples.7:2001
18160 msgid "Credits, if need be, should be placed here."
18161 msgstr ""
18162
18163 #. type: It
18164 #: build/C/man7/mdoc.samples.7:2001
18165 #, no-wrap
18166 msgid "\\&.Sh DIAGNOSTICS"
18167 msgstr ""
18168
18169 #. type: Plain text
18170 #: build/C/man7/mdoc.samples.7:2003
18171 msgid "Diagnostics from a command should be placed in this section."
18172 msgstr ""
18173
18174 #. type: It
18175 #: build/C/man7/mdoc.samples.7:2003
18176 #, no-wrap
18177 msgid "\\&.Sh ERRORS"
18178 msgstr ""
18179
18180 #. type: Plain text
18181 #: build/C/man7/mdoc.samples.7:2009
18182 msgid ""
18183 "Specific error handling, especially from library functions (man page "
18184 "sections 2 and 3) should go here.  The E<.Ql \\&.Er> macro is used to "
18185 "specify an errno."
18186 msgstr ""
18187
18188 #. type: It
18189 #: build/C/man7/mdoc.samples.7:2009
18190 #, no-wrap
18191 msgid "\\&.Sh BUGS"
18192 msgstr ""
18193
18194 #. type: Plain text
18195 #: build/C/man7/mdoc.samples.7:2011
18196 msgid "Blatant problems with the topic go here..."
18197 msgstr ""
18198
18199 #. type: Plain text
18200 #: build/C/man7/mdoc.samples.7:2017
18201 msgid ""
18202 "User specified E<.Ql \\&.Sh> sections may be added, for example, this "
18203 "section was set with:"
18204 msgstr ""
18205
18206 #. type: Plain text
18207 #: build/C/man7/mdoc.samples.7:2019
18208 #, no-wrap
18209 msgid "\\&.Sh PAGE STRUCTURE DOMAIN\n"
18210 msgstr ""
18211
18212 #. type: Ss
18213 #: build/C/man7/mdoc.samples.7:2020
18214 #, no-wrap
18215 msgid "Paragraphs and Line Spacing."
18216 msgstr ""
18217
18218 #. type: It
18219 #: build/C/man7/mdoc.samples.7:2022
18220 #, no-wrap
18221 msgid "\\&.Pp"
18222 msgstr ""
18223
18224 #. type: Plain text
18225 #: build/C/man7/mdoc.samples.7:2038
18226 msgid ""
18227 "The E<.Ql \\&.Pp> paragraph command may be used to specify a line space "
18228 "where necessary.  The macro is not necessary after a E<.Ql \\&.Sh> or E<.Ql "
18229 "\\&.Ss> macro or before a E<.Ql \\&.Bl> macro.  (The E<.Ql \\&.Bl> macro "
18230 "asserts a vertical distance unless the -compact flag is given)."
18231 msgstr ""
18232
18233 #.  This worked with version one, need to redo for version three
18234 #.  .Pp
18235 #.  .Ds I
18236 #.  .Cw (ax+bx+c) \ is\ produced\ by\ \&
18237 #.  .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
18238 #.  .Cl Cx \t\t
18239 #.  .Li \&.Cx\ (
18240 #.  .Cx
18241 #.  .Cl Cx \t\t
18242 #.  .Li \&.Va ax
18243 #.  .Cx
18244 #.  .Cl Cx \t\t
18245 #.  .Li \&.Sy \+
18246 #.  .Cx
18247 #.  .Cl Cx \&(\&
18248 #.  .Va ax
18249 #.  .Cx +
18250 #.  .Va by
18251 #.  .Cx +
18252 #.  .Va c )
18253 #.  .Cx \t
18254 #.  .Em is produced by
18255 #.  .Cx \t
18256 #.  .Li \&.Va by
18257 #.  .Cx
18258 #.  .Cl Cx \t\t
18259 #.  .Li \&.Sy \+
18260 #.  .Cx
18261 #.  .Cl Cx \t\t
18262 #.  .Li \&.Va c )
18263 #.  .Cx
18264 #.  .Cl Cx \t\t
18265 #.  .Li \&.Cx
18266 #.  .Cx
18267 #.  .Cw
18268 #.  .De
18269 #.  .Pp
18270 #.  This example shows the same equation in a different format.
18271 #.  The spaces
18272 #.  around the
18273 #.  .Li \&+
18274 #.  signs were forced with
18275 #.  .Li \e :
18276 #.  .Pp
18277 #.  .Ds I
18278 #.  .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
18279 #.  .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
18280 #.  .Cl Cx \t\t
18281 #.  .Li \&.Cx\ (
18282 #.  .Cx
18283 #.  .Cl Cx \t\t
18284 #.  .Li \&.Va a
18285 #.  .Cx
18286 #.  .Cl Cx \t\t
18287 #.  .Li \&.Sy x
18288 #.  .Cx
18289 #.  .Cl Cx \t\t
18290 #.  .Li \&.Cx \e\ +\e\ \e&
18291 #.  .Cx
18292 #.  .Cl Cx \&(\&
18293 #.  .Va a
18294 #.  .Sy x
18295 #.  .Cx \ +\ \&
18296 #.  .Va b
18297 #.  .Sy y
18298 #.  .Cx \ +\ \&
18299 #.  .Va c )
18300 #.  .Cx \t
18301 #.  .Em is produced by
18302 #.  .Cl Cx \t\t
18303 #.  .Li \&.Va b
18304 #.  .Cx
18305 #.  .Cl Cx \t\t
18306 #.  .Li \&.Sy y
18307 #.  .Cx
18308 #.  .Cl Cx \t\t
18309 #.  .Li \&.Cx \e\ +\e\ \e&
18310 #.  .Cx
18311 #.  .Cl Cx \t\t
18312 #.  .Li \&.Va c )
18313 #.  .Cx
18314 #.  .Cl Cx \t\t
18315 #.  .Li \&.Cx
18316 #.  .Cx
18317 #.  .Cw
18318 #.  .De
18319 #.  .Pp
18320 #.  The incantation below was
18321 #.  lifted from the
18322 #.  .Xr adb 1
18323 #.  manual page:
18324 #.  .Pp
18325 #.  .Ds I
18326 #.  .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
18327 #.  .Cl Cx \t\t
18328 #.  .Li \&.Cx Op Sy ?/
18329 #.  .Cx
18330 #.  .Cl Cx \t\t
18331 #.  .Li \&.Nm m
18332 #.  .Cx
18333 #.  .Cl Cx Op Sy ?/
18334 #.  .Nm m
18335 #.  .Ad \ b1 e1 f1
18336 #.  .Op Sy ?/
18337 #.  .Cx \t
18338 #.  .Em is produced by
18339 #.  .Cx \t
18340 #.  .Li \&.Ar \e\ b1 e1 f1
18341 #.  .Cx
18342 #.  .Cl Cx \t\t
18343 #.  .Li \&.Op Sy ?/
18344 #.  .Cx
18345 #.  .Cl Cx \t\t
18346 #.  .Li \&.Cx
18347 #.  .Cx
18348 #.  .Cw
18349 #.  .De
18350 #.  .Pp
18351 #. type: Ss
18352 #: build/C/man7/mdoc.samples.7:2157
18353 #, no-wrap
18354 msgid "Keeps"
18355 msgstr ""
18356
18357 #. type: Plain text
18358 #: build/C/man7/mdoc.samples.7:2186
18359 msgid ""
18360 "The only keep that is implemented at this time is for words.  The macros are "
18361 "E<.Ql \\&.Bk> (begin-keep)  and E<.Ql \\&.Ek> (end-keep).  The only option "
18362 "that E<.Ql \\&.Bk> accepts is E<.Fl words> and is useful for preventing line "
18363 "breaks in the middle of options.  In the example for the make command-line "
18364 "arguments (see E<.Sx What's in a name>), the keep prevented E<.Xr nroff> "
18365 "from placing up the flag and the argument on separate lines.  (Actually, the "
18366 "option macro used to prevent this from occurring, but was dropped when the "
18367 "decision (religious) was made to force right justified margins in E<.Xr "
18368 "troff> as options in general look atrocious when spread across a sparse "
18369 "line.  More work needs to be done with the keep macros, a E<.Fl line> option "
18370 "needs to be added.)"
18371 msgstr ""
18372
18373 #. type: Ss
18374 #: build/C/man7/mdoc.samples.7:2186
18375 #, no-wrap
18376 msgid "Examples and Displays"
18377 msgstr ""
18378
18379 #. type: Plain text
18380 #: build/C/man7/mdoc.samples.7:2198
18381 msgid ""
18382 "There are five types of displays, a quickie one line indented display E<.Ql "
18383 "\\&.D1>, a quickie one line literal display E<.Ql \\&.Dl>, and a block "
18384 "literal, block filled and block ragged which use the E<.Ql \\&.Bd> "
18385 "begin-display and E<.Ql \\&.Ed> end-display macros."
18386 msgstr ""
18387
18388 #. type: Plain text
18389 #: build/C/man7/mdoc.samples.7:2203
18390 msgid ""
18391 "(D-one) Display one line of indented text.  This macro is parsed, but it is "
18392 "not callable."
18393 msgstr ""
18394
18395 #. type: Dl
18396 #: build/C/man7/mdoc.samples.7:2204
18397 #, no-wrap
18398 msgid "Fl ldghfstru"
18399 msgstr ""
18400
18401 #. type: Plain text
18402 #: build/C/man7/mdoc.samples.7:2208
18403 msgid "The above was produced by: E<.Li \\&.Dl Fl ldghfstru>."
18404 msgstr ""
18405
18406 #. type: Plain text
18407 #: build/C/man7/mdoc.samples.7:2223
18408 msgid ""
18409 "(D-ell)  Display one line of indented E<.Em literal> text.  The E<.Ql "
18410 "\\&.Dl> example macro has been used throughout this file.  It allows the "
18411 "indent (display) of one line of text.  Its default font is set to constant "
18412 "width (literal) however it is parsed and will recognized other macros.  It "
18413 "is not callable however."
18414 msgstr ""
18415
18416 #. type: Dl
18417 #: build/C/man7/mdoc.samples.7:2224
18418 #, no-wrap
18419 msgid "% ls -ldg /usr/local/bin"
18420 msgstr ""
18421
18422 #. type: Plain text
18423 #: build/C/man7/mdoc.samples.7:2228
18424 msgid "The above was produced by E<.Li \\&.Dl % ls -ldg /usr/local/bin>."
18425 msgstr ""
18426
18427 #. type: Plain text
18428 #: build/C/man7/mdoc.samples.7:2239
18429 msgid ""
18430 "Begin-display.  The E<.Ql \\&.Bd> display must be ended with the E<.Ql "
18431 "\\&.Ed> macro.  Displays may be nested within displays and lists.  E<.Ql "
18432 "\\&.Bd> has the following syntax:"
18433 msgstr ""
18434
18435 #. type: Dl
18436 #: build/C/man7/mdoc.samples.7:2240
18437 #, no-wrap
18438 msgid ".Bd display-type [-offset offset_value] [-compact]"
18439 msgstr ""
18440
18441 #. type: Plain text
18442 #: build/C/man7/mdoc.samples.7:2245
18443 msgid ""
18444 "The display-type must be one of the following four types and may have an "
18445 "offset specifier for indentation: E<.Ql \\&.Bd>."
18446 msgstr ""
18447
18448 #. type: Plain text
18449 #: build/C/man7/mdoc.samples.7:2251
18450 msgid ""
18451 "Display a block of text as typed, right (and left) margin edges are left "
18452 "ragged."
18453 msgstr ""
18454
18455 #. type: Plain text
18456 #: build/C/man7/mdoc.samples.7:2255
18457 msgid ""
18458 "Display a filled (formatted) block.  The block of text is formatted (the "
18459 "edges are filled \\- not left unjustified)."
18460 msgstr ""
18461
18462 #. type: Plain text
18463 #: build/C/man7/mdoc.samples.7:2258
18464 msgid ""
18465 "Display a literal block, useful for source code or simple tabbed or spaced "
18466 "text."
18467 msgstr ""
18468
18469 #. type: It
18470 #: build/C/man7/mdoc.samples.7:2258
18471 #, no-wrap
18472 msgid "Fl file Ar file_name"
18473 msgstr ""
18474
18475 #. type: Plain text
18476 #: build/C/man7/mdoc.samples.7:2267
18477 msgid ""
18478 "The filename following the E<.Fl file> flag is read and displayed.  Literal "
18479 "mode is asserted and tabs are set at 8 constant width character intervals, "
18480 "however any E<.Xr troff/ Ns Nm \\-mdoc> commands in file will be processed."
18481 msgstr ""
18482
18483 #. type: Plain text
18484 #: build/C/man7/mdoc.samples.7:2273
18485 msgid ""
18486 "If E<.Fl offset> is specified with one of the following strings, the string "
18487 "is interpreted to indicate the level of indentation for the forthcoming "
18488 "block of text:"
18489 msgstr ""
18490
18491 #. type: Plain text
18492 #: build/C/man7/mdoc.samples.7:2279
18493 msgid ""
18494 "Align block on the current left margin, this is the default mode of E<.Ql "
18495 "\\&.Bd>."
18496 msgstr ""
18497
18498 #. type: Plain text
18499 #: build/C/man7/mdoc.samples.7:2284
18500 msgid ""
18501 "Supposedly center the block.  At this time unfortunately, the block merely "
18502 "gets left aligned about an imaginary center margin."
18503 msgstr ""
18504
18505 #. type: Plain text
18506 #: build/C/man7/mdoc.samples.7:2293
18507 msgid ""
18508 "Indents by one default indent value or tab.  The default indent value is "
18509 "also used for the E<.Ql \\&.D1> display so one is guaranteed the two types "
18510 "of displays will line up.  This indent is normally set to 6n or about two "
18511 "thirds of an inch (six constant width characters)."
18512 msgstr ""
18513
18514 #. type: Plain text
18515 #: build/C/man7/mdoc.samples.7:2295
18516 msgid "Indents two times the default indent value."
18517 msgstr ""
18518
18519 #. type: Plain text
18520 #: build/C/man7/mdoc.samples.7:2303
18521 msgid ""
18522 "This E<.Em left> aligns the block about two inches from the right side of "
18523 "the page.  This macro needs work and perhaps may never do the right thing by "
18524 "E<.Xr troff>."
18525 msgstr ""
18526
18527 #. type: It
18528 #: build/C/man7/mdoc.samples.7:2304
18529 #, no-wrap
18530 msgid ".Ed"
18531 msgstr ""
18532
18533 #. type: Plain text
18534 #: build/C/man7/mdoc.samples.7:2306
18535 msgid "End-display."
18536 msgstr ""
18537
18538 #. type: Ss
18539 #: build/C/man7/mdoc.samples.7:2307
18540 #, no-wrap
18541 msgid "Font Modes"
18542 msgstr ""
18543
18544 #. type: Plain text
18545 #: build/C/man7/mdoc.samples.7:2309
18546 msgid "There are five macros for changing the appearance of the manual page text:"
18547 msgstr ""
18548
18549 #. type: It
18550 #: build/C/man7/mdoc.samples.7:2310
18551 #, no-wrap
18552 msgid "\\&.Em"
18553 msgstr ""
18554
18555 #. type: Plain text
18556 #: build/C/man7/mdoc.samples.7:2315
18557 msgid ""
18558 "Text may be stressed or emphasized with the E<.Ql \\&.Em> macro.  The usual "
18559 "font for emphasis is italic."
18560 msgstr ""
18561
18562 #. type: Dl
18563 #: build/C/man7/mdoc.samples.7:2316
18564 #, no-wrap
18565 msgid "Usage: .Em argument ... \\*(Pu"
18566 msgstr ""
18567
18568 #. type: It
18569 #: build/C/man7/mdoc.samples.7:2318
18570 #, no-wrap
18571 msgid "Li \".Em does not\""
18572 msgstr ""
18573
18574 #. type: Plain text
18575 #: build/C/man7/mdoc.samples.7:2320
18576 msgid "E<.Em does not>"
18577 msgstr ""
18578
18579 #. type: It
18580 #: build/C/man7/mdoc.samples.7:2320
18581 #, no-wrap
18582 msgid "Li \".Em exceed 1024 .\""
18583 msgstr ""
18584
18585 #. type: Plain text
18586 #: build/C/man7/mdoc.samples.7:2322
18587 msgid "E<.Em exceed 1024>."
18588 msgstr ""
18589
18590 #. type: It
18591 #: build/C/man7/mdoc.samples.7:2322
18592 #, no-wrap
18593 msgid "Li \".Em vide infra ) ) ,\""
18594 msgstr ""
18595
18596 #. type: Plain text
18597 #: build/C/man7/mdoc.samples.7:2324
18598 msgid "E<.Em vide infra>)),"
18599 msgstr ""
18600
18601 #. type: Plain text
18602 #: build/C/man7/mdoc.samples.7:2332
18603 msgid ""
18604 "The E<.Ql \\&.Em> macro is parsed and is callable.  It is an error to call "
18605 "E<.Ql \\&.Em> without arguments."
18606 msgstr ""
18607
18608 #. type: It
18609 #: build/C/man7/mdoc.samples.7:2332
18610 #, no-wrap
18611 msgid "\\&.Li"
18612 msgstr ""
18613
18614 #. type: Plain text
18615 #: build/C/man7/mdoc.samples.7:2338
18616 msgid ""
18617 "The E<.Ql \\&.Li> literal macro may be used for special characters, variable "
18618 "constants, anything which should be displayed as it would be typed."
18619 msgstr ""
18620
18621 #. type: Dl
18622 #: build/C/man7/mdoc.samples.7:2339
18623 #, no-wrap
18624 msgid "Usage: .Li argument ... \\*(Pu"
18625 msgstr ""
18626
18627 #. type: It
18628 #: build/C/man7/mdoc.samples.7:2341
18629 #, no-wrap
18630 msgid "Li \\&.Li \\een"
18631 msgstr ""
18632
18633 #. type: Plain text
18634 #: build/C/man7/mdoc.samples.7:2343
18635 msgid "E<.Li \\en>"
18636 msgstr ""
18637
18638 #. type: It
18639 #: build/C/man7/mdoc.samples.7:2343
18640 #, no-wrap
18641 msgid "Li \\&.Li M1 M2 M3\\ ;"
18642 msgstr ""
18643
18644 #. type: Plain text
18645 #: build/C/man7/mdoc.samples.7:2345
18646 msgid "E<.Li M1 M2 M3>;"
18647 msgstr ""
18648
18649 #. type: It
18650 #: build/C/man7/mdoc.samples.7:2345
18651 #, no-wrap
18652 msgid "Li \\&.Li cntrl-D\\ )\\ ,"
18653 msgstr ""
18654
18655 #. type: Plain text
18656 #: build/C/man7/mdoc.samples.7:2347
18657 msgid "E<.Li cntrl-D>),"
18658 msgstr ""
18659
18660 #. type: It
18661 #: build/C/man7/mdoc.samples.7:2347
18662 #, no-wrap
18663 msgid "Li \\&.Li 1024\\ ..."
18664 msgstr ""
18665
18666 #. type: Plain text
18667 #: build/C/man7/mdoc.samples.7:2349
18668 msgid "E<.Li 1024 ...>"
18669 msgstr ""
18670
18671 #. type: Plain text
18672 #: build/C/man7/mdoc.samples.7:2354
18673 msgid "The E<.Ql \\&.Li> macro is parsed and is callable."
18674 msgstr ""
18675
18676 #. type: It
18677 #: build/C/man7/mdoc.samples.7:2354
18678 #, no-wrap
18679 msgid "\\&.Sy"
18680 msgstr ""
18681
18682 #. type: Plain text
18683 #: build/C/man7/mdoc.samples.7:2357
18684 msgid ""
18685 "The symbolic emphasis macro is generally a boldface macro in either the "
18686 "symbolic sense or the traditional English usage."
18687 msgstr ""
18688
18689 #. type: Dl
18690 #: build/C/man7/mdoc.samples.7:2358
18691 #, no-wrap
18692 msgid "Usage: .Sy symbol ... \\*(Pu"
18693 msgstr ""
18694
18695 #. type: It
18696 #: build/C/man7/mdoc.samples.7:2360
18697 #, no-wrap
18698 msgid "Li \\&.Sy Important Notice"
18699 msgstr ""
18700
18701 #. type: Plain text
18702 #: build/C/man7/mdoc.samples.7:2362
18703 msgid "E<.Sy Important Notice>"
18704 msgstr ""
18705
18706 #. type: Plain text
18707 #: build/C/man7/mdoc.samples.7:2369
18708 msgid ""
18709 "The E<.Ql \\&.Sy> macro is parsed and is callable.  Arguments to E<.Ql "
18710 "\\&.Sy> may be quoted."
18711 msgstr ""
18712
18713 #. type: It
18714 #: build/C/man7/mdoc.samples.7:2370
18715 #, no-wrap
18716 msgid "Li \\&.Bf"
18717 msgstr ""
18718
18719 #. type: Plain text
18720 #: build/C/man7/mdoc.samples.7:2380
18721 msgid ""
18722 "Begin font mode.  The E<.Ql \\&.Bf> font mode must be ended with the E<.Ql "
18723 "\\&.Ef> macro.  Font modes may be nested within other font modes.  E<.Ql "
18724 "\\&.Bf> has the following syntax:"
18725 msgstr ""
18726
18727 #. type: Dl
18728 #: build/C/man7/mdoc.samples.7:2381
18729 #, no-wrap
18730 msgid ".Bf font-mode"
18731 msgstr ""
18732
18733 #. type: Plain text
18734 #: build/C/man7/mdoc.samples.7:2385
18735 msgid "The font-mode must be one of the following three types: E<.Ql \\&.Bf>."
18736 msgstr ""
18737
18738 #. type: It
18739 #: build/C/man7/mdoc.samples.7:2387
18740 #, no-wrap
18741 msgid "Sy \\&Em | Fl emphasis"
18742 msgstr ""
18743
18744 #. type: Plain text
18745 #: build/C/man7/mdoc.samples.7:2391
18746 msgid "Same as if the E<.Ql \\&.Em> macro was used for the entire block of text."
18747 msgstr ""
18748
18749 #. type: It
18750 #: build/C/man7/mdoc.samples.7:2391
18751 #, no-wrap
18752 msgid "Sy \\&Li | Fl literal"
18753 msgstr ""
18754
18755 #. type: Plain text
18756 #: build/C/man7/mdoc.samples.7:2395
18757 msgid "Same as if the E<.Ql \\&.Li> macro was used for the entire block of text."
18758 msgstr ""
18759
18760 #. type: It
18761 #: build/C/man7/mdoc.samples.7:2395
18762 #, no-wrap
18763 msgid "Sy \\&Sy | Fl symbolic"
18764 msgstr ""
18765
18766 #. type: Plain text
18767 #: build/C/man7/mdoc.samples.7:2399
18768 msgid "Same as if the E<.Ql \\&.Sy> macro was used for the entire block of text."
18769 msgstr ""
18770
18771 #. type: It
18772 #: build/C/man7/mdoc.samples.7:2400
18773 #, no-wrap
18774 msgid ".Ef"
18775 msgstr ""
18776
18777 #. type: Plain text
18778 #: build/C/man7/mdoc.samples.7:2402
18779 msgid "End font mode."
18780 msgstr ""
18781
18782 #. type: Ss
18783 #: build/C/man7/mdoc.samples.7:2403
18784 #, no-wrap
18785 msgid "Tagged Lists and Columns"
18786 msgstr ""
18787
18788 #. type: Plain text
18789 #: build/C/man7/mdoc.samples.7:2417
18790 msgid ""
18791 "There are several types of lists which may be initiated with the E<.Ql "
18792 "\".Bl\"> begin-list macro.  Items within the list are specified with the "
18793 "E<.Ql \".It\"> item macro and each list must end with the E<.Ql \".El\"> "
18794 "macro.  Lists may be nested within themselves and within displays.  Columns "
18795 "may be used inside of lists, but lists are unproven inside of columns."
18796 msgstr ""
18797
18798 #. type: Plain text
18799 #: build/C/man7/mdoc.samples.7:2432
18800 msgid ""
18801 "In addition, several list attributes may be specified such as the width of a "
18802 "tag, the list offset, and compactness (blank lines between items allowed or "
18803 "disallowed).  Most of this document has been formatted with a tag style list "
18804 "E<.Pq Fl tag>.  For a change of pace, the list-type used to present the "
18805 "list-types is an over-hanging list E<.Pq Fl ohang>.  This type of list is "
18806 "quite popular with E<.Tn TeX> users, but might look a bit funny after having "
18807 "read many pages of tagged lists.  The following list types are accepted by "
18808 "E<.Ql \".Bl\">:"
18809 msgstr ""
18810
18811 #. type: It
18812 #: build/C/man7/mdoc.samples.7:2434
18813 #, no-wrap
18814 msgid "Fl bullet"
18815 msgstr ""
18816
18817 #. type: It
18818 #: build/C/man7/mdoc.samples.7:2435
18819 #, no-wrap
18820 msgid "Fl item"
18821 msgstr ""
18822
18823 #. type: It
18824 #: build/C/man7/mdoc.samples.7:2436
18825 #, no-wrap
18826 msgid "Fl enum"
18827 msgstr ""
18828
18829 #. type: Plain text
18830 #: build/C/man7/mdoc.samples.7:2446
18831 msgid ""
18832 "These three are the simplest types of lists.  Once the E<.Ql \".Bl\"> macro "
18833 "has been given, items in the list are merely indicated by a line consisting "
18834 "solely of the E<.Ql \".It\"> macro.  For example, the source text for a "
18835 "simple enumerated list would look like:"
18836 msgstr ""
18837
18838 #. type: Plain text
18839 #: build/C/man7/mdoc.samples.7:2455
18840 #, no-wrap
18841 msgid ""
18842 "\\&.Bl -enum -compact\n"
18843 "\\&.It\n"
18844 "\\&Item one goes here.\n"
18845 "\\&.It\n"
18846 "\\&And item two here.\n"
18847 "\\&.It\n"
18848 "\\&Lastly item three goes here.\n"
18849 "\\&.El\n"
18850 msgstr ""
18851
18852 #. type: Plain text
18853 #: build/C/man7/mdoc.samples.7:2459
18854 msgid "The results:"
18855 msgstr ""
18856
18857 #. type: Plain text
18858 #: build/C/man7/mdoc.samples.7:2463
18859 msgid "Item one goes here."
18860 msgstr ""
18861
18862 #. type: Plain text
18863 #: build/C/man7/mdoc.samples.7:2465
18864 msgid "And item two here."
18865 msgstr ""
18866
18867 #. type: Plain text
18868 #: build/C/man7/mdoc.samples.7:2467
18869 msgid "Lastly item three goes here."
18870 msgstr ""
18871
18872 #. type: Plain text
18873 #: build/C/man7/mdoc.samples.7:2470
18874 msgid "A simple bullet list construction:"
18875 msgstr ""
18876
18877 #. type: Plain text
18878 #: build/C/man7/mdoc.samples.7:2477
18879 #, no-wrap
18880 msgid ""
18881 "\\&.Bl -bullet -compact\n"
18882 "\\&.It\n"
18883 "\\&Bullet one goes here.\n"
18884 "\\&.It\n"
18885 "\\&Bullet two here.\n"
18886 "\\&.El\n"
18887 msgstr ""
18888
18889 #. type: Plain text
18890 #: build/C/man7/mdoc.samples.7:2483
18891 msgid "Bullet one goes here."
18892 msgstr ""
18893
18894 #. type: Plain text
18895 #: build/C/man7/mdoc.samples.7:2485
18896 msgid "Bullet two here."
18897 msgstr ""
18898
18899 #. type: It
18900 #: build/C/man7/mdoc.samples.7:2488
18901 #, no-wrap
18902 msgid "Fl tag"
18903 msgstr ""
18904
18905 #. type: It
18906 #: build/C/man7/mdoc.samples.7:2489
18907 #, no-wrap
18908 msgid "Fl diag"
18909 msgstr ""
18910
18911 #. type: It
18912 #: build/C/man7/mdoc.samples.7:2490
18913 #, no-wrap
18914 msgid "Fl hang"
18915 msgstr ""
18916
18917 #. type: It
18918 #: build/C/man7/mdoc.samples.7:2491
18919 #, no-wrap
18920 msgid "Fl ohang"
18921 msgstr ""
18922
18923 #. type: It
18924 #: build/C/man7/mdoc.samples.7:2492
18925 #, no-wrap
18926 msgid "Fl inset"
18927 msgstr ""
18928
18929 #. type: Plain text
18930 #: build/C/man7/mdoc.samples.7:2512
18931 msgid ""
18932 "These list-types collect arguments specified with the E<.Ql \\&.It> macro "
18933 "and create a label which may be E<.Em inset> into the forthcoming text, "
18934 "E<.Em hanged> from the forthcoming text, E<.Em overhanged> from above and "
18935 "not indented or E<.Em tagged>.  This list was constructed with the E<.Ql "
18936 "\\&Fl ohang> list-type.  The E<.Ql \\&.It> macro is parsed only for the "
18937 "inset, hang and tag list-types and is not callable.  Here is an example of "
18938 "inset labels:"
18939 msgstr ""
18940
18941 #. type: It
18942 #: build/C/man7/mdoc.samples.7:2514
18943 #, no-wrap
18944 msgid "Em Tag"
18945 msgstr ""
18946
18947 #. type: Plain text
18948 #: build/C/man7/mdoc.samples.7:2517
18949 msgid ""
18950 "The tagged list (also called a tagged paragraph) is the most common type of "
18951 "list used in the Berkeley manuals."
18952 msgstr ""
18953
18954 #. type: It
18955 #: build/C/man7/mdoc.samples.7:2517
18956 #, no-wrap
18957 msgid "Em Diag"
18958 msgstr ""
18959
18960 #. type: Plain text
18961 #: build/C/man7/mdoc.samples.7:2521
18962 msgid ""
18963 "Diag lists create section four diagnostic lists and are similar to inset "
18964 "lists except callable macros are ignored."
18965 msgstr ""
18966
18967 #. type: It
18968 #: build/C/man7/mdoc.samples.7:2521
18969 #, no-wrap
18970 msgid "Em Hang"
18971 msgstr ""
18972
18973 #. type: Plain text
18974 #: build/C/man7/mdoc.samples.7:2523
18975 msgid "Hanged labels are a matter of taste."
18976 msgstr ""
18977
18978 #. type: It
18979 #: build/C/man7/mdoc.samples.7:2523
18980 #, no-wrap
18981 msgid "Em Ohang"
18982 msgstr ""
18983
18984 #. type: Plain text
18985 #: build/C/man7/mdoc.samples.7:2525
18986 msgid "Overhanging labels are nice when space is constrained."
18987 msgstr ""
18988
18989 #. type: It
18990 #: build/C/man7/mdoc.samples.7:2525
18991 #, no-wrap
18992 msgid "Em Inset"
18993 msgstr ""
18994
18995 #. type: Plain text
18996 #: build/C/man7/mdoc.samples.7:2530
18997 msgid ""
18998 "Inset labels are useful for controlling blocks of paragraphs and are "
18999 "valuable for converting E<.Nm \\-mdoc> manuals to other formats."
19000 msgstr ""
19001
19002 #. type: Plain text
19003 #: build/C/man7/mdoc.samples.7:2533
19004 msgid "Here is the source text which produced the above example:"
19005 msgstr ""
19006
19007 #. type: Plain text
19008 #: build/C/man7/mdoc.samples.7:2552
19009 #, no-wrap
19010 msgid ""
19011 "\\&.Bl -inset -offset indent\n"
19012 "\\&.It Em Tag\n"
19013 "\\&The tagged list (also called a tagged paragraph) is the\n"
19014 "\\&most common type of list used in the Berkeley manuals.\n"
19015 "\\&.It Em Diag\n"
19016 "\\&Diag lists create section four diagnostic lists\n"
19017 "\\&and are similar to inset lists except callable\n"
19018 "\\&macros are ignored.\n"
19019 "\\&.It Em Hang\n"
19020 "\\&Hanged labels are a matter of taste.\n"
19021 "\\&.It Em Ohang\n"
19022 "\\&Overhanging labels are nice when space is constrained.\n"
19023 "\\&.It Em Inset\n"
19024 "\\&Inset labels are useful for controlling blocks of\n"
19025 "\\&paragraphs and are valuable for converting\n"
19026 "\\&.Nm \\-mdoc\n"
19027 "\\&manuals to other formats.\n"
19028 "\\&.El\n"
19029 msgstr ""
19030
19031 #. type: Plain text
19032 #: build/C/man7/mdoc.samples.7:2555
19033 msgid "Here is a hanged list with two items:"
19034 msgstr ""
19035
19036 #. type: It
19037 #: build/C/man7/mdoc.samples.7:2556
19038 #, no-wrap
19039 msgid "Em Hanged"
19040 msgstr ""
19041
19042 #. type: Plain text
19043 #: build/C/man7/mdoc.samples.7:2559
19044 msgid ""
19045 "labels appear similar to tagged lists when the label is smaller than the "
19046 "label width."
19047 msgstr ""
19048
19049 #. type: It
19050 #: build/C/man7/mdoc.samples.7:2559
19051 #, no-wrap
19052 msgid "Em Longer hanged list labels"
19053 msgstr ""
19054
19055 #. type: Plain text
19056 #: build/C/man7/mdoc.samples.7:2562
19057 msgid "blend in to the paragraph unlike tagged paragraph labels."
19058 msgstr ""
19059
19060 #. type: Plain text
19061 #: build/C/man7/mdoc.samples.7:2565
19062 msgid "And the unformatted text which created it:"
19063 msgstr ""
19064
19065 #. type: Plain text
19066 #: build/C/man7/mdoc.samples.7:2574
19067 #, no-wrap
19068 msgid ""
19069 "\\&.Bl -hang -offset indent\n"
19070 "\\&.It Em Hanged\n"
19071 "\\&labels appear similar to tagged lists when the\n"
19072 "\\&label is smaller than the label width.\n"
19073 "\\&.It Em Longer hanged list labels\n"
19074 "\\&blend in to the paragraph unlike\n"
19075 "\\&tagged paragraph labels.\n"
19076 "\\&.El\n"
19077 msgstr ""
19078
19079 #. type: Plain text
19080 #: build/C/man7/mdoc.samples.7:2578
19081 msgid ""
19082 "The tagged list which follows uses an optional width specifier to control "
19083 "the width of the tag."
19084 msgstr ""
19085
19086 #. type: It
19087 #: build/C/man7/mdoc.samples.7:2580
19088 #, no-wrap
19089 msgid "SL"
19090 msgstr ""
19091
19092 #. type: Plain text
19093 #: build/C/man7/mdoc.samples.7:2582
19094 msgid "sleep time of the process (seconds blocked)"
19095 msgstr ""
19096
19097 #. type: It
19098 #: build/C/man7/mdoc.samples.7:2582
19099 #, no-wrap
19100 msgid "PAGEIN"
19101 msgstr ""
19102
19103 #. type: Plain text
19104 #: build/C/man7/mdoc.samples.7:2587
19105 msgid ""
19106 "number of disk E<.Tn I/O Ns 's> resulting from references by the process to "
19107 "pages not loaded in core."
19108 msgstr ""
19109
19110 #. type: It
19111 #: build/C/man7/mdoc.samples.7:2587
19112 #, no-wrap
19113 msgid "UID"
19114 msgstr ""
19115
19116 #. type: Plain text
19117 #: build/C/man7/mdoc.samples.7:2589
19118 msgid "numerical user-id of process owner"
19119 msgstr ""
19120
19121 #. type: It
19122 #: build/C/man7/mdoc.samples.7:2589
19123 #, no-wrap
19124 msgid "PPID"
19125 msgstr ""
19126
19127 #. type: Plain text
19128 #: build/C/man7/mdoc.samples.7:2592
19129 msgid ""
19130 "numerical ID of parent of process process priority (nonpositive when in "
19131 "noninterruptible wait)"
19132 msgstr ""
19133
19134 #. type: Plain text
19135 #: build/C/man7/mdoc.samples.7:2595
19136 msgid "The raw text:"
19137 msgstr ""
19138
19139 #. type: Plain text
19140 #: build/C/man7/mdoc.samples.7:2610
19141 #, no-wrap
19142 msgid ""
19143 "\\&.Bl -tag -width \"PAGEIN\" -compact -offset indent\n"
19144 "\\&.It SL\n"
19145 "\\&sleep time of the process (seconds blocked)\n"
19146 "\\&.It PAGEIN\n"
19147 "\\&number of disk\n"
19148 "\\&.Tn I/O Ns 's\n"
19149 "\\&resulting from references\n"
19150 "\\&by the process to pages not loaded in core.\n"
19151 "\\&.It UID\n"
19152 "\\&numerical user ID of process owner\n"
19153 "\\&.It PPID\n"
19154 "\\&numerical ID of parent of process process priority\n"
19155 "\\&(nonpositive when in noninterruptible wait)\n"
19156 "\\&.El\n"
19157 msgstr ""
19158
19159 #. type: Plain text
19160 #: build/C/man7/mdoc.samples.7:2613
19161 msgid "Acceptable width specifiers:"
19162 msgstr ""
19163
19164 #. type: It
19165 #: build/C/man7/mdoc.samples.7:2614
19166 #, no-wrap
19167 msgid "Fl width Ar \\&Fl"
19168 msgstr ""
19169
19170 #. type: Plain text
19171 #: build/C/man7/mdoc.samples.7:2623
19172 msgid ""
19173 "sets the width to the default width for a flag.  All callable macros have a "
19174 "default width value.  The E<.Ql \\&.Fl>, value is presently set to ten "
19175 "constant width characters or about five sixth of an inch."
19176 msgstr ""
19177
19178 #. type: It
19179 #: build/C/man7/mdoc.samples.7:2623
19180 #, no-wrap
19181 msgid "Fl width Ar 24n"
19182 msgstr ""
19183
19184 #. type: Plain text
19185 #: build/C/man7/mdoc.samples.7:2629
19186 msgid ""
19187 "sets the width to 24 constant width characters or about two inches.  The "
19188 "E<.Ql n> is absolutely necessary for the scaling to work correctly."
19189 msgstr ""
19190
19191 #. type: It
19192 #: build/C/man7/mdoc.samples.7:2629
19193 #, no-wrap
19194 msgid "Fl width Ar ENAMETOOLONG"
19195 msgstr ""
19196
19197 #. type: Plain text
19198 #: build/C/man7/mdoc.samples.7:2632
19199 msgid "sets width to the constant width length of the string given."
19200 msgstr ""
19201
19202 #. type: It
19203 #: build/C/man7/mdoc.samples.7:2632
19204 #, no-wrap
19205 msgid "Fl width Ar \"\\*qint mkfifo\\*q\""
19206 msgstr ""
19207
19208 #. type: Plain text
19209 #: build/C/man7/mdoc.samples.7:2635
19210 msgid "again, the width is set to the constant width of the string given."
19211 msgstr ""
19212
19213 #. type: Plain text
19214 #: build/C/man7/mdoc.samples.7:2649
19215 msgid ""
19216 "If a width is not specified for the tag list type, the first time E<.Ql "
19217 "\\&.It> is invoked, an attempt is made to determine an appropriate width.  "
19218 "If the first argument to E<.Ql \".It\"> is a callable macro, the default "
19219 "width for that macro will be used as if the macro name had been supplied as "
19220 "the width.  However, if another item in the list is given with a different "
19221 "callable macro name, a new and nested list is assumed."
19222 msgstr ""
19223
19224 #. type: Sh
19225 #: build/C/man7/mdoc.samples.7:2649
19226 #, no-wrap
19227 msgid "PREDEFINED STRINGS"
19228 msgstr ""
19229
19230 #. type: Plain text
19231 #: build/C/man7/mdoc.samples.7:2661
19232 msgid ""
19233 "The following strings are predefined as may be used by preceding with the "
19234 "troff string interpreting sequence E<.Ql \\&\\e*(xx> where E<.Em xx> is the "
19235 "name of the defined string or as E<.Ql \\&\\e*x> where E<.Em x> is the name "
19236 "of the string.  The interpreting sequence may be used any where in the text."
19237 msgstr ""
19238
19239 #. type: It
19240 #: build/C/man7/mdoc.samples.7:2663
19241 #, no-wrap
19242 msgid "Sy \"String\tNroff\tTroff\""
19243 msgstr ""
19244
19245 #. type: It
19246 #: build/C/man7/mdoc.samples.7:2664
19247 #, no-wrap
19248 msgid "Li E<lt>= Ta \\&E<lt>\\&= Ta \\*(E<lt>="
19249 msgstr ""
19250
19251 #. type: It
19252 #: build/C/man7/mdoc.samples.7:2665
19253 #, no-wrap
19254 msgid "Li E<gt>= Ta \\&E<gt>\\&= Ta \\*(E<gt>="
19255 msgstr ""
19256
19257 #. type: It
19258 #: build/C/man7/mdoc.samples.7:2666
19259 #, no-wrap
19260 msgid "Li Rq Ta '' Ta \\*(Rq"
19261 msgstr ""
19262
19263 #. type: It
19264 #: build/C/man7/mdoc.samples.7:2667
19265 #, no-wrap
19266 msgid "Li Lq Ta `` Ta \\*(Lq"
19267 msgstr ""
19268
19269 #. type: It
19270 #: build/C/man7/mdoc.samples.7:2668
19271 #, no-wrap
19272 msgid "Li ua Ta ^ Ta \\*(ua"
19273 msgstr ""
19274
19275 #. type: It
19276 #: build/C/man7/mdoc.samples.7:2669
19277 #, no-wrap
19278 msgid "Li aa Ta ' Ta \\*(aa"
19279 msgstr ""
19280
19281 #. type: It
19282 #: build/C/man7/mdoc.samples.7:2670
19283 #, no-wrap
19284 msgid "Li ga Ta \\` Ta \\*(ga"
19285 msgstr ""
19286
19287 #.  .It Li "sL" Ta ` Ta \*(sL
19288 #.  .It Li "sR" Ta ' Ta \*(sR
19289 #. type: It
19290 #: build/C/man7/mdoc.samples.7:2673
19291 #, no-wrap
19292 msgid "Li q Ta \\(dq Ta \\*q"
19293 msgstr ""
19294
19295 #. type: It
19296 #: build/C/man7/mdoc.samples.7:2674
19297 #, no-wrap
19298 msgid "Li Pi Ta pi Ta \\*(Pi"
19299 msgstr ""
19300
19301 #. type: It
19302 #: build/C/man7/mdoc.samples.7:2675
19303 #, no-wrap
19304 msgid "Li Ne Ta != Ta \\*(Ne"
19305 msgstr ""
19306
19307 #. type: It
19308 #: build/C/man7/mdoc.samples.7:2676
19309 #, no-wrap
19310 msgid "Li Le Ta E<lt>= Ta \\*(Le"
19311 msgstr ""
19312
19313 #. type: It
19314 #: build/C/man7/mdoc.samples.7:2677
19315 #, no-wrap
19316 msgid "Li Ge Ta E<gt>= Ta \\*(Ge"
19317 msgstr ""
19318
19319 #. type: It
19320 #: build/C/man7/mdoc.samples.7:2678
19321 #, no-wrap
19322 msgid "Li Lt Ta E<lt> Ta \\*(Gt"
19323 msgstr ""
19324
19325 #. type: It
19326 #: build/C/man7/mdoc.samples.7:2679
19327 #, no-wrap
19328 msgid "Li Gt Ta E<gt> Ta \\*(Lt"
19329 msgstr ""
19330
19331 #. type: It
19332 #: build/C/man7/mdoc.samples.7:2680
19333 #, no-wrap
19334 msgid "Li Pm Ta +- Ta \\*(Pm"
19335 msgstr ""
19336
19337 #. type: It
19338 #: build/C/man7/mdoc.samples.7:2681
19339 #, no-wrap
19340 msgid "Li If Ta infinity Ta \\*(If"
19341 msgstr ""
19342
19343 #. type: It
19344 #: build/C/man7/mdoc.samples.7:2682
19345 #, no-wrap
19346 msgid "Li Na Ta I<NaN> Ta \\*(Na"
19347 msgstr ""
19348
19349 #. type: It
19350 #: build/C/man7/mdoc.samples.7:2683
19351 #, no-wrap
19352 msgid "Li Ba Ta \\&| Ta \\*(Ba"
19353 msgstr ""
19354
19355 #. type: Plain text
19356 #: build/C/man7/mdoc.samples.7:2692
19357 msgid ""
19358 "E<.Sy Note>: The string named E<.Ql q> should be written as E<.Ql \\e*q> "
19359 "since it is only one char."
19360 msgstr ""
19361
19362 #. type: Sh
19363 #: build/C/man7/mdoc.samples.7:2692
19364 #, no-wrap
19365 msgid "DIAGNOSTICS"
19366 msgstr ""
19367
19368 #. type: Plain text
19369 #: build/C/man7/mdoc.samples.7:2725
19370 msgid ""
19371 "The debugging facilities for E<.Nm \\-mdoc> are limited, but can help detect "
19372 "subtle errors such as the collision of an argument name with an internal "
19373 "register or macro name.  (A what?)  A register is an arithmetic storage "
19374 "class for E<.Xr troff> with a one or two character name.  All registers "
19375 "internal to E<.Nm \\-mdoc> for E<.Xr troff> and E<.Xr ditroff> are two "
19376 "characters and of the form E<lt>upper_caseE<gt>E<lt>lower_caseE<gt> such as "
19377 "E<.Ql \\&Ar>, E<lt>lower_caseE<gt>E<lt>upper_caseE<gt> as E<.Ql \\&aR> or "
19378 "E<lt>upper or lower letterE<gt>E<lt>digitE<gt> as E<.Ql \\&C\\&1>.  And "
19379 "adding to the muddle, E<.Xr troff> has its own internal registers all of "
19380 "which are either two lower case characters or a dot plus a letter or "
19381 "metacharacter character.  In one of the introduction examples, it was shown "
19382 "how to prevent the interpretation of a macro name with the escape sequence "
19383 "E<.Ql \\e&>.  This is sufficient for the internal register names also."
19384 msgstr ""
19385
19386 #.  Every callable macro name has a corresponding register
19387 #.  of the same name (<upper_case><lower_case>).
19388 #.  There are also specific registers which have
19389 #.  been used for stacks and arrays and are listed in the
19390 #.  .Sx Appendix .
19391 #.  .Bd -ragged -offset 4n
19392 #.  [A-Z][a-z]  registers corresponding to macro names (example ``Ar'')
19393 #.  [a-z][A-Z]  registers corresponding to macro names (example ``aR'')
19394 #.  C[0-9]              argument types (example C1)
19395 #.  O[0-9]              offset stack (displays)
19396 #.  h[0-9]              horizontal spacing stack (lists)
19397 #.  o[0-9]              offset (stack) (lists)
19398 #.  t[0-9]              tag stack (lists)
19399 #.  v[0-9]              vertical spacing stack (lists)
19400 #.  w[0-9]              width tag/label stack
19401 #.  .Ed
19402 #.  .Pp
19403 #. type: Plain text
19404 #: build/C/man7/mdoc.samples.7:2764
19405 msgid ""
19406 "If a nonescaped register name is given in the argument list of a request "
19407 "unpredictable behavior will occur.  In general, any time huge portions of "
19408 "text do not appear where expected in the output, or small strings such as "
19409 "list tags disappear, chances are there is a misunderstanding about an "
19410 "argument type in the argument list.  Your mother never intended for you to "
19411 "remember this evil stuff - so here is a way to find out whether or not your "
19412 "arguments are valid: The E<.Ql \\&.Db> (debug)  macro displays the "
19413 "interpretation of the argument list for most macros.  Macros such as the "
19414 "E<.Ql \\&.Pp> (paragraph)  macro do not contain debugging information.  All "
19415 "of the callable macros do, and it is strongly advised whenever in doubt, "
19416 "turn on the E<.Ql \\&.Db> macro."
19417 msgstr ""
19418
19419 #. type: Dl
19420 #: build/C/man7/mdoc.samples.7:2765
19421 #, no-wrap
19422 msgid "Usage: \\&.Db [on | off]"
19423 msgstr ""
19424
19425 #. type: Plain text
19426 #: build/C/man7/mdoc.samples.7:2774
19427 msgid ""
19428 "An example of a portion of text with the debug macro placed above and below "
19429 "an artificially created problem (a flag argument E<.Ql \\&aC> which should "
19430 "be E<.Ql \\e&aC> in order to work):"
19431 msgstr ""
19432
19433 #. type: Plain text
19434 #: build/C/man7/mdoc.samples.7:2778
19435 #, no-wrap
19436 msgid ""
19437 "\\&.Db on\n"
19438 "\\&.Op Fl aC Ar file )\n"
19439 "\\&.Db off\n"
19440 msgstr ""
19441
19442 #. type: Plain text
19443 #: build/C/man7/mdoc.samples.7:2781
19444 msgid "The resulting output:"
19445 msgstr ""
19446
19447 #. type: Plain text
19448 #: build/C/man7/mdoc.samples.7:2796
19449 #, no-wrap
19450 msgid ""
19451 "DEBUGGING ON\n"
19452 "DEBUG(argv) MACRO: `.Op'  Line #: 2\n"
19453 "\tArgc: 1  Argv: `Fl'  Length: 2\n"
19454 "\tSpace: `'  Class: Executable\n"
19455 "\tArgc: 2  Argv: `aC'  Length: 2\n"
19456 "\tSpace: `'  Class: Executable\n"
19457 "\tArgc: 3  Argv: `Ar'  Length: 2\n"
19458 "\tSpace: `'  Class: Executable\n"
19459 "\tArgc: 4  Argv: `file'  Length: 4\n"
19460 "\tSpace: ` '  Class: String\n"
19461 "\tArgc: 5  Argv: `)'  Length: 1\n"
19462 "\tSpace: ` '  Class: Closing Punctuation or suffix\n"
19463 "\tMACRO REQUEST: .Op Fl aC Ar file )\n"
19464 "DEBUGGING OFF\n"
19465 msgstr ""
19466
19467 #. type: Plain text
19468 #: build/C/man7/mdoc.samples.7:2823
19469 msgid ""
19470 "The first line of information tells the name of the calling macro, here "
19471 "E<.Ql \\&.Op>, and the line number it appears on.  If one or more files are "
19472 "involved (especially if text from another file is included) the line number "
19473 "may be bogus.  If there is only one file, it should be accurate.  The second "
19474 "line gives the argument count, the argument E<.Pq Ql \\&Fl> and its length.  "
19475 "If the length of an argument is two characters, the argument is tested to "
19476 "see if it is executable (unfortunately, any register which contains a "
19477 "nonzero value appears executable).  The third line gives the space allotted "
19478 "for a class, and the class type.  The problem here is the argument aC should "
19479 "not be executable.  The four types of classes are string, executable, "
19480 "closing punctuation and opening punctuation.  The last line shows the entire "
19481 "argument list as it was read.  In this next example, the offending E<.Ql "
19482 "\\&aC> is escaped:"
19483 msgstr ""
19484
19485 #. type: Plain text
19486 #: build/C/man7/mdoc.samples.7:2827
19487 #, no-wrap
19488 msgid ""
19489 "\\&.Db on\n"
19490 "\\&.Em An escaped \\e&aC\n"
19491 "\\&.Db off\n"
19492 msgstr ""
19493
19494 #. type: Plain text
19495 #: build/C/man7/mdoc.samples.7:2839
19496 #, no-wrap
19497 msgid ""
19498 "DEBUGGING ON\n"
19499 "DEBUG(fargv) MACRO: `.Em'  Line #: 2\n"
19500 "\tArgc: 1  Argv: `An'  Length: 2\n"
19501 "\tSpace: ` '  Class: String\n"
19502 "\tArgc: 2  Argv: `escaped'  Length: 7\n"
19503 "\tSpace: ` '  Class: String\n"
19504 "\tArgc: 3  Argv: `aC'  Length: 2\n"
19505 "\tSpace: ` '  Class: String\n"
19506 "\tMACRO REQUEST: .Em An escaped &aC\n"
19507 "DEBUGGING OFF\n"
19508 msgstr ""
19509
19510 #. type: Plain text
19511 #: build/C/man7/mdoc.samples.7:2849
19512 msgid ""
19513 "The argument E<.Ql \\e&aC> shows up with the same length of 2 as the E<.Ql "
19514 "\\e&> sequence produces a zero width, but a register named E<.Ql \\e&aC> was "
19515 "not found and the type classified as string."
19516 msgstr ""
19517
19518 #. type: Plain text
19519 #: build/C/man7/mdoc.samples.7:2851
19520 msgid "Other diagnostics consist of usage statements and are self explanatory."
19521 msgstr ""
19522
19523 #. type: Sh
19524 #: build/C/man7/mdoc.samples.7:2851
19525 #, no-wrap
19526 msgid "GROFF, TROFF AND NROFF"
19527 msgstr ""
19528
19529 #. type: Plain text
19530 #: build/C/man7/mdoc.samples.7:2856
19531 msgid ""
19532 "The E<.Nm \\-mdoc> package does not need compatibility mode with E<.Xr "
19533 "groff>."
19534 msgstr ""
19535
19536 #. type: Plain text
19537 #: build/C/man7/mdoc.samples.7:2874
19538 msgid ""
19539 "The package inhibits page breaks, and the headers and footers which normally "
19540 "occur at those breaks with E<.Xr nroff>, to make the manual more efficient "
19541 "for viewing on-line.  At the moment, E<.Xr groff> with E<.Fl T Ns Ar ascii> "
19542 "does eject the imaginary remainder of the page at end of file.  The "
19543 "inhibiting of the page breaks makes E<.Xr nroff Ns 'd> files unsuitable for "
19544 "hardcopy.  There is a register named E<.Ql \\&cR> which can be set to zero "
19545 "in the site dependent style file E<.Pa /usr/src/share/tmac/doc-nroff> to "
19546 "restore the old style behavior."
19547 msgstr ""
19548
19549 #. type: It
19550 #: build/C/man7/mdoc.samples.7:2876
19551 #, no-wrap
19552 msgid "Pa /usr/share/tmac/doc.tmac"
19553 msgstr ""
19554
19555 #. type: Plain text
19556 #: build/C/man7/mdoc.samples.7:2878
19557 msgid "manual macro package"
19558 msgstr ""
19559
19560 #. type: It
19561 #: build/C/man7/mdoc.samples.7:2878
19562 #, no-wrap
19563 msgid "Pa /usr/share/misc/mdoc.template"
19564 msgstr ""
19565
19566 #. type: Plain text
19567 #: build/C/man7/mdoc.samples.7:2880
19568 msgid "template for writing a man page"
19569 msgstr ""
19570
19571 #. type: It
19572 #: build/C/man7/mdoc.samples.7:2880
19573 #, no-wrap
19574 msgid "Pa /usr/share/examples/mdoc/*"
19575 msgstr ""
19576
19577 #. type: Plain text
19578 #: build/C/man7/mdoc.samples.7:2882
19579 msgid "several example man pages"
19580 msgstr ""
19581
19582 #. type: Plain text
19583 #: build/C/man7/mdoc.samples.7:2890
19584 msgid ""
19585 "Undesirable hyphenation on the dash of a flag argument is not yet resolved, "
19586 "and causes occasional mishaps in the E<.Sx DESCRIPTION> section.  (line "
19587 "break on the hyphen)."
19588 msgstr ""
19589
19590 #. type: Plain text
19591 #: build/C/man7/mdoc.samples.7:2892
19592 msgid "Predefined strings are not declared in documentation."
19593 msgstr ""
19594
19595 #. type: Plain text
19596 #: build/C/man7/mdoc.samples.7:2894
19597 msgid "Section 3f has not been added to the header routines."
19598 msgstr ""
19599
19600 #. type: Plain text
19601 #: build/C/man7/mdoc.samples.7:2899
19602 msgid "E<.Ql \\&.Nm> font should be changed in E<.Sx NAME> section."
19603 msgstr ""
19604
19605 #. type: Plain text
19606 #: build/C/man7/mdoc.samples.7:2906
19607 msgid ""
19608 "E<.Ql \\&.Fn> needs to have a check to prevent splitting up if the line "
19609 "length is too short.  Occasionally it separates the last parenthesis, and "
19610 "sometimes looks ridiculous if a line is in fill mode."
19611 msgstr ""
19612
19613 #. type: Plain text
19614 #: build/C/man7/mdoc.samples.7:2911
19615 msgid ""
19616 "The method used to prevent header and footer page breaks (other than the "
19617 "initial header and footer) when using nroff occasionally places an unsightly "
19618 "partially filled line (blank)  at the would be bottom of the page."
19619 msgstr ""
19620
19621 #.  Note what happens if the parameter list overlaps a newline
19622 #.  boundary.
19623 #.  to make sure a line boundary is crossed:
19624 #.  .Bd -literal
19625 #.  \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
19626 #.  .Ed
19627 #.  .Pp
19628 #.  produces, nudge nudge,
19629 #.  .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
19630 #.  .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
19631 #.  nudge
19632 #.  .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
19633 #.  .Pp
19634 #.  If double quotes are used, for example:
19635 #.  .Bd -literal
19636 #.  \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
19637 #.  .Ed
19638 #.  .Pp
19639 #.  produces, nudge nudge,
19640 #.  .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
19641 #.  nudge
19642 #.  .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
19643 #.  nudge
19644 #.  .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
19645 #.  .Pp
19646 #.  Not a pretty sight...
19647 #.  In a paragraph, a long parameter containing unpaddable spaces as
19648 #.  in the former example will cause
19649 #.  .Xr troff
19650 #.  to break the line and spread
19651 #.  the remaining words out.
19652 #.  The latter example will adjust nicely to
19653 #.  justified margins, but may break in between an argument and its
19654 #.  declaration.
19655 #.  In
19656 #.  .Xr nroff
19657 #.  the right margin adjustment is normally ragged and the problem is
19658 #.  not as severe.
19659 #. type: Plain text
19660 #: build/C/man7/mdoc.samples.7:2952
19661 msgid ""
19662 "The list and display macros to not do any keeps and certainly should be able "
19663 "to."
19664 msgstr ""
19665
19666 #. type: Plain text
19667 #: build/C/man7/mdoc.samples.7:2957
19668 msgid "E<.Xr man 1>, E<.Xr troff 1>, E<.Xr groff_mdoc 7>, E<.Xr mdoc 7>"
19669 msgstr ""