1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2013-07-15 16:07+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man7/feature_test_macros.7:25
22 msgid "FEATURE_TEST_MACROS"
26 #: build/C/man7/feature_test_macros.7:25 build/C/man7/libc.7:26 build/C/man7/man.7:34 build/C/man7/standards.7:26 build/C/man7/units.7:26
32 #: build/C/man7/feature_test_macros.7:25 build/C/man1/intro.1:28 build/C/man2/intro.2:29 build/C/man3/intro.3:26 build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29 build/C/man7/libc.7:26 build/C/man7/mailaddr.7:27 build/C/man7/man-pages.7:30 build/C/man7/man.7:34 build/C/man7/mdoc.7:44 build/C/man7/operator.7:40 build/C/man5/proc.5:62 build/C/man7/standards.7:26 build/C/man7/suffixes.7:40 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:26 build/C/man7/units.7:26
38 #: build/C/man7/feature_test_macros.7:25 build/C/man2/intro.2:29 build/C/man3/intro.3:26 build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29 build/C/man7/libc.7:26 build/C/man7/man-pages.7:30 build/C/man7/man.7:34 build/C/man7/operator.7:40 build/C/man7/posixoptions.7:24 build/C/man5/proc.5:62 build/C/man7/standards.7:26 build/C/man7/suffixes.7:40 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:26 build/C/man7/units.7:26
40 msgid "Linux Programmer's Manual"
44 #: build/C/man7/feature_test_macros.7:26 build/C/man1/intro.1:29 build/C/man2/intro.2:30 build/C/man3/intro.3:27 build/C/man4/intro.4:27 build/C/man5/intro.5:28 build/C/man6/intro.6:27 build/C/man7/intro.7:29 build/C/man8/intro.8:30 build/C/man7/libc.7:27 build/C/man7/mailaddr.7:29 build/C/man7/man-pages.7:31 build/C/man7/man.7:35 build/C/man7/mdoc.7:45 build/C/man7/operator.7:41 build/C/man7/posixoptions.7:25 build/C/man5/proc.5:63 build/C/man7/standards.7:27 build/C/man7/suffixes.7:41 build/C/man3/undocumented.3:30 build/C/man2/unimplemented.2:27 build/C/man7/units.7:27 build/C/man7/mdoc.samples.7:46
50 #: build/C/man7/feature_test_macros.7:28
51 msgid "feature_test_macros - feature test macros"
55 #: build/C/man7/feature_test_macros.7:28 build/C/man7/man-pages.7:33 build/C/man7/man.7:37 build/C/man7/mdoc.7:50 build/C/man3/undocumented.3:32 build/C/man2/unimplemented.2:31 build/C/man7/mdoc.samples.7:52
61 #: build/C/man7/feature_test_macros.7:31
63 msgid "B<#include E<lt>features.hE<gt>>\n"
67 #: build/C/man7/feature_test_macros.7:32 build/C/man1/intro.1:31 build/C/man2/intro.2:32 build/C/man3/intro.3:29 build/C/man4/intro.4:29 build/C/man5/intro.5:30 build/C/man6/intro.6:29 build/C/man7/intro.7:31 build/C/man8/intro.8:32 build/C/man7/libc.7:29 build/C/man7/mailaddr.7:31 build/C/man7/man-pages.7:37 build/C/man7/man.7:49 build/C/man7/mdoc.7:54 build/C/man7/operator.7:43 build/C/man7/posixoptions.7:27 build/C/man5/proc.5:65 build/C/man7/standards.7:29 build/C/man7/suffixes.7:43 build/C/man3/undocumented.3:34 build/C/man2/unimplemented.2:33 build/C/man7/units.7:29 build/C/man7/mdoc.samples.7:54
73 #: build/C/man7/feature_test_macros.7:35
75 "Feature test macros allow the programmer to control the definitions that are "
76 "exposed by system header files when a program is compiled."
80 #: build/C/man7/feature_test_macros.7:43
82 "B<NOTE:> In order to be effective, a feature test macro I<must be defined "
83 "before including any header files>. This can be done either in the "
84 "compilation command (I<cc -DMACRO=value>) or by defining the macro within "
85 "the source code before including any headers."
89 #: build/C/man7/feature_test_macros.7:52
91 "Some feature test macros are useful for creating portable applications, by "
92 "preventing nonstandard definitions from being exposed. Other macros can be "
93 "used to expose nonstandard definitions that are not exposed by default. The "
94 "precise effects of each of the feature test macros described below can be "
95 "ascertained by inspecting the I<E<lt>features.hE<gt>> header file."
99 #: build/C/man7/feature_test_macros.7:52
101 msgid "Specification of feature test macro requirements in manual pages"
105 #: build/C/man7/feature_test_macros.7:58
107 "When a function requires that a feature test macro is defined, the manual "
108 "page SYNOPSIS typically includes a note of the following form (this example "
109 "from the B<acct>(2) manual page):"
113 #: build/C/man7/feature_test_macros.7:61
114 msgid "B<#include E<lt>unistd.hE<gt>>"
118 #: build/C/man7/feature_test_macros.7:63
119 msgid "B<int acct(const char *>I<filename>B<);>"
123 #: build/C/man7/feature_test_macros.7:68
126 "Feature Test Macro Requirements for glibc (see\n"
127 "B<feature_test_macros>(7)):\n"
131 #: build/C/man7/feature_test_macros.7:73
132 msgid "B<acct>(): _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE\\ E<lt>\\ 500)"
136 #: build/C/man7/feature_test_macros.7:84
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:89
147 "#define _BSD_SOURCE\n"
148 "#define _XOPEN_SOURCE /* or any value E<lt> 500 */\n"
152 #: build/C/man7/feature_test_macros.7:94
154 "Alternatively, equivalent definitions can be included in the compilation "
159 #: build/C/man7/feature_test_macros.7:99
163 "cc -D_XOPEN_SOURCE # Or any value E<lt> 500\n"
167 #: build/C/man7/feature_test_macros.7:107
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:111
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:116
185 "B<#define _GNU_SOURCE>\n"
186 "B<#include E<lt>fcntl.hE<gt>>\n"
190 #: build/C/man7/feature_test_macros.7:118
193 "B<ssize_t readahead(int >I<fd>B<, off64_t *>I<offset>B<, size_t "
198 #: build/C/man7/feature_test_macros.7:124
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:124
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:132
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:134
223 msgid "Linux glibc understands the following feature test macros:"
227 #: build/C/man7/feature_test_macros.7:134
229 msgid "B<__STRICT_ANSI__>"
233 #: build/C/man7/feature_test_macros.7:144
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:144
242 msgid "B<_POSIX_C_SOURCE>"
246 #: build/C/man7/feature_test_macros.7:147 build/C/man7/feature_test_macros.7:178
247 msgid "Defining this macro causes header files to expose definitions as follows:"
251 #: build/C/man7/feature_test_macros.7:148 build/C/man7/feature_test_macros.7:151 build/C/man7/feature_test_macros.7:154 build/C/man7/feature_test_macros.7:158 build/C/man7/feature_test_macros.7:161 build/C/man7/feature_test_macros.7:165 build/C/man7/feature_test_macros.7:179 build/C/man7/feature_test_macros.7:182 build/C/man7/feature_test_macros.7:185 build/C/man7/feature_test_macros.7:189 build/C/man7/feature_test_macros.7:414 build/C/man7/feature_test_macros.7:419 build/C/man7/feature_test_macros.7:425 build/C/man7/feature_test_macros.7:430 build/C/man7/feature_test_macros.7:436 build/C/man7/feature_test_macros.7:441 build/C/man5/proc.5:2569 build/C/man5/proc.5:2571 build/C/man5/proc.5:2573 build/C/man5/proc.5:2576
257 #: build/C/man7/feature_test_macros.7:151
258 msgid "The value 1 exposes definitions conforming to POSIX.1-1990 and ISO C (1990)."
262 #: build/C/man7/feature_test_macros.7:154
263 msgid "The value 2 or greater additionally exposes definitions for POSIX.2-1992."
266 #. 199506L functionality is available only since glibc 2.1
268 #: build/C/man7/feature_test_macros.7:158
270 "The value 199309L or greater additionally exposes definitions for POSIX.1b "
271 "(real-time extensions)."
275 #: build/C/man7/feature_test_macros.7:161
277 "The value 199506L or greater additionally exposes definitions for POSIX.1c "
282 #: build/C/man7/feature_test_macros.7:165
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:169
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:170
300 msgid "B<_POSIX_SOURCE>"
304 #: build/C/man7/feature_test_macros.7:175
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:175
313 msgid "B<_XOPEN_SOURCE>"
317 #: build/C/man7/feature_test_macros.7:182
319 "Defining with any value exposes definitions conforming to POSIX.1, POSIX.2, "
324 #: build/C/man7/feature_test_macros.7:185
326 "The value 500 or greater additionally exposes definitions for SUSv2 (UNIX "
331 #: build/C/man7/feature_test_macros.7:189
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:193
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:194
349 msgid "B<_XOPEN_SOURCE_EXTENDED>"
353 #: build/C/man7/feature_test_macros.7:203
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:203
364 msgid "B<_ISOC95_SOURCE>"
368 #: build/C/man7/feature_test_macros.7:213
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:213
380 msgid "B<_ISOC99_SOURCE>"
384 #: build/C/man7/feature_test_macros.7:222
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:222
396 msgid "B<_ISOC11_SOURCE>"
400 #: build/C/man7/feature_test_macros.7:226
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:226
409 msgid "B<_LARGEFILE64_SOURCE>"
413 #: build/C/man7/feature_test_macros.7:247
415 "Expose definitions for the alternative API specified by the LFS (Large File "
416 "Summit) as a \"transitional extension\" to the Single UNIX Specification. "
417 "(See E<.UR http:\\:/\\:/opengroup.org\\:/platform\\:/lfs.html> E<.UE )> The "
418 "alternative API consists of a set of new objects (i.e., functions and types) "
419 "whose names are suffixed with \"64\" (e.g., I<off64_t> versus I<off_t>, "
420 "B<lseek64>() versus B<lseek>(), etc.). New programs should not employ this "
421 "interface; instead I<_FILE_OFFSET_BITS=64> should be employed."
425 #: build/C/man7/feature_test_macros.7:247
427 msgid "B<_FILE_OFFSET_BITS>"
431 #: build/C/man7/feature_test_macros.7:259
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:259
446 msgid "B<_BSD_SOURCE>"
450 #: build/C/man7/feature_test_macros.7:273
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:273
463 msgid "B<_SVID_SOURCE>"
467 #: build/C/man7/feature_test_macros.7:279
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:279
477 msgid "B<_ATFILE_SOURCE> (since glibc 2.4)"
481 #: build/C/man7/feature_test_macros.7:288
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:288
492 msgid "B<_GNU_SOURCE>"
496 #: build/C/man7/feature_test_macros.7:310
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:310
512 msgid "B<_REENTRANT>"
516 #: build/C/man7/feature_test_macros.7:316
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:316
525 msgid "B<_THREAD_SAFE>"
529 #: build/C/man7/feature_test_macros.7:321
531 "Synonym for B<_REENTRANT>, provided for compatibility with some other "
536 #: build/C/man7/feature_test_macros.7:321
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:367
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:367
570 msgid "Default definitions, implicit definitions, and combining definitions"
574 #: build/C/man7/feature_test_macros.7:379
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:395
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:406
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:407 build/C/man7/feature_test_macros.7:410 build/C/man7/man-pages.7:342 build/C/man7/man-pages.7:344 build/C/man7/man-pages.7:346 build/C/man7/man-pages.7:542 build/C/man7/man-pages.7:545 build/C/man7/man-pages.7:552 build/C/man7/man-pages.7:556 build/C/man7/man-pages.7:560 build/C/man7/man-pages.7:564 build/C/man7/man-pages.7:570 build/C/man5/proc.5:753 build/C/man5/proc.5:757 build/C/man5/proc.5:760 build/C/man5/proc.5:762 build/C/man5/proc.5:765 build/C/man5/proc.5:1241 build/C/man5/proc.5:1244 build/C/man5/proc.5:1256 build/C/man5/proc.5:1259 build/C/man5/proc.5:1263 build/C/man5/proc.5:1266 build/C/man5/proc.5:1269 build/C/man5/proc.5:1272 build/C/man5/proc.5:1275 build/C/man5/proc.5:1278 build/C/man5/proc.5:1281 build/C/man5/proc.5:1284 build/C/man5/proc.5:1288 build/C/man5/proc.5:1291 build/C/man5/proc.5:1294 build/C/man5/proc.5:1297 build/C/man5/proc.5:1300 build/C/man5/proc.5:1303 build/C/man5/proc.5:1306 build/C/man5/proc.5:1317 build/C/man5/proc.5:1323 build/C/man5/proc.5:1327 build/C/man5/proc.5:1332 build/C/man5/proc.5:1337 build/C/man5/proc.5:1342 build/C/man5/proc.5:1347 build/C/man5/proc.5:1352 build/C/man5/proc.5:1357 build/C/man5/proc.5:2347 build/C/man5/proc.5:2351 build/C/man5/proc.5:2354 build/C/man5/proc.5:2359 build/C/man5/proc.5:2556 build/C/man5/proc.5:2560 build/C/man5/proc.5:2566 build/C/man5/proc.5:2605 build/C/man5/proc.5:2611 build/C/man5/proc.5:2613
607 #: build/C/man7/feature_test_macros.7:410
608 msgid "B<_POSIX_SOURCE> is defined with the value 1; and"
612 #: build/C/man7/feature_test_macros.7:413
613 msgid "B<_POSIX_C_SOURCE> is defined with one of the following values:"
617 #: build/C/man7/feature_test_macros.7:419
618 msgid "2, if B<XOPEN_SOURCE> is defined with a value less than 500;"
622 #: build/C/man7/feature_test_macros.7:425
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:430
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:436
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:441
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:450
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:454
660 msgid "Multiple macros can be defined; the results are additive."
664 #: build/C/man7/feature_test_macros.7:454 build/C/man2/intro.2:70 build/C/man3/intro.3:87 build/C/man7/suffixes.7:277
666 msgid "CONFORMING TO"
670 #: build/C/man7/feature_test_macros.7:462
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:466
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:476
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:476 build/C/man1/intro.1:48 build/C/man2/intro.2:75 build/C/man3/intro.3:92 build/C/man4/intro.4:33 build/C/man5/intro.5:33 build/C/man6/intro.6:32 build/C/man7/intro.7:36 build/C/man8/intro.8:44 build/C/man7/man.7:479 build/C/man5/proc.5:3432 build/C/man2/unimplemented.2:40
699 #: build/C/man7/feature_test_macros.7:483
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:495
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:495 build/C/man7/man-pages.7:590
726 #: build/C/man7/feature_test_macros.7:501
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:528
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:530
767 msgid "Program source"
771 #: build/C/man7/feature_test_macros.7:534
773 msgid "/* ftm.c */\n"
777 #: build/C/man7/feature_test_macros.7:538
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:545
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:549
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:553
810 "#ifdef _ISOC99_SOURCE\n"
811 " printf(\"_ISOC99_SOURCE defined\\en\");\n"
816 #: build/C/man7/feature_test_macros.7:557
819 "#ifdef _XOPEN_SOURCE\n"
820 " printf(\"_XOPEN_SOURCE defined: %d\\en\", _XOPEN_SOURCE);\n"
825 #: build/C/man7/feature_test_macros.7:561
828 "#ifdef _XOPEN_SOURCE_EXTENDED\n"
829 " printf(\"_XOPEN_SOURCE_EXTENDED defined\\en\");\n"
834 #: build/C/man7/feature_test_macros.7:565
837 "#ifdef _LARGEFILE64_SOURCE\n"
838 " printf(\"_LARGEFILE64_SOURCE defined\\en\");\n"
843 #: build/C/man7/feature_test_macros.7:569
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:573
855 "#ifdef _BSD_SOURCE\n"
856 " printf(\"_BSD_SOURCE defined\\en\");\n"
861 #: build/C/man7/feature_test_macros.7:577
864 "#ifdef _SVID_SOURCE\n"
865 " printf(\"_SVID_SOURCE defined\\en\");\n"
870 #: build/C/man7/feature_test_macros.7:581
873 "#ifdef _ATFILE_SOURCE\n"
874 " printf(\"_ATFILE_SOURCE defined\\en\");\n"
879 #: build/C/man7/feature_test_macros.7:585
882 "#ifdef _GNU_SOURCE\n"
883 " printf(\"_GNU_SOURCE defined\\en\");\n"
888 #: build/C/man7/feature_test_macros.7:589
891 "#ifdef _REENTRANT\n"
892 " printf(\"_REENTRANT defined\\en\");\n"
897 #: build/C/man7/feature_test_macros.7:593
900 "#ifdef _THREAD_SAFE\n"
901 " printf(\"_THREAD_SAFE defined\\en\");\n"
906 #: build/C/man7/feature_test_macros.7:597
909 "#ifdef _FORTIFY_SOURCE\n"
910 " printf(\"_FORTIFY_SOURCE defined\\en\");\n"
915 #: build/C/man7/feature_test_macros.7:600
918 " exit(EXIT_SUCCESS);\n"
923 #: build/C/man7/feature_test_macros.7:601 build/C/man1/intro.1:302 build/C/man2/intro.2:89 build/C/man3/intro.3:97 build/C/man4/intro.4:38 build/C/man5/intro.5:38 build/C/man7/intro.7:41 build/C/man7/libc.7:99 build/C/man7/mailaddr.7:117 build/C/man7/man-pages.7:597 build/C/man7/man.7:560 build/C/man7/mdoc.7:428 build/C/man7/posixoptions.7:854 build/C/man5/proc.5:3445 build/C/man7/standards.7:267 build/C/man7/suffixes.7:281 build/C/man2/unimplemented.2:64 build/C/man7/mdoc.samples.7:2952
929 #: build/C/man7/feature_test_macros.7:604
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:608
936 msgid "The section \"Feature Test Macros\" under I<info libc>."
940 #: build/C/man7/feature_test_macros.7:610
941 msgid "I</usr/include/features.h>"
945 #: build/C/man7/feature_test_macros.7:610 build/C/man1/intro.1:304 build/C/man2/intro.2:112 build/C/man3/intro.3:110 build/C/man4/intro.4:40 build/C/man5/intro.5:40 build/C/man6/intro.6:37 build/C/man7/intro.7:43 build/C/man8/intro.8:49 build/C/man7/libc.7:104 build/C/man7/mailaddr.7:127 build/C/man7/man-pages.7:604 build/C/man7/man.7:572 build/C/man7/mdoc.7:433 build/C/man7/operator.7:65 build/C/man7/posixoptions.7:857 build/C/man5/proc.5:3476 build/C/man7/standards.7:271 build/C/man7/suffixes.7:284 build/C/man3/undocumented.3:183 build/C/man2/unimplemented.2:66 build/C/man7/units.7:130 build/C/man7/mdoc.samples.7:2957
951 #: build/C/man7/feature_test_macros.7:617 build/C/man1/intro.1:311 build/C/man2/intro.2:119 build/C/man3/intro.3:117 build/C/man4/intro.4:47 build/C/man5/intro.5:47 build/C/man6/intro.6:44 build/C/man7/intro.7:50 build/C/man8/intro.8:56 build/C/man7/libc.7:111 build/C/man7/mailaddr.7:134 build/C/man7/man-pages.7:611 build/C/man7/man.7:579 build/C/man7/operator.7:72 build/C/man7/posixoptions.7:864 build/C/man5/proc.5:3483 build/C/man7/standards.7:278 build/C/man7/suffixes.7:291 build/C/man3/undocumented.3:190 build/C/man2/unimplemented.2:73 build/C/man7/units.7:137
953 "This page is part of release 3.52 of the Linux I<man-pages> project. A "
954 "description of the project, and information about reporting bugs, can be "
955 "found at \\%http://www.kernel.org/doc/man-pages/."
959 #: build/C/man1/intro.1:28 build/C/man2/intro.2:29 build/C/man3/intro.3:26 build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29
965 #: build/C/man1/intro.1:28
971 #: build/C/man1/intro.1:28 build/C/man7/mailaddr.7:27
973 msgid "Linux User's Manual"
977 #: build/C/man1/intro.1:31
978 msgid "intro - introduction to user commands"
982 #: build/C/man1/intro.1:35
984 "Section 1 of the manual describes user commands and tools, for example, file "
985 "manipulation tools, shells, compilers, web browsers, file and image viewers "
986 "and editors, and so on."
990 #: build/C/man1/intro.1:48
992 "All commands yield a status value on termination. This value can be tested "
993 "(e.g., in most shells the variable I<$?> contains the status of the last "
994 "executed command) to see whether the command completed successfully. A "
995 "zero exit status is conventionally used to indicate success, and a nonzero "
996 "status means that the command was unsuccessful. (Details of the exit status "
997 "can be found in B<wait>(2).) A nonzero exit status can be in the range 1 to "
998 "255, and some commands use different nonzero status values to indicate the "
999 "reason why the command failed."
1003 #: build/C/man1/intro.1:52
1005 "Linux is a flavor of UNIX, and as a first approximation all user commands "
1006 "under UNIX work precisely the same under Linux (and FreeBSD and lots of "
1007 "other UNIX-like systems)."
1011 #: build/C/man1/intro.1:62
1013 "Under Linux there are GUIs (graphical user interfaces), where you can point "
1014 "and click and drag, and hopefully get work done without first reading lots "
1015 "of documentation. The traditional UNIX environment is a CLI (command line "
1016 "interface), where you type commands to tell the computer what to do. That "
1017 "is faster and more powerful, but requires finding out what the commands "
1018 "are. Below a bare minimum, to get started."
1022 #: build/C/man1/intro.1:62
1028 #: build/C/man1/intro.1:76
1030 "In order to start working, you probably first have to login, that is, give "
1031 "your username and password. See also B<login>(1). The program I<login> now "
1032 "starts a I<shell> (command interpreter) for you. In case of a graphical "
1033 "login, you get a screen with menus or icons and a mouse click will start a "
1034 "shell in a window. See also B<xterm>(1)."
1038 #: build/C/man1/intro.1:76
1044 #: build/C/man1/intro.1:91
1046 "One types commands to the I<shell>, the command interpreter. It is not "
1047 "built-in, but is just a program and you can change your shell. Everybody "
1048 "has her own favorite one. The standard one is called I<sh>. See also "
1049 "B<ash>(1), B<bash>(1), B<csh>(1), B<zsh>(1), B<chsh>(1)."
1053 #: build/C/man1/intro.1:93
1054 msgid "A session might go like"
1058 #: build/C/man1/intro.1:108
1061 "B<knuth login: >I<aeb>\n"
1062 "B<Password: >I<********>\n"
1064 "Tue Aug 6 23:50:44 CEST 2002\n"
1067 "Su Mo Tu We Th Fr Sa\n"
1070 "11 12 13 14 15 16 17\n"
1071 "18 19 20 21 22 23 24\n"
1072 "25 26 27 28 29 30 31\n"
1076 #: build/C/man1/intro.1:135
1083 "drwxrwxr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1084 "-rw-rw-r-- 1 aeb 37 Aug 6 23:52 tel\n"
1086 "maja 0501-1136285\n"
1087 "peter 0136-7399214\n"
1088 "B<% >I<cp tel tel2>\n"
1091 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1092 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel\n"
1093 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1094 "B<% >I<mv tel tel1>\n"
1097 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1098 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel1\n"
1099 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1100 "B<% >I<diff tel1 tel2>\n"
1102 "B<% >I<grep maja tel2>\n"
1103 "maja 0501-1136285\n"
1108 #: build/C/man1/intro.1:147
1110 "and here typing Control-D ended the session. The B<% > here was the command "
1111 "prompt\\(emit is the shell's way of indicating that it is ready for the next "
1112 "command. The prompt can be customized in lots of ways, and one might "
1113 "include stuff like username, machine name, current directory, time, and so "
1114 "on. An assignment PS1=\"What next, master? \" would change the prompt as "
1119 #: build/C/man1/intro.1:153
1121 "We see that there are commands I<date> (that gives date and time), and "
1122 "I<cal> (that gives a calendar)."
1126 #: build/C/man1/intro.1:169
1128 "The command I<ls> lists the contents of the current directory\\(emit tells "
1129 "you what files you have. With a I<-l> option it gives a long listing, that "
1130 "includes the owner and size and date of the file, and the permissions people "
1131 "have for reading and/or changing the file. For example, the file \"tel\" "
1132 "here is 37 bytes long, owned by aeb and the owner can read and write it, "
1133 "others can only read it. Owner and permissions can be changed by the "
1134 "commands I<chown> and I<chmod>."
1138 #: build/C/man1/intro.1:176
1140 "The command I<cat> will show the contents of a file. (The name is from "
1141 "\"concatenate and print\": all files given as parameters are concatenated "
1142 "and sent to \"standard output\", here the terminal screen.)"
1146 #: build/C/man1/intro.1:183
1148 "The command I<cp> (from \"copy\") will copy a file. On the other hand, the "
1149 "command I<mv> (from \"move\") only renames it."
1153 #: build/C/man1/intro.1:188
1155 "The command I<diff> lists the differences between two files. Here there was "
1156 "no output because there were no differences."
1160 #: build/C/man1/intro.1:194
1162 "The command I<rm> (from \"remove\") deletes the file, and be careful! it is "
1163 "gone. No wastepaper basket or anything. Deleted means lost."
1167 #: build/C/man1/intro.1:199
1169 "The command I<grep> (from \"g/re/p\") finds occurrences of a string in one "
1170 "or more files. Here it finds Maja's telephone number."
1174 #: build/C/man1/intro.1:199
1176 msgid "Pathnames and the current directory"
1180 #: build/C/man1/intro.1:211
1182 "Files live in a large tree, the file hierarchy. Each has a I<pathname> "
1183 "describing the path from the root of the tree (which is called /) to the "
1184 "file. For example, such a full pathname might be /home/aeb/tel. Always "
1185 "using full pathnames would be inconvenient, and the name of a file in the "
1186 "current directory may be abbreviated by giving only the last component. "
1187 "That is why \"/home/aeb/tel\" can be abbreviated to \"tel\" when the current "
1188 "directory is \"/home/aeb\"."
1192 #: build/C/man1/intro.1:215
1193 msgid "The command I<pwd> prints the current directory."
1197 #: build/C/man1/intro.1:220
1199 "The command I<cd> changes the current directory. Try \"cd /\" and \"pwd\" "
1200 "and \"cd\" and \"pwd\"."
1204 #: build/C/man1/intro.1:220
1210 #: build/C/man1/intro.1:224
1211 msgid "The command I<mkdir> makes a new directory."
1215 #: build/C/man1/intro.1:228
1217 "The command I<rmdir> removes a directory if it is empty, and complains "
1222 #: build/C/man1/intro.1:240
1224 "The command I<find> (with a rather baroque syntax) will find files with "
1225 "given name or other properties. For example, \"find . -name tel\" would "
1226 "find the file \"tel\" starting in the present directory (which is called "
1227 "\".\"). And \"find / -name tel\" would do the same, but starting at the "
1228 "root of the tree. Large searches on a multi-GB disk will be time-consuming, "
1229 "and it may be better to use B<locate>(1)."
1233 #: build/C/man1/intro.1:240
1235 msgid "Disks and filesystems"
1239 #: build/C/man1/intro.1:251
1241 "The command I<mount> will attach the file system found on some disk (or "
1242 "floppy, or CDROM or so) to the big file system hierarchy. And I<umount> "
1243 "detaches it again. The command I<df> will tell you how much of your disk is "
1248 #: build/C/man1/intro.1:251
1254 #: build/C/man1/intro.1:269
1256 "On a UNIX system many user and system processes run simultaneously. The one "
1257 "you are talking to runs in the I<foreground>, the others in the "
1258 "I<background>. The command I<ps> will show you which processes are active "
1259 "and what numbers these processes have. The command I<kill> allows you to "
1260 "get rid of them. Without option this is a friendly request: please go "
1261 "away. And \"kill -9\" followed by the number of the process is an immediate "
1262 "kill. Foreground processes can often be killed by typing Control-C."
1266 #: build/C/man1/intro.1:269
1268 msgid "Getting information"
1272 #: build/C/man1/intro.1:282
1274 "There are thousands of commands, each with many options. Traditionally "
1275 "commands are documented on I<man pages>, (like this one), so that the "
1276 "command \"man kill\" will document the use of the command \"kill\" (and "
1277 "\"man man\" document the command \"man\"). The program I<man> sends the "
1278 "text through some I<pager>, usually I<less>. Hit the space bar to get the "
1279 "next page, hit q to quit."
1283 #: build/C/man1/intro.1:290
1285 "In documentation it is customary to refer to man pages by giving the name "
1286 "and section number, as in B<man>(1). Man pages are terse, and allow you to "
1287 "find quickly some forgotten detail. For newcomers an introductory text with "
1288 "more examples and explanations is useful."
1292 #: build/C/man1/intro.1:294
1294 "A lot of GNU/FSF software is provided with info files. Type \"info info\" "
1295 "for an introduction on the use of the program \"info\"."
1299 #. Actual examples? Separate section for each of cat, cp, ...?
1300 #. gzip, bzip2, tar, rpm
1302 #: build/C/man1/intro.1:302
1304 "Special topics are often treated in HOWTOs. Look in "
1305 "I</usr/share/doc/howto/en> and use a browser if you find HTML files there."
1309 #: build/C/man1/intro.1:304 build/C/man4/intro.4:40 build/C/man5/intro.5:40 build/C/man7/intro.7:43
1310 msgid "B<standards>(7)"
1314 #: build/C/man2/intro.2:29 build/C/man3/intro.3:26
1320 #: build/C/man2/intro.2:32
1321 msgid "intro - introduction to system calls"
1325 #: build/C/man2/intro.2:42
1327 "Section 2 of the manual describes the Linux system calls. A system call is "
1328 "an entry point into the Linux kernel. Usually, system calls are not invoked "
1329 "directly: instead, most system calls have corresponding C library wrapper "
1330 "functions which perform the steps required (e.g., trapping to kernel mode) "
1331 "in order to invoke the system call. Thus, making a system call looks the "
1332 "same as invoking a normal library function."
1336 #: build/C/man2/intro.2:45
1337 msgid "For a list of the Linux system calls, see B<syscalls>(2)."
1341 #: build/C/man2/intro.2:45 build/C/man2/unimplemented.2:35
1343 msgid "RETURN VALUE"
1347 #: build/C/man2/intro.2:54
1349 "On error, most system calls return a negative error number (i.e., the "
1350 "negated value of one of the constants described in B<errno>(3)). The C "
1351 "library wrapper hides this detail from the caller: when a system call "
1352 "returns a negative value, the wrapper copies the absolute value into the "
1353 "I<errno> variable, and returns -1 as the return value of the wrapper."
1357 #: build/C/man2/intro.2:59
1359 "The value returned by a successful system call depends on the call. Many "
1360 "system calls return 0 on success, but some can return nonzero values from a "
1361 "successful call. The details are described in the individual manual pages."
1365 #: build/C/man2/intro.2:70
1367 "In some cases, the programmer must define a feature test macro in order to "
1368 "obtain the declaration of a system call from the header file specified in "
1369 "the man page SYNOPSIS section. (Where required, these feature test macros "
1370 "must be defined before including I<any> header files.) In such cases, the "
1371 "required macro is described in the man page. For further information on "
1372 "feature test macros, see B<feature_test_macros>(7)."
1376 #: build/C/man2/intro.2:75 build/C/man3/intro.3:92
1378 "Certain terms and abbreviations are used to indicate UNIX variants and "
1379 "standards to which calls in this section conform. See B<standards>(7)."
1383 #: build/C/man2/intro.2:76
1385 msgid "Calling directly"
1389 #: build/C/man2/intro.2:85
1391 "In most cases, it is unnecessary to invoke a system call directly, but there "
1392 "are times when the Standard C library does not implement a nice wrapper "
1393 "function for you. In this case, the programmer must manually invoke the "
1394 "system call using B<syscall>(2). Historically, this was also possible using "
1395 "one of the _syscall macros described in B<_syscall>(2)."
1399 #: build/C/man2/intro.2:85 build/C/man3/intro.3:93 build/C/man4/intro.4:34 build/C/man5/intro.5:34 build/C/man6/intro.6:33 build/C/man7/intro.7:37 build/C/man8/intro.8:45
1401 msgid "Authors and copyright conditions"
1405 #: build/C/man2/intro.2:89 build/C/man3/intro.3:97 build/C/man4/intro.4:38 build/C/man5/intro.5:38 build/C/man6/intro.6:37 build/C/man7/intro.7:41 build/C/man8/intro.8:49
1407 "Look at the header of the manual page source for the author(s) and copyright "
1408 "conditions. Note that these can be different from page to page!"
1412 #: build/C/man2/intro.2:112
1414 "B<_syscall>(2), B<syscall>(2), B<syscalls>(2), B<errno>(3), B<intro>(3), "
1415 "B<capabilities>(7), B<credentials>(7), B<feature_test_macros>(7), "
1416 "B<mq_overview>(7), B<path_resolution>(7), B<pipe>(7), B<pty>(7), "
1417 "B<sem_overview>(7), B<shm_overview>(7), B<signal>(7), B<socket>(7), "
1418 "B<standards>(7), B<svipc>(7), B<symlink>(7), B<time>(7)"
1422 #: build/C/man3/intro.3:29
1423 msgid "intro - introduction to library functions"
1427 #: build/C/man3/intro.3:33
1429 "Section 3 of the manual describes all library functions excluding the "
1430 "library functions (system call wrappers) described in section 2, which "
1431 "implement system calls."
1435 #: build/C/man3/intro.3:50
1437 "Many of the functions described in the section are part of the Standard C "
1438 "Library (I<libc>). Some functions are part of other libraries (e.g., the "
1439 "math library, I<libm>, or the real-time library, I<librt>) in which case "
1440 "the manual page will indicate the linker option needed to link against the "
1441 "required library (e.g., I<-lm> and I<-lrt>, respectively, for the "
1442 "aforementioned libraries)."
1447 #. are various function groups which can be identified by a letter which
1448 #. is appended to the chapter number:
1450 #. These functions, the functions from chapter 2 and from chapter 3S are
1451 #. contained in the C standard library libc, which will be used by
1455 #. These functions are parts of the
1457 #. library. They are contained in the standard C library libc.
1459 #. These functions are contained in the arithmetic library libm. They are
1462 #. FORTRAN compiler by default, but not by the
1464 #. C compiler, which needs the option \fI\-lm\fP.
1466 #. These functions are part of the FORTRAN library libF77. There are no
1467 #. special compiler flags needed to use these functions.
1469 #. Various special libraries. The manual pages documenting their functions
1470 #. specify the library names.
1472 #: build/C/man3/intro.3:87
1474 "In some cases, the programmer must define a feature test macro in order to "
1475 "obtain the declaration of a function from the header file specified in the "
1476 "man page SYNOPSIS section. (Where required, these feature test macros must "
1477 "be defined before including I<any> header files.) In such cases, the "
1478 "required macro is described in the man page. For further information on "
1479 "feature test macros, see B<feature_test_macros>(7)."
1483 #: build/C/man3/intro.3:110
1485 "B<intro>(2), B<errno>(3), B<capabilities>(7), B<credentials>(7), "
1486 "B<environ>(7), B<feature_test_macros>(7), B<libc>(7), B<math_error>(7), "
1487 "B<path_resolution>(7), B<pthreads>(7), B<signal>(7), B<standards>(7)"
1491 #: build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29
1497 #: build/C/man4/intro.4:29
1498 msgid "intro - introduction to special files"
1502 #: build/C/man4/intro.4:31
1503 msgid "Section 4 of the manual describes special files (devices)."
1507 #: build/C/man4/intro.4:31 build/C/man7/mailaddr.7:113 build/C/man7/man.7:475 build/C/man7/mdoc.7:411 build/C/man7/mdoc.samples.7:2874
1513 #: build/C/man4/intro.4:33
1514 msgid "/dev/* \\(em device files"
1518 #: build/C/man5/intro.5:30
1519 msgid "intro - introduction to file formats"
1523 #: build/C/man5/intro.5:33
1525 "Section 5 of the manual describes various file formats and protocols, and "
1526 "the corresponding C structures, if any."
1530 #: build/C/man6/intro.6:29
1531 msgid "intro - introduction to games"
1535 #: build/C/man6/intro.6:32
1537 "Section 6 of the manual describes all the games and funny little programs "
1538 "available on the system."
1542 #: build/C/man7/intro.7:31
1543 msgid "intro - introduction to overview, conventions, and miscellany section"
1547 #: build/C/man7/intro.7:36
1549 "Section 7 of the manual provides overviews on various topics, and describes "
1550 "conventions and protocols, character set standards, the standard file system "
1551 "layout, and miscellaneous other things."
1555 #: build/C/man8/intro.8:32
1556 msgid "intro - introduction to administration and privileged commands"
1560 #: build/C/man8/intro.8:37
1562 "Section 8 of the manual describes commands which either can be or are used "
1563 "only by the superuser, like system-administration commands, daemons, and "
1564 "hardware-related commands."
1568 #: build/C/man8/intro.8:44
1570 "As with the commands in described section 1, the commands described in this "
1571 "section terminate with an exit status that indicates whether the command "
1572 "succeeded or failed. See B<intro>(1) for more information."
1576 #: build/C/man7/libc.7:26
1582 #: build/C/man7/libc.7:29
1583 msgid "libc - overview of standard C libraries on Linux"
1587 #: build/C/man7/libc.7:36
1589 "The term \"libc\" is commonly used as a shorthand for the \"standard C "
1590 "library\", a library of standard functions that can be used by all C "
1591 "programs (and sometimes by programs in other languages). Because of some "
1592 "history (see below), use of the term \"libc\" to refer to the standard C "
1593 "library is somewhat ambiguous on Linux."
1597 #: build/C/man7/libc.7:36
1603 #: build/C/man7/libc.7:54
1605 "By far the most widely used C library on Linux is the GNU C Library E<.UR "
1606 "http://www.gnu.org\\:/software\\:/libc/> E<.UE ,> often referred to as "
1607 "I<glibc>. This is the C library that is nowadays used in all major Linux "
1608 "distributions. It is also the C library whose details are documented in the "
1609 "relevant pages of the I<man-pages> project (primarily in Section 3 of the "
1610 "manual). Documentation of glibc is also available in the glibc manual, "
1611 "available via the command I<info libc>. Release 1.0 of glibc was made in "
1612 "September 1992. (There were earlier 0.x releases.) The next major release "
1613 "of glibc was 2.0, at the beginning of 1997."
1617 #: build/C/man7/libc.7:61
1619 "The pathname I</lib/libc.so.6> (or something similar) is normally a symbolic "
1620 "link that points to the location of the glibc library, and executing this "
1621 "pathname will cause glibc to display various information about the version "
1622 "installed on your system."
1626 #: build/C/man7/libc.7:61
1632 #: build/C/man7/libc.7:84
1634 "In the early to mid 1990s, there was for a while I<Linux libc>, a fork of "
1635 "glibc 1.x created by Linux developers who felt that glibc development at the "
1636 "time was not sufficing for the needs of Linux. Often, this library was "
1637 "referred to (ambiguously) as just \"libc\". Linux libc released major "
1638 "versions 2, 3, 4, and 5 (as well as many minor versions of those releases). "
1639 "For a while, Linux libc was the standard C library in many Linux "
1640 "distributions. However, notwithstanding the original motivations of the "
1641 "Linux libc effort, by the time glibc 2.0 was released, it was clearly "
1642 "superior to Linux libc, and all major Linux distributions that had been "
1643 "using Linux libc soon switched back to glibc. (Since this switch occurred "
1644 "over a decade ago, I<man-pages> no longer takes care to document Linux libc "
1645 "details. Nevertheless, the history is visible in vestiges of information "
1646 "about Linux libc that remain in some manual pages, in particular, references "
1647 "to I<libc4> and I<libc5>.)"
1651 #: build/C/man7/libc.7:84
1653 msgid "Other C libraries"
1657 #: build/C/man7/libc.7:99
1659 "There are various other less widely used C libraries for Linux. These "
1660 "libraries are generally smaller than glibc, both in terms of features and "
1661 "memory footprint, and often intended for building small binaries, perhaps "
1662 "targeted at development for embedded Linux systems. Among such libraries "
1663 "are I<uClibc> (I<http://www.uclibc.org/>) and I<dietlibc> "
1664 "(I<http://www.fefe.de/dietlibc/>). Details of these libraries are generally "
1665 "not covered by the I<man-pages> project."
1669 #: build/C/man7/libc.7:104
1670 msgid "B<syscalls>(2), B<feature_test_macros>(7), B<man-pages>(7), B<standards>(7)"
1674 #: build/C/man7/mailaddr.7:27
1680 #: build/C/man7/mailaddr.7:27
1686 #: build/C/man7/mailaddr.7:31
1687 msgid "mailaddr - mail addressing description"
1691 #: build/C/man7/mailaddr.7:36
1693 "This manual page gives a brief introduction to SMTP mail addresses, as used "
1694 "on the Internet. These addresses are in the general format"
1698 #: build/C/man7/mailaddr.7:38
1699 msgid " user@domain"
1703 #: build/C/man7/mailaddr.7:41
1705 "where a domain is a hierarchical dot-separated list of subdomains. These "
1706 "examples are valid forms of the same address:"
1710 #: build/C/man7/mailaddr.7:43
1711 msgid " eric@monet.berkeley.edu"
1715 #: build/C/man7/mailaddr.7:45
1716 msgid " Eric Allman E<lt>eric@monet.berkeley.eduE<gt>"
1720 #: build/C/man7/mailaddr.7:47
1721 msgid " eric@monet.berkeley.edu (Eric Allman)"
1725 #: build/C/man7/mailaddr.7:51
1727 "The domain part (\"monet.berkeley.edu\") is a mail-accepting domain. It can "
1728 "be a host and in the past it usually was, but it doesn't have to be. The "
1729 "domain part is not case sensitive."
1733 #: build/C/man7/mailaddr.7:59
1735 "The local part (\"eric\") is often a username, but its meaning is defined by "
1736 "the local software. Sometimes it is case sensitive, although that is "
1737 "unusual. If you see a local-part that looks like garbage, it is usually "
1738 "because of a gateway between an internal e-mail system and the net, here are "
1743 #: build/C/man7/mailaddr.7:61
1744 msgid " \"surname/admd=telemail/c=us/o=hp/prmd=hp\"@some.where"
1748 #: build/C/man7/mailaddr.7:63
1749 msgid " USER%SOMETHING@some.where"
1753 #: build/C/man7/mailaddr.7:65
1754 msgid " machine!machine!name@some.where"
1758 #: build/C/man7/mailaddr.7:67
1759 msgid " I2461572@some.where"
1763 #: build/C/man7/mailaddr.7:71
1765 "(These are, respectively, an X.400 gateway, a gateway to an arbitrary "
1766 "internal mail system that lacks proper internet support, an UUCP gateway, "
1767 "and the last one is just boring username policy.)"
1771 #: build/C/man7/mailaddr.7:77
1773 "The real-name part (\"Eric Allman\") can either be placed before E<lt>E<gt>, "
1774 "or in () at the end. (Strictly speaking the two aren't the same, but the "
1775 "difference is beyond the scope of this page.) The name may have to be "
1776 "quoted using \"\", for example, if it contains \".\":"
1780 #: build/C/man7/mailaddr.7:79
1781 msgid " \"Eric P. Allman\" E<lt>eric@monet.berkeley.eduE<gt>"
1785 #: build/C/man7/mailaddr.7:79
1787 msgid "Abbreviation."
1791 #: build/C/man7/mailaddr.7:87
1793 "Many mail systems let users abbreviate the domain name. For instance, users "
1794 "at berkeley.edu may get away with \"eric@monet\" to send mail to Eric "
1795 "Allman. I<This behavior is deprecated.> Sometimes it works, but you should "
1800 #: build/C/man7/mailaddr.7:87
1802 msgid "Route-addrs."
1806 #: build/C/man7/mailaddr.7:94
1808 "In the past, sometimes one had to route a message through several hosts to "
1809 "get it to its final destination. Addresses which show these relays are "
1810 "termed \"route-addrs\". These use the syntax:"
1814 #: build/C/man7/mailaddr.7:96
1815 msgid " E<lt>@hosta,@hostb:user@hostcE<gt>"
1819 #: build/C/man7/mailaddr.7:101
1821 "This specifies that the message should be sent to hosta, from there to "
1822 "hostb, and finally to hostc. Many hosts disregard route-addrs and send "
1823 "directly to hostc."
1827 #: build/C/man7/mailaddr.7:107
1829 "Route-addrs are very unusual now. They occur sometimes in old mail "
1830 "archives. It is generally possible to ignore all but the \"user@hostc\" "
1831 "part of the address to determine the actual address."
1835 #: build/C/man7/mailaddr.7:107
1841 #: build/C/man7/mailaddr.7:113
1843 "Every site is required to have a user or user alias designated "
1844 "\"postmaster\" to which problems with the mail system may be addressed. The "
1845 "\"postmaster\" address is not case sensitive."
1849 #: build/C/man7/mailaddr.7:115
1850 msgid "I</etc/aliases>"
1854 #: build/C/man7/mailaddr.7:117
1855 msgid "I<~/.forward>"
1859 #: build/C/man7/mailaddr.7:125
1861 "B<binmail>(1), B<mail>(1), B<mconnect>(1), B<aliases>(5), B<forward>(5), "
1862 "B<sendmail>(8), B<vrfy>(8)"
1866 #: build/C/man7/mailaddr.7:127
1867 msgid "RFC\\ 2822 (Internet Message Format)"
1871 #: build/C/man7/man-pages.7:30
1877 #: build/C/man7/man-pages.7:30
1883 #: build/C/man7/man-pages.7:33
1884 msgid "man-pages - conventions for writing Linux man pages"
1888 #: build/C/man7/man-pages.7:37 build/C/man7/man.7:49
1889 msgid "B<man> [I<section>] I<title>"
1893 #: build/C/man7/man-pages.7:47
1895 "This page describes the conventions that should be employed when writing man "
1896 "pages for the Linux I<man-pages> project, which documents the user-space API "
1897 "provided by the Linux kernel and the GNU C library. The project thus "
1898 "provides most of the pages in Section 2, as well as many of the pages that "
1899 "appear in Sections 3, 4, 5, and 7 of the man pages on a Linux system. The "
1900 "conventions described on this page may also be useful for authors writing "
1901 "man pages for other projects."
1905 #: build/C/man7/man-pages.7:47
1907 msgid "Sections of the manual pages"
1911 #: build/C/man7/man-pages.7:50
1912 msgid "The manual Sections are traditionally defined as follows:"
1916 #: build/C/man7/man-pages.7:50
1918 msgid "B<1 Commands (Programs)>"
1922 #: build/C/man7/man-pages.7:54
1923 msgid "Those commands that can be executed by the user from within a shell."
1927 #: build/C/man7/man-pages.7:54
1929 msgid "B<2 System calls>"
1933 #: build/C/man7/man-pages.7:57
1934 msgid "Those functions which must be performed by the kernel."
1938 #: build/C/man7/man-pages.7:57
1940 msgid "B<3 Library calls>"
1944 #: build/C/man7/man-pages.7:62
1945 msgid "Most of the I<libc> functions."
1949 #: build/C/man7/man-pages.7:62
1951 msgid "B<4 Special files (devices)>"
1955 #: build/C/man7/man-pages.7:66
1956 msgid "Files found in I</dev>."
1960 #: build/C/man7/man-pages.7:66
1962 msgid "B<5 File formats and conventions>"
1966 #: build/C/man7/man-pages.7:71
1967 msgid "The format for I</etc/passwd> and other human-readable files."
1971 #: build/C/man7/man-pages.7:71
1977 #: build/C/man7/man-pages.7:73
1979 msgid "B<7 Overview, conventions, and miscellaneous>"
1983 #: build/C/man7/man-pages.7:77
1985 "Overviews of various topics, conventions and protocols, character set "
1986 "standards, and miscellaneous other things."
1990 #: build/C/man7/man-pages.7:77
1992 msgid "B<8 System management commands>"
1996 #. .B 9 Kernel routines
1997 #. This is an obsolete manual section.
1998 #. Once it was thought a good idea to document the Linux kernel here,
1999 #. but in fact very little has been documented, and the documentation
2000 #. that exists is outdated already.
2001 #. There are better sources of
2002 #. information for kernel developers.
2004 #: build/C/man7/man-pages.7:90
2005 msgid "Commands like B<mount>(8), many of which only root can execute."
2009 #: build/C/man7/man-pages.7:90
2011 msgid "Macro package"
2015 #: build/C/man7/man-pages.7:97
2017 "New manual pages should be marked up using the B<groff an.tmac> package "
2018 "described in B<man>(7). This choice is mainly for consistency: the vast "
2019 "majority of existing Linux manual pages are marked up using these macros."
2023 #: build/C/man7/man-pages.7:97
2025 msgid "Conventions for source file layout"
2029 #: build/C/man7/man-pages.7:102
2031 "Please limit source code line length to no more than about 75 characters "
2032 "wherever possible. This helps avoid line-wrapping in some mail clients when "
2033 "patches are submitted inline."
2037 #: build/C/man7/man-pages.7:106
2039 "New sentences should be started on new lines. This makes it easier to see "
2040 "the effect of patches, which often operate at the level of individual "
2045 #: build/C/man7/man-pages.7:106 build/C/man7/man.7:78
2051 #: build/C/man7/man-pages.7:110
2052 msgid "The first command in a man page should be a B<TH> command:"
2056 #: build/C/man7/man-pages.7:114 build/C/man7/man.7:85
2057 msgid "B<\\&.TH> I<title section date source manual>"
2061 #: build/C/man7/man-pages.7:117
2066 #: build/C/man7/man-pages.7:118
2072 #: build/C/man7/man-pages.7:122
2073 msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
2077 #: build/C/man7/man-pages.7:122
2083 #: build/C/man7/man-pages.7:126
2084 msgid "The section number in which the man page should be placed (e.g., I<7>)."
2088 #: build/C/man7/man-pages.7:126
2094 #: build/C/man7/man-pages.7:132
2096 "The date of the last revision\\(emremember to change this every time a "
2097 "change is made to the man page, since this is the most general way of doing "
2098 "version control. Dates should be written in the form YYYY-MM-DD."
2102 #: build/C/man7/man-pages.7:132
2108 #: build/C/man7/man-pages.7:135
2109 msgid "The source of the command, function, or system call."
2113 #: build/C/man7/man-pages.7:139
2115 "For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
2120 #: build/C/man7/man-pages.7:147
2122 "For system calls, just write I<Linux>. (An earlier practice was to write "
2123 "the version number of the kernel from which the manual page was being "
2124 "written/checked. However, this was never done consistently, and so was "
2125 "probably worse than including no version number. Henceforth, avoid "
2126 "including a version number.)"
2130 #: build/C/man7/man-pages.7:152
2132 "For library calls that are part of glibc or one of the other common GNU "
2133 "libraries, just use I<GNU C Library>, I<GNU>, or an empty string."
2137 #: build/C/man7/man-pages.7:155
2138 msgid "For Section 4 pages, use I<Linux>."
2142 #: build/C/man7/man-pages.7:158
2143 msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
2147 #: build/C/man7/man-pages.7:158
2153 #: build/C/man7/man-pages.7:163
2155 "The title of the manual (e.g., for Section 2 and 3 pages in the I<man-pages> "
2156 "package, use I<Linux Programmer's Manual>)."
2160 #: build/C/man7/man-pages.7:164
2162 msgid "Sections within a manual page"
2166 #: build/C/man7/man-pages.7:171
2168 "The list below shows conventional or suggested sections. Most manual pages "
2169 "should include at least the B<highlighted> sections. Arrange a new manual "
2170 "page so that sections are placed in the order shown in the list."
2173 #. May 07: Few current man pages have an ERROR HANDLING section,,,
2175 #. May 07: Almost no current man pages have a USAGE section,,,
2178 #. May 07: Almost no current man pages have a SECURITY section,,,
2180 #. AUTHORS sections are discouraged
2181 #. AUTHORS [Discouraged]
2183 #: build/C/man7/man-pages.7:200
2188 "CONFIGURATION [Normally only in Section 4]\n"
2190 "OPTIONS [Normally only in Sections 1, 8]\n"
2191 "EXIT STATUS [Normally only in Sections 1, 8]\n"
2192 "RETURN VALUE [Normally only in Sections 2, 3]\n"
2193 "ERRORS [Typically only in Sections 2, 3]\n"
2196 "ATTRIBUTES [Normally only in Sections 2, 3]\n"
2197 "VERSIONS [Normally only in Sections 2, 3]\n"
2206 #: build/C/man7/man-pages.7:211
2208 "I<Where a traditional heading would apply>, I<please use it>; this kind of "
2209 "consistency can make the information easier to understand. If you must, you "
2210 "can create your own headings if they make things easier to understand (this "
2211 "can be especially useful for pages in Sections 4 and 5). However, before "
2212 "doing this, consider whether you could use the traditional headings, with "
2213 "some subsections (I<.SS>) within those sections."
2217 #: build/C/man7/man-pages.7:214
2218 msgid "The following list elaborates on the contents of each of the above sections."
2222 #: build/C/man7/man-pages.7:214
2228 #: build/C/man7/man-pages.7:225
2230 "The name of this manual page. See B<man>(7) for important details of the "
2231 "line(s) that should follow the B<.SH NAME> command. All words in this line "
2232 "(including the word immediately following the \"\\e-\") should be in "
2233 "lowercase, except where English or technical terminological convention "
2234 "dictates otherwise."
2238 #: build/C/man7/man-pages.7:225
2244 #: build/C/man7/man-pages.7:237
2246 "briefly describes the command or function's interface. For commands, this "
2247 "shows the syntax of the command and its arguments (including options); "
2248 "boldface is used for as-is text and italics are used to indicate replaceable "
2249 "arguments. Brackets ([]) surround optional arguments, vertical bars (|) "
2250 "separate choices, and ellipses (\\&...) can be repeated. For functions, it "
2251 "shows any required data declarations or B<#include> directives, followed by "
2252 "the function declaration."
2255 #. FIXME . Say something here about compiler options
2257 #: build/C/man7/man-pages.7:243
2259 "Where a feature test macro must be defined in order to obtain the "
2260 "declaration of a function (or a variable) from a header file, then the "
2261 "SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
2265 #: build/C/man7/man-pages.7:243
2267 msgid "B<CONFIGURATION>"
2271 #: build/C/man7/man-pages.7:247
2273 "Configuration details for a device. This section normally appears only in "
2278 #: build/C/man7/man-pages.7:247
2280 msgid "B<DESCRIPTION>"
2283 #. If there is some kind of input grammar or complex set of subcommands,
2284 #. consider describing them in a separate
2286 #. section (and just place an overview in the
2290 #: build/C/man7/man-pages.7:264
2292 "gives an explanation of what the program, function, or format does. Discuss "
2293 "how it interacts with files and standard input, and what it produces on "
2294 "standard output or standard error. Omit internals and implementation "
2295 "details unless they're critical for understanding the interface. Describe "
2296 "the usual case; for information on command-line options of a program use the "
2297 "B<OPTIONS> section."
2301 #: build/C/man7/man-pages.7:264
2308 #. describes the grammar of any sublanguage this implements.
2310 #: build/C/man7/man-pages.7:272
2312 "describes the command-line options accepted by a program and how they change "
2313 "its behavior. This section should appear only for Section 1 and 8 manual "
2318 #: build/C/man7/man-pages.7:272
2320 msgid "B<EXIT STATUS>"
2324 #: build/C/man7/man-pages.7:277
2326 "lists the possible exit status values of a program and the conditions that "
2327 "cause these values to be returned. This section should appear only for "
2328 "Section 1 and 8 manual pages."
2332 #: build/C/man7/man-pages.7:277
2334 msgid "B<RETURN VALUE>"
2338 #: build/C/man7/man-pages.7:282
2340 "For Section 2 and 3 pages, this section gives a list of the values the "
2341 "library routine will return to the caller and the conditions that cause "
2342 "these values to be returned."
2346 #: build/C/man7/man-pages.7:282
2352 #: build/C/man7/man-pages.7:290
2354 "For Section 2 and 3 manual pages, this is a list of the values that may be "
2355 "placed in I<errno> in the event of an error, along with information about "
2356 "the cause of the errors. I<The error list should be in alphabetical order>."
2360 #: build/C/man7/man-pages.7:290
2362 msgid "B<ENVIRONMENT>"
2366 #: build/C/man7/man-pages.7:294
2368 "lists all environment variables that affect the program or function and how "
2373 #: build/C/man7/man-pages.7:294
2378 #. May 07: Almost no current man pages have a DIAGNOSTICS section;
2379 #. "RETURN VALUE" or "EXIT STATUS" is preferred.
2382 #. gives an overview of the most common error messages and how to
2384 #. You don't need to explain system error messages
2385 #. or fatal signals that can appear during execution of any program
2386 #. unless they're special in some way to the program.
2388 #. May 07: Almost no current man pages have a SECURITY section.
2391 #. discusses security issues and implications.
2392 #. Warn about configurations or environments that should be avoided,
2393 #. commands that may have security implications, and so on, especially
2394 #. if they aren't obvious.
2395 #. Discussing security in a separate section isn't necessary;
2396 #. if it's easier to understand, place security information in the
2397 #. other sections (such as the
2402 #. However, please include security information somewhere!
2404 #: build/C/man7/man-pages.7:331
2406 "lists the files the program or function uses, such as configuration files, "
2407 "startup files, and files the program directly operates on. Give the full "
2408 "pathname of these files, and use the installation process to modify the "
2409 "directory part to match user preferences. For many programs, the default "
2410 "installation location is in I</usr/local>, so your base manual page should "
2411 "use I</usr/local> as the base."
2415 #: build/C/man7/man-pages.7:331
2417 msgid "B<ATTRIBUTES>"
2421 #: build/C/man7/man-pages.7:336
2423 "A summary of various attributes of the function(s) documented on this page, "
2424 "broken into subsections. The following subsections are defined:"
2428 #: build/C/man7/man-pages.7:338
2430 msgid "B<Multithreading (see pthreads(7))>"
2434 #: build/C/man7/man-pages.7:341
2435 msgid "This subsection notes attributes relating to multithreaded applications:"
2439 #: build/C/man7/man-pages.7:344
2440 msgid "Whether the function is thread-safe."
2444 #: build/C/man7/man-pages.7:346
2445 msgid "Whether the function is a cancellation point."
2449 #: build/C/man7/man-pages.7:348
2450 msgid "Whether the function is async-cancel-safe."
2454 #: build/C/man7/man-pages.7:352
2455 msgid "Details of these attributes can be found in B<pthreads>(7)."
2459 #: build/C/man7/man-pages.7:353
2465 #: build/C/man7/man-pages.7:370
2467 "A brief summary of the Linux kernel or glibc versions where a system call or "
2468 "library function appeared, or changed significantly in its operation. As a "
2469 "general rule, every new interface should include a VERSIONS section in its "
2470 "manual page. Unfortunately, many existing manual pages don't include this "
2471 "information (since there was no policy to do so when they were written). "
2472 "Patches to remedy this are welcome, but, from the perspective of programmers "
2473 "writing new code, this information probably matters only in the case of "
2474 "kernel interfaces that have been added in Linux 2.4 or later (i.e., changes "
2475 "since kernel 2.2), and library functions that have been added to glibc since "
2476 "version 2.1 (i.e., changes since glibc 2.0)."
2480 #: build/C/man7/man-pages.7:375
2482 "The B<syscalls>(2) manual page also provides information about kernel "
2483 "versions in which various system calls first appeared."
2487 #: build/C/man7/man-pages.7:375
2489 msgid "B<CONFORMING TO>"
2493 #: build/C/man7/man-pages.7:389
2495 "describes any standards or conventions that relate to the function or "
2496 "command described by the manual page. For a page in Section 2 or 3, this "
2497 "section should note the POSIX.1 version(s) that the call conforms to, and "
2498 "also whether the call is specified in C99. (Don't worry too much about "
2499 "other standards like SUS, SUSv2, and XPG, or the SVr4 and 4.xBSD "
2500 "implementation standards, unless the call was specified in those standards, "
2501 "but isn't in the current version of POSIX.1.) (See B<standards>(7).)"
2505 #: build/C/man7/man-pages.7:393
2507 "If the call is not governed by any standards but commonly exists on other "
2508 "systems, note them. If the call is Linux-specific, note this."
2512 #: build/C/man7/man-pages.7:397
2514 "If this section consists of just a list of standards (which it commonly "
2515 "does), terminate the list with a period (\\(aq.\\(aq)."
2519 #: build/C/man7/man-pages.7:397
2525 #: build/C/man7/man-pages.7:402
2527 "provides miscellaneous notes. For Section 2 and 3 man pages you may find it "
2528 "useful to include subsections (B<SS>) named I<Linux Notes> and I<Glibc "
2533 #: build/C/man7/man-pages.7:402
2539 #: build/C/man7/man-pages.7:406
2541 "lists limitations, known defects or inconveniences, and other questionable "
2546 #: build/C/man7/man-pages.7:406
2552 #: build/C/man7/man-pages.7:412
2554 "provides one or more examples describing how this function, file or command "
2555 "is used. For details on writing example programs, see I<Example Programs> "
2560 #: build/C/man7/man-pages.7:412
2566 #: build/C/man7/man-pages.7:422
2568 "lists authors of the documentation or program. B<Use of an AUTHORS section "
2569 "is strongly discouraged>. Generally, it is better not to clutter every page "
2570 "with a list of (over time potentially numerous) authors; if you write or "
2571 "significantly amend a page, add a copyright notice as a comment in the "
2572 "source file. If you are the author of a device driver and want to include "
2573 "an address for reporting bugs, place this under the BUGS section."
2577 #: build/C/man7/man-pages.7:422
2583 #: build/C/man7/man-pages.7:429
2585 "provides a comma-separated list of related man pages, ordered by section "
2586 "number and then alphabetically by name, possibly followed by other related "
2587 "pages or documents. Do not terminate this with a period."
2591 #: build/C/man7/man-pages.7:440
2593 "Where the SEE ALSO list contains many long manual page names, to improve the "
2594 "visual result of the output, it may be useful to employ the I<.ad l> (don't "
2595 "right justify) and I<.nh> (don't hyphenate) directives. Hyphenation of "
2596 "individual page names can be prevented by preceding words with the string "
2601 #: build/C/man7/man-pages.7:440
2603 msgid "Font conventions"
2607 #: build/C/man7/man-pages.7:445
2609 "For functions, the arguments are always specified using italics, I<even in "
2610 "the SYNOPSIS section>, where the rest of the function is specified in bold:"
2614 #: build/C/man7/man-pages.7:447
2615 msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
2619 #: build/C/man7/man-pages.7:449
2620 msgid "Variable names should, like argument names, be specified in italics."
2624 #: build/C/man7/man-pages.7:462
2626 "Filenames (whether pathnames, or references to files in the I</usr/include> "
2627 "directory) are always in italics (e.g., I<E<lt>stdio.hE<gt>>), except in "
2628 "the SYNOPSIS section, where included files are in bold (e.g., B<#include "
2629 "E<lt>stdio.hE<gt>>). When referring to a standard include file under "
2630 "I</usr/include>, specify the header file surrounded by angle brackets, in "
2631 "the usual C way (e.g., I<E<lt>stdio.hE<gt>>)."
2635 #: build/C/man7/man-pages.7:466
2637 "Special macros, which are usually in upper case, are in bold (e.g., "
2638 "B<MAXINT>). Exception: don't boldface NULL."
2642 #: build/C/man7/man-pages.7:471
2644 "When enumerating a list of error codes, the codes are in bold (this list "
2645 "usually uses the B<\\&.TP> macro)."
2649 #: build/C/man7/man-pages.7:474
2651 "Complete commands should, if long, be written as in an indented line on "
2652 "their own, for example"
2656 #: build/C/man7/man-pages.7:478
2658 msgid "man 7 man-pages\n"
2662 #: build/C/man7/man-pages.7:488
2664 "If the command is short, then it can be included inline in the text, in "
2665 "italic format, for example, I<man 7 man-pages>. In this case, it may be "
2666 "worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
2667 "command. Command options should be written in italics, e.g., I<-l>."
2671 #: build/C/man7/man-pages.7:493
2673 "Expressions, if not written on a separate indented line, should be specified "
2674 "in italics. Again, the use of nonbreaking spaces may be appropriate if the "
2675 "expression is inlined with normal text."
2679 #: build/C/man7/man-pages.7:504
2681 "Any reference to the subject of the current manual page should be written "
2682 "with the name in bold. If the subject is a function (i.e., this is a "
2683 "Section 2 or 3 page), then the name should be followed by a pair of "
2684 "parentheses in Roman (normal) font. For example, in the B<fcntl>(2) man "
2685 "page, references to the subject of the page would be written as: "
2686 "B<fcntl>(). The preferred way to write this in the source file is:"
2690 #: build/C/man7/man-pages.7:507
2692 msgid " .BR fcntl ()\n"
2696 #: build/C/man7/man-pages.7:511
2698 "(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
2699 "easier to write tools that parse man page source files.)"
2703 #: build/C/man7/man-pages.7:520
2705 "Any reference to another man page should be written with the name in bold, "
2706 "I<always> followed by the section number, formatted in Roman (normal) font, "
2707 "without any separating spaces (e.g., B<intro>(2)). The preferred way to "
2708 "write this in the source file is:"
2712 #: build/C/man7/man-pages.7:523
2714 msgid " .BR intro (2)\n"
2718 #: build/C/man7/man-pages.7:528
2720 "(Including the section number in cross references lets tools like "
2721 "B<man2html>(1) create properly hyperlinked pages.)"
2725 #: build/C/man7/man-pages.7:528
2731 #: build/C/man7/man-pages.7:533
2733 "Starting with release 2.59, I<man-pages> follows American spelling "
2734 "conventions; please write all new pages and patches according to these "
2739 #: build/C/man7/man-pages.7:533
2741 msgid "Capitalization"
2745 #: build/C/man7/man-pages.7:538
2747 "In subsection (\"SS\") headings capitalize the first word in heading, but "
2748 "otherwise use lower case, except where English usage (e.g., proper nouns) or "
2749 "programming language requirements (e.g., identifier names) dictate "
2754 #: build/C/man7/man-pages.7:538
2756 msgid "Example programs and shell sessions"
2760 #: build/C/man7/man-pages.7:542
2762 "Manual pages can include example programs demonstrating how to use a system "
2763 "call or library function. However, note the following:"
2767 #: build/C/man7/man-pages.7:545
2768 msgid "Example programs should be written in C."
2772 #: build/C/man7/man-pages.7:552
2774 "An example program is necessary and useful only if it demonstrates something "
2775 "beyond what can easily be provided in a textual description of the "
2776 "interface. An example program that does nothing other than call an "
2777 "interface usually serves little purpose."
2781 #: build/C/man7/man-pages.7:556
2783 "Example programs should be fairly short (preferably less than 100 lines; "
2784 "ideally less than 50 lines)."
2788 #: build/C/man7/man-pages.7:560
2790 "Example programs should do error checking after system calls and library "
2795 #: build/C/man7/man-pages.7:564
2797 "Example programs should be complete, and compile without warnings when "
2798 "compiled with I<cc\\ -Wall>."
2802 #: build/C/man7/man-pages.7:570
2804 "Where possible and appropriate, example programs should allow "
2805 "experimentation, by varying their behavior based on inputs (ideally from "
2806 "command-line arguments, or alternatively, via input read by the program)."
2810 #: build/C/man7/man-pages.7:575
2812 "Example programs should be laid out according to Kernighan and Ritchie "
2813 "style, with 4-space indents. (Avoid the use of TAB characters in source "
2818 #: build/C/man7/man-pages.7:580
2820 "For some examples of what example programs should look like, see B<wait>(2) "
2825 #: build/C/man7/man-pages.7:584
2827 "If you include a shell session demonstrating the use of a program or other "
2828 "system feature, boldface the user input text, to distinguish it from output "
2829 "produced by the system."
2833 #: build/C/man7/man-pages.7:584
2835 msgid "Indentation of structure definitions, shell session logs, etc."
2839 #: build/C/man7/man-pages.7:590
2841 "When structure definitions, shell session logs, and so on are included in "
2842 "running text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ "
2847 #: build/C/man7/man-pages.7:597
2849 "For canonical examples of how man pages in the I<man-pages> package should "
2850 "look, see B<pipe>(2) and B<fcntl>(2)."
2854 #: build/C/man7/man-pages.7:604
2856 "B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
2861 #: build/C/man7/man.7:34
2867 #: build/C/man7/man.7:37
2868 msgid "man - macros to format man pages"
2872 #: build/C/man7/man.7:41
2873 msgid "B<groff -Tascii -man> I<file> \\&..."
2877 #: build/C/man7/man.7:45
2878 msgid "B<groff -Tps -man> I<file> \\&..."
2882 #: build/C/man7/man.7:62
2884 "This manual page explains the B<groff an.tmac> macro package (often called "
2885 "the B<man> macro package). This macro package should be used by developers "
2886 "when writing or porting man pages for Linux. It is fairly compatible with "
2887 "other versions of this macro package, so porting man pages should not be a "
2888 "major problem (exceptions include the NET-2 BSD release, which uses a "
2889 "totally different macro package called mdoc; see B<mdoc>(7))."
2893 #: build/C/man7/man.7:74
2895 "Note that NET-2 BSD mdoc man pages can be used with B<groff> simply by "
2896 "specifying the B<-mdoc> option instead of the B<-man> option. Using the "
2897 "B<-mandoc> option is, however, recommended, since this will automatically "
2898 "detect which macro package is in use."
2902 #: build/C/man7/man.7:78
2904 "For conventions that should be employed when writing man pages for the Linux "
2905 "I<man-pages> package, see B<man-pages>(7)."
2909 #: build/C/man7/man.7:81
2911 "The first command in a man page (after comment lines, that is, lines that "
2912 "start with B<.\\e\">) should be"
2916 #: build/C/man7/man.7:91
2918 "For details of the arguments that should be supplied to the B<TH> command, "
2919 "see B<man-pages>(7)."
2923 #: build/C/man7/man.7:97
2925 "Note that BSD mdoc-formatted pages begin with the B<Dd> command, not the "
2930 #: build/C/man7/man.7:97
2935 #. The following doesn't seem to be required (see Debian bug 411303),
2936 #. If the name contains spaces and appears
2937 #. on the same line as
2939 #. then place the heading in double quotes.
2941 #: build/C/man7/man.7:106
2942 msgid "Sections are started with B<\\&.SH> followed by the heading name."
2946 #: build/C/man7/man.7:109
2948 "The only mandatory heading is NAME, which should be the first section and be "
2949 "followed on the next line by a one-line description of the program:"
2953 #: build/C/man7/man.7:112
2958 #: build/C/man7/man.7:114
2959 msgid "item \\e- description"
2963 #: build/C/man7/man.7:128
2965 "It is extremely important that this format is followed, and that there is a "
2966 "backslash before the single dash which follows the item name. This syntax "
2967 "is used by the B<mandb>(8) program to create a database of short "
2968 "descriptions for the B<whatis>(1) and B<apropos>(1) commands. (See "
2969 "B<lexgrog>(1) for further details on the syntax of the NAME section.)"
2973 #: build/C/man7/man.7:131
2975 "For a list of other sections that might appear in a manual page, see "
2980 #: build/C/man7/man.7:131
2986 #: build/C/man7/man.7:133
2987 msgid "The commands to select the type face are:"
2991 #: build/C/man7/man.7:133
2997 #: build/C/man7/man.7:136
3002 #: build/C/man7/man.7:136
3008 #: build/C/man7/man.7:140
3010 "Bold alternating with italics (especially useful for function "
3015 #: build/C/man7/man.7:140
3021 #: build/C/man7/man.7:145
3023 "Bold alternating with Roman (especially useful for referring to other manual "
3028 #: build/C/man7/man.7:145
3034 #: build/C/man7/man.7:148
3039 #: build/C/man7/man.7:148
3045 #: build/C/man7/man.7:151
3046 msgid "Italics alternating with bold"
3050 #: build/C/man7/man.7:151
3056 #: build/C/man7/man.7:154
3057 msgid "Italics alternating with Roman"
3061 #: build/C/man7/man.7:154
3067 #: build/C/man7/man.7:157
3068 msgid "Roman alternating with bold"
3072 #: build/C/man7/man.7:157
3078 #: build/C/man7/man.7:160
3079 msgid "Roman alternating with italics"
3083 #: build/C/man7/man.7:160
3089 #: build/C/man7/man.7:163
3090 msgid "Small alternating with bold"
3094 #: build/C/man7/man.7:163
3100 #: build/C/man7/man.7:166
3101 msgid "Small (useful for acronyms)"
3105 #: build/C/man7/man.7:179
3107 "Traditionally, each command can have up to six arguments, but the GNU "
3108 "implementation removes this limitation (you might still want to limit "
3109 "yourself to 6 arguments for portability's sake). Arguments are delimited by "
3110 "spaces. Double quotes can be used to specify an argument which contains "
3111 "spaces. All of the arguments will be printed next to each other without "
3112 "intervening spaces, so that the B<\\&.BR> command can be used to specify a "
3113 "word in bold followed by a mark of punctuation in Roman. If no arguments "
3114 "are given, the command is applied to the following line of text."
3118 #: build/C/man7/man.7:179
3120 msgid "Other macros and strings"
3124 #: build/C/man7/man.7:199
3126 "Below are other relevant macros and predefined strings. Unless noted "
3127 "otherwise, all macros cause a break (end the current line of text). Many of "
3128 "these macros set or use the \"prevailing indent.\" The \"prevailing indent\" "
3129 "value is set by any macro with the parameter I<i> below; macros may omit "
3130 "I<i> in which case the current prevailing indent will be used. As a result, "
3131 "successive indented paragraphs can use the same indent without respecifying "
3132 "the indent value. A normal (nonindented) paragraph resets the prevailing "
3133 "indent value to its default value (0.5 inches). By default a given indent "
3134 "is measured in ens; try to use ens or ems as units for indents, since these "
3135 "will automatically adjust to font size changes. The other key macro "
3140 #: build/C/man7/man.7:199
3142 msgid "Normal paragraphs"
3146 #: build/C/man7/man.7:200
3152 #: build/C/man7/man.7:205 build/C/man7/man.7:210
3153 msgid "Same as B<\\&.PP> (begin a new paragraph)."
3157 #: build/C/man7/man.7:205
3163 #: build/C/man7/man.7:210
3169 #: build/C/man7/man.7:213
3170 msgid "Begin a new paragraph and reset prevailing indent."
3174 #: build/C/man7/man.7:213
3176 msgid "Relative margin indent"
3180 #: build/C/man7/man.7:214
3182 msgid "B<\\&.RS>I< i>"
3186 #: build/C/man7/man.7:225
3188 "Start relative margin indent: moves the left margin I<i> to the right (if "
3189 "I<i> is omitted, the prevailing indent value is used). A new prevailing "
3190 "indent is set to 0.5 inches. As a result, all following paragraph(s) will "
3191 "be indented until the corresponding B<\\&.RE>."
3195 #: build/C/man7/man.7:225
3201 #: build/C/man7/man.7:229
3203 "End relative margin indent and restores the previous value of the prevailing "
3208 #: build/C/man7/man.7:229
3210 msgid "Indented paragraph macros"
3214 #: build/C/man7/man.7:230
3216 msgid "B<\\&.HP>I< i>"
3220 #: build/C/man7/man.7:235
3222 "Begin paragraph with a hanging indent (the first line of the paragraph is at "
3223 "the left margin of normal paragraphs, and the rest of the paragraph's lines "
3228 #: build/C/man7/man.7:235
3230 msgid "B<\\&.IP>I< x i>"
3234 #: build/C/man7/man.7:256
3236 "Indented paragraph with optional hanging tag. If the tag I<x> is omitted, "
3237 "the entire following paragraph is indented by I<i>. If the tag I<x> is "
3238 "provided, it is hung at the left margin before the following indented "
3239 "paragraph (this is just like B<\\&.TP> except the tag is included with the "
3240 "command instead of being on the following line). If the tag is too long, "
3241 "the text after the tag will be moved down to the next line (text will not be "
3242 "lost or garbled). For bulleted lists, use this macro with \\e(bu (bullet) "
3243 "or \\e(em (em dash) as the tag, and for numbered lists, use the number or "
3244 "letter followed by a period as the tag; this simplifies translation to other "
3249 #: build/C/man7/man.7:256
3251 msgid "B<\\&.TP>I< i>"
3255 #: build/C/man7/man.7:263
3257 "Begin paragraph with hanging tag. The tag is given on the next line, but "
3258 "its results are like those of the B<\\&.IP> command."
3262 #: build/C/man7/man.7:263
3264 msgid "Hypertext link macros"
3268 #: build/C/man7/man.7:273
3270 "(Feature supported with B<groff> only.) In order to use hypertext link "
3271 "macros, it is necessary to load the B<www.tmac> macro package. Use the "
3272 "request B<.mso www.tmac> to do this."
3276 #: build/C/man7/man.7:273
3278 msgid "B<\\&.URL>I< url link trailer>"
3281 #. The following is a kludge to get a paragraph into the listing.
3283 #: build/C/man7/man.7:286
3285 "Inserts a hypertext link to the URI (URL) I<url>, with I<link> as the text "
3286 "of the link. The I<trailer> will be printed immediately afterward. When "
3287 "generating HTML this should translate into the HTML command B<E<lt>A "
3288 "HREF=\">I<url>B<\"E<gt>>I<link>B<E<lt>/AE<gt>>I<trailer>B<.>"
3291 #. The following is a kludge to get a paragraph into the listing.
3293 #: build/C/man7/man.7:293
3295 "This and other related macros are new, and many tools won't do anything with "
3296 "them, but since many tools (including troff) will simply ignore undefined "
3297 "macros (or at worst insert their text) these are safe to insert."
3300 #. The following is a kludge to get a paragraph into the listing.
3302 #: build/C/man7/man.7:302
3304 "It can be useful to define your own B<URL> macro in manual pages for the "
3305 "benefit of those viewing it with a roff viewer other than B<groff>. That "
3306 "way, the URL, link text, and trailer text (if any) are still visible."
3310 #: build/C/man7/man.7:305
3311 msgid "Here's an example:"
3315 #: build/C/man7/man.7:307
3320 #: build/C/man7/man.7:309
3321 msgid "\\e\\e$2 \\e(laURL: \\e\\e$1 \\e(ra\\e\\e$3"
3325 #: build/C/man7/man.7:311
3330 #: build/C/man7/man.7:313
3331 msgid "\\&.if \\en[.g] .mso www.tmac"
3335 #: build/C/man7/man.7:316
3336 msgid "\\&.TH I<...>"
3340 #: build/C/man7/man.7:318
3341 msgid "I<(later in the page)>"
3345 #: build/C/man7/man.7:320
3346 msgid "This software comes from the"
3350 #: build/C/man7/man.7:322
3351 msgid "\\&.URL \"http://www.gnu.org/\" \"GNU Project\" \" of the\""
3355 #: build/C/man7/man.7:324
3356 msgid "\\&.URL \"http://www.fsf.org/\" \"Free Software Foundation\" ."
3360 #: build/C/man7/man.7:334
3362 "In the above, if B<groff> is being used, the B<www.tmac> macro package's "
3363 "definition of the URL macro will supersede the locally defined one."
3367 #: build/C/man7/man.7:339
3369 "A number of other link macros are available. See B<groff_www>(7) for more "
3374 #: build/C/man7/man.7:339
3376 msgid "Miscellaneous macros"
3380 #: build/C/man7/man.7:340
3386 #: build/C/man7/man.7:344
3387 msgid "Reset tabs to default tab values (every 0.5 inches); does not cause a break."
3391 #: build/C/man7/man.7:344
3393 msgid "B<\\&.PD>I< d>"
3397 #: build/C/man7/man.7:349
3399 "Set inter-paragraph vertical distance to d (if omitted, d=0.4v); does not "
3404 #: build/C/man7/man.7:349
3406 msgid "B<\\&.SS>I< t>"
3410 #: build/C/man7/man.7:356
3412 "Subheading I<t> (like B<\\&.SH>, but used for a subsection inside a "
3417 #: build/C/man7/man.7:356
3419 msgid "Predefined strings"
3423 #: build/C/man7/man.7:360
3424 msgid "The B<man> package has the following predefined strings:"
3428 #: build/C/man7/man.7:360
3434 #: build/C/man7/man.7:362
3435 msgid "Registration Symbol: \\*R"
3439 #: build/C/man7/man.7:362
3445 #: build/C/man7/man.7:364
3446 msgid "Change to default font size"
3450 #: build/C/man7/man.7:364
3456 #: build/C/man7/man.7:366
3457 msgid "Trademark Symbol: \\*(Tm"
3461 #: build/C/man7/man.7:366
3467 #: build/C/man7/man.7:368
3468 msgid "Left angled double quote: ``"
3472 #: build/C/man7/man.7:368
3478 #: build/C/man7/man.7:370
3479 msgid "Right angled double quote: ''"
3483 #: build/C/man7/man.7:370
3489 #: build/C/man7/man.7:414
3491 "Although technically B<man> is a troff macro package, in reality a large "
3492 "number of other tools process man page files that don't implement all of "
3493 "troff's abilities. Thus, it's best to avoid some of troff's more exotic "
3494 "abilities where possible to permit these other tools to work correctly. "
3495 "Avoid using the various troff preprocessors (if you must, go ahead and use "
3496 "B<tbl>(1), but try to use the B<IP> and B<TP> commands instead for "
3497 "two-column tables). Avoid using computations; most other tools can't "
3498 "process them. Use simple commands that are easy to translate to other "
3499 "formats. The following troff macros are believed to be safe (though in many "
3500 "cases they will be ignored by translators): B<\\e\">, B<.>, B<ad>, B<bp>, "
3501 "B<br>, B<ce>, B<de>, B<ds>, B<el>, B<ie>, B<if>, B<fi>, B<ft>, B<hy>, B<ig>, "
3502 "B<in>, B<na>, B<ne>, B<nf>, B<nh>, B<ps>, B<so>, B<sp>, B<ti>, B<tr>."
3506 #: build/C/man7/man.7:437
3508 "You may also use many troff escape sequences (those sequences beginning with "
3509 "\\e). When you need to include the backslash character as normal text, use "
3510 "\\ee. Other sequences you may use, where x or xx are any characters and N "
3511 "is any digit, include: B<\\e'>, B<\\e`>, B<\\e->, B<\\e.>, B<\\e\">, "
3512 "B<\\e%>, B<\\e*x>, B<\\e*(xx>, B<\\e(xx>, B<\\e$N>, B<\\enx>, B<\\en(xx>, "
3513 "B<\\efx>, and B<\\ef(xx>. Avoid using the escape sequences for drawing "
3518 #: build/C/man7/man.7:468
3520 "Do not use the optional parameter for B<bp> (break page). Use only positive "
3521 "values for B<sp> (vertical space). Don't define a macro (B<de>) with the "
3522 "same name as a macro in this or the mdoc macro package with a different "
3523 "meaning; it's likely that such redefinitions will be ignored. Every "
3524 "positive indent (B<in>) should be paired with a matching negative indent "
3525 "(although you should be using the B<RS> and B<RE> macros instead). The "
3526 "condition test (B<if,ie>) should only have \\(aqt\\(aq or \\(aqn\\(aq as "
3527 "the condition. Only translations (B<tr>) that can be ignored should be "
3528 "used. Font changes (B<ft> and the B<\\ef> escape sequence) should only "
3529 "have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have "
3534 #: build/C/man7/man.7:475
3536 "If you use capabilities beyond these, check the results carefully on several "
3537 "tools. Once you've confirmed that the additional capability is safe, let "
3538 "the maintainer of this document know about the safe command or sequence that "
3539 "should be added to this list."
3543 #: build/C/man7/man.7:477
3544 msgid "I</usr/share/groff/>[*/]I<tmac/an.tmac>"
3548 #: build/C/man7/man.7:479
3549 msgid "I</usr/man/whatis>"
3553 #: build/C/man7/man.7:493
3555 "By all means include full URLs (or URIs) in the text itself; some tools such "
3556 "as B<man2html>(1) can automatically turn them into hypertext links. You "
3557 "can also use the new B<URL> macro to identify links to related information. "
3558 "If you include URLs, use the full URL (e.g., E<.UR "
3559 "http://www.kernelnotes.org> E<.UE )> to ensure that tools can automatically "
3564 #: build/C/man7/man.7:502
3566 "Tools processing these files should open the file and examine the first "
3567 "nonwhitespace character. A period (.) or single quote (') at the beginning "
3568 "of a line indicates a troff-based file (such as man or mdoc). A left angle "
3569 "bracket (E<lt>) indicates an SGML/XML-based file (such as HTML or Docbook). "
3570 "Anything else suggests simple ASCII text (e.g., a \"catman\" result)."
3574 #: build/C/man7/man.7:513
3576 "Many man pages begin with B<\\'\\e\"> followed by a space and a list of "
3577 "characters, indicating how the page is to be preprocessed. For "
3578 "portability's sake to non-troff translators we recommend that you avoid "
3579 "using anything other than B<tbl>(1), and Linux can detect that "
3580 "automatically. However, you might want to include this information so your "
3581 "man page can be handled by other (less capable) systems. Here are the "
3582 "definitions of the preprocessors invoked by these characters:"
3586 #: build/C/man7/man.7:513
3592 #: build/C/man7/man.7:516
3597 #: build/C/man7/man.7:516
3603 #: build/C/man7/man.7:519
3608 #: build/C/man7/man.7:519
3614 #: build/C/man7/man.7:522
3619 #: build/C/man7/man.7:522
3625 #: build/C/man7/man.7:525
3630 #: build/C/man7/man.7:525
3636 #: build/C/man7/man.7:528
3641 #: build/C/man7/man.7:528
3647 #: build/C/man7/man.7:531
3652 #: build/C/man7/man.7:531 build/C/man7/suffixes.7:279 build/C/man7/mdoc.samples.7:2883
3658 #: build/C/man7/man.7:544
3660 "Most of the macros describe formatting (e.g., font type and spacing) instead "
3661 "of marking semantic content (e.g., this text is a reference to another "
3662 "page), compared to formats like mdoc and DocBook (even HTML has more "
3663 "semantic markings). This situation makes it harder to vary the B<man> "
3664 "format for different media, to make the formatting consistent for a given "
3665 "media, and to automatically insert cross-references. By sticking to the "
3666 "safe subset described above, it should be easier to automate transitioning "
3667 "to a different reference page format in the future."
3672 #. James Clark (jjc@jclark.com) wrote the implementation of the macro package.
3674 #. Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
3675 #. this manual page.
3677 #. Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
3678 #. (which influenced this manual page).
3680 #. David A. Wheeler (dwheeler@ida.org) heavily modified this
3681 #. manual page, such as adding detailed information on sections and macros.
3683 #: build/C/man7/man.7:560
3684 msgid "The Sun macro B<TX> is not implemented."
3688 #: build/C/man7/man.7:572
3690 "B<apropos>(1), B<groff>(1), B<lexgrog>(1), B<man>(1), B<man2html>(1), "
3691 "B<whatis>(1), B<groff_man>(7), B<groff_www>(7), B<man-pages>(7), B<mdoc>(7), "
3692 "B<mdoc.samples>(7)"
3696 #: build/C/man7/mdoc.7:42
3698 msgid "July 11, 1999"
3702 #: build/C/man7/mdoc.7:43
3708 #: build/C/man7/mdoc.7:47
3713 #: build/C/man7/mdoc.7:47
3715 msgid "quick reference guide for the"
3719 #: build/C/man7/mdoc.7:50
3720 msgid "E<.Nm \\-mdoc> macro package"
3724 #: build/C/man7/mdoc.7:54
3725 msgid "E<.Nm groff> E<.Fl m Ns Ar doc> E<.Ar files ...>"
3729 #: build/C/man7/mdoc.7:66
3731 "The E<.Nm \\-mdoc> package is a set of content-based and domain-based macros "
3732 "used to format the E<.Bx> man pages. The macro names and their meanings are "
3733 "listed below for quick reference; for a detailed explanation on using the "
3734 "package, see the tutorial sampler E<.Xr mdoc.samples 7>."
3738 #: build/C/man7/mdoc.7:71
3740 "Note that this is not the usual macro package for Linux documentation, "
3741 "although it is used for documentation of several widely used programs; see "
3746 #: build/C/man7/mdoc.7:80
3748 "The macros are described in two groups, the first includes the structural "
3749 "and physical page layout macros. The second contains the manual and general "
3750 "text domain macros which differentiate the E<.Nm \\-mdoc> package from other "
3751 "E<.Xr troff> formatting packages."
3755 #: build/C/man7/mdoc.7:80 build/C/man7/mdoc.samples.7:1811
3757 msgid "PAGE STRUCTURE DOMAIN"
3761 #: build/C/man7/mdoc.7:81
3763 msgid "Title Macros"
3767 #: build/C/man7/mdoc.7:84
3769 "To create a valid manual page, these three macros, in this order, are "
3774 #: build/C/man7/mdoc.7:85
3776 msgid "Li \"\\&.Dd \" Ar \"Month day, year\""
3780 #: build/C/man7/mdoc.7:87
3781 msgid "Document date."
3785 #: build/C/man7/mdoc.7:87
3787 msgid "Li \"\\&.Dt \" Ar \"DOCUMENT_TITLE [section] [volume]\""
3791 #: build/C/man7/mdoc.7:89
3792 msgid "Title, in upper case."
3796 #: build/C/man7/mdoc.7:89
3798 msgid "Li \"\\&.Os \" Ar \"OPERATING_SYSTEM [version/release]\""
3802 #: build/C/man7/mdoc.7:92
3803 msgid "Operating system E<.Pq Tn BSD>."
3807 #: build/C/man7/mdoc.7:93
3809 msgid "Page Layout Macros"
3813 #: build/C/man7/mdoc.7:95
3814 msgid "Section headers, paragraph breaks, lists and displays."
3818 #: build/C/man7/mdoc.7:96
3824 #: build/C/man7/mdoc.7:99
3825 msgid "Section Headers. Valid headers, in the order of presentation:"
3829 #: build/C/man7/mdoc.7:100
3835 #: build/C/man7/mdoc.7:108
3837 "Name section, should include the E<.Ql \\&.Nm> or E<.Ql \\&.Fn> and the "
3838 "E<.Ql \\&.Nd> macros."
3842 #: build/C/man7/mdoc.7:108
3848 #: build/C/man7/mdoc.7:110
3853 #: build/C/man7/mdoc.7:110
3855 msgid "Ar DESCRIPTION"
3859 #: build/C/man7/mdoc.7:113
3860 msgid "General description, should include options and parameters."
3864 #: build/C/man7/mdoc.7:113
3866 msgid "Ar RETURN VALUE"
3870 #: build/C/man7/mdoc.7:115
3871 msgid "Sections two and three function calls."
3875 #: build/C/man7/mdoc.7:115
3877 msgid "Ar ENVIRONMENT"
3881 #: build/C/man7/mdoc.7:117
3882 msgid "Describe environment variables."
3886 #: build/C/man7/mdoc.7:117
3892 #: build/C/man7/mdoc.7:119
3893 msgid "Files associated with the subject."
3897 #: build/C/man7/mdoc.7:119
3903 #: build/C/man7/mdoc.7:121
3904 msgid "Examples and suggestions."
3908 #: build/C/man7/mdoc.7:121
3910 msgid "Ar DIAGNOSTICS"
3914 #: build/C/man7/mdoc.7:123
3915 msgid "Normally used for section four device interface diagnostics."
3919 #: build/C/man7/mdoc.7:123
3925 #: build/C/man7/mdoc.7:126
3926 msgid "Sections two and three error and signal handling."
3930 #: build/C/man7/mdoc.7:126
3936 #: build/C/man7/mdoc.7:128
3937 msgid "Cross references and citations."
3941 #: build/C/man7/mdoc.7:128
3943 msgid "Ar CONFORMING TO"
3947 #: build/C/man7/mdoc.7:130
3948 msgid "Conformance to standards if applicable."
3952 #: build/C/man7/mdoc.7:130
3958 #: build/C/man7/mdoc.7:133
3959 msgid "If a standard is not applicable, the history of the subject should be given."
3963 #: build/C/man7/mdoc.7:133
3969 #: build/C/man7/mdoc.7:135
3970 msgid "Gotchas and caveats."
3974 #: build/C/man7/mdoc.7:135
3980 #: build/C/man7/mdoc.7:138
3981 msgid "Customized headers may be added at the authors discretion."
3985 #: build/C/man7/mdoc.7:139
3991 #: build/C/man7/mdoc.7:141
3992 msgid "Subsection Headers."
3996 #: build/C/man7/mdoc.7:141
4002 #: build/C/man7/mdoc.7:144
4003 msgid "Paragraph Break. Vertical space (one line)."
4007 #: build/C/man7/mdoc.7:144 build/C/man7/mdoc.samples.7:2200
4013 #: build/C/man7/mdoc.7:147
4014 msgid "(D-one) Display-one Indent and display one text line."
4018 #: build/C/man7/mdoc.7:147 build/C/man7/mdoc.samples.7:2208
4024 #: build/C/man7/mdoc.7:150
4025 msgid "(D-ell) Display-one literal. Indent and display one line of literal text."
4029 #: build/C/man7/mdoc.7:150 build/C/man7/mdoc.samples.7:2228
4035 #: build/C/man7/mdoc.7:153
4036 msgid "Begin-display block. Display options:"
4040 #: build/C/man7/mdoc.7:154 build/C/man7/mdoc.samples.7:2248
4046 #: build/C/man7/mdoc.7:156
4047 msgid "Unjustified (ragged edges)."
4051 #: build/C/man7/mdoc.7:156 build/C/man7/mdoc.samples.7:2251
4057 #: build/C/man7/mdoc.7:158
4062 #: build/C/man7/mdoc.7:158 build/C/man7/mdoc.samples.7:2255
4068 #: build/C/man7/mdoc.7:160
4069 msgid "Literal text or code."
4073 #: build/C/man7/mdoc.7:160
4075 msgid "Fl file Ar name"
4079 #: build/C/man7/mdoc.7:164
4080 msgid "Read in named E<.Ar file> and display."
4084 #: build/C/man7/mdoc.7:164 build/C/man7/mdoc.samples.7:2267
4086 msgid "Fl offset Ar string"
4090 #: build/C/man7/mdoc.7:169
4091 msgid "Offset display. Acceptable E<.Ar string> values:"
4095 #: build/C/man7/mdoc.7:170 build/C/man7/mdoc.samples.7:2275
4101 #: build/C/man7/mdoc.7:172
4102 msgid "Align block on left (default)."
4106 #: build/C/man7/mdoc.7:172 build/C/man7/mdoc.samples.7:2279
4112 #: build/C/man7/mdoc.7:174
4113 msgid "Approximate center margin."
4117 #: build/C/man7/mdoc.7:174 build/C/man7/mdoc.samples.7:2284
4123 #: build/C/man7/mdoc.7:176
4124 msgid "Six constant width spaces (a tab)."
4128 #: build/C/man7/mdoc.7:176 build/C/man7/mdoc.samples.7:2293
4130 msgid "Ar indent-two"
4134 #: build/C/man7/mdoc.7:178
4139 #: build/C/man7/mdoc.7:178 build/C/man7/mdoc.samples.7:2295
4145 #: build/C/man7/mdoc.7:181
4146 msgid "Left aligns block 2 inches from right."
4150 #: build/C/man7/mdoc.7:181
4152 msgid "Ar xx Ns Cm n"
4156 #: build/C/man7/mdoc.7:188
4158 "Where E<.Ar xx> is a number from E<.No \\&4 Ns Cm n> to E<.No \\&9\\&9 Ns Cm "
4163 #: build/C/man7/mdoc.7:188
4169 #: build/C/man7/mdoc.7:192
4170 msgid "Where E<.Ar Aa> is a callable macro name."
4174 #: build/C/man7/mdoc.7:192
4180 #: build/C/man7/mdoc.7:196
4181 msgid "The width of E<.Ar string> is used."
4185 #: build/C/man7/mdoc.7:198
4191 #: build/C/man7/mdoc.7:200
4192 msgid "End-display (matches \\&.Bd)."
4196 #: build/C/man7/mdoc.7:200
4202 #: build/C/man7/mdoc.7:204
4203 msgid "Begin-list. Create lists or columns. Options:"
4207 #: build/C/man7/mdoc.7:205
4209 msgid "Ar List-types"
4213 #: build/C/man7/mdoc.7:207
4215 msgid "Fl bullet Ta \"Bullet Item List\""
4219 #: build/C/man7/mdoc.7:208
4221 msgid "Fl item Ta \"Unlabeled List\""
4225 #: build/C/man7/mdoc.7:209
4227 msgid "Fl enum Ta \"Enumerated List\""
4231 #: build/C/man7/mdoc.7:210
4233 msgid "Fl tag Ta \"Tag Labeled List\""
4237 #: build/C/man7/mdoc.7:211
4239 msgid "Fl diag Ta \"Diagnostic List\""
4243 #: build/C/man7/mdoc.7:212
4245 msgid "Fl hang Ta \"Hanging Labeled List\""
4249 #: build/C/man7/mdoc.7:213
4251 msgid "Fl ohang Ta \"Overhanging Labeled List\""
4255 #: build/C/man7/mdoc.7:214
4257 msgid "Fl inset Ta \"Inset or Run-on Labeled List\""
4261 #: build/C/man7/mdoc.7:216
4263 msgid "List-parameters"
4267 #: build/C/man7/mdoc.7:218
4273 #: build/C/man7/mdoc.7:222
4274 msgid "(All lists.) See E<.Ql \\&.Bd> begin-display above."
4278 #: build/C/man7/mdoc.7:222
4284 #: build/C/man7/mdoc.7:229
4285 msgid "E<.Pf ( Fl tag> and E<.Fl hang> lists only.) See E<.Ql \\&.Bd>."
4289 #: build/C/man7/mdoc.7:229
4295 #: build/C/man7/mdoc.7:232
4296 msgid "(All lists.) Suppresses blank lines."
4300 #: build/C/man7/mdoc.7:234
4306 #: build/C/man7/mdoc.7:236
4311 #: build/C/man7/mdoc.7:236
4317 #: build/C/man7/mdoc.7:238
4322 #: build/C/man7/mdoc.7:239
4324 msgid "MANUAL AND GENERAL TEXT DOMAIN MACROS"
4328 #: build/C/man7/mdoc.7:243
4330 "The manual and general text domain macros are special in that most of them "
4331 "are parsed for callable macros for example:"
4335 #: build/C/man7/mdoc.7:244
4337 msgid "Li \"\\&.Op Fl s Ar file\""
4341 #: build/C/man7/mdoc.7:247
4342 msgid "Produces E<.Op Fl s Ar file>"
4346 #: build/C/man7/mdoc.7:265
4348 "In this example, the option enclosure macro E<.Ql \\&.Op> is parsed, and "
4349 "calls the callable content macro E<.Ql \\&Fl> which operates on the argument "
4350 "E<.Ql s> and then calls the callable content macro E<.Ql \\&Ar> which "
4351 "operates on the argument E<.Ql file>. Some macros may be callable, but are "
4352 "not parsed and vice versa. These macros are indicated in the E<.Em parsed> "
4353 "and E<.Em callable> columns below."
4357 #: build/C/man7/mdoc.7:267
4358 msgid "Unless stated, manual domain macros share a common syntax:"
4362 #: build/C/man7/mdoc.7:268
4364 msgid "\\&.Va argument [\\ .\\ ,\\ ;\\ :\\ (\\ )\\ [\\ ]\\ argument ...\\ ]"
4368 #: build/C/man7/mdoc.7:288
4370 "E<.Sy Note>: Opening and closing punctuation characters are recognized as "
4371 "such only if they are presented one at a time. The string E<.Ql \"),\"> is "
4372 "not recognized as punctuation and will be output with a leading white space "
4373 "and in what ever font the calling macro uses. The argument list E<.Ql \"] ) "
4374 ",\"> is recognized as three sequential closing punctuation characters and a "
4375 "leading white space is not output between the characters and the previous "
4376 "argument (if any). The special meaning of a punctuation character may be "
4377 "escaped with the string E<.Ql \\e&>. For example the following string,"
4381 #: build/C/man7/mdoc.7:289
4383 msgid "Li \"\\&.Ar file1\\ , file2\\ , file3\\ )\\ .\""
4387 #: build/C/man7/mdoc.7:292
4388 msgid "Produces E<.Ar file1 , file2 , file3>)."
4392 #: build/C/man7/mdoc.7:294
4394 msgid "Manual Domain Macros"
4398 #: build/C/man7/mdoc.7:296 build/C/man7/mdoc.7:321
4400 msgid "Em \"Name\tParsed\tCallable\tDescription\""
4404 #: build/C/man7/mdoc.7:297
4406 msgid "Li \\&Ad Ta Yes Ta Yes Ta \"Address. (This macro may be deprecated.)\""
4410 #: build/C/man7/mdoc.7:298
4412 msgid "Li \\&An Ta Yes Ta Yes Ta \"Author name.\""
4416 #: build/C/man7/mdoc.7:299
4418 msgid "Li \\&Ar Ta Yes Ta Yes Ta \"Command-line argument.\""
4422 #: build/C/man7/mdoc.7:300
4425 "Li \\&Cd Ta \\&No Ta \\&No Ta \"Configuration declaration (section four "
4430 #: build/C/man7/mdoc.7:301
4432 msgid "Li \\&Cm Ta Yes Ta Yes Ta \"Command-line argument modifier.\""
4436 #: build/C/man7/mdoc.7:302
4438 msgid "Li \\&Dv Ta Yes Ta Yes Ta \"Defined variable (source code).\""
4442 #: build/C/man7/mdoc.7:303
4444 msgid "Li \\&Er Ta Yes Ta Yes Ta \"Error number (source code).\""
4448 #: build/C/man7/mdoc.7:304
4450 msgid "Li \\&Ev Ta Yes Ta Yes Ta \"Environment variable.\""
4454 #: build/C/man7/mdoc.7:305
4456 msgid "Li \\&Fa Ta Yes Ta Yes Ta \"Function argument.\""
4460 #: build/C/man7/mdoc.7:306
4462 msgid "Li \\&Fd Ta Yes Ta Yes Ta \"Function declaration.\""
4466 #: build/C/man7/mdoc.7:307
4468 msgid "Li \\&Fn Ta Yes Ta Yes Ta \"Function call (also .Fo and .Fc).\""
4472 #: build/C/man7/mdoc.7:308
4474 msgid "Li \\&Ic Ta Yes Ta Yes Ta \"Interactive command.\""
4478 #: build/C/man7/mdoc.7:309
4480 msgid "Li \\&Li Ta Yes Ta Yes Ta \"Literal text.\""
4484 #: build/C/man7/mdoc.7:310
4486 msgid "Li \\&Nm Ta Yes Ta Yes Ta \"Command name.\""
4490 #: build/C/man7/mdoc.7:311
4492 msgid "Li \\&Op Ta Yes Ta Yes Ta \"Option (also .Oo and .Oc).\""
4496 #: build/C/man7/mdoc.7:312
4498 msgid "Li \\&Ot Ta Yes Ta Yes Ta \"Old style function type (Fortran only).\""
4502 #: build/C/man7/mdoc.7:313
4504 msgid "Li \\&Pa Ta Yes Ta Yes Ta \"Pathname or filename.\""
4508 #: build/C/man7/mdoc.7:314
4510 msgid "Li \\&St Ta Yes Ta Yes Ta \"Standards (\\-p1003.2, \\-p1003.1 or \\-ansiC)\""
4514 #: build/C/man7/mdoc.7:315
4516 msgid "Li \\&Va Ta Yes Ta Yes Ta \"Variable name.\""
4520 #: build/C/man7/mdoc.7:316
4522 msgid "Li \\&Vt Ta Yes Ta Yes Ta \"Variable type (Fortran only).\""
4526 #: build/C/man7/mdoc.7:317
4528 msgid "Li \\&Xr Ta Yes Ta Yes Ta \"Manual Page Cross Reference.\""
4532 #: build/C/man7/mdoc.7:319
4534 msgid "General Text Domain Macros"
4538 #: build/C/man7/mdoc.7:322
4540 msgid "Li \\&%A Ta Yes Ta \\&No Ta \"Reference author.\""
4544 #: build/C/man7/mdoc.7:323
4546 msgid "Li \\&%B Ta Yes Ta Yes Ta \"Reference book title.\""
4550 #: build/C/man7/mdoc.7:324
4552 msgid "Li \\&%\\&C Ta \\&No Ta \\&No Ta \"Reference place of publishing (city).\""
4556 #: build/C/man7/mdoc.7:325
4558 msgid "Li \\&%\\&D Ta \\&No Ta \\&No Ta \"Reference date.\""
4562 #: build/C/man7/mdoc.7:326
4564 msgid "Li \\&%J Ta Yes Ta Yes Ta \"Reference journal title.\""
4568 #: build/C/man7/mdoc.7:327
4570 msgid "Li \\&%N Ta \\&No Ta \\&No Ta \"Reference issue number.\""
4574 #: build/C/man7/mdoc.7:328
4576 msgid "Li \\&%\\&O Ta \\&No Ta \\&No Ta \"Reference optional information.\""
4580 #: build/C/man7/mdoc.7:329
4582 msgid "Li \\&%P Ta \\&No Ta \\&No Ta \"Reference page number(s).\""
4586 #: build/C/man7/mdoc.7:330
4588 msgid "Li \\&%R Ta \\&No Ta \\&No Ta \"Reference report Name.\""
4592 #: build/C/man7/mdoc.7:331
4594 msgid "Li \\&%T Ta Yes Ta Yes Ta \"Reference article title.\""
4598 #: build/C/man7/mdoc.7:332
4600 msgid "Li \\&%V Ta \\&No Ta \\&No Ta \"Reference volume.\""
4604 #: build/C/man7/mdoc.7:333
4606 msgid "Li \\&Ac Ta Yes Ta Yes Ta \"Angle close quote.\""
4610 #: build/C/man7/mdoc.7:334
4612 msgid "Li \\&Ao Ta Yes Ta Yes Ta \"Angle open quote.\""
4616 #: build/C/man7/mdoc.7:335
4618 msgid "Li \\&Ap Ta Yes Ta Yes Ta Apostrophe."
4622 #: build/C/man7/mdoc.7:336
4624 msgid "Li \\&Aq Ta Yes Ta Yes Ta \"Angle quote.\""
4628 #: build/C/man7/mdoc.7:337
4630 msgid "Li \\&At Ta \\&No Ta \\&No Ta Tn \"AT&T UNIX\""
4634 #: build/C/man7/mdoc.7:338
4636 msgid "Li \\&Bc Ta Yes Ta Yes Ta \"Bracket close quote.\""
4640 #: build/C/man7/mdoc.7:339
4642 msgid "Li \\&Bf Ta \\&No Ta \\&No Ta \"Begin font mode.\""
4646 #: build/C/man7/mdoc.7:340
4648 msgid "Li \\&Bo Ta Yes Ta Yes Ta \"Bracket open quote.\""
4652 #: build/C/man7/mdoc.7:341
4654 msgid "Li \\&Bq Ta Yes Ta Yes Ta \"Bracket quote.\""
4658 #: build/C/man7/mdoc.7:342
4660 msgid "Li \\&Bx Ta Yes Ta Yes Ta Bx ."
4664 #: build/C/man7/mdoc.7:343
4666 msgid "Li \\&Db Ta \\&No Ta \\&No Ta \"Debug (default is \\*qoff\\*q)\""
4670 #: build/C/man7/mdoc.7:344
4672 msgid "Li \\&Dc Ta Yes Ta Yes Ta \"Double close quote.\""
4676 #: build/C/man7/mdoc.7:345
4678 msgid "Li \\&Do Ta Yes Ta Yes Ta \"Double open quote.\""
4682 #: build/C/man7/mdoc.7:346
4684 msgid "Li \\&Dq Ta Yes Ta Yes Ta \"Double quote.\""
4688 #: build/C/man7/mdoc.7:347
4690 msgid "Li \\&Ec Ta Yes Ta Yes Ta \"Enclose string close quote.\""
4694 #: build/C/man7/mdoc.7:348
4696 msgid "Li \\&Ef Ta \\&No Ta \\&No Ta \"End font mode.\""
4700 #: build/C/man7/mdoc.7:349
4702 msgid "Li \\&Em Ta Yes Ta Yes Ta \"Emphasis (traditional English).\""
4706 #: build/C/man7/mdoc.7:350
4708 msgid "Li \\&Eo Ta Yes Ta Yes Ta \"Enclose string open quote.\""
4712 #: build/C/man7/mdoc.7:351
4714 msgid "Li \\&Fx Ta \\&No Ta \\&No Ta Tn \"FreeBSD operating system\""
4718 #: build/C/man7/mdoc.7:352
4720 msgid "Li \\&No Ta Yes Ta Yes Ta \"Normal text (no-op).\""
4724 #: build/C/man7/mdoc.7:353
4726 msgid "Li \\&Ns Ta Yes Ta Yes Ta \"No space.\""
4730 #: build/C/man7/mdoc.7:354
4732 msgid "Li \\&Pc Ta Yes Ta Yes Ta \"Parenthesis close quote.\""
4736 #: build/C/man7/mdoc.7:355
4738 msgid "Li \\&Pf Ta Yes Ta \\&No Ta \"Prefix string.\""
4742 #: build/C/man7/mdoc.7:356
4744 msgid "Li \\&Po Ta Yes Ta Yes Ta \"Parenthesis open quote.\""
4748 #: build/C/man7/mdoc.7:357
4750 msgid "Li \\&Pq Ta Yes Ta Yes Ta \"Parentheses quote.\""
4754 #: build/C/man7/mdoc.7:358
4756 msgid "Li \\&Qc Ta Yes Ta Yes Ta \"Straight Double close quote.\""
4760 #: build/C/man7/mdoc.7:359
4762 msgid "Li \\&Ql Ta Yes Ta Yes Ta \"Quoted literal.\""
4766 #: build/C/man7/mdoc.7:360
4768 msgid "Li \\&Qo Ta Yes Ta Yes Ta \"Straight Double open quote.\""
4772 #: build/C/man7/mdoc.7:361
4774 msgid "Li \\&Qq Ta Yes Ta Yes Ta \"Straight Double quote.\""
4778 #: build/C/man7/mdoc.7:362
4780 msgid "Li \\&Re Ta \\&No Ta \\&No Ta \"Reference end.\""
4784 #: build/C/man7/mdoc.7:363
4786 msgid "Li \\&Rs Ta \\&No Ta \\&No Ta \"Reference start.\""
4790 #: build/C/man7/mdoc.7:364
4793 "Li \\&Rv Ta \\&No Ta \\&No Ta \"Return values (sections two and three "
4798 #: build/C/man7/mdoc.7:365
4800 msgid "Li \\&Sc Ta Yes Ta Yes Ta \"Single close quote.\""
4804 #: build/C/man7/mdoc.7:366
4806 msgid "Li \\&So Ta Yes Ta Yes Ta \"Single open quote.\""
4810 #: build/C/man7/mdoc.7:367
4812 msgid "Li \\&Sq Ta Yes Ta Yes Ta \"Single quote.\""
4816 #: build/C/man7/mdoc.7:368
4818 msgid "Li \\&Sm Ta \\&No Ta \\&No Ta \"Space mode (default is \\*qon\\*q)\""
4822 #: build/C/man7/mdoc.7:369
4824 msgid "Li \\&Sx Ta Yes Ta Yes Ta \"Section Cross Reference.\""
4828 #: build/C/man7/mdoc.7:370
4830 msgid "Li \\&Sy Ta Yes Ta Yes Ta \"Symbolic (traditional English).\""
4834 #: build/C/man7/mdoc.7:371
4836 msgid "Li \\&Tn Ta Yes Ta Yes Ta \"Trade or type name (small Caps).\""
4840 #: build/C/man7/mdoc.7:372
4842 msgid "Li \\&Ux Ta Yes Ta Yes Ta Ux"
4846 #: build/C/man7/mdoc.7:373
4848 msgid "Li \\&Xc Ta Yes Ta Yes Ta \"Extend argument list close.\""
4852 #: build/C/man7/mdoc.7:374
4854 msgid "Li \\&Xo Ta Yes Ta Yes Ta \"Extend argument list open.\""
4858 #: build/C/man7/mdoc.7:388
4860 "Macro names ending in E<.Ql q> quote remaining items on the argument list. "
4861 "Macro names ending in E<.Ql o> begin a quote which may span more than one "
4862 "line of input and are close quoted with the matching macro name ending in "
4863 "E<.Ql c>. Enclosure macros may be nested and are limited to eight "
4868 #: build/C/man7/mdoc.7:400
4870 "Note: the extended argument list macros E<.Pf ( Ql \\&.Xo>, E<.Ql \\&.Xc>) "
4871 "and the function enclosure macros E<.Pf ( Ql \\&.Fo>, E<.Ql \\&.Fc>) are "
4872 "irregular. The extended list macros are used when the number of macro "
4873 "arguments would exceed the E<.Xr troff> limitation of nine arguments."
4876 #. The following does not apply on Linux:
4877 #. .Sh CONFIGURATION
4878 #. For site specific configuration of the macro package,
4880 #. .Pa /usr/src/share/tmac/README .
4882 #: build/C/man7/mdoc.7:411
4884 "The macros UR (starting a URI/URL hypertext reference), UE (ending one), and "
4885 "UN (identifying a target for a reference) are also available. See E<.Xr man "
4886 "7> for more information on these macros."
4890 #: build/C/man7/mdoc.7:413
4896 #: build/C/man7/mdoc.7:415
4897 msgid "Manual and general text domain macros."
4901 #: build/C/man7/mdoc.7:415
4903 msgid "Pa tmac/doc-common"
4907 #: build/C/man7/mdoc.7:417
4908 msgid "Common structural macros and definitions."
4912 #: build/C/man7/mdoc.7:417
4914 msgid "Pa tmac/doc-nroff"
4918 #: build/C/man7/mdoc.7:421
4919 msgid "Site dependent E<.Xr nroff> style file."
4923 #: build/C/man7/mdoc.7:421
4925 msgid "Pa tmac/doc-ditroff"
4929 #: build/C/man7/mdoc.7:425
4930 msgid "Site dependent E<.Xr troff> style file."
4934 #: build/C/man7/mdoc.7:425
4936 msgid "Pa tmac/doc-syms"
4940 #: build/C/man7/mdoc.7:427
4941 msgid "Special defines (such as the standards macro)."
4945 #: build/C/man7/mdoc.7:433
4946 msgid "E<.Xr groff_mdoc 7>, E<.Xr mdoc.samples 7>, E<.Xr man 7>, E<.Xr man-pages 7>"
4950 #: build/C/man7/mdoc.7:440 build/C/man7/mdoc.samples.7:2964
4952 "This page is part of release 3.52 of the Linux E<.Em man-pages> project. A "
4953 "description of the project, and information about reporting bugs, can be "
4954 "found at \\%http://www.kernel.org/doc/man\\-pages/."
4958 #: build/C/man7/operator.7:40
4964 #: build/C/man7/operator.7:40
4970 #: build/C/man7/operator.7:43
4971 msgid "operator - C operator precedence and order of evaluation"
4975 #: build/C/man7/operator.7:45
4976 msgid "This manual page lists C operators and their precedence in evaluation."
4980 #: build/C/man7/operator.7:63
4983 "B<Operator Associativity>\n"
4984 "() [] -E<gt> . left to right\n"
4985 "! ~ ++ -- + - (type) * & sizeof right to left\n"
4986 "* / % left to right\n"
4987 "+ - left to right\n"
4988 "E<lt>E<lt> E<gt>E<gt> left to right\n"
4989 "E<lt> E<lt>= E<gt> E<gt>= left to right\n"
4990 "== != left to right\n"
4994 "&& left to right\n"
4995 "|| left to right\n"
4996 "?: right to left\n"
4997 "= += -= *= /= %= E<lt>E<lt>= E<gt>E<gt>= &= ^= |= right to left\n"
5002 #: build/C/man7/posixoptions.7:24
5004 msgid "POSIXOPTIONS"
5008 #: build/C/man7/posixoptions.7:24
5014 #: build/C/man7/posixoptions.7:27
5015 msgid "posixoptions - optional parts of the POSIX standard"
5019 #: build/C/man7/posixoptions.7:41
5021 "The POSIX standard (the information below is from POSIX.1-2001) describes a "
5022 "set of behaviors and interfaces for a compliant system. However, many "
5023 "interfaces are optional and there are feature test macros to test the "
5024 "availability of interfaces at compile time, and functions B<sysconf>(3), "
5025 "B<fpathconf>(3), B<pathconf>(3), B<confstr>(3) to do this at run time. "
5026 "From shell scripts one can use B<getconf>(1). For more detail, see "
5031 #: build/C/man7/posixoptions.7:48
5033 "We give the name of the POSIX abbreviation, the option, the name of the "
5034 "B<sysconf>(3) parameter used to inquire about the option, and possibly a "
5035 "very short description. Much more precise detail can be found in the POSIX "
5036 "standard itself, versions of which can nowadays be accessed freely on the "
5041 #: build/C/man7/posixoptions.7:48
5043 msgid "ADV - _POSIX_ADVISORY_INFO - _SC_ADVISORY_INFO"
5047 #: build/C/man7/posixoptions.7:50
5048 msgid "The following advisory functions are present:"
5052 #: build/C/man7/posixoptions.7:58
5055 "I<posix_fadvise>(),\n"
5056 "I<posix_fallocate>(),\n"
5057 "I<posix_memalign>(),\n"
5058 "I<posix_madvise>().\n"
5062 #: build/C/man7/posixoptions.7:61
5064 msgid "AIO - _POSIX_ASYNCHRONOUS_IO - _SC_ASYNCHRONOUS_IO"
5068 #: build/C/man7/posixoptions.7:66
5070 "The header I<E<lt>aio.hE<gt>> is present. The following functions are "
5075 #: build/C/man7/posixoptions.7:78
5078 "I<aio_cancel>(),\n"
5082 "I<aio_return>(),\n"
5083 "I<aio_suspend>(),\n"
5085 "I<lio_listio>().\n"
5089 #: build/C/man7/posixoptions.7:81
5091 msgid "BAR - _POSIX_BARRIERS - _SC_BARRIERS"
5095 #: build/C/man7/posixoptions.7:88 build/C/man7/posixoptions.7:458
5097 "This option implies the B<_POSIX_THREADS> and "
5098 "B<_POSIX_THREAD_SAFE_FUNCTIONS> options. The following functions are "
5103 #: build/C/man7/posixoptions.7:97
5106 "I<pthread_barrier_destroy>(),\n"
5107 "I<pthread_barrier_init>(),\n"
5108 "I<pthread_barrier_wait>(),\n"
5109 "I<pthread_barrierattr_destroy>(),\n"
5110 "I<pthread_barrierattr_init>().\n"
5114 #. Batch environment.
5118 #: build/C/man7/posixoptions.7:104
5120 msgid "--- - POSIX_CHOWN_RESTRICTED"
5123 #. What about lchown() ?
5125 #: build/C/man7/posixoptions.7:112
5127 "If this option is in effect (as it always is under POSIX.1-2001) then only "
5128 "root may change the owner of a file, and nonroot can set the group of a file "
5129 "only to one of the groups it belongs to. This affects the functions "
5130 "I<chown>(), I<fchown>()."
5134 #: build/C/man7/posixoptions.7:112
5136 msgid "CS - _POSIX_CLOCK_SELECTION - _SC_CLOCK_SELECTION"
5140 #: build/C/man7/posixoptions.7:117
5142 "This option implies the B<_POSIX_TIMERS> option. The following functions "
5147 #: build/C/man7/posixoptions.7:124
5150 "I<pthread_condattr_getclock>(),\n"
5151 "I<pthread_condattr_setclock>(),\n"
5152 "I<clock_nanosleep>().\n"
5156 #: build/C/man7/posixoptions.7:132
5158 "If B<CLOCK_REALTIME> is changed by the function I<clock_settime>(), then "
5159 "this affects all timers set for an absolute time."
5163 #: build/C/man7/posixoptions.7:132
5165 msgid "CPT - _POSIX_CPUTIME - _SC_CPUTIME"
5169 #. Fortran development
5173 #: build/C/man7/posixoptions.7:145
5175 "The clockID CLOCK_PROCESS_CPUTIME_ID is supported. The initial value of "
5176 "this clock is 0 for each process. This option implies the B<_POSIX_TIMERS> "
5177 "option. The function I<clock_getcpuclockid>() is present."
5181 #: build/C/man7/posixoptions.7:145
5183 msgid "--- - _POSIX_FILE_LOCKING - _SC_FILE_LOCKING"
5187 #. IEC 60559 Floating-Point Option.
5189 #: build/C/man7/posixoptions.7:148 build/C/man7/posixoptions.7:238
5190 msgid "This option has been deleted. Not in final XPG6."
5194 #: build/C/man7/posixoptions.7:148
5196 msgid "FSC - _POSIX_FSYNC - _SC_FSYNC"
5200 #: build/C/man7/posixoptions.7:152
5201 msgid "The function I<fsync>() is present."
5205 #: build/C/man7/posixoptions.7:152
5207 msgid "IP6 - _POSIX_IPV6 - _SC_IPV6"
5211 #: build/C/man7/posixoptions.7:154
5212 msgid "Internet Protocol Version 6 is supported."
5216 #: build/C/man7/posixoptions.7:154
5218 msgid "--- - _POSIX_JOB_CONTROL - _SC_JOB_CONTROL"
5222 #: build/C/man7/posixoptions.7:158
5224 "If this option is in effect (as it always is under POSIX.1-2001) then the "
5225 "system implements POSIX-style job control, and the following functions are "
5230 #: build/C/man7/posixoptions.7:169
5237 "I<tcsendbreak>(),\n"
5243 #: build/C/man7/posixoptions.7:171
5245 msgid "MF - _POSIX_MAPPED_FILES - _SC_MAPPED_FILES"
5249 #: build/C/man7/posixoptions.7:180
5251 "Shared memory is supported. The include file I<E<lt>sys/mman.hE<gt>> is "
5252 "present. The following functions are present: I<mmap>(), I<msync>(), "
5257 #: build/C/man7/posixoptions.7:180
5259 msgid "ML - _POSIX_MEMLOCK - _SC_MEMLOCK"
5263 #: build/C/man7/posixoptions.7:186
5265 "Shared memory can be locked into core. The functions I<mlockall>(), "
5266 "I<munlockall>() are present."
5270 #: build/C/man7/posixoptions.7:186
5272 msgid "MR/MLR - _POSIX_MEMLOCK_RANGE - _SC_MEMLOCK_RANGE"
5276 #: build/C/man7/posixoptions.7:192
5278 "More precisely, ranges can be locked into core. The functions I<mlock>(), "
5279 "I<munlock>() are present."
5283 #: build/C/man7/posixoptions.7:192
5285 msgid "MPR - _POSIX_MEMORY_PROTECTION - _SC_MEMORY_PROTECTION"
5289 #: build/C/man7/posixoptions.7:196
5290 msgid "The function I<mprotect>() is present."
5294 #: build/C/man7/posixoptions.7:196
5296 msgid "MSG - _POSIX_MESSAGE_PASSING - _SC_MESSAGE_PASSING"
5300 #: build/C/man7/posixoptions.7:201
5302 "The include file I<E<lt>mqueue.hE<gt>> is present. The following functions "
5307 #: build/C/man7/posixoptions.7:213
5311 "I<mq_getattr>(),\n"
5314 "I<mq_receive>(),\n"
5316 "I<mq_setattr>(),\n"
5321 #: build/C/man7/posixoptions.7:216
5323 msgid "MON - _POSIX_MONOTONIC_CLOCK - _SC_MONOTONIC_CLOCK"
5327 #: build/C/man7/posixoptions.7:223
5329 "B<CLOCK_MONOTONIC> is supported. This option implies the B<_POSIX_TIMERS> "
5330 "option. Affected functions are"
5334 #: build/C/man7/posixoptions.7:231
5337 "I<aio_suspend>(),\n"
5338 "I<clock_getres>(),\n"
5339 "I<clock_gettime>(),\n"
5340 "I<clock_settime>(),\n"
5341 "I<timer_create>().\n"
5345 #: build/C/man7/posixoptions.7:233
5347 msgid "--- - _POSIX_MULTI_PROCESS - _SC_MULTI_PROCESS"
5351 #: build/C/man7/posixoptions.7:238
5353 msgid "--- - _POSIX_NO_TRUNC"
5357 #: build/C/man7/posixoptions.7:245
5359 "If this option is in effect (as it always is under POSIX.1-2001) then "
5360 "pathname components longer than B<NAME_MAX> are not truncated, but give an "
5361 "error. This property may be dependent on the path prefix of the component."
5365 #: build/C/man7/posixoptions.7:245
5367 msgid "PIO - _POSIX_PRIORITIZED_IO - _SC_PRIORITIZED_IO"
5371 #: build/C/man7/posixoptions.7:248
5373 "This option says that one can specify priorities for asynchronous I/O. This "
5374 "affects the functions"
5378 #: build/C/man7/posixoptions.7:254
5386 #: build/C/man7/posixoptions.7:256
5388 msgid "PS - _POSIX_PRIORITY_SCHEDULING - _SC_PRIORITY_SCHEDULING"
5392 #: build/C/man7/posixoptions.7:261
5394 "The include file I<E<lt>sched.hE<gt>> is present. The following functions "
5399 #: build/C/man7/posixoptions.7:273
5402 "I<sched_get_priority_max>(),\n"
5403 "I<sched_get_priority_min>(),\n"
5404 "I<sched_getparam>(),\n"
5405 "I<sched_getscheduler>(),\n"
5406 "I<sched_rr_get_interval>(),\n"
5407 "I<sched_setparam>(),\n"
5408 "I<sched_setscheduler>(),\n"
5409 "I<sched_yield>().\n"
5413 #: build/C/man7/posixoptions.7:279
5415 "If also B<_POSIX_SPAWN> is in effect, then the following functions are "
5420 #: build/C/man7/posixoptions.7:287 build/C/man7/posixoptions.7:449
5423 "I<posix_spawnattr_getschedparam>(),\n"
5424 "I<posix_spawnattr_getschedpolicy>(),\n"
5425 "I<posix_spawnattr_setschedparam>(),\n"
5426 "I<posix_spawnattr_setschedpolicy>().\n"
5430 #: build/C/man7/posixoptions.7:289
5432 msgid "RS - _POSIX_RAW_SOCKETS"
5436 #: build/C/man7/posixoptions.7:294
5438 "Raw sockets are supported. Affected functions are I<getsockopt>(), "
5443 #: build/C/man7/posixoptions.7:294
5445 msgid "--- - _POSIX_READER_WRITER_LOCKS - _SC_READER_WRITER_LOCKS"
5449 #: build/C/man7/posixoptions.7:302
5451 "This option implies the B<_POSIX_THREADS> option. Conversely, under "
5452 "POSIX.1-2001 the B<_POSIX_THREADS> option implies this option."
5456 #: build/C/man7/posixoptions.7:304
5458 msgid "The following functions are present:\n"
5462 #: build/C/man7/posixoptions.7:315
5465 "I<pthread_rwlock_destroy>(),\n"
5466 "I<pthread_rwlock_init>(),\n"
5467 "I<pthread_rwlock_rdlock>(),\n"
5468 "I<pthread_rwlock_tryrdlock>(),\n"
5469 "I<pthread_rwlock_trywrlock>(),\n"
5470 "I<pthread_rwlock_unlock>(),\n"
5471 "I<pthread_rwlock_wrlock>(),\n"
5472 "I<pthread_rwlockattr_destroy>(),\n"
5473 "I<pthread_rwlockattr_init>().\n"
5477 #: build/C/man7/posixoptions.7:317
5479 msgid "RTS - _POSIX_REALTIME_SIGNALS - _SC_REALTIME_SIGNALS"
5483 #: build/C/man7/posixoptions.7:320
5484 msgid "Realtime signals are supported. The following functions are present:"
5488 #: build/C/man7/posixoptions.7:327
5492 "I<sigtimedwait>(),\n"
5493 "I<sigwaitinfo>().\n"
5497 #: build/C/man7/posixoptions.7:330
5499 msgid "--- - _POSIX_REGEXP - _SC_REGEXP"
5503 #: build/C/man7/posixoptions.7:334
5505 "If this option is in effect (as it always is under POSIX.1-2001) then POSIX "
5506 "regular expressions are supported and the following functions are present:"
5510 #: build/C/man7/posixoptions.7:342
5520 #: build/C/man7/posixoptions.7:345
5522 msgid "--- - _POSIX_SAVED_IDS - _SC_SAVED_IDS"
5526 #: build/C/man7/posixoptions.7:349
5528 "If this option is in effect (as it always is under POSIX.1-2001) then a "
5529 "process has a saved set-user-ID and a saved set-group-ID. Affected "
5534 #: build/C/man7/posixoptions.7:359
5546 #. Software development
5548 #: build/C/man7/posixoptions.7:364
5550 msgid "SEM - _POSIX_SEMAPHORES - _SC_SEMAPHORES"
5554 #: build/C/man7/posixoptions.7:369
5556 "The include file I<E<lt>semaphore.hE<gt>> is present. The following "
5557 "functions are present:"
5561 #: build/C/man7/posixoptions.7:382
5565 "I<sem_destroy>(),\n"
5566 "I<sem_getvalue>(),\n"
5570 "I<sem_trywait>(),\n"
5571 "I<sem_unlink>(),\n"
5576 #: build/C/man7/posixoptions.7:385
5578 msgid "SHM - _POSIX_SHARED_MEMORY_OBJECTS - _SC_SHARED_MEMORY_OBJECTS"
5582 #: build/C/man7/posixoptions.7:387 build/C/man7/posixoptions.7:703 build/C/man7/posixoptions.7:719 build/C/man7/posixoptions.7:833
5583 msgid "The following functions are present:"
5587 #: build/C/man7/posixoptions.7:395
5593 "I<shm_unlink>().\n"
5597 #: build/C/man7/posixoptions.7:398
5599 msgid "--- - _POSIX_SHELL - _SC_SHELL"
5603 #: build/C/man7/posixoptions.7:403
5605 "If this option is in effect (as it always is under POSIX.1-2001), the "
5606 "function I<system>() is present."
5610 #: build/C/man7/posixoptions.7:403
5612 msgid "SPN - _POSIX_SPAWN - _SC_SPAWN"
5616 #: build/C/man7/posixoptions.7:413
5618 "This option describes support for process creation in a context where it is "
5619 "difficult or impossible to use I<fork>(), for example, because no MMU is "
5620 "present. If B<_POSIX_SPAWN> is in effect, then the include file "
5621 "I<E<lt>spawn.hE<gt>> and the following functions are present:"
5625 #: build/C/man7/posixoptions.7:434
5628 "I<posix_spawn>(),\n"
5629 "I<posix_spawn_file_actions_addclose>(),\n"
5630 "I<posix_spawn_file_actions_adddup2>(),\n"
5631 "I<posix_spawn_file_actions_addopen>(),\n"
5632 "I<posix_spawn_file_actions_destroy>(),\n"
5633 "I<posix_spawn_file_actions_init>(),\n"
5634 "I<posix_spawnattr_destroy>(),\n"
5635 "I<posix_spawnattr_getsigdefault>(),\n"
5636 "I<posix_spawnattr_getflags>(),\n"
5637 "I<posix_spawnattr_getpgroup>(),\n"
5638 "I<posix_spawnattr_getsigmask>(),\n"
5639 "I<posix_spawnattr_init>(),\n"
5640 "I<posix_spawnattr_setsigdefault>(),\n"
5641 "I<posix_spawnattr_setflags>(),\n"
5642 "I<posix_spawnattr_setpgroup>(),\n"
5643 "I<posix_spawnattr_setsigmask>(),\n"
5644 "I<posix_spawnp>().\n"
5648 #: build/C/man7/posixoptions.7:441
5650 "If also B<_POSIX_PRIORITY_SCHEDULING> is in effect, then the following "
5651 "functions are present:"
5655 #: build/C/man7/posixoptions.7:451
5657 msgid "SPI - _POSIX_SPIN_LOCKS - _SC_SPIN_LOCKS"
5661 #: build/C/man7/posixoptions.7:467
5664 "I<pthread_spin_destroy>(),\n"
5665 "I<pthread_spin_init>(),\n"
5666 "I<pthread_spin_lock>(),\n"
5667 "I<pthread_spin_trylock>(),\n"
5668 "I<pthread_spin_unlock>().\n"
5672 #: build/C/man7/posixoptions.7:470
5674 msgid "SS - _POSIX_SPORADIC_SERVER - _SC_SPORADIC_SERVER"
5678 #: build/C/man7/posixoptions.7:478
5680 "The scheduling policy B<SCHED_SPORADIC> is supported. This option implies "
5681 "the B<_POSIX_PRIORITY_SCHEDULING> option. Affected functions are"
5685 #: build/C/man7/posixoptions.7:484
5688 "I<sched_setparam>(),\n"
5689 "I<sched_setscheduler>().\n"
5693 #: build/C/man7/posixoptions.7:487
5695 msgid "SIO - _POSIX_SYNCHRONIZED_IO - _SC_SYNCHRONIZED_IO"
5699 #: build/C/man7/posixoptions.7:493
5700 msgid "Affected functions are I<open>(), I<msync>(), I<fsync>(), I<fdatasync>()."
5704 #: build/C/man7/posixoptions.7:493
5706 msgid "TSA - _POSIX_THREAD_ATTR_STACKADDR - _SC_THREAD_ATTR_STACKADDR"
5710 #: build/C/man7/posixoptions.7:495 build/C/man7/posixoptions.7:508 build/C/man7/posixoptions.7:539 build/C/man7/posixoptions.7:550 build/C/man7/posixoptions.7:585 build/C/man7/posixoptions.7:602
5711 msgid "Affected functions are"
5715 #: build/C/man7/posixoptions.7:503
5718 "I<pthread_attr_getstack>(),\n"
5719 "I<pthread_attr_getstackaddr>(),\n"
5720 "I<pthread_attr_setstack>(),\n"
5721 "I<pthread_attr_setstackaddr>().\n"
5725 #: build/C/man7/posixoptions.7:506
5727 msgid "TSS - _POSIX_THREAD_ATTR_STACKSIZE - _SC_THREAD_ATTR_STACKSIZE"
5731 #: build/C/man7/posixoptions.7:516
5734 "I<pthread_attr_getstack>(),\n"
5735 "I<pthread_attr_getstacksize>(),\n"
5736 "I<pthread_attr_setstack>(),\n"
5737 "I<pthread_attr_setstacksize>().\n"
5741 #: build/C/man7/posixoptions.7:519
5743 msgid "TCT - _POSIX_THREAD_CPUTIME - _SC_THREAD_CPUTIME"
5747 #: build/C/man7/posixoptions.7:525
5749 "The clockID CLOCK_THREAD_CPUTIME_ID is supported. This option implies the "
5750 "B<_POSIX_TIMERS> option. Affected functions are"
5754 #: build/C/man7/posixoptions.7:534
5757 "I<pthread_getcpuclockid>(),\n"
5758 "I<clock_getres>(),\n"
5759 "I<clock_gettime>(),\n"
5760 "I<clock_settime>(),\n"
5761 "I<timer_create>().\n"
5765 #: build/C/man7/posixoptions.7:537
5767 msgid "TPI - _POSIX_THREAD_PRIO_INHERIT - _SC_THREAD_PRIO_INHERIT"
5771 #: build/C/man7/posixoptions.7:545
5774 "I<pthread_mutexattr_getprotocol>(),\n"
5775 "I<pthread_mutexattr_setprotocol>().\n"
5779 #: build/C/man7/posixoptions.7:548
5781 msgid "TPP - _POSIX_THREAD_PRIO_PROTECT - _SC_THREAD_PRIO_PROTECT"
5785 #: build/C/man7/posixoptions.7:560
5788 "I<pthread_mutex_getprioceiling>(),\n"
5789 "I<pthread_mutex_setprioceiling>(),\n"
5790 "I<pthread_mutexattr_getprioceiling>(),\n"
5791 "I<pthread_mutexattr_getprotocol>(),\n"
5792 "I<pthread_mutexattr_setprioceiling>(),\n"
5793 "I<pthread_mutexattr_setprotocol>().\n"
5797 #: build/C/man7/posixoptions.7:563
5799 msgid "TPS - _POSIX_THREAD_PRIORITY_SCHEDULING - _SC_THREAD_PRIORITY_SCHEDULING"
5803 #: build/C/man7/posixoptions.7:567
5805 "If this option is in effect, the different threads inside a process can run "
5806 "with different priorities and/or different schedulers. Affected functions "
5811 #: build/C/man7/posixoptions.7:580
5814 "I<pthread_attr_getinheritsched>(),\n"
5815 "I<pthread_attr_getschedpolicy>(),\n"
5816 "I<pthread_attr_getscope>(),\n"
5817 "I<pthread_attr_setinheritsched>(),\n"
5818 "I<pthread_attr_setschedpolicy>(),\n"
5819 "I<pthread_attr_setscope>(),\n"
5820 "I<pthread_getschedparam>(),\n"
5821 "I<pthread_setschedparam>(),\n"
5822 "I<pthread_setschedprio>().\n"
5826 #: build/C/man7/posixoptions.7:583
5828 msgid "TSH - _POSIX_THREAD_PROCESS_SHARED - _SC_THREAD_PROCESS_SHARED"
5832 #: build/C/man7/posixoptions.7:597
5835 "I<pthread_barrierattr_getpshared>(),\n"
5836 "I<pthread_barrierattr_setpshared>(),\n"
5837 "I<pthread_condattr_getpshared>(),\n"
5838 "I<pthread_condattr_setpshared>(),\n"
5839 "I<pthread_mutexattr_getpshared>(),\n"
5840 "I<pthread_mutexattr_setpshared>(),\n"
5841 "I<pthread_rwlockattr_getpshared>(),\n"
5842 "I<pthread_rwlockattr_setpshared>().\n"
5846 #: build/C/man7/posixoptions.7:600
5848 msgid "TSF - _POSIX_THREAD_SAFE_FUNCTIONS - _SC_THREAD_SAFE_FUNCTIONS"
5852 #: build/C/man7/posixoptions.7:625
5856 "I<getgrgid_r>(),\n"
5857 "I<getgrnam_r>(),\n"
5858 "I<getpwnam_r>(),\n"
5859 "I<getpwuid_r>(),\n"
5861 "I<ftrylockfile>(),\n"
5862 "I<funlockfile>(),\n"
5863 "I<getc_unlocked>(),\n"
5864 "I<getchar_unlocked>(),\n"
5865 "I<putc_unlocked>(),\n"
5866 "I<putchar_unlocked>(),\n"
5868 "I<strerror_r>(),\n"
5873 "I<localtime_r>().\n"
5877 #: build/C/man7/posixoptions.7:628
5879 msgid "TSP - _POSIX_THREAD_SPORADIC_SERVER - _SC_THREAD_SPORADIC_SERVER"
5883 #: build/C/man7/posixoptions.7:633
5885 "This option implies the B<_POSIX_THREAD_PRIORITY_SCHEDULING> option. "
5886 "Affected functions are"
5890 #: build/C/man7/posixoptions.7:640
5893 "I<sched_getparam>(),\n"
5894 "I<sched_setparam>(),\n"
5895 "I<sched_setscheduler>().\n"
5899 #: build/C/man7/posixoptions.7:643
5901 msgid "THR - _POSIX_THREADS - _SC_THREADS"
5905 #: build/C/man7/posixoptions.7:646
5907 "Basic support for POSIX threads is available. The following functions are "
5912 #: build/C/man7/posixoptions.7:698
5915 "I<pthread_atfork>(),\n"
5916 "I<pthread_attr_destroy>(),\n"
5917 "I<pthread_attr_getdetachstate>(),\n"
5918 "I<pthread_attr_getschedparam>(),\n"
5919 "I<pthread_attr_init>(),\n"
5920 "I<pthread_attr_setdetachstate>(),\n"
5921 "I<pthread_attr_setschedparam>(),\n"
5922 "I<pthread_cancel>(),\n"
5923 "I<pthread_cleanup_push>(),\n"
5924 "I<pthread_cleanup_pop>(),\n"
5925 "I<pthread_cond_broadcast>(),\n"
5926 "I<pthread_cond_destroy>(),\n"
5927 "I<pthread_cond_init>(),\n"
5928 "I<pthread_cond_signal>(),\n"
5929 "I<pthread_cond_timedwait>(),\n"
5930 "I<pthread_cond_wait>(),\n"
5931 "I<pthread_condattr_destroy>(),\n"
5932 "I<pthread_condattr_init>(),\n"
5933 "I<pthread_create>(),\n"
5934 "I<pthread_detach>(),\n"
5935 "I<pthread_equal>(),\n"
5936 "I<pthread_exit>(),\n"
5937 "I<pthread_getspecific>(),\n"
5938 "I<pthread_join>(),\n"
5939 "I<pthread_key_create>(),\n"
5940 "I<pthread_key_delete>(),\n"
5941 "I<pthread_mutex_destroy>(),\n"
5942 "I<pthread_mutex_init>(),\n"
5943 "I<pthread_mutex_lock>(),\n"
5944 "I<pthread_mutex_trylock>(),\n"
5945 "I<pthread_mutex_unlock>(),\n"
5946 "I<pthread_mutexattr_destroy>(),\n"
5947 "I<pthread_mutexattr_init>(),\n"
5948 "I<pthread_once>(),\n"
5949 "I<pthread_rwlock_destroy>(),\n"
5950 "I<pthread_rwlock_init>(),\n"
5951 "I<pthread_rwlock_rdlock>(),\n"
5952 "I<pthread_rwlock_tryrdlock>(),\n"
5953 "I<pthread_rwlock_trywrlock>(),\n"
5954 "I<pthread_rwlock_unlock>(),\n"
5955 "I<pthread_rwlock_wrlock>(),\n"
5956 "I<pthread_rwlockattr_destroy>(),\n"
5957 "I<pthread_rwlockattr_init>(),\n"
5958 "I<pthread_self>(),\n"
5959 "I<pthread_setcancelstate>(),\n"
5960 "I<pthread_setcanceltype>(),\n"
5961 "I<pthread_setspecific>(),\n"
5962 "I<pthread_testcancel>().\n"
5966 #: build/C/man7/posixoptions.7:701
5968 msgid "TMO - _POSIX_TIMEOUTS - _SC_TIMEOUTS"
5972 #: build/C/man7/posixoptions.7:714
5975 "I<mq_timedreceive>(),\n"
5976 "I<mq_timedsend>(),\n"
5977 "I<pthread_mutex_timedlock>(),\n"
5978 "I<pthread_rwlock_timedrdlock>(),\n"
5979 "I<pthread_rwlock_timedwrlock>(),\n"
5980 "I<sem_timedwait>(),\n"
5981 "I<posix_trace_timedgetnext_event>().\n"
5985 #: build/C/man7/posixoptions.7:717
5987 msgid "TMR - _POSIX_TIMERS - _SC_TIMERS"
5991 #: build/C/man7/posixoptions.7:732
5994 "I<clock_getres>(),\n"
5995 "I<clock_gettime>(),\n"
5996 "I<clock_settime>(),\n"
5998 "I<timer_create>(),\n"
5999 "I<timer_delete>(),\n"
6000 "I<timer_gettime>(),\n"
6001 "I<timer_getoverrun>(),\n"
6002 "I<timer_settime>().\n"
6006 #: build/C/man7/posixoptions.7:735
6008 msgid "TRC - _POSIX_TRACE - _SC_TRACE"
6012 #: build/C/man7/posixoptions.7:738
6013 msgid "POSIX tracing is available. The following functions are present:"
6017 #: build/C/man7/posixoptions.7:773
6020 "I<posix_trace_attr_destroy>(),\n"
6021 "I<posix_trace_attr_getclockres>(),\n"
6022 "I<posix_trace_attr_getcreatetime>(),\n"
6023 "I<posix_trace_attr_getgenversion>(),\n"
6024 "I<posix_trace_attr_getmaxdatasize>(),\n"
6025 "I<posix_trace_attr_getmaxsystemeventsize>(),\n"
6026 "I<posix_trace_attr_getmaxusereventsize>(),\n"
6027 "I<posix_trace_attr_getname>(),\n"
6028 "I<posix_trace_attr_getstreamfullpolicy>(),\n"
6029 "I<posix_trace_attr_getstreamsize>(),\n"
6030 "I<posix_trace_attr_init>(),\n"
6031 "I<posix_trace_attr_setmaxdatasize>(),\n"
6032 "I<posix_trace_attr_setname>(),\n"
6033 "I<posix_trace_attr_setstreamsize>(),\n"
6034 "I<posix_trace_attr_setstreamfullpolicy>(),\n"
6035 "I<posix_trace_clear>(),\n"
6036 "I<posix_trace_create>(),\n"
6037 "I<posix_trace_event>(),\n"
6038 "I<posix_trace_eventid_equal>(),\n"
6039 "I<posix_trace_eventid_get_name>(),\n"
6040 "I<posix_trace_eventid_open>(),\n"
6041 "I<posix_trace_eventtypelist_getnext_id>(),\n"
6042 "I<posix_trace_eventtypelist_rewind>(),\n"
6043 "I<posix_trace_flush>(),\n"
6044 "I<posix_trace_get_attr>(),\n"
6045 "I<posix_trace_get_status>(),\n"
6046 "I<posix_trace_getnext_event>(),\n"
6047 "I<posix_trace_shutdown>(),\n"
6048 "I<posix_trace_start>(),\n"
6049 "I<posix_trace_stop>(),\n"
6050 "I<posix_trace_trygetnext_event>().\n"
6054 #: build/C/man7/posixoptions.7:776
6056 msgid "TEF - _POSIX_TRACE_EVENT_FILTER - _SC_TRACE_EVENT_FILTER"
6060 #: build/C/man7/posixoptions.7:781 build/C/man7/posixoptions.7:816
6062 "This option implies the B<_POSIX_TRACE> option. The following functions are "
6067 #: build/C/man7/posixoptions.7:793
6070 "I<posix_trace_eventset_add>(),\n"
6071 "I<posix_trace_eventset_del>(),\n"
6072 "I<posix_trace_eventset_empty>(),\n"
6073 "I<posix_trace_eventset_fill>(),\n"
6074 "I<posix_trace_eventset_ismember>(),\n"
6075 "I<posix_trace_get_filter>(),\n"
6076 "I<posix_trace_set_filter>(),\n"
6077 "I<posix_trace_trid_eventid_open>().\n"
6081 #: build/C/man7/posixoptions.7:796
6083 msgid "TRI - _POSIX_TRACE_INHERIT - _SC_TRACE_INHERIT"
6087 #: build/C/man7/posixoptions.7:802
6089 "Tracing children of the traced process is supported. This option implies "
6090 "the B<_POSIX_TRACE> option. The following functions are present:"
6094 #: build/C/man7/posixoptions.7:808
6097 "I<posix_trace_attr_getinherited>(),\n"
6098 "I<posix_trace_attr_setinherited>().\n"
6102 #: build/C/man7/posixoptions.7:811
6104 msgid "TRL - _POSIX_TRACE_LOG - _SC_TRACE_LOG"
6108 #: build/C/man7/posixoptions.7:828
6111 "I<posix_trace_attr_getlogfullpolicy>(),\n"
6112 "I<posix_trace_attr_getlogsize>(),\n"
6113 "I<posix_trace_attr_setlogfullpolicy>(),\n"
6114 "I<posix_trace_attr_setlogsize>(),\n"
6115 "I<posix_trace_close>(),\n"
6116 "I<posix_trace_create_withlog>(),\n"
6117 "I<posix_trace_open>(),\n"
6118 "I<posix_trace_rewind>().\n"
6122 #: build/C/man7/posixoptions.7:831
6124 msgid "TYM - _POSIX_TYPED_MEMORY_OBJECTS - _SC_TYPED_MEMORY_OBJECT"
6128 #: build/C/man7/posixoptions.7:840
6131 "I<posix_mem_offset>(),\n"
6132 "I<posix_typed_mem_get_info>(),\n"
6133 "I<posix_typed_mem_open>().\n"
6137 #: build/C/man7/posixoptions.7:843
6139 msgid "--- - _POSIX_VDISABLE"
6143 #: build/C/man7/posixoptions.7:847
6145 "Always present (probably 0). Value to set a changeable special control "
6146 "character to indicate that it is disabled."
6150 #: build/C/man7/posixoptions.7:847
6152 msgid "XOPEN EXTENSIONS"
6157 #: build/C/man7/posixoptions.7:854
6159 "B<_XOPEN_CRYPT>, B<_XOPEN_LEGACY>, B<_XOPEN_REALTIME>, "
6160 "B<_XOPEN_REALTIME_THREADS>, B<_XOPEN_UNIX>."
6164 #: build/C/man7/posixoptions.7:857
6165 msgid "B<sysconf>(3), B<standards>(7)"
6169 #: build/C/man5/proc.5:62
6175 #: build/C/man5/proc.5:62
6181 #: build/C/man5/proc.5:65
6182 msgid "proc - process information pseudo-file system"
6186 #: build/C/man5/proc.5:74
6188 "The I<proc> file system is a pseudo-file system which is used as an "
6189 "interface to kernel data structures. It is commonly mounted at I</proc>. "
6190 "Most of it is read-only, but some files allow kernel variables to be "
6195 #: build/C/man5/proc.5:78
6196 msgid "The following outline gives a quick tour through the I</proc> hierarchy."
6200 #: build/C/man5/proc.5:79
6202 msgid "I</proc/[pid]>"
6205 #. FIXME Describe /proc/[pid]/attr and
6206 #. /proc/[pid]/task/[tid]/attr
6207 #. This is a directory
6211 #: build/C/man5/proc.5:91
6213 "There is a numerical subdirectory for each running process; the subdirectory "
6214 "is named by the process ID. Each such subdirectory contains the following "
6215 "pseudo-files and directories."
6219 #: build/C/man5/proc.5:91
6221 msgid "I</proc/[pid]/auxv> (since 2.6.0-test7)"
6225 #: build/C/man5/proc.5:98
6227 "This contains the contents of the ELF interpreter information passed to the "
6228 "process at exec time. The format is one I<unsigned long> ID plus one "
6229 "I<unsigned long> value for each entry. The last entry contains two zeros."
6233 #: build/C/man5/proc.5:98
6235 msgid "I</proc/[pid]/cgroup> (since Linux 2.6.24)"
6238 #. Info in Documentation/cgroups/cgroups.txt
6240 #: build/C/man5/proc.5:104
6242 "This file describes control groups to which the process/task belongs. For "
6243 "each cgroup hierarchy there is one entry containing colon-separated fields "
6248 #: build/C/man5/proc.5:108
6250 msgid "CW< 5:cpuacct,cpu,cpuset:/daemons>\n"
6254 #: build/C/man5/proc.5:112
6255 msgid "The colon-separated fields are, from left to right:"
6259 #: build/C/man5/proc.5:113
6265 #: build/C/man5/proc.5:115
6266 msgid "hierarchy ID number"
6270 #: build/C/man5/proc.5:115
6276 #: build/C/man5/proc.5:117
6277 msgid "set of subsystems bound to the hierarchy"
6281 #: build/C/man5/proc.5:117
6287 #: build/C/man5/proc.5:119
6288 msgid "control group in the hierarchy to which the process belongs"
6292 #. FIXME Describe /proc/[pid]/clear_refs
6294 #. "Clears page referenced bits shown in smaps output"
6296 #. CONFIG_PROC_PAGE_MONITOR
6298 #: build/C/man5/proc.5:130
6300 "This file is present only if the B<CONFIG_CGROUPS> kernel configuration "
6301 "option is enabled."
6305 #: build/C/man5/proc.5:130
6307 msgid "I</proc/[pid]/cmdline>"
6310 #. In 2.3.26, this also used to be true if the process was swapped out.
6312 #: build/C/man5/proc.5:140
6314 "This holds the complete command line for the process, unless the process is "
6315 "a zombie. In the latter case, there is nothing in this file: that is, a "
6316 "read on this file will return 0 characters. The command-line arguments "
6317 "appear in this file as a set of strings separated by null bytes "
6318 "(\\(aq\\e0\\(aq), with a further null byte after the last string."
6322 #: build/C/man5/proc.5:140
6324 msgid "I</proc/[pid]/coredump_filter> (since kernel 2.6.23)"
6328 #: build/C/man5/proc.5:144 build/C/man5/proc.5:2733 build/C/man5/proc.5:2737
6329 msgid "See B<core>(5)."
6333 #: build/C/man5/proc.5:144
6335 msgid "I</proc/[pid]/cpuset> (since kernel 2.6.12)"
6338 #. and/proc/[pid]/task/[tid]/cpuset
6340 #: build/C/man5/proc.5:149
6341 msgid "See B<cpuset>(7)."
6345 #: build/C/man5/proc.5:149
6347 msgid "I</proc/[pid]/cwd>"
6351 #: build/C/man5/proc.5:154
6353 "This is a symbolic link to the current working directory of the process. To "
6354 "find out the current working directory of process 20, for instance, you can "
6359 #: build/C/man5/proc.5:158
6361 msgid "$B< cd /proc/20/cwd; /bin/pwd>\n"
6365 #: build/C/man5/proc.5:169
6367 "Note that the I<pwd> command is often a shell built-in, and might not work "
6368 "properly. In B<bash>(1), you may use I<pwd\\ -P>."
6371 #. The following was still true as at kernel 2.6.13
6372 #. FIXME Describe /proc/[pid]/seccomp
6374 #. FIXME Describe /proc/[pid]/sessionid
6375 #. Added in 2.6.25; read-only; only readable by real UID
6376 #. CONFIG_AUDITSYSCALL
6377 #. FIXME Describe /proc/[pid]/sched
6379 #. CONFIG_SCHED_DEBUG, and additional fields if CONFIG_SCHEDSTATS
6380 #. Displays various scheduling parameters
6381 #. This file can be written, to reset stats
6382 #. FIXME Describe /proc/[pid]/schedstats and
6383 #. /proc/[pid]/task/[tid]/schedstats
6385 #. CONFIG_SCHEDSTATS
6387 #: build/C/man5/proc.5:175 build/C/man5/proc.5:877
6389 "In a multithreaded process, the contents of this symbolic link are not "
6390 "available if the main thread has already terminated (typically by calling "
6391 "B<pthread_exit>(3))."
6395 #: build/C/man5/proc.5:175
6397 msgid "I</proc/[pid]/environ>"
6401 #: build/C/man5/proc.5:181
6403 "This file contains the environment for the process. The entries are "
6404 "separated by null bytes (\\(aq\\e0\\(aq), and there may be a null byte at "
6405 "the end. Thus, to print out the environment of process 1, you would do:"
6409 #: build/C/man5/proc.5:186
6411 msgid "$B< strings /proc/1/environ>\n"
6415 #: build/C/man5/proc.5:189
6417 msgid "I</proc/[pid]/exe>"
6420 #. The following was still true as at kernel 2.6.13
6422 #: build/C/man5/proc.5:204
6424 "Under Linux 2.2 and later, this file is a symbolic link containing the "
6425 "actual pathname of the executed command. This symbolic link can be "
6426 "dereferenced normally; attempting to open it will open the executable. You "
6427 "can even type I</proc/[pid]/exe> to run another copy of the same executable "
6428 "as is being run by process [pid]. In a multithreaded process, the contents "
6429 "of this symbolic link are not available if the main thread has already "
6430 "terminated (typically by calling B<pthread_exit>(3))."
6434 #: build/C/man5/proc.5:212
6436 "Under Linux 2.0 and earlier I</proc/[pid]/exe> is a pointer to the binary "
6437 "which was executed, and appears as a symbolic link. A B<readlink>(2) call "
6438 "on this file under Linux 2.0 returns a string in the format:"
6442 #: build/C/man5/proc.5:214
6444 msgid " [device]:inode\n"
6448 #: build/C/man5/proc.5:217
6450 "For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, MFM, "
6451 "etc. drives) minor 01 (first partition on the first drive)."
6455 #: build/C/man5/proc.5:222
6456 msgid "B<find>(1) with the I<-inum> option can be used to locate the file."
6460 #: build/C/man5/proc.5:222
6462 msgid "I</proc/[pid]/fd/>"
6466 #: build/C/man5/proc.5:228
6468 "This is a subdirectory containing one entry for each file which the process "
6469 "has open, named by its file descriptor, and which is a symbolic link to the "
6470 "actual file. Thus, 0 is standard input, 1 standard output, 2 standard "
6475 #: build/C/man5/proc.5:235
6477 "For file descriptors for pipes and sockets, the entries will be symbolic "
6478 "links whose content is the file type with the inode. A B<readlink>(2) call "
6479 "on this file returns a string in the format:"
6483 #: build/C/man5/proc.5:237
6485 msgid " type:[inode]\n"
6489 #: build/C/man5/proc.5:244
6491 "For example, I<socket:[2248868]> will be a socket and its inode is 2248868. "
6492 "For sockets, that inode can be used to find more information in one of the "
6493 "files under I</proc/net/>."
6497 #: build/C/man5/proc.5:254
6499 "For file descriptors that have no corresponding inode (e.g., file "
6500 "descriptors produced by B<epoll_create>(2), B<eventfd>(2), "
6501 "B<inotify_init>(2), B<signalfd>(2), and B<timerfd>(2)), the entry will be a "
6502 "symbolic link with contents of the form"
6506 #: build/C/man5/proc.5:256
6508 msgid " anon_inode:E<lt>file-typeE<gt>\n"
6512 #: build/C/man5/proc.5:260
6513 msgid "In some cases, the I<file-type> is surrounded by square brackets."
6517 #: build/C/man5/proc.5:264
6519 "For example, an epoll file descriptor will have a symbolic link whose "
6520 "content is the string I<anon_inode:[eventpoll]>."
6523 #. The following was still true as at kernel 2.6.13
6525 #: build/C/man5/proc.5:270
6527 "In a multithreaded process, the contents of this directory are not available "
6528 "if the main thread has already terminated (typically by calling "
6529 "B<pthread_exit>(3))."
6533 #: build/C/man5/proc.5:283
6535 "Programs that will take a filename as a command-line argument, but will not "
6536 "take input from standard input if no argument is supplied, or that write to "
6537 "a file named as a command-line argument, but will not send their output to "
6538 "standard output if no argument is supplied, can nevertheless be made to use "
6539 "standard input or standard out using I</proc/[pid]/fd>. For example, "
6540 "assuming that I<-i> is the flag designating an input file and I<-o> is the "
6541 "flag designating an output file:"
6545 #: build/C/man5/proc.5:287
6547 msgid "$B< foobar -i /proc/self/fd/0 -o /proc/self/fd/1 ...>\n"
6550 #. The following is not true in my tests (MTK):
6551 #. Note that this will not work for
6552 #. programs that seek on their files, as the files in the fd directory
6553 #. are not seekable.
6555 #: build/C/man5/proc.5:295
6556 msgid "and you have a working filter."
6560 #: build/C/man5/proc.5:305
6562 "I</proc/self/fd/N> is approximately the same as I</dev/fd/N> in some UNIX "
6563 "and UNIX-like systems. Most Linux MAKEDEV scripts symbolically link "
6564 "I</dev/fd> to I</proc/self/fd>, in fact."
6568 #: build/C/man5/proc.5:319
6570 "Most systems provide symbolic links I</dev/stdin>, I</dev/stdout>, and "
6571 "I</dev/stderr>, which respectively link to the files I<0>, I<1>, and I<2> in "
6572 "I</proc/self/fd>. Thus the example command above could be written as:"
6576 #: build/C/man5/proc.5:323
6578 msgid "$B< foobar -i /dev/stdin -o /dev/stdout ...>\n"
6582 #: build/C/man5/proc.5:328
6584 msgid "I</proc/[pid]/fdinfo/> (since kernel 2.6.22)"
6588 #: build/C/man5/proc.5:334
6590 "This is a subdirectory containing one entry for each file which the process "
6591 "has open, named by its file descriptor. The contents of each file can be "
6592 "read to obtain information about the corresponding file descriptor, for "
6597 #: build/C/man5/proc.5:340
6600 "$B< cat /proc/12015/fdinfo/4>\n"
6606 #: build/C/man5/proc.5:351
6608 "The I<pos> field is a decimal number showing the current file offset. The "
6609 "I<flags> field is an octal number that displays the file access mode and "
6610 "file status flags (see B<open>(2))."
6613 #. FIXME document /proc/[pid]/io
6615 #. .IR /proc/[pid]/io " (since kernel 2.6.20)"
6617 #: build/C/man5/proc.5:356
6618 msgid "The files in this directory are readable only by the owner of the process."
6622 #: build/C/man5/proc.5:356
6624 msgid "I</proc/[pid]/limits> (since kernel 2.6.24)"
6627 #. commit 3036e7b490bf7878c6dae952eec5fb87b1106589
6629 #: build/C/man5/proc.5:366
6631 "This file displays the soft limit, hard limit, and units of measurement for "
6632 "each of the process's resource limits (see B<getrlimit>(2)). Up to and "
6633 "including Linux 2.6.35, this file is protected to allow reading only by the "
6634 "real UID of the process. Since Linux 2.6.36, this file is readable by all "
6635 "users on the system."
6639 #: build/C/man5/proc.5:366
6641 msgid "I</proc/[pid]/map_files/> (since kernel 3.3)"
6644 #. commit 640708a2cff7f81e246243b0073c66e6ece7e53e
6646 #: build/C/man5/proc.5:376
6648 "This subdirectory contains entries corresponding to memory-mapped files (see "
6649 "B<mmap>(2)). Entries are named by memory region start and end address pair "
6650 "(expressed as hexadecimal numbers), and are symbolic links to the mapped "
6651 "files themselves. Here is an example, with the output wrapped and "
6652 "reformatted to fit on an 80-column display:"
6656 #: build/C/man5/proc.5:383
6659 "$B< ls -l /proc/self/map_files/>\n"
6660 "lr--------. 1 root root 64 Apr 16 21:31\n"
6661 " 3252e00000-3252e20000 -E<gt> /usr/lib64/ld-2.15.so\n"
6666 #: build/C/man5/proc.5:397
6668 "Although these entries are present for memory regions that were mapped with "
6669 "the B<MAP_FILE> flag, the way anonymous shared memory (regions created with "
6670 "the B<MAP_ANON | MAP_SHARED> flags) is implemented in Linux means that such "
6671 "regions also appear on this directory. Here is an example where the target "
6672 "file is the deleted I</dev/zero> one:"
6676 #: build/C/man5/proc.5:403
6679 "lrw-------. 1 root root 64 Apr 16 21:33\n"
6680 " 7fc075d2f000-7fc075e6f000 -E<gt> /dev/zero (deleted)\n"
6684 #: build/C/man5/proc.5:409
6686 "This directory appears only if the B<CONFIG_CHECKPOINT_RESTORE> kernel "
6687 "configuration option is enabled."
6691 #: build/C/man5/proc.5:409
6693 msgid "I</proc/[pid]/maps>"
6697 #: build/C/man5/proc.5:416
6699 "A file containing the currently mapped memory regions and their access "
6700 "permissions. See B<mmap>(2) for some further information about memory "
6705 #: build/C/man5/proc.5:418
6706 msgid "The format of the file is:"
6710 #: build/C/man5/proc.5:443
6713 "I<address perms offset dev inode pathname>\n"
6714 "00400000-00452000 r-xp 00000000 08:02 173521 /usr/bin/dbus-daemon\n"
6715 "00651000-00652000 r--p 00051000 08:02 173521 /usr/bin/dbus-daemon\n"
6716 "00652000-00655000 rw-p 00052000 08:02 173521 /usr/bin/dbus-daemon\n"
6717 "00e03000-00e24000 rw-p 00000000 00:00 0 [heap]\n"
6718 "00e24000-011f7000 rw-p 00000000 00:00 0 [heap]\n"
6720 "35b1800000-35b1820000 r-xp 00000000 08:02 135522 /usr/lib64/ld-2.15.so\n"
6721 "35b1a1f000-35b1a20000 r--p 0001f000 08:02 135522 /usr/lib64/ld-2.15.so\n"
6722 "35b1a20000-35b1a21000 rw-p 00020000 08:02 135522 /usr/lib64/ld-2.15.so\n"
6723 "35b1a21000-35b1a22000 rw-p 00000000 00:00 0\n"
6724 "35b1c00000-35b1dac000 r-xp 00000000 08:02 135870 /usr/lib64/libc-2.15.so\n"
6725 "35b1dac000-35b1fac000 ---p 001ac000 08:02 135870 /usr/lib64/libc-2.15.so\n"
6726 "35b1fac000-35b1fb0000 r--p 001ac000 08:02 135870 /usr/lib64/libc-2.15.so\n"
6727 "35b1fb0000-35b1fb2000 rw-p 001b0000 08:02 135870 /usr/lib64/libc-2.15.so\n"
6729 "f2c6ff8c000-7f2c7078c000 rw-p 00000000 00:00 0 [stack:986]\n"
6731 "7fffb2c0d000-7fffb2c2e000 rw-p 00000000 00:00 0 [stack]\n"
6732 "7fffb2d48000-7fffb2d49000 r-xp 00000000 00:00 0 [vdso]\n"
6736 #: build/C/man5/proc.5:452
6738 "The I<address> field is the address space in the process that the mapping "
6739 "occupies. The I<perms> field is a set of permissions:"
6743 #: build/C/man5/proc.5:460
6750 "p = private (copy on write)\n"
6754 #: build/C/man5/proc.5:473
6756 "The I<offset> field is the offset into the file/whatever; I<dev> is the "
6757 "device (major:minor); I<inode> is the inode on that device. 0 indicates "
6758 "that no inode is associated with the memory region, as would be the case "
6759 "with BSS (uninitialized data)."
6763 #: build/C/man5/proc.5:483
6765 "The I<pathname> field will usually be the file that is backing the mapping. "
6766 "For ELF files, you can easily coordinate with the I<offset> field by looking "
6767 "at the Offset field in the ELF program headers (I<readelf\\ -l>)."
6771 #: build/C/man5/proc.5:485
6772 msgid "There are additional helpful pseudo-paths:"
6776 #: build/C/man5/proc.5:486
6782 #: build/C/man5/proc.5:489
6783 msgid "The initial process's (also known as the main thread's) stack."
6787 #: build/C/man5/proc.5:489
6789 msgid "I<[stack:E<lt>tidE<gt>]> (since Linux 3.4)"
6792 #. commit b76437579d1344b612cf1851ae610c636cec7db0
6794 #: build/C/man5/proc.5:498
6796 "A thread's stack (where the I<E<lt>tidE<gt>> is a thread ID). It "
6797 "corresponds to the I</proc/[pid]/task/[tid]/> path."
6801 #: build/C/man5/proc.5:498
6807 #: build/C/man5/proc.5:501
6808 msgid "The virtual dynamically linked shared object."
6812 #: build/C/man5/proc.5:501
6818 #: build/C/man5/proc.5:504
6819 msgid "The process's heap."
6823 #: build/C/man5/proc.5:519
6825 "If the I<pathname> field is blank, this is an anonymous mapping as obtained "
6826 "via the B<mmap>(2) function. There is no easy way to coordinate this back "
6827 "to a process's source, short of running it through B<gdb>(1), B<strace>(1), "
6832 #: build/C/man5/proc.5:521
6833 msgid "Under Linux 2.0 there is no field giving pathname."
6837 #: build/C/man5/proc.5:521
6839 msgid "I</proc/[pid]/mem>"
6843 #: build/C/man5/proc.5:528
6845 "This file can be used to access the pages of a process's memory through "
6846 "B<open>(2), B<read>(2), and B<lseek>(2)."
6850 #: build/C/man5/proc.5:528
6852 msgid "I</proc/[pid]/mountinfo> (since Linux 2.6.26)"
6855 #. This info adapted from Documentation/filesystems/proc.txt
6857 #: build/C/man5/proc.5:533
6859 "This file contains information about mount points. It contains lines of the "
6864 #: build/C/man5/proc.5:538
6867 "CW<36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root "
6868 "rw,errors=continue\n"
6869 "(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)>\n"
6873 #: build/C/man5/proc.5:542
6874 msgid "The numbers in parentheses are labels for the descriptions below:"
6878 #: build/C/man5/proc.5:543 build/C/man5/proc.5:636
6884 #: build/C/man5/proc.5:547
6885 msgid "mount ID: unique identifier of the mount (may be reused after B<umount>(2))."
6889 #: build/C/man5/proc.5:547 build/C/man5/proc.5:640
6895 #: build/C/man5/proc.5:550
6896 msgid "parent ID: ID of parent mount (or of self for the top of the mount tree)."
6900 #: build/C/man5/proc.5:550 build/C/man5/proc.5:643
6906 #: build/C/man5/proc.5:556
6907 msgid "major:minor: value of I<st_dev> for files on file system (see B<stat>(2))."
6911 #: build/C/man5/proc.5:556 build/C/man5/proc.5:646
6917 #: build/C/man5/proc.5:559
6918 msgid "root: root of the mount within the file system."
6922 #: build/C/man5/proc.5:559
6928 #: build/C/man5/proc.5:562
6929 msgid "mount point: mount point relative to the process's root."
6933 #: build/C/man5/proc.5:562
6939 #: build/C/man5/proc.5:565
6940 msgid "mount options: per-mount options."
6944 #: build/C/man5/proc.5:565
6950 #: build/C/man5/proc.5:568
6951 msgid "optional fields: zero or more fields of the form \"tag[:value]\"."
6955 #: build/C/man5/proc.5:568
6961 #: build/C/man5/proc.5:571
6962 msgid "separator: marks the end of the optional fields."
6966 #: build/C/man5/proc.5:571
6972 #: build/C/man5/proc.5:574
6973 msgid "file system type: name of file system in the form \"type[.subtype]\"."
6977 #: build/C/man5/proc.5:574
6983 #: build/C/man5/proc.5:577
6984 msgid "mount source: file system-specific information or \"none\"."
6988 #: build/C/man5/proc.5:577
6994 #: build/C/man5/proc.5:580
6995 msgid "super options: per-super block options."
6999 #: build/C/man5/proc.5:584
7001 "Parsers should ignore all unrecognized optional fields. Currently the "
7002 "possible optional fields are:"
7006 #: build/C/man5/proc.5:585
7012 #: build/C/man5/proc.5:588
7013 msgid "mount is shared in peer group X"
7017 #: build/C/man5/proc.5:588
7023 #: build/C/man5/proc.5:591
7024 msgid "mount is slave to peer group X"
7028 #: build/C/man5/proc.5:591
7030 msgid "propagate_from:X"
7034 #: build/C/man5/proc.5:594
7035 msgid "mount is slave and receives propagation from peer group X (*)"
7039 #: build/C/man5/proc.5:594
7045 #: build/C/man5/proc.5:597
7046 msgid "mount is unbindable"
7050 #: build/C/man5/proc.5:604
7052 "(*) X is the closest dominant peer group under the process's root. If X is "
7053 "the immediate master of the mount, or if there is no dominant peer group "
7054 "under the same root, then only the \"master:X\" field is present and not the "
7055 "\"propagate_from:X\" field."
7059 #: build/C/man5/proc.5:608
7061 "For more information on mount propagation see: "
7062 "I<Documentation/filesystems/sharedsubtree.txt> in the Linux kernel source "
7067 #: build/C/man5/proc.5:608
7069 msgid "I</proc/[pid]/mounts> (since Linux 2.4.19)"
7073 #: build/C/man5/proc.5:623
7075 "This is a list of all the file systems currently mounted in the process's "
7076 "mount namespace. The format of this file is documented in B<fstab>(5). "
7077 "Since kernel version 2.6.15, this file is pollable: after opening the file "
7078 "for reading, a change in this file (i.e., a file system mount or unmount) "
7079 "causes B<select>(2) to mark the file descriptor as readable, and B<poll>(2) "
7080 "and B<epoll_wait>(2) mark the file as having an error condition."
7084 #: build/C/man5/proc.5:623
7086 msgid "I</proc/[pid]/mountstats> (since Linux 2.6.17)"
7090 #: build/C/man5/proc.5:628
7092 "This file exports information (statistics, configuration information) about "
7093 "the mount points in the process's name space. Lines in this file have the "
7098 #: build/C/man5/proc.5:632
7101 "device /dev/sda7 mounted on /home with fstype ext3 [statistics]\n"
7102 "( 1 ) ( 2 ) (3 ) (4)\n"
7106 #: build/C/man5/proc.5:635
7107 msgid "The fields in each line are:"
7111 #: build/C/man5/proc.5:640
7113 "The name of the mounted device (or \"nodevice\" if there is no corresponding "
7118 #: build/C/man5/proc.5:643
7119 msgid "The mount point within the file system tree."
7123 #: build/C/man5/proc.5:646
7124 msgid "The file system type."
7128 #: build/C/man5/proc.5:651
7130 "Optional statistics and configuration information. Currently (as at Linux "
7131 "2.6.26), only NFS file systems export information via this field."
7135 #: build/C/man5/proc.5:654
7136 msgid "This file is readable only by the owner of the process."
7140 #: build/C/man5/proc.5:654
7142 msgid "I</proc/[pid]/ns/> (since Linux 3.0)"
7145 #. See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f
7147 #: build/C/man5/proc.5:662
7149 "This is a subdirectory containing one entry for each namespace that supports "
7150 "being manipulated by B<setns>(2). For information about namespaces, see "
7155 #: build/C/man5/proc.5:662
7157 msgid "I</proc/[pid]/ns/ipc> (since Linux 3.0)"
7161 #: build/C/man5/proc.5:670
7163 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
7164 "filesystem keeps the IPC namespace of the process specified by I<pid> alive "
7165 "even if all processes currently in the namespace terminate."
7169 #: build/C/man5/proc.5:679
7171 "Opening this file returns a file handle for the IPC namespace of the process "
7172 "specified by I<pid>. As long as this file descriptor remains open, the IPC "
7173 "namespace will remain alive, even if all processes in the namespace "
7174 "terminate. The file descriptor can be passed to B<setns>(2)."
7178 #: build/C/man5/proc.5:679
7180 msgid "I</proc/[pid]/ns/net> (since Linux 3.0)"
7184 #: build/C/man5/proc.5:687
7186 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
7187 "filesystem keeps the network namespace of the process specified by I<pid> "
7188 "alive even if all processes in the namespace terminate."
7192 #: build/C/man5/proc.5:696
7194 "Opening this file returns a file handle for the network namespace of the "
7195 "process specified by I<pid>. As long as this file descriptor remains open, "
7196 "the network namespace will remain alive, even if all processes in the "
7197 "namespace terminate. The file descriptor can be passed to B<setns>(2)."
7201 #: build/C/man5/proc.5:696
7203 msgid "I</proc/[pid]/ns/uts> (since Linux 3.0)"
7207 #: build/C/man5/proc.5:704
7209 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
7210 "filesystem keeps the UTS namespace of the process specified by I<pid> alive "
7211 "even if all processes currently in the namespace terminate."
7215 #: build/C/man5/proc.5:713
7217 "Opening this file returns a file handle for the UTS namespace of the process "
7218 "specified by I<pid>. As long as this file descriptor remains open, the UTS "
7219 "namespace will remain alive, even if all processes in the namespace "
7220 "terminate. The file descriptor can be passed to B<setns>(2)."
7224 #: build/C/man5/proc.5:713
7226 msgid "I</proc/[pid]/numa_maps> (since Linux 2.6.14)"
7230 #: build/C/man5/proc.5:717
7231 msgid "See B<numa>(7)."
7235 #: build/C/man5/proc.5:717
7237 msgid "I</proc/[pid]/oom_adj> (since Linux 2.6.11)"
7241 #: build/C/man5/proc.5:730
7243 "This file can be used to adjust the score used to select which process "
7244 "should be killed in an out-of-memory (OOM) situation. The kernel uses this "
7245 "value for a bit-shift operation of the process's I<oom_score> value: valid "
7246 "values are in the range -16 to +15, plus the special value -17, which "
7247 "disables OOM-killing altogether for this process. A positive score "
7248 "increases the likelihood of this process being killed by the OOM-killer; a "
7249 "negative score decreases the likelihood."
7253 #: build/C/man5/proc.5:738
7255 "The default value for this file is 0; a new process inherits its parent's "
7256 "I<oom_adj> setting. A process must be privileged (B<CAP_SYS_RESOURCE>) to "
7261 #: build/C/man5/proc.5:741
7263 "Since Linux 2.6.36, use of this file is deprecated in favor of "
7264 "I</proc/[pid]/oom_score_adj>."
7268 #: build/C/man5/proc.5:741
7270 msgid "I</proc/[pid]/oom_score> (since Linux 2.6.11)"
7273 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
7274 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
7276 #: build/C/man5/proc.5:752
7278 "This file displays the current score that the kernel gives to this process "
7279 "for the purpose of selecting a process for the OOM-killer. A higher score "
7280 "means that the process is more likely to be selected by the OOM-killer. The "
7281 "basis for this score is the amount of memory used by the process, with "
7282 "increases (+) or decreases (-) for factors including:"
7286 #: build/C/man5/proc.5:757
7287 msgid "whether the process creates a lot of children using B<fork>(2) (+);"
7291 #: build/C/man5/proc.5:760
7293 "whether the process has been running a long time, or has used a lot of CPU "
7298 #: build/C/man5/proc.5:762
7299 msgid "whether the process has a low nice value (i.e., E<gt> 0) (+);"
7302 #. More precisely, if it has CAP_SYS_ADMIN or CAP_SYS_RESOURCE
7304 #: build/C/man5/proc.5:765
7305 msgid "whether the process is privileged (-); and"
7308 #. More precisely, if it has CAP_SYS_RAWIO
7310 #: build/C/man5/proc.5:768
7311 msgid "whether the process is making direct hardware access (-)."
7315 #: build/C/man5/proc.5:777
7317 "The I<oom_score> also reflects the adjustment specified by the "
7318 "I<oom_score_adj> or I<oom_adj> setting for the process."
7322 #: build/C/man5/proc.5:777
7324 msgid "I</proc/[pid]/oom_score_adj> (since Linux 2.6.36)"
7327 #. Text taken from 3.7 Documentation/filesystems/proc.txt
7329 #: build/C/man5/proc.5:782
7331 "This file can be used to adjust the badness heuristic used to select which "
7332 "process gets killed in out-of-memory conditions."
7336 #: build/C/man5/proc.5:791
7338 "The badness heuristic assigns a value to each candidate task ranging from 0 "
7339 "(never kill) to 1000 (always kill) to determine which process is targeted. "
7340 "The units are roughly a proportion along that range of allowed memory the "
7341 "process may allocate from, based on an estimation of its current memory and "
7342 "swap use. For example, if a task is using all allowed memory, its badness "
7343 "score will be 1000. If it is using half of its allowed memory, its score "
7348 #: build/C/man5/proc.5:794
7350 "There is an additional factor included in the badness score: root processes "
7351 "are given 3% extra memory over other tasks."
7355 #: build/C/man5/proc.5:808
7357 "The amount of \"allowed\" memory depends on the context in which the "
7358 "OOM-killer was called. If it is due to the memory assigned to the "
7359 "allocating task's cpuset being exhausted, the allowed memory represents the "
7360 "set of mems assigned to that cpuset (see B<cpuset>(7)). If it is due to a "
7361 "mempolicy's node(s) being exhausted, the allowed memory represents the set "
7362 "of mempolicy nodes. If it is due to a memory limit (or swap limit) being "
7363 "reached, the allowed memory is that configured limit. Finally, if it is due "
7364 "to the entire system being out of memory, the allowed memory represents all "
7365 "allocatable resources."
7369 #: build/C/man5/proc.5:821
7371 "The value of I<oom_score_adj> is added to the badness score before it is "
7372 "used to determine which task to kill. Acceptable values range from -1000 "
7373 "(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). This allows user space to "
7374 "control the preference for OOM-killing, ranging from always preferring a "
7375 "certain task or completely disabling it from OOM-killing. The lowest "
7376 "possible value, -1000, is equivalent to disabling OOM-killing entirely for "
7377 "that task, since it will always report a badness score of 0."
7381 #: build/C/man5/proc.5:833
7383 "Consequently, it is very simple for user space to define the amount of "
7384 "memory to consider for each task. Setting a I<oom_score_adj> value of +500, "
7385 "for example, is roughly equivalent to allowing the remainder of tasks "
7386 "sharing the same system, cpuset, mempolicy, or memory controller resources "
7387 "to use at least 50% more memory. A value of -500, on the other hand, would "
7388 "be roughly equivalent to discounting 50% of the task's allowed memory from "
7389 "being considered as scoring against the task."
7393 #: build/C/man5/proc.5:840
7395 "For backward compatibility with previous kernels, I</proc/[pid]/oom_adj> can "
7396 "still be used to tune the badness score. Its value is scaled linearly with "
7400 #. FIXME Describe /proc/[pid]/pagemap
7402 #. CONFIG_PROC_PAGE_MONITOR
7404 #: build/C/man5/proc.5:849
7406 "Writing to I</proc/[pid]/oom_score_adj> or I</proc/[pid]/oom_adj> will "
7407 "change the other with its scaled value."
7411 #: build/C/man5/proc.5:849
7413 msgid "I</proc/[pid]/root>"
7417 #: build/C/man5/proc.5:857
7419 "UNIX and Linux support the idea of a per-process root of the file system, "
7420 "set by the B<chroot>(2) system call. This file is a symbolic link that "
7421 "points to the process's root directory, and behaves as exe, fd/*, etc. do."
7425 #: build/C/man5/proc.5:877
7427 msgid "I</proc/[pid]/smaps> (since Linux 2.6.14)"
7430 #. CONFIG_PROC_PAGE_MONITOR
7432 #: build/C/man5/proc.5:882
7434 "This file shows memory consumption for each of the process's mappings. For "
7435 "each of mappings there is a series of lines such as the following:"
7439 #: build/C/man5/proc.5:892
7442 "08048000-080bc000 r-xp 00000000 03:02 13130 /bin/bash\n"
7445 "Shared_Clean: 424 kB\n"
7446 "Shared_Dirty: 0 kB\n"
7447 "Private_Clean: 0 kB\n"
7448 "Private_Dirty: 0 kB\n"
7452 #: build/C/man5/proc.5:902
7454 "The first of these lines shows the same information as is displayed for the "
7455 "mapping in I</proc/[pid]/maps>. The remaining lines show the size of the "
7456 "mapping, the amount of the mapping that is currently resident in RAM, the "
7457 "number of clean and dirty shared pages in the mapping, and the number of "
7458 "clean and dirty private pages in the mapping."
7462 #: build/C/man5/proc.5:907
7464 "This file is present only if the B<CONFIG_MMU> kernel configuration option "
7469 #: build/C/man5/proc.5:907
7471 msgid "I</proc/[pid]/stat>"
7475 #: build/C/man5/proc.5:914
7477 "Status information about the process. This is used by B<ps>(1). It is "
7478 "defined in I</usr/src/linux/fs/proc/array.c>."
7482 #: build/C/man5/proc.5:918
7483 msgid "The fields, in order, with their proper B<scanf>(3) format specifiers, are:"
7487 #: build/C/man5/proc.5:919
7493 #: build/C/man5/proc.5:922
7494 msgid "(1) The process ID."
7498 #: build/C/man5/proc.5:922
7504 #: build/C/man5/proc.5:926
7506 "(2) The filename of the executable, in parentheses. This is visible whether "
7507 "or not the executable is swapped out."
7511 #: build/C/man5/proc.5:926
7517 #: build/C/man5/proc.5:932
7519 "(3) One character from the string \"RSDZTW\" where R is running, S is "
7520 "sleeping in an interruptible wait, D is waiting in uninterruptible disk "
7521 "sleep, Z is zombie, T is traced or stopped (on a signal), and W is paging."
7525 #: build/C/man5/proc.5:932
7531 #: build/C/man5/proc.5:935
7532 msgid "(4) The PID of the parent."
7536 #: build/C/man5/proc.5:935
7542 #: build/C/man5/proc.5:938
7543 msgid "(5) The process group ID of the process."
7547 #: build/C/man5/proc.5:938
7549 msgid "I<session> %d"
7553 #: build/C/man5/proc.5:941
7554 msgid "(6) The session ID of the process."
7558 #: build/C/man5/proc.5:941
7560 msgid "I<tty_nr> %d"
7564 #: build/C/man5/proc.5:947
7566 "(7) The controlling terminal of the process. (The minor device number is "
7567 "contained in the combination of bits 31 to 20 and 7 to 0; the major device "
7568 "number is in bits 15 to 8.)"
7572 #: build/C/man5/proc.5:947
7577 #. This field and following, up to and including wchan added 0.99.1
7579 #: build/C/man5/proc.5:952
7581 "(8) The ID of the foreground process group of the controlling terminal of "
7586 #: build/C/man5/proc.5:952
7588 msgid "I<flags> %u (%lu before Linux 2.6.22)"
7592 #: build/C/man5/proc.5:959
7594 "(9) The kernel flags word of the process. For bit meanings, see the PF_* "
7595 "defines in the Linux kernel source file I<include/linux/sched.h>. Details "
7596 "depend on the kernel version."
7600 #: build/C/man5/proc.5:959
7602 msgid "I<minflt> %lu"
7606 #: build/C/man5/proc.5:963
7608 "(10) The number of minor faults the process has made which have not required "
7609 "loading a memory page from disk."
7613 #: build/C/man5/proc.5:963
7615 msgid "I<cminflt> %lu"
7619 #: build/C/man5/proc.5:967
7621 "(11) The number of minor faults that the process's waited-for children have "
7626 #: build/C/man5/proc.5:967
7628 msgid "I<majflt> %lu"
7632 #: build/C/man5/proc.5:971
7634 "(12) The number of major faults the process has made which have required "
7635 "loading a memory page from disk."
7639 #: build/C/man5/proc.5:971
7641 msgid "I<cmajflt> %lu"
7645 #: build/C/man5/proc.5:975
7647 "(13) The number of major faults that the process's waited-for children have "
7652 #: build/C/man5/proc.5:975
7654 msgid "I<utime> %lu"
7658 #: build/C/man5/proc.5:984
7660 "(14) Amount of time that this process has been scheduled in user mode, "
7661 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>). This includes "
7662 "guest time, I<guest_time> (time spent running a virtual CPU, see below), so "
7663 "that applications that are not aware of the guest time field do not lose "
7664 "that time from their calculations."
7668 #: build/C/man5/proc.5:984
7670 msgid "I<stime> %lu"
7674 #: build/C/man5/proc.5:989
7676 "(15) Amount of time that this process has been scheduled in kernel mode, "
7677 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
7681 #: build/C/man5/proc.5:989
7683 msgid "I<cutime> %ld"
7687 #: build/C/man5/proc.5:999
7689 "(16) Amount of time that this process's waited-for children have been "
7690 "scheduled in user mode, measured in clock ticks (divide by "
7691 "I<sysconf(_SC_CLK_TCK)>). (See also B<times>(2).) This includes guest "
7692 "time, I<cguest_time> (time spent running a virtual CPU, see below)."
7696 #: build/C/man5/proc.5:999
7698 msgid "I<cstime> %ld"
7702 #: build/C/man5/proc.5:1005
7704 "(17) Amount of time that this process's waited-for children have been "
7705 "scheduled in kernel mode, measured in clock ticks (divide by "
7706 "I<sysconf(_SC_CLK_TCK)>)."
7710 #: build/C/man5/proc.5:1005
7712 msgid "I<priority> %ld"
7716 #: build/C/man5/proc.5:1022
7718 "(18) (Explanation for Linux 2.6) For processes running a real-time "
7719 "scheduling policy (I<policy> below; see B<sched_setscheduler>(2)), this is "
7720 "the negated scheduling priority, minus one; that is, a number in the range "
7721 "-2 to -100, corresponding to real-time priorities 1 to 99. For processes "
7722 "running under a non-real-time scheduling policy, this is the raw nice value "
7723 "(B<setpriority>(2)) as represented in the kernel. The kernel stores nice "
7724 "values as numbers in the range 0 (high) to 39 (low), corresponding to the "
7725 "user-visible nice range of -20 to 19."
7728 #. And back in kernel 1.2 days things were different again.
7730 #: build/C/man5/proc.5:1026
7732 "Before Linux 2.6, this was a scaled value based on the scheduler weighting "
7733 "given to this process."
7737 #: build/C/man5/proc.5:1026
7742 #. Back in kernel 1.2 days things were different.
7744 #. \fIcounter\fP %ld
7745 #. The current maximum size in jiffies of the process's next timeslice,
7746 #. or what is currently left of its current timeslice, if it is the
7747 #. currently running process.
7750 #. The time in jiffies of the process's next timeout.
7751 #. timeout was removed sometime around 2.1/2.2
7753 #: build/C/man5/proc.5:1041
7755 "(19) The nice value (see B<setpriority>(2)), a value in the range 19 (low "
7756 "priority) to -20 (high priority)."
7760 #: build/C/man5/proc.5:1041
7762 msgid "I<num_threads> %ld"
7766 #: build/C/man5/proc.5:1046
7768 "(20) Number of threads in this process (since Linux 2.6). Before kernel "
7769 "2.6, this field was hard coded to 0 as a placeholder for an earlier removed "
7774 #: build/C/man5/proc.5:1046
7776 msgid "I<itrealvalue> %ld"
7780 #: build/C/man5/proc.5:1053
7782 "(21) The time in jiffies before the next B<SIGALRM> is sent to the process "
7783 "due to an interval timer. Since kernel 2.6.17, this field is no longer "
7784 "maintained, and is hard coded as 0."
7788 #: build/C/man5/proc.5:1053
7790 msgid "I<starttime> %llu (was %lu before Linux 2.6)"
7794 #: build/C/man5/proc.5:1059
7796 "(22) The time the process started after system boot. In kernels before "
7797 "Linux 2.6, this value was expressed in jiffies. Since Linux 2.6, the value "
7798 "is expressed in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
7802 #: build/C/man5/proc.5:1059
7804 msgid "I<vsize> %lu"
7808 #: build/C/man5/proc.5:1062
7809 msgid "(23) Virtual memory size in bytes."
7813 #: build/C/man5/proc.5:1062
7819 #: build/C/man5/proc.5:1069
7821 "(24) Resident Set Size: number of pages the process has in real memory. "
7822 "This is just the pages which count toward text, data, or stack space. This "
7823 "does not include pages which have not been demand-loaded in, or which are "
7828 #: build/C/man5/proc.5:1069
7830 msgid "I<rsslim> %lu"
7834 #: build/C/man5/proc.5:1076
7836 "(25) Current soft limit in bytes on the rss of the process; see the "
7837 "description of B<RLIMIT_RSS> in B<getrlimit>(2)."
7841 #: build/C/man5/proc.5:1076
7843 msgid "I<startcode> %lu"
7847 #: build/C/man5/proc.5:1079
7848 msgid "(26) The address above which program text can run."
7852 #: build/C/man5/proc.5:1079
7854 msgid "I<endcode> %lu"
7858 #: build/C/man5/proc.5:1082
7859 msgid "(27) The address below which program text can run."
7863 #: build/C/man5/proc.5:1082
7865 msgid "I<startstack> %lu"
7869 #: build/C/man5/proc.5:1085
7870 msgid "(28) The address of the start (i.e., bottom) of the stack."
7874 #: build/C/man5/proc.5:1085
7876 msgid "I<kstkesp> %lu"
7880 #: build/C/man5/proc.5:1089
7882 "(29) The current value of ESP (stack pointer), as found in the kernel stack "
7883 "page for the process."
7887 #: build/C/man5/proc.5:1089
7889 msgid "I<kstkeip> %lu"
7893 #: build/C/man5/proc.5:1092
7894 msgid "(30) The current EIP (instruction pointer)."
7898 #: build/C/man5/proc.5:1092
7900 msgid "I<signal> %lu"
7904 #: build/C/man5/proc.5:1098
7906 "(31) The bitmap of pending signals, displayed as a decimal number. "
7907 "Obsolete, because it does not provide information on real-time signals; use "
7908 "I</proc/[pid]/status> instead."
7912 #: build/C/man5/proc.5:1098
7914 msgid "I<blocked> %lu"
7918 #: build/C/man5/proc.5:1104
7920 "(32) The bitmap of blocked signals, displayed as a decimal number. "
7921 "Obsolete, because it does not provide information on real-time signals; use "
7922 "I</proc/[pid]/status> instead."
7926 #: build/C/man5/proc.5:1104
7928 msgid "I<sigignore> %lu"
7932 #: build/C/man5/proc.5:1110
7934 "(33) The bitmap of ignored signals, displayed as a decimal number. "
7935 "Obsolete, because it does not provide information on real-time signals; use "
7936 "I</proc/[pid]/status> instead."
7940 #: build/C/man5/proc.5:1110
7942 msgid "I<sigcatch> %lu"
7946 #: build/C/man5/proc.5:1116
7948 "(34) The bitmap of caught signals, displayed as a decimal number. Obsolete, "
7949 "because it does not provide information on real-time signals; use "
7950 "I</proc/[pid]/status> instead."
7954 #: build/C/man5/proc.5:1116
7956 msgid "I<wchan> %lu"
7960 #: build/C/man5/proc.5:1126
7962 "(35) This is the \"channel\" in which the process is waiting. It is the "
7963 "address of a system call, and can be looked up in a namelist if you need a "
7964 "textual name. (If you have an up-to-date I</etc/psdatabase>, then try I<ps "
7965 "-l> to see the WCHAN field in action.)"
7969 #: build/C/man5/proc.5:1126
7971 msgid "I<nswap> %lu"
7974 #. nswap was added in 2.0
7976 #: build/C/man5/proc.5:1131
7977 msgid "(36) Number of pages swapped (not maintained)."
7981 #: build/C/man5/proc.5:1131
7983 msgid "I<cnswap> %lu"
7986 #. cnswap was added in 2.0
7988 #: build/C/man5/proc.5:1136
7989 msgid "(37) Cumulative I<nswap> for child processes (not maintained)."
7993 #: build/C/man5/proc.5:1136
7995 msgid "I<exit_signal> %d (since Linux 2.1.22)"
7999 #: build/C/man5/proc.5:1139
8000 msgid "(38) Signal to be sent to parent when we die."
8004 #: build/C/man5/proc.5:1139
8006 msgid "I<processor> %d (since Linux 2.2.8)"
8010 #: build/C/man5/proc.5:1142
8011 msgid "(39) CPU number last executed on."
8015 #: build/C/man5/proc.5:1142
8017 msgid "I<rt_priority> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
8021 #: build/C/man5/proc.5:1148
8023 "(40) Real-time scheduling priority, a number in the range 1 to 99 for "
8024 "processes scheduled under a real-time policy, or 0, for non-real-time "
8025 "processes (see B<sched_setscheduler>(2))."
8029 #: build/C/man5/proc.5:1148
8031 msgid "I<policy> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
8035 #: build/C/man5/proc.5:1154
8037 "(41) Scheduling policy (see B<sched_setscheduler>(2)). Decode using the "
8038 "SCHED_* constants in I<linux/sched.h>."
8042 #: build/C/man5/proc.5:1154
8044 msgid "I<delayacct_blkio_ticks> %llu (since Linux 2.6.18)"
8048 #: build/C/man5/proc.5:1157
8049 msgid "(42) Aggregated block I/O delays, measured in clock ticks (centiseconds)."
8053 #: build/C/man5/proc.5:1157
8055 msgid "I<guest_time> %lu (since Linux 2.6.24)"
8059 #: build/C/man5/proc.5:1162
8061 "(43) Guest time of the process (time spent running a virtual CPU for a guest "
8062 "operating system), measured in clock ticks (divide by "
8063 "I<sysconf(_SC_CLK_TCK)>)."
8067 #: build/C/man5/proc.5:1162
8069 msgid "I<cguest_time> %ld (since Linux 2.6.24)"
8073 #: build/C/man5/proc.5:1166
8075 "(44) Guest time of the process's children, measured in clock ticks (divide "
8076 "by I<sysconf(_SC_CLK_TCK)>)."
8080 #: build/C/man5/proc.5:1167
8082 msgid "I</proc/[pid]/statm>"
8086 #: build/C/man5/proc.5:1171
8088 "Provides information about memory usage, measured in pages. The columns "
8092 #. (not including libs; broken, includes data segment)
8093 #. (including libs; broken, includes library text)
8095 #: build/C/man5/proc.5:1185
8098 "size (1) total program size\n"
8099 " (same as VmSize in I</proc/[pid]/status>)\n"
8100 "resident (2) resident set size\n"
8101 " (same as VmRSS in I</proc/[pid]/status>)\n"
8102 "share (3) shared pages (i.e., backed by a file)\n"
8103 "text (4) text (code)\n"
8104 "lib (5) library (unused in Linux 2.6)\n"
8105 "data (6) data + stack\n"
8106 "dt (7) dirty pages (unused in Linux 2.6)\n"
8110 #: build/C/man5/proc.5:1187
8112 msgid "I</proc/[pid]/status>"
8116 #: build/C/man5/proc.5:1195
8118 "Provides much of the information in I</proc/[pid]/stat> and "
8119 "I</proc/[pid]/statm> in a format that's easier for humans to parse. Here's "
8124 #: build/C/man5/proc.5:1236
8127 "$B< cat /proc/$$/status>\n"
8129 "State: S (sleeping)\n"
8134 "Uid: 1000 1000 1000 1000\n"
8135 "Gid: 100 100 100 100\n"
8137 "Groups: 16 33 100\n"
8150 "SigPnd: 0000000000000000\n"
8151 "ShdPnd: 0000000000000000\n"
8152 "SigBlk: 0000000000010000\n"
8153 "SigIgn: 0000000000384004\n"
8154 "SigCgt: 000000004b813efb\n"
8155 "CapInh: 0000000000000000\n"
8156 "CapPrm: 0000000000000000\n"
8157 "CapEff: 0000000000000000\n"
8158 "CapBnd: ffffffffffffffff\n"
8159 "Cpus_allowed: 00000001\n"
8160 "Cpus_allowed_list: 0\n"
8162 "Mems_allowed_list: 0\n"
8163 "voluntary_ctxt_switches: 150\n"
8164 "nonvoluntary_ctxt_switches: 545\n"
8168 #: build/C/man5/proc.5:1240
8169 msgid "The fields are as follows:"
8173 #: build/C/man5/proc.5:1244
8174 msgid "I<Name>: Command run by this process."
8178 #: build/C/man5/proc.5:1256
8180 "I<State>: Current state of the process. One of \"R (running)\", \"S "
8181 "(sleeping)\", \"D (disk sleep)\", \"T (stopped)\", \"T (tracing stop)\", \"Z "
8182 "(zombie)\", or \"X (dead)\"."
8186 #: build/C/man5/proc.5:1259
8187 msgid "I<Tgid>: Thread group ID (i.e., Process ID)."
8191 #: build/C/man5/proc.5:1263
8192 msgid "I<Pid>: Thread ID (see B<gettid>(2))."
8196 #: build/C/man5/proc.5:1266
8197 msgid "I<PPid>: PID of parent process."
8201 #: build/C/man5/proc.5:1269
8202 msgid "I<TracerPid>: PID of process tracing this process (0 if not being traced)."
8206 #: build/C/man5/proc.5:1272
8207 msgid "I<Uid>, I<Gid>: Real, effective, saved set, and file system UIDs (GIDs)."
8211 #: build/C/man5/proc.5:1275
8212 msgid "I<FDSize>: Number of file descriptor slots currently allocated."
8216 #: build/C/man5/proc.5:1278
8217 msgid "I<Groups>: Supplementary group list."
8221 #: build/C/man5/proc.5:1281
8222 msgid "I<VmPeak>: Peak virtual memory size."
8226 #: build/C/man5/proc.5:1284
8227 msgid "I<VmSize>: Virtual memory size."
8231 #: build/C/man5/proc.5:1288
8232 msgid "I<VmLck>: Locked memory size (see B<mlock>(3))."
8236 #: build/C/man5/proc.5:1291
8237 msgid "I<VmHWM>: Peak resident set size (\"high water mark\")."
8241 #: build/C/man5/proc.5:1294
8242 msgid "I<VmRSS>: Resident set size."
8246 #: build/C/man5/proc.5:1297
8247 msgid "I<VmData>, I<VmStk>, I<VmExe>: Size of data, stack, and text segments."
8251 #: build/C/man5/proc.5:1300
8252 msgid "I<VmLib>: Shared library code size."
8256 #: build/C/man5/proc.5:1303
8257 msgid "I<VmPTE>: Page table entries size (since Linux 2.6.10)."
8261 #: build/C/man5/proc.5:1306
8262 msgid "I<Threads>: Number of threads in process containing this thread."
8266 #: build/C/man5/proc.5:1317
8268 "I<SigQ>: This field contains two slash-separated numbers that relate to "
8269 "queued signals for the real user ID of this process. The first of these is "
8270 "the number of currently queued signals for this real user ID, and the second "
8271 "is the resource limit on the number of queued signals for this process (see "
8272 "the description of B<RLIMIT_SIGPENDING> in B<getrlimit>(2))."
8276 #: build/C/man5/proc.5:1323
8278 "I<SigPnd>, I<ShdPnd>: Number of signals pending for thread and for process "
8279 "as a whole (see B<pthreads>(7) and B<signal>(7))."
8283 #: build/C/man5/proc.5:1327
8285 "I<SigBlk>, I<SigIgn>, I<SigCgt>: Masks indicating signals being blocked, "
8286 "ignored, and caught (see B<signal>(7))."
8290 #: build/C/man5/proc.5:1332
8292 "I<CapInh>, I<CapPrm>, I<CapEff>: Masks of capabilities enabled in "
8293 "inheritable, permitted, and effective sets (see B<capabilities>(7))."
8297 #: build/C/man5/proc.5:1337
8299 "I<CapBnd>: Capability Bounding set (since kernel 2.6.26, see "
8300 "B<capabilities>(7))."
8304 #: build/C/man5/proc.5:1342
8306 "I<Cpus_allowed>: Mask of CPUs on which this process may run (since Linux "
8307 "2.6.24, see B<cpuset>(7))."
8311 #: build/C/man5/proc.5:1347
8313 "I<Cpus_allowed_list>: Same as previous, but in \"list format\" (since Linux "
8314 "2.6.26, see B<cpuset>(7))."
8318 #: build/C/man5/proc.5:1352
8320 "I<Mems_allowed>: Mask of memory nodes allowed to this process (since Linux "
8321 "2.6.24, see B<cpuset>(7))."
8325 #: build/C/man5/proc.5:1357
8327 "I<Mems_allowed_list>: Same as previous, but in \"list format\" (since Linux "
8328 "2.6.26, see B<cpuset>(7))."
8332 #: build/C/man5/proc.5:1360
8334 "I<voluntary_context_switches>, I<nonvoluntary_context_switches>: Number of "
8335 "voluntary and involuntary context switches (since Linux 2.6.23)."
8339 #: build/C/man5/proc.5:1361
8341 msgid "I</proc/[pid]/task> (since Linux 2.6.0-test6)"
8345 #: build/C/man5/proc.5:1392
8347 "This is a directory that contains one subdirectory for each thread in the "
8348 "process. The name of each subdirectory is the numerical thread ID "
8349 "(I<[tid]>) of the thread (see B<gettid>(2)). Within each of these "
8350 "subdirectories, there is a set of files with the same names and contents as "
8351 "under the I</proc/[pid]> directories. For attributes that are shared by all "
8352 "threads, the contents for each of the files under the I<task/[tid]> "
8353 "subdirectories will be the same as in the corresponding file in the parent "
8354 "I</proc/[pid]> directory (e.g., in a multithreaded process, all of the "
8355 "I<task/[tid]/cwd> files will have the same value as the I</proc/[pid]/cwd> "
8356 "file in the parent directory, since all of the threads in a process share a "
8357 "working directory). For attributes that are distinct for each thread, the "
8358 "corresponding files under I<task/[tid]> may have different values (e.g., "
8359 "various fields in each of the I<task/[tid]/status> files may be different "
8363 #. The following was still true as at kernel 2.6.13
8365 #: build/C/man5/proc.5:1399
8367 "In a multithreaded process, the contents of the I</proc/[pid]/task> "
8368 "directory are not available if the main thread has already terminated "
8369 "(typically by calling B<pthread_exit>(3))."
8373 #: build/C/man5/proc.5:1399
8375 msgid "I</proc/apm>"
8379 #: build/C/man5/proc.5:1404
8381 "Advanced power management version and battery information when B<CONFIG_APM> "
8382 "is defined at kernel compilation time."
8386 #: build/C/man5/proc.5:1404
8388 msgid "I</proc/bus>"
8392 #: build/C/man5/proc.5:1407
8393 msgid "Contains subdirectories for installed busses."
8397 #: build/C/man5/proc.5:1407
8399 msgid "I</proc/bus/pccard>"
8403 #: build/C/man5/proc.5:1412
8405 "Subdirectory for PCMCIA devices when B<CONFIG_PCMCIA> is set at kernel "
8410 #: build/C/man5/proc.5:1412
8412 msgid "I</proc/bus/pccard/drivers>"
8416 #: build/C/man5/proc.5:1414
8418 msgid "I</proc/bus/pci>"
8422 #: build/C/man5/proc.5:1420
8424 "Contains various bus subdirectories and pseudo-files containing information "
8425 "about PCI busses, installed devices, and device drivers. Some of these "
8426 "files are not ASCII."
8430 #: build/C/man5/proc.5:1420
8432 msgid "I</proc/bus/pci/devices>"
8436 #: build/C/man5/proc.5:1427
8438 "Information about PCI devices. They may be accessed through B<lspci>(8) "
8443 #: build/C/man5/proc.5:1427
8445 msgid "I</proc/cmdline>"
8449 #: build/C/man5/proc.5:1434
8451 "Arguments passed to the Linux kernel at boot time. Often done via a boot "
8452 "manager such as B<lilo>(8) or B<grub>(8)."
8456 #: build/C/man5/proc.5:1434
8458 msgid "I</proc/config.gz> (since Linux 2.6)"
8462 #: build/C/man5/proc.5:1452
8464 "This file exposes the configuration options that were used to build the "
8465 "currently running kernel, in the same format as they would be shown in the "
8466 "I<.config> file that resulted when configuring the kernel (using I<make "
8467 "xconfig>, I<make config>, or similar). The file contents are compressed; "
8468 "view or search them using B<zcat>(1), B<zgrep>(1), etc. As long as no "
8469 "changes have been made to the following file, the contents of "
8470 "I</proc/config.gz> are the same as those provided by :"
8474 #: build/C/man5/proc.5:1456
8476 msgid "cat /lib/modules/$(uname -r)/build/.config\n"
8480 #: build/C/man5/proc.5:1462
8482 "I</proc/config.gz> is provided only if the kernel is configured with "
8483 "B<CONFIG_IKCONFIG_PROC>."
8487 #: build/C/man5/proc.5:1462
8489 msgid "I</proc/cpuinfo>"
8493 #: build/C/man5/proc.5:1474
8495 "This is a collection of CPU and system architecture dependent items, for "
8496 "each supported architecture a different list. Two common entries are "
8497 "I<processor> which gives CPU number and I<bogomips>; a system constant that "
8498 "is calculated during kernel initialization. SMP machines have information "
8499 "for each CPU. The B<lscpu>(1) command gathers its information from this "
8504 #: build/C/man5/proc.5:1474
8506 msgid "I</proc/devices>"
8510 #: build/C/man5/proc.5:1478
8512 "Text listing of major numbers and device groups. This can be used by "
8513 "MAKEDEV scripts for consistency with the kernel."
8517 #: build/C/man5/proc.5:1478
8519 msgid "I</proc/diskstats> (since Linux 2.5.69)"
8523 #: build/C/man5/proc.5:1484
8525 "This file contains disk I/O statistics for each disk device. See the Linux "
8526 "kernel source file I<Documentation/iostats.txt> for further information."
8530 #: build/C/man5/proc.5:1484
8532 msgid "I</proc/dma>"
8536 #: build/C/man5/proc.5:1488
8538 "This is a list of the registered I<ISA> DMA (direct memory access) channels "
8543 #: build/C/man5/proc.5:1488
8545 msgid "I</proc/driver>"
8549 #: build/C/man5/proc.5:1491 build/C/man5/proc.5:1519
8550 msgid "Empty subdirectory."
8554 #: build/C/man5/proc.5:1491
8556 msgid "I</proc/execdomains>"
8560 #: build/C/man5/proc.5:1494
8561 msgid "List of the execution domains (ABI personalities)."
8565 #: build/C/man5/proc.5:1494
8571 #: build/C/man5/proc.5:1499
8573 "Frame buffer information when B<CONFIG_FB> is defined during kernel "
8578 #: build/C/man5/proc.5:1499
8580 msgid "I</proc/filesystems>"
8584 #: build/C/man5/proc.5:1509
8586 "A text listing of the file systems which are supported by the kernel, namely "
8587 "file systems which were compiled into the kernel or whose kernel modules are "
8588 "currently loaded. (See also B<filesystems>(5).) If a file system is marked "
8589 "with \"nodev\", this means that it does not require a block device to be "
8590 "mounted (e.g., virtual file system, network file system)."
8594 #: build/C/man5/proc.5:1516
8596 "Incidentally, this file may be used by B<mount>(8) when no file system is "
8597 "specified and it didn't manage to determine the file system type. Then file "
8598 "systems contained in this file are tried (excepted those that are marked "
8603 #: build/C/man5/proc.5:1516
8609 #: build/C/man5/proc.5:1519
8611 msgid "I</proc/ide>"
8615 #: build/C/man5/proc.5:1525
8617 "This directory exists on systems with the IDE bus. There are directories "
8618 "for each IDE channel and attached device. Files include:"
8622 #: build/C/man5/proc.5:1538
8625 "cache buffer size in KB\n"
8626 "capacity number of sectors\n"
8627 "driver driver version\n"
8628 "geometry physical and logical geometry\n"
8629 "identify in hexadecimal\n"
8630 "media media type\n"
8631 "model manufacturer's model number\n"
8632 "settings drive settings\n"
8633 "smart_thresholds in hexadecimal\n"
8634 "smart_values in hexadecimal\n"
8638 #: build/C/man5/proc.5:1544
8640 "The B<hdparm>(8) utility provides access to this information in a friendly "
8645 #: build/C/man5/proc.5:1544
8647 msgid "I</proc/interrupts>"
8651 #: build/C/man5/proc.5:1554
8653 "This is used to record the number of interrupts per CPU per IO device. "
8654 "Since Linux 2.6.24, for the i386 and x86_64 architectures, at least, this "
8655 "also includes interrupts internal to the system (that is, not associated "
8656 "with a device as such), such as NMI (nonmaskable interrupt), LOC (local "
8657 "timer interrupt), and for SMP systems, TLB (TLB flush interrupt), RES "
8658 "(rescheduling interrupt), CAL (remote function call interrupt), and possibly "
8659 "others. Very easy to read formatting, done in ASCII."
8663 #: build/C/man5/proc.5:1554
8665 msgid "I</proc/iomem>"
8669 #: build/C/man5/proc.5:1557
8670 msgid "I/O memory map in Linux 2.4."
8674 #: build/C/man5/proc.5:1557
8676 msgid "I</proc/ioports>"
8680 #: build/C/man5/proc.5:1561
8682 "This is a list of currently registered Input-Output port regions that are in "
8687 #: build/C/man5/proc.5:1561
8689 msgid "I</proc/kallsyms> (since Linux 2.5.71)"
8693 #: build/C/man5/proc.5:1569
8695 "This holds the kernel exported symbol definitions used by the B<modules>(X) "
8696 "tools to dynamically link and bind loadable modules. In Linux 2.5.47 and "
8697 "earlier, a similar file with slightly different syntax was named I<ksyms>."
8701 #: build/C/man5/proc.5:1569
8703 msgid "I</proc/kcore>"
8707 #: build/C/man5/proc.5:1578
8709 "This file represents the physical memory of the system and is stored in the "
8710 "ELF core file format. With this pseudo-file, and an unstripped kernel "
8711 "(I</usr/src/linux/vmlinux>) binary, GDB can be used to examine the current "
8712 "state of any kernel data structures."
8716 #: build/C/man5/proc.5:1581
8717 msgid "The total length of the file is the size of physical memory (RAM) plus 4KB."
8721 #: build/C/man5/proc.5:1581
8723 msgid "I</proc/kmsg>"
8727 #: build/C/man5/proc.5:1593
8729 "This file can be used instead of the B<syslog>(2) system call to read "
8730 "kernel messages. A process must have superuser privileges to read this "
8731 "file, and only one process should read this file. This file should not be "
8732 "read if a syslog process is running which uses the B<syslog>(2) system call "
8733 "facility to log kernel messages."
8737 #: build/C/man5/proc.5:1597
8738 msgid "Information in this file is retrieved with the B<dmesg>(1) program."
8742 #: build/C/man5/proc.5:1597
8744 msgid "I</proc/ksyms> (Linux 1.1.23-2.5.47)"
8748 #: build/C/man5/proc.5:1601
8749 msgid "See I</proc/kallsyms>."
8753 #: build/C/man5/proc.5:1601
8755 msgid "I</proc/loadavg>"
8759 #: build/C/man5/proc.5:1616
8761 "The first three fields in this file are load average figures giving the "
8762 "number of jobs in the run queue (state R) or waiting for disk I/O (state D) "
8763 "averaged over 1, 5, and 15 minutes. They are the same as the load average "
8764 "numbers given by B<uptime>(1) and other programs. The fourth field "
8765 "consists of two numbers separated by a slash (/). The first of these is the "
8766 "number of currently runnable kernel scheduling entities (processes, "
8767 "threads). The value after the slash is the number of kernel scheduling "
8768 "entities that currently exist on the system. The fifth field is the PID of "
8769 "the process that was most recently created on the system."
8773 #: build/C/man5/proc.5:1616
8775 msgid "I</proc/locks>"
8779 #: build/C/man5/proc.5:1622
8781 "This file shows current file locks (B<flock>(2) and B<fcntl>(2)) and leases "
8786 #: build/C/man5/proc.5:1622
8788 msgid "I</proc/malloc> (only up to and including Linux 2.2)"
8791 #. It looks like this only ever did something back in 1.0 days
8793 #: build/C/man5/proc.5:1628
8795 "This file is present only if B<CONFIG_DEBUG_MALLOC> was defined during "
8800 #: build/C/man5/proc.5:1628
8802 msgid "I</proc/meminfo>"
8806 #: build/C/man5/proc.5:1644
8808 "This file reports statistics about memory usage on the system. It is used "
8809 "by B<free>(1) to report the amount of free and used memory (both physical "
8810 "and swap) on the system as well as the shared memory and buffers used by "
8811 "the kernel. Each line of the file consists of a parameter name, followed by "
8812 "a colon, the value of the parameter, and an option unit of measurement "
8813 "(e.g., \"kB\"). The list below describes the parameter names and the format "
8814 "specifier required to read the field value. Except as noted below, all of "
8815 "the fields have been present since at least Linux 2.6.0. Some fileds are "
8816 "displayed only if the kernel was configured with various options; those "
8817 "dependencies are noted in the list."
8821 #: build/C/man5/proc.5:1645
8823 msgid "I<MemTotal> %lu"
8827 #: build/C/man5/proc.5:1649
8829 "Total usable RAM (i.e. physical RAM minus a few reserved bits and the kernel "
8834 #: build/C/man5/proc.5:1649
8836 msgid "I<MemFree> %lu"
8840 #: build/C/man5/proc.5:1653
8841 msgid "The sum of I<LowFree>+I<HighFree>."
8845 #: build/C/man5/proc.5:1653
8847 msgid "I<Buffers> %lu"
8851 #: build/C/man5/proc.5:1657
8853 "Relatively temporary storage for raw disk blocks that shouldn't get "
8854 "tremendously large (20MB or so)."
8858 #: build/C/man5/proc.5:1657
8860 msgid "I<Cached> %lu"
8864 #: build/C/man5/proc.5:1662
8866 "In-memory cache for files read from the disk (the page cache). Doesn't "
8867 "include I<SwapCached>."
8871 #: build/C/man5/proc.5:1662
8873 msgid "I<SwapCached> %lu"
8877 #: build/C/man5/proc.5:1670
8879 "Memory that once was swapped out, is swapped back in but still also is in "
8880 "the swap file. (If memory pressure is high, these pages don't need to be "
8881 "swapped out again because they are already in the swap file. This saves "
8886 #: build/C/man5/proc.5:1670
8888 msgid "I<Active> %lu"
8892 #: build/C/man5/proc.5:1674
8894 "Memory that has been used more recently and usually not reclaimed unless "
8895 "absolutely necessary."
8899 #: build/C/man5/proc.5:1674
8901 msgid "I<Inactive> %lu"
8905 #: build/C/man5/proc.5:1678
8907 "Memory which has been less recently used. It is more eligible to be "
8908 "reclaimed for other purposes."
8912 #: build/C/man5/proc.5:1678
8914 msgid "I<Active(anon)> %lu (since Linux 2.6.28)"
8918 #: build/C/man5/proc.5:1681 build/C/man5/proc.5:1684 build/C/man5/proc.5:1687 build/C/man5/proc.5:1690 build/C/man5/proc.5:1755
8919 msgid "[To be documented.]"
8923 #: build/C/man5/proc.5:1681
8925 msgid "I<Inactive(anon)> %lu (since Linux 2.6.28)"
8929 #: build/C/man5/proc.5:1684
8931 msgid "I<Active(file)> %lu (since Linux 2.6.28)"
8935 #: build/C/man5/proc.5:1687
8937 msgid "I<Inactive(file)> %lu (since Linux 2.6.28)"
8941 #: build/C/man5/proc.5:1690
8943 msgid "I<Unevictable> %lu (since Linux 2.6.28)"
8947 #: build/C/man5/proc.5:1695 build/C/man5/proc.5:1700
8949 "(From Linux 2.6.28 to 2.6.30, B<CONFIG_UNEVICTABLE_LRU> was required.) [To "
8954 #: build/C/man5/proc.5:1695
8956 msgid "I<Mlocked> %lu (since Linux 2.6.28)"
8960 #: build/C/man5/proc.5:1700
8962 msgid "I<HighTotal> %lu"
8966 #: build/C/man5/proc.5:1709
8968 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
8969 "of highmem. Highmem is all memory above ~860MB of physical memory. Highmem "
8970 "areas are for use by user-space programs, or for the page cache. The kernel "
8971 "must use tricks to access this memory, making it slower to access than "
8976 #: build/C/man5/proc.5:1709
8978 msgid "I<HighFree> %lu"
8982 #: build/C/man5/proc.5:1713
8984 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
8989 #: build/C/man5/proc.5:1713
8991 msgid "I<LowTotal> %lu"
8995 #: build/C/man5/proc.5:1725
8997 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
8998 "of lowmem. Lowmem is memory which can be used for everything that highmem "
8999 "can be used for, but it is also available for the kernel's use for its own "
9000 "data structures. Among many other things, it is where everything from "
9001 "I<Slab> is allocated. Bad things happen when you're out of lowmem."
9005 #: build/C/man5/proc.5:1725
9007 msgid "I<LowFree> %lu"
9011 #: build/C/man5/proc.5:1729
9013 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
9018 #: build/C/man5/proc.5:1729
9020 msgid "I<MmapCopy> %lu (since Linux 2.6.29)"
9024 #: build/C/man5/proc.5:1734
9025 msgid "(B<CONFIG_MMU> is required.) [To be documented.]"
9029 #: build/C/man5/proc.5:1734
9031 msgid "I<SwapTotal> %lu"
9035 #: build/C/man5/proc.5:1737
9036 msgid "Total amount of swap space available."
9040 #: build/C/man5/proc.5:1737
9042 msgid "I<SwapFree> %lu"
9046 #: build/C/man5/proc.5:1740
9047 msgid "Amount of swap space that is currently unused."
9051 #: build/C/man5/proc.5:1740
9053 msgid "I<Dirty> %lu"
9057 #: build/C/man5/proc.5:1743
9058 msgid "Memory which is waiting to get written back to the disk."
9062 #: build/C/man5/proc.5:1743
9064 msgid "I<Writeback> %lu"
9068 #: build/C/man5/proc.5:1746
9069 msgid "Memory which is actively being written back to the disk."
9073 #: build/C/man5/proc.5:1746
9075 msgid "I<AnonPages> %lu (since Linux 2.6.18)"
9079 #: build/C/man5/proc.5:1749
9080 msgid "Non-file backed pages mapped into user-space page tables."
9084 #: build/C/man5/proc.5:1749
9086 msgid "I<Mapped> %lu"
9090 #: build/C/man5/proc.5:1752
9091 msgid "Files which have been mmaped, such as libraries."
9095 #: build/C/man5/proc.5:1752
9097 msgid "I<Shmem> %lu (since Linux 2.6.32)"
9101 #: build/C/man5/proc.5:1755
9107 #: build/C/man5/proc.5:1758
9108 msgid "In-kernel data structures cache."
9112 #: build/C/man5/proc.5:1758
9114 msgid "I<SReclaimable> %lu (since Linux 2.6.19)"
9118 #: build/C/man5/proc.5:1763
9119 msgid "Part of I<Slab>, that might be reclaimed, such as caches."
9123 #: build/C/man5/proc.5:1763
9125 msgid "I<SUnreclaim> %lu (since Linux 2.6.19)"
9129 #: build/C/man5/proc.5:1768
9130 msgid "Part of I<Slab>, that cannot be reclaimed on memory pressure."
9134 #: build/C/man5/proc.5:1768
9136 msgid "I<KernelStack> %lu (since Linux 2.6.32)"
9140 #: build/C/man5/proc.5:1771
9141 msgid "Amount of memory allocated to kernel stacks."
9145 #: build/C/man5/proc.5:1771
9147 msgid "I<PageTables> %lu (since Linux 2.6.18)"
9151 #: build/C/man5/proc.5:1774
9152 msgid "Amount of memory dedicated to the lowest level of page tables."
9156 #: build/C/man5/proc.5:1774
9158 msgid "I<Quicklists> %lu (since Linux 2.6.27)"
9162 #: build/C/man5/proc.5:1778
9163 msgid "(B<CONFIG_QUICKLIST> is required.) [To be documented.]"
9167 #: build/C/man5/proc.5:1778
9169 msgid "I<NFS_Unstable> %lu (since Linux 2.6.18)"
9173 #: build/C/man5/proc.5:1781
9174 msgid "NFS pages sent to the server, but not yet committed to stable storage."
9178 #: build/C/man5/proc.5:1781
9180 msgid "I<Bounce> %lu (since Linux 2.6.18)"
9184 #: build/C/man5/proc.5:1784
9185 msgid "Memory used for block device \"bounce buffers\"."
9189 #: build/C/man5/proc.5:1784
9191 msgid "I<WritebackTmp> %lu (since Linux 2.6.26)"
9195 #: build/C/man5/proc.5:1787
9196 msgid "Memory used by FUSE for temporary writeback buffers."
9200 #: build/C/man5/proc.5:1787
9202 msgid "I<CommitLimit> %lu (since Linux 2.6.10)"
9206 #: build/C/man5/proc.5:1798
9208 "Based on the overcommit ratio ('vm.overcommit_ratio'), this is the total "
9209 "amount of memory currently available to be allocated on the system. This "
9210 "limit is adhered to only if strict overcommit accounting is enabled (mode 2 "
9211 "in I</proc/sys/vm/overcommit_ratio>). The I<CommitLimit> is calculated "
9212 "using the following formula:"
9216 #: build/C/man5/proc.5:1800
9218 msgid " CommitLimit = (overcommit_ratio * Physical RAM) + Swap\n"
9222 #: build/C/man5/proc.5:1810
9224 "For example, on a system with 1GB of physical RAM and 7GB of swap with a "
9225 "I<overcommit_ratio> of 30, this formula yields a I<CommitLimit> of 7.3GB. "
9226 "For more details, see the memory overcommit documentation in the kernel "
9227 "source file I<Documentation/vm/overcommit-accounting>."
9231 #: build/C/man5/proc.5:1810
9233 msgid "I<Committed_AS> %lu"
9237 #: build/C/man5/proc.5:1830
9239 "The amount of memory presently allocated on the system. The committed "
9240 "memory is a sum of all of the memory which has been allocated by processes, "
9241 "even if it has not been \"used\" by them as of yet. A process which "
9242 "allocates 1GB of memory (using B<malloc>(3) or similar), but touches only "
9243 "300MB of that memory will show up as using only 300MB of memory even if it "
9244 "has the address space allocated for the entire 1GB. This 1GB is memory "
9245 "which has been \"committed\" to by the VM and can be used at any time by the "
9246 "allocating application. With strict overcommit enabled on the system (mode "
9247 "2 I</proc/sys/vm/overcommit_memory>), allocations which would exceed the "
9248 "I<CommitLimit> (detailed above) will not be permitted. This is useful if "
9249 "one needs to guarantee that processes will not fail due to lack of memory "
9250 "once that memory has been successfully allocated."
9254 #: build/C/man5/proc.5:1830
9256 msgid "I<VmallocTotal> %lu"
9260 #: build/C/man5/proc.5:1833
9261 msgid "Total size of vmalloc memory area."
9265 #: build/C/man5/proc.5:1833
9267 msgid "I<VmallocUsed> %lu"
9271 #: build/C/man5/proc.5:1836
9272 msgid "Amount of vmalloc area which is used."
9276 #: build/C/man5/proc.5:1836
9278 msgid "I<VmallocChunk> %lu"
9282 #: build/C/man5/proc.5:1839
9283 msgid "Largest contiguous block of vmalloc area which is free."
9287 #: build/C/man5/proc.5:1839
9289 msgid "I<HardwareCorrupted> %lu (since Linux 2.6.32)"
9293 #: build/C/man5/proc.5:1843
9294 msgid "(B<CONFIG_MEMORY_FAILURE> is required.) [To be documented.]"
9298 #: build/C/man5/proc.5:1843
9300 msgid "I<AnonHugePages> %lu (since Linux 2.6.38)"
9304 #: build/C/man5/proc.5:1847
9306 "(B<CONFIG_TRANSPARENT_HUGEPAGE> is required.) Non-file backed huge pages "
9307 "mapped into user-space page tables."
9311 #: build/C/man5/proc.5:1847
9313 msgid "I<HugePages_Total> %lu"
9317 #: build/C/man5/proc.5:1851
9318 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of the pool of huge pages."
9322 #: build/C/man5/proc.5:1851
9324 msgid "I<HugePages_Free> %lu"
9328 #: build/C/man5/proc.5:1855
9330 "(B<CONFIG_HUGETLB_PAGE> is required.) The number of huge pages in the pool "
9331 "that are not yet allocated."
9335 #: build/C/man5/proc.5:1855
9337 msgid "I<HugePages_Rsvd> %lu (since Linux 2.6.17)"
9341 #: build/C/man5/proc.5:1864
9343 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages for "
9344 "which a commitment to allocate from the pool has been made, but no "
9345 "allocation has yet been made. These reserved huge pages guarantee that an "
9346 "application will be able to allocate a huge page from the pool of huge pages "
9351 #: build/C/man5/proc.5:1864
9353 msgid "I<HugePages_Surp> %lu (since Linux 2.6.24)"
9357 #: build/C/man5/proc.5:1872
9359 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages in "
9360 "the pool above the value in I</proc/sys/vm/nr_hugepages>. The maximum "
9361 "number of surplus huge pages is controlled by "
9362 "I</proc/sys/vm/nr_overcommit_hugepages>."
9366 #: build/C/man5/proc.5:1872
9368 msgid "I<Hugepagesize> %lu"
9372 #: build/C/man5/proc.5:1876
9373 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of huge pages."
9377 #: build/C/man5/proc.5:1877
9379 msgid "I</proc/modules>"
9383 #: build/C/man5/proc.5:1882
9385 "A text list of the modules that have been loaded by the system. See also "
9390 #: build/C/man5/proc.5:1882
9392 msgid "I</proc/mounts>"
9396 #: build/C/man5/proc.5:1892
9398 "Before kernel 2.4.19, this file was a list of all the file systems currently "
9399 "mounted on the system. With the introduction of per-process mount "
9400 "namespaces in Linux 2.4.19, this file became a link to I</proc/self/mounts>, "
9401 "which lists the mount points of the process's own mount namespace. The "
9402 "format of this file is documented in B<fstab>(5)."
9406 #: build/C/man5/proc.5:1892
9408 msgid "I</proc/mtrr>"
9412 #: build/C/man5/proc.5:1898
9414 "Memory Type Range Registers. See the Linux kernel source file "
9415 "I<Documentation/mtrr.txt> for details."
9419 #: build/C/man5/proc.5:1898
9421 msgid "I</proc/net>"
9425 #: build/C/man5/proc.5:1908
9427 "various net pseudo-files, all of which give the status of some part of the "
9428 "networking layer. These files contain ASCII structures and are, therefore, "
9429 "readable with B<cat>(1). However, the standard B<netstat>(8) suite "
9430 "provides much cleaner access to these files."
9434 #: build/C/man5/proc.5:1908
9436 msgid "I</proc/net/arp>"
9440 #: build/C/man5/proc.5:1914
9442 "This holds an ASCII readable dump of the kernel ARP table used for address "
9443 "resolutions. It will show both dynamically learned and preprogrammed ARP "
9444 "entries. The format is:"
9448 #: build/C/man5/proc.5:1921
9451 "CW<IP address HW type Flags HW address Mask Device\n"
9452 "192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0\n"
9453 "192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0>\n"
9457 #: build/C/man5/proc.5:1933
9459 "Here \"IP address\" is the IPv4 address of the machine and the \"HW type\" "
9460 "is the hardware type of the address from RFC\\ 826. The flags are the "
9461 "internal flags of the ARP structure (as defined in "
9462 "I</usr/include/linux/if_arp.h>) and the \"HW address\" is the data link "
9463 "layer mapping for that IP address if it is known."
9467 #: build/C/man5/proc.5:1933
9469 msgid "I</proc/net/dev>"
9473 #: build/C/man5/proc.5:1944
9475 "The dev pseudo-file contains network device status information. This gives "
9476 "the number of received and sent packets, the number of errors and collisions "
9477 "and other basic statistics. These are used by the B<ifconfig>(8) program "
9478 "to report device status. The format is:"
9482 #: build/C/man5/proc.5:1954
9485 "CW<Inter-| Receive | "
9487 " face |bytes packets errs drop fifo frame compressed multicast|bytes "
9488 "packets errs drop fifo colls carrier compressed\n"
9489 " lo: 2776770 11307 0 0 0 0 0 0 2776770 "
9490 "11307 0 0 0 0 0 0\n"
9491 " eth0: 1215645 2751 0 0 0 0 0 0 1782404 "
9492 "4324 0 0 0 427 0 0\n"
9493 " ppp0: 1622270 5552 1 0 0 0 0 0 354130 "
9494 "5669 0 0 0 0 0 0\n"
9495 " tap0: 7714 81 0 0 0 0 0 0 7714 "
9500 #: build/C/man5/proc.5:1963
9502 msgid "I</proc/net/dev_mcast>"
9506 #: build/C/man5/proc.5:1967
9507 msgid "Defined in I</usr/src/linux/net/core/dev_mcast.c>:"
9511 #: build/C/man5/proc.5:1973
9514 "indx interface_name dmi_u dmi_g dmi_address\n"
9515 "2 eth0 1 0 01005e000001\n"
9516 "3 eth1 1 0 01005e000001\n"
9517 "4 eth2 1 0 01005e000001\n"
9521 #: build/C/man5/proc.5:1975
9523 msgid "I</proc/net/igmp>"
9527 #: build/C/man5/proc.5:1980
9529 "Internet Group Management Protocol. Defined in "
9530 "I</usr/src/linux/net/core/igmp.c>."
9534 #: build/C/man5/proc.5:1980
9536 msgid "I</proc/net/rarp>"
9540 #: build/C/man5/proc.5:1990
9542 "This file uses the same format as the I<arp> file and contains the current "
9543 "reverse mapping database used to provide B<rarp>(8) reverse address lookup "
9544 "services. If RARP is not configured into the kernel, this file will not be "
9549 #: build/C/man5/proc.5:1990
9551 msgid "I</proc/net/raw>"
9555 #. .I /proc/net/route
9556 #. No information, but looks similar to
9559 #: build/C/man5/proc.5:2010
9561 "Holds a dump of the RAW socket table. Much of the information is not of use "
9562 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
9563 "socket, the \"local_address\" is the local address and protocol number "
9564 "pair. \\&\"St\" is the internal status of the socket. The \"tx_queue\" and "
9565 "\"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
9566 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
9567 "used by RAW. The \"uid\" field holds the effective UID of the creator of "
9572 #: build/C/man5/proc.5:2010
9574 msgid "I</proc/net/snmp>"
9578 #: build/C/man5/proc.5:2015
9580 "This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP "
9581 "management information bases for an SNMP agent."
9585 #: build/C/man5/proc.5:2015
9587 msgid "I</proc/net/tcp>"
9591 #: build/C/man5/proc.5:2031
9593 "Holds a dump of the TCP socket table. Much of the information is not of use "
9594 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
9595 "socket, the \"local_address\" is the local address and port number pair. "
9596 "The \"rem_address\" is the remote address and port number pair (if "
9597 "connected). \\&\"St\" is the internal status of the socket. The "
9598 "\"tx_queue\" and \"rx_queue\" are the outgoing and incoming data queue in "
9599 "terms of kernel memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" "
9600 "fields hold internal information of the kernel socket state and are only "
9601 "useful for debugging. The \"uid\" field holds the effective UID of the "
9602 "creator of the socket."
9606 #: build/C/man5/proc.5:2031
9608 msgid "I</proc/net/udp>"
9612 #: build/C/man5/proc.5:2047
9614 "Holds a dump of the UDP socket table. Much of the information is not of use "
9615 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
9616 "socket, the \"local_address\" is the local address and port number pair. "
9617 "The \"rem_address\" is the remote address and port number pair (if "
9618 "connected). \"St\" is the internal status of the socket. The \"tx_queue\" "
9619 "and \"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
9620 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
9621 "used by UDP. The \"uid\" field holds the effective UID of the creator of "
9622 "the socket. The format is:"
9626 #: build/C/man5/proc.5:2055
9629 "CW<sl local_address rem_address st tx_queue rx_queue tr rexmits "
9630 "tm-E<gt>when uid\n"
9631 " 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 "
9633 " 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 "
9635 " 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 "
9640 #: build/C/man5/proc.5:2058
9642 msgid "I</proc/net/unix>"
9646 #: build/C/man5/proc.5:2063
9648 "Lists the UNIX domain sockets present within the system and their status. "
9653 #: build/C/man5/proc.5:2069
9656 "CW<Num RefCount Protocol Flags Type St Path\n"
9657 " 0: 00000002 00000000 00000000 0001 03\n"
9658 " 1: 00000001 00000000 00010000 0001 01 /dev/printer>\n"
9662 #: build/C/man5/proc.5:2081
9664 "Here \"Num\" is the kernel table slot number, \"RefCount\" is the number of "
9665 "users of the socket, \"Protocol\" is currently always 0, \"Flags\" represent "
9666 "the internal kernel flags holding the status of the socket. Currently, type "
9667 "is always \"1\" (UNIX domain datagram sockets are not yet supported in the "
9668 "kernel). \\&\"St\" is the internal state of the socket and Path is the "
9669 "bound path (if any) of the socket."
9673 #: build/C/man5/proc.5:2081
9675 msgid "I</proc/partitions>"
9679 #: build/C/man5/proc.5:2085
9681 "Contains major and minor numbers of each partition as well as number of "
9682 "blocks and partition name."
9686 #: build/C/man5/proc.5:2085
9688 msgid "I</proc/pci>"
9692 #: build/C/man5/proc.5:2089
9694 "This is a listing of all PCI devices found during kernel initialization and "
9695 "their configuration."
9698 #. FIXME /proc/sched_debug
9700 #. .IR /proc/sched_debug " (since Linux 2.6.23)"
9701 #. See also /proc/[pid]/sched
9703 #: build/C/man5/proc.5:2105
9705 "This file has been deprecated in favor of a new I</proc> interface for PCI "
9706 "(I</proc/bus/pci>). It became optional in Linux 2.2 (available with "
9707 "B<CONFIG_PCI_OLD_PROC> set at kernel compilation). It became once more "
9708 "nonoptionally enabled in Linux 2.4. Next, it was deprecated in Linux 2.6 "
9709 "(still available with B<CONFIG_PCI_LEGACY_PROC> set), and finally removed "
9710 "altogether since Linux 2.6.17."
9714 #: build/C/man5/proc.5:2105
9716 msgid "I</proc/profile> (since Linux 2.4)"
9720 #: build/C/man5/proc.5:2117
9722 "This file is present only if the kernel was booted with the I<profile=1> "
9723 "command-line option. It exposes kernel profiling information in a binary "
9724 "format for use by B<readprofile>(1). Writing (e.g., an empty string) to "
9725 "this file resets the profiling counters; on some architectures, writing a "
9726 "binary integer \"profiling multiplier\" of size I<sizeof(int)> sets the "
9727 "profiling interrupt frequency."
9731 #: build/C/man5/proc.5:2117
9733 msgid "I</proc/scsi>"
9737 #: build/C/man5/proc.5:2127
9739 "A directory with the I<scsi> mid-level pseudo-file and various SCSI "
9740 "low-level driver directories, which contain a file for each SCSI host in "
9741 "this system, all of which give the status of some part of the SCSI IO "
9742 "subsystem. These files contain ASCII structures and are, therefore, "
9743 "readable with B<cat>(1)."
9747 #: build/C/man5/proc.5:2130
9749 "You can also write to some of the files to reconfigure the subsystem or "
9750 "switch certain features on or off."
9754 #: build/C/man5/proc.5:2130
9756 msgid "I</proc/scsi/scsi>"
9760 #: build/C/man5/proc.5:2136
9762 "This is a listing of all SCSI devices known to the kernel. The listing is "
9763 "similar to the one seen during bootup. scsi currently supports only the "
9764 "I<add-single-device> command which allows root to add a hotplugged device to "
9765 "the list of known devices."
9769 #: build/C/man5/proc.5:2138
9774 #: build/C/man5/proc.5:2142
9776 msgid "echo \\(aqscsi add-single-device 1 0 5 0\\(aq E<gt> /proc/scsi/scsi\n"
9780 #: build/C/man5/proc.5:2150
9782 "will cause host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. "
9783 "If there is already a device known on this address or the address is "
9784 "invalid, an error will be returned."
9788 #: build/C/man5/proc.5:2150
9790 msgid "I</proc/scsi/[drivername]>"
9794 #: build/C/man5/proc.5:2160
9796 "I<[drivername]> can currently be NCR53c7xx, aha152x, aha1542, aha1740, "
9797 "aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, "
9798 "scsi_debug, seagate, t128, u15-24f, ultrastore, or wd7000. These "
9799 "directories show up for all drivers that registered at least one SCSI HBA. "
9800 "Every directory contains one file per registered host. Every host-file is "
9801 "named after the number the host was assigned during initialization."
9805 #: build/C/man5/proc.5:2163
9807 "Reading these files will usually show driver and host configuration, "
9812 #: build/C/man5/proc.5:2170
9814 "Writing to these files allows different things on different hosts. For "
9815 "example, with the I<latency> and I<nolatency> commands, root can switch on "
9816 "and off command latency measurement code in the eata_dma driver. With the "
9817 "I<lockup> and I<unlock> commands, root can control bus lockups simulated by "
9818 "the scsi_debug driver."
9822 #: build/C/man5/proc.5:2170
9824 msgid "I</proc/self>"
9828 #: build/C/man5/proc.5:2178
9830 "This directory refers to the process accessing the I</proc> file system, and "
9831 "is identical to the I</proc> directory named by the process ID of the same "
9836 #: build/C/man5/proc.5:2178
9838 msgid "I</proc/slabinfo>"
9842 #: build/C/man5/proc.5:2187
9844 "Information about kernel caches. Since Linux 2.6.16 this file is present "
9845 "only if the B<CONFIG_SLAB> kernel configuration option is enabled. The "
9846 "columns in I</proc/slabinfo> are:"
9850 #: build/C/man5/proc.5:2197
9857 "num-active-slabs\n"
9859 "num-pages-per-slab\n"
9863 #: build/C/man5/proc.5:2203
9864 msgid "See B<slabinfo>(5) for details."
9868 #: build/C/man5/proc.5:2203
9870 msgid "I</proc/stat>"
9874 #: build/C/man5/proc.5:2209
9876 "kernel/system statistics. Varies with architecture. Common entries "
9881 #: build/C/man5/proc.5:2210
9883 msgid "I<cpu 3357 0 4313 1362393>"
9886 #. 1024 on Alpha and ia64
9888 #: build/C/man5/proc.5:2218
9890 "The amount of time, measured in units of USER_HZ (1/100ths of a second on "
9891 "most architectures, use I<sysconf(_SC_CLK_TCK)> to obtain the right value), "
9892 "that the system spent in various states:"
9896 #: build/C/man5/proc.5:2219
9902 #: build/C/man5/proc.5:2222
9903 msgid "(1) Time spent in user mode."
9907 #: build/C/man5/proc.5:2222
9913 #: build/C/man5/proc.5:2225
9914 msgid "(2) Time spent in user mode with low priority (nice)."
9918 #: build/C/man5/proc.5:2225
9924 #: build/C/man5/proc.5:2228
9925 msgid "(3) Time spent in system mode."
9929 #: build/C/man5/proc.5:2228
9934 #. FIXME Actually, the following info about the /proc/stat 'cpu' field
9935 #. does not seem to be quite right (at least in 2.6.12 or 3.6):
9936 #. the idle time in /proc/uptime does not quite match this value
9938 #: build/C/man5/proc.5:2238
9940 "(4) Time spent in the idle task. This value should be USER_HZ times the "
9941 "second entry in the I</proc/uptime> pseudo-file."
9945 #: build/C/man5/proc.5:2238
9947 msgid "I<iowait> (since Linux 2.5.41)"
9951 #: build/C/man5/proc.5:2241
9952 msgid "(5) Time waiting for I/O to complete."
9956 #: build/C/man5/proc.5:2241
9958 msgid "I<irq> (since Linux 2.6.0-test4)"
9962 #: build/C/man5/proc.5:2244
9963 msgid "(6) Time servicing interrupts."
9967 #: build/C/man5/proc.5:2244
9969 msgid "I<softirq> (since Linux 2.6.0-test4)"
9973 #: build/C/man5/proc.5:2247
9974 msgid "(7) Time servicing softirqs."
9978 #: build/C/man5/proc.5:2247
9980 msgid "I<steal> (since Linux 2.6.11)"
9984 #: build/C/man5/proc.5:2251
9986 "(8) Stolen time, which is the time spent in other operating systems when "
9987 "running in a virtualized environment"
9991 #: build/C/man5/proc.5:2251
9993 msgid "I<guest> (since Linux 2.6.24)"
9996 #. See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de
9998 #: build/C/man5/proc.5:2256
10000 "(9) Time spent running a virtual CPU for guest operating systems under the "
10001 "control of the Linux kernel."
10005 #: build/C/man5/proc.5:2256
10007 msgid "I<guest_nice> (since Linux 2.6.33)"
10010 #. commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797
10011 #. type: Plain text
10012 #: build/C/man5/proc.5:2261
10014 "(10) Time spent running a niced guest (virtual CPU for guest operating "
10015 "systems under the control of the Linux kernel)."
10019 #: build/C/man5/proc.5:2262
10021 msgid "I<page 5741 1808>"
10024 #. type: Plain text
10025 #: build/C/man5/proc.5:2266
10027 "The number of pages the system paged in and the number that were paged out "
10032 #: build/C/man5/proc.5:2266
10034 msgid "I<swap 1 0>"
10037 #. type: Plain text
10038 #: build/C/man5/proc.5:2269
10039 msgid "The number of swap pages that have been brought in and out."
10042 #. FIXME The following is not the full picture for the 'intr' of
10043 #. /proc/stat on 2.6:
10045 #: build/C/man5/proc.5:2269
10047 msgid "I<intr 1462898>"
10050 #. type: Plain text
10051 #: build/C/man5/proc.5:2277
10053 "This line shows counts of interrupts serviced since boot time, for each of "
10054 "the possible system interrupts. The first column is the total of all "
10055 "interrupts serviced; each subsequent column is the total for a particular "
10060 #: build/C/man5/proc.5:2277
10062 msgid "I<disk_io: (2,0):(31,30,5764,1,2) (3,0):>..."
10065 #. type: Plain text
10066 #: build/C/man5/proc.5:2280
10068 "(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, "
10072 #. type: Plain text
10073 #: build/C/man5/proc.5:2282
10074 msgid "(Linux 2.4 only)"
10078 #: build/C/man5/proc.5:2282
10080 msgid "I<ctxt 115315>"
10083 #. type: Plain text
10084 #: build/C/man5/proc.5:2285
10085 msgid "The number of context switches that the system underwent."
10089 #: build/C/man5/proc.5:2285
10091 msgid "I<btime 769041601>"
10094 #. type: Plain text
10095 #: build/C/man5/proc.5:2288
10096 msgid "boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
10100 #: build/C/man5/proc.5:2288
10102 msgid "I<processes 86031>"
10105 #. type: Plain text
10106 #: build/C/man5/proc.5:2291
10107 msgid "Number of forks since boot."
10111 #: build/C/man5/proc.5:2291
10113 msgid "I<procs_running 6>"
10116 #. type: Plain text
10117 #: build/C/man5/proc.5:2295
10118 msgid "Number of processes in runnable state. (Linux 2.5.45 onward.)"
10122 #: build/C/man5/proc.5:2295
10124 msgid "I<procs_blocked 2>"
10127 #. type: Plain text
10128 #: build/C/man5/proc.5:2299
10130 "Number of processes blocked waiting for I/O to complete. (Linux 2.5.45 "
10135 #: build/C/man5/proc.5:2300
10137 msgid "I</proc/swaps>"
10140 #. type: Plain text
10141 #: build/C/man5/proc.5:2305
10142 msgid "Swap areas in use. See also B<swapon>(8)."
10146 #: build/C/man5/proc.5:2305
10148 msgid "I</proc/sys>"
10151 #. type: Plain text
10152 #: build/C/man5/proc.5:2313
10154 "This directory (present since 1.3.57) contains a number of files and "
10155 "subdirectories corresponding to kernel variables. These variables can be "
10156 "read and sometimes modified using the I</proc> file system, and the "
10157 "(deprecated) B<sysctl>(2) system call."
10161 #: build/C/man5/proc.5:2313
10163 msgid "I</proc/sys/abi> (since Linux 2.4.10)"
10166 #. On some systems, it is not present.
10167 #. type: Plain text
10168 #: build/C/man5/proc.5:2320
10170 "This directory may contain files with application binary information. See "
10171 "the Linux kernel source file I<Documentation/sysctl/abi.txt> for more "
10176 #: build/C/man5/proc.5:2320
10178 msgid "I</proc/sys/debug>"
10181 #. type: Plain text
10182 #: build/C/man5/proc.5:2323 build/C/man5/proc.5:3163
10183 msgid "This directory may be empty."
10187 #: build/C/man5/proc.5:2323
10189 msgid "I</proc/sys/dev>"
10192 #. type: Plain text
10193 #: build/C/man5/proc.5:2329
10195 "This directory contains device-specific information (e.g., "
10196 "I<dev/cdrom/info>). On some systems, it may be empty."
10200 #: build/C/man5/proc.5:2329
10202 msgid "I</proc/sys/fs>"
10205 #. type: Plain text
10206 #: build/C/man5/proc.5:2333
10208 "This directory contains the files and subdirectories for kernel variables "
10209 "related to file systems."
10213 #: build/C/man5/proc.5:2333
10215 msgid "I</proc/sys/fs/binfmt_misc>"
10218 #. type: Plain text
10219 #: build/C/man5/proc.5:2338
10221 "Documentation for files in this directory can be found in the Linux kernel "
10222 "sources in I<Documentation/binfmt_misc.txt>."
10226 #: build/C/man5/proc.5:2338
10228 msgid "I</proc/sys/fs/dentry-state> (since Linux 2.2)"
10231 #. type: Plain text
10232 #: build/C/man5/proc.5:2346
10234 "This file contains information about the status of the directory cache "
10235 "(dcache). The file contains six numbers, I<nr_dentry>, I<nr_unused>, "
10236 "I<age_limit> (age in seconds), I<want_pages> (pages requested by system) and "
10237 "two dummy values."
10240 #. type: Plain text
10241 #: build/C/man5/proc.5:2351
10243 "I<nr_dentry> is the number of allocated dentries (dcache entries). This "
10244 "field is unused in Linux 2.2."
10247 #. type: Plain text
10248 #: build/C/man5/proc.5:2354
10249 msgid "I<nr_unused> is the number of unused dentries."
10252 #. looks like this is unused in kernels 2.2 to 2.6
10253 #. type: Plain text
10254 #: build/C/man5/proc.5:2359
10256 "I<age_limit> is the age in seconds after which dcache entries can be "
10257 "reclaimed when memory is short."
10260 #. looks like this is unused in kernels 2.2 to 2.6
10261 #. type: Plain text
10262 #: build/C/man5/proc.5:2364
10264 "I<want_pages> is nonzero when the kernel has called shrink_dcache_pages() "
10265 "and the dcache isn't pruned yet."
10269 #: build/C/man5/proc.5:2365
10271 msgid "I</proc/sys/fs/dir-notify-enable>"
10274 #. type: Plain text
10275 #: build/C/man5/proc.5:2374
10277 "This file can be used to disable or enable the I<dnotify> interface "
10278 "described in B<fcntl>(2) on a system-wide basis. A value of 0 in this file "
10279 "disables the interface, and a value of 1 enables it."
10283 #: build/C/man5/proc.5:2374
10285 msgid "I</proc/sys/fs/dquot-max>"
10288 #. type: Plain text
10289 #: build/C/man5/proc.5:2381
10291 "This file shows the maximum number of cached disk quota entries. On some "
10292 "(2.4) systems, it is not present. If the number of free cached disk quota "
10293 "entries is very low and you have some awesome number of simultaneous system "
10294 "users, you might want to raise the limit."
10298 #: build/C/man5/proc.5:2381
10300 msgid "I</proc/sys/fs/dquot-nr>"
10303 #. type: Plain text
10304 #: build/C/man5/proc.5:2385
10306 "This file shows the number of allocated disk quota entries and the number of "
10307 "free disk quota entries."
10311 #: build/C/man5/proc.5:2385
10313 msgid "I</proc/sys/fs/epoll> (since Linux 2.6.28)"
10316 #. type: Plain text
10317 #: build/C/man5/proc.5:2394
10319 "This directory contains the file I<max_user_watches>, which can be used to "
10320 "limit the amount of kernel memory consumed by the I<epoll> interface. For "
10321 "further details, see B<epoll>(7)."
10325 #: build/C/man5/proc.5:2394
10327 msgid "I</proc/sys/fs/file-max>"
10330 #. type: Plain text
10331 #: build/C/man5/proc.5:2407
10333 "This file defines a system-wide limit on the number of open files for all "
10334 "processes. (See also B<setrlimit>(2), which can be used by a process to set "
10335 "the per-process limit, B<RLIMIT_NOFILE>, on the number of files it may "
10336 "open.) If you get lots of error messages in the kernel log about running "
10337 "out of file handles (look for \"VFS: file-max limit E<lt>numberE<gt> "
10338 "reached\"), try increasing this value:"
10341 #. type: Plain text
10342 #: build/C/man5/proc.5:2413
10344 msgid "CW< echo 100000 E<gt> /proc/sys/fs/file-max>\n"
10347 #. type: Plain text
10348 #: build/C/man5/proc.5:2420
10350 "The kernel constant B<NR_OPEN> imposes an upper limit on the value that may "
10351 "be placed in I<file-max>."
10354 #. type: Plain text
10355 #: build/C/man5/proc.5:2429
10357 "If you increase I</proc/sys/fs/file-max>, be sure to increase "
10358 "I</proc/sys/fs/inode-max> to 3-4 times the new value of "
10359 "I</proc/sys/fs/file-max>, or you will run out of inodes."
10362 #. type: Plain text
10363 #: build/C/man5/proc.5:2435
10364 msgid "Privileged processes (B<CAP_SYS_ADMIN>) can override the I<file-max> limit."
10368 #: build/C/man5/proc.5:2435
10370 msgid "I</proc/sys/fs/file-nr>"
10373 #. type: Plain text
10374 #: build/C/man5/proc.5:2454
10376 "This (read-only) file contains three numbers: the number of allocated file "
10377 "handles (i.e., the number of files presently opened); the number of free "
10378 "file handles; and the maximum number of file handles (i.e., the same value "
10379 "as I</proc/sys/fs/file-max>). If the number of allocated file handles is "
10380 "close to the maximum, you should consider increasing the maximum. Before "
10381 "Linux 2.6, the kernel allocated file handles dynamically, but it didn't free "
10382 "them again. Instead the free file handles were kept in a list for "
10383 "reallocation; the \"free file handles\" value indicates the size of that "
10384 "list. A large number of free file handles indicates that there was a past "
10385 "peak in the usage of open file handles. Since Linux 2.6, the kernel does "
10386 "deallocate freed file handles, and the \"free file handles\" value is always "
10391 #: build/C/man5/proc.5:2454
10393 msgid "I</proc/sys/fs/inode-max>"
10396 #. type: Plain text
10397 #: build/C/man5/proc.5:2464
10399 "This file contains the maximum number of in-memory inodes. On some (2.4) "
10400 "systems, it may not be present. This value should be 3-4 times larger than "
10401 "the value in I<file-max>, since I<stdin>, I<stdout> and network sockets also "
10402 "need an inode to handle them. When you regularly run out of inodes, you "
10403 "need to increase this value."
10407 #: build/C/man5/proc.5:2464
10409 msgid "I</proc/sys/fs/inode-nr>"
10412 #. type: Plain text
10413 #: build/C/man5/proc.5:2468
10414 msgid "This file contains the first two values from I<inode-state>."
10418 #: build/C/man5/proc.5:2468
10420 msgid "I</proc/sys/fs/inode-state>"
10423 #. type: Plain text
10424 #: build/C/man5/proc.5:2489
10426 "This file contains seven numbers: I<nr_inodes>, I<nr_free_inodes>, "
10427 "I<preshrink>, and four dummy values. I<nr_inodes> is the number of inodes "
10428 "the system has allocated. This can be slightly more than I<inode-max> "
10429 "because Linux allocates them one page full at a time. I<nr_free_inodes> "
10430 "represents the number of free inodes. I<preshrink> is nonzero when the "
10431 "I<nr_inodes> E<gt> I<inode-max> and the system needs to prune the inode list "
10432 "instead of allocating more."
10436 #: build/C/man5/proc.5:2489
10438 msgid "I</proc/sys/fs/inotify> (since Linux 2.6.13)"
10441 #. type: Plain text
10442 #: build/C/man5/proc.5:2498
10444 "This directory contains files I<max_queued_events>, I<max_user_instances>, "
10445 "and I<max_user_watches>, that can be used to limit the amount of kernel "
10446 "memory consumed by the I<inotify> interface. For further details, see "
10451 #: build/C/man5/proc.5:2498
10453 msgid "I</proc/sys/fs/lease-break-time>"
10456 #. type: Plain text
10457 #: build/C/man5/proc.5:2507
10459 "This file specifies the grace period that the kernel grants to a process "
10460 "holding a file lease (B<fcntl>(2)) after it has sent a signal to that "
10461 "process notifying it that another process is waiting to open the file. If "
10462 "the lease holder does not remove or downgrade the lease within this grace "
10463 "period, the kernel forcibly breaks the lease."
10467 #: build/C/man5/proc.5:2507
10469 msgid "I</proc/sys/fs/leases-enable>"
10472 #. type: Plain text
10473 #: build/C/man5/proc.5:2514
10475 "This file can be used to enable or disable file leases (B<fcntl>(2)) on a "
10476 "system-wide basis. If this file contains the value 0, leases are disabled. "
10477 "A nonzero value enables leases."
10481 #: build/C/man5/proc.5:2514
10483 msgid "I</proc/sys/fs/mqueue> (since Linux 2.6.6)"
10486 #. type: Plain text
10487 #: build/C/man5/proc.5:2522
10489 "This directory contains files I<msg_max>, I<msgsize_max>, and I<queues_max>, "
10490 "controlling the resources used by POSIX message queues. See "
10491 "B<mq_overview>(7) for details."
10495 #: build/C/man5/proc.5:2522
10497 msgid "I</proc/sys/fs/overflowgid> and I</proc/sys/fs/overflowuid>"
10500 #. type: Plain text
10501 #: build/C/man5/proc.5:2532
10503 "These files allow you to change the value of the fixed UID and GID. The "
10504 "default is 65534. Some file systems support only 16-bit UIDs and GIDs, "
10505 "although in Linux UIDs and GIDs are 32 bits. When one of these file systems "
10506 "is mounted with writes enabled, any UID or GID that would exceed 65535 is "
10507 "translated to the overflow value before being written to disk."
10511 #: build/C/man5/proc.5:2532
10513 msgid "I</proc/sys/fs/pipe-max-size> (since Linux 2.6.35)"
10516 #. type: Plain text
10517 #: build/C/man5/proc.5:2546
10519 "The value in this file defines an upper limit for raising the capacity of a "
10520 "pipe using the B<fcntl>(2) B<F_SETPIPE_SZ> operation. This limit applies "
10521 "only to unprivileged processes. The default value for this file is "
10522 "1,048,576. The value assigned to this file may be rounded upward, to "
10523 "reflect the value actually employed for a convenient implementation. To "
10524 "determine the rounded-up value, display the contents of this file after "
10525 "assigning a value to it. The minimum value that can be assigned to this "
10526 "file is the system page size."
10530 #: build/C/man5/proc.5:2546
10532 msgid "I</proc/sys/fs/protected_hardlinks> (since Linux 3.6)"
10535 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
10536 #. type: Plain text
10537 #: build/C/man5/proc.5:2555
10539 "When the value in this file is 0, no restrictions are placed on the creation "
10540 "of hard links (i.e., this is the historical behaviour before Linux 3.6). "
10541 "When the value in this file is 1, a hard link can be created to a target "
10542 "file only if one of the following conditions is true:"
10545 #. type: Plain text
10546 #: build/C/man5/proc.5:2560
10547 msgid "The caller has the B<CAP_FOWNER> capability."
10550 #. type: Plain text
10551 #: build/C/man5/proc.5:2566
10553 "The file system UID of the process creating the link matches the owner (UID) "
10554 "of the target file (as described in B<credentials>(7), a process's file "
10555 "system UID is normally the same as its effective UID)."
10558 #. type: Plain text
10559 #: build/C/man5/proc.5:2568
10560 msgid "All of the following conditions are true:"
10563 #. type: Plain text
10564 #: build/C/man5/proc.5:2571
10565 msgid "the target is a regular file;"
10568 #. type: Plain text
10569 #: build/C/man5/proc.5:2573
10570 msgid "the target file does not have its set-user-ID permission bit enabled;"
10573 #. type: Plain text
10574 #: build/C/man5/proc.5:2576
10576 "the target file does not have both its set-group-ID and group-executable "
10577 "permission bits enabled; and"
10580 #. type: Plain text
10581 #: build/C/man5/proc.5:2580
10583 "the caller has permission to read and write the target file (either via the "
10584 "file's permissions mask or because it has suitable capabilities)."
10587 #. type: Plain text
10588 #: build/C/man5/proc.5:2596
10590 "The default value in this file is 0. Setting the value to 1 prevents a "
10591 "longstanding class of security issues caused by hard-link-based "
10592 "time-of-check, time-of-use races, most commonly seen in world-writable "
10593 "directories such as I</tmp>. The common method of exploiting this flaw is "
10594 "to cross privilege boundaries when following a given hard link (i.e., a root "
10595 "process follows a hard link created by another user). Additionally, on "
10596 "systems without separated partitions, this stops unauthorized users from "
10597 "\"pinning\" vulnerable set-user-ID and set-group-ID files against being "
10598 "upgraded by the administrator, or linking to special files."
10602 #: build/C/man5/proc.5:2596
10604 msgid "I</proc/sys/fs/protected_symlinks> (since Linux 3.6)"
10607 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
10608 #. type: Plain text
10609 #: build/C/man5/proc.5:2604
10611 "When the value in this file is 0, no restrictions are placed on following "
10612 "symbolic links (i.e., this is the historical behaviour before Linux 3.6). "
10613 "When the value in this file is 1, symbolic links are followed only in the "
10614 "following circumstances:"
10617 #. type: Plain text
10618 #: build/C/man5/proc.5:2611
10620 "the file system UID of the process following the link matches the owner "
10621 "(UID) of the symbolic link (as described in B<credentials>(7), a process's "
10622 "file system UID is normally the same as its effective UID);"
10625 #. type: Plain text
10626 #: build/C/man5/proc.5:2613
10627 msgid "the link is not in a sticky world-writable directory; or"
10630 #. type: Plain text
10631 #: build/C/man5/proc.5:2615
10632 msgid "the symbolic link and and its parent directory have the same owner (UID)"
10635 #. type: Plain text
10636 #: build/C/man5/proc.5:2622
10638 "A system call that fails to follow a symbolic link because of the above "
10639 "restrictions returns the error B<EACCES> in I<errno>."
10642 #. type: Plain text
10643 #: build/C/man5/proc.5:2626
10645 "The default value in this file is 0. Setting the value to 1 avoids a "
10646 "longstanding class of security issues based on time-of-check, time-of-use "
10647 "races when accessing symbolic links."
10651 #: build/C/man5/proc.5:2626
10653 msgid "I</proc/sys/fs/suid_dumpable> (since Linux 2.6.13)"
10656 #. The following is based on text from Documentation/sysctl/kernel.txt
10657 #. type: Plain text
10658 #: build/C/man5/proc.5:2632
10660 "The value in this file determines whether core dump files are produced for "
10661 "set-user-ID or otherwise protected/tainted binaries. Three different "
10662 "integer values can be specified:"
10666 #: build/C/man5/proc.5:2633
10668 msgid "I<0\\ (default)>"
10671 #. type: Plain text
10672 #: build/C/man5/proc.5:2642
10674 "This provides the traditional (pre-Linux 2.6.13) behavior. A core dump will "
10675 "not be produced for a process which has changed credentials (by calling "
10676 "B<seteuid>(2), B<setgid>(2), or similar, or by executing a set-user-ID or "
10677 "set-group-ID program) or whose binary does not have read permission "
10682 #: build/C/man5/proc.5:2642
10684 msgid "I<1\\ (\"debug\")>"
10687 #. type: Plain text
10688 #: build/C/man5/proc.5:2649
10690 "All processes dump core when possible. The core dump is owned by the file "
10691 "system user ID of the dumping process and no security is applied. This is "
10692 "intended for system debugging situations only. Ptrace is unchecked."
10696 #: build/C/man5/proc.5:2649
10698 msgid "I<2\\ (\"suidsafe\")>"
10701 #. type: Plain text
10702 #: build/C/man5/proc.5:2658
10704 "Any binary which normally would not be dumped (see \"0\" above) is dumped "
10705 "readable by root only. This allows the user to remove the core dump file "
10706 "but not to read it. For security reasons core dumps in this mode will not "
10707 "overwrite one another or other files. This mode is appropriate when "
10708 "administrators are attempting to debug problems in a normal environment."
10711 #. 9520628e8ceb69fa9a4aee6b57f22675d9e1b709
10712 #. 54b501992dd2a839e94e76aa392c392b55080ce8
10713 #. type: Plain text
10714 #: build/C/man5/proc.5:2669
10716 "Additionally, since Linux 3.6, I</proc/sys/kernel/core_pattern> must either "
10717 "be an absolute pathname or a pipe command, as detailed in B<core>(5). "
10718 "Warnings will be written to the kernel log if I<core_pattern> does not "
10719 "follow these rules, and no core dump will be produced."
10723 #: build/C/man5/proc.5:2670
10725 msgid "I</proc/sys/fs/super-max>"
10728 #. type: Plain text
10729 #: build/C/man5/proc.5:2681
10731 "This file controls the maximum number of superblocks, and thus the maximum "
10732 "number of mounted file systems the kernel can have. You need increase only "
10733 "I<super-max> if you need to mount more file systems than the current value "
10734 "in I<super-max> allows you to."
10738 #: build/C/man5/proc.5:2681
10740 msgid "I</proc/sys/fs/super-nr>"
10743 #. type: Plain text
10744 #: build/C/man5/proc.5:2685
10745 msgid "This file contains the number of file systems currently mounted."
10749 #: build/C/man5/proc.5:2685
10751 msgid "I</proc/sys/kernel>"
10754 #. type: Plain text
10755 #: build/C/man5/proc.5:2689
10757 "This directory contains files controlling a range of kernel parameters, as "
10762 #: build/C/man5/proc.5:2689
10764 msgid "I</proc/sys/kernel/acct>"
10767 #. type: Plain text
10768 #: build/C/man5/proc.5:2713
10770 "This file contains three numbers: I<highwater>, I<lowwater>, and "
10771 "I<frequency>. If BSD-style process accounting is enabled these values "
10772 "control its behavior. If free space on file system where the log lives goes "
10773 "below I<lowwater> percent accounting suspends. If free space gets above "
10774 "I<highwater> percent accounting resumes. I<frequency> determines how often "
10775 "the kernel checks the amount of free space (value is in seconds). Default "
10776 "values are 4, 2 and 30. That is, suspend accounting if 2% or less space is "
10777 "free; resume it if 4% or more space is free; consider information about "
10778 "amount of free space valid for 30 seconds."
10782 #: build/C/man5/proc.5:2713
10784 msgid "I</proc/sys/kernel/cap_last_cap> (since Linux 3.2)"
10787 #. type: Plain text
10788 #: build/C/man5/proc.5:2717
10789 msgid "See B<capabilities>(7)."
10793 #: build/C/man5/proc.5:2717
10795 msgid "I</proc/sys/kernel/cap-bound> (from Linux 2.2 to 2.6.24)"
10798 #. type: Plain text
10799 #: build/C/man5/proc.5:2729
10801 "This file holds the value of the kernel I<capability bounding set> "
10802 "(expressed as a signed decimal number). This set is ANDed against the "
10803 "capabilities permitted to a process during B<execve>(2). Starting with "
10804 "Linux 2.6.25, the system-wide capability bounding set disappeared, and was "
10805 "replaced by a per-thread bounding set; see B<capabilities>(7)."
10809 #: build/C/man5/proc.5:2729
10811 msgid "I</proc/sys/kernel/core_pattern>"
10815 #: build/C/man5/proc.5:2733
10817 msgid "I</proc/sys/kernel/core_uses_pid>"
10821 #: build/C/man5/proc.5:2737
10823 msgid "I</proc/sys/kernel/ctrl-alt-del>"
10826 #. type: Plain text
10827 #: build/C/man5/proc.5:2752
10829 "This file controls the handling of Ctrl-Alt-Del from the keyboard. When the "
10830 "value in this file is 0, Ctrl-Alt-Del is trapped and sent to the B<init>(8) "
10831 "program to handle a graceful restart. When the value is greater than zero, "
10832 "Linux's reaction to a Vulcan Nerve Pinch (tm) will be an immediate reboot, "
10833 "without even syncing its dirty buffers. Note: when a program (like dosemu) "
10834 "has the keyboard in \"raw\" mode, the ctrl-alt-del is intercepted by the "
10835 "program before it ever reaches the kernel tty layer, and it's up to the "
10836 "program to decide what to do with it."
10840 #: build/C/man5/proc.5:2752
10842 msgid "I</proc/sys/kernel/dmesg_restrict> (since Linux 2.6.37)"
10845 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
10846 #. type: Plain text
10847 #: build/C/man5/proc.5:2765
10849 "The value in this file determines who can see kernel syslog contents. A "
10850 "value of 0 in this file imposes no restrictions. If the value is 1, only "
10851 "privileged users can read the kernel syslog. (See B<syslog>(2) for more "
10852 "details.) Since Linux 3.4, only users with the B<CAP_SYS_ADMIN> capability "
10853 "may change the value in this file."
10857 #: build/C/man5/proc.5:2765
10859 msgid "I</proc/sys/kernel/domainname> and I</proc/sys/kernel/hostname>"
10862 #. type: Plain text
10863 #: build/C/man5/proc.5:2773
10865 "can be used to set the NIS/YP domainname and the hostname of your box in "
10866 "exactly the same way as the commands B<domainname>(1) and B<hostname>(1), "
10870 #. type: Plain text
10871 #: build/C/man5/proc.5:2778
10874 "#B< echo \\(aqdarkstar\\(aq E<gt> /proc/sys/kernel/hostname>\n"
10875 "#B< echo \\(aqmydomain\\(aq E<gt> /proc/sys/kernel/domainname>\n"
10878 #. type: Plain text
10879 #: build/C/man5/proc.5:2782
10880 msgid "has the same effect as"
10883 #. type: Plain text
10884 #: build/C/man5/proc.5:2787
10887 "#B< hostname \\(aqdarkstar\\(aq>\n"
10888 "#B< domainname \\(aqmydomain\\(aq>\n"
10891 #. type: Plain text
10892 #: build/C/man5/proc.5:2800
10894 "Note, however, that the classic darkstar.frop.org has the hostname "
10895 "\"darkstar\" and DNS (Internet Domain Name Server) domainname \"frop.org\", "
10896 "not to be confused with the NIS (Network Information Service) or YP (Yellow "
10897 "Pages) domainname. These two domain names are in general different. For a "
10898 "detailed discussion see the B<hostname>(1) man page."
10902 #: build/C/man5/proc.5:2800
10904 msgid "I</proc/sys/kernel/hotplug>"
10907 #. type: Plain text
10908 #: build/C/man5/proc.5:2806
10910 "This file contains the path for the hotplug policy agent. The default value "
10911 "in this file is I</sbin/hotplug>."
10915 #: build/C/man5/proc.5:2806
10917 msgid "I</proc/sys/kernel/htab-reclaim>"
10920 #. type: Plain text
10921 #: build/C/man5/proc.5:2814
10923 "(PowerPC only) If this file is set to a nonzero value, the PowerPC htab (see "
10924 "kernel file I<Documentation/powerpc/ppc_htab.txt>) is pruned each time the "
10925 "system hits the idle loop."
10929 #: build/C/man5/proc.5:2814
10931 msgid "I</proc/sys/kernel/kptr_restrict> (since Linux 2.6.38)"
10934 #. 455cd5ab305c90ffc422dd2e0fb634730942b257
10935 #. commit 411f05f123cbd7f8aa1edcae86970755a6e2a9d9
10936 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
10937 #. type: Plain text
10938 #: build/C/man5/proc.5:2839
10940 "The value in this file determines whether kernel addresses are exposed via "
10941 "I</proc> files and other interfaces. A value of 0 in this file imposes no "
10942 "restrictions. If the value is 1, kernel pointers printed using the I<%pK> "
10943 "format specifier will be replaced with zeros unless the user has the "
10944 "B<CAP_SYSLOG> capability. If the value is 2, kernel pointers printed using "
10945 "the I<%pK> format specifier will be replaced with zeros regardless of the "
10946 "user's capabilities. The initial default value for this file was 1, but the "
10947 "default was changed to 0 in Linux 2.6.39. Since Linux 3.4, only users with "
10948 "the B<CAP_SYS_ADMIN> capability can change the value in this file."
10952 #: build/C/man5/proc.5:2839
10954 msgid "I</proc/sys/kernel/l2cr>"
10957 #. type: Plain text
10958 #: build/C/man5/proc.5:2846
10960 "(PowerPC only) This file contains a flag that controls the L2 cache of G3 "
10961 "processor boards. If 0, the cache is disabled. Enabled if nonzero."
10965 #: build/C/man5/proc.5:2846
10967 msgid "I</proc/sys/kernel/modprobe>"
10970 #. type: Plain text
10971 #: build/C/man5/proc.5:2859
10973 "This file contains the path for the kernel module loader. The default value "
10974 "is I</sbin/modprobe>. The file is present only if the kernel is built with "
10975 "the B<CONFIG_MODULES> (B<CONFIG_KMOD> in Linux 2.6.26 and earlier) option "
10976 "enabled. It is described by the Linux kernel source file "
10977 "I<Documentation/kmod.txt> (present only in kernel 2.4 and earlier)."
10981 #: build/C/man5/proc.5:2859
10983 msgid "I</proc/sys/kernel/modules_disabled> (since Linux 2.6.31)"
10986 #. 3d43321b7015387cfebbe26436d0e9d299162ea1
10987 #. From Documentation/sysctl/kernel.txt
10988 #. type: Plain text
10989 #: build/C/man5/proc.5:2871
10991 "A toggle value indicating if modules are allowed to be loaded in an "
10992 "otherwise modular kernel. This toggle defaults to off (0), but can be set "
10993 "true (1). Once true, modules can be neither loaded nor unloaded, and the "
10994 "toggle cannot be set back to false. The file is present only if the kernel "
10995 "is built with the B<CONFIG_MODULES> option enabled."
10999 #: build/C/man5/proc.5:2871
11001 msgid "I</proc/sys/kernel/msgmax>"
11004 #. type: Plain text
11005 #: build/C/man5/proc.5:2876
11007 "This file defines a system-wide limit specifying the maximum number of bytes "
11008 "in a single message written on a System V message queue."
11012 #: build/C/man5/proc.5:2876
11014 msgid "I</proc/sys/kernel/msgmni> (since Linux 2.4)"
11017 #. type: Plain text
11018 #: build/C/man5/proc.5:2880
11020 "This file defines the system-wide limit on the number of message queue "
11025 #: build/C/man5/proc.5:2880
11027 msgid "I</proc/sys/kernel/msgmnb>"
11030 #. type: Plain text
11031 #: build/C/man5/proc.5:2889
11033 "This file defines a system-wide parameter used to initialize the "
11034 "I<msg_qbytes> setting for subsequently created message queues. The "
11035 "I<msg_qbytes> setting specifies the maximum number of bytes that may be "
11036 "written to the message queue."
11040 #: build/C/man5/proc.5:2889
11042 msgid "I</proc/sys/kernel/ostype> and I</proc/sys/kernel/osrelease>"
11045 #. type: Plain text
11046 #: build/C/man5/proc.5:2894
11047 msgid "These files give substrings of I</proc/version>."
11051 #: build/C/man5/proc.5:2894
11053 msgid "I</proc/sys/kernel/overflowgid> and I</proc/sys/kernel/overflowuid>"
11056 #. type: Plain text
11057 #: build/C/man5/proc.5:2900
11059 "These files duplicate the files I</proc/sys/fs/overflowgid> and "
11060 "I</proc/sys/fs/overflowuid>."
11064 #: build/C/man5/proc.5:2900
11066 msgid "I</proc/sys/kernel/panic>"
11069 #. type: Plain text
11070 #: build/C/man5/proc.5:2909
11072 "This file gives read/write access to the kernel variable I<panic_timeout>. "
11073 "If this is zero, the kernel will loop on a panic; if nonzero it indicates "
11074 "that the kernel should autoreboot after this number of seconds. When you "
11075 "use the software watchdog device driver, the recommended setting is 60."
11079 #: build/C/man5/proc.5:2909
11081 msgid "I</proc/sys/kernel/panic_on_oops> (since Linux 2.5.68)"
11084 #. type: Plain text
11085 #: build/C/man5/proc.5:2921
11087 "This file controls the kernel's behavior when an oops or BUG is "
11088 "encountered. If this file contains 0, then the system tries to continue "
11089 "operation. If it contains 1, then the system delays a few seconds (to give "
11090 "klogd time to record the oops output) and then panics. If the "
11091 "I</proc/sys/kernel/panic> file is also nonzero then the machine will be "
11096 #: build/C/man5/proc.5:2921
11098 msgid "I</proc/sys/kernel/pid_max> (since Linux 2.5.34)"
11101 #. Prior to 2.6.10, pid_max could also be raised above 32768 on 32-bit
11102 #. platforms, but this broke /proc/[pid]
11103 #. See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2
11104 #. type: Plain text
11105 #: build/C/man5/proc.5:2937
11107 "This file specifies the value at which PIDs wrap around (i.e., the value in "
11108 "this file is one greater than the maximum PID). The default value for this "
11109 "file, 32768, results in the same range of PIDs as on earlier kernels. On "
11110 "32-bit platforms, 32768 is the maximum value for I<pid_max>. On 64-bit "
11111 "systems, I<pid_max> can be set to any value up to 2^22 (B<PID_MAX_LIMIT>, "
11112 "approximately 4 million)."
11116 #: build/C/man5/proc.5:2937
11118 msgid "I</proc/sys/kernel/powersave-nap> (PowerPC only)"
11121 #. type: Plain text
11122 #: build/C/man5/proc.5:2943
11124 "This file contains a flag. If set, Linux-PPC will use the \"nap\" mode of "
11125 "powersaving, otherwise the \"doze\" mode will be used."
11129 #: build/C/man5/proc.5:2943
11131 msgid "I</proc/sys/kernel/printk>"
11134 #. type: Plain text
11135 #: build/C/man5/proc.5:2969
11137 "The four values in this file are I<console_loglevel>, "
11138 "I<default_message_loglevel>, I<minimum_console_level>, and "
11139 "I<default_console_loglevel>. These values influence I<printk()> behavior "
11140 "when printing or logging error messages. See B<syslog>(2) for more info on "
11141 "the different loglevels. Messages with a higher priority than "
11142 "I<console_loglevel> will be printed to the console. Messages without an "
11143 "explicit priority will be printed with priority I<default_message_level>. "
11144 "I<minimum_console_loglevel> is the minimum (highest) value to which "
11145 "I<console_loglevel> can be set. I<default_console_loglevel> is the default "
11146 "value for I<console_loglevel>."
11150 #: build/C/man5/proc.5:2969
11152 msgid "I</proc/sys/kernel/pty> (since Linux 2.6.4)"
11155 #. type: Plain text
11156 #: build/C/man5/proc.5:2975
11158 "This directory contains two files relating to the number of UNIX 98 "
11159 "pseudoterminals (see B<pts>(4)) on the system."
11163 #: build/C/man5/proc.5:2975
11165 msgid "I</proc/sys/kernel/pty/max>"
11168 #. type: Plain text
11169 #: build/C/man5/proc.5:2978
11170 msgid "This file defines the maximum number of pseudoterminals."
11174 #: build/C/man5/proc.5:2978
11176 msgid "I</proc/sys/kernel/pty/nr>"
11179 #. type: Plain text
11180 #: build/C/man5/proc.5:2982
11181 msgid "This read-only file indicates how many pseudoterminals are currently in use."
11185 #: build/C/man5/proc.5:2982
11187 msgid "I</proc/sys/kernel/random>"
11190 #. type: Plain text
11191 #: build/C/man5/proc.5:2990
11193 "This directory contains various parameters controlling the operation of the "
11194 "file I</dev/random>. See B<random>(4) for further information."
11198 #: build/C/man5/proc.5:2990
11200 msgid "I</proc/sys/kernel/real-root-dev>"
11203 #. type: Plain text
11204 #: build/C/man5/proc.5:2994
11206 "This file is documented in the Linux kernel source file "
11207 "I<Documentation/initrd.txt>."
11211 #: build/C/man5/proc.5:2994
11213 msgid "I</proc/sys/kernel/reboot-cmd> (Sparc only) "
11216 #. type: Plain text
11217 #: build/C/man5/proc.5:3000
11219 "This file seems to be a way to give an argument to the SPARC ROM/Flash boot "
11220 "loader. Maybe to tell it what to do after rebooting?"
11224 #: build/C/man5/proc.5:3000
11226 msgid "I</proc/sys/kernel/rtsig-max>"
11229 #. type: Plain text
11230 #: build/C/man5/proc.5:3007
11232 "(Only in kernels up to and including 2.6.7; see B<setrlimit>(2)) This file "
11233 "can be used to tune the maximum number of POSIX real-time (queued) signals "
11234 "that can be outstanding in the system."
11238 #: build/C/man5/proc.5:3007
11240 msgid "I</proc/sys/kernel/rtsig-nr>"
11243 #. type: Plain text
11244 #: build/C/man5/proc.5:3011
11246 "(Only in kernels up to and including 2.6.7.) This file shows the number "
11247 "POSIX real-time signals currently queued."
11251 #: build/C/man5/proc.5:3011
11253 msgid "I</proc/sys/kernel/sched_rr_timeslice_ms> (since Linux 3.9)"
11256 #. type: Plain text
11257 #: build/C/man5/proc.5:3015
11258 msgid "See B<sched_rr_get_interval>(2)."
11262 #: build/C/man5/proc.5:3015
11264 msgid "I</proc/sys/kernel/sem> (since Linux 2.4)"
11267 #. type: Plain text
11268 #: build/C/man5/proc.5:3019
11270 "This file contains 4 numbers defining limits for System V IPC semaphores. "
11271 "These fields are, in order:"
11275 #: build/C/man5/proc.5:3020
11280 #. type: Plain text
11281 #: build/C/man5/proc.5:3022
11282 msgid "The maximum semaphores per semaphore set."
11286 #: build/C/man5/proc.5:3022
11291 #. type: Plain text
11292 #: build/C/man5/proc.5:3024
11293 msgid "A system-wide limit on the number of semaphores in all semaphore sets."
11297 #: build/C/man5/proc.5:3024
11302 #. type: Plain text
11303 #: build/C/man5/proc.5:3028
11305 "The maximum number of operations that may be specified in a B<semop>(2) "
11310 #: build/C/man5/proc.5:3028
11315 #. type: Plain text
11316 #: build/C/man5/proc.5:3030
11317 msgid "A system-wide limit on the maximum number of semaphore identifiers."
11321 #: build/C/man5/proc.5:3031
11323 msgid "I</proc/sys/kernel/sg-big-buff>"
11326 #. type: Plain text
11327 #: build/C/man5/proc.5:3042
11329 "This file shows the size of the generic SCSI device (sg) buffer. You can't "
11330 "tune it just yet, but you could change it at compile time by editing "
11331 "I<include/scsi/sg.h> and changing the value of B<SG_BIG_BUFF>. However, "
11332 "there shouldn't be any reason to change this value."
11336 #: build/C/man5/proc.5:3042
11338 msgid "I</proc/sys/kernel/shm_rmid_forced> (since Linux 3.1)"
11341 #. commit b34a6b1da371ed8af1221459a18c67970f7e3d53
11342 #. See also Documentation/sysctl/kernel.txt
11343 #. type: Plain text
11344 #: build/C/man5/proc.5:3051
11346 "If this file is set to 1, all System V shared memory segments will be marked "
11347 "for destruction as soon as the number of attached processes falls to zero; "
11348 "in other words, it is no longer possible to create shared memory segments "
11349 "that exist independently of any attached process."
11352 #. type: Plain text
11353 #: build/C/man5/proc.5:3063
11355 "The effect is as though a B<shmctl>(2) B<IPC_RMID> is performed on all "
11356 "existing segments as well as all segments created in the future (until this "
11357 "file is reset to 0). Note that existing segments that are attached to no "
11358 "process will be immediately destroyed when this file is set to 1. Setting "
11359 "this option will also destroy segments that were created, but never "
11360 "attached, upon termination of the process that created the segment with "
11364 #. type: Plain text
11365 #: build/C/man5/proc.5:3071
11367 "Setting this file to 1 provides a way of ensuring that all System V shared "
11368 "memory segments are counted against the resource usage and resource limits "
11369 "(see the description of B<RLIMIT_AS> in B<getrlimit>(2)) of at least one "
11373 #. type: Plain text
11374 #: build/C/man5/proc.5:3078
11376 "Because setting this file to 1 produces behavior that is nonstandard and "
11377 "could also break existing applications, the default value in this file is "
11378 "0. Only set this file to 1 if you have a good understanding of the "
11379 "semantics of the applications using System V shared memory on your system."
11383 #: build/C/man5/proc.5:3078
11385 msgid "I</proc/sys/kernel/shmall>"
11388 #. type: Plain text
11389 #: build/C/man5/proc.5:3083
11391 "This file contains the system-wide limit on the total number of pages of "
11392 "System V shared memory."
11396 #: build/C/man5/proc.5:3083
11398 msgid "I</proc/sys/kernel/shmmax>"
11401 #. type: Plain text
11402 #: build/C/man5/proc.5:3093
11404 "This file can be used to query and set the run-time limit on the maximum "
11405 "(System V IPC) shared memory segment size that can be created. Shared "
11406 "memory segments up to 1GB are now supported in the kernel. This value "
11407 "defaults to B<SHMMAX>."
11411 #: build/C/man5/proc.5:3093
11413 msgid "I</proc/sys/kernel/shmmni> (since Linux 2.4)"
11416 #. type: Plain text
11417 #: build/C/man5/proc.5:3098
11419 "This file specifies the system-wide maximum number of System V shared memory "
11420 "segments that can be created."
11424 #: build/C/man5/proc.5:3098
11426 msgid "I</proc/sys/kernel/sysrq>"
11429 #. type: Plain text
11430 #: build/C/man5/proc.5:3107
11432 "This file controls the functions allowed to be invoked by the SysRq key. By "
11433 "default, the file contains 1 meaning that every possible SysRq request is "
11434 "allowed (in older kernel versions, SysRq was disabled by default, and you "
11435 "were required to specifically enable it at run-time, but this is not the "
11436 "case any more). Possible values in this file are:"
11439 #. type: Plain text
11440 #: build/C/man5/proc.5:3119
11443 " 0 - disable sysrq completely\n"
11444 " 1 - enable all functions of sysrq\n"
11445 " E<gt>1 - bit mask of allowed sysrq functions, as follows:\n"
11446 " 2 - enable control of console logging level\n"
11447 " 4 - enable control of keyboard (SAK, unraw)\n"
11448 " 8 - enable debugging dumps of processes etc.\n"
11449 " 16 - enable sync command\n"
11450 " 32 - enable remount read-only\n"
11451 " 64 - enable signalling of processes (term, kill, oom-kill)\n"
11452 " 128 - allow reboot/poweroff\n"
11453 " 256 - allow nicing of all real-time tasks\n"
11456 #. type: Plain text
11457 #: build/C/man5/proc.5:3125
11459 "This file is present only if the B<CONFIG_MAGIC_SYSRQ> kernel configuration "
11460 "option is enabled. For further details see the Linux kernel source file "
11461 "I<Documentation/sysrq.txt>."
11465 #: build/C/man5/proc.5:3125
11467 msgid "I</proc/sys/kernel/version>"
11470 #. type: Plain text
11471 #: build/C/man5/proc.5:3128
11472 msgid "This file contains a string like:"
11475 #. type: Plain text
11476 #: build/C/man5/proc.5:3130
11478 msgid " #5 Wed Feb 25 21:49:24 MET 1998\n"
11481 #. type: Plain text
11482 #: build/C/man5/proc.5:3134
11484 "The \"#5\" means that this is the fifth kernel built from this source base "
11485 "and the date behind it indicates the time the kernel was built."
11489 #: build/C/man5/proc.5:3134
11491 msgid "I</proc/sys/kernel/threads-max> (since Linux 2.3.11)"
11494 #. type: Plain text
11495 #: build/C/man5/proc.5:3138
11497 "This file specifies the system-wide limit on the number of threads (tasks) "
11498 "that can be created on the system."
11502 #: build/C/man5/proc.5:3138
11504 msgid "I</proc/sys/kernel/zero-paged> (PowerPC only) "
11507 #. type: Plain text
11508 #: build/C/man5/proc.5:3144
11510 "This file contains a flag. When enabled (nonzero), Linux-PPC will pre-zero "
11511 "pages in the idle loop, possibly speeding up get_free_pages."
11515 #: build/C/man5/proc.5:3144
11517 msgid "I</proc/sys/net>"
11520 #. type: Plain text
11521 #: build/C/man5/proc.5:3151
11523 "This directory contains networking stuff. Explanations for some of the "
11524 "files under this directory can be found in B<tcp>(7) and B<ip>(7)."
11528 #: build/C/man5/proc.5:3151
11530 msgid "I</proc/sys/net/core/somaxconn>"
11533 #. type: Plain text
11534 #: build/C/man5/proc.5:3160
11536 "This file defines a ceiling value for the I<backlog> argument of "
11537 "B<listen>(2); see the B<listen>(2) manual page for details."
11541 #: build/C/man5/proc.5:3160
11543 msgid "I</proc/sys/proc>"
11547 #: build/C/man5/proc.5:3163
11549 msgid "I</proc/sys/sunrpc>"
11552 #. type: Plain text
11553 #: build/C/man5/proc.5:3168
11555 "This directory supports Sun remote procedure call for network file system "
11556 "(NFS). On some systems, it is not present."
11560 #: build/C/man5/proc.5:3168
11562 msgid "I</proc/sys/vm>"
11565 #. type: Plain text
11566 #: build/C/man5/proc.5:3172
11568 "This directory contains files for memory management tuning, buffer and cache "
11573 #: build/C/man5/proc.5:3172
11575 msgid "I</proc/sys/vm/drop_caches> (since Linux 2.6.16)"
11578 #. type: Plain text
11579 #: build/C/man5/proc.5:3176
11581 "Writing to this file causes the kernel to drop clean caches, dentries and "
11582 "inodes from memory, causing that memory to become free."
11585 #. type: Plain text
11586 #: build/C/man5/proc.5:3183
11588 "To free pagecache, use I<echo 1 E<gt> /proc/sys/vm/drop_caches>; to free "
11589 "dentries and inodes, use I<echo 2 E<gt> /proc/sys/vm/drop_caches>; to free "
11590 "pagecache, dentries and inodes, use I<echo 3 E<gt> "
11591 "/proc/sys/vm/drop_caches>."
11594 #. type: Plain text
11595 #: build/C/man5/proc.5:3189
11597 "Because this is a nondestructive operation and dirty objects are not "
11598 "freeable, the user should run B<sync>(8) first."
11602 #: build/C/man5/proc.5:3189
11604 msgid "I</proc/sys/vm/legacy_va_layout> (since Linux 2.6.9)"
11607 #. The following is from Documentation/filesystems/proc.txt
11608 #. type: Plain text
11609 #: build/C/man5/proc.5:3194
11611 "If nonzero, this disables the new 32-bit memory-mapping layout; the kernel "
11612 "will use the legacy (2.4) layout for all processes."
11616 #: build/C/man5/proc.5:3194
11618 msgid "I</proc/sys/vm/memory_failure_early_kill> (since Linux 2.6.32)"
11621 #. The following is based on the text in Documentation/sysctl/vm.txt
11622 #. type: Plain text
11623 #: build/C/man5/proc.5:3206
11625 "Control how to kill processes when an uncorrected memory error (typically a "
11626 "2-bit error in a memory module) that cannot be handled by the kernel is "
11627 "detected in the background by hardware. In some cases (like the page still "
11628 "having a valid copy on disk), the kernel will handle the failure "
11629 "transparently without affecting any applications. But if there is no other "
11630 "up-to-date copy of the data, it will kill processes to prevent any data "
11631 "corruptions from propagating."
11634 #. type: Plain text
11635 #: build/C/man5/proc.5:3208
11636 msgid "The file has one of the following values:"
11640 #: build/C/man5/proc.5:3209 build/C/man5/proc.5:3246
11645 #. type: Plain text
11646 #: build/C/man5/proc.5:3214
11648 "Kill all processes that have the corrupted-and-not-reloadable page mapped as "
11649 "soon as the corruption is detected. Note this is not supported for a few "
11650 "types of pages, like kernel internally allocated data or the swap cache, but "
11651 "works for the majority of user pages."
11655 #: build/C/man5/proc.5:3214 build/C/man5/proc.5:3248
11660 #. type: Plain text
11661 #: build/C/man5/proc.5:3217
11663 "Only unmap the corrupted page from all processes and kill only a process "
11664 "that tries to access it."
11667 #. type: Plain text
11668 #: build/C/man5/proc.5:3228
11670 "The kill is performed using a B<SIGBUS> signal with I<si_code> set to "
11671 "B<BUS_MCEERR_AO>. Processes can handle this if they want to; see "
11672 "B<sigaction>(2) for more details."
11675 #. type: Plain text
11676 #: build/C/man5/proc.5:3231
11678 "This feature is active only on architectures/platforms with advanced machine "
11679 "check handling and depends on the hardware capabilities."
11682 #. type: Plain text
11683 #: build/C/man5/proc.5:3238
11685 "Applications can override the I<memory_failure_early_kill> setting "
11686 "individually with the B<prctl>(2) B<PR_MCE_KILL> operation."
11689 #. type: Plain text
11690 #: build/C/man5/proc.5:3241 build/C/man5/proc.5:3254
11691 msgid "Only present if the kernel was configured with B<CONFIG_MEMORY_FAILURE>."
11695 #: build/C/man5/proc.5:3241
11697 msgid "I</proc/sys/vm/memory_failure_recovery> (since Linux 2.6.32)"
11700 #. The following is based on the text in Documentation/sysctl/vm.txt
11701 #. type: Plain text
11702 #: build/C/man5/proc.5:3245
11703 msgid "Enable memory failure recovery (when supported by the platform)"
11706 #. type: Plain text
11707 #: build/C/man5/proc.5:3248
11708 msgid "Attempt recovery."
11711 #. type: Plain text
11712 #: build/C/man5/proc.5:3250
11713 msgid "Always panic on a memory failure."
11717 #: build/C/man5/proc.5:3254
11719 msgid "I</proc/sys/vm/oom_dump_tasks> (since Linux 2.6.25)"
11722 #. The following is from Documentation/sysctl/vm.txt
11723 #. type: Plain text
11724 #: build/C/man5/proc.5:3269
11726 "Enables a system-wide task dump (excluding kernel threads) to be produced "
11727 "when the kernel performs an OOM-killing. The dump includes the following "
11728 "information for each task (thread, process): thread ID, real user ID, thread "
11729 "group ID (process ID), virtual memory size, resident set size, the CPU that "
11730 "the task is scheduled on, oom_adj score (see the description of "
11731 "I</proc/[pid]/oom_adj>), and command name. This is helpful to determine why "
11732 "the OOM-killer was invoked and to identify the rogue task that caused it."
11735 #. type: Plain text
11736 #: build/C/man5/proc.5:3275
11738 "If this contains the value zero, this information is suppressed. On very "
11739 "large systems with thousands of tasks, it may not be feasible to dump the "
11740 "memory state information for each one. Such systems should not be forced to "
11741 "incur a performance penalty in OOM situations when the information may not "
11745 #. type: Plain text
11746 #: build/C/man5/proc.5:3278
11748 "If this is set to nonzero, this information is shown whenever the OOM-killer "
11749 "actually kills a memory-hogging task."
11752 #. type: Plain text
11753 #: build/C/man5/proc.5:3280 build/C/man5/proc.5:3301
11754 msgid "The default value is 0."
11758 #: build/C/man5/proc.5:3280
11760 msgid "I</proc/sys/vm/oom_kill_allocating_task> (since Linux 2.6.24)"
11763 #. The following is from Documentation/sysctl/vm.txt
11764 #. type: Plain text
11765 #: build/C/man5/proc.5:3285
11767 "This enables or disables killing the OOM-triggering task in out-of-memory "
11771 #. type: Plain text
11772 #: build/C/man5/proc.5:3290
11774 "If this is set to zero, the OOM-killer will scan through the entire tasklist "
11775 "and select a task based on heuristics to kill. This normally selects a "
11776 "rogue memory-hogging task that frees up a large amount of memory when "
11780 #. type: Plain text
11781 #: build/C/man5/proc.5:3294
11783 "If this is set to nonzero, the OOM-killer simply kills the task that "
11784 "triggered the out-of-memory condition. This avoids a possibly expensive "
11788 #. type: Plain text
11789 #: build/C/man5/proc.5:3299
11791 "If I</proc/sys/vm/panic_on_oom> is nonzero, it takes precedence over "
11792 "whatever value is used in I</proc/sys/vm/oom_kill_allocating_task>."
11796 #: build/C/man5/proc.5:3301
11798 msgid "I</proc/sys/vm/overcommit_memory>"
11801 #. type: Plain text
11802 #: build/C/man5/proc.5:3305
11803 msgid "This file contains the kernel virtual memory accounting mode. Values are:"
11806 #. type: Plain text
11807 #: build/C/man5/proc.5:3308
11808 msgid "0: heuristic overcommit (this is the default)"
11811 #. type: Plain text
11812 #: build/C/man5/proc.5:3310
11813 msgid "1: always overcommit, never check"
11816 #. type: Plain text
11817 #: build/C/man5/proc.5:3312
11818 msgid "2: always check, never overcommit"
11821 #. type: Plain text
11822 #: build/C/man5/proc.5:3326
11824 "In mode 0, calls of B<mmap>(2) with B<MAP_NORESERVE> are not checked, and "
11825 "the default check is very weak, leading to the risk of getting a process "
11826 "\"OOM-killed\". Under Linux 2.4 any nonzero value implies mode 1. In mode "
11827 "2 (available since Linux 2.6), the total virtual address space on the system "
11828 "is limited to (SS + RAM*(r/100)), where SS is the size of the swap space, "
11829 "and RAM is the size of the physical memory, and r is the contents of the "
11830 "file I</proc/sys/vm/overcommit_ratio>."
11834 #: build/C/man5/proc.5:3326
11836 msgid "I</proc/sys/vm/overcommit_ratio>"
11839 #. type: Plain text
11840 #: build/C/man5/proc.5:3330
11841 msgid "See the description of I</proc/sys/vm/overcommit_memory>."
11845 #: build/C/man5/proc.5:3330
11847 msgid "I</proc/sys/vm/panic_on_oom> (since Linux 2.6.18)"
11850 #. The following is adapted from Documentation/sysctl/vm.txt
11851 #. type: Plain text
11852 #: build/C/man5/proc.5:3335
11853 msgid "This enables or disables a kernel panic in an out-of-memory situation."
11856 #. type: Plain text
11857 #: build/C/man5/proc.5:3340
11859 "If this file is set to the value 0, the kernel's OOM-killer will kill some "
11860 "rogue process. Usually, the OOM-killer is able to kill a rogue process and "
11861 "the system will survive."
11864 #. type: Plain text
11865 #: build/C/man5/proc.5:3355
11867 "If this file is set to the value 1, then the kernel normally panics when "
11868 "out-of-memory happens. However, if a process limits allocations to certain "
11869 "nodes using memory policies (B<mbind>(2) B<MPOL_BIND>) or cpusets "
11870 "(B<cpuset>(7)) and those nodes reach memory exhaustion status, one process "
11871 "may be killed by the OOM-killer. No panic occurs in this case: because "
11872 "other nodes' memory may be free, this means the system as a whole may not "
11873 "have reached an out-of-memory situation yet."
11876 #. type: Plain text
11877 #: build/C/man5/proc.5:3358
11879 "If this file is set to the value 2, the kernel always panics when an "
11880 "out-of-memory condition occurs."
11883 #. type: Plain text
11884 #: build/C/man5/proc.5:3362
11886 "The default value is 0. 1 and 2 are for failover of clustering. Select "
11887 "either according to your policy of failover."
11891 #: build/C/man5/proc.5:3362
11893 msgid "I</proc/sys/vm/swappiness>"
11896 #. The following is from Documentation/sysctl/vm.txt
11897 #. type: Plain text
11898 #: build/C/man5/proc.5:3370
11900 "The value in this file controls how aggressively the kernel will swap memory "
11901 "pages. Higher values increase aggressiveness, lower values decrease "
11902 "aggressiveness. The default value is 60."
11906 #: build/C/man5/proc.5:3370
11908 msgid "I</proc/sysrq-trigger> (since Linux 2.4.21)"
11911 #. type: Plain text
11912 #: build/C/man5/proc.5:3379
11914 "Writing a character to this file triggers the same SysRq function as typing "
11915 "ALT-SysRq-E<lt>characterE<gt> (see the description of "
11916 "I</proc/sys/kernel/sysrq>). This file is normally writable only by "
11917 "I<root>. For further details see the Linux kernel source file "
11918 "I<Documentation/sysrq.txt>."
11922 #: build/C/man5/proc.5:3379
11924 msgid "I</proc/sysvipc>"
11927 #. type: Plain text
11928 #: build/C/man5/proc.5:3392
11930 "Subdirectory containing the pseudo-files I<msg>, I<sem> and I<shm>. These "
11931 "files list the System V Interprocess Communication (IPC) objects "
11932 "(respectively: message queues, semaphores, and shared memory) that "
11933 "currently exist on the system, providing similar information to that "
11934 "available via B<ipcs>(1). These files have headers and are formatted (one "
11935 "IPC object per line) for easy understanding. B<svipc>(7) provides further "
11936 "background on the information shown by these files."
11940 #: build/C/man5/proc.5:3392
11942 msgid "I</proc/tty>"
11945 #. type: Plain text
11946 #: build/C/man5/proc.5:3396
11948 "Subdirectory containing the pseudo-files and subdirectories for tty drivers "
11949 "and line disciplines."
11953 #: build/C/man5/proc.5:3396
11955 msgid "I</proc/uptime>"
11958 #. type: Plain text
11959 #: build/C/man5/proc.5:3400
11961 "This file contains two numbers: the uptime of the system (seconds), and the "
11962 "amount of time spent in idle process (seconds)."
11966 #: build/C/man5/proc.5:3400
11968 msgid "I</proc/version>"
11971 #. type: Plain text
11972 #: build/C/man5/proc.5:3409
11974 "This string identifies the kernel version that is currently running. It "
11975 "includes the contents of I</proc/sys/kernel/ostype>, "
11976 "I</proc/sys/kernel/osrelease> and I</proc/sys/kernel/version>. For example:"
11979 #. type: Plain text
11980 #: build/C/man5/proc.5:3413
11982 msgid "CW<Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994>\n"
11986 #: build/C/man5/proc.5:3424
11988 msgid "I</proc/vmstat> (since Linux 2.6)"
11991 #. type: Plain text
11992 #: build/C/man5/proc.5:3427
11993 msgid "This file displays various virtual memory statistics."
11997 #: build/C/man5/proc.5:3427
11999 msgid "I</proc/zoneinfo> (since Linux 2.6.13)"
12002 #. FIXME more should be said about /proc/zoneinfo
12003 #. type: Plain text
12004 #: build/C/man5/proc.5:3432
12006 "This file display information about memory zones. This is useful for "
12007 "analyzing virtual memory behavior."
12010 #. type: Plain text
12011 #: build/C/man5/proc.5:3439
12013 "Many strings (i.e., the environment and command line) are in the internal "
12014 "format, with subfields terminated by null bytes (\\(aq\\e0\\(aq), so you may "
12015 "find that things are more readable if you use I<od -c> or I<tr \"\\e000\" "
12016 "\"\\en\"> to read them. Alternatively, I<echo \\`cat E<lt>fileE<gt>\\`> "
12020 #. .SH ACKNOWLEDGEMENTS
12021 #. The material on /proc/sys/fs and /proc/sys/kernel is closely based on
12022 #. kernel source documentation files written by Rik van Riel.
12023 #. type: Plain text
12024 #: build/C/man5/proc.5:3445
12026 "This manual page is incomplete, possibly inaccurate, and is the kind of "
12027 "thing that needs to be updated very often."
12030 #. type: Plain text
12031 #: build/C/man5/proc.5:3471
12033 "B<cat>(1), B<dmesg>(1), B<find>(1), B<free>(1), B<ps>(1), B<tr>(1), "
12034 "B<uptime>(1), B<chroot>(2), B<mmap>(2), B<readlink>(2), B<syslog>(2), "
12035 "B<slabinfo>(5), B<hier>(7), B<time>(7), B<arp>(8), B<hdparm>(8), "
12036 "B<ifconfig>(8), B<init>(8), B<lsmod>(8), B<lspci>(8), B<mount>(8), "
12037 "B<netstat>(8), B<procinfo>(8), B<route>(8), B<sysctl>(8)"
12040 #. type: Plain text
12041 #: build/C/man5/proc.5:3476
12043 "The Linux kernel source files: I<Documentation/filesystems/proc.txt> and "
12044 "I<Documentation/sysctl/vm.txt>."
12048 #: build/C/man7/standards.7:26
12053 #. type: Plain text
12054 #: build/C/man7/standards.7:29
12055 msgid "standards - C and UNIX Standards"
12058 #. type: Plain text
12059 #: build/C/man7/standards.7:33
12061 "The CONFORMING TO section that appears in many manual pages identifies "
12062 "various standards to which the documented interface conforms. The following "
12063 "list briefly describes these standards."
12067 #: build/C/man7/standards.7:33
12072 #. type: Plain text
12073 #: build/C/man7/standards.7:36
12074 msgid "Version 7, the ancestral UNIX from Bell Labs."
12078 #: build/C/man7/standards.7:36
12083 #. type: Plain text
12084 #: build/C/man7/standards.7:45
12086 "This is an implementation standard defined by the 4.2 release of the "
12087 "I<Berkeley Software Distribution>, released by the University of California "
12088 "at Berkeley. This was the first Berkeley release that contained a TCP/IP "
12089 "stack and the sockets API. 4.2BSD was released in 1983."
12092 #. type: Plain text
12093 #: build/C/man7/standards.7:54
12095 "Earlier major BSD releases included I<3BSD> (1980), I<4BSD> (1980), and "
12096 "I<4.1BSD> (1981)."
12100 #: build/C/man7/standards.7:54
12105 #. type: Plain text
12106 #: build/C/man7/standards.7:57
12107 msgid "The successor to 4.2BSD, released in 1986."
12111 #: build/C/man7/standards.7:57
12116 #. type: Plain text
12117 #: build/C/man7/standards.7:61
12119 "The successor to 4.3BSD, released in 1993. This was the last major Berkeley "
12124 #: build/C/man7/standards.7:61
12126 msgid "B<System V>"
12129 #. type: Plain text
12130 #: build/C/man7/standards.7:68
12132 "This is an implementation standard defined by AT&T's milestone 1983 release "
12133 "of its commercial System V (five) release. The previous major AT&T release "
12134 "was I<System III>, released in 1981."
12138 #: build/C/man7/standards.7:68
12140 msgid "B<System V release 2 (SVr2)>"
12143 #. type: Plain text
12144 #: build/C/man7/standards.7:75
12146 "This was the next System V release, made in 1985. The SVr2 was formally "
12147 "described in the I<System V Interface Definition version 1> (I<SVID 1>) "
12148 "published in 1985."
12152 #: build/C/man7/standards.7:75
12154 msgid "B<System V release 3 (SVr3)>"
12157 #. type: Plain text
12158 #: build/C/man7/standards.7:81
12160 "This was the successor to SVr2, released in 1986. This release was formally "
12161 "described in the I<System V Interface Definition version 2> (I<SVID 2>)."
12165 #: build/C/man7/standards.7:81
12167 msgid "B<System V release 4 (SVr4)>"
12170 #. type: Plain text
12171 #: build/C/man7/standards.7:91
12173 "This was the successor to SVr3, released in 1989. This version of System V "
12174 "is described in the \"Programmer's Reference Manual: Operating System API "
12175 "(Intel processors)\" (Prentice-Hall 1992, ISBN 0-13-951294-2) This release "
12176 "was formally described in the I<System V Interface Definition version 3> "
12177 "(I<SVID 3>), and is considered the definitive System V release."
12181 #: build/C/man7/standards.7:91
12186 #. type: Plain text
12187 #: build/C/man7/standards.7:97
12189 "System V Interface Definition version 4, issued in 1995. Available online "
12190 "at E<.UR http://www.sco.com\\:/developers\\:/devspecs/> E<.UE .>"
12194 #: build/C/man7/standards.7:97
12199 #. type: Plain text
12200 #: build/C/man7/standards.7:111
12202 "This was the first C language standard, ratified by ANSI (American National "
12203 "Standards Institute) in 1989 (I<X3.159-1989>). Sometimes this is known as "
12204 "I<ANSI C>, but since C99 is also an ANSI standard, this term is ambiguous. "
12205 "This standard was also ratified by ISO (International Standards "
12206 "Organization) in 1990 (I<ISO/IEC 9899:1990>), and is thus occasionally "
12207 "referred to as I<ISO C90>."
12211 #: build/C/man7/standards.7:111
12216 #. type: Plain text
12217 #: build/C/man7/standards.7:118
12219 "This revision of the C language standard was ratified by ISO in 1999 "
12220 "(I<ISO/IEC 9899:1999>). Available online at E<.UR "
12221 "http://www.open-std.org\\:/jtc1\\:/sc22\\:/wg14\\:/www\\:/standards> E<.UE "
12226 #: build/C/man7/standards.7:118
12228 msgid "B<POSIX.1-1990>"
12231 #. type: Plain text
12232 #: build/C/man7/standards.7:124
12234 "\"Portable Operating System Interface for Computing Environments\". IEEE "
12235 "1003.1-1990 part 1, ratified by ISO in 1990 (I<ISO/IEC 9945-1:1990>). The "
12236 "term \"POSIX\" was coined by Richard Stallman."
12240 #: build/C/man7/standards.7:124
12245 #. type: Plain text
12246 #: build/C/man7/standards.7:129
12248 "IEEE Std 1003.2-1992, describing commands and utilities, ratified by ISO in "
12249 "1993 (I<ISO/IEC 9945-2:1993>)."
12253 #: build/C/man7/standards.7:129
12255 msgid "B<POSIX.1b> (formerly known as I<POSIX.4>)"
12258 #. type: Plain text
12259 #: build/C/man7/standards.7:135
12261 "IEEE Std 1003.1b-1993 describing real-time facilities for portable operating "
12262 "systems, ratified by ISO in 1996 (I<ISO/IEC 9945-1:1996>)."
12266 #: build/C/man7/standards.7:135
12268 msgid "B<POSIX.1c>"
12271 #. type: Plain text
12272 #: build/C/man7/standards.7:138
12273 msgid "IEEE Std 1003.1c-1995 describing the POSIX threads interfaces."
12277 #: build/C/man7/standards.7:138
12279 msgid "B<POSIX.1d>"
12282 #. type: Plain text
12283 #: build/C/man7/standards.7:141
12284 msgid "IEEE Std 1003.1c-1999 describing additional real-time extensions."
12288 #: build/C/man7/standards.7:141
12290 msgid "B<POSIX.1g>"
12293 #. type: Plain text
12294 #: build/C/man7/standards.7:144
12295 msgid "IEEE Std 1003.1g-2000 describing networking APIs (including sockets)."
12299 #: build/C/man7/standards.7:144
12301 msgid "B<POSIX.1j>"
12304 #. type: Plain text
12305 #: build/C/man7/standards.7:147
12306 msgid "IEEE Std 1003.1j-2000 describing advanced real-time extensions."
12310 #: build/C/man7/standards.7:147
12312 msgid "B<POSIX.1-1996>"
12315 #. type: Plain text
12316 #: build/C/man7/standards.7:150
12317 msgid "A 1996 revision of POSIX.1 which incorporated POSIX.1b and POSIX.1c."
12321 #: build/C/man7/standards.7:150
12326 #. type: Plain text
12327 #: build/C/man7/standards.7:157
12329 "Released in 1989, this was the first significant release of the I<X/Open "
12330 "Portability Guide>, produced by the X/Open Company, a multivendor "
12331 "consortium. This multivolume guide was based on the POSIX standards."
12335 #: build/C/man7/standards.7:157
12340 #. type: Plain text
12341 #: build/C/man7/standards.7:160
12342 msgid "A revision of the X/Open Portability Guide, released in 1992."
12346 #: build/C/man7/standards.7:160
12351 #. type: Plain text
12352 #: build/C/man7/standards.7:167
12354 "A 1994 revision of XPG4. This is also referred to as I<Spec 1170>, where "
12355 "1170 referred to the number of interfaces defined by this standard."
12359 #: build/C/man7/standards.7:167
12361 msgid "B<SUS (SUSv1)>"
12364 #. type: Plain text
12365 #: build/C/man7/standards.7:175
12367 "Single UNIX Specification. This was a repackaging of XPG4v2 and other "
12368 "X/Open standards (X/Open Curses Issue 4 version 2, X/Open Networking Service "
12369 "(XNS) Issue 4). Systems conforming to this standard can be branded I<UNIX "
12374 #: build/C/man7/standards.7:175
12379 #. type: Plain text
12380 #: build/C/man7/standards.7:186
12382 "Single UNIX Specification version 2. Sometimes also referred to as "
12383 "I<XPG5>. This standard appeared in 1997. Systems conforming to this "
12384 "standard can be branded I<UNIX 98>. See also E<.UR "
12385 "http://www.UNIX-systems.org\\:/version2/> E<.UE .)>"
12389 #: build/C/man7/standards.7:186
12391 msgid "B<POSIX.1-2001, SUSv3>"
12394 #. type: Plain text
12395 #: build/C/man7/standards.7:198
12397 "This was a 2001 revision and consolidation of the POSIX.1, POSIX.2, and SUS "
12398 "standards into a single document, conducted under the auspices of the Austin "
12399 "group E<.UR http://www.opengroup.org\\:/austin/> E<.UE .> The standard is "
12400 "available online at E<.UR http://www.unix-systems.org\\:/version3/> E<.UE ,> "
12401 "and the interfaces that it describes are also available in the Linux manual "
12402 "pages package under sections 1p and 3p (e.g., \"man 3p open\")."
12405 #. type: Plain text
12406 #: build/C/man7/standards.7:211
12408 "The standard defines two levels of conformance: I<POSIX conformance>, which "
12409 "is a baseline set of interfaces required of a conforming system; and I<XSI "
12410 "Conformance>, which additionally mandates a set of interfaces (the \"XSI "
12411 "extension\") which are only optional for POSIX conformance. XSI-conformant "
12412 "systems can be branded I<UNIX 03>. (XSI conformance constitutes the "
12413 "I<Single UNIX Specification version 3> (I<SUSv3>).)"
12416 #. type: Plain text
12417 #: build/C/man7/standards.7:213
12418 msgid "The POSIX.1-2001 document is broken into four parts:"
12421 #. type: Plain text
12422 #: build/C/man7/standards.7:216
12423 msgid "B<XBD>: Definitions, terms and concepts, header file specifications."
12426 #. type: Plain text
12427 #: build/C/man7/standards.7:220
12429 "B<XSH>: Specifications of functions (i.e., system calls and library "
12430 "functions in actual implementations)."
12433 #. type: Plain text
12434 #: build/C/man7/standards.7:224
12436 "B<XCU>: Specifications of commands and utilities (i.e., the area formerly "
12437 "described by POSIX.2)."
12440 #. type: Plain text
12441 #: build/C/man7/standards.7:227
12442 msgid "B<XRAT>: Informative text on the other parts of the standard."
12445 #. type: Plain text
12446 #: build/C/man7/standards.7:231
12448 "POSIX.1-2001 is aligned with C99, so that all of the library functions "
12449 "standardized in C99 are also standardized in POSIX.1-2001."
12452 #. type: Plain text
12453 #: build/C/man7/standards.7:238
12455 "Two Technical Corrigenda (minor fixes and improvements) of the original "
12456 "2001 standard have occurred: TC1 in 2003 (referred to as I<POSIX.1-2003>), "
12457 "and TC2 in 2004 (referred to as I<POSIX.1-2004>)."
12461 #: build/C/man7/standards.7:238
12463 msgid "B<POSIX.1-2008, SUSv4>"
12466 #. type: Plain text
12467 #: build/C/man7/standards.7:242
12468 msgid "Work on the next revision of POSIX.1/SUS was completed and ratified in 2008."
12471 #. type: Plain text
12472 #: build/C/man7/standards.7:251
12474 "The changes in this revision are not as large as those that occurred for "
12475 "POSIX.1-2001/SUSv3, but a number of new interfaces are added and various "
12476 "details of existing specifications are modified. Many of the interfaces "
12477 "that were optional in POSIX.1-2001 become mandatory in the 2008 revision of "
12478 "the standard. A few interfaces that are present in POSIX.1-2001 are marked "
12479 "as obsolete in POSIX.1-2008, or removed from the standard altogether."
12482 #. type: Plain text
12483 #: build/C/man7/standards.7:259
12485 "The revised standard is broken into the same four parts as POSIX.1-2001, and "
12486 "again there are two levels of conformance: the baseline I<POSIX "
12487 "Conformance>, and I<XSI Conformance>, which mandates an additional set of "
12488 "interfaces beyond those in the base specification."
12491 #. type: Plain text
12492 #: build/C/man7/standards.7:263
12494 "In general, where the CONFORMING TO section of a manual page lists "
12495 "POSIX.1-2001, it can be assumed that the interface also conforms to "
12496 "POSIX.1-2008, unless otherwise noted."
12499 #. type: Plain text
12500 #: build/C/man7/standards.7:267
12502 "Further information can be found on the Austin group web site, E<.UR "
12503 "http://www.opengroup.org\\:/austin/> E<.UE .>"
12506 #. type: Plain text
12507 #: build/C/man7/standards.7:271
12508 msgid "B<feature_test_macros>(7), B<libc>(7), B<posixoptions>(7)"
12512 #: build/C/man7/suffixes.7:40
12518 #: build/C/man7/suffixes.7:40
12523 #. type: Plain text
12524 #: build/C/man7/suffixes.7:43
12525 msgid "suffixes - list of file suffixes"
12528 #. type: Plain text
12529 #: build/C/man7/suffixes.7:51
12531 "It is customary to indicate the contents of a file with the file suffix, "
12532 "which consists of a period, followed by one or more letters. Many standard "
12533 "utilities, such as compilers, use this to recognize the type of file they "
12534 "are dealing with. The B<make>(1) utility is driven by rules based on file "
12538 #. type: Plain text
12539 #: build/C/man7/suffixes.7:54
12541 "Following is a list of suffixes which are likely to be found on a Linux "
12546 #: build/C/man7/suffixes.7:59
12548 msgid "Suffix\tFile type\n"
12552 #: build/C/man7/suffixes.7:60
12554 msgid " ,v\tfiles for RCS (Revision Control System)\n"
12558 #: build/C/man7/suffixes.7:61
12560 msgid " -\tbackup file\n"
12564 #: build/C/man7/suffixes.7:62
12566 msgid " .C\tC++ source code, equivalent to I<.cc>\n"
12570 #: build/C/man7/suffixes.7:63
12572 msgid " .F\tFortran source with B<cpp>(1) directives\n"
12576 #: build/C/man7/suffixes.7:64
12578 msgid "\tor file compressed using freeze\n"
12582 #: build/C/man7/suffixes.7:65
12584 msgid " .S\tassembler source with B<cpp>(1) directives\n"
12588 #: build/C/man7/suffixes.7:66
12590 msgid " .Y\tfile compressed using yabba\n"
12594 #: build/C/man7/suffixes.7:67
12596 msgid " .Z\tfile compressed using B<compress>(1)\n"
12600 #: build/C/man7/suffixes.7:68
12602 msgid " .[0-9]+gf\tTeX generic font files\n"
12606 #: build/C/man7/suffixes.7:69
12608 msgid " .[0-9]+pk\tTeX packed font files\n"
12612 #: build/C/man7/suffixes.7:70
12614 msgid " .[1-9]\tmanual page for the corresponding section\n"
12618 #: build/C/man7/suffixes.7:71
12620 msgid " .[1-9][a-z]\tmanual page for section plus subsection\n"
12624 #: build/C/man7/suffixes.7:72
12626 msgid " .a\tstatic object code library\n"
12630 #: build/C/man7/suffixes.7:73
12632 msgid " .ad\tX application default resource file\n"
12636 #: build/C/man7/suffixes.7:74
12638 msgid " .ada\tAda source (may be body, spec, or combination)\n"
12642 #: build/C/man7/suffixes.7:75
12644 msgid " .adb\tAda body source\n"
12648 #: build/C/man7/suffixes.7:76
12650 msgid " .ads\tAda spec source\n"
12654 #: build/C/man7/suffixes.7:77
12656 msgid " .afm\tPostScript font metrics\n"
12660 #: build/C/man7/suffixes.7:78
12662 msgid " .al\tPerl autoload file\n"
12666 #: build/C/man7/suffixes.7:79
12668 msgid " .am\tB<automake>(1) input file\n"
12672 #: build/C/man7/suffixes.7:80
12674 msgid " .arc\tB<arc>(1) archive\n"
12678 #: build/C/man7/suffixes.7:81
12680 msgid " .arj\tB<arj>(1) archive\n"
12684 #: build/C/man7/suffixes.7:82
12686 msgid " .asc\tPGP ASCII-armored data\n"
12690 #: build/C/man7/suffixes.7:83
12692 msgid " .asm\t(GNU) assembler source file\n"
12696 #: build/C/man7/suffixes.7:84
12698 msgid " .au\tAudio sound file\n"
12702 #: build/C/man7/suffixes.7:85
12704 msgid " .aux\tLaTeX auxiliary file\n"
12708 #: build/C/man7/suffixes.7:86
12710 msgid " .avi\t(msvideo) movie\n"
12714 #: build/C/man7/suffixes.7:87
12716 msgid " .awk\tAWK language program\n"
12720 #: build/C/man7/suffixes.7:88
12722 msgid " .b\tLILO boot loader image\n"
12726 #: build/C/man7/suffixes.7:89
12728 msgid " .bak\tbackup file\n"
12732 #: build/C/man7/suffixes.7:90
12734 msgid " .bash\tB<bash>(1) shell script\n"
12738 #: build/C/man7/suffixes.7:91
12740 msgid " .bb\tbasic block list data produced by\n"
12744 #: build/C/man7/suffixes.7:92 build/C/man7/suffixes.7:94
12746 msgid "\tgcc -ftest-coverage\n"
12750 #: build/C/man7/suffixes.7:93
12752 msgid " .bbg\tbasic block graph data produced by\n"
12756 #: build/C/man7/suffixes.7:95
12758 msgid " .bbl\tBibTeX output\n"
12762 #: build/C/man7/suffixes.7:96
12764 msgid " .bdf\tX font file\n"
12768 #: build/C/man7/suffixes.7:97
12770 msgid " .bib\tTeX bibliographic database, BibTeX input\n"
12774 #: build/C/man7/suffixes.7:98
12776 msgid " .bm\tbitmap source\n"
12780 #: build/C/man7/suffixes.7:99
12782 msgid " .bmp\tbitmap\n"
12786 #: build/C/man7/suffixes.7:100
12788 msgid " .bz2\tfile compressed using B<bzip2>(1)\n"
12792 #: build/C/man7/suffixes.7:101
12794 msgid " .c\tC source\n"
12798 #: build/C/man7/suffixes.7:102
12800 msgid " .cat\tmessage catalog files\n"
12804 #: build/C/man7/suffixes.7:103
12806 msgid " .cc\tC++ source\n"
12810 #: build/C/man7/suffixes.7:104
12812 msgid " .cf\tconfiguration file\n"
12816 #: build/C/man7/suffixes.7:105
12818 msgid " .cfg\tconfiguration file\n"
12822 #: build/C/man7/suffixes.7:106
12824 msgid " .cgi\tWWW content generating script or program\n"
12828 #: build/C/man7/suffixes.7:107
12830 msgid " .cls\tLaTeX Class definition\n"
12834 #: build/C/man7/suffixes.7:108
12836 msgid " .class\tJava compiled byte-code\n"
12840 #: build/C/man7/suffixes.7:109
12842 msgid " .conf\tconfiguration file\n"
12846 #: build/C/man7/suffixes.7:110
12848 msgid " .config\tconfiguration file\n"
12852 #: build/C/man7/suffixes.7:111
12854 msgid " .cpp\tequivalent to I<.cc>\n"
12858 #: build/C/man7/suffixes.7:112
12860 msgid " .csh\tB<csh>(1) shell script\n"
12864 #: build/C/man7/suffixes.7:113
12866 msgid " .cxx\tequivalent to I<.cc>\n"
12870 #: build/C/man7/suffixes.7:114
12872 msgid " .dat\tdata file\n"
12876 #: build/C/man7/suffixes.7:115
12878 msgid " .deb\tDebian software package\n"
12882 #: build/C/man7/suffixes.7:116
12884 msgid " .def\tModula-2 source for definition modules\n"
12888 #: build/C/man7/suffixes.7:117
12890 msgid " .def\tother definition files\n"
12894 #: build/C/man7/suffixes.7:118
12896 msgid " .desc\tinitial part of mail message unpacked with\n"
12900 #: build/C/man7/suffixes.7:119
12902 msgid "\tB<munpack>(1)\n"
12906 #: build/C/man7/suffixes.7:120
12908 msgid " .diff\tfile differences (B<diff>(1) command output)\n"
12912 #: build/C/man7/suffixes.7:121
12914 msgid " .dir\tdbm data base directory file\n"
12918 #: build/C/man7/suffixes.7:122
12920 msgid " .doc\tdocumentation file\n"
12924 #: build/C/man7/suffixes.7:123
12926 msgid " .dsc\tDebian Source Control (source package)\n"
12930 #: build/C/man7/suffixes.7:124
12932 msgid " .dtx\tLaTeX package source file\n"
12936 #: build/C/man7/suffixes.7:125
12938 msgid " .dvi\tTeX's device independent output\n"
12942 #: build/C/man7/suffixes.7:126
12944 msgid " .el\tEmacs-Lisp source\n"
12948 #: build/C/man7/suffixes.7:127
12950 msgid " .elc\tcompiled Emacs-Lisp source\n"
12954 #: build/C/man7/suffixes.7:128
12956 msgid " .eps\tencapsulated PostScript\n"
12960 #: build/C/man7/suffixes.7:129
12962 msgid " .exp\tExpect source code\n"
12966 #: build/C/man7/suffixes.7:130
12968 msgid " .f\tFortran source\n"
12972 #: build/C/man7/suffixes.7:131
12974 msgid " .f77\tFortran 77 source\n"
12978 #: build/C/man7/suffixes.7:132
12980 msgid " .f90\tFortran 90 source\n"
12984 #: build/C/man7/suffixes.7:133
12986 msgid " .fas\tprecompiled Common-Lisp\n"
12990 #: build/C/man7/suffixes.7:134
12992 msgid " .fi\tFortran include files\n"
12996 #: build/C/man7/suffixes.7:135
12998 msgid " .fig\tFIG image file (used by B<xfig>(1))\n"
13002 #: build/C/man7/suffixes.7:136
13004 msgid " .fmt\tTeX format file\n"
13008 #: build/C/man7/suffixes.7:137
13010 msgid " .gif\tCompuserve Graphics Image File format\n"
13014 #: build/C/man7/suffixes.7:138
13016 msgid " .gmo\tGNU format message catalog\n"
13020 #: build/C/man7/suffixes.7:139
13022 msgid " .gsf\tGhostscript fonts\n"
13026 #: build/C/man7/suffixes.7:140
13028 msgid " .gz\tfile compressed using B<gzip>(1)\n"
13032 #: build/C/man7/suffixes.7:141
13034 msgid " .h\tC or C++ header files\n"
13038 #: build/C/man7/suffixes.7:142
13040 msgid " .help\thelp file\n"
13044 #: build/C/man7/suffixes.7:143
13046 msgid " .hf\tequivalent to I<.help>\n"
13050 #: build/C/man7/suffixes.7:144
13052 msgid " .hlp\tequivalent to I<.help>\n"
13056 #: build/C/man7/suffixes.7:145
13058 msgid " .htm\tpoor man's I<.html>\n"
13062 #: build/C/man7/suffixes.7:146
13064 msgid " .html\tHTML document used with the World Wide Web\n"
13068 #: build/C/man7/suffixes.7:147
13070 msgid " .hqx\t7-bit encoded Macintosh file\n"
13074 #: build/C/man7/suffixes.7:148
13076 msgid " .i\tC source after preprocessing\n"
13080 #: build/C/man7/suffixes.7:149
13082 msgid " .icon\tbitmap source\n"
13086 #: build/C/man7/suffixes.7:150
13088 msgid " .idx\treference or datum-index file for hypertext\n"
13092 #: build/C/man7/suffixes.7:151
13094 msgid "\tor database system\n"
13098 #: build/C/man7/suffixes.7:152
13100 msgid " .image\tbitmap source\n"
13104 #: build/C/man7/suffixes.7:153
13106 msgid " .in\tconfiguration template, especially for GNU Autoconf\n"
13110 #: build/C/man7/suffixes.7:154
13112 msgid " .info\tfiles for the Emacs info browser\n"
13116 #: build/C/man7/suffixes.7:155
13118 msgid " .info-[0-9]+\tsplit info files\n"
13122 #: build/C/man7/suffixes.7:156
13124 msgid " .ins\tLaTeX package install file for docstrip\n"
13128 #: build/C/man7/suffixes.7:157
13130 msgid " .itcl\titcl source code;\n"
13134 #: build/C/man7/suffixes.7:158
13136 msgid "\titcl ([incr Tcl]) is an OO extension of tcl\n"
13140 #: build/C/man7/suffixes.7:159
13142 msgid " .java\ta Java source file\n"
13146 #: build/C/man7/suffixes.7:160
13148 msgid " .jpeg\tJoint Photographic Experts Group format\n"
13152 #: build/C/man7/suffixes.7:161
13154 msgid " .jpg\tpoor man's I<.jpeg>\n"
13158 #: build/C/man7/suffixes.7:162
13160 msgid " .kmap\tB<lyx>(1) keymap\n"
13164 #: build/C/man7/suffixes.7:163
13166 msgid " .l\tequivalent to I<.lex> or I<.lisp>\n"
13170 #: build/C/man7/suffixes.7:164
13172 msgid " .lex\tB<lex>(1) or B<flex>(1) files\n"
13176 #: build/C/man7/suffixes.7:165
13178 msgid " .lha\tlharc archive\n"
13182 #: build/C/man7/suffixes.7:166
13184 msgid " .lib\tCommon-Lisp library\n"
13188 #: build/C/man7/suffixes.7:167
13190 msgid " .lisp\tLisp source\n"
13194 #: build/C/man7/suffixes.7:168
13196 msgid " .ln\tfiles for use with B<lint>(1)\n"
13200 #: build/C/man7/suffixes.7:169
13202 msgid " .log\tlog file, in particular produced by TeX\n"
13206 #: build/C/man7/suffixes.7:170
13208 msgid " .lsm\tLinux Software Map entry\n"
13212 #: build/C/man7/suffixes.7:171
13214 msgid " .lsp\tCommon-Lisp source\n"
13218 #: build/C/man7/suffixes.7:172
13220 msgid " .lzh\tlharc archive\n"
13224 #: build/C/man7/suffixes.7:173
13226 msgid " .m\tObjective-C source code\n"
13230 #: build/C/man7/suffixes.7:174
13232 msgid " .m4\tB<m4>(1) source\n"
13236 #: build/C/man7/suffixes.7:175
13238 msgid " .mac\tmacro files for various programs\n"
13242 #: build/C/man7/suffixes.7:176
13244 msgid " .man\tmanual page (usually source rather than formatted)\n"
13248 #: build/C/man7/suffixes.7:177
13250 msgid " .map\tmap files for various programs\n"
13254 #: build/C/man7/suffixes.7:178
13256 msgid " .me\tNroff source using the me macro package\n"
13260 #: build/C/man7/suffixes.7:179
13262 msgid " .mf\tMetafont (font generator for TeX) source\n"
13266 #: build/C/man7/suffixes.7:180
13268 msgid " .mgp\tMagicPoint file\n"
13272 #: build/C/man7/suffixes.7:181
13274 msgid " .mm\tsources for B<groff>(1) in mm - format\n"
13278 #: build/C/man7/suffixes.7:182
13280 msgid " .mo\tMessage catalog binary file\n"
13284 #: build/C/man7/suffixes.7:183
13286 msgid " .mod\tModula-2 source for implementation modules\n"
13290 #: build/C/man7/suffixes.7:184
13292 msgid " .mov\t(quicktime) movie\n"
13296 #: build/C/man7/suffixes.7:185
13298 msgid " .mp\tMetapost source\n"
13302 #: build/C/man7/suffixes.7:186
13304 msgid " .mp2\tMPEG Layer 2 (audio) file\n"
13308 #: build/C/man7/suffixes.7:187
13310 msgid " .mp3\tMPEG Layer 3 (audio) file\n"
13314 #: build/C/man7/suffixes.7:188
13316 msgid " .mpeg\tmovie file\n"
13320 #: build/C/man7/suffixes.7:189
13322 msgid " .o\tobject file\n"
13326 #: build/C/man7/suffixes.7:190
13328 msgid " .old\told or backup file\n"
13332 #: build/C/man7/suffixes.7:191
13334 msgid " .orig\tbackup (original) version of a file, from B<patch>(1)\n"
13338 #: build/C/man7/suffixes.7:192
13340 msgid " .out\toutput file, often executable program (a.out)\n"
13344 #: build/C/man7/suffixes.7:193
13346 msgid " .p\tPascal source\n"
13350 #: build/C/man7/suffixes.7:194
13352 msgid " .pag\tdbm data base data file\n"
13356 #: build/C/man7/suffixes.7:195
13358 msgid " .patch\tfile differences for B<patch>(1)\n"
13362 #: build/C/man7/suffixes.7:196
13364 msgid " .pbm\tportable bitmap format\n"
13368 #: build/C/man7/suffixes.7:197
13370 msgid " .pcf\tX11 font files\n"
13374 #: build/C/man7/suffixes.7:198
13376 msgid " .pdf\tAdobe Portable Data Format\n"
13380 #: build/C/man7/suffixes.7:199
13382 msgid "\t(use Acrobat/B<acroread> or B<xpdf>)\n"
13386 #: build/C/man7/suffixes.7:200
13388 msgid " .perl\tPerl source (see .ph, .pl and .pm)\n"
13392 #: build/C/man7/suffixes.7:201
13394 msgid " .pfa\tPostScript font definition files, ASCII format\n"
13398 #: build/C/man7/suffixes.7:202
13400 msgid " .pfb\tPostScript font definition files, binary format\n"
13404 #: build/C/man7/suffixes.7:203
13406 msgid " .pgm\tportable greymap format\n"
13410 #: build/C/man7/suffixes.7:204
13412 msgid " .pgp\tPGP binary data\n"
13416 #: build/C/man7/suffixes.7:205
13418 msgid " .ph\tPerl header file\n"
13422 #: build/C/man7/suffixes.7:206
13424 msgid " .php\tPHP program file\n"
13428 #: build/C/man7/suffixes.7:207
13430 msgid " .php3\tPHP3 program file\n"
13434 #: build/C/man7/suffixes.7:208
13436 msgid " .pid\tFile to store daemon PID (e.g., crond.pid)\n"
13440 #: build/C/man7/suffixes.7:209
13442 msgid " .pl\tTeX property list file or Perl library file\n"
13446 #: build/C/man7/suffixes.7:210
13448 msgid " .pm\tPerl module\n"
13452 #: build/C/man7/suffixes.7:211
13454 msgid " .png\tPortable Network Graphics file\n"
13458 #: build/C/man7/suffixes.7:212
13460 msgid " .po\tMessage catalog source\n"
13464 #: build/C/man7/suffixes.7:213
13466 msgid " .pod\tB<perldoc>(1) file\n"
13470 #: build/C/man7/suffixes.7:214
13472 msgid " .ppm\tportable pixmap format\n"
13476 #: build/C/man7/suffixes.7:215
13478 msgid " .pr\tbitmap source\n"
13482 #: build/C/man7/suffixes.7:216
13484 msgid " .ps\tPostScript file\n"
13488 #: build/C/man7/suffixes.7:217
13490 msgid " .py\tPython source\n"
13494 #: build/C/man7/suffixes.7:218
13496 msgid " .pyc\tcompiled python\n"
13500 #: build/C/man7/suffixes.7:219
13502 msgid " .qt\tquicktime movie\n"
13506 #: build/C/man7/suffixes.7:220
13508 msgid " .r\tRATFOR source (obsolete)\n"
13512 #: build/C/man7/suffixes.7:221
13514 msgid " .rej\tpatches that B<patch>(1) couldn't apply\n"
13518 #: build/C/man7/suffixes.7:222
13520 msgid " .rpm\tRPM software package\n"
13524 #: build/C/man7/suffixes.7:223
13526 msgid " .rtf\tRich Text Format file\n"
13530 #: build/C/man7/suffixes.7:224
13532 msgid " .rules\trules for something\n"
13536 #: build/C/man7/suffixes.7:225
13538 msgid " .s\tassembler source\n"
13542 #: build/C/man7/suffixes.7:226
13544 msgid " .sa\tstub libraries for a.out shared libraries\n"
13548 #: build/C/man7/suffixes.7:227
13550 msgid " .sc\tB<sc>(1) spreadsheet commands\n"
13554 #: build/C/man7/suffixes.7:228
13556 msgid " .scm\tScheme source code\n"
13560 #: build/C/man7/suffixes.7:229
13562 msgid " .sed\tsed source file\n"
13566 #: build/C/man7/suffixes.7:230
13568 msgid " .sgml\tSGML source file\n"
13572 #: build/C/man7/suffixes.7:231
13574 msgid " .sh\tB<sh>(1) scripts\n"
13578 #: build/C/man7/suffixes.7:232
13580 msgid " .shar\tarchive created by the B<shar>(1) utility\n"
13584 #: build/C/man7/suffixes.7:233
13586 msgid " .so\tShared library or dynamically loadable object\n"
13590 #: build/C/man7/suffixes.7:234
13592 msgid " .sql\tSQL source\n"
13596 #: build/C/man7/suffixes.7:235
13598 msgid " .sqml\tSQML schema or query program\n"
13602 #: build/C/man7/suffixes.7:236
13604 msgid " .sty\tLaTeX style files\n"
13608 #: build/C/man7/suffixes.7:237
13610 msgid " .sym\tModula-2 compiled definition modules\n"
13614 #: build/C/man7/suffixes.7:238
13616 msgid " .tar\tarchive created by the B<tar>(1) utility\n"
13620 #: build/C/man7/suffixes.7:239
13622 msgid " .tar.Z\ttar(1) archive compressed with B<compress>(1)\n"
13626 #: build/C/man7/suffixes.7:240
13628 msgid " .tar.bz2\ttar(1) archive compressed with B<bzip2>(1)\n"
13632 #: build/C/man7/suffixes.7:241
13634 msgid " .tar.gz\ttar(1) archive compressed with B<gzip>(1)\n"
13638 #: build/C/man7/suffixes.7:242
13640 msgid " .taz\ttar(1) archive compressed with B<compress>(1)\n"
13644 #: build/C/man7/suffixes.7:243
13646 msgid " .tcl\ttcl source code\n"
13650 #: build/C/man7/suffixes.7:244
13652 msgid " .tex\tTeX or LaTeX source\n"
13656 #: build/C/man7/suffixes.7:245
13658 msgid " .texi\tequivalent to I<.texinfo>\n"
13662 #: build/C/man7/suffixes.7:246
13664 msgid " .texinfo\tTexinfo documentation source\n"
13668 #: build/C/man7/suffixes.7:247
13670 msgid " .text\ttext file\n"
13674 #: build/C/man7/suffixes.7:248
13676 msgid " .tfm\tTeX font metric file\n"
13680 #: build/C/man7/suffixes.7:249
13682 msgid " .tgz\ttar archive compressed with B<gzip>(1)\n"
13686 #: build/C/man7/suffixes.7:250
13688 msgid " .tif\tpoor man's I<.tiff>\n"
13692 #: build/C/man7/suffixes.7:251
13694 msgid " .tiff\tTagged Image File Format\n"
13698 #: build/C/man7/suffixes.7:252
13700 msgid " .tk\ttcl/tk script\n"
13704 #: build/C/man7/suffixes.7:253
13706 msgid " .tmp\ttemporary file\n"
13710 #: build/C/man7/suffixes.7:254
13712 msgid " .tmpl\ttemplate files\n"
13716 #: build/C/man7/suffixes.7:255
13718 msgid " .txt\tequivalent to I<.text>\n"
13722 #: build/C/man7/suffixes.7:256
13724 msgid " .uu\tequivalent to I<.uue>\n"
13728 #: build/C/man7/suffixes.7:257
13730 msgid " .uue\tbinary file encoded with B<uuencode>(1)\n"
13734 #: build/C/man7/suffixes.7:258
13736 msgid " .vf\tTeX virtual font file\n"
13740 #: build/C/man7/suffixes.7:259
13742 msgid " .vpl\tTeX virtual property list file\n"
13746 #: build/C/man7/suffixes.7:260
13748 msgid " .w\tSilvio Levi's CWEB\n"
13752 #: build/C/man7/suffixes.7:261
13754 msgid " .wav\twave sound file\n"
13758 #: build/C/man7/suffixes.7:262
13760 msgid " .web\tDonald Knuth's WEB\n"
13764 #: build/C/man7/suffixes.7:263
13766 msgid " .wml\tSource file for Web Meta Language\n"
13770 #: build/C/man7/suffixes.7:264
13772 msgid " .xbm\tX11 bitmap source\n"
13776 #: build/C/man7/suffixes.7:265
13778 msgid " .xcf\tGIMP graphic\n"
13782 #: build/C/man7/suffixes.7:266
13784 msgid " .xml\teXtended Markup Language file\n"
13788 #: build/C/man7/suffixes.7:267
13790 msgid " .xpm\tX11 pixmap source\n"
13794 #: build/C/man7/suffixes.7:268
13796 msgid " .xs\tPerl xsub file produced by h2xs\n"
13800 #: build/C/man7/suffixes.7:269
13802 msgid " .xsl\tXSL stylesheet\n"
13806 #: build/C/man7/suffixes.7:270
13808 msgid " .y\tB<yacc>(1) or B<bison>(1) (parser generator) files\n"
13812 #: build/C/man7/suffixes.7:271
13814 msgid " .z\tFile compressed using B<pack>(1) (or an old B<gzip>(1))\n"
13818 #: build/C/man7/suffixes.7:272
13820 msgid " .zip\tB<zip>(1) archive\n"
13824 #: build/C/man7/suffixes.7:273
13826 msgid " .zoo\tB<zoo>(1) archive\n"
13830 #: build/C/man7/suffixes.7:274
13832 msgid " ~\tEmacs or B<patch>(1) backup file\n"
13836 #: build/C/man7/suffixes.7:275
13838 msgid " rc\tstartup (`run control') file, e.g., I<.newsrc>\n"
13841 #. type: Plain text
13842 #: build/C/man7/suffixes.7:279
13843 msgid "General UNIX conventions."
13846 #. type: Plain text
13847 #: build/C/man7/suffixes.7:281
13848 msgid "This list is not exhaustive."
13851 #. type: Plain text
13852 #: build/C/man7/suffixes.7:284
13853 msgid "B<file>(1), B<make>(1)"
13857 #: build/C/man3/undocumented.3:29
13859 msgid "UNDOCUMENTED"
13863 #: build/C/man3/undocumented.3:29
13868 #. type: Plain text
13869 #: build/C/man3/undocumented.3:32
13870 msgid "none - undocumented library functions"
13873 #. type: Plain text
13874 #: build/C/man3/undocumented.3:34
13875 msgid "Undocumented library functions"
13878 #. type: Plain text
13879 #: build/C/man3/undocumented.3:37
13881 "This man page mentions those library functions which are implemented in the "
13882 "standard libraries but not yet documented in man pages."
13886 #: build/C/man3/undocumented.3:37
13888 msgid "Solicitation"
13891 #. type: Plain text
13892 #: build/C/man3/undocumented.3:43
13894 "If you have information about these functions, please look in the source "
13895 "code, write a man page (using a style similar to that of the other Linux "
13896 "section 3 man pages), and send it to B<mtk.manpages@gmail.com> for inclusion "
13897 "in the next man page release."
13901 #: build/C/man3/undocumented.3:43
13906 #. .BR chflags (3),
13907 #. .BR fattach (3),
13908 #. .BR fchflags (3),
13910 #. .BR fdetach (3),
13911 #. .BR obstack stuff (3),
13912 #. type: Plain text
13913 #: build/C/man3/undocumented.3:183
13915 "B<authdes_create>(3), B<authdes_getucred>(3), B<authdes_pk_create>(3), "
13916 "B<clntunix_create>(3), B<creat64>(3), B<dn_skipname>(3), B<fcrypt>(3), "
13917 "B<fp_nquery>(3), B<fp_query>(3), B<fp_resstat>(3), B<freading>(3), "
13918 "B<freopen64>(3), B<fseeko64>(3), B<ftello64>(3), B<ftw64>(3), B<fwscanf>(3), "
13919 "B<get_avphys_pages>(3), B<getdirentries64>(3), B<getmsg>(3), "
13920 "B<getnetname>(3), B<get_nprocs>(3), B<get_nprocs_conf>(3), "
13921 "B<get_phys_pages>(3), B<getpublickey>(3), B<getsecretkey>(3), "
13922 "B<h_errlist>(3), B<host2netname>(3), B<hostalias>(3), B<inet_nsap_addr>(3), "
13923 "B<inet_nsap_ntoa>(3), B<init_des>(3), B<libc_nls_init>(3), B<lio_listio>(3), "
13924 "B<mstats>(3), B<netname2host>(3), B<netname2user>(3), B<nlist>(3), "
13925 "B<obstack_free>(3), B<parse_printf_format>(3), B<p_cdname>(3), "
13926 "B<p_cdnname>(3), B<p_class>(3), B<p_fqname>(3), B<p_option>(3), "
13927 "B<p_query>(3), B<printf_size>(3), B<printf_size_info>(3), B<p_rr>(3), "
13928 "B<p_time>(3), B<p_type>(3), B<putlong>(3), B<putshort>(3), "
13929 "B<re_compile_fastmap>(3), B<re_compile_pattern>(3), "
13930 "B<register_printf_function>(3), B<re_match>(3), B<re_match_2>(3), "
13931 "B<re_rx_search>(3), B<re_search>(3), B<re_search_2>(3), "
13932 "B<re_set_registers>(3), B<re_set_syntax>(3), B<res_send_setqhook>(3), "
13933 "B<res_send_setrhook>(3), B<ruserpass>(3), B<setfileno>(3), "
13934 "B<sethostfile>(3), B<svc_exit>(3), B<svcudp_enablecache>(3), B<tell>(3), "
13935 "B<tr_break>(3), B<tzsetwall>(3), B<ufc_dofinalperm>(3), B<ufc_doit>(3), "
13936 "B<user2netname>(3), B<vlimit>(3), B<vtimes>(3), B<wcschrnul>(3), "
13937 "B<wcsftime>(3), B<wscanf>(3), B<xdr_authdes_cred>(3), "
13938 "B<xdr_authdes_verf>(3), B<xdr_cryptkeyarg>(3), B<xdr_cryptkeyres>(3), "
13939 "B<xdr_datum>(3), B<xdr_des_block>(3), B<xdr_domainname>(3), "
13940 "B<xdr_getcredres>(3), B<xdr_keybuf>(3), B<xdr_keystatus>(3), "
13941 "B<xdr_mapname>(3), B<xdr_netnamestr>(3), B<xdr_netobj>(3), B<xdr_passwd>(3), "
13942 "B<xdr_peername>(3), B<xdr_rmtcall_args>(3), B<xdr_rmtcallres>(3), "
13943 "B<xdr_unixcred>(3), B<xdr_yp_buf>(3), B<xdr_yp_inaddr>(3), "
13944 "B<xdr_ypbind_binding>(3), B<xdr_ypbind_resp>(3), B<xdr_ypbind_resptype>(3), "
13945 "B<xdr_ypbind_setdom>(3), B<xdr_ypdelete_args>(3), B<xdr_ypmaplist>(3), "
13946 "B<xdr_ypmaplist_str>(3), B<xdr_yppasswd>(3), B<xdr_ypreq_key>(3), "
13947 "B<xdr_ypreq_nokey>(3), B<xdr_ypresp_all>(3), B<xdr_ypresp_all_seq>(3), "
13948 "B<xdr_ypresp_key_val>(3), B<xdr_ypresp_maplist>(3), B<xdr_ypresp_master>(3), "
13949 "B<xdr_ypresp_order>(3), B<xdr_ypresp_val>(3), B<xdr_ypstat>(3), "
13950 "B<xdr_ypupdate_args>(3), B<yp_all>(3), B<yp_bind>(3), B<yperr_string>(3), "
13951 "B<yp_first>(3), B<yp_get_default_domain>(3), B<yp_maplist>(3), "
13952 "B<yp_master>(3), B<yp_match>(3), B<yp_next>(3), B<yp_order>(3), "
13953 "B<ypprot_err>(3), B<yp_unbind>(3), B<yp_update>(3)"
13957 #: build/C/man2/unimplemented.2:26
13959 msgid "UNIMPLEMENTED"
13963 #: build/C/man2/unimplemented.2:26
13968 #. type: Plain text
13969 #: build/C/man2/unimplemented.2:31
13971 "afs_syscall, break, fattach, fdetach, ftime, getmsg, getpmsg, gtty, "
13972 "isastream, lock, madvise1, mpx, prof, profil, putmsg, putpmsg, security, "
13973 "stty, tuxcall, ulimit, vserver - unimplemented system calls"
13976 #. type: Plain text
13977 #: build/C/man2/unimplemented.2:33
13978 msgid "Unimplemented system calls."
13981 #. type: Plain text
13982 #: build/C/man2/unimplemented.2:35
13983 msgid "These system calls are not implemented in the Linux kernel."
13986 #. type: Plain text
13987 #: build/C/man2/unimplemented.2:40
13988 msgid "These system calls always return -1 and set I<errno> to B<ENOSYS>."
13991 #. type: Plain text
13992 #: build/C/man2/unimplemented.2:47
13994 "Note that B<ftime>(3), B<profil>(3) and B<ulimit>(3) are implemented as "
13995 "library functions."
13998 #. type: Plain text
13999 #: build/C/man2/unimplemented.2:56
14001 "Some system calls, like B<alloc_hugepages>(2), B<free_hugepages>(2), "
14002 "B<ioperm>(2), B<iopl>(2), and B<vm86>(2) exist only on certain "
14006 #. type: Plain text
14007 #: build/C/man2/unimplemented.2:64
14009 "Some system calls, like B<ipc>(2), B<create_module>(2), B<init_module>(2), "
14010 "and B<delete_module>(2) exist only when the Linux kernel was built with "
14011 "support for them."
14014 #. type: Plain text
14015 #: build/C/man2/unimplemented.2:66
14016 msgid "B<syscalls>(2)"
14020 #: build/C/man7/units.7:26
14025 #. type: Plain text
14026 #: build/C/man7/units.7:29
14027 msgid "units, kilo, kibi, mega, mebi, giga, gibi - decimal and binary prefixes"
14031 #: build/C/man7/units.7:30
14033 msgid "Decimal prefixes"
14036 #. type: Plain text
14037 #: build/C/man7/units.7:34
14039 "The SI system of units uses prefixes that indicate powers of ten. A "
14040 "kilometer is 1000 meter, and a megawatt is 1000000 watt. Below the standard "
14045 #: build/C/man7/units.7:37 build/C/man7/units.7:79
14047 msgid "Prefix\tName\tValue\n"
14051 #: build/C/man7/units.7:38
14053 msgid "y\tyocto\t10^-24 = 0.000000000000000000000001\n"
14057 #: build/C/man7/units.7:39
14059 msgid "z\tzepto\t10^-21 = 0.000000000000000000001\n"
14063 #: build/C/man7/units.7:40
14065 msgid "a\tatto\t10^-18 = 0.000000000000000001\n"
14069 #: build/C/man7/units.7:41
14071 msgid "f\tfemto\t10^-15 = 0.000000000000001\n"
14075 #: build/C/man7/units.7:42
14077 msgid "p\tpico\t10^-12 = 0.000000000001\n"
14081 #: build/C/man7/units.7:43
14083 msgid "n\tnano\t10^-9 = 0.000000001\n"
14087 #: build/C/man7/units.7:44
14089 msgid "\\(mc\tmicro\t10^-6 = 0.000001\n"
14093 #: build/C/man7/units.7:45
14095 msgid "m\tmilli\t10^-3 = 0.001\n"
14099 #: build/C/man7/units.7:46
14101 msgid "c\tcenti\t10^-2 = 0.01\n"
14105 #: build/C/man7/units.7:47
14107 msgid "d\tdeci\t10^-1 = 0.1\n"
14111 #: build/C/man7/units.7:48
14113 msgid "da\tdeka\t10^ 1 = 10\n"
14117 #: build/C/man7/units.7:49
14119 msgid "h\thecto\t10^ 2 = 100\n"
14123 #: build/C/man7/units.7:50
14125 msgid "k\tkilo\t10^ 3 = 1000\n"
14129 #: build/C/man7/units.7:51
14131 msgid "M\tmega\t10^ 6 = 1000000\n"
14135 #: build/C/man7/units.7:52
14137 msgid "G\tgiga\t10^ 9 = 1000000000\n"
14141 #: build/C/man7/units.7:53
14143 msgid "T\ttera\t10^12 = 1000000000000\n"
14147 #: build/C/man7/units.7:54
14149 msgid "P\tpeta\t10^15 = 1000000000000000\n"
14153 #: build/C/man7/units.7:55
14155 msgid "E\texa\t10^18 = 1000000000000000000\n"
14159 #: build/C/man7/units.7:56
14161 msgid "Z\tzetta\t10^21 = 1000000000000000000000\n"
14165 #: build/C/man7/units.7:57
14167 msgid "Y\tyotta\t10^24 = 1000000000000000000000000\n"
14170 #. type: Plain text
14171 #: build/C/man7/units.7:64
14173 "The symbol for micro is the Greek letter mu, often written u in an ASCII "
14174 "context where this Greek letter is not available. See also"
14177 #. type: Plain text
14178 #: build/C/man7/units.7:68
14179 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/prefixes.html> E<.UE>"
14183 #: build/C/man7/units.7:69
14185 msgid "Binary prefixes"
14188 #. type: Plain text
14189 #: build/C/man7/units.7:76
14191 "The binary prefixes resemble the decimal ones, but have an additional "
14192 "\\(aqi\\(aq (and \"Ki\" starts with a capital \\(aqK\\(aq). The names are "
14193 "formed by taking the first syllable of the names of the decimal prefix with "
14194 "roughly the same size, followed by \"bi\" for \"binary\"."
14198 #: build/C/man7/units.7:80
14200 msgid "Ki\tkibi\t2^10 = 1024\n"
14204 #: build/C/man7/units.7:81
14206 msgid "Mi\tmebi\t2^20 = 1048576\n"
14210 #: build/C/man7/units.7:82
14212 msgid "Gi\tgibi\t2^30 = 1073741824\n"
14216 #: build/C/man7/units.7:83
14218 msgid "Ti\ttebi\t2^40 = 1099511627776\n"
14222 #: build/C/man7/units.7:84
14224 msgid "Pi\tpebi\t2^50 = 1125899906842624\n"
14228 #: build/C/man7/units.7:85
14230 msgid "Ei\texbi\t2^60 = 1152921504606846976\n"
14233 #. type: Plain text
14234 #: build/C/man7/units.7:90
14238 #. type: Plain text
14239 #: build/C/man7/units.7:93
14240 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/binary.html> E<.UE>"
14244 #: build/C/man7/units.7:93
14249 #. type: Plain text
14250 #: build/C/man7/units.7:98
14252 "Before these binary prefixes were introduced, it was fairly common to use "
14253 "k=1000 and K=1024, just like b=bit, B=byte. Unfortunately, the M is capital "
14254 "already, and cannot be capitalized to indicate binary-ness."
14257 #. type: Plain text
14258 #: build/C/man7/units.7:109
14260 "At first that didn't matter too much, since memory modules and disks came in "
14261 "sizes that were powers of two, so everyone knew that in such contexts "
14262 "\"kilobyte\" and \"megabyte\" meant 1024 and 1048576 bytes, respectively. "
14263 "What originally was a sloppy use of the prefixes \"kilo\" and \"mega\" "
14264 "started to become regarded as the \"real true meaning\" when computers were "
14265 "involved. But then disk technology changed, and disk sizes became arbitrary "
14266 "numbers. After a period of uncertainty all disk manufacturers settled on "
14267 "the standard, namely k=1000, M=1000k, G=1000M."
14270 #. also common: 14.4k modem
14271 #. type: Plain text
14272 #: build/C/man7/units.7:116
14274 "The situation was messy: in the 14k4 modems, k=1000; in the 1.44MB "
14275 "diskettes, M=1024000; etc. In 1998 the IEC approved the standard that "
14276 "defines the binary prefixes given above, enabling people to be precise and "
14280 #. type: Plain text
14281 #: build/C/man7/units.7:118
14282 msgid "Thus, today, MB = 1000000B and MiB = 1048576B."
14285 #. type: Plain text
14286 #: build/C/man7/units.7:122
14288 "In the free software world programs are slowly being changed to conform. "
14289 "When the Linux kernel boots and says"
14292 #. type: Plain text
14293 #: build/C/man7/units.7:126
14295 msgid "hda: 120064896 sectors (61473 MB) w/2048KiB Cache\n"
14298 #. type: Plain text
14299 #: build/C/man7/units.7:130
14300 msgid "the MB are megabytes and the KiB are kibibytes."
14303 #. Copyright (c) 1990, 1993
14304 #. The Regents of the University of California. All rights reserved.
14306 #. %%%LICENSE_START(BSD_4_CLAUSE_UCB)
14307 #. Redistribution and use in source and binary forms, with or without
14308 #. modification, are permitted provided that the following conditions
14310 #. 1. Redistributions of source code must retain the above copyright
14311 #. notice, this list of conditions and the following disclaimer.
14312 #. 2. Redistributions in binary form must reproduce the above copyright
14313 #. notice, this list of conditions and the following disclaimer in the
14314 #. documentation and/or other materials provided with the distribution.
14315 #. 3. All advertising materials mentioning features or use of this software
14316 #. must display the following acknowledgement:
14317 #. This product includes software developed by the University of
14318 #. California, Berkeley and its contributors.
14319 #. 4. Neither the name of the University nor the names of its contributors
14320 #. may be used to endorse or promote products derived from this software
14321 #. without specific prior written permission.
14323 #. THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
14324 #. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14325 #. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14326 #. ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
14327 #. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
14328 #. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
14329 #. OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
14330 #. HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
14331 #. LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
14332 #. OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
14336 #. @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
14337 #. $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $
14339 #. This tutorial sampler invokes every macro in the package several
14340 #. times and is guaranteed to give a worst case performance
14341 #. for an already extremely slow package.
14343 #. String \*(Pu was not defined, probably means punctuation
14345 #: build/C/man7/mdoc.samples.7:42
14347 msgid "[ .,:;()[]?! ]"
14351 #: build/C/man7/mdoc.samples.7:43
14353 msgid "December 30, 1993"
14357 #: build/C/man7/mdoc.samples.7:45
14359 msgid "MDOC.SAMPLES 7"
14362 #. type: Plain text
14363 #: build/C/man7/mdoc.samples.7:48
14364 msgid "E<.Nm mdoc.samples>"
14368 #: build/C/man7/mdoc.samples.7:48
14370 msgid "tutorial sampler for writing"
14373 #. type: Plain text
14374 #: build/C/man7/mdoc.samples.7:52
14375 msgid "E<.Bx> manuals with E<.Nm \\-mdoc>"
14378 #. type: Plain text
14379 #: build/C/man7/mdoc.samples.7:54
14380 msgid "E<.Nm man mdoc.samples>"
14383 #. type: Plain text
14384 #: build/C/man7/mdoc.samples.7:100
14386 "A tutorial sampler for writing E<.Bx> manual pages with the E<.Nm \\-mdoc> "
14387 "macro package, a E<.Em content Ns \\-based> and E<.Em domain Ns \\-based> "
14388 "formatting package for E<.Xr troff 1>. Its predecessor, the E<.Xr \\-man 7> "
14389 "package, addressed page layout leaving the manipulation of fonts and other "
14390 "typesetting details to the individual author. In E<.Nm \\-mdoc>, page "
14391 "layout macros make up the E<.Em \"page structure domain\"> which consists of "
14392 "macros for titles, section headers, displays and lists. Essentially items "
14393 "which affect the physical position of text on a formatted page. In addition "
14394 "to the page structure domain, there are two more domains, the manual domain "
14395 "and the general text domain. The general text domain is defined as macros "
14396 "which perform tasks such as quoting or emphasizing pieces of text. The "
14397 "manual domain is defined as macros that are a subset of the day to day "
14398 "informal language used to describe commands, routines and related E<.Bx> "
14399 "files. Macros in the manual domain handle command names, command-line "
14400 "arguments and options, function names, function parameters, pathnames, "
14401 "variables, cross references to other manual pages, and so on. These domain "
14402 "items have value for both the author and the future user of the manual "
14403 "page. It is hoped the consistency gained across the manual set will provide "
14404 "easier translation to future documentation tools."
14407 #. type: Plain text
14408 #: build/C/man7/mdoc.samples.7:107
14410 "Throughout the E<.Ux> manual pages, a manual entry is simply referred to as "
14411 "a man page, regardless of actual length and without sexist intention."
14415 #: build/C/man7/mdoc.samples.7:107
14417 msgid "GETTING STARTED"
14420 #. type: Plain text
14421 #: build/C/man7/mdoc.samples.7:113
14423 "Since a tutorial document is normally read when a person desires to use the "
14424 "material immediately, the assumption has been made that the user of this "
14425 "document may be impatient. The material presented in the remained of this "
14426 "document is outlined as follows:"
14429 #. type: Plain text
14430 #: build/C/man7/mdoc.samples.7:116
14431 msgid "E<.Tn \"TROFF IDIOSYNCRASIES\">"
14435 #: build/C/man7/mdoc.samples.7:117
14437 msgid "\"Macro Usage\" ."
14441 #: build/C/man7/mdoc.samples.7:118
14443 msgid "\"Passing Space Characters in an Argument\" ."
14447 #: build/C/man7/mdoc.samples.7:119
14449 msgid "\"Trailing Blank Space Characters (a warning)\" ."
14453 #: build/C/man7/mdoc.samples.7:120
14455 msgid "\"Escaping Special Characters\" ."
14458 #. type: Plain text
14459 #: build/C/man7/mdoc.samples.7:124
14460 msgid "E<.Tn \"THE ANATOMY OF A MAN PAGE\">"
14464 #: build/C/man7/mdoc.samples.7:125
14466 msgid "\"A manual page template\" ."
14469 #. type: Plain text
14470 #: build/C/man7/mdoc.samples.7:129
14471 msgid "E<.Tn \"TITLE MACROS\">."
14474 #. type: Plain text
14475 #: build/C/man7/mdoc.samples.7:131
14476 msgid "E<.Tn \"INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS\">."
14480 #: build/C/man7/mdoc.samples.7:132
14482 msgid "\"What's in a name...\" ."
14486 #: build/C/man7/mdoc.samples.7:133
14488 msgid "\"General Syntax\" ."
14491 #. type: Plain text
14492 #: build/C/man7/mdoc.samples.7:137
14493 msgid "E<.Tn \"MANUAL DOMAIN\">"
14497 #: build/C/man7/mdoc.samples.7:138
14499 msgid "Addresses ."
14503 #: build/C/man7/mdoc.samples.7:139
14505 msgid "\"Author name\" ."
14509 #: build/C/man7/mdoc.samples.7:140
14511 msgid "Arguments ."
14515 #: build/C/man7/mdoc.samples.7:141
14517 msgid "\"Configuration Declarations (section four only)\" ."
14521 #: build/C/man7/mdoc.samples.7:142
14523 msgid "\"Command Modifier\" ."
14527 #: build/C/man7/mdoc.samples.7:143
14529 msgid "\"Defined Variables\" ."
14533 #: build/C/man7/mdoc.samples.7:144
14535 msgid "\"Errno's (Section two only)\" ."
14539 #: build/C/man7/mdoc.samples.7:145
14541 msgid "\"Environment Variables\" ."
14545 #: build/C/man7/mdoc.samples.7:146
14547 msgid "\"Function Argument\" ."
14551 #: build/C/man7/mdoc.samples.7:147
14553 msgid "\"Function Declaration\" ."
14557 #: build/C/man7/mdoc.samples.7:148
14563 #: build/C/man7/mdoc.samples.7:149
14565 msgid "\"Functions (library routines)\" ."
14569 #: build/C/man7/mdoc.samples.7:150
14571 msgid "\"Function Types\" ."
14574 #. .It "Header File (including source code)" .
14576 #: build/C/man7/mdoc.samples.7:152
14578 msgid "\"Interactive Commands\" ."
14582 #: build/C/man7/mdoc.samples.7:153
14588 #: build/C/man7/mdoc.samples.7:154
14594 #: build/C/man7/mdoc.samples.7:155
14596 msgid "Pathnames ."
14600 #: build/C/man7/mdoc.samples.7:156
14602 msgid "Variables ."
14606 #: build/C/man7/mdoc.samples.7:157
14608 msgid "\"Cross References\" ."
14611 #. type: Plain text
14612 #: build/C/man7/mdoc.samples.7:161
14613 msgid "E<.Tn \"GENERAL TEXT DOMAIN\">"
14617 #: build/C/man7/mdoc.samples.7:162
14619 msgid "\"AT&T Macro\" ."
14623 #: build/C/man7/mdoc.samples.7:163
14625 msgid "\"BSD Macro\" ."
14629 #: build/C/man7/mdoc.samples.7:164
14631 msgid "\"FreeBSD Macro\" ."
14635 #: build/C/man7/mdoc.samples.7:165
14637 msgid "\"UNIX Macro\" ."
14641 #: build/C/man7/mdoc.samples.7:166
14643 msgid "Enclosure/Quoting Macros"
14647 #: build/C/man7/mdoc.samples.7:168
14649 msgid "\"Angle Bracket Quote/Enclosure\" ."
14653 #: build/C/man7/mdoc.samples.7:169
14655 msgid "\"Bracket Quotes/Enclosure\" ."
14659 #: build/C/man7/mdoc.samples.7:170
14661 msgid "\"Double Quote macro/Enclosure\" ."
14665 #: build/C/man7/mdoc.samples.7:171
14667 msgid "\"Parenthesis Quote/Enclosure\" ."
14671 #: build/C/man7/mdoc.samples.7:172
14673 msgid "\"Single Quotes/Enclosure\" ."
14677 #: build/C/man7/mdoc.samples.7:173
14679 msgid "\"Prefix Macro\" ."
14683 #: build/C/man7/mdoc.samples.7:175
14685 msgid "\"No\\-Op or Normal Text Macro\" ."
14689 #: build/C/man7/mdoc.samples.7:176
14691 msgid "\"No Space Macro\" ."
14695 #: build/C/man7/mdoc.samples.7:177
14697 msgid "\"Section Cross References\" ."
14701 #: build/C/man7/mdoc.samples.7:178
14703 msgid "\"References and Citations\" ."
14707 #: build/C/man7/mdoc.samples.7:179
14709 msgid "Return Values (sections two and three only)"
14713 #: build/C/man7/mdoc.samples.7:180
14715 msgid "\"Trade Names (Acronyms and Type Names)\" ."
14719 #: build/C/man7/mdoc.samples.7:181
14721 msgid "\"Extended Arguments\" ."
14724 #. type: Plain text
14725 #: build/C/man7/mdoc.samples.7:185
14726 msgid "E<.Tn \"PAGE STRUCTURE DOMAIN\">"
14730 #: build/C/man7/mdoc.samples.7:186
14732 msgid "\"Section Headers\" ."
14736 #: build/C/man7/mdoc.samples.7:187
14738 msgid "\"Paragraphs and Line Spacing\" ."
14742 #: build/C/man7/mdoc.samples.7:188
14748 #: build/C/man7/mdoc.samples.7:189
14754 #: build/C/man7/mdoc.samples.7:190
14756 msgid "\"Font Modes (Emphasis, Literal, and Symbolic)\" ."
14760 #: build/C/man7/mdoc.samples.7:191
14762 msgid "\"Lists and Columns\" ."
14765 #. type: Plain text
14766 #: build/C/man7/mdoc.samples.7:195
14767 msgid "E<.Tn \"PREDEFINED STRINGS\">"
14770 #. type: Plain text
14771 #: build/C/man7/mdoc.samples.7:197
14772 msgid "E<.Tn \"DIAGNOSTICS\">"
14775 #. type: Plain text
14776 #: build/C/man7/mdoc.samples.7:199
14777 msgid "E<.Tn \"FORMATTING WITH GROFF, TROFF AND NROFF\">"
14780 #. type: Plain text
14781 #: build/C/man7/mdoc.samples.7:201
14782 msgid "E<.Tn \"BUGS\">"
14786 #: build/C/man7/mdoc.samples.7:203
14788 msgid "TROFF IDIOSYNCRASIES"
14791 #. type: Plain text
14792 #: build/C/man7/mdoc.samples.7:217
14794 "The E<.Nm \\-mdoc> package attempts to simplify the process of writing a man "
14795 "page. Theoretically, one should not have to learn the dirty details of "
14796 "E<.Xr troff 1> to use E<.Nm \\-mdoc>; however, there are a few limitations "
14797 "which are unavoidable and best gotten out of the way. And, too, be "
14798 "forewarned, this package is E<.Em not> fast."
14802 #: build/C/man7/mdoc.samples.7:217
14804 msgid "Macro Usage"
14807 #. type: Plain text
14808 #: build/C/man7/mdoc.samples.7:242
14810 "As in E<.Xr troff 1>, a macro is called by placing a E<.Ql \\&.> (dot "
14811 "character) at the beginning of a line followed by the two character name "
14812 "for the macro. Arguments may follow the macro separated by spaces. It is "
14813 "the dot character at the beginning of the line which causes E<.Xr troff 1> "
14814 "to interpret the next two characters as a macro name. To place a E<.Ql "
14815 "\\&.> (dot character) at the beginning of a line in some context other than "
14816 "a macro invocation, precede the E<.Ql \\&.> (dot) with the E<.Ql \\e&> "
14817 "escape sequence. The E<.Ql \\e&> translates literally to a zero width "
14818 "space, and is never displayed in the output."
14821 #. type: Plain text
14822 #: build/C/man7/mdoc.samples.7:257
14824 "In general, E<.Xr troff 1> macros accept up to nine arguments, any extra "
14825 "arguments are ignored. Most macros in E<.Nm \\-mdoc> accept nine arguments "
14826 "and, in limited cases, arguments may be continued or extended on the next "
14827 "line (See E<.Sx Extensions>). A few macros handle quoted arguments (see "
14828 "E<.Sx Passing Space Characters in an Argument> below)."
14831 #. type: Plain text
14832 #: build/C/man7/mdoc.samples.7:284
14834 "Most of the E<.Nm \\-mdoc> general text domain and manual domain macros are "
14835 "special in that their argument lists are E<.Em parsed> for callable macro "
14836 "names. This means an argument on the argument list which matches a general "
14837 "text or manual domain macro name and is determined to be callable will be "
14838 "executed or called when it is processed. In this case the argument, "
14839 "although the name of a macro, is not preceded by a E<.Ql \\&.> (dot). It is "
14840 "in this manner that many macros are nested; for example the option macro, "
14841 "E<.Ql \\&.Op>, may E<.Em call> the flag and argument macros, E<.Ql \\&Fl> "
14842 "and E<.Ql \\&Ar>, to specify an optional flag with an argument:"
14846 #: build/C/man7/mdoc.samples.7:285
14848 msgid "Op Fl s Ar bytes"
14851 #. type: Plain text
14852 #: build/C/man7/mdoc.samples.7:288
14853 msgid "is produced by E<.Li \\&.Op \\&Fl s \\&Ar bytes>"
14856 #. type: Plain text
14857 #: build/C/man7/mdoc.samples.7:295
14859 "To prevent a two character string from being interpreted as a macro name, "
14860 "precede the string with the escape sequence E<.Ql \\e&>:"
14864 #: build/C/man7/mdoc.samples.7:296
14866 msgid "Op \\&Fl s \\&Ar bytes"
14869 #. type: Plain text
14870 #: build/C/man7/mdoc.samples.7:299
14871 msgid "is produced by E<.Li \\&.Op \\e&Fl s \\e&Ar bytes>"
14874 #. type: Plain text
14875 #: build/C/man7/mdoc.samples.7:320
14877 "Here the strings E<.Ql \\&Fl> and E<.Ql \\&Ar> are not interpreted as "
14878 "macros. Macros whose argument lists are parsed for callable arguments are "
14879 "referred to as parsed and macros which may be called from an argument list "
14880 "are referred to as callable throughout this document and in the companion "
14881 "quick reference manual E<.Xr mdoc 7>. This is a technical E<.Em faux pas> "
14882 "as almost all of the macros in E<.Nm \\-mdoc> are parsed, but as it was "
14883 "cumbersome to constantly refer to macros as being callable and being able to "
14884 "call other macros, the term parsed has been used."
14888 #: build/C/man7/mdoc.samples.7:320
14890 msgid "Passing Space Characters in an Argument"
14893 #. type: Plain text
14894 #: build/C/man7/mdoc.samples.7:338
14896 "Sometimes it is desirable to give as one argument a string containing one or "
14897 "more blank space characters. This may be necessary to defeat the nine "
14898 "argument limit or to specify arguments to macros which expect particular "
14899 "arrangement of items in the argument list. For example, the function macro "
14900 "E<.Ql \\&.Fn> expects the first argument to be the name of a function and "
14901 "any remaining arguments to be function parameters. As E<.Tn \"ANSI C\"> "
14902 "stipulates the declaration of function parameters in the parenthesized "
14903 "parameter list, each parameter is guaranteed to be at minimum a two word "
14904 "string. For example, E<.Fa int foo>."
14907 #. type: Plain text
14908 #: build/C/man7/mdoc.samples.7:353
14910 "There are two possible ways to pass an argument which contains an embedded "
14911 "space. E<.Em Implementation note>: Unfortunately, the most convenient way "
14912 "of passing spaces in between quotes by reassigning individual arguments "
14913 "before parsing was fairly expensive speed wise and space wise to implement "
14914 "in all the macros for E<.Tn AT&T> E<.Xr troff>. It is not expensive for "
14915 "E<.Xr groff> but for the sake of portability, has been limited to the "
14916 "following macros which need it the most:"
14920 #: build/C/man7/mdoc.samples.7:355
14925 #. type: Plain text
14926 #: build/C/man7/mdoc.samples.7:358
14927 msgid "Configuration declaration (section 4 E<.Sx SYNOPSIS>)"
14931 #: build/C/man7/mdoc.samples.7:358
14936 #. type: Plain text
14937 #: build/C/man7/mdoc.samples.7:360
14938 msgid "Begin list (for the width specifier)."
14942 #: build/C/man7/mdoc.samples.7:360
14947 #. type: Plain text
14948 #: build/C/man7/mdoc.samples.7:362
14949 msgid "Emphasized text."
14953 #: build/C/man7/mdoc.samples.7:362
14958 #. type: Plain text
14959 #: build/C/man7/mdoc.samples.7:364
14960 msgid "Functions (sections two and four)."
14964 #: build/C/man7/mdoc.samples.7:364
14969 #. type: Plain text
14970 #: build/C/man7/mdoc.samples.7:366
14971 msgid "List items."
14975 #: build/C/man7/mdoc.samples.7:366
14980 #. type: Plain text
14981 #: build/C/man7/mdoc.samples.7:368
14982 msgid "Literal text."
14986 #: build/C/man7/mdoc.samples.7:368
14991 #. type: Plain text
14992 #: build/C/man7/mdoc.samples.7:370
14993 msgid "Symbolic text."
14997 #: build/C/man7/mdoc.samples.7:370
15002 #. type: Plain text
15003 #: build/C/man7/mdoc.samples.7:372
15004 msgid "Book titles."
15008 #: build/C/man7/mdoc.samples.7:372
15013 #. type: Plain text
15014 #: build/C/man7/mdoc.samples.7:374
15015 msgid "Journal names."
15019 #: build/C/man7/mdoc.samples.7:374
15024 #. type: Plain text
15025 #: build/C/man7/mdoc.samples.7:376
15026 msgid "Optional notes for a reference."
15030 #: build/C/man7/mdoc.samples.7:376
15035 #. type: Plain text
15036 #: build/C/man7/mdoc.samples.7:378
15037 msgid "Report title (in a reference)."
15041 #: build/C/man7/mdoc.samples.7:378
15046 #. type: Plain text
15047 #: build/C/man7/mdoc.samples.7:380
15048 msgid "Title of article in a book or journal."
15051 #. type: Plain text
15052 #: build/C/man7/mdoc.samples.7:397
15054 "One way of passing a string containing blank spaces is to use the hard or "
15055 "unpaddable space character E<.Ql \\e\\ >, that is, a blank space preceded by "
15056 "the escape character E<.Ql \\e>. This method may be used with any macro but "
15057 "has the side effect of interfering with the adjustment of text over the "
15058 "length of a line. E<.Xr Troff> sees the hard space as if it were any other "
15059 "printable character and cannot split the string into blank or newline "
15060 "separated pieces as one would expect. The method is useful for strings "
15061 "which are not expected to overlap a line boundary. For example:"
15065 #: build/C/man7/mdoc.samples.7:398
15067 msgid "Fn fetch char\\ *str"
15070 #. type: Plain text
15071 #: build/C/man7/mdoc.samples.7:401
15072 msgid "is created by E<.Ql \\&.Fn fetch char\\e *str>"
15076 #: build/C/man7/mdoc.samples.7:401
15078 msgid "Fn fetch \"char *str\""
15081 #. type: Plain text
15082 #: build/C/man7/mdoc.samples.7:404
15083 msgid "can also be created by E<.Ql \\&.Fn fetch \"\\*qchar *str\\*q\">"
15086 #. type: Plain text
15087 #: build/C/man7/mdoc.samples.7:413
15089 "If the E<.Ql \\e> or quotes were omitted, E<.Ql \\&.Fn> would see three "
15090 "arguments and the result would be:"
15094 #: build/C/man7/mdoc.samples.7:414
15096 msgid "Fn fetch char *str"
15099 #. type: Plain text
15100 #: build/C/man7/mdoc.samples.7:420
15102 "For an example of what happens when the parameter list overlaps a newline "
15103 "boundary, see the E<.Sx BUGS> section."
15107 #: build/C/man7/mdoc.samples.7:420
15109 msgid "Trailing Blank Space Characters"
15112 #. type: Plain text
15113 #: build/C/man7/mdoc.samples.7:433
15115 "E<.Xr Troff> can be confused by blank space characters at the end of a "
15116 "line. It is a wise preventive measure to globally remove all blank spaces "
15117 "from E<lt>blank-spaceE<gt>E<lt>end-of-lineE<gt> character sequences. Should "
15118 "the need arise to force a blank character at the end of a line, it may be "
15119 "forced with an unpaddable space and the E<.Ql \\e&> escape character. For "
15120 "example, E<.Ql string\\e\\ \\e&>."
15124 #: build/C/man7/mdoc.samples.7:433
15126 msgid "Escaping Special Characters"
15129 #. type: Plain text
15130 #: build/C/man7/mdoc.samples.7:445
15132 "Special characters like the newline character E<.Ql \\en>, are handled by "
15133 "replacing the E<.Ql \\e> with E<.Ql \\ee> (e.g., E<.Ql \\een>) to preserve "
15138 #: build/C/man7/mdoc.samples.7:445
15140 msgid "THE ANATOMY OF A MAN PAGE"
15143 #. type: Plain text
15144 #: build/C/man7/mdoc.samples.7:452
15146 "The body of a man page is easily constructed from a basic template found in "
15147 "the file E<.Pa /usr/share/misc/mdoc.template>. Several example man pages "
15148 "can also be found in E<.Pa /usr/share/examples/mdoc>."
15152 #: build/C/man7/mdoc.samples.7:453
15154 msgid "A manual page template"
15157 #. type: Plain text
15158 #: build/C/man7/mdoc.samples.7:484
15161 "\\&.\\e\" The following requests are required for all man pages.\n"
15162 "\\&.Dd Month day, year\n"
15163 "\\&.Os OPERATING_SYSTEM [version/release]\n"
15164 "\\&.Dt DOCUMENT_TITLE [section number] [volume]\n"
15167 "\\&.Nd one line description of name\n"
15168 "\\&.Sh SYNOPSIS\n"
15169 "\\&.Sh DESCRIPTION\n"
15170 "\\&.\\e\" The following requests should be uncommented and\n"
15171 "\\&.\\e\" used where appropriate. This next request is\n"
15172 "\\&.\\e\" for sections 2 and 3 function return values only.\n"
15173 "\\&.\\e\" .Sh RETURN VALUE\n"
15174 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
15175 "\\&.\\e\" .Sh ENVIRONMENT\n"
15176 "\\&.\\e\" .Sh FILES\n"
15177 "\\&.\\e\" .Sh EXAMPLES\n"
15178 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
15179 "\\&.\\e\" (command return values (to shell) and\n"
15180 "\\&.\\e\"\t fprintf/stderr type diagnostics)\n"
15181 "\\&.\\e\" .Sh DIAGNOSTICS\n"
15182 "\\&.\\e\" The next request is for sections 2 and 3 error\n"
15183 "\\&.\\e\" and signal handling only.\n"
15184 "\\&.\\e\" .Sh ERRORS\n"
15185 "\\&.\\e\" .Sh SEE ALSO\n"
15186 "\\&.\\e\" .Sh CONFORMING TO\n"
15187 "\\&.\\e\" .Sh HISTORY\n"
15188 "\\&.\\e\" .Sh AUTHORS\n"
15189 "\\&.\\e\" .Sh BUGS\n"
15192 #. type: Plain text
15193 #: build/C/man7/mdoc.samples.7:498
15195 "The first items in the template are the macros E<.Pq Li \\&.Dd , \\&.Os , "
15196 "\\&.Dt>; the document date, the operating system the man page or subject "
15197 "source is developed or modified for, and the man page title E<.Pq Em in "
15198 "upper case> along with the section of the manual the page belongs in. These "
15199 "macros identify the page, and are discussed below in E<.Sx TITLE MACROS>."
15202 #. type: Plain text
15203 #: build/C/man7/mdoc.samples.7:517
15205 "The remaining items in the template are section headers E<.Pq Li \\&.Sh>; of "
15206 "which E<.Sx NAME>, E<.Sx SYNOPSIS> and E<.Sx DESCRIPTION> are mandatory. "
15207 "The headers are discussed in E<.Sx PAGE STRUCTURE DOMAIN>, after "
15208 "presentation of E<.Sx MANUAL DOMAIN>. Several content macros are used to "
15209 "demonstrate page layout macros; reading about content macros before page "
15210 "layout macros is recommended."
15214 #: build/C/man7/mdoc.samples.7:517
15216 msgid "TITLE MACROS"
15219 #. type: Plain text
15220 #: build/C/man7/mdoc.samples.7:526
15222 "The title macros are the first portion of the page structure domain, but are "
15223 "presented first and separate for someone who wishes to start writing a man "
15224 "page yesterday. Three header macros designate the document title or manual "
15225 "page title, the operating system, and the date of authorship. These macros "
15226 "are one called once at the very beginning of the document and are used to "
15227 "construct the headers and footers only."
15231 #: build/C/man7/mdoc.samples.7:527
15233 msgid "Li \\&.Dt DOCUMENT_TITLE section# [volume]"
15237 #. USD UNIX User's Supplementary Documents
15239 #. PS1 UNIX Programmer's Supplementary Documents
15240 #. type: Plain text
15241 #: build/C/man7/mdoc.samples.7:541
15243 "The document title is the subject of the man page and must be in E<.Tn "
15244 "CAPITALS> due to troff limitations. The section number may be 1,\\ ...,\\ "
15245 "8, and if it is specified, the volume title may be omitted. A volume title "
15246 "may be arbitrary or one of the following:"
15250 #: build/C/man7/mdoc.samples.7:543
15252 msgid "Li \"AMD\tUNIX Ancestral Manual Documents\""
15256 #: build/C/man7/mdoc.samples.7:544
15258 msgid "Li \"SMM\tUNIX System Manager's Manual\""
15262 #: build/C/man7/mdoc.samples.7:545
15264 msgid "Li \"URM\tUNIX Reference Manual\""
15268 #: build/C/man7/mdoc.samples.7:546
15270 msgid "Li \"PRM\tUNIX Programmer's Manual\""
15274 #. MMI UNIX Manual Master Index
15276 #. CON UNIX Contributed Software Manual
15278 #. LOC UNIX Local Manual
15279 #. type: Plain text
15280 #: build/C/man7/mdoc.samples.7:562
15282 "The default volume labeling is E<.Li URM> for sections 1, 6, and 7; E<.Li "
15283 "SMM> for section 8; E<.Li PRM> for sections 2, 3, 4, and 5."
15287 #: build/C/man7/mdoc.samples.7:562
15289 msgid "Li \\&.Os operating_system release#"
15292 #. type: Plain text
15293 #: build/C/man7/mdoc.samples.7:575
15295 "The name of the operating system should be the common acronym, for example, "
15296 "E<.Tn BSD> or E<.Tn FreeBSD> or E<.Tn ATT>. The release should be the "
15297 "standard release nomenclature for the system specified, for example, 4.3, "
15298 "4.3+Tahoe, V.3, V.4. Unrecognized arguments are displayed as given in the "
15299 "page footer. For instance, a typical footer might be:"
15303 #: build/C/man7/mdoc.samples.7:576
15305 msgid "\\&.Os 4.3BSD"
15308 #. type: Plain text
15309 #: build/C/man7/mdoc.samples.7:579
15314 #: build/C/man7/mdoc.samples.7:579
15316 msgid "\\&.Os FreeBSD 2.2"
15319 #. type: Plain text
15320 #: build/C/man7/mdoc.samples.7:582
15321 msgid "or for a locally produced set"
15325 #: build/C/man7/mdoc.samples.7:583
15327 msgid "\\&.Os CS Department"
15330 #. type: Plain text
15331 #: build/C/man7/mdoc.samples.7:598
15333 "The Berkeley default, E<.Ql \\&.Os> without an argument, has been defined as "
15334 "E<.Tn BSD> in the site-specific file E<.Pa "
15335 "/usr/share/tmac/mdoc/doc-common>. It really should default to E<.Tn "
15336 "LOCAL>. Note, if the E<.Ql \\&.Os> macro is not present, the bottom left "
15337 "corner of the page will be ugly."
15341 #: build/C/man7/mdoc.samples.7:598
15343 msgid "Li \\&.Dd month day, year"
15346 #. type: Plain text
15347 #: build/C/man7/mdoc.samples.7:600
15348 msgid "The date should be written formally:"
15352 #: build/C/man7/mdoc.samples.7:602
15354 msgid "January 25, 1989"
15358 #: build/C/man7/mdoc.samples.7:604
15360 msgid "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
15364 #: build/C/man7/mdoc.samples.7:605
15366 msgid "What's in a name..."
15369 #. type: Plain text
15370 #: build/C/man7/mdoc.samples.7:622
15372 "The manual domain macro names are derived from the day to day informal "
15373 "language used to describe commands, subroutines and related files. Slightly "
15374 "different variations of this language are used to describe the three "
15375 "different aspects of writing a man page. First, there is the description of "
15376 "E<.Nm \\-mdoc> macro request usage. Second is the description of a E<.Ux> "
15377 "command E<.Em with> E<.Nm \\-mdoc> macros and third, the description of a "
15378 "command to a user in the verbal sense; that is, discussion of a command in "
15379 "the text of a man page."
15382 #. type: Plain text
15383 #: build/C/man7/mdoc.samples.7:627
15385 "In the first case, E<.Xr troff 1> macros are themselves a type of command; "
15386 "the general syntax for a troff command is:"
15389 #. type: Plain text
15390 #: build/C/man7/mdoc.samples.7:629
15392 msgid "\\&.Va argument1 argument2 ... argument9\n"
15395 #. type: Plain text
15396 #: build/C/man7/mdoc.samples.7:643
15398 "The E<.Ql \\&.Va> is a macro command or request, and anything following it "
15399 "is an argument to be processed. In the second case, the description of a "
15400 "E<.Ux> command using the content macros is a bit more involved; a typical "
15401 "E<.Sx SYNOPSIS> command line might be displayed as:"
15404 #. type: Plain text
15405 #: build/C/man7/mdoc.samples.7:647
15410 "E<.Ar infile outfile>\n"
15413 #. type: Plain text
15414 #: build/C/man7/mdoc.samples.7:667
15416 "Here, E<.Nm filter> is the command name and the bracketed string E<.Fl flag> "
15417 "is a E<.Em flag> argument designated as optional by the option brackets. In "
15418 "E<.Nm \\-mdoc> terms, E<.Ar infile> and E<.Ar outfile> are called E<.Em "
15419 "arguments>. The macros which formatted the above example:"
15422 #. type: Plain text
15423 #: build/C/man7/mdoc.samples.7:671
15427 "\\&.Op \\&Fl flag\n"
15428 "\\&.Ar infile outfile\n"
15431 #. type: Plain text
15432 #: build/C/man7/mdoc.samples.7:685
15434 "In the third case, discussion of commands and command syntax includes both "
15435 "examples above, but may add more detail. The arguments E<.Ar infile> and "
15436 "E<.Ar outfile> from the example above might be referred to as E<.Em "
15437 "operands> or E<.Em file arguments>. Some command-line argument lists are "
15442 #: build/C/man7/mdoc.samples.7:686
15447 #. type: Plain text
15448 #: build/C/man7/mdoc.samples.7:699
15450 "E<.Op Fl eiknqrstv> E<.Op Fl D Ar variable> E<.Op Fl d Ar flags> E<.Op Fl f "
15451 "Ar makefile> E<.Bk -words> E<.Op Fl I Ar directory> E<.Ek> E<.Op Fl j Ar "
15452 "max_jobs> E<.Op Ar variable=value> E<.Bk -words> E<.Op Ar target ...> E<.Ek>"
15455 #. type: Plain text
15456 #: build/C/man7/mdoc.samples.7:725
15458 "Here one might talk about the command E<.Nm make> and qualify the argument "
15459 "E<.Ar makefile>, as an argument to the flag, E<.Fl f>, or discuss the "
15460 "optional file operand E<.Ar target>. In the verbal context, such detail can "
15461 "prevent confusion, however the E<.Nm \\-mdoc> package does not have a macro "
15462 "for an argument E<.Em to> a flag. Instead the E<.Ql \\&Ar> argument macro "
15463 "is used for an operand or file argument like E<.Ar target> as well as an "
15464 "argument to a flag like E<.Ar variable>. The make command line was produced "
15468 #. type: Plain text
15469 #: build/C/man7/mdoc.samples.7:737
15473 "\\&.Op Fl eiknqrstv\n"
15474 "\\&.Op Fl D Ar variable\n"
15475 "\\&.Op Fl d Ar flags\n"
15476 "\\&.Op Fl f Ar makefile\n"
15477 "\\&.Op Fl I Ar directory\n"
15478 "\\&.Op Fl j Ar max_jobs\n"
15479 "\\&.Op Ar variable=value\n"
15481 "\\&.Op Ar target ...\n"
15485 #. type: Plain text
15486 #: build/C/man7/mdoc.samples.7:745
15487 msgid "The E<.Ql \\&.Bk> and E<.Ql \\&.Ek> macros are explained in E<.Sx Keeps>."
15491 #: build/C/man7/mdoc.samples.7:745
15493 msgid "General Syntax"
15496 #. type: Plain text
15497 #: build/C/man7/mdoc.samples.7:768
15499 "The manual domain and general text domain macros share a similar syntax with "
15500 "a few minor deviations: E<.Ql \\&.Ar>, E<.Ql \\&.Fl>, E<.Ql \\&.Nm>, and "
15501 "E<.Ql \\&.Pa> differ only when called without arguments; E<.Ql \\&.Fn> and "
15502 "E<.Ql \\&.Xr> impose an order on their argument lists and the E<.Ql \\&.Op> "
15503 "and E<.Ql \\&.Fn> macros have nesting limitations. All content macros are "
15504 "capable of recognizing and properly handling punctuation, provided each "
15505 "punctuation character is separated by a leading space. If a request is "
15510 #: build/C/man7/mdoc.samples.7:769
15512 msgid "\\&.Li sptr, ptr),"
15515 #. type: Plain text
15516 #: build/C/man7/mdoc.samples.7:772 build/C/man7/mdoc.samples.7:782
15517 msgid "The result is:"
15521 #: build/C/man7/mdoc.samples.7:773
15523 msgid "Li sptr, ptr),"
15526 #. type: Plain text
15527 #: build/C/man7/mdoc.samples.7:778
15529 "The punctuation is not recognized and all is output in the literal font. If "
15530 "the punctuation is separated by a leading white space:"
15534 #: build/C/man7/mdoc.samples.7:779
15536 msgid "\\&.Li \"sptr , ptr ) ,\""
15540 #: build/C/man7/mdoc.samples.7:783
15542 msgid "Li sptr , ptr ) ,"
15545 #. type: Plain text
15546 #: build/C/man7/mdoc.samples.7:787
15548 "The punctuation is now recognized and is output in the default font "
15549 "distinguishing it from the strings in literal font."
15552 #. type: Plain text
15553 #: build/C/man7/mdoc.samples.7:796
15555 "To remove the special meaning from a punctuation character escape it with "
15556 "E<.Ql \\e&>. E<.Xr Troff> is limited as a macro language, and has "
15557 "difficulty when presented with a string containing a member of the "
15558 "mathematical, logical or quotation set:"
15561 #. type: Plain text
15562 #: build/C/man7/mdoc.samples.7:798
15564 msgid "\\&{+,\\-,/,*,\\&%,E<lt>,E<gt>,E<lt>=,E<gt>=,=,==,&,`,',\"}\n"
15567 #. type: Plain text
15568 #: build/C/man7/mdoc.samples.7:810
15570 "The problem is that E<.Xr troff> may assume it is supposed to actually "
15571 "perform the operation or evaluation suggested by the characters. To prevent "
15572 "the accidental evaluation of these characters, escape them with E<.Ql "
15573 "\\e&>. Typical syntax is shown in the first content macro displayed below, "
15578 #: build/C/man7/mdoc.samples.7:810
15580 msgid "MANUAL DOMAIN"
15584 #: build/C/man7/mdoc.samples.7:811
15586 msgid "Address Macro"
15589 #. type: Plain text
15590 #: build/C/man7/mdoc.samples.7:814
15592 "The address macro identifies an address construct of the form "
15593 "addr1[,addr2[,addr3]]."
15597 #: build/C/man7/mdoc.samples.7:815
15599 msgid "Usage: .Ad address ... \\*(Pu"
15603 #: build/C/man7/mdoc.samples.7:817
15605 msgid "Li \\&.Ad addr1"
15608 #. type: Plain text
15609 #: build/C/man7/mdoc.samples.7:819
15610 msgid "E<.Ad addr1>"
15614 #: build/C/man7/mdoc.samples.7:819
15616 msgid "Li \\&.Ad addr1\\ ."
15619 #. type: Plain text
15620 #: build/C/man7/mdoc.samples.7:821
15621 msgid "E<.Ad addr1>."
15625 #: build/C/man7/mdoc.samples.7:821
15627 msgid "Li \\&.Ad addr1\\ , file2"
15630 #. type: Plain text
15631 #: build/C/man7/mdoc.samples.7:823
15632 msgid "E<.Ad addr1 , file2>"
15636 #: build/C/man7/mdoc.samples.7:823
15638 msgid "Li \\&.Ad f1\\ , f2\\ , f3\\ :"
15641 #. type: Plain text
15642 #: build/C/man7/mdoc.samples.7:825
15643 msgid "E<.Ad f1 , f2 , f3>:"
15647 #: build/C/man7/mdoc.samples.7:825
15649 msgid "Li \\&.Ad addr\\ )\\ )\\ ,"
15652 #. type: Plain text
15653 #: build/C/man7/mdoc.samples.7:827
15654 msgid "E<.Ad addr>)),"
15657 #. type: Plain text
15658 #: build/C/man7/mdoc.samples.7:834
15660 "It is an error to call E<.Ql \\&.Ad> without arguments. E<.Ql \\&.Ad> is "
15661 "callable by other macros and is parsed."
15665 #: build/C/man7/mdoc.samples.7:834
15667 msgid "Author Name"
15670 #. type: Plain text
15671 #: build/C/man7/mdoc.samples.7:841
15673 "The E<.Ql \\&.An> macro is used to specify the name of the author of the "
15674 "item being documented, or the name of the author of the actual manual page. "
15675 "Any remaining arguments after the name information are assumed to be "
15680 #: build/C/man7/mdoc.samples.7:842
15682 msgid "Usage: .An author_name \\*(Pu"
15686 #: build/C/man7/mdoc.samples.7:844
15688 msgid "Li \\&.An Joe\\ Author"
15691 #. type: Plain text
15692 #: build/C/man7/mdoc.samples.7:846
15693 msgid "E<.An Joe Author>"
15697 #: build/C/man7/mdoc.samples.7:846
15699 msgid "Li \\&.An Joe\\ Author\\ ,"
15702 #. type: Plain text
15703 #: build/C/man7/mdoc.samples.7:848
15704 msgid "E<.An Joe\\ Author>,"
15708 #: build/C/man7/mdoc.samples.7:848
15710 msgid "Li \\&.An Joe\\ Author\\ \\&Aq\\ nobody@FreeBSD.ORG"
15713 #. type: Plain text
15714 #: build/C/man7/mdoc.samples.7:850
15715 msgid "E<.An Joe Author Aq nobody@FreeBSD.ORG>"
15719 #: build/C/man7/mdoc.samples.7:850
15721 msgid "Li \\&.An Joe\\ Author\\ )\\ )\\ ,"
15724 #. type: Plain text
15725 #: build/C/man7/mdoc.samples.7:852
15726 msgid "E<.An Joe Author>)),"
15729 #. type: Plain text
15730 #: build/C/man7/mdoc.samples.7:861
15732 "The E<.Ql \\&.An> macro is parsed and is callable. It is an error to call "
15733 "E<.Ql \\&.An> without any arguments."
15737 #: build/C/man7/mdoc.samples.7:861
15739 msgid "Argument Macro"
15742 #. type: Plain text
15743 #: build/C/man7/mdoc.samples.7:866
15745 "The E<.Ql \\&.Ar> argument macro may be used whenever a command-line "
15746 "argument is referenced."
15750 #: build/C/man7/mdoc.samples.7:867
15752 msgid "Usage: .Ar argument ... \\*(Pu"
15756 #: build/C/man7/mdoc.samples.7:869
15761 #. type: Plain text
15762 #: build/C/man7/mdoc.samples.7:871
15767 #: build/C/man7/mdoc.samples.7:871
15769 msgid "Li \\&.Ar file1"
15772 #. type: Plain text
15773 #: build/C/man7/mdoc.samples.7:873
15774 msgid "E<.Ar file1>"
15778 #: build/C/man7/mdoc.samples.7:873
15780 msgid "Li \\&.Ar file1\\ ."
15783 #. type: Plain text
15784 #: build/C/man7/mdoc.samples.7:875
15785 msgid "E<.Ar file1>."
15789 #: build/C/man7/mdoc.samples.7:875
15791 msgid "Li \\&.Ar file1 file2"
15794 #. type: Plain text
15795 #: build/C/man7/mdoc.samples.7:877
15796 msgid "E<.Ar file1 file2>"
15800 #: build/C/man7/mdoc.samples.7:877
15802 msgid "Li \\&.Ar f1 f2 f3\\ :"
15805 #. type: Plain text
15806 #: build/C/man7/mdoc.samples.7:879
15807 msgid "E<.Ar f1 f2 f3>:"
15811 #: build/C/man7/mdoc.samples.7:879
15813 msgid "Li \\&.Ar file\\ )\\ )\\ ,"
15816 #. type: Plain text
15817 #: build/C/man7/mdoc.samples.7:881
15818 msgid "E<.Ar file>)),"
15821 #. type: Plain text
15822 #: build/C/man7/mdoc.samples.7:891
15824 "If E<.Ql \\&.Ar> is called without arguments E<.Ql \\&Ar> is assumed. The "
15825 "E<.Ql \\&.Ar> macro is parsed and is callable."
15829 #: build/C/man7/mdoc.samples.7:891
15831 msgid "Configuration Declaration (section four only)"
15834 #. type: Plain text
15835 #: build/C/man7/mdoc.samples.7:898
15837 "The E<.Ql \\&.Cd> macro is used to demonstrate a E<.Xr config 8> declaration "
15838 "for a device interface in a section four manual. This macro accepts quoted "
15839 "arguments (double quotes only)."
15843 #: build/C/man7/mdoc.samples.7:900
15845 msgid "Cd \"device le0 at scode?\""
15848 #. type: Plain text
15849 #: build/C/man7/mdoc.samples.7:903
15850 msgid "produced by: E<.Ql \".Cd device le0 at scode?\">."
15854 #: build/C/man7/mdoc.samples.7:904
15856 msgid "Command Modifier"
15859 #. type: Plain text
15860 #: build/C/man7/mdoc.samples.7:918
15862 "The command modifier is identical to the E<.Ql \\&.Fl> (flag) command with "
15863 "the exception the E<.Ql \\&.Cm> macro does not assert a dash in front of "
15864 "every argument. Traditionally flags are marked by the preceding dash, some "
15865 "commands or subsets of commands do not use them. Command modifiers may also "
15866 "be specified in conjunction with interactive commands such as editor "
15867 "commands. See E<.Sx Flags>."
15871 #: build/C/man7/mdoc.samples.7:918
15873 msgid "Defined Variables"
15876 #. type: Plain text
15877 #: build/C/man7/mdoc.samples.7:922
15879 "A variable which is defined in an include file is specified by the macro "
15884 #: build/C/man7/mdoc.samples.7:923
15886 msgid "Usage: .Dv defined_variable ... \\*(Pu"
15890 #: build/C/man7/mdoc.samples.7:925
15892 msgid "Li \".Dv MAXHOSTNAMELEN\""
15895 #. type: Plain text
15896 #: build/C/man7/mdoc.samples.7:927
15897 msgid "E<.Dv MAXHOSTNAMELEN>"
15901 #: build/C/man7/mdoc.samples.7:927
15903 msgid "Li \".Dv TIOCGPGRP )\""
15906 #. type: Plain text
15907 #: build/C/man7/mdoc.samples.7:929
15908 msgid "E<.Dv TIOCGPGRP>)"
15911 #. type: Plain text
15912 #: build/C/man7/mdoc.samples.7:936
15914 "It is an error to call E<.Ql \\&.Dv> without arguments. E<.Ql \\&.Dv> is "
15915 "parsed and is callable."
15919 #: build/C/man7/mdoc.samples.7:936
15921 msgid "Errno's (Section two only)"
15924 #. type: Plain text
15925 #: build/C/man7/mdoc.samples.7:948
15927 "The E<.Ql \\&.Er> errno macro specifies the error return value for section "
15928 "two library routines. The second example below shows E<.Ql \\&.Er> used "
15929 "with the E<.Ql \\&.Bq> general text domain macro, as it would be used in a "
15930 "section two manual page."
15934 #: build/C/man7/mdoc.samples.7:949
15936 msgid "Usage: .Er ERRNOTYPE ... \\*(Pu"
15940 #: build/C/man7/mdoc.samples.7:951
15942 msgid "Li \\&.Er ENOENT"
15945 #. type: Plain text
15946 #: build/C/man7/mdoc.samples.7:953
15947 msgid "E<.Er ENOENT>"
15951 #: build/C/man7/mdoc.samples.7:953
15953 msgid "Li \\&.Er ENOENT\\ )\\ ;"
15956 #. type: Plain text
15957 #: build/C/man7/mdoc.samples.7:955
15958 msgid "E<.Er ENOENT>);"
15962 #: build/C/man7/mdoc.samples.7:955
15964 msgid "Li \\&.Bq \\&Er ENOTDIR"
15967 #. type: Plain text
15968 #: build/C/man7/mdoc.samples.7:957
15969 msgid "E<.Bq Er ENOTDIR>"
15972 #. type: Plain text
15973 #: build/C/man7/mdoc.samples.7:965
15975 "It is an error to call E<.Ql \\&.Er> without arguments. The E<.Ql \\&.Er> "
15976 "macro is parsed and is callable."
15980 #: build/C/man7/mdoc.samples.7:965
15982 msgid "Environment Variables"
15985 #. type: Plain text
15986 #: build/C/man7/mdoc.samples.7:969
15987 msgid "The E<.Ql \\&.Ev> macro specifies an environment variable."
15991 #: build/C/man7/mdoc.samples.7:970
15993 msgid "Usage: .Ev argument ... \\*(Pu"
15997 #: build/C/man7/mdoc.samples.7:972
15999 msgid "Li \\&.Ev DISPLAY"
16002 #. type: Plain text
16003 #: build/C/man7/mdoc.samples.7:974
16004 msgid "E<.Ev DISPLAY>"
16008 #: build/C/man7/mdoc.samples.7:974
16010 msgid "Li \\&.Ev PATH\\ ."
16013 #. type: Plain text
16014 #: build/C/man7/mdoc.samples.7:976
16015 msgid "E<.Ev PATH>."
16019 #: build/C/man7/mdoc.samples.7:976
16021 msgid "Li \\&.Ev PRINTER\\ )\\ )\\ ,"
16024 #. type: Plain text
16025 #: build/C/man7/mdoc.samples.7:978
16026 msgid "E<.Ev PRINTER>)),"
16029 #. type: Plain text
16030 #: build/C/man7/mdoc.samples.7:986
16032 "It is an error to call E<.Ql \\&.Ev> without arguments. The E<.Ql \\&.Ev> "
16033 "macro is parsed and is callable."
16037 #: build/C/man7/mdoc.samples.7:986
16039 msgid "Function Argument"
16042 #. type: Plain text
16043 #: build/C/man7/mdoc.samples.7:1005
16045 "The E<.Ql \\&.Fa> macro is used to refer to function arguments (parameters) "
16046 "outside of the E<.Sx SYNOPSIS> section of the manual or inside the E<.Sx "
16047 "SYNOPSIS> section should a parameter list be too long for the E<.Ql \\&.Fn> "
16048 "macro and the enclosure macros E<.Ql \\&.Fo> and E<.Ql \\&.Fc> must be "
16049 "used. E<.Ql \\&.Fa> may also be used to refer to structure members."
16053 #: build/C/man7/mdoc.samples.7:1006
16055 msgid "Usage: .Fa function_argument ... \\*(Pu"
16059 #: build/C/man7/mdoc.samples.7:1008
16061 msgid "Li \\&.Fa d_namlen\\ )\\ )\\ ,"
16064 #. type: Plain text
16065 #: build/C/man7/mdoc.samples.7:1010
16066 msgid "E<.Fa d_namlen>)),"
16070 #: build/C/man7/mdoc.samples.7:1010
16072 msgid "Li \\&.Fa iov_len"
16075 #. type: Plain text
16076 #: build/C/man7/mdoc.samples.7:1012
16077 msgid "E<.Fa iov_len>"
16080 #. type: Plain text
16081 #: build/C/man7/mdoc.samples.7:1019
16083 "It is an error to call E<.Ql \\&.Fa> without arguments. E<.Ql \\&.Fa> is "
16084 "parsed and is callable."
16088 #: build/C/man7/mdoc.samples.7:1019
16090 msgid "Function Declaration"
16093 #. type: Plain text
16094 #: build/C/man7/mdoc.samples.7:1030
16096 "The E<.Ql \\&.Fd> macro is used in the E<.Sx SYNOPSIS> section with section "
16097 "two or three functions. The E<.Ql \\&.Fd> macro does not call other macros "
16098 "and is not callable by other macros."
16102 #: build/C/man7/mdoc.samples.7:1031
16104 msgid "Usage: .Fd include_file (or defined variable)"
16107 #. type: Plain text
16108 #: build/C/man7/mdoc.samples.7:1042
16110 "In the E<.Sx SYNOPSIS> section a E<.Ql \\&.Fd> request causes a line break "
16111 "if a function has already been presented and a break has not occurred. This "
16112 "leaves a nice vertical space in between the previous function call and the "
16113 "declaration for the next function."
16117 #: build/C/man7/mdoc.samples.7:1042
16122 #. type: Plain text
16123 #: build/C/man7/mdoc.samples.7:1055
16125 "The E<.Ql \\&.Fl> macro handles command-line flags. It prepends a dash, "
16126 "E<.Ql \\->, to the flag. For interactive command flags, which are not "
16127 "prepended with a dash, the E<.Ql \\&.Cm> (command modifier) macro is "
16128 "identical, but without the dash."
16132 #: build/C/man7/mdoc.samples.7:1056
16134 msgid "Usage: .Fl argument ... \\*(Pu"
16138 #: build/C/man7/mdoc.samples.7:1058
16143 #. type: Plain text
16144 #: build/C/man7/mdoc.samples.7:1060
16149 #: build/C/man7/mdoc.samples.7:1060
16151 msgid "Li \\&.Fl cfv"
16154 #. type: Plain text
16155 #: build/C/man7/mdoc.samples.7:1062
16160 #: build/C/man7/mdoc.samples.7:1062
16162 msgid "Li \\&.Fl cfv\\ ."
16165 #. type: Plain text
16166 #: build/C/man7/mdoc.samples.7:1064
16167 msgid "E<.Fl cfv>."
16171 #: build/C/man7/mdoc.samples.7:1064
16173 msgid "Li \\&.Fl s v t"
16176 #. type: Plain text
16177 #: build/C/man7/mdoc.samples.7:1066
16178 msgid "E<.Fl s v t>"
16182 #: build/C/man7/mdoc.samples.7:1066
16184 msgid "Li \\&.Fl -\\ ,"
16187 #. type: Plain text
16188 #: build/C/man7/mdoc.samples.7:1068
16193 #: build/C/man7/mdoc.samples.7:1068
16195 msgid "Li \\&.Fl xyz\\ )\\ ,"
16198 #. type: Plain text
16199 #: build/C/man7/mdoc.samples.7:1070
16200 msgid "E<.Fl xyz>),"
16203 #. type: Plain text
16204 #: build/C/man7/mdoc.samples.7:1082
16206 "The E<.Ql \\&.Fl> macro without any arguments results in a dash representing "
16207 "I<stdin>/I<stdout>. Note that giving E<.Ql \\&.Fl> a single dash, will "
16208 "result in two dashes. The E<.Ql \\&.Fl> macro is parsed and is callable."
16212 #: build/C/man7/mdoc.samples.7:1082
16214 msgid "Functions (library routines)"
16217 #. type: Plain text
16218 #: build/C/man7/mdoc.samples.7:1084
16219 msgid "The .Fn macro is modeled on ANSI C conventions."
16222 #. type: Plain text
16223 #: build/C/man7/mdoc.samples.7:1086
16225 msgid "Usage: .Fn [type] function [[type] parameters ... \\*(Pu]\n"
16229 #: build/C/man7/mdoc.samples.7:1088
16231 msgid "Li \"\\&.Fn getchar\""
16234 #. type: Plain text
16235 #: build/C/man7/mdoc.samples.7:1090
16236 msgid "E<.Fn getchar>"
16240 #: build/C/man7/mdoc.samples.7:1090
16242 msgid "Li \"\\&.Fn strlen ) ,\""
16245 #. type: Plain text
16246 #: build/C/man7/mdoc.samples.7:1092
16247 msgid "E<.Fn strlen>),"
16251 #: build/C/man7/mdoc.samples.7:1092
16253 msgid "Li \\&.Fn \"\\*qint align\\*q\" \"\\*qconst * char *sptrs\\*q\" ,"
16256 #. type: Plain text
16257 #: build/C/man7/mdoc.samples.7:1094
16258 msgid "E<.Fn \"int align\" \"const * char *sptrs\">,"
16261 #. type: Plain text
16262 #: build/C/man7/mdoc.samples.7:1107
16264 "It is an error to call E<.Ql \\&.Fn> without any arguments. The E<.Ql "
16265 "\\&.Fn> macro is parsed and is callable, note that any call to another macro "
16266 "signals the end of the E<.Ql \\&.Fn> call (it will close-parenthesis at that "
16270 #. type: Plain text
16271 #: build/C/man7/mdoc.samples.7:1121
16273 "For functions that have more than eight parameters (and this is rare), the "
16274 "macros E<.Ql \\&.Fo> (function open) and E<.Ql \\&.Fc> (function close) "
16275 "may be used with E<.Ql \\&.Fa> (function argument) to get around the "
16276 "limitation. For example:"
16279 #. type: Plain text
16280 #: build/C/man7/mdoc.samples.7:1133
16283 "\\&.Fo \"int res_mkquery\"\n"
16284 "\\&.Fa \"int op\"\n"
16285 "\\&.Fa \"char *dname\"\n"
16286 "\\&.Fa \"int class\"\n"
16287 "\\&.Fa \"int type\"\n"
16288 "\\&.Fa \"char *data\"\n"
16289 "\\&.Fa \"int datalen\"\n"
16290 "\\&.Fa \"struct rrec *newrr\"\n"
16291 "\\&.Fa \"char *buf\"\n"
16292 "\\&.Fa \"int buflen\"\n"
16296 #. type: Plain text
16297 #: build/C/man7/mdoc.samples.7:1136 build/C/man7/mdoc.samples.7:2480
16301 #. type: Plain text
16302 #: build/C/man7/mdoc.samples.7:1148
16305 "E<.Fo \"int res_mkquery\">\n"
16306 "E<.Fa \"int op\">\n"
16307 "E<.Fa \"char *dname\">\n"
16308 "E<.Fa \"int class\">\n"
16309 "E<.Fa \"int type\">\n"
16310 "E<.Fa \"char *data\">\n"
16311 "E<.Fa \"int datalen\">\n"
16312 "E<.Fa \"struct rrec *newrr\">\n"
16313 "E<.Fa \"char *buf\">\n"
16314 "E<.Fa \"int buflen\">\n"
16318 #. type: Plain text
16319 #: build/C/man7/mdoc.samples.7:1171
16321 "The E<.Ql \\&.Fo> and E<.Ql \\&.Fc> macros are parsed and are callable. In "
16322 "the E<.Sx SYNOPSIS> section, the function will always begin at the beginning "
16323 "of line. If there is more than one function presented in the E<.Sx "
16324 "SYNOPSIS> section and a function type has not been given, a line break will "
16325 "occur, leaving a nice vertical space between the current function name and "
16326 "the one prior. At the moment, E<.Ql \\&.Fn> does not check its word "
16327 "boundaries against troff line lengths and may split across a newline "
16328 "ungracefully. This will be fixed in the near future."
16332 #: build/C/man7/mdoc.samples.7:1171
16334 msgid "Function Type"
16337 #. type: Plain text
16338 #: build/C/man7/mdoc.samples.7:1182
16340 "This macro is intended for the E<.Sx SYNOPSIS> section. It may be used "
16341 "anywhere else in the man page without problems, but its main purpose is to "
16342 "present the function type in kernel normal form for the E<.Sx SYNOPSIS> of "
16343 "sections two and three (it causes a line break allowing the function name to "
16344 "appear on the next line)."
16348 #: build/C/man7/mdoc.samples.7:1183
16350 msgid "Usage: .Ft type ... \\*(Pu"
16354 #: build/C/man7/mdoc.samples.7:1185
16356 msgid "Li \\&.Ft struct stat"
16359 #. type: Plain text
16360 #: build/C/man7/mdoc.samples.7:1187
16361 msgid "E<.Ft struct stat>"
16364 #. type: Plain text
16365 #: build/C/man7/mdoc.samples.7:1192
16366 msgid "The E<.Ql \\&.Ft> request is not callable by other macros."
16370 #: build/C/man7/mdoc.samples.7:1192
16372 msgid "Interactive Commands"
16375 #. type: Plain text
16376 #: build/C/man7/mdoc.samples.7:1196
16377 msgid "The E<.Ql \\&.Ic> macro designates an interactive or internal command."
16381 #: build/C/man7/mdoc.samples.7:1197
16383 msgid "Usage: .Ic argument ... \\*(Pu"
16387 #: build/C/man7/mdoc.samples.7:1199
16389 msgid "Li \\&.Ic :wq"
16392 #. type: Plain text
16393 #: build/C/man7/mdoc.samples.7:1201
16398 #: build/C/man7/mdoc.samples.7:1201
16400 msgid "Li \\&.Ic do while {...}"
16403 #. type: Plain text
16404 #: build/C/man7/mdoc.samples.7:1203
16405 msgid "E<.Ic do while {...}>"
16409 #: build/C/man7/mdoc.samples.7:1203
16411 msgid "Li \\&.Ic setenv\\ , unsetenv"
16414 #. type: Plain text
16415 #: build/C/man7/mdoc.samples.7:1205
16416 msgid "E<.Ic setenv , unsetenv>"
16419 #. type: Plain text
16420 #: build/C/man7/mdoc.samples.7:1213
16422 "It is an error to call E<.Ql \\&.Ic> without arguments. The E<.Ql \\&.Ic> "
16423 "macro is parsed and is callable."
16427 #: build/C/man7/mdoc.samples.7:1213
16432 #. type: Plain text
16433 #: build/C/man7/mdoc.samples.7:1249
16435 "The E<.Ql \\&.Nm> macro is used for the document title or subject name. It "
16436 "has the peculiarity of remembering the first argument it was called with, "
16437 "which should always be the subject name of the page. When called without "
16438 "arguments, E<.Ql \\&.Nm> regurgitates this initial name for the sole purpose "
16439 "of making less work for the author. Note: a section two or three document "
16440 "function name is addressed with the E<.Ql \\&.Nm> in the E<.Sx NAME> "
16441 "section, and with E<.Ql \\&.Fn> in the E<.Sx SYNOPSIS> and remaining "
16442 "sections. For interactive commands, such as the E<.Ql while> command "
16443 "keyword in E<.Xr csh 1>, the E<.Ql \\&.Ic> macro should be used. While the "
16444 "E<.Ql \\&.Ic> is nearly identical to E<.Ql \\&.Nm>, it can not recall the "
16445 "first argument it was invoked with."
16449 #: build/C/man7/mdoc.samples.7:1250
16451 msgid "Usage: .Nm argument ... \\*(Pu"
16455 #: build/C/man7/mdoc.samples.7:1252
16457 msgid "Li \\&.Nm mdoc.sample"
16460 #. type: Plain text
16461 #: build/C/man7/mdoc.samples.7:1254
16462 msgid "E<.Nm mdoc.sample>"
16466 #: build/C/man7/mdoc.samples.7:1254
16468 msgid "Li \\&.Nm \\e-mdoc"
16471 #. type: Plain text
16472 #: build/C/man7/mdoc.samples.7:1256
16473 msgid "E<.Nm \\-mdoc>."
16477 #: build/C/man7/mdoc.samples.7:1256
16479 msgid "Li \\&.Nm foo\\ )\\ )\\ ,"
16482 #. type: Plain text
16483 #: build/C/man7/mdoc.samples.7:1258
16484 msgid "E<.Nm foo>)),"
16488 #: build/C/man7/mdoc.samples.7:1258
16493 #. type: Plain text
16494 #: build/C/man7/mdoc.samples.7:1260
16498 #. type: Plain text
16499 #: build/C/man7/mdoc.samples.7:1265
16500 msgid "The E<.Ql \\&.Nm> macro is parsed and is callable."
16504 #: build/C/man7/mdoc.samples.7:1265
16509 #. type: Plain text
16510 #: build/C/man7/mdoc.samples.7:1277
16512 "The E<.Ql \\&.Op> macro places option brackets around the any remaining "
16513 "arguments on the command line, and places any trailing punctuation outside "
16514 "the brackets. The macros E<.Ql \\&.Oc> and E<.Ql \\&.Oo> may be used across "
16515 "one or more lines."
16519 #: build/C/man7/mdoc.samples.7:1278
16521 msgid "Usage: .Op options ... \\*(Pu"
16525 #: build/C/man7/mdoc.samples.7:1280
16530 #. type: Plain text
16531 #: build/C/man7/mdoc.samples.7:1282
16536 #: build/C/man7/mdoc.samples.7:1282
16538 msgid "Li \".Op Fl k\""
16541 #. type: Plain text
16542 #: build/C/man7/mdoc.samples.7:1284
16543 msgid "E<.Op Fl k>"
16547 #: build/C/man7/mdoc.samples.7:1284
16549 msgid "Li \".Op Fl k ) .\""
16552 #. type: Plain text
16553 #: build/C/man7/mdoc.samples.7:1286
16554 msgid "E<.Op Fl k>)."
16558 #: build/C/man7/mdoc.samples.7:1286
16560 msgid "Li \".Op Fl k Ar kookfile\""
16563 #. type: Plain text
16564 #: build/C/man7/mdoc.samples.7:1288
16565 msgid "E<.Op Fl k Ar kookfile>"
16569 #: build/C/man7/mdoc.samples.7:1288
16571 msgid "Li \".Op Fl k Ar kookfile ,\""
16574 #. type: Plain text
16575 #: build/C/man7/mdoc.samples.7:1290
16576 msgid "E<.Op Fl k Ar kookfile>,"
16580 #: build/C/man7/mdoc.samples.7:1290
16582 msgid "Li \".Op Ar objfil Op Ar corfil\""
16585 #. type: Plain text
16586 #: build/C/man7/mdoc.samples.7:1292
16587 msgid "E<.Op Ar objfil Op Ar corfil>"
16591 #: build/C/man7/mdoc.samples.7:1292
16593 msgid "Li \".Op Fl c Ar objfil Op Ar corfil ,\""
16596 #. type: Plain text
16597 #: build/C/man7/mdoc.samples.7:1294
16598 msgid "E<.Op Fl c Ar objfil Op Ar corfil>,"
16602 #: build/C/man7/mdoc.samples.7:1294
16604 msgid "Li \\&.Op word1 word2"
16607 #. type: Plain text
16608 #: build/C/man7/mdoc.samples.7:1296
16609 msgid "E<.Op word1 word2>"
16612 #. type: Plain text
16613 #: build/C/man7/mdoc.samples.7:1303
16614 msgid "The E<.Ql \\&.Oc> and E<.Ql \\&.Oo> macros:"
16617 #. type: Plain text
16618 #: build/C/man7/mdoc.samples.7:1309
16622 "\\&.Op \\&Fl k \\&Ar kilobytes\n"
16623 "\\&.Op \\&Fl i \\&Ar interval\n"
16624 "\\&.Op \\&Fl c \\&Ar count\n"
16628 #. type: Plain text
16629 #: build/C/man7/mdoc.samples.7:1317
16631 "Produce: E<.Oo> E<.Op Fl k Ar kilobytes> E<.Op Fl i Ar interval> E<.Op Fl c "
16635 #. type: Plain text
16636 #: build/C/man7/mdoc.samples.7:1324
16638 "The macros E<.Ql \\&.Op>, E<.Ql \\&.Oc> and E<.Ql \\&.Oo> are parsed and are "
16643 #: build/C/man7/mdoc.samples.7:1324
16648 #. type: Plain text
16649 #: build/C/man7/mdoc.samples.7:1328
16650 msgid "The E<.Ql \\&.Pa> macro formats pathnames or filenames."
16654 #: build/C/man7/mdoc.samples.7:1329
16656 msgid "Usage: .Pa pathname \\*(Pu"
16660 #: build/C/man7/mdoc.samples.7:1331
16662 msgid "Li \\&.Pa /usr/share"
16665 #. type: Plain text
16666 #: build/C/man7/mdoc.samples.7:1333
16667 msgid "E<.Pa /usr/share>"
16671 #: build/C/man7/mdoc.samples.7:1333
16673 msgid "Li \\&.Pa /tmp/fooXXXXX\\ )\\ ."
16676 #. type: Plain text
16677 #: build/C/man7/mdoc.samples.7:1335
16678 msgid "E<.Pa /tmp/fooXXXXX>)."
16681 #. type: Plain text
16682 #: build/C/man7/mdoc.samples.7:1340
16683 msgid "The E<.Ql \\&.Pa> macro is parsed and is callable."
16687 #: build/C/man7/mdoc.samples.7:1340
16692 #. type: Plain text
16693 #: build/C/man7/mdoc.samples.7:1342
16694 msgid "Generic variable reference:"
16698 #: build/C/man7/mdoc.samples.7:1343
16700 msgid "Usage: .Va variable ... \\*(Pu"
16704 #: build/C/man7/mdoc.samples.7:1345
16706 msgid "Li \\&.Va count"
16709 #. type: Plain text
16710 #: build/C/man7/mdoc.samples.7:1347
16711 msgid "E<.Va count>"
16715 #: build/C/man7/mdoc.samples.7:1347
16717 msgid "Li \\&.Va settimer ,"
16720 #. type: Plain text
16721 #: build/C/man7/mdoc.samples.7:1349
16722 msgid "E<.Va settimer>,"
16726 #: build/C/man7/mdoc.samples.7:1349
16728 msgid "Li \\&.Va int\\ *prt\\ )\\ :"
16731 #. type: Plain text
16732 #: build/C/man7/mdoc.samples.7:1351
16733 msgid "E<.Va int\\ *prt>):"
16737 #: build/C/man7/mdoc.samples.7:1351
16739 msgid "Li \\&.Va char\\ s\\ ]\\ )\\ )\\ ,"
16742 #. type: Plain text
16743 #: build/C/man7/mdoc.samples.7:1353
16744 msgid "E<.Va char\\ s>])),"
16747 #. type: Plain text
16748 #: build/C/man7/mdoc.samples.7:1361
16750 "It is an error to call E<.Ql \\&.Va> without any arguments. The E<.Ql "
16751 "\\&.Va> macro is parsed and is callable."
16755 #: build/C/man7/mdoc.samples.7:1361
16757 msgid "Manual Page Cross References"
16760 #. type: Plain text
16761 #: build/C/man7/mdoc.samples.7:1369
16763 "The E<.Ql \\&.Xr> macro expects the first argument to be a manual page name, "
16764 "and the second argument, if it exists, to be either a section page number or "
16765 "punctuation. Any remaining arguments are assumed to be punctuation."
16769 #: build/C/man7/mdoc.samples.7:1370
16771 msgid "Usage: .Xr man_page [1,...,8] \\*(Pu"
16775 #: build/C/man7/mdoc.samples.7:1372
16777 msgid "Li \\&.Xr mdoc"
16780 #. type: Plain text
16781 #: build/C/man7/mdoc.samples.7:1374
16782 msgid "E<.Xr mdoc>"
16786 #: build/C/man7/mdoc.samples.7:1374
16788 msgid "Li \\&.Xr mdoc\\ ,"
16791 #. type: Plain text
16792 #: build/C/man7/mdoc.samples.7:1376
16793 msgid "E<.Xr mdoc>,"
16797 #: build/C/man7/mdoc.samples.7:1376
16799 msgid "Li \\&.Xr mdoc 7"
16802 #. type: Plain text
16803 #: build/C/man7/mdoc.samples.7:1378
16804 msgid "E<.Xr mdoc 7>"
16808 #: build/C/man7/mdoc.samples.7:1378
16810 msgid "Li \\&.Xr mdoc 7\\ )\\ )\\ ,"
16813 #. type: Plain text
16814 #: build/C/man7/mdoc.samples.7:1380
16815 msgid "E<.Xr mdoc 7>)),"
16818 #. type: Plain text
16819 #: build/C/man7/mdoc.samples.7:1389
16821 "The E<.Ql \\&.Xr> macro is parsed and is callable. It is an error to call "
16822 "E<.Ql \\&.Xr> without any arguments."
16826 #: build/C/man7/mdoc.samples.7:1389
16828 msgid "GENERAL TEXT DOMAIN"
16832 #: build/C/man7/mdoc.samples.7:1390
16837 #. type: Plain text
16838 #: build/C/man7/mdoc.samples.7:1393
16840 msgid "Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \\*(Pu\n"
16844 #: build/C/man7/mdoc.samples.7:1395
16849 #. type: Plain text
16850 #: build/C/man7/mdoc.samples.7:1397
16855 #: build/C/man7/mdoc.samples.7:1397
16857 msgid "Li \".At v6 .\""
16860 #. type: Plain text
16861 #: build/C/man7/mdoc.samples.7:1399
16865 #. type: Plain text
16866 #: build/C/man7/mdoc.samples.7:1409
16868 "The E<.Ql \\&.At> macro is E<.Em not> parsed and E<.Em not> callable It "
16869 "accepts at most two arguments."
16873 #: build/C/man7/mdoc.samples.7:1409
16879 #: build/C/man7/mdoc.samples.7:1410
16881 msgid "Usage: .Bx [Version/release] ... \\*(Pu"
16885 #: build/C/man7/mdoc.samples.7:1412
16890 #. type: Plain text
16891 #: build/C/man7/mdoc.samples.7:1414
16896 #: build/C/man7/mdoc.samples.7:1414
16898 msgid "Li \".Bx 4.3 .\""
16901 #. type: Plain text
16902 #: build/C/man7/mdoc.samples.7:1416
16903 msgid "E<.Bx 4.3>."
16906 #. type: Plain text
16907 #: build/C/man7/mdoc.samples.7:1421
16908 msgid "The E<.Ql \\&.Bx> macro is parsed and is callable."
16912 #: build/C/man7/mdoc.samples.7:1421
16914 msgid "FreeBSD Macro"
16917 #. type: Plain text
16918 #: build/C/man7/mdoc.samples.7:1424
16920 msgid "Usage: .Fx Version.release ... \\*(Pu\n"
16924 #: build/C/man7/mdoc.samples.7:1426
16926 msgid "Li \".Fx 2.2 .\""
16929 #. type: Plain text
16930 #: build/C/man7/mdoc.samples.7:1428
16931 msgid "E<.Fx 2.2>."
16934 #. type: Plain text
16935 #: build/C/man7/mdoc.samples.7:1438
16937 "The E<.Ql \\&.Fx> macro is E<.Em not> parsed and E<.Em not> callable It "
16938 "accepts at most two arguments."
16942 #: build/C/man7/mdoc.samples.7:1438
16948 #: build/C/man7/mdoc.samples.7:1439
16950 msgid "Usage: .Ux ... \\*(Pu"
16954 #: build/C/man7/mdoc.samples.7:1441
16959 #. type: Plain text
16960 #: build/C/man7/mdoc.samples.7:1443
16964 #. type: Plain text
16965 #: build/C/man7/mdoc.samples.7:1448
16966 msgid "The E<.Ql \\&.Ux> macro is parsed and is callable."
16970 #: build/C/man7/mdoc.samples.7:1448
16972 msgid "Enclosure and Quoting Macros"
16975 #. type: Plain text
16976 #: build/C/man7/mdoc.samples.7:1470
16978 "The concept of enclosure is similar to quoting. The object being to enclose "
16979 "one or more strings between a pair of characters like quotes or "
16980 "parentheses. The terms quoting and enclosure are used interchangeably "
16981 "throughout this document. Most of the one line enclosure macros end in "
16982 "small letter E<.Ql q> to give a hint of quoting, but there are a few "
16983 "irregularities. For each enclosure macro there is also a pair of open and "
16984 "close macros which end in small letters E<.Ql o> and E<.Ql c> respectively. "
16985 "These can be used across one or more lines of text and while they have "
16986 "nesting limitations, the one line quote macros can be used inside of them."
16989 #. type: Plain text
16990 #: build/C/man7/mdoc.samples.7:1483
16993 "E<.Em \" Quote\t Close\t Open\tFunction\tResult\">\n"
16994 "\\&.Aq\t.Ac\t.Ao\tAngle Bracket Enclosure\tE<lt>stringE<gt>\n"
16995 "\\&.Bq\t.Bc\t.Bo\tBracket Enclosure\t[string]\n"
16996 "\\&.Dq\t.Dc\t.Do\tDouble Quote\t``string''\n"
16997 "\t.Ec\t.Eo\tEnclose String (in XX)\tXXstringXX\n"
16998 "\\&.Pq\t.Pc\t.Po\tParenthesis Enclosure\t(string)\n"
16999 "\\&.Ql\t\t\tQuoted Literal\t`st' or string\n"
17000 "\\&.Qq\t.Qc\t.Qo\tStraight Double Quote\t\"string\"\n"
17001 "\\&.Sq\t.Sc\t.So\tSingle Quote\t`string'\n"
17004 #. type: Plain text
17005 #: build/C/man7/mdoc.samples.7:1494
17007 "Except for the irregular macros noted below, all of the quoting macros are "
17008 "parsed and callable. All handle punctuation properly, as long as it is "
17009 "presented one character at a time and separated by spaces. The quoting "
17010 "macros examine opening and closing punctuation to determine whether it comes "
17011 "before or after the enclosing string This makes some nesting possible."
17015 #: build/C/man7/mdoc.samples.7:1495
17017 msgid "Li \\&.Ec , \\&.Eo"
17020 #. type: Plain text
17021 #: build/C/man7/mdoc.samples.7:1498
17023 "These macros expect the first argument to be the opening and closing strings "
17028 #: build/C/man7/mdoc.samples.7:1498
17033 #. type: Plain text
17034 #: build/C/man7/mdoc.samples.7:1511
17036 "The quoted literal macro behaves differently for E<.Xr troff> than E<.Xr "
17037 "nroff>. If formatted with E<.Xr nroff>, a quoted literal is always quoted. "
17038 "If formatted with troff, an item is quoted only if the width of the item is "
17039 "less than three constant width characters. This is to make short strings "
17040 "more visible where the font change to literal (constant width) is less "
17045 #: build/C/man7/mdoc.samples.7:1511
17050 #. type: Plain text
17051 #: build/C/man7/mdoc.samples.7:1513
17052 msgid "The prefix macro is not callable, but it is parsed:"
17056 #: build/C/man7/mdoc.samples.7:1514
17058 msgid "Li \".Pf ( Fa name2\""
17061 #. type: Plain text
17062 #: build/C/man7/mdoc.samples.7:1517
17063 msgid "becomes E<.Pf ( Fa name2>."
17066 #. type: Plain text
17067 #: build/C/man7/mdoc.samples.7:1522
17068 msgid "The E<.Ql \\&.Ns> (no space) macro performs the analogous suffix function."
17071 #. type: Plain text
17072 #: build/C/man7/mdoc.samples.7:1526
17073 msgid "Examples of quoting:"
17077 #: build/C/man7/mdoc.samples.7:1527
17082 #. type: Plain text
17083 #: build/C/man7/mdoc.samples.7:1529
17088 #: build/C/man7/mdoc.samples.7:1529
17090 msgid "Li \\&.Aq \\&Ar ctype.h\\ )\\ ,"
17093 #. type: Plain text
17094 #: build/C/man7/mdoc.samples.7:1531
17095 msgid "E<.Aq Ar ctype.h>),"
17099 #: build/C/man7/mdoc.samples.7:1531
17104 #. type: Plain text
17105 #: build/C/man7/mdoc.samples.7:1533
17110 #: build/C/man7/mdoc.samples.7:1533
17112 msgid "Li \\&.Bq \\&Em Greek \\&, French \\&."
17115 #. type: Plain text
17116 #: build/C/man7/mdoc.samples.7:1535
17117 msgid "E<.Bq Em Greek , French>."
17121 #: build/C/man7/mdoc.samples.7:1535
17126 #. type: Plain text
17127 #: build/C/man7/mdoc.samples.7:1537
17132 #: build/C/man7/mdoc.samples.7:1537
17134 msgid "Li \".Dq string abc .\""
17137 #. type: Plain text
17138 #: build/C/man7/mdoc.samples.7:1539
17139 msgid "E<.Dq string abc>."
17143 #: build/C/man7/mdoc.samples.7:1539
17145 msgid "Li \".Dq \\'^[A-Z]\\'\""
17148 #. type: Plain text
17149 #: build/C/man7/mdoc.samples.7:1541
17150 msgid "E<.Dq \\'^[A-Z]\\'>"
17154 #: build/C/man7/mdoc.samples.7:1541
17156 msgid "Li \"\\&.Ql man mdoc\""
17159 #. type: Plain text
17160 #: build/C/man7/mdoc.samples.7:1543
17161 msgid "E<.Ql man mdoc>"
17165 #: build/C/man7/mdoc.samples.7:1543
17170 #. type: Plain text
17171 #: build/C/man7/mdoc.samples.7:1545
17176 #: build/C/man7/mdoc.samples.7:1545
17178 msgid "Li \"\\&.Qq string ) ,\""
17181 #. type: Plain text
17182 #: build/C/man7/mdoc.samples.7:1547
17183 msgid "E<.Qq string>),"
17187 #: build/C/man7/mdoc.samples.7:1547
17189 msgid "Li \"\\&.Qq string Ns ),\""
17192 #. type: Plain text
17193 #: build/C/man7/mdoc.samples.7:1549
17194 msgid "E<.Qq string Ns ),>"
17198 #: build/C/man7/mdoc.samples.7:1549
17203 #. type: Plain text
17204 #: build/C/man7/mdoc.samples.7:1551
17209 #: build/C/man7/mdoc.samples.7:1551
17211 msgid "Li \"\\&.Sq string\""
17214 #. type: Plain text
17215 #: build/C/man7/mdoc.samples.7:1553
17216 msgid "E<.Sq string>"
17219 #. type: Plain text
17220 #: build/C/man7/mdoc.samples.7:1570
17222 "For a good example of nested enclosure macros, see the E<.Ql \\&.Op> option "
17223 "macro. It was created from the same underlying enclosure macros as those "
17224 "presented in the list above. The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> extended "
17225 "argument list macros were also built from the same underlying routines and "
17226 "are a good example of E<.Nm \\-mdoc> macro usage at its worst."
17230 #: build/C/man7/mdoc.samples.7:1570
17232 msgid "No\\-Op or Normal Text Macro"
17235 #. type: Plain text
17236 #: build/C/man7/mdoc.samples.7:1578
17238 "The macro E<.Ql \\&.No> is a hack for words in a macro command line which "
17239 "should E<.Em not> be formatted and follows the conventional syntax for "
17244 #: build/C/man7/mdoc.samples.7:1578
17246 msgid "No Space Macro"
17249 #. type: Plain text
17250 #: build/C/man7/mdoc.samples.7:1584
17252 "The E<.Ql \\&.Ns> macro eliminates unwanted spaces in between macro "
17253 "requests. It is useful for old style argument lists where there is no space "
17254 "between the flag and argument:"
17258 #: build/C/man7/mdoc.samples.7:1585
17260 msgid "Li \".Op Fl I Ns Ar directory\""
17263 #. type: Plain text
17264 #: build/C/man7/mdoc.samples.7:1588
17265 msgid "produces E<.Op Fl I Ns Ar directory>"
17268 #. type: Plain text
17269 #: build/C/man7/mdoc.samples.7:1599
17271 "Note: the E<.Ql \\&.Ns> macro always invokes the E<.Ql \\&.No> macro after "
17272 "eliminating the space unless another macro name follows it. The macro E<.Ql "
17273 "\\&.Ns> is parsed and is callable."
17277 #: build/C/man7/mdoc.samples.7:1599
17279 msgid "Section Cross References"
17282 #. type: Plain text
17283 #: build/C/man7/mdoc.samples.7:1605
17285 "The E<.Ql \\&.Sx> macro designates a reference to a section header within "
17286 "the same document. It is parsed and is callable."
17290 #: build/C/man7/mdoc.samples.7:1607
17292 msgid "Li \\&.Sx FILES"
17295 #. type: Plain text
17296 #: build/C/man7/mdoc.samples.7:1609
17297 msgid "E<.Sx FILES>"
17301 #: build/C/man7/mdoc.samples.7:1610
17303 msgid "References and Citations"
17306 #. type: Plain text
17307 #: build/C/man7/mdoc.samples.7:1614
17309 "The following macros make a modest attempt to handle references. At best, "
17310 "the macros make it convenient to manually drop in a subset of refer style "
17315 #: build/C/man7/mdoc.samples.7:1616
17320 #. type: Plain text
17321 #: build/C/man7/mdoc.samples.7:1621
17323 "Reference Start. Causes a line break and begins collection of reference "
17324 "information until the reference end macro is read."
17328 #: build/C/man7/mdoc.samples.7:1621
17333 #. type: Plain text
17334 #: build/C/man7/mdoc.samples.7:1624
17335 msgid "Reference End. The reference is printed."
17339 #: build/C/man7/mdoc.samples.7:1624
17344 #. type: Plain text
17345 #: build/C/man7/mdoc.samples.7:1626
17346 msgid "Reference author name, one name per invocation."
17350 #: build/C/man7/mdoc.samples.7:1626
17355 #. type: Plain text
17356 #: build/C/man7/mdoc.samples.7:1628
17357 msgid "Book title."
17361 #: build/C/man7/mdoc.samples.7:1628
17366 #. type: Plain text
17367 #: build/C/man7/mdoc.samples.7:1630
17368 msgid "City/place."
17372 #: build/C/man7/mdoc.samples.7:1630
17377 #. type: Plain text
17378 #: build/C/man7/mdoc.samples.7:1632
17383 #: build/C/man7/mdoc.samples.7:1632
17388 #. type: Plain text
17389 #: build/C/man7/mdoc.samples.7:1634
17390 msgid "Journal name."
17394 #: build/C/man7/mdoc.samples.7:1634
17399 #. type: Plain text
17400 #: build/C/man7/mdoc.samples.7:1636
17401 msgid "Issue number."
17405 #: build/C/man7/mdoc.samples.7:1636
17410 #. type: Plain text
17411 #: build/C/man7/mdoc.samples.7:1638
17412 msgid "Optional information."
17416 #: build/C/man7/mdoc.samples.7:1638
17421 #. type: Plain text
17422 #: build/C/man7/mdoc.samples.7:1640
17423 msgid "Page number."
17427 #: build/C/man7/mdoc.samples.7:1640
17432 #. type: Plain text
17433 #: build/C/man7/mdoc.samples.7:1642
17434 msgid "Report name."
17438 #: build/C/man7/mdoc.samples.7:1642
17443 #. type: Plain text
17444 #: build/C/man7/mdoc.samples.7:1644
17445 msgid "Title of article."
17449 #: build/C/man7/mdoc.samples.7:1644
17454 #. type: Plain text
17455 #: build/C/man7/mdoc.samples.7:1646
17459 #. type: Plain text
17460 #: build/C/man7/mdoc.samples.7:1657
17462 "The macros beginning with E<.Ql %> are not callable, and are parsed only for "
17463 "the trade name macro which returns to its caller. (And not very predictably "
17464 "at the moment either.) The purpose is to allow trade names to be pretty "
17465 "printed in E<.Xr troff Ns / Ns Xr ditroff> output."
17469 #: build/C/man7/mdoc.samples.7:1657
17471 msgid "Return Values"
17474 #. type: Plain text
17475 #: build/C/man7/mdoc.samples.7:1663
17477 "The E<.Ql \\&.Rv> macro generates text for use in the E<.Sx RETURN VALUE> "
17482 #: build/C/man7/mdoc.samples.7:1664
17484 msgid "Usage: .Rv [-std function]"
17487 #. type: Plain text
17488 #: build/C/man7/mdoc.samples.7:1668
17489 msgid "E<.Ql \\&.Rv -std atexit> will generate the following text:"
17492 #. fake section 3 to avoid error message from Rv
17494 #. type: ds section
17495 #: build/C/man7/mdoc.samples.7:1671
17500 #. and back to 7 again
17502 #. type: Plain text
17503 #: build/C/man7/mdoc.samples.7:1675
17504 msgid "E<.Rv -std atexit>"
17507 #. type: ds section
17508 #: build/C/man7/mdoc.samples.7:1675
17513 #. type: Plain text
17514 #: build/C/man7/mdoc.samples.7:1680
17515 msgid "The E<.Fl std> option is valid only for manual page sections 2 and 3."
17519 #: build/C/man7/mdoc.samples.7:1680
17521 msgid "Trade Names (or Acronyms and Type Names)"
17524 #. type: Plain text
17525 #: build/C/man7/mdoc.samples.7:1683
17527 "The trade name macro is generally a small caps macro for all upper case "
17528 "words longer than two characters."
17532 #: build/C/man7/mdoc.samples.7:1684
17534 msgid "Usage: .Tn symbol ... \\*(Pu"
17538 #: build/C/man7/mdoc.samples.7:1686
17540 msgid "Li \\&.Tn DEC"
17543 #. type: Plain text
17544 #: build/C/man7/mdoc.samples.7:1688
17549 #: build/C/man7/mdoc.samples.7:1688
17551 msgid "Li \\&.Tn ASCII"
17554 #. type: Plain text
17555 #: build/C/man7/mdoc.samples.7:1690
17556 msgid "E<.Tn ASCII>"
17559 #. type: Plain text
17560 #: build/C/man7/mdoc.samples.7:1696
17561 msgid "The E<.Ql \\&.Tn> macro is parsed and is callable by other macros."
17565 #: build/C/man7/mdoc.samples.7:1696
17567 msgid "Extended Arguments"
17570 #. type: Plain text
17571 #: build/C/man7/mdoc.samples.7:1708
17573 "The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> macros allow one to extend an argument "
17574 "list on a macro boundary. Argument lists cannot be extended within a macro "
17575 "which expects all of its arguments on one line such as E<.Ql \\&.Op>."
17578 #. type: Plain text
17579 #: build/C/man7/mdoc.samples.7:1712
17581 "Here is an example of E<.Ql \\&.Xo> using the space mode macro to turn "
17585 #. type: Plain text
17586 #: build/C/man7/mdoc.samples.7:1718
17590 "\\&.It Xo Sy I Ar operation\n"
17591 "\\&.No \\een Ar count No \\een\n"
17596 #. type: Plain text
17597 #: build/C/man7/mdoc.samples.7:1721 build/C/man7/mdoc.samples.7:1742 build/C/man7/mdoc.samples.7:1766
17601 #. type: Plain text
17602 #: build/C/man7/mdoc.samples.7:1724 build/C/man7/mdoc.samples.7:1745
17604 msgid "E<.Sm off>\n"
17608 #: build/C/man7/mdoc.samples.7:1724
17610 msgid "Xo Sy I Ar operation"
17613 #. type: Plain text
17614 #: build/C/man7/mdoc.samples.7:1728
17617 "E<.No \\en Ar count No \\en>\n"
17622 #. type: Plain text
17623 #: build/C/man7/mdoc.samples.7:1732
17624 msgid "Another one:"
17627 #. type: Plain text
17628 #: build/C/man7/mdoc.samples.7:1739
17632 "\\&.It Cm S No \\&/ Ar old_pattern Xo\n"
17633 "\\&.No \\&/ Ar new_pattern\n"
17634 "\\&.No \\&/ Op Cm g\n"
17640 #: build/C/man7/mdoc.samples.7:1745
17642 msgid "Cm S No \\&/ Ar old_pattern Xo"
17645 #. type: Plain text
17646 #: build/C/man7/mdoc.samples.7:1750
17649 "E<.No \\&/ Ar new_pattern>\n"
17650 "E<.No \\&/ Op Cm g>\n"
17655 #. type: Plain text
17656 #: build/C/man7/mdoc.samples.7:1757
17658 "Another example of E<.Ql \\&.Xo> and using enclosure macros: Test the value "
17662 #. type: Plain text
17663 #: build/C/man7/mdoc.samples.7:1763
17668 "\\&.Oo \\e&! Oc Ns Ar variable\n"
17669 "\\&.Op Ar operator variable ...\n"
17674 #: build/C/man7/mdoc.samples.7:1768
17679 #. type: Plain text
17680 #: build/C/man7/mdoc.samples.7:1773
17684 "E<.Oo \\&! Oc Ns Ar variable>\n"
17685 "E<.Op Ar operator variable ...>\n"
17689 #. type: Plain text
17690 #: build/C/man7/mdoc.samples.7:1811
17692 "All of the above examples have used the E<.Ql \\&.Xo> macro on the argument "
17693 "list of the E<.Ql \\&.It> (list-item) macro. The extend macros are not "
17694 "used very often, and when they are it is usually to extend the list-item "
17695 "argument list. Unfortunately, this is also where the extend macros are the "
17696 "most finicky. In the first two examples, spacing was turned off; in the "
17697 "third, spacing was desired in part of the output but not all of it. To make "
17698 "these macros work in this situation make sure the E<.Ql \\&.Xo> and E<.Ql "
17699 "\\&.Xc> macros are placed as shown in the third example. If the E<.Ql "
17700 "\\&.Xo> macro is not alone on the E<.Ql \\&.It> argument list, spacing will "
17701 "be unpredictable. The E<.Ql \\&.Ns> (no space macro) must not occur as the "
17702 "first or last macro on a line in this situation. Out of 900 manual pages "
17703 "(about 1500 actual pages) currently released with E<.Bx> only fifteen use "
17704 "the E<.Ql \\&.Xo> macro."
17708 #: build/C/man7/mdoc.samples.7:1812
17710 msgid "Section Headers"
17713 #. type: Plain text
17714 #: build/C/man7/mdoc.samples.7:1825
17716 "The first three E<.Ql \\&.Sh> section header macros list below are required "
17717 "in every man page. The remaining section headers are recommended at the "
17718 "discretion of the author writing the manual page. The E<.Ql \\&.Sh> macro "
17719 "can take up to nine arguments. It is parsed and but is not callable."
17723 #: build/C/man7/mdoc.samples.7:1826
17725 msgid "\\&.Sh NAME"
17728 #. type: Plain text
17729 #: build/C/man7/mdoc.samples.7:1846
17731 "The E<.Ql \\&.Sh NAME> macro is mandatory. If not specified, the headers, "
17732 "footers and page layout defaults will not be set and things will be rather "
17733 "unpleasant. The E<.Sx NAME> section consists of at least three items. The "
17734 "first is the E<.Ql \\&.Nm> name macro naming the subject of the man page. "
17735 "The second is the Name Description macro, E<.Ql \\&.Nd>, which separates the "
17736 "subject name from the third item, which is the description. The description "
17737 "should be the most terse and lucid possible, as the space available is "
17742 #: build/C/man7/mdoc.samples.7:1846
17744 msgid "\\&.Sh SYNOPSIS"
17747 #. type: Plain text
17748 #: build/C/man7/mdoc.samples.7:1878
17750 "The E<.Sx SYNOPSIS> section describes the typical usage of the subject of a "
17751 "man page. The macros required are either E<.Ql \".Nm\">, E<.Ql \".Cd\">, "
17752 "E<.Ql \".Fn\">, (and possibly E<.Ql \".Fo\">, E<.Ql \".Fc\">, E<.Ql "
17753 "\".Fd\">, E<.Ql \".Ft\"> macros). The function name macro E<.Ql \".Fn\"> is "
17754 "required for manual page sections 2 and 3, the command and general name "
17755 "macro E<.Ql \\&.Nm> is required for sections 1, 5, 6, 7, 8. Section 4 "
17756 "manuals require a E<.Ql \".Nm\">, E<.Ql \".Fd\"> or a E<.Ql \".Cd\"> "
17757 "configuration device usage macro. Several other macros may be necessary to "
17758 "produce the synopsis line as shown below:"
17761 #. type: Plain text
17762 #: build/C/man7/mdoc.samples.7:1885
17766 "E<.Op Fl benstuv>\n"
17771 #. type: Plain text
17772 #: build/C/man7/mdoc.samples.7:1888
17773 msgid "The following macros were used:"
17777 #: build/C/man7/mdoc.samples.7:1889
17783 #: build/C/man7/mdoc.samples.7:1890
17785 msgid "\\&.Op \\&Fl benstuv"
17789 #: build/C/man7/mdoc.samples.7:1891
17791 msgid "\\&.Op \\&Fl"
17795 #: build/C/man7/mdoc.samples.7:1892
17800 #. type: Plain text
17801 #: build/C/man7/mdoc.samples.7:1903
17803 "E<.Sy Note>: The macros E<.Ql \\&.Op>, E<.Ql \\&.Fl>, and E<.Ql \\&.Ar> "
17804 "recognize the pipe bar character E<.Ql \\*(Ba>, so a command line such as:"
17808 #: build/C/man7/mdoc.samples.7:1904
17810 msgid ".Op Fl a | Fl b"
17813 #. type: Plain text
17814 #: build/C/man7/mdoc.samples.7:1913
17816 "will not go orbital. E<.Xr Troff> normally interprets a \\*(Ba as a special "
17817 "operator. See E<.Sx PREDEFINED STRINGS> for a usable \\*(Ba character in "
17818 "other situations."
17822 #: build/C/man7/mdoc.samples.7:1914
17824 msgid "\\&.Sh DESCRIPTION"
17827 #. type: Plain text
17828 #: build/C/man7/mdoc.samples.7:1931
17830 "In most cases the first text in the E<.Sx DESCRIPTION> section is a brief "
17831 "paragraph on the command, function or file, followed by a lexical list of "
17832 "options and respective explanations. To create such a list, the E<.Ql "
17833 "\\&.Bl> begin-list, E<.Ql \\&.It> list-item and E<.Ql \\&.El> end-list "
17834 "macros are used (see E<.Sx Lists and Columns> below)."
17837 #. type: Plain text
17838 #: build/C/man7/mdoc.samples.7:1940
17840 "The following E<.Ql \\&.Sh> section headers are part of the preferred manual "
17841 "page layout and must be used appropriately to maintain consistency. They "
17842 "are listed in the order in which they would be used."
17846 #: build/C/man7/mdoc.samples.7:1941
17848 msgid "\\&.Sh ENVIRONMENT"
17851 #. type: Plain text
17852 #: build/C/man7/mdoc.samples.7:1947
17854 "The E<.Sx ENVIRONMENT> section should reveal any related environment "
17855 "variables and clues to their behavior and/or usage."
17859 #: build/C/man7/mdoc.samples.7:1947
17861 msgid "\\&.Sh EXAMPLES"
17864 #. type: Plain text
17865 #: build/C/man7/mdoc.samples.7:1954
17867 "There are several ways to create examples. See the E<.Sx EXAMPLES> section "
17868 "below for details."
17872 #: build/C/man7/mdoc.samples.7:1954
17874 msgid "\\&.Sh FILES"
17877 #. type: Plain text
17878 #: build/C/man7/mdoc.samples.7:1961
17880 "Files which are used or created by the man page subject should be listed via "
17881 "the E<.Ql \\&.Pa> macro in the E<.Sx FILES> section."
17885 #: build/C/man7/mdoc.samples.7:1961
17887 msgid "\\&.Sh SEE ALSO"
17890 #. type: Plain text
17891 #: build/C/man7/mdoc.samples.7:1975
17893 "References to other material on the man page topic and cross references to "
17894 "other relevant man pages should be placed in the E<.Sx SEE ALSO> section. "
17895 "Cross references are specified using the E<.Ql \\&.Xr> macro. Cross "
17896 "references in the E<.Sx SEE ALSO> section should be sorted by section "
17897 "number, and then placed in alphabetical order and comma separated. For "
17901 #. type: Plain text
17902 #: build/C/man7/mdoc.samples.7:1980
17903 msgid "E<.Xr ls 1>, E<.Xr ps 1>, E<.Xr group 5>, E<.Xr passwd 5>."
17906 #. type: Plain text
17907 #: build/C/man7/mdoc.samples.7:1984
17908 msgid "At this time E<.Xr refer 1> style references are not accommodated."
17912 #: build/C/man7/mdoc.samples.7:1984
17914 msgid "\\&.Sh CONFORMING TO"
17917 #. type: Plain text
17918 #: build/C/man7/mdoc.samples.7:1996
17920 "If the command, library function or file adheres to a specific "
17921 "implementation such as E<.St -p1003.2> or E<.St -ansiC> this should be noted "
17922 "here. If the command does not adhere to any standard, its history should be "
17923 "noted in the E<.Sx HISTORY> section."
17927 #: build/C/man7/mdoc.samples.7:1996
17929 msgid "\\&.Sh HISTORY"
17932 #. type: Plain text
17933 #: build/C/man7/mdoc.samples.7:1999
17935 "Any command which does not adhere to any specific standards should be "
17936 "outlined historically in this section."
17940 #: build/C/man7/mdoc.samples.7:1999
17942 msgid "\\&.Sh AUTHORS"
17945 #. type: Plain text
17946 #: build/C/man7/mdoc.samples.7:2001
17947 msgid "Credits, if need be, should be placed here."
17951 #: build/C/man7/mdoc.samples.7:2001
17953 msgid "\\&.Sh DIAGNOSTICS"
17956 #. type: Plain text
17957 #: build/C/man7/mdoc.samples.7:2003
17958 msgid "Diagnostics from a command should be placed in this section."
17962 #: build/C/man7/mdoc.samples.7:2003
17964 msgid "\\&.Sh ERRORS"
17967 #. type: Plain text
17968 #: build/C/man7/mdoc.samples.7:2009
17970 "Specific error handling, especially from library functions (man page "
17971 "sections 2 and 3) should go here. The E<.Ql \\&.Er> macro is used to "
17972 "specify an errno."
17976 #: build/C/man7/mdoc.samples.7:2009
17978 msgid "\\&.Sh BUGS"
17981 #. type: Plain text
17982 #: build/C/man7/mdoc.samples.7:2011
17983 msgid "Blatant problems with the topic go here..."
17986 #. type: Plain text
17987 #: build/C/man7/mdoc.samples.7:2017
17989 "User specified E<.Ql \\&.Sh> sections may be added, for example, this "
17990 "section was set with:"
17993 #. type: Plain text
17994 #: build/C/man7/mdoc.samples.7:2019
17996 msgid "\\&.Sh PAGE STRUCTURE DOMAIN\n"
18000 #: build/C/man7/mdoc.samples.7:2020
18002 msgid "Paragraphs and Line Spacing."
18006 #: build/C/man7/mdoc.samples.7:2022
18011 #. type: Plain text
18012 #: build/C/man7/mdoc.samples.7:2038
18014 "The E<.Ql \\&.Pp> paragraph command may be used to specify a line space "
18015 "where necessary. The macro is not necessary after a E<.Ql \\&.Sh> or E<.Ql "
18016 "\\&.Ss> macro or before a E<.Ql \\&.Bl> macro. (The E<.Ql \\&.Bl> macro "
18017 "asserts a vertical distance unless the -compact flag is given)."
18020 #. This worked with version one, need to redo for version three
18023 #. .Cw (ax+bx+c) \ is\ produced\ by\ \&
18024 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
18041 #. .Em is produced by
18057 #. This example shows the same equation in a different format.
18061 #. signs were forced with
18065 #. .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
18066 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
18077 #. .Li \&.Cx \e\ +\e\ \e&
18088 #. .Em is produced by
18096 #. .Li \&.Cx \e\ +\e\ \e&
18107 #. The incantation below was
18113 #. .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
18115 #. .Li \&.Cx Op Sy ?/
18125 #. .Em is produced by
18127 #. .Li \&.Ar \e\ b1 e1 f1
18139 #: build/C/man7/mdoc.samples.7:2157
18144 #. type: Plain text
18145 #: build/C/man7/mdoc.samples.7:2186
18147 "The only keep that is implemented at this time is for words. The macros are "
18148 "E<.Ql \\&.Bk> (begin-keep) and E<.Ql \\&.Ek> (end-keep). The only option "
18149 "that E<.Ql \\&.Bk> accepts is E<.Fl words> and is useful for preventing line "
18150 "breaks in the middle of options. In the example for the make command-line "
18151 "arguments (see E<.Sx What's in a name>), the keep prevented E<.Xr nroff> "
18152 "from placing up the flag and the argument on separate lines. (Actually, the "
18153 "option macro used to prevent this from occurring, but was dropped when the "
18154 "decision (religious) was made to force right justified margins in E<.Xr "
18155 "troff> as options in general look atrocious when spread across a sparse "
18156 "line. More work needs to be done with the keep macros, a E<.Fl line> option "
18157 "needs to be added.)"
18161 #: build/C/man7/mdoc.samples.7:2186
18163 msgid "Examples and Displays"
18166 #. type: Plain text
18167 #: build/C/man7/mdoc.samples.7:2198
18169 "There are five types of displays, a quickie one line indented display E<.Ql "
18170 "\\&.D1>, a quickie one line literal display E<.Ql \\&.Dl>, and a block "
18171 "literal, block filled and block ragged which use the E<.Ql \\&.Bd> "
18172 "begin-display and E<.Ql \\&.Ed> end-display macros."
18175 #. type: Plain text
18176 #: build/C/man7/mdoc.samples.7:2203
18178 "(D-one) Display one line of indented text. This macro is parsed, but it is "
18183 #: build/C/man7/mdoc.samples.7:2204
18185 msgid "Fl ldghfstru"
18188 #. type: Plain text
18189 #: build/C/man7/mdoc.samples.7:2208
18190 msgid "The above was produced by: E<.Li \\&.Dl Fl ldghfstru>."
18193 #. type: Plain text
18194 #: build/C/man7/mdoc.samples.7:2223
18196 "(D-ell) Display one line of indented E<.Em literal> text. The E<.Ql "
18197 "\\&.Dl> example macro has been used throughout this file. It allows the "
18198 "indent (display) of one line of text. Its default font is set to constant "
18199 "width (literal) however it is parsed and will recognized other macros. It "
18200 "is not callable however."
18204 #: build/C/man7/mdoc.samples.7:2224
18206 msgid "% ls -ldg /usr/local/bin"
18209 #. type: Plain text
18210 #: build/C/man7/mdoc.samples.7:2228
18211 msgid "The above was produced by E<.Li \\&.Dl % ls -ldg /usr/local/bin>."
18214 #. type: Plain text
18215 #: build/C/man7/mdoc.samples.7:2239
18217 "Begin-display. The E<.Ql \\&.Bd> display must be ended with the E<.Ql "
18218 "\\&.Ed> macro. Displays may be nested within displays and lists. E<.Ql "
18219 "\\&.Bd> has the following syntax:"
18223 #: build/C/man7/mdoc.samples.7:2240
18225 msgid ".Bd display-type [-offset offset_value] [-compact]"
18228 #. type: Plain text
18229 #: build/C/man7/mdoc.samples.7:2245
18231 "The display-type must be one of the following four types and may have an "
18232 "offset specifier for indentation: E<.Ql \\&.Bd>."
18235 #. type: Plain text
18236 #: build/C/man7/mdoc.samples.7:2251
18238 "Display a block of text as typed, right (and left) margin edges are left "
18242 #. type: Plain text
18243 #: build/C/man7/mdoc.samples.7:2255
18245 "Display a filled (formatted) block. The block of text is formatted (the "
18246 "edges are filled \\- not left unjustified)."
18249 #. type: Plain text
18250 #: build/C/man7/mdoc.samples.7:2258
18252 "Display a literal block, useful for source code or simple tabbed or spaced "
18257 #: build/C/man7/mdoc.samples.7:2258
18259 msgid "Fl file Ar file_name"
18262 #. type: Plain text
18263 #: build/C/man7/mdoc.samples.7:2267
18265 "The filename following the E<.Fl file> flag is read and displayed. Literal "
18266 "mode is asserted and tabs are set at 8 constant width character intervals, "
18267 "however any E<.Xr troff/ Ns Nm \\-mdoc> commands in file will be processed."
18270 #. type: Plain text
18271 #: build/C/man7/mdoc.samples.7:2273
18273 "If E<.Fl offset> is specified with one of the following strings, the string "
18274 "is interpreted to indicate the level of indentation for the forthcoming "
18278 #. type: Plain text
18279 #: build/C/man7/mdoc.samples.7:2279
18281 "Align block on the current left margin, this is the default mode of E<.Ql "
18285 #. type: Plain text
18286 #: build/C/man7/mdoc.samples.7:2284
18288 "Supposedly center the block. At this time unfortunately, the block merely "
18289 "gets left aligned about an imaginary center margin."
18292 #. type: Plain text
18293 #: build/C/man7/mdoc.samples.7:2293
18295 "Indents by one default indent value or tab. The default indent value is "
18296 "also used for the E<.Ql \\&.D1> display so one is guaranteed the two types "
18297 "of displays will line up. This indent is normally set to 6n or about two "
18298 "thirds of an inch (six constant width characters)."
18301 #. type: Plain text
18302 #: build/C/man7/mdoc.samples.7:2295
18303 msgid "Indents two times the default indent value."
18306 #. type: Plain text
18307 #: build/C/man7/mdoc.samples.7:2303
18309 "This E<.Em left> aligns the block about two inches from the right side of "
18310 "the page. This macro needs work and perhaps may never do the right thing by "
18315 #: build/C/man7/mdoc.samples.7:2304
18320 #. type: Plain text
18321 #: build/C/man7/mdoc.samples.7:2306
18322 msgid "End-display."
18326 #: build/C/man7/mdoc.samples.7:2307
18331 #. type: Plain text
18332 #: build/C/man7/mdoc.samples.7:2309
18333 msgid "There are five macros for changing the appearance of the manual page text:"
18337 #: build/C/man7/mdoc.samples.7:2310
18342 #. type: Plain text
18343 #: build/C/man7/mdoc.samples.7:2315
18345 "Text may be stressed or emphasized with the E<.Ql \\&.Em> macro. The usual "
18346 "font for emphasis is italic."
18350 #: build/C/man7/mdoc.samples.7:2316
18352 msgid "Usage: .Em argument ... \\*(Pu"
18356 #: build/C/man7/mdoc.samples.7:2318
18358 msgid "Li \".Em does not\""
18361 #. type: Plain text
18362 #: build/C/man7/mdoc.samples.7:2320
18363 msgid "E<.Em does not>"
18367 #: build/C/man7/mdoc.samples.7:2320
18369 msgid "Li \".Em exceed 1024 .\""
18372 #. type: Plain text
18373 #: build/C/man7/mdoc.samples.7:2322
18374 msgid "E<.Em exceed 1024>."
18378 #: build/C/man7/mdoc.samples.7:2322
18380 msgid "Li \".Em vide infra ) ) ,\""
18383 #. type: Plain text
18384 #: build/C/man7/mdoc.samples.7:2324
18385 msgid "E<.Em vide infra>)),"
18388 #. type: Plain text
18389 #: build/C/man7/mdoc.samples.7:2332
18391 "The E<.Ql \\&.Em> macro is parsed and is callable. It is an error to call "
18392 "E<.Ql \\&.Em> without arguments."
18396 #: build/C/man7/mdoc.samples.7:2332
18401 #. type: Plain text
18402 #: build/C/man7/mdoc.samples.7:2338
18404 "The E<.Ql \\&.Li> literal macro may be used for special characters, variable "
18405 "constants, anything which should be displayed as it would be typed."
18409 #: build/C/man7/mdoc.samples.7:2339
18411 msgid "Usage: .Li argument ... \\*(Pu"
18415 #: build/C/man7/mdoc.samples.7:2341
18417 msgid "Li \\&.Li \\een"
18420 #. type: Plain text
18421 #: build/C/man7/mdoc.samples.7:2343
18422 msgid "E<.Li \\en>"
18426 #: build/C/man7/mdoc.samples.7:2343
18428 msgid "Li \\&.Li M1 M2 M3\\ ;"
18431 #. type: Plain text
18432 #: build/C/man7/mdoc.samples.7:2345
18433 msgid "E<.Li M1 M2 M3>;"
18437 #: build/C/man7/mdoc.samples.7:2345
18439 msgid "Li \\&.Li cntrl-D\\ )\\ ,"
18442 #. type: Plain text
18443 #: build/C/man7/mdoc.samples.7:2347
18444 msgid "E<.Li cntrl-D>),"
18448 #: build/C/man7/mdoc.samples.7:2347
18450 msgid "Li \\&.Li 1024\\ ..."
18453 #. type: Plain text
18454 #: build/C/man7/mdoc.samples.7:2349
18455 msgid "E<.Li 1024 ...>"
18458 #. type: Plain text
18459 #: build/C/man7/mdoc.samples.7:2354
18460 msgid "The E<.Ql \\&.Li> macro is parsed and is callable."
18464 #: build/C/man7/mdoc.samples.7:2354
18469 #. type: Plain text
18470 #: build/C/man7/mdoc.samples.7:2357
18472 "The symbolic emphasis macro is generally a boldface macro in either the "
18473 "symbolic sense or the traditional English usage."
18477 #: build/C/man7/mdoc.samples.7:2358
18479 msgid "Usage: .Sy symbol ... \\*(Pu"
18483 #: build/C/man7/mdoc.samples.7:2360
18485 msgid "Li \\&.Sy Important Notice"
18488 #. type: Plain text
18489 #: build/C/man7/mdoc.samples.7:2362
18490 msgid "E<.Sy Important Notice>"
18493 #. type: Plain text
18494 #: build/C/man7/mdoc.samples.7:2369
18496 "The E<.Ql \\&.Sy> macro is parsed and is callable. Arguments to E<.Ql "
18497 "\\&.Sy> may be quoted."
18501 #: build/C/man7/mdoc.samples.7:2370
18506 #. type: Plain text
18507 #: build/C/man7/mdoc.samples.7:2380
18509 "Begin font mode. The E<.Ql \\&.Bf> font mode must be ended with the E<.Ql "
18510 "\\&.Ef> macro. Font modes may be nested within other font modes. E<.Ql "
18511 "\\&.Bf> has the following syntax:"
18515 #: build/C/man7/mdoc.samples.7:2381
18517 msgid ".Bf font-mode"
18520 #. type: Plain text
18521 #: build/C/man7/mdoc.samples.7:2385
18522 msgid "The font-mode must be one of the following three types: E<.Ql \\&.Bf>."
18526 #: build/C/man7/mdoc.samples.7:2387
18528 msgid "Sy \\&Em | Fl emphasis"
18531 #. type: Plain text
18532 #: build/C/man7/mdoc.samples.7:2391
18533 msgid "Same as if the E<.Ql \\&.Em> macro was used for the entire block of text."
18537 #: build/C/man7/mdoc.samples.7:2391
18539 msgid "Sy \\&Li | Fl literal"
18542 #. type: Plain text
18543 #: build/C/man7/mdoc.samples.7:2395
18544 msgid "Same as if the E<.Ql \\&.Li> macro was used for the entire block of text."
18548 #: build/C/man7/mdoc.samples.7:2395
18550 msgid "Sy \\&Sy | Fl symbolic"
18553 #. type: Plain text
18554 #: build/C/man7/mdoc.samples.7:2399
18555 msgid "Same as if the E<.Ql \\&.Sy> macro was used for the entire block of text."
18559 #: build/C/man7/mdoc.samples.7:2400
18564 #. type: Plain text
18565 #: build/C/man7/mdoc.samples.7:2402
18566 msgid "End font mode."
18570 #: build/C/man7/mdoc.samples.7:2403
18572 msgid "Tagged Lists and Columns"
18575 #. type: Plain text
18576 #: build/C/man7/mdoc.samples.7:2417
18578 "There are several types of lists which may be initiated with the E<.Ql "
18579 "\".Bl\"> begin-list macro. Items within the list are specified with the "
18580 "E<.Ql \".It\"> item macro and each list must end with the E<.Ql \".El\"> "
18581 "macro. Lists may be nested within themselves and within displays. Columns "
18582 "may be used inside of lists, but lists are unproven inside of columns."
18585 #. type: Plain text
18586 #: build/C/man7/mdoc.samples.7:2432
18588 "In addition, several list attributes may be specified such as the width of a "
18589 "tag, the list offset, and compactness (blank lines between items allowed or "
18590 "disallowed). Most of this document has been formatted with a tag style list "
18591 "E<.Pq Fl tag>. For a change of pace, the list-type used to present the "
18592 "list-types is an over-hanging list E<.Pq Fl ohang>. This type of list is "
18593 "quite popular with E<.Tn TeX> users, but might look a bit funny after having "
18594 "read many pages of tagged lists. The following list types are accepted by "
18599 #: build/C/man7/mdoc.samples.7:2434
18605 #: build/C/man7/mdoc.samples.7:2435
18611 #: build/C/man7/mdoc.samples.7:2436
18616 #. type: Plain text
18617 #: build/C/man7/mdoc.samples.7:2446
18619 "These three are the simplest types of lists. Once the E<.Ql \".Bl\"> macro "
18620 "has been given, items in the list are merely indicated by a line consisting "
18621 "solely of the E<.Ql \".It\"> macro. For example, the source text for a "
18622 "simple enumerated list would look like:"
18625 #. type: Plain text
18626 #: build/C/man7/mdoc.samples.7:2455
18629 "\\&.Bl -enum -compact\n"
18631 "\\&Item one goes here.\n"
18633 "\\&And item two here.\n"
18635 "\\&Lastly item three goes here.\n"
18639 #. type: Plain text
18640 #: build/C/man7/mdoc.samples.7:2459
18641 msgid "The results:"
18644 #. type: Plain text
18645 #: build/C/man7/mdoc.samples.7:2463
18646 msgid "Item one goes here."
18649 #. type: Plain text
18650 #: build/C/man7/mdoc.samples.7:2465
18651 msgid "And item two here."
18654 #. type: Plain text
18655 #: build/C/man7/mdoc.samples.7:2467
18656 msgid "Lastly item three goes here."
18659 #. type: Plain text
18660 #: build/C/man7/mdoc.samples.7:2470
18661 msgid "A simple bullet list construction:"
18664 #. type: Plain text
18665 #: build/C/man7/mdoc.samples.7:2477
18668 "\\&.Bl -bullet -compact\n"
18670 "\\&Bullet one goes here.\n"
18672 "\\&Bullet two here.\n"
18676 #. type: Plain text
18677 #: build/C/man7/mdoc.samples.7:2483
18678 msgid "Bullet one goes here."
18681 #. type: Plain text
18682 #: build/C/man7/mdoc.samples.7:2485
18683 msgid "Bullet two here."
18687 #: build/C/man7/mdoc.samples.7:2488
18693 #: build/C/man7/mdoc.samples.7:2489
18699 #: build/C/man7/mdoc.samples.7:2490
18705 #: build/C/man7/mdoc.samples.7:2491
18711 #: build/C/man7/mdoc.samples.7:2492
18716 #. type: Plain text
18717 #: build/C/man7/mdoc.samples.7:2512
18719 "These list-types collect arguments specified with the E<.Ql \\&.It> macro "
18720 "and create a label which may be E<.Em inset> into the forthcoming text, "
18721 "E<.Em hanged> from the forthcoming text, E<.Em overhanged> from above and "
18722 "not indented or E<.Em tagged>. This list was constructed with the E<.Ql "
18723 "\\&Fl ohang> list-type. The E<.Ql \\&.It> macro is parsed only for the "
18724 "inset, hang and tag list-types and is not callable. Here is an example of "
18729 #: build/C/man7/mdoc.samples.7:2514
18734 #. type: Plain text
18735 #: build/C/man7/mdoc.samples.7:2517
18737 "The tagged list (also called a tagged paragraph) is the most common type of "
18738 "list used in the Berkeley manuals."
18742 #: build/C/man7/mdoc.samples.7:2517
18747 #. type: Plain text
18748 #: build/C/man7/mdoc.samples.7:2521
18750 "Diag lists create section four diagnostic lists and are similar to inset "
18751 "lists except callable macros are ignored."
18755 #: build/C/man7/mdoc.samples.7:2521
18760 #. type: Plain text
18761 #: build/C/man7/mdoc.samples.7:2523
18762 msgid "Hanged labels are a matter of taste."
18766 #: build/C/man7/mdoc.samples.7:2523
18771 #. type: Plain text
18772 #: build/C/man7/mdoc.samples.7:2525
18773 msgid "Overhanging labels are nice when space is constrained."
18777 #: build/C/man7/mdoc.samples.7:2525
18782 #. type: Plain text
18783 #: build/C/man7/mdoc.samples.7:2530
18785 "Inset labels are useful for controlling blocks of paragraphs and are "
18786 "valuable for converting E<.Nm \\-mdoc> manuals to other formats."
18789 #. type: Plain text
18790 #: build/C/man7/mdoc.samples.7:2533
18791 msgid "Here is the source text which produced the above example:"
18794 #. type: Plain text
18795 #: build/C/man7/mdoc.samples.7:2552
18798 "\\&.Bl -inset -offset indent\n"
18800 "\\&The tagged list (also called a tagged paragraph) is the\n"
18801 "\\&most common type of list used in the Berkeley manuals.\n"
18803 "\\&Diag lists create section four diagnostic lists\n"
18804 "\\&and are similar to inset lists except callable\n"
18805 "\\¯os are ignored.\n"
18807 "\\&Hanged labels are a matter of taste.\n"
18808 "\\&.It Em Ohang\n"
18809 "\\&Overhanging labels are nice when space is constrained.\n"
18810 "\\&.It Em Inset\n"
18811 "\\&Inset labels are useful for controlling blocks of\n"
18812 "\\¶graphs and are valuable for converting\n"
18814 "\\&manuals to other formats.\n"
18818 #. type: Plain text
18819 #: build/C/man7/mdoc.samples.7:2555
18820 msgid "Here is a hanged list with two items:"
18824 #: build/C/man7/mdoc.samples.7:2556
18829 #. type: Plain text
18830 #: build/C/man7/mdoc.samples.7:2559
18832 "labels appear similar to tagged lists when the label is smaller than the "
18837 #: build/C/man7/mdoc.samples.7:2559
18839 msgid "Em Longer hanged list labels"
18842 #. type: Plain text
18843 #: build/C/man7/mdoc.samples.7:2562
18844 msgid "blend in to the paragraph unlike tagged paragraph labels."
18847 #. type: Plain text
18848 #: build/C/man7/mdoc.samples.7:2565
18849 msgid "And the unformatted text which created it:"
18852 #. type: Plain text
18853 #: build/C/man7/mdoc.samples.7:2574
18856 "\\&.Bl -hang -offset indent\n"
18857 "\\&.It Em Hanged\n"
18858 "\\&labels appear similar to tagged lists when the\n"
18859 "\\&label is smaller than the label width.\n"
18860 "\\&.It Em Longer hanged list labels\n"
18861 "\\&blend in to the paragraph unlike\n"
18862 "\\&tagged paragraph labels.\n"
18866 #. type: Plain text
18867 #: build/C/man7/mdoc.samples.7:2578
18869 "The tagged list which follows uses an optional width specifier to control "
18870 "the width of the tag."
18874 #: build/C/man7/mdoc.samples.7:2580
18879 #. type: Plain text
18880 #: build/C/man7/mdoc.samples.7:2582
18881 msgid "sleep time of the process (seconds blocked)"
18885 #: build/C/man7/mdoc.samples.7:2582
18890 #. type: Plain text
18891 #: build/C/man7/mdoc.samples.7:2587
18893 "number of disk E<.Tn I/O Ns 's> resulting from references by the process to "
18894 "pages not loaded in core."
18898 #: build/C/man7/mdoc.samples.7:2587
18903 #. type: Plain text
18904 #: build/C/man7/mdoc.samples.7:2589
18905 msgid "numerical user-id of process owner"
18909 #: build/C/man7/mdoc.samples.7:2589
18914 #. type: Plain text
18915 #: build/C/man7/mdoc.samples.7:2592
18917 "numerical ID of parent of process process priority (nonpositive when in "
18918 "noninterruptible wait)"
18921 #. type: Plain text
18922 #: build/C/man7/mdoc.samples.7:2595
18923 msgid "The raw text:"
18926 #. type: Plain text
18927 #: build/C/man7/mdoc.samples.7:2610
18930 "\\&.Bl -tag -width \"PAGEIN\" -compact -offset indent\n"
18932 "\\&sleep time of the process (seconds blocked)\n"
18934 "\\&number of disk\n"
18935 "\\&.Tn I/O Ns 's\n"
18936 "\\&resulting from references\n"
18937 "\\&by the process to pages not loaded in core.\n"
18939 "\\&numerical user ID of process owner\n"
18941 "\\&numerical ID of parent of process process priority\n"
18942 "\\&(nonpositive when in noninterruptible wait)\n"
18946 #. type: Plain text
18947 #: build/C/man7/mdoc.samples.7:2613
18948 msgid "Acceptable width specifiers:"
18952 #: build/C/man7/mdoc.samples.7:2614
18954 msgid "Fl width Ar \\&Fl"
18957 #. type: Plain text
18958 #: build/C/man7/mdoc.samples.7:2623
18960 "sets the width to the default width for a flag. All callable macros have a "
18961 "default width value. The E<.Ql \\&.Fl>, value is presently set to ten "
18962 "constant width characters or about five sixth of an inch."
18966 #: build/C/man7/mdoc.samples.7:2623
18968 msgid "Fl width Ar 24n"
18971 #. type: Plain text
18972 #: build/C/man7/mdoc.samples.7:2629
18974 "sets the width to 24 constant width characters or about two inches. The "
18975 "E<.Ql n> is absolutely necessary for the scaling to work correctly."
18979 #: build/C/man7/mdoc.samples.7:2629
18981 msgid "Fl width Ar ENAMETOOLONG"
18984 #. type: Plain text
18985 #: build/C/man7/mdoc.samples.7:2632
18986 msgid "sets width to the constant width length of the string given."
18990 #: build/C/man7/mdoc.samples.7:2632
18992 msgid "Fl width Ar \"\\*qint mkfifo\\*q\""
18995 #. type: Plain text
18996 #: build/C/man7/mdoc.samples.7:2635
18997 msgid "again, the width is set to the constant width of the string given."
19000 #. type: Plain text
19001 #: build/C/man7/mdoc.samples.7:2649
19003 "If a width is not specified for the tag list type, the first time E<.Ql "
19004 "\\&.It> is invoked, an attempt is made to determine an appropriate width. "
19005 "If the first argument to E<.Ql \".It\"> is a callable macro, the default "
19006 "width for that macro will be used as if the macro name had been supplied as "
19007 "the width. However, if another item in the list is given with a different "
19008 "callable macro name, a new and nested list is assumed."
19012 #: build/C/man7/mdoc.samples.7:2649
19014 msgid "PREDEFINED STRINGS"
19017 #. type: Plain text
19018 #: build/C/man7/mdoc.samples.7:2661
19020 "The following strings are predefined as may be used by preceding with the "
19021 "troff string interpreting sequence E<.Ql \\&\\e*(xx> where E<.Em xx> is the "
19022 "name of the defined string or as E<.Ql \\&\\e*x> where E<.Em x> is the name "
19023 "of the string. The interpreting sequence may be used any where in the text."
19027 #: build/C/man7/mdoc.samples.7:2663
19029 msgid "Sy \"String\tNroff\tTroff\""
19033 #: build/C/man7/mdoc.samples.7:2664
19035 msgid "Li E<lt>= Ta \\&E<lt>\\&= Ta \\*(E<lt>="
19039 #: build/C/man7/mdoc.samples.7:2665
19041 msgid "Li E<gt>= Ta \\&E<gt>\\&= Ta \\*(E<gt>="
19045 #: build/C/man7/mdoc.samples.7:2666
19047 msgid "Li Rq Ta '' Ta \\*(Rq"
19051 #: build/C/man7/mdoc.samples.7:2667
19053 msgid "Li Lq Ta `` Ta \\*(Lq"
19057 #: build/C/man7/mdoc.samples.7:2668
19059 msgid "Li ua Ta ^ Ta \\*(ua"
19063 #: build/C/man7/mdoc.samples.7:2669
19065 msgid "Li aa Ta ' Ta \\*(aa"
19069 #: build/C/man7/mdoc.samples.7:2670
19071 msgid "Li ga Ta \\` Ta \\*(ga"
19074 #. .It Li "sL" Ta ` Ta \*(sL
19075 #. .It Li "sR" Ta ' Ta \*(sR
19077 #: build/C/man7/mdoc.samples.7:2673
19079 msgid "Li q Ta \\(dq Ta \\*q"
19083 #: build/C/man7/mdoc.samples.7:2674
19085 msgid "Li Pi Ta pi Ta \\*(Pi"
19089 #: build/C/man7/mdoc.samples.7:2675
19091 msgid "Li Ne Ta != Ta \\*(Ne"
19095 #: build/C/man7/mdoc.samples.7:2676
19097 msgid "Li Le Ta E<lt>= Ta \\*(Le"
19101 #: build/C/man7/mdoc.samples.7:2677
19103 msgid "Li Ge Ta E<gt>= Ta \\*(Ge"
19107 #: build/C/man7/mdoc.samples.7:2678
19109 msgid "Li Lt Ta E<lt> Ta \\*(Gt"
19113 #: build/C/man7/mdoc.samples.7:2679
19115 msgid "Li Gt Ta E<gt> Ta \\*(Lt"
19119 #: build/C/man7/mdoc.samples.7:2680
19121 msgid "Li Pm Ta +- Ta \\*(Pm"
19125 #: build/C/man7/mdoc.samples.7:2681
19127 msgid "Li If Ta infinity Ta \\*(If"
19131 #: build/C/man7/mdoc.samples.7:2682
19133 msgid "Li Na Ta I<NaN> Ta \\*(Na"
19137 #: build/C/man7/mdoc.samples.7:2683
19139 msgid "Li Ba Ta \\&| Ta \\*(Ba"
19142 #. type: Plain text
19143 #: build/C/man7/mdoc.samples.7:2692
19145 "E<.Sy Note>: The string named E<.Ql q> should be written as E<.Ql \\e*q> "
19146 "since it is only one char."
19150 #: build/C/man7/mdoc.samples.7:2692
19152 msgid "DIAGNOSTICS"
19155 #. type: Plain text
19156 #: build/C/man7/mdoc.samples.7:2725
19158 "The debugging facilities for E<.Nm \\-mdoc> are limited, but can help detect "
19159 "subtle errors such as the collision of an argument name with an internal "
19160 "register or macro name. (A what?) A register is an arithmetic storage "
19161 "class for E<.Xr troff> with a one or two character name. All registers "
19162 "internal to E<.Nm \\-mdoc> for E<.Xr troff> and E<.Xr ditroff> are two "
19163 "characters and of the form E<lt>upper_caseE<gt>E<lt>lower_caseE<gt> such as "
19164 "E<.Ql \\&Ar>, E<lt>lower_caseE<gt>E<lt>upper_caseE<gt> as E<.Ql \\&aR> or "
19165 "E<lt>upper or lower letterE<gt>E<lt>digitE<gt> as E<.Ql \\&C\\&1>. And "
19166 "adding to the muddle, E<.Xr troff> has its own internal registers all of "
19167 "which are either two lower case characters or a dot plus a letter or "
19168 "metacharacter character. In one of the introduction examples, it was shown "
19169 "how to prevent the interpretation of a macro name with the escape sequence "
19170 "E<.Ql \\e&>. This is sufficient for the internal register names also."
19173 #. Every callable macro name has a corresponding register
19174 #. of the same name (<upper_case><lower_case>).
19175 #. There are also specific registers which have
19176 #. been used for stacks and arrays and are listed in the
19178 #. .Bd -ragged -offset 4n
19179 #. [A-Z][a-z] registers corresponding to macro names (example ``Ar'')
19180 #. [a-z][A-Z] registers corresponding to macro names (example ``aR'')
19181 #. C[0-9] argument types (example C1)
19182 #. O[0-9] offset stack (displays)
19183 #. h[0-9] horizontal spacing stack (lists)
19184 #. o[0-9] offset (stack) (lists)
19185 #. t[0-9] tag stack (lists)
19186 #. v[0-9] vertical spacing stack (lists)
19187 #. w[0-9] width tag/label stack
19190 #. type: Plain text
19191 #: build/C/man7/mdoc.samples.7:2764
19193 "If a nonescaped register name is given in the argument list of a request "
19194 "unpredictable behavior will occur. In general, any time huge portions of "
19195 "text do not appear where expected in the output, or small strings such as "
19196 "list tags disappear, chances are there is a misunderstanding about an "
19197 "argument type in the argument list. Your mother never intended for you to "
19198 "remember this evil stuff - so here is a way to find out whether or not your "
19199 "arguments are valid: The E<.Ql \\&.Db> (debug) macro displays the "
19200 "interpretation of the argument list for most macros. Macros such as the "
19201 "E<.Ql \\&.Pp> (paragraph) macro do not contain debugging information. All "
19202 "of the callable macros do, and it is strongly advised whenever in doubt, "
19203 "turn on the E<.Ql \\&.Db> macro."
19207 #: build/C/man7/mdoc.samples.7:2765
19209 msgid "Usage: \\&.Db [on | off]"
19212 #. type: Plain text
19213 #: build/C/man7/mdoc.samples.7:2774
19215 "An example of a portion of text with the debug macro placed above and below "
19216 "an artificially created problem (a flag argument E<.Ql \\&aC> which should "
19217 "be E<.Ql \\e&aC> in order to work):"
19220 #. type: Plain text
19221 #: build/C/man7/mdoc.samples.7:2778
19225 "\\&.Op Fl aC Ar file )\n"
19229 #. type: Plain text
19230 #: build/C/man7/mdoc.samples.7:2781
19231 msgid "The resulting output:"
19234 #. type: Plain text
19235 #: build/C/man7/mdoc.samples.7:2796
19239 "DEBUG(argv) MACRO: `.Op' Line #: 2\n"
19240 "\tArgc: 1 Argv: `Fl' Length: 2\n"
19241 "\tSpace: `' Class: Executable\n"
19242 "\tArgc: 2 Argv: `aC' Length: 2\n"
19243 "\tSpace: `' Class: Executable\n"
19244 "\tArgc: 3 Argv: `Ar' Length: 2\n"
19245 "\tSpace: `' Class: Executable\n"
19246 "\tArgc: 4 Argv: `file' Length: 4\n"
19247 "\tSpace: ` ' Class: String\n"
19248 "\tArgc: 5 Argv: `)' Length: 1\n"
19249 "\tSpace: ` ' Class: Closing Punctuation or suffix\n"
19250 "\tMACRO REQUEST: .Op Fl aC Ar file )\n"
19254 #. type: Plain text
19255 #: build/C/man7/mdoc.samples.7:2823
19257 "The first line of information tells the name of the calling macro, here "
19258 "E<.Ql \\&.Op>, and the line number it appears on. If one or more files are "
19259 "involved (especially if text from another file is included) the line number "
19260 "may be bogus. If there is only one file, it should be accurate. The second "
19261 "line gives the argument count, the argument E<.Pq Ql \\&Fl> and its length. "
19262 "If the length of an argument is two characters, the argument is tested to "
19263 "see if it is executable (unfortunately, any register which contains a "
19264 "nonzero value appears executable). The third line gives the space allotted "
19265 "for a class, and the class type. The problem here is the argument aC should "
19266 "not be executable. The four types of classes are string, executable, "
19267 "closing punctuation and opening punctuation. The last line shows the entire "
19268 "argument list as it was read. In this next example, the offending E<.Ql "
19269 "\\&aC> is escaped:"
19272 #. type: Plain text
19273 #: build/C/man7/mdoc.samples.7:2827
19277 "\\&.Em An escaped \\e&aC\n"
19281 #. type: Plain text
19282 #: build/C/man7/mdoc.samples.7:2839
19286 "DEBUG(fargv) MACRO: `.Em' Line #: 2\n"
19287 "\tArgc: 1 Argv: `An' Length: 2\n"
19288 "\tSpace: ` ' Class: String\n"
19289 "\tArgc: 2 Argv: `escaped' Length: 7\n"
19290 "\tSpace: ` ' Class: String\n"
19291 "\tArgc: 3 Argv: `aC' Length: 2\n"
19292 "\tSpace: ` ' Class: String\n"
19293 "\tMACRO REQUEST: .Em An escaped &aC\n"
19297 #. type: Plain text
19298 #: build/C/man7/mdoc.samples.7:2849
19300 "The argument E<.Ql \\e&aC> shows up with the same length of 2 as the E<.Ql "
19301 "\\e&> sequence produces a zero width, but a register named E<.Ql \\e&aC> was "
19302 "not found and the type classified as string."
19305 #. type: Plain text
19306 #: build/C/man7/mdoc.samples.7:2851
19307 msgid "Other diagnostics consist of usage statements and are self explanatory."
19311 #: build/C/man7/mdoc.samples.7:2851
19313 msgid "GROFF, TROFF AND NROFF"
19316 #. type: Plain text
19317 #: build/C/man7/mdoc.samples.7:2856
19319 "The E<.Nm \\-mdoc> package does not need compatibility mode with E<.Xr "
19323 #. type: Plain text
19324 #: build/C/man7/mdoc.samples.7:2874
19326 "The package inhibits page breaks, and the headers and footers which normally "
19327 "occur at those breaks with E<.Xr nroff>, to make the manual more efficient "
19328 "for viewing on-line. At the moment, E<.Xr groff> with E<.Fl T Ns Ar ascii> "
19329 "does eject the imaginary remainder of the page at end of file. The "
19330 "inhibiting of the page breaks makes E<.Xr nroff Ns 'd> files unsuitable for "
19331 "hardcopy. There is a register named E<.Ql \\&cR> which can be set to zero "
19332 "in the site dependent style file E<.Pa /usr/src/share/tmac/doc-nroff> to "
19333 "restore the old style behavior."
19337 #: build/C/man7/mdoc.samples.7:2876
19339 msgid "Pa /usr/share/tmac/doc.tmac"
19342 #. type: Plain text
19343 #: build/C/man7/mdoc.samples.7:2878
19344 msgid "manual macro package"
19348 #: build/C/man7/mdoc.samples.7:2878
19350 msgid "Pa /usr/share/misc/mdoc.template"
19353 #. type: Plain text
19354 #: build/C/man7/mdoc.samples.7:2880
19355 msgid "template for writing a man page"
19359 #: build/C/man7/mdoc.samples.7:2880
19361 msgid "Pa /usr/share/examples/mdoc/*"
19364 #. type: Plain text
19365 #: build/C/man7/mdoc.samples.7:2882
19366 msgid "several example man pages"
19369 #. type: Plain text
19370 #: build/C/man7/mdoc.samples.7:2890
19372 "Undesirable hyphenation on the dash of a flag argument is not yet resolved, "
19373 "and causes occasional mishaps in the E<.Sx DESCRIPTION> section. (line "
19374 "break on the hyphen)."
19377 #. type: Plain text
19378 #: build/C/man7/mdoc.samples.7:2892
19379 msgid "Predefined strings are not declared in documentation."
19382 #. type: Plain text
19383 #: build/C/man7/mdoc.samples.7:2894
19384 msgid "Section 3f has not been added to the header routines."
19387 #. type: Plain text
19388 #: build/C/man7/mdoc.samples.7:2899
19389 msgid "E<.Ql \\&.Nm> font should be changed in E<.Sx NAME> section."
19392 #. type: Plain text
19393 #: build/C/man7/mdoc.samples.7:2906
19395 "E<.Ql \\&.Fn> needs to have a check to prevent splitting up if the line "
19396 "length is too short. Occasionally it separates the last parenthesis, and "
19397 "sometimes looks ridiculous if a line is in fill mode."
19400 #. type: Plain text
19401 #: build/C/man7/mdoc.samples.7:2911
19403 "The method used to prevent header and footer page breaks (other than the "
19404 "initial header and footer) when using nroff occasionally places an unsightly "
19405 "partially filled line (blank) at the would be bottom of the page."
19408 #. Note what happens if the parameter list overlaps a newline
19410 #. to make sure a line boundary is crossed:
19412 #. \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
19415 #. produces, nudge nudge,
19416 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
19417 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
19419 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
19421 #. If double quotes are used, for example:
19423 #. \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
19426 #. produces, nudge nudge,
19427 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
19429 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
19431 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
19433 #. Not a pretty sight...
19434 #. In a paragraph, a long parameter containing unpaddable spaces as
19435 #. in the former example will cause
19437 #. to break the line and spread
19438 #. the remaining words out.
19439 #. The latter example will adjust nicely to
19440 #. justified margins, but may break in between an argument and its
19444 #. the right margin adjustment is normally ragged and the problem is
19446 #. type: Plain text
19447 #: build/C/man7/mdoc.samples.7:2952
19449 "The list and display macros to not do any keeps and certainly should be able "
19453 #. type: Plain text
19454 #: build/C/man7/mdoc.samples.7:2957
19455 msgid "E<.Xr man 1>, E<.Xr troff 1>, E<.Xr groff_mdoc 7>, E<.Xr mdoc 7>"