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: 2015-01-23 22:24+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man7/feature_test_macros.7:25
22 msgid "FEATURE_TEST_MACROS"
26 #: build/C/man7/feature_test_macros.7:25
32 #: build/C/man7/feature_test_macros.7:25 build/C/man1/intro.1: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:55 build/C/man7/standards.7:24 build/C/man7/suffixes.7:39 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:55 build/C/man7/standards.7:24 build/C/man7/suffixes.7:39 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:56 build/C/man7/standards.7:25 build/C/man7/suffixes.7:40 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:58 build/C/man7/standards.7:27 build/C/man7/suffixes.7:42 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:180
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:167 build/C/man7/feature_test_macros.7:181 build/C/man7/feature_test_macros.7:184 build/C/man7/feature_test_macros.7:187 build/C/man7/feature_test_macros.7:191 build/C/man7/feature_test_macros.7:210 build/C/man7/feature_test_macros.7:213 build/C/man7/feature_test_macros.7:543 build/C/man7/feature_test_macros.7:548 build/C/man7/feature_test_macros.7:554 build/C/man7/feature_test_macros.7:559 build/C/man7/feature_test_macros.7:565 build/C/man7/feature_test_macros.7:570 build/C/man5/proc.5:3345 build/C/man5/proc.5:3347 build/C/man5/proc.5:3349 build/C/man5/proc.5:3352
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:167
284 "(Since glibc 2.3.3) The value 200112L or greater additionally exposes "
285 "definitions corresponding to the POSIX.1-2001 base specification (excluding "
286 "the XSI extension) and also causes C95 (since glibc 2.12) and C99 (since "
287 "glibc 2.10) features to be exposed."
291 #: build/C/man7/feature_test_macros.7:171
293 "(Since glibc 2.10) The value 200809L or greater additionally exposes "
294 "definitions corresponding to the POSIX.1-2008 base specification (excluding "
295 "the XSI extension)."
299 #: build/C/man7/feature_test_macros.7:172
301 msgid "B<_POSIX_SOURCE>"
305 #: build/C/man7/feature_test_macros.7:177
307 "Defining this obsolete macro with any value is equivalent to defining "
308 "B<_POSIX_C_SOURCE> with the value 1."
312 #: build/C/man7/feature_test_macros.7:177
314 msgid "B<_XOPEN_SOURCE>"
318 #: build/C/man7/feature_test_macros.7:184
320 "Defining with any value exposes definitions conforming to POSIX.1, POSIX.2, "
325 #: build/C/man7/feature_test_macros.7:187
327 "The value 500 or greater additionally exposes definitions for SUSv2 (UNIX "
332 #: build/C/man7/feature_test_macros.7:191
334 "(Since glibc 2.2) The value 600 or greater additionally exposes definitions "
335 "for SUSv3 (UNIX 03; i.e., the POSIX.1-2001 base specification plus the XSI "
336 "extension) and C99 definitions."
340 #: build/C/man7/feature_test_macros.7:195
342 "(Since glibc 2.10) The value 700 or greater additionally exposes definitions "
343 "for SUSv4 (i.e., the POSIX.1-2008 base specification plus the XSI "
348 #: build/C/man7/feature_test_macros.7:209
350 "If B<__STRICT_ANSI__> is not defined, or B<_XOPEN_SOURCE> is defined with a "
351 "value greater than or equal to 500 I<and> neither B<_POSIX_SOURCE> not "
352 "B<_POSIX_C_SOURCE> is explicitly defined, then the following macros are "
353 "implicitly defined:"
357 #: build/C/man7/feature_test_macros.7:213
358 msgid "B<_POSIX_SOURCE> is defined with the value 1."
362 #: build/C/man7/feature_test_macros.7:217
363 msgid "B<_POSIX_C_SOURCE> is defined, according to the value of B<_XOPEN_SOURCE>:"
367 #: build/C/man7/feature_test_macros.7:218
369 msgid "B<_XOPEN_SOURCE> E<lt> 500"
373 #: build/C/man7/feature_test_macros.7:222
374 msgid "B<_POSIX_C_SOURCE> is defined with the value 2."
378 #: build/C/man7/feature_test_macros.7:222
380 msgid "500 E<lt>= B<_XOPEN_SOURCE> E<lt> 600"
384 #: build/C/man7/feature_test_macros.7:226
385 msgid "B<_POSIX_C_SOURCE> is defined with the value 199506L."
389 #: build/C/man7/feature_test_macros.7:226
391 msgid "600 E<lt>= B<_XOPEN_SOURCE> E<lt> 700"
395 #: build/C/man7/feature_test_macros.7:230
396 msgid "B<_POSIX_C_SOURCE> is defined with the value 200112L."
400 #: build/C/man7/feature_test_macros.7:230
402 msgid "700 E<lt>= B<_XOPEN_SOURCE> (since glibc 2.10)"
406 #: build/C/man7/feature_test_macros.7:234
407 msgid "B<_POSIX_C_SOURCE> is defined with the value 200809L."
411 #: build/C/man7/feature_test_macros.7:236
413 msgid "B<_XOPEN_SOURCE_EXTENDED>"
417 #: build/C/man7/feature_test_macros.7:245
419 "If this macro is defined, and B<_XOPEN_SOURCE> is defined, then expose "
420 "definitions corresponding to the XPG4v2 (SUSv1) UNIX extensions (UNIX 95). "
421 "This macro is also implicitly defined if B<_XOPEN_SOURCE> is defined with a "
422 "value of 500 or more."
426 #: build/C/man7/feature_test_macros.7:245
428 msgid "B<_ISOC99_SOURCE> (since glibc 2.1.3)"
432 #: build/C/man7/feature_test_macros.7:248
433 msgid "Exposes declarations consistent with the ISO C99 standard."
437 #: build/C/man7/feature_test_macros.7:254
439 "Earlier glibc 2.1.x versions recognized an equivalent macro named "
440 "B<_ISOC9X_SOURCE> (because the C99 standard had not then been finalized). "
441 "Although the use of this macro is obsolete, glibc continues to recognize it "
442 "for backward compatibility."
446 #: build/C/man7/feature_test_macros.7:259
448 "Defining B<_ISOC99_SOURCE> also exposes ISO C (1990) Amendment 1 (\"C95\") "
449 "definitions. (The primary change in C95 was support for international "
454 #: build/C/man7/feature_test_macros.7:259
456 msgid "B<_ISOC11_SOURCE> (since glibc 2.16)"
460 #: build/C/man7/feature_test_macros.7:264
462 "Exposes declarations consistent with the ISO C11 standard. Defining this "
463 "macro also enables C99 and C95 features (like B<_ISOC99_SOURCE>)."
467 #: build/C/man7/feature_test_macros.7:264
469 msgid "B<_LARGEFILE64_SOURCE>"
473 #: build/C/man7/feature_test_macros.7:285
475 "Expose definitions for the alternative API specified by the LFS (Large File "
476 "Summit) as a \"transitional extension\" to the Single UNIX Specification. "
477 "(See E<.UR http:\\:/\\:/opengroup.org\\:/platform\\:/lfs.html> E<.UE .)> The "
478 "alternative API consists of a set of new objects (i.e., functions and types) "
479 "whose names are suffixed with \"64\" (e.g., I<off64_t> versus I<off_t>, "
480 "B<lseek64>() versus B<lseek>(), etc.). New programs should not employ this "
481 "macro; instead I<_FILE_OFFSET_BITS=64> should be employed."
485 #: build/C/man7/feature_test_macros.7:285
487 msgid "B<_LARGEFILE_SOURCE>"
491 #: build/C/man7/feature_test_macros.7:307
493 "This macro was historically used to expose certain functions (specifically "
494 "B<fseeko>(3) and B<ftello>(3)) that address limitations of earlier APIs "
495 "(B<feek>(3) and B<ftell>(3)) that use I<long int> for file offsets. This "
496 "macro is implicitly defined if B<_XOPEN_SOURCE> is defined with a value "
497 "greater than or equal to 500. New programs should not employ this macro; "
498 "defining B<_XOPEN_SOURCE> as just described or defining B<_FILE_OFFSET_BITS> "
499 "with the value 64 is the preferred mechanism to achieve the same result."
503 #: build/C/man7/feature_test_macros.7:307
505 msgid "B<_FILE_OFFSET_BITS>"
509 #: build/C/man7/feature_test_macros.7:317
511 "Defining this macro with the value 64 automatically converts references to "
512 "32-bit functions and data types related to file I/O and filesystem "
513 "operations into references to their 64-bit counterparts. This is useful for "
514 "performing I/O on large files (E<gt> 2 Gigabytes) on 32-bit systems. "
515 "(Defining this macro permits correctly written programs to use large files "
516 "with only a recompilation being required.)"
520 #: build/C/man7/feature_test_macros.7:320
522 "64-bit systems naturally permit file sizes greater than 2 Gigabytes, and on "
523 "those systems this macro has no effect."
527 #: build/C/man7/feature_test_macros.7:320
529 msgid "B<_BSD_SOURCE> (deprecated since glibc 2.20)"
533 #: build/C/man7/feature_test_macros.7:324
535 "Defining this macro with any value causes header files to expose BSD-derived "
540 #: build/C/man7/feature_test_macros.7:339
542 "In glibc versions up to and including 2.18, defining this macro also causes "
543 "BSD definitions to be preferred in some situations where standards conflict, "
544 "unless one or more of B<_SVID_SOURCE>, B<_POSIX_SOURCE>, B<_POSIX_C_SOURCE>, "
545 "B<_XOPEN_SOURCE>, B<_XOPEN_SOURCE_EXTENDED>, or B<_GNU_SOURCE> is defined, "
546 "in which case BSD definitions are disfavored. Since glibc 2.19, "
547 "B<_BSD_SOURCE> no longer causes BSD definitions to be preferred in case of "
551 #. commit c941736c92fa3a319221f65f6755659b2a5e0a20
552 #. commit 498afc54dfee41d33ba519f496e96480badace8e
553 #. commit acd7f096d79c181866d56d4aaf3b043e741f1e2c
554 #. commit ade40b10ff5fa59a318cf55b9d8414b758e8df78
556 #: build/C/man7/feature_test_macros.7:362
558 "Since glibc 2.20, this macro is deprecated. It now has the same effect as "
559 "defining B<_DEFAULT_SOURCE>, but generates a compile-time warning (unless "
560 "B<_DEFAULT_SOURCE> is also defined). Use B<_DEFAULT_SOURCE> instead. To "
561 "allow code that requires B<_BSD_SOURCE> in glibc 2.19 and earlier and "
562 "B<_DEFAULT_SOURCE> in glibc 2.20 and later to compile without warnings, "
563 "define I<both> B<_BSD_SOURCE> and B<_DEFAULT_SOURCE>."
567 #: build/C/man7/feature_test_macros.7:362
569 msgid "B<_SVID_SOURCE> (deprecated since glibc 2.20)"
573 #: build/C/man7/feature_test_macros.7:368
575 "Defining this macro with any value causes header files to expose System "
576 "V-derived definitions. (SVID == System V Interface Definition; see "
581 #: build/C/man7/feature_test_macros.7:371
583 "Since glibc 2.20, this macro is deprecated in the same fashion as "
588 #: build/C/man7/feature_test_macros.7:371
590 msgid "B<_DEFAULT_SOURCE> (since glibc 2.19)"
594 #: build/C/man7/feature_test_macros.7:383
596 "This macro can be defined to ensure that the \"default\" definitions are "
597 "provided even when the defaults would otherwise be disabled, as happens when "
598 "individual macros are explicitly defined, or the compiler is invoked in one "
599 "of its \"standard\" modes (e.g., I<cc\\ -std=c99>). Defining "
600 "B<_DEFAULT_SOURCE> without defining other individual macros or invoking the "
601 "compiler in one of its \"standard\" modes has no effect."
605 #: build/C/man7/feature_test_macros.7:388
607 "The \"default\" definitions comprise those required by POSIX.1-2008 as well "
608 "as various definitions derived from BSD and System V. On glibc 2.19 and "
609 "earlier, these defaults were approximately equivalent to explicitly defining "
614 #: build/C/man7/feature_test_macros.7:390
616 msgid " cc -D_BSD_SOURCE -D_SVID_SOURCE -D_POSIX_C_SOURCE=200809\n"
620 #: build/C/man7/feature_test_macros.7:391
622 msgid "B<_ATFILE_SOURCE> (since glibc 2.4)"
626 #: build/C/man7/feature_test_macros.7:400
628 "Defining this macro with any value causes header files to expose "
629 "declarations of a range of functions with the suffix \"at\"; see "
630 "B<openat>(2). Since glibc 2.10, this macro is also implicitly defined if "
631 "B<_POSIX_C_SOURCE> is defined with a value greater than or equal to 200809L."
635 #: build/C/man7/feature_test_macros.7:400
637 msgid "B<_GNU_SOURCE>"
641 #: build/C/man7/feature_test_macros.7:419
643 "Defining this macro (with any value) implicitly defines B<_ATFILE_SOURCE>, "
644 "B<_LARGEFILE64_SOURCE>, B<_ISOC99_SOURCE>, B<_XOPEN_SOURCE_EXTENDED>, "
645 "B<_POSIX_SOURCE>, B<_POSIX_C_SOURCE> with the value 200809L (200112L in "
646 "glibc versions before 2.10; 199506L in glibc versions before 2.5; 199309L in "
647 "glibc versions before 2.1) and B<_XOPEN_SOURCE> with the value 700 (600 in "
648 "glibc versions before 2.10; 500 in glibc versions before 2.2). In addition, "
649 "various GNU-specific extensions are also exposed."
653 #: build/C/man7/feature_test_macros.7:430
655 "Since glibc 2.19, defining B<_GNU_SOURCE> also has the effect of implicitly "
656 "defining B<_DEFAULT_SOURCE>. In glibc versions before 2.20, defining "
657 "B<_GNU_SOURCE> also had the effect of implicitly defining B<_BSD_SOURCE> and "
662 #: build/C/man7/feature_test_macros.7:430
664 msgid "B<_REENTRANT>"
668 #: build/C/man7/feature_test_macros.7:436
670 "Defining this macro exposes definitions of certain reentrant functions. For "
671 "multithreaded programs, use I<cc\\ -pthread> instead."
675 #: build/C/man7/feature_test_macros.7:436
677 msgid "B<_THREAD_SAFE>"
681 #: build/C/man7/feature_test_macros.7:441
683 "Synonym for B<_REENTRANT>, provided for compatibility with some other "
688 #: build/C/man7/feature_test_macros.7:441
690 msgid "B<_FORTIFY_SOURCE> (since glibc 2.3.4)"
693 #. For more detail, see:
694 #. http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html
695 #. [PATCH] Object size checking to prevent (some) buffer overflows
696 #. * From: Jakub Jelinek <jakub at redhat dot com>
697 #. * To: gcc-patches at gcc dot gnu dot org
698 #. * Date: Tue, 21 Sep 2004 04:16:40 -0400
700 #: build/C/man7/feature_test_macros.7:453
702 "Defining this macro causes some lightweight checks to be performed to detect "
703 "some buffer overflow errors when employing various string and memory "
704 "manipulation functions. Not all buffer overflows are detected, just some "
709 #: build/C/man7/feature_test_macros.7:471
711 "In the current implementation, checks are added for calls to B<memcpy>(3), "
712 "B<mempcpy>(3), B<memmove>(3), B<memset>(3), B<stpcpy>(3), B<strcpy>(3), "
713 "B<strncpy>(3), B<strcat>(3), B<strncat>(3), B<sprintf>(3), B<snprintf>(3), "
714 "B<vsprintf>(3), B<vsnprintf>(3), and B<gets>(3)."
718 #: build/C/man7/feature_test_macros.7:486
720 "If B<_FORTIFY_SOURCE> is set to 1, with compiler optimization level 1 "
721 "(I<gcc\\ -O1>) and above, checks that shouldn't change the behavior of "
722 "conforming programs are performed. With B<_FORTIFY_SOURCE> set to 2 some "
723 "more checking is added, but some conforming programs might fail. Some of "
724 "the checks can be performed at compile time, and result in compiler "
725 "warnings; other checks take place at run time, and result in a run-time "
726 "error if the check fails."
730 #: build/C/man7/feature_test_macros.7:490
732 "Use of this macro requires compiler support, available with B<gcc>(1) since "
737 #: build/C/man7/feature_test_macros.7:490
739 msgid "Default definitions, implicit definitions, and combining definitions"
743 #: build/C/man7/feature_test_macros.7:506
745 "If no feature test macros are explicitly defined, then the following feature "
746 "test macros are defined by default: B<_BSD_SOURCE> (in glibc 2.19 and "
747 "earlier), B<_SVID_SOURCE> (in glibc 2.19 and earlier), B<_DEFAULT_SOURCE> "
748 "(since glibc 2.19), B<_POSIX_SOURCE>, and B<_POSIX_C_SOURCE>=200809L "
749 "(200112L in glibc versions before 2.10; 199506L in glibc versions before "
750 "2.4; 199309L in glibc versions before 2.1)."
754 #: build/C/man7/feature_test_macros.7:525
756 "If any of B<__STRICT_ANSI__>, B<_ISOC99_SOURCE>, B<_POSIX_SOURCE>, "
757 "B<_POSIX_C_SOURCE>, B<_XOPEN_SOURCE>, B<_XOPEN_SOURCE_EXTENDED>, "
758 "B<_BSD_SOURCE> (in glibc 2.19 and earlier), or B<_SVID_SOURCE> (in glibc "
759 "2.19 and earlier) is explicitly defined, then B<_BSD_SOURCE>, "
760 "B<_SVID_SOURCE>, and B<_DEFAULT_SOURCE> are not defined by default."
764 #: build/C/man7/feature_test_macros.7:536
766 "If B<_POSIX_SOURCE> and B<_POSIX_C_SOURCE> are not explicitly defined, and "
767 "either B<__STRICT_ANSI__> is not defined or B<_XOPEN_SOURCE> is defined with "
768 "a value of 500 or more, then"
772 #: build/C/man7/feature_test_macros.7:536 build/C/man7/feature_test_macros.7:539 build/C/man2/intro.2:44 build/C/man2/intro.2:47 build/C/man2/intro.2:50 build/C/man7/man-pages.7:371 build/C/man7/man-pages.7:373 build/C/man7/man-pages.7:375 build/C/man7/man-pages.7:599 build/C/man7/man-pages.7:849 build/C/man7/man-pages.7:851 build/C/man7/man-pages.7:857 build/C/man7/man-pages.7:860 build/C/man7/man-pages.7:863 build/C/man7/man-pages.7:866 build/C/man7/man-pages.7:871 build/C/man7/man-pages.7:875 build/C/man7/man-pages.7:886 build/C/man7/man-pages.7:899 build/C/man7/man-pages.7:901 build/C/man7/man-pages.7:903 build/C/man5/proc.5:909 build/C/man5/proc.5:913 build/C/man5/proc.5:916 build/C/man5/proc.5:918 build/C/man5/proc.5:921 build/C/man5/proc.5:1614 build/C/man5/proc.5:1617 build/C/man5/proc.5:1629 build/C/man5/proc.5:1632 build/C/man5/proc.5:1636 build/C/man5/proc.5:1639 build/C/man5/proc.5:1642 build/C/man5/proc.5:1645 build/C/man5/proc.5:1648 build/C/man5/proc.5:1651 build/C/man5/proc.5:1654 build/C/man5/proc.5:1657 build/C/man5/proc.5:1661 build/C/man5/proc.5:1664 build/C/man5/proc.5:1667 build/C/man5/proc.5:1670 build/C/man5/proc.5:1673 build/C/man5/proc.5:1676 build/C/man5/proc.5:1680 build/C/man5/proc.5:1683 build/C/man5/proc.5:1694 build/C/man5/proc.5:1700 build/C/man5/proc.5:1704 build/C/man5/proc.5:1709 build/C/man5/proc.5:1714 build/C/man5/proc.5:1729 build/C/man5/proc.5:1734 build/C/man5/proc.5:1739 build/C/man5/proc.5:1744 build/C/man5/proc.5:1749 build/C/man5/proc.5:1898 build/C/man5/proc.5:1901 build/C/man5/proc.5:1903 build/C/man5/proc.5:1906 build/C/man5/proc.5:1924 build/C/man5/proc.5:1930 build/C/man5/proc.5:1935 build/C/man5/proc.5:3119 build/C/man5/proc.5:3123 build/C/man5/proc.5:3126 build/C/man5/proc.5:3131 build/C/man5/proc.5:3332 build/C/man5/proc.5:3336 build/C/man5/proc.5:3342 build/C/man5/proc.5:3381 build/C/man5/proc.5:3387 build/C/man5/proc.5:3389 build/C/man5/proc.5:4157 build/C/man5/proc.5:4160 build/C/man5/proc.5:4163 build/C/man5/proc.5:4168 build/C/man5/proc.5:4343 build/C/man5/proc.5:4348 build/C/man5/proc.5:4350 build/C/man5/proc.5:4352 build/C/man5/proc.5:4354
778 #: build/C/man7/feature_test_macros.7:539
779 msgid "B<_POSIX_SOURCE> is defined with the value 1; and"
783 #: build/C/man7/feature_test_macros.7:542
784 msgid "B<_POSIX_C_SOURCE> is defined with one of the following values:"
788 #: build/C/man7/feature_test_macros.7:548
789 msgid "2, if B<_XOPEN_SOURCE> is defined with a value less than 500;"
793 #: build/C/man7/feature_test_macros.7:554
795 "199506L, if B<_XOPEN_SOURCE> is defined with a value greater than or equal "
796 "to 500 and less than 600; or"
800 #: build/C/man7/feature_test_macros.7:559
802 "(since glibc 2.4) 200112L, if B<_XOPEN_SOURCE> is defined with a value "
803 "greater than or equal to 600 and less than 700."
807 #: build/C/man7/feature_test_macros.7:565
809 "(Since glibc 2.10) 200809L, if B<_XOPEN_SOURCE> is defined with a value "
810 "greater than or equal to 700."
814 #: build/C/man7/feature_test_macros.7:570
816 "Older versions of glibc do not know about the values 200112L and 200809L for "
817 "B<_POSIX_C_SOURCE>, and the setting of this macro will depend on the glibc "
822 #: build/C/man7/feature_test_macros.7:579
824 "If B<_XOPEN_SOURCE> is undefined, then the setting of B<_POSIX_C_SOURCE> "
825 "depends on the glibc version: 199506L, in glibc versions before 2.4; "
826 "200112L, in glibc 2.4 to 2.9; and 200809L, since glibc 2.10."
830 #: build/C/man7/feature_test_macros.7:582
831 msgid "Multiple macros can be defined; the results are additive."
835 #: build/C/man7/feature_test_macros.7:582 build/C/man2/intro.2:93 build/C/man3/intro.3:87 build/C/man7/suffixes.7:276
837 msgid "CONFORMING TO"
841 #: build/C/man7/feature_test_macros.7:590
843 "POSIX.1 specifies B<_POSIX_C_SOURCE>, B<_POSIX_SOURCE>, and "
844 "B<_XOPEN_SOURCE>. B<_XOPEN_SOURCE_EXTENDED> was specified by XPG4v2 (aka "
849 #: build/C/man7/feature_test_macros.7:594
851 "B<_FILE_OFFSET_BITS> is not specified by any standard, but is employed on "
852 "some other implementations."
856 #: build/C/man7/feature_test_macros.7:605
858 "B<_BSD_SOURCE>, B<_SVID_SOURCE>, B<_DEFAULT_SOURCE>, B<_ATFILE_SOURCE>, "
859 "B<_GNU_SOURCE>, B<_FORTIFY_SOURCE>, B<_REENTRANT>, and B<_THREAD_SAFE> are "
860 "specific to Linux (glibc)."
864 #: build/C/man7/feature_test_macros.7:605 build/C/man1/intro.1:48 build/C/man2/intro.2:98 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:4395 build/C/man2/unimplemented.2:40
870 #: build/C/man7/feature_test_macros.7:612
872 "I<E<lt>features.hE<gt>> is a Linux/glibc-specific header file. Other "
873 "systems have an analogous file, but typically with a different name. This "
874 "header file is automatically included by other header files as required: it "
875 "is not necessary to explicitly include it in order to employ feature test "
880 #: build/C/man7/feature_test_macros.7:624
882 "According to which of the above feature test macros are defined, "
883 "I<E<lt>features.hE<gt>> internally defines various other macros that are "
884 "checked by other glibc header files. These macros have names prefixed by "
885 "two underscores (e.g., B<__USE_MISC>). Programs should I<never> define "
886 "these macros directly: instead, the appropriate feature test macro(s) from "
887 "the list above should be employed."
891 #: build/C/man7/feature_test_macros.7:624 build/C/man7/man-pages.7:911
897 #: build/C/man7/feature_test_macros.7:630
899 "The program below can be used to explore how the various feature test macros "
900 "are set depending on the glibc version and what feature test macros are "
901 "explicitly set. The following shell session, on a system with glibc 2.10, "
902 "shows some examples of what we would see:"
906 #: build/C/man7/feature_test_macros.7:657
911 "_POSIX_SOURCE defined\n"
912 "_POSIX_C_SOURCE defined: 200809L\n"
913 "_BSD_SOURCE defined\n"
914 "_SVID_SOURCE defined\n"
915 "_ATFILE_SOURCE defined\n"
916 "$ B<cc -D_XOPEN_SOURCE=500 ftm.c>\n"
918 "_POSIX_SOURCE defined\n"
919 "_POSIX_C_SOURCE defined: 199506L\n"
920 "_XOPEN_SOURCE defined: 500\n"
921 "$ B<cc -D_GNU_SOURCE ftm.c>\n"
923 "_POSIX_SOURCE defined\n"
924 "_POSIX_C_SOURCE defined: 200809L\n"
925 "_ISOC99_SOURCE defined\n"
926 "_XOPEN_SOURCE defined: 700\n"
927 "_XOPEN_SOURCE_EXTENDED defined\n"
928 "_LARGEFILE64_SOURCE defined\n"
929 "_BSD_SOURCE defined\n"
930 "_SVID_SOURCE defined\n"
931 "_ATFILE_SOURCE defined\n"
932 "_GNU_SOURCE defined\n"
936 #: build/C/man7/feature_test_macros.7:659
938 msgid "Program source"
942 #: build/C/man7/feature_test_macros.7:663
944 msgid "/* ftm.c */\n"
948 #: build/C/man7/feature_test_macros.7:667
951 "#include E<lt>stdio.hE<gt>\n"
952 "#include E<lt>unistd.hE<gt>\n"
953 "#include E<lt>stdlib.hE<gt>\n"
957 #: build/C/man7/feature_test_macros.7:674
961 "main(int argc, char *argv[])\n"
963 "#ifdef _POSIX_SOURCE\n"
964 " printf(\"_POSIX_SOURCE defined\\en\");\n"
969 #: build/C/man7/feature_test_macros.7:678
972 "#ifdef _POSIX_C_SOURCE\n"
973 " printf(\"_POSIX_C_SOURCE defined: %ldL\\en\", (long) _POSIX_C_SOURCE);\n"
978 #: build/C/man7/feature_test_macros.7:682
981 "#ifdef _ISOC99_SOURCE\n"
982 " printf(\"_ISOC99_SOURCE defined\\en\");\n"
987 #: build/C/man7/feature_test_macros.7:686
990 "#ifdef _ISOC11_SOURCE\n"
991 " printf(\"_ISOC11_SOURCE defined\\en\");\n"
996 #: build/C/man7/feature_test_macros.7:690
999 "#ifdef _XOPEN_SOURCE\n"
1000 " printf(\"_XOPEN_SOURCE defined: %d\\en\", _XOPEN_SOURCE);\n"
1005 #: build/C/man7/feature_test_macros.7:694
1008 "#ifdef _XOPEN_SOURCE_EXTENDED\n"
1009 " printf(\"_XOPEN_SOURCE_EXTENDED defined\\en\");\n"
1014 #: build/C/man7/feature_test_macros.7:698
1017 "#ifdef _LARGEFILE64_SOURCE\n"
1018 " printf(\"_LARGEFILE64_SOURCE defined\\en\");\n"
1023 #: build/C/man7/feature_test_macros.7:702
1026 "#ifdef _FILE_OFFSET_BITS\n"
1027 " printf(\"_FILE_OFFSET_BITS defined: %d\\en\", _FILE_OFFSET_BITS);\n"
1032 #: build/C/man7/feature_test_macros.7:706
1035 "#ifdef _BSD_SOURCE\n"
1036 " printf(\"_BSD_SOURCE defined\\en\");\n"
1041 #: build/C/man7/feature_test_macros.7:710
1044 "#ifdef _SVID_SOURCE\n"
1045 " printf(\"_SVID_SOURCE defined\\en\");\n"
1050 #: build/C/man7/feature_test_macros.7:714
1053 "#ifdef _DEFAULT_SOURCE\n"
1054 " printf(\"_DEFAULT_SOURCE defined\\en\");\n"
1059 #: build/C/man7/feature_test_macros.7:718
1062 "#ifdef _ATFILE_SOURCE\n"
1063 " printf(\"_ATFILE_SOURCE defined\\en\");\n"
1068 #: build/C/man7/feature_test_macros.7:722
1071 "#ifdef _GNU_SOURCE\n"
1072 " printf(\"_GNU_SOURCE defined\\en\");\n"
1077 #: build/C/man7/feature_test_macros.7:726
1080 "#ifdef _REENTRANT\n"
1081 " printf(\"_REENTRANT defined\\en\");\n"
1086 #: build/C/man7/feature_test_macros.7:730
1089 "#ifdef _THREAD_SAFE\n"
1090 " printf(\"_THREAD_SAFE defined\\en\");\n"
1095 #: build/C/man7/feature_test_macros.7:734
1098 "#ifdef _FORTIFY_SOURCE\n"
1099 " printf(\"_FORTIFY_SOURCE defined\\en\");\n"
1104 #: build/C/man7/feature_test_macros.7:737
1107 " exit(EXIT_SUCCESS);\n"
1112 #: build/C/man7/feature_test_macros.7:738 build/C/man1/intro.1:302 build/C/man2/intro.2:112 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:106 build/C/man7/mailaddr.7:117 build/C/man7/man-pages.7:918 build/C/man7/man.7:560 build/C/man7/mdoc.7:428 build/C/man7/posixoptions.7:854 build/C/man5/proc.5:4408 build/C/man7/standards.7:277 build/C/man7/suffixes.7:280 build/C/man2/unimplemented.2:64 build/C/man7/mdoc.samples.7:2952
1118 #: build/C/man7/feature_test_macros.7:741
1119 msgid "B<libc>(7), B<standards>(7)"
1122 #. But beware: the info libc document is out of date (Jul 07, mtk)
1124 #: build/C/man7/feature_test_macros.7:745
1125 msgid "The section \"Feature Test Macros\" under I<info libc>."
1129 #: build/C/man7/feature_test_macros.7:747
1130 msgid "I</usr/include/features.h>"
1134 #: build/C/man7/feature_test_macros.7:747 build/C/man1/intro.1:304 build/C/man2/intro.2:135 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:114 build/C/man7/mailaddr.7:127 build/C/man7/man-pages.7:925 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:4443 build/C/man7/standards.7:281 build/C/man7/suffixes.7:283 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
1140 #: build/C/man7/feature_test_macros.7:755 build/C/man1/intro.1:312 build/C/man2/intro.2:143 build/C/man3/intro.3:118 build/C/man4/intro.4:48 build/C/man5/intro.5:48 build/C/man6/intro.6:45 build/C/man7/intro.7:51 build/C/man8/intro.8:57 build/C/man7/libc.7:122 build/C/man7/mailaddr.7:135 build/C/man7/man-pages.7:933 build/C/man7/man.7:580 build/C/man7/operator.7:73 build/C/man7/posixoptions.7:865 build/C/man5/proc.5:4451 build/C/man7/standards.7:289 build/C/man7/suffixes.7:291 build/C/man3/undocumented.3:191 build/C/man2/unimplemented.2:74 build/C/man7/units.7:138
1142 "This page is part of release 3.78 of the Linux I<man-pages> project. A "
1143 "description of the project, information about reporting bugs, and the latest "
1144 "version of this page, can be found at "
1145 "\\%http://www.kernel.org/doc/man-pages/."
1149 #: 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
1155 #: build/C/man1/intro.1:28
1161 #: build/C/man1/intro.1:28 build/C/man7/mailaddr.7:27
1163 msgid "Linux User's Manual"
1167 #: build/C/man1/intro.1:31
1168 msgid "intro - introduction to user commands"
1172 #: build/C/man1/intro.1:35
1174 "Section 1 of the manual describes user commands and tools, for example, file "
1175 "manipulation tools, shells, compilers, web browsers, file and image viewers "
1176 "and editors, and so on."
1180 #: build/C/man1/intro.1:48
1182 "All commands yield a status value on termination. This value can be tested "
1183 "(e.g., in most shells the variable I<$?> contains the status of the last "
1184 "executed command) to see whether the command completed successfully. A "
1185 "zero exit status is conventionally used to indicate success, and a nonzero "
1186 "status means that the command was unsuccessful. (Details of the exit status "
1187 "can be found in B<wait>(2).) A nonzero exit status can be in the range 1 to "
1188 "255, and some commands use different nonzero status values to indicate the "
1189 "reason why the command failed."
1193 #: build/C/man1/intro.1:52
1195 "Linux is a flavor of UNIX, and as a first approximation all user commands "
1196 "under UNIX work precisely the same under Linux (and FreeBSD and lots of "
1197 "other UNIX-like systems)."
1201 #: build/C/man1/intro.1:62
1203 "Under Linux, there are GUIs (graphical user interfaces), where you can point "
1204 "and click and drag, and hopefully get work done without first reading lots "
1205 "of documentation. The traditional UNIX environment is a CLI (command line "
1206 "interface), where you type commands to tell the computer what to do. That "
1207 "is faster and more powerful, but requires finding out what the commands "
1208 "are. Below a bare minimum, to get started."
1212 #: build/C/man1/intro.1:62
1218 #: build/C/man1/intro.1:76
1220 "In order to start working, you probably first have to login, that is, give "
1221 "your username and password. See also B<login>(1). The program I<login> now "
1222 "starts a I<shell> (command interpreter) for you. In case of a graphical "
1223 "login, you get a screen with menus or icons and a mouse click will start a "
1224 "shell in a window. See also B<xterm>(1)."
1228 #: build/C/man1/intro.1:76
1234 #: build/C/man1/intro.1:91
1236 "One types commands to the I<shell>, the command interpreter. It is not "
1237 "built-in, but is just a program and you can change your shell. Everybody "
1238 "has her own favorite one. The standard one is called I<sh>. See also "
1239 "B<ash>(1), B<bash>(1), B<csh>(1), B<zsh>(1), B<chsh>(1)."
1243 #: build/C/man1/intro.1:93
1244 msgid "A session might go like"
1248 #: build/C/man1/intro.1:108
1251 "B<knuth login: >I<aeb>\n"
1252 "B<Password: >I<********>\n"
1254 "Tue Aug 6 23:50:44 CEST 2002\n"
1257 "Su Mo Tu We Th Fr Sa\n"
1260 "11 12 13 14 15 16 17\n"
1261 "18 19 20 21 22 23 24\n"
1262 "25 26 27 28 29 30 31\n"
1266 #: build/C/man1/intro.1:135
1273 "drwxrwxr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1274 "-rw-rw-r-- 1 aeb 37 Aug 6 23:52 tel\n"
1276 "maja 0501-1136285\n"
1277 "peter 0136-7399214\n"
1278 "B<% >I<cp tel tel2>\n"
1281 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1282 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel\n"
1283 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1284 "B<% >I<mv tel tel1>\n"
1287 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1288 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel1\n"
1289 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1290 "B<% >I<diff tel1 tel2>\n"
1292 "B<% >I<grep maja tel2>\n"
1293 "maja 0501-1136285\n"
1298 #: build/C/man1/intro.1:147
1300 "and here typing Control-D ended the session. The B<% > here was the command "
1301 "prompt\\(emit is the shell's way of indicating that it is ready for the next "
1302 "command. The prompt can be customized in lots of ways, and one might "
1303 "include stuff like username, machine name, current directory, time, and so "
1304 "on. An assignment PS1=\"What next, master? \" would change the prompt as "
1309 #: build/C/man1/intro.1:153
1311 "We see that there are commands I<date> (that gives date and time), and "
1312 "I<cal> (that gives a calendar)."
1316 #: build/C/man1/intro.1:169
1318 "The command I<ls> lists the contents of the current directory\\(emit tells "
1319 "you what files you have. With a I<-l> option it gives a long listing, that "
1320 "includes the owner and size and date of the file, and the permissions people "
1321 "have for reading and/or changing the file. For example, the file \"tel\" "
1322 "here is 37 bytes long, owned by aeb and the owner can read and write it, "
1323 "others can only read it. Owner and permissions can be changed by the "
1324 "commands I<chown> and I<chmod>."
1328 #: build/C/man1/intro.1:176
1330 "The command I<cat> will show the contents of a file. (The name is from "
1331 "\"concatenate and print\": all files given as parameters are concatenated "
1332 "and sent to \"standard output\", here the terminal screen.)"
1336 #: build/C/man1/intro.1:183
1338 "The command I<cp> (from \"copy\") will copy a file. On the other hand, the "
1339 "command I<mv> (from \"move\") only renames it."
1343 #: build/C/man1/intro.1:188
1345 "The command I<diff> lists the differences between two files. Here there was "
1346 "no output because there were no differences."
1350 #: build/C/man1/intro.1:194
1352 "The command I<rm> (from \"remove\") deletes the file, and be careful! it is "
1353 "gone. No wastepaper basket or anything. Deleted means lost."
1357 #: build/C/man1/intro.1:199
1359 "The command I<grep> (from \"g/re/p\") finds occurrences of a string in one "
1360 "or more files. Here it finds Maja's telephone number."
1364 #: build/C/man1/intro.1:199
1366 msgid "Pathnames and the current directory"
1370 #: build/C/man1/intro.1:211
1372 "Files live in a large tree, the file hierarchy. Each has a I<pathname> "
1373 "describing the path from the root of the tree (which is called /) to the "
1374 "file. For example, such a full pathname might be /home/aeb/tel. Always "
1375 "using full pathnames would be inconvenient, and the name of a file in the "
1376 "current directory may be abbreviated by giving only the last component. "
1377 "That is why \"/home/aeb/tel\" can be abbreviated to \"tel\" when the current "
1378 "directory is \"/home/aeb\"."
1382 #: build/C/man1/intro.1:215
1383 msgid "The command I<pwd> prints the current directory."
1387 #: build/C/man1/intro.1:220
1389 "The command I<cd> changes the current directory. Try \"cd /\" and \"pwd\" "
1390 "and \"cd\" and \"pwd\"."
1394 #: build/C/man1/intro.1:220
1400 #: build/C/man1/intro.1:224
1401 msgid "The command I<mkdir> makes a new directory."
1405 #: build/C/man1/intro.1:228
1407 "The command I<rmdir> removes a directory if it is empty, and complains "
1412 #: build/C/man1/intro.1:240
1414 "The command I<find> (with a rather baroque syntax) will find files with "
1415 "given name or other properties. For example, \"find . -name tel\" would "
1416 "find the file \"tel\" starting in the present directory (which is called "
1417 "\".\"). And \"find / -name tel\" would do the same, but starting at the "
1418 "root of the tree. Large searches on a multi-GB disk will be time-consuming, "
1419 "and it may be better to use B<locate>(1)."
1423 #: build/C/man1/intro.1:240
1425 msgid "Disks and filesystems"
1429 #: build/C/man1/intro.1:251
1431 "The command I<mount> will attach the filesystem found on some disk (or "
1432 "floppy, or CDROM or so) to the big filesystem hierarchy. And I<umount> "
1433 "detaches it again. The command I<df> will tell you how much of your disk is "
1438 #: build/C/man1/intro.1:251
1444 #: build/C/man1/intro.1:269
1446 "On a UNIX system many user and system processes run simultaneously. The one "
1447 "you are talking to runs in the I<foreground>, the others in the "
1448 "I<background>. The command I<ps> will show you which processes are active "
1449 "and what numbers these processes have. The command I<kill> allows you to "
1450 "get rid of them. Without option this is a friendly request: please go "
1451 "away. And \"kill -9\" followed by the number of the process is an immediate "
1452 "kill. Foreground processes can often be killed by typing Control-C."
1456 #: build/C/man1/intro.1:269
1458 msgid "Getting information"
1462 #: build/C/man1/intro.1:282
1464 "There are thousands of commands, each with many options. Traditionally "
1465 "commands are documented on I<man pages>, (like this one), so that the "
1466 "command \"man kill\" will document the use of the command \"kill\" (and "
1467 "\"man man\" document the command \"man\"). The program I<man> sends the "
1468 "text through some I<pager>, usually I<less>. Hit the space bar to get the "
1469 "next page, hit q to quit."
1473 #: build/C/man1/intro.1:290
1475 "In documentation it is customary to refer to man pages by giving the name "
1476 "and section number, as in B<man>(1). Man pages are terse, and allow you to "
1477 "find quickly some forgotten detail. For newcomers an introductory text with "
1478 "more examples and explanations is useful."
1482 #: build/C/man1/intro.1:294
1484 "A lot of GNU/FSF software is provided with info files. Type \"info info\" "
1485 "for an introduction on the use of the program \"info\"."
1489 #. Actual examples? Separate section for each of cat, cp, ...?
1490 #. gzip, bzip2, tar, rpm
1492 #: build/C/man1/intro.1:302
1494 "Special topics are often treated in HOWTOs. Look in "
1495 "I</usr/share/doc/howto/en> and use a browser if you find HTML files there."
1499 #: build/C/man1/intro.1:304 build/C/man4/intro.4:40 build/C/man5/intro.5:40 build/C/man7/intro.7:43
1500 msgid "B<standards>(7)"
1504 #: build/C/man2/intro.2:29
1510 #: build/C/man2/intro.2:32
1511 msgid "intro - introduction to system calls"
1515 #: build/C/man2/intro.2:42
1517 "Section 2 of the manual describes the Linux system calls. A system call is "
1518 "an entry point into the Linux kernel. Usually, system calls are not invoked "
1519 "directly: instead, most system calls have corresponding C library wrapper "
1520 "functions which perform the steps required (e.g., trapping to kernel mode) "
1521 "in order to invoke the system call. Thus, making a system call looks the "
1522 "same as invoking a normal library function."
1526 #: build/C/man2/intro.2:44
1527 msgid "In many cases, the C library wrapper function does nothing more than:"
1531 #: build/C/man2/intro.2:47
1533 "copying arguments and the unique system call number to the registers where "
1534 "the kernel expects them;"
1538 #: build/C/man2/intro.2:50
1540 "trapping to kernel mode, at which point the kernel does the real work of the "
1545 #: build/C/man2/intro.2:55
1547 "setting I<errno> if the system call returns an error number when the kernel "
1548 "returns the CPU to user mode."
1552 #: build/C/man2/intro.2:65
1554 "However, in a few cases, a wrapper function may do rather more than this, "
1555 "for example, performing some preprocessing of the arguments of arguments "
1556 "before trapping to kernel mode, or postprocessing of values returned by the "
1557 "system call. Where this is the case, the manual pages in Section 2 "
1558 "generally try to note the details of both the (usually GNU) C library API "
1559 "interface and the raw system call. Most commonly, the main DESCRIPTION will "
1560 "focus on the C library interface, and differences for the system call are "
1561 "covered in the NOTES section."
1565 #: build/C/man2/intro.2:68
1566 msgid "For a list of the Linux system calls, see B<syscalls>(2)."
1570 #: build/C/man2/intro.2:68 build/C/man2/unimplemented.2:35
1572 msgid "RETURN VALUE"
1576 #: build/C/man2/intro.2:77
1578 "On error, most system calls return a negative error number (i.e., the "
1579 "negated value of one of the constants described in B<errno>(3)). The C "
1580 "library wrapper hides this detail from the caller: when a system call "
1581 "returns a negative value, the wrapper copies the absolute value into the "
1582 "I<errno> variable, and returns -1 as the return value of the wrapper."
1586 #: build/C/man2/intro.2:82
1588 "The value returned by a successful system call depends on the call. Many "
1589 "system calls return 0 on success, but some can return nonzero values from a "
1590 "successful call. The details are described in the individual manual pages."
1594 #: build/C/man2/intro.2:93
1596 "In some cases, the programmer must define a feature test macro in order to "
1597 "obtain the declaration of a system call from the header file specified in "
1598 "the man page SYNOPSIS section. (Where required, these feature test macros "
1599 "must be defined before including I<any> header files.) In such cases, the "
1600 "required macro is described in the man page. For further information on "
1601 "feature test macros, see B<feature_test_macros>(7)."
1605 #: build/C/man2/intro.2:98 build/C/man3/intro.3:92
1607 "Certain terms and abbreviations are used to indicate UNIX variants and "
1608 "standards to which calls in this section conform. See B<standards>(7)."
1612 #: build/C/man2/intro.2:99
1614 msgid "Calling directly"
1618 #: build/C/man2/intro.2:108
1620 "In most cases, it is unnecessary to invoke a system call directly, but there "
1621 "are times when the Standard C library does not implement a nice wrapper "
1622 "function for you. In this case, the programmer must manually invoke the "
1623 "system call using B<syscall>(2). Historically, this was also possible using "
1624 "one of the _syscall macros described in B<_syscall>(2)."
1628 #: build/C/man2/intro.2:108 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
1630 msgid "Authors and copyright conditions"
1634 #: build/C/man2/intro.2:112 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
1636 "Look at the header of the manual page source for the author(s) and copyright "
1637 "conditions. Note that these can be different from page to page!"
1641 #: build/C/man2/intro.2:135
1643 "B<_syscall>(2), B<syscall>(2), B<syscalls>(2), B<errno>(3), B<intro>(3), "
1644 "B<capabilities>(7), B<credentials>(7), B<feature_test_macros>(7), "
1645 "B<mq_overview>(7), B<path_resolution>(7), B<pipe>(7), B<pty>(7), "
1646 "B<sem_overview>(7), B<shm_overview>(7), B<signal>(7), B<socket>(7), "
1647 "B<standards>(7), B<svipc>(7), B<symlink>(7), B<time>(7)"
1651 #: build/C/man3/intro.3:26
1657 #: build/C/man3/intro.3:29
1658 msgid "intro - introduction to library functions"
1662 #: build/C/man3/intro.3:33
1664 "Section 3 of the manual describes all library functions excluding the "
1665 "library functions (system call wrappers) described in Section 2, which "
1666 "implement system calls."
1670 #: build/C/man3/intro.3:50
1672 "Many of the functions described in the section are part of the Standard C "
1673 "Library (I<libc>). Some functions are part of other libraries (e.g., the "
1674 "math library, I<libm>, or the real-time library, I<librt>) in which case "
1675 "the manual page will indicate the linker option needed to link against the "
1676 "required library (e.g., I<-lm> and I<-lrt>, respectively, for the "
1677 "aforementioned libraries)."
1682 #. are various function groups which can be identified by a letter which
1683 #. is appended to the chapter number:
1685 #. These functions, the functions from chapter 2 and from chapter 3S are
1686 #. contained in the C standard library libc, which will be used by
1690 #. These functions are parts of the
1692 #. library. They are contained in the standard C library libc.
1694 #. These functions are contained in the arithmetic library libm. They are
1697 #. FORTRAN compiler by default, but not by the
1699 #. C compiler, which needs the option \fI\-lm\fP.
1701 #. These functions are part of the FORTRAN library libF77. There are no
1702 #. special compiler flags needed to use these functions.
1704 #. Various special libraries. The manual pages documenting their functions
1705 #. specify the library names.
1707 #: build/C/man3/intro.3:87
1709 "In some cases, the programmer must define a feature test macro in order to "
1710 "obtain the declaration of a function from the header file specified in the "
1711 "man page SYNOPSIS section. (Where required, these feature test macros must "
1712 "be defined before including I<any> header files.) In such cases, the "
1713 "required macro is described in the man page. For further information on "
1714 "feature test macros, see B<feature_test_macros>(7)."
1718 #: build/C/man3/intro.3:110
1720 "B<intro>(2), B<errno>(3), B<capabilities>(7), B<credentials>(7), "
1721 "B<environ>(7), B<feature_test_macros>(7), B<libc>(7), B<math_error>(7), "
1722 "B<path_resolution>(7), B<pthreads>(7), B<signal>(7), B<standards>(7)"
1726 #: 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
1732 #: build/C/man4/intro.4:29
1733 msgid "intro - introduction to special files"
1737 #: build/C/man4/intro.4:31
1738 msgid "Section 4 of the manual describes special files (devices)."
1742 #: 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
1748 #: build/C/man4/intro.4:33
1749 msgid "/dev/* \\(em device files"
1753 #: build/C/man5/intro.5:30
1754 msgid "intro - introduction to file formats"
1758 #: build/C/man5/intro.5:33
1760 "Section 5 of the manual describes various file formats and protocols, and "
1761 "the corresponding C structures, if any."
1765 #: build/C/man6/intro.6:29
1766 msgid "intro - introduction to games"
1770 #: build/C/man6/intro.6:32
1772 "Section 6 of the manual describes all the games and funny little programs "
1773 "available on the system."
1777 #: build/C/man7/intro.7:31
1778 msgid "intro - introduction to overview, conventions, and miscellany section"
1782 #: build/C/man7/intro.7:36
1784 "Section 7 of the manual provides overviews on various topics, and describes "
1785 "conventions and protocols, character set standards, the standard filesystem "
1786 "layout, and miscellaneous other things."
1790 #: build/C/man8/intro.8:32
1791 msgid "intro - introduction to administration and privileged commands"
1795 #: build/C/man8/intro.8:37
1797 "Section 8 of the manual describes commands which either can be or are used "
1798 "only by the superuser, like system-administration commands, daemons, and "
1799 "hardware-related commands."
1803 #: build/C/man8/intro.8:44
1805 "As with the commands in described Section 1, the commands described in this "
1806 "section terminate with an exit status that indicates whether the command "
1807 "succeeded or failed. See B<intro>(1) for more information."
1811 #: build/C/man7/libc.7:26
1817 #: build/C/man7/libc.7:26
1823 #: build/C/man7/libc.7:29
1824 msgid "libc - overview of standard C libraries on Linux"
1828 #: build/C/man7/libc.7:36
1830 "The term \"libc\" is commonly used as a shorthand for the \"standard C "
1831 "library\", a library of standard functions that can be used by all C "
1832 "programs (and sometimes by programs in other languages). Because of some "
1833 "history (see below), use of the term \"libc\" to refer to the standard C "
1834 "library is somewhat ambiguous on Linux."
1838 #: build/C/man7/libc.7:36
1844 #: build/C/man7/libc.7:54
1846 "By far the most widely used C library on Linux is the GNU C Library E<.UR "
1847 "http://www.gnu.org\\:/software\\:/libc/> E<.UE ,> often referred to as "
1848 "I<glibc>. This is the C library that is nowadays used in all major Linux "
1849 "distributions. It is also the C library whose details are documented in the "
1850 "relevant pages of the I<man-pages> project (primarily in Section 3 of the "
1851 "manual). Documentation of glibc is also available in the glibc manual, "
1852 "available via the command I<info libc>. Release 1.0 of glibc was made in "
1853 "September 1992. (There were earlier 0.x releases.) The next major release "
1854 "of glibc was 2.0, at the beginning of 1997."
1858 #: build/C/man7/libc.7:61
1860 "The pathname I</lib/libc.so.6> (or something similar) is normally a symbolic "
1861 "link that points to the location of the glibc library, and executing this "
1862 "pathname will cause glibc to display various information about the version "
1863 "installed on your system."
1867 #: build/C/man7/libc.7:61
1873 #: build/C/man7/libc.7:71
1875 "In the early to mid 1990s, there was for a while I<Linux libc>, a fork of "
1876 "glibc 1.x created by Linux developers who felt that glibc development at the "
1877 "time was not sufficing for the needs of Linux. Often, this library was "
1878 "referred to (ambiguously) as just \"libc\". Linux libc released major "
1879 "versions 2, 3, 4, and 5 (as well as many minor versions of those releases). "
1880 "For a while, Linux libc was the standard C library in many Linux "
1885 #: build/C/man7/libc.7:86
1887 "However, notwithstanding the original motivations of the Linux libc effort, "
1888 "by the time glibc 2.0 was released (in 1997), it was clearly superior to "
1889 "Linux libc, and all major Linux distributions that had been using Linux libc "
1890 "soon switched back to glibc. Since this switch occurred long ago, "
1891 "I<man-pages> no longer takes care to document Linux libc details. "
1892 "Nevertheless, the history is visible in vestiges of information about Linux "
1893 "libc that remain in some manual pages, in particular, references to I<libc4> "
1898 #: build/C/man7/libc.7:86
1900 msgid "Other C libraries"
1904 #: build/C/man7/libc.7:106
1906 "There are various other less widely used C libraries for Linux. These "
1907 "libraries are generally smaller than glibc, both in terms of features and "
1908 "memory footprint, and often intended for building small binaries, perhaps "
1909 "targeted at development for embedded Linux systems. Among such libraries "
1910 "are E<.UR http://www.uclibc.org/> I<uClibc> E<.UE ,> E<.UR "
1911 "http://www.fefe.de/dietlibc/> I<dietlibc> E<.UE ,> and E<.UR "
1912 "http://www.musl-libc.org/> I<musl libc> E<.UE .> Details of these libraries "
1913 "are covered by the I<man-pages> project, where they are known."
1917 #: build/C/man7/libc.7:114
1919 "B<syscalls>(2), B<getauxval>(3), B<proc>(5), B<feature_test_macros>(7), "
1920 "B<man-pages>(7), B<standards>(7), B<vdso>(7)"
1924 #: build/C/man7/mailaddr.7:27
1930 #: build/C/man7/mailaddr.7:27
1936 #: build/C/man7/mailaddr.7:31
1937 msgid "mailaddr - mail addressing description"
1941 #: build/C/man7/mailaddr.7:36
1943 "This manual page gives a brief introduction to SMTP mail addresses, as used "
1944 "on the Internet. These addresses are in the general format"
1948 #: build/C/man7/mailaddr.7:38
1949 msgid " user@domain"
1953 #: build/C/man7/mailaddr.7:41
1955 "where a domain is a hierarchical dot-separated list of subdomains. These "
1956 "examples are valid forms of the same address:"
1960 #: build/C/man7/mailaddr.7:43
1961 msgid " eric@monet.berkeley.edu"
1965 #: build/C/man7/mailaddr.7:45
1966 msgid " Eric Allman E<lt>eric@monet.berkeley.eduE<gt>"
1970 #: build/C/man7/mailaddr.7:47
1972 msgid " eric@monet.berkeley.edu (Eric Allman)\n"
1976 #: build/C/man7/mailaddr.7:51
1978 "The domain part (\"monet.berkeley.edu\") is a mail-accepting domain. It can "
1979 "be a host and in the past it usually was, but it doesn't have to be. The "
1980 "domain part is not case sensitive."
1984 #: build/C/man7/mailaddr.7:59
1986 "The local part (\"eric\") is often a username, but its meaning is defined by "
1987 "the local software. Sometimes it is case sensitive, although that is "
1988 "unusual. If you see a local-part that looks like garbage, it is usually "
1989 "because of a gateway between an internal e-mail system and the net, here are "
1994 #: build/C/man7/mailaddr.7:61
1995 msgid " \"surname/admd=telemail/c=us/o=hp/prmd=hp\"@some.where"
1999 #: build/C/man7/mailaddr.7:63
2000 msgid " USER%SOMETHING@some.where"
2004 #: build/C/man7/mailaddr.7:65
2005 msgid " machine!machine!name@some.where"
2009 #: build/C/man7/mailaddr.7:67
2010 msgid " I2461572@some.where"
2014 #: build/C/man7/mailaddr.7:71
2016 "(These are, respectively, an X.400 gateway, a gateway to an arbitrary "
2017 "internal mail system that lacks proper internet support, an UUCP gateway, "
2018 "and the last one is just boring username policy.)"
2022 #: build/C/man7/mailaddr.7:77
2024 "The real-name part (\"Eric Allman\") can either be placed before E<lt>E<gt>, "
2025 "or in () at the end. (Strictly speaking the two aren't the same, but the "
2026 "difference is beyond the scope of this page.) The name may have to be "
2027 "quoted using \"\", for example, if it contains \".\":"
2031 #: build/C/man7/mailaddr.7:79
2032 msgid " \"Eric P. Allman\" E<lt>eric@monet.berkeley.eduE<gt>"
2036 #: build/C/man7/mailaddr.7:79
2038 msgid "Abbreviation."
2042 #: build/C/man7/mailaddr.7:87
2044 "Many mail systems let users abbreviate the domain name. For instance, users "
2045 "at berkeley.edu may get away with \"eric@monet\" to send mail to Eric "
2046 "Allman. I<This behavior is deprecated.> Sometimes it works, but you should "
2051 #: build/C/man7/mailaddr.7:87
2053 msgid "Route-addrs."
2057 #: build/C/man7/mailaddr.7:94
2059 "In the past, sometimes one had to route a message through several hosts to "
2060 "get it to its final destination. Addresses which show these relays are "
2061 "termed \"route-addrs\". These use the syntax:"
2065 #: build/C/man7/mailaddr.7:96
2066 msgid " E<lt>@hosta,@hostb:user@hostcE<gt>"
2070 #: build/C/man7/mailaddr.7:101
2072 "This specifies that the message should be sent to hosta, from there to "
2073 "hostb, and finally to hostc. Many hosts disregard route-addrs and send "
2074 "directly to hostc."
2078 #: build/C/man7/mailaddr.7:107
2080 "Route-addrs are very unusual now. They occur sometimes in old mail "
2081 "archives. It is generally possible to ignore all but the \"user@hostc\" "
2082 "part of the address to determine the actual address."
2086 #: build/C/man7/mailaddr.7:107
2092 #: build/C/man7/mailaddr.7:113
2094 "Every site is required to have a user or user alias designated "
2095 "\"postmaster\" to which problems with the mail system may be addressed. The "
2096 "\"postmaster\" address is not case sensitive."
2100 #: build/C/man7/mailaddr.7:115
2101 msgid "I</etc/aliases>"
2105 #: build/C/man7/mailaddr.7:117
2106 msgid "I<~/.forward>"
2110 #: build/C/man7/mailaddr.7:125
2112 "B<binmail>(1), B<mail>(1), B<mconnect>(1), B<aliases>(5), B<forward>(5), "
2113 "B<sendmail>(8), B<vrfy>(8)"
2117 #: build/C/man7/mailaddr.7:127
2118 msgid "RFC\\ 2822 (Internet Message Format)"
2122 #: build/C/man7/man-pages.7:30
2128 #: build/C/man7/man-pages.7:30
2134 #: build/C/man7/man-pages.7:33
2135 msgid "man-pages - conventions for writing Linux man pages"
2139 #: build/C/man7/man-pages.7:37 build/C/man7/man.7:49
2140 msgid "B<man> [I<section>] I<title>"
2144 #: build/C/man7/man-pages.7:47
2146 "This page describes the conventions that should be employed when writing man "
2147 "pages for the Linux I<man-pages> project, which documents the user-space API "
2148 "provided by the Linux kernel and the GNU C library. The project thus "
2149 "provides most of the pages in Section 2, as well as many of the pages that "
2150 "appear in Sections 3, 4, 5, and 7 of the man pages on a Linux system. The "
2151 "conventions described on this page may also be useful for authors writing "
2152 "man pages for other projects."
2156 #: build/C/man7/man-pages.7:47
2158 msgid "Sections of the manual pages"
2162 #: build/C/man7/man-pages.7:50
2163 msgid "The manual Sections are traditionally defined as follows:"
2167 #: build/C/man7/man-pages.7:50
2169 msgid "B<1 Commands (Programs)>"
2173 #: build/C/man7/man-pages.7:54
2174 msgid "Those commands that can be executed by the user from within a shell."
2178 #: build/C/man7/man-pages.7:54
2180 msgid "B<2 System calls>"
2184 #: build/C/man7/man-pages.7:57
2185 msgid "Those functions which must be performed by the kernel."
2189 #: build/C/man7/man-pages.7:57
2191 msgid "B<3 Library calls>"
2195 #: build/C/man7/man-pages.7:62
2196 msgid "Most of the I<libc> functions."
2200 #: build/C/man7/man-pages.7:62
2202 msgid "B<4 Special files (devices)>"
2206 #: build/C/man7/man-pages.7:66
2207 msgid "Files found in I</dev>."
2211 #: build/C/man7/man-pages.7:66
2213 msgid "B<5 File formats and conventions>"
2217 #: build/C/man7/man-pages.7:71
2218 msgid "The format for I</etc/passwd> and other human-readable files."
2222 #: build/C/man7/man-pages.7:71
2228 #: build/C/man7/man-pages.7:73
2230 msgid "B<7 Overview, conventions, and miscellaneous>"
2234 #: build/C/man7/man-pages.7:77
2236 "Overviews of various topics, conventions and protocols, character set "
2237 "standards, and miscellaneous other things."
2241 #: build/C/man7/man-pages.7:77
2243 msgid "B<8 System management commands>"
2247 #. .B 9 Kernel routines
2248 #. This is an obsolete manual section.
2249 #. Once it was thought a good idea to document the Linux kernel here,
2250 #. but in fact very little has been documented, and the documentation
2251 #. that exists is outdated already.
2252 #. There are better sources of
2253 #. information for kernel developers.
2255 #: build/C/man7/man-pages.7:90
2256 msgid "Commands like B<mount>(8), many of which only root can execute."
2260 #: build/C/man7/man-pages.7:90
2262 msgid "Macro package"
2266 #: build/C/man7/man-pages.7:97
2268 "New manual pages should be marked up using the B<groff an.tmac> package "
2269 "described in B<man>(7). This choice is mainly for consistency: the vast "
2270 "majority of existing Linux manual pages are marked up using these macros."
2274 #: build/C/man7/man-pages.7:97
2276 msgid "Conventions for source file layout"
2280 #: build/C/man7/man-pages.7:102
2282 "Please limit source code line length to no more than about 75 characters "
2283 "wherever possible. This helps avoid line-wrapping in some mail clients when "
2284 "patches are submitted inline."
2288 #: build/C/man7/man-pages.7:106
2290 "New sentences should be started on new lines. This makes it easier to see "
2291 "the effect of patches, which often operate at the level of individual "
2296 #: build/C/man7/man-pages.7:106 build/C/man7/man.7:78
2302 #: build/C/man7/man-pages.7:110
2303 msgid "The first command in a man page should be a B<TH> command:"
2307 #: build/C/man7/man-pages.7:114 build/C/man7/man.7:85
2308 msgid "B<\\&.TH> I<title section date source manual>"
2312 #: build/C/man7/man-pages.7:117 build/C/man5/proc.5:4156
2317 #: build/C/man7/man-pages.7:118
2323 #: build/C/man7/man-pages.7:122
2324 msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
2328 #: build/C/man7/man-pages.7:122
2334 #: build/C/man7/man-pages.7:126
2335 msgid "The section number in which the man page should be placed (e.g., I<7>)."
2339 #: build/C/man7/man-pages.7:126
2345 #: build/C/man7/man-pages.7:135
2347 "The date of the last nontrivial change that was made to the man page. "
2348 "(Within the I<man-pages> project, the necessary updates to these timetamps "
2349 "are handled automatically by scripts, so there is no need to manually update "
2350 "them as part of a patch.) Dates should be written in the form YYYY-MM-DD."
2354 #: build/C/man7/man-pages.7:135
2360 #: build/C/man7/man-pages.7:138
2361 msgid "The source of the command, function, or system call."
2365 #: build/C/man7/man-pages.7:142
2367 "For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
2372 #: build/C/man7/man-pages.7:150
2374 "For system calls, just write I<Linux>. (An earlier practice was to write "
2375 "the version number of the kernel from which the manual page was being "
2376 "written/checked. However, this was never done consistently, and so was "
2377 "probably worse than including no version number. Henceforth, avoid "
2378 "including a version number.)"
2382 #: build/C/man7/man-pages.7:155
2384 "For library calls that are part of glibc or one of the other common GNU "
2385 "libraries, just use I<GNU C Library>, I<GNU>, or an empty string."
2389 #: build/C/man7/man-pages.7:158
2390 msgid "For Section 4 pages, use I<Linux>."
2394 #: build/C/man7/man-pages.7:161
2395 msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
2399 #: build/C/man7/man-pages.7:161
2405 #: build/C/man7/man-pages.7:166
2407 "The title of the manual (e.g., for Section 2 and 3 pages in the I<man-pages> "
2408 "package, use I<Linux Programmer's Manual>)."
2412 #: build/C/man7/man-pages.7:167
2414 msgid "Sections within a manual page"
2418 #: build/C/man7/man-pages.7:174
2420 "The list below shows conventional or suggested sections. Most manual pages "
2421 "should include at least the B<highlighted> sections. Arrange a new manual "
2422 "page so that sections are placed in the order shown in the list."
2425 #. May 07: Few current man pages have an ERROR HANDLING section,,,
2427 #. May 07: Almost no current man pages have a USAGE section,,,
2430 #. May 07: Almost no current man pages have a SECURITY section,,,
2432 #. AUTHORS sections are discouraged
2433 #. AUTHORS [Discouraged]
2435 #: build/C/man7/man-pages.7:203
2440 "CONFIGURATION [Normally only in Section 4]\n"
2442 "OPTIONS [Normally only in Sections 1, 8]\n"
2443 "EXIT STATUS [Normally only in Sections 1, 8]\n"
2444 "RETURN VALUE [Normally only in Sections 2, 3]\n"
2445 "ERRORS [Typically only in Sections 2, 3]\n"
2448 "VERSIONS [Normally only in Sections 2, 3]\n"
2449 "ATTRIBUTES [Normally only in Sections 2, 3]\n"
2458 #: build/C/man7/man-pages.7:214
2460 "I<Where a traditional heading would apply>, I<please use it>; this kind of "
2461 "consistency can make the information easier to understand. If you must, you "
2462 "can create your own headings if they make things easier to understand (this "
2463 "can be especially useful for pages in Sections 4 and 5). However, before "
2464 "doing this, consider whether you could use the traditional headings, with "
2465 "some subsections (I<.SS>) within those sections."
2469 #: build/C/man7/man-pages.7:217
2470 msgid "The following list elaborates on the contents of each of the above sections."
2474 #: build/C/man7/man-pages.7:217
2480 #: build/C/man7/man-pages.7:220
2481 msgid "The name of this manual page."
2485 #: build/C/man7/man-pages.7:229
2487 "See B<man>(7) for important details of the line(s) that should follow the "
2488 "B<.SH NAME> command. All words in this line (including the word immediately "
2489 "following the \"\\e-\") should be in lowercase, except where English or "
2490 "technical terminological convention dictates otherwise."
2494 #: build/C/man7/man-pages.7:229
2500 #: build/C/man7/man-pages.7:232
2501 msgid "A brief summary of the command or function's interface."
2505 #: build/C/man7/man-pages.7:242
2507 "For commands, this shows the syntax of the command and its arguments "
2508 "(including options); boldface is used for as-is text and italics are used to "
2509 "indicate replaceable arguments. Brackets ([]) surround optional arguments, "
2510 "vertical bars (|) separate choices, and ellipses (\\&...) can be repeated. "
2511 "For functions, it shows any required data declarations or B<#include> "
2512 "directives, followed by the function declaration."
2515 #. FIXME . Say something here about compiler options
2517 #: build/C/man7/man-pages.7:248
2519 "Where a feature test macro must be defined in order to obtain the "
2520 "declaration of a function (or a variable) from a header file, then the "
2521 "SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
2525 #: build/C/man7/man-pages.7:248
2527 msgid "B<CONFIGURATION>"
2531 #: build/C/man7/man-pages.7:251
2532 msgid "Configuration details for a device."
2536 #: build/C/man7/man-pages.7:253
2537 msgid "This section normally appears only in Section 4 pages."
2541 #: build/C/man7/man-pages.7:253
2543 msgid "B<DESCRIPTION>"
2547 #: build/C/man7/man-pages.7:256
2548 msgid "An explanation of what the program, function, or format does."
2551 #. If there is some kind of input grammar or complex set of subcommands,
2552 #. consider describing them in a separate
2554 #. section (and just place an overview in the
2558 #: build/C/man7/man-pages.7:271
2560 "Discuss how it interacts with files and standard input, and what it produces "
2561 "on standard output or standard error. Omit internals and implementation "
2562 "details unless they're critical for understanding the interface. Describe "
2563 "the usual case; for information on command-line options of a program use the "
2564 "B<OPTIONS> section."
2568 #: build/C/man7/man-pages.7:279
2570 "When describing new behavior or new flags for a system call or library "
2571 "function, be careful to note the kernel or C library version that introduced "
2572 "the change. The preferred method of noting this information for flags is as "
2573 "part of a B<.TP> list, in the following form (here, for a new system call "
2578 #: build/C/man7/man-pages.7:280
2580 msgid "B<XYZ_FLAG> (since Linux 3.7)"
2584 #: build/C/man7/man-pages.7:283
2585 msgid "Description of flag..."
2589 #: build/C/man7/man-pages.7:288
2591 "Including version information is especially useful to users who are "
2592 "constrained to using older kernel or C library versions (which is typical in "
2593 "embedded systems, for example)."
2597 #: build/C/man7/man-pages.7:288
2603 #: build/C/man7/man-pages.7:292
2605 "A description of the command-line options accepted by a program and how they "
2606 "change its behavior."
2610 #: build/C/man7/man-pages.7:297 build/C/man7/man-pages.7:303
2611 msgid "This section should appear only for Section 1 and 8 manual pages."
2615 #: build/C/man7/man-pages.7:297
2617 msgid "B<EXIT STATUS>"
2621 #: build/C/man7/man-pages.7:301
2623 "A list of the possible exit status values of a program and the conditions "
2624 "that cause these values to be returned."
2628 #: build/C/man7/man-pages.7:303
2630 msgid "B<RETURN VALUE>"
2634 #: build/C/man7/man-pages.7:308
2636 "For Section 2 and 3 pages, this section gives a list of the values the "
2637 "library routine will return to the caller and the conditions that cause "
2638 "these values to be returned."
2642 #: build/C/man7/man-pages.7:308
2648 #: build/C/man7/man-pages.7:315
2650 "For Section 2 and 3 manual pages, this is a list of the values that may be "
2651 "placed in I<errno> in the event of an error, along with information about "
2652 "the cause of the errors."
2656 #: build/C/man7/man-pages.7:317
2657 msgid "I<The error list should be in alphabetical order>."
2661 #: build/C/man7/man-pages.7:317
2663 msgid "B<ENVIRONMENT>"
2667 #: build/C/man7/man-pages.7:321
2669 "A list of all environment variables that affect the program or function and "
2670 "how they affect it."
2674 #: build/C/man7/man-pages.7:321
2680 #: build/C/man7/man-pages.7:326
2682 "A list of the files the program or function uses, such as configuration "
2683 "files, startup files, and files the program directly operates on."
2686 #. May 07: Almost no current man pages have a DIAGNOSTICS section;
2687 #. "RETURN VALUE" or "EXIT STATUS" is preferred.
2690 #. gives an overview of the most common error messages and how to
2692 #. You don't need to explain system error messages
2693 #. or fatal signals that can appear during execution of any program
2694 #. unless they're special in some way to the program.
2696 #. May 07: Almost no current man pages have a SECURITY section.
2699 #. discusses security issues and implications.
2700 #. Warn about configurations or environments that should be avoided,
2701 #. commands that may have security implications, and so on, especially
2702 #. if they aren't obvious.
2703 #. Discussing security in a separate section isn't necessary;
2704 #. if it's easier to understand, place security information in the
2705 #. other sections (such as the
2710 #. However, please include security information somewhere!
2712 #: build/C/man7/man-pages.7:359
2714 "Give the full pathname of these files, and use the installation process to "
2715 "modify the directory part to match user preferences. For many programs, the "
2716 "default installation location is in I</usr/local>, so your base manual page "
2717 "should use I</usr/local> as the base."
2721 #: build/C/man7/man-pages.7:359
2723 msgid "B<ATTRIBUTES>"
2727 #: build/C/man7/man-pages.7:363
2729 "A summary of various attributes of the function(s) documented on this page, "
2730 "broken into subsections."
2734 #: build/C/man7/man-pages.7:365
2735 msgid "The following subsections are defined:"
2739 #: build/C/man7/man-pages.7:367
2741 msgid "B<Multithreading (see pthreads(7))>"
2745 #: build/C/man7/man-pages.7:370
2746 msgid "This subsection notes attributes relating to multithreaded applications:"
2750 #: build/C/man7/man-pages.7:373
2751 msgid "Whether the function is thread-safe."
2755 #: build/C/man7/man-pages.7:375
2756 msgid "Whether the function is a cancellation point."
2760 #: build/C/man7/man-pages.7:377
2761 msgid "Whether the function is async-cancel-safe."
2765 #: build/C/man7/man-pages.7:381
2766 msgid "Details of these attributes can be found in B<pthreads>(7)."
2770 #: build/C/man7/man-pages.7:382
2776 #: build/C/man7/man-pages.7:387
2778 "A brief summary of the Linux kernel or glibc versions where a system call or "
2779 "library function appeared, or changed significantly in its operation."
2783 #: build/C/man7/man-pages.7:400
2785 "As a general rule, every new interface should include a VERSIONS section in "
2786 "its manual page. Unfortunately, many existing manual pages don't include "
2787 "this information (since there was no policy to do so when they were "
2788 "written). Patches to remedy this are welcome, but, from the perspective of "
2789 "programmers writing new code, this information probably matters only in the "
2790 "case of kernel interfaces that have been added in Linux 2.4 or later (i.e., "
2791 "changes since kernel 2.2), and library functions that have been added to "
2792 "glibc since version 2.1 (i.e., changes since glibc 2.0)."
2796 #: build/C/man7/man-pages.7:405
2798 "The B<syscalls>(2) manual page also provides information about kernel "
2799 "versions in which various system calls first appeared."
2803 #: build/C/man7/man-pages.7:405
2805 msgid "B<CONFORMING TO>"
2809 #: build/C/man7/man-pages.7:409
2811 "A description of any standards or conventions that relate to the function or "
2812 "command described by the manual page."
2816 #: build/C/man7/man-pages.7:413
2818 "The preferred terms to use for the various standards are listed as headings "
2819 "in B<standards>(7)."
2823 #: build/C/man7/man-pages.7:422
2825 "For a page in Section 2 or 3, this section should note the POSIX.1 "
2826 "version(s) that the call conforms to, and also whether the call is specified "
2827 "in C99. (Don't worry too much about other standards like SUS, SUSv2, and "
2828 "XPG, or the SVr4 and 4.xBSD implementation standards, unless the call was "
2829 "specified in those standards, but isn't in the current version of POSIX.1.)"
2833 #: build/C/man7/man-pages.7:426
2835 "If the call is not governed by any standards but commonly exists on other "
2836 "systems, note them. If the call is Linux-specific, note this."
2840 #: build/C/man7/man-pages.7:430
2842 "If this section consists of just a list of standards (which it commonly "
2843 "does), terminate the list with a period (\\(aq.\\(aq)."
2847 #: build/C/man7/man-pages.7:430
2853 #: build/C/man7/man-pages.7:433
2854 msgid "Miscellaneous notes."
2858 #: build/C/man7/man-pages.7:436
2860 "For Section 2 and 3 man pages you may find it useful to include subsections "
2861 "(B<SS>) named I<Linux Notes> and I<Glibc Notes>."
2865 #: build/C/man7/man-pages.7:442
2867 "In Section 2, use the heading I<C library/kernel ABI differences> to mark "
2868 "off notes that describe the differences (if any) between the C library "
2869 "wrapper function for a system call and the raw system call interface "
2870 "provided by the kernel."
2874 #: build/C/man7/man-pages.7:442
2880 #: build/C/man7/man-pages.7:446
2882 "A list of limitations, known defects or inconveniences, and other "
2883 "questionable activities."
2887 #: build/C/man7/man-pages.7:446
2893 #: build/C/man7/man-pages.7:450
2895 "One or more examples demonstrating how this function, file or command is "
2900 #: build/C/man7/man-pages.7:453
2901 msgid "For details on writing example programs, see I<Example Programs> below."
2905 #: build/C/man7/man-pages.7:453
2911 #: build/C/man7/man-pages.7:456
2912 msgid "A list of authors of the documentation or program."
2916 #: build/C/man7/man-pages.7:464
2918 "B<Use of an AUTHORS section is strongly discouraged>. Generally, it is "
2919 "better not to clutter every page with a list of (over time potentially "
2920 "numerous) authors; if you write or significantly amend a page, add a "
2921 "copyright notice as a comment in the source file. If you are the author of "
2922 "a device driver and want to include an address for reporting bugs, place "
2923 "this under the BUGS section."
2927 #: build/C/man7/man-pages.7:464
2933 #: build/C/man7/man-pages.7:468
2935 "A comma-separated list of related man pages, possibly followed by other "
2936 "related pages or documents."
2940 #: build/C/man7/man-pages.7:472
2942 "The list should be ordered by section number and then alphabetically by name "
2943 "Do not terminate this list with a period."
2947 #: build/C/man7/man-pages.7:483
2949 "Where the SEE ALSO list contains many long manual page names, to improve the "
2950 "visual result of the output, it may be useful to employ the I<.ad l> (don't "
2951 "right justify) and I<.nh> (don't hyphenate) directives. Hyphenation of "
2952 "individual page names can be prevented by preceding words with the string "
2957 #: build/C/man7/man-pages.7:488
2959 "Given the distributed, autonomous nature of FOSS projects and their "
2960 "documentation, it is sometimes necessary\\(emand in many cases "
2961 "desirable\\(emthat the SEE ALSO section includes references to manual pages "
2962 "provided by other projects."
2966 #: build/C/man7/man-pages.7:488
2972 #: build/C/man7/man-pages.7:495
2974 "The following subsections describe the preferred style for the I<man-pages> "
2975 "project. For details not covered below, the Chicago Manual of Style is "
2976 "usually a good source; try also grepping for preexisting usage in the "
2977 "project source tree."
2981 #: build/C/man7/man-pages.7:495
2983 msgid "Use of gender-neutral language"
2987 #: build/C/man7/man-pages.7:500
2989 "As far as possible, use gender-neutral language in the text of man pages. "
2990 "Use of \"they\" (\"them\", \"themself\", \"their\") as a gender-neutral "
2991 "singular pronoun is acceptable."
2995 #: build/C/man7/man-pages.7:500
2997 msgid "Font conventions"
3001 #: build/C/man7/man-pages.7:505
3003 "For functions, the arguments are always specified using italics, I<even in "
3004 "the SYNOPSIS section>, where the rest of the function is specified in bold:"
3008 #: build/C/man7/man-pages.7:507
3009 msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
3013 #: build/C/man7/man-pages.7:509
3014 msgid "Variable names should, like argument names, be specified in italics."
3018 #: build/C/man7/man-pages.7:519
3020 "Filenames (whether pathnames, or references to header files) are always in "
3021 "italics (e.g., I<E<lt>stdio.hE<gt>>), except in the SYNOPSIS section, where "
3022 "included files are in bold (e.g., B<#include E<lt>stdio.hE<gt>>). When "
3023 "referring to a standard header file include, specify the header file "
3024 "surrounded by angle brackets, in the usual C way (e.g., "
3025 "I<E<lt>stdio.hE<gt>>)."
3029 #: build/C/man7/man-pages.7:523
3031 "Special macros, which are usually in uppercase, are in bold (e.g., "
3032 "B<MAXINT>). Exception: don't boldface NULL."
3036 #: build/C/man7/man-pages.7:528
3038 "When enumerating a list of error codes, the codes are in bold (this list "
3039 "usually uses the B<\\&.TP> macro)."
3043 #: build/C/man7/man-pages.7:532
3045 "Complete commands should, if long, be written as an indented line on their "
3046 "own, with a blank line before and after the command, for example"
3050 #: build/C/man7/man-pages.7:536
3052 msgid "man 7 man-pages\n"
3056 #: build/C/man7/man-pages.7:546
3058 "If the command is short, then it can be included inline in the text, in "
3059 "italic format, for example, I<man 7 man-pages>. In this case, it may be "
3060 "worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
3061 "command. Command options should be written in italics (e.g., I<-l>)."
3065 #: build/C/man7/man-pages.7:551
3067 "Expressions, if not written on a separate indented line, should be specified "
3068 "in italics. Again, the use of nonbreaking spaces may be appropriate if the "
3069 "expression is inlined with normal text."
3073 #: build/C/man7/man-pages.7:562
3075 "Any reference to the subject of the current manual page should be written "
3076 "with the name in bold. If the subject is a function (i.e., this is a "
3077 "Section 2 or 3 page), then the name should be followed by a pair of "
3078 "parentheses in Roman (normal) font. For example, in the B<fcntl>(2) man "
3079 "page, references to the subject of the page would be written as: "
3080 "B<fcntl>(). The preferred way to write this in the source file is:"
3084 #: build/C/man7/man-pages.7:565
3086 msgid " .BR fcntl ()\n"
3090 #: build/C/man7/man-pages.7:569
3092 "(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
3093 "easier to write tools that parse man page source files.)"
3097 #: build/C/man7/man-pages.7:578
3099 "Any reference to another man page should be written with the name in bold, "
3100 "I<always> followed by the section number, formatted in Roman (normal) font, "
3101 "without any separating spaces (e.g., B<intro>(2)). The preferred way to "
3102 "write this in the source file is:"
3106 #: build/C/man7/man-pages.7:581
3108 msgid " .BR intro (2)\n"
3112 #: build/C/man7/man-pages.7:586
3114 "(Including the section number in cross references lets tools like "
3115 "B<man2html>(1) create properly hyperlinked pages.)"
3119 #: build/C/man7/man-pages.7:590
3121 "Control characters should be written in bold face, with no quotes; for "
3126 #: build/C/man7/man-pages.7:590
3132 #: build/C/man7/man-pages.7:596
3134 "Starting with release 2.59, I<man-pages> follows American spelling "
3135 "conventions (previously, there was a random mix of British and American "
3136 "spellings); please write all new pages and patches according to these "
3141 #: build/C/man7/man-pages.7:599
3143 "Aside from the well-known spelling differences, there are a few other "
3144 "subtleties to watch for:"
3148 #: build/C/man7/man-pages.7:603
3150 "American English tends to use the forms \"backward\", \"upward\", "
3151 "\"toward\", and so on rather than the British forms \"backwards\", "
3152 "\"upwards\", \"towards\", and so on."
3156 #: build/C/man7/man-pages.7:603
3158 msgid "BSD version numbers"
3162 #: build/C/man7/man-pages.7:611
3164 "The classical scheme for writing BSD version numbers is I<x.yBSD>, where "
3165 "I<x.y> is the version number (e.g., 4.2BSD). Avoid forms such as I<BSD "
3170 #: build/C/man7/man-pages.7:611
3172 msgid "Capitalization"
3176 #: build/C/man7/man-pages.7:617
3178 "In subsection (\"SS\") headings, capitalize the first word in the heading, "
3179 "but otherwise use lowercase, except where English usage (e.g., proper nouns) "
3180 "or programming language requirements (e.g., identifier names) dictate "
3181 "otherwise. For example:"
3185 #: build/C/man7/man-pages.7:619
3186 msgid ".SS Unicode under Linux"
3190 #: build/C/man7/man-pages.7:620
3192 msgid "Indentation of structure definitions, shell session logs, and so on"
3196 #: build/C/man7/man-pages.7:626
3198 "When structure definitions, shell session logs, and so on are included in "
3199 "running text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ "
3204 #: build/C/man7/man-pages.7:626
3206 msgid "Preferred terms"
3210 #: build/C/man7/man-pages.7:629
3212 "The following table lists some preferred terms to use in man pages, mainly "
3213 "to ensure consistency across pages."
3217 #: build/C/man7/man-pages.7:633
3219 msgid "Term\tAvoid using\tNotes\n"
3223 #: build/C/man7/man-pages.7:635
3225 msgid "bit mask\tbitmask\n"
3229 #: build/C/man7/man-pages.7:636
3231 msgid "built-in\tbuiltin\n"
3235 #: build/C/man7/man-pages.7:637
3237 msgid "Epoch\tepoch\tT{\n"
3241 #: build/C/man7/man-pages.7:638
3243 msgid "For the UNIX Epoch (00:00:00, 1 Jan 1970 UTC)\n"
3247 #: build/C/man7/man-pages.7:639 build/C/man7/man-pages.7:650 build/C/man7/man-pages.7:654 build/C/man7/man-pages.7:659 build/C/man7/man-pages.7:663 build/C/man7/man-pages.7:669 build/C/man7/man-pages.7:673 build/C/man7/man-pages.7:698 build/C/man7/man-pages.7:701 build/C/man7/man-pages.7:704
3253 #: build/C/man7/man-pages.7:640
3255 msgid "filename\tfile name\n"
3259 #: build/C/man7/man-pages.7:641
3261 msgid "filesystem\tfile system\n"
3265 #: build/C/man7/man-pages.7:642
3267 msgid "hostname\thost name\n"
3271 #: build/C/man7/man-pages.7:643
3273 msgid "inode\ti-node\n"
3277 #: build/C/man7/man-pages.7:644
3279 msgid "lowercase\tlower case, lower-case\n"
3283 #: build/C/man7/man-pages.7:645
3285 msgid "pathname\tpath name\n"
3289 #: build/C/man7/man-pages.7:646
3291 msgid "pseudoterminal\tpseudo-terminal\n"
3295 #: build/C/man7/man-pages.7:647
3297 msgid "privileged port\tT{\n"
3301 #: build/C/man7/man-pages.7:648
3303 msgid "reserved port,\n"
3307 #: build/C/man7/man-pages.7:649
3309 msgid "system port\n"
3313 #: build/C/man7/man-pages.7:651
3315 msgid "real-time\tT{\n"
3319 #: build/C/man7/man-pages.7:652
3325 #: build/C/man7/man-pages.7:653
3331 #: build/C/man7/man-pages.7:655
3333 msgid "run time\truntime\n"
3337 #: build/C/man7/man-pages.7:656
3339 msgid "saved set-group-ID\tT{\n"
3343 #: build/C/man7/man-pages.7:657
3345 msgid "saved group ID,\n"
3349 #: build/C/man7/man-pages.7:658
3351 msgid "saved set-GID\n"
3355 #: build/C/man7/man-pages.7:660
3357 msgid "saved set-user-ID\tT{\n"
3361 #: build/C/man7/man-pages.7:661
3363 msgid "saved user ID,\n"
3367 #: build/C/man7/man-pages.7:662
3369 msgid "saved set-UID\n"
3373 #: build/C/man7/man-pages.7:664
3375 msgid "set-group-ID\tset-GID, setgid\n"
3379 #: build/C/man7/man-pages.7:665
3381 msgid "set-user-ID\tset-UID, setuid\n"
3385 #: build/C/man7/man-pages.7:666
3387 msgid "superuser\tT{\n"
3391 #: build/C/man7/man-pages.7:667
3393 msgid "super user,\n"
3397 #: build/C/man7/man-pages.7:668
3399 msgid "super-user\n"
3403 #: build/C/man7/man-pages.7:670
3405 msgid "superblock\tT{\n"
3409 #: build/C/man7/man-pages.7:671
3411 msgid "super block,\n"
3415 #: build/C/man7/man-pages.7:672
3417 msgid "super-block\n"
3421 #: build/C/man7/man-pages.7:674
3423 msgid "timestamp\ttime stamp\n"
3427 #: build/C/man7/man-pages.7:675
3429 msgid "timezone\ttime zone\n"
3433 #: build/C/man7/man-pages.7:676
3435 msgid "uppercase\tupper case, upper-case\n"
3439 #: build/C/man7/man-pages.7:677
3441 msgid "usable\tuseable\n"
3445 #: build/C/man7/man-pages.7:678
3447 msgid "user space\tuserspace\n"
3451 #: build/C/man7/man-pages.7:679
3453 msgid "username\tuser name\n"
3457 #: build/C/man7/man-pages.7:680
3459 msgid "zeros\tzeroes\n"
3463 #: build/C/man7/man-pages.7:686
3464 msgid "See also the discussion I<Hyphenation of attributive compounds> below."
3468 #: build/C/man7/man-pages.7:686
3470 msgid "Terms to avoid"
3474 #: build/C/man7/man-pages.7:690
3476 "The following table lists some terms to avoid using in man pages, along with "
3477 "some suggested alternatives, mainly to ensure consistency across pages."
3481 #: build/C/man7/man-pages.7:694
3483 msgid "Avoid\tUse instead\tNotes\n"
3487 #: build/C/man7/man-pages.7:696
3489 msgid "32bit\t32-bit\tT{\n"
3493 #: build/C/man7/man-pages.7:697
3495 msgid "same for 8-bit, 16-bit, etc.\n"
3499 #: build/C/man7/man-pages.7:699
3501 msgid "current process\tcalling process\tT{\n"
3505 #: build/C/man7/man-pages.7:700
3507 msgid "A common mistake made by kernel programmers when writing man pages\n"
3511 #: build/C/man7/man-pages.7:702
3513 msgid "manpage\tT{\n"
3517 #: build/C/man7/man-pages.7:703
3519 msgid "man page, manual page\n"
3523 #: build/C/man7/man-pages.7:705
3525 msgid "minus infinity\tnegative infinity\n"
3529 #: build/C/man7/man-pages.7:706
3531 msgid "non-root\tunprivileged user\n"
3535 #: build/C/man7/man-pages.7:707
3537 msgid "non-superuser\tunprivileged user\n"
3541 #: build/C/man7/man-pages.7:708
3543 msgid "nonprivileged\tunprivileged\n"
3547 #: build/C/man7/man-pages.7:709
3549 msgid "OS\toperating system\n"
3553 #: build/C/man7/man-pages.7:710
3555 msgid "plus infinity\tpositive infinity\n"
3559 #: build/C/man7/man-pages.7:711
3561 msgid "pty\tpseudoterminal\n"
3565 #: build/C/man7/man-pages.7:712
3567 msgid "tty\tterminal\n"
3571 #: build/C/man7/man-pages.7:713
3573 msgid "Unices\tUNIX systems\n"
3577 #: build/C/man7/man-pages.7:714
3579 msgid "Unixes\tUNIX systems\n"
3583 #: build/C/man7/man-pages.7:716
3589 #: build/C/man7/man-pages.7:720
3591 "Use the correct spelling and case for trademarks. The following is a list "
3592 "of the correct spellings of various relevant trademarks that are sometimes "
3597 #: build/C/man7/man-pages.7:725
3607 #: build/C/man7/man-pages.7:725
3609 msgid "NULL, NUL, null pointer, and null character"
3613 #: build/C/man7/man-pages.7:737
3615 "A I<null pointer> is a pointer that points to nothing, and is normally "
3616 "indicated by the constant I<NULL>. On the other hand, I<NUL> is the I<null "
3617 "byte>, a byte with the value 0, represented in C via the character constant "
3618 "I<\\(aq\\e0\\(aq>."
3622 #: build/C/man7/man-pages.7:740
3624 "The preferred term for the pointer is \"null pointer\" or simply \"NULL\"; "
3625 "avoid writing \"NULL pointer\"."
3629 #: build/C/man7/man-pages.7:748
3631 "The preferred term for the byte is \"null byte\". Avoid writing \"NUL\", "
3632 "since it is too easily confused with \"NULL\". Avoid also the terms \"zero "
3633 "byte\" and \"null character\". The byte that terminates a C string should "
3634 "be described as \"the terminating null byte\"; strings may be described as "
3635 "\"null-terminated\", but avoid the use of \"NUL-terminated\"."
3639 #: build/C/man7/man-pages.7:748
3645 #: build/C/man7/man-pages.7:756
3647 "For hyperlinks, use the I<.UR>/I<.UE> macro pair (see B<groff_man>(7)). "
3648 "This produces proper hyperlinks that can be used in a web browser, when "
3649 "rendering a page with, say:"
3653 #: build/C/man7/man-pages.7:758
3655 msgid " BROWSER=firefox man -H pagename\n"
3659 #: build/C/man7/man-pages.7:758
3661 msgid "Use of e.g., i.e., etc., a.k.a., and similar"
3665 #: build/C/man7/man-pages.7:762
3667 "In general, the use of abbreviations such as \"e.g.\", \"i.e.\", \"etc.\", "
3668 "\"a.k.a.\" should be avoided, in favor of suitable full wordings (\"for "
3669 "example\", \"that is\", \"and so on\", \"also known as\")."
3673 #: build/C/man7/man-pages.7:766
3675 "The only place where such abbreviations may be acceptable is in I<short> "
3676 "parenthetical asides (e.g., like this one)."
3680 #: build/C/man7/man-pages.7:769
3682 "Always include periods in such abbreviations, as shown here. In addition, "
3683 "\"e.g.\" and \"i.e.\" should always be followed by a comma."
3687 #: build/C/man7/man-pages.7:769
3693 #: build/C/man7/man-pages.7:777
3695 "The way to write an em-dash\\(emthe glyph that appears at either end of this "
3696 "subphrase\\(emin *roff is with the macro \"\\e(em\". (On an ASCII terminal, "
3697 "an em-dash typically renders as two hyphens, but in other typographical "
3698 "contexts it renders as a long dash.) Em-dashes should be written I<without> "
3699 "surrounding spaces."
3703 #: build/C/man7/man-pages.7:777
3705 msgid "Hyphenation of attributive compounds"
3709 #: build/C/man7/man-pages.7:780
3711 "Compound terms should be hyphenated when used attributively (i.e., to "
3712 "qualify a following noun). Some examples:"
3716 #: build/C/man7/man-pages.7:787
3720 " command-line argument\n"
3721 " floating-point number\n"
3723 " user-space function\n"
3724 " wide-character string\n"
3728 #: build/C/man7/man-pages.7:787
3730 msgid "Hyphenation with multi, non, pre, re, sub, and so on"
3734 #: build/C/man7/man-pages.7:793
3736 "The general tendency in modern English is not to hyphenate after prefixes "
3737 "such as \"multi\", \"non\", \"pre\", \"re\", \"sub\", and so on. Manual "
3738 "pages should generally follow this rule when these prefixes are used in "
3739 "natural English constructions with simple suffixes. The following list "
3740 "gives some examples of the preferred forms:"
3744 #: build/C/man7/man-pages.7:814
3770 #: build/C/man7/man-pages.7:818
3772 "Hyphens should be retained when the prefixes are used in nonstandard English "
3773 "words, with trademarks, proper nouns, acronyms, or compound terms. Some "
3778 #: build/C/man7/man-pages.7:823
3788 #: build/C/man7/man-pages.7:826
3790 "Finally, note that \"re-create\" and \"recreate\" are two different verbs, "
3791 "and the former is probably what you want."
3795 #: build/C/man7/man-pages.7:826
3797 msgid "Real minus character"
3801 #: build/C/man7/man-pages.7:831
3803 "Where a real minus character is required (e.g., for numbers such as -1, or "
3804 "when writing options that have a leading dash, such as in I<ls\\ -l>), use "
3805 "the following form in the man page source:"
3809 #: build/C/man7/man-pages.7:833
3815 #: build/C/man7/man-pages.7:835
3816 msgid "This guideline applies also to code examples."
3820 #: build/C/man7/man-pages.7:835
3822 msgid "Character constants"
3826 #: build/C/man7/man-pages.7:838
3828 "To produce single quotes that render well in both ASCII and UTF-8, use the "
3829 "following form for character constants in the man page source:"
3833 #: build/C/man7/man-pages.7:840
3835 msgid " \\e(aqC\\e(aq\n"
3839 #: build/C/man7/man-pages.7:845
3841 "where I<C> is the quoted character. This guideline applies also to "
3842 "character constants used in code examples."
3846 #: build/C/man7/man-pages.7:845
3848 msgid "Example programs and shell sessions"
3852 #: build/C/man7/man-pages.7:849
3854 "Manual pages may include example programs demonstrating how to use a system "
3855 "call or library function. However, note the following:"
3859 #: build/C/man7/man-pages.7:851
3860 msgid "Example programs should be written in C."
3864 #: build/C/man7/man-pages.7:857
3866 "An example program is necessary and useful only if it demonstrates something "
3867 "beyond what can easily be provided in a textual description of the "
3868 "interface. An example program that does nothing other than call an "
3869 "interface usually serves little purpose."
3873 #: build/C/man7/man-pages.7:860
3875 "Example programs should be fairly short (preferably less than 100 lines; "
3876 "ideally less than 50 lines)."
3880 #: build/C/man7/man-pages.7:863
3882 "Example programs should do error checking after system calls and library "
3887 #: build/C/man7/man-pages.7:866
3889 "Example programs should be complete, and compile without warnings when "
3890 "compiled with I<cc\\ -Wall>."
3894 #: build/C/man7/man-pages.7:871
3896 "Where possible and appropriate, example programs should allow "
3897 "experimentation, by varying their behavior based on inputs (ideally from "
3898 "command-line arguments, or alternatively, via input read by the program)."
3902 #: build/C/man7/man-pages.7:875
3904 "Example programs should be laid out according to Kernighan and Ritchie "
3905 "style, with 4-space indents. (Avoid the use of TAB characters in source "
3910 #: build/C/man7/man-pages.7:877
3911 msgid "For consistency, all example programs should terminate using either of:"
3915 #: build/C/man7/man-pages.7:880
3918 " exit(EXIT_SUCCESS);\n"
3919 " exit(EXIT_FAILURE);\n"
3923 #: build/C/man7/man-pages.7:882
3924 msgid "Avoid using the following forms to terminate a program:"
3928 #: build/C/man7/man-pages.7:886
3937 #: build/C/man7/man-pages.7:892
3939 "If there is extensive explanatory text before the program source code, mark "
3940 "off the source code with a subsection heading I<Program source>, as in:"
3944 #: build/C/man7/man-pages.7:894
3945 msgid ".SS Program source"
3949 #: build/C/man7/man-pages.7:896
3950 msgid "Always do this if the explanatory text includes a shell session log."
3954 #: build/C/man7/man-pages.7:899
3956 "If you include a shell session log demonstrating the use of a program or "
3957 "other system feature:"
3961 #: build/C/man7/man-pages.7:901
3962 msgid "Place the session log above the source code listing"
3966 #: build/C/man7/man-pages.7:903
3967 msgid "Indent the session log by four spaces."
3971 #: build/C/man7/man-pages.7:906
3973 "Boldface the user input text, to distinguish it from output produced by the "
3978 #: build/C/man7/man-pages.7:911
3980 "For some examples of what example programs should look like, see B<wait>(2) "
3985 #: build/C/man7/man-pages.7:918
3987 "For canonical examples of how man pages in the I<man-pages> package should "
3988 "look, see B<pipe>(2) and B<fcntl>(2)."
3992 #: build/C/man7/man-pages.7:925
3994 "B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
3999 #: build/C/man7/man.7:34
4005 #: build/C/man7/man.7:34 build/C/man7/units.7:26
4011 #: build/C/man7/man.7:37
4012 msgid "man - macros to format man pages"
4016 #: build/C/man7/man.7:41
4017 msgid "B<groff -Tascii -man> I<file> \\&..."
4021 #: build/C/man7/man.7:45
4022 msgid "B<groff -Tps -man> I<file> \\&..."
4026 #: build/C/man7/man.7:62
4028 "This manual page explains the B<groff an.tmac> macro package (often called "
4029 "the B<man> macro package). This macro package should be used by developers "
4030 "when writing or porting man pages for Linux. It is fairly compatible with "
4031 "other versions of this macro package, so porting man pages should not be a "
4032 "major problem (exceptions include the NET-2 BSD release, which uses a "
4033 "totally different macro package called mdoc; see B<mdoc>(7))."
4037 #: build/C/man7/man.7:74
4039 "Note that NET-2 BSD mdoc man pages can be used with B<groff> simply by "
4040 "specifying the B<-mdoc> option instead of the B<-man> option. Using the "
4041 "B<-mandoc> option is, however, recommended, since this will automatically "
4042 "detect which macro package is in use."
4046 #: build/C/man7/man.7:78
4048 "For conventions that should be employed when writing man pages for the Linux "
4049 "I<man-pages> package, see B<man-pages>(7)."
4053 #: build/C/man7/man.7:81
4055 "The first command in a man page (after comment lines, that is, lines that "
4056 "start with B<.\\e\">) should be"
4060 #: build/C/man7/man.7:91
4062 "For details of the arguments that should be supplied to the B<TH> command, "
4063 "see B<man-pages>(7)."
4067 #: build/C/man7/man.7:97
4069 "Note that BSD mdoc-formatted pages begin with the B<Dd> command, not the "
4074 #: build/C/man7/man.7:97
4079 #. The following doesn't seem to be required (see Debian bug 411303),
4080 #. If the name contains spaces and appears
4081 #. on the same line as
4083 #. then place the heading in double quotes.
4085 #: build/C/man7/man.7:106
4086 msgid "Sections are started with B<\\&.SH> followed by the heading name."
4090 #: build/C/man7/man.7:109
4092 "The only mandatory heading is NAME, which should be the first section and be "
4093 "followed on the next line by a one-line description of the program:"
4097 #: build/C/man7/man.7:112
4102 #: build/C/man7/man.7:114
4103 msgid "item \\e- description"
4107 #: build/C/man7/man.7:128
4109 "It is extremely important that this format is followed, and that there is a "
4110 "backslash before the single dash which follows the item name. This syntax "
4111 "is used by the B<mandb>(8) program to create a database of short "
4112 "descriptions for the B<whatis>(1) and B<apropos>(1) commands. (See "
4113 "B<lexgrog>(1) for further details on the syntax of the NAME section.)"
4117 #: build/C/man7/man.7:131
4119 "For a list of other sections that might appear in a manual page, see "
4124 #: build/C/man7/man.7:131
4130 #: build/C/man7/man.7:133
4131 msgid "The commands to select the type face are:"
4135 #: build/C/man7/man.7:133
4141 #: build/C/man7/man.7:136
4146 #: build/C/man7/man.7:136
4152 #: build/C/man7/man.7:140
4154 "Bold alternating with italics (especially useful for function "
4159 #: build/C/man7/man.7:140
4165 #: build/C/man7/man.7:145
4167 "Bold alternating with Roman (especially useful for referring to other manual "
4172 #: build/C/man7/man.7:145
4178 #: build/C/man7/man.7:148
4183 #: build/C/man7/man.7:148
4189 #: build/C/man7/man.7:151
4190 msgid "Italics alternating with bold"
4194 #: build/C/man7/man.7:151
4200 #: build/C/man7/man.7:154
4201 msgid "Italics alternating with Roman"
4205 #: build/C/man7/man.7:154
4211 #: build/C/man7/man.7:157
4212 msgid "Roman alternating with bold"
4216 #: build/C/man7/man.7:157
4222 #: build/C/man7/man.7:160
4223 msgid "Roman alternating with italics"
4227 #: build/C/man7/man.7:160
4233 #: build/C/man7/man.7:163
4234 msgid "Small alternating with bold"
4238 #: build/C/man7/man.7:163
4244 #: build/C/man7/man.7:166
4245 msgid "Small (useful for acronyms)"
4249 #: build/C/man7/man.7:179
4251 "Traditionally, each command can have up to six arguments, but the GNU "
4252 "implementation removes this limitation (you might still want to limit "
4253 "yourself to 6 arguments for portability's sake). Arguments are delimited by "
4254 "spaces. Double quotes can be used to specify an argument which contains "
4255 "spaces. All of the arguments will be printed next to each other without "
4256 "intervening spaces, so that the B<\\&.BR> command can be used to specify a "
4257 "word in bold followed by a mark of punctuation in Roman. If no arguments "
4258 "are given, the command is applied to the following line of text."
4262 #: build/C/man7/man.7:179
4264 msgid "Other macros and strings"
4268 #: build/C/man7/man.7:199
4270 "Below are other relevant macros and predefined strings. Unless noted "
4271 "otherwise, all macros cause a break (end the current line of text). Many of "
4272 "these macros set or use the \"prevailing indent.\" The \"prevailing indent\" "
4273 "value is set by any macro with the parameter I<i> below; macros may omit "
4274 "I<i> in which case the current prevailing indent will be used. As a result, "
4275 "successive indented paragraphs can use the same indent without respecifying "
4276 "the indent value. A normal (nonindented) paragraph resets the prevailing "
4277 "indent value to its default value (0.5 inches). By default a given indent "
4278 "is measured in ens; try to use ens or ems as units for indents, since these "
4279 "will automatically adjust to font size changes. The other key macro "
4284 #: build/C/man7/man.7:199
4286 msgid "Normal paragraphs"
4290 #: build/C/man7/man.7:200
4296 #: build/C/man7/man.7:205 build/C/man7/man.7:210
4297 msgid "Same as B<\\&.PP> (begin a new paragraph)."
4301 #: build/C/man7/man.7:205
4307 #: build/C/man7/man.7:210
4313 #: build/C/man7/man.7:213
4314 msgid "Begin a new paragraph and reset prevailing indent."
4318 #: build/C/man7/man.7:213
4320 msgid "Relative margin indent"
4324 #: build/C/man7/man.7:214
4326 msgid "B<\\&.RS>I< i>"
4330 #: build/C/man7/man.7:225
4332 "Start relative margin indent: moves the left margin I<i> to the right (if "
4333 "I<i> is omitted, the prevailing indent value is used). A new prevailing "
4334 "indent is set to 0.5 inches. As a result, all following paragraph(s) will "
4335 "be indented until the corresponding B<\\&.RE>."
4339 #: build/C/man7/man.7:225
4345 #: build/C/man7/man.7:229
4347 "End relative margin indent and restores the previous value of the prevailing "
4352 #: build/C/man7/man.7:229
4354 msgid "Indented paragraph macros"
4358 #: build/C/man7/man.7:230
4360 msgid "B<\\&.HP>I< i>"
4364 #: build/C/man7/man.7:235
4366 "Begin paragraph with a hanging indent (the first line of the paragraph is at "
4367 "the left margin of normal paragraphs, and the rest of the paragraph's lines "
4372 #: build/C/man7/man.7:235
4374 msgid "B<\\&.IP>I< x i>"
4378 #: build/C/man7/man.7:256
4380 "Indented paragraph with optional hanging tag. If the tag I<x> is omitted, "
4381 "the entire following paragraph is indented by I<i>. If the tag I<x> is "
4382 "provided, it is hung at the left margin before the following indented "
4383 "paragraph (this is just like B<\\&.TP> except the tag is included with the "
4384 "command instead of being on the following line). If the tag is too long, "
4385 "the text after the tag will be moved down to the next line (text will not be "
4386 "lost or garbled). For bulleted lists, use this macro with \\e(bu (bullet) "
4387 "or \\e(em (em dash) as the tag, and for numbered lists, use the number or "
4388 "letter followed by a period as the tag; this simplifies translation to other "
4393 #: build/C/man7/man.7:256
4395 msgid "B<\\&.TP>I< i>"
4399 #: build/C/man7/man.7:263
4401 "Begin paragraph with hanging tag. The tag is given on the next line, but "
4402 "its results are like those of the B<\\&.IP> command."
4406 #: build/C/man7/man.7:263
4408 msgid "Hypertext link macros"
4412 #: build/C/man7/man.7:273
4414 "(Feature supported with B<groff> only.) In order to use hypertext link "
4415 "macros, it is necessary to load the B<www.tmac> macro package. Use the "
4416 "request B<.mso www.tmac> to do this."
4420 #: build/C/man7/man.7:273
4422 msgid "B<\\&.URL>I< url link trailer>"
4425 #. The following is a kludge to get a paragraph into the listing.
4427 #: build/C/man7/man.7:286
4429 "Inserts a hypertext link to the URI (URL) I<url>, with I<link> as the text "
4430 "of the link. The I<trailer> will be printed immediately afterward. When "
4431 "generating HTML this should translate into the HTML command B<E<lt>A "
4432 "HREF=\">I<url>B<\"E<gt>>I<link>B<E<lt>/AE<gt>>I<trailer>B<.>"
4435 #. The following is a kludge to get a paragraph into the listing.
4437 #: build/C/man7/man.7:293
4439 "This and other related macros are new, and many tools won't do anything with "
4440 "them, but since many tools (including troff) will simply ignore undefined "
4441 "macros (or at worst insert their text) these are safe to insert."
4444 #. The following is a kludge to get a paragraph into the listing.
4446 #: build/C/man7/man.7:302
4448 "It can be useful to define your own B<URL> macro in manual pages for the "
4449 "benefit of those viewing it with a roff viewer other than B<groff>. That "
4450 "way, the URL, link text, and trailer text (if any) are still visible."
4454 #: build/C/man7/man.7:305
4455 msgid "Here's an example:"
4459 #: build/C/man7/man.7:307
4464 #: build/C/man7/man.7:309
4465 msgid "\\e\\e$2 \\e(laURL: \\e\\e$1 \\e(ra\\e\\e$3"
4469 #: build/C/man7/man.7:311
4474 #: build/C/man7/man.7:313
4475 msgid "\\&.if \\en[.g] .mso www.tmac"
4479 #: build/C/man7/man.7:316
4480 msgid "\\&.TH I<...>"
4484 #: build/C/man7/man.7:318
4485 msgid "I<(later in the page)>"
4489 #: build/C/man7/man.7:320
4490 msgid "This software comes from the"
4494 #: build/C/man7/man.7:322
4495 msgid "\\&.URL \"http://www.gnu.org/\" \"GNU Project\" \" of the\""
4499 #: build/C/man7/man.7:324
4500 msgid "\\&.URL \"http://www.fsf.org/\" \"Free Software Foundation\" ."
4504 #: build/C/man7/man.7:334
4506 "In the above, if B<groff> is being used, the B<www.tmac> macro package's "
4507 "definition of the URL macro will supersede the locally defined one."
4511 #: build/C/man7/man.7:339
4513 "A number of other link macros are available. See B<groff_www>(7) for more "
4518 #: build/C/man7/man.7:339
4520 msgid "Miscellaneous macros"
4524 #: build/C/man7/man.7:340
4530 #: build/C/man7/man.7:344
4531 msgid "Reset tabs to default tab values (every 0.5 inches); does not cause a break."
4535 #: build/C/man7/man.7:344
4537 msgid "B<\\&.PD>I< d>"
4541 #: build/C/man7/man.7:349
4543 "Set inter-paragraph vertical distance to d (if omitted, d=0.4v); does not "
4548 #: build/C/man7/man.7:349
4550 msgid "B<\\&.SS>I< t>"
4554 #: build/C/man7/man.7:356
4556 "Subheading I<t> (like B<\\&.SH>, but used for a subsection inside a "
4561 #: build/C/man7/man.7:356
4563 msgid "Predefined strings"
4567 #: build/C/man7/man.7:360
4568 msgid "The B<man> package has the following predefined strings:"
4572 #: build/C/man7/man.7:360
4578 #: build/C/man7/man.7:362
4579 msgid "Registration Symbol: \\*R"
4583 #: build/C/man7/man.7:362
4589 #: build/C/man7/man.7:364
4590 msgid "Change to default font size"
4594 #: build/C/man7/man.7:364
4600 #: build/C/man7/man.7:366
4601 msgid "Trademark Symbol: \\*(Tm"
4605 #: build/C/man7/man.7:366
4611 #: build/C/man7/man.7:368
4612 msgid "Left angled double quote: ``"
4616 #: build/C/man7/man.7:368
4622 #: build/C/man7/man.7:370
4623 msgid "Right angled double quote: ''"
4627 #: build/C/man7/man.7:370
4633 #: build/C/man7/man.7:414
4635 "Although technically B<man> is a troff macro package, in reality a large "
4636 "number of other tools process man page files that don't implement all of "
4637 "troff's abilities. Thus, it's best to avoid some of troff's more exotic "
4638 "abilities where possible to permit these other tools to work correctly. "
4639 "Avoid using the various troff preprocessors (if you must, go ahead and use "
4640 "B<tbl>(1), but try to use the B<IP> and B<TP> commands instead for "
4641 "two-column tables). Avoid using computations; most other tools can't "
4642 "process them. Use simple commands that are easy to translate to other "
4643 "formats. The following troff macros are believed to be safe (though in many "
4644 "cases they will be ignored by translators): B<\\e\">, B<.>, B<ad>, B<bp>, "
4645 "B<br>, B<ce>, B<de>, B<ds>, B<el>, B<ie>, B<if>, B<fi>, B<ft>, B<hy>, B<ig>, "
4646 "B<in>, B<na>, B<ne>, B<nf>, B<nh>, B<ps>, B<so>, B<sp>, B<ti>, B<tr>."
4650 #: build/C/man7/man.7:437
4652 "You may also use many troff escape sequences (those sequences beginning with "
4653 "\\e). When you need to include the backslash character as normal text, use "
4654 "\\ee. Other sequences you may use, where x or xx are any characters and N "
4655 "is any digit, include: B<\\e'>, B<\\e`>, B<\\e->, B<\\e.>, B<\\e\">, "
4656 "B<\\e%>, B<\\e*x>, B<\\e*(xx>, B<\\e(xx>, B<\\e$N>, B<\\enx>, B<\\en(xx>, "
4657 "B<\\efx>, and B<\\ef(xx>. Avoid using the escape sequences for drawing "
4662 #: build/C/man7/man.7:468
4664 "Do not use the optional parameter for B<bp> (break page). Use only positive "
4665 "values for B<sp> (vertical space). Don't define a macro (B<de>) with the "
4666 "same name as a macro in this or the mdoc macro package with a different "
4667 "meaning; it's likely that such redefinitions will be ignored. Every "
4668 "positive indent (B<in>) should be paired with a matching negative indent "
4669 "(although you should be using the B<RS> and B<RE> macros instead). The "
4670 "condition test (B<if,ie>) should only have \\(aqt\\(aq or \\(aqn\\(aq as "
4671 "the condition. Only translations (B<tr>) that can be ignored should be "
4672 "used. Font changes (B<ft> and the B<\\ef> escape sequence) should only "
4673 "have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have "
4678 #: build/C/man7/man.7:475
4680 "If you use capabilities beyond these, check the results carefully on several "
4681 "tools. Once you've confirmed that the additional capability is safe, let "
4682 "the maintainer of this document know about the safe command or sequence that "
4683 "should be added to this list."
4687 #: build/C/man7/man.7:477
4688 msgid "I</usr/share/groff/>[*/]I<tmac/an.tmac>"
4692 #: build/C/man7/man.7:479
4693 msgid "I</usr/man/whatis>"
4697 #: build/C/man7/man.7:493
4699 "By all means include full URLs (or URIs) in the text itself; some tools such "
4700 "as B<man2html>(1) can automatically turn them into hypertext links. You "
4701 "can also use the new B<URL> macro to identify links to related information. "
4702 "If you include URLs, use the full URL (e.g., E<.UR "
4703 "http://www.kernelnotes.org> E<.UE )> to ensure that tools can automatically "
4708 #: build/C/man7/man.7:502
4710 "Tools processing these files should open the file and examine the first "
4711 "nonwhitespace character. A period (.) or single quote (') at the beginning "
4712 "of a line indicates a troff-based file (such as man or mdoc). A left angle "
4713 "bracket (E<lt>) indicates an SGML/XML-based file (such as HTML or Docbook). "
4714 "Anything else suggests simple ASCII text (e.g., a \"catman\" result)."
4718 #: build/C/man7/man.7:513
4720 "Many man pages begin with B<\\'\\e\"> followed by a space and a list of "
4721 "characters, indicating how the page is to be preprocessed. For "
4722 "portability's sake to non-troff translators we recommend that you avoid "
4723 "using anything other than B<tbl>(1), and Linux can detect that "
4724 "automatically. However, you might want to include this information so your "
4725 "man page can be handled by other (less capable) systems. Here are the "
4726 "definitions of the preprocessors invoked by these characters:"
4730 #: build/C/man7/man.7:513
4736 #: build/C/man7/man.7:516
4741 #: build/C/man7/man.7:516
4747 #: build/C/man7/man.7:519
4752 #: build/C/man7/man.7:519
4758 #: build/C/man7/man.7:522
4763 #: build/C/man7/man.7:522
4769 #: build/C/man7/man.7:525
4774 #: build/C/man7/man.7:525
4780 #: build/C/man7/man.7:528
4785 #: build/C/man7/man.7:528
4791 #: build/C/man7/man.7:531
4796 #: build/C/man7/man.7:531 build/C/man7/suffixes.7:278 build/C/man7/mdoc.samples.7:2883
4802 #: build/C/man7/man.7:544
4804 "Most of the macros describe formatting (e.g., font type and spacing) instead "
4805 "of marking semantic content (e.g., this text is a reference to another "
4806 "page), compared to formats like mdoc and DocBook (even HTML has more "
4807 "semantic markings). This situation makes it harder to vary the B<man> "
4808 "format for different media, to make the formatting consistent for a given "
4809 "media, and to automatically insert cross-references. By sticking to the "
4810 "safe subset described above, it should be easier to automate transitioning "
4811 "to a different reference page format in the future."
4816 #. James Clark (jjc@jclark.com) wrote the implementation of the macro package.
4818 #. Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
4819 #. this manual page.
4821 #. Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
4822 #. (which influenced this manual page).
4824 #. David A. Wheeler (dwheeler@ida.org) heavily modified this
4825 #. manual page, such as adding detailed information on sections and macros.
4827 #: build/C/man7/man.7:560
4828 msgid "The Sun macro B<TX> is not implemented."
4832 #: build/C/man7/man.7:572
4834 "B<apropos>(1), B<groff>(1), B<lexgrog>(1), B<man>(1), B<man2html>(1), "
4835 "B<whatis>(1), B<groff_man>(7), B<groff_www>(7), B<man-pages>(7), B<mdoc>(7), "
4836 "B<mdoc.samples>(7)"
4840 #: build/C/man7/mdoc.7:42
4842 msgid "July 11, 1999"
4846 #: build/C/man7/mdoc.7:43
4852 #: build/C/man7/mdoc.7:47
4857 #: build/C/man7/mdoc.7:47
4859 msgid "quick reference guide for the"
4863 #: build/C/man7/mdoc.7:50
4864 msgid "E<.Nm \\-mdoc> macro package"
4868 #: build/C/man7/mdoc.7:54
4869 msgid "E<.Nm groff> E<.Fl m Ns Ar doc> E<.Ar files ...>"
4873 #: build/C/man7/mdoc.7:66
4875 "The E<.Nm \\-mdoc> package is a set of content-based and domain-based macros "
4876 "used to format the E<.Bx> man pages. The macro names and their meanings are "
4877 "listed below for quick reference; for a detailed explanation on using the "
4878 "package, see the tutorial sampler E<.Xr mdoc.samples 7>."
4882 #: build/C/man7/mdoc.7:71
4884 "Note that this is not the usual macro package for Linux documentation, "
4885 "although it is used for documentation of several widely used programs; see "
4890 #: build/C/man7/mdoc.7:80
4892 "The macros are described in two groups, the first includes the structural "
4893 "and physical page layout macros. The second contains the manual and general "
4894 "text domain macros which differentiate the E<.Nm \\-mdoc> package from other "
4895 "E<.Xr troff> formatting packages."
4899 #: build/C/man7/mdoc.7:80 build/C/man7/mdoc.samples.7:1811
4901 msgid "PAGE STRUCTURE DOMAIN"
4905 #: build/C/man7/mdoc.7:81
4907 msgid "Title Macros"
4911 #: build/C/man7/mdoc.7:84
4913 "To create a valid manual page, these three macros, in this order, are "
4918 #: build/C/man7/mdoc.7:85
4920 msgid "Li \"\\&.Dd \" Ar \"Month day, year\""
4924 #: build/C/man7/mdoc.7:87
4925 msgid "Document date."
4929 #: build/C/man7/mdoc.7:87
4931 msgid "Li \"\\&.Dt \" Ar \"DOCUMENT_TITLE [section] [volume]\""
4935 #: build/C/man7/mdoc.7:89
4936 msgid "Title, in uppercase."
4940 #: build/C/man7/mdoc.7:89
4942 msgid "Li \"\\&.Os \" Ar \"OPERATING_SYSTEM [version/release]\""
4946 #: build/C/man7/mdoc.7:92
4947 msgid "Operating system E<.Pq Tn BSD>."
4951 #: build/C/man7/mdoc.7:93
4953 msgid "Page Layout Macros"
4957 #: build/C/man7/mdoc.7:95
4958 msgid "Section headers, paragraph breaks, lists and displays."
4962 #: build/C/man7/mdoc.7:96
4968 #: build/C/man7/mdoc.7:99
4969 msgid "Section Headers. Valid headers, in the order of presentation:"
4973 #: build/C/man7/mdoc.7:100
4979 #: build/C/man7/mdoc.7:108
4981 "Name section, should include the E<.Ql \\&.Nm> or E<.Ql \\&.Fn> and the "
4982 "E<.Ql \\&.Nd> macros."
4986 #: build/C/man7/mdoc.7:108
4992 #: build/C/man7/mdoc.7:110
4997 #: build/C/man7/mdoc.7:110
4999 msgid "Ar DESCRIPTION"
5003 #: build/C/man7/mdoc.7:113
5004 msgid "General description, should include options and parameters."
5008 #: build/C/man7/mdoc.7:113
5010 msgid "Ar RETURN VALUE"
5014 #: build/C/man7/mdoc.7:115
5015 msgid "Sections two and three function calls."
5019 #: build/C/man7/mdoc.7:115
5021 msgid "Ar ENVIRONMENT"
5025 #: build/C/man7/mdoc.7:117
5026 msgid "Describe environment variables."
5030 #: build/C/man7/mdoc.7:117
5036 #: build/C/man7/mdoc.7:119
5037 msgid "Files associated with the subject."
5041 #: build/C/man7/mdoc.7:119
5047 #: build/C/man7/mdoc.7:121
5048 msgid "Examples and suggestions."
5052 #: build/C/man7/mdoc.7:121
5054 msgid "Ar DIAGNOSTICS"
5058 #: build/C/man7/mdoc.7:123
5059 msgid "Normally used for section four device interface diagnostics."
5063 #: build/C/man7/mdoc.7:123
5069 #: build/C/man7/mdoc.7:126
5070 msgid "Sections two and three error and signal handling."
5074 #: build/C/man7/mdoc.7:126
5080 #: build/C/man7/mdoc.7:128
5081 msgid "Cross references and citations."
5085 #: build/C/man7/mdoc.7:128
5087 msgid "Ar CONFORMING TO"
5091 #: build/C/man7/mdoc.7:130
5092 msgid "Conformance to standards if applicable."
5096 #: build/C/man7/mdoc.7:130
5102 #: build/C/man7/mdoc.7:133
5103 msgid "If a standard is not applicable, the history of the subject should be given."
5107 #: build/C/man7/mdoc.7:133
5113 #: build/C/man7/mdoc.7:135
5114 msgid "Gotchas and caveats."
5118 #: build/C/man7/mdoc.7:135
5124 #: build/C/man7/mdoc.7:138
5125 msgid "Customized headers may be added at the authors discretion."
5129 #: build/C/man7/mdoc.7:139
5135 #: build/C/man7/mdoc.7:141
5136 msgid "Subsection Headers."
5140 #: build/C/man7/mdoc.7:141
5146 #: build/C/man7/mdoc.7:144
5147 msgid "Paragraph Break. Vertical space (one line)."
5151 #: build/C/man7/mdoc.7:144 build/C/man7/mdoc.samples.7:2200
5157 #: build/C/man7/mdoc.7:147
5158 msgid "(D-one) Display-one Indent and display one text line."
5162 #: build/C/man7/mdoc.7:147 build/C/man7/mdoc.samples.7:2208
5168 #: build/C/man7/mdoc.7:150
5169 msgid "(D-ell) Display-one literal. Indent and display one line of literal text."
5173 #: build/C/man7/mdoc.7:150 build/C/man7/mdoc.samples.7:2228
5179 #: build/C/man7/mdoc.7:153
5180 msgid "Begin-display block. Display options:"
5184 #: build/C/man7/mdoc.7:154 build/C/man7/mdoc.samples.7:2248
5190 #: build/C/man7/mdoc.7:156
5191 msgid "Unjustified (ragged edges)."
5195 #: build/C/man7/mdoc.7:156 build/C/man7/mdoc.samples.7:2251
5201 #: build/C/man7/mdoc.7:158
5206 #: build/C/man7/mdoc.7:158 build/C/man7/mdoc.samples.7:2255
5212 #: build/C/man7/mdoc.7:160
5213 msgid "Literal text or code."
5217 #: build/C/man7/mdoc.7:160
5219 msgid "Fl file Ar name"
5223 #: build/C/man7/mdoc.7:164
5224 msgid "Read in named E<.Ar file> and display."
5228 #: build/C/man7/mdoc.7:164 build/C/man7/mdoc.samples.7:2267
5230 msgid "Fl offset Ar string"
5234 #: build/C/man7/mdoc.7:169
5235 msgid "Offset display. Acceptable E<.Ar string> values:"
5239 #: build/C/man7/mdoc.7:170 build/C/man7/mdoc.samples.7:2275
5245 #: build/C/man7/mdoc.7:172
5246 msgid "Align block on left (default)."
5250 #: build/C/man7/mdoc.7:172 build/C/man7/mdoc.samples.7:2279
5256 #: build/C/man7/mdoc.7:174
5257 msgid "Approximate center margin."
5261 #: build/C/man7/mdoc.7:174 build/C/man7/mdoc.samples.7:2284
5267 #: build/C/man7/mdoc.7:176
5268 msgid "Six constant width spaces (a tab)."
5272 #: build/C/man7/mdoc.7:176 build/C/man7/mdoc.samples.7:2293
5274 msgid "Ar indent-two"
5278 #: build/C/man7/mdoc.7:178
5283 #: build/C/man7/mdoc.7:178 build/C/man7/mdoc.samples.7:2295
5289 #: build/C/man7/mdoc.7:181
5290 msgid "Left aligns block 2 inches from right."
5294 #: build/C/man7/mdoc.7:181
5296 msgid "Ar xx Ns Cm n"
5300 #: build/C/man7/mdoc.7:188
5302 "Where E<.Ar xx> is a number from E<.No \\&4 Ns Cm n> to E<.No \\&9\\&9 Ns Cm "
5307 #: build/C/man7/mdoc.7:188
5313 #: build/C/man7/mdoc.7:192
5314 msgid "Where E<.Ar Aa> is a callable macro name."
5318 #: build/C/man7/mdoc.7:192
5324 #: build/C/man7/mdoc.7:196
5325 msgid "The width of E<.Ar string> is used."
5329 #: build/C/man7/mdoc.7:198
5335 #: build/C/man7/mdoc.7:200
5336 msgid "End-display (matches \\&.Bd)."
5340 #: build/C/man7/mdoc.7:200
5346 #: build/C/man7/mdoc.7:204
5347 msgid "Begin-list. Create lists or columns. Options:"
5351 #: build/C/man7/mdoc.7:205
5353 msgid "Ar List-types"
5357 #: build/C/man7/mdoc.7:207
5359 msgid "Fl bullet Ta \"Bullet Item List\""
5363 #: build/C/man7/mdoc.7:208
5365 msgid "Fl item Ta \"Unlabeled List\""
5369 #: build/C/man7/mdoc.7:209
5371 msgid "Fl enum Ta \"Enumerated List\""
5375 #: build/C/man7/mdoc.7:210
5377 msgid "Fl tag Ta \"Tag Labeled List\""
5381 #: build/C/man7/mdoc.7:211
5383 msgid "Fl diag Ta \"Diagnostic List\""
5387 #: build/C/man7/mdoc.7:212
5389 msgid "Fl hang Ta \"Hanging Labeled List\""
5393 #: build/C/man7/mdoc.7:213
5395 msgid "Fl ohang Ta \"Overhanging Labeled List\""
5399 #: build/C/man7/mdoc.7:214
5401 msgid "Fl inset Ta \"Inset or Run-on Labeled List\""
5405 #: build/C/man7/mdoc.7:216
5407 msgid "List-parameters"
5411 #: build/C/man7/mdoc.7:218
5417 #: build/C/man7/mdoc.7:222
5418 msgid "(All lists.) See E<.Ql \\&.Bd> begin-display above."
5422 #: build/C/man7/mdoc.7:222
5428 #: build/C/man7/mdoc.7:229
5429 msgid "E<.Pf ( Fl tag> and E<.Fl hang> lists only.) See E<.Ql \\&.Bd>."
5433 #: build/C/man7/mdoc.7:229
5439 #: build/C/man7/mdoc.7:232
5440 msgid "(All lists.) Suppresses blank lines."
5444 #: build/C/man7/mdoc.7:234
5450 #: build/C/man7/mdoc.7:236
5455 #: build/C/man7/mdoc.7:236
5461 #: build/C/man7/mdoc.7:238
5466 #: build/C/man7/mdoc.7:239
5468 msgid "MANUAL AND GENERAL TEXT DOMAIN MACROS"
5472 #: build/C/man7/mdoc.7:243
5474 "The manual and general text domain macros are special in that most of them "
5475 "are parsed for callable macros for example:"
5479 #: build/C/man7/mdoc.7:244
5481 msgid "Li \"\\&.Op Fl s Ar file\""
5485 #: build/C/man7/mdoc.7:247
5486 msgid "Produces E<.Op Fl s Ar file>"
5490 #: build/C/man7/mdoc.7:265
5492 "In this example, the option enclosure macro E<.Ql \\&.Op> is parsed, and "
5493 "calls the callable content macro E<.Ql \\&Fl> which operates on the argument "
5494 "E<.Ql s> and then calls the callable content macro E<.Ql \\&Ar> which "
5495 "operates on the argument E<.Ql file>. Some macros may be callable, but are "
5496 "not parsed and vice versa. These macros are indicated in the E<.Em parsed> "
5497 "and E<.Em callable> columns below."
5501 #: build/C/man7/mdoc.7:267
5502 msgid "Unless stated, manual domain macros share a common syntax:"
5506 #: build/C/man7/mdoc.7:268
5508 msgid "\\&.Va argument [\\ .\\ ,\\ ;\\ :\\ (\\ )\\ [\\ ]\\ argument ...\\ ]"
5512 #: build/C/man7/mdoc.7:288
5514 "E<.Sy Note>: Opening and closing punctuation characters are recognized as "
5515 "such only if they are presented one at a time. The string E<.Ql \"),\"> is "
5516 "not recognized as punctuation and will be output with a leading white space "
5517 "and in what ever font the calling macro uses. The argument list E<.Ql \"] ) "
5518 ",\"> is recognized as three sequential closing punctuation characters and a "
5519 "leading white space is not output between the characters and the previous "
5520 "argument (if any). The special meaning of a punctuation character may be "
5521 "escaped with the string E<.Ql \\e&>. For example the following string,"
5525 #: build/C/man7/mdoc.7:289
5527 msgid "Li \"\\&.Ar file1\\ , file2\\ , file3\\ )\\ .\""
5531 #: build/C/man7/mdoc.7:292
5532 msgid "Produces E<.Ar file1 , file2 , file3>)."
5536 #: build/C/man7/mdoc.7:294
5538 msgid "Manual Domain Macros"
5542 #: build/C/man7/mdoc.7:296 build/C/man7/mdoc.7:321
5544 msgid "Em \"Name\tParsed\tCallable\tDescription\""
5548 #: build/C/man7/mdoc.7:297
5550 msgid "Li \\&Ad Ta Yes Ta Yes Ta \"Address. (This macro may be deprecated.)\""
5554 #: build/C/man7/mdoc.7:298
5556 msgid "Li \\&An Ta Yes Ta Yes Ta \"Author name.\""
5560 #: build/C/man7/mdoc.7:299
5562 msgid "Li \\&Ar Ta Yes Ta Yes Ta \"Command-line argument.\""
5566 #: build/C/man7/mdoc.7:300
5569 "Li \\&Cd Ta \\&No Ta \\&No Ta \"Configuration declaration (section four "
5574 #: build/C/man7/mdoc.7:301
5576 msgid "Li \\&Cm Ta Yes Ta Yes Ta \"Command-line argument modifier.\""
5580 #: build/C/man7/mdoc.7:302
5582 msgid "Li \\&Dv Ta Yes Ta Yes Ta \"Defined variable (source code).\""
5586 #: build/C/man7/mdoc.7:303
5588 msgid "Li \\&Er Ta Yes Ta Yes Ta \"Error number (source code).\""
5592 #: build/C/man7/mdoc.7:304
5594 msgid "Li \\&Ev Ta Yes Ta Yes Ta \"Environment variable.\""
5598 #: build/C/man7/mdoc.7:305
5600 msgid "Li \\&Fa Ta Yes Ta Yes Ta \"Function argument.\""
5604 #: build/C/man7/mdoc.7:306
5606 msgid "Li \\&Fd Ta Yes Ta Yes Ta \"Function declaration.\""
5610 #: build/C/man7/mdoc.7:307
5612 msgid "Li \\&Fn Ta Yes Ta Yes Ta \"Function call (also .Fo and .Fc).\""
5616 #: build/C/man7/mdoc.7:308
5618 msgid "Li \\&Ic Ta Yes Ta Yes Ta \"Interactive command.\""
5622 #: build/C/man7/mdoc.7:309
5624 msgid "Li \\&Li Ta Yes Ta Yes Ta \"Literal text.\""
5628 #: build/C/man7/mdoc.7:310
5630 msgid "Li \\&Nm Ta Yes Ta Yes Ta \"Command name.\""
5634 #: build/C/man7/mdoc.7:311
5636 msgid "Li \\&Op Ta Yes Ta Yes Ta \"Option (also .Oo and .Oc).\""
5640 #: build/C/man7/mdoc.7:312
5642 msgid "Li \\&Ot Ta Yes Ta Yes Ta \"Old style function type (Fortran only).\""
5646 #: build/C/man7/mdoc.7:313
5648 msgid "Li \\&Pa Ta Yes Ta Yes Ta \"Pathname or filename.\""
5652 #: build/C/man7/mdoc.7:314
5654 msgid "Li \\&St Ta Yes Ta Yes Ta \"Standards (\\-p1003.2, \\-p1003.1 or \\-ansiC)\""
5658 #: build/C/man7/mdoc.7:315
5660 msgid "Li \\&Va Ta Yes Ta Yes Ta \"Variable name.\""
5664 #: build/C/man7/mdoc.7:316
5666 msgid "Li \\&Vt Ta Yes Ta Yes Ta \"Variable type (Fortran only).\""
5670 #: build/C/man7/mdoc.7:317
5672 msgid "Li \\&Xr Ta Yes Ta Yes Ta \"Manual Page Cross Reference.\""
5676 #: build/C/man7/mdoc.7:319
5678 msgid "General Text Domain Macros"
5682 #: build/C/man7/mdoc.7:322
5684 msgid "Li \\&%A Ta Yes Ta \\&No Ta \"Reference author.\""
5688 #: build/C/man7/mdoc.7:323
5690 msgid "Li \\&%B Ta Yes Ta Yes Ta \"Reference book title.\""
5694 #: build/C/man7/mdoc.7:324
5696 msgid "Li \\&%\\&C Ta \\&No Ta \\&No Ta \"Reference place of publishing (city).\""
5700 #: build/C/man7/mdoc.7:325
5702 msgid "Li \\&%\\&D Ta \\&No Ta \\&No Ta \"Reference date.\""
5706 #: build/C/man7/mdoc.7:326
5708 msgid "Li \\&%J Ta Yes Ta Yes Ta \"Reference journal title.\""
5712 #: build/C/man7/mdoc.7:327
5714 msgid "Li \\&%N Ta \\&No Ta \\&No Ta \"Reference issue number.\""
5718 #: build/C/man7/mdoc.7:328
5720 msgid "Li \\&%\\&O Ta \\&No Ta \\&No Ta \"Reference optional information.\""
5724 #: build/C/man7/mdoc.7:329
5726 msgid "Li \\&%P Ta \\&No Ta \\&No Ta \"Reference page number(s).\""
5730 #: build/C/man7/mdoc.7:330
5732 msgid "Li \\&%R Ta \\&No Ta \\&No Ta \"Reference report Name.\""
5736 #: build/C/man7/mdoc.7:331
5738 msgid "Li \\&%T Ta Yes Ta Yes Ta \"Reference article title.\""
5742 #: build/C/man7/mdoc.7:332
5744 msgid "Li \\&%V Ta \\&No Ta \\&No Ta \"Reference volume.\""
5748 #: build/C/man7/mdoc.7:333
5750 msgid "Li \\&Ac Ta Yes Ta Yes Ta \"Angle close quote.\""
5754 #: build/C/man7/mdoc.7:334
5756 msgid "Li \\&Ao Ta Yes Ta Yes Ta \"Angle open quote.\""
5760 #: build/C/man7/mdoc.7:335
5762 msgid "Li \\&Ap Ta Yes Ta Yes Ta Apostrophe."
5766 #: build/C/man7/mdoc.7:336
5768 msgid "Li \\&Aq Ta Yes Ta Yes Ta \"Angle quote.\""
5772 #: build/C/man7/mdoc.7:337
5774 msgid "Li \\&At Ta \\&No Ta \\&No Ta Tn \"AT&T UNIX\""
5778 #: build/C/man7/mdoc.7:338
5780 msgid "Li \\&Bc Ta Yes Ta Yes Ta \"Bracket close quote.\""
5784 #: build/C/man7/mdoc.7:339
5786 msgid "Li \\&Bf Ta \\&No Ta \\&No Ta \"Begin font mode.\""
5790 #: build/C/man7/mdoc.7:340
5792 msgid "Li \\&Bo Ta Yes Ta Yes Ta \"Bracket open quote.\""
5796 #: build/C/man7/mdoc.7:341
5798 msgid "Li \\&Bq Ta Yes Ta Yes Ta \"Bracket quote.\""
5802 #: build/C/man7/mdoc.7:342
5804 msgid "Li \\&Bx Ta Yes Ta Yes Ta Bx ."
5808 #: build/C/man7/mdoc.7:343
5810 msgid "Li \\&Db Ta \\&No Ta \\&No Ta \"Debug (default is \\*qoff\\*q)\""
5814 #: build/C/man7/mdoc.7:344
5816 msgid "Li \\&Dc Ta Yes Ta Yes Ta \"Double close quote.\""
5820 #: build/C/man7/mdoc.7:345
5822 msgid "Li \\&Do Ta Yes Ta Yes Ta \"Double open quote.\""
5826 #: build/C/man7/mdoc.7:346
5828 msgid "Li \\&Dq Ta Yes Ta Yes Ta \"Double quote.\""
5832 #: build/C/man7/mdoc.7:347
5834 msgid "Li \\&Ec Ta Yes Ta Yes Ta \"Enclose string close quote.\""
5838 #: build/C/man7/mdoc.7:348
5840 msgid "Li \\&Ef Ta \\&No Ta \\&No Ta \"End font mode.\""
5844 #: build/C/man7/mdoc.7:349
5846 msgid "Li \\&Em Ta Yes Ta Yes Ta \"Emphasis (traditional English).\""
5850 #: build/C/man7/mdoc.7:350
5852 msgid "Li \\&Eo Ta Yes Ta Yes Ta \"Enclose string open quote.\""
5856 #: build/C/man7/mdoc.7:351
5858 msgid "Li \\&Fx Ta \\&No Ta \\&No Ta Tn \"FreeBSD operating system\""
5862 #: build/C/man7/mdoc.7:352
5864 msgid "Li \\&No Ta Yes Ta Yes Ta \"Normal text (no-op).\""
5868 #: build/C/man7/mdoc.7:353
5870 msgid "Li \\&Ns Ta Yes Ta Yes Ta \"No space.\""
5874 #: build/C/man7/mdoc.7:354
5876 msgid "Li \\&Pc Ta Yes Ta Yes Ta \"Parenthesis close quote.\""
5880 #: build/C/man7/mdoc.7:355
5882 msgid "Li \\&Pf Ta Yes Ta \\&No Ta \"Prefix string.\""
5886 #: build/C/man7/mdoc.7:356
5888 msgid "Li \\&Po Ta Yes Ta Yes Ta \"Parenthesis open quote.\""
5892 #: build/C/man7/mdoc.7:357
5894 msgid "Li \\&Pq Ta Yes Ta Yes Ta \"Parentheses quote.\""
5898 #: build/C/man7/mdoc.7:358
5900 msgid "Li \\&Qc Ta Yes Ta Yes Ta \"Straight Double close quote.\""
5904 #: build/C/man7/mdoc.7:359
5906 msgid "Li \\&Ql Ta Yes Ta Yes Ta \"Quoted literal.\""
5910 #: build/C/man7/mdoc.7:360
5912 msgid "Li \\&Qo Ta Yes Ta Yes Ta \"Straight Double open quote.\""
5916 #: build/C/man7/mdoc.7:361
5918 msgid "Li \\&Qq Ta Yes Ta Yes Ta \"Straight Double quote.\""
5922 #: build/C/man7/mdoc.7:362
5924 msgid "Li \\&Re Ta \\&No Ta \\&No Ta \"Reference end.\""
5928 #: build/C/man7/mdoc.7:363
5930 msgid "Li \\&Rs Ta \\&No Ta \\&No Ta \"Reference start.\""
5934 #: build/C/man7/mdoc.7:364
5937 "Li \\&Rv Ta \\&No Ta \\&No Ta \"Return values (sections two and three "
5942 #: build/C/man7/mdoc.7:365
5944 msgid "Li \\&Sc Ta Yes Ta Yes Ta \"Single close quote.\""
5948 #: build/C/man7/mdoc.7:366
5950 msgid "Li \\&So Ta Yes Ta Yes Ta \"Single open quote.\""
5954 #: build/C/man7/mdoc.7:367
5956 msgid "Li \\&Sq Ta Yes Ta Yes Ta \"Single quote.\""
5960 #: build/C/man7/mdoc.7:368
5962 msgid "Li \\&Sm Ta \\&No Ta \\&No Ta \"Space mode (default is \\*qon\\*q)\""
5966 #: build/C/man7/mdoc.7:369
5968 msgid "Li \\&Sx Ta Yes Ta Yes Ta \"Section Cross Reference.\""
5972 #: build/C/man7/mdoc.7:370
5974 msgid "Li \\&Sy Ta Yes Ta Yes Ta \"Symbolic (traditional English).\""
5978 #: build/C/man7/mdoc.7:371
5980 msgid "Li \\&Tn Ta Yes Ta Yes Ta \"Trade or type name (small Caps).\""
5984 #: build/C/man7/mdoc.7:372
5986 msgid "Li \\&Ux Ta Yes Ta Yes Ta Ux"
5990 #: build/C/man7/mdoc.7:373
5992 msgid "Li \\&Xc Ta Yes Ta Yes Ta \"Extend argument list close.\""
5996 #: build/C/man7/mdoc.7:374
5998 msgid "Li \\&Xo Ta Yes Ta Yes Ta \"Extend argument list open.\""
6002 #: build/C/man7/mdoc.7:388
6004 "Macro names ending in E<.Ql q> quote remaining items on the argument list. "
6005 "Macro names ending in E<.Ql o> begin a quote which may span more than one "
6006 "line of input and are close quoted with the matching macro name ending in "
6007 "E<.Ql c>. Enclosure macros may be nested and are limited to eight "
6012 #: build/C/man7/mdoc.7:400
6014 "Note: the extended argument list macros E<.Pf ( Ql \\&.Xo>, E<.Ql \\&.Xc>) "
6015 "and the function enclosure macros E<.Pf ( Ql \\&.Fo>, E<.Ql \\&.Fc>) are "
6016 "irregular. The extended list macros are used when the number of macro "
6017 "arguments would exceed the E<.Xr troff> limitation of nine arguments."
6020 #. The following does not apply on Linux:
6021 #. .Sh CONFIGURATION
6022 #. For site specific configuration of the macro package,
6024 #. .Pa /usr/src/share/tmac/README .
6026 #: build/C/man7/mdoc.7:411
6028 "The macros UR (starting a URI/URL hypertext reference), UE (ending one), and "
6029 "UN (identifying a target for a reference) are also available. See E<.Xr man "
6030 "7> for more information on these macros."
6034 #: build/C/man7/mdoc.7:413
6040 #: build/C/man7/mdoc.7:415
6041 msgid "Manual and general text domain macros."
6045 #: build/C/man7/mdoc.7:415
6047 msgid "Pa tmac/doc-common"
6051 #: build/C/man7/mdoc.7:417
6052 msgid "Common structural macros and definitions."
6056 #: build/C/man7/mdoc.7:417
6058 msgid "Pa tmac/doc-nroff"
6062 #: build/C/man7/mdoc.7:421
6063 msgid "Site dependent E<.Xr nroff> style file."
6067 #: build/C/man7/mdoc.7:421
6069 msgid "Pa tmac/doc-ditroff"
6073 #: build/C/man7/mdoc.7:425
6074 msgid "Site dependent E<.Xr troff> style file."
6078 #: build/C/man7/mdoc.7:425
6080 msgid "Pa tmac/doc-syms"
6084 #: build/C/man7/mdoc.7:427
6085 msgid "Special defines (such as the standards macro)."
6089 #: build/C/man7/mdoc.7:433
6090 msgid "E<.Xr groff_mdoc 7>, E<.Xr mdoc.samples 7>, E<.Xr man 7>, E<.Xr man-pages 7>"
6094 #: build/C/man7/mdoc.7:441 build/C/man7/mdoc.samples.7:2965
6096 "This page is part of release 3.78 of the Linux E<.Em man-pages> project. A "
6097 "description of the project, information about reporting bugs, and the latest "
6098 "version of this page, can be found at "
6099 "\\%http://www.kernel.org/doc/man\\-pages/."
6103 #: build/C/man7/operator.7:40
6109 #: build/C/man7/operator.7:40
6115 #: build/C/man7/operator.7:43
6116 msgid "operator - C operator precedence and order of evaluation"
6120 #: build/C/man7/operator.7:45
6121 msgid "This manual page lists C operators and their precedence in evaluation."
6125 #: build/C/man7/operator.7:63
6128 "B<Operator Associativity>\n"
6129 "() [] -E<gt> . left to right\n"
6130 "! ~ ++ -- + - (type) * & sizeof right to left\n"
6131 "* / % left to right\n"
6132 "+ - left to right\n"
6133 "E<lt>E<lt> E<gt>E<gt> left to right\n"
6134 "E<lt> E<lt>= E<gt> E<gt>= left to right\n"
6135 "== != left to right\n"
6139 "&& left to right\n"
6140 "|| left to right\n"
6141 "?: right to left\n"
6142 "= += -= *= /= %= E<lt>E<lt>= E<gt>E<gt>= &= ^= |= right to left\n"
6147 #: build/C/man7/posixoptions.7:24
6149 msgid "POSIXOPTIONS"
6153 #: build/C/man7/posixoptions.7:24
6159 #: build/C/man7/posixoptions.7:27
6160 msgid "posixoptions - optional parts of the POSIX standard"
6164 #: build/C/man7/posixoptions.7:41
6166 "The POSIX standard (the information below is from POSIX.1-2001) describes a "
6167 "set of behaviors and interfaces for a compliant system. However, many "
6168 "interfaces are optional and there are feature test macros to test the "
6169 "availability of interfaces at compile time, and functions B<sysconf>(3), "
6170 "B<fpathconf>(3), B<pathconf>(3), B<confstr>(3) to do this at run time. "
6171 "From shell scripts one can use B<getconf>(1). For more detail, see "
6176 #: build/C/man7/posixoptions.7:48
6178 "We give the name of the POSIX abbreviation, the option, the name of the "
6179 "B<sysconf>(3) parameter used to inquire about the option, and possibly a "
6180 "very short description. Much more precise detail can be found in the POSIX "
6181 "standard itself, versions of which can nowadays be accessed freely on the "
6186 #: build/C/man7/posixoptions.7:48
6188 msgid "ADV - _POSIX_ADVISORY_INFO - _SC_ADVISORY_INFO"
6192 #: build/C/man7/posixoptions.7:50
6193 msgid "The following advisory functions are present:"
6197 #: build/C/man7/posixoptions.7:58
6200 "I<posix_fadvise>(),\n"
6201 "I<posix_fallocate>(),\n"
6202 "I<posix_memalign>(),\n"
6203 "I<posix_madvise>().\n"
6207 #: build/C/man7/posixoptions.7:61
6209 msgid "AIO - _POSIX_ASYNCHRONOUS_IO - _SC_ASYNCHRONOUS_IO"
6213 #: build/C/man7/posixoptions.7:66
6215 "The header I<E<lt>aio.hE<gt>> is present. The following functions are "
6220 #: build/C/man7/posixoptions.7:78
6223 "I<aio_cancel>(),\n"
6227 "I<aio_return>(),\n"
6228 "I<aio_suspend>(),\n"
6230 "I<lio_listio>().\n"
6234 #: build/C/man7/posixoptions.7:81
6236 msgid "BAR - _POSIX_BARRIERS - _SC_BARRIERS"
6240 #: build/C/man7/posixoptions.7:88 build/C/man7/posixoptions.7:458
6242 "This option implies the B<_POSIX_THREADS> and "
6243 "B<_POSIX_THREAD_SAFE_FUNCTIONS> options. The following functions are "
6248 #: build/C/man7/posixoptions.7:97
6251 "I<pthread_barrier_destroy>(),\n"
6252 "I<pthread_barrier_init>(),\n"
6253 "I<pthread_barrier_wait>(),\n"
6254 "I<pthread_barrierattr_destroy>(),\n"
6255 "I<pthread_barrierattr_init>().\n"
6259 #. Batch environment.
6263 #: build/C/man7/posixoptions.7:104
6265 msgid "--- - POSIX_CHOWN_RESTRICTED"
6268 #. What about lchown() ?
6270 #: build/C/man7/posixoptions.7:112
6272 "If this option is in effect (as it always is under POSIX.1-2001), then only "
6273 "root may change the owner of a file, and nonroot can set the group of a file "
6274 "only to one of the groups it belongs to. This affects the functions "
6275 "I<chown>(), I<fchown>()."
6279 #: build/C/man7/posixoptions.7:112
6281 msgid "CS - _POSIX_CLOCK_SELECTION - _SC_CLOCK_SELECTION"
6285 #: build/C/man7/posixoptions.7:117
6287 "This option implies the B<_POSIX_TIMERS> option. The following functions "
6292 #: build/C/man7/posixoptions.7:124
6295 "I<pthread_condattr_getclock>(),\n"
6296 "I<pthread_condattr_setclock>(),\n"
6297 "I<clock_nanosleep>().\n"
6301 #: build/C/man7/posixoptions.7:132
6303 "If B<CLOCK_REALTIME> is changed by the function I<clock_settime>(), then "
6304 "this affects all timers set for an absolute time."
6308 #: build/C/man7/posixoptions.7:132
6310 msgid "CPT - _POSIX_CPUTIME - _SC_CPUTIME"
6314 #. Fortran development
6318 #: build/C/man7/posixoptions.7:145
6320 "The clockID CLOCK_PROCESS_CPUTIME_ID is supported. The initial value of "
6321 "this clock is 0 for each process. This option implies the B<_POSIX_TIMERS> "
6322 "option. The function I<clock_getcpuclockid>() is present."
6326 #: build/C/man7/posixoptions.7:145
6328 msgid "--- - _POSIX_FILE_LOCKING - _SC_FILE_LOCKING"
6332 #. IEC 60559 Floating-Point Option.
6334 #: build/C/man7/posixoptions.7:148 build/C/man7/posixoptions.7:238
6335 msgid "This option has been deleted. Not in final XPG6."
6339 #: build/C/man7/posixoptions.7:148
6341 msgid "FSC - _POSIX_FSYNC - _SC_FSYNC"
6345 #: build/C/man7/posixoptions.7:152
6346 msgid "The function I<fsync>() is present."
6350 #: build/C/man7/posixoptions.7:152
6352 msgid "IP6 - _POSIX_IPV6 - _SC_IPV6"
6356 #: build/C/man7/posixoptions.7:154
6357 msgid "Internet Protocol Version 6 is supported."
6361 #: build/C/man7/posixoptions.7:154
6363 msgid "--- - _POSIX_JOB_CONTROL - _SC_JOB_CONTROL"
6367 #: build/C/man7/posixoptions.7:158
6369 "If this option is in effect (as it always is under POSIX.1-2001), then the "
6370 "system implements POSIX-style job control, and the following functions are "
6375 #: build/C/man7/posixoptions.7:169
6382 "I<tcsendbreak>(),\n"
6388 #: build/C/man7/posixoptions.7:171
6390 msgid "MF - _POSIX_MAPPED_FILES - _SC_MAPPED_FILES"
6394 #: build/C/man7/posixoptions.7:180
6396 "Shared memory is supported. The include file I<E<lt>sys/mman.hE<gt>> is "
6397 "present. The following functions are present: I<mmap>(), I<msync>(), "
6402 #: build/C/man7/posixoptions.7:180
6404 msgid "ML - _POSIX_MEMLOCK - _SC_MEMLOCK"
6408 #: build/C/man7/posixoptions.7:186
6410 "Shared memory can be locked into core. The functions I<mlockall>(), "
6411 "I<munlockall>() are present."
6415 #: build/C/man7/posixoptions.7:186
6417 msgid "MR/MLR - _POSIX_MEMLOCK_RANGE - _SC_MEMLOCK_RANGE"
6421 #: build/C/man7/posixoptions.7:192
6423 "More precisely, ranges can be locked into core. The functions I<mlock>(), "
6424 "I<munlock>() are present."
6428 #: build/C/man7/posixoptions.7:192
6430 msgid "MPR - _POSIX_MEMORY_PROTECTION - _SC_MEMORY_PROTECTION"
6434 #: build/C/man7/posixoptions.7:196
6435 msgid "The function I<mprotect>() is present."
6439 #: build/C/man7/posixoptions.7:196
6441 msgid "MSG - _POSIX_MESSAGE_PASSING - _SC_MESSAGE_PASSING"
6445 #: build/C/man7/posixoptions.7:201
6447 "The include file I<E<lt>mqueue.hE<gt>> is present. The following functions "
6452 #: build/C/man7/posixoptions.7:213
6456 "I<mq_getattr>(),\n"
6459 "I<mq_receive>(),\n"
6461 "I<mq_setattr>(),\n"
6466 #: build/C/man7/posixoptions.7:216
6468 msgid "MON - _POSIX_MONOTONIC_CLOCK - _SC_MONOTONIC_CLOCK"
6472 #: build/C/man7/posixoptions.7:223
6474 "B<CLOCK_MONOTONIC> is supported. This option implies the B<_POSIX_TIMERS> "
6475 "option. Affected functions are"
6479 #: build/C/man7/posixoptions.7:231
6482 "I<aio_suspend>(),\n"
6483 "I<clock_getres>(),\n"
6484 "I<clock_gettime>(),\n"
6485 "I<clock_settime>(),\n"
6486 "I<timer_create>().\n"
6490 #: build/C/man7/posixoptions.7:233
6492 msgid "--- - _POSIX_MULTI_PROCESS - _SC_MULTI_PROCESS"
6496 #: build/C/man7/posixoptions.7:238
6498 msgid "--- - _POSIX_NO_TRUNC"
6502 #: build/C/man7/posixoptions.7:245
6504 "If this option is in effect (as it always is under POSIX.1-2001) then "
6505 "pathname components longer than B<NAME_MAX> are not truncated, but give an "
6506 "error. This property may be dependent on the path prefix of the component."
6510 #: build/C/man7/posixoptions.7:245
6512 msgid "PIO - _POSIX_PRIORITIZED_IO - _SC_PRIORITIZED_IO"
6516 #: build/C/man7/posixoptions.7:248
6518 "This option says that one can specify priorities for asynchronous I/O. This "
6519 "affects the functions"
6523 #: build/C/man7/posixoptions.7:254
6531 #: build/C/man7/posixoptions.7:256
6533 msgid "PS - _POSIX_PRIORITY_SCHEDULING - _SC_PRIORITY_SCHEDULING"
6537 #: build/C/man7/posixoptions.7:261
6539 "The include file I<E<lt>sched.hE<gt>> is present. The following functions "
6544 #: build/C/man7/posixoptions.7:273
6547 "I<sched_get_priority_max>(),\n"
6548 "I<sched_get_priority_min>(),\n"
6549 "I<sched_getparam>(),\n"
6550 "I<sched_getscheduler>(),\n"
6551 "I<sched_rr_get_interval>(),\n"
6552 "I<sched_setparam>(),\n"
6553 "I<sched_setscheduler>(),\n"
6554 "I<sched_yield>().\n"
6558 #: build/C/man7/posixoptions.7:279
6560 "If also B<_POSIX_SPAWN> is in effect, then the following functions are "
6565 #: build/C/man7/posixoptions.7:287 build/C/man7/posixoptions.7:449
6568 "I<posix_spawnattr_getschedparam>(),\n"
6569 "I<posix_spawnattr_getschedpolicy>(),\n"
6570 "I<posix_spawnattr_setschedparam>(),\n"
6571 "I<posix_spawnattr_setschedpolicy>().\n"
6575 #: build/C/man7/posixoptions.7:289
6577 msgid "RS - _POSIX_RAW_SOCKETS"
6581 #: build/C/man7/posixoptions.7:294
6583 "Raw sockets are supported. Affected functions are I<getsockopt>(), "
6588 #: build/C/man7/posixoptions.7:294
6590 msgid "--- - _POSIX_READER_WRITER_LOCKS - _SC_READER_WRITER_LOCKS"
6594 #: build/C/man7/posixoptions.7:302
6596 "This option implies the B<_POSIX_THREADS> option. Conversely, under "
6597 "POSIX.1-2001 the B<_POSIX_THREADS> option implies this option."
6601 #: build/C/man7/posixoptions.7:304
6603 msgid "The following functions are present:\n"
6607 #: build/C/man7/posixoptions.7:315
6610 "I<pthread_rwlock_destroy>(),\n"
6611 "I<pthread_rwlock_init>(),\n"
6612 "I<pthread_rwlock_rdlock>(),\n"
6613 "I<pthread_rwlock_tryrdlock>(),\n"
6614 "I<pthread_rwlock_trywrlock>(),\n"
6615 "I<pthread_rwlock_unlock>(),\n"
6616 "I<pthread_rwlock_wrlock>(),\n"
6617 "I<pthread_rwlockattr_destroy>(),\n"
6618 "I<pthread_rwlockattr_init>().\n"
6622 #: build/C/man7/posixoptions.7:317
6624 msgid "RTS - _POSIX_REALTIME_SIGNALS - _SC_REALTIME_SIGNALS"
6628 #: build/C/man7/posixoptions.7:320
6629 msgid "Realtime signals are supported. The following functions are present:"
6633 #: build/C/man7/posixoptions.7:327
6637 "I<sigtimedwait>(),\n"
6638 "I<sigwaitinfo>().\n"
6642 #: build/C/man7/posixoptions.7:330
6644 msgid "--- - _POSIX_REGEXP - _SC_REGEXP"
6648 #: build/C/man7/posixoptions.7:334
6650 "If this option is in effect (as it always is under POSIX.1-2001) then POSIX "
6651 "regular expressions are supported and the following functions are present:"
6655 #: build/C/man7/posixoptions.7:342
6665 #: build/C/man7/posixoptions.7:345
6667 msgid "--- - _POSIX_SAVED_IDS - _SC_SAVED_IDS"
6671 #: build/C/man7/posixoptions.7:349
6673 "If this option is in effect (as it always is under POSIX.1-2001), then a "
6674 "process has a saved set-user-ID and a saved set-group-ID. Affected "
6679 #: build/C/man7/posixoptions.7:359
6691 #. Software development
6693 #: build/C/man7/posixoptions.7:364
6695 msgid "SEM - _POSIX_SEMAPHORES - _SC_SEMAPHORES"
6699 #: build/C/man7/posixoptions.7:369
6701 "The include file I<E<lt>semaphore.hE<gt>> is present. The following "
6702 "functions are present:"
6706 #: build/C/man7/posixoptions.7:382
6710 "I<sem_destroy>(),\n"
6711 "I<sem_getvalue>(),\n"
6715 "I<sem_trywait>(),\n"
6716 "I<sem_unlink>(),\n"
6721 #: build/C/man7/posixoptions.7:385
6723 msgid "SHM - _POSIX_SHARED_MEMORY_OBJECTS - _SC_SHARED_MEMORY_OBJECTS"
6727 #: build/C/man7/posixoptions.7:387 build/C/man7/posixoptions.7:703 build/C/man7/posixoptions.7:719 build/C/man7/posixoptions.7:833
6728 msgid "The following functions are present:"
6732 #: build/C/man7/posixoptions.7:395
6738 "I<shm_unlink>().\n"
6742 #: build/C/man7/posixoptions.7:398
6744 msgid "--- - _POSIX_SHELL - _SC_SHELL"
6748 #: build/C/man7/posixoptions.7:403
6750 "If this option is in effect (as it always is under POSIX.1-2001), the "
6751 "function I<system>() is present."
6755 #: build/C/man7/posixoptions.7:403
6757 msgid "SPN - _POSIX_SPAWN - _SC_SPAWN"
6761 #: build/C/man7/posixoptions.7:413
6763 "This option describes support for process creation in a context where it is "
6764 "difficult or impossible to use I<fork>(), for example, because no MMU is "
6765 "present. If B<_POSIX_SPAWN> is in effect, then the include file "
6766 "I<E<lt>spawn.hE<gt>> and the following functions are present:"
6770 #: build/C/man7/posixoptions.7:434
6773 "I<posix_spawn>(),\n"
6774 "I<posix_spawn_file_actions_addclose>(),\n"
6775 "I<posix_spawn_file_actions_adddup2>(),\n"
6776 "I<posix_spawn_file_actions_addopen>(),\n"
6777 "I<posix_spawn_file_actions_destroy>(),\n"
6778 "I<posix_spawn_file_actions_init>(),\n"
6779 "I<posix_spawnattr_destroy>(),\n"
6780 "I<posix_spawnattr_getsigdefault>(),\n"
6781 "I<posix_spawnattr_getflags>(),\n"
6782 "I<posix_spawnattr_getpgroup>(),\n"
6783 "I<posix_spawnattr_getsigmask>(),\n"
6784 "I<posix_spawnattr_init>(),\n"
6785 "I<posix_spawnattr_setsigdefault>(),\n"
6786 "I<posix_spawnattr_setflags>(),\n"
6787 "I<posix_spawnattr_setpgroup>(),\n"
6788 "I<posix_spawnattr_setsigmask>(),\n"
6789 "I<posix_spawnp>().\n"
6793 #: build/C/man7/posixoptions.7:441
6795 "If also B<_POSIX_PRIORITY_SCHEDULING> is in effect, then the following "
6796 "functions are present:"
6800 #: build/C/man7/posixoptions.7:451
6802 msgid "SPI - _POSIX_SPIN_LOCKS - _SC_SPIN_LOCKS"
6806 #: build/C/man7/posixoptions.7:467
6809 "I<pthread_spin_destroy>(),\n"
6810 "I<pthread_spin_init>(),\n"
6811 "I<pthread_spin_lock>(),\n"
6812 "I<pthread_spin_trylock>(),\n"
6813 "I<pthread_spin_unlock>().\n"
6817 #: build/C/man7/posixoptions.7:470
6819 msgid "SS - _POSIX_SPORADIC_SERVER - _SC_SPORADIC_SERVER"
6823 #: build/C/man7/posixoptions.7:478
6825 "The scheduling policy B<SCHED_SPORADIC> is supported. This option implies "
6826 "the B<_POSIX_PRIORITY_SCHEDULING> option. Affected functions are"
6830 #: build/C/man7/posixoptions.7:484
6833 "I<sched_setparam>(),\n"
6834 "I<sched_setscheduler>().\n"
6838 #: build/C/man7/posixoptions.7:487
6840 msgid "SIO - _POSIX_SYNCHRONIZED_IO - _SC_SYNCHRONIZED_IO"
6844 #: build/C/man7/posixoptions.7:493
6845 msgid "Affected functions are I<open>(), I<msync>(), I<fsync>(), I<fdatasync>()."
6849 #: build/C/man7/posixoptions.7:493
6851 msgid "TSA - _POSIX_THREAD_ATTR_STACKADDR - _SC_THREAD_ATTR_STACKADDR"
6855 #: 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
6856 msgid "Affected functions are"
6860 #: build/C/man7/posixoptions.7:503
6863 "I<pthread_attr_getstack>(),\n"
6864 "I<pthread_attr_getstackaddr>(),\n"
6865 "I<pthread_attr_setstack>(),\n"
6866 "I<pthread_attr_setstackaddr>().\n"
6870 #: build/C/man7/posixoptions.7:506
6872 msgid "TSS - _POSIX_THREAD_ATTR_STACKSIZE - _SC_THREAD_ATTR_STACKSIZE"
6876 #: build/C/man7/posixoptions.7:516
6879 "I<pthread_attr_getstack>(),\n"
6880 "I<pthread_attr_getstacksize>(),\n"
6881 "I<pthread_attr_setstack>(),\n"
6882 "I<pthread_attr_setstacksize>().\n"
6886 #: build/C/man7/posixoptions.7:519
6888 msgid "TCT - _POSIX_THREAD_CPUTIME - _SC_THREAD_CPUTIME"
6892 #: build/C/man7/posixoptions.7:525
6894 "The clockID CLOCK_THREAD_CPUTIME_ID is supported. This option implies the "
6895 "B<_POSIX_TIMERS> option. Affected functions are"
6899 #: build/C/man7/posixoptions.7:534
6902 "I<pthread_getcpuclockid>(),\n"
6903 "I<clock_getres>(),\n"
6904 "I<clock_gettime>(),\n"
6905 "I<clock_settime>(),\n"
6906 "I<timer_create>().\n"
6910 #: build/C/man7/posixoptions.7:537
6912 msgid "TPI - _POSIX_THREAD_PRIO_INHERIT - _SC_THREAD_PRIO_INHERIT"
6916 #: build/C/man7/posixoptions.7:545
6919 "I<pthread_mutexattr_getprotocol>(),\n"
6920 "I<pthread_mutexattr_setprotocol>().\n"
6924 #: build/C/man7/posixoptions.7:548
6926 msgid "TPP - _POSIX_THREAD_PRIO_PROTECT - _SC_THREAD_PRIO_PROTECT"
6930 #: build/C/man7/posixoptions.7:560
6933 "I<pthread_mutex_getprioceiling>(),\n"
6934 "I<pthread_mutex_setprioceiling>(),\n"
6935 "I<pthread_mutexattr_getprioceiling>(),\n"
6936 "I<pthread_mutexattr_getprotocol>(),\n"
6937 "I<pthread_mutexattr_setprioceiling>(),\n"
6938 "I<pthread_mutexattr_setprotocol>().\n"
6942 #: build/C/man7/posixoptions.7:563
6944 msgid "TPS - _POSIX_THREAD_PRIORITY_SCHEDULING - _SC_THREAD_PRIORITY_SCHEDULING"
6948 #: build/C/man7/posixoptions.7:567
6950 "If this option is in effect, the different threads inside a process can run "
6951 "with different priorities and/or different schedulers. Affected functions "
6956 #: build/C/man7/posixoptions.7:580
6959 "I<pthread_attr_getinheritsched>(),\n"
6960 "I<pthread_attr_getschedpolicy>(),\n"
6961 "I<pthread_attr_getscope>(),\n"
6962 "I<pthread_attr_setinheritsched>(),\n"
6963 "I<pthread_attr_setschedpolicy>(),\n"
6964 "I<pthread_attr_setscope>(),\n"
6965 "I<pthread_getschedparam>(),\n"
6966 "I<pthread_setschedparam>(),\n"
6967 "I<pthread_setschedprio>().\n"
6971 #: build/C/man7/posixoptions.7:583
6973 msgid "TSH - _POSIX_THREAD_PROCESS_SHARED - _SC_THREAD_PROCESS_SHARED"
6977 #: build/C/man7/posixoptions.7:597
6980 "I<pthread_barrierattr_getpshared>(),\n"
6981 "I<pthread_barrierattr_setpshared>(),\n"
6982 "I<pthread_condattr_getpshared>(),\n"
6983 "I<pthread_condattr_setpshared>(),\n"
6984 "I<pthread_mutexattr_getpshared>(),\n"
6985 "I<pthread_mutexattr_setpshared>(),\n"
6986 "I<pthread_rwlockattr_getpshared>(),\n"
6987 "I<pthread_rwlockattr_setpshared>().\n"
6991 #: build/C/man7/posixoptions.7:600
6993 msgid "TSF - _POSIX_THREAD_SAFE_FUNCTIONS - _SC_THREAD_SAFE_FUNCTIONS"
6997 #: build/C/man7/posixoptions.7:625
7001 "I<getgrgid_r>(),\n"
7002 "I<getgrnam_r>(),\n"
7003 "I<getpwnam_r>(),\n"
7004 "I<getpwuid_r>(),\n"
7006 "I<ftrylockfile>(),\n"
7007 "I<funlockfile>(),\n"
7008 "I<getc_unlocked>(),\n"
7009 "I<getchar_unlocked>(),\n"
7010 "I<putc_unlocked>(),\n"
7011 "I<putchar_unlocked>(),\n"
7013 "I<strerror_r>(),\n"
7018 "I<localtime_r>().\n"
7022 #: build/C/man7/posixoptions.7:628
7024 msgid "TSP - _POSIX_THREAD_SPORADIC_SERVER - _SC_THREAD_SPORADIC_SERVER"
7028 #: build/C/man7/posixoptions.7:633
7030 "This option implies the B<_POSIX_THREAD_PRIORITY_SCHEDULING> option. "
7031 "Affected functions are"
7035 #: build/C/man7/posixoptions.7:640
7038 "I<sched_getparam>(),\n"
7039 "I<sched_setparam>(),\n"
7040 "I<sched_setscheduler>().\n"
7044 #: build/C/man7/posixoptions.7:643
7046 msgid "THR - _POSIX_THREADS - _SC_THREADS"
7050 #: build/C/man7/posixoptions.7:646
7052 "Basic support for POSIX threads is available. The following functions are "
7057 #: build/C/man7/posixoptions.7:698
7060 "I<pthread_atfork>(),\n"
7061 "I<pthread_attr_destroy>(),\n"
7062 "I<pthread_attr_getdetachstate>(),\n"
7063 "I<pthread_attr_getschedparam>(),\n"
7064 "I<pthread_attr_init>(),\n"
7065 "I<pthread_attr_setdetachstate>(),\n"
7066 "I<pthread_attr_setschedparam>(),\n"
7067 "I<pthread_cancel>(),\n"
7068 "I<pthread_cleanup_push>(),\n"
7069 "I<pthread_cleanup_pop>(),\n"
7070 "I<pthread_cond_broadcast>(),\n"
7071 "I<pthread_cond_destroy>(),\n"
7072 "I<pthread_cond_init>(),\n"
7073 "I<pthread_cond_signal>(),\n"
7074 "I<pthread_cond_timedwait>(),\n"
7075 "I<pthread_cond_wait>(),\n"
7076 "I<pthread_condattr_destroy>(),\n"
7077 "I<pthread_condattr_init>(),\n"
7078 "I<pthread_create>(),\n"
7079 "I<pthread_detach>(),\n"
7080 "I<pthread_equal>(),\n"
7081 "I<pthread_exit>(),\n"
7082 "I<pthread_getspecific>(),\n"
7083 "I<pthread_join>(),\n"
7084 "I<pthread_key_create>(),\n"
7085 "I<pthread_key_delete>(),\n"
7086 "I<pthread_mutex_destroy>(),\n"
7087 "I<pthread_mutex_init>(),\n"
7088 "I<pthread_mutex_lock>(),\n"
7089 "I<pthread_mutex_trylock>(),\n"
7090 "I<pthread_mutex_unlock>(),\n"
7091 "I<pthread_mutexattr_destroy>(),\n"
7092 "I<pthread_mutexattr_init>(),\n"
7093 "I<pthread_once>(),\n"
7094 "I<pthread_rwlock_destroy>(),\n"
7095 "I<pthread_rwlock_init>(),\n"
7096 "I<pthread_rwlock_rdlock>(),\n"
7097 "I<pthread_rwlock_tryrdlock>(),\n"
7098 "I<pthread_rwlock_trywrlock>(),\n"
7099 "I<pthread_rwlock_unlock>(),\n"
7100 "I<pthread_rwlock_wrlock>(),\n"
7101 "I<pthread_rwlockattr_destroy>(),\n"
7102 "I<pthread_rwlockattr_init>(),\n"
7103 "I<pthread_self>(),\n"
7104 "I<pthread_setcancelstate>(),\n"
7105 "I<pthread_setcanceltype>(),\n"
7106 "I<pthread_setspecific>(),\n"
7107 "I<pthread_testcancel>().\n"
7111 #: build/C/man7/posixoptions.7:701
7113 msgid "TMO - _POSIX_TIMEOUTS - _SC_TIMEOUTS"
7117 #: build/C/man7/posixoptions.7:714
7120 "I<mq_timedreceive>(),\n"
7121 "I<mq_timedsend>(),\n"
7122 "I<pthread_mutex_timedlock>(),\n"
7123 "I<pthread_rwlock_timedrdlock>(),\n"
7124 "I<pthread_rwlock_timedwrlock>(),\n"
7125 "I<sem_timedwait>(),\n"
7126 "I<posix_trace_timedgetnext_event>().\n"
7130 #: build/C/man7/posixoptions.7:717
7132 msgid "TMR - _POSIX_TIMERS - _SC_TIMERS"
7136 #: build/C/man7/posixoptions.7:732
7139 "I<clock_getres>(),\n"
7140 "I<clock_gettime>(),\n"
7141 "I<clock_settime>(),\n"
7143 "I<timer_create>(),\n"
7144 "I<timer_delete>(),\n"
7145 "I<timer_gettime>(),\n"
7146 "I<timer_getoverrun>(),\n"
7147 "I<timer_settime>().\n"
7151 #: build/C/man7/posixoptions.7:735
7153 msgid "TRC - _POSIX_TRACE - _SC_TRACE"
7157 #: build/C/man7/posixoptions.7:738
7158 msgid "POSIX tracing is available. The following functions are present:"
7162 #: build/C/man7/posixoptions.7:773
7165 "I<posix_trace_attr_destroy>(),\n"
7166 "I<posix_trace_attr_getclockres>(),\n"
7167 "I<posix_trace_attr_getcreatetime>(),\n"
7168 "I<posix_trace_attr_getgenversion>(),\n"
7169 "I<posix_trace_attr_getmaxdatasize>(),\n"
7170 "I<posix_trace_attr_getmaxsystemeventsize>(),\n"
7171 "I<posix_trace_attr_getmaxusereventsize>(),\n"
7172 "I<posix_trace_attr_getname>(),\n"
7173 "I<posix_trace_attr_getstreamfullpolicy>(),\n"
7174 "I<posix_trace_attr_getstreamsize>(),\n"
7175 "I<posix_trace_attr_init>(),\n"
7176 "I<posix_trace_attr_setmaxdatasize>(),\n"
7177 "I<posix_trace_attr_setname>(),\n"
7178 "I<posix_trace_attr_setstreamsize>(),\n"
7179 "I<posix_trace_attr_setstreamfullpolicy>(),\n"
7180 "I<posix_trace_clear>(),\n"
7181 "I<posix_trace_create>(),\n"
7182 "I<posix_trace_event>(),\n"
7183 "I<posix_trace_eventid_equal>(),\n"
7184 "I<posix_trace_eventid_get_name>(),\n"
7185 "I<posix_trace_eventid_open>(),\n"
7186 "I<posix_trace_eventtypelist_getnext_id>(),\n"
7187 "I<posix_trace_eventtypelist_rewind>(),\n"
7188 "I<posix_trace_flush>(),\n"
7189 "I<posix_trace_get_attr>(),\n"
7190 "I<posix_trace_get_status>(),\n"
7191 "I<posix_trace_getnext_event>(),\n"
7192 "I<posix_trace_shutdown>(),\n"
7193 "I<posix_trace_start>(),\n"
7194 "I<posix_trace_stop>(),\n"
7195 "I<posix_trace_trygetnext_event>().\n"
7199 #: build/C/man7/posixoptions.7:776
7201 msgid "TEF - _POSIX_TRACE_EVENT_FILTER - _SC_TRACE_EVENT_FILTER"
7205 #: build/C/man7/posixoptions.7:781 build/C/man7/posixoptions.7:816
7207 "This option implies the B<_POSIX_TRACE> option. The following functions are "
7212 #: build/C/man7/posixoptions.7:793
7215 "I<posix_trace_eventset_add>(),\n"
7216 "I<posix_trace_eventset_del>(),\n"
7217 "I<posix_trace_eventset_empty>(),\n"
7218 "I<posix_trace_eventset_fill>(),\n"
7219 "I<posix_trace_eventset_ismember>(),\n"
7220 "I<posix_trace_get_filter>(),\n"
7221 "I<posix_trace_set_filter>(),\n"
7222 "I<posix_trace_trid_eventid_open>().\n"
7226 #: build/C/man7/posixoptions.7:796
7228 msgid "TRI - _POSIX_TRACE_INHERIT - _SC_TRACE_INHERIT"
7232 #: build/C/man7/posixoptions.7:802
7234 "Tracing children of the traced process is supported. This option implies "
7235 "the B<_POSIX_TRACE> option. The following functions are present:"
7239 #: build/C/man7/posixoptions.7:808
7242 "I<posix_trace_attr_getinherited>(),\n"
7243 "I<posix_trace_attr_setinherited>().\n"
7247 #: build/C/man7/posixoptions.7:811
7249 msgid "TRL - _POSIX_TRACE_LOG - _SC_TRACE_LOG"
7253 #: build/C/man7/posixoptions.7:828
7256 "I<posix_trace_attr_getlogfullpolicy>(),\n"
7257 "I<posix_trace_attr_getlogsize>(),\n"
7258 "I<posix_trace_attr_setlogfullpolicy>(),\n"
7259 "I<posix_trace_attr_setlogsize>(),\n"
7260 "I<posix_trace_close>(),\n"
7261 "I<posix_trace_create_withlog>(),\n"
7262 "I<posix_trace_open>(),\n"
7263 "I<posix_trace_rewind>().\n"
7267 #: build/C/man7/posixoptions.7:831
7269 msgid "TYM - _POSIX_TYPED_MEMORY_OBJECTS - _SC_TYPED_MEMORY_OBJECT"
7273 #: build/C/man7/posixoptions.7:840
7276 "I<posix_mem_offset>(),\n"
7277 "I<posix_typed_mem_get_info>(),\n"
7278 "I<posix_typed_mem_open>().\n"
7282 #: build/C/man7/posixoptions.7:843
7284 msgid "--- - _POSIX_VDISABLE"
7288 #: build/C/man7/posixoptions.7:847
7290 "Always present (probably 0). Value to set a changeable special control "
7291 "character to indicate that it is disabled."
7295 #: build/C/man7/posixoptions.7:847
7297 msgid "XOPEN EXTENSIONS"
7302 #: build/C/man7/posixoptions.7:854
7304 "B<_XOPEN_CRYPT>, B<_XOPEN_LEGACY>, B<_XOPEN_REALTIME>, "
7305 "B<_XOPEN_REALTIME_THREADS>, B<_XOPEN_UNIX>."
7309 #: build/C/man7/posixoptions.7:857
7310 msgid "B<sysconf>(3), B<standards>(7)"
7314 #: build/C/man5/proc.5:55
7320 #: build/C/man5/proc.5:55
7326 #: build/C/man5/proc.5:58
7327 msgid "proc - process information pseudo-filesystem"
7331 #: build/C/man5/proc.5:67
7333 "The I<proc> filesystem is a pseudo-filesystem which provides an interface to "
7334 "kernel data structures. It is commonly mounted at I</proc>. Most of it is "
7335 "read-only, but some files allow kernel variables to be changed."
7339 #: build/C/man5/proc.5:71
7341 "The following list describes many of the files and directories under the "
7342 "I</proc> hierarchy."
7346 #: build/C/man5/proc.5:72
7348 msgid "I</proc/[pid]>"
7351 #. FIXME Describe /proc/[pid]/attr and
7352 #. /proc/[pid]/task/[tid]/attr
7353 #. This is a directory
7356 #. https://lwn.net/Articles/28222/
7357 #. http://www.nsa.gov/research/_files/selinux/papers/module/x362.shtml
7359 #. fscreate, current, prev, and exec present in Linux 2.6.0
7360 #. keycreate added in Linux 2.6.18
7361 #. commit 4eb582cf1fbd7b9e5f466e3718a59c957e75254e
7362 #. /Documentation/keys.txt
7363 #. sockcreate added in Linux 2.6.18
7364 #. commit 42c3e03ef6b298813557cdb997bd6db619cd65a2
7366 #. FIXME Describe /proc/[pid]/autogroup
7368 #. commit 5091faa449ee0b7d73bc296a93bca9540fc51d0a
7369 #. CONFIG_SCHED_AUTOGROUP
7371 #: build/C/man5/proc.5:98
7373 "There is a numerical subdirectory for each running process; the subdirectory "
7374 "is named by the process ID. Each such subdirectory contains the following "
7375 "pseudo-files and directories."
7379 #: build/C/man5/proc.5:98
7381 msgid "I</proc/[pid]/auxv> (since 2.6.0-test7)"
7385 #: build/C/man5/proc.5:107
7387 "This contains the contents of the ELF interpreter information passed to the "
7388 "process at exec time. The format is one I<unsigned long> ID plus one "
7389 "I<unsigned long> value for each entry. The last entry contains two zeros. "
7390 "See also B<getauxval>(3)."
7394 #: build/C/man5/proc.5:107
7396 msgid "I</proc/[pid]/cgroup> (since Linux 2.6.24)"
7399 #. Info in Documentation/cgroups/cgroups.txt
7401 #: build/C/man5/proc.5:113
7403 "This file describes control groups to which the process/task belongs. For "
7404 "each cgroup hierarchy there is one entry containing colon-separated fields "
7409 #: build/C/man5/proc.5:117
7411 msgid "CW< 5:cpuacct,cpu,cpuset:/daemons>\n"
7415 #: build/C/man5/proc.5:121
7416 msgid "The colon-separated fields are, from left to right:"
7420 #: build/C/man5/proc.5:122
7426 #: build/C/man5/proc.5:124
7427 msgid "hierarchy ID number"
7431 #: build/C/man5/proc.5:124
7437 #: build/C/man5/proc.5:126
7438 msgid "set of subsystems bound to the hierarchy"
7442 #: build/C/man5/proc.5:126
7448 #: build/C/man5/proc.5:128
7449 msgid "control group in the hierarchy to which the process belongs"
7453 #: build/C/man5/proc.5:133
7455 "This file is present only if the B<CONFIG_CGROUPS> kernel configuration "
7456 "option is enabled."
7460 #: build/C/man5/proc.5:133
7462 msgid "I</proc/[pid]/clear_refs> (since Linux 2.6.22)"
7465 #. commit b813e931b4c8235bb42e301096ea97dbdee3e8fe (2.6.22)
7466 #. commit 398499d5f3613c47f2143b8c54a04efb5d7a6da9 (2.6.32)
7467 #. commit 040fa02077de01c7e08fa75be6125e4ca5636011 (3.11)
7469 #. "Clears page referenced bits shown in smaps output"
7470 #. write-only, writable only by the owner of the process
7472 #: build/C/man5/proc.5:143
7473 msgid "This is a write-only file, writable only by owner of the process."
7477 #: build/C/man5/proc.5:145
7478 msgid "The following values may be written to the file:"
7482 #: build/C/man5/proc.5:146
7484 msgid "1 (since Linux 2.6.22)"
7487 #. Internally: CLEAR_REFS_ALL
7489 #: build/C/man5/proc.5:153
7491 "Reset the PG_Referenced and ACCESSED/YOUNG bits for all the pages associated "
7492 "with the process. (Before kernel 2.6.32, writing any nonzero value to this "
7493 "file had this effect.)"
7497 #: build/C/man5/proc.5:153
7499 msgid "2 (since Linux 2.6.32)"
7502 #. Internally: CLEAR_REFS_ANON
7504 #: build/C/man5/proc.5:158
7506 "Reset the PG_Referenced and ACCESSED/YOUNG bits for all anonymous pages "
7507 "associated with the process."
7511 #: build/C/man5/proc.5:158
7513 msgid "3 (since Linux 2.6.32)"
7516 #. Internally: CLEAR_REFS_MAPPED
7518 #: build/C/man5/proc.5:163
7520 "Reset the PG_Referenced and ACCESSED/YOUNG bits for all file-mapped pages "
7521 "associated with the process."
7525 #: build/C/man5/proc.5:179
7527 "Clearing the PG_Referenced and ACCESSED/YOUNG bits provides a method to "
7528 "measure approximately how much memory a process is using. One first "
7529 "inspects the values in the \"Referenced\" fields for the VMAs shown in "
7530 "I</proc/[pid]/smaps> to get an idea of the memory footprint of the process. "
7531 "One then clears the PG_Referenced and ACCESSED/YOUNG bits and, after some "
7532 "measured time interval, once again inspects the values in the \"Referenced\" "
7533 "fields to get an idea of the change in memory footprint of the process "
7534 "during the measured interval. If one is interested only in inspecting the "
7535 "selected mapping types, then the value 2 or 3 can be used instead of 1."
7539 #: build/C/man5/proc.5:181
7540 msgid "A further value can be written to affect a different bit:"
7544 #: build/C/man5/proc.5:182
7546 msgid "4 (since Linux 3.11)"
7549 #. Internally: CLEAR_REFS_SOFT_DIRTY
7551 #: build/C/man5/proc.5:192
7553 "Clear the soft-dirty bit for all the pages associated with the process. "
7554 "This is used (in conjunction with I</proc/[pid]/pagemap>) by the "
7555 "check-point restore system to discover which pages of a process have been "
7556 "dirtied since the file I</proc/[pid]/clear_refs> was written to."
7560 #: build/C/man5/proc.5:197
7562 "Writing any value to I</proc/[pid]/clear_refs> other than those listed above "
7567 #: build/C/man5/proc.5:203
7569 "The I</proc/[pid]/clear_refs> file is present only if the "
7570 "B<CONFIG_PROC_PAGE_MONITOR> kernel configuration option is enabled."
7574 #: build/C/man5/proc.5:203
7576 msgid "I</proc/[pid]/cmdline>"
7579 #. In 2.3.26, this also used to be true if the process was swapped out.
7581 #: build/C/man5/proc.5:213
7583 "This read-only file holds the complete command line for the process, unless "
7584 "the process is a zombie. In the latter case, there is nothing in this file: "
7585 "that is, a read on this file will return 0 characters. The command-line "
7586 "arguments appear in this file as a set of strings separated by null bytes "
7587 "(\\(aq\\e0\\(aq), with a further null byte after the last string."
7591 #: build/C/man5/proc.5:213
7593 msgid "I</proc/[pid]/comm> (since Linux 2.6.33)"
7596 #. commit 4614a696bd1c3a9af3a08f0e5874830a85b889d4
7598 #: build/C/man5/proc.5:235
7600 "This file exposes the process's I<comm> value\\(emthat is, the command name "
7601 "associated with the process. Different threads in the same process may have "
7602 "different I<comm> values, accessible via I</proc/[pid]/task/[tid]/comm>. A "
7603 "thread may modify its I<comm> value, or that of any of other thread in the "
7604 "same thread group (see the discussion of B<CLONE_THREAD> in B<clone>(2)), by "
7605 "writing to the file I</proc/self/task/[tid]/comm>. Strings longer than "
7606 "B<TASK_COMM_LEN> (16) characters are silently truncated."
7610 #: build/C/man5/proc.5:244
7612 "This file provides a superset of the B<prctl>(2) B<PR_SET_NAME> and "
7613 "B<PR_GET_NAME> operations, and is employed by B<pthread_setname_np>(3) when "
7614 "used to rename threads other than the caller."
7618 #: build/C/man5/proc.5:244
7620 msgid "I</proc/[pid]/coredump_filter> (since Linux 2.6.23)"
7624 #: build/C/man5/proc.5:248 build/C/man5/proc.5:3509 build/C/man5/proc.5:3513
7625 msgid "See B<core>(5)."
7629 #: build/C/man5/proc.5:248
7631 msgid "I</proc/[pid]/cpuset> (since Linux 2.6.12)"
7634 #. and/proc/[pid]/task/[tid]/cpuset
7636 #: build/C/man5/proc.5:253
7637 msgid "See B<cpuset>(7)."
7641 #: build/C/man5/proc.5:253
7643 msgid "I</proc/[pid]/cwd>"
7647 #: build/C/man5/proc.5:258
7649 "This is a symbolic link to the current working directory of the process. To "
7650 "find out the current working directory of process 20, for instance, you can "
7655 #: build/C/man5/proc.5:262
7657 msgid "$B< cd /proc/20/cwd; /bin/pwd>\n"
7661 #: build/C/man5/proc.5:273
7663 "Note that the I<pwd> command is often a shell built-in, and might not work "
7664 "properly. In B<bash>(1), you may use I<pwd\\ -P>."
7667 #. The following was still true as at kernel 2.6.13
7668 #. FIXME Describe /proc/[pid]/projid_map
7669 #. Added in 3.7, commit f76d207a66c3a53defea67e7d36c3eb1b7d6d61d
7670 #. FIXME Describe /proc/[pid]/seccomp
7673 #. FIXME Describe /proc/[pid]/sessionid
7674 #. Added in 2.6.25; read-only; only readable by real UID
7675 #. commit 1e0bd7550ea9cf474b1ad4c6ff5729a507f75fdc
7676 #. CONFIG_AUDITSYSCALL
7678 #. FIXME Describe /proc/[pid]/sched
7680 #. CONFIG_SCHED_DEBUG, and additional fields if CONFIG_SCHEDSTATS
7681 #. Displays various scheduling parameters
7682 #. This file can be written, to reset stats
7683 #. The set of fields exposed by this file have changed
7684 #. significantly over time.
7685 #. commit 43ae34cb4cd650d1eb4460a8253a8e747ba052ac
7687 #. FIXME Describe /proc/[pid]/schedstats and
7688 #. /proc/[pid]/task/[tid]/schedstats
7690 #. CONFIG_SCHEDSTATS
7692 #: build/C/man5/proc.5:279 build/C/man5/proc.5:1099
7694 "In a multithreaded process, the contents of this symbolic link are not "
7695 "available if the main thread has already terminated (typically by calling "
7696 "B<pthread_exit>(3))."
7700 #: build/C/man5/proc.5:279
7702 msgid "I</proc/[pid]/environ>"
7706 #: build/C/man5/proc.5:285
7708 "This file contains the environment for the process. The entries are "
7709 "separated by null bytes (\\(aq\\e0\\(aq), and there may be a null byte at "
7710 "the end. Thus, to print out the environment of process 1, you would do:"
7714 #: build/C/man5/proc.5:290
7716 msgid "$B< strings /proc/1/environ>\n"
7720 #: build/C/man5/proc.5:293
7722 msgid "I</proc/[pid]/exe>"
7725 #. The following was still true as at kernel 2.6.13
7727 #: build/C/man5/proc.5:308
7729 "Under Linux 2.2 and later, this file is a symbolic link containing the "
7730 "actual pathname of the executed command. This symbolic link can be "
7731 "dereferenced normally; attempting to open it will open the executable. You "
7732 "can even type I</proc/[pid]/exe> to run another copy of the same executable "
7733 "as is being run by process [pid]. In a multithreaded process, the contents "
7734 "of this symbolic link are not available if the main thread has already "
7735 "terminated (typically by calling B<pthread_exit>(3))."
7739 #: build/C/man5/proc.5:316
7741 "Under Linux 2.0 and earlier, I</proc/[pid]/exe> is a pointer to the binary "
7742 "which was executed, and appears as a symbolic link. A B<readlink>(2) call "
7743 "on this file under Linux 2.0 returns a string in the format:"
7747 #: build/C/man5/proc.5:318
7749 msgid " [device]:inode\n"
7753 #: build/C/man5/proc.5:321
7755 "For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, MFM, "
7756 "etc. drives) minor 01 (first partition on the first drive)."
7760 #: build/C/man5/proc.5:326
7761 msgid "B<find>(1) with the I<-inum> option can be used to locate the file."
7765 #: build/C/man5/proc.5:326
7767 msgid "I</proc/[pid]/fd/>"
7771 #: build/C/man5/proc.5:332
7773 "This is a subdirectory containing one entry for each file which the process "
7774 "has open, named by its file descriptor, and which is a symbolic link to the "
7775 "actual file. Thus, 0 is standard input, 1 standard output, 2 standard "
7780 #: build/C/man5/proc.5:339
7782 "For file descriptors for pipes and sockets, the entries will be symbolic "
7783 "links whose content is the file type with the inode. A B<readlink>(2) call "
7784 "on this file returns a string in the format:"
7788 #: build/C/man5/proc.5:341
7790 msgid " type:[inode]\n"
7794 #: build/C/man5/proc.5:348
7796 "For example, I<socket:[2248868]> will be a socket and its inode is 2248868. "
7797 "For sockets, that inode can be used to find more information in one of the "
7798 "files under I</proc/net/>."
7802 #: build/C/man5/proc.5:358
7804 "For file descriptors that have no corresponding inode (e.g., file "
7805 "descriptors produced by B<epoll_create>(2), B<eventfd>(2), "
7806 "B<inotify_init>(2), B<signalfd>(2), and B<timerfd>(2)), the entry will be a "
7807 "symbolic link with contents of the form"
7811 #: build/C/man5/proc.5:360
7813 msgid " anon_inode:E<lt>file-typeE<gt>\n"
7817 #: build/C/man5/proc.5:364
7818 msgid "In some cases, the I<file-type> is surrounded by square brackets."
7822 #: build/C/man5/proc.5:368
7824 "For example, an epoll file descriptor will have a symbolic link whose "
7825 "content is the string I<anon_inode:[eventpoll]>."
7828 #. The following was still true as at kernel 2.6.13
7830 #: build/C/man5/proc.5:374
7832 "In a multithreaded process, the contents of this directory are not available "
7833 "if the main thread has already terminated (typically by calling "
7834 "B<pthread_exit>(3))."
7838 #: build/C/man5/proc.5:387
7840 "Programs that will take a filename as a command-line argument, but will not "
7841 "take input from standard input if no argument is supplied, or that write to "
7842 "a file named as a command-line argument, but will not send their output to "
7843 "standard output if no argument is supplied, can nevertheless be made to use "
7844 "standard input or standard out using I</proc/[pid]/fd>. For example, "
7845 "assuming that I<-i> is the flag designating an input file and I<-o> is the "
7846 "flag designating an output file:"
7850 #: build/C/man5/proc.5:391
7852 msgid "$B< foobar -i /proc/self/fd/0 -o /proc/self/fd/1 ...>\n"
7855 #. The following is not true in my tests (MTK):
7856 #. Note that this will not work for
7857 #. programs that seek on their files, as the files in the fd directory
7858 #. are not seekable.
7860 #: build/C/man5/proc.5:399
7861 msgid "and you have a working filter."
7865 #: build/C/man5/proc.5:409
7867 "I</proc/self/fd/N> is approximately the same as I</dev/fd/N> in some UNIX "
7868 "and UNIX-like systems. Most Linux MAKEDEV scripts symbolically link "
7869 "I</dev/fd> to I</proc/self/fd>, in fact."
7873 #: build/C/man5/proc.5:423
7875 "Most systems provide symbolic links I</dev/stdin>, I</dev/stdout>, and "
7876 "I</dev/stderr>, which respectively link to the files I<0>, I<1>, and I<2> in "
7877 "I</proc/self/fd>. Thus the example command above could be written as:"
7881 #: build/C/man5/proc.5:427
7883 msgid "$B< foobar -i /dev/stdin -o /dev/stdout ...>\n"
7887 #: build/C/man5/proc.5:432
7889 msgid "I</proc/[pid]/fdinfo/> (since Linux 2.6.22)"
7893 #: build/C/man5/proc.5:438
7895 "This is a subdirectory containing one entry for each file which the process "
7896 "has open, named by its file descriptor. The contents of each file can be "
7897 "read to obtain information about the corresponding file descriptor, for "
7902 #: build/C/man5/proc.5:444
7905 "$B< cat /proc/12015/fdinfo/4>\n"
7911 #: build/C/man5/proc.5:455
7913 "The I<pos> field is a decimal number showing the current file offset. The "
7914 "I<flags> field is an octal number that displays the file access mode and "
7915 "file status flags (see B<open>(2))."
7919 #. Certain file types include additional info; see
7920 #. Documentation/filesystems/proc.txt
7922 #. Especially interesting is this:
7924 #. commit ab49bdecc3ebb46ab661f5f05d5c5ea9606406c6
7925 #. Author: Cyrill Gorcunov <gorcunov@openvz.org>
7926 #. Date: Mon Dec 17 16:05:06 2012 -0800
7928 #. Basically, the /proc/PID/fdinfo/ entry for an inotify FD
7929 #. includes the file handles for all watched FDs
7931 #: build/C/man5/proc.5:470
7932 msgid "The files in this directory are readable only by the owner of the process."
7936 #: build/C/man5/proc.5:470
7938 msgid "I</proc/[pid]/io> (since kernel 2.6.20)"
7941 #. commit 7c3ab7381e79dfc7db14a67c6f4f3285664e1ec2
7943 #: build/C/man5/proc.5:474
7944 msgid "This file contains I/O statistics for the process, for example:"
7948 #: build/C/man5/proc.5:485
7951 "#B< cat /proc/3828/io>\n"
7952 "rchar: 323934931\n"
7953 "wchar: 323929600\n"
7957 "write_bytes: 323932160\n"
7958 "cancelled_write_bytes: 0\n"
7962 #: build/C/man5/proc.5:489 build/C/man5/proc.5:1613
7963 msgid "The fields are as follows:"
7967 #: build/C/man5/proc.5:490
7969 msgid "I<rchar>: characters read"
7973 #: build/C/man5/proc.5:500
7975 "The number of bytes which this task has caused to be read from storage. "
7976 "This is simply the sum of bytes which this process passed to B<read>(2) and "
7977 "similar system calls. It includes things such as terminal I/O and is "
7978 "unaffected by whether or not actual physical disk I/O was required (the read "
7979 "might have been satisfied from pagecache)."
7983 #: build/C/man5/proc.5:500
7985 msgid "I<wchar>: characters written"
7989 #: build/C/man5/proc.5:506
7991 "The number of bytes which this task has caused, or shall cause to be written "
7992 "to disk. Similar caveats apply here as with I<rchar>."
7996 #: build/C/man5/proc.5:506
7998 msgid "I<syscr>: read syscalls"
8002 #: build/C/man5/proc.5:513
8004 "Attempt to count the number of read I/O operations\\(emthat is, system calls "
8005 "such as B<read>(2) and B<pread>(2)."
8009 #: build/C/man5/proc.5:513
8011 msgid "I<syscw>: write syscalls"
8015 #: build/C/man5/proc.5:520
8017 "Attempt to count the number of write I/O operations\\(emthat is, system "
8018 "calls such as B<write>(2) and B<pwrite>(2)."
8022 #: build/C/man5/proc.5:520
8024 msgid "I<read_bytes>: bytes read"
8028 #: build/C/man5/proc.5:525
8030 "Attempt to count the number of bytes which this process really did cause to "
8031 "be fetched from the storage layer. This is accurate for block-backed "
8036 #: build/C/man5/proc.5:525
8038 msgid "I<write_bytes>: bytes written"
8042 #: build/C/man5/proc.5:529
8044 "Attempt to count the number of bytes which this process caused to be sent to "
8045 "the storage layer."
8049 #: build/C/man5/proc.5:529
8051 msgid "I<cancelled_write_bytes>:"
8055 #: build/C/man5/proc.5:543
8057 "The big inaccuracy here is truncate. If a process writes 1MB to a file and "
8058 "then deletes the file, it will in fact perform no writeout. But it will "
8059 "have been accounted as having caused 1MB of write. In other words: this "
8060 "field represents the number of bytes which this process caused to not "
8061 "happen, by truncating pagecache. A task can cause \"negative\" I/O too. If "
8062 "this task truncates some dirty pagecache, some I/O which another task has "
8063 "been accounted for (in its I<write_bytes>) will not be happening."
8067 #: build/C/man5/proc.5:551
8069 "I<Note>: In the current implementation, things are a bit racy on 32-bit "
8070 "systems: if process A reads process B's I</proc/[pid]/io> while process B is "
8071 "updating one of these 64-bit counters, process A could see an intermediate "
8076 #: build/C/man5/proc.5:551
8078 msgid "I</proc/[pid]/gid_map> (since Linux 3.5)"
8082 #: build/C/man5/proc.5:555
8083 msgid "See the description of I</proc/[pid]/uid_map>."
8087 #: build/C/man5/proc.5:556
8089 msgid "I</proc/[pid]/limits> (since Linux 2.6.24)"
8092 #. commit 3036e7b490bf7878c6dae952eec5fb87b1106589
8094 #: build/C/man5/proc.5:566
8096 "This file displays the soft limit, hard limit, and units of measurement for "
8097 "each of the process's resource limits (see B<getrlimit>(2)). Up to and "
8098 "including Linux 2.6.35, this file is protected to allow reading only by the "
8099 "real UID of the process. Since Linux 2.6.36, this file is readable by all "
8100 "users on the system."
8104 #: build/C/man5/proc.5:566
8106 msgid "I</proc/[pid]/map_files/> (since kernel 3.3)"
8109 #. commit 640708a2cff7f81e246243b0073c66e6ece7e53e
8111 #: build/C/man5/proc.5:576
8113 "This subdirectory contains entries corresponding to memory-mapped files (see "
8114 "B<mmap>(2)). Entries are named by memory region start and end address pair "
8115 "(expressed as hexadecimal numbers), and are symbolic links to the mapped "
8116 "files themselves. Here is an example, with the output wrapped and "
8117 "reformatted to fit on an 80-column display:"
8121 #: build/C/man5/proc.5:583
8124 "$B< ls -l /proc/self/map_files/>\n"
8125 "lr--------. 1 root root 64 Apr 16 21:31\n"
8126 " 3252e00000-3252e20000 -E<gt> /usr/lib64/ld-2.15.so\n"
8131 #: build/C/man5/proc.5:597
8133 "Although these entries are present for memory regions that were mapped with "
8134 "the B<MAP_FILE> flag, the way anonymous shared memory (regions created with "
8135 "the B<MAP_ANON | MAP_SHARED> flags) is implemented in Linux means that such "
8136 "regions also appear on this directory. Here is an example where the target "
8137 "file is the deleted I</dev/zero> one:"
8141 #: build/C/man5/proc.5:603
8144 "lrw-------. 1 root root 64 Apr 16 21:33\n"
8145 " 7fc075d2f000-7fc075e6f000 -E<gt> /dev/zero (deleted)\n"
8149 #: build/C/man5/proc.5:609
8151 "This directory appears only if the B<CONFIG_CHECKPOINT_RESTORE> kernel "
8152 "configuration option is enabled."
8156 #: build/C/man5/proc.5:609
8158 msgid "I</proc/[pid]/maps>"
8162 #: build/C/man5/proc.5:616
8164 "A file containing the currently mapped memory regions and their access "
8165 "permissions. See B<mmap>(2) for some further information about memory "
8170 #: build/C/man5/proc.5:618
8171 msgid "The format of the file is:"
8175 #: build/C/man5/proc.5:643
8178 "I<address perms offset dev inode pathname>\n"
8179 "00400000-00452000 r-xp 00000000 08:02 173521 /usr/bin/dbus-daemon\n"
8180 "00651000-00652000 r--p 00051000 08:02 173521 /usr/bin/dbus-daemon\n"
8181 "00652000-00655000 rw-p 00052000 08:02 173521 /usr/bin/dbus-daemon\n"
8182 "00e03000-00e24000 rw-p 00000000 00:00 0 [heap]\n"
8183 "00e24000-011f7000 rw-p 00000000 00:00 0 [heap]\n"
8185 "35b1800000-35b1820000 r-xp 00000000 08:02 135522 /usr/lib64/ld-2.15.so\n"
8186 "35b1a1f000-35b1a20000 r--p 0001f000 08:02 135522 /usr/lib64/ld-2.15.so\n"
8187 "35b1a20000-35b1a21000 rw-p 00020000 08:02 135522 /usr/lib64/ld-2.15.so\n"
8188 "35b1a21000-35b1a22000 rw-p 00000000 00:00 0\n"
8189 "35b1c00000-35b1dac000 r-xp 00000000 08:02 135870 /usr/lib64/libc-2.15.so\n"
8190 "35b1dac000-35b1fac000 ---p 001ac000 08:02 135870 /usr/lib64/libc-2.15.so\n"
8191 "35b1fac000-35b1fb0000 r--p 001ac000 08:02 135870 /usr/lib64/libc-2.15.so\n"
8192 "35b1fb0000-35b1fb2000 rw-p 001b0000 08:02 135870 /usr/lib64/libc-2.15.so\n"
8194 "f2c6ff8c000-7f2c7078c000 rw-p 00000000 00:00 0 [stack:986]\n"
8196 "7fffb2c0d000-7fffb2c2e000 rw-p 00000000 00:00 0 [stack]\n"
8197 "7fffb2d48000-7fffb2d49000 r-xp 00000000 00:00 0 [vdso]\n"
8201 #: build/C/man5/proc.5:652
8203 "The I<address> field is the address space in the process that the mapping "
8204 "occupies. The I<perms> field is a set of permissions:"
8208 #: build/C/man5/proc.5:660
8215 "p = private (copy on write)\n"
8219 #: build/C/man5/proc.5:673
8221 "The I<offset> field is the offset into the file/whatever; I<dev> is the "
8222 "device (major:minor); I<inode> is the inode on that device. 0 indicates "
8223 "that no inode is associated with the memory region, as would be the case "
8224 "with BSS (uninitialized data)."
8228 #: build/C/man5/proc.5:683
8230 "The I<pathname> field will usually be the file that is backing the mapping. "
8231 "For ELF files, you can easily coordinate with the I<offset> field by looking "
8232 "at the Offset field in the ELF program headers (I<readelf\\ -l>)."
8236 #: build/C/man5/proc.5:685
8237 msgid "There are additional helpful pseudo-paths:"
8241 #: build/C/man5/proc.5:686
8247 #: build/C/man5/proc.5:689
8248 msgid "The initial process's (also known as the main thread's) stack."
8252 #: build/C/man5/proc.5:689
8254 msgid "I<[stack:E<lt>tidE<gt>]> (since Linux 3.4)"
8257 #. commit b76437579d1344b612cf1851ae610c636cec7db0
8259 #: build/C/man5/proc.5:698
8261 "A thread's stack (where the I<E<lt>tidE<gt>> is a thread ID). It "
8262 "corresponds to the I</proc/[pid]/task/[tid]/> path."
8266 #: build/C/man5/proc.5:698
8272 #: build/C/man5/proc.5:701
8273 msgid "The virtual dynamically linked shared object."
8277 #: build/C/man5/proc.5:701
8283 #: build/C/man5/proc.5:704
8284 msgid "The process's heap."
8288 #: build/C/man5/proc.5:718
8290 "If the I<pathname> field is blank, this is an anonymous mapping as obtained "
8291 "via the B<mmap>(2) function. There is no easy way to coordinate this back "
8292 "to a process's source, short of running it through B<gdb>(1), B<strace>(1), "
8297 #: build/C/man5/proc.5:720
8298 msgid "Under Linux 2.0, there is no field giving pathname."
8302 #: build/C/man5/proc.5:720
8304 msgid "I</proc/[pid]/mem>"
8308 #: build/C/man5/proc.5:727
8310 "This file can be used to access the pages of a process's memory through "
8311 "B<open>(2), B<read>(2), and B<lseek>(2)."
8315 #: build/C/man5/proc.5:727
8317 msgid "I</proc/[pid]/mountinfo> (since Linux 2.6.26)"
8320 #. This info adapted from Documentation/filesystems/proc.txt
8322 #: build/C/man5/proc.5:732
8324 "This file contains information about mount points. It contains lines of the "
8329 #: build/C/man5/proc.5:737
8332 "CW<36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root "
8333 "rw,errors=continue\n"
8334 "(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)>\n"
8338 #: build/C/man5/proc.5:741
8339 msgid "The numbers in parentheses are labels for the descriptions below:"
8343 #: build/C/man5/proc.5:742 build/C/man5/proc.5:838 build/C/man5/proc.5:1843 build/C/man5/proc.5:2806
8349 #: build/C/man5/proc.5:746
8350 msgid "mount ID: unique identifier of the mount (may be reused after B<umount>(2))."
8354 #: build/C/man5/proc.5:746 build/C/man5/proc.5:842 build/C/man5/proc.5:1847 build/C/man5/proc.5:2817
8360 #: build/C/man5/proc.5:749
8361 msgid "parent ID: ID of parent mount (or of self for the top of the mount tree)."
8365 #: build/C/man5/proc.5:749 build/C/man5/proc.5:845 build/C/man5/proc.5:1882 build/C/man5/proc.5:2820
8371 #: build/C/man5/proc.5:755
8372 msgid "major:minor: value of I<st_dev> for files on filesystem (see B<stat>(2))."
8376 #: build/C/man5/proc.5:755 build/C/man5/proc.5:848 build/C/man5/proc.5:2824
8382 #: build/C/man5/proc.5:758
8383 msgid "root: root of the mount within the filesystem."
8387 #: build/C/man5/proc.5:758 build/C/man5/proc.5:2828
8393 #: build/C/man5/proc.5:761
8394 msgid "mount point: mount point relative to the process's root."
8398 #: build/C/man5/proc.5:761 build/C/man5/proc.5:2832
8404 #: build/C/man5/proc.5:764
8405 msgid "mount options: per-mount options."
8409 #: build/C/man5/proc.5:764 build/C/man5/proc.5:2837
8415 #: build/C/man5/proc.5:767
8416 msgid "optional fields: zero or more fields of the form \"tag[:value]\"."
8420 #: build/C/man5/proc.5:767 build/C/man5/proc.5:2842
8426 #: build/C/man5/proc.5:770
8427 msgid "separator: marks the end of the optional fields."
8431 #: build/C/man5/proc.5:770
8437 #: build/C/man5/proc.5:773
8438 msgid "filesystem type: name of filesystem in the form \"type[.subtype]\"."
8442 #: build/C/man5/proc.5:773
8448 #: build/C/man5/proc.5:776
8449 msgid "mount source: filesystem-specific information or \"none\"."
8453 #: build/C/man5/proc.5:776
8459 #: build/C/man5/proc.5:779
8460 msgid "super options: per-superblock options."
8464 #: build/C/man5/proc.5:783
8466 "Parsers should ignore all unrecognized optional fields. Currently the "
8467 "possible optional fields are:"
8471 #: build/C/man5/proc.5:784
8477 #: build/C/man5/proc.5:787
8478 msgid "mount is shared in peer group X"
8482 #: build/C/man5/proc.5:787
8488 #: build/C/man5/proc.5:790
8489 msgid "mount is slave to peer group X"
8493 #: build/C/man5/proc.5:790
8495 msgid "propagate_from:X"
8499 #: build/C/man5/proc.5:793
8500 msgid "mount is slave and receives propagation from peer group X (*)"
8504 #: build/C/man5/proc.5:793
8510 #: build/C/man5/proc.5:796
8511 msgid "mount is unbindable"
8515 #: build/C/man5/proc.5:803
8517 "(*) X is the closest dominant peer group under the process's root. If X is "
8518 "the immediate master of the mount, or if there is no dominant peer group "
8519 "under the same root, then only the \"master:X\" field is present and not the "
8520 "\"propagate_from:X\" field."
8524 #: build/C/man5/proc.5:807
8526 "For more information on mount propagation see: "
8527 "I<Documentation/filesystems/sharedsubtree.txt> in the Linux kernel source "
8532 #: build/C/man5/proc.5:807
8534 msgid "I</proc/[pid]/mounts> (since Linux 2.4.19)"
8538 #: build/C/man5/proc.5:825
8540 "This is a list of all the filesystems currently mounted in the process's "
8541 "mount namespace. The format of this file is documented in B<fstab>(5). "
8542 "Since kernel version 2.6.15, this file is pollable: after opening the file "
8543 "for reading, a change in this file (i.e., a filesystem mount or unmount) "
8544 "causes B<select>(2) to mark the file descriptor as readable, and B<poll>(2) "
8545 "and B<epoll_wait>(2) mark the file as having an error condition. See "
8546 "B<namespaces>(7) for more information."
8550 #: build/C/man5/proc.5:825
8552 msgid "I</proc/[pid]/mountstats> (since Linux 2.6.17)"
8556 #: build/C/man5/proc.5:830
8558 "This file exports information (statistics, configuration information) about "
8559 "the mount points in the process's mount namespace. Lines in this file have "
8564 #: build/C/man5/proc.5:834
8567 "device /dev/sda7 mounted on /home with fstype ext3 [statistics]\n"
8568 "( 1 ) ( 2 ) (3 ) (4)\n"
8572 #: build/C/man5/proc.5:837 build/C/man5/proc.5:2805
8573 msgid "The fields in each line are:"
8577 #: build/C/man5/proc.5:842
8579 "The name of the mounted device (or \"nodevice\" if there is no corresponding "
8584 #: build/C/man5/proc.5:845
8585 msgid "The mount point within the filesystem tree."
8589 #: build/C/man5/proc.5:848
8590 msgid "The filesystem type."
8594 #: build/C/man5/proc.5:853
8596 "Optional statistics and configuration information. Currently (as at Linux "
8597 "2.6.26), only NFS filesystems export information via this field."
8601 #: build/C/man5/proc.5:856
8602 msgid "This file is readable only by the owner of the process."
8606 #: build/C/man5/proc.5:860
8607 msgid "See B<namespaces>(7) for more information."
8611 #: build/C/man5/proc.5:860
8613 msgid "I</proc/[pid]/ns/> (since Linux 3.0)"
8616 #. See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f
8618 #: build/C/man5/proc.5:868
8620 "This is a subdirectory containing one entry for each namespace that supports "
8621 "being manipulated by B<setns>(2). For more information, see "
8626 #: build/C/man5/proc.5:869
8628 msgid "I</proc/[pid]/numa_maps> (since Linux 2.6.14)"
8632 #: build/C/man5/proc.5:873
8633 msgid "See B<numa>(7)."
8637 #: build/C/man5/proc.5:873
8639 msgid "I</proc/[pid]/oom_adj> (since Linux 2.6.11)"
8643 #: build/C/man5/proc.5:886
8645 "This file can be used to adjust the score used to select which process "
8646 "should be killed in an out-of-memory (OOM) situation. The kernel uses this "
8647 "value for a bit-shift operation of the process's I<oom_score> value: valid "
8648 "values are in the range -16 to +15, plus the special value -17, which "
8649 "disables OOM-killing altogether for this process. A positive score "
8650 "increases the likelihood of this process being killed by the OOM-killer; a "
8651 "negative score decreases the likelihood."
8655 #: build/C/man5/proc.5:894
8657 "The default value for this file is 0; a new process inherits its parent's "
8658 "I<oom_adj> setting. A process must be privileged (B<CAP_SYS_RESOURCE>) to "
8663 #: build/C/man5/proc.5:897
8665 "Since Linux 2.6.36, use of this file is deprecated in favor of "
8666 "I</proc/[pid]/oom_score_adj>."
8670 #: build/C/man5/proc.5:897
8672 msgid "I</proc/[pid]/oom_score> (since Linux 2.6.11)"
8675 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
8676 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
8678 #: build/C/man5/proc.5:908
8680 "This file displays the current score that the kernel gives to this process "
8681 "for the purpose of selecting a process for the OOM-killer. A higher score "
8682 "means that the process is more likely to be selected by the OOM-killer. The "
8683 "basis for this score is the amount of memory used by the process, with "
8684 "increases (+) or decreases (-) for factors including:"
8688 #: build/C/man5/proc.5:913
8689 msgid "whether the process creates a lot of children using B<fork>(2) (+);"
8693 #: build/C/man5/proc.5:916
8695 "whether the process has been running a long time, or has used a lot of CPU "
8700 #: build/C/man5/proc.5:918
8701 msgid "whether the process has a low nice value (i.e., E<gt> 0) (+);"
8704 #. More precisely, if it has CAP_SYS_ADMIN or CAP_SYS_RESOURCE
8706 #: build/C/man5/proc.5:921
8707 msgid "whether the process is privileged (-); and"
8710 #. More precisely, if it has CAP_SYS_RAWIO
8712 #: build/C/man5/proc.5:924
8713 msgid "whether the process is making direct hardware access (-)."
8717 #: build/C/man5/proc.5:933
8719 "The I<oom_score> also reflects the adjustment specified by the "
8720 "I<oom_score_adj> or I<oom_adj> setting for the process."
8724 #: build/C/man5/proc.5:933
8726 msgid "I</proc/[pid]/oom_score_adj> (since Linux 2.6.36)"
8729 #. Text taken from 3.7 Documentation/filesystems/proc.txt
8731 #: build/C/man5/proc.5:938
8733 "This file can be used to adjust the badness heuristic used to select which "
8734 "process gets killed in out-of-memory conditions."
8738 #: build/C/man5/proc.5:947
8740 "The badness heuristic assigns a value to each candidate task ranging from 0 "
8741 "(never kill) to 1000 (always kill) to determine which process is targeted. "
8742 "The units are roughly a proportion along that range of allowed memory the "
8743 "process may allocate from, based on an estimation of its current memory and "
8744 "swap use. For example, if a task is using all allowed memory, its badness "
8745 "score will be 1000. If it is using half of its allowed memory, its score "
8750 #: build/C/man5/proc.5:950
8752 "There is an additional factor included in the badness score: root processes "
8753 "are given 3% extra memory over other tasks."
8757 #: build/C/man5/proc.5:964
8759 "The amount of \"allowed\" memory depends on the context in which the "
8760 "OOM-killer was called. If it is due to the memory assigned to the "
8761 "allocating task's cpuset being exhausted, the allowed memory represents the "
8762 "set of mems assigned to that cpuset (see B<cpuset>(7)). If it is due to a "
8763 "mempolicy's node(s) being exhausted, the allowed memory represents the set "
8764 "of mempolicy nodes. If it is due to a memory limit (or swap limit) being "
8765 "reached, the allowed memory is that configured limit. Finally, if it is due "
8766 "to the entire system being out of memory, the allowed memory represents all "
8767 "allocatable resources."
8771 #: build/C/man5/proc.5:977
8773 "The value of I<oom_score_adj> is added to the badness score before it is "
8774 "used to determine which task to kill. Acceptable values range from -1000 "
8775 "(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). This allows user space to "
8776 "control the preference for OOM-killing, ranging from always preferring a "
8777 "certain task or completely disabling it from OOM killing. The lowest "
8778 "possible value, -1000, is equivalent to disabling OOM-killing entirely for "
8779 "that task, since it will always report a badness score of 0."
8783 #: build/C/man5/proc.5:989
8785 "Consequently, it is very simple for user space to define the amount of "
8786 "memory to consider for each task. Setting a I<oom_score_adj> value of +500, "
8787 "for example, is roughly equivalent to allowing the remainder of tasks "
8788 "sharing the same system, cpuset, mempolicy, or memory controller resources "
8789 "to use at least 50% more memory. A value of -500, on the other hand, would "
8790 "be roughly equivalent to discounting 50% of the task's allowed memory from "
8791 "being considered as scoring against the task."
8795 #: build/C/man5/proc.5:996
8797 "For backward compatibility with previous kernels, I</proc/[pid]/oom_adj> can "
8798 "still be used to tune the badness score. Its value is scaled linearly with "
8803 #: build/C/man5/proc.5:1002
8805 "Writing to I</proc/[pid]/oom_score_adj> or I</proc/[pid]/oom_adj> will "
8806 "change the other with its scaled value."
8810 #: build/C/man5/proc.5:1002
8812 msgid "I</proc/[pid]/pagemap> (since Linux 2.6.25)"
8816 #: build/C/man5/proc.5:1008
8818 "This file shows the mapping of each of the process's virtual pages into "
8819 "physical page frames or swap area. It contains one 64-bit value for each "
8820 "virtual page, with the bits set as follows:"
8824 #: build/C/man5/proc.5:1009
8830 #: build/C/man5/proc.5:1012
8831 msgid "If set, the page is present in RAM."
8835 #: build/C/man5/proc.5:1012
8841 #: build/C/man5/proc.5:1015
8842 msgid "If set, the page is in swap space"
8846 #: build/C/man5/proc.5:1015
8848 msgid "61 (since Linux 3.5)"
8852 #: build/C/man5/proc.5:1018
8853 msgid "The page is a file-mapped page or a shared anonymous page."
8857 #: build/C/man5/proc.5:1018
8859 msgid "60-56 (since Linux 3.11)"
8862 #. Not quite true; see commit 541c237c0923f567c9c4cabb8a81635baadc713f
8864 #: build/C/man5/proc.5:1022
8869 #: build/C/man5/proc.5:1022
8871 msgid "55 (Since Linux 3.11)"
8875 #: build/C/man5/proc.5:1027
8877 "PTE is soft-dirty (see the kernel source file "
8878 "I<Documentation/vm/soft-dirty.txt>)."
8882 #: build/C/man5/proc.5:1027
8888 #: build/C/man5/proc.5:1036
8890 "If the page is present in RAM (bit 63), then these bits provide the page "
8891 "frame number, which can be used to index I</proc/kpageflags> and "
8892 "I</proc/kpagecount>. If the page is present in swap (bit 62), then bits 4-0 "
8893 "give the swap type, and bits 54-5 encode the swap offset."
8897 #: build/C/man5/proc.5:1040
8899 "Before Linux 3.11, bits 60-55 were used to encode the base-2 log of the page "
8904 #: build/C/man5/proc.5:1047
8906 "To employ I</proc/[pid]/pagemap> efficiently, use I</proc/[pid]/maps> to "
8907 "determine which areas of memory are actually mapped and seek to skip over "
8912 #: build/C/man5/proc.5:1053
8914 "The I</proc/[pid]/pagemap> file is present only if the "
8915 "B<CONFIG_PROC_PAGE_MONITOR> kernel configuration option is enabled."
8919 #: build/C/man5/proc.5:1053
8921 msgid "I</proc/[pid]/personality> (since Linux 2.6.28)"
8924 #. commit 478307230810d7e2a753ed220db9066dfdf88718
8926 #: build/C/man5/proc.5:1059
8928 "This read-only file exposes the process's execution domain, as set by "
8929 "B<personality>(2). The value is displayed in hexadecimal notation."
8933 #: build/C/man5/proc.5:1059
8935 msgid "I</proc/[pid]/root>"
8939 #: build/C/man5/proc.5:1070
8941 "UNIX and Linux support the idea of a per-process root of the filesystem, set "
8942 "by the B<chroot>(2) system call. This file is a symbolic link that points "
8943 "to the process's root directory, and behaves in the same way as I<exe>, and "
8948 #: build/C/man5/proc.5:1099
8950 msgid "I</proc/[pid]/smaps> (since Linux 2.6.14)"
8954 #: build/C/man5/proc.5:1107
8956 "This file shows memory consumption for each of the process's mappings. (The "
8957 "B<pmap>(1) command displays similar information, in a form that may be "
8958 "easier for parsing.) For each mapping there is a series of lines such as "
8963 #: build/C/man5/proc.5:1125
8966 "00400000-0048a000 r-xp 00000000 fd:03 960637 /bin/bash\n"
8970 "Shared_Clean: 452 kB\n"
8971 "Shared_Dirty: 0 kB\n"
8972 "Private_Clean: 8 kB\n"
8973 "Private_Dirty: 0 kB\n"
8974 "Referenced: 460 kB\n"
8976 "AnonHugePages: 0 kB\n"
8978 "KernelPageSize: 4 kB\n"
8979 "MMUPageSize: 4 kB\n"
8984 #: build/C/man5/proc.5:1142
8986 "The first of these lines shows the same information as is displayed for the "
8987 "mapping in I</proc/[pid]/maps>. The remaining lines show the size of the "
8988 "mapping, the amount of the mapping that is currently resident in RAM "
8989 "(\"Rss\"), the process' proportional share of this mapping (\"Pss\"), the "
8990 "number of clean and dirty shared pages in the mapping, and the number of "
8991 "clean and dirty private pages in the mapping. \"Referenced\" indicates the "
8992 "amount of memory currently marked as referenced or accessed. \"Anonymous\" "
8993 "shows the amount of memory that does not belong to any file. \"Swap\" shows "
8994 "how much would-be-anonymous memory is also used, but out on swap."
8998 #: build/C/man5/proc.5:1150
9000 "The \"KernelPageSize\" entry is the page size used by the kernel to back a "
9001 "VMA. This matches the size used by the MMU in the majority of cases. "
9002 "However, one counter-example occurs on PPC64 kernels whereby a kernel using "
9003 "64K as a base page size may still use 4K pages for the MMU on older "
9004 "processors. To distinguish, this patch reports \"MMUPageSize\" as the page "
9005 "size used by the MMU."
9009 #: build/C/man5/proc.5:1153
9010 msgid "The \"Locked\" indicates whether the mapping is locked in memory or not."
9014 #: build/C/man5/proc.5:1157
9016 "\"VmFlags\" field represents the kernel flags associated with the particular "
9017 "virtual memory area in two letter encoded manner. The codes are the "
9022 #: build/C/man5/proc.5:1186
9027 " ex - executable\n"
9031 " me - may execute\n"
9033 " gd - stack segment grows down\n"
9034 " pf - pure PFN range\n"
9035 " dw - disabled write to the mapped file\n"
9036 " lo - pages are locked in memory\n"
9037 " io - memory mapped I/O area\n"
9038 " sr - sequential read advise provided\n"
9039 " rr - random read advise provided\n"
9040 " dc - do not copy area on fork\n"
9041 " de - do not expand area on remapping\n"
9042 " ac - area is accountable\n"
9043 " nr - swap space is not reserved for the area\n"
9044 " ht - area uses huge tlb pages\n"
9045 " nl - non-linear mapping\n"
9046 " ar - architecture specific flag\n"
9047 " dd - do not include area into core dump\n"
9048 " sd - soft-dirty flag\n"
9049 " mm - mixed map area\n"
9050 " hg - huge page advise flag\n"
9051 " nh - no-huge page advise flag\n"
9052 " mg - mergeable advise flag\n"
9056 #: build/C/man5/proc.5:1192
9058 "The I</proc/[pid]/smaps> file is present only if the "
9059 "B<CONFIG_PROC_PAGE_MONITOR> kernel configuration option is enabled."
9063 #: build/C/man5/proc.5:1192
9065 msgid "I</proc/[pid]/stack> (since Linux 2.6.29)"
9068 #. 2ec220e27f5040aec1e88901c1b6ea3d135787ad
9070 #: build/C/man5/proc.5:1200
9072 "This file provides a symbolic trace of the function calls in this process's "
9073 "kernel stack. This file is provided only if the kernel was built with the "
9074 "B<CONFIG_STACKTRACE> configuration option."
9078 #: build/C/man5/proc.5:1200
9080 msgid "I</proc/[pid]/stat>"
9084 #: build/C/man5/proc.5:1207
9086 "Status information about the process. This is used by B<ps>(1). It is "
9087 "defined in the kernel source file I<fs/proc/array.c>."
9091 #: build/C/man5/proc.5:1211
9092 msgid "The fields, in order, with their proper B<scanf>(3) format specifiers, are:"
9096 #: build/C/man5/proc.5:1212
9098 msgid "(1) I<pid> \\ %d"
9102 #: build/C/man5/proc.5:1216
9103 msgid "The process ID."
9107 #: build/C/man5/proc.5:1216
9109 msgid "(2) I<comm> \\ %s"
9113 #: build/C/man5/proc.5:1220
9115 "The filename of the executable, in parentheses. This is visible whether or "
9116 "not the executable is swapped out."
9120 #: build/C/man5/proc.5:1220
9122 msgid "(3) I<state> \\ %c"
9126 #: build/C/man5/proc.5:1223
9127 msgid "One of the following characters, indicating process state:"
9131 #: build/C/man5/proc.5:1224
9137 #: build/C/man5/proc.5:1226
9142 #: build/C/man5/proc.5:1226
9148 #: build/C/man5/proc.5:1228
9149 msgid "Sleeping in an interruptible wait"
9153 #: build/C/man5/proc.5:1228
9159 #: build/C/man5/proc.5:1231
9160 msgid "Waiting in uninterruptible disk sleep"
9164 #: build/C/man5/proc.5:1231
9170 #: build/C/man5/proc.5:1233
9175 #: build/C/man5/proc.5:1233
9181 #: build/C/man5/proc.5:1235
9182 msgid "Stopped (on a signal) or (before Linux 2.6.33) trace stopped"
9186 #: build/C/man5/proc.5:1235
9191 #. commit 44d90df6b757c59651ddd55f1a84f28132b50d29
9193 #: build/C/man5/proc.5:1238
9194 msgid "Tracing stop (Linux 2.6.33 onward)"
9198 #: build/C/man5/proc.5:1238 build/C/man5/proc.5:1252
9204 #: build/C/man5/proc.5:1240
9205 msgid "Paging (only before Linux 2.6.0)"
9209 #: build/C/man5/proc.5:1240
9215 #: build/C/man5/proc.5:1242
9216 msgid "Dead (from Linux 2.6.0 onward)"
9220 #: build/C/man5/proc.5:1242
9225 #. commit 44d90df6b757c59651ddd55f1a84f28132b50d29
9226 #. commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
9228 #: build/C/man5/proc.5:1247
9229 msgid "Dead (Linux 2.6.33 to 3.13 only)"
9233 #: build/C/man5/proc.5:1247
9238 #. commit 44d90df6b757c59651ddd55f1a84f28132b50d29
9239 #. commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
9241 #: build/C/man5/proc.5:1252
9242 msgid "Wakekill (Linux 2.6.33 to 3.13 only)"
9245 #. commit 44d90df6b757c59651ddd55f1a84f28132b50d29
9246 #. commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
9248 #: build/C/man5/proc.5:1257
9249 msgid "Waking (Linux 2.6.33 to 3.13 only)"
9253 #: build/C/man5/proc.5:1257
9258 #. commit f2530dc71cf0822f90bb63ea4600caaef33a66bb
9259 #. commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
9261 #: build/C/man5/proc.5:1262
9262 msgid "Parked (Linux 3.9 to 3.13 only)"
9266 #: build/C/man5/proc.5:1263
9268 msgid "(4) I<ppid> \\ %d"
9272 #: build/C/man5/proc.5:1266
9273 msgid "The PID of the parent of this process."
9277 #: build/C/man5/proc.5:1266
9279 msgid "(5) I<pgrp> \\ %d"
9283 #: build/C/man5/proc.5:1269
9284 msgid "The process group ID of the process."
9288 #: build/C/man5/proc.5:1269
9290 msgid "(6) I<session> \\ %d"
9294 #: build/C/man5/proc.5:1272
9295 msgid "The session ID of the process."
9299 #: build/C/man5/proc.5:1272
9301 msgid "(7) I<tty_nr> \\ %d"
9305 #: build/C/man5/proc.5:1278
9307 "The controlling terminal of the process. (The minor device number is "
9308 "contained in the combination of bits 31 to 20 and 7 to 0; the major device "
9309 "number is in bits 15 to 8.)"
9313 #: build/C/man5/proc.5:1278
9315 msgid "(8) I<tpgid> \\ %d"
9318 #. This field and following, up to and including wchan added 0.99.1
9320 #: build/C/man5/proc.5:1283
9322 "The ID of the foreground process group of the controlling terminal of the "
9327 #: build/C/man5/proc.5:1283
9329 msgid "(9) I<flags> \\ %u"
9333 #: build/C/man5/proc.5:1290
9335 "The kernel flags word of the process. For bit meanings, see the PF_* "
9336 "defines in the Linux kernel source file I<include/linux/sched.h>. Details "
9337 "depend on the kernel version."
9341 #: build/C/man5/proc.5:1292 build/C/man5/proc.5:1394
9342 msgid "The format for this field was %lu before Linux 2.6."
9346 #: build/C/man5/proc.5:1292
9348 msgid "(10) I<minflt> \\ %lu"
9352 #: build/C/man5/proc.5:1296
9354 "The number of minor faults the process has made which have not required "
9355 "loading a memory page from disk."
9359 #: build/C/man5/proc.5:1296
9361 msgid "(11) I<cminflt> \\ %lu"
9365 #: build/C/man5/proc.5:1300
9366 msgid "The number of minor faults that the process's waited-for children have made."
9370 #: build/C/man5/proc.5:1300
9372 msgid "(12) I<majflt> \\ %lu"
9376 #: build/C/man5/proc.5:1304
9378 "The number of major faults the process has made which have required loading "
9379 "a memory page from disk."
9383 #: build/C/man5/proc.5:1304
9385 msgid "(13) I<cmajflt> \\ %lu"
9389 #: build/C/man5/proc.5:1308
9390 msgid "The number of major faults that the process's waited-for children have made."
9394 #: build/C/man5/proc.5:1308
9396 msgid "(14) I<utime> \\ %lu"
9400 #: build/C/man5/proc.5:1317
9402 "Amount of time that this process has been scheduled in user mode, measured "
9403 "in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>). This includes guest "
9404 "time, I<guest_time> (time spent running a virtual CPU, see below), so that "
9405 "applications that are not aware of the guest time field do not lose that "
9406 "time from their calculations."
9410 #: build/C/man5/proc.5:1317
9412 msgid "(15) I<stime> \\ %lu"
9416 #: build/C/man5/proc.5:1322
9418 "Amount of time that this process has been scheduled in kernel mode, measured "
9419 "in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
9423 #: build/C/man5/proc.5:1322
9425 msgid "(16) I<cutime> \\ %ld"
9429 #: build/C/man5/proc.5:1332
9431 "Amount of time that this process's waited-for children have been scheduled "
9432 "in user mode, measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>). "
9433 "(See also B<times>(2).) This includes guest time, I<cguest_time> (time "
9434 "spent running a virtual CPU, see below)."
9438 #: build/C/man5/proc.5:1332
9440 msgid "(17) I<cstime> \\ %ld"
9444 #: build/C/man5/proc.5:1338
9446 "Amount of time that this process's waited-for children have been scheduled "
9447 "in kernel mode, measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
9451 #: build/C/man5/proc.5:1338
9453 msgid "(18) I<priority> \\ %ld"
9457 #: build/C/man5/proc.5:1355
9459 "(Explanation for Linux 2.6) For processes running a real-time scheduling "
9460 "policy (I<policy> below; see B<sched_setscheduler>(2)), this is the negated "
9461 "scheduling priority, minus one; that is, a number in the range -2 to -100, "
9462 "corresponding to real-time priorities 1 to 99. For processes running under "
9463 "a non-real-time scheduling policy, this is the raw nice value "
9464 "(B<setpriority>(2)) as represented in the kernel. The kernel stores nice "
9465 "values as numbers in the range 0 (high) to 39 (low), corresponding to the "
9466 "user-visible nice range of -20 to 19."
9469 #. And back in kernel 1.2 days things were different again.
9471 #: build/C/man5/proc.5:1359
9473 "Before Linux 2.6, this was a scaled value based on the scheduler weighting "
9474 "given to this process."
9478 #: build/C/man5/proc.5:1359
9480 msgid "(19) I<nice> \\ %ld"
9483 #. Back in kernel 1.2 days things were different.
9485 #. \fIcounter\fP %ld
9486 #. The current maximum size in jiffies of the process's next timeslice,
9487 #. or what is currently left of its current timeslice, if it is the
9488 #. currently running process.
9491 #. The time in jiffies of the process's next timeout.
9492 #. timeout was removed sometime around 2.1/2.2
9494 #: build/C/man5/proc.5:1374
9496 "The nice value (see B<setpriority>(2)), a value in the range 19 (low "
9497 "priority) to -20 (high priority)."
9501 #: build/C/man5/proc.5:1374
9503 msgid "(20) I<num_threads> \\ %ld"
9507 #: build/C/man5/proc.5:1379
9509 "Number of threads in this process (since Linux 2.6). Before kernel 2.6, "
9510 "this field was hard coded to 0 as a placeholder for an earlier removed "
9515 #: build/C/man5/proc.5:1379
9517 msgid "(21) I<itrealvalue> \\ %ld"
9521 #: build/C/man5/proc.5:1386
9523 "The time in jiffies before the next B<SIGALRM> is sent to the process due to "
9524 "an interval timer. Since kernel 2.6.17, this field is no longer maintained, "
9525 "and is hard coded as 0."
9529 #: build/C/man5/proc.5:1386
9531 msgid "(22) I<starttime> \\ %llu"
9535 #: build/C/man5/proc.5:1392
9537 "The time the process started after system boot. In kernels before Linux "
9538 "2.6, this value was expressed in jiffies. Since Linux 2.6, the value is "
9539 "expressed in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
9543 #: build/C/man5/proc.5:1394
9545 msgid "(23) I<vsize> \\ %lu"
9549 #: build/C/man5/proc.5:1397
9550 msgid "Virtual memory size in bytes."
9554 #: build/C/man5/proc.5:1397
9556 msgid "(24) I<rss> \\ %ld"
9560 #: build/C/man5/proc.5:1404
9562 "Resident Set Size: number of pages the process has in real memory. This is "
9563 "just the pages which count toward text, data, or stack space. This does not "
9564 "include pages which have not been demand-loaded in, or which are swapped "
9569 #: build/C/man5/proc.5:1404
9571 msgid "(25) I<rsslim> \\ %lu"
9575 #: build/C/man5/proc.5:1411
9577 "Current soft limit in bytes on the rss of the process; see the description "
9578 "of B<RLIMIT_RSS> in B<getrlimit>(2)."
9582 #: build/C/man5/proc.5:1411
9584 msgid "(26) I<startcode> \\ %lu"
9588 #: build/C/man5/proc.5:1414
9589 msgid "The address above which program text can run."
9593 #: build/C/man5/proc.5:1414
9595 msgid "(27) I<endcode> \\ %lu"
9599 #: build/C/man5/proc.5:1417
9600 msgid "The address below which program text can run."
9604 #: build/C/man5/proc.5:1417
9606 msgid "(28) I<startstack> \\ %lu"
9610 #: build/C/man5/proc.5:1420
9611 msgid "The address of the start (i.e., bottom) of the stack."
9615 #: build/C/man5/proc.5:1420
9617 msgid "(29) I<kstkesp> \\ %lu"
9621 #: build/C/man5/proc.5:1424
9623 "The current value of ESP (stack pointer), as found in the kernel stack page "
9628 #: build/C/man5/proc.5:1424
9630 msgid "(30) I<kstkeip> \\ %lu"
9634 #: build/C/man5/proc.5:1427
9635 msgid "The current EIP (instruction pointer)."
9639 #: build/C/man5/proc.5:1427
9641 msgid "(31) I<signal> \\ %lu"
9645 #: build/C/man5/proc.5:1433
9647 "The bitmap of pending signals, displayed as a decimal number. Obsolete, "
9648 "because it does not provide information on real-time signals; use "
9649 "I</proc/[pid]/status> instead."
9653 #: build/C/man5/proc.5:1433
9655 msgid "(32) I<blocked> \\ %lu"
9659 #: build/C/man5/proc.5:1439
9661 "The bitmap of blocked signals, displayed as a decimal number. Obsolete, "
9662 "because it does not provide information on real-time signals; use "
9663 "I</proc/[pid]/status> instead."
9667 #: build/C/man5/proc.5:1439
9669 msgid "(33) I<sigignore> \\ %lu"
9673 #: build/C/man5/proc.5:1445
9675 "The bitmap of ignored signals, displayed as a decimal number. Obsolete, "
9676 "because it does not provide information on real-time signals; use "
9677 "I</proc/[pid]/status> instead."
9681 #: build/C/man5/proc.5:1445
9683 msgid "(34) I<sigcatch> \\ %lu"
9687 #: build/C/man5/proc.5:1451
9689 "The bitmap of caught signals, displayed as a decimal number. Obsolete, "
9690 "because it does not provide information on real-time signals; use "
9691 "I</proc/[pid]/status> instead."
9695 #: build/C/man5/proc.5:1451
9697 msgid "(35) I<wchan> \\ %lu"
9701 #: build/C/man5/proc.5:1457
9703 "This is the \"channel\" in which the process is waiting. It is the address "
9704 "of a location in the kernel where the process is sleeping. The "
9705 "corresponding symbolic name can be found in I</proc/[pid]/wchan>."
9709 #: build/C/man5/proc.5:1457
9711 msgid "(36) I<nswap> \\ %lu"
9714 #. nswap was added in 2.0
9716 #: build/C/man5/proc.5:1461
9717 msgid "Number of pages swapped (not maintained)."
9721 #: build/C/man5/proc.5:1461
9723 msgid "(37) I<cnswap> \\ %lu"
9726 #. cnswap was added in 2.0
9728 #: build/C/man5/proc.5:1465
9729 msgid "Cumulative I<nswap> for child processes (not maintained)."
9733 #: build/C/man5/proc.5:1465
9735 msgid "(38) I<exit_signal> \\ %d \\ (since Linux 2.1.22)"
9739 #: build/C/man5/proc.5:1468
9740 msgid "Signal to be sent to parent when we die."
9744 #: build/C/man5/proc.5:1468
9746 msgid "(39) I<processor> \\ %d \\ (since Linux 2.2.8)"
9750 #: build/C/man5/proc.5:1471
9751 msgid "CPU number last executed on."
9755 #: build/C/man5/proc.5:1471
9757 msgid "(40) I<rt_priority> \\ %u \\ (since Linux 2.5.19)"
9761 #: build/C/man5/proc.5:1477
9763 "Real-time scheduling priority, a number in the range 1 to 99 for processes "
9764 "scheduled under a real-time policy, or 0, for non-real-time processes (see "
9765 "B<sched_setscheduler>(2))."
9769 #: build/C/man5/proc.5:1477
9771 msgid "(41) I<policy> \\ %u \\ (since Linux 2.5.19)"
9775 #: build/C/man5/proc.5:1483
9777 "Scheduling policy (see B<sched_setscheduler>(2)). Decode using the SCHED_* "
9778 "constants in I<linux/sched.h>."
9782 #: build/C/man5/proc.5:1485
9783 msgid "The format for this field was %lu before Linux 2.6.22."
9787 #: build/C/man5/proc.5:1485
9789 msgid "(42) I<delayacct_blkio_ticks> \\ %llu \\ (since Linux 2.6.18)"
9793 #: build/C/man5/proc.5:1488
9794 msgid "Aggregated block I/O delays, measured in clock ticks (centiseconds)."
9798 #: build/C/man5/proc.5:1488
9800 msgid "(43) I<guest_time> \\ %lu \\ (since Linux 2.6.24)"
9804 #: build/C/man5/proc.5:1493
9806 "Guest time of the process (time spent running a virtual CPU for a guest "
9807 "operating system), measured in clock ticks (divide by "
9808 "I<sysconf(_SC_CLK_TCK)>)."
9812 #: build/C/man5/proc.5:1493
9814 msgid "(44) I<cguest_time> \\ %ld \\ (since Linux 2.6.24)"
9818 #: build/C/man5/proc.5:1497
9820 "Guest time of the process's children, measured in clock ticks (divide by "
9821 "I<sysconf(_SC_CLK_TCK)>)."
9825 #: build/C/man5/proc.5:1497
9827 msgid "(45) I<start_data> \\ %lu \\ (since Linux 3.3)"
9830 #. commit b3f7f573a20081910e34e99cbc91831f4f02f1ff
9832 #: build/C/man5/proc.5:1502
9834 "Address above which program initialized and uninitialized (BSS) data are "
9839 #: build/C/man5/proc.5:1502
9841 msgid "(46) I<end_data> \\ %lu \\ (since Linux 3.3)"
9844 #. commit b3f7f573a20081910e34e99cbc91831f4f02f1ff
9846 #: build/C/man5/proc.5:1507
9848 "Address below which program initialized and uninitialized (BSS) data are "
9853 #: build/C/man5/proc.5:1507
9855 msgid "(47) I<start_brk> \\ %lu \\ (since Linux 3.3)"
9858 #. commit b3f7f573a20081910e34e99cbc91831f4f02f1ff
9860 #: build/C/man5/proc.5:1512
9861 msgid "Address above which program heap can be expanded with B<brk>(2)."
9865 #: build/C/man5/proc.5:1512
9867 msgid "(48) I<arg_start> \\ %lu \\ (since Linux 3.5)"
9870 #. commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3
9872 #: build/C/man5/proc.5:1518
9873 msgid "Address above which program command-line arguments (I<argv>) are placed."
9877 #: build/C/man5/proc.5:1518
9879 msgid "(49) I<arg_end> \\ %lu \\ (since Linux 3.5)"
9882 #. commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3
9884 #: build/C/man5/proc.5:1524
9885 msgid "Address below program command-line arguments (I<argv>) are placed."
9889 #: build/C/man5/proc.5:1524
9891 msgid "(50) I<env_start> \\ %lu \\ (since Linux 3.5)"
9894 #. commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3
9896 #: build/C/man5/proc.5:1528
9897 msgid "Address above which program environment is placed."
9901 #: build/C/man5/proc.5:1528
9903 msgid "(51) I<env_end> \\ %lu \\ (since Linux 3.5)"
9906 #. commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3
9908 #: build/C/man5/proc.5:1532
9909 msgid "Address below which program environment is placed."
9913 #: build/C/man5/proc.5:1532
9915 msgid "(52) I<exit_code> \\ %d \\ (since Linux 3.5)"
9918 #. commit 5b172087f99189416d5f47fd7ab5e6fb762a9ba3
9920 #: build/C/man5/proc.5:1537
9921 msgid "The thread's exit status in the form reported by B<waitpid>(2)."
9925 #: build/C/man5/proc.5:1538
9927 msgid "I</proc/[pid]/statm>"
9931 #: build/C/man5/proc.5:1542
9933 "Provides information about memory usage, measured in pages. The columns "
9937 #. (not including libs; broken, includes data segment)
9938 #. (including libs; broken, includes library text)
9940 #: build/C/man5/proc.5:1556
9943 "size (1) total program size\n"
9944 " (same as VmSize in I</proc/[pid]/status>)\n"
9945 "resident (2) resident set size\n"
9946 " (same as VmRSS in I</proc/[pid]/status>)\n"
9947 "share (3) shared pages (i.e., backed by a file)\n"
9948 "text (4) text (code)\n"
9949 "lib (5) library (unused in Linux 2.6)\n"
9950 "data (6) data + stack\n"
9951 "dt (7) dirty pages (unused in Linux 2.6)\n"
9955 #: build/C/man5/proc.5:1558
9957 msgid "I</proc/[pid]/status>"
9961 #: build/C/man5/proc.5:1566
9963 "Provides much of the information in I</proc/[pid]/stat> and "
9964 "I</proc/[pid]/statm> in a format that's easier for humans to parse. Here's "
9969 #: build/C/man5/proc.5:1609
9972 "$B< cat /proc/$$/status>\n"
9974 "State: S (sleeping)\n"
9979 "Uid: 1000 1000 1000 1000\n"
9980 "Gid: 100 100 100 100\n"
9982 "Groups: 16 33 100\n"
9996 "SigPnd: 0000000000000000\n"
9997 "ShdPnd: 0000000000000000\n"
9998 "SigBlk: 0000000000010000\n"
9999 "SigIgn: 0000000000384004\n"
10000 "SigCgt: 000000004b813efb\n"
10001 "CapInh: 0000000000000000\n"
10002 "CapPrm: 0000000000000000\n"
10003 "CapEff: 0000000000000000\n"
10004 "CapBnd: ffffffffffffffff\n"
10006 "Cpus_allowed: 00000001\n"
10007 "Cpus_allowed_list: 0\n"
10008 "Mems_allowed: 1\n"
10009 "Mems_allowed_list: 0\n"
10010 "voluntary_ctxt_switches: 150\n"
10011 "nonvoluntary_ctxt_switches: 545\n"
10014 #. type: Plain text
10015 #: build/C/man5/proc.5:1617
10016 msgid "I<Name>: Command run by this process."
10019 #. type: Plain text
10020 #: build/C/man5/proc.5:1629
10022 "I<State>: Current state of the process. One of \"R (running)\", \"S "
10023 "(sleeping)\", \"D (disk sleep)\", \"T (stopped)\", \"T (tracing stop)\", \"Z "
10024 "(zombie)\", or \"X (dead)\"."
10027 #. type: Plain text
10028 #: build/C/man5/proc.5:1632
10029 msgid "I<Tgid>: Thread group ID (i.e., Process ID)."
10032 #. type: Plain text
10033 #: build/C/man5/proc.5:1636
10034 msgid "I<Pid>: Thread ID (see B<gettid>(2))."
10037 #. type: Plain text
10038 #: build/C/man5/proc.5:1639
10039 msgid "I<PPid>: PID of parent process."
10042 #. type: Plain text
10043 #: build/C/man5/proc.5:1642
10044 msgid "I<TracerPid>: PID of process tracing this process (0 if not being traced)."
10047 #. type: Plain text
10048 #: build/C/man5/proc.5:1645
10049 msgid "I<Uid>, I<Gid>: Real, effective, saved set, and filesystem UIDs (GIDs)."
10052 #. type: Plain text
10053 #: build/C/man5/proc.5:1648
10054 msgid "I<FDSize>: Number of file descriptor slots currently allocated."
10057 #. type: Plain text
10058 #: build/C/man5/proc.5:1651
10059 msgid "I<Groups>: Supplementary group list."
10062 #. type: Plain text
10063 #: build/C/man5/proc.5:1654
10064 msgid "I<VmPeak>: Peak virtual memory size."
10067 #. type: Plain text
10068 #: build/C/man5/proc.5:1657
10069 msgid "I<VmSize>: Virtual memory size."
10072 #. type: Plain text
10073 #: build/C/man5/proc.5:1661
10074 msgid "I<VmLck>: Locked memory size (see B<mlock>(3))."
10077 #. type: Plain text
10078 #: build/C/man5/proc.5:1664
10079 msgid "I<VmHWM>: Peak resident set size (\"high water mark\")."
10082 #. type: Plain text
10083 #: build/C/man5/proc.5:1667
10084 msgid "I<VmRSS>: Resident set size."
10087 #. type: Plain text
10088 #: build/C/man5/proc.5:1670
10089 msgid "I<VmData>, I<VmStk>, I<VmExe>: Size of data, stack, and text segments."
10092 #. type: Plain text
10093 #: build/C/man5/proc.5:1673
10094 msgid "I<VmLib>: Shared library code size."
10097 #. type: Plain text
10098 #: build/C/man5/proc.5:1676
10099 msgid "I<VmPTE>: Page table entries size (since Linux 2.6.10)."
10102 #. commit b084d4353ff99d824d3bc5a5c2c22c70b1fba722
10103 #. type: Plain text
10104 #: build/C/man5/proc.5:1680
10105 msgid "I<VmSwap>: Swapped-out virtual memory size (since Linux 2.6.34)."
10108 #. type: Plain text
10109 #: build/C/man5/proc.5:1683
10110 msgid "I<Threads>: Number of threads in process containing this thread."
10113 #. type: Plain text
10114 #: build/C/man5/proc.5:1694
10116 "I<SigQ>: This field contains two slash-separated numbers that relate to "
10117 "queued signals for the real user ID of this process. The first of these is "
10118 "the number of currently queued signals for this real user ID, and the second "
10119 "is the resource limit on the number of queued signals for this process (see "
10120 "the description of B<RLIMIT_SIGPENDING> in B<getrlimit>(2))."
10123 #. type: Plain text
10124 #: build/C/man5/proc.5:1700
10126 "I<SigPnd>, I<ShdPnd>: Number of signals pending for thread and for process "
10127 "as a whole (see B<pthreads>(7) and B<signal>(7))."
10130 #. type: Plain text
10131 #: build/C/man5/proc.5:1704
10133 "I<SigBlk>, I<SigIgn>, I<SigCgt>: Masks indicating signals being blocked, "
10134 "ignored, and caught (see B<signal>(7))."
10137 #. type: Plain text
10138 #: build/C/man5/proc.5:1709
10140 "I<CapInh>, I<CapPrm>, I<CapEff>: Masks of capabilities enabled in "
10141 "inheritable, permitted, and effective sets (see B<capabilities>(7))."
10144 #. type: Plain text
10145 #: build/C/man5/proc.5:1714
10147 "I<CapBnd>: Capability Bounding set (since Linux 2.6.26, see "
10148 "B<capabilities>(7))."
10151 #. commit 2f4b3bf6b2318cfaa177ec5a802f4d8d6afbd816
10152 #. type: Plain text
10153 #: build/C/man5/proc.5:1729
10155 "I<Seccomp>: Seccomp mode of the process (since Linux 3.8, see "
10156 "B<seccomp>(2)). 0 means B<SECCOMP_MODE_DISABLED>; 1 means "
10157 "B<SECCOMP_MODE_STRICT>; 2 means B<SECCOMP_MODE_FILTER>. This field is "
10158 "provided only if the kernel was built with the B<CONFIG_SECCOMP> kernel "
10159 "configuration option enabled."
10162 #. type: Plain text
10163 #: build/C/man5/proc.5:1734
10165 "I<Cpus_allowed>: Mask of CPUs on which this process may run (since Linux "
10166 "2.6.24, see B<cpuset>(7))."
10169 #. type: Plain text
10170 #: build/C/man5/proc.5:1739
10172 "I<Cpus_allowed_list>: Same as previous, but in \"list format\" (since Linux "
10173 "2.6.26, see B<cpuset>(7))."
10176 #. type: Plain text
10177 #: build/C/man5/proc.5:1744
10179 "I<Mems_allowed>: Mask of memory nodes allowed to this process (since Linux "
10180 "2.6.24, see B<cpuset>(7))."
10183 #. type: Plain text
10184 #: build/C/man5/proc.5:1749
10186 "I<Mems_allowed_list>: Same as previous, but in \"list format\" (since Linux "
10187 "2.6.26, see B<cpuset>(7))."
10190 #. type: Plain text
10191 #: build/C/man5/proc.5:1752
10193 "I<voluntary_ctxt_switches>, I<nonvoluntary_ctxt_switches>: Number of "
10194 "voluntary and involuntary context switches (since Linux 2.6.23)."
10198 #: build/C/man5/proc.5:1753
10200 msgid "I</proc/[pid]/syscall> (since Linux 2.6.27)"
10203 #. commit ebcb67341fee34061430f3367f2e507e52ee051b
10204 #. type: Plain text
10205 #: build/C/man5/proc.5:1761
10207 "This file exposes the system call number and argument registers for the "
10208 "system call currently being executed by the process, followed by the values "
10209 "of the stack pointer and program counter registers. The values of all six "
10210 "argument registers are exposed, although most system calls use fewer "
10214 #. type: Plain text
10215 #: build/C/man5/proc.5:1766
10217 "If the process is blocked, but not in a system call, then the file displays "
10218 "-1 in place of the system call number, followed by just the values of the "
10219 "stack pointer and program counter. If process is not blocked, then file "
10220 "contains just the string \"running\"."
10223 #. type: Plain text
10224 #: build/C/man5/proc.5:1769
10226 "This file is present only if the kernel was configured with "
10227 "B<CONFIG_HAVE_ARCH_TRACEHOOK>."
10231 #: build/C/man5/proc.5:1769
10233 msgid "I</proc/[pid]/task> (since Linux 2.6.0-test6)"
10236 #. type: Plain text
10237 #: build/C/man5/proc.5:1800
10239 "This is a directory that contains one subdirectory for each thread in the "
10240 "process. The name of each subdirectory is the numerical thread ID "
10241 "(I<[tid]>) of the thread (see B<gettid>(2)). Within each of these "
10242 "subdirectories, there is a set of files with the same names and contents as "
10243 "under the I</proc/[pid]> directories. For attributes that are shared by all "
10244 "threads, the contents for each of the files under the I<task/[tid]> "
10245 "subdirectories will be the same as in the corresponding file in the parent "
10246 "I</proc/[pid]> directory (e.g., in a multithreaded process, all of the "
10247 "I<task/[tid]/cwd> files will have the same value as the I</proc/[pid]/cwd> "
10248 "file in the parent directory, since all of the threads in a process share a "
10249 "working directory). For attributes that are distinct for each thread, the "
10250 "corresponding files under I<task/[tid]> may have different values (e.g., "
10251 "various fields in each of the I<task/[tid]/status> files may be different "
10252 "for each thread)."
10255 #. The following was still true as at kernel 2.6.13
10256 #. type: Plain text
10257 #: build/C/man5/proc.5:1807
10259 "In a multithreaded process, the contents of the I</proc/[pid]/task> "
10260 "directory are not available if the main thread has already terminated "
10261 "(typically by calling B<pthread_exit>(3))."
10265 #: build/C/man5/proc.5:1807
10267 msgid "I</proc/[pid]/uid_map>, I</proc/[pid]/gid_map> (since Linux 3.5)"
10270 #. commit 22d917d80e842829d0ca0a561967d728eb1d6303
10271 #. type: Plain text
10272 #: build/C/man5/proc.5:1818
10274 "These files expose the mappings for user and group IDs inside the user "
10275 "namespace for the process I<pid>. The description here explains the details "
10276 "for I<uid_map>; I<gid_map> is exactly the same, but each instance of \"user "
10277 "ID\" is replaced by \"group ID\"."
10280 #. type: Plain text
10281 #: build/C/man5/proc.5:1832
10283 "The I<uid_map> file exposes the mapping of user IDs from the user namespace "
10284 "of the process I<pid> to the user namespace of the process that opened "
10285 "I<uid_map> (but see a qualification to this point below). In other words, "
10286 "processes that are in different user namespaces will potentially see "
10287 "different values when reading from a particular I<uid_map> file, depending "
10288 "on the user ID mappings for the user namespaces of the reading processes."
10291 #. type: Plain text
10292 #: build/C/man5/proc.5:1842
10294 "Each line in the file specifies a 1-to-1 mapping of a range of contiguous "
10295 "between two user namespaces. The specification in each line takes the form "
10296 "of three numbers delimited by white space. The first two numbers specify "
10297 "the starting user ID in each user namespace. The third number specifies the "
10298 "length of the mapped range. In detail, the fields are interpreted as "
10302 #. type: Plain text
10303 #: build/C/man5/proc.5:1847
10305 "The start of the range of user IDs in the user namespace of the process "
10309 #. type: Plain text
10310 #: build/C/man5/proc.5:1855
10312 "The start of the range of user IDs to which the user IDs specified by field "
10313 "one map. How field two is interpreted depends on whether the process that "
10314 "opened I<uid_map> and the process I<pid> are in the same user namespace, as "
10319 #: build/C/man5/proc.5:1856
10324 #. type: Plain text
10325 #: build/C/man5/proc.5:1861
10327 "If the two processes are in different user namespaces: field two is the "
10328 "start of a range of user IDs in the user namespace of the process that "
10329 "opened I<uid_map>."
10333 #: build/C/man5/proc.5:1861
10338 #. type: Plain text
10339 #: build/C/man5/proc.5:1881
10341 "If the two processes are in the same user namespace: field two is the start "
10342 "of the range of user IDs in the parent user namespace of the process "
10343 "I<pid>. (The \"parent user namespace\" is the user namespace of the process "
10344 "that created a user namespace via a call to B<unshare>(2) or B<clone>(2) "
10345 "with the B<CLONE_NEWUSER> flag.) This case enables the opener of I<uid_map> "
10346 "(the common case here is opening I</proc/self/uid_map>) to see the mapping "
10347 "of user IDs into the user namespace of the process that created this user "
10351 #. type: Plain text
10352 #: build/C/man5/proc.5:1885
10354 "The length of the range of user IDs that is mapped between the two user "
10358 #. type: Plain text
10359 #: build/C/man5/proc.5:1893
10361 "After the creation of a new user namespace, the I<uid_map> file may be "
10362 "written to exactly once to specify the mapping of user IDs in the new user "
10363 "namespace. (An attempt to write more than once to the file fails with the "
10367 #. type: Plain text
10368 #: build/C/man5/proc.5:1897
10369 msgid "The lines written to I<uid_map> must conform to the following rules:"
10372 #. type: Plain text
10373 #: build/C/man5/proc.5:1901
10375 "The three fields must be valid numbers, and the last field must be greater "
10379 #. type: Plain text
10380 #: build/C/man5/proc.5:1903
10381 msgid "Lines are terminated by newline characters."
10384 #. type: Plain text
10385 #: build/C/man5/proc.5:1906
10387 "There is an (arbitrary) limit on the number of lines in the file. As at "
10388 "Linux 3.8, the limit is five lines."
10391 #. type: Plain text
10392 #: build/C/man5/proc.5:1914
10394 "The range of user IDs specified in each line cannot overlap with the ranges "
10395 "in any other lines. In the current implementation (Linux 3.8), this "
10396 "requirement is satisfied by a simplistic implementation that imposes the "
10397 "further requirement that the values in both field 1 and field 2 of "
10398 "successive lines must be in ascending numerical order."
10401 #. type: Plain text
10402 #: build/C/man5/proc.5:1918
10403 msgid "Writes that violate the above rules fail with the error B<EINVAL>."
10406 #. type: Plain text
10407 #: build/C/man5/proc.5:1923
10409 "In order for a process to write to the I</proc/[pid]/uid_map> "
10410 "(I</proc/[pid]/gid_map>) file, the following requirements must be met:"
10413 #. type: Plain text
10414 #: build/C/man5/proc.5:1930
10416 "The process must have the B<CAP_SETUID> (B<CAP_SETGID>) capability in the "
10417 "user namespace of the process I<pid>."
10420 #. type: Plain text
10421 #: build/C/man5/proc.5:1935
10423 "The process must have the B<CAP_SETUID> (B<CAP_SETGID>) capability in the "
10424 "parent user namespace."
10427 #. type: Plain text
10428 #: build/C/man5/proc.5:1940
10430 "The process must be in either the user namespace of the process I<pid> or "
10431 "inside the parent user namespace of the process I<pid>."
10434 #. type: Plain text
10435 #: build/C/man5/proc.5:1943
10436 msgid "For further details, see B<namespaces>(7)."
10440 #: build/C/man5/proc.5:1943
10442 msgid "I</proc/[pid]/wchan> (since Linux 2.6.0)"
10445 #. type: Plain text
10446 #: build/C/man5/proc.5:1947
10448 "The symbolic name corresponding to the location in the kernel where the "
10449 "process is sleeping."
10453 #: build/C/man5/proc.5:1947
10455 msgid "I</proc/apm>"
10458 #. type: Plain text
10459 #: build/C/man5/proc.5:1952
10461 "Advanced power management version and battery information when B<CONFIG_APM> "
10462 "is defined at kernel compilation time."
10466 #: build/C/man5/proc.5:1952
10468 msgid "I</proc/buddyinfo>"
10471 #. type: Plain text
10472 #: build/C/man5/proc.5:1962
10474 "This file contains information which is used for diagnosing memory "
10475 "fragmentation issues. Each line starts with the identification of the node "
10476 "and the name of the zone which together identify a memory region This is "
10477 "then followed by the count of available chunks of a certain order in which "
10478 "these zones are split. The size in bytes of a certain order is given by the "
10482 #. type: Plain text
10483 #: build/C/man5/proc.5:1964
10485 msgid " (2^order)\\ *\\ PAGE_SIZE\n"
10488 #. type: Plain text
10489 #: build/C/man5/proc.5:1971
10491 "The binary buddy allocator algorithm inside the kernel will split one chunk "
10492 "into two chunks of a smaller order (thus with half the size) or combine two "
10493 "contiguous chunks into one larger chunk of a higher order (thus with double "
10494 "the size) to satisfy allocation requests and to counter memory "
10495 "fragmentation. The order matches the column number, when starting to count "
10499 #. type: Plain text
10500 #: build/C/man5/proc.5:1973
10501 msgid "For example on a x86_64 system:"
10504 #. type: Plain text
10505 #: build/C/man5/proc.5:1979
10508 "Node 0, zone DMA 1 1 1 0 2 1 1 0 1 1 "
10510 "Node 0, zone DMA32 65 47 4 81 52 28 13 10 5 1 "
10512 "Node 0, zone Normal 216 55 189 101 84 38 37 27 5 3 "
10516 #. type: Plain text
10517 #: build/C/man5/proc.5:1988
10519 "In this example, there is one node containing three zones and there are 11 "
10520 "different chunk sizes. If the page size is 4 kilobytes, then the first zone "
10521 "called I<DMA> (on x86 the first 16 megabyte of memory) has 1 chunk of 4 "
10522 "kilobytes (order 0) available and has 3 chunks of 4 megabytes (order 10) "
10526 #. type: Plain text
10527 #: build/C/man5/proc.5:1992
10529 "If the memory is heavily fragmented, the counters for higher order chunks "
10530 "will be zero and allocation of large contiguous areas will fail."
10533 #. type: Plain text
10534 #: build/C/man5/proc.5:1995
10535 msgid "Further information about the zones can be found in I</proc/zoneinfo>."
10539 #: build/C/man5/proc.5:1995
10541 msgid "I</proc/bus>"
10544 #. type: Plain text
10545 #: build/C/man5/proc.5:1998
10546 msgid "Contains subdirectories for installed busses."
10550 #: build/C/man5/proc.5:1998
10552 msgid "I</proc/bus/pccard>"
10555 #. type: Plain text
10556 #: build/C/man5/proc.5:2003
10558 "Subdirectory for PCMCIA devices when B<CONFIG_PCMCIA> is set at kernel "
10559 "compilation time."
10563 #: build/C/man5/proc.5:2003
10565 msgid "I</proc/[pid]/timers> (since Linux 3.10)"
10568 #. commit 5ed67f05f66c41e39880a6d61358438a25f9fee5
10569 #. commit 48f6a7a511ef8823fdff39afee0320092d43a8a0
10570 #. type: Plain text
10571 #: build/C/man5/proc.5:2010
10573 "A list of the POSIX timers for this process. Each timer is listed with a "
10574 "line that started with the string \"ID:\". For example:"
10577 #. type: Plain text
10578 #: build/C/man5/proc.5:2021
10582 "signal: 60/00007fff86e452a8\n"
10583 "notify: signal/pid.2634\n"
10586 "signal: 60/00007fff86e452a8\n"
10587 "notify: signal/pid.2634\n"
10591 #. type: Plain text
10592 #: build/C/man5/proc.5:2025
10593 msgid "The lines shown for each timer have the following meanings:"
10597 #: build/C/man5/proc.5:2026
10602 #. type: Plain text
10603 #: build/C/man5/proc.5:2037
10605 "The ID for this timer. This is not the same as the timer ID returned by "
10606 "B<timer_create>(2); rather, it is the same kernel-internal ID that is "
10607 "available via the I<si_timerid> field of the I<siginfo_t> structure (see "
10608 "B<sigaction>(2))."
10612 #: build/C/man5/proc.5:2037
10617 #. type: Plain text
10618 #: build/C/man5/proc.5:2044
10620 "This is the signal number that this timer uses to deliver notifications "
10621 "followed by a slash, and then the I<sigev_value.sival_ptr> value supplied to "
10622 "the signal handler. Valid only for timers that notify via a signal."
10626 #: build/C/man5/proc.5:2044
10631 #. type: Plain text
10632 #: build/C/man5/proc.5:2055
10634 "The part before the slash specifies the mechanism that this timer uses to "
10635 "deliver notifications, and is one of \"thread\", \"signal\", or \"none\". "
10636 "Immediately following the slash is either the string \"tid\" for timers with "
10637 "B<SIGEV_THREAD_ID> notification, or \"pid\" for timers that notify by other "
10638 "mechanisms. Following the \".\" is the PID of the process that will be "
10639 "delivered a signal if the timer delivers notifications via a signal."
10643 #: build/C/man5/proc.5:2055
10648 #. type: Plain text
10649 #: build/C/man5/proc.5:2068
10651 "This field identifies the clock that the timer uses for measuring time. For "
10652 "most clocks, this is a number that matches one of the user-space B<CLOCK_*> "
10653 "constants exposed via I<E<lt>time.hE<gt>>. B<CLOCK_PROCESS_CPUTIME_ID> "
10654 "timers display with a value of -6 in this field. B<CLOCK_THREAD_CPUTIME_ID> "
10655 "timers display with a value of -2 in this field."
10659 #: build/C/man5/proc.5:2069
10661 msgid "I</proc/bus/pccard/drivers>"
10665 #: build/C/man5/proc.5:2071
10667 msgid "I</proc/bus/pci>"
10670 #. type: Plain text
10671 #: build/C/man5/proc.5:2077
10673 "Contains various bus subdirectories and pseudo-files containing information "
10674 "about PCI busses, installed devices, and device drivers. Some of these "
10675 "files are not ASCII."
10679 #: build/C/man5/proc.5:2077
10681 msgid "I</proc/bus/pci/devices>"
10684 #. type: Plain text
10685 #: build/C/man5/proc.5:2084
10687 "Information about PCI devices. They may be accessed through B<lspci>(8) "
10688 "and B<setpci>(8)."
10692 #: build/C/man5/proc.5:2084
10694 msgid "I</proc/cmdline>"
10697 #. type: Plain text
10698 #: build/C/man5/proc.5:2091
10700 "Arguments passed to the Linux kernel at boot time. Often done via a boot "
10701 "manager such as B<lilo>(8) or B<grub>(8)."
10705 #: build/C/man5/proc.5:2091
10707 msgid "I</proc/config.gz> (since Linux 2.6)"
10710 #. type: Plain text
10711 #: build/C/man5/proc.5:2109
10713 "This file exposes the configuration options that were used to build the "
10714 "currently running kernel, in the same format as they would be shown in the "
10715 "I<.config> file that resulted when configuring the kernel (using I<make "
10716 "xconfig>, I<make config>, or similar). The file contents are compressed; "
10717 "view or search them using B<zcat>(1) and B<zgrep>(1). As long as no "
10718 "changes have been made to the following file, the contents of "
10719 "I</proc/config.gz> are the same as those provided by :"
10722 #. type: Plain text
10723 #: build/C/man5/proc.5:2113
10725 msgid "cat /lib/modules/$(uname -r)/build/.config\n"
10728 #. type: Plain text
10729 #: build/C/man5/proc.5:2119
10731 "I</proc/config.gz> is provided only if the kernel is configured with "
10732 "B<CONFIG_IKCONFIG_PROC>."
10736 #: build/C/man5/proc.5:2119
10738 msgid "I</proc/cpuinfo>"
10741 #. type: Plain text
10742 #: build/C/man5/proc.5:2131
10744 "This is a collection of CPU and system architecture dependent items, for "
10745 "each supported architecture a different list. Two common entries are "
10746 "I<processor> which gives CPU number and I<bogomips>; a system constant that "
10747 "is calculated during kernel initialization. SMP machines have information "
10748 "for each CPU. The B<lscpu>(1) command gathers its information from this "
10753 #: build/C/man5/proc.5:2131
10755 msgid "I</proc/devices>"
10758 #. type: Plain text
10759 #: build/C/man5/proc.5:2135
10761 "Text listing of major numbers and device groups. This can be used by "
10762 "MAKEDEV scripts for consistency with the kernel."
10766 #: build/C/man5/proc.5:2135
10768 msgid "I</proc/diskstats> (since Linux 2.5.69)"
10771 #. type: Plain text
10772 #: build/C/man5/proc.5:2141
10774 "This file contains disk I/O statistics for each disk device. See the Linux "
10775 "kernel source file I<Documentation/iostats.txt> for further information."
10779 #: build/C/man5/proc.5:2141
10781 msgid "I</proc/dma>"
10784 #. type: Plain text
10785 #: build/C/man5/proc.5:2145
10787 "This is a list of the registered I<ISA> DMA (direct memory access) channels "
10792 #: build/C/man5/proc.5:2145
10794 msgid "I</proc/driver>"
10797 #. type: Plain text
10798 #: build/C/man5/proc.5:2148
10799 msgid "Empty subdirectory."
10803 #: build/C/man5/proc.5:2148
10805 msgid "I</proc/execdomains>"
10808 #. type: Plain text
10809 #: build/C/man5/proc.5:2151
10810 msgid "List of the execution domains (ABI personalities)."
10814 #: build/C/man5/proc.5:2151
10816 msgid "I</proc/fb>"
10819 #. type: Plain text
10820 #: build/C/man5/proc.5:2156
10822 "Frame buffer information when B<CONFIG_FB> is defined during kernel "
10827 #: build/C/man5/proc.5:2156
10829 msgid "I</proc/filesystems>"
10832 #. type: Plain text
10833 #: build/C/man5/proc.5:2166
10835 "A text listing of the filesystems which are supported by the kernel, namely "
10836 "filesystems which were compiled into the kernel or whose kernel modules are "
10837 "currently loaded. (See also B<filesystems>(5).) If a filesystem is marked "
10838 "with \"nodev\", this means that it does not require a block device to be "
10839 "mounted (e.g., virtual filesystem, network filesystem)."
10842 #. type: Plain text
10843 #: build/C/man5/proc.5:2173
10845 "Incidentally, this file may be used by B<mount>(8) when no filesystem is "
10846 "specified and it didn't manage to determine the filesystem type. Then "
10847 "filesystems contained in this file are tried (excepted those that are marked "
10852 #: build/C/man5/proc.5:2173
10854 msgid "I</proc/fs>"
10857 #. FIXME Much more needs to be said about /proc/fs
10858 #. type: Plain text
10859 #: build/C/man5/proc.5:2179
10861 "Contains subdirectories that in turn contain files with information about "
10862 "(certain) mounted filesystems."
10866 #: build/C/man5/proc.5:2179
10868 msgid "I</proc/ide>"
10871 #. type: Plain text
10872 #: build/C/man5/proc.5:2185
10874 "This directory exists on systems with the IDE bus. There are directories "
10875 "for each IDE channel and attached device. Files include:"
10878 #. type: Plain text
10879 #: build/C/man5/proc.5:2198
10882 "cache buffer size in KB\n"
10883 "capacity number of sectors\n"
10884 "driver driver version\n"
10885 "geometry physical and logical geometry\n"
10886 "identify in hexadecimal\n"
10887 "media media type\n"
10888 "model manufacturer's model number\n"
10889 "settings drive settings\n"
10890 "smart_thresholds in hexadecimal\n"
10891 "smart_values in hexadecimal\n"
10894 #. type: Plain text
10895 #: build/C/man5/proc.5:2204
10897 "The B<hdparm>(8) utility provides access to this information in a friendly "
10902 #: build/C/man5/proc.5:2204
10904 msgid "I</proc/interrupts>"
10907 #. type: Plain text
10908 #: build/C/man5/proc.5:2214
10910 "This is used to record the number of interrupts per CPU per IO device. "
10911 "Since Linux 2.6.24, for the i386 and x86_64 architectures, at least, this "
10912 "also includes interrupts internal to the system (that is, not associated "
10913 "with a device as such), such as NMI (nonmaskable interrupt), LOC (local "
10914 "timer interrupt), and for SMP systems, TLB (TLB flush interrupt), RES "
10915 "(rescheduling interrupt), CAL (remote function call interrupt), and possibly "
10916 "others. Very easy to read formatting, done in ASCII."
10920 #: build/C/man5/proc.5:2214
10922 msgid "I</proc/iomem>"
10925 #. type: Plain text
10926 #: build/C/man5/proc.5:2217
10927 msgid "I/O memory map in Linux 2.4."
10931 #: build/C/man5/proc.5:2217
10933 msgid "I</proc/ioports>"
10936 #. type: Plain text
10937 #: build/C/man5/proc.5:2221
10939 "This is a list of currently registered Input-Output port regions that are in "
10944 #: build/C/man5/proc.5:2221
10946 msgid "I</proc/kallsyms> (since Linux 2.5.71)"
10949 #. type: Plain text
10950 #: build/C/man5/proc.5:2229
10952 "This holds the kernel exported symbol definitions used by the B<modules>(X) "
10953 "tools to dynamically link and bind loadable modules. In Linux 2.5.47 and "
10954 "earlier, a similar file with slightly different syntax was named I<ksyms>."
10958 #: build/C/man5/proc.5:2229
10960 msgid "I</proc/kcore>"
10963 #. type: Plain text
10964 #: build/C/man5/proc.5:2238
10966 "This file represents the physical memory of the system and is stored in the "
10967 "ELF core file format. With this pseudo-file, and an unstripped kernel "
10968 "(I</usr/src/linux/vmlinux>) binary, GDB can be used to examine the current "
10969 "state of any kernel data structures."
10972 #. type: Plain text
10973 #: build/C/man5/proc.5:2241
10974 msgid "The total length of the file is the size of physical memory (RAM) plus 4KB."
10978 #: build/C/man5/proc.5:2241
10980 msgid "I</proc/kmsg>"
10983 #. type: Plain text
10984 #: build/C/man5/proc.5:2253
10986 "This file can be used instead of the B<syslog>(2) system call to read "
10987 "kernel messages. A process must have superuser privileges to read this "
10988 "file, and only one process should read this file. This file should not be "
10989 "read if a syslog process is running which uses the B<syslog>(2) system call "
10990 "facility to log kernel messages."
10993 #. type: Plain text
10994 #: build/C/man5/proc.5:2257
10995 msgid "Information in this file is retrieved with the B<dmesg>(1) program."
10999 #: build/C/man5/proc.5:2257
11001 msgid "I</proc/kpagecount> (since Linux 2.6.25)"
11004 #. type: Plain text
11005 #: build/C/man5/proc.5:2263
11007 "This file contains a 64-bit count of the number of times each physical page "
11008 "frame is mapped, indexed by page frame number (see the discussion of "
11009 "I</proc/[pid]/pagemap>)."
11012 #. type: Plain text
11013 #: build/C/man5/proc.5:2269
11015 "The I</proc/kpagecount> file is present only if the "
11016 "B<CONFIG_PROC_PAGE_MONITOR> kernel configuration option is enabled."
11020 #: build/C/man5/proc.5:2269
11022 msgid "I</proc/kpageflags> (since Linux 2.6.25)"
11025 #. type: Plain text
11026 #: build/C/man5/proc.5:2275
11028 "This file contains 64-bit masks corresponding to each physical page frame; "
11029 "it is indexed by page frame number (see the discussion of "
11030 "I</proc/[pid]/pagemap>). The bits are as follows:"
11033 #. type: Plain text
11034 #: build/C/man5/proc.5:2299
11037 " 0 - KPF_LOCKED\n"
11039 " 2 - KPF_REFERENCED\n"
11040 " 3 - KPF_UPTODATE\n"
11043 " 6 - KPF_ACTIVE\n"
11045 " 8 - KPF_WRITEBACK\n"
11046 " 9 - KPF_RECLAIM\n"
11047 " 10 - KPF_BUDDY\n"
11048 " 11 - KPF_MMAP (since Linux 2.6.31)\n"
11049 " 12 - KPF_ANON (since Linux 2.6.31)\n"
11050 " 13 - KPF_SWAPCACHE (since Linux 2.6.31)\n"
11051 " 14 - KPF_SWAPBACKED (since Linux 2.6.31)\n"
11052 " 15 - KPF_COMPOUND_HEAD (since Linux 2.6.31)\n"
11053 " 16 - KPF_COMPOUND_TAIL (since Linux 2.6.31)\n"
11054 " 16 - KPF_HUGE (since Linux 2.6.31)\n"
11055 " 18 - KPF_UNEVICTABLE (since Linux 2.6.31)\n"
11056 " 19 - KPF_HWPOISON (since Linux 2.6.31)\n"
11057 " 20 - KPF_NOPAGE (since Linux 2.6.31)\n"
11058 " 21 - KPF_KSM (since Linux 2.6.32)\n"
11059 " 22 - KPF_THP (since Linux 3.4)\n"
11062 #. commit ad3bdefe877afb47480418fdb05ecd42842de65e
11063 #. commit e07a4b9217d1e97d2f3a62b6b070efdc61212110
11064 #. type: Plain text
11065 #: build/C/man5/proc.5:2312
11067 "For further details on the meanings of these bits, see the kernel source "
11068 "file I<Documentation/vm/pagemap.txt>. Before kernel 2.6.29, "
11069 "B<KPF_WRITEBACK>, B<KPF_RECLAIM>, B<KPF_BUDDY>, and B<KPF_LOCKED> did not "
11070 "report correctly."
11073 #. type: Plain text
11074 #: build/C/man5/proc.5:2318
11076 "The I</proc/kpageflags> file is present only if the "
11077 "B<CONFIG_PROC_PAGE_MONITOR> kernel configuration option is enabled."
11081 #: build/C/man5/proc.5:2318
11083 msgid "I</proc/ksyms> (Linux 1.1.23-2.5.47)"
11086 #. type: Plain text
11087 #: build/C/man5/proc.5:2322
11088 msgid "See I</proc/kallsyms>."
11092 #: build/C/man5/proc.5:2322
11094 msgid "I</proc/loadavg>"
11097 #. type: Plain text
11098 #: build/C/man5/proc.5:2337
11100 "The first three fields in this file are load average figures giving the "
11101 "number of jobs in the run queue (state R) or waiting for disk I/O (state D) "
11102 "averaged over 1, 5, and 15 minutes. They are the same as the load average "
11103 "numbers given by B<uptime>(1) and other programs. The fourth field "
11104 "consists of two numbers separated by a slash (/). The first of these is the "
11105 "number of currently runnable kernel scheduling entities (processes, "
11106 "threads). The value after the slash is the number of kernel scheduling "
11107 "entities that currently exist on the system. The fifth field is the PID of "
11108 "the process that was most recently created on the system."
11112 #: build/C/man5/proc.5:2337
11114 msgid "I</proc/locks>"
11117 #. type: Plain text
11118 #: build/C/man5/proc.5:2343
11120 "This file shows current file locks (B<flock>(2) and B<fcntl>(2)) and leases "
11125 #: build/C/man5/proc.5:2343
11127 msgid "I</proc/malloc> (only up to and including Linux 2.2)"
11130 #. It looks like this only ever did something back in 1.0 days
11131 #. type: Plain text
11132 #: build/C/man5/proc.5:2349
11134 "This file is present only if B<CONFIG_DEBUG_MALLOC> was defined during "
11139 #: build/C/man5/proc.5:2349
11141 msgid "I</proc/meminfo>"
11144 #. type: Plain text
11145 #: build/C/man5/proc.5:2365
11147 "This file reports statistics about memory usage on the system. It is used "
11148 "by B<free>(1) to report the amount of free and used memory (both physical "
11149 "and swap) on the system as well as the shared memory and buffers used by "
11150 "the kernel. Each line of the file consists of a parameter name, followed by "
11151 "a colon, the value of the parameter, and an option unit of measurement "
11152 "(e.g., \"kB\"). The list below describes the parameter names and the format "
11153 "specifier required to read the field value. Except as noted below, all of "
11154 "the fields have been present since at least Linux 2.6.0. Some fields are "
11155 "displayed only if the kernel was configured with various options; those "
11156 "dependencies are noted in the list."
11160 #: build/C/man5/proc.5:2366
11162 msgid "I<MemTotal> %lu"
11165 #. type: Plain text
11166 #: build/C/man5/proc.5:2370
11168 "Total usable RAM (i.e., physical RAM minus a few reserved bits and the "
11169 "kernel binary code)."
11173 #: build/C/man5/proc.5:2370
11175 msgid "I<MemFree> %lu"
11178 #. type: Plain text
11179 #: build/C/man5/proc.5:2374
11180 msgid "The sum of I<LowFree>+I<HighFree>."
11184 #: build/C/man5/proc.5:2374
11186 msgid "I<Buffers> %lu"
11189 #. type: Plain text
11190 #: build/C/man5/proc.5:2378
11192 "Relatively temporary storage for raw disk blocks that shouldn't get "
11193 "tremendously large (20MB or so)."
11197 #: build/C/man5/proc.5:2378
11199 msgid "I<Cached> %lu"
11202 #. type: Plain text
11203 #: build/C/man5/proc.5:2383
11205 "In-memory cache for files read from the disk (the page cache). Doesn't "
11206 "include I<SwapCached>."
11210 #: build/C/man5/proc.5:2383
11212 msgid "I<SwapCached> %lu"
11215 #. type: Plain text
11216 #: build/C/man5/proc.5:2391
11218 "Memory that once was swapped out, is swapped back in but still also is in "
11219 "the swap file. (If memory pressure is high, these pages don't need to be "
11220 "swapped out again because they are already in the swap file. This saves "
11225 #: build/C/man5/proc.5:2391
11227 msgid "I<Active> %lu"
11230 #. type: Plain text
11231 #: build/C/man5/proc.5:2395
11233 "Memory that has been used more recently and usually not reclaimed unless "
11234 "absolutely necessary."
11238 #: build/C/man5/proc.5:2395
11240 msgid "I<Inactive> %lu"
11243 #. type: Plain text
11244 #: build/C/man5/proc.5:2399
11246 "Memory which has been less recently used. It is more eligible to be "
11247 "reclaimed for other purposes."
11251 #: build/C/man5/proc.5:2399
11253 msgid "I<Active(anon)> %lu (since Linux 2.6.28)"
11256 #. type: Plain text
11257 #: build/C/man5/proc.5:2402 build/C/man5/proc.5:2405 build/C/man5/proc.5:2408 build/C/man5/proc.5:2411 build/C/man5/proc.5:2478
11258 msgid "[To be documented.]"
11262 #: build/C/man5/proc.5:2402
11264 msgid "I<Inactive(anon)> %lu (since Linux 2.6.28)"
11268 #: build/C/man5/proc.5:2405
11270 msgid "I<Active(file)> %lu (since Linux 2.6.28)"
11274 #: build/C/man5/proc.5:2408
11276 msgid "I<Inactive(file)> %lu (since Linux 2.6.28)"
11280 #: build/C/man5/proc.5:2411
11282 msgid "I<Unevictable> %lu (since Linux 2.6.28)"
11285 #. type: Plain text
11286 #: build/C/man5/proc.5:2416 build/C/man5/proc.5:2421
11288 "(From Linux 2.6.28 to 2.6.30, B<CONFIG_UNEVICTABLE_LRU> was required.) [To "
11293 #: build/C/man5/proc.5:2416
11295 msgid "I<Mlocked> %lu (since Linux 2.6.28)"
11299 #: build/C/man5/proc.5:2421
11301 msgid "I<HighTotal> %lu"
11304 #. type: Plain text
11305 #: build/C/man5/proc.5:2430
11307 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
11308 "of highmem. Highmem is all memory above ~860MB of physical memory. Highmem "
11309 "areas are for use by user-space programs, or for the page cache. The kernel "
11310 "must use tricks to access this memory, making it slower to access than "
11315 #: build/C/man5/proc.5:2430
11317 msgid "I<HighFree> %lu"
11320 #. type: Plain text
11321 #: build/C/man5/proc.5:2434
11323 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
11328 #: build/C/man5/proc.5:2434
11330 msgid "I<LowTotal> %lu"
11333 #. type: Plain text
11334 #: build/C/man5/proc.5:2446
11336 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
11337 "of lowmem. Lowmem is memory which can be used for everything that highmem "
11338 "can be used for, but it is also available for the kernel's use for its own "
11339 "data structures. Among many other things, it is where everything from "
11340 "I<Slab> is allocated. Bad things happen when you're out of lowmem."
11344 #: build/C/man5/proc.5:2446
11346 msgid "I<LowFree> %lu"
11349 #. type: Plain text
11350 #: build/C/man5/proc.5:2450
11352 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
11357 #: build/C/man5/proc.5:2450
11359 msgid "I<MmapCopy> %lu (since Linux 2.6.29)"
11362 #. type: Plain text
11363 #: build/C/man5/proc.5:2455
11364 msgid "(B<CONFIG_MMU> is required.) [To be documented.]"
11368 #: build/C/man5/proc.5:2455
11370 msgid "I<SwapTotal> %lu"
11373 #. type: Plain text
11374 #: build/C/man5/proc.5:2458
11375 msgid "Total amount of swap space available."
11379 #: build/C/man5/proc.5:2458
11381 msgid "I<SwapFree> %lu"
11384 #. type: Plain text
11385 #: build/C/man5/proc.5:2461
11386 msgid "Amount of swap space that is currently unused."
11390 #: build/C/man5/proc.5:2461
11392 msgid "I<Dirty> %lu"
11395 #. type: Plain text
11396 #: build/C/man5/proc.5:2464
11397 msgid "Memory which is waiting to get written back to the disk."
11401 #: build/C/man5/proc.5:2464
11403 msgid "I<Writeback> %lu"
11406 #. type: Plain text
11407 #: build/C/man5/proc.5:2467
11408 msgid "Memory which is actively being written back to the disk."
11412 #: build/C/man5/proc.5:2467
11414 msgid "I<AnonPages> %lu (since Linux 2.6.18)"
11417 #. type: Plain text
11418 #: build/C/man5/proc.5:2470
11419 msgid "Non-file backed pages mapped into user-space page tables."
11423 #: build/C/man5/proc.5:2470
11425 msgid "I<Mapped> %lu"
11428 #. type: Plain text
11429 #: build/C/man5/proc.5:2475
11431 "Files which have been mapped into memory (with B<mmap>(2)), such as "
11436 #: build/C/man5/proc.5:2475
11438 msgid "I<Shmem> %lu (since Linux 2.6.32)"
11442 #: build/C/man5/proc.5:2478
11444 msgid "I<Slab> %lu"
11447 #. type: Plain text
11448 #: build/C/man5/proc.5:2481
11449 msgid "In-kernel data structures cache."
11453 #: build/C/man5/proc.5:2481
11455 msgid "I<SReclaimable> %lu (since Linux 2.6.19)"
11458 #. type: Plain text
11459 #: build/C/man5/proc.5:2486
11460 msgid "Part of I<Slab>, that might be reclaimed, such as caches."
11464 #: build/C/man5/proc.5:2486
11466 msgid "I<SUnreclaim> %lu (since Linux 2.6.19)"
11469 #. type: Plain text
11470 #: build/C/man5/proc.5:2491
11471 msgid "Part of I<Slab>, that cannot be reclaimed on memory pressure."
11475 #: build/C/man5/proc.5:2491
11477 msgid "I<KernelStack> %lu (since Linux 2.6.32)"
11480 #. type: Plain text
11481 #: build/C/man5/proc.5:2494
11482 msgid "Amount of memory allocated to kernel stacks."
11486 #: build/C/man5/proc.5:2494
11488 msgid "I<PageTables> %lu (since Linux 2.6.18)"
11491 #. type: Plain text
11492 #: build/C/man5/proc.5:2497
11493 msgid "Amount of memory dedicated to the lowest level of page tables."
11497 #: build/C/man5/proc.5:2497
11499 msgid "I<Quicklists> %lu (since Linux 2.6.27)"
11502 #. type: Plain text
11503 #: build/C/man5/proc.5:2501
11504 msgid "(B<CONFIG_QUICKLIST> is required.) [To be documented.]"
11508 #: build/C/man5/proc.5:2501
11510 msgid "I<NFS_Unstable> %lu (since Linux 2.6.18)"
11513 #. type: Plain text
11514 #: build/C/man5/proc.5:2504
11515 msgid "NFS pages sent to the server, but not yet committed to stable storage."
11519 #: build/C/man5/proc.5:2504
11521 msgid "I<Bounce> %lu (since Linux 2.6.18)"
11524 #. type: Plain text
11525 #: build/C/man5/proc.5:2507
11526 msgid "Memory used for block device \"bounce buffers\"."
11530 #: build/C/man5/proc.5:2507
11532 msgid "I<WritebackTmp> %lu (since Linux 2.6.26)"
11535 #. type: Plain text
11536 #: build/C/man5/proc.5:2510
11537 msgid "Memory used by FUSE for temporary writeback buffers."
11541 #: build/C/man5/proc.5:2510
11543 msgid "I<CommitLimit> %lu (since Linux 2.6.10)"
11546 #. type: Plain text
11547 #: build/C/man5/proc.5:2521
11549 "This is the total amount of memory currently available to be allocated on "
11550 "the system, expressed in kilobytes. This limit is adhered to only if strict "
11551 "overcommit accounting is enabled (mode 2 in "
11552 "I</proc/sys/vm/overcommit_memory>). The limit is calculated according to "
11553 "the formula described under I</proc/sys/vm/overcommit_memory>. For further "
11554 "details, see the kernel source file "
11555 "I<Documentation/vm/overcommit-accounting>."
11559 #: build/C/man5/proc.5:2521
11561 msgid "I<Committed_AS> %lu"
11564 #. type: Plain text
11565 #: build/C/man5/proc.5:2532
11567 "The amount of memory presently allocated on the system. The committed "
11568 "memory is a sum of all of the memory which has been allocated by processes, "
11569 "even if it has not been \"used\" by them as of yet. A process which "
11570 "allocates 1GB of memory (using B<malloc>(3) or similar), but touches only "
11571 "300MB of that memory will show up as using only 300MB of memory even if it "
11572 "has the address space allocated for the entire 1GB."
11575 #. type: Plain text
11576 #: build/C/man5/proc.5:2542
11578 "This 1GB is memory which has been \"committed\" to by the VM and can be used "
11579 "at any time by the allocating application. With strict overcommit enabled "
11580 "on the system (mode 2 in IR /proc/sys/vm/overcommit_memory ), allocations "
11581 "which would exceed the I<CommitLimit> will not be permitted. This is useful "
11582 "if one needs to guarantee that processes will not fail due to lack of memory "
11583 "once that memory has been successfully allocated."
11587 #: build/C/man5/proc.5:2542
11589 msgid "I<VmallocTotal> %lu"
11592 #. type: Plain text
11593 #: build/C/man5/proc.5:2545
11594 msgid "Total size of vmalloc memory area."
11598 #: build/C/man5/proc.5:2545
11600 msgid "I<VmallocUsed> %lu"
11603 #. type: Plain text
11604 #: build/C/man5/proc.5:2548
11605 msgid "Amount of vmalloc area which is used."
11609 #: build/C/man5/proc.5:2548
11611 msgid "I<VmallocChunk> %lu"
11614 #. type: Plain text
11615 #: build/C/man5/proc.5:2551
11616 msgid "Largest contiguous block of vmalloc area which is free."
11620 #: build/C/man5/proc.5:2551
11622 msgid "I<HardwareCorrupted> %lu (since Linux 2.6.32)"
11625 #. type: Plain text
11626 #: build/C/man5/proc.5:2555
11627 msgid "(B<CONFIG_MEMORY_FAILURE> is required.) [To be documented.]"
11631 #: build/C/man5/proc.5:2555
11633 msgid "I<AnonHugePages> %lu (since Linux 2.6.38)"
11636 #. type: Plain text
11637 #: build/C/man5/proc.5:2559
11639 "(B<CONFIG_TRANSPARENT_HUGEPAGE> is required.) Non-file backed huge pages "
11640 "mapped into user-space page tables."
11644 #: build/C/man5/proc.5:2559
11646 msgid "I<HugePages_Total> %lu"
11649 #. type: Plain text
11650 #: build/C/man5/proc.5:2563
11651 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of the pool of huge pages."
11655 #: build/C/man5/proc.5:2563
11657 msgid "I<HugePages_Free> %lu"
11660 #. type: Plain text
11661 #: build/C/man5/proc.5:2567
11663 "(B<CONFIG_HUGETLB_PAGE> is required.) The number of huge pages in the pool "
11664 "that are not yet allocated."
11668 #: build/C/man5/proc.5:2567
11670 msgid "I<HugePages_Rsvd> %lu (since Linux 2.6.17)"
11673 #. type: Plain text
11674 #: build/C/man5/proc.5:2576
11676 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages for "
11677 "which a commitment to allocate from the pool has been made, but no "
11678 "allocation has yet been made. These reserved huge pages guarantee that an "
11679 "application will be able to allocate a huge page from the pool of huge pages "
11684 #: build/C/man5/proc.5:2576
11686 msgid "I<HugePages_Surp> %lu (since Linux 2.6.24)"
11689 #. type: Plain text
11690 #: build/C/man5/proc.5:2584
11692 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages in "
11693 "the pool above the value in I</proc/sys/vm/nr_hugepages>. The maximum "
11694 "number of surplus huge pages is controlled by "
11695 "I</proc/sys/vm/nr_overcommit_hugepages>."
11699 #: build/C/man5/proc.5:2584
11701 msgid "I<Hugepagesize> %lu"
11704 #. type: Plain text
11705 #: build/C/man5/proc.5:2588
11706 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of huge pages."
11710 #: build/C/man5/proc.5:2589
11712 msgid "I</proc/modules>"
11715 #. type: Plain text
11716 #: build/C/man5/proc.5:2594
11718 "A text list of the modules that have been loaded by the system. See also "
11723 #: build/C/man5/proc.5:2594
11725 msgid "I</proc/mounts>"
11728 #. type: Plain text
11729 #: build/C/man5/proc.5:2604
11731 "Before kernel 2.4.19, this file was a list of all the filesystems currently "
11732 "mounted on the system. With the introduction of per-process mount "
11733 "namespaces in Linux 2.4.19, this file became a link to I</proc/self/mounts>, "
11734 "which lists the mount points of the process's own mount namespace. The "
11735 "format of this file is documented in B<fstab>(5)."
11739 #: build/C/man5/proc.5:2604
11741 msgid "I</proc/mtrr>"
11744 #. type: Plain text
11745 #: build/C/man5/proc.5:2610
11747 "Memory Type Range Registers. See the Linux kernel source file "
11748 "I<Documentation/mtrr.txt> for details."
11752 #: build/C/man5/proc.5:2610
11754 msgid "I</proc/net>"
11757 #. type: Plain text
11758 #: build/C/man5/proc.5:2620
11760 "various net pseudo-files, all of which give the status of some part of the "
11761 "networking layer. These files contain ASCII structures and are, therefore, "
11762 "readable with B<cat>(1). However, the standard B<netstat>(8) suite "
11763 "provides much cleaner access to these files."
11767 #: build/C/man5/proc.5:2620
11769 msgid "I</proc/net/arp>"
11772 #. type: Plain text
11773 #: build/C/man5/proc.5:2626
11775 "This holds an ASCII readable dump of the kernel ARP table used for address "
11776 "resolutions. It will show both dynamically learned and preprogrammed ARP "
11777 "entries. The format is:"
11780 #. type: Plain text
11781 #: build/C/man5/proc.5:2633
11784 "CW<IP address HW type Flags HW address Mask Device\n"
11785 "192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0\n"
11786 "192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0>\n"
11789 #. type: Plain text
11790 #: build/C/man5/proc.5:2645
11792 "Here \"IP address\" is the IPv4 address of the machine and the \"HW type\" "
11793 "is the hardware type of the address from RFC\\ 826. The flags are the "
11794 "internal flags of the ARP structure (as defined in "
11795 "I</usr/include/linux/if_arp.h>) and the \"HW address\" is the data link "
11796 "layer mapping for that IP address if it is known."
11800 #: build/C/man5/proc.5:2645
11802 msgid "I</proc/net/dev>"
11805 #. type: Plain text
11806 #: build/C/man5/proc.5:2656
11808 "The dev pseudo-file contains network device status information. This gives "
11809 "the number of received and sent packets, the number of errors and collisions "
11810 "and other basic statistics. These are used by the B<ifconfig>(8) program "
11811 "to report device status. The format is:"
11814 #. type: Plain text
11815 #: build/C/man5/proc.5:2666
11818 "CW<Inter-| Receive | "
11820 " face |bytes packets errs drop fifo frame compressed multicast|bytes "
11821 "packets errs drop fifo colls carrier compressed\n"
11822 " lo: 2776770 11307 0 0 0 0 0 0 2776770 "
11823 "11307 0 0 0 0 0 0\n"
11824 " eth0: 1215645 2751 0 0 0 0 0 0 1782404 "
11825 "4324 0 0 0 427 0 0\n"
11826 " ppp0: 1622270 5552 1 0 0 0 0 0 354130 "
11827 "5669 0 0 0 0 0 0\n"
11828 " tap0: 7714 81 0 0 0 0 0 0 7714 "
11829 "81 0 0 0 0 0 0>\n"
11833 #: build/C/man5/proc.5:2675
11835 msgid "I</proc/net/dev_mcast>"
11838 #. type: Plain text
11839 #: build/C/man5/proc.5:2679
11840 msgid "Defined in I</usr/src/linux/net/core/dev_mcast.c>:"
11843 #. type: Plain text
11844 #: build/C/man5/proc.5:2685
11847 "indx interface_name dmi_u dmi_g dmi_address\n"
11848 "2 eth0 1 0 01005e000001\n"
11849 "3 eth1 1 0 01005e000001\n"
11850 "4 eth2 1 0 01005e000001\n"
11854 #: build/C/man5/proc.5:2687
11856 msgid "I</proc/net/igmp>"
11859 #. type: Plain text
11860 #: build/C/man5/proc.5:2692
11862 "Internet Group Management Protocol. Defined in "
11863 "I</usr/src/linux/net/core/igmp.c>."
11867 #: build/C/man5/proc.5:2692
11869 msgid "I</proc/net/rarp>"
11872 #. type: Plain text
11873 #: build/C/man5/proc.5:2702
11875 "This file uses the same format as the I<arp> file and contains the current "
11876 "reverse mapping database used to provide B<rarp>(8) reverse address lookup "
11877 "services. If RARP is not configured into the kernel, this file will not be "
11882 #: build/C/man5/proc.5:2702
11884 msgid "I</proc/net/raw>"
11888 #. .I /proc/net/route
11889 #. No information, but looks similar to
11891 #. type: Plain text
11892 #: build/C/man5/proc.5:2722
11894 "Holds a dump of the RAW socket table. Much of the information is not of use "
11895 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
11896 "socket, the \"local_address\" is the local address and protocol number "
11897 "pair. \\&\"St\" is the internal status of the socket. The \"tx_queue\" and "
11898 "\"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
11899 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
11900 "used by RAW. The \"uid\" field holds the effective UID of the creator of "
11905 #: build/C/man5/proc.5:2722
11907 msgid "I</proc/net/snmp>"
11910 #. type: Plain text
11911 #: build/C/man5/proc.5:2727
11913 "This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP "
11914 "management information bases for an SNMP agent."
11918 #: build/C/man5/proc.5:2727
11920 msgid "I</proc/net/tcp>"
11923 #. type: Plain text
11924 #: build/C/man5/proc.5:2743
11926 "Holds a dump of the TCP socket table. Much of the information is not of use "
11927 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
11928 "socket, the \"local_address\" is the local address and port number pair. "
11929 "The \"rem_address\" is the remote address and port number pair (if "
11930 "connected). \\&\"St\" is the internal status of the socket. The "
11931 "\"tx_queue\" and \"rx_queue\" are the outgoing and incoming data queue in "
11932 "terms of kernel memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" "
11933 "fields hold internal information of the kernel socket state and are only "
11934 "useful for debugging. The \"uid\" field holds the effective UID of the "
11935 "creator of the socket."
11939 #: build/C/man5/proc.5:2743
11941 msgid "I</proc/net/udp>"
11944 #. type: Plain text
11945 #: build/C/man5/proc.5:2759
11947 "Holds a dump of the UDP socket table. Much of the information is not of use "
11948 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
11949 "socket, the \"local_address\" is the local address and port number pair. "
11950 "The \"rem_address\" is the remote address and port number pair (if "
11951 "connected). \"St\" is the internal status of the socket. The \"tx_queue\" "
11952 "and \"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
11953 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
11954 "used by UDP. The \"uid\" field holds the effective UID of the creator of "
11955 "the socket. The format is:"
11958 #. type: Plain text
11959 #: build/C/man5/proc.5:2767
11962 "CW<sl local_address rem_address st tx_queue rx_queue tr rexmits "
11963 "tm-E<gt>when uid\n"
11964 " 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 "
11966 " 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 "
11968 " 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 "
11973 #: build/C/man5/proc.5:2770
11975 msgid "I</proc/net/unix>"
11978 #. type: Plain text
11979 #: build/C/man5/proc.5:2775
11981 "Lists the UNIX domain sockets present within the system and their status. "
11985 #. type: Plain text
11986 #: build/C/man5/proc.5:2781
11989 "CW<Num RefCount Protocol Flags Type St Path\n"
11990 " 0: 00000002 00000000 00000000 0001 03\n"
11991 " 1: 00000001 00000000 00010000 0001 01 /dev/printer>\n"
11994 #. type: Plain text
11995 #: build/C/man5/proc.5:2793
11997 "Here \"Num\" is the kernel table slot number, \"RefCount\" is the number of "
11998 "users of the socket, \"Protocol\" is currently always 0, \"Flags\" represent "
11999 "the internal kernel flags holding the status of the socket. Currently, type "
12000 "is always \"1\" (UNIX domain datagram sockets are not yet supported in the "
12001 "kernel). \\&\"St\" is the internal state of the socket and Path is the "
12002 "bound path (if any) of the socket."
12006 #: build/C/man5/proc.5:2793
12008 msgid "I</proc/net/netfilter/nfnetlink_queue>"
12011 #. type: Plain text
12012 #: build/C/man5/proc.5:2798
12014 "This file contains information about netfilter userspace queueing, if used. "
12015 "Each line represents a queue. Queues that have not been subscribed to by "
12016 "userspace are not shown."
12019 #. type: Plain text
12020 #: build/C/man5/proc.5:2802
12023 " 1 4207 0 2 65535 0 0 0 1\n"
12024 " (1) (2) (3)(4) (5) (6) (7) (8)\n"
12027 #. type: Plain text
12028 #: build/C/man5/proc.5:2817
12030 "The ID of the queue. This matches what is specified in the B<--queue-num> "
12031 "or B<--queue-balance> options to the B<iptables>(8) NFQUEUE target. See "
12032 "B<iptables-extensions>(8) for more information."
12035 #. type: Plain text
12036 #: build/C/man5/proc.5:2820
12037 msgid "The netlink port id subscribed to the queue."
12040 #. type: Plain text
12041 #: build/C/man5/proc.5:2824
12043 "The number of packets currently queued and waiting to be processed by the "
12047 #. type: Plain text
12048 #: build/C/man5/proc.5:2828
12050 "The copy mode of the queue. It is either 1 (metadata only) or 2 (also copy "
12051 "payload data to userspace)."
12054 #. type: Plain text
12055 #: build/C/man5/proc.5:2832
12057 "Copy range, i.e. how many bytes of packet payload should be copied to "
12058 "userspace at most."
12061 #. type: Plain text
12062 #: build/C/man5/proc.5:2837
12064 "queue dropped. Number of packets that had to be dropped by the kernel "
12065 "because too many packets are already waiting for userspace to send back the "
12066 "mandatory accept/drop verdicts."
12069 #. type: Plain text
12070 #: build/C/man5/proc.5:2842
12072 "queue user dropped. Number of packets that were dropped within the netlink "
12073 "subsystem. Such drops usually happen when the corresponding socket buffer "
12074 "is full, i.e. userspace is not able to read messages fast enough."
12077 #. type: Plain text
12078 #: build/C/man5/proc.5:2847
12080 "sequence number. Every queued packet is associated with a (32-bit) "
12081 "monotonically-increasing sequence number. This shows the ID of the most "
12082 "recent packet queued."
12085 #. type: Plain text
12086 #: build/C/man5/proc.5:2850
12087 msgid "The last number only exists for compatibility reasons and is always 1."
12091 #: build/C/man5/proc.5:2850
12093 msgid "I</proc/partitions>"
12096 #. type: Plain text
12097 #: build/C/man5/proc.5:2854
12099 "Contains the major and minor numbers of each partition as well as the number "
12100 "of 1024-byte blocks and the partition name."
12104 #: build/C/man5/proc.5:2854
12106 msgid "I</proc/pci>"
12109 #. type: Plain text
12110 #: build/C/man5/proc.5:2858
12112 "This is a listing of all PCI devices found during kernel initialization and "
12113 "their configuration."
12116 #. FIXME Document /proc/sched_debug
12119 #. .IR /proc/sched_debug " (since Linux 2.6.23)"
12120 #. See also /proc/[pid]/sched
12121 #. type: Plain text
12122 #: build/C/man5/proc.5:2875
12124 "This file has been deprecated in favor of a new I</proc> interface for PCI "
12125 "(I</proc/bus/pci>). It became optional in Linux 2.2 (available with "
12126 "B<CONFIG_PCI_OLD_PROC> set at kernel compilation). It became once more "
12127 "nonoptionally enabled in Linux 2.4. Next, it was deprecated in Linux 2.6 "
12128 "(still available with B<CONFIG_PCI_LEGACY_PROC> set), and finally removed "
12129 "altogether since Linux 2.6.17."
12133 #: build/C/man5/proc.5:2875
12135 msgid "I</proc/profile> (since Linux 2.4)"
12138 #. type: Plain text
12139 #: build/C/man5/proc.5:2887
12141 "This file is present only if the kernel was booted with the I<profile=1> "
12142 "command-line option. It exposes kernel profiling information in a binary "
12143 "format for use by B<readprofile>(1). Writing (e.g., an empty string) to "
12144 "this file resets the profiling counters; on some architectures, writing a "
12145 "binary integer \"profiling multiplier\" of size I<sizeof(int)> sets the "
12146 "profiling interrupt frequency."
12150 #: build/C/man5/proc.5:2887
12152 msgid "I</proc/scsi>"
12155 #. type: Plain text
12156 #: build/C/man5/proc.5:2897
12158 "A directory with the I<scsi> mid-level pseudo-file and various SCSI "
12159 "low-level driver directories, which contain a file for each SCSI host in "
12160 "this system, all of which give the status of some part of the SCSI IO "
12161 "subsystem. These files contain ASCII structures and are, therefore, "
12162 "readable with B<cat>(1)."
12165 #. type: Plain text
12166 #: build/C/man5/proc.5:2900
12168 "You can also write to some of the files to reconfigure the subsystem or "
12169 "switch certain features on or off."
12173 #: build/C/man5/proc.5:2900
12175 msgid "I</proc/scsi/scsi>"
12178 #. type: Plain text
12179 #: build/C/man5/proc.5:2906
12181 "This is a listing of all SCSI devices known to the kernel. The listing is "
12182 "similar to the one seen during bootup. scsi currently supports only the "
12183 "I<add-single-device> command which allows root to add a hotplugged device to "
12184 "the list of known devices."
12187 #. type: Plain text
12188 #: build/C/man5/proc.5:2908
12189 msgid "The command"
12192 #. type: Plain text
12193 #: build/C/man5/proc.5:2912
12195 msgid "echo \\(aqscsi add-single-device 1 0 5 0\\(aq E<gt> /proc/scsi/scsi\n"
12198 #. type: Plain text
12199 #: build/C/man5/proc.5:2920
12201 "will cause host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. "
12202 "If there is already a device known on this address or the address is "
12203 "invalid, an error will be returned."
12207 #: build/C/man5/proc.5:2920
12209 msgid "I</proc/scsi/[drivername]>"
12212 #. type: Plain text
12213 #: build/C/man5/proc.5:2930
12215 "I<[drivername]> can currently be NCR53c7xx, aha152x, aha1542, aha1740, "
12216 "aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, "
12217 "scsi_debug, seagate, t128, u15-24f, ultrastore, or wd7000. These "
12218 "directories show up for all drivers that registered at least one SCSI HBA. "
12219 "Every directory contains one file per registered host. Every host-file is "
12220 "named after the number the host was assigned during initialization."
12223 #. type: Plain text
12224 #: build/C/man5/proc.5:2933
12226 "Reading these files will usually show driver and host configuration, "
12227 "statistics, and so on."
12230 #. type: Plain text
12231 #: build/C/man5/proc.5:2940
12233 "Writing to these files allows different things on different hosts. For "
12234 "example, with the I<latency> and I<nolatency> commands, root can switch on "
12235 "and off command latency measurement code in the eata_dma driver. With the "
12236 "I<lockup> and I<unlock> commands, root can control bus lockups simulated by "
12237 "the scsi_debug driver."
12241 #: build/C/man5/proc.5:2940
12243 msgid "I</proc/self>"
12246 #. type: Plain text
12247 #: build/C/man5/proc.5:2948
12249 "This directory refers to the process accessing the I</proc> filesystem, and "
12250 "is identical to the I</proc> directory named by the process ID of the same "
12255 #: build/C/man5/proc.5:2948
12257 msgid "I</proc/slabinfo>"
12260 #. type: Plain text
12261 #: build/C/man5/proc.5:2957
12263 "Information about kernel caches. Since Linux 2.6.16 this file is present "
12264 "only if the B<CONFIG_SLAB> kernel configuration option is enabled. The "
12265 "columns in I</proc/slabinfo> are:"
12268 #. type: Plain text
12269 #: build/C/man5/proc.5:2967
12273 "num-active-objs\n"
12276 "num-active-slabs\n"
12278 "num-pages-per-slab\n"
12281 #. type: Plain text
12282 #: build/C/man5/proc.5:2973
12283 msgid "See B<slabinfo>(5) for details."
12287 #: build/C/man5/proc.5:2973
12289 msgid "I</proc/stat>"
12292 #. type: Plain text
12293 #: build/C/man5/proc.5:2979
12295 "kernel/system statistics. Varies with architecture. Common entries "
12300 #: build/C/man5/proc.5:2980
12302 msgid "I<cpu 3357 0 4313 1362393>"
12305 #. 1024 on Alpha and ia64
12306 #. type: Plain text
12307 #: build/C/man5/proc.5:2988
12309 "The amount of time, measured in units of USER_HZ (1/100ths of a second on "
12310 "most architectures, use I<sysconf(_SC_CLK_TCK)> to obtain the right value), "
12311 "that the system spent in various states:"
12315 #: build/C/man5/proc.5:2989
12320 #. type: Plain text
12321 #: build/C/man5/proc.5:2992
12322 msgid "(1) Time spent in user mode."
12326 #: build/C/man5/proc.5:2992
12331 #. type: Plain text
12332 #: build/C/man5/proc.5:2995
12333 msgid "(2) Time spent in user mode with low priority (nice)."
12337 #: build/C/man5/proc.5:2995
12342 #. type: Plain text
12343 #: build/C/man5/proc.5:2998
12344 msgid "(3) Time spent in system mode."
12348 #: build/C/man5/proc.5:2998
12353 #. FIXME . Actually, the following info about the /proc/stat 'cpu' field
12354 #. does not seem to be quite right (at least in 2.6.12 or 3.6):
12355 #. the idle time in /proc/uptime does not quite match this value
12356 #. type: Plain text
12357 #: build/C/man5/proc.5:3008
12359 "(4) Time spent in the idle task. This value should be USER_HZ times the "
12360 "second entry in the I</proc/uptime> pseudo-file."
12364 #: build/C/man5/proc.5:3008
12366 msgid "I<iowait> (since Linux 2.5.41)"
12369 #. type: Plain text
12370 #: build/C/man5/proc.5:3011
12371 msgid "(5) Time waiting for I/O to complete."
12375 #: build/C/man5/proc.5:3011
12377 msgid "I<irq> (since Linux 2.6.0-test4)"
12380 #. type: Plain text
12381 #: build/C/man5/proc.5:3014
12382 msgid "(6) Time servicing interrupts."
12386 #: build/C/man5/proc.5:3014
12388 msgid "I<softirq> (since Linux 2.6.0-test4)"
12391 #. type: Plain text
12392 #: build/C/man5/proc.5:3017
12393 msgid "(7) Time servicing softirqs."
12397 #: build/C/man5/proc.5:3017
12399 msgid "I<steal> (since Linux 2.6.11)"
12402 #. type: Plain text
12403 #: build/C/man5/proc.5:3021
12405 "(8) Stolen time, which is the time spent in other operating systems when "
12406 "running in a virtualized environment"
12410 #: build/C/man5/proc.5:3021
12412 msgid "I<guest> (since Linux 2.6.24)"
12415 #. See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de
12416 #. type: Plain text
12417 #: build/C/man5/proc.5:3026
12419 "(9) Time spent running a virtual CPU for guest operating systems under the "
12420 "control of the Linux kernel."
12424 #: build/C/man5/proc.5:3026
12426 msgid "I<guest_nice> (since Linux 2.6.33)"
12429 #. commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797
12430 #. type: Plain text
12431 #: build/C/man5/proc.5:3031
12433 "(10) Time spent running a niced guest (virtual CPU for guest operating "
12434 "systems under the control of the Linux kernel)."
12438 #: build/C/man5/proc.5:3032
12440 msgid "I<page 5741 1808>"
12443 #. type: Plain text
12444 #: build/C/man5/proc.5:3036
12446 "The number of pages the system paged in and the number that were paged out "
12451 #: build/C/man5/proc.5:3036
12453 msgid "I<swap 1 0>"
12456 #. type: Plain text
12457 #: build/C/man5/proc.5:3039
12458 msgid "The number of swap pages that have been brought in and out."
12461 #. FIXME . The following is not the full picture for the 'intr' of
12462 #. /proc/stat on 2.6:
12464 #: build/C/man5/proc.5:3039
12466 msgid "I<intr 1462898>"
12469 #. type: Plain text
12470 #: build/C/man5/proc.5:3049
12472 "This line shows counts of interrupts serviced since boot time, for each of "
12473 "the possible system interrupts. The first column is the total of all "
12474 "interrupts serviced including unnumbered architecture specific interrupts; "
12475 "each subsequent column is the total for that particular numbered interrupt. "
12476 "Unnumbered interrupts are not shown, only summed into the total."
12480 #: build/C/man5/proc.5:3049
12482 msgid "I<disk_io: (2,0):(31,30,5764,1,2) (3,0):>..."
12485 #. type: Plain text
12486 #: build/C/man5/proc.5:3052
12488 "(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, "
12492 #. type: Plain text
12493 #: build/C/man5/proc.5:3054
12494 msgid "(Linux 2.4 only)"
12498 #: build/C/man5/proc.5:3054
12500 msgid "I<ctxt 115315>"
12503 #. type: Plain text
12504 #: build/C/man5/proc.5:3057
12505 msgid "The number of context switches that the system underwent."
12509 #: build/C/man5/proc.5:3057
12511 msgid "I<btime 769041601>"
12514 #. type: Plain text
12515 #: build/C/man5/proc.5:3060
12516 msgid "boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
12520 #: build/C/man5/proc.5:3060
12522 msgid "I<processes 86031>"
12525 #. type: Plain text
12526 #: build/C/man5/proc.5:3063
12527 msgid "Number of forks since boot."
12531 #: build/C/man5/proc.5:3063
12533 msgid "I<procs_running 6>"
12536 #. type: Plain text
12537 #: build/C/man5/proc.5:3067
12538 msgid "Number of processes in runnable state. (Linux 2.5.45 onward.)"
12542 #: build/C/man5/proc.5:3067
12544 msgid "I<procs_blocked 2>"
12547 #. type: Plain text
12548 #: build/C/man5/proc.5:3071
12550 "Number of processes blocked waiting for I/O to complete. (Linux 2.5.45 "
12555 #: build/C/man5/proc.5:3072
12557 msgid "I</proc/swaps>"
12560 #. type: Plain text
12561 #: build/C/man5/proc.5:3077
12562 msgid "Swap areas in use. See also B<swapon>(8)."
12566 #: build/C/man5/proc.5:3077
12568 msgid "I</proc/sys>"
12571 #. type: Plain text
12572 #: build/C/man5/proc.5:3085
12574 "This directory (present since 1.3.57) contains a number of files and "
12575 "subdirectories corresponding to kernel variables. These variables can be "
12576 "read and sometimes modified using the I</proc> filesystem, and the "
12577 "(deprecated) B<sysctl>(2) system call."
12581 #: build/C/man5/proc.5:3085
12583 msgid "I</proc/sys/abi> (since Linux 2.4.10)"
12586 #. On some systems, it is not present.
12587 #. type: Plain text
12588 #: build/C/man5/proc.5:3092
12590 "This directory may contain files with application binary information. See "
12591 "the Linux kernel source file I<Documentation/sysctl/abi.txt> for more "
12596 #: build/C/man5/proc.5:3092
12598 msgid "I</proc/sys/debug>"
12601 #. type: Plain text
12602 #: build/C/man5/proc.5:3095 build/C/man5/proc.5:3936
12603 msgid "This directory may be empty."
12607 #: build/C/man5/proc.5:3095
12609 msgid "I</proc/sys/dev>"
12612 #. type: Plain text
12613 #: build/C/man5/proc.5:3101
12615 "This directory contains device-specific information (e.g., "
12616 "I<dev/cdrom/info>). On some systems, it may be empty."
12620 #: build/C/man5/proc.5:3101
12622 msgid "I</proc/sys/fs>"
12625 #. type: Plain text
12626 #: build/C/man5/proc.5:3105
12628 "This directory contains the files and subdirectories for kernel variables "
12629 "related to filesystems."
12633 #: build/C/man5/proc.5:3105
12635 msgid "I</proc/sys/fs/binfmt_misc>"
12638 #. type: Plain text
12639 #: build/C/man5/proc.5:3110
12641 "Documentation for files in this directory can be found in the Linux kernel "
12642 "sources in I<Documentation/binfmt_misc.txt>."
12646 #: build/C/man5/proc.5:3110
12648 msgid "I</proc/sys/fs/dentry-state> (since Linux 2.2)"
12651 #. type: Plain text
12652 #: build/C/man5/proc.5:3118
12654 "This file contains information about the status of the directory cache "
12655 "(dcache). The file contains six numbers, I<nr_dentry>, I<nr_unused>, "
12656 "I<age_limit> (age in seconds), I<want_pages> (pages requested by system) and "
12657 "two dummy values."
12660 #. type: Plain text
12661 #: build/C/man5/proc.5:3123
12663 "I<nr_dentry> is the number of allocated dentries (dcache entries). This "
12664 "field is unused in Linux 2.2."
12667 #. type: Plain text
12668 #: build/C/man5/proc.5:3126
12669 msgid "I<nr_unused> is the number of unused dentries."
12672 #. looks like this is unused in kernels 2.2 to 2.6
12673 #. type: Plain text
12674 #: build/C/man5/proc.5:3131
12676 "I<age_limit> is the age in seconds after which dcache entries can be "
12677 "reclaimed when memory is short."
12680 #. looks like this is unused in kernels 2.2 to 2.6
12681 #. type: Plain text
12682 #: build/C/man5/proc.5:3136
12684 "I<want_pages> is nonzero when the kernel has called shrink_dcache_pages() "
12685 "and the dcache isn't pruned yet."
12689 #: build/C/man5/proc.5:3137
12691 msgid "I</proc/sys/fs/dir-notify-enable>"
12694 #. type: Plain text
12695 #: build/C/man5/proc.5:3146
12697 "This file can be used to disable or enable the I<dnotify> interface "
12698 "described in B<fcntl>(2) on a system-wide basis. A value of 0 in this file "
12699 "disables the interface, and a value of 1 enables it."
12703 #: build/C/man5/proc.5:3146
12705 msgid "I</proc/sys/fs/dquot-max>"
12708 #. type: Plain text
12709 #: build/C/man5/proc.5:3153
12711 "This file shows the maximum number of cached disk quota entries. On some "
12712 "(2.4) systems, it is not present. If the number of free cached disk quota "
12713 "entries is very low and you have some awesome number of simultaneous system "
12714 "users, you might want to raise the limit."
12718 #: build/C/man5/proc.5:3153
12720 msgid "I</proc/sys/fs/dquot-nr>"
12723 #. type: Plain text
12724 #: build/C/man5/proc.5:3157
12726 "This file shows the number of allocated disk quota entries and the number of "
12727 "free disk quota entries."
12731 #: build/C/man5/proc.5:3157
12733 msgid "I</proc/sys/fs/epoll> (since Linux 2.6.28)"
12736 #. type: Plain text
12737 #: build/C/man5/proc.5:3166
12739 "This directory contains the file I<max_user_watches>, which can be used to "
12740 "limit the amount of kernel memory consumed by the I<epoll> interface. For "
12741 "further details, see B<epoll>(7)."
12745 #: build/C/man5/proc.5:3166
12747 msgid "I</proc/sys/fs/file-max>"
12750 #. type: Plain text
12751 #: build/C/man5/proc.5:3179
12753 "This file defines a system-wide limit on the number of open files for all "
12754 "processes. (See also B<setrlimit>(2), which can be used by a process to set "
12755 "the per-process limit, B<RLIMIT_NOFILE>, on the number of files it may "
12756 "open.) If you get lots of error messages in the kernel log about running "
12757 "out of file handles (look for \"VFS: file-max limit E<lt>numberE<gt> "
12758 "reached\"), try increasing this value:"
12761 #. type: Plain text
12762 #: build/C/man5/proc.5:3185
12764 msgid "CW< echo 100000 E<gt> /proc/sys/fs/file-max>\n"
12767 #. type: Plain text
12768 #: build/C/man5/proc.5:3193
12769 msgid "Privileged processes (B<CAP_SYS_ADMIN>) can override the I<file-max> limit."
12773 #: build/C/man5/proc.5:3193
12775 msgid "I</proc/sys/fs/file-nr>"
12778 #. type: Plain text
12779 #: build/C/man5/proc.5:3212
12781 "This (read-only) file contains three numbers: the number of allocated file "
12782 "handles (i.e., the number of files presently opened); the number of free "
12783 "file handles; and the maximum number of file handles (i.e., the same value "
12784 "as I</proc/sys/fs/file-max>). If the number of allocated file handles is "
12785 "close to the maximum, you should consider increasing the maximum. Before "
12786 "Linux 2.6, the kernel allocated file handles dynamically, but it didn't free "
12787 "them again. Instead the free file handles were kept in a list for "
12788 "reallocation; the \"free file handles\" value indicates the size of that "
12789 "list. A large number of free file handles indicates that there was a past "
12790 "peak in the usage of open file handles. Since Linux 2.6, the kernel does "
12791 "deallocate freed file handles, and the \"free file handles\" value is always "
12796 #: build/C/man5/proc.5:3212
12798 msgid "I</proc/sys/fs/inode-max> (only present until Linux 2.2)"
12801 #. type: Plain text
12802 #: build/C/man5/proc.5:3221
12804 "This file contains the maximum number of in-memory inodes. This value "
12805 "should be 3-4 times larger than the value in I<file-max>, since I<stdin>, "
12806 "I<stdout> and network sockets also need an inode to handle them. When you "
12807 "regularly run out of inodes, you need to increase this value."
12810 #. type: Plain text
12811 #: build/C/man5/proc.5:3225
12813 "Starting with Linux 2.4, there is no longer a static limit on the number of "
12814 "inodes, and this file is removed."
12818 #: build/C/man5/proc.5:3225
12820 msgid "I</proc/sys/fs/inode-nr>"
12823 #. type: Plain text
12824 #: build/C/man5/proc.5:3229
12825 msgid "This file contains the first two values from I<inode-state>."
12829 #: build/C/man5/proc.5:3229
12831 msgid "I</proc/sys/fs/inode-state>"
12834 #. type: Plain text
12835 #: build/C/man5/proc.5:3237
12837 "This file contains seven numbers: I<nr_inodes>, I<nr_free_inodes>, "
12838 "I<preshrink>, and four dummy values (always zero)."
12841 #. This can be slightly more than
12843 #. because Linux allocates them one page full at a time.
12844 #. type: Plain text
12845 #: build/C/man5/proc.5:3245
12847 "I<nr_inodes> is the number of inodes the system has allocated. "
12848 "I<nr_free_inodes> represents the number of free inodes."
12851 #. type: Plain text
12852 #: build/C/man5/proc.5:3253
12854 "I<preshrink> is nonzero when the I<nr_inodes> E<gt> I<inode-max> and the "
12855 "system needs to prune the inode list instead of allocating more; since Linux "
12856 "2.4, this field is a dummy value (always zero)."
12860 #: build/C/man5/proc.5:3253
12862 msgid "I</proc/sys/fs/inotify> (since Linux 2.6.13)"
12865 #. type: Plain text
12866 #: build/C/man5/proc.5:3262
12868 "This directory contains files I<max_queued_events>, I<max_user_instances>, "
12869 "and I<max_user_watches>, that can be used to limit the amount of kernel "
12870 "memory consumed by the I<inotify> interface. For further details, see "
12875 #: build/C/man5/proc.5:3262
12877 msgid "I</proc/sys/fs/lease-break-time>"
12880 #. type: Plain text
12881 #: build/C/man5/proc.5:3271
12883 "This file specifies the grace period that the kernel grants to a process "
12884 "holding a file lease (B<fcntl>(2)) after it has sent a signal to that "
12885 "process notifying it that another process is waiting to open the file. If "
12886 "the lease holder does not remove or downgrade the lease within this grace "
12887 "period, the kernel forcibly breaks the lease."
12891 #: build/C/man5/proc.5:3271
12893 msgid "I</proc/sys/fs/leases-enable>"
12896 #. type: Plain text
12897 #: build/C/man5/proc.5:3278
12899 "This file can be used to enable or disable file leases (B<fcntl>(2)) on a "
12900 "system-wide basis. If this file contains the value 0, leases are disabled. "
12901 "A nonzero value enables leases."
12905 #: build/C/man5/proc.5:3278
12907 msgid "I</proc/sys/fs/mqueue> (since Linux 2.6.6)"
12910 #. type: Plain text
12911 #: build/C/man5/proc.5:3286
12913 "This directory contains files I<msg_max>, I<msgsize_max>, and I<queues_max>, "
12914 "controlling the resources used by POSIX message queues. See "
12915 "B<mq_overview>(7) for details."
12919 #: build/C/man5/proc.5:3286
12921 msgid "I</proc/sys/fs/nr_open> (since Linux 2.6.25)"
12924 #. commit 9cfe015aa424b3c003baba3841a60dd9b5ad319b
12925 #. type: Plain text
12926 #: build/C/man5/proc.5:3298
12928 "This file imposes ceiling on the value to which the B<RLIMIT_NOFILE> "
12929 "resource limit can be raised (see B<getrlimit>(2)). This ceiling is "
12930 "enforced for both unprivileged and privileged process. The default value in "
12931 "this file is 1048576. (Before Linux 2.6.25, the ceiling for "
12932 "B<RLIMIT_NOFILE> was hard-coded to the same value.)"
12936 #: build/C/man5/proc.5:3298
12938 msgid "I</proc/sys/fs/overflowgid> and I</proc/sys/fs/overflowuid>"
12941 #. type: Plain text
12942 #: build/C/man5/proc.5:3308
12944 "These files allow you to change the value of the fixed UID and GID. The "
12945 "default is 65534. Some filesystems support only 16-bit UIDs and GIDs, "
12946 "although in Linux UIDs and GIDs are 32 bits. When one of these filesystems "
12947 "is mounted with writes enabled, any UID or GID that would exceed 65535 is "
12948 "translated to the overflow value before being written to disk."
12952 #: build/C/man5/proc.5:3308
12954 msgid "I</proc/sys/fs/pipe-max-size> (since Linux 2.6.35)"
12957 #. type: Plain text
12958 #: build/C/man5/proc.5:3322
12960 "The value in this file defines an upper limit for raising the capacity of a "
12961 "pipe using the B<fcntl>(2) B<F_SETPIPE_SZ> operation. This limit applies "
12962 "only to unprivileged processes. The default value for this file is "
12963 "1,048,576. The value assigned to this file may be rounded upward, to "
12964 "reflect the value actually employed for a convenient implementation. To "
12965 "determine the rounded-up value, display the contents of this file after "
12966 "assigning a value to it. The minimum value that can be assigned to this "
12967 "file is the system page size."
12971 #: build/C/man5/proc.5:3322
12973 msgid "I</proc/sys/fs/protected_hardlinks> (since Linux 3.6)"
12976 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
12977 #. type: Plain text
12978 #: build/C/man5/proc.5:3331
12980 "When the value in this file is 0, no restrictions are placed on the creation "
12981 "of hard links (i.e., this is the historical behavior before Linux 3.6). "
12982 "When the value in this file is 1, a hard link can be created to a target "
12983 "file only if one of the following conditions is true:"
12986 #. type: Plain text
12987 #: build/C/man5/proc.5:3336
12988 msgid "The caller has the B<CAP_FOWNER> capability."
12991 #. type: Plain text
12992 #: build/C/man5/proc.5:3342
12994 "The filesystem UID of the process creating the link matches the owner (UID) "
12995 "of the target file (as described in B<credentials>(7), a process's "
12996 "filesystem UID is normally the same as its effective UID)."
12999 #. type: Plain text
13000 #: build/C/man5/proc.5:3344
13001 msgid "All of the following conditions are true:"
13004 #. type: Plain text
13005 #: build/C/man5/proc.5:3347
13006 msgid "the target is a regular file;"
13009 #. type: Plain text
13010 #: build/C/man5/proc.5:3349
13011 msgid "the target file does not have its set-user-ID permission bit enabled;"
13014 #. type: Plain text
13015 #: build/C/man5/proc.5:3352
13017 "the target file does not have both its set-group-ID and group-executable "
13018 "permission bits enabled; and"
13021 #. type: Plain text
13022 #: build/C/man5/proc.5:3356
13024 "the caller has permission to read and write the target file (either via the "
13025 "file's permissions mask or because it has suitable capabilities)."
13028 #. type: Plain text
13029 #: build/C/man5/proc.5:3372
13031 "The default value in this file is 0. Setting the value to 1 prevents a "
13032 "longstanding class of security issues caused by hard-link-based "
13033 "time-of-check, time-of-use races, most commonly seen in world-writable "
13034 "directories such as I</tmp>. The common method of exploiting this flaw is "
13035 "to cross privilege boundaries when following a given hard link (i.e., a root "
13036 "process follows a hard link created by another user). Additionally, on "
13037 "systems without separated partitions, this stops unauthorized users from "
13038 "\"pinning\" vulnerable set-user-ID and set-group-ID files against being "
13039 "upgraded by the administrator, or linking to special files."
13043 #: build/C/man5/proc.5:3372
13045 msgid "I</proc/sys/fs/protected_symlinks> (since Linux 3.6)"
13048 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
13049 #. type: Plain text
13050 #: build/C/man5/proc.5:3380
13052 "When the value in this file is 0, no restrictions are placed on following "
13053 "symbolic links (i.e., this is the historical behavior before Linux 3.6). "
13054 "When the value in this file is 1, symbolic links are followed only in the "
13055 "following circumstances:"
13058 #. type: Plain text
13059 #: build/C/man5/proc.5:3387
13061 "the filesystem UID of the process following the link matches the owner (UID) "
13062 "of the symbolic link (as described in B<credentials>(7), a process's "
13063 "filesystem UID is normally the same as its effective UID);"
13066 #. type: Plain text
13067 #: build/C/man5/proc.5:3389
13068 msgid "the link is not in a sticky world-writable directory; or"
13071 #. type: Plain text
13072 #: build/C/man5/proc.5:3391
13073 msgid "the symbolic link and its parent directory have the same owner (UID)"
13076 #. type: Plain text
13077 #: build/C/man5/proc.5:3398
13079 "A system call that fails to follow a symbolic link because of the above "
13080 "restrictions returns the error B<EACCES> in I<errno>."
13083 #. type: Plain text
13084 #: build/C/man5/proc.5:3402
13086 "The default value in this file is 0. Setting the value to 1 avoids a "
13087 "longstanding class of security issues based on time-of-check, time-of-use "
13088 "races when accessing symbolic links."
13092 #: build/C/man5/proc.5:3402
13094 msgid "I</proc/sys/fs/suid_dumpable> (since Linux 2.6.13)"
13097 #. The following is based on text from Documentation/sysctl/kernel.txt
13098 #. type: Plain text
13099 #: build/C/man5/proc.5:3408
13101 "The value in this file determines whether core dump files are produced for "
13102 "set-user-ID or otherwise protected/tainted binaries. Three different "
13103 "integer values can be specified:"
13107 #: build/C/man5/proc.5:3409
13109 msgid "I<0\\ (default)>"
13112 #. type: Plain text
13113 #: build/C/man5/proc.5:3418
13115 "This provides the traditional (pre-Linux 2.6.13) behavior. A core dump will "
13116 "not be produced for a process which has changed credentials (by calling "
13117 "B<seteuid>(2), B<setgid>(2), or similar, or by executing a set-user-ID or "
13118 "set-group-ID program) or whose binary does not have read permission "
13123 #: build/C/man5/proc.5:3418
13125 msgid "I<1\\ (\"debug\")>"
13128 #. type: Plain text
13129 #: build/C/man5/proc.5:3425
13131 "All processes dump core when possible. The core dump is owned by the "
13132 "filesystem user ID of the dumping process and no security is applied. This "
13133 "is intended for system debugging situations only. Ptrace is unchecked."
13137 #: build/C/man5/proc.5:3425
13139 msgid "I<2\\ (\"suidsafe\")>"
13142 #. type: Plain text
13143 #: build/C/man5/proc.5:3434
13145 "Any binary which normally would not be dumped (see \"0\" above) is dumped "
13146 "readable by root only. This allows the user to remove the core dump file "
13147 "but not to read it. For security reasons core dumps in this mode will not "
13148 "overwrite one another or other files. This mode is appropriate when "
13149 "administrators are attempting to debug problems in a normal environment."
13152 #. 9520628e8ceb69fa9a4aee6b57f22675d9e1b709
13153 #. 54b501992dd2a839e94e76aa392c392b55080ce8
13154 #. type: Plain text
13155 #: build/C/man5/proc.5:3445
13157 "Additionally, since Linux 3.6, I</proc/sys/kernel/core_pattern> must either "
13158 "be an absolute pathname or a pipe command, as detailed in B<core>(5). "
13159 "Warnings will be written to the kernel log if I<core_pattern> does not "
13160 "follow these rules, and no core dump will be produced."
13164 #: build/C/man5/proc.5:3446
13166 msgid "I</proc/sys/fs/super-max>"
13169 #. type: Plain text
13170 #: build/C/man5/proc.5:3457
13172 "This file controls the maximum number of superblocks, and thus the maximum "
13173 "number of mounted filesystems the kernel can have. You need increase only "
13174 "I<super-max> if you need to mount more filesystems than the current value in "
13175 "I<super-max> allows you to."
13179 #: build/C/man5/proc.5:3457
13181 msgid "I</proc/sys/fs/super-nr>"
13184 #. type: Plain text
13185 #: build/C/man5/proc.5:3461
13186 msgid "This file contains the number of filesystems currently mounted."
13190 #: build/C/man5/proc.5:3461
13192 msgid "I</proc/sys/kernel>"
13195 #. type: Plain text
13196 #: build/C/man5/proc.5:3465
13198 "This directory contains files controlling a range of kernel parameters, as "
13203 #: build/C/man5/proc.5:3465
13205 msgid "I</proc/sys/kernel/acct>"
13208 #. type: Plain text
13209 #: build/C/man5/proc.5:3489
13211 "This file contains three numbers: I<highwater>, I<lowwater>, and "
13212 "I<frequency>. If BSD-style process accounting is enabled, these values "
13213 "control its behavior. If free space on filesystem where the log lives goes "
13214 "below I<lowwater> percent, accounting suspends. If free space gets above "
13215 "I<highwater> percent, accounting resumes. I<frequency> determines how often "
13216 "the kernel checks the amount of free space (value is in seconds). Default "
13217 "values are 4, 2 and 30. That is, suspend accounting if 2% or less space is "
13218 "free; resume it if 4% or more space is free; consider information about "
13219 "amount of free space valid for 30 seconds."
13223 #: build/C/man5/proc.5:3489
13225 msgid "I</proc/sys/kernel/cap_last_cap> (since Linux 3.2)"
13228 #. type: Plain text
13229 #: build/C/man5/proc.5:3493
13230 msgid "See B<capabilities>(7)."
13234 #: build/C/man5/proc.5:3493
13236 msgid "I</proc/sys/kernel/cap-bound> (from Linux 2.2 to 2.6.24)"
13239 #. type: Plain text
13240 #: build/C/man5/proc.5:3505
13242 "This file holds the value of the kernel I<capability bounding set> "
13243 "(expressed as a signed decimal number). This set is ANDed against the "
13244 "capabilities permitted to a process during B<execve>(2). Starting with "
13245 "Linux 2.6.25, the system-wide capability bounding set disappeared, and was "
13246 "replaced by a per-thread bounding set; see B<capabilities>(7)."
13250 #: build/C/man5/proc.5:3505
13252 msgid "I</proc/sys/kernel/core_pattern>"
13256 #: build/C/man5/proc.5:3509
13258 msgid "I</proc/sys/kernel/core_uses_pid>"
13262 #: build/C/man5/proc.5:3513
13264 msgid "I</proc/sys/kernel/ctrl-alt-del>"
13267 #. type: Plain text
13268 #: build/C/man5/proc.5:3528
13270 "This file controls the handling of Ctrl-Alt-Del from the keyboard. When the "
13271 "value in this file is 0, Ctrl-Alt-Del is trapped and sent to the B<init>(1) "
13272 "program to handle a graceful restart. When the value is greater than zero, "
13273 "Linux's reaction to a Vulcan Nerve Pinch (tm) will be an immediate reboot, "
13274 "without even syncing its dirty buffers. Note: when a program (like dosemu) "
13275 "has the keyboard in \"raw\" mode, the ctrl-alt-del is intercepted by the "
13276 "program before it ever reaches the kernel tty layer, and it's up to the "
13277 "program to decide what to do with it."
13281 #: build/C/man5/proc.5:3528
13283 msgid "I</proc/sys/kernel/dmesg_restrict> (since Linux 2.6.37)"
13286 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
13287 #. type: Plain text
13288 #: build/C/man5/proc.5:3541
13290 "The value in this file determines who can see kernel syslog contents. A "
13291 "value of 0 in this file imposes no restrictions. If the value is 1, only "
13292 "privileged users can read the kernel syslog. (See B<syslog>(2) for more "
13293 "details.) Since Linux 3.4, only users with the B<CAP_SYS_ADMIN> capability "
13294 "may change the value in this file."
13298 #: build/C/man5/proc.5:3541
13300 msgid "I</proc/sys/kernel/domainname> and I</proc/sys/kernel/hostname>"
13303 #. type: Plain text
13304 #: build/C/man5/proc.5:3549
13306 "can be used to set the NIS/YP domainname and the hostname of your box in "
13307 "exactly the same way as the commands B<domainname>(1) and B<hostname>(1), "
13311 #. type: Plain text
13312 #: build/C/man5/proc.5:3554
13315 "#B< echo \\(aqdarkstar\\(aq E<gt> /proc/sys/kernel/hostname>\n"
13316 "#B< echo \\(aqmydomain\\(aq E<gt> /proc/sys/kernel/domainname>\n"
13319 #. type: Plain text
13320 #: build/C/man5/proc.5:3558
13321 msgid "has the same effect as"
13324 #. type: Plain text
13325 #: build/C/man5/proc.5:3563
13328 "#B< hostname \\(aqdarkstar\\(aq>\n"
13329 "#B< domainname \\(aqmydomain\\(aq>\n"
13332 #. type: Plain text
13333 #: build/C/man5/proc.5:3576
13335 "Note, however, that the classic darkstar.frop.org has the hostname "
13336 "\"darkstar\" and DNS (Internet Domain Name Server) domainname \"frop.org\", "
13337 "not to be confused with the NIS (Network Information Service) or YP (Yellow "
13338 "Pages) domainname. These two domain names are in general different. For a "
13339 "detailed discussion see the B<hostname>(1) man page."
13343 #: build/C/man5/proc.5:3576
13345 msgid "I</proc/sys/kernel/hotplug>"
13348 #. type: Plain text
13349 #: build/C/man5/proc.5:3582
13351 "This file contains the path for the hotplug policy agent. The default value "
13352 "in this file is I</sbin/hotplug>."
13356 #: build/C/man5/proc.5:3582
13358 msgid "I</proc/sys/kernel/htab-reclaim>"
13361 #. type: Plain text
13362 #: build/C/man5/proc.5:3590
13364 "(PowerPC only) If this file is set to a nonzero value, the PowerPC htab (see "
13365 "kernel file I<Documentation/powerpc/ppc_htab.txt>) is pruned each time the "
13366 "system hits the idle loop."
13370 #: build/C/man5/proc.5:3590
13372 msgid "I</proc/sys/kernel/kptr_restrict> (since Linux 2.6.38)"
13375 #. 455cd5ab305c90ffc422dd2e0fb634730942b257
13376 #. commit 411f05f123cbd7f8aa1edcae86970755a6e2a9d9
13377 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
13378 #. type: Plain text
13379 #: build/C/man5/proc.5:3615
13381 "The value in this file determines whether kernel addresses are exposed via "
13382 "I</proc> files and other interfaces. A value of 0 in this file imposes no "
13383 "restrictions. If the value is 1, kernel pointers printed using the I<%pK> "
13384 "format specifier will be replaced with zeros unless the user has the "
13385 "B<CAP_SYSLOG> capability. If the value is 2, kernel pointers printed using "
13386 "the I<%pK> format specifier will be replaced with zeros regardless of the "
13387 "user's capabilities. The initial default value for this file was 1, but the "
13388 "default was changed to 0 in Linux 2.6.39. Since Linux 3.4, only users with "
13389 "the B<CAP_SYS_ADMIN> capability can change the value in this file."
13393 #: build/C/man5/proc.5:3615
13395 msgid "I</proc/sys/kernel/l2cr>"
13398 #. type: Plain text
13399 #: build/C/man5/proc.5:3622
13401 "(PowerPC only) This file contains a flag that controls the L2 cache of G3 "
13402 "processor boards. If 0, the cache is disabled. Enabled if nonzero."
13406 #: build/C/man5/proc.5:3622
13408 msgid "I</proc/sys/kernel/modprobe>"
13411 #. type: Plain text
13412 #: build/C/man5/proc.5:3635
13414 "This file contains the path for the kernel module loader. The default value "
13415 "is I</sbin/modprobe>. The file is present only if the kernel is built with "
13416 "the B<CONFIG_MODULES> (B<CONFIG_KMOD> in Linux 2.6.26 and earlier) option "
13417 "enabled. It is described by the Linux kernel source file "
13418 "I<Documentation/kmod.txt> (present only in kernel 2.4 and earlier)."
13422 #: build/C/man5/proc.5:3635
13424 msgid "I</proc/sys/kernel/modules_disabled> (since Linux 2.6.31)"
13427 #. 3d43321b7015387cfebbe26436d0e9d299162ea1
13428 #. From Documentation/sysctl/kernel.txt
13429 #. type: Plain text
13430 #: build/C/man5/proc.5:3647
13432 "A toggle value indicating if modules are allowed to be loaded in an "
13433 "otherwise modular kernel. This toggle defaults to off (0), but can be set "
13434 "true (1). Once true, modules can be neither loaded nor unloaded, and the "
13435 "toggle cannot be set back to false. The file is present only if the kernel "
13436 "is built with the B<CONFIG_MODULES> option enabled."
13440 #: build/C/man5/proc.5:3647
13442 msgid "I</proc/sys/kernel/msgmax> (since Linux 2.2)"
13445 #. type: Plain text
13446 #: build/C/man5/proc.5:3652
13448 "This file defines a system-wide limit specifying the maximum number of bytes "
13449 "in a single message written on a System V message queue."
13453 #: build/C/man5/proc.5:3652
13455 msgid "I</proc/sys/kernel/msgmni> (since Linux 2.4)"
13458 #. type: Plain text
13459 #: build/C/man5/proc.5:3656
13461 "This file defines the system-wide limit on the number of message queue "
13466 #: build/C/man5/proc.5:3656
13468 msgid "I</proc/sys/kernel/msgmnb> (since Linux 2.2)"
13471 #. type: Plain text
13472 #: build/C/man5/proc.5:3665
13474 "This file defines a system-wide parameter used to initialize the "
13475 "I<msg_qbytes> setting for subsequently created message queues. The "
13476 "I<msg_qbytes> setting specifies the maximum number of bytes that may be "
13477 "written to the message queue."
13481 #: build/C/man5/proc.5:3665
13483 msgid "I</proc/sys/kernel/ngroups_max> (since Linux 2.6.4)"
13486 #. type: Plain text
13487 #: build/C/man5/proc.5:3669
13489 "This is a read-only file that displays the upper limit on the number of a "
13490 "process's group memberships."
13494 #: build/C/man5/proc.5:3669
13496 msgid "I</proc/sys/kernel/ostype> and I</proc/sys/kernel/osrelease>"
13499 #. type: Plain text
13500 #: build/C/man5/proc.5:3674
13501 msgid "These files give substrings of I</proc/version>."
13505 #: build/C/man5/proc.5:3674
13507 msgid "I</proc/sys/kernel/overflowgid> and I</proc/sys/kernel/overflowuid>"
13510 #. type: Plain text
13511 #: build/C/man5/proc.5:3680
13513 "These files duplicate the files I</proc/sys/fs/overflowgid> and "
13514 "I</proc/sys/fs/overflowuid>."
13518 #: build/C/man5/proc.5:3680
13520 msgid "I</proc/sys/kernel/panic>"
13523 #. type: Plain text
13524 #: build/C/man5/proc.5:3689
13526 "This file gives read/write access to the kernel variable I<panic_timeout>. "
13527 "If this is zero, the kernel will loop on a panic; if nonzero, it indicates "
13528 "that the kernel should autoreboot after this number of seconds. When you "
13529 "use the software watchdog device driver, the recommended setting is 60."
13533 #: build/C/man5/proc.5:3689
13535 msgid "I</proc/sys/kernel/panic_on_oops> (since Linux 2.5.68)"
13538 #. type: Plain text
13539 #: build/C/man5/proc.5:3701
13541 "This file controls the kernel's behavior when an oops or BUG is "
13542 "encountered. If this file contains 0, then the system tries to continue "
13543 "operation. If it contains 1, then the system delays a few seconds (to give "
13544 "klogd time to record the oops output) and then panics. If the "
13545 "I</proc/sys/kernel/panic> file is also nonzero, then the machine will be "
13550 #: build/C/man5/proc.5:3701
13552 msgid "I</proc/sys/kernel/pid_max> (since Linux 2.5.34)"
13555 #. Prior to 2.6.10, pid_max could also be raised above 32768 on 32-bit
13556 #. platforms, but this broke /proc/[pid]
13557 #. See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2
13558 #. type: Plain text
13559 #: build/C/man5/proc.5:3720
13561 "This file specifies the value at which PIDs wrap around (i.e., the value in "
13562 "this file is one greater than the maximum PID). PIDs greater than this "
13563 "value are not allocated; thus, the value in this file also acts as a "
13564 "system-wide limit on the total number of processes and threads. The default "
13565 "value for this file, 32768, results in the same range of PIDs as on earlier "
13566 "kernels. On 32-bit platforms, 32768 is the maximum value for I<pid_max>. "
13567 "On 64-bit systems, I<pid_max> can be set to any value up to 2^22 "
13568 "(B<PID_MAX_LIMIT>, approximately 4 million)."
13572 #: build/C/man5/proc.5:3720
13574 msgid "I</proc/sys/kernel/powersave-nap> (PowerPC only)"
13577 #. type: Plain text
13578 #: build/C/man5/proc.5:3726
13580 "This file contains a flag. If set, Linux-PPC will use the \"nap\" mode of "
13581 "powersaving, otherwise the \"doze\" mode will be used."
13585 #: build/C/man5/proc.5:3726
13587 msgid "I</proc/sys/kernel/printk>"
13590 #. type: Plain text
13591 #: build/C/man5/proc.5:3730
13592 msgid "See B<syslog>(2)."
13596 #: build/C/man5/proc.5:3730
13598 msgid "I</proc/sys/kernel/pty> (since Linux 2.6.4)"
13601 #. type: Plain text
13602 #: build/C/man5/proc.5:3736
13604 "This directory contains two files relating to the number of UNIX 98 "
13605 "pseudoterminals (see B<pts>(4)) on the system."
13609 #: build/C/man5/proc.5:3736
13611 msgid "I</proc/sys/kernel/pty/max>"
13614 #. type: Plain text
13615 #: build/C/man5/proc.5:3739
13616 msgid "This file defines the maximum number of pseudoterminals."
13620 #: build/C/man5/proc.5:3739
13622 msgid "I</proc/sys/kernel/pty/nr>"
13625 #. type: Plain text
13626 #: build/C/man5/proc.5:3743
13627 msgid "This read-only file indicates how many pseudoterminals are currently in use."
13631 #: build/C/man5/proc.5:3743
13633 msgid "I</proc/sys/kernel/random>"
13636 #. type: Plain text
13637 #: build/C/man5/proc.5:3751
13639 "This directory contains various parameters controlling the operation of the "
13640 "file I</dev/random>. See B<random>(4) for further information."
13644 #: build/C/man5/proc.5:3751
13646 msgid "I</proc/sys/kernel/random/uuid> (since Linux 2.4)"
13649 #. type: Plain text
13650 #: build/C/man5/proc.5:3755
13652 "Each read from this read-only file returns a randomly generated 128-bit "
13653 "UUID, as a string in the standard UUID format."
13657 #: build/C/man5/proc.5:3755
13659 msgid "I</proc/sys/kernel/real-root-dev>"
13662 #. type: Plain text
13663 #: build/C/man5/proc.5:3759
13665 "This file is documented in the Linux kernel source file "
13666 "I<Documentation/initrd.txt>."
13670 #: build/C/man5/proc.5:3759
13672 msgid "I</proc/sys/kernel/reboot-cmd> (Sparc only) "
13675 #. type: Plain text
13676 #: build/C/man5/proc.5:3765
13678 "This file seems to be a way to give an argument to the SPARC ROM/Flash boot "
13679 "loader. Maybe to tell it what to do after rebooting?"
13683 #: build/C/man5/proc.5:3765
13685 msgid "I</proc/sys/kernel/rtsig-max>"
13688 #. type: Plain text
13689 #: build/C/man5/proc.5:3772
13691 "(Only in kernels up to and including 2.6.7; see B<setrlimit>(2)) This file "
13692 "can be used to tune the maximum number of POSIX real-time (queued) signals "
13693 "that can be outstanding in the system."
13697 #: build/C/man5/proc.5:3772
13699 msgid "I</proc/sys/kernel/rtsig-nr>"
13702 #. type: Plain text
13703 #: build/C/man5/proc.5:3776
13705 "(Only in kernels up to and including 2.6.7.) This file shows the number "
13706 "POSIX real-time signals currently queued."
13710 #: build/C/man5/proc.5:3776
13712 msgid "I</proc/sys/kernel/sched_rr_timeslice_ms> (since Linux 3.9)"
13715 #. type: Plain text
13716 #: build/C/man5/proc.5:3780
13717 msgid "See B<sched_rr_get_interval>(2)."
13721 #: build/C/man5/proc.5:3780
13723 msgid "I</proc/sys/kernel/sched_rt_period_us> (Since Linux 2.6.25)"
13726 #. type: Plain text
13727 #: build/C/man5/proc.5:3784 build/C/man5/proc.5:3788
13728 msgid "See B<sched>(7)."
13732 #: build/C/man5/proc.5:3784
13734 msgid "I</proc/sys/kernel/sched_rt_runtime_us> (Since Linux 2.6.25)"
13738 #: build/C/man5/proc.5:3788
13740 msgid "I</proc/sys/kernel/sem> (since Linux 2.4)"
13743 #. type: Plain text
13744 #: build/C/man5/proc.5:3792
13746 "This file contains 4 numbers defining limits for System V IPC semaphores. "
13747 "These fields are, in order:"
13751 #: build/C/man5/proc.5:3793
13756 #. type: Plain text
13757 #: build/C/man5/proc.5:3795
13758 msgid "The maximum semaphores per semaphore set."
13762 #: build/C/man5/proc.5:3795
13767 #. type: Plain text
13768 #: build/C/man5/proc.5:3797
13769 msgid "A system-wide limit on the number of semaphores in all semaphore sets."
13773 #: build/C/man5/proc.5:3797
13778 #. type: Plain text
13779 #: build/C/man5/proc.5:3801
13781 "The maximum number of operations that may be specified in a B<semop>(2) "
13786 #: build/C/man5/proc.5:3801
13791 #. type: Plain text
13792 #: build/C/man5/proc.5:3803
13793 msgid "A system-wide limit on the maximum number of semaphore identifiers."
13797 #: build/C/man5/proc.5:3804
13799 msgid "I</proc/sys/kernel/sg-big-buff>"
13802 #. type: Plain text
13803 #: build/C/man5/proc.5:3815
13805 "This file shows the size of the generic SCSI device (sg) buffer. You can't "
13806 "tune it just yet, but you could change it at compile time by editing "
13807 "I<include/scsi/sg.h> and changing the value of B<SG_BIG_BUFF>. However, "
13808 "there shouldn't be any reason to change this value."
13812 #: build/C/man5/proc.5:3815
13814 msgid "I</proc/sys/kernel/shm_rmid_forced> (since Linux 3.1)"
13817 #. commit b34a6b1da371ed8af1221459a18c67970f7e3d53
13818 #. See also Documentation/sysctl/kernel.txt
13819 #. type: Plain text
13820 #: build/C/man5/proc.5:3824
13822 "If this file is set to 1, all System V shared memory segments will be marked "
13823 "for destruction as soon as the number of attached processes falls to zero; "
13824 "in other words, it is no longer possible to create shared memory segments "
13825 "that exist independently of any attached process."
13828 #. type: Plain text
13829 #: build/C/man5/proc.5:3836
13831 "The effect is as though a B<shmctl>(2) B<IPC_RMID> is performed on all "
13832 "existing segments as well as all segments created in the future (until this "
13833 "file is reset to 0). Note that existing segments that are attached to no "
13834 "process will be immediately destroyed when this file is set to 1. Setting "
13835 "this option will also destroy segments that were created, but never "
13836 "attached, upon termination of the process that created the segment with "
13840 #. type: Plain text
13841 #: build/C/man5/proc.5:3844
13843 "Setting this file to 1 provides a way of ensuring that all System V shared "
13844 "memory segments are counted against the resource usage and resource limits "
13845 "(see the description of B<RLIMIT_AS> in B<getrlimit>(2)) of at least one "
13849 #. type: Plain text
13850 #: build/C/man5/proc.5:3851
13852 "Because setting this file to 1 produces behavior that is nonstandard and "
13853 "could also break existing applications, the default value in this file is "
13854 "0. Only set this file to 1 if you have a good understanding of the "
13855 "semantics of the applications using System V shared memory on your system."
13859 #: build/C/man5/proc.5:3851
13861 msgid "I</proc/sys/kernel/shmall> (since Linux 2.2)"
13864 #. type: Plain text
13865 #: build/C/man5/proc.5:3856
13867 "This file contains the system-wide limit on the total number of pages of "
13868 "System V shared memory."
13872 #: build/C/man5/proc.5:3856
13874 msgid "I</proc/sys/kernel/shmmax> (since Linux 2.2)"
13877 #. type: Plain text
13878 #: build/C/man5/proc.5:3866
13880 "This file can be used to query and set the run-time limit on the maximum "
13881 "(System V IPC) shared memory segment size that can be created. Shared "
13882 "memory segments up to 1GB are now supported in the kernel. This value "
13883 "defaults to B<SHMMAX>."
13887 #: build/C/man5/proc.5:3866
13889 msgid "I</proc/sys/kernel/shmmni> (since Linux 2.4)"
13892 #. type: Plain text
13893 #: build/C/man5/proc.5:3871
13895 "This file specifies the system-wide maximum number of System V shared memory "
13896 "segments that can be created."
13900 #: build/C/man5/proc.5:3871
13902 msgid "I</proc/sys/kernel/sysrq>"
13905 #. type: Plain text
13906 #: build/C/man5/proc.5:3880
13908 "This file controls the functions allowed to be invoked by the SysRq key. By "
13909 "default, the file contains 1 meaning that every possible SysRq request is "
13910 "allowed (in older kernel versions, SysRq was disabled by default, and you "
13911 "were required to specifically enable it at run-time, but this is not the "
13912 "case any more). Possible values in this file are:"
13915 #. type: Plain text
13916 #: build/C/man5/proc.5:3892
13919 " 0 - disable sysrq completely\n"
13920 " 1 - enable all functions of sysrq\n"
13921 " E<gt>1 - bit mask of allowed sysrq functions, as follows:\n"
13922 " 2 - enable control of console logging level\n"
13923 " 4 - enable control of keyboard (SAK, unraw)\n"
13924 " 8 - enable debugging dumps of processes etc.\n"
13925 " 16 - enable sync command\n"
13926 " 32 - enable remount read-only\n"
13927 " 64 - enable signaling of processes (term, kill, oom-kill)\n"
13928 " 128 - allow reboot/poweroff\n"
13929 " 256 - allow nicing of all real-time tasks\n"
13932 #. type: Plain text
13933 #: build/C/man5/proc.5:3898
13935 "This file is present only if the B<CONFIG_MAGIC_SYSRQ> kernel configuration "
13936 "option is enabled. For further details see the Linux kernel source file "
13937 "I<Documentation/sysrq.txt>."
13941 #: build/C/man5/proc.5:3898
13943 msgid "I</proc/sys/kernel/version>"
13946 #. type: Plain text
13947 #: build/C/man5/proc.5:3901
13948 msgid "This file contains a string like:"
13951 #. type: Plain text
13952 #: build/C/man5/proc.5:3903
13954 msgid " #5 Wed Feb 25 21:49:24 MET 1998\n"
13957 #. type: Plain text
13958 #: build/C/man5/proc.5:3907
13960 "The \"#5\" means that this is the fifth kernel built from this source base "
13961 "and the date behind it indicates the time the kernel was built."
13965 #: build/C/man5/proc.5:3907
13967 msgid "I</proc/sys/kernel/threads-max> (since Linux 2.3.11)"
13970 #. type: Plain text
13971 #: build/C/man5/proc.5:3911
13973 "This file specifies the system-wide limit on the number of threads (tasks) "
13974 "that can be created on the system."
13978 #: build/C/man5/proc.5:3911
13980 msgid "I</proc/sys/kernel/zero-paged> (PowerPC only) "
13983 #. type: Plain text
13984 #: build/C/man5/proc.5:3917
13986 "This file contains a flag. When enabled (nonzero), Linux-PPC will pre-zero "
13987 "pages in the idle loop, possibly speeding up get_free_pages."
13991 #: build/C/man5/proc.5:3917
13993 msgid "I</proc/sys/net>"
13996 #. type: Plain text
13997 #: build/C/man5/proc.5:3924
13999 "This directory contains networking stuff. Explanations for some of the "
14000 "files under this directory can be found in B<tcp>(7) and B<ip>(7)."
14004 #: build/C/man5/proc.5:3924
14006 msgid "I</proc/sys/net/core/somaxconn>"
14009 #. type: Plain text
14010 #: build/C/man5/proc.5:3933
14012 "This file defines a ceiling value for the I<backlog> argument of "
14013 "B<listen>(2); see the B<listen>(2) manual page for details."
14017 #: build/C/man5/proc.5:3933
14019 msgid "I</proc/sys/proc>"
14023 #: build/C/man5/proc.5:3936
14025 msgid "I</proc/sys/sunrpc>"
14028 #. type: Plain text
14029 #: build/C/man5/proc.5:3941
14031 "This directory supports Sun remote procedure call for network filesystem "
14032 "(NFS). On some systems, it is not present."
14036 #: build/C/man5/proc.5:3941
14038 msgid "I</proc/sys/vm>"
14041 #. type: Plain text
14042 #: build/C/man5/proc.5:3945
14044 "This directory contains files for memory management tuning, buffer and cache "
14049 #: build/C/man5/proc.5:3945
14051 msgid "I</proc/sys/vm/compact_memory> (since Linux 2.6.35)"
14054 #. type: Plain text
14055 #: build/C/man5/proc.5:3951
14057 "When 1 is written to this file, all zones are compacted such that free "
14058 "memory is available in contiguous blocks where possible. The effect of this "
14059 "action can be seen by examining I</proc/buddyinfo>."
14062 #. type: Plain text
14063 #: build/C/man5/proc.5:3954
14064 msgid "Only present if the kernel was configured with B<CONFIG_COMPACTION>."
14068 #: build/C/man5/proc.5:3954
14070 msgid "I</proc/sys/vm/drop_caches> (since Linux 2.6.16)"
14073 #. type: Plain text
14074 #: build/C/man5/proc.5:3962
14076 "Writing to this file causes the kernel to drop clean caches, dentries, and "
14077 "inodes from memory, causing that memory to become free. This can be useful "
14078 "for memory management testing and performing reproducible filesystem "
14079 "benchmarks. Because writing to this file causes the benefits of caching to "
14080 "be lost, it can degrade overall system performance."
14083 #. type: Plain text
14084 #: build/C/man5/proc.5:3964
14085 msgid "To free pagecache, use:"
14088 #. type: Plain text
14089 #: build/C/man5/proc.5:3966
14091 msgid " echo 1 E<gt> /proc/sys/vm/drop_caches\n"
14094 #. type: Plain text
14095 #: build/C/man5/proc.5:3968
14096 msgid "To free dentries and inodes, use:"
14099 #. type: Plain text
14100 #: build/C/man5/proc.5:3970
14102 msgid " echo 2 E<gt> /proc/sys/vm/drop_caches\n"
14105 #. type: Plain text
14106 #: build/C/man5/proc.5:3972
14107 msgid "To free pagecache, dentries and inodes, use:"
14110 #. type: Plain text
14111 #: build/C/man5/proc.5:3974
14113 msgid " echo 3 E<gt> /proc/sys/vm/drop_caches\n"
14116 #. type: Plain text
14117 #: build/C/man5/proc.5:3980
14119 "Because writing to this file is a nondestructive operation and dirty objects "
14120 "are not freeable, the user should run B<sync>(1) first."
14124 #: build/C/man5/proc.5:3980
14126 msgid "I</proc/sys/vm/legacy_va_layout> (since Linux 2.6.9)"
14129 #. The following is from Documentation/filesystems/proc.txt
14130 #. type: Plain text
14131 #: build/C/man5/proc.5:3985
14133 "If nonzero, this disables the new 32-bit memory-mapping layout; the kernel "
14134 "will use the legacy (2.4) layout for all processes."
14138 #: build/C/man5/proc.5:3985
14140 msgid "I</proc/sys/vm/memory_failure_early_kill> (since Linux 2.6.32)"
14143 #. The following is based on the text in Documentation/sysctl/vm.txt
14144 #. type: Plain text
14145 #: build/C/man5/proc.5:3997
14147 "Control how to kill processes when an uncorrected memory error (typically a "
14148 "2-bit error in a memory module) that cannot be handled by the kernel is "
14149 "detected in the background by hardware. In some cases (like the page still "
14150 "having a valid copy on disk), the kernel will handle the failure "
14151 "transparently without affecting any applications. But if there is no other "
14152 "up-to-date copy of the data, it will kill processes to prevent any data "
14153 "corruptions from propagating."
14156 #. type: Plain text
14157 #: build/C/man5/proc.5:3999
14158 msgid "The file has one of the following values:"
14162 #: build/C/man5/proc.5:4000 build/C/man5/proc.5:4037
14167 #. type: Plain text
14168 #: build/C/man5/proc.5:4005
14170 "Kill all processes that have the corrupted-and-not-reloadable page mapped as "
14171 "soon as the corruption is detected. Note this is not supported for a few "
14172 "types of pages, like kernel internally allocated data or the swap cache, but "
14173 "works for the majority of user pages."
14177 #: build/C/man5/proc.5:4005 build/C/man5/proc.5:4039
14182 #. type: Plain text
14183 #: build/C/man5/proc.5:4008
14185 "Only unmap the corrupted page from all processes and kill only a process "
14186 "that tries to access it."
14189 #. type: Plain text
14190 #: build/C/man5/proc.5:4019
14192 "The kill is performed using a B<SIGBUS> signal with I<si_code> set to "
14193 "B<BUS_MCEERR_AO>. Processes can handle this if they want to; see "
14194 "B<sigaction>(2) for more details."
14197 #. type: Plain text
14198 #: build/C/man5/proc.5:4022
14200 "This feature is active only on architectures/platforms with advanced machine "
14201 "check handling and depends on the hardware capabilities."
14204 #. type: Plain text
14205 #: build/C/man5/proc.5:4029
14207 "Applications can override the I<memory_failure_early_kill> setting "
14208 "individually with the B<prctl>(2) B<PR_MCE_KILL> operation."
14211 #. type: Plain text
14212 #: build/C/man5/proc.5:4032 build/C/man5/proc.5:4045
14213 msgid "Only present if the kernel was configured with B<CONFIG_MEMORY_FAILURE>."
14217 #: build/C/man5/proc.5:4032
14219 msgid "I</proc/sys/vm/memory_failure_recovery> (since Linux 2.6.32)"
14222 #. The following is based on the text in Documentation/sysctl/vm.txt
14223 #. type: Plain text
14224 #: build/C/man5/proc.5:4036
14225 msgid "Enable memory failure recovery (when supported by the platform)"
14228 #. type: Plain text
14229 #: build/C/man5/proc.5:4039
14230 msgid "Attempt recovery."
14233 #. type: Plain text
14234 #: build/C/man5/proc.5:4041
14235 msgid "Always panic on a memory failure."
14239 #: build/C/man5/proc.5:4045
14241 msgid "I</proc/sys/vm/oom_dump_tasks> (since Linux 2.6.25)"
14244 #. The following is from Documentation/sysctl/vm.txt
14245 #. type: Plain text
14246 #: build/C/man5/proc.5:4060
14248 "Enables a system-wide task dump (excluding kernel threads) to be produced "
14249 "when the kernel performs an OOM-killing. The dump includes the following "
14250 "information for each task (thread, process): thread ID, real user ID, thread "
14251 "group ID (process ID), virtual memory size, resident set size, the CPU that "
14252 "the task is scheduled on, oom_adj score (see the description of "
14253 "I</proc/[pid]/oom_adj>), and command name. This is helpful to determine why "
14254 "the OOM-killer was invoked and to identify the rogue task that caused it."
14257 #. type: Plain text
14258 #: build/C/man5/proc.5:4066
14260 "If this contains the value zero, this information is suppressed. On very "
14261 "large systems with thousands of tasks, it may not be feasible to dump the "
14262 "memory state information for each one. Such systems should not be forced to "
14263 "incur a performance penalty in OOM situations when the information may not "
14267 #. type: Plain text
14268 #: build/C/man5/proc.5:4069
14270 "If this is set to nonzero, this information is shown whenever the OOM-killer "
14271 "actually kills a memory-hogging task."
14274 #. type: Plain text
14275 #: build/C/man5/proc.5:4071 build/C/man5/proc.5:4092
14276 msgid "The default value is 0."
14280 #: build/C/man5/proc.5:4071
14282 msgid "I</proc/sys/vm/oom_kill_allocating_task> (since Linux 2.6.24)"
14285 #. The following is from Documentation/sysctl/vm.txt
14286 #. type: Plain text
14287 #: build/C/man5/proc.5:4076
14289 "This enables or disables killing the OOM-triggering task in out-of-memory "
14293 #. type: Plain text
14294 #: build/C/man5/proc.5:4081
14296 "If this is set to zero, the OOM-killer will scan through the entire tasklist "
14297 "and select a task based on heuristics to kill. This normally selects a "
14298 "rogue memory-hogging task that frees up a large amount of memory when "
14302 #. type: Plain text
14303 #: build/C/man5/proc.5:4085
14305 "If this is set to nonzero, the OOM-killer simply kills the task that "
14306 "triggered the out-of-memory condition. This avoids a possibly expensive "
14310 #. type: Plain text
14311 #: build/C/man5/proc.5:4090
14313 "If I</proc/sys/vm/panic_on_oom> is nonzero, it takes precedence over "
14314 "whatever value is used in I</proc/sys/vm/oom_kill_allocating_task>."
14318 #: build/C/man5/proc.5:4092
14320 msgid "I</proc/sys/vm/overcommit_kbytes> (since Linux 3.14)"
14323 #. commit 49f0ce5f92321cdcf741e35f385669a421013cb7
14324 #. type: Plain text
14325 #: build/C/man5/proc.5:4109
14327 "This writable file provides an alternative to "
14328 "I</proc/sys/vm/overcommit_ratio> for controlling the I<CommitLimit> when "
14329 "I</proc/sys/vm/overcommit_memory> has the value 2. It allows the amount of "
14330 "memory overcommitting to be specified as an absolute value (in kB), rather "
14331 "than as a percentage, as is done with I<overcommit_ratio>. This allows for "
14332 "finer-grained control of I<CommitLimit> on systems with extremely large "
14336 #. type: Plain text
14337 #: build/C/man5/proc.5:4124
14339 "Only one of I<overcommit_kbytes> or I<overcommit_ratio> can have an effect: "
14340 "if I<overcommit_kbytes> has a nonzero value, then it is used to calculate "
14341 "I<CommitLimit>, otherwise I<overcommit_ratio> is used. Writing a value to "
14342 "either of these files causes the value in the other file to be set to zero."
14346 #: build/C/man5/proc.5:4124
14348 msgid "I</proc/sys/vm/overcommit_memory>"
14351 #. type: Plain text
14352 #: build/C/man5/proc.5:4128
14353 msgid "This file contains the kernel virtual memory accounting mode. Values are:"
14356 #. type: Plain text
14357 #: build/C/man5/proc.5:4131
14358 msgid "0: heuristic overcommit (this is the default)"
14361 #. type: Plain text
14362 #: build/C/man5/proc.5:4133
14363 msgid "1: always overcommit, never check"
14366 #. type: Plain text
14367 #: build/C/man5/proc.5:4135
14368 msgid "2: always check, never overcommit"
14371 #. type: Plain text
14372 #: build/C/man5/proc.5:4144
14374 "In mode 0, calls of B<mmap>(2) with B<MAP_NORESERVE> are not checked, and "
14375 "the default check is very weak, leading to the risk of getting a process "
14376 "\"OOM-killed\". Under Linux 2.4, any nonzero value implies mode 1."
14379 #. type: Plain text
14380 #: build/C/man5/proc.5:4151
14382 "In mode 2 (available since Linux 2.6), the total virtual address space that "
14383 "can be allocated (I<CommitLimit> in I</proc/meminfo>) is calculated as"
14386 #. type: Plain text
14387 #: build/C/man5/proc.5:4154
14390 " CommitLimit = (total_RAM - total_huge_TLB) *\n"
14391 " overcommit_ratio / 100 + total_swap\n"
14394 #. type: Plain text
14395 #: build/C/man5/proc.5:4160
14396 msgid "I<total_RAM> is the total amount of RAM on the system;"
14399 #. type: Plain text
14400 #: build/C/man5/proc.5:4163
14401 msgid "I<total_huge_TLB> is the amount of memory set aside for huge pages;"
14404 #. type: Plain text
14405 #: build/C/man5/proc.5:4168
14406 msgid "I<overcommit_ratio> is the value in I</proc/sys/vm/overcommit_ratio>; and"
14409 #. type: Plain text
14410 #: build/C/man5/proc.5:4171
14411 msgid "I<total_swap> is the amount of swap space."
14414 #. type: Plain text
14415 #: build/C/man5/proc.5:4179
14417 "For example, on a system with 16GB of physical RAM, 16GB of swap, no space "
14418 "dedicated to huge pages, and an I<overcommit_ratio> of 50, this formula "
14419 "yields a I<CommitLimit> of 24GB."
14422 #. type: Plain text
14423 #: build/C/man5/proc.5:4185
14425 "Since Linux 3.14, if the value in I</proc/sys/vm/overcommit_kbytes> is "
14426 "nonzero, then I<CommitLimit> is instead calculated as:"
14429 #. type: Plain text
14430 #: build/C/man5/proc.5:4187
14432 msgid " CommitLimit = overcommit_kbytes + total_swap\n"
14436 #: build/C/man5/proc.5:4187
14438 msgid "I</proc/sys/vm/overcommit_ratio> (since Linux 2.6.0)"
14441 #. type: Plain text
14442 #: build/C/man5/proc.5:4194
14444 "This writable file defines a percentage by which memory can be "
14445 "overcommitted. The default value in the file is 50. See the description of "
14446 "I</proc/sys/vm/overcommit_memory>."
14450 #: build/C/man5/proc.5:4194
14452 msgid "I</proc/sys/vm/panic_on_oom> (since Linux 2.6.18)"
14455 #. The following is adapted from Documentation/sysctl/vm.txt
14456 #. type: Plain text
14457 #: build/C/man5/proc.5:4199
14458 msgid "This enables or disables a kernel panic in an out-of-memory situation."
14461 #. type: Plain text
14462 #: build/C/man5/proc.5:4204
14464 "If this file is set to the value 0, the kernel's OOM-killer will kill some "
14465 "rogue process. Usually, the OOM-killer is able to kill a rogue process and "
14466 "the system will survive."
14469 #. type: Plain text
14470 #: build/C/man5/proc.5:4219
14472 "If this file is set to the value 1, then the kernel normally panics when "
14473 "out-of-memory happens. However, if a process limits allocations to certain "
14474 "nodes using memory policies (B<mbind>(2) B<MPOL_BIND>) or cpusets "
14475 "(B<cpuset>(7)) and those nodes reach memory exhaustion status, one process "
14476 "may be killed by the OOM-killer. No panic occurs in this case: because "
14477 "other nodes' memory may be free, this means the system as a whole may not "
14478 "have reached an out-of-memory situation yet."
14481 #. type: Plain text
14482 #: build/C/man5/proc.5:4222
14484 "If this file is set to the value 2, the kernel always panics when an "
14485 "out-of-memory condition occurs."
14488 #. type: Plain text
14489 #: build/C/man5/proc.5:4226
14491 "The default value is 0. 1 and 2 are for failover of clustering. Select "
14492 "either according to your policy of failover."
14496 #: build/C/man5/proc.5:4226
14498 msgid "I</proc/sys/vm/swappiness>"
14501 #. The following is from Documentation/sysctl/vm.txt
14502 #. type: Plain text
14503 #: build/C/man5/proc.5:4234
14505 "The value in this file controls how aggressively the kernel will swap memory "
14506 "pages. Higher values increase aggressiveness, lower values decrease "
14507 "aggressiveness. The default value is 60."
14511 #: build/C/man5/proc.5:4234
14513 msgid "I</proc/sysrq-trigger> (since Linux 2.4.21)"
14516 #. type: Plain text
14517 #: build/C/man5/proc.5:4243
14519 "Writing a character to this file triggers the same SysRq function as typing "
14520 "ALT-SysRq-E<lt>characterE<gt> (see the description of "
14521 "I</proc/sys/kernel/sysrq>). This file is normally writable only by "
14522 "I<root>. For further details see the Linux kernel source file "
14523 "I<Documentation/sysrq.txt>."
14527 #: build/C/man5/proc.5:4243
14529 msgid "I</proc/sysvipc>"
14532 #. type: Plain text
14533 #: build/C/man5/proc.5:4256
14535 "Subdirectory containing the pseudo-files I<msg>, I<sem> and I<shm>. These "
14536 "files list the System V Interprocess Communication (IPC) objects "
14537 "(respectively: message queues, semaphores, and shared memory) that "
14538 "currently exist on the system, providing similar information to that "
14539 "available via B<ipcs>(1). These files have headers and are formatted (one "
14540 "IPC object per line) for easy understanding. B<svipc>(7) provides further "
14541 "background on the information shown by these files."
14545 #: build/C/man5/proc.5:4256
14547 msgid "I</proc/thread-self> (since Linux 3.17)"
14550 #. commit 0097875bd41528922fb3bb5f348c53f17e00e2fd
14551 #. type: Plain text
14552 #: build/C/man5/proc.5:4267
14554 "This directory refers to the thread accessing the I</proc> filesystem, and "
14555 "is identical to the I</proc/self/task/[tid]> directory named by the process "
14556 "thread ID (I<[tid]>) of the same thread."
14560 #: build/C/man5/proc.5:4267
14562 msgid "I</proc/timer_list> (since Linux 2.6.21)"
14565 #. commit 289f480af87e45f7a6de6ba9b4c061c2e259fe98
14566 #. type: Plain text
14567 #: build/C/man5/proc.5:4273
14569 "This read-only file exposes a list of all currently pending "
14570 "(high-resolution) timers, all clock-event sources, and their parameters in a "
14571 "human-readable form."
14575 #: build/C/man5/proc.5:4273
14577 msgid "I</proc/timer_stats> (since Linux 2.6.21)"
14580 #. commit 82f67cd9fca8c8762c15ba7ed0d5747588c1e221
14581 #. Date: Fri Feb 16 01:28:13 2007 -0800
14582 #. Text largely derived from Documentation/timers/timer_stats.txt
14583 #. type: Plain text
14584 #: build/C/man5/proc.5:4284
14586 "This is a debugging facility to make timer (ab)use in a Linux system visible "
14587 "to kernel and user-space developers. It can be used by kernel and "
14588 "user-space developers to verify that their code does not make undue use of "
14589 "timers. The goal is to avoid unnecessary wakeups, thereby optimizing power "
14593 #. type: Plain text
14594 #: build/C/man5/proc.5:4292
14596 "If enabled in the kernel (B<CONFIG_TIMER_STATS>), but not used, it has "
14597 "almost zero runtime overhead and a relatively small data-structure "
14598 "overhead. Even if collection is enabled at runtime, overhead is low: all "
14599 "the locking is per-CPU and lookup is hashed."
14602 #. type: Plain text
14603 #: build/C/man5/proc.5:4297
14605 "The I</proc/timer_stats> file is used both to control sampling facility and "
14606 "to read out the sampled information."
14609 #. type: Plain text
14610 #: build/C/man5/proc.5:4300
14612 "The timer_stats functionality is inactive on bootup. A sampling period can "
14613 "be started using the following command:"
14616 #. type: Plain text
14617 #: build/C/man5/proc.5:4302
14619 msgid " # echo 1 E<gt> /proc/timer_stats\n"
14622 #. type: Plain text
14623 #: build/C/man5/proc.5:4304
14624 msgid "The following command stops a sampling period:"
14627 #. type: Plain text
14628 #: build/C/man5/proc.5:4306
14630 msgid " # echo 0 E<gt> /proc/timer_stats\n"
14633 #. type: Plain text
14634 #: build/C/man5/proc.5:4308
14635 msgid "The statistics can be retrieved by:"
14638 #. type: Plain text
14639 #: build/C/man5/proc.5:4310
14641 msgid " $ cat /proc/timer_stats\n"
14644 #. type: Plain text
14645 #: build/C/man5/proc.5:4318
14647 "While sampling is enabled, each readout from I</proc/timer_stats> will see "
14648 "newly updated statistics. Once sampling is disabled, the sampled "
14649 "information is kept until a new sample period is started. This allows "
14650 "multiple readouts."
14653 #. type: Plain text
14654 #: build/C/man5/proc.5:4321
14655 msgid "Sample output from I</proc/timer_stats>:"
14658 #. type: Plain text
14659 #: build/C/man5/proc.5:4337
14662 "$B< cat /proc/timer_stats>\n"
14663 "Timer Stats Version: v0.3\n"
14664 "Sample period: 1.764 s\n"
14665 "Collection: active\n"
14666 " 255, 0 swapper/3 hrtimer_start_range_ns (tick_sched_timer)\n"
14667 " 71, 0 swapper/1 hrtimer_start_range_ns (tick_sched_timer)\n"
14668 " 58, 0 swapper/0 hrtimer_start_range_ns (tick_sched_timer)\n"
14669 " 4, 1694 gnome-shell mod_delayed_work_on (delayed_work_timer_fn)\n"
14670 " 17, 7 rcu_sched rcu_gp_kthread (process_timeout)\n"
14672 " 1, 4911 kworker/u16:0 mod_delayed_work_on (delayed_work_timer_fn)\n"
14673 " 1D, 2522 kworker/0:0 queue_delayed_work_on "
14674 "(delayed_work_timer_fn)\n"
14675 "1029 total events, 583.333 events/sec\n"
14678 #. type: Plain text
14679 #: build/C/man5/proc.5:4342
14680 msgid "The output columns are:"
14683 #. commit c5c061b8f9726bc2c25e19dec227933a13d1e6b7 deferrable timers
14684 #. type: Plain text
14685 #: build/C/man5/proc.5:4348
14687 "a count of the number of events, optionally (since Linux 2.6.23) followed by "
14688 "the letter \\(aqD\\(aq if this is a deferrable timer;"
14691 #. type: Plain text
14692 #: build/C/man5/proc.5:4350
14693 msgid "the PID of the process that initialized the timer;"
14696 #. type: Plain text
14697 #: build/C/man5/proc.5:4352
14698 msgid "the name of the process that initialized the timer;"
14701 #. type: Plain text
14702 #: build/C/man5/proc.5:4354
14703 msgid "the function where the timer was initialized; and"
14706 #. type: Plain text
14707 #: build/C/man5/proc.5:4357
14708 msgid "(in parentheses) the callback function that is associated with the timer."
14712 #: build/C/man5/proc.5:4358
14714 msgid "I</proc/tty>"
14717 #. type: Plain text
14718 #: build/C/man5/proc.5:4362
14720 "Subdirectory containing the pseudo-files and subdirectories for tty drivers "
14721 "and line disciplines."
14725 #: build/C/man5/proc.5:4362
14727 msgid "I</proc/uptime>"
14730 #. type: Plain text
14731 #: build/C/man5/proc.5:4366
14733 "This file contains two numbers: the uptime of the system (seconds), and the "
14734 "amount of time spent in idle process (seconds)."
14738 #: build/C/man5/proc.5:4366
14740 msgid "I</proc/version>"
14743 #. type: Plain text
14744 #: build/C/man5/proc.5:4375
14746 "This string identifies the kernel version that is currently running. It "
14747 "includes the contents of I</proc/sys/kernel/ostype>, "
14748 "I</proc/sys/kernel/osrelease> and I</proc/sys/kernel/version>. For example:"
14751 #. type: Plain text
14752 #: build/C/man5/proc.5:4379
14754 msgid "CW<Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994>\n"
14758 #: build/C/man5/proc.5:4387
14760 msgid "I</proc/vmstat> (since Linux 2.6)"
14763 #. type: Plain text
14764 #: build/C/man5/proc.5:4390
14765 msgid "This file displays various virtual memory statistics."
14769 #: build/C/man5/proc.5:4390
14771 msgid "I</proc/zoneinfo> (since Linux 2.6.13)"
14774 #. FIXME more should be said about /proc/zoneinfo
14775 #. type: Plain text
14776 #: build/C/man5/proc.5:4395
14778 "This file display information about memory zones. This is useful for "
14779 "analyzing virtual memory behavior."
14782 #. type: Plain text
14783 #: build/C/man5/proc.5:4402
14785 "Many strings (i.e., the environment and command line) are in the internal "
14786 "format, with subfields terminated by null bytes (\\(aq\\e0\\(aq), so you may "
14787 "find that things are more readable if you use I<od -c> or I<tr \"\\e000\" "
14788 "\"\\en\"> to read them. Alternatively, I<echo \\`cat E<lt>fileE<gt>\\`> "
14792 #. .SH ACKNOWLEDGEMENTS
14793 #. The material on /proc/sys/fs and /proc/sys/kernel is closely based on
14794 #. kernel source documentation files written by Rik van Riel.
14795 #. type: Plain text
14796 #: build/C/man5/proc.5:4408
14798 "This manual page is incomplete, possibly inaccurate, and is the kind of "
14799 "thing that needs to be updated very often."
14802 #. type: Plain text
14803 #: build/C/man5/proc.5:4435
14805 "B<cat>(1), B<dmesg>(1), B<find>(1), B<free>(1), B<ps>(1), B<tr>(1), "
14806 "B<uptime>(1), B<chroot>(2), B<mmap>(2), B<readlink>(2), B<syslog>(2), "
14807 "B<slabinfo>(5), B<hier>(7), B<namespaces>(7), B<time>(7), B<arp>(8), "
14808 "B<hdparm>(8), B<ifconfig>(8), B<init>(1), B<lsmod>(8), B<lspci>(8), "
14809 "B<mount>(8), B<netstat>(8), B<procinfo>(8), B<route>(8), B<sysctl>(8)"
14812 #. type: Plain text
14813 #: build/C/man5/proc.5:4443
14815 "The Linux kernel source files: I<Documentation/filesystems/proc.txt> "
14816 "I<Documentation/sysctl/fs.txt>, I<Documentation/sysctl/kernel.txt>, "
14817 "I<Documentation/sysctl/net.txt>, and I<Documentation/sysctl/vm.txt>."
14821 #: build/C/man7/standards.7:24
14827 #: build/C/man7/standards.7:24
14832 #. type: Plain text
14833 #: build/C/man7/standards.7:27
14834 msgid "standards - C and UNIX Standards"
14837 #. type: Plain text
14838 #: build/C/man7/standards.7:31
14840 "The CONFORMING TO section that appears in many manual pages identifies "
14841 "various standards to which the documented interface conforms. The following "
14842 "list briefly describes these standards."
14846 #: build/C/man7/standards.7:31
14851 #. type: Plain text
14852 #: build/C/man7/standards.7:37
14854 "Version 7 (also known as Seventh Edition) UNIX, released by AT&T/Bell Labs "
14855 "in 1979. After this point, UNIX systems diverged into two main dialects: "
14856 "BSD and System V."
14860 #: build/C/man7/standards.7:37
14865 #. type: Plain text
14866 #: build/C/man7/standards.7:46
14868 "This is an implementation standard defined by the 4.2 release of the "
14869 "I<Berkeley Software Distribution>, released by the University of California "
14870 "at Berkeley. This was the first Berkeley release that contained a TCP/IP "
14871 "stack and the sockets API. 4.2BSD was released in 1983."
14874 #. type: Plain text
14875 #: build/C/man7/standards.7:55
14877 "Earlier major BSD releases included I<3BSD> (1980), I<4BSD> (1980), and "
14878 "I<4.1BSD> (1981)."
14882 #: build/C/man7/standards.7:55
14887 #. type: Plain text
14888 #: build/C/man7/standards.7:58
14889 msgid "The successor to 4.2BSD, released in 1986."
14893 #: build/C/man7/standards.7:58
14898 #. type: Plain text
14899 #: build/C/man7/standards.7:62
14901 "The successor to 4.3BSD, released in 1993. This was the last major Berkeley "
14906 #: build/C/man7/standards.7:62
14908 msgid "B<System V>"
14911 #. type: Plain text
14912 #: build/C/man7/standards.7:69
14914 "This is an implementation standard defined by AT&T's milestone 1983 release "
14915 "of its commercial System V (five) release. The previous major AT&T release "
14916 "was I<System III>, released in 1981."
14920 #: build/C/man7/standards.7:69
14922 msgid "B<System V release 2 (SVr2)>"
14925 #. type: Plain text
14926 #: build/C/man7/standards.7:76
14928 "This was the next System V release, made in 1985. The SVr2 was formally "
14929 "described in the I<System V Interface Definition version 1> (I<SVID 1>) "
14930 "published in 1985."
14934 #: build/C/man7/standards.7:76
14936 msgid "B<System V release 3 (SVr3)>"
14939 #. type: Plain text
14940 #: build/C/man7/standards.7:82
14942 "This was the successor to SVr2, released in 1986. This release was formally "
14943 "described in the I<System V Interface Definition version 2> (I<SVID 2>)."
14947 #: build/C/man7/standards.7:82
14949 msgid "B<System V release 4 (SVr4)>"
14952 #. type: Plain text
14953 #: build/C/man7/standards.7:92
14955 "This was the successor to SVr3, released in 1989. This version of System V "
14956 "is described in the \"Programmer's Reference Manual: Operating System API "
14957 "(Intel processors)\" (Prentice-Hall 1992, ISBN 0-13-951294-2) This release "
14958 "was formally described in the I<System V Interface Definition version 3> "
14959 "(I<SVID 3>), and is considered the definitive System V release."
14963 #: build/C/man7/standards.7:92
14968 #. type: Plain text
14969 #: build/C/man7/standards.7:98
14971 "System V Interface Definition version 4, issued in 1995. Available online "
14972 "at E<.UR http://www.sco.com\\:/developers\\:/devspecs/> E<.UE .>"
14976 #: build/C/man7/standards.7:98
14981 #. type: Plain text
14982 #: build/C/man7/standards.7:112
14984 "This was the first C language standard, ratified by ANSI (American National "
14985 "Standards Institute) in 1989 (I<X3.159-1989>). Sometimes this is known as "
14986 "I<ANSI C>, but since C99 is also an ANSI standard, this term is ambiguous. "
14987 "This standard was also ratified by ISO (International Standards "
14988 "Organization) in 1990 (I<ISO/IEC 9899:1990>), and is thus occasionally "
14989 "referred to as I<ISO C90>."
14993 #: build/C/man7/standards.7:112
14998 #. type: Plain text
14999 #: build/C/man7/standards.7:119
15001 "This revision of the C language standard was ratified by ISO in 1999 "
15002 "(I<ISO/IEC 9899:1999>). Available online at E<.UR "
15003 "http://www.open-std.org\\:/jtc1\\:/sc22\\:/wg14\\:/www\\:/standards> E<.UE "
15008 #: build/C/man7/standards.7:119
15013 #. type: Plain text
15014 #: build/C/man7/standards.7:123
15016 "This revision of the C language standard was ratified by ISO in 2011 "
15017 "(I<ISO/IEC 9899:2011>)."
15021 #: build/C/man7/standards.7:123
15023 msgid "B<POSIX.1-1990>"
15026 #. type: Plain text
15027 #: build/C/man7/standards.7:129
15029 "\"Portable Operating System Interface for Computing Environments\". IEEE "
15030 "1003.1-1990 part 1, ratified by ISO in 1990 (I<ISO/IEC 9945-1:1990>). The "
15031 "term \"POSIX\" was coined by Richard Stallman."
15035 #: build/C/man7/standards.7:129
15040 #. type: Plain text
15041 #: build/C/man7/standards.7:134
15043 "IEEE Std 1003.2-1992, describing commands and utilities, ratified by ISO in "
15044 "1993 (I<ISO/IEC 9945-2:1993>)."
15048 #: build/C/man7/standards.7:134
15050 msgid "B<POSIX.1b> (formerly known as I<POSIX.4>)"
15053 #. type: Plain text
15054 #: build/C/man7/standards.7:140
15056 "IEEE Std 1003.1b-1993, describing real-time facilities for portable "
15057 "operating systems, ratified by ISO in 1996 (I<ISO/IEC 9945-1:1996>)."
15061 #: build/C/man7/standards.7:140
15063 msgid "B<POSIX.1c>"
15066 #. type: Plain text
15067 #: build/C/man7/standards.7:143
15068 msgid "IEEE Std 1003.1c-1995, which describes the POSIX threads interfaces."
15072 #: build/C/man7/standards.7:143
15074 msgid "B<POSIX.1d>"
15077 #. type: Plain text
15078 #: build/C/man7/standards.7:146
15079 msgid "IEEE Std 1003.1c-1999, which describes additional real-time extensions."
15083 #: build/C/man7/standards.7:146
15085 msgid "B<POSIX.1g>"
15088 #. type: Plain text
15089 #: build/C/man7/standards.7:149
15090 msgid "IEEE Std 1003.1g-2000, which describes networking APIs (including sockets)."
15094 #: build/C/man7/standards.7:149
15096 msgid "B<POSIX.1j>"
15099 #. type: Plain text
15100 #: build/C/man7/standards.7:152
15101 msgid "IEEE Std 1003.1j-2000, which describes advanced real-time extensions."
15105 #: build/C/man7/standards.7:152
15107 msgid "B<POSIX.1-1996>"
15110 #. type: Plain text
15111 #: build/C/man7/standards.7:155
15112 msgid "A 1996 revision of POSIX.1 which incorporated POSIX.1b and POSIX.1c."
15116 #: build/C/man7/standards.7:155
15121 #. type: Plain text
15122 #: build/C/man7/standards.7:162
15124 "Released in 1989, this was the first significant release of the I<X/Open "
15125 "Portability Guide>, produced by the X/Open Company, a multivendor "
15126 "consortium. This multivolume guide was based on the POSIX standards."
15130 #: build/C/man7/standards.7:162
15135 #. type: Plain text
15136 #: build/C/man7/standards.7:165
15137 msgid "A revision of the X/Open Portability Guide, released in 1992."
15141 #: build/C/man7/standards.7:165
15146 #. type: Plain text
15147 #: build/C/man7/standards.7:172
15149 "A 1994 revision of XPG4. This is also referred to as I<Spec 1170>, where "
15150 "1170 referred to the number of interfaces defined by this standard."
15154 #: build/C/man7/standards.7:172
15156 msgid "B<SUS (SUSv1)>"
15159 #. type: Plain text
15160 #: build/C/man7/standards.7:180
15162 "Single UNIX Specification. This was a repackaging of XPG4v2 and other "
15163 "X/Open standards (X/Open Curses Issue 4 version 2, X/Open Networking Service "
15164 "(XNS) Issue 4). Systems conforming to this standard can be branded I<UNIX "
15169 #: build/C/man7/standards.7:180
15174 #. type: Plain text
15175 #: build/C/man7/standards.7:191
15177 "Single UNIX Specification version 2. Sometimes also referred to as "
15178 "I<XPG5>. This standard appeared in 1997. Systems conforming to this "
15179 "standard can be branded I<UNIX 98>. See also E<.UR "
15180 "http://www.UNIX-systems.org\\:/version2/> E<.UE .)>"
15184 #: build/C/man7/standards.7:191
15186 msgid "B<POSIX.1-2001, SUSv3>"
15189 #. type: Plain text
15190 #: build/C/man7/standards.7:203
15192 "This was a 2001 revision and consolidation of the POSIX.1, POSIX.2, and SUS "
15193 "standards into a single document, conducted under the auspices of the Austin "
15194 "Group E<.UR http://www.opengroup.org\\:/austin/> E<.UE .> The standard is "
15195 "available online at E<.UR http://www.unix-systems.org\\:/version3/> E<.UE ,> "
15196 "and the interfaces that it describes are also available in the Linux manual "
15197 "pages package under sections 1p and 3p (e.g., \"man 3p open\")."
15200 #. type: Plain text
15201 #: build/C/man7/standards.7:216
15203 "The standard defines two levels of conformance: I<POSIX conformance>, which "
15204 "is a baseline set of interfaces required of a conforming system; and I<XSI "
15205 "Conformance>, which additionally mandates a set of interfaces (the \"XSI "
15206 "extension\") which are only optional for POSIX conformance. XSI-conformant "
15207 "systems can be branded I<UNIX 03>. (XSI conformance constitutes the "
15208 "I<Single UNIX Specification version 3> (I<SUSv3>).)"
15211 #. type: Plain text
15212 #: build/C/man7/standards.7:218
15213 msgid "The POSIX.1-2001 document is broken into four parts:"
15216 #. type: Plain text
15217 #: build/C/man7/standards.7:221
15218 msgid "B<XBD>: Definitions, terms and concepts, header file specifications."
15221 #. type: Plain text
15222 #: build/C/man7/standards.7:225
15224 "B<XSH>: Specifications of functions (i.e., system calls and library "
15225 "functions in actual implementations)."
15228 #. type: Plain text
15229 #: build/C/man7/standards.7:229
15231 "B<XCU>: Specifications of commands and utilities (i.e., the area formerly "
15232 "described by POSIX.2)."
15235 #. type: Plain text
15236 #: build/C/man7/standards.7:232
15237 msgid "B<XRAT>: Informative text on the other parts of the standard."
15240 #. type: Plain text
15241 #: build/C/man7/standards.7:236
15243 "POSIX.1-2001 is aligned with C99, so that all of the library functions "
15244 "standardized in C99 are also standardized in POSIX.1-2001."
15247 #. type: Plain text
15248 #: build/C/man7/standards.7:243
15250 "Two Technical Corrigenda (minor fixes and improvements) of the original "
15251 "2001 standard have occurred: TC1 in 2003 (referred to as I<POSIX.1-2003>), "
15252 "and TC2 in 2004 (referred to as I<POSIX.1-2004>)."
15256 #: build/C/man7/standards.7:243
15258 msgid "B<POSIX.1-2008, SUSv4>"
15261 #. type: Plain text
15262 #: build/C/man7/standards.7:247
15263 msgid "Work on the next revision of POSIX.1/SUS was completed and ratified in 2008."
15266 #. type: Plain text
15267 #: build/C/man7/standards.7:256
15269 "The changes in this revision are not as large as those that occurred for "
15270 "POSIX.1-2001/SUSv3, but a number of new interfaces are added and various "
15271 "details of existing specifications are modified. Many of the interfaces "
15272 "that were optional in POSIX.1-2001 become mandatory in the 2008 revision of "
15273 "the standard. A few interfaces that are present in POSIX.1-2001 are marked "
15274 "as obsolete in POSIX.1-2008, or removed from the standard altogether."
15277 #. type: Plain text
15278 #: build/C/man7/standards.7:264
15280 "The revised standard is broken into the same four parts as POSIX.1-2001, and "
15281 "again there are two levels of conformance: the baseline I<POSIX "
15282 "Conformance>, and I<XSI Conformance>, which mandates an additional set of "
15283 "interfaces beyond those in the base specification."
15286 #. type: Plain text
15287 #: build/C/man7/standards.7:268
15289 "In general, where the CONFORMING TO section of a manual page lists "
15290 "POSIX.1-2001, it can be assumed that the interface also conforms to "
15291 "POSIX.1-2008, unless otherwise noted."
15294 #. type: Plain text
15295 #: build/C/man7/standards.7:273
15297 "Technical Corrigendum 1 (minor fixes and improvements) of this standard was "
15298 "released in 2013 (referred to as I<POSIX.1-2013>)."
15301 #. type: Plain text
15302 #: build/C/man7/standards.7:277
15304 "Further information can be found on the Austin Group web site, E<.UR "
15305 "http://www.opengroup.org\\:/austin/> E<.UE .>"
15308 #. type: Plain text
15309 #: build/C/man7/standards.7:281
15310 msgid "B<feature_test_macros>(7), B<libc>(7), B<posixoptions>(7)"
15314 #: build/C/man7/suffixes.7:39
15320 #: build/C/man7/suffixes.7:39
15325 #. type: Plain text
15326 #: build/C/man7/suffixes.7:42
15327 msgid "suffixes - list of file suffixes"
15330 #. type: Plain text
15331 #: build/C/man7/suffixes.7:50
15333 "It is customary to indicate the contents of a file with the file suffix, "
15334 "which consists of a period, followed by one or more letters. Many standard "
15335 "utilities, such as compilers, use this to recognize the type of file they "
15336 "are dealing with. The B<make>(1) utility is driven by rules based on file "
15340 #. type: Plain text
15341 #: build/C/man7/suffixes.7:53
15343 "Following is a list of suffixes which are likely to be found on a Linux "
15348 #: build/C/man7/suffixes.7:58
15350 msgid "Suffix\tFile type\n"
15354 #: build/C/man7/suffixes.7:59
15356 msgid " ,v\tfiles for RCS (Revision Control System)\n"
15360 #: build/C/man7/suffixes.7:60
15362 msgid " -\tbackup file\n"
15366 #: build/C/man7/suffixes.7:61
15368 msgid " .C\tC++ source code, equivalent to I<.cc>\n"
15372 #: build/C/man7/suffixes.7:62
15374 msgid " .F\tFortran source with B<cpp>(1) directives\n"
15378 #: build/C/man7/suffixes.7:63
15380 msgid "\tor file compressed using freeze\n"
15384 #: build/C/man7/suffixes.7:64
15386 msgid " .S\tassembler source with B<cpp>(1) directives\n"
15390 #: build/C/man7/suffixes.7:65
15392 msgid " .Y\tfile compressed using yabba\n"
15396 #: build/C/man7/suffixes.7:66
15398 msgid " .Z\tfile compressed using B<compress>(1)\n"
15402 #: build/C/man7/suffixes.7:67
15404 msgid " .[0-9]+gf\tTeX generic font files\n"
15408 #: build/C/man7/suffixes.7:68
15410 msgid " .[0-9]+pk\tTeX packed font files\n"
15414 #: build/C/man7/suffixes.7:69
15416 msgid " .[1-9]\tmanual page for the corresponding section\n"
15420 #: build/C/man7/suffixes.7:70
15422 msgid " .[1-9][a-z]\tmanual page for section plus subsection\n"
15426 #: build/C/man7/suffixes.7:71
15428 msgid " .a\tstatic object code library\n"
15432 #: build/C/man7/suffixes.7:72
15434 msgid " .ad\tX application default resource file\n"
15438 #: build/C/man7/suffixes.7:73
15440 msgid " .ada\tAda source (may be body, spec, or combination)\n"
15444 #: build/C/man7/suffixes.7:74
15446 msgid " .adb\tAda body source\n"
15450 #: build/C/man7/suffixes.7:75
15452 msgid " .ads\tAda spec source\n"
15456 #: build/C/man7/suffixes.7:76
15458 msgid " .afm\tPostScript font metrics\n"
15462 #: build/C/man7/suffixes.7:77
15464 msgid " .al\tPerl autoload file\n"
15468 #: build/C/man7/suffixes.7:78
15470 msgid " .am\tB<automake>(1) input file\n"
15474 #: build/C/man7/suffixes.7:79
15476 msgid " .arc\tB<arc>(1) archive\n"
15480 #: build/C/man7/suffixes.7:80
15482 msgid " .arj\tB<arj>(1) archive\n"
15486 #: build/C/man7/suffixes.7:81
15488 msgid " .asc\tPGP ASCII-armored data\n"
15492 #: build/C/man7/suffixes.7:82
15494 msgid " .asm\t(GNU) assembler source file\n"
15498 #: build/C/man7/suffixes.7:83
15500 msgid " .au\tAudio sound file\n"
15504 #: build/C/man7/suffixes.7:84
15506 msgid " .aux\tLaTeX auxiliary file\n"
15510 #: build/C/man7/suffixes.7:85
15512 msgid " .avi\t(msvideo) movie\n"
15516 #: build/C/man7/suffixes.7:86
15518 msgid " .awk\tAWK language program\n"
15522 #: build/C/man7/suffixes.7:87
15524 msgid " .b\tLILO boot loader image\n"
15528 #: build/C/man7/suffixes.7:88
15530 msgid " .bak\tbackup file\n"
15534 #: build/C/man7/suffixes.7:89
15536 msgid " .bash\tB<bash>(1) shell script\n"
15540 #: build/C/man7/suffixes.7:90
15542 msgid " .bb\tbasic block list data produced by\n"
15546 #: build/C/man7/suffixes.7:91 build/C/man7/suffixes.7:93
15548 msgid "\tgcc -ftest-coverage\n"
15552 #: build/C/man7/suffixes.7:92
15554 msgid " .bbg\tbasic block graph data produced by\n"
15558 #: build/C/man7/suffixes.7:94
15560 msgid " .bbl\tBibTeX output\n"
15564 #: build/C/man7/suffixes.7:95
15566 msgid " .bdf\tX font file\n"
15570 #: build/C/man7/suffixes.7:96
15572 msgid " .bib\tTeX bibliographic database, BibTeX input\n"
15576 #: build/C/man7/suffixes.7:97
15578 msgid " .bm\tbitmap source\n"
15582 #: build/C/man7/suffixes.7:98
15584 msgid " .bmp\tbitmap\n"
15588 #: build/C/man7/suffixes.7:99
15590 msgid " .bz2\tfile compressed using B<bzip2>(1)\n"
15594 #: build/C/man7/suffixes.7:100
15596 msgid " .c\tC source\n"
15600 #: build/C/man7/suffixes.7:101
15602 msgid " .cat\tmessage catalog files\n"
15606 #: build/C/man7/suffixes.7:102
15608 msgid " .cc\tC++ source\n"
15612 #: build/C/man7/suffixes.7:103
15614 msgid " .cf\tconfiguration file\n"
15618 #: build/C/man7/suffixes.7:104
15620 msgid " .cfg\tconfiguration file\n"
15624 #: build/C/man7/suffixes.7:105
15626 msgid " .cgi\tWWW content generating script or program\n"
15630 #: build/C/man7/suffixes.7:106
15632 msgid " .cls\tLaTeX Class definition\n"
15636 #: build/C/man7/suffixes.7:107
15638 msgid " .class\tJava compiled byte-code\n"
15642 #: build/C/man7/suffixes.7:108
15644 msgid " .conf\tconfiguration file\n"
15648 #: build/C/man7/suffixes.7:109
15650 msgid " .config\tconfiguration file\n"
15654 #: build/C/man7/suffixes.7:110
15656 msgid " .cpp\tequivalent to I<.cc>\n"
15660 #: build/C/man7/suffixes.7:111
15662 msgid " .csh\tB<csh>(1) shell script\n"
15666 #: build/C/man7/suffixes.7:112
15668 msgid " .cxx\tequivalent to I<.cc>\n"
15672 #: build/C/man7/suffixes.7:113
15674 msgid " .dat\tdata file\n"
15678 #: build/C/man7/suffixes.7:114
15680 msgid " .deb\tDebian software package\n"
15684 #: build/C/man7/suffixes.7:115
15686 msgid " .def\tModula-2 source for definition modules\n"
15690 #: build/C/man7/suffixes.7:116
15692 msgid " .def\tother definition files\n"
15696 #: build/C/man7/suffixes.7:117
15698 msgid " .desc\tinitial part of mail message unpacked with\n"
15702 #: build/C/man7/suffixes.7:118
15704 msgid "\tB<munpack>(1)\n"
15708 #: build/C/man7/suffixes.7:119
15710 msgid " .diff\tfile differences (B<diff>(1) command output)\n"
15714 #: build/C/man7/suffixes.7:120
15716 msgid " .dir\tdbm data base directory file\n"
15720 #: build/C/man7/suffixes.7:121
15722 msgid " .doc\tdocumentation file\n"
15726 #: build/C/man7/suffixes.7:122
15728 msgid " .dsc\tDebian Source Control (source package)\n"
15732 #: build/C/man7/suffixes.7:123
15734 msgid " .dtx\tLaTeX package source file\n"
15738 #: build/C/man7/suffixes.7:124
15740 msgid " .dvi\tTeX's device independent output\n"
15744 #: build/C/man7/suffixes.7:125
15746 msgid " .el\tEmacs-Lisp source\n"
15750 #: build/C/man7/suffixes.7:126
15752 msgid " .elc\tcompiled Emacs-Lisp source\n"
15756 #: build/C/man7/suffixes.7:127
15758 msgid " .eps\tencapsulated PostScript\n"
15762 #: build/C/man7/suffixes.7:128
15764 msgid " .exp\tExpect source code\n"
15768 #: build/C/man7/suffixes.7:129
15770 msgid " .f\tFortran source\n"
15774 #: build/C/man7/suffixes.7:130
15776 msgid " .f77\tFortran 77 source\n"
15780 #: build/C/man7/suffixes.7:131
15782 msgid " .f90\tFortran 90 source\n"
15786 #: build/C/man7/suffixes.7:132
15788 msgid " .fas\tprecompiled Common-Lisp\n"
15792 #: build/C/man7/suffixes.7:133
15794 msgid " .fi\tFortran include files\n"
15798 #: build/C/man7/suffixes.7:134
15800 msgid " .fig\tFIG image file (used by B<xfig>(1))\n"
15804 #: build/C/man7/suffixes.7:135
15806 msgid " .fmt\tTeX format file\n"
15810 #: build/C/man7/suffixes.7:136
15812 msgid " .gif\tCompuserve Graphics Image File format\n"
15816 #: build/C/man7/suffixes.7:137
15818 msgid " .gmo\tGNU format message catalog\n"
15822 #: build/C/man7/suffixes.7:138
15824 msgid " .gsf\tGhostscript fonts\n"
15828 #: build/C/man7/suffixes.7:139
15830 msgid " .gz\tfile compressed using B<gzip>(1)\n"
15834 #: build/C/man7/suffixes.7:140
15836 msgid " .h\tC or C++ header files\n"
15840 #: build/C/man7/suffixes.7:141
15842 msgid " .help\thelp file\n"
15846 #: build/C/man7/suffixes.7:142
15848 msgid " .hf\tequivalent to I<.help>\n"
15852 #: build/C/man7/suffixes.7:143
15854 msgid " .hlp\tequivalent to I<.help>\n"
15858 #: build/C/man7/suffixes.7:144
15860 msgid " .htm\tpoor man's I<.html>\n"
15864 #: build/C/man7/suffixes.7:145
15866 msgid " .html\tHTML document used with the World Wide Web\n"
15870 #: build/C/man7/suffixes.7:146
15872 msgid " .hqx\t7-bit encoded Macintosh file\n"
15876 #: build/C/man7/suffixes.7:147
15878 msgid " .i\tC source after preprocessing\n"
15882 #: build/C/man7/suffixes.7:148
15884 msgid " .icon\tbitmap source\n"
15888 #: build/C/man7/suffixes.7:149
15890 msgid " .idx\treference or datum-index file for hypertext\n"
15894 #: build/C/man7/suffixes.7:150
15896 msgid "\tor database system\n"
15900 #: build/C/man7/suffixes.7:151
15902 msgid " .image\tbitmap source\n"
15906 #: build/C/man7/suffixes.7:152
15908 msgid " .in\tconfiguration template, especially for GNU Autoconf\n"
15912 #: build/C/man7/suffixes.7:153
15914 msgid " .info\tfiles for the Emacs info browser\n"
15918 #: build/C/man7/suffixes.7:154
15920 msgid " .info-[0-9]+\tsplit info files\n"
15924 #: build/C/man7/suffixes.7:155
15926 msgid " .ins\tLaTeX package install file for docstrip\n"
15930 #: build/C/man7/suffixes.7:156
15932 msgid " .itcl\titcl source code;\n"
15936 #: build/C/man7/suffixes.7:157
15938 msgid "\titcl ([incr Tcl]) is an OO extension of tcl\n"
15942 #: build/C/man7/suffixes.7:158
15944 msgid " .java\ta Java source file\n"
15948 #: build/C/man7/suffixes.7:159
15950 msgid " .jpeg\tJoint Photographic Experts Group format\n"
15954 #: build/C/man7/suffixes.7:160
15956 msgid " .jpg\tpoor man's I<.jpeg>\n"
15960 #: build/C/man7/suffixes.7:161
15962 msgid " .kmap\tB<lyx>(1) keymap\n"
15966 #: build/C/man7/suffixes.7:162
15968 msgid " .l\tequivalent to I<.lex> or I<.lisp>\n"
15972 #: build/C/man7/suffixes.7:163
15974 msgid " .lex\tB<lex>(1) or B<flex>(1) files\n"
15978 #: build/C/man7/suffixes.7:164
15980 msgid " .lha\tlharc archive\n"
15984 #: build/C/man7/suffixes.7:165
15986 msgid " .lib\tCommon-Lisp library\n"
15990 #: build/C/man7/suffixes.7:166
15992 msgid " .lisp\tLisp source\n"
15996 #: build/C/man7/suffixes.7:167
15998 msgid " .ln\tfiles for use with B<lint>(1)\n"
16002 #: build/C/man7/suffixes.7:168
16004 msgid " .log\tlog file, in particular produced by TeX\n"
16008 #: build/C/man7/suffixes.7:169
16010 msgid " .lsm\tLinux Software Map entry\n"
16014 #: build/C/man7/suffixes.7:170
16016 msgid " .lsp\tCommon-Lisp source\n"
16020 #: build/C/man7/suffixes.7:171
16022 msgid " .lzh\tlharc archive\n"
16026 #: build/C/man7/suffixes.7:172
16028 msgid " .m\tObjective-C source code\n"
16032 #: build/C/man7/suffixes.7:173
16034 msgid " .m4\tB<m4>(1) source\n"
16038 #: build/C/man7/suffixes.7:174
16040 msgid " .mac\tmacro files for various programs\n"
16044 #: build/C/man7/suffixes.7:175
16046 msgid " .man\tmanual page (usually source rather than formatted)\n"
16050 #: build/C/man7/suffixes.7:176
16052 msgid " .map\tmap files for various programs\n"
16056 #: build/C/man7/suffixes.7:177
16058 msgid " .me\tNroff source using the me macro package\n"
16062 #: build/C/man7/suffixes.7:178
16064 msgid " .mf\tMetafont (font generator for TeX) source\n"
16068 #: build/C/man7/suffixes.7:179
16070 msgid " .mgp\tMagicPoint file\n"
16074 #: build/C/man7/suffixes.7:180
16076 msgid " .mm\tsources for B<groff>(1) in mm - format\n"
16080 #: build/C/man7/suffixes.7:181
16082 msgid " .mo\tMessage catalog binary file\n"
16086 #: build/C/man7/suffixes.7:182
16088 msgid " .mod\tModula-2 source for implementation modules\n"
16092 #: build/C/man7/suffixes.7:183
16094 msgid " .mov\t(quicktime) movie\n"
16098 #: build/C/man7/suffixes.7:184
16100 msgid " .mp\tMetapost source\n"
16104 #: build/C/man7/suffixes.7:185
16106 msgid " .mp2\tMPEG Layer 2 (audio) file\n"
16110 #: build/C/man7/suffixes.7:186
16112 msgid " .mp3\tMPEG Layer 3 (audio) file\n"
16116 #: build/C/man7/suffixes.7:187
16118 msgid " .mpeg\tmovie file\n"
16122 #: build/C/man7/suffixes.7:188
16124 msgid " .o\tobject file\n"
16128 #: build/C/man7/suffixes.7:189
16130 msgid " .old\told or backup file\n"
16134 #: build/C/man7/suffixes.7:190
16136 msgid " .orig\tbackup (original) version of a file, from B<patch>(1)\n"
16140 #: build/C/man7/suffixes.7:191
16142 msgid " .out\toutput file, often executable program (a.out)\n"
16146 #: build/C/man7/suffixes.7:192
16148 msgid " .p\tPascal source\n"
16152 #: build/C/man7/suffixes.7:193
16154 msgid " .pag\tdbm data base data file\n"
16158 #: build/C/man7/suffixes.7:194
16160 msgid " .patch\tfile differences for B<patch>(1)\n"
16164 #: build/C/man7/suffixes.7:195
16166 msgid " .pbm\tportable bitmap format\n"
16170 #: build/C/man7/suffixes.7:196
16172 msgid " .pcf\tX11 font files\n"
16176 #: build/C/man7/suffixes.7:197
16178 msgid " .pdf\tAdobe Portable Data Format\n"
16182 #: build/C/man7/suffixes.7:198
16184 msgid "\t(use Acrobat/B<acroread> or B<xpdf>)\n"
16188 #: build/C/man7/suffixes.7:199
16190 msgid " .perl\tPerl source (see .ph, .pl and .pm)\n"
16194 #: build/C/man7/suffixes.7:200
16196 msgid " .pfa\tPostScript font definition files, ASCII format\n"
16200 #: build/C/man7/suffixes.7:201
16202 msgid " .pfb\tPostScript font definition files, binary format\n"
16206 #: build/C/man7/suffixes.7:202
16208 msgid " .pgm\tportable greymap format\n"
16212 #: build/C/man7/suffixes.7:203
16214 msgid " .pgp\tPGP binary data\n"
16218 #: build/C/man7/suffixes.7:204
16220 msgid " .ph\tPerl header file\n"
16224 #: build/C/man7/suffixes.7:205
16226 msgid " .php\tPHP program file\n"
16230 #: build/C/man7/suffixes.7:206
16232 msgid " .php3\tPHP3 program file\n"
16236 #: build/C/man7/suffixes.7:207
16238 msgid " .pid\tFile to store daemon PID (e.g., crond.pid)\n"
16242 #: build/C/man7/suffixes.7:208
16244 msgid " .pl\tTeX property list file or Perl library file\n"
16248 #: build/C/man7/suffixes.7:209
16250 msgid " .pm\tPerl module\n"
16254 #: build/C/man7/suffixes.7:210
16256 msgid " .png\tPortable Network Graphics file\n"
16260 #: build/C/man7/suffixes.7:211
16262 msgid " .po\tMessage catalog source\n"
16266 #: build/C/man7/suffixes.7:212
16268 msgid " .pod\tB<perldoc>(1) file\n"
16272 #: build/C/man7/suffixes.7:213
16274 msgid " .ppm\tportable pixmap format\n"
16278 #: build/C/man7/suffixes.7:214
16280 msgid " .pr\tbitmap source\n"
16284 #: build/C/man7/suffixes.7:215
16286 msgid " .ps\tPostScript file\n"
16290 #: build/C/man7/suffixes.7:216
16292 msgid " .py\tPython source\n"
16296 #: build/C/man7/suffixes.7:217
16298 msgid " .pyc\tcompiled python\n"
16302 #: build/C/man7/suffixes.7:218
16304 msgid " .qt\tquicktime movie\n"
16308 #: build/C/man7/suffixes.7:219
16310 msgid " .r\tRATFOR source (obsolete)\n"
16314 #: build/C/man7/suffixes.7:220
16316 msgid " .rej\tpatches that B<patch>(1) couldn't apply\n"
16320 #: build/C/man7/suffixes.7:221
16322 msgid " .rpm\tRPM software package\n"
16326 #: build/C/man7/suffixes.7:222
16328 msgid " .rtf\tRich Text Format file\n"
16332 #: build/C/man7/suffixes.7:223
16334 msgid " .rules\trules for something\n"
16338 #: build/C/man7/suffixes.7:224
16340 msgid " .s\tassembler source\n"
16344 #: build/C/man7/suffixes.7:225
16346 msgid " .sa\tstub libraries for a.out shared libraries\n"
16350 #: build/C/man7/suffixes.7:226
16352 msgid " .sc\tB<sc>(1) spreadsheet commands\n"
16356 #: build/C/man7/suffixes.7:227
16358 msgid " .scm\tScheme source code\n"
16362 #: build/C/man7/suffixes.7:228
16364 msgid " .sed\tsed source file\n"
16368 #: build/C/man7/suffixes.7:229
16370 msgid " .sgml\tSGML source file\n"
16374 #: build/C/man7/suffixes.7:230
16376 msgid " .sh\tB<sh>(1) scripts\n"
16380 #: build/C/man7/suffixes.7:231
16382 msgid " .shar\tarchive created by the B<shar>(1) utility\n"
16386 #: build/C/man7/suffixes.7:232
16388 msgid " .so\tShared library or dynamically loadable object\n"
16392 #: build/C/man7/suffixes.7:233
16394 msgid " .sql\tSQL source\n"
16398 #: build/C/man7/suffixes.7:234
16400 msgid " .sqml\tSQML schema or query program\n"
16404 #: build/C/man7/suffixes.7:235
16406 msgid " .sty\tLaTeX style files\n"
16410 #: build/C/man7/suffixes.7:236
16412 msgid " .sym\tModula-2 compiled definition modules\n"
16416 #: build/C/man7/suffixes.7:237
16418 msgid " .tar\tarchive created by the B<tar>(1) utility\n"
16422 #: build/C/man7/suffixes.7:238
16424 msgid " .tar.Z\ttar(1) archive compressed with B<compress>(1)\n"
16428 #: build/C/man7/suffixes.7:239
16430 msgid " .tar.bz2\ttar(1) archive compressed with B<bzip2>(1)\n"
16434 #: build/C/man7/suffixes.7:240
16436 msgid " .tar.gz\ttar(1) archive compressed with B<gzip>(1)\n"
16440 #: build/C/man7/suffixes.7:241
16442 msgid " .taz\ttar(1) archive compressed with B<compress>(1)\n"
16446 #: build/C/man7/suffixes.7:242
16448 msgid " .tcl\ttcl source code\n"
16452 #: build/C/man7/suffixes.7:243
16454 msgid " .tex\tTeX or LaTeX source\n"
16458 #: build/C/man7/suffixes.7:244
16460 msgid " .texi\tequivalent to I<.texinfo>\n"
16464 #: build/C/man7/suffixes.7:245
16466 msgid " .texinfo\tTexinfo documentation source\n"
16470 #: build/C/man7/suffixes.7:246
16472 msgid " .text\ttext file\n"
16476 #: build/C/man7/suffixes.7:247
16478 msgid " .tfm\tTeX font metric file\n"
16482 #: build/C/man7/suffixes.7:248
16484 msgid " .tgz\ttar archive compressed with B<gzip>(1)\n"
16488 #: build/C/man7/suffixes.7:249
16490 msgid " .tif\tpoor man's I<.tiff>\n"
16494 #: build/C/man7/suffixes.7:250
16496 msgid " .tiff\tTagged Image File Format\n"
16500 #: build/C/man7/suffixes.7:251
16502 msgid " .tk\ttcl/tk script\n"
16506 #: build/C/man7/suffixes.7:252
16508 msgid " .tmp\ttemporary file\n"
16512 #: build/C/man7/suffixes.7:253
16514 msgid " .tmpl\ttemplate files\n"
16518 #: build/C/man7/suffixes.7:254
16520 msgid " .txt\tequivalent to I<.text>\n"
16524 #: build/C/man7/suffixes.7:255
16526 msgid " .uu\tequivalent to I<.uue>\n"
16530 #: build/C/man7/suffixes.7:256
16532 msgid " .uue\tbinary file encoded with B<uuencode>(1)\n"
16536 #: build/C/man7/suffixes.7:257
16538 msgid " .vf\tTeX virtual font file\n"
16542 #: build/C/man7/suffixes.7:258
16544 msgid " .vpl\tTeX virtual property list file\n"
16548 #: build/C/man7/suffixes.7:259
16550 msgid " .w\tSilvio Levi's CWEB\n"
16554 #: build/C/man7/suffixes.7:260
16556 msgid " .wav\twave sound file\n"
16560 #: build/C/man7/suffixes.7:261
16562 msgid " .web\tDonald Knuth's WEB\n"
16566 #: build/C/man7/suffixes.7:262
16568 msgid " .wml\tSource file for Web Meta Language\n"
16572 #: build/C/man7/suffixes.7:263
16574 msgid " .xbm\tX11 bitmap source\n"
16578 #: build/C/man7/suffixes.7:264
16580 msgid " .xcf\tGIMP graphic\n"
16584 #: build/C/man7/suffixes.7:265
16586 msgid " .xml\teXtended Markup Language file\n"
16590 #: build/C/man7/suffixes.7:266
16592 msgid " .xpm\tX11 pixmap source\n"
16596 #: build/C/man7/suffixes.7:267
16598 msgid " .xs\tPerl xsub file produced by h2xs\n"
16602 #: build/C/man7/suffixes.7:268
16604 msgid " .xsl\tXSL stylesheet\n"
16608 #: build/C/man7/suffixes.7:269
16610 msgid " .y\tB<yacc>(1) or B<bison>(1) (parser generator) files\n"
16614 #: build/C/man7/suffixes.7:270
16616 msgid " .z\tFile compressed using B<pack>(1) (or an old B<gzip>(1))\n"
16620 #: build/C/man7/suffixes.7:271
16622 msgid " .zip\tB<zip>(1) archive\n"
16626 #: build/C/man7/suffixes.7:272
16628 msgid " .zoo\tB<zoo>(1) archive\n"
16632 #: build/C/man7/suffixes.7:273
16634 msgid " ~\tEmacs or B<patch>(1) backup file\n"
16638 #: build/C/man7/suffixes.7:274
16640 msgid " rc\tstartup (`run control') file, e.g., I<.newsrc>\n"
16643 #. type: Plain text
16644 #: build/C/man7/suffixes.7:278
16645 msgid "General UNIX conventions."
16648 #. type: Plain text
16649 #: build/C/man7/suffixes.7:280
16650 msgid "This list is not exhaustive."
16653 #. type: Plain text
16654 #: build/C/man7/suffixes.7:283
16655 msgid "B<file>(1), B<make>(1)"
16659 #: build/C/man3/undocumented.3:29
16661 msgid "UNDOCUMENTED"
16665 #: build/C/man3/undocumented.3:29
16670 #. type: Plain text
16671 #: build/C/man3/undocumented.3:32
16672 msgid "none - undocumented library functions"
16675 #. type: Plain text
16676 #: build/C/man3/undocumented.3:34
16677 msgid "Undocumented library functions"
16680 #. type: Plain text
16681 #: build/C/man3/undocumented.3:37
16683 "This man page mentions those library functions which are implemented in the "
16684 "standard libraries but not yet documented in man pages."
16688 #: build/C/man3/undocumented.3:37
16690 msgid "Solicitation"
16693 #. type: Plain text
16694 #: build/C/man3/undocumented.3:43
16696 "If you have information about these functions, please look in the source "
16697 "code, write a man page (using a style similar to that of the other Linux "
16698 "section 3 man pages), and send it to B<mtk.manpages@gmail.com> for inclusion "
16699 "in the next man page release."
16703 #: build/C/man3/undocumented.3:43
16708 #. .BR chflags (3),
16709 #. .BR fattach (3),
16710 #. .BR fchflags (3),
16712 #. .BR fdetach (3),
16713 #. .BR obstack stuff (3),
16714 #. type: Plain text
16715 #: build/C/man3/undocumented.3:183
16717 "B<authdes_create>(3), B<authdes_getucred>(3), B<authdes_pk_create>(3), "
16718 "B<clntunix_create>(3), B<creat64>(3), B<dn_skipname>(3), B<fcrypt>(3), "
16719 "B<fp_nquery>(3), B<fp_query>(3), B<fp_resstat>(3), B<freading>(3), "
16720 "B<freopen64>(3), B<fseeko64>(3), B<ftello64>(3), B<ftw64>(3), B<fwscanf>(3), "
16721 "B<get_avphys_pages>(3), B<getdirentries64>(3), B<getmsg>(3), "
16722 "B<getnetname>(3), B<get_nprocs>(3), B<get_nprocs_conf>(3), "
16723 "B<get_phys_pages>(3), B<getpublickey>(3), B<getsecretkey>(3), "
16724 "B<h_errlist>(3), B<host2netname>(3), B<hostalias>(3), B<inet_nsap_addr>(3), "
16725 "B<inet_nsap_ntoa>(3), B<init_des>(3), B<libc_nls_init>(3), B<lio_listio>(3), "
16726 "B<mstats>(3), B<netname2host>(3), B<netname2user>(3), B<nlist>(3), "
16727 "B<obstack_free>(3), B<parse_printf_format>(3), B<p_cdname>(3), "
16728 "B<p_cdnname>(3), B<p_class>(3), B<p_fqname>(3), B<p_option>(3), "
16729 "B<p_query>(3), B<printf_size>(3), B<printf_size_info>(3), B<p_rr>(3), "
16730 "B<p_time>(3), B<p_type>(3), B<putlong>(3), B<putshort>(3), "
16731 "B<re_compile_fastmap>(3), B<re_compile_pattern>(3), "
16732 "B<register_printf_function>(3), B<re_match>(3), B<re_match_2>(3), "
16733 "B<re_rx_search>(3), B<re_search>(3), B<re_search_2>(3), "
16734 "B<re_set_registers>(3), B<re_set_syntax>(3), B<res_send_setqhook>(3), "
16735 "B<res_send_setrhook>(3), B<ruserpass>(3), B<setfileno>(3), "
16736 "B<sethostfile>(3), B<svc_exit>(3), B<svcudp_enablecache>(3), B<tell>(3), "
16737 "B<tr_break>(3), B<tzsetwall>(3), B<ufc_dofinalperm>(3), B<ufc_doit>(3), "
16738 "B<user2netname>(3), B<vlimit>(3), B<vtimes>(3), B<wcschrnul>(3), "
16739 "B<wcsftime>(3), B<wscanf>(3), B<xdr_authdes_cred>(3), "
16740 "B<xdr_authdes_verf>(3), B<xdr_cryptkeyarg>(3), B<xdr_cryptkeyres>(3), "
16741 "B<xdr_datum>(3), B<xdr_des_block>(3), B<xdr_domainname>(3), "
16742 "B<xdr_getcredres>(3), B<xdr_keybuf>(3), B<xdr_keystatus>(3), "
16743 "B<xdr_mapname>(3), B<xdr_netnamestr>(3), B<xdr_netobj>(3), B<xdr_passwd>(3), "
16744 "B<xdr_peername>(3), B<xdr_rmtcall_args>(3), B<xdr_rmtcallres>(3), "
16745 "B<xdr_unixcred>(3), B<xdr_yp_buf>(3), B<xdr_yp_inaddr>(3), "
16746 "B<xdr_ypbind_binding>(3), B<xdr_ypbind_resp>(3), B<xdr_ypbind_resptype>(3), "
16747 "B<xdr_ypbind_setdom>(3), B<xdr_ypdelete_args>(3), B<xdr_ypmaplist>(3), "
16748 "B<xdr_ypmaplist_str>(3), B<xdr_yppasswd>(3), B<xdr_ypreq_key>(3), "
16749 "B<xdr_ypreq_nokey>(3), B<xdr_ypresp_all>(3), B<xdr_ypresp_all_seq>(3), "
16750 "B<xdr_ypresp_key_val>(3), B<xdr_ypresp_maplist>(3), B<xdr_ypresp_master>(3), "
16751 "B<xdr_ypresp_order>(3), B<xdr_ypresp_val>(3), B<xdr_ypstat>(3), "
16752 "B<xdr_ypupdate_args>(3), B<yp_all>(3), B<yp_bind>(3), B<yperr_string>(3), "
16753 "B<yp_first>(3), B<yp_get_default_domain>(3), B<yp_maplist>(3), "
16754 "B<yp_master>(3), B<yp_match>(3), B<yp_next>(3), B<yp_order>(3), "
16755 "B<ypprot_err>(3), B<yp_unbind>(3), B<yp_update>(3)"
16759 #: build/C/man2/unimplemented.2:26
16761 msgid "UNIMPLEMENTED"
16765 #: build/C/man2/unimplemented.2:26
16770 #. type: Plain text
16771 #: build/C/man2/unimplemented.2:31
16773 "afs_syscall, break, fattach, fdetach, ftime, getmsg, getpmsg, gtty, "
16774 "isastream, lock, madvise1, mpx, prof, profil, putmsg, putpmsg, security, "
16775 "stty, tuxcall, ulimit, vserver - unimplemented system calls"
16778 #. type: Plain text
16779 #: build/C/man2/unimplemented.2:33
16780 msgid "Unimplemented system calls."
16783 #. type: Plain text
16784 #: build/C/man2/unimplemented.2:35
16785 msgid "These system calls are not implemented in the Linux kernel."
16788 #. type: Plain text
16789 #: build/C/man2/unimplemented.2:40
16790 msgid "These system calls always return -1 and set I<errno> to B<ENOSYS>."
16793 #. type: Plain text
16794 #: build/C/man2/unimplemented.2:47
16796 "Note that B<ftime>(3), B<profil>(3), and B<ulimit>(3) are implemented as "
16797 "library functions."
16800 #. type: Plain text
16801 #: build/C/man2/unimplemented.2:56
16803 "Some system calls, like B<alloc_hugepages>(2), B<free_hugepages>(2), "
16804 "B<ioperm>(2), B<iopl>(2), and B<vm86>(2) exist only on certain "
16808 #. type: Plain text
16809 #: build/C/man2/unimplemented.2:64
16811 "Some system calls, like B<ipc>(2), B<create_module>(2), B<init_module>(2), "
16812 "and B<delete_module>(2) exist only when the Linux kernel was built with "
16813 "support for them."
16816 #. type: Plain text
16817 #: build/C/man2/unimplemented.2:66
16818 msgid "B<syscalls>(2)"
16822 #: build/C/man7/units.7:26
16827 #. type: Plain text
16828 #: build/C/man7/units.7:29
16829 msgid "units, kilo, kibi, mega, mebi, giga, gibi - decimal and binary prefixes"
16833 #: build/C/man7/units.7:30
16835 msgid "Decimal prefixes"
16838 #. type: Plain text
16839 #: build/C/man7/units.7:34
16841 "The SI system of units uses prefixes that indicate powers of ten. A "
16842 "kilometer is 1000 meter, and a megawatt is 1000000 watt. Below the standard "
16847 #: build/C/man7/units.7:37 build/C/man7/units.7:79
16849 msgid "Prefix\tName\tValue\n"
16853 #: build/C/man7/units.7:38
16855 msgid "y\tyocto\t10^-24 = 0.000000000000000000000001\n"
16859 #: build/C/man7/units.7:39
16861 msgid "z\tzepto\t10^-21 = 0.000000000000000000001\n"
16865 #: build/C/man7/units.7:40
16867 msgid "a\tatto\t10^-18 = 0.000000000000000001\n"
16871 #: build/C/man7/units.7:41
16873 msgid "f\tfemto\t10^-15 = 0.000000000000001\n"
16877 #: build/C/man7/units.7:42
16879 msgid "p\tpico\t10^-12 = 0.000000000001\n"
16883 #: build/C/man7/units.7:43
16885 msgid "n\tnano\t10^-9 = 0.000000001\n"
16889 #: build/C/man7/units.7:44
16891 msgid "\\(mc\tmicro\t10^-6 = 0.000001\n"
16895 #: build/C/man7/units.7:45
16897 msgid "m\tmilli\t10^-3 = 0.001\n"
16901 #: build/C/man7/units.7:46
16903 msgid "c\tcenti\t10^-2 = 0.01\n"
16907 #: build/C/man7/units.7:47
16909 msgid "d\tdeci\t10^-1 = 0.1\n"
16913 #: build/C/man7/units.7:48
16915 msgid "da\tdeka\t10^ 1 = 10\n"
16919 #: build/C/man7/units.7:49
16921 msgid "h\thecto\t10^ 2 = 100\n"
16925 #: build/C/man7/units.7:50
16927 msgid "k\tkilo\t10^ 3 = 1000\n"
16931 #: build/C/man7/units.7:51
16933 msgid "M\tmega\t10^ 6 = 1000000\n"
16937 #: build/C/man7/units.7:52
16939 msgid "G\tgiga\t10^ 9 = 1000000000\n"
16943 #: build/C/man7/units.7:53
16945 msgid "T\ttera\t10^12 = 1000000000000\n"
16949 #: build/C/man7/units.7:54
16951 msgid "P\tpeta\t10^15 = 1000000000000000\n"
16955 #: build/C/man7/units.7:55
16957 msgid "E\texa\t10^18 = 1000000000000000000\n"
16961 #: build/C/man7/units.7:56
16963 msgid "Z\tzetta\t10^21 = 1000000000000000000000\n"
16967 #: build/C/man7/units.7:57
16969 msgid "Y\tyotta\t10^24 = 1000000000000000000000000\n"
16972 #. type: Plain text
16973 #: build/C/man7/units.7:64
16975 "The symbol for micro is the Greek letter mu, often written u in an ASCII "
16976 "context where this Greek letter is not available. See also"
16979 #. type: Plain text
16980 #: build/C/man7/units.7:68
16981 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/prefixes.html> E<.UE>"
16985 #: build/C/man7/units.7:69
16987 msgid "Binary prefixes"
16990 #. type: Plain text
16991 #: build/C/man7/units.7:76
16993 "The binary prefixes resemble the decimal ones, but have an additional "
16994 "\\(aqi\\(aq (and \"Ki\" starts with a capital \\(aqK\\(aq). The names are "
16995 "formed by taking the first syllable of the names of the decimal prefix with "
16996 "roughly the same size, followed by \"bi\" for \"binary\"."
17000 #: build/C/man7/units.7:80
17002 msgid "Ki\tkibi\t2^10 = 1024\n"
17006 #: build/C/man7/units.7:81
17008 msgid "Mi\tmebi\t2^20 = 1048576\n"
17012 #: build/C/man7/units.7:82
17014 msgid "Gi\tgibi\t2^30 = 1073741824\n"
17018 #: build/C/man7/units.7:83
17020 msgid "Ti\ttebi\t2^40 = 1099511627776\n"
17024 #: build/C/man7/units.7:84
17026 msgid "Pi\tpebi\t2^50 = 1125899906842624\n"
17030 #: build/C/man7/units.7:85
17032 msgid "Ei\texbi\t2^60 = 1152921504606846976\n"
17035 #. type: Plain text
17036 #: build/C/man7/units.7:90
17040 #. type: Plain text
17041 #: build/C/man7/units.7:93
17042 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/binary.html> E<.UE>"
17046 #: build/C/man7/units.7:93
17051 #. type: Plain text
17052 #: build/C/man7/units.7:98
17054 "Before these binary prefixes were introduced, it was fairly common to use "
17055 "k=1000 and K=1024, just like b=bit, B=byte. Unfortunately, the M is capital "
17056 "already, and cannot be capitalized to indicate binary-ness."
17059 #. type: Plain text
17060 #: build/C/man7/units.7:109
17062 "At first that didn't matter too much, since memory modules and disks came in "
17063 "sizes that were powers of two, so everyone knew that in such contexts "
17064 "\"kilobyte\" and \"megabyte\" meant 1024 and 1048576 bytes, respectively. "
17065 "What originally was a sloppy use of the prefixes \"kilo\" and \"mega\" "
17066 "started to become regarded as the \"real true meaning\" when computers were "
17067 "involved. But then disk technology changed, and disk sizes became arbitrary "
17068 "numbers. After a period of uncertainty all disk manufacturers settled on "
17069 "the standard, namely k=1000, M=1000k, G=1000M."
17072 #. also common: 14.4k modem
17073 #. type: Plain text
17074 #: build/C/man7/units.7:116
17076 "The situation was messy: in the 14k4 modems, k=1000; in the 1.44MB "
17077 "diskettes, M=1024000; and so on. In 1998 the IEC approved the standard that "
17078 "defines the binary prefixes given above, enabling people to be precise and "
17082 #. type: Plain text
17083 #: build/C/man7/units.7:118
17084 msgid "Thus, today, MB = 1000000B and MiB = 1048576B."
17087 #. type: Plain text
17088 #: build/C/man7/units.7:122
17090 "In the free software world programs are slowly being changed to conform. "
17091 "When the Linux kernel boots and says"
17094 #. type: Plain text
17095 #: build/C/man7/units.7:126
17097 msgid "hda: 120064896 sectors (61473 MB) w/2048KiB Cache\n"
17100 #. type: Plain text
17101 #: build/C/man7/units.7:130
17102 msgid "the MB are megabytes and the KiB are kibibytes."
17105 #. Copyright (c) 1990, 1993
17106 #. The Regents of the University of California. All rights reserved.
17108 #. %%%LICENSE_START(BSD_4_CLAUSE_UCB)
17109 #. Redistribution and use in source and binary forms, with or without
17110 #. modification, are permitted provided that the following conditions
17112 #. 1. Redistributions of source code must retain the above copyright
17113 #. notice, this list of conditions and the following disclaimer.
17114 #. 2. Redistributions in binary form must reproduce the above copyright
17115 #. notice, this list of conditions and the following disclaimer in the
17116 #. documentation and/or other materials provided with the distribution.
17117 #. 3. All advertising materials mentioning features or use of this software
17118 #. must display the following acknowledgement:
17119 #. This product includes software developed by the University of
17120 #. California, Berkeley and its contributors.
17121 #. 4. Neither the name of the University nor the names of its contributors
17122 #. may be used to endorse or promote products derived from this software
17123 #. without specific prior written permission.
17125 #. THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17126 #. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17127 #. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17128 #. ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
17129 #. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17130 #. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
17131 #. OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
17132 #. HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
17133 #. LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
17134 #. OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
17138 #. @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
17139 #. $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $
17141 #. This tutorial sampler invokes every macro in the package several
17142 #. times and is guaranteed to give a worst case performance
17143 #. for an already extremely slow package.
17145 #. String \*(Pu was not defined, probably means punctuation
17147 #: build/C/man7/mdoc.samples.7:42
17149 msgid "[ .,:;()[]?! ]"
17153 #: build/C/man7/mdoc.samples.7:43
17155 msgid "December 30, 1993"
17159 #: build/C/man7/mdoc.samples.7:45
17161 msgid "MDOC.SAMPLES 7"
17164 #. type: Plain text
17165 #: build/C/man7/mdoc.samples.7:48
17166 msgid "E<.Nm mdoc.samples>"
17170 #: build/C/man7/mdoc.samples.7:48
17172 msgid "tutorial sampler for writing"
17175 #. type: Plain text
17176 #: build/C/man7/mdoc.samples.7:52
17177 msgid "E<.Bx> manuals with E<.Nm \\-mdoc>"
17180 #. type: Plain text
17181 #: build/C/man7/mdoc.samples.7:54
17182 msgid "E<.Nm man mdoc.samples>"
17185 #. type: Plain text
17186 #: build/C/man7/mdoc.samples.7:100
17188 "A tutorial sampler for writing E<.Bx> manual pages with the E<.Nm \\-mdoc> "
17189 "macro package, a E<.Em content Ns \\-based> and E<.Em domain Ns \\-based> "
17190 "formatting package for E<.Xr troff 1>. Its predecessor, the E<.Xr \\-man 7> "
17191 "package, addressed page layout leaving the manipulation of fonts and other "
17192 "typesetting details to the individual author. In E<.Nm \\-mdoc>, page "
17193 "layout macros make up the E<.Em \"page structure domain\"> which consists of "
17194 "macros for titles, section headers, displays and lists. Essentially items "
17195 "which affect the physical position of text on a formatted page. In addition "
17196 "to the page structure domain, there are two more domains, the manual domain "
17197 "and the general text domain. The general text domain is defined as macros "
17198 "which perform tasks such as quoting or emphasizing pieces of text. The "
17199 "manual domain is defined as macros that are a subset of the day to day "
17200 "informal language used to describe commands, routines and related E<.Bx> "
17201 "files. Macros in the manual domain handle command names, command-line "
17202 "arguments and options, function names, function parameters, pathnames, "
17203 "variables, cross references to other manual pages, and so on. These domain "
17204 "items have value for both the author and the future user of the manual "
17205 "page. It is hoped the consistency gained across the manual set will provide "
17206 "easier translation to future documentation tools."
17209 #. type: Plain text
17210 #: build/C/man7/mdoc.samples.7:107
17212 "Throughout the E<.Ux> manual pages, a manual entry is simply referred to as "
17213 "a man page, regardless of actual length and without sexist intention."
17217 #: build/C/man7/mdoc.samples.7:107
17219 msgid "GETTING STARTED"
17222 #. type: Plain text
17223 #: build/C/man7/mdoc.samples.7:113
17225 "Since a tutorial document is normally read when a person desires to use the "
17226 "material immediately, the assumption has been made that the user of this "
17227 "document may be impatient. The material presented in the remained of this "
17228 "document is outlined as follows:"
17231 #. type: Plain text
17232 #: build/C/man7/mdoc.samples.7:116
17233 msgid "E<.Tn \"TROFF IDIOSYNCRASIES\">"
17237 #: build/C/man7/mdoc.samples.7:117
17239 msgid "\"Macro Usage\" ."
17243 #: build/C/man7/mdoc.samples.7:118
17245 msgid "\"Passing Space Characters in an Argument\" ."
17249 #: build/C/man7/mdoc.samples.7:119
17251 msgid "\"Trailing Blank Space Characters (a warning)\" ."
17255 #: build/C/man7/mdoc.samples.7:120
17257 msgid "\"Escaping Special Characters\" ."
17260 #. type: Plain text
17261 #: build/C/man7/mdoc.samples.7:124
17262 msgid "E<.Tn \"THE ANATOMY OF A MAN PAGE\">"
17266 #: build/C/man7/mdoc.samples.7:125
17268 msgid "\"A manual page template\" ."
17271 #. type: Plain text
17272 #: build/C/man7/mdoc.samples.7:129
17273 msgid "E<.Tn \"TITLE MACROS\">."
17276 #. type: Plain text
17277 #: build/C/man7/mdoc.samples.7:131
17278 msgid "E<.Tn \"INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS\">."
17282 #: build/C/man7/mdoc.samples.7:132
17284 msgid "\"What's in a name...\" ."
17288 #: build/C/man7/mdoc.samples.7:133
17290 msgid "\"General Syntax\" ."
17293 #. type: Plain text
17294 #: build/C/man7/mdoc.samples.7:137
17295 msgid "E<.Tn \"MANUAL DOMAIN\">"
17299 #: build/C/man7/mdoc.samples.7:138
17301 msgid "Addresses ."
17305 #: build/C/man7/mdoc.samples.7:139
17307 msgid "\"Author name\" ."
17311 #: build/C/man7/mdoc.samples.7:140
17313 msgid "Arguments ."
17317 #: build/C/man7/mdoc.samples.7:141
17319 msgid "\"Configuration Declarations (section four only)\" ."
17323 #: build/C/man7/mdoc.samples.7:142
17325 msgid "\"Command Modifier\" ."
17329 #: build/C/man7/mdoc.samples.7:143
17331 msgid "\"Defined Variables\" ."
17335 #: build/C/man7/mdoc.samples.7:144
17337 msgid "\"Errno's (Section two only)\" ."
17341 #: build/C/man7/mdoc.samples.7:145
17343 msgid "\"Environment Variables\" ."
17347 #: build/C/man7/mdoc.samples.7:146
17349 msgid "\"Function Argument\" ."
17353 #: build/C/man7/mdoc.samples.7:147
17355 msgid "\"Function Declaration\" ."
17359 #: build/C/man7/mdoc.samples.7:148
17365 #: build/C/man7/mdoc.samples.7:149
17367 msgid "\"Functions (library routines)\" ."
17371 #: build/C/man7/mdoc.samples.7:150
17373 msgid "\"Function Types\" ."
17376 #. .It "Header File (including source code)" .
17378 #: build/C/man7/mdoc.samples.7:152
17380 msgid "\"Interactive Commands\" ."
17384 #: build/C/man7/mdoc.samples.7:153
17390 #: build/C/man7/mdoc.samples.7:154
17396 #: build/C/man7/mdoc.samples.7:155
17398 msgid "Pathnames ."
17402 #: build/C/man7/mdoc.samples.7:156
17404 msgid "Variables ."
17408 #: build/C/man7/mdoc.samples.7:157
17410 msgid "\"Cross References\" ."
17413 #. type: Plain text
17414 #: build/C/man7/mdoc.samples.7:161
17415 msgid "E<.Tn \"GENERAL TEXT DOMAIN\">"
17419 #: build/C/man7/mdoc.samples.7:162
17421 msgid "\"AT&T Macro\" ."
17425 #: build/C/man7/mdoc.samples.7:163
17427 msgid "\"BSD Macro\" ."
17431 #: build/C/man7/mdoc.samples.7:164
17433 msgid "\"FreeBSD Macro\" ."
17437 #: build/C/man7/mdoc.samples.7:165
17439 msgid "\"UNIX Macro\" ."
17443 #: build/C/man7/mdoc.samples.7:166
17445 msgid "Enclosure/Quoting Macros"
17449 #: build/C/man7/mdoc.samples.7:168
17451 msgid "\"Angle Bracket Quote/Enclosure\" ."
17455 #: build/C/man7/mdoc.samples.7:169
17457 msgid "\"Bracket Quotes/Enclosure\" ."
17461 #: build/C/man7/mdoc.samples.7:170
17463 msgid "\"Double Quote macro/Enclosure\" ."
17467 #: build/C/man7/mdoc.samples.7:171
17469 msgid "\"Parenthesis Quote/Enclosure\" ."
17473 #: build/C/man7/mdoc.samples.7:172
17475 msgid "\"Single Quotes/Enclosure\" ."
17479 #: build/C/man7/mdoc.samples.7:173
17481 msgid "\"Prefix Macro\" ."
17485 #: build/C/man7/mdoc.samples.7:175
17487 msgid "\"No\\-Op or Normal Text Macro\" ."
17491 #: build/C/man7/mdoc.samples.7:176
17493 msgid "\"No Space Macro\" ."
17497 #: build/C/man7/mdoc.samples.7:177
17499 msgid "\"Section Cross References\" ."
17503 #: build/C/man7/mdoc.samples.7:178
17505 msgid "\"References and Citations\" ."
17509 #: build/C/man7/mdoc.samples.7:179
17511 msgid "Return Values (sections two and three only)"
17515 #: build/C/man7/mdoc.samples.7:180
17517 msgid "\"Trade Names (Acronyms and Type Names)\" ."
17521 #: build/C/man7/mdoc.samples.7:181
17523 msgid "\"Extended Arguments\" ."
17526 #. type: Plain text
17527 #: build/C/man7/mdoc.samples.7:185
17528 msgid "E<.Tn \"PAGE STRUCTURE DOMAIN\">"
17532 #: build/C/man7/mdoc.samples.7:186
17534 msgid "\"Section Headers\" ."
17538 #: build/C/man7/mdoc.samples.7:187
17540 msgid "\"Paragraphs and Line Spacing\" ."
17544 #: build/C/man7/mdoc.samples.7:188
17550 #: build/C/man7/mdoc.samples.7:189
17556 #: build/C/man7/mdoc.samples.7:190
17558 msgid "\"Font Modes (Emphasis, Literal, and Symbolic)\" ."
17562 #: build/C/man7/mdoc.samples.7:191
17564 msgid "\"Lists and Columns\" ."
17567 #. type: Plain text
17568 #: build/C/man7/mdoc.samples.7:195
17569 msgid "E<.Tn \"PREDEFINED STRINGS\">"
17572 #. type: Plain text
17573 #: build/C/man7/mdoc.samples.7:197
17574 msgid "E<.Tn \"DIAGNOSTICS\">"
17577 #. type: Plain text
17578 #: build/C/man7/mdoc.samples.7:199
17579 msgid "E<.Tn \"FORMATTING WITH GROFF, TROFF AND NROFF\">"
17582 #. type: Plain text
17583 #: build/C/man7/mdoc.samples.7:201
17584 msgid "E<.Tn \"BUGS\">"
17588 #: build/C/man7/mdoc.samples.7:203
17590 msgid "TROFF IDIOSYNCRASIES"
17593 #. type: Plain text
17594 #: build/C/man7/mdoc.samples.7:217
17596 "The E<.Nm \\-mdoc> package attempts to simplify the process of writing a man "
17597 "page. Theoretically, one should not have to learn the dirty details of "
17598 "E<.Xr troff 1> to use E<.Nm \\-mdoc>; however, there are a few limitations "
17599 "which are unavoidable and best gotten out of the way. And, too, be "
17600 "forewarned, this package is E<.Em not> fast."
17604 #: build/C/man7/mdoc.samples.7:217
17606 msgid "Macro Usage"
17609 #. type: Plain text
17610 #: build/C/man7/mdoc.samples.7:242
17612 "As in E<.Xr troff 1>, a macro is called by placing a E<.Ql \\&.> (dot "
17613 "character) at the beginning of a line followed by the two character name "
17614 "for the macro. Arguments may follow the macro separated by spaces. It is "
17615 "the dot character at the beginning of the line which causes E<.Xr troff 1> "
17616 "to interpret the next two characters as a macro name. To place a E<.Ql "
17617 "\\&.> (dot character) at the beginning of a line in some context other than "
17618 "a macro invocation, precede the E<.Ql \\&.> (dot) with the E<.Ql \\e&> "
17619 "escape sequence. The E<.Ql \\e&> translates literally to a zero width "
17620 "space, and is never displayed in the output."
17623 #. type: Plain text
17624 #: build/C/man7/mdoc.samples.7:257
17626 "In general, E<.Xr troff 1> macros accept up to nine arguments, any extra "
17627 "arguments are ignored. Most macros in E<.Nm \\-mdoc> accept nine arguments "
17628 "and, in limited cases, arguments may be continued or extended on the next "
17629 "line (See E<.Sx Extensions>). A few macros handle quoted arguments (see "
17630 "E<.Sx Passing Space Characters in an Argument> below)."
17633 #. type: Plain text
17634 #: build/C/man7/mdoc.samples.7:284
17636 "Most of the E<.Nm \\-mdoc> general text domain and manual domain macros are "
17637 "special in that their argument lists are E<.Em parsed> for callable macro "
17638 "names. This means an argument on the argument list which matches a general "
17639 "text or manual domain macro name and is determined to be callable will be "
17640 "executed or called when it is processed. In this case, the argument, "
17641 "although the name of a macro, is not preceded by a E<.Ql \\&.> (dot). It is "
17642 "in this manner that many macros are nested; for example the option macro, "
17643 "E<.Ql \\&.Op>, may E<.Em call> the flag and argument macros, E<.Ql \\&Fl> "
17644 "and E<.Ql \\&Ar>, to specify an optional flag with an argument:"
17648 #: build/C/man7/mdoc.samples.7:285
17650 msgid "Op Fl s Ar bytes"
17653 #. type: Plain text
17654 #: build/C/man7/mdoc.samples.7:288
17655 msgid "is produced by E<.Li \\&.Op \\&Fl s \\&Ar bytes>"
17658 #. type: Plain text
17659 #: build/C/man7/mdoc.samples.7:295
17661 "To prevent a two character string from being interpreted as a macro name, "
17662 "precede the string with the escape sequence E<.Ql \\e&>:"
17666 #: build/C/man7/mdoc.samples.7:296
17668 msgid "Op \\&Fl s \\&Ar bytes"
17671 #. type: Plain text
17672 #: build/C/man7/mdoc.samples.7:299
17673 msgid "is produced by E<.Li \\&.Op \\e&Fl s \\e&Ar bytes>"
17676 #. type: Plain text
17677 #: build/C/man7/mdoc.samples.7:320
17679 "Here the strings E<.Ql \\&Fl> and E<.Ql \\&Ar> are not interpreted as "
17680 "macros. Macros whose argument lists are parsed for callable arguments are "
17681 "referred to as parsed and macros which may be called from an argument list "
17682 "are referred to as callable throughout this document and in the companion "
17683 "quick reference manual E<.Xr mdoc 7>. This is a technical E<.Em faux pas> "
17684 "as almost all of the macros in E<.Nm \\-mdoc> are parsed, but as it was "
17685 "cumbersome to constantly refer to macros as being callable and being able to "
17686 "call other macros, the term parsed has been used."
17690 #: build/C/man7/mdoc.samples.7:320
17692 msgid "Passing Space Characters in an Argument"
17695 #. type: Plain text
17696 #: build/C/man7/mdoc.samples.7:338
17698 "Sometimes it is desirable to give as one argument a string containing one or "
17699 "more blank space characters. This may be necessary to defeat the nine "
17700 "argument limit or to specify arguments to macros which expect particular "
17701 "arrangement of items in the argument list. For example, the function macro "
17702 "E<.Ql \\&.Fn> expects the first argument to be the name of a function and "
17703 "any remaining arguments to be function parameters. As E<.Tn \"ANSI C\"> "
17704 "stipulates the declaration of function parameters in the parenthesized "
17705 "parameter list, each parameter is guaranteed to be at minimum a two word "
17706 "string. For example, E<.Fa int foo>."
17709 #. type: Plain text
17710 #: build/C/man7/mdoc.samples.7:353
17712 "There are two possible ways to pass an argument which contains an embedded "
17713 "space. E<.Em Implementation note>: Unfortunately, the most convenient way "
17714 "of passing spaces in between quotes by reassigning individual arguments "
17715 "before parsing was fairly expensive speed wise and space wise to implement "
17716 "in all the macros for E<.Tn AT&T> E<.Xr troff>. It is not expensive for "
17717 "E<.Xr groff> but for the sake of portability, has been limited to the "
17718 "following macros which need it the most:"
17722 #: build/C/man7/mdoc.samples.7:355
17727 #. type: Plain text
17728 #: build/C/man7/mdoc.samples.7:358
17729 msgid "Configuration declaration (section 4 E<.Sx SYNOPSIS>)"
17733 #: build/C/man7/mdoc.samples.7:358
17738 #. type: Plain text
17739 #: build/C/man7/mdoc.samples.7:360
17740 msgid "Begin list (for the width specifier)."
17744 #: build/C/man7/mdoc.samples.7:360
17749 #. type: Plain text
17750 #: build/C/man7/mdoc.samples.7:362
17751 msgid "Emphasized text."
17755 #: build/C/man7/mdoc.samples.7:362
17760 #. type: Plain text
17761 #: build/C/man7/mdoc.samples.7:364
17762 msgid "Functions (sections two and four)."
17766 #: build/C/man7/mdoc.samples.7:364
17771 #. type: Plain text
17772 #: build/C/man7/mdoc.samples.7:366
17773 msgid "List items."
17777 #: build/C/man7/mdoc.samples.7:366
17782 #. type: Plain text
17783 #: build/C/man7/mdoc.samples.7:368
17784 msgid "Literal text."
17788 #: build/C/man7/mdoc.samples.7:368
17793 #. type: Plain text
17794 #: build/C/man7/mdoc.samples.7:370
17795 msgid "Symbolic text."
17799 #: build/C/man7/mdoc.samples.7:370
17804 #. type: Plain text
17805 #: build/C/man7/mdoc.samples.7:372
17806 msgid "Book titles."
17810 #: build/C/man7/mdoc.samples.7:372
17815 #. type: Plain text
17816 #: build/C/man7/mdoc.samples.7:374
17817 msgid "Journal names."
17821 #: build/C/man7/mdoc.samples.7:374
17826 #. type: Plain text
17827 #: build/C/man7/mdoc.samples.7:376
17828 msgid "Optional notes for a reference."
17832 #: build/C/man7/mdoc.samples.7:376
17837 #. type: Plain text
17838 #: build/C/man7/mdoc.samples.7:378
17839 msgid "Report title (in a reference)."
17843 #: build/C/man7/mdoc.samples.7:378
17848 #. type: Plain text
17849 #: build/C/man7/mdoc.samples.7:380
17850 msgid "Title of article in a book or journal."
17853 #. type: Plain text
17854 #: build/C/man7/mdoc.samples.7:397
17856 "One way of passing a string containing blank spaces is to use the hard or "
17857 "unpaddable space character E<.Ql \\e\\ >, that is, a blank space preceded by "
17858 "the escape character E<.Ql \\e>. This method may be used with any macro but "
17859 "has the side effect of interfering with the adjustment of text over the "
17860 "length of a line. E<.Xr Troff> sees the hard space as if it were any other "
17861 "printable character and cannot split the string into blank or newline "
17862 "separated pieces as one would expect. The method is useful for strings "
17863 "which are not expected to overlap a line boundary. For example:"
17867 #: build/C/man7/mdoc.samples.7:398
17869 msgid "Fn fetch char\\ *str"
17872 #. type: Plain text
17873 #: build/C/man7/mdoc.samples.7:401
17874 msgid "is created by E<.Ql \\&.Fn fetch char\\e *str>"
17878 #: build/C/man7/mdoc.samples.7:401
17880 msgid "Fn fetch \"char *str\""
17883 #. type: Plain text
17884 #: build/C/man7/mdoc.samples.7:404
17885 msgid "can also be created by E<.Ql \\&.Fn fetch \"\\*qchar *str\\*q\">"
17888 #. type: Plain text
17889 #: build/C/man7/mdoc.samples.7:413
17891 "If the E<.Ql \\e> or quotes were omitted, E<.Ql \\&.Fn> would see three "
17892 "arguments and the result would be:"
17896 #: build/C/man7/mdoc.samples.7:414
17898 msgid "Fn fetch char *str"
17901 #. type: Plain text
17902 #: build/C/man7/mdoc.samples.7:420
17904 "For an example of what happens when the parameter list overlaps a newline "
17905 "boundary, see the E<.Sx BUGS> section."
17909 #: build/C/man7/mdoc.samples.7:420
17911 msgid "Trailing Blank Space Characters"
17914 #. type: Plain text
17915 #: build/C/man7/mdoc.samples.7:433
17917 "E<.Xr Troff> can be confused by blank space characters at the end of a "
17918 "line. It is a wise preventive measure to globally remove all blank spaces "
17919 "from E<lt>blank-spaceE<gt>E<lt>end-of-lineE<gt> character sequences. Should "
17920 "the need arise to force a blank character at the end of a line, it may be "
17921 "forced with an unpaddable space and the E<.Ql \\e&> escape character. For "
17922 "example, E<.Ql string\\e\\ \\e&>."
17926 #: build/C/man7/mdoc.samples.7:433
17928 msgid "Escaping Special Characters"
17931 #. type: Plain text
17932 #: build/C/man7/mdoc.samples.7:445
17934 "Special characters like the newline character E<.Ql \\en>, are handled by "
17935 "replacing the E<.Ql \\e> with E<.Ql \\ee> (e.g., E<.Ql \\een>) to preserve "
17940 #: build/C/man7/mdoc.samples.7:445
17942 msgid "THE ANATOMY OF A MAN PAGE"
17945 #. type: Plain text
17946 #: build/C/man7/mdoc.samples.7:452
17948 "The body of a man page is easily constructed from a basic template found in "
17949 "the file E<.Pa /usr/share/misc/mdoc.template>. Several example man pages "
17950 "can also be found in E<.Pa /usr/share/examples/mdoc>."
17954 #: build/C/man7/mdoc.samples.7:453
17956 msgid "A manual page template"
17959 #. type: Plain text
17960 #: build/C/man7/mdoc.samples.7:484
17963 "\\&.\\e\" The following requests are required for all man pages.\n"
17964 "\\&.Dd Month day, year\n"
17965 "\\&.Os OPERATING_SYSTEM [version/release]\n"
17966 "\\&.Dt DOCUMENT_TITLE [section number] [volume]\n"
17969 "\\&.Nd one line description of name\n"
17970 "\\&.Sh SYNOPSIS\n"
17971 "\\&.Sh DESCRIPTION\n"
17972 "\\&.\\e\" The following requests should be uncommented and\n"
17973 "\\&.\\e\" used where appropriate. This next request is\n"
17974 "\\&.\\e\" for sections 2 and 3 function return values only.\n"
17975 "\\&.\\e\" .Sh RETURN VALUE\n"
17976 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
17977 "\\&.\\e\" .Sh ENVIRONMENT\n"
17978 "\\&.\\e\" .Sh FILES\n"
17979 "\\&.\\e\" .Sh EXAMPLES\n"
17980 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
17981 "\\&.\\e\" (command return values (to shell) and\n"
17982 "\\&.\\e\"\t fprintf/stderr type diagnostics)\n"
17983 "\\&.\\e\" .Sh DIAGNOSTICS\n"
17984 "\\&.\\e\" The next request is for sections 2 and 3 error\n"
17985 "\\&.\\e\" and signal handling only.\n"
17986 "\\&.\\e\" .Sh ERRORS\n"
17987 "\\&.\\e\" .Sh SEE ALSO\n"
17988 "\\&.\\e\" .Sh CONFORMING TO\n"
17989 "\\&.\\e\" .Sh HISTORY\n"
17990 "\\&.\\e\" .Sh AUTHORS\n"
17991 "\\&.\\e\" .Sh BUGS\n"
17994 #. type: Plain text
17995 #: build/C/man7/mdoc.samples.7:498
17997 "The first items in the template are the macros E<.Pq Li \\&.Dd , \\&.Os , "
17998 "\\&.Dt>; the document date, the operating system the man page or subject "
17999 "source is developed or modified for, and the man page title E<.Pq Em in "
18000 "uppercase> along with the section of the manual the page belongs in. These "
18001 "macros identify the page, and are discussed below in E<.Sx TITLE MACROS>."
18004 #. type: Plain text
18005 #: build/C/man7/mdoc.samples.7:517
18007 "The remaining items in the template are section headers E<.Pq Li \\&.Sh>; of "
18008 "which E<.Sx NAME>, E<.Sx SYNOPSIS> and E<.Sx DESCRIPTION> are mandatory. "
18009 "The headers are discussed in E<.Sx PAGE STRUCTURE DOMAIN>, after "
18010 "presentation of E<.Sx MANUAL DOMAIN>. Several content macros are used to "
18011 "demonstrate page layout macros; reading about content macros before page "
18012 "layout macros is recommended."
18016 #: build/C/man7/mdoc.samples.7:517
18018 msgid "TITLE MACROS"
18021 #. type: Plain text
18022 #: build/C/man7/mdoc.samples.7:526
18024 "The title macros are the first portion of the page structure domain, but are "
18025 "presented first and separate for someone who wishes to start writing a man "
18026 "page yesterday. Three header macros designate the document title or manual "
18027 "page title, the operating system, and the date of authorship. These macros "
18028 "are one called once at the very beginning of the document and are used to "
18029 "construct the headers and footers only."
18033 #: build/C/man7/mdoc.samples.7:527
18035 msgid "Li \\&.Dt DOCUMENT_TITLE section# [volume]"
18039 #. USD UNIX User's Supplementary Documents
18041 #. PS1 UNIX Programmer's Supplementary Documents
18042 #. type: Plain text
18043 #: build/C/man7/mdoc.samples.7:541
18045 "The document title is the subject of the man page and must be in E<.Tn "
18046 "CAPITALS> due to troff limitations. The section number may be 1,\\ ...,\\ "
18047 "8, and if it is specified, the volume title may be omitted. A volume title "
18048 "may be arbitrary or one of the following:"
18052 #: build/C/man7/mdoc.samples.7:543
18054 msgid "Li \"AMD\tUNIX Ancestral Manual Documents\""
18058 #: build/C/man7/mdoc.samples.7:544
18060 msgid "Li \"SMM\tUNIX System Manager's Manual\""
18064 #: build/C/man7/mdoc.samples.7:545
18066 msgid "Li \"URM\tUNIX Reference Manual\""
18070 #: build/C/man7/mdoc.samples.7:546
18072 msgid "Li \"PRM\tUNIX Programmer's Manual\""
18076 #. MMI UNIX Manual Master Index
18078 #. CON UNIX Contributed Software Manual
18080 #. LOC UNIX Local Manual
18081 #. type: Plain text
18082 #: build/C/man7/mdoc.samples.7:562
18084 "The default volume labeling is E<.Li URM> for sections 1, 6, and 7; E<.Li "
18085 "SMM> for section 8; E<.Li PRM> for sections 2, 3, 4, and 5."
18089 #: build/C/man7/mdoc.samples.7:562
18091 msgid "Li \\&.Os operating_system release#"
18094 #. type: Plain text
18095 #: build/C/man7/mdoc.samples.7:575
18097 "The name of the operating system should be the common acronym, for example, "
18098 "E<.Tn BSD> or E<.Tn FreeBSD> or E<.Tn ATT>. The release should be the "
18099 "standard release nomenclature for the system specified, for example, 4.3, "
18100 "4.3+Tahoe, V.3, V.4. Unrecognized arguments are displayed as given in the "
18101 "page footer. For instance, a typical footer might be:"
18105 #: build/C/man7/mdoc.samples.7:576
18107 msgid "\\&.Os 4.3BSD"
18110 #. type: Plain text
18111 #: build/C/man7/mdoc.samples.7:579
18116 #: build/C/man7/mdoc.samples.7:579
18118 msgid "\\&.Os FreeBSD 2.2"
18121 #. type: Plain text
18122 #: build/C/man7/mdoc.samples.7:582
18123 msgid "or for a locally produced set"
18127 #: build/C/man7/mdoc.samples.7:583
18129 msgid "\\&.Os CS Department"
18132 #. type: Plain text
18133 #: build/C/man7/mdoc.samples.7:598
18135 "The Berkeley default, E<.Ql \\&.Os> without an argument, has been defined as "
18136 "E<.Tn BSD> in the site-specific file E<.Pa "
18137 "/usr/share/tmac/mdoc/doc-common>. It really should default to E<.Tn "
18138 "LOCAL>. Note, if the E<.Ql \\&.Os> macro is not present, the bottom left "
18139 "corner of the page will be ugly."
18143 #: build/C/man7/mdoc.samples.7:598
18145 msgid "Li \\&.Dd month day, year"
18148 #. type: Plain text
18149 #: build/C/man7/mdoc.samples.7:600
18150 msgid "The date should be written formally:"
18154 #: build/C/man7/mdoc.samples.7:602
18156 msgid "January 25, 1989"
18160 #: build/C/man7/mdoc.samples.7:604
18162 msgid "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
18166 #: build/C/man7/mdoc.samples.7:605
18168 msgid "What's in a name..."
18171 #. type: Plain text
18172 #: build/C/man7/mdoc.samples.7:622
18174 "The manual domain macro names are derived from the day to day informal "
18175 "language used to describe commands, subroutines and related files. Slightly "
18176 "different variations of this language are used to describe the three "
18177 "different aspects of writing a man page. First, there is the description of "
18178 "E<.Nm \\-mdoc> macro request usage. Second is the description of a E<.Ux> "
18179 "command E<.Em with> E<.Nm \\-mdoc> macros and third, the description of a "
18180 "command to a user in the verbal sense; that is, discussion of a command in "
18181 "the text of a man page."
18184 #. type: Plain text
18185 #: build/C/man7/mdoc.samples.7:627
18187 "In the first case, E<.Xr troff 1> macros are themselves a type of command; "
18188 "the general syntax for a troff command is:"
18191 #. type: Plain text
18192 #: build/C/man7/mdoc.samples.7:629
18194 msgid "\\&.Va argument1 argument2 ... argument9\n"
18197 #. type: Plain text
18198 #: build/C/man7/mdoc.samples.7:643
18200 "The E<.Ql \\&.Va> is a macro command or request, and anything following it "
18201 "is an argument to be processed. In the second case, the description of a "
18202 "E<.Ux> command using the content macros is a bit more involved; a typical "
18203 "E<.Sx SYNOPSIS> command line might be displayed as:"
18206 #. type: Plain text
18207 #: build/C/man7/mdoc.samples.7:647
18212 "E<.Ar infile outfile>\n"
18215 #. type: Plain text
18216 #: build/C/man7/mdoc.samples.7:667
18218 "Here, E<.Nm filter> is the command name and the bracketed string E<.Fl flag> "
18219 "is a E<.Em flag> argument designated as optional by the option brackets. In "
18220 "E<.Nm \\-mdoc> terms, E<.Ar infile> and E<.Ar outfile> are called E<.Em "
18221 "arguments>. The macros which formatted the above example:"
18224 #. type: Plain text
18225 #: build/C/man7/mdoc.samples.7:671
18229 "\\&.Op \\&Fl flag\n"
18230 "\\&.Ar infile outfile\n"
18233 #. type: Plain text
18234 #: build/C/man7/mdoc.samples.7:685
18236 "In the third case, discussion of commands and command syntax includes both "
18237 "examples above, but may add more detail. The arguments E<.Ar infile> and "
18238 "E<.Ar outfile> from the example above might be referred to as E<.Em "
18239 "operands> or E<.Em file arguments>. Some command-line argument lists are "
18244 #: build/C/man7/mdoc.samples.7:686
18249 #. type: Plain text
18250 #: build/C/man7/mdoc.samples.7:699
18252 "E<.Op Fl eiknqrstv> E<.Op Fl D Ar variable> E<.Op Fl d Ar flags> E<.Op Fl f "
18253 "Ar makefile> E<.Bk -words> E<.Op Fl I Ar directory> E<.Ek> E<.Op Fl j Ar "
18254 "max_jobs> E<.Op Ar variable=value> E<.Bk -words> E<.Op Ar target ...> E<.Ek>"
18257 #. type: Plain text
18258 #: build/C/man7/mdoc.samples.7:725
18260 "Here one might talk about the command E<.Nm make> and qualify the argument "
18261 "E<.Ar makefile>, as an argument to the flag, E<.Fl f>, or discuss the "
18262 "optional file operand E<.Ar target>. In the verbal context, such detail can "
18263 "prevent confusion, however the E<.Nm \\-mdoc> package does not have a macro "
18264 "for an argument E<.Em to> a flag. Instead the E<.Ql \\&Ar> argument macro "
18265 "is used for an operand or file argument like E<.Ar target> as well as an "
18266 "argument to a flag like E<.Ar variable>. The make command line was produced "
18270 #. type: Plain text
18271 #: build/C/man7/mdoc.samples.7:737
18275 "\\&.Op Fl eiknqrstv\n"
18276 "\\&.Op Fl D Ar variable\n"
18277 "\\&.Op Fl d Ar flags\n"
18278 "\\&.Op Fl f Ar makefile\n"
18279 "\\&.Op Fl I Ar directory\n"
18280 "\\&.Op Fl j Ar max_jobs\n"
18281 "\\&.Op Ar variable=value\n"
18283 "\\&.Op Ar target ...\n"
18287 #. type: Plain text
18288 #: build/C/man7/mdoc.samples.7:745
18289 msgid "The E<.Ql \\&.Bk> and E<.Ql \\&.Ek> macros are explained in E<.Sx Keeps>."
18293 #: build/C/man7/mdoc.samples.7:745
18295 msgid "General Syntax"
18298 #. type: Plain text
18299 #: build/C/man7/mdoc.samples.7:768
18301 "The manual domain and general text domain macros share a similar syntax with "
18302 "a few minor deviations: E<.Ql \\&.Ar>, E<.Ql \\&.Fl>, E<.Ql \\&.Nm>, and "
18303 "E<.Ql \\&.Pa> differ only when called without arguments; E<.Ql \\&.Fn> and "
18304 "E<.Ql \\&.Xr> impose an order on their argument lists and the E<.Ql \\&.Op> "
18305 "and E<.Ql \\&.Fn> macros have nesting limitations. All content macros are "
18306 "capable of recognizing and properly handling punctuation, provided each "
18307 "punctuation character is separated by a leading space. If a request is "
18312 #: build/C/man7/mdoc.samples.7:769
18314 msgid "\\&.Li sptr, ptr),"
18317 #. type: Plain text
18318 #: build/C/man7/mdoc.samples.7:772 build/C/man7/mdoc.samples.7:782
18319 msgid "The result is:"
18323 #: build/C/man7/mdoc.samples.7:773
18325 msgid "Li sptr, ptr),"
18328 #. type: Plain text
18329 #: build/C/man7/mdoc.samples.7:778
18331 "The punctuation is not recognized and all is output in the literal font. If "
18332 "the punctuation is separated by a leading white space:"
18336 #: build/C/man7/mdoc.samples.7:779
18338 msgid "\\&.Li \"sptr , ptr ) ,\""
18342 #: build/C/man7/mdoc.samples.7:783
18344 msgid "Li sptr , ptr ) ,"
18347 #. type: Plain text
18348 #: build/C/man7/mdoc.samples.7:787
18350 "The punctuation is now recognized and is output in the default font "
18351 "distinguishing it from the strings in literal font."
18354 #. type: Plain text
18355 #: build/C/man7/mdoc.samples.7:796
18357 "To remove the special meaning from a punctuation character escape it with "
18358 "E<.Ql \\e&>. E<.Xr Troff> is limited as a macro language, and has "
18359 "difficulty when presented with a string containing a member of the "
18360 "mathematical, logical or quotation set:"
18363 #. type: Plain text
18364 #: build/C/man7/mdoc.samples.7:798
18366 msgid "\\&{+,\\-,/,*,\\&%,E<lt>,E<gt>,E<lt>=,E<gt>=,=,==,&,`,',\"}\n"
18369 #. type: Plain text
18370 #: build/C/man7/mdoc.samples.7:810
18372 "The problem is that E<.Xr troff> may assume it is supposed to actually "
18373 "perform the operation or evaluation suggested by the characters. To prevent "
18374 "the accidental evaluation of these characters, escape them with E<.Ql "
18375 "\\e&>. Typical syntax is shown in the first content macro displayed below, "
18380 #: build/C/man7/mdoc.samples.7:810
18382 msgid "MANUAL DOMAIN"
18386 #: build/C/man7/mdoc.samples.7:811
18388 msgid "Address Macro"
18391 #. type: Plain text
18392 #: build/C/man7/mdoc.samples.7:814
18394 "The address macro identifies an address construct of the form "
18395 "addr1[,addr2[,addr3]]."
18399 #: build/C/man7/mdoc.samples.7:815
18401 msgid "Usage: .Ad address ... \\*(Pu"
18405 #: build/C/man7/mdoc.samples.7:817
18407 msgid "Li \\&.Ad addr1"
18410 #. type: Plain text
18411 #: build/C/man7/mdoc.samples.7:819
18412 msgid "E<.Ad addr1>"
18416 #: build/C/man7/mdoc.samples.7:819
18418 msgid "Li \\&.Ad addr1\\ ."
18421 #. type: Plain text
18422 #: build/C/man7/mdoc.samples.7:821
18423 msgid "E<.Ad addr1>."
18427 #: build/C/man7/mdoc.samples.7:821
18429 msgid "Li \\&.Ad addr1\\ , file2"
18432 #. type: Plain text
18433 #: build/C/man7/mdoc.samples.7:823
18434 msgid "E<.Ad addr1 , file2>"
18438 #: build/C/man7/mdoc.samples.7:823
18440 msgid "Li \\&.Ad f1\\ , f2\\ , f3\\ :"
18443 #. type: Plain text
18444 #: build/C/man7/mdoc.samples.7:825
18445 msgid "E<.Ad f1 , f2 , f3>:"
18449 #: build/C/man7/mdoc.samples.7:825
18451 msgid "Li \\&.Ad addr\\ )\\ )\\ ,"
18454 #. type: Plain text
18455 #: build/C/man7/mdoc.samples.7:827
18456 msgid "E<.Ad addr>)),"
18459 #. type: Plain text
18460 #: build/C/man7/mdoc.samples.7:834
18462 "It is an error to call E<.Ql \\&.Ad> without arguments. E<.Ql \\&.Ad> is "
18463 "callable by other macros and is parsed."
18467 #: build/C/man7/mdoc.samples.7:834
18469 msgid "Author Name"
18472 #. type: Plain text
18473 #: build/C/man7/mdoc.samples.7:841
18475 "The E<.Ql \\&.An> macro is used to specify the name of the author of the "
18476 "item being documented, or the name of the author of the actual manual page. "
18477 "Any remaining arguments after the name information are assumed to be "
18482 #: build/C/man7/mdoc.samples.7:842
18484 msgid "Usage: .An author_name \\*(Pu"
18488 #: build/C/man7/mdoc.samples.7:844
18490 msgid "Li \\&.An Joe\\ Author"
18493 #. type: Plain text
18494 #: build/C/man7/mdoc.samples.7:846
18495 msgid "E<.An Joe Author>"
18499 #: build/C/man7/mdoc.samples.7:846
18501 msgid "Li \\&.An Joe\\ Author\\ ,"
18504 #. type: Plain text
18505 #: build/C/man7/mdoc.samples.7:848
18506 msgid "E<.An Joe\\ Author>,"
18510 #: build/C/man7/mdoc.samples.7:848
18512 msgid "Li \\&.An Joe\\ Author\\ \\&Aq\\ nobody@FreeBSD.ORG"
18515 #. type: Plain text
18516 #: build/C/man7/mdoc.samples.7:850
18517 msgid "E<.An Joe Author Aq nobody@FreeBSD.ORG>"
18521 #: build/C/man7/mdoc.samples.7:850
18523 msgid "Li \\&.An Joe\\ Author\\ )\\ )\\ ,"
18526 #. type: Plain text
18527 #: build/C/man7/mdoc.samples.7:852
18528 msgid "E<.An Joe Author>)),"
18531 #. type: Plain text
18532 #: build/C/man7/mdoc.samples.7:861
18534 "The E<.Ql \\&.An> macro is parsed and is callable. It is an error to call "
18535 "E<.Ql \\&.An> without any arguments."
18539 #: build/C/man7/mdoc.samples.7:861
18541 msgid "Argument Macro"
18544 #. type: Plain text
18545 #: build/C/man7/mdoc.samples.7:866
18547 "The E<.Ql \\&.Ar> argument macro may be used whenever a command-line "
18548 "argument is referenced."
18552 #: build/C/man7/mdoc.samples.7:867
18554 msgid "Usage: .Ar argument ... \\*(Pu"
18558 #: build/C/man7/mdoc.samples.7:869
18563 #. type: Plain text
18564 #: build/C/man7/mdoc.samples.7:871
18569 #: build/C/man7/mdoc.samples.7:871
18571 msgid "Li \\&.Ar file1"
18574 #. type: Plain text
18575 #: build/C/man7/mdoc.samples.7:873
18576 msgid "E<.Ar file1>"
18580 #: build/C/man7/mdoc.samples.7:873
18582 msgid "Li \\&.Ar file1\\ ."
18585 #. type: Plain text
18586 #: build/C/man7/mdoc.samples.7:875
18587 msgid "E<.Ar file1>."
18591 #: build/C/man7/mdoc.samples.7:875
18593 msgid "Li \\&.Ar file1 file2"
18596 #. type: Plain text
18597 #: build/C/man7/mdoc.samples.7:877
18598 msgid "E<.Ar file1 file2>"
18602 #: build/C/man7/mdoc.samples.7:877
18604 msgid "Li \\&.Ar f1 f2 f3\\ :"
18607 #. type: Plain text
18608 #: build/C/man7/mdoc.samples.7:879
18609 msgid "E<.Ar f1 f2 f3>:"
18613 #: build/C/man7/mdoc.samples.7:879
18615 msgid "Li \\&.Ar file\\ )\\ )\\ ,"
18618 #. type: Plain text
18619 #: build/C/man7/mdoc.samples.7:881
18620 msgid "E<.Ar file>)),"
18623 #. type: Plain text
18624 #: build/C/man7/mdoc.samples.7:891
18626 "If E<.Ql \\&.Ar> is called without arguments, E<.Ql \\&Ar> is assumed. The "
18627 "E<.Ql \\&.Ar> macro is parsed and is callable."
18631 #: build/C/man7/mdoc.samples.7:891
18633 msgid "Configuration Declaration (section four only)"
18636 #. type: Plain text
18637 #: build/C/man7/mdoc.samples.7:898
18639 "The E<.Ql \\&.Cd> macro is used to demonstrate a E<.Xr config 8> declaration "
18640 "for a device interface in a section four manual. This macro accepts quoted "
18641 "arguments (double quotes only)."
18645 #: build/C/man7/mdoc.samples.7:900
18647 msgid "Cd \"device le0 at scode?\""
18650 #. type: Plain text
18651 #: build/C/man7/mdoc.samples.7:903
18652 msgid "produced by: E<.Ql \".Cd device le0 at scode?\">."
18656 #: build/C/man7/mdoc.samples.7:904
18658 msgid "Command Modifier"
18661 #. type: Plain text
18662 #: build/C/man7/mdoc.samples.7:918
18664 "The command modifier is identical to the E<.Ql \\&.Fl> (flag) command with "
18665 "the exception the E<.Ql \\&.Cm> macro does not assert a dash in front of "
18666 "every argument. Traditionally flags are marked by the preceding dash, some "
18667 "commands or subsets of commands do not use them. Command modifiers may also "
18668 "be specified in conjunction with interactive commands such as editor "
18669 "commands. See E<.Sx Flags>."
18673 #: build/C/man7/mdoc.samples.7:918
18675 msgid "Defined Variables"
18678 #. type: Plain text
18679 #: build/C/man7/mdoc.samples.7:922
18681 "A variable which is defined in an include file is specified by the macro "
18686 #: build/C/man7/mdoc.samples.7:923
18688 msgid "Usage: .Dv defined_variable ... \\*(Pu"
18692 #: build/C/man7/mdoc.samples.7:925
18694 msgid "Li \".Dv MAXHOSTNAMELEN\""
18697 #. type: Plain text
18698 #: build/C/man7/mdoc.samples.7:927
18699 msgid "E<.Dv MAXHOSTNAMELEN>"
18703 #: build/C/man7/mdoc.samples.7:927
18705 msgid "Li \".Dv TIOCGPGRP )\""
18708 #. type: Plain text
18709 #: build/C/man7/mdoc.samples.7:929
18710 msgid "E<.Dv TIOCGPGRP>)"
18713 #. type: Plain text
18714 #: build/C/man7/mdoc.samples.7:936
18716 "It is an error to call E<.Ql \\&.Dv> without arguments. E<.Ql \\&.Dv> is "
18717 "parsed and is callable."
18721 #: build/C/man7/mdoc.samples.7:936
18723 msgid "Errno's (Section two only)"
18726 #. type: Plain text
18727 #: build/C/man7/mdoc.samples.7:948
18729 "The E<.Ql \\&.Er> errno macro specifies the error return value for section "
18730 "two library routines. The second example below shows E<.Ql \\&.Er> used "
18731 "with the E<.Ql \\&.Bq> general text domain macro, as it would be used in a "
18732 "section two manual page."
18736 #: build/C/man7/mdoc.samples.7:949
18738 msgid "Usage: .Er ERRNOTYPE ... \\*(Pu"
18742 #: build/C/man7/mdoc.samples.7:951
18744 msgid "Li \\&.Er ENOENT"
18747 #. type: Plain text
18748 #: build/C/man7/mdoc.samples.7:953
18749 msgid "E<.Er ENOENT>"
18753 #: build/C/man7/mdoc.samples.7:953
18755 msgid "Li \\&.Er ENOENT\\ )\\ ;"
18758 #. type: Plain text
18759 #: build/C/man7/mdoc.samples.7:955
18760 msgid "E<.Er ENOENT>);"
18764 #: build/C/man7/mdoc.samples.7:955
18766 msgid "Li \\&.Bq \\&Er ENOTDIR"
18769 #. type: Plain text
18770 #: build/C/man7/mdoc.samples.7:957
18771 msgid "E<.Bq Er ENOTDIR>"
18774 #. type: Plain text
18775 #: build/C/man7/mdoc.samples.7:965
18777 "It is an error to call E<.Ql \\&.Er> without arguments. The E<.Ql \\&.Er> "
18778 "macro is parsed and is callable."
18782 #: build/C/man7/mdoc.samples.7:965
18784 msgid "Environment Variables"
18787 #. type: Plain text
18788 #: build/C/man7/mdoc.samples.7:969
18789 msgid "The E<.Ql \\&.Ev> macro specifies an environment variable."
18793 #: build/C/man7/mdoc.samples.7:970
18795 msgid "Usage: .Ev argument ... \\*(Pu"
18799 #: build/C/man7/mdoc.samples.7:972
18801 msgid "Li \\&.Ev DISPLAY"
18804 #. type: Plain text
18805 #: build/C/man7/mdoc.samples.7:974
18806 msgid "E<.Ev DISPLAY>"
18810 #: build/C/man7/mdoc.samples.7:974
18812 msgid "Li \\&.Ev PATH\\ ."
18815 #. type: Plain text
18816 #: build/C/man7/mdoc.samples.7:976
18817 msgid "E<.Ev PATH>."
18821 #: build/C/man7/mdoc.samples.7:976
18823 msgid "Li \\&.Ev PRINTER\\ )\\ )\\ ,"
18826 #. type: Plain text
18827 #: build/C/man7/mdoc.samples.7:978
18828 msgid "E<.Ev PRINTER>)),"
18831 #. type: Plain text
18832 #: build/C/man7/mdoc.samples.7:986
18834 "It is an error to call E<.Ql \\&.Ev> without arguments. The E<.Ql \\&.Ev> "
18835 "macro is parsed and is callable."
18839 #: build/C/man7/mdoc.samples.7:986
18841 msgid "Function Argument"
18844 #. type: Plain text
18845 #: build/C/man7/mdoc.samples.7:1005
18847 "The E<.Ql \\&.Fa> macro is used to refer to function arguments (parameters) "
18848 "outside of the E<.Sx SYNOPSIS> section of the manual or inside the E<.Sx "
18849 "SYNOPSIS> section should a parameter list be too long for the E<.Ql \\&.Fn> "
18850 "macro and the enclosure macros E<.Ql \\&.Fo> and E<.Ql \\&.Fc> must be "
18851 "used. E<.Ql \\&.Fa> may also be used to refer to structure members."
18855 #: build/C/man7/mdoc.samples.7:1006
18857 msgid "Usage: .Fa function_argument ... \\*(Pu"
18861 #: build/C/man7/mdoc.samples.7:1008
18863 msgid "Li \\&.Fa d_namlen\\ )\\ )\\ ,"
18866 #. type: Plain text
18867 #: build/C/man7/mdoc.samples.7:1010
18868 msgid "E<.Fa d_namlen>)),"
18872 #: build/C/man7/mdoc.samples.7:1010
18874 msgid "Li \\&.Fa iov_len"
18877 #. type: Plain text
18878 #: build/C/man7/mdoc.samples.7:1012
18879 msgid "E<.Fa iov_len>"
18882 #. type: Plain text
18883 #: build/C/man7/mdoc.samples.7:1019
18885 "It is an error to call E<.Ql \\&.Fa> without arguments. E<.Ql \\&.Fa> is "
18886 "parsed and is callable."
18890 #: build/C/man7/mdoc.samples.7:1019
18892 msgid "Function Declaration"
18895 #. type: Plain text
18896 #: build/C/man7/mdoc.samples.7:1030
18898 "The E<.Ql \\&.Fd> macro is used in the E<.Sx SYNOPSIS> section with section "
18899 "two or three functions. The E<.Ql \\&.Fd> macro does not call other macros "
18900 "and is not callable by other macros."
18904 #: build/C/man7/mdoc.samples.7:1031
18906 msgid "Usage: .Fd include_file (or defined variable)"
18909 #. type: Plain text
18910 #: build/C/man7/mdoc.samples.7:1042
18912 "In the E<.Sx SYNOPSIS> section a E<.Ql \\&.Fd> request causes a line break "
18913 "if a function has already been presented and a break has not occurred. This "
18914 "leaves a nice vertical space in between the previous function call and the "
18915 "declaration for the next function."
18919 #: build/C/man7/mdoc.samples.7:1042
18924 #. type: Plain text
18925 #: build/C/man7/mdoc.samples.7:1055
18927 "The E<.Ql \\&.Fl> macro handles command-line flags. It prepends a dash, "
18928 "E<.Ql \\->, to the flag. For interactive command flags, which are not "
18929 "prepended with a dash, the E<.Ql \\&.Cm> (command modifier) macro is "
18930 "identical, but without the dash."
18934 #: build/C/man7/mdoc.samples.7:1056
18936 msgid "Usage: .Fl argument ... \\*(Pu"
18940 #: build/C/man7/mdoc.samples.7:1058
18945 #. type: Plain text
18946 #: build/C/man7/mdoc.samples.7:1060
18951 #: build/C/man7/mdoc.samples.7:1060
18953 msgid "Li \\&.Fl cfv"
18956 #. type: Plain text
18957 #: build/C/man7/mdoc.samples.7:1062
18962 #: build/C/man7/mdoc.samples.7:1062
18964 msgid "Li \\&.Fl cfv\\ ."
18967 #. type: Plain text
18968 #: build/C/man7/mdoc.samples.7:1064
18969 msgid "E<.Fl cfv>."
18973 #: build/C/man7/mdoc.samples.7:1064
18975 msgid "Li \\&.Fl s v t"
18978 #. type: Plain text
18979 #: build/C/man7/mdoc.samples.7:1066
18980 msgid "E<.Fl s v t>"
18984 #: build/C/man7/mdoc.samples.7:1066
18986 msgid "Li \\&.Fl -\\ ,"
18989 #. type: Plain text
18990 #: build/C/man7/mdoc.samples.7:1068
18995 #: build/C/man7/mdoc.samples.7:1068
18997 msgid "Li \\&.Fl xyz\\ )\\ ,"
19000 #. type: Plain text
19001 #: build/C/man7/mdoc.samples.7:1070
19002 msgid "E<.Fl xyz>),"
19005 #. type: Plain text
19006 #: build/C/man7/mdoc.samples.7:1082
19008 "The E<.Ql \\&.Fl> macro without any arguments results in a dash representing "
19009 "I<stdin>/I<stdout>. Note that giving E<.Ql \\&.Fl> a single dash, will "
19010 "result in two dashes. The E<.Ql \\&.Fl> macro is parsed and is callable."
19014 #: build/C/man7/mdoc.samples.7:1082
19016 msgid "Functions (library routines)"
19019 #. type: Plain text
19020 #: build/C/man7/mdoc.samples.7:1084
19021 msgid "The .Fn macro is modeled on ANSI C conventions."
19024 #. type: Plain text
19025 #: build/C/man7/mdoc.samples.7:1086
19027 msgid "Usage: .Fn [type] function [[type] parameters ... \\*(Pu]\n"
19031 #: build/C/man7/mdoc.samples.7:1088
19033 msgid "Li \"\\&.Fn getchar\""
19036 #. type: Plain text
19037 #: build/C/man7/mdoc.samples.7:1090
19038 msgid "E<.Fn getchar>"
19042 #: build/C/man7/mdoc.samples.7:1090
19044 msgid "Li \"\\&.Fn strlen ) ,\""
19047 #. type: Plain text
19048 #: build/C/man7/mdoc.samples.7:1092
19049 msgid "E<.Fn strlen>),"
19053 #: build/C/man7/mdoc.samples.7:1092
19055 msgid "Li \\&.Fn \"\\*qint align\\*q\" \"\\*qconst * char *sptrs\\*q\" ,"
19058 #. type: Plain text
19059 #: build/C/man7/mdoc.samples.7:1094
19060 msgid "E<.Fn \"int align\" \"const * char *sptrs\">,"
19063 #. type: Plain text
19064 #: build/C/man7/mdoc.samples.7:1107
19066 "It is an error to call E<.Ql \\&.Fn> without any arguments. The E<.Ql "
19067 "\\&.Fn> macro is parsed and is callable, note that any call to another macro "
19068 "signals the end of the E<.Ql \\&.Fn> call (it will close-parenthesis at that "
19072 #. type: Plain text
19073 #: build/C/man7/mdoc.samples.7:1121
19075 "For functions that have more than eight parameters (and this is rare), the "
19076 "macros E<.Ql \\&.Fo> (function open) and E<.Ql \\&.Fc> (function close) "
19077 "may be used with E<.Ql \\&.Fa> (function argument) to get around the "
19078 "limitation. For example:"
19081 #. type: Plain text
19082 #: build/C/man7/mdoc.samples.7:1133
19085 "\\&.Fo \"int res_mkquery\"\n"
19086 "\\&.Fa \"int op\"\n"
19087 "\\&.Fa \"char *dname\"\n"
19088 "\\&.Fa \"int class\"\n"
19089 "\\&.Fa \"int type\"\n"
19090 "\\&.Fa \"char *data\"\n"
19091 "\\&.Fa \"int datalen\"\n"
19092 "\\&.Fa \"struct rrec *newrr\"\n"
19093 "\\&.Fa \"char *buf\"\n"
19094 "\\&.Fa \"int buflen\"\n"
19098 #. type: Plain text
19099 #: build/C/man7/mdoc.samples.7:1136 build/C/man7/mdoc.samples.7:2480
19103 #. type: Plain text
19104 #: build/C/man7/mdoc.samples.7:1148
19107 "E<.Fo \"int res_mkquery\">\n"
19108 "E<.Fa \"int op\">\n"
19109 "E<.Fa \"char *dname\">\n"
19110 "E<.Fa \"int class\">\n"
19111 "E<.Fa \"int type\">\n"
19112 "E<.Fa \"char *data\">\n"
19113 "E<.Fa \"int datalen\">\n"
19114 "E<.Fa \"struct rrec *newrr\">\n"
19115 "E<.Fa \"char *buf\">\n"
19116 "E<.Fa \"int buflen\">\n"
19120 #. type: Plain text
19121 #: build/C/man7/mdoc.samples.7:1171
19123 "The E<.Ql \\&.Fo> and E<.Ql \\&.Fc> macros are parsed and are callable. In "
19124 "the E<.Sx SYNOPSIS> section, the function will always begin at the beginning "
19125 "of line. If there is more than one function presented in the E<.Sx "
19126 "SYNOPSIS> section and a function type has not been given, a line break will "
19127 "occur, leaving a nice vertical space between the current function name and "
19128 "the one prior. At the moment, E<.Ql \\&.Fn> does not check its word "
19129 "boundaries against troff line lengths and may split across a newline "
19130 "ungracefully. This will be fixed in the near future."
19134 #: build/C/man7/mdoc.samples.7:1171
19136 msgid "Function Type"
19139 #. type: Plain text
19140 #: build/C/man7/mdoc.samples.7:1182
19142 "This macro is intended for the E<.Sx SYNOPSIS> section. It may be used "
19143 "anywhere else in the man page without problems, but its main purpose is to "
19144 "present the function type in kernel normal form for the E<.Sx SYNOPSIS> of "
19145 "sections two and three (it causes a line break allowing the function name to "
19146 "appear on the next line)."
19150 #: build/C/man7/mdoc.samples.7:1183
19152 msgid "Usage: .Ft type ... \\*(Pu"
19156 #: build/C/man7/mdoc.samples.7:1185
19158 msgid "Li \\&.Ft struct stat"
19161 #. type: Plain text
19162 #: build/C/man7/mdoc.samples.7:1187
19163 msgid "E<.Ft struct stat>"
19166 #. type: Plain text
19167 #: build/C/man7/mdoc.samples.7:1192
19168 msgid "The E<.Ql \\&.Ft> request is not callable by other macros."
19172 #: build/C/man7/mdoc.samples.7:1192
19174 msgid "Interactive Commands"
19177 #. type: Plain text
19178 #: build/C/man7/mdoc.samples.7:1196
19179 msgid "The E<.Ql \\&.Ic> macro designates an interactive or internal command."
19183 #: build/C/man7/mdoc.samples.7:1197
19185 msgid "Usage: .Ic argument ... \\*(Pu"
19189 #: build/C/man7/mdoc.samples.7:1199
19191 msgid "Li \\&.Ic :wq"
19194 #. type: Plain text
19195 #: build/C/man7/mdoc.samples.7:1201
19200 #: build/C/man7/mdoc.samples.7:1201
19202 msgid "Li \\&.Ic do while {...}"
19205 #. type: Plain text
19206 #: build/C/man7/mdoc.samples.7:1203
19207 msgid "E<.Ic do while {...}>"
19211 #: build/C/man7/mdoc.samples.7:1203
19213 msgid "Li \\&.Ic setenv\\ , unsetenv"
19216 #. type: Plain text
19217 #: build/C/man7/mdoc.samples.7:1205
19218 msgid "E<.Ic setenv , unsetenv>"
19221 #. type: Plain text
19222 #: build/C/man7/mdoc.samples.7:1213
19224 "It is an error to call E<.Ql \\&.Ic> without arguments. The E<.Ql \\&.Ic> "
19225 "macro is parsed and is callable."
19229 #: build/C/man7/mdoc.samples.7:1213
19234 #. type: Plain text
19235 #: build/C/man7/mdoc.samples.7:1249
19237 "The E<.Ql \\&.Nm> macro is used for the document title or subject name. It "
19238 "has the peculiarity of remembering the first argument it was called with, "
19239 "which should always be the subject name of the page. When called without "
19240 "arguments, E<.Ql \\&.Nm> regurgitates this initial name for the sole purpose "
19241 "of making less work for the author. Note: a section two or three document "
19242 "function name is addressed with the E<.Ql \\&.Nm> in the E<.Sx NAME> "
19243 "section, and with E<.Ql \\&.Fn> in the E<.Sx SYNOPSIS> and remaining "
19244 "sections. For interactive commands, such as the E<.Ql while> command "
19245 "keyword in E<.Xr csh 1>, the E<.Ql \\&.Ic> macro should be used. While the "
19246 "E<.Ql \\&.Ic> is nearly identical to E<.Ql \\&.Nm>, it can not recall the "
19247 "first argument it was invoked with."
19251 #: build/C/man7/mdoc.samples.7:1250
19253 msgid "Usage: .Nm argument ... \\*(Pu"
19257 #: build/C/man7/mdoc.samples.7:1252
19259 msgid "Li \\&.Nm mdoc.sample"
19262 #. type: Plain text
19263 #: build/C/man7/mdoc.samples.7:1254
19264 msgid "E<.Nm mdoc.sample>"
19268 #: build/C/man7/mdoc.samples.7:1254
19270 msgid "Li \\&.Nm \\e-mdoc"
19273 #. type: Plain text
19274 #: build/C/man7/mdoc.samples.7:1256
19275 msgid "E<.Nm \\-mdoc>."
19279 #: build/C/man7/mdoc.samples.7:1256
19281 msgid "Li \\&.Nm foo\\ )\\ )\\ ,"
19284 #. type: Plain text
19285 #: build/C/man7/mdoc.samples.7:1258
19286 msgid "E<.Nm foo>)),"
19290 #: build/C/man7/mdoc.samples.7:1258
19295 #. type: Plain text
19296 #: build/C/man7/mdoc.samples.7:1260
19300 #. type: Plain text
19301 #: build/C/man7/mdoc.samples.7:1265
19302 msgid "The E<.Ql \\&.Nm> macro is parsed and is callable."
19306 #: build/C/man7/mdoc.samples.7:1265
19311 #. type: Plain text
19312 #: build/C/man7/mdoc.samples.7:1277
19314 "The E<.Ql \\&.Op> macro places option brackets around the any remaining "
19315 "arguments on the command line, and places any trailing punctuation outside "
19316 "the brackets. The macros E<.Ql \\&.Oc> and E<.Ql \\&.Oo> may be used across "
19317 "one or more lines."
19321 #: build/C/man7/mdoc.samples.7:1278
19323 msgid "Usage: .Op options ... \\*(Pu"
19327 #: build/C/man7/mdoc.samples.7:1280
19332 #. type: Plain text
19333 #: build/C/man7/mdoc.samples.7:1282
19338 #: build/C/man7/mdoc.samples.7:1282
19340 msgid "Li \".Op Fl k\""
19343 #. type: Plain text
19344 #: build/C/man7/mdoc.samples.7:1284
19345 msgid "E<.Op Fl k>"
19349 #: build/C/man7/mdoc.samples.7:1284
19351 msgid "Li \".Op Fl k ) .\""
19354 #. type: Plain text
19355 #: build/C/man7/mdoc.samples.7:1286
19356 msgid "E<.Op Fl k>)."
19360 #: build/C/man7/mdoc.samples.7:1286
19362 msgid "Li \".Op Fl k Ar kookfile\""
19365 #. type: Plain text
19366 #: build/C/man7/mdoc.samples.7:1288
19367 msgid "E<.Op Fl k Ar kookfile>"
19371 #: build/C/man7/mdoc.samples.7:1288
19373 msgid "Li \".Op Fl k Ar kookfile ,\""
19376 #. type: Plain text
19377 #: build/C/man7/mdoc.samples.7:1290
19378 msgid "E<.Op Fl k Ar kookfile>,"
19382 #: build/C/man7/mdoc.samples.7:1290
19384 msgid "Li \".Op Ar objfil Op Ar corfil\""
19387 #. type: Plain text
19388 #: build/C/man7/mdoc.samples.7:1292
19389 msgid "E<.Op Ar objfil Op Ar corfil>"
19393 #: build/C/man7/mdoc.samples.7:1292
19395 msgid "Li \".Op Fl c Ar objfil Op Ar corfil ,\""
19398 #. type: Plain text
19399 #: build/C/man7/mdoc.samples.7:1294
19400 msgid "E<.Op Fl c Ar objfil Op Ar corfil>,"
19404 #: build/C/man7/mdoc.samples.7:1294
19406 msgid "Li \\&.Op word1 word2"
19409 #. type: Plain text
19410 #: build/C/man7/mdoc.samples.7:1296
19411 msgid "E<.Op word1 word2>"
19414 #. type: Plain text
19415 #: build/C/man7/mdoc.samples.7:1303
19416 msgid "The E<.Ql \\&.Oc> and E<.Ql \\&.Oo> macros:"
19419 #. type: Plain text
19420 #: build/C/man7/mdoc.samples.7:1309
19424 "\\&.Op \\&Fl k \\&Ar kilobytes\n"
19425 "\\&.Op \\&Fl i \\&Ar interval\n"
19426 "\\&.Op \\&Fl c \\&Ar count\n"
19430 #. type: Plain text
19431 #: build/C/man7/mdoc.samples.7:1317
19433 "Produce: E<.Oo> E<.Op Fl k Ar kilobytes> E<.Op Fl i Ar interval> E<.Op Fl c "
19437 #. type: Plain text
19438 #: build/C/man7/mdoc.samples.7:1324
19440 "The macros E<.Ql \\&.Op>, E<.Ql \\&.Oc> and E<.Ql \\&.Oo> are parsed and are "
19445 #: build/C/man7/mdoc.samples.7:1324
19450 #. type: Plain text
19451 #: build/C/man7/mdoc.samples.7:1328
19452 msgid "The E<.Ql \\&.Pa> macro formats pathnames or filenames."
19456 #: build/C/man7/mdoc.samples.7:1329
19458 msgid "Usage: .Pa pathname \\*(Pu"
19462 #: build/C/man7/mdoc.samples.7:1331
19464 msgid "Li \\&.Pa /usr/share"
19467 #. type: Plain text
19468 #: build/C/man7/mdoc.samples.7:1333
19469 msgid "E<.Pa /usr/share>"
19473 #: build/C/man7/mdoc.samples.7:1333
19475 msgid "Li \\&.Pa /tmp/fooXXXXX\\ )\\ ."
19478 #. type: Plain text
19479 #: build/C/man7/mdoc.samples.7:1335
19480 msgid "E<.Pa /tmp/fooXXXXX>)."
19483 #. type: Plain text
19484 #: build/C/man7/mdoc.samples.7:1340
19485 msgid "The E<.Ql \\&.Pa> macro is parsed and is callable."
19489 #: build/C/man7/mdoc.samples.7:1340
19494 #. type: Plain text
19495 #: build/C/man7/mdoc.samples.7:1342
19496 msgid "Generic variable reference:"
19500 #: build/C/man7/mdoc.samples.7:1343
19502 msgid "Usage: .Va variable ... \\*(Pu"
19506 #: build/C/man7/mdoc.samples.7:1345
19508 msgid "Li \\&.Va count"
19511 #. type: Plain text
19512 #: build/C/man7/mdoc.samples.7:1347
19513 msgid "E<.Va count>"
19517 #: build/C/man7/mdoc.samples.7:1347
19519 msgid "Li \\&.Va settimer ,"
19522 #. type: Plain text
19523 #: build/C/man7/mdoc.samples.7:1349
19524 msgid "E<.Va settimer>,"
19528 #: build/C/man7/mdoc.samples.7:1349
19530 msgid "Li \\&.Va int\\ *prt\\ )\\ :"
19533 #. type: Plain text
19534 #: build/C/man7/mdoc.samples.7:1351
19535 msgid "E<.Va int\\ *prt>):"
19539 #: build/C/man7/mdoc.samples.7:1351
19541 msgid "Li \\&.Va char\\ s\\ ]\\ )\\ )\\ ,"
19544 #. type: Plain text
19545 #: build/C/man7/mdoc.samples.7:1353
19546 msgid "E<.Va char\\ s>])),"
19549 #. type: Plain text
19550 #: build/C/man7/mdoc.samples.7:1361
19552 "It is an error to call E<.Ql \\&.Va> without any arguments. The E<.Ql "
19553 "\\&.Va> macro is parsed and is callable."
19557 #: build/C/man7/mdoc.samples.7:1361
19559 msgid "Manual Page Cross References"
19562 #. type: Plain text
19563 #: build/C/man7/mdoc.samples.7:1369
19565 "The E<.Ql \\&.Xr> macro expects the first argument to be a manual page name, "
19566 "and the second argument, if it exists, to be either a section page number or "
19567 "punctuation. Any remaining arguments are assumed to be punctuation."
19571 #: build/C/man7/mdoc.samples.7:1370
19573 msgid "Usage: .Xr man_page [1,...,8] \\*(Pu"
19577 #: build/C/man7/mdoc.samples.7:1372
19579 msgid "Li \\&.Xr mdoc"
19582 #. type: Plain text
19583 #: build/C/man7/mdoc.samples.7:1374
19584 msgid "E<.Xr mdoc>"
19588 #: build/C/man7/mdoc.samples.7:1374
19590 msgid "Li \\&.Xr mdoc\\ ,"
19593 #. type: Plain text
19594 #: build/C/man7/mdoc.samples.7:1376
19595 msgid "E<.Xr mdoc>,"
19599 #: build/C/man7/mdoc.samples.7:1376
19601 msgid "Li \\&.Xr mdoc 7"
19604 #. type: Plain text
19605 #: build/C/man7/mdoc.samples.7:1378
19606 msgid "E<.Xr mdoc 7>"
19610 #: build/C/man7/mdoc.samples.7:1378
19612 msgid "Li \\&.Xr mdoc 7\\ )\\ )\\ ,"
19615 #. type: Plain text
19616 #: build/C/man7/mdoc.samples.7:1380
19617 msgid "E<.Xr mdoc 7>)),"
19620 #. type: Plain text
19621 #: build/C/man7/mdoc.samples.7:1389
19623 "The E<.Ql \\&.Xr> macro is parsed and is callable. It is an error to call "
19624 "E<.Ql \\&.Xr> without any arguments."
19628 #: build/C/man7/mdoc.samples.7:1389
19630 msgid "GENERAL TEXT DOMAIN"
19634 #: build/C/man7/mdoc.samples.7:1390
19639 #. type: Plain text
19640 #: build/C/man7/mdoc.samples.7:1393
19642 msgid "Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \\*(Pu\n"
19646 #: build/C/man7/mdoc.samples.7:1395
19651 #. type: Plain text
19652 #: build/C/man7/mdoc.samples.7:1397
19657 #: build/C/man7/mdoc.samples.7:1397
19659 msgid "Li \".At v6 .\""
19662 #. type: Plain text
19663 #: build/C/man7/mdoc.samples.7:1399
19667 #. type: Plain text
19668 #: build/C/man7/mdoc.samples.7:1409
19670 "The E<.Ql \\&.At> macro is E<.Em not> parsed and E<.Em not> callable It "
19671 "accepts at most two arguments."
19675 #: build/C/man7/mdoc.samples.7:1409
19681 #: build/C/man7/mdoc.samples.7:1410
19683 msgid "Usage: .Bx [Version/release] ... \\*(Pu"
19687 #: build/C/man7/mdoc.samples.7:1412
19692 #. type: Plain text
19693 #: build/C/man7/mdoc.samples.7:1414
19698 #: build/C/man7/mdoc.samples.7:1414
19700 msgid "Li \".Bx 4.3 .\""
19703 #. type: Plain text
19704 #: build/C/man7/mdoc.samples.7:1416
19705 msgid "E<.Bx 4.3>."
19708 #. type: Plain text
19709 #: build/C/man7/mdoc.samples.7:1421
19710 msgid "The E<.Ql \\&.Bx> macro is parsed and is callable."
19714 #: build/C/man7/mdoc.samples.7:1421
19716 msgid "FreeBSD Macro"
19719 #. type: Plain text
19720 #: build/C/man7/mdoc.samples.7:1424
19722 msgid "Usage: .Fx Version.release ... \\*(Pu\n"
19726 #: build/C/man7/mdoc.samples.7:1426
19728 msgid "Li \".Fx 2.2 .\""
19731 #. type: Plain text
19732 #: build/C/man7/mdoc.samples.7:1428
19733 msgid "E<.Fx 2.2>."
19736 #. type: Plain text
19737 #: build/C/man7/mdoc.samples.7:1438
19739 "The E<.Ql \\&.Fx> macro is E<.Em not> parsed and E<.Em not> callable It "
19740 "accepts at most two arguments."
19744 #: build/C/man7/mdoc.samples.7:1438
19750 #: build/C/man7/mdoc.samples.7:1439
19752 msgid "Usage: .Ux ... \\*(Pu"
19756 #: build/C/man7/mdoc.samples.7:1441
19761 #. type: Plain text
19762 #: build/C/man7/mdoc.samples.7:1443
19766 #. type: Plain text
19767 #: build/C/man7/mdoc.samples.7:1448
19768 msgid "The E<.Ql \\&.Ux> macro is parsed and is callable."
19772 #: build/C/man7/mdoc.samples.7:1448
19774 msgid "Enclosure and Quoting Macros"
19777 #. type: Plain text
19778 #: build/C/man7/mdoc.samples.7:1470
19780 "The concept of enclosure is similar to quoting. The object being to enclose "
19781 "one or more strings between a pair of characters like quotes or "
19782 "parentheses. The terms quoting and enclosure are used interchangeably "
19783 "throughout this document. Most of the one line enclosure macros end in "
19784 "small letter E<.Ql q> to give a hint of quoting, but there are a few "
19785 "irregularities. For each enclosure macro there is also a pair of open and "
19786 "close macros which end in small letters E<.Ql o> and E<.Ql c> respectively. "
19787 "These can be used across one or more lines of text and while they have "
19788 "nesting limitations, the one line quote macros can be used inside of them."
19791 #. type: Plain text
19792 #: build/C/man7/mdoc.samples.7:1483
19795 "E<.Em \" Quote\t Close\t Open\tFunction\tResult\">\n"
19796 "\\&.Aq\t.Ac\t.Ao\tAngle Bracket Enclosure\tE<lt>stringE<gt>\n"
19797 "\\&.Bq\t.Bc\t.Bo\tBracket Enclosure\t[string]\n"
19798 "\\&.Dq\t.Dc\t.Do\tDouble Quote\t``string''\n"
19799 "\t.Ec\t.Eo\tEnclose String (in XX)\tXXstringXX\n"
19800 "\\&.Pq\t.Pc\t.Po\tParenthesis Enclosure\t(string)\n"
19801 "\\&.Ql\t\t\tQuoted Literal\t`st' or string\n"
19802 "\\&.Qq\t.Qc\t.Qo\tStraight Double Quote\t\"string\"\n"
19803 "\\&.Sq\t.Sc\t.So\tSingle Quote\t`string'\n"
19806 #. type: Plain text
19807 #: build/C/man7/mdoc.samples.7:1494
19809 "Except for the irregular macros noted below, all of the quoting macros are "
19810 "parsed and callable. All handle punctuation properly, as long as it is "
19811 "presented one character at a time and separated by spaces. The quoting "
19812 "macros examine opening and closing punctuation to determine whether it comes "
19813 "before or after the enclosing string This makes some nesting possible."
19817 #: build/C/man7/mdoc.samples.7:1495
19819 msgid "Li \\&.Ec , \\&.Eo"
19822 #. type: Plain text
19823 #: build/C/man7/mdoc.samples.7:1498
19825 "These macros expect the first argument to be the opening and closing strings "
19830 #: build/C/man7/mdoc.samples.7:1498
19835 #. type: Plain text
19836 #: build/C/man7/mdoc.samples.7:1511
19838 "The quoted literal macro behaves differently for E<.Xr troff> than E<.Xr "
19839 "nroff>. If formatted with E<.Xr nroff>, a quoted literal is always quoted. "
19840 "If formatted with troff, an item is quoted only if the width of the item is "
19841 "less than three constant width characters. This is to make short strings "
19842 "more visible where the font change to literal (constant width) is less "
19847 #: build/C/man7/mdoc.samples.7:1511
19852 #. type: Plain text
19853 #: build/C/man7/mdoc.samples.7:1513
19854 msgid "The prefix macro is not callable, but it is parsed:"
19858 #: build/C/man7/mdoc.samples.7:1514
19860 msgid "Li \".Pf ( Fa name2\""
19863 #. type: Plain text
19864 #: build/C/man7/mdoc.samples.7:1517
19865 msgid "becomes E<.Pf ( Fa name2>."
19868 #. type: Plain text
19869 #: build/C/man7/mdoc.samples.7:1522
19870 msgid "The E<.Ql \\&.Ns> (no space) macro performs the analogous suffix function."
19873 #. type: Plain text
19874 #: build/C/man7/mdoc.samples.7:1526
19875 msgid "Examples of quoting:"
19879 #: build/C/man7/mdoc.samples.7:1527
19884 #. type: Plain text
19885 #: build/C/man7/mdoc.samples.7:1529
19890 #: build/C/man7/mdoc.samples.7:1529
19892 msgid "Li \\&.Aq \\&Ar ctype.h\\ )\\ ,"
19895 #. type: Plain text
19896 #: build/C/man7/mdoc.samples.7:1531
19897 msgid "E<.Aq Ar ctype.h>),"
19901 #: build/C/man7/mdoc.samples.7:1531
19906 #. type: Plain text
19907 #: build/C/man7/mdoc.samples.7:1533
19912 #: build/C/man7/mdoc.samples.7:1533
19914 msgid "Li \\&.Bq \\&Em Greek \\&, French \\&."
19917 #. type: Plain text
19918 #: build/C/man7/mdoc.samples.7:1535
19919 msgid "E<.Bq Em Greek , French>."
19923 #: build/C/man7/mdoc.samples.7:1535
19928 #. type: Plain text
19929 #: build/C/man7/mdoc.samples.7:1537
19934 #: build/C/man7/mdoc.samples.7:1537
19936 msgid "Li \".Dq string abc .\""
19939 #. type: Plain text
19940 #: build/C/man7/mdoc.samples.7:1539
19941 msgid "E<.Dq string abc>."
19945 #: build/C/man7/mdoc.samples.7:1539
19947 msgid "Li \".Dq \\'^[A-Z]\\'\""
19950 #. type: Plain text
19951 #: build/C/man7/mdoc.samples.7:1541
19952 msgid "E<.Dq \\'^[A-Z]\\'>"
19956 #: build/C/man7/mdoc.samples.7:1541
19958 msgid "Li \"\\&.Ql man mdoc\""
19961 #. type: Plain text
19962 #: build/C/man7/mdoc.samples.7:1543
19963 msgid "E<.Ql man mdoc>"
19967 #: build/C/man7/mdoc.samples.7:1543
19972 #. type: Plain text
19973 #: build/C/man7/mdoc.samples.7:1545
19978 #: build/C/man7/mdoc.samples.7:1545
19980 msgid "Li \"\\&.Qq string ) ,\""
19983 #. type: Plain text
19984 #: build/C/man7/mdoc.samples.7:1547
19985 msgid "E<.Qq string>),"
19989 #: build/C/man7/mdoc.samples.7:1547
19991 msgid "Li \"\\&.Qq string Ns ),\""
19994 #. type: Plain text
19995 #: build/C/man7/mdoc.samples.7:1549
19996 msgid "E<.Qq string Ns ),>"
20000 #: build/C/man7/mdoc.samples.7:1549
20005 #. type: Plain text
20006 #: build/C/man7/mdoc.samples.7:1551
20011 #: build/C/man7/mdoc.samples.7:1551
20013 msgid "Li \"\\&.Sq string\""
20016 #. type: Plain text
20017 #: build/C/man7/mdoc.samples.7:1553
20018 msgid "E<.Sq string>"
20021 #. type: Plain text
20022 #: build/C/man7/mdoc.samples.7:1570
20024 "For a good example of nested enclosure macros, see the E<.Ql \\&.Op> option "
20025 "macro. It was created from the same underlying enclosure macros as those "
20026 "presented in the list above. The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> extended "
20027 "argument list macros were also built from the same underlying routines and "
20028 "are a good example of E<.Nm \\-mdoc> macro usage at its worst."
20032 #: build/C/man7/mdoc.samples.7:1570
20034 msgid "No\\-Op or Normal Text Macro"
20037 #. type: Plain text
20038 #: build/C/man7/mdoc.samples.7:1578
20040 "The macro E<.Ql \\&.No> is a hack for words in a macro command line which "
20041 "should E<.Em not> be formatted and follows the conventional syntax for "
20046 #: build/C/man7/mdoc.samples.7:1578
20048 msgid "No Space Macro"
20051 #. type: Plain text
20052 #: build/C/man7/mdoc.samples.7:1584
20054 "The E<.Ql \\&.Ns> macro eliminates unwanted spaces in between macro "
20055 "requests. It is useful for old style argument lists where there is no space "
20056 "between the flag and argument:"
20060 #: build/C/man7/mdoc.samples.7:1585
20062 msgid "Li \".Op Fl I Ns Ar directory\""
20065 #. type: Plain text
20066 #: build/C/man7/mdoc.samples.7:1588
20067 msgid "produces E<.Op Fl I Ns Ar directory>"
20070 #. type: Plain text
20071 #: build/C/man7/mdoc.samples.7:1599
20073 "Note: the E<.Ql \\&.Ns> macro always invokes the E<.Ql \\&.No> macro after "
20074 "eliminating the space unless another macro name follows it. The macro E<.Ql "
20075 "\\&.Ns> is parsed and is callable."
20079 #: build/C/man7/mdoc.samples.7:1599
20081 msgid "Section Cross References"
20084 #. type: Plain text
20085 #: build/C/man7/mdoc.samples.7:1605
20087 "The E<.Ql \\&.Sx> macro designates a reference to a section header within "
20088 "the same document. It is parsed and is callable."
20092 #: build/C/man7/mdoc.samples.7:1607
20094 msgid "Li \\&.Sx FILES"
20097 #. type: Plain text
20098 #: build/C/man7/mdoc.samples.7:1609
20099 msgid "E<.Sx FILES>"
20103 #: build/C/man7/mdoc.samples.7:1610
20105 msgid "References and Citations"
20108 #. type: Plain text
20109 #: build/C/man7/mdoc.samples.7:1614
20111 "The following macros make a modest attempt to handle references. At best, "
20112 "the macros make it convenient to manually drop in a subset of refer style "
20117 #: build/C/man7/mdoc.samples.7:1616
20122 #. type: Plain text
20123 #: build/C/man7/mdoc.samples.7:1621
20125 "Reference Start. Causes a line break and begins collection of reference "
20126 "information until the reference end macro is read."
20130 #: build/C/man7/mdoc.samples.7:1621
20135 #. type: Plain text
20136 #: build/C/man7/mdoc.samples.7:1624
20137 msgid "Reference End. The reference is printed."
20141 #: build/C/man7/mdoc.samples.7:1624
20146 #. type: Plain text
20147 #: build/C/man7/mdoc.samples.7:1626
20148 msgid "Reference author name, one name per invocation."
20152 #: build/C/man7/mdoc.samples.7:1626
20157 #. type: Plain text
20158 #: build/C/man7/mdoc.samples.7:1628
20159 msgid "Book title."
20163 #: build/C/man7/mdoc.samples.7:1628
20168 #. type: Plain text
20169 #: build/C/man7/mdoc.samples.7:1630
20170 msgid "City/place."
20174 #: build/C/man7/mdoc.samples.7:1630
20179 #. type: Plain text
20180 #: build/C/man7/mdoc.samples.7:1632
20185 #: build/C/man7/mdoc.samples.7:1632
20190 #. type: Plain text
20191 #: build/C/man7/mdoc.samples.7:1634
20192 msgid "Journal name."
20196 #: build/C/man7/mdoc.samples.7:1634
20201 #. type: Plain text
20202 #: build/C/man7/mdoc.samples.7:1636
20203 msgid "Issue number."
20207 #: build/C/man7/mdoc.samples.7:1636
20212 #. type: Plain text
20213 #: build/C/man7/mdoc.samples.7:1638
20214 msgid "Optional information."
20218 #: build/C/man7/mdoc.samples.7:1638
20223 #. type: Plain text
20224 #: build/C/man7/mdoc.samples.7:1640
20225 msgid "Page number."
20229 #: build/C/man7/mdoc.samples.7:1640
20234 #. type: Plain text
20235 #: build/C/man7/mdoc.samples.7:1642
20236 msgid "Report name."
20240 #: build/C/man7/mdoc.samples.7:1642
20245 #. type: Plain text
20246 #: build/C/man7/mdoc.samples.7:1644
20247 msgid "Title of article."
20251 #: build/C/man7/mdoc.samples.7:1644
20256 #. type: Plain text
20257 #: build/C/man7/mdoc.samples.7:1646
20261 #. type: Plain text
20262 #: build/C/man7/mdoc.samples.7:1657
20264 "The macros beginning with E<.Ql %> are not callable, and are parsed only for "
20265 "the trade name macro which returns to its caller. (And not very predictably "
20266 "at the moment either.) The purpose is to allow trade names to be pretty "
20267 "printed in E<.Xr troff Ns / Ns Xr ditroff> output."
20271 #: build/C/man7/mdoc.samples.7:1657
20273 msgid "Return Values"
20276 #. type: Plain text
20277 #: build/C/man7/mdoc.samples.7:1663
20279 "The E<.Ql \\&.Rv> macro generates text for use in the E<.Sx RETURN VALUE> "
20284 #: build/C/man7/mdoc.samples.7:1664
20286 msgid "Usage: .Rv [-std function]"
20289 #. type: Plain text
20290 #: build/C/man7/mdoc.samples.7:1668
20291 msgid "E<.Ql \\&.Rv -std atexit> will generate the following text:"
20294 #. fake section 3 to avoid error message from Rv
20296 #. type: ds section
20297 #: build/C/man7/mdoc.samples.7:1671
20302 #. and back to 7 again
20304 #. type: Plain text
20305 #: build/C/man7/mdoc.samples.7:1675
20306 msgid "E<.Rv -std atexit>"
20309 #. type: ds section
20310 #: build/C/man7/mdoc.samples.7:1675
20315 #. type: Plain text
20316 #: build/C/man7/mdoc.samples.7:1680
20317 msgid "The E<.Fl std> option is valid only for manual page sections 2 and 3."
20321 #: build/C/man7/mdoc.samples.7:1680
20323 msgid "Trade Names (or Acronyms and Type Names)"
20326 #. type: Plain text
20327 #: build/C/man7/mdoc.samples.7:1683
20329 "The trade name macro is generally a small caps macro for all uppercase words "
20330 "longer than two characters."
20334 #: build/C/man7/mdoc.samples.7:1684
20336 msgid "Usage: .Tn symbol ... \\*(Pu"
20340 #: build/C/man7/mdoc.samples.7:1686
20342 msgid "Li \\&.Tn DEC"
20345 #. type: Plain text
20346 #: build/C/man7/mdoc.samples.7:1688
20351 #: build/C/man7/mdoc.samples.7:1688
20353 msgid "Li \\&.Tn ASCII"
20356 #. type: Plain text
20357 #: build/C/man7/mdoc.samples.7:1690
20358 msgid "E<.Tn ASCII>"
20361 #. type: Plain text
20362 #: build/C/man7/mdoc.samples.7:1696
20363 msgid "The E<.Ql \\&.Tn> macro is parsed and is callable by other macros."
20367 #: build/C/man7/mdoc.samples.7:1696
20369 msgid "Extended Arguments"
20372 #. type: Plain text
20373 #: build/C/man7/mdoc.samples.7:1708
20375 "The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> macros allow one to extend an argument "
20376 "list on a macro boundary. Argument lists cannot be extended within a macro "
20377 "which expects all of its arguments on one line such as E<.Ql \\&.Op>."
20380 #. type: Plain text
20381 #: build/C/man7/mdoc.samples.7:1712
20383 "Here is an example of E<.Ql \\&.Xo> using the space mode macro to turn "
20387 #. type: Plain text
20388 #: build/C/man7/mdoc.samples.7:1718
20392 "\\&.It Xo Sy I Ar operation\n"
20393 "\\&.No \\een Ar count No \\een\n"
20398 #. type: Plain text
20399 #: build/C/man7/mdoc.samples.7:1721 build/C/man7/mdoc.samples.7:1742 build/C/man7/mdoc.samples.7:1766
20403 #. type: Plain text
20404 #: build/C/man7/mdoc.samples.7:1724 build/C/man7/mdoc.samples.7:1745
20406 msgid "E<.Sm off>\n"
20410 #: build/C/man7/mdoc.samples.7:1724
20412 msgid "Xo Sy I Ar operation"
20415 #. type: Plain text
20416 #: build/C/man7/mdoc.samples.7:1728
20419 "E<.No \\en Ar count No \\en>\n"
20424 #. type: Plain text
20425 #: build/C/man7/mdoc.samples.7:1732
20426 msgid "Another one:"
20429 #. type: Plain text
20430 #: build/C/man7/mdoc.samples.7:1739
20434 "\\&.It Cm S No \\&/ Ar old_pattern Xo\n"
20435 "\\&.No \\&/ Ar new_pattern\n"
20436 "\\&.No \\&/ Op Cm g\n"
20442 #: build/C/man7/mdoc.samples.7:1745
20444 msgid "Cm S No \\&/ Ar old_pattern Xo"
20447 #. type: Plain text
20448 #: build/C/man7/mdoc.samples.7:1750
20451 "E<.No \\&/ Ar new_pattern>\n"
20452 "E<.No \\&/ Op Cm g>\n"
20457 #. type: Plain text
20458 #: build/C/man7/mdoc.samples.7:1757
20460 "Another example of E<.Ql \\&.Xo> and using enclosure macros: Test the value "
20464 #. type: Plain text
20465 #: build/C/man7/mdoc.samples.7:1763
20470 "\\&.Oo \\e&! Oc Ns Ar variable\n"
20471 "\\&.Op Ar operator variable ...\n"
20476 #: build/C/man7/mdoc.samples.7:1768
20481 #. type: Plain text
20482 #: build/C/man7/mdoc.samples.7:1773
20486 "E<.Oo \\&! Oc Ns Ar variable>\n"
20487 "E<.Op Ar operator variable ...>\n"
20491 #. type: Plain text
20492 #: build/C/man7/mdoc.samples.7:1811
20494 "All of the above examples have used the E<.Ql \\&.Xo> macro on the argument "
20495 "list of the E<.Ql \\&.It> (list-item) macro. The extend macros are not "
20496 "used very often, and when they are it is usually to extend the list-item "
20497 "argument list. Unfortunately, this is also where the extend macros are the "
20498 "most finicky. In the first two examples, spacing was turned off; in the "
20499 "third, spacing was desired in part of the output but not all of it. To make "
20500 "these macros work in this situation make sure the E<.Ql \\&.Xo> and E<.Ql "
20501 "\\&.Xc> macros are placed as shown in the third example. If the E<.Ql "
20502 "\\&.Xo> macro is not alone on the E<.Ql \\&.It> argument list, spacing will "
20503 "be unpredictable. The E<.Ql \\&.Ns> (no space macro) must not occur as the "
20504 "first or last macro on a line in this situation. Out of 900 manual pages "
20505 "(about 1500 actual pages) currently released with E<.Bx> only fifteen use "
20506 "the E<.Ql \\&.Xo> macro."
20510 #: build/C/man7/mdoc.samples.7:1812
20512 msgid "Section Headers"
20515 #. type: Plain text
20516 #: build/C/man7/mdoc.samples.7:1825
20518 "The first three E<.Ql \\&.Sh> section header macros list below are required "
20519 "in every man page. The remaining section headers are recommended at the "
20520 "discretion of the author writing the manual page. The E<.Ql \\&.Sh> macro "
20521 "can take up to nine arguments. It is parsed and but is not callable."
20525 #: build/C/man7/mdoc.samples.7:1826
20527 msgid "\\&.Sh NAME"
20530 #. type: Plain text
20531 #: build/C/man7/mdoc.samples.7:1846
20533 "The E<.Ql \\&.Sh NAME> macro is mandatory. If not specified, the headers, "
20534 "footers and page layout defaults will not be set and things will be rather "
20535 "unpleasant. The E<.Sx NAME> section consists of at least three items. The "
20536 "first is the E<.Ql \\&.Nm> name macro naming the subject of the man page. "
20537 "The second is the Name Description macro, E<.Ql \\&.Nd>, which separates the "
20538 "subject name from the third item, which is the description. The description "
20539 "should be the most terse and lucid possible, as the space available is "
20544 #: build/C/man7/mdoc.samples.7:1846
20546 msgid "\\&.Sh SYNOPSIS"
20549 #. type: Plain text
20550 #: build/C/man7/mdoc.samples.7:1878
20552 "The E<.Sx SYNOPSIS> section describes the typical usage of the subject of a "
20553 "man page. The macros required are either E<.Ql \".Nm\">, E<.Ql \".Cd\">, "
20554 "E<.Ql \".Fn\">, (and possibly E<.Ql \".Fo\">, E<.Ql \".Fc\">, E<.Ql "
20555 "\".Fd\">, E<.Ql \".Ft\"> macros). The function name macro E<.Ql \".Fn\"> is "
20556 "required for manual page sections 2 and 3, the command and general name "
20557 "macro E<.Ql \\&.Nm> is required for sections 1, 5, 6, 7, 8. Section 4 "
20558 "manuals require a E<.Ql \".Nm\">, E<.Ql \".Fd\"> or a E<.Ql \".Cd\"> "
20559 "configuration device usage macro. Several other macros may be necessary to "
20560 "produce the synopsis line as shown below:"
20563 #. type: Plain text
20564 #: build/C/man7/mdoc.samples.7:1885
20568 "E<.Op Fl benstuv>\n"
20573 #. type: Plain text
20574 #: build/C/man7/mdoc.samples.7:1888
20575 msgid "The following macros were used:"
20579 #: build/C/man7/mdoc.samples.7:1889
20585 #: build/C/man7/mdoc.samples.7:1890
20587 msgid "\\&.Op \\&Fl benstuv"
20591 #: build/C/man7/mdoc.samples.7:1891
20593 msgid "\\&.Op \\&Fl"
20597 #: build/C/man7/mdoc.samples.7:1892
20602 #. type: Plain text
20603 #: build/C/man7/mdoc.samples.7:1903
20605 "E<.Sy Note>: The macros E<.Ql \\&.Op>, E<.Ql \\&.Fl>, and E<.Ql \\&.Ar> "
20606 "recognize the pipe bar character E<.Ql \\*(Ba>, so a command line such as:"
20610 #: build/C/man7/mdoc.samples.7:1904
20612 msgid ".Op Fl a | Fl b"
20615 #. type: Plain text
20616 #: build/C/man7/mdoc.samples.7:1913
20618 "will not go orbital. E<.Xr Troff> normally interprets a \\*(Ba as a special "
20619 "operator. See E<.Sx PREDEFINED STRINGS> for a usable \\*(Ba character in "
20620 "other situations."
20624 #: build/C/man7/mdoc.samples.7:1914
20626 msgid "\\&.Sh DESCRIPTION"
20629 #. type: Plain text
20630 #: build/C/man7/mdoc.samples.7:1931
20632 "In most cases the first text in the E<.Sx DESCRIPTION> section is a brief "
20633 "paragraph on the command, function or file, followed by a lexical list of "
20634 "options and respective explanations. To create such a list, the E<.Ql "
20635 "\\&.Bl> begin-list, E<.Ql \\&.It> list-item and E<.Ql \\&.El> end-list "
20636 "macros are used (see E<.Sx Lists and Columns> below)."
20639 #. type: Plain text
20640 #: build/C/man7/mdoc.samples.7:1940
20642 "The following E<.Ql \\&.Sh> section headers are part of the preferred manual "
20643 "page layout and must be used appropriately to maintain consistency. They "
20644 "are listed in the order in which they would be used."
20648 #: build/C/man7/mdoc.samples.7:1941
20650 msgid "\\&.Sh ENVIRONMENT"
20653 #. type: Plain text
20654 #: build/C/man7/mdoc.samples.7:1947
20656 "The E<.Sx ENVIRONMENT> section should reveal any related environment "
20657 "variables and clues to their behavior and/or usage."
20661 #: build/C/man7/mdoc.samples.7:1947
20663 msgid "\\&.Sh EXAMPLES"
20666 #. type: Plain text
20667 #: build/C/man7/mdoc.samples.7:1954
20669 "There are several ways to create examples. See the E<.Sx EXAMPLES> section "
20670 "below for details."
20674 #: build/C/man7/mdoc.samples.7:1954
20676 msgid "\\&.Sh FILES"
20679 #. type: Plain text
20680 #: build/C/man7/mdoc.samples.7:1961
20682 "Files which are used or created by the man page subject should be listed via "
20683 "the E<.Ql \\&.Pa> macro in the E<.Sx FILES> section."
20687 #: build/C/man7/mdoc.samples.7:1961
20689 msgid "\\&.Sh SEE ALSO"
20692 #. type: Plain text
20693 #: build/C/man7/mdoc.samples.7:1975
20695 "References to other material on the man page topic and cross references to "
20696 "other relevant man pages should be placed in the E<.Sx SEE ALSO> section. "
20697 "Cross references are specified using the E<.Ql \\&.Xr> macro. Cross "
20698 "references in the E<.Sx SEE ALSO> section should be sorted by section "
20699 "number, and then placed in alphabetical order and comma separated. For "
20703 #. type: Plain text
20704 #: build/C/man7/mdoc.samples.7:1980
20705 msgid "E<.Xr ls 1>, E<.Xr ps 1>, E<.Xr group 5>, E<.Xr passwd 5>."
20708 #. type: Plain text
20709 #: build/C/man7/mdoc.samples.7:1984
20710 msgid "At this time E<.Xr refer 1> style references are not accommodated."
20714 #: build/C/man7/mdoc.samples.7:1984
20716 msgid "\\&.Sh CONFORMING TO"
20719 #. type: Plain text
20720 #: build/C/man7/mdoc.samples.7:1996
20722 "If the command, library function or file adheres to a specific "
20723 "implementation such as E<.St -p1003.2> or E<.St -ansiC> this should be noted "
20724 "here. If the command does not adhere to any standard, its history should be "
20725 "noted in the E<.Sx HISTORY> section."
20729 #: build/C/man7/mdoc.samples.7:1996
20731 msgid "\\&.Sh HISTORY"
20734 #. type: Plain text
20735 #: build/C/man7/mdoc.samples.7:1999
20737 "Any command which does not adhere to any specific standards should be "
20738 "outlined historically in this section."
20742 #: build/C/man7/mdoc.samples.7:1999
20744 msgid "\\&.Sh AUTHORS"
20747 #. type: Plain text
20748 #: build/C/man7/mdoc.samples.7:2001
20749 msgid "Credits, if need be, should be placed here."
20753 #: build/C/man7/mdoc.samples.7:2001
20755 msgid "\\&.Sh DIAGNOSTICS"
20758 #. type: Plain text
20759 #: build/C/man7/mdoc.samples.7:2003
20760 msgid "Diagnostics from a command should be placed in this section."
20764 #: build/C/man7/mdoc.samples.7:2003
20766 msgid "\\&.Sh ERRORS"
20769 #. type: Plain text
20770 #: build/C/man7/mdoc.samples.7:2009
20772 "Specific error handling, especially from library functions (man page "
20773 "sections 2 and 3) should go here. The E<.Ql \\&.Er> macro is used to "
20774 "specify an errno."
20778 #: build/C/man7/mdoc.samples.7:2009
20780 msgid "\\&.Sh BUGS"
20783 #. type: Plain text
20784 #: build/C/man7/mdoc.samples.7:2011
20785 msgid "Blatant problems with the topic go here..."
20788 #. type: Plain text
20789 #: build/C/man7/mdoc.samples.7:2017
20791 "User specified E<.Ql \\&.Sh> sections may be added, for example, this "
20792 "section was set with:"
20795 #. type: Plain text
20796 #: build/C/man7/mdoc.samples.7:2019
20798 msgid "\\&.Sh PAGE STRUCTURE DOMAIN\n"
20802 #: build/C/man7/mdoc.samples.7:2020
20804 msgid "Paragraphs and Line Spacing."
20808 #: build/C/man7/mdoc.samples.7:2022
20813 #. type: Plain text
20814 #: build/C/man7/mdoc.samples.7:2038
20816 "The E<.Ql \\&.Pp> paragraph command may be used to specify a line space "
20817 "where necessary. The macro is not necessary after a E<.Ql \\&.Sh> or E<.Ql "
20818 "\\&.Ss> macro or before a E<.Ql \\&.Bl> macro. (The E<.Ql \\&.Bl> macro "
20819 "asserts a vertical distance unless the -compact flag is given)."
20822 #. This worked with version one, need to redo for version three
20825 #. .Cw (ax+bx+c) \ is\ produced\ by\ \&
20826 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
20843 #. .Em is produced by
20859 #. This example shows the same equation in a different format.
20863 #. signs were forced with
20867 #. .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
20868 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
20879 #. .Li \&.Cx \e\ +\e\ \e&
20890 #. .Em is produced by
20898 #. .Li \&.Cx \e\ +\e\ \e&
20909 #. The incantation below was
20915 #. .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
20917 #. .Li \&.Cx Op Sy ?/
20927 #. .Em is produced by
20929 #. .Li \&.Ar \e\ b1 e1 f1
20941 #: build/C/man7/mdoc.samples.7:2157
20946 #. type: Plain text
20947 #: build/C/man7/mdoc.samples.7:2186
20949 "The only keep that is implemented at this time is for words. The macros are "
20950 "E<.Ql \\&.Bk> (begin-keep) and E<.Ql \\&.Ek> (end-keep). The only option "
20951 "that E<.Ql \\&.Bk> accepts is E<.Fl words> and is useful for preventing line "
20952 "breaks in the middle of options. In the example for the make command-line "
20953 "arguments (see E<.Sx What's in a name>), the keep prevented E<.Xr nroff> "
20954 "from placing up the flag and the argument on separate lines. (Actually, the "
20955 "option macro used to prevent this from occurring, but was dropped when the "
20956 "decision (religious) was made to force right justified margins in E<.Xr "
20957 "troff> as options in general look atrocious when spread across a sparse "
20958 "line. More work needs to be done with the keep macros, a E<.Fl line> option "
20959 "needs to be added.)"
20963 #: build/C/man7/mdoc.samples.7:2186
20965 msgid "Examples and Displays"
20968 #. type: Plain text
20969 #: build/C/man7/mdoc.samples.7:2198
20971 "There are five types of displays, a quickie one line indented display E<.Ql "
20972 "\\&.D1>, a quickie one line literal display E<.Ql \\&.Dl>, and a block "
20973 "literal, block filled and block ragged which use the E<.Ql \\&.Bd> "
20974 "begin-display and E<.Ql \\&.Ed> end-display macros."
20977 #. type: Plain text
20978 #: build/C/man7/mdoc.samples.7:2203
20980 "(D-one) Display one line of indented text. This macro is parsed, but it is "
20985 #: build/C/man7/mdoc.samples.7:2204
20987 msgid "Fl ldghfstru"
20990 #. type: Plain text
20991 #: build/C/man7/mdoc.samples.7:2208
20992 msgid "The above was produced by: E<.Li \\&.Dl Fl ldghfstru>."
20995 #. type: Plain text
20996 #: build/C/man7/mdoc.samples.7:2223
20998 "(D-ell) Display one line of indented E<.Em literal> text. The E<.Ql "
20999 "\\&.Dl> example macro has been used throughout this file. It allows the "
21000 "indent (display) of one line of text. Its default font is set to constant "
21001 "width (literal) however it is parsed and will recognized other macros. It "
21002 "is not callable however."
21006 #: build/C/man7/mdoc.samples.7:2224
21008 msgid "% ls -ldg /usr/local/bin"
21011 #. type: Plain text
21012 #: build/C/man7/mdoc.samples.7:2228
21013 msgid "The above was produced by E<.Li \\&.Dl % ls -ldg /usr/local/bin>."
21016 #. type: Plain text
21017 #: build/C/man7/mdoc.samples.7:2239
21019 "Begin-display. The E<.Ql \\&.Bd> display must be ended with the E<.Ql "
21020 "\\&.Ed> macro. Displays may be nested within displays and lists. E<.Ql "
21021 "\\&.Bd> has the following syntax:"
21025 #: build/C/man7/mdoc.samples.7:2240
21027 msgid ".Bd display-type [-offset offset_value] [-compact]"
21030 #. type: Plain text
21031 #: build/C/man7/mdoc.samples.7:2245
21033 "The display-type must be one of the following four types and may have an "
21034 "offset specifier for indentation: E<.Ql \\&.Bd>."
21037 #. type: Plain text
21038 #: build/C/man7/mdoc.samples.7:2251
21040 "Display a block of text as typed, right (and left) margin edges are left "
21044 #. type: Plain text
21045 #: build/C/man7/mdoc.samples.7:2255
21047 "Display a filled (formatted) block. The block of text is formatted (the "
21048 "edges are filled \\- not left unjustified)."
21051 #. type: Plain text
21052 #: build/C/man7/mdoc.samples.7:2258
21054 "Display a literal block, useful for source code or simple tabbed or spaced "
21059 #: build/C/man7/mdoc.samples.7:2258
21061 msgid "Fl file Ar file_name"
21064 #. type: Plain text
21065 #: build/C/man7/mdoc.samples.7:2267
21067 "The filename following the E<.Fl file> flag is read and displayed. Literal "
21068 "mode is asserted and tabs are set at 8 constant width character intervals, "
21069 "however any E<.Xr troff/ Ns Nm \\-mdoc> commands in file will be processed."
21072 #. type: Plain text
21073 #: build/C/man7/mdoc.samples.7:2273
21075 "If E<.Fl offset> is specified with one of the following strings, the string "
21076 "is interpreted to indicate the level of indentation for the forthcoming "
21080 #. type: Plain text
21081 #: build/C/man7/mdoc.samples.7:2279
21083 "Align block on the current left margin, this is the default mode of E<.Ql "
21087 #. type: Plain text
21088 #: build/C/man7/mdoc.samples.7:2284
21090 "Supposedly center the block. At this time unfortunately, the block merely "
21091 "gets left aligned about an imaginary center margin."
21094 #. type: Plain text
21095 #: build/C/man7/mdoc.samples.7:2293
21097 "Indents by one default indent value or tab. The default indent value is "
21098 "also used for the E<.Ql \\&.D1> display so one is guaranteed the two types "
21099 "of displays will line up. This indent is normally set to 6n or about two "
21100 "thirds of an inch (six constant width characters)."
21103 #. type: Plain text
21104 #: build/C/man7/mdoc.samples.7:2295
21105 msgid "Indents two times the default indent value."
21108 #. type: Plain text
21109 #: build/C/man7/mdoc.samples.7:2303
21111 "This E<.Em left> aligns the block about two inches from the right side of "
21112 "the page. This macro needs work and perhaps may never do the right thing by "
21117 #: build/C/man7/mdoc.samples.7:2304
21122 #. type: Plain text
21123 #: build/C/man7/mdoc.samples.7:2306
21124 msgid "End-display."
21128 #: build/C/man7/mdoc.samples.7:2307
21133 #. type: Plain text
21134 #: build/C/man7/mdoc.samples.7:2309
21135 msgid "There are five macros for changing the appearance of the manual page text:"
21139 #: build/C/man7/mdoc.samples.7:2310
21144 #. type: Plain text
21145 #: build/C/man7/mdoc.samples.7:2315
21147 "Text may be stressed or emphasized with the E<.Ql \\&.Em> macro. The usual "
21148 "font for emphasis is italic."
21152 #: build/C/man7/mdoc.samples.7:2316
21154 msgid "Usage: .Em argument ... \\*(Pu"
21158 #: build/C/man7/mdoc.samples.7:2318
21160 msgid "Li \".Em does not\""
21163 #. type: Plain text
21164 #: build/C/man7/mdoc.samples.7:2320
21165 msgid "E<.Em does not>"
21169 #: build/C/man7/mdoc.samples.7:2320
21171 msgid "Li \".Em exceed 1024 .\""
21174 #. type: Plain text
21175 #: build/C/man7/mdoc.samples.7:2322
21176 msgid "E<.Em exceed 1024>."
21180 #: build/C/man7/mdoc.samples.7:2322
21182 msgid "Li \".Em vide infra ) ) ,\""
21185 #. type: Plain text
21186 #: build/C/man7/mdoc.samples.7:2324
21187 msgid "E<.Em vide infra>)),"
21190 #. type: Plain text
21191 #: build/C/man7/mdoc.samples.7:2332
21193 "The E<.Ql \\&.Em> macro is parsed and is callable. It is an error to call "
21194 "E<.Ql \\&.Em> without arguments."
21198 #: build/C/man7/mdoc.samples.7:2332
21203 #. type: Plain text
21204 #: build/C/man7/mdoc.samples.7:2338
21206 "The E<.Ql \\&.Li> literal macro may be used for special characters, variable "
21207 "constants, anything which should be displayed as it would be typed."
21211 #: build/C/man7/mdoc.samples.7:2339
21213 msgid "Usage: .Li argument ... \\*(Pu"
21217 #: build/C/man7/mdoc.samples.7:2341
21219 msgid "Li \\&.Li \\een"
21222 #. type: Plain text
21223 #: build/C/man7/mdoc.samples.7:2343
21224 msgid "E<.Li \\en>"
21228 #: build/C/man7/mdoc.samples.7:2343
21230 msgid "Li \\&.Li M1 M2 M3\\ ;"
21233 #. type: Plain text
21234 #: build/C/man7/mdoc.samples.7:2345
21235 msgid "E<.Li M1 M2 M3>;"
21239 #: build/C/man7/mdoc.samples.7:2345
21241 msgid "Li \\&.Li cntrl-D\\ )\\ ,"
21244 #. type: Plain text
21245 #: build/C/man7/mdoc.samples.7:2347
21246 msgid "E<.Li cntrl-D>),"
21250 #: build/C/man7/mdoc.samples.7:2347
21252 msgid "Li \\&.Li 1024\\ ..."
21255 #. type: Plain text
21256 #: build/C/man7/mdoc.samples.7:2349
21257 msgid "E<.Li 1024 ...>"
21260 #. type: Plain text
21261 #: build/C/man7/mdoc.samples.7:2354
21262 msgid "The E<.Ql \\&.Li> macro is parsed and is callable."
21266 #: build/C/man7/mdoc.samples.7:2354
21271 #. type: Plain text
21272 #: build/C/man7/mdoc.samples.7:2357
21274 "The symbolic emphasis macro is generally a boldface macro in either the "
21275 "symbolic sense or the traditional English usage."
21279 #: build/C/man7/mdoc.samples.7:2358
21281 msgid "Usage: .Sy symbol ... \\*(Pu"
21285 #: build/C/man7/mdoc.samples.7:2360
21287 msgid "Li \\&.Sy Important Notice"
21290 #. type: Plain text
21291 #: build/C/man7/mdoc.samples.7:2362
21292 msgid "E<.Sy Important Notice>"
21295 #. type: Plain text
21296 #: build/C/man7/mdoc.samples.7:2369
21298 "The E<.Ql \\&.Sy> macro is parsed and is callable. Arguments to E<.Ql "
21299 "\\&.Sy> may be quoted."
21303 #: build/C/man7/mdoc.samples.7:2370
21308 #. type: Plain text
21309 #: build/C/man7/mdoc.samples.7:2380
21311 "Begin font mode. The E<.Ql \\&.Bf> font mode must be ended with the E<.Ql "
21312 "\\&.Ef> macro. Font modes may be nested within other font modes. E<.Ql "
21313 "\\&.Bf> has the following syntax:"
21317 #: build/C/man7/mdoc.samples.7:2381
21319 msgid ".Bf font-mode"
21322 #. type: Plain text
21323 #: build/C/man7/mdoc.samples.7:2385
21324 msgid "The font-mode must be one of the following three types: E<.Ql \\&.Bf>."
21328 #: build/C/man7/mdoc.samples.7:2387
21330 msgid "Sy \\&Em | Fl emphasis"
21333 #. type: Plain text
21334 #: build/C/man7/mdoc.samples.7:2391
21335 msgid "Same as if the E<.Ql \\&.Em> macro was used for the entire block of text."
21339 #: build/C/man7/mdoc.samples.7:2391
21341 msgid "Sy \\&Li | Fl literal"
21344 #. type: Plain text
21345 #: build/C/man7/mdoc.samples.7:2395
21346 msgid "Same as if the E<.Ql \\&.Li> macro was used for the entire block of text."
21350 #: build/C/man7/mdoc.samples.7:2395
21352 msgid "Sy \\&Sy | Fl symbolic"
21355 #. type: Plain text
21356 #: build/C/man7/mdoc.samples.7:2399
21357 msgid "Same as if the E<.Ql \\&.Sy> macro was used for the entire block of text."
21361 #: build/C/man7/mdoc.samples.7:2400
21366 #. type: Plain text
21367 #: build/C/man7/mdoc.samples.7:2402
21368 msgid "End font mode."
21372 #: build/C/man7/mdoc.samples.7:2403
21374 msgid "Tagged Lists and Columns"
21377 #. type: Plain text
21378 #: build/C/man7/mdoc.samples.7:2417
21380 "There are several types of lists which may be initiated with the E<.Ql "
21381 "\".Bl\"> begin-list macro. Items within the list are specified with the "
21382 "E<.Ql \".It\"> item macro and each list must end with the E<.Ql \".El\"> "
21383 "macro. Lists may be nested within themselves and within displays. Columns "
21384 "may be used inside of lists, but lists are unproven inside of columns."
21387 #. type: Plain text
21388 #: build/C/man7/mdoc.samples.7:2432
21390 "In addition, several list attributes may be specified such as the width of a "
21391 "tag, the list offset, and compactness (blank lines between items allowed or "
21392 "disallowed). Most of this document has been formatted with a tag style list "
21393 "E<.Pq Fl tag>. For a change of pace, the list-type used to present the "
21394 "list-types is an over-hanging list E<.Pq Fl ohang>. This type of list is "
21395 "quite popular with E<.Tn TeX> users, but might look a bit funny after having "
21396 "read many pages of tagged lists. The following list types are accepted by "
21401 #: build/C/man7/mdoc.samples.7:2434
21407 #: build/C/man7/mdoc.samples.7:2435
21413 #: build/C/man7/mdoc.samples.7:2436
21418 #. type: Plain text
21419 #: build/C/man7/mdoc.samples.7:2446
21421 "These three are the simplest types of lists. Once the E<.Ql \".Bl\"> macro "
21422 "has been given, items in the list are merely indicated by a line consisting "
21423 "solely of the E<.Ql \".It\"> macro. For example, the source text for a "
21424 "simple enumerated list would look like:"
21427 #. type: Plain text
21428 #: build/C/man7/mdoc.samples.7:2455
21431 "\\&.Bl -enum -compact\n"
21433 "\\&Item one goes here.\n"
21435 "\\&And item two here.\n"
21437 "\\&Lastly item three goes here.\n"
21441 #. type: Plain text
21442 #: build/C/man7/mdoc.samples.7:2459
21443 msgid "The results:"
21446 #. type: Plain text
21447 #: build/C/man7/mdoc.samples.7:2463
21448 msgid "Item one goes here."
21451 #. type: Plain text
21452 #: build/C/man7/mdoc.samples.7:2465
21453 msgid "And item two here."
21456 #. type: Plain text
21457 #: build/C/man7/mdoc.samples.7:2467
21458 msgid "Lastly item three goes here."
21461 #. type: Plain text
21462 #: build/C/man7/mdoc.samples.7:2470
21463 msgid "A simple bullet list construction:"
21466 #. type: Plain text
21467 #: build/C/man7/mdoc.samples.7:2477
21470 "\\&.Bl -bullet -compact\n"
21472 "\\&Bullet one goes here.\n"
21474 "\\&Bullet two here.\n"
21478 #. type: Plain text
21479 #: build/C/man7/mdoc.samples.7:2483
21480 msgid "Bullet one goes here."
21483 #. type: Plain text
21484 #: build/C/man7/mdoc.samples.7:2485
21485 msgid "Bullet two here."
21489 #: build/C/man7/mdoc.samples.7:2488
21495 #: build/C/man7/mdoc.samples.7:2489
21501 #: build/C/man7/mdoc.samples.7:2490
21507 #: build/C/man7/mdoc.samples.7:2491
21513 #: build/C/man7/mdoc.samples.7:2492
21518 #. type: Plain text
21519 #: build/C/man7/mdoc.samples.7:2512
21521 "These list-types collect arguments specified with the E<.Ql \\&.It> macro "
21522 "and create a label which may be E<.Em inset> into the forthcoming text, "
21523 "E<.Em hanged> from the forthcoming text, E<.Em overhanged> from above and "
21524 "not indented or E<.Em tagged>. This list was constructed with the E<.Ql "
21525 "\\&Fl ohang> list-type. The E<.Ql \\&.It> macro is parsed only for the "
21526 "inset, hang and tag list-types and is not callable. Here is an example of "
21531 #: build/C/man7/mdoc.samples.7:2514
21536 #. type: Plain text
21537 #: build/C/man7/mdoc.samples.7:2517
21539 "The tagged list (also called a tagged paragraph) is the most common type of "
21540 "list used in the Berkeley manuals."
21544 #: build/C/man7/mdoc.samples.7:2517
21549 #. type: Plain text
21550 #: build/C/man7/mdoc.samples.7:2521
21552 "Diag lists create section four diagnostic lists and are similar to inset "
21553 "lists except callable macros are ignored."
21557 #: build/C/man7/mdoc.samples.7:2521
21562 #. type: Plain text
21563 #: build/C/man7/mdoc.samples.7:2523
21564 msgid "Hanged labels are a matter of taste."
21568 #: build/C/man7/mdoc.samples.7:2523
21573 #. type: Plain text
21574 #: build/C/man7/mdoc.samples.7:2525
21575 msgid "Overhanging labels are nice when space is constrained."
21579 #: build/C/man7/mdoc.samples.7:2525
21584 #. type: Plain text
21585 #: build/C/man7/mdoc.samples.7:2530
21587 "Inset labels are useful for controlling blocks of paragraphs and are "
21588 "valuable for converting E<.Nm \\-mdoc> manuals to other formats."
21591 #. type: Plain text
21592 #: build/C/man7/mdoc.samples.7:2533
21593 msgid "Here is the source text which produced the above example:"
21596 #. type: Plain text
21597 #: build/C/man7/mdoc.samples.7:2552
21600 "\\&.Bl -inset -offset indent\n"
21602 "\\&The tagged list (also called a tagged paragraph) is the\n"
21603 "\\&most common type of list used in the Berkeley manuals.\n"
21605 "\\&Diag lists create section four diagnostic lists\n"
21606 "\\&and are similar to inset lists except callable\n"
21607 "\\¯os are ignored.\n"
21609 "\\&Hanged labels are a matter of taste.\n"
21610 "\\&.It Em Ohang\n"
21611 "\\&Overhanging labels are nice when space is constrained.\n"
21612 "\\&.It Em Inset\n"
21613 "\\&Inset labels are useful for controlling blocks of\n"
21614 "\\¶graphs and are valuable for converting\n"
21616 "\\&manuals to other formats.\n"
21620 #. type: Plain text
21621 #: build/C/man7/mdoc.samples.7:2555
21622 msgid "Here is a hanged list with two items:"
21626 #: build/C/man7/mdoc.samples.7:2556
21631 #. type: Plain text
21632 #: build/C/man7/mdoc.samples.7:2559
21634 "labels appear similar to tagged lists when the label is smaller than the "
21639 #: build/C/man7/mdoc.samples.7:2559
21641 msgid "Em Longer hanged list labels"
21644 #. type: Plain text
21645 #: build/C/man7/mdoc.samples.7:2562
21646 msgid "blend in to the paragraph unlike tagged paragraph labels."
21649 #. type: Plain text
21650 #: build/C/man7/mdoc.samples.7:2565
21651 msgid "And the unformatted text which created it:"
21654 #. type: Plain text
21655 #: build/C/man7/mdoc.samples.7:2574
21658 "\\&.Bl -hang -offset indent\n"
21659 "\\&.It Em Hanged\n"
21660 "\\&labels appear similar to tagged lists when the\n"
21661 "\\&label is smaller than the label width.\n"
21662 "\\&.It Em Longer hanged list labels\n"
21663 "\\&blend in to the paragraph unlike\n"
21664 "\\&tagged paragraph labels.\n"
21668 #. type: Plain text
21669 #: build/C/man7/mdoc.samples.7:2578
21671 "The tagged list which follows uses an optional width specifier to control "
21672 "the width of the tag."
21676 #: build/C/man7/mdoc.samples.7:2580
21681 #. type: Plain text
21682 #: build/C/man7/mdoc.samples.7:2582
21683 msgid "sleep time of the process (seconds blocked)"
21687 #: build/C/man7/mdoc.samples.7:2582
21692 #. type: Plain text
21693 #: build/C/man7/mdoc.samples.7:2587
21695 "number of disk E<.Tn I/O Ns 's> resulting from references by the process to "
21696 "pages not loaded in core."
21700 #: build/C/man7/mdoc.samples.7:2587
21705 #. type: Plain text
21706 #: build/C/man7/mdoc.samples.7:2589
21707 msgid "numerical user-id of process owner"
21711 #: build/C/man7/mdoc.samples.7:2589
21716 #. type: Plain text
21717 #: build/C/man7/mdoc.samples.7:2592
21719 "numerical ID of parent of process process priority (nonpositive when in "
21720 "noninterruptible wait)"
21723 #. type: Plain text
21724 #: build/C/man7/mdoc.samples.7:2595
21725 msgid "The raw text:"
21728 #. type: Plain text
21729 #: build/C/man7/mdoc.samples.7:2610
21732 "\\&.Bl -tag -width \"PAGEIN\" -compact -offset indent\n"
21734 "\\&sleep time of the process (seconds blocked)\n"
21736 "\\&number of disk\n"
21737 "\\&.Tn I/O Ns 's\n"
21738 "\\&resulting from references\n"
21739 "\\&by the process to pages not loaded in core.\n"
21741 "\\&numerical user ID of process owner\n"
21743 "\\&numerical ID of parent of process process priority\n"
21744 "\\&(nonpositive when in noninterruptible wait)\n"
21748 #. type: Plain text
21749 #: build/C/man7/mdoc.samples.7:2613
21750 msgid "Acceptable width specifiers:"
21754 #: build/C/man7/mdoc.samples.7:2614
21756 msgid "Fl width Ar \\&Fl"
21759 #. type: Plain text
21760 #: build/C/man7/mdoc.samples.7:2623
21762 "sets the width to the default width for a flag. All callable macros have a "
21763 "default width value. The E<.Ql \\&.Fl>, value is presently set to ten "
21764 "constant width characters or about five sixth of an inch."
21768 #: build/C/man7/mdoc.samples.7:2623
21770 msgid "Fl width Ar 24n"
21773 #. type: Plain text
21774 #: build/C/man7/mdoc.samples.7:2629
21776 "sets the width to 24 constant width characters or about two inches. The "
21777 "E<.Ql n> is absolutely necessary for the scaling to work correctly."
21781 #: build/C/man7/mdoc.samples.7:2629
21783 msgid "Fl width Ar ENAMETOOLONG"
21786 #. type: Plain text
21787 #: build/C/man7/mdoc.samples.7:2632
21788 msgid "sets width to the constant width length of the string given."
21792 #: build/C/man7/mdoc.samples.7:2632
21794 msgid "Fl width Ar \"\\*qint mkfifo\\*q\""
21797 #. type: Plain text
21798 #: build/C/man7/mdoc.samples.7:2635
21799 msgid "again, the width is set to the constant width of the string given."
21802 #. type: Plain text
21803 #: build/C/man7/mdoc.samples.7:2649
21805 "If a width is not specified for the tag list type, the first time E<.Ql "
21806 "\\&.It> is invoked, an attempt is made to determine an appropriate width. "
21807 "If the first argument to E<.Ql \".It\"> is a callable macro, the default "
21808 "width for that macro will be used as if the macro name had been supplied as "
21809 "the width. However, if another item in the list is given with a different "
21810 "callable macro name, a new and nested list is assumed."
21814 #: build/C/man7/mdoc.samples.7:2649
21816 msgid "PREDEFINED STRINGS"
21819 #. type: Plain text
21820 #: build/C/man7/mdoc.samples.7:2661
21822 "The following strings are predefined as may be used by preceding with the "
21823 "troff string interpreting sequence E<.Ql \\&\\e*(xx> where E<.Em xx> is the "
21824 "name of the defined string or as E<.Ql \\&\\e*x> where E<.Em x> is the name "
21825 "of the string. The interpreting sequence may be used any where in the text."
21829 #: build/C/man7/mdoc.samples.7:2663
21831 msgid "Sy \"String\tNroff\tTroff\""
21835 #: build/C/man7/mdoc.samples.7:2664
21837 msgid "Li E<lt>= Ta \\&E<lt>\\&= Ta \\*(E<lt>="
21841 #: build/C/man7/mdoc.samples.7:2665
21843 msgid "Li E<gt>= Ta \\&E<gt>\\&= Ta \\*(E<gt>="
21847 #: build/C/man7/mdoc.samples.7:2666
21849 msgid "Li Rq Ta '' Ta \\*(Rq"
21853 #: build/C/man7/mdoc.samples.7:2667
21855 msgid "Li Lq Ta `` Ta \\*(Lq"
21859 #: build/C/man7/mdoc.samples.7:2668
21861 msgid "Li ua Ta ^ Ta \\*(ua"
21865 #: build/C/man7/mdoc.samples.7:2669
21867 msgid "Li aa Ta ' Ta \\*(aa"
21871 #: build/C/man7/mdoc.samples.7:2670
21873 msgid "Li ga Ta \\` Ta \\*(ga"
21876 #. .It Li "sL" Ta ` Ta \*(sL
21877 #. .It Li "sR" Ta ' Ta \*(sR
21879 #: build/C/man7/mdoc.samples.7:2673
21881 msgid "Li q Ta \\(dq Ta \\*q"
21885 #: build/C/man7/mdoc.samples.7:2674
21887 msgid "Li Pi Ta pi Ta \\*(Pi"
21891 #: build/C/man7/mdoc.samples.7:2675
21893 msgid "Li Ne Ta != Ta \\*(Ne"
21897 #: build/C/man7/mdoc.samples.7:2676
21899 msgid "Li Le Ta E<lt>= Ta \\*(Le"
21903 #: build/C/man7/mdoc.samples.7:2677
21905 msgid "Li Ge Ta E<gt>= Ta \\*(Ge"
21909 #: build/C/man7/mdoc.samples.7:2678
21911 msgid "Li Lt Ta E<lt> Ta \\*(Gt"
21915 #: build/C/man7/mdoc.samples.7:2679
21917 msgid "Li Gt Ta E<gt> Ta \\*(Lt"
21921 #: build/C/man7/mdoc.samples.7:2680
21923 msgid "Li Pm Ta +- Ta \\*(Pm"
21927 #: build/C/man7/mdoc.samples.7:2681
21929 msgid "Li If Ta infinity Ta \\*(If"
21933 #: build/C/man7/mdoc.samples.7:2682
21935 msgid "Li Na Ta I<NaN> Ta \\*(Na"
21939 #: build/C/man7/mdoc.samples.7:2683
21941 msgid "Li Ba Ta \\&| Ta \\*(Ba"
21944 #. type: Plain text
21945 #: build/C/man7/mdoc.samples.7:2692
21947 "E<.Sy Note>: The string named E<.Ql q> should be written as E<.Ql \\e*q> "
21948 "since it is only one char."
21952 #: build/C/man7/mdoc.samples.7:2692
21954 msgid "DIAGNOSTICS"
21957 #. type: Plain text
21958 #: build/C/man7/mdoc.samples.7:2725
21960 "The debugging facilities for E<.Nm \\-mdoc> are limited, but can help detect "
21961 "subtle errors such as the collision of an argument name with an internal "
21962 "register or macro name. (A what?) A register is an arithmetic storage "
21963 "class for E<.Xr troff> with a one or two character name. All registers "
21964 "internal to E<.Nm \\-mdoc> for E<.Xr troff> and E<.Xr ditroff> are two "
21965 "characters and of the form E<lt>upper_caseE<gt>E<lt>lower_caseE<gt> such as "
21966 "E<.Ql \\&Ar>, E<lt>lower_caseE<gt>E<lt>upper_caseE<gt> as E<.Ql \\&aR> or "
21967 "E<lt>upper or lower letterE<gt>E<lt>digitE<gt> as E<.Ql \\&C\\&1>. And "
21968 "adding to the muddle, E<.Xr troff> has its own internal registers all of "
21969 "which are either two lowercase characters or a dot plus a letter or "
21970 "metacharacter character. In one of the introduction examples, it was shown "
21971 "how to prevent the interpretation of a macro name with the escape sequence "
21972 "E<.Ql \\e&>. This is sufficient for the internal register names also."
21975 #. Every callable macro name has a corresponding register
21976 #. of the same name (<upper_case><lower_case>).
21977 #. There are also specific registers which have
21978 #. been used for stacks and arrays and are listed in the
21980 #. .Bd -ragged -offset 4n
21981 #. [A-Z][a-z] registers corresponding to macro names (example ``Ar'')
21982 #. [a-z][A-Z] registers corresponding to macro names (example ``aR'')
21983 #. C[0-9] argument types (example C1)
21984 #. O[0-9] offset stack (displays)
21985 #. h[0-9] horizontal spacing stack (lists)
21986 #. o[0-9] offset (stack) (lists)
21987 #. t[0-9] tag stack (lists)
21988 #. v[0-9] vertical spacing stack (lists)
21989 #. w[0-9] width tag/label stack
21992 #. type: Plain text
21993 #: build/C/man7/mdoc.samples.7:2764
21995 "If a nonescaped register name is given in the argument list of a request, "
21996 "unpredictable behavior will occur. In general, any time huge portions of "
21997 "text do not appear where expected in the output, or small strings such as "
21998 "list tags disappear, chances are there is a misunderstanding about an "
21999 "argument type in the argument list. Your mother never intended for you to "
22000 "remember this evil stuff - so here is a way to find out whether or not your "
22001 "arguments are valid: The E<.Ql \\&.Db> (debug) macro displays the "
22002 "interpretation of the argument list for most macros. Macros such as the "
22003 "E<.Ql \\&.Pp> (paragraph) macro do not contain debugging information. All "
22004 "of the callable macros do, and it is strongly advised whenever in doubt, "
22005 "turn on the E<.Ql \\&.Db> macro."
22009 #: build/C/man7/mdoc.samples.7:2765
22011 msgid "Usage: \\&.Db [on | off]"
22014 #. type: Plain text
22015 #: build/C/man7/mdoc.samples.7:2774
22017 "An example of a portion of text with the debug macro placed above and below "
22018 "an artificially created problem (a flag argument E<.Ql \\&aC> which should "
22019 "be E<.Ql \\e&aC> in order to work):"
22022 #. type: Plain text
22023 #: build/C/man7/mdoc.samples.7:2778
22027 "\\&.Op Fl aC Ar file )\n"
22031 #. type: Plain text
22032 #: build/C/man7/mdoc.samples.7:2781
22033 msgid "The resulting output:"
22036 #. type: Plain text
22037 #: build/C/man7/mdoc.samples.7:2796
22041 "DEBUG(argv) MACRO: `.Op' Line #: 2\n"
22042 "\tArgc: 1 Argv: `Fl' Length: 2\n"
22043 "\tSpace: `' Class: Executable\n"
22044 "\tArgc: 2 Argv: `aC' Length: 2\n"
22045 "\tSpace: `' Class: Executable\n"
22046 "\tArgc: 3 Argv: `Ar' Length: 2\n"
22047 "\tSpace: `' Class: Executable\n"
22048 "\tArgc: 4 Argv: `file' Length: 4\n"
22049 "\tSpace: ` ' Class: String\n"
22050 "\tArgc: 5 Argv: `)' Length: 1\n"
22051 "\tSpace: ` ' Class: Closing Punctuation or suffix\n"
22052 "\tMACRO REQUEST: .Op Fl aC Ar file )\n"
22056 #. type: Plain text
22057 #: build/C/man7/mdoc.samples.7:2823
22059 "The first line of information tells the name of the calling macro, here "
22060 "E<.Ql \\&.Op>, and the line number it appears on. If one or more files are "
22061 "involved (especially if text from another file is included), the line number "
22062 "may be bogus. If there is only one file, it should be accurate. The second "
22063 "line gives the argument count, the argument E<.Pq Ql \\&Fl> and its length. "
22064 "If the length of an argument is two characters, the argument is tested to "
22065 "see if it is executable (unfortunately, any register which contains a "
22066 "nonzero value appears executable). The third line gives the space allotted "
22067 "for a class, and the class type. The problem here is the argument aC should "
22068 "not be executable. The four types of classes are string, executable, "
22069 "closing punctuation and opening punctuation. The last line shows the entire "
22070 "argument list as it was read. In this next example, the offending E<.Ql "
22071 "\\&aC> is escaped:"
22074 #. type: Plain text
22075 #: build/C/man7/mdoc.samples.7:2827
22079 "\\&.Em An escaped \\e&aC\n"
22083 #. type: Plain text
22084 #: build/C/man7/mdoc.samples.7:2839
22088 "DEBUG(fargv) MACRO: `.Em' Line #: 2\n"
22089 "\tArgc: 1 Argv: `An' Length: 2\n"
22090 "\tSpace: ` ' Class: String\n"
22091 "\tArgc: 2 Argv: `escaped' Length: 7\n"
22092 "\tSpace: ` ' Class: String\n"
22093 "\tArgc: 3 Argv: `aC' Length: 2\n"
22094 "\tSpace: ` ' Class: String\n"
22095 "\tMACRO REQUEST: .Em An escaped &aC\n"
22099 #. type: Plain text
22100 #: build/C/man7/mdoc.samples.7:2849
22102 "The argument E<.Ql \\e&aC> shows up with the same length of 2 as the E<.Ql "
22103 "\\e&> sequence produces a zero width, but a register named E<.Ql \\e&aC> was "
22104 "not found and the type classified as string."
22107 #. type: Plain text
22108 #: build/C/man7/mdoc.samples.7:2851
22109 msgid "Other diagnostics consist of usage statements and are self explanatory."
22113 #: build/C/man7/mdoc.samples.7:2851
22115 msgid "GROFF, TROFF AND NROFF"
22118 #. type: Plain text
22119 #: build/C/man7/mdoc.samples.7:2856
22121 "The E<.Nm \\-mdoc> package does not need compatibility mode with E<.Xr "
22125 #. type: Plain text
22126 #: build/C/man7/mdoc.samples.7:2874
22128 "The package inhibits page breaks, and the headers and footers which normally "
22129 "occur at those breaks with E<.Xr nroff>, to make the manual more efficient "
22130 "for viewing on-line. At the moment, E<.Xr groff> with E<.Fl T Ns Ar ascii> "
22131 "does eject the imaginary remainder of the page at end of file. The "
22132 "inhibiting of the page breaks makes E<.Xr nroff Ns 'd> files unsuitable for "
22133 "hardcopy. There is a register named E<.Ql \\&cR> which can be set to zero "
22134 "in the site dependent style file E<.Pa /usr/src/share/tmac/doc-nroff> to "
22135 "restore the old style behavior."
22139 #: build/C/man7/mdoc.samples.7:2876
22141 msgid "Pa /usr/share/tmac/doc.tmac"
22144 #. type: Plain text
22145 #: build/C/man7/mdoc.samples.7:2878
22146 msgid "manual macro package"
22150 #: build/C/man7/mdoc.samples.7:2878
22152 msgid "Pa /usr/share/misc/mdoc.template"
22155 #. type: Plain text
22156 #: build/C/man7/mdoc.samples.7:2880
22157 msgid "template for writing a man page"
22161 #: build/C/man7/mdoc.samples.7:2880
22163 msgid "Pa /usr/share/examples/mdoc/*"
22166 #. type: Plain text
22167 #: build/C/man7/mdoc.samples.7:2882
22168 msgid "several example man pages"
22171 #. type: Plain text
22172 #: build/C/man7/mdoc.samples.7:2890
22174 "Undesirable hyphenation on the dash of a flag argument is not yet resolved, "
22175 "and causes occasional mishaps in the E<.Sx DESCRIPTION> section. (line "
22176 "break on the hyphen)."
22179 #. type: Plain text
22180 #: build/C/man7/mdoc.samples.7:2892
22181 msgid "Predefined strings are not declared in documentation."
22184 #. type: Plain text
22185 #: build/C/man7/mdoc.samples.7:2894
22186 msgid "Section 3f has not been added to the header routines."
22189 #. type: Plain text
22190 #: build/C/man7/mdoc.samples.7:2899
22191 msgid "E<.Ql \\&.Nm> font should be changed in E<.Sx NAME> section."
22194 #. type: Plain text
22195 #: build/C/man7/mdoc.samples.7:2906
22197 "E<.Ql \\&.Fn> needs to have a check to prevent splitting up if the line "
22198 "length is too short. Occasionally it separates the last parenthesis, and "
22199 "sometimes looks ridiculous if a line is in fill mode."
22202 #. type: Plain text
22203 #: build/C/man7/mdoc.samples.7:2911
22205 "The method used to prevent header and footer page breaks (other than the "
22206 "initial header and footer) when using nroff occasionally places an unsightly "
22207 "partially filled line (blank) at the would be bottom of the page."
22210 #. Note what happens if the parameter list overlaps a newline
22212 #. to make sure a line boundary is crossed:
22214 #. \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
22217 #. produces, nudge nudge,
22218 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
22219 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
22221 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
22223 #. If double quotes are used, for example:
22225 #. \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
22228 #. produces, nudge nudge,
22229 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
22231 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
22233 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
22235 #. Not a pretty sight...
22236 #. In a paragraph, a long parameter containing unpaddable spaces as
22237 #. in the former example will cause
22239 #. to break the line and spread
22240 #. the remaining words out.
22241 #. The latter example will adjust nicely to
22242 #. justified margins, but may break in between an argument and its
22246 #. the right margin adjustment is normally ragged and the problem is
22248 #. type: Plain text
22249 #: build/C/man7/mdoc.samples.7:2952
22251 "The list and display macros to not do any keeps and certainly should be able "
22255 #. type: Plain text
22256 #: build/C/man7/mdoc.samples.7:2957
22257 msgid "E<.Xr man 1>, E<.Xr troff 1>, E<.Xr groff_mdoc 7>, E<.Xr mdoc 7>"