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.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2013-03-26 16:48+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"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man7/feature_test_macros.7:25
22 msgid "FEATURE_TEST_MACROS"
26 #: build/C/man7/feature_test_macros.7:25 build/C/man7/libc.7:26 build/C/man7/man.7:34 build/C/man7/standards.7:26 build/C/man7/units.7:26
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
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
40 msgid "Linux Programmer's Manual"
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
50 #: build/C/man7/feature_test_macros.7:28
51 msgid "feature_test_macros - feature test macros"
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
61 #: build/C/man7/feature_test_macros.7:31
63 msgid "B<#include E<lt>features.hE<gt>>\n"
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
73 #: build/C/man7/feature_test_macros.7:35
75 "Feature test macros allow the programmer to control the definitions that are "
76 "exposed by system header files when a program is compiled."
80 #: build/C/man7/feature_test_macros.7:43
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."
89 #: build/C/man7/feature_test_macros.7:52
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."
99 #: build/C/man7/feature_test_macros.7:52
101 msgid "Specification of feature test macro requirements in manual pages"
105 #: build/C/man7/feature_test_macros.7:58
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):"
113 #: build/C/man7/feature_test_macros.7:61
114 msgid "B<#include E<lt>unistd.hE<gt>>"
118 #: build/C/man7/feature_test_macros.7:63
119 msgid "B<int acct(const char *>I<filename>B<);>"
123 #: build/C/man7/feature_test_macros.7:68
126 "Feature Test Macro Requirements for glibc (see\n"
127 "B<feature_test_macros>(7)):\n"
131 #: build/C/man7/feature_test_macros.7:73
132 msgid "B<acct>(): _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE\\ E<lt>\\ 500)"
136 #: build/C/man7/feature_test_macros.7:81
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:"
144 #: build/C/man7/feature_test_macros.7:86
147 "#define _BSD_SOURCE\n"
148 "#define _XOPEN_SOURCE /* or any value E<lt> 500 */\n"
152 #: build/C/man7/feature_test_macros.7:91
154 "Alternatively, equivalent definitions can be included in the compilation "
159 #: build/C/man7/feature_test_macros.7:96
163 "cc -D_XOPEN_SOURCE # Or any value E<lt> 500\n"
167 #: build/C/man7/feature_test_macros.7:104
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."
175 #: build/C/man7/feature_test_macros.7:108
177 "In a few cases, manual pages use a shorthand for expressing the feature test "
178 "macro requirements (this example from B<readahead>(2)):"
182 #: build/C/man7/feature_test_macros.7:113
185 "B<#define _GNU_SOURCE>\n"
186 "B<#include E<lt>fcntl.hE<gt>>\n"
190 #: build/C/man7/feature_test_macros.7:115
193 "B<ssize_t readahead(int >I<fd>B<, off64_t *>I<offset>B<, size_t "
198 #: build/C/man7/feature_test_macros.7:121
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 "
206 #: build/C/man7/feature_test_macros.7:121
208 msgid "Feature test macros understood by glibc"
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.
215 #: build/C/man7/feature_test_macros.7:127
217 "The following paragraphs explain how feature test macros are handled in "
218 "Linux glibc 2.I<x>, I<x> E<gt> 0."
222 #: build/C/man7/feature_test_macros.7:129
223 msgid "Linux glibc understands the following feature test macros:"
227 #: build/C/man7/feature_test_macros.7:129
229 msgid "B<__STRICT_ANSI__>"
233 #: build/C/man7/feature_test_macros.7:139
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."
240 #: build/C/man7/feature_test_macros.7:139
242 msgid "B<_POSIX_C_SOURCE>"
246 #: build/C/man7/feature_test_macros.7:142 build/C/man7/feature_test_macros.7:173
247 msgid "Defining this macro causes header files to expose definitions as follows:"
251 #: build/C/man7/feature_test_macros.7:143 build/C/man7/feature_test_macros.7:146 build/C/man7/feature_test_macros.7:149 build/C/man7/feature_test_macros.7:153 build/C/man7/feature_test_macros.7:156 build/C/man7/feature_test_macros.7:160 build/C/man7/feature_test_macros.7:174 build/C/man7/feature_test_macros.7:177 build/C/man7/feature_test_macros.7:180 build/C/man7/feature_test_macros.7:184 build/C/man7/feature_test_macros.7:409 build/C/man7/feature_test_macros.7:414 build/C/man7/feature_test_macros.7:420 build/C/man7/feature_test_macros.7:425 build/C/man7/feature_test_macros.7:431 build/C/man7/feature_test_macros.7:436 build/C/man5/proc.5:2422 build/C/man5/proc.5:2424 build/C/man5/proc.5:2426 build/C/man5/proc.5:2429
257 #: build/C/man7/feature_test_macros.7:146
258 msgid "The value 1 exposes definitions conforming to POSIX.1-1990 and ISO C (1990)."
262 #: build/C/man7/feature_test_macros.7:149
263 msgid "The value 2 or greater additionally exposes definitions for POSIX.2-1992."
266 #. 199506L functionality is only available since glibc 2.1
268 #: build/C/man7/feature_test_macros.7:153
270 "The value 199309L or greater additionally exposes definitions for POSIX.1b "
271 "(real-time extensions)."
275 #: build/C/man7/feature_test_macros.7:156
277 "The value 199506L or greater additionally exposes definitions for POSIX.1c "
282 #: build/C/man7/feature_test_macros.7:160
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 "
290 #: build/C/man7/feature_test_macros.7:164
292 "(Since glibc 2.10) The value 200809L or greater exposes definitions "
293 "corresponding to the POSIX.1-2008 base specification (excluding the XSI "
298 #: build/C/man7/feature_test_macros.7:165
300 msgid "B<_POSIX_SOURCE>"
304 #: build/C/man7/feature_test_macros.7:170
306 "Defining this obsolete macro with any value is equivalent to defining "
307 "B<_POSIX_C_SOURCE> with the value 1."
311 #: build/C/man7/feature_test_macros.7:170
313 msgid "B<_XOPEN_SOURCE>"
317 #: build/C/man7/feature_test_macros.7:177
319 "Defining with any value exposes definitions conforming to POSIX.1, POSIX.2, "
324 #: build/C/man7/feature_test_macros.7:180
326 "The value 500 or greater additionally exposes definitions for SUSv2 (UNIX "
331 #: build/C/man7/feature_test_macros.7:184
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."
339 #: build/C/man7/feature_test_macros.7:188
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 "
347 #: build/C/man7/feature_test_macros.7:189
349 msgid "B<_XOPEN_SOURCE_EXTENDED>"
353 #: build/C/man7/feature_test_macros.7:198
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."
362 #: build/C/man7/feature_test_macros.7:198
364 msgid "B<_ISOC95_SOURCE>"
368 #: build/C/man7/feature_test_macros.7:208
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>)."
378 #: build/C/man7/feature_test_macros.7:208
380 msgid "B<_ISOC99_SOURCE>"
384 #: build/C/man7/feature_test_macros.7:217
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."
394 #: build/C/man7/feature_test_macros.7:217
396 msgid "B<_ISOC11_SOURCE>"
400 #: build/C/man7/feature_test_macros.7:221
402 "Exposes declarations consistent with the ISO C11 standard. This macro is "
403 "recognized since glibc 2.16."
407 #: build/C/man7/feature_test_macros.7:221
409 msgid "B<_LARGEFILE64_SOURCE>"
413 #: build/C/man7/feature_test_macros.7:242
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."
425 #: build/C/man7/feature_test_macros.7:242
427 msgid "B<_FILE_OFFSET_BITS>"
431 #: build/C/man7/feature_test_macros.7:254
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 file system "
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 "
444 #: build/C/man7/feature_test_macros.7:254
446 msgid "B<_BSD_SOURCE>"
450 #: build/C/man7/feature_test_macros.7:268
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."
461 #: build/C/man7/feature_test_macros.7:268
463 msgid "B<_SVID_SOURCE>"
467 #: build/C/man7/feature_test_macros.7:274
469 "Defining this macro with any value causes header files to expose System "
470 "V-derived definitions. (SVID == System V Interface Definition; see "
475 #: build/C/man7/feature_test_macros.7:274
477 msgid "B<_ATFILE_SOURCE> (since glibc 2.4)"
481 #: build/C/man7/feature_test_macros.7:283
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."
490 #: build/C/man7/feature_test_macros.7:283
492 msgid "B<_GNU_SOURCE>"
496 #: build/C/man7/feature_test_macros.7:305
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 "
510 #: build/C/man7/feature_test_macros.7:305
512 msgid "B<_REENTRANT>"
516 #: build/C/man7/feature_test_macros.7:311
518 "Defining this macro exposes definitions of certain reentrant functions. For "
519 "multithreaded programs, use I<cc\\ -pthread> instead."
523 #: build/C/man7/feature_test_macros.7:311
525 msgid "B<_THREAD_SAFE>"
529 #: build/C/man7/feature_test_macros.7:316
531 "Synonym for B<_REENTRANT>, provided for compatibility with some other "
536 #: build/C/man7/feature_test_macros.7:316
538 msgid "B<_FORTIFY_SOURCE> (since glibc 2.3.4)"
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
548 #: build/C/man7/feature_test_macros.7:362
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 "
568 #: build/C/man7/feature_test_macros.7:362
570 msgid "Default definitions, implicit definitions, and combining definitions"
574 #: build/C/man7/feature_test_macros.7:374
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 "
584 #: build/C/man7/feature_test_macros.7:390
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."
593 #: build/C/man7/feature_test_macros.7:401
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"
601 #: build/C/man7/feature_test_macros.7:402 build/C/man7/feature_test_macros.7:405 build/C/man7/man-pages.7:516 build/C/man7/man-pages.7:519 build/C/man7/man-pages.7:526 build/C/man7/man-pages.7:530 build/C/man7/man-pages.7:534 build/C/man7/man-pages.7:538 build/C/man7/man-pages.7:544 build/C/man5/proc.5:603 build/C/man5/proc.5:607 build/C/man5/proc.5:610 build/C/man5/proc.5:612 build/C/man5/proc.5:615 build/C/man5/proc.5:1095 build/C/man5/proc.5:1098 build/C/man5/proc.5:1110 build/C/man5/proc.5:1113 build/C/man5/proc.5:1117 build/C/man5/proc.5:1120 build/C/man5/proc.5:1123 build/C/man5/proc.5:1126 build/C/man5/proc.5:1129 build/C/man5/proc.5:1132 build/C/man5/proc.5:1135 build/C/man5/proc.5:1138 build/C/man5/proc.5:1142 build/C/man5/proc.5:1145 build/C/man5/proc.5:1148 build/C/man5/proc.5:1151 build/C/man5/proc.5:1154 build/C/man5/proc.5:1157 build/C/man5/proc.5:1160 build/C/man5/proc.5:1171 build/C/man5/proc.5:1177 build/C/man5/proc.5:1181 build/C/man5/proc.5:1186 build/C/man5/proc.5:1191 build/C/man5/proc.5:1196 build/C/man5/proc.5:1201 build/C/man5/proc.5:1206 build/C/man5/proc.5:1211 build/C/man5/proc.5:2200 build/C/man5/proc.5:2204 build/C/man5/proc.5:2207 build/C/man5/proc.5:2212 build/C/man5/proc.5:2409 build/C/man5/proc.5:2413 build/C/man5/proc.5:2419 build/C/man5/proc.5:2458 build/C/man5/proc.5:2464 build/C/man5/proc.5:2466
607 #: build/C/man7/feature_test_macros.7:405
608 msgid "B<_POSIX_SOURCE> is defined with the value 1; and"
612 #: build/C/man7/feature_test_macros.7:408
613 msgid "B<_POSIX_C_SOURCE> is defined with one of the following values:"
617 #: build/C/man7/feature_test_macros.7:414
618 msgid "2, if B<XOPEN_SOURCE> is defined with a value less than 500;"
622 #: build/C/man7/feature_test_macros.7:420
624 "199506L, if B<XOPEN_SOURCE> is defined with a value greater than or equal to "
625 "500 and less than 600; or"
629 #: build/C/man7/feature_test_macros.7:425
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."
636 #: build/C/man7/feature_test_macros.7:431
638 "(Since glibc 2.10) 200809L, if B<XOPEN_SOURCE> is defined with a value "
639 "greater than or equal to 700."
643 #: build/C/man7/feature_test_macros.7:436
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 "
651 #: build/C/man7/feature_test_macros.7:445
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."
659 #: build/C/man7/feature_test_macros.7:449
660 msgid "Multiple macros can be defined; the results are additive."
664 #: build/C/man7/feature_test_macros.7:449 build/C/man2/intro.2:70 build/C/man3/intro.3:87 build/C/man7/suffixes.7:277
666 msgid "CONFORMING TO"
670 #: build/C/man7/feature_test_macros.7:457
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 "
678 #: build/C/man7/feature_test_macros.7:461
680 "B<_FILE_OFFSET_BITS> is not specified by any standard, but is employed on "
681 "some other implementations."
685 #: build/C/man7/feature_test_macros.7:471
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 "
693 #: build/C/man7/feature_test_macros.7:471 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:478 build/C/man5/proc.5:3243 build/C/man2/unimplemented.2:40
699 #: build/C/man7/feature_test_macros.7:478
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 "
709 #: build/C/man7/feature_test_macros.7:488
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."
720 #: build/C/man7/feature_test_macros.7:488 build/C/man7/man-pages.7:564
726 #: build/C/man7/feature_test_macros.7:494
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:"
735 #: build/C/man7/feature_test_macros.7:521
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"
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"
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"
765 #: build/C/man7/feature_test_macros.7:523
767 msgid "Program source"
771 #: build/C/man7/feature_test_macros.7:527
773 msgid "/* ftm.c */\n"
777 #: build/C/man7/feature_test_macros.7:531
780 "#include E<lt>stdio.hE<gt>\n"
781 "#include E<lt>unistd.hE<gt>\n"
782 "#include E<lt>stdlib.hE<gt>\n"
786 #: build/C/man7/feature_test_macros.7:538
790 "main(int argc, char *argv[])\n"
792 "#ifdef _POSIX_SOURCE\n"
793 " printf(\"_POSIX_SOURCE defined\\en\");\n"
798 #: build/C/man7/feature_test_macros.7:542
801 "#ifdef _POSIX_C_SOURCE\n"
802 " printf(\"_POSIX_C_SOURCE defined: %ldL\\en\", (long) _POSIX_C_SOURCE);\n"
807 #: build/C/man7/feature_test_macros.7:546
810 "#ifdef _ISOC99_SOURCE\n"
811 " printf(\"_ISOC99_SOURCE defined\\en\");\n"
816 #: build/C/man7/feature_test_macros.7:550
819 "#ifdef _XOPEN_SOURCE\n"
820 " printf(\"_XOPEN_SOURCE defined: %d\\en\", _XOPEN_SOURCE);\n"
825 #: build/C/man7/feature_test_macros.7:554
828 "#ifdef _XOPEN_SOURCE_EXTENDED\n"
829 " printf(\"_XOPEN_SOURCE_EXTENDED defined\\en\");\n"
834 #: build/C/man7/feature_test_macros.7:558
837 "#ifdef _LARGEFILE64_SOURCE\n"
838 " printf(\"_LARGEFILE64_SOURCE defined\\en\");\n"
843 #: build/C/man7/feature_test_macros.7:562
846 "#ifdef _FILE_OFFSET_BITS\n"
847 " printf(\"_FILE_OFFSET_BITS defined: %d\\en\", _FILE_OFFSET_BITS);\n"
852 #: build/C/man7/feature_test_macros.7:566
855 "#ifdef _BSD_SOURCE\n"
856 " printf(\"_BSD_SOURCE defined\\en\");\n"
861 #: build/C/man7/feature_test_macros.7:570
864 "#ifdef _SVID_SOURCE\n"
865 " printf(\"_SVID_SOURCE defined\\en\");\n"
870 #: build/C/man7/feature_test_macros.7:574
873 "#ifdef _ATFILE_SOURCE\n"
874 " printf(\"_ATFILE_SOURCE defined\\en\");\n"
879 #: build/C/man7/feature_test_macros.7:578
882 "#ifdef _GNU_SOURCE\n"
883 " printf(\"_GNU_SOURCE defined\\en\");\n"
888 #: build/C/man7/feature_test_macros.7:582
891 "#ifdef _REENTRANT\n"
892 " printf(\"_REENTRANT defined\\en\");\n"
897 #: build/C/man7/feature_test_macros.7:586
900 "#ifdef _THREAD_SAFE\n"
901 " printf(\"_THREAD_SAFE defined\\en\");\n"
906 #: build/C/man7/feature_test_macros.7:590
909 "#ifdef _FORTIFY_SOURCE\n"
910 " printf(\"_FORTIFY_SOURCE defined\\en\");\n"
915 #: build/C/man7/feature_test_macros.7:593
918 " exit(EXIT_SUCCESS);\n"
923 #: build/C/man7/feature_test_macros.7:594 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:571 build/C/man7/man.7:559 build/C/man7/mdoc.7:428 build/C/man7/posixoptions.7:854 build/C/man5/proc.5:3256 build/C/man7/standards.7:261 build/C/man7/suffixes.7:281 build/C/man2/unimplemented.2:64 build/C/man7/mdoc.samples.7:2952
929 #: build/C/man7/feature_test_macros.7:597
930 msgid "B<libc>(7), B<standards>(7)"
933 #. But beware: the info libc document is out of date (Jul 07, mtk)
935 #: build/C/man7/feature_test_macros.7:601
936 msgid "The section \"Feature Test Macros\" under I<info libc>."
940 #: build/C/man7/feature_test_macros.7:603
941 msgid "I</usr/include/features.h>"
945 #: build/C/man7/feature_test_macros.7:603 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:578 build/C/man7/man.7:571 build/C/man7/mdoc.7:433 build/C/man7/operator.7:65 build/C/man7/posixoptions.7:857 build/C/man5/proc.5:3286 build/C/man7/standards.7:265 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
951 #: build/C/man7/feature_test_macros.7:610 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:585 build/C/man7/man.7:578 build/C/man7/operator.7:72 build/C/man7/posixoptions.7:864 build/C/man5/proc.5:3293 build/C/man7/standards.7:272 build/C/man7/suffixes.7:291 build/C/man3/undocumented.3:190 build/C/man2/unimplemented.2:73 build/C/man7/units.7:137
953 "This page is part of release 3.50 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/."
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
965 #: build/C/man1/intro.1:28
971 #: build/C/man1/intro.1:28 build/C/man7/mailaddr.7:27
973 msgid "Linux User's Manual"
977 #: build/C/man1/intro.1:31
978 msgid "intro - introduction to user commands"
982 #: build/C/man1/intro.1:35
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."
990 #: build/C/man1/intro.1:48
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."
1003 #: build/C/man1/intro.1:52
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)."
1011 #: build/C/man1/intro.1:62
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."
1022 #: build/C/man1/intro.1:62
1028 #: build/C/man1/intro.1:76
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)."
1038 #: build/C/man1/intro.1:76
1044 #: build/C/man1/intro.1:91
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)."
1053 #: build/C/man1/intro.1:93
1054 msgid "A session might go like"
1058 #: build/C/man1/intro.1:108
1061 "B<knuth login: >I<aeb>\n"
1062 "B<Password: >I<********>\n"
1064 "Tue Aug 6 23:50:44 CEST 2002\n"
1067 "Su Mo Tu We Th Fr Sa\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"
1076 #: build/C/man1/intro.1:135
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"
1086 "maja 0501-1136285\n"
1087 "peter 0136-7399214\n"
1088 "B<% >I<cp tel tel2>\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"
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"
1102 "B<% >I<grep maja tel2>\n"
1103 "maja 0501-1136285\n"
1108 #: build/C/man1/intro.1:147
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 "
1119 #: build/C/man1/intro.1:153
1121 "We see that there are commands I<date> (that gives date and time), and "
1122 "I<cal> (that gives a calendar)."
1126 #: build/C/man1/intro.1:169
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>."
1138 #: build/C/man1/intro.1:176
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.)"
1146 #: build/C/man1/intro.1:183
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."
1153 #: build/C/man1/intro.1:188
1155 "The command I<diff> lists the differences between two files. Here there was "
1156 "no output because there were no differences."
1160 #: build/C/man1/intro.1:194
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."
1167 #: build/C/man1/intro.1:199
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."
1174 #: build/C/man1/intro.1:199
1176 msgid "Pathnames and the current directory"
1180 #: build/C/man1/intro.1:211
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 only giving the last component. "
1187 "That is why \"/home/aeb/tel\" can be abbreviated to \"tel\" when the current "
1188 "directory is \"/home/aeb\"."
1192 #: build/C/man1/intro.1:215
1193 msgid "The command I<pwd> prints the current directory."
1197 #: build/C/man1/intro.1:220
1199 "The command I<cd> changes the current directory. Try \"cd /\" and \"pwd\" "
1200 "and \"cd\" and \"pwd\"."
1204 #: build/C/man1/intro.1:220
1210 #: build/C/man1/intro.1:224
1211 msgid "The command I<mkdir> makes a new directory."
1215 #: build/C/man1/intro.1:228
1217 "The command I<rmdir> removes a directory if it is empty, and complains "
1222 #: build/C/man1/intro.1:240
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)."
1233 #: build/C/man1/intro.1:240
1235 msgid "Disks and filesystems"
1239 #: build/C/man1/intro.1:251
1241 "The command I<mount> will attach the file system found on some disk (or "
1242 "floppy, or CDROM or so) to the big file system hierarchy. And I<umount> "
1243 "detaches it again. The command I<df> will tell you how much of your disk is "
1248 #: build/C/man1/intro.1:251
1254 #: build/C/man1/intro.1:269
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."
1266 #: build/C/man1/intro.1:269
1268 msgid "Getting information"
1272 #: build/C/man1/intro.1:282
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."
1283 #: build/C/man1/intro.1:290
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."
1292 #: build/C/man1/intro.1:294
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\"."
1299 #. Actual examples? Separate section for each of cat, cp, ...?
1300 #. gzip, bzip2, tar, rpm
1302 #: build/C/man1/intro.1:302
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."
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)"
1314 #: build/C/man2/intro.2:29 build/C/man3/intro.3:26
1320 #: build/C/man2/intro.2:32
1321 msgid "intro - introduction to system calls"
1325 #: build/C/man2/intro.2:42
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."
1336 #: build/C/man2/intro.2:45
1337 msgid "For a list of the Linux system calls, see B<syscalls>(2)."
1341 #: build/C/man2/intro.2:45 build/C/man2/unimplemented.2:35
1343 msgid "RETURN VALUE"
1347 #: build/C/man2/intro.2:54
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."
1357 #: build/C/man2/intro.2:59
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."
1365 #: build/C/man2/intro.2:70
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)."
1376 #: build/C/man2/intro.2:75 build/C/man3/intro.3:92
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)."
1383 #: build/C/man2/intro.2:76
1385 msgid "Calling directly"
1389 #: build/C/man2/intro.2:85
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)."
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
1401 msgid "Authors and copyright conditions"
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
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!"
1412 #: build/C/man2/intro.2:112
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)"
1422 #: build/C/man3/intro.3:29
1423 msgid "intro - introduction to library functions"
1427 #: build/C/man3/intro.3:33
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."
1435 #: build/C/man3/intro.3:50
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)."
1447 #. are various function groups which can be identified by a letter which
1448 #. is appended to the chapter number:
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
1455 #. These functions are parts of the
1457 #. library. They are contained in the standard C library libc.
1459 #. These functions are contained in the arithmetic library libm. They are
1462 #. FORTRAN compiler by default, but not by the
1464 #. C compiler, which needs the option \fI\-lm\fP.
1466 #. These functions are part of the FORTRAN library libF77. There are no
1467 #. special compiler flags needed to use these functions.
1469 #. Various special libraries. The manual pages documenting their functions
1470 #. specify the library names.
1472 #: build/C/man3/intro.3:87
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)."
1483 #: build/C/man3/intro.3:110
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)"
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
1497 #: build/C/man4/intro.4:29
1498 msgid "intro - introduction to special files"
1502 #: build/C/man4/intro.4:31
1503 msgid "Section 4 of the manual describes special files (devices)."
1507 #: build/C/man4/intro.4:31 build/C/man7/mailaddr.7:113 build/C/man7/man.7:474 build/C/man7/mdoc.7:411 build/C/man7/mdoc.samples.7:2874
1513 #: build/C/man4/intro.4:33
1514 msgid "/dev/* \\(em device files"
1518 #: build/C/man5/intro.5:30
1519 msgid "intro - introduction to file formats"
1523 #: build/C/man5/intro.5:33
1525 "Section 5 of the manual describes various file formats and protocols, and "
1526 "the corresponding C structures, if any."
1530 #: build/C/man6/intro.6:29
1531 msgid "intro - introduction to games"
1535 #: build/C/man6/intro.6:32
1537 "Section 6 of the manual describes all the games and funny little programs "
1538 "available on the system."
1542 #: build/C/man7/intro.7:31
1543 msgid "intro - introduction to overview, conventions, and miscellany section"
1547 #: build/C/man7/intro.7:36
1549 "Section 7 of the manual provides overviews on various topics, and describes "
1550 "conventions and protocols, character set standards, the standard file system "
1551 "layout, and miscellaneous other things."
1555 #: build/C/man8/intro.8:32
1556 msgid "intro - introduction to administration and privileged commands"
1560 #: build/C/man8/intro.8:37
1562 "Section 8 of the manual describes commands which either can be or are only "
1563 "used by the superuser, like system-administration commands, daemons, and "
1564 "hardware-related commands."
1568 #: build/C/man8/intro.8:44
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."
1576 #: build/C/man7/libc.7:26
1582 #: build/C/man7/libc.7:29
1583 msgid "libc - overview of standard C libraries on Linux"
1587 #: build/C/man7/libc.7:36
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."
1597 #: build/C/man7/libc.7:36
1603 #: build/C/man7/libc.7:54
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."
1617 #: build/C/man7/libc.7:61
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."
1626 #: build/C/man7/libc.7:61
1632 #: build/C/man7/libc.7:84
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>.)"
1651 #: build/C/man7/libc.7:84
1653 msgid "Other C libraries"
1657 #: build/C/man7/libc.7:99
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."
1669 #: build/C/man7/libc.7:104
1670 msgid "B<syscalls>(2), B<feature_test_macros>(7), B<man-pages>(7), B<standards>(7)"
1674 #: build/C/man7/mailaddr.7:27
1680 #: build/C/man7/mailaddr.7:27
1686 #: build/C/man7/mailaddr.7:31
1687 msgid "mailaddr - mail addressing description"
1691 #: build/C/man7/mailaddr.7:36
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"
1698 #: build/C/man7/mailaddr.7:38
1699 msgid " user@domain"
1703 #: build/C/man7/mailaddr.7:41
1705 "where a domain is a hierarchical dot-separated list of subdomains. These "
1706 "examples are valid forms of the same address:"
1710 #: build/C/man7/mailaddr.7:43
1711 msgid " eric@monet.berkeley.edu"
1715 #: build/C/man7/mailaddr.7:45
1716 msgid " Eric Allman E<lt>eric@monet.berkeley.eduE<gt>"
1720 #: build/C/man7/mailaddr.7:47
1721 msgid " eric@monet.berkeley.edu (Eric Allman)"
1725 #: build/C/man7/mailaddr.7:51
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."
1733 #: build/C/man7/mailaddr.7:59
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 "
1743 #: build/C/man7/mailaddr.7:61
1744 msgid " \"surname/admd=telemail/c=us/o=hp/prmd=hp\"@some.where"
1748 #: build/C/man7/mailaddr.7:63
1749 msgid " USER%SOMETHING@some.where"
1753 #: build/C/man7/mailaddr.7:65
1754 msgid " machine!machine!name@some.where"
1758 #: build/C/man7/mailaddr.7:67
1759 msgid " I2461572@some.where"
1763 #: build/C/man7/mailaddr.7:71
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.)"
1771 #: build/C/man7/mailaddr.7:77
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 \".\":"
1780 #: build/C/man7/mailaddr.7:79
1781 msgid " \"Eric P. Allman\" E<lt>eric@monet.berkeley.eduE<gt>"
1785 #: build/C/man7/mailaddr.7:79
1787 msgid "Abbreviation."
1791 #: build/C/man7/mailaddr.7:87
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 "
1800 #: build/C/man7/mailaddr.7:87
1802 msgid "Route-addrs."
1806 #: build/C/man7/mailaddr.7:94
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:"
1814 #: build/C/man7/mailaddr.7:96
1815 msgid " E<lt>@hosta,@hostb:user@hostcE<gt>"
1819 #: build/C/man7/mailaddr.7:101
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."
1827 #: build/C/man7/mailaddr.7:107
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."
1835 #: build/C/man7/mailaddr.7:107
1841 #: build/C/man7/mailaddr.7:113
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."
1849 #: build/C/man7/mailaddr.7:115
1850 msgid "I</etc/aliases>"
1854 #: build/C/man7/mailaddr.7:117
1855 msgid "I<~/.forward>"
1859 #: build/C/man7/mailaddr.7:125
1861 "B<binmail>(1), B<mail>(1), B<mconnect>(1), B<aliases>(5), B<forward>(5), "
1862 "B<sendmail>(8), B<vrfy>(8)"
1866 #: build/C/man7/mailaddr.7:127
1867 msgid "RFC\\ 2822 (Internet Message Format)"
1871 #: build/C/man7/man-pages.7:30
1877 #: build/C/man7/man-pages.7:30
1883 #: build/C/man7/man-pages.7:33
1884 msgid "man-pages - conventions for writing Linux man pages"
1888 #: build/C/man7/man-pages.7:37 build/C/man7/man.7:49
1889 msgid "B<man> [I<section>] I<title>"
1893 #: build/C/man7/man-pages.7:47
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."
1905 #: build/C/man7/man-pages.7:47
1907 msgid "Sections of the manual pages"
1911 #: build/C/man7/man-pages.7:50
1912 msgid "The manual Sections are traditionally defined as follows:"
1916 #: build/C/man7/man-pages.7:50
1918 msgid "B<1 Commands (Programs)>"
1922 #: build/C/man7/man-pages.7:54
1923 msgid "Those commands that can be executed by the user from within a shell."
1927 #: build/C/man7/man-pages.7:54
1929 msgid "B<2 System calls>"
1933 #: build/C/man7/man-pages.7:57
1934 msgid "Those functions which must be performed by the kernel."
1938 #: build/C/man7/man-pages.7:57
1940 msgid "B<3 Library calls>"
1944 #: build/C/man7/man-pages.7:62
1945 msgid "Most of the I<libc> functions."
1949 #: build/C/man7/man-pages.7:62
1951 msgid "B<4 Special files (devices)>"
1955 #: build/C/man7/man-pages.7:66
1956 msgid "Files found in I</dev>."
1960 #: build/C/man7/man-pages.7:66
1962 msgid "B<5 File formats and conventions>"
1966 #: build/C/man7/man-pages.7:71
1967 msgid "The format for I</etc/passwd> and other human-readable files."
1971 #: build/C/man7/man-pages.7:71
1977 #: build/C/man7/man-pages.7:73
1979 msgid "B<7 Overview, conventions, and miscellaneous>"
1983 #: build/C/man7/man-pages.7:77
1985 "Overviews of various topics, conventions and protocols, character set "
1986 "standards, and miscellaneous other things."
1990 #: build/C/man7/man-pages.7:77
1992 msgid "B<8 System management commands>"
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.
2004 #: build/C/man7/man-pages.7:90
2005 msgid "Commands like B<mount>(8), many of which only root can execute."
2009 #: build/C/man7/man-pages.7:90
2011 msgid "Macro package"
2015 #: build/C/man7/man-pages.7:97
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."
2023 #: build/C/man7/man-pages.7:97
2025 msgid "Conventions for source file layout"
2029 #: build/C/man7/man-pages.7:102
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."
2037 #: build/C/man7/man-pages.7:106
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 "
2045 #: build/C/man7/man-pages.7:106 build/C/man7/man.7:78
2051 #: build/C/man7/man-pages.7:108
2052 msgid "The first command in a man page should be a B<TH> command:"
2056 #: build/C/man7/man-pages.7:112 build/C/man7/man.7:85
2057 msgid "B<\\&.TH> I<title section date source manual>"
2061 #: build/C/man7/man-pages.7:115
2066 #: build/C/man7/man-pages.7:116
2072 #: build/C/man7/man-pages.7:120
2073 msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
2077 #: build/C/man7/man-pages.7:120
2083 #: build/C/man7/man-pages.7:124
2084 msgid "The section number in which the man page should be placed (e.g., I<7>)."
2088 #: build/C/man7/man-pages.7:124
2094 #: build/C/man7/man-pages.7:130
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."
2102 #: build/C/man7/man-pages.7:130
2108 #: build/C/man7/man-pages.7:133
2109 msgid "The source of the command, function, or system call."
2113 #: build/C/man7/man-pages.7:137
2115 "For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
2120 #: build/C/man7/man-pages.7:145
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.)"
2130 #: build/C/man7/man-pages.7:150
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."
2137 #: build/C/man7/man-pages.7:153
2138 msgid "For Section 4 pages, use I<Linux>."
2142 #: build/C/man7/man-pages.7:156
2143 msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
2147 #: build/C/man7/man-pages.7:156
2153 #: build/C/man7/man-pages.7:161
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>)."
2160 #: build/C/man7/man-pages.7:162
2162 msgid "Sections within a manual page"
2166 #: build/C/man7/man-pages.7:169
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."
2173 #. May 07: Few current man pages have an ERROR HANDLING section,,,
2175 #. May 07: Almost no current man pages have a USAGE section,,,
2178 #. May 07: Almost no current man pages have a SECURITY section,,,
2180 #. AUTHORS sections are discouraged
2181 #. AUTHORS [Discouraged]
2183 #: build/C/man7/man-pages.7:197
2188 "CONFIGURATION [Normally only in Section 4]\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"
2196 "VERSIONS [Normally only in Sections 2, 3]\n"
2205 #: build/C/man7/man-pages.7:208
2207 "I<Where a traditional heading would apply>, I<please use it>; this kind of "
2208 "consistency can make the information easier to understand. If you must, you "
2209 "can create your own headings if they make things easier to understand (this "
2210 "can be especially useful for pages in Sections 4 and 5). However, before "
2211 "doing this, consider whether you could use the traditional headings, with "
2212 "some subsections (I<.SS>) within those sections."
2216 #: build/C/man7/man-pages.7:211
2217 msgid "The following list elaborates on the contents of each of the above sections."
2221 #: build/C/man7/man-pages.7:211
2227 #: build/C/man7/man-pages.7:222
2229 "The name of this manual page. See B<man>(7) for important details of the "
2230 "line(s) that should follow the B<.SH NAME> command. All words in this line "
2231 "(including the word immediately following the \"\\e-\") should be in "
2232 "lowercase, except where English or technical terminological convention "
2233 "dictates otherwise."
2237 #: build/C/man7/man-pages.7:222
2243 #: build/C/man7/man-pages.7:234
2245 "briefly describes the command or function's interface. For commands, this "
2246 "shows the syntax of the command and its arguments (including options); "
2247 "boldface is used for as-is text and italics are used to indicate replaceable "
2248 "arguments. Brackets ([]) surround optional arguments, vertical bars (|) "
2249 "separate choices, and ellipses (\\&...) can be repeated. For functions, it "
2250 "shows any required data declarations or B<#include> directives, followed by "
2251 "the function declaration."
2254 #. FIXME . Say something here about compiler options
2256 #: build/C/man7/man-pages.7:240
2258 "Where a feature test macro must be defined in order to obtain the "
2259 "declaration of a function (or a variable) from a header file, then the "
2260 "SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
2264 #: build/C/man7/man-pages.7:240
2266 msgid "B<CONFIGURATION>"
2270 #: build/C/man7/man-pages.7:244
2272 "Configuration details for a device. This section normally only appears in "
2277 #: build/C/man7/man-pages.7:244
2279 msgid "B<DESCRIPTION>"
2282 #. If there is some kind of input grammar or complex set of subcommands,
2283 #. consider describing them in a separate
2285 #. section (and just place an overview in the
2289 #: build/C/man7/man-pages.7:261
2291 "gives an explanation of what the program, function, or format does. Discuss "
2292 "how it interacts with files and standard input, and what it produces on "
2293 "standard output or standard error. Omit internals and implementation "
2294 "details unless they're critical for understanding the interface. Describe "
2295 "the usual case; for information on command-line options of a program use the "
2296 "B<OPTIONS> section."
2300 #: build/C/man7/man-pages.7:261
2307 #. describes the grammar of any sublanguage this implements.
2309 #: build/C/man7/man-pages.7:269
2311 "describes the command-line options accepted by a program and how they change "
2312 "its behavior. This section should only appear for Section 1 and 8 manual "
2317 #: build/C/man7/man-pages.7:269
2319 msgid "B<EXIT STATUS>"
2323 #: build/C/man7/man-pages.7:274
2325 "lists the possible exit status values of a program and the conditions that "
2326 "cause these values to be returned. This section should only appear for "
2327 "Section 1 and 8 manual pages."
2331 #: build/C/man7/man-pages.7:274
2333 msgid "B<RETURN VALUE>"
2337 #: build/C/man7/man-pages.7:279
2339 "For Section 2 and 3 pages, this section gives a list of the values the "
2340 "library routine will return to the caller and the conditions that cause "
2341 "these values to be returned."
2345 #: build/C/man7/man-pages.7:279
2351 #: build/C/man7/man-pages.7:287
2353 "For Section 2 and 3 manual pages, this is a list of the values that may be "
2354 "placed in I<errno> in the event of an error, along with information about "
2355 "the cause of the errors. I<The error list should be in alphabetical order>."
2359 #: build/C/man7/man-pages.7:287
2361 msgid "B<ENVIRONMENT>"
2365 #: build/C/man7/man-pages.7:291
2367 "lists all environment variables that affect the program or function and how "
2372 #: build/C/man7/man-pages.7:291
2377 #. May 07: Almost no current man pages have a DIAGNOSTICS section;
2378 #. "RETURN VALUE" or "EXIT STATUS" is preferred.
2381 #. gives an overview of the most common error messages and how to
2383 #. You don't need to explain system error messages
2384 #. or fatal signals that can appear during execution of any program
2385 #. unless they're special in some way to the program.
2387 #. May 07: Almost no current man pages have a SECURITY section.
2390 #. discusses security issues and implications.
2391 #. Warn about configurations or environments that should be avoided,
2392 #. commands that may have security implications, and so on, especially
2393 #. if they aren't obvious.
2394 #. Discussing security in a separate section isn't necessary;
2395 #. if it's easier to understand, place security information in the
2396 #. other sections (such as the
2401 #. However, please include security information somewhere!
2403 #: build/C/man7/man-pages.7:328
2405 "lists the files the program or function uses, such as configuration files, "
2406 "startup files, and files the program directly operates on. Give the full "
2407 "pathname of these files, and use the installation process to modify the "
2408 "directory part to match user preferences. For many programs, the default "
2409 "installation location is in I</usr/local>, so your base manual page should "
2410 "use I</usr/local> as the base."
2414 #: build/C/man7/man-pages.7:328
2420 #: build/C/man7/man-pages.7:345
2422 "A brief summary of the Linux kernel or glibc versions where a system call or "
2423 "library function appeared, or changed significantly in its operation. As a "
2424 "general rule, every new interface should include a VERSIONS section in its "
2425 "manual page. Unfortunately, many existing manual pages don't include this "
2426 "information (since there was no policy to do so when they were written). "
2427 "Patches to remedy this are welcome, but, from the perspective of programmers "
2428 "writing new code, this information probably only matters in the case of "
2429 "kernel interfaces that have been added in Linux 2.4 or later (i.e., changes "
2430 "since kernel 2.2), and library functions that have been added to glibc since "
2431 "version 2.1 (i.e., changes since glibc 2.0)."
2435 #: build/C/man7/man-pages.7:350
2437 "The B<syscalls>(2) manual page also provides information about kernel "
2438 "versions in which various system calls first appeared."
2442 #: build/C/man7/man-pages.7:350
2444 msgid "B<CONFORMING TO>"
2448 #: build/C/man7/man-pages.7:364
2450 "describes any standards or conventions that relate to the function or "
2451 "command described by the manual page. For a page in Section 2 or 3, this "
2452 "section should note the POSIX.1 version(s) that the call conforms to, and "
2453 "also whether the call is specified in C99. (Don't worry too much about "
2454 "other standards like SUS, SUSv2, and XPG, or the SVr4 and 4.xBSD "
2455 "implementation standards, unless the call was specified in those standards, "
2456 "but isn't in the current version of POSIX.1.) (See B<standards>(7).)"
2460 #: build/C/man7/man-pages.7:368
2462 "If the call is not governed by any standards but commonly exists on other "
2463 "systems, note them. If the call is Linux-specific, note this."
2467 #: build/C/man7/man-pages.7:372
2469 "If this section consists of just a list of standards (which it commonly "
2470 "does), terminate the list with a period (\\(aq.\\(aq)."
2474 #: build/C/man7/man-pages.7:372
2480 #: build/C/man7/man-pages.7:377
2482 "provides miscellaneous notes. For Section 2 and 3 man pages you may find it "
2483 "useful to include subsections (B<SS>) named I<Linux Notes> and I<Glibc "
2488 #: build/C/man7/man-pages.7:377
2494 #: build/C/man7/man-pages.7:381
2496 "lists limitations, known defects or inconveniences, and other questionable "
2501 #: build/C/man7/man-pages.7:381
2507 #: build/C/man7/man-pages.7:387
2509 "provides one or more examples describing how this function, file or command "
2510 "is used. For details on writing example programs, see I<Example Programs> "
2515 #: build/C/man7/man-pages.7:387
2521 #: build/C/man7/man-pages.7:397
2523 "lists authors of the documentation or program. B<Use of an AUTHORS section "
2524 "is strongly discouraged>. Generally, it is better not to clutter every page "
2525 "with a list of (over time potentially numerous) authors; if you write or "
2526 "significantly amend a page, add a copyright notice as a comment in the "
2527 "source file. If you are the author of a device driver and want to include "
2528 "an address for reporting bugs, place this under the BUGS section."
2532 #: build/C/man7/man-pages.7:397
2538 #: build/C/man7/man-pages.7:404
2540 "provides a comma-separated list of related man pages, ordered by section "
2541 "number and then alphabetically by name, possibly followed by other related "
2542 "pages or documents. Do not terminate this with a period."
2546 #: build/C/man7/man-pages.7:415
2548 "Where the SEE ALSO list contains many long manual page names, to improve the "
2549 "visual result of the output, it may be useful to employ the I<.ad l> (don't "
2550 "right justify) and I<.nh> (don't hyphenate) directives. Hyphenation of "
2551 "individual page names can be prevented by preceding words with the string "
2556 #: build/C/man7/man-pages.7:415
2558 msgid "Font conventions"
2562 #: build/C/man7/man-pages.7:420
2564 "For functions, the arguments are always specified using italics, I<even in "
2565 "the SYNOPSIS section>, where the rest of the function is specified in bold:"
2569 #: build/C/man7/man-pages.7:422
2570 msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
2574 #: build/C/man7/man-pages.7:424
2575 msgid "Variable names should, like argument names, be specified in italics."
2579 #: build/C/man7/man-pages.7:437
2581 "Filenames (whether pathnames, or references to files in the I</usr/include> "
2582 "directory) are always in italics (e.g., I<E<lt>stdio.hE<gt>>), except in "
2583 "the SYNOPSIS section, where included files are in bold (e.g., B<#include "
2584 "E<lt>stdio.hE<gt>>). When referring to a standard include file under "
2585 "I</usr/include>, specify the header file surrounded by angle brackets, in "
2586 "the usual C way (e.g., I<E<lt>stdio.hE<gt>>)."
2590 #: build/C/man7/man-pages.7:441
2592 "Special macros, which are usually in upper case, are in bold (e.g., "
2593 "B<MAXINT>). Exception: don't boldface NULL."
2597 #: build/C/man7/man-pages.7:446
2599 "When enumerating a list of error codes, the codes are in bold (this list "
2600 "usually uses the B<\\&.TP> macro)."
2604 #: build/C/man7/man-pages.7:449
2606 "Complete commands should, if long, be written as in an indented line on "
2607 "their own, for example"
2611 #: build/C/man7/man-pages.7:453
2613 msgid "man 7 man-pages\n"
2617 #: build/C/man7/man-pages.7:463
2619 "If the command is short, then it can be included inline in the text, in "
2620 "italic format, for example, I<man 7 man-pages>. In this case, it may be "
2621 "worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
2622 "command. Command options should be written in italics, e.g., I<-l>."
2626 #: build/C/man7/man-pages.7:468
2628 "Expressions, if not written on a separate indented line, should be specified "
2629 "in italics. Again, the use of nonbreaking spaces may be appropriate if the "
2630 "expression is inlined with normal text."
2634 #: build/C/man7/man-pages.7:479
2636 "Any reference to the subject of the current manual page should be written "
2637 "with the name in bold. If the subject is a function (i.e., this is a "
2638 "Section 2 or 3 page), then the name should be followed by a pair of "
2639 "parentheses in Roman (normal) font. For example, in the B<fcntl>(2) man "
2640 "page, references to the subject of the page would be written as: "
2641 "B<fcntl>(). The preferred way to write this in the source file is:"
2645 #: build/C/man7/man-pages.7:482
2647 msgid " .BR fcntl ()\n"
2651 #: build/C/man7/man-pages.7:486
2653 "(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
2654 "easier to write tools that parse man page source files.)"
2658 #: build/C/man7/man-pages.7:494
2660 "Any reference to another man page should be written with the name in bold, "
2661 "I<always> followed by the section number, formatted in Roman (normal) font, "
2662 "without any separating spaces (e.g., B<intro>(2)). The preferred way to "
2663 "write this in the source file is:"
2667 #: build/C/man7/man-pages.7:497
2669 msgid " .BR intro (2)\n"
2673 #: build/C/man7/man-pages.7:502
2675 "(Including the section number in cross references lets tools like "
2676 "B<man2html>(1) create properly hyperlinked pages.)"
2680 #: build/C/man7/man-pages.7:502
2686 #: build/C/man7/man-pages.7:507
2688 "Starting with release 2.59, I<man-pages> follows American spelling "
2689 "conventions; please write all new pages and patches according to these "
2694 #: build/C/man7/man-pages.7:507
2696 msgid "Capitalization"
2700 #: build/C/man7/man-pages.7:512
2702 "In subsection (\"SS\") headings capitalize the first word in heading, but "
2703 "otherwise use lower case, except where English usage (e.g., proper nouns) or "
2704 "programming language requirements (e.g., identifier names) dictate "
2709 #: build/C/man7/man-pages.7:512
2711 msgid "Example programs and shell sessions"
2715 #: build/C/man7/man-pages.7:516
2717 "Manual pages can include example programs demonstrating how to use a system "
2718 "call or library function. However, note the following:"
2722 #: build/C/man7/man-pages.7:519
2723 msgid "Example programs should be written in C."
2727 #: build/C/man7/man-pages.7:526
2729 "An example program is only necessary and useful if it demonstrates something "
2730 "beyond what can easily be provided in a textual description of the "
2731 "interface. An example program that does nothing other than call an "
2732 "interface usually serves little purpose."
2736 #: build/C/man7/man-pages.7:530
2738 "Example programs should be fairly short (preferably less than 100 lines; "
2739 "ideally less than 50 lines)."
2743 #: build/C/man7/man-pages.7:534
2745 "Example programs should do error checking after system calls and library "
2750 #: build/C/man7/man-pages.7:538
2752 "Example programs should be complete, and compile without warnings when "
2753 "compiled with I<cc\\ -Wall>."
2757 #: build/C/man7/man-pages.7:544
2759 "Where possible and appropriate, example programs should allow "
2760 "experimentation, by varying their behavior based on inputs (ideally from "
2761 "command-line arguments, or alternatively, via input read by the program)."
2765 #: build/C/man7/man-pages.7:549
2767 "Example programs should be laid out according to Kernighan and Ritchie "
2768 "style, with 4-space indents. (Avoid the use of TAB characters in source "
2773 #: build/C/man7/man-pages.7:554
2775 "For some examples of what example programs should look like, see B<wait>(2) "
2780 #: build/C/man7/man-pages.7:558
2782 "If you include a shell session demonstrating the use of a program or other "
2783 "system feature, boldface the user input text, to distinguish it from output "
2784 "produced by the system."
2788 #: build/C/man7/man-pages.7:558
2790 msgid "Indentation of structure definitions, shell session logs, etc."
2794 #: build/C/man7/man-pages.7:564
2796 "When structure definitions, shell session logs, and so on are included in "
2797 "running text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ "
2802 #: build/C/man7/man-pages.7:571
2804 "For canonical examples of how man pages in the I<man-pages> package should "
2805 "look, see B<pipe>(2) and B<fcntl>(2)."
2809 #: build/C/man7/man-pages.7:578
2811 "B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
2816 #: build/C/man7/man.7:34
2822 #: build/C/man7/man.7:37
2823 msgid "man - macros to format man pages"
2827 #: build/C/man7/man.7:41
2828 msgid "B<groff -Tascii -man> I<file> \\&..."
2832 #: build/C/man7/man.7:45
2833 msgid "B<groff -Tps -man> I<file> \\&..."
2837 #: build/C/man7/man.7:62
2839 "This manual page explains the B<groff an.tmac> macro package (often called "
2840 "the B<man> macro package). This macro package should be used by developers "
2841 "when writing or porting man pages for Linux. It is fairly compatible with "
2842 "other versions of this macro package, so porting man pages should not be a "
2843 "major problem (exceptions include the NET-2 BSD release, which uses a "
2844 "totally different macro package called mdoc; see B<mdoc>(7))."
2848 #: build/C/man7/man.7:74
2850 "Note that NET-2 BSD mdoc man pages can be used with B<groff> simply by "
2851 "specifying the B<-mdoc> option instead of the B<-man> option. Using the "
2852 "B<-mandoc> option is, however, recommended, since this will automatically "
2853 "detect which macro package is in use."
2857 #: build/C/man7/man.7:78
2859 "For conventions that should be employed when writing man pages for the Linux "
2860 "I<man-pages> package, see B<man-pages>(7)."
2864 #: build/C/man7/man.7:81
2866 "The first command in a man page (after comment lines, that is, lines that "
2867 "start with B<.\\e\">) should be"
2871 #: build/C/man7/man.7:90
2873 "For details of the arguments that should be supplied to the B<TH> command, "
2874 "see B<man-pages>(7)."
2878 #: build/C/man7/man.7:96
2880 "Note that BSD mdoc-formatted pages begin with the B<Dd> command, not the "
2885 #: build/C/man7/man.7:96
2890 #. The following doesn't seem to be required (see Debian bug 411303),
2891 #. If the name contains spaces and appears
2892 #. on the same line as
2894 #. then place the heading in double quotes.
2896 #: build/C/man7/man.7:105
2897 msgid "Sections are started with B<\\&.SH> followed by the heading name."
2901 #: build/C/man7/man.7:108
2903 "The only mandatory heading is NAME, which should be the first section and be "
2904 "followed on the next line by a one-line description of the program:"
2908 #: build/C/man7/man.7:111
2913 #: build/C/man7/man.7:113
2914 msgid "item \\e- description"
2918 #: build/C/man7/man.7:127
2920 "It is extremely important that this format is followed, and that there is a "
2921 "backslash before the single dash which follows the item name. This syntax "
2922 "is used by the B<mandb>(8) program to create a database of short "
2923 "descriptions for the B<whatis>(1) and B<apropos>(1) commands. (See "
2924 "B<lexgrog>(1) for further details on the syntax of the NAME section.)"
2928 #: build/C/man7/man.7:130
2930 "For a list of other sections that might appear in a manual page, see "
2935 #: build/C/man7/man.7:130
2941 #: build/C/man7/man.7:132
2942 msgid "The commands to select the type face are:"
2946 #: build/C/man7/man.7:132
2952 #: build/C/man7/man.7:135
2957 #: build/C/man7/man.7:135
2963 #: build/C/man7/man.7:139
2965 "Bold alternating with italics (especially useful for function "
2970 #: build/C/man7/man.7:139
2976 #: build/C/man7/man.7:144
2978 "Bold alternating with Roman (especially useful for referring to other manual "
2983 #: build/C/man7/man.7:144
2989 #: build/C/man7/man.7:147
2994 #: build/C/man7/man.7:147
3000 #: build/C/man7/man.7:150
3001 msgid "Italics alternating with bold"
3005 #: build/C/man7/man.7:150
3011 #: build/C/man7/man.7:153
3012 msgid "Italics alternating with Roman"
3016 #: build/C/man7/man.7:153
3022 #: build/C/man7/man.7:156
3023 msgid "Roman alternating with bold"
3027 #: build/C/man7/man.7:156
3033 #: build/C/man7/man.7:159
3034 msgid "Roman alternating with italics"
3038 #: build/C/man7/man.7:159
3044 #: build/C/man7/man.7:162
3045 msgid "Small alternating with bold"
3049 #: build/C/man7/man.7:162
3055 #: build/C/man7/man.7:165
3056 msgid "Small (useful for acronyms)"
3060 #: build/C/man7/man.7:178
3062 "Traditionally, each command can have up to six arguments, but the GNU "
3063 "implementation removes this limitation (you might still want to limit "
3064 "yourself to 6 arguments for portability's sake). Arguments are delimited by "
3065 "spaces. Double quotes can be used to specify an argument which contains "
3066 "spaces. All of the arguments will be printed next to each other without "
3067 "intervening spaces, so that the B<\\&.BR> command can be used to specify a "
3068 "word in bold followed by a mark of punctuation in Roman. If no arguments "
3069 "are given, the command is applied to the following line of text."
3073 #: build/C/man7/man.7:178
3075 msgid "Other macros and strings"
3079 #: build/C/man7/man.7:198
3081 "Below are other relevant macros and predefined strings. Unless noted "
3082 "otherwise, all macros cause a break (end the current line of text). Many of "
3083 "these macros set or use the \"prevailing indent.\" The \"prevailing indent\" "
3084 "value is set by any macro with the parameter I<i> below; macros may omit "
3085 "I<i> in which case the current prevailing indent will be used. As a result, "
3086 "successive indented paragraphs can use the same indent without respecifying "
3087 "the indent value. A normal (nonindented) paragraph resets the prevailing "
3088 "indent value to its default value (0.5 inches). By default a given indent "
3089 "is measured in ens; try to use ens or ems as units for indents, since these "
3090 "will automatically adjust to font size changes. The other key macro "
3095 #: build/C/man7/man.7:198
3097 msgid "Normal paragraphs"
3101 #: build/C/man7/man.7:199
3107 #: build/C/man7/man.7:204 build/C/man7/man.7:209
3108 msgid "Same as B<\\&.PP> (begin a new paragraph)."
3112 #: build/C/man7/man.7:204
3118 #: build/C/man7/man.7:209
3124 #: build/C/man7/man.7:212
3125 msgid "Begin a new paragraph and reset prevailing indent."
3129 #: build/C/man7/man.7:212
3131 msgid "Relative margin indent"
3135 #: build/C/man7/man.7:213
3137 msgid "B<\\&.RS>I< i>"
3141 #: build/C/man7/man.7:224
3143 "Start relative margin indent: moves the left margin I<i> to the right (if "
3144 "I<i> is omitted, the prevailing indent value is used). A new prevailing "
3145 "indent is set to 0.5 inches. As a result, all following paragraph(s) will "
3146 "be indented until the corresponding B<\\&.RE>."
3150 #: build/C/man7/man.7:224
3156 #: build/C/man7/man.7:228
3158 "End relative margin indent and restores the previous value of the prevailing "
3163 #: build/C/man7/man.7:228
3165 msgid "Indented paragraph macros"
3169 #: build/C/man7/man.7:229
3171 msgid "B<\\&.HP>I< i>"
3175 #: build/C/man7/man.7:234
3177 "Begin paragraph with a hanging indent (the first line of the paragraph is at "
3178 "the left margin of normal paragraphs, and the rest of the paragraph's lines "
3183 #: build/C/man7/man.7:234
3185 msgid "B<\\&.IP>I< x i>"
3189 #: build/C/man7/man.7:255
3191 "Indented paragraph with optional hanging tag. If the tag I<x> is omitted, "
3192 "the entire following paragraph is indented by I<i>. If the tag I<x> is "
3193 "provided, it is hung at the left margin before the following indented "
3194 "paragraph (this is just like B<\\&.TP> except the tag is included with the "
3195 "command instead of being on the following line). If the tag is too long, "
3196 "the text after the tag will be moved down to the next line (text will not be "
3197 "lost or garbled). For bulleted lists, use this macro with \\e(bu (bullet) "
3198 "or \\e(em (em dash) as the tag, and for numbered lists, use the number or "
3199 "letter followed by a period as the tag; this simplifies translation to other "
3204 #: build/C/man7/man.7:255
3206 msgid "B<\\&.TP>I< i>"
3210 #: build/C/man7/man.7:262
3212 "Begin paragraph with hanging tag. The tag is given on the next line, but "
3213 "its results are like those of the B<\\&.IP> command."
3217 #: build/C/man7/man.7:262
3219 msgid "Hypertext link macros"
3223 #: build/C/man7/man.7:272
3225 "(Feature supported with B<groff> only.) In order to use hypertext link "
3226 "macros, it is necessary to load the B<www.tmac> macro package. Use the "
3227 "request B<.mso www.tmac> to do this."
3231 #: build/C/man7/man.7:272
3233 msgid "B<\\&.URL>I< url link trailer>"
3236 #. The following is a kludge to get a paragraph into the listing.
3238 #: build/C/man7/man.7:285
3240 "Inserts a hypertext link to the URI (URL) I<url>, with I<link> as the text "
3241 "of the link. The I<trailer> will be printed immediately afterward. When "
3242 "generating HTML this should translate into the HTML command B<E<lt>A "
3243 "HREF=\">I<url>B<\"E<gt>>I<link>B<E<lt>/AE<gt>>I<trailer>B<.>"
3246 #. The following is a kludge to get a paragraph into the listing.
3248 #: build/C/man7/man.7:292
3250 "This and other related macros are new, and many tools won't do anything with "
3251 "them, but since many tools (including troff) will simply ignore undefined "
3252 "macros (or at worst insert their text) these are safe to insert."
3255 #. The following is a kludge to get a paragraph into the listing.
3257 #: build/C/man7/man.7:301
3259 "It can be useful to define your own B<URL> macro in manual pages for the "
3260 "benefit of those viewing it with a roff viewer other than B<groff>. That "
3261 "way, the URL, link text, and trailer text (if any) are still visible."
3265 #: build/C/man7/man.7:304
3266 msgid "Here's an example:"
3270 #: build/C/man7/man.7:306
3275 #: build/C/man7/man.7:308
3276 msgid "\\e\\e$2 \\e(laURL: \\e\\e$1 \\e(ra\\e\\e$3"
3280 #: build/C/man7/man.7:310
3285 #: build/C/man7/man.7:312
3286 msgid "\\&.if \\en[.g] .mso www.tmac"
3290 #: build/C/man7/man.7:315
3291 msgid "\\&.TH I<...>"
3295 #: build/C/man7/man.7:317
3296 msgid "I<(later in the page)>"
3300 #: build/C/man7/man.7:319
3301 msgid "This software comes from the"
3305 #: build/C/man7/man.7:321
3306 msgid "\\&.URL \"http://www.gnu.org/\" \"GNU Project\" \" of the\""
3310 #: build/C/man7/man.7:323
3311 msgid "\\&.URL \"http://www.fsf.org/\" \"Free Software Foundation\" ."
3315 #: build/C/man7/man.7:333
3317 "In the above, if B<groff> is being used, the B<www.tmac> macro package's "
3318 "definition of the URL macro will supersede the locally defined one."
3322 #: build/C/man7/man.7:338
3324 "A number of other link macros are available. See B<groff_www>(7) for more "
3329 #: build/C/man7/man.7:338
3331 msgid "Miscellaneous macros"
3335 #: build/C/man7/man.7:339
3341 #: build/C/man7/man.7:343
3342 msgid "Reset tabs to default tab values (every 0.5 inches); does not cause a break."
3346 #: build/C/man7/man.7:343
3348 msgid "B<\\&.PD>I< d>"
3352 #: build/C/man7/man.7:348
3354 "Set inter-paragraph vertical distance to d (if omitted, d=0.4v); does not "
3359 #: build/C/man7/man.7:348
3361 msgid "B<\\&.SS>I< t>"
3365 #: build/C/man7/man.7:355
3367 "Subheading I<t> (like B<\\&.SH>, but used for a subsection inside a "
3372 #: build/C/man7/man.7:355
3374 msgid "Predefined strings"
3378 #: build/C/man7/man.7:359
3379 msgid "The B<man> package has the following predefined strings:"
3383 #: build/C/man7/man.7:359
3389 #: build/C/man7/man.7:361
3390 msgid "Registration Symbol: \\*R"
3394 #: build/C/man7/man.7:361
3400 #: build/C/man7/man.7:363
3401 msgid "Change to default font size"
3405 #: build/C/man7/man.7:363
3411 #: build/C/man7/man.7:365
3412 msgid "Trademark Symbol: \\*(Tm"
3416 #: build/C/man7/man.7:365
3422 #: build/C/man7/man.7:367
3423 msgid "Left angled double quote: ``"
3427 #: build/C/man7/man.7:367
3433 #: build/C/man7/man.7:369
3434 msgid "Right angled double quote: ''"
3438 #: build/C/man7/man.7:369
3444 #: build/C/man7/man.7:413
3446 "Although technically B<man> is a troff macro package, in reality a large "
3447 "number of other tools process man page files that don't implement all of "
3448 "troff's abilities. Thus, it's best to avoid some of troff's more exotic "
3449 "abilities where possible to permit these other tools to work correctly. "
3450 "Avoid using the various troff preprocessors (if you must, go ahead and use "
3451 "B<tbl>(1), but try to use the B<IP> and B<TP> commands instead for "
3452 "two-column tables). Avoid using computations; most other tools can't "
3453 "process them. Use simple commands that are easy to translate to other "
3454 "formats. The following troff macros are believed to be safe (though in many "
3455 "cases they will be ignored by translators): B<\\e\">, B<.>, B<ad>, B<bp>, "
3456 "B<br>, B<ce>, B<de>, B<ds>, B<el>, B<ie>, B<if>, B<fi>, B<ft>, B<hy>, B<ig>, "
3457 "B<in>, B<na>, B<ne>, B<nf>, B<nh>, B<ps>, B<so>, B<sp>, B<ti>, B<tr>."
3461 #: build/C/man7/man.7:436
3463 "You may also use many troff escape sequences (those sequences beginning with "
3464 "\\e). When you need to include the backslash character as normal text, use "
3465 "\\ee. Other sequences you may use, where x or xx are any characters and N "
3466 "is any digit, include: B<\\e'>, B<\\e`>, B<\\e->, B<\\e.>, B<\\e\">, "
3467 "B<\\e%>, B<\\e*x>, B<\\e*(xx>, B<\\e(xx>, B<\\e$N>, B<\\enx>, B<\\en(xx>, "
3468 "B<\\efx>, and B<\\ef(xx>. Avoid using the escape sequences for drawing "
3473 #: build/C/man7/man.7:467
3475 "Do not use the optional parameter for B<bp> (break page). Use only positive "
3476 "values for B<sp> (vertical space). Don't define a macro (B<de>) with the "
3477 "same name as a macro in this or the mdoc macro package with a different "
3478 "meaning; it's likely that such redefinitions will be ignored. Every "
3479 "positive indent (B<in>) should be paired with a matching negative indent "
3480 "(although you should be using the B<RS> and B<RE> macros instead). The "
3481 "condition test (B<if,ie>) should only have \\(aqt\\(aq or \\(aqn\\(aq as "
3482 "the condition. Only translations (B<tr>) that can be ignored should be "
3483 "used. Font changes (B<ft> and the B<\\ef> escape sequence) should only "
3484 "have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have "
3489 #: build/C/man7/man.7:474
3491 "If you use capabilities beyond these, check the results carefully on several "
3492 "tools. Once you've confirmed that the additional capability is safe, let "
3493 "the maintainer of this document know about the safe command or sequence that "
3494 "should be added to this list."
3498 #: build/C/man7/man.7:476
3499 msgid "I</usr/share/groff/>[*/]I<tmac/an.tmac>"
3503 #: build/C/man7/man.7:478
3504 msgid "I</usr/man/whatis>"
3508 #: build/C/man7/man.7:492
3510 "By all means include full URLs (or URIs) in the text itself; some tools such "
3511 "as B<man2html>(1) can automatically turn them into hypertext links. You "
3512 "can also use the new B<URL> macro to identify links to related information. "
3513 "If you include URLs, use the full URL (e.g., E<.UR "
3514 "http://www.kernelnotes.org> E<.UE )> to ensure that tools can automatically "
3519 #: build/C/man7/man.7:501
3521 "Tools processing these files should open the file and examine the first "
3522 "nonwhitespace character. A period (.) or single quote (') at the beginning "
3523 "of a line indicates a troff-based file (such as man or mdoc). A left angle "
3524 "bracket (E<lt>) indicates an SGML/XML-based file (such as HTML or Docbook). "
3525 "Anything else suggests simple ASCII text (e.g., a \"catman\" result)."
3529 #: build/C/man7/man.7:512
3531 "Many man pages begin with B<\\'\\e\"> followed by a space and a list of "
3532 "characters, indicating how the page is to be preprocessed. For "
3533 "portability's sake to non-troff translators we recommend that you avoid "
3534 "using anything other than B<tbl>(1), and Linux can detect that "
3535 "automatically. However, you might want to include this information so your "
3536 "man page can be handled by other (less capable) systems. Here are the "
3537 "definitions of the preprocessors invoked by these characters:"
3541 #: build/C/man7/man.7:512
3547 #: build/C/man7/man.7:515
3552 #: build/C/man7/man.7:515
3558 #: build/C/man7/man.7:518
3563 #: build/C/man7/man.7:518
3569 #: build/C/man7/man.7:521
3574 #: build/C/man7/man.7:521
3580 #: build/C/man7/man.7:524
3585 #: build/C/man7/man.7:524
3591 #: build/C/man7/man.7:527
3596 #: build/C/man7/man.7:527
3602 #: build/C/man7/man.7:530
3607 #: build/C/man7/man.7:530 build/C/man7/suffixes.7:279 build/C/man7/mdoc.samples.7:2883
3613 #: build/C/man7/man.7:543
3615 "Most of the macros describe formatting (e.g., font type and spacing) instead "
3616 "of marking semantic content (e.g., this text is a reference to another "
3617 "page), compared to formats like mdoc and DocBook (even HTML has more "
3618 "semantic markings). This situation makes it harder to vary the B<man> "
3619 "format for different media, to make the formatting consistent for a given "
3620 "media, and to automatically insert cross-references. By sticking to the "
3621 "safe subset described above, it should be easier to automate transitioning "
3622 "to a different reference page format in the future."
3627 #. James Clark (jjc@jclark.com) wrote the implementation of the macro package.
3629 #. Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
3630 #. this manual page.
3632 #. Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
3633 #. (which influenced this manual page).
3635 #. David A. Wheeler (dwheeler@ida.org) heavily modified this
3636 #. manual page, such as adding detailed information on sections and macros.
3638 #: build/C/man7/man.7:559
3639 msgid "The Sun macro B<TX> is not implemented."
3643 #: build/C/man7/man.7:571
3645 "B<apropos>(1), B<groff>(1), B<lexgrog>(1), B<man>(1), B<man2html>(1), "
3646 "B<whatis>(1), B<groff_man>(7), B<groff_www>(7), B<man-pages>(7), B<mdoc>(7), "
3647 "B<mdoc.samples>(7)"
3651 #: build/C/man7/mdoc.7:42
3653 msgid "July 11, 1999"
3657 #: build/C/man7/mdoc.7:43
3663 #: build/C/man7/mdoc.7:47
3668 #: build/C/man7/mdoc.7:47
3670 msgid "quick reference guide for the"
3674 #: build/C/man7/mdoc.7:50
3675 msgid "E<.Nm \\-mdoc> macro package"
3679 #: build/C/man7/mdoc.7:54
3680 msgid "E<.Nm groff> E<.Fl m Ns Ar doc> E<.Ar files ...>"
3684 #: build/C/man7/mdoc.7:66
3686 "The E<.Nm \\-mdoc> package is a set of content-based and domain-based macros "
3687 "used to format the E<.Bx> man pages. The macro names and their meanings are "
3688 "listed below for quick reference; for a detailed explanation on using the "
3689 "package, see the tutorial sampler E<.Xr mdoc.samples 7>."
3693 #: build/C/man7/mdoc.7:71
3695 "Note that this is not the usual macro package for Linux documentation, "
3696 "although it is used for documentation of several widely used programs; see "
3701 #: build/C/man7/mdoc.7:80
3703 "The macros are described in two groups, the first includes the structural "
3704 "and physical page layout macros. The second contains the manual and general "
3705 "text domain macros which differentiate the E<.Nm \\-mdoc> package from other "
3706 "E<.Xr troff> formatting packages."
3710 #: build/C/man7/mdoc.7:80 build/C/man7/mdoc.samples.7:1811
3712 msgid "PAGE STRUCTURE DOMAIN"
3716 #: build/C/man7/mdoc.7:81
3718 msgid "Title Macros"
3722 #: build/C/man7/mdoc.7:84
3724 "To create a valid manual page, these three macros, in this order, are "
3729 #: build/C/man7/mdoc.7:85
3731 msgid "Li \"\\&.Dd \" Ar \"Month day, year\""
3735 #: build/C/man7/mdoc.7:87
3736 msgid "Document date."
3740 #: build/C/man7/mdoc.7:87
3742 msgid "Li \"\\&.Dt \" Ar \"DOCUMENT_TITLE [section] [volume]\""
3746 #: build/C/man7/mdoc.7:89
3747 msgid "Title, in upper case."
3751 #: build/C/man7/mdoc.7:89
3753 msgid "Li \"\\&.Os \" Ar \"OPERATING_SYSTEM [version/release]\""
3757 #: build/C/man7/mdoc.7:92
3758 msgid "Operating system E<.Pq Tn BSD>."
3762 #: build/C/man7/mdoc.7:93
3764 msgid "Page Layout Macros"
3768 #: build/C/man7/mdoc.7:95
3769 msgid "Section headers, paragraph breaks, lists and displays."
3773 #: build/C/man7/mdoc.7:96
3779 #: build/C/man7/mdoc.7:99
3780 msgid "Section Headers. Valid headers, in the order of presentation:"
3784 #: build/C/man7/mdoc.7:100
3790 #: build/C/man7/mdoc.7:108
3792 "Name section, should include the E<.Ql \\&.Nm> or E<.Ql \\&.Fn> and the "
3793 "E<.Ql \\&.Nd> macros."
3797 #: build/C/man7/mdoc.7:108
3803 #: build/C/man7/mdoc.7:110
3808 #: build/C/man7/mdoc.7:110
3810 msgid "Ar DESCRIPTION"
3814 #: build/C/man7/mdoc.7:113
3815 msgid "General description, should include options and parameters."
3819 #: build/C/man7/mdoc.7:113
3821 msgid "Ar RETURN VALUE"
3825 #: build/C/man7/mdoc.7:115
3826 msgid "Sections two and three function calls."
3830 #: build/C/man7/mdoc.7:115
3832 msgid "Ar ENVIRONMENT"
3836 #: build/C/man7/mdoc.7:117
3837 msgid "Describe environment variables."
3841 #: build/C/man7/mdoc.7:117
3847 #: build/C/man7/mdoc.7:119
3848 msgid "Files associated with the subject."
3852 #: build/C/man7/mdoc.7:119
3858 #: build/C/man7/mdoc.7:121
3859 msgid "Examples and suggestions."
3863 #: build/C/man7/mdoc.7:121
3865 msgid "Ar DIAGNOSTICS"
3869 #: build/C/man7/mdoc.7:123
3870 msgid "Normally used for section four device interface diagnostics."
3874 #: build/C/man7/mdoc.7:123
3880 #: build/C/man7/mdoc.7:126
3881 msgid "Sections two and three error and signal handling."
3885 #: build/C/man7/mdoc.7:126
3891 #: build/C/man7/mdoc.7:128
3892 msgid "Cross references and citations."
3896 #: build/C/man7/mdoc.7:128
3898 msgid "Ar CONFORMING TO"
3902 #: build/C/man7/mdoc.7:130
3903 msgid "Conformance to standards if applicable."
3907 #: build/C/man7/mdoc.7:130
3913 #: build/C/man7/mdoc.7:133
3914 msgid "If a standard is not applicable, the history of the subject should be given."
3918 #: build/C/man7/mdoc.7:133
3924 #: build/C/man7/mdoc.7:135
3925 msgid "Gotchas and caveats."
3929 #: build/C/man7/mdoc.7:135
3935 #: build/C/man7/mdoc.7:138
3936 msgid "Customized headers may be added at the authors discretion."
3940 #: build/C/man7/mdoc.7:139
3946 #: build/C/man7/mdoc.7:141
3947 msgid "Subsection Headers."
3951 #: build/C/man7/mdoc.7:141
3957 #: build/C/man7/mdoc.7:144
3958 msgid "Paragraph Break. Vertical space (one line)."
3962 #: build/C/man7/mdoc.7:144 build/C/man7/mdoc.samples.7:2200
3968 #: build/C/man7/mdoc.7:147
3969 msgid "(D-one) Display-one Indent and display one text line."
3973 #: build/C/man7/mdoc.7:147 build/C/man7/mdoc.samples.7:2208
3979 #: build/C/man7/mdoc.7:150
3980 msgid "(D-ell) Display-one literal. Indent and display one line of literal text."
3984 #: build/C/man7/mdoc.7:150 build/C/man7/mdoc.samples.7:2228
3990 #: build/C/man7/mdoc.7:153
3991 msgid "Begin-display block. Display options:"
3995 #: build/C/man7/mdoc.7:154 build/C/man7/mdoc.samples.7:2248
4001 #: build/C/man7/mdoc.7:156
4002 msgid "Unjustified (ragged edges)."
4006 #: build/C/man7/mdoc.7:156 build/C/man7/mdoc.samples.7:2251
4012 #: build/C/man7/mdoc.7:158
4017 #: build/C/man7/mdoc.7:158 build/C/man7/mdoc.samples.7:2255
4023 #: build/C/man7/mdoc.7:160
4024 msgid "Literal text or code."
4028 #: build/C/man7/mdoc.7:160
4030 msgid "Fl file Ar name"
4034 #: build/C/man7/mdoc.7:164
4035 msgid "Read in named E<.Ar file> and display."
4039 #: build/C/man7/mdoc.7:164 build/C/man7/mdoc.samples.7:2267
4041 msgid "Fl offset Ar string"
4045 #: build/C/man7/mdoc.7:169
4046 msgid "Offset display. Acceptable E<.Ar string> values:"
4050 #: build/C/man7/mdoc.7:170 build/C/man7/mdoc.samples.7:2275
4056 #: build/C/man7/mdoc.7:172
4057 msgid "Align block on left (default)."
4061 #: build/C/man7/mdoc.7:172 build/C/man7/mdoc.samples.7:2279
4067 #: build/C/man7/mdoc.7:174
4068 msgid "Approximate center margin."
4072 #: build/C/man7/mdoc.7:174 build/C/man7/mdoc.samples.7:2284
4078 #: build/C/man7/mdoc.7:176
4079 msgid "Six constant width spaces (a tab)."
4083 #: build/C/man7/mdoc.7:176 build/C/man7/mdoc.samples.7:2293
4085 msgid "Ar indent-two"
4089 #: build/C/man7/mdoc.7:178
4094 #: build/C/man7/mdoc.7:178 build/C/man7/mdoc.samples.7:2295
4100 #: build/C/man7/mdoc.7:181
4101 msgid "Left aligns block 2 inches from right."
4105 #: build/C/man7/mdoc.7:181
4107 msgid "Ar xx Ns Cm n"
4111 #: build/C/man7/mdoc.7:188
4113 "Where E<.Ar xx> is a number from E<.No \\&4 Ns Cm n> to E<.No \\&9\\&9 Ns Cm "
4118 #: build/C/man7/mdoc.7:188
4124 #: build/C/man7/mdoc.7:192
4125 msgid "Where E<.Ar Aa> is a callable macro name."
4129 #: build/C/man7/mdoc.7:192
4135 #: build/C/man7/mdoc.7:196
4136 msgid "The width of E<.Ar string> is used."
4140 #: build/C/man7/mdoc.7:198
4146 #: build/C/man7/mdoc.7:200
4147 msgid "End-display (matches \\&.Bd)."
4151 #: build/C/man7/mdoc.7:200
4157 #: build/C/man7/mdoc.7:204
4158 msgid "Begin-list. Create lists or columns. Options:"
4162 #: build/C/man7/mdoc.7:205
4164 msgid "Ar List-types"
4168 #: build/C/man7/mdoc.7:207
4170 msgid "Fl bullet Ta \"Bullet Item List\""
4174 #: build/C/man7/mdoc.7:208
4176 msgid "Fl item Ta \"Unlabeled List\""
4180 #: build/C/man7/mdoc.7:209
4182 msgid "Fl enum Ta \"Enumerated List\""
4186 #: build/C/man7/mdoc.7:210
4188 msgid "Fl tag Ta \"Tag Labeled List\""
4192 #: build/C/man7/mdoc.7:211
4194 msgid "Fl diag Ta \"Diagnostic List\""
4198 #: build/C/man7/mdoc.7:212
4200 msgid "Fl hang Ta \"Hanging Labeled List\""
4204 #: build/C/man7/mdoc.7:213
4206 msgid "Fl ohang Ta \"Overhanging Labeled List\""
4210 #: build/C/man7/mdoc.7:214
4212 msgid "Fl inset Ta \"Inset or Run-on Labeled List\""
4216 #: build/C/man7/mdoc.7:216
4218 msgid "List-parameters"
4222 #: build/C/man7/mdoc.7:218
4228 #: build/C/man7/mdoc.7:222
4229 msgid "(All lists.) See E<.Ql \\&.Bd> begin-display above."
4233 #: build/C/man7/mdoc.7:222
4239 #: build/C/man7/mdoc.7:229
4240 msgid "E<.Pf ( Fl tag> and E<.Fl hang> lists only.) See E<.Ql \\&.Bd>."
4244 #: build/C/man7/mdoc.7:229
4250 #: build/C/man7/mdoc.7:232
4251 msgid "(All lists.) Suppresses blank lines."
4255 #: build/C/man7/mdoc.7:234
4261 #: build/C/man7/mdoc.7:236
4266 #: build/C/man7/mdoc.7:236
4272 #: build/C/man7/mdoc.7:238
4277 #: build/C/man7/mdoc.7:239
4279 msgid "MANUAL AND GENERAL TEXT DOMAIN MACROS"
4283 #: build/C/man7/mdoc.7:243
4285 "The manual and general text domain macros are special in that most of them "
4286 "are parsed for callable macros for example:"
4290 #: build/C/man7/mdoc.7:244
4292 msgid "Li \"\\&.Op Fl s Ar file\""
4296 #: build/C/man7/mdoc.7:247
4297 msgid "Produces E<.Op Fl s Ar file>"
4301 #: build/C/man7/mdoc.7:265
4303 "In this example, the option enclosure macro E<.Ql \\&.Op> is parsed, and "
4304 "calls the callable content macro E<.Ql \\&Fl> which operates on the argument "
4305 "E<.Ql s> and then calls the callable content macro E<.Ql \\&Ar> which "
4306 "operates on the argument E<.Ql file>. Some macros may be callable, but are "
4307 "not parsed and vice versa. These macros are indicated in the E<.Em parsed> "
4308 "and E<.Em callable> columns below."
4312 #: build/C/man7/mdoc.7:267
4313 msgid "Unless stated, manual domain macros share a common syntax:"
4317 #: build/C/man7/mdoc.7:268
4319 msgid "\\&.Va argument [\\ .\\ ,\\ ;\\ :\\ (\\ )\\ [\\ ]\\ argument ...\\ ]"
4323 #: build/C/man7/mdoc.7:288
4325 "E<.Sy Note>: Opening and closing punctuation characters are only recognized "
4326 "as such if they are presented one at a time. The string E<.Ql \"),\"> is "
4327 "not recognized as punctuation and will be output with a leading white space "
4328 "and in what ever font the calling macro uses. The argument list E<.Ql \"] ) "
4329 ",\"> is recognized as three sequential closing punctuation characters and a "
4330 "leading white space is not output between the characters and the previous "
4331 "argument (if any). The special meaning of a punctuation character may be "
4332 "escaped with the string E<.Ql \\e&>. For example the following string,"
4336 #: build/C/man7/mdoc.7:289
4338 msgid "Li \"\\&.Ar file1\\ , file2\\ , file3\\ )\\ .\""
4342 #: build/C/man7/mdoc.7:292
4343 msgid "Produces E<.Ar file1 , file2 , file3>)."
4347 #: build/C/man7/mdoc.7:294
4349 msgid "Manual Domain Macros"
4353 #: build/C/man7/mdoc.7:296 build/C/man7/mdoc.7:321
4355 msgid "Em \"Name\tParsed\tCallable\tDescription\""
4359 #: build/C/man7/mdoc.7:297
4361 msgid "Li \\&Ad Ta Yes Ta Yes Ta \"Address. (This macro may be deprecated.)\""
4365 #: build/C/man7/mdoc.7:298
4367 msgid "Li \\&An Ta Yes Ta Yes Ta \"Author name.\""
4371 #: build/C/man7/mdoc.7:299
4373 msgid "Li \\&Ar Ta Yes Ta Yes Ta \"Command-line argument.\""
4377 #: build/C/man7/mdoc.7:300
4380 "Li \\&Cd Ta \\&No Ta \\&No Ta \"Configuration declaration (section four "
4385 #: build/C/man7/mdoc.7:301
4387 msgid "Li \\&Cm Ta Yes Ta Yes Ta \"Command-line argument modifier.\""
4391 #: build/C/man7/mdoc.7:302
4393 msgid "Li \\&Dv Ta Yes Ta Yes Ta \"Defined variable (source code).\""
4397 #: build/C/man7/mdoc.7:303
4399 msgid "Li \\&Er Ta Yes Ta Yes Ta \"Error number (source code).\""
4403 #: build/C/man7/mdoc.7:304
4405 msgid "Li \\&Ev Ta Yes Ta Yes Ta \"Environment variable.\""
4409 #: build/C/man7/mdoc.7:305
4411 msgid "Li \\&Fa Ta Yes Ta Yes Ta \"Function argument.\""
4415 #: build/C/man7/mdoc.7:306
4417 msgid "Li \\&Fd Ta Yes Ta Yes Ta \"Function declaration.\""
4421 #: build/C/man7/mdoc.7:307
4423 msgid "Li \\&Fn Ta Yes Ta Yes Ta \"Function call (also .Fo and .Fc).\""
4427 #: build/C/man7/mdoc.7:308
4429 msgid "Li \\&Ic Ta Yes Ta Yes Ta \"Interactive command.\""
4433 #: build/C/man7/mdoc.7:309
4435 msgid "Li \\&Li Ta Yes Ta Yes Ta \"Literal text.\""
4439 #: build/C/man7/mdoc.7:310
4441 msgid "Li \\&Nm Ta Yes Ta Yes Ta \"Command name.\""
4445 #: build/C/man7/mdoc.7:311
4447 msgid "Li \\&Op Ta Yes Ta Yes Ta \"Option (also .Oo and .Oc).\""
4451 #: build/C/man7/mdoc.7:312
4453 msgid "Li \\&Ot Ta Yes Ta Yes Ta \"Old style function type (Fortran only).\""
4457 #: build/C/man7/mdoc.7:313
4459 msgid "Li \\&Pa Ta Yes Ta Yes Ta \"Pathname or filename.\""
4463 #: build/C/man7/mdoc.7:314
4465 msgid "Li \\&St Ta Yes Ta Yes Ta \"Standards (\\-p1003.2, \\-p1003.1 or \\-ansiC)\""
4469 #: build/C/man7/mdoc.7:315
4471 msgid "Li \\&Va Ta Yes Ta Yes Ta \"Variable name.\""
4475 #: build/C/man7/mdoc.7:316
4477 msgid "Li \\&Vt Ta Yes Ta Yes Ta \"Variable type (Fortran only).\""
4481 #: build/C/man7/mdoc.7:317
4483 msgid "Li \\&Xr Ta Yes Ta Yes Ta \"Manual Page Cross Reference.\""
4487 #: build/C/man7/mdoc.7:319
4489 msgid "General Text Domain Macros"
4493 #: build/C/man7/mdoc.7:322
4495 msgid "Li \\&%A Ta Yes Ta \\&No Ta \"Reference author.\""
4499 #: build/C/man7/mdoc.7:323
4501 msgid "Li \\&%B Ta Yes Ta Yes Ta \"Reference book title.\""
4505 #: build/C/man7/mdoc.7:324
4507 msgid "Li \\&%\\&C Ta \\&No Ta \\&No Ta \"Reference place of publishing (city).\""
4511 #: build/C/man7/mdoc.7:325
4513 msgid "Li \\&%\\&D Ta \\&No Ta \\&No Ta \"Reference date.\""
4517 #: build/C/man7/mdoc.7:326
4519 msgid "Li \\&%J Ta Yes Ta Yes Ta \"Reference journal title.\""
4523 #: build/C/man7/mdoc.7:327
4525 msgid "Li \\&%N Ta \\&No Ta \\&No Ta \"Reference issue number.\""
4529 #: build/C/man7/mdoc.7:328
4531 msgid "Li \\&%\\&O Ta \\&No Ta \\&No Ta \"Reference optional information.\""
4535 #: build/C/man7/mdoc.7:329
4537 msgid "Li \\&%P Ta \\&No Ta \\&No Ta \"Reference page number(s).\""
4541 #: build/C/man7/mdoc.7:330
4543 msgid "Li \\&%R Ta \\&No Ta \\&No Ta \"Reference report Name.\""
4547 #: build/C/man7/mdoc.7:331
4549 msgid "Li \\&%T Ta Yes Ta Yes Ta \"Reference article title.\""
4553 #: build/C/man7/mdoc.7:332
4555 msgid "Li \\&%V Ta \\&No Ta \\&No Ta \"Reference volume.\""
4559 #: build/C/man7/mdoc.7:333
4561 msgid "Li \\&Ac Ta Yes Ta Yes Ta \"Angle close quote.\""
4565 #: build/C/man7/mdoc.7:334
4567 msgid "Li \\&Ao Ta Yes Ta Yes Ta \"Angle open quote.\""
4571 #: build/C/man7/mdoc.7:335
4573 msgid "Li \\&Ap Ta Yes Ta Yes Ta Apostrophe."
4577 #: build/C/man7/mdoc.7:336
4579 msgid "Li \\&Aq Ta Yes Ta Yes Ta \"Angle quote.\""
4583 #: build/C/man7/mdoc.7:337
4585 msgid "Li \\&At Ta \\&No Ta \\&No Ta Tn \"AT&T UNIX\""
4589 #: build/C/man7/mdoc.7:338
4591 msgid "Li \\&Bc Ta Yes Ta Yes Ta \"Bracket close quote.\""
4595 #: build/C/man7/mdoc.7:339
4597 msgid "Li \\&Bf Ta \\&No Ta \\&No Ta \"Begin font mode.\""
4601 #: build/C/man7/mdoc.7:340
4603 msgid "Li \\&Bo Ta Yes Ta Yes Ta \"Bracket open quote.\""
4607 #: build/C/man7/mdoc.7:341
4609 msgid "Li \\&Bq Ta Yes Ta Yes Ta \"Bracket quote.\""
4613 #: build/C/man7/mdoc.7:342
4615 msgid "Li \\&Bx Ta Yes Ta Yes Ta Bx ."
4619 #: build/C/man7/mdoc.7:343
4621 msgid "Li \\&Db Ta \\&No Ta \\&No Ta \"Debug (default is \\*qoff\\*q)\""
4625 #: build/C/man7/mdoc.7:344
4627 msgid "Li \\&Dc Ta Yes Ta Yes Ta \"Double close quote.\""
4631 #: build/C/man7/mdoc.7:345
4633 msgid "Li \\&Do Ta Yes Ta Yes Ta \"Double open quote.\""
4637 #: build/C/man7/mdoc.7:346
4639 msgid "Li \\&Dq Ta Yes Ta Yes Ta \"Double quote.\""
4643 #: build/C/man7/mdoc.7:347
4645 msgid "Li \\&Ec Ta Yes Ta Yes Ta \"Enclose string close quote.\""
4649 #: build/C/man7/mdoc.7:348
4651 msgid "Li \\&Ef Ta \\&No Ta \\&No Ta \"End font mode.\""
4655 #: build/C/man7/mdoc.7:349
4657 msgid "Li \\&Em Ta Yes Ta Yes Ta \"Emphasis (traditional English).\""
4661 #: build/C/man7/mdoc.7:350
4663 msgid "Li \\&Eo Ta Yes Ta Yes Ta \"Enclose string open quote.\""
4667 #: build/C/man7/mdoc.7:351
4669 msgid "Li \\&Fx Ta \\&No Ta \\&No Ta Tn \"FreeBSD operating system\""
4673 #: build/C/man7/mdoc.7:352
4675 msgid "Li \\&No Ta Yes Ta Yes Ta \"Normal text (no-op).\""
4679 #: build/C/man7/mdoc.7:353
4681 msgid "Li \\&Ns Ta Yes Ta Yes Ta \"No space.\""
4685 #: build/C/man7/mdoc.7:354
4687 msgid "Li \\&Pc Ta Yes Ta Yes Ta \"Parenthesis close quote.\""
4691 #: build/C/man7/mdoc.7:355
4693 msgid "Li \\&Pf Ta Yes Ta \\&No Ta \"Prefix string.\""
4697 #: build/C/man7/mdoc.7:356
4699 msgid "Li \\&Po Ta Yes Ta Yes Ta \"Parenthesis open quote.\""
4703 #: build/C/man7/mdoc.7:357
4705 msgid "Li \\&Pq Ta Yes Ta Yes Ta \"Parentheses quote.\""
4709 #: build/C/man7/mdoc.7:358
4711 msgid "Li \\&Qc Ta Yes Ta Yes Ta \"Straight Double close quote.\""
4715 #: build/C/man7/mdoc.7:359
4717 msgid "Li \\&Ql Ta Yes Ta Yes Ta \"Quoted literal.\""
4721 #: build/C/man7/mdoc.7:360
4723 msgid "Li \\&Qo Ta Yes Ta Yes Ta \"Straight Double open quote.\""
4727 #: build/C/man7/mdoc.7:361
4729 msgid "Li \\&Qq Ta Yes Ta Yes Ta \"Straight Double quote.\""
4733 #: build/C/man7/mdoc.7:362
4735 msgid "Li \\&Re Ta \\&No Ta \\&No Ta \"Reference end.\""
4739 #: build/C/man7/mdoc.7:363
4741 msgid "Li \\&Rs Ta \\&No Ta \\&No Ta \"Reference start.\""
4745 #: build/C/man7/mdoc.7:364
4748 "Li \\&Rv Ta \\&No Ta \\&No Ta \"Return values (sections two and three "
4753 #: build/C/man7/mdoc.7:365
4755 msgid "Li \\&Sc Ta Yes Ta Yes Ta \"Single close quote.\""
4759 #: build/C/man7/mdoc.7:366
4761 msgid "Li \\&So Ta Yes Ta Yes Ta \"Single open quote.\""
4765 #: build/C/man7/mdoc.7:367
4767 msgid "Li \\&Sq Ta Yes Ta Yes Ta \"Single quote.\""
4771 #: build/C/man7/mdoc.7:368
4773 msgid "Li \\&Sm Ta \\&No Ta \\&No Ta \"Space mode (default is \\*qon\\*q)\""
4777 #: build/C/man7/mdoc.7:369
4779 msgid "Li \\&Sx Ta Yes Ta Yes Ta \"Section Cross Reference.\""
4783 #: build/C/man7/mdoc.7:370
4785 msgid "Li \\&Sy Ta Yes Ta Yes Ta \"Symbolic (traditional English).\""
4789 #: build/C/man7/mdoc.7:371
4791 msgid "Li \\&Tn Ta Yes Ta Yes Ta \"Trade or type name (small Caps).\""
4795 #: build/C/man7/mdoc.7:372
4797 msgid "Li \\&Ux Ta Yes Ta Yes Ta Ux"
4801 #: build/C/man7/mdoc.7:373
4803 msgid "Li \\&Xc Ta Yes Ta Yes Ta \"Extend argument list close.\""
4807 #: build/C/man7/mdoc.7:374
4809 msgid "Li \\&Xo Ta Yes Ta Yes Ta \"Extend argument list open.\""
4813 #: build/C/man7/mdoc.7:388
4815 "Macro names ending in E<.Ql q> quote remaining items on the argument list. "
4816 "Macro names ending in E<.Ql o> begin a quote which may span more than one "
4817 "line of input and are close quoted with the matching macro name ending in "
4818 "E<.Ql c>. Enclosure macros may be nested and are limited to eight "
4823 #: build/C/man7/mdoc.7:400
4825 "Note: the extended argument list macros E<.Pf ( Ql \\&.Xo>, E<.Ql \\&.Xc>) "
4826 "and the function enclosure macros E<.Pf ( Ql \\&.Fo>, E<.Ql \\&.Fc>) are "
4827 "irregular. The extended list macros are used when the number of macro "
4828 "arguments would exceed the E<.Xr troff> limitation of nine arguments."
4831 #. The following does not apply on Linux:
4832 #. .Sh CONFIGURATION
4833 #. For site specific configuration of the macro package,
4835 #. .Pa /usr/src/share/tmac/README .
4837 #: build/C/man7/mdoc.7:411
4839 "The macros UR (starting a URI/URL hypertext reference), UE (ending one), and "
4840 "UN (identifying a target for a reference) are also available. See E<.Xr man "
4841 "7> for more information on these macros."
4845 #: build/C/man7/mdoc.7:413
4851 #: build/C/man7/mdoc.7:415
4852 msgid "Manual and general text domain macros."
4856 #: build/C/man7/mdoc.7:415
4858 msgid "Pa tmac/doc-common"
4862 #: build/C/man7/mdoc.7:417
4863 msgid "Common structural macros and definitions."
4867 #: build/C/man7/mdoc.7:417
4869 msgid "Pa tmac/doc-nroff"
4873 #: build/C/man7/mdoc.7:421
4874 msgid "Site dependent E<.Xr nroff> style file."
4878 #: build/C/man7/mdoc.7:421
4880 msgid "Pa tmac/doc-ditroff"
4884 #: build/C/man7/mdoc.7:425
4885 msgid "Site dependent E<.Xr troff> style file."
4889 #: build/C/man7/mdoc.7:425
4891 msgid "Pa tmac/doc-syms"
4895 #: build/C/man7/mdoc.7:427
4896 msgid "Special defines (such as the standards macro)."
4900 #: build/C/man7/mdoc.7:433
4901 msgid "E<.Xr groff_mdoc 7>, E<.Xr mdoc.samples 7>, E<.Xr man 7>, E<.Xr man-pages 7>"
4905 #: build/C/man7/mdoc.7:440 build/C/man7/mdoc.samples.7:2964
4907 "This page is part of release 3.50 of the Linux E<.Em man-pages> project. A "
4908 "description of the project, and information about reporting bugs, can be "
4909 "found at http://www.kernel.org/doc/man-pages/."
4913 #: build/C/man7/operator.7:40
4919 #: build/C/man7/operator.7:40
4925 #: build/C/man7/operator.7:43
4926 msgid "operator - C operator precedence and order of evaluation"
4930 #: build/C/man7/operator.7:45
4931 msgid "This manual page lists C operators and their precedence in evaluation."
4935 #: build/C/man7/operator.7:63
4938 "B<Operator Associativity>\n"
4939 "() [] -E<gt> . left to right\n"
4940 "! ~ ++ -- + - (type) * & sizeof right to left\n"
4941 "* / % left to right\n"
4942 "+ - left to right\n"
4943 "E<lt>E<lt> E<gt>E<gt> left to right\n"
4944 "E<lt> E<lt>= E<gt> E<gt>= left to right\n"
4945 "== != left to right\n"
4949 "&& left to right\n"
4950 "|| left to right\n"
4951 "?: right to left\n"
4952 "= += -= *= /= %= E<lt>E<lt>= E<gt>E<gt>= &= ^= |= right to left\n"
4957 #: build/C/man7/posixoptions.7:24
4959 msgid "POSIXOPTIONS"
4963 #: build/C/man7/posixoptions.7:24
4969 #: build/C/man7/posixoptions.7:27
4970 msgid "posixoptions - optional parts of the POSIX standard"
4974 #: build/C/man7/posixoptions.7:41
4976 "The POSIX standard (the information below is from POSIX.1-2001) describes a "
4977 "set of behaviors and interfaces for a compliant system. However, many "
4978 "interfaces are optional and there are feature test macros to test the "
4979 "availability of interfaces at compile time, and functions B<sysconf>(3), "
4980 "B<fpathconf>(3), B<pathconf>(3), B<confstr>(3) to do this at run time. "
4981 "From shell scripts one can use B<getconf>(1). For more detail, see "
4986 #: build/C/man7/posixoptions.7:48
4988 "We give the name of the POSIX abbreviation, the option, the name of the "
4989 "B<sysconf>(3) parameter used to inquire about the option, and possibly a "
4990 "very short description. Much more precise detail can be found in the POSIX "
4991 "standard itself, versions of which can nowadays be accessed freely on the "
4996 #: build/C/man7/posixoptions.7:48
4998 msgid "ADV - _POSIX_ADVISORY_INFO - _SC_ADVISORY_INFO"
5002 #: build/C/man7/posixoptions.7:50
5003 msgid "The following advisory functions are present:"
5007 #: build/C/man7/posixoptions.7:58
5010 "I<posix_fadvise>(),\n"
5011 "I<posix_fallocate>(),\n"
5012 "I<posix_memalign>(),\n"
5013 "I<posix_madvise>().\n"
5017 #: build/C/man7/posixoptions.7:61
5019 msgid "AIO - _POSIX_ASYNCHRONOUS_IO - _SC_ASYNCHRONOUS_IO"
5023 #: build/C/man7/posixoptions.7:66
5025 "The header I<E<lt>aio.hE<gt>> is present. The following functions are "
5030 #: build/C/man7/posixoptions.7:78
5033 "I<aio_cancel>(),\n"
5037 "I<aio_return>(),\n"
5038 "I<aio_suspend>(),\n"
5040 "I<lio_listio>().\n"
5044 #: build/C/man7/posixoptions.7:81
5046 msgid "BAR - _POSIX_BARRIERS - _SC_BARRIERS"
5050 #: build/C/man7/posixoptions.7:88 build/C/man7/posixoptions.7:458
5052 "This option implies the B<_POSIX_THREADS> and "
5053 "B<_POSIX_THREAD_SAFE_FUNCTIONS> options. The following functions are "
5058 #: build/C/man7/posixoptions.7:97
5061 "I<pthread_barrier_destroy>(),\n"
5062 "I<pthread_barrier_init>(),\n"
5063 "I<pthread_barrier_wait>(),\n"
5064 "I<pthread_barrierattr_destroy>(),\n"
5065 "I<pthread_barrierattr_init>().\n"
5069 #. Batch environment.
5073 #: build/C/man7/posixoptions.7:104
5075 msgid "--- - POSIX_CHOWN_RESTRICTED"
5078 #. What about lchown() ?
5080 #: build/C/man7/posixoptions.7:112
5082 "If this option is in effect (as it always is under POSIX.1-2001) then only "
5083 "root may change the owner of a file, and nonroot can only set the group of a "
5084 "file to one of the groups it belongs to. This affects the functions "
5085 "I<chown>(), I<fchown>()."
5089 #: build/C/man7/posixoptions.7:112
5091 msgid "CS - _POSIX_CLOCK_SELECTION - _SC_CLOCK_SELECTION"
5095 #: build/C/man7/posixoptions.7:117
5097 "This option implies the B<_POSIX_TIMERS> option. The following functions "
5102 #: build/C/man7/posixoptions.7:124
5105 "I<pthread_condattr_getclock>(),\n"
5106 "I<pthread_condattr_setclock>(),\n"
5107 "I<clock_nanosleep>().\n"
5111 #: build/C/man7/posixoptions.7:132
5113 "If B<CLOCK_REALTIME> is changed by the function I<clock_settime>(), then "
5114 "this affects all timers set for an absolute time."
5118 #: build/C/man7/posixoptions.7:132
5120 msgid "CPT - _POSIX_CPUTIME - _SC_CPUTIME"
5124 #. Fortran development
5128 #: build/C/man7/posixoptions.7:145
5130 "The clockID CLOCK_PROCESS_CPUTIME_ID is supported. The initial value of "
5131 "this clock is 0 for each process. This option implies the B<_POSIX_TIMERS> "
5132 "option. The function I<clock_getcpuclockid>() is present."
5136 #: build/C/man7/posixoptions.7:145
5138 msgid "--- - _POSIX_FILE_LOCKING - _SC_FILE_LOCKING"
5142 #. IEC 60559 Floating-Point Option.
5144 #: build/C/man7/posixoptions.7:148 build/C/man7/posixoptions.7:238
5145 msgid "This option has been deleted. Not in final XPG6."
5149 #: build/C/man7/posixoptions.7:148
5151 msgid "FSC - _POSIX_FSYNC - _SC_FSYNC"
5155 #: build/C/man7/posixoptions.7:152
5156 msgid "The function I<fsync>() is present."
5160 #: build/C/man7/posixoptions.7:152
5162 msgid "IP6 - _POSIX_IPV6 - _SC_IPV6"
5166 #: build/C/man7/posixoptions.7:154
5167 msgid "Internet Protocol Version 6 is supported."
5171 #: build/C/man7/posixoptions.7:154
5173 msgid "--- - _POSIX_JOB_CONTROL - _SC_JOB_CONTROL"
5177 #: build/C/man7/posixoptions.7:158
5179 "If this option is in effect (as it always is under POSIX.1-2001) then the "
5180 "system implements POSIX-style job control, and the following functions are "
5185 #: build/C/man7/posixoptions.7:169
5192 "I<tcsendbreak>(),\n"
5198 #: build/C/man7/posixoptions.7:171
5200 msgid "MF - _POSIX_MAPPED_FILES - _SC_MAPPED_FILES"
5204 #: build/C/man7/posixoptions.7:180
5206 "Shared memory is supported. The include file I<E<lt>sys/mman.hE<gt>> is "
5207 "present. The following functions are present: I<mmap>(), I<msync>(), "
5212 #: build/C/man7/posixoptions.7:180
5214 msgid "ML - _POSIX_MEMLOCK - _SC_MEMLOCK"
5218 #: build/C/man7/posixoptions.7:186
5220 "Shared memory can be locked into core. The functions I<mlockall>(), "
5221 "I<munlockall>() are present."
5225 #: build/C/man7/posixoptions.7:186
5227 msgid "MR/MLR - _POSIX_MEMLOCK_RANGE - _SC_MEMLOCK_RANGE"
5231 #: build/C/man7/posixoptions.7:192
5233 "More precisely, ranges can be locked into core. The functions I<mlock>(), "
5234 "I<munlock>() are present."
5238 #: build/C/man7/posixoptions.7:192
5240 msgid "MPR - _POSIX_MEMORY_PROTECTION - _SC_MEMORY_PROTECTION"
5244 #: build/C/man7/posixoptions.7:196
5245 msgid "The function I<mprotect>() is present."
5249 #: build/C/man7/posixoptions.7:196
5251 msgid "MSG - _POSIX_MESSAGE_PASSING - _SC_MESSAGE_PASSING"
5255 #: build/C/man7/posixoptions.7:201
5257 "The include file I<E<lt>mqueue.hE<gt>> is present. The following functions "
5262 #: build/C/man7/posixoptions.7:213
5266 "I<mq_getattr>(),\n"
5269 "I<mq_receive>(),\n"
5271 "I<mq_setattr>(),\n"
5276 #: build/C/man7/posixoptions.7:216
5278 msgid "MON - _POSIX_MONOTONIC_CLOCK - _SC_MONOTONIC_CLOCK"
5282 #: build/C/man7/posixoptions.7:223
5284 "B<CLOCK_MONOTONIC> is supported. This option implies the B<_POSIX_TIMERS> "
5285 "option. Affected functions are"
5289 #: build/C/man7/posixoptions.7:231
5292 "I<aio_suspend>(),\n"
5293 "I<clock_getres>(),\n"
5294 "I<clock_gettime>(),\n"
5295 "I<clock_settime>(),\n"
5296 "I<timer_create>().\n"
5300 #: build/C/man7/posixoptions.7:233
5302 msgid "--- - _POSIX_MULTI_PROCESS - _SC_MULTI_PROCESS"
5306 #: build/C/man7/posixoptions.7:238
5308 msgid "--- - _POSIX_NO_TRUNC"
5312 #: build/C/man7/posixoptions.7:245
5314 "If this option is in effect (as it always is under POSIX.1-2001) then "
5315 "pathname components longer than B<NAME_MAX> are not truncated, but give an "
5316 "error. This property may be dependent on the path prefix of the component."
5320 #: build/C/man7/posixoptions.7:245
5322 msgid "PIO - _POSIX_PRIORITIZED_IO - _SC_PRIORITIZED_IO"
5326 #: build/C/man7/posixoptions.7:248
5328 "This option says that one can specify priorities for asynchronous I/O. This "
5329 "affects the functions"
5333 #: build/C/man7/posixoptions.7:254
5341 #: build/C/man7/posixoptions.7:256
5343 msgid "PS - _POSIX_PRIORITY_SCHEDULING - _SC_PRIORITY_SCHEDULING"
5347 #: build/C/man7/posixoptions.7:261
5349 "The include file I<E<lt>sched.hE<gt>> is present. The following functions "
5354 #: build/C/man7/posixoptions.7:273
5357 "I<sched_get_priority_max>(),\n"
5358 "I<sched_get_priority_min>(),\n"
5359 "I<sched_getparam>(),\n"
5360 "I<sched_getscheduler>(),\n"
5361 "I<sched_rr_get_interval>(),\n"
5362 "I<sched_setparam>(),\n"
5363 "I<sched_setscheduler>(),\n"
5364 "I<sched_yield>().\n"
5368 #: build/C/man7/posixoptions.7:279
5370 "If also B<_POSIX_SPAWN> is in effect, then the following functions are "
5375 #: build/C/man7/posixoptions.7:287 build/C/man7/posixoptions.7:449
5378 "I<posix_spawnattr_getschedparam>(),\n"
5379 "I<posix_spawnattr_getschedpolicy>(),\n"
5380 "I<posix_spawnattr_setschedparam>(),\n"
5381 "I<posix_spawnattr_setschedpolicy>().\n"
5385 #: build/C/man7/posixoptions.7:289
5387 msgid "RS - _POSIX_RAW_SOCKETS"
5391 #: build/C/man7/posixoptions.7:294
5393 "Raw sockets are supported. Affected functions are I<getsockopt>(), "
5398 #: build/C/man7/posixoptions.7:294
5400 msgid "--- - _POSIX_READER_WRITER_LOCKS - _SC_READER_WRITER_LOCKS"
5404 #: build/C/man7/posixoptions.7:302
5406 "This option implies the B<_POSIX_THREADS> option. Conversely, under "
5407 "POSIX.1-2001 the B<_POSIX_THREADS> option implies this option."
5411 #: build/C/man7/posixoptions.7:304
5413 msgid "The following functions are present:\n"
5417 #: build/C/man7/posixoptions.7:315
5420 "I<pthread_rwlock_destroy>(),\n"
5421 "I<pthread_rwlock_init>(),\n"
5422 "I<pthread_rwlock_rdlock>(),\n"
5423 "I<pthread_rwlock_tryrdlock>(),\n"
5424 "I<pthread_rwlock_trywrlock>(),\n"
5425 "I<pthread_rwlock_unlock>(),\n"
5426 "I<pthread_rwlock_wrlock>(),\n"
5427 "I<pthread_rwlockattr_destroy>(),\n"
5428 "I<pthread_rwlockattr_init>().\n"
5432 #: build/C/man7/posixoptions.7:317
5434 msgid "RTS - _POSIX_REALTIME_SIGNALS - _SC_REALTIME_SIGNALS"
5438 #: build/C/man7/posixoptions.7:320
5439 msgid "Realtime signals are supported. The following functions are present:"
5443 #: build/C/man7/posixoptions.7:327
5447 "I<sigtimedwait>(),\n"
5448 "I<sigwaitinfo>().\n"
5452 #: build/C/man7/posixoptions.7:330
5454 msgid "--- - _POSIX_REGEXP - _SC_REGEXP"
5458 #: build/C/man7/posixoptions.7:334
5460 "If this option is in effect (as it always is under POSIX.1-2001) then POSIX "
5461 "regular expressions are supported and the following functions are present:"
5465 #: build/C/man7/posixoptions.7:342
5475 #: build/C/man7/posixoptions.7:345
5477 msgid "--- - _POSIX_SAVED_IDS - _SC_SAVED_IDS"
5481 #: build/C/man7/posixoptions.7:349
5483 "If this option is in effect (as it always is under POSIX.1-2001) then a "
5484 "process has a saved set-user-ID and a saved set-group-ID. Affected "
5489 #: build/C/man7/posixoptions.7:359
5501 #. Software development
5503 #: build/C/man7/posixoptions.7:364
5505 msgid "SEM - _POSIX_SEMAPHORES - _SC_SEMAPHORES"
5509 #: build/C/man7/posixoptions.7:369
5511 "The include file I<E<lt>semaphore.hE<gt>> is present. The following "
5512 "functions are present:"
5516 #: build/C/man7/posixoptions.7:382
5520 "I<sem_destroy>(),\n"
5521 "I<sem_getvalue>(),\n"
5525 "I<sem_trywait>(),\n"
5526 "I<sem_unlink>(),\n"
5531 #: build/C/man7/posixoptions.7:385
5533 msgid "SHM - _POSIX_SHARED_MEMORY_OBJECTS - _SC_SHARED_MEMORY_OBJECTS"
5537 #: build/C/man7/posixoptions.7:387 build/C/man7/posixoptions.7:703 build/C/man7/posixoptions.7:719 build/C/man7/posixoptions.7:833
5538 msgid "The following functions are present:"
5542 #: build/C/man7/posixoptions.7:395
5548 "I<shm_unlink>().\n"
5552 #: build/C/man7/posixoptions.7:398
5554 msgid "--- - _POSIX_SHELL - _SC_SHELL"
5558 #: build/C/man7/posixoptions.7:403
5560 "If this option is in effect (as it always is under POSIX.1-2001), the "
5561 "function I<system>() is present."
5565 #: build/C/man7/posixoptions.7:403
5567 msgid "SPN - _POSIX_SPAWN - _SC_SPAWN"
5571 #: build/C/man7/posixoptions.7:413
5573 "This option describes support for process creation in a context where it is "
5574 "difficult or impossible to use I<fork>(), for example, because no MMU is "
5575 "present. If B<_POSIX_SPAWN> is in effect, then the include file "
5576 "I<E<lt>spawn.hE<gt>> and the following functions are present:"
5580 #: build/C/man7/posixoptions.7:434
5583 "I<posix_spawn>(),\n"
5584 "I<posix_spawn_file_actions_addclose>(),\n"
5585 "I<posix_spawn_file_actions_adddup2>(),\n"
5586 "I<posix_spawn_file_actions_addopen>(),\n"
5587 "I<posix_spawn_file_actions_destroy>(),\n"
5588 "I<posix_spawn_file_actions_init>(),\n"
5589 "I<posix_spawnattr_destroy>(),\n"
5590 "I<posix_spawnattr_getsigdefault>(),\n"
5591 "I<posix_spawnattr_getflags>(),\n"
5592 "I<posix_spawnattr_getpgroup>(),\n"
5593 "I<posix_spawnattr_getsigmask>(),\n"
5594 "I<posix_spawnattr_init>(),\n"
5595 "I<posix_spawnattr_setsigdefault>(),\n"
5596 "I<posix_spawnattr_setflags>(),\n"
5597 "I<posix_spawnattr_setpgroup>(),\n"
5598 "I<posix_spawnattr_setsigmask>(),\n"
5599 "I<posix_spawnp>().\n"
5603 #: build/C/man7/posixoptions.7:441
5605 "If also B<_POSIX_PRIORITY_SCHEDULING> is in effect, then the following "
5606 "functions are present:"
5610 #: build/C/man7/posixoptions.7:451
5612 msgid "SPI - _POSIX_SPIN_LOCKS - _SC_SPIN_LOCKS"
5616 #: build/C/man7/posixoptions.7:467
5619 "I<pthread_spin_destroy>(),\n"
5620 "I<pthread_spin_init>(),\n"
5621 "I<pthread_spin_lock>(),\n"
5622 "I<pthread_spin_trylock>(),\n"
5623 "I<pthread_spin_unlock>().\n"
5627 #: build/C/man7/posixoptions.7:470
5629 msgid "SS - _POSIX_SPORADIC_SERVER - _SC_SPORADIC_SERVER"
5633 #: build/C/man7/posixoptions.7:478
5635 "The scheduling policy B<SCHED_SPORADIC> is supported. This option implies "
5636 "the B<_POSIX_PRIORITY_SCHEDULING> option. Affected functions are"
5640 #: build/C/man7/posixoptions.7:484
5643 "I<sched_setparam>(),\n"
5644 "I<sched_setscheduler>().\n"
5648 #: build/C/man7/posixoptions.7:487
5650 msgid "SIO - _POSIX_SYNCHRONIZED_IO - _SC_SYNCHRONIZED_IO"
5654 #: build/C/man7/posixoptions.7:493
5655 msgid "Affected functions are I<open>(), I<msync>(), I<fsync>(), I<fdatasync>()."
5659 #: build/C/man7/posixoptions.7:493
5661 msgid "TSA - _POSIX_THREAD_ATTR_STACKADDR - _SC_THREAD_ATTR_STACKADDR"
5665 #: 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
5666 msgid "Affected functions are"
5670 #: build/C/man7/posixoptions.7:503
5673 "I<pthread_attr_getstack>(),\n"
5674 "I<pthread_attr_getstackaddr>(),\n"
5675 "I<pthread_attr_setstack>(),\n"
5676 "I<pthread_attr_setstackaddr>().\n"
5680 #: build/C/man7/posixoptions.7:506
5682 msgid "TSS - _POSIX_THREAD_ATTR_STACKSIZE - _SC_THREAD_ATTR_STACKSIZE"
5686 #: build/C/man7/posixoptions.7:516
5689 "I<pthread_attr_getstack>(),\n"
5690 "I<pthread_attr_getstacksize>(),\n"
5691 "I<pthread_attr_setstack>(),\n"
5692 "I<pthread_attr_setstacksize>().\n"
5696 #: build/C/man7/posixoptions.7:519
5698 msgid "TCT - _POSIX_THREAD_CPUTIME - _SC_THREAD_CPUTIME"
5702 #: build/C/man7/posixoptions.7:525
5704 "The clockID CLOCK_THREAD_CPUTIME_ID is supported. This option implies the "
5705 "B<_POSIX_TIMERS> option. Affected functions are"
5709 #: build/C/man7/posixoptions.7:534
5712 "I<pthread_getcpuclockid>(),\n"
5713 "I<clock_getres>(),\n"
5714 "I<clock_gettime>(),\n"
5715 "I<clock_settime>(),\n"
5716 "I<timer_create>().\n"
5720 #: build/C/man7/posixoptions.7:537
5722 msgid "TPI - _POSIX_THREAD_PRIO_INHERIT - _SC_THREAD_PRIO_INHERIT"
5726 #: build/C/man7/posixoptions.7:545
5729 "I<pthread_mutexattr_getprotocol>(),\n"
5730 "I<pthread_mutexattr_setprotocol>().\n"
5734 #: build/C/man7/posixoptions.7:548
5736 msgid "TPP - _POSIX_THREAD_PRIO_PROTECT - _SC_THREAD_PRIO_PROTECT"
5740 #: build/C/man7/posixoptions.7:560
5743 "I<pthread_mutex_getprioceiling>(),\n"
5744 "I<pthread_mutex_setprioceiling>(),\n"
5745 "I<pthread_mutexattr_getprioceiling>(),\n"
5746 "I<pthread_mutexattr_getprotocol>(),\n"
5747 "I<pthread_mutexattr_setprioceiling>(),\n"
5748 "I<pthread_mutexattr_setprotocol>().\n"
5752 #: build/C/man7/posixoptions.7:563
5754 msgid "TPS - _POSIX_THREAD_PRIORITY_SCHEDULING - _SC_THREAD_PRIORITY_SCHEDULING"
5758 #: build/C/man7/posixoptions.7:567
5760 "If this option is in effect, the different threads inside a process can run "
5761 "with different priorities and/or different schedulers. Affected functions "
5766 #: build/C/man7/posixoptions.7:580
5769 "I<pthread_attr_getinheritsched>(),\n"
5770 "I<pthread_attr_getschedpolicy>(),\n"
5771 "I<pthread_attr_getscope>(),\n"
5772 "I<pthread_attr_setinheritsched>(),\n"
5773 "I<pthread_attr_setschedpolicy>(),\n"
5774 "I<pthread_attr_setscope>(),\n"
5775 "I<pthread_getschedparam>(),\n"
5776 "I<pthread_setschedparam>(),\n"
5777 "I<pthread_setschedprio>().\n"
5781 #: build/C/man7/posixoptions.7:583
5783 msgid "TSH - _POSIX_THREAD_PROCESS_SHARED - _SC_THREAD_PROCESS_SHARED"
5787 #: build/C/man7/posixoptions.7:597
5790 "I<pthread_barrierattr_getpshared>(),\n"
5791 "I<pthread_barrierattr_setpshared>(),\n"
5792 "I<pthread_condattr_getpshared>(),\n"
5793 "I<pthread_condattr_setpshared>(),\n"
5794 "I<pthread_mutexattr_getpshared>(),\n"
5795 "I<pthread_mutexattr_setpshared>(),\n"
5796 "I<pthread_rwlockattr_getpshared>(),\n"
5797 "I<pthread_rwlockattr_setpshared>().\n"
5801 #: build/C/man7/posixoptions.7:600
5803 msgid "TSF - _POSIX_THREAD_SAFE_FUNCTIONS - _SC_THREAD_SAFE_FUNCTIONS"
5807 #: build/C/man7/posixoptions.7:625
5811 "I<getgrgid_r>(),\n"
5812 "I<getgrnam_r>(),\n"
5813 "I<getpwnam_r>(),\n"
5814 "I<getpwuid_r>(),\n"
5816 "I<ftrylockfile>(),\n"
5817 "I<funlockfile>(),\n"
5818 "I<getc_unlocked>(),\n"
5819 "I<getchar_unlocked>(),\n"
5820 "I<putc_unlocked>(),\n"
5821 "I<putchar_unlocked>(),\n"
5823 "I<strerror_r>(),\n"
5828 "I<localtime_r>().\n"
5832 #: build/C/man7/posixoptions.7:628
5834 msgid "TSP - _POSIX_THREAD_SPORADIC_SERVER - _SC_THREAD_SPORADIC_SERVER"
5838 #: build/C/man7/posixoptions.7:633
5840 "This option implies the B<_POSIX_THREAD_PRIORITY_SCHEDULING> option. "
5841 "Affected functions are"
5845 #: build/C/man7/posixoptions.7:640
5848 "I<sched_getparam>(),\n"
5849 "I<sched_setparam>(),\n"
5850 "I<sched_setscheduler>().\n"
5854 #: build/C/man7/posixoptions.7:643
5856 msgid "THR - _POSIX_THREADS - _SC_THREADS"
5860 #: build/C/man7/posixoptions.7:646
5862 "Basic support for POSIX threads is available. The following functions are "
5867 #: build/C/man7/posixoptions.7:698
5870 "I<pthread_atfork>(),\n"
5871 "I<pthread_attr_destroy>(),\n"
5872 "I<pthread_attr_getdetachstate>(),\n"
5873 "I<pthread_attr_getschedparam>(),\n"
5874 "I<pthread_attr_init>(),\n"
5875 "I<pthread_attr_setdetachstate>(),\n"
5876 "I<pthread_attr_setschedparam>(),\n"
5877 "I<pthread_cancel>(),\n"
5878 "I<pthread_cleanup_push>(),\n"
5879 "I<pthread_cleanup_pop>(),\n"
5880 "I<pthread_cond_broadcast>(),\n"
5881 "I<pthread_cond_destroy>(),\n"
5882 "I<pthread_cond_init>(),\n"
5883 "I<pthread_cond_signal>(),\n"
5884 "I<pthread_cond_timedwait>(),\n"
5885 "I<pthread_cond_wait>(),\n"
5886 "I<pthread_condattr_destroy>(),\n"
5887 "I<pthread_condattr_init>(),\n"
5888 "I<pthread_create>(),\n"
5889 "I<pthread_detach>(),\n"
5890 "I<pthread_equal>(),\n"
5891 "I<pthread_exit>(),\n"
5892 "I<pthread_getspecific>(),\n"
5893 "I<pthread_join>(),\n"
5894 "I<pthread_key_create>(),\n"
5895 "I<pthread_key_delete>(),\n"
5896 "I<pthread_mutex_destroy>(),\n"
5897 "I<pthread_mutex_init>(),\n"
5898 "I<pthread_mutex_lock>(),\n"
5899 "I<pthread_mutex_trylock>(),\n"
5900 "I<pthread_mutex_unlock>(),\n"
5901 "I<pthread_mutexattr_destroy>(),\n"
5902 "I<pthread_mutexattr_init>(),\n"
5903 "I<pthread_once>(),\n"
5904 "I<pthread_rwlock_destroy>(),\n"
5905 "I<pthread_rwlock_init>(),\n"
5906 "I<pthread_rwlock_rdlock>(),\n"
5907 "I<pthread_rwlock_tryrdlock>(),\n"
5908 "I<pthread_rwlock_trywrlock>(),\n"
5909 "I<pthread_rwlock_unlock>(),\n"
5910 "I<pthread_rwlock_wrlock>(),\n"
5911 "I<pthread_rwlockattr_destroy>(),\n"
5912 "I<pthread_rwlockattr_init>(),\n"
5913 "I<pthread_self>(),\n"
5914 "I<pthread_setcancelstate>(),\n"
5915 "I<pthread_setcanceltype>(),\n"
5916 "I<pthread_setspecific>(),\n"
5917 "I<pthread_testcancel>().\n"
5921 #: build/C/man7/posixoptions.7:701
5923 msgid "TMO - _POSIX_TIMEOUTS - _SC_TIMEOUTS"
5927 #: build/C/man7/posixoptions.7:714
5930 "I<mq_timedreceive>(),\n"
5931 "I<mq_timedsend>(),\n"
5932 "I<pthread_mutex_timedlock>(),\n"
5933 "I<pthread_rwlock_timedrdlock>(),\n"
5934 "I<pthread_rwlock_timedwrlock>(),\n"
5935 "I<sem_timedwait>(),\n"
5936 "I<posix_trace_timedgetnext_event>().\n"
5940 #: build/C/man7/posixoptions.7:717
5942 msgid "TMR - _POSIX_TIMERS - _SC_TIMERS"
5946 #: build/C/man7/posixoptions.7:732
5949 "I<clock_getres>(),\n"
5950 "I<clock_gettime>(),\n"
5951 "I<clock_settime>(),\n"
5953 "I<timer_create>(),\n"
5954 "I<timer_delete>(),\n"
5955 "I<timer_gettime>(),\n"
5956 "I<timer_getoverrun>(),\n"
5957 "I<timer_settime>().\n"
5961 #: build/C/man7/posixoptions.7:735
5963 msgid "TRC - _POSIX_TRACE - _SC_TRACE"
5967 #: build/C/man7/posixoptions.7:738
5968 msgid "POSIX tracing is available. The following functions are present:"
5972 #: build/C/man7/posixoptions.7:773
5975 "I<posix_trace_attr_destroy>(),\n"
5976 "I<posix_trace_attr_getclockres>(),\n"
5977 "I<posix_trace_attr_getcreatetime>(),\n"
5978 "I<posix_trace_attr_getgenversion>(),\n"
5979 "I<posix_trace_attr_getmaxdatasize>(),\n"
5980 "I<posix_trace_attr_getmaxsystemeventsize>(),\n"
5981 "I<posix_trace_attr_getmaxusereventsize>(),\n"
5982 "I<posix_trace_attr_getname>(),\n"
5983 "I<posix_trace_attr_getstreamfullpolicy>(),\n"
5984 "I<posix_trace_attr_getstreamsize>(),\n"
5985 "I<posix_trace_attr_init>(),\n"
5986 "I<posix_trace_attr_setmaxdatasize>(),\n"
5987 "I<posix_trace_attr_setname>(),\n"
5988 "I<posix_trace_attr_setstreamsize>(),\n"
5989 "I<posix_trace_attr_setstreamfullpolicy>(),\n"
5990 "I<posix_trace_clear>(),\n"
5991 "I<posix_trace_create>(),\n"
5992 "I<posix_trace_event>(),\n"
5993 "I<posix_trace_eventid_equal>(),\n"
5994 "I<posix_trace_eventid_get_name>(),\n"
5995 "I<posix_trace_eventid_open>(),\n"
5996 "I<posix_trace_eventtypelist_getnext_id>(),\n"
5997 "I<posix_trace_eventtypelist_rewind>(),\n"
5998 "I<posix_trace_flush>(),\n"
5999 "I<posix_trace_get_attr>(),\n"
6000 "I<posix_trace_get_status>(),\n"
6001 "I<posix_trace_getnext_event>(),\n"
6002 "I<posix_trace_shutdown>(),\n"
6003 "I<posix_trace_start>(),\n"
6004 "I<posix_trace_stop>(),\n"
6005 "I<posix_trace_trygetnext_event>().\n"
6009 #: build/C/man7/posixoptions.7:776
6011 msgid "TEF - _POSIX_TRACE_EVENT_FILTER - _SC_TRACE_EVENT_FILTER"
6015 #: build/C/man7/posixoptions.7:781 build/C/man7/posixoptions.7:816
6017 "This option implies the B<_POSIX_TRACE> option. The following functions are "
6022 #: build/C/man7/posixoptions.7:793
6025 "I<posix_trace_eventset_add>(),\n"
6026 "I<posix_trace_eventset_del>(),\n"
6027 "I<posix_trace_eventset_empty>(),\n"
6028 "I<posix_trace_eventset_fill>(),\n"
6029 "I<posix_trace_eventset_ismember>(),\n"
6030 "I<posix_trace_get_filter>(),\n"
6031 "I<posix_trace_set_filter>(),\n"
6032 "I<posix_trace_trid_eventid_open>().\n"
6036 #: build/C/man7/posixoptions.7:796
6038 msgid "TRI - _POSIX_TRACE_INHERIT - _SC_TRACE_INHERIT"
6042 #: build/C/man7/posixoptions.7:802
6044 "Tracing children of the traced process is supported. This option implies "
6045 "the B<_POSIX_TRACE> option. The following functions are present:"
6049 #: build/C/man7/posixoptions.7:808
6052 "I<posix_trace_attr_getinherited>(),\n"
6053 "I<posix_trace_attr_setinherited>().\n"
6057 #: build/C/man7/posixoptions.7:811
6059 msgid "TRL - _POSIX_TRACE_LOG - _SC_TRACE_LOG"
6063 #: build/C/man7/posixoptions.7:828
6066 "I<posix_trace_attr_getlogfullpolicy>(),\n"
6067 "I<posix_trace_attr_getlogsize>(),\n"
6068 "I<posix_trace_attr_setlogfullpolicy>(),\n"
6069 "I<posix_trace_attr_setlogsize>(),\n"
6070 "I<posix_trace_close>(),\n"
6071 "I<posix_trace_create_withlog>(),\n"
6072 "I<posix_trace_open>(),\n"
6073 "I<posix_trace_rewind>().\n"
6077 #: build/C/man7/posixoptions.7:831
6079 msgid "TYM - _POSIX_TYPED_MEMORY_OBJECTS - _SC_TYPED_MEMORY_OBJECT"
6083 #: build/C/man7/posixoptions.7:840
6086 "I<posix_mem_offset>(),\n"
6087 "I<posix_typed_mem_get_info>(),\n"
6088 "I<posix_typed_mem_open>().\n"
6092 #: build/C/man7/posixoptions.7:843
6094 msgid "--- - _POSIX_VDISABLE"
6098 #: build/C/man7/posixoptions.7:847
6100 "Always present (probably 0). Value to set a changeable special control "
6101 "character to indicate that it is disabled."
6105 #: build/C/man7/posixoptions.7:847
6107 msgid "XOPEN EXTENSIONS"
6112 #: build/C/man7/posixoptions.7:854
6114 "B<_XOPEN_CRYPT>, B<_XOPEN_LEGACY>, B<_XOPEN_REALTIME>, "
6115 "B<_XOPEN_REALTIME_THREADS>, B<_XOPEN_UNIX>."
6119 #: build/C/man7/posixoptions.7:857
6120 msgid "B<sysconf>(3), B<standards>(7)"
6124 #: build/C/man5/proc.5:62
6130 #: build/C/man5/proc.5:62
6136 #: build/C/man5/proc.5:65
6137 msgid "proc - process information pseudo-file system"
6141 #: build/C/man5/proc.5:74
6143 "The I<proc> file system is a pseudo-file system which is used as an "
6144 "interface to kernel data structures. It is commonly mounted at I</proc>. "
6145 "Most of it is read-only, but some files allow kernel variables to be "
6150 #: build/C/man5/proc.5:78
6151 msgid "The following outline gives a quick tour through the I</proc> hierarchy."
6155 #: build/C/man5/proc.5:79
6157 msgid "I</proc/[pid]>"
6160 #. FIXME Describe /proc/[pid]/attr and
6161 #. /proc/[pid]/task/[tid]/attr
6162 #. This is a directory
6166 #: build/C/man5/proc.5:91
6168 "There is a numerical subdirectory for each running process; the subdirectory "
6169 "is named by the process ID. Each such subdirectory contains the following "
6170 "pseudo-files and directories."
6174 #: build/C/man5/proc.5:91
6176 msgid "I</proc/[pid]/auxv> (since 2.6.0-test7)"
6180 #: build/C/man5/proc.5:98
6182 "This contains the contents of the ELF interpreter information passed to the "
6183 "process at exec time. The format is one I<unsigned long> ID plus one "
6184 "I<unsigned long> value for each entry. The last entry contains two zeros."
6188 #: build/C/man5/proc.5:98
6190 msgid "I</proc/[pid]/cgroup> (since Linux 2.6.24)"
6193 #. Info in Documentation/cgroups/cgroups.txt
6195 #: build/C/man5/proc.5:104
6197 "This file describes control groups to which the process/task belongs. For "
6198 "each cgroup hierarchy there is one entry containing colon-separated fields "
6203 #: build/C/man5/proc.5:108
6205 msgid "CW< 5:cpuacct,cpu,cpuset:/daemons>\n"
6209 #: build/C/man5/proc.5:112
6210 msgid "The colon-separated fields are, from left to right:"
6214 #: build/C/man5/proc.5:113
6220 #: build/C/man5/proc.5:115
6221 msgid "hierarchy ID number"
6225 #: build/C/man5/proc.5:115
6231 #: build/C/man5/proc.5:117
6232 msgid "set of subsystems bound to the hierarchy"
6236 #: build/C/man5/proc.5:117
6242 #: build/C/man5/proc.5:119
6243 msgid "control group in the hierarchy to which the process belongs"
6247 #. FIXME Describe /proc/[pid]/clear_refs
6249 #. "Clears page referenced bits shown in smaps output"
6251 #. CONFIG_PROC_PAGE_MONITOR
6253 #: build/C/man5/proc.5:130
6255 "This file is only present if the B<CONFIG_CGROUPS> kernel configuration "
6256 "option is enabled."
6260 #: build/C/man5/proc.5:130
6262 msgid "I</proc/[pid]/cmdline>"
6265 #. In 2.3.26, this also used to be true if the process was swapped out.
6267 #: build/C/man5/proc.5:140
6269 "This holds the complete command line for the process, unless the process is "
6270 "a zombie. In the latter case, there is nothing in this file: that is, a "
6271 "read on this file will return 0 characters. The command-line arguments "
6272 "appear in this file as a set of strings separated by null bytes "
6273 "(\\(aq\\e0\\(aq), with a further null byte after the last string."
6277 #: build/C/man5/proc.5:140
6279 msgid "I</proc/[pid]/coredump_filter> (since kernel 2.6.23)"
6283 #: build/C/man5/proc.5:144 build/C/man5/proc.5:2582 build/C/man5/proc.5:2586
6284 msgid "See B<core>(5)."
6288 #: build/C/man5/proc.5:144
6290 msgid "I</proc/[pid]/cpuset> (since kernel 2.6.12)"
6293 #. and/proc/[pid]/task/[tid]/cpuset
6295 #: build/C/man5/proc.5:149
6296 msgid "See B<cpuset>(7)."
6300 #: build/C/man5/proc.5:149
6302 msgid "I</proc/[pid]/cwd>"
6306 #: build/C/man5/proc.5:154
6308 "This is a symbolic link to the current working directory of the process. To "
6309 "find out the current working directory of process 20, for instance, you can "
6314 #: build/C/man5/proc.5:158
6316 msgid "$B< cd /proc/20/cwd; /bin/pwd>\n"
6320 #: build/C/man5/proc.5:169
6322 "Note that the I<pwd> command is often a shell built-in, and might not work "
6323 "properly. In B<bash>(1), you may use I<pwd\\ -P>."
6326 #. The following was still true as at kernel 2.6.13
6327 #. FIXME Describe /proc/[pid]/seccomp
6329 #. FIXME Describe /proc/[pid]/sessionid
6330 #. Added in 2.6.25; read-only; only readable by real UID
6331 #. CONFIG_AUDITSYSCALL
6332 #. FIXME Describe /proc/[pid]/sched
6334 #. CONFIG_SCHED_DEBUG, and additional fields if CONFIG_SCHEDSTATS
6335 #. Displays various scheduling parameters
6336 #. This file can be written, to reset stats
6337 #. FIXME Describe /proc/[pid]/schedstats and
6338 #. /proc/[pid]/task/[tid]/schedstats
6340 #. CONFIG_SCHEDSTATS
6342 #: build/C/man5/proc.5:175 build/C/man5/proc.5:727
6344 "In a multithreaded process, the contents of this symbolic link are not "
6345 "available if the main thread has already terminated (typically by calling "
6346 "B<pthread_exit>(3))."
6350 #: build/C/man5/proc.5:175
6352 msgid "I</proc/[pid]/environ>"
6356 #: build/C/man5/proc.5:181
6358 "This file contains the environment for the process. The entries are "
6359 "separated by null bytes (\\(aq\\e0\\(aq), and there may be a null byte at "
6360 "the end. Thus, to print out the environment of process 1, you would do:"
6364 #: build/C/man5/proc.5:186
6366 msgid "$B< (cat /proc/1/environ; echo) | tr \\(aq\\e000\\(aq \\(aq\\en\\(aq>\n"
6370 #: build/C/man5/proc.5:189
6372 msgid "I</proc/[pid]/exe>"
6375 #. The following was still true as at kernel 2.6.13
6377 #: build/C/man5/proc.5:204
6379 "Under Linux 2.2 and later, this file is a symbolic link containing the "
6380 "actual pathname of the executed command. This symbolic link can be "
6381 "dereferenced normally; attempting to open it will open the executable. You "
6382 "can even type I</proc/[pid]/exe> to run another copy of the same executable "
6383 "as is being run by process [pid]. In a multithreaded process, the contents "
6384 "of this symbolic link are not available if the main thread has already "
6385 "terminated (typically by calling B<pthread_exit>(3))."
6389 #: build/C/man5/proc.5:212
6391 "Under Linux 2.0 and earlier I</proc/[pid]/exe> is a pointer to the binary "
6392 "which was executed, and appears as a symbolic link. A B<readlink>(2) call "
6393 "on this file under Linux 2.0 returns a string in the format:"
6397 #: build/C/man5/proc.5:214
6399 msgid " [device]:inode\n"
6403 #: build/C/man5/proc.5:217
6405 "For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, MFM, "
6406 "etc. drives) minor 01 (first partition on the first drive)."
6410 #: build/C/man5/proc.5:222
6411 msgid "B<find>(1) with the I<-inum> option can be used to locate the file."
6415 #: build/C/man5/proc.5:222
6417 msgid "I</proc/[pid]/fd>"
6421 #: build/C/man5/proc.5:228
6423 "This is a subdirectory containing one entry for each file which the process "
6424 "has open, named by its file descriptor, and which is a symbolic link to the "
6425 "actual file. Thus, 0 is standard input, 1 standard output, 2 standard "
6429 #. The following was still true as at kernel 2.6.13
6431 #: build/C/man5/proc.5:234
6433 "In a multithreaded process, the contents of this directory are not available "
6434 "if the main thread has already terminated (typically by calling "
6435 "B<pthread_exit>(3))."
6439 #: build/C/man5/proc.5:247
6441 "Programs that will take a filename as a command-line argument, but will not "
6442 "take input from standard input if no argument is supplied, or that write to "
6443 "a file named as a command-line argument, but will not send their output to "
6444 "standard output if no argument is supplied, can nevertheless be made to use "
6445 "standard input or standard out using I</proc/[pid]/fd>. For example, "
6446 "assuming that I<-i> is the flag designating an input file and I<-o> is the "
6447 "flag designating an output file:"
6451 #: build/C/man5/proc.5:251
6453 msgid "$B< foobar -i /proc/self/fd/0 -o /proc/self/fd/1 ...>\n"
6456 #. The following is not true in my tests (MTK):
6457 #. Note that this will not work for
6458 #. programs that seek on their files, as the files in the fd directory
6459 #. are not seekable.
6461 #: build/C/man5/proc.5:259
6462 msgid "and you have a working filter."
6466 #: build/C/man5/proc.5:269
6468 "I</proc/self/fd/N> is approximately the same as I</dev/fd/N> in some UNIX "
6469 "and UNIX-like systems. Most Linux MAKEDEV scripts symbolically link "
6470 "I</dev/fd> to I</proc/self/fd>, in fact."
6474 #: build/C/man5/proc.5:283
6476 "Most systems provide symbolic links I</dev/stdin>, I</dev/stdout>, and "
6477 "I</dev/stderr>, which respectively link to the files I<0>, I<1>, and I<2> in "
6478 "I</proc/self/fd>. Thus the example command above could be written as:"
6482 #: build/C/man5/proc.5:287
6484 msgid "$B< foobar -i /dev/stdin -o /dev/stdout ...>\n"
6488 #: build/C/man5/proc.5:292
6490 msgid "I</proc/[pid]/fdinfo/> (since kernel 2.6.22)"
6494 #: build/C/man5/proc.5:298
6496 "This is a subdirectory containing one entry for each file which the process "
6497 "has open, named by its file descriptor. The contents of each file can be "
6498 "read to obtain information about the corresponding file descriptor, for "
6503 #: build/C/man5/proc.5:304
6506 "$B< cat /proc/12015/fdinfo/4>\n"
6512 #: build/C/man5/proc.5:315
6514 "The I<pos> field is a decimal number showing the current file offset. The "
6515 "I<flags> field is an octal number that displays the file access mode and "
6516 "file status flags (see B<open>(2))."
6519 #. FIXME document /proc/[pid]/io
6521 #. .IR /proc/[pid]/io " (since kernel 2.6.20)"
6523 #: build/C/man5/proc.5:320
6524 msgid "The files in this directory are readable only by the owner of the process."
6528 #: build/C/man5/proc.5:320
6530 msgid "I</proc/[pid]/limits> (since kernel 2.6.24)"
6533 #. commit 3036e7b490bf7878c6dae952eec5fb87b1106589
6535 #: build/C/man5/proc.5:330
6537 "This file displays the soft limit, hard limit, and units of measurement for "
6538 "each of the process's resource limits (see B<getrlimit>(2)). Up to and "
6539 "including Linux 2.6.35, this file is protected to only allow reading by the "
6540 "real UID of the process. Since Linux 2.6.36, this file is readable by all "
6541 "users on the system."
6545 #: build/C/man5/proc.5:330
6547 msgid "I</proc/[pid]/maps>"
6551 #: build/C/man5/proc.5:334
6553 "A file containing the currently mapped memory regions and their access "
6558 #: build/C/man5/proc.5:336
6559 msgid "The format is:"
6563 #: build/C/man5/proc.5:349
6566 "CW<address perms offset dev inode pathname\n"
6567 "08048000-08056000 r-xp 00000000 03:0c 64593 /usr/sbin/gpm\n"
6568 "08056000-08058000 rw-p 0000d000 03:0c 64593 /usr/sbin/gpm\n"
6569 "08058000-0805b000 rwxp 00000000 00:00 0\n"
6570 "40000000-40013000 r-xp 00000000 03:0c 4165 /lib/ld-2.2.4.so\n"
6571 "40013000-40015000 rw-p 00012000 03:0c 4165 /lib/ld-2.2.4.so\n"
6572 "4001f000-40135000 r-xp 00000000 03:0c 45494 /lib/libc-2.2.4.so\n"
6573 "40135000-4013e000 rw-p 00115000 03:0c 45494 /lib/libc-2.2.4.so\n"
6574 "4013e000-40142000 rw-p 00000000 00:00 0\n"
6575 "bffff000-c0000000 rwxp 00000000 00:00 0>\n"
6579 #: build/C/man5/proc.5:354
6581 "where \"address\" is the address space in the process that it occupies, "
6582 "\"perms\" is a set of permissions:"
6586 #: build/C/man5/proc.5:362
6593 "p = private (copy on write)\n"
6597 #: build/C/man5/proc.5:369
6599 "\"offset\" is the offset into the file/whatever, \"dev\" is the device "
6600 "(major:minor), and \"inode\" is the inode on that device. 0 indicates that "
6601 "no inode is associated with the memory region, as the case would be with BSS "
6602 "(uninitialized data)."
6606 #: build/C/man5/proc.5:371
6607 msgid "Under Linux 2.0 there is no field giving pathname."
6611 #: build/C/man5/proc.5:371
6613 msgid "I</proc/[pid]/mem>"
6617 #: build/C/man5/proc.5:378
6619 "This file can be used to access the pages of a process's memory through "
6620 "B<open>(2), B<read>(2), and B<lseek>(2)."
6624 #: build/C/man5/proc.5:378
6626 msgid "I</proc/[pid]/mountinfo> (since Linux 2.6.26)"
6629 #. This info adapted from Documentation/filesystems/proc.txt
6631 #: build/C/man5/proc.5:383
6633 "This file contains information about mount points. It contains lines of the "
6638 #: build/C/man5/proc.5:388
6641 "CW<36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root "
6642 "rw,errors=continue\n"
6643 "(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)>\n"
6647 #: build/C/man5/proc.5:392
6648 msgid "The numbers in parentheses are labels for the descriptions below:"
6652 #: build/C/man5/proc.5:393 build/C/man5/proc.5:486
6658 #: build/C/man5/proc.5:397
6659 msgid "mount ID: unique identifier of the mount (may be reused after B<umount>(2))."
6663 #: build/C/man5/proc.5:397 build/C/man5/proc.5:490
6669 #: build/C/man5/proc.5:400
6670 msgid "parent ID: ID of parent mount (or of self for the top of the mount tree)."
6674 #: build/C/man5/proc.5:400 build/C/man5/proc.5:493
6680 #: build/C/man5/proc.5:406
6681 msgid "major:minor: value of I<st_dev> for files on file system (see B<stat>(2))."
6685 #: build/C/man5/proc.5:406 build/C/man5/proc.5:496
6691 #: build/C/man5/proc.5:409
6692 msgid "root: root of the mount within the file system."
6696 #: build/C/man5/proc.5:409
6702 #: build/C/man5/proc.5:412
6703 msgid "mount point: mount point relative to the process's root."
6707 #: build/C/man5/proc.5:412
6713 #: build/C/man5/proc.5:415
6714 msgid "mount options: per-mount options."
6718 #: build/C/man5/proc.5:415
6724 #: build/C/man5/proc.5:418
6725 msgid "optional fields: zero or more fields of the form \"tag[:value]\"."
6729 #: build/C/man5/proc.5:418
6735 #: build/C/man5/proc.5:421
6736 msgid "separator: marks the end of the optional fields."
6740 #: build/C/man5/proc.5:421
6746 #: build/C/man5/proc.5:424
6747 msgid "file system type: name of file system in the form \"type[.subtype]\"."
6751 #: build/C/man5/proc.5:424
6757 #: build/C/man5/proc.5:427
6758 msgid "mount source: file system-specific information or \"none\"."
6762 #: build/C/man5/proc.5:427
6768 #: build/C/man5/proc.5:430
6769 msgid "super options: per-super block options."
6773 #: build/C/man5/proc.5:434
6775 "Parsers should ignore all unrecognized optional fields. Currently the "
6776 "possible optional fields are:"
6780 #: build/C/man5/proc.5:435
6786 #: build/C/man5/proc.5:438
6787 msgid "mount is shared in peer group X"
6791 #: build/C/man5/proc.5:438
6797 #: build/C/man5/proc.5:441
6798 msgid "mount is slave to peer group X"
6802 #: build/C/man5/proc.5:441
6804 msgid "propagate_from:X"
6808 #: build/C/man5/proc.5:444
6809 msgid "mount is slave and receives propagation from peer group X (*)"
6813 #: build/C/man5/proc.5:444
6819 #: build/C/man5/proc.5:447
6820 msgid "mount is unbindable"
6824 #: build/C/man5/proc.5:454
6826 "(*) X is the closest dominant peer group under the process's root. If X is "
6827 "the immediate master of the mount, or if there is no dominant peer group "
6828 "under the same root, then only the \"master:X\" field is present and not the "
6829 "\"propagate_from:X\" field."
6833 #: build/C/man5/proc.5:458
6835 "For more information on mount propagation see: "
6836 "I<Documentation/filesystems/sharedsubtree.txt> in the Linux kernel source "
6841 #: build/C/man5/proc.5:458
6843 msgid "I</proc/[pid]/mounts> (since Linux 2.4.19)"
6847 #: build/C/man5/proc.5:473
6849 "This is a list of all the file systems currently mounted in the process's "
6850 "mount namespace. The format of this file is documented in B<fstab>(5). "
6851 "Since kernel version 2.6.15, this file is pollable: after opening the file "
6852 "for reading, a change in this file (i.e., a file system mount or unmount) "
6853 "causes B<select>(2) to mark the file descriptor as readable, and B<poll>(2) "
6854 "and B<epoll_wait>(2) mark the file as having an error condition."
6858 #: build/C/man5/proc.5:473
6860 msgid "I</proc/[pid]/mountstats> (since Linux 2.6.17)"
6864 #: build/C/man5/proc.5:478
6866 "This file exports information (statistics, configuration information) about "
6867 "the mount points in the process's name space. Lines in this file have the "
6872 #: build/C/man5/proc.5:482
6875 "device /dev/sda7 mounted on /home with fstype ext3 [statistics]\n"
6876 "( 1 ) ( 2 ) (3 ) (4)\n"
6880 #: build/C/man5/proc.5:485
6881 msgid "The fields in each line are:"
6885 #: build/C/man5/proc.5:490
6887 "The name of the mounted device (or \"nodevice\" if there is no corresponding "
6892 #: build/C/man5/proc.5:493
6893 msgid "The mount point within the file system tree."
6897 #: build/C/man5/proc.5:496
6898 msgid "The file system type."
6902 #: build/C/man5/proc.5:501
6904 "Optional statistics and configuration information. Currently (as at Linux "
6905 "2.6.26), only NFS file systems export information via this field."
6909 #: build/C/man5/proc.5:504
6910 msgid "This file is only readable by the owner of the process."
6914 #: build/C/man5/proc.5:504
6916 msgid "I</proc/[pid]/ns/> (since Linux 3.0)"
6919 #. See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f
6921 #: build/C/man5/proc.5:512
6923 "This is a subdirectory containing one entry for each namespace that supports "
6924 "being manipulated by B<setns>(2). For information about namespaces, see "
6929 #: build/C/man5/proc.5:512
6931 msgid "I</proc/[pid]/ns/ipc> (since Linux 3.0)"
6935 #: build/C/man5/proc.5:520
6937 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6938 "filesystem keeps the IPC namespace of the process specified by I<pid> alive "
6939 "even if all processes currently in the namespace terminate."
6943 #: build/C/man5/proc.5:529
6945 "Opening this file returns a file handle for the IPC namespace of the process "
6946 "specified by I<pid>. As long as this file descriptor remains open, the IPC "
6947 "namespace will remain alive, even if all processes in the namespace "
6948 "terminate. The file descriptor can be passed to B<setns>(2)."
6952 #: build/C/man5/proc.5:529
6954 msgid "I</proc/[pid]/ns/net> (since Linux 3.0)"
6958 #: build/C/man5/proc.5:537
6960 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6961 "filesystem keeps the network namespace of the process specified by I<pid> "
6962 "alive even if all processes in the namespace terminate."
6966 #: build/C/man5/proc.5:546
6968 "Opening this file returns a file handle for the network namespace of the "
6969 "process specified by I<pid>. As long as this file descriptor remains open, "
6970 "the network namespace will remain alive, even if all processes in the "
6971 "namespace terminate. The file descriptor can be passed to B<setns>(2)."
6975 #: build/C/man5/proc.5:546
6977 msgid "I</proc/[pid]/ns/uts> (since Linux 3.0)"
6981 #: build/C/man5/proc.5:554
6983 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6984 "filesystem keeps the UTS namespace of the process specified by I<pid> alive "
6985 "even if all processes currently in the namespace terminate."
6989 #: build/C/man5/proc.5:563
6991 "Opening this file returns a file handle for the UTS namespace of the process "
6992 "specified by I<pid>. As long as this file descriptor remains open, the UTS "
6993 "namespace will remain alive, even if all processes in the namespace "
6994 "terminate. The file descriptor can be passed to B<setns>(2)."
6998 #: build/C/man5/proc.5:563
7000 msgid "I</proc/[pid]/numa_maps> (since Linux 2.6.14)"
7004 #: build/C/man5/proc.5:567
7005 msgid "See B<numa>(7)."
7009 #: build/C/man5/proc.5:567
7011 msgid "I</proc/[pid]/oom_adj> (since Linux 2.6.11)"
7015 #: build/C/man5/proc.5:580
7017 "This file can be used to adjust the score used to select which process "
7018 "should be killed in an out-of-memory (OOM) situation. The kernel uses this "
7019 "value for a bit-shift operation of the process's I<oom_score> value: valid "
7020 "values are in the range -16 to +15, plus the special value -17, which "
7021 "disables OOM-killing altogether for this process. A positive score "
7022 "increases the likelihood of this process being killed by the OOM-killer; a "
7023 "negative score decreases the likelihood."
7027 #: build/C/man5/proc.5:588
7029 "The default value for this file is 0; a new process inherits its parent's "
7030 "I<oom_adj> setting. A process must be privileged (B<CAP_SYS_RESOURCE>) to "
7035 #: build/C/man5/proc.5:591
7037 "Since Linux 2.6.36, use of this file is deprecated in favor of "
7038 "I</proc/[pid]/oom_score_adj>."
7042 #: build/C/man5/proc.5:591
7044 msgid "I</proc/[pid]/oom_score> (since Linux 2.6.11)"
7047 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
7048 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
7050 #: build/C/man5/proc.5:602
7052 "This file displays the current score that the kernel gives to this process "
7053 "for the purpose of selecting a process for the OOM-killer. A higher score "
7054 "means that the process is more likely to be selected by the OOM-killer. The "
7055 "basis for this score is the amount of memory used by the process, with "
7056 "increases (+) or decreases (-) for factors including:"
7060 #: build/C/man5/proc.5:607
7061 msgid "whether the process creates a lot of children using B<fork>(2) (+);"
7065 #: build/C/man5/proc.5:610
7067 "whether the process has been running a long time, or has used a lot of CPU "
7072 #: build/C/man5/proc.5:612
7073 msgid "whether the process has a low nice value (i.e., E<gt> 0) (+);"
7076 #. More precisely, if it has CAP_SYS_ADMIN or CAP_SYS_RESOURCE
7078 #: build/C/man5/proc.5:615
7079 msgid "whether the process is privileged (-); and"
7082 #. More precisely, if it has CAP_SYS_RAWIO
7084 #: build/C/man5/proc.5:618
7085 msgid "whether the process is making direct hardware access (-)."
7089 #: build/C/man5/proc.5:627
7091 "The I<oom_score> also reflects the adjustment specified by the "
7092 "I<oom_score_adj> or I<oom_adj> setting for the process."
7096 #: build/C/man5/proc.5:627
7098 msgid "I</proc/[pid]/oom_score_adj> (since Linux 2.6.36)"
7101 #. Text taken from 3.7 Documentation/filesystems/proc.txt
7103 #: build/C/man5/proc.5:632
7105 "This file can be used to adjust the badness heuristic used to select which "
7106 "process gets killed in out-of-memory conditions."
7110 #: build/C/man5/proc.5:641
7112 "The badness heuristic assigns a value to each candidate task ranging from 0 "
7113 "(never kill) to 1000 (always kill) to determine which process is targeted. "
7114 "The units are roughly a proportion along that range of allowed memory the "
7115 "process may allocate from, based on an estimation of its current memory and "
7116 "swap use. For example, if a task is using all allowed memory, its badness "
7117 "score will be 1000. If it is using half of its allowed memory, its score "
7122 #: build/C/man5/proc.5:644
7124 "There is an additional factor included in the badness score: root processes "
7125 "are given 3% extra memory over other tasks."
7129 #: build/C/man5/proc.5:658
7131 "The amount of \"allowed\" memory depends on the context in which the "
7132 "OOM-killer was called. If it is due to the memory assigned to the "
7133 "allocating task's cpuset being exhausted, the allowed memory represents the "
7134 "set of mems assigned to that cpuset (see B<cpuset>(7)). If it is due to a "
7135 "mempolicy's node(s) being exhausted, the allowed memory represents the set "
7136 "of mempolicy nodes. If it is due to a memory limit (or swap limit) being "
7137 "reached, the allowed memory is that configured limit. Finally, if it is due "
7138 "to the entire system being out of memory, the allowed memory represents all "
7139 "allocatable resources."
7143 #: build/C/man5/proc.5:671
7145 "The value of I<oom_score_adj> is added to the badness score before it is "
7146 "used to determine which task to kill. Acceptable values range from -1000 "
7147 "(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). This allows user space to "
7148 "control the preference for OOM-killing, ranging from always preferring a "
7149 "certain task or completely disabling it from OOM-killing. The lowest "
7150 "possible value, -1000, is equivalent to disabling OOM-killing entirely for "
7151 "that task, since it will always report a badness score of 0."
7155 #: build/C/man5/proc.5:683
7157 "Consequently, it is very simple for user space to define the amount of "
7158 "memory to consider for each task. Setting a I<oom_score_adj> value of +500, "
7159 "for example, is roughly equivalent to allowing the remainder of tasks "
7160 "sharing the same system, cpuset, mempolicy, or memory controller resources "
7161 "to use at least 50% more memory. A value of -500, on the other hand, would "
7162 "be roughly equivalent to discounting 50% of the task's allowed memory from "
7163 "being considered as scoring against the task."
7167 #: build/C/man5/proc.5:690
7169 "For backward compatibility with previous kernels, I</proc/[pid]/oom_adj> can "
7170 "still be used to tune the badness score. Its value is scaled linearly with "
7174 #. FIXME Describe /proc/[pid]/pagemap
7176 #. CONFIG_PROC_PAGE_MONITOR
7178 #: build/C/man5/proc.5:699
7180 "Writing to I</proc/[pid]/oom_score_adj> or I</proc/[pid]/oom_adj> will "
7181 "change the other with its scaled value."
7185 #: build/C/man5/proc.5:699
7187 msgid "I</proc/[pid]/root>"
7191 #: build/C/man5/proc.5:707
7193 "UNIX and Linux support the idea of a per-process root of the file system, "
7194 "set by the B<chroot>(2) system call. This file is a symbolic link that "
7195 "points to the process's root directory, and behaves as exe, fd/*, etc. do."
7199 #: build/C/man5/proc.5:727
7201 msgid "I</proc/[pid]/smaps> (since Linux 2.6.14)"
7204 #. CONFIG_PROC_PAGE_MONITOR
7206 #: build/C/man5/proc.5:732
7208 "This file shows memory consumption for each of the process's mappings. For "
7209 "each of mappings there is a series of lines such as the following:"
7213 #: build/C/man5/proc.5:742
7216 "08048000-080bc000 r-xp 00000000 03:02 13130 /bin/bash\n"
7219 "Shared_Clean: 424 kB\n"
7220 "Shared_Dirty: 0 kB\n"
7221 "Private_Clean: 0 kB\n"
7222 "Private_Dirty: 0 kB\n"
7226 #: build/C/man5/proc.5:752
7228 "The first of these lines shows the same information as is displayed for the "
7229 "mapping in I</proc/[pid]/maps>. The remaining lines show the size of the "
7230 "mapping, the amount of the mapping that is currently resident in RAM, the "
7231 "number of clean and dirty shared pages in the mapping, and the number of "
7232 "clean and dirty private pages in the mapping."
7236 #: build/C/man5/proc.5:757
7238 "This file is only present if the B<CONFIG_MMU> kernel configuration option "
7243 #: build/C/man5/proc.5:757
7245 msgid "I</proc/[pid]/stat>"
7249 #: build/C/man5/proc.5:764
7251 "Status information about the process. This is used by B<ps>(1). It is "
7252 "defined in I</usr/src/linux/fs/proc/array.c>."
7256 #: build/C/man5/proc.5:768
7257 msgid "The fields, in order, with their proper B<scanf>(3) format specifiers, are:"
7261 #: build/C/man5/proc.5:769
7267 #: build/C/man5/proc.5:772
7268 msgid "(1) The process ID."
7272 #: build/C/man5/proc.5:772
7278 #: build/C/man5/proc.5:776
7280 "(2) The filename of the executable, in parentheses. This is visible whether "
7281 "or not the executable is swapped out."
7285 #: build/C/man5/proc.5:776
7291 #: build/C/man5/proc.5:782
7293 "(3) One character from the string \"RSDZTW\" where R is running, S is "
7294 "sleeping in an interruptible wait, D is waiting in uninterruptible disk "
7295 "sleep, Z is zombie, T is traced or stopped (on a signal), and W is paging."
7299 #: build/C/man5/proc.5:782
7305 #: build/C/man5/proc.5:785
7306 msgid "(4) The PID of the parent."
7310 #: build/C/man5/proc.5:785
7316 #: build/C/man5/proc.5:788
7317 msgid "(5) The process group ID of the process."
7321 #: build/C/man5/proc.5:788
7323 msgid "I<session> %d"
7327 #: build/C/man5/proc.5:791
7328 msgid "(6) The session ID of the process."
7332 #: build/C/man5/proc.5:791
7334 msgid "I<tty_nr> %d"
7338 #: build/C/man5/proc.5:797
7340 "(7) The controlling terminal of the process. (The minor device number is "
7341 "contained in the combination of bits 31 to 20 and 7 to 0; the major device "
7342 "number is in bits 15 to 8.)"
7346 #: build/C/man5/proc.5:797
7351 #. This field and following, up to and including wchan added 0.99.1
7353 #: build/C/man5/proc.5:802
7355 "(8) The ID of the foreground process group of the controlling terminal of "
7360 #: build/C/man5/proc.5:802
7362 msgid "I<flags> %u (%lu before Linux 2.6.22)"
7366 #: build/C/man5/proc.5:809
7368 "(9) The kernel flags word of the process. For bit meanings, see the PF_* "
7369 "defines in the Linux kernel source file I<include/linux/sched.h>. Details "
7370 "depend on the kernel version."
7374 #: build/C/man5/proc.5:809
7376 msgid "I<minflt> %lu"
7380 #: build/C/man5/proc.5:813
7382 "(10) The number of minor faults the process has made which have not required "
7383 "loading a memory page from disk."
7388 #: build/C/man5/proc.5:813
7390 msgid "I<cminflt> %lu"
7394 #: build/C/man5/proc.5:818
7396 "(11) The number of minor faults that the process's waited-for children have "
7401 #: build/C/man5/proc.5:818
7403 msgid "I<majflt> %lu"
7407 #: build/C/man5/proc.5:822
7409 "(12) The number of major faults the process has made which have required "
7410 "loading a memory page from disk."
7414 #: build/C/man5/proc.5:822
7416 msgid "I<cmajflt> %lu"
7420 #: build/C/man5/proc.5:826
7422 "(13) The number of major faults that the process's waited-for children have "
7427 #: build/C/man5/proc.5:826
7429 msgid "I<utime> %lu"
7433 #: build/C/man5/proc.5:835
7435 "(14) Amount of time that this process has been scheduled in user mode, "
7436 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>). This includes "
7437 "guest time, I<guest_time> (time spent running a virtual CPU, see below), so "
7438 "that applications that are not aware of the guest time field do not lose "
7439 "that time from their calculations."
7443 #: build/C/man5/proc.5:835
7445 msgid "I<stime> %lu"
7449 #: build/C/man5/proc.5:840
7451 "(15) Amount of time that this process has been scheduled in kernel mode, "
7452 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
7456 #: build/C/man5/proc.5:840
7458 msgid "I<cutime> %ld"
7462 #: build/C/man5/proc.5:850
7464 "(16) Amount of time that this process's waited-for children have been "
7465 "scheduled in user mode, measured in clock ticks (divide by "
7466 "I<sysconf(_SC_CLK_TCK)>). (See also B<times>(2).) This includes guest "
7467 "time, I<cguest_time> (time spent running a virtual CPU, see below)."
7471 #: build/C/man5/proc.5:850
7473 msgid "I<cstime> %ld"
7477 #: build/C/man5/proc.5:856
7479 "(17) Amount of time that this process's waited-for children have been "
7480 "scheduled in kernel mode, measured in clock ticks (divide by "
7481 "I<sysconf(_SC_CLK_TCK)>)."
7485 #: build/C/man5/proc.5:856
7487 msgid "I<priority> %ld"
7491 #: build/C/man5/proc.5:873
7493 "(18) (Explanation for Linux 2.6) For processes running a real-time "
7494 "scheduling policy (I<policy> below; see B<sched_setscheduler>(2)), this is "
7495 "the negated scheduling priority, minus one; that is, a number in the range "
7496 "-2 to -100, corresponding to real-time priorities 1 to 99. For processes "
7497 "running under a non-real-time scheduling policy, this is the raw nice value "
7498 "(B<setpriority>(2)) as represented in the kernel. The kernel stores nice "
7499 "values as numbers in the range 0 (high) to 39 (low), corresponding to the "
7500 "user-visible nice range of -20 to 19."
7503 #. And back in kernel 1.2 days things were different again.
7505 #: build/C/man5/proc.5:877
7507 "Before Linux 2.6, this was a scaled value based on the scheduler weighting "
7508 "given to this process."
7512 #: build/C/man5/proc.5:877
7517 #. Back in kernel 1.2 days things were different.
7519 #. \fIcounter\fP %ld
7520 #. The current maximum size in jiffies of the process's next timeslice,
7521 #. or what is currently left of its current timeslice, if it is the
7522 #. currently running process.
7525 #. The time in jiffies of the process's next timeout.
7526 #. timeout was removed sometime around 2.1/2.2
7528 #: build/C/man5/proc.5:892
7530 "(19) The nice value (see B<setpriority>(2)), a value in the range 19 (low "
7531 "priority) to -20 (high priority)."
7535 #: build/C/man5/proc.5:892
7537 msgid "I<num_threads> %ld"
7541 #: build/C/man5/proc.5:897
7543 "(20) Number of threads in this process (since Linux 2.6). Before kernel "
7544 "2.6, this field was hard coded to 0 as a placeholder for an earlier removed "
7550 #: build/C/man5/proc.5:897
7552 msgid "I<itrealvalue> %ld"
7556 #: build/C/man5/proc.5:905
7558 "(21) The time in jiffies before the next B<SIGALRM> is sent to the process "
7559 "due to an interval timer. Since kernel 2.6.17, this field is no longer "
7560 "maintained, and is hard coded as 0."
7564 #: build/C/man5/proc.5:905
7566 msgid "I<starttime> %llu (was %lu before Linux 2.6)"
7570 #: build/C/man5/proc.5:911
7572 "(22) The time the process started after system boot. In kernels before "
7573 "Linux 2.6, this value was expressed in jiffies. Since Linux 2.6, the value "
7574 "is expressed in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
7578 #: build/C/man5/proc.5:911
7580 msgid "I<vsize> %lu"
7584 #: build/C/man5/proc.5:914
7585 msgid "(23) Virtual memory size in bytes."
7589 #: build/C/man5/proc.5:914
7595 #: build/C/man5/proc.5:921
7597 "(24) Resident Set Size: number of pages the process has in real memory. "
7598 "This is just the pages which count toward text, data, or stack space. This "
7599 "does not include pages which have not been demand-loaded in, or which are "
7604 #: build/C/man5/proc.5:921
7606 msgid "I<rsslim> %lu"
7610 #: build/C/man5/proc.5:928
7612 "(25) Current soft limit in bytes on the rss of the process; see the "
7613 "description of B<RLIMIT_RSS> in B<getrlimit>(2)."
7617 #: build/C/man5/proc.5:928
7619 msgid "I<startcode> %lu"
7623 #: build/C/man5/proc.5:931
7624 msgid "(26) The address above which program text can run."
7628 #: build/C/man5/proc.5:931
7630 msgid "I<endcode> %lu"
7634 #: build/C/man5/proc.5:934
7635 msgid "(27) The address below which program text can run."
7639 #: build/C/man5/proc.5:934
7641 msgid "I<startstack> %lu"
7645 #: build/C/man5/proc.5:937
7646 msgid "(28) The address of the start (i.e., bottom) of the stack."
7650 #: build/C/man5/proc.5:937
7652 msgid "I<kstkesp> %lu"
7656 #: build/C/man5/proc.5:941
7658 "(29) The current value of ESP (stack pointer), as found in the kernel stack "
7659 "page for the process."
7663 #: build/C/man5/proc.5:941
7665 msgid "I<kstkeip> %lu"
7669 #: build/C/man5/proc.5:944
7670 msgid "(30) The current EIP (instruction pointer)."
7675 #: build/C/man5/proc.5:944
7677 msgid "I<signal> %lu"
7681 #: build/C/man5/proc.5:951
7683 "(31) The bitmap of pending signals, displayed as a decimal number. "
7684 "Obsolete, because it does not provide information on real-time signals; use "
7685 "I</proc/[pid]/status> instead."
7689 #: build/C/man5/proc.5:951
7691 msgid "I<blocked> %lu"
7695 #: build/C/man5/proc.5:957
7697 "(32) The bitmap of blocked signals, displayed as a decimal number. "
7698 "Obsolete, because it does not provide information on real-time signals; use "
7699 "I</proc/[pid]/status> instead."
7703 #: build/C/man5/proc.5:957
7705 msgid "I<sigignore> %lu"
7709 #: build/C/man5/proc.5:963
7711 "(33) The bitmap of ignored signals, displayed as a decimal number. "
7712 "Obsolete, because it does not provide information on real-time signals; use "
7713 "I</proc/[pid]/status> instead."
7717 #: build/C/man5/proc.5:963
7719 msgid "I<sigcatch> %lu"
7723 #: build/C/man5/proc.5:969
7725 "(34) The bitmap of caught signals, displayed as a decimal number. Obsolete, "
7726 "because it does not provide information on real-time signals; use "
7727 "I</proc/[pid]/status> instead."
7731 #: build/C/man5/proc.5:969
7733 msgid "I<wchan> %lu"
7737 #: build/C/man5/proc.5:979
7739 "(35) This is the \"channel\" in which the process is waiting. It is the "
7740 "address of a system call, and can be looked up in a namelist if you need a "
7741 "textual name. (If you have an up-to-date I</etc/psdatabase>, then try I<ps "
7742 "-l> to see the WCHAN field in action.)"
7746 #: build/C/man5/proc.5:979
7748 msgid "I<nswap> %lu"
7751 #. nswap was added in 2.0
7753 #: build/C/man5/proc.5:984
7754 msgid "(36) Number of pages swapped (not maintained)."
7758 #: build/C/man5/proc.5:984
7760 msgid "I<cnswap> %lu"
7763 #. cnswap was added in 2.0
7765 #: build/C/man5/proc.5:989
7766 msgid "(37) Cumulative I<nswap> for child processes (not maintained)."
7770 #: build/C/man5/proc.5:989
7772 msgid "I<exit_signal> %d (since Linux 2.1.22)"
7776 #: build/C/man5/proc.5:992
7777 msgid "(38) Signal to be sent to parent when we die."
7781 #: build/C/man5/proc.5:992
7783 msgid "I<processor> %d (since Linux 2.2.8)"
7787 #: build/C/man5/proc.5:995
7788 msgid "(39) CPU number last executed on."
7792 #: build/C/man5/proc.5:995
7794 msgid "I<rt_priority> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
7798 #: build/C/man5/proc.5:1001
7800 "(40) Real-time scheduling priority, a number in the range 1 to 99 for "
7801 "processes scheduled under a real-time policy, or 0, for non-real-time "
7802 "processes (see B<sched_setscheduler>(2))."
7807 #: build/C/man5/proc.5:1001
7809 msgid "I<policy> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
7813 #: build/C/man5/proc.5:1008
7815 "(41) Scheduling policy (see B<sched_setscheduler>(2)). Decode using the "
7816 "SCHED_* constants in I<linux/sched.h>."
7820 #: build/C/man5/proc.5:1008
7822 msgid "I<delayacct_blkio_ticks> %llu (since Linux 2.6.18)"
7826 #: build/C/man5/proc.5:1011
7827 msgid "(42) Aggregated block I/O delays, measured in clock ticks (centiseconds)."
7831 #: build/C/man5/proc.5:1011
7833 msgid "I<guest_time> %lu (since Linux 2.6.24)"
7837 #: build/C/man5/proc.5:1016
7839 "(43) Guest time of the process (time spent running a virtual CPU for a guest "
7840 "operating system), measured in clock ticks (divide by "
7841 "I<sysconf(_SC_CLK_TCK)>)."
7845 #: build/C/man5/proc.5:1016
7847 msgid "I<cguest_time> %ld (since Linux 2.6.24)"
7851 #: build/C/man5/proc.5:1020
7853 "(44) Guest time of the process's children, measured in clock ticks (divide "
7854 "by I<sysconf(_SC_CLK_TCK)>)."
7858 #: build/C/man5/proc.5:1021
7860 msgid "I</proc/[pid]/statm>"
7864 #: build/C/man5/proc.5:1025
7866 "Provides information about memory usage, measured in pages. The columns "
7870 #. (not including libs; broken, includes data segment)
7871 #. (including libs; broken, includes library text)
7873 #: build/C/man5/proc.5:1039
7876 "size (1) total program size\n"
7877 " (same as VmSize in I</proc/[pid]/status>)\n"
7878 "resident (2) resident set size\n"
7879 " (same as VmRSS in I</proc/[pid]/status>)\n"
7880 "share (3) shared pages (i.e., backed by a file)\n"
7881 "text (4) text (code)\n"
7882 "lib (5) library (unused in Linux 2.6)\n"
7883 "data (6) data + stack\n"
7884 "dt (7) dirty pages (unused in Linux 2.6)\n"
7888 #: build/C/man5/proc.5:1041
7890 msgid "I</proc/[pid]/status>"
7894 #: build/C/man5/proc.5:1049
7896 "Provides much of the information in I</proc/[pid]/stat> and "
7897 "I</proc/[pid]/statm> in a format that's easier for humans to parse. Here's "
7902 #: build/C/man5/proc.5:1090
7905 "$B< cat /proc/$$/status>\n"
7907 "State: S (sleeping)\n"
7912 "Uid: 1000 1000 1000 1000\n"
7913 "Gid: 100 100 100 100\n"
7915 "Groups: 16 33 100\n"
7928 "SigPnd: 0000000000000000\n"
7929 "ShdPnd: 0000000000000000\n"
7930 "SigBlk: 0000000000010000\n"
7931 "SigIgn: 0000000000384004\n"
7932 "SigCgt: 000000004b813efb\n"
7933 "CapInh: 0000000000000000\n"
7934 "CapPrm: 0000000000000000\n"
7935 "CapEff: 0000000000000000\n"
7936 "CapBnd: ffffffffffffffff\n"
7937 "Cpus_allowed: 00000001\n"
7938 "Cpus_allowed_list: 0\n"
7940 "Mems_allowed_list: 0\n"
7941 "voluntary_ctxt_switches: 150\n"
7942 "nonvoluntary_ctxt_switches: 545\n"
7946 #: build/C/man5/proc.5:1094
7947 msgid "The fields are as follows:"
7951 #: build/C/man5/proc.5:1098
7952 msgid "I<Name>: Command run by this process."
7956 #: build/C/man5/proc.5:1110
7958 "I<State>: Current state of the process. One of \"R (running)\", \"S "
7959 "(sleeping)\", \"D (disk sleep)\", \"T (stopped)\", \"T (tracing stop)\", \"Z "
7960 "(zombie)\", or \"X (dead)\"."
7964 #: build/C/man5/proc.5:1113
7965 msgid "I<Tgid>: Thread group ID (i.e., Process ID)."
7969 #: build/C/man5/proc.5:1117
7970 msgid "I<Pid>: Thread ID (see B<gettid>(2))."
7974 #: build/C/man5/proc.5:1120
7975 msgid "I<PPid>: PID of parent process."
7979 #: build/C/man5/proc.5:1123
7980 msgid "I<TracerPid>: PID of process tracing this process (0 if not being traced)."
7984 #: build/C/man5/proc.5:1126
7985 msgid "I<Uid>, I<Gid>: Real, effective, saved set, and file system UIDs (GIDs)."
7989 #: build/C/man5/proc.5:1129
7990 msgid "I<FDSize>: Number of file descriptor slots currently allocated."
7994 #: build/C/man5/proc.5:1132
7995 msgid "I<Groups>: Supplementary group list."
7999 #: build/C/man5/proc.5:1135
8000 msgid "I<VmPeak>: Peak virtual memory size."
8004 #: build/C/man5/proc.5:1138
8005 msgid "I<VmSize>: Virtual memory size."
8009 #: build/C/man5/proc.5:1142
8010 msgid "I<VmLck>: Locked memory size (see B<mlock>(3))."
8014 #: build/C/man5/proc.5:1145
8015 msgid "I<VmHWM>: Peak resident set size (\"high water mark\")."
8019 #: build/C/man5/proc.5:1148
8020 msgid "I<VmRSS>: Resident set size."
8024 #: build/C/man5/proc.5:1151
8025 msgid "I<VmData>, I<VmStk>, I<VmExe>: Size of data, stack, and text segments."
8029 #: build/C/man5/proc.5:1154
8030 msgid "I<VmLib>: Shared library code size."
8034 #: build/C/man5/proc.5:1157
8035 msgid "I<VmPTE>: Page table entries size (since Linux 2.6.10)."
8039 #: build/C/man5/proc.5:1160
8040 msgid "I<Threads>: Number of threads in process containing this thread."
8044 #: build/C/man5/proc.5:1171
8046 "I<SigQ>: This field contains two slash-separated numbers that relate to "
8047 "queued signals for the real user ID of this process. The first of these is "
8048 "the number of currently queued signals for this real user ID, and the second "
8049 "is the resource limit on the number of queued signals for this process (see "
8050 "the description of B<RLIMIT_SIGPENDING> in B<getrlimit>(2))."
8054 #: build/C/man5/proc.5:1177
8056 "I<SigPnd>, I<ShdPnd>: Number of signals pending for thread and for process "
8057 "as a whole (see B<pthreads>(7) and B<signal>(7))."
8061 #: build/C/man5/proc.5:1181
8063 "I<SigBlk>, I<SigIgn>, I<SigCgt>: Masks indicating signals being blocked, "
8064 "ignored, and caught (see B<signal>(7))."
8068 #: build/C/man5/proc.5:1186
8070 "I<CapInh>, I<CapPrm>, I<CapEff>: Masks of capabilities enabled in "
8071 "inheritable, permitted, and effective sets (see B<capabilities>(7))."
8075 #: build/C/man5/proc.5:1191
8077 "I<CapBnd>: Capability Bounding set (since kernel 2.6.26, see "
8078 "B<capabilities>(7))."
8082 #: build/C/man5/proc.5:1196
8084 "I<Cpus_allowed>: Mask of CPUs on which this process may run (since Linux "
8085 "2.6.24, see B<cpuset>(7))."
8089 #: build/C/man5/proc.5:1201
8091 "I<Cpus_allowed_list>: Same as previous, but in \"list format\" (since Linux "
8092 "2.6.26, see B<cpuset>(7))."
8096 #: build/C/man5/proc.5:1206
8098 "I<Mems_allowed>: Mask of memory nodes allowed to this process (since Linux "
8099 "2.6.24, see B<cpuset>(7))."
8103 #: build/C/man5/proc.5:1211
8105 "I<Mems_allowed_list>: Same as previous, but in \"list format\" (since Linux "
8106 "2.6.26, see B<cpuset>(7))."
8110 #: build/C/man5/proc.5:1214
8112 "I<voluntary_context_switches>, I<nonvoluntary_context_switches>: Number of "
8113 "voluntary and involuntary context switches (since Linux 2.6.23)."
8117 #: build/C/man5/proc.5:1215
8119 msgid "I</proc/[pid]/task> (since Linux 2.6.0-test6)"
8123 #: build/C/man5/proc.5:1246
8125 "This is a directory that contains one subdirectory for each thread in the "
8126 "process. The name of each subdirectory is the numerical thread ID "
8127 "(I<[tid]>) of the thread (see B<gettid>(2)). Within each of these "
8128 "subdirectories, there is a set of files with the same names and contents as "
8129 "under the I</proc/[pid]> directories. For attributes that are shared by all "
8130 "threads, the contents for each of the files under the I<task/[tid]> "
8131 "subdirectories will be the same as in the corresponding file in the parent "
8132 "I</proc/[pid]> directory (e.g., in a multithreaded process, all of the "
8133 "I<task/[tid]/cwd> files will have the same value as the I</proc/[pid]/cwd> "
8134 "file in the parent directory, since all of the threads in a process share a "
8135 "working directory). For attributes that are distinct for each thread, the "
8136 "corresponding files under I<task/[tid]> may have different values (e.g., "
8137 "various fields in each of the I<task/[tid]/status> files may be different "
8141 #. The following was still true as at kernel 2.6.13
8143 #: build/C/man5/proc.5:1253
8145 "In a multithreaded process, the contents of the I</proc/[pid]/task> "
8146 "directory are not available if the main thread has already terminated "
8147 "(typically by calling B<pthread_exit>(3))."
8151 #: build/C/man5/proc.5:1253
8153 msgid "I</proc/apm>"
8157 #: build/C/man5/proc.5:1258
8159 "Advanced power management version and battery information when B<CONFIG_APM> "
8160 "is defined at kernel compilation time."
8164 #: build/C/man5/proc.5:1258
8166 msgid "I</proc/bus>"
8170 #: build/C/man5/proc.5:1261
8171 msgid "Contains subdirectories for installed busses."
8175 #: build/C/man5/proc.5:1261
8177 msgid "I</proc/bus/pccard>"
8181 #: build/C/man5/proc.5:1266
8183 "Subdirectory for PCMCIA devices when B<CONFIG_PCMCIA> is set at kernel "
8188 #: build/C/man5/proc.5:1266
8190 msgid "I</proc/bus/pccard/drivers>"
8194 #: build/C/man5/proc.5:1268
8196 msgid "I</proc/bus/pci>"
8200 #: build/C/man5/proc.5:1274
8202 "Contains various bus subdirectories and pseudo-files containing information "
8203 "about PCI busses, installed devices, and device drivers. Some of these "
8204 "files are not ASCII."
8208 #: build/C/man5/proc.5:1274
8210 msgid "I</proc/bus/pci/devices>"
8214 #: build/C/man5/proc.5:1281
8216 "Information about PCI devices. They may be accessed through B<lspci>(8) "
8221 #: build/C/man5/proc.5:1281
8223 msgid "I</proc/cmdline>"
8227 #: build/C/man5/proc.5:1288
8229 "Arguments passed to the Linux kernel at boot time. Often done via a boot "
8230 "manager such as B<lilo>(8) or B<grub>(8)."
8234 #: build/C/man5/proc.5:1288
8236 msgid "I</proc/config.gz> (since Linux 2.6)"
8240 #: build/C/man5/proc.5:1306
8242 "This file exposes the configuration options that were used to build the "
8243 "currently running kernel, in the same format as they would be shown in the "
8244 "I<.config> file that resulted when configuring the kernel (using I<make "
8245 "xconfig>, I<make config>, or similar). The file contents are compressed; "
8246 "view or search them using B<zcat>(1), B<zgrep>(1), etc. As long as no "
8247 "changes have been made to the following file, the contents of "
8248 "I</proc/config.gz> are the same as those provided by :"
8252 #: build/C/man5/proc.5:1310
8254 msgid "cat /lib/modules/$(uname -r)/build/.config\n"
8258 #: build/C/man5/proc.5:1316
8260 "I</proc/config.gz> is only provided if the kernel is configured with "
8261 "B<CONFIG_IKCONFIG_PROC>."
8265 #: build/C/man5/proc.5:1316
8267 msgid "I</proc/cpuinfo>"
8271 #: build/C/man5/proc.5:1328
8273 "This is a collection of CPU and system architecture dependent items, for "
8274 "each supported architecture a different list. Two common entries are "
8275 "I<processor> which gives CPU number and I<bogomips>; a system constant that "
8276 "is calculated during kernel initialization. SMP machines have information "
8277 "for each CPU. The B<lscpu>(1) command gathers its information from this "
8282 #: build/C/man5/proc.5:1328
8284 msgid "I</proc/devices>"
8288 #: build/C/man5/proc.5:1332
8290 "Text listing of major numbers and device groups. This can be used by "
8291 "MAKEDEV scripts for consistency with the kernel."
8295 #: build/C/man5/proc.5:1332
8297 msgid "I</proc/diskstats> (since Linux 2.5.69)"
8301 #: build/C/man5/proc.5:1338
8303 "This file contains disk I/O statistics for each disk device. See the Linux "
8304 "kernel source file I<Documentation/iostats.txt> for further information."
8308 #: build/C/man5/proc.5:1338
8310 msgid "I</proc/dma>"
8314 #: build/C/man5/proc.5:1342
8316 "This is a list of the registered I<ISA> DMA (direct memory access) channels "
8321 #: build/C/man5/proc.5:1342
8323 msgid "I</proc/driver>"
8327 #: build/C/man5/proc.5:1345 build/C/man5/proc.5:1373
8328 msgid "Empty subdirectory."
8332 #: build/C/man5/proc.5:1345
8334 msgid "I</proc/execdomains>"
8338 #: build/C/man5/proc.5:1348
8339 msgid "List of the execution domains (ABI personalities)."
8343 #: build/C/man5/proc.5:1348
8349 #: build/C/man5/proc.5:1353
8351 "Frame buffer information when B<CONFIG_FB> is defined during kernel "
8356 #: build/C/man5/proc.5:1353
8358 msgid "I</proc/filesystems>"
8362 #: build/C/man5/proc.5:1363
8364 "A text listing of the file systems which are supported by the kernel, namely "
8365 "file systems which were compiled into the kernel or whose kernel modules are "
8366 "currently loaded. (See also B<filesystems>(5).) If a file system is marked "
8367 "with \"nodev\", this means that it does not require a block device to be "
8368 "mounted (e.g., virtual file system, network file system)."
8372 #: build/C/man5/proc.5:1370
8374 "Incidentally, this file may be used by B<mount>(8) when no file system is "
8375 "specified and it didn't manage to determine the file system type. Then file "
8376 "systems contained in this file are tried (excepted those that are marked "
8381 #: build/C/man5/proc.5:1370
8387 #: build/C/man5/proc.5:1373
8389 msgid "I</proc/ide>"
8393 #: build/C/man5/proc.5:1379
8395 "This directory exists on systems with the IDE bus. There are directories "
8396 "for each IDE channel and attached device. Files include:"
8400 #: build/C/man5/proc.5:1392
8403 "cache buffer size in KB\n"
8404 "capacity number of sectors\n"
8405 "driver driver version\n"
8406 "geometry physical and logical geometry\n"
8407 "identify in hexadecimal\n"
8408 "media media type\n"
8409 "model manufacturer's model number\n"
8410 "settings drive settings\n"
8411 "smart_thresholds in hexadecimal\n"
8412 "smart_values in hexadecimal\n"
8416 #: build/C/man5/proc.5:1398
8418 "The B<hdparm>(8) utility provides access to this information in a friendly "
8423 #: build/C/man5/proc.5:1398
8425 msgid "I</proc/interrupts>"
8429 #: build/C/man5/proc.5:1408
8431 "This is used to record the number of interrupts per CPU per IO device. "
8432 "Since Linux 2.6.24, for the i386 and x86_64 architectures, at least, this "
8433 "also includes interrupts internal to the system (that is, not associated "
8434 "with a device as such), such as NMI (nonmaskable interrupt), LOC (local "
8435 "timer interrupt), and for SMP systems, TLB (TLB flush interrupt), RES "
8436 "(rescheduling interrupt), CAL (remote function call interrupt), and possibly "
8437 "others. Very easy to read formatting, done in ASCII."
8441 #: build/C/man5/proc.5:1408
8443 msgid "I</proc/iomem>"
8447 #: build/C/man5/proc.5:1411
8448 msgid "I/O memory map in Linux 2.4."
8452 #: build/C/man5/proc.5:1411
8454 msgid "I</proc/ioports>"
8458 #: build/C/man5/proc.5:1415
8460 "This is a list of currently registered Input-Output port regions that are in "
8465 #: build/C/man5/proc.5:1415
8467 msgid "I</proc/kallsyms> (since Linux 2.5.71)"
8471 #: build/C/man5/proc.5:1423
8473 "This holds the kernel exported symbol definitions used by the B<modules>(X) "
8474 "tools to dynamically link and bind loadable modules. In Linux 2.5.47 and "
8475 "earlier, a similar file with slightly different syntax was named I<ksyms>."
8479 #: build/C/man5/proc.5:1423
8481 msgid "I</proc/kcore>"
8485 #: build/C/man5/proc.5:1432
8487 "This file represents the physical memory of the system and is stored in the "
8488 "ELF core file format. With this pseudo-file, and an unstripped kernel "
8489 "(I</usr/src/linux/vmlinux>) binary, GDB can be used to examine the current "
8490 "state of any kernel data structures."
8494 #: build/C/man5/proc.5:1435
8495 msgid "The total length of the file is the size of physical memory (RAM) plus 4KB."
8499 #: build/C/man5/proc.5:1435
8501 msgid "I</proc/kmsg>"
8505 #: build/C/man5/proc.5:1447
8507 "This file can be used instead of the B<syslog>(2) system call to read "
8508 "kernel messages. A process must have superuser privileges to read this "
8509 "file, and only one process should read this file. This file should not be "
8510 "read if a syslog process is running which uses the B<syslog>(2) system call "
8511 "facility to log kernel messages."
8515 #: build/C/man5/proc.5:1451
8516 msgid "Information in this file is retrieved with the B<dmesg>(1) program."
8520 #: build/C/man5/proc.5:1451
8522 msgid "I</proc/ksyms> (Linux 1.1.23-2.5.47)"
8526 #: build/C/man5/proc.5:1455
8527 msgid "See I</proc/kallsyms>."
8531 #: build/C/man5/proc.5:1455
8533 msgid "I</proc/loadavg>"
8537 #: build/C/man5/proc.5:1470
8539 "The first three fields in this file are load average figures giving the "
8540 "number of jobs in the run queue (state R) or waiting for disk I/O (state D) "
8541 "averaged over 1, 5, and 15 minutes. They are the same as the load average "
8542 "numbers given by B<uptime>(1) and other programs. The fourth field "
8543 "consists of two numbers separated by a slash (/). The first of these is the "
8544 "number of currently runnable kernel scheduling entities (processes, "
8545 "threads). The value after the slash is the number of kernel scheduling "
8546 "entities that currently exist on the system. The fifth field is the PID of "
8547 "the process that was most recently created on the system."
8551 #: build/C/man5/proc.5:1470
8553 msgid "I</proc/locks>"
8557 #: build/C/man5/proc.5:1476
8559 "This file shows current file locks (B<flock>(2) and B<fcntl>(2)) and leases "
8564 #: build/C/man5/proc.5:1476
8566 msgid "I</proc/malloc> (only up to and including Linux 2.2)"
8569 #. It looks like this only ever did something back in 1.0 days
8571 #: build/C/man5/proc.5:1482
8573 "This file is only present if B<CONFIG_DEBUG_MALLOC> was defined during "
8578 #: build/C/man5/proc.5:1482
8580 msgid "I</proc/meminfo>"
8584 #: build/C/man5/proc.5:1498
8586 "This file reports statistics about memory usage on the system. It is used "
8587 "by B<free>(1) to report the amount of free and used memory (both physical "
8588 "and swap) on the system as well as the shared memory and buffers used by "
8589 "the kernel. Each line of the file consists of a parameter name, followed by "
8590 "a colon, the value of the parameter, and an option unit of measurement "
8591 "(e.g., \"kB\"). The list below describes the parameter names and the format "
8592 "specifier required to read the field value. Except as noted below, all of "
8593 "the fields have been present since at least Linux 2.6.0. Some fileds are "
8594 "only displayed if the kernel was configured with various options; those "
8595 "dependencies are noted in the list."
8599 #: build/C/man5/proc.5:1499
8601 msgid "I<MemTotal> %lu"
8605 #: build/C/man5/proc.5:1503
8607 "Total usable RAM (i.e. physical RAM minus a few reserved bits and the kernel "
8612 #: build/C/man5/proc.5:1503
8614 msgid "I<MemFree> %lu"
8618 #: build/C/man5/proc.5:1507
8619 msgid "The sum of I<LowFree>+I<HighFree>."
8623 #: build/C/man5/proc.5:1507
8625 msgid "I<Buffers> %lu"
8629 #: build/C/man5/proc.5:1511
8631 "Relatively temporary storage for raw disk blocks that shouldn't get "
8632 "tremendously large (20MB or so)."
8636 #: build/C/man5/proc.5:1511
8638 msgid "I<Cached> %lu"
8642 #: build/C/man5/proc.5:1516
8644 "In-memory cache for files read from the disk (the page cache). Doesn't "
8645 "include I<SwapCached>."
8649 #: build/C/man5/proc.5:1516
8651 msgid "I<SwapCached> %lu"
8655 #: build/C/man5/proc.5:1524
8657 "Memory that once was swapped out, is swapped back in but still also is in "
8658 "the swap file. (If memory pressure is high, these pages don't need to be "
8659 "swapped out again because they are already in the swap file. This saves "
8664 #: build/C/man5/proc.5:1524
8666 msgid "I<Active> %lu"
8670 #: build/C/man5/proc.5:1528
8672 "Memory that has been used more recently and usually not reclaimed unless "
8673 "absolutely necessary."
8677 #: build/C/man5/proc.5:1528
8679 msgid "I<Inactive> %lu"
8683 #: build/C/man5/proc.5:1532
8685 "Memory which has been less recently used. It is more eligible to be "
8686 "reclaimed for other purposes."
8690 #: build/C/man5/proc.5:1532
8692 msgid "I<Active(anon)> %lu (since Linux 2.6.28)"
8696 #: build/C/man5/proc.5:1535 build/C/man5/proc.5:1538 build/C/man5/proc.5:1541 build/C/man5/proc.5:1544 build/C/man5/proc.5:1609
8697 msgid "[To be documented.]"
8701 #: build/C/man5/proc.5:1535
8703 msgid "I<Inactive(anon)> %lu (since Linux 2.6.28)"
8707 #: build/C/man5/proc.5:1538
8709 msgid "I<Active(file)> %lu (since Linux 2.6.28)"
8713 #: build/C/man5/proc.5:1541
8715 msgid "I<Inactive(file)> %lu (since Linux 2.6.28)"
8719 #: build/C/man5/proc.5:1544
8721 msgid "I<Unevictable> %lu (since Linux 2.6.28)"
8725 #: build/C/man5/proc.5:1549 build/C/man5/proc.5:1554
8727 "(From Linux 2.6.28 to 2.6.30, B<CONFIG_UNEVICTABLE_LRU> was required.) [To "
8732 #: build/C/man5/proc.5:1549
8734 msgid "I<Mlocked> %lu (since Linux 2.6.28)"
8738 #: build/C/man5/proc.5:1554
8740 msgid "I<HighTotal> %lu"
8744 #: build/C/man5/proc.5:1563
8746 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
8747 "of highmem. Highmem is all memory above ~860MB of physical memory. Highmem "
8748 "areas are for use by user-space programs, or for the page cache. The kernel "
8749 "must use tricks to access this memory, making it slower to access than "
8754 #: build/C/man5/proc.5:1563
8756 msgid "I<HighFree> %lu"
8760 #: build/C/man5/proc.5:1567
8762 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
8767 #: build/C/man5/proc.5:1567
8769 msgid "I<LowTotal> %lu"
8773 #: build/C/man5/proc.5:1579
8775 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
8776 "of lowmem. Lowmem is memory which can be used for everything that highmem "
8777 "can be used for, but it is also available for the kernel's use for its own "
8778 "data structures. Among many other things, it is where everything from "
8779 "I<Slab> is allocated. Bad things happen when you're out of lowmem."
8783 #: build/C/man5/proc.5:1579
8785 msgid "I<LowFree> %lu"
8789 #: build/C/man5/proc.5:1583
8791 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
8796 #: build/C/man5/proc.5:1583
8798 msgid "I<MmapCopy> %lu (since Linux 2.6.29)"
8802 #: build/C/man5/proc.5:1588
8803 msgid "(B<CONFIG_MMU> is required.) [To be documented.]"
8807 #: build/C/man5/proc.5:1588
8809 msgid "I<SwapTotal> %lu"
8813 #: build/C/man5/proc.5:1591
8814 msgid "Total amount of swap space available."
8818 #: build/C/man5/proc.5:1591
8820 msgid "I<SwapFree> %lu"
8824 #: build/C/man5/proc.5:1594
8825 msgid "Amount of swap space that is currently unused."
8829 #: build/C/man5/proc.5:1594
8831 msgid "I<Dirty> %lu"
8835 #: build/C/man5/proc.5:1597
8836 msgid "Memory which is waiting to get written back to the disk."
8840 #: build/C/man5/proc.5:1597
8842 msgid "I<Writeback> %lu"
8846 #: build/C/man5/proc.5:1600
8847 msgid "Memory which is actively being written back to the disk."
8851 #: build/C/man5/proc.5:1600
8853 msgid "I<AnonPages> %lu (since Linux 2.6.18)"
8857 #: build/C/man5/proc.5:1603
8858 msgid "Non-file backed pages mapped into user-space page tables."
8862 #: build/C/man5/proc.5:1603
8864 msgid "I<Mapped> %lu"
8868 #: build/C/man5/proc.5:1606
8869 msgid "Files which have been mmaped, such as libraries."
8873 #: build/C/man5/proc.5:1606
8875 msgid "I<Shmem> %lu (since Linux 2.6.32)"
8879 #: build/C/man5/proc.5:1609
8885 #: build/C/man5/proc.5:1612
8886 msgid "In-kernel data structures cache."
8890 #: build/C/man5/proc.5:1612
8892 msgid "I<SReclaimable> %lu (since Linux 2.6.19)"
8896 #: build/C/man5/proc.5:1617
8897 msgid "Part of I<Slab>, that might be reclaimed, such as caches."
8901 #: build/C/man5/proc.5:1617
8903 msgid "I<SUnreclaim> %lu (since Linux 2.6.19)"
8907 #: build/C/man5/proc.5:1622
8908 msgid "Part of I<Slab>, that cannot be reclaimed on memory pressure."
8912 #: build/C/man5/proc.5:1622
8914 msgid "I<KernelStack> %lu (since Linux 2.6.32)"
8918 #: build/C/man5/proc.5:1625
8919 msgid "Amount of memory allocated to kernel stacks."
8923 #: build/C/man5/proc.5:1625
8925 msgid "I<PageTables> %lu (since Linux 2.6.18)"
8929 #: build/C/man5/proc.5:1628
8930 msgid "Amount of memory dedicated to the lowest level of page tables."
8934 #: build/C/man5/proc.5:1628
8936 msgid "I<Quicklists> %lu (since Linux 2.6.27)"
8940 #: build/C/man5/proc.5:1632
8941 msgid "(B<CONFIG_QUICKLIST> is required.) [To be documented.]"
8945 #: build/C/man5/proc.5:1632
8947 msgid "I<NFS_Unstable> %lu (since Linux 2.6.18)"
8951 #: build/C/man5/proc.5:1635
8952 msgid "NFS pages sent to the server, but not yet committed to stable storage."
8956 #: build/C/man5/proc.5:1635
8958 msgid "I<Bounce> %lu (since Linux 2.6.18)"
8962 #: build/C/man5/proc.5:1638
8963 msgid "Memory used for block device \"bounce buffers\"."
8967 #: build/C/man5/proc.5:1638
8969 msgid "I<WritebackTmp> %lu (since Linux 2.6.26)"
8973 #: build/C/man5/proc.5:1641
8974 msgid "Memory used by FUSE for temporary writeback buffers."
8978 #: build/C/man5/proc.5:1641
8980 msgid "I<CommitLimit> %lu (since Linux 2.6.10)"
8984 #: build/C/man5/proc.5:1651
8986 "Based on the overcommit ratio ('vm.overcommit_ratio'), this is the total "
8987 "amount of memory currently available to be allocated on the system. This "
8988 "limit is only adhered to if strict overcommit accounting is enabled (mode 2 "
8989 "in I</proc/sys/vm/overcommit_ratio>). The I<CommitLimit> is calculated "
8990 "using the following formula:"
8994 #: build/C/man5/proc.5:1653
8996 msgid " CommitLimit = (overcommit_ratio * Physical RAM) + Swap\n"
9000 #: build/C/man5/proc.5:1663
9002 "For example, on a system with 1GB of physical RAM and 7GB of swap with a "
9003 "I<overcommit_ratio> of 30, this formula yields a I<CommitLimit> of 7.3GB. "
9004 "For more details, see the memory overcommit documentation in the kernel "
9005 "source file I<Documentation/vm/overcommit-accounting>."
9009 #: build/C/man5/proc.5:1663
9011 msgid "I<Committed_AS> %lu"
9015 #: build/C/man5/proc.5:1683
9017 "The amount of memory presently allocated on the system. The committed "
9018 "memory is a sum of all of the memory which has been allocated by processes, "
9019 "even if it has not been \"used\" by them as of yet. A process which "
9020 "allocates 1GB of memory (using B<malloc>(3) or similar), but only touches "
9021 "300MB of that memory will only show up as using 300MB of memory even if it "
9022 "has the address space allocated for the entire 1GB. This 1GB is memory "
9023 "which has been \"committed\" to by the VM and can be used at any time by the "
9024 "allocating application. With strict overcommit enabled on the system (mode "
9025 "2 I</proc/sys/vm/overcommit_memory>), allocations which would exceed the "
9026 "I<CommitLimit> (detailed above) will not be permitted. This is useful if "
9027 "one needs to guarantee that processes will not fail due to lack of memory "
9028 "once that memory has been successfully allocated."
9032 #: build/C/man5/proc.5:1683
9034 msgid "I<VmallocTotal> %lu"
9038 #: build/C/man5/proc.5:1686
9039 msgid "Total size of vmalloc memory area."
9043 #: build/C/man5/proc.5:1686
9045 msgid "I<VmallocUsed> %lu"
9049 #: build/C/man5/proc.5:1689
9050 msgid "Amount of vmalloc area which is used."
9054 #: build/C/man5/proc.5:1689
9056 msgid "I<VmallocChunk> %lu"
9060 #: build/C/man5/proc.5:1692
9061 msgid "Largest contiguous block of vmalloc area which is free."
9065 #: build/C/man5/proc.5:1692
9067 msgid "I<HardwareCorrupted> %lu (since Linux 2.6.32)"
9071 #: build/C/man5/proc.5:1696
9072 msgid "(B<CONFIG_MEMORY_FAILURE> is required.) [To be documented.]"
9076 #: build/C/man5/proc.5:1696
9078 msgid "I<AnonHugePages> %lu (since Linux 2.6.38)"
9082 #: build/C/man5/proc.5:1700
9084 "(B<CONFIG_TRANSPARENT_HUGEPAGE> is required.) Non-file backed huge pages "
9085 "mapped into user-space page tables."
9089 #: build/C/man5/proc.5:1700
9091 msgid "I<HugePages_Total> %lu"
9095 #: build/C/man5/proc.5:1704
9096 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of the pool of huge pages."
9100 #: build/C/man5/proc.5:1704
9102 msgid "I<HugePages_Free> %lu"
9106 #: build/C/man5/proc.5:1708
9108 "(B<CONFIG_HUGETLB_PAGE> is required.) The number of huge pages in the pool "
9109 "that are not yet allocated."
9113 #: build/C/man5/proc.5:1708
9115 msgid "I<HugePages_Rsvd> %lu (since Linux 2.6.17)"
9119 #: build/C/man5/proc.5:1717
9121 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages for "
9122 "which a commitment to allocate from the pool has been made, but no "
9123 "allocation has yet been made. These reserved huge pages guarantee that an "
9124 "application will be able to allocate a huge page from the pool of huge pages "
9129 #: build/C/man5/proc.5:1717
9131 msgid "I<HugePages_Surp> %lu (since Linux 2.6.24)"
9135 #: build/C/man5/proc.5:1725
9137 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages in "
9138 "the pool above the value in I</proc/sys/vm/nr_hugepages>. The maximum "
9139 "number of surplus huge pages is controlled by "
9140 "I</proc/sys/vm/nr_overcommit_hugepages>."
9144 #: build/C/man5/proc.5:1725
9146 msgid "I<Hugepagesize> %lu"
9150 #: build/C/man5/proc.5:1729
9151 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of huge pages."
9155 #: build/C/man5/proc.5:1730
9157 msgid "I</proc/modules>"
9161 #: build/C/man5/proc.5:1735
9163 "A text list of the modules that have been loaded by the system. See also "
9168 #: build/C/man5/proc.5:1735
9170 msgid "I</proc/mounts>"
9174 #: build/C/man5/proc.5:1745
9176 "Before kernel 2.4.19, this file was a list of all the file systems currently "
9177 "mounted on the system. With the introduction of per-process mount "
9178 "namespaces in Linux 2.4.19, this file became a link to I</proc/self/mounts>, "
9179 "which lists the mount points of the process's own mount namespace. The "
9180 "format of this file is documented in B<fstab>(5)."
9184 #: build/C/man5/proc.5:1745
9186 msgid "I</proc/mtrr>"
9190 #: build/C/man5/proc.5:1751
9192 "Memory Type Range Registers. See the Linux kernel source file "
9193 "I<Documentation/mtrr.txt> for details."
9197 #: build/C/man5/proc.5:1751
9199 msgid "I</proc/net>"
9203 #: build/C/man5/proc.5:1761
9205 "various net pseudo-files, all of which give the status of some part of the "
9206 "networking layer. These files contain ASCII structures and are, therefore, "
9207 "readable with B<cat>(1). However, the standard B<netstat>(8) suite "
9208 "provides much cleaner access to these files."
9212 #: build/C/man5/proc.5:1761
9214 msgid "I</proc/net/arp>"
9218 #: build/C/man5/proc.5:1767
9220 "This holds an ASCII readable dump of the kernel ARP table used for address "
9221 "resolutions. It will show both dynamically learned and preprogrammed ARP "
9222 "entries. The format is:"
9226 #: build/C/man5/proc.5:1774
9229 "CW<IP address HW type Flags HW address Mask Device\n"
9230 "192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0\n"
9231 "192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0>\n"
9235 #: build/C/man5/proc.5:1786
9237 "Here \"IP address\" is the IPv4 address of the machine and the \"HW type\" "
9238 "is the hardware type of the address from RFC\\ 826. The flags are the "
9239 "internal flags of the ARP structure (as defined in "
9240 "I</usr/include/linux/if_arp.h>) and the \"HW address\" is the data link "
9241 "layer mapping for that IP address if it is known."
9245 #: build/C/man5/proc.5:1786
9247 msgid "I</proc/net/dev>"
9251 #: build/C/man5/proc.5:1797
9253 "The dev pseudo-file contains network device status information. This gives "
9254 "the number of received and sent packets, the number of errors and collisions "
9255 "and other basic statistics. These are used by the B<ifconfig>(8) program "
9256 "to report device status. The format is:"
9260 #: build/C/man5/proc.5:1807
9263 "CW<Inter-| Receive | "
9265 " face |bytes packets errs drop fifo frame compressed multicast|bytes "
9266 "packets errs drop fifo colls carrier compressed\n"
9267 " lo: 2776770 11307 0 0 0 0 0 0 2776770 "
9268 "11307 0 0 0 0 0 0\n"
9269 " eth0: 1215645 2751 0 0 0 0 0 0 1782404 "
9270 "4324 0 0 0 427 0 0\n"
9271 " ppp0: 1622270 5552 1 0 0 0 0 0 354130 "
9272 "5669 0 0 0 0 0 0\n"
9273 " tap0: 7714 81 0 0 0 0 0 0 7714 "
9278 #: build/C/man5/proc.5:1816
9280 msgid "I</proc/net/dev_mcast>"
9284 #: build/C/man5/proc.5:1820
9285 msgid "Defined in I</usr/src/linux/net/core/dev_mcast.c>:"
9289 #: build/C/man5/proc.5:1826
9292 "indx interface_name dmi_u dmi_g dmi_address\n"
9293 "2 eth0 1 0 01005e000001\n"
9294 "3 eth1 1 0 01005e000001\n"
9295 "4 eth2 1 0 01005e000001\n"
9299 #: build/C/man5/proc.5:1828
9301 msgid "I</proc/net/igmp>"
9305 #: build/C/man5/proc.5:1833
9307 "Internet Group Management Protocol. Defined in "
9308 "I</usr/src/linux/net/core/igmp.c>."
9312 #: build/C/man5/proc.5:1833
9314 msgid "I</proc/net/rarp>"
9318 #: build/C/man5/proc.5:1843
9320 "This file uses the same format as the I<arp> file and contains the current "
9321 "reverse mapping database used to provide B<rarp>(8) reverse address lookup "
9322 "services. If RARP is not configured into the kernel, this file will not be "
9327 #: build/C/man5/proc.5:1843
9329 msgid "I</proc/net/raw>"
9333 #. .I /proc/net/route
9334 #. No information, but looks similar to
9337 #: build/C/man5/proc.5:1863
9339 "Holds a dump of the RAW socket table. Much of the information is not of use "
9340 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
9341 "socket, the \"local_address\" is the local address and protocol number "
9342 "pair. \\&\"St\" is the internal status of the socket. The \"tx_queue\" and "
9343 "\"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
9344 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
9345 "used by RAW. The \"uid\" field holds the effective UID of the creator of "
9350 #: build/C/man5/proc.5:1863
9352 msgid "I</proc/net/snmp>"
9356 #: build/C/man5/proc.5:1868
9358 "This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP "
9359 "management information bases for an SNMP agent."
9363 #: build/C/man5/proc.5:1868
9365 msgid "I</proc/net/tcp>"
9369 #: build/C/man5/proc.5:1884
9371 "Holds a dump of the TCP socket table. Much of the information is not of use "
9372 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
9373 "socket, the \"local_address\" is the local address and port number pair. "
9374 "The \"rem_address\" is the remote address and port number pair (if "
9375 "connected). \\&\"St\" is the internal status of the socket. The "
9376 "\"tx_queue\" and \"rx_queue\" are the outgoing and incoming data queue in "
9377 "terms of kernel memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" "
9378 "fields hold internal information of the kernel socket state and are only "
9379 "useful for debugging. The \"uid\" field holds the effective UID of the "
9380 "creator of the socket."
9384 #: build/C/man5/proc.5:1884
9386 msgid "I</proc/net/udp>"
9390 #: build/C/man5/proc.5:1900
9392 "Holds a dump of the UDP socket table. Much of the information is not of use "
9393 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
9394 "socket, the \"local_address\" is the local address and port number pair. "
9395 "The \"rem_address\" is the remote address and port number pair (if "
9396 "connected). \"St\" is the internal status of the socket. The \"tx_queue\" "
9397 "and \"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
9398 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
9399 "used by UDP. The \"uid\" field holds the effective UID of the creator of "
9400 "the socket. The format is:"
9404 #: build/C/man5/proc.5:1908
9407 "CW<sl local_address rem_address st tx_queue rx_queue tr rexmits "
9408 "tm-E<gt>when uid\n"
9409 " 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 "
9411 " 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 "
9413 " 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 "
9418 #: build/C/man5/proc.5:1911
9420 msgid "I</proc/net/unix>"
9424 #: build/C/man5/proc.5:1916
9426 "Lists the UNIX domain sockets present within the system and their status. "
9431 #: build/C/man5/proc.5:1922
9434 "CW<Num RefCount Protocol Flags Type St Path\n"
9435 " 0: 00000002 00000000 00000000 0001 03\n"
9436 " 1: 00000001 00000000 00010000 0001 01 /dev/printer>\n"
9440 #: build/C/man5/proc.5:1934
9442 "Here \"Num\" is the kernel table slot number, \"RefCount\" is the number of "
9443 "users of the socket, \"Protocol\" is currently always 0, \"Flags\" represent "
9444 "the internal kernel flags holding the status of the socket. Currently, type "
9445 "is always \"1\" (UNIX domain datagram sockets are not yet supported in the "
9446 "kernel). \\&\"St\" is the internal state of the socket and Path is the "
9447 "bound path (if any) of the socket."
9451 #: build/C/man5/proc.5:1934
9453 msgid "I</proc/partitions>"
9457 #: build/C/man5/proc.5:1938
9459 "Contains major and minor numbers of each partition as well as number of "
9460 "blocks and partition name."
9464 #: build/C/man5/proc.5:1938
9466 msgid "I</proc/pci>"
9470 #: build/C/man5/proc.5:1942
9472 "This is a listing of all PCI devices found during kernel initialization and "
9473 "their configuration."
9476 #. FIXME /proc/sched_debug
9478 #. .IR /proc/sched_debug " (since Linux 2.6.23)"
9479 #. See also /proc/[pid]/sched
9481 #: build/C/man5/proc.5:1958
9483 "This file has been deprecated in favor of a new I</proc> interface for PCI "
9484 "(I</proc/bus/pci>). It became optional in Linux 2.2 (available with "
9485 "B<CONFIG_PCI_OLD_PROC> set at kernel compilation). It became once more "
9486 "nonoptionally enabled in Linux 2.4. Next, it was deprecated in Linux 2.6 "
9487 "(still available with B<CONFIG_PCI_LEGACY_PROC> set), and finally removed "
9488 "altogether since Linux 2.6.17."
9492 #: build/C/man5/proc.5:1958
9494 msgid "I</proc/profile> (since Linux 2.4)"
9498 #: build/C/man5/proc.5:1970
9500 "This file is present only if the kernel was booted with the I<profile=1> "
9501 "command-line option. It exposes kernel profiling information in a binary "
9502 "format for use by B<readprofile>(1). Writing (e.g., an empty string) to "
9503 "this file resets the profiling counters; on some architectures, writing a "
9504 "binary integer \"profiling multiplier\" of size I<sizeof(int)> sets the "
9505 "profiling interrupt frequency."
9509 #: build/C/man5/proc.5:1970
9511 msgid "I</proc/scsi>"
9515 #: build/C/man5/proc.5:1980
9517 "A directory with the I<scsi> mid-level pseudo-file and various SCSI "
9518 "low-level driver directories, which contain a file for each SCSI host in "
9519 "this system, all of which give the status of some part of the SCSI IO "
9520 "subsystem. These files contain ASCII structures and are, therefore, "
9521 "readable with B<cat>(1)."
9525 #: build/C/man5/proc.5:1983
9527 "You can also write to some of the files to reconfigure the subsystem or "
9528 "switch certain features on or off."
9532 #: build/C/man5/proc.5:1983
9534 msgid "I</proc/scsi/scsi>"
9538 #: build/C/man5/proc.5:1989
9540 "This is a listing of all SCSI devices known to the kernel. The listing is "
9541 "similar to the one seen during bootup. scsi currently supports only the "
9542 "I<add-single-device> command which allows root to add a hotplugged device to "
9543 "the list of known devices."
9547 #: build/C/man5/proc.5:1991
9552 #: build/C/man5/proc.5:1995
9554 msgid "echo \\(aqscsi add-single-device 1 0 5 0\\(aq E<gt> /proc/scsi/scsi\n"
9558 #: build/C/man5/proc.5:2003
9560 "will cause host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. "
9561 "If there is already a device known on this address or the address is "
9562 "invalid, an error will be returned."
9566 #: build/C/man5/proc.5:2003
9568 msgid "I</proc/scsi/[drivername]>"
9572 #: build/C/man5/proc.5:2013
9574 "I<[drivername]> can currently be NCR53c7xx, aha152x, aha1542, aha1740, "
9575 "aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, "
9576 "scsi_debug, seagate, t128, u15-24f, ultrastore, or wd7000. These "
9577 "directories show up for all drivers that registered at least one SCSI HBA. "
9578 "Every directory contains one file per registered host. Every host-file is "
9579 "named after the number the host was assigned during initialization."
9583 #: build/C/man5/proc.5:2016
9585 "Reading these files will usually show driver and host configuration, "
9590 #: build/C/man5/proc.5:2023
9592 "Writing to these files allows different things on different hosts. For "
9593 "example, with the I<latency> and I<nolatency> commands, root can switch on "
9594 "and off command latency measurement code in the eata_dma driver. With the "
9595 "I<lockup> and I<unlock> commands, root can control bus lockups simulated by "
9596 "the scsi_debug driver."
9600 #: build/C/man5/proc.5:2023
9602 msgid "I</proc/self>"
9606 #: build/C/man5/proc.5:2031
9608 "This directory refers to the process accessing the I</proc> file system, and "
9609 "is identical to the I</proc> directory named by the process ID of the same "
9614 #: build/C/man5/proc.5:2031
9616 msgid "I</proc/slabinfo>"
9620 #: build/C/man5/proc.5:2040
9622 "Information about kernel caches. Since Linux 2.6.16 this file is only "
9623 "present if the B<CONFIG_SLAB> kernel configuration option is enabled. The "
9624 "columns in I</proc/slabinfo> are:"
9628 #: build/C/man5/proc.5:2050
9635 "num-active-slabs\n"
9637 "num-pages-per-slab\n"
9641 #: build/C/man5/proc.5:2056
9642 msgid "See B<slabinfo>(5) for details."
9646 #: build/C/man5/proc.5:2056
9648 msgid "I</proc/stat>"
9652 #: build/C/man5/proc.5:2062
9654 "kernel/system statistics. Varies with architecture. Common entries "
9659 #: build/C/man5/proc.5:2063
9661 msgid "I<cpu 3357 0 4313 1362393>"
9664 #. 1024 on Alpha and ia64
9666 #: build/C/man5/proc.5:2071
9668 "The amount of time, measured in units of USER_HZ (1/100ths of a second on "
9669 "most architectures, use I<sysconf(_SC_CLK_TCK)> to obtain the right value), "
9670 "that the system spent in various states:"
9674 #: build/C/man5/proc.5:2072
9680 #: build/C/man5/proc.5:2075
9681 msgid "(1) Time spent in user mode."
9685 #: build/C/man5/proc.5:2075
9691 #: build/C/man5/proc.5:2078
9692 msgid "(2) Time spent in user mode with low priority (nice)."
9696 #: build/C/man5/proc.5:2078
9702 #: build/C/man5/proc.5:2081
9703 msgid "(3) Time spent in system mode."
9707 #: build/C/man5/proc.5:2081
9712 #. FIXME Actually, the following info about the /proc/stat 'cpu' field
9713 #. does not seem to be quite right (at least in 2.6.12 or 3.6):
9714 #. the idle time in /proc/uptime does not quite match this value
9716 #: build/C/man5/proc.5:2091
9718 "(4) Time spent in the idle task. This value should be USER_HZ times the "
9719 "second entry in the I</proc/uptime> pseudo-file."
9723 #: build/C/man5/proc.5:2091
9725 msgid "I<iowait> (since Linux 2.5.41)"
9729 #: build/C/man5/proc.5:2094
9730 msgid "(5) Time waiting for I/O to complete."
9734 #: build/C/man5/proc.5:2094
9736 msgid "I<irq> (since Linux 2.6.0-test4)"
9740 #: build/C/man5/proc.5:2097
9741 msgid "(6) Time servicing interrupts."
9745 #: build/C/man5/proc.5:2097
9747 msgid "I<softirq> (since Linux 2.6.0-test4)"
9751 #: build/C/man5/proc.5:2100
9752 msgid "(7) Time servicing softirqs."
9756 #: build/C/man5/proc.5:2100
9758 msgid "I<steal> (since Linux 2.6.11)"
9762 #: build/C/man5/proc.5:2104
9764 "(8) Stolen time, which is the time spent in other operating systems when "
9765 "running in a virtualized environment"
9769 #: build/C/man5/proc.5:2104
9771 msgid "I<guest> (since Linux 2.6.24)"
9774 #. See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de
9776 #: build/C/man5/proc.5:2109
9778 "(9) Time spent running a virtual CPU for guest operating systems under the "
9779 "control of the Linux kernel."
9783 #: build/C/man5/proc.5:2109
9785 msgid "I<guest_nice> (since Linux 2.6.33)"
9788 #. commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797
9790 #: build/C/man5/proc.5:2114
9792 "(10) Time spent running a niced guest (virtual CPU for guest operating "
9793 "systems under the control of the Linux kernel)."
9797 #: build/C/man5/proc.5:2115
9799 msgid "I<page 5741 1808>"
9803 #: build/C/man5/proc.5:2119
9805 "The number of pages the system paged in and the number that were paged out "
9810 #: build/C/man5/proc.5:2119
9816 #: build/C/man5/proc.5:2122
9817 msgid "The number of swap pages that have been brought in and out."
9820 #. FIXME The following is not the full picture for the 'intr' of
9821 #. /proc/stat on 2.6:
9823 #: build/C/man5/proc.5:2122
9825 msgid "I<intr 1462898>"
9829 #: build/C/man5/proc.5:2130
9831 "This line shows counts of interrupts serviced since boot time, for each of "
9832 "the possible system interrupts. The first column is the total of all "
9833 "interrupts serviced; each subsequent column is the total for a particular "
9838 #: build/C/man5/proc.5:2130
9840 msgid "I<disk_io: (2,0):(31,30,5764,1,2) (3,0):>..."
9844 #: build/C/man5/proc.5:2133
9846 "(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, "
9851 #: build/C/man5/proc.5:2135
9852 msgid "(Linux 2.4 only)"
9856 #: build/C/man5/proc.5:2135
9858 msgid "I<ctxt 115315>"
9862 #: build/C/man5/proc.5:2138
9863 msgid "The number of context switches that the system underwent."
9867 #: build/C/man5/proc.5:2138
9869 msgid "I<btime 769041601>"
9873 #: build/C/man5/proc.5:2141
9874 msgid "boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
9878 #: build/C/man5/proc.5:2141
9880 msgid "I<processes 86031>"
9884 #: build/C/man5/proc.5:2144
9885 msgid "Number of forks since boot."
9889 #: build/C/man5/proc.5:2144
9891 msgid "I<procs_running 6>"
9895 #: build/C/man5/proc.5:2148
9896 msgid "Number of processes in runnable state. (Linux 2.5.45 onward.)"
9900 #: build/C/man5/proc.5:2148
9902 msgid "I<procs_blocked 2>"
9906 #: build/C/man5/proc.5:2152
9908 "Number of processes blocked waiting for I/O to complete. (Linux 2.5.45 "
9913 #: build/C/man5/proc.5:2153
9915 msgid "I</proc/swaps>"
9919 #: build/C/man5/proc.5:2158
9920 msgid "Swap areas in use. See also B<swapon>(8)."
9924 #: build/C/man5/proc.5:2158
9926 msgid "I</proc/sys>"
9930 #: build/C/man5/proc.5:2166
9932 "This directory (present since 1.3.57) contains a number of files and "
9933 "subdirectories corresponding to kernel variables. These variables can be "
9934 "read and sometimes modified using the I</proc> file system, and the "
9935 "(deprecated) B<sysctl>(2) system call."
9939 #: build/C/man5/proc.5:2166
9941 msgid "I</proc/sys/abi> (since Linux 2.4.10)"
9944 #. On some systems, it is not present.
9946 #: build/C/man5/proc.5:2173
9948 "This directory may contain files with application binary information. See "
9949 "the Linux kernel source file I<Documentation/sysctl/abi.txt> for more "
9954 #: build/C/man5/proc.5:2173
9956 msgid "I</proc/sys/debug>"
9960 #: build/C/man5/proc.5:2176 build/C/man5/proc.5:2974
9961 msgid "This directory may be empty."
9965 #: build/C/man5/proc.5:2176
9967 msgid "I</proc/sys/dev>"
9971 #: build/C/man5/proc.5:2182
9973 "This directory contains device-specific information (e.g., "
9974 "I<dev/cdrom/info>). On some systems, it may be empty."
9978 #: build/C/man5/proc.5:2182
9980 msgid "I</proc/sys/fs>"
9984 #: build/C/man5/proc.5:2186
9986 "This directory contains the files and subdirectories for kernel variables "
9987 "related to file systems."
9991 #: build/C/man5/proc.5:2186
9993 msgid "I</proc/sys/fs/binfmt_misc>"
9997 #: build/C/man5/proc.5:2191
9999 "Documentation for files in this directory can be found in the Linux kernel "
10000 "sources in I<Documentation/binfmt_misc.txt>."
10004 #: build/C/man5/proc.5:2191
10006 msgid "I</proc/sys/fs/dentry-state> (since Linux 2.2)"
10009 #. type: Plain text
10010 #: build/C/man5/proc.5:2199
10012 "This file contains information about the status of the directory cache "
10013 "(dcache). The file contains six numbers, I<nr_dentry>, I<nr_unused>, "
10014 "I<age_limit> (age in seconds), I<want_pages> (pages requested by system) and "
10015 "two dummy values."
10018 #. type: Plain text
10019 #: build/C/man5/proc.5:2204
10021 "I<nr_dentry> is the number of allocated dentries (dcache entries). This "
10022 "field is unused in Linux 2.2."
10025 #. type: Plain text
10026 #: build/C/man5/proc.5:2207
10027 msgid "I<nr_unused> is the number of unused dentries."
10030 #. looks like this is unused in kernels 2.2 to 2.6
10031 #. type: Plain text
10032 #: build/C/man5/proc.5:2212
10034 "I<age_limit> is the age in seconds after which dcache entries can be "
10035 "reclaimed when memory is short."
10038 #. looks like this is unused in kernels 2.2 to 2.6
10039 #. type: Plain text
10040 #: build/C/man5/proc.5:2217
10042 "I<want_pages> is nonzero when the kernel has called shrink_dcache_pages() "
10043 "and the dcache isn't pruned yet."
10047 #: build/C/man5/proc.5:2218
10049 msgid "I</proc/sys/fs/dir-notify-enable>"
10052 #. type: Plain text
10053 #: build/C/man5/proc.5:2227
10055 "This file can be used to disable or enable the I<dnotify> interface "
10056 "described in B<fcntl>(2) on a system-wide basis. A value of 0 in this file "
10057 "disables the interface, and a value of 1 enables it."
10061 #: build/C/man5/proc.5:2227
10063 msgid "I</proc/sys/fs/dquot-max>"
10066 #. type: Plain text
10067 #: build/C/man5/proc.5:2234
10069 "This file shows the maximum number of cached disk quota entries. On some "
10070 "(2.4) systems, it is not present. If the number of free cached disk quota "
10071 "entries is very low and you have some awesome number of simultaneous system "
10072 "users, you might want to raise the limit."
10076 #: build/C/man5/proc.5:2234
10078 msgid "I</proc/sys/fs/dquot-nr>"
10081 #. type: Plain text
10082 #: build/C/man5/proc.5:2238
10084 "This file shows the number of allocated disk quota entries and the number of "
10085 "free disk quota entries."
10089 #: build/C/man5/proc.5:2238
10091 msgid "I</proc/sys/fs/epoll> (since Linux 2.6.28)"
10094 #. type: Plain text
10095 #: build/C/man5/proc.5:2247
10097 "This directory contains the file I<max_user_watches>, which can be used to "
10098 "limit the amount of kernel memory consumed by the I<epoll> interface. For "
10099 "further details, see B<epoll>(7)."
10103 #: build/C/man5/proc.5:2247
10105 msgid "I</proc/sys/fs/file-max>"
10108 #. type: Plain text
10109 #: build/C/man5/proc.5:2260
10111 "This file defines a system-wide limit on the number of open files for all "
10112 "processes. (See also B<setrlimit>(2), which can be used by a process to set "
10113 "the per-process limit, B<RLIMIT_NOFILE>, on the number of files it may "
10114 "open.) If you get lots of error messages in the kernel log about running "
10115 "out of file handles (look for \"VFS: file-max limit E<lt>numberE<gt> "
10116 "reached\"), try increasing this value:"
10119 #. type: Plain text
10120 #: build/C/man5/proc.5:2266
10122 msgid "CW< echo 100000 E<gt> /proc/sys/fs/file-max>\n"
10125 #. type: Plain text
10126 #: build/C/man5/proc.5:2273
10128 "The kernel constant B<NR_OPEN> imposes an upper limit on the value that may "
10129 "be placed in I<file-max>."
10132 #. type: Plain text
10133 #: build/C/man5/proc.5:2282
10135 "If you increase I</proc/sys/fs/file-max>, be sure to increase "
10136 "I</proc/sys/fs/inode-max> to 3-4 times the new value of "
10137 "I</proc/sys/fs/file-max>, or you will run out of inodes."
10140 #. type: Plain text
10141 #: build/C/man5/proc.5:2288
10142 msgid "Privileged processes (B<CAP_SYS_ADMIN>) can override the I<file-max> limit."
10146 #: build/C/man5/proc.5:2288
10148 msgid "I</proc/sys/fs/file-nr>"
10151 #. type: Plain text
10152 #: build/C/man5/proc.5:2307
10154 "This (read-only) file contains three numbers: the number of allocated file "
10155 "handles (i.e., the number of files presently opened); the number of free "
10156 "file handles; and the maximum number of file handles (i.e., the same value "
10157 "as I</proc/sys/fs/file-max>). If the number of allocated file handles is "
10158 "close to the maximum, you should consider increasing the maximum. Before "
10159 "Linux 2.6, the kernel allocated file handles dynamically, but it didn't free "
10160 "them again. Instead the free file handles were kept in a list for "
10161 "reallocation; the \"free file handles\" value indicates the size of that "
10162 "list. A large number of free file handles indicates that there was a past "
10163 "peak in the usage of open file handles. Since Linux 2.6, the kernel does "
10164 "deallocate freed file handles, and the \"free file handles\" value is always "
10169 #: build/C/man5/proc.5:2307
10171 msgid "I</proc/sys/fs/inode-max>"
10174 #. type: Plain text
10175 #: build/C/man5/proc.5:2317
10177 "This file contains the maximum number of in-memory inodes. On some (2.4) "
10178 "systems, it may not be present. This value should be 3-4 times larger than "
10179 "the value in I<file-max>, since I<stdin>, I<stdout> and network sockets also "
10180 "need an inode to handle them. When you regularly run out of inodes, you "
10181 "need to increase this value."
10185 #: build/C/man5/proc.5:2317
10187 msgid "I</proc/sys/fs/inode-nr>"
10190 #. type: Plain text
10191 #: build/C/man5/proc.5:2321
10192 msgid "This file contains the first two values from I<inode-state>."
10196 #: build/C/man5/proc.5:2321
10198 msgid "I</proc/sys/fs/inode-state>"
10201 #. type: Plain text
10202 #: build/C/man5/proc.5:2342
10204 "This file contains seven numbers: I<nr_inodes>, I<nr_free_inodes>, "
10205 "I<preshrink>, and four dummy values. I<nr_inodes> is the number of inodes "
10206 "the system has allocated. This can be slightly more than I<inode-max> "
10207 "because Linux allocates them one page full at a time. I<nr_free_inodes> "
10208 "represents the number of free inodes. I<preshrink> is nonzero when the "
10209 "I<nr_inodes> E<gt> I<inode-max> and the system needs to prune the inode list "
10210 "instead of allocating more."
10214 #: build/C/man5/proc.5:2342
10216 msgid "I</proc/sys/fs/inotify> (since Linux 2.6.13)"
10219 #. type: Plain text
10220 #: build/C/man5/proc.5:2351
10222 "This directory contains files I<max_queued_events>, I<max_user_instances>, "
10223 "and I<max_user_watches>, that can be used to limit the amount of kernel "
10224 "memory consumed by the I<inotify> interface. For further details, see "
10229 #: build/C/man5/proc.5:2351
10231 msgid "I</proc/sys/fs/lease-break-time>"
10234 #. type: Plain text
10235 #: build/C/man5/proc.5:2360
10237 "This file specifies the grace period that the kernel grants to a process "
10238 "holding a file lease (B<fcntl>(2)) after it has sent a signal to that "
10239 "process notifying it that another process is waiting to open the file. If "
10240 "the lease holder does not remove or downgrade the lease within this grace "
10241 "period, the kernel forcibly breaks the lease."
10245 #: build/C/man5/proc.5:2360
10247 msgid "I</proc/sys/fs/leases-enable>"
10250 #. type: Plain text
10251 #: build/C/man5/proc.5:2367
10253 "This file can be used to enable or disable file leases (B<fcntl>(2)) on a "
10254 "system-wide basis. If this file contains the value 0, leases are disabled. "
10255 "A nonzero value enables leases."
10259 #: build/C/man5/proc.5:2367
10261 msgid "I</proc/sys/fs/mqueue> (since Linux 2.6.6)"
10264 #. type: Plain text
10265 #: build/C/man5/proc.5:2375
10267 "This directory contains files I<msg_max>, I<msgsize_max>, and I<queues_max>, "
10268 "controlling the resources used by POSIX message queues. See "
10269 "B<mq_overview>(7) for details."
10273 #: build/C/man5/proc.5:2375
10275 msgid "I</proc/sys/fs/overflowgid> and I</proc/sys/fs/overflowuid>"
10278 #. type: Plain text
10279 #: build/C/man5/proc.5:2385
10281 "These files allow you to change the value of the fixed UID and GID. The "
10282 "default is 65534. Some file systems only support 16-bit UIDs and GIDs, "
10283 "although in Linux UIDs and GIDs are 32 bits. When one of these file systems "
10284 "is mounted with writes enabled, any UID or GID that would exceed 65535 is "
10285 "translated to the overflow value before being written to disk."
10289 #: build/C/man5/proc.5:2385
10291 msgid "I</proc/sys/fs/pipe-max-size> (since Linux 2.6.35)"
10294 #. type: Plain text
10295 #: build/C/man5/proc.5:2399
10297 "The value in this file defines an upper limit for raising the capacity of a "
10298 "pipe using the B<fcntl>(2) B<F_SETPIPE_SZ> operation. This limit applies "
10299 "only to unprivileged processes. The default value for this file is "
10300 "1,048,576. The value assigned to this file may be rounded upward, to "
10301 "reflect the value actually employed for a convenient implementation. To "
10302 "determine the rounded-up value, display the contents of this file after "
10303 "assigning a value to it. The minimum value that can be assigned to this "
10304 "file is the system page size."
10308 #: build/C/man5/proc.5:2399
10310 msgid "I</proc/sys/fs/protected_hardlinks> (since Linux 3.6)"
10313 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
10314 #. type: Plain text
10315 #: build/C/man5/proc.5:2408
10317 "When the value in this file is 0, no restrictions are placed on the creation "
10318 "of hard links (i.e., this is the historical behaviour before Linux 3.6). "
10319 "When the value in this file is 1, a hard link can be created to a target "
10320 "file only if one of the following conditions is true:"
10323 #. type: Plain text
10324 #: build/C/man5/proc.5:2413
10325 msgid "The caller has the B<CAP_FOWNER> capability."
10328 #. type: Plain text
10329 #: build/C/man5/proc.5:2419
10331 "The file system UID of the process creating the link matches the owner (UID) "
10332 "of the target file (as described in B<credentials>(7), a process's file "
10333 "system UID is normally the same as its effective UID)."
10336 #. type: Plain text
10337 #: build/C/man5/proc.5:2421
10338 msgid "All of the following conditions are true:"
10341 #. type: Plain text
10342 #: build/C/man5/proc.5:2424
10343 msgid "the target is a regular file;"
10346 #. type: Plain text
10347 #: build/C/man5/proc.5:2426
10348 msgid "the target file does not have its set-user-ID permission bit enabled;"
10351 #. type: Plain text
10352 #: build/C/man5/proc.5:2429
10354 "the target file does not have both its set-group-ID and group-executable "
10355 "permission bits enabled; and"
10358 #. type: Plain text
10359 #: build/C/man5/proc.5:2433
10361 "the caller has permission to read and write the target file (either via the "
10362 "file's permissions mask or because it has suitable capabilities)."
10365 #. type: Plain text
10366 #: build/C/man5/proc.5:2449
10368 "The default value in this file is 0. Setting the value to 1 prevents a "
10369 "longstanding class of security issues caused by hard-link-based "
10370 "time-of-check, time-of-use races, most commonly seen in world-writable "
10371 "directories such as I</tmp>. The common method of exploiting this flaw is "
10372 "to cross privilege boundaries when following a given hard link (i.e., a root "
10373 "process follows a hard link created by another user). Additionally, on "
10374 "systems without separated partitions, this stops unauthorized users from "
10375 "\"pinning\" vulnerable set-user-ID and set-group-ID files against being "
10376 "upgraded by the administrator, or linking to special files."
10380 #: build/C/man5/proc.5:2449
10382 msgid "I</proc/sys/fs/protected_symlinks> (since Linux 3.6)"
10385 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
10386 #. type: Plain text
10387 #: build/C/man5/proc.5:2457
10389 "When the value in this file is 0, no restrictions are placed on following "
10390 "symbolic links (i.e., this is the historical behaviour before Linux 3.6). "
10391 "When the value in this file is 1, symbolic links are followed only in the "
10392 "following circumstances:"
10395 #. type: Plain text
10396 #: build/C/man5/proc.5:2464
10398 "the file system UID of the process following the link matches the owner "
10399 "(UID) of the symbolic link (as described in B<credentials>(7), a process's "
10400 "file system UID is normally the same as its effective UID);"
10403 #. type: Plain text
10404 #: build/C/man5/proc.5:2466
10405 msgid "the link is not in a sticky world-writable directory; or"
10408 #. type: Plain text
10409 #: build/C/man5/proc.5:2468
10410 msgid "the symbolic link and and its parent directory have the same owner (UID)"
10413 #. type: Plain text
10414 #: build/C/man5/proc.5:2475
10416 "A system call that fails to follow a symbolic link because of the above "
10417 "restrictions returns the error B<EACCES> in I<errno>."
10420 #. type: Plain text
10421 #: build/C/man5/proc.5:2479
10423 "The default value in this file is 0. Setting the value to 1 avoids a "
10424 "longstanding class of security issues based on time-of-check, time-of-use "
10425 "races when accessing symbolic links."
10429 #: build/C/man5/proc.5:2479
10431 msgid "I</proc/sys/fs/suid_dumpable> (since Linux 2.6.13)"
10434 #. The following is based on text from Documentation/sysctl/kernel.txt
10435 #. type: Plain text
10436 #: build/C/man5/proc.5:2485
10438 "The value in this file determines whether core dump files are produced for "
10439 "set-user-ID or otherwise protected/tainted binaries. Three different "
10440 "integer values can be specified:"
10444 #: build/C/man5/proc.5:2486
10446 msgid "I<0\\ (default)>"
10449 #. type: Plain text
10450 #: build/C/man5/proc.5:2495
10452 "This provides the traditional (pre-Linux 2.6.13) behavior. A core dump will "
10453 "not be produced for a process which has changed credentials (by calling "
10454 "B<seteuid>(2), B<setgid>(2), or similar, or by executing a set-user-ID or "
10455 "set-group-ID program) or whose binary does not have read permission "
10460 #: build/C/man5/proc.5:2495
10462 msgid "I<1\\ (\"debug\")>"
10465 #. type: Plain text
10466 #: build/C/man5/proc.5:2502
10468 "All processes dump core when possible. The core dump is owned by the file "
10469 "system user ID of the dumping process and no security is applied. This is "
10470 "intended for system debugging situations only. Ptrace is unchecked."
10474 #: build/C/man5/proc.5:2502
10476 msgid "I<2\\ (\"suidsafe\")>"
10479 #. type: Plain text
10480 #: build/C/man5/proc.5:2511
10482 "Any binary which normally would not be dumped (see \"0\" above) is dumped "
10483 "readable by root only. This allows the user to remove the core dump file "
10484 "but not to read it. For security reasons core dumps in this mode will not "
10485 "overwrite one another or other files. This mode is appropriate when "
10486 "administrators are attempting to debug problems in a normal environment."
10489 #. 9520628e8ceb69fa9a4aee6b57f22675d9e1b709
10490 #. 54b501992dd2a839e94e76aa392c392b55080ce8
10491 #. type: Plain text
10492 #: build/C/man5/proc.5:2522
10494 "Additionally, since Linux 3.6, I</proc/sys/kernel/core_pattern> must either "
10495 "be an absolute pathname or a pipe command, as detailed in B<core>(5). "
10496 "Warnings will be written to the kernel log if I<core_pattern> does not "
10497 "follow these rules, and no core dump will be produced."
10501 #: build/C/man5/proc.5:2523
10503 msgid "I</proc/sys/fs/super-max>"
10506 #. type: Plain text
10507 #: build/C/man5/proc.5:2534
10509 "This file controls the maximum number of superblocks, and thus the maximum "
10510 "number of mounted file systems the kernel can have. You only need to "
10511 "increase I<super-max> if you need to mount more file systems than the "
10512 "current value in I<super-max> allows you to."
10516 #: build/C/man5/proc.5:2534
10518 msgid "I</proc/sys/fs/super-nr>"
10521 #. type: Plain text
10522 #: build/C/man5/proc.5:2538
10523 msgid "This file contains the number of file systems currently mounted."
10527 #: build/C/man5/proc.5:2538
10529 msgid "I</proc/sys/kernel>"
10532 #. type: Plain text
10533 #: build/C/man5/proc.5:2542
10535 "This directory contains files controlling a range of kernel parameters, as "
10540 #: build/C/man5/proc.5:2542
10542 msgid "I</proc/sys/kernel/acct>"
10545 #. type: Plain text
10546 #: build/C/man5/proc.5:2566
10548 "This file contains three numbers: I<highwater>, I<lowwater>, and "
10549 "I<frequency>. If BSD-style process accounting is enabled these values "
10550 "control its behavior. If free space on file system where the log lives goes "
10551 "below I<lowwater> percent accounting suspends. If free space gets above "
10552 "I<highwater> percent accounting resumes. I<frequency> determines how often "
10553 "the kernel checks the amount of free space (value is in seconds). Default "
10554 "values are 4, 2 and 30. That is, suspend accounting if 2% or less space is "
10555 "free; resume it if 4% or more space is free; consider information about "
10556 "amount of free space valid for 30 seconds."
10560 #: build/C/man5/proc.5:2566
10562 msgid "I</proc/sys/kernel/cap-bound> (from Linux 2.2 to 2.6.24)"
10565 #. type: Plain text
10566 #: build/C/man5/proc.5:2578
10568 "This file holds the value of the kernel I<capability bounding set> "
10569 "(expressed as a signed decimal number). This set is ANDed against the "
10570 "capabilities permitted to a process during B<execve>(2). Starting with "
10571 "Linux 2.6.25, the system-wide capability bounding set disappeared, and was "
10572 "replaced by a per-thread bounding set; see B<capabilities>(7)."
10576 #: build/C/man5/proc.5:2578
10578 msgid "I</proc/sys/kernel/core_pattern>"
10582 #: build/C/man5/proc.5:2582
10584 msgid "I</proc/sys/kernel/core_uses_pid>"
10588 #: build/C/man5/proc.5:2586
10590 msgid "I</proc/sys/kernel/ctrl-alt-del>"
10593 #. type: Plain text
10594 #: build/C/man5/proc.5:2601
10596 "This file controls the handling of Ctrl-Alt-Del from the keyboard. When the "
10597 "value in this file is 0, Ctrl-Alt-Del is trapped and sent to the B<init>(8) "
10598 "program to handle a graceful restart. When the value is greater than zero, "
10599 "Linux's reaction to a Vulcan Nerve Pinch (tm) will be an immediate reboot, "
10600 "without even syncing its dirty buffers. Note: when a program (like dosemu) "
10601 "has the keyboard in \"raw\" mode, the ctrl-alt-del is intercepted by the "
10602 "program before it ever reaches the kernel tty layer, and it's up to the "
10603 "program to decide what to do with it."
10607 #: build/C/man5/proc.5:2601
10609 msgid "I</proc/sys/kernel/dmesg_restrict> (since Linux 2.6.37)"
10612 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
10613 #. type: Plain text
10614 #: build/C/man5/proc.5:2614
10616 "The value in this file determines who can see kernel syslog contents. A "
10617 "value of 0 in this file imposes no restrictions. If the value is 1, only "
10618 "privileged users can read the kernel syslog. (See B<syslog>(2) for more "
10619 "details.) Since Linux 3.4, only users with the B<CAP_SYS_ADMIN> capability "
10620 "may change the value in this file."
10624 #: build/C/man5/proc.5:2614
10626 msgid "I</proc/sys/kernel/domainname> and I</proc/sys/kernel/hostname>"
10629 #. type: Plain text
10630 #: build/C/man5/proc.5:2622
10632 "can be used to set the NIS/YP domainname and the hostname of your box in "
10633 "exactly the same way as the commands B<domainname>(1) and B<hostname>(1), "
10637 #. type: Plain text
10638 #: build/C/man5/proc.5:2627
10641 "#B< echo \\(aqdarkstar\\(aq E<gt> /proc/sys/kernel/hostname>\n"
10642 "#B< echo \\(aqmydomain\\(aq E<gt> /proc/sys/kernel/domainname>\n"
10645 #. type: Plain text
10646 #: build/C/man5/proc.5:2631
10647 msgid "has the same effect as"
10650 #. type: Plain text
10651 #: build/C/man5/proc.5:2636
10654 "#B< hostname \\(aqdarkstar\\(aq>\n"
10655 "#B< domainname \\(aqmydomain\\(aq>\n"
10658 #. type: Plain text
10659 #: build/C/man5/proc.5:2649
10661 "Note, however, that the classic darkstar.frop.org has the hostname "
10662 "\"darkstar\" and DNS (Internet Domain Name Server) domainname \"frop.org\", "
10663 "not to be confused with the NIS (Network Information Service) or YP (Yellow "
10664 "Pages) domainname. These two domain names are in general different. For a "
10665 "detailed discussion see the B<hostname>(1) man page."
10669 #: build/C/man5/proc.5:2649
10671 msgid "I</proc/sys/kernel/hotplug>"
10674 #. type: Plain text
10675 #: build/C/man5/proc.5:2655
10677 "This file contains the path for the hotplug policy agent. The default value "
10678 "in this file is I</sbin/hotplug>."
10682 #: build/C/man5/proc.5:2655
10684 msgid "I</proc/sys/kernel/htab-reclaim>"
10687 #. type: Plain text
10688 #: build/C/man5/proc.5:2663
10690 "(PowerPC only) If this file is set to a nonzero value, the PowerPC htab (see "
10691 "kernel file I<Documentation/powerpc/ppc_htab.txt>) is pruned each time the "
10692 "system hits the idle loop."
10696 #: build/C/man5/proc.5:2663
10698 msgid "I</proc/sys/kernel/kptr_restrict> (since Linux 2.6.38)"
10701 #. 455cd5ab305c90ffc422dd2e0fb634730942b257
10702 #. commit 411f05f123cbd7f8aa1edcae86970755a6e2a9d9
10703 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
10704 #. type: Plain text
10705 #: build/C/man5/proc.5:2688
10707 "The value in this file determines whether kernel addresses are exposed via "
10708 "I</proc> files and other interfaces. A value of 0 in this file imposes no "
10709 "restrictions. If the value is 1, kernel pointers printed using the I<%pK> "
10710 "format specifier will be replaced with zeros unless the user has the "
10711 "B<CAP_SYSLOG> capability. If the value is 2, kernel pointers printed using "
10712 "the I<%pK> format specifier will be replaced with zeros regardless of the "
10713 "user's capabilities. The initial default value for this file was 1, but the "
10714 "default was changed to 0 in Linux 2.6.39. Since Linux 3.4, only users with "
10715 "the B<CAP_SYS_ADMIN> capability can change the value in this file."
10719 #: build/C/man5/proc.5:2688
10721 msgid "I</proc/sys/kernel/l2cr>"
10724 #. type: Plain text
10725 #: build/C/man5/proc.5:2695
10727 "(PowerPC only) This file contains a flag that controls the L2 cache of G3 "
10728 "processor boards. If 0, the cache is disabled. Enabled if nonzero."
10732 #: build/C/man5/proc.5:2695
10734 msgid "I</proc/sys/kernel/modprobe>"
10737 #. type: Plain text
10738 #: build/C/man5/proc.5:2708
10740 "This file contains the path for the kernel module loader. The default value "
10741 "is I</sbin/modprobe>. The file is only present if the kernel is built with "
10742 "the B<CONFIG_MODULES> (B<CONFIG_KMOD> in Linux 2.6.26 and earlier) option "
10743 "enabled. It is described by the Linux kernel source file "
10744 "I<Documentation/kmod.txt> (only present in kernel 2.4 and earlier)."
10748 #: build/C/man5/proc.5:2708
10750 msgid "I</proc/sys/kernel/modules_disabled> (since Linux 2.6.31)"
10753 #. 3d43321b7015387cfebbe26436d0e9d299162ea1
10754 #. From Documentation/sysctl/kernel.txt
10755 #. type: Plain text
10756 #: build/C/man5/proc.5:2720
10758 "A toggle value indicating if modules are allowed to be loaded in an "
10759 "otherwise modular kernel. This toggle defaults to off (0), but can be set "
10760 "true (1). Once true, modules can be neither loaded nor unloaded, and the "
10761 "toggle cannot be set back to false. The file is only present if the kernel "
10762 "is built with the B<CONFIG_MODULES> option enabled."
10766 #: build/C/man5/proc.5:2720
10768 msgid "I</proc/sys/kernel/msgmax>"
10771 #. type: Plain text
10772 #: build/C/man5/proc.5:2725
10774 "This file defines a system-wide limit specifying the maximum number of bytes "
10775 "in a single message written on a System V message queue."
10779 #: build/C/man5/proc.5:2725
10781 msgid "I</proc/sys/kernel/msgmni>"
10784 #. type: Plain text
10785 #: build/C/man5/proc.5:2730
10787 "This file defines the system-wide limit on the number of message queue "
10788 "identifiers. (This file is only present in Linux 2.4 onward.)"
10792 #: build/C/man5/proc.5:2730
10794 msgid "I</proc/sys/kernel/msgmnb>"
10797 #. type: Plain text
10798 #: build/C/man5/proc.5:2739
10800 "This file defines a system-wide parameter used to initialize the "
10801 "I<msg_qbytes> setting for subsequently created message queues. The "
10802 "I<msg_qbytes> setting specifies the maximum number of bytes that may be "
10803 "written to the message queue."
10807 #: build/C/man5/proc.5:2739
10809 msgid "I</proc/sys/kernel/ostype> and I</proc/sys/kernel/osrelease>"
10812 #. type: Plain text
10813 #: build/C/man5/proc.5:2744
10814 msgid "These files give substrings of I</proc/version>."
10818 #: build/C/man5/proc.5:2744
10820 msgid "I</proc/sys/kernel/overflowgid> and I</proc/sys/kernel/overflowuid>"
10823 #. type: Plain text
10824 #: build/C/man5/proc.5:2750
10826 "These files duplicate the files I</proc/sys/fs/overflowgid> and "
10827 "I</proc/sys/fs/overflowuid>."
10831 #: build/C/man5/proc.5:2750
10833 msgid "I</proc/sys/kernel/panic>"
10836 #. type: Plain text
10837 #: build/C/man5/proc.5:2759
10839 "This file gives read/write access to the kernel variable I<panic_timeout>. "
10840 "If this is zero, the kernel will loop on a panic; if nonzero it indicates "
10841 "that the kernel should autoreboot after this number of seconds. When you "
10842 "use the software watchdog device driver, the recommended setting is 60."
10846 #: build/C/man5/proc.5:2759
10848 msgid "I</proc/sys/kernel/panic_on_oops> (since Linux 2.5.68)"
10851 #. type: Plain text
10852 #: build/C/man5/proc.5:2771
10854 "This file controls the kernel's behavior when an oops or BUG is "
10855 "encountered. If this file contains 0, then the system tries to continue "
10856 "operation. If it contains 1, then the system delays a few seconds (to give "
10857 "klogd time to record the oops output) and then panics. If the "
10858 "I</proc/sys/kernel/panic> file is also nonzero then the machine will be "
10863 #: build/C/man5/proc.5:2771
10865 msgid "I</proc/sys/kernel/pid_max> (since Linux 2.5.34)"
10868 #. Prior to 2.6.10, pid_max could also be raised above 32768 on 32-bit
10869 #. platforms, but this broke /proc/[pid]
10870 #. See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2
10871 #. type: Plain text
10872 #: build/C/man5/proc.5:2787
10874 "This file specifies the value at which PIDs wrap around (i.e., the value in "
10875 "this file is one greater than the maximum PID). The default value for this "
10876 "file, 32768, results in the same range of PIDs as on earlier kernels. On "
10877 "32-bit platforms, 32768 is the maximum value for I<pid_max>. On 64-bit "
10878 "systems, I<pid_max> can be set to any value up to 2^22 (B<PID_MAX_LIMIT>, "
10879 "approximately 4 million)."
10883 #: build/C/man5/proc.5:2787
10885 msgid "I</proc/sys/kernel/powersave-nap> (PowerPC only)"
10888 #. type: Plain text
10889 #: build/C/man5/proc.5:2793
10891 "This file contains a flag. If set, Linux-PPC will use the \"nap\" mode of "
10892 "powersaving, otherwise the \"doze\" mode will be used."
10896 #: build/C/man5/proc.5:2793
10898 msgid "I</proc/sys/kernel/printk>"
10901 #. type: Plain text
10902 #: build/C/man5/proc.5:2819
10904 "The four values in this file are I<console_loglevel>, "
10905 "I<default_message_loglevel>, I<minimum_console_level>, and "
10906 "I<default_console_loglevel>. These values influence I<printk()> behavior "
10907 "when printing or logging error messages. See B<syslog>(2) for more info on "
10908 "the different loglevels. Messages with a higher priority than "
10909 "I<console_loglevel> will be printed to the console. Messages without an "
10910 "explicit priority will be printed with priority I<default_message_level>. "
10911 "I<minimum_console_loglevel> is the minimum (highest) value to which "
10912 "I<console_loglevel> can be set. I<default_console_loglevel> is the default "
10913 "value for I<console_loglevel>."
10917 #: build/C/man5/proc.5:2819
10919 msgid "I</proc/sys/kernel/pty> (since Linux 2.6.4)"
10922 #. type: Plain text
10923 #: build/C/man5/proc.5:2825
10925 "This directory contains two files relating to the number of UNIX 98 "
10926 "pseudoterminals (see B<pts>(4)) on the system."
10930 #: build/C/man5/proc.5:2825
10932 msgid "I</proc/sys/kernel/pty/max>"
10935 #. type: Plain text
10936 #: build/C/man5/proc.5:2828
10937 msgid "This file defines the maximum number of pseudoterminals."
10941 #: build/C/man5/proc.5:2828
10943 msgid "I</proc/sys/kernel/pty/nr>"
10946 #. type: Plain text
10947 #: build/C/man5/proc.5:2832
10948 msgid "This read-only file indicates how many pseudoterminals are currently in use."
10952 #: build/C/man5/proc.5:2832
10954 msgid "I</proc/sys/kernel/random>"
10957 #. type: Plain text
10958 #: build/C/man5/proc.5:2840
10960 "This directory contains various parameters controlling the operation of the "
10961 "file I</dev/random>. See B<random>(4) for further information."
10965 #: build/C/man5/proc.5:2840
10967 msgid "I</proc/sys/kernel/real-root-dev>"
10970 #. type: Plain text
10971 #: build/C/man5/proc.5:2844
10973 "This file is documented in the Linux kernel source file "
10974 "I<Documentation/initrd.txt>."
10978 #: build/C/man5/proc.5:2844
10980 msgid "I</proc/sys/kernel/reboot-cmd> (Sparc only) "
10983 #. type: Plain text
10984 #: build/C/man5/proc.5:2850
10986 "This file seems to be a way to give an argument to the SPARC ROM/Flash boot "
10987 "loader. Maybe to tell it what to do after rebooting?"
10991 #: build/C/man5/proc.5:2850
10993 msgid "I</proc/sys/kernel/rtsig-max>"
10996 #. type: Plain text
10997 #: build/C/man5/proc.5:2857
10999 "(Only in kernels up to and including 2.6.7; see B<setrlimit>(2)) This file "
11000 "can be used to tune the maximum number of POSIX real-time (queued) signals "
11001 "that can be outstanding in the system."
11005 #: build/C/man5/proc.5:2857
11007 msgid "I</proc/sys/kernel/rtsig-nr>"
11010 #. type: Plain text
11011 #: build/C/man5/proc.5:2861
11013 "(Only in kernels up to and including 2.6.7.) This file shows the number "
11014 "POSIX real-time signals currently queued."
11018 #: build/C/man5/proc.5:2861
11020 msgid "I</proc/sys/kernel/sem> (since Linux 2.4)"
11023 #. type: Plain text
11024 #: build/C/man5/proc.5:2865
11026 "This file contains 4 numbers defining limits for System V IPC semaphores. "
11027 "These fields are, in order:"
11031 #: build/C/man5/proc.5:2866
11036 #. type: Plain text
11037 #: build/C/man5/proc.5:2868
11038 msgid "The maximum semaphores per semaphore set."
11042 #: build/C/man5/proc.5:2868
11047 #. type: Plain text
11048 #: build/C/man5/proc.5:2870
11049 msgid "A system-wide limit on the number of semaphores in all semaphore sets."
11053 #: build/C/man5/proc.5:2870
11058 #. type: Plain text
11059 #: build/C/man5/proc.5:2874
11061 "The maximum number of operations that may be specified in a B<semop>(2) "
11066 #: build/C/man5/proc.5:2874
11071 #. type: Plain text
11072 #: build/C/man5/proc.5:2876
11073 msgid "A system-wide limit on the maximum number of semaphore identifiers."
11077 #: build/C/man5/proc.5:2877
11079 msgid "I</proc/sys/kernel/sg-big-buff>"
11082 #. type: Plain text
11083 #: build/C/man5/proc.5:2888
11085 "This file shows the size of the generic SCSI device (sg) buffer. You can't "
11086 "tune it just yet, but you could change it at compile time by editing "
11087 "I<include/scsi/sg.h> and changing the value of B<SG_BIG_BUFF>. However, "
11088 "there shouldn't be any reason to change this value."
11092 #: build/C/man5/proc.5:2888
11094 msgid "I</proc/sys/kernel/shmall>"
11097 #. type: Plain text
11098 #: build/C/man5/proc.5:2893
11100 "This file contains the system-wide limit on the total number of pages of "
11101 "System V shared memory."
11105 #: build/C/man5/proc.5:2893
11107 msgid "I</proc/sys/kernel/shmmax>"
11110 #. type: Plain text
11111 #: build/C/man5/proc.5:2903
11113 "This file can be used to query and set the run-time limit on the maximum "
11114 "(System V IPC) shared memory segment size that can be created. Shared "
11115 "memory segments up to 1GB are now supported in the kernel. This value "
11116 "defaults to B<SHMMAX>."
11120 #: build/C/man5/proc.5:2903
11122 msgid "I</proc/sys/kernel/shmmni>"
11125 #. type: Plain text
11126 #: build/C/man5/proc.5:2909
11128 "(available in Linux 2.4 and onward) This file specifies the system-wide "
11129 "maximum number of System V shared memory segments that can be created."
11133 #: build/C/man5/proc.5:2909
11135 msgid "I</proc/sys/kernel/sysrq>"
11138 #. type: Plain text
11139 #: build/C/man5/proc.5:2918
11141 "This file controls the functions allowed to be invoked by the SysRq key. By "
11142 "default, the file contains 1 meaning that every possible SysRq request is "
11143 "allowed (in older kernel versions, SysRq was disabled by default, and you "
11144 "were required to specifically enable it at run-time, but this is not the "
11145 "case any more). Possible values in this file are:"
11148 #. type: Plain text
11149 #: build/C/man5/proc.5:2930
11152 " 0 - disable sysrq completely\n"
11153 " 1 - enable all functions of sysrq\n"
11154 " E<gt>1 - bit mask of allowed sysrq functions, as follows:\n"
11155 " 2 - enable control of console logging level\n"
11156 " 4 - enable control of keyboard (SAK, unraw)\n"
11157 " 8 - enable debugging dumps of processes etc.\n"
11158 " 16 - enable sync command\n"
11159 " 32 - enable remount read-only\n"
11160 " 64 - enable signalling of processes (term, kill, oom-kill)\n"
11161 " 128 - allow reboot/poweroff\n"
11162 " 256 - allow nicing of all real-time tasks\n"
11165 #. type: Plain text
11166 #: build/C/man5/proc.5:2936
11168 "This file is only present if the B<CONFIG_MAGIC_SYSRQ> kernel configuration "
11169 "option is enabled. For further details see the Linux kernel source file "
11170 "I<Documentation/sysrq.txt>."
11174 #: build/C/man5/proc.5:2936
11176 msgid "I</proc/sys/kernel/version>"
11179 #. type: Plain text
11180 #: build/C/man5/proc.5:2939
11181 msgid "This file contains a string like:"
11184 #. type: Plain text
11185 #: build/C/man5/proc.5:2941
11187 msgid " #5 Wed Feb 25 21:49:24 MET 1998\n"
11190 #. type: Plain text
11191 #: build/C/man5/proc.5:2945
11193 "The \"#5\" means that this is the fifth kernel built from this source base "
11194 "and the date behind it indicates the time the kernel was built."
11198 #: build/C/man5/proc.5:2945
11200 msgid "I</proc/sys/kernel/threads-max> (since Linux 2.3.11)"
11203 #. type: Plain text
11204 #: build/C/man5/proc.5:2949
11206 "This file specifies the system-wide limit on the number of threads (tasks) "
11207 "that can be created on the system."
11211 #: build/C/man5/proc.5:2949
11213 msgid "I</proc/sys/kernel/zero-paged> (PowerPC only) "
11216 #. type: Plain text
11217 #: build/C/man5/proc.5:2955
11219 "This file contains a flag. When enabled (nonzero), Linux-PPC will pre-zero "
11220 "pages in the idle loop, possibly speeding up get_free_pages."
11224 #: build/C/man5/proc.5:2955
11226 msgid "I</proc/sys/net>"
11229 #. type: Plain text
11230 #: build/C/man5/proc.5:2962
11232 "This directory contains networking stuff. Explanations for some of the "
11233 "files under this directory can be found in B<tcp>(7) and B<ip>(7)."
11237 #: build/C/man5/proc.5:2962
11239 msgid "I</proc/sys/net/core/somaxconn>"
11242 #. type: Plain text
11243 #: build/C/man5/proc.5:2971
11245 "This file defines a ceiling value for the I<backlog> argument of "
11246 "B<listen>(2); see the B<listen>(2) manual page for details."
11250 #: build/C/man5/proc.5:2971
11252 msgid "I</proc/sys/proc>"
11256 #: build/C/man5/proc.5:2974
11258 msgid "I</proc/sys/sunrpc>"
11261 #. type: Plain text
11262 #: build/C/man5/proc.5:2979
11264 "This directory supports Sun remote procedure call for network file system "
11265 "(NFS). On some systems, it is not present."
11269 #: build/C/man5/proc.5:2979
11271 msgid "I</proc/sys/vm>"
11274 #. type: Plain text
11275 #: build/C/man5/proc.5:2983
11277 "This directory contains files for memory management tuning, buffer and cache "
11282 #: build/C/man5/proc.5:2983
11284 msgid "I</proc/sys/vm/drop_caches> (since Linux 2.6.16)"
11287 #. type: Plain text
11288 #: build/C/man5/proc.5:2987
11290 "Writing to this file causes the kernel to drop clean caches, dentries and "
11291 "inodes from memory, causing that memory to become free."
11294 #. type: Plain text
11295 #: build/C/man5/proc.5:2994
11297 "To free pagecache, use I<echo 1 E<gt> /proc/sys/vm/drop_caches>; to free "
11298 "dentries and inodes, use I<echo 2 E<gt> /proc/sys/vm/drop_caches>; to free "
11299 "pagecache, dentries and inodes, use I<echo 3 E<gt> "
11300 "/proc/sys/vm/drop_caches>."
11303 #. type: Plain text
11304 #: build/C/man5/proc.5:3000
11306 "Because this is a nondestructive operation and dirty objects are not "
11307 "freeable, the user should run B<sync>(8) first."
11311 #: build/C/man5/proc.5:3000
11313 msgid "I</proc/sys/vm/legacy_va_layout> (since Linux 2.6.9)"
11316 #. The following is from Documentation/filesystems/proc.txt
11317 #. type: Plain text
11318 #: build/C/man5/proc.5:3005
11320 "If nonzero, this disables the new 32-bit memory-mapping layout; the kernel "
11321 "will use the legacy (2.4) layout for all processes."
11325 #: build/C/man5/proc.5:3005
11327 msgid "I</proc/sys/vm/memory_failure_early_kill> (since Linux 2.6.32)"
11330 #. The following is based on the text in Documentation/sysctl/vm.txt
11331 #. type: Plain text
11332 #: build/C/man5/proc.5:3017
11334 "Control how to kill processes when an uncorrected memory error (typically a "
11335 "2-bit error in a memory module) that cannot be handled by the kernel is "
11336 "detected in the background by hardware. In some cases (like the page still "
11337 "having a valid copy on disk), the kernel will handle the failure "
11338 "transparently without affecting any applications. But if there is no other "
11339 "up-to-date copy of the data, it will kill processes to prevent any data "
11340 "corruptions from propagating."
11343 #. type: Plain text
11344 #: build/C/man5/proc.5:3019
11345 msgid "The file has one of the following values:"
11349 #: build/C/man5/proc.5:3020 build/C/man5/proc.5:3057
11354 #. type: Plain text
11355 #: build/C/man5/proc.5:3025
11357 "Kill all processes that have the corrupted-and-not-reloadable page mapped as "
11358 "soon as the corruption is detected. Note this is not supported for a few "
11359 "types of pages, like kernel internally allocated data or the swap cache, but "
11360 "works for the majority of user pages."
11364 #: build/C/man5/proc.5:3025 build/C/man5/proc.5:3059
11369 #. type: Plain text
11370 #: build/C/man5/proc.5:3028
11372 "Only unmap the corrupted page from all processes and only kill a process who "
11373 "tries to access it."
11376 #. type: Plain text
11377 #: build/C/man5/proc.5:3039
11379 "The kill is performed using a B<SIGBUS> signal with I<si_code> set to "
11380 "B<BUS_MCEERR_AO>. Processes can handle this if they want to; see "
11381 "B<sigaction>(2) for more details."
11384 #. type: Plain text
11385 #: build/C/man5/proc.5:3042
11387 "This feature is only active on architectures/platforms with advanced machine "
11388 "check handling and depends on the hardware capabilities."
11391 #. type: Plain text
11392 #: build/C/man5/proc.5:3049
11394 "Applications can override the I<memory_failure_early_kill> setting "
11395 "individually with the B<prctl>(2) B<PR_MCE_KILL> operation."
11398 #. type: Plain text
11399 #: build/C/man5/proc.5:3052 build/C/man5/proc.5:3065
11400 msgid "Only present if the kernel was configured with B<CONFIG_MEMORY_FAILURE>."
11404 #: build/C/man5/proc.5:3052
11406 msgid "I</proc/sys/vm/memory_failure_recovery> (since Linux 2.6.32)"
11409 #. The following is based on the text in Documentation/sysctl/vm.txt
11410 #. type: Plain text
11411 #: build/C/man5/proc.5:3056
11412 msgid "Enable memory failure recovery (when supported by the platform)"
11415 #. type: Plain text
11416 #: build/C/man5/proc.5:3059
11417 msgid "Attempt recovery."
11420 #. type: Plain text
11421 #: build/C/man5/proc.5:3061
11422 msgid "Always panic on a memory failure."
11426 #: build/C/man5/proc.5:3065
11428 msgid "I</proc/sys/vm/oom_dump_tasks> (since Linux 2.6.25)"
11431 #. The following is from Documentation/sysctl/vm.txt
11432 #. type: Plain text
11433 #: build/C/man5/proc.5:3080
11435 "Enables a system-wide task dump (excluding kernel threads) to be produced "
11436 "when the kernel performs an OOM-killing. The dump includes the following "
11437 "information for each task (thread, process): thread ID, real user ID, thread "
11438 "group ID (process ID), virtual memory size, resident set size, the CPU that "
11439 "the task is scheduled on, oom_adj score (see the description of "
11440 "I</proc/[pid]/oom_adj>), and command name. This is helpful to determine why "
11441 "the OOM-killer was invoked and to identify the rogue task that caused it."
11444 #. type: Plain text
11445 #: build/C/man5/proc.5:3086
11447 "If this contains the value zero, this information is suppressed. On very "
11448 "large systems with thousands of tasks, it may not be feasible to dump the "
11449 "memory state information for each one. Such systems should not be forced to "
11450 "incur a performance penalty in OOM situations when the information may not "
11454 #. type: Plain text
11455 #: build/C/man5/proc.5:3089
11457 "If this is set to nonzero, this information is shown whenever the OOM-killer "
11458 "actually kills a memory-hogging task."
11461 #. type: Plain text
11462 #: build/C/man5/proc.5:3091 build/C/man5/proc.5:3112
11463 msgid "The default value is 0."
11467 #: build/C/man5/proc.5:3091
11469 msgid "I</proc/sys/vm/oom_kill_allocating_task> (since Linux 2.6.24)"
11472 #. The following is from Documentation/sysctl/vm.txt
11473 #. type: Plain text
11474 #: build/C/man5/proc.5:3096
11476 "This enables or disables killing the OOM-triggering task in out-of-memory "
11480 #. type: Plain text
11481 #: build/C/man5/proc.5:3101
11483 "If this is set to zero, the OOM-killer will scan through the entire tasklist "
11484 "and select a task based on heuristics to kill. This normally selects a "
11485 "rogue memory-hogging task that frees up a large amount of memory when "
11489 #. type: Plain text
11490 #: build/C/man5/proc.5:3105
11492 "If this is set to nonzero, the OOM-killer simply kills the task that "
11493 "triggered the out-of-memory condition. This avoids a possibly expensive "
11497 #. type: Plain text
11498 #: build/C/man5/proc.5:3110
11500 "If I</proc/sys/vm/panic_on_oom> is nonzero, it takes precedence over "
11501 "whatever value is used in I</proc/sys/vm/oom_kill_allocating_task>."
11505 #: build/C/man5/proc.5:3112
11507 msgid "I</proc/sys/vm/overcommit_memory>"
11510 #. type: Plain text
11511 #: build/C/man5/proc.5:3116
11512 msgid "This file contains the kernel virtual memory accounting mode. Values are:"
11515 #. type: Plain text
11516 #: build/C/man5/proc.5:3119
11517 msgid "0: heuristic overcommit (this is the default)"
11520 #. type: Plain text
11521 #: build/C/man5/proc.5:3121
11522 msgid "1: always overcommit, never check"
11525 #. type: Plain text
11526 #: build/C/man5/proc.5:3123
11527 msgid "2: always check, never overcommit"
11530 #. type: Plain text
11531 #: build/C/man5/proc.5:3137
11533 "In mode 0, calls of B<mmap>(2) with B<MAP_NORESERVE> are not checked, and "
11534 "the default check is very weak, leading to the risk of getting a process "
11535 "\"OOM-killed\". Under Linux 2.4 any nonzero value implies mode 1. In mode "
11536 "2 (available since Linux 2.6), the total virtual address space on the system "
11537 "is limited to (SS + RAM*(r/100)), where SS is the size of the swap space, "
11538 "and RAM is the size of the physical memory, and r is the contents of the "
11539 "file I</proc/sys/vm/overcommit_ratio>."
11543 #: build/C/man5/proc.5:3137
11545 msgid "I</proc/sys/vm/overcommit_ratio>"
11548 #. type: Plain text
11549 #: build/C/man5/proc.5:3141
11550 msgid "See the description of I</proc/sys/vm/overcommit_memory>."
11554 #: build/C/man5/proc.5:3141
11556 msgid "I</proc/sys/vm/panic_on_oom> (since Linux 2.6.18)"
11559 #. The following is adapted from Documentation/sysctl/vm.txt
11560 #. type: Plain text
11561 #: build/C/man5/proc.5:3146
11562 msgid "This enables or disables a kernel panic in an out-of-memory situation."
11565 #. type: Plain text
11566 #: build/C/man5/proc.5:3151
11568 "If this file is set to the value 0, the kernel's OOM-killer will kill some "
11569 "rogue process. Usually, the OOM-killer is able to kill a rogue process and "
11570 "the system will survive."
11573 #. type: Plain text
11574 #: build/C/man5/proc.5:3166
11576 "If this file is set to the value 1, then the kernel normally panics when "
11577 "out-of-memory happens. However, if a process limits allocations to certain "
11578 "nodes using memory policies (B<mbind>(2) B<MPOL_BIND>) or cpusets "
11579 "(B<cpuset>(7)) and those nodes reach memory exhaustion status, one process "
11580 "may be killed by the OOM-killer. No panic occurs in this case: because "
11581 "other nodes' memory may be free, this means the system as a whole may not "
11582 "have reached an out-of-memory situation yet."
11585 #. type: Plain text
11586 #: build/C/man5/proc.5:3169
11588 "If this file is set to the value 2, the kernel always panics when an "
11589 "out-of-memory condition occurs."
11592 #. type: Plain text
11593 #: build/C/man5/proc.5:3173
11595 "The default value is 0. 1 and 2 are for failover of clustering. Select "
11596 "either according to your policy of failover."
11600 #: build/C/man5/proc.5:3173
11602 msgid "I</proc/sys/vm/swappiness>"
11605 #. The following is from Documentation/sysctl/vm.txt
11606 #. type: Plain text
11607 #: build/C/man5/proc.5:3181
11609 "The value in this file controls how aggressively the kernel will swap memory "
11610 "pages. Higher values increase aggressiveness, lower values decrease "
11611 "aggressiveness. The default value is 60."
11615 #: build/C/man5/proc.5:3181
11617 msgid "I</proc/sysrq-trigger> (since Linux 2.4.21)"
11620 #. type: Plain text
11621 #: build/C/man5/proc.5:3190
11623 "Writing a character to this file triggers the same SysRq function as typing "
11624 "ALT-SysRq-E<lt>characterE<gt> (see the description of "
11625 "I</proc/sys/kernel/sysrq>). This file is normally only writable by "
11626 "I<root>. For further details see the Linux kernel source file "
11627 "I<Documentation/sysrq.txt>."
11631 #: build/C/man5/proc.5:3190
11633 msgid "I</proc/sysvipc>"
11636 #. type: Plain text
11637 #: build/C/man5/proc.5:3203
11639 "Subdirectory containing the pseudo-files I<msg>, I<sem> and I<shm>. These "
11640 "files list the System V Interprocess Communication (IPC) objects "
11641 "(respectively: message queues, semaphores, and shared memory) that "
11642 "currently exist on the system, providing similar information to that "
11643 "available via B<ipcs>(1). These files have headers and are formatted (one "
11644 "IPC object per line) for easy understanding. B<svipc>(7) provides further "
11645 "background on the information shown by these files."
11649 #: build/C/man5/proc.5:3203
11651 msgid "I</proc/tty>"
11654 #. type: Plain text
11655 #: build/C/man5/proc.5:3207
11657 "Subdirectory containing the pseudo-files and subdirectories for tty drivers "
11658 "and line disciplines."
11662 #: build/C/man5/proc.5:3207
11664 msgid "I</proc/uptime>"
11667 #. type: Plain text
11668 #: build/C/man5/proc.5:3211
11670 "This file contains two numbers: the uptime of the system (seconds), and the "
11671 "amount of time spent in idle process (seconds)."
11675 #: build/C/man5/proc.5:3211
11677 msgid "I</proc/version>"
11680 #. type: Plain text
11681 #: build/C/man5/proc.5:3220
11683 "This string identifies the kernel version that is currently running. It "
11684 "includes the contents of I</proc/sys/kernel/ostype>, "
11685 "I</proc/sys/kernel/osrelease> and I</proc/sys/kernel/version>. For example:"
11688 #. type: Plain text
11689 #: build/C/man5/proc.5:3224
11691 msgid "CW<Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994>\n"
11695 #: build/C/man5/proc.5:3235
11697 msgid "I</proc/vmstat> (since Linux 2.6)"
11700 #. type: Plain text
11701 #: build/C/man5/proc.5:3238
11702 msgid "This file displays various virtual memory statistics."
11706 #: build/C/man5/proc.5:3238
11708 msgid "I</proc/zoneinfo> (since Linux 2.6.13)"
11711 #. FIXME more should be said about /proc/zoneinfo
11712 #. type: Plain text
11713 #: build/C/man5/proc.5:3243
11715 "This file display information about memory zones. This is useful for "
11716 "analyzing virtual memory behavior."
11719 #. type: Plain text
11720 #: build/C/man5/proc.5:3250
11722 "Many strings (i.e., the environment and command line) are in the internal "
11723 "format, with subfields terminated by null bytes (\\(aq\\e0\\(aq), so you may "
11724 "find that things are more readable if you use I<od -c> or I<tr \"\\e000\" "
11725 "\"\\en\"> to read them. Alternatively, I<echo \\`cat E<lt>fileE<gt>\\`> "
11729 #. .SH ACKNOWLEDGEMENTS
11730 #. The material on /proc/sys/fs and /proc/sys/kernel is closely based on
11731 #. kernel source documentation files written by Rik van Riel.
11732 #. type: Plain text
11733 #: build/C/man5/proc.5:3256
11735 "This manual page is incomplete, possibly inaccurate, and is the kind of "
11736 "thing that needs to be updated very often."
11739 #. type: Plain text
11740 #: build/C/man5/proc.5:3281
11742 "B<cat>(1), B<dmesg>(1), B<find>(1), B<free>(1), B<ps>(1), B<tr>(1), "
11743 "B<uptime>(1), B<chroot>(2), B<mmap>(2), B<readlink>(2), B<syslog>(2), "
11744 "B<slabinfo>(5), B<hier>(7), B<time>(7), B<arp>(8), B<hdparm>(8), "
11745 "B<ifconfig>(8), B<init>(8), B<lsmod>(8), B<lspci>(8), B<mount>(8), "
11746 "B<netstat>(8), B<procinfo>(8), B<route>(8)"
11749 #. type: Plain text
11750 #: build/C/man5/proc.5:3286
11752 "The Linux kernel source files: I<Documentation/filesystems/proc.txt> and "
11753 "I<Documentation/sysctl/vm.txt>."
11757 #: build/C/man7/standards.7:26
11762 #. type: Plain text
11763 #: build/C/man7/standards.7:29
11764 msgid "standards - C and UNIX Standards"
11767 #. type: Plain text
11768 #: build/C/man7/standards.7:33
11770 "The CONFORMING TO section that appears in many manual pages identifies "
11771 "various standards to which the documented interface conforms. The following "
11772 "list briefly describes these standards."
11776 #: build/C/man7/standards.7:33
11781 #. type: Plain text
11782 #: build/C/man7/standards.7:36
11783 msgid "Version 7, the ancestral UNIX from Bell Labs."
11787 #: build/C/man7/standards.7:36
11792 #. type: Plain text
11793 #: build/C/man7/standards.7:45
11795 "This is an implementation standard defined by the 4.2 release of the "
11796 "I<Berkeley Software Distribution>, released by the University of California "
11797 "at Berkeley. This was the first Berkeley release that contained a TCP/IP "
11798 "stack and the sockets API. 4.2BSD was released in 1983."
11801 #. type: Plain text
11802 #: build/C/man7/standards.7:48
11804 "Earlier major BSD releases included I<3BSD> (1980), I<4BSD> (1980), and "
11805 "I<4.1BSD> (1981)."
11809 #: build/C/man7/standards.7:48
11814 #. type: Plain text
11815 #: build/C/man7/standards.7:51
11816 msgid "The successor to 4.2BSD, released in 1986."
11820 #: build/C/man7/standards.7:51
11825 #. type: Plain text
11826 #: build/C/man7/standards.7:55
11828 "The successor to 4.3BSD, released in 1993. This was the last major Berkeley "
11833 #: build/C/man7/standards.7:55
11835 msgid "B<System V>"
11838 #. type: Plain text
11839 #: build/C/man7/standards.7:62
11841 "This is an implementation standard defined by AT&T's milestone 1983 release "
11842 "of its commercial System V (five) release. The previous major AT&T release "
11843 "was I<System III>, released in 1981."
11847 #: build/C/man7/standards.7:62
11849 msgid "B<System V release 2 (SVr2)>"
11852 #. type: Plain text
11853 #: build/C/man7/standards.7:69
11855 "This was the next System V release, made in 1985. The SVr2 was formally "
11856 "described in the I<System V Interface Definition version 1> (I<SVID 1>) "
11857 "published in 1985."
11861 #: build/C/man7/standards.7:69
11863 msgid "B<System V release 3 (SVr3)>"
11866 #. type: Plain text
11867 #: build/C/man7/standards.7:75
11869 "This was the successor to SVr2, released in 1986. This release was formally "
11870 "described in the I<System V Interface Definition version 2> (I<SVID 2>)."
11874 #: build/C/man7/standards.7:75
11876 msgid "B<System V release 4 (SVr4)>"
11879 #. type: Plain text
11880 #: build/C/man7/standards.7:85
11882 "This was the successor to SVr3, released in 1989. This version of System V "
11883 "is described in the \"Programmer's Reference Manual: Operating System API "
11884 "(Intel processors)\" (Prentice-Hall 1992, ISBN 0-13-951294-2) This release "
11885 "was formally described in the I<System V Interface Definition version 3> "
11886 "(I<SVID 3>), and is considered the definitive System V release."
11890 #: build/C/man7/standards.7:85
11895 #. type: Plain text
11896 #: build/C/man7/standards.7:91
11898 "System V Interface Definition version 4, issued in 1995. Available online "
11899 "at E<.UR http://www.sco.com\\:/developers\\:/devspecs/> E<.UE .>"
11903 #: build/C/man7/standards.7:91
11908 #. type: Plain text
11909 #: build/C/man7/standards.7:105
11911 "This was the first C language standard, ratified by ANSI (American National "
11912 "Standards Institute) in 1989 (I<X3.159-1989>). Sometimes this is known as "
11913 "I<ANSI C>, but since C99 is also an ANSI standard, this term is ambiguous. "
11914 "This standard was also ratified by ISO (International Standards "
11915 "Organization) in 1990 (I<ISO/IEC 9899:1990>), and is thus occasionally "
11916 "referred to as I<ISO C90>."
11920 #: build/C/man7/standards.7:105
11925 #. type: Plain text
11926 #: build/C/man7/standards.7:112
11928 "This revision of the C language standard was ratified by ISO in 1999 "
11929 "(I<ISO/IEC 9899:1999>). Available online at E<.UR "
11930 "http://www.open-std.org\\:/jtc1\\:/sc22\\:/wg14\\:/www\\:/standards> E<.UE "
11935 #: build/C/man7/standards.7:112
11937 msgid "B<POSIX.1-1990>"
11940 #. type: Plain text
11941 #: build/C/man7/standards.7:118
11943 "\"Portable Operating System Interface for Computing Environments\". IEEE "
11944 "1003.1-1990 part 1, ratified by ISO in 1990 (I<ISO/IEC 9945-1:1990>). The "
11945 "term \"POSIX\" was coined by Richard Stallman."
11949 #: build/C/man7/standards.7:118
11954 #. type: Plain text
11955 #: build/C/man7/standards.7:123
11957 "IEEE Std 1003.2-1992, describing commands and utilities, ratified by ISO in "
11958 "1993 (I<ISO/IEC 9945-2:1993>)."
11962 #: build/C/man7/standards.7:123
11964 msgid "B<POSIX.1b> (formerly known as I<POSIX.4>)"
11967 #. type: Plain text
11968 #: build/C/man7/standards.7:129
11970 "IEEE Std 1003.1b-1993 describing real-time facilities for portable operating "
11971 "systems, ratified by ISO in 1996 (I<ISO/IEC 9945-1:1996>)."
11975 #: build/C/man7/standards.7:129
11977 msgid "B<POSIX.1c>"
11980 #. type: Plain text
11981 #: build/C/man7/standards.7:132
11982 msgid "IEEE Std 1003.1c-1995 describing the POSIX threads interfaces."
11986 #: build/C/man7/standards.7:132
11988 msgid "B<POSIX.1d>"
11991 #. type: Plain text
11992 #: build/C/man7/standards.7:135
11993 msgid "IEEE Std 1003.1c-1999 describing additional real-time extensions."
11997 #: build/C/man7/standards.7:135
11999 msgid "B<POSIX.1g>"
12002 #. type: Plain text
12003 #: build/C/man7/standards.7:138
12004 msgid "IEEE Std 1003.1g-2000 describing networking APIs (including sockets)."
12008 #: build/C/man7/standards.7:138
12010 msgid "B<POSIX.1j>"
12013 #. type: Plain text
12014 #: build/C/man7/standards.7:141
12015 msgid "IEEE Std 1003.1j-2000 describing advanced real-time extensions."
12019 #: build/C/man7/standards.7:141
12021 msgid "B<POSIX.1-1996>"
12024 #. type: Plain text
12025 #: build/C/man7/standards.7:144
12026 msgid "A 1996 revision of POSIX.1 which incorporated POSIX.1b and POSIX.1c."
12030 #: build/C/man7/standards.7:144
12035 #. type: Plain text
12036 #: build/C/man7/standards.7:151
12038 "Released in 1989, this was the first significant release of the I<X/Open "
12039 "Portability Guide>, produced by the X/Open Company, a multivendor "
12040 "consortium. This multivolume guide was based on the POSIX standards."
12044 #: build/C/man7/standards.7:151
12049 #. type: Plain text
12050 #: build/C/man7/standards.7:154
12051 msgid "A revision of the X/Open Portability Guide, released in 1992."
12055 #: build/C/man7/standards.7:154
12060 #. type: Plain text
12061 #: build/C/man7/standards.7:161
12063 "A 1994 revision of XPG4. This is also referred to as I<Spec 1170>, where "
12064 "1170 referred to the number of interfaces defined by this standard."
12068 #: build/C/man7/standards.7:161
12070 msgid "B<SUS (SUSv1)>"
12073 #. type: Plain text
12074 #: build/C/man7/standards.7:169
12076 "Single UNIX Specification. This was a repackaging of XPG4v2 and other "
12077 "X/Open standards (X/Open Curses Issue 4 version 2, X/Open Networking Service "
12078 "(XNS) Issue 4). Systems conforming to this standard can be branded I<UNIX "
12083 #: build/C/man7/standards.7:169
12088 #. type: Plain text
12089 #: build/C/man7/standards.7:180
12091 "Single UNIX Specification version 2. Sometimes also referred to as "
12092 "I<XPG5>. This standard appeared in 1997. Systems conforming to this "
12093 "standard can be branded I<UNIX 98>. See also E<.UR "
12094 "http://www.UNIX-systems.org\\:/version2/> E<.UE .)>"
12098 #: build/C/man7/standards.7:180
12100 msgid "B<POSIX.1-2001, SUSv3>"
12103 #. type: Plain text
12104 #: build/C/man7/standards.7:192
12106 "This was a 2001 revision and consolidation of the POSIX.1, POSIX.2, and SUS "
12107 "standards into a single document, conducted under the auspices of the Austin "
12108 "group E<.UR http://www.opengroup.org\\:/austin/> E<.UE .> The standard is "
12109 "available online at E<.UR http://www.unix-systems.org\\:/version3/> E<.UE ,> "
12110 "and the interfaces that it describes are also available in the Linux manual "
12111 "pages package under sections 1p and 3p (e.g., \"man 3p open\")."
12114 #. type: Plain text
12115 #: build/C/man7/standards.7:205
12117 "The standard defines two levels of conformance: I<POSIX conformance>, which "
12118 "is a baseline set of interfaces required of a conforming system; and I<XSI "
12119 "Conformance>, which additionally mandates a set of interfaces (the \"XSI "
12120 "extension\") which are only optional for POSIX conformance. XSI-conformant "
12121 "systems can be branded I<UNIX 03>. (XSI conformance constitutes the "
12122 "I<Single UNIX Specification version 3> (I<SUSv3>).)"
12125 #. type: Plain text
12126 #: build/C/man7/standards.7:207
12127 msgid "The POSIX.1-2001 document is broken into four parts:"
12130 #. type: Plain text
12131 #: build/C/man7/standards.7:210
12132 msgid "B<XBD>: Definitions, terms and concepts, header file specifications."
12135 #. type: Plain text
12136 #: build/C/man7/standards.7:214
12138 "B<XSH>: Specifications of functions (i.e., system calls and library "
12139 "functions in actual implementations)."
12142 #. type: Plain text
12143 #: build/C/man7/standards.7:218
12145 "B<XCU>: Specifications of commands and utilities (i.e., the area formerly "
12146 "described by POSIX.2)."
12149 #. type: Plain text
12150 #: build/C/man7/standards.7:221
12151 msgid "B<XRAT>: Informative text on the other parts of the standard."
12154 #. type: Plain text
12155 #: build/C/man7/standards.7:225
12157 "POSIX.1-2001 is aligned with C99, so that all of the library functions "
12158 "standardized in C99 are also standardized in POSIX.1-2001."
12161 #. type: Plain text
12162 #: build/C/man7/standards.7:232
12164 "Two Technical Corrigenda (minor fixes and improvements) of the original "
12165 "2001 standard have occurred: TC1 in 2003 (referred to as I<POSIX.1-2003>), "
12166 "and TC2 in 2004 (referred to as I<POSIX.1-2004>)."
12170 #: build/C/man7/standards.7:232
12172 msgid "B<POSIX.1-2008, SUSv4>"
12175 #. type: Plain text
12176 #: build/C/man7/standards.7:236
12177 msgid "Work on the next revision of POSIX.1/SUS was completed and ratified in 2008."
12180 #. type: Plain text
12181 #: build/C/man7/standards.7:245
12183 "The changes in this revision are not as large as those that occurred for "
12184 "POSIX.1-2001/SUSv3, but a number of new interfaces are added and various "
12185 "details of existing specifications are modified. Many of the interfaces "
12186 "that were optional in POSIX.1-2001 become mandatory in the 2008 revision of "
12187 "the standard. A few interfaces that are present in POSIX.1-2001 are marked "
12188 "as obsolete in POSIX.1-2008, or removed from the standard altogether."
12191 #. type: Plain text
12192 #: build/C/man7/standards.7:253
12194 "The revised standard is broken into the same four parts as POSIX.1-2001, and "
12195 "again there are two levels of conformance: the baseline I<POSIX "
12196 "Conformance>, and I<XSI Conformance>, which mandates an additional set of "
12197 "interfaces beyond those in the base specification."
12200 #. type: Plain text
12201 #: build/C/man7/standards.7:257
12203 "In general, where the CONFORMING TO section of a manual page lists "
12204 "POSIX.1-2001, it can be assumed that the interface also conforms to "
12205 "POSIX.1-2008, unless otherwise noted."
12208 #. type: Plain text
12209 #: build/C/man7/standards.7:261
12211 "Further information can be found on the Austin group web site, E<.UR "
12212 "http://www.opengroup.org\\:/austin/> E<.UE .>"
12215 #. type: Plain text
12216 #: build/C/man7/standards.7:265
12217 msgid "B<feature_test_macros>(7), B<libc>(7), B<posixoptions>(7)"
12221 #: build/C/man7/suffixes.7:40
12227 #: build/C/man7/suffixes.7:40
12232 #. type: Plain text
12233 #: build/C/man7/suffixes.7:43
12234 msgid "suffixes - list of file suffixes"
12237 #. type: Plain text
12238 #: build/C/man7/suffixes.7:51
12240 "It is customary to indicate the contents of a file with the file suffix, "
12241 "which consists of a period, followed by one or more letters. Many standard "
12242 "utilities, such as compilers, use this to recognize the type of file they "
12243 "are dealing with. The B<make>(1) utility is driven by rules based on file "
12247 #. type: Plain text
12248 #: build/C/man7/suffixes.7:54
12250 "Following is a list of suffixes which are likely to be found on a Linux "
12255 #: build/C/man7/suffixes.7:59
12257 msgid "Suffix\tFile type\n"
12261 #: build/C/man7/suffixes.7:60
12263 msgid " ,v\tfiles for RCS (Revision Control System)\n"
12267 #: build/C/man7/suffixes.7:61
12269 msgid " -\tbackup file\n"
12273 #: build/C/man7/suffixes.7:62
12275 msgid " .C\tC++ source code, equivalent to I<.cc>\n"
12279 #: build/C/man7/suffixes.7:63
12281 msgid " .F\tFortran source with B<cpp>(1) directives\n"
12285 #: build/C/man7/suffixes.7:64
12287 msgid "\tor file compressed using freeze\n"
12291 #: build/C/man7/suffixes.7:65
12293 msgid " .S\tassembler source with B<cpp>(1) directives\n"
12297 #: build/C/man7/suffixes.7:66
12299 msgid " .Y\tfile compressed using yabba\n"
12303 #: build/C/man7/suffixes.7:67
12305 msgid " .Z\tfile compressed using B<compress>(1)\n"
12309 #: build/C/man7/suffixes.7:68
12311 msgid " .[0-9]+gf\tTeX generic font files\n"
12315 #: build/C/man7/suffixes.7:69
12317 msgid " .[0-9]+pk\tTeX packed font files\n"
12321 #: build/C/man7/suffixes.7:70
12323 msgid " .[1-9]\tmanual page for the corresponding section\n"
12327 #: build/C/man7/suffixes.7:71
12329 msgid " .[1-9][a-z]\tmanual page for section plus subsection\n"
12333 #: build/C/man7/suffixes.7:72
12335 msgid " .a\tstatic object code library\n"
12339 #: build/C/man7/suffixes.7:73
12341 msgid " .ad\tX application default resource file\n"
12345 #: build/C/man7/suffixes.7:74
12347 msgid " .ada\tAda source (may be body, spec, or combination)\n"
12351 #: build/C/man7/suffixes.7:75
12353 msgid " .adb\tAda body source\n"
12357 #: build/C/man7/suffixes.7:76
12359 msgid " .ads\tAda spec source\n"
12363 #: build/C/man7/suffixes.7:77
12365 msgid " .afm\tPostScript font metrics\n"
12369 #: build/C/man7/suffixes.7:78
12371 msgid " .al\tPerl autoload file\n"
12375 #: build/C/man7/suffixes.7:79
12377 msgid " .am\tB<automake>(1) input file\n"
12381 #: build/C/man7/suffixes.7:80
12383 msgid " .arc\tB<arc>(1) archive\n"
12387 #: build/C/man7/suffixes.7:81
12389 msgid " .arj\tB<arj>(1) archive\n"
12393 #: build/C/man7/suffixes.7:82
12395 msgid " .asc\tPGP ASCII-armored data\n"
12399 #: build/C/man7/suffixes.7:83
12401 msgid " .asm\t(GNU) assembler source file\n"
12405 #: build/C/man7/suffixes.7:84
12407 msgid " .au\tAudio sound file\n"
12411 #: build/C/man7/suffixes.7:85
12413 msgid " .aux\tLaTeX auxiliary file\n"
12417 #: build/C/man7/suffixes.7:86
12419 msgid " .avi\t(msvideo) movie\n"
12423 #: build/C/man7/suffixes.7:87
12425 msgid " .awk\tAWK language program\n"
12429 #: build/C/man7/suffixes.7:88
12431 msgid " .b\tLILO boot loader image\n"
12435 #: build/C/man7/suffixes.7:89
12437 msgid " .bak\tbackup file\n"
12441 #: build/C/man7/suffixes.7:90
12443 msgid " .bash\tB<bash>(1) shell script\n"
12447 #: build/C/man7/suffixes.7:91
12449 msgid " .bb\tbasic block list data produced by\n"
12453 #: build/C/man7/suffixes.7:92 build/C/man7/suffixes.7:94
12455 msgid "\tgcc -ftest-coverage\n"
12459 #: build/C/man7/suffixes.7:93
12461 msgid " .bbg\tbasic block graph data produced by\n"
12465 #: build/C/man7/suffixes.7:95
12467 msgid " .bbl\tBibTeX output\n"
12471 #: build/C/man7/suffixes.7:96
12473 msgid " .bdf\tX font file\n"
12477 #: build/C/man7/suffixes.7:97
12479 msgid " .bib\tTeX bibliographic database, BibTeX input\n"
12483 #: build/C/man7/suffixes.7:98
12485 msgid " .bm\tbitmap source\n"
12489 #: build/C/man7/suffixes.7:99
12491 msgid " .bmp\tbitmap\n"
12495 #: build/C/man7/suffixes.7:100
12497 msgid " .bz2\tfile compressed using B<bzip2>(1)\n"
12501 #: build/C/man7/suffixes.7:101
12503 msgid " .c\tC source\n"
12507 #: build/C/man7/suffixes.7:102
12509 msgid " .cat\tmessage catalog files\n"
12513 #: build/C/man7/suffixes.7:103
12515 msgid " .cc\tC++ source\n"
12519 #: build/C/man7/suffixes.7:104
12521 msgid " .cf\tconfiguration file\n"
12525 #: build/C/man7/suffixes.7:105
12527 msgid " .cfg\tconfiguration file\n"
12531 #: build/C/man7/suffixes.7:106
12533 msgid " .cgi\tWWW content generating script or program\n"
12537 #: build/C/man7/suffixes.7:107
12539 msgid " .cls\tLaTeX Class definition\n"
12543 #: build/C/man7/suffixes.7:108
12545 msgid " .class\tJava compiled byte-code\n"
12549 #: build/C/man7/suffixes.7:109
12551 msgid " .conf\tconfiguration file\n"
12555 #: build/C/man7/suffixes.7:110
12557 msgid " .config\tconfiguration file\n"
12561 #: build/C/man7/suffixes.7:111
12563 msgid " .cpp\tequivalent to I<.cc>\n"
12567 #: build/C/man7/suffixes.7:112
12569 msgid " .csh\tB<csh>(1) shell script\n"
12573 #: build/C/man7/suffixes.7:113
12575 msgid " .cxx\tequivalent to I<.cc>\n"
12579 #: build/C/man7/suffixes.7:114
12581 msgid " .dat\tdata file\n"
12585 #: build/C/man7/suffixes.7:115
12587 msgid " .deb\tDebian software package\n"
12591 #: build/C/man7/suffixes.7:116
12593 msgid " .def\tModula-2 source for definition modules\n"
12597 #: build/C/man7/suffixes.7:117
12599 msgid " .def\tother definition files\n"
12603 #: build/C/man7/suffixes.7:118
12605 msgid " .desc\tinitial part of mail message unpacked with\n"
12609 #: build/C/man7/suffixes.7:119
12611 msgid "\tB<munpack>(1)\n"
12615 #: build/C/man7/suffixes.7:120
12617 msgid " .diff\tfile differences (B<diff>(1) command output)\n"
12621 #: build/C/man7/suffixes.7:121
12623 msgid " .dir\tdbm data base directory file\n"
12627 #: build/C/man7/suffixes.7:122
12629 msgid " .doc\tdocumentation file\n"
12633 #: build/C/man7/suffixes.7:123
12635 msgid " .dsc\tDebian Source Control (source package)\n"
12639 #: build/C/man7/suffixes.7:124
12641 msgid " .dtx\tLaTeX package source file\n"
12645 #: build/C/man7/suffixes.7:125
12647 msgid " .dvi\tTeX's device independent output\n"
12651 #: build/C/man7/suffixes.7:126
12653 msgid " .el\tEmacs-Lisp source\n"
12657 #: build/C/man7/suffixes.7:127
12659 msgid " .elc\tcompiled Emacs-Lisp source\n"
12663 #: build/C/man7/suffixes.7:128
12665 msgid " .eps\tencapsulated PostScript\n"
12669 #: build/C/man7/suffixes.7:129
12671 msgid " .exp\tExpect source code\n"
12675 #: build/C/man7/suffixes.7:130
12677 msgid " .f\tFortran source\n"
12681 #: build/C/man7/suffixes.7:131
12683 msgid " .f77\tFortran 77 source\n"
12687 #: build/C/man7/suffixes.7:132
12689 msgid " .f90\tFortran 90 source\n"
12693 #: build/C/man7/suffixes.7:133
12695 msgid " .fas\tprecompiled Common-Lisp\n"
12699 #: build/C/man7/suffixes.7:134
12701 msgid " .fi\tFortran include files\n"
12705 #: build/C/man7/suffixes.7:135
12707 msgid " .fig\tFIG image file (used by B<xfig>(1))\n"
12711 #: build/C/man7/suffixes.7:136
12713 msgid " .fmt\tTeX format file\n"
12717 #: build/C/man7/suffixes.7:137
12719 msgid " .gif\tCompuserve Graphics Image File format\n"
12723 #: build/C/man7/suffixes.7:138
12725 msgid " .gmo\tGNU format message catalog\n"
12729 #: build/C/man7/suffixes.7:139
12731 msgid " .gsf\tGhostscript fonts\n"
12735 #: build/C/man7/suffixes.7:140
12737 msgid " .gz\tfile compressed using B<gzip>(1)\n"
12741 #: build/C/man7/suffixes.7:141
12743 msgid " .h\tC or C++ header files\n"
12747 #: build/C/man7/suffixes.7:142
12749 msgid " .help\thelp file\n"
12753 #: build/C/man7/suffixes.7:143
12755 msgid " .hf\tequivalent to I<.help>\n"
12759 #: build/C/man7/suffixes.7:144
12761 msgid " .hlp\tequivalent to I<.help>\n"
12765 #: build/C/man7/suffixes.7:145
12767 msgid " .htm\tpoor man's I<.html>\n"
12771 #: build/C/man7/suffixes.7:146
12773 msgid " .html\tHTML document used with the World Wide Web\n"
12777 #: build/C/man7/suffixes.7:147
12779 msgid " .hqx\t7-bit encoded Macintosh file\n"
12783 #: build/C/man7/suffixes.7:148
12785 msgid " .i\tC source after preprocessing\n"
12789 #: build/C/man7/suffixes.7:149
12791 msgid " .icon\tbitmap source\n"
12795 #: build/C/man7/suffixes.7:150
12797 msgid " .idx\treference or datum-index file for hypertext\n"
12801 #: build/C/man7/suffixes.7:151
12803 msgid "\tor database system\n"
12807 #: build/C/man7/suffixes.7:152
12809 msgid " .image\tbitmap source\n"
12813 #: build/C/man7/suffixes.7:153
12815 msgid " .in\tconfiguration template, especially for GNU Autoconf\n"
12819 #: build/C/man7/suffixes.7:154
12821 msgid " .info\tfiles for the Emacs info browser\n"
12825 #: build/C/man7/suffixes.7:155
12827 msgid " .info-[0-9]+\tsplit info files\n"
12831 #: build/C/man7/suffixes.7:156
12833 msgid " .ins\tLaTeX package install file for docstrip\n"
12837 #: build/C/man7/suffixes.7:157
12839 msgid " .itcl\titcl source code;\n"
12843 #: build/C/man7/suffixes.7:158
12845 msgid "\titcl ([incr Tcl]) is an OO extension of tcl\n"
12849 #: build/C/man7/suffixes.7:159
12851 msgid " .java\ta Java source file\n"
12855 #: build/C/man7/suffixes.7:160
12857 msgid " .jpeg\tJoint Photographic Experts Group format\n"
12861 #: build/C/man7/suffixes.7:161
12863 msgid " .jpg\tpoor man's I<.jpeg>\n"
12867 #: build/C/man7/suffixes.7:162
12869 msgid " .kmap\tB<lyx>(1) keymap\n"
12873 #: build/C/man7/suffixes.7:163
12875 msgid " .l\tequivalent to I<.lex> or I<.lisp>\n"
12879 #: build/C/man7/suffixes.7:164
12881 msgid " .lex\tB<lex>(1) or B<flex>(1) files\n"
12885 #: build/C/man7/suffixes.7:165
12887 msgid " .lha\tlharc archive\n"
12891 #: build/C/man7/suffixes.7:166
12893 msgid " .lib\tCommon-Lisp library\n"
12897 #: build/C/man7/suffixes.7:167
12899 msgid " .lisp\tLisp source\n"
12903 #: build/C/man7/suffixes.7:168
12905 msgid " .ln\tfiles for use with B<lint>(1)\n"
12909 #: build/C/man7/suffixes.7:169
12911 msgid " .log\tlog file, in particular produced by TeX\n"
12915 #: build/C/man7/suffixes.7:170
12917 msgid " .lsm\tLinux Software Map entry\n"
12921 #: build/C/man7/suffixes.7:171
12923 msgid " .lsp\tCommon-Lisp source\n"
12927 #: build/C/man7/suffixes.7:172
12929 msgid " .lzh\tlharc archive\n"
12933 #: build/C/man7/suffixes.7:173
12935 msgid " .m\tObjective-C source code\n"
12939 #: build/C/man7/suffixes.7:174
12941 msgid " .m4\tB<m4>(1) source\n"
12945 #: build/C/man7/suffixes.7:175
12947 msgid " .mac\tmacro files for various programs\n"
12951 #: build/C/man7/suffixes.7:176
12953 msgid " .man\tmanual page (usually source rather than formatted)\n"
12957 #: build/C/man7/suffixes.7:177
12959 msgid " .map\tmap files for various programs\n"
12963 #: build/C/man7/suffixes.7:178
12965 msgid " .me\tNroff source using the me macro package\n"
12969 #: build/C/man7/suffixes.7:179
12971 msgid " .mf\tMetafont (font generator for TeX) source\n"
12975 #: build/C/man7/suffixes.7:180
12977 msgid " .mgp\tMagicPoint file\n"
12981 #: build/C/man7/suffixes.7:181
12983 msgid " .mm\tsources for B<groff>(1) in mm - format\n"
12987 #: build/C/man7/suffixes.7:182
12989 msgid " .mo\tMessage catalog binary file\n"
12993 #: build/C/man7/suffixes.7:183
12995 msgid " .mod\tModula-2 source for implementation modules\n"
12999 #: build/C/man7/suffixes.7:184
13001 msgid " .mov\t(quicktime) movie\n"
13005 #: build/C/man7/suffixes.7:185
13007 msgid " .mp\tMetapost source\n"
13011 #: build/C/man7/suffixes.7:186
13013 msgid " .mp2\tMPEG Layer 2 (audio) file\n"
13017 #: build/C/man7/suffixes.7:187
13019 msgid " .mp3\tMPEG Layer 3 (audio) file\n"
13023 #: build/C/man7/suffixes.7:188
13025 msgid " .mpeg\tmovie file\n"
13029 #: build/C/man7/suffixes.7:189
13031 msgid " .o\tobject file\n"
13035 #: build/C/man7/suffixes.7:190
13037 msgid " .old\told or backup file\n"
13041 #: build/C/man7/suffixes.7:191
13043 msgid " .orig\tbackup (original) version of a file, from B<patch>(1)\n"
13047 #: build/C/man7/suffixes.7:192
13049 msgid " .out\toutput file, often executable program (a.out)\n"
13053 #: build/C/man7/suffixes.7:193
13055 msgid " .p\tPascal source\n"
13059 #: build/C/man7/suffixes.7:194
13061 msgid " .pag\tdbm data base data file\n"
13065 #: build/C/man7/suffixes.7:195
13067 msgid " .patch\tfile differences for B<patch>(1)\n"
13071 #: build/C/man7/suffixes.7:196
13073 msgid " .pbm\tportable bitmap format\n"
13077 #: build/C/man7/suffixes.7:197
13079 msgid " .pcf\tX11 font files\n"
13083 #: build/C/man7/suffixes.7:198
13085 msgid " .pdf\tAdobe Portable Data Format\n"
13089 #: build/C/man7/suffixes.7:199
13091 msgid "\t(use Acrobat/B<acroread> or B<xpdf>)\n"
13095 #: build/C/man7/suffixes.7:200
13097 msgid " .perl\tPerl source (see .ph, .pl and .pm)\n"
13101 #: build/C/man7/suffixes.7:201
13103 msgid " .pfa\tPostScript font definition files, ASCII format\n"
13107 #: build/C/man7/suffixes.7:202
13109 msgid " .pfb\tPostScript font definition files, binary format\n"
13113 #: build/C/man7/suffixes.7:203
13115 msgid " .pgm\tportable greymap format\n"
13119 #: build/C/man7/suffixes.7:204
13121 msgid " .pgp\tPGP binary data\n"
13125 #: build/C/man7/suffixes.7:205
13127 msgid " .ph\tPerl header file\n"
13131 #: build/C/man7/suffixes.7:206
13133 msgid " .php\tPHP program file\n"
13137 #: build/C/man7/suffixes.7:207
13139 msgid " .php3\tPHP3 program file\n"
13143 #: build/C/man7/suffixes.7:208
13145 msgid " .pid\tFile to store daemon PID (e.g., crond.pid)\n"
13149 #: build/C/man7/suffixes.7:209
13151 msgid " .pl\tTeX property list file or Perl library file\n"
13155 #: build/C/man7/suffixes.7:210
13157 msgid " .pm\tPerl module\n"
13161 #: build/C/man7/suffixes.7:211
13163 msgid " .png\tPortable Network Graphics file\n"
13167 #: build/C/man7/suffixes.7:212
13169 msgid " .po\tMessage catalog source\n"
13173 #: build/C/man7/suffixes.7:213
13175 msgid " .pod\tB<perldoc>(1) file\n"
13179 #: build/C/man7/suffixes.7:214
13181 msgid " .ppm\tportable pixmap format\n"
13185 #: build/C/man7/suffixes.7:215
13187 msgid " .pr\tbitmap source\n"
13191 #: build/C/man7/suffixes.7:216
13193 msgid " .ps\tPostScript file\n"
13197 #: build/C/man7/suffixes.7:217
13199 msgid " .py\tPython source\n"
13203 #: build/C/man7/suffixes.7:218
13205 msgid " .pyc\tcompiled python\n"
13209 #: build/C/man7/suffixes.7:219
13211 msgid " .qt\tquicktime movie\n"
13215 #: build/C/man7/suffixes.7:220
13217 msgid " .r\tRATFOR source (obsolete)\n"
13221 #: build/C/man7/suffixes.7:221
13223 msgid " .rej\tpatches that B<patch>(1) couldn't apply\n"
13227 #: build/C/man7/suffixes.7:222
13229 msgid " .rpm\tRPM software package\n"
13233 #: build/C/man7/suffixes.7:223
13235 msgid " .rtf\tRich Text Format file\n"
13239 #: build/C/man7/suffixes.7:224
13241 msgid " .rules\trules for something\n"
13245 #: build/C/man7/suffixes.7:225
13247 msgid " .s\tassembler source\n"
13251 #: build/C/man7/suffixes.7:226
13253 msgid " .sa\tstub libraries for a.out shared libraries\n"
13257 #: build/C/man7/suffixes.7:227
13259 msgid " .sc\tB<sc>(1) spreadsheet commands\n"
13263 #: build/C/man7/suffixes.7:228
13265 msgid " .scm\tScheme source code\n"
13269 #: build/C/man7/suffixes.7:229
13271 msgid " .sed\tsed source file\n"
13275 #: build/C/man7/suffixes.7:230
13277 msgid " .sgml\tSGML source file\n"
13281 #: build/C/man7/suffixes.7:231
13283 msgid " .sh\tB<sh>(1) scripts\n"
13287 #: build/C/man7/suffixes.7:232
13289 msgid " .shar\tarchive created by the B<shar>(1) utility\n"
13293 #: build/C/man7/suffixes.7:233
13295 msgid " .so\tShared library or dynamically loadable object\n"
13299 #: build/C/man7/suffixes.7:234
13301 msgid " .sql\tSQL source\n"
13305 #: build/C/man7/suffixes.7:235
13307 msgid " .sqml\tSQML schema or query program\n"
13311 #: build/C/man7/suffixes.7:236
13313 msgid " .sty\tLaTeX style files\n"
13317 #: build/C/man7/suffixes.7:237
13319 msgid " .sym\tModula-2 compiled definition modules\n"
13323 #: build/C/man7/suffixes.7:238
13325 msgid " .tar\tarchive created by the B<tar>(1) utility\n"
13329 #: build/C/man7/suffixes.7:239
13331 msgid " .tar.Z\ttar(1) archive compressed with B<compress>(1)\n"
13335 #: build/C/man7/suffixes.7:240
13337 msgid " .tar.bz2\ttar(1) archive compressed with B<bzip2>(1)\n"
13341 #: build/C/man7/suffixes.7:241
13343 msgid " .tar.gz\ttar(1) archive compressed with B<gzip>(1)\n"
13347 #: build/C/man7/suffixes.7:242
13349 msgid " .taz\ttar(1) archive compressed with B<compress>(1)\n"
13353 #: build/C/man7/suffixes.7:243
13355 msgid " .tcl\ttcl source code\n"
13359 #: build/C/man7/suffixes.7:244
13361 msgid " .tex\tTeX or LaTeX source\n"
13365 #: build/C/man7/suffixes.7:245
13367 msgid " .texi\tequivalent to I<.texinfo>\n"
13371 #: build/C/man7/suffixes.7:246
13373 msgid " .texinfo\tTexinfo documentation source\n"
13377 #: build/C/man7/suffixes.7:247
13379 msgid " .text\ttext file\n"
13383 #: build/C/man7/suffixes.7:248
13385 msgid " .tfm\tTeX font metric file\n"
13389 #: build/C/man7/suffixes.7:249
13391 msgid " .tgz\ttar archive compressed with B<gzip>(1)\n"
13395 #: build/C/man7/suffixes.7:250
13397 msgid " .tif\tpoor man's I<.tiff>\n"
13401 #: build/C/man7/suffixes.7:251
13403 msgid " .tiff\tTagged Image File Format\n"
13407 #: build/C/man7/suffixes.7:252
13409 msgid " .tk\ttcl/tk script\n"
13413 #: build/C/man7/suffixes.7:253
13415 msgid " .tmp\ttemporary file\n"
13419 #: build/C/man7/suffixes.7:254
13421 msgid " .tmpl\ttemplate files\n"
13425 #: build/C/man7/suffixes.7:255
13427 msgid " .txt\tequivalent to I<.text>\n"
13431 #: build/C/man7/suffixes.7:256
13433 msgid " .uu\tequivalent to I<.uue>\n"
13437 #: build/C/man7/suffixes.7:257
13439 msgid " .uue\tbinary file encoded with B<uuencode>(1)\n"
13443 #: build/C/man7/suffixes.7:258
13445 msgid " .vf\tTeX virtual font file\n"
13449 #: build/C/man7/suffixes.7:259
13451 msgid " .vpl\tTeX virtual property list file\n"
13455 #: build/C/man7/suffixes.7:260
13457 msgid " .w\tSilvio Levi's CWEB\n"
13461 #: build/C/man7/suffixes.7:261
13463 msgid " .wav\twave sound file\n"
13467 #: build/C/man7/suffixes.7:262
13469 msgid " .web\tDonald Knuth's WEB\n"
13473 #: build/C/man7/suffixes.7:263
13475 msgid " .wml\tSource file for Web Meta Language\n"
13479 #: build/C/man7/suffixes.7:264
13481 msgid " .xbm\tX11 bitmap source\n"
13485 #: build/C/man7/suffixes.7:265
13487 msgid " .xcf\tGIMP graphic\n"
13491 #: build/C/man7/suffixes.7:266
13493 msgid " .xml\teXtended Markup Language file\n"
13497 #: build/C/man7/suffixes.7:267
13499 msgid " .xpm\tX11 pixmap source\n"
13503 #: build/C/man7/suffixes.7:268
13505 msgid " .xs\tPerl xsub file produced by h2xs\n"
13509 #: build/C/man7/suffixes.7:269
13511 msgid " .xsl\tXSL stylesheet\n"
13515 #: build/C/man7/suffixes.7:270
13517 msgid " .y\tB<yacc>(1) or B<bison>(1) (parser generator) files\n"
13521 #: build/C/man7/suffixes.7:271
13523 msgid " .z\tFile compressed using B<pack>(1) (or an old B<gzip>(1))\n"
13527 #: build/C/man7/suffixes.7:272
13529 msgid " .zip\tB<zip>(1) archive\n"
13533 #: build/C/man7/suffixes.7:273
13535 msgid " .zoo\tB<zoo>(1) archive\n"
13539 #: build/C/man7/suffixes.7:274
13541 msgid " ~\tEmacs or B<patch>(1) backup file\n"
13545 #: build/C/man7/suffixes.7:275
13547 msgid " rc\tstartup (`run control') file, e.g., I<.newsrc>\n"
13550 #. type: Plain text
13551 #: build/C/man7/suffixes.7:279
13552 msgid "General UNIX conventions."
13555 #. type: Plain text
13556 #: build/C/man7/suffixes.7:281
13557 msgid "This list is not exhaustive."
13560 #. type: Plain text
13561 #: build/C/man7/suffixes.7:284
13562 msgid "B<file>(1), B<make>(1)"
13566 #: build/C/man3/undocumented.3:29
13568 msgid "UNDOCUMENTED"
13572 #: build/C/man3/undocumented.3:29
13577 #. type: Plain text
13578 #: build/C/man3/undocumented.3:32
13579 msgid "none - undocumented library functions"
13582 #. type: Plain text
13583 #: build/C/man3/undocumented.3:34
13584 msgid "Undocumented library functions"
13587 #. type: Plain text
13588 #: build/C/man3/undocumented.3:37
13590 "This man page mentions those library functions which are implemented in the "
13591 "standard libraries but not yet documented in man pages."
13595 #: build/C/man3/undocumented.3:37
13597 msgid "Solicitation"
13600 #. type: Plain text
13601 #: build/C/man3/undocumented.3:43
13603 "If you have information about these functions, please look in the source "
13604 "code, write a man page (using a style similar to that of the other Linux "
13605 "section 3 man pages), and send it to B<mtk.manpages@gmail.com> for inclusion "
13606 "in the next man page release."
13610 #: build/C/man3/undocumented.3:43
13615 #. .BR chflags (3),
13616 #. .BR fattach (3),
13617 #. .BR fchflags (3),
13619 #. .BR fdetach (3),
13620 #. .BR obstack stuff (3),
13621 #. type: Plain text
13622 #: build/C/man3/undocumented.3:183
13624 "B<authdes_create>(3), B<authdes_getucred>(3), B<authdes_pk_create>(3), "
13625 "B<clntunix_create>(3), B<creat64>(3), B<dn_skipname>(3), B<fcrypt>(3), "
13626 "B<fp_nquery>(3), B<fp_query>(3), B<fp_resstat>(3), B<freading>(3), "
13627 "B<freopen64>(3), B<fseeko64>(3), B<ftello64>(3), B<ftw64>(3), B<fwscanf>(3), "
13628 "B<get_avphys_pages>(3), B<getdirentries64>(3), B<getmsg>(3), "
13629 "B<getnetname>(3), B<get_nprocs>(3), B<get_nprocs_conf>(3), "
13630 "B<get_phys_pages>(3), B<getpublickey>(3), B<getsecretkey>(3), "
13631 "B<h_errlist>(3), B<host2netname>(3), B<hostalias>(3), B<inet_nsap_addr>(3), "
13632 "B<inet_nsap_ntoa>(3), B<init_des>(3), B<libc_nls_init>(3), B<lio_listio>(3), "
13633 "B<mstats>(3), B<netname2host>(3), B<netname2user>(3), B<nlist>(3), "
13634 "B<obstack_free>(3), B<parse_printf_format>(3), B<p_cdname>(3), "
13635 "B<p_cdnname>(3), B<p_class>(3), B<p_fqname>(3), B<p_option>(3), "
13636 "B<p_query>(3), B<printf_size>(3), B<printf_size_info>(3), B<p_rr>(3), "
13637 "B<p_time>(3), B<p_type>(3), B<putlong>(3), B<putshort>(3), "
13638 "B<re_compile_fastmap>(3), B<re_compile_pattern>(3), "
13639 "B<register_printf_function>(3), B<re_match>(3), B<re_match_2>(3), "
13640 "B<re_rx_search>(3), B<re_search>(3), B<re_search_2>(3), "
13641 "B<re_set_registers>(3), B<re_set_syntax>(3), B<res_send_setqhook>(3), "
13642 "B<res_send_setrhook>(3), B<ruserpass>(3), B<setfileno>(3), "
13643 "B<sethostfile>(3), B<svc_exit>(3), B<svcudp_enablecache>(3), B<tell>(3), "
13644 "B<tr_break>(3), B<tzsetwall>(3), B<ufc_dofinalperm>(3), B<ufc_doit>(3), "
13645 "B<user2netname>(3), B<vlimit>(3), B<vtimes>(3), B<wcschrnul>(3), "
13646 "B<wcsftime>(3), B<wscanf>(3), B<xdr_authdes_cred>(3), "
13647 "B<xdr_authdes_verf>(3), B<xdr_cryptkeyarg>(3), B<xdr_cryptkeyres>(3), "
13648 "B<xdr_datum>(3), B<xdr_des_block>(3), B<xdr_domainname>(3), "
13649 "B<xdr_getcredres>(3), B<xdr_keybuf>(3), B<xdr_keystatus>(3), "
13650 "B<xdr_mapname>(3), B<xdr_netnamestr>(3), B<xdr_netobj>(3), B<xdr_passwd>(3), "
13651 "B<xdr_peername>(3), B<xdr_rmtcall_args>(3), B<xdr_rmtcallres>(3), "
13652 "B<xdr_unixcred>(3), B<xdr_yp_buf>(3), B<xdr_yp_inaddr>(3), "
13653 "B<xdr_ypbind_binding>(3), B<xdr_ypbind_resp>(3), B<xdr_ypbind_resptype>(3), "
13654 "B<xdr_ypbind_setdom>(3), B<xdr_ypdelete_args>(3), B<xdr_ypmaplist>(3), "
13655 "B<xdr_ypmaplist_str>(3), B<xdr_yppasswd>(3), B<xdr_ypreq_key>(3), "
13656 "B<xdr_ypreq_nokey>(3), B<xdr_ypresp_all>(3), B<xdr_ypresp_all_seq>(3), "
13657 "B<xdr_ypresp_key_val>(3), B<xdr_ypresp_maplist>(3), B<xdr_ypresp_master>(3), "
13658 "B<xdr_ypresp_order>(3), B<xdr_ypresp_val>(3), B<xdr_ypstat>(3), "
13659 "B<xdr_ypupdate_args>(3), B<yp_all>(3), B<yp_bind>(3), B<yperr_string>(3), "
13660 "B<yp_first>(3), B<yp_get_default_domain>(3), B<yp_maplist>(3), "
13661 "B<yp_master>(3), B<yp_match>(3), B<yp_next>(3), B<yp_order>(3), "
13662 "B<ypprot_err>(3), B<yp_unbind>(3), B<yp_update>(3)"
13666 #: build/C/man2/unimplemented.2:26
13668 msgid "UNIMPLEMENTED"
13672 #: build/C/man2/unimplemented.2:26
13677 #. type: Plain text
13678 #: build/C/man2/unimplemented.2:31
13680 "afs_syscall, break, fattach, fdetach, ftime, getmsg, getpmsg, gtty, "
13681 "isastream, lock, madvise1, mpx, prof, profil, putmsg, putpmsg, security, "
13682 "stty, tuxcall, ulimit, vserver - unimplemented system calls"
13685 #. type: Plain text
13686 #: build/C/man2/unimplemented.2:33
13687 msgid "Unimplemented system calls."
13690 #. type: Plain text
13691 #: build/C/man2/unimplemented.2:35
13692 msgid "These system calls are not implemented in the Linux kernel."
13695 #. type: Plain text
13696 #: build/C/man2/unimplemented.2:40
13697 msgid "These system calls always return -1 and set I<errno> to B<ENOSYS>."
13700 #. type: Plain text
13701 #: build/C/man2/unimplemented.2:47
13703 "Note that B<ftime>(3), B<profil>(3) and B<ulimit>(3) are implemented as "
13704 "library functions."
13707 #. type: Plain text
13708 #: build/C/man2/unimplemented.2:56
13710 "Some system calls, like B<alloc_hugepages>(2), B<free_hugepages>(2), "
13711 "B<ioperm>(2), B<iopl>(2), and B<vm86>(2) only exist on certain "
13715 #. type: Plain text
13716 #: build/C/man2/unimplemented.2:64
13718 "Some system calls, like B<ipc>(2), B<create_module>(2), B<init_module>(2), "
13719 "and B<delete_module>(2) only exist when the Linux kernel was built with "
13720 "support for them."
13723 #. type: Plain text
13724 #: build/C/man2/unimplemented.2:66
13725 msgid "B<syscalls>(2)"
13729 #: build/C/man7/units.7:26
13734 #. type: Plain text
13735 #: build/C/man7/units.7:29
13736 msgid "units, kilo, kibi, mega, mebi, giga, gibi - decimal and binary prefixes"
13740 #: build/C/man7/units.7:30
13742 msgid "Decimal prefixes"
13745 #. type: Plain text
13746 #: build/C/man7/units.7:34
13748 "The SI system of units uses prefixes that indicate powers of ten. A "
13749 "kilometer is 1000 meter, and a megawatt is 1000000 watt. Below the standard "
13754 #: build/C/man7/units.7:37 build/C/man7/units.7:79
13756 msgid "Prefix\tName\tValue\n"
13760 #: build/C/man7/units.7:38
13762 msgid "y\tyocto\t10^-24 = 0.000000000000000000000001\n"
13766 #: build/C/man7/units.7:39
13768 msgid "z\tzepto\t10^-21 = 0.000000000000000000001\n"
13772 #: build/C/man7/units.7:40
13774 msgid "a\tatto\t10^-18 = 0.000000000000000001\n"
13778 #: build/C/man7/units.7:41
13780 msgid "f\tfemto\t10^-15 = 0.000000000000001\n"
13784 #: build/C/man7/units.7:42
13786 msgid "p\tpico\t10^-12 = 0.000000000001\n"
13790 #: build/C/man7/units.7:43
13792 msgid "n\tnano\t10^-9 = 0.000000001\n"
13796 #: build/C/man7/units.7:44
13798 msgid "u\tmicro\t10^-6 = 0.000001\n"
13802 #: build/C/man7/units.7:45
13804 msgid "m\tmilli\t10^-3 = 0.001\n"
13808 #: build/C/man7/units.7:46
13810 msgid "c\tcenti\t10^-2 = 0.01\n"
13814 #: build/C/man7/units.7:47
13816 msgid "d\tdeci\t10^-1 = 0.1\n"
13820 #: build/C/man7/units.7:48
13822 msgid "da\tdeka\t10^ 1 = 10\n"
13826 #: build/C/man7/units.7:49
13828 msgid "h\thecto\t10^ 2 = 100\n"
13832 #: build/C/man7/units.7:50
13834 msgid "k\tkilo\t10^ 3 = 1000\n"
13838 #: build/C/man7/units.7:51
13840 msgid "M\tmega\t10^ 6 = 1000000\n"
13844 #: build/C/man7/units.7:52
13846 msgid "G\tgiga\t10^ 9 = 1000000000\n"
13850 #: build/C/man7/units.7:53
13852 msgid "T\ttera\t10^12 = 1000000000000\n"
13856 #: build/C/man7/units.7:54
13858 msgid "P\tpeta\t10^15 = 1000000000000000\n"
13862 #: build/C/man7/units.7:55
13864 msgid "E\texa\t10^18 = 1000000000000000000\n"
13868 #: build/C/man7/units.7:56
13870 msgid "Z\tzetta\t10^21 = 1000000000000000000000\n"
13874 #: build/C/man7/units.7:57
13876 msgid "Y\tyotta\t10^24 = 1000000000000000000000000\n"
13879 #. type: Plain text
13880 #: build/C/man7/units.7:64
13882 "The symbol for micro is the Greek letter mu, often written u in an ASCII "
13883 "context where this Greek letter is not available. See also"
13886 #. type: Plain text
13887 #: build/C/man7/units.7:68
13888 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/prefixes.html> E<.UE>"
13892 #: build/C/man7/units.7:69
13894 msgid "Binary prefixes"
13897 #. type: Plain text
13898 #: build/C/man7/units.7:76
13900 "The binary prefixes resemble the decimal ones, but have an additional "
13901 "\\(aqi\\(aq (and \"Ki\" starts with a capital \\(aqK\\(aq). The names are "
13902 "formed by taking the first syllable of the names of the decimal prefix with "
13903 "roughly the same size, followed by \"bi\" for \"binary\"."
13907 #: build/C/man7/units.7:80
13909 msgid "Ki\tkibi\t2^10 = 1024\n"
13913 #: build/C/man7/units.7:81
13915 msgid "Mi\tmebi\t2^20 = 1048576\n"
13919 #: build/C/man7/units.7:82
13921 msgid "Gi\tgibi\t2^30 = 1073741824\n"
13925 #: build/C/man7/units.7:83
13927 msgid "Ti\ttebi\t2^40 = 1099511627776\n"
13931 #: build/C/man7/units.7:84
13933 msgid "Pi\tpebi\t2^50 = 1125899906842624\n"
13937 #: build/C/man7/units.7:85
13939 msgid "Ei\texbi\t2^60 = 1152921504606846976\n"
13942 #. type: Plain text
13943 #: build/C/man7/units.7:90
13947 #. type: Plain text
13948 #: build/C/man7/units.7:93
13949 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/binary.html> E<.UE>"
13953 #: build/C/man7/units.7:93
13958 #. type: Plain text
13959 #: build/C/man7/units.7:98
13961 "Before these binary prefixes were introduced, it was fairly common to use "
13962 "k=1000 and K=1024, just like b=bit, B=byte. Unfortunately, the M is capital "
13963 "already, and cannot be capitalized to indicate binary-ness."
13966 #. type: Plain text
13967 #: build/C/man7/units.7:109
13969 "At first that didn't matter too much, since memory modules and disks came in "
13970 "sizes that were powers of two, so everyone knew that in such contexts "
13971 "\"kilobyte\" and \"megabyte\" meant 1024 and 1048576 bytes, respectively. "
13972 "What originally was a sloppy use of the prefixes \"kilo\" and \"mega\" "
13973 "started to become regarded as the \"real true meaning\" when computers were "
13974 "involved. But then disk technology changed, and disk sizes became arbitrary "
13975 "numbers. After a period of uncertainty all disk manufacturers settled on "
13976 "the standard, namely k=1000, M=1000k, G=1000M."
13979 #. also common: 14.4k modem
13980 #. type: Plain text
13981 #: build/C/man7/units.7:116
13983 "The situation was messy: in the 14k4 modems, k=1000; in the 1.44MB "
13984 "diskettes, M=1024000; etc. In 1998 the IEC approved the standard that "
13985 "defines the binary prefixes given above, enabling people to be precise and "
13989 #. type: Plain text
13990 #: build/C/man7/units.7:118
13991 msgid "Thus, today, MB = 1000000B and MiB = 1048576B."
13994 #. type: Plain text
13995 #: build/C/man7/units.7:122
13997 "In the free software world programs are slowly being changed to conform. "
13998 "When the Linux kernel boots and says"
14001 #. type: Plain text
14002 #: build/C/man7/units.7:126
14004 msgid "hda: 120064896 sectors (61473 MB) w/2048KiB Cache\n"
14007 #. type: Plain text
14008 #: build/C/man7/units.7:130
14009 msgid "the MB are megabytes and the KiB are kibibytes."
14012 #. Copyright (c) 1990, 1993
14013 #. The Regents of the University of California. All rights reserved.
14015 #. %%%LICENSE_START(BSD_4_CLAUSE_UCB)
14016 #. Redistribution and use in source and binary forms, with or without
14017 #. modification, are permitted provided that the following conditions
14019 #. 1. Redistributions of source code must retain the above copyright
14020 #. notice, this list of conditions and the following disclaimer.
14021 #. 2. Redistributions in binary form must reproduce the above copyright
14022 #. notice, this list of conditions and the following disclaimer in the
14023 #. documentation and/or other materials provided with the distribution.
14024 #. 3. All advertising materials mentioning features or use of this software
14025 #. must display the following acknowledgement:
14026 #. This product includes software developed by the University of
14027 #. California, Berkeley and its contributors.
14028 #. 4. Neither the name of the University nor the names of its contributors
14029 #. may be used to endorse or promote products derived from this software
14030 #. without specific prior written permission.
14032 #. THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
14033 #. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14034 #. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14035 #. ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
14036 #. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
14037 #. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
14038 #. OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
14039 #. HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
14040 #. LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
14041 #. OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
14045 #. @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
14046 #. $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $
14048 #. This tutorial sampler invokes every macro in the package several
14049 #. times and is guaranteed to give a worst case performance
14050 #. for an already extremely slow package.
14052 #. String \*(Pu was not defined, probably means punctuation
14054 #: build/C/man7/mdoc.samples.7:42
14056 msgid "[ .,:;()[]?! ]"
14060 #: build/C/man7/mdoc.samples.7:43
14062 msgid "December 30, 1993"
14066 #: build/C/man7/mdoc.samples.7:45
14068 msgid "MDOC.SAMPLES 7"
14071 #. type: Plain text
14072 #: build/C/man7/mdoc.samples.7:48
14073 msgid "E<.Nm mdoc.samples>"
14077 #: build/C/man7/mdoc.samples.7:48
14079 msgid "tutorial sampler for writing"
14082 #. type: Plain text
14083 #: build/C/man7/mdoc.samples.7:52
14084 msgid "E<.Bx> manuals with E<.Nm \\-mdoc>"
14087 #. type: Plain text
14088 #: build/C/man7/mdoc.samples.7:54
14089 msgid "E<.Nm man mdoc.samples>"
14092 #. type: Plain text
14093 #: build/C/man7/mdoc.samples.7:100
14095 "A tutorial sampler for writing E<.Bx> manual pages with the E<.Nm \\-mdoc> "
14096 "macro package, a E<.Em content Ns \\-based> and E<.Em domain Ns \\-based> "
14097 "formatting package for E<.Xr troff 1>. Its predecessor, the E<.Xr \\-man 7> "
14098 "package, addressed page layout leaving the manipulation of fonts and other "
14099 "typesetting details to the individual author. In E<.Nm \\-mdoc>, page "
14100 "layout macros make up the E<.Em \"page structure domain\"> which consists of "
14101 "macros for titles, section headers, displays and lists. Essentially items "
14102 "which affect the physical position of text on a formatted page. In addition "
14103 "to the page structure domain, there are two more domains, the manual domain "
14104 "and the general text domain. The general text domain is defined as macros "
14105 "which perform tasks such as quoting or emphasizing pieces of text. The "
14106 "manual domain is defined as macros that are a subset of the day to day "
14107 "informal language used to describe commands, routines and related E<.Bx> "
14108 "files. Macros in the manual domain handle command names, command-line "
14109 "arguments and options, function names, function parameters, pathnames, "
14110 "variables, cross references to other manual pages, and so on. These domain "
14111 "items have value for both the author and the future user of the manual "
14112 "page. It is hoped the consistency gained across the manual set will provide "
14113 "easier translation to future documentation tools."
14116 #. type: Plain text
14117 #: build/C/man7/mdoc.samples.7:107
14119 "Throughout the E<.Ux> manual pages, a manual entry is simply referred to as "
14120 "a man page, regardless of actual length and without sexist intention."
14124 #: build/C/man7/mdoc.samples.7:107
14126 msgid "GETTING STARTED"
14129 #. type: Plain text
14130 #: build/C/man7/mdoc.samples.7:113
14132 "Since a tutorial document is normally read when a person desires to use the "
14133 "material immediately, the assumption has been made that the user of this "
14134 "document may be impatient. The material presented in the remained of this "
14135 "document is outlined as follows:"
14138 #. type: Plain text
14139 #: build/C/man7/mdoc.samples.7:116
14140 msgid "E<.Tn \"TROFF IDIOSYNCRASIES\">"
14144 #: build/C/man7/mdoc.samples.7:117
14146 msgid "\"Macro Usage\" ."
14150 #: build/C/man7/mdoc.samples.7:118
14152 msgid "\"Passing Space Characters in an Argument\" ."
14156 #: build/C/man7/mdoc.samples.7:119
14158 msgid "\"Trailing Blank Space Characters (a warning)\" ."
14162 #: build/C/man7/mdoc.samples.7:120
14164 msgid "\"Escaping Special Characters\" ."
14167 #. type: Plain text
14168 #: build/C/man7/mdoc.samples.7:124
14169 msgid "E<.Tn \"THE ANATOMY OF A MAN PAGE\">"
14173 #: build/C/man7/mdoc.samples.7:125
14175 msgid "\"A manual page template\" ."
14178 #. type: Plain text
14179 #: build/C/man7/mdoc.samples.7:129
14180 msgid "E<.Tn \"TITLE MACROS\">."
14183 #. type: Plain text
14184 #: build/C/man7/mdoc.samples.7:131
14185 msgid "E<.Tn \"INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS\">."
14189 #: build/C/man7/mdoc.samples.7:132
14191 msgid "\"What's in a name...\" ."
14195 #: build/C/man7/mdoc.samples.7:133
14197 msgid "\"General Syntax\" ."
14200 #. type: Plain text
14201 #: build/C/man7/mdoc.samples.7:137
14202 msgid "E<.Tn \"MANUAL DOMAIN\">"
14206 #: build/C/man7/mdoc.samples.7:138
14208 msgid "Addresses ."
14212 #: build/C/man7/mdoc.samples.7:139
14214 msgid "\"Author name\" ."
14218 #: build/C/man7/mdoc.samples.7:140
14220 msgid "Arguments ."
14224 #: build/C/man7/mdoc.samples.7:141
14226 msgid "\"Configuration Declarations (section four only)\" ."
14230 #: build/C/man7/mdoc.samples.7:142
14232 msgid "\"Command Modifier\" ."
14236 #: build/C/man7/mdoc.samples.7:143
14238 msgid "\"Defined Variables\" ."
14242 #: build/C/man7/mdoc.samples.7:144
14244 msgid "\"Errno's (Section two only)\" ."
14248 #: build/C/man7/mdoc.samples.7:145
14250 msgid "\"Environment Variables\" ."
14254 #: build/C/man7/mdoc.samples.7:146
14256 msgid "\"Function Argument\" ."
14260 #: build/C/man7/mdoc.samples.7:147
14262 msgid "\"Function Declaration\" ."
14266 #: build/C/man7/mdoc.samples.7:148
14272 #: build/C/man7/mdoc.samples.7:149
14274 msgid "\"Functions (library routines)\" ."
14278 #: build/C/man7/mdoc.samples.7:150
14280 msgid "\"Function Types\" ."
14283 #. .It "Header File (including source code)" .
14285 #: build/C/man7/mdoc.samples.7:152
14287 msgid "\"Interactive Commands\" ."
14291 #: build/C/man7/mdoc.samples.7:153
14297 #: build/C/man7/mdoc.samples.7:154
14303 #: build/C/man7/mdoc.samples.7:155
14305 msgid "Pathnames ."
14309 #: build/C/man7/mdoc.samples.7:156
14311 msgid "Variables ."
14315 #: build/C/man7/mdoc.samples.7:157
14317 msgid "\"Cross References\" ."
14320 #. type: Plain text
14321 #: build/C/man7/mdoc.samples.7:161
14322 msgid "E<.Tn \"GENERAL TEXT DOMAIN\">"
14326 #: build/C/man7/mdoc.samples.7:162
14328 msgid "\"AT&T Macro\" ."
14332 #: build/C/man7/mdoc.samples.7:163
14334 msgid "\"BSD Macro\" ."
14338 #: build/C/man7/mdoc.samples.7:164
14340 msgid "\"FreeBSD Macro\" ."
14344 #: build/C/man7/mdoc.samples.7:165
14346 msgid "\"UNIX Macro\" ."
14350 #: build/C/man7/mdoc.samples.7:166
14352 msgid "Enclosure/Quoting Macros"
14356 #: build/C/man7/mdoc.samples.7:168
14358 msgid "\"Angle Bracket Quote/Enclosure\" ."
14362 #: build/C/man7/mdoc.samples.7:169
14364 msgid "\"Bracket Quotes/Enclosure\" ."
14368 #: build/C/man7/mdoc.samples.7:170
14370 msgid "\"Double Quote macro/Enclosure\" ."
14374 #: build/C/man7/mdoc.samples.7:171
14376 msgid "\"Parenthesis Quote/Enclosure\" ."
14380 #: build/C/man7/mdoc.samples.7:172
14382 msgid "\"Single Quotes/Enclosure\" ."
14386 #: build/C/man7/mdoc.samples.7:173
14388 msgid "\"Prefix Macro\" ."
14392 #: build/C/man7/mdoc.samples.7:175
14394 msgid "\"No\\-Op or Normal Text Macro\" ."
14398 #: build/C/man7/mdoc.samples.7:176
14400 msgid "\"No Space Macro\" ."
14404 #: build/C/man7/mdoc.samples.7:177
14406 msgid "\"Section Cross References\" ."
14410 #: build/C/man7/mdoc.samples.7:178
14412 msgid "\"References and Citations\" ."
14416 #: build/C/man7/mdoc.samples.7:179
14418 msgid "Return Values (sections two and three only)"
14422 #: build/C/man7/mdoc.samples.7:180
14424 msgid "\"Trade Names (Acronyms and Type Names)\" ."
14428 #: build/C/man7/mdoc.samples.7:181
14430 msgid "\"Extended Arguments\" ."
14433 #. type: Plain text
14434 #: build/C/man7/mdoc.samples.7:185
14435 msgid "E<.Tn \"PAGE STRUCTURE DOMAIN\">"
14439 #: build/C/man7/mdoc.samples.7:186
14441 msgid "\"Section Headers\" ."
14445 #: build/C/man7/mdoc.samples.7:187
14447 msgid "\"Paragraphs and Line Spacing\" ."
14451 #: build/C/man7/mdoc.samples.7:188
14457 #: build/C/man7/mdoc.samples.7:189
14463 #: build/C/man7/mdoc.samples.7:190
14465 msgid "\"Font Modes (Emphasis, Literal, and Symbolic)\" ."
14469 #: build/C/man7/mdoc.samples.7:191
14471 msgid "\"Lists and Columns\" ."
14474 #. type: Plain text
14475 #: build/C/man7/mdoc.samples.7:195
14476 msgid "E<.Tn \"PREDEFINED STRINGS\">"
14479 #. type: Plain text
14480 #: build/C/man7/mdoc.samples.7:197
14481 msgid "E<.Tn \"DIAGNOSTICS\">"
14484 #. type: Plain text
14485 #: build/C/man7/mdoc.samples.7:199
14486 msgid "E<.Tn \"FORMATTING WITH GROFF, TROFF AND NROFF\">"
14489 #. type: Plain text
14490 #: build/C/man7/mdoc.samples.7:201
14491 msgid "E<.Tn \"BUGS\">"
14495 #: build/C/man7/mdoc.samples.7:203
14497 msgid "TROFF IDIOSYNCRASIES"
14500 #. type: Plain text
14501 #: build/C/man7/mdoc.samples.7:217
14503 "The E<.Nm \\-mdoc> package attempts to simplify the process of writing a man "
14504 "page. Theoretically, one should not have to learn the dirty details of "
14505 "E<.Xr troff 1> to use E<.Nm \\-mdoc>; however, there are a few limitations "
14506 "which are unavoidable and best gotten out of the way. And, too, be "
14507 "forewarned, this package is E<.Em not> fast."
14511 #: build/C/man7/mdoc.samples.7:217
14513 msgid "Macro Usage"
14516 #. type: Plain text
14517 #: build/C/man7/mdoc.samples.7:242
14519 "As in E<.Xr troff 1>, a macro is called by placing a E<.Ql \\&.> (dot "
14520 "character) at the beginning of a line followed by the two character name "
14521 "for the macro. Arguments may follow the macro separated by spaces. It is "
14522 "the dot character at the beginning of the line which causes E<.Xr troff 1> "
14523 "to interpret the next two characters as a macro name. To place a E<.Ql "
14524 "\\&.> (dot character) at the beginning of a line in some context other than "
14525 "a macro invocation, precede the E<.Ql \\&.> (dot) with the E<.Ql \\e&> "
14526 "escape sequence. The E<.Ql \\e&> translates literally to a zero width "
14527 "space, and is never displayed in the output."
14530 #. type: Plain text
14531 #: build/C/man7/mdoc.samples.7:257
14533 "In general, E<.Xr troff 1> macros accept up to nine arguments, any extra "
14534 "arguments are ignored. Most macros in E<.Nm \\-mdoc> accept nine arguments "
14535 "and, in limited cases, arguments may be continued or extended on the next "
14536 "line (See E<.Sx Extensions>). A few macros handle quoted arguments (see "
14537 "E<.Sx Passing Space Characters in an Argument> below)."
14540 #. type: Plain text
14541 #: build/C/man7/mdoc.samples.7:284
14543 "Most of the E<.Nm \\-mdoc> general text domain and manual domain macros are "
14544 "special in that their argument lists are E<.Em parsed> for callable macro "
14545 "names. This means an argument on the argument list which matches a general "
14546 "text or manual domain macro name and is determined to be callable will be "
14547 "executed or called when it is processed. In this case the argument, "
14548 "although the name of a macro, is not preceded by a E<.Ql \\&.> (dot). It is "
14549 "in this manner that many macros are nested; for example the option macro, "
14550 "E<.Ql \\&.Op>, may E<.Em call> the flag and argument macros, E<.Ql \\&Fl> "
14551 "and E<.Ql \\&Ar>, to specify an optional flag with an argument:"
14555 #: build/C/man7/mdoc.samples.7:285
14557 msgid "Op Fl s Ar bytes"
14560 #. type: Plain text
14561 #: build/C/man7/mdoc.samples.7:288
14562 msgid "is produced by E<.Li \\&.Op \\&Fl s \\&Ar bytes>"
14565 #. type: Plain text
14566 #: build/C/man7/mdoc.samples.7:295
14568 "To prevent a two character string from being interpreted as a macro name, "
14569 "precede the string with the escape sequence E<.Ql \\e&>:"
14573 #: build/C/man7/mdoc.samples.7:296
14575 msgid "Op \\&Fl s \\&Ar bytes"
14578 #. type: Plain text
14579 #: build/C/man7/mdoc.samples.7:299
14580 msgid "is produced by E<.Li \\&.Op \\e&Fl s \\e&Ar bytes>"
14583 #. type: Plain text
14584 #: build/C/man7/mdoc.samples.7:320
14586 "Here the strings E<.Ql \\&Fl> and E<.Ql \\&Ar> are not interpreted as "
14587 "macros. Macros whose argument lists are parsed for callable arguments are "
14588 "referred to as parsed and macros which may be called from an argument list "
14589 "are referred to as callable throughout this document and in the companion "
14590 "quick reference manual E<.Xr mdoc 7>. This is a technical E<.Em faux pas> "
14591 "as almost all of the macros in E<.Nm \\-mdoc> are parsed, but as it was "
14592 "cumbersome to constantly refer to macros as being callable and being able to "
14593 "call other macros, the term parsed has been used."
14597 #: build/C/man7/mdoc.samples.7:320
14599 msgid "Passing Space Characters in an Argument"
14602 #. type: Plain text
14603 #: build/C/man7/mdoc.samples.7:338
14605 "Sometimes it is desirable to give as one argument a string containing one or "
14606 "more blank space characters. This may be necessary to defeat the nine "
14607 "argument limit or to specify arguments to macros which expect particular "
14608 "arrangement of items in the argument list. For example, the function macro "
14609 "E<.Ql \\&.Fn> expects the first argument to be the name of a function and "
14610 "any remaining arguments to be function parameters. As E<.Tn \"ANSI C\"> "
14611 "stipulates the declaration of function parameters in the parenthesized "
14612 "parameter list, each parameter is guaranteed to be at minimum a two word "
14613 "string. For example, E<.Fa int foo>."
14616 #. type: Plain text
14617 #: build/C/man7/mdoc.samples.7:353
14619 "There are two possible ways to pass an argument which contains an embedded "
14620 "space. E<.Em Implementation note>: Unfortunately, the most convenient way "
14621 "of passing spaces in between quotes by reassigning individual arguments "
14622 "before parsing was fairly expensive speed wise and space wise to implement "
14623 "in all the macros for E<.Tn AT&T> E<.Xr troff>. It is not expensive for "
14624 "E<.Xr groff> but for the sake of portability, has been limited to the "
14625 "following macros which need it the most:"
14629 #: build/C/man7/mdoc.samples.7:355
14634 #. type: Plain text
14635 #: build/C/man7/mdoc.samples.7:358
14636 msgid "Configuration declaration (section 4 E<.Sx SYNOPSIS>)"
14640 #: build/C/man7/mdoc.samples.7:358
14645 #. type: Plain text
14646 #: build/C/man7/mdoc.samples.7:360
14647 msgid "Begin list (for the width specifier)."
14651 #: build/C/man7/mdoc.samples.7:360
14656 #. type: Plain text
14657 #: build/C/man7/mdoc.samples.7:362
14658 msgid "Emphasized text."
14662 #: build/C/man7/mdoc.samples.7:362
14667 #. type: Plain text
14668 #: build/C/man7/mdoc.samples.7:364
14669 msgid "Functions (sections two and four)."
14673 #: build/C/man7/mdoc.samples.7:364
14678 #. type: Plain text
14679 #: build/C/man7/mdoc.samples.7:366
14680 msgid "List items."
14684 #: build/C/man7/mdoc.samples.7:366
14689 #. type: Plain text
14690 #: build/C/man7/mdoc.samples.7:368
14691 msgid "Literal text."
14695 #: build/C/man7/mdoc.samples.7:368
14700 #. type: Plain text
14701 #: build/C/man7/mdoc.samples.7:370
14702 msgid "Symbolic text."
14706 #: build/C/man7/mdoc.samples.7:370
14711 #. type: Plain text
14712 #: build/C/man7/mdoc.samples.7:372
14713 msgid "Book titles."
14717 #: build/C/man7/mdoc.samples.7:372
14722 #. type: Plain text
14723 #: build/C/man7/mdoc.samples.7:374
14724 msgid "Journal names."
14728 #: build/C/man7/mdoc.samples.7:374
14733 #. type: Plain text
14734 #: build/C/man7/mdoc.samples.7:376
14735 msgid "Optional notes for a reference."
14739 #: build/C/man7/mdoc.samples.7:376
14744 #. type: Plain text
14745 #: build/C/man7/mdoc.samples.7:378
14746 msgid "Report title (in a reference)."
14750 #: build/C/man7/mdoc.samples.7:378
14755 #. type: Plain text
14756 #: build/C/man7/mdoc.samples.7:380
14757 msgid "Title of article in a book or journal."
14760 #. type: Plain text
14761 #: build/C/man7/mdoc.samples.7:397
14763 "One way of passing a string containing blank spaces is to use the hard or "
14764 "unpaddable space character E<.Ql \\e\\ >, that is, a blank space preceded by "
14765 "the escape character E<.Ql \\e>. This method may be used with any macro but "
14766 "has the side effect of interfering with the adjustment of text over the "
14767 "length of a line. E<.Xr Troff> sees the hard space as if it were any other "
14768 "printable character and cannot split the string into blank or newline "
14769 "separated pieces as one would expect. The method is useful for strings "
14770 "which are not expected to overlap a line boundary. For example:"
14774 #: build/C/man7/mdoc.samples.7:398
14776 msgid "Fn fetch char\\ *str"
14779 #. type: Plain text
14780 #: build/C/man7/mdoc.samples.7:401
14781 msgid "is created by E<.Ql \\&.Fn fetch char\\e *str>"
14785 #: build/C/man7/mdoc.samples.7:401
14787 msgid "Fn fetch \"char *str\""
14790 #. type: Plain text
14791 #: build/C/man7/mdoc.samples.7:404
14792 msgid "can also be created by E<.Ql \\&.Fn fetch \"\\*qchar *str\\*q\">"
14795 #. type: Plain text
14796 #: build/C/man7/mdoc.samples.7:413
14798 "If the E<.Ql \\e> or quotes were omitted, E<.Ql \\&.Fn> would see three "
14799 "arguments and the result would be:"
14803 #: build/C/man7/mdoc.samples.7:414
14805 msgid "Fn fetch char *str"
14808 #. type: Plain text
14809 #: build/C/man7/mdoc.samples.7:420
14811 "For an example of what happens when the parameter list overlaps a newline "
14812 "boundary, see the E<.Sx BUGS> section."
14816 #: build/C/man7/mdoc.samples.7:420
14818 msgid "Trailing Blank Space Characters"
14821 #. type: Plain text
14822 #: build/C/man7/mdoc.samples.7:433
14824 "E<.Xr Troff> can be confused by blank space characters at the end of a "
14825 "line. It is a wise preventive measure to globally remove all blank spaces "
14826 "from E<lt>blank-spaceE<gt>E<lt>end-of-lineE<gt> character sequences. Should "
14827 "the need arise to force a blank character at the end of a line, it may be "
14828 "forced with an unpaddable space and the E<.Ql \\e&> escape character. For "
14829 "example, E<.Ql string\\e\\ \\e&>."
14833 #: build/C/man7/mdoc.samples.7:433
14835 msgid "Escaping Special Characters"
14838 #. type: Plain text
14839 #: build/C/man7/mdoc.samples.7:445
14841 "Special characters like the newline character E<.Ql \\en>, are handled by "
14842 "replacing the E<.Ql \\e> with E<.Ql \\ee> (e.g., E<.Ql \\een>) to preserve "
14847 #: build/C/man7/mdoc.samples.7:445
14849 msgid "THE ANATOMY OF A MAN PAGE"
14852 #. type: Plain text
14853 #: build/C/man7/mdoc.samples.7:452
14855 "The body of a man page is easily constructed from a basic template found in "
14856 "the file E<.Pa /usr/share/misc/mdoc.template>. Several example man pages "
14857 "can also be found in E<.Pa /usr/share/examples/mdoc>."
14861 #: build/C/man7/mdoc.samples.7:453
14863 msgid "A manual page template"
14866 #. type: Plain text
14867 #: build/C/man7/mdoc.samples.7:484
14870 "\\&.\\e\" The following requests are required for all man pages.\n"
14871 "\\&.Dd Month day, year\n"
14872 "\\&.Os OPERATING_SYSTEM [version/release]\n"
14873 "\\&.Dt DOCUMENT_TITLE [section number] [volume]\n"
14876 "\\&.Nd one line description of name\n"
14877 "\\&.Sh SYNOPSIS\n"
14878 "\\&.Sh DESCRIPTION\n"
14879 "\\&.\\e\" The following requests should be uncommented and\n"
14880 "\\&.\\e\" used where appropriate. This next request is\n"
14881 "\\&.\\e\" for sections 2 and 3 function return values only.\n"
14882 "\\&.\\e\" .Sh RETURN VALUE\n"
14883 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
14884 "\\&.\\e\" .Sh ENVIRONMENT\n"
14885 "\\&.\\e\" .Sh FILES\n"
14886 "\\&.\\e\" .Sh EXAMPLES\n"
14887 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
14888 "\\&.\\e\" (command return values (to shell) and\n"
14889 "\\&.\\e\"\t fprintf/stderr type diagnostics)\n"
14890 "\\&.\\e\" .Sh DIAGNOSTICS\n"
14891 "\\&.\\e\" The next request is for sections 2 and 3 error\n"
14892 "\\&.\\e\" and signal handling only.\n"
14893 "\\&.\\e\" .Sh ERRORS\n"
14894 "\\&.\\e\" .Sh SEE ALSO\n"
14895 "\\&.\\e\" .Sh CONFORMING TO\n"
14896 "\\&.\\e\" .Sh HISTORY\n"
14897 "\\&.\\e\" .Sh AUTHORS\n"
14898 "\\&.\\e\" .Sh BUGS\n"
14901 #. type: Plain text
14902 #: build/C/man7/mdoc.samples.7:498
14904 "The first items in the template are the macros E<.Pq Li \\&.Dd , \\&.Os , "
14905 "\\&.Dt>; the document date, the operating system the man page or subject "
14906 "source is developed or modified for, and the man page title E<.Pq Em in "
14907 "upper case> along with the section of the manual the page belongs in. These "
14908 "macros identify the page, and are discussed below in E<.Sx TITLE MACROS>."
14911 #. type: Plain text
14912 #: build/C/man7/mdoc.samples.7:517
14914 "The remaining items in the template are section headers E<.Pq Li \\&.Sh>; of "
14915 "which E<.Sx NAME>, E<.Sx SYNOPSIS> and E<.Sx DESCRIPTION> are mandatory. "
14916 "The headers are discussed in E<.Sx PAGE STRUCTURE DOMAIN>, after "
14917 "presentation of E<.Sx MANUAL DOMAIN>. Several content macros are used to "
14918 "demonstrate page layout macros; reading about content macros before page "
14919 "layout macros is recommended."
14923 #: build/C/man7/mdoc.samples.7:517
14925 msgid "TITLE MACROS"
14928 #. type: Plain text
14929 #: build/C/man7/mdoc.samples.7:526
14931 "The title macros are the first portion of the page structure domain, but are "
14932 "presented first and separate for someone who wishes to start writing a man "
14933 "page yesterday. Three header macros designate the document title or manual "
14934 "page title, the operating system, and the date of authorship. These macros "
14935 "are one called once at the very beginning of the document and are used to "
14936 "construct the headers and footers only."
14940 #: build/C/man7/mdoc.samples.7:527
14942 msgid "Li \\&.Dt DOCUMENT_TITLE section# [volume]"
14946 #. USD UNIX User's Supplementary Documents
14948 #. PS1 UNIX Programmer's Supplementary Documents
14949 #. type: Plain text
14950 #: build/C/man7/mdoc.samples.7:541
14952 "The document title is the subject of the man page and must be in E<.Tn "
14953 "CAPITALS> due to troff limitations. The section number may be 1,\\ ...,\\ "
14954 "8, and if it is specified, the volume title may be omitted. A volume title "
14955 "may be arbitrary or one of the following:"
14959 #: build/C/man7/mdoc.samples.7:543
14961 msgid "Li \"AMD\tUNIX Ancestral Manual Documents\""
14965 #: build/C/man7/mdoc.samples.7:544
14967 msgid "Li \"SMM\tUNIX System Manager's Manual\""
14971 #: build/C/man7/mdoc.samples.7:545
14973 msgid "Li \"URM\tUNIX Reference Manual\""
14977 #: build/C/man7/mdoc.samples.7:546
14979 msgid "Li \"PRM\tUNIX Programmer's Manual\""
14983 #. MMI UNIX Manual Master Index
14985 #. CON UNIX Contributed Software Manual
14987 #. LOC UNIX Local Manual
14988 #. type: Plain text
14989 #: build/C/man7/mdoc.samples.7:562
14991 "The default volume labeling is E<.Li URM> for sections 1, 6, and 7; E<.Li "
14992 "SMM> for section 8; E<.Li PRM> for sections 2, 3, 4, and 5."
14996 #: build/C/man7/mdoc.samples.7:562
14998 msgid "Li \\&.Os operating_system release#"
15001 #. type: Plain text
15002 #: build/C/man7/mdoc.samples.7:575
15004 "The name of the operating system should be the common acronym, for example, "
15005 "E<.Tn BSD> or E<.Tn FreeBSD> or E<.Tn ATT>. The release should be the "
15006 "standard release nomenclature for the system specified, for example, 4.3, "
15007 "4.3+Tahoe, V.3, V.4. Unrecognized arguments are displayed as given in the "
15008 "page footer. For instance, a typical footer might be:"
15012 #: build/C/man7/mdoc.samples.7:576
15014 msgid "\\&.Os 4.3BSD"
15017 #. type: Plain text
15018 #: build/C/man7/mdoc.samples.7:579
15023 #: build/C/man7/mdoc.samples.7:579
15025 msgid "\\&.Os FreeBSD 2.2"
15028 #. type: Plain text
15029 #: build/C/man7/mdoc.samples.7:582
15030 msgid "or for a locally produced set"
15034 #: build/C/man7/mdoc.samples.7:583
15036 msgid "\\&.Os CS Department"
15039 #. type: Plain text
15040 #: build/C/man7/mdoc.samples.7:598
15042 "The Berkeley default, E<.Ql \\&.Os> without an argument, has been defined as "
15043 "E<.Tn BSD> in the site-specific file E<.Pa "
15044 "/usr/share/tmac/mdoc/doc-common>. It really should default to E<.Tn "
15045 "LOCAL>. Note, if the E<.Ql \\&.Os> macro is not present, the bottom left "
15046 "corner of the page will be ugly."
15050 #: build/C/man7/mdoc.samples.7:598
15052 msgid "Li \\&.Dd month day, year"
15055 #. type: Plain text
15056 #: build/C/man7/mdoc.samples.7:600
15057 msgid "The date should be written formally:"
15061 #: build/C/man7/mdoc.samples.7:602
15063 msgid "January 25, 1989"
15067 #: build/C/man7/mdoc.samples.7:604
15069 msgid "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
15073 #: build/C/man7/mdoc.samples.7:605
15075 msgid "What's in a name..."
15078 #. type: Plain text
15079 #: build/C/man7/mdoc.samples.7:622
15081 "The manual domain macro names are derived from the day to day informal "
15082 "language used to describe commands, subroutines and related files. Slightly "
15083 "different variations of this language are used to describe the three "
15084 "different aspects of writing a man page. First, there is the description of "
15085 "E<.Nm \\-mdoc> macro request usage. Second is the description of a E<.Ux> "
15086 "command E<.Em with> E<.Nm \\-mdoc> macros and third, the description of a "
15087 "command to a user in the verbal sense; that is, discussion of a command in "
15088 "the text of a man page."
15091 #. type: Plain text
15092 #: build/C/man7/mdoc.samples.7:627
15094 "In the first case, E<.Xr troff 1> macros are themselves a type of command; "
15095 "the general syntax for a troff command is:"
15098 #. type: Plain text
15099 #: build/C/man7/mdoc.samples.7:629
15101 msgid "\\&.Va argument1 argument2 ... argument9\n"
15104 #. type: Plain text
15105 #: build/C/man7/mdoc.samples.7:643
15107 "The E<.Ql \\&.Va> is a macro command or request, and anything following it "
15108 "is an argument to be processed. In the second case, the description of a "
15109 "E<.Ux> command using the content macros is a bit more involved; a typical "
15110 "E<.Sx SYNOPSIS> command line might be displayed as:"
15113 #. type: Plain text
15114 #: build/C/man7/mdoc.samples.7:647
15119 "E<.Ar infile outfile>\n"
15122 #. type: Plain text
15123 #: build/C/man7/mdoc.samples.7:667
15125 "Here, E<.Nm filter> is the command name and the bracketed string E<.Fl flag> "
15126 "is a E<.Em flag> argument designated as optional by the option brackets. In "
15127 "E<.Nm \\-mdoc> terms, E<.Ar infile> and E<.Ar outfile> are called E<.Em "
15128 "arguments>. The macros which formatted the above example:"
15131 #. type: Plain text
15132 #: build/C/man7/mdoc.samples.7:671
15136 "\\&.Op \\&Fl flag\n"
15137 "\\&.Ar infile outfile\n"
15140 #. type: Plain text
15141 #: build/C/man7/mdoc.samples.7:685
15143 "In the third case, discussion of commands and command syntax includes both "
15144 "examples above, but may add more detail. The arguments E<.Ar infile> and "
15145 "E<.Ar outfile> from the example above might be referred to as E<.Em "
15146 "operands> or E<.Em file arguments>. Some command-line argument lists are "
15151 #: build/C/man7/mdoc.samples.7:686
15156 #. type: Plain text
15157 #: build/C/man7/mdoc.samples.7:699
15159 "E<.Op Fl eiknqrstv> E<.Op Fl D Ar variable> E<.Op Fl d Ar flags> E<.Op Fl f "
15160 "Ar makefile> E<.Bk -words> E<.Op Fl I Ar directory> E<.Ek> E<.Op Fl j Ar "
15161 "max_jobs> E<.Op Ar variable=value> E<.Bk -words> E<.Op Ar target ...> E<.Ek>"
15164 #. type: Plain text
15165 #: build/C/man7/mdoc.samples.7:725
15167 "Here one might talk about the command E<.Nm make> and qualify the argument "
15168 "E<.Ar makefile>, as an argument to the flag, E<.Fl f>, or discuss the "
15169 "optional file operand E<.Ar target>. In the verbal context, such detail can "
15170 "prevent confusion, however the E<.Nm \\-mdoc> package does not have a macro "
15171 "for an argument E<.Em to> a flag. Instead the E<.Ql \\&Ar> argument macro "
15172 "is used for an operand or file argument like E<.Ar target> as well as an "
15173 "argument to a flag like E<.Ar variable>. The make command line was produced "
15177 #. type: Plain text
15178 #: build/C/man7/mdoc.samples.7:737
15182 "\\&.Op Fl eiknqrstv\n"
15183 "\\&.Op Fl D Ar variable\n"
15184 "\\&.Op Fl d Ar flags\n"
15185 "\\&.Op Fl f Ar makefile\n"
15186 "\\&.Op Fl I Ar directory\n"
15187 "\\&.Op Fl j Ar max_jobs\n"
15188 "\\&.Op Ar variable=value\n"
15190 "\\&.Op Ar target ...\n"
15194 #. type: Plain text
15195 #: build/C/man7/mdoc.samples.7:745
15196 msgid "The E<.Ql \\&.Bk> and E<.Ql \\&.Ek> macros are explained in E<.Sx Keeps>."
15200 #: build/C/man7/mdoc.samples.7:745
15202 msgid "General Syntax"
15205 #. type: Plain text
15206 #: build/C/man7/mdoc.samples.7:768
15208 "The manual domain and general text domain macros share a similar syntax with "
15209 "a few minor deviations: E<.Ql \\&.Ar>, E<.Ql \\&.Fl>, E<.Ql \\&.Nm>, and "
15210 "E<.Ql \\&.Pa> differ only when called without arguments; E<.Ql \\&.Fn> and "
15211 "E<.Ql \\&.Xr> impose an order on their argument lists and the E<.Ql \\&.Op> "
15212 "and E<.Ql \\&.Fn> macros have nesting limitations. All content macros are "
15213 "capable of recognizing and properly handling punctuation, provided each "
15214 "punctuation character is separated by a leading space. If a request is "
15219 #: build/C/man7/mdoc.samples.7:769
15221 msgid "\\&.Li sptr, ptr),"
15224 #. type: Plain text
15225 #: build/C/man7/mdoc.samples.7:772 build/C/man7/mdoc.samples.7:782
15226 msgid "The result is:"
15230 #: build/C/man7/mdoc.samples.7:773
15232 msgid "Li sptr, ptr),"
15235 #. type: Plain text
15236 #: build/C/man7/mdoc.samples.7:778
15238 "The punctuation is not recognized and all is output in the literal font. If "
15239 "the punctuation is separated by a leading white space:"
15243 #: build/C/man7/mdoc.samples.7:779
15245 msgid "\\&.Li \"sptr , ptr ) ,\""
15249 #: build/C/man7/mdoc.samples.7:783
15251 msgid "Li sptr , ptr ) ,"
15254 #. type: Plain text
15255 #: build/C/man7/mdoc.samples.7:787
15257 "The punctuation is now recognized and is output in the default font "
15258 "distinguishing it from the strings in literal font."
15261 #. type: Plain text
15262 #: build/C/man7/mdoc.samples.7:796
15264 "To remove the special meaning from a punctuation character escape it with "
15265 "E<.Ql \\e&>. E<.Xr Troff> is limited as a macro language, and has "
15266 "difficulty when presented with a string containing a member of the "
15267 "mathematical, logical or quotation set:"
15270 #. type: Plain text
15271 #: build/C/man7/mdoc.samples.7:798
15273 msgid "\\&{+,\\-,/,*,\\&%,E<lt>,E<gt>,E<lt>=,E<gt>=,=,==,&,`,',\"}\n"
15276 #. type: Plain text
15277 #: build/C/man7/mdoc.samples.7:810
15279 "The problem is that E<.Xr troff> may assume it is supposed to actually "
15280 "perform the operation or evaluation suggested by the characters. To prevent "
15281 "the accidental evaluation of these characters, escape them with E<.Ql "
15282 "\\e&>. Typical syntax is shown in the first content macro displayed below, "
15287 #: build/C/man7/mdoc.samples.7:810
15289 msgid "MANUAL DOMAIN"
15293 #: build/C/man7/mdoc.samples.7:811
15295 msgid "Address Macro"
15298 #. type: Plain text
15299 #: build/C/man7/mdoc.samples.7:814
15301 "The address macro identifies an address construct of the form "
15302 "addr1[,addr2[,addr3]]."
15306 #: build/C/man7/mdoc.samples.7:815
15308 msgid "Usage: .Ad address ... \\*(Pu"
15312 #: build/C/man7/mdoc.samples.7:817
15314 msgid "Li \\&.Ad addr1"
15317 #. type: Plain text
15318 #: build/C/man7/mdoc.samples.7:819
15319 msgid "E<.Ad addr1>"
15323 #: build/C/man7/mdoc.samples.7:819
15325 msgid "Li \\&.Ad addr1\\ ."
15328 #. type: Plain text
15329 #: build/C/man7/mdoc.samples.7:821
15330 msgid "E<.Ad addr1>."
15334 #: build/C/man7/mdoc.samples.7:821
15336 msgid "Li \\&.Ad addr1\\ , file2"
15339 #. type: Plain text
15340 #: build/C/man7/mdoc.samples.7:823
15341 msgid "E<.Ad addr1 , file2>"
15345 #: build/C/man7/mdoc.samples.7:823
15347 msgid "Li \\&.Ad f1\\ , f2\\ , f3\\ :"
15350 #. type: Plain text
15351 #: build/C/man7/mdoc.samples.7:825
15352 msgid "E<.Ad f1 , f2 , f3>:"
15356 #: build/C/man7/mdoc.samples.7:825
15358 msgid "Li \\&.Ad addr\\ )\\ )\\ ,"
15361 #. type: Plain text
15362 #: build/C/man7/mdoc.samples.7:827
15363 msgid "E<.Ad addr>)),"
15366 #. type: Plain text
15367 #: build/C/man7/mdoc.samples.7:834
15369 "It is an error to call E<.Ql \\&.Ad> without arguments. E<.Ql \\&.Ad> is "
15370 "callable by other macros and is parsed."
15374 #: build/C/man7/mdoc.samples.7:834
15376 msgid "Author Name"
15379 #. type: Plain text
15380 #: build/C/man7/mdoc.samples.7:841
15382 "The E<.Ql \\&.An> macro is used to specify the name of the author of the "
15383 "item being documented, or the name of the author of the actual manual page. "
15384 "Any remaining arguments after the name information are assumed to be "
15389 #: build/C/man7/mdoc.samples.7:842
15391 msgid "Usage: .An author_name \\*(Pu"
15395 #: build/C/man7/mdoc.samples.7:844
15397 msgid "Li \\&.An Joe\\ Author"
15400 #. type: Plain text
15401 #: build/C/man7/mdoc.samples.7:846
15402 msgid "E<.An Joe Author>"
15406 #: build/C/man7/mdoc.samples.7:846
15408 msgid "Li \\&.An Joe\\ Author\\ ,"
15411 #. type: Plain text
15412 #: build/C/man7/mdoc.samples.7:848
15413 msgid "E<.An Joe\\ Author>,"
15417 #: build/C/man7/mdoc.samples.7:848
15419 msgid "Li \\&.An Joe\\ Author\\ \\&Aq\\ nobody@FreeBSD.ORG"
15422 #. type: Plain text
15423 #: build/C/man7/mdoc.samples.7:850
15424 msgid "E<.An Joe Author Aq nobody@FreeBSD.ORG>"
15428 #: build/C/man7/mdoc.samples.7:850
15430 msgid "Li \\&.An Joe\\ Author\\ )\\ )\\ ,"
15433 #. type: Plain text
15434 #: build/C/man7/mdoc.samples.7:852
15435 msgid "E<.An Joe Author>)),"
15438 #. type: Plain text
15439 #: build/C/man7/mdoc.samples.7:861
15441 "The E<.Ql \\&.An> macro is parsed and is callable. It is an error to call "
15442 "E<.Ql \\&.An> without any arguments."
15446 #: build/C/man7/mdoc.samples.7:861
15448 msgid "Argument Macro"
15451 #. type: Plain text
15452 #: build/C/man7/mdoc.samples.7:866
15454 "The E<.Ql \\&.Ar> argument macro may be used whenever a command-line "
15455 "argument is referenced."
15459 #: build/C/man7/mdoc.samples.7:867
15461 msgid "Usage: .Ar argument ... \\*(Pu"
15465 #: build/C/man7/mdoc.samples.7:869
15470 #. type: Plain text
15471 #: build/C/man7/mdoc.samples.7:871
15476 #: build/C/man7/mdoc.samples.7:871
15478 msgid "Li \\&.Ar file1"
15481 #. type: Plain text
15482 #: build/C/man7/mdoc.samples.7:873
15483 msgid "E<.Ar file1>"
15487 #: build/C/man7/mdoc.samples.7:873
15489 msgid "Li \\&.Ar file1\\ ."
15492 #. type: Plain text
15493 #: build/C/man7/mdoc.samples.7:875
15494 msgid "E<.Ar file1>."
15498 #: build/C/man7/mdoc.samples.7:875
15500 msgid "Li \\&.Ar file1 file2"
15503 #. type: Plain text
15504 #: build/C/man7/mdoc.samples.7:877
15505 msgid "E<.Ar file1 file2>"
15509 #: build/C/man7/mdoc.samples.7:877
15511 msgid "Li \\&.Ar f1 f2 f3\\ :"
15514 #. type: Plain text
15515 #: build/C/man7/mdoc.samples.7:879
15516 msgid "E<.Ar f1 f2 f3>:"
15520 #: build/C/man7/mdoc.samples.7:879
15522 msgid "Li \\&.Ar file\\ )\\ )\\ ,"
15525 #. type: Plain text
15526 #: build/C/man7/mdoc.samples.7:881
15527 msgid "E<.Ar file>)),"
15530 #. type: Plain text
15531 #: build/C/man7/mdoc.samples.7:891
15533 "If E<.Ql \\&.Ar> is called without arguments E<.Ql \\&Ar> is assumed. The "
15534 "E<.Ql \\&.Ar> macro is parsed and is callable."
15538 #: build/C/man7/mdoc.samples.7:891
15540 msgid "Configuration Declaration (section four only)"
15543 #. type: Plain text
15544 #: build/C/man7/mdoc.samples.7:898
15546 "The E<.Ql \\&.Cd> macro is used to demonstrate a E<.Xr config 8> declaration "
15547 "for a device interface in a section four manual. This macro accepts quoted "
15548 "arguments (double quotes only)."
15552 #: build/C/man7/mdoc.samples.7:900
15554 msgid "Cd \"device le0 at scode?\""
15557 #. type: Plain text
15558 #: build/C/man7/mdoc.samples.7:903
15559 msgid "produced by: E<.Ql \".Cd device le0 at scode?\">."
15563 #: build/C/man7/mdoc.samples.7:904
15565 msgid "Command Modifier"
15568 #. type: Plain text
15569 #: build/C/man7/mdoc.samples.7:918
15571 "The command modifier is identical to the E<.Ql \\&.Fl> (flag) command with "
15572 "the exception the E<.Ql \\&.Cm> macro does not assert a dash in front of "
15573 "every argument. Traditionally flags are marked by the preceding dash, some "
15574 "commands or subsets of commands do not use them. Command modifiers may also "
15575 "be specified in conjunction with interactive commands such as editor "
15576 "commands. See E<.Sx Flags>."
15580 #: build/C/man7/mdoc.samples.7:918
15582 msgid "Defined Variables"
15585 #. type: Plain text
15586 #: build/C/man7/mdoc.samples.7:922
15588 "A variable which is defined in an include file is specified by the macro "
15593 #: build/C/man7/mdoc.samples.7:923
15595 msgid "Usage: .Dv defined_variable ... \\*(Pu"
15599 #: build/C/man7/mdoc.samples.7:925
15601 msgid "Li \".Dv MAXHOSTNAMELEN\""
15604 #. type: Plain text
15605 #: build/C/man7/mdoc.samples.7:927
15606 msgid "E<.Dv MAXHOSTNAMELEN>"
15610 #: build/C/man7/mdoc.samples.7:927
15612 msgid "Li \".Dv TIOCGPGRP )\""
15615 #. type: Plain text
15616 #: build/C/man7/mdoc.samples.7:929
15617 msgid "E<.Dv TIOCGPGRP>)"
15620 #. type: Plain text
15621 #: build/C/man7/mdoc.samples.7:936
15623 "It is an error to call E<.Ql \\&.Dv> without arguments. E<.Ql \\&.Dv> is "
15624 "parsed and is callable."
15628 #: build/C/man7/mdoc.samples.7:936
15630 msgid "Errno's (Section two only)"
15633 #. type: Plain text
15634 #: build/C/man7/mdoc.samples.7:948
15636 "The E<.Ql \\&.Er> errno macro specifies the error return value for section "
15637 "two library routines. The second example below shows E<.Ql \\&.Er> used "
15638 "with the E<.Ql \\&.Bq> general text domain macro, as it would be used in a "
15639 "section two manual page."
15643 #: build/C/man7/mdoc.samples.7:949
15645 msgid "Usage: .Er ERRNOTYPE ... \\*(Pu"
15649 #: build/C/man7/mdoc.samples.7:951
15651 msgid "Li \\&.Er ENOENT"
15654 #. type: Plain text
15655 #: build/C/man7/mdoc.samples.7:953
15656 msgid "E<.Er ENOENT>"
15660 #: build/C/man7/mdoc.samples.7:953
15662 msgid "Li \\&.Er ENOENT\\ )\\ ;"
15665 #. type: Plain text
15666 #: build/C/man7/mdoc.samples.7:955
15667 msgid "E<.Er ENOENT>);"
15671 #: build/C/man7/mdoc.samples.7:955
15673 msgid "Li \\&.Bq \\&Er ENOTDIR"
15676 #. type: Plain text
15677 #: build/C/man7/mdoc.samples.7:957
15678 msgid "E<.Bq Er ENOTDIR>"
15681 #. type: Plain text
15682 #: build/C/man7/mdoc.samples.7:965
15684 "It is an error to call E<.Ql \\&.Er> without arguments. The E<.Ql \\&.Er> "
15685 "macro is parsed and is callable."
15689 #: build/C/man7/mdoc.samples.7:965
15691 msgid "Environment Variables"
15694 #. type: Plain text
15695 #: build/C/man7/mdoc.samples.7:969
15696 msgid "The E<.Ql \\&.Ev> macro specifies an environment variable."
15700 #: build/C/man7/mdoc.samples.7:970
15702 msgid "Usage: .Ev argument ... \\*(Pu"
15706 #: build/C/man7/mdoc.samples.7:972
15708 msgid "Li \\&.Ev DISPLAY"
15711 #. type: Plain text
15712 #: build/C/man7/mdoc.samples.7:974
15713 msgid "E<.Ev DISPLAY>"
15717 #: build/C/man7/mdoc.samples.7:974
15719 msgid "Li \\&.Ev PATH\\ ."
15722 #. type: Plain text
15723 #: build/C/man7/mdoc.samples.7:976
15724 msgid "E<.Ev PATH>."
15728 #: build/C/man7/mdoc.samples.7:976
15730 msgid "Li \\&.Ev PRINTER\\ )\\ )\\ ,"
15733 #. type: Plain text
15734 #: build/C/man7/mdoc.samples.7:978
15735 msgid "E<.Ev PRINTER>)),"
15738 #. type: Plain text
15739 #: build/C/man7/mdoc.samples.7:986
15741 "It is an error to call E<.Ql \\&.Ev> without arguments. The E<.Ql \\&.Ev> "
15742 "macro is parsed and is callable."
15746 #: build/C/man7/mdoc.samples.7:986
15748 msgid "Function Argument"
15751 #. type: Plain text
15752 #: build/C/man7/mdoc.samples.7:1005
15754 "The E<.Ql \\&.Fa> macro is used to refer to function arguments (parameters) "
15755 "outside of the E<.Sx SYNOPSIS> section of the manual or inside the E<.Sx "
15756 "SYNOPSIS> section should a parameter list be too long for the E<.Ql \\&.Fn> "
15757 "macro and the enclosure macros E<.Ql \\&.Fo> and E<.Ql \\&.Fc> must be "
15758 "used. E<.Ql \\&.Fa> may also be used to refer to structure members."
15762 #: build/C/man7/mdoc.samples.7:1006
15764 msgid "Usage: .Fa function_argument ... \\*(Pu"
15768 #: build/C/man7/mdoc.samples.7:1008
15770 msgid "Li \\&.Fa d_namlen\\ )\\ )\\ ,"
15773 #. type: Plain text
15774 #: build/C/man7/mdoc.samples.7:1010
15775 msgid "E<.Fa d_namlen>)),"
15779 #: build/C/man7/mdoc.samples.7:1010
15781 msgid "Li \\&.Fa iov_len"
15784 #. type: Plain text
15785 #: build/C/man7/mdoc.samples.7:1012
15786 msgid "E<.Fa iov_len>"
15789 #. type: Plain text
15790 #: build/C/man7/mdoc.samples.7:1019
15792 "It is an error to call E<.Ql \\&.Fa> without arguments. E<.Ql \\&.Fa> is "
15793 "parsed and is callable."
15797 #: build/C/man7/mdoc.samples.7:1019
15799 msgid "Function Declaration"
15802 #. type: Plain text
15803 #: build/C/man7/mdoc.samples.7:1030
15805 "The E<.Ql \\&.Fd> macro is used in the E<.Sx SYNOPSIS> section with section "
15806 "two or three functions. The E<.Ql \\&.Fd> macro does not call other macros "
15807 "and is not callable by other macros."
15811 #: build/C/man7/mdoc.samples.7:1031
15813 msgid "Usage: .Fd include_file (or defined variable)"
15816 #. type: Plain text
15817 #: build/C/man7/mdoc.samples.7:1042
15819 "In the E<.Sx SYNOPSIS> section a E<.Ql \\&.Fd> request causes a line break "
15820 "if a function has already been presented and a break has not occurred. This "
15821 "leaves a nice vertical space in between the previous function call and the "
15822 "declaration for the next function."
15826 #: build/C/man7/mdoc.samples.7:1042
15831 #. type: Plain text
15832 #: build/C/man7/mdoc.samples.7:1055
15834 "The E<.Ql \\&.Fl> macro handles command-line flags. It prepends a dash, "
15835 "E<.Ql \\->, to the flag. For interactive command flags, which are not "
15836 "prepended with a dash, the E<.Ql \\&.Cm> (command modifier) macro is "
15837 "identical, but without the dash."
15841 #: build/C/man7/mdoc.samples.7:1056
15843 msgid "Usage: .Fl argument ... \\*(Pu"
15847 #: build/C/man7/mdoc.samples.7:1058
15852 #. type: Plain text
15853 #: build/C/man7/mdoc.samples.7:1060
15858 #: build/C/man7/mdoc.samples.7:1060
15860 msgid "Li \\&.Fl cfv"
15863 #. type: Plain text
15864 #: build/C/man7/mdoc.samples.7:1062
15869 #: build/C/man7/mdoc.samples.7:1062
15871 msgid "Li \\&.Fl cfv\\ ."
15874 #. type: Plain text
15875 #: build/C/man7/mdoc.samples.7:1064
15876 msgid "E<.Fl cfv>."
15880 #: build/C/man7/mdoc.samples.7:1064
15882 msgid "Li \\&.Fl s v t"
15885 #. type: Plain text
15886 #: build/C/man7/mdoc.samples.7:1066
15887 msgid "E<.Fl s v t>"
15891 #: build/C/man7/mdoc.samples.7:1066
15893 msgid "Li \\&.Fl -\\ ,"
15896 #. type: Plain text
15897 #: build/C/man7/mdoc.samples.7:1068
15902 #: build/C/man7/mdoc.samples.7:1068
15904 msgid "Li \\&.Fl xyz\\ )\\ ,"
15907 #. type: Plain text
15908 #: build/C/man7/mdoc.samples.7:1070
15909 msgid "E<.Fl xyz>),"
15912 #. type: Plain text
15913 #: build/C/man7/mdoc.samples.7:1082
15915 "The E<.Ql \\&.Fl> macro without any arguments results in a dash representing "
15916 "I<stdin>/I<stdout>. Note that giving E<.Ql \\&.Fl> a single dash, will "
15917 "result in two dashes. The E<.Ql \\&.Fl> macro is parsed and is callable."
15921 #: build/C/man7/mdoc.samples.7:1082
15923 msgid "Functions (library routines)"
15926 #. type: Plain text
15927 #: build/C/man7/mdoc.samples.7:1084
15928 msgid "The .Fn macro is modeled on ANSI C conventions."
15931 #. type: Plain text
15932 #: build/C/man7/mdoc.samples.7:1086
15934 msgid "Usage: .Fn [type] function [[type] parameters ... \\*(Pu]\n"
15938 #: build/C/man7/mdoc.samples.7:1088
15940 msgid "Li \"\\&.Fn getchar\""
15943 #. type: Plain text
15944 #: build/C/man7/mdoc.samples.7:1090
15945 msgid "E<.Fn getchar>"
15949 #: build/C/man7/mdoc.samples.7:1090
15951 msgid "Li \"\\&.Fn strlen ) ,\""
15954 #. type: Plain text
15955 #: build/C/man7/mdoc.samples.7:1092
15956 msgid "E<.Fn strlen>),"
15960 #: build/C/man7/mdoc.samples.7:1092
15962 msgid "Li \\&.Fn \"\\*qint align\\*q\" \"\\*qconst * char *sptrs\\*q\" ,"
15965 #. type: Plain text
15966 #: build/C/man7/mdoc.samples.7:1094
15967 msgid "E<.Fn \"int align\" \"const * char *sptrs\">,"
15970 #. type: Plain text
15971 #: build/C/man7/mdoc.samples.7:1107
15973 "It is an error to call E<.Ql \\&.Fn> without any arguments. The E<.Ql "
15974 "\\&.Fn> macro is parsed and is callable, note that any call to another macro "
15975 "signals the end of the E<.Ql \\&.Fn> call (it will close-parenthesis at that "
15979 #. type: Plain text
15980 #: build/C/man7/mdoc.samples.7:1121
15982 "For functions that have more than eight parameters (and this is rare), the "
15983 "macros E<.Ql \\&.Fo> (function open) and E<.Ql \\&.Fc> (function close) "
15984 "may be used with E<.Ql \\&.Fa> (function argument) to get around the "
15985 "limitation. For example:"
15988 #. type: Plain text
15989 #: build/C/man7/mdoc.samples.7:1133
15992 "\\&.Fo \"int res_mkquery\"\n"
15993 "\\&.Fa \"int op\"\n"
15994 "\\&.Fa \"char *dname\"\n"
15995 "\\&.Fa \"int class\"\n"
15996 "\\&.Fa \"int type\"\n"
15997 "\\&.Fa \"char *data\"\n"
15998 "\\&.Fa \"int datalen\"\n"
15999 "\\&.Fa \"struct rrec *newrr\"\n"
16000 "\\&.Fa \"char *buf\"\n"
16001 "\\&.Fa \"int buflen\"\n"
16005 #. type: Plain text
16006 #: build/C/man7/mdoc.samples.7:1136 build/C/man7/mdoc.samples.7:2480
16010 #. type: Plain text
16011 #: build/C/man7/mdoc.samples.7:1148
16014 "E<.Fo \"int res_mkquery\">\n"
16015 "E<.Fa \"int op\">\n"
16016 "E<.Fa \"char *dname\">\n"
16017 "E<.Fa \"int class\">\n"
16018 "E<.Fa \"int type\">\n"
16019 "E<.Fa \"char *data\">\n"
16020 "E<.Fa \"int datalen\">\n"
16021 "E<.Fa \"struct rrec *newrr\">\n"
16022 "E<.Fa \"char *buf\">\n"
16023 "E<.Fa \"int buflen\">\n"
16027 #. type: Plain text
16028 #: build/C/man7/mdoc.samples.7:1171
16030 "The E<.Ql \\&.Fo> and E<.Ql \\&.Fc> macros are parsed and are callable. In "
16031 "the E<.Sx SYNOPSIS> section, the function will always begin at the beginning "
16032 "of line. If there is more than one function presented in the E<.Sx "
16033 "SYNOPSIS> section and a function type has not been given, a line break will "
16034 "occur, leaving a nice vertical space between the current function name and "
16035 "the one prior. At the moment, E<.Ql \\&.Fn> does not check its word "
16036 "boundaries against troff line lengths and may split across a newline "
16037 "ungracefully. This will be fixed in the near future."
16041 #: build/C/man7/mdoc.samples.7:1171
16043 msgid "Function Type"
16046 #. type: Plain text
16047 #: build/C/man7/mdoc.samples.7:1182
16049 "This macro is intended for the E<.Sx SYNOPSIS> section. It may be used "
16050 "anywhere else in the man page without problems, but its main purpose is to "
16051 "present the function type in kernel normal form for the E<.Sx SYNOPSIS> of "
16052 "sections two and three (it causes a line break allowing the function name to "
16053 "appear on the next line)."
16057 #: build/C/man7/mdoc.samples.7:1183
16059 msgid "Usage: .Ft type ... \\*(Pu"
16063 #: build/C/man7/mdoc.samples.7:1185
16065 msgid "Li \\&.Ft struct stat"
16068 #. type: Plain text
16069 #: build/C/man7/mdoc.samples.7:1187
16070 msgid "E<.Ft struct stat>"
16073 #. type: Plain text
16074 #: build/C/man7/mdoc.samples.7:1192
16075 msgid "The E<.Ql \\&.Ft> request is not callable by other macros."
16079 #: build/C/man7/mdoc.samples.7:1192
16081 msgid "Interactive Commands"
16084 #. type: Plain text
16085 #: build/C/man7/mdoc.samples.7:1196
16086 msgid "The E<.Ql \\&.Ic> macro designates an interactive or internal command."
16090 #: build/C/man7/mdoc.samples.7:1197
16092 msgid "Usage: .Ic argument ... \\*(Pu"
16096 #: build/C/man7/mdoc.samples.7:1199
16098 msgid "Li \\&.Ic :wq"
16101 #. type: Plain text
16102 #: build/C/man7/mdoc.samples.7:1201
16107 #: build/C/man7/mdoc.samples.7:1201
16109 msgid "Li \\&.Ic do while {...}"
16112 #. type: Plain text
16113 #: build/C/man7/mdoc.samples.7:1203
16114 msgid "E<.Ic do while {...}>"
16118 #: build/C/man7/mdoc.samples.7:1203
16120 msgid "Li \\&.Ic setenv\\ , unsetenv"
16123 #. type: Plain text
16124 #: build/C/man7/mdoc.samples.7:1205
16125 msgid "E<.Ic setenv , unsetenv>"
16128 #. type: Plain text
16129 #: build/C/man7/mdoc.samples.7:1213
16131 "It is an error to call E<.Ql \\&.Ic> without arguments. The E<.Ql \\&.Ic> "
16132 "macro is parsed and is callable."
16136 #: build/C/man7/mdoc.samples.7:1213
16141 #. type: Plain text
16142 #: build/C/man7/mdoc.samples.7:1249
16144 "The E<.Ql \\&.Nm> macro is used for the document title or subject name. It "
16145 "has the peculiarity of remembering the first argument it was called with, "
16146 "which should always be the subject name of the page. When called without "
16147 "arguments, E<.Ql \\&.Nm> regurgitates this initial name for the sole purpose "
16148 "of making less work for the author. Note: a section two or three document "
16149 "function name is addressed with the E<.Ql \\&.Nm> in the E<.Sx NAME> "
16150 "section, and with E<.Ql \\&.Fn> in the E<.Sx SYNOPSIS> and remaining "
16151 "sections. For interactive commands, such as the E<.Ql while> command "
16152 "keyword in E<.Xr csh 1>, the E<.Ql \\&.Ic> macro should be used. While the "
16153 "E<.Ql \\&.Ic> is nearly identical to E<.Ql \\&.Nm>, it can not recall the "
16154 "first argument it was invoked with."
16158 #: build/C/man7/mdoc.samples.7:1250
16160 msgid "Usage: .Nm argument ... \\*(Pu"
16164 #: build/C/man7/mdoc.samples.7:1252
16166 msgid "Li \\&.Nm mdoc.sample"
16169 #. type: Plain text
16170 #: build/C/man7/mdoc.samples.7:1254
16171 msgid "E<.Nm mdoc.sample>"
16175 #: build/C/man7/mdoc.samples.7:1254
16177 msgid "Li \\&.Nm \\e-mdoc"
16180 #. type: Plain text
16181 #: build/C/man7/mdoc.samples.7:1256
16182 msgid "E<.Nm \\-mdoc>."
16186 #: build/C/man7/mdoc.samples.7:1256
16188 msgid "Li \\&.Nm foo\\ )\\ )\\ ,"
16191 #. type: Plain text
16192 #: build/C/man7/mdoc.samples.7:1258
16193 msgid "E<.Nm foo>)),"
16197 #: build/C/man7/mdoc.samples.7:1258
16202 #. type: Plain text
16203 #: build/C/man7/mdoc.samples.7:1260
16207 #. type: Plain text
16208 #: build/C/man7/mdoc.samples.7:1265
16209 msgid "The E<.Ql \\&.Nm> macro is parsed and is callable."
16213 #: build/C/man7/mdoc.samples.7:1265
16218 #. type: Plain text
16219 #: build/C/man7/mdoc.samples.7:1277
16221 "The E<.Ql \\&.Op> macro places option brackets around the any remaining "
16222 "arguments on the command line, and places any trailing punctuation outside "
16223 "the brackets. The macros E<.Ql \\&.Oc> and E<.Ql \\&.Oo> may be used across "
16224 "one or more lines."
16228 #: build/C/man7/mdoc.samples.7:1278
16230 msgid "Usage: .Op options ... \\*(Pu"
16234 #: build/C/man7/mdoc.samples.7:1280
16239 #. type: Plain text
16240 #: build/C/man7/mdoc.samples.7:1282
16245 #: build/C/man7/mdoc.samples.7:1282
16247 msgid "Li \".Op Fl k\""
16250 #. type: Plain text
16251 #: build/C/man7/mdoc.samples.7:1284
16252 msgid "E<.Op Fl k>"
16256 #: build/C/man7/mdoc.samples.7:1284
16258 msgid "Li \".Op Fl k ) .\""
16261 #. type: Plain text
16262 #: build/C/man7/mdoc.samples.7:1286
16263 msgid "E<.Op Fl k>)."
16267 #: build/C/man7/mdoc.samples.7:1286
16269 msgid "Li \".Op Fl k Ar kookfile\""
16272 #. type: Plain text
16273 #: build/C/man7/mdoc.samples.7:1288
16274 msgid "E<.Op Fl k Ar kookfile>"
16278 #: build/C/man7/mdoc.samples.7:1288
16280 msgid "Li \".Op Fl k Ar kookfile ,\""
16283 #. type: Plain text
16284 #: build/C/man7/mdoc.samples.7:1290
16285 msgid "E<.Op Fl k Ar kookfile>,"
16289 #: build/C/man7/mdoc.samples.7:1290
16291 msgid "Li \".Op Ar objfil Op Ar corfil\""
16294 #. type: Plain text
16295 #: build/C/man7/mdoc.samples.7:1292
16296 msgid "E<.Op Ar objfil Op Ar corfil>"
16300 #: build/C/man7/mdoc.samples.7:1292
16302 msgid "Li \".Op Fl c Ar objfil Op Ar corfil ,\""
16305 #. type: Plain text
16306 #: build/C/man7/mdoc.samples.7:1294
16307 msgid "E<.Op Fl c Ar objfil Op Ar corfil>,"
16311 #: build/C/man7/mdoc.samples.7:1294
16313 msgid "Li \\&.Op word1 word2"
16316 #. type: Plain text
16317 #: build/C/man7/mdoc.samples.7:1296
16318 msgid "E<.Op word1 word2>"
16321 #. type: Plain text
16322 #: build/C/man7/mdoc.samples.7:1303
16323 msgid "The E<.Ql \\&.Oc> and E<.Ql \\&.Oo> macros:"
16326 #. type: Plain text
16327 #: build/C/man7/mdoc.samples.7:1309
16331 "\\&.Op \\&Fl k \\&Ar kilobytes\n"
16332 "\\&.Op \\&Fl i \\&Ar interval\n"
16333 "\\&.Op \\&Fl c \\&Ar count\n"
16337 #. type: Plain text
16338 #: build/C/man7/mdoc.samples.7:1317
16340 "Produce: E<.Oo> E<.Op Fl k Ar kilobytes> E<.Op Fl i Ar interval> E<.Op Fl c "
16344 #. type: Plain text
16345 #: build/C/man7/mdoc.samples.7:1324
16347 "The macros E<.Ql \\&.Op>, E<.Ql \\&.Oc> and E<.Ql \\&.Oo> are parsed and are "
16352 #: build/C/man7/mdoc.samples.7:1324
16357 #. type: Plain text
16358 #: build/C/man7/mdoc.samples.7:1328
16359 msgid "The E<.Ql \\&.Pa> macro formats pathnames or filenames."
16363 #: build/C/man7/mdoc.samples.7:1329
16365 msgid "Usage: .Pa pathname \\*(Pu"
16369 #: build/C/man7/mdoc.samples.7:1331
16371 msgid "Li \\&.Pa /usr/share"
16374 #. type: Plain text
16375 #: build/C/man7/mdoc.samples.7:1333
16376 msgid "E<.Pa /usr/share>"
16380 #: build/C/man7/mdoc.samples.7:1333
16382 msgid "Li \\&.Pa /tmp/fooXXXXX\\ )\\ ."
16385 #. type: Plain text
16386 #: build/C/man7/mdoc.samples.7:1335
16387 msgid "E<.Pa /tmp/fooXXXXX>)."
16390 #. type: Plain text
16391 #: build/C/man7/mdoc.samples.7:1340
16392 msgid "The E<.Ql \\&.Pa> macro is parsed and is callable."
16396 #: build/C/man7/mdoc.samples.7:1340
16401 #. type: Plain text
16402 #: build/C/man7/mdoc.samples.7:1342
16403 msgid "Generic variable reference:"
16407 #: build/C/man7/mdoc.samples.7:1343
16409 msgid "Usage: .Va variable ... \\*(Pu"
16413 #: build/C/man7/mdoc.samples.7:1345
16415 msgid "Li \\&.Va count"
16418 #. type: Plain text
16419 #: build/C/man7/mdoc.samples.7:1347
16420 msgid "E<.Va count>"
16424 #: build/C/man7/mdoc.samples.7:1347
16426 msgid "Li \\&.Va settimer ,"
16429 #. type: Plain text
16430 #: build/C/man7/mdoc.samples.7:1349
16431 msgid "E<.Va settimer>,"
16435 #: build/C/man7/mdoc.samples.7:1349
16437 msgid "Li \\&.Va int\\ *prt\\ )\\ :"
16440 #. type: Plain text
16441 #: build/C/man7/mdoc.samples.7:1351
16442 msgid "E<.Va int\\ *prt>):"
16446 #: build/C/man7/mdoc.samples.7:1351
16448 msgid "Li \\&.Va char\\ s\\ ]\\ )\\ )\\ ,"
16451 #. type: Plain text
16452 #: build/C/man7/mdoc.samples.7:1353
16453 msgid "E<.Va char\\ s>])),"
16456 #. type: Plain text
16457 #: build/C/man7/mdoc.samples.7:1361
16459 "It is an error to call E<.Ql \\&.Va> without any arguments. The E<.Ql "
16460 "\\&.Va> macro is parsed and is callable."
16464 #: build/C/man7/mdoc.samples.7:1361
16466 msgid "Manual Page Cross References"
16469 #. type: Plain text
16470 #: build/C/man7/mdoc.samples.7:1369
16472 "The E<.Ql \\&.Xr> macro expects the first argument to be a manual page name, "
16473 "and the second argument, if it exists, to be either a section page number or "
16474 "punctuation. Any remaining arguments are assumed to be punctuation."
16478 #: build/C/man7/mdoc.samples.7:1370
16480 msgid "Usage: .Xr man_page [1,...,8] \\*(Pu"
16484 #: build/C/man7/mdoc.samples.7:1372
16486 msgid "Li \\&.Xr mdoc"
16489 #. type: Plain text
16490 #: build/C/man7/mdoc.samples.7:1374
16491 msgid "E<.Xr mdoc>"
16495 #: build/C/man7/mdoc.samples.7:1374
16497 msgid "Li \\&.Xr mdoc\\ ,"
16500 #. type: Plain text
16501 #: build/C/man7/mdoc.samples.7:1376
16502 msgid "E<.Xr mdoc>,"
16506 #: build/C/man7/mdoc.samples.7:1376
16508 msgid "Li \\&.Xr mdoc 7"
16511 #. type: Plain text
16512 #: build/C/man7/mdoc.samples.7:1378
16513 msgid "E<.Xr mdoc 7>"
16517 #: build/C/man7/mdoc.samples.7:1378
16519 msgid "Li \\&.Xr mdoc 7\\ )\\ )\\ ,"
16522 #. type: Plain text
16523 #: build/C/man7/mdoc.samples.7:1380
16524 msgid "E<.Xr mdoc 7>)),"
16527 #. type: Plain text
16528 #: build/C/man7/mdoc.samples.7:1389
16530 "The E<.Ql \\&.Xr> macro is parsed and is callable. It is an error to call "
16531 "E<.Ql \\&.Xr> without any arguments."
16535 #: build/C/man7/mdoc.samples.7:1389
16537 msgid "GENERAL TEXT DOMAIN"
16541 #: build/C/man7/mdoc.samples.7:1390
16546 #. type: Plain text
16547 #: build/C/man7/mdoc.samples.7:1393
16549 msgid "Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \\*(Pu\n"
16553 #: build/C/man7/mdoc.samples.7:1395
16558 #. type: Plain text
16559 #: build/C/man7/mdoc.samples.7:1397
16564 #: build/C/man7/mdoc.samples.7:1397
16566 msgid "Li \".At v6 .\""
16569 #. type: Plain text
16570 #: build/C/man7/mdoc.samples.7:1399
16574 #. type: Plain text
16575 #: build/C/man7/mdoc.samples.7:1409
16577 "The E<.Ql \\&.At> macro is E<.Em not> parsed and E<.Em not> callable It "
16578 "accepts at most two arguments."
16582 #: build/C/man7/mdoc.samples.7:1409
16588 #: build/C/man7/mdoc.samples.7:1410
16590 msgid "Usage: .Bx [Version/release] ... \\*(Pu"
16594 #: build/C/man7/mdoc.samples.7:1412
16599 #. type: Plain text
16600 #: build/C/man7/mdoc.samples.7:1414
16605 #: build/C/man7/mdoc.samples.7:1414
16607 msgid "Li \".Bx 4.3 .\""
16610 #. type: Plain text
16611 #: build/C/man7/mdoc.samples.7:1416
16612 msgid "E<.Bx 4.3>."
16615 #. type: Plain text
16616 #: build/C/man7/mdoc.samples.7:1421
16617 msgid "The E<.Ql \\&.Bx> macro is parsed and is callable."
16621 #: build/C/man7/mdoc.samples.7:1421
16623 msgid "FreeBSD Macro"
16626 #. type: Plain text
16627 #: build/C/man7/mdoc.samples.7:1424
16629 msgid "Usage: .Fx Version.release ... \\*(Pu\n"
16633 #: build/C/man7/mdoc.samples.7:1426
16635 msgid "Li \".Fx 2.2 .\""
16638 #. type: Plain text
16639 #: build/C/man7/mdoc.samples.7:1428
16640 msgid "E<.Fx 2.2>."
16643 #. type: Plain text
16644 #: build/C/man7/mdoc.samples.7:1438
16646 "The E<.Ql \\&.Fx> macro is E<.Em not> parsed and E<.Em not> callable It "
16647 "accepts at most two arguments."
16651 #: build/C/man7/mdoc.samples.7:1438
16657 #: build/C/man7/mdoc.samples.7:1439
16659 msgid "Usage: .Ux ... \\*(Pu"
16663 #: build/C/man7/mdoc.samples.7:1441
16668 #. type: Plain text
16669 #: build/C/man7/mdoc.samples.7:1443
16673 #. type: Plain text
16674 #: build/C/man7/mdoc.samples.7:1448
16675 msgid "The E<.Ql \\&.Ux> macro is parsed and is callable."
16679 #: build/C/man7/mdoc.samples.7:1448
16681 msgid "Enclosure and Quoting Macros"
16684 #. type: Plain text
16685 #: build/C/man7/mdoc.samples.7:1470
16687 "The concept of enclosure is similar to quoting. The object being to enclose "
16688 "one or more strings between a pair of characters like quotes or "
16689 "parentheses. The terms quoting and enclosure are used interchangeably "
16690 "throughout this document. Most of the one line enclosure macros end in "
16691 "small letter E<.Ql q> to give a hint of quoting, but there are a few "
16692 "irregularities. For each enclosure macro there is also a pair of open and "
16693 "close macros which end in small letters E<.Ql o> and E<.Ql c> respectively. "
16694 "These can be used across one or more lines of text and while they have "
16695 "nesting limitations, the one line quote macros can be used inside of them."
16698 #. type: Plain text
16699 #: build/C/man7/mdoc.samples.7:1483
16702 "E<.Em \" Quote\t Close\t Open\tFunction\tResult\">\n"
16703 "\\&.Aq\t.Ac\t.Ao\tAngle Bracket Enclosure\tE<lt>stringE<gt>\n"
16704 "\\&.Bq\t.Bc\t.Bo\tBracket Enclosure\t[string]\n"
16705 "\\&.Dq\t.Dc\t.Do\tDouble Quote\t``string''\n"
16706 "\t.Ec\t.Eo\tEnclose String (in XX)\tXXstringXX\n"
16707 "\\&.Pq\t.Pc\t.Po\tParenthesis Enclosure\t(string)\n"
16708 "\\&.Ql\t\t\tQuoted Literal\t`st' or string\n"
16709 "\\&.Qq\t.Qc\t.Qo\tStraight Double Quote\t\"string\"\n"
16710 "\\&.Sq\t.Sc\t.So\tSingle Quote\t`string'\n"
16713 #. type: Plain text
16714 #: build/C/man7/mdoc.samples.7:1494
16716 "Except for the irregular macros noted below, all of the quoting macros are "
16717 "parsed and callable. All handle punctuation properly, as long as it is "
16718 "presented one character at a time and separated by spaces. The quoting "
16719 "macros examine opening and closing punctuation to determine whether it comes "
16720 "before or after the enclosing string This makes some nesting possible."
16724 #: build/C/man7/mdoc.samples.7:1495
16726 msgid "Li \\&.Ec , \\&.Eo"
16729 #. type: Plain text
16730 #: build/C/man7/mdoc.samples.7:1498
16732 "These macros expect the first argument to be the opening and closing strings "
16737 #: build/C/man7/mdoc.samples.7:1498
16742 #. type: Plain text
16743 #: build/C/man7/mdoc.samples.7:1511
16745 "The quoted literal macro behaves differently for E<.Xr troff> than E<.Xr "
16746 "nroff>. If formatted with E<.Xr nroff>, a quoted literal is always quoted. "
16747 "If formatted with troff, an item is only quoted if the width of the item is "
16748 "less than three constant width characters. This is to make short strings "
16749 "more visible where the font change to literal (constant width) is less "
16754 #: build/C/man7/mdoc.samples.7:1511
16759 #. type: Plain text
16760 #: build/C/man7/mdoc.samples.7:1513
16761 msgid "The prefix macro is not callable, but it is parsed:"
16765 #: build/C/man7/mdoc.samples.7:1514
16767 msgid "Li \".Pf ( Fa name2\""
16770 #. type: Plain text
16771 #: build/C/man7/mdoc.samples.7:1517
16772 msgid "becomes E<.Pf ( Fa name2>."
16775 #. type: Plain text
16776 #: build/C/man7/mdoc.samples.7:1522
16777 msgid "The E<.Ql \\&.Ns> (no space) macro performs the analogous suffix function."
16780 #. type: Plain text
16781 #: build/C/man7/mdoc.samples.7:1526
16782 msgid "Examples of quoting:"
16786 #: build/C/man7/mdoc.samples.7:1527
16791 #. type: Plain text
16792 #: build/C/man7/mdoc.samples.7:1529
16797 #: build/C/man7/mdoc.samples.7:1529
16799 msgid "Li \\&.Aq \\&Ar ctype.h\\ )\\ ,"
16802 #. type: Plain text
16803 #: build/C/man7/mdoc.samples.7:1531
16804 msgid "E<.Aq Ar ctype.h>),"
16808 #: build/C/man7/mdoc.samples.7:1531
16813 #. type: Plain text
16814 #: build/C/man7/mdoc.samples.7:1533
16819 #: build/C/man7/mdoc.samples.7:1533
16821 msgid "Li \\&.Bq \\&Em Greek \\&, French \\&."
16824 #. type: Plain text
16825 #: build/C/man7/mdoc.samples.7:1535
16826 msgid "E<.Bq Em Greek , French>."
16830 #: build/C/man7/mdoc.samples.7:1535
16835 #. type: Plain text
16836 #: build/C/man7/mdoc.samples.7:1537
16841 #: build/C/man7/mdoc.samples.7:1537
16843 msgid "Li \".Dq string abc .\""
16846 #. type: Plain text
16847 #: build/C/man7/mdoc.samples.7:1539
16848 msgid "E<.Dq string abc>."
16852 #: build/C/man7/mdoc.samples.7:1539
16854 msgid "Li \".Dq \\'^[A-Z]\\'\""
16857 #. type: Plain text
16858 #: build/C/man7/mdoc.samples.7:1541
16859 msgid "E<.Dq \\'^[A-Z]\\'>"
16863 #: build/C/man7/mdoc.samples.7:1541
16865 msgid "Li \"\\&.Ql man mdoc\""
16868 #. type: Plain text
16869 #: build/C/man7/mdoc.samples.7:1543
16870 msgid "E<.Ql man mdoc>"
16874 #: build/C/man7/mdoc.samples.7:1543
16879 #. type: Plain text
16880 #: build/C/man7/mdoc.samples.7:1545
16885 #: build/C/man7/mdoc.samples.7:1545
16887 msgid "Li \"\\&.Qq string ) ,\""
16890 #. type: Plain text
16891 #: build/C/man7/mdoc.samples.7:1547
16892 msgid "E<.Qq string>),"
16896 #: build/C/man7/mdoc.samples.7:1547
16898 msgid "Li \"\\&.Qq string Ns ),\""
16901 #. type: Plain text
16902 #: build/C/man7/mdoc.samples.7:1549
16903 msgid "E<.Qq string Ns ),>"
16907 #: build/C/man7/mdoc.samples.7:1549
16912 #. type: Plain text
16913 #: build/C/man7/mdoc.samples.7:1551
16918 #: build/C/man7/mdoc.samples.7:1551
16920 msgid "Li \"\\&.Sq string\""
16923 #. type: Plain text
16924 #: build/C/man7/mdoc.samples.7:1553
16925 msgid "E<.Sq string>"
16928 #. type: Plain text
16929 #: build/C/man7/mdoc.samples.7:1570
16931 "For a good example of nested enclosure macros, see the E<.Ql \\&.Op> option "
16932 "macro. It was created from the same underlying enclosure macros as those "
16933 "presented in the list above. The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> extended "
16934 "argument list macros were also built from the same underlying routines and "
16935 "are a good example of E<.Nm \\-mdoc> macro usage at its worst."
16939 #: build/C/man7/mdoc.samples.7:1570
16941 msgid "No\\-Op or Normal Text Macro"
16944 #. type: Plain text
16945 #: build/C/man7/mdoc.samples.7:1578
16947 "The macro E<.Ql \\&.No> is a hack for words in a macro command line which "
16948 "should E<.Em not> be formatted and follows the conventional syntax for "
16953 #: build/C/man7/mdoc.samples.7:1578
16955 msgid "No Space Macro"
16958 #. type: Plain text
16959 #: build/C/man7/mdoc.samples.7:1584
16961 "The E<.Ql \\&.Ns> macro eliminates unwanted spaces in between macro "
16962 "requests. It is useful for old style argument lists where there is no space "
16963 "between the flag and argument:"
16967 #: build/C/man7/mdoc.samples.7:1585
16969 msgid "Li \".Op Fl I Ns Ar directory\""
16972 #. type: Plain text
16973 #: build/C/man7/mdoc.samples.7:1588
16974 msgid "produces E<.Op Fl I Ns Ar directory>"
16977 #. type: Plain text
16978 #: build/C/man7/mdoc.samples.7:1599
16980 "Note: the E<.Ql \\&.Ns> macro always invokes the E<.Ql \\&.No> macro after "
16981 "eliminating the space unless another macro name follows it. The macro E<.Ql "
16982 "\\&.Ns> is parsed and is callable."
16986 #: build/C/man7/mdoc.samples.7:1599
16988 msgid "Section Cross References"
16991 #. type: Plain text
16992 #: build/C/man7/mdoc.samples.7:1605
16994 "The E<.Ql \\&.Sx> macro designates a reference to a section header within "
16995 "the same document. It is parsed and is callable."
16999 #: build/C/man7/mdoc.samples.7:1607
17001 msgid "Li \\&.Sx FILES"
17004 #. type: Plain text
17005 #: build/C/man7/mdoc.samples.7:1609
17006 msgid "E<.Sx FILES>"
17010 #: build/C/man7/mdoc.samples.7:1610
17012 msgid "References and Citations"
17015 #. type: Plain text
17016 #: build/C/man7/mdoc.samples.7:1614
17018 "The following macros make a modest attempt to handle references. At best, "
17019 "the macros make it convenient to manually drop in a subset of refer style "
17024 #: build/C/man7/mdoc.samples.7:1616
17029 #. type: Plain text
17030 #: build/C/man7/mdoc.samples.7:1621
17032 "Reference Start. Causes a line break and begins collection of reference "
17033 "information until the reference end macro is read."
17037 #: build/C/man7/mdoc.samples.7:1621
17042 #. type: Plain text
17043 #: build/C/man7/mdoc.samples.7:1624
17044 msgid "Reference End. The reference is printed."
17048 #: build/C/man7/mdoc.samples.7:1624
17053 #. type: Plain text
17054 #: build/C/man7/mdoc.samples.7:1626
17055 msgid "Reference author name, one name per invocation."
17059 #: build/C/man7/mdoc.samples.7:1626
17064 #. type: Plain text
17065 #: build/C/man7/mdoc.samples.7:1628
17066 msgid "Book title."
17070 #: build/C/man7/mdoc.samples.7:1628
17075 #. type: Plain text
17076 #: build/C/man7/mdoc.samples.7:1630
17077 msgid "City/place."
17081 #: build/C/man7/mdoc.samples.7:1630
17086 #. type: Plain text
17087 #: build/C/man7/mdoc.samples.7:1632
17092 #: build/C/man7/mdoc.samples.7:1632
17097 #. type: Plain text
17098 #: build/C/man7/mdoc.samples.7:1634
17099 msgid "Journal name."
17103 #: build/C/man7/mdoc.samples.7:1634
17108 #. type: Plain text
17109 #: build/C/man7/mdoc.samples.7:1636
17110 msgid "Issue number."
17114 #: build/C/man7/mdoc.samples.7:1636
17119 #. type: Plain text
17120 #: build/C/man7/mdoc.samples.7:1638
17121 msgid "Optional information."
17125 #: build/C/man7/mdoc.samples.7:1638
17130 #. type: Plain text
17131 #: build/C/man7/mdoc.samples.7:1640
17132 msgid "Page number."
17136 #: build/C/man7/mdoc.samples.7:1640
17141 #. type: Plain text
17142 #: build/C/man7/mdoc.samples.7:1642
17143 msgid "Report name."
17147 #: build/C/man7/mdoc.samples.7:1642
17152 #. type: Plain text
17153 #: build/C/man7/mdoc.samples.7:1644
17154 msgid "Title of article."
17158 #: build/C/man7/mdoc.samples.7:1644
17163 #. type: Plain text
17164 #: build/C/man7/mdoc.samples.7:1646
17168 #. type: Plain text
17169 #: build/C/man7/mdoc.samples.7:1657
17171 "The macros beginning with E<.Ql %> are not callable, and are parsed only for "
17172 "the trade name macro which returns to its caller. (And not very predictably "
17173 "at the moment either.) The purpose is to allow trade names to be pretty "
17174 "printed in E<.Xr troff Ns / Ns Xr ditroff> output."
17178 #: build/C/man7/mdoc.samples.7:1657
17180 msgid "Return Values"
17183 #. type: Plain text
17184 #: build/C/man7/mdoc.samples.7:1663
17186 "The E<.Ql \\&.Rv> macro generates text for use in the E<.Sx RETURN VALUE> "
17191 #: build/C/man7/mdoc.samples.7:1664
17193 msgid "Usage: .Rv [-std function]"
17196 #. type: Plain text
17197 #: build/C/man7/mdoc.samples.7:1668
17198 msgid "E<.Ql \\&.Rv -std atexit> will generate the following text:"
17201 #. fake section 3 to avoid error message from Rv
17203 #. type: ds section
17204 #: build/C/man7/mdoc.samples.7:1671
17209 #. and back to 7 again
17211 #. type: Plain text
17212 #: build/C/man7/mdoc.samples.7:1675
17213 msgid "E<.Rv -std atexit>"
17216 #. type: ds section
17217 #: build/C/man7/mdoc.samples.7:1675
17222 #. type: Plain text
17223 #: build/C/man7/mdoc.samples.7:1680
17224 msgid "The E<.Fl std> option is valid only for manual page sections 2 and 3."
17228 #: build/C/man7/mdoc.samples.7:1680
17230 msgid "Trade Names (or Acronyms and Type Names)"
17233 #. type: Plain text
17234 #: build/C/man7/mdoc.samples.7:1683
17236 "The trade name macro is generally a small caps macro for all upper case "
17237 "words longer than two characters."
17241 #: build/C/man7/mdoc.samples.7:1684
17243 msgid "Usage: .Tn symbol ... \\*(Pu"
17247 #: build/C/man7/mdoc.samples.7:1686
17249 msgid "Li \\&.Tn DEC"
17252 #. type: Plain text
17253 #: build/C/man7/mdoc.samples.7:1688
17258 #: build/C/man7/mdoc.samples.7:1688
17260 msgid "Li \\&.Tn ASCII"
17263 #. type: Plain text
17264 #: build/C/man7/mdoc.samples.7:1690
17265 msgid "E<.Tn ASCII>"
17268 #. type: Plain text
17269 #: build/C/man7/mdoc.samples.7:1696
17270 msgid "The E<.Ql \\&.Tn> macro is parsed and is callable by other macros."
17274 #: build/C/man7/mdoc.samples.7:1696
17276 msgid "Extended Arguments"
17279 #. type: Plain text
17280 #: build/C/man7/mdoc.samples.7:1708
17282 "The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> macros allow one to extend an argument "
17283 "list on a macro boundary. Argument lists cannot be extended within a macro "
17284 "which expects all of its arguments on one line such as E<.Ql \\&.Op>."
17287 #. type: Plain text
17288 #: build/C/man7/mdoc.samples.7:1712
17290 "Here is an example of E<.Ql \\&.Xo> using the space mode macro to turn "
17294 #. type: Plain text
17295 #: build/C/man7/mdoc.samples.7:1718
17299 "\\&.It Xo Sy I Ar operation\n"
17300 "\\&.No \\een Ar count No \\een\n"
17305 #. type: Plain text
17306 #: build/C/man7/mdoc.samples.7:1721 build/C/man7/mdoc.samples.7:1742 build/C/man7/mdoc.samples.7:1766
17310 #. type: Plain text
17311 #: build/C/man7/mdoc.samples.7:1724 build/C/man7/mdoc.samples.7:1745
17313 msgid "E<.Sm off>\n"
17317 #: build/C/man7/mdoc.samples.7:1724
17319 msgid "Xo Sy I Ar operation"
17322 #. type: Plain text
17323 #: build/C/man7/mdoc.samples.7:1728
17326 "E<.No \\en Ar count No \\en>\n"
17331 #. type: Plain text
17332 #: build/C/man7/mdoc.samples.7:1732
17333 msgid "Another one:"
17336 #. type: Plain text
17337 #: build/C/man7/mdoc.samples.7:1739
17341 "\\&.It Cm S No \\&/ Ar old_pattern Xo\n"
17342 "\\&.No \\&/ Ar new_pattern\n"
17343 "\\&.No \\&/ Op Cm g\n"
17349 #: build/C/man7/mdoc.samples.7:1745
17351 msgid "Cm S No \\&/ Ar old_pattern Xo"
17354 #. type: Plain text
17355 #: build/C/man7/mdoc.samples.7:1750
17358 "E<.No \\&/ Ar new_pattern>\n"
17359 "E<.No \\&/ Op Cm g>\n"
17364 #. type: Plain text
17365 #: build/C/man7/mdoc.samples.7:1757
17367 "Another example of E<.Ql \\&.Xo> and using enclosure macros: Test the value "
17371 #. type: Plain text
17372 #: build/C/man7/mdoc.samples.7:1763
17377 "\\&.Oo \\e&! Oc Ns Ar variable\n"
17378 "\\&.Op Ar operator variable ...\n"
17383 #: build/C/man7/mdoc.samples.7:1768
17388 #. type: Plain text
17389 #: build/C/man7/mdoc.samples.7:1773
17393 "E<.Oo \\&! Oc Ns Ar variable>\n"
17394 "E<.Op Ar operator variable ...>\n"
17398 #. type: Plain text
17399 #: build/C/man7/mdoc.samples.7:1811
17401 "All of the above examples have used the E<.Ql \\&.Xo> macro on the argument "
17402 "list of the E<.Ql \\&.It> (list-item) macro. The extend macros are not "
17403 "used very often, and when they are it is usually to extend the list-item "
17404 "argument list. Unfortunately, this is also where the extend macros are the "
17405 "most finicky. In the first two examples, spacing was turned off; in the "
17406 "third, spacing was desired in part of the output but not all of it. To make "
17407 "these macros work in this situation make sure the E<.Ql \\&.Xo> and E<.Ql "
17408 "\\&.Xc> macros are placed as shown in the third example. If the E<.Ql "
17409 "\\&.Xo> macro is not alone on the E<.Ql \\&.It> argument list, spacing will "
17410 "be unpredictable. The E<.Ql \\&.Ns> (no space macro) must not occur as the "
17411 "first or last macro on a line in this situation. Out of 900 manual pages "
17412 "(about 1500 actual pages) currently released with E<.Bx> only fifteen use "
17413 "the E<.Ql \\&.Xo> macro."
17417 #: build/C/man7/mdoc.samples.7:1812
17419 msgid "Section Headers"
17422 #. type: Plain text
17423 #: build/C/man7/mdoc.samples.7:1825
17425 "The first three E<.Ql \\&.Sh> section header macros list below are required "
17426 "in every man page. The remaining section headers are recommended at the "
17427 "discretion of the author writing the manual page. The E<.Ql \\&.Sh> macro "
17428 "can take up to nine arguments. It is parsed and but is not callable."
17432 #: build/C/man7/mdoc.samples.7:1826
17434 msgid "\\&.Sh NAME"
17437 #. type: Plain text
17438 #: build/C/man7/mdoc.samples.7:1846
17440 "The E<.Ql \\&.Sh NAME> macro is mandatory. If not specified, the headers, "
17441 "footers and page layout defaults will not be set and things will be rather "
17442 "unpleasant. The E<.Sx NAME> section consists of at least three items. The "
17443 "first is the E<.Ql \\&.Nm> name macro naming the subject of the man page. "
17444 "The second is the Name Description macro, E<.Ql \\&.Nd>, which separates the "
17445 "subject name from the third item, which is the description. The description "
17446 "should be the most terse and lucid possible, as the space available is "
17451 #: build/C/man7/mdoc.samples.7:1846
17453 msgid "\\&.Sh SYNOPSIS"
17456 #. type: Plain text
17457 #: build/C/man7/mdoc.samples.7:1878
17459 "The E<.Sx SYNOPSIS> section describes the typical usage of the subject of a "
17460 "man page. The macros required are either E<.Ql \".Nm\">, E<.Ql \".Cd\">, "
17461 "E<.Ql \".Fn\">, (and possibly E<.Ql \".Fo\">, E<.Ql \".Fc\">, E<.Ql "
17462 "\".Fd\">, E<.Ql \".Ft\"> macros). The function name macro E<.Ql \".Fn\"> is "
17463 "required for manual page sections 2 and 3, the command and general name "
17464 "macro E<.Ql \\&.Nm> is required for sections 1, 5, 6, 7, 8. Section 4 "
17465 "manuals require a E<.Ql \".Nm\">, E<.Ql \".Fd\"> or a E<.Ql \".Cd\"> "
17466 "configuration device usage macro. Several other macros may be necessary to "
17467 "produce the synopsis line as shown below:"
17470 #. type: Plain text
17471 #: build/C/man7/mdoc.samples.7:1885
17475 "E<.Op Fl benstuv>\n"
17480 #. type: Plain text
17481 #: build/C/man7/mdoc.samples.7:1888
17482 msgid "The following macros were used:"
17486 #: build/C/man7/mdoc.samples.7:1889
17492 #: build/C/man7/mdoc.samples.7:1890
17494 msgid "\\&.Op \\&Fl benstuv"
17498 #: build/C/man7/mdoc.samples.7:1891
17500 msgid "\\&.Op \\&Fl"
17504 #: build/C/man7/mdoc.samples.7:1892
17509 #. type: Plain text
17510 #: build/C/man7/mdoc.samples.7:1903
17512 "E<.Sy Note>: The macros E<.Ql \\&.Op>, E<.Ql \\&.Fl>, and E<.Ql \\&.Ar> "
17513 "recognize the pipe bar character E<.Ql \\*(Ba>, so a command line such as:"
17517 #: build/C/man7/mdoc.samples.7:1904
17519 msgid ".Op Fl a | Fl b"
17522 #. type: Plain text
17523 #: build/C/man7/mdoc.samples.7:1913
17525 "will not go orbital. E<.Xr Troff> normally interprets a \\*(Ba as a special "
17526 "operator. See E<.Sx PREDEFINED STRINGS> for a usable \\*(Ba character in "
17527 "other situations."
17531 #: build/C/man7/mdoc.samples.7:1914
17533 msgid "\\&.Sh DESCRIPTION"
17536 #. type: Plain text
17537 #: build/C/man7/mdoc.samples.7:1931
17539 "In most cases the first text in the E<.Sx DESCRIPTION> section is a brief "
17540 "paragraph on the command, function or file, followed by a lexical list of "
17541 "options and respective explanations. To create such a list, the E<.Ql "
17542 "\\&.Bl> begin-list, E<.Ql \\&.It> list-item and E<.Ql \\&.El> end-list "
17543 "macros are used (see E<.Sx Lists and Columns> below)."
17546 #. type: Plain text
17547 #: build/C/man7/mdoc.samples.7:1940
17549 "The following E<.Ql \\&.Sh> section headers are part of the preferred manual "
17550 "page layout and must be used appropriately to maintain consistency. They "
17551 "are listed in the order in which they would be used."
17555 #: build/C/man7/mdoc.samples.7:1941
17557 msgid "\\&.Sh ENVIRONMENT"
17560 #. type: Plain text
17561 #: build/C/man7/mdoc.samples.7:1947
17563 "The E<.Sx ENVIRONMENT> section should reveal any related environment "
17564 "variables and clues to their behavior and/or usage."
17568 #: build/C/man7/mdoc.samples.7:1947
17570 msgid "\\&.Sh EXAMPLES"
17573 #. type: Plain text
17574 #: build/C/man7/mdoc.samples.7:1954
17576 "There are several ways to create examples. See the E<.Sx EXAMPLES> section "
17577 "below for details."
17581 #: build/C/man7/mdoc.samples.7:1954
17583 msgid "\\&.Sh FILES"
17586 #. type: Plain text
17587 #: build/C/man7/mdoc.samples.7:1961
17589 "Files which are used or created by the man page subject should be listed via "
17590 "the E<.Ql \\&.Pa> macro in the E<.Sx FILES> section."
17594 #: build/C/man7/mdoc.samples.7:1961
17596 msgid "\\&.Sh SEE ALSO"
17599 #. type: Plain text
17600 #: build/C/man7/mdoc.samples.7:1975
17602 "References to other material on the man page topic and cross references to "
17603 "other relevant man pages should be placed in the E<.Sx SEE ALSO> section. "
17604 "Cross references are specified using the E<.Ql \\&.Xr> macro. Cross "
17605 "references in the E<.Sx SEE ALSO> section should be sorted by section "
17606 "number, and then placed in alphabetical order and comma separated. For "
17610 #. type: Plain text
17611 #: build/C/man7/mdoc.samples.7:1980
17612 msgid "E<.Xr ls 1>, E<.Xr ps 1>, E<.Xr group 5>, E<.Xr passwd 5>."
17615 #. type: Plain text
17616 #: build/C/man7/mdoc.samples.7:1984
17617 msgid "At this time E<.Xr refer 1> style references are not accommodated."
17621 #: build/C/man7/mdoc.samples.7:1984
17623 msgid "\\&.Sh CONFORMING TO"
17626 #. type: Plain text
17627 #: build/C/man7/mdoc.samples.7:1996
17629 "If the command, library function or file adheres to a specific "
17630 "implementation such as E<.St -p1003.2> or E<.St -ansiC> this should be noted "
17631 "here. If the command does not adhere to any standard, its history should be "
17632 "noted in the E<.Sx HISTORY> section."
17636 #: build/C/man7/mdoc.samples.7:1996
17638 msgid "\\&.Sh HISTORY"
17641 #. type: Plain text
17642 #: build/C/man7/mdoc.samples.7:1999
17644 "Any command which does not adhere to any specific standards should be "
17645 "outlined historically in this section."
17649 #: build/C/man7/mdoc.samples.7:1999
17651 msgid "\\&.Sh AUTHORS"
17654 #. type: Plain text
17655 #: build/C/man7/mdoc.samples.7:2001
17656 msgid "Credits, if need be, should be placed here."
17660 #: build/C/man7/mdoc.samples.7:2001
17662 msgid "\\&.Sh DIAGNOSTICS"
17665 #. type: Plain text
17666 #: build/C/man7/mdoc.samples.7:2003
17667 msgid "Diagnostics from a command should be placed in this section."
17671 #: build/C/man7/mdoc.samples.7:2003
17673 msgid "\\&.Sh ERRORS"
17676 #. type: Plain text
17677 #: build/C/man7/mdoc.samples.7:2009
17679 "Specific error handling, especially from library functions (man page "
17680 "sections 2 and 3) should go here. The E<.Ql \\&.Er> macro is used to "
17681 "specify an errno."
17685 #: build/C/man7/mdoc.samples.7:2009
17687 msgid "\\&.Sh BUGS"
17690 #. type: Plain text
17691 #: build/C/man7/mdoc.samples.7:2011
17692 msgid "Blatant problems with the topic go here..."
17695 #. type: Plain text
17696 #: build/C/man7/mdoc.samples.7:2017
17698 "User specified E<.Ql \\&.Sh> sections may be added, for example, this "
17699 "section was set with:"
17702 #. type: Plain text
17703 #: build/C/man7/mdoc.samples.7:2019
17705 msgid "\\&.Sh PAGE STRUCTURE DOMAIN\n"
17709 #: build/C/man7/mdoc.samples.7:2020
17711 msgid "Paragraphs and Line Spacing."
17715 #: build/C/man7/mdoc.samples.7:2022
17720 #. type: Plain text
17721 #: build/C/man7/mdoc.samples.7:2038
17723 "The E<.Ql \\&.Pp> paragraph command may be used to specify a line space "
17724 "where necessary. The macro is not necessary after a E<.Ql \\&.Sh> or E<.Ql "
17725 "\\&.Ss> macro or before a E<.Ql \\&.Bl> macro. (The E<.Ql \\&.Bl> macro "
17726 "asserts a vertical distance unless the -compact flag is given)."
17729 #. This worked with version one, need to redo for version three
17732 #. .Cw (ax+bx+c) \ is\ produced\ by\ \&
17733 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
17750 #. .Em is produced by
17766 #. This example shows the same equation in a different format.
17770 #. signs were forced with
17774 #. .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
17775 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
17786 #. .Li \&.Cx \e\ +\e\ \e&
17797 #. .Em is produced by
17805 #. .Li \&.Cx \e\ +\e\ \e&
17816 #. The incantation below was
17822 #. .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
17824 #. .Li \&.Cx Op Sy ?/
17834 #. .Em is produced by
17836 #. .Li \&.Ar \e\ b1 e1 f1
17848 #: build/C/man7/mdoc.samples.7:2157
17853 #. type: Plain text
17854 #: build/C/man7/mdoc.samples.7:2186
17856 "The only keep that is implemented at this time is for words. The macros are "
17857 "E<.Ql \\&.Bk> (begin-keep) and E<.Ql \\&.Ek> (end-keep). The only option "
17858 "that E<.Ql \\&.Bk> accepts is E<.Fl words> and is useful for preventing line "
17859 "breaks in the middle of options. In the example for the make command-line "
17860 "arguments (see E<.Sx What's in a name>), the keep prevented E<.Xr nroff> "
17861 "from placing up the flag and the argument on separate lines. (Actually, the "
17862 "option macro used to prevent this from occurring, but was dropped when the "
17863 "decision (religious) was made to force right justified margins in E<.Xr "
17864 "troff> as options in general look atrocious when spread across a sparse "
17865 "line. More work needs to be done with the keep macros, a E<.Fl line> option "
17866 "needs to be added.)"
17870 #: build/C/man7/mdoc.samples.7:2186
17872 msgid "Examples and Displays"
17875 #. type: Plain text
17876 #: build/C/man7/mdoc.samples.7:2198
17878 "There are five types of displays, a quickie one line indented display E<.Ql "
17879 "\\&.D1>, a quickie one line literal display E<.Ql \\&.Dl>, and a block "
17880 "literal, block filled and block ragged which use the E<.Ql \\&.Bd> "
17881 "begin-display and E<.Ql \\&.Ed> end-display macros."
17884 #. type: Plain text
17885 #: build/C/man7/mdoc.samples.7:2203
17887 "(D-one) Display one line of indented text. This macro is parsed, but it is "
17892 #: build/C/man7/mdoc.samples.7:2204
17894 msgid "Fl ldghfstru"
17897 #. type: Plain text
17898 #: build/C/man7/mdoc.samples.7:2208
17899 msgid "The above was produced by: E<.Li \\&.Dl Fl ldghfstru>."
17902 #. type: Plain text
17903 #: build/C/man7/mdoc.samples.7:2223
17905 "(D-ell) Display one line of indented E<.Em literal> text. The E<.Ql "
17906 "\\&.Dl> example macro has been used throughout this file. It allows the "
17907 "indent (display) of one line of text. Its default font is set to constant "
17908 "width (literal) however it is parsed and will recognized other macros. It "
17909 "is not callable however."
17913 #: build/C/man7/mdoc.samples.7:2224
17915 msgid "% ls -ldg /usr/local/bin"
17918 #. type: Plain text
17919 #: build/C/man7/mdoc.samples.7:2228
17920 msgid "The above was produced by E<.Li \\&.Dl % ls -ldg /usr/local/bin>."
17923 #. type: Plain text
17924 #: build/C/man7/mdoc.samples.7:2239
17926 "Begin-display. The E<.Ql \\&.Bd> display must be ended with the E<.Ql "
17927 "\\&.Ed> macro. Displays may be nested within displays and lists. E<.Ql "
17928 "\\&.Bd> has the following syntax:"
17932 #: build/C/man7/mdoc.samples.7:2240
17934 msgid ".Bd display-type [-offset offset_value] [-compact]"
17937 #. type: Plain text
17938 #: build/C/man7/mdoc.samples.7:2245
17940 "The display-type must be one of the following four types and may have an "
17941 "offset specifier for indentation: E<.Ql \\&.Bd>."
17944 #. type: Plain text
17945 #: build/C/man7/mdoc.samples.7:2251
17947 "Display a block of text as typed, right (and left) margin edges are left "
17951 #. type: Plain text
17952 #: build/C/man7/mdoc.samples.7:2255
17954 "Display a filled (formatted) block. The block of text is formatted (the "
17955 "edges are filled \\- not left unjustified)."
17958 #. type: Plain text
17959 #: build/C/man7/mdoc.samples.7:2258
17961 "Display a literal block, useful for source code or simple tabbed or spaced "
17966 #: build/C/man7/mdoc.samples.7:2258
17968 msgid "Fl file Ar file_name"
17971 #. type: Plain text
17972 #: build/C/man7/mdoc.samples.7:2267
17974 "The filename following the E<.Fl file> flag is read and displayed. Literal "
17975 "mode is asserted and tabs are set at 8 constant width character intervals, "
17976 "however any E<.Xr troff/ Ns Nm \\-mdoc> commands in file will be processed."
17979 #. type: Plain text
17980 #: build/C/man7/mdoc.samples.7:2273
17982 "If E<.Fl offset> is specified with one of the following strings, the string "
17983 "is interpreted to indicate the level of indentation for the forthcoming "
17987 #. type: Plain text
17988 #: build/C/man7/mdoc.samples.7:2279
17990 "Align block on the current left margin, this is the default mode of E<.Ql "
17994 #. type: Plain text
17995 #: build/C/man7/mdoc.samples.7:2284
17997 "Supposedly center the block. At this time unfortunately, the block merely "
17998 "gets left aligned about an imaginary center margin."
18001 #. type: Plain text
18002 #: build/C/man7/mdoc.samples.7:2293
18004 "Indents by one default indent value or tab. The default indent value is "
18005 "also used for the E<.Ql \\&.D1> display so one is guaranteed the two types "
18006 "of displays will line up. This indent is normally set to 6n or about two "
18007 "thirds of an inch (six constant width characters)."
18010 #. type: Plain text
18011 #: build/C/man7/mdoc.samples.7:2295
18012 msgid "Indents two times the default indent value."
18015 #. type: Plain text
18016 #: build/C/man7/mdoc.samples.7:2303
18018 "This E<.Em left> aligns the block about two inches from the right side of "
18019 "the page. This macro needs work and perhaps may never do the right thing by "
18024 #: build/C/man7/mdoc.samples.7:2304
18029 #. type: Plain text
18030 #: build/C/man7/mdoc.samples.7:2306
18031 msgid "End-display."
18035 #: build/C/man7/mdoc.samples.7:2307
18040 #. type: Plain text
18041 #: build/C/man7/mdoc.samples.7:2309
18042 msgid "There are five macros for changing the appearance of the manual page text:"
18046 #: build/C/man7/mdoc.samples.7:2310
18051 #. type: Plain text
18052 #: build/C/man7/mdoc.samples.7:2315
18054 "Text may be stressed or emphasized with the E<.Ql \\&.Em> macro. The usual "
18055 "font for emphasis is italic."
18059 #: build/C/man7/mdoc.samples.7:2316
18061 msgid "Usage: .Em argument ... \\*(Pu"
18065 #: build/C/man7/mdoc.samples.7:2318
18067 msgid "Li \".Em does not\""
18070 #. type: Plain text
18071 #: build/C/man7/mdoc.samples.7:2320
18072 msgid "E<.Em does not>"
18076 #: build/C/man7/mdoc.samples.7:2320
18078 msgid "Li \".Em exceed 1024 .\""
18081 #. type: Plain text
18082 #: build/C/man7/mdoc.samples.7:2322
18083 msgid "E<.Em exceed 1024>."
18087 #: build/C/man7/mdoc.samples.7:2322
18089 msgid "Li \".Em vide infra ) ) ,\""
18092 #. type: Plain text
18093 #: build/C/man7/mdoc.samples.7:2324
18094 msgid "E<.Em vide infra>)),"
18097 #. type: Plain text
18098 #: build/C/man7/mdoc.samples.7:2332
18100 "The E<.Ql \\&.Em> macro is parsed and is callable. It is an error to call "
18101 "E<.Ql \\&.Em> without arguments."
18105 #: build/C/man7/mdoc.samples.7:2332
18110 #. type: Plain text
18111 #: build/C/man7/mdoc.samples.7:2338
18113 "The E<.Ql \\&.Li> literal macro may be used for special characters, variable "
18114 "constants, anything which should be displayed as it would be typed."
18118 #: build/C/man7/mdoc.samples.7:2339
18120 msgid "Usage: .Li argument ... \\*(Pu"
18124 #: build/C/man7/mdoc.samples.7:2341
18126 msgid "Li \\&.Li \\een"
18129 #. type: Plain text
18130 #: build/C/man7/mdoc.samples.7:2343
18131 msgid "E<.Li \\en>"
18135 #: build/C/man7/mdoc.samples.7:2343
18137 msgid "Li \\&.Li M1 M2 M3\\ ;"
18140 #. type: Plain text
18141 #: build/C/man7/mdoc.samples.7:2345
18142 msgid "E<.Li M1 M2 M3>;"
18146 #: build/C/man7/mdoc.samples.7:2345
18148 msgid "Li \\&.Li cntrl-D\\ )\\ ,"
18151 #. type: Plain text
18152 #: build/C/man7/mdoc.samples.7:2347
18153 msgid "E<.Li cntrl-D>),"
18157 #: build/C/man7/mdoc.samples.7:2347
18159 msgid "Li \\&.Li 1024\\ ..."
18162 #. type: Plain text
18163 #: build/C/man7/mdoc.samples.7:2349
18164 msgid "E<.Li 1024 ...>"
18167 #. type: Plain text
18168 #: build/C/man7/mdoc.samples.7:2354
18169 msgid "The E<.Ql \\&.Li> macro is parsed and is callable."
18173 #: build/C/man7/mdoc.samples.7:2354
18178 #. type: Plain text
18179 #: build/C/man7/mdoc.samples.7:2357
18181 "The symbolic emphasis macro is generally a boldface macro in either the "
18182 "symbolic sense or the traditional English usage."
18186 #: build/C/man7/mdoc.samples.7:2358
18188 msgid "Usage: .Sy symbol ... \\*(Pu"
18192 #: build/C/man7/mdoc.samples.7:2360
18194 msgid "Li \\&.Sy Important Notice"
18197 #. type: Plain text
18198 #: build/C/man7/mdoc.samples.7:2362
18199 msgid "E<.Sy Important Notice>"
18202 #. type: Plain text
18203 #: build/C/man7/mdoc.samples.7:2369
18205 "The E<.Ql \\&.Sy> macro is parsed and is callable. Arguments to E<.Ql "
18206 "\\&.Sy> may be quoted."
18210 #: build/C/man7/mdoc.samples.7:2370
18215 #. type: Plain text
18216 #: build/C/man7/mdoc.samples.7:2380
18218 "Begin font mode. The E<.Ql \\&.Bf> font mode must be ended with the E<.Ql "
18219 "\\&.Ef> macro. Font modes may be nested within other font modes. E<.Ql "
18220 "\\&.Bf> has the following syntax:"
18224 #: build/C/man7/mdoc.samples.7:2381
18226 msgid ".Bf font-mode"
18229 #. type: Plain text
18230 #: build/C/man7/mdoc.samples.7:2385
18231 msgid "The font-mode must be one of the following three types: E<.Ql \\&.Bf>."
18235 #: build/C/man7/mdoc.samples.7:2387
18237 msgid "Sy \\&Em | Fl emphasis"
18240 #. type: Plain text
18241 #: build/C/man7/mdoc.samples.7:2391
18242 msgid "Same as if the E<.Ql \\&.Em> macro was used for the entire block of text."
18246 #: build/C/man7/mdoc.samples.7:2391
18248 msgid "Sy \\&Li | Fl literal"
18251 #. type: Plain text
18252 #: build/C/man7/mdoc.samples.7:2395
18253 msgid "Same as if the E<.Ql \\&.Li> macro was used for the entire block of text."
18257 #: build/C/man7/mdoc.samples.7:2395
18259 msgid "Sy \\&Sy | Fl symbolic"
18262 #. type: Plain text
18263 #: build/C/man7/mdoc.samples.7:2399
18264 msgid "Same as if the E<.Ql \\&.Sy> macro was used for the entire block of text."
18268 #: build/C/man7/mdoc.samples.7:2400
18273 #. type: Plain text
18274 #: build/C/man7/mdoc.samples.7:2402
18275 msgid "End font mode."
18279 #: build/C/man7/mdoc.samples.7:2403
18281 msgid "Tagged Lists and Columns"
18284 #. type: Plain text
18285 #: build/C/man7/mdoc.samples.7:2417
18287 "There are several types of lists which may be initiated with the E<.Ql "
18288 "\".Bl\"> begin-list macro. Items within the list are specified with the "
18289 "E<.Ql \".It\"> item macro and each list must end with the E<.Ql \".El\"> "
18290 "macro. Lists may be nested within themselves and within displays. Columns "
18291 "may be used inside of lists, but lists are unproven inside of columns."
18294 #. type: Plain text
18295 #: build/C/man7/mdoc.samples.7:2432
18297 "In addition, several list attributes may be specified such as the width of a "
18298 "tag, the list offset, and compactness (blank lines between items allowed or "
18299 "disallowed). Most of this document has been formatted with a tag style list "
18300 "E<.Pq Fl tag>. For a change of pace, the list-type used to present the "
18301 "list-types is an over-hanging list E<.Pq Fl ohang>. This type of list is "
18302 "quite popular with E<.Tn TeX> users, but might look a bit funny after having "
18303 "read many pages of tagged lists. The following list types are accepted by "
18308 #: build/C/man7/mdoc.samples.7:2434
18314 #: build/C/man7/mdoc.samples.7:2435
18320 #: build/C/man7/mdoc.samples.7:2436
18325 #. type: Plain text
18326 #: build/C/man7/mdoc.samples.7:2446
18328 "These three are the simplest types of lists. Once the E<.Ql \".Bl\"> macro "
18329 "has been given, items in the list are merely indicated by a line consisting "
18330 "solely of the E<.Ql \".It\"> macro. For example, the source text for a "
18331 "simple enumerated list would look like:"
18334 #. type: Plain text
18335 #: build/C/man7/mdoc.samples.7:2455
18338 "\\&.Bl -enum -compact\n"
18340 "\\&Item one goes here.\n"
18342 "\\&And item two here.\n"
18344 "\\&Lastly item three goes here.\n"
18348 #. type: Plain text
18349 #: build/C/man7/mdoc.samples.7:2459
18350 msgid "The results:"
18353 #. type: Plain text
18354 #: build/C/man7/mdoc.samples.7:2463
18355 msgid "Item one goes here."
18358 #. type: Plain text
18359 #: build/C/man7/mdoc.samples.7:2465
18360 msgid "And item two here."
18363 #. type: Plain text
18364 #: build/C/man7/mdoc.samples.7:2467
18365 msgid "Lastly item three goes here."
18368 #. type: Plain text
18369 #: build/C/man7/mdoc.samples.7:2470
18370 msgid "A simple bullet list construction:"
18373 #. type: Plain text
18374 #: build/C/man7/mdoc.samples.7:2477
18377 "\\&.Bl -bullet -compact\n"
18379 "\\&Bullet one goes here.\n"
18381 "\\&Bullet two here.\n"
18385 #. type: Plain text
18386 #: build/C/man7/mdoc.samples.7:2483
18387 msgid "Bullet one goes here."
18390 #. type: Plain text
18391 #: build/C/man7/mdoc.samples.7:2485
18392 msgid "Bullet two here."
18396 #: build/C/man7/mdoc.samples.7:2488
18402 #: build/C/man7/mdoc.samples.7:2489
18408 #: build/C/man7/mdoc.samples.7:2490
18414 #: build/C/man7/mdoc.samples.7:2491
18420 #: build/C/man7/mdoc.samples.7:2492
18425 #. type: Plain text
18426 #: build/C/man7/mdoc.samples.7:2512
18428 "These list-types collect arguments specified with the E<.Ql \\&.It> macro "
18429 "and create a label which may be E<.Em inset> into the forthcoming text, "
18430 "E<.Em hanged> from the forthcoming text, E<.Em overhanged> from above and "
18431 "not indented or E<.Em tagged>. This list was constructed with the E<.Ql "
18432 "\\&Fl ohang> list-type. The E<.Ql \\&.It> macro is parsed only for the "
18433 "inset, hang and tag list-types and is not callable. Here is an example of "
18438 #: build/C/man7/mdoc.samples.7:2514
18443 #. type: Plain text
18444 #: build/C/man7/mdoc.samples.7:2517
18446 "The tagged list (also called a tagged paragraph) is the most common type of "
18447 "list used in the Berkeley manuals."
18451 #: build/C/man7/mdoc.samples.7:2517
18456 #. type: Plain text
18457 #: build/C/man7/mdoc.samples.7:2521
18459 "Diag lists create section four diagnostic lists and are similar to inset "
18460 "lists except callable macros are ignored."
18464 #: build/C/man7/mdoc.samples.7:2521
18469 #. type: Plain text
18470 #: build/C/man7/mdoc.samples.7:2523
18471 msgid "Hanged labels are a matter of taste."
18475 #: build/C/man7/mdoc.samples.7:2523
18480 #. type: Plain text
18481 #: build/C/man7/mdoc.samples.7:2525
18482 msgid "Overhanging labels are nice when space is constrained."
18486 #: build/C/man7/mdoc.samples.7:2525
18491 #. type: Plain text
18492 #: build/C/man7/mdoc.samples.7:2530
18494 "Inset labels are useful for controlling blocks of paragraphs and are "
18495 "valuable for converting E<.Nm \\-mdoc> manuals to other formats."
18498 #. type: Plain text
18499 #: build/C/man7/mdoc.samples.7:2533
18500 msgid "Here is the source text which produced the above example:"
18503 #. type: Plain text
18504 #: build/C/man7/mdoc.samples.7:2552
18507 "\\&.Bl -inset -offset indent\n"
18509 "\\&The tagged list (also called a tagged paragraph) is the\n"
18510 "\\&most common type of list used in the Berkeley manuals.\n"
18512 "\\&Diag lists create section four diagnostic lists\n"
18513 "\\&and are similar to inset lists except callable\n"
18514 "\\¯os are ignored.\n"
18516 "\\&Hanged labels are a matter of taste.\n"
18517 "\\&.It Em Ohang\n"
18518 "\\&Overhanging labels are nice when space is constrained.\n"
18519 "\\&.It Em Inset\n"
18520 "\\&Inset labels are useful for controlling blocks of\n"
18521 "\\¶graphs and are valuable for converting\n"
18523 "\\&manuals to other formats.\n"
18527 #. type: Plain text
18528 #: build/C/man7/mdoc.samples.7:2555
18529 msgid "Here is a hanged list with two items:"
18533 #: build/C/man7/mdoc.samples.7:2556
18538 #. type: Plain text
18539 #: build/C/man7/mdoc.samples.7:2559
18541 "labels appear similar to tagged lists when the label is smaller than the "
18546 #: build/C/man7/mdoc.samples.7:2559
18548 msgid "Em Longer hanged list labels"
18551 #. type: Plain text
18552 #: build/C/man7/mdoc.samples.7:2562
18553 msgid "blend in to the paragraph unlike tagged paragraph labels."
18556 #. type: Plain text
18557 #: build/C/man7/mdoc.samples.7:2565
18558 msgid "And the unformatted text which created it:"
18561 #. type: Plain text
18562 #: build/C/man7/mdoc.samples.7:2574
18565 "\\&.Bl -hang -offset indent\n"
18566 "\\&.It Em Hanged\n"
18567 "\\&labels appear similar to tagged lists when the\n"
18568 "\\&label is smaller than the label width.\n"
18569 "\\&.It Em Longer hanged list labels\n"
18570 "\\&blend in to the paragraph unlike\n"
18571 "\\&tagged paragraph labels.\n"
18575 #. type: Plain text
18576 #: build/C/man7/mdoc.samples.7:2578
18578 "The tagged list which follows uses an optional width specifier to control "
18579 "the width of the tag."
18583 #: build/C/man7/mdoc.samples.7:2580
18588 #. type: Plain text
18589 #: build/C/man7/mdoc.samples.7:2582
18590 msgid "sleep time of the process (seconds blocked)"
18594 #: build/C/man7/mdoc.samples.7:2582
18599 #. type: Plain text
18600 #: build/C/man7/mdoc.samples.7:2587
18602 "number of disk E<.Tn I/O Ns 's> resulting from references by the process to "
18603 "pages not loaded in core."
18607 #: build/C/man7/mdoc.samples.7:2587
18612 #. type: Plain text
18613 #: build/C/man7/mdoc.samples.7:2589
18614 msgid "numerical user-id of process owner"
18618 #: build/C/man7/mdoc.samples.7:2589
18623 #. type: Plain text
18624 #: build/C/man7/mdoc.samples.7:2592
18626 "numerical ID of parent of process process priority (nonpositive when in "
18627 "noninterruptible wait)"
18630 #. type: Plain text
18631 #: build/C/man7/mdoc.samples.7:2595
18632 msgid "The raw text:"
18635 #. type: Plain text
18636 #: build/C/man7/mdoc.samples.7:2610
18639 "\\&.Bl -tag -width \"PAGEIN\" -compact -offset indent\n"
18641 "\\&sleep time of the process (seconds blocked)\n"
18643 "\\&number of disk\n"
18644 "\\&.Tn I/O Ns 's\n"
18645 "\\&resulting from references\n"
18646 "\\&by the process to pages not loaded in core.\n"
18648 "\\&numerical user ID of process owner\n"
18650 "\\&numerical ID of parent of process process priority\n"
18651 "\\&(nonpositive when in noninterruptible wait)\n"
18655 #. type: Plain text
18656 #: build/C/man7/mdoc.samples.7:2613
18657 msgid "Acceptable width specifiers:"
18661 #: build/C/man7/mdoc.samples.7:2614
18663 msgid "Fl width Ar \\&Fl"
18666 #. type: Plain text
18667 #: build/C/man7/mdoc.samples.7:2623
18669 "sets the width to the default width for a flag. All callable macros have a "
18670 "default width value. The E<.Ql \\&.Fl>, value is presently set to ten "
18671 "constant width characters or about five sixth of an inch."
18675 #: build/C/man7/mdoc.samples.7:2623
18677 msgid "Fl width Ar 24n"
18680 #. type: Plain text
18681 #: build/C/man7/mdoc.samples.7:2629
18683 "sets the width to 24 constant width characters or about two inches. The "
18684 "E<.Ql n> is absolutely necessary for the scaling to work correctly."
18688 #: build/C/man7/mdoc.samples.7:2629
18690 msgid "Fl width Ar ENAMETOOLONG"
18693 #. type: Plain text
18694 #: build/C/man7/mdoc.samples.7:2632
18695 msgid "sets width to the constant width length of the string given."
18699 #: build/C/man7/mdoc.samples.7:2632
18701 msgid "Fl width Ar \"\\*qint mkfifo\\*q\""
18704 #. type: Plain text
18705 #: build/C/man7/mdoc.samples.7:2635
18706 msgid "again, the width is set to the constant width of the string given."
18709 #. type: Plain text
18710 #: build/C/man7/mdoc.samples.7:2649
18712 "If a width is not specified for the tag list type, the first time E<.Ql "
18713 "\\&.It> is invoked, an attempt is made to determine an appropriate width. "
18714 "If the first argument to E<.Ql \".It\"> is a callable macro, the default "
18715 "width for that macro will be used as if the macro name had been supplied as "
18716 "the width. However, if another item in the list is given with a different "
18717 "callable macro name, a new and nested list is assumed."
18721 #: build/C/man7/mdoc.samples.7:2649
18723 msgid "PREDEFINED STRINGS"
18726 #. type: Plain text
18727 #: build/C/man7/mdoc.samples.7:2661
18729 "The following strings are predefined as may be used by preceding with the "
18730 "troff string interpreting sequence E<.Ql \\&\\e*(xx> where E<.Em xx> is the "
18731 "name of the defined string or as E<.Ql \\&\\e*x> where E<.Em x> is the name "
18732 "of the string. The interpreting sequence may be used any where in the text."
18736 #: build/C/man7/mdoc.samples.7:2663
18738 msgid "Sy \"String\tNroff\tTroff\""
18742 #: build/C/man7/mdoc.samples.7:2664
18744 msgid "Li E<lt>= Ta \\&E<lt>\\&= Ta \\*(E<lt>="
18748 #: build/C/man7/mdoc.samples.7:2665
18750 msgid "Li E<gt>= Ta \\&E<gt>\\&= Ta \\*(E<gt>="
18754 #: build/C/man7/mdoc.samples.7:2666
18756 msgid "Li Rq Ta '' Ta \\*(Rq"
18760 #: build/C/man7/mdoc.samples.7:2667
18762 msgid "Li Lq Ta `` Ta \\*(Lq"
18766 #: build/C/man7/mdoc.samples.7:2668
18768 msgid "Li ua Ta ^ Ta \\*(ua"
18772 #: build/C/man7/mdoc.samples.7:2669
18774 msgid "Li aa Ta ' Ta \\*(aa"
18778 #: build/C/man7/mdoc.samples.7:2670
18780 msgid "Li ga Ta \\` Ta \\*(ga"
18783 #. .It Li "sL" Ta ` Ta \*(sL
18784 #. .It Li "sR" Ta ' Ta \*(sR
18786 #: build/C/man7/mdoc.samples.7:2673
18788 msgid "Li q Ta \\(dq Ta \\*q"
18792 #: build/C/man7/mdoc.samples.7:2674
18794 msgid "Li Pi Ta pi Ta \\*(Pi"
18798 #: build/C/man7/mdoc.samples.7:2675
18800 msgid "Li Ne Ta != Ta \\*(Ne"
18804 #: build/C/man7/mdoc.samples.7:2676
18806 msgid "Li Le Ta E<lt>= Ta \\*(Le"
18810 #: build/C/man7/mdoc.samples.7:2677
18812 msgid "Li Ge Ta E<gt>= Ta \\*(Ge"
18816 #: build/C/man7/mdoc.samples.7:2678
18818 msgid "Li Lt Ta E<lt> Ta \\*(Gt"
18822 #: build/C/man7/mdoc.samples.7:2679
18824 msgid "Li Gt Ta E<gt> Ta \\*(Lt"
18828 #: build/C/man7/mdoc.samples.7:2680
18830 msgid "Li Pm Ta +- Ta \\*(Pm"
18834 #: build/C/man7/mdoc.samples.7:2681
18836 msgid "Li If Ta infinity Ta \\*(If"
18840 #: build/C/man7/mdoc.samples.7:2682
18842 msgid "Li Na Ta I<NaN> Ta \\*(Na"
18846 #: build/C/man7/mdoc.samples.7:2683
18848 msgid "Li Ba Ta \\&| Ta \\*(Ba"
18851 #. type: Plain text
18852 #: build/C/man7/mdoc.samples.7:2692
18854 "E<.Sy Note>: The string named E<.Ql q> should be written as E<.Ql \\e*q> "
18855 "since it is only one char."
18859 #: build/C/man7/mdoc.samples.7:2692
18861 msgid "DIAGNOSTICS"
18864 #. type: Plain text
18865 #: build/C/man7/mdoc.samples.7:2725
18867 "The debugging facilities for E<.Nm \\-mdoc> are limited, but can help detect "
18868 "subtle errors such as the collision of an argument name with an internal "
18869 "register or macro name. (A what?) A register is an arithmetic storage "
18870 "class for E<.Xr troff> with a one or two character name. All registers "
18871 "internal to E<.Nm \\-mdoc> for E<.Xr troff> and E<.Xr ditroff> are two "
18872 "characters and of the form E<lt>upper_caseE<gt>E<lt>lower_caseE<gt> such as "
18873 "E<.Ql \\&Ar>, E<lt>lower_caseE<gt>E<lt>upper_caseE<gt> as E<.Ql \\&aR> or "
18874 "E<lt>upper or lower letterE<gt>E<lt>digitE<gt> as E<.Ql \\&C\\&1>. And "
18875 "adding to the muddle, E<.Xr troff> has its own internal registers all of "
18876 "which are either two lower case characters or a dot plus a letter or "
18877 "metacharacter character. In one of the introduction examples, it was shown "
18878 "how to prevent the interpretation of a macro name with the escape sequence "
18879 "E<.Ql \\e&>. This is sufficient for the internal register names also."
18882 #. Every callable macro name has a corresponding register
18883 #. of the same name (<upper_case><lower_case>).
18884 #. There are also specific registers which have
18885 #. been used for stacks and arrays and are listed in the
18887 #. .Bd -ragged -offset 4n
18888 #. [A-Z][a-z] registers corresponding to macro names (example ``Ar'')
18889 #. [a-z][A-Z] registers corresponding to macro names (example ``aR'')
18890 #. C[0-9] argument types (example C1)
18891 #. O[0-9] offset stack (displays)
18892 #. h[0-9] horizontal spacing stack (lists)
18893 #. o[0-9] offset (stack) (lists)
18894 #. t[0-9] tag stack (lists)
18895 #. v[0-9] vertical spacing stack (lists)
18896 #. w[0-9] width tag/label stack
18899 #. type: Plain text
18900 #: build/C/man7/mdoc.samples.7:2764
18902 "If a nonescaped register name is given in the argument list of a request "
18903 "unpredictable behavior will occur. In general, any time huge portions of "
18904 "text do not appear where expected in the output, or small strings such as "
18905 "list tags disappear, chances are there is a misunderstanding about an "
18906 "argument type in the argument list. Your mother never intended for you to "
18907 "remember this evil stuff - so here is a way to find out whether or not your "
18908 "arguments are valid: The E<.Ql \\&.Db> (debug) macro displays the "
18909 "interpretation of the argument list for most macros. Macros such as the "
18910 "E<.Ql \\&.Pp> (paragraph) macro do not contain debugging information. All "
18911 "of the callable macros do, and it is strongly advised whenever in doubt, "
18912 "turn on the E<.Ql \\&.Db> macro."
18916 #: build/C/man7/mdoc.samples.7:2765
18918 msgid "Usage: \\&.Db [on | off]"
18921 #. type: Plain text
18922 #: build/C/man7/mdoc.samples.7:2774
18924 "An example of a portion of text with the debug macro placed above and below "
18925 "an artificially created problem (a flag argument E<.Ql \\&aC> which should "
18926 "be E<.Ql \\e&aC> in order to work):"
18929 #. type: Plain text
18930 #: build/C/man7/mdoc.samples.7:2778
18934 "\\&.Op Fl aC Ar file )\n"
18938 #. type: Plain text
18939 #: build/C/man7/mdoc.samples.7:2781
18940 msgid "The resulting output:"
18943 #. type: Plain text
18944 #: build/C/man7/mdoc.samples.7:2796
18948 "DEBUG(argv) MACRO: `.Op' Line #: 2\n"
18949 "\tArgc: 1 Argv: `Fl' Length: 2\n"
18950 "\tSpace: `' Class: Executable\n"
18951 "\tArgc: 2 Argv: `aC' Length: 2\n"
18952 "\tSpace: `' Class: Executable\n"
18953 "\tArgc: 3 Argv: `Ar' Length: 2\n"
18954 "\tSpace: `' Class: Executable\n"
18955 "\tArgc: 4 Argv: `file' Length: 4\n"
18956 "\tSpace: ` ' Class: String\n"
18957 "\tArgc: 5 Argv: `)' Length: 1\n"
18958 "\tSpace: ` ' Class: Closing Punctuation or suffix\n"
18959 "\tMACRO REQUEST: .Op Fl aC Ar file )\n"
18963 #. type: Plain text
18964 #: build/C/man7/mdoc.samples.7:2823
18966 "The first line of information tells the name of the calling macro, here "
18967 "E<.Ql \\&.Op>, and the line number it appears on. If one or more files are "
18968 "involved (especially if text from another file is included) the line number "
18969 "may be bogus. If there is only one file, it should be accurate. The second "
18970 "line gives the argument count, the argument E<.Pq Ql \\&Fl> and its length. "
18971 "If the length of an argument is two characters, the argument is tested to "
18972 "see if it is executable (unfortunately, any register which contains a "
18973 "nonzero value appears executable). The third line gives the space allotted "
18974 "for a class, and the class type. The problem here is the argument aC should "
18975 "not be executable. The four types of classes are string, executable, "
18976 "closing punctuation and opening punctuation. The last line shows the entire "
18977 "argument list as it was read. In this next example, the offending E<.Ql "
18978 "\\&aC> is escaped:"
18981 #. type: Plain text
18982 #: build/C/man7/mdoc.samples.7:2827
18986 "\\&.Em An escaped \\e&aC\n"
18990 #. type: Plain text
18991 #: build/C/man7/mdoc.samples.7:2839
18995 "DEBUG(fargv) MACRO: `.Em' Line #: 2\n"
18996 "\tArgc: 1 Argv: `An' Length: 2\n"
18997 "\tSpace: ` ' Class: String\n"
18998 "\tArgc: 2 Argv: `escaped' Length: 7\n"
18999 "\tSpace: ` ' Class: String\n"
19000 "\tArgc: 3 Argv: `aC' Length: 2\n"
19001 "\tSpace: ` ' Class: String\n"
19002 "\tMACRO REQUEST: .Em An escaped &aC\n"
19006 #. type: Plain text
19007 #: build/C/man7/mdoc.samples.7:2849
19009 "The argument E<.Ql \\e&aC> shows up with the same length of 2 as the E<.Ql "
19010 "\\e&> sequence produces a zero width, but a register named E<.Ql \\e&aC> was "
19011 "not found and the type classified as string."
19014 #. type: Plain text
19015 #: build/C/man7/mdoc.samples.7:2851
19016 msgid "Other diagnostics consist of usage statements and are self explanatory."
19020 #: build/C/man7/mdoc.samples.7:2851
19022 msgid "GROFF, TROFF AND NROFF"
19025 #. type: Plain text
19026 #: build/C/man7/mdoc.samples.7:2856
19028 "The E<.Nm \\-mdoc> package does not need compatibility mode with E<.Xr "
19032 #. type: Plain text
19033 #: build/C/man7/mdoc.samples.7:2874
19035 "The package inhibits page breaks, and the headers and footers which normally "
19036 "occur at those breaks with E<.Xr nroff>, to make the manual more efficient "
19037 "for viewing on-line. At the moment, E<.Xr groff> with E<.Fl T Ns Ar ascii> "
19038 "does eject the imaginary remainder of the page at end of file. The "
19039 "inhibiting of the page breaks makes E<.Xr nroff Ns 'd> files unsuitable for "
19040 "hardcopy. There is a register named E<.Ql \\&cR> which can be set to zero "
19041 "in the site dependent style file E<.Pa /usr/src/share/tmac/doc-nroff> to "
19042 "restore the old style behavior."
19046 #: build/C/man7/mdoc.samples.7:2876
19048 msgid "Pa /usr/share/tmac/doc.tmac"
19051 #. type: Plain text
19052 #: build/C/man7/mdoc.samples.7:2878
19053 msgid "manual macro package"
19057 #: build/C/man7/mdoc.samples.7:2878
19059 msgid "Pa /usr/share/misc/mdoc.template"
19062 #. type: Plain text
19063 #: build/C/man7/mdoc.samples.7:2880
19064 msgid "template for writing a man page"
19068 #: build/C/man7/mdoc.samples.7:2880
19070 msgid "Pa /usr/share/examples/mdoc/*"
19073 #. type: Plain text
19074 #: build/C/man7/mdoc.samples.7:2882
19075 msgid "several example man pages"
19078 #. type: Plain text
19079 #: build/C/man7/mdoc.samples.7:2890
19081 "Undesirable hyphenation on the dash of a flag argument is not yet resolved, "
19082 "and causes occasional mishaps in the E<.Sx DESCRIPTION> section. (line "
19083 "break on the hyphen)."
19086 #. type: Plain text
19087 #: build/C/man7/mdoc.samples.7:2892
19088 msgid "Predefined strings are not declared in documentation."
19091 #. type: Plain text
19092 #: build/C/man7/mdoc.samples.7:2894
19093 msgid "Section 3f has not been added to the header routines."
19096 #. type: Plain text
19097 #: build/C/man7/mdoc.samples.7:2899
19098 msgid "E<.Ql \\&.Nm> font should be changed in E<.Sx NAME> section."
19101 #. type: Plain text
19102 #: build/C/man7/mdoc.samples.7:2906
19104 "E<.Ql \\&.Fn> needs to have a check to prevent splitting up if the line "
19105 "length is too short. Occasionally it separates the last parenthesis, and "
19106 "sometimes looks ridiculous if a line is in fill mode."
19109 #. type: Plain text
19110 #: build/C/man7/mdoc.samples.7:2911
19112 "The method used to prevent header and footer page breaks (other than the "
19113 "initial header and footer) when using nroff occasionally places an unsightly "
19114 "partially filled line (blank) at the would be bottom of the page."
19117 #. Note what happens if the parameter list overlaps a newline
19119 #. to make sure a line boundary is crossed:
19121 #. \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
19124 #. produces, nudge nudge,
19125 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
19126 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
19128 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
19130 #. If double quotes are used, for example:
19132 #. \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
19135 #. produces, nudge nudge,
19136 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
19138 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
19140 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
19142 #. Not a pretty sight...
19143 #. In a paragraph, a long parameter containing unpaddable spaces as
19144 #. in the former example will cause
19146 #. to break the line and spread
19147 #. the remaining words out.
19148 #. The latter example will adjust nicely to
19149 #. justified margins, but may break in between an argument and its
19153 #. the right margin adjustment is normally ragged and the problem is
19155 #. type: Plain text
19156 #: build/C/man7/mdoc.samples.7:2952
19158 "The list and display macros to not do any keeps and certainly should be able "
19162 #. type: Plain text
19163 #: build/C/man7/mdoc.samples.7:2957
19164 msgid "E<.Xr man 1>, E<.Xr troff 1>, E<.Xr groff_mdoc 7>, E<.Xr mdoc 7>"