#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: man-pages-l10n VERSION\n"
"POT-Creation-Date: 2014-07-17 17:57+0900\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#. type: TH
#: man-pages/man7/man-pages.7:30
#, no-wrap
msgid "MAN-PAGES"
msgstr ""

#. type: TH
#: man-pages/man7/man-pages.7:30
#, no-wrap
msgid "2014-06-13"
msgstr ""

#. type: TH
#: man-pages/man7/man-pages.7:30
#, no-wrap
msgid "Linux"
msgstr ""

#. type: TH
#: man-pages/man7/man-pages.7:30
#, no-wrap
msgid "Linux Programmer's Manual"
msgstr ""

#. type: SH
#: man-pages/man7/man-pages.7:31
#, no-wrap
msgid "NAME"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:33
msgid "man-pages - conventions for writing Linux man pages"
msgstr ""

#. type: SH
#: man-pages/man7/man-pages.7:33
#, no-wrap
msgid "SYNOPSIS"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:37
msgid "B<man> [I<section>] I<title>"
msgstr ""

#. type: SH
#: man-pages/man7/man-pages.7:37
#, no-wrap
msgid "DESCRIPTION"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:47
msgid ""
"This page describes the conventions that should be employed when writing man "
"pages for the Linux I<man-pages> project, which documents the user-space API "
"provided by the Linux kernel and the GNU C library.  The project thus "
"provides most of the pages in Section 2, as well as many of the pages that "
"appear in Sections 3, 4, 5, and 7 of the man pages on a Linux system.  The "
"conventions described on this page may also be useful for authors writing "
"man pages for other projects."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:47
#, no-wrap
msgid "Sections of the manual pages"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:50
msgid "The manual Sections are traditionally defined as follows:"
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:50
#, no-wrap
msgid "B<1 Commands (Programs)>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:54
msgid "Those commands that can be executed by the user from within a shell."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:54
#, no-wrap
msgid "B<2 System calls>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:57
msgid "Those functions which must be performed by the kernel."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:57
#, no-wrap
msgid "B<3 Library calls>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:62
msgid "Most of the I<libc> functions."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:62
#, no-wrap
msgid "B<4 Special files (devices)>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:66
msgid "Files found in I</dev>."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:66
#, no-wrap
msgid "B<5 File formats and conventions>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:71
msgid "The format for I</etc/passwd> and other human-readable files."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:71
#, no-wrap
msgid "B<6 Games>"
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:73
#, no-wrap
msgid "B<7 Overview, conventions, and miscellaneous>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:77
msgid ""
"Overviews of various topics, conventions and protocols, character set "
"standards, and miscellaneous other things."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:77
#, no-wrap
msgid "B<8 System management commands>"
msgstr ""

#.  .TP
#.  .B 9 Kernel routines
#.  This is an obsolete manual section.
#.  Once it was thought a good idea to document the Linux kernel here,
#.  but in fact very little has been documented, and the documentation
#.  that exists is outdated already.
#.  There are better sources of
#.  information for kernel developers.
#. type: Plain text
#: man-pages/man7/man-pages.7:90
msgid "Commands like B<mount>(8), many of which only root can execute."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:90
#, no-wrap
msgid "Macro package"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:97
msgid ""
"New manual pages should be marked up using the B<groff an.tmac> package "
"described in B<man>(7).  This choice is mainly for consistency: the vast "
"majority of existing Linux manual pages are marked up using these macros."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:97
#, no-wrap
msgid "Conventions for source file layout"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:102
msgid ""
"Please limit source code line length to no more than about 75 characters "
"wherever possible.  This helps avoid line-wrapping in some mail clients when "
"patches are submitted inline."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:106
msgid ""
"New sentences should be started on new lines.  This makes it easier to see "
"the effect of patches, which often operate at the level of individual "
"sentences."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:106
#, no-wrap
msgid "Title line"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:110
msgid "The first command in a man page should be a B<TH> command:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:114
msgid "B<\\&.TH> I<title section date source manual>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:117
msgid "where:"
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:118
#, no-wrap
msgid "I<title>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:122
msgid "The title of the man page, written in all caps (e.g., I<MAN-PAGES>)."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:122
#, no-wrap
msgid "I<section>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:126
msgid ""
"The section number in which the man page should be placed (e.g., I<7>)."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:126
#, no-wrap
msgid "I<date>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:135
msgid ""
"The date of the last nontrivial change that was made to the man page.  "
"(Within the I<man-pages> project, the necessary updates to these timetamps "
"are handled automatically by scripts, so there is no need to manually update "
"them as part of a patch.)  Dates should be written in the form YYYY-MM-DD."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:135
#, no-wrap
msgid "I<source>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:138
msgid "The source of the command, function, or system call."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:142
msgid ""
"For those few I<man-pages> pages in Sections 1 and 8, probably you just want "
"to write I<GNU>."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:150
msgid ""
"For system calls, just write I<Linux>.  (An earlier practice was to write "
"the version number of the kernel from which the manual page was being "
"written/checked.  However, this was never done consistently, and so was "
"probably worse than including no version number.  Henceforth, avoid "
"including a version number.)"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:155
msgid ""
"For library calls that are part of glibc or one of the other common GNU "
"libraries, just use I<GNU C Library>, I<GNU>, or an empty string."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:158
msgid "For Section 4 pages, use I<Linux>."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:161
msgid "In cases of doubt, just write I<Linux>, or I<GNU>."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:161
#, no-wrap
msgid "I<manual>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:166
msgid ""
"The title of the manual (e.g., for Section 2 and 3 pages in the I<man-pages> "
"package, use I<Linux Programmer's Manual>)."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:167
#, no-wrap
msgid "Sections within a manual page"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:174
msgid ""
"The list below shows conventional or suggested sections.  Most manual pages "
"should include at least the B<highlighted> sections.  Arrange a new manual "
"page so that sections are placed in the order shown in the list."
msgstr ""

