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: 2012-04-25 06:00+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
32 #: build/C/man7/feature_test_macros.7:25 build/C/man1/intro.1:26 build/C/man2/intro.2:27 build/C/man3/intro.3:24 build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28 build/C/man7/libc.7:24 build/C/man7/mailaddr.7:26 build/C/man7/man-pages.7:28 build/C/man7/man.7:32 build/C/man7/mdoc.7:42 build/C/man7/operator.7:38 build/C/man5/proc.5:61 build/C/man7/standards.7:25 build/C/man7/suffixes.7:38 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:27 build/C/man7/units.7:24
38 #: build/C/man7/feature_test_macros.7:25 build/C/man2/intro.2:27 build/C/man3/intro.3:24 build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28 build/C/man7/libc.7:24 build/C/man7/man-pages.7:28 build/C/man7/man.7:32 build/C/man7/operator.7:38 build/C/man7/posixoptions.7:23 build/C/man5/proc.5:61 build/C/man7/standards.7:25 build/C/man7/suffixes.7:38 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:27 build/C/man7/units.7:24
40 msgid "Linux Programmer's Manual"
44 #: build/C/man7/feature_test_macros.7:26 build/C/man1/intro.1:27 build/C/man2/intro.2:28 build/C/man3/intro.3:25 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:25 build/C/man7/mailaddr.7:28 build/C/man7/man-pages.7:29 build/C/man7/man.7:33 build/C/man7/mdoc.7:43 build/C/man7/operator.7:39 build/C/man7/posixoptions.7:24 build/C/man5/proc.5:62 build/C/man7/standards.7:26 build/C/man7/suffixes.7:39 build/C/man3/undocumented.3:30 build/C/man2/unimplemented.2:28 build/C/man7/units.7:25 build/C/man7/mdoc.samples.7:42
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:31 build/C/man7/man.7:35 build/C/man7/mdoc.7:48 build/C/man3/undocumented.3:32 build/C/man2/unimplemented.2:31 build/C/man7/mdoc.samples.7:48
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:29 build/C/man2/intro.2:30 build/C/man3/intro.3:27 build/C/man4/intro.4:28 build/C/man5/intro.5:29 build/C/man6/intro.6:28 build/C/man7/intro.7:30 build/C/man8/intro.8:31 build/C/man7/libc.7:27 build/C/man7/mailaddr.7:30 build/C/man7/man-pages.7:35 build/C/man7/man.7:47 build/C/man7/mdoc.7:52 build/C/man7/operator.7:41 build/C/man7/posixoptions.7:26 build/C/man5/proc.5:64 build/C/man7/standards.7:28 build/C/man7/suffixes.7:41 build/C/man3/undocumented.3:34 build/C/man2/unimplemented.2:33 build/C/man7/units.7:27 build/C/man7/mdoc.samples.7:50
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:407 build/C/man7/feature_test_macros.7:412 build/C/man7/feature_test_macros.7:418 build/C/man7/feature_test_macros.7:423 build/C/man7/feature_test_macros.7:429 build/C/man7/feature_test_macros.7:434
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:240
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 http://opengroup.org/platform/lfs.html.) The alternative API consists "
418 "of a set of new objects (i.e., functions and types) whose names are suffixed "
419 "with \"64\" (e.g., I<off64_t> versus I<off_t>, B<lseek64>() versus "
420 "B<lseek>(), etc.). New programs should not employ this interface; instead "
421 "I<_FILE_OFFSET_BITS=64> should be employed."
425 #: build/C/man7/feature_test_macros.7:240
427 msgid "B<_FILE_OFFSET_BITS>"
431 #: build/C/man7/feature_test_macros.7:252
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:252
446 msgid "B<_BSD_SOURCE>"
450 #: build/C/man7/feature_test_macros.7:266
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:266
463 msgid "B<_SVID_SOURCE>"
467 #: build/C/man7/feature_test_macros.7:272
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:272
477 msgid "B<_ATFILE_SOURCE> (since glibc 2.4)"
481 #: build/C/man7/feature_test_macros.7:281
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:281
492 msgid "B<_GNU_SOURCE>"
496 #: build/C/man7/feature_test_macros.7:303
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:303
512 msgid "B<_REENTRANT>"
516 #: build/C/man7/feature_test_macros.7:309
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:309
525 msgid "B<_THREAD_SAFE>"
529 #: build/C/man7/feature_test_macros.7:314
531 "Synonym for B<_REENTRANT>, provided for compatibility with some other "
536 #: build/C/man7/feature_test_macros.7:314
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:360
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:360
570 msgid "Default definitions, implicit definitions, and combining definitions"
574 #: build/C/man7/feature_test_macros.7:372
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:388
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:399
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:400 build/C/man7/feature_test_macros.7:403 build/C/man7/man-pages.7:490 build/C/man7/man-pages.7:493 build/C/man7/man-pages.7:500 build/C/man7/man-pages.7:504 build/C/man7/man-pages.7:508 build/C/man7/man-pages.7:512 build/C/man7/man-pages.7:518 build/C/man5/proc.5:573 build/C/man5/proc.5:577 build/C/man5/proc.5:580 build/C/man5/proc.5:582 build/C/man5/proc.5:585 build/C/man5/proc.5:989 build/C/man5/proc.5:992 build/C/man5/proc.5:1003 build/C/man5/proc.5:1006 build/C/man5/proc.5:1010 build/C/man5/proc.5:1013 build/C/man5/proc.5:1016 build/C/man5/proc.5:1019 build/C/man5/proc.5:1022 build/C/man5/proc.5:1025 build/C/man5/proc.5:1028 build/C/man5/proc.5:1031 build/C/man5/proc.5:1035 build/C/man5/proc.5:1038 build/C/man5/proc.5:1041 build/C/man5/proc.5:1044 build/C/man5/proc.5:1047 build/C/man5/proc.5:1050 build/C/man5/proc.5:1053 build/C/man5/proc.5:1064 build/C/man5/proc.5:1070 build/C/man5/proc.5:1074 build/C/man5/proc.5:1079 build/C/man5/proc.5:1084 build/C/man5/proc.5:1089 build/C/man5/proc.5:1094 build/C/man5/proc.5:1099 build/C/man5/proc.5:1104 build/C/man5/proc.5:1819 build/C/man5/proc.5:1823 build/C/man5/proc.5:1826 build/C/man5/proc.5:1831
607 #: build/C/man7/feature_test_macros.7:403
608 msgid "B<_POSIX_SOURCE> is defined with the value 1; and"
612 #: build/C/man7/feature_test_macros.7:406
613 msgid "B<_POSIX_C_SOURCE> is defined with one of the following values:"
617 #: build/C/man7/feature_test_macros.7:412
618 msgid "2, if B<XOPEN_SOURCE> is defined with a value less than 500;"
622 #: build/C/man7/feature_test_macros.7:418
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:423
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:429
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:434
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:443
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:447
660 msgid "Multiple macros can be defined; the results are additive."
664 #: build/C/man7/feature_test_macros.7:447 build/C/man2/intro.2:68 build/C/man3/intro.3:85 build/C/man7/suffixes.7:275
666 msgid "CONFORMING TO"
670 #: build/C/man7/feature_test_macros.7:455
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:459
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:469
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:469 build/C/man1/intro.1:46 build/C/man2/intro.2:73 build/C/man3/intro.3:90 build/C/man4/intro.4:32 build/C/man5/intro.5:32 build/C/man6/intro.6:31 build/C/man7/intro.7:35 build/C/man8/intro.8:43 build/C/man7/man.7:476 build/C/man5/proc.5:2703 build/C/man2/unimplemented.2:40
699 #: build/C/man7/feature_test_macros.7:476
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:486
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:486 build/C/man7/man-pages.7:538
726 #: build/C/man7/feature_test_macros.7:492
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:519
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:521
767 msgid "Program source"
771 #: build/C/man7/feature_test_macros.7:525
773 msgid "/* ftm.c */\n"
777 #: build/C/man7/feature_test_macros.7:529
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:536
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:540
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:544
810 "#ifdef _ISOC99_SOURCE\n"
811 " printf(\"_ISOC99_SOURCE defined\\en\");\n"
816 #: build/C/man7/feature_test_macros.7:548
819 "#ifdef _XOPEN_SOURCE\n"
820 " printf(\"_XOPEN_SOURCE defined: %d\\en\", _XOPEN_SOURCE);\n"
825 #: build/C/man7/feature_test_macros.7:552
828 "#ifdef _XOPEN_SOURCE_EXTENDED\n"
829 " printf(\"_XOPEN_SOURCE_EXTENDED defined\\en\");\n"
834 #: build/C/man7/feature_test_macros.7:556
837 "#ifdef _LARGEFILE64_SOURCE\n"
838 " printf(\"_LARGEFILE64_SOURCE defined\\en\");\n"
843 #: build/C/man7/feature_test_macros.7:560
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:564
855 "#ifdef _BSD_SOURCE\n"
856 " printf(\"_BSD_SOURCE defined\\en\");\n"
861 #: build/C/man7/feature_test_macros.7:568
864 "#ifdef _SVID_SOURCE\n"
865 " printf(\"_SVID_SOURCE defined\\en\");\n"
870 #: build/C/man7/feature_test_macros.7:572
873 "#ifdef _ATFILE_SOURCE\n"
874 " printf(\"_ATFILE_SOURCE defined\\en\");\n"
879 #: build/C/man7/feature_test_macros.7:576
882 "#ifdef _GNU_SOURCE\n"
883 " printf(\"_GNU_SOURCE defined\\en\");\n"
888 #: build/C/man7/feature_test_macros.7:580
891 "#ifdef _REENTRANT\n"
892 " printf(\"_REENTRANT defined\\en\");\n"
897 #: build/C/man7/feature_test_macros.7:584
900 "#ifdef _THREAD_SAFE\n"
901 " printf(\"_THREAD_SAFE defined\\en\");\n"
906 #: build/C/man7/feature_test_macros.7:588
909 "#ifdef _FORTIFY_SOURCE\n"
910 " printf(\"_FORTIFY_SOURCE defined\\en\");\n"
915 #: build/C/man7/feature_test_macros.7:591
918 " exit(EXIT_SUCCESS);\n"
923 #: build/C/man7/feature_test_macros.7:592 build/C/man1/intro.1:300 build/C/man2/intro.2:87 build/C/man3/intro.3:95 build/C/man4/intro.4:37 build/C/man5/intro.5:37 build/C/man7/intro.7:40 build/C/man7/libc.7:96 build/C/man7/mailaddr.7:116 build/C/man7/man-pages.7:545 build/C/man7/man.7:555 build/C/man7/mdoc.7:426 build/C/man7/posixoptions.7:853 build/C/man5/proc.5:2716 build/C/man7/standards.7:253 build/C/man7/suffixes.7:279 build/C/man2/unimplemented.2:64 build/C/man7/mdoc.samples.7:2941
929 #: build/C/man7/feature_test_macros.7:595
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:599
936 msgid "The section \"Feature Test Macros\" under I<info libc>."
940 #: build/C/man7/feature_test_macros.7:600
941 msgid "I</usr/include/features.h>"
945 #: build/C/man1/intro.1:26 build/C/man2/intro.2:27 build/C/man3/intro.3:24 build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28
951 #: build/C/man1/intro.1:26
957 #: build/C/man1/intro.1:26 build/C/man7/mailaddr.7:26
959 msgid "Linux User's Manual"
963 #: build/C/man1/intro.1:29
964 msgid "intro - Introduction to user commands"
968 #: build/C/man1/intro.1:33
970 "Section 1 of the manual describes user commands and tools, for example, file "
971 "manipulation tools, shells, compilers, web browsers, file and image viewers "
972 "and editors, and so on."
976 #: build/C/man1/intro.1:46
978 "All commands yield a status value on termination. This value can be tested "
979 "(e.g., in most shells the variable I<$?> contains the status of the last "
980 "executed command) to see whether the command completed successfully. A "
981 "zero exit status is conventionally used to indicate success, and a nonzero "
982 "status means that the command was unsuccessful. (Details of the exit status "
983 "can be found in B<wait>(2).) A nonzero exit status can be in the range 1 to "
984 "255, and some commands use different nonzero status values to indicate the "
985 "reason why the command failed."
989 #: build/C/man1/intro.1:50
991 "Linux is a flavor of UNIX, and as a first approximation all user commands "
992 "under UNIX work precisely the same under Linux (and FreeBSD and lots of "
993 "other UNIX-like systems)."
997 #: build/C/man1/intro.1:60
999 "Under Linux there are GUIs (graphical user interfaces), where you can point "
1000 "and click and drag, and hopefully get work done without first reading lots "
1001 "of documentation. The traditional UNIX environment is a CLI (command line "
1002 "interface), where you type commands to tell the computer what to do. That "
1003 "is faster and more powerful, but requires finding out what the commands "
1004 "are. Below a bare minimum, to get started."
1008 #: build/C/man1/intro.1:60
1014 #: build/C/man1/intro.1:74
1016 "In order to start working, you probably first have to login, that is, give "
1017 "your username and password. See also B<login>(1). The program I<login> now "
1018 "starts a I<shell> (command interpreter) for you. In case of a graphical "
1019 "login, you get a screen with menus or icons and a mouse click will start a "
1020 "shell in a window. See also B<xterm>(1)."
1024 #: build/C/man1/intro.1:74
1030 #: build/C/man1/intro.1:89
1032 "One types commands to the I<shell>, the command interpreter. It is not "
1033 "built-in, but is just a program and you can change your shell. Everybody "
1034 "has her own favorite one. The standard one is called I<sh>. See also "
1035 "B<ash>(1), B<bash>(1), B<csh>(1), B<zsh>(1), B<chsh>(1)."
1039 #: build/C/man1/intro.1:91
1040 msgid "A session might go like"
1044 #: build/C/man1/intro.1:106
1047 "B<knuth login: >I<aeb>\n"
1048 "B<Password: >I<********>\n"
1050 "Tue Aug 6 23:50:44 CEST 2002\n"
1053 "Su Mo Tu We Th Fr Sa\n"
1056 "11 12 13 14 15 16 17\n"
1057 "18 19 20 21 22 23 24\n"
1058 "25 26 27 28 29 30 31\n"
1062 #: build/C/man1/intro.1:133
1069 "drwxrwxr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1070 "-rw-rw-r-- 1 aeb 37 Aug 6 23:52 tel\n"
1072 "maja 0501-1136285\n"
1073 "peter 0136-7399214\n"
1074 "B<% >I<cp tel tel2>\n"
1077 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1078 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel\n"
1079 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1080 "B<% >I<mv tel tel1>\n"
1083 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1084 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel1\n"
1085 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1086 "B<% >I<diff tel1 tel2>\n"
1088 "B<% >I<grep maja tel2>\n"
1089 "maja 0501-1136285\n"
1094 #: build/C/man1/intro.1:145
1096 "and here typing Control-D ended the session. The B<% > here was the command "
1097 "prompt\\(emit is the shell's way of indicating that it is ready for the next "
1098 "command. The prompt can be customized in lots of ways, and one might "
1099 "include stuff like username, machine name, current directory, time, etc. An "
1100 "assignment PS1=\"What next, master? \" would change the prompt as indicated."
1104 #: build/C/man1/intro.1:151
1106 "We see that there are commands I<date> (that gives date and time), and "
1107 "I<cal> (that gives a calendar)."
1111 #: build/C/man1/intro.1:167
1113 "The command I<ls> lists the contents of the current directory\\(emit tells "
1114 "you what files you have. With a I<-l> option it gives a long listing, that "
1115 "includes the owner and size and date of the file, and the permissions people "
1116 "have for reading and/or changing the file. For example, the file \"tel\" "
1117 "here is 37 bytes long, owned by aeb and the owner can read and write it, "
1118 "others can only read it. Owner and permissions can be changed by the "
1119 "commands I<chown> and I<chmod>."
1123 #: build/C/man1/intro.1:174
1125 "The command I<cat> will show the contents of a file. (The name is from "
1126 "\"concatenate and print\": all files given as parameters are concatenated "
1127 "and sent to \"standard output\", here the terminal screen.)"
1131 #: build/C/man1/intro.1:181
1133 "The command I<cp> (from \"copy\") will copy a file. On the other hand, the "
1134 "command I<mv> (from \"move\") only renames it."
1138 #: build/C/man1/intro.1:186
1140 "The command I<diff> lists the differences between two files. Here there was "
1141 "no output because there were no differences."
1145 #: build/C/man1/intro.1:192
1147 "The command I<rm> (from \"remove\") deletes the file, and be careful! it is "
1148 "gone. No wastepaper basket or anything. Deleted means lost."
1152 #: build/C/man1/intro.1:197
1154 "The command I<grep> (from \"g/re/p\") finds occurrences of a string in one "
1155 "or more files. Here it finds Maja's telephone number."
1159 #: build/C/man1/intro.1:197
1161 msgid "Pathnames and the current directory"
1165 #: build/C/man1/intro.1:209
1167 "Files live in a large tree, the file hierarchy. Each has a I<pathname> "
1168 "describing the path from the root of the tree (which is called /) to the "
1169 "file. For example, such a full pathname might be /home/aeb/tel. Always "
1170 "using full pathnames would be inconvenient, and the name of a file in the "
1171 "current directory may be abbreviated by only giving the last component. "
1172 "That is why \"/home/aeb/tel\" can be abbreviated to \"tel\" when the current "
1173 "directory is \"/home/aeb\"."
1177 #: build/C/man1/intro.1:213
1178 msgid "The command I<pwd> prints the current directory."
1182 #: build/C/man1/intro.1:218
1184 "The command I<cd> changes the current directory. Try \"cd /\" and \"pwd\" "
1185 "and \"cd\" and \"pwd\"."
1189 #: build/C/man1/intro.1:218
1195 #: build/C/man1/intro.1:222
1196 msgid "The command I<mkdir> makes a new directory."
1200 #: build/C/man1/intro.1:226
1202 "The command I<rmdir> removes a directory if it is empty, and complains "
1207 #: build/C/man1/intro.1:238
1209 "The command I<find> (with a rather baroque syntax) will find files with "
1210 "given name or other properties. For example, \"find . -name tel\" would "
1211 "find the file \"tel\" starting in the present directory (which is called "
1212 "\".\"). And \"find / -name tel\" would do the same, but starting at the "
1213 "root of the tree. Large searches on a multi-GB disk will be time-consuming, "
1214 "and it may be better to use B<locate>(1)."
1218 #: build/C/man1/intro.1:238
1220 msgid "Disks and Filesystems"
1224 #: build/C/man1/intro.1:249
1226 "The command I<mount> will attach the file system found on some disk (or "
1227 "floppy, or CDROM or so) to the big file system hierarchy. And I<umount> "
1228 "detaches it again. The command I<df> will tell you how much of your disk is "
1233 #: build/C/man1/intro.1:249
1239 #: build/C/man1/intro.1:267
1241 "On a UNIX system many user and system processes run simultaneously. The one "
1242 "you are talking to runs in the I<foreground>, the others in the "
1243 "I<background>. The command I<ps> will show you which processes are active "
1244 "and what numbers these processes have. The command I<kill> allows you to "
1245 "get rid of them. Without option this is a friendly request: please go "
1246 "away. And \"kill -9\" followed by the number of the process is an immediate "
1247 "kill. Foreground processes can often be killed by typing Control-C."
1251 #: build/C/man1/intro.1:267
1253 msgid "Getting information"
1257 #: build/C/man1/intro.1:280
1259 "There are thousands of commands, each with many options. Traditionally "
1260 "commands are documented on I<man pages>, (like this one), so that the "
1261 "command \"man kill\" will document the use of the command \"kill\" (and "
1262 "\"man man\" document the command \"man\"). The program I<man> sends the "
1263 "text through some I<pager>, usually I<less>. Hit the space bar to get the "
1264 "next page, hit q to quit."
1268 #: build/C/man1/intro.1:288
1270 "In documentation it is customary to refer to man pages by giving the name "
1271 "and section number, as in B<man>(1). Man pages are terse, and allow you to "
1272 "find quickly some forgotten detail. For newcomers an introductory text with "
1273 "more examples and explanations is useful."
1277 #: build/C/man1/intro.1:292
1279 "A lot of GNU/FSF software is provided with info files. Type \"info info\" "
1280 "for an introduction on the use of the program \"info\"."
1284 #. Actual examples? Separate section for each of cat, cp, ...?
1285 #. gzip, bzip2, tar, rpm
1287 #: build/C/man1/intro.1:300
1289 "Special topics are often treated in HOWTOs. Look in "
1290 "I</usr/share/doc/howto/en> and use a browser if you find HTML files there."
1294 #: build/C/man1/intro.1:301 build/C/man4/intro.4:38 build/C/man5/intro.5:38 build/C/man7/intro.7:41
1295 msgid "B<standards>(7)"
1299 #: build/C/man2/intro.2:27 build/C/man3/intro.3:24
1305 #: build/C/man2/intro.2:30
1306 msgid "intro - Introduction to system calls"
1310 #: build/C/man2/intro.2:40
1312 "Section 2 of the manual describes the Linux system calls. A system call is "
1313 "an entry point into the Linux kernel. Usually, system calls are not invoked "
1314 "directly: instead, most system calls have corresponding C library wrapper "
1315 "functions which perform the steps required (e.g., trapping to kernel mode) "
1316 "in order to invoke the system call. Thus, making a system call looks the "
1317 "same as invoking a normal library function."
1321 #: build/C/man2/intro.2:43
1322 msgid "For a list of the Linux system calls, see B<syscalls>(2)."
1326 #: build/C/man2/intro.2:43 build/C/man2/unimplemented.2:35
1328 msgid "RETURN VALUE"
1332 #: build/C/man2/intro.2:52
1334 "On error, most system calls return a negative error number (i.e., the "
1335 "negated value of one of the constants described in B<errno>(3)). The C "
1336 "library wrapper hides this detail from the caller: when a system call "
1337 "returns a negative value, the wrapper copies the absolute value into the "
1338 "I<errno> variable, and returns -1 as the return value of the wrapper."
1342 #: build/C/man2/intro.2:57
1344 "The value returned by a successful system call depends on the call. Many "
1345 "system calls return 0 on success, but some can return nonzero values from a "
1346 "successful call. The details are described in the individual manual pages."
1350 #: build/C/man2/intro.2:68
1352 "In some cases, the programmer must define a feature test macro in order to "
1353 "obtain the declaration of a system call from the header file specified in "
1354 "the man page SYNOPSIS section. (Where required, these feature test macros "
1355 "must be defined before including I<any> header files.) In such cases, the "
1356 "required macro is described in the man page. For further information on "
1357 "feature test macros, see B<feature_test_macros>(7)."
1361 #: build/C/man2/intro.2:73 build/C/man3/intro.3:90
1363 "Certain terms and abbreviations are used to indicate UNIX variants and "
1364 "standards to which calls in this section conform. See B<standards>(7)."
1368 #: build/C/man2/intro.2:74
1370 msgid "Calling Directly"
1374 #: build/C/man2/intro.2:83
1376 "In most cases, it is unnecessary to invoke a system call directly, but there "
1377 "are times when the Standard C library does not implement a nice wrapper "
1378 "function for you. In this case, the programmer must manually invoke the "
1379 "system call using B<syscall>(2). Historically, this was also possible using "
1380 "one of the _syscall macros described in B<_syscall>(2)."
1384 #: build/C/man2/intro.2:83 build/C/man3/intro.3:91 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
1386 msgid "Authors and Copyright Conditions"
1390 #: build/C/man2/intro.2:87 build/C/man3/intro.3:95 build/C/man4/intro.4:37 build/C/man5/intro.5:37 build/C/man6/intro.6:35 build/C/man7/intro.7:40 build/C/man8/intro.8:47
1392 "Look at the header of the manual page source for the author(s) and copyright "
1393 "conditions. Note that these can be different from page to page!"
1397 #: build/C/man2/intro.2:109
1399 "B<_syscall>(2), B<syscall>(2), B<syscalls>(2), B<errno>(3), B<intro>(3), "
1400 "B<capabilities>(7), B<credentials>(7), B<feature_test_macros>(7), "
1401 "B<mq_overview>(7), B<path_resolution>(7), B<pipe>(7), B<pty>(7), "
1402 "B<sem_overview>(7), B<shm_overview>(7), B<signal>(7), B<socket>(7), "
1403 "B<standards>(7), B<svipc>(7), B<symlink>(7), B<time>(7)"
1407 #: build/C/man3/intro.3:27
1408 msgid "intro - Introduction to library functions"
1412 #: build/C/man3/intro.3:31
1414 "Section 3 of the manual describes all library functions excluding the "
1415 "library functions (system call wrappers) described in section 2, which "
1416 "implement system calls."
1420 #: build/C/man3/intro.3:48
1422 "Many of the functions described in the section are part of the Standard C "
1423 "Library (I<libc>). Some functions are part of other libraries (e.g., the "
1424 "math library, I<libm>, or the real-time library, I<librt>) in which case "
1425 "the manual page will indicate the linker option needed to link against the "
1426 "required library (e.g., I<-lm> and I<-lrt>, respectively, for the "
1427 "aforementioned libraries)."
1432 #. are various function groups which can be identified by a letter which
1433 #. is appended to the chapter number:
1435 #. These functions, the functions from chapter 2 and from chapter 3S are
1436 #. contained in the C standard library libc, which will be used by
1440 #. These functions are parts of the
1442 #. library. They are contained in the standard C library libc.
1444 #. These functions are contained in the arithmetic library libm. They are
1447 #. FORTRAN compiler by default, but not by the
1449 #. C compiler, which needs the option \fI\-lm\fP.
1451 #. These functions are part of the FORTRAN library libF77. There are no
1452 #. special compiler flags needed to use these functions.
1454 #. Various special libraries. The manual pages documenting their functions
1455 #. specify the library names.
1457 #: build/C/man3/intro.3:85
1459 "In some cases, the programmer must define a feature test macro in order to "
1460 "obtain the declaration of a function from the header file specified in the "
1461 "man page SYNOPSIS section. (Where required, these feature test macros must "
1462 "be defined before including I<any> header files.) In such cases, the "
1463 "required macro is described in the man page. For further information on "
1464 "feature test macros, see B<feature_test_macros>(7)."
1468 #: build/C/man3/intro.3:107
1470 "B<intro>(2), B<errno>(3), B<capabilities>(7), B<credentials>(7), "
1471 "B<environ>(7), B<feature_test_macros>(7), B<libc>(7), B<math_error>(7), "
1472 "B<path_resolution>(7), B<pthreads>(7), B<signal>(7), B<standards>(7)"
1476 #: build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28
1482 #: build/C/man4/intro.4:28
1483 msgid "intro - Introduction to special files"
1487 #: build/C/man4/intro.4:30
1488 msgid "Section 4 of the manual describes special files (devices)."
1492 #: build/C/man4/intro.4:30 build/C/man7/mailaddr.7:112 build/C/man7/man.7:472 build/C/man7/mdoc.7:409 build/C/man7/mdoc.samples.7:2863
1498 #: build/C/man4/intro.4:32
1499 msgid "/dev/* \\(em device files"
1503 #: build/C/man5/intro.5:29
1504 msgid "intro - Introduction to file formats"
1508 #: build/C/man5/intro.5:32
1510 "Section 5 of the manual describes various file formats and protocols, and "
1511 "the corresponding C structures, if any."
1515 #: build/C/man6/intro.6:28
1516 msgid "intro - Introduction to games"
1520 #: build/C/man6/intro.6:31
1522 "Section 6 of the manual describes all the games and funny little programs "
1523 "available on the system."
1527 #: build/C/man7/intro.7:30
1528 msgid "intro - Introduction to overview, conventions, and miscellany section"
1532 #: build/C/man7/intro.7:35
1534 "Section 7 of the manual provides overviews on various topics, and describes "
1535 "conventions and protocols, character set standards, the standard file system "
1536 "layout, and miscellaneous other things."
1540 #: build/C/man8/intro.8:31
1541 msgid "intro - Introduction to administration and privileged commands"
1545 #: build/C/man8/intro.8:36
1547 "Section 8 of the manual describes commands which either can be or are only "
1548 "used by the superuser, like system-administration commands, daemons, and "
1549 "hardware-related commands."
1553 #: build/C/man8/intro.8:43
1555 "As with the commands in described section 1, the commands described in this "
1556 "section terminate with an exit status that indicates whether the command "
1557 "succeeded or failed. See B<intro>(1) for more information."
1561 #: build/C/man7/libc.7:24
1567 #: build/C/man7/libc.7:24
1573 #: build/C/man7/libc.7:27
1574 msgid "libc - Overview of standard C libraries on Linux"
1578 #: build/C/man7/libc.7:34
1580 "The term \"libc\" is commonly used as a shorthand for the \"standard C "
1581 "library\", a library of standard functions that can be used by all C "
1582 "programs (and sometimes by programs in other languages). Because of some "
1583 "history (see below), use of the term \"libc\" to refer to the standard C "
1584 "library is somewhat ambiguous on Linux."
1588 #: build/C/man7/libc.7:34
1594 #: build/C/man7/libc.7:51
1596 "By far the most widely used C library on Linux is the GNU C Library "
1597 "(I<http://www.gnu.org/software/libc/>), often referred to as I<glibc>. This "
1598 "is the C library that is nowadays used in all major Linux distributions. It "
1599 "is also the C library whose details are documented in the relevant pages of "
1600 "the I<man-pages> project (primarily in Section 3 of the manual). "
1601 "Documentation of glibc is also available in the glibc manual, available via "
1602 "the command I<info libc>. Release 1.0 of glibc was made in September 1992. "
1603 "(There were earlier 0.x releases.) The next major release of glibc was 2.0, "
1604 "at the beginning of 1997."
1608 #: build/C/man7/libc.7:58
1610 "The pathname I</lib/libc.so.6> (or something similar) is normally a symbolic "
1611 "link that points to the location of the glibc library, and executing this "
1612 "pathname will cause glibc to display various information about the version "
1613 "installed on your system."
1617 #: build/C/man7/libc.7:58
1623 #: build/C/man7/libc.7:81
1625 "In the early to mid 1990s, there was for a while I<Linux libc>, a fork of "
1626 "glibc 1.x created by Linux developers who felt that glibc development at the "
1627 "time was not sufficing for the needs of Linux. Often, this library was "
1628 "referred to (ambiguously) as just \"libc\". Linux libc released major "
1629 "versions 2, 3, 4, and 5 (as well as many minor versions of those releases). "
1630 "For a while, Linux libc was the standard C library in many Linux "
1631 "distributions. However, notwithstanding the original motivations of the "
1632 "Linux libc effort, by the time glibc 2.0 was released, it was clearly "
1633 "superior to Linux libc, and all major Linux distributions that had been "
1634 "using Linux libc soon switched back to glibc. (Since this switch occurred "
1635 "over a decade ago, I<man-pages> no longer takes care to document Linux libc "
1636 "details. Nevertheless, the history is visible in vestiges of information "
1637 "about Linux libc that remain in some manual pages, in particular, references "
1638 "to I<libc4> and I<libc5>.)"
1642 #: build/C/man7/libc.7:81
1644 msgid "Other C libraries"
1648 #: build/C/man7/libc.7:96
1650 "There are various other less widely used C libraries for Linux. These "
1651 "libraries are generally smaller than glibc, both in terms of features and "
1652 "memory footprint, and often intended for building small binaries, perhaps "
1653 "targeted at development for embedded Linux systems. Among such libraries "
1654 "are I<uClibc> (I<http://www.uclibc.org/>) and I<dietlibc> "
1655 "(I<http://www.fefe.de/dietlibc/>). Details of these libraries are generally "
1656 "not covered by the I<man-pages> project."
1660 #: build/C/man7/libc.7:100
1661 msgid "B<syscalls>(2), B<feature_test_macros>(7), B<man-pages>(7), B<standards>(7)"
1665 #: build/C/man7/mailaddr.7:26
1671 #: build/C/man7/mailaddr.7:26
1677 #: build/C/man7/mailaddr.7:30
1678 msgid "mailaddr - mail addressing description"
1682 #: build/C/man7/mailaddr.7:35
1684 "This manual page gives a brief introduction to SMTP mail addresses, as used "
1685 "on the Internet. These addresses are in the general format"
1689 #: build/C/man7/mailaddr.7:37
1690 msgid " user@domain"
1694 #: build/C/man7/mailaddr.7:40
1696 "where a domain is a hierarchical dot-separated list of subdomains. These "
1697 "examples are valid forms of the same address:"
1701 #: build/C/man7/mailaddr.7:42
1702 msgid " eric@monet.berkeley.edu"
1706 #: build/C/man7/mailaddr.7:44
1707 msgid " Eric Allman E<lt>eric@monet.berkeley.eduE<gt>"
1711 #: build/C/man7/mailaddr.7:46
1712 msgid " eric@monet.berkeley.edu (Eric Allman)"
1716 #: build/C/man7/mailaddr.7:50
1718 "The domain part (\"monet.berkeley.edu\") is a mail-accepting domain. It can "
1719 "be a host and in the past it usually was, but it doesn't have to be. The "
1720 "domain part is not case sensitive."
1724 #: build/C/man7/mailaddr.7:58
1726 "The local part (\"eric\") is often a username, but its meaning is defined by "
1727 "the local software. Sometimes it is case sensitive, although that is "
1728 "unusual. If you see a local-part that looks like garbage, it is usually "
1729 "because of a gateway between an internal e-mail system and the net, here are "
1734 #: build/C/man7/mailaddr.7:60
1735 msgid " \"surname/admd=telemail/c=us/o=hp/prmd=hp\"@some.where"
1739 #: build/C/man7/mailaddr.7:62
1740 msgid " USER%SOMETHING@some.where"
1744 #: build/C/man7/mailaddr.7:64
1745 msgid " machine!machine!name@some.where"
1749 #: build/C/man7/mailaddr.7:66
1750 msgid " I2461572@some.where"
1754 #: build/C/man7/mailaddr.7:70
1756 "(These are, respectively, an X.400 gateway, a gateway to an arbitrary "
1757 "internal mail system that lacks proper internet support, an UUCP gateway, "
1758 "and the last one is just boring username policy.)"
1762 #: build/C/man7/mailaddr.7:76
1764 "The real-name part (\"Eric Allman\") can either be placed before E<lt>E<gt>, "
1765 "or in () at the end. (Strictly speaking the two aren't the same, but the "
1766 "difference is beyond the scope of this page.) The name may have to be "
1767 "quoted using \"\", for example, if it contains \".\":"
1771 #: build/C/man7/mailaddr.7:78
1772 msgid " \"Eric P. Allman\" E<lt>eric@monet.berkeley.eduE<gt>"
1776 #: build/C/man7/mailaddr.7:78
1778 msgid "Abbreviation."
1782 #: build/C/man7/mailaddr.7:86
1784 "Many mail systems let users abbreviate the domain name. For instance, users "
1785 "at berkeley.edu may get away with \"eric@monet\" to send mail to Eric "
1786 "Allman. I<This behavior is deprecated.> Sometimes it works, but you should "
1791 #: build/C/man7/mailaddr.7:86
1793 msgid "Route-addrs."
1797 #: build/C/man7/mailaddr.7:93
1799 "In the past, sometimes one had to route a message through several hosts to "
1800 "get it to its final destination. Addresses which show these relays are "
1801 "termed \"route-addrs\". These use the syntax:"
1805 #: build/C/man7/mailaddr.7:95
1806 msgid " E<lt>@hosta,@hostb:user@hostcE<gt>"
1810 #: build/C/man7/mailaddr.7:100
1812 "This specifies that the message should be sent to hosta, from there to "
1813 "hostb, and finally to hostc. Many hosts disregard route-addrs and send "
1814 "directly to hostc."
1818 #: build/C/man7/mailaddr.7:106
1820 "Route-addrs are very unusual now. They occur sometimes in old mail "
1821 "archives. It is generally possible to ignore all but the \"user@hostc\" "
1822 "part of the address to determine the actual address."
1826 #: build/C/man7/mailaddr.7:106
1832 #: build/C/man7/mailaddr.7:112
1834 "Every site is required to have a user or user alias designated "
1835 "\"postmaster\" to which problems with the mail system may be addressed. The "
1836 "\"postmaster\" address is not case sensitive."
1840 #: build/C/man7/mailaddr.7:114
1841 msgid "I</etc/aliases>"
1845 #: build/C/man7/mailaddr.7:116
1846 msgid "I<~/.forward>"
1850 #: build/C/man7/mailaddr.7:124
1852 "B<binmail>(1), B<mail>(1), B<mconnect>(1), B<aliases>(5), B<forward>(5), "
1853 "B<sendmail>(8), B<vrfy>(8)"
1857 #: build/C/man7/mailaddr.7:125
1858 msgid "RFC\\ 2822 (Internet Message Format)"
1862 #: build/C/man7/man-pages.7:28
1868 #: build/C/man7/man-pages.7:28
1874 #: build/C/man7/man-pages.7:31
1875 msgid "man-pages - conventions for writing Linux man pages"
1879 #: build/C/man7/man-pages.7:35 build/C/man7/man.7:47
1880 msgid "B<man> [I<section>] I<title>"
1884 #: build/C/man7/man-pages.7:41
1886 "This page describes the conventions that should be employed when writing man "
1887 "pages for the Linux I<man-pages> project, which comprises Sections 2, 3, 4, "
1888 "5, and 7 of the Linux manual pages. The conventions described on this page "
1889 "may also be useful for authors writing man pages for other projects."
1893 #: build/C/man7/man-pages.7:41
1895 msgid "Sections of the Manual Pages"
1899 #: build/C/man7/man-pages.7:44
1900 msgid "The manual Sections are traditionally defined as follows:"
1904 #: build/C/man7/man-pages.7:44
1906 msgid "B<1 Commands (Programs)>"
1910 #: build/C/man7/man-pages.7:48
1911 msgid "Those commands that can be executed by the user from within a shell."
1915 #: build/C/man7/man-pages.7:48
1917 msgid "B<2 System calls>"
1921 #: build/C/man7/man-pages.7:51
1922 msgid "Those functions which must be performed by the kernel."
1926 #: build/C/man7/man-pages.7:51
1928 msgid "B<3 Library calls>"
1932 #: build/C/man7/man-pages.7:56
1933 msgid "Most of the I<libc> functions."
1937 #: build/C/man7/man-pages.7:56
1939 msgid "B<4 Special files (devices)>"
1943 #: build/C/man7/man-pages.7:60
1944 msgid "Files found in I</dev>."
1948 #: build/C/man7/man-pages.7:60
1950 msgid "B<5 File formats and conventions>"
1954 #: build/C/man7/man-pages.7:65
1955 msgid "The format for I</etc/passwd> and other human-readable files."
1959 #: build/C/man7/man-pages.7:65
1965 #: build/C/man7/man-pages.7:67
1967 msgid "B<7 Conventions and miscellaneous>"
1971 #: build/C/man7/man-pages.7:71
1973 "Overviews of various topics, conventions and protocols, character set "
1974 "standards, and miscellaneous other things."
1978 #: build/C/man7/man-pages.7:71
1980 msgid "B<8 System management commands>"
1984 #. .B 9 Kernel routines
1985 #. This is an obsolete manual section.
1986 #. Once it was thought a good idea to document the Linux kernel here,
1987 #. but in fact very little has been documented, and the documentation
1988 #. that exists is outdated already.
1989 #. There are better sources of
1990 #. information for kernel developers.
1992 #: build/C/man7/man-pages.7:84
1993 msgid "Commands like B<mount>(8), many of which only root can execute."
1997 #: build/C/man7/man-pages.7:84
1999 msgid "Macro package"
2003 #: build/C/man7/man-pages.7:91
2005 "New manual pages should be marked up using the B<groff an.tmac> package "
2006 "described in B<man>(7). This choice is mainly for consistency: the vast "
2007 "majority of existing Linux manual pages are marked up using these macros."
2011 #: build/C/man7/man-pages.7:91
2013 msgid "Conventions for source file layout"
2017 #: build/C/man7/man-pages.7:96
2019 "Please limit source code line length to no more than about 75 characters "
2020 "wherever possible. This helps avoid line-wrapping in some mail clients when "
2021 "patches are submitted inline."
2025 #: build/C/man7/man-pages.7:100
2027 "New sentences should be started on new lines. This makes it easier to see "
2028 "the effect of patches, which often operate at the level of individual "
2033 #: build/C/man7/man-pages.7:100 build/C/man7/man.7:76
2039 #: build/C/man7/man-pages.7:102
2040 msgid "The first command in a man page should be a B<TH> command:"
2044 #: build/C/man7/man-pages.7:106 build/C/man7/man.7:83
2045 msgid "B<\\&.TH> I<title section date source manual>"
2049 #: build/C/man7/man-pages.7:109
2054 #: build/C/man7/man-pages.7:110
2060 #: build/C/man7/man-pages.7:114
2061 msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
2065 #: build/C/man7/man-pages.7:114
2071 #: build/C/man7/man-pages.7:118
2072 msgid "The section number in which the man page should be placed (e.g., I<7>)."
2076 #: build/C/man7/man-pages.7:118
2082 #: build/C/man7/man-pages.7:124
2084 "The date of the last revision\\(emremember to change this every time a "
2085 "change is made to the man page, since this is the most general way of doing "
2086 "version control. Dates should be written in the form YYYY-MM-DD."
2090 #: build/C/man7/man-pages.7:124
2096 #: build/C/man7/man-pages.7:127
2097 msgid "The source of the command, function, or system call."
2101 #: build/C/man7/man-pages.7:131
2103 "For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
2108 #: build/C/man7/man-pages.7:139
2110 "For system calls, just write I<Linux>. (An earlier practice was to write "
2111 "the version number of the kernel from which the manual page was being "
2112 "written/checked. However, this was never done consistently, and so was "
2113 "probably worse than including no version number. Henceforth, avoid "
2114 "including a version number.)"
2118 #: build/C/man7/man-pages.7:144
2120 "For library calls that are part of glibc or one of the other common GNU "
2121 "libraries, just use I<GNU C Library>, I<GNU>, or an empty string."
2125 #: build/C/man7/man-pages.7:147
2126 msgid "For Section 4 pages, use I<Linux>."
2130 #: build/C/man7/man-pages.7:150
2131 msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
2135 #: build/C/man7/man-pages.7:150
2141 #: build/C/man7/man-pages.7:155
2143 "The title of the manual (e.g., for Section 2 and 3 pages in the I<man-pages> "
2144 "package, use I<Linux Programmer's Manual>)."
2148 #: build/C/man7/man-pages.7:156
2150 msgid "Sections within a manual page"
2154 #: build/C/man7/man-pages.7:163
2156 "The list below shows conventional or suggested sections. Most manual pages "
2157 "should include at least the B<highlighted> sections. Arrange a new manual "
2158 "page so that sections are placed in the order shown in the list."
2161 #. May 07: Few current man pages have an ERROR HANDLING section,,,
2163 #. May 07: Almost no current man pages have a USAGE section,,,
2166 #. May 07: Almost no current man pages have a SECURITY section,,,
2168 #. AUTHORS sections are discouraged
2169 #. AUTHORS [Discouraged]
2171 #: build/C/man7/man-pages.7:191
2176 "CONFIGURATION [Normally only in Section 4]\n"
2178 "OPTIONS [Normally only in Sections 1, 8]\n"
2179 "EXIT STATUS [Normally only in Sections 1, 8]\n"
2180 "RETURN VALUE [Normally only in Sections 2, 3]\n"
2181 "ERRORS [Typically only in Sections 2, 3]\n"
2184 "VERSIONS [Normally only in Sections 2, 3]\n"
2193 #: build/C/man7/man-pages.7:202
2195 "I<Where a traditional heading would apply>, I<please use it>; this kind of "
2196 "consistency can make the information easier to understand. If you must, you "
2197 "can create your own headings if they make things easier to understand (this "
2198 "can be especially useful for pages in Sections 4 and 5). However, before "
2199 "doing this, consider whether you could use the traditional headings, with "
2200 "some subsections (I<.SS>) within those sections."
2204 #: build/C/man7/man-pages.7:205
2205 msgid "The following list elaborates on the contents of each of the above sections."
2209 #: build/C/man7/man-pages.7:205
2215 #: build/C/man7/man-pages.7:212
2217 "The name of this manual page. See B<man>(7) for important details of the "
2218 "line(s) that should follow the B<.SH NAME> command."
2222 #: build/C/man7/man-pages.7:212
2228 #: build/C/man7/man-pages.7:224
2230 "briefly describes the command or function's interface. For commands, this "
2231 "shows the syntax of the command and its arguments (including options); "
2232 "boldface is used for as-is text and italics are used to indicate replaceable "
2233 "arguments. Brackets ([]) surround optional arguments, vertical bars (|) "
2234 "separate choices, and ellipses (\\&...) can be repeated. For functions, it "
2235 "shows any required data declarations or B<#include> directives, followed by "
2236 "the function declaration."
2239 #. FIXME . Say something here about compiler options
2241 #: build/C/man7/man-pages.7:230
2243 "Where a feature test macro must be defined in order to obtain the "
2244 "declaration of a function (or a variable) from a header file, then the "
2245 "SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
2249 #: build/C/man7/man-pages.7:230
2251 msgid "B<CONFIGURATION>"
2255 #: build/C/man7/man-pages.7:234
2257 "Configuration details for a device. This section normally only appears in "
2262 #: build/C/man7/man-pages.7:234
2264 msgid "B<DESCRIPTION>"
2267 #. If there is some kind of input grammar or complex set of subcommands,
2268 #. consider describing them in a separate
2270 #. section (and just place an overview in the
2274 #: build/C/man7/man-pages.7:251
2276 "gives an explanation of what the program, function, or format does. Discuss "
2277 "how it interacts with files and standard input, and what it produces on "
2278 "standard output or standard error. Omit internals and implementation "
2279 "details unless they're critical for understanding the interface. Describe "
2280 "the usual case; for information on command-line options of a program use the "
2281 "B<OPTIONS> section."
2285 #: build/C/man7/man-pages.7:251
2292 #. describes the grammar of any sublanguage this implements.
2294 #: build/C/man7/man-pages.7:259
2296 "describes the command-line options accepted by a program and how they change "
2297 "its behavior. This section should only appear for Section 1 and 8 manual "
2302 #: build/C/man7/man-pages.7:259
2304 msgid "B<EXIT STATUS>"
2308 #: build/C/man7/man-pages.7:264
2310 "lists the possible exit status values of a program and the conditions that "
2311 "cause these values to be returned. This section should only appear for "
2312 "Section 1 and 8 manual pages."
2316 #: build/C/man7/man-pages.7:264
2318 msgid "B<RETURN VALUE>"
2322 #: build/C/man7/man-pages.7:269
2324 "For Section 2 and 3 pages, this section gives a list of the values the "
2325 "library routine will return to the caller and the conditions that cause "
2326 "these values to be returned."
2330 #: build/C/man7/man-pages.7:269
2336 #: build/C/man7/man-pages.7:277
2338 "For Section 2 and 3 manual pages, this is a list of the values that may be "
2339 "placed in I<errno> in the event of an error, along with information about "
2340 "the cause of the errors. I<The error list should be in alphabetical order>."
2344 #: build/C/man7/man-pages.7:277
2346 msgid "B<ENVIRONMENT>"
2350 #: build/C/man7/man-pages.7:281
2352 "lists all environment variables that affect the program or function and how "
2357 #: build/C/man7/man-pages.7:281
2362 #. May 07: Almost no current man pages have a DIAGNOSTICS section;
2363 #. "RETURN VALUE" or "EXIT STATUS" is preferred.
2366 #. gives an overview of the most common error messages and how to
2368 #. You don't need to explain system error messages
2369 #. or fatal signals that can appear during execution of any program
2370 #. unless they're special in some way to the program.
2372 #. May 07: Almost no current man pages have a SECURITY section.
2375 #. discusses security issues and implications.
2376 #. Warn about configurations or environments that should be avoided,
2377 #. commands that may have security implications, and so on, especially
2378 #. if they aren't obvious.
2379 #. Discussing security in a separate section isn't necessary;
2380 #. if it's easier to understand, place security information in the
2381 #. other sections (such as the
2386 #. However, please include security information somewhere!
2388 #: build/C/man7/man-pages.7:318
2390 "lists the files the program or function uses, such as configuration files, "
2391 "startup files, and files the program directly operates on. Give the full "
2392 "pathname of these files, and use the installation process to modify the "
2393 "directory part to match user preferences. For many programs, the default "
2394 "installation location is in I</usr/local>, so your base manual page should "
2395 "use I</usr/local> as the base."
2399 #: build/C/man7/man-pages.7:318
2405 #: build/C/man7/man-pages.7:335
2407 "A brief summary of the Linux kernel or glibc versions where a system call or "
2408 "library function appeared, or changed significantly in its operation. As a "
2409 "general rule, every new interface should include a VERSIONS section in its "
2410 "manual page. Unfortunately, many existing manual pages don't include this "
2411 "information (since there was no policy to do so when they were written). "
2412 "Patches to remedy this are welcome, but, from the perspective of programmers "
2413 "writing new code, this information probably only matters in the case of "
2414 "kernel interfaces that have been added in Linux 2.4 or later (i.e., changes "
2415 "since kernel 2.2), and library functions that have been added to glibc since "
2416 "version 2.1 (i.e., changes since glibc 2.0)."
2420 #: build/C/man7/man-pages.7:340
2422 "The B<syscalls>(2) manual page also provides information about kernel "
2423 "versions in which various system calls first appeared."
2427 #: build/C/man7/man-pages.7:340
2429 msgid "B<CONFORMING TO>"
2433 #: build/C/man7/man-pages.7:354
2435 "describes any standards or conventions that relate to the function or "
2436 "command described by the manual page. For a page in Section 2 or 3, this "
2437 "section should note the POSIX.1 version(s) that the call conforms to, and "
2438 "also whether the call is specified in C99. (Don't worry too much about "
2439 "other standards like SUS, SUSv2, and XPG, or the SVr4 and 4.xBSD "
2440 "implementation standards, unless the call was specified in those standards, "
2441 "but isn't in the current version of POSIX.1.) (See B<standards>(7).)"
2445 #: build/C/man7/man-pages.7:358
2447 "If the call is not governed by any standards but commonly exists on other "
2448 "systems, note them. If the call is Linux-specific, note this."
2452 #: build/C/man7/man-pages.7:362
2454 "If this section consists of just a list of standards (which it commonly "
2455 "does), terminate the list with a period (\\(aq.\\(aq)."
2459 #: build/C/man7/man-pages.7:362
2465 #: build/C/man7/man-pages.7:367
2467 "provides miscellaneous notes. For Section 2 and 3 man pages you may find it "
2468 "useful to include subsections (B<SS>) named I<Linux Notes> and I<Glibc "
2473 #: build/C/man7/man-pages.7:367
2479 #: build/C/man7/man-pages.7:371
2481 "lists limitations, known defects or inconveniences, and other questionable "
2486 #: build/C/man7/man-pages.7:371
2492 #: build/C/man7/man-pages.7:377
2494 "provides one or more examples describing how this function, file or command "
2495 "is used. For details on writing example programs, see I<Example Programs> "
2500 #: build/C/man7/man-pages.7:377
2506 #: build/C/man7/man-pages.7:387
2508 "lists authors of the documentation or program. B<Use of an AUTHORS section "
2509 "is strongly discouraged>. Generally, it is better not to clutter every page "
2510 "with a list of (over time potentially numerous) authors; if you write or "
2511 "significantly amend a page, add a copyright notice as a comment in the "
2512 "source file. If you are the author of a device driver and want to include "
2513 "an address for reporting bugs, place this under the BUGS section."
2517 #: build/C/man7/man-pages.7:387
2523 #: build/C/man7/man-pages.7:394
2525 "provides a comma-separated list of related man pages, ordered by section "
2526 "number and then alphabetically by name, possibly followed by other related "
2527 "pages or documents. Do not terminate this with a period."
2531 #: build/C/man7/man-pages.7:394
2533 msgid "Font conventions"
2537 #: build/C/man7/man-pages.7:399
2539 "For functions, the arguments are always specified using italics, I<even in "
2540 "the SYNOPSIS section>, where the rest of the function is specified in bold:"
2544 #: build/C/man7/man-pages.7:401
2545 msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
2549 #: build/C/man7/man-pages.7:403
2550 msgid "Variable names should, like argument names, be specified in italics."
2554 #: build/C/man7/man-pages.7:416
2556 "Filenames (whether pathnames, or references to files in the I</usr/include> "
2557 "directory) are always in italics (e.g., I<E<lt>stdio.hE<gt>>), except in "
2558 "the SYNOPSIS section, where included files are in bold (e.g., B<#include "
2559 "E<lt>stdio.hE<gt>>). When referring to a standard include file under "
2560 "I</usr/include>, specify the header file surrounded by angle brackets, in "
2561 "the usual C way (e.g., I<E<lt>stdio.hE<gt>>)."
2565 #: build/C/man7/man-pages.7:420
2567 "Special macros, which are usually in upper case, are in bold (e.g., "
2568 "B<MAXINT>). Exception: don't boldface NULL."
2572 #: build/C/man7/man-pages.7:425
2574 "When enumerating a list of error codes, the codes are in bold (this list "
2575 "usually uses the B<\\&.TP> macro)."
2579 #: build/C/man7/man-pages.7:428
2581 "Complete commands should, if long, be written as in an indented line on "
2582 "their own, for example"
2586 #: build/C/man7/man-pages.7:432
2588 msgid "man 7 man-pages\n"
2592 #: build/C/man7/man-pages.7:442
2594 "If the command is short, then it can be included inline in the text, in "
2595 "italic format, for example, I<man 7 man-pages>. In this case, it may be "
2596 "worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
2597 "command. Command options should be written in italics, e.g., I<-l>."
2601 #: build/C/man7/man-pages.7:447
2603 "Expressions, if not written on a separate indented line, should be specified "
2604 "in italics. Again, the use of nonbreaking spaces may be appropriate if the "
2605 "expression is inlined with normal text."
2609 #: build/C/man7/man-pages.7:458
2611 "Any reference to the subject of the current manual page should be written "
2612 "with the name in bold. If the subject is a function (i.e., this is a "
2613 "Section 2 or 3 page), then the name should be followed by a pair of "
2614 "parentheses in Roman (normal) font. For example, in the B<fcntl>(2) man "
2615 "page, references to the subject of the page would be written as: "
2616 "B<fcntl>(). The preferred way to write this in the source file is:"
2620 #: build/C/man7/man-pages.7:461
2622 msgid " .BR fcntl ()\n"
2626 #: build/C/man7/man-pages.7:465
2628 "(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
2629 "easier to write tools that parse man page source files.)"
2633 #: build/C/man7/man-pages.7:473
2635 "Any reference to another man page should be written with the name in bold, "
2636 "I<always> followed by the section number, formatted in Roman (normal) font, "
2637 "without any separating spaces (e.g., B<intro>(2)). The preferred way to "
2638 "write this in the source file is:"
2642 #: build/C/man7/man-pages.7:476
2644 msgid " .BR intro (2)\n"
2648 #: build/C/man7/man-pages.7:481
2650 "(Including the section number in cross references lets tools like "
2651 "B<man2html>(1) create properly hyperlinked pages.)"
2655 #: build/C/man7/man-pages.7:481
2661 #: build/C/man7/man-pages.7:486
2663 "Starting with release 2.59, I<man-pages> follows American spelling "
2664 "conventions; please write all new pages and patches according to these "
2669 #: build/C/man7/man-pages.7:486
2671 msgid "Example Programs and Shell Sessions"
2675 #: build/C/man7/man-pages.7:490
2677 "Manual pages can include example programs demonstrating how to use a system "
2678 "call or library function. However, note the following:"
2682 #: build/C/man7/man-pages.7:493
2683 msgid "Example programs should be written in C."
2687 #: build/C/man7/man-pages.7:500
2689 "An example program is only necessary and useful if it demonstrates something "
2690 "beyond what can easily be provided in a textual description of the "
2691 "interface. An example program that does nothing other than call an "
2692 "interface usually serves little purpose."
2696 #: build/C/man7/man-pages.7:504
2698 "Example programs should be fairly short (preferably less than 100 lines; "
2699 "ideally less than 50 lines)."
2703 #: build/C/man7/man-pages.7:508
2705 "Example programs should do error checking after system calls and library "
2710 #: build/C/man7/man-pages.7:512
2712 "Example programs should be complete, and compile without warnings when "
2713 "compiled with I<cc\\ -Wall>."
2717 #: build/C/man7/man-pages.7:518
2719 "Where possible and appropriate, example programs should allow "
2720 "experimentation, by varying their behavior based on inputs (ideally from "
2721 "command-line arguments, or alternatively, via input read by the program)."
2725 #: build/C/man7/man-pages.7:523
2727 "Example programs should be laid out according to Kernighan and Ritchie "
2728 "style, with 4-space indents. (Avoid the use of TAB characters in source "
2733 #: build/C/man7/man-pages.7:528
2735 "For some examples of what example programs should look like, see B<wait>(2) "
2740 #: build/C/man7/man-pages.7:532
2742 "If you include a shell session demonstrating the use of a program or other "
2743 "system feature, boldface the user input text, to distinguish it from output "
2744 "produced by the system."
2748 #: build/C/man7/man-pages.7:532
2750 msgid "Indentation of structure definitions, shell session logs, etc."
2754 #: build/C/man7/man-pages.7:538
2756 "When structure definitions, shell session logs, etc. are included in running "
2757 "text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ +4n> and "
2762 #: build/C/man7/man-pages.7:545
2764 "For canonical examples of how man pages in the I<man-pages> package should "
2765 "look, see B<pipe>(2) and B<fcntl>(2)."
2769 #: build/C/man7/man-pages.7:551
2771 "B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
2776 #: build/C/man7/man.7:32
2782 #: build/C/man7/man.7:32
2788 #: build/C/man7/man.7:35
2789 msgid "man - macros to format man pages"
2793 #: build/C/man7/man.7:39
2794 msgid "B<groff -Tascii -man> I<file> \\&..."
2798 #: build/C/man7/man.7:43
2799 msgid "B<groff -Tps -man> I<file> \\&..."
2803 #: build/C/man7/man.7:60
2805 "This manual page explains the B<groff an.tmac> macro package (often called "
2806 "the B<man> macro package). This macro package should be used by developers "
2807 "when writing or porting man pages for Linux. It is fairly compatible with "
2808 "other versions of this macro package, so porting man pages should not be a "
2809 "major problem (exceptions include the NET-2 BSD release, which uses a "
2810 "totally different macro package called mdoc; see B<mdoc>(7))."
2814 #: build/C/man7/man.7:72
2816 "Note that NET-2 BSD mdoc man pages can be used with B<groff> simply by "
2817 "specifying the B<-mdoc> option instead of the B<-man> option. Using the "
2818 "B<-mandoc> option is, however, recommended, since this will automatically "
2819 "detect which macro package is in use."
2823 #: build/C/man7/man.7:76
2825 "For conventions that should be employed when writing man pages for the Linux "
2826 "I<man-pages> package, see B<man-pages>(7)."
2830 #: build/C/man7/man.7:79
2832 "The first command in a man page (after comment lines, that is, lines that "
2833 "start with B<.\\e\">) should be"
2837 #: build/C/man7/man.7:88
2839 "For details of the arguments that should be supplied to the B<TH> command, "
2840 "see B<man-pages>(7)."
2844 #: build/C/man7/man.7:94
2846 "Note that BSD mdoc-formatted pages begin with the B<Dd> command, not the "
2851 #: build/C/man7/man.7:94
2856 #. The following doesn't seem to be required (see Debian bug 411303),
2857 #. If the name contains spaces and appears
2858 #. on the same line as
2860 #. then place the heading in double quotes.
2862 #: build/C/man7/man.7:103
2863 msgid "Sections are started with B<\\&.SH> followed by the heading name."
2867 #: build/C/man7/man.7:106
2869 "The only mandatory heading is NAME, which should be the first section and be "
2870 "followed on the next line by a one-line description of the program:"
2874 #: build/C/man7/man.7:109
2879 #: build/C/man7/man.7:111
2880 msgid "item \\e- description"
2884 #: build/C/man7/man.7:125
2886 "It is extremely important that this format is followed, and that there is a "
2887 "backslash before the single dash which follows the item name. This syntax "
2888 "is used by the B<mandb>(8) program to create a database of short "
2889 "descriptions for the B<whatis>(1) and B<apropos>(1) commands. (See "
2890 "B<lexgrog>(1) for further details on the syntax of the NAME section.)"
2894 #: build/C/man7/man.7:128
2896 "For a list of other sections that might appear in a manual page, see "
2901 #: build/C/man7/man.7:128
2907 #: build/C/man7/man.7:130
2908 msgid "The commands to select the type face are:"
2912 #: build/C/man7/man.7:130
2918 #: build/C/man7/man.7:133
2923 #: build/C/man7/man.7:133
2929 #: build/C/man7/man.7:137
2931 "Bold alternating with italics (especially useful for function "
2936 #: build/C/man7/man.7:137
2942 #: build/C/man7/man.7:142
2944 "Bold alternating with Roman (especially useful for referring to other manual "
2949 #: build/C/man7/man.7:142
2955 #: build/C/man7/man.7:145
2960 #: build/C/man7/man.7:145
2966 #: build/C/man7/man.7:148
2967 msgid "Italics alternating with bold"
2971 #: build/C/man7/man.7:148
2977 #: build/C/man7/man.7:151
2978 msgid "Italics alternating with Roman"
2982 #: build/C/man7/man.7:151
2988 #: build/C/man7/man.7:154
2989 msgid "Roman alternating with bold"
2993 #: build/C/man7/man.7:154
2999 #: build/C/man7/man.7:157
3000 msgid "Roman alternating with italics"
3004 #: build/C/man7/man.7:157
3010 #: build/C/man7/man.7:160
3011 msgid "Small alternating with bold"
3015 #: build/C/man7/man.7:160
3021 #: build/C/man7/man.7:163
3022 msgid "Small (useful for acronyms)"
3026 #: build/C/man7/man.7:176
3028 "Traditionally, each command can have up to six arguments, but the GNU "
3029 "implementation removes this limitation (you might still want to limit "
3030 "yourself to 6 arguments for portability's sake). Arguments are delimited by "
3031 "spaces. Double quotes can be used to specify an argument which contains "
3032 "spaces. All of the arguments will be printed next to each other without "
3033 "intervening spaces, so that the B<\\&.BR> command can be used to specify a "
3034 "word in bold followed by a mark of punctuation in Roman. If no arguments "
3035 "are given, the command is applied to the following line of text."
3039 #: build/C/man7/man.7:176
3041 msgid "Other Macros and Strings"
3045 #: build/C/man7/man.7:196
3047 "Below are other relevant macros and predefined strings. Unless noted "
3048 "otherwise, all macros cause a break (end the current line of text). Many of "
3049 "these macros set or use the \"prevailing indent.\" The \"prevailing indent\" "
3050 "value is set by any macro with the parameter I<i> below; macros may omit "
3051 "I<i> in which case the current prevailing indent will be used. As a result, "
3052 "successive indented paragraphs can use the same indent without respecifying "
3053 "the indent value. A normal (nonindented) paragraph resets the prevailing "
3054 "indent value to its default value (0.5 inches). By default a given indent "
3055 "is measured in ens; try to use ens or ems as units for indents, since these "
3056 "will automatically adjust to font size changes. The other key macro "
3061 #: build/C/man7/man.7:196
3063 msgid "Normal Paragraphs"
3067 #: build/C/man7/man.7:197
3073 #: build/C/man7/man.7:202 build/C/man7/man.7:207
3074 msgid "Same as B<\\&.PP> (begin a new paragraph)."
3078 #: build/C/man7/man.7:202
3084 #: build/C/man7/man.7:207
3090 #: build/C/man7/man.7:210
3091 msgid "Begin a new paragraph and reset prevailing indent."
3095 #: build/C/man7/man.7:210
3097 msgid "Relative Margin Indent"
3101 #: build/C/man7/man.7:211
3103 msgid "B<\\&.RS>I< i>"
3107 #: build/C/man7/man.7:222
3109 "Start relative margin indent: moves the left margin I<i> to the right (if "
3110 "I<i> is omitted, the prevailing indent value is used). A new prevailing "
3111 "indent is set to 0.5 inches. As a result, all following paragraph(s) will "
3112 "be indented until the corresponding B<\\&.RE>."
3116 #: build/C/man7/man.7:222
3122 #: build/C/man7/man.7:226
3124 "End relative margin indent and restores the previous value of the prevailing "
3129 #: build/C/man7/man.7:226
3131 msgid "Indented Paragraph Macros"
3135 #: build/C/man7/man.7:227
3137 msgid "B<\\&.HP>I< i>"
3141 #: build/C/man7/man.7:232
3143 "Begin paragraph with a hanging indent (the first line of the paragraph is at "
3144 "the left margin of normal paragraphs, and the rest of the paragraph's lines "
3149 #: build/C/man7/man.7:232
3151 msgid "B<\\&.IP>I< x i>"
3155 #: build/C/man7/man.7:253
3157 "Indented paragraph with optional hanging tag. If the tag I<x> is omitted, "
3158 "the entire following paragraph is indented by I<i>. If the tag I<x> is "
3159 "provided, it is hung at the left margin before the following indented "
3160 "paragraph (this is just like B<\\&.TP> except the tag is included with the "
3161 "command instead of being on the following line). If the tag is too long, "
3162 "the text after the tag will be moved down to the next line (text will not be "
3163 "lost or garbled). For bulleted lists, use this macro with \\e(bu (bullet) "
3164 "or \\e(em (em dash) as the tag, and for numbered lists, use the number or "
3165 "letter followed by a period as the tag; this simplifies translation to other "
3170 #: build/C/man7/man.7:253
3172 msgid "B<\\&.TP>I< i>"
3176 #: build/C/man7/man.7:260
3178 "Begin paragraph with hanging tag. The tag is given on the next line, but "
3179 "its results are like those of the B<\\&.IP> command."
3183 #: build/C/man7/man.7:260
3185 msgid "Hypertext Link Macros"
3189 #: build/C/man7/man.7:270
3191 "(Feature supported with B<groff> only.) In order to use hypertext link "
3192 "macros, it is necessary to load the B<www.tmac> macro package. Use the "
3193 "request B<.mso www.tmac> to do this."
3197 #: build/C/man7/man.7:270
3199 msgid "B<\\&.URL>I< url link trailer>"
3202 #. The following is a kludge to get a paragraph into the listing.
3204 #: build/C/man7/man.7:283
3206 "Inserts a hypertext link to the URI (URL) I<url>, with I<link> as the text "
3207 "of the link. The I<trailer> will be printed immediately afterward. When "
3208 "generating HTML this should translate into the HTML command B<E<lt>A "
3209 "HREF=\">I<url>B<\"E<gt>>I<link>B<E<lt>/AE<gt>>I<trailer>B<.>"
3212 #. The following is a kludge to get a paragraph into the listing.
3214 #: build/C/man7/man.7:290
3216 "This and other related macros are new, and many tools won't do anything with "
3217 "them, but since many tools (including troff) will simply ignore undefined "
3218 "macros (or at worst insert their text) these are safe to insert."
3221 #. The following is a kludge to get a paragraph into the listing.
3223 #: build/C/man7/man.7:299
3225 "It can be useful to define your own B<URL> macro in manual pages for the "
3226 "benefit of those viewing it with a roff viewer other than B<groff>. That "
3227 "way, the URL, link text, and trailer text (if any) are still visible."
3231 #: build/C/man7/man.7:302
3232 msgid "Here's an example:"
3236 #: build/C/man7/man.7:304
3241 #: build/C/man7/man.7:306
3242 msgid "\\e\\e$2 \\e(laURL: \\e\\e$1 \\e(ra\\e\\e$3"
3246 #: build/C/man7/man.7:308
3251 #: build/C/man7/man.7:310
3252 msgid "\\&.if \\en[.g] .mso www.tmac"
3256 #: build/C/man7/man.7:313
3257 msgid "\\&.TH I<...>"
3261 #: build/C/man7/man.7:315
3262 msgid "I<(later in the page)>"
3266 #: build/C/man7/man.7:317
3267 msgid "This software comes from the"
3271 #: build/C/man7/man.7:319
3272 msgid "\\&.URL \"http://www.gnu.org/\" \"GNU Project\" \" of the\""
3276 #: build/C/man7/man.7:321
3277 msgid "\\&.URL \"http://www.fsf.org/\" \"Free Software Foundation\" ."
3281 #: build/C/man7/man.7:331
3283 "In the above, if B<groff> is being used, the B<www.tmac> macro package's "
3284 "definition of the URL macro will supersede the locally defined one."
3288 #: build/C/man7/man.7:336
3290 "A number of other link macros are available. See B<groff_www>(7) for more "
3295 #: build/C/man7/man.7:336
3297 msgid "Miscellaneous Macros"
3301 #: build/C/man7/man.7:337
3307 #: build/C/man7/man.7:341
3308 msgid "Reset tabs to default tab values (every 0.5 inches); does not cause a break."
3312 #: build/C/man7/man.7:341
3314 msgid "B<\\&.PD>I< d>"
3318 #: build/C/man7/man.7:346
3320 "Set inter-paragraph vertical distance to d (if omitted, d=0.4v); does not "
3325 #: build/C/man7/man.7:346
3327 msgid "B<\\&.SS>I< t>"
3331 #: build/C/man7/man.7:353
3333 "Subheading I<t> (like B<\\&.SH>, but used for a subsection inside a "
3338 #: build/C/man7/man.7:353
3340 msgid "Predefined Strings"
3344 #: build/C/man7/man.7:357
3345 msgid "The B<man> package has the following predefined strings:"
3349 #: build/C/man7/man.7:357
3355 #: build/C/man7/man.7:359
3356 msgid "Registration Symbol: \\*R"
3360 #: build/C/man7/man.7:359
3366 #: build/C/man7/man.7:361
3367 msgid "Change to default font size"
3371 #: build/C/man7/man.7:361
3377 #: build/C/man7/man.7:363
3378 msgid "Trademark Symbol: \\*(Tm"
3382 #: build/C/man7/man.7:363
3388 #: build/C/man7/man.7:365
3389 msgid "Left angled double quote: ``"
3393 #: build/C/man7/man.7:365
3399 #: build/C/man7/man.7:367
3400 msgid "Right angled double quote: ''"
3404 #: build/C/man7/man.7:367
3410 #: build/C/man7/man.7:411
3412 "Although technically B<man> is a troff macro package, in reality a large "
3413 "number of other tools process man page files that don't implement all of "
3414 "troff's abilities. Thus, it's best to avoid some of troff's more exotic "
3415 "abilities where possible to permit these other tools to work correctly. "
3416 "Avoid using the various troff preprocessors (if you must, go ahead and use "
3417 "B<tbl>(1), but try to use the B<IP> and B<TP> commands instead for "
3418 "two-column tables). Avoid using computations; most other tools can't "
3419 "process them. Use simple commands that are easy to translate to other "
3420 "formats. The following troff macros are believed to be safe (though in many "
3421 "cases they will be ignored by translators): B<\\e\">, B<.>, B<ad>, B<bp>, "
3422 "B<br>, B<ce>, B<de>, B<ds>, B<el>, B<ie>, B<if>, B<fi>, B<ft>, B<hy>, B<ig>, "
3423 "B<in>, B<na>, B<ne>, B<nf>, B<nh>, B<ps>, B<so>, B<sp>, B<ti>, B<tr>."
3427 #: build/C/man7/man.7:434
3429 "You may also use many troff escape sequences (those sequences beginning with "
3430 "\\e). When you need to include the backslash character as normal text, use "
3431 "\\ee. Other sequences you may use, where x or xx are any characters and N "
3432 "is any digit, include: B<\\e'>, B<\\e`>, B<\\e->, B<\\e.>, B<\\e\">, "
3433 "B<\\e%>, B<\\e*x>, B<\\e*(xx>, B<\\e(xx>, B<\\e$N>, B<\\enx>, B<\\en(xx>, "
3434 "B<\\efx>, and B<\\ef(xx>. Avoid using the escape sequences for drawing "
3439 #: build/C/man7/man.7:465
3441 "Do not use the optional parameter for B<bp> (break page). Use only positive "
3442 "values for B<sp> (vertical space). Don't define a macro (B<de>) with the "
3443 "same name as a macro in this or the mdoc macro package with a different "
3444 "meaning; it's likely that such redefinitions will be ignored. Every "
3445 "positive indent (B<in>) should be paired with a matching negative indent "
3446 "(although you should be using the B<RS> and B<RE> macros instead). The "
3447 "condition test (B<if,ie>) should only have \\(aqt\\(aq or \\(aqn\\(aq as "
3448 "the condition. Only translations (B<tr>) that can be ignored should be "
3449 "used. Font changes (B<ft> and the B<\\ef> escape sequence) should only "
3450 "have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have "
3455 #: build/C/man7/man.7:472
3457 "If you use capabilities beyond these, check the results carefully on several "
3458 "tools. Once you've confirmed that the additional capability is safe, let "
3459 "the maintainer of this document know about the safe command or sequence that "
3460 "should be added to this list."
3464 #: build/C/man7/man.7:474
3465 msgid "I</usr/share/groff/>[*/]I<tmac/an.tmac>"
3469 #: build/C/man7/man.7:476
3470 msgid "I</usr/man/whatis>"
3474 #: build/C/man7/man.7:488
3476 "By all means include full URLs (or URIs) in the text itself; some tools such "
3477 "as B<man2html>(1) can automatically turn them into hypertext links. You "
3478 "can also use the new B<URL> macro to identify links to related information. "
3479 "If you include URLs, use the full URL (e.g., "
3480 "E<lt>http://www.kernelnotes.orgE<gt>) to ensure that tools can automatically "
3485 #: build/C/man7/man.7:497
3487 "Tools processing these files should open the file and examine the first "
3488 "nonwhitespace character. A period (.) or single quote (') at the beginning "
3489 "of a line indicates a troff-based file (such as man or mdoc). A left angle "
3490 "bracket (E<lt>) indicates an SGML/XML-based file (such as HTML or Docbook). "
3491 "Anything else suggests simple ASCII text (e.g., a \"catman\" result)."
3495 #: build/C/man7/man.7:508
3497 "Many man pages begin with B<\\'\\e\"> followed by a space and a list of "
3498 "characters, indicating how the page is to be preprocessed. For "
3499 "portability's sake to non-troff translators we recommend that you avoid "
3500 "using anything other than B<tbl>(1), and Linux can detect that "
3501 "automatically. However, you might want to include this information so your "
3502 "man page can be handled by other (less capable) systems. Here are the "
3503 "definitions of the preprocessors invoked by these characters:"
3507 #: build/C/man7/man.7:508
3513 #: build/C/man7/man.7:511
3518 #: build/C/man7/man.7:511
3524 #: build/C/man7/man.7:514
3529 #: build/C/man7/man.7:514
3535 #: build/C/man7/man.7:517
3540 #: build/C/man7/man.7:517
3546 #: build/C/man7/man.7:520
3551 #: build/C/man7/man.7:520
3557 #: build/C/man7/man.7:523
3562 #: build/C/man7/man.7:523
3568 #: build/C/man7/man.7:526
3573 #: build/C/man7/man.7:526 build/C/man7/suffixes.7:277 build/C/man7/mdoc.samples.7:2872
3579 #: build/C/man7/man.7:539
3581 "Most of the macros describe formatting (e.g., font type and spacing) instead "
3582 "of marking semantic content (e.g., this text is a reference to another "
3583 "page), compared to formats like mdoc and DocBook (even HTML has more "
3584 "semantic markings). This situation makes it harder to vary the B<man> "
3585 "format for different media, to make the formatting consistent for a given "
3586 "media, and to automatically insert cross-references. By sticking to the "
3587 "safe subset described above, it should be easier to automate transitioning "
3588 "to a different reference page format in the future."
3593 #. James Clark (jjc@jclark.com) wrote the implementation of the macro package.
3595 #. Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
3596 #. this manual page.
3598 #. Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
3599 #. (which influenced this manual page).
3601 #. David A. Wheeler (dwheeler@ida.org) heavily modified this
3602 #. manual page, such as adding detailed information on sections and macros.
3604 #: build/C/man7/man.7:555
3605 msgid "The Sun macro B<TX> is not implemented."
3609 #: build/C/man7/man.7:566
3611 "B<apropos>(1), B<groff>(1), B<lexgrog>(1), B<man>(1), B<man2html>(1), "
3612 "B<whatis>(1), B<groff_man>(7), B<groff_www>(7), B<man-pages>(7), B<mdoc>(7), "
3613 "B<mdoc.samples>(7)"
3617 #: build/C/man7/mdoc.7:40
3619 msgid "July 11, 1999"
3623 #: build/C/man7/mdoc.7:41
3629 #: build/C/man7/mdoc.7:45
3634 #: build/C/man7/mdoc.7:45
3636 msgid "quick reference guide for the"
3640 #: build/C/man7/mdoc.7:48
3641 msgid "E<.Nm \\-mdoc> macro package"
3645 #: build/C/man7/mdoc.7:52
3646 msgid "E<.Nm groff> E<.Fl m Ns Ar doc> E<.Ar files ...>"
3650 #: build/C/man7/mdoc.7:64
3652 "The E<.Nm \\-mdoc> package is a set of content-based and domain-based macros "
3653 "used to format the E<.Bx> man pages. The macro names and their meanings are "
3654 "listed below for quick reference; for a detailed explanation on using the "
3655 "package, see the tutorial sampler E<.Xr mdoc.samples 7>."
3659 #: build/C/man7/mdoc.7:69
3661 "Note that this is not the usual macro package for Linux documentation, "
3662 "although it is used for documentation of several widely used programs; see "
3667 #: build/C/man7/mdoc.7:78
3669 "The macros are described in two groups, the first includes the structural "
3670 "and physical page layout macros. The second contains the manual and general "
3671 "text domain macros which differentiate the E<.Nm \\-mdoc> package from other "
3672 "E<.Xr troff> formatting packages."
3676 #: build/C/man7/mdoc.7:78 build/C/man7/mdoc.samples.7:1804
3678 msgid "PAGE STRUCTURE DOMAIN"
3682 #: build/C/man7/mdoc.7:79
3684 msgid "Title Macros"
3688 #: build/C/man7/mdoc.7:82
3690 "To create a valid manual page, these three macros, in this order, are "
3695 #: build/C/man7/mdoc.7:83
3697 msgid "Li \"\\&.Dd \" Ar \"Month day, year\""
3701 #: build/C/man7/mdoc.7:85
3702 msgid "Document date."
3706 #: build/C/man7/mdoc.7:85
3708 msgid "Li \"\\&.Dt \" Ar \"DOCUMENT_TITLE [section] [volume]\""
3712 #: build/C/man7/mdoc.7:87
3713 msgid "Title, in upper case."
3717 #: build/C/man7/mdoc.7:87
3719 msgid "Li \"\\&.Os \" Ar \"OPERATING_SYSTEM [version/release]\""
3723 #: build/C/man7/mdoc.7:90
3724 msgid "Operating system E<.Pq Tn BSD>."
3728 #: build/C/man7/mdoc.7:91
3730 msgid "Page Layout Macros"
3734 #: build/C/man7/mdoc.7:93
3735 msgid "Section headers, paragraph breaks, lists and displays."
3739 #: build/C/man7/mdoc.7:94
3745 #: build/C/man7/mdoc.7:97
3746 msgid "Section Headers. Valid headers, in the order of presentation:"
3750 #: build/C/man7/mdoc.7:98
3756 #: build/C/man7/mdoc.7:106
3758 "Name section, should include the E<.Ql \\&.Nm> or E<.Ql \\&.Fn> and the "
3759 "E<.Ql \\&.Nd> macros."
3763 #: build/C/man7/mdoc.7:106
3769 #: build/C/man7/mdoc.7:108
3774 #: build/C/man7/mdoc.7:108
3776 msgid "Ar DESCRIPTION"
3780 #: build/C/man7/mdoc.7:111
3781 msgid "General description, should include options and parameters."
3785 #: build/C/man7/mdoc.7:111
3787 msgid "Ar RETURN VALUE"
3791 #: build/C/man7/mdoc.7:113
3792 msgid "Sections two and three function calls."
3796 #: build/C/man7/mdoc.7:113
3798 msgid "Ar ENVIRONMENT"
3802 #: build/C/man7/mdoc.7:115
3803 msgid "Describe environment variables."
3807 #: build/C/man7/mdoc.7:115
3813 #: build/C/man7/mdoc.7:117
3814 msgid "Files associated with the subject."
3818 #: build/C/man7/mdoc.7:117
3824 #: build/C/man7/mdoc.7:119
3825 msgid "Examples and suggestions."
3829 #: build/C/man7/mdoc.7:119
3831 msgid "Ar DIAGNOSTICS"
3835 #: build/C/man7/mdoc.7:121
3836 msgid "Normally used for section four device interface diagnostics."
3840 #: build/C/man7/mdoc.7:121
3846 #: build/C/man7/mdoc.7:124
3847 msgid "Sections two and three error and signal handling."
3851 #: build/C/man7/mdoc.7:124
3857 #: build/C/man7/mdoc.7:126
3858 msgid "Cross references and citations."
3862 #: build/C/man7/mdoc.7:126
3864 msgid "Ar CONFORMING TO"
3868 #: build/C/man7/mdoc.7:128
3869 msgid "Conformance to standards if applicable."
3873 #: build/C/man7/mdoc.7:128
3879 #: build/C/man7/mdoc.7:131
3880 msgid "If a standard is not applicable, the history of the subject should be given."
3884 #: build/C/man7/mdoc.7:131
3890 #: build/C/man7/mdoc.7:133
3891 msgid "Gotchas and caveats."
3895 #: build/C/man7/mdoc.7:133
3901 #: build/C/man7/mdoc.7:136
3902 msgid "Customized headers may be added at the authors discretion."
3906 #: build/C/man7/mdoc.7:137
3912 #: build/C/man7/mdoc.7:139
3913 msgid "Subsection Headers."
3917 #: build/C/man7/mdoc.7:139
3923 #: build/C/man7/mdoc.7:142
3924 msgid "Paragraph Break. Vertical space (one line)."
3928 #: build/C/man7/mdoc.7:142 build/C/man7/mdoc.samples.7:2191
3934 #: build/C/man7/mdoc.7:145
3935 msgid "(D-one) Display-one Indent and display one text line."
3939 #: build/C/man7/mdoc.7:145 build/C/man7/mdoc.samples.7:2199
3945 #: build/C/man7/mdoc.7:148
3946 msgid "(D-ell) Display-one literal. Indent and display one line of literal text."
3950 #: build/C/man7/mdoc.7:148 build/C/man7/mdoc.samples.7:2219
3956 #: build/C/man7/mdoc.7:151
3957 msgid "Begin-display block. Display options:"
3961 #: build/C/man7/mdoc.7:152 build/C/man7/mdoc.samples.7:2238
3967 #: build/C/man7/mdoc.7:154
3968 msgid "Unjustified (ragged edges)."
3972 #: build/C/man7/mdoc.7:154 build/C/man7/mdoc.samples.7:2241
3978 #: build/C/man7/mdoc.7:156
3983 #: build/C/man7/mdoc.7:156 build/C/man7/mdoc.samples.7:2245
3989 #: build/C/man7/mdoc.7:158
3990 msgid "Literal text or code."
3994 #: build/C/man7/mdoc.7:158
3996 msgid "Fl file Ar name"
4000 #: build/C/man7/mdoc.7:162
4001 msgid "Read in named E<.Ar file> and display."
4005 #: build/C/man7/mdoc.7:162 build/C/man7/mdoc.samples.7:2257
4007 msgid "Fl offset Ar string"
4011 #: build/C/man7/mdoc.7:167
4012 msgid "Offset display. Acceptable E<.Ar string> values:"
4016 #: build/C/man7/mdoc.7:168 build/C/man7/mdoc.samples.7:2265
4022 #: build/C/man7/mdoc.7:170
4023 msgid "Align block on left (default)."
4027 #: build/C/man7/mdoc.7:170 build/C/man7/mdoc.samples.7:2269
4033 #: build/C/man7/mdoc.7:172
4034 msgid "Approximate center margin."
4038 #: build/C/man7/mdoc.7:172 build/C/man7/mdoc.samples.7:2274
4044 #: build/C/man7/mdoc.7:174
4045 msgid "Six constant width spaces (a tab)."
4049 #: build/C/man7/mdoc.7:174 build/C/man7/mdoc.samples.7:2283
4051 msgid "Ar indent-two"
4055 #: build/C/man7/mdoc.7:176
4060 #: build/C/man7/mdoc.7:176 build/C/man7/mdoc.samples.7:2285
4066 #: build/C/man7/mdoc.7:179
4067 msgid "Left aligns block 2 inches from right."
4071 #: build/C/man7/mdoc.7:179
4073 msgid "Ar xx Ns Cm n"
4077 #: build/C/man7/mdoc.7:186
4079 "Where E<.Ar xx> is a number from E<.No \\&4 Ns Cm n> to E<.No \\&9\\&9 Ns Cm "
4084 #: build/C/man7/mdoc.7:186
4090 #: build/C/man7/mdoc.7:190
4091 msgid "Where E<.Ar Aa> is a callable macro name."
4095 #: build/C/man7/mdoc.7:190
4101 #: build/C/man7/mdoc.7:194
4102 msgid "The width of E<.Ar string> is used."
4106 #: build/C/man7/mdoc.7:196
4112 #: build/C/man7/mdoc.7:198
4113 msgid "End-display (matches \\&.Bd)."
4117 #: build/C/man7/mdoc.7:198
4123 #: build/C/man7/mdoc.7:202
4124 msgid "Begin-list. Create lists or columns. Options:"
4128 #: build/C/man7/mdoc.7:203
4130 msgid "Ar List-types"
4134 #: build/C/man7/mdoc.7:205
4136 msgid "Fl bullet Ta \"Bullet Item List\""
4140 #: build/C/man7/mdoc.7:206
4142 msgid "Fl item Ta \"Unlabeled List\""
4146 #: build/C/man7/mdoc.7:207
4148 msgid "Fl enum Ta \"Enumerated List\""
4152 #: build/C/man7/mdoc.7:208
4154 msgid "Fl tag Ta \"Tag Labeled List\""
4158 #: build/C/man7/mdoc.7:209
4160 msgid "Fl diag Ta \"Diagnostic List\""
4164 #: build/C/man7/mdoc.7:210
4166 msgid "Fl hang Ta \"Hanging Labeled List\""
4170 #: build/C/man7/mdoc.7:211
4172 msgid "Fl ohang Ta \"Overhanging Labeled List\""
4176 #: build/C/man7/mdoc.7:212
4178 msgid "Fl inset Ta \"Inset or Run-on Labeled List\""
4182 #: build/C/man7/mdoc.7:214
4184 msgid "List-parameters"
4188 #: build/C/man7/mdoc.7:216
4194 #: build/C/man7/mdoc.7:220
4195 msgid "(All lists.) See E<.Ql \\&.Bd> begin-display above."
4199 #: build/C/man7/mdoc.7:220
4205 #: build/C/man7/mdoc.7:227
4206 msgid "E<.Pf ( Fl tag> and E<.Fl hang> lists only.) See E<.Ql \\&.Bd>."
4210 #: build/C/man7/mdoc.7:227
4216 #: build/C/man7/mdoc.7:230
4217 msgid "(All lists.) Suppresses blank lines."
4221 #: build/C/man7/mdoc.7:232
4227 #: build/C/man7/mdoc.7:234
4232 #: build/C/man7/mdoc.7:234
4238 #: build/C/man7/mdoc.7:236
4243 #: build/C/man7/mdoc.7:237
4245 msgid "MANUAL AND GENERAL TEXT DOMAIN MACROS"
4249 #: build/C/man7/mdoc.7:241
4251 "The manual and general text domain macros are special in that most of them "
4252 "are parsed for callable macros for example:"
4256 #: build/C/man7/mdoc.7:242
4258 msgid "Li \"\\&.Op Fl s Ar file\""
4262 #: build/C/man7/mdoc.7:245
4263 msgid "Produces E<.Op Fl s Ar file>"
4267 #: build/C/man7/mdoc.7:263
4269 "In this example, the option enclosure macro E<.Ql \\&.Op> is parsed, and "
4270 "calls the callable content macro E<.Ql \\&Fl> which operates on the argument "
4271 "E<.Ql s> and then calls the callable content macro E<.Ql \\&Ar> which "
4272 "operates on the argument E<.Ql file>. Some macros may be callable, but are "
4273 "not parsed and vice versa. These macros are indicated in the E<.Em parsed> "
4274 "and E<.Em callable> columns below."
4278 #: build/C/man7/mdoc.7:265
4279 msgid "Unless stated, manual domain macros share a common syntax:"
4283 #: build/C/man7/mdoc.7:266
4285 msgid "\\&.Va argument [\\ .\\ ,\\ ;\\ :\\ (\\ )\\ [\\ ]\\ argument ...\\ ]"
4289 #: build/C/man7/mdoc.7:286
4291 "E<.Sy Note>: Opening and closing punctuation characters are only recognized "
4292 "as such if they are presented one at a time. The string E<.Ql \"),\"> is "
4293 "not recognized as punctuation and will be output with a leading white space "
4294 "and in what ever font the calling macro uses. The argument list E<.Ql \"] ) "
4295 ",\"> is recognized as three sequential closing punctuation characters and a "
4296 "leading white space is not output between the characters and the previous "
4297 "argument (if any). The special meaning of a punctuation character may be "
4298 "escaped with the string E<.Ql \\e&>. For example the following string,"
4302 #: build/C/man7/mdoc.7:287
4304 msgid "Li \"\\&.Ar file1\\ , file2\\ , file3\\ )\\ .\""
4308 #: build/C/man7/mdoc.7:290
4309 msgid "Produces E<.Ar file1 , file2 , file3>)."
4313 #: build/C/man7/mdoc.7:292
4315 msgid "Manual Domain Macros"
4319 #: build/C/man7/mdoc.7:294 build/C/man7/mdoc.7:319
4321 msgid "Em \"Name\tParsed\tCallable\tDescription\""
4325 #: build/C/man7/mdoc.7:295
4327 msgid "Li \\&Ad Ta Yes Ta Yes Ta \"Address. (This macro may be deprecated.)\""
4331 #: build/C/man7/mdoc.7:296
4333 msgid "Li \\&An Ta Yes Ta Yes Ta \"Author name.\""
4337 #: build/C/man7/mdoc.7:297
4339 msgid "Li \\&Ar Ta Yes Ta Yes Ta \"Command-line argument.\""
4343 #: build/C/man7/mdoc.7:298
4346 "Li \\&Cd Ta \\&No Ta \\&No Ta \"Configuration declaration (section four "
4351 #: build/C/man7/mdoc.7:299
4353 msgid "Li \\&Cm Ta Yes Ta Yes Ta \"Command-line argument modifier.\""
4357 #: build/C/man7/mdoc.7:300
4359 msgid "Li \\&Dv Ta Yes Ta Yes Ta \"Defined variable (source code).\""
4363 #: build/C/man7/mdoc.7:301
4365 msgid "Li \\&Er Ta Yes Ta Yes Ta \"Error number (source code).\""
4369 #: build/C/man7/mdoc.7:302
4371 msgid "Li \\&Ev Ta Yes Ta Yes Ta \"Environment variable.\""
4375 #: build/C/man7/mdoc.7:303
4377 msgid "Li \\&Fa Ta Yes Ta Yes Ta \"Function argument.\""
4381 #: build/C/man7/mdoc.7:304
4383 msgid "Li \\&Fd Ta Yes Ta Yes Ta \"Function declaration.\""
4387 #: build/C/man7/mdoc.7:305
4389 msgid "Li \\&Fn Ta Yes Ta Yes Ta \"Function call (also .Fo and .Fc).\""
4393 #: build/C/man7/mdoc.7:306
4395 msgid "Li \\&Ic Ta Yes Ta Yes Ta \"Interactive command.\""
4399 #: build/C/man7/mdoc.7:307
4401 msgid "Li \\&Li Ta Yes Ta Yes Ta \"Literal text.\""
4405 #: build/C/man7/mdoc.7:308
4407 msgid "Li \\&Nm Ta Yes Ta Yes Ta \"Command name.\""
4411 #: build/C/man7/mdoc.7:309
4413 msgid "Li \\&Op Ta Yes Ta Yes Ta \"Option (also .Oo and .Oc).\""
4417 #: build/C/man7/mdoc.7:310
4419 msgid "Li \\&Ot Ta Yes Ta Yes Ta \"Old style function type (Fortran only).\""
4423 #: build/C/man7/mdoc.7:311
4425 msgid "Li \\&Pa Ta Yes Ta Yes Ta \"Pathname or filename.\""
4429 #: build/C/man7/mdoc.7:312
4431 msgid "Li \\&St Ta Yes Ta Yes Ta \"Standards (\\-p1003.2, \\-p1003.1 or \\-ansiC)\""
4435 #: build/C/man7/mdoc.7:313
4437 msgid "Li \\&Va Ta Yes Ta Yes Ta \"Variable name.\""
4441 #: build/C/man7/mdoc.7:314
4443 msgid "Li \\&Vt Ta Yes Ta Yes Ta \"Variable type (Fortran only).\""
4447 #: build/C/man7/mdoc.7:315
4449 msgid "Li \\&Xr Ta Yes Ta Yes Ta \"Manual Page Cross Reference.\""
4453 #: build/C/man7/mdoc.7:317
4455 msgid "General Text Domain Macros"
4459 #: build/C/man7/mdoc.7:320
4461 msgid "Li \\&%A Ta Yes Ta \\&No Ta \"Reference author.\""
4465 #: build/C/man7/mdoc.7:321
4467 msgid "Li \\&%B Ta Yes Ta Yes Ta \"Reference book title.\""
4471 #: build/C/man7/mdoc.7:322
4473 msgid "Li \\&%\\&C Ta \\&No Ta \\&No Ta \"Reference place of publishing (city).\""
4477 #: build/C/man7/mdoc.7:323
4479 msgid "Li \\&%\\&D Ta \\&No Ta \\&No Ta \"Reference date.\""
4483 #: build/C/man7/mdoc.7:324
4485 msgid "Li \\&%J Ta Yes Ta Yes Ta \"Reference journal title.\""
4489 #: build/C/man7/mdoc.7:325
4491 msgid "Li \\&%N Ta \\&No Ta \\&No Ta \"Reference issue number.\""
4495 #: build/C/man7/mdoc.7:326
4497 msgid "Li \\&%\\&O Ta \\&No Ta \\&No Ta \"Reference optional information.\""
4501 #: build/C/man7/mdoc.7:327
4503 msgid "Li \\&%P Ta \\&No Ta \\&No Ta \"Reference page number(s).\""
4507 #: build/C/man7/mdoc.7:328
4509 msgid "Li \\&%R Ta \\&No Ta \\&No Ta \"Reference report Name.\""
4513 #: build/C/man7/mdoc.7:329
4515 msgid "Li \\&%T Ta Yes Ta Yes Ta \"Reference article title.\""
4519 #: build/C/man7/mdoc.7:330
4521 msgid "Li \\&%V Ta \\&No Ta \\&No Ta \"Reference volume.\""
4525 #: build/C/man7/mdoc.7:331
4527 msgid "Li \\&Ac Ta Yes Ta Yes Ta \"Angle close quote.\""
4531 #: build/C/man7/mdoc.7:332
4533 msgid "Li \\&Ao Ta Yes Ta Yes Ta \"Angle open quote.\""
4537 #: build/C/man7/mdoc.7:333
4539 msgid "Li \\&Ap Ta Yes Ta Yes Ta Apostrophe."
4543 #: build/C/man7/mdoc.7:334
4545 msgid "Li \\&Aq Ta Yes Ta Yes Ta \"Angle quote.\""
4549 #: build/C/man7/mdoc.7:335
4551 msgid "Li \\&At Ta \\&No Ta \\&No Ta Tn \"AT&T UNIX\""
4555 #: build/C/man7/mdoc.7:336
4557 msgid "Li \\&Bc Ta Yes Ta Yes Ta \"Bracket close quote.\""
4561 #: build/C/man7/mdoc.7:337
4563 msgid "Li \\&Bf Ta \\&No Ta \\&No Ta \"Begin font mode.\""
4567 #: build/C/man7/mdoc.7:338
4569 msgid "Li \\&Bo Ta Yes Ta Yes Ta \"Bracket open quote.\""
4573 #: build/C/man7/mdoc.7:339
4575 msgid "Li \\&Bq Ta Yes Ta Yes Ta \"Bracket quote.\""
4579 #: build/C/man7/mdoc.7:340
4581 msgid "Li \\&Bx Ta Yes Ta Yes Ta Bx ."
4585 #: build/C/man7/mdoc.7:341
4587 msgid "Li \\&Db Ta \\&No Ta \\&No Ta \"Debug (default is \\*qoff\\*q)\""
4591 #: build/C/man7/mdoc.7:342
4593 msgid "Li \\&Dc Ta Yes Ta Yes Ta \"Double close quote.\""
4597 #: build/C/man7/mdoc.7:343
4599 msgid "Li \\&Do Ta Yes Ta Yes Ta \"Double open quote.\""
4603 #: build/C/man7/mdoc.7:344
4605 msgid "Li \\&Dq Ta Yes Ta Yes Ta \"Double quote.\""
4609 #: build/C/man7/mdoc.7:345
4611 msgid "Li \\&Ec Ta Yes Ta Yes Ta \"Enclose string close quote.\""
4615 #: build/C/man7/mdoc.7:346
4617 msgid "Li \\&Ef Ta \\&No Ta \\&No Ta \"End font mode.\""
4621 #: build/C/man7/mdoc.7:347
4623 msgid "Li \\&Em Ta Yes Ta Yes Ta \"Emphasis (traditional English).\""
4627 #: build/C/man7/mdoc.7:348
4629 msgid "Li \\&Eo Ta Yes Ta Yes Ta \"Enclose string open quote.\""
4633 #: build/C/man7/mdoc.7:349
4635 msgid "Li \\&Fx Ta \\&No Ta \\&No Ta Tn \"FreeBSD operating system\""
4639 #: build/C/man7/mdoc.7:350
4641 msgid "Li \\&No Ta Yes Ta Yes Ta \"Normal text (no-op).\""
4645 #: build/C/man7/mdoc.7:351
4647 msgid "Li \\&Ns Ta Yes Ta Yes Ta \"No space.\""
4651 #: build/C/man7/mdoc.7:352
4653 msgid "Li \\&Pc Ta Yes Ta Yes Ta \"Parenthesis close quote.\""
4657 #: build/C/man7/mdoc.7:353
4659 msgid "Li \\&Pf Ta Yes Ta \\&No Ta \"Prefix string.\""
4663 #: build/C/man7/mdoc.7:354
4665 msgid "Li \\&Po Ta Yes Ta Yes Ta \"Parenthesis open quote.\""
4669 #: build/C/man7/mdoc.7:355
4671 msgid "Li \\&Pq Ta Yes Ta Yes Ta \"Parentheses quote.\""
4675 #: build/C/man7/mdoc.7:356
4677 msgid "Li \\&Qc Ta Yes Ta Yes Ta \"Straight Double close quote.\""
4681 #: build/C/man7/mdoc.7:357
4683 msgid "Li \\&Ql Ta Yes Ta Yes Ta \"Quoted literal.\""
4687 #: build/C/man7/mdoc.7:358
4689 msgid "Li \\&Qo Ta Yes Ta Yes Ta \"Straight Double open quote.\""
4693 #: build/C/man7/mdoc.7:359
4695 msgid "Li \\&Qq Ta Yes Ta Yes Ta \"Straight Double quote.\""
4699 #: build/C/man7/mdoc.7:360
4701 msgid "Li \\&Re Ta \\&No Ta \\&No Ta \"Reference end.\""
4705 #: build/C/man7/mdoc.7:361
4707 msgid "Li \\&Rs Ta \\&No Ta \\&No Ta \"Reference start.\""
4711 #: build/C/man7/mdoc.7:362
4714 "Li \\&Rv Ta \\&No Ta \\&No Ta \"Return values (sections two and three "
4719 #: build/C/man7/mdoc.7:363
4721 msgid "Li \\&Sc Ta Yes Ta Yes Ta \"Single close quote.\""
4725 #: build/C/man7/mdoc.7:364
4727 msgid "Li \\&So Ta Yes Ta Yes Ta \"Single open quote.\""
4731 #: build/C/man7/mdoc.7:365
4733 msgid "Li \\&Sq Ta Yes Ta Yes Ta \"Single quote.\""
4737 #: build/C/man7/mdoc.7:366
4739 msgid "Li \\&Sm Ta \\&No Ta \\&No Ta \"Space mode (default is \\*qon\\*q)\""
4743 #: build/C/man7/mdoc.7:367
4745 msgid "Li \\&Sx Ta Yes Ta Yes Ta \"Section Cross Reference.\""
4749 #: build/C/man7/mdoc.7:368
4751 msgid "Li \\&Sy Ta Yes Ta Yes Ta \"Symbolic (traditional English).\""
4755 #: build/C/man7/mdoc.7:369
4757 msgid "Li \\&Tn Ta Yes Ta Yes Ta \"Trade or type name (small Caps).\""
4761 #: build/C/man7/mdoc.7:370
4763 msgid "Li \\&Ux Ta Yes Ta Yes Ta Ux"
4767 #: build/C/man7/mdoc.7:371
4769 msgid "Li \\&Xc Ta Yes Ta Yes Ta \"Extend argument list close.\""
4773 #: build/C/man7/mdoc.7:372
4775 msgid "Li \\&Xo Ta Yes Ta Yes Ta \"Extend argument list open.\""
4779 #: build/C/man7/mdoc.7:386
4781 "Macro names ending in E<.Ql q> quote remaining items on the argument list. "
4782 "Macro names ending in E<.Ql o> begin a quote which may span more than one "
4783 "line of input and are close quoted with the matching macro name ending in "
4784 "E<.Ql c>. Enclosure macros may be nested and are limited to eight "
4789 #: build/C/man7/mdoc.7:398
4791 "Note: the extended argument list macros E<.Pf ( Ql \\&.Xo>, E<.Ql \\&.Xc>) "
4792 "and the function enclosure macros E<.Pf ( Ql \\&.Fo>, E<.Ql \\&.Fc>) are "
4793 "irregular. The extended list macros are used when the number of macro "
4794 "arguments would exceed the E<.Xr troff> limitation of nine arguments."
4797 #. The following does not apply on Linux:
4798 #. .Sh CONFIGURATION
4799 #. For site specific configuration of the macro package,
4801 #. .Pa /usr/src/share/tmac/README .
4803 #: build/C/man7/mdoc.7:409
4805 "The macros UR (starting a URI/URL hypertext reference), UE (ending one), and "
4806 "UN (identifying a target for a reference) are also available. See E<.Xr man "
4807 "7> for more information on these macros."
4811 #: build/C/man7/mdoc.7:411
4817 #: build/C/man7/mdoc.7:413
4818 msgid "Manual and general text domain macros."
4822 #: build/C/man7/mdoc.7:413
4824 msgid "Pa tmac/doc-common"
4828 #: build/C/man7/mdoc.7:415
4829 msgid "Common structural macros and definitions."
4833 #: build/C/man7/mdoc.7:415
4835 msgid "Pa tmac/doc-nroff"
4839 #: build/C/man7/mdoc.7:419
4840 msgid "Site dependent E<.Xr nroff> style file."
4844 #: build/C/man7/mdoc.7:419
4846 msgid "Pa tmac/doc-ditroff"
4850 #: build/C/man7/mdoc.7:423
4851 msgid "Site dependent E<.Xr troff> style file."
4855 #: build/C/man7/mdoc.7:423
4857 msgid "Pa tmac/doc-syms"
4861 #: build/C/man7/mdoc.7:425
4862 msgid "Special defines (such as the standards macro)."
4866 #: build/C/man7/mdoc.7:430
4867 msgid "E<.Xr groff_mdoc 7>, E<.Xr mdoc.samples 7>, E<.Xr man 7>, E<.Xr man-pages 7>"
4871 #: build/C/man7/operator.7:38
4877 #: build/C/man7/operator.7:38
4883 #: build/C/man7/operator.7:41
4884 msgid "operator - C operator precedence and order of evaluation"
4888 #: build/C/man7/operator.7:43
4889 msgid "This manual page lists C operators and their precedence in evaluation."
4893 #: build/C/man7/operator.7:61
4896 "B<Operator Associativity>\n"
4897 "() [] -E<gt> . left to right\n"
4898 "! ~ ++ -- + - (type) * & sizeof right to left\n"
4899 "* / % left to right\n"
4900 "+ - left to right\n"
4901 "E<lt>E<lt> E<gt>E<gt> left to right\n"
4902 "E<lt> E<lt>= E<gt> E<gt>= left to right\n"
4903 "== != left to right\n"
4907 "&& left to right\n"
4908 "|| left to right\n"
4909 "?: right to left\n"
4910 "= += -= *= /= %= E<lt>E<lt>= E<gt>E<gt>= &= ^= |= right to left\n"
4915 #: build/C/man7/posixoptions.7:23
4917 msgid "POSIXOPTIONS"
4921 #: build/C/man7/posixoptions.7:23
4927 #: build/C/man7/posixoptions.7:26
4928 msgid "posixoptions - optional parts of the POSIX standard"
4932 #: build/C/man7/posixoptions.7:40
4934 "The POSIX standard (the information below is from POSIX.1-2001) describes a "
4935 "set of behaviors and interfaces for a compliant system. However, many "
4936 "interfaces are optional and there are feature test macros to test the "
4937 "availability of interfaces at compile time, and functions B<sysconf>(3), "
4938 "B<fpathconf>(3), B<pathconf>(3), B<confstr>(3) to do this at run time. "
4939 "From shell scripts one can use B<getconf>(1). For more detail, see "
4944 #: build/C/man7/posixoptions.7:47
4946 "We give the name of the POSIX abbreviation, the option, the name of the "
4947 "B<sysconf>(3) parameter used to inquire about the option, and possibly a "
4948 "very short description. Much more precise detail can be found in the POSIX "
4949 "standard itself, versions of which can nowadays be accessed freely on the "
4954 #: build/C/man7/posixoptions.7:47
4956 msgid "ADV - _POSIX_ADVISORY_INFO - _SC_ADVISORY_INFO"
4960 #: build/C/man7/posixoptions.7:49
4961 msgid "The following advisory functions are present:"
4965 #: build/C/man7/posixoptions.7:57
4968 "I<posix_fadvise>(),\n"
4969 "I<posix_fallocate>(),\n"
4970 "I<posix_memalign>(),\n"
4971 "I<posix_madvise>().\n"
4975 #: build/C/man7/posixoptions.7:60
4977 msgid "AIO - _POSIX_ASYNCHRONOUS_IO - _SC_ASYNCHRONOUS_IO"
4981 #: build/C/man7/posixoptions.7:65
4983 "The header I<E<lt>aio.hE<gt>> is present. The following functions are "
4988 #: build/C/man7/posixoptions.7:77
4991 "I<aio_cancel>(),\n"
4995 "I<aio_return>(),\n"
4996 "I<aio_suspend>(),\n"
4998 "I<lio_listio>().\n"
5002 #: build/C/man7/posixoptions.7:80
5004 msgid "BAR - _POSIX_BARRIERS - _SC_BARRIERS"
5008 #: build/C/man7/posixoptions.7:87 build/C/man7/posixoptions.7:457
5010 "This option implies the B<_POSIX_THREADS> and "
5011 "B<_POSIX_THREAD_SAFE_FUNCTIONS> options. The following functions are "
5016 #: build/C/man7/posixoptions.7:96
5019 "I<pthread_barrier_destroy>(),\n"
5020 "I<pthread_barrier_init>(),\n"
5021 "I<pthread_barrier_wait>(),\n"
5022 "I<pthread_barrierattr_destroy>(),\n"
5023 "I<pthread_barrierattr_init>().\n"
5027 #. Batch environment.
5031 #: build/C/man7/posixoptions.7:103
5033 msgid "--- - POSIX_CHOWN_RESTRICTED"
5036 #. What about lchown() ?
5038 #: build/C/man7/posixoptions.7:111
5040 "If this option is in effect (as it always is under POSIX.1-2001) then only "
5041 "root may change the owner of a file, and nonroot can only set the group of a "
5042 "file to one of the groups it belongs to. This affects the functions "
5043 "I<chown>(), I<fchown>()."
5047 #: build/C/man7/posixoptions.7:111
5049 msgid "CS - _POSIX_CLOCK_SELECTION - _SC_CLOCK_SELECTION"
5053 #: build/C/man7/posixoptions.7:116
5055 "This option implies the B<_POSIX_TIMERS> option. The following functions "
5060 #: build/C/man7/posixoptions.7:123
5063 "I<pthread_condattr_getclock>(),\n"
5064 "I<pthread_condattr_setclock>(),\n"
5065 "I<clock_nanosleep>().\n"
5069 #: build/C/man7/posixoptions.7:131
5071 "If B<CLOCK_REALTIME> is changed by the function I<clock_settime>(), then "
5072 "this affects all timers set for an absolute time."
5076 #: build/C/man7/posixoptions.7:131
5078 msgid "CPT - _POSIX_CPUTIME - _SC_CPUTIME"
5082 #. Fortran development
5086 #: build/C/man7/posixoptions.7:144
5088 "The clockID CLOCK_PROCESS_CPUTIME_ID is supported. The initial value of "
5089 "this clock is 0 for each process. This option implies the B<_POSIX_TIMERS> "
5090 "option. The function I<clock_getcpuclockid>() is present."
5094 #: build/C/man7/posixoptions.7:144
5096 msgid "--- - _POSIX_FILE_LOCKING - _SC_FILE_LOCKING"
5100 #. IEC 60559 Floating-Point Option.
5102 #: build/C/man7/posixoptions.7:147 build/C/man7/posixoptions.7:237
5103 msgid "This option has been deleted. Not in final XPG6."
5107 #: build/C/man7/posixoptions.7:147
5109 msgid "FSC - _POSIX_FSYNC - _SC_FSYNC "
5113 #: build/C/man7/posixoptions.7:151
5114 msgid "The function I<fsync>() is present."
5118 #: build/C/man7/posixoptions.7:151
5120 msgid "IP6 - _POSIX_IPV6 - _SC_IPV6"
5124 #: build/C/man7/posixoptions.7:153
5125 msgid "Internet Protocol Version 6 is supported."
5129 #: build/C/man7/posixoptions.7:153
5131 msgid "--- - _POSIX_JOB_CONTROL - _SC_JOB_CONTROL"
5135 #: build/C/man7/posixoptions.7:157
5137 "If this option is in effect (as it always is under POSIX.1-2001) then the "
5138 "system implements POSIX-style job control, and the following functions are "
5143 #: build/C/man7/posixoptions.7:168
5150 "I<tcsendbreak>(),\n"
5156 #: build/C/man7/posixoptions.7:170
5158 msgid "MF - _POSIX_MAPPED_FILES - _SC_MAPPED_FILES"
5162 #: build/C/man7/posixoptions.7:179
5164 "Shared memory is supported. The include file I<E<lt>sys/mman.hE<gt>> is "
5165 "present. The following functions are present: I<mmap>(), I<msync>(), "
5170 #: build/C/man7/posixoptions.7:179
5172 msgid "ML - _POSIX_MEMLOCK - _SC_MEMLOCK"
5176 #: build/C/man7/posixoptions.7:185
5178 "Shared memory can be locked into core. The functions I<mlockall>(), "
5179 "I<munlockall>() are present."
5183 #: build/C/man7/posixoptions.7:185
5185 msgid "MR/MLR - _POSIX_MEMLOCK_RANGE - _SC_MEMLOCK_RANGE"
5189 #: build/C/man7/posixoptions.7:191
5191 "More precisely, ranges can be locked into core. The functions I<mlock>(), "
5192 "I<munlock>() are present."
5196 #: build/C/man7/posixoptions.7:191
5198 msgid "MPR - _POSIX_MEMORY_PROTECTION - _SC_MEMORY_PROTECTION"
5202 #: build/C/man7/posixoptions.7:195
5203 msgid "The function I<mprotect>() is present."
5207 #: build/C/man7/posixoptions.7:195
5209 msgid "MSG - _POSIX_MESSAGE_PASSING - _SC_MESSAGE_PASSING"
5213 #: build/C/man7/posixoptions.7:200
5215 "The include file I<E<lt>mqueue.hE<gt>> is present. The following functions "
5220 #: build/C/man7/posixoptions.7:212
5224 "I<mq_getattr>(),\n"
5227 "I<mq_receive>(),\n"
5229 "I<mq_setattr>(),\n"
5234 #: build/C/man7/posixoptions.7:215
5236 msgid "MON - _POSIX_MONOTONIC_CLOCK - _SC_MONOTONIC_CLOCK"
5240 #: build/C/man7/posixoptions.7:222
5242 "B<CLOCK_MONOTONIC> is supported. This option implies the B<_POSIX_TIMERS> "
5243 "option. Affected functions are"
5247 #: build/C/man7/posixoptions.7:230
5250 "I<aio_suspend>(),\n"
5251 "I<clock_getres>(),\n"
5252 "I<clock_gettime>(),\n"
5253 "I<clock_settime>(),\n"
5254 "I<timer_create>().\n"
5258 #: build/C/man7/posixoptions.7:232
5260 msgid "--- - _POSIX_MULTI_PROCESS - _SC_MULTI_PROCESS"
5264 #: build/C/man7/posixoptions.7:237
5266 msgid "--- - _POSIX_NO_TRUNC"
5270 #: build/C/man7/posixoptions.7:244
5272 "If this option is in effect (as it always is under POSIX.1-2001) then "
5273 "pathname components longer than B<NAME_MAX> are not truncated, but give an "
5274 "error. This property may be dependent on the path prefix of the component."
5278 #: build/C/man7/posixoptions.7:244
5280 msgid "PIO - _POSIX_PRIORITIZED_IO - _SC_PRIORITIZED_IO"
5284 #: build/C/man7/posixoptions.7:247
5286 "This option says that one can specify priorities for asynchronous I/O. This "
5287 "affects the functions"
5291 #: build/C/man7/posixoptions.7:253
5299 #: build/C/man7/posixoptions.7:255
5301 msgid "PS - _POSIX_PRIORITY_SCHEDULING - _SC_PRIORITY_SCHEDULING"
5305 #: build/C/man7/posixoptions.7:260
5307 "The include file I<E<lt>sched.hE<gt>> is present. The following functions "
5312 #: build/C/man7/posixoptions.7:272
5315 "I<sched_get_priority_max>(),\n"
5316 "I<sched_get_priority_min>(),\n"
5317 "I<sched_getparam>(),\n"
5318 "I<sched_getscheduler>(),\n"
5319 "I<sched_rr_get_interval>(),\n"
5320 "I<sched_setparam>(),\n"
5321 "I<sched_setscheduler>(),\n"
5322 "I<sched_yield>().\n"
5326 #: build/C/man7/posixoptions.7:278
5328 "If also B<_POSIX_SPAWN> is in effect, then the following functions are "
5333 #: build/C/man7/posixoptions.7:286 build/C/man7/posixoptions.7:448
5336 "I<posix_spawnattr_getschedparam>(),\n"
5337 "I<posix_spawnattr_getschedpolicy>(),\n"
5338 "I<posix_spawnattr_setschedparam>(),\n"
5339 "I<posix_spawnattr_setschedpolicy>().\n"
5343 #: build/C/man7/posixoptions.7:288
5345 msgid "RS - _POSIX_RAW_SOCKETS"
5349 #: build/C/man7/posixoptions.7:293
5351 "Raw sockets are supported. Affected functions are I<getsockopt>(), "
5356 #: build/C/man7/posixoptions.7:293
5358 msgid "--- - _POSIX_READER_WRITER_LOCKS - _SC_READER_WRITER_LOCKS"
5362 #: build/C/man7/posixoptions.7:301
5364 "This option implies the B<_POSIX_THREADS> option. Conversely, under "
5365 "POSIX.1-2001 the B<_POSIX_THREADS> option implies this option."
5369 #: build/C/man7/posixoptions.7:303
5371 msgid "The following functions are present:\n"
5375 #: build/C/man7/posixoptions.7:314
5378 "I<pthread_rwlock_destroy>(),\n"
5379 "I<pthread_rwlock_init>(),\n"
5380 "I<pthread_rwlock_rdlock>(),\n"
5381 "I<pthread_rwlock_tryrdlock>(),\n"
5382 "I<pthread_rwlock_trywrlock>(),\n"
5383 "I<pthread_rwlock_unlock>(),\n"
5384 "I<pthread_rwlock_wrlock>(),\n"
5385 "I<pthread_rwlockattr_destroy>(),\n"
5386 "I<pthread_rwlockattr_init>().\n"
5390 #: build/C/man7/posixoptions.7:316
5392 msgid "RTS - _POSIX_REALTIME_SIGNALS - _SC_REALTIME_SIGNALS"
5396 #: build/C/man7/posixoptions.7:319
5397 msgid "Realtime signals are supported. The following functions are present:"
5401 #: build/C/man7/posixoptions.7:326
5405 "I<sigtimedwait>(),\n"
5406 "I<sigwaitinfo>().\n"
5410 #: build/C/man7/posixoptions.7:329
5412 msgid "--- - _POSIX_REGEXP - _SC_REGEXP"
5416 #: build/C/man7/posixoptions.7:333
5418 "If this option is in effect (as it always is under POSIX.1-2001) then POSIX "
5419 "regular expressions are supported and the following functions are present:"
5423 #: build/C/man7/posixoptions.7:341
5433 #: build/C/man7/posixoptions.7:344
5435 msgid "--- - _POSIX_SAVED_IDS - _SC_SAVED_IDS"
5439 #: build/C/man7/posixoptions.7:348
5441 "If this option is in effect (as it always is under POSIX.1-2001) then a "
5442 "process has a saved set-user-ID and a saved set-group-ID. Affected "
5447 #: build/C/man7/posixoptions.7:358
5459 #. Software development
5461 #: build/C/man7/posixoptions.7:363
5463 msgid "SEM - _POSIX_SEMAPHORES - _SC_SEMAPHORES"
5467 #: build/C/man7/posixoptions.7:368
5469 "The include file I<E<lt>semaphore.hE<gt>> is present. The following "
5470 "functions are present:"
5474 #: build/C/man7/posixoptions.7:381
5478 "I<sem_destroy>(),\n"
5479 "I<sem_getvalue>(),\n"
5483 "I<sem_trywait>(),\n"
5484 "I<sem_unlink>(),\n"
5489 #: build/C/man7/posixoptions.7:384
5491 msgid "SHM - _POSIX_SHARED_MEMORY_OBJECTS - _SC_SHARED_MEMORY_OBJECTS"
5495 #: build/C/man7/posixoptions.7:386 build/C/man7/posixoptions.7:702 build/C/man7/posixoptions.7:718 build/C/man7/posixoptions.7:832
5496 msgid "The following functions are present:"
5500 #: build/C/man7/posixoptions.7:394
5506 "I<shm_unlink>().\n"
5510 #: build/C/man7/posixoptions.7:397
5512 msgid "--- - _POSIX_SHELL - _SC_SHELL"
5516 #: build/C/man7/posixoptions.7:402
5518 "If this option is in effect (as it always is under POSIX.1-2001), the "
5519 "function I<system>() is present."
5523 #: build/C/man7/posixoptions.7:402
5525 msgid "SPN - _POSIX_SPAWN - _SC_SPAWN"
5529 #: build/C/man7/posixoptions.7:412
5531 "This option describes support for process creation in a context where it is "
5532 "difficult or impossible to use I<fork>(), for example, because no MMU is "
5533 "present. If B<_POSIX_SPAWN> is in effect, then the include file "
5534 "I<E<lt>spawn.hE<gt>> and the following functions are present:"
5538 #: build/C/man7/posixoptions.7:433
5541 "I<posix_spawn>(),\n"
5542 "I<posix_spawn_file_actions_addclose>(),\n"
5543 "I<posix_spawn_file_actions_adddup2>(),\n"
5544 "I<posix_spawn_file_actions_addopen>(),\n"
5545 "I<posix_spawn_file_actions_destroy>(),\n"
5546 "I<posix_spawn_file_actions_init>(),\n"
5547 "I<posix_spawnattr_destroy>(),\n"
5548 "I<posix_spawnattr_getsigdefault>(),\n"
5549 "I<posix_spawnattr_getflags>(),\n"
5550 "I<posix_spawnattr_getpgroup>(),\n"
5551 "I<posix_spawnattr_getsigmask>(),\n"
5552 "I<posix_spawnattr_init>(),\n"
5553 "I<posix_spawnattr_setsigdefault>(),\n"
5554 "I<posix_spawnattr_setflags>(),\n"
5555 "I<posix_spawnattr_setpgroup>(),\n"
5556 "I<posix_spawnattr_setsigmask>(),\n"
5557 "I<posix_spawnp>().\n"
5561 #: build/C/man7/posixoptions.7:440
5563 "If also B<_POSIX_PRIORITY_SCHEDULING> is in effect, then the following "
5564 "functions are present:"
5568 #: build/C/man7/posixoptions.7:450
5570 msgid "SPI - _POSIX_SPIN_LOCKS - _SC_SPIN_LOCKS"
5574 #: build/C/man7/posixoptions.7:466
5577 "I<pthread_spin_destroy>(),\n"
5578 "I<pthread_spin_init>(),\n"
5579 "I<pthread_spin_lock>(),\n"
5580 "I<pthread_spin_trylock>(),\n"
5581 "I<pthread_spin_unlock>().\n"
5585 #: build/C/man7/posixoptions.7:469
5587 msgid "SS - _POSIX_SPORADIC_SERVER - _SC_SPORADIC_SERVER"
5591 #: build/C/man7/posixoptions.7:477
5593 "The scheduling policy B<SCHED_SPORADIC> is supported. This option implies "
5594 "the B<_POSIX_PRIORITY_SCHEDULING> option. Affected functions are"
5598 #: build/C/man7/posixoptions.7:483
5601 "I<sched_setparam>(),\n"
5602 "I<sched_setscheduler>().\n"
5606 #: build/C/man7/posixoptions.7:486
5608 msgid "SIO - _POSIX_SYNCHRONIZED_IO - _SC_SYNCHRONIZED_IO"
5612 #: build/C/man7/posixoptions.7:492
5613 msgid "Affected functions are I<open>(), I<msync>(), I<fsync>(), I<fdatasync>()."
5617 #: build/C/man7/posixoptions.7:492
5619 msgid "TSA - _POSIX_THREAD_ATTR_STACKADDR - _SC_THREAD_ATTR_STACKADDR"
5623 #: build/C/man7/posixoptions.7:494 build/C/man7/posixoptions.7:507 build/C/man7/posixoptions.7:538 build/C/man7/posixoptions.7:549 build/C/man7/posixoptions.7:584 build/C/man7/posixoptions.7:601
5624 msgid "Affected functions are"
5628 #: build/C/man7/posixoptions.7:502
5631 "I<pthread_attr_getstack>(),\n"
5632 "I<pthread_attr_getstackaddr>(),\n"
5633 "I<pthread_attr_setstack>(),\n"
5634 "I<pthread_attr_setstackaddr>().\n"
5638 #: build/C/man7/posixoptions.7:505
5640 msgid "TSS - _POSIX_THREAD_ATTR_STACKSIZE - _SC_THREAD_ATTR_STACKSIZE"
5644 #: build/C/man7/posixoptions.7:515
5647 "I<pthread_attr_getstack>(),\n"
5648 "I<pthread_attr_getstacksize>(),\n"
5649 "I<pthread_attr_setstack>(),\n"
5650 "I<pthread_attr_setstacksize>().\n"
5654 #: build/C/man7/posixoptions.7:518
5656 msgid "TCT - _POSIX_THREAD_CPUTIME - _SC_THREAD_CPUTIME"
5660 #: build/C/man7/posixoptions.7:524
5662 "The clockID CLOCK_THREAD_CPUTIME_ID is supported. This option implies the "
5663 "B<_POSIX_TIMERS> option. Affected functions are"
5667 #: build/C/man7/posixoptions.7:533
5670 "I<pthread_getcpuclockid>(),\n"
5671 "I<clock_getres>(),\n"
5672 "I<clock_gettime>(),\n"
5673 "I<clock_settime>(),\n"
5674 "I<timer_create>().\n"
5678 #: build/C/man7/posixoptions.7:536
5680 msgid "TPI - _POSIX_THREAD_PRIO_INHERIT - _SC_THREAD_PRIO_INHERIT"
5684 #: build/C/man7/posixoptions.7:544
5687 "I<pthread_mutexattr_getprotocol>(),\n"
5688 "I<pthread_mutexattr_setprotocol>().\n"
5692 #: build/C/man7/posixoptions.7:547
5694 msgid "TPP - _POSIX_THREAD_PRIO_PROTECT - _SC_THREAD_PRIO_PROTECT"
5698 #: build/C/man7/posixoptions.7:559
5701 "I<pthread_mutex_getprioceiling>(),\n"
5702 "I<pthread_mutex_setprioceiling>(),\n"
5703 "I<pthread_mutexattr_getprioceiling>(),\n"
5704 "I<pthread_mutexattr_getprotocol>(),\n"
5705 "I<pthread_mutexattr_setprioceiling>(),\n"
5706 "I<pthread_mutexattr_setprotocol>().\n"
5710 #: build/C/man7/posixoptions.7:562
5712 msgid "TPS - _POSIX_THREAD_PRIORITY_SCHEDULING - _SC_THREAD_PRIORITY_SCHEDULING"
5716 #: build/C/man7/posixoptions.7:566
5718 "If this option is in effect, the different threads inside a process can run "
5719 "with different priorities and/or different schedulers. Affected functions "
5724 #: build/C/man7/posixoptions.7:579
5727 "I<pthread_attr_getinheritsched>(),\n"
5728 "I<pthread_attr_getschedpolicy>(),\n"
5729 "I<pthread_attr_getscope>(),\n"
5730 "I<pthread_attr_setinheritsched>(),\n"
5731 "I<pthread_attr_setschedpolicy>(),\n"
5732 "I<pthread_attr_setscope>(),\n"
5733 "I<pthread_getschedparam>(),\n"
5734 "I<pthread_setschedparam>(),\n"
5735 "I<pthread_setschedprio>().\n"
5739 #: build/C/man7/posixoptions.7:582
5741 msgid "TSH - _POSIX_THREAD_PROCESS_SHARED - _SC_THREAD_PROCESS_SHARED"
5745 #: build/C/man7/posixoptions.7:596
5748 "I<pthread_barrierattr_getpshared>(),\n"
5749 "I<pthread_barrierattr_setpshared>(),\n"
5750 "I<pthread_condattr_getpshared>(),\n"
5751 "I<pthread_condattr_setpshared>(),\n"
5752 "I<pthread_mutexattr_getpshared>(),\n"
5753 "I<pthread_mutexattr_setpshared>(),\n"
5754 "I<pthread_rwlockattr_getpshared>(),\n"
5755 "I<pthread_rwlockattr_setpshared>().\n"
5759 #: build/C/man7/posixoptions.7:599
5761 msgid "TSF - _POSIX_THREAD_SAFE_FUNCTIONS - _SC_THREAD_SAFE_FUNCTIONS"
5765 #: build/C/man7/posixoptions.7:624
5769 "I<getgrgid_r>(),\n"
5770 "I<getgrnam_r>(),\n"
5771 "I<getpwnam_r>(),\n"
5772 "I<getpwuid_r>(),\n"
5774 "I<ftrylockfile>(),\n"
5775 "I<funlockfile>(),\n"
5776 "I<getc_unlocked>(),\n"
5777 "I<getchar_unlocked>(),\n"
5778 "I<putc_unlocked>(),\n"
5779 "I<putchar_unlocked>(),\n"
5781 "I<strerror_r>(),\n"
5786 "I<localtime_r>().\n"
5790 #: build/C/man7/posixoptions.7:627
5792 msgid "TSP - _POSIX_THREAD_SPORADIC_SERVER - _SC_THREAD_SPORADIC_SERVER"
5796 #: build/C/man7/posixoptions.7:632
5798 "This option implies the B<_POSIX_THREAD_PRIORITY_SCHEDULING> option. "
5799 "Affected functions are"
5803 #: build/C/man7/posixoptions.7:639
5806 "I<sched_getparam>(),\n"
5807 "I<sched_setparam>(),\n"
5808 "I<sched_setscheduler>().\n"
5812 #: build/C/man7/posixoptions.7:642
5814 msgid "THR - _POSIX_THREADS - _SC_THREADS"
5818 #: build/C/man7/posixoptions.7:645
5820 "Basic support for POSIX threads is available. The following functions are "
5825 #: build/C/man7/posixoptions.7:697
5828 "I<pthread_atfork>(),\n"
5829 "I<pthread_attr_destroy>(),\n"
5830 "I<pthread_attr_getdetachstate>(),\n"
5831 "I<pthread_attr_getschedparam>(),\n"
5832 "I<pthread_attr_init>(),\n"
5833 "I<pthread_attr_setdetachstate>(),\n"
5834 "I<pthread_attr_setschedparam>(),\n"
5835 "I<pthread_cancel>(),\n"
5836 "I<pthread_cleanup_push>(),\n"
5837 "I<pthread_cleanup_pop>(),\n"
5838 "I<pthread_cond_broadcast>(),\n"
5839 "I<pthread_cond_destroy>(),\n"
5840 "I<pthread_cond_init>(),\n"
5841 "I<pthread_cond_signal>(),\n"
5842 "I<pthread_cond_timedwait>(),\n"
5843 "I<pthread_cond_wait>(),\n"
5844 "I<pthread_condattr_destroy>(),\n"
5845 "I<pthread_condattr_init>(),\n"
5846 "I<pthread_create>(),\n"
5847 "I<pthread_detach>(),\n"
5848 "I<pthread_equal>(),\n"
5849 "I<pthread_exit>(),\n"
5850 "I<pthread_getspecific>(),\n"
5851 "I<pthread_join>(),\n"
5852 "I<pthread_key_create>(),\n"
5853 "I<pthread_key_delete>(),\n"
5854 "I<pthread_mutex_destroy>(),\n"
5855 "I<pthread_mutex_init>(),\n"
5856 "I<pthread_mutex_lock>(),\n"
5857 "I<pthread_mutex_trylock>(),\n"
5858 "I<pthread_mutex_unlock>(),\n"
5859 "I<pthread_mutexattr_destroy>(),\n"
5860 "I<pthread_mutexattr_init>(),\n"
5861 "I<pthread_once>(),\n"
5862 "I<pthread_rwlock_destroy>(),\n"
5863 "I<pthread_rwlock_init>(),\n"
5864 "I<pthread_rwlock_rdlock>(),\n"
5865 "I<pthread_rwlock_tryrdlock>(),\n"
5866 "I<pthread_rwlock_trywrlock>(),\n"
5867 "I<pthread_rwlock_unlock>(),\n"
5868 "I<pthread_rwlock_wrlock>(),\n"
5869 "I<pthread_rwlockattr_destroy>(),\n"
5870 "I<pthread_rwlockattr_init>(),\n"
5871 "I<pthread_self>(),\n"
5872 "I<pthread_setcancelstate>(),\n"
5873 "I<pthread_setcanceltype>(),\n"
5874 "I<pthread_setspecific>(),\n"
5875 "I<pthread_testcancel>().\n"
5879 #: build/C/man7/posixoptions.7:700
5881 msgid "TMO - _POSIX_TIMEOUTS - _SC_TIMEOUTS"
5885 #: build/C/man7/posixoptions.7:713
5888 "I<mq_timedreceive>(),\n"
5889 "I<mq_timedsend>(),\n"
5890 "I<pthread_mutex_timedlock>(),\n"
5891 "I<pthread_rwlock_timedrdlock>(),\n"
5892 "I<pthread_rwlock_timedwrlock>(),\n"
5893 "I<sem_timedwait>(),\n"
5894 "I<posix_trace_timedgetnext_event>().\n"
5898 #: build/C/man7/posixoptions.7:716
5900 msgid "TMR - _POSIX_TIMERS - _SC_TIMERS"
5904 #: build/C/man7/posixoptions.7:731
5907 "I<clock_getres>(),\n"
5908 "I<clock_gettime>(),\n"
5909 "I<clock_settime>(),\n"
5911 "I<timer_create>(),\n"
5912 "I<timer_delete>(),\n"
5913 "I<timer_gettime>(),\n"
5914 "I<timer_getoverrun>(),\n"
5915 "I<timer_settime>().\n"
5919 #: build/C/man7/posixoptions.7:734
5921 msgid "TRC - _POSIX_TRACE - _SC_TRACE"
5925 #: build/C/man7/posixoptions.7:737
5926 msgid "POSIX tracing is available. The following functions are present:"
5930 #: build/C/man7/posixoptions.7:772
5933 "I<posix_trace_attr_destroy>(),\n"
5934 "I<posix_trace_attr_getclockres>(),\n"
5935 "I<posix_trace_attr_getcreatetime>(),\n"
5936 "I<posix_trace_attr_getgenversion>(),\n"
5937 "I<posix_trace_attr_getmaxdatasize>(),\n"
5938 "I<posix_trace_attr_getmaxsystemeventsize>(),\n"
5939 "I<posix_trace_attr_getmaxusereventsize>(),\n"
5940 "I<posix_trace_attr_getname>(),\n"
5941 "I<posix_trace_attr_getstreamfullpolicy>(),\n"
5942 "I<posix_trace_attr_getstreamsize>(),\n"
5943 "I<posix_trace_attr_init>(),\n"
5944 "I<posix_trace_attr_setmaxdatasize>(),\n"
5945 "I<posix_trace_attr_setname>(),\n"
5946 "I<posix_trace_attr_setstreamsize>(),\n"
5947 "I<posix_trace_attr_setstreamfullpolicy>(),\n"
5948 "I<posix_trace_clear>(),\n"
5949 "I<posix_trace_create>(),\n"
5950 "I<posix_trace_event>(),\n"
5951 "I<posix_trace_eventid_equal>(),\n"
5952 "I<posix_trace_eventid_get_name>(),\n"
5953 "I<posix_trace_eventid_open>(),\n"
5954 "I<posix_trace_eventtypelist_getnext_id>(),\n"
5955 "I<posix_trace_eventtypelist_rewind>(),\n"
5956 "I<posix_trace_flush>(),\n"
5957 "I<posix_trace_get_attr>(),\n"
5958 "I<posix_trace_get_status>(),\n"
5959 "I<posix_trace_getnext_event>(),\n"
5960 "I<posix_trace_shutdown>(),\n"
5961 "I<posix_trace_start>(),\n"
5962 "I<posix_trace_stop>(),\n"
5963 "I<posix_trace_trygetnext_event>().\n"
5967 #: build/C/man7/posixoptions.7:775
5969 msgid "TEF - _POSIX_TRACE_EVENT_FILTER - _SC_TRACE_EVENT_FILTER"
5973 #: build/C/man7/posixoptions.7:780 build/C/man7/posixoptions.7:815
5975 "This option implies the B<_POSIX_TRACE> option. The following functions are "
5980 #: build/C/man7/posixoptions.7:792
5983 "I<posix_trace_eventset_add>(),\n"
5984 "I<posix_trace_eventset_del>(),\n"
5985 "I<posix_trace_eventset_empty>(),\n"
5986 "I<posix_trace_eventset_fill>(),\n"
5987 "I<posix_trace_eventset_ismember>(),\n"
5988 "I<posix_trace_get_filter>(),\n"
5989 "I<posix_trace_set_filter>(),\n"
5990 "I<posix_trace_trid_eventid_open>().\n"
5994 #: build/C/man7/posixoptions.7:795
5996 msgid "TRI - _POSIX_TRACE_INHERIT - _SC_TRACE_INHERIT"
6000 #: build/C/man7/posixoptions.7:801
6002 "Tracing children of the traced process is supported. This option implies "
6003 "the B<_POSIX_TRACE> option. The following functions are present:"
6007 #: build/C/man7/posixoptions.7:807
6010 "I<posix_trace_attr_getinherited>(),\n"
6011 "I<posix_trace_attr_setinherited>().\n"
6015 #: build/C/man7/posixoptions.7:810
6017 msgid "TRL - _POSIX_TRACE_LOG - _SC_TRACE_LOG"
6021 #: build/C/man7/posixoptions.7:827
6024 "I<posix_trace_attr_getlogfullpolicy>(),\n"
6025 "I<posix_trace_attr_getlogsize>(),\n"
6026 "I<posix_trace_attr_setlogfullpolicy>(),\n"
6027 "I<posix_trace_attr_setlogsize>(),\n"
6028 "I<posix_trace_close>(),\n"
6029 "I<posix_trace_create_withlog>(),\n"
6030 "I<posix_trace_open>(),\n"
6031 "I<posix_trace_rewind>().\n"
6035 #: build/C/man7/posixoptions.7:830
6037 msgid "TYM - _POSIX_TYPED_MEMORY_OBJECTS - _SC_TYPED_MEMORY_OBJECT"
6041 #: build/C/man7/posixoptions.7:839
6044 "I<posix_mem_offset>(),\n"
6045 "I<posix_typed_mem_get_info>(),\n"
6046 "I<posix_typed_mem_open>().\n"
6050 #: build/C/man7/posixoptions.7:842
6052 msgid "--- - _POSIX_VDISABLE"
6056 #: build/C/man7/posixoptions.7:846
6058 "Always present (probably 0). Value to set a changeable special control "
6059 "character to indicate that it is disabled."
6063 #: build/C/man7/posixoptions.7:846
6065 msgid "XOPEN EXTENSIONS"
6070 #: build/C/man7/posixoptions.7:853
6072 "B<_XOPEN_CRYPT>, B<_XOPEN_LEGACY>, B<_XOPEN_REALTIME>, "
6073 "B<_XOPEN_REALTIME_THREADS>, B<_XOPEN_UNIX>."
6077 #: build/C/man7/posixoptions.7:855
6078 msgid "B<sysconf>(3), B<standards>(7)"
6082 #: build/C/man5/proc.5:61
6088 #: build/C/man5/proc.5:61
6094 #: build/C/man5/proc.5:64
6095 msgid "proc - process information pseudo-file system"
6099 #: build/C/man5/proc.5:73
6101 "The I<proc> file system is a pseudo-file system which is used as an "
6102 "interface to kernel data structures. It is commonly mounted at I</proc>. "
6103 "Most of it is read-only, but some files allow kernel variables to be "
6108 #: build/C/man5/proc.5:77
6109 msgid "The following outline gives a quick tour through the I</proc> hierarchy."
6113 #: build/C/man5/proc.5:78
6115 msgid "I</proc/[pid]>"
6118 #. FIXME Describe /proc/[pid]/attr and
6119 #. /proc/[pid]/task/[tid]/attr
6120 #. This is a directory
6124 #: build/C/man5/proc.5:90
6126 "There is a numerical subdirectory for each running process; the subdirectory "
6127 "is named by the process ID. Each such subdirectory contains the following "
6128 "pseudo-files and directories."
6132 #: build/C/man5/proc.5:90
6134 msgid "I</proc/[pid]/auxv> (since 2.6.0-test7)"
6137 #. FIXME Describe /proc/[pid]/cgroup and
6138 #. /proc/[pid]/task/[tid]/cgroup
6139 #. Info in Documentation/cgroups.txt
6143 #. FIXME Describe /proc/[pid]/clear_refs
6145 #. "Clears page referenced bits shown in smaps output"
6147 #. CONFIG_PROC_PAGE_MONITOR
6149 #: build/C/man5/proc.5:108
6151 "This contains the contents of the ELF interpreter information passed to the "
6152 "process at exec time. The format is one I<unsigned long> ID plus one "
6153 "I<unsigned long> value for each entry. The last entry contains two zeros."
6157 #: build/C/man5/proc.5:108
6159 msgid "I</proc/[pid]/cmdline>"
6162 #. In 2.3.26, this also used to be true if the process was swapped out.
6164 #: build/C/man5/proc.5:118
6166 "This holds the complete command line for the process, unless the process is "
6167 "a zombie. In the latter case, there is nothing in this file: that is, a "
6168 "read on this file will return 0 characters. The command-line arguments "
6169 "appear in this file as a set of strings separated by null bytes "
6170 "(\\(aq\\e0\\(aq), with a further null byte after the last string."
6174 #: build/C/man5/proc.5:118
6176 msgid "I</proc/[pid]/coredump_filter> (since kernel 2.6.23)"
6180 #: build/C/man5/proc.5:122 build/C/man5/proc.5:2094 build/C/man5/proc.5:2098
6181 msgid "See B<core>(5)."
6185 #: build/C/man5/proc.5:122
6187 msgid "I</proc/[pid]/cpuset> (since kernel 2.6.12)"
6190 #. and/proc/[pid]/task/[tid]/cpuset
6192 #: build/C/man5/proc.5:127
6193 msgid "See B<cpuset>(7)."
6197 #: build/C/man5/proc.5:127
6199 msgid "I</proc/[pid]/cwd>"
6203 #: build/C/man5/proc.5:132
6205 "This is a symbolic link to the current working directory of the process. To "
6206 "find out the current working directory of process 20, for instance, you can "
6211 #: build/C/man5/proc.5:136
6213 msgid "$B< cd /proc/20/cwd; /bin/pwd>\n"
6217 #: build/C/man5/proc.5:147
6219 "Note that the I<pwd> command is often a shell built-in, and might not work "
6220 "properly. In B<bash>(1), you may use I<pwd\\ -P>."
6223 #. The following was still true as at kernel 2.6.13
6224 #. FIXME Describe /proc/[pid]/seccomp
6226 #. FIXME Describe /proc/[pid]/sessionid
6227 #. Added in 2.6.25; read-only; only readable by real UID
6228 #. CONFIG_AUDITSYSCALL
6229 #. FIXME Describe /proc/[pid]/sched
6231 #. CONFIG_SCHED_DEBUG, and additional fields if CONFIG_SCHEDSTATS
6232 #. Displays various scheduling parameters
6233 #. This file can be written, to reset stats
6234 #. FIXME Describe /proc/[pid]/schedstats and
6235 #. /proc/[pid]/task/[tid]/schedstats
6237 #. CONFIG_SCHEDSTATS
6239 #: build/C/man5/proc.5:153 build/C/man5/proc.5:626
6241 "In a multithreaded process, the contents of this symbolic link are not "
6242 "available if the main thread has already terminated (typically by calling "
6243 "B<pthread_exit>(3))."
6247 #: build/C/man5/proc.5:153
6249 msgid "I</proc/[pid]/environ>"
6253 #: build/C/man5/proc.5:159
6255 "This file contains the environment for the process. The entries are "
6256 "separated by null bytes (\\(aq\\e0\\(aq), and there may be a null byte at "
6257 "the end. Thus, to print out the environment of process 1, you would do:"
6261 #: build/C/man5/proc.5:164
6263 msgid "$B< (cat /proc/1/environ; echo) | tr \\(aq\\e000\\(aq \\(aq\\en\\(aq>\n"
6267 #: build/C/man5/proc.5:167
6269 msgid "I</proc/[pid]/exe>"
6272 #. The following was still true as at kernel 2.6.13
6274 #: build/C/man5/proc.5:182
6276 "Under Linux 2.2 and later, this file is a symbolic link containing the "
6277 "actual pathname of the executed command. This symbolic link can be "
6278 "dereferenced normally; attempting to open it will open the executable. You "
6279 "can even type I</proc/[pid]/exe> to run another copy of the same executable "
6280 "as is being run by process [pid]. In a multithreaded process, the contents "
6281 "of this symbolic link are not available if the main thread has already "
6282 "terminated (typically by calling B<pthread_exit>(3))."
6286 #: build/C/man5/proc.5:190
6288 "Under Linux 2.0 and earlier I</proc/[pid]/exe> is a pointer to the binary "
6289 "which was executed, and appears as a symbolic link. A B<readlink>(2) call "
6290 "on this file under Linux 2.0 returns a string in the format:"
6294 #: build/C/man5/proc.5:192
6296 msgid " [device]:inode\n"
6300 #: build/C/man5/proc.5:195
6302 "For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, MFM, "
6303 "etc. drives) minor 01 (first partition on the first drive)."
6307 #: build/C/man5/proc.5:200
6308 msgid "B<find>(1) with the I<-inum> option can be used to locate the file."
6312 #: build/C/man5/proc.5:200
6314 msgid "I</proc/[pid]/fd>"
6318 #: build/C/man5/proc.5:206
6320 "This is a subdirectory containing one entry for each file which the process "
6321 "has open, named by its file descriptor, and which is a symbolic link to the "
6322 "actual file. Thus, 0 is standard input, 1 standard output, 2 standard "
6326 #. The following was still true as at kernel 2.6.13
6328 #: build/C/man5/proc.5:212
6330 "In a multithreaded process, the contents of this directory are not available "
6331 "if the main thread has already terminated (typically by calling "
6332 "B<pthread_exit>(3))."
6336 #: build/C/man5/proc.5:225
6338 "Programs that will take a filename as a command-line argument, but will not "
6339 "take input from standard input if no argument is supplied, or that write to "
6340 "a file named as a command-line argument, but will not send their output to "
6341 "standard output if no argument is supplied, can nevertheless be made to use "
6342 "standard input or standard out using I</proc/[pid]/fd>. For example, "
6343 "assuming that I<-i> is the flag designating an input file and I<-o> is the "
6344 "flag designating an output file:"
6348 #: build/C/man5/proc.5:229
6350 msgid "$B< foobar -i /proc/self/fd/0 -o /proc/self/fd/1 ...>\n"
6353 #. The following is not true in my tests (MTK):
6354 #. Note that this will not work for
6355 #. programs that seek on their files, as the files in the fd directory
6356 #. are not seekable.
6358 #: build/C/man5/proc.5:237
6359 msgid "and you have a working filter."
6363 #: build/C/man5/proc.5:247
6365 "I</proc/self/fd/N> is approximately the same as I</dev/fd/N> in some UNIX "
6366 "and UNIX-like systems. Most Linux MAKEDEV scripts symbolically link "
6367 "I</dev/fd> to I</proc/self/fd>, in fact."
6371 #: build/C/man5/proc.5:261
6373 "Most systems provide symbolic links I</dev/stdin>, I</dev/stdout>, and "
6374 "I</dev/stderr>, which respectively link to the files I<0>, I<1>, and I<2> in "
6375 "I</proc/self/fd>. Thus the example command above could be written as:"
6379 #: build/C/man5/proc.5:265
6381 msgid "$B< foobar -i /dev/stdin -o /dev/stdout ...>\n"
6385 #: build/C/man5/proc.5:270
6387 msgid "I</proc/[pid]/fdinfo/> (since kernel 2.6.22)"
6391 #: build/C/man5/proc.5:276
6393 "This is a subdirectory containing one entry for each file which the process "
6394 "has open, named by its file descriptor. The contents of each file can be "
6395 "read to obtain information about the corresponding file descriptor, for "
6400 #: build/C/man5/proc.5:282
6403 "$B< cat /proc/12015/fdinfo/4>\n"
6409 #: build/C/man5/proc.5:293
6411 "The I<pos> field is a decimal number showing the current file offset. The "
6412 "I<flags> field is an octal number that displays the file access mode and "
6413 "file status flags (see B<open>(2))."
6416 #. FIXME document /proc/[pid]/io
6418 #. .IR /proc/[pid]/io " (since kernel 2.6.20)"
6420 #: build/C/man5/proc.5:298
6421 msgid "The files in this directory are readable only by the owner of the process."
6425 #: build/C/man5/proc.5:298
6427 msgid "I</proc/[pid]/limits> (since kernel 2.6.24)"
6431 #: build/C/man5/proc.5:304
6433 "This file displays the soft limit, hard limit, and units of measurement for "
6434 "each of the process's resource limits (see B<getrlimit>(2)). The file is "
6435 "protected to only allow reading by the real UID of the process."
6439 #: build/C/man5/proc.5:304
6441 msgid "I</proc/[pid]/maps>"
6445 #: build/C/man5/proc.5:308
6447 "A file containing the currently mapped memory regions and their access "
6452 #: build/C/man5/proc.5:310
6453 msgid "The format is:"
6457 #: build/C/man5/proc.5:323
6460 "CW<address perms offset dev inode pathname\n"
6461 "08048000-08056000 r-xp 00000000 03:0c 64593 /usr/sbin/gpm\n"
6462 "08056000-08058000 rw-p 0000d000 03:0c 64593 /usr/sbin/gpm\n"
6463 "08058000-0805b000 rwxp 00000000 00:00 0\n"
6464 "40000000-40013000 r-xp 00000000 03:0c 4165 /lib/ld-2.2.4.so\n"
6465 "40013000-40015000 rw-p 00012000 03:0c 4165 /lib/ld-2.2.4.so\n"
6466 "4001f000-40135000 r-xp 00000000 03:0c 45494 /lib/libc-2.2.4.so\n"
6467 "40135000-4013e000 rw-p 00115000 03:0c 45494 /lib/libc-2.2.4.so\n"
6468 "4013e000-40142000 rw-p 00000000 00:00 0\n"
6469 "bffff000-c0000000 rwxp 00000000 00:00 0>\n"
6473 #: build/C/man5/proc.5:328
6475 "where \"address\" is the address space in the process that it occupies, "
6476 "\"perms\" is a set of permissions:"
6480 #: build/C/man5/proc.5:336
6487 "p = private (copy on write)\n"
6491 #: build/C/man5/proc.5:343
6493 "\"offset\" is the offset into the file/whatever, \"dev\" is the device "
6494 "(major:minor), and \"inode\" is the inode on that device. 0 indicates that "
6495 "no inode is associated with the memory region, as the case would be with BSS "
6496 "(uninitialized data)."
6500 #: build/C/man5/proc.5:345
6501 msgid "Under Linux 2.0 there is no field giving pathname."
6505 #: build/C/man5/proc.5:345
6507 msgid "I</proc/[pid]/mem>"
6511 #: build/C/man5/proc.5:352
6513 "This file can be used to access the pages of a process's memory through "
6514 "B<open>(2), B<read>(2), and B<lseek>(2)."
6518 #: build/C/man5/proc.5:352
6520 msgid "I</proc/[pid]/mountinfo> (since Linux 2.6.26)"
6523 #. This info adapted from Documentation/filesystems/proc.txt
6525 #: build/C/man5/proc.5:357
6527 "This file contains information about mount points. It contains lines of the "
6532 #: build/C/man5/proc.5:362
6535 "CW<36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root "
6536 "rw,errors=continue\n"
6537 "(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)>\n"
6541 #: build/C/man5/proc.5:366
6542 msgid "The numbers in parentheses are labels for the descriptions below:"
6546 #: build/C/man5/proc.5:367 build/C/man5/proc.5:460
6552 #: build/C/man5/proc.5:371
6553 msgid "mount ID: unique identifier of the mount (may be reused after B<umount>(2))."
6557 #: build/C/man5/proc.5:371 build/C/man5/proc.5:464
6563 #: build/C/man5/proc.5:374
6564 msgid "parent ID: ID of parent mount (or of self for the top of the mount tree)."
6568 #: build/C/man5/proc.5:374 build/C/man5/proc.5:467
6574 #: build/C/man5/proc.5:380
6575 msgid "major:minor: value of I<st_dev> for files on file system (see B<stat>(2))."
6579 #: build/C/man5/proc.5:380 build/C/man5/proc.5:470
6585 #: build/C/man5/proc.5:383
6586 msgid "root: root of the mount within the file system."
6590 #: build/C/man5/proc.5:383
6596 #: build/C/man5/proc.5:386
6597 msgid "mount point: mount point relative to the process's root."
6601 #: build/C/man5/proc.5:386
6607 #: build/C/man5/proc.5:389
6608 msgid "mount options: per-mount options."
6612 #: build/C/man5/proc.5:389
6618 #: build/C/man5/proc.5:392
6619 msgid "optional fields: zero or more fields of the form \"tag[:value]\"."
6623 #: build/C/man5/proc.5:392
6629 #: build/C/man5/proc.5:395
6630 msgid "separator: marks the end of the optional fields."
6634 #: build/C/man5/proc.5:395
6640 #: build/C/man5/proc.5:398
6641 msgid "file system type: name of file system in the form \"type[.subtype]\"."
6645 #: build/C/man5/proc.5:398
6651 #: build/C/man5/proc.5:401
6652 msgid "mount source: file system-specific information or \"none\"."
6656 #: build/C/man5/proc.5:401
6662 #: build/C/man5/proc.5:404
6663 msgid "super options: per-super block options."
6667 #: build/C/man5/proc.5:408
6669 "Parsers should ignore all unrecognized optional fields. Currently the "
6670 "possible optional fields are:"
6674 #: build/C/man5/proc.5:409
6680 #: build/C/man5/proc.5:412
6681 msgid "mount is shared in peer group X"
6685 #: build/C/man5/proc.5:412
6691 #: build/C/man5/proc.5:415
6692 msgid "mount is slave to peer group X"
6696 #: build/C/man5/proc.5:415
6698 msgid "propagate_from:X"
6702 #: build/C/man5/proc.5:418
6703 msgid "mount is slave and receives propagation from peer group X (*)"
6707 #: build/C/man5/proc.5:418
6713 #: build/C/man5/proc.5:421
6714 msgid "mount is unbindable"
6718 #: build/C/man5/proc.5:428
6720 "(*) X is the closest dominant peer group under the process's root. If X is "
6721 "the immediate master of the mount, or if there is no dominant peer group "
6722 "under the same root, then only the \"master:X\" field is present and not the "
6723 "\"propagate_from:X\" field."
6727 #: build/C/man5/proc.5:432
6729 "For more information on mount propagation see: "
6730 "I<Documentation/filesystems/sharedsubtree.txt> in the kernel source tree."
6734 #: build/C/man5/proc.5:432
6736 msgid "I</proc/[pid]/mounts> (since Linux 2.4.19)"
6740 #: build/C/man5/proc.5:447
6742 "This is a list of all the file systems currently mounted in the process's "
6743 "mount namespace. The format of this file is documented in B<fstab>(5). "
6744 "Since kernel version 2.6.15, this file is pollable: after opening the file "
6745 "for reading, a change in this file (i.e., a file system mount or unmount) "
6746 "causes B<select>(2) to mark the file descriptor as readable, and B<poll>(2) "
6747 "and B<epoll_wait>(2) mark the file as having an error condition."
6751 #: build/C/man5/proc.5:447
6753 msgid "I</proc/[pid]/mountstats> (since Linux 2.6.17)"
6757 #: build/C/man5/proc.5:452
6759 "This file exports information (statistics, configuration information) about "
6760 "the mount points in the process's name space. Lines in this file have the "
6765 #: build/C/man5/proc.5:456
6768 "device /dev/sda7 mounted on /home with fstype ext3 [statistics]\n"
6769 "( 1 ) ( 2 ) (3 ) (4)\n"
6773 #: build/C/man5/proc.5:459
6774 msgid "The fields in each line are:"
6778 #: build/C/man5/proc.5:464
6780 "The name of the mounted device (or \"nodevice\" if there is no corresponding "
6785 #: build/C/man5/proc.5:467
6786 msgid "The mount point within the file system tree."
6790 #: build/C/man5/proc.5:470
6791 msgid "The file system type."
6795 #: build/C/man5/proc.5:475
6797 "Optional statistics and configuration information. Currently (as at Linux "
6798 "2.6.26), only NFS file systems export information via this field."
6802 #: build/C/man5/proc.5:478
6803 msgid "This file is only readable by the owner of the process."
6807 #: build/C/man5/proc.5:478
6809 msgid "I</proc/[pid]/ns/> (since Linux 3.0)"
6812 #. See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f
6814 #: build/C/man5/proc.5:486
6816 "This is a subdirectory containing one entry for each namespace that supports "
6817 "being manipulated by B<setns>(2). For information about namespaces, see "
6822 #: build/C/man5/proc.5:486
6824 msgid "I</proc/[pid]/ns/ipc> (since Linux 3.0)"
6828 #: build/C/man5/proc.5:494
6830 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6831 "filesystem keeps the IPC namespace of the process specified by I<pid> alive "
6832 "even if all processes currently in the namespace terminate."
6836 #: build/C/man5/proc.5:503
6838 "Opening this file returns a file handle for the IPC namespace of the process "
6839 "specified by I<pid>. As long as this file descriptor remains open, the IPC "
6840 "namespace will remain alive, even if all processes in the namespace "
6841 "terminate. The file descriptor can be passed to B<setns>(2)."
6845 #: build/C/man5/proc.5:503
6847 msgid "I</proc/[pid]/ns/net> (since Linux 3.0)"
6851 #: build/C/man5/proc.5:511
6853 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6854 "filesystem keeps the network namespace of the process specified by I<pid> "
6855 "alive even if all processes in the namespace terminate."
6859 #: build/C/man5/proc.5:520
6861 "Opening this file returns a file handle for the network namespace of the "
6862 "process specified by I<pid>. As long as this file descriptor remains open, "
6863 "the network namespace will remain alive, even if all processes in the "
6864 "namespace terminate. The file descriptor can be passed to B<setns>(2)."
6868 #: build/C/man5/proc.5:520
6870 msgid "I</proc/[pid]/ns/uts> (since Linux 3.0)"
6874 #: build/C/man5/proc.5:528
6876 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6877 "filesystem keeps the UTS namespace of the process specified by I<pid> alive "
6878 "even if all processes currently in the namespace terminate."
6882 #: build/C/man5/proc.5:537
6884 "Opening this file returns a file handle for the UTS namespace of the process "
6885 "specified by I<pid>. As long as this file descriptor remains open, the UTS "
6886 "namespace will remain alive, even if all processes in the namespace "
6887 "terminate. The file descriptor can be passed to B<setns>(2)."
6891 #: build/C/man5/proc.5:537
6893 msgid "I</proc/[pid]/numa_maps> (since Linux 2.6.14)"
6897 #: build/C/man5/proc.5:541
6898 msgid "See B<numa>(7)."
6902 #: build/C/man5/proc.5:541
6904 msgid "I</proc/[pid]/oom_adj> (since Linux 2.6.11)"
6908 #: build/C/man5/proc.5:561
6910 "This file can be used to adjust the score used to select which process "
6911 "should be killed in an out-of-memory (OOM) situation. The kernel uses this "
6912 "value for a bit-shift operation of the process's I<oom_score> value: valid "
6913 "values are in the range -16 to +15, plus the special value -17, which "
6914 "disables OOM-killing altogether for this process. A positive score "
6915 "increases the likelihood of this process being killed by the OOM-killer; a "
6916 "negative score decreases the likelihood. The default value for this file is "
6917 "0; a new process inherits its parent's I<oom_adj> setting. A process must "
6918 "be privileged (B<CAP_SYS_RESOURCE>) to update this file."
6922 #: build/C/man5/proc.5:561
6924 msgid "I</proc/[pid]/oom_score> (since Linux 2.6.11)"
6927 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
6928 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
6930 #: build/C/man5/proc.5:572
6932 "This file displays the current score that the kernel gives to this process "
6933 "for the purpose of selecting a process for the OOM-killer. A higher score "
6934 "means that the process is more likely to be selected by the OOM-killer. The "
6935 "basis for this score is the amount of memory used by the process, with "
6936 "increases (+) or decreases (-) for factors including:"
6940 #: build/C/man5/proc.5:577
6941 msgid "whether the process creates a lot of children using B<fork>(2) (+);"
6945 #: build/C/man5/proc.5:580
6947 "whether the process has been running a long time, or has used a lot of CPU "
6952 #: build/C/man5/proc.5:582
6953 msgid "whether the process has a low nice value (i.e., E<gt> 0) (+);"
6956 #. More precisely, if it has CAP_SYS_ADMIN or CAP_SYS_RESOURCE
6958 #: build/C/man5/proc.5:585
6959 msgid "whether the process is privileged (-); and"
6962 #. More precisely, if it has CAP_SYS_RAWIO
6964 #: build/C/man5/proc.5:588
6965 msgid "whether the process is making direct hardware access (-)."
6968 #. FIXME Describe /proc/[pid]/pagemap
6970 #. CONFIG_PROC_PAGE_MONITOR
6972 #: build/C/man5/proc.5:598
6974 "The I<oom_score> also reflects the bit-shift adjustment specified by the "
6975 "I<oom_adj> setting for the process."
6979 #: build/C/man5/proc.5:598
6981 msgid "I</proc/[pid]/root>"
6985 #: build/C/man5/proc.5:606
6987 "UNIX and Linux support the idea of a per-process root of the file system, "
6988 "set by the B<chroot>(2) system call. This file is a symbolic link that "
6989 "points to the process's root directory, and behaves as exe, fd/*, etc. do."
6993 #: build/C/man5/proc.5:626
6995 msgid "I</proc/[pid]/smaps> (since Linux 2.6.14)"
6998 #. CONFIG_PROC_PAGE_MONITOR
7000 #: build/C/man5/proc.5:631
7002 "This file shows memory consumption for each of the process's mappings. For "
7003 "each of mappings there is a series of lines such as the following:"
7007 #: build/C/man5/proc.5:641
7010 "08048000-080bc000 r-xp 00000000 03:02 13130 /bin/bash\n"
7013 "Shared_Clean: 424 kB\n"
7014 "Shared_Dirty: 0 kB\n"
7015 "Private_Clean: 0 kB\n"
7016 "Private_Dirty: 0 kB\n"
7020 #: build/C/man5/proc.5:651
7022 "The first of these lines shows the same information as is displayed for the "
7023 "mapping in I</proc/[pid]/maps>. The remaining lines show the size of the "
7024 "mapping, the amount of the mapping that is currently resident in RAM, the "
7025 "number of clean and dirty shared pages in the mapping, and the number of "
7026 "clean and dirty private pages in the mapping."
7030 #: build/C/man5/proc.5:656
7032 "This file is only present if the B<CONFIG_MMU> kernel configuration option "
7037 #: build/C/man5/proc.5:656
7039 msgid "I</proc/[pid]/stat>"
7043 #: build/C/man5/proc.5:663
7045 "Status information about the process. This is used by B<ps>(1). It is "
7046 "defined in I</usr/src/linux/fs/proc/array.c>."
7050 #: build/C/man5/proc.5:667
7051 msgid "The fields, in order, with their proper B<scanf>(3) format specifiers, are:"
7055 #: build/C/man5/proc.5:668
7061 #: build/C/man5/proc.5:671
7062 msgid "The process ID."
7066 #: build/C/man5/proc.5:671
7072 #: build/C/man5/proc.5:675
7074 "The filename of the executable, in parentheses. This is visible whether or "
7075 "not the executable is swapped out."
7079 #: build/C/man5/proc.5:675
7085 #: build/C/man5/proc.5:681
7087 "One character from the string \"RSDZTW\" where R is running, S is sleeping "
7088 "in an interruptible wait, D is waiting in uninterruptible disk sleep, Z is "
7089 "zombie, T is traced or stopped (on a signal), and W is paging."
7093 #: build/C/man5/proc.5:681
7099 #: build/C/man5/proc.5:684
7100 msgid "The PID of the parent."
7104 #: build/C/man5/proc.5:684
7110 #: build/C/man5/proc.5:687
7111 msgid "The process group ID of the process."
7115 #: build/C/man5/proc.5:687
7117 msgid "I<session> %d"
7121 #: build/C/man5/proc.5:690
7122 msgid "The session ID of the process."
7126 #: build/C/man5/proc.5:690
7128 msgid "I<tty_nr> %d"
7132 #: build/C/man5/proc.5:696
7134 "The controlling terminal of the process. (The minor device number is "
7135 "contained in the combination of bits 31 to 20 and 7 to 0; the major device "
7136 "number is in bits 15 to 8.)"
7140 #: build/C/man5/proc.5:696
7145 #. This field and following, up to and including wchan added 0.99.1
7147 #: build/C/man5/proc.5:701
7149 "The ID of the foreground process group of the controlling terminal of the "
7154 #: build/C/man5/proc.5:701
7156 msgid "I<flags> %u (%lu before Linux 2.6.22)"
7160 #: build/C/man5/proc.5:708
7162 "The kernel flags word of the process. For bit meanings, see the PF_* "
7163 "defines in I<E<lt>linux/sched.hE<gt>>. Details depend on the kernel "
7168 #: build/C/man5/proc.5:708
7170 msgid "I<minflt> %lu"
7174 #: build/C/man5/proc.5:712
7176 "The number of minor faults the process has made which have not required "
7177 "loading a memory page from disk."
7182 #: build/C/man5/proc.5:712
7184 msgid "I<cminflt> %lu"
7188 #: build/C/man5/proc.5:717
7189 msgid "The number of minor faults that the process's waited-for children have made."
7193 #: build/C/man5/proc.5:717
7195 msgid "I<majflt> %lu"
7199 #: build/C/man5/proc.5:721
7201 "The number of major faults the process has made which have required loading "
7202 "a memory page from disk."
7206 #: build/C/man5/proc.5:721
7208 msgid "I<cmajflt> %lu"
7212 #: build/C/man5/proc.5:725
7213 msgid "The number of major faults that the process's waited-for children have made."
7217 #: build/C/man5/proc.5:725
7219 msgid "I<utime> %lu"
7223 #: build/C/man5/proc.5:734
7225 "Amount of time that this process has been scheduled in user mode, measured "
7226 "in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>. This includes guest "
7227 "time, I<guest_time> (time spent running a virtual CPU, see below), so that "
7228 "applications that are not aware of the guest time field do not lose that "
7229 "time from their calculations."
7233 #: build/C/man5/proc.5:734
7235 msgid "I<stime> %lu"
7239 #: build/C/man5/proc.5:739
7241 "Amount of time that this process has been scheduled in kernel mode, measured "
7242 "in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>."
7246 #: build/C/man5/proc.5:739
7248 msgid "I<cutime> %ld"
7252 #: build/C/man5/proc.5:749
7254 "Amount of time that this process's waited-for children have been scheduled "
7255 "in user mode, measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>. "
7256 "(See also B<times>(2).) This includes guest time, I<cguest_time> (time "
7257 "spent running a virtual CPU, see below)."
7261 #: build/C/man5/proc.5:749
7263 msgid "I<cstime> %ld"
7267 #: build/C/man5/proc.5:755
7269 "Amount of time that this process's waited-for children have been scheduled "
7270 "in kernel mode, measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>."
7274 #: build/C/man5/proc.5:755
7276 msgid "I<priority> %ld"
7280 #: build/C/man5/proc.5:772
7282 "(Explanation for Linux 2.6) For processes running a real-time scheduling "
7283 "policy (I<policy> below; see B<sched_setscheduler>(2)), this is the negated "
7284 "scheduling priority, minus one; that is, a number in the range -2 to -100, "
7285 "corresponding to real-time priorities 1 to 99. For processes running under "
7286 "a non-real-time scheduling policy, this is the raw nice value "
7287 "(B<setpriority>(2)) as represented in the kernel. The kernel stores nice "
7288 "values as numbers in the range 0 (high) to 39 (low), corresponding to the "
7289 "user-visible nice range of -20 to 19."
7292 #. And back in kernel 1.2 days things were different again.
7294 #: build/C/man5/proc.5:776
7296 "Before Linux 2.6, this was a scaled value based on the scheduler weighting "
7297 "given to this process."
7301 #: build/C/man5/proc.5:776
7306 #. Back in kernel 1.2 days things were different.
7308 #: build/C/man5/proc.5:782
7310 "The nice value (see B<setpriority>(2)), a value in the range 19 (low "
7311 "priority) to -20 (high priority)."
7315 #. \fIcounter\fP %ld
7316 #. The current maximum size in jiffies of the process's next timeslice,
7317 #. or what is currently left of its current timeslice, if it is the
7318 #. currently running process.
7321 #. The time in jiffies of the process's next timeout.
7322 #. timeout was removed sometime around 2.1/2.2
7324 #: build/C/man5/proc.5:782
7326 msgid "I<num_threads> %ld"
7330 #: build/C/man5/proc.5:796
7332 "Number of threads in this process (since Linux 2.6). Before kernel 2.6, "
7333 "this field was hard coded to 0 as a placeholder for an earlier removed "
7339 #: build/C/man5/proc.5:796
7341 msgid "I<itrealvalue> %ld"
7345 #: build/C/man5/proc.5:804
7347 "The time in jiffies before the next B<SIGALRM> is sent to the process due to "
7348 "an interval timer. Since kernel 2.6.17, this field is no longer maintained, "
7349 "and is hard coded as 0."
7353 #: build/C/man5/proc.5:804
7355 msgid "I<starttime> %llu (was %lu before Linux 2.6)"
7359 #: build/C/man5/proc.5:807
7360 msgid "The time in jiffies the process started after system boot."
7364 #: build/C/man5/proc.5:807
7366 msgid "I<vsize> %lu"
7370 #: build/C/man5/proc.5:810
7371 msgid "Virtual memory size in bytes."
7375 #: build/C/man5/proc.5:810
7381 #: build/C/man5/proc.5:817
7383 "Resident Set Size: number of pages the process has in real memory. This is "
7384 "just the pages which count toward text, data, or stack space. This does not "
7385 "include pages which have not been demand-loaded in, or which are swapped "
7390 #: build/C/man5/proc.5:817
7392 msgid "I<rsslim> %lu"
7396 #: build/C/man5/proc.5:824
7398 "Current soft limit in bytes on the rss of the process; see the description "
7399 "of B<RLIMIT_RSS> in B<getpriority>(2)."
7403 #: build/C/man5/proc.5:824
7405 msgid "I<startcode> %lu"
7409 #: build/C/man5/proc.5:827
7410 msgid "The address above which program text can run."
7414 #: build/C/man5/proc.5:827
7416 msgid "I<endcode> %lu"
7420 #: build/C/man5/proc.5:830
7421 msgid "The address below which program text can run."
7425 #: build/C/man5/proc.5:830
7427 msgid "I<startstack> %lu"
7431 #: build/C/man5/proc.5:833
7432 msgid "The address of the start (i.e., bottom) of the stack."
7436 #: build/C/man5/proc.5:833
7438 msgid "I<kstkesp> %lu"
7442 #: build/C/man5/proc.5:837
7444 "The current value of ESP (stack pointer), as found in the kernel stack page "
7449 #: build/C/man5/proc.5:837
7451 msgid "I<kstkeip> %lu"
7455 #: build/C/man5/proc.5:840
7456 msgid "The current EIP (instruction pointer)."
7461 #: build/C/man5/proc.5:840
7463 msgid "I<signal> %lu"
7467 #: build/C/man5/proc.5:847
7469 "The bitmap of pending signals, displayed as a decimal number. Obsolete, "
7470 "because it does not provide information on real-time signals; use "
7471 "I</proc/[pid]/status> instead."
7475 #: build/C/man5/proc.5:847
7477 msgid "I<blocked> %lu"
7481 #: build/C/man5/proc.5:853
7483 "The bitmap of blocked signals, displayed as a decimal number. Obsolete, "
7484 "because it does not provide information on real-time signals; use "
7485 "I</proc/[pid]/status> instead."
7489 #: build/C/man5/proc.5:853
7491 msgid "I<sigignore> %lu"
7495 #: build/C/man5/proc.5:859
7497 "The bitmap of ignored signals, displayed as a decimal number. Obsolete, "
7498 "because it does not provide information on real-time signals; use "
7499 "I</proc/[pid]/status> instead."
7503 #: build/C/man5/proc.5:859
7505 msgid "I<sigcatch> %lu"
7509 #: build/C/man5/proc.5:865
7511 "The bitmap of caught signals, displayed as a decimal number. Obsolete, "
7512 "because it does not provide information on real-time signals; use "
7513 "I</proc/[pid]/status> instead."
7517 #: build/C/man5/proc.5:865
7519 msgid "I<wchan> %lu"
7523 #: build/C/man5/proc.5:875
7525 "This is the \"channel\" in which the process is waiting. It is the address "
7526 "of a system call, and can be looked up in a namelist if you need a textual "
7527 "name. (If you have an up-to-date I</etc/psdatabase>, then try I<ps -l> to "
7528 "see the WCHAN field in action.)"
7532 #: build/C/man5/proc.5:875
7534 msgid "I<nswap> %lu"
7537 #. nswap was added in 2.0
7539 #: build/C/man5/proc.5:879
7540 msgid "Number of pages swapped (not maintained)."
7544 #: build/C/man5/proc.5:879
7546 msgid "I<cnswap> %lu"
7549 #. cnswap was added in 2.0
7551 #: build/C/man5/proc.5:883
7552 msgid "Cumulative I<nswap> for child processes (not maintained)."
7556 #: build/C/man5/proc.5:883
7558 msgid "I<exit_signal> %d (since Linux 2.1.22)"
7562 #: build/C/man5/proc.5:886
7563 msgid "Signal to be sent to parent when we die."
7567 #: build/C/man5/proc.5:886
7569 msgid "I<processor> %d (since Linux 2.2.8)"
7573 #: build/C/man5/proc.5:889
7574 msgid "CPU number last executed on."
7578 #: build/C/man5/proc.5:889
7580 msgid "I<rt_priority> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
7584 #: build/C/man5/proc.5:895
7586 "Real-time scheduling priority, a number in the range 1 to 99 for processes "
7587 "scheduled under a real-time policy, or 0, for non-real-time processes (see "
7588 "B<sched_setscheduler>(2))."
7593 #: build/C/man5/proc.5:895
7595 msgid "I<policy> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
7599 #: build/C/man5/proc.5:902
7601 "Scheduling policy (see B<sched_setscheduler>(2)). Decode using the SCHED_* "
7602 "constants in I<linux/sched.h>."
7606 #: build/C/man5/proc.5:902
7608 msgid "I<delayacct_blkio_ticks> %llu (since Linux 2.6.18)"
7612 #: build/C/man5/proc.5:905
7613 msgid "Aggregated block I/O delays, measured in clock ticks (centiseconds)."
7617 #: build/C/man5/proc.5:905
7619 msgid "I<guest_time> %lu (since Linux 2.6.24)"
7623 #: build/C/man5/proc.5:910
7625 "Guest time of the process (time spent running a virtual CPU for a guest "
7626 "operating system), measured in clock ticks (divide by "
7627 "I<sysconf(_SC_CLK_TCK)>."
7631 #: build/C/man5/proc.5:910
7633 msgid "I<cguest_time> %ld (since Linux 2.6.24)"
7637 #: build/C/man5/proc.5:914
7639 "Guest time of the process's children, measured in clock ticks (divide by "
7640 "I<sysconf(_SC_CLK_TCK)>."
7644 #: build/C/man5/proc.5:915
7646 msgid "I</proc/[pid]/statm>"
7650 #: build/C/man5/proc.5:919
7652 "Provides information about memory usage, measured in pages. The columns "
7656 #. (not including libs; broken, includes data segment)
7657 #. (including libs; broken, includes library text)
7659 #: build/C/man5/proc.5:933
7662 "size total program size\n"
7663 " (same as VmSize in I</proc/[pid]/status>)\n"
7664 "resident resident set size\n"
7665 " (same as VmRSS in I</proc/[pid]/status>)\n"
7666 "share shared pages (from shared mappings)\n"
7667 "text text (code)\n"
7668 "lib library (unused in Linux 2.6)\n"
7669 "data data + stack\n"
7670 "dt dirty pages (unused in Linux 2.6)\n"
7674 #: build/C/man5/proc.5:935
7676 msgid "I</proc/[pid]/status>"
7680 #: build/C/man5/proc.5:943
7682 "Provides much of the information in I</proc/[pid]/stat> and "
7683 "I</proc/[pid]/statm> in a format that's easier for humans to parse. Here's "
7688 #: build/C/man5/proc.5:984
7691 "$B< cat /proc/$$/status>\n"
7693 "State: S (sleeping)\n"
7698 "Uid: 1000 1000 1000 1000\n"
7699 "Gid: 100 100 100 100\n"
7701 "Groups: 16 33 100\n"
7714 "SigPnd: 0000000000000000\n"
7715 "ShdPnd: 0000000000000000\n"
7716 "SigBlk: 0000000000010000\n"
7717 "SigIgn: 0000000000384004\n"
7718 "SigCgt: 000000004b813efb\n"
7719 "CapInh: 0000000000000000\n"
7720 "CapPrm: 0000000000000000\n"
7721 "CapEff: 0000000000000000\n"
7722 "CapBnd: ffffffffffffffff\n"
7723 "Cpus_allowed: 00000001\n"
7724 "Cpus_allowed_list: 0\n"
7726 "Mems_allowed_list: 0\n"
7727 "voluntary_ctxt_switches: 150\n"
7728 "nonvoluntary_ctxt_switches: 545\n"
7732 #: build/C/man5/proc.5:988
7733 msgid "The fields are as follows:"
7737 #: build/C/man5/proc.5:992
7738 msgid "I<Name>: Command run by this process."
7742 #: build/C/man5/proc.5:1003
7744 "I<State>: Current state of the process. One of \"R (running)\", \"S "
7745 "(sleeping)\", \"D (disk sleep)\", \"T (stopped)\", \"T (tracing stop)\", \"Z "
7746 "(zombie)\", or \"X (dead)\"."
7750 #: build/C/man5/proc.5:1006
7751 msgid "I<Tgid>: Thread group ID (i.e., Process ID)."
7755 #: build/C/man5/proc.5:1010
7756 msgid "I<Pid>: Thread ID (see B<gettid>(2))."
7760 #: build/C/man5/proc.5:1013
7761 msgid "I<PPid>: PID of parent process."
7765 #: build/C/man5/proc.5:1016
7766 msgid "I<TracerPid>: PID of process tracing this process (0 if not being traced)."
7770 #: build/C/man5/proc.5:1019
7771 msgid "I<Uid>, I<Gid>: Real, effective, saved set, and file system UIDs (GIDs)."
7775 #: build/C/man5/proc.5:1022
7776 msgid "I<FDSize>: Number of file descriptor slots currently allocated."
7780 #: build/C/man5/proc.5:1025
7781 msgid "I<Groups>: Supplementary group list."
7785 #: build/C/man5/proc.5:1028
7786 msgid "I<VmPeak>: Peak virtual memory size."
7790 #: build/C/man5/proc.5:1031
7791 msgid "I<VmSize>: Virtual memory size."
7795 #: build/C/man5/proc.5:1035
7796 msgid "I<VmLck>: Locked memory size (see B<mlock>(3))."
7800 #: build/C/man5/proc.5:1038
7801 msgid "I<VmHWM>: Peak resident set size (\"high water mark\")."
7805 #: build/C/man5/proc.5:1041
7806 msgid "I<VmRSS>: Resident set size."
7810 #: build/C/man5/proc.5:1044
7811 msgid "I<VmData>, I<VmStk>, I<VmExe>: Size of data, stack, and text segments."
7815 #: build/C/man5/proc.5:1047
7816 msgid "I<VmLib>: Shared library code size."
7820 #: build/C/man5/proc.5:1050
7821 msgid "I<VmPTE>: Page table entries size (since Linux 2.6.10)."
7825 #: build/C/man5/proc.5:1053
7826 msgid "I<Threads>: Number of threads in process containing this thread."
7830 #: build/C/man5/proc.5:1064
7832 "I<SigQ>: This field contains two slash-separated numbers that relate to "
7833 "queued signals for the real user ID of this process. The first of these is "
7834 "the number of currently queued signals for this real user ID, and the second "
7835 "is the resource limit on the number of queued signals for this process (see "
7836 "the description of B<RLIMIT_SIGPENDING> in B<getrlimit>(2))."
7840 #: build/C/man5/proc.5:1070
7842 "I<SigPnd>, I<ShdPnd>: Number of signals pending for thread and for process "
7843 "as a whole (see B<pthreads>(7) and B<signal>(7))."
7847 #: build/C/man5/proc.5:1074
7849 "I<SigBlk>, I<SigIgn>, I<SigCgt>: Masks indicating signals being blocked, "
7850 "ignored, and caught (see B<signal>(7))."
7854 #: build/C/man5/proc.5:1079
7856 "I<CapInh>, I<CapPrm>, I<CapEff>: Masks of capabilities enabled in "
7857 "inheritable, permitted, and effective sets (see B<capabilities>(7))."
7861 #: build/C/man5/proc.5:1084
7863 "I<CapBnd>: Capability Bounding set (since kernel 2.6.26, see "
7864 "B<capabilities>(7))."
7868 #: build/C/man5/proc.5:1089
7870 "I<Cpus_allowed>: Mask of CPUs on which this process may run (since Linux "
7871 "2.6.24, see B<cpuset>(7))."
7875 #: build/C/man5/proc.5:1094
7877 "I<Cpus_allowed_list>: Same as previous, but in \"list format\" (since Linux "
7878 "2.6.26, see B<cpuset>(7))."
7882 #: build/C/man5/proc.5:1099
7884 "I<Mems_allowed>: Mask of memory nodes allowed to this process (since Linux "
7885 "2.6.24, see B<cpuset>(7))."
7889 #: build/C/man5/proc.5:1104
7891 "I<Mems_allowed_list>: Same as previous, but in \"list format\" (since Linux "
7892 "2.6.26, see B<cpuset>(7))."
7896 #: build/C/man5/proc.5:1107
7898 "I<voluntary_context_switches>, I<nonvoluntary_context_switches>: Number of "
7899 "voluntary and involuntary context switches (since Linux 2.6.23)."
7903 #: build/C/man5/proc.5:1108
7905 msgid "I</proc/[pid]/task> (since Linux 2.6.0-test6)"
7909 #: build/C/man5/proc.5:1139
7911 "This is a directory that contains one subdirectory for each thread in the "
7912 "process. The name of each subdirectory is the numerical thread ID "
7913 "(I<[tid]>) of the thread (see B<gettid>(2)). Within each of these "
7914 "subdirectories, there is a set of files with the same names and contents as "
7915 "under the I</proc/[pid]> directories. For attributes that are shared by all "
7916 "threads, the contents for each of the files under the I<task/[tid]> "
7917 "subdirectories will be the same as in the corresponding file in the parent "
7918 "I</proc/[pid]> directory (e.g., in a multithreaded process, all of the "
7919 "I<task/[tid]/cwd> files will have the same value as the I</proc/[pid]/cwd> "
7920 "file in the parent directory, since all of the threads in a process share a "
7921 "working directory). For attributes that are distinct for each thread, the "
7922 "corresponding files under I<task/[tid]> may have different values (e.g., "
7923 "various fields in each of the I<task/[tid]/status> files may be different "
7927 #. The following was still true as at kernel 2.6.13
7929 #: build/C/man5/proc.5:1146
7931 "In a multithreaded process, the contents of the I</proc/[pid]/task> "
7932 "directory are not available if the main thread has already terminated "
7933 "(typically by calling B<pthread_exit>(3))."
7937 #: build/C/man5/proc.5:1146
7939 msgid "I</proc/apm>"
7943 #: build/C/man5/proc.5:1151
7945 "Advanced power management version and battery information when B<CONFIG_APM> "
7946 "is defined at kernel compilation time."
7950 #: build/C/man5/proc.5:1151
7952 msgid "I</proc/bus>"
7956 #: build/C/man5/proc.5:1154
7957 msgid "Contains subdirectories for installed busses."
7961 #: build/C/man5/proc.5:1154
7963 msgid "I</proc/bus/pccard>"
7967 #: build/C/man5/proc.5:1159
7969 "Subdirectory for PCMCIA devices when B<CONFIG_PCMCIA> is set at kernel "
7974 #: build/C/man5/proc.5:1159
7976 msgid "I</proc/bus/pccard/drivers>"
7980 #: build/C/man5/proc.5:1161
7982 msgid "I</proc/bus/pci>"
7986 #: build/C/man5/proc.5:1167
7988 "Contains various bus subdirectories and pseudo-files containing information "
7989 "about PCI busses, installed devices, and device drivers. Some of these "
7990 "files are not ASCII."
7994 #: build/C/man5/proc.5:1167
7996 msgid "I</proc/bus/pci/devices>"
8000 #: build/C/man5/proc.5:1174
8002 "Information about PCI devices. They may be accessed through B<lspci>(8) "
8007 #: build/C/man5/proc.5:1174
8009 msgid "I</proc/cmdline>"
8013 #: build/C/man5/proc.5:1181
8015 "Arguments passed to the Linux kernel at boot time. Often done via a boot "
8016 "manager such as B<lilo>(8) or B<grub>(8)."
8020 #: build/C/man5/proc.5:1181
8022 msgid "I</proc/config.gz> (since Linux 2.6)"
8026 #: build/C/man5/proc.5:1199
8028 "This file exposes the configuration options that were used to build the "
8029 "currently running kernel, in the same format as they would be shown in the "
8030 "I<.config> file that resulted when configuring the kernel (using I<make "
8031 "xconfig>, I<make config>, or similar). The file contents are compressed; "
8032 "view or search them using B<zcat>(1), B<zgrep>(1), etc. As long as no "
8033 "changes have been made to the following file, the contents of "
8034 "I</proc/config.gz> are the same as those provided by :"
8038 #: build/C/man5/proc.5:1203
8040 msgid "cat /lib/modules/$(uname -r)/build/.config\n"
8044 #: build/C/man5/proc.5:1209
8046 "I</proc/config.gz> is only provided if the kernel is configured with "
8047 "B<CONFIG_IKCONFIG_PROC>."
8051 #: build/C/man5/proc.5:1209
8053 msgid "I</proc/cpuinfo>"
8057 #: build/C/man5/proc.5:1218
8059 "This is a collection of CPU and system architecture dependent items, for "
8060 "each supported architecture a different list. Two common entries are "
8061 "I<processor> which gives CPU number and I<bogomips>; a system constant that "
8062 "is calculated during kernel initialization. SMP machines have information "
8067 #: build/C/man5/proc.5:1218
8069 msgid "I</proc/devices>"
8073 #: build/C/man5/proc.5:1222
8075 "Text listing of major numbers and device groups. This can be used by "
8076 "MAKEDEV scripts for consistency with the kernel."
8080 #: build/C/man5/proc.5:1222
8082 msgid "I</proc/diskstats> (since Linux 2.5.69)"
8086 #: build/C/man5/proc.5:1228
8088 "This file contains disk I/O statistics for each disk device. See the kernel "
8089 "source file I<Documentation/iostats.txt> for further information."
8093 #: build/C/man5/proc.5:1228
8095 msgid "I</proc/dma>"
8099 #: build/C/man5/proc.5:1232
8101 "This is a list of the registered I<ISA> DMA (direct memory access) channels "
8106 #: build/C/man5/proc.5:1232
8108 msgid "I</proc/driver>"
8112 #: build/C/man5/proc.5:1235 build/C/man5/proc.5:1263
8113 msgid "Empty subdirectory."
8117 #: build/C/man5/proc.5:1235
8119 msgid "I</proc/execdomains>"
8123 #: build/C/man5/proc.5:1238
8124 msgid "List of the execution domains (ABI personalities)."
8128 #: build/C/man5/proc.5:1238
8134 #: build/C/man5/proc.5:1243
8136 "Frame buffer information when B<CONFIG_FB> is defined during kernel "
8141 #: build/C/man5/proc.5:1243
8143 msgid "I</proc/filesystems>"
8147 #: build/C/man5/proc.5:1253
8149 "A text listing of the file systems which are supported by the kernel, namely "
8150 "file systems which were compiled into the kernel or whose kernel modules are "
8151 "currently loaded. (See also B<filesystems>(5).) If a file system is marked "
8152 "with \"nodev\", this means that it does not require a block device to be "
8153 "mounted (e.g., virtual file system, network file system)."
8157 #: build/C/man5/proc.5:1260
8159 "Incidentally, this file may be used by B<mount>(8) when no file system is "
8160 "specified and it didn't manage to determine the file system type. Then file "
8161 "systems contained in this file are tried (excepted those that are marked "
8166 #: build/C/man5/proc.5:1260
8172 #: build/C/man5/proc.5:1263
8174 msgid "I</proc/ide>"
8178 #: build/C/man5/proc.5:1269
8180 "This directory exists on systems with the IDE bus. There are directories "
8181 "for each IDE channel and attached device. Files include:"
8185 #: build/C/man5/proc.5:1282
8188 "cache buffer size in KB\n"
8189 "capacity number of sectors\n"
8190 "driver driver version\n"
8191 "geometry physical and logical geometry\n"
8192 "identify in hexadecimal\n"
8193 "media media type\n"
8194 "model manufacturer's model number\n"
8195 "settings drive settings\n"
8196 "smart_thresholds in hexadecimal\n"
8197 "smart_values in hexadecimal\n"
8201 #: build/C/man5/proc.5:1288
8203 "The B<hdparm>(8) utility provides access to this information in a friendly "
8208 #: build/C/man5/proc.5:1288
8210 msgid "I</proc/interrupts>"
8214 #: build/C/man5/proc.5:1298
8216 "This is used to record the number of interrupts per CPU per IO device. "
8217 "Since Linux 2.6.24, for the i386 and x86_64 architectures, at least, this "
8218 "also includes interrupts internal to the system (that is, not associated "
8219 "with a device as such), such as NMI (nonmaskable interrupt), LOC (local "
8220 "timer interrupt), and for SMP systems, TLB (TLB flush interrupt), RES "
8221 "(rescheduling interrupt), CAL (remote function call interrupt), and possibly "
8222 "others. Very easy to read formatting, done in ASCII."
8226 #: build/C/man5/proc.5:1298
8228 msgid "I</proc/iomem>"
8232 #: build/C/man5/proc.5:1301
8233 msgid "I/O memory map in Linux 2.4."
8237 #: build/C/man5/proc.5:1301
8239 msgid "I</proc/ioports>"
8243 #: build/C/man5/proc.5:1305
8245 "This is a list of currently registered Input-Output port regions that are in "
8250 #: build/C/man5/proc.5:1305
8252 msgid "I</proc/kallsyms> (since Linux 2.5.71)"
8256 #: build/C/man5/proc.5:1313
8258 "This holds the kernel exported symbol definitions used by the B<modules>(X) "
8259 "tools to dynamically link and bind loadable modules. In Linux 2.5.47 and "
8260 "earlier, a similar file with slightly different syntax was named I<ksyms>."
8264 #: build/C/man5/proc.5:1313
8266 msgid "I</proc/kcore>"
8270 #: build/C/man5/proc.5:1322
8272 "This file represents the physical memory of the system and is stored in the "
8273 "ELF core file format. With this pseudo-file, and an unstripped kernel "
8274 "(I</usr/src/linux/vmlinux>) binary, GDB can be used to examine the current "
8275 "state of any kernel data structures."
8279 #: build/C/man5/proc.5:1325
8280 msgid "The total length of the file is the size of physical memory (RAM) plus 4KB."
8284 #: build/C/man5/proc.5:1325
8286 msgid "I</proc/kmsg>"
8290 #: build/C/man5/proc.5:1337
8292 "This file can be used instead of the B<syslog>(2) system call to read "
8293 "kernel messages. A process must have superuser privileges to read this "
8294 "file, and only one process should read this file. This file should not be "
8295 "read if a syslog process is running which uses the B<syslog>(2) system call "
8296 "facility to log kernel messages."
8300 #: build/C/man5/proc.5:1341
8301 msgid "Information in this file is retrieved with the B<dmesg>(1) program."
8305 #: build/C/man5/proc.5:1341
8307 msgid "I</proc/ksyms> (Linux 1.1.23-2.5.47)"
8311 #: build/C/man5/proc.5:1345
8312 msgid "See I</proc/kallsyms>."
8316 #: build/C/man5/proc.5:1345
8318 msgid "I</proc/loadavg>"
8322 #: build/C/man5/proc.5:1360
8324 "The first three fields in this file are load average figures giving the "
8325 "number of jobs in the run queue (state R) or waiting for disk I/O (state D) "
8326 "averaged over 1, 5, and 15 minutes. They are the same as the load average "
8327 "numbers given by B<uptime>(1) and other programs. The fourth field "
8328 "consists of two numbers separated by a slash (/). The first of these is the "
8329 "number of currently runnable kernel scheduling entities (processes, "
8330 "threads). The value after the slash is the number of kernel scheduling "
8331 "entities that currently exist on the system. The fifth field is the PID of "
8332 "the process that was most recently created on the system."
8336 #: build/C/man5/proc.5:1360
8338 msgid "I</proc/locks>"
8342 #: build/C/man5/proc.5:1366
8344 "This file shows current file locks (B<flock>(2) and B<fcntl>(2)) and leases "
8349 #: build/C/man5/proc.5:1366
8351 msgid "I</proc/malloc> (only up to and including Linux 2.2)"
8354 #. It looks like this only ever did something back in 1.0 days
8356 #: build/C/man5/proc.5:1372
8358 "This file is only present if B<CONFIG_DEBUG_MALLOC> was defined during "
8363 #: build/C/man5/proc.5:1372
8365 msgid "I</proc/meminfo>"
8369 #: build/C/man5/proc.5:1380
8371 "This file reports statistics about memory usage on the system. It is used "
8372 "by B<free>(1) to report the amount of free and used memory (both physical "
8373 "and swap) on the system as well as the shared memory and buffers used by "
8378 #: build/C/man5/proc.5:1380
8380 msgid "I</proc/modules>"
8384 #: build/C/man5/proc.5:1385
8386 "A text list of the modules that have been loaded by the system. See also "
8391 #: build/C/man5/proc.5:1385
8393 msgid "I</proc/mounts>"
8397 #: build/C/man5/proc.5:1395
8399 "Before kernel 2.4.19, this file was a list of all the file systems currently "
8400 "mounted on the system. With the introduction of per-process mount "
8401 "namespaces in Linux 2.4.19, this file became a link to I</proc/self/mounts>, "
8402 "which lists the mount points of the process's own mount namespace. The "
8403 "format of this file is documented in B<fstab>(5)."
8407 #: build/C/man5/proc.5:1395
8409 msgid "I</proc/mtrr>"
8413 #: build/C/man5/proc.5:1401
8415 "Memory Type Range Registers. See the kernel source file "
8416 "I<Documentation/mtrr.txt> for details."
8420 #: build/C/man5/proc.5:1401
8422 msgid "I</proc/net>"
8426 #: build/C/man5/proc.5:1411
8428 "various net pseudo-files, all of which give the status of some part of the "
8429 "networking layer. These files contain ASCII structures and are, therefore, "
8430 "readable with B<cat>(1). However, the standard B<netstat>(8) suite "
8431 "provides much cleaner access to these files."
8435 #: build/C/man5/proc.5:1411
8437 msgid "I</proc/net/arp>"
8441 #: build/C/man5/proc.5:1417
8443 "This holds an ASCII readable dump of the kernel ARP table used for address "
8444 "resolutions. It will show both dynamically learned and preprogrammed ARP "
8445 "entries. The format is:"
8449 #: build/C/man5/proc.5:1424
8452 "CW<IP address HW type Flags HW address Mask Device\n"
8453 "192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0\n"
8454 "192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0>\n"
8458 #: build/C/man5/proc.5:1436
8460 "Here \"IP address\" is the IPv4 address of the machine and the \"HW type\" "
8461 "is the hardware type of the address from RFC\\ 826. The flags are the "
8462 "internal flags of the ARP structure (as defined in "
8463 "I</usr/include/linux/if_arp.h>) and the \"HW address\" is the data link "
8464 "layer mapping for that IP address if it is known."
8468 #: build/C/man5/proc.5:1436
8470 msgid "I</proc/net/dev>"
8474 #: build/C/man5/proc.5:1447
8476 "The dev pseudo-file contains network device status information. This gives "
8477 "the number of received and sent packets, the number of errors and collisions "
8478 "and other basic statistics. These are used by the B<ifconfig>(8) program "
8479 "to report device status. The format is:"
8483 #: build/C/man5/proc.5:1457
8486 "CW<Inter-| Receive | "
8488 " face |bytes packets errs drop fifo frame compressed multicast|bytes "
8489 "packets errs drop fifo colls carrier compressed\n"
8490 " lo: 2776770 11307 0 0 0 0 0 0 2776770 "
8491 "11307 0 0 0 0 0 0\n"
8492 " eth0: 1215645 2751 0 0 0 0 0 0 1782404 "
8493 "4324 0 0 0 427 0 0\n"
8494 " ppp0: 1622270 5552 1 0 0 0 0 0 354130 "
8495 "5669 0 0 0 0 0 0\n"
8496 " tap0: 7714 81 0 0 0 0 0 0 7714 "
8501 #: build/C/man5/proc.5:1466
8503 msgid "I</proc/net/dev_mcast>"
8507 #: build/C/man5/proc.5:1470
8508 msgid "Defined in I</usr/src/linux/net/core/dev_mcast.c>:"
8512 #: build/C/man5/proc.5:1476
8515 "indx interface_name dmi_u dmi_g dmi_address\n"
8516 "2 eth0 1 0 01005e000001\n"
8517 "3 eth1 1 0 01005e000001\n"
8518 "4 eth2 1 0 01005e000001\n"
8522 #: build/C/man5/proc.5:1478
8524 msgid "I</proc/net/igmp>"
8528 #: build/C/man5/proc.5:1483
8530 "Internet Group Management Protocol. Defined in "
8531 "I</usr/src/linux/net/core/igmp.c>."
8535 #: build/C/man5/proc.5:1483
8537 msgid "I</proc/net/rarp>"
8541 #: build/C/man5/proc.5:1493
8543 "This file uses the same format as the I<arp> file and contains the current "
8544 "reverse mapping database used to provide B<rarp>(8) reverse address lookup "
8545 "services. If RARP is not configured into the kernel, this file will not be "
8550 #: build/C/man5/proc.5:1493
8552 msgid "I</proc/net/raw>"
8556 #. .I /proc/net/route
8557 #. No information, but looks similar to
8560 #: build/C/man5/proc.5:1513
8562 "Holds a dump of the RAW socket table. Much of the information is not of use "
8563 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
8564 "socket, the \"local_address\" is the local address and protocol number "
8565 "pair. \\&\"St\" is the internal status of the socket. The \"tx_queue\" and "
8566 "\"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
8567 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
8568 "used by RAW. The \"uid\" field holds the effective UID of the creator of "
8573 #: build/C/man5/proc.5:1513
8575 msgid "I</proc/net/snmp>"
8579 #: build/C/man5/proc.5:1518
8581 "This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP "
8582 "management information bases for an SNMP agent."
8586 #: build/C/man5/proc.5:1518
8588 msgid "I</proc/net/tcp>"
8592 #: build/C/man5/proc.5:1534
8594 "Holds a dump of the TCP socket table. Much of the information is not of use "
8595 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
8596 "socket, the \"local_address\" is the local address and port number pair. "
8597 "The \"rem_address\" is the remote address and port number pair (if "
8598 "connected). \\&\"St\" is the internal status of the socket. The "
8599 "\"tx_queue\" and \"rx_queue\" are the outgoing and incoming data queue in "
8600 "terms of kernel memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" "
8601 "fields hold internal information of the kernel socket state and are only "
8602 "useful for debugging. The \"uid\" field holds the effective UID of the "
8603 "creator of the socket."
8607 #: build/C/man5/proc.5:1534
8609 msgid "I</proc/net/udp>"
8613 #: build/C/man5/proc.5:1550
8615 "Holds a dump of the UDP socket table. Much of the information is not of use "
8616 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
8617 "socket, the \"local_address\" is the local address and port number pair. "
8618 "The \"rem_address\" is the remote address and port number pair (if "
8619 "connected). \"St\" is the internal status of the socket. The \"tx_queue\" "
8620 "and \"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
8621 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
8622 "used by UDP. The \"uid\" field holds the effective UID of the creator of "
8623 "the socket. The format is:"
8627 #: build/C/man5/proc.5:1558
8630 "CW<sl local_address rem_address st tx_queue rx_queue tr rexmits "
8631 "tm-E<gt>when uid\n"
8632 " 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 "
8634 " 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 "
8636 " 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 "
8641 #: build/C/man5/proc.5:1561
8643 msgid "I</proc/net/unix>"
8647 #: build/C/man5/proc.5:1566
8649 "Lists the UNIX domain sockets present within the system and their status. "
8654 #: build/C/man5/proc.5:1572
8657 "CW<Num RefCount Protocol Flags Type St Path\n"
8658 " 0: 00000002 00000000 00000000 0001 03\n"
8659 " 1: 00000001 00000000 00010000 0001 01 /dev/printer>\n"
8663 #: build/C/man5/proc.5:1584
8665 "Here \"Num\" is the kernel table slot number, \"RefCount\" is the number of "
8666 "users of the socket, \"Protocol\" is currently always 0, \"Flags\" represent "
8667 "the internal kernel flags holding the status of the socket. Currently, type "
8668 "is always \"1\" (UNIX domain datagram sockets are not yet supported in the "
8669 "kernel). \\&\"St\" is the internal state of the socket and Path is the "
8670 "bound path (if any) of the socket."
8674 #: build/C/man5/proc.5:1584
8676 msgid "I</proc/partitions>"
8680 #: build/C/man5/proc.5:1588
8682 "Contains major and minor numbers of each partition as well as number of "
8683 "blocks and partition name."
8687 #: build/C/man5/proc.5:1588
8689 msgid "I</proc/pci>"
8693 #: build/C/man5/proc.5:1592
8695 "This is a listing of all PCI devices found during kernel initialization and "
8696 "their configuration."
8699 #. FIXME /proc/sched_debug
8701 #. .IR /proc/sched_debug " (since Linux 2.6.23)"
8702 #. See also /proc/[pid]/sched
8704 #: build/C/man5/proc.5:1608
8706 "This file has been deprecated in favor of a new I</proc> interface for PCI "
8707 "(I</proc/bus/pci>). It became optional in Linux 2.2 (available with "
8708 "B<CONFIG_PCI_OLD_PROC> set at kernel compilation). It became once more "
8709 "nonoptionally enabled in Linux 2.4. Next, it was deprecated in Linux 2.6 "
8710 "(still available with B<CONFIG_PCI_LEGACY_PROC> set), and finally removed "
8711 "altogether since Linux 2.6.17."
8715 #: build/C/man5/proc.5:1608
8717 msgid "I</proc/scsi>"
8721 #: build/C/man5/proc.5:1618
8723 "A directory with the I<scsi> mid-level pseudo-file and various SCSI "
8724 "low-level driver directories, which contain a file for each SCSI host in "
8725 "this system, all of which give the status of some part of the SCSI IO "
8726 "subsystem. These files contain ASCII structures and are, therefore, "
8727 "readable with B<cat>(1)."
8731 #: build/C/man5/proc.5:1621
8733 "You can also write to some of the files to reconfigure the subsystem or "
8734 "switch certain features on or off."
8738 #: build/C/man5/proc.5:1621
8740 msgid "I</proc/scsi/scsi>"
8744 #: build/C/man5/proc.5:1627
8746 "This is a listing of all SCSI devices known to the kernel. The listing is "
8747 "similar to the one seen during bootup. scsi currently supports only the "
8748 "I<add-single-device> command which allows root to add a hotplugged device to "
8749 "the list of known devices."
8753 #: build/C/man5/proc.5:1629
8758 #: build/C/man5/proc.5:1633
8760 msgid "echo \\(aqscsi add-single-device 1 0 5 0\\(aq E<gt> /proc/scsi/scsi\n"
8764 #: build/C/man5/proc.5:1641
8766 "will cause host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. "
8767 "If there is already a device known on this address or the address is "
8768 "invalid, an error will be returned."
8772 #: build/C/man5/proc.5:1641
8774 msgid "I</proc/scsi/[drivername]>"
8778 #: build/C/man5/proc.5:1651
8780 "I<[drivername]> can currently be NCR53c7xx, aha152x, aha1542, aha1740, "
8781 "aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, "
8782 "scsi_debug, seagate, t128, u15-24f, ultrastore, or wd7000. These "
8783 "directories show up for all drivers that registered at least one SCSI HBA. "
8784 "Every directory contains one file per registered host. Every host-file is "
8785 "named after the number the host was assigned during initialization."
8789 #: build/C/man5/proc.5:1654
8791 "Reading these files will usually show driver and host configuration, "
8796 #: build/C/man5/proc.5:1661
8798 "Writing to these files allows different things on different hosts. For "
8799 "example, with the I<latency> and I<nolatency> commands, root can switch on "
8800 "and off command latency measurement code in the eata_dma driver. With the "
8801 "I<lockup> and I<unlock> commands, root can control bus lockups simulated by "
8802 "the scsi_debug driver."
8806 #: build/C/man5/proc.5:1661
8808 msgid "I</proc/self>"
8812 #: build/C/man5/proc.5:1669
8814 "This directory refers to the process accessing the I</proc> file system, and "
8815 "is identical to the I</proc> directory named by the process ID of the same "
8820 #: build/C/man5/proc.5:1669
8822 msgid "I</proc/slabinfo>"
8826 #: build/C/man5/proc.5:1678
8828 "Information about kernel caches. Since Linux 2.6.16 this file is only "
8829 "present if the B<CONFIG_SLAB> kernel configuration option is enabled. The "
8830 "columns in I</proc/slabinfo> are:"
8834 #: build/C/man5/proc.5:1688
8841 "num-active-slabs\n"
8843 "num-pages-per-slab\n"
8847 #: build/C/man5/proc.5:1694
8848 msgid "See B<slabinfo>(5) for details."
8852 #: build/C/man5/proc.5:1694
8854 msgid "I</proc/stat>"
8858 #: build/C/man5/proc.5:1700
8860 "kernel/system statistics. Varies with architecture. Common entries "
8865 #: build/C/man5/proc.5:1701
8867 msgid "I<cpu 3357 0 4313 1362393>"
8870 #. 1024 on Alpha and ia64
8871 #. FIXME Actually, the following info about the /proc/stat 'cpu' field
8872 #. does not seem to be quite right (at least in 2.6.12)
8874 #: build/C/man5/proc.5:1715
8876 "The amount of time, measured in units of USER_HZ (1/100ths of a second on "
8877 "most architectures, use I<sysconf(_SC_CLK_TCK)> to obtain the right value), "
8878 "that the system spent in user mode, user mode with low priority (nice), "
8879 "system mode, and the idle task, respectively. The last value should be "
8880 "USER_HZ times the second entry in the uptime pseudo-file."
8884 #: build/C/man5/proc.5:1723
8886 "In Linux 2.6 this line includes three additional columns: I<iowait> - time "
8887 "waiting for I/O to complete (since 2.5.41); I<irq> - time servicing "
8888 "interrupts (since 2.6.0-test4); I<softirq> - time servicing softirqs (since "
8893 #: build/C/man5/proc.5:1728
8895 "Since Linux 2.6.11, there is an eighth column, I<steal> - stolen time, which "
8896 "is the time spent in other operating systems when running in a virtualized "
8900 #. See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de
8902 #: build/C/man5/proc.5:1734
8904 "Since Linux 2.6.24, there is a ninth column, I<guest>, which is the time "
8905 "spent running a virtual CPU for guest operating systems under the control of "
8910 #: build/C/man5/proc.5:1734
8912 msgid "I<page 5741 1808>"
8916 #: build/C/man5/proc.5:1738
8918 "The number of pages the system paged in and the number that were paged out "
8923 #: build/C/man5/proc.5:1738
8929 #: build/C/man5/proc.5:1741
8930 msgid "The number of swap pages that have been brought in and out."
8933 #. FIXME The following is not the full picture for the 'intr' of
8934 #. /proc/stat on 2.6:
8936 #: build/C/man5/proc.5:1741
8938 msgid "I<intr 1462898>"
8942 #: build/C/man5/proc.5:1749
8944 "This line shows counts of interrupts serviced since boot time, for each of "
8945 "the possible system interrupts. The first column is the total of all "
8946 "interrupts serviced; each subsequent column is the total for a particular "
8951 #: build/C/man5/proc.5:1749
8953 msgid "I<disk_io: (2,0):(31,30,5764,1,2) (3,0):>..."
8957 #: build/C/man5/proc.5:1752
8959 "(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, "
8964 #: build/C/man5/proc.5:1754
8965 msgid "(Linux 2.4 only)"
8969 #: build/C/man5/proc.5:1754
8971 msgid "I<ctxt 115315>"
8975 #: build/C/man5/proc.5:1757
8976 msgid "The number of context switches that the system underwent."
8980 #: build/C/man5/proc.5:1757
8982 msgid "I<btime 769041601>"
8986 #: build/C/man5/proc.5:1760
8987 msgid "boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
8991 #: build/C/man5/proc.5:1760
8993 msgid "I<processes 86031>"
8997 #: build/C/man5/proc.5:1763
8998 msgid "Number of forks since boot."
9002 #: build/C/man5/proc.5:1763
9004 msgid "I<procs_running 6>"
9008 #: build/C/man5/proc.5:1767
9009 msgid "Number of processes in runnable state. (Linux 2.5.45 onward.)"
9013 #: build/C/man5/proc.5:1767
9015 msgid "I<procs_blocked 2>"
9019 #: build/C/man5/proc.5:1771
9021 "Number of processes blocked waiting for I/O to complete. (Linux 2.5.45 "
9026 #: build/C/man5/proc.5:1772
9028 msgid "I</proc/swaps>"
9032 #: build/C/man5/proc.5:1777
9033 msgid "Swap areas in use. See also B<swapon>(8)."
9037 #: build/C/man5/proc.5:1777
9039 msgid "I</proc/sys>"
9043 #: build/C/man5/proc.5:1785
9045 "This directory (present since 1.3.57) contains a number of files and "
9046 "subdirectories corresponding to kernel variables. These variables can be "
9047 "read and sometimes modified using the I</proc> file system, and the "
9048 "(deprecated) B<sysctl>(2) system call."
9052 #: build/C/man5/proc.5:1785
9054 msgid "I</proc/sys/abi> (since Linux 2.4.10)"
9057 #. On some systems, it is not present.
9059 #: build/C/man5/proc.5:1792
9061 "This directory may contain files with application binary information. See "
9062 "the kernel source file I<Documentation/sysctl/abi.txt> for more information."
9066 #: build/C/man5/proc.5:1792
9068 msgid "I</proc/sys/debug>"
9072 #: build/C/man5/proc.5:1795 build/C/man5/proc.5:2434
9073 msgid "This directory may be empty."
9077 #: build/C/man5/proc.5:1795
9079 msgid "I</proc/sys/dev>"
9083 #: build/C/man5/proc.5:1801
9085 "This directory contains device-specific information (e.g., "
9086 "I<dev/cdrom/info>). On some systems, it may be empty."
9090 #: build/C/man5/proc.5:1801
9092 msgid "I</proc/sys/fs>"
9096 #: build/C/man5/proc.5:1805
9098 "This directory contains the files and subdirectories for kernel variables "
9099 "related to file systems."
9103 #: build/C/man5/proc.5:1805
9105 msgid "I</proc/sys/fs/binfmt_misc>"
9109 #: build/C/man5/proc.5:1810
9111 "Documentation for files in this directory can be found in the kernel sources "
9112 "in I<Documentation/binfmt_misc.txt>."
9116 #: build/C/man5/proc.5:1810
9118 msgid "I</proc/sys/fs/dentry-state> (since Linux 2.2)"
9122 #: build/C/man5/proc.5:1818
9124 "This file contains information about the status of the directory cache "
9125 "(dcache). The file contains six numbers, I<nr_dentry>, I<nr_unused>, "
9126 "I<age_limit> (age in seconds), I<want_pages> (pages requested by system) and "
9131 #: build/C/man5/proc.5:1823
9133 "I<nr_dentry> is the number of allocated dentries (dcache entries). This "
9134 "field is unused in Linux 2.2."
9138 #: build/C/man5/proc.5:1826
9139 msgid "I<nr_unused> is the number of unused dentries."
9142 #. looks like this is unused in kernels 2.2 to 2.6
9144 #: build/C/man5/proc.5:1831
9146 "I<age_limit> is the age in seconds after which dcache entries can be "
9147 "reclaimed when memory is short."
9150 #. looks like this is unused in kernels 2.2 to 2.6
9152 #: build/C/man5/proc.5:1836
9154 "I<want_pages> is nonzero when the kernel has called shrink_dcache_pages() "
9155 "and the dcache isn't pruned yet."
9159 #: build/C/man5/proc.5:1837
9161 msgid "I</proc/sys/fs/dir-notify-enable>"
9165 #: build/C/man5/proc.5:1846
9167 "This file can be used to disable or enable the I<dnotify> interface "
9168 "described in B<fcntl>(2) on a system-wide basis. A value of 0 in this file "
9169 "disables the interface, and a value of 1 enables it."
9173 #: build/C/man5/proc.5:1846
9175 msgid "I</proc/sys/fs/dquot-max>"
9179 #: build/C/man5/proc.5:1853
9181 "This file shows the maximum number of cached disk quota entries. On some "
9182 "(2.4) systems, it is not present. If the number of free cached disk quota "
9183 "entries is very low and you have some awesome number of simultaneous system "
9184 "users, you might want to raise the limit."
9188 #: build/C/man5/proc.5:1853
9190 msgid "I</proc/sys/fs/dquot-nr>"
9194 #: build/C/man5/proc.5:1857
9196 "This file shows the number of allocated disk quota entries and the number of "
9197 "free disk quota entries."
9201 #: build/C/man5/proc.5:1857
9203 msgid "I</proc/sys/fs/epoll> (since Linux 2.6.28)"
9207 #: build/C/man5/proc.5:1866
9209 "This directory contains the file I<max_user_watches>, which can be used to "
9210 "limit the amount of kernel memory consumed by the I<epoll> interface. For "
9211 "further details, see B<epoll>(7)."
9215 #: build/C/man5/proc.5:1866
9217 msgid "I</proc/sys/fs/file-max>"
9221 #: build/C/man5/proc.5:1878
9223 "This file defines a system-wide limit on the number of open files for all "
9224 "processes. (See also B<setrlimit>(2), which can be used by a process to set "
9225 "the per-process limit, B<RLIMIT_NOFILE>, on the number of files it may "
9226 "open.) If you get lots of error messages about running out of file handles, "
9227 "try increasing this value:"
9231 #: build/C/man5/proc.5:1884
9233 msgid "CW<echo 100000 E<gt> /proc/sys/fs/file-max>\n"
9237 #: build/C/man5/proc.5:1891
9239 "The kernel constant B<NR_OPEN> imposes an upper limit on the value that may "
9240 "be placed in I<file-max>."
9244 #: build/C/man5/proc.5:1900
9246 "If you increase I</proc/sys/fs/file-max>, be sure to increase "
9247 "I</proc/sys/fs/inode-max> to 3-4 times the new value of "
9248 "I</proc/sys/fs/file-max>, or you will run out of inodes."
9252 #: build/C/man5/proc.5:1900
9254 msgid "I</proc/sys/fs/file-nr>"
9258 #: build/C/man5/proc.5:1912
9260 "This (read-only) file gives the number of files presently opened. It "
9261 "contains three numbers: the number of allocated file handles; the number of "
9262 "free file handles; and the maximum number of file handles. The kernel "
9263 "allocates file handles dynamically, but it doesn't free them again. If the "
9264 "number of allocated files is close to the maximum, you should consider "
9265 "increasing the maximum. When the number of free file handles is large, "
9266 "you've encountered a peak in your usage of file handles and you probably "
9267 "don't need to increase the maximum."
9271 #: build/C/man5/proc.5:1912
9273 msgid "I</proc/sys/fs/inode-max>"
9277 #: build/C/man5/proc.5:1922
9279 "This file contains the maximum number of in-memory inodes. On some (2.4) "
9280 "systems, it may not be present. This value should be 3-4 times larger than "
9281 "the value in I<file-max>, since I<stdin>, I<stdout> and network sockets also "
9282 "need an inode to handle them. When you regularly run out of inodes, you "
9283 "need to increase this value."
9287 #: build/C/man5/proc.5:1922
9289 msgid "I</proc/sys/fs/inode-nr>"
9293 #: build/C/man5/proc.5:1926
9294 msgid "This file contains the first two values from I<inode-state>."
9298 #: build/C/man5/proc.5:1926
9300 msgid "I</proc/sys/fs/inode-state>"
9304 #: build/C/man5/proc.5:1947
9306 "This file contains seven numbers: I<nr_inodes>, I<nr_free_inodes>, "
9307 "I<preshrink>, and four dummy values. I<nr_inodes> is the number of inodes "
9308 "the system has allocated. This can be slightly more than I<inode-max> "
9309 "because Linux allocates them one page full at a time. I<nr_free_inodes> "
9310 "represents the number of free inodes. I<preshrink> is nonzero when the "
9311 "I<nr_inodes> E<gt> I<inode-max> and the system needs to prune the inode list "
9312 "instead of allocating more."
9316 #: build/C/man5/proc.5:1947
9318 msgid "I</proc/sys/fs/inotify> (since Linux 2.6.13)"
9322 #: build/C/man5/proc.5:1956
9324 "This directory contains files I<max_queued_events>, I<max_user_instances>, "
9325 "and I<max_user_watches>, that can be used to limit the amount of kernel "
9326 "memory consumed by the I<inotify> interface. For further details, see "
9331 #: build/C/man5/proc.5:1956
9333 msgid "I</proc/sys/fs/lease-break-time>"
9337 #: build/C/man5/proc.5:1965
9339 "This file specifies the grace period that the kernel grants to a process "
9340 "holding a file lease (B<fcntl>(2)) after it has sent a signal to that "
9341 "process notifying it that another process is waiting to open the file. If "
9342 "the lease holder does not remove or downgrade the lease within this grace "
9343 "period, the kernel forcibly breaks the lease."
9347 #: build/C/man5/proc.5:1965
9349 msgid "I</proc/sys/fs/leases-enable>"
9353 #: build/C/man5/proc.5:1972
9355 "This file can be used to enable or disable file leases (B<fcntl>(2)) on a "
9356 "system-wide basis. If this file contains the value 0, leases are disabled. "
9357 "A nonzero value enables leases."
9361 #: build/C/man5/proc.5:1972
9363 msgid "I</proc/sys/fs/mqueue> (since Linux 2.6.6)"
9367 #: build/C/man5/proc.5:1980
9369 "This directory contains files I<msg_max>, I<msgsize_max>, and I<queues_max>, "
9370 "controlling the resources used by POSIX message queues. See "
9371 "B<mq_overview>(7) for details."
9375 #: build/C/man5/proc.5:1980
9377 msgid "I</proc/sys/fs/overflowgid> and I</proc/sys/fs/overflowuid>"
9381 #: build/C/man5/proc.5:1990
9383 "These files allow you to change the value of the fixed UID and GID. The "
9384 "default is 65534. Some file systems only support 16-bit UIDs and GIDs, "
9385 "although in Linux UIDs and GIDs are 32 bits. When one of these file systems "
9386 "is mounted with writes enabled, any UID or GID that would exceed 65535 is "
9387 "translated to the overflow value before being written to disk."
9391 #: build/C/man5/proc.5:1990
9393 msgid "I</proc/sys/fs/pipe-max-size> (since Linux 2.6.35)"
9397 #: build/C/man5/proc.5:2004
9399 "The value in this file defines an upper limit for raising the capacity of a "
9400 "pipe using the B<fcntl>(2) B<F_SETPIPE_SZ> operation. This limit applies "
9401 "only to unprivileged processes. The default value for this file is "
9402 "1,048,576. The value assigned to this file may be rounded upward, to "
9403 "reflect the value actually employed for a convenient implementation. To "
9404 "determine the rounded-up value, display the contents of this file after "
9405 "assigning a value to it. The minimum value that can be assigned to this "
9406 "file is the system page size."
9410 #: build/C/man5/proc.5:2004
9412 msgid "I</proc/sys/fs/suid_dumpable> (since Linux 2.6.13)"
9415 #. The following is based on text from Documentation/sysctl/kernel.txt
9417 #: build/C/man5/proc.5:2010
9419 "The value in this file determines whether core dump files are produced for "
9420 "set-user-ID or otherwise protected/tainted binaries. Three different "
9421 "integer values can be specified:"
9425 #: build/C/man5/proc.5:2019
9427 "I<0\\ (default)> This provides the traditional (pre-Linux 2.6.13) behavior. "
9428 "A core dump will not be produced for a process which has changed credentials "
9429 "(by calling B<seteuid>(2), B<setgid>(2), or similar, or by executing a "
9430 "set-user-ID or set-group-ID program) or whose binary does not have read "
9431 "permission enabled."
9435 #: build/C/man5/proc.5:2026
9437 "I<1\\ (\"debug\")> All processes dump core when possible. The core dump is "
9438 "owned by the file system user ID of the dumping process and no security is "
9439 "applied. This is intended for system debugging situations only. Ptrace is "
9444 #: build/C/man5/proc.5:2035
9446 "I<2\\ (\"suidsafe\")> Any binary which normally would not be dumped (see "
9447 "\"0\" above) is dumped readable by root only. This allows the user to "
9448 "remove the core dump file but not to read it. For security reasons core "
9449 "dumps in this mode will not overwrite one another or other files. This mode "
9450 "is appropriate when administrators are attempting to debug problems in a "
9451 "normal environment."
9455 #: build/C/man5/proc.5:2035
9457 msgid "I</proc/sys/fs/super-max>"
9461 #: build/C/man5/proc.5:2046
9463 "This file controls the maximum number of superblocks, and thus the maximum "
9464 "number of mounted file systems the kernel can have. You only need to "
9465 "increase I<super-max> if you need to mount more file systems than the "
9466 "current value in I<super-max> allows you to."
9470 #: build/C/man5/proc.5:2046
9472 msgid "I</proc/sys/fs/super-nr>"
9476 #: build/C/man5/proc.5:2050
9477 msgid "This file contains the number of file systems currently mounted."
9481 #: build/C/man5/proc.5:2050
9483 msgid "I</proc/sys/kernel>"
9487 #: build/C/man5/proc.5:2054
9489 "This directory contains files controlling a range of kernel parameters, as "
9494 #: build/C/man5/proc.5:2054
9496 msgid "I</proc/sys/kernel/acct>"
9500 #: build/C/man5/proc.5:2078
9502 "This file contains three numbers: I<highwater>, I<lowwater>, and "
9503 "I<frequency>. If BSD-style process accounting is enabled these values "
9504 "control its behavior. If free space on file system where the log lives goes "
9505 "below I<lowwater> percent accounting suspends. If free space gets above "
9506 "I<highwater> percent accounting resumes. I<frequency> determines how often "
9507 "the kernel checks the amount of free space (value is in seconds). Default "
9508 "values are 4, 2 and 30. That is, suspend accounting if 2% or less space is "
9509 "free; resume it if 4% or more space is free; consider information about "
9510 "amount of free space valid for 30 seconds."
9514 #: build/C/man5/proc.5:2078
9516 msgid "I</proc/sys/kernel/cap-bound> (from Linux 2.2 to 2.6.24)"
9520 #: build/C/man5/proc.5:2090
9522 "This file holds the value of the kernel I<capability bounding set> "
9523 "(expressed as a signed decimal number). This set is ANDed against the "
9524 "capabilities permitted to a process during B<execve>(2). Starting with "
9525 "Linux 2.6.25, the system-wide capability bounding set disappeared, and was "
9526 "replaced by a per-thread bounding set; see B<capabilities>(7)."
9530 #: build/C/man5/proc.5:2090
9532 msgid "I</proc/sys/kernel/core_pattern>"
9536 #: build/C/man5/proc.5:2094
9538 msgid "I</proc/sys/kernel/core_uses_pid>"
9542 #: build/C/man5/proc.5:2098
9544 msgid "I</proc/sys/kernel/ctrl-alt-del>"
9548 #: build/C/man5/proc.5:2113
9550 "This file controls the handling of Ctrl-Alt-Del from the keyboard. When the "
9551 "value in this file is 0, Ctrl-Alt-Del is trapped and sent to the B<init>(8) "
9552 "program to handle a graceful restart. When the value is greater than zero, "
9553 "Linux's reaction to a Vulcan Nerve Pinch (tm) will be an immediate reboot, "
9554 "without even syncing its dirty buffers. Note: when a program (like dosemu) "
9555 "has the keyboard in \"raw\" mode, the ctrl-alt-del is intercepted by the "
9556 "program before it ever reaches the kernel tty layer, and it's up to the "
9557 "program to decide what to do with it."
9561 #: build/C/man5/proc.5:2113
9563 msgid "I</proc/sys/kernel/hotplug>"
9567 #: build/C/man5/proc.5:2119
9569 "This file contains the path for the hotplug policy agent. The default value "
9570 "in this file is I</sbin/hotplug>."
9574 #: build/C/man5/proc.5:2119
9576 msgid "I</proc/sys/kernel/domainname> and I</proc/sys/kernel/hostname>"
9580 #: build/C/man5/proc.5:2127
9582 "can be used to set the NIS/YP domainname and the hostname of your box in "
9583 "exactly the same way as the commands B<domainname>(1) and B<hostname>(1), "
9588 #: build/C/man5/proc.5:2132
9591 "#B< echo \\(aqdarkstar\\(aq E<gt> /proc/sys/kernel/hostname>\n"
9592 "#B< echo \\(aqmydomain\\(aq E<gt> /proc/sys/kernel/domainname>\n"
9596 #: build/C/man5/proc.5:2136
9597 msgid "has the same effect as"
9601 #: build/C/man5/proc.5:2141
9604 "#B< hostname \\(aqdarkstar\\(aq>\n"
9605 "#B< domainname \\(aqmydomain\\(aq>\n"
9609 #: build/C/man5/proc.5:2154
9611 "Note, however, that the classic darkstar.frop.org has the hostname "
9612 "\"darkstar\" and DNS (Internet Domain Name Server) domainname \"frop.org\", "
9613 "not to be confused with the NIS (Network Information Service) or YP (Yellow "
9614 "Pages) domainname. These two domain names are in general different. For a "
9615 "detailed discussion see the B<hostname>(1) man page."
9619 #: build/C/man5/proc.5:2154
9621 msgid "I</proc/sys/kernel/htab-reclaim>"
9625 #: build/C/man5/proc.5:2162
9627 "(PowerPC only) If this file is set to a nonzero value, the PowerPC htab (see "
9628 "kernel file I<Documentation/powerpc/ppc_htab.txt>) is pruned each time the "
9629 "system hits the idle loop."
9633 #: build/C/man5/proc.5:2162
9635 msgid "I</proc/sys/kernel/l2cr>"
9639 #: build/C/man5/proc.5:2169
9641 "(PowerPC only) This file contains a flag that controls the L2 cache of G3 "
9642 "processor boards. If 0, the cache is disabled. Enabled if nonzero."
9646 #: build/C/man5/proc.5:2169
9648 msgid "I</proc/sys/kernel/modprobe>"
9652 #: build/C/man5/proc.5:2180
9654 "This file contains the path for the kernel module loader. The default value "
9655 "is I</sbin/modprobe>. The file is only present if the kernel is built with "
9656 "the B<CONFIG_KMOD> option enabled. It is described by the kernel source "
9657 "file I<Documentation/kmod.txt> (only present in kernel 2.4 and earlier)."
9661 #: build/C/man5/proc.5:2180
9663 msgid "I</proc/sys/kernel/msgmax>"
9667 #: build/C/man5/proc.5:2185
9669 "This file defines a system-wide limit specifying the maximum number of bytes "
9670 "in a single message written on a System V message queue."
9674 #: build/C/man5/proc.5:2185
9676 msgid "I</proc/sys/kernel/msgmni>"
9680 #: build/C/man5/proc.5:2190
9682 "This file defines the system-wide limit on the number of message queue "
9683 "identifiers. (This file is only present in Linux 2.4 onward.)"
9687 #: build/C/man5/proc.5:2190
9689 msgid "I</proc/sys/kernel/msgmnb>"
9693 #: build/C/man5/proc.5:2199
9695 "This file defines a system-wide parameter used to initialize the "
9696 "I<msg_qbytes> setting for subsequently created message queues. The "
9697 "I<msg_qbytes> setting specifies the maximum number of bytes that may be "
9698 "written to the message queue."
9702 #: build/C/man5/proc.5:2199
9704 msgid "I</proc/sys/kernel/ostype> and I</proc/sys/kernel/osrelease>"
9708 #: build/C/man5/proc.5:2204
9709 msgid "These files give substrings of I</proc/version>."
9713 #: build/C/man5/proc.5:2204
9715 msgid "I</proc/sys/kernel/overflowgid> and I</proc/sys/kernel/overflowuid>"
9719 #: build/C/man5/proc.5:2210
9721 "These files duplicate the files I</proc/sys/fs/overflowgid> and "
9722 "I</proc/sys/fs/overflowuid>."
9726 #: build/C/man5/proc.5:2210
9728 msgid "I</proc/sys/kernel/panic>"
9732 #: build/C/man5/proc.5:2219
9734 "This file gives read/write access to the kernel variable I<panic_timeout>. "
9735 "If this is zero, the kernel will loop on a panic; if nonzero it indicates "
9736 "that the kernel should autoreboot after this number of seconds. When you "
9737 "use the software watchdog device driver, the recommended setting is 60."
9741 #: build/C/man5/proc.5:2219
9743 msgid "I</proc/sys/kernel/panic_on_oops> (since Linux 2.5.68)"
9747 #: build/C/man5/proc.5:2231
9749 "This file controls the kernel's behavior when an oops or BUG is "
9750 "encountered. If this file contains 0, then the system tries to continue "
9751 "operation. If it contains 1, then the system delays a few seconds (to give "
9752 "klogd time to record the oops output) and then panics. If the "
9753 "I</proc/sys/kernel/panic> file is also nonzero then the machine will be "
9758 #: build/C/man5/proc.5:2231
9760 msgid "I</proc/sys/kernel/pid_max> (since Linux 2.5.34)"
9763 #. Prior to 2.6.10, pid_max could also be raised above 32768 on 32-bit
9764 #. platforms, but this broke /proc/[pid]
9765 #. See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2
9767 #: build/C/man5/proc.5:2247
9769 "This file specifies the value at which PIDs wrap around (i.e., the value in "
9770 "this file is one greater than the maximum PID). The default value for this "
9771 "file, 32768, results in the same range of PIDs as on earlier kernels. On "
9772 "32-bit platforms, 32768 is the maximum value for I<pid_max>. On 64-bit "
9773 "systems, I<pid_max> can be set to any value up to 2^22 (B<PID_MAX_LIMIT>, "
9774 "approximately 4 million)."
9778 #: build/C/man5/proc.5:2247
9780 msgid "I</proc/sys/kernel/powersave-nap> (PowerPC only)"
9784 #: build/C/man5/proc.5:2253
9786 "This file contains a flag. If set, Linux-PPC will use the \"nap\" mode of "
9787 "powersaving, otherwise the \"doze\" mode will be used."
9791 #: build/C/man5/proc.5:2253
9793 msgid "I</proc/sys/kernel/printk>"
9797 #: build/C/man5/proc.5:2279
9799 "The four values in this file are I<console_loglevel>, "
9800 "I<default_message_loglevel>, I<minimum_console_level>, and "
9801 "I<default_console_loglevel>. These values influence I<printk()> behavior "
9802 "when printing or logging error messages. See B<syslog>(2) for more info on "
9803 "the different loglevels. Messages with a higher priority than "
9804 "I<console_loglevel> will be printed to the console. Messages without an "
9805 "explicit priority will be printed with priority I<default_message_level>. "
9806 "I<minimum_console_loglevel> is the minimum (highest) value to which "
9807 "I<console_loglevel> can be set. I<default_console_loglevel> is the default "
9808 "value for I<console_loglevel>."
9812 #: build/C/man5/proc.5:2279
9814 msgid "I</proc/sys/kernel/pty> (since Linux 2.6.4)"
9818 #: build/C/man5/proc.5:2285
9820 "This directory contains two files relating to the number of UNIX 98 "
9821 "pseudoterminals (see B<pts>(4)) on the system."
9825 #: build/C/man5/proc.5:2285
9827 msgid "I</proc/sys/kernel/pty/max>"
9831 #: build/C/man5/proc.5:2288
9832 msgid "This file defines the maximum number of pseudoterminals."
9836 #: build/C/man5/proc.5:2288
9838 msgid "I</proc/sys/kernel/pty/nr>"
9842 #: build/C/man5/proc.5:2292
9843 msgid "This read-only file indicates how many pseudoterminals are currently in use."
9847 #: build/C/man5/proc.5:2292
9849 msgid "I</proc/sys/kernel/random>"
9853 #: build/C/man5/proc.5:2300
9855 "This directory contains various parameters controlling the operation of the "
9856 "file I</dev/random>. See B<random>(4) for further information."
9860 #: build/C/man5/proc.5:2300
9862 msgid "I</proc/sys/kernel/real-root-dev>"
9866 #: build/C/man5/proc.5:2304
9868 "This file is documented in the kernel source file "
9869 "I<Documentation/initrd.txt>."
9873 #: build/C/man5/proc.5:2304
9875 msgid "I</proc/sys/kernel/reboot-cmd> (Sparc only) "
9879 #: build/C/man5/proc.5:2310
9881 "This file seems to be a way to give an argument to the SPARC ROM/Flash boot "
9882 "loader. Maybe to tell it what to do after rebooting?"
9886 #: build/C/man5/proc.5:2310
9888 msgid "I</proc/sys/kernel/rtsig-max>"
9892 #: build/C/man5/proc.5:2317
9894 "(Only in kernels up to and including 2.6.7; see B<setrlimit>(2)) This file "
9895 "can be used to tune the maximum number of POSIX real-time (queued) signals "
9896 "that can be outstanding in the system."
9900 #: build/C/man5/proc.5:2317
9902 msgid "I</proc/sys/kernel/rtsig-nr>"
9906 #: build/C/man5/proc.5:2321
9908 "(Only in kernels up to and including 2.6.7.) This file shows the number "
9909 "POSIX real-time signals currently queued."
9913 #: build/C/man5/proc.5:2321
9915 msgid "I</proc/sys/kernel/sem> (since Linux 2.4)"
9919 #: build/C/man5/proc.5:2325
9921 "This file contains 4 numbers defining limits for System V IPC semaphores. "
9922 "These fields are, in order:"
9926 #: build/C/man5/proc.5:2326
9932 #: build/C/man5/proc.5:2328
9933 msgid "The maximum semaphores per semaphore set."
9937 #: build/C/man5/proc.5:2328
9943 #: build/C/man5/proc.5:2330
9944 msgid "A system-wide limit on the number of semaphores in all semaphore sets."
9948 #: build/C/man5/proc.5:2330
9954 #: build/C/man5/proc.5:2334
9956 "The maximum number of operations that may be specified in a B<semop>(2) "
9961 #: build/C/man5/proc.5:2334
9967 #: build/C/man5/proc.5:2336
9968 msgid "A system-wide limit on the maximum number of semaphore identifiers."
9972 #: build/C/man5/proc.5:2337
9974 msgid "I</proc/sys/kernel/sg-big-buff>"
9978 #: build/C/man5/proc.5:2348
9980 "This file shows the size of the generic SCSI device (sg) buffer. You can't "
9981 "tune it just yet, but you could change it at compile time by editing "
9982 "I<include/scsi/sg.h> and changing the value of B<SG_BIG_BUFF>. However, "
9983 "there shouldn't be any reason to change this value."
9987 #: build/C/man5/proc.5:2348
9989 msgid "I</proc/sys/kernel/shmall>"
9993 #: build/C/man5/proc.5:2353
9995 "This file contains the system-wide limit on the total number of pages of "
9996 "System V shared memory."
10000 #: build/C/man5/proc.5:2353
10002 msgid "I</proc/sys/kernel/shmmax>"
10005 #. type: Plain text
10006 #: build/C/man5/proc.5:2363
10008 "This file can be used to query and set the run-time limit on the maximum "
10009 "(System V IPC) shared memory segment size that can be created. Shared "
10010 "memory segments up to 1GB are now supported in the kernel. This value "
10011 "defaults to B<SHMMAX>."
10015 #: build/C/man5/proc.5:2363
10017 msgid "I</proc/sys/kernel/shmmni>"
10020 #. type: Plain text
10021 #: build/C/man5/proc.5:2369
10023 "(available in Linux 2.4 and onward) This file specifies the system-wide "
10024 "maximum number of System V shared memory segments that can be created."
10028 #: build/C/man5/proc.5:2369
10030 msgid "I</proc/sys/kernel/sysrq>"
10033 #. type: Plain text
10034 #: build/C/man5/proc.5:2378
10036 "This file controls the functions allowed to be invoked by the SysRq key. By "
10037 "default, the file contains 1 meaning that every possible SysRq request is "
10038 "allowed (in older kernel versions, SysRq was disabled by default, and you "
10039 "were required to specifically enable it at run-time, but this is not the "
10040 "case any more). Possible values in this file are:"
10043 #. type: Plain text
10044 #: build/C/man5/proc.5:2390
10047 " 0 - disable sysrq completely\n"
10048 " 1 - enable all functions of sysrq\n"
10049 " E<gt>1 - bitmask of allowed sysrq functions, as follows:\n"
10050 " 2 - enable control of console logging level\n"
10051 " 4 - enable control of keyboard (SAK, unraw)\n"
10052 " 8 - enable debugging dumps of processes etc.\n"
10053 " 16 - enable sync command\n"
10054 " 32 - enable remount read-only\n"
10055 " 64 - enable signalling of processes (term, kill, oom-kill)\n"
10056 " 128 - allow reboot/poweroff\n"
10057 " 256 - allow nicing of all real-time tasks\n"
10060 #. type: Plain text
10061 #: build/C/man5/proc.5:2396
10063 "This file is only present if the B<CONFIG_MAGIC_SYSRQ> kernel configuration "
10064 "option is enabled. For further details see the kernel source file "
10065 "I<Documentation/sysrq.txt>."
10069 #: build/C/man5/proc.5:2396
10071 msgid "I</proc/sys/kernel/version>"
10074 #. type: Plain text
10075 #: build/C/man5/proc.5:2399
10076 msgid "This file contains a string like:"
10079 #. type: Plain text
10080 #: build/C/man5/proc.5:2401
10082 msgid " #5 Wed Feb 25 21:49:24 MET 1998\n"
10085 #. type: Plain text
10086 #: build/C/man5/proc.5:2405
10088 "The \"#5\" means that this is the fifth kernel built from this source base "
10089 "and the date behind it indicates the time the kernel was built."
10093 #: build/C/man5/proc.5:2405
10095 msgid "I</proc/sys/kernel/threads-max> (since Linux 2.3.11)"
10098 #. type: Plain text
10099 #: build/C/man5/proc.5:2409
10101 "This file specifies the system-wide limit on the number of threads (tasks) "
10102 "that can be created on the system."
10106 #: build/C/man5/proc.5:2409
10108 msgid "I</proc/sys/kernel/zero-paged> (PowerPC only) "
10111 #. type: Plain text
10112 #: build/C/man5/proc.5:2415
10114 "This file contains a flag. When enabled (nonzero), Linux-PPC will pre-zero "
10115 "pages in the idle loop, possibly speeding up get_free_pages."
10119 #: build/C/man5/proc.5:2415
10121 msgid "I</proc/sys/net>"
10124 #. type: Plain text
10125 #: build/C/man5/proc.5:2422
10127 "This directory contains networking stuff. Explanations for some of the "
10128 "files under this directory can be found in B<tcp>(7) and B<ip>(7)."
10132 #: build/C/man5/proc.5:2422
10134 msgid "I</proc/sys/net/core/somaxconn>"
10137 #. type: Plain text
10138 #: build/C/man5/proc.5:2431
10140 "This file defines a ceiling value for the I<backlog> argument of "
10141 "B<listen>(2); see the B<listen>(2) manual page for details."
10145 #: build/C/man5/proc.5:2431
10147 msgid "I</proc/sys/proc>"
10151 #: build/C/man5/proc.5:2434
10153 msgid "I</proc/sys/sunrpc>"
10156 #. type: Plain text
10157 #: build/C/man5/proc.5:2439
10159 "This directory supports Sun remote procedure call for network file system "
10160 "(NFS). On some systems, it is not present."
10164 #: build/C/man5/proc.5:2439
10166 msgid "I</proc/sys/vm>"
10169 #. type: Plain text
10170 #: build/C/man5/proc.5:2443
10172 "This directory contains files for memory management tuning, buffer and cache "
10177 #: build/C/man5/proc.5:2443
10179 msgid "I</proc/sys/vm/drop_caches> (since Linux 2.6.16)"
10182 #. type: Plain text
10183 #: build/C/man5/proc.5:2447
10185 "Writing to this file causes the kernel to drop clean caches, dentries and "
10186 "inodes from memory, causing that memory to become free."
10189 #. type: Plain text
10190 #: build/C/man5/proc.5:2454
10192 "To free pagecache, use I<echo 1 E<gt> /proc/sys/vm/drop_caches>; to free "
10193 "dentries and inodes, use I<echo 2 E<gt> /proc/sys/vm/drop_caches>; to free "
10194 "pagecache, dentries and inodes, use I<echo 3 E<gt> "
10195 "/proc/sys/vm/drop_caches>."
10198 #. type: Plain text
10199 #: build/C/man5/proc.5:2460
10201 "Because this is a nondestructive operation and dirty objects are not "
10202 "freeable, the user should run B<sync>(8) first."
10206 #: build/C/man5/proc.5:2460
10208 msgid "I</proc/sys/vm/legacy_va_layout> (since Linux 2.6.9)"
10211 #. The following is from Documentation/filesystems/proc.txt
10212 #. type: Plain text
10213 #: build/C/man5/proc.5:2465
10215 "If nonzero, this disables the new 32-bit memory-mapping layout; the kernel "
10216 "will use the legacy (2.4) layout for all processes."
10220 #: build/C/man5/proc.5:2465
10222 msgid "I</proc/sys/vm/memory_failure_early_kill> (since Linux 2.6.32)"
10225 #. The following is based on the text in Documentation/sysctl/vm.txt
10226 #. type: Plain text
10227 #: build/C/man5/proc.5:2477
10229 "Control how to kill processes when an uncorrected memory error (typically a "
10230 "2-bit error in a memory module) that cannot be handled by the kernel is "
10231 "detected in the background by hardware. In some cases (like the page still "
10232 "having a valid copy on disk), the kernel will handle the failure "
10233 "transparently without affecting any applications. But if there is no other "
10234 "up-to-date copy of the data, it will kill processes to prevent any data "
10235 "corruptions from propagating."
10238 #. type: Plain text
10239 #: build/C/man5/proc.5:2479
10240 msgid "The file has one of the following values:"
10244 #: build/C/man5/proc.5:2480 build/C/man5/proc.5:2517
10249 #. type: Plain text
10250 #: build/C/man5/proc.5:2485
10252 "Kill all processes that have the corrupted-and-not-reloadable page mapped as "
10253 "soon as the corruption is detected. Note this is not supported for a few "
10254 "types of pages, like kernel internally allocated data or the swap cache, but "
10255 "works for the majority of user pages."
10259 #: build/C/man5/proc.5:2485 build/C/man5/proc.5:2519
10264 #. type: Plain text
10265 #: build/C/man5/proc.5:2488
10267 "Only unmap the corrupted page from all processes and only kill a process who "
10268 "tries to access it."
10271 #. type: Plain text
10272 #: build/C/man5/proc.5:2499
10274 "The kill is performed using a B<SIGBUS> signal with I<si_code> set to "
10275 "B<BUS_MCEERR_AO>. Processes can handle this if they want to; see "
10276 "B<sigaction>(2) for more details."
10279 #. type: Plain text
10280 #: build/C/man5/proc.5:2502
10282 "This feature is only active on architectures/platforms with advanced machine "
10283 "check handling and depends on the hardware capabilities."
10286 #. type: Plain text
10287 #: build/C/man5/proc.5:2509
10289 "Applications can override the I<memory_failure_early_kill> setting "
10290 "individually with the B<prctl>(2) B<PR_MCE_KILL> operation."
10293 #. type: Plain text
10294 #: build/C/man5/proc.5:2512 build/C/man5/proc.5:2525
10295 msgid "Only present if the kernel was configured with B<CONFIG_MEMORY_FAILURE>."
10299 #: build/C/man5/proc.5:2512
10301 msgid "I</proc/sys/vm/memory_failure_recovery> (since Linux 2.6.32)"
10304 #. The following is based on the text in Documentation/sysctl/vm.txt
10305 #. type: Plain text
10306 #: build/C/man5/proc.5:2516
10307 msgid "Enable memory failure recovery (when supported by the platform)"
10310 #. type: Plain text
10311 #: build/C/man5/proc.5:2519
10312 msgid "Attempt recovery."
10315 #. type: Plain text
10316 #: build/C/man5/proc.5:2521
10317 msgid "Always panic on a memory failure."
10321 #: build/C/man5/proc.5:2525
10323 msgid "I</proc/sys/vm/oom_dump_tasks> (since Linux 2.6.25)"
10326 #. The following is from Documentation/sysctl/vm.txt
10327 #. type: Plain text
10328 #: build/C/man5/proc.5:2540
10330 "Enables a system-wide task dump (excluding kernel threads) to be produced "
10331 "when the kernel performs an OOM-killing. The dump includes the following "
10332 "information for each task (thread, process): thread ID, real user ID, thread "
10333 "group ID (process ID), virtual memory size, resident set size, the CPU that "
10334 "the task is scheduled on, oom_adj score (see the description of "
10335 "I</proc/[pid]/oom_adj>), and command name. This is helpful to determine why "
10336 "the OOM-killer was invoked and to identify the rogue task that caused it."
10339 #. type: Plain text
10340 #: build/C/man5/proc.5:2546
10342 "If this contains the value zero, this information is suppressed. On very "
10343 "large systems with thousands of tasks, it may not be feasible to dump the "
10344 "memory state information for each one. Such systems should not be forced to "
10345 "incur a performance penalty in OOM situations when the information may not "
10349 #. type: Plain text
10350 #: build/C/man5/proc.5:2549
10352 "If this is set to nonzero, this information is shown whenever the OOM-killer "
10353 "actually kills a memory-hogging task."
10356 #. type: Plain text
10357 #: build/C/man5/proc.5:2551 build/C/man5/proc.5:2572
10358 msgid "The default value is 0."
10362 #: build/C/man5/proc.5:2551
10364 msgid "I</proc/sys/vm/oom_kill_allocating_task> (since Linux 2.6.24)"
10367 #. The following is from Documentation/sysctl/vm.txt
10368 #. type: Plain text
10369 #: build/C/man5/proc.5:2556
10371 "This enables or disables killing the OOM-triggering task in out-of-memory "
10375 #. type: Plain text
10376 #: build/C/man5/proc.5:2561
10378 "If this is set to zero, the OOM-killer will scan through the entire tasklist "
10379 "and select a task based on heuristics to kill. This normally selects a "
10380 "rogue memory-hogging task that frees up a large amount of memory when "
10384 #. type: Plain text
10385 #: build/C/man5/proc.5:2565
10387 "If this is set to nonzero, the OOM-killer simply kills the task that "
10388 "triggered the out-of-memory condition. This avoids a possibly expensive "
10392 #. type: Plain text
10393 #: build/C/man5/proc.5:2570
10395 "If I</proc/sys/vm/panic_on_oom> is nonzero, it takes precedence over "
10396 "whatever value is used in I</proc/sys/vm/oom_kill_allocating_task>."
10400 #: build/C/man5/proc.5:2572
10402 msgid "I</proc/sys/vm/overcommit_memory>"
10405 #. type: Plain text
10406 #: build/C/man5/proc.5:2576
10407 msgid "This file contains the kernel virtual memory accounting mode. Values are:"
10410 #. type: Plain text
10411 #: build/C/man5/proc.5:2579
10412 msgid "0: heuristic overcommit (this is the default)"
10415 #. type: Plain text
10416 #: build/C/man5/proc.5:2581
10417 msgid "1: always overcommit, never check"
10420 #. type: Plain text
10421 #: build/C/man5/proc.5:2583
10422 msgid "2: always check, never overcommit"
10425 #. type: Plain text
10426 #: build/C/man5/proc.5:2597
10428 "In mode 0, calls of B<mmap>(2) with B<MAP_NORESERVE> are not checked, and "
10429 "the default check is very weak, leading to the risk of getting a process "
10430 "\"OOM-killed\". Under Linux 2.4 any nonzero value implies mode 1. In mode "
10431 "2 (available since Linux 2.6), the total virtual address space on the system "
10432 "is limited to (SS + RAM*(r/100)), where SS is the size of the swap space, "
10433 "and RAM is the size of the physical memory, and r is the contents of the "
10434 "file I</proc/sys/vm/overcommit_ratio>."
10438 #: build/C/man5/proc.5:2597
10440 msgid "I</proc/sys/vm/overcommit_ratio>"
10443 #. type: Plain text
10444 #: build/C/man5/proc.5:2601
10445 msgid "See the description of I</proc/sys/vm/overcommit_memory>."
10449 #: build/C/man5/proc.5:2601
10451 msgid "I</proc/sys/vm/panic_on_oom> (since Linux 2.6.18)"
10454 #. The following is adapted from Documentation/sysctl/vm.txt
10455 #. type: Plain text
10456 #: build/C/man5/proc.5:2606
10457 msgid "This enables or disables a kernel panic in an out-of-memory situation."
10460 #. type: Plain text
10461 #: build/C/man5/proc.5:2611
10463 "If this file is set to the value 0, the kernel's OOM-killer will kill some "
10464 "rogue process. Usually, the OOM-killer is able to kill a rogue process and "
10465 "the system will survive."
10468 #. type: Plain text
10469 #: build/C/man5/proc.5:2626
10471 "If this file is set to the value 1, then the kernel normally panics when "
10472 "out-of-memory happens. However, if a process limits allocations to certain "
10473 "nodes using memory policies (B<mbind>(2) B<MPOL_BIND>) or cpusets "
10474 "(B<cpuset>(7)) and those nodes reach memory exhaustion status, one process "
10475 "may be killed by the OOM-killer. No panic occurs in this case: because "
10476 "other nodes' memory may be free, this means the system as a whole may not "
10477 "have reached an out-of-memory situation yet."
10480 #. type: Plain text
10481 #: build/C/man5/proc.5:2629
10483 "If this file is set to the value 2, the kernel always panics when an "
10484 "out-of-memory condition occurs."
10487 #. type: Plain text
10488 #: build/C/man5/proc.5:2633
10490 "The default value is 0. 1 and 2 are for failover of clustering. Select "
10491 "either according to your policy of failover."
10495 #: build/C/man5/proc.5:2633
10497 msgid "I</proc/sys/vm/swappiness>"
10500 #. The following is from Documentation/sysctl/vm.txt
10501 #. type: Plain text
10502 #: build/C/man5/proc.5:2641
10504 "The value in this file controls how aggressively the kernel will swap memory "
10505 "pages. Higher values increase aggressiveness, lower values decrease "
10506 "aggressiveness. The default value is 60."
10510 #: build/C/man5/proc.5:2641
10512 msgid "I</proc/sysrq-trigger> (since Linux 2.4.21)"
10515 #. type: Plain text
10516 #: build/C/man5/proc.5:2650
10518 "Writing a character to this file triggers the same SysRq function as typing "
10519 "ALT-SysRq-E<lt>characterE<gt> (see the description of "
10520 "I</proc/sys/kernel/sysrq>). This file is normally only writable by "
10521 "I<root>. For further details see the kernel source file "
10522 "I<Documentation/sysrq.txt>."
10526 #: build/C/man5/proc.5:2650
10528 msgid "I</proc/sysvipc>"
10531 #. type: Plain text
10532 #: build/C/man5/proc.5:2663
10534 "Subdirectory containing the pseudo-files I<msg>, I<sem> and I<shm>. These "
10535 "files list the System V Interprocess Communication (IPC) objects "
10536 "(respectively: message queues, semaphores, and shared memory) that "
10537 "currently exist on the system, providing similar information to that "
10538 "available via B<ipcs>(1). These files have headers and are formatted (one "
10539 "IPC object per line) for easy understanding. B<svipc>(7) provides further "
10540 "background on the information shown by these files."
10544 #: build/C/man5/proc.5:2663
10546 msgid "I</proc/tty>"
10549 #. type: Plain text
10550 #: build/C/man5/proc.5:2667
10552 "Subdirectory containing the pseudo-files and subdirectories for tty drivers "
10553 "and line disciplines."
10557 #: build/C/man5/proc.5:2667
10559 msgid "I</proc/uptime>"
10562 #. type: Plain text
10563 #: build/C/man5/proc.5:2671
10565 "This file contains two numbers: the uptime of the system (seconds), and the "
10566 "amount of time spent in idle process (seconds)."
10570 #: build/C/man5/proc.5:2671
10572 msgid "I</proc/version>"
10575 #. type: Plain text
10576 #: build/C/man5/proc.5:2680
10578 "This string identifies the kernel version that is currently running. It "
10579 "includes the contents of I</proc/sys/kernel/ostype>, "
10580 "I</proc/sys/kernel/osrelease> and I</proc/sys/kernel/version>. For example:"
10583 #. type: Plain text
10584 #: build/C/man5/proc.5:2684
10586 msgid "CW<Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994>\n"
10590 #: build/C/man5/proc.5:2695
10592 msgid "I</proc/vmstat> (since Linux 2.6)"
10595 #. type: Plain text
10596 #: build/C/man5/proc.5:2698
10597 msgid "This file displays various virtual memory statistics."
10601 #: build/C/man5/proc.5:2698
10603 msgid "I</proc/zoneinfo> (since Linux 2.6.13)"
10606 #. FIXME more should be said about /proc/zoneinfo
10607 #. type: Plain text
10608 #: build/C/man5/proc.5:2703
10610 "This file display information about memory zones. This is useful for "
10611 "analyzing virtual memory behavior."
10614 #. type: Plain text
10615 #: build/C/man5/proc.5:2710
10617 "Many strings (i.e., the environment and command line) are in the internal "
10618 "format, with subfields terminated by null bytes (\\(aq\\e0\\(aq), so you may "
10619 "find that things are more readable if you use I<od -c> or I<tr \"\\e000\" "
10620 "\"\\en\"> to read them. Alternatively, I<echo \\`cat E<lt>fileE<gt>\\`> "
10624 #. .SH ACKNOWLEDGEMENTS
10625 #. The material on /proc/sys/fs and /proc/sys/kernel is closely based on
10626 #. kernel source documentation files written by Rik van Riel.
10627 #. type: Plain text
10628 #: build/C/man5/proc.5:2716
10630 "This manual page is incomplete, possibly inaccurate, and is the kind of "
10631 "thing that needs to be updated very often."
10634 #. type: Plain text
10635 #: build/C/man5/proc.5:2741
10637 "B<cat>(1), B<dmesg>(1), B<find>(1), B<free>(1), B<ps>(1), B<tr>(1), "
10638 "B<uptime>(1), B<chroot>(2), B<mmap>(2), B<readlink>(2), B<syslog>(2), "
10639 "B<slabinfo>(5), B<hier>(7), B<time>(7), B<arp>(8), B<hdparm>(8), "
10640 "B<ifconfig>(8), B<init>(8), B<lsmod>(8), B<lspci>(8), B<mount>(8), "
10641 "B<netstat>(8), B<procinfo>(8), B<route>(8)"
10644 #. type: Plain text
10645 #: build/C/man5/proc.5:2744
10647 "The kernel source files: I<Documentation/filesystems/proc.txt>, "
10648 "I<Documentation/sysctl/vm.txt>"
10652 #: build/C/man7/standards.7:25
10658 #: build/C/man7/standards.7:25
10663 #. type: Plain text
10664 #: build/C/man7/standards.7:28
10665 msgid "standards - C and UNIX Standards"
10668 #. type: Plain text
10669 #: build/C/man7/standards.7:32
10671 "The CONFORMING TO section that appears in many manual pages identifies "
10672 "various standards to which the documented interface conforms. The following "
10673 "list briefly describes these standards."
10677 #: build/C/man7/standards.7:32
10682 #. type: Plain text
10683 #: build/C/man7/standards.7:35
10684 msgid "Version 7, the ancestral UNIX from Bell Labs."
10688 #: build/C/man7/standards.7:35
10693 #. type: Plain text
10694 #: build/C/man7/standards.7:44
10696 "This is an implementation standard defined by the 4.2 release of the "
10697 "I<Berkeley Software Distribution>, released by the University of California "
10698 "at Berkeley. This was the first Berkeley release that contained a TCP/IP "
10699 "stack and the sockets API. 4.2BSD was released in 1983."
10702 #. type: Plain text
10703 #: build/C/man7/standards.7:47
10705 "Earlier major BSD releases included I<3BSD> (1980), I<4BSD> (1980), and "
10706 "I<4.1BSD> (1981)."
10710 #: build/C/man7/standards.7:47
10715 #. type: Plain text
10716 #: build/C/man7/standards.7:50
10717 msgid "The successor to 4.2BSD, released in 1986."
10721 #: build/C/man7/standards.7:50
10726 #. type: Plain text
10727 #: build/C/man7/standards.7:54
10729 "The successor to 4.3BSD, released in 1993. This was the last major Berkeley "
10734 #: build/C/man7/standards.7:54
10736 msgid "B<System V>"
10739 #. type: Plain text
10740 #: build/C/man7/standards.7:61
10742 "This is an implementation standard defined by AT&T's milestone 1983 release "
10743 "of its commercial System V (five) release. The previous major AT&T release "
10744 "was I<System III>, released in 1981."
10748 #: build/C/man7/standards.7:61
10750 msgid "B<System V release 2 (SVr2)>"
10753 #. type: Plain text
10754 #: build/C/man7/standards.7:68
10756 "This was the next System V release, made in 1985. The SVr2 was formally "
10757 "described in the I<System V Interface Definition version 1> (I<SVID 1>) "
10758 "published in 1985."
10762 #: build/C/man7/standards.7:68
10764 msgid "B<System V release 3 (SVr3)>"
10767 #. type: Plain text
10768 #: build/C/man7/standards.7:74
10770 "This was the successor to SVr2, released in 1986. This release was formally "
10771 "described in the I<System V Interface Definition version 2> (I<SVID 2>)."
10775 #: build/C/man7/standards.7:74
10777 msgid "B<System V release 4 (SVr4)>"
10780 #. type: Plain text
10781 #: build/C/man7/standards.7:84
10783 "This was the successor to SVr3, released in 1989. This version of System V "
10784 "is described in the \"Programmer's Reference Manual: Operating System API "
10785 "(Intel processors)\" (Prentice-Hall 1992, ISBN 0-13-951294-2) This release "
10786 "was formally described in the I<System V Interface Definition version 3> "
10787 "(I<SVID 3>), and is considered the definitive System V release."
10791 #: build/C/man7/standards.7:84
10796 #. type: Plain text
10797 #: build/C/man7/standards.7:88
10799 "System V Interface Definition version 4, issued in 1995. Available online "
10800 "at http://www.sco.com/developers/devspecs/ ."
10804 #: build/C/man7/standards.7:88
10809 #. type: Plain text
10810 #: build/C/man7/standards.7:102
10812 "This was the first C language standard, ratified by ANSI (American National "
10813 "Standards Institute) in 1989 (I<X3.159-1989>). Sometimes this is known as "
10814 "I<ANSI C>, but since C99 is also an ANSI standard, this term is ambiguous. "
10815 "This standard was also ratified by ISO (International Standards "
10816 "Organization) in 1990 (I<ISO/IEC 9899:1990>), and is thus occasionally "
10817 "referred to as I<ISO C90>."
10821 #: build/C/man7/standards.7:102
10826 #. type: Plain text
10827 #: build/C/man7/standards.7:108
10829 "This revision of the C language standard was ratified by ISO in 1999 "
10830 "(I<ISO/IEC 9899:1999>). Available online at "
10831 "http://www.open-std.org/jtc1/sc22/wg14/www/standards."
10835 #: build/C/man7/standards.7:108
10837 msgid "B<POSIX.1-1990>"
10840 #. type: Plain text
10841 #: build/C/man7/standards.7:114
10843 "\"Portable Operating System Interface for Computing Environments\". IEEE "
10844 "1003.1-1990 part 1, ratified by ISO in 1990 (I<ISO/IEC 9945-1:1990>). The "
10845 "term \"POSIX\" was coined by Richard Stallman."
10849 #: build/C/man7/standards.7:114
10854 #. type: Plain text
10855 #: build/C/man7/standards.7:119
10857 "IEEE Std 1003.2-1992, describing commands and utilities, ratified by ISO in "
10858 "1993 (I<ISO/IEC 9945-2:1993>)."
10862 #: build/C/man7/standards.7:119
10864 msgid "B<POSIX.1b> (formerly known as I<POSIX.4>)"
10867 #. type: Plain text
10868 #: build/C/man7/standards.7:125
10870 "IEEE Std 1003.1b-1993 describing real-time facilities for portable operating "
10871 "systems, ratified by ISO in 1996 (I<ISO/IEC 9945-1:1996>)."
10875 #: build/C/man7/standards.7:125
10877 msgid "B<POSIX.1c>"
10880 #. type: Plain text
10881 #: build/C/man7/standards.7:128
10882 msgid "IEEE Std 1003.1c-1995 describing the POSIX threads interfaces."
10886 #: build/C/man7/standards.7:128
10888 msgid "B<POSIX.1d>"
10891 #. type: Plain text
10892 #: build/C/man7/standards.7:131
10893 msgid "IEEE Std 1003.1c-1999 describing additional real-time extensions."
10897 #: build/C/man7/standards.7:131
10899 msgid "B<POSIX.1g>"
10902 #. type: Plain text
10903 #: build/C/man7/standards.7:134
10904 msgid "IEEE Std 1003.1g-2000 describing networking APIs (including sockets)."
10908 #: build/C/man7/standards.7:134
10910 msgid "B<POSIX.1j>"
10913 #. type: Plain text
10914 #: build/C/man7/standards.7:137
10915 msgid "IEEE Std 1003.1j-2000 describing advanced real-time extensions."
10919 #: build/C/man7/standards.7:137
10921 msgid "B<POSIX.1-1996>"
10924 #. type: Plain text
10925 #: build/C/man7/standards.7:140
10926 msgid "A 1996 revision of POSIX.1 which incorporated POSIX.1b and POSIX.1c."
10930 #: build/C/man7/standards.7:140
10935 #. type: Plain text
10936 #: build/C/man7/standards.7:147
10938 "Released in 1989, this was the first significant release of the I<X/Open "
10939 "Portability Guide>, produced by the X/Open Company, a multivendor "
10940 "consortium. This multivolume guide was based on the POSIX standards."
10944 #: build/C/man7/standards.7:147
10949 #. type: Plain text
10950 #: build/C/man7/standards.7:150
10951 msgid "A revision of the X/Open Portability Guide, released in 1992."
10955 #: build/C/man7/standards.7:150
10960 #. type: Plain text
10961 #: build/C/man7/standards.7:157
10963 "A 1994 revision of XPG4. This is also referred to as I<Spec 1170>, where "
10964 "1170 referred to the number of interfaces defined by this standard."
10968 #: build/C/man7/standards.7:157
10970 msgid "B<SUS (SUSv1)>"
10973 #. type: Plain text
10974 #: build/C/man7/standards.7:165
10976 "Single UNIX Specification. This was a repackaging of XPG4v2 and other "
10977 "X/Open standards (X/Open Curses Issue 4 version 2, X/Open Networking Service "
10978 "(XNS) Issue 4). Systems conforming to this standard can be branded I<UNIX "
10983 #: build/C/man7/standards.7:165
10988 #. type: Plain text
10989 #: build/C/man7/standards.7:175
10991 "Single UNIX Specification version 2. Sometimes also referred to as "
10992 "I<XPG5>. This standard appeared in 1997. Systems conforming to this "
10993 "standard can be branded I<UNIX 98>. See also "
10994 "http://www.UNIX-systems.org/version2/ .)"
10998 #: build/C/man7/standards.7:175
11000 msgid "B<POSIX.1-2001, SUSv3>"
11003 #. type: Plain text
11004 #: build/C/man7/standards.7:185
11006 "This was a 2001 revision and consolidation of the POSIX.1, POSIX.2, and SUS "
11007 "standards into a single document, conducted under the auspices of the Austin "
11008 "group (http://www.opengroup.org/austin/ .) The standard is available online "
11009 "at http://www.unix-systems.org/version3/ , and the interfaces that it "
11010 "describes are also available in the Linux manual pages package under "
11011 "sections 1p and 3p (e.g., \"man 3p open\")."
11014 #. type: Plain text
11015 #: build/C/man7/standards.7:198
11017 "The standard defines two levels of conformance: I<POSIX conformance>, which "
11018 "is a baseline set of interfaces required of a conforming system; and I<XSI "
11019 "Conformance>, which additionally mandates a set of interfaces (the \"XSI "
11020 "extension\") which are only optional for POSIX conformance. XSI-conformant "
11021 "systems can be branded I<UNIX 03>. (XSI conformance constitutes the "
11022 "I<Single UNIX Specification version 3> (I<SUSv3>).)"
11025 #. type: Plain text
11026 #: build/C/man7/standards.7:200
11027 msgid "The POSIX.1-2001 document is broken into four parts:"
11030 #. type: Plain text
11031 #: build/C/man7/standards.7:203
11032 msgid "B<XBD>: Definitions, terms and concepts, header file specifications."
11035 #. type: Plain text
11036 #: build/C/man7/standards.7:207
11038 "B<XSH>: Specifications of functions (i.e., system calls and library "
11039 "functions in actual implementations)."
11042 #. type: Plain text
11043 #: build/C/man7/standards.7:211
11045 "B<XCU>: Specifications of commands and utilities (i.e., the area formerly "
11046 "described by POSIX.2)."
11049 #. type: Plain text
11050 #: build/C/man7/standards.7:214
11051 msgid "B<XRAT>: Informative text on the other parts of the standard."
11054 #. type: Plain text
11055 #: build/C/man7/standards.7:218
11057 "POSIX.1-2001 is aligned with C99, so that all of the library functions "
11058 "standardized in C99 are also standardized in POSIX.1-2001."
11061 #. type: Plain text
11062 #: build/C/man7/standards.7:225
11064 "Two Technical Corrigenda (minor fixes and improvements) of the original "
11065 "2001 standard have occurred: TC1 in 2003 (referred to as I<POSIX.1-2003>), "
11066 "and TC2 in 2004 (referred to as I<POSIX.1-2004>)."
11070 #: build/C/man7/standards.7:225
11072 msgid "B<POSIX.1-2008, SUSv4>"
11075 #. type: Plain text
11076 #: build/C/man7/standards.7:229
11077 msgid "Work on the next revision of POSIX.1/SUS was completed and ratified in 2008."
11080 #. type: Plain text
11081 #: build/C/man7/standards.7:238
11083 "The changes in this revision are not as large as those that occurred for "
11084 "POSIX.1-2001/SUSv3, but a number of new interfaces are added and various "
11085 "details of existing specifications are modified. Many of the interfaces "
11086 "that were optional in POSIX.1-2001 become mandatory in the 2008 revision of "
11087 "the standard. A few interfaces that are present in POSIX.1-2001 are marked "
11088 "as obsolete in POSIX.1-2008, or removed from the standard altogether."
11091 #. type: Plain text
11092 #: build/C/man7/standards.7:246
11094 "The revised standard is broken into the same four parts as POSIX.1-2001, and "
11095 "again there are two levels of conformance: the baseline I<POSIX "
11096 "Conformance>, and I<XSI Conformance>, which mandates an additional set of "
11097 "interfaces beyond those in the base specification."
11100 #. type: Plain text
11101 #: build/C/man7/standards.7:250
11103 "In general, where the CONFORMING TO section of a manual page lists "
11104 "POSIX.1-2001, it can be assumed that the interface also conforms to "
11105 "POSIX.1-2008, unless otherwise noted."
11108 #. type: Plain text
11109 #: build/C/man7/standards.7:253
11111 "Further information can be found on the Austin group web site, "
11112 "http://www.opengroup.org/austin/ ."
11115 #. type: Plain text
11116 #: build/C/man7/standards.7:256
11117 msgid "B<feature_test_macros>(7), B<libc>(7), B<posixoptions>(7)"
11121 #: build/C/man7/suffixes.7:38
11127 #: build/C/man7/suffixes.7:38
11132 #. type: Plain text
11133 #: build/C/man7/suffixes.7:41
11134 msgid "suffixes - list of file suffixes"
11137 #. type: Plain text
11138 #: build/C/man7/suffixes.7:49
11140 "It is customary to indicate the contents of a file with the file suffix, "
11141 "which consists of a period, followed by one or more letters. Many standard "
11142 "utilities, such as compilers, use this to recognize the type of file they "
11143 "are dealing with. The B<make>(1) utility is driven by rules based on file "
11147 #. type: Plain text
11148 #: build/C/man7/suffixes.7:52
11150 "Following is a list of suffixes which are likely to be found on a Linux "
11155 #: build/C/man7/suffixes.7:57
11157 msgid "Suffix\tFile type\n"
11161 #: build/C/man7/suffixes.7:58
11163 msgid " ,v\tfiles for RCS (Revision Control System)\n"
11167 #: build/C/man7/suffixes.7:59
11169 msgid " -\tbackup file\n"
11173 #: build/C/man7/suffixes.7:60
11175 msgid " .C\tC++ source code, equivalent to I<.cc>\n"
11179 #: build/C/man7/suffixes.7:61
11181 msgid " .F\tFortran source with B<cpp>(1) directives\n"
11185 #: build/C/man7/suffixes.7:62
11187 msgid "\tor file compressed using freeze\n"
11191 #: build/C/man7/suffixes.7:63
11193 msgid " .S\tassembler source with B<cpp>(1) directives\n"
11197 #: build/C/man7/suffixes.7:64
11199 msgid " .Y\tfile compressed using yabba\n"
11203 #: build/C/man7/suffixes.7:65
11205 msgid " .Z\tfile compressed using B<compress>(1)\n"
11209 #: build/C/man7/suffixes.7:66
11211 msgid " .[0-9]+gf\tTeX generic font files\n"
11215 #: build/C/man7/suffixes.7:67
11217 msgid " .[0-9]+pk\tTeX packed font files\n"
11221 #: build/C/man7/suffixes.7:68
11223 msgid " .[1-9]\tmanual page for the corresponding section\n"
11227 #: build/C/man7/suffixes.7:69
11229 msgid " .[1-9][a-z]\tmanual page for section plus subsection\n"
11233 #: build/C/man7/suffixes.7:70
11235 msgid " .a\tstatic object code library\n"
11239 #: build/C/man7/suffixes.7:71
11241 msgid " .ad\tX application default resource file\n"
11245 #: build/C/man7/suffixes.7:72
11247 msgid " .ada\tAda source (may be body, spec, or combination)\n"
11251 #: build/C/man7/suffixes.7:73
11253 msgid " .adb\tAda body source\n"
11257 #: build/C/man7/suffixes.7:74
11259 msgid " .ads\tAda spec source\n"
11263 #: build/C/man7/suffixes.7:75
11265 msgid " .afm\tPostScript font metrics\n"
11269 #: build/C/man7/suffixes.7:76
11271 msgid " .al\tPerl autoload file\n"
11275 #: build/C/man7/suffixes.7:77
11277 msgid " .am\tB<automake>(1) input file\n"
11281 #: build/C/man7/suffixes.7:78
11283 msgid " .arc\tB<arc>(1) archive\n"
11287 #: build/C/man7/suffixes.7:79
11289 msgid " .arj\tB<arj>(1) archive\n"
11293 #: build/C/man7/suffixes.7:80
11295 msgid " .asc\tPGP ASCII-armored data\n"
11299 #: build/C/man7/suffixes.7:81
11301 msgid " .asm\t(GNU) assembler source file\n"
11305 #: build/C/man7/suffixes.7:82
11307 msgid " .au\tAudio sound file\n"
11311 #: build/C/man7/suffixes.7:83
11313 msgid " .aux\tLaTeX auxiliary file\n"
11317 #: build/C/man7/suffixes.7:84
11319 msgid " .avi\t(msvideo) movie\n"
11323 #: build/C/man7/suffixes.7:85
11325 msgid " .awk\tAWK language program\n"
11329 #: build/C/man7/suffixes.7:86
11331 msgid " .b\tLILO boot loader image\n"
11335 #: build/C/man7/suffixes.7:87
11337 msgid " .bak\tbackup file\n"
11341 #: build/C/man7/suffixes.7:88
11343 msgid " .bash\tB<bash>(1) shell script\n"
11347 #: build/C/man7/suffixes.7:89
11349 msgid " .bb\tbasic block list data produced by\n"
11353 #: build/C/man7/suffixes.7:90 build/C/man7/suffixes.7:92
11355 msgid "\tgcc -ftest-coverage\n"
11359 #: build/C/man7/suffixes.7:91
11361 msgid " .bbg\tbasic block graph data produced by\n"
11365 #: build/C/man7/suffixes.7:93
11367 msgid " .bbl\tBibTeX output\n"
11371 #: build/C/man7/suffixes.7:94
11373 msgid " .bdf\tX font file\n"
11377 #: build/C/man7/suffixes.7:95
11379 msgid " .bib\tTeX bibliographic database, BibTeX input\n"
11383 #: build/C/man7/suffixes.7:96
11385 msgid " .bm\tbitmap source\n"
11389 #: build/C/man7/suffixes.7:97
11391 msgid " .bmp\tbitmap\n"
11395 #: build/C/man7/suffixes.7:98
11397 msgid " .bz2\tfile compressed using B<bzip2>(1)\n"
11401 #: build/C/man7/suffixes.7:99
11403 msgid " .c\tC source\n"
11407 #: build/C/man7/suffixes.7:100
11409 msgid " .cat\tmessage catalog files\n"
11413 #: build/C/man7/suffixes.7:101
11415 msgid " .cc\tC++ source\n"
11419 #: build/C/man7/suffixes.7:102
11421 msgid " .cf\tconfiguration file\n"
11425 #: build/C/man7/suffixes.7:103
11427 msgid " .cfg\tconfiguration file\n"
11431 #: build/C/man7/suffixes.7:104
11433 msgid " .cgi\tWWW content generating script or program\n"
11437 #: build/C/man7/suffixes.7:105
11439 msgid " .cls\tLaTeX Class definition\n"
11443 #: build/C/man7/suffixes.7:106
11445 msgid " .class\tJava compiled byte-code\n"
11449 #: build/C/man7/suffixes.7:107
11451 msgid " .conf\tconfiguration file\n"
11455 #: build/C/man7/suffixes.7:108
11457 msgid " .config\tconfiguration file\n"
11461 #: build/C/man7/suffixes.7:109
11463 msgid " .cpp\tequivalent to I<.cc>\n"
11467 #: build/C/man7/suffixes.7:110
11469 msgid " .csh\tB<csh>(1) shell script\n"
11473 #: build/C/man7/suffixes.7:111
11475 msgid " .cxx\tequivalent to I<.cc>\n"
11479 #: build/C/man7/suffixes.7:112
11481 msgid " .dat\tdata file\n"
11485 #: build/C/man7/suffixes.7:113
11487 msgid " .deb\tDebian software package\n"
11491 #: build/C/man7/suffixes.7:114
11493 msgid " .def\tModula-2 source for definition modules\n"
11497 #: build/C/man7/suffixes.7:115
11499 msgid " .def\tother definition files\n"
11503 #: build/C/man7/suffixes.7:116
11505 msgid " .desc\tinitial part of mail message unpacked with\n"
11509 #: build/C/man7/suffixes.7:117
11511 msgid "\tB<munpack>(1)\n"
11515 #: build/C/man7/suffixes.7:118
11517 msgid " .diff\tfile differences (B<diff>(1) command output)\n"
11521 #: build/C/man7/suffixes.7:119
11523 msgid " .dir\tdbm data base directory file\n"
11527 #: build/C/man7/suffixes.7:120
11529 msgid " .doc\tdocumentation file\n"
11533 #: build/C/man7/suffixes.7:121
11535 msgid " .dsc\tDebian Source Control (source package)\n"
11539 #: build/C/man7/suffixes.7:122
11541 msgid " .dtx\tLaTeX package source file\n"
11545 #: build/C/man7/suffixes.7:123
11547 msgid " .dvi\tTeX's device independent output\n"
11551 #: build/C/man7/suffixes.7:124
11553 msgid " .el\tEmacs-Lisp source\n"
11557 #: build/C/man7/suffixes.7:125
11559 msgid " .elc\tcompiled Emacs-Lisp source\n"
11563 #: build/C/man7/suffixes.7:126
11565 msgid " .eps\tencapsulated PostScript\n"
11569 #: build/C/man7/suffixes.7:127
11571 msgid " .exp\tExpect source code\n"
11575 #: build/C/man7/suffixes.7:128
11577 msgid " .f\tFortran source\n"
11581 #: build/C/man7/suffixes.7:129
11583 msgid " .f77\tFortran 77 source\n"
11587 #: build/C/man7/suffixes.7:130
11589 msgid " .f90\tFortran 90 source\n"
11593 #: build/C/man7/suffixes.7:131
11595 msgid " .fas\tprecompiled Common-Lisp\n"
11599 #: build/C/man7/suffixes.7:132
11601 msgid " .fi\tFortran include files\n"
11605 #: build/C/man7/suffixes.7:133
11607 msgid " .fig\tFIG image file (used by B<xfig>(1))\n"
11611 #: build/C/man7/suffixes.7:134
11613 msgid " .fmt\tTeX format file\n"
11617 #: build/C/man7/suffixes.7:135
11619 msgid " .gif\tCompuserve Graphics Image File format\n"
11623 #: build/C/man7/suffixes.7:136
11625 msgid " .gmo\tGNU format message catalog\n"
11629 #: build/C/man7/suffixes.7:137
11631 msgid " .gsf\tGhostscript fonts\n"
11635 #: build/C/man7/suffixes.7:138
11637 msgid " .gz\tfile compressed using B<gzip>(1)\n"
11641 #: build/C/man7/suffixes.7:139
11643 msgid " .h\tC or C++ header files\n"
11647 #: build/C/man7/suffixes.7:140
11649 msgid " .help\thelp file\n"
11653 #: build/C/man7/suffixes.7:141
11655 msgid " .hf\tequivalent to I<.help>\n"
11659 #: build/C/man7/suffixes.7:142
11661 msgid " .hlp\tequivalent to I<.help>\n"
11665 #: build/C/man7/suffixes.7:143
11667 msgid " .htm\tpoor man's I<.html>\n"
11671 #: build/C/man7/suffixes.7:144
11673 msgid " .html\tHTML document used with the World Wide Web\n"
11677 #: build/C/man7/suffixes.7:145
11679 msgid " .hqx\t7-bit encoded Macintosh file\n"
11683 #: build/C/man7/suffixes.7:146
11685 msgid " .i\tC source after preprocessing\n"
11689 #: build/C/man7/suffixes.7:147
11691 msgid " .icon\tbitmap source\n"
11695 #: build/C/man7/suffixes.7:148
11697 msgid " .idx\treference or datum-index file for hypertext\n"
11701 #: build/C/man7/suffixes.7:149
11703 msgid "\tor database system\n"
11707 #: build/C/man7/suffixes.7:150
11709 msgid " .image\tbitmap source\n"
11713 #: build/C/man7/suffixes.7:151
11715 msgid " .in\tconfiguration template, especially for GNU Autoconf\n"
11719 #: build/C/man7/suffixes.7:152
11721 msgid " .info\tfiles for the Emacs info browser\n"
11725 #: build/C/man7/suffixes.7:153
11727 msgid " .info-[0-9]+\tsplit info files\n"
11731 #: build/C/man7/suffixes.7:154
11733 msgid " .ins\tLaTeX package install file for docstrip\n"
11737 #: build/C/man7/suffixes.7:155
11739 msgid " .itcl\titcl source code;\n"
11743 #: build/C/man7/suffixes.7:156
11745 msgid "\titcl ([incr Tcl]) is an OO extension of tcl\n"
11749 #: build/C/man7/suffixes.7:157
11751 msgid " .java\ta Java source file\n"
11755 #: build/C/man7/suffixes.7:158
11757 msgid " .jpeg\tJoint Photographic Experts Group format\n"
11761 #: build/C/man7/suffixes.7:159
11763 msgid " .jpg\tpoor man's I<.jpeg>\n"
11767 #: build/C/man7/suffixes.7:160
11769 msgid " .kmap\tB<lyx>(1) keymap\n"
11773 #: build/C/man7/suffixes.7:161
11775 msgid " .l\tequivalent to I<.lex> or I<.lisp>\n"
11779 #: build/C/man7/suffixes.7:162
11781 msgid " .lex\tB<lex>(1) or B<flex>(1) files\n"
11785 #: build/C/man7/suffixes.7:163
11787 msgid " .lha\tlharc archive\n"
11791 #: build/C/man7/suffixes.7:164
11793 msgid " .lib\tCommon-Lisp library\n"
11797 #: build/C/man7/suffixes.7:165
11799 msgid " .lisp\tLisp source\n"
11803 #: build/C/man7/suffixes.7:166
11805 msgid " .ln\tfiles for use with B<lint>(1)\n"
11809 #: build/C/man7/suffixes.7:167
11811 msgid " .log\tlog file, in particular produced by TeX\n"
11815 #: build/C/man7/suffixes.7:168
11817 msgid " .lsm\tLinux Software Map entry\n"
11821 #: build/C/man7/suffixes.7:169
11823 msgid " .lsp\tCommon-Lisp source\n"
11827 #: build/C/man7/suffixes.7:170
11829 msgid " .lzh\tlharc archive\n"
11833 #: build/C/man7/suffixes.7:171
11835 msgid " .m\tObjective-C source code\n"
11839 #: build/C/man7/suffixes.7:172
11841 msgid " .m4\tB<m4>(1) source\n"
11845 #: build/C/man7/suffixes.7:173
11847 msgid " .mac\tmacro files for various programs\n"
11851 #: build/C/man7/suffixes.7:174
11853 msgid " .man\tmanual page (usually source rather than formatted)\n"
11857 #: build/C/man7/suffixes.7:175
11859 msgid " .map\tmap files for various programs\n"
11863 #: build/C/man7/suffixes.7:176
11865 msgid " .me\tNroff source using the me macro package\n"
11869 #: build/C/man7/suffixes.7:177
11871 msgid " .mf\tMetafont (font generator for TeX) source\n"
11875 #: build/C/man7/suffixes.7:178
11877 msgid " .mgp\tMagicPoint file\n"
11881 #: build/C/man7/suffixes.7:179
11883 msgid " .mm\tsources for B<groff>(1) in mm - format\n"
11887 #: build/C/man7/suffixes.7:180
11889 msgid " .mo\tMessage catalog binary file\n"
11893 #: build/C/man7/suffixes.7:181
11895 msgid " .mod\tModula-2 source for implementation modules\n"
11899 #: build/C/man7/suffixes.7:182
11901 msgid " .mov\t(quicktime) movie\n"
11905 #: build/C/man7/suffixes.7:183
11907 msgid " .mp\tMetapost source\n"
11911 #: build/C/man7/suffixes.7:184
11913 msgid " .mp2\tMPEG Layer 2 (audio) file\n"
11917 #: build/C/man7/suffixes.7:185
11919 msgid " .mp3\tMPEG Layer 3 (audio) file\n"
11923 #: build/C/man7/suffixes.7:186
11925 msgid " .mpeg\tmovie file\n"
11929 #: build/C/man7/suffixes.7:187
11931 msgid " .o\tobject file\n"
11935 #: build/C/man7/suffixes.7:188
11937 msgid " .old\told or backup file\n"
11941 #: build/C/man7/suffixes.7:189
11943 msgid " .orig\tbackup (original) version of a file, from B<patch>(1)\n"
11947 #: build/C/man7/suffixes.7:190
11949 msgid " .out\toutput file, often executable program (a.out)\n"
11953 #: build/C/man7/suffixes.7:191
11955 msgid " .p\tPascal source\n"
11959 #: build/C/man7/suffixes.7:192
11961 msgid " .pag\tdbm data base data file\n"
11965 #: build/C/man7/suffixes.7:193
11967 msgid " .patch\tfile differences for B<patch>(1)\n"
11971 #: build/C/man7/suffixes.7:194
11973 msgid " .pbm\tportable bitmap format\n"
11977 #: build/C/man7/suffixes.7:195
11979 msgid " .pcf\tX11 font files\n"
11983 #: build/C/man7/suffixes.7:196
11985 msgid " .pdf\tAdobe Portable Data Format\n"
11989 #: build/C/man7/suffixes.7:197
11991 msgid "\t(use Acrobat/B<acroread> or B<xpdf>)\n"
11995 #: build/C/man7/suffixes.7:198
11997 msgid " .perl\tPerl source (see .ph, .pl and .pm)\n"
12001 #: build/C/man7/suffixes.7:199
12003 msgid " .pfa\tPostScript font definition files, ASCII format\n"
12007 #: build/C/man7/suffixes.7:200
12009 msgid " .pfb\tPostScript font definition files, binary format\n"
12013 #: build/C/man7/suffixes.7:201
12015 msgid " .pgm\tportable greymap format\n"
12019 #: build/C/man7/suffixes.7:202
12021 msgid " .pgp\tPGP binary data\n"
12025 #: build/C/man7/suffixes.7:203
12027 msgid " .ph\tPerl header file\n"
12031 #: build/C/man7/suffixes.7:204
12033 msgid " .php\tPHP program file\n"
12037 #: build/C/man7/suffixes.7:205
12039 msgid " .php3\tPHP3 program file\n"
12043 #: build/C/man7/suffixes.7:206
12045 msgid " .pid\tFile to store daemon PID (e.g., crond.pid)\n"
12049 #: build/C/man7/suffixes.7:207
12051 msgid " .pl\tTeX property list file or Perl library file\n"
12055 #: build/C/man7/suffixes.7:208
12057 msgid " .pm\tPerl module\n"
12061 #: build/C/man7/suffixes.7:209
12063 msgid " .png\tPortable Network Graphics file\n"
12067 #: build/C/man7/suffixes.7:210
12069 msgid " .po\tMessage catalog source\n"
12073 #: build/C/man7/suffixes.7:211
12075 msgid " .pod\tB<perldoc>(1) file\n"
12079 #: build/C/man7/suffixes.7:212
12081 msgid " .ppm\tportable pixmap format\n"
12085 #: build/C/man7/suffixes.7:213
12087 msgid " .pr\tbitmap source\n"
12091 #: build/C/man7/suffixes.7:214
12093 msgid " .ps\tPostScript file\n"
12097 #: build/C/man7/suffixes.7:215
12099 msgid " .py\tPython source\n"
12103 #: build/C/man7/suffixes.7:216
12105 msgid " .pyc\tcompiled python\n"
12109 #: build/C/man7/suffixes.7:217
12111 msgid " .qt\tquicktime movie\n"
12115 #: build/C/man7/suffixes.7:218
12117 msgid " .r\tRATFOR source (obsolete)\n"
12121 #: build/C/man7/suffixes.7:219
12123 msgid " .rej\tpatches that B<patch>(1) couldn't apply\n"
12127 #: build/C/man7/suffixes.7:220
12129 msgid " .rpm\tRPM software package\n"
12133 #: build/C/man7/suffixes.7:221
12135 msgid " .rtf\tRich Text Format file\n"
12139 #: build/C/man7/suffixes.7:222
12141 msgid " .rules\trules for something\n"
12145 #: build/C/man7/suffixes.7:223
12147 msgid " .s\tassembler source\n"
12151 #: build/C/man7/suffixes.7:224
12153 msgid " .sa\tstub libraries for a.out shared libraries\n"
12157 #: build/C/man7/suffixes.7:225
12159 msgid " .sc\tB<sc>(1) spreadsheet commands\n"
12163 #: build/C/man7/suffixes.7:226
12165 msgid " .scm\tScheme source code\n"
12169 #: build/C/man7/suffixes.7:227
12171 msgid " .sed\tsed source file\n"
12175 #: build/C/man7/suffixes.7:228
12177 msgid " .sgml\tSGML source file\n"
12181 #: build/C/man7/suffixes.7:229
12183 msgid " .sh\tB<sh>(1) scripts\n"
12187 #: build/C/man7/suffixes.7:230
12189 msgid " .shar\tarchive created by the B<shar>(1) utility\n"
12193 #: build/C/man7/suffixes.7:231
12195 msgid " .so\tShared library or dynamically loadable object\n"
12199 #: build/C/man7/suffixes.7:232
12201 msgid " .sql\tSQL source\n"
12205 #: build/C/man7/suffixes.7:233
12207 msgid " .sqml\tSQML schema or query program\n"
12211 #: build/C/man7/suffixes.7:234
12213 msgid " .sty\tLaTeX style files\n"
12217 #: build/C/man7/suffixes.7:235
12219 msgid " .sym\tModula-2 compiled definition modules\n"
12223 #: build/C/man7/suffixes.7:236
12225 msgid " .tar\tarchive created by the B<tar>(1) utility\n"
12229 #: build/C/man7/suffixes.7:237
12231 msgid " .tar.Z\ttar(1) archive compressed with B<compress>(1)\n"
12235 #: build/C/man7/suffixes.7:238
12237 msgid " .tar.bz2\ttar(1) archive compressed with B<bzip2>(1)\n"
12241 #: build/C/man7/suffixes.7:239
12243 msgid " .tar.gz\ttar(1) archive compressed with B<gzip>(1)\n"
12247 #: build/C/man7/suffixes.7:240
12249 msgid " .taz\ttar(1) archive compressed with B<compress>(1)\n"
12253 #: build/C/man7/suffixes.7:241
12255 msgid " .tcl\ttcl source code\n"
12259 #: build/C/man7/suffixes.7:242
12261 msgid " .tex\tTeX or LaTeX source\n"
12265 #: build/C/man7/suffixes.7:243
12267 msgid " .texi\tequivalent to I<.texinfo>\n"
12271 #: build/C/man7/suffixes.7:244
12273 msgid " .texinfo\tTexinfo documentation source\n"
12277 #: build/C/man7/suffixes.7:245
12279 msgid " .text\ttext file\n"
12283 #: build/C/man7/suffixes.7:246
12285 msgid " .tfm\tTeX font metric file\n"
12289 #: build/C/man7/suffixes.7:247
12291 msgid " .tgz\ttar archive compressed with B<gzip>(1)\n"
12295 #: build/C/man7/suffixes.7:248
12297 msgid " .tif\tpoor man's I<.tiff>\n"
12301 #: build/C/man7/suffixes.7:249
12303 msgid " .tiff\tTagged Image File Format\n"
12307 #: build/C/man7/suffixes.7:250
12309 msgid " .tk\ttcl/tk script\n"
12313 #: build/C/man7/suffixes.7:251
12315 msgid " .tmp\ttemporary file\n"
12319 #: build/C/man7/suffixes.7:252
12321 msgid " .tmpl\ttemplate files\n"
12325 #: build/C/man7/suffixes.7:253
12327 msgid " .txt\tequivalent to I<.text>\n"
12331 #: build/C/man7/suffixes.7:254
12333 msgid " .uu\tequivalent to I<.uue>\n"
12337 #: build/C/man7/suffixes.7:255
12339 msgid " .uue\tbinary file encoded with B<uuencode>(1)\n"
12343 #: build/C/man7/suffixes.7:256
12345 msgid " .vf\tTeX virtual font file\n"
12349 #: build/C/man7/suffixes.7:257
12351 msgid " .vpl\tTeX virtual property list file\n"
12355 #: build/C/man7/suffixes.7:258
12357 msgid " .w\tSilvio Levi's CWEB\n"
12361 #: build/C/man7/suffixes.7:259
12363 msgid " .wav\twave sound file\n"
12367 #: build/C/man7/suffixes.7:260
12369 msgid " .web\tDonald Knuth's WEB\n"
12373 #: build/C/man7/suffixes.7:261
12375 msgid " .wml\tSource file for Web Meta Language\n"
12379 #: build/C/man7/suffixes.7:262
12381 msgid " .xbm\tX11 bitmap source\n"
12385 #: build/C/man7/suffixes.7:263
12387 msgid " .xcf\tGIMP graphic\n"
12391 #: build/C/man7/suffixes.7:264
12393 msgid " .xml\teXtended Markup Language file\n"
12397 #: build/C/man7/suffixes.7:265
12399 msgid " .xpm\tX11 pixmap source\n"
12403 #: build/C/man7/suffixes.7:266
12405 msgid " .xs\tPerl xsub file produced by h2xs\n"
12409 #: build/C/man7/suffixes.7:267
12411 msgid " .xsl\tXSL stylesheet\n"
12415 #: build/C/man7/suffixes.7:268
12417 msgid " .y\tB<yacc>(1) or B<bison>(1) (parser generator) files\n"
12421 #: build/C/man7/suffixes.7:269
12423 msgid " .z\tFile compressed using B<pack>(1) (or an old B<gzip>(1))\n"
12427 #: build/C/man7/suffixes.7:270
12429 msgid " .zip\tB<zip>(1) archive\n"
12433 #: build/C/man7/suffixes.7:271
12435 msgid " .zoo\tB<zoo>(1) archive\n"
12439 #: build/C/man7/suffixes.7:272
12441 msgid " ~\tEmacs or B<patch>(1) backup file\n"
12445 #: build/C/man7/suffixes.7:273
12447 msgid " rc\tstartup (`run control') file, e.g., I<.newsrc>\n"
12450 #. type: Plain text
12451 #: build/C/man7/suffixes.7:277
12452 msgid "General UNIX conventions."
12455 #. type: Plain text
12456 #: build/C/man7/suffixes.7:279
12457 msgid "This list is not exhaustive."
12460 #. type: Plain text
12461 #: build/C/man7/suffixes.7:281
12462 msgid "B<file>(1), B<make>(1)"
12466 #: build/C/man3/undocumented.3:29
12468 msgid "UNDOCUMENTED"
12472 #: build/C/man3/undocumented.3:29
12477 #. type: Plain text
12478 #: build/C/man3/undocumented.3:32
12479 msgid "none - undocumented library functions"
12482 #. type: Plain text
12483 #: build/C/man3/undocumented.3:34
12484 msgid "Undocumented library functions"
12487 #. type: Plain text
12488 #: build/C/man3/undocumented.3:37
12490 "This man page mentions those library functions which are implemented in the "
12491 "standard libraries but not yet documented in man pages."
12495 #: build/C/man3/undocumented.3:37
12497 msgid "Solicitation"
12500 #. type: Plain text
12501 #: build/C/man3/undocumented.3:43
12503 "If you have information about these functions, please look in the source "
12504 "code, write a man page (using a style similar to that of the other Linux "
12505 "section 3 man pages), and send it to B<mtk.manpages@gmail.com> for inclusion "
12506 "in the next man page release."
12510 #: build/C/man3/undocumented.3:43
12515 #. .BR chflags (3),
12516 #. .BR fattach (3),
12517 #. .BR fchflags (3),
12519 #. .BR fdetach (3),
12520 #. .BR obstack stuff (3),
12521 #. type: Plain text
12522 #: build/C/man3/undocumented.3:190
12524 "B<authdes_create>(3), B<authdes_getucred>(3), B<authdes_pk_create>(3), "
12525 "B<clntunix_create>(3), B<creat64>(3), B<dn_skipname>(3), B<fcrypt>(3), "
12526 "B<fp_nquery>(3), B<fp_query>(3), B<fp_resstat>(3), B<freading>(3), "
12527 "B<freopen64>(3), B<fseeko64>(3), B<ftello64>(3), B<ftw64>(3), B<fwscanf>(3), "
12528 "B<get_avphys_pages>(3), B<getdirentries64>(3), B<getmsg>(3), "
12529 "B<getnetname>(3), B<get_nprocs>(3), B<get_nprocs_conf>(3), "
12530 "B<get_phys_pages>(3), B<getpublickey>(3), B<getsecretkey>(3), "
12531 "B<h_errlist>(3), B<host2netname>(3), B<hostalias>(3), "
12532 "B<if_freenameindex>(3), B<if_indextoname>(3), B<if_nameindex>(3), "
12533 "B<if_nametoindex>(3), B<inet_nsap_addr>(3), B<inet_nsap_ntoa>(3), "
12534 "B<init_des>(3), B<libc_nls_init>(3), B<lio_listio>(3), B<mallinfo>(3), "
12535 "B<mallopt>(3), B<mcheck>(3), B<mprobe>(3), B<mstats>(3), B<netname2host>(3), "
12536 "B<netname2user>(3), B<nlist>(3), B<obstack_free>(3), "
12537 "B<parse_printf_format>(3), B<p_cdname>(3), B<p_cdnname>(3), B<p_class>(3), "
12538 "B<p_fqname>(3), B<p_option>(3), B<p_query>(3), B<printf_size>(3), "
12539 "B<printf_size_info>(3), B<p_rr>(3), B<p_time>(3), B<p_type>(3), "
12540 "B<putlong>(3), B<putshort>(3), B<re_compile_fastmap>(3), "
12541 "B<re_compile_pattern>(3), B<register_printf_function>(3), B<re_match>(3), "
12542 "B<re_match_2>(3), B<re_rx_search>(3), B<re_search>(3), B<re_search_2>(3), "
12543 "B<re_set_registers>(3), B<re_set_syntax>(3), B<res_send_setqhook>(3), "
12544 "B<res_send_setrhook>(3), B<ruserpass>(3), B<setfileno>(3), "
12545 "B<sethostfile>(3), B<svc_exit>(3), B<svcudp_enablecache>(3), B<tell>(3), "
12546 "B<tr_break>(3), B<tzsetwall>(3), B<ufc_dofinalperm>(3), B<ufc_doit>(3), "
12547 "B<user2netname>(3), B<vlimit>(3), B<vtimes>(3), B<wcschrnul>(3), "
12548 "B<wcsftime>(3), B<wscanf>(3), B<xdr_authdes_cred>(3), "
12549 "B<xdr_authdes_verf>(3), B<xdr_cryptkeyarg>(3), B<xdr_cryptkeyres>(3), "
12550 "B<xdr_datum>(3), B<xdr_des_block>(3), B<xdr_domainname>(3), "
12551 "B<xdr_getcredres>(3), B<xdr_keybuf>(3), B<xdr_keystatus>(3), "
12552 "B<xdr_mapname>(3), B<xdr_netnamestr>(3), B<xdr_netobj>(3), B<xdr_passwd>(3), "
12553 "B<xdr_peername>(3), B<xdr_rmtcall_args>(3), B<xdr_rmtcallres>(3), "
12554 "B<xdr_unixcred>(3), B<xdr_yp_buf>(3), B<xdr_yp_inaddr>(3), "
12555 "B<xdr_ypbind_binding>(3), B<xdr_ypbind_resp>(3), B<xdr_ypbind_resptype>(3), "
12556 "B<xdr_ypbind_setdom>(3), B<xdr_ypdelete_args>(3), B<xdr_ypmaplist>(3), "
12557 "B<xdr_ypmaplist_str>(3), B<xdr_yppasswd>(3), B<xdr_ypreq_key>(3), "
12558 "B<xdr_ypreq_nokey>(3), B<xdr_ypresp_all>(3), B<xdr_ypresp_all_seq>(3), "
12559 "B<xdr_ypresp_key_val>(3), B<xdr_ypresp_maplist>(3), B<xdr_ypresp_master>(3), "
12560 "B<xdr_ypresp_order>(3), B<xdr_ypresp_val>(3), B<xdr_ypstat>(3), "
12561 "B<xdr_ypupdate_args>(3), B<yp_all>(3), B<yp_bind>(3), B<yperr_string>(3), "
12562 "B<yp_first>(3), B<yp_get_default_domain>(3), B<yp_maplist>(3), "
12563 "B<yp_master>(3), B<yp_match>(3), B<yp_next>(3), B<yp_order>(3), "
12564 "B<ypprot_err>(3), B<yp_unbind>(3), B<yp_update>(3)"
12568 #: build/C/man2/unimplemented.2:27
12570 msgid "UNIMPLEMENTED"
12574 #: build/C/man2/unimplemented.2:27
12579 #. type: Plain text
12580 #: build/C/man2/unimplemented.2:31
12582 "afs_syscall, break, ftime, getpmsg, gtty, lock, madvise1, mpx, prof, profil, "
12583 "putpmsg, security, stty, tuxcall, ulimit, vserver - unimplemented system "
12587 #. type: Plain text
12588 #: build/C/man2/unimplemented.2:33
12589 msgid "Unimplemented system calls."
12592 #. type: Plain text
12593 #: build/C/man2/unimplemented.2:35
12594 msgid "These system calls are not implemented in the Linux 2.6.22 kernel."
12597 #. type: Plain text
12598 #: build/C/man2/unimplemented.2:40
12599 msgid "These system calls always return -1 and set I<errno> to B<ENOSYS>."
12602 #. type: Plain text
12603 #: build/C/man2/unimplemented.2:47
12605 "Note that B<ftime>(3), B<profil>(3) and B<ulimit>(3) are implemented as "
12606 "library functions."
12609 #. type: Plain text
12610 #: build/C/man2/unimplemented.2:56
12612 "Some system calls, like B<alloc_hugepages>(2), B<free_hugepages>(2), "
12613 "B<ioperm>(2), B<iopl>(2), and B<vm86>(2) only exist on certain "
12617 #. type: Plain text
12618 #: build/C/man2/unimplemented.2:64
12620 "Some system calls, like B<ipc>(2), B<create_module>(2), B<init_module>(2), "
12621 "and B<delete_module>(2) only exist when the Linux kernel was built with "
12622 "support for them."
12625 #. type: Plain text
12626 #: build/C/man2/unimplemented.2:65
12627 msgid "B<syscalls>(2)"
12631 #: build/C/man7/units.7:24
12637 #: build/C/man7/units.7:24
12642 #. type: Plain text
12643 #: build/C/man7/units.7:27
12644 msgid "units, kilo, kibi, mega, mebi, giga, gibi - decimal and binary prefixes"
12648 #: build/C/man7/units.7:28
12650 msgid "Decimal prefixes"
12653 #. type: Plain text
12654 #: build/C/man7/units.7:32
12656 "The SI system of units uses prefixes that indicate powers of ten. A "
12657 "kilometer is 1000 meter, and a megawatt is 1000000 watt. Below the standard "
12662 #: build/C/man7/units.7:35 build/C/man7/units.7:76
12664 msgid "Prefix\tName\tValue\n"
12668 #: build/C/man7/units.7:36
12670 msgid "y\tyocto\t10^-24 = 0.000000000000000000000001\n"
12674 #: build/C/man7/units.7:37
12676 msgid "z\tzepto\t10^-21 = 0.000000000000000000001\n"
12680 #: build/C/man7/units.7:38
12682 msgid "a\tatto\t10^-18 = 0.000000000000000001\n"
12686 #: build/C/man7/units.7:39
12688 msgid "f\tfemto\t10^-15 = 0.000000000000001\n"
12692 #: build/C/man7/units.7:40
12694 msgid "p\tpico\t10^-12 = 0.000000000001\n"
12698 #: build/C/man7/units.7:41
12700 msgid "n\tnano\t10^-9 = 0.000000001\n"
12704 #: build/C/man7/units.7:42
12706 msgid "u\tmicro\t10^-6 = 0.000001\n"
12710 #: build/C/man7/units.7:43
12712 msgid "m\tmilli\t10^-3 = 0.001\n"
12716 #: build/C/man7/units.7:44
12718 msgid "c\tcenti\t10^-2 = 0.01\n"
12722 #: build/C/man7/units.7:45
12724 msgid "d\tdeci\t10^-1 = 0.1\n"
12728 #: build/C/man7/units.7:46
12730 msgid "da\tdeka\t10^ 1 = 10\n"
12734 #: build/C/man7/units.7:47
12736 msgid "h\thecto\t10^ 2 = 100\n"
12740 #: build/C/man7/units.7:48
12742 msgid "k\tkilo\t10^ 3 = 1000\n"
12746 #: build/C/man7/units.7:49
12748 msgid "M\tmega\t10^ 6 = 1000000\n"
12752 #: build/C/man7/units.7:50
12754 msgid "G\tgiga\t10^ 9 = 1000000000\n"
12758 #: build/C/man7/units.7:51
12760 msgid "T\ttera\t10^12 = 1000000000000\n"
12764 #: build/C/man7/units.7:52
12766 msgid "P\tpeta\t10^15 = 1000000000000000\n"
12770 #: build/C/man7/units.7:53
12772 msgid "E\texa\t10^18 = 1000000000000000000\n"
12776 #: build/C/man7/units.7:54
12778 msgid "Z\tzetta\t10^21 = 1000000000000000000000\n"
12782 #: build/C/man7/units.7:55
12784 msgid "Y\tyotta\t10^24 = 1000000000000000000000000\n"
12787 #. type: Plain text
12788 #: build/C/man7/units.7:62
12790 "The symbol for micro is the Greek letter mu, often written u in an ASCII "
12791 "context where this Greek letter is not available. See also"
12794 #. type: Plain text
12795 #: build/C/man7/units.7:65
12796 msgid "http://physics.nist.gov/cuu/Units/prefixes.html"
12800 #: build/C/man7/units.7:66
12802 msgid "Binary prefixes"
12805 #. type: Plain text
12806 #: build/C/man7/units.7:73
12808 "The binary prefixes resemble the decimal ones, but have an additional "
12809 "\\(aqi\\(aq (and \"Ki\" starts with a capital \\(aqK\\(aq). The names are "
12810 "formed by taking the first syllable of the names of the decimal prefix with "
12811 "roughly the same size, followed by \"bi\" for \"binary\"."
12815 #: build/C/man7/units.7:77
12817 msgid "Ki\tkibi\t2^10 = 1024\n"
12821 #: build/C/man7/units.7:78
12823 msgid "Mi\tmebi\t2^20 = 1048576\n"
12827 #: build/C/man7/units.7:79
12829 msgid "Gi\tgibi\t2^30 = 1073741824\n"
12833 #: build/C/man7/units.7:80
12835 msgid "Ti\ttebi\t2^40 = 1099511627776\n"
12839 #: build/C/man7/units.7:81
12841 msgid "Pi\tpebi\t2^50 = 1125899906842624\n"
12845 #: build/C/man7/units.7:82
12847 msgid "Ei\texbi\t2^60 = 1152921504606846976\n"
12850 #. type: Plain text
12851 #: build/C/man7/units.7:87
12855 #. type: Plain text
12856 #: build/C/man7/units.7:90
12857 msgid "http://physics.nist.gov/cuu/Units/binary.html"
12861 #: build/C/man7/units.7:91
12866 #. type: Plain text
12867 #: build/C/man7/units.7:96
12869 "Before these binary prefixes were introduced, it was fairly common to use "
12870 "k=1000 and K=1024, just like b=bit, B=byte. Unfortunately, the M is capital "
12871 "already, and cannot be capitalized to indicate binary-ness."
12874 #. type: Plain text
12875 #: build/C/man7/units.7:107
12877 "At first that didn't matter too much, since memory modules and disks came in "
12878 "sizes that were powers of two, so everyone knew that in such contexts "
12879 "\"kilobyte\" and \"megabyte\" meant 1024 and 1048576 bytes, respectively. "
12880 "What originally was a sloppy use of the prefixes \"kilo\" and \"mega\" "
12881 "started to become regarded as the \"real true meaning\" when computers were "
12882 "involved. But then disk technology changed, and disk sizes became arbitrary "
12883 "numbers. After a period of uncertainty all disk manufacturers settled on "
12884 "the standard, namely k=1000, M=1000k, G=1000M."
12887 #. also common: 14.4k modem
12888 #. type: Plain text
12889 #: build/C/man7/units.7:114
12891 "The situation was messy: in the 14k4 modems, k=1000; in the 1.44MB "
12892 "diskettes, M=1024000; etc. In 1998 the IEC approved the standard that "
12893 "defines the binary prefixes given above, enabling people to be precise and "
12897 #. type: Plain text
12898 #: build/C/man7/units.7:116
12899 msgid "Thus, today, MB = 1000000B and MiB = 1048576B."
12902 #. type: Plain text
12903 #: build/C/man7/units.7:120
12905 "In the free software world programs are slowly being changed to conform. "
12906 "When the Linux kernel boots and says"
12909 #. type: Plain text
12910 #: build/C/man7/units.7:124
12912 msgid "hda: 120064896 sectors (61473 MB) w/2048KiB Cache\n"
12915 #. type: Plain text
12916 #: build/C/man7/units.7:127
12917 msgid "the MB are megabytes and the KiB are kibibytes."
12921 #: build/C/man7/mdoc.samples.7:39
12923 msgid "December 30, 1993"
12927 #: build/C/man7/mdoc.samples.7:41
12929 msgid "MDOC.SAMPLES 7"
12932 #. type: Plain text
12933 #: build/C/man7/mdoc.samples.7:44
12934 msgid "E<.Nm mdoc.samples>"
12938 #: build/C/man7/mdoc.samples.7:44
12940 msgid "tutorial sampler for writing"
12943 #. type: Plain text
12944 #: build/C/man7/mdoc.samples.7:48
12945 msgid "E<.Bx> manuals with E<.Nm \\-mdoc>"
12948 #. type: Plain text
12949 #: build/C/man7/mdoc.samples.7:50
12950 msgid "E<.Nm man mdoc.samples>"
12953 #. type: Plain text
12954 #: build/C/man7/mdoc.samples.7:95
12956 "A tutorial sampler for writing E<.Bx> manual pages with the E<.Nm \\-mdoc> "
12957 "macro package, a E<.Em content Ns \\-based> and E<.Em domain Ns \\-based> "
12958 "formatting package for E<.Xr troff 1>. Its predecessor, the E<.Xr \\-man 7> "
12959 "package, addressed page layout leaving the manipulation of fonts and other "
12960 "typesetting details to the individual author. In E<.Nm \\-mdoc>, page "
12961 "layout macros make up the E<.Em \"page structure domain\"> which consists of "
12962 "macros for titles, section headers, displays and lists. Essentially items "
12963 "which affect the physical position of text on a formatted page. In addition "
12964 "to the page structure domain, there are two more domains, the manual domain "
12965 "and the general text domain. The general text domain is defined as macros "
12966 "which perform tasks such as quoting or emphasizing pieces of text. The "
12967 "manual domain is defined as macros that are a subset of the day to day "
12968 "informal language used to describe commands, routines and related E<.Bx> "
12969 "files. Macros in the manual domain handle command names, command-line "
12970 "arguments and options, function names, function parameters, pathnames, "
12971 "variables, cross references to other manual pages, and so on. These domain "
12972 "items have value for both the author and the future user of the manual "
12973 "page. It is hoped the consistency gained across the manual set will provide "
12974 "easier translation to future documentation tools."
12977 #. type: Plain text
12978 #: build/C/man7/mdoc.samples.7:102
12980 "Throughout the E<.Ux> manual pages, a manual entry is simply referred to as "
12981 "a man page, regardless of actual length and without sexist intention."
12985 #: build/C/man7/mdoc.samples.7:102
12987 msgid "GETTING STARTED"
12990 #. type: Plain text
12991 #: build/C/man7/mdoc.samples.7:108
12993 "Since a tutorial document is normally read when a person desires to use the "
12994 "material immediately, the assumption has been made that the user of this "
12995 "document may be impatient. The material presented in the remained of this "
12996 "document is outlined as follows:"
12999 #. type: Plain text
13000 #: build/C/man7/mdoc.samples.7:111
13001 msgid "E<.Tn \"TROFF IDIOSYNCRASIES\">"
13005 #: build/C/man7/mdoc.samples.7:112
13007 msgid "\"Macro Usage\" ."
13011 #: build/C/man7/mdoc.samples.7:113
13013 msgid "\"Passing Space Characters in an Argument\" ."
13017 #: build/C/man7/mdoc.samples.7:114
13019 msgid "\"Trailing Blank Space Characters (a warning)\" ."
13023 #: build/C/man7/mdoc.samples.7:115
13025 msgid "\"Escaping Special Characters\" ."
13028 #. type: Plain text
13029 #: build/C/man7/mdoc.samples.7:119
13030 msgid "E<.Tn \"THE ANATOMY OF A MAN PAGE\">"
13034 #: build/C/man7/mdoc.samples.7:120
13036 msgid "\"A manual page template\" ."
13039 #. type: Plain text
13040 #: build/C/man7/mdoc.samples.7:124
13041 msgid "E<.Tn \"TITLE MACROS\">."
13044 #. type: Plain text
13045 #: build/C/man7/mdoc.samples.7:126
13046 msgid "E<.Tn \"INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS\">."
13050 #: build/C/man7/mdoc.samples.7:127
13052 msgid "\"What's in a name...\" ."
13056 #: build/C/man7/mdoc.samples.7:128
13058 msgid "\"General Syntax\" ."
13061 #. type: Plain text
13062 #: build/C/man7/mdoc.samples.7:132
13063 msgid "E<.Tn \"MANUAL DOMAIN\">"
13067 #: build/C/man7/mdoc.samples.7:133
13069 msgid "Addresses ."
13073 #: build/C/man7/mdoc.samples.7:134
13075 msgid "\"Author name\" ."
13079 #: build/C/man7/mdoc.samples.7:135
13081 msgid "Arguments ."
13085 #: build/C/man7/mdoc.samples.7:136
13087 msgid "\"Configuration Declarations (section four only)\" ."
13091 #: build/C/man7/mdoc.samples.7:137
13093 msgid "\"Command Modifier\" ."
13097 #: build/C/man7/mdoc.samples.7:138
13099 msgid "\"Defined Variables\" ."
13103 #: build/C/man7/mdoc.samples.7:139
13105 msgid "\"Errno's (Section two only)\" ."
13109 #: build/C/man7/mdoc.samples.7:140
13111 msgid "\"Environment Variables\" ."
13115 #: build/C/man7/mdoc.samples.7:141
13117 msgid "\"Function Argument\" ."
13121 #: build/C/man7/mdoc.samples.7:142
13123 msgid "\"Function Declaration\" ."
13127 #: build/C/man7/mdoc.samples.7:143
13133 #: build/C/man7/mdoc.samples.7:144
13135 msgid "\"Functions (library routines)\" ."
13139 #: build/C/man7/mdoc.samples.7:145
13141 msgid "\"Function Types\" ."
13144 #. .It "Header File (including source code)" .
13146 #: build/C/man7/mdoc.samples.7:147
13148 msgid "\"Interactive Commands\" ."
13152 #: build/C/man7/mdoc.samples.7:148
13158 #: build/C/man7/mdoc.samples.7:149
13164 #: build/C/man7/mdoc.samples.7:150
13166 msgid "Pathnames ."
13170 #: build/C/man7/mdoc.samples.7:151
13172 msgid "Variables ."
13176 #: build/C/man7/mdoc.samples.7:152
13178 msgid "\"Cross References\" ."
13181 #. type: Plain text
13182 #: build/C/man7/mdoc.samples.7:156
13183 msgid "E<.Tn \"GENERAL TEXT DOMAIN\">"
13187 #: build/C/man7/mdoc.samples.7:157
13189 msgid "\"AT&T Macro\" ."
13193 #: build/C/man7/mdoc.samples.7:158
13195 msgid "\"BSD Macro\" ."
13199 #: build/C/man7/mdoc.samples.7:159
13201 msgid "\"FreeBSD Macro\" ."
13205 #: build/C/man7/mdoc.samples.7:160
13207 msgid "\"UNIX Macro\" ."
13211 #: build/C/man7/mdoc.samples.7:161
13213 msgid "Enclosure/Quoting Macros"
13217 #: build/C/man7/mdoc.samples.7:163
13219 msgid "\"Angle Bracket Quote/Enclosure\" ."
13223 #: build/C/man7/mdoc.samples.7:164
13225 msgid "\"Bracket Quotes/Enclosure\" ."
13229 #: build/C/man7/mdoc.samples.7:165
13231 msgid "\"Double Quote macro/Enclosure\" ."
13235 #: build/C/man7/mdoc.samples.7:166
13237 msgid "\"Parenthesis Quote/Enclosure\" ."
13241 #: build/C/man7/mdoc.samples.7:167
13243 msgid "\"Single Quotes/Enclosure\" ."
13247 #: build/C/man7/mdoc.samples.7:168
13249 msgid "\"Prefix Macro\" ."
13253 #: build/C/man7/mdoc.samples.7:170
13255 msgid "\"No\\-Op or Normal Text Macro\" ."
13259 #: build/C/man7/mdoc.samples.7:171
13261 msgid "\"No Space Macro\" ."
13265 #: build/C/man7/mdoc.samples.7:172
13267 msgid "\"Section Cross References\" ."
13271 #: build/C/man7/mdoc.samples.7:173
13273 msgid "\"References and Citations\" ."
13277 #: build/C/man7/mdoc.samples.7:174
13279 msgid "Return Values (sections two and three only)"
13283 #: build/C/man7/mdoc.samples.7:175
13285 msgid "\"Trade Names (Acronyms and Type Names)\" ."
13289 #: build/C/man7/mdoc.samples.7:176
13291 msgid "\"Extended Arguments\" ."
13294 #. type: Plain text
13295 #: build/C/man7/mdoc.samples.7:180
13296 msgid "E<.Tn \"PAGE STRUCTURE DOMAIN\">"
13300 #: build/C/man7/mdoc.samples.7:181
13302 msgid "\"Section Headers\" ."
13306 #: build/C/man7/mdoc.samples.7:182
13308 msgid "\"Paragraphs and Line Spacing\" ."
13312 #: build/C/man7/mdoc.samples.7:183
13318 #: build/C/man7/mdoc.samples.7:184
13324 #: build/C/man7/mdoc.samples.7:185
13326 msgid "\"Font Modes (Emphasis, Literal, and Symbolic)\" ."
13330 #: build/C/man7/mdoc.samples.7:186
13332 msgid "\"Lists and Columns\" ."
13335 #. type: Plain text
13336 #: build/C/man7/mdoc.samples.7:190
13337 msgid "E<.Tn \"PREDEFINED STRINGS\">"
13340 #. type: Plain text
13341 #: build/C/man7/mdoc.samples.7:192
13342 msgid "E<.Tn \"DIAGNOSTICS\">"
13345 #. type: Plain text
13346 #: build/C/man7/mdoc.samples.7:194
13347 msgid "E<.Tn \"FORMATTING WITH GROFF, TROFF AND NROFF\">"
13350 #. type: Plain text
13351 #: build/C/man7/mdoc.samples.7:196
13352 msgid "E<.Tn \"BUGS\">"
13356 #: build/C/man7/mdoc.samples.7:198
13358 msgid "TROFF IDIOSYNCRASIES"
13361 #. type: Plain text
13362 #: build/C/man7/mdoc.samples.7:212
13364 "The E<.Nm \\-mdoc> package attempts to simplify the process of writing a man "
13365 "page. Theoretically, one should not have to learn the dirty details of "
13366 "E<.Xr troff 1> to use E<.Nm \\-mdoc>; however, there are a few limitations "
13367 "which are unavoidable and best gotten out of the way. And, too, be "
13368 "forewarned, this package is E<.Em not> fast."
13372 #: build/C/man7/mdoc.samples.7:212
13374 msgid "Macro Usage"
13377 #. type: Plain text
13378 #: build/C/man7/mdoc.samples.7:237
13380 "As in E<.Xr troff 1>, a macro is called by placing a E<.Ql \\&.> (dot "
13381 "character) at the beginning of a line followed by the two character name "
13382 "for the macro. Arguments may follow the macro separated by spaces. It is "
13383 "the dot character at the beginning of the line which causes E<.Xr troff 1> "
13384 "to interpret the next two characters as a macro name. To place a E<.Ql "
13385 "\\&.> (dot character) at the beginning of a line in some context other than "
13386 "a macro invocation, precede the E<.Ql \\&.> (dot) with the E<.Ql \\e&> "
13387 "escape sequence. The E<.Ql \\e&> translates literally to a zero width "
13388 "space, and is never displayed in the output."
13391 #. type: Plain text
13392 #: build/C/man7/mdoc.samples.7:252
13394 "In general, E<.Xr troff 1> macros accept up to nine arguments, any extra "
13395 "arguments are ignored. Most macros in E<.Nm \\-mdoc> accept nine arguments "
13396 "and, in limited cases, arguments may be continued or extended on the next "
13397 "line (See E<.Sx Extensions>). A few macros handle quoted arguments (see "
13398 "E<.Sx Passing Space Characters in an Argument> below)."
13401 #. type: Plain text
13402 #: build/C/man7/mdoc.samples.7:279
13404 "Most of the E<.Nm \\-mdoc> general text domain and manual domain macros are "
13405 "special in that their argument lists are E<.Em parsed> for callable macro "
13406 "names. This means an argument on the argument list which matches a general "
13407 "text or manual domain macro name and is determined to be callable will be "
13408 "executed or called when it is processed. In this case the argument, "
13409 "although the name of a macro, is not preceded by a E<.Ql \\&.> (dot). It is "
13410 "in this manner that many macros are nested; for example the option macro, "
13411 "E<.Ql \\&.Op>, may E<.Em call> the flag and argument macros, E<.Ql \\&Fl> "
13412 "and E<.Ql \\&Ar>, to specify an optional flag with an argument:"
13416 #: build/C/man7/mdoc.samples.7:280
13418 msgid "Op Fl s Ar bytes"
13421 #. type: Plain text
13422 #: build/C/man7/mdoc.samples.7:283
13423 msgid "is produced by E<.Li \\&.Op \\&Fl s \\&Ar bytes>"
13426 #. type: Plain text
13427 #: build/C/man7/mdoc.samples.7:290
13429 "To prevent a two character string from being interpreted as a macro name, "
13430 "precede the string with the escape sequence E<.Ql \\e&>:"
13434 #: build/C/man7/mdoc.samples.7:291
13436 msgid "Op \\&Fl s \\&Ar bytes"
13439 #. type: Plain text
13440 #: build/C/man7/mdoc.samples.7:294
13441 msgid "is produced by E<.Li \\&.Op \\e&Fl s \\e&Ar bytes>"
13444 #. type: Plain text
13445 #: build/C/man7/mdoc.samples.7:315
13447 "Here the strings E<.Ql \\&Fl> and E<.Ql \\&Ar> are not interpreted as "
13448 "macros. Macros whose argument lists are parsed for callable arguments are "
13449 "referred to as parsed and macros which may be called from an argument list "
13450 "are referred to as callable throughout this document and in the companion "
13451 "quick reference manual E<.Xr mdoc 7>. This is a technical E<.Em faux pas> "
13452 "as almost all of the macros in E<.Nm \\-mdoc> are parsed, but as it was "
13453 "cumbersome to constantly refer to macros as being callable and being able to "
13454 "call other macros, the term parsed has been used."
13458 #: build/C/man7/mdoc.samples.7:315
13460 msgid "Passing Space Characters in an Argument"
13463 #. type: Plain text
13464 #: build/C/man7/mdoc.samples.7:333
13466 "Sometimes it is desirable to give as one argument a string containing one or "
13467 "more blank space characters. This may be necessary to defeat the nine "
13468 "argument limit or to specify arguments to macros which expect particular "
13469 "arrangement of items in the argument list. For example, the function macro "
13470 "E<.Ql \\&.Fn> expects the first argument to be the name of a function and "
13471 "any remaining arguments to be function parameters. As E<.Tn \"ANSI C\"> "
13472 "stipulates the declaration of function parameters in the parenthesized "
13473 "parameter list, each parameter is guaranteed to be at minimum a two word "
13474 "string. For example, E<.Fa int foo>."
13477 #. type: Plain text
13478 #: build/C/man7/mdoc.samples.7:348
13480 "There are two possible ways to pass an argument which contains an embedded "
13481 "space. E<.Em Implementation note>: Unfortunately, the most convenient way "
13482 "of passing spaces in between quotes by reassigning individual arguments "
13483 "before parsing was fairly expensive speed wise and space wise to implement "
13484 "in all the macros for E<.Tn AT&T> E<.Xr troff>. It is not expensive for "
13485 "E<.Xr groff> but for the sake of portability, has been limited to the "
13486 "following macros which need it the most:"
13490 #: build/C/man7/mdoc.samples.7:350
13495 #. type: Plain text
13496 #: build/C/man7/mdoc.samples.7:353
13497 msgid "Configuration declaration (section 4 E<.Sx SYNOPSIS>)"
13501 #: build/C/man7/mdoc.samples.7:353
13506 #. type: Plain text
13507 #: build/C/man7/mdoc.samples.7:355
13508 msgid "Begin list (for the width specifier)."
13512 #: build/C/man7/mdoc.samples.7:355
13517 #. type: Plain text
13518 #: build/C/man7/mdoc.samples.7:357
13519 msgid "Emphasized text."
13523 #: build/C/man7/mdoc.samples.7:357
13528 #. type: Plain text
13529 #: build/C/man7/mdoc.samples.7:359
13530 msgid "Functions (sections two and four)."
13534 #: build/C/man7/mdoc.samples.7:359
13539 #. type: Plain text
13540 #: build/C/man7/mdoc.samples.7:361
13541 msgid "List items."
13545 #: build/C/man7/mdoc.samples.7:361
13550 #. type: Plain text
13551 #: build/C/man7/mdoc.samples.7:363
13552 msgid "Literal text."
13556 #: build/C/man7/mdoc.samples.7:363
13561 #. type: Plain text
13562 #: build/C/man7/mdoc.samples.7:365
13563 msgid "Symbolic text."
13567 #: build/C/man7/mdoc.samples.7:365
13572 #. type: Plain text
13573 #: build/C/man7/mdoc.samples.7:367
13574 msgid "Book titles."
13578 #: build/C/man7/mdoc.samples.7:367
13583 #. type: Plain text
13584 #: build/C/man7/mdoc.samples.7:369
13585 msgid "Journal names."
13589 #: build/C/man7/mdoc.samples.7:369
13594 #. type: Plain text
13595 #: build/C/man7/mdoc.samples.7:371
13596 msgid "Optional notes for a reference."
13600 #: build/C/man7/mdoc.samples.7:371
13605 #. type: Plain text
13606 #: build/C/man7/mdoc.samples.7:373
13607 msgid "Report title (in a reference)."
13611 #: build/C/man7/mdoc.samples.7:373
13616 #. type: Plain text
13617 #: build/C/man7/mdoc.samples.7:375
13618 msgid "Title of article in a book or journal."
13621 #. type: Plain text
13622 #: build/C/man7/mdoc.samples.7:392
13624 "One way of passing a string containing blank spaces is to use the hard or "
13625 "unpaddable space character E<.Ql \\e\\ >, that is, a blank space preceded by "
13626 "the escape character E<.Ql \\e>. This method may be used with any macro but "
13627 "has the side effect of interfering with the adjustment of text over the "
13628 "length of a line. E<.Xr Troff> sees the hard space as if it were any other "
13629 "printable character and cannot split the string into blank or newline "
13630 "separated pieces as one would expect. The method is useful for strings "
13631 "which are not expected to overlap a line boundary. For example:"
13635 #: build/C/man7/mdoc.samples.7:393
13637 msgid "Fn fetch char\\ *str"
13640 #. type: Plain text
13641 #: build/C/man7/mdoc.samples.7:396
13642 msgid "is created by E<.Ql \\&.Fn fetch char\\e *str>"
13646 #: build/C/man7/mdoc.samples.7:396
13648 msgid "Fn fetch \"char *str\""
13651 #. type: Plain text
13652 #: build/C/man7/mdoc.samples.7:399
13653 msgid "can also be created by E<.Ql \\&.Fn fetch \"\\*qchar *str\\*q\">"
13656 #. type: Plain text
13657 #: build/C/man7/mdoc.samples.7:408
13659 "If the E<.Ql \\e> or quotes were omitted, E<.Ql \\&.Fn> would see three "
13660 "arguments and the result would be:"
13664 #: build/C/man7/mdoc.samples.7:409
13666 msgid "Fn fetch char *str"
13669 #. type: Plain text
13670 #: build/C/man7/mdoc.samples.7:415
13672 "For an example of what happens when the parameter list overlaps a newline "
13673 "boundary, see the E<.Sx BUGS> section."
13677 #: build/C/man7/mdoc.samples.7:415
13679 msgid "Trailing Blank Space Characters"
13682 #. type: Plain text
13683 #: build/C/man7/mdoc.samples.7:428
13685 "E<.Xr Troff> can be confused by blank space characters at the end of a "
13686 "line. It is a wise preventive measure to globally remove all blank spaces "
13687 "from E<lt>blank-spaceE<gt>E<lt>end-of-lineE<gt> character sequences. Should "
13688 "the need arise to force a blank character at the end of a line, it may be "
13689 "forced with an unpaddable space and the E<.Ql \\e&> escape character. For "
13690 "example, E<.Ql string\\e\\ \\e&>."
13694 #: build/C/man7/mdoc.samples.7:428
13696 msgid "Escaping Special Characters"
13699 #. type: Plain text
13700 #: build/C/man7/mdoc.samples.7:440
13702 "Special characters like the newline character E<.Ql \\en>, are handled by "
13703 "replacing the E<.Ql \\e> with E<.Ql \\ee> (e.g. E<.Ql \\een>) to preserve "
13708 #: build/C/man7/mdoc.samples.7:440
13710 msgid "THE ANATOMY OF A MAN PAGE"
13713 #. type: Plain text
13714 #: build/C/man7/mdoc.samples.7:447
13716 "The body of a man page is easily constructed from a basic template found in "
13717 "the file E<.Pa /usr/share/misc/mdoc.template>. Several example man pages "
13718 "can also be found in E<.Pa /usr/share/examples/mdoc>."
13722 #: build/C/man7/mdoc.samples.7:448
13724 msgid "A manual page template"
13727 #. type: Plain text
13728 #: build/C/man7/mdoc.samples.7:479
13731 "\\&.\\e\" The following requests are required for all man pages.\n"
13732 "\\&.Dd Month day, year\n"
13733 "\\&.Os OPERATING_SYSTEM [version/release]\n"
13734 "\\&.Dt DOCUMENT_TITLE [section number] [volume]\n"
13737 "\\&.Nd one line description of name\n"
13738 "\\&.Sh SYNOPSIS\n"
13739 "\\&.Sh DESCRIPTION\n"
13740 "\\&.\\e\" The following requests should be uncommented and\n"
13741 "\\&.\\e\" used where appropriate. This next request is\n"
13742 "\\&.\\e\" for sections 2 and 3 function return values only.\n"
13743 "\\&.\\e\" .Sh RETURN VALUE\n"
13744 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
13745 "\\&.\\e\" .Sh ENVIRONMENT\n"
13746 "\\&.\\e\" .Sh FILES\n"
13747 "\\&.\\e\" .Sh EXAMPLES\n"
13748 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
13749 "\\&.\\e\" (command return values (to shell) and\n"
13750 "\\&.\\e\"\t fprintf/stderr type diagnostics)\n"
13751 "\\&.\\e\" .Sh DIAGNOSTICS\n"
13752 "\\&.\\e\" The next request is for sections 2 and 3 error\n"
13753 "\\&.\\e\" and signal handling only.\n"
13754 "\\&.\\e\" .Sh ERRORS\n"
13755 "\\&.\\e\" .Sh SEE ALSO\n"
13756 "\\&.\\e\" .Sh CONFORMING TO\n"
13757 "\\&.\\e\" .Sh HISTORY\n"
13758 "\\&.\\e\" .Sh AUTHORS\n"
13759 "\\&.\\e\" .Sh BUGS\n"
13762 #. type: Plain text
13763 #: build/C/man7/mdoc.samples.7:493
13765 "The first items in the template are the macros E<.Pq Li \\&.Dd , \\&.Os , "
13766 "\\&.Dt>; the document date, the operating system the man page or subject "
13767 "source is developed or modified for, and the man page title E<.Pq Em in "
13768 "upper case> along with the section of the manual the page belongs in. These "
13769 "macros identify the page, and are discussed below in E<.Sx TITLE MACROS>."
13772 #. type: Plain text
13773 #: build/C/man7/mdoc.samples.7:512
13775 "The remaining items in the template are section headers E<.Pq Li \\&.Sh>; of "
13776 "which E<.Sx NAME>, E<.Sx SYNOPSIS> and E<.Sx DESCRIPTION> are mandatory. "
13777 "The headers are discussed in E<.Sx PAGE STRUCTURE DOMAIN>, after "
13778 "presentation of E<.Sx MANUAL DOMAIN>. Several content macros are used to "
13779 "demonstrate page layout macros; reading about content macros before page "
13780 "layout macros is recommended."
13784 #: build/C/man7/mdoc.samples.7:512
13786 msgid "TITLE MACROS"
13789 #. type: Plain text
13790 #: build/C/man7/mdoc.samples.7:521
13792 "The title macros are the first portion of the page structure domain, but are "
13793 "presented first and separate for someone who wishes to start writing a man "
13794 "page yesterday. Three header macros designate the document title or manual "
13795 "page title, the operating system, and the date of authorship. These macros "
13796 "are one called once at the very beginning of the document and are used to "
13797 "construct the headers and footers only."
13801 #: build/C/man7/mdoc.samples.7:522
13803 msgid "Li \\&.Dt DOCUMENT_TITLE section# [volume]"
13807 #. USD UNIX User's Supplementary Documents
13809 #. PS1 UNIX Programmer's Supplementary Documents
13810 #. type: Plain text
13811 #: build/C/man7/mdoc.samples.7:536
13813 "The document title is the subject of the man page and must be in E<.Tn "
13814 "CAPITALS> due to troff limitations. The section number may be 1,\\ ...,\\ "
13815 "8, and if it is specified, the volume title may be omitted. A volume title "
13816 "may be arbitrary or one of the following:"
13820 #: build/C/man7/mdoc.samples.7:538
13822 msgid "Li \"AMD\tUNIX\" Ancestral Manual Documents"
13826 #: build/C/man7/mdoc.samples.7:539
13828 msgid "Li \"SMM\tUNIX\" System Manager's Manual"
13832 #: build/C/man7/mdoc.samples.7:540
13834 msgid "Li \"URM\tUNIX\" Reference Manual"
13838 #: build/C/man7/mdoc.samples.7:541
13840 msgid "Li \"PRM\tUNIX\" Programmer's Manual"
13844 #. MMI UNIX Manual Master Index
13846 #. CON UNIX Contributed Software Manual
13848 #. LOC UNIX Local Manual
13849 #. type: Plain text
13850 #: build/C/man7/mdoc.samples.7:557
13852 "The default volume labeling is E<.Li URM> for sections 1, 6, and 7; E<.Li "
13853 "SMM> for section 8; E<.Li PRM> for sections 2, 3, 4, and 5."
13857 #: build/C/man7/mdoc.samples.7:557
13859 msgid "Li \\&.Os operating_system release#"
13862 #. type: Plain text
13863 #: build/C/man7/mdoc.samples.7:570
13865 "The name of the operating system should be the common acronym, for example, "
13866 "E<.Tn BSD> or E<.Tn FreeBSD> or E<.Tn ATT>. The release should be the "
13867 "standard release nomenclature for the system specified, for example, 4.3, "
13868 "4.3+Tahoe, V.3, V.4. Unrecognized arguments are displayed as given in the "
13869 "page footer. For instance, a typical footer might be:"
13873 #: build/C/man7/mdoc.samples.7:571
13875 msgid "\\&.Os 4.3BSD"
13878 #. type: Plain text
13879 #: build/C/man7/mdoc.samples.7:574
13884 #: build/C/man7/mdoc.samples.7:574
13886 msgid "\\&.Os FreeBSD 2.2"
13889 #. type: Plain text
13890 #: build/C/man7/mdoc.samples.7:577
13891 msgid "or for a locally produced set"
13895 #: build/C/man7/mdoc.samples.7:578
13897 msgid "\\&.Os CS Department"
13900 #. type: Plain text
13901 #: build/C/man7/mdoc.samples.7:593
13903 "The Berkeley default, E<.Ql \\&.Os> without an argument, has been defined as "
13904 "E<.Tn BSD> in the site-specific file E<.Pa "
13905 "/usr/share/tmac/mdoc/doc-common>. It really should default to E<.Tn "
13906 "LOCAL>. Note, if the E<.Ql \\&.Os> macro is not present, the bottom left "
13907 "corner of the page will be ugly."
13911 #: build/C/man7/mdoc.samples.7:593
13913 msgid "Li \\&.Dd month day, year"
13916 #. type: Plain text
13917 #: build/C/man7/mdoc.samples.7:595
13918 msgid "The date should be written formally:"
13922 #: build/C/man7/mdoc.samples.7:597
13924 msgid "January 25, 1989"
13928 #: build/C/man7/mdoc.samples.7:599
13930 msgid "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
13934 #: build/C/man7/mdoc.samples.7:600
13936 msgid "What's in a name..."
13939 #. type: Plain text
13940 #: build/C/man7/mdoc.samples.7:617
13942 "The manual domain macro names are derived from the day to day informal "
13943 "language used to describe commands, subroutines and related files. Slightly "
13944 "different variations of this language are used to describe the three "
13945 "different aspects of writing a man page. First, there is the description of "
13946 "E<.Nm \\-mdoc> macro request usage. Second is the description of a E<.Ux> "
13947 "command E<.Em with> E<.Nm \\-mdoc> macros and third, the description of a "
13948 "command to a user in the verbal sense; that is, discussion of a command in "
13949 "the text of a man page."
13952 #. type: Plain text
13953 #: build/C/man7/mdoc.samples.7:622
13955 "In the first case, E<.Xr troff 1> macros are themselves a type of command; "
13956 "the general syntax for a troff command is:"
13959 #. type: Plain text
13960 #: build/C/man7/mdoc.samples.7:624
13962 msgid "\\&.Va argument1 argument2 ... argument9\n"
13965 #. type: Plain text
13966 #: build/C/man7/mdoc.samples.7:638
13968 "The E<.Ql \\&.Va> is a macro command or request, and anything following it "
13969 "is an argument to be processed. In the second case, the description of a "
13970 "E<.Ux> command using the content macros is a bit more involved; a typical "
13971 "E<.Sx SYNOPSIS> command line might be displayed as:"
13974 #. type: Plain text
13975 #: build/C/man7/mdoc.samples.7:642
13980 "E<.Ar infile outfile>\n"
13983 #. type: Plain text
13984 #: build/C/man7/mdoc.samples.7:662
13986 "Here, E<.Nm filter> is the command name and the bracketed string E<.Fl flag> "
13987 "is a E<.Em flag> argument designated as optional by the option brackets. In "
13988 "E<.Nm \\-mdoc> terms, E<.Ar infile> and E<.Ar outfile> are called E<.Em "
13989 "arguments>. The macros which formatted the above example:"
13992 #. type: Plain text
13993 #: build/C/man7/mdoc.samples.7:666
13997 "\\&.Op \\&Fl flag\n"
13998 "\\&.Ar infile outfile\n"
14001 #. type: Plain text
14002 #: build/C/man7/mdoc.samples.7:680
14004 "In the third case, discussion of commands and command syntax includes both "
14005 "examples above, but may add more detail. The arguments E<.Ar infile> and "
14006 "E<.Ar outfile> from the example above might be referred to as E<.Em "
14007 "operands> or E<.Em file arguments>. Some command-line argument lists are "
14012 #: build/C/man7/mdoc.samples.7:681
14017 #. type: Plain text
14018 #: build/C/man7/mdoc.samples.7:694
14020 "E<.Op Fl eiknqrstv> E<.Op Fl D Ar variable> E<.Op Fl d Ar flags> E<.Op Fl f "
14021 "Ar makefile> E<.Bk -words> E<.Op Fl I Ar directory> E<.Ek> E<.Op Fl j Ar "
14022 "max_jobs> E<.Op Ar variable=value> E<.Bk -words> E<.Op Ar target ...> E<.Ek>"
14025 #. type: Plain text
14026 #: build/C/man7/mdoc.samples.7:720
14028 "Here one might talk about the command E<.Nm make> and qualify the argument "
14029 "E<.Ar makefile>, as an argument to the flag, E<.Fl f>, or discuss the "
14030 "optional file operand E<.Ar target>. In the verbal context, such detail can "
14031 "prevent confusion, however the E<.Nm \\-mdoc> package does not have a macro "
14032 "for an argument E<.Em to> a flag. Instead the E<.Ql \\&Ar> argument macro "
14033 "is used for an operand or file argument like E<.Ar target> as well as an "
14034 "argument to a flag like E<.Ar variable>. The make command line was produced "
14038 #. type: Plain text
14039 #: build/C/man7/mdoc.samples.7:732
14043 "\\&.Op Fl eiknqrstv\n"
14044 "\\&.Op Fl D Ar variable\n"
14045 "\\&.Op Fl d Ar flags\n"
14046 "\\&.Op Fl f Ar makefile\n"
14047 "\\&.Op Fl I Ar directory\n"
14048 "\\&.Op Fl j Ar max_jobs\n"
14049 "\\&.Op Ar variable=value\n"
14051 "\\&.Op Ar target ...\n"
14055 #. type: Plain text
14056 #: build/C/man7/mdoc.samples.7:740
14057 msgid "The E<.Ql \\&.Bk> and E<.Ql \\&.Ek> macros are explained in E<.Sx Keeps>."
14061 #: build/C/man7/mdoc.samples.7:740
14063 msgid "General Syntax"
14066 #. type: Plain text
14067 #: build/C/man7/mdoc.samples.7:763
14069 "The manual domain and general text domain macros share a similar syntax with "
14070 "a few minor deviations: E<.Ql \\&.Ar>, E<.Ql \\&.Fl>, E<.Ql \\&.Nm>, and "
14071 "E<.Ql \\&.Pa> differ only when called without arguments; E<.Ql \\&.Fn> and "
14072 "E<.Ql \\&.Xr> impose an order on their argument lists and the E<.Ql \\&.Op> "
14073 "and E<.Ql \\&.Fn> macros have nesting limitations. All content macros are "
14074 "capable of recognizing and properly handling punctuation, provided each "
14075 "punctuation character is separated by a leading space. If a request is "
14080 #: build/C/man7/mdoc.samples.7:764
14082 msgid "\\&.Li sptr, ptr),"
14085 #. type: Plain text
14086 #: build/C/man7/mdoc.samples.7:767 build/C/man7/mdoc.samples.7:777
14087 msgid "The result is:"
14091 #: build/C/man7/mdoc.samples.7:768
14093 msgid "Li sptr, ptr),"
14096 #. type: Plain text
14097 #: build/C/man7/mdoc.samples.7:773
14099 "The punctuation is not recognized and all is output in the literal font. If "
14100 "the punctuation is separated by a leading white space:"
14104 #: build/C/man7/mdoc.samples.7:774
14106 msgid "\\&.Li \"sptr , ptr ) ,\""
14110 #: build/C/man7/mdoc.samples.7:778
14112 msgid "Li sptr , ptr ) ,"
14115 #. type: Plain text
14116 #: build/C/man7/mdoc.samples.7:782
14118 "The punctuation is now recognized and is output in the default font "
14119 "distinguishing it from the strings in literal font."
14122 #. type: Plain text
14123 #: build/C/man7/mdoc.samples.7:791
14125 "To remove the special meaning from a punctuation character escape it with "
14126 "E<.Ql \\e&>. E<.Xr Troff> is limited as a macro language, and has "
14127 "difficulty when presented with a string containing a member of the "
14128 "mathematical, logical or quotation set:"
14131 #. type: Plain text
14132 #: build/C/man7/mdoc.samples.7:793
14134 msgid "\\&{+,\\-,/,*,\\&%,E<lt>,E<gt>,E<lt>=,E<gt>=,=,==,&,`,',\"}\n"
14137 #. type: Plain text
14138 #: build/C/man7/mdoc.samples.7:805
14140 "The problem is that E<.Xr troff> may assume it is supposed to actually "
14141 "perform the operation or evaluation suggested by the characters. To prevent "
14142 "the accidental evaluation of these characters, escape them with E<.Ql "
14143 "\\e&>. Typical syntax is shown in the first content macro displayed below, "
14148 #: build/C/man7/mdoc.samples.7:805
14150 msgid "MANUAL DOMAIN"
14154 #: build/C/man7/mdoc.samples.7:806
14156 msgid "Address Macro"
14159 #. type: Plain text
14160 #: build/C/man7/mdoc.samples.7:809
14162 "The address macro identifies an address construct of the form "
14163 "addr1[,addr2[,addr3]]."
14167 #: build/C/man7/mdoc.samples.7:810
14169 msgid "Usage: .Ad address ... \\*(Pu"
14173 #: build/C/man7/mdoc.samples.7:812
14175 msgid "Li \\&.Ad addr1"
14178 #. type: Plain text
14179 #: build/C/man7/mdoc.samples.7:814
14180 msgid "E<.Ad addr1>"
14184 #: build/C/man7/mdoc.samples.7:814
14186 msgid "Li \\&.Ad addr1\\ ."
14189 #. type: Plain text
14190 #: build/C/man7/mdoc.samples.7:816
14191 msgid "E<.Ad addr1>."
14195 #: build/C/man7/mdoc.samples.7:816
14197 msgid "Li \\&.Ad addr1\\ , file2"
14200 #. type: Plain text
14201 #: build/C/man7/mdoc.samples.7:818
14202 msgid "E<.Ad addr1 , file2>"
14206 #: build/C/man7/mdoc.samples.7:818
14208 msgid "Li \\&.Ad f1\\ , f2\\ , f3\\ :"
14211 #. type: Plain text
14212 #: build/C/man7/mdoc.samples.7:820
14213 msgid "E<.Ad f1 , f2 , f3>:"
14217 #: build/C/man7/mdoc.samples.7:820
14219 msgid "Li \\&.Ad addr\\ )\\ )\\ ,"
14222 #. type: Plain text
14223 #: build/C/man7/mdoc.samples.7:822
14224 msgid "E<.Ad addr>)),"
14227 #. type: Plain text
14228 #: build/C/man7/mdoc.samples.7:829
14230 "It is an error to call E<.Ql \\&.Ad> without arguments. E<.Ql \\&.Ad> is "
14231 "callable by other macros and is parsed."
14235 #: build/C/man7/mdoc.samples.7:829
14237 msgid "Author Name"
14240 #. type: Plain text
14241 #: build/C/man7/mdoc.samples.7:836
14243 "The E<.Ql \\&.An> macro is used to specify the name of the author of the "
14244 "item being documented, or the name of the author of the actual manual page. "
14245 "Any remaining arguments after the name information are assumed to be "
14250 #: build/C/man7/mdoc.samples.7:837
14252 msgid "Usage: .An author_name \\*(Pu"
14256 #: build/C/man7/mdoc.samples.7:839
14258 msgid "Li \\&.An Joe\\ Author"
14261 #. type: Plain text
14262 #: build/C/man7/mdoc.samples.7:841
14263 msgid "E<.An Joe Author>"
14267 #: build/C/man7/mdoc.samples.7:841
14269 msgid "Li \\&.An Joe\\ Author\\ ,"
14272 #. type: Plain text
14273 #: build/C/man7/mdoc.samples.7:843
14274 msgid "E<.An Joe\\ Author>,"
14278 #: build/C/man7/mdoc.samples.7:843
14280 msgid "Li \\&.An Joe\\ Author\\ \\&Aq\\ nobody@FreeBSD.ORG"
14283 #. type: Plain text
14284 #: build/C/man7/mdoc.samples.7:845
14285 msgid "E<.An Joe Author Aq nobody@FreeBSD.ORG>"
14289 #: build/C/man7/mdoc.samples.7:845
14291 msgid "Li \\&.An Joe\\ Author\\ )\\ )\\ ,"
14294 #. type: Plain text
14295 #: build/C/man7/mdoc.samples.7:847
14296 msgid "E<.An Joe Author>)),"
14299 #. type: Plain text
14300 #: build/C/man7/mdoc.samples.7:856
14302 "The E<.Ql \\&.An> macro is parsed and is callable. It is an error to call "
14303 "E<.Ql \\&.An> without any arguments."
14307 #: build/C/man7/mdoc.samples.7:856
14309 msgid "Argument Macro"
14312 #. type: Plain text
14313 #: build/C/man7/mdoc.samples.7:861
14315 "The E<.Ql \\&.Ar> argument macro may be used whenever a command-line "
14316 "argument is referenced."
14320 #: build/C/man7/mdoc.samples.7:862
14322 msgid "Usage: .Ar argument ... \\*(Pu"
14326 #: build/C/man7/mdoc.samples.7:864
14331 #. type: Plain text
14332 #: build/C/man7/mdoc.samples.7:866
14337 #: build/C/man7/mdoc.samples.7:866
14339 msgid "Li \\&.Ar file1"
14342 #. type: Plain text
14343 #: build/C/man7/mdoc.samples.7:868
14344 msgid "E<.Ar file1>"
14348 #: build/C/man7/mdoc.samples.7:868
14350 msgid "Li \\&.Ar file1\\ ."
14353 #. type: Plain text
14354 #: build/C/man7/mdoc.samples.7:870
14355 msgid "E<.Ar file1>."
14359 #: build/C/man7/mdoc.samples.7:870
14361 msgid "Li \\&.Ar file1 file2"
14364 #. type: Plain text
14365 #: build/C/man7/mdoc.samples.7:872
14366 msgid "E<.Ar file1 file2>"
14370 #: build/C/man7/mdoc.samples.7:872
14372 msgid "Li \\&.Ar f1 f2 f3\\ :"
14375 #. type: Plain text
14376 #: build/C/man7/mdoc.samples.7:874
14377 msgid "E<.Ar f1 f2 f3>:"
14381 #: build/C/man7/mdoc.samples.7:874
14383 msgid "Li \\&.Ar file\\ )\\ )\\ ,"
14386 #. type: Plain text
14387 #: build/C/man7/mdoc.samples.7:876
14388 msgid "E<.Ar file>)),"
14391 #. type: Plain text
14392 #: build/C/man7/mdoc.samples.7:886
14394 "If E<.Ql \\&.Ar> is called without arguments E<.Ql Ar> is assumed. The "
14395 "E<.Ql \\&.Ar> macro is parsed and is callable."
14399 #: build/C/man7/mdoc.samples.7:886
14401 msgid "Configuration Declaration (section four only)"
14404 #. type: Plain text
14405 #: build/C/man7/mdoc.samples.7:893
14407 "The E<.Ql \\&.Cd> macro is used to demonstrate a E<.Xr config 8> declaration "
14408 "for a device interface in a section four manual. This macro accepts quoted "
14409 "arguments (double quotes only)."
14413 #: build/C/man7/mdoc.samples.7:895
14415 msgid "Cd \"device le0 at scode?\""
14418 #. type: Plain text
14419 #: build/C/man7/mdoc.samples.7:898
14420 msgid "produced by: E<.Ql \".Cd device le0 at scode?\">."
14424 #: build/C/man7/mdoc.samples.7:899
14426 msgid "Command Modifier"
14429 #. type: Plain text
14430 #: build/C/man7/mdoc.samples.7:913
14432 "The command modifier is identical to the E<.Ql \\&.Fl> (flag) command with "
14433 "the exception the E<.Ql \\&.Cm> macro does not assert a dash in front of "
14434 "every argument. Traditionally flags are marked by the preceding dash, some "
14435 "commands or subsets of commands do not use them. Command modifiers may also "
14436 "be specified in conjunction with interactive commands such as editor "
14437 "commands. See E<.Sx Flags>."
14441 #: build/C/man7/mdoc.samples.7:913
14443 msgid "Defined Variables"
14446 #. type: Plain text
14447 #: build/C/man7/mdoc.samples.7:917
14449 "A variable which is defined in an include file is specified by the macro "
14454 #: build/C/man7/mdoc.samples.7:918
14456 msgid "Usage: .Dv defined_variable ... \\*(Pu"
14460 #: build/C/man7/mdoc.samples.7:920
14462 msgid "Li \".Dv MAXHOSTNAMELEN\""
14465 #. type: Plain text
14466 #: build/C/man7/mdoc.samples.7:922
14467 msgid "E<.Dv MAXHOSTNAMELEN>"
14471 #: build/C/man7/mdoc.samples.7:922
14473 msgid "Li \".Dv TIOCGPGRP )\""
14476 #. type: Plain text
14477 #: build/C/man7/mdoc.samples.7:924
14478 msgid "E<.Dv TIOCGPGRP>)"
14481 #. type: Plain text
14482 #: build/C/man7/mdoc.samples.7:931
14484 "It is an error to call E<.Ql \\&.Dv> without arguments. E<.Ql \\&.Dv> is "
14485 "parsed and is callable."
14489 #: build/C/man7/mdoc.samples.7:931
14491 msgid "Errno's (Section two only)"
14494 #. type: Plain text
14495 #: build/C/man7/mdoc.samples.7:943
14497 "The E<.Ql \\&.Er> errno macro specifies the error return value for section "
14498 "two library routines. The second example below shows E<.Ql \\&.Er> used "
14499 "with the E<.Ql \\&.Bq> general text domain macro, as it would be used in a "
14500 "section two manual page."
14504 #: build/C/man7/mdoc.samples.7:944
14506 msgid "Usage: .Er ERRNOTYPE ... \\*(Pu"
14510 #: build/C/man7/mdoc.samples.7:946
14512 msgid "Li \\&.Er ENOENT"
14515 #. type: Plain text
14516 #: build/C/man7/mdoc.samples.7:948
14517 msgid "E<.Er ENOENT>"
14521 #: build/C/man7/mdoc.samples.7:948
14523 msgid "Li \\&.Er ENOENT\\ )\\ ;"
14526 #. type: Plain text
14527 #: build/C/man7/mdoc.samples.7:950
14528 msgid "E<.Er ENOENT>);"
14532 #: build/C/man7/mdoc.samples.7:950
14534 msgid "Li \\&.Bq \\&Er ENOTDIR"
14537 #. type: Plain text
14538 #: build/C/man7/mdoc.samples.7:952
14539 msgid "E<.Bq Er ENOTDIR>"
14542 #. type: Plain text
14543 #: build/C/man7/mdoc.samples.7:960
14545 "It is an error to call E<.Ql \\&.Er> without arguments. The E<.Ql \\&.Er> "
14546 "macro is parsed and is callable."
14550 #: build/C/man7/mdoc.samples.7:960
14552 msgid "Environment Variables"
14555 #. type: Plain text
14556 #: build/C/man7/mdoc.samples.7:964
14557 msgid "The E<.Ql \\&.Ev> macro specifies an environment variable."
14561 #: build/C/man7/mdoc.samples.7:965
14563 msgid "Usage: .Ev argument ... \\*(Pu"
14567 #: build/C/man7/mdoc.samples.7:967
14569 msgid "Li \\&.Ev DISPLAY"
14572 #. type: Plain text
14573 #: build/C/man7/mdoc.samples.7:969
14574 msgid "E<.Ev DISPLAY>"
14578 #: build/C/man7/mdoc.samples.7:969
14580 msgid "Li \\&.Ev PATH\\ ."
14583 #. type: Plain text
14584 #: build/C/man7/mdoc.samples.7:971
14585 msgid "E<.Ev PATH>."
14589 #: build/C/man7/mdoc.samples.7:971
14591 msgid "Li \\&.Ev PRINTER\\ )\\ )\\ ,"
14594 #. type: Plain text
14595 #: build/C/man7/mdoc.samples.7:973
14596 msgid "E<.Ev PRINTER>)),"
14599 #. type: Plain text
14600 #: build/C/man7/mdoc.samples.7:981
14602 "It is an error to call E<.Ql \\&.Ev> without arguments. The E<.Ql \\&.Ev> "
14603 "macro is parsed and is callable."
14607 #: build/C/man7/mdoc.samples.7:981
14609 msgid "Function Argument"
14612 #. type: Plain text
14613 #: build/C/man7/mdoc.samples.7:1000
14615 "The E<.Ql \\&.Fa> macro is used to refer to function arguments (parameters) "
14616 "outside of the E<.Sx SYNOPSIS> section of the manual or inside the E<.Sx "
14617 "SYNOPSIS> section should a parameter list be too long for the E<.Ql \\&.Fn> "
14618 "macro and the enclosure macros E<.Ql \\&.Fo> and E<.Ql \\&.Fc> must be "
14619 "used. E<.Ql \\&.Fa> may also be used to refer to structure members."
14623 #: build/C/man7/mdoc.samples.7:1001
14625 msgid "Usage: .Fa function_argument ... \\*(Pu"
14629 #: build/C/man7/mdoc.samples.7:1003
14631 msgid "Li \\&.Fa d_namlen\\ )\\ )\\ ,"
14634 #. type: Plain text
14635 #: build/C/man7/mdoc.samples.7:1005
14636 msgid "E<.Fa d_namlen>)),"
14640 #: build/C/man7/mdoc.samples.7:1005
14642 msgid "Li \\&.Fa iov_len"
14645 #. type: Plain text
14646 #: build/C/man7/mdoc.samples.7:1007
14647 msgid "E<.Fa iov_len>"
14650 #. type: Plain text
14651 #: build/C/man7/mdoc.samples.7:1014
14653 "It is an error to call E<.Ql \\&.Fa> without arguments. E<.Ql \\&.Fa> is "
14654 "parsed and is callable."
14658 #: build/C/man7/mdoc.samples.7:1014
14660 msgid "Function Declaration"
14663 #. type: Plain text
14664 #: build/C/man7/mdoc.samples.7:1025
14666 "The E<.Ql \\&.Fd> macro is used in the E<.Sx SYNOPSIS> section with section "
14667 "two or three functions. The E<.Ql \\&.Fd> macro does not call other macros "
14668 "and is not callable by other macros."
14672 #: build/C/man7/mdoc.samples.7:1026
14674 msgid "Usage: .Fd include_file (or defined variable)"
14677 #. type: Plain text
14678 #: build/C/man7/mdoc.samples.7:1037
14680 "In the E<.Sx SYNOPSIS> section a E<.Ql \\&.Fd> request causes a line break "
14681 "if a function has already been presented and a break has not occurred. This "
14682 "leaves a nice vertical space in between the previous function call and the "
14683 "declaration for the next function."
14687 #: build/C/man7/mdoc.samples.7:1037
14692 #. type: Plain text
14693 #: build/C/man7/mdoc.samples.7:1050
14695 "The E<.Ql \\&.Fl> macro handles command-line flags. It prepends a dash, "
14696 "E<.Ql \\->, to the flag. For interactive command flags, which are not "
14697 "prepended with a dash, the E<.Ql \\&.Cm> (command modifier) macro is "
14698 "identical, but without the dash."
14702 #: build/C/man7/mdoc.samples.7:1051
14704 msgid "Usage: .Fl argument ... \\*(Pu"
14708 #: build/C/man7/mdoc.samples.7:1053
14713 #. type: Plain text
14714 #: build/C/man7/mdoc.samples.7:1055
14719 #: build/C/man7/mdoc.samples.7:1055
14721 msgid "Li \\&.Fl cfv"
14724 #. type: Plain text
14725 #: build/C/man7/mdoc.samples.7:1057
14730 #: build/C/man7/mdoc.samples.7:1057
14732 msgid "Li \\&.Fl cfv\\ ."
14735 #. type: Plain text
14736 #: build/C/man7/mdoc.samples.7:1059
14737 msgid "E<.Fl cfv>."
14741 #: build/C/man7/mdoc.samples.7:1059
14743 msgid "Li \\&.Fl s v t"
14746 #. type: Plain text
14747 #: build/C/man7/mdoc.samples.7:1061
14748 msgid "E<.Fl s v t>"
14752 #: build/C/man7/mdoc.samples.7:1061
14754 msgid "Li \\&.Fl -\\ ,"
14757 #. type: Plain text
14758 #: build/C/man7/mdoc.samples.7:1063
14763 #: build/C/man7/mdoc.samples.7:1063
14765 msgid "Li \\&.Fl xyz\\ )\\ ,"
14768 #. type: Plain text
14769 #: build/C/man7/mdoc.samples.7:1065
14770 msgid "E<.Fl xyz>),"
14773 #. type: Plain text
14774 #: build/C/man7/mdoc.samples.7:1077
14776 "The E<.Ql \\&.Fl> macro without any arguments results in a dash representing "
14777 "I<stdin>/I<stdout>. Note that giving E<.Ql \\&.Fl> a single dash, will "
14778 "result in two dashes. The E<.Ql \\&.Fl> macro is parsed and is callable."
14782 #: build/C/man7/mdoc.samples.7:1077
14784 msgid "Functions (library routines)"
14787 #. type: Plain text
14788 #: build/C/man7/mdoc.samples.7:1079
14789 msgid "The .Fn macro is modeled on ANSI C conventions."
14792 #. type: Plain text
14793 #: build/C/man7/mdoc.samples.7:1081
14795 msgid "Usage: .Fn [type] function [[type] parameters ... \\*(Pu]\n"
14799 #: build/C/man7/mdoc.samples.7:1083
14801 msgid "Li \"\\&.Fn getchar\""
14804 #. type: Plain text
14805 #: build/C/man7/mdoc.samples.7:1085
14806 msgid "E<.Fn getchar>"
14810 #: build/C/man7/mdoc.samples.7:1085
14812 msgid "Li \"\\&.Fn strlen ) ,\""
14815 #. type: Plain text
14816 #: build/C/man7/mdoc.samples.7:1087
14817 msgid "E<.Fn strlen>),"
14821 #: build/C/man7/mdoc.samples.7:1087
14823 msgid "Li \\&.Fn \"\\*qint align\\*q\" \"\\*qconst * char *sptrs\\*q\" ,"
14826 #. type: Plain text
14827 #: build/C/man7/mdoc.samples.7:1089
14828 msgid "E<.Fn \"int align\" \"const * char *sptrs\">,"
14831 #. type: Plain text
14832 #: build/C/man7/mdoc.samples.7:1102
14834 "It is an error to call E<.Ql \\&.Fn> without any arguments. The E<.Ql "
14835 "\\&.Fn> macro is parsed and is callable, note that any call to another macro "
14836 "signals the end of the E<.Ql \\&.Fn> call (it will close-parenthesis at that "
14840 #. type: Plain text
14841 #: build/C/man7/mdoc.samples.7:1116
14843 "For functions that have more than eight parameters (and this is rare), the "
14844 "macros E<.Ql \\&.Fo> (function open) and E<.Ql \\&.Fc> (function close) "
14845 "may be used with E<.Ql \\&.Fa> (function argument) to get around the "
14846 "limitation. For example:"
14849 #. type: Plain text
14850 #: build/C/man7/mdoc.samples.7:1128
14853 "\\&.Fo \"int res_mkquery\"\n"
14854 "\\&.Fa \"int op\"\n"
14855 "\\&.Fa \"char *dname\"\n"
14856 "\\&.Fa \"int class\"\n"
14857 "\\&.Fa \"int type\"\n"
14858 "\\&.Fa \"char *data\"\n"
14859 "\\&.Fa \"int datalen\"\n"
14860 "\\&.Fa \"struct rrec *newrr\"\n"
14861 "\\&.Fa \"char *buf\"\n"
14862 "\\&.Fa \"int buflen\"\n"
14866 #. type: Plain text
14867 #: build/C/man7/mdoc.samples.7:1131 build/C/man7/mdoc.samples.7:2470
14871 #. type: Plain text
14872 #: build/C/man7/mdoc.samples.7:1143
14875 "E<.Fo \"int res_mkquery\">\n"
14876 "E<.Fa \"int op\">\n"
14877 "E<.Fa \"char *dname\">\n"
14878 "E<.Fa \"int class\">\n"
14879 "E<.Fa \"int type\">\n"
14880 "E<.Fa \"char *data\">\n"
14881 "E<.Fa \"int datalen\">\n"
14882 "E<.Fa \"struct rrec *newrr\">\n"
14883 "E<.Fa \"char *buf\">\n"
14884 "E<.Fa \"int buflen\">\n"
14888 #. type: Plain text
14889 #: build/C/man7/mdoc.samples.7:1166
14891 "The E<.Ql \\&.Fo> and E<.Ql \\&.Fc> macros are parsed and are callable. In "
14892 "the E<.Sx SYNOPSIS> section, the function will always begin at the beginning "
14893 "of line. If there is more than one function presented in the E<.Sx "
14894 "SYNOPSIS> section and a function type has not been given, a line break will "
14895 "occur, leaving a nice vertical space between the current function name and "
14896 "the one prior. At the moment, E<.Ql \\&.Fn> does not check its word "
14897 "boundaries against troff line lengths and may split across a newline "
14898 "ungracefully. This will be fixed in the near future."
14902 #: build/C/man7/mdoc.samples.7:1166
14904 msgid "Function Type"
14907 #. type: Plain text
14908 #: build/C/man7/mdoc.samples.7:1177
14910 "This macro is intended for the E<.Sx SYNOPSIS> section. It may be used "
14911 "anywhere else in the man page without problems, but its main purpose is to "
14912 "present the function type in kernel normal form for the E<.Sx SYNOPSIS> of "
14913 "sections two and three (it causes a line break allowing the function name to "
14914 "appear on the next line)."
14918 #: build/C/man7/mdoc.samples.7:1178
14920 msgid "Usage: .Ft type ... \\*(Pu"
14924 #: build/C/man7/mdoc.samples.7:1180
14926 msgid "Li \\&.Ft struct stat"
14929 #. type: Plain text
14930 #: build/C/man7/mdoc.samples.7:1182
14931 msgid "E<.Ft struct stat>"
14934 #. type: Plain text
14935 #: build/C/man7/mdoc.samples.7:1187
14936 msgid "The E<.Ql \\&.Ft> request is not callable by other macros."
14940 #: build/C/man7/mdoc.samples.7:1187
14942 msgid "Interactive Commands"
14945 #. type: Plain text
14946 #: build/C/man7/mdoc.samples.7:1191
14947 msgid "The E<.Ql \\&.Ic> macro designates an interactive or internal command."
14951 #: build/C/man7/mdoc.samples.7:1192
14953 msgid "Usage: .Ic argument ... \\*(Pu"
14957 #: build/C/man7/mdoc.samples.7:1194
14959 msgid "Li \\&.Ic :wq"
14962 #. type: Plain text
14963 #: build/C/man7/mdoc.samples.7:1196
14968 #: build/C/man7/mdoc.samples.7:1196
14970 msgid "Li \\&.Ic do while {...}"
14973 #. type: Plain text
14974 #: build/C/man7/mdoc.samples.7:1198
14975 msgid "E<.Ic do while {...}>"
14979 #: build/C/man7/mdoc.samples.7:1198
14981 msgid "Li \\&.Ic setenv\\ , unsetenv"
14984 #. type: Plain text
14985 #: build/C/man7/mdoc.samples.7:1200
14986 msgid "E<.Ic setenv , unsetenv>"
14989 #. type: Plain text
14990 #: build/C/man7/mdoc.samples.7:1208
14992 "It is an error to call E<.Ql \\&.Ic> without arguments. The E<.Ql \\&.Ic> "
14993 "macro is parsed and is callable."
14997 #: build/C/man7/mdoc.samples.7:1208
15002 #. type: Plain text
15003 #: build/C/man7/mdoc.samples.7:1244
15005 "The E<.Ql \\&.Nm> macro is used for the document title or subject name. It "
15006 "has the peculiarity of remembering the first argument it was called with, "
15007 "which should always be the subject name of the page. When called without "
15008 "arguments, E<.Ql \\&.Nm> regurgitates this initial name for the sole purpose "
15009 "of making less work for the author. Note: a section two or three document "
15010 "function name is addressed with the E<.Ql \\&.Nm> in the E<.Sx NAME> "
15011 "section, and with E<.Ql \\&.Fn> in the E<.Sx SYNOPSIS> and remaining "
15012 "sections. For interactive commands, such as the E<.Ql while> command "
15013 "keyword in E<.Xr csh 1>, the E<.Ql \\&.Ic> macro should be used. While the "
15014 "E<.Ql \\&.Ic> is nearly identical to E<.Ql \\&.Nm>, it can not recall the "
15015 "first argument it was invoked with."
15019 #: build/C/man7/mdoc.samples.7:1245
15021 msgid "Usage: .Nm argument ... \\*(Pu"
15025 #: build/C/man7/mdoc.samples.7:1247
15027 msgid "Li \\&.Nm mdoc.sample"
15030 #. type: Plain text
15031 #: build/C/man7/mdoc.samples.7:1249
15032 msgid "E<.Nm mdoc.sample>"
15036 #: build/C/man7/mdoc.samples.7:1249
15038 msgid "Li \\&.Nm \\e-mdoc"
15041 #. type: Plain text
15042 #: build/C/man7/mdoc.samples.7:1251
15043 msgid "E<.Nm \\-mdoc>."
15047 #: build/C/man7/mdoc.samples.7:1251
15049 msgid "Li \\&.Nm foo\\ )\\ )\\ ,"
15052 #. type: Plain text
15053 #: build/C/man7/mdoc.samples.7:1253
15054 msgid "E<.Nm foo>)),"
15058 #: build/C/man7/mdoc.samples.7:1253
15063 #. type: Plain text
15064 #: build/C/man7/mdoc.samples.7:1255
15068 #. type: Plain text
15069 #: build/C/man7/mdoc.samples.7:1260
15070 msgid "The E<.Ql \\&.Nm> macro is parsed and is callable."
15074 #: build/C/man7/mdoc.samples.7:1260
15079 #. type: Plain text
15080 #: build/C/man7/mdoc.samples.7:1272
15082 "The E<.Ql \\&.Op> macro places option brackets around the any remaining "
15083 "arguments on the command line, and places any trailing punctuation outside "
15084 "the brackets. The macros E<.Ql \\&.Oc> and E<.Ql \\&.Oo> may be used across "
15085 "one or more lines."
15089 #: build/C/man7/mdoc.samples.7:1273
15091 msgid "Usage: .Op options ... \\*(Pu"
15095 #: build/C/man7/mdoc.samples.7:1275
15100 #. type: Plain text
15101 #: build/C/man7/mdoc.samples.7:1277
15106 #: build/C/man7/mdoc.samples.7:1277
15108 msgid "Li \".Op Fl k\""
15111 #. type: Plain text
15112 #: build/C/man7/mdoc.samples.7:1279
15113 msgid "E<.Op Fl k>"
15117 #: build/C/man7/mdoc.samples.7:1279
15119 msgid "Li \".Op Fl k ) .\""
15122 #. type: Plain text
15123 #: build/C/man7/mdoc.samples.7:1281
15124 msgid "E<.Op Fl k>)."
15128 #: build/C/man7/mdoc.samples.7:1281
15130 msgid "Li \".Op Fl k Ar kookfile\""
15133 #. type: Plain text
15134 #: build/C/man7/mdoc.samples.7:1283
15135 msgid "E<.Op Fl k Ar kookfile>"
15139 #: build/C/man7/mdoc.samples.7:1283
15141 msgid "Li \".Op Fl k Ar kookfile ,\""
15144 #. type: Plain text
15145 #: build/C/man7/mdoc.samples.7:1285
15146 msgid "E<.Op Fl k Ar kookfile>,"
15150 #: build/C/man7/mdoc.samples.7:1285
15152 msgid "Li \".Op Ar objfil Op Ar corfil\""
15155 #. type: Plain text
15156 #: build/C/man7/mdoc.samples.7:1287
15157 msgid "E<.Op Ar objfil Op Ar corfil>"
15161 #: build/C/man7/mdoc.samples.7:1287
15163 msgid "Li \".Op Fl c Ar objfil Op Ar corfil ,\""
15166 #. type: Plain text
15167 #: build/C/man7/mdoc.samples.7:1289
15168 msgid "E<.Op Fl c Ar objfil Op Ar corfil>,"
15172 #: build/C/man7/mdoc.samples.7:1289
15174 msgid "Li \\&.Op word1 word2"
15177 #. type: Plain text
15178 #: build/C/man7/mdoc.samples.7:1291
15179 msgid "E<.Op word1 word2>"
15182 #. type: Plain text
15183 #: build/C/man7/mdoc.samples.7:1298
15184 msgid "The E<.Ql \\&.Oc> and E<.Ql \\&.Oo> macros:"
15187 #. type: Plain text
15188 #: build/C/man7/mdoc.samples.7:1304
15192 "\\&.Op \\&Fl k \\&Ar kilobytes\n"
15193 "\\&.Op \\&Fl i \\&Ar interval\n"
15194 "\\&.Op \\&Fl c \\&Ar count\n"
15198 #. type: Plain text
15199 #: build/C/man7/mdoc.samples.7:1312
15201 "Produce: E<.Oo> E<.Op Fl k Ar kilobytes> E<.Op Fl i Ar interval> E<.Op Fl c "
15205 #. type: Plain text
15206 #: build/C/man7/mdoc.samples.7:1319
15208 "The macros E<.Ql \\&.Op>, E<.Ql \\&.Oc> and E<.Ql \\&.Oo> are parsed and are "
15213 #: build/C/man7/mdoc.samples.7:1319
15218 #. type: Plain text
15219 #: build/C/man7/mdoc.samples.7:1323
15220 msgid "The E<.Ql \\&.Pa> macro formats pathnames or filenames."
15224 #: build/C/man7/mdoc.samples.7:1324
15226 msgid "Usage: .Pa pathname \\*(Pu"
15230 #: build/C/man7/mdoc.samples.7:1326
15232 msgid "Li \\&.Pa /usr/share"
15235 #. type: Plain text
15236 #: build/C/man7/mdoc.samples.7:1328
15237 msgid "E<.Pa /usr/share>"
15241 #: build/C/man7/mdoc.samples.7:1328
15243 msgid "Li \\&.Pa /tmp/fooXXXXX\\ )\\ ."
15246 #. type: Plain text
15247 #: build/C/man7/mdoc.samples.7:1330
15248 msgid "E<.Pa /tmp/fooXXXXX>)."
15251 #. type: Plain text
15252 #: build/C/man7/mdoc.samples.7:1335
15253 msgid "The E<.Ql \\&.Pa> macro is parsed and is callable."
15257 #: build/C/man7/mdoc.samples.7:1335
15262 #. type: Plain text
15263 #: build/C/man7/mdoc.samples.7:1337
15264 msgid "Generic variable reference:"
15268 #: build/C/man7/mdoc.samples.7:1338
15270 msgid "Usage: .Va variable ... \\*(Pu"
15274 #: build/C/man7/mdoc.samples.7:1340
15276 msgid "Li \\&.Va count"
15279 #. type: Plain text
15280 #: build/C/man7/mdoc.samples.7:1342
15281 msgid "E<.Va count>"
15285 #: build/C/man7/mdoc.samples.7:1342
15287 msgid "Li \\&.Va settimer ,"
15290 #. type: Plain text
15291 #: build/C/man7/mdoc.samples.7:1344
15292 msgid "E<.Va settimer>,"
15296 #: build/C/man7/mdoc.samples.7:1344
15298 msgid "Li \\&.Va int\\ *prt\\ )\\ :"
15301 #. type: Plain text
15302 #: build/C/man7/mdoc.samples.7:1346
15303 msgid "E<.Va int\\ *prt>):"
15307 #: build/C/man7/mdoc.samples.7:1346
15309 msgid "Li \\&.Va char\\ s\\ ]\\ )\\ )\\ ,"
15312 #. type: Plain text
15313 #: build/C/man7/mdoc.samples.7:1348
15314 msgid "E<.Va char\\ s>])),"
15317 #. type: Plain text
15318 #: build/C/man7/mdoc.samples.7:1356
15320 "It is an error to call E<.Ql \\&.Va> without any arguments. The E<.Ql "
15321 "\\&.Va> macro is parsed and is callable."
15325 #: build/C/man7/mdoc.samples.7:1356
15327 msgid "Manual Page Cross References"
15330 #. type: Plain text
15331 #: build/C/man7/mdoc.samples.7:1364
15333 "The E<.Ql \\&.Xr> macro expects the first argument to be a manual page name, "
15334 "and the second argument, if it exists, to be either a section page number or "
15335 "punctuation. Any remaining arguments are assumed to be punctuation."
15339 #: build/C/man7/mdoc.samples.7:1365
15341 msgid "Usage: .Xr man_page [1,...,8] \\*(Pu"
15345 #: build/C/man7/mdoc.samples.7:1367
15347 msgid "Li \\&.Xr mdoc"
15350 #. type: Plain text
15351 #: build/C/man7/mdoc.samples.7:1369
15352 msgid "E<.Xr mdoc>"
15356 #: build/C/man7/mdoc.samples.7:1369
15358 msgid "Li \\&.Xr mdoc\\ ,"
15361 #. type: Plain text
15362 #: build/C/man7/mdoc.samples.7:1371
15363 msgid "E<.Xr mdoc>,"
15367 #: build/C/man7/mdoc.samples.7:1371
15369 msgid "Li \\&.Xr mdoc 7"
15372 #. type: Plain text
15373 #: build/C/man7/mdoc.samples.7:1373
15374 msgid "E<.Xr mdoc 7>"
15378 #: build/C/man7/mdoc.samples.7:1373
15380 msgid "Li \\&.Xr mdoc 7\\ )\\ )\\ ,"
15383 #. type: Plain text
15384 #: build/C/man7/mdoc.samples.7:1375
15385 msgid "E<.Xr mdoc 7>)),"
15388 #. type: Plain text
15389 #: build/C/man7/mdoc.samples.7:1384
15391 "The E<.Ql \\&.Xr> macro is parsed and is callable. It is an error to call "
15392 "E<.Ql \\&.Xr> without any arguments."
15396 #: build/C/man7/mdoc.samples.7:1384
15398 msgid "GENERAL TEXT DOMAIN"
15402 #: build/C/man7/mdoc.samples.7:1385
15407 #. type: Plain text
15408 #: build/C/man7/mdoc.samples.7:1388
15410 msgid "Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \\*(Pu\n"
15414 #: build/C/man7/mdoc.samples.7:1390
15419 #. type: Plain text
15420 #: build/C/man7/mdoc.samples.7:1392
15425 #: build/C/man7/mdoc.samples.7:1392
15427 msgid "Li \".At v6 .\""
15430 #. type: Plain text
15431 #: build/C/man7/mdoc.samples.7:1394
15435 #. type: Plain text
15436 #: build/C/man7/mdoc.samples.7:1404
15438 "The E<.Ql \\&.At> macro is E<.Em not> parsed and E<.Em not> callable It "
15439 "accepts at most two arguments."
15443 #: build/C/man7/mdoc.samples.7:1404
15449 #: build/C/man7/mdoc.samples.7:1405
15451 msgid "Usage: .Bx [Version/release] ... \\*(Pu"
15455 #: build/C/man7/mdoc.samples.7:1407
15460 #. type: Plain text
15461 #: build/C/man7/mdoc.samples.7:1409
15466 #: build/C/man7/mdoc.samples.7:1409
15468 msgid "Li \".Bx 4.3 .\""
15471 #. type: Plain text
15472 #: build/C/man7/mdoc.samples.7:1411
15473 msgid "E<.Bx 4.3>."
15476 #. type: Plain text
15477 #: build/C/man7/mdoc.samples.7:1416
15478 msgid "The E<.Ql \\&.Bx> macro is parsed and is callable."
15482 #: build/C/man7/mdoc.samples.7:1416
15484 msgid "FreeBSD Macro"
15487 #. type: Plain text
15488 #: build/C/man7/mdoc.samples.7:1419
15490 msgid "Usage: .Fx Version.release ... \\*(Pu\n"
15494 #: build/C/man7/mdoc.samples.7:1421
15496 msgid "Li \".Fx 2.2 .\""
15499 #. type: Plain text
15500 #: build/C/man7/mdoc.samples.7:1423
15501 msgid "E<.Fx 2.2>."
15504 #. type: Plain text
15505 #: build/C/man7/mdoc.samples.7:1433
15507 "The E<.Ql \\&.Fx> macro is E<.Em not> parsed and E<.Em not> callable It "
15508 "accepts at most two arguments."
15512 #: build/C/man7/mdoc.samples.7:1433
15518 #: build/C/man7/mdoc.samples.7:1434
15520 msgid "Usage: .Ux ... \\*(Pu"
15524 #: build/C/man7/mdoc.samples.7:1436
15529 #. type: Plain text
15530 #: build/C/man7/mdoc.samples.7:1438
15534 #. type: Plain text
15535 #: build/C/man7/mdoc.samples.7:1443
15536 msgid "The E<.Ql \\&.Ux> macro is parsed and is callable."
15540 #: build/C/man7/mdoc.samples.7:1443
15542 msgid "Enclosure and Quoting Macros"
15545 #. type: Plain text
15546 #: build/C/man7/mdoc.samples.7:1465
15548 "The concept of enclosure is similar to quoting. The object being to enclose "
15549 "one or more strings between a pair of characters like quotes or "
15550 "parentheses. The terms quoting and enclosure are used interchangeably "
15551 "throughout this document. Most of the one line enclosure macros end in "
15552 "small letter E<.Ql q> to give a hint of quoting, but there are a few "
15553 "irregularities. For each enclosure macro there is also a pair of open and "
15554 "close macros which end in small letters E<.Ql o> and E<.Ql c> respectively. "
15555 "These can be used across one or more lines of text and while they have "
15556 "nesting limitations, the one line quote macros can be used inside of them."
15559 #. type: Plain text
15560 #: build/C/man7/mdoc.samples.7:1478
15563 "E<.Em \" Quote\t Close\t Open\tFunction\tResult\">\n"
15564 "\\&.Aq\t.Ac\t.Ao\tAngle Bracket Enclosure\tE<lt>stringE<gt>\n"
15565 "\\&.Bq\t.Bc\t.Bo\tBracket Enclosure\t[string]\n"
15566 "\\&.Dq\t.Dc\t.Do\tDouble Quote\t``string''\n"
15567 "\t.Ec\t.Eo\tEnclose String (in XX)\tXXstringXX\n"
15568 "\\&.Pq\t.Pc\t.Po\tParenthesis Enclosure\t(string)\n"
15569 "\\&.Ql\t\t\tQuoted Literal\t`st' or string\n"
15570 "\\&.Qq\t.Qc\t.Qo\tStraight Double Quote\t\"string\"\n"
15571 "\\&.Sq\t.Sc\t.So\tSingle Quote\t`string'\n"
15574 #. type: Plain text
15575 #: build/C/man7/mdoc.samples.7:1489
15577 "Except for the irregular macros noted below, all of the quoting macros are "
15578 "parsed and callable. All handle punctuation properly, as long as it is "
15579 "presented one character at a time and separated by spaces. The quoting "
15580 "macros examine opening and closing punctuation to determine whether it comes "
15581 "before or after the enclosing string This makes some nesting possible."
15585 #: build/C/man7/mdoc.samples.7:1490
15587 msgid "Li \\&.Ec , \\&.Eo"
15590 #. type: Plain text
15591 #: build/C/man7/mdoc.samples.7:1493
15593 "These macros expect the first argument to be the opening and closing strings "
15598 #: build/C/man7/mdoc.samples.7:1493
15603 #. type: Plain text
15604 #: build/C/man7/mdoc.samples.7:1506
15606 "The quoted literal macro behaves differently for E<.Xr troff> than E<.Xr "
15607 "nroff>. If formatted with E<.Xr nroff>, a quoted literal is always quoted. "
15608 "If formatted with troff, an item is only quoted if the width of the item is "
15609 "less than three constant width characters. This is to make short strings "
15610 "more visible where the font change to literal (constant width) is less "
15615 #: build/C/man7/mdoc.samples.7:1506
15620 #. type: Plain text
15621 #: build/C/man7/mdoc.samples.7:1508
15622 msgid "The prefix macro is not callable, but it is parsed:"
15626 #: build/C/man7/mdoc.samples.7:1509
15628 msgid "Li \".Pf ( Fa name2\""
15631 #. type: Plain text
15632 #: build/C/man7/mdoc.samples.7:1512
15633 msgid "becomes E<.Pf ( Fa name2>."
15636 #. type: Plain text
15637 #: build/C/man7/mdoc.samples.7:1517
15638 msgid "The E<.Ql \\&.Ns> (no space) macro performs the analogous suffix function."
15641 #. type: Plain text
15642 #: build/C/man7/mdoc.samples.7:1521
15643 msgid "Examples of quoting:"
15647 #: build/C/man7/mdoc.samples.7:1522
15652 #. type: Plain text
15653 #: build/C/man7/mdoc.samples.7:1524
15658 #: build/C/man7/mdoc.samples.7:1524
15660 msgid "Li \\&.Aq \\&Ar ctype.h\\ )\\ ,"
15663 #. type: Plain text
15664 #: build/C/man7/mdoc.samples.7:1526
15665 msgid "E<.Aq Ar ctype.h>),"
15669 #: build/C/man7/mdoc.samples.7:1526
15674 #. type: Plain text
15675 #: build/C/man7/mdoc.samples.7:1528
15680 #: build/C/man7/mdoc.samples.7:1528
15682 msgid "Li \\&.Bq \\&Em Greek \\&, French \\&."
15685 #. type: Plain text
15686 #: build/C/man7/mdoc.samples.7:1530
15687 msgid "E<.Bq Em Greek , French>."
15691 #: build/C/man7/mdoc.samples.7:1530
15696 #. type: Plain text
15697 #: build/C/man7/mdoc.samples.7:1532
15702 #: build/C/man7/mdoc.samples.7:1532
15704 msgid "Li \".Dq string abc .\""
15707 #. type: Plain text
15708 #: build/C/man7/mdoc.samples.7:1534
15709 msgid "E<.Dq string abc>."
15713 #: build/C/man7/mdoc.samples.7:1534
15715 msgid "Li \".Dq \\'^[A-Z]\\'\""
15718 #. type: Plain text
15719 #: build/C/man7/mdoc.samples.7:1536
15720 msgid "E<.Dq \\'^[A-Z]\\'>"
15724 #: build/C/man7/mdoc.samples.7:1536
15726 msgid "Li \"\\&.Ql man mdoc\""
15729 #. type: Plain text
15730 #: build/C/man7/mdoc.samples.7:1538
15731 msgid "E<.Ql man mdoc>"
15735 #: build/C/man7/mdoc.samples.7:1538
15740 #. type: Plain text
15741 #: build/C/man7/mdoc.samples.7:1540
15746 #: build/C/man7/mdoc.samples.7:1540
15748 msgid "Li \"\\&.Qq string ) ,\""
15751 #. type: Plain text
15752 #: build/C/man7/mdoc.samples.7:1542
15753 msgid "E<.Qq string>),"
15757 #: build/C/man7/mdoc.samples.7:1542
15759 msgid "Li \"\\&.Qq string Ns ),\""
15762 #. type: Plain text
15763 #: build/C/man7/mdoc.samples.7:1544
15764 msgid "E<.Qq string Ns ),>"
15768 #: build/C/man7/mdoc.samples.7:1544
15773 #. type: Plain text
15774 #: build/C/man7/mdoc.samples.7:1546
15779 #: build/C/man7/mdoc.samples.7:1546
15781 msgid "Li \"\\&.Sq string\""
15784 #. type: Plain text
15785 #: build/C/man7/mdoc.samples.7:1548
15786 msgid "E<.Sq string>"
15789 #. type: Plain text
15790 #: build/C/man7/mdoc.samples.7:1565
15792 "For a good example of nested enclosure macros, see the E<.Ql \\&.Op> option "
15793 "macro. It was created from the same underlying enclosure macros as those "
15794 "presented in the list above. The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> extended "
15795 "argument list macros were also built from the same underlying routines and "
15796 "are a good example of E<.Nm \\-mdoc> macro usage at its worst."
15800 #: build/C/man7/mdoc.samples.7:1565
15802 msgid "No\\-Op or Normal Text Macro"
15805 #. type: Plain text
15806 #: build/C/man7/mdoc.samples.7:1573
15808 "The macro E<.Ql \\&.No> is a hack for words in a macro command line which "
15809 "should E<.Em not> be formatted and follows the conventional syntax for "
15814 #: build/C/man7/mdoc.samples.7:1573
15816 msgid "No Space Macro"
15819 #. type: Plain text
15820 #: build/C/man7/mdoc.samples.7:1579
15822 "The E<.Ql \\&.Ns> macro eliminates unwanted spaces in between macro "
15823 "requests. It is useful for old style argument lists where there is no space "
15824 "between the flag and argument:"
15828 #: build/C/man7/mdoc.samples.7:1580
15830 msgid "Li \".Op Fl I Ns Ar directory\""
15833 #. type: Plain text
15834 #: build/C/man7/mdoc.samples.7:1583
15835 msgid "produces E<.Op Fl I Ns Ar directory>"
15838 #. type: Plain text
15839 #: build/C/man7/mdoc.samples.7:1594
15841 "Note: the E<.Ql \\&.Ns> macro always invokes the E<.Ql \\&.No> macro after "
15842 "eliminating the space unless another macro name follows it. The macro E<.Ql "
15843 "\\&.Ns> is parsed and is callable."
15847 #: build/C/man7/mdoc.samples.7:1594
15849 msgid "Section Cross References"
15852 #. type: Plain text
15853 #: build/C/man7/mdoc.samples.7:1600
15855 "The E<.Ql \\&.Sx> macro designates a reference to a section header within "
15856 "the same document. It is parsed and is callable."
15860 #: build/C/man7/mdoc.samples.7:1602
15862 msgid "Li \\&.Sx FILES"
15865 #. type: Plain text
15866 #: build/C/man7/mdoc.samples.7:1604
15867 msgid "E<.Sx FILES>"
15871 #: build/C/man7/mdoc.samples.7:1605
15873 msgid "References and Citations"
15876 #. type: Plain text
15877 #: build/C/man7/mdoc.samples.7:1609
15879 "The following macros make a modest attempt to handle references. At best, "
15880 "the macros make it convenient to manually drop in a subset of refer style "
15885 #: build/C/man7/mdoc.samples.7:1611
15890 #. type: Plain text
15891 #: build/C/man7/mdoc.samples.7:1616
15893 "Reference Start. Causes a line break and begins collection of reference "
15894 "information until the reference end macro is read."
15898 #: build/C/man7/mdoc.samples.7:1616
15903 #. type: Plain text
15904 #: build/C/man7/mdoc.samples.7:1619
15905 msgid "Reference End. The reference is printed."
15909 #: build/C/man7/mdoc.samples.7:1619
15914 #. type: Plain text
15915 #: build/C/man7/mdoc.samples.7:1621
15916 msgid "Reference author name, one name per invocation."
15920 #: build/C/man7/mdoc.samples.7:1621
15925 #. type: Plain text
15926 #: build/C/man7/mdoc.samples.7:1623
15927 msgid "Book title."
15931 #: build/C/man7/mdoc.samples.7:1623
15936 #. type: Plain text
15937 #: build/C/man7/mdoc.samples.7:1625
15938 msgid "City/place."
15942 #: build/C/man7/mdoc.samples.7:1625
15947 #. type: Plain text
15948 #: build/C/man7/mdoc.samples.7:1627
15953 #: build/C/man7/mdoc.samples.7:1627
15958 #. type: Plain text
15959 #: build/C/man7/mdoc.samples.7:1629
15960 msgid "Journal name."
15964 #: build/C/man7/mdoc.samples.7:1629
15969 #. type: Plain text
15970 #: build/C/man7/mdoc.samples.7:1631
15971 msgid "Issue number."
15975 #: build/C/man7/mdoc.samples.7:1631
15980 #. type: Plain text
15981 #: build/C/man7/mdoc.samples.7:1633
15982 msgid "Optional information."
15986 #: build/C/man7/mdoc.samples.7:1633
15991 #. type: Plain text
15992 #: build/C/man7/mdoc.samples.7:1635
15993 msgid "Page number."
15997 #: build/C/man7/mdoc.samples.7:1635
16002 #. type: Plain text
16003 #: build/C/man7/mdoc.samples.7:1637
16004 msgid "Report name."
16008 #: build/C/man7/mdoc.samples.7:1637
16013 #. type: Plain text
16014 #: build/C/man7/mdoc.samples.7:1639
16015 msgid "Title of article."
16019 #: build/C/man7/mdoc.samples.7:1639
16024 #. type: Plain text
16025 #: build/C/man7/mdoc.samples.7:1641
16029 #. type: Plain text
16030 #: build/C/man7/mdoc.samples.7:1652
16032 "The macros beginning with E<.Ql %> are not callable, and are parsed only for "
16033 "the trade name macro which returns to its caller. (And not very predictably "
16034 "at the moment either.) The purpose is to allow trade names to be pretty "
16035 "printed in E<.Xr troff Ns / Ns Xr ditroff> output."
16039 #: build/C/man7/mdoc.samples.7:1652
16041 msgid "Return Values"
16044 #. type: Plain text
16045 #: build/C/man7/mdoc.samples.7:1658
16047 "The E<.Ql \\&.Rv> macro generates text for use in the E<.Sx RETURN VALUE> "
16052 #: build/C/man7/mdoc.samples.7:1659
16054 msgid "Usage: .Rv [-std function]"
16057 #. type: Plain text
16058 #: build/C/man7/mdoc.samples.7:1663
16059 msgid "E<.Ql \\&.Rv -std atexit> will generate the following text:"
16062 #. fake chapter 3 to avoid error message from Rv
16064 #: build/C/man7/mdoc.samples.7:1665
16069 #. and back to 7 again
16070 #. type: Plain text
16071 #: build/C/man7/mdoc.samples.7:1668
16072 msgid "E<.Rv -std atexit>"
16076 #: build/C/man7/mdoc.samples.7:1668
16081 #. type: Plain text
16082 #: build/C/man7/mdoc.samples.7:1673
16083 msgid "The E<.Fl std> option is valid only for manual page sections 2 and 3."
16087 #: build/C/man7/mdoc.samples.7:1673
16089 msgid "Trade Names (or Acronyms and Type Names)"
16092 #. type: Plain text
16093 #: build/C/man7/mdoc.samples.7:1676
16095 "The trade name macro is generally a small caps macro for all upper case "
16096 "words longer than two characters."
16100 #: build/C/man7/mdoc.samples.7:1677
16102 msgid "Usage: .Tn symbol ... \\*(Pu"
16106 #: build/C/man7/mdoc.samples.7:1679
16108 msgid "Li \\&.Tn DEC"
16111 #. type: Plain text
16112 #: build/C/man7/mdoc.samples.7:1681
16117 #: build/C/man7/mdoc.samples.7:1681
16119 msgid "Li \\&.Tn ASCII"
16122 #. type: Plain text
16123 #: build/C/man7/mdoc.samples.7:1683
16124 msgid "E<.Tn ASCII>"
16127 #. type: Plain text
16128 #: build/C/man7/mdoc.samples.7:1689
16129 msgid "The E<.Ql \\&.Tn> macro is parsed and is callable by other macros."
16133 #: build/C/man7/mdoc.samples.7:1689
16135 msgid "Extended Arguments"
16138 #. type: Plain text
16139 #: build/C/man7/mdoc.samples.7:1701
16141 "The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> macros allow one to extend an argument "
16142 "list on a macro boundary. Argument lists cannot be extended within a macro "
16143 "which expects all of its arguments on one line such as E<.Ql \\&.Op>."
16146 #. type: Plain text
16147 #: build/C/man7/mdoc.samples.7:1705
16149 "Here is an example of E<.Ql \\&.Xo> using the space mode macro to turn "
16153 #. type: Plain text
16154 #: build/C/man7/mdoc.samples.7:1711
16158 "\\&.It Xo Sy I Ar operation\n"
16159 "\\&.No \\een Ar count No \\een\n"
16164 #. type: Plain text
16165 #: build/C/man7/mdoc.samples.7:1714 build/C/man7/mdoc.samples.7:1735 build/C/man7/mdoc.samples.7:1759
16169 #. type: Plain text
16170 #: build/C/man7/mdoc.samples.7:1717 build/C/man7/mdoc.samples.7:1738
16172 msgid "E<.Sm off>\n"
16176 #: build/C/man7/mdoc.samples.7:1717
16178 msgid "Xo Sy I Ar operation"
16181 #. type: Plain text
16182 #: build/C/man7/mdoc.samples.7:1721
16185 "E<.No \\en Ar count No \\en>\n"
16190 #. type: Plain text
16191 #: build/C/man7/mdoc.samples.7:1725
16192 msgid "Another one:"
16195 #. type: Plain text
16196 #: build/C/man7/mdoc.samples.7:1732
16200 "\\&.It Cm S No \\&/ Ar old_pattern Xo\n"
16201 "\\&.No \\&/ Ar new_pattern\n"
16202 "\\&.No \\&/ Op Cm g\n"
16208 #: build/C/man7/mdoc.samples.7:1738
16210 msgid "Cm S No \\&/ Ar old_pattern Xo"
16213 #. type: Plain text
16214 #: build/C/man7/mdoc.samples.7:1743
16217 "E<.No \\&/ Ar new_pattern>\n"
16218 "E<.No \\&/ Op Cm g>\n"
16223 #. type: Plain text
16224 #: build/C/man7/mdoc.samples.7:1750
16226 "Another example of E<.Ql \\&.Xo> and using enclosure macros: Test the value "
16230 #. type: Plain text
16231 #: build/C/man7/mdoc.samples.7:1756
16236 "\\&.Oo \\e&! Oc Ns Ar variable\n"
16237 "\\&.Op Ar operator variable ...\n"
16242 #: build/C/man7/mdoc.samples.7:1761
16247 #. type: Plain text
16248 #: build/C/man7/mdoc.samples.7:1766
16252 "E<.Oo \\&! Oc Ns Ar variable>\n"
16253 "E<.Op Ar operator variable ...>\n"
16257 #. type: Plain text
16258 #: build/C/man7/mdoc.samples.7:1804
16260 "All of the above examples have used the E<.Ql \\&.Xo> macro on the argument "
16261 "list of the E<.Ql \\&.It> (list-item) macro. The extend macros are not "
16262 "used very often, and when they are it is usually to extend the list-item "
16263 "argument list. Unfortunately, this is also where the extend macros are the "
16264 "most finicky. In the first two examples, spacing was turned off; in the "
16265 "third, spacing was desired in part of the output but not all of it. To make "
16266 "these macros work in this situation make sure the E<.Ql \\&.Xo> and E<.Ql "
16267 "\\&.Xc> macros are placed as shown in the third example. If the E<.Ql "
16268 "\\&.Xo> macro is not alone on the E<.Ql \\&.It> argument list, spacing will "
16269 "be unpredictable. The E<.Ql \\&.Ns> (no space macro) must not occur as the "
16270 "first or last macro on a line in this situation. Out of 900 manual pages "
16271 "(about 1500 actual pages) currently released with E<.Bx> only fifteen use "
16272 "the E<.Ql \\&.Xo> macro."
16276 #: build/C/man7/mdoc.samples.7:1805
16278 msgid "Section Headers"
16281 #. type: Plain text
16282 #: build/C/man7/mdoc.samples.7:1818
16284 "The first three E<.Ql \\&.Sh> section header macros list below are required "
16285 "in every man page. The remaining section headers are recommended at the "
16286 "discretion of the author writing the manual page. The E<.Ql \\&.Sh> macro "
16287 "can take up to nine arguments. It is parsed and but is not callable."
16291 #: build/C/man7/mdoc.samples.7:1819
16293 msgid "\\&.Sh NAME"
16296 #. type: Plain text
16297 #: build/C/man7/mdoc.samples.7:1839
16299 "The E<.Ql \\&.Sh NAME> macro is mandatory. If not specified, the headers, "
16300 "footers and page layout defaults will not be set and things will be rather "
16301 "unpleasant. The E<.Sx NAME> section consists of at least three items. The "
16302 "first is the E<.Ql \\&.Nm> name macro naming the subject of the man page. "
16303 "The second is the Name Description macro, E<.Ql \\&.Nd>, which separates the "
16304 "subject name from the third item, which is the description. The description "
16305 "should be the most terse and lucid possible, as the space available is "
16310 #: build/C/man7/mdoc.samples.7:1839
16312 msgid "\\&.Sh SYNOPSIS"
16315 #. type: Plain text
16316 #: build/C/man7/mdoc.samples.7:1871
16318 "The E<.Sx SYNOPSIS> section describes the typical usage of the subject of a "
16319 "man page. The macros required are either E<.Ql \".Nm\">, E<.Ql \".Cd\">, "
16320 "E<.Ql \".Fn\">, (and possibly E<.Ql \".Fo\">, E<.Ql \".Fc\">, E<.Ql "
16321 "\".Fd\">, E<.Ql \".Ft\"> macros). The function name macro E<.Ql \".Fn\"> is "
16322 "required for manual page sections 2 and 3, the command and general name "
16323 "macro E<.Ql \\&.Nm> is required for sections 1, 5, 6, 7, 8. Section 4 "
16324 "manuals require a E<.Ql \".Nm\">, E<.Ql \".Fd\"> or a E<.Ql \".Cd\"> "
16325 "configuration device usage macro. Several other macros may be necessary to "
16326 "produce the synopsis line as shown below:"
16329 #. type: Plain text
16330 #: build/C/man7/mdoc.samples.7:1877
16334 "E<.Op Fl benstuv>\n"
16339 #. type: Plain text
16340 #: build/C/man7/mdoc.samples.7:1880
16341 msgid "The following macros were used:"
16345 #: build/C/man7/mdoc.samples.7:1881
16351 #: build/C/man7/mdoc.samples.7:1882
16353 msgid "\\&.Op \\&Fl benstuv"
16357 #: build/C/man7/mdoc.samples.7:1883
16359 msgid "\\&.Op \\&Fl"
16363 #: build/C/man7/mdoc.samples.7:1884
16368 #. type: Plain text
16369 #: build/C/man7/mdoc.samples.7:1895
16371 "E<.Sy Note>: The macros E<.Ql \\&.Op>, E<.Ql \\&.Fl>, and E<.Ql \\&.Ar> "
16372 "recognize the pipe bar character E<.Ql \\*(Ba>, so a command line such as:"
16376 #: build/C/man7/mdoc.samples.7:1896
16378 msgid ".Op Fl a | Fl b"
16381 #. type: Plain text
16382 #: build/C/man7/mdoc.samples.7:1905
16384 "will not go orbital. E<.Xr Troff> normally interprets a \\*(Ba as a special "
16385 "operator. See E<.Sx PREDEFINED STRINGS> for a usable \\*(Ba character in "
16386 "other situations."
16390 #: build/C/man7/mdoc.samples.7:1905
16392 msgid "\\&.Sh DESCRIPTION"
16395 #. type: Plain text
16396 #: build/C/man7/mdoc.samples.7:1922
16398 "In most cases the first text in the E<.Sx DESCRIPTION> section is a brief "
16399 "paragraph on the command, function or file, followed by a lexical list of "
16400 "options and respective explanations. To create such a list, the E<.Ql "
16401 "\\&.Bl> begin-list, E<.Ql \\&.It> list-item and E<.Ql \\&.El> end-list "
16402 "macros are used (see E<.Sx Lists and Columns> below)."
16405 #. type: Plain text
16406 #: build/C/man7/mdoc.samples.7:1931
16408 "The following E<.Ql \\&.Sh> section headers are part of the preferred manual "
16409 "page layout and must be used appropriately to maintain consistency. They "
16410 "are listed in the order in which they would be used."
16414 #: build/C/man7/mdoc.samples.7:1932
16416 msgid "\\&.Sh ENVIRONMENT"
16419 #. type: Plain text
16420 #: build/C/man7/mdoc.samples.7:1938
16422 "The E<.Sx ENVIRONMENT> section should reveal any related environment "
16423 "variables and clues to their behavior and/or usage."
16427 #: build/C/man7/mdoc.samples.7:1938
16429 msgid "\\&.Sh EXAMPLES"
16432 #. type: Plain text
16433 #: build/C/man7/mdoc.samples.7:1945
16435 "There are several ways to create examples. See the E<.Sx EXAMPLES> section "
16436 "below for details."
16440 #: build/C/man7/mdoc.samples.7:1945
16442 msgid "\\&.Sh FILES"
16445 #. type: Plain text
16446 #: build/C/man7/mdoc.samples.7:1952
16448 "Files which are used or created by the man page subject should be listed via "
16449 "the E<.Ql \\&.Pa> macro in the E<.Sx FILES> section."
16453 #: build/C/man7/mdoc.samples.7:1952
16455 msgid "\\&.Sh SEE ALSO"
16458 #. type: Plain text
16459 #: build/C/man7/mdoc.samples.7:1966
16461 "References to other material on the man page topic and cross references to "
16462 "other relevant man pages should be placed in the E<.Sx SEE ALSO> section. "
16463 "Cross references are specified using the E<.Ql \\&.Xr> macro. Cross "
16464 "references in the E<.Sx SEE ALSO> section should be sorted by section "
16465 "number, and then placed in alphabetical order and comma separated. For "
16469 #. type: Plain text
16470 #: build/C/man7/mdoc.samples.7:1971
16471 msgid "E<.Xr ls 1>, E<.Xr ps 1>, E<.Xr group 5>, E<.Xr passwd 5>."
16474 #. type: Plain text
16475 #: build/C/man7/mdoc.samples.7:1975
16476 msgid "At this time E<.Xr refer 1> style references are not accommodated."
16480 #: build/C/man7/mdoc.samples.7:1975
16482 msgid "\\&.Sh CONFORMING TO"
16485 #. type: Plain text
16486 #: build/C/man7/mdoc.samples.7:1987
16488 "If the command, library function or file adheres to a specific "
16489 "implementation such as E<.St -p1003.2> or E<.St -ansiC> this should be noted "
16490 "here. If the command does not adhere to any standard, its history should be "
16491 "noted in the E<.Sx HISTORY> section."
16495 #: build/C/man7/mdoc.samples.7:1987
16497 msgid "\\&.Sh HISTORY"
16500 #. type: Plain text
16501 #: build/C/man7/mdoc.samples.7:1990
16503 "Any command which does not adhere to any specific standards should be "
16504 "outlined historically in this section."
16508 #: build/C/man7/mdoc.samples.7:1990
16510 msgid "\\&.Sh AUTHORS"
16513 #. type: Plain text
16514 #: build/C/man7/mdoc.samples.7:1992
16515 msgid "Credits, if need be, should be placed here."
16519 #: build/C/man7/mdoc.samples.7:1992
16521 msgid "\\&.Sh DIAGNOSTICS"
16524 #. type: Plain text
16525 #: build/C/man7/mdoc.samples.7:1994
16526 msgid "Diagnostics from a command should be placed in this section."
16530 #: build/C/man7/mdoc.samples.7:1994
16532 msgid "\\&.Sh ERRORS"
16535 #. type: Plain text
16536 #: build/C/man7/mdoc.samples.7:2000
16538 "Specific error handling, especially from library functions (man page "
16539 "sections 2 and 3) should go here. The E<.Ql \\&.Er> macro is used to "
16540 "specify an errno."
16544 #: build/C/man7/mdoc.samples.7:2000
16546 msgid "\\&.Sh BUGS"
16549 #. type: Plain text
16550 #: build/C/man7/mdoc.samples.7:2002
16551 msgid "Blatant problems with the topic go here..."
16554 #. type: Plain text
16555 #: build/C/man7/mdoc.samples.7:2008
16557 "User specified E<.Ql \\&.Sh> sections may be added, for example, this "
16558 "section was set with:"
16561 #. type: Plain text
16562 #: build/C/man7/mdoc.samples.7:2010
16564 msgid "\\&.Sh PAGE STRUCTURE DOMAIN\n"
16568 #: build/C/man7/mdoc.samples.7:2011
16570 msgid "Paragraphs and Line Spacing."
16574 #: build/C/man7/mdoc.samples.7:2013
16579 #. type: Plain text
16580 #: build/C/man7/mdoc.samples.7:2029
16582 "The E<.Ql \\&.Pp> paragraph command may be used to specify a line space "
16583 "where necessary. The macro is not necessary after a E<.Ql \\&.Sh> or E<.Ql "
16584 "\\&.Ss> macro or before a E<.Ql \\&.Bl> macro. (The E<.Ql \\&.Bl> macro "
16585 "asserts a vertical distance unless the -compact flag is given)."
16588 #. This worked with version one, need to redo for version three
16591 #. .Cw (ax+bx+c) \ is\ produced\ by\ \&
16592 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
16609 #. .Em is produced by
16625 #. This example shows the same equation in a different format.
16629 #. signs were forced with
16633 #. .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
16634 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
16645 #. .Li \&.Cx \e\ +\e\ \e&
16656 #. .Em is produced by
16664 #. .Li \&.Cx \e\ +\e\ \e&
16675 #. The incantation below was
16681 #. .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
16683 #. .Li \&.Cx Op Sy ?/
16693 #. .Em is produced by
16695 #. .Li \&.Ar \e\ b1 e1 f1
16707 #: build/C/man7/mdoc.samples.7:2148
16712 #. type: Plain text
16713 #: build/C/man7/mdoc.samples.7:2177
16715 "The only keep that is implemented at this time is for words. The macros are "
16716 "E<.Ql \\&.Bk> (begin-keep) and E<.Ql \\&.Ek> (end-keep). The only option "
16717 "that E<.Ql \\&.Bk> accepts is E<.Fl words> and is useful for preventing line "
16718 "breaks in the middle of options. In the example for the make command-line "
16719 "arguments (see E<.Sx What's in a name>), the keep prevented E<.Xr nroff> "
16720 "from placing up the flag and the argument on separate lines. (Actually, the "
16721 "option macro used to prevent this from occurring, but was dropped when the "
16722 "decision (religious) was made to force right justified margins in E<.Xr "
16723 "troff> as options in general look atrocious when spread across a sparse "
16724 "line. More work needs to be done with the keep macros, a E<.Fl line> option "
16725 "needs to be added.)"
16729 #: build/C/man7/mdoc.samples.7:2177
16731 msgid "Examples and Displays"
16734 #. type: Plain text
16735 #: build/C/man7/mdoc.samples.7:2189
16737 "There are five types of displays, a quickie one line indented display E<.Ql "
16738 "\\&.D1>, a quickie one line literal display E<.Ql \\&.Dl>, and a block "
16739 "literal, block filled and block ragged which use the E<.Ql \\&.Bd> "
16740 "begin-display and E<.Ql \\&.Ed> end-display macros."
16743 #. type: Plain text
16744 #: build/C/man7/mdoc.samples.7:2194
16746 "(D-one) Display one line of indented text. This macro is parsed, but it is "
16751 #: build/C/man7/mdoc.samples.7:2195
16753 msgid "Fl ldghfstru"
16756 #. type: Plain text
16757 #: build/C/man7/mdoc.samples.7:2199
16758 msgid "The above was produced by: E<.Li \\&.Dl Fl ldghfstru>."
16761 #. type: Plain text
16762 #: build/C/man7/mdoc.samples.7:2214
16764 "(D-ell) Display one line of indented E<.Em literal> text. The E<.Ql "
16765 "\\&.Dl> example macro has been used throughout this file. It allows the "
16766 "indent (display) of one line of text. Its default font is set to constant "
16767 "width (literal) however it is parsed and will recognized other macros. It "
16768 "is not callable however."
16772 #: build/C/man7/mdoc.samples.7:2215
16774 msgid "% ls -ldg /usr/local/bin"
16777 #. type: Plain text
16778 #: build/C/man7/mdoc.samples.7:2219
16779 msgid "The above was produced by E<.Li \\&.Dl % ls -ldg /usr/local/bin>."
16782 #. type: Plain text
16783 #: build/C/man7/mdoc.samples.7:2230
16785 "Begin-display. The E<.Ql \\&.Bd> display must be ended with the E<.Ql "
16786 "\\&.Ed> macro. Displays may be nested within displays and lists. E<.Ql "
16787 "\\&.Bd> has the following syntax:"
16791 #: build/C/man7/mdoc.samples.7:2231
16793 msgid ".Bd display-type [-offset offset_value] [-compact]"
16796 #. type: Plain text
16797 #: build/C/man7/mdoc.samples.7:2236
16799 "The display-type must be one of the following four types and may have an "
16800 "offset specifier for indentation: E<.Ql \\&.Bd>."
16803 #. type: Plain text
16804 #: build/C/man7/mdoc.samples.7:2241
16806 "Display a block of text as typed, right (and left) margin edges are left "
16810 #. type: Plain text
16811 #: build/C/man7/mdoc.samples.7:2245
16813 "Display a filled (formatted) block. The block of text is formatted (the "
16814 "edges are filled \\- not left unjustified)."
16817 #. type: Plain text
16818 #: build/C/man7/mdoc.samples.7:2248
16820 "Display a literal block, useful for source code or simple tabbed or spaced "
16825 #: build/C/man7/mdoc.samples.7:2248
16827 msgid "Fl file Ar file_name"
16830 #. type: Plain text
16831 #: build/C/man7/mdoc.samples.7:2257
16833 "The filename following the E<.Fl file> flag is read and displayed. Literal "
16834 "mode is asserted and tabs are set at 8 constant width character intervals, "
16835 "however any E<.Xr troff/ Ns Nm \\-mdoc> commands in file will be processed."
16838 #. type: Plain text
16839 #: build/C/man7/mdoc.samples.7:2263
16841 "If E<.Fl offset> is specified with one of the following strings, the string "
16842 "is interpreted to indicate the level of indentation for the forthcoming "
16846 #. type: Plain text
16847 #: build/C/man7/mdoc.samples.7:2269
16849 "Align block on the current left margin, this is the default mode of E<.Ql "
16853 #. type: Plain text
16854 #: build/C/man7/mdoc.samples.7:2274
16856 "Supposedly center the block. At this time unfortunately, the block merely "
16857 "gets left aligned about an imaginary center margin."
16860 #. type: Plain text
16861 #: build/C/man7/mdoc.samples.7:2283
16863 "Indents by one default indent value or tab. The default indent value is "
16864 "also used for the E<.Ql \\&.D1> display so one is guaranteed the two types "
16865 "of displays will line up. This indent is normally set to 6n or about two "
16866 "thirds of an inch (six constant width characters)."
16869 #. type: Plain text
16870 #: build/C/man7/mdoc.samples.7:2285
16871 msgid "Indents two times the default indent value."
16874 #. type: Plain text
16875 #: build/C/man7/mdoc.samples.7:2293
16877 "This E<.Em left> aligns the block about two inches from the right side of "
16878 "the page. This macro needs work and perhaps may never do the right thing by "
16883 #: build/C/man7/mdoc.samples.7:2295
16888 #. type: Plain text
16889 #: build/C/man7/mdoc.samples.7:2297
16890 msgid "End-display."
16894 #: build/C/man7/mdoc.samples.7:2298
16899 #. type: Plain text
16900 #: build/C/man7/mdoc.samples.7:2300
16901 msgid "There are five macros for changing the appearance of the manual page text:"
16905 #: build/C/man7/mdoc.samples.7:2301
16910 #. type: Plain text
16911 #: build/C/man7/mdoc.samples.7:2306
16913 "Text may be stressed or emphasized with the E<.Ql \\&.Em> macro. The usual "
16914 "font for emphasis is italic."
16918 #: build/C/man7/mdoc.samples.7:2307
16920 msgid "Usage: .Em argument ... \\*(Pu"
16924 #: build/C/man7/mdoc.samples.7:2309
16926 msgid "Li \".Em does not\""
16929 #. type: Plain text
16930 #: build/C/man7/mdoc.samples.7:2311
16931 msgid "E<.Em does not>"
16935 #: build/C/man7/mdoc.samples.7:2311
16937 msgid "Li \".Em exceed 1024 .\""
16940 #. type: Plain text
16941 #: build/C/man7/mdoc.samples.7:2313
16942 msgid "E<.Em exceed 1024>."
16946 #: build/C/man7/mdoc.samples.7:2313
16948 msgid "Li \".Em vide infra ) ) ,\""
16951 #. type: Plain text
16952 #: build/C/man7/mdoc.samples.7:2315
16953 msgid "E<.Em vide infra>)),"
16956 #. type: Plain text
16957 #: build/C/man7/mdoc.samples.7:2323
16959 "The E<.Ql \\&.Em> macro is parsed and is callable. It is an error to call "
16960 "E<.Ql \\&.Em> without arguments."
16964 #: build/C/man7/mdoc.samples.7:2323
16969 #. type: Plain text
16970 #: build/C/man7/mdoc.samples.7:2329
16972 "The E<.Ql \\&.Li> literal macro may be used for special characters, variable "
16973 "constants, anything which should be displayed as it would be typed."
16977 #: build/C/man7/mdoc.samples.7:2330
16979 msgid "Usage: .Li argument ... \\*(Pu"
16983 #: build/C/man7/mdoc.samples.7:2332
16985 msgid "Li \\&.Li \\een"
16988 #. type: Plain text
16989 #: build/C/man7/mdoc.samples.7:2334
16990 msgid "E<.Li \\en>"
16994 #: build/C/man7/mdoc.samples.7:2334
16996 msgid "Li \\&.Li M1 M2 M3\\ ;"
16999 #. type: Plain text
17000 #: build/C/man7/mdoc.samples.7:2336
17001 msgid "E<.Li M1 M2 M3>;"
17005 #: build/C/man7/mdoc.samples.7:2336
17007 msgid "Li \\&.Li cntrl-D\\ )\\ ,"
17010 #. type: Plain text
17011 #: build/C/man7/mdoc.samples.7:2338
17012 msgid "E<.Li cntrl-D>),"
17016 #: build/C/man7/mdoc.samples.7:2338
17018 msgid "Li \\&.Li 1024\\ ..."
17021 #. type: Plain text
17022 #: build/C/man7/mdoc.samples.7:2340
17023 msgid "E<.Li 1024 ...>"
17026 #. type: Plain text
17027 #: build/C/man7/mdoc.samples.7:2345
17028 msgid "The E<.Ql \\&.Li> macro is parsed and is callable."
17032 #: build/C/man7/mdoc.samples.7:2345
17037 #. type: Plain text
17038 #: build/C/man7/mdoc.samples.7:2348
17040 "The symbolic emphasis macro is generally a boldface macro in either the "
17041 "symbolic sense or the traditional English usage."
17045 #: build/C/man7/mdoc.samples.7:2349
17047 msgid "Usage: .Sy symbol ... \\*(Pu"
17051 #: build/C/man7/mdoc.samples.7:2351
17053 msgid "Li \\&.Sy Important Notice"
17056 #. type: Plain text
17057 #: build/C/man7/mdoc.samples.7:2353
17058 msgid "E<.Sy Important Notice>"
17061 #. type: Plain text
17062 #: build/C/man7/mdoc.samples.7:2361
17064 "The E<.Ql \\&.Sy> macro is parsed and is callable. Arguments to E<.Ql "
17065 "\\&.Sy> may be quoted."
17069 #: build/C/man7/mdoc.samples.7:2361
17074 #. type: Plain text
17075 #: build/C/man7/mdoc.samples.7:2371
17077 "Begin font mode. The E<.Ql \\&.Bf> font mode must be ended with the E<.Ql "
17078 "\\&.Ef> macro. Font modes may be nested within other font modes. E<.Ql "
17079 "\\&.Bf> has the following syntax:"
17083 #: build/C/man7/mdoc.samples.7:2372
17085 msgid ".Bf font-mode"
17088 #. type: Plain text
17089 #: build/C/man7/mdoc.samples.7:2376
17090 msgid "The font-mode must be one of the following three types: E<.Ql \\&.Bf>."
17094 #: build/C/man7/mdoc.samples.7:2378
17096 msgid "Sy \\&Em | Fl emphasis"
17099 #. type: Plain text
17100 #: build/C/man7/mdoc.samples.7:2382
17101 msgid "Same as if the E<.Ql \\&.Em> macro was used for the entire block of text."
17105 #: build/C/man7/mdoc.samples.7:2382
17107 msgid "Sy \\&Li | Fl literal"
17110 #. type: Plain text
17111 #: build/C/man7/mdoc.samples.7:2386
17112 msgid "Same as if the E<.Ql \\&.Li> macro was used for the entire block of text."
17116 #: build/C/man7/mdoc.samples.7:2386
17118 msgid "Sy \\&Sy | Fl symbolic"
17121 #. type: Plain text
17122 #: build/C/man7/mdoc.samples.7:2390
17123 msgid "Same as if the E<.Ql \\&.Sy> macro was used for the entire block of text."
17127 #: build/C/man7/mdoc.samples.7:2391
17132 #. type: Plain text
17133 #: build/C/man7/mdoc.samples.7:2393
17134 msgid "End font mode."
17138 #: build/C/man7/mdoc.samples.7:2394
17140 msgid "Tagged Lists and Columns"
17143 #. type: Plain text
17144 #: build/C/man7/mdoc.samples.7:2408
17146 "There are several types of lists which may be initiated with the E<.Ql "
17147 "\".Bl\"> begin-list macro. Items within the list are specified with the "
17148 "E<.Ql \".It\"> item macro and each list must end with the E<.Ql \".El\"> "
17149 "macro. Lists may be nested within themselves and within displays. Columns "
17150 "may be used inside of lists, but lists are unproven inside of columns."
17153 #. type: Plain text
17154 #: build/C/man7/mdoc.samples.7:2423
17156 "In addition, several list attributes may be specified such as the width of a "
17157 "tag, the list offset, and compactness (blank lines between items allowed or "
17158 "disallowed). Most of this document has been formatted with a tag style list "
17159 "E<.Pq Fl tag>. For a change of pace, the list-type used to present the "
17160 "list-types is an over-hanging list E<.Pq Fl ohang>. This type of list is "
17161 "quite popular with E<.Tn TeX> users, but might look a bit funny after having "
17162 "read many pages of tagged lists. The following list types are accepted by "
17167 #: build/C/man7/mdoc.samples.7:2425
17173 #: build/C/man7/mdoc.samples.7:2426
17179 #: build/C/man7/mdoc.samples.7:2427
17184 #. type: Plain text
17185 #: build/C/man7/mdoc.samples.7:2437
17187 "These three are the simplest types of lists. Once the E<.Ql \".Bl\"> macro "
17188 "has been given, items in the list are merely indicated by a line consisting "
17189 "solely of the E<.Ql \".It\"> macro. For example, the source text for a "
17190 "simple enumerated list would look like:"
17193 #. type: Plain text
17194 #: build/C/man7/mdoc.samples.7:2446
17197 "\\&.Bl -enum -compact\n"
17199 "\\&Item one goes here.\n"
17201 "\\&And item two here.\n"
17203 "\\&Lastly item three goes here.\n"
17207 #. type: Plain text
17208 #: build/C/man7/mdoc.samples.7:2449
17209 msgid "The results:"
17212 #. type: Plain text
17213 #: build/C/man7/mdoc.samples.7:2453
17214 msgid "Item one goes here."
17217 #. type: Plain text
17218 #: build/C/man7/mdoc.samples.7:2455
17219 msgid "And item two here."
17222 #. type: Plain text
17223 #: build/C/man7/mdoc.samples.7:2457
17224 msgid "Lastly item three goes here."
17227 #. type: Plain text
17228 #: build/C/man7/mdoc.samples.7:2460
17229 msgid "A simple bullet list construction:"
17232 #. type: Plain text
17233 #: build/C/man7/mdoc.samples.7:2467
17236 "\\&.Bl -bullet -compact\n"
17238 "\\&Bullet one goes here.\n"
17240 "\\&Bullet two here.\n"
17244 #. type: Plain text
17245 #: build/C/man7/mdoc.samples.7:2473
17246 msgid "Bullet one goes here."
17249 #. type: Plain text
17250 #: build/C/man7/mdoc.samples.7:2475
17251 msgid "Bullet two here."
17255 #: build/C/man7/mdoc.samples.7:2477
17261 #: build/C/man7/mdoc.samples.7:2478
17267 #: build/C/man7/mdoc.samples.7:2479
17273 #: build/C/man7/mdoc.samples.7:2480
17279 #: build/C/man7/mdoc.samples.7:2481
17284 #. type: Plain text
17285 #: build/C/man7/mdoc.samples.7:2501
17287 "These list-types collect arguments specified with the E<.Ql \\&.It> macro "
17288 "and create a label which may be E<.Em inset> into the forthcoming text, "
17289 "E<.Em hanged> from the forthcoming text, E<.Em overhanged> from above and "
17290 "not indented or E<.Em tagged>. This list was constructed with the E<.Ql Fl "
17291 "ohang> list-type. The E<.Ql \\&.It> macro is parsed only for the inset, "
17292 "hang and tag list-types and is not callable. Here is an example of inset "
17297 #: build/C/man7/mdoc.samples.7:2502
17302 #. type: Plain text
17303 #: build/C/man7/mdoc.samples.7:2505
17305 "The tagged list (also called a tagged paragraph) is the most common type of "
17306 "list used in the Berkeley manuals."
17310 #: build/C/man7/mdoc.samples.7:2505
17315 #. type: Plain text
17316 #: build/C/man7/mdoc.samples.7:2509
17318 "Diag lists create section four diagnostic lists and are similar to inset "
17319 "lists except callable macros are ignored."
17323 #: build/C/man7/mdoc.samples.7:2509
17328 #. type: Plain text
17329 #: build/C/man7/mdoc.samples.7:2511
17330 msgid "Hanged labels are a matter of taste."
17334 #: build/C/man7/mdoc.samples.7:2511
17339 #. type: Plain text
17340 #: build/C/man7/mdoc.samples.7:2513
17341 msgid "Overhanging labels are nice when space is constrained."
17345 #: build/C/man7/mdoc.samples.7:2513
17350 #. type: Plain text
17351 #: build/C/man7/mdoc.samples.7:2518
17353 "Inset labels are useful for controlling blocks of paragraphs and are "
17354 "valuable for converting E<.Nm \\-mdoc> manuals to other formats."
17357 #. type: Plain text
17358 #: build/C/man7/mdoc.samples.7:2521
17359 msgid "Here is the source text which produced the above example:"
17362 #. type: Plain text
17363 #: build/C/man7/mdoc.samples.7:2540
17366 "\\&.Bl -inset -offset indent\n"
17368 "\\&The tagged list (also called a tagged paragraph) is the\n"
17369 "\\&most common type of list used in the Berkeley manuals.\n"
17371 "\\&Diag lists create section four diagnostic lists\n"
17372 "\\&and are similar to inset lists except callable\n"
17373 "\\¯os are ignored.\n"
17375 "\\&Hanged labels are a matter of taste.\n"
17376 "\\&.It Em Ohang\n"
17377 "\\&Overhanging labels are nice when space is constrained.\n"
17378 "\\&.It Em Inset\n"
17379 "\\&Inset labels are useful for controlling blocks of\n"
17380 "\\¶graphs and are valuable for converting\n"
17382 "\\&manuals to other formats.\n"
17386 #. type: Plain text
17387 #: build/C/man7/mdoc.samples.7:2543
17388 msgid "Here is a hanged list with two items:"
17392 #: build/C/man7/mdoc.samples.7:2544
17397 #. type: Plain text
17398 #: build/C/man7/mdoc.samples.7:2547
17400 "labels appear similar to tagged lists when the label is smaller than the "
17405 #: build/C/man7/mdoc.samples.7:2547
17407 msgid "Em Longer hanged list labels"
17410 #. type: Plain text
17411 #: build/C/man7/mdoc.samples.7:2550
17412 msgid "blend in to the paragraph unlike tagged paragraph labels."
17415 #. type: Plain text
17416 #: build/C/man7/mdoc.samples.7:2553
17417 msgid "And the unformatted text which created it:"
17420 #. type: Plain text
17421 #: build/C/man7/mdoc.samples.7:2562
17424 "\\&.Bl -hang -offset indent\n"
17425 "\\&.It Em Hanged\n"
17426 "\\&labels appear similar to tagged lists when the\n"
17427 "\\&label is smaller than the label width.\n"
17428 "\\&.It Em Longer hanged list labels\n"
17429 "\\&blend in to the paragraph unlike\n"
17430 "\\&tagged paragraph labels.\n"
17434 #. type: Plain text
17435 #: build/C/man7/mdoc.samples.7:2566
17437 "The tagged list which follows uses an optional width specifier to control "
17438 "the width of the tag."
17442 #: build/C/man7/mdoc.samples.7:2568
17447 #. type: Plain text
17448 #: build/C/man7/mdoc.samples.7:2570
17449 msgid "sleep time of the process (seconds blocked)"
17453 #: build/C/man7/mdoc.samples.7:2570
17458 #. type: Plain text
17459 #: build/C/man7/mdoc.samples.7:2575
17461 "number of disk E<.Tn I/O Ns 's> resulting from references by the process to "
17462 "pages not loaded in core."
17466 #: build/C/man7/mdoc.samples.7:2575
17471 #. type: Plain text
17472 #: build/C/man7/mdoc.samples.7:2577
17473 msgid "numerical user-id of process owner"
17477 #: build/C/man7/mdoc.samples.7:2577
17482 #. type: Plain text
17483 #: build/C/man7/mdoc.samples.7:2580
17485 "numerical ID of parent of process process priority (nonpositive when in "
17486 "noninterruptible wait)"
17489 #. type: Plain text
17490 #: build/C/man7/mdoc.samples.7:2583
17491 msgid "The raw text:"
17494 #. type: Plain text
17495 #: build/C/man7/mdoc.samples.7:2598
17498 "\\&.Bl -tag -width \"PAGEIN\" -compact -offset indent\n"
17500 "\\&sleep time of the process (seconds blocked)\n"
17502 "\\&number of disk\n"
17503 "\\&.Tn I/O Ns 's\n"
17504 "\\&resulting from references\n"
17505 "\\&by the process to pages not loaded in core.\n"
17507 "\\&numerical user ID of process owner\n"
17509 "\\&numerical ID of parent of process process priority\n"
17510 "\\&(nonpositive when in noninterruptible wait)\n"
17514 #. type: Plain text
17515 #: build/C/man7/mdoc.samples.7:2601
17516 msgid "Acceptable width specifiers:"
17520 #: build/C/man7/mdoc.samples.7:2602
17522 msgid "Fl width Ar \\&Fl"
17525 #. type: Plain text
17526 #: build/C/man7/mdoc.samples.7:2611
17528 "sets the width to the default width for a flag. All callable macros have a "
17529 "default width value. The E<.Ql \\&.Fl>, value is presently set to ten "
17530 "constant width characters or about five sixth of an inch."
17534 #: build/C/man7/mdoc.samples.7:2611
17536 msgid "Fl width Ar 24n"
17539 #. type: Plain text
17540 #: build/C/man7/mdoc.samples.7:2617
17542 "sets the width to 24 constant width characters or about two inches. The "
17543 "E<.Ql n> is absolutely necessary for the scaling to work correctly."
17547 #: build/C/man7/mdoc.samples.7:2617
17549 msgid "Fl width Ar ENAMETOOLONG"
17552 #. type: Plain text
17553 #: build/C/man7/mdoc.samples.7:2620
17554 msgid "sets width to the constant width length of the string given."
17558 #: build/C/man7/mdoc.samples.7:2620
17560 msgid "Fl width Ar \"\\*qint mkfifo\\*q\""
17563 #. type: Plain text
17564 #: build/C/man7/mdoc.samples.7:2623
17565 msgid "again, the width is set to the constant width of the string given."
17568 #. type: Plain text
17569 #: build/C/man7/mdoc.samples.7:2638
17571 "If a width is not specified for the tag list type, the first time E<.Ql "
17572 "\\&.It> is invoked, an attempt is made to determine an appropriate width. "
17573 "If the first argument to E<.Ql \".It\"> is a callable macro, the default "
17574 "width for that macro will be used as if the macro name had been supplied as "
17575 "the width. However, if another item in the list is given with a different "
17576 "callable macro name, a new and nested list is assumed."
17580 #: build/C/man7/mdoc.samples.7:2638
17582 msgid "PREDEFINED STRINGS"
17585 #. type: Plain text
17586 #: build/C/man7/mdoc.samples.7:2650
17588 "The following strings are predefined as may be used by preceding with the "
17589 "troff string interpreting sequence E<.Ql \\&\\e*(xx> where E<.Em xx> is the "
17590 "name of the defined string or as E<.Ql \\&\\e*x> where E<.Em x> is the name "
17591 "of the string. The interpreting sequence may be used any where in the text."
17595 #: build/C/man7/mdoc.samples.7:2652
17597 msgid "Sy \"String\tNroff\tTroff\""
17601 #: build/C/man7/mdoc.samples.7:2653
17603 msgid "Li E<lt>= Ta \\&E<lt>\\&= Ta \\*(E<lt>="
17607 #: build/C/man7/mdoc.samples.7:2654
17609 msgid "Li E<gt>= Ta \\&E<gt>\\&= Ta \\*(E<gt>="
17613 #: build/C/man7/mdoc.samples.7:2655
17615 msgid "Li Rq Ta '' Ta \\*(Rq"
17619 #: build/C/man7/mdoc.samples.7:2656
17621 msgid "Li Lq Ta `` Ta \\*(Lq"
17625 #: build/C/man7/mdoc.samples.7:2657
17627 msgid "Li ua Ta ^ Ta \\*(ua"
17631 #: build/C/man7/mdoc.samples.7:2658
17633 msgid "Li aa Ta ' Ta \\*(aa"
17637 #: build/C/man7/mdoc.samples.7:2659
17639 msgid "Li ga Ta \\` Ta \\*(ga"
17642 #. .It Li "sL" Ta ` Ta \*(sL
17643 #. .It Li "sR" Ta ' Ta \*(sR
17645 #: build/C/man7/mdoc.samples.7:2662
17647 msgid "Li q Ta \\(dq Ta \\*q"
17651 #: build/C/man7/mdoc.samples.7:2663
17653 msgid "Li Pi Ta pi Ta \\*(Pi"
17657 #: build/C/man7/mdoc.samples.7:2664
17659 msgid "Li Ne Ta != Ta \\*(Ne"
17663 #: build/C/man7/mdoc.samples.7:2665
17665 msgid "Li Le Ta E<lt>= Ta \\*(Le"
17669 #: build/C/man7/mdoc.samples.7:2666
17671 msgid "Li Ge Ta E<gt>= Ta \\*(Ge"
17675 #: build/C/man7/mdoc.samples.7:2667
17677 msgid "Li Lt Ta E<lt> Ta \\*(Gt"
17681 #: build/C/man7/mdoc.samples.7:2668
17683 msgid "Li Gt Ta E<gt> Ta \\*(Lt"
17687 #: build/C/man7/mdoc.samples.7:2669
17689 msgid "Li Pm Ta +- Ta \\*(Pm"
17693 #: build/C/man7/mdoc.samples.7:2670
17695 msgid "Li If Ta infinity Ta \\*(If"
17699 #: build/C/man7/mdoc.samples.7:2671
17701 msgid "Li Na Ta I<NaN> Ta \\*(Na"
17705 #: build/C/man7/mdoc.samples.7:2672
17707 msgid "Li Ba Ta \\&| Ta \\*(Ba"
17710 #. type: Plain text
17711 #: build/C/man7/mdoc.samples.7:2681
17713 "E<.Sy Note>: The string named E<.Ql q> should be written as E<.Ql \\e*q> "
17714 "since it is only one char."
17718 #: build/C/man7/mdoc.samples.7:2681
17720 msgid "DIAGNOSTICS"
17723 #. type: Plain text
17724 #: build/C/man7/mdoc.samples.7:2714
17726 "The debugging facilities for E<.Nm \\-mdoc> are limited, but can help detect "
17727 "subtle errors such as the collision of an argument name with an internal "
17728 "register or macro name. (A what?) A register is an arithmetic storage "
17729 "class for E<.Xr troff> with a one or two character name. All registers "
17730 "internal to E<.Nm \\-mdoc> for E<.Xr troff> and E<.Xr ditroff> are two "
17731 "characters and of the form E<lt>upper_caseE<gt>E<lt>lower_caseE<gt> such as "
17732 "E<.Ql \\&Ar>, E<lt>lower_caseE<gt>E<lt>upper_caseE<gt> as E<.Ql \\&aR> or "
17733 "E<lt>upper or lower letterE<gt>E<lt>digitE<gt> as E<.Ql \\&C\\&1>. And "
17734 "adding to the muddle, E<.Xr troff> has its own internal registers all of "
17735 "which are either two lower case characters or a dot plus a letter or "
17736 "metacharacter character. In one of the introduction examples, it was shown "
17737 "how to prevent the interpretation of a macro name with the escape sequence "
17738 "E<.Ql \\e&>. This is sufficient for the internal register names also."
17741 #. Every callable macro name has a corresponding register
17742 #. of the same name (<upper_case><lower_case>).
17743 #. There are also specific registers which have
17744 #. been used for stacks and arrays and are listed in the
17746 #. .Bd -ragged -offset 4n
17747 #. [A-Z][a-z] registers corresponding to macro names (example ``Ar'')
17748 #. [a-z][A-Z] registers corresponding to macro names (example ``aR'')
17749 #. C[0-9] argument types (example C1)
17750 #. O[0-9] offset stack (displays)
17751 #. h[0-9] horizontal spacing stack (lists)
17752 #. o[0-9] offset (stack) (lists)
17753 #. t[0-9] tag stack (lists)
17754 #. v[0-9] vertical spacing stack (lists)
17755 #. w[0-9] width tag/label stack
17758 #. type: Plain text
17759 #: build/C/man7/mdoc.samples.7:2753
17761 "If a nonescaped register name is given in the argument list of a request "
17762 "unpredictable behavior will occur. In general, any time huge portions of "
17763 "text do not appear where expected in the output, or small strings such as "
17764 "list tags disappear, chances are there is a misunderstanding about an "
17765 "argument type in the argument list. Your mother never intended for you to "
17766 "remember this evil stuff - so here is a way to find out whether or not your "
17767 "arguments are valid: The E<.Ql \\&.Db> (debug) macro displays the "
17768 "interpretation of the argument list for most macros. Macros such as the "
17769 "E<.Ql \\&.Pp> (paragraph) macro do not contain debugging information. All "
17770 "of the callable macros do, and it is strongly advised whenever in doubt, "
17771 "turn on the E<.Ql \\&.Db> macro."
17775 #: build/C/man7/mdoc.samples.7:2754
17777 msgid "Usage: \\&.Db [on | off]"
17780 #. type: Plain text
17781 #: build/C/man7/mdoc.samples.7:2763
17783 "An example of a portion of text with the debug macro placed above and below "
17784 "an artificially created problem (a flag argument E<.Ql \\&aC> which should "
17785 "be E<.Ql \\e&aC> in order to work):"
17788 #. type: Plain text
17789 #: build/C/man7/mdoc.samples.7:2767
17793 "\\&.Op Fl aC Ar file )\n"
17797 #. type: Plain text
17798 #: build/C/man7/mdoc.samples.7:2770
17799 msgid "The resulting output:"
17802 #. type: Plain text
17803 #: build/C/man7/mdoc.samples.7:2785
17807 "DEBUG(argv) MACRO: `.Op' Line #: 2\n"
17808 "\tArgc: 1 Argv: `Fl' Length: 2\n"
17809 "\tSpace: `' Class: Executable\n"
17810 "\tArgc: 2 Argv: `aC' Length: 2\n"
17811 "\tSpace: `' Class: Executable\n"
17812 "\tArgc: 3 Argv: `Ar' Length: 2\n"
17813 "\tSpace: `' Class: Executable\n"
17814 "\tArgc: 4 Argv: `file' Length: 4\n"
17815 "\tSpace: ` ' Class: String\n"
17816 "\tArgc: 5 Argv: `)' Length: 1\n"
17817 "\tSpace: ` ' Class: Closing Punctuation or suffix\n"
17818 "\tMACRO REQUEST: .Op Fl aC Ar file )\n"
17822 #. type: Plain text
17823 #: build/C/man7/mdoc.samples.7:2812
17825 "The first line of information tells the name of the calling macro, here "
17826 "E<.Ql \\&.Op>, and the line number it appears on. If one or more files are "
17827 "involved (especially if text from another file is included) the line number "
17828 "may be bogus. If there is only one file, it should be accurate. The second "
17829 "line gives the argument count, the argument E<.Pq Ql \\&Fl> and its length. "
17830 "If the length of an argument is two characters, the argument is tested to "
17831 "see if it is executable (unfortunately, any register which contains a "
17832 "nonzero value appears executable). The third line gives the space allotted "
17833 "for a class, and the class type. The problem here is the argument aC should "
17834 "not be executable. The four types of classes are string, executable, "
17835 "closing punctuation and opening punctuation. The last line shows the entire "
17836 "argument list as it was read. In this next example, the offending E<.Ql "
17837 "\\&aC> is escaped:"
17840 #. type: Plain text
17841 #: build/C/man7/mdoc.samples.7:2816
17845 "\\&.Em An escaped \\e&aC\n"
17849 #. type: Plain text
17850 #: build/C/man7/mdoc.samples.7:2828
17854 "DEBUG(fargv) MACRO: `.Em' Line #: 2\n"
17855 "\tArgc: 1 Argv: `An' Length: 2\n"
17856 "\tSpace: ` ' Class: String\n"
17857 "\tArgc: 2 Argv: `escaped' Length: 7\n"
17858 "\tSpace: ` ' Class: String\n"
17859 "\tArgc: 3 Argv: `aC' Length: 2\n"
17860 "\tSpace: ` ' Class: String\n"
17861 "\tMACRO REQUEST: .Em An escaped &aC\n"
17865 #. type: Plain text
17866 #: build/C/man7/mdoc.samples.7:2838
17868 "The argument E<.Ql \\e&aC> shows up with the same length of 2 as the E<.Ql "
17869 "\\e&> sequence produces a zero width, but a register named E<.Ql \\e&aC> was "
17870 "not found and the type classified as string."
17873 #. type: Plain text
17874 #: build/C/man7/mdoc.samples.7:2840
17875 msgid "Other diagnostics consist of usage statements and are self explanatory."
17879 #: build/C/man7/mdoc.samples.7:2840
17881 msgid "GROFF, TROFF AND NROFF"
17884 #. type: Plain text
17885 #: build/C/man7/mdoc.samples.7:2845
17887 "The E<.Nm \\-mdoc> package does not need compatibility mode with E<.Xr "
17891 #. type: Plain text
17892 #: build/C/man7/mdoc.samples.7:2863
17894 "The package inhibits page breaks, and the headers and footers which normally "
17895 "occur at those breaks with E<.Xr nroff>, to make the manual more efficient "
17896 "for viewing on-line. At the moment, E<.Xr groff> with E<.Fl T Ns Ar ascii> "
17897 "does eject the imaginary remainder of the page at end of file. The "
17898 "inhibiting of the page breaks makes E<.Xr nroff Ns 'd> files unsuitable for "
17899 "hardcopy. There is a register named E<.Ql \\&cR> which can be set to zero "
17900 "in the site dependent style file E<.Pa /usr/src/share/tmac/doc-nroff> to "
17901 "restore the old style behavior."
17905 #: build/C/man7/mdoc.samples.7:2865
17907 msgid "Pa /usr/share/tmac/doc.tmac"
17910 #. type: Plain text
17911 #: build/C/man7/mdoc.samples.7:2867
17912 msgid "manual macro package"
17916 #: build/C/man7/mdoc.samples.7:2867
17918 msgid "Pa /usr/share/misc/mdoc.template"
17921 #. type: Plain text
17922 #: build/C/man7/mdoc.samples.7:2869
17923 msgid "template for writing a man page"
17927 #: build/C/man7/mdoc.samples.7:2869
17929 msgid "Pa /usr/share/examples/mdoc/*"
17932 #. type: Plain text
17933 #: build/C/man7/mdoc.samples.7:2871
17934 msgid "several example man pages"
17937 #. type: Plain text
17938 #: build/C/man7/mdoc.samples.7:2879
17940 "Undesirable hyphenation on the dash of a flag argument is not yet resolved, "
17941 "and causes occasional mishaps in the E<.Sx DESCRIPTION> section. (line "
17942 "break on the hyphen)."
17945 #. type: Plain text
17946 #: build/C/man7/mdoc.samples.7:2881
17947 msgid "Predefined strings are not declared in documentation."
17950 #. type: Plain text
17951 #: build/C/man7/mdoc.samples.7:2883
17952 msgid "Section 3f has not been added to the header routines."
17955 #. type: Plain text
17956 #: build/C/man7/mdoc.samples.7:2888
17957 msgid "E<.Ql \\&.Nm> font should be changed in E<.Sx NAME> section."
17960 #. type: Plain text
17961 #: build/C/man7/mdoc.samples.7:2895
17963 "E<.Ql \\&.Fn> needs to have a check to prevent splitting up if the line "
17964 "length is too short. Occasionally it separates the last parenthesis, and "
17965 "sometimes looks ridiculous if a line is in fill mode."
17968 #. type: Plain text
17969 #: build/C/man7/mdoc.samples.7:2900
17971 "The method used to prevent header and footer page breaks (other than the "
17972 "initial header and footer) when using nroff occasionally places an unsightly "
17973 "partially filled line (blank) at the would be bottom of the page."
17976 #. Note what happens if the parameter list overlaps a newline
17978 #. to make sure a line boundary is crossed:
17980 #. \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
17983 #. produces, nudge nudge,
17984 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
17985 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
17987 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
17989 #. If double quotes are used, for example:
17991 #. \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
17994 #. produces, nudge nudge,
17995 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
17997 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
17999 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
18001 #. Not a pretty sight...
18002 #. In a paragraph, a long parameter containing unpaddable spaces as
18003 #. in the former example will cause
18005 #. to break the line and spread
18006 #. the remaining words out.
18007 #. The latter example will adjust nicely to
18008 #. justified margins, but may break in between an argument and its
18012 #. the right margin adjustment is normally ragged and the problem is
18014 #. type: Plain text
18015 #: build/C/man7/mdoc.samples.7:2941
18017 "The list and display macros to not do any keeps and certainly should be able "
18021 #. type: Plain text
18022 #: build/C/man7/mdoc.samples.7:2945
18023 msgid "E<.Xr man 1>, E<.Xr troff 1>, E<.Xr groff_mdoc 7>, E<.Xr mdoc 7>"