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: 2014-04-17 13:13+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:62 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:62 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:63 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:65 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:2727 build/C/man5/proc.5:2729 build/C/man5/proc.5:2731 build/C/man5/proc.5:2734
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:358 build/C/man7/man-pages.7:360 build/C/man7/man-pages.7:362 build/C/man7/man-pages.7:570 build/C/man7/man-pages.7:820 build/C/man7/man-pages.7:822 build/C/man7/man-pages.7:828 build/C/man7/man-pages.7:831 build/C/man7/man-pages.7:834 build/C/man7/man-pages.7:837 build/C/man7/man-pages.7:842 build/C/man7/man-pages.7:846 build/C/man7/man-pages.7:857 build/C/man7/man-pages.7:870 build/C/man7/man-pages.7:872 build/C/man7/man-pages.7:874 build/C/man5/proc.5:843 build/C/man5/proc.5:847 build/C/man5/proc.5:850 build/C/man5/proc.5:852 build/C/man5/proc.5:855 build/C/man5/proc.5:1330 build/C/man5/proc.5:1333 build/C/man5/proc.5:1345 build/C/man5/proc.5:1348 build/C/man5/proc.5:1352 build/C/man5/proc.5:1355 build/C/man5/proc.5:1358 build/C/man5/proc.5:1361 build/C/man5/proc.5:1364 build/C/man5/proc.5:1367 build/C/man5/proc.5:1370 build/C/man5/proc.5:1373 build/C/man5/proc.5:1377 build/C/man5/proc.5:1380 build/C/man5/proc.5:1383 build/C/man5/proc.5:1386 build/C/man5/proc.5:1389 build/C/man5/proc.5:1392 build/C/man5/proc.5:1395 build/C/man5/proc.5:1406 build/C/man5/proc.5:1412 build/C/man5/proc.5:1416 build/C/man5/proc.5:1421 build/C/man5/proc.5:1426 build/C/man5/proc.5:1431 build/C/man5/proc.5:1436 build/C/man5/proc.5:1441 build/C/man5/proc.5:1446 build/C/man5/proc.5:2508 build/C/man5/proc.5:2512 build/C/man5/proc.5:2515 build/C/man5/proc.5:2520 build/C/man5/proc.5:2714 build/C/man5/proc.5:2718 build/C/man5/proc.5:2724 build/C/man5/proc.5:2763 build/C/man5/proc.5:2769 build/C/man5/proc.5:2771
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:3607 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:882
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:99 build/C/man7/mailaddr.7:117 build/C/man7/man-pages.7:889 build/C/man7/man.7:560 build/C/man7/mdoc.7:428 build/C/man7/posixoptions.7:854 build/C/man5/proc.5:3620 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:107 build/C/man7/mailaddr.7:127 build/C/man7/man-pages.7:896 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:3654 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:754 build/C/man1/intro.1:311 build/C/man2/intro.2:142 build/C/man3/intro.3:117 build/C/man4/intro.4:47 build/C/man5/intro.5:47 build/C/man6/intro.6:44 build/C/man7/intro.7:50 build/C/man8/intro.8:56 build/C/man7/libc.7:114 build/C/man7/mailaddr.7:134 build/C/man7/man-pages.7:903 build/C/man7/man.7:579 build/C/man7/operator.7:72 build/C/man7/posixoptions.7:864 build/C/man5/proc.5:3661 build/C/man7/standards.7:288 build/C/man7/suffixes.7:290 build/C/man3/undocumented.3:190 build/C/man2/unimplemented.2:73 build/C/man7/units.7:137
1142 "This page is part of release 3.64 of the Linux I<man-pages> project. A "
1143 "description of the project, and information about reporting bugs, can be "
1144 "found at \\%http://www.kernel.org/doc/man-pages/."
1148 #: 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
1154 #: build/C/man1/intro.1:28
1160 #: build/C/man1/intro.1:28 build/C/man7/mailaddr.7:27
1162 msgid "Linux User's Manual"
1166 #: build/C/man1/intro.1:31
1167 msgid "intro - introduction to user commands"
1171 #: build/C/man1/intro.1:35
1173 "Section 1 of the manual describes user commands and tools, for example, file "
1174 "manipulation tools, shells, compilers, web browsers, file and image viewers "
1175 "and editors, and so on."
1179 #: build/C/man1/intro.1:48
1181 "All commands yield a status value on termination. This value can be tested "
1182 "(e.g., in most shells the variable I<$?> contains the status of the last "
1183 "executed command) to see whether the command completed successfully. A "
1184 "zero exit status is conventionally used to indicate success, and a nonzero "
1185 "status means that the command was unsuccessful. (Details of the exit status "
1186 "can be found in B<wait>(2).) A nonzero exit status can be in the range 1 to "
1187 "255, and some commands use different nonzero status values to indicate the "
1188 "reason why the command failed."
1192 #: build/C/man1/intro.1:52
1194 "Linux is a flavor of UNIX, and as a first approximation all user commands "
1195 "under UNIX work precisely the same under Linux (and FreeBSD and lots of "
1196 "other UNIX-like systems)."
1200 #: build/C/man1/intro.1:62
1202 "Under Linux there are GUIs (graphical user interfaces), where you can point "
1203 "and click and drag, and hopefully get work done without first reading lots "
1204 "of documentation. The traditional UNIX environment is a CLI (command line "
1205 "interface), where you type commands to tell the computer what to do. That "
1206 "is faster and more powerful, but requires finding out what the commands "
1207 "are. Below a bare minimum, to get started."
1211 #: build/C/man1/intro.1:62
1217 #: build/C/man1/intro.1:76
1219 "In order to start working, you probably first have to login, that is, give "
1220 "your username and password. See also B<login>(1). The program I<login> now "
1221 "starts a I<shell> (command interpreter) for you. In case of a graphical "
1222 "login, you get a screen with menus or icons and a mouse click will start a "
1223 "shell in a window. See also B<xterm>(1)."
1227 #: build/C/man1/intro.1:76
1233 #: build/C/man1/intro.1:91
1235 "One types commands to the I<shell>, the command interpreter. It is not "
1236 "built-in, but is just a program and you can change your shell. Everybody "
1237 "has her own favorite one. The standard one is called I<sh>. See also "
1238 "B<ash>(1), B<bash>(1), B<csh>(1), B<zsh>(1), B<chsh>(1)."
1242 #: build/C/man1/intro.1:93
1243 msgid "A session might go like"
1247 #: build/C/man1/intro.1:108
1250 "B<knuth login: >I<aeb>\n"
1251 "B<Password: >I<********>\n"
1253 "Tue Aug 6 23:50:44 CEST 2002\n"
1256 "Su Mo Tu We Th Fr Sa\n"
1259 "11 12 13 14 15 16 17\n"
1260 "18 19 20 21 22 23 24\n"
1261 "25 26 27 28 29 30 31\n"
1265 #: build/C/man1/intro.1:135
1272 "drwxrwxr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1273 "-rw-rw-r-- 1 aeb 37 Aug 6 23:52 tel\n"
1275 "maja 0501-1136285\n"
1276 "peter 0136-7399214\n"
1277 "B<% >I<cp tel tel2>\n"
1280 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1281 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel\n"
1282 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1283 "B<% >I<mv tel tel1>\n"
1286 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1287 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel1\n"
1288 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1289 "B<% >I<diff tel1 tel2>\n"
1291 "B<% >I<grep maja tel2>\n"
1292 "maja 0501-1136285\n"
1297 #: build/C/man1/intro.1:147
1299 "and here typing Control-D ended the session. The B<% > here was the command "
1300 "prompt\\(emit is the shell's way of indicating that it is ready for the next "
1301 "command. The prompt can be customized in lots of ways, and one might "
1302 "include stuff like username, machine name, current directory, time, and so "
1303 "on. An assignment PS1=\"What next, master? \" would change the prompt as "
1308 #: build/C/man1/intro.1:153
1310 "We see that there are commands I<date> (that gives date and time), and "
1311 "I<cal> (that gives a calendar)."
1315 #: build/C/man1/intro.1:169
1317 "The command I<ls> lists the contents of the current directory\\(emit tells "
1318 "you what files you have. With a I<-l> option it gives a long listing, that "
1319 "includes the owner and size and date of the file, and the permissions people "
1320 "have for reading and/or changing the file. For example, the file \"tel\" "
1321 "here is 37 bytes long, owned by aeb and the owner can read and write it, "
1322 "others can only read it. Owner and permissions can be changed by the "
1323 "commands I<chown> and I<chmod>."
1327 #: build/C/man1/intro.1:176
1329 "The command I<cat> will show the contents of a file. (The name is from "
1330 "\"concatenate and print\": all files given as parameters are concatenated "
1331 "and sent to \"standard output\", here the terminal screen.)"
1335 #: build/C/man1/intro.1:183
1337 "The command I<cp> (from \"copy\") will copy a file. On the other hand, the "
1338 "command I<mv> (from \"move\") only renames it."
1342 #: build/C/man1/intro.1:188
1344 "The command I<diff> lists the differences between two files. Here there was "
1345 "no output because there were no differences."
1349 #: build/C/man1/intro.1:194
1351 "The command I<rm> (from \"remove\") deletes the file, and be careful! it is "
1352 "gone. No wastepaper basket or anything. Deleted means lost."
1356 #: build/C/man1/intro.1:199
1358 "The command I<grep> (from \"g/re/p\") finds occurrences of a string in one "
1359 "or more files. Here it finds Maja's telephone number."
1363 #: build/C/man1/intro.1:199
1365 msgid "Pathnames and the current directory"
1369 #: build/C/man1/intro.1:211
1371 "Files live in a large tree, the file hierarchy. Each has a I<pathname> "
1372 "describing the path from the root of the tree (which is called /) to the "
1373 "file. For example, such a full pathname might be /home/aeb/tel. Always "
1374 "using full pathnames would be inconvenient, and the name of a file in the "
1375 "current directory may be abbreviated by giving only the last component. "
1376 "That is why \"/home/aeb/tel\" can be abbreviated to \"tel\" when the current "
1377 "directory is \"/home/aeb\"."
1381 #: build/C/man1/intro.1:215
1382 msgid "The command I<pwd> prints the current directory."
1386 #: build/C/man1/intro.1:220
1388 "The command I<cd> changes the current directory. Try \"cd /\" and \"pwd\" "
1389 "and \"cd\" and \"pwd\"."
1393 #: build/C/man1/intro.1:220
1399 #: build/C/man1/intro.1:224
1400 msgid "The command I<mkdir> makes a new directory."
1404 #: build/C/man1/intro.1:228
1406 "The command I<rmdir> removes a directory if it is empty, and complains "
1411 #: build/C/man1/intro.1:240
1413 "The command I<find> (with a rather baroque syntax) will find files with "
1414 "given name or other properties. For example, \"find . -name tel\" would "
1415 "find the file \"tel\" starting in the present directory (which is called "
1416 "\".\"). And \"find / -name tel\" would do the same, but starting at the "
1417 "root of the tree. Large searches on a multi-GB disk will be time-consuming, "
1418 "and it may be better to use B<locate>(1)."
1422 #: build/C/man1/intro.1:240
1424 msgid "Disks and filesystems"
1428 #: build/C/man1/intro.1:251
1430 "The command I<mount> will attach the filesystem found on some disk (or "
1431 "floppy, or CDROM or so) to the big filesystem hierarchy. And I<umount> "
1432 "detaches it again. The command I<df> will tell you how much of your disk is "
1437 #: build/C/man1/intro.1:251
1443 #: build/C/man1/intro.1:269
1445 "On a UNIX system many user and system processes run simultaneously. The one "
1446 "you are talking to runs in the I<foreground>, the others in the "
1447 "I<background>. The command I<ps> will show you which processes are active "
1448 "and what numbers these processes have. The command I<kill> allows you to "
1449 "get rid of them. Without option this is a friendly request: please go "
1450 "away. And \"kill -9\" followed by the number of the process is an immediate "
1451 "kill. Foreground processes can often be killed by typing Control-C."
1455 #: build/C/man1/intro.1:269
1457 msgid "Getting information"
1461 #: build/C/man1/intro.1:282
1463 "There are thousands of commands, each with many options. Traditionally "
1464 "commands are documented on I<man pages>, (like this one), so that the "
1465 "command \"man kill\" will document the use of the command \"kill\" (and "
1466 "\"man man\" document the command \"man\"). The program I<man> sends the "
1467 "text through some I<pager>, usually I<less>. Hit the space bar to get the "
1468 "next page, hit q to quit."
1472 #: build/C/man1/intro.1:290
1474 "In documentation it is customary to refer to man pages by giving the name "
1475 "and section number, as in B<man>(1). Man pages are terse, and allow you to "
1476 "find quickly some forgotten detail. For newcomers an introductory text with "
1477 "more examples and explanations is useful."
1481 #: build/C/man1/intro.1:294
1483 "A lot of GNU/FSF software is provided with info files. Type \"info info\" "
1484 "for an introduction on the use of the program \"info\"."
1488 #. Actual examples? Separate section for each of cat, cp, ...?
1489 #. gzip, bzip2, tar, rpm
1491 #: build/C/man1/intro.1:302
1493 "Special topics are often treated in HOWTOs. Look in "
1494 "I</usr/share/doc/howto/en> and use a browser if you find HTML files there."
1498 #: build/C/man1/intro.1:304 build/C/man4/intro.4:40 build/C/man5/intro.5:40 build/C/man7/intro.7:43
1499 msgid "B<standards>(7)"
1503 #: build/C/man2/intro.2:29
1509 #: build/C/man2/intro.2:32
1510 msgid "intro - introduction to system calls"
1514 #: build/C/man2/intro.2:42
1516 "Section 2 of the manual describes the Linux system calls. A system call is "
1517 "an entry point into the Linux kernel. Usually, system calls are not invoked "
1518 "directly: instead, most system calls have corresponding C library wrapper "
1519 "functions which perform the steps required (e.g., trapping to kernel mode) "
1520 "in order to invoke the system call. Thus, making a system call looks the "
1521 "same as invoking a normal library function."
1525 #: build/C/man2/intro.2:44
1526 msgid "In many cases, the C library wrapper function does nothing more than:"
1530 #: build/C/man2/intro.2:47
1532 "copying arguments and the unique system call number to the registers where "
1533 "the kernel expects them;"
1537 #: build/C/man2/intro.2:50
1539 "trapping to kernel mode, at which point the kernel does the real work of the "
1544 #: build/C/man2/intro.2:55
1546 "setting I<errno> if the system call returns an error number when the kernel "
1547 "returns the CPU to user mode."
1551 #: build/C/man2/intro.2:65
1553 "However, in a few cases, a wrapper function may do rather more than this, "
1554 "for example, performing some preprocessing of the arguments of arguments "
1555 "before trapping to kernel mode, or postprocessing of values returned by the "
1556 "system call. Where this is the case, the manual pages in Section 2 "
1557 "generally try to note the details of both the (usually GNU) C library API "
1558 "interface and the raw system call. Most commonly, the main DESCRIPTION will "
1559 "focus on the C library interface, and differences for the system call are "
1560 "covered in the NOTES section."
1564 #: build/C/man2/intro.2:68
1565 msgid "For a list of the Linux system calls, see B<syscalls>(2)."
1569 #: build/C/man2/intro.2:68 build/C/man2/unimplemented.2:35
1571 msgid "RETURN VALUE"
1575 #: build/C/man2/intro.2:77
1577 "On error, most system calls return a negative error number (i.e., the "
1578 "negated value of one of the constants described in B<errno>(3)). The C "
1579 "library wrapper hides this detail from the caller: when a system call "
1580 "returns a negative value, the wrapper copies the absolute value into the "
1581 "I<errno> variable, and returns -1 as the return value of the wrapper."
1585 #: build/C/man2/intro.2:82
1587 "The value returned by a successful system call depends on the call. Many "
1588 "system calls return 0 on success, but some can return nonzero values from a "
1589 "successful call. The details are described in the individual manual pages."
1593 #: build/C/man2/intro.2:93
1595 "In some cases, the programmer must define a feature test macro in order to "
1596 "obtain the declaration of a system call from the header file specified in "
1597 "the man page SYNOPSIS section. (Where required, these feature test macros "
1598 "must be defined before including I<any> header files.) In such cases, the "
1599 "required macro is described in the man page. For further information on "
1600 "feature test macros, see B<feature_test_macros>(7)."
1604 #: build/C/man2/intro.2:98 build/C/man3/intro.3:92
1606 "Certain terms and abbreviations are used to indicate UNIX variants and "
1607 "standards to which calls in this section conform. See B<standards>(7)."
1611 #: build/C/man2/intro.2:99
1613 msgid "Calling directly"
1617 #: build/C/man2/intro.2:108
1619 "In most cases, it is unnecessary to invoke a system call directly, but there "
1620 "are times when the Standard C library does not implement a nice wrapper "
1621 "function for you. In this case, the programmer must manually invoke the "
1622 "system call using B<syscall>(2). Historically, this was also possible using "
1623 "one of the _syscall macros described in B<_syscall>(2)."
1627 #: 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
1629 msgid "Authors and copyright conditions"
1633 #: 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
1635 "Look at the header of the manual page source for the author(s) and copyright "
1636 "conditions. Note that these can be different from page to page!"
1640 #: build/C/man2/intro.2:135
1642 "B<_syscall>(2), B<syscall>(2), B<syscalls>(2), B<errno>(3), B<intro>(3), "
1643 "B<capabilities>(7), B<credentials>(7), B<feature_test_macros>(7), "
1644 "B<mq_overview>(7), B<path_resolution>(7), B<pipe>(7), B<pty>(7), "
1645 "B<sem_overview>(7), B<shm_overview>(7), B<signal>(7), B<socket>(7), "
1646 "B<standards>(7), B<svipc>(7), B<symlink>(7), B<time>(7)"
1650 #: build/C/man3/intro.3:26
1656 #: build/C/man3/intro.3:29
1657 msgid "intro - introduction to library functions"
1661 #: build/C/man3/intro.3:33
1663 "Section 3 of the manual describes all library functions excluding the "
1664 "library functions (system call wrappers) described in Section 2, which "
1665 "implement system calls."
1669 #: build/C/man3/intro.3:50
1671 "Many of the functions described in the section are part of the Standard C "
1672 "Library (I<libc>). Some functions are part of other libraries (e.g., the "
1673 "math library, I<libm>, or the real-time library, I<librt>) in which case "
1674 "the manual page will indicate the linker option needed to link against the "
1675 "required library (e.g., I<-lm> and I<-lrt>, respectively, for the "
1676 "aforementioned libraries)."
1681 #. are various function groups which can be identified by a letter which
1682 #. is appended to the chapter number:
1684 #. These functions, the functions from chapter 2 and from chapter 3S are
1685 #. contained in the C standard library libc, which will be used by
1689 #. These functions are parts of the
1691 #. library. They are contained in the standard C library libc.
1693 #. These functions are contained in the arithmetic library libm. They are
1696 #. FORTRAN compiler by default, but not by the
1698 #. C compiler, which needs the option \fI\-lm\fP.
1700 #. These functions are part of the FORTRAN library libF77. There are no
1701 #. special compiler flags needed to use these functions.
1703 #. Various special libraries. The manual pages documenting their functions
1704 #. specify the library names.
1706 #: build/C/man3/intro.3:87
1708 "In some cases, the programmer must define a feature test macro in order to "
1709 "obtain the declaration of a function from the header file specified in the "
1710 "man page SYNOPSIS section. (Where required, these feature test macros must "
1711 "be defined before including I<any> header files.) In such cases, the "
1712 "required macro is described in the man page. For further information on "
1713 "feature test macros, see B<feature_test_macros>(7)."
1717 #: build/C/man3/intro.3:110
1719 "B<intro>(2), B<errno>(3), B<capabilities>(7), B<credentials>(7), "
1720 "B<environ>(7), B<feature_test_macros>(7), B<libc>(7), B<math_error>(7), "
1721 "B<path_resolution>(7), B<pthreads>(7), B<signal>(7), B<standards>(7)"
1725 #: 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
1731 #: build/C/man4/intro.4:29
1732 msgid "intro - introduction to special files"
1736 #: build/C/man4/intro.4:31
1737 msgid "Section 4 of the manual describes special files (devices)."
1741 #: 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
1747 #: build/C/man4/intro.4:33
1748 msgid "/dev/* \\(em device files"
1752 #: build/C/man5/intro.5:30
1753 msgid "intro - introduction to file formats"
1757 #: build/C/man5/intro.5:33
1759 "Section 5 of the manual describes various file formats and protocols, and "
1760 "the corresponding C structures, if any."
1764 #: build/C/man6/intro.6:29
1765 msgid "intro - introduction to games"
1769 #: build/C/man6/intro.6:32
1771 "Section 6 of the manual describes all the games and funny little programs "
1772 "available on the system."
1776 #: build/C/man7/intro.7:31
1777 msgid "intro - introduction to overview, conventions, and miscellany section"
1781 #: build/C/man7/intro.7:36
1783 "Section 7 of the manual provides overviews on various topics, and describes "
1784 "conventions and protocols, character set standards, the standard filesystem "
1785 "layout, and miscellaneous other things."
1789 #: build/C/man8/intro.8:32
1790 msgid "intro - introduction to administration and privileged commands"
1794 #: build/C/man8/intro.8:37
1796 "Section 8 of the manual describes commands which either can be or are used "
1797 "only by the superuser, like system-administration commands, daemons, and "
1798 "hardware-related commands."
1802 #: build/C/man8/intro.8:44
1804 "As with the commands in described Section 1, the commands described in this "
1805 "section terminate with an exit status that indicates whether the command "
1806 "succeeded or failed. See B<intro>(1) for more information."
1810 #: build/C/man7/libc.7:26
1816 #: build/C/man7/libc.7:26
1822 #: build/C/man7/libc.7:29
1823 msgid "libc - overview of standard C libraries on Linux"
1827 #: build/C/man7/libc.7:36
1829 "The term \"libc\" is commonly used as a shorthand for the \"standard C "
1830 "library\", a library of standard functions that can be used by all C "
1831 "programs (and sometimes by programs in other languages). Because of some "
1832 "history (see below), use of the term \"libc\" to refer to the standard C "
1833 "library is somewhat ambiguous on Linux."
1837 #: build/C/man7/libc.7:36
1843 #: build/C/man7/libc.7:54
1845 "By far the most widely used C library on Linux is the GNU C Library E<.UR "
1846 "http://www.gnu.org\\:/software\\:/libc/> E<.UE ,> often referred to as "
1847 "I<glibc>. This is the C library that is nowadays used in all major Linux "
1848 "distributions. It is also the C library whose details are documented in the "
1849 "relevant pages of the I<man-pages> project (primarily in Section 3 of the "
1850 "manual). Documentation of glibc is also available in the glibc manual, "
1851 "available via the command I<info libc>. Release 1.0 of glibc was made in "
1852 "September 1992. (There were earlier 0.x releases.) The next major release "
1853 "of glibc was 2.0, at the beginning of 1997."
1857 #: build/C/man7/libc.7:61
1859 "The pathname I</lib/libc.so.6> (or something similar) is normally a symbolic "
1860 "link that points to the location of the glibc library, and executing this "
1861 "pathname will cause glibc to display various information about the version "
1862 "installed on your system."
1866 #: build/C/man7/libc.7:61
1872 #: build/C/man7/libc.7:84
1874 "In the early to mid 1990s, there was for a while I<Linux libc>, a fork of "
1875 "glibc 1.x created by Linux developers who felt that glibc development at the "
1876 "time was not sufficing for the needs of Linux. Often, this library was "
1877 "referred to (ambiguously) as just \"libc\". Linux libc released major "
1878 "versions 2, 3, 4, and 5 (as well as many minor versions of those releases). "
1879 "For a while, Linux libc was the standard C library in many Linux "
1880 "distributions. However, notwithstanding the original motivations of the "
1881 "Linux libc effort, by the time glibc 2.0 was released, it was clearly "
1882 "superior to Linux libc, and all major Linux distributions that had been "
1883 "using Linux libc soon switched back to glibc. (Since this switch occurred "
1884 "over a decade ago, I<man-pages> no longer takes care to document Linux libc "
1885 "details. Nevertheless, the history is visible in vestiges of information "
1886 "about Linux libc that remain in some manual pages, in particular, references "
1887 "to I<libc4> and I<libc5>.)"
1891 #: build/C/man7/libc.7:84
1893 msgid "Other C libraries"
1897 #: build/C/man7/libc.7:99
1899 "There are various other less widely used C libraries for Linux. These "
1900 "libraries are generally smaller than glibc, both in terms of features and "
1901 "memory footprint, and often intended for building small binaries, perhaps "
1902 "targeted at development for embedded Linux systems. Among such libraries "
1903 "are I<uClibc> (I<http://www.uclibc.org/>) and I<dietlibc> "
1904 "(I<http://www.fefe.de/dietlibc/>). Details of these libraries are generally "
1905 "not covered by the I<man-pages> project."
1909 #: build/C/man7/libc.7:107
1911 "B<syscalls>(2), B<getauxval>(3), B<proc>(5), B<feature_test_macros>(7), "
1912 "B<man-pages>(7), B<standards>(7), B<vdso>(7)"
1916 #: build/C/man7/mailaddr.7:27
1922 #: build/C/man7/mailaddr.7:27
1928 #: build/C/man7/mailaddr.7:31
1929 msgid "mailaddr - mail addressing description"
1933 #: build/C/man7/mailaddr.7:36
1935 "This manual page gives a brief introduction to SMTP mail addresses, as used "
1936 "on the Internet. These addresses are in the general format"
1940 #: build/C/man7/mailaddr.7:38
1941 msgid " user@domain"
1945 #: build/C/man7/mailaddr.7:41
1947 "where a domain is a hierarchical dot-separated list of subdomains. These "
1948 "examples are valid forms of the same address:"
1952 #: build/C/man7/mailaddr.7:43
1953 msgid " eric@monet.berkeley.edu"
1957 #: build/C/man7/mailaddr.7:45
1958 msgid " Eric Allman E<lt>eric@monet.berkeley.eduE<gt>"
1962 #: build/C/man7/mailaddr.7:47
1964 msgid " eric@monet.berkeley.edu (Eric Allman)\n"
1968 #: build/C/man7/mailaddr.7:51
1970 "The domain part (\"monet.berkeley.edu\") is a mail-accepting domain. It can "
1971 "be a host and in the past it usually was, but it doesn't have to be. The "
1972 "domain part is not case sensitive."
1976 #: build/C/man7/mailaddr.7:59
1978 "The local part (\"eric\") is often a username, but its meaning is defined by "
1979 "the local software. Sometimes it is case sensitive, although that is "
1980 "unusual. If you see a local-part that looks like garbage, it is usually "
1981 "because of a gateway between an internal e-mail system and the net, here are "
1986 #: build/C/man7/mailaddr.7:61
1987 msgid " \"surname/admd=telemail/c=us/o=hp/prmd=hp\"@some.where"
1991 #: build/C/man7/mailaddr.7:63
1992 msgid " USER%SOMETHING@some.where"
1996 #: build/C/man7/mailaddr.7:65
1997 msgid " machine!machine!name@some.where"
2001 #: build/C/man7/mailaddr.7:67
2002 msgid " I2461572@some.where"
2006 #: build/C/man7/mailaddr.7:71
2008 "(These are, respectively, an X.400 gateway, a gateway to an arbitrary "
2009 "internal mail system that lacks proper internet support, an UUCP gateway, "
2010 "and the last one is just boring username policy.)"
2014 #: build/C/man7/mailaddr.7:77
2016 "The real-name part (\"Eric Allman\") can either be placed before E<lt>E<gt>, "
2017 "or in () at the end. (Strictly speaking the two aren't the same, but the "
2018 "difference is beyond the scope of this page.) The name may have to be "
2019 "quoted using \"\", for example, if it contains \".\":"
2023 #: build/C/man7/mailaddr.7:79
2024 msgid " \"Eric P. Allman\" E<lt>eric@monet.berkeley.eduE<gt>"
2028 #: build/C/man7/mailaddr.7:79
2030 msgid "Abbreviation."
2034 #: build/C/man7/mailaddr.7:87
2036 "Many mail systems let users abbreviate the domain name. For instance, users "
2037 "at berkeley.edu may get away with \"eric@monet\" to send mail to Eric "
2038 "Allman. I<This behavior is deprecated.> Sometimes it works, but you should "
2043 #: build/C/man7/mailaddr.7:87
2045 msgid "Route-addrs."
2049 #: build/C/man7/mailaddr.7:94
2051 "In the past, sometimes one had to route a message through several hosts to "
2052 "get it to its final destination. Addresses which show these relays are "
2053 "termed \"route-addrs\". These use the syntax:"
2057 #: build/C/man7/mailaddr.7:96
2058 msgid " E<lt>@hosta,@hostb:user@hostcE<gt>"
2062 #: build/C/man7/mailaddr.7:101
2064 "This specifies that the message should be sent to hosta, from there to "
2065 "hostb, and finally to hostc. Many hosts disregard route-addrs and send "
2066 "directly to hostc."
2070 #: build/C/man7/mailaddr.7:107
2072 "Route-addrs are very unusual now. They occur sometimes in old mail "
2073 "archives. It is generally possible to ignore all but the \"user@hostc\" "
2074 "part of the address to determine the actual address."
2078 #: build/C/man7/mailaddr.7:107
2084 #: build/C/man7/mailaddr.7:113
2086 "Every site is required to have a user or user alias designated "
2087 "\"postmaster\" to which problems with the mail system may be addressed. The "
2088 "\"postmaster\" address is not case sensitive."
2092 #: build/C/man7/mailaddr.7:115
2093 msgid "I</etc/aliases>"
2097 #: build/C/man7/mailaddr.7:117
2098 msgid "I<~/.forward>"
2102 #: build/C/man7/mailaddr.7:125
2104 "B<binmail>(1), B<mail>(1), B<mconnect>(1), B<aliases>(5), B<forward>(5), "
2105 "B<sendmail>(8), B<vrfy>(8)"
2109 #: build/C/man7/mailaddr.7:127
2110 msgid "RFC\\ 2822 (Internet Message Format)"
2114 #: build/C/man7/man-pages.7:30
2120 #: build/C/man7/man-pages.7:30
2126 #: build/C/man7/man-pages.7:33
2127 msgid "man-pages - conventions for writing Linux man pages"
2131 #: build/C/man7/man-pages.7:37 build/C/man7/man.7:49
2132 msgid "B<man> [I<section>] I<title>"
2136 #: build/C/man7/man-pages.7:47
2138 "This page describes the conventions that should be employed when writing man "
2139 "pages for the Linux I<man-pages> project, which documents the user-space API "
2140 "provided by the Linux kernel and the GNU C library. The project thus "
2141 "provides most of the pages in Section 2, as well as many of the pages that "
2142 "appear in Sections 3, 4, 5, and 7 of the man pages on a Linux system. The "
2143 "conventions described on this page may also be useful for authors writing "
2144 "man pages for other projects."
2148 #: build/C/man7/man-pages.7:47
2150 msgid "Sections of the manual pages"
2154 #: build/C/man7/man-pages.7:50
2155 msgid "The manual Sections are traditionally defined as follows:"
2159 #: build/C/man7/man-pages.7:50
2161 msgid "B<1 Commands (Programs)>"
2165 #: build/C/man7/man-pages.7:54
2166 msgid "Those commands that can be executed by the user from within a shell."
2170 #: build/C/man7/man-pages.7:54
2172 msgid "B<2 System calls>"
2176 #: build/C/man7/man-pages.7:57
2177 msgid "Those functions which must be performed by the kernel."
2181 #: build/C/man7/man-pages.7:57
2183 msgid "B<3 Library calls>"
2187 #: build/C/man7/man-pages.7:62
2188 msgid "Most of the I<libc> functions."
2192 #: build/C/man7/man-pages.7:62
2194 msgid "B<4 Special files (devices)>"
2198 #: build/C/man7/man-pages.7:66
2199 msgid "Files found in I</dev>."
2203 #: build/C/man7/man-pages.7:66
2205 msgid "B<5 File formats and conventions>"
2209 #: build/C/man7/man-pages.7:71
2210 msgid "The format for I</etc/passwd> and other human-readable files."
2214 #: build/C/man7/man-pages.7:71
2220 #: build/C/man7/man-pages.7:73
2222 msgid "B<7 Overview, conventions, and miscellaneous>"
2226 #: build/C/man7/man-pages.7:77
2228 "Overviews of various topics, conventions and protocols, character set "
2229 "standards, and miscellaneous other things."
2233 #: build/C/man7/man-pages.7:77
2235 msgid "B<8 System management commands>"
2239 #. .B 9 Kernel routines
2240 #. This is an obsolete manual section.
2241 #. Once it was thought a good idea to document the Linux kernel here,
2242 #. but in fact very little has been documented, and the documentation
2243 #. that exists is outdated already.
2244 #. There are better sources of
2245 #. information for kernel developers.
2247 #: build/C/man7/man-pages.7:90
2248 msgid "Commands like B<mount>(8), many of which only root can execute."
2252 #: build/C/man7/man-pages.7:90
2254 msgid "Macro package"
2258 #: build/C/man7/man-pages.7:97
2260 "New manual pages should be marked up using the B<groff an.tmac> package "
2261 "described in B<man>(7). This choice is mainly for consistency: the vast "
2262 "majority of existing Linux manual pages are marked up using these macros."
2266 #: build/C/man7/man-pages.7:97
2268 msgid "Conventions for source file layout"
2272 #: build/C/man7/man-pages.7:102
2274 "Please limit source code line length to no more than about 75 characters "
2275 "wherever possible. This helps avoid line-wrapping in some mail clients when "
2276 "patches are submitted inline."
2280 #: build/C/man7/man-pages.7:106
2282 "New sentences should be started on new lines. This makes it easier to see "
2283 "the effect of patches, which often operate at the level of individual "
2288 #: build/C/man7/man-pages.7:106 build/C/man7/man.7:78
2294 #: build/C/man7/man-pages.7:110
2295 msgid "The first command in a man page should be a B<TH> command:"
2299 #: build/C/man7/man-pages.7:114 build/C/man7/man.7:85
2300 msgid "B<\\&.TH> I<title section date source manual>"
2304 #: build/C/man7/man-pages.7:117
2309 #: build/C/man7/man-pages.7:118
2315 #: build/C/man7/man-pages.7:122
2316 msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
2320 #: build/C/man7/man-pages.7:122
2326 #: build/C/man7/man-pages.7:126
2327 msgid "The section number in which the man page should be placed (e.g., I<7>)."
2331 #: build/C/man7/man-pages.7:126
2337 #: build/C/man7/man-pages.7:131
2339 "The date of the last revision\\(emremember to change this every time a "
2340 "nontrivial change is made to the man page. Dates should be written in the "
2345 #: build/C/man7/man-pages.7:131
2351 #: build/C/man7/man-pages.7:134
2352 msgid "The source of the command, function, or system call."
2356 #: build/C/man7/man-pages.7:138
2358 "For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
2363 #: build/C/man7/man-pages.7:146
2365 "For system calls, just write I<Linux>. (An earlier practice was to write "
2366 "the version number of the kernel from which the manual page was being "
2367 "written/checked. However, this was never done consistently, and so was "
2368 "probably worse than including no version number. Henceforth, avoid "
2369 "including a version number.)"
2373 #: build/C/man7/man-pages.7:151
2375 "For library calls that are part of glibc or one of the other common GNU "
2376 "libraries, just use I<GNU C Library>, I<GNU>, or an empty string."
2380 #: build/C/man7/man-pages.7:154
2381 msgid "For Section 4 pages, use I<Linux>."
2385 #: build/C/man7/man-pages.7:157
2386 msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
2390 #: build/C/man7/man-pages.7:157
2396 #: build/C/man7/man-pages.7:162
2398 "The title of the manual (e.g., for Section 2 and 3 pages in the I<man-pages> "
2399 "package, use I<Linux Programmer's Manual>)."
2403 #: build/C/man7/man-pages.7:163
2405 msgid "Sections within a manual page"
2409 #: build/C/man7/man-pages.7:170
2411 "The list below shows conventional or suggested sections. Most manual pages "
2412 "should include at least the B<highlighted> sections. Arrange a new manual "
2413 "page so that sections are placed in the order shown in the list."
2416 #. May 07: Few current man pages have an ERROR HANDLING section,,,
2418 #. May 07: Almost no current man pages have a USAGE section,,,
2421 #. May 07: Almost no current man pages have a SECURITY section,,,
2423 #. AUTHORS sections are discouraged
2424 #. AUTHORS [Discouraged]
2426 #: build/C/man7/man-pages.7:199
2431 "CONFIGURATION [Normally only in Section 4]\n"
2433 "OPTIONS [Normally only in Sections 1, 8]\n"
2434 "EXIT STATUS [Normally only in Sections 1, 8]\n"
2435 "RETURN VALUE [Normally only in Sections 2, 3]\n"
2436 "ERRORS [Typically only in Sections 2, 3]\n"
2439 "VERSIONS [Normally only in Sections 2, 3]\n"
2440 "ATTRIBUTES [Normally only in Sections 2, 3]\n"
2449 #: build/C/man7/man-pages.7:210
2451 "I<Where a traditional heading would apply>, I<please use it>; this kind of "
2452 "consistency can make the information easier to understand. If you must, you "
2453 "can create your own headings if they make things easier to understand (this "
2454 "can be especially useful for pages in Sections 4 and 5). However, before "
2455 "doing this, consider whether you could use the traditional headings, with "
2456 "some subsections (I<.SS>) within those sections."
2460 #: build/C/man7/man-pages.7:213
2461 msgid "The following list elaborates on the contents of each of the above sections."
2465 #: build/C/man7/man-pages.7:213
2471 #: build/C/man7/man-pages.7:224
2473 "The name of this manual page. See B<man>(7) for important details of the "
2474 "line(s) that should follow the B<.SH NAME> command. All words in this line "
2475 "(including the word immediately following the \"\\e-\") should be in "
2476 "lowercase, except where English or technical terminological convention "
2477 "dictates otherwise."
2481 #: build/C/man7/man-pages.7:224
2487 #: build/C/man7/man-pages.7:236
2489 "briefly describes the command or function's interface. For commands, this "
2490 "shows the syntax of the command and its arguments (including options); "
2491 "boldface is used for as-is text and italics are used to indicate replaceable "
2492 "arguments. Brackets ([]) surround optional arguments, vertical bars (|) "
2493 "separate choices, and ellipses (\\&...) can be repeated. For functions, it "
2494 "shows any required data declarations or B<#include> directives, followed by "
2495 "the function declaration."
2498 #. FIXME . Say something here about compiler options
2500 #: build/C/man7/man-pages.7:242
2502 "Where a feature test macro must be defined in order to obtain the "
2503 "declaration of a function (or a variable) from a header file, then the "
2504 "SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
2508 #: build/C/man7/man-pages.7:242
2510 msgid "B<CONFIGURATION>"
2514 #: build/C/man7/man-pages.7:246
2516 "Configuration details for a device. This section normally appears only in "
2521 #: build/C/man7/man-pages.7:246
2523 msgid "B<DESCRIPTION>"
2526 #. If there is some kind of input grammar or complex set of subcommands,
2527 #. consider describing them in a separate
2529 #. section (and just place an overview in the
2533 #: build/C/man7/man-pages.7:263
2535 "gives an explanation of what the program, function, or format does. Discuss "
2536 "how it interacts with files and standard input, and what it produces on "
2537 "standard output or standard error. Omit internals and implementation "
2538 "details unless they're critical for understanding the interface. Describe "
2539 "the usual case; for information on command-line options of a program use the "
2540 "B<OPTIONS> section."
2544 #: build/C/man7/man-pages.7:271
2546 "When describing new behavior or new flags for a system call or library "
2547 "function, be careful to note the kernel or C library version that introduced "
2548 "the change. The preferred method of noting this information for flags is as "
2549 "part of a B<.TP> list, in the following form (here, for a new system call "
2554 #: build/C/man7/man-pages.7:272
2556 msgid "B<XYZ_FLAG> (since Linux 3.7)"
2560 #: build/C/man7/man-pages.7:275
2561 msgid "Description of flag..."
2565 #: build/C/man7/man-pages.7:280
2567 "Including version information is especially useful to users who are "
2568 "constrained to using older kernel or C library versions (which is typical in "
2569 "embedded systems, for example)."
2573 #: build/C/man7/man-pages.7:280
2580 #. describes the grammar of any sublanguage this implements.
2582 #: build/C/man7/man-pages.7:288
2584 "describes the command-line options accepted by a program and how they change "
2585 "its behavior. This section should appear only for Section 1 and 8 manual "
2590 #: build/C/man7/man-pages.7:288
2592 msgid "B<EXIT STATUS>"
2596 #: build/C/man7/man-pages.7:293
2598 "lists the possible exit status values of a program and the conditions that "
2599 "cause these values to be returned. This section should appear only for "
2600 "Section 1 and 8 manual pages."
2604 #: build/C/man7/man-pages.7:293
2606 msgid "B<RETURN VALUE>"
2610 #: build/C/man7/man-pages.7:298
2612 "For Section 2 and 3 pages, this section gives a list of the values the "
2613 "library routine will return to the caller and the conditions that cause "
2614 "these values to be returned."
2618 #: build/C/man7/man-pages.7:298
2624 #: build/C/man7/man-pages.7:306
2626 "For Section 2 and 3 manual pages, this is a list of the values that may be "
2627 "placed in I<errno> in the event of an error, along with information about "
2628 "the cause of the errors. I<The error list should be in alphabetical order>."
2632 #: build/C/man7/man-pages.7:306
2634 msgid "B<ENVIRONMENT>"
2638 #: build/C/man7/man-pages.7:310
2640 "lists all environment variables that affect the program or function and how "
2645 #: build/C/man7/man-pages.7:310
2650 #. May 07: Almost no current man pages have a DIAGNOSTICS section;
2651 #. "RETURN VALUE" or "EXIT STATUS" is preferred.
2654 #. gives an overview of the most common error messages and how to
2656 #. You don't need to explain system error messages
2657 #. or fatal signals that can appear during execution of any program
2658 #. unless they're special in some way to the program.
2660 #. May 07: Almost no current man pages have a SECURITY section.
2663 #. discusses security issues and implications.
2664 #. Warn about configurations or environments that should be avoided,
2665 #. commands that may have security implications, and so on, especially
2666 #. if they aren't obvious.
2667 #. Discussing security in a separate section isn't necessary;
2668 #. if it's easier to understand, place security information in the
2669 #. other sections (such as the
2674 #. However, please include security information somewhere!
2676 #: build/C/man7/man-pages.7:347
2678 "lists the files the program or function uses, such as configuration files, "
2679 "startup files, and files the program directly operates on. Give the full "
2680 "pathname of these files, and use the installation process to modify the "
2681 "directory part to match user preferences. For many programs, the default "
2682 "installation location is in I</usr/local>, so your base manual page should "
2683 "use I</usr/local> as the base."
2687 #: build/C/man7/man-pages.7:347
2689 msgid "B<ATTRIBUTES>"
2693 #: build/C/man7/man-pages.7:352
2695 "A summary of various attributes of the function(s) documented on this page, "
2696 "broken into subsections. The following subsections are defined:"
2700 #: build/C/man7/man-pages.7:354
2702 msgid "B<Multithreading (see pthreads(7))>"
2706 #: build/C/man7/man-pages.7:357
2707 msgid "This subsection notes attributes relating to multithreaded applications:"
2711 #: build/C/man7/man-pages.7:360
2712 msgid "Whether the function is thread-safe."
2716 #: build/C/man7/man-pages.7:362
2717 msgid "Whether the function is a cancellation point."
2721 #: build/C/man7/man-pages.7:364
2722 msgid "Whether the function is async-cancel-safe."
2726 #: build/C/man7/man-pages.7:368
2727 msgid "Details of these attributes can be found in B<pthreads>(7)."
2731 #: build/C/man7/man-pages.7:369
2737 #: build/C/man7/man-pages.7:386
2739 "A brief summary of the Linux kernel or glibc versions where a system call or "
2740 "library function appeared, or changed significantly in its operation. As a "
2741 "general rule, every new interface should include a VERSIONS section in its "
2742 "manual page. Unfortunately, many existing manual pages don't include this "
2743 "information (since there was no policy to do so when they were written). "
2744 "Patches to remedy this are welcome, but, from the perspective of programmers "
2745 "writing new code, this information probably matters only in the case of "
2746 "kernel interfaces that have been added in Linux 2.4 or later (i.e., changes "
2747 "since kernel 2.2), and library functions that have been added to glibc since "
2748 "version 2.1 (i.e., changes since glibc 2.0)."
2752 #: build/C/man7/man-pages.7:391
2754 "The B<syscalls>(2) manual page also provides information about kernel "
2755 "versions in which various system calls first appeared."
2759 #: build/C/man7/man-pages.7:391
2761 msgid "B<CONFORMING TO>"
2765 #: build/C/man7/man-pages.7:408
2767 "describes any standards or conventions that relate to the function or "
2768 "command described by the manual page. The preferred terms to use for the "
2769 "various standards are listed as headings in B<standards>(7). For a page in "
2770 "Section 2 or 3, this section should note the POSIX.1 version(s) that the "
2771 "call conforms to, and also whether the call is specified in C99. (Don't "
2772 "worry too much about other standards like SUS, SUSv2, and XPG, or the SVr4 "
2773 "and 4.xBSD implementation standards, unless the call was specified in those "
2774 "standards, but isn't in the current version of POSIX.1.) (See "
2779 #: build/C/man7/man-pages.7:412
2781 "If the call is not governed by any standards but commonly exists on other "
2782 "systems, note them. If the call is Linux-specific, note this."
2786 #: build/C/man7/man-pages.7:416
2788 "If this section consists of just a list of standards (which it commonly "
2789 "does), terminate the list with a period (\\(aq.\\(aq)."
2793 #: build/C/man7/man-pages.7:416
2799 #: build/C/man7/man-pages.7:421
2801 "provides miscellaneous notes. For Section 2 and 3 man pages you may find it "
2802 "useful to include subsections (B<SS>) named I<Linux Notes> and I<Glibc "
2807 #: build/C/man7/man-pages.7:421
2813 #: build/C/man7/man-pages.7:425
2815 "lists limitations, known defects or inconveniences, and other questionable "
2820 #: build/C/man7/man-pages.7:425
2826 #: build/C/man7/man-pages.7:431
2828 "provides one or more examples describing how this function, file or command "
2829 "is used. For details on writing example programs, see I<Example Programs> "
2834 #: build/C/man7/man-pages.7:431
2840 #: build/C/man7/man-pages.7:441
2842 "lists authors of the documentation or program. B<Use of an AUTHORS section "
2843 "is strongly discouraged>. Generally, it is better not to clutter every page "
2844 "with a list of (over time potentially numerous) authors; if you write or "
2845 "significantly amend a page, add a copyright notice as a comment in the "
2846 "source file. If you are the author of a device driver and want to include "
2847 "an address for reporting bugs, place this under the BUGS section."
2851 #: build/C/man7/man-pages.7:441
2857 #: build/C/man7/man-pages.7:448
2859 "provides a comma-separated list of related man pages, ordered by section "
2860 "number and then alphabetically by name, possibly followed by other related "
2861 "pages or documents. Do not terminate this with a period."
2865 #: build/C/man7/man-pages.7:459
2867 "Where the SEE ALSO list contains many long manual page names, to improve the "
2868 "visual result of the output, it may be useful to employ the I<.ad l> (don't "
2869 "right justify) and I<.nh> (don't hyphenate) directives. Hyphenation of "
2870 "individual page names can be prevented by preceding words with the string "
2875 #: build/C/man7/man-pages.7:459
2881 #: build/C/man7/man-pages.7:466
2883 "The following subsections describe the preferred style for the I<man-pages> "
2884 "project. For details not covered below, the Chicago Manual of Style is "
2885 "usually a good source; try also grepping for preexisting usage in the "
2886 "project source tree."
2890 #: build/C/man7/man-pages.7:466
2892 msgid "Use of gender-neutral language"
2896 #: build/C/man7/man-pages.7:471
2898 "As far as possible, use gender-neutral language in the text of man pages. "
2899 "Use of \"they\" (\"them\", \"themself\", \"their\") as a gender-neutral "
2900 "singular pronoun is acceptable."
2904 #: build/C/man7/man-pages.7:471
2906 msgid "Font conventions"
2910 #: build/C/man7/man-pages.7:476
2912 "For functions, the arguments are always specified using italics, I<even in "
2913 "the SYNOPSIS section>, where the rest of the function is specified in bold:"
2917 #: build/C/man7/man-pages.7:478
2918 msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
2922 #: build/C/man7/man-pages.7:480
2923 msgid "Variable names should, like argument names, be specified in italics."
2927 #: build/C/man7/man-pages.7:490
2929 "Filenames (whether pathnames, or references to header files) are always in "
2930 "italics (e.g., I<E<lt>stdio.hE<gt>>), except in the SYNOPSIS section, where "
2931 "included files are in bold (e.g., B<#include E<lt>stdio.hE<gt>>). When "
2932 "referring to a standard header file include, specify the header file "
2933 "surrounded by angle brackets, in the usual C way (e.g., "
2934 "I<E<lt>stdio.hE<gt>>)."
2938 #: build/C/man7/man-pages.7:494
2940 "Special macros, which are usually in uppercase, are in bold (e.g., "
2941 "B<MAXINT>). Exception: don't boldface NULL."
2945 #: build/C/man7/man-pages.7:499
2947 "When enumerating a list of error codes, the codes are in bold (this list "
2948 "usually uses the B<\\&.TP> macro)."
2952 #: build/C/man7/man-pages.7:503
2954 "Complete commands should, if long, be written as an indented line on their "
2955 "own, with a blank line before and after the command, for example"
2959 #: build/C/man7/man-pages.7:507
2961 msgid "man 7 man-pages\n"
2965 #: build/C/man7/man-pages.7:517
2967 "If the command is short, then it can be included inline in the text, in "
2968 "italic format, for example, I<man 7 man-pages>. In this case, it may be "
2969 "worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
2970 "command. Command options should be written in italics (e.g., I<-l>)."
2974 #: build/C/man7/man-pages.7:522
2976 "Expressions, if not written on a separate indented line, should be specified "
2977 "in italics. Again, the use of nonbreaking spaces may be appropriate if the "
2978 "expression is inlined with normal text."
2982 #: build/C/man7/man-pages.7:533
2984 "Any reference to the subject of the current manual page should be written "
2985 "with the name in bold. If the subject is a function (i.e., this is a "
2986 "Section 2 or 3 page), then the name should be followed by a pair of "
2987 "parentheses in Roman (normal) font. For example, in the B<fcntl>(2) man "
2988 "page, references to the subject of the page would be written as: "
2989 "B<fcntl>(). The preferred way to write this in the source file is:"
2993 #: build/C/man7/man-pages.7:536
2995 msgid " .BR fcntl ()\n"
2999 #: build/C/man7/man-pages.7:540
3001 "(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
3002 "easier to write tools that parse man page source files.)"
3006 #: build/C/man7/man-pages.7:549
3008 "Any reference to another man page should be written with the name in bold, "
3009 "I<always> followed by the section number, formatted in Roman (normal) font, "
3010 "without any separating spaces (e.g., B<intro>(2)). The preferred way to "
3011 "write this in the source file is:"
3015 #: build/C/man7/man-pages.7:552
3017 msgid " .BR intro (2)\n"
3021 #: build/C/man7/man-pages.7:557
3023 "(Including the section number in cross references lets tools like "
3024 "B<man2html>(1) create properly hyperlinked pages.)"
3028 #: build/C/man7/man-pages.7:561
3030 "Control characters should be written in bold face, with no quotes; for "
3035 #: build/C/man7/man-pages.7:561
3041 #: build/C/man7/man-pages.7:567
3043 "Starting with release 2.59, I<man-pages> follows American spelling "
3044 "conventions (previously, there was a random mix of British and American "
3045 "spellings); please write all new pages and patches according to these "
3050 #: build/C/man7/man-pages.7:570
3052 "Aside from the well-known spelling differences, there are a few other "
3053 "subtleties to watch for:"
3057 #: build/C/man7/man-pages.7:574
3059 "American English tends to use the forms \"backward\", \"upward\", "
3060 "\"toward\", and so on rather than the British forms \"backwards\", "
3061 "\"upwards\", \"towards\", and so on."
3065 #: build/C/man7/man-pages.7:574
3067 msgid "BSD version numbers"
3071 #: build/C/man7/man-pages.7:582
3073 "The classical scheme for writing BSD version numbers is I<x.yBSD>, where "
3074 "I<x.y> is the version number (e.g., 4.2BSD). Avoid forms such as I<BSD "
3079 #: build/C/man7/man-pages.7:582
3081 msgid "Capitalization"
3085 #: build/C/man7/man-pages.7:588
3087 "In subsection (\"SS\") headings, capitalize the first word in the heading, "
3088 "but otherwise use lowercase, except where English usage (e.g., proper nouns) "
3089 "or programming language requirements (e.g., identifier names) dictate "
3090 "otherwise. For example:"
3094 #: build/C/man7/man-pages.7:590
3095 msgid ".SS Unicode under Linux"
3099 #: build/C/man7/man-pages.7:591
3101 msgid "Indentation of structure definitions, shell session logs, and so on"
3105 #: build/C/man7/man-pages.7:597
3107 "When structure definitions, shell session logs, and so on are included in "
3108 "running text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ "
3113 #: build/C/man7/man-pages.7:597
3115 msgid "Preferred terms"
3119 #: build/C/man7/man-pages.7:600
3121 "The following table lists some preferred terms to use in man pages, mainly "
3122 "to ensure consistency across pages."
3126 #: build/C/man7/man-pages.7:604
3128 msgid "Term\tAvoid using\tNotes\n"
3132 #: build/C/man7/man-pages.7:606
3134 msgid "bit mask\tbitmask\n"
3138 #: build/C/man7/man-pages.7:607
3140 msgid "built-in\tbuiltin\n"
3144 #: build/C/man7/man-pages.7:608
3146 msgid "Epoch\tepoch\tT{\n"
3150 #: build/C/man7/man-pages.7:609
3152 msgid "For the UNIX Epoch (00:00:00, 1 Jan 1970 UTC)\n"
3156 #: build/C/man7/man-pages.7:610 build/C/man7/man-pages.7:621 build/C/man7/man-pages.7:625 build/C/man7/man-pages.7:630 build/C/man7/man-pages.7:634 build/C/man7/man-pages.7:640 build/C/man7/man-pages.7:644 build/C/man7/man-pages.7:669 build/C/man7/man-pages.7:672 build/C/man7/man-pages.7:675
3162 #: build/C/man7/man-pages.7:611
3164 msgid "filename\tfile name\n"
3168 #: build/C/man7/man-pages.7:612
3170 msgid "filesystem\tfile system\n"
3174 #: build/C/man7/man-pages.7:613
3176 msgid "hostname\thost name\n"
3180 #: build/C/man7/man-pages.7:614
3182 msgid "inode\ti-node\n"
3186 #: build/C/man7/man-pages.7:615
3188 msgid "lowercase\tlower case, lower-case\n"
3192 #: build/C/man7/man-pages.7:616
3194 msgid "pathname\tpath name\n"
3198 #: build/C/man7/man-pages.7:617
3200 msgid "pseudoterminal\tpseudo-terminal\n"
3204 #: build/C/man7/man-pages.7:618
3206 msgid "privileged port\tT{\n"
3210 #: build/C/man7/man-pages.7:619
3212 msgid "reserved port,\n"
3216 #: build/C/man7/man-pages.7:620
3218 msgid "system port\n"
3222 #: build/C/man7/man-pages.7:622
3224 msgid "real-time\tT{\n"
3228 #: build/C/man7/man-pages.7:623
3234 #: build/C/man7/man-pages.7:624
3240 #: build/C/man7/man-pages.7:626
3242 msgid "run time\truntime\n"
3246 #: build/C/man7/man-pages.7:627
3248 msgid "saved set-group-ID\tT{\n"
3252 #: build/C/man7/man-pages.7:628
3254 msgid "saved group ID,\n"
3258 #: build/C/man7/man-pages.7:629
3260 msgid "saved set-GID\n"
3264 #: build/C/man7/man-pages.7:631
3266 msgid "saved set-user-ID\tT{\n"
3270 #: build/C/man7/man-pages.7:632
3272 msgid "saved user ID,\n"
3276 #: build/C/man7/man-pages.7:633
3278 msgid "saved set-UID\n"
3282 #: build/C/man7/man-pages.7:635
3284 msgid "set-group-ID\tset-GID, setgid\n"
3288 #: build/C/man7/man-pages.7:636
3290 msgid "set-user-ID\tset-UID, setuid\n"
3294 #: build/C/man7/man-pages.7:637
3296 msgid "superuser\tT{\n"
3300 #: build/C/man7/man-pages.7:638
3302 msgid "super user,\n"
3306 #: build/C/man7/man-pages.7:639
3308 msgid "super-user\n"
3312 #: build/C/man7/man-pages.7:641
3314 msgid "superblock\tT{\n"
3318 #: build/C/man7/man-pages.7:642
3320 msgid "super block,\n"
3324 #: build/C/man7/man-pages.7:643
3326 msgid "super-block\n"
3330 #: build/C/man7/man-pages.7:645
3332 msgid "timestamp\ttime stamp\n"
3336 #: build/C/man7/man-pages.7:646
3338 msgid "timezone\ttime zone\n"
3342 #: build/C/man7/man-pages.7:647
3344 msgid "uppercase\tupper case, upper-case\n"
3348 #: build/C/man7/man-pages.7:648
3350 msgid "usable\tuseable\n"
3354 #: build/C/man7/man-pages.7:649
3356 msgid "user space\tuserspace\n"
3360 #: build/C/man7/man-pages.7:650
3362 msgid "username\tuser name\n"
3366 #: build/C/man7/man-pages.7:651
3368 msgid "zeros\tzeroes\n"
3372 #: build/C/man7/man-pages.7:657
3373 msgid "See also the discussion I<Hyphenation of attributive compounds> below."
3377 #: build/C/man7/man-pages.7:657
3379 msgid "Terms to avoid"
3383 #: build/C/man7/man-pages.7:661
3385 "The following table lists some terms to avoid using in man pages, along with "
3386 "some suggested alternatives, mainly to ensure consistency across pages."
3390 #: build/C/man7/man-pages.7:665
3392 msgid "Avoid\tUse instead\tNotes\n"
3396 #: build/C/man7/man-pages.7:667
3398 msgid "32bit\t32-bit\tT{\n"
3402 #: build/C/man7/man-pages.7:668
3404 msgid "same for 8-bit, 16-bit, etc.\n"
3408 #: build/C/man7/man-pages.7:670
3410 msgid "current process\tcalling process\tT{\n"
3414 #: build/C/man7/man-pages.7:671
3416 msgid "A common mistake made by kernel programmers when writing man pages\n"
3420 #: build/C/man7/man-pages.7:673
3422 msgid "manpage\tT{\n"
3426 #: build/C/man7/man-pages.7:674
3428 msgid "man page, manual page\n"
3432 #: build/C/man7/man-pages.7:676
3434 msgid "minus infinity\tnegative infinity\n"
3438 #: build/C/man7/man-pages.7:677
3440 msgid "non-root\tunprivileged user\n"
3444 #: build/C/man7/man-pages.7:678
3446 msgid "non-superuser\tunprivileged user\n"
3450 #: build/C/man7/man-pages.7:679
3452 msgid "nonprivileged\tunprivileged\n"
3456 #: build/C/man7/man-pages.7:680
3458 msgid "OS\toperating system\n"
3462 #: build/C/man7/man-pages.7:681
3464 msgid "plus infinity\tpositive infinity\n"
3468 #: build/C/man7/man-pages.7:682
3470 msgid "pty\tpseudoterminal\n"
3474 #: build/C/man7/man-pages.7:683
3476 msgid "tty\tterminal\n"
3480 #: build/C/man7/man-pages.7:684
3482 msgid "Unices\tUNIX systems\n"
3486 #: build/C/man7/man-pages.7:685
3488 msgid "Unixes\tUNIX systems\n"
3492 #: build/C/man7/man-pages.7:687
3498 #: build/C/man7/man-pages.7:691
3500 "Use the correct spelling and case for trademarks. The following is a list "
3501 "of the correct spellings of various relevant trademarks that are sometimes "
3506 #: build/C/man7/man-pages.7:696
3516 #: build/C/man7/man-pages.7:696
3518 msgid "NULL, NUL, null pointer, and null character"
3522 #: build/C/man7/man-pages.7:708
3524 "A I<null pointer> is a pointer that points to nothing, and is normally "
3525 "indicated by the constant I<NULL>. On the other hand, I<NUL> is the I<null "
3526 "byte>, a byte with the value 0, represented in C via the character constant "
3527 "I<\\(aq\\e0\\(aq>."
3531 #: build/C/man7/man-pages.7:711
3533 "The preferred term for the pointer is \"null pointer\" or simply \"NULL\"; "
3534 "avoid writing \"NULL pointer\"."
3538 #: build/C/man7/man-pages.7:719
3540 "The preferred term for the byte is \"null byte\". Avoid writing \"NUL\", "
3541 "since it is too easily confused with \"NULL\". Avoid also the terms \"zero "
3542 "byte\" and \"null character\". The byte that terminates a C string should "
3543 "be described as \"the terminating null byte\"; strings may be described as "
3544 "\"null-terminated\", but avoid the use of \"NUL-terminated\"."
3548 #: build/C/man7/man-pages.7:719
3554 #: build/C/man7/man-pages.7:727
3556 "For hyperlinks, use the I<.UR>/I<.UE> macro pair (see B<groff_man>(7)). "
3557 "This produces proper hyperlinks that can be used in a web browser, when "
3558 "rendering a page with, say:"
3562 #: build/C/man7/man-pages.7:729
3564 msgid " BROWSER=firefox man -H pagename\n"
3568 #: build/C/man7/man-pages.7:729
3570 msgid "Use of e.g., i.e., etc., a.k.a., and similar"
3574 #: build/C/man7/man-pages.7:733
3576 "In general, the use of abbreviations such as \"e.g.\", \"i.e.\", \"etc.\", "
3577 "\"a.k.a.\" should be avoided, in favor of suitable full wordings (\"for "
3578 "example\", \"that is\", \"and so on\", \"also known as\")."
3582 #: build/C/man7/man-pages.7:737
3584 "The only place where such abbreviations may be acceptable is in I<short> "
3585 "parenthetical asides (e.g., like this one)."
3589 #: build/C/man7/man-pages.7:740
3591 "Always include periods in such abbreviations, as shown here. In addition, "
3592 "\"e.g.\" and \"i.e.\" should always be followed by a comma."
3596 #: build/C/man7/man-pages.7:740
3602 #: build/C/man7/man-pages.7:748
3604 "The way to write an em-dash\\(emthe glyph that appears at either end of this "
3605 "subphrase\\(emin *roff is with the macro \"\\e(em\". (On an ASCII terminal, "
3606 "an em-dash typically renders as two hyphens, but in other typographical "
3607 "contexts it renders as a long dash.) Em-dashes should be written I<without> "
3608 "surrounding spaces."
3612 #: build/C/man7/man-pages.7:748
3614 msgid "Hyphenation of attributive compounds"
3618 #: build/C/man7/man-pages.7:751
3620 "Compound terms should be hyphenated when used attributively (i.e., to "
3621 "qualify a following noun). Some examples:"
3625 #: build/C/man7/man-pages.7:758
3629 " command-line argument\n"
3630 " floating-point number\n"
3632 " user-space function\n"
3633 " wide-character string\n"
3637 #: build/C/man7/man-pages.7:758
3639 msgid "Hyphenation with multi, non, pre, re, sub, and so on"
3643 #: build/C/man7/man-pages.7:764
3645 "The general tendency in modern English is not to hyphenate after prefixes "
3646 "such as \"multi\", \"non\", \"pre\", \"re\", \"sub\", and so on. Manual "
3647 "pages should generally follow this rule when these prefixes are used in "
3648 "natural English constructions with simple suffixes. The following list "
3649 "gives some examples of the preferred forms:"
3653 #: build/C/man7/man-pages.7:785
3679 #: build/C/man7/man-pages.7:789
3681 "Hyphens should be retained when the prefixes are used in nonstandard English "
3682 "words, with trademarks, proper nouns, acronyms, or compound terms. Some "
3687 #: build/C/man7/man-pages.7:794
3697 #: build/C/man7/man-pages.7:797
3699 "Finally, note that \"re-create\" and \"recreate\" are two different verbs, "
3700 "and the former is probably what you want."
3704 #: build/C/man7/man-pages.7:797
3706 msgid "Real minus character"
3710 #: build/C/man7/man-pages.7:802
3712 "Where a real minus character is required (e.g., for numbers such as -1, or "
3713 "when writing options that have a leading dash, such as in I<ls\\ -l>), use "
3714 "the following form in the man page source:"
3718 #: build/C/man7/man-pages.7:804
3724 #: build/C/man7/man-pages.7:806
3725 msgid "This guideline applies also to code examples."
3729 #: build/C/man7/man-pages.7:806
3731 msgid "Character constants"
3735 #: build/C/man7/man-pages.7:809
3737 "To produce single quotes that render well in both ASCII and UTF-8, use the "
3738 "following form for character constants in the man page source:"
3742 #: build/C/man7/man-pages.7:811
3744 msgid " \\e(aqC\\e(aq\n"
3748 #: build/C/man7/man-pages.7:816
3750 "where I<C> is the quoted character. This guideline applies also to "
3751 "character constants used in code examples."
3755 #: build/C/man7/man-pages.7:816
3757 msgid "Example programs and shell sessions"
3761 #: build/C/man7/man-pages.7:820
3763 "Manual pages may include example programs demonstrating how to use a system "
3764 "call or library function. However, note the following:"
3768 #: build/C/man7/man-pages.7:822
3769 msgid "Example programs should be written in C."
3773 #: build/C/man7/man-pages.7:828
3775 "An example program is necessary and useful only if it demonstrates something "
3776 "beyond what can easily be provided in a textual description of the "
3777 "interface. An example program that does nothing other than call an "
3778 "interface usually serves little purpose."
3782 #: build/C/man7/man-pages.7:831
3784 "Example programs should be fairly short (preferably less than 100 lines; "
3785 "ideally less than 50 lines)."
3789 #: build/C/man7/man-pages.7:834
3791 "Example programs should do error checking after system calls and library "
3796 #: build/C/man7/man-pages.7:837
3798 "Example programs should be complete, and compile without warnings when "
3799 "compiled with I<cc\\ -Wall>."
3803 #: build/C/man7/man-pages.7:842
3805 "Where possible and appropriate, example programs should allow "
3806 "experimentation, by varying their behavior based on inputs (ideally from "
3807 "command-line arguments, or alternatively, via input read by the program)."
3811 #: build/C/man7/man-pages.7:846
3813 "Example programs should be laid out according to Kernighan and Ritchie "
3814 "style, with 4-space indents. (Avoid the use of TAB characters in source "
3819 #: build/C/man7/man-pages.7:848
3820 msgid "For consistency, all example programs should terminate using either of:"
3824 #: build/C/man7/man-pages.7:851
3827 " exit(EXIT_SUCCESS);\n"
3828 " exit(EXIT_FAILURE);\n"
3832 #: build/C/man7/man-pages.7:853
3833 msgid "Avoid using the following forms to terminate a program:"
3837 #: build/C/man7/man-pages.7:857
3846 #: build/C/man7/man-pages.7:863
3848 "If there is extensive explanatory text before the program source code, mark "
3849 "off the source code with a susbsection heading I<Program source>, as in:"
3853 #: build/C/man7/man-pages.7:865
3854 msgid ".SS Program source"
3858 #: build/C/man7/man-pages.7:867
3859 msgid "Always do this if the explanatory text includes a shell session log."
3863 #: build/C/man7/man-pages.7:870
3865 "If you include a shell session log demonstrating the use of a program or "
3866 "other system feature:"
3870 #: build/C/man7/man-pages.7:872
3871 msgid "Place the session log above the source code listing"
3875 #: build/C/man7/man-pages.7:874
3876 msgid "Indent the session log by four spaces."
3880 #: build/C/man7/man-pages.7:877
3882 "Boldface the user input text, to distinguish it from output produced by the "
3887 #: build/C/man7/man-pages.7:882
3889 "For some examples of what example programs should look like, see B<wait>(2) "
3894 #: build/C/man7/man-pages.7:889
3896 "For canonical examples of how man pages in the I<man-pages> package should "
3897 "look, see B<pipe>(2) and B<fcntl>(2)."
3901 #: build/C/man7/man-pages.7:896
3903 "B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
3908 #: build/C/man7/man.7:34
3914 #: build/C/man7/man.7:34 build/C/man7/units.7:26
3920 #: build/C/man7/man.7:37
3921 msgid "man - macros to format man pages"
3925 #: build/C/man7/man.7:41
3926 msgid "B<groff -Tascii -man> I<file> \\&..."
3930 #: build/C/man7/man.7:45
3931 msgid "B<groff -Tps -man> I<file> \\&..."
3935 #: build/C/man7/man.7:62
3937 "This manual page explains the B<groff an.tmac> macro package (often called "
3938 "the B<man> macro package). This macro package should be used by developers "
3939 "when writing or porting man pages for Linux. It is fairly compatible with "
3940 "other versions of this macro package, so porting man pages should not be a "
3941 "major problem (exceptions include the NET-2 BSD release, which uses a "
3942 "totally different macro package called mdoc; see B<mdoc>(7))."
3946 #: build/C/man7/man.7:74
3948 "Note that NET-2 BSD mdoc man pages can be used with B<groff> simply by "
3949 "specifying the B<-mdoc> option instead of the B<-man> option. Using the "
3950 "B<-mandoc> option is, however, recommended, since this will automatically "
3951 "detect which macro package is in use."
3955 #: build/C/man7/man.7:78
3957 "For conventions that should be employed when writing man pages for the Linux "
3958 "I<man-pages> package, see B<man-pages>(7)."
3962 #: build/C/man7/man.7:81
3964 "The first command in a man page (after comment lines, that is, lines that "
3965 "start with B<.\\e\">) should be"
3969 #: build/C/man7/man.7:91
3971 "For details of the arguments that should be supplied to the B<TH> command, "
3972 "see B<man-pages>(7)."
3976 #: build/C/man7/man.7:97
3978 "Note that BSD mdoc-formatted pages begin with the B<Dd> command, not the "
3983 #: build/C/man7/man.7:97
3988 #. The following doesn't seem to be required (see Debian bug 411303),
3989 #. If the name contains spaces and appears
3990 #. on the same line as
3992 #. then place the heading in double quotes.
3994 #: build/C/man7/man.7:106
3995 msgid "Sections are started with B<\\&.SH> followed by the heading name."
3999 #: build/C/man7/man.7:109
4001 "The only mandatory heading is NAME, which should be the first section and be "
4002 "followed on the next line by a one-line description of the program:"
4006 #: build/C/man7/man.7:112
4011 #: build/C/man7/man.7:114
4012 msgid "item \\e- description"
4016 #: build/C/man7/man.7:128
4018 "It is extremely important that this format is followed, and that there is a "
4019 "backslash before the single dash which follows the item name. This syntax "
4020 "is used by the B<mandb>(8) program to create a database of short "
4021 "descriptions for the B<whatis>(1) and B<apropos>(1) commands. (See "
4022 "B<lexgrog>(1) for further details on the syntax of the NAME section.)"
4026 #: build/C/man7/man.7:131
4028 "For a list of other sections that might appear in a manual page, see "
4033 #: build/C/man7/man.7:131
4039 #: build/C/man7/man.7:133
4040 msgid "The commands to select the type face are:"
4044 #: build/C/man7/man.7:133
4050 #: build/C/man7/man.7:136
4055 #: build/C/man7/man.7:136
4061 #: build/C/man7/man.7:140
4063 "Bold alternating with italics (especially useful for function "
4068 #: build/C/man7/man.7:140
4074 #: build/C/man7/man.7:145
4076 "Bold alternating with Roman (especially useful for referring to other manual "
4081 #: build/C/man7/man.7:145
4087 #: build/C/man7/man.7:148
4092 #: build/C/man7/man.7:148
4098 #: build/C/man7/man.7:151
4099 msgid "Italics alternating with bold"
4103 #: build/C/man7/man.7:151
4109 #: build/C/man7/man.7:154
4110 msgid "Italics alternating with Roman"
4114 #: build/C/man7/man.7:154
4120 #: build/C/man7/man.7:157
4121 msgid "Roman alternating with bold"
4125 #: build/C/man7/man.7:157
4131 #: build/C/man7/man.7:160
4132 msgid "Roman alternating with italics"
4136 #: build/C/man7/man.7:160
4142 #: build/C/man7/man.7:163
4143 msgid "Small alternating with bold"
4147 #: build/C/man7/man.7:163
4153 #: build/C/man7/man.7:166
4154 msgid "Small (useful for acronyms)"
4158 #: build/C/man7/man.7:179
4160 "Traditionally, each command can have up to six arguments, but the GNU "
4161 "implementation removes this limitation (you might still want to limit "
4162 "yourself to 6 arguments for portability's sake). Arguments are delimited by "
4163 "spaces. Double quotes can be used to specify an argument which contains "
4164 "spaces. All of the arguments will be printed next to each other without "
4165 "intervening spaces, so that the B<\\&.BR> command can be used to specify a "
4166 "word in bold followed by a mark of punctuation in Roman. If no arguments "
4167 "are given, the command is applied to the following line of text."
4171 #: build/C/man7/man.7:179
4173 msgid "Other macros and strings"
4177 #: build/C/man7/man.7:199
4179 "Below are other relevant macros and predefined strings. Unless noted "
4180 "otherwise, all macros cause a break (end the current line of text). Many of "
4181 "these macros set or use the \"prevailing indent.\" The \"prevailing indent\" "
4182 "value is set by any macro with the parameter I<i> below; macros may omit "
4183 "I<i> in which case the current prevailing indent will be used. As a result, "
4184 "successive indented paragraphs can use the same indent without respecifying "
4185 "the indent value. A normal (nonindented) paragraph resets the prevailing "
4186 "indent value to its default value (0.5 inches). By default a given indent "
4187 "is measured in ens; try to use ens or ems as units for indents, since these "
4188 "will automatically adjust to font size changes. The other key macro "
4193 #: build/C/man7/man.7:199
4195 msgid "Normal paragraphs"
4199 #: build/C/man7/man.7:200
4205 #: build/C/man7/man.7:205 build/C/man7/man.7:210
4206 msgid "Same as B<\\&.PP> (begin a new paragraph)."
4210 #: build/C/man7/man.7:205
4216 #: build/C/man7/man.7:210
4222 #: build/C/man7/man.7:213
4223 msgid "Begin a new paragraph and reset prevailing indent."
4227 #: build/C/man7/man.7:213
4229 msgid "Relative margin indent"
4233 #: build/C/man7/man.7:214
4235 msgid "B<\\&.RS>I< i>"
4239 #: build/C/man7/man.7:225
4241 "Start relative margin indent: moves the left margin I<i> to the right (if "
4242 "I<i> is omitted, the prevailing indent value is used). A new prevailing "
4243 "indent is set to 0.5 inches. As a result, all following paragraph(s) will "
4244 "be indented until the corresponding B<\\&.RE>."
4248 #: build/C/man7/man.7:225
4254 #: build/C/man7/man.7:229
4256 "End relative margin indent and restores the previous value of the prevailing "
4261 #: build/C/man7/man.7:229
4263 msgid "Indented paragraph macros"
4267 #: build/C/man7/man.7:230
4269 msgid "B<\\&.HP>I< i>"
4273 #: build/C/man7/man.7:235
4275 "Begin paragraph with a hanging indent (the first line of the paragraph is at "
4276 "the left margin of normal paragraphs, and the rest of the paragraph's lines "
4281 #: build/C/man7/man.7:235
4283 msgid "B<\\&.IP>I< x i>"
4287 #: build/C/man7/man.7:256
4289 "Indented paragraph with optional hanging tag. If the tag I<x> is omitted, "
4290 "the entire following paragraph is indented by I<i>. If the tag I<x> is "
4291 "provided, it is hung at the left margin before the following indented "
4292 "paragraph (this is just like B<\\&.TP> except the tag is included with the "
4293 "command instead of being on the following line). If the tag is too long, "
4294 "the text after the tag will be moved down to the next line (text will not be "
4295 "lost or garbled). For bulleted lists, use this macro with \\e(bu (bullet) "
4296 "or \\e(em (em dash) as the tag, and for numbered lists, use the number or "
4297 "letter followed by a period as the tag; this simplifies translation to other "
4302 #: build/C/man7/man.7:256
4304 msgid "B<\\&.TP>I< i>"
4308 #: build/C/man7/man.7:263
4310 "Begin paragraph with hanging tag. The tag is given on the next line, but "
4311 "its results are like those of the B<\\&.IP> command."
4315 #: build/C/man7/man.7:263
4317 msgid "Hypertext link macros"
4321 #: build/C/man7/man.7:273
4323 "(Feature supported with B<groff> only.) In order to use hypertext link "
4324 "macros, it is necessary to load the B<www.tmac> macro package. Use the "
4325 "request B<.mso www.tmac> to do this."
4329 #: build/C/man7/man.7:273
4331 msgid "B<\\&.URL>I< url link trailer>"
4334 #. The following is a kludge to get a paragraph into the listing.
4336 #: build/C/man7/man.7:286
4338 "Inserts a hypertext link to the URI (URL) I<url>, with I<link> as the text "
4339 "of the link. The I<trailer> will be printed immediately afterward. When "
4340 "generating HTML this should translate into the HTML command B<E<lt>A "
4341 "HREF=\">I<url>B<\"E<gt>>I<link>B<E<lt>/AE<gt>>I<trailer>B<.>"
4344 #. The following is a kludge to get a paragraph into the listing.
4346 #: build/C/man7/man.7:293
4348 "This and other related macros are new, and many tools won't do anything with "
4349 "them, but since many tools (including troff) will simply ignore undefined "
4350 "macros (or at worst insert their text) these are safe to insert."
4353 #. The following is a kludge to get a paragraph into the listing.
4355 #: build/C/man7/man.7:302
4357 "It can be useful to define your own B<URL> macro in manual pages for the "
4358 "benefit of those viewing it with a roff viewer other than B<groff>. That "
4359 "way, the URL, link text, and trailer text (if any) are still visible."
4363 #: build/C/man7/man.7:305
4364 msgid "Here's an example:"
4368 #: build/C/man7/man.7:307
4373 #: build/C/man7/man.7:309
4374 msgid "\\e\\e$2 \\e(laURL: \\e\\e$1 \\e(ra\\e\\e$3"
4378 #: build/C/man7/man.7:311
4383 #: build/C/man7/man.7:313
4384 msgid "\\&.if \\en[.g] .mso www.tmac"
4388 #: build/C/man7/man.7:316
4389 msgid "\\&.TH I<...>"
4393 #: build/C/man7/man.7:318
4394 msgid "I<(later in the page)>"
4398 #: build/C/man7/man.7:320
4399 msgid "This software comes from the"
4403 #: build/C/man7/man.7:322
4404 msgid "\\&.URL \"http://www.gnu.org/\" \"GNU Project\" \" of the\""
4408 #: build/C/man7/man.7:324
4409 msgid "\\&.URL \"http://www.fsf.org/\" \"Free Software Foundation\" ."
4413 #: build/C/man7/man.7:334
4415 "In the above, if B<groff> is being used, the B<www.tmac> macro package's "
4416 "definition of the URL macro will supersede the locally defined one."
4420 #: build/C/man7/man.7:339
4422 "A number of other link macros are available. See B<groff_www>(7) for more "
4427 #: build/C/man7/man.7:339
4429 msgid "Miscellaneous macros"
4433 #: build/C/man7/man.7:340
4439 #: build/C/man7/man.7:344
4440 msgid "Reset tabs to default tab values (every 0.5 inches); does not cause a break."
4444 #: build/C/man7/man.7:344
4446 msgid "B<\\&.PD>I< d>"
4450 #: build/C/man7/man.7:349
4452 "Set inter-paragraph vertical distance to d (if omitted, d=0.4v); does not "
4457 #: build/C/man7/man.7:349
4459 msgid "B<\\&.SS>I< t>"
4463 #: build/C/man7/man.7:356
4465 "Subheading I<t> (like B<\\&.SH>, but used for a subsection inside a "
4470 #: build/C/man7/man.7:356
4472 msgid "Predefined strings"
4476 #: build/C/man7/man.7:360
4477 msgid "The B<man> package has the following predefined strings:"
4481 #: build/C/man7/man.7:360
4487 #: build/C/man7/man.7:362
4488 msgid "Registration Symbol: \\*R"
4492 #: build/C/man7/man.7:362
4498 #: build/C/man7/man.7:364
4499 msgid "Change to default font size"
4503 #: build/C/man7/man.7:364
4509 #: build/C/man7/man.7:366
4510 msgid "Trademark Symbol: \\*(Tm"
4514 #: build/C/man7/man.7:366
4520 #: build/C/man7/man.7:368
4521 msgid "Left angled double quote: ``"
4525 #: build/C/man7/man.7:368
4531 #: build/C/man7/man.7:370
4532 msgid "Right angled double quote: ''"
4536 #: build/C/man7/man.7:370
4542 #: build/C/man7/man.7:414
4544 "Although technically B<man> is a troff macro package, in reality a large "
4545 "number of other tools process man page files that don't implement all of "
4546 "troff's abilities. Thus, it's best to avoid some of troff's more exotic "
4547 "abilities where possible to permit these other tools to work correctly. "
4548 "Avoid using the various troff preprocessors (if you must, go ahead and use "
4549 "B<tbl>(1), but try to use the B<IP> and B<TP> commands instead for "
4550 "two-column tables). Avoid using computations; most other tools can't "
4551 "process them. Use simple commands that are easy to translate to other "
4552 "formats. The following troff macros are believed to be safe (though in many "
4553 "cases they will be ignored by translators): B<\\e\">, B<.>, B<ad>, B<bp>, "
4554 "B<br>, B<ce>, B<de>, B<ds>, B<el>, B<ie>, B<if>, B<fi>, B<ft>, B<hy>, B<ig>, "
4555 "B<in>, B<na>, B<ne>, B<nf>, B<nh>, B<ps>, B<so>, B<sp>, B<ti>, B<tr>."
4559 #: build/C/man7/man.7:437
4561 "You may also use many troff escape sequences (those sequences beginning with "
4562 "\\e). When you need to include the backslash character as normal text, use "
4563 "\\ee. Other sequences you may use, where x or xx are any characters and N "
4564 "is any digit, include: B<\\e'>, B<\\e`>, B<\\e->, B<\\e.>, B<\\e\">, "
4565 "B<\\e%>, B<\\e*x>, B<\\e*(xx>, B<\\e(xx>, B<\\e$N>, B<\\enx>, B<\\en(xx>, "
4566 "B<\\efx>, and B<\\ef(xx>. Avoid using the escape sequences for drawing "
4571 #: build/C/man7/man.7:468
4573 "Do not use the optional parameter for B<bp> (break page). Use only positive "
4574 "values for B<sp> (vertical space). Don't define a macro (B<de>) with the "
4575 "same name as a macro in this or the mdoc macro package with a different "
4576 "meaning; it's likely that such redefinitions will be ignored. Every "
4577 "positive indent (B<in>) should be paired with a matching negative indent "
4578 "(although you should be using the B<RS> and B<RE> macros instead). The "
4579 "condition test (B<if,ie>) should only have \\(aqt\\(aq or \\(aqn\\(aq as "
4580 "the condition. Only translations (B<tr>) that can be ignored should be "
4581 "used. Font changes (B<ft> and the B<\\ef> escape sequence) should only "
4582 "have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have "
4587 #: build/C/man7/man.7:475
4589 "If you use capabilities beyond these, check the results carefully on several "
4590 "tools. Once you've confirmed that the additional capability is safe, let "
4591 "the maintainer of this document know about the safe command or sequence that "
4592 "should be added to this list."
4596 #: build/C/man7/man.7:477
4597 msgid "I</usr/share/groff/>[*/]I<tmac/an.tmac>"
4601 #: build/C/man7/man.7:479
4602 msgid "I</usr/man/whatis>"
4606 #: build/C/man7/man.7:493
4608 "By all means include full URLs (or URIs) in the text itself; some tools such "
4609 "as B<man2html>(1) can automatically turn them into hypertext links. You "
4610 "can also use the new B<URL> macro to identify links to related information. "
4611 "If you include URLs, use the full URL (e.g., E<.UR "
4612 "http://www.kernelnotes.org> E<.UE )> to ensure that tools can automatically "
4617 #: build/C/man7/man.7:502
4619 "Tools processing these files should open the file and examine the first "
4620 "nonwhitespace character. A period (.) or single quote (') at the beginning "
4621 "of a line indicates a troff-based file (such as man or mdoc). A left angle "
4622 "bracket (E<lt>) indicates an SGML/XML-based file (such as HTML or Docbook). "
4623 "Anything else suggests simple ASCII text (e.g., a \"catman\" result)."
4627 #: build/C/man7/man.7:513
4629 "Many man pages begin with B<\\'\\e\"> followed by a space and a list of "
4630 "characters, indicating how the page is to be preprocessed. For "
4631 "portability's sake to non-troff translators we recommend that you avoid "
4632 "using anything other than B<tbl>(1), and Linux can detect that "
4633 "automatically. However, you might want to include this information so your "
4634 "man page can be handled by other (less capable) systems. Here are the "
4635 "definitions of the preprocessors invoked by these characters:"
4639 #: build/C/man7/man.7:513
4645 #: build/C/man7/man.7:516
4650 #: build/C/man7/man.7:516
4656 #: build/C/man7/man.7:519
4661 #: build/C/man7/man.7:519
4667 #: build/C/man7/man.7:522
4672 #: build/C/man7/man.7:522
4678 #: build/C/man7/man.7:525
4683 #: build/C/man7/man.7:525
4689 #: build/C/man7/man.7:528
4694 #: build/C/man7/man.7:528
4700 #: build/C/man7/man.7:531
4705 #: build/C/man7/man.7:531 build/C/man7/suffixes.7:278 build/C/man7/mdoc.samples.7:2883
4711 #: build/C/man7/man.7:544
4713 "Most of the macros describe formatting (e.g., font type and spacing) instead "
4714 "of marking semantic content (e.g., this text is a reference to another "
4715 "page), compared to formats like mdoc and DocBook (even HTML has more "
4716 "semantic markings). This situation makes it harder to vary the B<man> "
4717 "format for different media, to make the formatting consistent for a given "
4718 "media, and to automatically insert cross-references. By sticking to the "
4719 "safe subset described above, it should be easier to automate transitioning "
4720 "to a different reference page format in the future."
4725 #. James Clark (jjc@jclark.com) wrote the implementation of the macro package.
4727 #. Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
4728 #. this manual page.
4730 #. Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
4731 #. (which influenced this manual page).
4733 #. David A. Wheeler (dwheeler@ida.org) heavily modified this
4734 #. manual page, such as adding detailed information on sections and macros.
4736 #: build/C/man7/man.7:560
4737 msgid "The Sun macro B<TX> is not implemented."
4741 #: build/C/man7/man.7:572
4743 "B<apropos>(1), B<groff>(1), B<lexgrog>(1), B<man>(1), B<man2html>(1), "
4744 "B<whatis>(1), B<groff_man>(7), B<groff_www>(7), B<man-pages>(7), B<mdoc>(7), "
4745 "B<mdoc.samples>(7)"
4749 #: build/C/man7/mdoc.7:42
4751 msgid "July 11, 1999"
4755 #: build/C/man7/mdoc.7:43
4761 #: build/C/man7/mdoc.7:47
4766 #: build/C/man7/mdoc.7:47
4768 msgid "quick reference guide for the"
4772 #: build/C/man7/mdoc.7:50
4773 msgid "E<.Nm \\-mdoc> macro package"
4777 #: build/C/man7/mdoc.7:54
4778 msgid "E<.Nm groff> E<.Fl m Ns Ar doc> E<.Ar files ...>"
4782 #: build/C/man7/mdoc.7:66
4784 "The E<.Nm \\-mdoc> package is a set of content-based and domain-based macros "
4785 "used to format the E<.Bx> man pages. The macro names and their meanings are "
4786 "listed below for quick reference; for a detailed explanation on using the "
4787 "package, see the tutorial sampler E<.Xr mdoc.samples 7>."
4791 #: build/C/man7/mdoc.7:71
4793 "Note that this is not the usual macro package for Linux documentation, "
4794 "although it is used for documentation of several widely used programs; see "
4799 #: build/C/man7/mdoc.7:80
4801 "The macros are described in two groups, the first includes the structural "
4802 "and physical page layout macros. The second contains the manual and general "
4803 "text domain macros which differentiate the E<.Nm \\-mdoc> package from other "
4804 "E<.Xr troff> formatting packages."
4808 #: build/C/man7/mdoc.7:80 build/C/man7/mdoc.samples.7:1811
4810 msgid "PAGE STRUCTURE DOMAIN"
4814 #: build/C/man7/mdoc.7:81
4816 msgid "Title Macros"
4820 #: build/C/man7/mdoc.7:84
4822 "To create a valid manual page, these three macros, in this order, are "
4827 #: build/C/man7/mdoc.7:85
4829 msgid "Li \"\\&.Dd \" Ar \"Month day, year\""
4833 #: build/C/man7/mdoc.7:87
4834 msgid "Document date."
4838 #: build/C/man7/mdoc.7:87
4840 msgid "Li \"\\&.Dt \" Ar \"DOCUMENT_TITLE [section] [volume]\""
4844 #: build/C/man7/mdoc.7:89
4845 msgid "Title, in uppercase."
4849 #: build/C/man7/mdoc.7:89
4851 msgid "Li \"\\&.Os \" Ar \"OPERATING_SYSTEM [version/release]\""
4855 #: build/C/man7/mdoc.7:92
4856 msgid "Operating system E<.Pq Tn BSD>."
4860 #: build/C/man7/mdoc.7:93
4862 msgid "Page Layout Macros"
4866 #: build/C/man7/mdoc.7:95
4867 msgid "Section headers, paragraph breaks, lists and displays."
4871 #: build/C/man7/mdoc.7:96
4877 #: build/C/man7/mdoc.7:99
4878 msgid "Section Headers. Valid headers, in the order of presentation:"
4882 #: build/C/man7/mdoc.7:100
4888 #: build/C/man7/mdoc.7:108
4890 "Name section, should include the E<.Ql \\&.Nm> or E<.Ql \\&.Fn> and the "
4891 "E<.Ql \\&.Nd> macros."
4895 #: build/C/man7/mdoc.7:108
4901 #: build/C/man7/mdoc.7:110
4906 #: build/C/man7/mdoc.7:110
4908 msgid "Ar DESCRIPTION"
4912 #: build/C/man7/mdoc.7:113
4913 msgid "General description, should include options and parameters."
4917 #: build/C/man7/mdoc.7:113
4919 msgid "Ar RETURN VALUE"
4923 #: build/C/man7/mdoc.7:115
4924 msgid "Sections two and three function calls."
4928 #: build/C/man7/mdoc.7:115
4930 msgid "Ar ENVIRONMENT"
4934 #: build/C/man7/mdoc.7:117
4935 msgid "Describe environment variables."
4939 #: build/C/man7/mdoc.7:117
4945 #: build/C/man7/mdoc.7:119
4946 msgid "Files associated with the subject."
4950 #: build/C/man7/mdoc.7:119
4956 #: build/C/man7/mdoc.7:121
4957 msgid "Examples and suggestions."
4961 #: build/C/man7/mdoc.7:121
4963 msgid "Ar DIAGNOSTICS"
4967 #: build/C/man7/mdoc.7:123
4968 msgid "Normally used for section four device interface diagnostics."
4972 #: build/C/man7/mdoc.7:123
4978 #: build/C/man7/mdoc.7:126
4979 msgid "Sections two and three error and signal handling."
4983 #: build/C/man7/mdoc.7:126
4989 #: build/C/man7/mdoc.7:128
4990 msgid "Cross references and citations."
4994 #: build/C/man7/mdoc.7:128
4996 msgid "Ar CONFORMING TO"
5000 #: build/C/man7/mdoc.7:130
5001 msgid "Conformance to standards if applicable."
5005 #: build/C/man7/mdoc.7:130
5011 #: build/C/man7/mdoc.7:133
5012 msgid "If a standard is not applicable, the history of the subject should be given."
5016 #: build/C/man7/mdoc.7:133
5022 #: build/C/man7/mdoc.7:135
5023 msgid "Gotchas and caveats."
5027 #: build/C/man7/mdoc.7:135
5033 #: build/C/man7/mdoc.7:138
5034 msgid "Customized headers may be added at the authors discretion."
5038 #: build/C/man7/mdoc.7:139
5044 #: build/C/man7/mdoc.7:141
5045 msgid "Subsection Headers."
5049 #: build/C/man7/mdoc.7:141
5055 #: build/C/man7/mdoc.7:144
5056 msgid "Paragraph Break. Vertical space (one line)."
5060 #: build/C/man7/mdoc.7:144 build/C/man7/mdoc.samples.7:2200
5066 #: build/C/man7/mdoc.7:147
5067 msgid "(D-one) Display-one Indent and display one text line."
5071 #: build/C/man7/mdoc.7:147 build/C/man7/mdoc.samples.7:2208
5077 #: build/C/man7/mdoc.7:150
5078 msgid "(D-ell) Display-one literal. Indent and display one line of literal text."
5082 #: build/C/man7/mdoc.7:150 build/C/man7/mdoc.samples.7:2228
5088 #: build/C/man7/mdoc.7:153
5089 msgid "Begin-display block. Display options:"
5093 #: build/C/man7/mdoc.7:154 build/C/man7/mdoc.samples.7:2248
5099 #: build/C/man7/mdoc.7:156
5100 msgid "Unjustified (ragged edges)."
5104 #: build/C/man7/mdoc.7:156 build/C/man7/mdoc.samples.7:2251
5110 #: build/C/man7/mdoc.7:158
5115 #: build/C/man7/mdoc.7:158 build/C/man7/mdoc.samples.7:2255
5121 #: build/C/man7/mdoc.7:160
5122 msgid "Literal text or code."
5126 #: build/C/man7/mdoc.7:160
5128 msgid "Fl file Ar name"
5132 #: build/C/man7/mdoc.7:164
5133 msgid "Read in named E<.Ar file> and display."
5137 #: build/C/man7/mdoc.7:164 build/C/man7/mdoc.samples.7:2267
5139 msgid "Fl offset Ar string"
5143 #: build/C/man7/mdoc.7:169
5144 msgid "Offset display. Acceptable E<.Ar string> values:"
5148 #: build/C/man7/mdoc.7:170 build/C/man7/mdoc.samples.7:2275
5154 #: build/C/man7/mdoc.7:172
5155 msgid "Align block on left (default)."
5159 #: build/C/man7/mdoc.7:172 build/C/man7/mdoc.samples.7:2279
5165 #: build/C/man7/mdoc.7:174
5166 msgid "Approximate center margin."
5170 #: build/C/man7/mdoc.7:174 build/C/man7/mdoc.samples.7:2284
5176 #: build/C/man7/mdoc.7:176
5177 msgid "Six constant width spaces (a tab)."
5181 #: build/C/man7/mdoc.7:176 build/C/man7/mdoc.samples.7:2293
5183 msgid "Ar indent-two"
5187 #: build/C/man7/mdoc.7:178
5192 #: build/C/man7/mdoc.7:178 build/C/man7/mdoc.samples.7:2295
5198 #: build/C/man7/mdoc.7:181
5199 msgid "Left aligns block 2 inches from right."
5203 #: build/C/man7/mdoc.7:181
5205 msgid "Ar xx Ns Cm n"
5209 #: build/C/man7/mdoc.7:188
5211 "Where E<.Ar xx> is a number from E<.No \\&4 Ns Cm n> to E<.No \\&9\\&9 Ns Cm "
5216 #: build/C/man7/mdoc.7:188
5222 #: build/C/man7/mdoc.7:192
5223 msgid "Where E<.Ar Aa> is a callable macro name."
5227 #: build/C/man7/mdoc.7:192
5233 #: build/C/man7/mdoc.7:196
5234 msgid "The width of E<.Ar string> is used."
5238 #: build/C/man7/mdoc.7:198
5244 #: build/C/man7/mdoc.7:200
5245 msgid "End-display (matches \\&.Bd)."
5249 #: build/C/man7/mdoc.7:200
5255 #: build/C/man7/mdoc.7:204
5256 msgid "Begin-list. Create lists or columns. Options:"
5260 #: build/C/man7/mdoc.7:205
5262 msgid "Ar List-types"
5266 #: build/C/man7/mdoc.7:207
5268 msgid "Fl bullet Ta \"Bullet Item List\""
5272 #: build/C/man7/mdoc.7:208
5274 msgid "Fl item Ta \"Unlabeled List\""
5278 #: build/C/man7/mdoc.7:209
5280 msgid "Fl enum Ta \"Enumerated List\""
5284 #: build/C/man7/mdoc.7:210
5286 msgid "Fl tag Ta \"Tag Labeled List\""
5290 #: build/C/man7/mdoc.7:211
5292 msgid "Fl diag Ta \"Diagnostic List\""
5296 #: build/C/man7/mdoc.7:212
5298 msgid "Fl hang Ta \"Hanging Labeled List\""
5302 #: build/C/man7/mdoc.7:213
5304 msgid "Fl ohang Ta \"Overhanging Labeled List\""
5308 #: build/C/man7/mdoc.7:214
5310 msgid "Fl inset Ta \"Inset or Run-on Labeled List\""
5314 #: build/C/man7/mdoc.7:216
5316 msgid "List-parameters"
5320 #: build/C/man7/mdoc.7:218
5326 #: build/C/man7/mdoc.7:222
5327 msgid "(All lists.) See E<.Ql \\&.Bd> begin-display above."
5331 #: build/C/man7/mdoc.7:222
5337 #: build/C/man7/mdoc.7:229
5338 msgid "E<.Pf ( Fl tag> and E<.Fl hang> lists only.) See E<.Ql \\&.Bd>."
5342 #: build/C/man7/mdoc.7:229
5348 #: build/C/man7/mdoc.7:232
5349 msgid "(All lists.) Suppresses blank lines."
5353 #: build/C/man7/mdoc.7:234
5359 #: build/C/man7/mdoc.7:236
5364 #: build/C/man7/mdoc.7:236
5370 #: build/C/man7/mdoc.7:238
5375 #: build/C/man7/mdoc.7:239
5377 msgid "MANUAL AND GENERAL TEXT DOMAIN MACROS"
5381 #: build/C/man7/mdoc.7:243
5383 "The manual and general text domain macros are special in that most of them "
5384 "are parsed for callable macros for example:"
5388 #: build/C/man7/mdoc.7:244
5390 msgid "Li \"\\&.Op Fl s Ar file\""
5394 #: build/C/man7/mdoc.7:247
5395 msgid "Produces E<.Op Fl s Ar file>"
5399 #: build/C/man7/mdoc.7:265
5401 "In this example, the option enclosure macro E<.Ql \\&.Op> is parsed, and "
5402 "calls the callable content macro E<.Ql \\&Fl> which operates on the argument "
5403 "E<.Ql s> and then calls the callable content macro E<.Ql \\&Ar> which "
5404 "operates on the argument E<.Ql file>. Some macros may be callable, but are "
5405 "not parsed and vice versa. These macros are indicated in the E<.Em parsed> "
5406 "and E<.Em callable> columns below."
5410 #: build/C/man7/mdoc.7:267
5411 msgid "Unless stated, manual domain macros share a common syntax:"
5415 #: build/C/man7/mdoc.7:268
5417 msgid "\\&.Va argument [\\ .\\ ,\\ ;\\ :\\ (\\ )\\ [\\ ]\\ argument ...\\ ]"
5421 #: build/C/man7/mdoc.7:288
5423 "E<.Sy Note>: Opening and closing punctuation characters are recognized as "
5424 "such only if they are presented one at a time. The string E<.Ql \"),\"> is "
5425 "not recognized as punctuation and will be output with a leading white space "
5426 "and in what ever font the calling macro uses. The argument list E<.Ql \"] ) "
5427 ",\"> is recognized as three sequential closing punctuation characters and a "
5428 "leading white space is not output between the characters and the previous "
5429 "argument (if any). The special meaning of a punctuation character may be "
5430 "escaped with the string E<.Ql \\e&>. For example the following string,"
5434 #: build/C/man7/mdoc.7:289
5436 msgid "Li \"\\&.Ar file1\\ , file2\\ , file3\\ )\\ .\""
5440 #: build/C/man7/mdoc.7:292
5441 msgid "Produces E<.Ar file1 , file2 , file3>)."
5445 #: build/C/man7/mdoc.7:294
5447 msgid "Manual Domain Macros"
5451 #: build/C/man7/mdoc.7:296 build/C/man7/mdoc.7:321
5453 msgid "Em \"Name\tParsed\tCallable\tDescription\""
5457 #: build/C/man7/mdoc.7:297
5459 msgid "Li \\&Ad Ta Yes Ta Yes Ta \"Address. (This macro may be deprecated.)\""
5463 #: build/C/man7/mdoc.7:298
5465 msgid "Li \\&An Ta Yes Ta Yes Ta \"Author name.\""
5469 #: build/C/man7/mdoc.7:299
5471 msgid "Li \\&Ar Ta Yes Ta Yes Ta \"Command-line argument.\""
5475 #: build/C/man7/mdoc.7:300
5478 "Li \\&Cd Ta \\&No Ta \\&No Ta \"Configuration declaration (section four "
5483 #: build/C/man7/mdoc.7:301
5485 msgid "Li \\&Cm Ta Yes Ta Yes Ta \"Command-line argument modifier.\""
5489 #: build/C/man7/mdoc.7:302
5491 msgid "Li \\&Dv Ta Yes Ta Yes Ta \"Defined variable (source code).\""
5495 #: build/C/man7/mdoc.7:303
5497 msgid "Li \\&Er Ta Yes Ta Yes Ta \"Error number (source code).\""
5501 #: build/C/man7/mdoc.7:304
5503 msgid "Li \\&Ev Ta Yes Ta Yes Ta \"Environment variable.\""
5507 #: build/C/man7/mdoc.7:305
5509 msgid "Li \\&Fa Ta Yes Ta Yes Ta \"Function argument.\""
5513 #: build/C/man7/mdoc.7:306
5515 msgid "Li \\&Fd Ta Yes Ta Yes Ta \"Function declaration.\""
5519 #: build/C/man7/mdoc.7:307
5521 msgid "Li \\&Fn Ta Yes Ta Yes Ta \"Function call (also .Fo and .Fc).\""
5525 #: build/C/man7/mdoc.7:308
5527 msgid "Li \\&Ic Ta Yes Ta Yes Ta \"Interactive command.\""
5531 #: build/C/man7/mdoc.7:309
5533 msgid "Li \\&Li Ta Yes Ta Yes Ta \"Literal text.\""
5537 #: build/C/man7/mdoc.7:310
5539 msgid "Li \\&Nm Ta Yes Ta Yes Ta \"Command name.\""
5543 #: build/C/man7/mdoc.7:311
5545 msgid "Li \\&Op Ta Yes Ta Yes Ta \"Option (also .Oo and .Oc).\""
5549 #: build/C/man7/mdoc.7:312
5551 msgid "Li \\&Ot Ta Yes Ta Yes Ta \"Old style function type (Fortran only).\""
5555 #: build/C/man7/mdoc.7:313
5557 msgid "Li \\&Pa Ta Yes Ta Yes Ta \"Pathname or filename.\""
5561 #: build/C/man7/mdoc.7:314
5563 msgid "Li \\&St Ta Yes Ta Yes Ta \"Standards (\\-p1003.2, \\-p1003.1 or \\-ansiC)\""
5567 #: build/C/man7/mdoc.7:315
5569 msgid "Li \\&Va Ta Yes Ta Yes Ta \"Variable name.\""
5573 #: build/C/man7/mdoc.7:316
5575 msgid "Li \\&Vt Ta Yes Ta Yes Ta \"Variable type (Fortran only).\""
5579 #: build/C/man7/mdoc.7:317
5581 msgid "Li \\&Xr Ta Yes Ta Yes Ta \"Manual Page Cross Reference.\""
5585 #: build/C/man7/mdoc.7:319
5587 msgid "General Text Domain Macros"
5591 #: build/C/man7/mdoc.7:322
5593 msgid "Li \\&%A Ta Yes Ta \\&No Ta \"Reference author.\""
5597 #: build/C/man7/mdoc.7:323
5599 msgid "Li \\&%B Ta Yes Ta Yes Ta \"Reference book title.\""
5603 #: build/C/man7/mdoc.7:324
5605 msgid "Li \\&%\\&C Ta \\&No Ta \\&No Ta \"Reference place of publishing (city).\""
5609 #: build/C/man7/mdoc.7:325
5611 msgid "Li \\&%\\&D Ta \\&No Ta \\&No Ta \"Reference date.\""
5615 #: build/C/man7/mdoc.7:326
5617 msgid "Li \\&%J Ta Yes Ta Yes Ta \"Reference journal title.\""
5621 #: build/C/man7/mdoc.7:327
5623 msgid "Li \\&%N Ta \\&No Ta \\&No Ta \"Reference issue number.\""
5627 #: build/C/man7/mdoc.7:328
5629 msgid "Li \\&%\\&O Ta \\&No Ta \\&No Ta \"Reference optional information.\""
5633 #: build/C/man7/mdoc.7:329
5635 msgid "Li \\&%P Ta \\&No Ta \\&No Ta \"Reference page number(s).\""
5639 #: build/C/man7/mdoc.7:330
5641 msgid "Li \\&%R Ta \\&No Ta \\&No Ta \"Reference report Name.\""
5645 #: build/C/man7/mdoc.7:331
5647 msgid "Li \\&%T Ta Yes Ta Yes Ta \"Reference article title.\""
5651 #: build/C/man7/mdoc.7:332
5653 msgid "Li \\&%V Ta \\&No Ta \\&No Ta \"Reference volume.\""
5657 #: build/C/man7/mdoc.7:333
5659 msgid "Li \\&Ac Ta Yes Ta Yes Ta \"Angle close quote.\""
5663 #: build/C/man7/mdoc.7:334
5665 msgid "Li \\&Ao Ta Yes Ta Yes Ta \"Angle open quote.\""
5669 #: build/C/man7/mdoc.7:335
5671 msgid "Li \\&Ap Ta Yes Ta Yes Ta Apostrophe."
5675 #: build/C/man7/mdoc.7:336
5677 msgid "Li \\&Aq Ta Yes Ta Yes Ta \"Angle quote.\""
5681 #: build/C/man7/mdoc.7:337
5683 msgid "Li \\&At Ta \\&No Ta \\&No Ta Tn \"AT&T UNIX\""
5687 #: build/C/man7/mdoc.7:338
5689 msgid "Li \\&Bc Ta Yes Ta Yes Ta \"Bracket close quote.\""
5693 #: build/C/man7/mdoc.7:339
5695 msgid "Li \\&Bf Ta \\&No Ta \\&No Ta \"Begin font mode.\""
5699 #: build/C/man7/mdoc.7:340
5701 msgid "Li \\&Bo Ta Yes Ta Yes Ta \"Bracket open quote.\""
5705 #: build/C/man7/mdoc.7:341
5707 msgid "Li \\&Bq Ta Yes Ta Yes Ta \"Bracket quote.\""
5711 #: build/C/man7/mdoc.7:342
5713 msgid "Li \\&Bx Ta Yes Ta Yes Ta Bx ."
5717 #: build/C/man7/mdoc.7:343
5719 msgid "Li \\&Db Ta \\&No Ta \\&No Ta \"Debug (default is \\*qoff\\*q)\""
5723 #: build/C/man7/mdoc.7:344
5725 msgid "Li \\&Dc Ta Yes Ta Yes Ta \"Double close quote.\""
5729 #: build/C/man7/mdoc.7:345
5731 msgid "Li \\&Do Ta Yes Ta Yes Ta \"Double open quote.\""
5735 #: build/C/man7/mdoc.7:346
5737 msgid "Li \\&Dq Ta Yes Ta Yes Ta \"Double quote.\""
5741 #: build/C/man7/mdoc.7:347
5743 msgid "Li \\&Ec Ta Yes Ta Yes Ta \"Enclose string close quote.\""
5747 #: build/C/man7/mdoc.7:348
5749 msgid "Li \\&Ef Ta \\&No Ta \\&No Ta \"End font mode.\""
5753 #: build/C/man7/mdoc.7:349
5755 msgid "Li \\&Em Ta Yes Ta Yes Ta \"Emphasis (traditional English).\""
5759 #: build/C/man7/mdoc.7:350
5761 msgid "Li \\&Eo Ta Yes Ta Yes Ta \"Enclose string open quote.\""
5765 #: build/C/man7/mdoc.7:351
5767 msgid "Li \\&Fx Ta \\&No Ta \\&No Ta Tn \"FreeBSD operating system\""
5771 #: build/C/man7/mdoc.7:352
5773 msgid "Li \\&No Ta Yes Ta Yes Ta \"Normal text (no-op).\""
5777 #: build/C/man7/mdoc.7:353
5779 msgid "Li \\&Ns Ta Yes Ta Yes Ta \"No space.\""
5783 #: build/C/man7/mdoc.7:354
5785 msgid "Li \\&Pc Ta Yes Ta Yes Ta \"Parenthesis close quote.\""
5789 #: build/C/man7/mdoc.7:355
5791 msgid "Li \\&Pf Ta Yes Ta \\&No Ta \"Prefix string.\""
5795 #: build/C/man7/mdoc.7:356
5797 msgid "Li \\&Po Ta Yes Ta Yes Ta \"Parenthesis open quote.\""
5801 #: build/C/man7/mdoc.7:357
5803 msgid "Li \\&Pq Ta Yes Ta Yes Ta \"Parentheses quote.\""
5807 #: build/C/man7/mdoc.7:358
5809 msgid "Li \\&Qc Ta Yes Ta Yes Ta \"Straight Double close quote.\""
5813 #: build/C/man7/mdoc.7:359
5815 msgid "Li \\&Ql Ta Yes Ta Yes Ta \"Quoted literal.\""
5819 #: build/C/man7/mdoc.7:360
5821 msgid "Li \\&Qo Ta Yes Ta Yes Ta \"Straight Double open quote.\""
5825 #: build/C/man7/mdoc.7:361
5827 msgid "Li \\&Qq Ta Yes Ta Yes Ta \"Straight Double quote.\""
5831 #: build/C/man7/mdoc.7:362
5833 msgid "Li \\&Re Ta \\&No Ta \\&No Ta \"Reference end.\""
5837 #: build/C/man7/mdoc.7:363
5839 msgid "Li \\&Rs Ta \\&No Ta \\&No Ta \"Reference start.\""
5843 #: build/C/man7/mdoc.7:364
5846 "Li \\&Rv Ta \\&No Ta \\&No Ta \"Return values (sections two and three "
5851 #: build/C/man7/mdoc.7:365
5853 msgid "Li \\&Sc Ta Yes Ta Yes Ta \"Single close quote.\""
5857 #: build/C/man7/mdoc.7:366
5859 msgid "Li \\&So Ta Yes Ta Yes Ta \"Single open quote.\""
5863 #: build/C/man7/mdoc.7:367
5865 msgid "Li \\&Sq Ta Yes Ta Yes Ta \"Single quote.\""
5869 #: build/C/man7/mdoc.7:368
5871 msgid "Li \\&Sm Ta \\&No Ta \\&No Ta \"Space mode (default is \\*qon\\*q)\""
5875 #: build/C/man7/mdoc.7:369
5877 msgid "Li \\&Sx Ta Yes Ta Yes Ta \"Section Cross Reference.\""
5881 #: build/C/man7/mdoc.7:370
5883 msgid "Li \\&Sy Ta Yes Ta Yes Ta \"Symbolic (traditional English).\""
5887 #: build/C/man7/mdoc.7:371
5889 msgid "Li \\&Tn Ta Yes Ta Yes Ta \"Trade or type name (small Caps).\""
5893 #: build/C/man7/mdoc.7:372
5895 msgid "Li \\&Ux Ta Yes Ta Yes Ta Ux"
5899 #: build/C/man7/mdoc.7:373
5901 msgid "Li \\&Xc Ta Yes Ta Yes Ta \"Extend argument list close.\""
5905 #: build/C/man7/mdoc.7:374
5907 msgid "Li \\&Xo Ta Yes Ta Yes Ta \"Extend argument list open.\""
5911 #: build/C/man7/mdoc.7:388
5913 "Macro names ending in E<.Ql q> quote remaining items on the argument list. "
5914 "Macro names ending in E<.Ql o> begin a quote which may span more than one "
5915 "line of input and are close quoted with the matching macro name ending in "
5916 "E<.Ql c>. Enclosure macros may be nested and are limited to eight "
5921 #: build/C/man7/mdoc.7:400
5923 "Note: the extended argument list macros E<.Pf ( Ql \\&.Xo>, E<.Ql \\&.Xc>) "
5924 "and the function enclosure macros E<.Pf ( Ql \\&.Fo>, E<.Ql \\&.Fc>) are "
5925 "irregular. The extended list macros are used when the number of macro "
5926 "arguments would exceed the E<.Xr troff> limitation of nine arguments."
5929 #. The following does not apply on Linux:
5930 #. .Sh CONFIGURATION
5931 #. For site specific configuration of the macro package,
5933 #. .Pa /usr/src/share/tmac/README .
5935 #: build/C/man7/mdoc.7:411
5937 "The macros UR (starting a URI/URL hypertext reference), UE (ending one), and "
5938 "UN (identifying a target for a reference) are also available. See E<.Xr man "
5939 "7> for more information on these macros."
5943 #: build/C/man7/mdoc.7:413
5949 #: build/C/man7/mdoc.7:415
5950 msgid "Manual and general text domain macros."
5954 #: build/C/man7/mdoc.7:415
5956 msgid "Pa tmac/doc-common"
5960 #: build/C/man7/mdoc.7:417
5961 msgid "Common structural macros and definitions."
5965 #: build/C/man7/mdoc.7:417
5967 msgid "Pa tmac/doc-nroff"
5971 #: build/C/man7/mdoc.7:421
5972 msgid "Site dependent E<.Xr nroff> style file."
5976 #: build/C/man7/mdoc.7:421
5978 msgid "Pa tmac/doc-ditroff"
5982 #: build/C/man7/mdoc.7:425
5983 msgid "Site dependent E<.Xr troff> style file."
5987 #: build/C/man7/mdoc.7:425
5989 msgid "Pa tmac/doc-syms"
5993 #: build/C/man7/mdoc.7:427
5994 msgid "Special defines (such as the standards macro)."
5998 #: build/C/man7/mdoc.7:433
5999 msgid "E<.Xr groff_mdoc 7>, E<.Xr mdoc.samples 7>, E<.Xr man 7>, E<.Xr man-pages 7>"
6003 #: build/C/man7/mdoc.7:440 build/C/man7/mdoc.samples.7:2964
6005 "This page is part of release 3.64 of the Linux E<.Em man-pages> project. A "
6006 "description of the project, and information about reporting bugs, can be "
6007 "found at \\%http://www.kernel.org/doc/man\\-pages/."
6011 #: build/C/man7/operator.7:40
6017 #: build/C/man7/operator.7:40
6023 #: build/C/man7/operator.7:43
6024 msgid "operator - C operator precedence and order of evaluation"
6028 #: build/C/man7/operator.7:45
6029 msgid "This manual page lists C operators and their precedence in evaluation."
6033 #: build/C/man7/operator.7:63
6036 "B<Operator Associativity>\n"
6037 "() [] -E<gt> . left to right\n"
6038 "! ~ ++ -- + - (type) * & sizeof right to left\n"
6039 "* / % left to right\n"
6040 "+ - left to right\n"
6041 "E<lt>E<lt> E<gt>E<gt> left to right\n"
6042 "E<lt> E<lt>= E<gt> E<gt>= left to right\n"
6043 "== != left to right\n"
6047 "&& left to right\n"
6048 "|| left to right\n"
6049 "?: right to left\n"
6050 "= += -= *= /= %= E<lt>E<lt>= E<gt>E<gt>= &= ^= |= right to left\n"
6055 #: build/C/man7/posixoptions.7:24
6057 msgid "POSIXOPTIONS"
6061 #: build/C/man7/posixoptions.7:24
6067 #: build/C/man7/posixoptions.7:27
6068 msgid "posixoptions - optional parts of the POSIX standard"
6072 #: build/C/man7/posixoptions.7:41
6074 "The POSIX standard (the information below is from POSIX.1-2001) describes a "
6075 "set of behaviors and interfaces for a compliant system. However, many "
6076 "interfaces are optional and there are feature test macros to test the "
6077 "availability of interfaces at compile time, and functions B<sysconf>(3), "
6078 "B<fpathconf>(3), B<pathconf>(3), B<confstr>(3) to do this at run time. "
6079 "From shell scripts one can use B<getconf>(1). For more detail, see "
6084 #: build/C/man7/posixoptions.7:48
6086 "We give the name of the POSIX abbreviation, the option, the name of the "
6087 "B<sysconf>(3) parameter used to inquire about the option, and possibly a "
6088 "very short description. Much more precise detail can be found in the POSIX "
6089 "standard itself, versions of which can nowadays be accessed freely on the "
6094 #: build/C/man7/posixoptions.7:48
6096 msgid "ADV - _POSIX_ADVISORY_INFO - _SC_ADVISORY_INFO"
6100 #: build/C/man7/posixoptions.7:50
6101 msgid "The following advisory functions are present:"
6105 #: build/C/man7/posixoptions.7:58
6108 "I<posix_fadvise>(),\n"
6109 "I<posix_fallocate>(),\n"
6110 "I<posix_memalign>(),\n"
6111 "I<posix_madvise>().\n"
6115 #: build/C/man7/posixoptions.7:61
6117 msgid "AIO - _POSIX_ASYNCHRONOUS_IO - _SC_ASYNCHRONOUS_IO"
6121 #: build/C/man7/posixoptions.7:66
6123 "The header I<E<lt>aio.hE<gt>> is present. The following functions are "
6128 #: build/C/man7/posixoptions.7:78
6131 "I<aio_cancel>(),\n"
6135 "I<aio_return>(),\n"
6136 "I<aio_suspend>(),\n"
6138 "I<lio_listio>().\n"
6142 #: build/C/man7/posixoptions.7:81
6144 msgid "BAR - _POSIX_BARRIERS - _SC_BARRIERS"
6148 #: build/C/man7/posixoptions.7:88 build/C/man7/posixoptions.7:458
6150 "This option implies the B<_POSIX_THREADS> and "
6151 "B<_POSIX_THREAD_SAFE_FUNCTIONS> options. The following functions are "
6156 #: build/C/man7/posixoptions.7:97
6159 "I<pthread_barrier_destroy>(),\n"
6160 "I<pthread_barrier_init>(),\n"
6161 "I<pthread_barrier_wait>(),\n"
6162 "I<pthread_barrierattr_destroy>(),\n"
6163 "I<pthread_barrierattr_init>().\n"
6167 #. Batch environment.
6171 #: build/C/man7/posixoptions.7:104
6173 msgid "--- - POSIX_CHOWN_RESTRICTED"
6176 #. What about lchown() ?
6178 #: build/C/man7/posixoptions.7:112
6180 "If this option is in effect (as it always is under POSIX.1-2001), then only "
6181 "root may change the owner of a file, and nonroot can set the group of a file "
6182 "only to one of the groups it belongs to. This affects the functions "
6183 "I<chown>(), I<fchown>()."
6187 #: build/C/man7/posixoptions.7:112
6189 msgid "CS - _POSIX_CLOCK_SELECTION - _SC_CLOCK_SELECTION"
6193 #: build/C/man7/posixoptions.7:117
6195 "This option implies the B<_POSIX_TIMERS> option. The following functions "
6200 #: build/C/man7/posixoptions.7:124
6203 "I<pthread_condattr_getclock>(),\n"
6204 "I<pthread_condattr_setclock>(),\n"
6205 "I<clock_nanosleep>().\n"
6209 #: build/C/man7/posixoptions.7:132
6211 "If B<CLOCK_REALTIME> is changed by the function I<clock_settime>(), then "
6212 "this affects all timers set for an absolute time."
6216 #: build/C/man7/posixoptions.7:132
6218 msgid "CPT - _POSIX_CPUTIME - _SC_CPUTIME"
6222 #. Fortran development
6226 #: build/C/man7/posixoptions.7:145
6228 "The clockID CLOCK_PROCESS_CPUTIME_ID is supported. The initial value of "
6229 "this clock is 0 for each process. This option implies the B<_POSIX_TIMERS> "
6230 "option. The function I<clock_getcpuclockid>() is present."
6234 #: build/C/man7/posixoptions.7:145
6236 msgid "--- - _POSIX_FILE_LOCKING - _SC_FILE_LOCKING"
6240 #. IEC 60559 Floating-Point Option.
6242 #: build/C/man7/posixoptions.7:148 build/C/man7/posixoptions.7:238
6243 msgid "This option has been deleted. Not in final XPG6."
6247 #: build/C/man7/posixoptions.7:148
6249 msgid "FSC - _POSIX_FSYNC - _SC_FSYNC"
6253 #: build/C/man7/posixoptions.7:152
6254 msgid "The function I<fsync>() is present."
6258 #: build/C/man7/posixoptions.7:152
6260 msgid "IP6 - _POSIX_IPV6 - _SC_IPV6"
6264 #: build/C/man7/posixoptions.7:154
6265 msgid "Internet Protocol Version 6 is supported."
6269 #: build/C/man7/posixoptions.7:154
6271 msgid "--- - _POSIX_JOB_CONTROL - _SC_JOB_CONTROL"
6275 #: build/C/man7/posixoptions.7:158
6277 "If this option is in effect (as it always is under POSIX.1-2001), then the "
6278 "system implements POSIX-style job control, and the following functions are "
6283 #: build/C/man7/posixoptions.7:169
6290 "I<tcsendbreak>(),\n"
6296 #: build/C/man7/posixoptions.7:171
6298 msgid "MF - _POSIX_MAPPED_FILES - _SC_MAPPED_FILES"
6302 #: build/C/man7/posixoptions.7:180
6304 "Shared memory is supported. The include file I<E<lt>sys/mman.hE<gt>> is "
6305 "present. The following functions are present: I<mmap>(), I<msync>(), "
6310 #: build/C/man7/posixoptions.7:180
6312 msgid "ML - _POSIX_MEMLOCK - _SC_MEMLOCK"
6316 #: build/C/man7/posixoptions.7:186
6318 "Shared memory can be locked into core. The functions I<mlockall>(), "
6319 "I<munlockall>() are present."
6323 #: build/C/man7/posixoptions.7:186
6325 msgid "MR/MLR - _POSIX_MEMLOCK_RANGE - _SC_MEMLOCK_RANGE"
6329 #: build/C/man7/posixoptions.7:192
6331 "More precisely, ranges can be locked into core. The functions I<mlock>(), "
6332 "I<munlock>() are present."
6336 #: build/C/man7/posixoptions.7:192
6338 msgid "MPR - _POSIX_MEMORY_PROTECTION - _SC_MEMORY_PROTECTION"
6342 #: build/C/man7/posixoptions.7:196
6343 msgid "The function I<mprotect>() is present."
6347 #: build/C/man7/posixoptions.7:196
6349 msgid "MSG - _POSIX_MESSAGE_PASSING - _SC_MESSAGE_PASSING"
6353 #: build/C/man7/posixoptions.7:201
6355 "The include file I<E<lt>mqueue.hE<gt>> is present. The following functions "
6360 #: build/C/man7/posixoptions.7:213
6364 "I<mq_getattr>(),\n"
6367 "I<mq_receive>(),\n"
6369 "I<mq_setattr>(),\n"
6374 #: build/C/man7/posixoptions.7:216
6376 msgid "MON - _POSIX_MONOTONIC_CLOCK - _SC_MONOTONIC_CLOCK"
6380 #: build/C/man7/posixoptions.7:223
6382 "B<CLOCK_MONOTONIC> is supported. This option implies the B<_POSIX_TIMERS> "
6383 "option. Affected functions are"
6387 #: build/C/man7/posixoptions.7:231
6390 "I<aio_suspend>(),\n"
6391 "I<clock_getres>(),\n"
6392 "I<clock_gettime>(),\n"
6393 "I<clock_settime>(),\n"
6394 "I<timer_create>().\n"
6398 #: build/C/man7/posixoptions.7:233
6400 msgid "--- - _POSIX_MULTI_PROCESS - _SC_MULTI_PROCESS"
6404 #: build/C/man7/posixoptions.7:238
6406 msgid "--- - _POSIX_NO_TRUNC"
6410 #: build/C/man7/posixoptions.7:245
6412 "If this option is in effect (as it always is under POSIX.1-2001) then "
6413 "pathname components longer than B<NAME_MAX> are not truncated, but give an "
6414 "error. This property may be dependent on the path prefix of the component."
6418 #: build/C/man7/posixoptions.7:245
6420 msgid "PIO - _POSIX_PRIORITIZED_IO - _SC_PRIORITIZED_IO"
6424 #: build/C/man7/posixoptions.7:248
6426 "This option says that one can specify priorities for asynchronous I/O. This "
6427 "affects the functions"
6431 #: build/C/man7/posixoptions.7:254
6439 #: build/C/man7/posixoptions.7:256
6441 msgid "PS - _POSIX_PRIORITY_SCHEDULING - _SC_PRIORITY_SCHEDULING"
6445 #: build/C/man7/posixoptions.7:261
6447 "The include file I<E<lt>sched.hE<gt>> is present. The following functions "
6452 #: build/C/man7/posixoptions.7:273
6455 "I<sched_get_priority_max>(),\n"
6456 "I<sched_get_priority_min>(),\n"
6457 "I<sched_getparam>(),\n"
6458 "I<sched_getscheduler>(),\n"
6459 "I<sched_rr_get_interval>(),\n"
6460 "I<sched_setparam>(),\n"
6461 "I<sched_setscheduler>(),\n"
6462 "I<sched_yield>().\n"
6466 #: build/C/man7/posixoptions.7:279
6468 "If also B<_POSIX_SPAWN> is in effect, then the following functions are "
6473 #: build/C/man7/posixoptions.7:287 build/C/man7/posixoptions.7:449
6476 "I<posix_spawnattr_getschedparam>(),\n"
6477 "I<posix_spawnattr_getschedpolicy>(),\n"
6478 "I<posix_spawnattr_setschedparam>(),\n"
6479 "I<posix_spawnattr_setschedpolicy>().\n"
6483 #: build/C/man7/posixoptions.7:289
6485 msgid "RS - _POSIX_RAW_SOCKETS"
6489 #: build/C/man7/posixoptions.7:294
6491 "Raw sockets are supported. Affected functions are I<getsockopt>(), "
6496 #: build/C/man7/posixoptions.7:294
6498 msgid "--- - _POSIX_READER_WRITER_LOCKS - _SC_READER_WRITER_LOCKS"
6502 #: build/C/man7/posixoptions.7:302
6504 "This option implies the B<_POSIX_THREADS> option. Conversely, under "
6505 "POSIX.1-2001 the B<_POSIX_THREADS> option implies this option."
6509 #: build/C/man7/posixoptions.7:304
6511 msgid "The following functions are present:\n"
6515 #: build/C/man7/posixoptions.7:315
6518 "I<pthread_rwlock_destroy>(),\n"
6519 "I<pthread_rwlock_init>(),\n"
6520 "I<pthread_rwlock_rdlock>(),\n"
6521 "I<pthread_rwlock_tryrdlock>(),\n"
6522 "I<pthread_rwlock_trywrlock>(),\n"
6523 "I<pthread_rwlock_unlock>(),\n"
6524 "I<pthread_rwlock_wrlock>(),\n"
6525 "I<pthread_rwlockattr_destroy>(),\n"
6526 "I<pthread_rwlockattr_init>().\n"
6530 #: build/C/man7/posixoptions.7:317
6532 msgid "RTS - _POSIX_REALTIME_SIGNALS - _SC_REALTIME_SIGNALS"
6536 #: build/C/man7/posixoptions.7:320
6537 msgid "Realtime signals are supported. The following functions are present:"
6541 #: build/C/man7/posixoptions.7:327
6545 "I<sigtimedwait>(),\n"
6546 "I<sigwaitinfo>().\n"
6550 #: build/C/man7/posixoptions.7:330
6552 msgid "--- - _POSIX_REGEXP - _SC_REGEXP"
6556 #: build/C/man7/posixoptions.7:334
6558 "If this option is in effect (as it always is under POSIX.1-2001) then POSIX "
6559 "regular expressions are supported and the following functions are present:"
6563 #: build/C/man7/posixoptions.7:342
6573 #: build/C/man7/posixoptions.7:345
6575 msgid "--- - _POSIX_SAVED_IDS - _SC_SAVED_IDS"
6579 #: build/C/man7/posixoptions.7:349
6581 "If this option is in effect (as it always is under POSIX.1-2001), then a "
6582 "process has a saved set-user-ID and a saved set-group-ID. Affected "
6587 #: build/C/man7/posixoptions.7:359
6599 #. Software development
6601 #: build/C/man7/posixoptions.7:364
6603 msgid "SEM - _POSIX_SEMAPHORES - _SC_SEMAPHORES"
6607 #: build/C/man7/posixoptions.7:369
6609 "The include file I<E<lt>semaphore.hE<gt>> is present. The following "
6610 "functions are present:"
6614 #: build/C/man7/posixoptions.7:382
6618 "I<sem_destroy>(),\n"
6619 "I<sem_getvalue>(),\n"
6623 "I<sem_trywait>(),\n"
6624 "I<sem_unlink>(),\n"
6629 #: build/C/man7/posixoptions.7:385
6631 msgid "SHM - _POSIX_SHARED_MEMORY_OBJECTS - _SC_SHARED_MEMORY_OBJECTS"
6635 #: build/C/man7/posixoptions.7:387 build/C/man7/posixoptions.7:703 build/C/man7/posixoptions.7:719 build/C/man7/posixoptions.7:833
6636 msgid "The following functions are present:"
6640 #: build/C/man7/posixoptions.7:395
6646 "I<shm_unlink>().\n"
6650 #: build/C/man7/posixoptions.7:398
6652 msgid "--- - _POSIX_SHELL - _SC_SHELL"
6656 #: build/C/man7/posixoptions.7:403
6658 "If this option is in effect (as it always is under POSIX.1-2001), the "
6659 "function I<system>() is present."
6663 #: build/C/man7/posixoptions.7:403
6665 msgid "SPN - _POSIX_SPAWN - _SC_SPAWN"
6669 #: build/C/man7/posixoptions.7:413
6671 "This option describes support for process creation in a context where it is "
6672 "difficult or impossible to use I<fork>(), for example, because no MMU is "
6673 "present. If B<_POSIX_SPAWN> is in effect, then the include file "
6674 "I<E<lt>spawn.hE<gt>> and the following functions are present:"
6678 #: build/C/man7/posixoptions.7:434
6681 "I<posix_spawn>(),\n"
6682 "I<posix_spawn_file_actions_addclose>(),\n"
6683 "I<posix_spawn_file_actions_adddup2>(),\n"
6684 "I<posix_spawn_file_actions_addopen>(),\n"
6685 "I<posix_spawn_file_actions_destroy>(),\n"
6686 "I<posix_spawn_file_actions_init>(),\n"
6687 "I<posix_spawnattr_destroy>(),\n"
6688 "I<posix_spawnattr_getsigdefault>(),\n"
6689 "I<posix_spawnattr_getflags>(),\n"
6690 "I<posix_spawnattr_getpgroup>(),\n"
6691 "I<posix_spawnattr_getsigmask>(),\n"
6692 "I<posix_spawnattr_init>(),\n"
6693 "I<posix_spawnattr_setsigdefault>(),\n"
6694 "I<posix_spawnattr_setflags>(),\n"
6695 "I<posix_spawnattr_setpgroup>(),\n"
6696 "I<posix_spawnattr_setsigmask>(),\n"
6697 "I<posix_spawnp>().\n"
6701 #: build/C/man7/posixoptions.7:441
6703 "If also B<_POSIX_PRIORITY_SCHEDULING> is in effect, then the following "
6704 "functions are present:"
6708 #: build/C/man7/posixoptions.7:451
6710 msgid "SPI - _POSIX_SPIN_LOCKS - _SC_SPIN_LOCKS"
6714 #: build/C/man7/posixoptions.7:467
6717 "I<pthread_spin_destroy>(),\n"
6718 "I<pthread_spin_init>(),\n"
6719 "I<pthread_spin_lock>(),\n"
6720 "I<pthread_spin_trylock>(),\n"
6721 "I<pthread_spin_unlock>().\n"
6725 #: build/C/man7/posixoptions.7:470
6727 msgid "SS - _POSIX_SPORADIC_SERVER - _SC_SPORADIC_SERVER"
6731 #: build/C/man7/posixoptions.7:478
6733 "The scheduling policy B<SCHED_SPORADIC> is supported. This option implies "
6734 "the B<_POSIX_PRIORITY_SCHEDULING> option. Affected functions are"
6738 #: build/C/man7/posixoptions.7:484
6741 "I<sched_setparam>(),\n"
6742 "I<sched_setscheduler>().\n"
6746 #: build/C/man7/posixoptions.7:487
6748 msgid "SIO - _POSIX_SYNCHRONIZED_IO - _SC_SYNCHRONIZED_IO"
6752 #: build/C/man7/posixoptions.7:493
6753 msgid "Affected functions are I<open>(), I<msync>(), I<fsync>(), I<fdatasync>()."
6757 #: build/C/man7/posixoptions.7:493
6759 msgid "TSA - _POSIX_THREAD_ATTR_STACKADDR - _SC_THREAD_ATTR_STACKADDR"
6763 #: 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
6764 msgid "Affected functions are"
6768 #: build/C/man7/posixoptions.7:503
6771 "I<pthread_attr_getstack>(),\n"
6772 "I<pthread_attr_getstackaddr>(),\n"
6773 "I<pthread_attr_setstack>(),\n"
6774 "I<pthread_attr_setstackaddr>().\n"
6778 #: build/C/man7/posixoptions.7:506
6780 msgid "TSS - _POSIX_THREAD_ATTR_STACKSIZE - _SC_THREAD_ATTR_STACKSIZE"
6784 #: build/C/man7/posixoptions.7:516
6787 "I<pthread_attr_getstack>(),\n"
6788 "I<pthread_attr_getstacksize>(),\n"
6789 "I<pthread_attr_setstack>(),\n"
6790 "I<pthread_attr_setstacksize>().\n"
6794 #: build/C/man7/posixoptions.7:519
6796 msgid "TCT - _POSIX_THREAD_CPUTIME - _SC_THREAD_CPUTIME"
6800 #: build/C/man7/posixoptions.7:525
6802 "The clockID CLOCK_THREAD_CPUTIME_ID is supported. This option implies the "
6803 "B<_POSIX_TIMERS> option. Affected functions are"
6807 #: build/C/man7/posixoptions.7:534
6810 "I<pthread_getcpuclockid>(),\n"
6811 "I<clock_getres>(),\n"
6812 "I<clock_gettime>(),\n"
6813 "I<clock_settime>(),\n"
6814 "I<timer_create>().\n"
6818 #: build/C/man7/posixoptions.7:537
6820 msgid "TPI - _POSIX_THREAD_PRIO_INHERIT - _SC_THREAD_PRIO_INHERIT"
6824 #: build/C/man7/posixoptions.7:545
6827 "I<pthread_mutexattr_getprotocol>(),\n"
6828 "I<pthread_mutexattr_setprotocol>().\n"
6832 #: build/C/man7/posixoptions.7:548
6834 msgid "TPP - _POSIX_THREAD_PRIO_PROTECT - _SC_THREAD_PRIO_PROTECT"
6838 #: build/C/man7/posixoptions.7:560
6841 "I<pthread_mutex_getprioceiling>(),\n"
6842 "I<pthread_mutex_setprioceiling>(),\n"
6843 "I<pthread_mutexattr_getprioceiling>(),\n"
6844 "I<pthread_mutexattr_getprotocol>(),\n"
6845 "I<pthread_mutexattr_setprioceiling>(),\n"
6846 "I<pthread_mutexattr_setprotocol>().\n"
6850 #: build/C/man7/posixoptions.7:563
6852 msgid "TPS - _POSIX_THREAD_PRIORITY_SCHEDULING - _SC_THREAD_PRIORITY_SCHEDULING"
6856 #: build/C/man7/posixoptions.7:567
6858 "If this option is in effect, the different threads inside a process can run "
6859 "with different priorities and/or different schedulers. Affected functions "
6864 #: build/C/man7/posixoptions.7:580
6867 "I<pthread_attr_getinheritsched>(),\n"
6868 "I<pthread_attr_getschedpolicy>(),\n"
6869 "I<pthread_attr_getscope>(),\n"
6870 "I<pthread_attr_setinheritsched>(),\n"
6871 "I<pthread_attr_setschedpolicy>(),\n"
6872 "I<pthread_attr_setscope>(),\n"
6873 "I<pthread_getschedparam>(),\n"
6874 "I<pthread_setschedparam>(),\n"
6875 "I<pthread_setschedprio>().\n"
6879 #: build/C/man7/posixoptions.7:583
6881 msgid "TSH - _POSIX_THREAD_PROCESS_SHARED - _SC_THREAD_PROCESS_SHARED"
6885 #: build/C/man7/posixoptions.7:597
6888 "I<pthread_barrierattr_getpshared>(),\n"
6889 "I<pthread_barrierattr_setpshared>(),\n"
6890 "I<pthread_condattr_getpshared>(),\n"
6891 "I<pthread_condattr_setpshared>(),\n"
6892 "I<pthread_mutexattr_getpshared>(),\n"
6893 "I<pthread_mutexattr_setpshared>(),\n"
6894 "I<pthread_rwlockattr_getpshared>(),\n"
6895 "I<pthread_rwlockattr_setpshared>().\n"
6899 #: build/C/man7/posixoptions.7:600
6901 msgid "TSF - _POSIX_THREAD_SAFE_FUNCTIONS - _SC_THREAD_SAFE_FUNCTIONS"
6905 #: build/C/man7/posixoptions.7:625
6909 "I<getgrgid_r>(),\n"
6910 "I<getgrnam_r>(),\n"
6911 "I<getpwnam_r>(),\n"
6912 "I<getpwuid_r>(),\n"
6914 "I<ftrylockfile>(),\n"
6915 "I<funlockfile>(),\n"
6916 "I<getc_unlocked>(),\n"
6917 "I<getchar_unlocked>(),\n"
6918 "I<putc_unlocked>(),\n"
6919 "I<putchar_unlocked>(),\n"
6921 "I<strerror_r>(),\n"
6926 "I<localtime_r>().\n"
6930 #: build/C/man7/posixoptions.7:628
6932 msgid "TSP - _POSIX_THREAD_SPORADIC_SERVER - _SC_THREAD_SPORADIC_SERVER"
6936 #: build/C/man7/posixoptions.7:633
6938 "This option implies the B<_POSIX_THREAD_PRIORITY_SCHEDULING> option. "
6939 "Affected functions are"
6943 #: build/C/man7/posixoptions.7:640
6946 "I<sched_getparam>(),\n"
6947 "I<sched_setparam>(),\n"
6948 "I<sched_setscheduler>().\n"
6952 #: build/C/man7/posixoptions.7:643
6954 msgid "THR - _POSIX_THREADS - _SC_THREADS"
6958 #: build/C/man7/posixoptions.7:646
6960 "Basic support for POSIX threads is available. The following functions are "
6965 #: build/C/man7/posixoptions.7:698
6968 "I<pthread_atfork>(),\n"
6969 "I<pthread_attr_destroy>(),\n"
6970 "I<pthread_attr_getdetachstate>(),\n"
6971 "I<pthread_attr_getschedparam>(),\n"
6972 "I<pthread_attr_init>(),\n"
6973 "I<pthread_attr_setdetachstate>(),\n"
6974 "I<pthread_attr_setschedparam>(),\n"
6975 "I<pthread_cancel>(),\n"
6976 "I<pthread_cleanup_push>(),\n"
6977 "I<pthread_cleanup_pop>(),\n"
6978 "I<pthread_cond_broadcast>(),\n"
6979 "I<pthread_cond_destroy>(),\n"
6980 "I<pthread_cond_init>(),\n"
6981 "I<pthread_cond_signal>(),\n"
6982 "I<pthread_cond_timedwait>(),\n"
6983 "I<pthread_cond_wait>(),\n"
6984 "I<pthread_condattr_destroy>(),\n"
6985 "I<pthread_condattr_init>(),\n"
6986 "I<pthread_create>(),\n"
6987 "I<pthread_detach>(),\n"
6988 "I<pthread_equal>(),\n"
6989 "I<pthread_exit>(),\n"
6990 "I<pthread_getspecific>(),\n"
6991 "I<pthread_join>(),\n"
6992 "I<pthread_key_create>(),\n"
6993 "I<pthread_key_delete>(),\n"
6994 "I<pthread_mutex_destroy>(),\n"
6995 "I<pthread_mutex_init>(),\n"
6996 "I<pthread_mutex_lock>(),\n"
6997 "I<pthread_mutex_trylock>(),\n"
6998 "I<pthread_mutex_unlock>(),\n"
6999 "I<pthread_mutexattr_destroy>(),\n"
7000 "I<pthread_mutexattr_init>(),\n"
7001 "I<pthread_once>(),\n"
7002 "I<pthread_rwlock_destroy>(),\n"
7003 "I<pthread_rwlock_init>(),\n"
7004 "I<pthread_rwlock_rdlock>(),\n"
7005 "I<pthread_rwlock_tryrdlock>(),\n"
7006 "I<pthread_rwlock_trywrlock>(),\n"
7007 "I<pthread_rwlock_unlock>(),\n"
7008 "I<pthread_rwlock_wrlock>(),\n"
7009 "I<pthread_rwlockattr_destroy>(),\n"
7010 "I<pthread_rwlockattr_init>(),\n"
7011 "I<pthread_self>(),\n"
7012 "I<pthread_setcancelstate>(),\n"
7013 "I<pthread_setcanceltype>(),\n"
7014 "I<pthread_setspecific>(),\n"
7015 "I<pthread_testcancel>().\n"
7019 #: build/C/man7/posixoptions.7:701
7021 msgid "TMO - _POSIX_TIMEOUTS - _SC_TIMEOUTS"
7025 #: build/C/man7/posixoptions.7:714
7028 "I<mq_timedreceive>(),\n"
7029 "I<mq_timedsend>(),\n"
7030 "I<pthread_mutex_timedlock>(),\n"
7031 "I<pthread_rwlock_timedrdlock>(),\n"
7032 "I<pthread_rwlock_timedwrlock>(),\n"
7033 "I<sem_timedwait>(),\n"
7034 "I<posix_trace_timedgetnext_event>().\n"
7038 #: build/C/man7/posixoptions.7:717
7040 msgid "TMR - _POSIX_TIMERS - _SC_TIMERS"
7044 #: build/C/man7/posixoptions.7:732
7047 "I<clock_getres>(),\n"
7048 "I<clock_gettime>(),\n"
7049 "I<clock_settime>(),\n"
7051 "I<timer_create>(),\n"
7052 "I<timer_delete>(),\n"
7053 "I<timer_gettime>(),\n"
7054 "I<timer_getoverrun>(),\n"
7055 "I<timer_settime>().\n"
7059 #: build/C/man7/posixoptions.7:735
7061 msgid "TRC - _POSIX_TRACE - _SC_TRACE"
7065 #: build/C/man7/posixoptions.7:738
7066 msgid "POSIX tracing is available. The following functions are present:"
7070 #: build/C/man7/posixoptions.7:773
7073 "I<posix_trace_attr_destroy>(),\n"
7074 "I<posix_trace_attr_getclockres>(),\n"
7075 "I<posix_trace_attr_getcreatetime>(),\n"
7076 "I<posix_trace_attr_getgenversion>(),\n"
7077 "I<posix_trace_attr_getmaxdatasize>(),\n"
7078 "I<posix_trace_attr_getmaxsystemeventsize>(),\n"
7079 "I<posix_trace_attr_getmaxusereventsize>(),\n"
7080 "I<posix_trace_attr_getname>(),\n"
7081 "I<posix_trace_attr_getstreamfullpolicy>(),\n"
7082 "I<posix_trace_attr_getstreamsize>(),\n"
7083 "I<posix_trace_attr_init>(),\n"
7084 "I<posix_trace_attr_setmaxdatasize>(),\n"
7085 "I<posix_trace_attr_setname>(),\n"
7086 "I<posix_trace_attr_setstreamsize>(),\n"
7087 "I<posix_trace_attr_setstreamfullpolicy>(),\n"
7088 "I<posix_trace_clear>(),\n"
7089 "I<posix_trace_create>(),\n"
7090 "I<posix_trace_event>(),\n"
7091 "I<posix_trace_eventid_equal>(),\n"
7092 "I<posix_trace_eventid_get_name>(),\n"
7093 "I<posix_trace_eventid_open>(),\n"
7094 "I<posix_trace_eventtypelist_getnext_id>(),\n"
7095 "I<posix_trace_eventtypelist_rewind>(),\n"
7096 "I<posix_trace_flush>(),\n"
7097 "I<posix_trace_get_attr>(),\n"
7098 "I<posix_trace_get_status>(),\n"
7099 "I<posix_trace_getnext_event>(),\n"
7100 "I<posix_trace_shutdown>(),\n"
7101 "I<posix_trace_start>(),\n"
7102 "I<posix_trace_stop>(),\n"
7103 "I<posix_trace_trygetnext_event>().\n"
7107 #: build/C/man7/posixoptions.7:776
7109 msgid "TEF - _POSIX_TRACE_EVENT_FILTER - _SC_TRACE_EVENT_FILTER"
7113 #: build/C/man7/posixoptions.7:781 build/C/man7/posixoptions.7:816
7115 "This option implies the B<_POSIX_TRACE> option. The following functions are "
7120 #: build/C/man7/posixoptions.7:793
7123 "I<posix_trace_eventset_add>(),\n"
7124 "I<posix_trace_eventset_del>(),\n"
7125 "I<posix_trace_eventset_empty>(),\n"
7126 "I<posix_trace_eventset_fill>(),\n"
7127 "I<posix_trace_eventset_ismember>(),\n"
7128 "I<posix_trace_get_filter>(),\n"
7129 "I<posix_trace_set_filter>(),\n"
7130 "I<posix_trace_trid_eventid_open>().\n"
7134 #: build/C/man7/posixoptions.7:796
7136 msgid "TRI - _POSIX_TRACE_INHERIT - _SC_TRACE_INHERIT"
7140 #: build/C/man7/posixoptions.7:802
7142 "Tracing children of the traced process is supported. This option implies "
7143 "the B<_POSIX_TRACE> option. The following functions are present:"
7147 #: build/C/man7/posixoptions.7:808
7150 "I<posix_trace_attr_getinherited>(),\n"
7151 "I<posix_trace_attr_setinherited>().\n"
7155 #: build/C/man7/posixoptions.7:811
7157 msgid "TRL - _POSIX_TRACE_LOG - _SC_TRACE_LOG"
7161 #: build/C/man7/posixoptions.7:828
7164 "I<posix_trace_attr_getlogfullpolicy>(),\n"
7165 "I<posix_trace_attr_getlogsize>(),\n"
7166 "I<posix_trace_attr_setlogfullpolicy>(),\n"
7167 "I<posix_trace_attr_setlogsize>(),\n"
7168 "I<posix_trace_close>(),\n"
7169 "I<posix_trace_create_withlog>(),\n"
7170 "I<posix_trace_open>(),\n"
7171 "I<posix_trace_rewind>().\n"
7175 #: build/C/man7/posixoptions.7:831
7177 msgid "TYM - _POSIX_TYPED_MEMORY_OBJECTS - _SC_TYPED_MEMORY_OBJECT"
7181 #: build/C/man7/posixoptions.7:840
7184 "I<posix_mem_offset>(),\n"
7185 "I<posix_typed_mem_get_info>(),\n"
7186 "I<posix_typed_mem_open>().\n"
7190 #: build/C/man7/posixoptions.7:843
7192 msgid "--- - _POSIX_VDISABLE"
7196 #: build/C/man7/posixoptions.7:847
7198 "Always present (probably 0). Value to set a changeable special control "
7199 "character to indicate that it is disabled."
7203 #: build/C/man7/posixoptions.7:847
7205 msgid "XOPEN EXTENSIONS"
7210 #: build/C/man7/posixoptions.7:854
7212 "B<_XOPEN_CRYPT>, B<_XOPEN_LEGACY>, B<_XOPEN_REALTIME>, "
7213 "B<_XOPEN_REALTIME_THREADS>, B<_XOPEN_UNIX>."
7217 #: build/C/man7/posixoptions.7:857
7218 msgid "B<sysconf>(3), B<standards>(7)"
7222 #: build/C/man5/proc.5:62
7228 #: build/C/man5/proc.5:62
7234 #: build/C/man5/proc.5:65
7235 msgid "proc - process information pseudo-filesystem"
7239 #: build/C/man5/proc.5:74
7241 "The I<proc> filesystem is a pseudo-filesystem which provides an interface to "
7242 "kernel data structures. It is commonly mounted at I</proc>. Most of it is "
7243 "read-only, but some files allow kernel variables to be changed."
7247 #: build/C/man5/proc.5:78
7249 "The following list describes many of the files and directories under the "
7250 "I</proc> hierarchy."
7254 #: build/C/man5/proc.5:79
7256 msgid "I</proc/[pid]>"
7259 #. FIXME Describe /proc/[pid]/attr and
7260 #. /proc/[pid]/task/[tid]/attr
7261 #. This is a directory
7265 #: build/C/man5/proc.5:91
7267 "There is a numerical subdirectory for each running process; the subdirectory "
7268 "is named by the process ID. Each such subdirectory contains the following "
7269 "pseudo-files and directories."
7273 #: build/C/man5/proc.5:91
7275 msgid "I</proc/[pid]/auxv> (since 2.6.0-test7)"
7279 #: build/C/man5/proc.5:98
7281 "This contains the contents of the ELF interpreter information passed to the "
7282 "process at exec time. The format is one I<unsigned long> ID plus one "
7283 "I<unsigned long> value for each entry. The last entry contains two zeros."
7287 #: build/C/man5/proc.5:98
7289 msgid "I</proc/[pid]/cgroup> (since Linux 2.6.24)"
7292 #. Info in Documentation/cgroups/cgroups.txt
7294 #: build/C/man5/proc.5:104
7296 "This file describes control groups to which the process/task belongs. For "
7297 "each cgroup hierarchy there is one entry containing colon-separated fields "
7302 #: build/C/man5/proc.5:108
7304 msgid "CW< 5:cpuacct,cpu,cpuset:/daemons>\n"
7308 #: build/C/man5/proc.5:112
7309 msgid "The colon-separated fields are, from left to right:"
7313 #: build/C/man5/proc.5:113
7319 #: build/C/man5/proc.5:115
7320 msgid "hierarchy ID number"
7324 #: build/C/man5/proc.5:115
7330 #: build/C/man5/proc.5:117
7331 msgid "set of subsystems bound to the hierarchy"
7335 #: build/C/man5/proc.5:117
7341 #: build/C/man5/proc.5:119
7342 msgid "control group in the hierarchy to which the process belongs"
7346 #. FIXME Describe /proc/[pid]/clear_refs
7348 #. "Clears page referenced bits shown in smaps output"
7350 #. CONFIG_PROC_PAGE_MONITOR
7352 #: build/C/man5/proc.5:130
7354 "This file is present only if the B<CONFIG_CGROUPS> kernel configuration "
7355 "option is enabled."
7359 #: build/C/man5/proc.5:130
7361 msgid "I</proc/[pid]/cmdline>"
7364 #. In 2.3.26, this also used to be true if the process was swapped out.
7366 #: build/C/man5/proc.5:140
7368 "This holds the complete command line for the process, unless the process is "
7369 "a zombie. In the latter case, there is nothing in this file: that is, a "
7370 "read on this file will return 0 characters. The command-line arguments "
7371 "appear in this file as a set of strings separated by null bytes "
7372 "(\\(aq\\e0\\(aq), with a further null byte after the last string."
7376 #: build/C/man5/proc.5:140
7378 msgid "I</proc/[pid]/coredump_filter> (since kernel 2.6.23)"
7382 #: build/C/man5/proc.5:144 build/C/man5/proc.5:2891 build/C/man5/proc.5:2895
7383 msgid "See B<core>(5)."
7387 #: build/C/man5/proc.5:144
7389 msgid "I</proc/[pid]/cpuset> (since kernel 2.6.12)"
7392 #. and/proc/[pid]/task/[tid]/cpuset
7394 #: build/C/man5/proc.5:149
7395 msgid "See B<cpuset>(7)."
7399 #: build/C/man5/proc.5:149
7401 msgid "I</proc/[pid]/cwd>"
7405 #: build/C/man5/proc.5:154
7407 "This is a symbolic link to the current working directory of the process. To "
7408 "find out the current working directory of process 20, for instance, you can "
7413 #: build/C/man5/proc.5:158
7415 msgid "$B< cd /proc/20/cwd; /bin/pwd>\n"
7419 #: build/C/man5/proc.5:169
7421 "Note that the I<pwd> command is often a shell built-in, and might not work "
7422 "properly. In B<bash>(1), you may use I<pwd\\ -P>."
7425 #. The following was still true as at kernel 2.6.13
7426 #. FIXME Describe /proc/[pid]/seccomp
7428 #. FIXME Describe /proc/[pid]/sessionid
7429 #. Added in 2.6.25; read-only; only readable by real UID
7430 #. CONFIG_AUDITSYSCALL
7431 #. FIXME Describe /proc/[pid]/sched
7433 #. CONFIG_SCHED_DEBUG, and additional fields if CONFIG_SCHEDSTATS
7434 #. Displays various scheduling parameters
7435 #. This file can be written, to reset stats
7436 #. FIXME Describe /proc/[pid]/schedstats and
7437 #. /proc/[pid]/task/[tid]/schedstats
7439 #. CONFIG_SCHEDSTATS
7441 #: build/C/man5/proc.5:175 build/C/man5/proc.5:970
7443 "In a multithreaded process, the contents of this symbolic link are not "
7444 "available if the main thread has already terminated (typically by calling "
7445 "B<pthread_exit>(3))."
7449 #: build/C/man5/proc.5:175
7451 msgid "I</proc/[pid]/environ>"
7455 #: build/C/man5/proc.5:181
7457 "This file contains the environment for the process. The entries are "
7458 "separated by null bytes (\\(aq\\e0\\(aq), and there may be a null byte at "
7459 "the end. Thus, to print out the environment of process 1, you would do:"
7463 #: build/C/man5/proc.5:186
7465 msgid "$B< strings /proc/1/environ>\n"
7469 #: build/C/man5/proc.5:189
7471 msgid "I</proc/[pid]/exe>"
7474 #. The following was still true as at kernel 2.6.13
7476 #: build/C/man5/proc.5:204
7478 "Under Linux 2.2 and later, this file is a symbolic link containing the "
7479 "actual pathname of the executed command. This symbolic link can be "
7480 "dereferenced normally; attempting to open it will open the executable. You "
7481 "can even type I</proc/[pid]/exe> to run another copy of the same executable "
7482 "as is being run by process [pid]. In a multithreaded process, the contents "
7483 "of this symbolic link are not available if the main thread has already "
7484 "terminated (typically by calling B<pthread_exit>(3))."
7488 #: build/C/man5/proc.5:212
7490 "Under Linux 2.0 and earlier I</proc/[pid]/exe> is a pointer to the binary "
7491 "which was executed, and appears as a symbolic link. A B<readlink>(2) call "
7492 "on this file under Linux 2.0 returns a string in the format:"
7496 #: build/C/man5/proc.5:214
7498 msgid " [device]:inode\n"
7502 #: build/C/man5/proc.5:217
7504 "For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, MFM, "
7505 "etc. drives) minor 01 (first partition on the first drive)."
7509 #: build/C/man5/proc.5:222
7510 msgid "B<find>(1) with the I<-inum> option can be used to locate the file."
7514 #: build/C/man5/proc.5:222
7516 msgid "I</proc/[pid]/fd/>"
7520 #: build/C/man5/proc.5:228
7522 "This is a subdirectory containing one entry for each file which the process "
7523 "has open, named by its file descriptor, and which is a symbolic link to the "
7524 "actual file. Thus, 0 is standard input, 1 standard output, 2 standard "
7529 #: build/C/man5/proc.5:235
7531 "For file descriptors for pipes and sockets, the entries will be symbolic "
7532 "links whose content is the file type with the inode. A B<readlink>(2) call "
7533 "on this file returns a string in the format:"
7537 #: build/C/man5/proc.5:237
7539 msgid " type:[inode]\n"
7543 #: build/C/man5/proc.5:244
7545 "For example, I<socket:[2248868]> will be a socket and its inode is 2248868. "
7546 "For sockets, that inode can be used to find more information in one of the "
7547 "files under I</proc/net/>."
7551 #: build/C/man5/proc.5:254
7553 "For file descriptors that have no corresponding inode (e.g., file "
7554 "descriptors produced by B<epoll_create>(2), B<eventfd>(2), "
7555 "B<inotify_init>(2), B<signalfd>(2), and B<timerfd>(2)), the entry will be a "
7556 "symbolic link with contents of the form"
7560 #: build/C/man5/proc.5:256
7562 msgid " anon_inode:E<lt>file-typeE<gt>\n"
7566 #: build/C/man5/proc.5:260
7567 msgid "In some cases, the I<file-type> is surrounded by square brackets."
7571 #: build/C/man5/proc.5:264
7573 "For example, an epoll file descriptor will have a symbolic link whose "
7574 "content is the string I<anon_inode:[eventpoll]>."
7577 #. The following was still true as at kernel 2.6.13
7579 #: build/C/man5/proc.5:270
7581 "In a multithreaded process, the contents of this directory are not available "
7582 "if the main thread has already terminated (typically by calling "
7583 "B<pthread_exit>(3))."
7587 #: build/C/man5/proc.5:283
7589 "Programs that will take a filename as a command-line argument, but will not "
7590 "take input from standard input if no argument is supplied, or that write to "
7591 "a file named as a command-line argument, but will not send their output to "
7592 "standard output if no argument is supplied, can nevertheless be made to use "
7593 "standard input or standard out using I</proc/[pid]/fd>. For example, "
7594 "assuming that I<-i> is the flag designating an input file and I<-o> is the "
7595 "flag designating an output file:"
7599 #: build/C/man5/proc.5:287
7601 msgid "$B< foobar -i /proc/self/fd/0 -o /proc/self/fd/1 ...>\n"
7604 #. The following is not true in my tests (MTK):
7605 #. Note that this will not work for
7606 #. programs that seek on their files, as the files in the fd directory
7607 #. are not seekable.
7609 #: build/C/man5/proc.5:295
7610 msgid "and you have a working filter."
7614 #: build/C/man5/proc.5:305
7616 "I</proc/self/fd/N> is approximately the same as I</dev/fd/N> in some UNIX "
7617 "and UNIX-like systems. Most Linux MAKEDEV scripts symbolically link "
7618 "I</dev/fd> to I</proc/self/fd>, in fact."
7622 #: build/C/man5/proc.5:319
7624 "Most systems provide symbolic links I</dev/stdin>, I</dev/stdout>, and "
7625 "I</dev/stderr>, which respectively link to the files I<0>, I<1>, and I<2> in "
7626 "I</proc/self/fd>. Thus the example command above could be written as:"
7630 #: build/C/man5/proc.5:323
7632 msgid "$B< foobar -i /dev/stdin -o /dev/stdout ...>\n"
7636 #: build/C/man5/proc.5:328
7638 msgid "I</proc/[pid]/fdinfo/> (since kernel 2.6.22)"
7642 #: build/C/man5/proc.5:334
7644 "This is a subdirectory containing one entry for each file which the process "
7645 "has open, named by its file descriptor. The contents of each file can be "
7646 "read to obtain information about the corresponding file descriptor, for "
7651 #: build/C/man5/proc.5:340
7654 "$B< cat /proc/12015/fdinfo/4>\n"
7660 #: build/C/man5/proc.5:351
7662 "The I<pos> field is a decimal number showing the current file offset. The "
7663 "I<flags> field is an octal number that displays the file access mode and "
7664 "file status flags (see B<open>(2))."
7668 #. Certain file types include additional info; see
7669 #. Documentation/filesystems/proc.txt
7671 #. Especially interesting is this:
7673 #. commit ab49bdecc3ebb46ab661f5f05d5c5ea9606406c6
7674 #. Author: Cyrill Gorcunov <gorcunov@openvz.org>
7675 #. Date: Mon Dec 17 16:05:06 2012 -0800
7677 #. Basically, the /proc/PID/fdinfo/ entry for an inotify FD
7678 #. includes the file handles for all watched FDs
7680 #: build/C/man5/proc.5:366
7681 msgid "The files in this directory are readable only by the owner of the process."
7685 #: build/C/man5/proc.5:366
7687 msgid "I</proc/[pid]/io> (since kernel 2.6.20)"
7690 #. commit 7c3ab7381e79dfc7db14a67c6f4f3285664e1ec2
7692 #: build/C/man5/proc.5:370
7693 msgid "This file contains I/O statistics for the process, for example:"
7697 #: build/C/man5/proc.5:381
7700 "#B< cat /proc/3828/io>\n"
7701 "rchar: 323934931\n"
7702 "wchar: 323929600\n"
7706 "write_bytes: 323932160\n"
7707 "cancelled_write_bytes: 0\n"
7711 #: build/C/man5/proc.5:385 build/C/man5/proc.5:1329
7712 msgid "The fields are as follows:"
7716 #: build/C/man5/proc.5:386
7718 msgid "I<rchar>: characters read"
7722 #: build/C/man5/proc.5:396
7724 "The number of bytes which this task has caused to be read from storage. "
7725 "This is simply the sum of bytes which this process passed to B<read>(2) and "
7726 "similar system calls. It includes things such as terminal I/O and is "
7727 "unaffected by whether or not actual physical disk I/O was required (the read "
7728 "might have been satisfied from pagecache)."
7732 #: build/C/man5/proc.5:396
7734 msgid "I<wchar>: characters written"
7738 #: build/C/man5/proc.5:402
7740 "The number of bytes which this task has caused, or shall cause to be written "
7741 "to disk. Similar caveats apply here as with I<rchar>."
7745 #: build/C/man5/proc.5:402
7747 msgid "I<syscr>: read syscalls"
7751 #: build/C/man5/proc.5:409
7753 "Attempt to count the number of read I/O operations\\(emthat is, system calls "
7754 "such as B<read>(2) and B<pread>(2)."
7758 #: build/C/man5/proc.5:409
7760 msgid "I<syscw>: write syscalls"
7764 #: build/C/man5/proc.5:416
7766 "Attempt to count the number of write I/O operations\\(emthat is, system "
7767 "calls such as B<write>(2) and B<pwrite>(2)."
7771 #: build/C/man5/proc.5:416
7773 msgid "I<read_bytes>: bytes read"
7777 #: build/C/man5/proc.5:421
7779 "Attempt to count the number of bytes which this process really did cause to "
7780 "be fetched from the storage layer. This is accurate for block-backed "
7785 #: build/C/man5/proc.5:421
7787 msgid "I<write_bytes>: bytes written"
7791 #: build/C/man5/proc.5:425
7793 "Attempt to count the number of bytes which this process caused to be sent to "
7794 "the storage layer."
7798 #: build/C/man5/proc.5:425
7800 msgid "I<cancelled_write_bytes>:"
7804 #: build/C/man5/proc.5:439
7806 "The big inaccuracy here is truncate. If a process writes 1MB to a file and "
7807 "then deletes the file, it will in fact perform no writeout. But it will "
7808 "have been accounted as having caused 1MB of write. In other words: this "
7809 "field represents the number of bytes which this process caused to not "
7810 "happen, by truncating pagecache. A task can cause \"negative\" I/O too. If "
7811 "this task truncates some dirty pagecache, some I/O which another task has "
7812 "been accounted for (in its I<write_bytes>) will not be happening."
7816 #: build/C/man5/proc.5:447
7818 "I<Note>: In the current implementation, things are a bit racy on 32-bit "
7819 "systems: if process A reads process B's I</proc/[pid]/io> while process B is "
7820 "updating one of these 64-bit counters, process A could see an intermediate "
7825 #: build/C/man5/proc.5:447
7827 msgid "I</proc/[pid]/limits> (since kernel 2.6.24)"
7830 #. commit 3036e7b490bf7878c6dae952eec5fb87b1106589
7832 #: build/C/man5/proc.5:457
7834 "This file displays the soft limit, hard limit, and units of measurement for "
7835 "each of the process's resource limits (see B<getrlimit>(2)). Up to and "
7836 "including Linux 2.6.35, this file is protected to allow reading only by the "
7837 "real UID of the process. Since Linux 2.6.36, this file is readable by all "
7838 "users on the system."
7842 #: build/C/man5/proc.5:457
7844 msgid "I</proc/[pid]/map_files/> (since kernel 3.3)"
7847 #. commit 640708a2cff7f81e246243b0073c66e6ece7e53e
7849 #: build/C/man5/proc.5:467
7851 "This subdirectory contains entries corresponding to memory-mapped files (see "
7852 "B<mmap>(2)). Entries are named by memory region start and end address pair "
7853 "(expressed as hexadecimal numbers), and are symbolic links to the mapped "
7854 "files themselves. Here is an example, with the output wrapped and "
7855 "reformatted to fit on an 80-column display:"
7859 #: build/C/man5/proc.5:474
7862 "$B< ls -l /proc/self/map_files/>\n"
7863 "lr--------. 1 root root 64 Apr 16 21:31\n"
7864 " 3252e00000-3252e20000 -E<gt> /usr/lib64/ld-2.15.so\n"
7869 #: build/C/man5/proc.5:488
7871 "Although these entries are present for memory regions that were mapped with "
7872 "the B<MAP_FILE> flag, the way anonymous shared memory (regions created with "
7873 "the B<MAP_ANON | MAP_SHARED> flags) is implemented in Linux means that such "
7874 "regions also appear on this directory. Here is an example where the target "
7875 "file is the deleted I</dev/zero> one:"
7879 #: build/C/man5/proc.5:494
7882 "lrw-------. 1 root root 64 Apr 16 21:33\n"
7883 " 7fc075d2f000-7fc075e6f000 -E<gt> /dev/zero (deleted)\n"
7887 #: build/C/man5/proc.5:500
7889 "This directory appears only if the B<CONFIG_CHECKPOINT_RESTORE> kernel "
7890 "configuration option is enabled."
7894 #: build/C/man5/proc.5:500
7896 msgid "I</proc/[pid]/maps>"
7900 #: build/C/man5/proc.5:507
7902 "A file containing the currently mapped memory regions and their access "
7903 "permissions. See B<mmap>(2) for some further information about memory "
7908 #: build/C/man5/proc.5:509
7909 msgid "The format of the file is:"
7913 #: build/C/man5/proc.5:534
7916 "I<address perms offset dev inode pathname>\n"
7917 "00400000-00452000 r-xp 00000000 08:02 173521 /usr/bin/dbus-daemon\n"
7918 "00651000-00652000 r--p 00051000 08:02 173521 /usr/bin/dbus-daemon\n"
7919 "00652000-00655000 rw-p 00052000 08:02 173521 /usr/bin/dbus-daemon\n"
7920 "00e03000-00e24000 rw-p 00000000 00:00 0 [heap]\n"
7921 "00e24000-011f7000 rw-p 00000000 00:00 0 [heap]\n"
7923 "35b1800000-35b1820000 r-xp 00000000 08:02 135522 /usr/lib64/ld-2.15.so\n"
7924 "35b1a1f000-35b1a20000 r--p 0001f000 08:02 135522 /usr/lib64/ld-2.15.so\n"
7925 "35b1a20000-35b1a21000 rw-p 00020000 08:02 135522 /usr/lib64/ld-2.15.so\n"
7926 "35b1a21000-35b1a22000 rw-p 00000000 00:00 0\n"
7927 "35b1c00000-35b1dac000 r-xp 00000000 08:02 135870 /usr/lib64/libc-2.15.so\n"
7928 "35b1dac000-35b1fac000 ---p 001ac000 08:02 135870 /usr/lib64/libc-2.15.so\n"
7929 "35b1fac000-35b1fb0000 r--p 001ac000 08:02 135870 /usr/lib64/libc-2.15.so\n"
7930 "35b1fb0000-35b1fb2000 rw-p 001b0000 08:02 135870 /usr/lib64/libc-2.15.so\n"
7932 "f2c6ff8c000-7f2c7078c000 rw-p 00000000 00:00 0 [stack:986]\n"
7934 "7fffb2c0d000-7fffb2c2e000 rw-p 00000000 00:00 0 [stack]\n"
7935 "7fffb2d48000-7fffb2d49000 r-xp 00000000 00:00 0 [vdso]\n"
7939 #: build/C/man5/proc.5:543
7941 "The I<address> field is the address space in the process that the mapping "
7942 "occupies. The I<perms> field is a set of permissions:"
7946 #: build/C/man5/proc.5:551
7953 "p = private (copy on write)\n"
7957 #: build/C/man5/proc.5:564
7959 "The I<offset> field is the offset into the file/whatever; I<dev> is the "
7960 "device (major:minor); I<inode> is the inode on that device. 0 indicates "
7961 "that no inode is associated with the memory region, as would be the case "
7962 "with BSS (uninitialized data)."
7966 #: build/C/man5/proc.5:574
7968 "The I<pathname> field will usually be the file that is backing the mapping. "
7969 "For ELF files, you can easily coordinate with the I<offset> field by looking "
7970 "at the Offset field in the ELF program headers (I<readelf\\ -l>)."
7974 #: build/C/man5/proc.5:576
7975 msgid "There are additional helpful pseudo-paths:"
7979 #: build/C/man5/proc.5:577
7985 #: build/C/man5/proc.5:580
7986 msgid "The initial process's (also known as the main thread's) stack."
7990 #: build/C/man5/proc.5:580
7992 msgid "I<[stack:E<lt>tidE<gt>]> (since Linux 3.4)"
7995 #. commit b76437579d1344b612cf1851ae610c636cec7db0
7997 #: build/C/man5/proc.5:589
7999 "A thread's stack (where the I<E<lt>tidE<gt>> is a thread ID). It "
8000 "corresponds to the I</proc/[pid]/task/[tid]/> path."
8004 #: build/C/man5/proc.5:589
8010 #: build/C/man5/proc.5:592
8011 msgid "The virtual dynamically linked shared object."
8015 #: build/C/man5/proc.5:592
8021 #: build/C/man5/proc.5:595
8022 msgid "The process's heap."
8026 #: build/C/man5/proc.5:609
8028 "If the I<pathname> field is blank, this is an anonymous mapping as obtained "
8029 "via the B<mmap>(2) function. There is no easy way to coordinate this back "
8030 "to a process's source, short of running it through B<gdb>(1), B<strace>(1), "
8035 #: build/C/man5/proc.5:611
8036 msgid "Under Linux 2.0 there is no field giving pathname."
8040 #: build/C/man5/proc.5:611
8042 msgid "I</proc/[pid]/mem>"
8046 #: build/C/man5/proc.5:618
8048 "This file can be used to access the pages of a process's memory through "
8049 "B<open>(2), B<read>(2), and B<lseek>(2)."
8053 #: build/C/man5/proc.5:618
8055 msgid "I</proc/[pid]/mountinfo> (since Linux 2.6.26)"
8058 #. This info adapted from Documentation/filesystems/proc.txt
8060 #: build/C/man5/proc.5:623
8062 "This file contains information about mount points. It contains lines of the "
8067 #: build/C/man5/proc.5:628
8070 "CW<36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root "
8071 "rw,errors=continue\n"
8072 "(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)>\n"
8076 #: build/C/man5/proc.5:632
8077 msgid "The numbers in parentheses are labels for the descriptions below:"
8081 #: build/C/man5/proc.5:633 build/C/man5/proc.5:726
8087 #: build/C/man5/proc.5:637
8088 msgid "mount ID: unique identifier of the mount (may be reused after B<umount>(2))."
8092 #: build/C/man5/proc.5:637 build/C/man5/proc.5:730
8098 #: build/C/man5/proc.5:640
8099 msgid "parent ID: ID of parent mount (or of self for the top of the mount tree)."
8103 #: build/C/man5/proc.5:640 build/C/man5/proc.5:733
8109 #: build/C/man5/proc.5:646
8110 msgid "major:minor: value of I<st_dev> for files on filesystem (see B<stat>(2))."
8114 #: build/C/man5/proc.5:646 build/C/man5/proc.5:736
8120 #: build/C/man5/proc.5:649
8121 msgid "root: root of the mount within the filesystem."
8125 #: build/C/man5/proc.5:649
8131 #: build/C/man5/proc.5:652
8132 msgid "mount point: mount point relative to the process's root."
8136 #: build/C/man5/proc.5:652
8142 #: build/C/man5/proc.5:655
8143 msgid "mount options: per-mount options."
8147 #: build/C/man5/proc.5:655
8153 #: build/C/man5/proc.5:658
8154 msgid "optional fields: zero or more fields of the form \"tag[:value]\"."
8158 #: build/C/man5/proc.5:658
8164 #: build/C/man5/proc.5:661
8165 msgid "separator: marks the end of the optional fields."
8169 #: build/C/man5/proc.5:661
8175 #: build/C/man5/proc.5:664
8176 msgid "filesystem type: name of filesystem in the form \"type[.subtype]\"."
8180 #: build/C/man5/proc.5:664
8186 #: build/C/man5/proc.5:667
8187 msgid "mount source: filesystem-specific information or \"none\"."
8191 #: build/C/man5/proc.5:667
8197 #: build/C/man5/proc.5:670
8198 msgid "super options: per-superblock options."
8202 #: build/C/man5/proc.5:674
8204 "Parsers should ignore all unrecognized optional fields. Currently the "
8205 "possible optional fields are:"
8209 #: build/C/man5/proc.5:675
8215 #: build/C/man5/proc.5:678
8216 msgid "mount is shared in peer group X"
8220 #: build/C/man5/proc.5:678
8226 #: build/C/man5/proc.5:681
8227 msgid "mount is slave to peer group X"
8231 #: build/C/man5/proc.5:681
8233 msgid "propagate_from:X"
8237 #: build/C/man5/proc.5:684
8238 msgid "mount is slave and receives propagation from peer group X (*)"
8242 #: build/C/man5/proc.5:684
8248 #: build/C/man5/proc.5:687
8249 msgid "mount is unbindable"
8253 #: build/C/man5/proc.5:694
8255 "(*) X is the closest dominant peer group under the process's root. If X is "
8256 "the immediate master of the mount, or if there is no dominant peer group "
8257 "under the same root, then only the \"master:X\" field is present and not the "
8258 "\"propagate_from:X\" field."
8262 #: build/C/man5/proc.5:698
8264 "For more information on mount propagation see: "
8265 "I<Documentation/filesystems/sharedsubtree.txt> in the Linux kernel source "
8270 #: build/C/man5/proc.5:698
8272 msgid "I</proc/[pid]/mounts> (since Linux 2.4.19)"
8276 #: build/C/man5/proc.5:713
8278 "This is a list of all the filesystems currently mounted in the process's "
8279 "mount namespace. The format of this file is documented in B<fstab>(5). "
8280 "Since kernel version 2.6.15, this file is pollable: after opening the file "
8281 "for reading, a change in this file (i.e., a filesystem mount or unmount) "
8282 "causes B<select>(2) to mark the file descriptor as readable, and B<poll>(2) "
8283 "and B<epoll_wait>(2) mark the file as having an error condition."
8287 #: build/C/man5/proc.5:713
8289 msgid "I</proc/[pid]/mountstats> (since Linux 2.6.17)"
8293 #: build/C/man5/proc.5:718
8295 "This file exports information (statistics, configuration information) about "
8296 "the mount points in the process's name space. Lines in this file have the "
8301 #: build/C/man5/proc.5:722
8304 "device /dev/sda7 mounted on /home with fstype ext3 [statistics]\n"
8305 "( 1 ) ( 2 ) (3 ) (4)\n"
8309 #: build/C/man5/proc.5:725
8310 msgid "The fields in each line are:"
8314 #: build/C/man5/proc.5:730
8316 "The name of the mounted device (or \"nodevice\" if there is no corresponding "
8321 #: build/C/man5/proc.5:733
8322 msgid "The mount point within the filesystem tree."
8326 #: build/C/man5/proc.5:736
8327 msgid "The filesystem type."
8331 #: build/C/man5/proc.5:741
8333 "Optional statistics and configuration information. Currently (as at Linux "
8334 "2.6.26), only NFS filesystems export information via this field."
8338 #: build/C/man5/proc.5:744
8339 msgid "This file is readable only by the owner of the process."
8343 #: build/C/man5/proc.5:744
8345 msgid "I</proc/[pid]/ns/> (since Linux 3.0)"
8348 #. See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f
8350 #: build/C/man5/proc.5:752
8352 "This is a subdirectory containing one entry for each namespace that supports "
8353 "being manipulated by B<setns>(2). For information about namespaces, see "
8358 #: build/C/man5/proc.5:752
8360 msgid "I</proc/[pid]/ns/ipc> (since Linux 3.0)"
8364 #: build/C/man5/proc.5:760
8366 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
8367 "filesystem keeps the IPC namespace of the process specified by I<pid> alive "
8368 "even if all processes currently in the namespace terminate."
8372 #: build/C/man5/proc.5:769
8374 "Opening this file returns a file handle for the IPC namespace of the process "
8375 "specified by I<pid>. As long as this file descriptor remains open, the IPC "
8376 "namespace will remain alive, even if all processes in the namespace "
8377 "terminate. The file descriptor can be passed to B<setns>(2)."
8381 #: build/C/man5/proc.5:769
8383 msgid "I</proc/[pid]/ns/net> (since Linux 3.0)"
8387 #: build/C/man5/proc.5:777
8389 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
8390 "filesystem keeps the network namespace of the process specified by I<pid> "
8391 "alive even if all processes in the namespace terminate."
8395 #: build/C/man5/proc.5:786
8397 "Opening this file returns a file handle for the network namespace of the "
8398 "process specified by I<pid>. As long as this file descriptor remains open, "
8399 "the network namespace will remain alive, even if all processes in the "
8400 "namespace terminate. The file descriptor can be passed to B<setns>(2)."
8404 #: build/C/man5/proc.5:786
8406 msgid "I</proc/[pid]/ns/uts> (since Linux 3.0)"
8410 #: build/C/man5/proc.5:794
8412 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
8413 "filesystem keeps the UTS namespace of the process specified by I<pid> alive "
8414 "even if all processes currently in the namespace terminate."
8418 #: build/C/man5/proc.5:803
8420 "Opening this file returns a file handle for the UTS namespace of the process "
8421 "specified by I<pid>. As long as this file descriptor remains open, the UTS "
8422 "namespace will remain alive, even if all processes in the namespace "
8423 "terminate. The file descriptor can be passed to B<setns>(2)."
8427 #: build/C/man5/proc.5:803
8429 msgid "I</proc/[pid]/numa_maps> (since Linux 2.6.14)"
8433 #: build/C/man5/proc.5:807
8434 msgid "See B<numa>(7)."
8438 #: build/C/man5/proc.5:807
8440 msgid "I</proc/[pid]/oom_adj> (since Linux 2.6.11)"
8444 #: build/C/man5/proc.5:820
8446 "This file can be used to adjust the score used to select which process "
8447 "should be killed in an out-of-memory (OOM) situation. The kernel uses this "
8448 "value for a bit-shift operation of the process's I<oom_score> value: valid "
8449 "values are in the range -16 to +15, plus the special value -17, which "
8450 "disables OOM-killing altogether for this process. A positive score "
8451 "increases the likelihood of this process being killed by the OOM-killer; a "
8452 "negative score decreases the likelihood."
8456 #: build/C/man5/proc.5:828
8458 "The default value for this file is 0; a new process inherits its parent's "
8459 "I<oom_adj> setting. A process must be privileged (B<CAP_SYS_RESOURCE>) to "
8464 #: build/C/man5/proc.5:831
8466 "Since Linux 2.6.36, use of this file is deprecated in favor of "
8467 "I</proc/[pid]/oom_score_adj>."
8471 #: build/C/man5/proc.5:831
8473 msgid "I</proc/[pid]/oom_score> (since Linux 2.6.11)"
8476 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
8477 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
8479 #: build/C/man5/proc.5:842
8481 "This file displays the current score that the kernel gives to this process "
8482 "for the purpose of selecting a process for the OOM-killer. A higher score "
8483 "means that the process is more likely to be selected by the OOM-killer. The "
8484 "basis for this score is the amount of memory used by the process, with "
8485 "increases (+) or decreases (-) for factors including:"
8489 #: build/C/man5/proc.5:847
8490 msgid "whether the process creates a lot of children using B<fork>(2) (+);"
8494 #: build/C/man5/proc.5:850
8496 "whether the process has been running a long time, or has used a lot of CPU "
8501 #: build/C/man5/proc.5:852
8502 msgid "whether the process has a low nice value (i.e., E<gt> 0) (+);"
8505 #. More precisely, if it has CAP_SYS_ADMIN or CAP_SYS_RESOURCE
8507 #: build/C/man5/proc.5:855
8508 msgid "whether the process is privileged (-); and"
8511 #. More precisely, if it has CAP_SYS_RAWIO
8513 #: build/C/man5/proc.5:858
8514 msgid "whether the process is making direct hardware access (-)."
8518 #: build/C/man5/proc.5:867
8520 "The I<oom_score> also reflects the adjustment specified by the "
8521 "I<oom_score_adj> or I<oom_adj> setting for the process."
8525 #: build/C/man5/proc.5:867
8527 msgid "I</proc/[pid]/oom_score_adj> (since Linux 2.6.36)"
8530 #. Text taken from 3.7 Documentation/filesystems/proc.txt
8532 #: build/C/man5/proc.5:872
8534 "This file can be used to adjust the badness heuristic used to select which "
8535 "process gets killed in out-of-memory conditions."
8539 #: build/C/man5/proc.5:881
8541 "The badness heuristic assigns a value to each candidate task ranging from 0 "
8542 "(never kill) to 1000 (always kill) to determine which process is targeted. "
8543 "The units are roughly a proportion along that range of allowed memory the "
8544 "process may allocate from, based on an estimation of its current memory and "
8545 "swap use. For example, if a task is using all allowed memory, its badness "
8546 "score will be 1000. If it is using half of its allowed memory, its score "
8551 #: build/C/man5/proc.5:884
8553 "There is an additional factor included in the badness score: root processes "
8554 "are given 3% extra memory over other tasks."
8558 #: build/C/man5/proc.5:898
8560 "The amount of \"allowed\" memory depends on the context in which the "
8561 "OOM-killer was called. If it is due to the memory assigned to the "
8562 "allocating task's cpuset being exhausted, the allowed memory represents the "
8563 "set of mems assigned to that cpuset (see B<cpuset>(7)). If it is due to a "
8564 "mempolicy's node(s) being exhausted, the allowed memory represents the set "
8565 "of mempolicy nodes. If it is due to a memory limit (or swap limit) being "
8566 "reached, the allowed memory is that configured limit. Finally, if it is due "
8567 "to the entire system being out of memory, the allowed memory represents all "
8568 "allocatable resources."
8572 #: build/C/man5/proc.5:911
8574 "The value of I<oom_score_adj> is added to the badness score before it is "
8575 "used to determine which task to kill. Acceptable values range from -1000 "
8576 "(OOM_SCORE_ADJ_MIN) to +1000 (OOM_SCORE_ADJ_MAX). This allows user space to "
8577 "control the preference for OOM-killing, ranging from always preferring a "
8578 "certain task or completely disabling it from OOM-killing. The lowest "
8579 "possible value, -1000, is equivalent to disabling OOM-killing entirely for "
8580 "that task, since it will always report a badness score of 0."
8584 #: build/C/man5/proc.5:923
8586 "Consequently, it is very simple for user space to define the amount of "
8587 "memory to consider for each task. Setting a I<oom_score_adj> value of +500, "
8588 "for example, is roughly equivalent to allowing the remainder of tasks "
8589 "sharing the same system, cpuset, mempolicy, or memory controller resources "
8590 "to use at least 50% more memory. A value of -500, on the other hand, would "
8591 "be roughly equivalent to discounting 50% of the task's allowed memory from "
8592 "being considered as scoring against the task."
8596 #: build/C/man5/proc.5:930
8598 "For backward compatibility with previous kernels, I</proc/[pid]/oom_adj> can "
8599 "still be used to tune the badness score. Its value is scaled linearly with "
8603 #. FIXME Describe /proc/[pid]/pagemap
8605 #. CONFIG_PROC_PAGE_MONITOR
8607 #: build/C/man5/proc.5:939
8609 "Writing to I</proc/[pid]/oom_score_adj> or I</proc/[pid]/oom_adj> will "
8610 "change the other with its scaled value."
8614 #: build/C/man5/proc.5:939
8616 msgid "I</proc/[pid]/root>"
8620 #: build/C/man5/proc.5:950
8622 "UNIX and Linux support the idea of a per-process root of the filesystem, set "
8623 "by the B<chroot>(2) system call. This file is a symbolic link that points "
8624 "to the process's root directory, and behaves in the same way as I<exe>, and "
8629 #: build/C/man5/proc.5:970
8631 msgid "I</proc/[pid]/smaps> (since Linux 2.6.14)"
8634 #. CONFIG_PROC_PAGE_MONITOR
8636 #: build/C/man5/proc.5:975
8638 "This file shows memory consumption for each of the process's mappings. For "
8639 "each of mappings there is a series of lines such as the following:"
8643 #: build/C/man5/proc.5:985
8646 "08048000-080bc000 r-xp 00000000 03:02 13130 /bin/bash\n"
8649 "Shared_Clean: 424 kB\n"
8650 "Shared_Dirty: 0 kB\n"
8651 "Private_Clean: 0 kB\n"
8652 "Private_Dirty: 0 kB\n"
8656 #: build/C/man5/proc.5:995
8658 "The first of these lines shows the same information as is displayed for the "
8659 "mapping in I</proc/[pid]/maps>. The remaining lines show the size of the "
8660 "mapping, the amount of the mapping that is currently resident in RAM, the "
8661 "number of clean and dirty shared pages in the mapping, and the number of "
8662 "clean and dirty private pages in the mapping."
8666 #: build/C/man5/proc.5:1000
8668 "This file is present only if the B<CONFIG_MMU> kernel configuration option "
8673 #: build/C/man5/proc.5:1000
8675 msgid "I</proc/[pid]/stat>"
8679 #: build/C/man5/proc.5:1007
8681 "Status information about the process. This is used by B<ps>(1). It is "
8682 "defined in I</usr/src/linux/fs/proc/array.c>."
8686 #: build/C/man5/proc.5:1011
8687 msgid "The fields, in order, with their proper B<scanf>(3) format specifiers, are:"
8691 #: build/C/man5/proc.5:1012
8697 #: build/C/man5/proc.5:1015
8698 msgid "(1) The process ID."
8702 #: build/C/man5/proc.5:1015
8708 #: build/C/man5/proc.5:1019
8710 "(2) The filename of the executable, in parentheses. This is visible whether "
8711 "or not the executable is swapped out."
8715 #: build/C/man5/proc.5:1019
8721 #: build/C/man5/proc.5:1025
8723 "(3) One character from the string \"RSDZTW\" where R is running, S is "
8724 "sleeping in an interruptible wait, D is waiting in uninterruptible disk "
8725 "sleep, Z is zombie, T is traced or stopped (on a signal), and W is paging."
8729 #: build/C/man5/proc.5:1025
8735 #: build/C/man5/proc.5:1028
8736 msgid "(4) The PID of the parent."
8740 #: build/C/man5/proc.5:1028
8746 #: build/C/man5/proc.5:1031
8747 msgid "(5) The process group ID of the process."
8751 #: build/C/man5/proc.5:1031
8753 msgid "I<session> %d"
8757 #: build/C/man5/proc.5:1034
8758 msgid "(6) The session ID of the process."
8762 #: build/C/man5/proc.5:1034
8764 msgid "I<tty_nr> %d"
8768 #: build/C/man5/proc.5:1040
8770 "(7) The controlling terminal of the process. (The minor device number is "
8771 "contained in the combination of bits 31 to 20 and 7 to 0; the major device "
8772 "number is in bits 15 to 8.)"
8776 #: build/C/man5/proc.5:1040
8781 #. This field and following, up to and including wchan added 0.99.1
8783 #: build/C/man5/proc.5:1045
8785 "(8) The ID of the foreground process group of the controlling terminal of "
8790 #: build/C/man5/proc.5:1045
8792 msgid "I<flags> %u (%lu before Linux 2.6.22)"
8796 #: build/C/man5/proc.5:1052
8798 "(9) The kernel flags word of the process. For bit meanings, see the PF_* "
8799 "defines in the Linux kernel source file I<include/linux/sched.h>. Details "
8800 "depend on the kernel version."
8804 #: build/C/man5/proc.5:1052
8806 msgid "I<minflt> %lu"
8810 #: build/C/man5/proc.5:1056
8812 "(10) The number of minor faults the process has made which have not required "
8813 "loading a memory page from disk."
8817 #: build/C/man5/proc.5:1056
8819 msgid "I<cminflt> %lu"
8823 #: build/C/man5/proc.5:1060
8825 "(11) The number of minor faults that the process's waited-for children have "
8830 #: build/C/man5/proc.5:1060
8832 msgid "I<majflt> %lu"
8836 #: build/C/man5/proc.5:1064
8838 "(12) The number of major faults the process has made which have required "
8839 "loading a memory page from disk."
8843 #: build/C/man5/proc.5:1064
8845 msgid "I<cmajflt> %lu"
8849 #: build/C/man5/proc.5:1068
8851 "(13) The number of major faults that the process's waited-for children have "
8856 #: build/C/man5/proc.5:1068
8858 msgid "I<utime> %lu"
8862 #: build/C/man5/proc.5:1077
8864 "(14) Amount of time that this process has been scheduled in user mode, "
8865 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>). This includes "
8866 "guest time, I<guest_time> (time spent running a virtual CPU, see below), so "
8867 "that applications that are not aware of the guest time field do not lose "
8868 "that time from their calculations."
8872 #: build/C/man5/proc.5:1077
8874 msgid "I<stime> %lu"
8878 #: build/C/man5/proc.5:1082
8880 "(15) Amount of time that this process has been scheduled in kernel mode, "
8881 "measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
8885 #: build/C/man5/proc.5:1082
8887 msgid "I<cutime> %ld"
8891 #: build/C/man5/proc.5:1092
8893 "(16) Amount of time that this process's waited-for children have been "
8894 "scheduled in user mode, measured in clock ticks (divide by "
8895 "I<sysconf(_SC_CLK_TCK)>). (See also B<times>(2).) This includes guest "
8896 "time, I<cguest_time> (time spent running a virtual CPU, see below)."
8900 #: build/C/man5/proc.5:1092
8902 msgid "I<cstime> %ld"
8906 #: build/C/man5/proc.5:1098
8908 "(17) Amount of time that this process's waited-for children have been "
8909 "scheduled in kernel mode, measured in clock ticks (divide by "
8910 "I<sysconf(_SC_CLK_TCK)>)."
8914 #: build/C/man5/proc.5:1098
8916 msgid "I<priority> %ld"
8920 #: build/C/man5/proc.5:1115
8922 "(18) (Explanation for Linux 2.6) For processes running a real-time "
8923 "scheduling policy (I<policy> below; see B<sched_setscheduler>(2)), this is "
8924 "the negated scheduling priority, minus one; that is, a number in the range "
8925 "-2 to -100, corresponding to real-time priorities 1 to 99. For processes "
8926 "running under a non-real-time scheduling policy, this is the raw nice value "
8927 "(B<setpriority>(2)) as represented in the kernel. The kernel stores nice "
8928 "values as numbers in the range 0 (high) to 39 (low), corresponding to the "
8929 "user-visible nice range of -20 to 19."
8932 #. And back in kernel 1.2 days things were different again.
8934 #: build/C/man5/proc.5:1119
8936 "Before Linux 2.6, this was a scaled value based on the scheduler weighting "
8937 "given to this process."
8941 #: build/C/man5/proc.5:1119
8946 #. Back in kernel 1.2 days things were different.
8948 #. \fIcounter\fP %ld
8949 #. The current maximum size in jiffies of the process's next timeslice,
8950 #. or what is currently left of its current timeslice, if it is the
8951 #. currently running process.
8954 #. The time in jiffies of the process's next timeout.
8955 #. timeout was removed sometime around 2.1/2.2
8957 #: build/C/man5/proc.5:1134
8959 "(19) The nice value (see B<setpriority>(2)), a value in the range 19 (low "
8960 "priority) to -20 (high priority)."
8964 #: build/C/man5/proc.5:1134
8966 msgid "I<num_threads> %ld"
8970 #: build/C/man5/proc.5:1139
8972 "(20) Number of threads in this process (since Linux 2.6). Before kernel "
8973 "2.6, this field was hard coded to 0 as a placeholder for an earlier removed "
8978 #: build/C/man5/proc.5:1139
8980 msgid "I<itrealvalue> %ld"
8984 #: build/C/man5/proc.5:1146
8986 "(21) The time in jiffies before the next B<SIGALRM> is sent to the process "
8987 "due to an interval timer. Since kernel 2.6.17, this field is no longer "
8988 "maintained, and is hard coded as 0."
8992 #: build/C/man5/proc.5:1146
8994 msgid "I<starttime> %llu (was %lu before Linux 2.6)"
8998 #: build/C/man5/proc.5:1152
9000 "(22) The time the process started after system boot. In kernels before "
9001 "Linux 2.6, this value was expressed in jiffies. Since Linux 2.6, the value "
9002 "is expressed in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>)."
9006 #: build/C/man5/proc.5:1152
9008 msgid "I<vsize> %lu"
9012 #: build/C/man5/proc.5:1155
9013 msgid "(23) Virtual memory size in bytes."
9017 #: build/C/man5/proc.5:1155
9023 #: build/C/man5/proc.5:1162
9025 "(24) Resident Set Size: number of pages the process has in real memory. "
9026 "This is just the pages which count toward text, data, or stack space. This "
9027 "does not include pages which have not been demand-loaded in, or which are "
9032 #: build/C/man5/proc.5:1162
9034 msgid "I<rsslim> %lu"
9038 #: build/C/man5/proc.5:1169
9040 "(25) Current soft limit in bytes on the rss of the process; see the "
9041 "description of B<RLIMIT_RSS> in B<getrlimit>(2)."
9045 #: build/C/man5/proc.5:1169
9047 msgid "I<startcode> %lu"
9051 #: build/C/man5/proc.5:1172
9052 msgid "(26) The address above which program text can run."
9056 #: build/C/man5/proc.5:1172
9058 msgid "I<endcode> %lu"
9062 #: build/C/man5/proc.5:1175
9063 msgid "(27) The address below which program text can run."
9067 #: build/C/man5/proc.5:1175
9069 msgid "I<startstack> %lu"
9073 #: build/C/man5/proc.5:1178
9074 msgid "(28) The address of the start (i.e., bottom) of the stack."
9078 #: build/C/man5/proc.5:1178
9080 msgid "I<kstkesp> %lu"
9084 #: build/C/man5/proc.5:1182
9086 "(29) The current value of ESP (stack pointer), as found in the kernel stack "
9087 "page for the process."
9091 #: build/C/man5/proc.5:1182
9093 msgid "I<kstkeip> %lu"
9097 #: build/C/man5/proc.5:1185
9098 msgid "(30) The current EIP (instruction pointer)."
9102 #: build/C/man5/proc.5:1185
9104 msgid "I<signal> %lu"
9108 #: build/C/man5/proc.5:1191
9110 "(31) The bitmap of pending signals, displayed as a decimal number. "
9111 "Obsolete, because it does not provide information on real-time signals; use "
9112 "I</proc/[pid]/status> instead."
9116 #: build/C/man5/proc.5:1191
9118 msgid "I<blocked> %lu"
9122 #: build/C/man5/proc.5:1197
9124 "(32) The bitmap of blocked signals, displayed as a decimal number. "
9125 "Obsolete, because it does not provide information on real-time signals; use "
9126 "I</proc/[pid]/status> instead."
9130 #: build/C/man5/proc.5:1197
9132 msgid "I<sigignore> %lu"
9136 #: build/C/man5/proc.5:1203
9138 "(33) The bitmap of ignored signals, displayed as a decimal number. "
9139 "Obsolete, because it does not provide information on real-time signals; use "
9140 "I</proc/[pid]/status> instead."
9144 #: build/C/man5/proc.5:1203
9146 msgid "I<sigcatch> %lu"
9150 #: build/C/man5/proc.5:1209
9152 "(34) The bitmap of caught signals, displayed as a decimal number. Obsolete, "
9153 "because it does not provide information on real-time signals; use "
9154 "I</proc/[pid]/status> instead."
9158 #: build/C/man5/proc.5:1209
9160 msgid "I<wchan> %lu"
9164 #: build/C/man5/proc.5:1215
9166 "(35) This is the \"channel\" in which the process is waiting. It is the "
9167 "address of a location in the kernel where the process is sleeping. The "
9168 "corresponding symbolic name can be found in I</proc/[pid]/wchan>."
9172 #: build/C/man5/proc.5:1215
9174 msgid "I<nswap> %lu"
9177 #. nswap was added in 2.0
9179 #: build/C/man5/proc.5:1220
9180 msgid "(36) Number of pages swapped (not maintained)."
9184 #: build/C/man5/proc.5:1220
9186 msgid "I<cnswap> %lu"
9189 #. cnswap was added in 2.0
9191 #: build/C/man5/proc.5:1225
9192 msgid "(37) Cumulative I<nswap> for child processes (not maintained)."
9196 #: build/C/man5/proc.5:1225
9198 msgid "I<exit_signal> %d (since Linux 2.1.22)"
9202 #: build/C/man5/proc.5:1228
9203 msgid "(38) Signal to be sent to parent when we die."
9207 #: build/C/man5/proc.5:1228
9209 msgid "I<processor> %d (since Linux 2.2.8)"
9213 #: build/C/man5/proc.5:1231
9214 msgid "(39) CPU number last executed on."
9218 #: build/C/man5/proc.5:1231
9220 msgid "I<rt_priority> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
9224 #: build/C/man5/proc.5:1237
9226 "(40) Real-time scheduling priority, a number in the range 1 to 99 for "
9227 "processes scheduled under a real-time policy, or 0, for non-real-time "
9228 "processes (see B<sched_setscheduler>(2))."
9232 #: build/C/man5/proc.5:1237
9234 msgid "I<policy> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
9238 #: build/C/man5/proc.5:1243
9240 "(41) Scheduling policy (see B<sched_setscheduler>(2)). Decode using the "
9241 "SCHED_* constants in I<linux/sched.h>."
9245 #: build/C/man5/proc.5:1243
9247 msgid "I<delayacct_blkio_ticks> %llu (since Linux 2.6.18)"
9251 #: build/C/man5/proc.5:1246
9252 msgid "(42) Aggregated block I/O delays, measured in clock ticks (centiseconds)."
9256 #: build/C/man5/proc.5:1246
9258 msgid "I<guest_time> %lu (since Linux 2.6.24)"
9262 #: build/C/man5/proc.5:1251
9264 "(43) Guest time of the process (time spent running a virtual CPU for a guest "
9265 "operating system), measured in clock ticks (divide by "
9266 "I<sysconf(_SC_CLK_TCK)>)."
9270 #: build/C/man5/proc.5:1251
9272 msgid "I<cguest_time> %ld (since Linux 2.6.24)"
9276 #: build/C/man5/proc.5:1255
9278 "(44) Guest time of the process's children, measured in clock ticks (divide "
9279 "by I<sysconf(_SC_CLK_TCK)>)."
9283 #: build/C/man5/proc.5:1256
9285 msgid "I</proc/[pid]/statm>"
9289 #: build/C/man5/proc.5:1260
9291 "Provides information about memory usage, measured in pages. The columns "
9295 #. (not including libs; broken, includes data segment)
9296 #. (including libs; broken, includes library text)
9298 #: build/C/man5/proc.5:1274
9301 "size (1) total program size\n"
9302 " (same as VmSize in I</proc/[pid]/status>)\n"
9303 "resident (2) resident set size\n"
9304 " (same as VmRSS in I</proc/[pid]/status>)\n"
9305 "share (3) shared pages (i.e., backed by a file)\n"
9306 "text (4) text (code)\n"
9307 "lib (5) library (unused in Linux 2.6)\n"
9308 "data (6) data + stack\n"
9309 "dt (7) dirty pages (unused in Linux 2.6)\n"
9313 #: build/C/man5/proc.5:1276
9315 msgid "I</proc/[pid]/status>"
9319 #: build/C/man5/proc.5:1284
9321 "Provides much of the information in I</proc/[pid]/stat> and "
9322 "I</proc/[pid]/statm> in a format that's easier for humans to parse. Here's "
9327 #: build/C/man5/proc.5:1325
9330 "$B< cat /proc/$$/status>\n"
9332 "State: S (sleeping)\n"
9337 "Uid: 1000 1000 1000 1000\n"
9338 "Gid: 100 100 100 100\n"
9340 "Groups: 16 33 100\n"
9353 "SigPnd: 0000000000000000\n"
9354 "ShdPnd: 0000000000000000\n"
9355 "SigBlk: 0000000000010000\n"
9356 "SigIgn: 0000000000384004\n"
9357 "SigCgt: 000000004b813efb\n"
9358 "CapInh: 0000000000000000\n"
9359 "CapPrm: 0000000000000000\n"
9360 "CapEff: 0000000000000000\n"
9361 "CapBnd: ffffffffffffffff\n"
9362 "Cpus_allowed: 00000001\n"
9363 "Cpus_allowed_list: 0\n"
9365 "Mems_allowed_list: 0\n"
9366 "voluntary_ctxt_switches: 150\n"
9367 "nonvoluntary_ctxt_switches: 545\n"
9371 #: build/C/man5/proc.5:1333
9372 msgid "I<Name>: Command run by this process."
9376 #: build/C/man5/proc.5:1345
9378 "I<State>: Current state of the process. One of \"R (running)\", \"S "
9379 "(sleeping)\", \"D (disk sleep)\", \"T (stopped)\", \"T (tracing stop)\", \"Z "
9380 "(zombie)\", or \"X (dead)\"."
9384 #: build/C/man5/proc.5:1348
9385 msgid "I<Tgid>: Thread group ID (i.e., Process ID)."
9389 #: build/C/man5/proc.5:1352
9390 msgid "I<Pid>: Thread ID (see B<gettid>(2))."
9394 #: build/C/man5/proc.5:1355
9395 msgid "I<PPid>: PID of parent process."
9399 #: build/C/man5/proc.5:1358
9400 msgid "I<TracerPid>: PID of process tracing this process (0 if not being traced)."
9404 #: build/C/man5/proc.5:1361
9405 msgid "I<Uid>, I<Gid>: Real, effective, saved set, and filesystem UIDs (GIDs)."
9409 #: build/C/man5/proc.5:1364
9410 msgid "I<FDSize>: Number of file descriptor slots currently allocated."
9414 #: build/C/man5/proc.5:1367
9415 msgid "I<Groups>: Supplementary group list."
9419 #: build/C/man5/proc.5:1370
9420 msgid "I<VmPeak>: Peak virtual memory size."
9424 #: build/C/man5/proc.5:1373
9425 msgid "I<VmSize>: Virtual memory size."
9429 #: build/C/man5/proc.5:1377
9430 msgid "I<VmLck>: Locked memory size (see B<mlock>(3))."
9434 #: build/C/man5/proc.5:1380
9435 msgid "I<VmHWM>: Peak resident set size (\"high water mark\")."
9439 #: build/C/man5/proc.5:1383
9440 msgid "I<VmRSS>: Resident set size."
9444 #: build/C/man5/proc.5:1386
9445 msgid "I<VmData>, I<VmStk>, I<VmExe>: Size of data, stack, and text segments."
9449 #: build/C/man5/proc.5:1389
9450 msgid "I<VmLib>: Shared library code size."
9454 #: build/C/man5/proc.5:1392
9455 msgid "I<VmPTE>: Page table entries size (since Linux 2.6.10)."
9459 #: build/C/man5/proc.5:1395
9460 msgid "I<Threads>: Number of threads in process containing this thread."
9464 #: build/C/man5/proc.5:1406
9466 "I<SigQ>: This field contains two slash-separated numbers that relate to "
9467 "queued signals for the real user ID of this process. The first of these is "
9468 "the number of currently queued signals for this real user ID, and the second "
9469 "is the resource limit on the number of queued signals for this process (see "
9470 "the description of B<RLIMIT_SIGPENDING> in B<getrlimit>(2))."
9474 #: build/C/man5/proc.5:1412
9476 "I<SigPnd>, I<ShdPnd>: Number of signals pending for thread and for process "
9477 "as a whole (see B<pthreads>(7) and B<signal>(7))."
9481 #: build/C/man5/proc.5:1416
9483 "I<SigBlk>, I<SigIgn>, I<SigCgt>: Masks indicating signals being blocked, "
9484 "ignored, and caught (see B<signal>(7))."
9488 #: build/C/man5/proc.5:1421
9490 "I<CapInh>, I<CapPrm>, I<CapEff>: Masks of capabilities enabled in "
9491 "inheritable, permitted, and effective sets (see B<capabilities>(7))."
9495 #: build/C/man5/proc.5:1426
9497 "I<CapBnd>: Capability Bounding set (since kernel 2.6.26, see "
9498 "B<capabilities>(7))."
9502 #: build/C/man5/proc.5:1431
9504 "I<Cpus_allowed>: Mask of CPUs on which this process may run (since Linux "
9505 "2.6.24, see B<cpuset>(7))."
9509 #: build/C/man5/proc.5:1436
9511 "I<Cpus_allowed_list>: Same as previous, but in \"list format\" (since Linux "
9512 "2.6.26, see B<cpuset>(7))."
9516 #: build/C/man5/proc.5:1441
9518 "I<Mems_allowed>: Mask of memory nodes allowed to this process (since Linux "
9519 "2.6.24, see B<cpuset>(7))."
9523 #: build/C/man5/proc.5:1446
9525 "I<Mems_allowed_list>: Same as previous, but in \"list format\" (since Linux "
9526 "2.6.26, see B<cpuset>(7))."
9530 #: build/C/man5/proc.5:1449
9532 "I<voluntary_context_switches>, I<nonvoluntary_context_switches>: Number of "
9533 "voluntary and involuntary context switches (since Linux 2.6.23)."
9537 #: build/C/man5/proc.5:1450
9539 msgid "I</proc/[pid]/task> (since Linux 2.6.0-test6)"
9543 #: build/C/man5/proc.5:1481
9545 "This is a directory that contains one subdirectory for each thread in the "
9546 "process. The name of each subdirectory is the numerical thread ID "
9547 "(I<[tid]>) of the thread (see B<gettid>(2)). Within each of these "
9548 "subdirectories, there is a set of files with the same names and contents as "
9549 "under the I</proc/[pid]> directories. For attributes that are shared by all "
9550 "threads, the contents for each of the files under the I<task/[tid]> "
9551 "subdirectories will be the same as in the corresponding file in the parent "
9552 "I</proc/[pid]> directory (e.g., in a multithreaded process, all of the "
9553 "I<task/[tid]/cwd> files will have the same value as the I</proc/[pid]/cwd> "
9554 "file in the parent directory, since all of the threads in a process share a "
9555 "working directory). For attributes that are distinct for each thread, the "
9556 "corresponding files under I<task/[tid]> may have different values (e.g., "
9557 "various fields in each of the I<task/[tid]/status> files may be different "
9561 #. The following was still true as at kernel 2.6.13
9563 #: build/C/man5/proc.5:1488
9565 "In a multithreaded process, the contents of the I</proc/[pid]/task> "
9566 "directory are not available if the main thread has already terminated "
9567 "(typically by calling B<pthread_exit>(3))."
9571 #: build/C/man5/proc.5:1488
9573 msgid "I</proc/[pid]/wchan> (since Linux 2.6.0)"
9577 #: build/C/man5/proc.5:1492
9579 "The symbolic name corresponding to the location in the kernel where the "
9580 "process is sleeping."
9584 #: build/C/man5/proc.5:1492
9586 msgid "I</proc/apm>"
9590 #: build/C/man5/proc.5:1497
9592 "Advanced power management version and battery information when B<CONFIG_APM> "
9593 "is defined at kernel compilation time."
9597 #: build/C/man5/proc.5:1497
9599 msgid "I</proc/bus>"
9603 #: build/C/man5/proc.5:1500
9604 msgid "Contains subdirectories for installed busses."
9608 #: build/C/man5/proc.5:1500
9610 msgid "I</proc/bus/pccard>"
9614 #: build/C/man5/proc.5:1505
9616 "Subdirectory for PCMCIA devices when B<CONFIG_PCMCIA> is set at kernel "
9621 #: build/C/man5/proc.5:1505
9623 msgid "I</proc/[pid]/timers> (since Linux 3.10)"
9626 #. commit 5ed67f05f66c41e39880a6d61358438a25f9fee5
9627 #. commit 48f6a7a511ef8823fdff39afee0320092d43a8a0
9629 #: build/C/man5/proc.5:1512
9631 "A list of the POSIX timers for this process. Each timer is listed with a "
9632 "line that started with the string \"ID:\". For example:"
9636 #: build/C/man5/proc.5:1523
9640 "signal: 60/00007fff86e452a8\n"
9641 "notify: signal/pid.2634\n"
9644 "signal: 60/00007fff86e452a8\n"
9645 "notify: signal/pid.2634\n"
9650 #: build/C/man5/proc.5:1527
9651 msgid "The lines shown for each timer have the following meanings:"
9655 #: build/C/man5/proc.5:1528
9661 #: build/C/man5/proc.5:1539
9663 "The ID for this timer. This is not the same as the timer ID returned by "
9664 "B<timer_create>(2); rather, it is the same kernel-internal ID that is "
9665 "available via the I<si_timerid> field of the I<siginfo_t> structure (see "
9670 #: build/C/man5/proc.5:1539
9676 #: build/C/man5/proc.5:1546
9678 "This is the signal number that this timer uses to deliver notifications "
9679 "followed by a slash, and then the I<sigev_value.sival_ptr> value supplied to "
9680 "the signal handler. Valid only for timers that notify via a signal."
9684 #: build/C/man5/proc.5:1546
9690 #: build/C/man5/proc.5:1557
9692 "The part before the slash specifies the mechanism that this timer uses to "
9693 "deliver notifications, and is one of \"thread\", \"signal\", or \"none\". "
9694 "Immediately following the slash is either the string \"tid\" for timers with "
9695 "B<SIGEV_THREAD_ID> notification, or \"pid\" for timers that notify by other "
9696 "mechanisms. Following the \".\" is the PID of the process that will be "
9697 "delivered a signal if the timer delivers notifications via a signal."
9701 #: build/C/man5/proc.5:1557
9707 #: build/C/man5/proc.5:1570
9709 "This field identifies the clock that the timer uses for measuring time. For "
9710 "most clocks, this is a number that matches one of the user-space B<CLOCK_*> "
9711 "constants exposed via I<E<lt>time.hE<gt>>. B<CLOCK_PROCESS_CPUTIME_ID> "
9712 "timers display with a value of -6 in this field. B<CLOCK_THREAD_CPUTIME_ID> "
9713 "timers display with a value of -2 in this field."
9717 #: build/C/man5/proc.5:1571
9719 msgid "I</proc/bus/pccard/drivers>"
9723 #: build/C/man5/proc.5:1573
9725 msgid "I</proc/bus/pci>"
9729 #: build/C/man5/proc.5:1579
9731 "Contains various bus subdirectories and pseudo-files containing information "
9732 "about PCI busses, installed devices, and device drivers. Some of these "
9733 "files are not ASCII."
9737 #: build/C/man5/proc.5:1579
9739 msgid "I</proc/bus/pci/devices>"
9743 #: build/C/man5/proc.5:1586
9745 "Information about PCI devices. They may be accessed through B<lspci>(8) "
9750 #: build/C/man5/proc.5:1586
9752 msgid "I</proc/cmdline>"
9756 #: build/C/man5/proc.5:1593
9758 "Arguments passed to the Linux kernel at boot time. Often done via a boot "
9759 "manager such as B<lilo>(8) or B<grub>(8)."
9763 #: build/C/man5/proc.5:1593
9765 msgid "I</proc/config.gz> (since Linux 2.6)"
9769 #: build/C/man5/proc.5:1611
9771 "This file exposes the configuration options that were used to build the "
9772 "currently running kernel, in the same format as they would be shown in the "
9773 "I<.config> file that resulted when configuring the kernel (using I<make "
9774 "xconfig>, I<make config>, or similar). The file contents are compressed; "
9775 "view or search them using B<zcat>(1) and B<zgrep>(1). As long as no "
9776 "changes have been made to the following file, the contents of "
9777 "I</proc/config.gz> are the same as those provided by :"
9781 #: build/C/man5/proc.5:1615
9783 msgid "cat /lib/modules/$(uname -r)/build/.config\n"
9787 #: build/C/man5/proc.5:1621
9789 "I</proc/config.gz> is provided only if the kernel is configured with "
9790 "B<CONFIG_IKCONFIG_PROC>."
9794 #: build/C/man5/proc.5:1621
9796 msgid "I</proc/cpuinfo>"
9800 #: build/C/man5/proc.5:1633
9802 "This is a collection of CPU and system architecture dependent items, for "
9803 "each supported architecture a different list. Two common entries are "
9804 "I<processor> which gives CPU number and I<bogomips>; a system constant that "
9805 "is calculated during kernel initialization. SMP machines have information "
9806 "for each CPU. The B<lscpu>(1) command gathers its information from this "
9811 #: build/C/man5/proc.5:1633
9813 msgid "I</proc/devices>"
9817 #: build/C/man5/proc.5:1637
9819 "Text listing of major numbers and device groups. This can be used by "
9820 "MAKEDEV scripts for consistency with the kernel."
9824 #: build/C/man5/proc.5:1637
9826 msgid "I</proc/diskstats> (since Linux 2.5.69)"
9830 #: build/C/man5/proc.5:1643
9832 "This file contains disk I/O statistics for each disk device. See the Linux "
9833 "kernel source file I<Documentation/iostats.txt> for further information."
9837 #: build/C/man5/proc.5:1643
9839 msgid "I</proc/dma>"
9843 #: build/C/man5/proc.5:1647
9845 "This is a list of the registered I<ISA> DMA (direct memory access) channels "
9850 #: build/C/man5/proc.5:1647
9852 msgid "I</proc/driver>"
9856 #: build/C/man5/proc.5:1650 build/C/man5/proc.5:1678
9857 msgid "Empty subdirectory."
9861 #: build/C/man5/proc.5:1650
9863 msgid "I</proc/execdomains>"
9867 #: build/C/man5/proc.5:1653
9868 msgid "List of the execution domains (ABI personalities)."
9872 #: build/C/man5/proc.5:1653
9878 #: build/C/man5/proc.5:1658
9880 "Frame buffer information when B<CONFIG_FB> is defined during kernel "
9885 #: build/C/man5/proc.5:1658
9887 msgid "I</proc/filesystems>"
9891 #: build/C/man5/proc.5:1668
9893 "A text listing of the filesystems which are supported by the kernel, namely "
9894 "filesystems which were compiled into the kernel or whose kernel modules are "
9895 "currently loaded. (See also B<filesystems>(5).) If a filesystem is marked "
9896 "with \"nodev\", this means that it does not require a block device to be "
9897 "mounted (e.g., virtual filesystem, network filesystem)."
9901 #: build/C/man5/proc.5:1675
9903 "Incidentally, this file may be used by B<mount>(8) when no filesystem is "
9904 "specified and it didn't manage to determine the filesystem type. Then "
9905 "filesystems contained in this file are tried (excepted those that are marked "
9910 #: build/C/man5/proc.5:1675
9916 #: build/C/man5/proc.5:1678
9918 msgid "I</proc/ide>"
9922 #: build/C/man5/proc.5:1684
9924 "This directory exists on systems with the IDE bus. There are directories "
9925 "for each IDE channel and attached device. Files include:"
9929 #: build/C/man5/proc.5:1697
9932 "cache buffer size in KB\n"
9933 "capacity number of sectors\n"
9934 "driver driver version\n"
9935 "geometry physical and logical geometry\n"
9936 "identify in hexadecimal\n"
9937 "media media type\n"
9938 "model manufacturer's model number\n"
9939 "settings drive settings\n"
9940 "smart_thresholds in hexadecimal\n"
9941 "smart_values in hexadecimal\n"
9945 #: build/C/man5/proc.5:1703
9947 "The B<hdparm>(8) utility provides access to this information in a friendly "
9952 #: build/C/man5/proc.5:1703
9954 msgid "I</proc/interrupts>"
9958 #: build/C/man5/proc.5:1713
9960 "This is used to record the number of interrupts per CPU per IO device. "
9961 "Since Linux 2.6.24, for the i386 and x86_64 architectures, at least, this "
9962 "also includes interrupts internal to the system (that is, not associated "
9963 "with a device as such), such as NMI (nonmaskable interrupt), LOC (local "
9964 "timer interrupt), and for SMP systems, TLB (TLB flush interrupt), RES "
9965 "(rescheduling interrupt), CAL (remote function call interrupt), and possibly "
9966 "others. Very easy to read formatting, done in ASCII."
9970 #: build/C/man5/proc.5:1713
9972 msgid "I</proc/iomem>"
9976 #: build/C/man5/proc.5:1716
9977 msgid "I/O memory map in Linux 2.4."
9981 #: build/C/man5/proc.5:1716
9983 msgid "I</proc/ioports>"
9987 #: build/C/man5/proc.5:1720
9989 "This is a list of currently registered Input-Output port regions that are in "
9994 #: build/C/man5/proc.5:1720
9996 msgid "I</proc/kallsyms> (since Linux 2.5.71)"
10000 #: build/C/man5/proc.5:1728
10002 "This holds the kernel exported symbol definitions used by the B<modules>(X) "
10003 "tools to dynamically link and bind loadable modules. In Linux 2.5.47 and "
10004 "earlier, a similar file with slightly different syntax was named I<ksyms>."
10008 #: build/C/man5/proc.5:1728
10010 msgid "I</proc/kcore>"
10013 #. type: Plain text
10014 #: build/C/man5/proc.5:1737
10016 "This file represents the physical memory of the system and is stored in the "
10017 "ELF core file format. With this pseudo-file, and an unstripped kernel "
10018 "(I</usr/src/linux/vmlinux>) binary, GDB can be used to examine the current "
10019 "state of any kernel data structures."
10022 #. type: Plain text
10023 #: build/C/man5/proc.5:1740
10024 msgid "The total length of the file is the size of physical memory (RAM) plus 4KB."
10028 #: build/C/man5/proc.5:1740
10030 msgid "I</proc/kmsg>"
10033 #. type: Plain text
10034 #: build/C/man5/proc.5:1752
10036 "This file can be used instead of the B<syslog>(2) system call to read "
10037 "kernel messages. A process must have superuser privileges to read this "
10038 "file, and only one process should read this file. This file should not be "
10039 "read if a syslog process is running which uses the B<syslog>(2) system call "
10040 "facility to log kernel messages."
10043 #. type: Plain text
10044 #: build/C/man5/proc.5:1756
10045 msgid "Information in this file is retrieved with the B<dmesg>(1) program."
10049 #: build/C/man5/proc.5:1756
10051 msgid "I</proc/ksyms> (Linux 1.1.23-2.5.47)"
10054 #. type: Plain text
10055 #: build/C/man5/proc.5:1760
10056 msgid "See I</proc/kallsyms>."
10060 #: build/C/man5/proc.5:1760
10062 msgid "I</proc/loadavg>"
10065 #. type: Plain text
10066 #: build/C/man5/proc.5:1775
10068 "The first three fields in this file are load average figures giving the "
10069 "number of jobs in the run queue (state R) or waiting for disk I/O (state D) "
10070 "averaged over 1, 5, and 15 minutes. They are the same as the load average "
10071 "numbers given by B<uptime>(1) and other programs. The fourth field "
10072 "consists of two numbers separated by a slash (/). The first of these is the "
10073 "number of currently runnable kernel scheduling entities (processes, "
10074 "threads). The value after the slash is the number of kernel scheduling "
10075 "entities that currently exist on the system. The fifth field is the PID of "
10076 "the process that was most recently created on the system."
10080 #: build/C/man5/proc.5:1775
10082 msgid "I</proc/locks>"
10085 #. type: Plain text
10086 #: build/C/man5/proc.5:1781
10088 "This file shows current file locks (B<flock>(2) and B<fcntl>(2)) and leases "
10093 #: build/C/man5/proc.5:1781
10095 msgid "I</proc/malloc> (only up to and including Linux 2.2)"
10098 #. It looks like this only ever did something back in 1.0 days
10099 #. type: Plain text
10100 #: build/C/man5/proc.5:1787
10102 "This file is present only if B<CONFIG_DEBUG_MALLOC> was defined during "
10107 #: build/C/man5/proc.5:1787
10109 msgid "I</proc/meminfo>"
10112 #. type: Plain text
10113 #: build/C/man5/proc.5:1803
10115 "This file reports statistics about memory usage on the system. It is used "
10116 "by B<free>(1) to report the amount of free and used memory (both physical "
10117 "and swap) on the system as well as the shared memory and buffers used by "
10118 "the kernel. Each line of the file consists of a parameter name, followed by "
10119 "a colon, the value of the parameter, and an option unit of measurement "
10120 "(e.g., \"kB\"). The list below describes the parameter names and the format "
10121 "specifier required to read the field value. Except as noted below, all of "
10122 "the fields have been present since at least Linux 2.6.0. Some fileds are "
10123 "displayed only if the kernel was configured with various options; those "
10124 "dependencies are noted in the list."
10128 #: build/C/man5/proc.5:1804
10130 msgid "I<MemTotal> %lu"
10133 #. type: Plain text
10134 #: build/C/man5/proc.5:1808
10136 "Total usable RAM (i.e., physical RAM minus a few reserved bits and the "
10137 "kernel binary code)."
10141 #: build/C/man5/proc.5:1808
10143 msgid "I<MemFree> %lu"
10146 #. type: Plain text
10147 #: build/C/man5/proc.5:1812
10148 msgid "The sum of I<LowFree>+I<HighFree>."
10152 #: build/C/man5/proc.5:1812
10154 msgid "I<Buffers> %lu"
10157 #. type: Plain text
10158 #: build/C/man5/proc.5:1816
10160 "Relatively temporary storage for raw disk blocks that shouldn't get "
10161 "tremendously large (20MB or so)."
10165 #: build/C/man5/proc.5:1816
10167 msgid "I<Cached> %lu"
10170 #. type: Plain text
10171 #: build/C/man5/proc.5:1821
10173 "In-memory cache for files read from the disk (the page cache). Doesn't "
10174 "include I<SwapCached>."
10178 #: build/C/man5/proc.5:1821
10180 msgid "I<SwapCached> %lu"
10183 #. type: Plain text
10184 #: build/C/man5/proc.5:1829
10186 "Memory that once was swapped out, is swapped back in but still also is in "
10187 "the swap file. (If memory pressure is high, these pages don't need to be "
10188 "swapped out again because they are already in the swap file. This saves "
10193 #: build/C/man5/proc.5:1829
10195 msgid "I<Active> %lu"
10198 #. type: Plain text
10199 #: build/C/man5/proc.5:1833
10201 "Memory that has been used more recently and usually not reclaimed unless "
10202 "absolutely necessary."
10206 #: build/C/man5/proc.5:1833
10208 msgid "I<Inactive> %lu"
10211 #. type: Plain text
10212 #: build/C/man5/proc.5:1837
10214 "Memory which has been less recently used. It is more eligible to be "
10215 "reclaimed for other purposes."
10219 #: build/C/man5/proc.5:1837
10221 msgid "I<Active(anon)> %lu (since Linux 2.6.28)"
10224 #. type: Plain text
10225 #: build/C/man5/proc.5:1840 build/C/man5/proc.5:1843 build/C/man5/proc.5:1846 build/C/man5/proc.5:1849 build/C/man5/proc.5:1914
10226 msgid "[To be documented.]"
10230 #: build/C/man5/proc.5:1840
10232 msgid "I<Inactive(anon)> %lu (since Linux 2.6.28)"
10236 #: build/C/man5/proc.5:1843
10238 msgid "I<Active(file)> %lu (since Linux 2.6.28)"
10242 #: build/C/man5/proc.5:1846
10244 msgid "I<Inactive(file)> %lu (since Linux 2.6.28)"
10248 #: build/C/man5/proc.5:1849
10250 msgid "I<Unevictable> %lu (since Linux 2.6.28)"
10253 #. type: Plain text
10254 #: build/C/man5/proc.5:1854 build/C/man5/proc.5:1859
10256 "(From Linux 2.6.28 to 2.6.30, B<CONFIG_UNEVICTABLE_LRU> was required.) [To "
10261 #: build/C/man5/proc.5:1854
10263 msgid "I<Mlocked> %lu (since Linux 2.6.28)"
10267 #: build/C/man5/proc.5:1859
10269 msgid "I<HighTotal> %lu"
10272 #. type: Plain text
10273 #: build/C/man5/proc.5:1868
10275 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
10276 "of highmem. Highmem is all memory above ~860MB of physical memory. Highmem "
10277 "areas are for use by user-space programs, or for the page cache. The kernel "
10278 "must use tricks to access this memory, making it slower to access than "
10283 #: build/C/man5/proc.5:1868
10285 msgid "I<HighFree> %lu"
10288 #. type: Plain text
10289 #: build/C/man5/proc.5:1872
10291 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
10296 #: build/C/man5/proc.5:1872
10298 msgid "I<LowTotal> %lu"
10301 #. type: Plain text
10302 #: build/C/man5/proc.5:1884
10304 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Total amount "
10305 "of lowmem. Lowmem is memory which can be used for everything that highmem "
10306 "can be used for, but it is also available for the kernel's use for its own "
10307 "data structures. Among many other things, it is where everything from "
10308 "I<Slab> is allocated. Bad things happen when you're out of lowmem."
10312 #: build/C/man5/proc.5:1884
10314 msgid "I<LowFree> %lu"
10317 #. type: Plain text
10318 #: build/C/man5/proc.5:1888
10320 "(Starting with Linux 2.6.19, B<CONFIG_HIGHMEM> is required.) Amount of free "
10325 #: build/C/man5/proc.5:1888
10327 msgid "I<MmapCopy> %lu (since Linux 2.6.29)"
10330 #. type: Plain text
10331 #: build/C/man5/proc.5:1893
10332 msgid "(B<CONFIG_MMU> is required.) [To be documented.]"
10336 #: build/C/man5/proc.5:1893
10338 msgid "I<SwapTotal> %lu"
10341 #. type: Plain text
10342 #: build/C/man5/proc.5:1896
10343 msgid "Total amount of swap space available."
10347 #: build/C/man5/proc.5:1896
10349 msgid "I<SwapFree> %lu"
10352 #. type: Plain text
10353 #: build/C/man5/proc.5:1899
10354 msgid "Amount of swap space that is currently unused."
10358 #: build/C/man5/proc.5:1899
10360 msgid "I<Dirty> %lu"
10363 #. type: Plain text
10364 #: build/C/man5/proc.5:1902
10365 msgid "Memory which is waiting to get written back to the disk."
10369 #: build/C/man5/proc.5:1902
10371 msgid "I<Writeback> %lu"
10374 #. type: Plain text
10375 #: build/C/man5/proc.5:1905
10376 msgid "Memory which is actively being written back to the disk."
10380 #: build/C/man5/proc.5:1905
10382 msgid "I<AnonPages> %lu (since Linux 2.6.18)"
10385 #. type: Plain text
10386 #: build/C/man5/proc.5:1908
10387 msgid "Non-file backed pages mapped into user-space page tables."
10391 #: build/C/man5/proc.5:1908
10393 msgid "I<Mapped> %lu"
10396 #. type: Plain text
10397 #: build/C/man5/proc.5:1911
10398 msgid "Files which have been mmaped, such as libraries."
10402 #: build/C/man5/proc.5:1911
10404 msgid "I<Shmem> %lu (since Linux 2.6.32)"
10408 #: build/C/man5/proc.5:1914
10410 msgid "I<Slab> %lu"
10413 #. type: Plain text
10414 #: build/C/man5/proc.5:1917
10415 msgid "In-kernel data structures cache."
10419 #: build/C/man5/proc.5:1917
10421 msgid "I<SReclaimable> %lu (since Linux 2.6.19)"
10424 #. type: Plain text
10425 #: build/C/man5/proc.5:1922
10426 msgid "Part of I<Slab>, that might be reclaimed, such as caches."
10430 #: build/C/man5/proc.5:1922
10432 msgid "I<SUnreclaim> %lu (since Linux 2.6.19)"
10435 #. type: Plain text
10436 #: build/C/man5/proc.5:1927
10437 msgid "Part of I<Slab>, that cannot be reclaimed on memory pressure."
10441 #: build/C/man5/proc.5:1927
10443 msgid "I<KernelStack> %lu (since Linux 2.6.32)"
10446 #. type: Plain text
10447 #: build/C/man5/proc.5:1930
10448 msgid "Amount of memory allocated to kernel stacks."
10452 #: build/C/man5/proc.5:1930
10454 msgid "I<PageTables> %lu (since Linux 2.6.18)"
10457 #. type: Plain text
10458 #: build/C/man5/proc.5:1933
10459 msgid "Amount of memory dedicated to the lowest level of page tables."
10463 #: build/C/man5/proc.5:1933
10465 msgid "I<Quicklists> %lu (since Linux 2.6.27)"
10468 #. type: Plain text
10469 #: build/C/man5/proc.5:1937
10470 msgid "(B<CONFIG_QUICKLIST> is required.) [To be documented.]"
10474 #: build/C/man5/proc.5:1937
10476 msgid "I<NFS_Unstable> %lu (since Linux 2.6.18)"
10479 #. type: Plain text
10480 #: build/C/man5/proc.5:1940
10481 msgid "NFS pages sent to the server, but not yet committed to stable storage."
10485 #: build/C/man5/proc.5:1940
10487 msgid "I<Bounce> %lu (since Linux 2.6.18)"
10490 #. type: Plain text
10491 #: build/C/man5/proc.5:1943
10492 msgid "Memory used for block device \"bounce buffers\"."
10496 #: build/C/man5/proc.5:1943
10498 msgid "I<WritebackTmp> %lu (since Linux 2.6.26)"
10501 #. type: Plain text
10502 #: build/C/man5/proc.5:1946
10503 msgid "Memory used by FUSE for temporary writeback buffers."
10507 #: build/C/man5/proc.5:1946
10509 msgid "I<CommitLimit> %lu (since Linux 2.6.10)"
10512 #. type: Plain text
10513 #: build/C/man5/proc.5:1957
10515 "Based on the overcommit ratio ('vm.overcommit_ratio'), this is the total "
10516 "amount of memory currently available to be allocated on the system. This "
10517 "limit is adhered to only if strict overcommit accounting is enabled (mode 2 "
10518 "in I</proc/sys/vm/overcommit_ratio>). The I<CommitLimit> is calculated "
10519 "using the following formula:"
10522 #. type: Plain text
10523 #: build/C/man5/proc.5:1961
10527 " ([total RAM pages] - [total huge TLB pages]) *\n"
10528 " overcommit_ratio / 100 + [total swap pages]\n"
10531 #. type: Plain text
10532 #: build/C/man5/proc.5:1971
10534 "For example, on a system with 1GB of physical RAM and 7GB of swap with a "
10535 "I<overcommit_ratio> of 30, this formula yields a I<CommitLimit> of 7.3GB. "
10536 "For more details, see the memory overcommit documentation in the kernel "
10537 "source file I<Documentation/vm/overcommit-accounting>."
10541 #: build/C/man5/proc.5:1971
10543 msgid "I<Committed_AS> %lu"
10546 #. type: Plain text
10547 #: build/C/man5/proc.5:1991
10549 "The amount of memory presently allocated on the system. The committed "
10550 "memory is a sum of all of the memory which has been allocated by processes, "
10551 "even if it has not been \"used\" by them as of yet. A process which "
10552 "allocates 1GB of memory (using B<malloc>(3) or similar), but touches only "
10553 "300MB of that memory will show up as using only 300MB of memory even if it "
10554 "has the address space allocated for the entire 1GB. This 1GB is memory "
10555 "which has been \"committed\" to by the VM and can be used at any time by the "
10556 "allocating application. With strict overcommit enabled on the system (mode "
10557 "2 I</proc/sys/vm/overcommit_memory>), allocations which would exceed the "
10558 "I<CommitLimit> (detailed above) will not be permitted. This is useful if "
10559 "one needs to guarantee that processes will not fail due to lack of memory "
10560 "once that memory has been successfully allocated."
10564 #: build/C/man5/proc.5:1991
10566 msgid "I<VmallocTotal> %lu"
10569 #. type: Plain text
10570 #: build/C/man5/proc.5:1994
10571 msgid "Total size of vmalloc memory area."
10575 #: build/C/man5/proc.5:1994
10577 msgid "I<VmallocUsed> %lu"
10580 #. type: Plain text
10581 #: build/C/man5/proc.5:1997
10582 msgid "Amount of vmalloc area which is used."
10586 #: build/C/man5/proc.5:1997
10588 msgid "I<VmallocChunk> %lu"
10591 #. type: Plain text
10592 #: build/C/man5/proc.5:2000
10593 msgid "Largest contiguous block of vmalloc area which is free."
10597 #: build/C/man5/proc.5:2000
10599 msgid "I<HardwareCorrupted> %lu (since Linux 2.6.32)"
10602 #. type: Plain text
10603 #: build/C/man5/proc.5:2004
10604 msgid "(B<CONFIG_MEMORY_FAILURE> is required.) [To be documented.]"
10608 #: build/C/man5/proc.5:2004
10610 msgid "I<AnonHugePages> %lu (since Linux 2.6.38)"
10613 #. type: Plain text
10614 #: build/C/man5/proc.5:2008
10616 "(B<CONFIG_TRANSPARENT_HUGEPAGE> is required.) Non-file backed huge pages "
10617 "mapped into user-space page tables."
10621 #: build/C/man5/proc.5:2008
10623 msgid "I<HugePages_Total> %lu"
10626 #. type: Plain text
10627 #: build/C/man5/proc.5:2012
10628 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of the pool of huge pages."
10632 #: build/C/man5/proc.5:2012
10634 msgid "I<HugePages_Free> %lu"
10637 #. type: Plain text
10638 #: build/C/man5/proc.5:2016
10640 "(B<CONFIG_HUGETLB_PAGE> is required.) The number of huge pages in the pool "
10641 "that are not yet allocated."
10645 #: build/C/man5/proc.5:2016
10647 msgid "I<HugePages_Rsvd> %lu (since Linux 2.6.17)"
10650 #. type: Plain text
10651 #: build/C/man5/proc.5:2025
10653 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages for "
10654 "which a commitment to allocate from the pool has been made, but no "
10655 "allocation has yet been made. These reserved huge pages guarantee that an "
10656 "application will be able to allocate a huge page from the pool of huge pages "
10661 #: build/C/man5/proc.5:2025
10663 msgid "I<HugePages_Surp> %lu (since Linux 2.6.24)"
10666 #. type: Plain text
10667 #: build/C/man5/proc.5:2033
10669 "(B<CONFIG_HUGETLB_PAGE> is required.) This is the number of huge pages in "
10670 "the pool above the value in I</proc/sys/vm/nr_hugepages>. The maximum "
10671 "number of surplus huge pages is controlled by "
10672 "I</proc/sys/vm/nr_overcommit_hugepages>."
10676 #: build/C/man5/proc.5:2033
10678 msgid "I<Hugepagesize> %lu"
10681 #. type: Plain text
10682 #: build/C/man5/proc.5:2037
10683 msgid "(B<CONFIG_HUGETLB_PAGE> is required.) The size of huge pages."
10687 #: build/C/man5/proc.5:2038
10689 msgid "I</proc/modules>"
10692 #. type: Plain text
10693 #: build/C/man5/proc.5:2043
10695 "A text list of the modules that have been loaded by the system. See also "
10700 #: build/C/man5/proc.5:2043
10702 msgid "I</proc/mounts>"
10705 #. type: Plain text
10706 #: build/C/man5/proc.5:2053
10708 "Before kernel 2.4.19, this file was a list of all the filesystems currently "
10709 "mounted on the system. With the introduction of per-process mount "
10710 "namespaces in Linux 2.4.19, this file became a link to I</proc/self/mounts>, "
10711 "which lists the mount points of the process's own mount namespace. The "
10712 "format of this file is documented in B<fstab>(5)."
10716 #: build/C/man5/proc.5:2053
10718 msgid "I</proc/mtrr>"
10721 #. type: Plain text
10722 #: build/C/man5/proc.5:2059
10724 "Memory Type Range Registers. See the Linux kernel source file "
10725 "I<Documentation/mtrr.txt> for details."
10729 #: build/C/man5/proc.5:2059
10731 msgid "I</proc/net>"
10734 #. type: Plain text
10735 #: build/C/man5/proc.5:2069
10737 "various net pseudo-files, all of which give the status of some part of the "
10738 "networking layer. These files contain ASCII structures and are, therefore, "
10739 "readable with B<cat>(1). However, the standard B<netstat>(8) suite "
10740 "provides much cleaner access to these files."
10744 #: build/C/man5/proc.5:2069
10746 msgid "I</proc/net/arp>"
10749 #. type: Plain text
10750 #: build/C/man5/proc.5:2075
10752 "This holds an ASCII readable dump of the kernel ARP table used for address "
10753 "resolutions. It will show both dynamically learned and preprogrammed ARP "
10754 "entries. The format is:"
10757 #. type: Plain text
10758 #: build/C/man5/proc.5:2082
10761 "CW<IP address HW type Flags HW address Mask Device\n"
10762 "192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0\n"
10763 "192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0>\n"
10766 #. type: Plain text
10767 #: build/C/man5/proc.5:2094
10769 "Here \"IP address\" is the IPv4 address of the machine and the \"HW type\" "
10770 "is the hardware type of the address from RFC\\ 826. The flags are the "
10771 "internal flags of the ARP structure (as defined in "
10772 "I</usr/include/linux/if_arp.h>) and the \"HW address\" is the data link "
10773 "layer mapping for that IP address if it is known."
10777 #: build/C/man5/proc.5:2094
10779 msgid "I</proc/net/dev>"
10782 #. type: Plain text
10783 #: build/C/man5/proc.5:2105
10785 "The dev pseudo-file contains network device status information. This gives "
10786 "the number of received and sent packets, the number of errors and collisions "
10787 "and other basic statistics. These are used by the B<ifconfig>(8) program "
10788 "to report device status. The format is:"
10791 #. type: Plain text
10792 #: build/C/man5/proc.5:2115
10795 "CW<Inter-| Receive | "
10797 " face |bytes packets errs drop fifo frame compressed multicast|bytes "
10798 "packets errs drop fifo colls carrier compressed\n"
10799 " lo: 2776770 11307 0 0 0 0 0 0 2776770 "
10800 "11307 0 0 0 0 0 0\n"
10801 " eth0: 1215645 2751 0 0 0 0 0 0 1782404 "
10802 "4324 0 0 0 427 0 0\n"
10803 " ppp0: 1622270 5552 1 0 0 0 0 0 354130 "
10804 "5669 0 0 0 0 0 0\n"
10805 " tap0: 7714 81 0 0 0 0 0 0 7714 "
10806 "81 0 0 0 0 0 0>\n"
10810 #: build/C/man5/proc.5:2124
10812 msgid "I</proc/net/dev_mcast>"
10815 #. type: Plain text
10816 #: build/C/man5/proc.5:2128
10817 msgid "Defined in I</usr/src/linux/net/core/dev_mcast.c>:"
10820 #. type: Plain text
10821 #: build/C/man5/proc.5:2134
10824 "indx interface_name dmi_u dmi_g dmi_address\n"
10825 "2 eth0 1 0 01005e000001\n"
10826 "3 eth1 1 0 01005e000001\n"
10827 "4 eth2 1 0 01005e000001\n"
10831 #: build/C/man5/proc.5:2136
10833 msgid "I</proc/net/igmp>"
10836 #. type: Plain text
10837 #: build/C/man5/proc.5:2141
10839 "Internet Group Management Protocol. Defined in "
10840 "I</usr/src/linux/net/core/igmp.c>."
10844 #: build/C/man5/proc.5:2141
10846 msgid "I</proc/net/rarp>"
10849 #. type: Plain text
10850 #: build/C/man5/proc.5:2151
10852 "This file uses the same format as the I<arp> file and contains the current "
10853 "reverse mapping database used to provide B<rarp>(8) reverse address lookup "
10854 "services. If RARP is not configured into the kernel, this file will not be "
10859 #: build/C/man5/proc.5:2151
10861 msgid "I</proc/net/raw>"
10865 #. .I /proc/net/route
10866 #. No information, but looks similar to
10868 #. type: Plain text
10869 #: build/C/man5/proc.5:2171
10871 "Holds a dump of the RAW socket table. Much of the information is not of use "
10872 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
10873 "socket, the \"local_address\" is the local address and protocol number "
10874 "pair. \\&\"St\" is the internal status of the socket. The \"tx_queue\" and "
10875 "\"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
10876 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
10877 "used by RAW. The \"uid\" field holds the effective UID of the creator of "
10882 #: build/C/man5/proc.5:2171
10884 msgid "I</proc/net/snmp>"
10887 #. type: Plain text
10888 #: build/C/man5/proc.5:2176
10890 "This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP "
10891 "management information bases for an SNMP agent."
10895 #: build/C/man5/proc.5:2176
10897 msgid "I</proc/net/tcp>"
10900 #. type: Plain text
10901 #: build/C/man5/proc.5:2192
10903 "Holds a dump of the TCP socket table. Much of the information is not of use "
10904 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
10905 "socket, the \"local_address\" is the local address and port number pair. "
10906 "The \"rem_address\" is the remote address and port number pair (if "
10907 "connected). \\&\"St\" is the internal status of the socket. The "
10908 "\"tx_queue\" and \"rx_queue\" are the outgoing and incoming data queue in "
10909 "terms of kernel memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" "
10910 "fields hold internal information of the kernel socket state and are only "
10911 "useful for debugging. The \"uid\" field holds the effective UID of the "
10912 "creator of the socket."
10916 #: build/C/man5/proc.5:2192
10918 msgid "I</proc/net/udp>"
10921 #. type: Plain text
10922 #: build/C/man5/proc.5:2208
10924 "Holds a dump of the UDP socket table. Much of the information is not of use "
10925 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
10926 "socket, the \"local_address\" is the local address and port number pair. "
10927 "The \"rem_address\" is the remote address and port number pair (if "
10928 "connected). \"St\" is the internal status of the socket. The \"tx_queue\" "
10929 "and \"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
10930 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
10931 "used by UDP. The \"uid\" field holds the effective UID of the creator of "
10932 "the socket. The format is:"
10935 #. type: Plain text
10936 #: build/C/man5/proc.5:2216
10939 "CW<sl local_address rem_address st tx_queue rx_queue tr rexmits "
10940 "tm-E<gt>when uid\n"
10941 " 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 "
10943 " 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 "
10945 " 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 "
10950 #: build/C/man5/proc.5:2219
10952 msgid "I</proc/net/unix>"
10955 #. type: Plain text
10956 #: build/C/man5/proc.5:2224
10958 "Lists the UNIX domain sockets present within the system and their status. "
10962 #. type: Plain text
10963 #: build/C/man5/proc.5:2230
10966 "CW<Num RefCount Protocol Flags Type St Path\n"
10967 " 0: 00000002 00000000 00000000 0001 03\n"
10968 " 1: 00000001 00000000 00010000 0001 01 /dev/printer>\n"
10971 #. type: Plain text
10972 #: build/C/man5/proc.5:2242
10974 "Here \"Num\" is the kernel table slot number, \"RefCount\" is the number of "
10975 "users of the socket, \"Protocol\" is currently always 0, \"Flags\" represent "
10976 "the internal kernel flags holding the status of the socket. Currently, type "
10977 "is always \"1\" (UNIX domain datagram sockets are not yet supported in the "
10978 "kernel). \\&\"St\" is the internal state of the socket and Path is the "
10979 "bound path (if any) of the socket."
10983 #: build/C/man5/proc.5:2242
10985 msgid "I</proc/partitions>"
10988 #. type: Plain text
10989 #: build/C/man5/proc.5:2246
10991 "Contains the major and minor numbers of each partition as well as the number "
10992 "of 1024-byte blocks and the partition name."
10996 #: build/C/man5/proc.5:2246
10998 msgid "I</proc/pci>"
11001 #. type: Plain text
11002 #: build/C/man5/proc.5:2250
11004 "This is a listing of all PCI devices found during kernel initialization and "
11005 "their configuration."
11008 #. FIXME /proc/sched_debug
11010 #. .IR /proc/sched_debug " (since Linux 2.6.23)"
11011 #. See also /proc/[pid]/sched
11012 #. type: Plain text
11013 #: build/C/man5/proc.5:2266
11015 "This file has been deprecated in favor of a new I</proc> interface for PCI "
11016 "(I</proc/bus/pci>). It became optional in Linux 2.2 (available with "
11017 "B<CONFIG_PCI_OLD_PROC> set at kernel compilation). It became once more "
11018 "nonoptionally enabled in Linux 2.4. Next, it was deprecated in Linux 2.6 "
11019 "(still available with B<CONFIG_PCI_LEGACY_PROC> set), and finally removed "
11020 "altogether since Linux 2.6.17."
11024 #: build/C/man5/proc.5:2266
11026 msgid "I</proc/profile> (since Linux 2.4)"
11029 #. type: Plain text
11030 #: build/C/man5/proc.5:2278
11032 "This file is present only if the kernel was booted with the I<profile=1> "
11033 "command-line option. It exposes kernel profiling information in a binary "
11034 "format for use by B<readprofile>(1). Writing (e.g., an empty string) to "
11035 "this file resets the profiling counters; on some architectures, writing a "
11036 "binary integer \"profiling multiplier\" of size I<sizeof(int)> sets the "
11037 "profiling interrupt frequency."
11041 #: build/C/man5/proc.5:2278
11043 msgid "I</proc/scsi>"
11046 #. type: Plain text
11047 #: build/C/man5/proc.5:2288
11049 "A directory with the I<scsi> mid-level pseudo-file and various SCSI "
11050 "low-level driver directories, which contain a file for each SCSI host in "
11051 "this system, all of which give the status of some part of the SCSI IO "
11052 "subsystem. These files contain ASCII structures and are, therefore, "
11053 "readable with B<cat>(1)."
11056 #. type: Plain text
11057 #: build/C/man5/proc.5:2291
11059 "You can also write to some of the files to reconfigure the subsystem or "
11060 "switch certain features on or off."
11064 #: build/C/man5/proc.5:2291
11066 msgid "I</proc/scsi/scsi>"
11069 #. type: Plain text
11070 #: build/C/man5/proc.5:2297
11072 "This is a listing of all SCSI devices known to the kernel. The listing is "
11073 "similar to the one seen during bootup. scsi currently supports only the "
11074 "I<add-single-device> command which allows root to add a hotplugged device to "
11075 "the list of known devices."
11078 #. type: Plain text
11079 #: build/C/man5/proc.5:2299
11080 msgid "The command"
11083 #. type: Plain text
11084 #: build/C/man5/proc.5:2303
11086 msgid "echo \\(aqscsi add-single-device 1 0 5 0\\(aq E<gt> /proc/scsi/scsi\n"
11089 #. type: Plain text
11090 #: build/C/man5/proc.5:2311
11092 "will cause host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. "
11093 "If there is already a device known on this address or the address is "
11094 "invalid, an error will be returned."
11098 #: build/C/man5/proc.5:2311
11100 msgid "I</proc/scsi/[drivername]>"
11103 #. type: Plain text
11104 #: build/C/man5/proc.5:2321
11106 "I<[drivername]> can currently be NCR53c7xx, aha152x, aha1542, aha1740, "
11107 "aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, "
11108 "scsi_debug, seagate, t128, u15-24f, ultrastore, or wd7000. These "
11109 "directories show up for all drivers that registered at least one SCSI HBA. "
11110 "Every directory contains one file per registered host. Every host-file is "
11111 "named after the number the host was assigned during initialization."
11114 #. type: Plain text
11115 #: build/C/man5/proc.5:2324
11117 "Reading these files will usually show driver and host configuration, "
11118 "statistics, and so on."
11121 #. type: Plain text
11122 #: build/C/man5/proc.5:2331
11124 "Writing to these files allows different things on different hosts. For "
11125 "example, with the I<latency> and I<nolatency> commands, root can switch on "
11126 "and off command latency measurement code in the eata_dma driver. With the "
11127 "I<lockup> and I<unlock> commands, root can control bus lockups simulated by "
11128 "the scsi_debug driver."
11132 #: build/C/man5/proc.5:2331
11134 msgid "I</proc/self>"
11137 #. type: Plain text
11138 #: build/C/man5/proc.5:2339
11140 "This directory refers to the process accessing the I</proc> filesystem, and "
11141 "is identical to the I</proc> directory named by the process ID of the same "
11146 #: build/C/man5/proc.5:2339
11148 msgid "I</proc/slabinfo>"
11151 #. type: Plain text
11152 #: build/C/man5/proc.5:2348
11154 "Information about kernel caches. Since Linux 2.6.16 this file is present "
11155 "only if the B<CONFIG_SLAB> kernel configuration option is enabled. The "
11156 "columns in I</proc/slabinfo> are:"
11159 #. type: Plain text
11160 #: build/C/man5/proc.5:2358
11164 "num-active-objs\n"
11167 "num-active-slabs\n"
11169 "num-pages-per-slab\n"
11172 #. type: Plain text
11173 #: build/C/man5/proc.5:2364
11174 msgid "See B<slabinfo>(5) for details."
11178 #: build/C/man5/proc.5:2364
11180 msgid "I</proc/stat>"
11183 #. type: Plain text
11184 #: build/C/man5/proc.5:2370
11186 "kernel/system statistics. Varies with architecture. Common entries "
11191 #: build/C/man5/proc.5:2371
11193 msgid "I<cpu 3357 0 4313 1362393>"
11196 #. 1024 on Alpha and ia64
11197 #. type: Plain text
11198 #: build/C/man5/proc.5:2379
11200 "The amount of time, measured in units of USER_HZ (1/100ths of a second on "
11201 "most architectures, use I<sysconf(_SC_CLK_TCK)> to obtain the right value), "
11202 "that the system spent in various states:"
11206 #: build/C/man5/proc.5:2380
11211 #. type: Plain text
11212 #: build/C/man5/proc.5:2383
11213 msgid "(1) Time spent in user mode."
11217 #: build/C/man5/proc.5:2383
11222 #. type: Plain text
11223 #: build/C/man5/proc.5:2386
11224 msgid "(2) Time spent in user mode with low priority (nice)."
11228 #: build/C/man5/proc.5:2386
11233 #. type: Plain text
11234 #: build/C/man5/proc.5:2389
11235 msgid "(3) Time spent in system mode."
11239 #: build/C/man5/proc.5:2389
11244 #. FIXME Actually, the following info about the /proc/stat 'cpu' field
11245 #. does not seem to be quite right (at least in 2.6.12 or 3.6):
11246 #. the idle time in /proc/uptime does not quite match this value
11247 #. type: Plain text
11248 #: build/C/man5/proc.5:2399
11250 "(4) Time spent in the idle task. This value should be USER_HZ times the "
11251 "second entry in the I</proc/uptime> pseudo-file."
11255 #: build/C/man5/proc.5:2399
11257 msgid "I<iowait> (since Linux 2.5.41)"
11260 #. type: Plain text
11261 #: build/C/man5/proc.5:2402
11262 msgid "(5) Time waiting for I/O to complete."
11266 #: build/C/man5/proc.5:2402
11268 msgid "I<irq> (since Linux 2.6.0-test4)"
11271 #. type: Plain text
11272 #: build/C/man5/proc.5:2405
11273 msgid "(6) Time servicing interrupts."
11277 #: build/C/man5/proc.5:2405
11279 msgid "I<softirq> (since Linux 2.6.0-test4)"
11282 #. type: Plain text
11283 #: build/C/man5/proc.5:2408
11284 msgid "(7) Time servicing softirqs."
11288 #: build/C/man5/proc.5:2408
11290 msgid "I<steal> (since Linux 2.6.11)"
11293 #. type: Plain text
11294 #: build/C/man5/proc.5:2412
11296 "(8) Stolen time, which is the time spent in other operating systems when "
11297 "running in a virtualized environment"
11301 #: build/C/man5/proc.5:2412
11303 msgid "I<guest> (since Linux 2.6.24)"
11306 #. See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de
11307 #. type: Plain text
11308 #: build/C/man5/proc.5:2417
11310 "(9) Time spent running a virtual CPU for guest operating systems under the "
11311 "control of the Linux kernel."
11315 #: build/C/man5/proc.5:2417
11317 msgid "I<guest_nice> (since Linux 2.6.33)"
11320 #. commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797
11321 #. type: Plain text
11322 #: build/C/man5/proc.5:2422
11324 "(10) Time spent running a niced guest (virtual CPU for guest operating "
11325 "systems under the control of the Linux kernel)."
11329 #: build/C/man5/proc.5:2423
11331 msgid "I<page 5741 1808>"
11334 #. type: Plain text
11335 #: build/C/man5/proc.5:2427
11337 "The number of pages the system paged in and the number that were paged out "
11342 #: build/C/man5/proc.5:2427
11344 msgid "I<swap 1 0>"
11347 #. type: Plain text
11348 #: build/C/man5/proc.5:2430
11349 msgid "The number of swap pages that have been brought in and out."
11352 #. FIXME The following is not the full picture for the 'intr' of
11353 #. /proc/stat on 2.6:
11355 #: build/C/man5/proc.5:2430
11357 msgid "I<intr 1462898>"
11360 #. type: Plain text
11361 #: build/C/man5/proc.5:2438
11363 "This line shows counts of interrupts serviced since boot time, for each of "
11364 "the possible system interrupts. The first column is the total of all "
11365 "interrupts serviced; each subsequent column is the total for a particular "
11370 #: build/C/man5/proc.5:2438
11372 msgid "I<disk_io: (2,0):(31,30,5764,1,2) (3,0):>..."
11375 #. type: Plain text
11376 #: build/C/man5/proc.5:2441
11378 "(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, "
11382 #. type: Plain text
11383 #: build/C/man5/proc.5:2443
11384 msgid "(Linux 2.4 only)"
11388 #: build/C/man5/proc.5:2443
11390 msgid "I<ctxt 115315>"
11393 #. type: Plain text
11394 #: build/C/man5/proc.5:2446
11395 msgid "The number of context switches that the system underwent."
11399 #: build/C/man5/proc.5:2446
11401 msgid "I<btime 769041601>"
11404 #. type: Plain text
11405 #: build/C/man5/proc.5:2449
11406 msgid "boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
11410 #: build/C/man5/proc.5:2449
11412 msgid "I<processes 86031>"
11415 #. type: Plain text
11416 #: build/C/man5/proc.5:2452
11417 msgid "Number of forks since boot."
11421 #: build/C/man5/proc.5:2452
11423 msgid "I<procs_running 6>"
11426 #. type: Plain text
11427 #: build/C/man5/proc.5:2456
11428 msgid "Number of processes in runnable state. (Linux 2.5.45 onward.)"
11432 #: build/C/man5/proc.5:2456
11434 msgid "I<procs_blocked 2>"
11437 #. type: Plain text
11438 #: build/C/man5/proc.5:2460
11440 "Number of processes blocked waiting for I/O to complete. (Linux 2.5.45 "
11445 #: build/C/man5/proc.5:2461
11447 msgid "I</proc/swaps>"
11450 #. type: Plain text
11451 #: build/C/man5/proc.5:2466
11452 msgid "Swap areas in use. See also B<swapon>(8)."
11456 #: build/C/man5/proc.5:2466
11458 msgid "I</proc/sys>"
11461 #. type: Plain text
11462 #: build/C/man5/proc.5:2474
11464 "This directory (present since 1.3.57) contains a number of files and "
11465 "subdirectories corresponding to kernel variables. These variables can be "
11466 "read and sometimes modified using the I</proc> filesystem, and the "
11467 "(deprecated) B<sysctl>(2) system call."
11471 #: build/C/man5/proc.5:2474
11473 msgid "I</proc/sys/abi> (since Linux 2.4.10)"
11476 #. On some systems, it is not present.
11477 #. type: Plain text
11478 #: build/C/man5/proc.5:2481
11480 "This directory may contain files with application binary information. See "
11481 "the Linux kernel source file I<Documentation/sysctl/abi.txt> for more "
11486 #: build/C/man5/proc.5:2481
11488 msgid "I</proc/sys/debug>"
11491 #. type: Plain text
11492 #: build/C/man5/proc.5:2484 build/C/man5/proc.5:3329
11493 msgid "This directory may be empty."
11497 #: build/C/man5/proc.5:2484
11499 msgid "I</proc/sys/dev>"
11502 #. type: Plain text
11503 #: build/C/man5/proc.5:2490
11505 "This directory contains device-specific information (e.g., "
11506 "I<dev/cdrom/info>). On some systems, it may be empty."
11510 #: build/C/man5/proc.5:2490
11512 msgid "I</proc/sys/fs>"
11515 #. type: Plain text
11516 #: build/C/man5/proc.5:2494
11518 "This directory contains the files and subdirectories for kernel variables "
11519 "related to filesystems."
11523 #: build/C/man5/proc.5:2494
11525 msgid "I</proc/sys/fs/binfmt_misc>"
11528 #. type: Plain text
11529 #: build/C/man5/proc.5:2499
11531 "Documentation for files in this directory can be found in the Linux kernel "
11532 "sources in I<Documentation/binfmt_misc.txt>."
11536 #: build/C/man5/proc.5:2499
11538 msgid "I</proc/sys/fs/dentry-state> (since Linux 2.2)"
11541 #. type: Plain text
11542 #: build/C/man5/proc.5:2507
11544 "This file contains information about the status of the directory cache "
11545 "(dcache). The file contains six numbers, I<nr_dentry>, I<nr_unused>, "
11546 "I<age_limit> (age in seconds), I<want_pages> (pages requested by system) and "
11547 "two dummy values."
11550 #. type: Plain text
11551 #: build/C/man5/proc.5:2512
11553 "I<nr_dentry> is the number of allocated dentries (dcache entries). This "
11554 "field is unused in Linux 2.2."
11557 #. type: Plain text
11558 #: build/C/man5/proc.5:2515
11559 msgid "I<nr_unused> is the number of unused dentries."
11562 #. looks like this is unused in kernels 2.2 to 2.6
11563 #. type: Plain text
11564 #: build/C/man5/proc.5:2520
11566 "I<age_limit> is the age in seconds after which dcache entries can be "
11567 "reclaimed when memory is short."
11570 #. looks like this is unused in kernels 2.2 to 2.6
11571 #. type: Plain text
11572 #: build/C/man5/proc.5:2525
11574 "I<want_pages> is nonzero when the kernel has called shrink_dcache_pages() "
11575 "and the dcache isn't pruned yet."
11579 #: build/C/man5/proc.5:2526
11581 msgid "I</proc/sys/fs/dir-notify-enable>"
11584 #. type: Plain text
11585 #: build/C/man5/proc.5:2535
11587 "This file can be used to disable or enable the I<dnotify> interface "
11588 "described in B<fcntl>(2) on a system-wide basis. A value of 0 in this file "
11589 "disables the interface, and a value of 1 enables it."
11593 #: build/C/man5/proc.5:2535
11595 msgid "I</proc/sys/fs/dquot-max>"
11598 #. type: Plain text
11599 #: build/C/man5/proc.5:2542
11601 "This file shows the maximum number of cached disk quota entries. On some "
11602 "(2.4) systems, it is not present. If the number of free cached disk quota "
11603 "entries is very low and you have some awesome number of simultaneous system "
11604 "users, you might want to raise the limit."
11608 #: build/C/man5/proc.5:2542
11610 msgid "I</proc/sys/fs/dquot-nr>"
11613 #. type: Plain text
11614 #: build/C/man5/proc.5:2546
11616 "This file shows the number of allocated disk quota entries and the number of "
11617 "free disk quota entries."
11621 #: build/C/man5/proc.5:2546
11623 msgid "I</proc/sys/fs/epoll> (since Linux 2.6.28)"
11626 #. type: Plain text
11627 #: build/C/man5/proc.5:2555
11629 "This directory contains the file I<max_user_watches>, which can be used to "
11630 "limit the amount of kernel memory consumed by the I<epoll> interface. For "
11631 "further details, see B<epoll>(7)."
11635 #: build/C/man5/proc.5:2555
11637 msgid "I</proc/sys/fs/file-max>"
11640 #. type: Plain text
11641 #: build/C/man5/proc.5:2568
11643 "This file defines a system-wide limit on the number of open files for all "
11644 "processes. (See also B<setrlimit>(2), which can be used by a process to set "
11645 "the per-process limit, B<RLIMIT_NOFILE>, on the number of files it may "
11646 "open.) If you get lots of error messages in the kernel log about running "
11647 "out of file handles (look for \"VFS: file-max limit E<lt>numberE<gt> "
11648 "reached\"), try increasing this value:"
11651 #. type: Plain text
11652 #: build/C/man5/proc.5:2574
11654 msgid "CW< echo 100000 E<gt> /proc/sys/fs/file-max>\n"
11657 #. type: Plain text
11658 #: build/C/man5/proc.5:2581
11660 "The kernel constant B<NR_OPEN> imposes an upper limit on the value that may "
11661 "be placed in I<file-max>."
11664 #. type: Plain text
11665 #: build/C/man5/proc.5:2587
11666 msgid "Privileged processes (B<CAP_SYS_ADMIN>) can override the I<file-max> limit."
11670 #: build/C/man5/proc.5:2587
11672 msgid "I</proc/sys/fs/file-nr>"
11675 #. type: Plain text
11676 #: build/C/man5/proc.5:2606
11678 "This (read-only) file contains three numbers: the number of allocated file "
11679 "handles (i.e., the number of files presently opened); the number of free "
11680 "file handles; and the maximum number of file handles (i.e., the same value "
11681 "as I</proc/sys/fs/file-max>). If the number of allocated file handles is "
11682 "close to the maximum, you should consider increasing the maximum. Before "
11683 "Linux 2.6, the kernel allocated file handles dynamically, but it didn't free "
11684 "them again. Instead the free file handles were kept in a list for "
11685 "reallocation; the \"free file handles\" value indicates the size of that "
11686 "list. A large number of free file handles indicates that there was a past "
11687 "peak in the usage of open file handles. Since Linux 2.6, the kernel does "
11688 "deallocate freed file handles, and the \"free file handles\" value is always "
11693 #: build/C/man5/proc.5:2606
11695 msgid "I</proc/sys/fs/inode-max> (only present until Linux 2.2)"
11698 #. type: Plain text
11699 #: build/C/man5/proc.5:2615
11701 "This file contains the maximum number of in-memory inodes. This value "
11702 "should be 3-4 times larger than the value in I<file-max>, since I<stdin>, "
11703 "I<stdout> and network sockets also need an inode to handle them. When you "
11704 "regularly run out of inodes, you need to increase this value."
11707 #. type: Plain text
11708 #: build/C/man5/proc.5:2619
11710 "Starting with Linux 2.4, there is no longer a static limit on the number of "
11711 "inodes, and this file is removed."
11715 #: build/C/man5/proc.5:2619
11717 msgid "I</proc/sys/fs/inode-nr>"
11720 #. type: Plain text
11721 #: build/C/man5/proc.5:2623
11722 msgid "This file contains the first two values from I<inode-state>."
11726 #: build/C/man5/proc.5:2623
11728 msgid "I</proc/sys/fs/inode-state>"
11731 #. type: Plain text
11732 #: build/C/man5/proc.5:2631
11734 "This file contains seven numbers: I<nr_inodes>, I<nr_free_inodes>, "
11735 "I<preshrink>, and four dummy values (always zero)."
11738 #. This can be slightly more than
11740 #. because Linux allocates them one page full at a time.
11741 #. type: Plain text
11742 #: build/C/man5/proc.5:2639
11744 "I<nr_inodes> is the number of inodes the system has allocated. "
11745 "I<nr_free_inodes> represents the number of free inodes."
11748 #. type: Plain text
11749 #: build/C/man5/proc.5:2647
11751 "I<preshrink> is nonzero when the I<nr_inodes> E<gt> I<inode-max> and the "
11752 "system needs to prune the inode list instead of allocating more; since Linux "
11753 "2.4, this field is a dummy value (always zero)."
11757 #: build/C/man5/proc.5:2647
11759 msgid "I</proc/sys/fs/inotify> (since Linux 2.6.13)"
11762 #. type: Plain text
11763 #: build/C/man5/proc.5:2656
11765 "This directory contains files I<max_queued_events>, I<max_user_instances>, "
11766 "and I<max_user_watches>, that can be used to limit the amount of kernel "
11767 "memory consumed by the I<inotify> interface. For further details, see "
11772 #: build/C/man5/proc.5:2656
11774 msgid "I</proc/sys/fs/lease-break-time>"
11777 #. type: Plain text
11778 #: build/C/man5/proc.5:2665
11780 "This file specifies the grace period that the kernel grants to a process "
11781 "holding a file lease (B<fcntl>(2)) after it has sent a signal to that "
11782 "process notifying it that another process is waiting to open the file. If "
11783 "the lease holder does not remove or downgrade the lease within this grace "
11784 "period, the kernel forcibly breaks the lease."
11788 #: build/C/man5/proc.5:2665
11790 msgid "I</proc/sys/fs/leases-enable>"
11793 #. type: Plain text
11794 #: build/C/man5/proc.5:2672
11796 "This file can be used to enable or disable file leases (B<fcntl>(2)) on a "
11797 "system-wide basis. If this file contains the value 0, leases are disabled. "
11798 "A nonzero value enables leases."
11802 #: build/C/man5/proc.5:2672
11804 msgid "I</proc/sys/fs/mqueue> (since Linux 2.6.6)"
11807 #. type: Plain text
11808 #: build/C/man5/proc.5:2680
11810 "This directory contains files I<msg_max>, I<msgsize_max>, and I<queues_max>, "
11811 "controlling the resources used by POSIX message queues. See "
11812 "B<mq_overview>(7) for details."
11816 #: build/C/man5/proc.5:2680
11818 msgid "I</proc/sys/fs/overflowgid> and I</proc/sys/fs/overflowuid>"
11821 #. type: Plain text
11822 #: build/C/man5/proc.5:2690
11824 "These files allow you to change the value of the fixed UID and GID. The "
11825 "default is 65534. Some filesystems support only 16-bit UIDs and GIDs, "
11826 "although in Linux UIDs and GIDs are 32 bits. When one of these filesystems "
11827 "is mounted with writes enabled, any UID or GID that would exceed 65535 is "
11828 "translated to the overflow value before being written to disk."
11832 #: build/C/man5/proc.5:2690
11834 msgid "I</proc/sys/fs/pipe-max-size> (since Linux 2.6.35)"
11837 #. type: Plain text
11838 #: build/C/man5/proc.5:2704
11840 "The value in this file defines an upper limit for raising the capacity of a "
11841 "pipe using the B<fcntl>(2) B<F_SETPIPE_SZ> operation. This limit applies "
11842 "only to unprivileged processes. The default value for this file is "
11843 "1,048,576. The value assigned to this file may be rounded upward, to "
11844 "reflect the value actually employed for a convenient implementation. To "
11845 "determine the rounded-up value, display the contents of this file after "
11846 "assigning a value to it. The minimum value that can be assigned to this "
11847 "file is the system page size."
11851 #: build/C/man5/proc.5:2704
11853 msgid "I</proc/sys/fs/protected_hardlinks> (since Linux 3.6)"
11856 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
11857 #. type: Plain text
11858 #: build/C/man5/proc.5:2713
11860 "When the value in this file is 0, no restrictions are placed on the creation "
11861 "of hard links (i.e., this is the historical behaviour before Linux 3.6). "
11862 "When the value in this file is 1, a hard link can be created to a target "
11863 "file only if one of the following conditions is true:"
11866 #. type: Plain text
11867 #: build/C/man5/proc.5:2718
11868 msgid "The caller has the B<CAP_FOWNER> capability."
11871 #. type: Plain text
11872 #: build/C/man5/proc.5:2724
11874 "The filesystem UID of the process creating the link matches the owner (UID) "
11875 "of the target file (as described in B<credentials>(7), a process's "
11876 "filesystem UID is normally the same as its effective UID)."
11879 #. type: Plain text
11880 #: build/C/man5/proc.5:2726
11881 msgid "All of the following conditions are true:"
11884 #. type: Plain text
11885 #: build/C/man5/proc.5:2729
11886 msgid "the target is a regular file;"
11889 #. type: Plain text
11890 #: build/C/man5/proc.5:2731
11891 msgid "the target file does not have its set-user-ID permission bit enabled;"
11894 #. type: Plain text
11895 #: build/C/man5/proc.5:2734
11897 "the target file does not have both its set-group-ID and group-executable "
11898 "permission bits enabled; and"
11901 #. type: Plain text
11902 #: build/C/man5/proc.5:2738
11904 "the caller has permission to read and write the target file (either via the "
11905 "file's permissions mask or because it has suitable capabilities)."
11908 #. type: Plain text
11909 #: build/C/man5/proc.5:2754
11911 "The default value in this file is 0. Setting the value to 1 prevents a "
11912 "longstanding class of security issues caused by hard-link-based "
11913 "time-of-check, time-of-use races, most commonly seen in world-writable "
11914 "directories such as I</tmp>. The common method of exploiting this flaw is "
11915 "to cross privilege boundaries when following a given hard link (i.e., a root "
11916 "process follows a hard link created by another user). Additionally, on "
11917 "systems without separated partitions, this stops unauthorized users from "
11918 "\"pinning\" vulnerable set-user-ID and set-group-ID files against being "
11919 "upgraded by the administrator, or linking to special files."
11923 #: build/C/man5/proc.5:2754
11925 msgid "I</proc/sys/fs/protected_symlinks> (since Linux 3.6)"
11928 #. commit 800179c9b8a1e796e441674776d11cd4c05d61d7
11929 #. type: Plain text
11930 #: build/C/man5/proc.5:2762
11932 "When the value in this file is 0, no restrictions are placed on following "
11933 "symbolic links (i.e., this is the historical behaviour before Linux 3.6). "
11934 "When the value in this file is 1, symbolic links are followed only in the "
11935 "following circumstances:"
11938 #. type: Plain text
11939 #: build/C/man5/proc.5:2769
11941 "the filesystem UID of the process following the link matches the owner (UID) "
11942 "of the symbolic link (as described in B<credentials>(7), a process's "
11943 "filesystem UID is normally the same as its effective UID);"
11946 #. type: Plain text
11947 #: build/C/man5/proc.5:2771
11948 msgid "the link is not in a sticky world-writable directory; or"
11951 #. type: Plain text
11952 #: build/C/man5/proc.5:2773
11953 msgid "the symbolic link and its parent directory have the same owner (UID)"
11956 #. type: Plain text
11957 #: build/C/man5/proc.5:2780
11959 "A system call that fails to follow a symbolic link because of the above "
11960 "restrictions returns the error B<EACCES> in I<errno>."
11963 #. type: Plain text
11964 #: build/C/man5/proc.5:2784
11966 "The default value in this file is 0. Setting the value to 1 avoids a "
11967 "longstanding class of security issues based on time-of-check, time-of-use "
11968 "races when accessing symbolic links."
11972 #: build/C/man5/proc.5:2784
11974 msgid "I</proc/sys/fs/suid_dumpable> (since Linux 2.6.13)"
11977 #. The following is based on text from Documentation/sysctl/kernel.txt
11978 #. type: Plain text
11979 #: build/C/man5/proc.5:2790
11981 "The value in this file determines whether core dump files are produced for "
11982 "set-user-ID or otherwise protected/tainted binaries. Three different "
11983 "integer values can be specified:"
11987 #: build/C/man5/proc.5:2791
11989 msgid "I<0\\ (default)>"
11992 #. type: Plain text
11993 #: build/C/man5/proc.5:2800
11995 "This provides the traditional (pre-Linux 2.6.13) behavior. A core dump will "
11996 "not be produced for a process which has changed credentials (by calling "
11997 "B<seteuid>(2), B<setgid>(2), or similar, or by executing a set-user-ID or "
11998 "set-group-ID program) or whose binary does not have read permission "
12003 #: build/C/man5/proc.5:2800
12005 msgid "I<1\\ (\"debug\")>"
12008 #. type: Plain text
12009 #: build/C/man5/proc.5:2807
12011 "All processes dump core when possible. The core dump is owned by the "
12012 "filesystem user ID of the dumping process and no security is applied. This "
12013 "is intended for system debugging situations only. Ptrace is unchecked."
12017 #: build/C/man5/proc.5:2807
12019 msgid "I<2\\ (\"suidsafe\")>"
12022 #. type: Plain text
12023 #: build/C/man5/proc.5:2816
12025 "Any binary which normally would not be dumped (see \"0\" above) is dumped "
12026 "readable by root only. This allows the user to remove the core dump file "
12027 "but not to read it. For security reasons core dumps in this mode will not "
12028 "overwrite one another or other files. This mode is appropriate when "
12029 "administrators are attempting to debug problems in a normal environment."
12032 #. 9520628e8ceb69fa9a4aee6b57f22675d9e1b709
12033 #. 54b501992dd2a839e94e76aa392c392b55080ce8
12034 #. type: Plain text
12035 #: build/C/man5/proc.5:2827
12037 "Additionally, since Linux 3.6, I</proc/sys/kernel/core_pattern> must either "
12038 "be an absolute pathname or a pipe command, as detailed in B<core>(5). "
12039 "Warnings will be written to the kernel log if I<core_pattern> does not "
12040 "follow these rules, and no core dump will be produced."
12044 #: build/C/man5/proc.5:2828
12046 msgid "I</proc/sys/fs/super-max>"
12049 #. type: Plain text
12050 #: build/C/man5/proc.5:2839
12052 "This file controls the maximum number of superblocks, and thus the maximum "
12053 "number of mounted filesystems the kernel can have. You need increase only "
12054 "I<super-max> if you need to mount more filesystems than the current value in "
12055 "I<super-max> allows you to."
12059 #: build/C/man5/proc.5:2839
12061 msgid "I</proc/sys/fs/super-nr>"
12064 #. type: Plain text
12065 #: build/C/man5/proc.5:2843
12066 msgid "This file contains the number of filesystems currently mounted."
12070 #: build/C/man5/proc.5:2843
12072 msgid "I</proc/sys/kernel>"
12075 #. type: Plain text
12076 #: build/C/man5/proc.5:2847
12078 "This directory contains files controlling a range of kernel parameters, as "
12083 #: build/C/man5/proc.5:2847
12085 msgid "I</proc/sys/kernel/acct>"
12088 #. type: Plain text
12089 #: build/C/man5/proc.5:2871
12091 "This file contains three numbers: I<highwater>, I<lowwater>, and "
12092 "I<frequency>. If BSD-style process accounting is enabled, these values "
12093 "control its behavior. If free space on filesystem where the log lives goes "
12094 "below I<lowwater> percent, accounting suspends. If free space gets above "
12095 "I<highwater> percent, accounting resumes. I<frequency> determines how often "
12096 "the kernel checks the amount of free space (value is in seconds). Default "
12097 "values are 4, 2 and 30. That is, suspend accounting if 2% or less space is "
12098 "free; resume it if 4% or more space is free; consider information about "
12099 "amount of free space valid for 30 seconds."
12103 #: build/C/man5/proc.5:2871
12105 msgid "I</proc/sys/kernel/cap_last_cap> (since Linux 3.2)"
12108 #. type: Plain text
12109 #: build/C/man5/proc.5:2875
12110 msgid "See B<capabilities>(7)."
12114 #: build/C/man5/proc.5:2875
12116 msgid "I</proc/sys/kernel/cap-bound> (from Linux 2.2 to 2.6.24)"
12119 #. type: Plain text
12120 #: build/C/man5/proc.5:2887
12122 "This file holds the value of the kernel I<capability bounding set> "
12123 "(expressed as a signed decimal number). This set is ANDed against the "
12124 "capabilities permitted to a process during B<execve>(2). Starting with "
12125 "Linux 2.6.25, the system-wide capability bounding set disappeared, and was "
12126 "replaced by a per-thread bounding set; see B<capabilities>(7)."
12130 #: build/C/man5/proc.5:2887
12132 msgid "I</proc/sys/kernel/core_pattern>"
12136 #: build/C/man5/proc.5:2891
12138 msgid "I</proc/sys/kernel/core_uses_pid>"
12142 #: build/C/man5/proc.5:2895
12144 msgid "I</proc/sys/kernel/ctrl-alt-del>"
12147 #. type: Plain text
12148 #: build/C/man5/proc.5:2910
12150 "This file controls the handling of Ctrl-Alt-Del from the keyboard. When the "
12151 "value in this file is 0, Ctrl-Alt-Del is trapped and sent to the B<init>(8) "
12152 "program to handle a graceful restart. When the value is greater than zero, "
12153 "Linux's reaction to a Vulcan Nerve Pinch (tm) will be an immediate reboot, "
12154 "without even syncing its dirty buffers. Note: when a program (like dosemu) "
12155 "has the keyboard in \"raw\" mode, the ctrl-alt-del is intercepted by the "
12156 "program before it ever reaches the kernel tty layer, and it's up to the "
12157 "program to decide what to do with it."
12161 #: build/C/man5/proc.5:2910
12163 msgid "I</proc/sys/kernel/dmesg_restrict> (since Linux 2.6.37)"
12166 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
12167 #. type: Plain text
12168 #: build/C/man5/proc.5:2923
12170 "The value in this file determines who can see kernel syslog contents. A "
12171 "value of 0 in this file imposes no restrictions. If the value is 1, only "
12172 "privileged users can read the kernel syslog. (See B<syslog>(2) for more "
12173 "details.) Since Linux 3.4, only users with the B<CAP_SYS_ADMIN> capability "
12174 "may change the value in this file."
12178 #: build/C/man5/proc.5:2923
12180 msgid "I</proc/sys/kernel/domainname> and I</proc/sys/kernel/hostname>"
12183 #. type: Plain text
12184 #: build/C/man5/proc.5:2931
12186 "can be used to set the NIS/YP domainname and the hostname of your box in "
12187 "exactly the same way as the commands B<domainname>(1) and B<hostname>(1), "
12191 #. type: Plain text
12192 #: build/C/man5/proc.5:2936
12195 "#B< echo \\(aqdarkstar\\(aq E<gt> /proc/sys/kernel/hostname>\n"
12196 "#B< echo \\(aqmydomain\\(aq E<gt> /proc/sys/kernel/domainname>\n"
12199 #. type: Plain text
12200 #: build/C/man5/proc.5:2940
12201 msgid "has the same effect as"
12204 #. type: Plain text
12205 #: build/C/man5/proc.5:2945
12208 "#B< hostname \\(aqdarkstar\\(aq>\n"
12209 "#B< domainname \\(aqmydomain\\(aq>\n"
12212 #. type: Plain text
12213 #: build/C/man5/proc.5:2958
12215 "Note, however, that the classic darkstar.frop.org has the hostname "
12216 "\"darkstar\" and DNS (Internet Domain Name Server) domainname \"frop.org\", "
12217 "not to be confused with the NIS (Network Information Service) or YP (Yellow "
12218 "Pages) domainname. These two domain names are in general different. For a "
12219 "detailed discussion see the B<hostname>(1) man page."
12223 #: build/C/man5/proc.5:2958
12225 msgid "I</proc/sys/kernel/hotplug>"
12228 #. type: Plain text
12229 #: build/C/man5/proc.5:2964
12231 "This file contains the path for the hotplug policy agent. The default value "
12232 "in this file is I</sbin/hotplug>."
12236 #: build/C/man5/proc.5:2964
12238 msgid "I</proc/sys/kernel/htab-reclaim>"
12241 #. type: Plain text
12242 #: build/C/man5/proc.5:2972
12244 "(PowerPC only) If this file is set to a nonzero value, the PowerPC htab (see "
12245 "kernel file I<Documentation/powerpc/ppc_htab.txt>) is pruned each time the "
12246 "system hits the idle loop."
12250 #: build/C/man5/proc.5:2972
12252 msgid "I</proc/sys/kernel/kptr_restrict> (since Linux 2.6.38)"
12255 #. 455cd5ab305c90ffc422dd2e0fb634730942b257
12256 #. commit 411f05f123cbd7f8aa1edcae86970755a6e2a9d9
12257 #. commit 620f6e8e855d6d447688a5f67a4e176944a084e8
12258 #. type: Plain text
12259 #: build/C/man5/proc.5:2997
12261 "The value in this file determines whether kernel addresses are exposed via "
12262 "I</proc> files and other interfaces. A value of 0 in this file imposes no "
12263 "restrictions. If the value is 1, kernel pointers printed using the I<%pK> "
12264 "format specifier will be replaced with zeros unless the user has the "
12265 "B<CAP_SYSLOG> capability. If the value is 2, kernel pointers printed using "
12266 "the I<%pK> format specifier will be replaced with zeros regardless of the "
12267 "user's capabilities. The initial default value for this file was 1, but the "
12268 "default was changed to 0 in Linux 2.6.39. Since Linux 3.4, only users with "
12269 "the B<CAP_SYS_ADMIN> capability can change the value in this file."
12273 #: build/C/man5/proc.5:2997
12275 msgid "I</proc/sys/kernel/l2cr>"
12278 #. type: Plain text
12279 #: build/C/man5/proc.5:3004
12281 "(PowerPC only) This file contains a flag that controls the L2 cache of G3 "
12282 "processor boards. If 0, the cache is disabled. Enabled if nonzero."
12286 #: build/C/man5/proc.5:3004
12288 msgid "I</proc/sys/kernel/modprobe>"
12291 #. type: Plain text
12292 #: build/C/man5/proc.5:3017
12294 "This file contains the path for the kernel module loader. The default value "
12295 "is I</sbin/modprobe>. The file is present only if the kernel is built with "
12296 "the B<CONFIG_MODULES> (B<CONFIG_KMOD> in Linux 2.6.26 and earlier) option "
12297 "enabled. It is described by the Linux kernel source file "
12298 "I<Documentation/kmod.txt> (present only in kernel 2.4 and earlier)."
12302 #: build/C/man5/proc.5:3017
12304 msgid "I</proc/sys/kernel/modules_disabled> (since Linux 2.6.31)"
12307 #. 3d43321b7015387cfebbe26436d0e9d299162ea1
12308 #. From Documentation/sysctl/kernel.txt
12309 #. type: Plain text
12310 #: build/C/man5/proc.5:3029
12312 "A toggle value indicating if modules are allowed to be loaded in an "
12313 "otherwise modular kernel. This toggle defaults to off (0), but can be set "
12314 "true (1). Once true, modules can be neither loaded nor unloaded, and the "
12315 "toggle cannot be set back to false. The file is present only if the kernel "
12316 "is built with the B<CONFIG_MODULES> option enabled."
12320 #: build/C/man5/proc.5:3029
12322 msgid "I</proc/sys/kernel/msgmax>"
12325 #. type: Plain text
12326 #: build/C/man5/proc.5:3034
12328 "This file defines a system-wide limit specifying the maximum number of bytes "
12329 "in a single message written on a System V message queue."
12333 #: build/C/man5/proc.5:3034
12335 msgid "I</proc/sys/kernel/msgmni> (since Linux 2.4)"
12338 #. type: Plain text
12339 #: build/C/man5/proc.5:3038
12341 "This file defines the system-wide limit on the number of message queue "
12346 #: build/C/man5/proc.5:3038
12348 msgid "I</proc/sys/kernel/msgmnb>"
12351 #. type: Plain text
12352 #: build/C/man5/proc.5:3047
12354 "This file defines a system-wide parameter used to initialize the "
12355 "I<msg_qbytes> setting for subsequently created message queues. The "
12356 "I<msg_qbytes> setting specifies the maximum number of bytes that may be "
12357 "written to the message queue."
12361 #: build/C/man5/proc.5:3047
12363 msgid "I</proc/sys/kernel/ngroups_max> (since Linux 2.6.4)"
12366 #. type: Plain text
12367 #: build/C/man5/proc.5:3051
12369 "This is a read-only file that displays the upper limit on the number of a "
12370 "process's group memberships."
12374 #: build/C/man5/proc.5:3051
12376 msgid "I</proc/sys/kernel/ostype> and I</proc/sys/kernel/osrelease>"
12379 #. type: Plain text
12380 #: build/C/man5/proc.5:3056
12381 msgid "These files give substrings of I</proc/version>."
12385 #: build/C/man5/proc.5:3056
12387 msgid "I</proc/sys/kernel/overflowgid> and I</proc/sys/kernel/overflowuid>"
12390 #. type: Plain text
12391 #: build/C/man5/proc.5:3062
12393 "These files duplicate the files I</proc/sys/fs/overflowgid> and "
12394 "I</proc/sys/fs/overflowuid>."
12398 #: build/C/man5/proc.5:3062
12400 msgid "I</proc/sys/kernel/panic>"
12403 #. type: Plain text
12404 #: build/C/man5/proc.5:3071
12406 "This file gives read/write access to the kernel variable I<panic_timeout>. "
12407 "If this is zero, the kernel will loop on a panic; if nonzero, it indicates "
12408 "that the kernel should autoreboot after this number of seconds. When you "
12409 "use the software watchdog device driver, the recommended setting is 60."
12413 #: build/C/man5/proc.5:3071
12415 msgid "I</proc/sys/kernel/panic_on_oops> (since Linux 2.5.68)"
12418 #. type: Plain text
12419 #: build/C/man5/proc.5:3083
12421 "This file controls the kernel's behavior when an oops or BUG is "
12422 "encountered. If this file contains 0, then the system tries to continue "
12423 "operation. If it contains 1, then the system delays a few seconds (to give "
12424 "klogd time to record the oops output) and then panics. If the "
12425 "I</proc/sys/kernel/panic> file is also nonzero, then the machine will be "
12430 #: build/C/man5/proc.5:3083
12432 msgid "I</proc/sys/kernel/pid_max> (since Linux 2.5.34)"
12435 #. Prior to 2.6.10, pid_max could also be raised above 32768 on 32-bit
12436 #. platforms, but this broke /proc/[pid]
12437 #. See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2
12438 #. type: Plain text
12439 #: build/C/man5/proc.5:3099
12441 "This file specifies the value at which PIDs wrap around (i.e., the value in "
12442 "this file is one greater than the maximum PID). The default value for this "
12443 "file, 32768, results in the same range of PIDs as on earlier kernels. On "
12444 "32-bit platforms, 32768 is the maximum value for I<pid_max>. On 64-bit "
12445 "systems, I<pid_max> can be set to any value up to 2^22 (B<PID_MAX_LIMIT>, "
12446 "approximately 4 million)."
12450 #: build/C/man5/proc.5:3099
12452 msgid "I</proc/sys/kernel/powersave-nap> (PowerPC only)"
12455 #. type: Plain text
12456 #: build/C/man5/proc.5:3105
12458 "This file contains a flag. If set, Linux-PPC will use the \"nap\" mode of "
12459 "powersaving, otherwise the \"doze\" mode will be used."
12463 #: build/C/man5/proc.5:3105
12465 msgid "I</proc/sys/kernel/printk>"
12468 #. type: Plain text
12469 #: build/C/man5/proc.5:3131
12471 "The four values in this file are I<console_loglevel>, "
12472 "I<default_message_loglevel>, I<minimum_console_level>, and "
12473 "I<default_console_loglevel>. These values influence I<printk()> behavior "
12474 "when printing or logging error messages. See B<syslog>(2) for more info on "
12475 "the different loglevels. Messages with a higher priority than "
12476 "I<console_loglevel> will be printed to the console. Messages without an "
12477 "explicit priority will be printed with priority I<default_message_level>. "
12478 "I<minimum_console_loglevel> is the minimum (highest) value to which "
12479 "I<console_loglevel> can be set. I<default_console_loglevel> is the default "
12480 "value for I<console_loglevel>."
12484 #: build/C/man5/proc.5:3131
12486 msgid "I</proc/sys/kernel/pty> (since Linux 2.6.4)"
12489 #. type: Plain text
12490 #: build/C/man5/proc.5:3137
12492 "This directory contains two files relating to the number of UNIX 98 "
12493 "pseudoterminals (see B<pts>(4)) on the system."
12497 #: build/C/man5/proc.5:3137
12499 msgid "I</proc/sys/kernel/pty/max>"
12502 #. type: Plain text
12503 #: build/C/man5/proc.5:3140
12504 msgid "This file defines the maximum number of pseudoterminals."
12508 #: build/C/man5/proc.5:3140
12510 msgid "I</proc/sys/kernel/pty/nr>"
12513 #. type: Plain text
12514 #: build/C/man5/proc.5:3144
12515 msgid "This read-only file indicates how many pseudoterminals are currently in use."
12519 #: build/C/man5/proc.5:3144
12521 msgid "I</proc/sys/kernel/random>"
12524 #. type: Plain text
12525 #: build/C/man5/proc.5:3152
12527 "This directory contains various parameters controlling the operation of the "
12528 "file I</dev/random>. See B<random>(4) for further information."
12532 #: build/C/man5/proc.5:3152
12534 msgid "I</proc/sys/kernel/random/uuid> (since Linux 2.4)"
12537 #. type: Plain text
12538 #: build/C/man5/proc.5:3156
12540 "Each read from this read-only file returns a randomly generated 128-bit "
12541 "UUID, as a string in the standard UUID format."
12545 #: build/C/man5/proc.5:3156
12547 msgid "I</proc/sys/kernel/real-root-dev>"
12550 #. type: Plain text
12551 #: build/C/man5/proc.5:3160
12553 "This file is documented in the Linux kernel source file "
12554 "I<Documentation/initrd.txt>."
12558 #: build/C/man5/proc.5:3160
12560 msgid "I</proc/sys/kernel/reboot-cmd> (Sparc only) "
12563 #. type: Plain text
12564 #: build/C/man5/proc.5:3166
12566 "This file seems to be a way to give an argument to the SPARC ROM/Flash boot "
12567 "loader. Maybe to tell it what to do after rebooting?"
12571 #: build/C/man5/proc.5:3166
12573 msgid "I</proc/sys/kernel/rtsig-max>"
12576 #. type: Plain text
12577 #: build/C/man5/proc.5:3173
12579 "(Only in kernels up to and including 2.6.7; see B<setrlimit>(2)) This file "
12580 "can be used to tune the maximum number of POSIX real-time (queued) signals "
12581 "that can be outstanding in the system."
12585 #: build/C/man5/proc.5:3173
12587 msgid "I</proc/sys/kernel/rtsig-nr>"
12590 #. type: Plain text
12591 #: build/C/man5/proc.5:3177
12593 "(Only in kernels up to and including 2.6.7.) This file shows the number "
12594 "POSIX real-time signals currently queued."
12598 #: build/C/man5/proc.5:3177
12600 msgid "I</proc/sys/kernel/sched_rr_timeslice_ms> (since Linux 3.9)"
12603 #. type: Plain text
12604 #: build/C/man5/proc.5:3181
12605 msgid "See B<sched_rr_get_interval>(2)."
12609 #: build/C/man5/proc.5:3181
12611 msgid "I</proc/sys/kernel/sem> (since Linux 2.4)"
12614 #. type: Plain text
12615 #: build/C/man5/proc.5:3185
12617 "This file contains 4 numbers defining limits for System V IPC semaphores. "
12618 "These fields are, in order:"
12622 #: build/C/man5/proc.5:3186
12627 #. type: Plain text
12628 #: build/C/man5/proc.5:3188
12629 msgid "The maximum semaphores per semaphore set."
12633 #: build/C/man5/proc.5:3188
12638 #. type: Plain text
12639 #: build/C/man5/proc.5:3190
12640 msgid "A system-wide limit on the number of semaphores in all semaphore sets."
12644 #: build/C/man5/proc.5:3190
12649 #. type: Plain text
12650 #: build/C/man5/proc.5:3194
12652 "The maximum number of operations that may be specified in a B<semop>(2) "
12657 #: build/C/man5/proc.5:3194
12662 #. type: Plain text
12663 #: build/C/man5/proc.5:3196
12664 msgid "A system-wide limit on the maximum number of semaphore identifiers."
12668 #: build/C/man5/proc.5:3197
12670 msgid "I</proc/sys/kernel/sg-big-buff>"
12673 #. type: Plain text
12674 #: build/C/man5/proc.5:3208
12676 "This file shows the size of the generic SCSI device (sg) buffer. You can't "
12677 "tune it just yet, but you could change it at compile time by editing "
12678 "I<include/scsi/sg.h> and changing the value of B<SG_BIG_BUFF>. However, "
12679 "there shouldn't be any reason to change this value."
12683 #: build/C/man5/proc.5:3208
12685 msgid "I</proc/sys/kernel/shm_rmid_forced> (since Linux 3.1)"
12688 #. commit b34a6b1da371ed8af1221459a18c67970f7e3d53
12689 #. See also Documentation/sysctl/kernel.txt
12690 #. type: Plain text
12691 #: build/C/man5/proc.5:3217
12693 "If this file is set to 1, all System V shared memory segments will be marked "
12694 "for destruction as soon as the number of attached processes falls to zero; "
12695 "in other words, it is no longer possible to create shared memory segments "
12696 "that exist independently of any attached process."
12699 #. type: Plain text
12700 #: build/C/man5/proc.5:3229
12702 "The effect is as though a B<shmctl>(2) B<IPC_RMID> is performed on all "
12703 "existing segments as well as all segments created in the future (until this "
12704 "file is reset to 0). Note that existing segments that are attached to no "
12705 "process will be immediately destroyed when this file is set to 1. Setting "
12706 "this option will also destroy segments that were created, but never "
12707 "attached, upon termination of the process that created the segment with "
12711 #. type: Plain text
12712 #: build/C/man5/proc.5:3237
12714 "Setting this file to 1 provides a way of ensuring that all System V shared "
12715 "memory segments are counted against the resource usage and resource limits "
12716 "(see the description of B<RLIMIT_AS> in B<getrlimit>(2)) of at least one "
12720 #. type: Plain text
12721 #: build/C/man5/proc.5:3244
12723 "Because setting this file to 1 produces behavior that is nonstandard and "
12724 "could also break existing applications, the default value in this file is "
12725 "0. Only set this file to 1 if you have a good understanding of the "
12726 "semantics of the applications using System V shared memory on your system."
12730 #: build/C/man5/proc.5:3244
12732 msgid "I</proc/sys/kernel/shmall>"
12735 #. type: Plain text
12736 #: build/C/man5/proc.5:3249
12738 "This file contains the system-wide limit on the total number of pages of "
12739 "System V shared memory."
12743 #: build/C/man5/proc.5:3249
12745 msgid "I</proc/sys/kernel/shmmax>"
12748 #. type: Plain text
12749 #: build/C/man5/proc.5:3259
12751 "This file can be used to query and set the run-time limit on the maximum "
12752 "(System V IPC) shared memory segment size that can be created. Shared "
12753 "memory segments up to 1GB are now supported in the kernel. This value "
12754 "defaults to B<SHMMAX>."
12758 #: build/C/man5/proc.5:3259
12760 msgid "I</proc/sys/kernel/shmmni> (since Linux 2.4)"
12763 #. type: Plain text
12764 #: build/C/man5/proc.5:3264
12766 "This file specifies the system-wide maximum number of System V shared memory "
12767 "segments that can be created."
12771 #: build/C/man5/proc.5:3264
12773 msgid "I</proc/sys/kernel/sysrq>"
12776 #. type: Plain text
12777 #: build/C/man5/proc.5:3273
12779 "This file controls the functions allowed to be invoked by the SysRq key. By "
12780 "default, the file contains 1 meaning that every possible SysRq request is "
12781 "allowed (in older kernel versions, SysRq was disabled by default, and you "
12782 "were required to specifically enable it at run-time, but this is not the "
12783 "case any more). Possible values in this file are:"
12786 #. type: Plain text
12787 #: build/C/man5/proc.5:3285
12790 " 0 - disable sysrq completely\n"
12791 " 1 - enable all functions of sysrq\n"
12792 " E<gt>1 - bit mask of allowed sysrq functions, as follows:\n"
12793 " 2 - enable control of console logging level\n"
12794 " 4 - enable control of keyboard (SAK, unraw)\n"
12795 " 8 - enable debugging dumps of processes etc.\n"
12796 " 16 - enable sync command\n"
12797 " 32 - enable remount read-only\n"
12798 " 64 - enable signaling of processes (term, kill, oom-kill)\n"
12799 " 128 - allow reboot/poweroff\n"
12800 " 256 - allow nicing of all real-time tasks\n"
12803 #. type: Plain text
12804 #: build/C/man5/proc.5:3291
12806 "This file is present only if the B<CONFIG_MAGIC_SYSRQ> kernel configuration "
12807 "option is enabled. For further details see the Linux kernel source file "
12808 "I<Documentation/sysrq.txt>."
12812 #: build/C/man5/proc.5:3291
12814 msgid "I</proc/sys/kernel/version>"
12817 #. type: Plain text
12818 #: build/C/man5/proc.5:3294
12819 msgid "This file contains a string like:"
12822 #. type: Plain text
12823 #: build/C/man5/proc.5:3296
12825 msgid " #5 Wed Feb 25 21:49:24 MET 1998\n"
12828 #. type: Plain text
12829 #: build/C/man5/proc.5:3300
12831 "The \"#5\" means that this is the fifth kernel built from this source base "
12832 "and the date behind it indicates the time the kernel was built."
12836 #: build/C/man5/proc.5:3300
12838 msgid "I</proc/sys/kernel/threads-max> (since Linux 2.3.11)"
12841 #. type: Plain text
12842 #: build/C/man5/proc.5:3304
12844 "This file specifies the system-wide limit on the number of threads (tasks) "
12845 "that can be created on the system."
12849 #: build/C/man5/proc.5:3304
12851 msgid "I</proc/sys/kernel/zero-paged> (PowerPC only) "
12854 #. type: Plain text
12855 #: build/C/man5/proc.5:3310
12857 "This file contains a flag. When enabled (nonzero), Linux-PPC will pre-zero "
12858 "pages in the idle loop, possibly speeding up get_free_pages."
12862 #: build/C/man5/proc.5:3310
12864 msgid "I</proc/sys/net>"
12867 #. type: Plain text
12868 #: build/C/man5/proc.5:3317
12870 "This directory contains networking stuff. Explanations for some of the "
12871 "files under this directory can be found in B<tcp>(7) and B<ip>(7)."
12875 #: build/C/man5/proc.5:3317
12877 msgid "I</proc/sys/net/core/somaxconn>"
12880 #. type: Plain text
12881 #: build/C/man5/proc.5:3326
12883 "This file defines a ceiling value for the I<backlog> argument of "
12884 "B<listen>(2); see the B<listen>(2) manual page for details."
12888 #: build/C/man5/proc.5:3326
12890 msgid "I</proc/sys/proc>"
12894 #: build/C/man5/proc.5:3329
12896 msgid "I</proc/sys/sunrpc>"
12899 #. type: Plain text
12900 #: build/C/man5/proc.5:3334
12902 "This directory supports Sun remote procedure call for network filesystem "
12903 "(NFS). On some systems, it is not present."
12907 #: build/C/man5/proc.5:3334
12909 msgid "I</proc/sys/vm>"
12912 #. type: Plain text
12913 #: build/C/man5/proc.5:3338
12915 "This directory contains files for memory management tuning, buffer and cache "
12920 #: build/C/man5/proc.5:3338
12922 msgid "I</proc/sys/vm/drop_caches> (since Linux 2.6.16)"
12925 #. type: Plain text
12926 #: build/C/man5/proc.5:3346
12928 "Writing to this file causes the kernel to drop clean caches, dentries, and "
12929 "inodes from memory, causing that memory to become free. This can be useful "
12930 "for memory management testing and performing reproducible filesystem "
12931 "benchmarks. Because writing to this file causes the benefits of caching to "
12932 "be lost, it can degrade overall system performance."
12935 #. type: Plain text
12936 #: build/C/man5/proc.5:3348
12937 msgid "To free pagecache, use:"
12940 #. type: Plain text
12941 #: build/C/man5/proc.5:3350
12943 msgid " echo 1 E<gt> /proc/sys/vm/drop_caches\n"
12946 #. type: Plain text
12947 #: build/C/man5/proc.5:3352
12948 msgid "To free dentries and inodes, use:"
12951 #. type: Plain text
12952 #: build/C/man5/proc.5:3354
12954 msgid " echo 2 E<gt> /proc/sys/vm/drop_caches\n"
12957 #. type: Plain text
12958 #: build/C/man5/proc.5:3356
12959 msgid "To free pagecache, dentries and inodes, use:"
12962 #. type: Plain text
12963 #: build/C/man5/proc.5:3358
12965 msgid " echo 3 E<gt> /proc/sys/vm/drop_caches\n"
12968 #. type: Plain text
12969 #: build/C/man5/proc.5:3364
12971 "Because writing to this file is a nondestructive operation and dirty objects "
12972 "are not freeable, the user should run B<sync>(8) first."
12976 #: build/C/man5/proc.5:3364
12978 msgid "I</proc/sys/vm/legacy_va_layout> (since Linux 2.6.9)"
12981 #. The following is from Documentation/filesystems/proc.txt
12982 #. type: Plain text
12983 #: build/C/man5/proc.5:3369
12985 "If nonzero, this disables the new 32-bit memory-mapping layout; the kernel "
12986 "will use the legacy (2.4) layout for all processes."
12990 #: build/C/man5/proc.5:3369
12992 msgid "I</proc/sys/vm/memory_failure_early_kill> (since Linux 2.6.32)"
12995 #. The following is based on the text in Documentation/sysctl/vm.txt
12996 #. type: Plain text
12997 #: build/C/man5/proc.5:3381
12999 "Control how to kill processes when an uncorrected memory error (typically a "
13000 "2-bit error in a memory module) that cannot be handled by the kernel is "
13001 "detected in the background by hardware. In some cases (like the page still "
13002 "having a valid copy on disk), the kernel will handle the failure "
13003 "transparently without affecting any applications. But if there is no other "
13004 "up-to-date copy of the data, it will kill processes to prevent any data "
13005 "corruptions from propagating."
13008 #. type: Plain text
13009 #: build/C/man5/proc.5:3383
13010 msgid "The file has one of the following values:"
13014 #: build/C/man5/proc.5:3384 build/C/man5/proc.5:3421
13019 #. type: Plain text
13020 #: build/C/man5/proc.5:3389
13022 "Kill all processes that have the corrupted-and-not-reloadable page mapped as "
13023 "soon as the corruption is detected. Note this is not supported for a few "
13024 "types of pages, like kernel internally allocated data or the swap cache, but "
13025 "works for the majority of user pages."
13029 #: build/C/man5/proc.5:3389 build/C/man5/proc.5:3423
13034 #. type: Plain text
13035 #: build/C/man5/proc.5:3392
13037 "Only unmap the corrupted page from all processes and kill only a process "
13038 "that tries to access it."
13041 #. type: Plain text
13042 #: build/C/man5/proc.5:3403
13044 "The kill is performed using a B<SIGBUS> signal with I<si_code> set to "
13045 "B<BUS_MCEERR_AO>. Processes can handle this if they want to; see "
13046 "B<sigaction>(2) for more details."
13049 #. type: Plain text
13050 #: build/C/man5/proc.5:3406
13052 "This feature is active only on architectures/platforms with advanced machine "
13053 "check handling and depends on the hardware capabilities."
13056 #. type: Plain text
13057 #: build/C/man5/proc.5:3413
13059 "Applications can override the I<memory_failure_early_kill> setting "
13060 "individually with the B<prctl>(2) B<PR_MCE_KILL> operation."
13063 #. type: Plain text
13064 #: build/C/man5/proc.5:3416 build/C/man5/proc.5:3429
13065 msgid "Only present if the kernel was configured with B<CONFIG_MEMORY_FAILURE>."
13069 #: build/C/man5/proc.5:3416
13071 msgid "I</proc/sys/vm/memory_failure_recovery> (since Linux 2.6.32)"
13074 #. The following is based on the text in Documentation/sysctl/vm.txt
13075 #. type: Plain text
13076 #: build/C/man5/proc.5:3420
13077 msgid "Enable memory failure recovery (when supported by the platform)"
13080 #. type: Plain text
13081 #: build/C/man5/proc.5:3423
13082 msgid "Attempt recovery."
13085 #. type: Plain text
13086 #: build/C/man5/proc.5:3425
13087 msgid "Always panic on a memory failure."
13091 #: build/C/man5/proc.5:3429
13093 msgid "I</proc/sys/vm/oom_dump_tasks> (since Linux 2.6.25)"
13096 #. The following is from Documentation/sysctl/vm.txt
13097 #. type: Plain text
13098 #: build/C/man5/proc.5:3444
13100 "Enables a system-wide task dump (excluding kernel threads) to be produced "
13101 "when the kernel performs an OOM-killing. The dump includes the following "
13102 "information for each task (thread, process): thread ID, real user ID, thread "
13103 "group ID (process ID), virtual memory size, resident set size, the CPU that "
13104 "the task is scheduled on, oom_adj score (see the description of "
13105 "I</proc/[pid]/oom_adj>), and command name. This is helpful to determine why "
13106 "the OOM-killer was invoked and to identify the rogue task that caused it."
13109 #. type: Plain text
13110 #: build/C/man5/proc.5:3450
13112 "If this contains the value zero, this information is suppressed. On very "
13113 "large systems with thousands of tasks, it may not be feasible to dump the "
13114 "memory state information for each one. Such systems should not be forced to "
13115 "incur a performance penalty in OOM situations when the information may not "
13119 #. type: Plain text
13120 #: build/C/man5/proc.5:3453
13122 "If this is set to nonzero, this information is shown whenever the OOM-killer "
13123 "actually kills a memory-hogging task."
13126 #. type: Plain text
13127 #: build/C/man5/proc.5:3455 build/C/man5/proc.5:3476
13128 msgid "The default value is 0."
13132 #: build/C/man5/proc.5:3455
13134 msgid "I</proc/sys/vm/oom_kill_allocating_task> (since Linux 2.6.24)"
13137 #. The following is from Documentation/sysctl/vm.txt
13138 #. type: Plain text
13139 #: build/C/man5/proc.5:3460
13141 "This enables or disables killing the OOM-triggering task in out-of-memory "
13145 #. type: Plain text
13146 #: build/C/man5/proc.5:3465
13148 "If this is set to zero, the OOM-killer will scan through the entire tasklist "
13149 "and select a task based on heuristics to kill. This normally selects a "
13150 "rogue memory-hogging task that frees up a large amount of memory when "
13154 #. type: Plain text
13155 #: build/C/man5/proc.5:3469
13157 "If this is set to nonzero, the OOM-killer simply kills the task that "
13158 "triggered the out-of-memory condition. This avoids a possibly expensive "
13162 #. type: Plain text
13163 #: build/C/man5/proc.5:3474
13165 "If I</proc/sys/vm/panic_on_oom> is nonzero, it takes precedence over "
13166 "whatever value is used in I</proc/sys/vm/oom_kill_allocating_task>."
13170 #: build/C/man5/proc.5:3476
13172 msgid "I</proc/sys/vm/overcommit_memory>"
13175 #. type: Plain text
13176 #: build/C/man5/proc.5:3480
13177 msgid "This file contains the kernel virtual memory accounting mode. Values are:"
13180 #. type: Plain text
13181 #: build/C/man5/proc.5:3483
13182 msgid "0: heuristic overcommit (this is the default)"
13185 #. type: Plain text
13186 #: build/C/man5/proc.5:3485
13187 msgid "1: always overcommit, never check"
13190 #. type: Plain text
13191 #: build/C/man5/proc.5:3487
13192 msgid "2: always check, never overcommit"
13195 #. type: Plain text
13196 #: build/C/man5/proc.5:3501
13198 "In mode 0, calls of B<mmap>(2) with B<MAP_NORESERVE> are not checked, and "
13199 "the default check is very weak, leading to the risk of getting a process "
13200 "\"OOM-killed\". Under Linux 2.4 any nonzero value implies mode 1. In mode "
13201 "2 (available since Linux 2.6), the total virtual address space on the system "
13202 "is limited to (SS + RAM*(r/100)), where SS is the size of the swap space, "
13203 "and RAM is the size of the physical memory, and r is the contents of the "
13204 "file I</proc/sys/vm/overcommit_ratio>."
13208 #: build/C/man5/proc.5:3501
13210 msgid "I</proc/sys/vm/overcommit_ratio>"
13213 #. type: Plain text
13214 #: build/C/man5/proc.5:3505
13215 msgid "See the description of I</proc/sys/vm/overcommit_memory>."
13219 #: build/C/man5/proc.5:3505
13221 msgid "I</proc/sys/vm/panic_on_oom> (since Linux 2.6.18)"
13224 #. The following is adapted from Documentation/sysctl/vm.txt
13225 #. type: Plain text
13226 #: build/C/man5/proc.5:3510
13227 msgid "This enables or disables a kernel panic in an out-of-memory situation."
13230 #. type: Plain text
13231 #: build/C/man5/proc.5:3515
13233 "If this file is set to the value 0, the kernel's OOM-killer will kill some "
13234 "rogue process. Usually, the OOM-killer is able to kill a rogue process and "
13235 "the system will survive."
13238 #. type: Plain text
13239 #: build/C/man5/proc.5:3530
13241 "If this file is set to the value 1, then the kernel normally panics when "
13242 "out-of-memory happens. However, if a process limits allocations to certain "
13243 "nodes using memory policies (B<mbind>(2) B<MPOL_BIND>) or cpusets "
13244 "(B<cpuset>(7)) and those nodes reach memory exhaustion status, one process "
13245 "may be killed by the OOM-killer. No panic occurs in this case: because "
13246 "other nodes' memory may be free, this means the system as a whole may not "
13247 "have reached an out-of-memory situation yet."
13250 #. type: Plain text
13251 #: build/C/man5/proc.5:3533
13253 "If this file is set to the value 2, the kernel always panics when an "
13254 "out-of-memory condition occurs."
13257 #. type: Plain text
13258 #: build/C/man5/proc.5:3537
13260 "The default value is 0. 1 and 2 are for failover of clustering. Select "
13261 "either according to your policy of failover."
13265 #: build/C/man5/proc.5:3537
13267 msgid "I</proc/sys/vm/swappiness>"
13270 #. The following is from Documentation/sysctl/vm.txt
13271 #. type: Plain text
13272 #: build/C/man5/proc.5:3545
13274 "The value in this file controls how aggressively the kernel will swap memory "
13275 "pages. Higher values increase aggressiveness, lower values decrease "
13276 "aggressiveness. The default value is 60."
13280 #: build/C/man5/proc.5:3545
13282 msgid "I</proc/sysrq-trigger> (since Linux 2.4.21)"
13285 #. type: Plain text
13286 #: build/C/man5/proc.5:3554
13288 "Writing a character to this file triggers the same SysRq function as typing "
13289 "ALT-SysRq-E<lt>characterE<gt> (see the description of "
13290 "I</proc/sys/kernel/sysrq>). This file is normally writable only by "
13291 "I<root>. For further details see the Linux kernel source file "
13292 "I<Documentation/sysrq.txt>."
13296 #: build/C/man5/proc.5:3554
13298 msgid "I</proc/sysvipc>"
13301 #. type: Plain text
13302 #: build/C/man5/proc.5:3567
13304 "Subdirectory containing the pseudo-files I<msg>, I<sem> and I<shm>. These "
13305 "files list the System V Interprocess Communication (IPC) objects "
13306 "(respectively: message queues, semaphores, and shared memory) that "
13307 "currently exist on the system, providing similar information to that "
13308 "available via B<ipcs>(1). These files have headers and are formatted (one "
13309 "IPC object per line) for easy understanding. B<svipc>(7) provides further "
13310 "background on the information shown by these files."
13314 #: build/C/man5/proc.5:3567
13316 msgid "I</proc/tty>"
13319 #. type: Plain text
13320 #: build/C/man5/proc.5:3571
13322 "Subdirectory containing the pseudo-files and subdirectories for tty drivers "
13323 "and line disciplines."
13327 #: build/C/man5/proc.5:3571
13329 msgid "I</proc/uptime>"
13332 #. type: Plain text
13333 #: build/C/man5/proc.5:3575
13335 "This file contains two numbers: the uptime of the system (seconds), and the "
13336 "amount of time spent in idle process (seconds)."
13340 #: build/C/man5/proc.5:3575
13342 msgid "I</proc/version>"
13345 #. type: Plain text
13346 #: build/C/man5/proc.5:3584
13348 "This string identifies the kernel version that is currently running. It "
13349 "includes the contents of I</proc/sys/kernel/ostype>, "
13350 "I</proc/sys/kernel/osrelease> and I</proc/sys/kernel/version>. For example:"
13353 #. type: Plain text
13354 #: build/C/man5/proc.5:3588
13356 msgid "CW<Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994>\n"
13360 #: build/C/man5/proc.5:3599
13362 msgid "I</proc/vmstat> (since Linux 2.6)"
13365 #. type: Plain text
13366 #: build/C/man5/proc.5:3602
13367 msgid "This file displays various virtual memory statistics."
13371 #: build/C/man5/proc.5:3602
13373 msgid "I</proc/zoneinfo> (since Linux 2.6.13)"
13376 #. FIXME more should be said about /proc/zoneinfo
13377 #. type: Plain text
13378 #: build/C/man5/proc.5:3607
13380 "This file display information about memory zones. This is useful for "
13381 "analyzing virtual memory behavior."
13384 #. type: Plain text
13385 #: build/C/man5/proc.5:3614
13387 "Many strings (i.e., the environment and command line) are in the internal "
13388 "format, with subfields terminated by null bytes (\\(aq\\e0\\(aq), so you may "
13389 "find that things are more readable if you use I<od -c> or I<tr \"\\e000\" "
13390 "\"\\en\"> to read them. Alternatively, I<echo \\`cat E<lt>fileE<gt>\\`> "
13394 #. .SH ACKNOWLEDGEMENTS
13395 #. The material on /proc/sys/fs and /proc/sys/kernel is closely based on
13396 #. kernel source documentation files written by Rik van Riel.
13397 #. type: Plain text
13398 #: build/C/man5/proc.5:3620
13400 "This manual page is incomplete, possibly inaccurate, and is the kind of "
13401 "thing that needs to be updated very often."
13404 #. type: Plain text
13405 #: build/C/man5/proc.5:3646
13407 "B<cat>(1), B<dmesg>(1), B<find>(1), B<free>(1), B<ps>(1), B<tr>(1), "
13408 "B<uptime>(1), B<chroot>(2), B<mmap>(2), B<readlink>(2), B<syslog>(2), "
13409 "B<slabinfo>(5), B<hier>(7), B<time>(7), B<arp>(8), B<hdparm>(8), "
13410 "B<ifconfig>(8), B<init>(8), B<lsmod>(8), B<lspci>(8), B<mount>(8), "
13411 "B<netstat>(8), B<procinfo>(8), B<route>(8), B<sysctl>(8)"
13414 #. type: Plain text
13415 #: build/C/man5/proc.5:3654
13417 "The Linux kernel source files: I<Documentation/filesystems/proc.txt> "
13418 "I<Documentation/sysctl/fs.txt>, I<Documentation/sysctl/kernel.txt>, "
13419 "I<Documentation/sysctl/net.txt>, and I<Documentation/sysctl/vm.txt>."
13423 #: build/C/man7/standards.7:24
13429 #: build/C/man7/standards.7:24
13434 #. type: Plain text
13435 #: build/C/man7/standards.7:27
13436 msgid "standards - C and UNIX Standards"
13439 #. type: Plain text
13440 #: build/C/man7/standards.7:31
13442 "The CONFORMING TO section that appears in many manual pages identifies "
13443 "various standards to which the documented interface conforms. The following "
13444 "list briefly describes these standards."
13448 #: build/C/man7/standards.7:31
13453 #. type: Plain text
13454 #: build/C/man7/standards.7:37
13456 "Version 7 (also known as Seventh Edition) UNIX, released by AT&T/Bell Labs "
13457 "in 1979. After this point, UNIX systems diverged into two main dialects: "
13458 "BSD and System V."
13462 #: build/C/man7/standards.7:37
13467 #. type: Plain text
13468 #: build/C/man7/standards.7:46
13470 "This is an implementation standard defined by the 4.2 release of the "
13471 "I<Berkeley Software Distribution>, released by the University of California "
13472 "at Berkeley. This was the first Berkeley release that contained a TCP/IP "
13473 "stack and the sockets API. 4.2BSD was released in 1983."
13476 #. type: Plain text
13477 #: build/C/man7/standards.7:55
13479 "Earlier major BSD releases included I<3BSD> (1980), I<4BSD> (1980), and "
13480 "I<4.1BSD> (1981)."
13484 #: build/C/man7/standards.7:55
13489 #. type: Plain text
13490 #: build/C/man7/standards.7:58
13491 msgid "The successor to 4.2BSD, released in 1986."
13495 #: build/C/man7/standards.7:58
13500 #. type: Plain text
13501 #: build/C/man7/standards.7:62
13503 "The successor to 4.3BSD, released in 1993. This was the last major Berkeley "
13508 #: build/C/man7/standards.7:62
13510 msgid "B<System V>"
13513 #. type: Plain text
13514 #: build/C/man7/standards.7:69
13516 "This is an implementation standard defined by AT&T's milestone 1983 release "
13517 "of its commercial System V (five) release. The previous major AT&T release "
13518 "was I<System III>, released in 1981."
13522 #: build/C/man7/standards.7:69
13524 msgid "B<System V release 2 (SVr2)>"
13527 #. type: Plain text
13528 #: build/C/man7/standards.7:76
13530 "This was the next System V release, made in 1985. The SVr2 was formally "
13531 "described in the I<System V Interface Definition version 1> (I<SVID 1>) "
13532 "published in 1985."
13536 #: build/C/man7/standards.7:76
13538 msgid "B<System V release 3 (SVr3)>"
13541 #. type: Plain text
13542 #: build/C/man7/standards.7:82
13544 "This was the successor to SVr2, released in 1986. This release was formally "
13545 "described in the I<System V Interface Definition version 2> (I<SVID 2>)."
13549 #: build/C/man7/standards.7:82
13551 msgid "B<System V release 4 (SVr4)>"
13554 #. type: Plain text
13555 #: build/C/man7/standards.7:92
13557 "This was the successor to SVr3, released in 1989. This version of System V "
13558 "is described in the \"Programmer's Reference Manual: Operating System API "
13559 "(Intel processors)\" (Prentice-Hall 1992, ISBN 0-13-951294-2) This release "
13560 "was formally described in the I<System V Interface Definition version 3> "
13561 "(I<SVID 3>), and is considered the definitive System V release."
13565 #: build/C/man7/standards.7:92
13570 #. type: Plain text
13571 #: build/C/man7/standards.7:98
13573 "System V Interface Definition version 4, issued in 1995. Available online "
13574 "at E<.UR http://www.sco.com\\:/developers\\:/devspecs/> E<.UE .>"
13578 #: build/C/man7/standards.7:98
13583 #. type: Plain text
13584 #: build/C/man7/standards.7:112
13586 "This was the first C language standard, ratified by ANSI (American National "
13587 "Standards Institute) in 1989 (I<X3.159-1989>). Sometimes this is known as "
13588 "I<ANSI C>, but since C99 is also an ANSI standard, this term is ambiguous. "
13589 "This standard was also ratified by ISO (International Standards "
13590 "Organization) in 1990 (I<ISO/IEC 9899:1990>), and is thus occasionally "
13591 "referred to as I<ISO C90>."
13595 #: build/C/man7/standards.7:112
13600 #. type: Plain text
13601 #: build/C/man7/standards.7:119
13603 "This revision of the C language standard was ratified by ISO in 1999 "
13604 "(I<ISO/IEC 9899:1999>). Available online at E<.UR "
13605 "http://www.open-std.org\\:/jtc1\\:/sc22\\:/wg14\\:/www\\:/standards> E<.UE "
13610 #: build/C/man7/standards.7:119
13615 #. type: Plain text
13616 #: build/C/man7/standards.7:123
13618 "This revision of the C language standard was ratified by ISO in 2011 "
13619 "(I<ISO/IEC 9899:2011>)."
13623 #: build/C/man7/standards.7:123
13625 msgid "B<POSIX.1-1990>"
13628 #. type: Plain text
13629 #: build/C/man7/standards.7:129
13631 "\"Portable Operating System Interface for Computing Environments\". IEEE "
13632 "1003.1-1990 part 1, ratified by ISO in 1990 (I<ISO/IEC 9945-1:1990>). The "
13633 "term \"POSIX\" was coined by Richard Stallman."
13637 #: build/C/man7/standards.7:129
13642 #. type: Plain text
13643 #: build/C/man7/standards.7:134
13645 "IEEE Std 1003.2-1992, describing commands and utilities, ratified by ISO in "
13646 "1993 (I<ISO/IEC 9945-2:1993>)."
13650 #: build/C/man7/standards.7:134
13652 msgid "B<POSIX.1b> (formerly known as I<POSIX.4>)"
13655 #. type: Plain text
13656 #: build/C/man7/standards.7:140
13658 "IEEE Std 1003.1b-1993, describing real-time facilities for portable "
13659 "operating systems, ratified by ISO in 1996 (I<ISO/IEC 9945-1:1996>)."
13663 #: build/C/man7/standards.7:140
13665 msgid "B<POSIX.1c>"
13668 #. type: Plain text
13669 #: build/C/man7/standards.7:143
13670 msgid "IEEE Std 1003.1c-1995, which describes the POSIX threads interfaces."
13674 #: build/C/man7/standards.7:143
13676 msgid "B<POSIX.1d>"
13679 #. type: Plain text
13680 #: build/C/man7/standards.7:146
13681 msgid "IEEE Std 1003.1c-1999, which describes additional real-time extensions."
13685 #: build/C/man7/standards.7:146
13687 msgid "B<POSIX.1g>"
13690 #. type: Plain text
13691 #: build/C/man7/standards.7:149
13692 msgid "IEEE Std 1003.1g-2000, which describes networking APIs (including sockets)."
13696 #: build/C/man7/standards.7:149
13698 msgid "B<POSIX.1j>"
13701 #. type: Plain text
13702 #: build/C/man7/standards.7:152
13703 msgid "IEEE Std 1003.1j-2000, which describes advanced real-time extensions."
13707 #: build/C/man7/standards.7:152
13709 msgid "B<POSIX.1-1996>"
13712 #. type: Plain text
13713 #: build/C/man7/standards.7:155
13714 msgid "A 1996 revision of POSIX.1 which incorporated POSIX.1b and POSIX.1c."
13718 #: build/C/man7/standards.7:155
13723 #. type: Plain text
13724 #: build/C/man7/standards.7:162
13726 "Released in 1989, this was the first significant release of the I<X/Open "
13727 "Portability Guide>, produced by the X/Open Company, a multivendor "
13728 "consortium. This multivolume guide was based on the POSIX standards."
13732 #: build/C/man7/standards.7:162
13737 #. type: Plain text
13738 #: build/C/man7/standards.7:165
13739 msgid "A revision of the X/Open Portability Guide, released in 1992."
13743 #: build/C/man7/standards.7:165
13748 #. type: Plain text
13749 #: build/C/man7/standards.7:172
13751 "A 1994 revision of XPG4. This is also referred to as I<Spec 1170>, where "
13752 "1170 referred to the number of interfaces defined by this standard."
13756 #: build/C/man7/standards.7:172
13758 msgid "B<SUS (SUSv1)>"
13761 #. type: Plain text
13762 #: build/C/man7/standards.7:180
13764 "Single UNIX Specification. This was a repackaging of XPG4v2 and other "
13765 "X/Open standards (X/Open Curses Issue 4 version 2, X/Open Networking Service "
13766 "(XNS) Issue 4). Systems conforming to this standard can be branded I<UNIX "
13771 #: build/C/man7/standards.7:180
13776 #. type: Plain text
13777 #: build/C/man7/standards.7:191
13779 "Single UNIX Specification version 2. Sometimes also referred to as "
13780 "I<XPG5>. This standard appeared in 1997. Systems conforming to this "
13781 "standard can be branded I<UNIX 98>. See also E<.UR "
13782 "http://www.UNIX-systems.org\\:/version2/> E<.UE .)>"
13786 #: build/C/man7/standards.7:191
13788 msgid "B<POSIX.1-2001, SUSv3>"
13791 #. type: Plain text
13792 #: build/C/man7/standards.7:203
13794 "This was a 2001 revision and consolidation of the POSIX.1, POSIX.2, and SUS "
13795 "standards into a single document, conducted under the auspices of the Austin "
13796 "group E<.UR http://www.opengroup.org\\:/austin/> E<.UE .> The standard is "
13797 "available online at E<.UR http://www.unix-systems.org\\:/version3/> E<.UE ,> "
13798 "and the interfaces that it describes are also available in the Linux manual "
13799 "pages package under sections 1p and 3p (e.g., \"man 3p open\")."
13802 #. type: Plain text
13803 #: build/C/man7/standards.7:216
13805 "The standard defines two levels of conformance: I<POSIX conformance>, which "
13806 "is a baseline set of interfaces required of a conforming system; and I<XSI "
13807 "Conformance>, which additionally mandates a set of interfaces (the \"XSI "
13808 "extension\") which are only optional for POSIX conformance. XSI-conformant "
13809 "systems can be branded I<UNIX 03>. (XSI conformance constitutes the "
13810 "I<Single UNIX Specification version 3> (I<SUSv3>).)"
13813 #. type: Plain text
13814 #: build/C/man7/standards.7:218
13815 msgid "The POSIX.1-2001 document is broken into four parts:"
13818 #. type: Plain text
13819 #: build/C/man7/standards.7:221
13820 msgid "B<XBD>: Definitions, terms and concepts, header file specifications."
13823 #. type: Plain text
13824 #: build/C/man7/standards.7:225
13826 "B<XSH>: Specifications of functions (i.e., system calls and library "
13827 "functions in actual implementations)."
13830 #. type: Plain text
13831 #: build/C/man7/standards.7:229
13833 "B<XCU>: Specifications of commands and utilities (i.e., the area formerly "
13834 "described by POSIX.2)."
13837 #. type: Plain text
13838 #: build/C/man7/standards.7:232
13839 msgid "B<XRAT>: Informative text on the other parts of the standard."
13842 #. type: Plain text
13843 #: build/C/man7/standards.7:236
13845 "POSIX.1-2001 is aligned with C99, so that all of the library functions "
13846 "standardized in C99 are also standardized in POSIX.1-2001."
13849 #. type: Plain text
13850 #: build/C/man7/standards.7:243
13852 "Two Technical Corrigenda (minor fixes and improvements) of the original "
13853 "2001 standard have occurred: TC1 in 2003 (referred to as I<POSIX.1-2003>), "
13854 "and TC2 in 2004 (referred to as I<POSIX.1-2004>)."
13858 #: build/C/man7/standards.7:243
13860 msgid "B<POSIX.1-2008, SUSv4>"
13863 #. type: Plain text
13864 #: build/C/man7/standards.7:247
13865 msgid "Work on the next revision of POSIX.1/SUS was completed and ratified in 2008."
13868 #. type: Plain text
13869 #: build/C/man7/standards.7:256
13871 "The changes in this revision are not as large as those that occurred for "
13872 "POSIX.1-2001/SUSv3, but a number of new interfaces are added and various "
13873 "details of existing specifications are modified. Many of the interfaces "
13874 "that were optional in POSIX.1-2001 become mandatory in the 2008 revision of "
13875 "the standard. A few interfaces that are present in POSIX.1-2001 are marked "
13876 "as obsolete in POSIX.1-2008, or removed from the standard altogether."
13879 #. type: Plain text
13880 #: build/C/man7/standards.7:264
13882 "The revised standard is broken into the same four parts as POSIX.1-2001, and "
13883 "again there are two levels of conformance: the baseline I<POSIX "
13884 "Conformance>, and I<XSI Conformance>, which mandates an additional set of "
13885 "interfaces beyond those in the base specification."
13888 #. type: Plain text
13889 #: build/C/man7/standards.7:268
13891 "In general, where the CONFORMING TO section of a manual page lists "
13892 "POSIX.1-2001, it can be assumed that the interface also conforms to "
13893 "POSIX.1-2008, unless otherwise noted."
13896 #. type: Plain text
13897 #: build/C/man7/standards.7:273
13899 "Technical Corrigendum 1 (minor fixes and improvements) of this standard was "
13900 "released in 2013 (referred to as I<POSIX.1-2013>)."
13903 #. type: Plain text
13904 #: build/C/man7/standards.7:277
13906 "Further information can be found on the Austin group web site, E<.UR "
13907 "http://www.opengroup.org\\:/austin/> E<.UE .>"
13910 #. type: Plain text
13911 #: build/C/man7/standards.7:281
13912 msgid "B<feature_test_macros>(7), B<libc>(7), B<posixoptions>(7)"
13916 #: build/C/man7/suffixes.7:39
13922 #: build/C/man7/suffixes.7:39
13927 #. type: Plain text
13928 #: build/C/man7/suffixes.7:42
13929 msgid "suffixes - list of file suffixes"
13932 #. type: Plain text
13933 #: build/C/man7/suffixes.7:50
13935 "It is customary to indicate the contents of a file with the file suffix, "
13936 "which consists of a period, followed by one or more letters. Many standard "
13937 "utilities, such as compilers, use this to recognize the type of file they "
13938 "are dealing with. The B<make>(1) utility is driven by rules based on file "
13942 #. type: Plain text
13943 #: build/C/man7/suffixes.7:53
13945 "Following is a list of suffixes which are likely to be found on a Linux "
13950 #: build/C/man7/suffixes.7:58
13952 msgid "Suffix\tFile type\n"
13956 #: build/C/man7/suffixes.7:59
13958 msgid " ,v\tfiles for RCS (Revision Control System)\n"
13962 #: build/C/man7/suffixes.7:60
13964 msgid " -\tbackup file\n"
13968 #: build/C/man7/suffixes.7:61
13970 msgid " .C\tC++ source code, equivalent to I<.cc>\n"
13974 #: build/C/man7/suffixes.7:62
13976 msgid " .F\tFortran source with B<cpp>(1) directives\n"
13980 #: build/C/man7/suffixes.7:63
13982 msgid "\tor file compressed using freeze\n"
13986 #: build/C/man7/suffixes.7:64
13988 msgid " .S\tassembler source with B<cpp>(1) directives\n"
13992 #: build/C/man7/suffixes.7:65
13994 msgid " .Y\tfile compressed using yabba\n"
13998 #: build/C/man7/suffixes.7:66
14000 msgid " .Z\tfile compressed using B<compress>(1)\n"
14004 #: build/C/man7/suffixes.7:67
14006 msgid " .[0-9]+gf\tTeX generic font files\n"
14010 #: build/C/man7/suffixes.7:68
14012 msgid " .[0-9]+pk\tTeX packed font files\n"
14016 #: build/C/man7/suffixes.7:69
14018 msgid " .[1-9]\tmanual page for the corresponding section\n"
14022 #: build/C/man7/suffixes.7:70
14024 msgid " .[1-9][a-z]\tmanual page for section plus subsection\n"
14028 #: build/C/man7/suffixes.7:71
14030 msgid " .a\tstatic object code library\n"
14034 #: build/C/man7/suffixes.7:72
14036 msgid " .ad\tX application default resource file\n"
14040 #: build/C/man7/suffixes.7:73
14042 msgid " .ada\tAda source (may be body, spec, or combination)\n"
14046 #: build/C/man7/suffixes.7:74
14048 msgid " .adb\tAda body source\n"
14052 #: build/C/man7/suffixes.7:75
14054 msgid " .ads\tAda spec source\n"
14058 #: build/C/man7/suffixes.7:76
14060 msgid " .afm\tPostScript font metrics\n"
14064 #: build/C/man7/suffixes.7:77
14066 msgid " .al\tPerl autoload file\n"
14070 #: build/C/man7/suffixes.7:78
14072 msgid " .am\tB<automake>(1) input file\n"
14076 #: build/C/man7/suffixes.7:79
14078 msgid " .arc\tB<arc>(1) archive\n"
14082 #: build/C/man7/suffixes.7:80
14084 msgid " .arj\tB<arj>(1) archive\n"
14088 #: build/C/man7/suffixes.7:81
14090 msgid " .asc\tPGP ASCII-armored data\n"
14094 #: build/C/man7/suffixes.7:82
14096 msgid " .asm\t(GNU) assembler source file\n"
14100 #: build/C/man7/suffixes.7:83
14102 msgid " .au\tAudio sound file\n"
14106 #: build/C/man7/suffixes.7:84
14108 msgid " .aux\tLaTeX auxiliary file\n"
14112 #: build/C/man7/suffixes.7:85
14114 msgid " .avi\t(msvideo) movie\n"
14118 #: build/C/man7/suffixes.7:86
14120 msgid " .awk\tAWK language program\n"
14124 #: build/C/man7/suffixes.7:87
14126 msgid " .b\tLILO boot loader image\n"
14130 #: build/C/man7/suffixes.7:88
14132 msgid " .bak\tbackup file\n"
14136 #: build/C/man7/suffixes.7:89
14138 msgid " .bash\tB<bash>(1) shell script\n"
14142 #: build/C/man7/suffixes.7:90
14144 msgid " .bb\tbasic block list data produced by\n"
14148 #: build/C/man7/suffixes.7:91 build/C/man7/suffixes.7:93
14150 msgid "\tgcc -ftest-coverage\n"
14154 #: build/C/man7/suffixes.7:92
14156 msgid " .bbg\tbasic block graph data produced by\n"
14160 #: build/C/man7/suffixes.7:94
14162 msgid " .bbl\tBibTeX output\n"
14166 #: build/C/man7/suffixes.7:95
14168 msgid " .bdf\tX font file\n"
14172 #: build/C/man7/suffixes.7:96
14174 msgid " .bib\tTeX bibliographic database, BibTeX input\n"
14178 #: build/C/man7/suffixes.7:97
14180 msgid " .bm\tbitmap source\n"
14184 #: build/C/man7/suffixes.7:98
14186 msgid " .bmp\tbitmap\n"
14190 #: build/C/man7/suffixes.7:99
14192 msgid " .bz2\tfile compressed using B<bzip2>(1)\n"
14196 #: build/C/man7/suffixes.7:100
14198 msgid " .c\tC source\n"
14202 #: build/C/man7/suffixes.7:101
14204 msgid " .cat\tmessage catalog files\n"
14208 #: build/C/man7/suffixes.7:102
14210 msgid " .cc\tC++ source\n"
14214 #: build/C/man7/suffixes.7:103
14216 msgid " .cf\tconfiguration file\n"
14220 #: build/C/man7/suffixes.7:104
14222 msgid " .cfg\tconfiguration file\n"
14226 #: build/C/man7/suffixes.7:105
14228 msgid " .cgi\tWWW content generating script or program\n"
14232 #: build/C/man7/suffixes.7:106
14234 msgid " .cls\tLaTeX Class definition\n"
14238 #: build/C/man7/suffixes.7:107
14240 msgid " .class\tJava compiled byte-code\n"
14244 #: build/C/man7/suffixes.7:108
14246 msgid " .conf\tconfiguration file\n"
14250 #: build/C/man7/suffixes.7:109
14252 msgid " .config\tconfiguration file\n"
14256 #: build/C/man7/suffixes.7:110
14258 msgid " .cpp\tequivalent to I<.cc>\n"
14262 #: build/C/man7/suffixes.7:111
14264 msgid " .csh\tB<csh>(1) shell script\n"
14268 #: build/C/man7/suffixes.7:112
14270 msgid " .cxx\tequivalent to I<.cc>\n"
14274 #: build/C/man7/suffixes.7:113
14276 msgid " .dat\tdata file\n"
14280 #: build/C/man7/suffixes.7:114
14282 msgid " .deb\tDebian software package\n"
14286 #: build/C/man7/suffixes.7:115
14288 msgid " .def\tModula-2 source for definition modules\n"
14292 #: build/C/man7/suffixes.7:116
14294 msgid " .def\tother definition files\n"
14298 #: build/C/man7/suffixes.7:117
14300 msgid " .desc\tinitial part of mail message unpacked with\n"
14304 #: build/C/man7/suffixes.7:118
14306 msgid "\tB<munpack>(1)\n"
14310 #: build/C/man7/suffixes.7:119
14312 msgid " .diff\tfile differences (B<diff>(1) command output)\n"
14316 #: build/C/man7/suffixes.7:120
14318 msgid " .dir\tdbm data base directory file\n"
14322 #: build/C/man7/suffixes.7:121
14324 msgid " .doc\tdocumentation file\n"
14328 #: build/C/man7/suffixes.7:122
14330 msgid " .dsc\tDebian Source Control (source package)\n"
14334 #: build/C/man7/suffixes.7:123
14336 msgid " .dtx\tLaTeX package source file\n"
14340 #: build/C/man7/suffixes.7:124
14342 msgid " .dvi\tTeX's device independent output\n"
14346 #: build/C/man7/suffixes.7:125
14348 msgid " .el\tEmacs-Lisp source\n"
14352 #: build/C/man7/suffixes.7:126
14354 msgid " .elc\tcompiled Emacs-Lisp source\n"
14358 #: build/C/man7/suffixes.7:127
14360 msgid " .eps\tencapsulated PostScript\n"
14364 #: build/C/man7/suffixes.7:128
14366 msgid " .exp\tExpect source code\n"
14370 #: build/C/man7/suffixes.7:129
14372 msgid " .f\tFortran source\n"
14376 #: build/C/man7/suffixes.7:130
14378 msgid " .f77\tFortran 77 source\n"
14382 #: build/C/man7/suffixes.7:131
14384 msgid " .f90\tFortran 90 source\n"
14388 #: build/C/man7/suffixes.7:132
14390 msgid " .fas\tprecompiled Common-Lisp\n"
14394 #: build/C/man7/suffixes.7:133
14396 msgid " .fi\tFortran include files\n"
14400 #: build/C/man7/suffixes.7:134
14402 msgid " .fig\tFIG image file (used by B<xfig>(1))\n"
14406 #: build/C/man7/suffixes.7:135
14408 msgid " .fmt\tTeX format file\n"
14412 #: build/C/man7/suffixes.7:136
14414 msgid " .gif\tCompuserve Graphics Image File format\n"
14418 #: build/C/man7/suffixes.7:137
14420 msgid " .gmo\tGNU format message catalog\n"
14424 #: build/C/man7/suffixes.7:138
14426 msgid " .gsf\tGhostscript fonts\n"
14430 #: build/C/man7/suffixes.7:139
14432 msgid " .gz\tfile compressed using B<gzip>(1)\n"
14436 #: build/C/man7/suffixes.7:140
14438 msgid " .h\tC or C++ header files\n"
14442 #: build/C/man7/suffixes.7:141
14444 msgid " .help\thelp file\n"
14448 #: build/C/man7/suffixes.7:142
14450 msgid " .hf\tequivalent to I<.help>\n"
14454 #: build/C/man7/suffixes.7:143
14456 msgid " .hlp\tequivalent to I<.help>\n"
14460 #: build/C/man7/suffixes.7:144
14462 msgid " .htm\tpoor man's I<.html>\n"
14466 #: build/C/man7/suffixes.7:145
14468 msgid " .html\tHTML document used with the World Wide Web\n"
14472 #: build/C/man7/suffixes.7:146
14474 msgid " .hqx\t7-bit encoded Macintosh file\n"
14478 #: build/C/man7/suffixes.7:147
14480 msgid " .i\tC source after preprocessing\n"
14484 #: build/C/man7/suffixes.7:148
14486 msgid " .icon\tbitmap source\n"
14490 #: build/C/man7/suffixes.7:149
14492 msgid " .idx\treference or datum-index file for hypertext\n"
14496 #: build/C/man7/suffixes.7:150
14498 msgid "\tor database system\n"
14502 #: build/C/man7/suffixes.7:151
14504 msgid " .image\tbitmap source\n"
14508 #: build/C/man7/suffixes.7:152
14510 msgid " .in\tconfiguration template, especially for GNU Autoconf\n"
14514 #: build/C/man7/suffixes.7:153
14516 msgid " .info\tfiles for the Emacs info browser\n"
14520 #: build/C/man7/suffixes.7:154
14522 msgid " .info-[0-9]+\tsplit info files\n"
14526 #: build/C/man7/suffixes.7:155
14528 msgid " .ins\tLaTeX package install file for docstrip\n"
14532 #: build/C/man7/suffixes.7:156
14534 msgid " .itcl\titcl source code;\n"
14538 #: build/C/man7/suffixes.7:157
14540 msgid "\titcl ([incr Tcl]) is an OO extension of tcl\n"
14544 #: build/C/man7/suffixes.7:158
14546 msgid " .java\ta Java source file\n"
14550 #: build/C/man7/suffixes.7:159
14552 msgid " .jpeg\tJoint Photographic Experts Group format\n"
14556 #: build/C/man7/suffixes.7:160
14558 msgid " .jpg\tpoor man's I<.jpeg>\n"
14562 #: build/C/man7/suffixes.7:161
14564 msgid " .kmap\tB<lyx>(1) keymap\n"
14568 #: build/C/man7/suffixes.7:162
14570 msgid " .l\tequivalent to I<.lex> or I<.lisp>\n"
14574 #: build/C/man7/suffixes.7:163
14576 msgid " .lex\tB<lex>(1) or B<flex>(1) files\n"
14580 #: build/C/man7/suffixes.7:164
14582 msgid " .lha\tlharc archive\n"
14586 #: build/C/man7/suffixes.7:165
14588 msgid " .lib\tCommon-Lisp library\n"
14592 #: build/C/man7/suffixes.7:166
14594 msgid " .lisp\tLisp source\n"
14598 #: build/C/man7/suffixes.7:167
14600 msgid " .ln\tfiles for use with B<lint>(1)\n"
14604 #: build/C/man7/suffixes.7:168
14606 msgid " .log\tlog file, in particular produced by TeX\n"
14610 #: build/C/man7/suffixes.7:169
14612 msgid " .lsm\tLinux Software Map entry\n"
14616 #: build/C/man7/suffixes.7:170
14618 msgid " .lsp\tCommon-Lisp source\n"
14622 #: build/C/man7/suffixes.7:171
14624 msgid " .lzh\tlharc archive\n"
14628 #: build/C/man7/suffixes.7:172
14630 msgid " .m\tObjective-C source code\n"
14634 #: build/C/man7/suffixes.7:173
14636 msgid " .m4\tB<m4>(1) source\n"
14640 #: build/C/man7/suffixes.7:174
14642 msgid " .mac\tmacro files for various programs\n"
14646 #: build/C/man7/suffixes.7:175
14648 msgid " .man\tmanual page (usually source rather than formatted)\n"
14652 #: build/C/man7/suffixes.7:176
14654 msgid " .map\tmap files for various programs\n"
14658 #: build/C/man7/suffixes.7:177
14660 msgid " .me\tNroff source using the me macro package\n"
14664 #: build/C/man7/suffixes.7:178
14666 msgid " .mf\tMetafont (font generator for TeX) source\n"
14670 #: build/C/man7/suffixes.7:179
14672 msgid " .mgp\tMagicPoint file\n"
14676 #: build/C/man7/suffixes.7:180
14678 msgid " .mm\tsources for B<groff>(1) in mm - format\n"
14682 #: build/C/man7/suffixes.7:181
14684 msgid " .mo\tMessage catalog binary file\n"
14688 #: build/C/man7/suffixes.7:182
14690 msgid " .mod\tModula-2 source for implementation modules\n"
14694 #: build/C/man7/suffixes.7:183
14696 msgid " .mov\t(quicktime) movie\n"
14700 #: build/C/man7/suffixes.7:184
14702 msgid " .mp\tMetapost source\n"
14706 #: build/C/man7/suffixes.7:185
14708 msgid " .mp2\tMPEG Layer 2 (audio) file\n"
14712 #: build/C/man7/suffixes.7:186
14714 msgid " .mp3\tMPEG Layer 3 (audio) file\n"
14718 #: build/C/man7/suffixes.7:187
14720 msgid " .mpeg\tmovie file\n"
14724 #: build/C/man7/suffixes.7:188
14726 msgid " .o\tobject file\n"
14730 #: build/C/man7/suffixes.7:189
14732 msgid " .old\told or backup file\n"
14736 #: build/C/man7/suffixes.7:190
14738 msgid " .orig\tbackup (original) version of a file, from B<patch>(1)\n"
14742 #: build/C/man7/suffixes.7:191
14744 msgid " .out\toutput file, often executable program (a.out)\n"
14748 #: build/C/man7/suffixes.7:192
14750 msgid " .p\tPascal source\n"
14754 #: build/C/man7/suffixes.7:193
14756 msgid " .pag\tdbm data base data file\n"
14760 #: build/C/man7/suffixes.7:194
14762 msgid " .patch\tfile differences for B<patch>(1)\n"
14766 #: build/C/man7/suffixes.7:195
14768 msgid " .pbm\tportable bitmap format\n"
14772 #: build/C/man7/suffixes.7:196
14774 msgid " .pcf\tX11 font files\n"
14778 #: build/C/man7/suffixes.7:197
14780 msgid " .pdf\tAdobe Portable Data Format\n"
14784 #: build/C/man7/suffixes.7:198
14786 msgid "\t(use Acrobat/B<acroread> or B<xpdf>)\n"
14790 #: build/C/man7/suffixes.7:199
14792 msgid " .perl\tPerl source (see .ph, .pl and .pm)\n"
14796 #: build/C/man7/suffixes.7:200
14798 msgid " .pfa\tPostScript font definition files, ASCII format\n"
14802 #: build/C/man7/suffixes.7:201
14804 msgid " .pfb\tPostScript font definition files, binary format\n"
14808 #: build/C/man7/suffixes.7:202
14810 msgid " .pgm\tportable greymap format\n"
14814 #: build/C/man7/suffixes.7:203
14816 msgid " .pgp\tPGP binary data\n"
14820 #: build/C/man7/suffixes.7:204
14822 msgid " .ph\tPerl header file\n"
14826 #: build/C/man7/suffixes.7:205
14828 msgid " .php\tPHP program file\n"
14832 #: build/C/man7/suffixes.7:206
14834 msgid " .php3\tPHP3 program file\n"
14838 #: build/C/man7/suffixes.7:207
14840 msgid " .pid\tFile to store daemon PID (e.g., crond.pid)\n"
14844 #: build/C/man7/suffixes.7:208
14846 msgid " .pl\tTeX property list file or Perl library file\n"
14850 #: build/C/man7/suffixes.7:209
14852 msgid " .pm\tPerl module\n"
14856 #: build/C/man7/suffixes.7:210
14858 msgid " .png\tPortable Network Graphics file\n"
14862 #: build/C/man7/suffixes.7:211
14864 msgid " .po\tMessage catalog source\n"
14868 #: build/C/man7/suffixes.7:212
14870 msgid " .pod\tB<perldoc>(1) file\n"
14874 #: build/C/man7/suffixes.7:213
14876 msgid " .ppm\tportable pixmap format\n"
14880 #: build/C/man7/suffixes.7:214
14882 msgid " .pr\tbitmap source\n"
14886 #: build/C/man7/suffixes.7:215
14888 msgid " .ps\tPostScript file\n"
14892 #: build/C/man7/suffixes.7:216
14894 msgid " .py\tPython source\n"
14898 #: build/C/man7/suffixes.7:217
14900 msgid " .pyc\tcompiled python\n"
14904 #: build/C/man7/suffixes.7:218
14906 msgid " .qt\tquicktime movie\n"
14910 #: build/C/man7/suffixes.7:219
14912 msgid " .r\tRATFOR source (obsolete)\n"
14916 #: build/C/man7/suffixes.7:220
14918 msgid " .rej\tpatches that B<patch>(1) couldn't apply\n"
14922 #: build/C/man7/suffixes.7:221
14924 msgid " .rpm\tRPM software package\n"
14928 #: build/C/man7/suffixes.7:222
14930 msgid " .rtf\tRich Text Format file\n"
14934 #: build/C/man7/suffixes.7:223
14936 msgid " .rules\trules for something\n"
14940 #: build/C/man7/suffixes.7:224
14942 msgid " .s\tassembler source\n"
14946 #: build/C/man7/suffixes.7:225
14948 msgid " .sa\tstub libraries for a.out shared libraries\n"
14952 #: build/C/man7/suffixes.7:226
14954 msgid " .sc\tB<sc>(1) spreadsheet commands\n"
14958 #: build/C/man7/suffixes.7:227
14960 msgid " .scm\tScheme source code\n"
14964 #: build/C/man7/suffixes.7:228
14966 msgid " .sed\tsed source file\n"
14970 #: build/C/man7/suffixes.7:229
14972 msgid " .sgml\tSGML source file\n"
14976 #: build/C/man7/suffixes.7:230
14978 msgid " .sh\tB<sh>(1) scripts\n"
14982 #: build/C/man7/suffixes.7:231
14984 msgid " .shar\tarchive created by the B<shar>(1) utility\n"
14988 #: build/C/man7/suffixes.7:232
14990 msgid " .so\tShared library or dynamically loadable object\n"
14994 #: build/C/man7/suffixes.7:233
14996 msgid " .sql\tSQL source\n"
15000 #: build/C/man7/suffixes.7:234
15002 msgid " .sqml\tSQML schema or query program\n"
15006 #: build/C/man7/suffixes.7:235
15008 msgid " .sty\tLaTeX style files\n"
15012 #: build/C/man7/suffixes.7:236
15014 msgid " .sym\tModula-2 compiled definition modules\n"
15018 #: build/C/man7/suffixes.7:237
15020 msgid " .tar\tarchive created by the B<tar>(1) utility\n"
15024 #: build/C/man7/suffixes.7:238
15026 msgid " .tar.Z\ttar(1) archive compressed with B<compress>(1)\n"
15030 #: build/C/man7/suffixes.7:239
15032 msgid " .tar.bz2\ttar(1) archive compressed with B<bzip2>(1)\n"
15036 #: build/C/man7/suffixes.7:240
15038 msgid " .tar.gz\ttar(1) archive compressed with B<gzip>(1)\n"
15042 #: build/C/man7/suffixes.7:241
15044 msgid " .taz\ttar(1) archive compressed with B<compress>(1)\n"
15048 #: build/C/man7/suffixes.7:242
15050 msgid " .tcl\ttcl source code\n"
15054 #: build/C/man7/suffixes.7:243
15056 msgid " .tex\tTeX or LaTeX source\n"
15060 #: build/C/man7/suffixes.7:244
15062 msgid " .texi\tequivalent to I<.texinfo>\n"
15066 #: build/C/man7/suffixes.7:245
15068 msgid " .texinfo\tTexinfo documentation source\n"
15072 #: build/C/man7/suffixes.7:246
15074 msgid " .text\ttext file\n"
15078 #: build/C/man7/suffixes.7:247
15080 msgid " .tfm\tTeX font metric file\n"
15084 #: build/C/man7/suffixes.7:248
15086 msgid " .tgz\ttar archive compressed with B<gzip>(1)\n"
15090 #: build/C/man7/suffixes.7:249
15092 msgid " .tif\tpoor man's I<.tiff>\n"
15096 #: build/C/man7/suffixes.7:250
15098 msgid " .tiff\tTagged Image File Format\n"
15102 #: build/C/man7/suffixes.7:251
15104 msgid " .tk\ttcl/tk script\n"
15108 #: build/C/man7/suffixes.7:252
15110 msgid " .tmp\ttemporary file\n"
15114 #: build/C/man7/suffixes.7:253
15116 msgid " .tmpl\ttemplate files\n"
15120 #: build/C/man7/suffixes.7:254
15122 msgid " .txt\tequivalent to I<.text>\n"
15126 #: build/C/man7/suffixes.7:255
15128 msgid " .uu\tequivalent to I<.uue>\n"
15132 #: build/C/man7/suffixes.7:256
15134 msgid " .uue\tbinary file encoded with B<uuencode>(1)\n"
15138 #: build/C/man7/suffixes.7:257
15140 msgid " .vf\tTeX virtual font file\n"
15144 #: build/C/man7/suffixes.7:258
15146 msgid " .vpl\tTeX virtual property list file\n"
15150 #: build/C/man7/suffixes.7:259
15152 msgid " .w\tSilvio Levi's CWEB\n"
15156 #: build/C/man7/suffixes.7:260
15158 msgid " .wav\twave sound file\n"
15162 #: build/C/man7/suffixes.7:261
15164 msgid " .web\tDonald Knuth's WEB\n"
15168 #: build/C/man7/suffixes.7:262
15170 msgid " .wml\tSource file for Web Meta Language\n"
15174 #: build/C/man7/suffixes.7:263
15176 msgid " .xbm\tX11 bitmap source\n"
15180 #: build/C/man7/suffixes.7:264
15182 msgid " .xcf\tGIMP graphic\n"
15186 #: build/C/man7/suffixes.7:265
15188 msgid " .xml\teXtended Markup Language file\n"
15192 #: build/C/man7/suffixes.7:266
15194 msgid " .xpm\tX11 pixmap source\n"
15198 #: build/C/man7/suffixes.7:267
15200 msgid " .xs\tPerl xsub file produced by h2xs\n"
15204 #: build/C/man7/suffixes.7:268
15206 msgid " .xsl\tXSL stylesheet\n"
15210 #: build/C/man7/suffixes.7:269
15212 msgid " .y\tB<yacc>(1) or B<bison>(1) (parser generator) files\n"
15216 #: build/C/man7/suffixes.7:270
15218 msgid " .z\tFile compressed using B<pack>(1) (or an old B<gzip>(1))\n"
15222 #: build/C/man7/suffixes.7:271
15224 msgid " .zip\tB<zip>(1) archive\n"
15228 #: build/C/man7/suffixes.7:272
15230 msgid " .zoo\tB<zoo>(1) archive\n"
15234 #: build/C/man7/suffixes.7:273
15236 msgid " ~\tEmacs or B<patch>(1) backup file\n"
15240 #: build/C/man7/suffixes.7:274
15242 msgid " rc\tstartup (`run control') file, e.g., I<.newsrc>\n"
15245 #. type: Plain text
15246 #: build/C/man7/suffixes.7:278
15247 msgid "General UNIX conventions."
15250 #. type: Plain text
15251 #: build/C/man7/suffixes.7:280
15252 msgid "This list is not exhaustive."
15255 #. type: Plain text
15256 #: build/C/man7/suffixes.7:283
15257 msgid "B<file>(1), B<make>(1)"
15261 #: build/C/man3/undocumented.3:29
15263 msgid "UNDOCUMENTED"
15267 #: build/C/man3/undocumented.3:29
15272 #. type: Plain text
15273 #: build/C/man3/undocumented.3:32
15274 msgid "none - undocumented library functions"
15277 #. type: Plain text
15278 #: build/C/man3/undocumented.3:34
15279 msgid "Undocumented library functions"
15282 #. type: Plain text
15283 #: build/C/man3/undocumented.3:37
15285 "This man page mentions those library functions which are implemented in the "
15286 "standard libraries but not yet documented in man pages."
15290 #: build/C/man3/undocumented.3:37
15292 msgid "Solicitation"
15295 #. type: Plain text
15296 #: build/C/man3/undocumented.3:43
15298 "If you have information about these functions, please look in the source "
15299 "code, write a man page (using a style similar to that of the other Linux "
15300 "section 3 man pages), and send it to B<mtk.manpages@gmail.com> for inclusion "
15301 "in the next man page release."
15305 #: build/C/man3/undocumented.3:43
15310 #. .BR chflags (3),
15311 #. .BR fattach (3),
15312 #. .BR fchflags (3),
15314 #. .BR fdetach (3),
15315 #. .BR obstack stuff (3),
15316 #. type: Plain text
15317 #: build/C/man3/undocumented.3:183
15319 "B<authdes_create>(3), B<authdes_getucred>(3), B<authdes_pk_create>(3), "
15320 "B<clntunix_create>(3), B<creat64>(3), B<dn_skipname>(3), B<fcrypt>(3), "
15321 "B<fp_nquery>(3), B<fp_query>(3), B<fp_resstat>(3), B<freading>(3), "
15322 "B<freopen64>(3), B<fseeko64>(3), B<ftello64>(3), B<ftw64>(3), B<fwscanf>(3), "
15323 "B<get_avphys_pages>(3), B<getdirentries64>(3), B<getmsg>(3), "
15324 "B<getnetname>(3), B<get_nprocs>(3), B<get_nprocs_conf>(3), "
15325 "B<get_phys_pages>(3), B<getpublickey>(3), B<getsecretkey>(3), "
15326 "B<h_errlist>(3), B<host2netname>(3), B<hostalias>(3), B<inet_nsap_addr>(3), "
15327 "B<inet_nsap_ntoa>(3), B<init_des>(3), B<libc_nls_init>(3), B<lio_listio>(3), "
15328 "B<mstats>(3), B<netname2host>(3), B<netname2user>(3), B<nlist>(3), "
15329 "B<obstack_free>(3), B<parse_printf_format>(3), B<p_cdname>(3), "
15330 "B<p_cdnname>(3), B<p_class>(3), B<p_fqname>(3), B<p_option>(3), "
15331 "B<p_query>(3), B<printf_size>(3), B<printf_size_info>(3), B<p_rr>(3), "
15332 "B<p_time>(3), B<p_type>(3), B<putlong>(3), B<putshort>(3), "
15333 "B<re_compile_fastmap>(3), B<re_compile_pattern>(3), "
15334 "B<register_printf_function>(3), B<re_match>(3), B<re_match_2>(3), "
15335 "B<re_rx_search>(3), B<re_search>(3), B<re_search_2>(3), "
15336 "B<re_set_registers>(3), B<re_set_syntax>(3), B<res_send_setqhook>(3), "
15337 "B<res_send_setrhook>(3), B<ruserpass>(3), B<setfileno>(3), "
15338 "B<sethostfile>(3), B<svc_exit>(3), B<svcudp_enablecache>(3), B<tell>(3), "
15339 "B<tr_break>(3), B<tzsetwall>(3), B<ufc_dofinalperm>(3), B<ufc_doit>(3), "
15340 "B<user2netname>(3), B<vlimit>(3), B<vtimes>(3), B<wcschrnul>(3), "
15341 "B<wcsftime>(3), B<wscanf>(3), B<xdr_authdes_cred>(3), "
15342 "B<xdr_authdes_verf>(3), B<xdr_cryptkeyarg>(3), B<xdr_cryptkeyres>(3), "
15343 "B<xdr_datum>(3), B<xdr_des_block>(3), B<xdr_domainname>(3), "
15344 "B<xdr_getcredres>(3), B<xdr_keybuf>(3), B<xdr_keystatus>(3), "
15345 "B<xdr_mapname>(3), B<xdr_netnamestr>(3), B<xdr_netobj>(3), B<xdr_passwd>(3), "
15346 "B<xdr_peername>(3), B<xdr_rmtcall_args>(3), B<xdr_rmtcallres>(3), "
15347 "B<xdr_unixcred>(3), B<xdr_yp_buf>(3), B<xdr_yp_inaddr>(3), "
15348 "B<xdr_ypbind_binding>(3), B<xdr_ypbind_resp>(3), B<xdr_ypbind_resptype>(3), "
15349 "B<xdr_ypbind_setdom>(3), B<xdr_ypdelete_args>(3), B<xdr_ypmaplist>(3), "
15350 "B<xdr_ypmaplist_str>(3), B<xdr_yppasswd>(3), B<xdr_ypreq_key>(3), "
15351 "B<xdr_ypreq_nokey>(3), B<xdr_ypresp_all>(3), B<xdr_ypresp_all_seq>(3), "
15352 "B<xdr_ypresp_key_val>(3), B<xdr_ypresp_maplist>(3), B<xdr_ypresp_master>(3), "
15353 "B<xdr_ypresp_order>(3), B<xdr_ypresp_val>(3), B<xdr_ypstat>(3), "
15354 "B<xdr_ypupdate_args>(3), B<yp_all>(3), B<yp_bind>(3), B<yperr_string>(3), "
15355 "B<yp_first>(3), B<yp_get_default_domain>(3), B<yp_maplist>(3), "
15356 "B<yp_master>(3), B<yp_match>(3), B<yp_next>(3), B<yp_order>(3), "
15357 "B<ypprot_err>(3), B<yp_unbind>(3), B<yp_update>(3)"
15361 #: build/C/man2/unimplemented.2:26
15363 msgid "UNIMPLEMENTED"
15367 #: build/C/man2/unimplemented.2:26
15372 #. type: Plain text
15373 #: build/C/man2/unimplemented.2:31
15375 "afs_syscall, break, fattach, fdetach, ftime, getmsg, getpmsg, gtty, "
15376 "isastream, lock, madvise1, mpx, prof, profil, putmsg, putpmsg, security, "
15377 "stty, tuxcall, ulimit, vserver - unimplemented system calls"
15380 #. type: Plain text
15381 #: build/C/man2/unimplemented.2:33
15382 msgid "Unimplemented system calls."
15385 #. type: Plain text
15386 #: build/C/man2/unimplemented.2:35
15387 msgid "These system calls are not implemented in the Linux kernel."
15390 #. type: Plain text
15391 #: build/C/man2/unimplemented.2:40
15392 msgid "These system calls always return -1 and set I<errno> to B<ENOSYS>."
15395 #. type: Plain text
15396 #: build/C/man2/unimplemented.2:47
15398 "Note that B<ftime>(3), B<profil>(3) and B<ulimit>(3) are implemented as "
15399 "library functions."
15402 #. type: Plain text
15403 #: build/C/man2/unimplemented.2:56
15405 "Some system calls, like B<alloc_hugepages>(2), B<free_hugepages>(2), "
15406 "B<ioperm>(2), B<iopl>(2), and B<vm86>(2) exist only on certain "
15410 #. type: Plain text
15411 #: build/C/man2/unimplemented.2:64
15413 "Some system calls, like B<ipc>(2), B<create_module>(2), B<init_module>(2), "
15414 "and B<delete_module>(2) exist only when the Linux kernel was built with "
15415 "support for them."
15418 #. type: Plain text
15419 #: build/C/man2/unimplemented.2:66
15420 msgid "B<syscalls>(2)"
15424 #: build/C/man7/units.7:26
15429 #. type: Plain text
15430 #: build/C/man7/units.7:29
15431 msgid "units, kilo, kibi, mega, mebi, giga, gibi - decimal and binary prefixes"
15435 #: build/C/man7/units.7:30
15437 msgid "Decimal prefixes"
15440 #. type: Plain text
15441 #: build/C/man7/units.7:34
15443 "The SI system of units uses prefixes that indicate powers of ten. A "
15444 "kilometer is 1000 meter, and a megawatt is 1000000 watt. Below the standard "
15449 #: build/C/man7/units.7:37 build/C/man7/units.7:79
15451 msgid "Prefix\tName\tValue\n"
15455 #: build/C/man7/units.7:38
15457 msgid "y\tyocto\t10^-24 = 0.000000000000000000000001\n"
15461 #: build/C/man7/units.7:39
15463 msgid "z\tzepto\t10^-21 = 0.000000000000000000001\n"
15467 #: build/C/man7/units.7:40
15469 msgid "a\tatto\t10^-18 = 0.000000000000000001\n"
15473 #: build/C/man7/units.7:41
15475 msgid "f\tfemto\t10^-15 = 0.000000000000001\n"
15479 #: build/C/man7/units.7:42
15481 msgid "p\tpico\t10^-12 = 0.000000000001\n"
15485 #: build/C/man7/units.7:43
15487 msgid "n\tnano\t10^-9 = 0.000000001\n"
15491 #: build/C/man7/units.7:44
15493 msgid "\\(mc\tmicro\t10^-6 = 0.000001\n"
15497 #: build/C/man7/units.7:45
15499 msgid "m\tmilli\t10^-3 = 0.001\n"
15503 #: build/C/man7/units.7:46
15505 msgid "c\tcenti\t10^-2 = 0.01\n"
15509 #: build/C/man7/units.7:47
15511 msgid "d\tdeci\t10^-1 = 0.1\n"
15515 #: build/C/man7/units.7:48
15517 msgid "da\tdeka\t10^ 1 = 10\n"
15521 #: build/C/man7/units.7:49
15523 msgid "h\thecto\t10^ 2 = 100\n"
15527 #: build/C/man7/units.7:50
15529 msgid "k\tkilo\t10^ 3 = 1000\n"
15533 #: build/C/man7/units.7:51
15535 msgid "M\tmega\t10^ 6 = 1000000\n"
15539 #: build/C/man7/units.7:52
15541 msgid "G\tgiga\t10^ 9 = 1000000000\n"
15545 #: build/C/man7/units.7:53
15547 msgid "T\ttera\t10^12 = 1000000000000\n"
15551 #: build/C/man7/units.7:54
15553 msgid "P\tpeta\t10^15 = 1000000000000000\n"
15557 #: build/C/man7/units.7:55
15559 msgid "E\texa\t10^18 = 1000000000000000000\n"
15563 #: build/C/man7/units.7:56
15565 msgid "Z\tzetta\t10^21 = 1000000000000000000000\n"
15569 #: build/C/man7/units.7:57
15571 msgid "Y\tyotta\t10^24 = 1000000000000000000000000\n"
15574 #. type: Plain text
15575 #: build/C/man7/units.7:64
15577 "The symbol for micro is the Greek letter mu, often written u in an ASCII "
15578 "context where this Greek letter is not available. See also"
15581 #. type: Plain text
15582 #: build/C/man7/units.7:68
15583 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/prefixes.html> E<.UE>"
15587 #: build/C/man7/units.7:69
15589 msgid "Binary prefixes"
15592 #. type: Plain text
15593 #: build/C/man7/units.7:76
15595 "The binary prefixes resemble the decimal ones, but have an additional "
15596 "\\(aqi\\(aq (and \"Ki\" starts with a capital \\(aqK\\(aq). The names are "
15597 "formed by taking the first syllable of the names of the decimal prefix with "
15598 "roughly the same size, followed by \"bi\" for \"binary\"."
15602 #: build/C/man7/units.7:80
15604 msgid "Ki\tkibi\t2^10 = 1024\n"
15608 #: build/C/man7/units.7:81
15610 msgid "Mi\tmebi\t2^20 = 1048576\n"
15614 #: build/C/man7/units.7:82
15616 msgid "Gi\tgibi\t2^30 = 1073741824\n"
15620 #: build/C/man7/units.7:83
15622 msgid "Ti\ttebi\t2^40 = 1099511627776\n"
15626 #: build/C/man7/units.7:84
15628 msgid "Pi\tpebi\t2^50 = 1125899906842624\n"
15632 #: build/C/man7/units.7:85
15634 msgid "Ei\texbi\t2^60 = 1152921504606846976\n"
15637 #. type: Plain text
15638 #: build/C/man7/units.7:90
15642 #. type: Plain text
15643 #: build/C/man7/units.7:93
15644 msgid "E<.UR http://physics.nist.gov\\:/cuu\\:/Units\\:/binary.html> E<.UE>"
15648 #: build/C/man7/units.7:93
15653 #. type: Plain text
15654 #: build/C/man7/units.7:98
15656 "Before these binary prefixes were introduced, it was fairly common to use "
15657 "k=1000 and K=1024, just like b=bit, B=byte. Unfortunately, the M is capital "
15658 "already, and cannot be capitalized to indicate binary-ness."
15661 #. type: Plain text
15662 #: build/C/man7/units.7:109
15664 "At first that didn't matter too much, since memory modules and disks came in "
15665 "sizes that were powers of two, so everyone knew that in such contexts "
15666 "\"kilobyte\" and \"megabyte\" meant 1024 and 1048576 bytes, respectively. "
15667 "What originally was a sloppy use of the prefixes \"kilo\" and \"mega\" "
15668 "started to become regarded as the \"real true meaning\" when computers were "
15669 "involved. But then disk technology changed, and disk sizes became arbitrary "
15670 "numbers. After a period of uncertainty all disk manufacturers settled on "
15671 "the standard, namely k=1000, M=1000k, G=1000M."
15674 #. also common: 14.4k modem
15675 #. type: Plain text
15676 #: build/C/man7/units.7:116
15678 "The situation was messy: in the 14k4 modems, k=1000; in the 1.44MB "
15679 "diskettes, M=1024000; and so on. In 1998 the IEC approved the standard that "
15680 "defines the binary prefixes given above, enabling people to be precise and "
15684 #. type: Plain text
15685 #: build/C/man7/units.7:118
15686 msgid "Thus, today, MB = 1000000B and MiB = 1048576B."
15689 #. type: Plain text
15690 #: build/C/man7/units.7:122
15692 "In the free software world programs are slowly being changed to conform. "
15693 "When the Linux kernel boots and says"
15696 #. type: Plain text
15697 #: build/C/man7/units.7:126
15699 msgid "hda: 120064896 sectors (61473 MB) w/2048KiB Cache\n"
15702 #. type: Plain text
15703 #: build/C/man7/units.7:130
15704 msgid "the MB are megabytes and the KiB are kibibytes."
15707 #. Copyright (c) 1990, 1993
15708 #. The Regents of the University of California. All rights reserved.
15710 #. %%%LICENSE_START(BSD_4_CLAUSE_UCB)
15711 #. Redistribution and use in source and binary forms, with or without
15712 #. modification, are permitted provided that the following conditions
15714 #. 1. Redistributions of source code must retain the above copyright
15715 #. notice, this list of conditions and the following disclaimer.
15716 #. 2. Redistributions in binary form must reproduce the above copyright
15717 #. notice, this list of conditions and the following disclaimer in the
15718 #. documentation and/or other materials provided with the distribution.
15719 #. 3. All advertising materials mentioning features or use of this software
15720 #. must display the following acknowledgement:
15721 #. This product includes software developed by the University of
15722 #. California, Berkeley and its contributors.
15723 #. 4. Neither the name of the University nor the names of its contributors
15724 #. may be used to endorse or promote products derived from this software
15725 #. without specific prior written permission.
15727 #. THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
15728 #. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15729 #. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15730 #. ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
15731 #. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
15732 #. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
15733 #. OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
15734 #. HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
15735 #. LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
15736 #. OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
15740 #. @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
15741 #. $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $
15743 #. This tutorial sampler invokes every macro in the package several
15744 #. times and is guaranteed to give a worst case performance
15745 #. for an already extremely slow package.
15747 #. String \*(Pu was not defined, probably means punctuation
15749 #: build/C/man7/mdoc.samples.7:42
15751 msgid "[ .,:;()[]?! ]"
15755 #: build/C/man7/mdoc.samples.7:43
15757 msgid "December 30, 1993"
15761 #: build/C/man7/mdoc.samples.7:45
15763 msgid "MDOC.SAMPLES 7"
15766 #. type: Plain text
15767 #: build/C/man7/mdoc.samples.7:48
15768 msgid "E<.Nm mdoc.samples>"
15772 #: build/C/man7/mdoc.samples.7:48
15774 msgid "tutorial sampler for writing"
15777 #. type: Plain text
15778 #: build/C/man7/mdoc.samples.7:52
15779 msgid "E<.Bx> manuals with E<.Nm \\-mdoc>"
15782 #. type: Plain text
15783 #: build/C/man7/mdoc.samples.7:54
15784 msgid "E<.Nm man mdoc.samples>"
15787 #. type: Plain text
15788 #: build/C/man7/mdoc.samples.7:100
15790 "A tutorial sampler for writing E<.Bx> manual pages with the E<.Nm \\-mdoc> "
15791 "macro package, a E<.Em content Ns \\-based> and E<.Em domain Ns \\-based> "
15792 "formatting package for E<.Xr troff 1>. Its predecessor, the E<.Xr \\-man 7> "
15793 "package, addressed page layout leaving the manipulation of fonts and other "
15794 "typesetting details to the individual author. In E<.Nm \\-mdoc>, page "
15795 "layout macros make up the E<.Em \"page structure domain\"> which consists of "
15796 "macros for titles, section headers, displays and lists. Essentially items "
15797 "which affect the physical position of text on a formatted page. In addition "
15798 "to the page structure domain, there are two more domains, the manual domain "
15799 "and the general text domain. The general text domain is defined as macros "
15800 "which perform tasks such as quoting or emphasizing pieces of text. The "
15801 "manual domain is defined as macros that are a subset of the day to day "
15802 "informal language used to describe commands, routines and related E<.Bx> "
15803 "files. Macros in the manual domain handle command names, command-line "
15804 "arguments and options, function names, function parameters, pathnames, "
15805 "variables, cross references to other manual pages, and so on. These domain "
15806 "items have value for both the author and the future user of the manual "
15807 "page. It is hoped the consistency gained across the manual set will provide "
15808 "easier translation to future documentation tools."
15811 #. type: Plain text
15812 #: build/C/man7/mdoc.samples.7:107
15814 "Throughout the E<.Ux> manual pages, a manual entry is simply referred to as "
15815 "a man page, regardless of actual length and without sexist intention."
15819 #: build/C/man7/mdoc.samples.7:107
15821 msgid "GETTING STARTED"
15824 #. type: Plain text
15825 #: build/C/man7/mdoc.samples.7:113
15827 "Since a tutorial document is normally read when a person desires to use the "
15828 "material immediately, the assumption has been made that the user of this "
15829 "document may be impatient. The material presented in the remained of this "
15830 "document is outlined as follows:"
15833 #. type: Plain text
15834 #: build/C/man7/mdoc.samples.7:116
15835 msgid "E<.Tn \"TROFF IDIOSYNCRASIES\">"
15839 #: build/C/man7/mdoc.samples.7:117
15841 msgid "\"Macro Usage\" ."
15845 #: build/C/man7/mdoc.samples.7:118
15847 msgid "\"Passing Space Characters in an Argument\" ."
15851 #: build/C/man7/mdoc.samples.7:119
15853 msgid "\"Trailing Blank Space Characters (a warning)\" ."
15857 #: build/C/man7/mdoc.samples.7:120
15859 msgid "\"Escaping Special Characters\" ."
15862 #. type: Plain text
15863 #: build/C/man7/mdoc.samples.7:124
15864 msgid "E<.Tn \"THE ANATOMY OF A MAN PAGE\">"
15868 #: build/C/man7/mdoc.samples.7:125
15870 msgid "\"A manual page template\" ."
15873 #. type: Plain text
15874 #: build/C/man7/mdoc.samples.7:129
15875 msgid "E<.Tn \"TITLE MACROS\">."
15878 #. type: Plain text
15879 #: build/C/man7/mdoc.samples.7:131
15880 msgid "E<.Tn \"INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS\">."
15884 #: build/C/man7/mdoc.samples.7:132
15886 msgid "\"What's in a name...\" ."
15890 #: build/C/man7/mdoc.samples.7:133
15892 msgid "\"General Syntax\" ."
15895 #. type: Plain text
15896 #: build/C/man7/mdoc.samples.7:137
15897 msgid "E<.Tn \"MANUAL DOMAIN\">"
15901 #: build/C/man7/mdoc.samples.7:138
15903 msgid "Addresses ."
15907 #: build/C/man7/mdoc.samples.7:139
15909 msgid "\"Author name\" ."
15913 #: build/C/man7/mdoc.samples.7:140
15915 msgid "Arguments ."
15919 #: build/C/man7/mdoc.samples.7:141
15921 msgid "\"Configuration Declarations (section four only)\" ."
15925 #: build/C/man7/mdoc.samples.7:142
15927 msgid "\"Command Modifier\" ."
15931 #: build/C/man7/mdoc.samples.7:143
15933 msgid "\"Defined Variables\" ."
15937 #: build/C/man7/mdoc.samples.7:144
15939 msgid "\"Errno's (Section two only)\" ."
15943 #: build/C/man7/mdoc.samples.7:145
15945 msgid "\"Environment Variables\" ."
15949 #: build/C/man7/mdoc.samples.7:146
15951 msgid "\"Function Argument\" ."
15955 #: build/C/man7/mdoc.samples.7:147
15957 msgid "\"Function Declaration\" ."
15961 #: build/C/man7/mdoc.samples.7:148
15967 #: build/C/man7/mdoc.samples.7:149
15969 msgid "\"Functions (library routines)\" ."
15973 #: build/C/man7/mdoc.samples.7:150
15975 msgid "\"Function Types\" ."
15978 #. .It "Header File (including source code)" .
15980 #: build/C/man7/mdoc.samples.7:152
15982 msgid "\"Interactive Commands\" ."
15986 #: build/C/man7/mdoc.samples.7:153
15992 #: build/C/man7/mdoc.samples.7:154
15998 #: build/C/man7/mdoc.samples.7:155
16000 msgid "Pathnames ."
16004 #: build/C/man7/mdoc.samples.7:156
16006 msgid "Variables ."
16010 #: build/C/man7/mdoc.samples.7:157
16012 msgid "\"Cross References\" ."
16015 #. type: Plain text
16016 #: build/C/man7/mdoc.samples.7:161
16017 msgid "E<.Tn \"GENERAL TEXT DOMAIN\">"
16021 #: build/C/man7/mdoc.samples.7:162
16023 msgid "\"AT&T Macro\" ."
16027 #: build/C/man7/mdoc.samples.7:163
16029 msgid "\"BSD Macro\" ."
16033 #: build/C/man7/mdoc.samples.7:164
16035 msgid "\"FreeBSD Macro\" ."
16039 #: build/C/man7/mdoc.samples.7:165
16041 msgid "\"UNIX Macro\" ."
16045 #: build/C/man7/mdoc.samples.7:166
16047 msgid "Enclosure/Quoting Macros"
16051 #: build/C/man7/mdoc.samples.7:168
16053 msgid "\"Angle Bracket Quote/Enclosure\" ."
16057 #: build/C/man7/mdoc.samples.7:169
16059 msgid "\"Bracket Quotes/Enclosure\" ."
16063 #: build/C/man7/mdoc.samples.7:170
16065 msgid "\"Double Quote macro/Enclosure\" ."
16069 #: build/C/man7/mdoc.samples.7:171
16071 msgid "\"Parenthesis Quote/Enclosure\" ."
16075 #: build/C/man7/mdoc.samples.7:172
16077 msgid "\"Single Quotes/Enclosure\" ."
16081 #: build/C/man7/mdoc.samples.7:173
16083 msgid "\"Prefix Macro\" ."
16087 #: build/C/man7/mdoc.samples.7:175
16089 msgid "\"No\\-Op or Normal Text Macro\" ."
16093 #: build/C/man7/mdoc.samples.7:176
16095 msgid "\"No Space Macro\" ."
16099 #: build/C/man7/mdoc.samples.7:177
16101 msgid "\"Section Cross References\" ."
16105 #: build/C/man7/mdoc.samples.7:178
16107 msgid "\"References and Citations\" ."
16111 #: build/C/man7/mdoc.samples.7:179
16113 msgid "Return Values (sections two and three only)"
16117 #: build/C/man7/mdoc.samples.7:180
16119 msgid "\"Trade Names (Acronyms and Type Names)\" ."
16123 #: build/C/man7/mdoc.samples.7:181
16125 msgid "\"Extended Arguments\" ."
16128 #. type: Plain text
16129 #: build/C/man7/mdoc.samples.7:185
16130 msgid "E<.Tn \"PAGE STRUCTURE DOMAIN\">"
16134 #: build/C/man7/mdoc.samples.7:186
16136 msgid "\"Section Headers\" ."
16140 #: build/C/man7/mdoc.samples.7:187
16142 msgid "\"Paragraphs and Line Spacing\" ."
16146 #: build/C/man7/mdoc.samples.7:188
16152 #: build/C/man7/mdoc.samples.7:189
16158 #: build/C/man7/mdoc.samples.7:190
16160 msgid "\"Font Modes (Emphasis, Literal, and Symbolic)\" ."
16164 #: build/C/man7/mdoc.samples.7:191
16166 msgid "\"Lists and Columns\" ."
16169 #. type: Plain text
16170 #: build/C/man7/mdoc.samples.7:195
16171 msgid "E<.Tn \"PREDEFINED STRINGS\">"
16174 #. type: Plain text
16175 #: build/C/man7/mdoc.samples.7:197
16176 msgid "E<.Tn \"DIAGNOSTICS\">"
16179 #. type: Plain text
16180 #: build/C/man7/mdoc.samples.7:199
16181 msgid "E<.Tn \"FORMATTING WITH GROFF, TROFF AND NROFF\">"
16184 #. type: Plain text
16185 #: build/C/man7/mdoc.samples.7:201
16186 msgid "E<.Tn \"BUGS\">"
16190 #: build/C/man7/mdoc.samples.7:203
16192 msgid "TROFF IDIOSYNCRASIES"
16195 #. type: Plain text
16196 #: build/C/man7/mdoc.samples.7:217
16198 "The E<.Nm \\-mdoc> package attempts to simplify the process of writing a man "
16199 "page. Theoretically, one should not have to learn the dirty details of "
16200 "E<.Xr troff 1> to use E<.Nm \\-mdoc>; however, there are a few limitations "
16201 "which are unavoidable and best gotten out of the way. And, too, be "
16202 "forewarned, this package is E<.Em not> fast."
16206 #: build/C/man7/mdoc.samples.7:217
16208 msgid "Macro Usage"
16211 #. type: Plain text
16212 #: build/C/man7/mdoc.samples.7:242
16214 "As in E<.Xr troff 1>, a macro is called by placing a E<.Ql \\&.> (dot "
16215 "character) at the beginning of a line followed by the two character name "
16216 "for the macro. Arguments may follow the macro separated by spaces. It is "
16217 "the dot character at the beginning of the line which causes E<.Xr troff 1> "
16218 "to interpret the next two characters as a macro name. To place a E<.Ql "
16219 "\\&.> (dot character) at the beginning of a line in some context other than "
16220 "a macro invocation, precede the E<.Ql \\&.> (dot) with the E<.Ql \\e&> "
16221 "escape sequence. The E<.Ql \\e&> translates literally to a zero width "
16222 "space, and is never displayed in the output."
16225 #. type: Plain text
16226 #: build/C/man7/mdoc.samples.7:257
16228 "In general, E<.Xr troff 1> macros accept up to nine arguments, any extra "
16229 "arguments are ignored. Most macros in E<.Nm \\-mdoc> accept nine arguments "
16230 "and, in limited cases, arguments may be continued or extended on the next "
16231 "line (See E<.Sx Extensions>). A few macros handle quoted arguments (see "
16232 "E<.Sx Passing Space Characters in an Argument> below)."
16235 #. type: Plain text
16236 #: build/C/man7/mdoc.samples.7:284
16238 "Most of the E<.Nm \\-mdoc> general text domain and manual domain macros are "
16239 "special in that their argument lists are E<.Em parsed> for callable macro "
16240 "names. This means an argument on the argument list which matches a general "
16241 "text or manual domain macro name and is determined to be callable will be "
16242 "executed or called when it is processed. In this case, the argument, "
16243 "although the name of a macro, is not preceded by a E<.Ql \\&.> (dot). It is "
16244 "in this manner that many macros are nested; for example the option macro, "
16245 "E<.Ql \\&.Op>, may E<.Em call> the flag and argument macros, E<.Ql \\&Fl> "
16246 "and E<.Ql \\&Ar>, to specify an optional flag with an argument:"
16250 #: build/C/man7/mdoc.samples.7:285
16252 msgid "Op Fl s Ar bytes"
16255 #. type: Plain text
16256 #: build/C/man7/mdoc.samples.7:288
16257 msgid "is produced by E<.Li \\&.Op \\&Fl s \\&Ar bytes>"
16260 #. type: Plain text
16261 #: build/C/man7/mdoc.samples.7:295
16263 "To prevent a two character string from being interpreted as a macro name, "
16264 "precede the string with the escape sequence E<.Ql \\e&>:"
16268 #: build/C/man7/mdoc.samples.7:296
16270 msgid "Op \\&Fl s \\&Ar bytes"
16273 #. type: Plain text
16274 #: build/C/man7/mdoc.samples.7:299
16275 msgid "is produced by E<.Li \\&.Op \\e&Fl s \\e&Ar bytes>"
16278 #. type: Plain text
16279 #: build/C/man7/mdoc.samples.7:320
16281 "Here the strings E<.Ql \\&Fl> and E<.Ql \\&Ar> are not interpreted as "
16282 "macros. Macros whose argument lists are parsed for callable arguments are "
16283 "referred to as parsed and macros which may be called from an argument list "
16284 "are referred to as callable throughout this document and in the companion "
16285 "quick reference manual E<.Xr mdoc 7>. This is a technical E<.Em faux pas> "
16286 "as almost all of the macros in E<.Nm \\-mdoc> are parsed, but as it was "
16287 "cumbersome to constantly refer to macros as being callable and being able to "
16288 "call other macros, the term parsed has been used."
16292 #: build/C/man7/mdoc.samples.7:320
16294 msgid "Passing Space Characters in an Argument"
16297 #. type: Plain text
16298 #: build/C/man7/mdoc.samples.7:338
16300 "Sometimes it is desirable to give as one argument a string containing one or "
16301 "more blank space characters. This may be necessary to defeat the nine "
16302 "argument limit or to specify arguments to macros which expect particular "
16303 "arrangement of items in the argument list. For example, the function macro "
16304 "E<.Ql \\&.Fn> expects the first argument to be the name of a function and "
16305 "any remaining arguments to be function parameters. As E<.Tn \"ANSI C\"> "
16306 "stipulates the declaration of function parameters in the parenthesized "
16307 "parameter list, each parameter is guaranteed to be at minimum a two word "
16308 "string. For example, E<.Fa int foo>."
16311 #. type: Plain text
16312 #: build/C/man7/mdoc.samples.7:353
16314 "There are two possible ways to pass an argument which contains an embedded "
16315 "space. E<.Em Implementation note>: Unfortunately, the most convenient way "
16316 "of passing spaces in between quotes by reassigning individual arguments "
16317 "before parsing was fairly expensive speed wise and space wise to implement "
16318 "in all the macros for E<.Tn AT&T> E<.Xr troff>. It is not expensive for "
16319 "E<.Xr groff> but for the sake of portability, has been limited to the "
16320 "following macros which need it the most:"
16324 #: build/C/man7/mdoc.samples.7:355
16329 #. type: Plain text
16330 #: build/C/man7/mdoc.samples.7:358
16331 msgid "Configuration declaration (section 4 E<.Sx SYNOPSIS>)"
16335 #: build/C/man7/mdoc.samples.7:358
16340 #. type: Plain text
16341 #: build/C/man7/mdoc.samples.7:360
16342 msgid "Begin list (for the width specifier)."
16346 #: build/C/man7/mdoc.samples.7:360
16351 #. type: Plain text
16352 #: build/C/man7/mdoc.samples.7:362
16353 msgid "Emphasized text."
16357 #: build/C/man7/mdoc.samples.7:362
16362 #. type: Plain text
16363 #: build/C/man7/mdoc.samples.7:364
16364 msgid "Functions (sections two and four)."
16368 #: build/C/man7/mdoc.samples.7:364
16373 #. type: Plain text
16374 #: build/C/man7/mdoc.samples.7:366
16375 msgid "List items."
16379 #: build/C/man7/mdoc.samples.7:366
16384 #. type: Plain text
16385 #: build/C/man7/mdoc.samples.7:368
16386 msgid "Literal text."
16390 #: build/C/man7/mdoc.samples.7:368
16395 #. type: Plain text
16396 #: build/C/man7/mdoc.samples.7:370
16397 msgid "Symbolic text."
16401 #: build/C/man7/mdoc.samples.7:370
16406 #. type: Plain text
16407 #: build/C/man7/mdoc.samples.7:372
16408 msgid "Book titles."
16412 #: build/C/man7/mdoc.samples.7:372
16417 #. type: Plain text
16418 #: build/C/man7/mdoc.samples.7:374
16419 msgid "Journal names."
16423 #: build/C/man7/mdoc.samples.7:374
16428 #. type: Plain text
16429 #: build/C/man7/mdoc.samples.7:376
16430 msgid "Optional notes for a reference."
16434 #: build/C/man7/mdoc.samples.7:376
16439 #. type: Plain text
16440 #: build/C/man7/mdoc.samples.7:378
16441 msgid "Report title (in a reference)."
16445 #: build/C/man7/mdoc.samples.7:378
16450 #. type: Plain text
16451 #: build/C/man7/mdoc.samples.7:380
16452 msgid "Title of article in a book or journal."
16455 #. type: Plain text
16456 #: build/C/man7/mdoc.samples.7:397
16458 "One way of passing a string containing blank spaces is to use the hard or "
16459 "unpaddable space character E<.Ql \\e\\ >, that is, a blank space preceded by "
16460 "the escape character E<.Ql \\e>. This method may be used with any macro but "
16461 "has the side effect of interfering with the adjustment of text over the "
16462 "length of a line. E<.Xr Troff> sees the hard space as if it were any other "
16463 "printable character and cannot split the string into blank or newline "
16464 "separated pieces as one would expect. The method is useful for strings "
16465 "which are not expected to overlap a line boundary. For example:"
16469 #: build/C/man7/mdoc.samples.7:398
16471 msgid "Fn fetch char\\ *str"
16474 #. type: Plain text
16475 #: build/C/man7/mdoc.samples.7:401
16476 msgid "is created by E<.Ql \\&.Fn fetch char\\e *str>"
16480 #: build/C/man7/mdoc.samples.7:401
16482 msgid "Fn fetch \"char *str\""
16485 #. type: Plain text
16486 #: build/C/man7/mdoc.samples.7:404
16487 msgid "can also be created by E<.Ql \\&.Fn fetch \"\\*qchar *str\\*q\">"
16490 #. type: Plain text
16491 #: build/C/man7/mdoc.samples.7:413
16493 "If the E<.Ql \\e> or quotes were omitted, E<.Ql \\&.Fn> would see three "
16494 "arguments and the result would be:"
16498 #: build/C/man7/mdoc.samples.7:414
16500 msgid "Fn fetch char *str"
16503 #. type: Plain text
16504 #: build/C/man7/mdoc.samples.7:420
16506 "For an example of what happens when the parameter list overlaps a newline "
16507 "boundary, see the E<.Sx BUGS> section."
16511 #: build/C/man7/mdoc.samples.7:420
16513 msgid "Trailing Blank Space Characters"
16516 #. type: Plain text
16517 #: build/C/man7/mdoc.samples.7:433
16519 "E<.Xr Troff> can be confused by blank space characters at the end of a "
16520 "line. It is a wise preventive measure to globally remove all blank spaces "
16521 "from E<lt>blank-spaceE<gt>E<lt>end-of-lineE<gt> character sequences. Should "
16522 "the need arise to force a blank character at the end of a line, it may be "
16523 "forced with an unpaddable space and the E<.Ql \\e&> escape character. For "
16524 "example, E<.Ql string\\e\\ \\e&>."
16528 #: build/C/man7/mdoc.samples.7:433
16530 msgid "Escaping Special Characters"
16533 #. type: Plain text
16534 #: build/C/man7/mdoc.samples.7:445
16536 "Special characters like the newline character E<.Ql \\en>, are handled by "
16537 "replacing the E<.Ql \\e> with E<.Ql \\ee> (e.g., E<.Ql \\een>) to preserve "
16542 #: build/C/man7/mdoc.samples.7:445
16544 msgid "THE ANATOMY OF A MAN PAGE"
16547 #. type: Plain text
16548 #: build/C/man7/mdoc.samples.7:452
16550 "The body of a man page is easily constructed from a basic template found in "
16551 "the file E<.Pa /usr/share/misc/mdoc.template>. Several example man pages "
16552 "can also be found in E<.Pa /usr/share/examples/mdoc>."
16556 #: build/C/man7/mdoc.samples.7:453
16558 msgid "A manual page template"
16561 #. type: Plain text
16562 #: build/C/man7/mdoc.samples.7:484
16565 "\\&.\\e\" The following requests are required for all man pages.\n"
16566 "\\&.Dd Month day, year\n"
16567 "\\&.Os OPERATING_SYSTEM [version/release]\n"
16568 "\\&.Dt DOCUMENT_TITLE [section number] [volume]\n"
16571 "\\&.Nd one line description of name\n"
16572 "\\&.Sh SYNOPSIS\n"
16573 "\\&.Sh DESCRIPTION\n"
16574 "\\&.\\e\" The following requests should be uncommented and\n"
16575 "\\&.\\e\" used where appropriate. This next request is\n"
16576 "\\&.\\e\" for sections 2 and 3 function return values only.\n"
16577 "\\&.\\e\" .Sh RETURN VALUE\n"
16578 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
16579 "\\&.\\e\" .Sh ENVIRONMENT\n"
16580 "\\&.\\e\" .Sh FILES\n"
16581 "\\&.\\e\" .Sh EXAMPLES\n"
16582 "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n"
16583 "\\&.\\e\" (command return values (to shell) and\n"
16584 "\\&.\\e\"\t fprintf/stderr type diagnostics)\n"
16585 "\\&.\\e\" .Sh DIAGNOSTICS\n"
16586 "\\&.\\e\" The next request is for sections 2 and 3 error\n"
16587 "\\&.\\e\" and signal handling only.\n"
16588 "\\&.\\e\" .Sh ERRORS\n"
16589 "\\&.\\e\" .Sh SEE ALSO\n"
16590 "\\&.\\e\" .Sh CONFORMING TO\n"
16591 "\\&.\\e\" .Sh HISTORY\n"
16592 "\\&.\\e\" .Sh AUTHORS\n"
16593 "\\&.\\e\" .Sh BUGS\n"
16596 #. type: Plain text
16597 #: build/C/man7/mdoc.samples.7:498
16599 "The first items in the template are the macros E<.Pq Li \\&.Dd , \\&.Os , "
16600 "\\&.Dt>; the document date, the operating system the man page or subject "
16601 "source is developed or modified for, and the man page title E<.Pq Em in "
16602 "uppercase> along with the section of the manual the page belongs in. These "
16603 "macros identify the page, and are discussed below in E<.Sx TITLE MACROS>."
16606 #. type: Plain text
16607 #: build/C/man7/mdoc.samples.7:517
16609 "The remaining items in the template are section headers E<.Pq Li \\&.Sh>; of "
16610 "which E<.Sx NAME>, E<.Sx SYNOPSIS> and E<.Sx DESCRIPTION> are mandatory. "
16611 "The headers are discussed in E<.Sx PAGE STRUCTURE DOMAIN>, after "
16612 "presentation of E<.Sx MANUAL DOMAIN>. Several content macros are used to "
16613 "demonstrate page layout macros; reading about content macros before page "
16614 "layout macros is recommended."
16618 #: build/C/man7/mdoc.samples.7:517
16620 msgid "TITLE MACROS"
16623 #. type: Plain text
16624 #: build/C/man7/mdoc.samples.7:526
16626 "The title macros are the first portion of the page structure domain, but are "
16627 "presented first and separate for someone who wishes to start writing a man "
16628 "page yesterday. Three header macros designate the document title or manual "
16629 "page title, the operating system, and the date of authorship. These macros "
16630 "are one called once at the very beginning of the document and are used to "
16631 "construct the headers and footers only."
16635 #: build/C/man7/mdoc.samples.7:527
16637 msgid "Li \\&.Dt DOCUMENT_TITLE section# [volume]"
16641 #. USD UNIX User's Supplementary Documents
16643 #. PS1 UNIX Programmer's Supplementary Documents
16644 #. type: Plain text
16645 #: build/C/man7/mdoc.samples.7:541
16647 "The document title is the subject of the man page and must be in E<.Tn "
16648 "CAPITALS> due to troff limitations. The section number may be 1,\\ ...,\\ "
16649 "8, and if it is specified, the volume title may be omitted. A volume title "
16650 "may be arbitrary or one of the following:"
16654 #: build/C/man7/mdoc.samples.7:543
16656 msgid "Li \"AMD\tUNIX Ancestral Manual Documents\""
16660 #: build/C/man7/mdoc.samples.7:544
16662 msgid "Li \"SMM\tUNIX System Manager's Manual\""
16666 #: build/C/man7/mdoc.samples.7:545
16668 msgid "Li \"URM\tUNIX Reference Manual\""
16672 #: build/C/man7/mdoc.samples.7:546
16674 msgid "Li \"PRM\tUNIX Programmer's Manual\""
16678 #. MMI UNIX Manual Master Index
16680 #. CON UNIX Contributed Software Manual
16682 #. LOC UNIX Local Manual
16683 #. type: Plain text
16684 #: build/C/man7/mdoc.samples.7:562
16686 "The default volume labeling is E<.Li URM> for sections 1, 6, and 7; E<.Li "
16687 "SMM> for section 8; E<.Li PRM> for sections 2, 3, 4, and 5."
16691 #: build/C/man7/mdoc.samples.7:562
16693 msgid "Li \\&.Os operating_system release#"
16696 #. type: Plain text
16697 #: build/C/man7/mdoc.samples.7:575
16699 "The name of the operating system should be the common acronym, for example, "
16700 "E<.Tn BSD> or E<.Tn FreeBSD> or E<.Tn ATT>. The release should be the "
16701 "standard release nomenclature for the system specified, for example, 4.3, "
16702 "4.3+Tahoe, V.3, V.4. Unrecognized arguments are displayed as given in the "
16703 "page footer. For instance, a typical footer might be:"
16707 #: build/C/man7/mdoc.samples.7:576
16709 msgid "\\&.Os 4.3BSD"
16712 #. type: Plain text
16713 #: build/C/man7/mdoc.samples.7:579
16718 #: build/C/man7/mdoc.samples.7:579
16720 msgid "\\&.Os FreeBSD 2.2"
16723 #. type: Plain text
16724 #: build/C/man7/mdoc.samples.7:582
16725 msgid "or for a locally produced set"
16729 #: build/C/man7/mdoc.samples.7:583
16731 msgid "\\&.Os CS Department"
16734 #. type: Plain text
16735 #: build/C/man7/mdoc.samples.7:598
16737 "The Berkeley default, E<.Ql \\&.Os> without an argument, has been defined as "
16738 "E<.Tn BSD> in the site-specific file E<.Pa "
16739 "/usr/share/tmac/mdoc/doc-common>. It really should default to E<.Tn "
16740 "LOCAL>. Note, if the E<.Ql \\&.Os> macro is not present, the bottom left "
16741 "corner of the page will be ugly."
16745 #: build/C/man7/mdoc.samples.7:598
16747 msgid "Li \\&.Dd month day, year"
16750 #. type: Plain text
16751 #: build/C/man7/mdoc.samples.7:600
16752 msgid "The date should be written formally:"
16756 #: build/C/man7/mdoc.samples.7:602
16758 msgid "January 25, 1989"
16762 #: build/C/man7/mdoc.samples.7:604
16764 msgid "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
16768 #: build/C/man7/mdoc.samples.7:605
16770 msgid "What's in a name..."
16773 #. type: Plain text
16774 #: build/C/man7/mdoc.samples.7:622
16776 "The manual domain macro names are derived from the day to day informal "
16777 "language used to describe commands, subroutines and related files. Slightly "
16778 "different variations of this language are used to describe the three "
16779 "different aspects of writing a man page. First, there is the description of "
16780 "E<.Nm \\-mdoc> macro request usage. Second is the description of a E<.Ux> "
16781 "command E<.Em with> E<.Nm \\-mdoc> macros and third, the description of a "
16782 "command to a user in the verbal sense; that is, discussion of a command in "
16783 "the text of a man page."
16786 #. type: Plain text
16787 #: build/C/man7/mdoc.samples.7:627
16789 "In the first case, E<.Xr troff 1> macros are themselves a type of command; "
16790 "the general syntax for a troff command is:"
16793 #. type: Plain text
16794 #: build/C/man7/mdoc.samples.7:629
16796 msgid "\\&.Va argument1 argument2 ... argument9\n"
16799 #. type: Plain text
16800 #: build/C/man7/mdoc.samples.7:643
16802 "The E<.Ql \\&.Va> is a macro command or request, and anything following it "
16803 "is an argument to be processed. In the second case, the description of a "
16804 "E<.Ux> command using the content macros is a bit more involved; a typical "
16805 "E<.Sx SYNOPSIS> command line might be displayed as:"
16808 #. type: Plain text
16809 #: build/C/man7/mdoc.samples.7:647
16814 "E<.Ar infile outfile>\n"
16817 #. type: Plain text
16818 #: build/C/man7/mdoc.samples.7:667
16820 "Here, E<.Nm filter> is the command name and the bracketed string E<.Fl flag> "
16821 "is a E<.Em flag> argument designated as optional by the option brackets. In "
16822 "E<.Nm \\-mdoc> terms, E<.Ar infile> and E<.Ar outfile> are called E<.Em "
16823 "arguments>. The macros which formatted the above example:"
16826 #. type: Plain text
16827 #: build/C/man7/mdoc.samples.7:671
16831 "\\&.Op \\&Fl flag\n"
16832 "\\&.Ar infile outfile\n"
16835 #. type: Plain text
16836 #: build/C/man7/mdoc.samples.7:685
16838 "In the third case, discussion of commands and command syntax includes both "
16839 "examples above, but may add more detail. The arguments E<.Ar infile> and "
16840 "E<.Ar outfile> from the example above might be referred to as E<.Em "
16841 "operands> or E<.Em file arguments>. Some command-line argument lists are "
16846 #: build/C/man7/mdoc.samples.7:686
16851 #. type: Plain text
16852 #: build/C/man7/mdoc.samples.7:699
16854 "E<.Op Fl eiknqrstv> E<.Op Fl D Ar variable> E<.Op Fl d Ar flags> E<.Op Fl f "
16855 "Ar makefile> E<.Bk -words> E<.Op Fl I Ar directory> E<.Ek> E<.Op Fl j Ar "
16856 "max_jobs> E<.Op Ar variable=value> E<.Bk -words> E<.Op Ar target ...> E<.Ek>"
16859 #. type: Plain text
16860 #: build/C/man7/mdoc.samples.7:725
16862 "Here one might talk about the command E<.Nm make> and qualify the argument "
16863 "E<.Ar makefile>, as an argument to the flag, E<.Fl f>, or discuss the "
16864 "optional file operand E<.Ar target>. In the verbal context, such detail can "
16865 "prevent confusion, however the E<.Nm \\-mdoc> package does not have a macro "
16866 "for an argument E<.Em to> a flag. Instead the E<.Ql \\&Ar> argument macro "
16867 "is used for an operand or file argument like E<.Ar target> as well as an "
16868 "argument to a flag like E<.Ar variable>. The make command line was produced "
16872 #. type: Plain text
16873 #: build/C/man7/mdoc.samples.7:737
16877 "\\&.Op Fl eiknqrstv\n"
16878 "\\&.Op Fl D Ar variable\n"
16879 "\\&.Op Fl d Ar flags\n"
16880 "\\&.Op Fl f Ar makefile\n"
16881 "\\&.Op Fl I Ar directory\n"
16882 "\\&.Op Fl j Ar max_jobs\n"
16883 "\\&.Op Ar variable=value\n"
16885 "\\&.Op Ar target ...\n"
16889 #. type: Plain text
16890 #: build/C/man7/mdoc.samples.7:745
16891 msgid "The E<.Ql \\&.Bk> and E<.Ql \\&.Ek> macros are explained in E<.Sx Keeps>."
16895 #: build/C/man7/mdoc.samples.7:745
16897 msgid "General Syntax"
16900 #. type: Plain text
16901 #: build/C/man7/mdoc.samples.7:768
16903 "The manual domain and general text domain macros share a similar syntax with "
16904 "a few minor deviations: E<.Ql \\&.Ar>, E<.Ql \\&.Fl>, E<.Ql \\&.Nm>, and "
16905 "E<.Ql \\&.Pa> differ only when called without arguments; E<.Ql \\&.Fn> and "
16906 "E<.Ql \\&.Xr> impose an order on their argument lists and the E<.Ql \\&.Op> "
16907 "and E<.Ql \\&.Fn> macros have nesting limitations. All content macros are "
16908 "capable of recognizing and properly handling punctuation, provided each "
16909 "punctuation character is separated by a leading space. If a request is "
16914 #: build/C/man7/mdoc.samples.7:769
16916 msgid "\\&.Li sptr, ptr),"
16919 #. type: Plain text
16920 #: build/C/man7/mdoc.samples.7:772 build/C/man7/mdoc.samples.7:782
16921 msgid "The result is:"
16925 #: build/C/man7/mdoc.samples.7:773
16927 msgid "Li sptr, ptr),"
16930 #. type: Plain text
16931 #: build/C/man7/mdoc.samples.7:778
16933 "The punctuation is not recognized and all is output in the literal font. If "
16934 "the punctuation is separated by a leading white space:"
16938 #: build/C/man7/mdoc.samples.7:779
16940 msgid "\\&.Li \"sptr , ptr ) ,\""
16944 #: build/C/man7/mdoc.samples.7:783
16946 msgid "Li sptr , ptr ) ,"
16949 #. type: Plain text
16950 #: build/C/man7/mdoc.samples.7:787
16952 "The punctuation is now recognized and is output in the default font "
16953 "distinguishing it from the strings in literal font."
16956 #. type: Plain text
16957 #: build/C/man7/mdoc.samples.7:796
16959 "To remove the special meaning from a punctuation character escape it with "
16960 "E<.Ql \\e&>. E<.Xr Troff> is limited as a macro language, and has "
16961 "difficulty when presented with a string containing a member of the "
16962 "mathematical, logical or quotation set:"
16965 #. type: Plain text
16966 #: build/C/man7/mdoc.samples.7:798
16968 msgid "\\&{+,\\-,/,*,\\&%,E<lt>,E<gt>,E<lt>=,E<gt>=,=,==,&,`,',\"}\n"
16971 #. type: Plain text
16972 #: build/C/man7/mdoc.samples.7:810
16974 "The problem is that E<.Xr troff> may assume it is supposed to actually "
16975 "perform the operation or evaluation suggested by the characters. To prevent "
16976 "the accidental evaluation of these characters, escape them with E<.Ql "
16977 "\\e&>. Typical syntax is shown in the first content macro displayed below, "
16982 #: build/C/man7/mdoc.samples.7:810
16984 msgid "MANUAL DOMAIN"
16988 #: build/C/man7/mdoc.samples.7:811
16990 msgid "Address Macro"
16993 #. type: Plain text
16994 #: build/C/man7/mdoc.samples.7:814
16996 "The address macro identifies an address construct of the form "
16997 "addr1[,addr2[,addr3]]."
17001 #: build/C/man7/mdoc.samples.7:815
17003 msgid "Usage: .Ad address ... \\*(Pu"
17007 #: build/C/man7/mdoc.samples.7:817
17009 msgid "Li \\&.Ad addr1"
17012 #. type: Plain text
17013 #: build/C/man7/mdoc.samples.7:819
17014 msgid "E<.Ad addr1>"
17018 #: build/C/man7/mdoc.samples.7:819
17020 msgid "Li \\&.Ad addr1\\ ."
17023 #. type: Plain text
17024 #: build/C/man7/mdoc.samples.7:821
17025 msgid "E<.Ad addr1>."
17029 #: build/C/man7/mdoc.samples.7:821
17031 msgid "Li \\&.Ad addr1\\ , file2"
17034 #. type: Plain text
17035 #: build/C/man7/mdoc.samples.7:823
17036 msgid "E<.Ad addr1 , file2>"
17040 #: build/C/man7/mdoc.samples.7:823
17042 msgid "Li \\&.Ad f1\\ , f2\\ , f3\\ :"
17045 #. type: Plain text
17046 #: build/C/man7/mdoc.samples.7:825
17047 msgid "E<.Ad f1 , f2 , f3>:"
17051 #: build/C/man7/mdoc.samples.7:825
17053 msgid "Li \\&.Ad addr\\ )\\ )\\ ,"
17056 #. type: Plain text
17057 #: build/C/man7/mdoc.samples.7:827
17058 msgid "E<.Ad addr>)),"
17061 #. type: Plain text
17062 #: build/C/man7/mdoc.samples.7:834
17064 "It is an error to call E<.Ql \\&.Ad> without arguments. E<.Ql \\&.Ad> is "
17065 "callable by other macros and is parsed."
17069 #: build/C/man7/mdoc.samples.7:834
17071 msgid "Author Name"
17074 #. type: Plain text
17075 #: build/C/man7/mdoc.samples.7:841
17077 "The E<.Ql \\&.An> macro is used to specify the name of the author of the "
17078 "item being documented, or the name of the author of the actual manual page. "
17079 "Any remaining arguments after the name information are assumed to be "
17084 #: build/C/man7/mdoc.samples.7:842
17086 msgid "Usage: .An author_name \\*(Pu"
17090 #: build/C/man7/mdoc.samples.7:844
17092 msgid "Li \\&.An Joe\\ Author"
17095 #. type: Plain text
17096 #: build/C/man7/mdoc.samples.7:846
17097 msgid "E<.An Joe Author>"
17101 #: build/C/man7/mdoc.samples.7:846
17103 msgid "Li \\&.An Joe\\ Author\\ ,"
17106 #. type: Plain text
17107 #: build/C/man7/mdoc.samples.7:848
17108 msgid "E<.An Joe\\ Author>,"
17112 #: build/C/man7/mdoc.samples.7:848
17114 msgid "Li \\&.An Joe\\ Author\\ \\&Aq\\ nobody@FreeBSD.ORG"
17117 #. type: Plain text
17118 #: build/C/man7/mdoc.samples.7:850
17119 msgid "E<.An Joe Author Aq nobody@FreeBSD.ORG>"
17123 #: build/C/man7/mdoc.samples.7:850
17125 msgid "Li \\&.An Joe\\ Author\\ )\\ )\\ ,"
17128 #. type: Plain text
17129 #: build/C/man7/mdoc.samples.7:852
17130 msgid "E<.An Joe Author>)),"
17133 #. type: Plain text
17134 #: build/C/man7/mdoc.samples.7:861
17136 "The E<.Ql \\&.An> macro is parsed and is callable. It is an error to call "
17137 "E<.Ql \\&.An> without any arguments."
17141 #: build/C/man7/mdoc.samples.7:861
17143 msgid "Argument Macro"
17146 #. type: Plain text
17147 #: build/C/man7/mdoc.samples.7:866
17149 "The E<.Ql \\&.Ar> argument macro may be used whenever a command-line "
17150 "argument is referenced."
17154 #: build/C/man7/mdoc.samples.7:867
17156 msgid "Usage: .Ar argument ... \\*(Pu"
17160 #: build/C/man7/mdoc.samples.7:869
17165 #. type: Plain text
17166 #: build/C/man7/mdoc.samples.7:871
17171 #: build/C/man7/mdoc.samples.7:871
17173 msgid "Li \\&.Ar file1"
17176 #. type: Plain text
17177 #: build/C/man7/mdoc.samples.7:873
17178 msgid "E<.Ar file1>"
17182 #: build/C/man7/mdoc.samples.7:873
17184 msgid "Li \\&.Ar file1\\ ."
17187 #. type: Plain text
17188 #: build/C/man7/mdoc.samples.7:875
17189 msgid "E<.Ar file1>."
17193 #: build/C/man7/mdoc.samples.7:875
17195 msgid "Li \\&.Ar file1 file2"
17198 #. type: Plain text
17199 #: build/C/man7/mdoc.samples.7:877
17200 msgid "E<.Ar file1 file2>"
17204 #: build/C/man7/mdoc.samples.7:877
17206 msgid "Li \\&.Ar f1 f2 f3\\ :"
17209 #. type: Plain text
17210 #: build/C/man7/mdoc.samples.7:879
17211 msgid "E<.Ar f1 f2 f3>:"
17215 #: build/C/man7/mdoc.samples.7:879
17217 msgid "Li \\&.Ar file\\ )\\ )\\ ,"
17220 #. type: Plain text
17221 #: build/C/man7/mdoc.samples.7:881
17222 msgid "E<.Ar file>)),"
17225 #. type: Plain text
17226 #: build/C/man7/mdoc.samples.7:891
17228 "If E<.Ql \\&.Ar> is called without arguments, E<.Ql \\&Ar> is assumed. The "
17229 "E<.Ql \\&.Ar> macro is parsed and is callable."
17233 #: build/C/man7/mdoc.samples.7:891
17235 msgid "Configuration Declaration (section four only)"
17238 #. type: Plain text
17239 #: build/C/man7/mdoc.samples.7:898
17241 "The E<.Ql \\&.Cd> macro is used to demonstrate a E<.Xr config 8> declaration "
17242 "for a device interface in a section four manual. This macro accepts quoted "
17243 "arguments (double quotes only)."
17247 #: build/C/man7/mdoc.samples.7:900
17249 msgid "Cd \"device le0 at scode?\""
17252 #. type: Plain text
17253 #: build/C/man7/mdoc.samples.7:903
17254 msgid "produced by: E<.Ql \".Cd device le0 at scode?\">."
17258 #: build/C/man7/mdoc.samples.7:904
17260 msgid "Command Modifier"
17263 #. type: Plain text
17264 #: build/C/man7/mdoc.samples.7:918
17266 "The command modifier is identical to the E<.Ql \\&.Fl> (flag) command with "
17267 "the exception the E<.Ql \\&.Cm> macro does not assert a dash in front of "
17268 "every argument. Traditionally flags are marked by the preceding dash, some "
17269 "commands or subsets of commands do not use them. Command modifiers may also "
17270 "be specified in conjunction with interactive commands such as editor "
17271 "commands. See E<.Sx Flags>."
17275 #: build/C/man7/mdoc.samples.7:918
17277 msgid "Defined Variables"
17280 #. type: Plain text
17281 #: build/C/man7/mdoc.samples.7:922
17283 "A variable which is defined in an include file is specified by the macro "
17288 #: build/C/man7/mdoc.samples.7:923
17290 msgid "Usage: .Dv defined_variable ... \\*(Pu"
17294 #: build/C/man7/mdoc.samples.7:925
17296 msgid "Li \".Dv MAXHOSTNAMELEN\""
17299 #. type: Plain text
17300 #: build/C/man7/mdoc.samples.7:927
17301 msgid "E<.Dv MAXHOSTNAMELEN>"
17305 #: build/C/man7/mdoc.samples.7:927
17307 msgid "Li \".Dv TIOCGPGRP )\""
17310 #. type: Plain text
17311 #: build/C/man7/mdoc.samples.7:929
17312 msgid "E<.Dv TIOCGPGRP>)"
17315 #. type: Plain text
17316 #: build/C/man7/mdoc.samples.7:936
17318 "It is an error to call E<.Ql \\&.Dv> without arguments. E<.Ql \\&.Dv> is "
17319 "parsed and is callable."
17323 #: build/C/man7/mdoc.samples.7:936
17325 msgid "Errno's (Section two only)"
17328 #. type: Plain text
17329 #: build/C/man7/mdoc.samples.7:948
17331 "The E<.Ql \\&.Er> errno macro specifies the error return value for section "
17332 "two library routines. The second example below shows E<.Ql \\&.Er> used "
17333 "with the E<.Ql \\&.Bq> general text domain macro, as it would be used in a "
17334 "section two manual page."
17338 #: build/C/man7/mdoc.samples.7:949
17340 msgid "Usage: .Er ERRNOTYPE ... \\*(Pu"
17344 #: build/C/man7/mdoc.samples.7:951
17346 msgid "Li \\&.Er ENOENT"
17349 #. type: Plain text
17350 #: build/C/man7/mdoc.samples.7:953
17351 msgid "E<.Er ENOENT>"
17355 #: build/C/man7/mdoc.samples.7:953
17357 msgid "Li \\&.Er ENOENT\\ )\\ ;"
17360 #. type: Plain text
17361 #: build/C/man7/mdoc.samples.7:955
17362 msgid "E<.Er ENOENT>);"
17366 #: build/C/man7/mdoc.samples.7:955
17368 msgid "Li \\&.Bq \\&Er ENOTDIR"
17371 #. type: Plain text
17372 #: build/C/man7/mdoc.samples.7:957
17373 msgid "E<.Bq Er ENOTDIR>"
17376 #. type: Plain text
17377 #: build/C/man7/mdoc.samples.7:965
17379 "It is an error to call E<.Ql \\&.Er> without arguments. The E<.Ql \\&.Er> "
17380 "macro is parsed and is callable."
17384 #: build/C/man7/mdoc.samples.7:965
17386 msgid "Environment Variables"
17389 #. type: Plain text
17390 #: build/C/man7/mdoc.samples.7:969
17391 msgid "The E<.Ql \\&.Ev> macro specifies an environment variable."
17395 #: build/C/man7/mdoc.samples.7:970
17397 msgid "Usage: .Ev argument ... \\*(Pu"
17401 #: build/C/man7/mdoc.samples.7:972
17403 msgid "Li \\&.Ev DISPLAY"
17406 #. type: Plain text
17407 #: build/C/man7/mdoc.samples.7:974
17408 msgid "E<.Ev DISPLAY>"
17412 #: build/C/man7/mdoc.samples.7:974
17414 msgid "Li \\&.Ev PATH\\ ."
17417 #. type: Plain text
17418 #: build/C/man7/mdoc.samples.7:976
17419 msgid "E<.Ev PATH>."
17423 #: build/C/man7/mdoc.samples.7:976
17425 msgid "Li \\&.Ev PRINTER\\ )\\ )\\ ,"
17428 #. type: Plain text
17429 #: build/C/man7/mdoc.samples.7:978
17430 msgid "E<.Ev PRINTER>)),"
17433 #. type: Plain text
17434 #: build/C/man7/mdoc.samples.7:986
17436 "It is an error to call E<.Ql \\&.Ev> without arguments. The E<.Ql \\&.Ev> "
17437 "macro is parsed and is callable."
17441 #: build/C/man7/mdoc.samples.7:986
17443 msgid "Function Argument"
17446 #. type: Plain text
17447 #: build/C/man7/mdoc.samples.7:1005
17449 "The E<.Ql \\&.Fa> macro is used to refer to function arguments (parameters) "
17450 "outside of the E<.Sx SYNOPSIS> section of the manual or inside the E<.Sx "
17451 "SYNOPSIS> section should a parameter list be too long for the E<.Ql \\&.Fn> "
17452 "macro and the enclosure macros E<.Ql \\&.Fo> and E<.Ql \\&.Fc> must be "
17453 "used. E<.Ql \\&.Fa> may also be used to refer to structure members."
17457 #: build/C/man7/mdoc.samples.7:1006
17459 msgid "Usage: .Fa function_argument ... \\*(Pu"
17463 #: build/C/man7/mdoc.samples.7:1008
17465 msgid "Li \\&.Fa d_namlen\\ )\\ )\\ ,"
17468 #. type: Plain text
17469 #: build/C/man7/mdoc.samples.7:1010
17470 msgid "E<.Fa d_namlen>)),"
17474 #: build/C/man7/mdoc.samples.7:1010
17476 msgid "Li \\&.Fa iov_len"
17479 #. type: Plain text
17480 #: build/C/man7/mdoc.samples.7:1012
17481 msgid "E<.Fa iov_len>"
17484 #. type: Plain text
17485 #: build/C/man7/mdoc.samples.7:1019
17487 "It is an error to call E<.Ql \\&.Fa> without arguments. E<.Ql \\&.Fa> is "
17488 "parsed and is callable."
17492 #: build/C/man7/mdoc.samples.7:1019
17494 msgid "Function Declaration"
17497 #. type: Plain text
17498 #: build/C/man7/mdoc.samples.7:1030
17500 "The E<.Ql \\&.Fd> macro is used in the E<.Sx SYNOPSIS> section with section "
17501 "two or three functions. The E<.Ql \\&.Fd> macro does not call other macros "
17502 "and is not callable by other macros."
17506 #: build/C/man7/mdoc.samples.7:1031
17508 msgid "Usage: .Fd include_file (or defined variable)"
17511 #. type: Plain text
17512 #: build/C/man7/mdoc.samples.7:1042
17514 "In the E<.Sx SYNOPSIS> section a E<.Ql \\&.Fd> request causes a line break "
17515 "if a function has already been presented and a break has not occurred. This "
17516 "leaves a nice vertical space in between the previous function call and the "
17517 "declaration for the next function."
17521 #: build/C/man7/mdoc.samples.7:1042
17526 #. type: Plain text
17527 #: build/C/man7/mdoc.samples.7:1055
17529 "The E<.Ql \\&.Fl> macro handles command-line flags. It prepends a dash, "
17530 "E<.Ql \\->, to the flag. For interactive command flags, which are not "
17531 "prepended with a dash, the E<.Ql \\&.Cm> (command modifier) macro is "
17532 "identical, but without the dash."
17536 #: build/C/man7/mdoc.samples.7:1056
17538 msgid "Usage: .Fl argument ... \\*(Pu"
17542 #: build/C/man7/mdoc.samples.7:1058
17547 #. type: Plain text
17548 #: build/C/man7/mdoc.samples.7:1060
17553 #: build/C/man7/mdoc.samples.7:1060
17555 msgid "Li \\&.Fl cfv"
17558 #. type: Plain text
17559 #: build/C/man7/mdoc.samples.7:1062
17564 #: build/C/man7/mdoc.samples.7:1062
17566 msgid "Li \\&.Fl cfv\\ ."
17569 #. type: Plain text
17570 #: build/C/man7/mdoc.samples.7:1064
17571 msgid "E<.Fl cfv>."
17575 #: build/C/man7/mdoc.samples.7:1064
17577 msgid "Li \\&.Fl s v t"
17580 #. type: Plain text
17581 #: build/C/man7/mdoc.samples.7:1066
17582 msgid "E<.Fl s v t>"
17586 #: build/C/man7/mdoc.samples.7:1066
17588 msgid "Li \\&.Fl -\\ ,"
17591 #. type: Plain text
17592 #: build/C/man7/mdoc.samples.7:1068
17597 #: build/C/man7/mdoc.samples.7:1068
17599 msgid "Li \\&.Fl xyz\\ )\\ ,"
17602 #. type: Plain text
17603 #: build/C/man7/mdoc.samples.7:1070
17604 msgid "E<.Fl xyz>),"
17607 #. type: Plain text
17608 #: build/C/man7/mdoc.samples.7:1082
17610 "The E<.Ql \\&.Fl> macro without any arguments results in a dash representing "
17611 "I<stdin>/I<stdout>. Note that giving E<.Ql \\&.Fl> a single dash, will "
17612 "result in two dashes. The E<.Ql \\&.Fl> macro is parsed and is callable."
17616 #: build/C/man7/mdoc.samples.7:1082
17618 msgid "Functions (library routines)"
17621 #. type: Plain text
17622 #: build/C/man7/mdoc.samples.7:1084
17623 msgid "The .Fn macro is modeled on ANSI C conventions."
17626 #. type: Plain text
17627 #: build/C/man7/mdoc.samples.7:1086
17629 msgid "Usage: .Fn [type] function [[type] parameters ... \\*(Pu]\n"
17633 #: build/C/man7/mdoc.samples.7:1088
17635 msgid "Li \"\\&.Fn getchar\""
17638 #. type: Plain text
17639 #: build/C/man7/mdoc.samples.7:1090
17640 msgid "E<.Fn getchar>"
17644 #: build/C/man7/mdoc.samples.7:1090
17646 msgid "Li \"\\&.Fn strlen ) ,\""
17649 #. type: Plain text
17650 #: build/C/man7/mdoc.samples.7:1092
17651 msgid "E<.Fn strlen>),"
17655 #: build/C/man7/mdoc.samples.7:1092
17657 msgid "Li \\&.Fn \"\\*qint align\\*q\" \"\\*qconst * char *sptrs\\*q\" ,"
17660 #. type: Plain text
17661 #: build/C/man7/mdoc.samples.7:1094
17662 msgid "E<.Fn \"int align\" \"const * char *sptrs\">,"
17665 #. type: Plain text
17666 #: build/C/man7/mdoc.samples.7:1107
17668 "It is an error to call E<.Ql \\&.Fn> without any arguments. The E<.Ql "
17669 "\\&.Fn> macro is parsed and is callable, note that any call to another macro "
17670 "signals the end of the E<.Ql \\&.Fn> call (it will close-parenthesis at that "
17674 #. type: Plain text
17675 #: build/C/man7/mdoc.samples.7:1121
17677 "For functions that have more than eight parameters (and this is rare), the "
17678 "macros E<.Ql \\&.Fo> (function open) and E<.Ql \\&.Fc> (function close) "
17679 "may be used with E<.Ql \\&.Fa> (function argument) to get around the "
17680 "limitation. For example:"
17683 #. type: Plain text
17684 #: build/C/man7/mdoc.samples.7:1133
17687 "\\&.Fo \"int res_mkquery\"\n"
17688 "\\&.Fa \"int op\"\n"
17689 "\\&.Fa \"char *dname\"\n"
17690 "\\&.Fa \"int class\"\n"
17691 "\\&.Fa \"int type\"\n"
17692 "\\&.Fa \"char *data\"\n"
17693 "\\&.Fa \"int datalen\"\n"
17694 "\\&.Fa \"struct rrec *newrr\"\n"
17695 "\\&.Fa \"char *buf\"\n"
17696 "\\&.Fa \"int buflen\"\n"
17700 #. type: Plain text
17701 #: build/C/man7/mdoc.samples.7:1136 build/C/man7/mdoc.samples.7:2480
17705 #. type: Plain text
17706 #: build/C/man7/mdoc.samples.7:1148
17709 "E<.Fo \"int res_mkquery\">\n"
17710 "E<.Fa \"int op\">\n"
17711 "E<.Fa \"char *dname\">\n"
17712 "E<.Fa \"int class\">\n"
17713 "E<.Fa \"int type\">\n"
17714 "E<.Fa \"char *data\">\n"
17715 "E<.Fa \"int datalen\">\n"
17716 "E<.Fa \"struct rrec *newrr\">\n"
17717 "E<.Fa \"char *buf\">\n"
17718 "E<.Fa \"int buflen\">\n"
17722 #. type: Plain text
17723 #: build/C/man7/mdoc.samples.7:1171
17725 "The E<.Ql \\&.Fo> and E<.Ql \\&.Fc> macros are parsed and are callable. In "
17726 "the E<.Sx SYNOPSIS> section, the function will always begin at the beginning "
17727 "of line. If there is more than one function presented in the E<.Sx "
17728 "SYNOPSIS> section and a function type has not been given, a line break will "
17729 "occur, leaving a nice vertical space between the current function name and "
17730 "the one prior. At the moment, E<.Ql \\&.Fn> does not check its word "
17731 "boundaries against troff line lengths and may split across a newline "
17732 "ungracefully. This will be fixed in the near future."
17736 #: build/C/man7/mdoc.samples.7:1171
17738 msgid "Function Type"
17741 #. type: Plain text
17742 #: build/C/man7/mdoc.samples.7:1182
17744 "This macro is intended for the E<.Sx SYNOPSIS> section. It may be used "
17745 "anywhere else in the man page without problems, but its main purpose is to "
17746 "present the function type in kernel normal form for the E<.Sx SYNOPSIS> of "
17747 "sections two and three (it causes a line break allowing the function name to "
17748 "appear on the next line)."
17752 #: build/C/man7/mdoc.samples.7:1183
17754 msgid "Usage: .Ft type ... \\*(Pu"
17758 #: build/C/man7/mdoc.samples.7:1185
17760 msgid "Li \\&.Ft struct stat"
17763 #. type: Plain text
17764 #: build/C/man7/mdoc.samples.7:1187
17765 msgid "E<.Ft struct stat>"
17768 #. type: Plain text
17769 #: build/C/man7/mdoc.samples.7:1192
17770 msgid "The E<.Ql \\&.Ft> request is not callable by other macros."
17774 #: build/C/man7/mdoc.samples.7:1192
17776 msgid "Interactive Commands"
17779 #. type: Plain text
17780 #: build/C/man7/mdoc.samples.7:1196
17781 msgid "The E<.Ql \\&.Ic> macro designates an interactive or internal command."
17785 #: build/C/man7/mdoc.samples.7:1197
17787 msgid "Usage: .Ic argument ... \\*(Pu"
17791 #: build/C/man7/mdoc.samples.7:1199
17793 msgid "Li \\&.Ic :wq"
17796 #. type: Plain text
17797 #: build/C/man7/mdoc.samples.7:1201
17802 #: build/C/man7/mdoc.samples.7:1201
17804 msgid "Li \\&.Ic do while {...}"
17807 #. type: Plain text
17808 #: build/C/man7/mdoc.samples.7:1203
17809 msgid "E<.Ic do while {...}>"
17813 #: build/C/man7/mdoc.samples.7:1203
17815 msgid "Li \\&.Ic setenv\\ , unsetenv"
17818 #. type: Plain text
17819 #: build/C/man7/mdoc.samples.7:1205
17820 msgid "E<.Ic setenv , unsetenv>"
17823 #. type: Plain text
17824 #: build/C/man7/mdoc.samples.7:1213
17826 "It is an error to call E<.Ql \\&.Ic> without arguments. The E<.Ql \\&.Ic> "
17827 "macro is parsed and is callable."
17831 #: build/C/man7/mdoc.samples.7:1213
17836 #. type: Plain text
17837 #: build/C/man7/mdoc.samples.7:1249
17839 "The E<.Ql \\&.Nm> macro is used for the document title or subject name. It "
17840 "has the peculiarity of remembering the first argument it was called with, "
17841 "which should always be the subject name of the page. When called without "
17842 "arguments, E<.Ql \\&.Nm> regurgitates this initial name for the sole purpose "
17843 "of making less work for the author. Note: a section two or three document "
17844 "function name is addressed with the E<.Ql \\&.Nm> in the E<.Sx NAME> "
17845 "section, and with E<.Ql \\&.Fn> in the E<.Sx SYNOPSIS> and remaining "
17846 "sections. For interactive commands, such as the E<.Ql while> command "
17847 "keyword in E<.Xr csh 1>, the E<.Ql \\&.Ic> macro should be used. While the "
17848 "E<.Ql \\&.Ic> is nearly identical to E<.Ql \\&.Nm>, it can not recall the "
17849 "first argument it was invoked with."
17853 #: build/C/man7/mdoc.samples.7:1250
17855 msgid "Usage: .Nm argument ... \\*(Pu"
17859 #: build/C/man7/mdoc.samples.7:1252
17861 msgid "Li \\&.Nm mdoc.sample"
17864 #. type: Plain text
17865 #: build/C/man7/mdoc.samples.7:1254
17866 msgid "E<.Nm mdoc.sample>"
17870 #: build/C/man7/mdoc.samples.7:1254
17872 msgid "Li \\&.Nm \\e-mdoc"
17875 #. type: Plain text
17876 #: build/C/man7/mdoc.samples.7:1256
17877 msgid "E<.Nm \\-mdoc>."
17881 #: build/C/man7/mdoc.samples.7:1256
17883 msgid "Li \\&.Nm foo\\ )\\ )\\ ,"
17886 #. type: Plain text
17887 #: build/C/man7/mdoc.samples.7:1258
17888 msgid "E<.Nm foo>)),"
17892 #: build/C/man7/mdoc.samples.7:1258
17897 #. type: Plain text
17898 #: build/C/man7/mdoc.samples.7:1260
17902 #. type: Plain text
17903 #: build/C/man7/mdoc.samples.7:1265
17904 msgid "The E<.Ql \\&.Nm> macro is parsed and is callable."
17908 #: build/C/man7/mdoc.samples.7:1265
17913 #. type: Plain text
17914 #: build/C/man7/mdoc.samples.7:1277
17916 "The E<.Ql \\&.Op> macro places option brackets around the any remaining "
17917 "arguments on the command line, and places any trailing punctuation outside "
17918 "the brackets. The macros E<.Ql \\&.Oc> and E<.Ql \\&.Oo> may be used across "
17919 "one or more lines."
17923 #: build/C/man7/mdoc.samples.7:1278
17925 msgid "Usage: .Op options ... \\*(Pu"
17929 #: build/C/man7/mdoc.samples.7:1280
17934 #. type: Plain text
17935 #: build/C/man7/mdoc.samples.7:1282
17940 #: build/C/man7/mdoc.samples.7:1282
17942 msgid "Li \".Op Fl k\""
17945 #. type: Plain text
17946 #: build/C/man7/mdoc.samples.7:1284
17947 msgid "E<.Op Fl k>"
17951 #: build/C/man7/mdoc.samples.7:1284
17953 msgid "Li \".Op Fl k ) .\""
17956 #. type: Plain text
17957 #: build/C/man7/mdoc.samples.7:1286
17958 msgid "E<.Op Fl k>)."
17962 #: build/C/man7/mdoc.samples.7:1286
17964 msgid "Li \".Op Fl k Ar kookfile\""
17967 #. type: Plain text
17968 #: build/C/man7/mdoc.samples.7:1288
17969 msgid "E<.Op Fl k Ar kookfile>"
17973 #: build/C/man7/mdoc.samples.7:1288
17975 msgid "Li \".Op Fl k Ar kookfile ,\""
17978 #. type: Plain text
17979 #: build/C/man7/mdoc.samples.7:1290
17980 msgid "E<.Op Fl k Ar kookfile>,"
17984 #: build/C/man7/mdoc.samples.7:1290
17986 msgid "Li \".Op Ar objfil Op Ar corfil\""
17989 #. type: Plain text
17990 #: build/C/man7/mdoc.samples.7:1292
17991 msgid "E<.Op Ar objfil Op Ar corfil>"
17995 #: build/C/man7/mdoc.samples.7:1292
17997 msgid "Li \".Op Fl c Ar objfil Op Ar corfil ,\""
18000 #. type: Plain text
18001 #: build/C/man7/mdoc.samples.7:1294
18002 msgid "E<.Op Fl c Ar objfil Op Ar corfil>,"
18006 #: build/C/man7/mdoc.samples.7:1294
18008 msgid "Li \\&.Op word1 word2"
18011 #. type: Plain text
18012 #: build/C/man7/mdoc.samples.7:1296
18013 msgid "E<.Op word1 word2>"
18016 #. type: Plain text
18017 #: build/C/man7/mdoc.samples.7:1303
18018 msgid "The E<.Ql \\&.Oc> and E<.Ql \\&.Oo> macros:"
18021 #. type: Plain text
18022 #: build/C/man7/mdoc.samples.7:1309
18026 "\\&.Op \\&Fl k \\&Ar kilobytes\n"
18027 "\\&.Op \\&Fl i \\&Ar interval\n"
18028 "\\&.Op \\&Fl c \\&Ar count\n"
18032 #. type: Plain text
18033 #: build/C/man7/mdoc.samples.7:1317
18035 "Produce: E<.Oo> E<.Op Fl k Ar kilobytes> E<.Op Fl i Ar interval> E<.Op Fl c "
18039 #. type: Plain text
18040 #: build/C/man7/mdoc.samples.7:1324
18042 "The macros E<.Ql \\&.Op>, E<.Ql \\&.Oc> and E<.Ql \\&.Oo> are parsed and are "
18047 #: build/C/man7/mdoc.samples.7:1324
18052 #. type: Plain text
18053 #: build/C/man7/mdoc.samples.7:1328
18054 msgid "The E<.Ql \\&.Pa> macro formats pathnames or filenames."
18058 #: build/C/man7/mdoc.samples.7:1329
18060 msgid "Usage: .Pa pathname \\*(Pu"
18064 #: build/C/man7/mdoc.samples.7:1331
18066 msgid "Li \\&.Pa /usr/share"
18069 #. type: Plain text
18070 #: build/C/man7/mdoc.samples.7:1333
18071 msgid "E<.Pa /usr/share>"
18075 #: build/C/man7/mdoc.samples.7:1333
18077 msgid "Li \\&.Pa /tmp/fooXXXXX\\ )\\ ."
18080 #. type: Plain text
18081 #: build/C/man7/mdoc.samples.7:1335
18082 msgid "E<.Pa /tmp/fooXXXXX>)."
18085 #. type: Plain text
18086 #: build/C/man7/mdoc.samples.7:1340
18087 msgid "The E<.Ql \\&.Pa> macro is parsed and is callable."
18091 #: build/C/man7/mdoc.samples.7:1340
18096 #. type: Plain text
18097 #: build/C/man7/mdoc.samples.7:1342
18098 msgid "Generic variable reference:"
18102 #: build/C/man7/mdoc.samples.7:1343
18104 msgid "Usage: .Va variable ... \\*(Pu"
18108 #: build/C/man7/mdoc.samples.7:1345
18110 msgid "Li \\&.Va count"
18113 #. type: Plain text
18114 #: build/C/man7/mdoc.samples.7:1347
18115 msgid "E<.Va count>"
18119 #: build/C/man7/mdoc.samples.7:1347
18121 msgid "Li \\&.Va settimer ,"
18124 #. type: Plain text
18125 #: build/C/man7/mdoc.samples.7:1349
18126 msgid "E<.Va settimer>,"
18130 #: build/C/man7/mdoc.samples.7:1349
18132 msgid "Li \\&.Va int\\ *prt\\ )\\ :"
18135 #. type: Plain text
18136 #: build/C/man7/mdoc.samples.7:1351
18137 msgid "E<.Va int\\ *prt>):"
18141 #: build/C/man7/mdoc.samples.7:1351
18143 msgid "Li \\&.Va char\\ s\\ ]\\ )\\ )\\ ,"
18146 #. type: Plain text
18147 #: build/C/man7/mdoc.samples.7:1353
18148 msgid "E<.Va char\\ s>])),"
18151 #. type: Plain text
18152 #: build/C/man7/mdoc.samples.7:1361
18154 "It is an error to call E<.Ql \\&.Va> without any arguments. The E<.Ql "
18155 "\\&.Va> macro is parsed and is callable."
18159 #: build/C/man7/mdoc.samples.7:1361
18161 msgid "Manual Page Cross References"
18164 #. type: Plain text
18165 #: build/C/man7/mdoc.samples.7:1369
18167 "The E<.Ql \\&.Xr> macro expects the first argument to be a manual page name, "
18168 "and the second argument, if it exists, to be either a section page number or "
18169 "punctuation. Any remaining arguments are assumed to be punctuation."
18173 #: build/C/man7/mdoc.samples.7:1370
18175 msgid "Usage: .Xr man_page [1,...,8] \\*(Pu"
18179 #: build/C/man7/mdoc.samples.7:1372
18181 msgid "Li \\&.Xr mdoc"
18184 #. type: Plain text
18185 #: build/C/man7/mdoc.samples.7:1374
18186 msgid "E<.Xr mdoc>"
18190 #: build/C/man7/mdoc.samples.7:1374
18192 msgid "Li \\&.Xr mdoc\\ ,"
18195 #. type: Plain text
18196 #: build/C/man7/mdoc.samples.7:1376
18197 msgid "E<.Xr mdoc>,"
18201 #: build/C/man7/mdoc.samples.7:1376
18203 msgid "Li \\&.Xr mdoc 7"
18206 #. type: Plain text
18207 #: build/C/man7/mdoc.samples.7:1378
18208 msgid "E<.Xr mdoc 7>"
18212 #: build/C/man7/mdoc.samples.7:1378
18214 msgid "Li \\&.Xr mdoc 7\\ )\\ )\\ ,"
18217 #. type: Plain text
18218 #: build/C/man7/mdoc.samples.7:1380
18219 msgid "E<.Xr mdoc 7>)),"
18222 #. type: Plain text
18223 #: build/C/man7/mdoc.samples.7:1389
18225 "The E<.Ql \\&.Xr> macro is parsed and is callable. It is an error to call "
18226 "E<.Ql \\&.Xr> without any arguments."
18230 #: build/C/man7/mdoc.samples.7:1389
18232 msgid "GENERAL TEXT DOMAIN"
18236 #: build/C/man7/mdoc.samples.7:1390
18241 #. type: Plain text
18242 #: build/C/man7/mdoc.samples.7:1393
18244 msgid "Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \\*(Pu\n"
18248 #: build/C/man7/mdoc.samples.7:1395
18253 #. type: Plain text
18254 #: build/C/man7/mdoc.samples.7:1397
18259 #: build/C/man7/mdoc.samples.7:1397
18261 msgid "Li \".At v6 .\""
18264 #. type: Plain text
18265 #: build/C/man7/mdoc.samples.7:1399
18269 #. type: Plain text
18270 #: build/C/man7/mdoc.samples.7:1409
18272 "The E<.Ql \\&.At> macro is E<.Em not> parsed and E<.Em not> callable It "
18273 "accepts at most two arguments."
18277 #: build/C/man7/mdoc.samples.7:1409
18283 #: build/C/man7/mdoc.samples.7:1410
18285 msgid "Usage: .Bx [Version/release] ... \\*(Pu"
18289 #: build/C/man7/mdoc.samples.7:1412
18294 #. type: Plain text
18295 #: build/C/man7/mdoc.samples.7:1414
18300 #: build/C/man7/mdoc.samples.7:1414
18302 msgid "Li \".Bx 4.3 .\""
18305 #. type: Plain text
18306 #: build/C/man7/mdoc.samples.7:1416
18307 msgid "E<.Bx 4.3>."
18310 #. type: Plain text
18311 #: build/C/man7/mdoc.samples.7:1421
18312 msgid "The E<.Ql \\&.Bx> macro is parsed and is callable."
18316 #: build/C/man7/mdoc.samples.7:1421
18318 msgid "FreeBSD Macro"
18321 #. type: Plain text
18322 #: build/C/man7/mdoc.samples.7:1424
18324 msgid "Usage: .Fx Version.release ... \\*(Pu\n"
18328 #: build/C/man7/mdoc.samples.7:1426
18330 msgid "Li \".Fx 2.2 .\""
18333 #. type: Plain text
18334 #: build/C/man7/mdoc.samples.7:1428
18335 msgid "E<.Fx 2.2>."
18338 #. type: Plain text
18339 #: build/C/man7/mdoc.samples.7:1438
18341 "The E<.Ql \\&.Fx> macro is E<.Em not> parsed and E<.Em not> callable It "
18342 "accepts at most two arguments."
18346 #: build/C/man7/mdoc.samples.7:1438
18352 #: build/C/man7/mdoc.samples.7:1439
18354 msgid "Usage: .Ux ... \\*(Pu"
18358 #: build/C/man7/mdoc.samples.7:1441
18363 #. type: Plain text
18364 #: build/C/man7/mdoc.samples.7:1443
18368 #. type: Plain text
18369 #: build/C/man7/mdoc.samples.7:1448
18370 msgid "The E<.Ql \\&.Ux> macro is parsed and is callable."
18374 #: build/C/man7/mdoc.samples.7:1448
18376 msgid "Enclosure and Quoting Macros"
18379 #. type: Plain text
18380 #: build/C/man7/mdoc.samples.7:1470
18382 "The concept of enclosure is similar to quoting. The object being to enclose "
18383 "one or more strings between a pair of characters like quotes or "
18384 "parentheses. The terms quoting and enclosure are used interchangeably "
18385 "throughout this document. Most of the one line enclosure macros end in "
18386 "small letter E<.Ql q> to give a hint of quoting, but there are a few "
18387 "irregularities. For each enclosure macro there is also a pair of open and "
18388 "close macros which end in small letters E<.Ql o> and E<.Ql c> respectively. "
18389 "These can be used across one or more lines of text and while they have "
18390 "nesting limitations, the one line quote macros can be used inside of them."
18393 #. type: Plain text
18394 #: build/C/man7/mdoc.samples.7:1483
18397 "E<.Em \" Quote\t Close\t Open\tFunction\tResult\">\n"
18398 "\\&.Aq\t.Ac\t.Ao\tAngle Bracket Enclosure\tE<lt>stringE<gt>\n"
18399 "\\&.Bq\t.Bc\t.Bo\tBracket Enclosure\t[string]\n"
18400 "\\&.Dq\t.Dc\t.Do\tDouble Quote\t``string''\n"
18401 "\t.Ec\t.Eo\tEnclose String (in XX)\tXXstringXX\n"
18402 "\\&.Pq\t.Pc\t.Po\tParenthesis Enclosure\t(string)\n"
18403 "\\&.Ql\t\t\tQuoted Literal\t`st' or string\n"
18404 "\\&.Qq\t.Qc\t.Qo\tStraight Double Quote\t\"string\"\n"
18405 "\\&.Sq\t.Sc\t.So\tSingle Quote\t`string'\n"
18408 #. type: Plain text
18409 #: build/C/man7/mdoc.samples.7:1494
18411 "Except for the irregular macros noted below, all of the quoting macros are "
18412 "parsed and callable. All handle punctuation properly, as long as it is "
18413 "presented one character at a time and separated by spaces. The quoting "
18414 "macros examine opening and closing punctuation to determine whether it comes "
18415 "before or after the enclosing string This makes some nesting possible."
18419 #: build/C/man7/mdoc.samples.7:1495
18421 msgid "Li \\&.Ec , \\&.Eo"
18424 #. type: Plain text
18425 #: build/C/man7/mdoc.samples.7:1498
18427 "These macros expect the first argument to be the opening and closing strings "
18432 #: build/C/man7/mdoc.samples.7:1498
18437 #. type: Plain text
18438 #: build/C/man7/mdoc.samples.7:1511
18440 "The quoted literal macro behaves differently for E<.Xr troff> than E<.Xr "
18441 "nroff>. If formatted with E<.Xr nroff>, a quoted literal is always quoted. "
18442 "If formatted with troff, an item is quoted only if the width of the item is "
18443 "less than three constant width characters. This is to make short strings "
18444 "more visible where the font change to literal (constant width) is less "
18449 #: build/C/man7/mdoc.samples.7:1511
18454 #. type: Plain text
18455 #: build/C/man7/mdoc.samples.7:1513
18456 msgid "The prefix macro is not callable, but it is parsed:"
18460 #: build/C/man7/mdoc.samples.7:1514
18462 msgid "Li \".Pf ( Fa name2\""
18465 #. type: Plain text
18466 #: build/C/man7/mdoc.samples.7:1517
18467 msgid "becomes E<.Pf ( Fa name2>."
18470 #. type: Plain text
18471 #: build/C/man7/mdoc.samples.7:1522
18472 msgid "The E<.Ql \\&.Ns> (no space) macro performs the analogous suffix function."
18475 #. type: Plain text
18476 #: build/C/man7/mdoc.samples.7:1526
18477 msgid "Examples of quoting:"
18481 #: build/C/man7/mdoc.samples.7:1527
18486 #. type: Plain text
18487 #: build/C/man7/mdoc.samples.7:1529
18492 #: build/C/man7/mdoc.samples.7:1529
18494 msgid "Li \\&.Aq \\&Ar ctype.h\\ )\\ ,"
18497 #. type: Plain text
18498 #: build/C/man7/mdoc.samples.7:1531
18499 msgid "E<.Aq Ar ctype.h>),"
18503 #: build/C/man7/mdoc.samples.7:1531
18508 #. type: Plain text
18509 #: build/C/man7/mdoc.samples.7:1533
18514 #: build/C/man7/mdoc.samples.7:1533
18516 msgid "Li \\&.Bq \\&Em Greek \\&, French \\&."
18519 #. type: Plain text
18520 #: build/C/man7/mdoc.samples.7:1535
18521 msgid "E<.Bq Em Greek , French>."
18525 #: build/C/man7/mdoc.samples.7:1535
18530 #. type: Plain text
18531 #: build/C/man7/mdoc.samples.7:1537
18536 #: build/C/man7/mdoc.samples.7:1537
18538 msgid "Li \".Dq string abc .\""
18541 #. type: Plain text
18542 #: build/C/man7/mdoc.samples.7:1539
18543 msgid "E<.Dq string abc>."
18547 #: build/C/man7/mdoc.samples.7:1539
18549 msgid "Li \".Dq \\'^[A-Z]\\'\""
18552 #. type: Plain text
18553 #: build/C/man7/mdoc.samples.7:1541
18554 msgid "E<.Dq \\'^[A-Z]\\'>"
18558 #: build/C/man7/mdoc.samples.7:1541
18560 msgid "Li \"\\&.Ql man mdoc\""
18563 #. type: Plain text
18564 #: build/C/man7/mdoc.samples.7:1543
18565 msgid "E<.Ql man mdoc>"
18569 #: build/C/man7/mdoc.samples.7:1543
18574 #. type: Plain text
18575 #: build/C/man7/mdoc.samples.7:1545
18580 #: build/C/man7/mdoc.samples.7:1545
18582 msgid "Li \"\\&.Qq string ) ,\""
18585 #. type: Plain text
18586 #: build/C/man7/mdoc.samples.7:1547
18587 msgid "E<.Qq string>),"
18591 #: build/C/man7/mdoc.samples.7:1547
18593 msgid "Li \"\\&.Qq string Ns ),\""
18596 #. type: Plain text
18597 #: build/C/man7/mdoc.samples.7:1549
18598 msgid "E<.Qq string Ns ),>"
18602 #: build/C/man7/mdoc.samples.7:1549
18607 #. type: Plain text
18608 #: build/C/man7/mdoc.samples.7:1551
18613 #: build/C/man7/mdoc.samples.7:1551
18615 msgid "Li \"\\&.Sq string\""
18618 #. type: Plain text
18619 #: build/C/man7/mdoc.samples.7:1553
18620 msgid "E<.Sq string>"
18623 #. type: Plain text
18624 #: build/C/man7/mdoc.samples.7:1570
18626 "For a good example of nested enclosure macros, see the E<.Ql \\&.Op> option "
18627 "macro. It was created from the same underlying enclosure macros as those "
18628 "presented in the list above. The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> extended "
18629 "argument list macros were also built from the same underlying routines and "
18630 "are a good example of E<.Nm \\-mdoc> macro usage at its worst."
18634 #: build/C/man7/mdoc.samples.7:1570
18636 msgid "No\\-Op or Normal Text Macro"
18639 #. type: Plain text
18640 #: build/C/man7/mdoc.samples.7:1578
18642 "The macro E<.Ql \\&.No> is a hack for words in a macro command line which "
18643 "should E<.Em not> be formatted and follows the conventional syntax for "
18648 #: build/C/man7/mdoc.samples.7:1578
18650 msgid "No Space Macro"
18653 #. type: Plain text
18654 #: build/C/man7/mdoc.samples.7:1584
18656 "The E<.Ql \\&.Ns> macro eliminates unwanted spaces in between macro "
18657 "requests. It is useful for old style argument lists where there is no space "
18658 "between the flag and argument:"
18662 #: build/C/man7/mdoc.samples.7:1585
18664 msgid "Li \".Op Fl I Ns Ar directory\""
18667 #. type: Plain text
18668 #: build/C/man7/mdoc.samples.7:1588
18669 msgid "produces E<.Op Fl I Ns Ar directory>"
18672 #. type: Plain text
18673 #: build/C/man7/mdoc.samples.7:1599
18675 "Note: the E<.Ql \\&.Ns> macro always invokes the E<.Ql \\&.No> macro after "
18676 "eliminating the space unless another macro name follows it. The macro E<.Ql "
18677 "\\&.Ns> is parsed and is callable."
18681 #: build/C/man7/mdoc.samples.7:1599
18683 msgid "Section Cross References"
18686 #. type: Plain text
18687 #: build/C/man7/mdoc.samples.7:1605
18689 "The E<.Ql \\&.Sx> macro designates a reference to a section header within "
18690 "the same document. It is parsed and is callable."
18694 #: build/C/man7/mdoc.samples.7:1607
18696 msgid "Li \\&.Sx FILES"
18699 #. type: Plain text
18700 #: build/C/man7/mdoc.samples.7:1609
18701 msgid "E<.Sx FILES>"
18705 #: build/C/man7/mdoc.samples.7:1610
18707 msgid "References and Citations"
18710 #. type: Plain text
18711 #: build/C/man7/mdoc.samples.7:1614
18713 "The following macros make a modest attempt to handle references. At best, "
18714 "the macros make it convenient to manually drop in a subset of refer style "
18719 #: build/C/man7/mdoc.samples.7:1616
18724 #. type: Plain text
18725 #: build/C/man7/mdoc.samples.7:1621
18727 "Reference Start. Causes a line break and begins collection of reference "
18728 "information until the reference end macro is read."
18732 #: build/C/man7/mdoc.samples.7:1621
18737 #. type: Plain text
18738 #: build/C/man7/mdoc.samples.7:1624
18739 msgid "Reference End. The reference is printed."
18743 #: build/C/man7/mdoc.samples.7:1624
18748 #. type: Plain text
18749 #: build/C/man7/mdoc.samples.7:1626
18750 msgid "Reference author name, one name per invocation."
18754 #: build/C/man7/mdoc.samples.7:1626
18759 #. type: Plain text
18760 #: build/C/man7/mdoc.samples.7:1628
18761 msgid "Book title."
18765 #: build/C/man7/mdoc.samples.7:1628
18770 #. type: Plain text
18771 #: build/C/man7/mdoc.samples.7:1630
18772 msgid "City/place."
18776 #: build/C/man7/mdoc.samples.7:1630
18781 #. type: Plain text
18782 #: build/C/man7/mdoc.samples.7:1632
18787 #: build/C/man7/mdoc.samples.7:1632
18792 #. type: Plain text
18793 #: build/C/man7/mdoc.samples.7:1634
18794 msgid "Journal name."
18798 #: build/C/man7/mdoc.samples.7:1634
18803 #. type: Plain text
18804 #: build/C/man7/mdoc.samples.7:1636
18805 msgid "Issue number."
18809 #: build/C/man7/mdoc.samples.7:1636
18814 #. type: Plain text
18815 #: build/C/man7/mdoc.samples.7:1638
18816 msgid "Optional information."
18820 #: build/C/man7/mdoc.samples.7:1638
18825 #. type: Plain text
18826 #: build/C/man7/mdoc.samples.7:1640
18827 msgid "Page number."
18831 #: build/C/man7/mdoc.samples.7:1640
18836 #. type: Plain text
18837 #: build/C/man7/mdoc.samples.7:1642
18838 msgid "Report name."
18842 #: build/C/man7/mdoc.samples.7:1642
18847 #. type: Plain text
18848 #: build/C/man7/mdoc.samples.7:1644
18849 msgid "Title of article."
18853 #: build/C/man7/mdoc.samples.7:1644
18858 #. type: Plain text
18859 #: build/C/man7/mdoc.samples.7:1646
18863 #. type: Plain text
18864 #: build/C/man7/mdoc.samples.7:1657
18866 "The macros beginning with E<.Ql %> are not callable, and are parsed only for "
18867 "the trade name macro which returns to its caller. (And not very predictably "
18868 "at the moment either.) The purpose is to allow trade names to be pretty "
18869 "printed in E<.Xr troff Ns / Ns Xr ditroff> output."
18873 #: build/C/man7/mdoc.samples.7:1657
18875 msgid "Return Values"
18878 #. type: Plain text
18879 #: build/C/man7/mdoc.samples.7:1663
18881 "The E<.Ql \\&.Rv> macro generates text for use in the E<.Sx RETURN VALUE> "
18886 #: build/C/man7/mdoc.samples.7:1664
18888 msgid "Usage: .Rv [-std function]"
18891 #. type: Plain text
18892 #: build/C/man7/mdoc.samples.7:1668
18893 msgid "E<.Ql \\&.Rv -std atexit> will generate the following text:"
18896 #. fake section 3 to avoid error message from Rv
18898 #. type: ds section
18899 #: build/C/man7/mdoc.samples.7:1671
18904 #. and back to 7 again
18906 #. type: Plain text
18907 #: build/C/man7/mdoc.samples.7:1675
18908 msgid "E<.Rv -std atexit>"
18911 #. type: ds section
18912 #: build/C/man7/mdoc.samples.7:1675
18917 #. type: Plain text
18918 #: build/C/man7/mdoc.samples.7:1680
18919 msgid "The E<.Fl std> option is valid only for manual page sections 2 and 3."
18923 #: build/C/man7/mdoc.samples.7:1680
18925 msgid "Trade Names (or Acronyms and Type Names)"
18928 #. type: Plain text
18929 #: build/C/man7/mdoc.samples.7:1683
18931 "The trade name macro is generally a small caps macro for all uppercase words "
18932 "longer than two characters."
18936 #: build/C/man7/mdoc.samples.7:1684
18938 msgid "Usage: .Tn symbol ... \\*(Pu"
18942 #: build/C/man7/mdoc.samples.7:1686
18944 msgid "Li \\&.Tn DEC"
18947 #. type: Plain text
18948 #: build/C/man7/mdoc.samples.7:1688
18953 #: build/C/man7/mdoc.samples.7:1688
18955 msgid "Li \\&.Tn ASCII"
18958 #. type: Plain text
18959 #: build/C/man7/mdoc.samples.7:1690
18960 msgid "E<.Tn ASCII>"
18963 #. type: Plain text
18964 #: build/C/man7/mdoc.samples.7:1696
18965 msgid "The E<.Ql \\&.Tn> macro is parsed and is callable by other macros."
18969 #: build/C/man7/mdoc.samples.7:1696
18971 msgid "Extended Arguments"
18974 #. type: Plain text
18975 #: build/C/man7/mdoc.samples.7:1708
18977 "The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> macros allow one to extend an argument "
18978 "list on a macro boundary. Argument lists cannot be extended within a macro "
18979 "which expects all of its arguments on one line such as E<.Ql \\&.Op>."
18982 #. type: Plain text
18983 #: build/C/man7/mdoc.samples.7:1712
18985 "Here is an example of E<.Ql \\&.Xo> using the space mode macro to turn "
18989 #. type: Plain text
18990 #: build/C/man7/mdoc.samples.7:1718
18994 "\\&.It Xo Sy I Ar operation\n"
18995 "\\&.No \\een Ar count No \\een\n"
19000 #. type: Plain text
19001 #: build/C/man7/mdoc.samples.7:1721 build/C/man7/mdoc.samples.7:1742 build/C/man7/mdoc.samples.7:1766
19005 #. type: Plain text
19006 #: build/C/man7/mdoc.samples.7:1724 build/C/man7/mdoc.samples.7:1745
19008 msgid "E<.Sm off>\n"
19012 #: build/C/man7/mdoc.samples.7:1724
19014 msgid "Xo Sy I Ar operation"
19017 #. type: Plain text
19018 #: build/C/man7/mdoc.samples.7:1728
19021 "E<.No \\en Ar count No \\en>\n"
19026 #. type: Plain text
19027 #: build/C/man7/mdoc.samples.7:1732
19028 msgid "Another one:"
19031 #. type: Plain text
19032 #: build/C/man7/mdoc.samples.7:1739
19036 "\\&.It Cm S No \\&/ Ar old_pattern Xo\n"
19037 "\\&.No \\&/ Ar new_pattern\n"
19038 "\\&.No \\&/ Op Cm g\n"
19044 #: build/C/man7/mdoc.samples.7:1745
19046 msgid "Cm S No \\&/ Ar old_pattern Xo"
19049 #. type: Plain text
19050 #: build/C/man7/mdoc.samples.7:1750
19053 "E<.No \\&/ Ar new_pattern>\n"
19054 "E<.No \\&/ Op Cm g>\n"
19059 #. type: Plain text
19060 #: build/C/man7/mdoc.samples.7:1757
19062 "Another example of E<.Ql \\&.Xo> and using enclosure macros: Test the value "
19066 #. type: Plain text
19067 #: build/C/man7/mdoc.samples.7:1763
19072 "\\&.Oo \\e&! Oc Ns Ar variable\n"
19073 "\\&.Op Ar operator variable ...\n"
19078 #: build/C/man7/mdoc.samples.7:1768
19083 #. type: Plain text
19084 #: build/C/man7/mdoc.samples.7:1773
19088 "E<.Oo \\&! Oc Ns Ar variable>\n"
19089 "E<.Op Ar operator variable ...>\n"
19093 #. type: Plain text
19094 #: build/C/man7/mdoc.samples.7:1811
19096 "All of the above examples have used the E<.Ql \\&.Xo> macro on the argument "
19097 "list of the E<.Ql \\&.It> (list-item) macro. The extend macros are not "
19098 "used very often, and when they are it is usually to extend the list-item "
19099 "argument list. Unfortunately, this is also where the extend macros are the "
19100 "most finicky. In the first two examples, spacing was turned off; in the "
19101 "third, spacing was desired in part of the output but not all of it. To make "
19102 "these macros work in this situation make sure the E<.Ql \\&.Xo> and E<.Ql "
19103 "\\&.Xc> macros are placed as shown in the third example. If the E<.Ql "
19104 "\\&.Xo> macro is not alone on the E<.Ql \\&.It> argument list, spacing will "
19105 "be unpredictable. The E<.Ql \\&.Ns> (no space macro) must not occur as the "
19106 "first or last macro on a line in this situation. Out of 900 manual pages "
19107 "(about 1500 actual pages) currently released with E<.Bx> only fifteen use "
19108 "the E<.Ql \\&.Xo> macro."
19112 #: build/C/man7/mdoc.samples.7:1812
19114 msgid "Section Headers"
19117 #. type: Plain text
19118 #: build/C/man7/mdoc.samples.7:1825
19120 "The first three E<.Ql \\&.Sh> section header macros list below are required "
19121 "in every man page. The remaining section headers are recommended at the "
19122 "discretion of the author writing the manual page. The E<.Ql \\&.Sh> macro "
19123 "can take up to nine arguments. It is parsed and but is not callable."
19127 #: build/C/man7/mdoc.samples.7:1826
19129 msgid "\\&.Sh NAME"
19132 #. type: Plain text
19133 #: build/C/man7/mdoc.samples.7:1846
19135 "The E<.Ql \\&.Sh NAME> macro is mandatory. If not specified, the headers, "
19136 "footers and page layout defaults will not be set and things will be rather "
19137 "unpleasant. The E<.Sx NAME> section consists of at least three items. The "
19138 "first is the E<.Ql \\&.Nm> name macro naming the subject of the man page. "
19139 "The second is the Name Description macro, E<.Ql \\&.Nd>, which separates the "
19140 "subject name from the third item, which is the description. The description "
19141 "should be the most terse and lucid possible, as the space available is "
19146 #: build/C/man7/mdoc.samples.7:1846
19148 msgid "\\&.Sh SYNOPSIS"
19151 #. type: Plain text
19152 #: build/C/man7/mdoc.samples.7:1878
19154 "The E<.Sx SYNOPSIS> section describes the typical usage of the subject of a "
19155 "man page. The macros required are either E<.Ql \".Nm\">, E<.Ql \".Cd\">, "
19156 "E<.Ql \".Fn\">, (and possibly E<.Ql \".Fo\">, E<.Ql \".Fc\">, E<.Ql "
19157 "\".Fd\">, E<.Ql \".Ft\"> macros). The function name macro E<.Ql \".Fn\"> is "
19158 "required for manual page sections 2 and 3, the command and general name "
19159 "macro E<.Ql \\&.Nm> is required for sections 1, 5, 6, 7, 8. Section 4 "
19160 "manuals require a E<.Ql \".Nm\">, E<.Ql \".Fd\"> or a E<.Ql \".Cd\"> "
19161 "configuration device usage macro. Several other macros may be necessary to "
19162 "produce the synopsis line as shown below:"
19165 #. type: Plain text
19166 #: build/C/man7/mdoc.samples.7:1885
19170 "E<.Op Fl benstuv>\n"
19175 #. type: Plain text
19176 #: build/C/man7/mdoc.samples.7:1888
19177 msgid "The following macros were used:"
19181 #: build/C/man7/mdoc.samples.7:1889
19187 #: build/C/man7/mdoc.samples.7:1890
19189 msgid "\\&.Op \\&Fl benstuv"
19193 #: build/C/man7/mdoc.samples.7:1891
19195 msgid "\\&.Op \\&Fl"
19199 #: build/C/man7/mdoc.samples.7:1892
19204 #. type: Plain text
19205 #: build/C/man7/mdoc.samples.7:1903
19207 "E<.Sy Note>: The macros E<.Ql \\&.Op>, E<.Ql \\&.Fl>, and E<.Ql \\&.Ar> "
19208 "recognize the pipe bar character E<.Ql \\*(Ba>, so a command line such as:"
19212 #: build/C/man7/mdoc.samples.7:1904
19214 msgid ".Op Fl a | Fl b"
19217 #. type: Plain text
19218 #: build/C/man7/mdoc.samples.7:1913
19220 "will not go orbital. E<.Xr Troff> normally interprets a \\*(Ba as a special "
19221 "operator. See E<.Sx PREDEFINED STRINGS> for a usable \\*(Ba character in "
19222 "other situations."
19226 #: build/C/man7/mdoc.samples.7:1914
19228 msgid "\\&.Sh DESCRIPTION"
19231 #. type: Plain text
19232 #: build/C/man7/mdoc.samples.7:1931
19234 "In most cases the first text in the E<.Sx DESCRIPTION> section is a brief "
19235 "paragraph on the command, function or file, followed by a lexical list of "
19236 "options and respective explanations. To create such a list, the E<.Ql "
19237 "\\&.Bl> begin-list, E<.Ql \\&.It> list-item and E<.Ql \\&.El> end-list "
19238 "macros are used (see E<.Sx Lists and Columns> below)."
19241 #. type: Plain text
19242 #: build/C/man7/mdoc.samples.7:1940
19244 "The following E<.Ql \\&.Sh> section headers are part of the preferred manual "
19245 "page layout and must be used appropriately to maintain consistency. They "
19246 "are listed in the order in which they would be used."
19250 #: build/C/man7/mdoc.samples.7:1941
19252 msgid "\\&.Sh ENVIRONMENT"
19255 #. type: Plain text
19256 #: build/C/man7/mdoc.samples.7:1947
19258 "The E<.Sx ENVIRONMENT> section should reveal any related environment "
19259 "variables and clues to their behavior and/or usage."
19263 #: build/C/man7/mdoc.samples.7:1947
19265 msgid "\\&.Sh EXAMPLES"
19268 #. type: Plain text
19269 #: build/C/man7/mdoc.samples.7:1954
19271 "There are several ways to create examples. See the E<.Sx EXAMPLES> section "
19272 "below for details."
19276 #: build/C/man7/mdoc.samples.7:1954
19278 msgid "\\&.Sh FILES"
19281 #. type: Plain text
19282 #: build/C/man7/mdoc.samples.7:1961
19284 "Files which are used or created by the man page subject should be listed via "
19285 "the E<.Ql \\&.Pa> macro in the E<.Sx FILES> section."
19289 #: build/C/man7/mdoc.samples.7:1961
19291 msgid "\\&.Sh SEE ALSO"
19294 #. type: Plain text
19295 #: build/C/man7/mdoc.samples.7:1975
19297 "References to other material on the man page topic and cross references to "
19298 "other relevant man pages should be placed in the E<.Sx SEE ALSO> section. "
19299 "Cross references are specified using the E<.Ql \\&.Xr> macro. Cross "
19300 "references in the E<.Sx SEE ALSO> section should be sorted by section "
19301 "number, and then placed in alphabetical order and comma separated. For "
19305 #. type: Plain text
19306 #: build/C/man7/mdoc.samples.7:1980
19307 msgid "E<.Xr ls 1>, E<.Xr ps 1>, E<.Xr group 5>, E<.Xr passwd 5>."
19310 #. type: Plain text
19311 #: build/C/man7/mdoc.samples.7:1984
19312 msgid "At this time E<.Xr refer 1> style references are not accommodated."
19316 #: build/C/man7/mdoc.samples.7:1984
19318 msgid "\\&.Sh CONFORMING TO"
19321 #. type: Plain text
19322 #: build/C/man7/mdoc.samples.7:1996
19324 "If the command, library function or file adheres to a specific "
19325 "implementation such as E<.St -p1003.2> or E<.St -ansiC> this should be noted "
19326 "here. If the command does not adhere to any standard, its history should be "
19327 "noted in the E<.Sx HISTORY> section."
19331 #: build/C/man7/mdoc.samples.7:1996
19333 msgid "\\&.Sh HISTORY"
19336 #. type: Plain text
19337 #: build/C/man7/mdoc.samples.7:1999
19339 "Any command which does not adhere to any specific standards should be "
19340 "outlined historically in this section."
19344 #: build/C/man7/mdoc.samples.7:1999
19346 msgid "\\&.Sh AUTHORS"
19349 #. type: Plain text
19350 #: build/C/man7/mdoc.samples.7:2001
19351 msgid "Credits, if need be, should be placed here."
19355 #: build/C/man7/mdoc.samples.7:2001
19357 msgid "\\&.Sh DIAGNOSTICS"
19360 #. type: Plain text
19361 #: build/C/man7/mdoc.samples.7:2003
19362 msgid "Diagnostics from a command should be placed in this section."
19366 #: build/C/man7/mdoc.samples.7:2003
19368 msgid "\\&.Sh ERRORS"
19371 #. type: Plain text
19372 #: build/C/man7/mdoc.samples.7:2009
19374 "Specific error handling, especially from library functions (man page "
19375 "sections 2 and 3) should go here. The E<.Ql \\&.Er> macro is used to "
19376 "specify an errno."
19380 #: build/C/man7/mdoc.samples.7:2009
19382 msgid "\\&.Sh BUGS"
19385 #. type: Plain text
19386 #: build/C/man7/mdoc.samples.7:2011
19387 msgid "Blatant problems with the topic go here..."
19390 #. type: Plain text
19391 #: build/C/man7/mdoc.samples.7:2017
19393 "User specified E<.Ql \\&.Sh> sections may be added, for example, this "
19394 "section was set with:"
19397 #. type: Plain text
19398 #: build/C/man7/mdoc.samples.7:2019
19400 msgid "\\&.Sh PAGE STRUCTURE DOMAIN\n"
19404 #: build/C/man7/mdoc.samples.7:2020
19406 msgid "Paragraphs and Line Spacing."
19410 #: build/C/man7/mdoc.samples.7:2022
19415 #. type: Plain text
19416 #: build/C/man7/mdoc.samples.7:2038
19418 "The E<.Ql \\&.Pp> paragraph command may be used to specify a line space "
19419 "where necessary. The macro is not necessary after a E<.Ql \\&.Sh> or E<.Ql "
19420 "\\&.Ss> macro or before a E<.Ql \\&.Bl> macro. (The E<.Ql \\&.Bl> macro "
19421 "asserts a vertical distance unless the -compact flag is given)."
19424 #. This worked with version one, need to redo for version three
19427 #. .Cw (ax+bx+c) \ is\ produced\ by\ \&
19428 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
19445 #. .Em is produced by
19461 #. This example shows the same equation in a different format.
19465 #. signs were forced with
19469 #. .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
19470 #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
19481 #. .Li \&.Cx \e\ +\e\ \e&
19492 #. .Em is produced by
19500 #. .Li \&.Cx \e\ +\e\ \e&
19511 #. The incantation below was
19517 #. .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
19519 #. .Li \&.Cx Op Sy ?/
19529 #. .Em is produced by
19531 #. .Li \&.Ar \e\ b1 e1 f1
19543 #: build/C/man7/mdoc.samples.7:2157
19548 #. type: Plain text
19549 #: build/C/man7/mdoc.samples.7:2186
19551 "The only keep that is implemented at this time is for words. The macros are "
19552 "E<.Ql \\&.Bk> (begin-keep) and E<.Ql \\&.Ek> (end-keep). The only option "
19553 "that E<.Ql \\&.Bk> accepts is E<.Fl words> and is useful for preventing line "
19554 "breaks in the middle of options. In the example for the make command-line "
19555 "arguments (see E<.Sx What's in a name>), the keep prevented E<.Xr nroff> "
19556 "from placing up the flag and the argument on separate lines. (Actually, the "
19557 "option macro used to prevent this from occurring, but was dropped when the "
19558 "decision (religious) was made to force right justified margins in E<.Xr "
19559 "troff> as options in general look atrocious when spread across a sparse "
19560 "line. More work needs to be done with the keep macros, a E<.Fl line> option "
19561 "needs to be added.)"
19565 #: build/C/man7/mdoc.samples.7:2186
19567 msgid "Examples and Displays"
19570 #. type: Plain text
19571 #: build/C/man7/mdoc.samples.7:2198
19573 "There are five types of displays, a quickie one line indented display E<.Ql "
19574 "\\&.D1>, a quickie one line literal display E<.Ql \\&.Dl>, and a block "
19575 "literal, block filled and block ragged which use the E<.Ql \\&.Bd> "
19576 "begin-display and E<.Ql \\&.Ed> end-display macros."
19579 #. type: Plain text
19580 #: build/C/man7/mdoc.samples.7:2203
19582 "(D-one) Display one line of indented text. This macro is parsed, but it is "
19587 #: build/C/man7/mdoc.samples.7:2204
19589 msgid "Fl ldghfstru"
19592 #. type: Plain text
19593 #: build/C/man7/mdoc.samples.7:2208
19594 msgid "The above was produced by: E<.Li \\&.Dl Fl ldghfstru>."
19597 #. type: Plain text
19598 #: build/C/man7/mdoc.samples.7:2223
19600 "(D-ell) Display one line of indented E<.Em literal> text. The E<.Ql "
19601 "\\&.Dl> example macro has been used throughout this file. It allows the "
19602 "indent (display) of one line of text. Its default font is set to constant "
19603 "width (literal) however it is parsed and will recognized other macros. It "
19604 "is not callable however."
19608 #: build/C/man7/mdoc.samples.7:2224
19610 msgid "% ls -ldg /usr/local/bin"
19613 #. type: Plain text
19614 #: build/C/man7/mdoc.samples.7:2228
19615 msgid "The above was produced by E<.Li \\&.Dl % ls -ldg /usr/local/bin>."
19618 #. type: Plain text
19619 #: build/C/man7/mdoc.samples.7:2239
19621 "Begin-display. The E<.Ql \\&.Bd> display must be ended with the E<.Ql "
19622 "\\&.Ed> macro. Displays may be nested within displays and lists. E<.Ql "
19623 "\\&.Bd> has the following syntax:"
19627 #: build/C/man7/mdoc.samples.7:2240
19629 msgid ".Bd display-type [-offset offset_value] [-compact]"
19632 #. type: Plain text
19633 #: build/C/man7/mdoc.samples.7:2245
19635 "The display-type must be one of the following four types and may have an "
19636 "offset specifier for indentation: E<.Ql \\&.Bd>."
19639 #. type: Plain text
19640 #: build/C/man7/mdoc.samples.7:2251
19642 "Display a block of text as typed, right (and left) margin edges are left "
19646 #. type: Plain text
19647 #: build/C/man7/mdoc.samples.7:2255
19649 "Display a filled (formatted) block. The block of text is formatted (the "
19650 "edges are filled \\- not left unjustified)."
19653 #. type: Plain text
19654 #: build/C/man7/mdoc.samples.7:2258
19656 "Display a literal block, useful for source code or simple tabbed or spaced "
19661 #: build/C/man7/mdoc.samples.7:2258
19663 msgid "Fl file Ar file_name"
19666 #. type: Plain text
19667 #: build/C/man7/mdoc.samples.7:2267
19669 "The filename following the E<.Fl file> flag is read and displayed. Literal "
19670 "mode is asserted and tabs are set at 8 constant width character intervals, "
19671 "however any E<.Xr troff/ Ns Nm \\-mdoc> commands in file will be processed."
19674 #. type: Plain text
19675 #: build/C/man7/mdoc.samples.7:2273
19677 "If E<.Fl offset> is specified with one of the following strings, the string "
19678 "is interpreted to indicate the level of indentation for the forthcoming "
19682 #. type: Plain text
19683 #: build/C/man7/mdoc.samples.7:2279
19685 "Align block on the current left margin, this is the default mode of E<.Ql "
19689 #. type: Plain text
19690 #: build/C/man7/mdoc.samples.7:2284
19692 "Supposedly center the block. At this time unfortunately, the block merely "
19693 "gets left aligned about an imaginary center margin."
19696 #. type: Plain text
19697 #: build/C/man7/mdoc.samples.7:2293
19699 "Indents by one default indent value or tab. The default indent value is "
19700 "also used for the E<.Ql \\&.D1> display so one is guaranteed the two types "
19701 "of displays will line up. This indent is normally set to 6n or about two "
19702 "thirds of an inch (six constant width characters)."
19705 #. type: Plain text
19706 #: build/C/man7/mdoc.samples.7:2295
19707 msgid "Indents two times the default indent value."
19710 #. type: Plain text
19711 #: build/C/man7/mdoc.samples.7:2303
19713 "This E<.Em left> aligns the block about two inches from the right side of "
19714 "the page. This macro needs work and perhaps may never do the right thing by "
19719 #: build/C/man7/mdoc.samples.7:2304
19724 #. type: Plain text
19725 #: build/C/man7/mdoc.samples.7:2306
19726 msgid "End-display."
19730 #: build/C/man7/mdoc.samples.7:2307
19735 #. type: Plain text
19736 #: build/C/man7/mdoc.samples.7:2309
19737 msgid "There are five macros for changing the appearance of the manual page text:"
19741 #: build/C/man7/mdoc.samples.7:2310
19746 #. type: Plain text
19747 #: build/C/man7/mdoc.samples.7:2315
19749 "Text may be stressed or emphasized with the E<.Ql \\&.Em> macro. The usual "
19750 "font for emphasis is italic."
19754 #: build/C/man7/mdoc.samples.7:2316
19756 msgid "Usage: .Em argument ... \\*(Pu"
19760 #: build/C/man7/mdoc.samples.7:2318
19762 msgid "Li \".Em does not\""
19765 #. type: Plain text
19766 #: build/C/man7/mdoc.samples.7:2320
19767 msgid "E<.Em does not>"
19771 #: build/C/man7/mdoc.samples.7:2320
19773 msgid "Li \".Em exceed 1024 .\""
19776 #. type: Plain text
19777 #: build/C/man7/mdoc.samples.7:2322
19778 msgid "E<.Em exceed 1024>."
19782 #: build/C/man7/mdoc.samples.7:2322
19784 msgid "Li \".Em vide infra ) ) ,\""
19787 #. type: Plain text
19788 #: build/C/man7/mdoc.samples.7:2324
19789 msgid "E<.Em vide infra>)),"
19792 #. type: Plain text
19793 #: build/C/man7/mdoc.samples.7:2332
19795 "The E<.Ql \\&.Em> macro is parsed and is callable. It is an error to call "
19796 "E<.Ql \\&.Em> without arguments."
19800 #: build/C/man7/mdoc.samples.7:2332
19805 #. type: Plain text
19806 #: build/C/man7/mdoc.samples.7:2338
19808 "The E<.Ql \\&.Li> literal macro may be used for special characters, variable "
19809 "constants, anything which should be displayed as it would be typed."
19813 #: build/C/man7/mdoc.samples.7:2339
19815 msgid "Usage: .Li argument ... \\*(Pu"
19819 #: build/C/man7/mdoc.samples.7:2341
19821 msgid "Li \\&.Li \\een"
19824 #. type: Plain text
19825 #: build/C/man7/mdoc.samples.7:2343
19826 msgid "E<.Li \\en>"
19830 #: build/C/man7/mdoc.samples.7:2343
19832 msgid "Li \\&.Li M1 M2 M3\\ ;"
19835 #. type: Plain text
19836 #: build/C/man7/mdoc.samples.7:2345
19837 msgid "E<.Li M1 M2 M3>;"
19841 #: build/C/man7/mdoc.samples.7:2345
19843 msgid "Li \\&.Li cntrl-D\\ )\\ ,"
19846 #. type: Plain text
19847 #: build/C/man7/mdoc.samples.7:2347
19848 msgid "E<.Li cntrl-D>),"
19852 #: build/C/man7/mdoc.samples.7:2347
19854 msgid "Li \\&.Li 1024\\ ..."
19857 #. type: Plain text
19858 #: build/C/man7/mdoc.samples.7:2349
19859 msgid "E<.Li 1024 ...>"
19862 #. type: Plain text
19863 #: build/C/man7/mdoc.samples.7:2354
19864 msgid "The E<.Ql \\&.Li> macro is parsed and is callable."
19868 #: build/C/man7/mdoc.samples.7:2354
19873 #. type: Plain text
19874 #: build/C/man7/mdoc.samples.7:2357
19876 "The symbolic emphasis macro is generally a boldface macro in either the "
19877 "symbolic sense or the traditional English usage."
19881 #: build/C/man7/mdoc.samples.7:2358
19883 msgid "Usage: .Sy symbol ... \\*(Pu"
19887 #: build/C/man7/mdoc.samples.7:2360
19889 msgid "Li \\&.Sy Important Notice"
19892 #. type: Plain text
19893 #: build/C/man7/mdoc.samples.7:2362
19894 msgid "E<.Sy Important Notice>"
19897 #. type: Plain text
19898 #: build/C/man7/mdoc.samples.7:2369
19900 "The E<.Ql \\&.Sy> macro is parsed and is callable. Arguments to E<.Ql "
19901 "\\&.Sy> may be quoted."
19905 #: build/C/man7/mdoc.samples.7:2370
19910 #. type: Plain text
19911 #: build/C/man7/mdoc.samples.7:2380
19913 "Begin font mode. The E<.Ql \\&.Bf> font mode must be ended with the E<.Ql "
19914 "\\&.Ef> macro. Font modes may be nested within other font modes. E<.Ql "
19915 "\\&.Bf> has the following syntax:"
19919 #: build/C/man7/mdoc.samples.7:2381
19921 msgid ".Bf font-mode"
19924 #. type: Plain text
19925 #: build/C/man7/mdoc.samples.7:2385
19926 msgid "The font-mode must be one of the following three types: E<.Ql \\&.Bf>."
19930 #: build/C/man7/mdoc.samples.7:2387
19932 msgid "Sy \\&Em | Fl emphasis"
19935 #. type: Plain text
19936 #: build/C/man7/mdoc.samples.7:2391
19937 msgid "Same as if the E<.Ql \\&.Em> macro was used for the entire block of text."
19941 #: build/C/man7/mdoc.samples.7:2391
19943 msgid "Sy \\&Li | Fl literal"
19946 #. type: Plain text
19947 #: build/C/man7/mdoc.samples.7:2395
19948 msgid "Same as if the E<.Ql \\&.Li> macro was used for the entire block of text."
19952 #: build/C/man7/mdoc.samples.7:2395
19954 msgid "Sy \\&Sy | Fl symbolic"
19957 #. type: Plain text
19958 #: build/C/man7/mdoc.samples.7:2399
19959 msgid "Same as if the E<.Ql \\&.Sy> macro was used for the entire block of text."
19963 #: build/C/man7/mdoc.samples.7:2400
19968 #. type: Plain text
19969 #: build/C/man7/mdoc.samples.7:2402
19970 msgid "End font mode."
19974 #: build/C/man7/mdoc.samples.7:2403
19976 msgid "Tagged Lists and Columns"
19979 #. type: Plain text
19980 #: build/C/man7/mdoc.samples.7:2417
19982 "There are several types of lists which may be initiated with the E<.Ql "
19983 "\".Bl\"> begin-list macro. Items within the list are specified with the "
19984 "E<.Ql \".It\"> item macro and each list must end with the E<.Ql \".El\"> "
19985 "macro. Lists may be nested within themselves and within displays. Columns "
19986 "may be used inside of lists, but lists are unproven inside of columns."
19989 #. type: Plain text
19990 #: build/C/man7/mdoc.samples.7:2432
19992 "In addition, several list attributes may be specified such as the width of a "
19993 "tag, the list offset, and compactness (blank lines between items allowed or "
19994 "disallowed). Most of this document has been formatted with a tag style list "
19995 "E<.Pq Fl tag>. For a change of pace, the list-type used to present the "
19996 "list-types is an over-hanging list E<.Pq Fl ohang>. This type of list is "
19997 "quite popular with E<.Tn TeX> users, but might look a bit funny after having "
19998 "read many pages of tagged lists. The following list types are accepted by "
20003 #: build/C/man7/mdoc.samples.7:2434
20009 #: build/C/man7/mdoc.samples.7:2435
20015 #: build/C/man7/mdoc.samples.7:2436
20020 #. type: Plain text
20021 #: build/C/man7/mdoc.samples.7:2446
20023 "These three are the simplest types of lists. Once the E<.Ql \".Bl\"> macro "
20024 "has been given, items in the list are merely indicated by a line consisting "
20025 "solely of the E<.Ql \".It\"> macro. For example, the source text for a "
20026 "simple enumerated list would look like:"
20029 #. type: Plain text
20030 #: build/C/man7/mdoc.samples.7:2455
20033 "\\&.Bl -enum -compact\n"
20035 "\\&Item one goes here.\n"
20037 "\\&And item two here.\n"
20039 "\\&Lastly item three goes here.\n"
20043 #. type: Plain text
20044 #: build/C/man7/mdoc.samples.7:2459
20045 msgid "The results:"
20048 #. type: Plain text
20049 #: build/C/man7/mdoc.samples.7:2463
20050 msgid "Item one goes here."
20053 #. type: Plain text
20054 #: build/C/man7/mdoc.samples.7:2465
20055 msgid "And item two here."
20058 #. type: Plain text
20059 #: build/C/man7/mdoc.samples.7:2467
20060 msgid "Lastly item three goes here."
20063 #. type: Plain text
20064 #: build/C/man7/mdoc.samples.7:2470
20065 msgid "A simple bullet list construction:"
20068 #. type: Plain text
20069 #: build/C/man7/mdoc.samples.7:2477
20072 "\\&.Bl -bullet -compact\n"
20074 "\\&Bullet one goes here.\n"
20076 "\\&Bullet two here.\n"
20080 #. type: Plain text
20081 #: build/C/man7/mdoc.samples.7:2483
20082 msgid "Bullet one goes here."
20085 #. type: Plain text
20086 #: build/C/man7/mdoc.samples.7:2485
20087 msgid "Bullet two here."
20091 #: build/C/man7/mdoc.samples.7:2488
20097 #: build/C/man7/mdoc.samples.7:2489
20103 #: build/C/man7/mdoc.samples.7:2490
20109 #: build/C/man7/mdoc.samples.7:2491
20115 #: build/C/man7/mdoc.samples.7:2492
20120 #. type: Plain text
20121 #: build/C/man7/mdoc.samples.7:2512
20123 "These list-types collect arguments specified with the E<.Ql \\&.It> macro "
20124 "and create a label which may be E<.Em inset> into the forthcoming text, "
20125 "E<.Em hanged> from the forthcoming text, E<.Em overhanged> from above and "
20126 "not indented or E<.Em tagged>. This list was constructed with the E<.Ql "
20127 "\\&Fl ohang> list-type. The E<.Ql \\&.It> macro is parsed only for the "
20128 "inset, hang and tag list-types and is not callable. Here is an example of "
20133 #: build/C/man7/mdoc.samples.7:2514
20138 #. type: Plain text
20139 #: build/C/man7/mdoc.samples.7:2517
20141 "The tagged list (also called a tagged paragraph) is the most common type of "
20142 "list used in the Berkeley manuals."
20146 #: build/C/man7/mdoc.samples.7:2517
20151 #. type: Plain text
20152 #: build/C/man7/mdoc.samples.7:2521
20154 "Diag lists create section four diagnostic lists and are similar to inset "
20155 "lists except callable macros are ignored."
20159 #: build/C/man7/mdoc.samples.7:2521
20164 #. type: Plain text
20165 #: build/C/man7/mdoc.samples.7:2523
20166 msgid "Hanged labels are a matter of taste."
20170 #: build/C/man7/mdoc.samples.7:2523
20175 #. type: Plain text
20176 #: build/C/man7/mdoc.samples.7:2525
20177 msgid "Overhanging labels are nice when space is constrained."
20181 #: build/C/man7/mdoc.samples.7:2525
20186 #. type: Plain text
20187 #: build/C/man7/mdoc.samples.7:2530
20189 "Inset labels are useful for controlling blocks of paragraphs and are "
20190 "valuable for converting E<.Nm \\-mdoc> manuals to other formats."
20193 #. type: Plain text
20194 #: build/C/man7/mdoc.samples.7:2533
20195 msgid "Here is the source text which produced the above example:"
20198 #. type: Plain text
20199 #: build/C/man7/mdoc.samples.7:2552
20202 "\\&.Bl -inset -offset indent\n"
20204 "\\&The tagged list (also called a tagged paragraph) is the\n"
20205 "\\&most common type of list used in the Berkeley manuals.\n"
20207 "\\&Diag lists create section four diagnostic lists\n"
20208 "\\&and are similar to inset lists except callable\n"
20209 "\\¯os are ignored.\n"
20211 "\\&Hanged labels are a matter of taste.\n"
20212 "\\&.It Em Ohang\n"
20213 "\\&Overhanging labels are nice when space is constrained.\n"
20214 "\\&.It Em Inset\n"
20215 "\\&Inset labels are useful for controlling blocks of\n"
20216 "\\¶graphs and are valuable for converting\n"
20218 "\\&manuals to other formats.\n"
20222 #. type: Plain text
20223 #: build/C/man7/mdoc.samples.7:2555
20224 msgid "Here is a hanged list with two items:"
20228 #: build/C/man7/mdoc.samples.7:2556
20233 #. type: Plain text
20234 #: build/C/man7/mdoc.samples.7:2559
20236 "labels appear similar to tagged lists when the label is smaller than the "
20241 #: build/C/man7/mdoc.samples.7:2559
20243 msgid "Em Longer hanged list labels"
20246 #. type: Plain text
20247 #: build/C/man7/mdoc.samples.7:2562
20248 msgid "blend in to the paragraph unlike tagged paragraph labels."
20251 #. type: Plain text
20252 #: build/C/man7/mdoc.samples.7:2565
20253 msgid "And the unformatted text which created it:"
20256 #. type: Plain text
20257 #: build/C/man7/mdoc.samples.7:2574
20260 "\\&.Bl -hang -offset indent\n"
20261 "\\&.It Em Hanged\n"
20262 "\\&labels appear similar to tagged lists when the\n"
20263 "\\&label is smaller than the label width.\n"
20264 "\\&.It Em Longer hanged list labels\n"
20265 "\\&blend in to the paragraph unlike\n"
20266 "\\&tagged paragraph labels.\n"
20270 #. type: Plain text
20271 #: build/C/man7/mdoc.samples.7:2578
20273 "The tagged list which follows uses an optional width specifier to control "
20274 "the width of the tag."
20278 #: build/C/man7/mdoc.samples.7:2580
20283 #. type: Plain text
20284 #: build/C/man7/mdoc.samples.7:2582
20285 msgid "sleep time of the process (seconds blocked)"
20289 #: build/C/man7/mdoc.samples.7:2582
20294 #. type: Plain text
20295 #: build/C/man7/mdoc.samples.7:2587
20297 "number of disk E<.Tn I/O Ns 's> resulting from references by the process to "
20298 "pages not loaded in core."
20302 #: build/C/man7/mdoc.samples.7:2587
20307 #. type: Plain text
20308 #: build/C/man7/mdoc.samples.7:2589
20309 msgid "numerical user-id of process owner"
20313 #: build/C/man7/mdoc.samples.7:2589
20318 #. type: Plain text
20319 #: build/C/man7/mdoc.samples.7:2592
20321 "numerical ID of parent of process process priority (nonpositive when in "
20322 "noninterruptible wait)"
20325 #. type: Plain text
20326 #: build/C/man7/mdoc.samples.7:2595
20327 msgid "The raw text:"
20330 #. type: Plain text
20331 #: build/C/man7/mdoc.samples.7:2610
20334 "\\&.Bl -tag -width \"PAGEIN\" -compact -offset indent\n"
20336 "\\&sleep time of the process (seconds blocked)\n"
20338 "\\&number of disk\n"
20339 "\\&.Tn I/O Ns 's\n"
20340 "\\&resulting from references\n"
20341 "\\&by the process to pages not loaded in core.\n"
20343 "\\&numerical user ID of process owner\n"
20345 "\\&numerical ID of parent of process process priority\n"
20346 "\\&(nonpositive when in noninterruptible wait)\n"
20350 #. type: Plain text
20351 #: build/C/man7/mdoc.samples.7:2613
20352 msgid "Acceptable width specifiers:"
20356 #: build/C/man7/mdoc.samples.7:2614
20358 msgid "Fl width Ar \\&Fl"
20361 #. type: Plain text
20362 #: build/C/man7/mdoc.samples.7:2623
20364 "sets the width to the default width for a flag. All callable macros have a "
20365 "default width value. The E<.Ql \\&.Fl>, value is presently set to ten "
20366 "constant width characters or about five sixth of an inch."
20370 #: build/C/man7/mdoc.samples.7:2623
20372 msgid "Fl width Ar 24n"
20375 #. type: Plain text
20376 #: build/C/man7/mdoc.samples.7:2629
20378 "sets the width to 24 constant width characters or about two inches. The "
20379 "E<.Ql n> is absolutely necessary for the scaling to work correctly."
20383 #: build/C/man7/mdoc.samples.7:2629
20385 msgid "Fl width Ar ENAMETOOLONG"
20388 #. type: Plain text
20389 #: build/C/man7/mdoc.samples.7:2632
20390 msgid "sets width to the constant width length of the string given."
20394 #: build/C/man7/mdoc.samples.7:2632
20396 msgid "Fl width Ar \"\\*qint mkfifo\\*q\""
20399 #. type: Plain text
20400 #: build/C/man7/mdoc.samples.7:2635
20401 msgid "again, the width is set to the constant width of the string given."
20404 #. type: Plain text
20405 #: build/C/man7/mdoc.samples.7:2649
20407 "If a width is not specified for the tag list type, the first time E<.Ql "
20408 "\\&.It> is invoked, an attempt is made to determine an appropriate width. "
20409 "If the first argument to E<.Ql \".It\"> is a callable macro, the default "
20410 "width for that macro will be used as if the macro name had been supplied as "
20411 "the width. However, if another item in the list is given with a different "
20412 "callable macro name, a new and nested list is assumed."
20416 #: build/C/man7/mdoc.samples.7:2649
20418 msgid "PREDEFINED STRINGS"
20421 #. type: Plain text
20422 #: build/C/man7/mdoc.samples.7:2661
20424 "The following strings are predefined as may be used by preceding with the "
20425 "troff string interpreting sequence E<.Ql \\&\\e*(xx> where E<.Em xx> is the "
20426 "name of the defined string or as E<.Ql \\&\\e*x> where E<.Em x> is the name "
20427 "of the string. The interpreting sequence may be used any where in the text."
20431 #: build/C/man7/mdoc.samples.7:2663
20433 msgid "Sy \"String\tNroff\tTroff\""
20437 #: build/C/man7/mdoc.samples.7:2664
20439 msgid "Li E<lt>= Ta \\&E<lt>\\&= Ta \\*(E<lt>="
20443 #: build/C/man7/mdoc.samples.7:2665
20445 msgid "Li E<gt>= Ta \\&E<gt>\\&= Ta \\*(E<gt>="
20449 #: build/C/man7/mdoc.samples.7:2666
20451 msgid "Li Rq Ta '' Ta \\*(Rq"
20455 #: build/C/man7/mdoc.samples.7:2667
20457 msgid "Li Lq Ta `` Ta \\*(Lq"
20461 #: build/C/man7/mdoc.samples.7:2668
20463 msgid "Li ua Ta ^ Ta \\*(ua"
20467 #: build/C/man7/mdoc.samples.7:2669
20469 msgid "Li aa Ta ' Ta \\*(aa"
20473 #: build/C/man7/mdoc.samples.7:2670
20475 msgid "Li ga Ta \\` Ta \\*(ga"
20478 #. .It Li "sL" Ta ` Ta \*(sL
20479 #. .It Li "sR" Ta ' Ta \*(sR
20481 #: build/C/man7/mdoc.samples.7:2673
20483 msgid "Li q Ta \\(dq Ta \\*q"
20487 #: build/C/man7/mdoc.samples.7:2674
20489 msgid "Li Pi Ta pi Ta \\*(Pi"
20493 #: build/C/man7/mdoc.samples.7:2675
20495 msgid "Li Ne Ta != Ta \\*(Ne"
20499 #: build/C/man7/mdoc.samples.7:2676
20501 msgid "Li Le Ta E<lt>= Ta \\*(Le"
20505 #: build/C/man7/mdoc.samples.7:2677
20507 msgid "Li Ge Ta E<gt>= Ta \\*(Ge"
20511 #: build/C/man7/mdoc.samples.7:2678
20513 msgid "Li Lt Ta E<lt> Ta \\*(Gt"
20517 #: build/C/man7/mdoc.samples.7:2679
20519 msgid "Li Gt Ta E<gt> Ta \\*(Lt"
20523 #: build/C/man7/mdoc.samples.7:2680
20525 msgid "Li Pm Ta +- Ta \\*(Pm"
20529 #: build/C/man7/mdoc.samples.7:2681
20531 msgid "Li If Ta infinity Ta \\*(If"
20535 #: build/C/man7/mdoc.samples.7:2682
20537 msgid "Li Na Ta I<NaN> Ta \\*(Na"
20541 #: build/C/man7/mdoc.samples.7:2683
20543 msgid "Li Ba Ta \\&| Ta \\*(Ba"
20546 #. type: Plain text
20547 #: build/C/man7/mdoc.samples.7:2692
20549 "E<.Sy Note>: The string named E<.Ql q> should be written as E<.Ql \\e*q> "
20550 "since it is only one char."
20554 #: build/C/man7/mdoc.samples.7:2692
20556 msgid "DIAGNOSTICS"
20559 #. type: Plain text
20560 #: build/C/man7/mdoc.samples.7:2725
20562 "The debugging facilities for E<.Nm \\-mdoc> are limited, but can help detect "
20563 "subtle errors such as the collision of an argument name with an internal "
20564 "register or macro name. (A what?) A register is an arithmetic storage "
20565 "class for E<.Xr troff> with a one or two character name. All registers "
20566 "internal to E<.Nm \\-mdoc> for E<.Xr troff> and E<.Xr ditroff> are two "
20567 "characters and of the form E<lt>upper_caseE<gt>E<lt>lower_caseE<gt> such as "
20568 "E<.Ql \\&Ar>, E<lt>lower_caseE<gt>E<lt>upper_caseE<gt> as E<.Ql \\&aR> or "
20569 "E<lt>upper or lower letterE<gt>E<lt>digitE<gt> as E<.Ql \\&C\\&1>. And "
20570 "adding to the muddle, E<.Xr troff> has its own internal registers all of "
20571 "which are either two lowercase characters or a dot plus a letter or "
20572 "metacharacter character. In one of the introduction examples, it was shown "
20573 "how to prevent the interpretation of a macro name with the escape sequence "
20574 "E<.Ql \\e&>. This is sufficient for the internal register names also."
20577 #. Every callable macro name has a corresponding register
20578 #. of the same name (<upper_case><lower_case>).
20579 #. There are also specific registers which have
20580 #. been used for stacks and arrays and are listed in the
20582 #. .Bd -ragged -offset 4n
20583 #. [A-Z][a-z] registers corresponding to macro names (example ``Ar'')
20584 #. [a-z][A-Z] registers corresponding to macro names (example ``aR'')
20585 #. C[0-9] argument types (example C1)
20586 #. O[0-9] offset stack (displays)
20587 #. h[0-9] horizontal spacing stack (lists)
20588 #. o[0-9] offset (stack) (lists)
20589 #. t[0-9] tag stack (lists)
20590 #. v[0-9] vertical spacing stack (lists)
20591 #. w[0-9] width tag/label stack
20594 #. type: Plain text
20595 #: build/C/man7/mdoc.samples.7:2764
20597 "If a nonescaped register name is given in the argument list of a request, "
20598 "unpredictable behavior will occur. In general, any time huge portions of "
20599 "text do not appear where expected in the output, or small strings such as "
20600 "list tags disappear, chances are there is a misunderstanding about an "
20601 "argument type in the argument list. Your mother never intended for you to "
20602 "remember this evil stuff - so here is a way to find out whether or not your "
20603 "arguments are valid: The E<.Ql \\&.Db> (debug) macro displays the "
20604 "interpretation of the argument list for most macros. Macros such as the "
20605 "E<.Ql \\&.Pp> (paragraph) macro do not contain debugging information. All "
20606 "of the callable macros do, and it is strongly advised whenever in doubt, "
20607 "turn on the E<.Ql \\&.Db> macro."
20611 #: build/C/man7/mdoc.samples.7:2765
20613 msgid "Usage: \\&.Db [on | off]"
20616 #. type: Plain text
20617 #: build/C/man7/mdoc.samples.7:2774
20619 "An example of a portion of text with the debug macro placed above and below "
20620 "an artificially created problem (a flag argument E<.Ql \\&aC> which should "
20621 "be E<.Ql \\e&aC> in order to work):"
20624 #. type: Plain text
20625 #: build/C/man7/mdoc.samples.7:2778
20629 "\\&.Op Fl aC Ar file )\n"
20633 #. type: Plain text
20634 #: build/C/man7/mdoc.samples.7:2781
20635 msgid "The resulting output:"
20638 #. type: Plain text
20639 #: build/C/man7/mdoc.samples.7:2796
20643 "DEBUG(argv) MACRO: `.Op' Line #: 2\n"
20644 "\tArgc: 1 Argv: `Fl' Length: 2\n"
20645 "\tSpace: `' Class: Executable\n"
20646 "\tArgc: 2 Argv: `aC' Length: 2\n"
20647 "\tSpace: `' Class: Executable\n"
20648 "\tArgc: 3 Argv: `Ar' Length: 2\n"
20649 "\tSpace: `' Class: Executable\n"
20650 "\tArgc: 4 Argv: `file' Length: 4\n"
20651 "\tSpace: ` ' Class: String\n"
20652 "\tArgc: 5 Argv: `)' Length: 1\n"
20653 "\tSpace: ` ' Class: Closing Punctuation or suffix\n"
20654 "\tMACRO REQUEST: .Op Fl aC Ar file )\n"
20658 #. type: Plain text
20659 #: build/C/man7/mdoc.samples.7:2823
20661 "The first line of information tells the name of the calling macro, here "
20662 "E<.Ql \\&.Op>, and the line number it appears on. If one or more files are "
20663 "involved (especially if text from another file is included), the line number "
20664 "may be bogus. If there is only one file, it should be accurate. The second "
20665 "line gives the argument count, the argument E<.Pq Ql \\&Fl> and its length. "
20666 "If the length of an argument is two characters, the argument is tested to "
20667 "see if it is executable (unfortunately, any register which contains a "
20668 "nonzero value appears executable). The third line gives the space allotted "
20669 "for a class, and the class type. The problem here is the argument aC should "
20670 "not be executable. The four types of classes are string, executable, "
20671 "closing punctuation and opening punctuation. The last line shows the entire "
20672 "argument list as it was read. In this next example, the offending E<.Ql "
20673 "\\&aC> is escaped:"
20676 #. type: Plain text
20677 #: build/C/man7/mdoc.samples.7:2827
20681 "\\&.Em An escaped \\e&aC\n"
20685 #. type: Plain text
20686 #: build/C/man7/mdoc.samples.7:2839
20690 "DEBUG(fargv) MACRO: `.Em' Line #: 2\n"
20691 "\tArgc: 1 Argv: `An' Length: 2\n"
20692 "\tSpace: ` ' Class: String\n"
20693 "\tArgc: 2 Argv: `escaped' Length: 7\n"
20694 "\tSpace: ` ' Class: String\n"
20695 "\tArgc: 3 Argv: `aC' Length: 2\n"
20696 "\tSpace: ` ' Class: String\n"
20697 "\tMACRO REQUEST: .Em An escaped &aC\n"
20701 #. type: Plain text
20702 #: build/C/man7/mdoc.samples.7:2849
20704 "The argument E<.Ql \\e&aC> shows up with the same length of 2 as the E<.Ql "
20705 "\\e&> sequence produces a zero width, but a register named E<.Ql \\e&aC> was "
20706 "not found and the type classified as string."
20709 #. type: Plain text
20710 #: build/C/man7/mdoc.samples.7:2851
20711 msgid "Other diagnostics consist of usage statements and are self explanatory."
20715 #: build/C/man7/mdoc.samples.7:2851
20717 msgid "GROFF, TROFF AND NROFF"
20720 #. type: Plain text
20721 #: build/C/man7/mdoc.samples.7:2856
20723 "The E<.Nm \\-mdoc> package does not need compatibility mode with E<.Xr "
20727 #. type: Plain text
20728 #: build/C/man7/mdoc.samples.7:2874
20730 "The package inhibits page breaks, and the headers and footers which normally "
20731 "occur at those breaks with E<.Xr nroff>, to make the manual more efficient "
20732 "for viewing on-line. At the moment, E<.Xr groff> with E<.Fl T Ns Ar ascii> "
20733 "does eject the imaginary remainder of the page at end of file. The "
20734 "inhibiting of the page breaks makes E<.Xr nroff Ns 'd> files unsuitable for "
20735 "hardcopy. There is a register named E<.Ql \\&cR> which can be set to zero "
20736 "in the site dependent style file E<.Pa /usr/src/share/tmac/doc-nroff> to "
20737 "restore the old style behavior."
20741 #: build/C/man7/mdoc.samples.7:2876
20743 msgid "Pa /usr/share/tmac/doc.tmac"
20746 #. type: Plain text
20747 #: build/C/man7/mdoc.samples.7:2878
20748 msgid "manual macro package"
20752 #: build/C/man7/mdoc.samples.7:2878
20754 msgid "Pa /usr/share/misc/mdoc.template"
20757 #. type: Plain text
20758 #: build/C/man7/mdoc.samples.7:2880
20759 msgid "template for writing a man page"
20763 #: build/C/man7/mdoc.samples.7:2880
20765 msgid "Pa /usr/share/examples/mdoc/*"
20768 #. type: Plain text
20769 #: build/C/man7/mdoc.samples.7:2882
20770 msgid "several example man pages"
20773 #. type: Plain text
20774 #: build/C/man7/mdoc.samples.7:2890
20776 "Undesirable hyphenation on the dash of a flag argument is not yet resolved, "
20777 "and causes occasional mishaps in the E<.Sx DESCRIPTION> section. (line "
20778 "break on the hyphen)."
20781 #. type: Plain text
20782 #: build/C/man7/mdoc.samples.7:2892
20783 msgid "Predefined strings are not declared in documentation."
20786 #. type: Plain text
20787 #: build/C/man7/mdoc.samples.7:2894
20788 msgid "Section 3f has not been added to the header routines."
20791 #. type: Plain text
20792 #: build/C/man7/mdoc.samples.7:2899
20793 msgid "E<.Ql \\&.Nm> font should be changed in E<.Sx NAME> section."
20796 #. type: Plain text
20797 #: build/C/man7/mdoc.samples.7:2906
20799 "E<.Ql \\&.Fn> needs to have a check to prevent splitting up if the line "
20800 "length is too short. Occasionally it separates the last parenthesis, and "
20801 "sometimes looks ridiculous if a line is in fill mode."
20804 #. type: Plain text
20805 #: build/C/man7/mdoc.samples.7:2911
20807 "The method used to prevent header and footer page breaks (other than the "
20808 "initial header and footer) when using nroff occasionally places an unsightly "
20809 "partially filled line (blank) at the would be bottom of the page."
20812 #. Note what happens if the parameter list overlaps a newline
20814 #. to make sure a line boundary is crossed:
20816 #. \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
20819 #. produces, nudge nudge,
20820 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
20821 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
20823 #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
20825 #. If double quotes are used, for example:
20827 #. \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
20830 #. produces, nudge nudge,
20831 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
20833 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
20835 #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
20837 #. Not a pretty sight...
20838 #. In a paragraph, a long parameter containing unpaddable spaces as
20839 #. in the former example will cause
20841 #. to break the line and spread
20842 #. the remaining words out.
20843 #. The latter example will adjust nicely to
20844 #. justified margins, but may break in between an argument and its
20848 #. the right margin adjustment is normally ragged and the problem is
20850 #. type: Plain text
20851 #: build/C/man7/mdoc.samples.7:2952
20853 "The list and display macros to not do any keeps and certainly should be able "
20857 #. type: Plain text
20858 #: build/C/man7/mdoc.samples.7:2957
20859 msgid "E<.Xr man 1>, E<.Xr troff 1>, E<.Xr groff_mdoc 7>, E<.Xr mdoc 7>"