#.  May 07: Few current man pages have an ERROR HANDLING section,,,
#.  ERROR HANDLING,
#.  May 07: Almost no current man pages have a USAGE section,,,
#.  USAGE,
#.  DIAGNOSTICS,
#.  May 07: Almost no current man pages have a SECURITY section,,,
#.  SECURITY,
#.  AUTHORS sections are discouraged
#.  AUTHORS             [Discouraged]
#. type: Plain text
#: man-pages/man7/man-pages.7:203
#, no-wrap
msgid ""
"B<NAME>\n"
"B<SYNOPSIS>\n"
"CONFIGURATION      [Normally only in Section 4]\n"
"B<DESCRIPTION>\n"
"OPTIONS            [Normally only in Sections 1, 8]\n"
"EXIT STATUS        [Normally only in Sections 1, 8]\n"
"RETURN VALUE       [Normally only in Sections 2, 3]\n"
"ERRORS             [Typically only in Sections 2, 3]\n"
"ENVIRONMENT\n"
"FILES\n"
"VERSIONS           [Normally only in Sections 2, 3]\n"
"ATTRIBUTES         [Normally only in Sections 2, 3]\n"
"CONFORMING TO\n"
"NOTES\n"
"BUGS\n"
"EXAMPLE\n"
"B<SEE ALSO>\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:214
msgid ""
"I<Where a traditional heading would apply>, I<please use it>; this kind of "
"consistency can make the information easier to understand.  If you must, you "
"can create your own headings if they make things easier to understand (this "
"can be especially useful for pages in Sections 4 and 5).  However, before "
"doing this, consider whether you could use the traditional headings, with "
"some subsections (I<.SS>) within those sections."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:217
msgid ""
"The following list elaborates on the contents of each of the above sections."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:217
#, no-wrap
msgid "B<NAME>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:228
msgid ""
"The name of this manual page.  See B<man>(7)  for important details of the "
"line(s) that should follow the B<.SH NAME> command.  All words in this line "
"(including the word immediately following the \"\\e-\") should be in "
"lowercase, except where English or technical terminological convention "
"dictates otherwise."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:228
#, no-wrap
msgid "B<SYNOPSIS>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:240
msgid ""
"briefly describes the command or function's interface.  For commands, this "
"shows the syntax of the command and its arguments (including options); "
"boldface is used for as-is text and italics are used to indicate replaceable "
"arguments.  Brackets ([]) surround optional arguments, vertical bars (|)  "
"separate choices, and ellipses (\\&...) can be repeated.  For functions, it "
"shows any required data declarations or B<#include> directives, followed by "
"the function declaration."
msgstr ""

#.  FIXME . Say something here about compiler options
#. type: Plain text
#: man-pages/man7/man-pages.7:246
msgid ""
"Where a feature test macro must be defined in order to obtain the "
"declaration of a function (or a variable) from a header file, then the "
"SYNOPSIS should indicate this, as described in B<feature_test_macros>(7)."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:246
#, no-wrap
msgid "B<CONFIGURATION>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:250
msgid ""
"Configuration details for a device.  This section normally appears only in "
"Section 4 pages."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:250
#, no-wrap
msgid "B<DESCRIPTION>"
msgstr ""

