1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2012-03-22 04:25+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man7/feature_test_macros.7:25
22 msgid "FEATURE_TEST_MACROS"
26 #: build/C/man7/feature_test_macros.7:25
32 #: build/C/man7/feature_test_macros.7:25 build/C/man1/intro.1:26 build/C/man2/intro.2:27 build/C/man3/intro.3:24 build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28 build/C/man7/libc.7:24 build/C/man7/mailaddr.7:26 build/C/man7/man-pages.7:28 build/C/man7/man.7:32 build/C/man7/mdoc.7:42 build/C/man7/operator.7:38 build/C/man5/proc.5:61 build/C/man7/standards.7:25 build/C/man7/suffixes.7:38 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:27 build/C/man7/units.7:24
38 #: build/C/man7/feature_test_macros.7:25 build/C/man2/intro.2:27 build/C/man3/intro.3:24 build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28 build/C/man7/libc.7:24 build/C/man7/man-pages.7:28 build/C/man7/man.7:32 build/C/man7/operator.7:38 build/C/man7/posixoptions.7:23 build/C/man5/proc.5:61 build/C/man7/standards.7:25 build/C/man7/suffixes.7:38 build/C/man3/undocumented.3:29 build/C/man2/unimplemented.2:27 build/C/man7/units.7:24
40 msgid "Linux Programmer's Manual"
44 #: build/C/man7/feature_test_macros.7:26 build/C/man1/intro.1:27 build/C/man2/intro.2:28 build/C/man3/intro.3:25 build/C/man4/intro.4:26 build/C/man5/intro.5:27 build/C/man6/intro.6:26 build/C/man7/intro.7:28 build/C/man8/intro.8:29 build/C/man7/libc.7:25 build/C/man7/mailaddr.7:28 build/C/man7/man-pages.7:29 build/C/man7/man.7:33 build/C/man7/mdoc.7:43 build/C/man7/operator.7:39 build/C/man7/posixoptions.7:24 build/C/man5/proc.5:62 build/C/man7/standards.7:26 build/C/man7/suffixes.7:39 build/C/man3/undocumented.3:30 build/C/man2/unimplemented.2:28 build/C/man7/units.7:25
50 #: build/C/man7/feature_test_macros.7:28
51 msgid "feature_test_macros - feature test macros"
55 #: build/C/man7/feature_test_macros.7:28 build/C/man7/man-pages.7:31 build/C/man7/man.7:35 build/C/man7/mdoc.7:48 build/C/man3/undocumented.3:32 build/C/man2/unimplemented.2:31
61 #: build/C/man7/feature_test_macros.7:31
63 msgid "B<#include E<lt>features.hE<gt>>\n"
67 #: build/C/man7/feature_test_macros.7:32 build/C/man1/intro.1:29 build/C/man2/intro.2:30 build/C/man3/intro.3:27 build/C/man4/intro.4:28 build/C/man5/intro.5:29 build/C/man6/intro.6:28 build/C/man7/intro.7:30 build/C/man8/intro.8:31 build/C/man7/libc.7:27 build/C/man7/mailaddr.7:30 build/C/man7/man-pages.7:35 build/C/man7/man.7:47 build/C/man7/mdoc.7:52 build/C/man7/operator.7:41 build/C/man7/posixoptions.7:26 build/C/man5/proc.5:64 build/C/man7/standards.7:28 build/C/man7/suffixes.7:41 build/C/man3/undocumented.3:34 build/C/man2/unimplemented.2:33 build/C/man7/units.7:27
73 #: build/C/man7/feature_test_macros.7:35
75 "Feature test macros allow the programmer to control the definitions that are "
76 "exposed by system header files when a program is compiled."
80 #: build/C/man7/feature_test_macros.7:43
82 "B<NOTE:> In order to be effective, a feature test macro I<must be defined "
83 "before including any header files>. This can be done either in the "
84 "compilation command (I<cc -DMACRO=value>) or by defining the macro within "
85 "the source code before including any headers."
89 #: build/C/man7/feature_test_macros.7:52
91 "Some feature test macros are useful for creating portable applications, by "
92 "preventing nonstandard definitions from being exposed. Other macros can be "
93 "used to expose nonstandard definitions that are not exposed by default. The "
94 "precise effects of each of the feature test macros described below can be "
95 "ascertained by inspecting the I<E<lt>features.hE<gt>> header file."
99 #: build/C/man7/feature_test_macros.7:52
101 msgid "Specification of feature test macro requirements in manual pages"
105 #: build/C/man7/feature_test_macros.7:58
107 "When a function requires that a feature test macro is defined, the manual "
108 "page SYNOPSIS typically includes a note of the following form (this example "
109 "from the B<acct>(2) manual page):"
113 #: build/C/man7/feature_test_macros.7:61
114 msgid "B<#include E<lt>unistd.hE<gt>>"
118 #: build/C/man7/feature_test_macros.7:63
119 msgid "B<int acct(const char *>I<filename>B<);>"
123 #: build/C/man7/feature_test_macros.7:68
126 "Feature Test Macro Requirements for glibc (see\n"
127 "B<feature_test_macros>(7)):\n"
131 #: build/C/man7/feature_test_macros.7:73
132 msgid "B<acct>(): _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE\\ E<lt>\\ 500)"
136 #: build/C/man7/feature_test_macros.7:81
138 "The B<||> means that in order to obtain the declaration of B<acct>(2) from "
139 "I<E<lt>unistd.hE<gt>>, I<either> of the following macro definitions must be "
140 "made before including any header files:"
144 #: build/C/man7/feature_test_macros.7:86
147 "#define _BSD_SOURCE\n"
148 "#define _XOPEN_SOURCE /* or any value E<lt> 500 */\n"
152 #: build/C/man7/feature_test_macros.7:91
154 "Alternatively, equivalent definitions can be included in the compilation "
159 #: build/C/man7/feature_test_macros.7:96
163 "cc -D_XOPEN_SOURCE # Or any value E<lt> 500\n"
167 #: build/C/man7/feature_test_macros.7:104
169 "Note that, as described below, B<some feature test macros are defined by "
170 "default>, so that it may not always be necessary to explicitly specify the "
171 "feature test macro(s) shown in the SYNOPSIS."
175 #: build/C/man7/feature_test_macros.7:108
177 "In a few cases, manual pages use a shorthand for expressing the feature test "
178 "macro requirements (this example from B<readahead>(2)):"
182 #: build/C/man7/feature_test_macros.7:113
185 "B<#define _GNU_SOURCE>\n"
186 "B<#include E<lt>fcntl.hE<gt>>\n"
190 #: build/C/man7/feature_test_macros.7:115
193 "B<ssize_t readahead(int >I<fd>B<, off64_t *>I<offset>B<, size_t "
198 #: build/C/man7/feature_test_macros.7:121
200 "This format is employed in cases where only a single feature test macro can "
201 "be used to expose the function declaration, and that macro is not defined by "
206 #: build/C/man7/feature_test_macros.7:121
208 msgid "Feature test macros understood by glibc"
211 #. The details in glibc 2.0 are simpler, but combining a
212 #. a description of them with the details in later glibc versions
213 #. would make for a complicated description.
215 #: build/C/man7/feature_test_macros.7:127
217 "The following paragraphs explain how feature test macros are handled in "
218 "Linux glibc 2.I<x>, I<x> E<gt> 0."
222 #: build/C/man7/feature_test_macros.7:129
223 msgid "Linux glibc understands the following feature test macros:"
227 #: build/C/man7/feature_test_macros.7:129
229 msgid "B<__STRICT_ANSI__>"
233 #: build/C/man7/feature_test_macros.7:139
235 "ISO Standard C. This macro is implicitly defined by B<gcc>(1) when invoked "
236 "with, for example, the I<-std=c99> or I<-ansi> flag."
240 #: build/C/man7/feature_test_macros.7:139
242 msgid "B<_POSIX_C_SOURCE>"
246 #: build/C/man7/feature_test_macros.7:142 build/C/man7/feature_test_macros.7:173
247 msgid "Defining this macro causes header files to expose definitions as follows:"
251 #: build/C/man7/feature_test_macros.7:143 build/C/man7/feature_test_macros.7:146 build/C/man7/feature_test_macros.7:149 build/C/man7/feature_test_macros.7:153 build/C/man7/feature_test_macros.7:156 build/C/man7/feature_test_macros.7:160 build/C/man7/feature_test_macros.7:174 build/C/man7/feature_test_macros.7:177 build/C/man7/feature_test_macros.7:180 build/C/man7/feature_test_macros.7:184 build/C/man7/feature_test_macros.7:407 build/C/man7/feature_test_macros.7:412 build/C/man7/feature_test_macros.7:418 build/C/man7/feature_test_macros.7:423 build/C/man7/feature_test_macros.7:429 build/C/man7/feature_test_macros.7:434
257 #: build/C/man7/feature_test_macros.7:146
258 msgid "The value 1 exposes definitions conforming to POSIX.1-1990 and ISO C (1990)."
262 #: build/C/man7/feature_test_macros.7:149
263 msgid "The value 2 or greater additionally exposes definitions for POSIX.2-1992."
266 #. 199506L functionality is only available since glibc 2.1
268 #: build/C/man7/feature_test_macros.7:153
270 "The value 199309L or greater additionally exposes definitions for POSIX.1b "
271 "(real-time extensions)."
275 #: build/C/man7/feature_test_macros.7:156
277 "The value 199506L or greater additionally exposes definitions for POSIX.1c "
282 #: build/C/man7/feature_test_macros.7:160
284 "(Since glibc 2.3.3) The value 200112L or greater exposes definitions "
285 "corresponding to the POSIX.1-2001 base specification (excluding the XSI "
290 #: build/C/man7/feature_test_macros.7:164
292 "(Since glibc 2.10) The value 200809L or greater exposes definitions "
293 "corresponding to the POSIX.1-2008 base specification (excluding the XSI "
298 #: build/C/man7/feature_test_macros.7:165
300 msgid "B<_POSIX_SOURCE>"
304 #: build/C/man7/feature_test_macros.7:170
306 "Defining this obsolete macro with any value is equivalent to defining "
307 "B<_POSIX_C_SOURCE> with the value 1."
311 #: build/C/man7/feature_test_macros.7:170
313 msgid "B<_XOPEN_SOURCE>"
317 #: build/C/man7/feature_test_macros.7:177
319 "Defining with any value exposes definitions conforming to POSIX.1, POSIX.2, "
324 #: build/C/man7/feature_test_macros.7:180
326 "The value 500 or greater additionally exposes definitions for SUSv2 (UNIX "
331 #: build/C/man7/feature_test_macros.7:184
333 "(Since glibc 2.2) The value 600 or greater additionally exposes definitions "
334 "for SUSv3 (UNIX 03; i.e., the POSIX.1-2001 base specification plus the XSI "
335 "extension) and C99 definitions."
339 #: build/C/man7/feature_test_macros.7:188
341 "(Since glibc 2.10) The value 700 or greater additionally exposes definitions "
342 "for SUSv4 (i.e., the POSIX.1-2008 base specification plus the XSI "
347 #: build/C/man7/feature_test_macros.7:189
349 msgid "B<_XOPEN_SOURCE_EXTENDED>"
353 #: build/C/man7/feature_test_macros.7:198
355 "If this macro is defined, and B<_XOPEN_SOURCE> is defined, then expose "
356 "definitions corresponding to the XPG4v2 (SUSv1) UNIX extensions (UNIX 95). "
357 "This macro is also implicitly defined if B<_XOPEN_SOURCE> is defined with a "
358 "value of 500 or more."
362 #: build/C/man7/feature_test_macros.7:198
364 msgid "B<_ISOC95_SOURCE>"
368 #: build/C/man7/feature_test_macros.7:208
370 "Exposes ISO C (1990) Amendment 1 definitions (also known as C95). This "
371 "macro is recognized since glibc 2.12. The primary change in C95 was support "
372 "for international character sets. The C95 changes were included in the "
373 "subsequent C99 standard (in other words, B<_ISOC99_SOURCE> implies "
374 "B<_ISOC95_SOURCE>)."
378 #: build/C/man7/feature_test_macros.7:208
380 msgid "B<_ISOC99_SOURCE>"
384 #: build/C/man7/feature_test_macros.7:217
386 "Exposes C99 extensions to ISO C (1990). This macro is recognized since "
387 "glibc 2.1.3; earlier glibc 2.1.x versions recognized an equivalent macro "
388 "named B<_ISOC9X_SOURCE> (because the C99 standard had not then been "
389 "finalized). Although the use of the latter macro is obsolete, glibc "
390 "continues to recognize it for backward compatibility."
394 #: build/C/man7/feature_test_macros.7:217
396 msgid "B<_ISOC11_SOURCE>"
400 #: build/C/man7/feature_test_macros.7:221
402 "Exposes declarations consistent with the ISO C11 standard. This macro is "
403 "recognized since glibc 2.16."
407 #: build/C/man7/feature_test_macros.7:221
409 msgid "B<_LARGEFILE64_SOURCE>"
413 #: build/C/man7/feature_test_macros.7:240
415 "Expose definitions for the alternative API specified by the LFS (Large File "
416 "Summit) as a \"transitional extension\" to the Single UNIX Specification. "
417 "(See http://opengroup.org/platform/lfs.html.) The alternative API consists "
418 "of a set of new objects (i.e., functions and types) whose names are suffixed "
419 "with \"64\" (e.g., I<off64_t> versus I<off_t>, B<lseek64>() versus "
420 "B<lseek>(), etc.). New programs should not employ this interface; instead "
421 "I<_FILE_OFFSET_BITS=64> should be employed."
425 #: build/C/man7/feature_test_macros.7:240
427 msgid "B<_FILE_OFFSET_BITS>"
431 #: build/C/man7/feature_test_macros.7:252
433 "Defining this macro with the value 64 automatically converts references to "
434 "32-bit functions and data types related to file I/O and file system "
435 "operations into references to their 64-bit counterparts. This is useful for "
436 "performing I/O on large files (E<gt> 2 Gigabytes) on 32-bit systems. "
437 "(Defining this macro permits correctly written programs to use large files "
438 "with only a recompilation being required.) 64-bit systems naturally permit "
439 "file sizes greater than 2 Gigabytes, and on those systems this macro has no "
444 #: build/C/man7/feature_test_macros.7:252
446 msgid "B<_BSD_SOURCE>"
450 #: build/C/man7/feature_test_macros.7:266
452 "Defining this macro with any value causes header files to expose BSD-derived "
453 "definitions. Defining this macro also causes BSD definitions to be "
454 "preferred in some situations where standards conflict, unless one or more of "
455 "B<_SVID_SOURCE>, B<_POSIX_SOURCE>, B<_POSIX_C_SOURCE>, B<_XOPEN_SOURCE>, "
456 "B<_XOPEN_SOURCE_EXTENDED>, or B<_GNU_SOURCE> is defined, in which case BSD "
457 "definitions are disfavored."
461 #: build/C/man7/feature_test_macros.7:266
463 msgid "B<_SVID_SOURCE>"
467 #: build/C/man7/feature_test_macros.7:272
469 "Defining this macro with any value causes header files to expose System "
470 "V-derived definitions. (SVID == System V Interface Definition; see "
475 #: build/C/man7/feature_test_macros.7:272
477 msgid "B<_ATFILE_SOURCE> (since glibc 2.4)"
481 #: build/C/man7/feature_test_macros.7:281
483 "Defining this macro with any value causes header files to expose "
484 "declarations of a range of functions with the suffix \"at\"; see "
485 "B<openat>(2). Since glibc 2.10, this macro is also implicitly defined if "
486 "B<_POSIX_C_SOURCE> is defined with a value greater than or equal to 200809L."
490 #: build/C/man7/feature_test_macros.7:281
492 msgid "B<_GNU_SOURCE>"
496 #: build/C/man7/feature_test_macros.7:303
498 "Defining this macro (with any value) is equivalent to defining "
499 "B<_BSD_SOURCE>, B<_SVID_SOURCE>, B<_ATFILE_SOURCE>, B<_LARGEFILE64_SOURCE>, "
500 "B<_ISOC99_SOURCE>, B<_XOPEN_SOURCE_EXTENDED>, B<_POSIX_SOURCE>, "
501 "B<_POSIX_C_SOURCE> with the value 200809L (200112L in glibc versions before "
502 "2.10; 199506L in glibc versions before 2.5; 199309L in glibc versions before "
503 "2.1) and B<_XOPEN_SOURCE> with the value 700 (600 in glibc versions before "
504 "2.10; 500 in glibc versions before 2.2). In addition, various GNU-specific "
505 "extensions are also exposed. Where standards conflict, BSD definitions are "
510 #: build/C/man7/feature_test_macros.7:303
512 msgid "B<_REENTRANT>"
516 #: build/C/man7/feature_test_macros.7:309
518 "Defining this macro exposes definitions of certain reentrant functions. For "
519 "multithreaded programs, use I<cc\\ -pthread> instead."
523 #: build/C/man7/feature_test_macros.7:309
525 msgid "B<_THREAD_SAFE>"
529 #: build/C/man7/feature_test_macros.7:314
531 "Synonym for B<_REENTRANT>, provided for compatibility with some other "
536 #: build/C/man7/feature_test_macros.7:314
538 msgid "B<_FORTIFY_SOURCE> (since glibc 2.3.4)"
541 #. For more detail, see:
542 #. http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html
543 #. [PATCH] Object size checking to prevent (some) buffer overflows
544 #. * From: Jakub Jelinek <jakub at redhat dot com>
545 #. * To: gcc-patches at gcc dot gnu dot org
546 #. * Date: Tue, 21 Sep 2004 04:16:40 -0400
548 #: build/C/man7/feature_test_macros.7:360
550 "Defining this macro causes some lightweight checks to be performed to detect "
551 "some buffer overflow errors when employing various string and memory "
552 "manipulation functions. Not all buffer overflows are detected, just some "
553 "common cases. In the current implementation checks are added for calls to "
554 "B<memcpy>(3), B<mempcpy>(3), B<memmove>(3), B<memset>(3), B<stpcpy>(3), "
555 "B<strcpy>(3), B<strncpy>(3), B<strcat>(3), B<strncat>(3), B<sprintf>(3), "
556 "B<snprintf>(3), B<vsprintf>(3), B<vsnprintf>(3), and B<gets>(3). If "
557 "B<_FORTIFY_SOURCE> is set to 1, with compiler optimization level 1 (I<gcc\\ "
558 "-O1>) and above, checks that shouldn't change the behavior of conforming "
559 "programs are performed. With B<_FORTIFY_SOURCE> set to 2 some more checking "
560 "is added, but some conforming programs might fail. Some of the checks can "
561 "be performed at compile time, and result in compiler warnings; other checks "
562 "take place at run time, and result in a run-time error if the check fails. "
563 "Use of this macro requires compiler support, available with B<gcc>(1) since "
568 #: build/C/man7/feature_test_macros.7:360
570 msgid "Default definitions, implicit definitions, and combining definitions"
574 #: build/C/man7/feature_test_macros.7:372
576 "If no feature test macros are explicitly defined, then the following feature "
577 "test macros are defined by default: B<_BSD_SOURCE>, B<_SVID_SOURCE>, "
578 "B<_POSIX_SOURCE>, and B<_POSIX_C_SOURCE>=200809L (200112L in glibc versions "
579 "before 2.10; 199506L in glibc versions before 2.4; 199309L in glibc versions "
584 #: build/C/man7/feature_test_macros.7:388
586 "If any of B<__STRICT_ANSI__>, B<_ISOC99_SOURCE>, B<_POSIX_SOURCE>, "
587 "B<_POSIX_C_SOURCE>, B<_XOPEN_SOURCE>, B<_XOPEN_SOURCE_EXTENDED>, "
588 "B<_BSD_SOURCE>, or B<_SVID_SOURCE> is explicitly defined, then "
589 "B<_BSD_SOURCE>, and B<_SVID_SOURCE> are not defined by default."
593 #: build/C/man7/feature_test_macros.7:399
595 "If B<_POSIX_SOURCE> and B<_POSIX_C_SOURCE> are not explicitly defined, and "
596 "either B<__STRICT_ANSI__> is not defined or B<_XOPEN_SOURCE> is defined with "
597 "a value of 500 or more, then"
601 #: build/C/man7/feature_test_macros.7:400 build/C/man7/feature_test_macros.7:403 build/C/man7/man-pages.7:490 build/C/man7/man-pages.7:493 build/C/man7/man-pages.7:500 build/C/man7/man-pages.7:504 build/C/man7/man-pages.7:508 build/C/man7/man-pages.7:512 build/C/man7/man-pages.7:518 build/C/man5/proc.5:573 build/C/man5/proc.5:577 build/C/man5/proc.5:580 build/C/man5/proc.5:582 build/C/man5/proc.5:585 build/C/man5/proc.5:989 build/C/man5/proc.5:992 build/C/man5/proc.5:1003 build/C/man5/proc.5:1006 build/C/man5/proc.5:1010 build/C/man5/proc.5:1013 build/C/man5/proc.5:1016 build/C/man5/proc.5:1019 build/C/man5/proc.5:1022 build/C/man5/proc.5:1025 build/C/man5/proc.5:1028 build/C/man5/proc.5:1031 build/C/man5/proc.5:1035 build/C/man5/proc.5:1038 build/C/man5/proc.5:1041 build/C/man5/proc.5:1044 build/C/man5/proc.5:1047 build/C/man5/proc.5:1050 build/C/man5/proc.5:1053 build/C/man5/proc.5:1064 build/C/man5/proc.5:1070 build/C/man5/proc.5:1074 build/C/man5/proc.5:1079 build/C/man5/proc.5:1084 build/C/man5/proc.5:1089 build/C/man5/proc.5:1094 build/C/man5/proc.5:1099 build/C/man5/proc.5:1104 build/C/man5/proc.5:1819 build/C/man5/proc.5:1823 build/C/man5/proc.5:1826 build/C/man5/proc.5:1831
607 #: build/C/man7/feature_test_macros.7:403
608 msgid "B<_POSIX_SOURCE> is defined with the value 1; and"
612 #: build/C/man7/feature_test_macros.7:406
613 msgid "B<_POSIX_C_SOURCE> is defined with one of the following values:"
617 #: build/C/man7/feature_test_macros.7:412
618 msgid "2, if B<XOPEN_SOURCE> is defined with a value less than 500;"
622 #: build/C/man7/feature_test_macros.7:418
624 "199506L, if B<XOPEN_SOURCE> is defined with a value greater than or equal to "
625 "500 and less than 600; or"
629 #: build/C/man7/feature_test_macros.7:423
631 "(since glibc 2.4) 200112L, if B<XOPEN_SOURCE> is defined with a value "
632 "greater than or equal to 600 and less than 700."
636 #: build/C/man7/feature_test_macros.7:429
638 "(Since glibc 2.10) 200809L, if B<XOPEN_SOURCE> is defined with a value "
639 "greater than or equal to 700."
643 #: build/C/man7/feature_test_macros.7:434
645 "Older versions of glibc do not know about the values 200112L and 200809L for "
646 "B<_POSIX_C_SOURCE>, and the setting of this macro will depend on the glibc "
651 #: build/C/man7/feature_test_macros.7:443
653 "If B<_XOPEN_SOURCE> is undefined, then the setting of B<_POSIX_C_SOURCE> "
654 "depends on the glibc version: 199506L, in glibc versions before 2.4; "
655 "200112L, in glibc 2.4 to 2.9; and 200809L, since glibc 2.10."
659 #: build/C/man7/feature_test_macros.7:447
660 msgid "Multiple macros can be defined; the results are additive."
664 #: build/C/man7/feature_test_macros.7:447 build/C/man2/intro.2:68 build/C/man3/intro.3:85 build/C/man7/suffixes.7:275
666 msgid "CONFORMING TO"
670 #: build/C/man7/feature_test_macros.7:455
672 "POSIX.1 specifies B<_POSIX_C_SOURCE>, B<_POSIX_SOURCE>, and "
673 "B<_XOPEN_SOURCE>. B<_XOPEN_SOURCE_EXTENDED> was specified by XPG4v2 (aka "
678 #: build/C/man7/feature_test_macros.7:459
680 "B<_FILE_OFFSET_BITS> is not specified by any standard, but is employed on "
681 "some other implementations."
685 #: build/C/man7/feature_test_macros.7:469
687 "B<_BSD_SOURCE>, B<_SVID_SOURCE>, B<_ATFILE_SOURCE>, B<_GNU_SOURCE>, "
688 "B<_FORTIFY_SOURCE>, B<_REENTRANT>, and B<_THREAD_SAFE> are specific to Linux "
693 #: build/C/man7/feature_test_macros.7:469 build/C/man1/intro.1:46 build/C/man2/intro.2:73 build/C/man3/intro.3:90 build/C/man4/intro.4:32 build/C/man5/intro.5:32 build/C/man6/intro.6:31 build/C/man7/intro.7:35 build/C/man8/intro.8:43 build/C/man7/man.7:476 build/C/man5/proc.5:2703 build/C/man2/unimplemented.2:40
699 #: build/C/man7/feature_test_macros.7:476
701 "I<E<lt>features.hE<gt>> is a Linux/glibc-specific header file. Other "
702 "systems have an analogous file, but typically with a different name. This "
703 "header file is automatically included by other header files as required: it "
704 "is not necessary to explicitly include it in order to employ feature test "
709 #: build/C/man7/feature_test_macros.7:486
711 "According to which of the above feature test macros are defined, "
712 "I<E<lt>features.hE<gt>> internally defines various other macros that are "
713 "checked by other glibc header files. These macros have names prefixed by "
714 "two underscores (e.g., B<__USE_MISC>). Programs should I<never> define "
715 "these macros directly: instead, the appropriate feature test macro(s) from "
716 "the list above should be employed."
720 #: build/C/man7/feature_test_macros.7:486 build/C/man7/man-pages.7:538
726 #: build/C/man7/feature_test_macros.7:492
728 "The program below can be used to explore how the various feature test macros "
729 "are set depending on the glibc version and what feature test macros are "
730 "explicitly set. The following shell session, on a system with glibc 2.10, "
731 "shows some examples of what we would see:"
735 #: build/C/man7/feature_test_macros.7:519
740 "_POSIX_SOURCE defined\n"
741 "_POSIX_C_SOURCE defined: 200809L\n"
742 "_BSD_SOURCE defined\n"
743 "_SVID_SOURCE defined\n"
744 "_ATFILE_SOURCE defined\n"
745 "$ B<cc -D_XOPEN_SOURCE=500 ftm.c>\n"
747 "_POSIX_SOURCE defined\n"
748 "_POSIX_C_SOURCE defined: 199506L\n"
749 "_XOPEN_SOURCE defined: 500\n"
750 "$ B<cc -D_GNU_SOURCE ftm.c>\n"
752 "_POSIX_SOURCE defined\n"
753 "_POSIX_C_SOURCE defined: 200809L\n"
754 "_ISOC99_SOURCE defined\n"
755 "_XOPEN_SOURCE defined: 700\n"
756 "_XOPEN_SOURCE_EXTENDED defined\n"
757 "_LARGEFILE64_SOURCE defined\n"
758 "_BSD_SOURCE defined\n"
759 "_SVID_SOURCE defined\n"
760 "_ATFILE_SOURCE defined\n"
761 "_GNU_SOURCE defined\n"
765 #: build/C/man7/feature_test_macros.7:521
767 msgid "Program source"
771 #: build/C/man7/feature_test_macros.7:525
773 msgid "/* ftm.c */\n"
777 #: build/C/man7/feature_test_macros.7:529
780 "#include E<lt>stdio.hE<gt>\n"
781 "#include E<lt>unistd.hE<gt>\n"
782 "#include E<lt>stdlib.hE<gt>\n"
786 #: build/C/man7/feature_test_macros.7:536
790 "main(int argc, char *argv[])\n"
792 "#ifdef _POSIX_SOURCE\n"
793 " printf(\"_POSIX_SOURCE defined\\en\");\n"
798 #: build/C/man7/feature_test_macros.7:540
801 "#ifdef _POSIX_C_SOURCE\n"
802 " printf(\"_POSIX_C_SOURCE defined: %ldL\\en\", (long) _POSIX_C_SOURCE);\n"
807 #: build/C/man7/feature_test_macros.7:544
810 "#ifdef _ISOC99_SOURCE\n"
811 " printf(\"_ISOC99_SOURCE defined\\en\");\n"
816 #: build/C/man7/feature_test_macros.7:548
819 "#ifdef _XOPEN_SOURCE\n"
820 " printf(\"_XOPEN_SOURCE defined: %d\\en\", _XOPEN_SOURCE);\n"
825 #: build/C/man7/feature_test_macros.7:552
828 "#ifdef _XOPEN_SOURCE_EXTENDED\n"
829 " printf(\"_XOPEN_SOURCE_EXTENDED defined\\en\");\n"
834 #: build/C/man7/feature_test_macros.7:556
837 "#ifdef _LARGEFILE64_SOURCE\n"
838 " printf(\"_LARGEFILE64_SOURCE defined\\en\");\n"
843 #: build/C/man7/feature_test_macros.7:560
846 "#ifdef _FILE_OFFSET_BITS\n"
847 " printf(\"_FILE_OFFSET_BITS defined: %d\\en\", _FILE_OFFSET_BITS);\n"
852 #: build/C/man7/feature_test_macros.7:564
855 "#ifdef _BSD_SOURCE\n"
856 " printf(\"_BSD_SOURCE defined\\en\");\n"
861 #: build/C/man7/feature_test_macros.7:568
864 "#ifdef _SVID_SOURCE\n"
865 " printf(\"_SVID_SOURCE defined\\en\");\n"
870 #: build/C/man7/feature_test_macros.7:572
873 "#ifdef _ATFILE_SOURCE\n"
874 " printf(\"_ATFILE_SOURCE defined\\en\");\n"
879 #: build/C/man7/feature_test_macros.7:576
882 "#ifdef _GNU_SOURCE\n"
883 " printf(\"_GNU_SOURCE defined\\en\");\n"
888 #: build/C/man7/feature_test_macros.7:580
891 "#ifdef _REENTRANT\n"
892 " printf(\"_REENTRANT defined\\en\");\n"
897 #: build/C/man7/feature_test_macros.7:584
900 "#ifdef _THREAD_SAFE\n"
901 " printf(\"_THREAD_SAFE defined\\en\");\n"
906 #: build/C/man7/feature_test_macros.7:588
909 "#ifdef _FORTIFY_SOURCE\n"
910 " printf(\"_FORTIFY_SOURCE defined\\en\");\n"
915 #: build/C/man7/feature_test_macros.7:591
918 " exit(EXIT_SUCCESS);\n"
923 #: build/C/man7/feature_test_macros.7:592 build/C/man1/intro.1:300 build/C/man2/intro.2:87 build/C/man3/intro.3:95 build/C/man4/intro.4:37 build/C/man5/intro.5:37 build/C/man7/intro.7:40 build/C/man7/libc.7:96 build/C/man7/mailaddr.7:116 build/C/man7/man-pages.7:545 build/C/man7/man.7:555 build/C/man7/mdoc.7:426 build/C/man7/posixoptions.7:853 build/C/man5/proc.5:2716 build/C/man7/standards.7:253 build/C/man7/suffixes.7:279 build/C/man2/unimplemented.2:64
929 #: build/C/man7/feature_test_macros.7:595
930 msgid "B<libc>(7), B<standards>(7)"
933 #. But beware: the info libc document is out of date (Jul 07, mtk)
935 #: build/C/man7/feature_test_macros.7:599
936 msgid "The section \"Feature Test Macros\" under I<info libc>."
940 #: build/C/man7/feature_test_macros.7:601
941 msgid "I</usr/include/features.h>"
945 #: build/C/man7/feature_test_macros.7:601 build/C/man1/intro.1:302 build/C/man2/intro.2:110 build/C/man3/intro.3:108 build/C/man4/intro.4:39 build/C/man5/intro.5:39 build/C/man6/intro.6:36 build/C/man7/intro.7:42 build/C/man8/intro.8:48 build/C/man7/libc.7:101 build/C/man7/mailaddr.7:126 build/C/man7/man-pages.7:552 build/C/man7/man.7:567 build/C/man7/mdoc.7:431 build/C/man7/operator.7:63 build/C/man7/posixoptions.7:856 build/C/man5/proc.5:2745 build/C/man7/standards.7:257 build/C/man7/suffixes.7:282 build/C/man3/undocumented.3:191 build/C/man2/unimplemented.2:66 build/C/man7/units.7:128
951 #: build/C/man7/feature_test_macros.7:608 build/C/man1/intro.1:309 build/C/man2/intro.2:117 build/C/man3/intro.3:115 build/C/man4/intro.4:46 build/C/man5/intro.5:46 build/C/man6/intro.6:43 build/C/man7/intro.7:49 build/C/man8/intro.8:55 build/C/man7/libc.7:108 build/C/man7/mailaddr.7:133 build/C/man7/man-pages.7:559 build/C/man7/man.7:574 build/C/man7/operator.7:70 build/C/man7/posixoptions.7:863 build/C/man5/proc.5:2752 build/C/man7/standards.7:264 build/C/man7/suffixes.7:289 build/C/man3/undocumented.3:198 build/C/man2/unimplemented.2:73 build/C/man7/units.7:135
953 "This page is part of release 3.37 of the Linux I<man-pages> project. A "
954 "description of the project, and information about reporting bugs, can be "
955 "found at http://www.kernel.org/doc/man-pages/."
959 #: build/C/man1/intro.1:26 build/C/man2/intro.2:27 build/C/man3/intro.3:24 build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28
965 #: build/C/man1/intro.1:26
971 #: build/C/man1/intro.1:26 build/C/man7/mailaddr.7:26
973 msgid "Linux User's Manual"
977 #: build/C/man1/intro.1:29
978 msgid "intro - Introduction to user commands"
982 #: build/C/man1/intro.1:33
984 "Section 1 of the manual describes user commands and tools, for example, file "
985 "manipulation tools, shells, compilers, web browsers, file and image viewers "
986 "and editors, and so on."
990 #: build/C/man1/intro.1:46
992 "All commands yield a status value on termination. This value can be tested "
993 "(e.g., in most shells the variable I<$?> contains the status of the last "
994 "executed command) to see whether the command completed successfully. A "
995 "zero exit status is conventionally used to indicate success, and a nonzero "
996 "status means that the command was unsuccessful. (Details of the exit status "
997 "can be found in B<wait>(2).) A nonzero exit status can be in the range 1 to "
998 "255, and some commands use different nonzero status values to indicate the "
999 "reason why the command failed."
1003 #: build/C/man1/intro.1:50
1005 "Linux is a flavor of UNIX, and as a first approximation all user commands "
1006 "under UNIX work precisely the same under Linux (and FreeBSD and lots of "
1007 "other UNIX-like systems)."
1011 #: build/C/man1/intro.1:60
1013 "Under Linux there are GUIs (graphical user interfaces), where you can point "
1014 "and click and drag, and hopefully get work done without first reading lots "
1015 "of documentation. The traditional UNIX environment is a CLI (command line "
1016 "interface), where you type commands to tell the computer what to do. That "
1017 "is faster and more powerful, but requires finding out what the commands "
1018 "are. Below a bare minimum, to get started."
1022 #: build/C/man1/intro.1:60
1028 #: build/C/man1/intro.1:74
1030 "In order to start working, you probably first have to login, that is, give "
1031 "your username and password. See also B<login>(1). The program I<login> now "
1032 "starts a I<shell> (command interpreter) for you. In case of a graphical "
1033 "login, you get a screen with menus or icons and a mouse click will start a "
1034 "shell in a window. See also B<xterm>(1)."
1038 #: build/C/man1/intro.1:74
1044 #: build/C/man1/intro.1:89
1046 "One types commands to the I<shell>, the command interpreter. It is not "
1047 "built-in, but is just a program and you can change your shell. Everybody "
1048 "has her own favorite one. The standard one is called I<sh>. See also "
1049 "B<ash>(1), B<bash>(1), B<csh>(1), B<zsh>(1), B<chsh>(1)."
1053 #: build/C/man1/intro.1:91
1054 msgid "A session might go like"
1058 #: build/C/man1/intro.1:106
1061 "B<knuth login: >I<aeb>\n"
1062 "B<Password: >I<********>\n"
1064 "Tue Aug 6 23:50:44 CEST 2002\n"
1067 "Su Mo Tu We Th Fr Sa\n"
1070 "11 12 13 14 15 16 17\n"
1071 "18 19 20 21 22 23 24\n"
1072 "25 26 27 28 29 30 31\n"
1076 #: build/C/man1/intro.1:133
1083 "drwxrwxr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1084 "-rw-rw-r-- 1 aeb 37 Aug 6 23:52 tel\n"
1086 "maja 0501-1136285\n"
1087 "peter 0136-7399214\n"
1088 "B<% >I<cp tel tel2>\n"
1091 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1092 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel\n"
1093 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1094 "B<% >I<mv tel tel1>\n"
1097 "drwxr-xr-x 2 aeb 1024 Aug 6 23:51 bin\n"
1098 "-rw-r--r-- 1 aeb 37 Aug 6 23:52 tel1\n"
1099 "-rw-r--r-- 1 aeb 37 Aug 6 23:53 tel2\n"
1100 "B<% >I<diff tel1 tel2>\n"
1102 "B<% >I<grep maja tel2>\n"
1103 "maja 0501-1136285\n"
1108 #: build/C/man1/intro.1:145
1110 "and here typing Control-D ended the session. The B<% > here was the command "
1111 "prompt\\(emit is the shell's way of indicating that it is ready for the next "
1112 "command. The prompt can be customized in lots of ways, and one might "
1113 "include stuff like username, machine name, current directory, time, etc. An "
1114 "assignment PS1=\"What next, master? \" would change the prompt as indicated."
1118 #: build/C/man1/intro.1:151
1120 "We see that there are commands I<date> (that gives date and time), and "
1121 "I<cal> (that gives a calendar)."
1125 #: build/C/man1/intro.1:167
1127 "The command I<ls> lists the contents of the current directory\\(emit tells "
1128 "you what files you have. With a I<-l> option it gives a long listing, that "
1129 "includes the owner and size and date of the file, and the permissions people "
1130 "have for reading and/or changing the file. For example, the file \"tel\" "
1131 "here is 37 bytes long, owned by aeb and the owner can read and write it, "
1132 "others can only read it. Owner and permissions can be changed by the "
1133 "commands I<chown> and I<chmod>."
1137 #: build/C/man1/intro.1:174
1139 "The command I<cat> will show the contents of a file. (The name is from "
1140 "\"concatenate and print\": all files given as parameters are concatenated "
1141 "and sent to \"standard output\", here the terminal screen.)"
1145 #: build/C/man1/intro.1:181
1147 "The command I<cp> (from \"copy\") will copy a file. On the other hand, the "
1148 "command I<mv> (from \"move\") only renames it."
1152 #: build/C/man1/intro.1:186
1154 "The command I<diff> lists the differences between two files. Here there was "
1155 "no output because there were no differences."
1159 #: build/C/man1/intro.1:192
1161 "The command I<rm> (from \"remove\") deletes the file, and be careful! it is "
1162 "gone. No wastepaper basket or anything. Deleted means lost."
1166 #: build/C/man1/intro.1:197
1168 "The command I<grep> (from \"g/re/p\") finds occurrences of a string in one "
1169 "or more files. Here it finds Maja's telephone number."
1173 #: build/C/man1/intro.1:197
1175 msgid "Pathnames and the current directory"
1179 #: build/C/man1/intro.1:209
1181 "Files live in a large tree, the file hierarchy. Each has a I<pathname> "
1182 "describing the path from the root of the tree (which is called /) to the "
1183 "file. For example, such a full pathname might be /home/aeb/tel. Always "
1184 "using full pathnames would be inconvenient, and the name of a file in the "
1185 "current directory may be abbreviated by only giving the last component. "
1186 "That is why \"/home/aeb/tel\" can be abbreviated to \"tel\" when the current "
1187 "directory is \"/home/aeb\"."
1191 #: build/C/man1/intro.1:213
1192 msgid "The command I<pwd> prints the current directory."
1196 #: build/C/man1/intro.1:218
1198 "The command I<cd> changes the current directory. Try \"cd /\" and \"pwd\" "
1199 "and \"cd\" and \"pwd\"."
1203 #: build/C/man1/intro.1:218
1209 #: build/C/man1/intro.1:222
1210 msgid "The command I<mkdir> makes a new directory."
1214 #: build/C/man1/intro.1:226
1216 "The command I<rmdir> removes a directory if it is empty, and complains "
1221 #: build/C/man1/intro.1:238
1223 "The command I<find> (with a rather baroque syntax) will find files with "
1224 "given name or other properties. For example, \"find . -name tel\" would "
1225 "find the file \"tel\" starting in the present directory (which is called "
1226 "\".\"). And \"find / -name tel\" would do the same, but starting at the "
1227 "root of the tree. Large searches on a multi-GB disk will be time-consuming, "
1228 "and it may be better to use B<locate>(1)."
1232 #: build/C/man1/intro.1:238
1234 msgid "Disks and Filesystems"
1238 #: build/C/man1/intro.1:249
1240 "The command I<mount> will attach the file system found on some disk (or "
1241 "floppy, or CDROM or so) to the big file system hierarchy. And I<umount> "
1242 "detaches it again. The command I<df> will tell you how much of your disk is "
1247 #: build/C/man1/intro.1:249
1253 #: build/C/man1/intro.1:267
1255 "On a UNIX system many user and system processes run simultaneously. The one "
1256 "you are talking to runs in the I<foreground>, the others in the "
1257 "I<background>. The command I<ps> will show you which processes are active "
1258 "and what numbers these processes have. The command I<kill> allows you to "
1259 "get rid of them. Without option this is a friendly request: please go "
1260 "away. And \"kill -9\" followed by the number of the process is an immediate "
1261 "kill. Foreground processes can often be killed by typing Control-C."
1265 #: build/C/man1/intro.1:267
1267 msgid "Getting information"
1271 #: build/C/man1/intro.1:280
1273 "There are thousands of commands, each with many options. Traditionally "
1274 "commands are documented on I<man pages>, (like this one), so that the "
1275 "command \"man kill\" will document the use of the command \"kill\" (and "
1276 "\"man man\" document the command \"man\"). The program I<man> sends the "
1277 "text through some I<pager>, usually I<less>. Hit the space bar to get the "
1278 "next page, hit q to quit."
1282 #: build/C/man1/intro.1:288
1284 "In documentation it is customary to refer to man pages by giving the name "
1285 "and section number, as in B<man>(1). Man pages are terse, and allow you to "
1286 "find quickly some forgotten detail. For newcomers an introductory text with "
1287 "more examples and explanations is useful."
1291 #: build/C/man1/intro.1:292
1293 "A lot of GNU/FSF software is provided with info files. Type \"info info\" "
1294 "for an introduction on the use of the program \"info\"."
1298 #. Actual examples? Separate section for each of cat, cp, ...?
1299 #. gzip, bzip2, tar, rpm
1301 #: build/C/man1/intro.1:300
1303 "Special topics are often treated in HOWTOs. Look in "
1304 "I</usr/share/doc/howto/en> and use a browser if you find HTML files there."
1308 #: build/C/man1/intro.1:302 build/C/man4/intro.4:39 build/C/man5/intro.5:39 build/C/man7/intro.7:42
1309 msgid "B<standards>(7)"
1313 #: build/C/man2/intro.2:27 build/C/man3/intro.3:24
1319 #: build/C/man2/intro.2:30
1320 msgid "intro - Introduction to system calls"
1324 #: build/C/man2/intro.2:40
1326 "Section 2 of the manual describes the Linux system calls. A system call is "
1327 "an entry point into the Linux kernel. Usually, system calls are not invoked "
1328 "directly: instead, most system calls have corresponding C library wrapper "
1329 "functions which perform the steps required (e.g., trapping to kernel mode) "
1330 "in order to invoke the system call. Thus, making a system call looks the "
1331 "same as invoking a normal library function."
1335 #: build/C/man2/intro.2:43
1336 msgid "For a list of the Linux system calls, see B<syscalls>(2)."
1340 #: build/C/man2/intro.2:43 build/C/man2/unimplemented.2:35
1342 msgid "RETURN VALUE"
1346 #: build/C/man2/intro.2:52
1348 "On error, most system calls return a negative error number (i.e., the "
1349 "negated value of one of the constants described in B<errno>(3)). The C "
1350 "library wrapper hides this detail from the caller: when a system call "
1351 "returns a negative value, the wrapper copies the absolute value into the "
1352 "I<errno> variable, and returns -1 as the return value of the wrapper."
1356 #: build/C/man2/intro.2:57
1358 "The value returned by a successful system call depends on the call. Many "
1359 "system calls return 0 on success, but some can return nonzero values from a "
1360 "successful call. The details are described in the individual manual pages."
1364 #: build/C/man2/intro.2:68
1366 "In some cases, the programmer must define a feature test macro in order to "
1367 "obtain the declaration of a system call from the header file specified in "
1368 "the man page SYNOPSIS section. (Where required, these feature test macros "
1369 "must be defined before including I<any> header files.) In such cases, the "
1370 "required macro is described in the man page. For further information on "
1371 "feature test macros, see B<feature_test_macros>(7)."
1375 #: build/C/man2/intro.2:73 build/C/man3/intro.3:90
1377 "Certain terms and abbreviations are used to indicate UNIX variants and "
1378 "standards to which calls in this section conform. See B<standards>(7)."
1382 #: build/C/man2/intro.2:74
1384 msgid "Calling Directly"
1388 #: build/C/man2/intro.2:83
1390 "In most cases, it is unnecessary to invoke a system call directly, but there "
1391 "are times when the Standard C library does not implement a nice wrapper "
1392 "function for you. In this case, the programmer must manually invoke the "
1393 "system call using B<syscall>(2). Historically, this was also possible using "
1394 "one of the _syscall macros described in B<_syscall>(2)."
1398 #: build/C/man2/intro.2:83 build/C/man3/intro.3:91 build/C/man4/intro.4:33 build/C/man5/intro.5:33 build/C/man6/intro.6:32 build/C/man7/intro.7:36 build/C/man8/intro.8:44
1400 msgid "Authors and Copyright Conditions"
1404 #: build/C/man2/intro.2:87 build/C/man3/intro.3:95 build/C/man4/intro.4:37 build/C/man5/intro.5:37 build/C/man6/intro.6:36 build/C/man7/intro.7:40 build/C/man8/intro.8:48
1406 "Look at the header of the manual page source for the author(s) and copyright "
1407 "conditions. Note that these can be different from page to page!"
1411 #: build/C/man2/intro.2:110
1413 "B<_syscall>(2), B<syscall>(2), B<syscalls>(2), B<errno>(3), B<intro>(3), "
1414 "B<capabilities>(7), B<credentials>(7), B<feature_test_macros>(7), "
1415 "B<mq_overview>(7), B<path_resolution>(7), B<pipe>(7), B<pty>(7), "
1416 "B<sem_overview>(7), B<shm_overview>(7), B<signal>(7), B<svipc>(7), "
1417 "B<standards>(7), B<socket>(7), B<symlink>(7), B<time>(7)"
1421 #: build/C/man3/intro.3:27
1422 msgid "intro - Introduction to library functions"
1426 #: build/C/man3/intro.3:31
1428 "Section 3 of the manual describes all library functions excluding the "
1429 "library functions (system call wrappers) described in section 2, which "
1430 "implement system calls."
1434 #: build/C/man3/intro.3:48
1436 "Many of the functions described in the section are part of the Standard C "
1437 "Library (I<libc>). Some functions are part of other libraries (e.g., the "
1438 "math library, I<libm>, or the real-time library, I<librt>) in which case "
1439 "the manual page will indicate the linker option needed to link against the "
1440 "required library (e.g., I<-lm> and I<-lrt>, respectively, for the "
1441 "aforementioned libraries)."
1446 #. are various function groups which can be identified by a letter which
1447 #. is appended to the chapter number:
1449 #. These functions, the functions from chapter 2 and from chapter 3S are
1450 #. contained in the C standard library libc, which will be used by
1454 #. These functions are parts of the
1456 #. library. They are contained in the standard C library libc.
1458 #. These functions are contained in the arithmetic library libm. They are
1461 #. FORTRAN compiler by default, but not by the
1463 #. C compiler, which needs the option \fI\-lm\fP.
1465 #. These functions are part of the FORTRAN library libF77. There are no
1466 #. special compiler flags needed to use these functions.
1468 #. Various special libraries. The manual pages documenting their functions
1469 #. specify the library names.
1471 #: build/C/man3/intro.3:85
1473 "In some cases, the programmer must define a feature test macro in order to "
1474 "obtain the declaration of a function from the header file specified in the "
1475 "man page SYNOPSIS section. (Where required, these feature test macros must "
1476 "be defined before including I<any> header files.) In such cases, the "
1477 "required macro is described in the man page. For further information on "
1478 "feature test macros, see B<feature_test_macros>(7)."
1482 #: build/C/man3/intro.3:108
1484 "B<intro>(2), B<errno>(3), B<capabilities>(7), B<credentials>(7), "
1485 "B<feature_test_macros>(7), B<libc>(7), B<math_error>(7), B<environ>(7), "
1486 "B<path_resolution>(7), B<pthreads>(7), B<signal>(7), B<standards>(7)"
1490 #: build/C/man4/intro.4:25 build/C/man5/intro.5:26 build/C/man6/intro.6:25 build/C/man7/intro.7:27 build/C/man8/intro.8:28
1496 #: build/C/man4/intro.4:28
1497 msgid "intro - Introduction to special files"
1501 #: build/C/man4/intro.4:30
1502 msgid "Section 4 of the manual describes special files (devices)."
1506 #: build/C/man4/intro.4:30 build/C/man7/mailaddr.7:112 build/C/man7/man.7:472 build/C/man7/mdoc.7:409
1512 #: build/C/man4/intro.4:32
1513 msgid "/dev/* \\(em device files"
1517 #: build/C/man5/intro.5:29
1518 msgid "intro - Introduction to file formats"
1522 #: build/C/man5/intro.5:32
1524 "Section 5 of the manual describes various file formats and protocols, and "
1525 "the corresponding C structures, if any."
1529 #: build/C/man6/intro.6:28
1530 msgid "intro - Introduction to games"
1534 #: build/C/man6/intro.6:31
1536 "Section 6 of the manual describes all the games and funny little programs "
1537 "available on the system."
1541 #: build/C/man7/intro.7:30
1542 msgid "intro - Introduction to overview, conventions, and miscellany section"
1546 #: build/C/man7/intro.7:35
1548 "Section 7 of the manual provides overviews on various topics, and describes "
1549 "conventions and protocols, character set standards, the standard file system "
1550 "layout, and miscellaneous other things."
1554 #: build/C/man8/intro.8:31
1555 msgid "intro - Introduction to administration and privileged commands"
1559 #: build/C/man8/intro.8:36
1561 "Section 8 of the manual describes commands which either can be or are only "
1562 "used by the superuser, like system-administration commands, daemons, and "
1563 "hardware-related commands."
1567 #: build/C/man8/intro.8:43
1569 "As with the commands in described section 1, the commands described in this "
1570 "section terminate with an exit status that indicates whether the command "
1571 "succeeded or failed. See B<intro>(1) for more information."
1575 #: build/C/man7/libc.7:24
1581 #: build/C/man7/libc.7:24
1587 #: build/C/man7/libc.7:27
1588 msgid "libc - Overview of standard C libraries on Linux"
1592 #: build/C/man7/libc.7:34
1594 "The term \"libc\" is commonly used as a shorthand for the \"standard C "
1595 "library\", a library of standard functions that can be used by all C "
1596 "programs (and sometimes by programs in other languages). Because of some "
1597 "history (see below), use of the term \"libc\" to refer to the standard C "
1598 "library is somewhat ambiguous on Linux."
1602 #: build/C/man7/libc.7:34
1608 #: build/C/man7/libc.7:51
1610 "By far the most widely used C library on Linux is the GNU C Library "
1611 "(I<http://www.gnu.org/software/libc/>), often referred to as I<glibc>. This "
1612 "is the C library that is nowadays used in all major Linux distributions. It "
1613 "is also the C library whose details are documented in the relevant pages of "
1614 "the I<man-pages> project (primarily in Section 3 of the manual). "
1615 "Documentation of glibc is also available in the glibc manual, available via "
1616 "the command I<info libc>. Release 1.0 of glibc was made in September 1992. "
1617 "(There were earlier 0.x releases.) The next major release of glibc was 2.0, "
1618 "at the beginning of 1997."
1622 #: build/C/man7/libc.7:58
1624 "The pathname I</lib/libc.so.6> (or something similar) is normally a symbolic "
1625 "link that points to the location of the glibc library, and executing this "
1626 "pathname will cause glibc to display various information about the version "
1627 "installed on your system."
1631 #: build/C/man7/libc.7:58
1637 #: build/C/man7/libc.7:81
1639 "In the early to mid 1990s, there was for a while I<Linux libc>, a fork of "
1640 "glibc 1.x created by Linux developers who felt that glibc development at the "
1641 "time was not sufficing for the needs of Linux. Often, this library was "
1642 "referred to (ambiguously) as just \"libc\". Linux libc released major "
1643 "versions 2, 3, 4, and 5 (as well as many minor versions of those releases). "
1644 "For a while, Linux libc was the standard C library in many Linux "
1645 "distributions. However, notwithstanding the original motivations of the "
1646 "Linux libc effort, by the time glibc 2.0 was released, it was clearly "
1647 "superior to Linux libc, and all major Linux distributions that had been "
1648 "using Linux libc soon switched back to glibc. (Since this switch occurred "
1649 "over a decade ago, I<man-pages> no longer takes care to document Linux libc "
1650 "details. Nevertheless, the history is visible in vestiges of information "
1651 "about Linux libc that remain in some manual pages, in particular, references "
1652 "to I<libc4> and I<libc5>.)"
1656 #: build/C/man7/libc.7:81
1658 msgid "Other C libraries"
1662 #: build/C/man7/libc.7:96
1664 "There are various other less widely used C libraries for Linux. These "
1665 "libraries are generally smaller than glibc, both in terms of features and "
1666 "memory footprint, and often intended for building small binaries, perhaps "
1667 "targeted at development for embedded Linux systems. Among such libraries "
1668 "are I<uClibc> (I<http://www.uclibc.org/>) and I<dietlibc> "
1669 "(I<http://www.fefe.de/dietlibc/>). Details of these libraries are generally "
1670 "not covered by the I<man-pages> project."
1674 #: build/C/man7/libc.7:101
1675 msgid "B<syscalls>(2), B<feature_test_macros>(7), B<man-pages>(7), B<standards>(7)"
1679 #: build/C/man7/mailaddr.7:26
1685 #: build/C/man7/mailaddr.7:26
1691 #: build/C/man7/mailaddr.7:30
1692 msgid "mailaddr - mail addressing description"
1696 #: build/C/man7/mailaddr.7:35
1698 "This manual page gives a brief introduction to SMTP mail addresses, as used "
1699 "on the Internet. These addresses are in the general format"
1703 #: build/C/man7/mailaddr.7:37
1704 msgid " user@domain"
1708 #: build/C/man7/mailaddr.7:40
1710 "where a domain is a hierarchical dot-separated list of subdomains. These "
1711 "examples are valid forms of the same address:"
1715 #: build/C/man7/mailaddr.7:42
1716 msgid " eric@monet.berkeley.edu"
1720 #: build/C/man7/mailaddr.7:44
1721 msgid " Eric Allman E<lt>eric@monet.berkeley.eduE<gt>"
1725 #: build/C/man7/mailaddr.7:46
1726 msgid " eric@monet.berkeley.edu (Eric Allman)"
1730 #: build/C/man7/mailaddr.7:50
1732 "The domain part (\"monet.berkeley.edu\") is a mail-accepting domain. It can "
1733 "be a host and in the past it usually was, but it doesn't have to be. The "
1734 "domain part is not case sensitive."
1738 #: build/C/man7/mailaddr.7:58
1740 "The local part (\"eric\") is often a username, but its meaning is defined by "
1741 "the local software. Sometimes it is case sensitive, although that is "
1742 "unusual. If you see a local-part that looks like garbage, it is usually "
1743 "because of a gateway between an internal e-mail system and the net, here are "
1748 #: build/C/man7/mailaddr.7:60
1749 msgid " \"surname/admd=telemail/c=us/o=hp/prmd=hp\"@some.where"
1753 #: build/C/man7/mailaddr.7:62
1754 msgid " USER%SOMETHING@some.where"
1758 #: build/C/man7/mailaddr.7:64
1759 msgid " machine!machine!name@some.where"
1763 #: build/C/man7/mailaddr.7:66
1764 msgid " I2461572@some.where"
1768 #: build/C/man7/mailaddr.7:70
1770 "(These are, respectively, an X.400 gateway, a gateway to an arbitrary "
1771 "internal mail system that lacks proper internet support, an UUCP gateway, "
1772 "and the last one is just boring username policy.)"
1776 #: build/C/man7/mailaddr.7:76
1778 "The real-name part (\"Eric Allman\") can either be placed before E<lt>E<gt>, "
1779 "or in () at the end. (Strictly speaking the two aren't the same, but the "
1780 "difference is beyond the scope of this page.) The name may have to be "
1781 "quoted using \"\", for example, if it contains \".\":"
1785 #: build/C/man7/mailaddr.7:78
1786 msgid " \"Eric P. Allman\" E<lt>eric@monet.berkeley.eduE<gt>"
1790 #: build/C/man7/mailaddr.7:78
1792 msgid "Abbreviation."
1796 #: build/C/man7/mailaddr.7:86
1798 "Many mail systems let users abbreviate the domain name. For instance, users "
1799 "at berkeley.edu may get away with \"eric@monet\" to send mail to Eric "
1800 "Allman. I<This behavior is deprecated.> Sometimes it works, but you should "
1805 #: build/C/man7/mailaddr.7:86
1807 msgid "Route-addrs."
1811 #: build/C/man7/mailaddr.7:93
1813 "In the past, sometimes one had to route a message through several hosts to "
1814 "get it to its final destination. Addresses which show these relays are "
1815 "termed \"route-addrs\". These use the syntax:"
1819 #: build/C/man7/mailaddr.7:95
1820 msgid " E<lt>@hosta,@hostb:user@hostcE<gt>"
1824 #: build/C/man7/mailaddr.7:100
1826 "This specifies that the message should be sent to hosta, from there to "
1827 "hostb, and finally to hostc. Many hosts disregard route-addrs and send "
1828 "directly to hostc."
1832 #: build/C/man7/mailaddr.7:106
1834 "Route-addrs are very unusual now. They occur sometimes in old mail "
1835 "archives. It is generally possible to ignore all but the \"user@hostc\" "
1836 "part of the address to determine the actual address."
1840 #: build/C/man7/mailaddr.7:106
1846 #: build/C/man7/mailaddr.7:112
1848 "Every site is required to have a user or user alias designated "
1849 "\"postmaster\" to which problems with the mail system may be addressed. The "
1850 "\"postmaster\" address is not case sensitive."
1854 #: build/C/man7/mailaddr.7:114
1855 msgid "I</etc/aliases>"
1859 #: build/C/man7/mailaddr.7:116
1860 msgid "I<~/.forward>"
1864 #: build/C/man7/mailaddr.7:124
1866 "B<binmail>(1), B<mail>(1), B<mconnect>(1), B<aliases>(5), B<forward>(5), "
1867 "B<sendmail>(8), B<vrfy>(8)"
1871 #: build/C/man7/mailaddr.7:126
1872 msgid "RFC\\ 2822 (Internet Message Format)"
1876 #: build/C/man7/man-pages.7:28
1882 #: build/C/man7/man-pages.7:28
1888 #: build/C/man7/man-pages.7:31
1889 msgid "man-pages - conventions for writing Linux man pages"
1893 #: build/C/man7/man-pages.7:35 build/C/man7/man.7:47
1894 msgid "B<man> [I<section>] I<title>"
1898 #: build/C/man7/man-pages.7:41
1900 "This page describes the conventions that should be employed when writing man "
1901 "pages for the Linux I<man-pages> project, which comprises Sections 2, 3, 4, "
1902 "5, and 7 of the Linux manual pages. The conventions described on this page "
1903 "may also be useful for authors writing man pages for other projects."
1907 #: build/C/man7/man-pages.7:41
1909 msgid "Sections of the Manual Pages"
1913 #: build/C/man7/man-pages.7:44
1914 msgid "The manual Sections are traditionally defined as follows:"
1918 #: build/C/man7/man-pages.7:44
1920 msgid "B<1 Commands (Programs)>"
1924 #: build/C/man7/man-pages.7:48
1925 msgid "Those commands that can be executed by the user from within a shell."
1929 #: build/C/man7/man-pages.7:48
1931 msgid "B<2 System calls>"
1935 #: build/C/man7/man-pages.7:51
1936 msgid "Those functions which must be performed by the kernel."
1940 #: build/C/man7/man-pages.7:51
1942 msgid "B<3 Library calls>"
1946 #: build/C/man7/man-pages.7:56
1947 msgid "Most of the I<libc> functions."
1951 #: build/C/man7/man-pages.7:56
1953 msgid "B<4 Special files (devices)>"
1957 #: build/C/man7/man-pages.7:60
1958 msgid "Files found in I</dev>."
1962 #: build/C/man7/man-pages.7:60
1964 msgid "B<5 File formats and conventions>"
1968 #: build/C/man7/man-pages.7:65
1969 msgid "The format for I</etc/passwd> and other human-readable files."
1973 #: build/C/man7/man-pages.7:65
1979 #: build/C/man7/man-pages.7:67
1981 msgid "B<7 Conventions and miscellaneous>"
1985 #: build/C/man7/man-pages.7:71
1987 "Overviews of various topics, conventions and protocols, character set "
1988 "standards, and miscellaneous other things."
1992 #: build/C/man7/man-pages.7:71
1994 msgid "B<8 System management commands>"
1998 #. .B 9 Kernel routines
1999 #. This is an obsolete manual section.
2000 #. Once it was thought a good idea to document the Linux kernel here,
2001 #. but in fact very little has been documented, and the documentation
2002 #. that exists is outdated already.
2003 #. There are better sources of
2004 #. information for kernel developers.
2006 #: build/C/man7/man-pages.7:84
2007 msgid "Commands like B<mount>(8), many of which only root can execute."
2011 #: build/C/man7/man-pages.7:84
2013 msgid "Macro package"
2017 #: build/C/man7/man-pages.7:91
2019 "New manual pages should be marked up using the B<groff an.tmac> package "
2020 "described in B<man>(7). This choice is mainly for consistency: the vast "
2021 "majority of existing Linux manual pages are marked up using these macros."
2025 #: build/C/man7/man-pages.7:91
2027 msgid "Conventions for source file layout"
2031 #: build/C/man7/man-pages.7:96
2033 "Please limit source code line length to no more than about 75 characters "
2034 "wherever possible. This helps avoid line-wrapping in some mail clients when "
2035 "patches are submitted inline."
2039 #: build/C/man7/man-pages.7:100
2041 "New sentences should be started on new lines. This makes it easier to see "
2042 "the effect of patches, which often operate at the level of individual "
2047 #: build/C/man7/man-pages.7:100 build/C/man7/man.7:76
2053 #: build/C/man7/man-pages.7:102
2054 msgid "The first command in a man page should be a B<TH> command:"
2058 #: build/C/man7/man-pages.7:106 build/C/man7/man.7:83
2059 msgid "B<\\&.TH> I<title section date source manual>"
2063 #: build/C/man7/man-pages.7:109
2068 #: build/C/man7/man-pages.7:110
2074 #: build/C/man7/man-pages.7:114
2075 msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
2079 #: build/C/man7/man-pages.7:114
2085 #: build/C/man7/man-pages.7:118
2086 msgid "The section number in which the man page should be placed (e.g., I<7>)."
2090 #: build/C/man7/man-pages.7:118
2096 #: build/C/man7/man-pages.7:124
2098 "The date of the last revision\\(emremember to change this every time a "
2099 "change is made to the man page, since this is the most general way of doing "
2100 "version control. Dates should be written in the form YYYY-MM-DD."
2104 #: build/C/man7/man-pages.7:124
2110 #: build/C/man7/man-pages.7:127
2111 msgid "The source of the command, function, or system call."
2115 #: build/C/man7/man-pages.7:131
2117 "For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
2122 #: build/C/man7/man-pages.7:139
2124 "For system calls, just write I<Linux>. (An earlier practice was to write "
2125 "the version number of the kernel from which the manual page was being "
2126 "written/checked. However, this was never done consistently, and so was "
2127 "probably worse than including no version number. Henceforth, avoid "
2128 "including a version number.)"
2132 #: build/C/man7/man-pages.7:144
2134 "For library calls that are part of glibc or one of the other common GNU "
2135 "libraries, just use I<GNU C Library>, I<GNU>, or an empty string."
2139 #: build/C/man7/man-pages.7:147
2140 msgid "For Section 4 pages, use I<Linux>."
2144 #: build/C/man7/man-pages.7:150
2145 msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
2149 #: build/C/man7/man-pages.7:150
2155 #: build/C/man7/man-pages.7:155
2157 "The title of the manual (e.g., for Section 2 and 3 pages in the I<man-pages> "
2158 "package, use I<Linux Programmer's Manual>)."
2162 #: build/C/man7/man-pages.7:156
2164 msgid "Sections within a manual page"
2168 #: build/C/man7/man-pages.7:163
2170 "The list below shows conventional or suggested sections. Most manual pages "
2171 "should include at least the B<highlighted> sections. Arrange a new manual "
2172 "page so that sections are placed in the order shown in the list."
2175 #. May 07: Few current man pages have an ERROR HANDLING section,,,
2177 #. May 07: Almost no current man pages have a USAGE section,,,
2180 #. May 07: Almost no current man pages have a SECURITY section,,,
2182 #. AUTHORS sections are discouraged
2183 #. AUTHORS [Discouraged]
2185 #: build/C/man7/man-pages.7:191
2190 "CONFIGURATION [Normally only in Section 4]\n"
2192 "OPTIONS [Normally only in Sections 1, 8]\n"
2193 "EXIT STATUS [Normally only in Sections 1, 8]\n"
2194 "RETURN VALUE [Normally only in Sections 2, 3]\n"
2195 "ERRORS [Typically only in Sections 2, 3]\n"
2198 "VERSIONS [Normally only in Sections 2, 3]\n"
2207 #: build/C/man7/man-pages.7:202
2209 "I<Where a traditional heading would apply>, I<please use it>; this kind of "
2210 "consistency can make the information easier to understand. If you must, you "
2211 "can create your own headings if they make things easier to understand (this "
2212 "can be especially useful for pages in Sections 4 and 5). However, before "
2213 "doing this, consider whether you could use the traditional headings, with "
2214 "some subsections (I<.SS>) within those sections."
2218 #: build/C/man7/man-pages.7:205
2219 msgid "The following list elaborates on the contents of each of the above sections."
2223 #: build/C/man7/man-pages.7:205
2229 #: build/C/man7/man-pages.7:212
2231 "The name of this manual page. See B<man>(7) for important details of the "
2232 "line(s) that should follow the B<.SH NAME> command."
2236 #: build/C/man7/man-pages.7:212
2242 #: build/C/man7/man-pages.7:224
2244 "briefly describes the command or function's interface. For commands, this "
2245 "shows the syntax of the command and its arguments (including options); "
2246 "boldface is used for as-is text and italics are used to indicate replaceable "
2247 "arguments. Brackets ([]) surround optional arguments, vertical bars (|) "
2248 "separate choices, and ellipses (\\&...) can be repeated. For functions, it "
2249 "shows any required data declarations or B<#include> directives, followed by "
2250 "the function declaration."
2253 #. FIXME . Say something here about compiler options
2255 #: build/C/man7/man-pages.7:230
2257 "Where a feature test macro must be defined in order to obtain the "
2258 "declaration of a function (or a variable) from a header file, then the "
2259 "SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
2263 #: build/C/man7/man-pages.7:230
2265 msgid "B<CONFIGURATION>"
2269 #: build/C/man7/man-pages.7:234
2271 "Configuration details for a device. This section normally only appears in "
2276 #: build/C/man7/man-pages.7:234
2278 msgid "B<DESCRIPTION>"
2281 #. If there is some kind of input grammar or complex set of subcommands,
2282 #. consider describing them in a separate
2284 #. section (and just place an overview in the
2288 #: build/C/man7/man-pages.7:251
2290 "gives an explanation of what the program, function, or format does. Discuss "
2291 "how it interacts with files and standard input, and what it produces on "
2292 "standard output or standard error. Omit internals and implementation "
2293 "details unless they're critical for understanding the interface. Describe "
2294 "the usual case; for information on command-line options of a program use the "
2295 "B<OPTIONS> section."
2299 #: build/C/man7/man-pages.7:251
2306 #. describes the grammar of any sublanguage this implements.
2308 #: build/C/man7/man-pages.7:259
2310 "describes the command-line options accepted by a program and how they change "
2311 "its behavior. This section should only appear for Section 1 and 8 manual "
2316 #: build/C/man7/man-pages.7:259
2318 msgid "B<EXIT STATUS>"
2322 #: build/C/man7/man-pages.7:264
2324 "lists the possible exit status values of a program and the conditions that "
2325 "cause these values to be returned. This section should only appear for "
2326 "Section 1 and 8 manual pages."
2330 #: build/C/man7/man-pages.7:264
2332 msgid "B<RETURN VALUE>"
2336 #: build/C/man7/man-pages.7:269
2338 "For Section 2 and 3 pages, this section gives a list of the values the "
2339 "library routine will return to the caller and the conditions that cause "
2340 "these values to be returned."
2344 #: build/C/man7/man-pages.7:269
2350 #: build/C/man7/man-pages.7:277
2352 "For Section 2 and 3 manual pages, this is a list of the values that may be "
2353 "placed in I<errno> in the event of an error, along with information about "
2354 "the cause of the errors. I<The error list should be in alphabetical order>."
2358 #: build/C/man7/man-pages.7:277
2360 msgid "B<ENVIRONMENT>"
2364 #: build/C/man7/man-pages.7:281
2366 "lists all environment variables that affect the program or function and how "
2371 #: build/C/man7/man-pages.7:281
2376 #. May 07: Almost no current man pages have a DIAGNOSTICS section;
2377 #. "RETURN VALUE" or "EXIT STATUS" is preferred.
2380 #. gives an overview of the most common error messages and how to
2382 #. You don't need to explain system error messages
2383 #. or fatal signals that can appear during execution of any program
2384 #. unless they're special in some way to the program.
2386 #. May 07: Almost no current man pages have a SECURITY section.
2389 #. discusses security issues and implications.
2390 #. Warn about configurations or environments that should be avoided,
2391 #. commands that may have security implications, and so on, especially
2392 #. if they aren't obvious.
2393 #. Discussing security in a separate section isn't necessary;
2394 #. if it's easier to understand, place security information in the
2395 #. other sections (such as the
2400 #. However, please include security information somewhere!
2402 #: build/C/man7/man-pages.7:318
2404 "lists the files the program or function uses, such as configuration files, "
2405 "startup files, and files the program directly operates on. Give the full "
2406 "pathname of these files, and use the installation process to modify the "
2407 "directory part to match user preferences. For many programs, the default "
2408 "installation location is in I</usr/local>, so your base manual page should "
2409 "use I</usr/local> as the base."
2413 #: build/C/man7/man-pages.7:318
2419 #: build/C/man7/man-pages.7:335
2421 "A brief summary of the Linux kernel or glibc versions where a system call or "
2422 "library function appeared, or changed significantly in its operation. As a "
2423 "general rule, every new interface should include a VERSIONS section in its "
2424 "manual page. Unfortunately, many existing manual pages don't include this "
2425 "information (since there was no policy to do so when they were written). "
2426 "Patches to remedy this are welcome, but, from the perspective of programmers "
2427 "writing new code, this information probably only matters in the case of "
2428 "kernel interfaces that have been added in Linux 2.4 or later (i.e., changes "
2429 "since kernel 2.2), and library functions that have been added to glibc since "
2430 "version 2.1 (i.e., changes since glibc 2.0)."
2434 #: build/C/man7/man-pages.7:340
2436 "The B<syscalls>(2) manual page also provides information about kernel "
2437 "versions in which various system calls first appeared."
2441 #: build/C/man7/man-pages.7:340
2443 msgid "B<CONFORMING TO>"
2447 #: build/C/man7/man-pages.7:354
2449 "describes any standards or conventions that relate to the function or "
2450 "command described by the manual page. For a page in Section 2 or 3, this "
2451 "section should note the POSIX.1 version(s) that the call conforms to, and "
2452 "also whether the call is specified in C99. (Don't worry too much about "
2453 "other standards like SUS, SUSv2, and XPG, or the SVr4 and 4.xBSD "
2454 "implementation standards, unless the call was specified in those standards, "
2455 "but isn't in the current version of POSIX.1.) (See B<standards>(7).)"
2459 #: build/C/man7/man-pages.7:358
2461 "If the call is not governed by any standards but commonly exists on other "
2462 "systems, note them. If the call is Linux-specific, note this."
2466 #: build/C/man7/man-pages.7:362
2468 "If this section consists of just a list of standards (which it commonly "
2469 "does), terminate the list with a period (\\(aq.\\(aq)."
2473 #: build/C/man7/man-pages.7:362
2479 #: build/C/man7/man-pages.7:367
2481 "provides miscellaneous notes. For Section 2 and 3 man pages you may find it "
2482 "useful to include subsections (B<SS>) named I<Linux Notes> and I<Glibc "
2487 #: build/C/man7/man-pages.7:367
2493 #: build/C/man7/man-pages.7:371
2495 "lists limitations, known defects or inconveniences, and other questionable "
2500 #: build/C/man7/man-pages.7:371
2506 #: build/C/man7/man-pages.7:377
2508 "provides one or more examples describing how this function, file or command "
2509 "is used. For details on writing example programs, see I<Example Programs> "
2514 #: build/C/man7/man-pages.7:377
2520 #: build/C/man7/man-pages.7:387
2522 "lists authors of the documentation or program. B<Use of an AUTHORS section "
2523 "is strongly discouraged>. Generally, it is better not to clutter every page "
2524 "with a list of (over time potentially numerous) authors; if you write or "
2525 "significantly amend a page, add a copyright notice as a comment in the "
2526 "source file. If you are the author of a device driver and want to include "
2527 "an address for reporting bugs, place this under the BUGS section."
2531 #: build/C/man7/man-pages.7:387
2537 #: build/C/man7/man-pages.7:394
2539 "provides a comma-separated list of related man pages, ordered by section "
2540 "number and then alphabetically by name, possibly followed by other related "
2541 "pages or documents. Do not terminate this with a period."
2545 #: build/C/man7/man-pages.7:394
2547 msgid "Font conventions"
2551 #: build/C/man7/man-pages.7:399
2553 "For functions, the arguments are always specified using italics, I<even in "
2554 "the SYNOPSIS section>, where the rest of the function is specified in bold:"
2558 #: build/C/man7/man-pages.7:401
2559 msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
2563 #: build/C/man7/man-pages.7:403
2564 msgid "Variable names should, like argument names, be specified in italics."
2568 #: build/C/man7/man-pages.7:416
2570 "Filenames (whether pathnames, or references to files in the I</usr/include> "
2571 "directory) are always in italics (e.g., I<E<lt>stdio.hE<gt>>), except in "
2572 "the SYNOPSIS section, where included files are in bold (e.g., B<#include "
2573 "E<lt>stdio.hE<gt>>). When referring to a standard include file under "
2574 "I</usr/include>, specify the header file surrounded by angle brackets, in "
2575 "the usual C way (e.g., I<E<lt>stdio.hE<gt>>)."
2579 #: build/C/man7/man-pages.7:420
2581 "Special macros, which are usually in upper case, are in bold (e.g., "
2582 "B<MAXINT>). Exception: don't boldface NULL."
2586 #: build/C/man7/man-pages.7:425
2588 "When enumerating a list of error codes, the codes are in bold (this list "
2589 "usually uses the B<\\&.TP> macro)."
2593 #: build/C/man7/man-pages.7:428
2595 "Complete commands should, if long, be written as in an indented line on "
2596 "their own, for example"
2600 #: build/C/man7/man-pages.7:432
2602 msgid "man 7 man-pages\n"
2606 #: build/C/man7/man-pages.7:442
2608 "If the command is short, then it can be included inline in the text, in "
2609 "italic format, for example, I<man 7 man-pages>. In this case, it may be "
2610 "worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
2611 "command. Command options should be written in italics, e.g., I<-l>."
2615 #: build/C/man7/man-pages.7:447
2617 "Expressions, if not written on a separate indented line, should be specified "
2618 "in italics. Again, the use of nonbreaking spaces may be appropriate if the "
2619 "expression is inlined with normal text."
2623 #: build/C/man7/man-pages.7:458
2625 "Any reference to the subject of the current manual page should be written "
2626 "with the name in bold. If the subject is a function (i.e., this is a "
2627 "Section 2 or 3 page), then the name should be followed by a pair of "
2628 "parentheses in Roman (normal) font. For example, in the B<fcntl>(2) man "
2629 "page, references to the subject of the page would be written as: "
2630 "B<fcntl>(). The preferred way to write this in the source file is:"
2634 #: build/C/man7/man-pages.7:461
2636 msgid " .BR fcntl ()\n"
2640 #: build/C/man7/man-pages.7:465
2642 "(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
2643 "easier to write tools that parse man page source files.)"
2647 #: build/C/man7/man-pages.7:473
2649 "Any reference to another man page should be written with the name in bold, "
2650 "I<always> followed by the section number, formatted in Roman (normal) font, "
2651 "without any separating spaces (e.g., B<intro>(2)). The preferred way to "
2652 "write this in the source file is:"
2656 #: build/C/man7/man-pages.7:476
2658 msgid " .BR intro (2)\n"
2662 #: build/C/man7/man-pages.7:481
2664 "(Including the section number in cross references lets tools like "
2665 "B<man2html>(1) create properly hyperlinked pages.)"
2669 #: build/C/man7/man-pages.7:481
2675 #: build/C/man7/man-pages.7:486
2677 "Starting with release 2.59, I<man-pages> follows American spelling "
2678 "conventions; please write all new pages and patches according to these "
2683 #: build/C/man7/man-pages.7:486
2685 msgid "Example Programs and Shell Sessions"
2689 #: build/C/man7/man-pages.7:490
2691 "Manual pages can include example programs demonstrating how to use a system "
2692 "call or library function. However, note the following:"
2696 #: build/C/man7/man-pages.7:493
2697 msgid "Example programs should be written in C."
2701 #: build/C/man7/man-pages.7:500
2703 "An example program is only necessary and useful if it demonstrates something "
2704 "beyond what can easily be provided in a textual description of the "
2705 "interface. An example program that does nothing other than call an "
2706 "interface usually serves little purpose."
2710 #: build/C/man7/man-pages.7:504
2712 "Example programs should be fairly short (preferably less than 100 lines; "
2713 "ideally less than 50 lines)."
2717 #: build/C/man7/man-pages.7:508
2719 "Example programs should do error checking after system calls and library "
2724 #: build/C/man7/man-pages.7:512
2726 "Example programs should be complete, and compile without warnings when "
2727 "compiled with I<cc\\ -Wall>."
2731 #: build/C/man7/man-pages.7:518
2733 "Where possible and appropriate, example programs should allow "
2734 "experimentation, by varying their behavior based on inputs (ideally from "
2735 "command-line arguments, or alternatively, via input read by the program)."
2739 #: build/C/man7/man-pages.7:523
2741 "Example programs should be laid out according to Kernighan and Ritchie "
2742 "style, with 4-space indents. (Avoid the use of TAB characters in source "
2747 #: build/C/man7/man-pages.7:528
2749 "For some examples of what example programs should look like, see B<wait>(2) "
2754 #: build/C/man7/man-pages.7:532
2756 "If you include a shell session demonstrating the use of a program or other "
2757 "system feature, boldface the user input text, to distinguish it from output "
2758 "produced by the system."
2762 #: build/C/man7/man-pages.7:532
2764 msgid "Indentation of structure definitions, shell session logs, etc."
2768 #: build/C/man7/man-pages.7:538
2770 "When structure definitions, shell session logs, etc. are included in running "
2771 "text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ +4n> and "
2776 #: build/C/man7/man-pages.7:545
2778 "For canonical examples of how man pages in the I<man-pages> package should "
2779 "look, see B<pipe>(2) and B<fcntl>(2)."
2783 #: build/C/man7/man-pages.7:552
2785 "B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
2790 #: build/C/man7/man.7:32
2796 #: build/C/man7/man.7:32
2802 #: build/C/man7/man.7:35
2803 msgid "man - macros to format man pages"
2807 #: build/C/man7/man.7:39
2808 msgid "B<groff -Tascii -man> I<file> \\&..."
2812 #: build/C/man7/man.7:43
2813 msgid "B<groff -Tps -man> I<file> \\&..."
2817 #: build/C/man7/man.7:60
2819 "This manual page explains the B<groff an.tmac> macro package (often called "
2820 "the B<man> macro package). This macro package should be used by developers "
2821 "when writing or porting man pages for Linux. It is fairly compatible with "
2822 "other versions of this macro package, so porting man pages should not be a "
2823 "major problem (exceptions include the NET-2 BSD release, which uses a "
2824 "totally different macro package called mdoc; see B<mdoc>(7))."
2828 #: build/C/man7/man.7:72
2830 "Note that NET-2 BSD mdoc man pages can be used with B<groff> simply by "
2831 "specifying the B<-mdoc> option instead of the B<-man> option. Using the "
2832 "B<-mandoc> option is, however, recommended, since this will automatically "
2833 "detect which macro package is in use."
2837 #: build/C/man7/man.7:76
2839 "For conventions that should be employed when writing man pages for the Linux "
2840 "I<man-pages> package, see B<man-pages>(7)."
2844 #: build/C/man7/man.7:79
2846 "The first command in a man page (after comment lines, that is, lines that "
2847 "start with B<.\\e\">) should be"
2851 #: build/C/man7/man.7:88
2853 "For details of the arguments that should be supplied to the B<TH> command, "
2854 "see B<man-pages>(7)."
2858 #: build/C/man7/man.7:94
2860 "Note that BSD mdoc-formatted pages begin with the B<Dd> command, not the "
2865 #: build/C/man7/man.7:94
2870 #. The following doesn't seem to be required (see Debian bug 411303),
2871 #. If the name contains spaces and appears
2872 #. on the same line as
2874 #. then place the heading in double quotes.
2876 #: build/C/man7/man.7:103
2877 msgid "Sections are started with B<\\&.SH> followed by the heading name."
2881 #: build/C/man7/man.7:106
2883 "The only mandatory heading is NAME, which should be the first section and be "
2884 "followed on the next line by a one-line description of the program:"
2888 #: build/C/man7/man.7:109
2893 #: build/C/man7/man.7:111
2894 msgid "item \\e- description"
2898 #: build/C/man7/man.7:125
2900 "It is extremely important that this format is followed, and that there is a "
2901 "backslash before the single dash which follows the item name. This syntax "
2902 "is used by the B<mandb>(8) program to create a database of short "
2903 "descriptions for the B<whatis>(1) and B<apropos>(1) commands. (See "
2904 "B<lexgrog>(1) for further details on the syntax of the NAME section.)"
2908 #: build/C/man7/man.7:128
2910 "For a list of other sections that might appear in a manual page, see "
2915 #: build/C/man7/man.7:128
2921 #: build/C/man7/man.7:130
2922 msgid "The commands to select the type face are:"
2926 #: build/C/man7/man.7:130
2932 #: build/C/man7/man.7:133
2937 #: build/C/man7/man.7:133
2943 #: build/C/man7/man.7:137
2945 "Bold alternating with italics (especially useful for function "
2950 #: build/C/man7/man.7:137
2956 #: build/C/man7/man.7:142
2958 "Bold alternating with Roman (especially useful for referring to other manual "
2963 #: build/C/man7/man.7:142
2969 #: build/C/man7/man.7:145
2974 #: build/C/man7/man.7:145
2980 #: build/C/man7/man.7:148
2981 msgid "Italics alternating with bold"
2985 #: build/C/man7/man.7:148
2991 #: build/C/man7/man.7:151
2992 msgid "Italics alternating with Roman"
2996 #: build/C/man7/man.7:151
3002 #: build/C/man7/man.7:154
3003 msgid "Roman alternating with bold"
3007 #: build/C/man7/man.7:154
3013 #: build/C/man7/man.7:157
3014 msgid "Roman alternating with italics"
3018 #: build/C/man7/man.7:157
3024 #: build/C/man7/man.7:160
3025 msgid "Small alternating with bold"
3029 #: build/C/man7/man.7:160
3035 #: build/C/man7/man.7:163
3036 msgid "Small (useful for acronyms)"
3040 #: build/C/man7/man.7:176
3042 "Traditionally, each command can have up to six arguments, but the GNU "
3043 "implementation removes this limitation (you might still want to limit "
3044 "yourself to 6 arguments for portability's sake). Arguments are delimited by "
3045 "spaces. Double quotes can be used to specify an argument which contains "
3046 "spaces. All of the arguments will be printed next to each other without "
3047 "intervening spaces, so that the B<\\&.BR> command can be used to specify a "
3048 "word in bold followed by a mark of punctuation in Roman. If no arguments "
3049 "are given, the command is applied to the following line of text."
3053 #: build/C/man7/man.7:176
3055 msgid "Other Macros and Strings"
3059 #: build/C/man7/man.7:196
3061 "Below are other relevant macros and predefined strings. Unless noted "
3062 "otherwise, all macros cause a break (end the current line of text). Many of "
3063 "these macros set or use the \"prevailing indent.\" The \"prevailing indent\" "
3064 "value is set by any macro with the parameter I<i> below; macros may omit "
3065 "I<i> in which case the current prevailing indent will be used. As a result, "
3066 "successive indented paragraphs can use the same indent without respecifying "
3067 "the indent value. A normal (nonindented) paragraph resets the prevailing "
3068 "indent value to its default value (0.5 inches). By default a given indent "
3069 "is measured in ens; try to use ens or ems as units for indents, since these "
3070 "will automatically adjust to font size changes. The other key macro "
3075 #: build/C/man7/man.7:196
3077 msgid "Normal Paragraphs"
3081 #: build/C/man7/man.7:197
3087 #: build/C/man7/man.7:202 build/C/man7/man.7:207
3088 msgid "Same as B<\\&.PP> (begin a new paragraph)."
3092 #: build/C/man7/man.7:202
3098 #: build/C/man7/man.7:207
3104 #: build/C/man7/man.7:210
3105 msgid "Begin a new paragraph and reset prevailing indent."
3109 #: build/C/man7/man.7:210
3111 msgid "Relative Margin Indent"
3115 #: build/C/man7/man.7:211
3117 msgid "B<\\&.RS>I< i>"
3121 #: build/C/man7/man.7:222
3123 "Start relative margin indent: moves the left margin I<i> to the right (if "
3124 "I<i> is omitted, the prevailing indent value is used). A new prevailing "
3125 "indent is set to 0.5 inches. As a result, all following paragraph(s) will "
3126 "be indented until the corresponding B<\\&.RE>."
3130 #: build/C/man7/man.7:222
3136 #: build/C/man7/man.7:226
3138 "End relative margin indent and restores the previous value of the prevailing "
3143 #: build/C/man7/man.7:226
3145 msgid "Indented Paragraph Macros"
3149 #: build/C/man7/man.7:227
3151 msgid "B<\\&.HP>I< i>"
3155 #: build/C/man7/man.7:232
3157 "Begin paragraph with a hanging indent (the first line of the paragraph is at "
3158 "the left margin of normal paragraphs, and the rest of the paragraph's lines "
3163 #: build/C/man7/man.7:232
3165 msgid "B<\\&.IP>I< x i>"
3169 #: build/C/man7/man.7:253
3171 "Indented paragraph with optional hanging tag. If the tag I<x> is omitted, "
3172 "the entire following paragraph is indented by I<i>. If the tag I<x> is "
3173 "provided, it is hung at the left margin before the following indented "
3174 "paragraph (this is just like B<\\&.TP> except the tag is included with the "
3175 "command instead of being on the following line). If the tag is too long, "
3176 "the text after the tag will be moved down to the next line (text will not be "
3177 "lost or garbled). For bulleted lists, use this macro with \\e(bu (bullet) "
3178 "or \\e(em (em dash) as the tag, and for numbered lists, use the number or "
3179 "letter followed by a period as the tag; this simplifies translation to other "
3184 #: build/C/man7/man.7:253
3186 msgid "B<\\&.TP>I< i>"
3190 #: build/C/man7/man.7:260
3192 "Begin paragraph with hanging tag. The tag is given on the next line, but "
3193 "its results are like those of the B<\\&.IP> command."
3197 #: build/C/man7/man.7:260
3199 msgid "Hypertext Link Macros"
3203 #: build/C/man7/man.7:270
3205 "(Feature supported with B<groff> only.) In order to use hypertext link "
3206 "macros, it is necessary to load the B<www.tmac> macro package. Use the "
3207 "request B<.mso www.tmac> to do this."
3211 #: build/C/man7/man.7:270
3213 msgid "B<\\&.URL>I< url link trailer>"
3216 #. The following is a kludge to get a paragraph into the listing.
3218 #: build/C/man7/man.7:283
3220 "Inserts a hypertext link to the URI (URL) I<url>, with I<link> as the text "
3221 "of the link. The I<trailer> will be printed immediately afterward. When "
3222 "generating HTML this should translate into the HTML command B<E<lt>A "
3223 "HREF=\">I<url>B<\"E<gt>>I<link>B<E<lt>/AE<gt>>I<trailer>B<.>"
3226 #. The following is a kludge to get a paragraph into the listing.
3228 #: build/C/man7/man.7:290
3230 "This and other related macros are new, and many tools won't do anything with "
3231 "them, but since many tools (including troff) will simply ignore undefined "
3232 "macros (or at worst insert their text) these are safe to insert."
3235 #. The following is a kludge to get a paragraph into the listing.
3237 #: build/C/man7/man.7:299
3239 "It can be useful to define your own B<URL> macro in manual pages for the "
3240 "benefit of those viewing it with a roff viewer other than B<groff>. That "
3241 "way, the URL, link text, and trailer text (if any) are still visible."
3245 #: build/C/man7/man.7:302
3246 msgid "Here's an example:"
3250 #: build/C/man7/man.7:304
3255 #: build/C/man7/man.7:306
3256 msgid "\\e\\e$2 \\e(laURL: \\e\\e$1 \\e(ra\\e\\e$3"
3260 #: build/C/man7/man.7:308
3265 #: build/C/man7/man.7:310
3266 msgid "\\&.if \\en[.g] .mso www.tmac"
3270 #: build/C/man7/man.7:313
3271 msgid "\\&.TH I<...>"
3275 #: build/C/man7/man.7:315
3276 msgid "I<(later in the page)>"
3280 #: build/C/man7/man.7:317
3281 msgid "This software comes from the"
3285 #: build/C/man7/man.7:319
3286 msgid "\\&.URL \"http://www.gnu.org/\" \"GNU Project\" \" of the\""
3290 #: build/C/man7/man.7:321
3291 msgid "\\&.URL \"http://www.fsf.org/\" \"Free Software Foundation\" ."
3295 #: build/C/man7/man.7:331
3297 "In the above, if B<groff> is being used, the B<www.tmac> macro package's "
3298 "definition of the URL macro will supersede the locally defined one."
3302 #: build/C/man7/man.7:336
3304 "A number of other link macros are available. See B<groff_www>(7) for more "
3309 #: build/C/man7/man.7:336
3311 msgid "Miscellaneous Macros"
3315 #: build/C/man7/man.7:337
3321 #: build/C/man7/man.7:341
3322 msgid "Reset tabs to default tab values (every 0.5 inches); does not cause a break."
3326 #: build/C/man7/man.7:341
3328 msgid "B<\\&.PD>I< d>"
3332 #: build/C/man7/man.7:346
3334 "Set inter-paragraph vertical distance to d (if omitted, d=0.4v); does not "
3339 #: build/C/man7/man.7:346
3341 msgid "B<\\&.SS>I< t>"
3345 #: build/C/man7/man.7:353
3347 "Subheading I<t> (like B<\\&.SH>, but used for a subsection inside a "
3352 #: build/C/man7/man.7:353
3354 msgid "Predefined Strings"
3358 #: build/C/man7/man.7:357
3359 msgid "The B<man> package has the following predefined strings:"
3363 #: build/C/man7/man.7:357
3369 #: build/C/man7/man.7:359
3370 msgid "Registration Symbol: \\*R"
3374 #: build/C/man7/man.7:359
3380 #: build/C/man7/man.7:361
3381 msgid "Change to default font size"
3385 #: build/C/man7/man.7:361
3391 #: build/C/man7/man.7:363
3392 msgid "Trademark Symbol: \\*(Tm"
3396 #: build/C/man7/man.7:363
3402 #: build/C/man7/man.7:365
3403 msgid "Left angled double quote: ``"
3407 #: build/C/man7/man.7:365
3413 #: build/C/man7/man.7:367
3414 msgid "Right angled double quote: ''"
3418 #: build/C/man7/man.7:367
3424 #: build/C/man7/man.7:411
3426 "Although technically B<man> is a troff macro package, in reality a large "
3427 "number of other tools process man page files that don't implement all of "
3428 "troff's abilities. Thus, it's best to avoid some of troff's more exotic "
3429 "abilities where possible to permit these other tools to work correctly. "
3430 "Avoid using the various troff preprocessors (if you must, go ahead and use "
3431 "B<tbl>(1), but try to use the B<IP> and B<TP> commands instead for "
3432 "two-column tables). Avoid using computations; most other tools can't "
3433 "process them. Use simple commands that are easy to translate to other "
3434 "formats. The following troff macros are believed to be safe (though in many "
3435 "cases they will be ignored by translators): B<\\e\">, B<.>, B<ad>, B<bp>, "
3436 "B<br>, B<ce>, B<de>, B<ds>, B<el>, B<ie>, B<if>, B<fi>, B<ft>, B<hy>, B<ig>, "
3437 "B<in>, B<na>, B<ne>, B<nf>, B<nh>, B<ps>, B<so>, B<sp>, B<ti>, B<tr>."
3441 #: build/C/man7/man.7:434
3443 "You may also use many troff escape sequences (those sequences beginning with "
3444 "\\e). When you need to include the backslash character as normal text, use "
3445 "\\ee. Other sequences you may use, where x or xx are any characters and N "
3446 "is any digit, include: B<\\e'>, B<\\e`>, B<\\e->, B<\\e.>, B<\\e\">, "
3447 "B<\\e%>, B<\\e*x>, B<\\e*(xx>, B<\\e(xx>, B<\\e$N>, B<\\enx>, B<\\en(xx>, "
3448 "B<\\efx>, and B<\\ef(xx>. Avoid using the escape sequences for drawing "
3453 #: build/C/man7/man.7:465
3455 "Do not use the optional parameter for B<bp> (break page). Use only positive "
3456 "values for B<sp> (vertical space). Don't define a macro (B<de>) with the "
3457 "same name as a macro in this or the mdoc macro package with a different "
3458 "meaning; it's likely that such redefinitions will be ignored. Every "
3459 "positive indent (B<in>) should be paired with a matching negative indent "
3460 "(although you should be using the B<RS> and B<RE> macros instead). The "
3461 "condition test (B<if,ie>) should only have \\(aqt\\(aq or \\(aqn\\(aq as "
3462 "the condition. Only translations (B<tr>) that can be ignored should be "
3463 "used. Font changes (B<ft> and the B<\\ef> escape sequence) should only "
3464 "have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have "
3469 #: build/C/man7/man.7:472
3471 "If you use capabilities beyond these, check the results carefully on several "
3472 "tools. Once you've confirmed that the additional capability is safe, let "
3473 "the maintainer of this document know about the safe command or sequence that "
3474 "should be added to this list."
3478 #: build/C/man7/man.7:474
3479 msgid "I</usr/share/groff/>[*/]I<tmac/an.tmac>"
3483 #: build/C/man7/man.7:476
3484 msgid "I</usr/man/whatis>"
3488 #: build/C/man7/man.7:488
3490 "By all means include full URLs (or URIs) in the text itself; some tools such "
3491 "as B<man2html>(1) can automatically turn them into hypertext links. You "
3492 "can also use the new B<URL> macro to identify links to related information. "
3493 "If you include URLs, use the full URL (e.g., "
3494 "E<lt>http://www.kernelnotes.orgE<gt>) to ensure that tools can automatically "
3499 #: build/C/man7/man.7:497
3501 "Tools processing these files should open the file and examine the first "
3502 "nonwhitespace character. A period (.) or single quote (') at the beginning "
3503 "of a line indicates a troff-based file (such as man or mdoc). A left angle "
3504 "bracket (E<lt>) indicates an SGML/XML-based file (such as HTML or Docbook). "
3505 "Anything else suggests simple ASCII text (e.g., a \"catman\" result)."
3509 #: build/C/man7/man.7:508
3511 "Many man pages begin with B<\\'\\e\"> followed by a space and a list of "
3512 "characters, indicating how the page is to be preprocessed. For "
3513 "portability's sake to non-troff translators we recommend that you avoid "
3514 "using anything other than B<tbl>(1), and Linux can detect that "
3515 "automatically. However, you might want to include this information so your "
3516 "man page can be handled by other (less capable) systems. Here are the "
3517 "definitions of the preprocessors invoked by these characters:"
3521 #: build/C/man7/man.7:508
3527 #: build/C/man7/man.7:511
3532 #: build/C/man7/man.7:511
3538 #: build/C/man7/man.7:514
3543 #: build/C/man7/man.7:514
3549 #: build/C/man7/man.7:517
3554 #: build/C/man7/man.7:517
3560 #: build/C/man7/man.7:520
3565 #: build/C/man7/man.7:520
3571 #: build/C/man7/man.7:523
3576 #: build/C/man7/man.7:523
3582 #: build/C/man7/man.7:526
3587 #: build/C/man7/man.7:526 build/C/man7/suffixes.7:277
3593 #: build/C/man7/man.7:539
3595 "Most of the macros describe formatting (e.g., font type and spacing) instead "
3596 "of marking semantic content (e.g., this text is a reference to another "
3597 "page), compared to formats like mdoc and DocBook (even HTML has more "
3598 "semantic markings). This situation makes it harder to vary the B<man> "
3599 "format for different media, to make the formatting consistent for a given "
3600 "media, and to automatically insert cross-references. By sticking to the "
3601 "safe subset described above, it should be easier to automate transitioning "
3602 "to a different reference page format in the future."
3607 #. James Clark (jjc@jclark.com) wrote the implementation of the macro package.
3609 #. Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of
3610 #. this manual page.
3612 #. Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO
3613 #. (which influenced this manual page).
3615 #. David A. Wheeler (dwheeler@ida.org) heavily modified this
3616 #. manual page, such as adding detailed information on sections and macros.
3618 #: build/C/man7/man.7:555
3619 msgid "The Sun macro B<TX> is not implemented."
3623 #: build/C/man7/man.7:567
3625 "B<apropos>(1), B<groff>(1), B<lexgrog>(1), B<man>(1), B<man2html>(1), "
3626 "B<whatis>(1), B<groff_man>(7), B<groff_www>(7), B<man-pages>(7), B<mdoc>(7), "
3627 "B<mdoc.samples>(7)"
3631 #: build/C/man7/mdoc.7:40
3633 msgid "July 11, 1999"
3637 #: build/C/man7/mdoc.7:41
3643 #: build/C/man7/mdoc.7:45
3648 #: build/C/man7/mdoc.7:45
3650 msgid "quick reference guide for the"
3654 #: build/C/man7/mdoc.7:48
3655 msgid "E<.Nm \\-mdoc> macro package"
3659 #: build/C/man7/mdoc.7:52
3660 msgid "E<.Nm groff> E<.Fl m Ns Ar doc> E<.Ar files ...>"
3664 #: build/C/man7/mdoc.7:64
3666 "The E<.Nm \\-mdoc> package is a set of content-based and domain-based macros "
3667 "used to format the E<.Bx> man pages. The macro names and their meanings are "
3668 "listed below for quick reference; for a detailed explanation on using the "
3669 "package, see the tutorial sampler E<.Xr mdoc.samples 7>."
3673 #: build/C/man7/mdoc.7:69
3675 "Note that this is not the usual macro package for Linux documentation, "
3676 "although it is used for documentation of several widely used programs; see "
3681 #: build/C/man7/mdoc.7:78
3683 "The macros are described in two groups, the first includes the structural "
3684 "and physical page layout macros. The second contains the manual and general "
3685 "text domain macros which differentiate the E<.Nm \\-mdoc> package from other "
3686 "E<.Xr troff> formatting packages."
3690 #: build/C/man7/mdoc.7:78
3692 msgid "PAGE STRUCTURE DOMAIN"
3696 #: build/C/man7/mdoc.7:79
3698 msgid "Title Macros"
3702 #: build/C/man7/mdoc.7:82
3704 "To create a valid manual page, these three macros, in this order, are "
3709 #: build/C/man7/mdoc.7:83
3711 msgid "Li \"\\&.Dd \" Ar \"Month day, year\""
3715 #: build/C/man7/mdoc.7:85
3716 msgid "Document date."
3720 #: build/C/man7/mdoc.7:85
3722 msgid "Li \"\\&.Dt \" Ar \"DOCUMENT_TITLE [section] [volume]\""
3726 #: build/C/man7/mdoc.7:87
3727 msgid "Title, in upper case."
3731 #: build/C/man7/mdoc.7:87
3733 msgid "Li \"\\&.Os \" Ar \"OPERATING_SYSTEM [version/release]\""
3737 #: build/C/man7/mdoc.7:90
3738 msgid "Operating system E<.Pq Tn BSD>."
3742 #: build/C/man7/mdoc.7:91
3744 msgid "Page Layout Macros"
3748 #: build/C/man7/mdoc.7:93
3749 msgid "Section headers, paragraph breaks, lists and displays."
3753 #: build/C/man7/mdoc.7:94
3759 #: build/C/man7/mdoc.7:97
3760 msgid "Section Headers. Valid headers, in the order of presentation:"
3764 #: build/C/man7/mdoc.7:98
3770 #: build/C/man7/mdoc.7:106
3772 "Name section, should include the E<.Ql \\&.Nm> or E<.Ql \\&.Fn> and the "
3773 "E<.Ql \\&.Nd> macros."
3777 #: build/C/man7/mdoc.7:106
3783 #: build/C/man7/mdoc.7:108
3788 #: build/C/man7/mdoc.7:108
3790 msgid "Ar DESCRIPTION"
3794 #: build/C/man7/mdoc.7:111
3795 msgid "General description, should include options and parameters."
3799 #: build/C/man7/mdoc.7:111
3801 msgid "Ar RETURN VALUE"
3805 #: build/C/man7/mdoc.7:113
3806 msgid "Sections two and three function calls."
3810 #: build/C/man7/mdoc.7:113
3812 msgid "Ar ENVIRONMENT"
3816 #: build/C/man7/mdoc.7:115
3817 msgid "Describe environment variables."
3821 #: build/C/man7/mdoc.7:115
3827 #: build/C/man7/mdoc.7:117
3828 msgid "Files associated with the subject."
3832 #: build/C/man7/mdoc.7:117
3838 #: build/C/man7/mdoc.7:119
3839 msgid "Examples and suggestions."
3843 #: build/C/man7/mdoc.7:119
3845 msgid "Ar DIAGNOSTICS"
3849 #: build/C/man7/mdoc.7:121
3850 msgid "Normally used for section four device interface diagnostics."
3854 #: build/C/man7/mdoc.7:121
3860 #: build/C/man7/mdoc.7:124
3861 msgid "Sections two and three error and signal handling."
3865 #: build/C/man7/mdoc.7:124
3871 #: build/C/man7/mdoc.7:126
3872 msgid "Cross references and citations."
3876 #: build/C/man7/mdoc.7:126
3878 msgid "Ar CONFORMING TO"
3882 #: build/C/man7/mdoc.7:128
3883 msgid "Conformance to standards if applicable."
3887 #: build/C/man7/mdoc.7:128
3893 #: build/C/man7/mdoc.7:131
3894 msgid "If a standard is not applicable, the history of the subject should be given."
3898 #: build/C/man7/mdoc.7:131
3904 #: build/C/man7/mdoc.7:133
3905 msgid "Gotchas and caveats."
3909 #: build/C/man7/mdoc.7:133
3915 #: build/C/man7/mdoc.7:136
3916 msgid "Customized headers may be added at the authors discretion."
3920 #: build/C/man7/mdoc.7:137
3926 #: build/C/man7/mdoc.7:139
3927 msgid "Subsection Headers."
3931 #: build/C/man7/mdoc.7:139
3937 #: build/C/man7/mdoc.7:142
3938 msgid "Paragraph Break. Vertical space (one line)."
3942 #: build/C/man7/mdoc.7:142
3948 #: build/C/man7/mdoc.7:145
3949 msgid "(D-one) Display-one Indent and display one text line."
3953 #: build/C/man7/mdoc.7:145
3959 #: build/C/man7/mdoc.7:148
3960 msgid "(D-ell) Display-one literal. Indent and display one line of literal text."
3964 #: build/C/man7/mdoc.7:148
3970 #: build/C/man7/mdoc.7:151
3971 msgid "Begin-display block. Display options:"
3975 #: build/C/man7/mdoc.7:152
3981 #: build/C/man7/mdoc.7:154
3982 msgid "Unjustified (ragged edges)."
3986 #: build/C/man7/mdoc.7:154
3992 #: build/C/man7/mdoc.7:156
3997 #: build/C/man7/mdoc.7:156
4003 #: build/C/man7/mdoc.7:158
4004 msgid "Literal text or code."
4008 #: build/C/man7/mdoc.7:158
4010 msgid "Fl file Ar name"
4014 #: build/C/man7/mdoc.7:162
4015 msgid "Read in named E<.Ar file> and display."
4019 #: build/C/man7/mdoc.7:162
4021 msgid "Fl offset Ar string"
4025 #: build/C/man7/mdoc.7:167
4026 msgid "Offset display. Acceptable E<.Ar string> values:"
4030 #: build/C/man7/mdoc.7:168
4036 #: build/C/man7/mdoc.7:170
4037 msgid "Align block on left (default)."
4041 #: build/C/man7/mdoc.7:170
4047 #: build/C/man7/mdoc.7:172
4048 msgid "Approximate center margin."
4052 #: build/C/man7/mdoc.7:172
4058 #: build/C/man7/mdoc.7:174
4059 msgid "Six constant width spaces (a tab)."
4063 #: build/C/man7/mdoc.7:174
4065 msgid "Ar indent-two"
4069 #: build/C/man7/mdoc.7:176
4074 #: build/C/man7/mdoc.7:176
4080 #: build/C/man7/mdoc.7:179
4081 msgid "Left aligns block 2 inches from right."
4085 #: build/C/man7/mdoc.7:179
4087 msgid "Ar xx Ns Cm n"
4091 #: build/C/man7/mdoc.7:186
4093 "Where E<.Ar xx> is a number from E<.No \\&4 Ns Cm n> to E<.No \\&9\\&9 Ns Cm "
4098 #: build/C/man7/mdoc.7:186
4104 #: build/C/man7/mdoc.7:190
4105 msgid "Where E<.Ar Aa> is a callable macro name."
4109 #: build/C/man7/mdoc.7:190
4115 #: build/C/man7/mdoc.7:194
4116 msgid "The width of E<.Ar string> is used."
4120 #: build/C/man7/mdoc.7:196
4126 #: build/C/man7/mdoc.7:198
4127 msgid "End-display (matches \\&.Bd)."
4131 #: build/C/man7/mdoc.7:198
4137 #: build/C/man7/mdoc.7:202
4138 msgid "Begin-list. Create lists or columns. Options:"
4142 #: build/C/man7/mdoc.7:203
4144 msgid "Ar List-types"
4148 #: build/C/man7/mdoc.7:205
4150 msgid "Fl bullet Ta \"Bullet Item List\""
4154 #: build/C/man7/mdoc.7:206
4156 msgid "Fl item Ta \"Unlabeled List\""
4160 #: build/C/man7/mdoc.7:207
4162 msgid "Fl enum Ta \"Enumerated List\""
4166 #: build/C/man7/mdoc.7:208
4168 msgid "Fl tag Ta \"Tag Labeled List\""
4172 #: build/C/man7/mdoc.7:209
4174 msgid "Fl diag Ta \"Diagnostic List\""
4178 #: build/C/man7/mdoc.7:210
4180 msgid "Fl hang Ta \"Hanging Labeled List\""
4184 #: build/C/man7/mdoc.7:211
4186 msgid "Fl ohang Ta \"Overhanging Labeled List\""
4190 #: build/C/man7/mdoc.7:212
4192 msgid "Fl inset Ta \"Inset or Run-on Labeled List\""
4196 #: build/C/man7/mdoc.7:214
4198 msgid "List-parameters"
4202 #: build/C/man7/mdoc.7:216
4208 #: build/C/man7/mdoc.7:220
4209 msgid "(All lists.) See E<.Ql \\&.Bd> begin-display above."
4213 #: build/C/man7/mdoc.7:220
4219 #: build/C/man7/mdoc.7:227
4220 msgid "E<.Pf ( Fl tag> and E<.Fl hang> lists only.) See E<.Ql \\&.Bd>."
4224 #: build/C/man7/mdoc.7:227
4230 #: build/C/man7/mdoc.7:230
4231 msgid "(All lists.) Suppresses blank lines."
4235 #: build/C/man7/mdoc.7:232
4241 #: build/C/man7/mdoc.7:234
4246 #: build/C/man7/mdoc.7:234
4252 #: build/C/man7/mdoc.7:236
4257 #: build/C/man7/mdoc.7:237
4259 msgid "MANUAL AND GENERAL TEXT DOMAIN MACROS"
4263 #: build/C/man7/mdoc.7:241
4265 "The manual and general text domain macros are special in that most of them "
4266 "are parsed for callable macros for example:"
4270 #: build/C/man7/mdoc.7:242
4272 msgid "Li \"\\&.Op Fl s Ar file\""
4276 #: build/C/man7/mdoc.7:245
4277 msgid "Produces E<.Op Fl s Ar file>"
4281 #: build/C/man7/mdoc.7:263
4283 "In this example, the option enclosure macro E<.Ql \\&.Op> is parsed, and "
4284 "calls the callable content macro E<.Ql \\&Fl> which operates on the argument "
4285 "E<.Ql s> and then calls the callable content macro E<.Ql \\&Ar> which "
4286 "operates on the argument E<.Ql file>. Some macros may be callable, but are "
4287 "not parsed and vice versa. These macros are indicated in the E<.Em parsed> "
4288 "and E<.Em callable> columns below."
4292 #: build/C/man7/mdoc.7:265
4293 msgid "Unless stated, manual domain macros share a common syntax:"
4297 #: build/C/man7/mdoc.7:266
4299 msgid "\\&.Va argument [\\ .\\ ,\\ ;\\ :\\ (\\ )\\ [\\ ]\\ argument ...\\ ]"
4303 #: build/C/man7/mdoc.7:286
4305 "E<.Sy Note>: Opening and closing punctuation characters are only recognized "
4306 "as such if they are presented one at a time. The string E<.Ql \"),\"> is "
4307 "not recognized as punctuation and will be output with a leading white space "
4308 "and in what ever font the calling macro uses. The argument list E<.Ql \"] ) "
4309 ",\"> is recognized as three sequential closing punctuation characters and a "
4310 "leading white space is not output between the characters and the previous "
4311 "argument (if any). The special meaning of a punctuation character may be "
4312 "escaped with the string E<.Ql \\e&>. For example the following string,"
4316 #: build/C/man7/mdoc.7:287
4318 msgid "Li \"\\&.Ar file1\\ , file2\\ , file3\\ )\\ .\""
4322 #: build/C/man7/mdoc.7:290
4323 msgid "Produces E<.Ar file1 , file2 , file3>)."
4327 #: build/C/man7/mdoc.7:292
4329 msgid "Manual Domain Macros"
4333 #: build/C/man7/mdoc.7:294 build/C/man7/mdoc.7:319
4335 msgid "Em \"Name\tParsed\tCallable\tDescription\""
4339 #: build/C/man7/mdoc.7:295
4341 msgid "Li \\&Ad Ta Yes Ta Yes Ta \"Address. (This macro may be deprecated.)\""
4345 #: build/C/man7/mdoc.7:296
4347 msgid "Li \\&An Ta Yes Ta Yes Ta \"Author name.\""
4351 #: build/C/man7/mdoc.7:297
4353 msgid "Li \\&Ar Ta Yes Ta Yes Ta \"Command-line argument.\""
4357 #: build/C/man7/mdoc.7:298
4360 "Li \\&Cd Ta \\&No Ta \\&No Ta \"Configuration declaration (section four "
4365 #: build/C/man7/mdoc.7:299
4367 msgid "Li \\&Cm Ta Yes Ta Yes Ta \"Command-line argument modifier.\""
4371 #: build/C/man7/mdoc.7:300
4373 msgid "Li \\&Dv Ta Yes Ta Yes Ta \"Defined variable (source code).\""
4377 #: build/C/man7/mdoc.7:301
4379 msgid "Li \\&Er Ta Yes Ta Yes Ta \"Error number (source code).\""
4383 #: build/C/man7/mdoc.7:302
4385 msgid "Li \\&Ev Ta Yes Ta Yes Ta \"Environment variable.\""
4389 #: build/C/man7/mdoc.7:303
4391 msgid "Li \\&Fa Ta Yes Ta Yes Ta \"Function argument.\""
4395 #: build/C/man7/mdoc.7:304
4397 msgid "Li \\&Fd Ta Yes Ta Yes Ta \"Function declaration.\""
4401 #: build/C/man7/mdoc.7:305
4403 msgid "Li \\&Fn Ta Yes Ta Yes Ta \"Function call (also .Fo and .Fc).\""
4407 #: build/C/man7/mdoc.7:306
4409 msgid "Li \\&Ic Ta Yes Ta Yes Ta \"Interactive command.\""
4413 #: build/C/man7/mdoc.7:307
4415 msgid "Li \\&Li Ta Yes Ta Yes Ta \"Literal text.\""
4419 #: build/C/man7/mdoc.7:308
4421 msgid "Li \\&Nm Ta Yes Ta Yes Ta \"Command name.\""
4425 #: build/C/man7/mdoc.7:309
4427 msgid "Li \\&Op Ta Yes Ta Yes Ta \"Option (also .Oo and .Oc).\""
4431 #: build/C/man7/mdoc.7:310
4433 msgid "Li \\&Ot Ta Yes Ta Yes Ta \"Old style function type (Fortran only).\""
4437 #: build/C/man7/mdoc.7:311
4439 msgid "Li \\&Pa Ta Yes Ta Yes Ta \"Pathname or filename.\""
4443 #: build/C/man7/mdoc.7:312
4445 msgid "Li \\&St Ta Yes Ta Yes Ta \"Standards (\\-p1003.2, \\-p1003.1 or \\-ansiC)\""
4449 #: build/C/man7/mdoc.7:313
4451 msgid "Li \\&Va Ta Yes Ta Yes Ta \"Variable name.\""
4455 #: build/C/man7/mdoc.7:314
4457 msgid "Li \\&Vt Ta Yes Ta Yes Ta \"Variable type (Fortran only).\""
4461 #: build/C/man7/mdoc.7:315
4463 msgid "Li \\&Xr Ta Yes Ta Yes Ta \"Manual Page Cross Reference.\""
4467 #: build/C/man7/mdoc.7:317
4469 msgid "General Text Domain Macros"
4473 #: build/C/man7/mdoc.7:320
4475 msgid "Li \\&%A Ta Yes Ta \\&No Ta \"Reference author.\""
4479 #: build/C/man7/mdoc.7:321
4481 msgid "Li \\&%B Ta Yes Ta Yes Ta \"Reference book title.\""
4485 #: build/C/man7/mdoc.7:322
4487 msgid "Li \\&%\\&C Ta \\&No Ta \\&No Ta \"Reference place of publishing (city).\""
4491 #: build/C/man7/mdoc.7:323
4493 msgid "Li \\&%\\&D Ta \\&No Ta \\&No Ta \"Reference date.\""
4497 #: build/C/man7/mdoc.7:324
4499 msgid "Li \\&%J Ta Yes Ta Yes Ta \"Reference journal title.\""
4503 #: build/C/man7/mdoc.7:325
4505 msgid "Li \\&%N Ta \\&No Ta \\&No Ta \"Reference issue number.\""
4509 #: build/C/man7/mdoc.7:326
4511 msgid "Li \\&%\\&O Ta \\&No Ta \\&No Ta \"Reference optional information.\""
4515 #: build/C/man7/mdoc.7:327
4517 msgid "Li \\&%P Ta \\&No Ta \\&No Ta \"Reference page number(s).\""
4521 #: build/C/man7/mdoc.7:328
4523 msgid "Li \\&%R Ta \\&No Ta \\&No Ta \"Reference report Name.\""
4527 #: build/C/man7/mdoc.7:329
4529 msgid "Li \\&%T Ta Yes Ta Yes Ta \"Reference article title.\""
4533 #: build/C/man7/mdoc.7:330
4535 msgid "Li \\&%V Ta \\&No Ta \\&No Ta \"Reference volume.\""
4539 #: build/C/man7/mdoc.7:331
4541 msgid "Li \\&Ac Ta Yes Ta Yes Ta \"Angle close quote.\""
4545 #: build/C/man7/mdoc.7:332
4547 msgid "Li \\&Ao Ta Yes Ta Yes Ta \"Angle open quote.\""
4551 #: build/C/man7/mdoc.7:333
4553 msgid "Li \\&Ap Ta Yes Ta Yes Ta Apostrophe."
4557 #: build/C/man7/mdoc.7:334
4559 msgid "Li \\&Aq Ta Yes Ta Yes Ta \"Angle quote.\""
4563 #: build/C/man7/mdoc.7:335
4565 msgid "Li \\&At Ta \\&No Ta \\&No Ta Tn \"AT&T UNIX\""
4569 #: build/C/man7/mdoc.7:336
4571 msgid "Li \\&Bc Ta Yes Ta Yes Ta \"Bracket close quote.\""
4575 #: build/C/man7/mdoc.7:337
4577 msgid "Li \\&Bf Ta \\&No Ta \\&No Ta \"Begin font mode.\""
4581 #: build/C/man7/mdoc.7:338
4583 msgid "Li \\&Bo Ta Yes Ta Yes Ta \"Bracket open quote.\""
4587 #: build/C/man7/mdoc.7:339
4589 msgid "Li \\&Bq Ta Yes Ta Yes Ta \"Bracket quote.\""
4593 #: build/C/man7/mdoc.7:340
4595 msgid "Li \\&Bx Ta Yes Ta Yes Ta Bx ."
4599 #: build/C/man7/mdoc.7:341
4601 msgid "Li \\&Db Ta \\&No Ta \\&No Ta \"Debug (default is \\*qoff\\*q)\""
4605 #: build/C/man7/mdoc.7:342
4607 msgid "Li \\&Dc Ta Yes Ta Yes Ta \"Double close quote.\""
4611 #: build/C/man7/mdoc.7:343
4613 msgid "Li \\&Do Ta Yes Ta Yes Ta \"Double open quote.\""
4617 #: build/C/man7/mdoc.7:344
4619 msgid "Li \\&Dq Ta Yes Ta Yes Ta \"Double quote.\""
4623 #: build/C/man7/mdoc.7:345
4625 msgid "Li \\&Ec Ta Yes Ta Yes Ta \"Enclose string close quote.\""
4629 #: build/C/man7/mdoc.7:346
4631 msgid "Li \\&Ef Ta \\&No Ta \\&No Ta \"End font mode.\""
4635 #: build/C/man7/mdoc.7:347
4637 msgid "Li \\&Em Ta Yes Ta Yes Ta \"Emphasis (traditional English).\""
4641 #: build/C/man7/mdoc.7:348
4643 msgid "Li \\&Eo Ta Yes Ta Yes Ta \"Enclose string open quote.\""
4647 #: build/C/man7/mdoc.7:349
4649 msgid "Li \\&Fx Ta \\&No Ta \\&No Ta Tn \"FreeBSD operating system\""
4653 #: build/C/man7/mdoc.7:350
4655 msgid "Li \\&No Ta Yes Ta Yes Ta \"Normal text (no-op).\""
4659 #: build/C/man7/mdoc.7:351
4661 msgid "Li \\&Ns Ta Yes Ta Yes Ta \"No space.\""
4665 #: build/C/man7/mdoc.7:352
4667 msgid "Li \\&Pc Ta Yes Ta Yes Ta \"Parenthesis close quote.\""
4671 #: build/C/man7/mdoc.7:353
4673 msgid "Li \\&Pf Ta Yes Ta \\&No Ta \"Prefix string.\""
4677 #: build/C/man7/mdoc.7:354
4679 msgid "Li \\&Po Ta Yes Ta Yes Ta \"Parenthesis open quote.\""
4683 #: build/C/man7/mdoc.7:355
4685 msgid "Li \\&Pq Ta Yes Ta Yes Ta \"Parentheses quote.\""
4689 #: build/C/man7/mdoc.7:356
4691 msgid "Li \\&Qc Ta Yes Ta Yes Ta \"Straight Double close quote.\""
4695 #: build/C/man7/mdoc.7:357
4697 msgid "Li \\&Ql Ta Yes Ta Yes Ta \"Quoted literal.\""
4701 #: build/C/man7/mdoc.7:358
4703 msgid "Li \\&Qo Ta Yes Ta Yes Ta \"Straight Double open quote.\""
4707 #: build/C/man7/mdoc.7:359
4709 msgid "Li \\&Qq Ta Yes Ta Yes Ta \"Straight Double quote.\""
4713 #: build/C/man7/mdoc.7:360
4715 msgid "Li \\&Re Ta \\&No Ta \\&No Ta \"Reference end.\""
4719 #: build/C/man7/mdoc.7:361
4721 msgid "Li \\&Rs Ta \\&No Ta \\&No Ta \"Reference start.\""
4725 #: build/C/man7/mdoc.7:362
4728 "Li \\&Rv Ta \\&No Ta \\&No Ta \"Return values (sections two and three "
4733 #: build/C/man7/mdoc.7:363
4735 msgid "Li \\&Sc Ta Yes Ta Yes Ta \"Single close quote.\""
4739 #: build/C/man7/mdoc.7:364
4741 msgid "Li \\&So Ta Yes Ta Yes Ta \"Single open quote.\""
4745 #: build/C/man7/mdoc.7:365
4747 msgid "Li \\&Sq Ta Yes Ta Yes Ta \"Single quote.\""
4751 #: build/C/man7/mdoc.7:366
4753 msgid "Li \\&Sm Ta \\&No Ta \\&No Ta \"Space mode (default is \\*qon\\*q)\""
4757 #: build/C/man7/mdoc.7:367
4759 msgid "Li \\&Sx Ta Yes Ta Yes Ta \"Section Cross Reference.\""
4763 #: build/C/man7/mdoc.7:368
4765 msgid "Li \\&Sy Ta Yes Ta Yes Ta \"Symbolic (traditional English).\""
4769 #: build/C/man7/mdoc.7:369
4771 msgid "Li \\&Tn Ta Yes Ta Yes Ta \"Trade or type name (small Caps).\""
4775 #: build/C/man7/mdoc.7:370
4777 msgid "Li \\&Ux Ta Yes Ta Yes Ta Ux"
4781 #: build/C/man7/mdoc.7:371
4783 msgid "Li \\&Xc Ta Yes Ta Yes Ta \"Extend argument list close.\""
4787 #: build/C/man7/mdoc.7:372
4789 msgid "Li \\&Xo Ta Yes Ta Yes Ta \"Extend argument list open.\""
4793 #: build/C/man7/mdoc.7:386
4795 "Macro names ending in E<.Ql q> quote remaining items on the argument list. "
4796 "Macro names ending in E<.Ql o> begin a quote which may span more than one "
4797 "line of input and are close quoted with the matching macro name ending in "
4798 "E<.Ql c>. Enclosure macros may be nested and are limited to eight "
4803 #: build/C/man7/mdoc.7:398
4805 "Note: the extended argument list macros E<.Pf ( Ql \\&.Xo>, E<.Ql \\&.Xc>) "
4806 "and the function enclosure macros E<.Pf ( Ql \\&.Fo>, E<.Ql \\&.Fc>) are "
4807 "irregular. The extended list macros are used when the number of macro "
4808 "arguments would exceed the E<.Xr troff> limitation of nine arguments."
4811 #. The following does not apply on Linux:
4812 #. .Sh CONFIGURATION
4813 #. For site specific configuration of the macro package,
4815 #. .Pa /usr/src/share/tmac/README .
4817 #: build/C/man7/mdoc.7:409
4819 "The macros UR (starting a URI/URL hypertext reference), UE (ending one), and "
4820 "UN (identifying a target for a reference) are also available. See E<.Xr man "
4821 "7> for more information on these macros."
4825 #: build/C/man7/mdoc.7:411
4831 #: build/C/man7/mdoc.7:413
4832 msgid "Manual and general text domain macros."
4836 #: build/C/man7/mdoc.7:413
4838 msgid "Pa tmac/doc-common"
4842 #: build/C/man7/mdoc.7:415
4843 msgid "Common structural macros and definitions."
4847 #: build/C/man7/mdoc.7:415
4849 msgid "Pa tmac/doc-nroff"
4853 #: build/C/man7/mdoc.7:419
4854 msgid "Site dependent E<.Xr nroff> style file."
4858 #: build/C/man7/mdoc.7:419
4860 msgid "Pa tmac/doc-ditroff"
4864 #: build/C/man7/mdoc.7:423
4865 msgid "Site dependent E<.Xr troff> style file."
4869 #: build/C/man7/mdoc.7:423
4871 msgid "Pa tmac/doc-syms"
4875 #: build/C/man7/mdoc.7:425
4876 msgid "Special defines (such as the standards macro)."
4880 #: build/C/man7/mdoc.7:431
4881 msgid "E<.Xr groff_mdoc 7>, E<.Xr mdoc.samples 7>, E<.Xr man 7>, E<.Xr man-pages 7>"
4885 #: build/C/man7/mdoc.7:438
4887 "This page is part of release 3.37 of the Linux E<.Em man-pages> project. A "
4888 "description of the project, and information about reporting bugs, can be "
4889 "found at http://www.kernel.org/doc/man-pages/."
4893 #: build/C/man7/operator.7:38
4899 #: build/C/man7/operator.7:38
4905 #: build/C/man7/operator.7:41
4906 msgid "operator - C operator precedence and order of evaluation"
4910 #: build/C/man7/operator.7:43
4911 msgid "This manual page lists C operators and their precedence in evaluation."
4915 #: build/C/man7/operator.7:61
4918 "B<Operator Associativity>\n"
4919 "() [] -E<gt> . left to right\n"
4920 "! ~ ++ -- + - (type) * & sizeof right to left\n"
4921 "* / % left to right\n"
4922 "+ - left to right\n"
4923 "E<lt>E<lt> E<gt>E<gt> left to right\n"
4924 "E<lt> E<lt>= E<gt> E<gt>= left to right\n"
4925 "== != left to right\n"
4929 "&& left to right\n"
4930 "|| left to right\n"
4931 "?: right to left\n"
4932 "= += -= *= /= %= E<lt>E<lt>= E<gt>E<gt>= &= ^= |= right to left\n"
4937 #: build/C/man7/posixoptions.7:23
4939 msgid "POSIXOPTIONS"
4943 #: build/C/man7/posixoptions.7:23
4949 #: build/C/man7/posixoptions.7:26
4950 msgid "posixoptions - optional parts of the POSIX standard"
4954 #: build/C/man7/posixoptions.7:40
4956 "The POSIX standard (the information below is from POSIX.1-2001) describes a "
4957 "set of behaviors and interfaces for a compliant system. However, many "
4958 "interfaces are optional and there are feature test macros to test the "
4959 "availability of interfaces at compile time, and functions B<sysconf>(3), "
4960 "B<fpathconf>(3), B<pathconf>(3), B<confstr>(3) to do this at run time. "
4961 "From shell scripts one can use B<getconf>(1). For more detail, see "
4966 #: build/C/man7/posixoptions.7:47
4968 "We give the name of the POSIX abbreviation, the option, the name of the "
4969 "B<sysconf>(3) parameter used to inquire about the option, and possibly a "
4970 "very short description. Much more precise detail can be found in the POSIX "
4971 "standard itself, versions of which can nowadays be accessed freely on the "
4976 #: build/C/man7/posixoptions.7:47
4978 msgid "ADV - _POSIX_ADVISORY_INFO - _SC_ADVISORY_INFO"
4982 #: build/C/man7/posixoptions.7:49
4983 msgid "The following advisory functions are present:"
4987 #: build/C/man7/posixoptions.7:57
4990 "I<posix_fadvise>(),\n"
4991 "I<posix_fallocate>(),\n"
4992 "I<posix_memalign>(),\n"
4993 "I<posix_madvise>().\n"
4997 #: build/C/man7/posixoptions.7:60
4999 msgid "AIO - _POSIX_ASYNCHRONOUS_IO - _SC_ASYNCHRONOUS_IO"
5003 #: build/C/man7/posixoptions.7:65
5005 "The header I<E<lt>aio.hE<gt>> is present. The following functions are "
5010 #: build/C/man7/posixoptions.7:77
5013 "I<aio_cancel>(),\n"
5017 "I<aio_return>(),\n"
5018 "I<aio_suspend>(),\n"
5020 "I<lio_listio>().\n"
5024 #: build/C/man7/posixoptions.7:80
5026 msgid "BAR - _POSIX_BARRIERS - _SC_BARRIERS"
5030 #: build/C/man7/posixoptions.7:87 build/C/man7/posixoptions.7:457
5032 "This option implies the B<_POSIX_THREADS> and "
5033 "B<_POSIX_THREAD_SAFE_FUNCTIONS> options. The following functions are "
5038 #: build/C/man7/posixoptions.7:96
5041 "I<pthread_barrier_destroy>(),\n"
5042 "I<pthread_barrier_init>(),\n"
5043 "I<pthread_barrier_wait>(),\n"
5044 "I<pthread_barrierattr_destroy>(),\n"
5045 "I<pthread_barrierattr_init>().\n"
5049 #. Batch environment.
5053 #: build/C/man7/posixoptions.7:103
5055 msgid "--- - POSIX_CHOWN_RESTRICTED"
5058 #. What about lchown() ?
5060 #: build/C/man7/posixoptions.7:111
5062 "If this option is in effect (as it always is under POSIX.1-2001) then only "
5063 "root may change the owner of a file, and nonroot can only set the group of a "
5064 "file to one of the groups it belongs to. This affects the functions "
5065 "I<chown>(), I<fchown>()."
5069 #: build/C/man7/posixoptions.7:111
5071 msgid "CS - _POSIX_CLOCK_SELECTION - _SC_CLOCK_SELECTION"
5075 #: build/C/man7/posixoptions.7:116
5077 "This option implies the B<_POSIX_TIMERS> option. The following functions "
5082 #: build/C/man7/posixoptions.7:123
5085 "I<pthread_condattr_getclock>(),\n"
5086 "I<pthread_condattr_setclock>(),\n"
5087 "I<clock_nanosleep>().\n"
5091 #: build/C/man7/posixoptions.7:131
5093 "If B<CLOCK_REALTIME> is changed by the function I<clock_settime>(), then "
5094 "this affects all timers set for an absolute time."
5098 #: build/C/man7/posixoptions.7:131
5100 msgid "CPT - _POSIX_CPUTIME - _SC_CPUTIME"
5104 #. Fortran development
5108 #: build/C/man7/posixoptions.7:144
5110 "The clockID CLOCK_PROCESS_CPUTIME_ID is supported. The initial value of "
5111 "this clock is 0 for each process. This option implies the B<_POSIX_TIMERS> "
5112 "option. The function I<clock_getcpuclockid>() is present."
5116 #: build/C/man7/posixoptions.7:144
5118 msgid "--- - _POSIX_FILE_LOCKING - _SC_FILE_LOCKING"
5122 #. IEC 60559 Floating-Point Option.
5124 #: build/C/man7/posixoptions.7:147 build/C/man7/posixoptions.7:237
5125 msgid "This option has been deleted. Not in final XPG6."
5129 #: build/C/man7/posixoptions.7:147
5131 msgid "FSC - _POSIX_FSYNC - _SC_FSYNC "
5135 #: build/C/man7/posixoptions.7:151
5136 msgid "The function I<fsync>() is present."
5140 #: build/C/man7/posixoptions.7:151
5142 msgid "IP6 - _POSIX_IPV6 - _SC_IPV6"
5146 #: build/C/man7/posixoptions.7:153
5147 msgid "Internet Protocol Version 6 is supported."
5151 #: build/C/man7/posixoptions.7:153
5153 msgid "--- - _POSIX_JOB_CONTROL - _SC_JOB_CONTROL"
5157 #: build/C/man7/posixoptions.7:157
5159 "If this option is in effect (as it always is under POSIX.1-2001) then the "
5160 "system implements POSIX-style job control, and the following functions are "
5165 #: build/C/man7/posixoptions.7:168
5172 "I<tcsendbreak>(),\n"
5178 #: build/C/man7/posixoptions.7:170
5180 msgid "MF - _POSIX_MAPPED_FILES - _SC_MAPPED_FILES"
5184 #: build/C/man7/posixoptions.7:179
5186 "Shared memory is supported. The include file I<E<lt>sys/mman.hE<gt>> is "
5187 "present. The following functions are present: I<mmap>(), I<msync>(), "
5192 #: build/C/man7/posixoptions.7:179
5194 msgid "ML - _POSIX_MEMLOCK - _SC_MEMLOCK"
5198 #: build/C/man7/posixoptions.7:185
5200 "Shared memory can be locked into core. The functions I<mlockall>(), "
5201 "I<munlockall>() are present."
5205 #: build/C/man7/posixoptions.7:185
5207 msgid "MR/MLR - _POSIX_MEMLOCK_RANGE - _SC_MEMLOCK_RANGE"
5211 #: build/C/man7/posixoptions.7:191
5213 "More precisely, ranges can be locked into core. The functions I<mlock>(), "
5214 "I<munlock>() are present."
5218 #: build/C/man7/posixoptions.7:191
5220 msgid "MPR - _POSIX_MEMORY_PROTECTION - _SC_MEMORY_PROTECTION"
5224 #: build/C/man7/posixoptions.7:195
5225 msgid "The function I<mprotect>() is present."
5229 #: build/C/man7/posixoptions.7:195
5231 msgid "MSG - _POSIX_MESSAGE_PASSING - _SC_MESSAGE_PASSING"
5235 #: build/C/man7/posixoptions.7:200
5237 "The include file I<E<lt>mqueue.hE<gt>> is present. The following functions "
5242 #: build/C/man7/posixoptions.7:212
5246 "I<mq_getattr>(),\n"
5249 "I<mq_receive>(),\n"
5251 "I<mq_setattr>(),\n"
5256 #: build/C/man7/posixoptions.7:215
5258 msgid "MON - _POSIX_MONOTONIC_CLOCK - _SC_MONOTONIC_CLOCK"
5262 #: build/C/man7/posixoptions.7:222
5264 "B<CLOCK_MONOTONIC> is supported. This option implies the B<_POSIX_TIMERS> "
5265 "option. Affected functions are"
5269 #: build/C/man7/posixoptions.7:230
5272 "I<aio_suspend>(),\n"
5273 "I<clock_getres>(),\n"
5274 "I<clock_gettime>(),\n"
5275 "I<clock_settime>(),\n"
5276 "I<timer_create>().\n"
5280 #: build/C/man7/posixoptions.7:232
5282 msgid "--- - _POSIX_MULTI_PROCESS - _SC_MULTI_PROCESS"
5286 #: build/C/man7/posixoptions.7:237
5288 msgid "--- - _POSIX_NO_TRUNC"
5292 #: build/C/man7/posixoptions.7:244
5294 "If this option is in effect (as it always is under POSIX.1-2001) then "
5295 "pathname components longer than B<NAME_MAX> are not truncated, but give an "
5296 "error. This property may be dependent on the path prefix of the component."
5300 #: build/C/man7/posixoptions.7:244
5302 msgid "PIO - _POSIX_PRIORITIZED_IO - _SC_PRIORITIZED_IO"
5306 #: build/C/man7/posixoptions.7:247
5308 "This option says that one can specify priorities for asynchronous I/O. This "
5309 "affects the functions"
5313 #: build/C/man7/posixoptions.7:253
5321 #: build/C/man7/posixoptions.7:255
5323 msgid "PS - _POSIX_PRIORITY_SCHEDULING - _SC_PRIORITY_SCHEDULING"
5327 #: build/C/man7/posixoptions.7:260
5329 "The include file I<E<lt>sched.hE<gt>> is present. The following functions "
5334 #: build/C/man7/posixoptions.7:272
5337 "I<sched_get_priority_max>(),\n"
5338 "I<sched_get_priority_min>(),\n"
5339 "I<sched_getparam>(),\n"
5340 "I<sched_getscheduler>(),\n"
5341 "I<sched_rr_get_interval>(),\n"
5342 "I<sched_setparam>(),\n"
5343 "I<sched_setscheduler>(),\n"
5344 "I<sched_yield>().\n"
5348 #: build/C/man7/posixoptions.7:278
5350 "If also B<_POSIX_SPAWN> is in effect, then the following functions are "
5355 #: build/C/man7/posixoptions.7:286 build/C/man7/posixoptions.7:448
5358 "I<posix_spawnattr_getschedparam>(),\n"
5359 "I<posix_spawnattr_getschedpolicy>(),\n"
5360 "I<posix_spawnattr_setschedparam>(),\n"
5361 "I<posix_spawnattr_setschedpolicy>().\n"
5365 #: build/C/man7/posixoptions.7:288
5367 msgid "RS - _POSIX_RAW_SOCKETS"
5371 #: build/C/man7/posixoptions.7:293
5373 "Raw sockets are supported. Affected functions are I<getsockopt>(), "
5378 #: build/C/man7/posixoptions.7:293
5380 msgid "--- - _POSIX_READER_WRITER_LOCKS - _SC_READER_WRITER_LOCKS"
5384 #: build/C/man7/posixoptions.7:301
5386 "This option implies the B<_POSIX_THREADS> option. Conversely, under "
5387 "POSIX.1-2001 the B<_POSIX_THREADS> option implies this option."
5391 #: build/C/man7/posixoptions.7:303
5393 msgid "The following functions are present:\n"
5397 #: build/C/man7/posixoptions.7:314
5400 "I<pthread_rwlock_destroy>(),\n"
5401 "I<pthread_rwlock_init>(),\n"
5402 "I<pthread_rwlock_rdlock>(),\n"
5403 "I<pthread_rwlock_tryrdlock>(),\n"
5404 "I<pthread_rwlock_trywrlock>(),\n"
5405 "I<pthread_rwlock_unlock>(),\n"
5406 "I<pthread_rwlock_wrlock>(),\n"
5407 "I<pthread_rwlockattr_destroy>(),\n"
5408 "I<pthread_rwlockattr_init>().\n"
5412 #: build/C/man7/posixoptions.7:316
5414 msgid "RTS - _POSIX_REALTIME_SIGNALS - _SC_REALTIME_SIGNALS"
5418 #: build/C/man7/posixoptions.7:319
5419 msgid "Realtime signals are supported. The following functions are present:"
5423 #: build/C/man7/posixoptions.7:326
5427 "I<sigtimedwait>(),\n"
5428 "I<sigwaitinfo>().\n"
5432 #: build/C/man7/posixoptions.7:329
5434 msgid "--- - _POSIX_REGEXP - _SC_REGEXP"
5438 #: build/C/man7/posixoptions.7:333
5440 "If this option is in effect (as it always is under POSIX.1-2001) then POSIX "
5441 "regular expressions are supported and the following functions are present:"
5445 #: build/C/man7/posixoptions.7:341
5455 #: build/C/man7/posixoptions.7:344
5457 msgid "--- - _POSIX_SAVED_IDS - _SC_SAVED_IDS"
5461 #: build/C/man7/posixoptions.7:348
5463 "If this option is in effect (as it always is under POSIX.1-2001) then a "
5464 "process has a saved set-user-ID and a saved set-group-ID. Affected "
5469 #: build/C/man7/posixoptions.7:358
5481 #. Software development
5483 #: build/C/man7/posixoptions.7:363
5485 msgid "SEM - _POSIX_SEMAPHORES - _SC_SEMAPHORES"
5489 #: build/C/man7/posixoptions.7:368
5491 "The include file I<E<lt>semaphore.hE<gt>> is present. The following "
5492 "functions are present:"
5496 #: build/C/man7/posixoptions.7:381
5500 "I<sem_destroy>(),\n"
5501 "I<sem_getvalue>(),\n"
5505 "I<sem_trywait>(),\n"
5506 "I<sem_unlink>(),\n"
5511 #: build/C/man7/posixoptions.7:384
5513 msgid "SHM - _POSIX_SHARED_MEMORY_OBJECTS - _SC_SHARED_MEMORY_OBJECTS"
5517 #: build/C/man7/posixoptions.7:386 build/C/man7/posixoptions.7:702 build/C/man7/posixoptions.7:718 build/C/man7/posixoptions.7:832
5518 msgid "The following functions are present:"
5522 #: build/C/man7/posixoptions.7:394
5528 "I<shm_unlink>().\n"
5532 #: build/C/man7/posixoptions.7:397
5534 msgid "--- - _POSIX_SHELL - _SC_SHELL"
5538 #: build/C/man7/posixoptions.7:402
5540 "If this option is in effect (as it always is under POSIX.1-2001), the "
5541 "function I<system>() is present."
5545 #: build/C/man7/posixoptions.7:402
5547 msgid "SPN - _POSIX_SPAWN - _SC_SPAWN"
5551 #: build/C/man7/posixoptions.7:412
5553 "This option describes support for process creation in a context where it is "
5554 "difficult or impossible to use I<fork>(), for example, because no MMU is "
5555 "present. If B<_POSIX_SPAWN> is in effect, then the include file "
5556 "I<E<lt>spawn.hE<gt>> and the following functions are present:"
5560 #: build/C/man7/posixoptions.7:433
5563 "I<posix_spawn>(),\n"
5564 "I<posix_spawn_file_actions_addclose>(),\n"
5565 "I<posix_spawn_file_actions_adddup2>(),\n"
5566 "I<posix_spawn_file_actions_addopen>(),\n"
5567 "I<posix_spawn_file_actions_destroy>(),\n"
5568 "I<posix_spawn_file_actions_init>(),\n"
5569 "I<posix_spawnattr_destroy>(),\n"
5570 "I<posix_spawnattr_getsigdefault>(),\n"
5571 "I<posix_spawnattr_getflags>(),\n"
5572 "I<posix_spawnattr_getpgroup>(),\n"
5573 "I<posix_spawnattr_getsigmask>(),\n"
5574 "I<posix_spawnattr_init>(),\n"
5575 "I<posix_spawnattr_setsigdefault>(),\n"
5576 "I<posix_spawnattr_setflags>(),\n"
5577 "I<posix_spawnattr_setpgroup>(),\n"
5578 "I<posix_spawnattr_setsigmask>(),\n"
5579 "I<posix_spawnp>().\n"
5583 #: build/C/man7/posixoptions.7:440
5585 "If also B<_POSIX_PRIORITY_SCHEDULING> is in effect, then the following "
5586 "functions are present:"
5590 #: build/C/man7/posixoptions.7:450
5592 msgid "SPI - _POSIX_SPIN_LOCKS - _SC_SPIN_LOCKS"
5596 #: build/C/man7/posixoptions.7:466
5599 "I<pthread_spin_destroy>(),\n"
5600 "I<pthread_spin_init>(),\n"
5601 "I<pthread_spin_lock>(),\n"
5602 "I<pthread_spin_trylock>(),\n"
5603 "I<pthread_spin_unlock>().\n"
5607 #: build/C/man7/posixoptions.7:469
5609 msgid "SS - _POSIX_SPORADIC_SERVER - _SC_SPORADIC_SERVER"
5613 #: build/C/man7/posixoptions.7:477
5615 "The scheduling policy B<SCHED_SPORADIC> is supported. This option implies "
5616 "the B<_POSIX_PRIORITY_SCHEDULING> option. Affected functions are"
5620 #: build/C/man7/posixoptions.7:483
5623 "I<sched_setparam>(),\n"
5624 "I<sched_setscheduler>().\n"
5628 #: build/C/man7/posixoptions.7:486
5630 msgid "SIO - _POSIX_SYNCHRONIZED_IO - _SC_SYNCHRONIZED_IO"
5634 #: build/C/man7/posixoptions.7:492
5635 msgid "Affected functions are I<open>(), I<msync>(), I<fsync>(), I<fdatasync>()."
5639 #: build/C/man7/posixoptions.7:492
5641 msgid "TSA - _POSIX_THREAD_ATTR_STACKADDR - _SC_THREAD_ATTR_STACKADDR"
5645 #: build/C/man7/posixoptions.7:494 build/C/man7/posixoptions.7:507 build/C/man7/posixoptions.7:538 build/C/man7/posixoptions.7:549 build/C/man7/posixoptions.7:584 build/C/man7/posixoptions.7:601
5646 msgid "Affected functions are"
5650 #: build/C/man7/posixoptions.7:502
5653 "I<pthread_attr_getstack>(),\n"
5654 "I<pthread_attr_getstackaddr>(),\n"
5655 "I<pthread_attr_setstack>(),\n"
5656 "I<pthread_attr_setstackaddr>().\n"
5660 #: build/C/man7/posixoptions.7:505
5662 msgid "TSS - _POSIX_THREAD_ATTR_STACKSIZE - _SC_THREAD_ATTR_STACKSIZE"
5666 #: build/C/man7/posixoptions.7:515
5669 "I<pthread_attr_getstack>(),\n"
5670 "I<pthread_attr_getstacksize>(),\n"
5671 "I<pthread_attr_setstack>(),\n"
5672 "I<pthread_attr_setstacksize>().\n"
5676 #: build/C/man7/posixoptions.7:518
5678 msgid "TCT - _POSIX_THREAD_CPUTIME - _SC_THREAD_CPUTIME"
5682 #: build/C/man7/posixoptions.7:524
5684 "The clockID CLOCK_THREAD_CPUTIME_ID is supported. This option implies the "
5685 "B<_POSIX_TIMERS> option. Affected functions are"
5689 #: build/C/man7/posixoptions.7:533
5692 "I<pthread_getcpuclockid>(),\n"
5693 "I<clock_getres>(),\n"
5694 "I<clock_gettime>(),\n"
5695 "I<clock_settime>(),\n"
5696 "I<timer_create>().\n"
5700 #: build/C/man7/posixoptions.7:536
5702 msgid "TPI - _POSIX_THREAD_PRIO_INHERIT - _SC_THREAD_PRIO_INHERIT"
5706 #: build/C/man7/posixoptions.7:544
5709 "I<pthread_mutexattr_getprotocol>(),\n"
5710 "I<pthread_mutexattr_setprotocol>().\n"
5714 #: build/C/man7/posixoptions.7:547
5716 msgid "TPP - _POSIX_THREAD_PRIO_PROTECT - _SC_THREAD_PRIO_PROTECT"
5720 #: build/C/man7/posixoptions.7:559
5723 "I<pthread_mutex_getprioceiling>(),\n"
5724 "I<pthread_mutex_setprioceiling>(),\n"
5725 "I<pthread_mutexattr_getprioceiling>(),\n"
5726 "I<pthread_mutexattr_getprotocol>(),\n"
5727 "I<pthread_mutexattr_setprioceiling>(),\n"
5728 "I<pthread_mutexattr_setprotocol>().\n"
5732 #: build/C/man7/posixoptions.7:562
5734 msgid "TPS - _POSIX_THREAD_PRIORITY_SCHEDULING - _SC_THREAD_PRIORITY_SCHEDULING"
5738 #: build/C/man7/posixoptions.7:566
5740 "If this option is in effect, the different threads inside a process can run "
5741 "with different priorities and/or different schedulers. Affected functions "
5746 #: build/C/man7/posixoptions.7:579
5749 "I<pthread_attr_getinheritsched>(),\n"
5750 "I<pthread_attr_getschedpolicy>(),\n"
5751 "I<pthread_attr_getscope>(),\n"
5752 "I<pthread_attr_setinheritsched>(),\n"
5753 "I<pthread_attr_setschedpolicy>(),\n"
5754 "I<pthread_attr_setscope>(),\n"
5755 "I<pthread_getschedparam>(),\n"
5756 "I<pthread_setschedparam>(),\n"
5757 "I<pthread_setschedprio>().\n"
5761 #: build/C/man7/posixoptions.7:582
5763 msgid "TSH - _POSIX_THREAD_PROCESS_SHARED - _SC_THREAD_PROCESS_SHARED"
5767 #: build/C/man7/posixoptions.7:596
5770 "I<pthread_barrierattr_getpshared>(),\n"
5771 "I<pthread_barrierattr_setpshared>(),\n"
5772 "I<pthread_condattr_getpshared>(),\n"
5773 "I<pthread_condattr_setpshared>(),\n"
5774 "I<pthread_mutexattr_getpshared>(),\n"
5775 "I<pthread_mutexattr_setpshared>(),\n"
5776 "I<pthread_rwlockattr_getpshared>(),\n"
5777 "I<pthread_rwlockattr_setpshared>().\n"
5781 #: build/C/man7/posixoptions.7:599
5783 msgid "TSF - _POSIX_THREAD_SAFE_FUNCTIONS - _SC_THREAD_SAFE_FUNCTIONS"
5787 #: build/C/man7/posixoptions.7:624
5791 "I<getgrgid_r>(),\n"
5792 "I<getgrnam_r>(),\n"
5793 "I<getpwnam_r>(),\n"
5794 "I<getpwuid_r>(),\n"
5796 "I<ftrylockfile>(),\n"
5797 "I<funlockfile>(),\n"
5798 "I<getc_unlocked>(),\n"
5799 "I<getchar_unlocked>(),\n"
5800 "I<putc_unlocked>(),\n"
5801 "I<putchar_unlocked>(),\n"
5803 "I<strerror_r>(),\n"
5808 "I<localtime_r>().\n"
5812 #: build/C/man7/posixoptions.7:627
5814 msgid "TSP - _POSIX_THREAD_SPORADIC_SERVER - _SC_THREAD_SPORADIC_SERVER"
5818 #: build/C/man7/posixoptions.7:632
5820 "This option implies the B<_POSIX_THREAD_PRIORITY_SCHEDULING> option. "
5821 "Affected functions are"
5825 #: build/C/man7/posixoptions.7:639
5828 "I<sched_getparam>(),\n"
5829 "I<sched_setparam>(),\n"
5830 "I<sched_setscheduler>().\n"
5834 #: build/C/man7/posixoptions.7:642
5836 msgid "THR - _POSIX_THREADS - _SC_THREADS"
5840 #: build/C/man7/posixoptions.7:645
5842 "Basic support for POSIX threads is available. The following functions are "
5847 #: build/C/man7/posixoptions.7:697
5850 "I<pthread_atfork>(),\n"
5851 "I<pthread_attr_destroy>(),\n"
5852 "I<pthread_attr_getdetachstate>(),\n"
5853 "I<pthread_attr_getschedparam>(),\n"
5854 "I<pthread_attr_init>(),\n"
5855 "I<pthread_attr_setdetachstate>(),\n"
5856 "I<pthread_attr_setschedparam>(),\n"
5857 "I<pthread_cancel>(),\n"
5858 "I<pthread_cleanup_push>(),\n"
5859 "I<pthread_cleanup_pop>(),\n"
5860 "I<pthread_cond_broadcast>(),\n"
5861 "I<pthread_cond_destroy>(),\n"
5862 "I<pthread_cond_init>(),\n"
5863 "I<pthread_cond_signal>(),\n"
5864 "I<pthread_cond_timedwait>(),\n"
5865 "I<pthread_cond_wait>(),\n"
5866 "I<pthread_condattr_destroy>(),\n"
5867 "I<pthread_condattr_init>(),\n"
5868 "I<pthread_create>(),\n"
5869 "I<pthread_detach>(),\n"
5870 "I<pthread_equal>(),\n"
5871 "I<pthread_exit>(),\n"
5872 "I<pthread_getspecific>(),\n"
5873 "I<pthread_join>(),\n"
5874 "I<pthread_key_create>(),\n"
5875 "I<pthread_key_delete>(),\n"
5876 "I<pthread_mutex_destroy>(),\n"
5877 "I<pthread_mutex_init>(),\n"
5878 "I<pthread_mutex_lock>(),\n"
5879 "I<pthread_mutex_trylock>(),\n"
5880 "I<pthread_mutex_unlock>(),\n"
5881 "I<pthread_mutexattr_destroy>(),\n"
5882 "I<pthread_mutexattr_init>(),\n"
5883 "I<pthread_once>(),\n"
5884 "I<pthread_rwlock_destroy>(),\n"
5885 "I<pthread_rwlock_init>(),\n"
5886 "I<pthread_rwlock_rdlock>(),\n"
5887 "I<pthread_rwlock_tryrdlock>(),\n"
5888 "I<pthread_rwlock_trywrlock>(),\n"
5889 "I<pthread_rwlock_unlock>(),\n"
5890 "I<pthread_rwlock_wrlock>(),\n"
5891 "I<pthread_rwlockattr_destroy>(),\n"
5892 "I<pthread_rwlockattr_init>(),\n"
5893 "I<pthread_self>(),\n"
5894 "I<pthread_setcancelstate>(),\n"
5895 "I<pthread_setcanceltype>(),\n"
5896 "I<pthread_setspecific>(),\n"
5897 "I<pthread_testcancel>().\n"
5901 #: build/C/man7/posixoptions.7:700
5903 msgid "TMO - _POSIX_TIMEOUTS - _SC_TIMEOUTS"
5907 #: build/C/man7/posixoptions.7:713
5910 "I<mq_timedreceive>(),\n"
5911 "I<mq_timedsend>(),\n"
5912 "I<pthread_mutex_timedlock>(),\n"
5913 "I<pthread_rwlock_timedrdlock>(),\n"
5914 "I<pthread_rwlock_timedwrlock>(),\n"
5915 "I<sem_timedwait>(),\n"
5916 "I<posix_trace_timedgetnext_event>().\n"
5920 #: build/C/man7/posixoptions.7:716
5922 msgid "TMR - _POSIX_TIMERS - _SC_TIMERS"
5926 #: build/C/man7/posixoptions.7:731
5929 "I<clock_getres>(),\n"
5930 "I<clock_gettime>(),\n"
5931 "I<clock_settime>(),\n"
5933 "I<timer_create>(),\n"
5934 "I<timer_delete>(),\n"
5935 "I<timer_gettime>(),\n"
5936 "I<timer_getoverrun>(),\n"
5937 "I<timer_settime>().\n"
5941 #: build/C/man7/posixoptions.7:734
5943 msgid "TRC - _POSIX_TRACE - _SC_TRACE"
5947 #: build/C/man7/posixoptions.7:737
5948 msgid "POSIX tracing is available. The following functions are present:"
5952 #: build/C/man7/posixoptions.7:772
5955 "I<posix_trace_attr_destroy>(),\n"
5956 "I<posix_trace_attr_getclockres>(),\n"
5957 "I<posix_trace_attr_getcreatetime>(),\n"
5958 "I<posix_trace_attr_getgenversion>(),\n"
5959 "I<posix_trace_attr_getmaxdatasize>(),\n"
5960 "I<posix_trace_attr_getmaxsystemeventsize>(),\n"
5961 "I<posix_trace_attr_getmaxusereventsize>(),\n"
5962 "I<posix_trace_attr_getname>(),\n"
5963 "I<posix_trace_attr_getstreamfullpolicy>(),\n"
5964 "I<posix_trace_attr_getstreamsize>(),\n"
5965 "I<posix_trace_attr_init>(),\n"
5966 "I<posix_trace_attr_setmaxdatasize>(),\n"
5967 "I<posix_trace_attr_setname>(),\n"
5968 "I<posix_trace_attr_setstreamsize>(),\n"
5969 "I<posix_trace_attr_setstreamfullpolicy>(),\n"
5970 "I<posix_trace_clear>(),\n"
5971 "I<posix_trace_create>(),\n"
5972 "I<posix_trace_event>(),\n"
5973 "I<posix_trace_eventid_equal>(),\n"
5974 "I<posix_trace_eventid_get_name>(),\n"
5975 "I<posix_trace_eventid_open>(),\n"
5976 "I<posix_trace_eventtypelist_getnext_id>(),\n"
5977 "I<posix_trace_eventtypelist_rewind>(),\n"
5978 "I<posix_trace_flush>(),\n"
5979 "I<posix_trace_get_attr>(),\n"
5980 "I<posix_trace_get_status>(),\n"
5981 "I<posix_trace_getnext_event>(),\n"
5982 "I<posix_trace_shutdown>(),\n"
5983 "I<posix_trace_start>(),\n"
5984 "I<posix_trace_stop>(),\n"
5985 "I<posix_trace_trygetnext_event>().\n"
5989 #: build/C/man7/posixoptions.7:775
5991 msgid "TEF - _POSIX_TRACE_EVENT_FILTER - _SC_TRACE_EVENT_FILTER"
5995 #: build/C/man7/posixoptions.7:780 build/C/man7/posixoptions.7:815
5997 "This option implies the B<_POSIX_TRACE> option. The following functions are "
6002 #: build/C/man7/posixoptions.7:792
6005 "I<posix_trace_eventset_add>(),\n"
6006 "I<posix_trace_eventset_del>(),\n"
6007 "I<posix_trace_eventset_empty>(),\n"
6008 "I<posix_trace_eventset_fill>(),\n"
6009 "I<posix_trace_eventset_ismember>(),\n"
6010 "I<posix_trace_get_filter>(),\n"
6011 "I<posix_trace_set_filter>(),\n"
6012 "I<posix_trace_trid_eventid_open>().\n"
6016 #: build/C/man7/posixoptions.7:795
6018 msgid "TRI - _POSIX_TRACE_INHERIT - _SC_TRACE_INHERIT"
6022 #: build/C/man7/posixoptions.7:801
6024 "Tracing children of the traced process is supported. This option implies "
6025 "the B<_POSIX_TRACE> option. The following functions are present:"
6029 #: build/C/man7/posixoptions.7:807
6032 "I<posix_trace_attr_getinherited>(),\n"
6033 "I<posix_trace_attr_setinherited>().\n"
6037 #: build/C/man7/posixoptions.7:810
6039 msgid "TRL - _POSIX_TRACE_LOG - _SC_TRACE_LOG"
6043 #: build/C/man7/posixoptions.7:827
6046 "I<posix_trace_attr_getlogfullpolicy>(),\n"
6047 "I<posix_trace_attr_getlogsize>(),\n"
6048 "I<posix_trace_attr_setlogfullpolicy>(),\n"
6049 "I<posix_trace_attr_setlogsize>(),\n"
6050 "I<posix_trace_close>(),\n"
6051 "I<posix_trace_create_withlog>(),\n"
6052 "I<posix_trace_open>(),\n"
6053 "I<posix_trace_rewind>().\n"
6057 #: build/C/man7/posixoptions.7:830
6059 msgid "TYM - _POSIX_TYPED_MEMORY_OBJECTS - _SC_TYPED_MEMORY_OBJECT"
6063 #: build/C/man7/posixoptions.7:839
6066 "I<posix_mem_offset>(),\n"
6067 "I<posix_typed_mem_get_info>(),\n"
6068 "I<posix_typed_mem_open>().\n"
6072 #: build/C/man7/posixoptions.7:842
6074 msgid "--- - _POSIX_VDISABLE"
6078 #: build/C/man7/posixoptions.7:846
6080 "Always present (probably 0). Value to set a changeable special control "
6081 "character to indicate that it is disabled."
6085 #: build/C/man7/posixoptions.7:846
6087 msgid "XOPEN EXTENSIONS"
6092 #: build/C/man7/posixoptions.7:853
6094 "B<_XOPEN_CRYPT>, B<_XOPEN_LEGACY>, B<_XOPEN_REALTIME>, "
6095 "B<_XOPEN_REALTIME_THREADS>, B<_XOPEN_UNIX>."
6099 #: build/C/man7/posixoptions.7:856
6100 msgid "B<sysconf>(3), B<standards>(7)"
6104 #: build/C/man5/proc.5:61
6110 #: build/C/man5/proc.5:61
6116 #: build/C/man5/proc.5:64
6117 msgid "proc - process information pseudo-file system"
6121 #: build/C/man5/proc.5:73
6123 "The I<proc> file system is a pseudo-file system which is used as an "
6124 "interface to kernel data structures. It is commonly mounted at I</proc>. "
6125 "Most of it is read-only, but some files allow kernel variables to be "
6130 #: build/C/man5/proc.5:77
6131 msgid "The following outline gives a quick tour through the I</proc> hierarchy."
6135 #: build/C/man5/proc.5:78
6137 msgid "I</proc/[pid]>"
6140 #. FIXME Describe /proc/[pid]/attr and
6141 #. /proc/[pid]/task/[tid]/attr
6142 #. This is a directory
6146 #: build/C/man5/proc.5:90
6148 "There is a numerical subdirectory for each running process; the subdirectory "
6149 "is named by the process ID. Each such subdirectory contains the following "
6150 "pseudo-files and directories."
6154 #: build/C/man5/proc.5:90
6156 msgid "I</proc/[pid]/auxv> (since 2.6.0-test7)"
6159 #. FIXME Describe /proc/[pid]/cgroup and
6160 #. /proc/[pid]/task/[tid]/cgroup
6161 #. Info in Documentation/cgroups.txt
6165 #. FIXME Describe /proc/[pid]/clear_refs
6167 #. "Clears page referenced bits shown in smaps output"
6169 #. CONFIG_PROC_PAGE_MONITOR
6171 #: build/C/man5/proc.5:108
6173 "This contains the contents of the ELF interpreter information passed to the "
6174 "process at exec time. The format is one I<unsigned long> ID plus one "
6175 "I<unsigned long> value for each entry. The last entry contains two zeros."
6179 #: build/C/man5/proc.5:108
6181 msgid "I</proc/[pid]/cmdline>"
6184 #. In 2.3.26, this also used to be true if the process was swapped out.
6186 #: build/C/man5/proc.5:118
6188 "This holds the complete command line for the process, unless the process is "
6189 "a zombie. In the latter case, there is nothing in this file: that is, a "
6190 "read on this file will return 0 characters. The command-line arguments "
6191 "appear in this file as a set of strings separated by null bytes "
6192 "(\\(aq\\e0\\(aq), with a further null byte after the last string."
6196 #: build/C/man5/proc.5:118
6198 msgid "I</proc/[pid]/coredump_filter> (since kernel 2.6.23)"
6202 #: build/C/man5/proc.5:122 build/C/man5/proc.5:2094 build/C/man5/proc.5:2098
6203 msgid "See B<core>(5)."
6207 #: build/C/man5/proc.5:122
6209 msgid "I</proc/[pid]/cpuset> (since kernel 2.6.12)"
6212 #. and/proc/[pid]/task/[tid]/cpuset
6214 #: build/C/man5/proc.5:127
6215 msgid "See B<cpuset>(7)."
6219 #: build/C/man5/proc.5:127
6221 msgid "I</proc/[pid]/cwd>"
6225 #: build/C/man5/proc.5:132
6227 "This is a symbolic link to the current working directory of the process. To "
6228 "find out the current working directory of process 20, for instance, you can "
6233 #: build/C/man5/proc.5:136
6235 msgid "$B< cd /proc/20/cwd; /bin/pwd>\n"
6239 #: build/C/man5/proc.5:147
6241 "Note that the I<pwd> command is often a shell built-in, and might not work "
6242 "properly. In B<bash>(1), you may use I<pwd\\ -P>."
6245 #. The following was still true as at kernel 2.6.13
6246 #. FIXME Describe /proc/[pid]/seccomp
6248 #. FIXME Describe /proc/[pid]/sessionid
6249 #. Added in 2.6.25; read-only; only readable by real UID
6250 #. CONFIG_AUDITSYSCALL
6251 #. FIXME Describe /proc/[pid]/sched
6253 #. CONFIG_SCHED_DEBUG, and additional fields if CONFIG_SCHEDSTATS
6254 #. Displays various scheduling parameters
6255 #. This file can be written, to reset stats
6256 #. FIXME Describe /proc/[pid]/schedstats and
6257 #. /proc/[pid]/task/[tid]/schedstats
6259 #. CONFIG_SCHEDSTATS
6261 #: build/C/man5/proc.5:153 build/C/man5/proc.5:626
6263 "In a multithreaded process, the contents of this symbolic link are not "
6264 "available if the main thread has already terminated (typically by calling "
6265 "B<pthread_exit>(3))."
6269 #: build/C/man5/proc.5:153
6271 msgid "I</proc/[pid]/environ>"
6275 #: build/C/man5/proc.5:159
6277 "This file contains the environment for the process. The entries are "
6278 "separated by null bytes (\\(aq\\e0\\(aq), and there may be a null byte at "
6279 "the end. Thus, to print out the environment of process 1, you would do:"
6283 #: build/C/man5/proc.5:164
6285 msgid "$B< (cat /proc/1/environ; echo) | tr \\(aq\\e000\\(aq \\(aq\\en\\(aq>\n"
6289 #: build/C/man5/proc.5:167
6291 msgid "I</proc/[pid]/exe>"
6294 #. The following was still true as at kernel 2.6.13
6296 #: build/C/man5/proc.5:182
6298 "Under Linux 2.2 and later, this file is a symbolic link containing the "
6299 "actual pathname of the executed command. This symbolic link can be "
6300 "dereferenced normally; attempting to open it will open the executable. You "
6301 "can even type I</proc/[pid]/exe> to run another copy of the same executable "
6302 "as is being run by process [pid]. In a multithreaded process, the contents "
6303 "of this symbolic link are not available if the main thread has already "
6304 "terminated (typically by calling B<pthread_exit>(3))."
6308 #: build/C/man5/proc.5:190
6310 "Under Linux 2.0 and earlier I</proc/[pid]/exe> is a pointer to the binary "
6311 "which was executed, and appears as a symbolic link. A B<readlink>(2) call "
6312 "on this file under Linux 2.0 returns a string in the format:"
6316 #: build/C/man5/proc.5:192
6318 msgid " [device]:inode\n"
6322 #: build/C/man5/proc.5:195
6324 "For example, [0301]:1502 would be inode 1502 on device major 03 (IDE, MFM, "
6325 "etc. drives) minor 01 (first partition on the first drive)."
6329 #: build/C/man5/proc.5:200
6330 msgid "B<find>(1) with the I<-inum> option can be used to locate the file."
6334 #: build/C/man5/proc.5:200
6336 msgid "I</proc/[pid]/fd>"
6340 #: build/C/man5/proc.5:206
6342 "This is a subdirectory containing one entry for each file which the process "
6343 "has open, named by its file descriptor, and which is a symbolic link to the "
6344 "actual file. Thus, 0 is standard input, 1 standard output, 2 standard "
6348 #. The following was still true as at kernel 2.6.13
6350 #: build/C/man5/proc.5:212
6352 "In a multithreaded process, the contents of this directory are not available "
6353 "if the main thread has already terminated (typically by calling "
6354 "B<pthread_exit>(3))."
6358 #: build/C/man5/proc.5:225
6360 "Programs that will take a filename as a command-line argument, but will not "
6361 "take input from standard input if no argument is supplied, or that write to "
6362 "a file named as a command-line argument, but will not send their output to "
6363 "standard output if no argument is supplied, can nevertheless be made to use "
6364 "standard input or standard out using I</proc/[pid]/fd>. For example, "
6365 "assuming that I<-i> is the flag designating an input file and I<-o> is the "
6366 "flag designating an output file:"
6370 #: build/C/man5/proc.5:229
6372 msgid "$B< foobar -i /proc/self/fd/0 -o /proc/self/fd/1 ...>\n"
6375 #. The following is not true in my tests (MTK):
6376 #. Note that this will not work for
6377 #. programs that seek on their files, as the files in the fd directory
6378 #. are not seekable.
6380 #: build/C/man5/proc.5:237
6381 msgid "and you have a working filter."
6385 #: build/C/man5/proc.5:247
6387 "I</proc/self/fd/N> is approximately the same as I</dev/fd/N> in some UNIX "
6388 "and UNIX-like systems. Most Linux MAKEDEV scripts symbolically link "
6389 "I</dev/fd> to I</proc/self/fd>, in fact."
6393 #: build/C/man5/proc.5:261
6395 "Most systems provide symbolic links I</dev/stdin>, I</dev/stdout>, and "
6396 "I</dev/stderr>, which respectively link to the files I<0>, I<1>, and I<2> in "
6397 "I</proc/self/fd>. Thus the example command above could be written as:"
6401 #: build/C/man5/proc.5:265
6403 msgid "$B< foobar -i /dev/stdin -o /dev/stdout ...>\n"
6407 #: build/C/man5/proc.5:270
6409 msgid "I</proc/[pid]/fdinfo/> (since kernel 2.6.22)"
6413 #: build/C/man5/proc.5:276
6415 "This is a subdirectory containing one entry for each file which the process "
6416 "has open, named by its file descriptor. The contents of each file can be "
6417 "read to obtain information about the corresponding file descriptor, for "
6422 #: build/C/man5/proc.5:282
6425 "$B< cat /proc/12015/fdinfo/4>\n"
6431 #: build/C/man5/proc.5:293
6433 "The I<pos> field is a decimal number showing the current file offset. The "
6434 "I<flags> field is an octal number that displays the file access mode and "
6435 "file status flags (see B<open>(2))."
6438 #. FIXME document /proc/[pid]/io
6440 #. .IR /proc/[pid]/io " (since kernel 2.6.20)"
6442 #: build/C/man5/proc.5:298
6443 msgid "The files in this directory are readable only by the owner of the process."
6447 #: build/C/man5/proc.5:298
6449 msgid "I</proc/[pid]/limits> (since kernel 2.6.24)"
6453 #: build/C/man5/proc.5:304
6455 "This file displays the soft limit, hard limit, and units of measurement for "
6456 "each of the process's resource limits (see B<getrlimit>(2)). The file is "
6457 "protected to only allow reading by the real UID of the process."
6461 #: build/C/man5/proc.5:304
6463 msgid "I</proc/[pid]/maps>"
6467 #: build/C/man5/proc.5:308
6469 "A file containing the currently mapped memory regions and their access "
6474 #: build/C/man5/proc.5:310
6475 msgid "The format is:"
6479 #: build/C/man5/proc.5:323
6482 "CW<address perms offset dev inode pathname\n"
6483 "08048000-08056000 r-xp 00000000 03:0c 64593 /usr/sbin/gpm\n"
6484 "08056000-08058000 rw-p 0000d000 03:0c 64593 /usr/sbin/gpm\n"
6485 "08058000-0805b000 rwxp 00000000 00:00 0\n"
6486 "40000000-40013000 r-xp 00000000 03:0c 4165 /lib/ld-2.2.4.so\n"
6487 "40013000-40015000 rw-p 00012000 03:0c 4165 /lib/ld-2.2.4.so\n"
6488 "4001f000-40135000 r-xp 00000000 03:0c 45494 /lib/libc-2.2.4.so\n"
6489 "40135000-4013e000 rw-p 00115000 03:0c 45494 /lib/libc-2.2.4.so\n"
6490 "4013e000-40142000 rw-p 00000000 00:00 0\n"
6491 "bffff000-c0000000 rwxp 00000000 00:00 0>\n"
6495 #: build/C/man5/proc.5:328
6497 "where \"address\" is the address space in the process that it occupies, "
6498 "\"perms\" is a set of permissions:"
6502 #: build/C/man5/proc.5:336
6509 "p = private (copy on write)\n"
6513 #: build/C/man5/proc.5:343
6515 "\"offset\" is the offset into the file/whatever, \"dev\" is the device "
6516 "(major:minor), and \"inode\" is the inode on that device. 0 indicates that "
6517 "no inode is associated with the memory region, as the case would be with BSS "
6518 "(uninitialized data)."
6522 #: build/C/man5/proc.5:345
6523 msgid "Under Linux 2.0 there is no field giving pathname."
6527 #: build/C/man5/proc.5:345
6529 msgid "I</proc/[pid]/mem>"
6533 #: build/C/man5/proc.5:352
6535 "This file can be used to access the pages of a process's memory through "
6536 "B<open>(2), B<read>(2), and B<lseek>(2)."
6540 #: build/C/man5/proc.5:352
6542 msgid "I</proc/[pid]/mountinfo> (since Linux 2.6.26)"
6545 #. This info adapted from Documentation/filesystems/proc.txt
6547 #: build/C/man5/proc.5:357
6549 "This file contains information about mount points. It contains lines of the "
6554 #: build/C/man5/proc.5:362
6557 "CW<36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root "
6558 "rw,errors=continue\n"
6559 "(1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11)>\n"
6563 #: build/C/man5/proc.5:366
6564 msgid "The numbers in parentheses are labels for the descriptions below:"
6568 #: build/C/man5/proc.5:367 build/C/man5/proc.5:460
6574 #: build/C/man5/proc.5:371
6575 msgid "mount ID: unique identifier of the mount (may be reused after B<umount>(2))."
6579 #: build/C/man5/proc.5:371 build/C/man5/proc.5:464
6585 #: build/C/man5/proc.5:374
6586 msgid "parent ID: ID of parent mount (or of self for the top of the mount tree)."
6590 #: build/C/man5/proc.5:374 build/C/man5/proc.5:467
6596 #: build/C/man5/proc.5:380
6597 msgid "major:minor: value of I<st_dev> for files on file system (see B<stat>(2))."
6601 #: build/C/man5/proc.5:380 build/C/man5/proc.5:470
6607 #: build/C/man5/proc.5:383
6608 msgid "root: root of the mount within the file system."
6612 #: build/C/man5/proc.5:383
6618 #: build/C/man5/proc.5:386
6619 msgid "mount point: mount point relative to the process's root."
6623 #: build/C/man5/proc.5:386
6629 #: build/C/man5/proc.5:389
6630 msgid "mount options: per-mount options."
6634 #: build/C/man5/proc.5:389
6640 #: build/C/man5/proc.5:392
6641 msgid "optional fields: zero or more fields of the form \"tag[:value]\"."
6645 #: build/C/man5/proc.5:392
6651 #: build/C/man5/proc.5:395
6652 msgid "separator: marks the end of the optional fields."
6656 #: build/C/man5/proc.5:395
6662 #: build/C/man5/proc.5:398
6663 msgid "file system type: name of file system in the form \"type[.subtype]\"."
6667 #: build/C/man5/proc.5:398
6673 #: build/C/man5/proc.5:401
6674 msgid "mount source: file system-specific information or \"none\"."
6678 #: build/C/man5/proc.5:401
6684 #: build/C/man5/proc.5:404
6685 msgid "super options: per-super block options."
6689 #: build/C/man5/proc.5:408
6691 "Parsers should ignore all unrecognized optional fields. Currently the "
6692 "possible optional fields are:"
6696 #: build/C/man5/proc.5:409
6702 #: build/C/man5/proc.5:412
6703 msgid "mount is shared in peer group X"
6707 #: build/C/man5/proc.5:412
6713 #: build/C/man5/proc.5:415
6714 msgid "mount is slave to peer group X"
6718 #: build/C/man5/proc.5:415
6720 msgid "propagate_from:X"
6724 #: build/C/man5/proc.5:418
6725 msgid "mount is slave and receives propagation from peer group X (*)"
6729 #: build/C/man5/proc.5:418
6735 #: build/C/man5/proc.5:421
6736 msgid "mount is unbindable"
6740 #: build/C/man5/proc.5:428
6742 "(*) X is the closest dominant peer group under the process's root. If X is "
6743 "the immediate master of the mount, or if there is no dominant peer group "
6744 "under the same root, then only the \"master:X\" field is present and not the "
6745 "\"propagate_from:X\" field."
6749 #: build/C/man5/proc.5:432
6751 "For more information on mount propagation see: "
6752 "I<Documentation/filesystems/sharedsubtree.txt> in the kernel source tree."
6756 #: build/C/man5/proc.5:432
6758 msgid "I</proc/[pid]/mounts> (since Linux 2.4.19)"
6762 #: build/C/man5/proc.5:447
6764 "This is a list of all the file systems currently mounted in the process's "
6765 "mount namespace. The format of this file is documented in B<fstab>(5). "
6766 "Since kernel version 2.6.15, this file is pollable: after opening the file "
6767 "for reading, a change in this file (i.e., a file system mount or unmount) "
6768 "causes B<select>(2) to mark the file descriptor as readable, and B<poll>(2) "
6769 "and B<epoll_wait>(2) mark the file as having an error condition."
6773 #: build/C/man5/proc.5:447
6775 msgid "I</proc/[pid]/mountstats> (since Linux 2.6.17)"
6779 #: build/C/man5/proc.5:452
6781 "This file exports information (statistics, configuration information) about "
6782 "the mount points in the process's name space. Lines in this file have the "
6787 #: build/C/man5/proc.5:456
6790 "device /dev/sda7 mounted on /home with fstype ext3 [statistics]\n"
6791 "( 1 ) ( 2 ) (3 ) (4)\n"
6795 #: build/C/man5/proc.5:459
6796 msgid "The fields in each line are:"
6800 #: build/C/man5/proc.5:464
6802 "The name of the mounted device (or \"nodevice\" if there is no corresponding "
6807 #: build/C/man5/proc.5:467
6808 msgid "The mount point within the file system tree."
6812 #: build/C/man5/proc.5:470
6813 msgid "The file system type."
6817 #: build/C/man5/proc.5:475
6819 "Optional statistics and configuration information. Currently (as at Linux "
6820 "2.6.26), only NFS file systems export information via this field."
6824 #: build/C/man5/proc.5:478
6825 msgid "This file is only readable by the owner of the process."
6829 #: build/C/man5/proc.5:478
6831 msgid "I</proc/[pid]/ns/> (since Linux 3.0)"
6834 #. See commit 6b4e306aa3dc94a0545eb9279475b1ab6209a31f
6836 #: build/C/man5/proc.5:486
6838 "This is a subdirectory containing one entry for each namespace that supports "
6839 "being manipulated by B<setns>(2). For information about namespaces, see "
6844 #: build/C/man5/proc.5:486
6846 msgid "I</proc/[pid]/ns/ipc> (since Linux 3.0)"
6850 #: build/C/man5/proc.5:494
6852 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6853 "filesystem keeps the IPC namespace of the process specified by I<pid> alive "
6854 "even if all processes currently in the namespace terminate."
6858 #: build/C/man5/proc.5:503
6860 "Opening this file returns a file handle for the IPC namespace of the process "
6861 "specified by I<pid>. As long as this file descriptor remains open, the IPC "
6862 "namespace will remain alive, even if all processes in the namespace "
6863 "terminate. The file descriptor can be passed to B<setns>(2)."
6867 #: build/C/man5/proc.5:503
6869 msgid "I</proc/[pid]/ns/net> (since Linux 3.0)"
6873 #: build/C/man5/proc.5:511
6875 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6876 "filesystem keeps the network namespace of the process specified by I<pid> "
6877 "alive even if all processes in the namespace terminate."
6881 #: build/C/man5/proc.5:520
6883 "Opening this file returns a file handle for the network namespace of the "
6884 "process specified by I<pid>. As long as this file descriptor remains open, "
6885 "the network namespace will remain alive, even if all processes in the "
6886 "namespace terminate. The file descriptor can be passed to B<setns>(2)."
6890 #: build/C/man5/proc.5:520
6892 msgid "I</proc/[pid]/ns/uts> (since Linux 3.0)"
6896 #: build/C/man5/proc.5:528
6898 "Bind mounting this file (see B<mount>(2)) to somewhere else in the "
6899 "filesystem keeps the UTS namespace of the process specified by I<pid> alive "
6900 "even if all processes currently in the namespace terminate."
6904 #: build/C/man5/proc.5:537
6906 "Opening this file returns a file handle for the UTS namespace of the process "
6907 "specified by I<pid>. As long as this file descriptor remains open, the UTS "
6908 "namespace will remain alive, even if all processes in the namespace "
6909 "terminate. The file descriptor can be passed to B<setns>(2)."
6913 #: build/C/man5/proc.5:537
6915 msgid "I</proc/[pid]/numa_maps> (since Linux 2.6.14)"
6919 #: build/C/man5/proc.5:541
6920 msgid "See B<numa>(7)."
6924 #: build/C/man5/proc.5:541
6926 msgid "I</proc/[pid]/oom_adj> (since Linux 2.6.11)"
6930 #: build/C/man5/proc.5:561
6932 "This file can be used to adjust the score used to select which process "
6933 "should be killed in an out-of-memory (OOM) situation. The kernel uses this "
6934 "value for a bit-shift operation of the process's I<oom_score> value: valid "
6935 "values are in the range -16 to +15, plus the special value -17, which "
6936 "disables OOM-killing altogether for this process. A positive score "
6937 "increases the likelihood of this process being killed by the OOM-killer; a "
6938 "negative score decreases the likelihood. The default value for this file is "
6939 "0; a new process inherits its parent's I<oom_adj> setting. A process must "
6940 "be privileged (B<CAP_SYS_RESOURCE>) to update this file."
6944 #: build/C/man5/proc.5:561
6946 msgid "I</proc/[pid]/oom_score> (since Linux 2.6.11)"
6949 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
6950 #. See mm/oom_kill.c::badness() in the 2.6.25 sources
6952 #: build/C/man5/proc.5:572
6954 "This file displays the current score that the kernel gives to this process "
6955 "for the purpose of selecting a process for the OOM-killer. A higher score "
6956 "means that the process is more likely to be selected by the OOM-killer. The "
6957 "basis for this score is the amount of memory used by the process, with "
6958 "increases (+) or decreases (-) for factors including:"
6962 #: build/C/man5/proc.5:577
6963 msgid "whether the process creates a lot of children using B<fork>(2) (+);"
6967 #: build/C/man5/proc.5:580
6969 "whether the process has been running a long time, or has used a lot of CPU "
6974 #: build/C/man5/proc.5:582
6975 msgid "whether the process has a low nice value (i.e., E<gt> 0) (+);"
6978 #. More precisely, if it has CAP_SYS_ADMIN or CAP_SYS_RESOURCE
6980 #: build/C/man5/proc.5:585
6981 msgid "whether the process is privileged (-); and"
6984 #. More precisely, if it has CAP_SYS_RAWIO
6986 #: build/C/man5/proc.5:588
6987 msgid "whether the process is making direct hardware access (-)."
6990 #. FIXME Describe /proc/[pid]/pagemap
6992 #. CONFIG_PROC_PAGE_MONITOR
6994 #: build/C/man5/proc.5:598
6996 "The I<oom_score> also reflects the bit-shift adjustment specified by the "
6997 "I<oom_adj> setting for the process."
7001 #: build/C/man5/proc.5:598
7003 msgid "I</proc/[pid]/root>"
7007 #: build/C/man5/proc.5:606
7009 "UNIX and Linux support the idea of a per-process root of the file system, "
7010 "set by the B<chroot>(2) system call. This file is a symbolic link that "
7011 "points to the process's root directory, and behaves as exe, fd/*, etc. do."
7015 #: build/C/man5/proc.5:626
7017 msgid "I</proc/[pid]/smaps> (since Linux 2.6.14)"
7020 #. CONFIG_PROC_PAGE_MONITOR
7022 #: build/C/man5/proc.5:631
7024 "This file shows memory consumption for each of the process's mappings. For "
7025 "each of mappings there is a series of lines such as the following:"
7029 #: build/C/man5/proc.5:641
7032 "08048000-080bc000 r-xp 00000000 03:02 13130 /bin/bash\n"
7035 "Shared_Clean: 424 kB\n"
7036 "Shared_Dirty: 0 kB\n"
7037 "Private_Clean: 0 kB\n"
7038 "Private_Dirty: 0 kB\n"
7042 #: build/C/man5/proc.5:651
7044 "The first of these lines shows the same information as is displayed for the "
7045 "mapping in I</proc/[pid]/maps>. The remaining lines show the size of the "
7046 "mapping, the amount of the mapping that is currently resident in RAM, the "
7047 "number of clean and dirty shared pages in the mapping, and the number of "
7048 "clean and dirty private pages in the mapping."
7052 #: build/C/man5/proc.5:656
7054 "This file is only present if the B<CONFIG_MMU> kernel configuration option "
7059 #: build/C/man5/proc.5:656
7061 msgid "I</proc/[pid]/stat>"
7065 #: build/C/man5/proc.5:663
7067 "Status information about the process. This is used by B<ps>(1). It is "
7068 "defined in I</usr/src/linux/fs/proc/array.c>."
7072 #: build/C/man5/proc.5:667
7073 msgid "The fields, in order, with their proper B<scanf>(3) format specifiers, are:"
7077 #: build/C/man5/proc.5:668
7083 #: build/C/man5/proc.5:671
7084 msgid "The process ID."
7088 #: build/C/man5/proc.5:671
7094 #: build/C/man5/proc.5:675
7096 "The filename of the executable, in parentheses. This is visible whether or "
7097 "not the executable is swapped out."
7101 #: build/C/man5/proc.5:675
7107 #: build/C/man5/proc.5:681
7109 "One character from the string \"RSDZTW\" where R is running, S is sleeping "
7110 "in an interruptible wait, D is waiting in uninterruptible disk sleep, Z is "
7111 "zombie, T is traced or stopped (on a signal), and W is paging."
7115 #: build/C/man5/proc.5:681
7121 #: build/C/man5/proc.5:684
7122 msgid "The PID of the parent."
7126 #: build/C/man5/proc.5:684
7132 #: build/C/man5/proc.5:687
7133 msgid "The process group ID of the process."
7137 #: build/C/man5/proc.5:687
7139 msgid "I<session> %d"
7143 #: build/C/man5/proc.5:690
7144 msgid "The session ID of the process."
7148 #: build/C/man5/proc.5:690
7150 msgid "I<tty_nr> %d"
7154 #: build/C/man5/proc.5:696
7156 "The controlling terminal of the process. (The minor device number is "
7157 "contained in the combination of bits 31 to 20 and 7 to 0; the major device "
7158 "number is in bits 15 to 8.)"
7162 #: build/C/man5/proc.5:696
7167 #. This field and following, up to and including wchan added 0.99.1
7169 #: build/C/man5/proc.5:701
7171 "The ID of the foreground process group of the controlling terminal of the "
7176 #: build/C/man5/proc.5:701
7178 msgid "I<flags> %u (%lu before Linux 2.6.22)"
7182 #: build/C/man5/proc.5:708
7184 "The kernel flags word of the process. For bit meanings, see the PF_* "
7185 "defines in I<E<lt>linux/sched.hE<gt>>. Details depend on the kernel "
7190 #: build/C/man5/proc.5:708
7192 msgid "I<minflt> %lu"
7196 #: build/C/man5/proc.5:712
7198 "The number of minor faults the process has made which have not required "
7199 "loading a memory page from disk."
7204 #: build/C/man5/proc.5:712
7206 msgid "I<cminflt> %lu"
7210 #: build/C/man5/proc.5:717
7211 msgid "The number of minor faults that the process's waited-for children have made."
7215 #: build/C/man5/proc.5:717
7217 msgid "I<majflt> %lu"
7221 #: build/C/man5/proc.5:721
7223 "The number of major faults the process has made which have required loading "
7224 "a memory page from disk."
7228 #: build/C/man5/proc.5:721
7230 msgid "I<cmajflt> %lu"
7234 #: build/C/man5/proc.5:725
7235 msgid "The number of major faults that the process's waited-for children have made."
7239 #: build/C/man5/proc.5:725
7241 msgid "I<utime> %lu"
7245 #: build/C/man5/proc.5:734
7247 "Amount of time that this process has been scheduled in user mode, measured "
7248 "in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>. This includes guest "
7249 "time, I<guest_time> (time spent running a virtual CPU, see below), so that "
7250 "applications that are not aware of the guest time field do not lose that "
7251 "time from their calculations."
7255 #: build/C/man5/proc.5:734
7257 msgid "I<stime> %lu"
7261 #: build/C/man5/proc.5:739
7263 "Amount of time that this process has been scheduled in kernel mode, measured "
7264 "in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>."
7268 #: build/C/man5/proc.5:739
7270 msgid "I<cutime> %ld"
7274 #: build/C/man5/proc.5:749
7276 "Amount of time that this process's waited-for children have been scheduled "
7277 "in user mode, measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>. "
7278 "(See also B<times>(2).) This includes guest time, I<cguest_time> (time "
7279 "spent running a virtual CPU, see below)."
7283 #: build/C/man5/proc.5:749
7285 msgid "I<cstime> %ld"
7289 #: build/C/man5/proc.5:755
7291 "Amount of time that this process's waited-for children have been scheduled "
7292 "in kernel mode, measured in clock ticks (divide by I<sysconf(_SC_CLK_TCK)>."
7296 #: build/C/man5/proc.5:755
7298 msgid "I<priority> %ld"
7302 #: build/C/man5/proc.5:772
7304 "(Explanation for Linux 2.6) For processes running a real-time scheduling "
7305 "policy (I<policy> below; see B<sched_setscheduler>(2)), this is the negated "
7306 "scheduling priority, minus one; that is, a number in the range -2 to -100, "
7307 "corresponding to real-time priorities 1 to 99. For processes running under "
7308 "a non-real-time scheduling policy, this is the raw nice value "
7309 "(B<setpriority>(2)) as represented in the kernel. The kernel stores nice "
7310 "values as numbers in the range 0 (high) to 39 (low), corresponding to the "
7311 "user-visible nice range of -20 to 19."
7314 #. And back in kernel 1.2 days things were different again.
7316 #: build/C/man5/proc.5:776
7318 "Before Linux 2.6, this was a scaled value based on the scheduler weighting "
7319 "given to this process."
7323 #: build/C/man5/proc.5:776
7328 #. Back in kernel 1.2 days things were different.
7330 #: build/C/man5/proc.5:782
7332 "The nice value (see B<setpriority>(2)), a value in the range 19 (low "
7333 "priority) to -20 (high priority)."
7337 #. \fIcounter\fP %ld
7338 #. The current maximum size in jiffies of the process's next timeslice,
7339 #. or what is currently left of its current timeslice, if it is the
7340 #. currently running process.
7343 #. The time in jiffies of the process's next timeout.
7344 #. timeout was removed sometime around 2.1/2.2
7346 #: build/C/man5/proc.5:782
7348 msgid "I<num_threads> %ld"
7352 #: build/C/man5/proc.5:796
7354 "Number of threads in this process (since Linux 2.6). Before kernel 2.6, "
7355 "this field was hard coded to 0 as a placeholder for an earlier removed "
7361 #: build/C/man5/proc.5:796
7363 msgid "I<itrealvalue> %ld"
7367 #: build/C/man5/proc.5:804
7369 "The time in jiffies before the next B<SIGALRM> is sent to the process due to "
7370 "an interval timer. Since kernel 2.6.17, this field is no longer maintained, "
7371 "and is hard coded as 0."
7375 #: build/C/man5/proc.5:804
7377 msgid "I<starttime> %llu (was %lu before Linux 2.6)"
7381 #: build/C/man5/proc.5:807
7382 msgid "The time in jiffies the process started after system boot."
7386 #: build/C/man5/proc.5:807
7388 msgid "I<vsize> %lu"
7392 #: build/C/man5/proc.5:810
7393 msgid "Virtual memory size in bytes."
7397 #: build/C/man5/proc.5:810
7403 #: build/C/man5/proc.5:817
7405 "Resident Set Size: number of pages the process has in real memory. This is "
7406 "just the pages which count toward text, data, or stack space. This does not "
7407 "include pages which have not been demand-loaded in, or which are swapped "
7412 #: build/C/man5/proc.5:817
7414 msgid "I<rsslim> %lu"
7418 #: build/C/man5/proc.5:824
7420 "Current soft limit in bytes on the rss of the process; see the description "
7421 "of B<RLIMIT_RSS> in B<getpriority>(2)."
7425 #: build/C/man5/proc.5:824
7427 msgid "I<startcode> %lu"
7431 #: build/C/man5/proc.5:827
7432 msgid "The address above which program text can run."
7436 #: build/C/man5/proc.5:827
7438 msgid "I<endcode> %lu"
7442 #: build/C/man5/proc.5:830
7443 msgid "The address below which program text can run."
7447 #: build/C/man5/proc.5:830
7449 msgid "I<startstack> %lu"
7453 #: build/C/man5/proc.5:833
7454 msgid "The address of the start (i.e., bottom) of the stack."
7458 #: build/C/man5/proc.5:833
7460 msgid "I<kstkesp> %lu"
7464 #: build/C/man5/proc.5:837
7466 "The current value of ESP (stack pointer), as found in the kernel stack page "
7471 #: build/C/man5/proc.5:837
7473 msgid "I<kstkeip> %lu"
7477 #: build/C/man5/proc.5:840
7478 msgid "The current EIP (instruction pointer)."
7483 #: build/C/man5/proc.5:840
7485 msgid "I<signal> %lu"
7489 #: build/C/man5/proc.5:847
7491 "The bitmap of pending signals, displayed as a decimal number. Obsolete, "
7492 "because it does not provide information on real-time signals; use "
7493 "I</proc/[pid]/status> instead."
7497 #: build/C/man5/proc.5:847
7499 msgid "I<blocked> %lu"
7503 #: build/C/man5/proc.5:853
7505 "The bitmap of blocked signals, displayed as a decimal number. Obsolete, "
7506 "because it does not provide information on real-time signals; use "
7507 "I</proc/[pid]/status> instead."
7511 #: build/C/man5/proc.5:853
7513 msgid "I<sigignore> %lu"
7517 #: build/C/man5/proc.5:859
7519 "The bitmap of ignored signals, displayed as a decimal number. Obsolete, "
7520 "because it does not provide information on real-time signals; use "
7521 "I</proc/[pid]/status> instead."
7525 #: build/C/man5/proc.5:859
7527 msgid "I<sigcatch> %lu"
7531 #: build/C/man5/proc.5:865
7533 "The bitmap of caught signals, displayed as a decimal number. Obsolete, "
7534 "because it does not provide information on real-time signals; use "
7535 "I</proc/[pid]/status> instead."
7539 #: build/C/man5/proc.5:865
7541 msgid "I<wchan> %lu"
7545 #: build/C/man5/proc.5:875
7547 "This is the \"channel\" in which the process is waiting. It is the address "
7548 "of a system call, and can be looked up in a namelist if you need a textual "
7549 "name. (If you have an up-to-date I</etc/psdatabase>, then try I<ps -l> to "
7550 "see the WCHAN field in action.)"
7554 #: build/C/man5/proc.5:875
7556 msgid "I<nswap> %lu"
7559 #. nswap was added in 2.0
7561 #: build/C/man5/proc.5:879
7562 msgid "Number of pages swapped (not maintained)."
7566 #: build/C/man5/proc.5:879
7568 msgid "I<cnswap> %lu"
7571 #. cnswap was added in 2.0
7573 #: build/C/man5/proc.5:883
7574 msgid "Cumulative I<nswap> for child processes (not maintained)."
7578 #: build/C/man5/proc.5:883
7580 msgid "I<exit_signal> %d (since Linux 2.1.22)"
7584 #: build/C/man5/proc.5:886
7585 msgid "Signal to be sent to parent when we die."
7589 #: build/C/man5/proc.5:886
7591 msgid "I<processor> %d (since Linux 2.2.8)"
7595 #: build/C/man5/proc.5:889
7596 msgid "CPU number last executed on."
7600 #: build/C/man5/proc.5:889
7602 msgid "I<rt_priority> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
7606 #: build/C/man5/proc.5:895
7608 "Real-time scheduling priority, a number in the range 1 to 99 for processes "
7609 "scheduled under a real-time policy, or 0, for non-real-time processes (see "
7610 "B<sched_setscheduler>(2))."
7615 #: build/C/man5/proc.5:895
7617 msgid "I<policy> %u (since Linux 2.5.19; was %lu before Linux 2.6.22)"
7621 #: build/C/man5/proc.5:902
7623 "Scheduling policy (see B<sched_setscheduler>(2)). Decode using the SCHED_* "
7624 "constants in I<linux/sched.h>."
7628 #: build/C/man5/proc.5:902
7630 msgid "I<delayacct_blkio_ticks> %llu (since Linux 2.6.18)"
7634 #: build/C/man5/proc.5:905
7635 msgid "Aggregated block I/O delays, measured in clock ticks (centiseconds)."
7639 #: build/C/man5/proc.5:905
7641 msgid "I<guest_time> %lu (since Linux 2.6.24)"
7645 #: build/C/man5/proc.5:910
7647 "Guest time of the process (time spent running a virtual CPU for a guest "
7648 "operating system), measured in clock ticks (divide by "
7649 "I<sysconf(_SC_CLK_TCK)>."
7653 #: build/C/man5/proc.5:910
7655 msgid "I<cguest_time> %ld (since Linux 2.6.24)"
7659 #: build/C/man5/proc.5:914
7661 "Guest time of the process's children, measured in clock ticks (divide by "
7662 "I<sysconf(_SC_CLK_TCK)>."
7666 #: build/C/man5/proc.5:915
7668 msgid "I</proc/[pid]/statm>"
7672 #: build/C/man5/proc.5:919
7674 "Provides information about memory usage, measured in pages. The columns "
7678 #. (not including libs; broken, includes data segment)
7679 #. (including libs; broken, includes library text)
7681 #: build/C/man5/proc.5:933
7684 "size total program size\n"
7685 " (same as VmSize in I</proc/[pid]/status>)\n"
7686 "resident resident set size\n"
7687 " (same as VmRSS in I</proc/[pid]/status>)\n"
7688 "share shared pages (from shared mappings)\n"
7689 "text text (code)\n"
7690 "lib library (unused in Linux 2.6)\n"
7691 "data data + stack\n"
7692 "dt dirty pages (unused in Linux 2.6)\n"
7696 #: build/C/man5/proc.5:935
7698 msgid "I</proc/[pid]/status>"
7702 #: build/C/man5/proc.5:943
7704 "Provides much of the information in I</proc/[pid]/stat> and "
7705 "I</proc/[pid]/statm> in a format that's easier for humans to parse. Here's "
7710 #: build/C/man5/proc.5:984
7713 "$B< cat /proc/$$/status>\n"
7715 "State: S (sleeping)\n"
7720 "Uid: 1000 1000 1000 1000\n"
7721 "Gid: 100 100 100 100\n"
7723 "Groups: 16 33 100\n"
7736 "SigPnd: 0000000000000000\n"
7737 "ShdPnd: 0000000000000000\n"
7738 "SigBlk: 0000000000010000\n"
7739 "SigIgn: 0000000000384004\n"
7740 "SigCgt: 000000004b813efb\n"
7741 "CapInh: 0000000000000000\n"
7742 "CapPrm: 0000000000000000\n"
7743 "CapEff: 0000000000000000\n"
7744 "CapBnd: ffffffffffffffff\n"
7745 "Cpus_allowed: 00000001\n"
7746 "Cpus_allowed_list: 0\n"
7748 "Mems_allowed_list: 0\n"
7749 "voluntary_ctxt_switches: 150\n"
7750 "nonvoluntary_ctxt_switches: 545\n"
7754 #: build/C/man5/proc.5:988
7755 msgid "The fields are as follows:"
7759 #: build/C/man5/proc.5:992
7760 msgid "I<Name>: Command run by this process."
7764 #: build/C/man5/proc.5:1003
7766 "I<State>: Current state of the process. One of \"R (running)\", \"S "
7767 "(sleeping)\", \"D (disk sleep)\", \"T (stopped)\", \"T (tracing stop)\", \"Z "
7768 "(zombie)\", or \"X (dead)\"."
7772 #: build/C/man5/proc.5:1006
7773 msgid "I<Tgid>: Thread group ID (i.e., Process ID)."
7777 #: build/C/man5/proc.5:1010
7778 msgid "I<Pid>: Thread ID (see B<gettid>(2))."
7782 #: build/C/man5/proc.5:1013
7783 msgid "I<PPid>: PID of parent process."
7787 #: build/C/man5/proc.5:1016
7788 msgid "I<TracerPid>: PID of process tracing this process (0 if not being traced)."
7792 #: build/C/man5/proc.5:1019
7793 msgid "I<Uid>, I<Gid>: Real, effective, saved set, and file system UIDs (GIDs)."
7797 #: build/C/man5/proc.5:1022
7798 msgid "I<FDSize>: Number of file descriptor slots currently allocated."
7802 #: build/C/man5/proc.5:1025
7803 msgid "I<Groups>: Supplementary group list."
7807 #: build/C/man5/proc.5:1028
7808 msgid "I<VmPeak>: Peak virtual memory size."
7812 #: build/C/man5/proc.5:1031
7813 msgid "I<VmSize>: Virtual memory size."
7817 #: build/C/man5/proc.5:1035
7818 msgid "I<VmLck>: Locked memory size (see B<mlock>(3))."
7822 #: build/C/man5/proc.5:1038
7823 msgid "I<VmHWM>: Peak resident set size (\"high water mark\")."
7827 #: build/C/man5/proc.5:1041
7828 msgid "I<VmRSS>: Resident set size."
7832 #: build/C/man5/proc.5:1044
7833 msgid "I<VmData>, I<VmStk>, I<VmExe>: Size of data, stack, and text segments."
7837 #: build/C/man5/proc.5:1047
7838 msgid "I<VmLib>: Shared library code size."
7842 #: build/C/man5/proc.5:1050
7843 msgid "I<VmPTE>: Page table entries size (since Linux 2.6.10)."
7847 #: build/C/man5/proc.5:1053
7848 msgid "I<Threads>: Number of threads in process containing this thread."
7852 #: build/C/man5/proc.5:1064
7854 "I<SigQ>: This field contains two slash-separated numbers that relate to "
7855 "queued signals for the real user ID of this process. The first of these is "
7856 "the number of currently queued signals for this real user ID, and the second "
7857 "is the resource limit on the number of queued signals for this process (see "
7858 "the description of B<RLIMIT_SIGPENDING> in B<getrlimit>(2))."
7862 #: build/C/man5/proc.5:1070
7864 "I<SigPnd>, I<ShdPnd>: Number of signals pending for thread and for process "
7865 "as a whole (see B<pthreads>(7) and B<signal>(7))."
7869 #: build/C/man5/proc.5:1074
7871 "I<SigBlk>, I<SigIgn>, I<SigCgt>: Masks indicating signals being blocked, "
7872 "ignored, and caught (see B<signal>(7))."
7876 #: build/C/man5/proc.5:1079
7878 "I<CapInh>, I<CapPrm>, I<CapEff>: Masks of capabilities enabled in "
7879 "inheritable, permitted, and effective sets (see B<capabilities>(7))."
7883 #: build/C/man5/proc.5:1084
7885 "I<CapBnd>: Capability Bounding set (since kernel 2.6.26, see "
7886 "B<capabilities>(7))."
7890 #: build/C/man5/proc.5:1089
7892 "I<Cpus_allowed>: Mask of CPUs on which this process may run (since Linux "
7893 "2.6.24, see B<cpuset>(7))."
7897 #: build/C/man5/proc.5:1094
7899 "I<Cpus_allowed_list>: Same as previous, but in \"list format\" (since Linux "
7900 "2.6.26, see B<cpuset>(7))."
7904 #: build/C/man5/proc.5:1099
7906 "I<Mems_allowed>: Mask of memory nodes allowed to this process (since Linux "
7907 "2.6.24, see B<cpuset>(7))."
7911 #: build/C/man5/proc.5:1104
7913 "I<Mems_allowed_list>: Same as previous, but in \"list format\" (since Linux "
7914 "2.6.26, see B<cpuset>(7))."
7918 #: build/C/man5/proc.5:1107
7920 "I<voluntary_context_switches>, I<nonvoluntary_context_switches>: Number of "
7921 "voluntary and involuntary context switches (since Linux 2.6.23)."
7925 #: build/C/man5/proc.5:1108
7927 msgid "I</proc/[pid]/task> (since Linux 2.6.0-test6)"
7931 #: build/C/man5/proc.5:1139
7933 "This is a directory that contains one subdirectory for each thread in the "
7934 "process. The name of each subdirectory is the numerical thread ID "
7935 "(I<[tid]>) of the thread (see B<gettid>(2)). Within each of these "
7936 "subdirectories, there is a set of files with the same names and contents as "
7937 "under the I</proc/[pid]> directories. For attributes that are shared by all "
7938 "threads, the contents for each of the files under the I<task/[tid]> "
7939 "subdirectories will be the same as in the corresponding file in the parent "
7940 "I</proc/[pid]> directory (e.g., in a multithreaded process, all of the "
7941 "I<task/[tid]/cwd> files will have the same value as the I</proc/[pid]/cwd> "
7942 "file in the parent directory, since all of the threads in a process share a "
7943 "working directory). For attributes that are distinct for each thread, the "
7944 "corresponding files under I<task/[tid]> may have different values (e.g., "
7945 "various fields in each of the I<task/[tid]/status> files may be different "
7949 #. The following was still true as at kernel 2.6.13
7951 #: build/C/man5/proc.5:1146
7953 "In a multithreaded process, the contents of the I</proc/[pid]/task> "
7954 "directory are not available if the main thread has already terminated "
7955 "(typically by calling B<pthread_exit>(3))."
7959 #: build/C/man5/proc.5:1146
7961 msgid "I</proc/apm>"
7965 #: build/C/man5/proc.5:1151
7967 "Advanced power management version and battery information when B<CONFIG_APM> "
7968 "is defined at kernel compilation time."
7972 #: build/C/man5/proc.5:1151
7974 msgid "I</proc/bus>"
7978 #: build/C/man5/proc.5:1154
7979 msgid "Contains subdirectories for installed busses."
7983 #: build/C/man5/proc.5:1154
7985 msgid "I</proc/bus/pccard>"
7989 #: build/C/man5/proc.5:1159
7991 "Subdirectory for PCMCIA devices when B<CONFIG_PCMCIA> is set at kernel "
7996 #: build/C/man5/proc.5:1159
7998 msgid "I</proc/bus/pccard/drivers>"
8002 #: build/C/man5/proc.5:1161
8004 msgid "I</proc/bus/pci>"
8008 #: build/C/man5/proc.5:1167
8010 "Contains various bus subdirectories and pseudo-files containing information "
8011 "about PCI busses, installed devices, and device drivers. Some of these "
8012 "files are not ASCII."
8016 #: build/C/man5/proc.5:1167
8018 msgid "I</proc/bus/pci/devices>"
8022 #: build/C/man5/proc.5:1174
8024 "Information about PCI devices. They may be accessed through B<lspci>(8) "
8029 #: build/C/man5/proc.5:1174
8031 msgid "I</proc/cmdline>"
8035 #: build/C/man5/proc.5:1181
8037 "Arguments passed to the Linux kernel at boot time. Often done via a boot "
8038 "manager such as B<lilo>(8) or B<grub>(8)."
8042 #: build/C/man5/proc.5:1181
8044 msgid "I</proc/config.gz> (since Linux 2.6)"
8048 #: build/C/man5/proc.5:1199
8050 "This file exposes the configuration options that were used to build the "
8051 "currently running kernel, in the same format as they would be shown in the "
8052 "I<.config> file that resulted when configuring the kernel (using I<make "
8053 "xconfig>, I<make config>, or similar). The file contents are compressed; "
8054 "view or search them using B<zcat>(1), B<zgrep>(1), etc. As long as no "
8055 "changes have been made to the following file, the contents of "
8056 "I</proc/config.gz> are the same as those provided by :"
8060 #: build/C/man5/proc.5:1203
8062 msgid "cat /lib/modules/$(uname -r)/build/.config\n"
8066 #: build/C/man5/proc.5:1209
8068 "I</proc/config.gz> is only provided if the kernel is configured with "
8069 "B<CONFIG_IKCONFIG_PROC>."
8073 #: build/C/man5/proc.5:1209
8075 msgid "I</proc/cpuinfo>"
8079 #: build/C/man5/proc.5:1218
8081 "This is a collection of CPU and system architecture dependent items, for "
8082 "each supported architecture a different list. Two common entries are "
8083 "I<processor> which gives CPU number and I<bogomips>; a system constant that "
8084 "is calculated during kernel initialization. SMP machines have information "
8089 #: build/C/man5/proc.5:1218
8091 msgid "I</proc/devices>"
8095 #: build/C/man5/proc.5:1222
8097 "Text listing of major numbers and device groups. This can be used by "
8098 "MAKEDEV scripts for consistency with the kernel."
8102 #: build/C/man5/proc.5:1222
8104 msgid "I</proc/diskstats> (since Linux 2.5.69)"
8108 #: build/C/man5/proc.5:1228
8110 "This file contains disk I/O statistics for each disk device. See the kernel "
8111 "source file I<Documentation/iostats.txt> for further information."
8115 #: build/C/man5/proc.5:1228
8117 msgid "I</proc/dma>"
8121 #: build/C/man5/proc.5:1232
8123 "This is a list of the registered I<ISA> DMA (direct memory access) channels "
8128 #: build/C/man5/proc.5:1232
8130 msgid "I</proc/driver>"
8134 #: build/C/man5/proc.5:1235 build/C/man5/proc.5:1263
8135 msgid "Empty subdirectory."
8139 #: build/C/man5/proc.5:1235
8141 msgid "I</proc/execdomains>"
8145 #: build/C/man5/proc.5:1238
8146 msgid "List of the execution domains (ABI personalities)."
8150 #: build/C/man5/proc.5:1238
8156 #: build/C/man5/proc.5:1243
8158 "Frame buffer information when B<CONFIG_FB> is defined during kernel "
8163 #: build/C/man5/proc.5:1243
8165 msgid "I</proc/filesystems>"
8169 #: build/C/man5/proc.5:1253
8171 "A text listing of the file systems which are supported by the kernel, namely "
8172 "file systems which were compiled into the kernel or whose kernel modules are "
8173 "currently loaded. (See also B<filesystems>(5).) If a file system is marked "
8174 "with \"nodev\", this means that it does not require a block device to be "
8175 "mounted (e.g., virtual file system, network file system)."
8179 #: build/C/man5/proc.5:1260
8181 "Incidentally, this file may be used by B<mount>(8) when no file system is "
8182 "specified and it didn't manage to determine the file system type. Then file "
8183 "systems contained in this file are tried (excepted those that are marked "
8188 #: build/C/man5/proc.5:1260
8194 #: build/C/man5/proc.5:1263
8196 msgid "I</proc/ide>"
8200 #: build/C/man5/proc.5:1269
8202 "This directory exists on systems with the IDE bus. There are directories "
8203 "for each IDE channel and attached device. Files include:"
8207 #: build/C/man5/proc.5:1282
8210 "cache buffer size in KB\n"
8211 "capacity number of sectors\n"
8212 "driver driver version\n"
8213 "geometry physical and logical geometry\n"
8214 "identify in hexadecimal\n"
8215 "media media type\n"
8216 "model manufacturer's model number\n"
8217 "settings drive settings\n"
8218 "smart_thresholds in hexadecimal\n"
8219 "smart_values in hexadecimal\n"
8223 #: build/C/man5/proc.5:1288
8225 "The B<hdparm>(8) utility provides access to this information in a friendly "
8230 #: build/C/man5/proc.5:1288
8232 msgid "I</proc/interrupts>"
8236 #: build/C/man5/proc.5:1298
8238 "This is used to record the number of interrupts per CPU per IO device. "
8239 "Since Linux 2.6.24, for the i386 and x86_64 architectures, at least, this "
8240 "also includes interrupts internal to the system (that is, not associated "
8241 "with a device as such), such as NMI (nonmaskable interrupt), LOC (local "
8242 "timer interrupt), and for SMP systems, TLB (TLB flush interrupt), RES "
8243 "(rescheduling interrupt), CAL (remote function call interrupt), and possibly "
8244 "others. Very easy to read formatting, done in ASCII."
8248 #: build/C/man5/proc.5:1298
8250 msgid "I</proc/iomem>"
8254 #: build/C/man5/proc.5:1301
8255 msgid "I/O memory map in Linux 2.4."
8259 #: build/C/man5/proc.5:1301
8261 msgid "I</proc/ioports>"
8265 #: build/C/man5/proc.5:1305
8267 "This is a list of currently registered Input-Output port regions that are in "
8272 #: build/C/man5/proc.5:1305
8274 msgid "I</proc/kallsyms> (since Linux 2.5.71)"
8278 #: build/C/man5/proc.5:1313
8280 "This holds the kernel exported symbol definitions used by the B<modules>(X) "
8281 "tools to dynamically link and bind loadable modules. In Linux 2.5.47 and "
8282 "earlier, a similar file with slightly different syntax was named I<ksyms>."
8286 #: build/C/man5/proc.5:1313
8288 msgid "I</proc/kcore>"
8292 #: build/C/man5/proc.5:1322
8294 "This file represents the physical memory of the system and is stored in the "
8295 "ELF core file format. With this pseudo-file, and an unstripped kernel "
8296 "(I</usr/src/linux/vmlinux>) binary, GDB can be used to examine the current "
8297 "state of any kernel data structures."
8301 #: build/C/man5/proc.5:1325
8302 msgid "The total length of the file is the size of physical memory (RAM) plus 4KB."
8306 #: build/C/man5/proc.5:1325
8308 msgid "I</proc/kmsg>"
8312 #: build/C/man5/proc.5:1337
8314 "This file can be used instead of the B<syslog>(2) system call to read "
8315 "kernel messages. A process must have superuser privileges to read this "
8316 "file, and only one process should read this file. This file should not be "
8317 "read if a syslog process is running which uses the B<syslog>(2) system call "
8318 "facility to log kernel messages."
8322 #: build/C/man5/proc.5:1341
8323 msgid "Information in this file is retrieved with the B<dmesg>(1) program."
8327 #: build/C/man5/proc.5:1341
8329 msgid "I</proc/ksyms> (Linux 1.1.23-2.5.47)"
8333 #: build/C/man5/proc.5:1345
8334 msgid "See I</proc/kallsyms>."
8338 #: build/C/man5/proc.5:1345
8340 msgid "I</proc/loadavg>"
8344 #: build/C/man5/proc.5:1360
8346 "The first three fields in this file are load average figures giving the "
8347 "number of jobs in the run queue (state R) or waiting for disk I/O (state D) "
8348 "averaged over 1, 5, and 15 minutes. They are the same as the load average "
8349 "numbers given by B<uptime>(1) and other programs. The fourth field "
8350 "consists of two numbers separated by a slash (/). The first of these is the "
8351 "number of currently runnable kernel scheduling entities (processes, "
8352 "threads). The value after the slash is the number of kernel scheduling "
8353 "entities that currently exist on the system. The fifth field is the PID of "
8354 "the process that was most recently created on the system."
8358 #: build/C/man5/proc.5:1360
8360 msgid "I</proc/locks>"
8364 #: build/C/man5/proc.5:1366
8366 "This file shows current file locks (B<flock>(2) and B<fcntl>(2)) and leases "
8371 #: build/C/man5/proc.5:1366
8373 msgid "I</proc/malloc> (only up to and including Linux 2.2)"
8376 #. It looks like this only ever did something back in 1.0 days
8378 #: build/C/man5/proc.5:1372
8380 "This file is only present if B<CONFIG_DEBUG_MALLOC> was defined during "
8385 #: build/C/man5/proc.5:1372
8387 msgid "I</proc/meminfo>"
8391 #: build/C/man5/proc.5:1380
8393 "This file reports statistics about memory usage on the system. It is used "
8394 "by B<free>(1) to report the amount of free and used memory (both physical "
8395 "and swap) on the system as well as the shared memory and buffers used by "
8400 #: build/C/man5/proc.5:1380
8402 msgid "I</proc/modules>"
8406 #: build/C/man5/proc.5:1385
8408 "A text list of the modules that have been loaded by the system. See also "
8413 #: build/C/man5/proc.5:1385
8415 msgid "I</proc/mounts>"
8419 #: build/C/man5/proc.5:1395
8421 "Before kernel 2.4.19, this file was a list of all the file systems currently "
8422 "mounted on the system. With the introduction of per-process mount "
8423 "namespaces in Linux 2.4.19, this file became a link to I</proc/self/mounts>, "
8424 "which lists the mount points of the process's own mount namespace. The "
8425 "format of this file is documented in B<fstab>(5)."
8429 #: build/C/man5/proc.5:1395
8431 msgid "I</proc/mtrr>"
8435 #: build/C/man5/proc.5:1401
8437 "Memory Type Range Registers. See the kernel source file "
8438 "I<Documentation/mtrr.txt> for details."
8442 #: build/C/man5/proc.5:1401
8444 msgid "I</proc/net>"
8448 #: build/C/man5/proc.5:1411
8450 "various net pseudo-files, all of which give the status of some part of the "
8451 "networking layer. These files contain ASCII structures and are, therefore, "
8452 "readable with B<cat>(1). However, the standard B<netstat>(8) suite "
8453 "provides much cleaner access to these files."
8457 #: build/C/man5/proc.5:1411
8459 msgid "I</proc/net/arp>"
8463 #: build/C/man5/proc.5:1417
8465 "This holds an ASCII readable dump of the kernel ARP table used for address "
8466 "resolutions. It will show both dynamically learned and preprogrammed ARP "
8467 "entries. The format is:"
8471 #: build/C/man5/proc.5:1424
8474 "CW<IP address HW type Flags HW address Mask Device\n"
8475 "192.168.0.50 0x1 0x2 00:50:BF:25:68:F3 * eth0\n"
8476 "192.168.0.250 0x1 0xc 00:00:00:00:00:00 * eth0>\n"
8480 #: build/C/man5/proc.5:1436
8482 "Here \"IP address\" is the IPv4 address of the machine and the \"HW type\" "
8483 "is the hardware type of the address from RFC\\ 826. The flags are the "
8484 "internal flags of the ARP structure (as defined in "
8485 "I</usr/include/linux/if_arp.h>) and the \"HW address\" is the data link "
8486 "layer mapping for that IP address if it is known."
8490 #: build/C/man5/proc.5:1436
8492 msgid "I</proc/net/dev>"
8496 #: build/C/man5/proc.5:1447
8498 "The dev pseudo-file contains network device status information. This gives "
8499 "the number of received and sent packets, the number of errors and collisions "
8500 "and other basic statistics. These are used by the B<ifconfig>(8) program "
8501 "to report device status. The format is:"
8505 #: build/C/man5/proc.5:1457
8508 "CW<Inter-| Receive | "
8510 " face |bytes packets errs drop fifo frame compressed multicast|bytes "
8511 "packets errs drop fifo colls carrier compressed\n"
8512 " lo: 2776770 11307 0 0 0 0 0 0 2776770 "
8513 "11307 0 0 0 0 0 0\n"
8514 " eth0: 1215645 2751 0 0 0 0 0 0 1782404 "
8515 "4324 0 0 0 427 0 0\n"
8516 " ppp0: 1622270 5552 1 0 0 0 0 0 354130 "
8517 "5669 0 0 0 0 0 0\n"
8518 " tap0: 7714 81 0 0 0 0 0 0 7714 "
8523 #: build/C/man5/proc.5:1466
8525 msgid "I</proc/net/dev_mcast>"
8529 #: build/C/man5/proc.5:1470
8530 msgid "Defined in I</usr/src/linux/net/core/dev_mcast.c>:"
8534 #: build/C/man5/proc.5:1476
8537 "indx interface_name dmi_u dmi_g dmi_address\n"
8538 "2 eth0 1 0 01005e000001\n"
8539 "3 eth1 1 0 01005e000001\n"
8540 "4 eth2 1 0 01005e000001\n"
8544 #: build/C/man5/proc.5:1478
8546 msgid "I</proc/net/igmp>"
8550 #: build/C/man5/proc.5:1483
8552 "Internet Group Management Protocol. Defined in "
8553 "I</usr/src/linux/net/core/igmp.c>."
8557 #: build/C/man5/proc.5:1483
8559 msgid "I</proc/net/rarp>"
8563 #: build/C/man5/proc.5:1493
8565 "This file uses the same format as the I<arp> file and contains the current "
8566 "reverse mapping database used to provide B<rarp>(8) reverse address lookup "
8567 "services. If RARP is not configured into the kernel, this file will not be "
8572 #: build/C/man5/proc.5:1493
8574 msgid "I</proc/net/raw>"
8578 #. .I /proc/net/route
8579 #. No information, but looks similar to
8582 #: build/C/man5/proc.5:1513
8584 "Holds a dump of the RAW socket table. Much of the information is not of use "
8585 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
8586 "socket, the \"local_address\" is the local address and protocol number "
8587 "pair. \\&\"St\" is the internal status of the socket. The \"tx_queue\" and "
8588 "\"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
8589 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
8590 "used by RAW. The \"uid\" field holds the effective UID of the creator of "
8595 #: build/C/man5/proc.5:1513
8597 msgid "I</proc/net/snmp>"
8601 #: build/C/man5/proc.5:1518
8603 "This file holds the ASCII data needed for the IP, ICMP, TCP, and UDP "
8604 "management information bases for an SNMP agent."
8608 #: build/C/man5/proc.5:1518
8610 msgid "I</proc/net/tcp>"
8614 #: build/C/man5/proc.5:1534
8616 "Holds a dump of the TCP socket table. Much of the information is not of use "
8617 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
8618 "socket, the \"local_address\" is the local address and port number pair. "
8619 "The \"rem_address\" is the remote address and port number pair (if "
8620 "connected). \\&\"St\" is the internal status of the socket. The "
8621 "\"tx_queue\" and \"rx_queue\" are the outgoing and incoming data queue in "
8622 "terms of kernel memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" "
8623 "fields hold internal information of the kernel socket state and are only "
8624 "useful for debugging. The \"uid\" field holds the effective UID of the "
8625 "creator of the socket."
8629 #: build/C/man5/proc.5:1534
8631 msgid "I</proc/net/udp>"
8635 #: build/C/man5/proc.5:1550
8637 "Holds a dump of the UDP socket table. Much of the information is not of use "
8638 "apart from debugging. The \"sl\" value is the kernel hash slot for the "
8639 "socket, the \"local_address\" is the local address and port number pair. "
8640 "The \"rem_address\" is the remote address and port number pair (if "
8641 "connected). \"St\" is the internal status of the socket. The \"tx_queue\" "
8642 "and \"rx_queue\" are the outgoing and incoming data queue in terms of kernel "
8643 "memory usage. The \"tr\", \"tm-E<gt>when\", and \"rexmits\" fields are not "
8644 "used by UDP. The \"uid\" field holds the effective UID of the creator of "
8645 "the socket. The format is:"
8649 #: build/C/man5/proc.5:1558
8652 "CW<sl local_address rem_address st tx_queue rx_queue tr rexmits "
8653 "tm-E<gt>when uid\n"
8654 " 1: 01642C89:0201 0C642C89:03FF 01 00000000:00000001 01:000071BA 00000000 "
8656 " 1: 00000000:0801 00000000:0000 0A 00000000:00000000 00:00000000 6F000100 "
8658 " 1: 00000000:0201 00000000:0000 0A 00000000:00000000 00:00000000 00000000 "
8663 #: build/C/man5/proc.5:1561
8665 msgid "I</proc/net/unix>"
8669 #: build/C/man5/proc.5:1566
8671 "Lists the UNIX domain sockets present within the system and their status. "
8676 #: build/C/man5/proc.5:1572
8679 "CW<Num RefCount Protocol Flags Type St Path\n"
8680 " 0: 00000002 00000000 00000000 0001 03\n"
8681 " 1: 00000001 00000000 00010000 0001 01 /dev/printer>\n"
8685 #: build/C/man5/proc.5:1584
8687 "Here \"Num\" is the kernel table slot number, \"RefCount\" is the number of "
8688 "users of the socket, \"Protocol\" is currently always 0, \"Flags\" represent "
8689 "the internal kernel flags holding the status of the socket. Currently, type "
8690 "is always \"1\" (UNIX domain datagram sockets are not yet supported in the "
8691 "kernel). \\&\"St\" is the internal state of the socket and Path is the "
8692 "bound path (if any) of the socket."
8696 #: build/C/man5/proc.5:1584
8698 msgid "I</proc/partitions>"
8702 #: build/C/man5/proc.5:1588
8704 "Contains major and minor numbers of each partition as well as number of "
8705 "blocks and partition name."
8709 #: build/C/man5/proc.5:1588
8711 msgid "I</proc/pci>"
8715 #: build/C/man5/proc.5:1592
8717 "This is a listing of all PCI devices found during kernel initialization and "
8718 "their configuration."
8721 #. FIXME /proc/sched_debug
8723 #. .IR /proc/sched_debug " (since Linux 2.6.23)"
8724 #. See also /proc/[pid]/sched
8726 #: build/C/man5/proc.5:1608
8728 "This file has been deprecated in favor of a new I</proc> interface for PCI "
8729 "(I</proc/bus/pci>). It became optional in Linux 2.2 (available with "
8730 "B<CONFIG_PCI_OLD_PROC> set at kernel compilation). It became once more "
8731 "nonoptionally enabled in Linux 2.4. Next, it was deprecated in Linux 2.6 "
8732 "(still available with B<CONFIG_PCI_LEGACY_PROC> set), and finally removed "
8733 "altogether since Linux 2.6.17."
8737 #: build/C/man5/proc.5:1608
8739 msgid "I</proc/scsi>"
8743 #: build/C/man5/proc.5:1618
8745 "A directory with the I<scsi> mid-level pseudo-file and various SCSI "
8746 "low-level driver directories, which contain a file for each SCSI host in "
8747 "this system, all of which give the status of some part of the SCSI IO "
8748 "subsystem. These files contain ASCII structures and are, therefore, "
8749 "readable with B<cat>(1)."
8753 #: build/C/man5/proc.5:1621
8755 "You can also write to some of the files to reconfigure the subsystem or "
8756 "switch certain features on or off."
8760 #: build/C/man5/proc.5:1621
8762 msgid "I</proc/scsi/scsi>"
8766 #: build/C/man5/proc.5:1627
8768 "This is a listing of all SCSI devices known to the kernel. The listing is "
8769 "similar to the one seen during bootup. scsi currently supports only the "
8770 "I<add-single-device> command which allows root to add a hotplugged device to "
8771 "the list of known devices."
8775 #: build/C/man5/proc.5:1629
8780 #: build/C/man5/proc.5:1633
8782 msgid "echo \\(aqscsi add-single-device 1 0 5 0\\(aq E<gt> /proc/scsi/scsi\n"
8786 #: build/C/man5/proc.5:1641
8788 "will cause host scsi1 to scan on SCSI channel 0 for a device on ID 5 LUN 0. "
8789 "If there is already a device known on this address or the address is "
8790 "invalid, an error will be returned."
8794 #: build/C/man5/proc.5:1641
8796 msgid "I</proc/scsi/[drivername]>"
8800 #: build/C/man5/proc.5:1651
8802 "I<[drivername]> can currently be NCR53c7xx, aha152x, aha1542, aha1740, "
8803 "aic7xxx, buslogic, eata_dma, eata_pio, fdomain, in2000, pas16, qlogic, "
8804 "scsi_debug, seagate, t128, u15-24f, ultrastore, or wd7000. These "
8805 "directories show up for all drivers that registered at least one SCSI HBA. "
8806 "Every directory contains one file per registered host. Every host-file is "
8807 "named after the number the host was assigned during initialization."
8811 #: build/C/man5/proc.5:1654
8813 "Reading these files will usually show driver and host configuration, "
8818 #: build/C/man5/proc.5:1661
8820 "Writing to these files allows different things on different hosts. For "
8821 "example, with the I<latency> and I<nolatency> commands, root can switch on "
8822 "and off command latency measurement code in the eata_dma driver. With the "
8823 "I<lockup> and I<unlock> commands, root can control bus lockups simulated by "
8824 "the scsi_debug driver."
8828 #: build/C/man5/proc.5:1661
8830 msgid "I</proc/self>"
8834 #: build/C/man5/proc.5:1669
8836 "This directory refers to the process accessing the I</proc> file system, and "
8837 "is identical to the I</proc> directory named by the process ID of the same "
8842 #: build/C/man5/proc.5:1669
8844 msgid "I</proc/slabinfo>"
8848 #: build/C/man5/proc.5:1678
8850 "Information about kernel caches. Since Linux 2.6.16 this file is only "
8851 "present if the B<CONFIG_SLAB> kernel configuration option is enabled. The "
8852 "columns in I</proc/slabinfo> are:"
8856 #: build/C/man5/proc.5:1688
8863 "num-active-slabs\n"
8865 "num-pages-per-slab\n"
8869 #: build/C/man5/proc.5:1694
8870 msgid "See B<slabinfo>(5) for details."
8874 #: build/C/man5/proc.5:1694
8876 msgid "I</proc/stat>"
8880 #: build/C/man5/proc.5:1700
8882 "kernel/system statistics. Varies with architecture. Common entries "
8887 #: build/C/man5/proc.5:1701
8889 msgid "I<cpu 3357 0 4313 1362393>"
8892 #. 1024 on Alpha and ia64
8893 #. FIXME Actually, the following info about the /proc/stat 'cpu' field
8894 #. does not seem to be quite right (at least in 2.6.12)
8896 #: build/C/man5/proc.5:1715
8898 "The amount of time, measured in units of USER_HZ (1/100ths of a second on "
8899 "most architectures, use I<sysconf(_SC_CLK_TCK)> to obtain the right value), "
8900 "that the system spent in user mode, user mode with low priority (nice), "
8901 "system mode, and the idle task, respectively. The last value should be "
8902 "USER_HZ times the second entry in the uptime pseudo-file."
8906 #: build/C/man5/proc.5:1723
8908 "In Linux 2.6 this line includes three additional columns: I<iowait> - time "
8909 "waiting for I/O to complete (since 2.5.41); I<irq> - time servicing "
8910 "interrupts (since 2.6.0-test4); I<softirq> - time servicing softirqs (since "
8915 #: build/C/man5/proc.5:1728
8917 "Since Linux 2.6.11, there is an eighth column, I<steal> - stolen time, which "
8918 "is the time spent in other operating systems when running in a virtualized "
8922 #. See Changelog entry for 5e84cfde51cf303d368fcb48f22059f37b3872de
8924 #: build/C/man5/proc.5:1734
8926 "Since Linux 2.6.24, there is a ninth column, I<guest>, which is the time "
8927 "spent running a virtual CPU for guest operating systems under the control of "
8932 #: build/C/man5/proc.5:1734
8934 msgid "I<page 5741 1808>"
8938 #: build/C/man5/proc.5:1738
8940 "The number of pages the system paged in and the number that were paged out "
8945 #: build/C/man5/proc.5:1738
8951 #: build/C/man5/proc.5:1741
8952 msgid "The number of swap pages that have been brought in and out."
8955 #. FIXME The following is not the full picture for the 'intr' of
8956 #. /proc/stat on 2.6:
8958 #: build/C/man5/proc.5:1741
8960 msgid "I<intr 1462898>"
8964 #: build/C/man5/proc.5:1749
8966 "This line shows counts of interrupts serviced since boot time, for each of "
8967 "the possible system interrupts. The first column is the total of all "
8968 "interrupts serviced; each subsequent column is the total for a particular "
8973 #: build/C/man5/proc.5:1749
8975 msgid "I<disk_io: (2,0):(31,30,5764,1,2) (3,0):>..."
8979 #: build/C/man5/proc.5:1752
8981 "(major,disk_idx):(noinfo, read_io_ops, blks_read, write_io_ops, "
8986 #: build/C/man5/proc.5:1754
8987 msgid "(Linux 2.4 only)"
8991 #: build/C/man5/proc.5:1754
8993 msgid "I<ctxt 115315>"
8997 #: build/C/man5/proc.5:1757
8998 msgid "The number of context switches that the system underwent."
9002 #: build/C/man5/proc.5:1757
9004 msgid "I<btime 769041601>"
9008 #: build/C/man5/proc.5:1760
9009 msgid "boot time, in seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
9013 #: build/C/man5/proc.5:1760
9015 msgid "I<processes 86031>"
9019 #: build/C/man5/proc.5:1763
9020 msgid "Number of forks since boot."
9024 #: build/C/man5/proc.5:1763
9026 msgid "I<procs_running 6>"
9030 #: build/C/man5/proc.5:1767
9031 msgid "Number of processes in runnable state. (Linux 2.5.45 onward.)"
9035 #: build/C/man5/proc.5:1767
9037 msgid "I<procs_blocked 2>"
9041 #: build/C/man5/proc.5:1771
9043 "Number of processes blocked waiting for I/O to complete. (Linux 2.5.45 "
9048 #: build/C/man5/proc.5:1772
9050 msgid "I</proc/swaps>"
9054 #: build/C/man5/proc.5:1777
9055 msgid "Swap areas in use. See also B<swapon>(8)."
9059 #: build/C/man5/proc.5:1777
9061 msgid "I</proc/sys>"
9065 #: build/C/man5/proc.5:1785
9067 "This directory (present since 1.3.57) contains a number of files and "
9068 "subdirectories corresponding to kernel variables. These variables can be "
9069 "read and sometimes modified using the I</proc> file system, and the "
9070 "(deprecated) B<sysctl>(2) system call."
9074 #: build/C/man5/proc.5:1785
9076 msgid "I</proc/sys/abi> (since Linux 2.4.10)"
9079 #. On some systems, it is not present.
9081 #: build/C/man5/proc.5:1792
9083 "This directory may contain files with application binary information. See "
9084 "the kernel source file I<Documentation/sysctl/abi.txt> for more information."
9088 #: build/C/man5/proc.5:1792
9090 msgid "I</proc/sys/debug>"
9094 #: build/C/man5/proc.5:1795 build/C/man5/proc.5:2434
9095 msgid "This directory may be empty."
9099 #: build/C/man5/proc.5:1795
9101 msgid "I</proc/sys/dev>"
9105 #: build/C/man5/proc.5:1801
9107 "This directory contains device-specific information (e.g., "
9108 "I<dev/cdrom/info>). On some systems, it may be empty."
9112 #: build/C/man5/proc.5:1801
9114 msgid "I</proc/sys/fs>"
9118 #: build/C/man5/proc.5:1805
9120 "This directory contains the files and subdirectories for kernel variables "
9121 "related to file systems."
9125 #: build/C/man5/proc.5:1805
9127 msgid "I</proc/sys/fs/binfmt_misc>"
9131 #: build/C/man5/proc.5:1810
9133 "Documentation for files in this directory can be found in the kernel sources "
9134 "in I<Documentation/binfmt_misc.txt>."
9138 #: build/C/man5/proc.5:1810
9140 msgid "I</proc/sys/fs/dentry-state> (since Linux 2.2)"
9144 #: build/C/man5/proc.5:1818
9146 "This file contains information about the status of the directory cache "
9147 "(dcache). The file contains six numbers, I<nr_dentry>, I<nr_unused>, "
9148 "I<age_limit> (age in seconds), I<want_pages> (pages requested by system) and "
9153 #: build/C/man5/proc.5:1823
9155 "I<nr_dentry> is the number of allocated dentries (dcache entries). This "
9156 "field is unused in Linux 2.2."
9160 #: build/C/man5/proc.5:1826
9161 msgid "I<nr_unused> is the number of unused dentries."
9164 #. looks like this is unused in kernels 2.2 to 2.6
9166 #: build/C/man5/proc.5:1831
9168 "I<age_limit> is the age in seconds after which dcache entries can be "
9169 "reclaimed when memory is short."
9172 #. looks like this is unused in kernels 2.2 to 2.6
9174 #: build/C/man5/proc.5:1836
9176 "I<want_pages> is nonzero when the kernel has called shrink_dcache_pages() "
9177 "and the dcache isn't pruned yet."
9181 #: build/C/man5/proc.5:1837
9183 msgid "I</proc/sys/fs/dir-notify-enable>"
9187 #: build/C/man5/proc.5:1846
9189 "This file can be used to disable or enable the I<dnotify> interface "
9190 "described in B<fcntl>(2) on a system-wide basis. A value of 0 in this file "
9191 "disables the interface, and a value of 1 enables it."
9195 #: build/C/man5/proc.5:1846
9197 msgid "I</proc/sys/fs/dquot-max>"
9201 #: build/C/man5/proc.5:1853
9203 "This file shows the maximum number of cached disk quota entries. On some "
9204 "(2.4) systems, it is not present. If the number of free cached disk quota "
9205 "entries is very low and you have some awesome number of simultaneous system "
9206 "users, you might want to raise the limit."
9210 #: build/C/man5/proc.5:1853
9212 msgid "I</proc/sys/fs/dquot-nr>"
9216 #: build/C/man5/proc.5:1857
9218 "This file shows the number of allocated disk quota entries and the number of "
9219 "free disk quota entries."
9223 #: build/C/man5/proc.5:1857
9225 msgid "I</proc/sys/fs/epoll> (since Linux 2.6.28)"
9229 #: build/C/man5/proc.5:1866
9231 "This directory contains the file I<max_user_watches>, which can be used to "
9232 "limit the amount of kernel memory consumed by the I<epoll> interface. For "
9233 "further details, see B<epoll>(7)."
9237 #: build/C/man5/proc.5:1866
9239 msgid "I</proc/sys/fs/file-max>"
9243 #: build/C/man5/proc.5:1878
9245 "This file defines a system-wide limit on the number of open files for all "
9246 "processes. (See also B<setrlimit>(2), which can be used by a process to set "
9247 "the per-process limit, B<RLIMIT_NOFILE>, on the number of files it may "
9248 "open.) If you get lots of error messages about running out of file handles, "
9249 "try increasing this value:"
9253 #: build/C/man5/proc.5:1884
9255 msgid "CW<echo 100000 E<gt> /proc/sys/fs/file-max>\n"
9259 #: build/C/man5/proc.5:1891
9261 "The kernel constant B<NR_OPEN> imposes an upper limit on the value that may "
9262 "be placed in I<file-max>."
9266 #: build/C/man5/proc.5:1900
9268 "If you increase I</proc/sys/fs/file-max>, be sure to increase "
9269 "I</proc/sys/fs/inode-max> to 3-4 times the new value of "
9270 "I</proc/sys/fs/file-max>, or you will run out of inodes."
9274 #: build/C/man5/proc.5:1900
9276 msgid "I</proc/sys/fs/file-nr>"
9280 #: build/C/man5/proc.5:1912
9282 "This (read-only) file gives the number of files presently opened. It "
9283 "contains three numbers: the number of allocated file handles; the number of "
9284 "free file handles; and the maximum number of file handles. The kernel "
9285 "allocates file handles dynamically, but it doesn't free them again. If the "
9286 "number of allocated files is close to the maximum, you should consider "
9287 "increasing the maximum. When the number of free file handles is large, "
9288 "you've encountered a peak in your usage of file handles and you probably "
9289 "don't need to increase the maximum."
9293 #: build/C/man5/proc.5:1912
9295 msgid "I</proc/sys/fs/inode-max>"
9299 #: build/C/man5/proc.5:1922
9301 "This file contains the maximum number of in-memory inodes. On some (2.4) "
9302 "systems, it may not be present. This value should be 3-4 times larger than "
9303 "the value in I<file-max>, since I<stdin>, I<stdout> and network sockets also "
9304 "need an inode to handle them. When you regularly run out of inodes, you "
9305 "need to increase this value."
9309 #: build/C/man5/proc.5:1922
9311 msgid "I</proc/sys/fs/inode-nr>"
9315 #: build/C/man5/proc.5:1926
9316 msgid "This file contains the first two values from I<inode-state>."
9320 #: build/C/man5/proc.5:1926
9322 msgid "I</proc/sys/fs/inode-state>"
9326 #: build/C/man5/proc.5:1947
9328 "This file contains seven numbers: I<nr_inodes>, I<nr_free_inodes>, "
9329 "I<preshrink>, and four dummy values. I<nr_inodes> is the number of inodes "
9330 "the system has allocated. This can be slightly more than I<inode-max> "
9331 "because Linux allocates them one page full at a time. I<nr_free_inodes> "
9332 "represents the number of free inodes. I<preshrink> is nonzero when the "
9333 "I<nr_inodes> E<gt> I<inode-max> and the system needs to prune the inode list "
9334 "instead of allocating more."
9338 #: build/C/man5/proc.5:1947
9340 msgid "I</proc/sys/fs/inotify> (since Linux 2.6.13)"
9344 #: build/C/man5/proc.5:1956
9346 "This directory contains files I<max_queued_events>, I<max_user_instances>, "
9347 "and I<max_user_watches>, that can be used to limit the amount of kernel "
9348 "memory consumed by the I<inotify> interface. For further details, see "
9353 #: build/C/man5/proc.5:1956
9355 msgid "I</proc/sys/fs/lease-break-time>"
9359 #: build/C/man5/proc.5:1965
9361 "This file specifies the grace period that the kernel grants to a process "
9362 "holding a file lease (B<fcntl>(2)) after it has sent a signal to that "
9363 "process notifying it that another process is waiting to open the file. If "
9364 "the lease holder does not remove or downgrade the lease within this grace "
9365 "period, the kernel forcibly breaks the lease."
9369 #: build/C/man5/proc.5:1965
9371 msgid "I</proc/sys/fs/leases-enable>"
9375 #: build/C/man5/proc.5:1972
9377 "This file can be used to enable or disable file leases (B<fcntl>(2)) on a "
9378 "system-wide basis. If this file contains the value 0, leases are disabled. "
9379 "A nonzero value enables leases."
9383 #: build/C/man5/proc.5:1972
9385 msgid "I</proc/sys/fs/mqueue> (since Linux 2.6.6)"
9389 #: build/C/man5/proc.5:1980
9391 "This directory contains files I<msg_max>, I<msgsize_max>, and I<queues_max>, "
9392 "controlling the resources used by POSIX message queues. See "
9393 "B<mq_overview>(7) for details."
9397 #: build/C/man5/proc.5:1980
9399 msgid "I</proc/sys/fs/overflowgid> and I</proc/sys/fs/overflowuid>"
9403 #: build/C/man5/proc.5:1990
9405 "These files allow you to change the value of the fixed UID and GID. The "
9406 "default is 65534. Some file systems only support 16-bit UIDs and GIDs, "
9407 "although in Linux UIDs and GIDs are 32 bits. When one of these file systems "
9408 "is mounted with writes enabled, any UID or GID that would exceed 65535 is "
9409 "translated to the overflow value before being written to disk."
9413 #: build/C/man5/proc.5:1990
9415 msgid "I</proc/sys/fs/pipe-max-size> (since Linux 2.6.35)"
9419 #: build/C/man5/proc.5:2004
9421 "The value in this file defines an upper limit for raising the capacity of a "
9422 "pipe using the B<fcntl>(2) B<F_SETPIPE_SZ> operation. This limit applies "
9423 "only to unprivileged processes. The default value for this file is "
9424 "1,048,576. The value assigned to this file may be rounded upward, to "
9425 "reflect the value actually employed for a convenient implementation. To "
9426 "determine the rounded-up value, display the contents of this file after "
9427 "assigning a value to it. The minimum value that can be assigned to this "
9428 "file is the system page size."
9432 #: build/C/man5/proc.5:2004
9434 msgid "I</proc/sys/fs/suid_dumpable> (since Linux 2.6.13)"
9437 #. The following is based on text from Documentation/sysctl/kernel.txt
9439 #: build/C/man5/proc.5:2010
9441 "The value in this file determines whether core dump files are produced for "
9442 "set-user-ID or otherwise protected/tainted binaries. Three different "
9443 "integer values can be specified:"
9447 #: build/C/man5/proc.5:2019
9449 "I<0\\ (default)> This provides the traditional (pre-Linux 2.6.13) behavior. "
9450 "A core dump will not be produced for a process which has changed credentials "
9451 "(by calling B<seteuid>(2), B<setgid>(2), or similar, or by executing a "
9452 "set-user-ID or set-group-ID program) or whose binary does not have read "
9453 "permission enabled."
9457 #: build/C/man5/proc.5:2026
9459 "I<1\\ (\"debug\")> All processes dump core when possible. The core dump is "
9460 "owned by the file system user ID of the dumping process and no security is "
9461 "applied. This is intended for system debugging situations only. Ptrace is "
9466 #: build/C/man5/proc.5:2035
9468 "I<2\\ (\"suidsafe\")> Any binary which normally would not be dumped (see "
9469 "\"0\" above) is dumped readable by root only. This allows the user to "
9470 "remove the core dump file but not to read it. For security reasons core "
9471 "dumps in this mode will not overwrite one another or other files. This mode "
9472 "is appropriate when administrators are attempting to debug problems in a "
9473 "normal environment."
9477 #: build/C/man5/proc.5:2035
9479 msgid "I</proc/sys/fs/super-max>"
9483 #: build/C/man5/proc.5:2046
9485 "This file controls the maximum number of superblocks, and thus the maximum "
9486 "number of mounted file systems the kernel can have. You only need to "
9487 "increase I<super-max> if you need to mount more file systems than the "
9488 "current value in I<super-max> allows you to."
9492 #: build/C/man5/proc.5:2046
9494 msgid "I</proc/sys/fs/super-nr>"
9498 #: build/C/man5/proc.5:2050
9499 msgid "This file contains the number of file systems currently mounted."
9503 #: build/C/man5/proc.5:2050
9505 msgid "I</proc/sys/kernel>"
9509 #: build/C/man5/proc.5:2054
9511 "This directory contains files controlling a range of kernel parameters, as "
9516 #: build/C/man5/proc.5:2054
9518 msgid "I</proc/sys/kernel/acct>"
9522 #: build/C/man5/proc.5:2078
9524 "This file contains three numbers: I<highwater>, I<lowwater>, and "
9525 "I<frequency>. If BSD-style process accounting is enabled these values "
9526 "control its behavior. If free space on file system where the log lives goes "
9527 "below I<lowwater> percent accounting suspends. If free space gets above "
9528 "I<highwater> percent accounting resumes. I<frequency> determines how often "
9529 "the kernel checks the amount of free space (value is in seconds). Default "
9530 "values are 4, 2 and 30. That is, suspend accounting if 2% or less space is "
9531 "free; resume it if 4% or more space is free; consider information about "
9532 "amount of free space valid for 30 seconds."
9536 #: build/C/man5/proc.5:2078
9538 msgid "I</proc/sys/kernel/cap-bound> (from Linux 2.2 to 2.6.24)"
9542 #: build/C/man5/proc.5:2090
9544 "This file holds the value of the kernel I<capability bounding set> "
9545 "(expressed as a signed decimal number). This set is ANDed against the "
9546 "capabilities permitted to a process during B<execve>(2). Starting with "
9547 "Linux 2.6.25, the system-wide capability bounding set disappeared, and was "
9548 "replaced by a per-thread bounding set; see B<capabilities>(7)."
9552 #: build/C/man5/proc.5:2090
9554 msgid "I</proc/sys/kernel/core_pattern>"
9558 #: build/C/man5/proc.5:2094
9560 msgid "I</proc/sys/kernel/core_uses_pid>"
9564 #: build/C/man5/proc.5:2098
9566 msgid "I</proc/sys/kernel/ctrl-alt-del>"
9570 #: build/C/man5/proc.5:2113
9572 "This file controls the handling of Ctrl-Alt-Del from the keyboard. When the "
9573 "value in this file is 0, Ctrl-Alt-Del is trapped and sent to the B<init>(8) "
9574 "program to handle a graceful restart. When the value is greater than zero, "
9575 "Linux's reaction to a Vulcan Nerve Pinch (tm) will be an immediate reboot, "
9576 "without even syncing its dirty buffers. Note: when a program (like dosemu) "
9577 "has the keyboard in \"raw\" mode, the ctrl-alt-del is intercepted by the "
9578 "program before it ever reaches the kernel tty layer, and it's up to the "
9579 "program to decide what to do with it."
9583 #: build/C/man5/proc.5:2113
9585 msgid "I</proc/sys/kernel/hotplug>"
9589 #: build/C/man5/proc.5:2119
9591 "This file contains the path for the hotplug policy agent. The default value "
9592 "in this file is I</sbin/hotplug>."
9596 #: build/C/man5/proc.5:2119
9598 msgid "I</proc/sys/kernel/domainname> and I</proc/sys/kernel/hostname>"
9602 #: build/C/man5/proc.5:2127
9604 "can be used to set the NIS/YP domainname and the hostname of your box in "
9605 "exactly the same way as the commands B<domainname>(1) and B<hostname>(1), "
9610 #: build/C/man5/proc.5:2132
9613 "#B< echo \\(aqdarkstar\\(aq E<gt> /proc/sys/kernel/hostname>\n"
9614 "#B< echo \\(aqmydomain\\(aq E<gt> /proc/sys/kernel/domainname>\n"
9618 #: build/C/man5/proc.5:2136
9619 msgid "has the same effect as"
9623 #: build/C/man5/proc.5:2141
9626 "#B< hostname \\(aqdarkstar\\(aq>\n"
9627 "#B< domainname \\(aqmydomain\\(aq>\n"
9631 #: build/C/man5/proc.5:2154
9633 "Note, however, that the classic darkstar.frop.org has the hostname "
9634 "\"darkstar\" and DNS (Internet Domain Name Server) domainname \"frop.org\", "
9635 "not to be confused with the NIS (Network Information Service) or YP (Yellow "
9636 "Pages) domainname. These two domain names are in general different. For a "
9637 "detailed discussion see the B<hostname>(1) man page."
9641 #: build/C/man5/proc.5:2154
9643 msgid "I</proc/sys/kernel/htab-reclaim>"
9647 #: build/C/man5/proc.5:2162
9649 "(PowerPC only) If this file is set to a nonzero value, the PowerPC htab (see "
9650 "kernel file I<Documentation/powerpc/ppc_htab.txt>) is pruned each time the "
9651 "system hits the idle loop."
9655 #: build/C/man5/proc.5:2162
9657 msgid "I</proc/sys/kernel/l2cr>"
9661 #: build/C/man5/proc.5:2169
9663 "(PowerPC only) This file contains a flag that controls the L2 cache of G3 "
9664 "processor boards. If 0, the cache is disabled. Enabled if nonzero."
9668 #: build/C/man5/proc.5:2169
9670 msgid "I</proc/sys/kernel/modprobe>"
9674 #: build/C/man5/proc.5:2180
9676 "This file contains the path for the kernel module loader. The default value "
9677 "is I</sbin/modprobe>. The file is only present if the kernel is built with "
9678 "the B<CONFIG_KMOD> option enabled. It is described by the kernel source "
9679 "file I<Documentation/kmod.txt> (only present in kernel 2.4 and earlier)."
9683 #: build/C/man5/proc.5:2180
9685 msgid "I</proc/sys/kernel/msgmax>"
9689 #: build/C/man5/proc.5:2185
9691 "This file defines a system-wide limit specifying the maximum number of bytes "
9692 "in a single message written on a System V message queue."
9696 #: build/C/man5/proc.5:2185
9698 msgid "I</proc/sys/kernel/msgmni>"
9702 #: build/C/man5/proc.5:2190
9704 "This file defines the system-wide limit on the number of message queue "
9705 "identifiers. (This file is only present in Linux 2.4 onward.)"
9709 #: build/C/man5/proc.5:2190
9711 msgid "I</proc/sys/kernel/msgmnb>"
9715 #: build/C/man5/proc.5:2199
9717 "This file defines a system-wide parameter used to initialize the "
9718 "I<msg_qbytes> setting for subsequently created message queues. The "
9719 "I<msg_qbytes> setting specifies the maximum number of bytes that may be "
9720 "written to the message queue."
9724 #: build/C/man5/proc.5:2199
9726 msgid "I</proc/sys/kernel/ostype> and I</proc/sys/kernel/osrelease>"
9730 #: build/C/man5/proc.5:2204
9731 msgid "These files give substrings of I</proc/version>."
9735 #: build/C/man5/proc.5:2204
9737 msgid "I</proc/sys/kernel/overflowgid> and I</proc/sys/kernel/overflowuid>"
9741 #: build/C/man5/proc.5:2210
9743 "These files duplicate the files I</proc/sys/fs/overflowgid> and "
9744 "I</proc/sys/fs/overflowuid>."
9748 #: build/C/man5/proc.5:2210
9750 msgid "I</proc/sys/kernel/panic>"
9754 #: build/C/man5/proc.5:2219
9756 "This file gives read/write access to the kernel variable I<panic_timeout>. "
9757 "If this is zero, the kernel will loop on a panic; if nonzero it indicates "
9758 "that the kernel should autoreboot after this number of seconds. When you "
9759 "use the software watchdog device driver, the recommended setting is 60."
9763 #: build/C/man5/proc.5:2219
9765 msgid "I</proc/sys/kernel/panic_on_oops> (since Linux 2.5.68)"
9769 #: build/C/man5/proc.5:2231
9771 "This file controls the kernel's behavior when an oops or BUG is "
9772 "encountered. If this file contains 0, then the system tries to continue "
9773 "operation. If it contains 1, then the system delays a few seconds (to give "
9774 "klogd time to record the oops output) and then panics. If the "
9775 "I</proc/sys/kernel/panic> file is also nonzero then the machine will be "
9780 #: build/C/man5/proc.5:2231
9782 msgid "I</proc/sys/kernel/pid_max> (since Linux 2.5.34)"
9785 #. Prior to 2.6.10, pid_max could also be raised above 32768 on 32-bit
9786 #. platforms, but this broke /proc/[pid]
9787 #. See http://marc.theaimsgroup.com/?l=linux-kernel&m=109513010926152&w=2
9789 #: build/C/man5/proc.5:2247
9791 "This file specifies the value at which PIDs wrap around (i.e., the value in "
9792 "this file is one greater than the maximum PID). The default value for this "
9793 "file, 32768, results in the same range of PIDs as on earlier kernels. On "
9794 "32-bit platforms, 32768 is the maximum value for I<pid_max>. On 64-bit "
9795 "systems, I<pid_max> can be set to any value up to 2^22 (B<PID_MAX_LIMIT>, "
9796 "approximately 4 million)."
9800 #: build/C/man5/proc.5:2247
9802 msgid "I</proc/sys/kernel/powersave-nap> (PowerPC only)"
9806 #: build/C/man5/proc.5:2253
9808 "This file contains a flag. If set, Linux-PPC will use the \"nap\" mode of "
9809 "powersaving, otherwise the \"doze\" mode will be used."
9813 #: build/C/man5/proc.5:2253
9815 msgid "I</proc/sys/kernel/printk>"
9819 #: build/C/man5/proc.5:2279
9821 "The four values in this file are I<console_loglevel>, "
9822 "I<default_message_loglevel>, I<minimum_console_level>, and "
9823 "I<default_console_loglevel>. These values influence I<printk()> behavior "
9824 "when printing or logging error messages. See B<syslog>(2) for more info on "
9825 "the different loglevels. Messages with a higher priority than "
9826 "I<console_loglevel> will be printed to the console. Messages without an "
9827 "explicit priority will be printed with priority I<default_message_level>. "
9828 "I<minimum_console_loglevel> is the minimum (highest) value to which "
9829 "I<console_loglevel> can be set. I<default_console_loglevel> is the default "
9830 "value for I<console_loglevel>."
9834 #: build/C/man5/proc.5:2279
9836 msgid "I</proc/sys/kernel/pty> (since Linux 2.6.4)"
9840 #: build/C/man5/proc.5:2285
9842 "This directory contains two files relating to the number of UNIX 98 "
9843 "pseudoterminals (see B<pts>(4)) on the system."
9847 #: build/C/man5/proc.5:2285
9849 msgid "I</proc/sys/kernel/pty/max>"
9853 #: build/C/man5/proc.5:2288
9854 msgid "This file defines the maximum number of pseudoterminals."
9858 #: build/C/man5/proc.5:2288
9860 msgid "I</proc/sys/kernel/pty/nr>"
9864 #: build/C/man5/proc.5:2292
9865 msgid "This read-only file indicates how many pseudoterminals are currently in use."
9869 #: build/C/man5/proc.5:2292
9871 msgid "I</proc/sys/kernel/random>"
9875 #: build/C/man5/proc.5:2300
9877 "This directory contains various parameters controlling the operation of the "
9878 "file I</dev/random>. See B<random>(4) for further information."
9882 #: build/C/man5/proc.5:2300
9884 msgid "I</proc/sys/kernel/real-root-dev>"
9888 #: build/C/man5/proc.5:2304
9890 "This file is documented in the kernel source file "
9891 "I<Documentation/initrd.txt>."
9895 #: build/C/man5/proc.5:2304
9897 msgid "I</proc/sys/kernel/reboot-cmd> (Sparc only) "
9901 #: build/C/man5/proc.5:2310
9903 "This file seems to be a way to give an argument to the SPARC ROM/Flash boot "
9904 "loader. Maybe to tell it what to do after rebooting?"
9908 #: build/C/man5/proc.5:2310
9910 msgid "I</proc/sys/kernel/rtsig-max>"
9914 #: build/C/man5/proc.5:2317
9916 "(Only in kernels up to and including 2.6.7; see B<setrlimit>(2)) This file "
9917 "can be used to tune the maximum number of POSIX real-time (queued) signals "
9918 "that can be outstanding in the system."
9922 #: build/C/man5/proc.5:2317
9924 msgid "I</proc/sys/kernel/rtsig-nr>"
9928 #: build/C/man5/proc.5:2321
9930 "(Only in kernels up to and including 2.6.7.) This file shows the number "
9931 "POSIX real-time signals currently queued."
9935 #: build/C/man5/proc.5:2321
9937 msgid "I</proc/sys/kernel/sem> (since Linux 2.4)"
9941 #: build/C/man5/proc.5:2325
9943 "This file contains 4 numbers defining limits for System V IPC semaphores. "
9944 "These fields are, in order:"
9948 #: build/C/man5/proc.5:2326
9954 #: build/C/man5/proc.5:2328
9955 msgid "The maximum semaphores per semaphore set."
9959 #: build/C/man5/proc.5:2328
9965 #: build/C/man5/proc.5:2330
9966 msgid "A system-wide limit on the number of semaphores in all semaphore sets."
9970 #: build/C/man5/proc.5:2330
9976 #: build/C/man5/proc.5:2334
9978 "The maximum number of operations that may be specified in a B<semop>(2) "
9983 #: build/C/man5/proc.5:2334
9989 #: build/C/man5/proc.5:2336
9990 msgid "A system-wide limit on the maximum number of semaphore identifiers."
9994 #: build/C/man5/proc.5:2337
9996 msgid "I</proc/sys/kernel/sg-big-buff>"
10000 #: build/C/man5/proc.5:2348
10002 "This file shows the size of the generic SCSI device (sg) buffer. You can't "
10003 "tune it just yet, but you could change it at compile time by editing "
10004 "I<include/scsi/sg.h> and changing the value of B<SG_BIG_BUFF>. However, "
10005 "there shouldn't be any reason to change this value."
10009 #: build/C/man5/proc.5:2348
10011 msgid "I</proc/sys/kernel/shmall>"
10014 #. type: Plain text
10015 #: build/C/man5/proc.5:2353
10017 "This file contains the system-wide limit on the total number of pages of "
10018 "System V shared memory."
10022 #: build/C/man5/proc.5:2353
10024 msgid "I</proc/sys/kernel/shmmax>"
10027 #. type: Plain text
10028 #: build/C/man5/proc.5:2363
10030 "This file can be used to query and set the run-time limit on the maximum "
10031 "(System V IPC) shared memory segment size that can be created. Shared "
10032 "memory segments up to 1GB are now supported in the kernel. This value "
10033 "defaults to B<SHMMAX>."
10037 #: build/C/man5/proc.5:2363
10039 msgid "I</proc/sys/kernel/shmmni>"
10042 #. type: Plain text
10043 #: build/C/man5/proc.5:2369
10045 "(available in Linux 2.4 and onward) This file specifies the system-wide "
10046 "maximum number of System V shared memory segments that can be created."
10050 #: build/C/man5/proc.5:2369
10052 msgid "I</proc/sys/kernel/sysrq>"
10055 #. type: Plain text
10056 #: build/C/man5/proc.5:2378
10058 "This file controls the functions allowed to be invoked by the SysRq key. By "
10059 "default, the file contains 1 meaning that every possible SysRq request is "
10060 "allowed (in older kernel versions, SysRq was disabled by default, and you "
10061 "were required to specifically enable it at run-time, but this is not the "
10062 "case any more). Possible values in this file are:"
10065 #. type: Plain text
10066 #: build/C/man5/proc.5:2390
10069 " 0 - disable sysrq completely\n"
10070 " 1 - enable all functions of sysrq\n"
10071 " E<gt>1 - bitmask of allowed sysrq functions, as follows:\n"
10072 " 2 - enable control of console logging level\n"
10073 " 4 - enable control of keyboard (SAK, unraw)\n"
10074 " 8 - enable debugging dumps of processes etc.\n"
10075 " 16 - enable sync command\n"
10076 " 32 - enable remount read-only\n"
10077 " 64 - enable signalling of processes (term, kill, oom-kill)\n"
10078 " 128 - allow reboot/poweroff\n"
10079 " 256 - allow nicing of all real-time tasks\n"
10082 #. type: Plain text
10083 #: build/C/man5/proc.5:2396
10085 "This file is only present if the B<CONFIG_MAGIC_SYSRQ> kernel configuration "
10086 "option is enabled. For further details see the kernel source file "
10087 "I<Documentation/sysrq.txt>."
10091 #: build/C/man5/proc.5:2396
10093 msgid "I</proc/sys/kernel/version>"
10096 #. type: Plain text
10097 #: build/C/man5/proc.5:2399
10098 msgid "This file contains a string like:"
10101 #. type: Plain text
10102 #: build/C/man5/proc.5:2401
10104 msgid " #5 Wed Feb 25 21:49:24 MET 1998\n"
10107 #. type: Plain text
10108 #: build/C/man5/proc.5:2405
10110 "The \"#5\" means that this is the fifth kernel built from this source base "
10111 "and the date behind it indicates the time the kernel was built."
10115 #: build/C/man5/proc.5:2405
10117 msgid "I</proc/sys/kernel/threads-max> (since Linux 2.3.11)"
10120 #. type: Plain text
10121 #: build/C/man5/proc.5:2409
10123 "This file specifies the system-wide limit on the number of threads (tasks) "
10124 "that can be created on the system."
10128 #: build/C/man5/proc.5:2409
10130 msgid "I</proc/sys/kernel/zero-paged> (PowerPC only) "
10133 #. type: Plain text
10134 #: build/C/man5/proc.5:2415
10136 "This file contains a flag. When enabled (nonzero), Linux-PPC will pre-zero "
10137 "pages in the idle loop, possibly speeding up get_free_pages."
10141 #: build/C/man5/proc.5:2415
10143 msgid "I</proc/sys/net>"
10146 #. type: Plain text
10147 #: build/C/man5/proc.5:2422
10149 "This directory contains networking stuff. Explanations for some of the "
10150 "files under this directory can be found in B<tcp>(7) and B<ip>(7)."
10154 #: build/C/man5/proc.5:2422
10156 msgid "I</proc/sys/net/core/somaxconn>"
10159 #. type: Plain text
10160 #: build/C/man5/proc.5:2431
10162 "This file defines a ceiling value for the I<backlog> argument of "
10163 "B<listen>(2); see the B<listen>(2) manual page for details."
10167 #: build/C/man5/proc.5:2431
10169 msgid "I</proc/sys/proc>"
10173 #: build/C/man5/proc.5:2434
10175 msgid "I</proc/sys/sunrpc>"
10178 #. type: Plain text
10179 #: build/C/man5/proc.5:2439
10181 "This directory supports Sun remote procedure call for network file system "
10182 "(NFS). On some systems, it is not present."
10186 #: build/C/man5/proc.5:2439
10188 msgid "I</proc/sys/vm>"
10191 #. type: Plain text
10192 #: build/C/man5/proc.5:2443
10194 "This directory contains files for memory management tuning, buffer and cache "
10199 #: build/C/man5/proc.5:2443
10201 msgid "I</proc/sys/vm/drop_caches> (since Linux 2.6.16)"
10204 #. type: Plain text
10205 #: build/C/man5/proc.5:2447
10207 "Writing to this file causes the kernel to drop clean caches, dentries and "
10208 "inodes from memory, causing that memory to become free."
10211 #. type: Plain text
10212 #: build/C/man5/proc.5:2454
10214 "To free pagecache, use I<echo 1 E<gt> /proc/sys/vm/drop_caches>; to free "
10215 "dentries and inodes, use I<echo 2 E<gt> /proc/sys/vm/drop_caches>; to free "
10216 "pagecache, dentries and inodes, use I<echo 3 E<gt> "
10217 "/proc/sys/vm/drop_caches>."
10220 #. type: Plain text
10221 #: build/C/man5/proc.5:2460
10223 "Because this is a nondestructive operation and dirty objects are not "
10224 "freeable, the user should run B<sync>(8) first."
10228 #: build/C/man5/proc.5:2460
10230 msgid "I</proc/sys/vm/legacy_va_layout> (since Linux 2.6.9)"
10233 #. The following is from Documentation/filesystems/proc.txt
10234 #. type: Plain text
10235 #: build/C/man5/proc.5:2465
10237 "If nonzero, this disables the new 32-bit memory-mapping layout; the kernel "
10238 "will use the legacy (2.4) layout for all processes."
10242 #: build/C/man5/proc.5:2465
10244 msgid "I</proc/sys/vm/memory_failure_early_kill> (since Linux 2.6.32)"
10247 #. The following is based on the text in Documentation/sysctl/vm.txt
10248 #. type: Plain text
10249 #: build/C/man5/proc.5:2477
10251 "Control how to kill processes when an uncorrected memory error (typically a "
10252 "2-bit error in a memory module) that cannot be handled by the kernel is "
10253 "detected in the background by hardware. In some cases (like the page still "
10254 "having a valid copy on disk), the kernel will handle the failure "
10255 "transparently without affecting any applications. But if there is no other "
10256 "up-to-date copy of the data, it will kill processes to prevent any data "
10257 "corruptions from propagating."
10260 #. type: Plain text
10261 #: build/C/man5/proc.5:2479
10262 msgid "The file has one of the following values:"
10266 #: build/C/man5/proc.5:2480 build/C/man5/proc.5:2517
10271 #. type: Plain text
10272 #: build/C/man5/proc.5:2485
10274 "Kill all processes that have the corrupted-and-not-reloadable page mapped as "
10275 "soon as the corruption is detected. Note this is not supported for a few "
10276 "types of pages, like kernel internally allocated data or the swap cache, but "
10277 "works for the majority of user pages."
10281 #: build/C/man5/proc.5:2485 build/C/man5/proc.5:2519
10286 #. type: Plain text
10287 #: build/C/man5/proc.5:2488
10289 "Only unmap the corrupted page from all processes and only kill a process who "
10290 "tries to access it."
10293 #. type: Plain text
10294 #: build/C/man5/proc.5:2499
10296 "The kill is performed using a B<SIGBUS> signal with I<si_code> set to "
10297 "B<BUS_MCEERR_AO>. Processes can handle this if they want to; see "
10298 "B<sigaction>(2) for more details."
10301 #. type: Plain text
10302 #: build/C/man5/proc.5:2502
10304 "This feature is only active on architectures/platforms with advanced machine "
10305 "check handling and depends on the hardware capabilities."
10308 #. type: Plain text
10309 #: build/C/man5/proc.5:2509
10311 "Applications can override the I<memory_failure_early_kill> setting "
10312 "individually with the B<prctl>(2) B<PR_MCE_KILL> operation."
10315 #. type: Plain text
10316 #: build/C/man5/proc.5:2512 build/C/man5/proc.5:2525
10317 msgid "Only present if the kernel was configured with B<CONFIG_MEMORY_FAILURE>."
10321 #: build/C/man5/proc.5:2512
10323 msgid "I</proc/sys/vm/memory_failure_recovery> (since Linux 2.6.32)"
10326 #. The following is based on the text in Documentation/sysctl/vm.txt
10327 #. type: Plain text
10328 #: build/C/man5/proc.5:2516
10329 msgid "Enable memory failure recovery (when supported by the platform)"
10332 #. type: Plain text
10333 #: build/C/man5/proc.5:2519
10334 msgid "Attempt recovery."
10337 #. type: Plain text
10338 #: build/C/man5/proc.5:2521
10339 msgid "Always panic on a memory failure."
10343 #: build/C/man5/proc.5:2525
10345 msgid "I</proc/sys/vm/oom_dump_tasks> (since Linux 2.6.25)"
10348 #. The following is from Documentation/sysctl/vm.txt
10349 #. type: Plain text
10350 #: build/C/man5/proc.5:2540
10352 "Enables a system-wide task dump (excluding kernel threads) to be produced "
10353 "when the kernel performs an OOM-killing. The dump includes the following "
10354 "information for each task (thread, process): thread ID, real user ID, thread "
10355 "group ID (process ID), virtual memory size, resident set size, the CPU that "
10356 "the task is scheduled on, oom_adj score (see the description of "
10357 "I</proc/[pid]/oom_adj>), and command name. This is helpful to determine why "
10358 "the OOM-killer was invoked and to identify the rogue task that caused it."
10361 #. type: Plain text
10362 #: build/C/man5/proc.5:2546
10364 "If this contains the value zero, this information is suppressed. On very "
10365 "large systems with thousands of tasks, it may not be feasible to dump the "
10366 "memory state information for each one. Such systems should not be forced to "
10367 "incur a performance penalty in OOM situations when the information may not "
10371 #. type: Plain text
10372 #: build/C/man5/proc.5:2549
10374 "If this is set to nonzero, this information is shown whenever the OOM-killer "
10375 "actually kills a memory-hogging task."
10378 #. type: Plain text
10379 #: build/C/man5/proc.5:2551 build/C/man5/proc.5:2572
10380 msgid "The default value is 0."
10384 #: build/C/man5/proc.5:2551
10386 msgid "I</proc/sys/vm/oom_kill_allocating_task> (since Linux 2.6.24)"
10389 #. The following is from Documentation/sysctl/vm.txt
10390 #. type: Plain text
10391 #: build/C/man5/proc.5:2556
10393 "This enables or disables killing the OOM-triggering task in out-of-memory "
10397 #. type: Plain text
10398 #: build/C/man5/proc.5:2561
10400 "If this is set to zero, the OOM-killer will scan through the entire tasklist "
10401 "and select a task based on heuristics to kill. This normally selects a "
10402 "rogue memory-hogging task that frees up a large amount of memory when "
10406 #. type: Plain text
10407 #: build/C/man5/proc.5:2565
10409 "If this is set to nonzero, the OOM-killer simply kills the task that "
10410 "triggered the out-of-memory condition. This avoids a possibly expensive "
10414 #. type: Plain text
10415 #: build/C/man5/proc.5:2570
10417 "If I</proc/sys/vm/panic_on_oom> is nonzero, it takes precedence over "
10418 "whatever value is used in I</proc/sys/vm/oom_kill_allocating_task>."
10422 #: build/C/man5/proc.5:2572
10424 msgid "I</proc/sys/vm/overcommit_memory>"
10427 #. type: Plain text
10428 #: build/C/man5/proc.5:2576
10429 msgid "This file contains the kernel virtual memory accounting mode. Values are:"
10432 #. type: Plain text
10433 #: build/C/man5/proc.5:2579
10434 msgid "0: heuristic overcommit (this is the default)"
10437 #. type: Plain text
10438 #: build/C/man5/proc.5:2581
10439 msgid "1: always overcommit, never check"
10442 #. type: Plain text
10443 #: build/C/man5/proc.5:2583
10444 msgid "2: always check, never overcommit"
10447 #. type: Plain text
10448 #: build/C/man5/proc.5:2597
10450 "In mode 0, calls of B<mmap>(2) with B<MAP_NORESERVE> are not checked, and "
10451 "the default check is very weak, leading to the risk of getting a process "
10452 "\"OOM-killed\". Under Linux 2.4 any nonzero value implies mode 1. In mode "
10453 "2 (available since Linux 2.6), the total virtual address space on the system "
10454 "is limited to (SS + RAM*(r/100)), where SS is the size of the swap space, "
10455 "and RAM is the size of the physical memory, and r is the contents of the "
10456 "file I</proc/sys/vm/overcommit_ratio>."
10460 #: build/C/man5/proc.5:2597
10462 msgid "I</proc/sys/vm/overcommit_ratio>"
10465 #. type: Plain text
10466 #: build/C/man5/proc.5:2601
10467 msgid "See the description of I</proc/sys/vm/overcommit_memory>."
10471 #: build/C/man5/proc.5:2601
10473 msgid "I</proc/sys/vm/panic_on_oom> (since Linux 2.6.18)"
10476 #. The following is adapted from Documentation/sysctl/vm.txt
10477 #. type: Plain text
10478 #: build/C/man5/proc.5:2606
10479 msgid "This enables or disables a kernel panic in an out-of-memory situation."
10482 #. type: Plain text
10483 #: build/C/man5/proc.5:2611
10485 "If this file is set to the value 0, the kernel's OOM-killer will kill some "
10486 "rogue process. Usually, the OOM-killer is able to kill a rogue process and "
10487 "the system will survive."
10490 #. type: Plain text
10491 #: build/C/man5/proc.5:2626
10493 "If this file is set to the value 1, then the kernel normally panics when "
10494 "out-of-memory happens. However, if a process limits allocations to certain "
10495 "nodes using memory policies (B<mbind>(2) B<MPOL_BIND>) or cpusets "
10496 "(B<cpuset>(7)) and those nodes reach memory exhaustion status, one process "
10497 "may be killed by the OOM-killer. No panic occurs in this case: because "
10498 "other nodes' memory may be free, this means the system as a whole may not "
10499 "have reached an out-of-memory situation yet."
10502 #. type: Plain text
10503 #: build/C/man5/proc.5:2629
10505 "If this file is set to the value 2, the kernel always panics when an "
10506 "out-of-memory condition occurs."
10509 #. type: Plain text
10510 #: build/C/man5/proc.5:2633
10512 "The default value is 0. 1 and 2 are for failover of clustering. Select "
10513 "either according to your policy of failover."
10517 #: build/C/man5/proc.5:2633
10519 msgid "I</proc/sys/vm/swappiness>"
10522 #. The following is from Documentation/sysctl/vm.txt
10523 #. type: Plain text
10524 #: build/C/man5/proc.5:2641
10526 "The value in this file controls how aggressively the kernel will swap memory "
10527 "pages. Higher values increase aggressiveness, lower values decrease "
10528 "aggressiveness. The default value is 60."
10532 #: build/C/man5/proc.5:2641
10534 msgid "I</proc/sysrq-trigger> (since Linux 2.4.21)"
10537 #. type: Plain text
10538 #: build/C/man5/proc.5:2650
10540 "Writing a character to this file triggers the same SysRq function as typing "
10541 "ALT-SysRq-E<lt>characterE<gt> (see the description of "
10542 "I</proc/sys/kernel/sysrq>). This file is normally only writable by "
10543 "I<root>. For further details see the kernel source file "
10544 "I<Documentation/sysrq.txt>."
10548 #: build/C/man5/proc.5:2650
10550 msgid "I</proc/sysvipc>"
10553 #. type: Plain text
10554 #: build/C/man5/proc.5:2663
10556 "Subdirectory containing the pseudo-files I<msg>, I<sem> and I<shm>. These "
10557 "files list the System V Interprocess Communication (IPC) objects "
10558 "(respectively: message queues, semaphores, and shared memory) that "
10559 "currently exist on the system, providing similar information to that "
10560 "available via B<ipcs>(1). These files have headers and are formatted (one "
10561 "IPC object per line) for easy understanding. B<svipc>(7) provides further "
10562 "background on the information shown by these files."
10566 #: build/C/man5/proc.5:2663
10568 msgid "I</proc/tty>"
10571 #. type: Plain text
10572 #: build/C/man5/proc.5:2667
10574 "Subdirectory containing the pseudo-files and subdirectories for tty drivers "
10575 "and line disciplines."
10579 #: build/C/man5/proc.5:2667
10581 msgid "I</proc/uptime>"
10584 #. type: Plain text
10585 #: build/C/man5/proc.5:2671
10587 "This file contains two numbers: the uptime of the system (seconds), and the "
10588 "amount of time spent in idle process (seconds)."
10592 #: build/C/man5/proc.5:2671
10594 msgid "I</proc/version>"
10597 #. type: Plain text
10598 #: build/C/man5/proc.5:2680
10600 "This string identifies the kernel version that is currently running. It "
10601 "includes the contents of I</proc/sys/kernel/ostype>, "
10602 "I</proc/sys/kernel/osrelease> and I</proc/sys/kernel/version>. For example:"
10605 #. type: Plain text
10606 #: build/C/man5/proc.5:2684
10608 msgid "CW<Linux version 1.0.9 (quinlan@phaze) #1 Sat May 14 01:51:54 EDT 1994>\n"
10612 #: build/C/man5/proc.5:2695
10614 msgid "I</proc/vmstat> (since Linux 2.6)"
10617 #. type: Plain text
10618 #: build/C/man5/proc.5:2698
10619 msgid "This file displays various virtual memory statistics."
10623 #: build/C/man5/proc.5:2698
10625 msgid "I</proc/zoneinfo> (since Linux 2.6.13)"
10628 #. FIXME more should be said about /proc/zoneinfo
10629 #. type: Plain text
10630 #: build/C/man5/proc.5:2703
10632 "This file display information about memory zones. This is useful for "
10633 "analyzing virtual memory behavior."
10636 #. type: Plain text
10637 #: build/C/man5/proc.5:2710
10639 "Many strings (i.e., the environment and command line) are in the internal "
10640 "format, with subfields terminated by null bytes (\\(aq\\e0\\(aq), so you may "
10641 "find that things are more readable if you use I<od -c> or I<tr \"\\e000\" "
10642 "\"\\en\"> to read them. Alternatively, I<echo \\`cat E<lt>fileE<gt>\\`> "
10646 #. .SH ACKNOWLEDGEMENTS
10647 #. The material on /proc/sys/fs and /proc/sys/kernel is closely based on
10648 #. kernel source documentation files written by Rik van Riel.
10649 #. type: Plain text
10650 #: build/C/man5/proc.5:2716
10652 "This manual page is incomplete, possibly inaccurate, and is the kind of "
10653 "thing that needs to be updated very often."
10656 #. type: Plain text
10657 #: build/C/man5/proc.5:2741
10659 "B<cat>(1), B<dmesg>(1), B<find>(1), B<free>(1), B<ps>(1), B<tr>(1), "
10660 "B<uptime>(1), B<chroot>(2), B<mmap>(2), B<readlink>(2), B<syslog>(2), "
10661 "B<slabinfo>(5), B<hier>(7), B<time>(7), B<arp>(8), B<hdparm>(8), "
10662 "B<ifconfig>(8), B<init>(8), B<lsmod>(8), B<lspci>(8), B<mount>(8), "
10663 "B<netstat>(8), B<procinfo>(8), B<route>(8)"
10666 #. type: Plain text
10667 #: build/C/man5/proc.5:2745
10669 "The kernel source files: I<Documentation/filesystems/proc.txt>, "
10670 "I<Documentation/sysctl/vm.txt>"
10674 #: build/C/man7/standards.7:25
10680 #: build/C/man7/standards.7:25
10685 #. type: Plain text
10686 #: build/C/man7/standards.7:28
10687 msgid "standards - C and UNIX Standards"
10690 #. type: Plain text
10691 #: build/C/man7/standards.7:32
10693 "The CONFORMING TO section that appears in many manual pages identifies "
10694 "various standards to which the documented interface conforms. The following "
10695 "list briefly describes these standards."
10699 #: build/C/man7/standards.7:32
10704 #. type: Plain text
10705 #: build/C/man7/standards.7:35
10706 msgid "Version 7, the ancestral UNIX from Bell Labs."
10710 #: build/C/man7/standards.7:35
10715 #. type: Plain text
10716 #: build/C/man7/standards.7:44
10718 "This is an implementation standard defined by the 4.2 release of the "
10719 "I<Berkeley Software Distribution>, released by the University of California "
10720 "at Berkeley. This was the first Berkeley release that contained a TCP/IP "
10721 "stack and the sockets API. 4.2BSD was released in 1983."
10724 #. type: Plain text
10725 #: build/C/man7/standards.7:47
10727 "Earlier major BSD releases included I<3BSD> (1980), I<4BSD> (1980), and "
10728 "I<4.1BSD> (1981)."
10732 #: build/C/man7/standards.7:47
10737 #. type: Plain text
10738 #: build/C/man7/standards.7:50
10739 msgid "The successor to 4.2BSD, released in 1986."
10743 #: build/C/man7/standards.7:50
10748 #. type: Plain text
10749 #: build/C/man7/standards.7:54
10751 "The successor to 4.3BSD, released in 1993. This was the last major Berkeley "
10756 #: build/C/man7/standards.7:54
10758 msgid "B<System V>"
10761 #. type: Plain text
10762 #: build/C/man7/standards.7:61
10764 "This is an implementation standard defined by AT&T's milestone 1983 release "
10765 "of its commercial System V (five) release. The previous major AT&T release "
10766 "was I<System III>, released in 1981."
10770 #: build/C/man7/standards.7:61
10772 msgid "B<System V release 2 (SVr2)>"
10775 #. type: Plain text
10776 #: build/C/man7/standards.7:68
10778 "This was the next System V release, made in 1985. The SVr2 was formally "
10779 "described in the I<System V Interface Definition version 1> (I<SVID 1>) "
10780 "published in 1985."
10784 #: build/C/man7/standards.7:68
10786 msgid "B<System V release 3 (SVr3)>"
10789 #. type: Plain text
10790 #: build/C/man7/standards.7:74
10792 "This was the successor to SVr2, released in 1986. This release was formally "
10793 "described in the I<System V Interface Definition version 2> (I<SVID 2>)."
10797 #: build/C/man7/standards.7:74
10799 msgid "B<System V release 4 (SVr4)>"
10802 #. type: Plain text
10803 #: build/C/man7/standards.7:84
10805 "This was the successor to SVr3, released in 1989. This version of System V "
10806 "is described in the \"Programmer's Reference Manual: Operating System API "
10807 "(Intel processors)\" (Prentice-Hall 1992, ISBN 0-13-951294-2) This release "
10808 "was formally described in the I<System V Interface Definition version 3> "
10809 "(I<SVID 3>), and is considered the definitive System V release."
10813 #: build/C/man7/standards.7:84
10818 #. type: Plain text
10819 #: build/C/man7/standards.7:88
10821 "System V Interface Definition version 4, issued in 1995. Available online "
10822 "at http://www.sco.com/developers/devspecs/ ."
10826 #: build/C/man7/standards.7:88
10831 #. type: Plain text
10832 #: build/C/man7/standards.7:102
10834 "This was the first C language standard, ratified by ANSI (American National "
10835 "Standards Institute) in 1989 (I<X3.159-1989>). Sometimes this is known as "
10836 "I<ANSI C>, but since C99 is also an ANSI standard, this term is ambiguous. "
10837 "This standard was also ratified by ISO (International Standards "
10838 "Organization) in 1990 (I<ISO/IEC 9899:1990>), and is thus occasionally "
10839 "referred to as I<ISO C90>."
10843 #: build/C/man7/standards.7:102
10848 #. type: Plain text
10849 #: build/C/man7/standards.7:108
10851 "This revision of the C language standard was ratified by ISO in 1999 "
10852 "(I<ISO/IEC 9899:1999>). Available online at "
10853 "http://www.open-std.org/jtc1/sc22/wg14/www/standards."
10857 #: build/C/man7/standards.7:108
10859 msgid "B<POSIX.1-1990>"
10862 #. type: Plain text
10863 #: build/C/man7/standards.7:114
10865 "\"Portable Operating System Interface for Computing Environments\". IEEE "
10866 "1003.1-1990 part 1, ratified by ISO in 1990 (I<ISO/IEC 9945-1:1990>). The "
10867 "term \"POSIX\" was coined by Richard Stallman."
10871 #: build/C/man7/standards.7:114
10876 #. type: Plain text
10877 #: build/C/man7/standards.7:119
10879 "IEEE Std 1003.2-1992, describing commands and utilities, ratified by ISO in "
10880 "1993 (I<ISO/IEC 9945-2:1993>)."
10884 #: build/C/man7/standards.7:119
10886 msgid "B<POSIX.1b> (formerly known as I<POSIX.4>)"
10889 #. type: Plain text
10890 #: build/C/man7/standards.7:125
10892 "IEEE Std 1003.1b-1993 describing real-time facilities for portable operating "
10893 "systems, ratified by ISO in 1996 (I<ISO/IEC 9945-1:1996>)."
10897 #: build/C/man7/standards.7:125
10899 msgid "B<POSIX.1c>"
10902 #. type: Plain text
10903 #: build/C/man7/standards.7:128
10904 msgid "IEEE Std 1003.1c-1995 describing the POSIX threads interfaces."
10908 #: build/C/man7/standards.7:128
10910 msgid "B<POSIX.1d>"
10913 #. type: Plain text
10914 #: build/C/man7/standards.7:131
10915 msgid "IEEE Std 1003.1c-1999 describing additional real-time extensions."
10919 #: build/C/man7/standards.7:131
10921 msgid "B<POSIX.1g>"
10924 #. type: Plain text
10925 #: build/C/man7/standards.7:134
10926 msgid "IEEE Std 1003.1g-2000 describing networking APIs (including sockets)."
10930 #: build/C/man7/standards.7:134
10932 msgid "B<POSIX.1j>"
10935 #. type: Plain text
10936 #: build/C/man7/standards.7:137
10937 msgid "IEEE Std 1003.1j-2000 describing advanced real-time extensions."
10941 #: build/C/man7/standards.7:137
10943 msgid "B<POSIX.1-1996>"
10946 #. type: Plain text
10947 #: build/C/man7/standards.7:140
10948 msgid "A 1996 revision of POSIX.1 which incorporated POSIX.1b and POSIX.1c."
10952 #: build/C/man7/standards.7:140
10957 #. type: Plain text
10958 #: build/C/man7/standards.7:147
10960 "Released in 1989, this was the first significant release of the I<X/Open "
10961 "Portability Guide>, produced by the X/Open Company, a multivendor "
10962 "consortium. This multivolume guide was based on the POSIX standards."
10966 #: build/C/man7/standards.7:147
10971 #. type: Plain text
10972 #: build/C/man7/standards.7:150
10973 msgid "A revision of the X/Open Portability Guide, released in 1992."
10977 #: build/C/man7/standards.7:150
10982 #. type: Plain text
10983 #: build/C/man7/standards.7:157
10985 "A 1994 revision of XPG4. This is also referred to as I<Spec 1170>, where "
10986 "1170 referred to the number of interfaces defined by this standard."
10990 #: build/C/man7/standards.7:157
10992 msgid "B<SUS (SUSv1)>"
10995 #. type: Plain text
10996 #: build/C/man7/standards.7:165
10998 "Single UNIX Specification. This was a repackaging of XPG4v2 and other "
10999 "X/Open standards (X/Open Curses Issue 4 version 2, X/Open Networking Service "
11000 "(XNS) Issue 4). Systems conforming to this standard can be branded I<UNIX "
11005 #: build/C/man7/standards.7:165
11010 #. type: Plain text
11011 #: build/C/man7/standards.7:175
11013 "Single UNIX Specification version 2. Sometimes also referred to as "
11014 "I<XPG5>. This standard appeared in 1997. Systems conforming to this "
11015 "standard can be branded I<UNIX 98>. See also "
11016 "http://www.UNIX-systems.org/version2/ .)"
11020 #: build/C/man7/standards.7:175
11022 msgid "B<POSIX.1-2001, SUSv3>"
11025 #. type: Plain text
11026 #: build/C/man7/standards.7:185
11028 "This was a 2001 revision and consolidation of the POSIX.1, POSIX.2, and SUS "
11029 "standards into a single document, conducted under the auspices of the Austin "
11030 "group (http://www.opengroup.org/austin/ .) The standard is available online "
11031 "at http://www.unix-systems.org/version3/ , and the interfaces that it "
11032 "describes are also available in the Linux manual pages package under "
11033 "sections 1p and 3p (e.g., \"man 3p open\")."
11036 #. type: Plain text
11037 #: build/C/man7/standards.7:198
11039 "The standard defines two levels of conformance: I<POSIX conformance>, which "
11040 "is a baseline set of interfaces required of a conforming system; and I<XSI "
11041 "Conformance>, which additionally mandates a set of interfaces (the \"XSI "
11042 "extension\") which are only optional for POSIX conformance. XSI-conformant "
11043 "systems can be branded I<UNIX 03>. (XSI conformance constitutes the "
11044 "I<Single UNIX Specification version 3> (I<SUSv3>).)"
11047 #. type: Plain text
11048 #: build/C/man7/standards.7:200
11049 msgid "The POSIX.1-2001 document is broken into four parts:"
11052 #. type: Plain text
11053 #: build/C/man7/standards.7:203
11054 msgid "B<XBD>: Definitions, terms and concepts, header file specifications."
11057 #. type: Plain text
11058 #: build/C/man7/standards.7:207
11060 "B<XSH>: Specifications of functions (i.e., system calls and library "
11061 "functions in actual implementations)."
11064 #. type: Plain text
11065 #: build/C/man7/standards.7:211
11067 "B<XCU>: Specifications of commands and utilities (i.e., the area formerly "
11068 "described by POSIX.2)."
11071 #. type: Plain text
11072 #: build/C/man7/standards.7:214
11073 msgid "B<XRAT>: Informative text on the other parts of the standard."
11076 #. type: Plain text
11077 #: build/C/man7/standards.7:218
11079 "POSIX.1-2001 is aligned with C99, so that all of the library functions "
11080 "standardized in C99 are also standardized in POSIX.1-2001."
11083 #. type: Plain text
11084 #: build/C/man7/standards.7:225
11086 "Two Technical Corrigenda (minor fixes and improvements) of the original "
11087 "2001 standard have occurred: TC1 in 2003 (referred to as I<POSIX.1-2003>), "
11088 "and TC2 in 2004 (referred to as I<POSIX.1-2004>)."
11092 #: build/C/man7/standards.7:225
11094 msgid "B<POSIX.1-2008, SUSv4>"
11097 #. type: Plain text
11098 #: build/C/man7/standards.7:229
11099 msgid "Work on the next revision of POSIX.1/SUS was completed and ratified in 2008."
11102 #. type: Plain text
11103 #: build/C/man7/standards.7:238
11105 "The changes in this revision are not as large as those that occurred for "
11106 "POSIX.1-2001/SUSv3, but a number of new interfaces are added and various "
11107 "details of existing specifications are modified. Many of the interfaces "
11108 "that were optional in POSIX.1-2001 become mandatory in the 2008 revision of "
11109 "the standard. A few interfaces that are present in POSIX.1-2001 are marked "
11110 "as obsolete in POSIX.1-2008, or removed from the standard altogether."
11113 #. type: Plain text
11114 #: build/C/man7/standards.7:246
11116 "The revised standard is broken into the same four parts as POSIX.1-2001, and "
11117 "again there are two levels of conformance: the baseline I<POSIX "
11118 "Conformance>, and I<XSI Conformance>, which mandates an additional set of "
11119 "interfaces beyond those in the base specification."
11122 #. type: Plain text
11123 #: build/C/man7/standards.7:250
11125 "In general, where the CONFORMING TO section of a manual page lists "
11126 "POSIX.1-2001, it can be assumed that the interface also conforms to "
11127 "POSIX.1-2008, unless otherwise noted."
11130 #. type: Plain text
11131 #: build/C/man7/standards.7:253
11133 "Further information can be found on the Austin group web site, "
11134 "http://www.opengroup.org/austin/ ."
11137 #. type: Plain text
11138 #: build/C/man7/standards.7:257
11139 msgid "B<feature_test_macros>(7), B<libc>(7), B<posixoptions>(7)"
11143 #: build/C/man7/suffixes.7:38
11149 #: build/C/man7/suffixes.7:38
11154 #. type: Plain text
11155 #: build/C/man7/suffixes.7:41
11156 msgid "suffixes - list of file suffixes"
11159 #. type: Plain text
11160 #: build/C/man7/suffixes.7:49
11162 "It is customary to indicate the contents of a file with the file suffix, "
11163 "which consists of a period, followed by one or more letters. Many standard "
11164 "utilities, such as compilers, use this to recognize the type of file they "
11165 "are dealing with. The B<make>(1) utility is driven by rules based on file "
11169 #. type: Plain text
11170 #: build/C/man7/suffixes.7:52
11172 "Following is a list of suffixes which are likely to be found on a Linux "
11177 #: build/C/man7/suffixes.7:57
11179 msgid "Suffix\tFile type\n"
11183 #: build/C/man7/suffixes.7:58
11185 msgid " ,v\tfiles for RCS (Revision Control System)\n"
11189 #: build/C/man7/suffixes.7:59
11191 msgid " -\tbackup file\n"
11195 #: build/C/man7/suffixes.7:60
11197 msgid " .C\tC++ source code, equivalent to I<.cc>\n"
11201 #: build/C/man7/suffixes.7:61
11203 msgid " .F\tFortran source with B<cpp>(1) directives\n"
11207 #: build/C/man7/suffixes.7:62
11209 msgid "\tor file compressed using freeze\n"
11213 #: build/C/man7/suffixes.7:63
11215 msgid " .S\tassembler source with B<cpp>(1) directives\n"
11219 #: build/C/man7/suffixes.7:64
11221 msgid " .Y\tfile compressed using yabba\n"
11225 #: build/C/man7/suffixes.7:65
11227 msgid " .Z\tfile compressed using B<compress>(1)\n"
11231 #: build/C/man7/suffixes.7:66
11233 msgid " .[0-9]+gf\tTeX generic font files\n"
11237 #: build/C/man7/suffixes.7:67
11239 msgid " .[0-9]+pk\tTeX packed font files\n"
11243 #: build/C/man7/suffixes.7:68
11245 msgid " .[1-9]\tmanual page for the corresponding section\n"
11249 #: build/C/man7/suffixes.7:69
11251 msgid " .[1-9][a-z]\tmanual page for section plus subsection\n"
11255 #: build/C/man7/suffixes.7:70
11257 msgid " .a\tstatic object code library\n"
11261 #: build/C/man7/suffixes.7:71
11263 msgid " .ad\tX application default resource file\n"
11267 #: build/C/man7/suffixes.7:72
11269 msgid " .ada\tAda source (may be body, spec, or combination)\n"
11273 #: build/C/man7/suffixes.7:73
11275 msgid " .adb\tAda body source\n"
11279 #: build/C/man7/suffixes.7:74
11281 msgid " .ads\tAda spec source\n"
11285 #: build/C/man7/suffixes.7:75
11287 msgid " .afm\tPostScript font metrics\n"
11291 #: build/C/man7/suffixes.7:76
11293 msgid " .al\tPerl autoload file\n"
11297 #: build/C/man7/suffixes.7:77
11299 msgid " .am\tB<automake>(1) input file\n"
11303 #: build/C/man7/suffixes.7:78
11305 msgid " .arc\tB<arc>(1) archive\n"
11309 #: build/C/man7/suffixes.7:79
11311 msgid " .arj\tB<arj>(1) archive\n"
11315 #: build/C/man7/suffixes.7:80
11317 msgid " .asc\tPGP ASCII-armored data\n"
11321 #: build/C/man7/suffixes.7:81
11323 msgid " .asm\t(GNU) assembler source file\n"
11327 #: build/C/man7/suffixes.7:82
11329 msgid " .au\tAudio sound file\n"
11333 #: build/C/man7/suffixes.7:83
11335 msgid " .aux\tLaTeX auxiliary file\n"
11339 #: build/C/man7/suffixes.7:84
11341 msgid " .avi\t(msvideo) movie\n"
11345 #: build/C/man7/suffixes.7:85
11347 msgid " .awk\tAWK language program\n"
11351 #: build/C/man7/suffixes.7:86
11353 msgid " .b\tLILO boot loader image\n"
11357 #: build/C/man7/suffixes.7:87
11359 msgid " .bak\tbackup file\n"
11363 #: build/C/man7/suffixes.7:88
11365 msgid " .bash\tB<bash>(1) shell script\n"
11369 #: build/C/man7/suffixes.7:89
11371 msgid " .bb\tbasic block list data produced by\n"
11375 #: build/C/man7/suffixes.7:90 build/C/man7/suffixes.7:92
11377 msgid "\tgcc -ftest-coverage\n"
11381 #: build/C/man7/suffixes.7:91
11383 msgid " .bbg\tbasic block graph data produced by\n"
11387 #: build/C/man7/suffixes.7:93
11389 msgid " .bbl\tBibTeX output\n"
11393 #: build/C/man7/suffixes.7:94
11395 msgid " .bdf\tX font file\n"
11399 #: build/C/man7/suffixes.7:95
11401 msgid " .bib\tTeX bibliographic database, BibTeX input\n"
11405 #: build/C/man7/suffixes.7:96
11407 msgid " .bm\tbitmap source\n"
11411 #: build/C/man7/suffixes.7:97
11413 msgid " .bmp\tbitmap\n"
11417 #: build/C/man7/suffixes.7:98
11419 msgid " .bz2\tfile compressed using B<bzip2>(1)\n"
11423 #: build/C/man7/suffixes.7:99
11425 msgid " .c\tC source\n"
11429 #: build/C/man7/suffixes.7:100
11431 msgid " .cat\tmessage catalog files\n"
11435 #: build/C/man7/suffixes.7:101
11437 msgid " .cc\tC++ source\n"
11441 #: build/C/man7/suffixes.7:102
11443 msgid " .cf\tconfiguration file\n"
11447 #: build/C/man7/suffixes.7:103
11449 msgid " .cfg\tconfiguration file\n"
11453 #: build/C/man7/suffixes.7:104
11455 msgid " .cgi\tWWW content generating script or program\n"
11459 #: build/C/man7/suffixes.7:105
11461 msgid " .cls\tLaTeX Class definition\n"
11465 #: build/C/man7/suffixes.7:106
11467 msgid " .class\tJava compiled byte-code\n"
11471 #: build/C/man7/suffixes.7:107
11473 msgid " .conf\tconfiguration file\n"
11477 #: build/C/man7/suffixes.7:108
11479 msgid " .config\tconfiguration file\n"
11483 #: build/C/man7/suffixes.7:109
11485 msgid " .cpp\tequivalent to I<.cc>\n"
11489 #: build/C/man7/suffixes.7:110
11491 msgid " .csh\tB<csh>(1) shell script\n"
11495 #: build/C/man7/suffixes.7:111
11497 msgid " .cxx\tequivalent to I<.cc>\n"
11501 #: build/C/man7/suffixes.7:112
11503 msgid " .dat\tdata file\n"
11507 #: build/C/man7/suffixes.7:113
11509 msgid " .deb\tDebian software package\n"
11513 #: build/C/man7/suffixes.7:114
11515 msgid " .def\tModula-2 source for definition modules\n"
11519 #: build/C/man7/suffixes.7:115
11521 msgid " .def\tother definition files\n"
11525 #: build/C/man7/suffixes.7:116
11527 msgid " .desc\tinitial part of mail message unpacked with\n"
11531 #: build/C/man7/suffixes.7:117
11533 msgid "\tB<munpack>(1)\n"
11537 #: build/C/man7/suffixes.7:118
11539 msgid " .diff\tfile differences (B<diff>(1) command output)\n"
11543 #: build/C/man7/suffixes.7:119
11545 msgid " .dir\tdbm data base directory file\n"
11549 #: build/C/man7/suffixes.7:120
11551 msgid " .doc\tdocumentation file\n"
11555 #: build/C/man7/suffixes.7:121
11557 msgid " .dsc\tDebian Source Control (source package)\n"
11561 #: build/C/man7/suffixes.7:122
11563 msgid " .dtx\tLaTeX package source file\n"
11567 #: build/C/man7/suffixes.7:123
11569 msgid " .dvi\tTeX's device independent output\n"
11573 #: build/C/man7/suffixes.7:124
11575 msgid " .el\tEmacs-Lisp source\n"
11579 #: build/C/man7/suffixes.7:125
11581 msgid " .elc\tcompiled Emacs-Lisp source\n"
11585 #: build/C/man7/suffixes.7:126
11587 msgid " .eps\tencapsulated PostScript\n"
11591 #: build/C/man7/suffixes.7:127
11593 msgid " .exp\tExpect source code\n"
11597 #: build/C/man7/suffixes.7:128
11599 msgid " .f\tFortran source\n"
11603 #: build/C/man7/suffixes.7:129
11605 msgid " .f77\tFortran 77 source\n"
11609 #: build/C/man7/suffixes.7:130
11611 msgid " .f90\tFortran 90 source\n"
11615 #: build/C/man7/suffixes.7:131
11617 msgid " .fas\tprecompiled Common-Lisp\n"
11621 #: build/C/man7/suffixes.7:132
11623 msgid " .fi\tFortran include files\n"
11627 #: build/C/man7/suffixes.7:133
11629 msgid " .fig\tFIG image file (used by B<xfig>(1))\n"
11633 #: build/C/man7/suffixes.7:134
11635 msgid " .fmt\tTeX format file\n"
11639 #: build/C/man7/suffixes.7:135
11641 msgid " .gif\tCompuserve Graphics Image File format\n"
11645 #: build/C/man7/suffixes.7:136
11647 msgid " .gmo\tGNU format message catalog\n"
11651 #: build/C/man7/suffixes.7:137
11653 msgid " .gsf\tGhostscript fonts\n"
11657 #: build/C/man7/suffixes.7:138
11659 msgid " .gz\tfile compressed using B<gzip>(1)\n"
11663 #: build/C/man7/suffixes.7:139
11665 msgid " .h\tC or C++ header files\n"
11669 #: build/C/man7/suffixes.7:140
11671 msgid " .help\thelp file\n"
11675 #: build/C/man7/suffixes.7:141
11677 msgid " .hf\tequivalent to I<.help>\n"
11681 #: build/C/man7/suffixes.7:142
11683 msgid " .hlp\tequivalent to I<.help>\n"
11687 #: build/C/man7/suffixes.7:143
11689 msgid " .htm\tpoor man's I<.html>\n"
11693 #: build/C/man7/suffixes.7:144
11695 msgid " .html\tHTML document used with the World Wide Web\n"
11699 #: build/C/man7/suffixes.7:145
11701 msgid " .hqx\t7-bit encoded Macintosh file\n"
11705 #: build/C/man7/suffixes.7:146
11707 msgid " .i\tC source after preprocessing\n"
11711 #: build/C/man7/suffixes.7:147
11713 msgid " .icon\tbitmap source\n"
11717 #: build/C/man7/suffixes.7:148
11719 msgid " .idx\treference or datum-index file for hypertext\n"
11723 #: build/C/man7/suffixes.7:149
11725 msgid "\tor database system\n"
11729 #: build/C/man7/suffixes.7:150
11731 msgid " .image\tbitmap source\n"
11735 #: build/C/man7/suffixes.7:151
11737 msgid " .in\tconfiguration template, especially for GNU Autoconf\n"
11741 #: build/C/man7/suffixes.7:152
11743 msgid " .info\tfiles for the Emacs info browser\n"
11747 #: build/C/man7/suffixes.7:153
11749 msgid " .info-[0-9]+\tsplit info files\n"
11753 #: build/C/man7/suffixes.7:154
11755 msgid " .ins\tLaTeX package install file for docstrip\n"
11759 #: build/C/man7/suffixes.7:155
11761 msgid " .itcl\titcl source code;\n"
11765 #: build/C/man7/suffixes.7:156
11767 msgid "\titcl ([incr Tcl]) is an OO extension of tcl\n"
11771 #: build/C/man7/suffixes.7:157
11773 msgid " .java\ta Java source file\n"
11777 #: build/C/man7/suffixes.7:158
11779 msgid " .jpeg\tJoint Photographic Experts Group format\n"
11783 #: build/C/man7/suffixes.7:159
11785 msgid " .jpg\tpoor man's I<.jpeg>\n"
11789 #: build/C/man7/suffixes.7:160
11791 msgid " .kmap\tB<lyx>(1) keymap\n"
11795 #: build/C/man7/suffixes.7:161
11797 msgid " .l\tequivalent to I<.lex> or I<.lisp>\n"
11801 #: build/C/man7/suffixes.7:162
11803 msgid " .lex\tB<lex>(1) or B<flex>(1) files\n"
11807 #: build/C/man7/suffixes.7:163
11809 msgid " .lha\tlharc archive\n"
11813 #: build/C/man7/suffixes.7:164
11815 msgid " .lib\tCommon-Lisp library\n"
11819 #: build/C/man7/suffixes.7:165
11821 msgid " .lisp\tLisp source\n"
11825 #: build/C/man7/suffixes.7:166
11827 msgid " .ln\tfiles for use with B<lint>(1)\n"
11831 #: build/C/man7/suffixes.7:167
11833 msgid " .log\tlog file, in particular produced by TeX\n"
11837 #: build/C/man7/suffixes.7:168
11839 msgid " .lsm\tLinux Software Map entry\n"
11843 #: build/C/man7/suffixes.7:169
11845 msgid " .lsp\tCommon-Lisp source\n"
11849 #: build/C/man7/suffixes.7:170
11851 msgid " .lzh\tlharc archive\n"
11855 #: build/C/man7/suffixes.7:171
11857 msgid " .m\tObjective-C source code\n"
11861 #: build/C/man7/suffixes.7:172
11863 msgid " .m4\tB<m4>(1) source\n"
11867 #: build/C/man7/suffixes.7:173
11869 msgid " .mac\tmacro files for various programs\n"
11873 #: build/C/man7/suffixes.7:174
11875 msgid " .man\tmanual page (usually source rather than formatted)\n"
11879 #: build/C/man7/suffixes.7:175
11881 msgid " .map\tmap files for various programs\n"
11885 #: build/C/man7/suffixes.7:176
11887 msgid " .me\tNroff source using the me macro package\n"
11891 #: build/C/man7/suffixes.7:177
11893 msgid " .mf\tMetafont (font generator for TeX) source\n"
11897 #: build/C/man7/suffixes.7:178
11899 msgid " .mgp\tMagicPoint file\n"
11903 #: build/C/man7/suffixes.7:179
11905 msgid " .mm\tsources for B<groff>(1) in mm - format\n"
11909 #: build/C/man7/suffixes.7:180
11911 msgid " .mo\tMessage catalog binary file\n"
11915 #: build/C/man7/suffixes.7:181
11917 msgid " .mod\tModula-2 source for implementation modules\n"
11921 #: build/C/man7/suffixes.7:182
11923 msgid " .mov\t(quicktime) movie\n"
11927 #: build/C/man7/suffixes.7:183
11929 msgid " .mp\tMetapost source\n"
11933 #: build/C/man7/suffixes.7:184
11935 msgid " .mp2\tMPEG Layer 2 (audio) file\n"
11939 #: build/C/man7/suffixes.7:185
11941 msgid " .mp3\tMPEG Layer 3 (audio) file\n"
11945 #: build/C/man7/suffixes.7:186
11947 msgid " .mpeg\tmovie file\n"
11951 #: build/C/man7/suffixes.7:187
11953 msgid " .o\tobject file\n"
11957 #: build/C/man7/suffixes.7:188
11959 msgid " .old\told or backup file\n"
11963 #: build/C/man7/suffixes.7:189
11965 msgid " .orig\tbackup (original) version of a file, from B<patch>(1)\n"
11969 #: build/C/man7/suffixes.7:190
11971 msgid " .out\toutput file, often executable program (a.out)\n"
11975 #: build/C/man7/suffixes.7:191
11977 msgid " .p\tPascal source\n"
11981 #: build/C/man7/suffixes.7:192
11983 msgid " .pag\tdbm data base data file\n"
11987 #: build/C/man7/suffixes.7:193
11989 msgid " .patch\tfile differences for B<patch>(1)\n"
11993 #: build/C/man7/suffixes.7:194
11995 msgid " .pbm\tportable bitmap format\n"
11999 #: build/C/man7/suffixes.7:195
12001 msgid " .pcf\tX11 font files\n"
12005 #: build/C/man7/suffixes.7:196
12007 msgid " .pdf\tAdobe Portable Data Format\n"
12011 #: build/C/man7/suffixes.7:197
12013 msgid "\t(use Acrobat/B<acroread> or B<xpdf>)\n"
12017 #: build/C/man7/suffixes.7:198
12019 msgid " .perl\tPerl source (see .ph, .pl and .pm)\n"
12023 #: build/C/man7/suffixes.7:199
12025 msgid " .pfa\tPostScript font definition files, ASCII format\n"
12029 #: build/C/man7/suffixes.7:200
12031 msgid " .pfb\tPostScript font definition files, binary format\n"
12035 #: build/C/man7/suffixes.7:201
12037 msgid " .pgm\tportable greymap format\n"
12041 #: build/C/man7/suffixes.7:202
12043 msgid " .pgp\tPGP binary data\n"
12047 #: build/C/man7/suffixes.7:203
12049 msgid " .ph\tPerl header file\n"
12053 #: build/C/man7/suffixes.7:204
12055 msgid " .php\tPHP program file\n"
12059 #: build/C/man7/suffixes.7:205
12061 msgid " .php3\tPHP3 program file\n"
12065 #: build/C/man7/suffixes.7:206
12067 msgid " .pid\tFile to store daemon PID (e.g., crond.pid)\n"
12071 #: build/C/man7/suffixes.7:207
12073 msgid " .pl\tTeX property list file or Perl library file\n"
12077 #: build/C/man7/suffixes.7:208
12079 msgid " .pm\tPerl module\n"
12083 #: build/C/man7/suffixes.7:209
12085 msgid " .png\tPortable Network Graphics file\n"
12089 #: build/C/man7/suffixes.7:210
12091 msgid " .po\tMessage catalog source\n"
12095 #: build/C/man7/suffixes.7:211
12097 msgid " .pod\tB<perldoc>(1) file\n"
12101 #: build/C/man7/suffixes.7:212
12103 msgid " .ppm\tportable pixmap format\n"
12107 #: build/C/man7/suffixes.7:213
12109 msgid " .pr\tbitmap source\n"
12113 #: build/C/man7/suffixes.7:214
12115 msgid " .ps\tPostScript file\n"
12119 #: build/C/man7/suffixes.7:215
12121 msgid " .py\tPython source\n"
12125 #: build/C/man7/suffixes.7:216
12127 msgid " .pyc\tcompiled python\n"
12131 #: build/C/man7/suffixes.7:217
12133 msgid " .qt\tquicktime movie\n"
12137 #: build/C/man7/suffixes.7:218
12139 msgid " .r\tRATFOR source (obsolete)\n"
12143 #: build/C/man7/suffixes.7:219
12145 msgid " .rej\tpatches that B<patch>(1) couldn't apply\n"
12149 #: build/C/man7/suffixes.7:220
12151 msgid " .rpm\tRPM software package\n"
12155 #: build/C/man7/suffixes.7:221
12157 msgid " .rtf\tRich Text Format file\n"
12161 #: build/C/man7/suffixes.7:222
12163 msgid " .rules\trules for something\n"
12167 #: build/C/man7/suffixes.7:223
12169 msgid " .s\tassembler source\n"
12173 #: build/C/man7/suffixes.7:224
12175 msgid " .sa\tstub libraries for a.out shared libraries\n"
12179 #: build/C/man7/suffixes.7:225
12181 msgid " .sc\tB<sc>(1) spreadsheet commands\n"
12185 #: build/C/man7/suffixes.7:226
12187 msgid " .scm\tScheme source code\n"
12191 #: build/C/man7/suffixes.7:227
12193 msgid " .sed\tsed source file\n"
12197 #: build/C/man7/suffixes.7:228
12199 msgid " .sgml\tSGML source file\n"
12203 #: build/C/man7/suffixes.7:229
12205 msgid " .sh\tB<sh>(1) scripts\n"
12209 #: build/C/man7/suffixes.7:230
12211 msgid " .shar\tarchive created by the B<shar>(1) utility\n"
12215 #: build/C/man7/suffixes.7:231
12217 msgid " .so\tShared library or dynamically loadable object\n"
12221 #: build/C/man7/suffixes.7:232
12223 msgid " .sql\tSQL source\n"
12227 #: build/C/man7/suffixes.7:233
12229 msgid " .sqml\tSQML schema or query program\n"
12233 #: build/C/man7/suffixes.7:234
12235 msgid " .sty\tLaTeX style files\n"
12239 #: build/C/man7/suffixes.7:235
12241 msgid " .sym\tModula-2 compiled definition modules\n"
12245 #: build/C/man7/suffixes.7:236
12247 msgid " .tar\tarchive created by the B<tar>(1) utility\n"
12251 #: build/C/man7/suffixes.7:237
12253 msgid " .tar.Z\ttar(1) archive compressed with B<compress>(1)\n"
12257 #: build/C/man7/suffixes.7:238
12259 msgid " .tar.bz2\ttar(1) archive compressed with B<bzip2>(1)\n"
12263 #: build/C/man7/suffixes.7:239
12265 msgid " .tar.gz\ttar(1) archive compressed with B<gzip>(1)\n"
12269 #: build/C/man7/suffixes.7:240
12271 msgid " .taz\ttar(1) archive compressed with B<compress>(1)\n"
12275 #: build/C/man7/suffixes.7:241
12277 msgid " .tcl\ttcl source code\n"
12281 #: build/C/man7/suffixes.7:242
12283 msgid " .tex\tTeX or LaTeX source\n"
12287 #: build/C/man7/suffixes.7:243
12289 msgid " .texi\tequivalent to I<.texinfo>\n"
12293 #: build/C/man7/suffixes.7:244
12295 msgid " .texinfo\tTexinfo documentation source\n"
12299 #: build/C/man7/suffixes.7:245
12301 msgid " .text\ttext file\n"
12305 #: build/C/man7/suffixes.7:246
12307 msgid " .tfm\tTeX font metric file\n"
12311 #: build/C/man7/suffixes.7:247
12313 msgid " .tgz\ttar archive compressed with B<gzip>(1)\n"
12317 #: build/C/man7/suffixes.7:248
12319 msgid " .tif\tpoor man's I<.tiff>\n"
12323 #: build/C/man7/suffixes.7:249
12325 msgid " .tiff\tTagged Image File Format\n"
12329 #: build/C/man7/suffixes.7:250
12331 msgid " .tk\ttcl/tk script\n"
12335 #: build/C/man7/suffixes.7:251
12337 msgid " .tmp\ttemporary file\n"
12341 #: build/C/man7/suffixes.7:252
12343 msgid " .tmpl\ttemplate files\n"
12347 #: build/C/man7/suffixes.7:253
12349 msgid " .txt\tequivalent to I<.text>\n"
12353 #: build/C/man7/suffixes.7:254
12355 msgid " .uu\tequivalent to I<.uue>\n"
12359 #: build/C/man7/suffixes.7:255
12361 msgid " .uue\tbinary file encoded with B<uuencode>(1)\n"
12365 #: build/C/man7/suffixes.7:256
12367 msgid " .vf\tTeX virtual font file\n"
12371 #: build/C/man7/suffixes.7:257
12373 msgid " .vpl\tTeX virtual property list file\n"
12377 #: build/C/man7/suffixes.7:258
12379 msgid " .w\tSilvio Levi's CWEB\n"
12383 #: build/C/man7/suffixes.7:259
12385 msgid " .wav\twave sound file\n"
12389 #: build/C/man7/suffixes.7:260
12391 msgid " .web\tDonald Knuth's WEB\n"
12395 #: build/C/man7/suffixes.7:261
12397 msgid " .wml\tSource file for Web Meta Language\n"
12401 #: build/C/man7/suffixes.7:262
12403 msgid " .xbm\tX11 bitmap source\n"
12407 #: build/C/man7/suffixes.7:263
12409 msgid " .xcf\tGIMP graphic\n"
12413 #: build/C/man7/suffixes.7:264
12415 msgid " .xml\teXtended Markup Language file\n"
12419 #: build/C/man7/suffixes.7:265
12421 msgid " .xpm\tX11 pixmap source\n"
12425 #: build/C/man7/suffixes.7:266
12427 msgid " .xs\tPerl xsub file produced by h2xs\n"
12431 #: build/C/man7/suffixes.7:267
12433 msgid " .xsl\tXSL stylesheet\n"
12437 #: build/C/man7/suffixes.7:268
12439 msgid " .y\tB<yacc>(1) or B<bison>(1) (parser generator) files\n"
12443 #: build/C/man7/suffixes.7:269
12445 msgid " .z\tFile compressed using B<pack>(1) (or an old B<gzip>(1))\n"
12449 #: build/C/man7/suffixes.7:270
12451 msgid " .zip\tB<zip>(1) archive\n"
12455 #: build/C/man7/suffixes.7:271
12457 msgid " .zoo\tB<zoo>(1) archive\n"
12461 #: build/C/man7/suffixes.7:272
12463 msgid " ~\tEmacs or B<patch>(1) backup file\n"
12467 #: build/C/man7/suffixes.7:273
12469 msgid " rc\tstartup (`run control') file, e.g., I<.newsrc>\n"
12472 #. type: Plain text
12473 #: build/C/man7/suffixes.7:277
12474 msgid "General UNIX conventions."
12477 #. type: Plain text
12478 #: build/C/man7/suffixes.7:279
12479 msgid "This list is not exhaustive."
12482 #. type: Plain text
12483 #: build/C/man7/suffixes.7:282
12484 msgid "B<file>(1), B<make>(1)"
12488 #: build/C/man3/undocumented.3:29
12490 msgid "UNDOCUMENTED"
12494 #: build/C/man3/undocumented.3:29
12499 #. type: Plain text
12500 #: build/C/man3/undocumented.3:32
12501 msgid "none - undocumented library functions"
12504 #. type: Plain text
12505 #: build/C/man3/undocumented.3:34
12506 msgid "Undocumented library functions"
12509 #. type: Plain text
12510 #: build/C/man3/undocumented.3:37
12512 "This man page mentions those library functions which are implemented in the "
12513 "standard libraries but not yet documented in man pages."
12517 #: build/C/man3/undocumented.3:37
12519 msgid "Solicitation"
12522 #. type: Plain text
12523 #: build/C/man3/undocumented.3:43
12525 "If you have information about these functions, please look in the source "
12526 "code, write a man page (using a style similar to that of the other Linux "
12527 "section 3 man pages), and send it to B<mtk.manpages@gmail.com> for inclusion "
12528 "in the next man page release."
12532 #: build/C/man3/undocumented.3:43
12537 #. .BR chflags (3),
12538 #. .BR fattach (3),
12539 #. .BR fchflags (3),
12541 #. .BR fdetach (3),
12542 #. .BR obstack stuff (3),
12543 #. type: Plain text
12544 #: build/C/man3/undocumented.3:191
12546 "B<authdes_create>(3), B<authdes_getucred>(3), B<authdes_pk_create>(3), "
12547 "B<clntunix_create>(3), B<creat64>(3), B<dn_skipname>(3), B<fcrypt>(3), "
12548 "B<fp_nquery>(3), B<fp_query>(3), B<fp_resstat>(3), B<freading>(3), "
12549 "B<freopen64>(3), B<fseeko64>(3), B<ftello64>(3), B<ftw64>(3), B<fwscanf>(3), "
12550 "B<get_avphys_pages>(3), B<getdirentries64>(3), B<getmsg>(3), "
12551 "B<getnetname>(3), B<get_nprocs>(3), B<get_nprocs_conf>(3), "
12552 "B<get_phys_pages>(3), B<getpublickey>(3), B<getsecretkey>(3), "
12553 "B<h_errlist>(3), B<host2netname>(3), B<hostalias>(3), "
12554 "B<if_freenameindex>(3), B<if_indextoname>(3), B<if_nameindex>(3), "
12555 "B<if_nametoindex>(3), B<inet_nsap_addr>(3), B<inet_nsap_ntoa>(3), "
12556 "B<init_des>(3), B<libc_nls_init>(3), B<lio_listio>(3), B<mallinfo>(3), "
12557 "B<mallopt>(3), B<mcheck>(3), B<mprobe>(3), B<mstats>(3), B<netname2host>(3), "
12558 "B<netname2user>(3), B<nlist>(3), B<obstack_free>(3), "
12559 "B<parse_printf_format>(3), B<p_cdname>(3), B<p_cdnname>(3), B<p_class>(3), "
12560 "B<p_fqname>(3), B<p_option>(3), B<p_query>(3), B<printf_size>(3), "
12561 "B<printf_size_info>(3), B<p_rr>(3), B<p_time>(3), B<p_type>(3), "
12562 "B<putlong>(3), B<putshort>(3), B<re_compile_fastmap>(3), "
12563 "B<re_compile_pattern>(3), B<register_printf_function>(3), B<re_match>(3), "
12564 "B<re_match_2>(3), B<re_rx_search>(3), B<re_search>(3), B<re_search_2>(3), "
12565 "B<re_set_registers>(3), B<re_set_syntax>(3), B<res_send_setqhook>(3), "
12566 "B<res_send_setrhook>(3), B<ruserpass>(3), B<setfileno>(3), "
12567 "B<sethostfile>(3), B<svc_exit>(3), B<svcudp_enablecache>(3), B<tell>(3), "
12568 "B<tr_break>(3), B<tzsetwall>(3), B<ufc_dofinalperm>(3), B<ufc_doit>(3), "
12569 "B<user2netname>(3), B<vlimit>(3), B<vtimes>(3), B<wcschrnul>(3), "
12570 "B<wcsftime>(3), B<wscanf>(3), B<xdr_authdes_cred>(3), "
12571 "B<xdr_authdes_verf>(3), B<xdr_cryptkeyarg>(3), B<xdr_cryptkeyres>(3), "
12572 "B<xdr_datum>(3), B<xdr_des_block>(3), B<xdr_domainname>(3), "
12573 "B<xdr_getcredres>(3), B<xdr_keybuf>(3), B<xdr_keystatus>(3), "
12574 "B<xdr_mapname>(3), B<xdr_netnamestr>(3), B<xdr_netobj>(3), B<xdr_passwd>(3), "
12575 "B<xdr_peername>(3), B<xdr_rmtcall_args>(3), B<xdr_rmtcallres>(3), "
12576 "B<xdr_unixcred>(3), B<xdr_yp_buf>(3), B<xdr_yp_inaddr>(3), "
12577 "B<xdr_ypbind_binding>(3), B<xdr_ypbind_resp>(3), B<xdr_ypbind_resptype>(3), "
12578 "B<xdr_ypbind_setdom>(3), B<xdr_ypdelete_args>(3), B<xdr_ypmaplist>(3), "
12579 "B<xdr_ypmaplist_str>(3), B<xdr_yppasswd>(3), B<xdr_ypreq_key>(3), "
12580 "B<xdr_ypreq_nokey>(3), B<xdr_ypresp_all>(3), B<xdr_ypresp_all_seq>(3), "
12581 "B<xdr_ypresp_key_val>(3), B<xdr_ypresp_maplist>(3), B<xdr_ypresp_master>(3), "
12582 "B<xdr_ypresp_order>(3), B<xdr_ypresp_val>(3), B<xdr_ypstat>(3), "
12583 "B<xdr_ypupdate_args>(3), B<yp_all>(3), B<yp_bind>(3), B<yperr_string>(3), "
12584 "B<yp_first>(3), B<yp_get_default_domain>(3), B<yp_maplist>(3), "
12585 "B<yp_master>(3), B<yp_match>(3), B<yp_next>(3), B<yp_order>(3), "
12586 "B<ypprot_err>(3), B<yp_unbind>(3), B<yp_update>(3)"
12590 #: build/C/man2/unimplemented.2:27
12592 msgid "UNIMPLEMENTED"
12596 #: build/C/man2/unimplemented.2:27
12601 #. type: Plain text
12602 #: build/C/man2/unimplemented.2:31
12604 "afs_syscall, break, ftime, getpmsg, gtty, lock, madvise1, mpx, prof, profil, "
12605 "putpmsg, security, stty, tuxcall, ulimit, vserver - unimplemented system "
12609 #. type: Plain text
12610 #: build/C/man2/unimplemented.2:33
12611 msgid "Unimplemented system calls."
12614 #. type: Plain text
12615 #: build/C/man2/unimplemented.2:35
12616 msgid "These system calls are not implemented in the Linux 2.6.22 kernel."
12619 #. type: Plain text
12620 #: build/C/man2/unimplemented.2:40
12621 msgid "These system calls always return -1 and set I<errno> to B<ENOSYS>."
12624 #. type: Plain text
12625 #: build/C/man2/unimplemented.2:47
12627 "Note that B<ftime>(3), B<profil>(3) and B<ulimit>(3) are implemented as "
12628 "library functions."
12631 #. type: Plain text
12632 #: build/C/man2/unimplemented.2:56
12634 "Some system calls, like B<alloc_hugepages>(2), B<free_hugepages>(2), "
12635 "B<ioperm>(2), B<iopl>(2), and B<vm86>(2) only exist on certain "
12639 #. type: Plain text
12640 #: build/C/man2/unimplemented.2:64
12642 "Some system calls, like B<ipc>(2), B<create_module>(2), B<init_module>(2), "
12643 "and B<delete_module>(2) only exist when the Linux kernel was built with "
12644 "support for them."
12647 #. type: Plain text
12648 #: build/C/man2/unimplemented.2:66
12649 msgid "B<syscalls>(2)"
12653 #: build/C/man7/units.7:24
12659 #: build/C/man7/units.7:24
12664 #. type: Plain text
12665 #: build/C/man7/units.7:27
12666 msgid "units, kilo, kibi, mega, mebi, giga, gibi - decimal and binary prefixes"
12670 #: build/C/man7/units.7:28
12672 msgid "Decimal prefixes"
12675 #. type: Plain text
12676 #: build/C/man7/units.7:32
12678 "The SI system of units uses prefixes that indicate powers of ten. A "
12679 "kilometer is 1000 meter, and a megawatt is 1000000 watt. Below the standard "
12684 #: build/C/man7/units.7:35 build/C/man7/units.7:76
12686 msgid "Prefix\tName\tValue\n"
12690 #: build/C/man7/units.7:36
12692 msgid "y\tyocto\t10^-24 = 0.000000000000000000000001\n"
12696 #: build/C/man7/units.7:37
12698 msgid "z\tzepto\t10^-21 = 0.000000000000000000001\n"
12702 #: build/C/man7/units.7:38
12704 msgid "a\tatto\t10^-18 = 0.000000000000000001\n"
12708 #: build/C/man7/units.7:39
12710 msgid "f\tfemto\t10^-15 = 0.000000000000001\n"
12714 #: build/C/man7/units.7:40
12716 msgid "p\tpico\t10^-12 = 0.000000000001\n"
12720 #: build/C/man7/units.7:41
12722 msgid "n\tnano\t10^-9 = 0.000000001\n"
12726 #: build/C/man7/units.7:42
12728 msgid "u\tmicro\t10^-6 = 0.000001\n"
12732 #: build/C/man7/units.7:43
12734 msgid "m\tmilli\t10^-3 = 0.001\n"
12738 #: build/C/man7/units.7:44
12740 msgid "c\tcenti\t10^-2 = 0.01\n"
12744 #: build/C/man7/units.7:45
12746 msgid "d\tdeci\t10^-1 = 0.1\n"
12750 #: build/C/man7/units.7:46
12752 msgid "da\tdeka\t10^ 1 = 10\n"
12756 #: build/C/man7/units.7:47
12758 msgid "h\thecto\t10^ 2 = 100\n"
12762 #: build/C/man7/units.7:48
12764 msgid "k\tkilo\t10^ 3 = 1000\n"
12768 #: build/C/man7/units.7:49
12770 msgid "M\tmega\t10^ 6 = 1000000\n"
12774 #: build/C/man7/units.7:50
12776 msgid "G\tgiga\t10^ 9 = 1000000000\n"
12780 #: build/C/man7/units.7:51
12782 msgid "T\ttera\t10^12 = 1000000000000\n"
12786 #: build/C/man7/units.7:52
12788 msgid "P\tpeta\t10^15 = 1000000000000000\n"
12792 #: build/C/man7/units.7:53
12794 msgid "E\texa\t10^18 = 1000000000000000000\n"
12798 #: build/C/man7/units.7:54
12800 msgid "Z\tzetta\t10^21 = 1000000000000000000000\n"
12804 #: build/C/man7/units.7:55
12806 msgid "Y\tyotta\t10^24 = 1000000000000000000000000\n"
12809 #. type: Plain text
12810 #: build/C/man7/units.7:62
12812 "The symbol for micro is the Greek letter mu, often written u in an ASCII "
12813 "context where this Greek letter is not available. See also"
12816 #. type: Plain text
12817 #: build/C/man7/units.7:65
12818 msgid "http://physics.nist.gov/cuu/Units/prefixes.html"
12822 #: build/C/man7/units.7:66
12824 msgid "Binary prefixes"
12827 #. type: Plain text
12828 #: build/C/man7/units.7:73
12830 "The binary prefixes resemble the decimal ones, but have an additional "
12831 "\\(aqi\\(aq (and \"Ki\" starts with a capital \\(aqK\\(aq). The names are "
12832 "formed by taking the first syllable of the names of the decimal prefix with "
12833 "roughly the same size, followed by \"bi\" for \"binary\"."
12837 #: build/C/man7/units.7:77
12839 msgid "Ki\tkibi\t2^10 = 1024\n"
12843 #: build/C/man7/units.7:78
12845 msgid "Mi\tmebi\t2^20 = 1048576\n"
12849 #: build/C/man7/units.7:79
12851 msgid "Gi\tgibi\t2^30 = 1073741824\n"
12855 #: build/C/man7/units.7:80
12857 msgid "Ti\ttebi\t2^40 = 1099511627776\n"
12861 #: build/C/man7/units.7:81
12863 msgid "Pi\tpebi\t2^50 = 1125899906842624\n"
12867 #: build/C/man7/units.7:82
12869 msgid "Ei\texbi\t2^60 = 1152921504606846976\n"
12872 #. type: Plain text
12873 #: build/C/man7/units.7:87
12877 #. type: Plain text
12878 #: build/C/man7/units.7:90
12879 msgid "http://physics.nist.gov/cuu/Units/binary.html"
12883 #: build/C/man7/units.7:91
12888 #. type: Plain text
12889 #: build/C/man7/units.7:96
12891 "Before these binary prefixes were introduced, it was fairly common to use "
12892 "k=1000 and K=1024, just like b=bit, B=byte. Unfortunately, the M is capital "
12893 "already, and cannot be capitalized to indicate binary-ness."
12896 #. type: Plain text
12897 #: build/C/man7/units.7:107
12899 "At first that didn't matter too much, since memory modules and disks came in "
12900 "sizes that were powers of two, so everyone knew that in such contexts "
12901 "\"kilobyte\" and \"megabyte\" meant 1024 and 1048576 bytes, respectively. "
12902 "What originally was a sloppy use of the prefixes \"kilo\" and \"mega\" "
12903 "started to become regarded as the \"real true meaning\" when computers were "
12904 "involved. But then disk technology changed, and disk sizes became arbitrary "
12905 "numbers. After a period of uncertainty all disk manufacturers settled on "
12906 "the standard, namely k=1000, M=1000k, G=1000M."
12909 #. also common: 14.4k modem
12910 #. type: Plain text
12911 #: build/C/man7/units.7:114
12913 "The situation was messy: in the 14k4 modems, k=1000; in the 1.44MB "
12914 "diskettes, M=1024000; etc. In 1998 the IEC approved the standard that "
12915 "defines the binary prefixes given above, enabling people to be precise and "
12919 #. type: Plain text
12920 #: build/C/man7/units.7:116
12921 msgid "Thus, today, MB = 1000000B and MiB = 1048576B."
12924 #. type: Plain text
12925 #: build/C/man7/units.7:120
12927 "In the free software world programs are slowly being changed to conform. "
12928 "When the Linux kernel boots and says"
12931 #. type: Plain text
12932 #: build/C/man7/units.7:124
12934 msgid "hda: 120064896 sectors (61473 MB) w/2048KiB Cache\n"
12937 #. type: Plain text
12938 #: build/C/man7/units.7:128
12939 msgid "the MB are megabytes and the KiB are kibibytes."
OSDN Git Service