#.  If there is some kind of input grammar or complex set of subcommands,
#.  consider describing them in a separate
#.  .B USAGE
#.  section (and just place an overview in the
#.  .B DESCRIPTION
#.  section).
#. type: Plain text
#: man-pages/man7/man-pages.7:267
msgid ""
"gives an explanation of what the program, function, or format does.  Discuss "
"how it interacts with files and standard input, and what it produces on "
"standard output or standard error.  Omit internals and implementation "
"details unless they're critical for understanding the interface.  Describe "
"the usual case; for information on command-line options of a program use the "
"B<OPTIONS> section."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:275
msgid ""
"When describing new behavior or new flags for a system call or library "
"function, be careful to note the kernel or C library version that introduced "
"the change.  The preferred method of noting this information for flags is as "
"part of a B<.TP> list, in the following form (here, for a new system call "
"flag):"
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:276
#, no-wrap
msgid "B<XYZ_FLAG> (since Linux 3.7)"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:279
msgid "Description of flag..."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:284
msgid ""
"Including version information is especially useful to users who are "
"constrained to using older kernel or C library versions (which is typical in "
"embedded systems, for example)."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:284
#, no-wrap
msgid "B<OPTIONS>"
msgstr ""

#.  .TP
#.  .B USAGE
#.  describes the grammar of any sublanguage this implements.
#. type: Plain text
#: man-pages/man7/man-pages.7:292
msgid ""
"describes the command-line options accepted by a program and how they change "
"its behavior.  This section should appear only for Section 1 and 8 manual "
"pages."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:292
#, no-wrap
msgid "B<EXIT STATUS>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:297
msgid ""
"lists the possible exit status values of a program and the conditions that "
"cause these values to be returned.  This section should appear only for "
"Section 1 and 8 manual pages."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:297
#, no-wrap
msgid "B<RETURN VALUE>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:302
msgid ""
"For Section 2 and 3 pages, this section gives a list of the values the "
"library routine will return to the caller and the conditions that cause "
"these values to be returned."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:302
#, no-wrap
msgid "B<ERRORS>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:310
msgid ""
"For Section 2 and 3 manual pages, this is a list of the values that may be "
"placed in I<errno> in the event of an error, along with information about "
"the cause of the errors.  I<The error list should be in alphabetical order>."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:310
#, no-wrap
msgid "B<ENVIRONMENT>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:314
msgid ""
"lists all environment variables that affect the program or function and how "
"they affect it."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:314
#, no-wrap
msgid "B<FILES>"
msgstr ""

#.  May 07: Almost no current man pages have a DIAGNOSTICS section;
#.          "RETURN VALUE" or "EXIT STATUS" is preferred.
#.  .TP
#.  .B DIAGNOSTICS
#.  gives an overview of the most common error messages and how to
#.  cope with them.
#.  You don't need to explain system error messages
#.  or fatal signals that can appear during execution of any program
#.  unless they're special in some way to the program.
#.  May 07: Almost no current man pages have a SECURITY section.
#. .TP
#. .B SECURITY
#. discusses security issues and implications.
#. Warn about configurations or environments that should be avoided,
#. commands that may have security implications, and so on, especially
#. if they aren't obvious.
#. Discussing security in a separate section isn't necessary;
#. if it's easier to understand, place security information in the
#. other sections (such as the
#.  .B DESCRIPTION
#.  or
#.  .B USAGE
#.  section).
#.  However, please include security information somewhere!
#. type: Plain text
#: man-pages/man7/man-pages.7:351
msgid ""
"lists the files the program or function uses, such as configuration files, "
"startup files, and files the program directly operates on.  Give the full "
"pathname of these files, and use the installation process to modify the "
"directory part to match user preferences.  For many programs, the default "
"installation location is in I</usr/local>, so your base manual page should "
"use I</usr/local> as the base."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:351
#, no-wrap
msgid "B<ATTRIBUTES>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:356
msgid ""
"A summary of various attributes of the function(s) documented on this page, "
"broken into subsections.  The following subsections are defined:"
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:358
#, no-wrap
msgid "B<Multithreading (see pthreads(7))>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:361
msgid ""
"This subsection notes attributes relating to multithreaded applications:"
msgstr ""

#. type: IP
#: man-pages/man7/man-pages.7:362 man-pages/man7/man-pages.7:364 man-pages/man7/man-pages.7:366 man-pages/man7/man-pages.7:574 man-pages/man7/man-pages.7:824 man-pages/man7/man-pages.7:826 man-pages/man7/man-pages.7:832 man-pages/man7/man-pages.7:835 man-pages/man7/man-pages.7:838 man-pages/man7/man-pages.7:841 man-pages/man7/man-pages.7:846 man-pages/man7/man-pages.7:850 man-pages/man7/man-pages.7:861 man-pages/man7/man-pages.7:874 man-pages/man7/man-pages.7:876 man-pages/man7/man-pages.7:878
#, no-wrap
msgid "*"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:364
msgid "Whether the function is thread-safe."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:366
msgid "Whether the function is a cancellation point."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:368
msgid "Whether the function is async-cancel-safe."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:372
msgid "Details of these attributes can be found in B<pthreads>(7)."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:373
#, no-wrap
msgid "B<VERSIONS>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:390
msgid ""
"A brief summary of the Linux kernel or glibc versions where a system call or "
"library function appeared, or changed significantly in its operation.  As a "
"general rule, every new interface should include a VERSIONS section in its "
"manual page.  Unfortunately, many existing manual pages don't include this "
"information (since there was no policy to do so when they were written).  "
"Patches to remedy this are welcome, but, from the perspective of programmers "
"writing new code, this information probably matters only in the case of "
"kernel interfaces that have been added in Linux 2.4 or later (i.e., changes "
"since kernel 2.2), and library functions that have been added to glibc since "
"version 2.1 (i.e., changes since glibc 2.0)."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:395
msgid ""
"The B<syscalls>(2)  manual page also provides information about kernel "
"versions in which various system calls first appeared."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:395
#, no-wrap
msgid "B<CONFORMING TO>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:412
msgid ""
"describes any standards or conventions that relate to the function or "
"command described by the manual page.  The preferred terms to use for the "
"various standards are listed as headings in B<standards>(7).  For a page in "
"Section 2 or 3, this section should note the POSIX.1 version(s) that the "
"call conforms to, and also whether the call is specified in C99.  (Don't "
"worry too much about other standards like SUS, SUSv2, and XPG, or the SVr4 "
"and 4.xBSD implementation standards, unless the call was specified in those "
"standards, but isn't in the current version of POSIX.1.)  (See "
"B<standards>(7).)"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:416
msgid ""
"If the call is not governed by any standards but commonly exists on other "
"systems, note them.  If the call is Linux-specific, note this."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:420
msgid ""
"If this section consists of just a list of standards (which it commonly "
"does), terminate the list with a period (\\(aq.\\(aq)."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:420
#, no-wrap
msgid "B<NOTES>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:425
msgid ""
"provides miscellaneous notes.  For Section 2 and 3 man pages you may find it "
"useful to include subsections (B<SS>) named I<Linux Notes> and I<Glibc "
"Notes>."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:425
#, no-wrap
msgid "B<BUGS>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:429
msgid ""
"lists limitations, known defects or inconveniences, and other questionable "
"activities."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:429
#, no-wrap
msgid "B<EXAMPLE>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:435
msgid ""
"provides one or more examples describing how this function, file or command "
"is used.  For details on writing example programs, see I<Example Programs> "
"below."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:435
#, no-wrap
msgid "B<AUTHORS>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:445
msgid ""
"lists authors of the documentation or program.  B<Use of an AUTHORS section "
"is strongly discouraged>.  Generally, it is better not to clutter every page "
"with a list of (over time potentially numerous) authors; if you write or "
"significantly amend a page, add a copyright notice as a comment in the "
"source file.  If you are the author of a device driver and want to include "
"an address for reporting bugs, place this under the BUGS section."
msgstr ""

#. type: TP
#: man-pages/man7/man-pages.7:445
#, no-wrap
msgid "B<SEE ALSO>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:452
msgid ""
"provides a comma-separated list of related man pages, ordered by section "
"number and then alphabetically by name, possibly followed by other related "
"pages or documents.  Do not terminate this with a period."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:463
msgid ""
"Where the SEE ALSO list contains many long manual page names, to improve the "
"visual result of the output, it may be useful to employ the I<.ad l> (don't "
"right justify)  and I<.nh> (don't hyphenate)  directives.  Hyphenation of "
"individual page names can be prevented by preceding words with the string "
"\"\\e%\"."
msgstr ""

#. type: SH
#: man-pages/man7/man-pages.7:463
#, no-wrap
msgid "STYLE GUIDE"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:470
msgid ""
"The following subsections describe the preferred style for the I<man-pages> "
"project.  For details not covered below, the Chicago Manual of Style is "
"usually a good source; try also grepping for preexisting usage in the "
"project source tree."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:470
#, no-wrap
msgid "Use of gender-neutral language"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:475
msgid ""
"As far as possible, use gender-neutral language in the text of man pages.  "
"Use of \"they\" (\"them\", \"themself\", \"their\") as a gender-neutral "
"singular pronoun is acceptable."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:475
#, no-wrap
msgid "Font conventions"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:480
msgid ""
"For functions, the arguments are always specified using italics, I<even in "
"the SYNOPSIS section>, where the rest of the function is specified in bold:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:482
msgid "B< int myfunction(int >I<argc>B<, char **>I<argv>B<);>"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:484
msgid "Variable names should, like argument names, be specified in italics."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:494
msgid ""
"Filenames (whether pathnames, or references to header files)  are always in "
"italics (e.g., I<E<lt>stdio.hE<gt>>), except in the SYNOPSIS section, where "
"included files are in bold (e.g., B<#include E<lt>stdio.hE<gt>>).  When "
"referring to a standard header file include, specify the header file "
"surrounded by angle brackets, in the usual C way (e.g., I<E<lt>stdio."
"hE<gt>>)."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:498
msgid ""
"Special macros, which are usually in uppercase, are in bold (e.g., "
"B<MAXINT>).  Exception: don't boldface NULL."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:503
msgid ""
"When enumerating a list of error codes, the codes are in bold (this list "
"usually uses the B<\\&.TP> macro)."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:507
msgid ""
"Complete commands should, if long, be written as an indented line on their "
"own, with a blank line before and after the command, for example"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:511
#, no-wrap
msgid "man 7 man-pages\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:521
msgid ""
"If the command is short, then it can be included inline in the text, in "
"italic format, for example, I<man 7 man-pages>.  In this case, it may be "
"worth using nonbreaking spaces (\"\\e\\ \") at suitable places in the "
"command.  Command options should be written in italics (e.g., I<-l>)."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:526
msgid ""
"Expressions, if not written on a separate indented line, should be specified "
"in italics.  Again, the use of nonbreaking spaces may be appropriate if the "
"expression is inlined with normal text."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:537
msgid ""
"Any reference to the subject of the current manual page should be written "
"with the name in bold.  If the subject is a function (i.e., this is a "
"Section 2 or 3 page), then the name should be followed by a pair of "
"parentheses in Roman (normal) font.  For example, in the B<fcntl>(2)  man "
"page, references to the subject of the page would be written as: B<fcntl>(). "
" The preferred way to write this in the source file is:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:540
#, no-wrap
msgid "    .BR fcntl ()\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:544
msgid ""
"(Using this format, rather than the use of \"\\efB...\\efP()\" makes it "
"easier to write tools that parse man page source files.)"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:553
msgid ""
"Any reference to another man page should be written with the name in bold, "
"I<always> followed by the section number, formatted in Roman (normal) font, "
"without any separating spaces (e.g., B<intro>(2)).  The preferred way to "
"write this in the source file is:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:556
#, no-wrap
msgid "    .BR intro (2)\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:561
msgid ""
"(Including the section number in cross references lets tools like "
"B<man2html>(1)  create properly hyperlinked pages.)"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:565
msgid ""
"Control characters should be written in bold face, with no quotes; for "
"example, B<^X>."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:565
#, no-wrap
msgid "Spelling"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:571
msgid ""
"Starting with release 2.59, I<man-pages> follows American spelling "
"conventions (previously, there was a random mix of British and American "
"spellings); please write all new pages and patches according to these "
"conventions."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:574
msgid ""
"Aside from the well-known spelling differences, there are a few other "
"subtleties to watch for:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:578
msgid ""
"American English tends to use the forms \"backward\", \"upward\", "
"\"toward\", and so on rather than the British forms \"backwards\", "
"\"upwards\", \"towards\", and so on."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:578
#, no-wrap
msgid "BSD version numbers"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:586
msgid ""
"The classical scheme for writing BSD version numbers is I<x.yBSD>, where I<x."
"y> is the version number (e.g., 4.2BSD).  Avoid forms such as I<BSD 4.3>."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:586
#, no-wrap
msgid "Capitalization"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:592
msgid ""
"In subsection (\"SS\") headings, capitalize the first word in the heading, "
"but otherwise use lowercase, except where English usage (e.g., proper nouns) "
"or programming language requirements (e.g., identifier names) dictate "
"otherwise.  For example:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:594
msgid ".SS Unicode under Linux"
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:595
#, no-wrap
msgid "Indentation of structure definitions, shell session logs, and so on"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:601
msgid ""
"When structure definitions, shell session logs, and so on are included in "
"running text, indent them by 4 spaces (i.e., a block enclosed by I<.in\\ "
"+4n> and I<.in>)."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:601
#, no-wrap
msgid "Preferred terms"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:604
msgid ""
"The following table lists some preferred terms to use in man pages, mainly "
"to ensure consistency across pages."
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:608
#, no-wrap
msgid "Term	Avoid using	Notes\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:610
#, no-wrap
msgid "bit mask	bitmask\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:611
#, no-wrap
msgid "built-in	builtin\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:612
#, no-wrap
msgid "Epoch	epoch	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:613
#, no-wrap
msgid "For the UNIX Epoch (00:00:00, 1 Jan 1970 UTC)\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:614 man-pages/man7/man-pages.7:625 man-pages/man7/man-pages.7:629 man-pages/man7/man-pages.7:634 man-pages/man7/man-pages.7:638 man-pages/man7/man-pages.7:644 man-pages/man7/man-pages.7:648 man-pages/man7/man-pages.7:673 man-pages/man7/man-pages.7:676 man-pages/man7/man-pages.7:679
#, no-wrap
msgid "T}\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:615
#, no-wrap
msgid "filename	file name\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:616
#, no-wrap
msgid "filesystem	file system\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:617
#, no-wrap
msgid "hostname	host name\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:618
#, no-wrap
msgid "inode	i-node\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:619
#, no-wrap
msgid "lowercase	lower case, lower-case\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:620
#, no-wrap
msgid "pathname	path name\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:621
#, no-wrap
msgid "pseudoterminal	pseudo-terminal\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:622
#, no-wrap
msgid "privileged port	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:623
#, no-wrap
msgid "reserved port,\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:624
#, no-wrap
msgid "system port\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:626
#, no-wrap
msgid "real-time	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:627
#, no-wrap
msgid "realtime,\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:628
#, no-wrap
msgid "real time\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:630
#, no-wrap
msgid "run time	runtime\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:631
#, no-wrap
msgid "saved set-group-ID	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:632
#, no-wrap
msgid "saved group ID,\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:633
#, no-wrap
msgid "saved set-GID\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:635
#, no-wrap
msgid "saved set-user-ID	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:636
#, no-wrap
msgid "saved user ID,\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:637
#, no-wrap
msgid "saved set-UID\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:639
#, no-wrap
msgid "set-group-ID	set-GID, setgid\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:640
#, no-wrap
msgid "set-user-ID	set-UID, setuid\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:641
#, no-wrap
msgid "superuser	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:642
#, no-wrap
msgid "super user,\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:643
#, no-wrap
msgid "super-user\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:645
#, no-wrap
msgid "superblock	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:646
#, no-wrap
msgid "super block,\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:647
#, no-wrap
msgid "super-block\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:649
#, no-wrap
msgid "timestamp	time stamp\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:650
#, no-wrap
msgid "timezone	time zone\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:651
#, no-wrap
msgid "uppercase	upper case, upper-case\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:652
#, no-wrap
msgid "usable	useable\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:653
#, no-wrap
msgid "user space	userspace\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:654
#, no-wrap
msgid "username	user name\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:655
#, no-wrap
msgid "zeros	zeroes\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:661
msgid "See also the discussion I<Hyphenation of attributive compounds> below."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:661
#, no-wrap
msgid "Terms to avoid"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:665
msgid ""
"The following table lists some terms to avoid using in man pages, along with "
"some suggested alternatives, mainly to ensure consistency across pages."
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:669
#, no-wrap
msgid "Avoid	Use instead	Notes\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:671
#, no-wrap
msgid "32bit	32-bit	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:672
#, no-wrap
msgid "same for 8-bit, 16-bit, etc.\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:674
#, no-wrap
msgid "current process	calling process	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:675
#, no-wrap
msgid "A common mistake made by kernel programmers when writing man pages\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:677
#, no-wrap
msgid "manpage	T{\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:678
#, no-wrap
msgid "man page, manual page\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:680
#, no-wrap
msgid "minus infinity	negative infinity\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:681
#, no-wrap
msgid "non-root	unprivileged user\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:682
#, no-wrap
msgid "non-superuser	unprivileged user\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:683
#, no-wrap
msgid "nonprivileged	unprivileged\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:684
#, no-wrap
msgid "OS	operating system\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:685
#, no-wrap
msgid "plus infinity	positive infinity\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:686
#, no-wrap
msgid "pty	pseudoterminal\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:687
#, no-wrap
msgid "tty	terminal\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:688
#, no-wrap
msgid "Unices	UNIX systems\n"
msgstr ""

#. type: tbl table
#: man-pages/man7/man-pages.7:689
#, no-wrap
msgid "Unixes	UNIX systems\n"
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:691
#, no-wrap
msgid "Trademarks"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:695
msgid ""
"Use the correct spelling and case for trademarks.  The following is a list "
"of the correct spellings of various relevant trademarks that are sometimes "
"misspelled:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:700
#, no-wrap
msgid "     DG/UX\n"
"     HP-UX\n"
"     UNIX\n"
"     UnixWare\n"
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:700
#, no-wrap
msgid "NULL, NUL, null pointer, and null character"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:712
msgid ""
"A I<null pointer> is a pointer that points to nothing, and is normally "
"indicated by the constant I<NULL>.  On the other hand, I<NUL> is the I<null "
"byte>, a byte with the value 0, represented in C via the character constant "
"I<\\(aq\\e0\\(aq>."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:715
msgid ""
"The preferred term for the pointer is \"null pointer\" or simply \"NULL\"; "
"avoid writing \"NULL pointer\"."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:723
msgid ""
"The preferred term for the byte is \"null byte\".  Avoid writing \"NUL\", "
"since it is too easily confused with \"NULL\".  Avoid also the terms \"zero "
"byte\" and \"null character\".  The byte that terminates a C string should "
"be described as \"the terminating null byte\"; strings may be described as "
"\"null-terminated\", but avoid the use of \"NUL-terminated\"."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:723
#, no-wrap
msgid "Hyperlinks"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:731
msgid ""
"For hyperlinks, use the I<.UR>/I<.UE> macro pair (see B<groff_man>(7)).  "
"This produces proper hyperlinks that can be used in a web browser, when "
"rendering a page with, say:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:733
#, no-wrap
msgid "     BROWSER=firefox man -H pagename\n"
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:733
#, no-wrap
msgid "Use of e.g., i.e., etc., a.k.a., and similar"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:737
msgid ""
"In general, the use of abbreviations such as \"e.g.\", \"i.e.\", \"etc.\", "
"\"a.k.a.\" should be avoided, in favor of suitable full wordings (\"for "
"example\", \"that is\", \"and so on\", \"also known as\")."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:741
msgid ""
"The only place where such abbreviations may be acceptable is in I<short> "
"parenthetical asides (e.g., like this one)."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:744
msgid ""
"Always include periods in such abbreviations, as shown here.  In addition, "
"\"e.g.\" and \"i.e.\" should always be followed by a comma."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:744
#, no-wrap
msgid "Em-dashes"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:752
msgid ""
"The way to write an em-dash\\(emthe glyph that appears at either end of this "
"subphrase\\(emin *roff is with the macro \"\\e(em\".  (On an ASCII terminal, "
"an em-dash typically renders as two hyphens, but in other typographical "
"contexts it renders as a long dash.)  Em-dashes should be written I<without> "
"surrounding spaces."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:752
#, no-wrap
msgid "Hyphenation of attributive compounds"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:755
msgid ""
"Compound terms should be hyphenated when used attributively (i.e., to "
"qualify a following noun). Some examples:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:762
#, no-wrap
msgid ""
"    32-bit value\n"
"    command-line argument\n"
"    floating-point number\n"
"    run-time check\n"
"    user-space function\n"
"    wide-character string\n"
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:762
#, no-wrap
msgid "Hyphenation with multi, non, pre, re, sub, and so on"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:768
msgid ""
"The general tendency in modern English is not to hyphenate after prefixes "
"such as \"multi\", \"non\", \"pre\", \"re\", \"sub\", and so on.  Manual "
"pages should generally follow this rule when these prefixes are used in "
"natural English constructions with simple suffixes.  The following list "
"gives some examples of the preferred forms:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:789
#, no-wrap
msgid ""
"    interprocess\n"
"    multithreaded\n"
"    multiprocess\n"
"    nonblocking\n"
"    nondefault\n"
"    nonempty\n"
"    noninteractive\n"
"    nonnegative\n"
"    nonportable\n"
"    nonzero\n"
"    preallocated\n"
"    precreate\n"
"    prerecorded\n"
"    reestablished\n"
"    reinitialize\n"
"    rearm\n"
"    reread\n"
"    subcomponent\n"
"    subdirectory\n"
"    subsystem\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:793
msgid ""
"Hyphens should be retained when the prefixes are used in nonstandard English "
"words, with trademarks, proper nouns, acronyms, or compound terms.  Some "
"examples:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:798
#, no-wrap
msgid "    non-ASCII\n"
"    non-English\n"
"    non-NULL\n"
"    non-real-time\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:801
msgid ""
"Finally, note that \"re-create\" and \"recreate\" are two different verbs, "
"and the former is probably what you want."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:801
#, no-wrap
msgid "Real minus character"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:806
msgid ""
"Where a real minus character is required (e.g., for numbers such as -1, or "
"when writing options that have a leading dash, such as in I<ls\\ -l>), use "
"the following form in the man page source:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:808
#, no-wrap
msgid "    \\e-\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:810
msgid "This guideline applies also to code examples."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:810
#, no-wrap
msgid "Character constants"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:813
msgid ""
"To produce single quotes that render well in both ASCII and UTF-8, use the "
"following form for character constants in the man page source:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:815
#, no-wrap
msgid "    \\e(aqC\\e(aq\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:820
msgid ""
"where I<C> is the quoted character.  This guideline applies also to "
"character constants used in code examples."
msgstr ""

#. type: SS
#: man-pages/man7/man-pages.7:820
#, no-wrap
msgid "Example programs and shell sessions"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:824
msgid ""
"Manual pages may include example programs demonstrating how to use a system "
"call or library function.  However, note the following:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:826
msgid "Example programs should be written in C."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:832
msgid ""
"An example program is necessary and useful only if it demonstrates something "
"beyond what can easily be provided in a textual description of the interface."
"  An example program that does nothing other than call an interface usually "
"serves little purpose."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:835
msgid ""
"Example programs should be fairly short (preferably less than 100 lines; "
"ideally less than 50 lines)."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:838
msgid ""
"Example programs should do error checking after system calls and library "
"function calls."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:841
msgid ""
"Example programs should be complete, and compile without warnings when "
"compiled with I<cc\\ -Wall>."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:846
msgid ""
"Where possible and appropriate, example programs should allow "
"experimentation, by varying their behavior based on inputs (ideally from "
"command-line arguments, or alternatively, via input read by the program)."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:850
msgid ""
"Example programs should be laid out according to Kernighan and Ritchie "
"style, with 4-space indents.  (Avoid the use of TAB characters in source "
"code!)"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:852
msgid ""
"For consistency, all example programs should terminate using either of:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:855
#, no-wrap
msgid "     exit(EXIT_SUCCESS);\n"
"     exit(EXIT_FAILURE);\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:857
msgid "Avoid using the following forms to terminate a program:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:861
#, no-wrap
msgid "    exit(0);\n"
"    exit(1);\n"
"    return n;\n"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:867
msgid ""
"If there is extensive explanatory text before the program source code, mark "
"off the source code with a subsection heading I<Program source>, as in:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:869
msgid ".SS Program source"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:871
msgid "Always do this if the explanatory text includes a shell session log."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:874
msgid ""
"If you include a shell session log demonstrating the use of a program or "
"other system feature:"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:876
msgid "Place the session log above the source code listing"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:878
msgid "Indent the session log by four spaces."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:881
msgid ""
"Boldface the user input text, to distinguish it from output produced by the "
"system."
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:886
msgid ""
"For some examples of what example programs should look like, see B<wait>(2)  "
"and B<pipe>(2)."
msgstr ""

#. type: SH
#: man-pages/man7/man-pages.7:886
#, no-wrap
msgid "EXAMPLE"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:893
msgid ""
"For canonical examples of how man pages in the I<man-pages> package should "
"look, see B<pipe>(2)  and B<fcntl>(2)."
msgstr ""

#. type: SH
#: man-pages/man7/man-pages.7:893
#, no-wrap
msgid "SEE ALSO"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:900
msgid ""
"B<man>(1), B<man2html>(1), B<groff>(7), B<groff_man>(7), B<man>(7), "
"B<mdoc>(7)"
msgstr ""

#. type: SH
#: man-pages/man7/man-pages.7:900
#, no-wrap
msgid "COLOPHON"
msgstr ""

#. type: Plain text
#: man-pages/man7/man-pages.7:908
msgid ""
"This page is part of release 3.70 of the Linux I<man-pages> project.  A "
"description of the project, information about reporting bugs, and the latest "
"version of this page, can be found at \\%http://www.kernel.org/doc/man-pages/"
"."
msgstr ""