1275 lines
37 KiB
HTML
1275 lines
37 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of MAN-PAGES</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>MAN-PAGES</H1>
|
|
Section: Linux Programmer's Manual (7)<BR>Updated: 2019-10-10<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
man-pages - conventions for writing Linux man pages
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>man</B>
|
|
|
|
[<I>section</I>]
|
|
|
|
<I>title</I>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
This page describes the conventions that should be employed
|
|
when writing man pages for the Linux <I>man-pages</I> 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,
|
|
many of the pages that appear in Sections 3, 4, and 7,
|
|
and a few of the pages that appear in Sections 1, 5, and 8
|
|
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.
|
|
<A NAME="lbAE"> </A>
|
|
<H3>Sections of the manual pages</H3>
|
|
|
|
<P>
|
|
|
|
The manual Sections are traditionally defined as follows:
|
|
<DL COMPACT>
|
|
<DT id="1"><B>1 User commands (Programs)</B>
|
|
|
|
<DD>
|
|
Those commands that can be executed by the user from within
|
|
a shell.
|
|
<DT id="2"><B>2 System calls</B>
|
|
|
|
<DD>
|
|
Those functions which wrap operations performed by the kernel.
|
|
<DT id="3"><B>3 Library calls</B>
|
|
|
|
<DD>
|
|
All library functions excluding the system call wrappers
|
|
(Most of the
|
|
<I>libc</I>
|
|
|
|
functions).
|
|
<DT id="4"><B>4 Special files (devices)</B>
|
|
|
|
<DD>
|
|
Files found in
|
|
<I>/dev</I>
|
|
|
|
which allow to access to devices through the kernel.
|
|
<DT id="5"><B>5 File formats and configuration files</B>
|
|
|
|
<DD>
|
|
Describes various human-readable file formats and configuration files.
|
|
<DT id="6"><B>6 Games</B>
|
|
|
|
<DD>
|
|
Games and funny little programs available on the system.
|
|
<DT id="7"><B>7 Overview, conventions, and miscellaneous</B>
|
|
|
|
<DD>
|
|
Overviews or descriptions of various topics, conventions and protocols,
|
|
character set standards, the standard filesystem layout, and miscellaneous
|
|
other things.
|
|
<DT id="8"><B>8 System management commands</B>
|
|
|
|
<DD>
|
|
Commands like
|
|
<B><A HREF="/cgi-bin/man/man2html?8+mount">mount</A></B>(8),
|
|
|
|
many of which only root can execute.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H3>Macro package</H3>
|
|
|
|
New manual pages should be marked up using the
|
|
<B>groff an.tmac</B>
|
|
|
|
package described in
|
|
<B><A HREF="/cgi-bin/man/man2html?7+man">man</A></B>(7).
|
|
|
|
This choice is mainly for consistency: the vast majority of
|
|
existing Linux manual pages are marked up using these macros.
|
|
<A NAME="lbAG"> </A>
|
|
<H3>Conventions for source file layout</H3>
|
|
|
|
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.
|
|
<A NAME="lbAH"> </A>
|
|
<H3>Title line</H3>
|
|
|
|
The first command in a man page should be a
|
|
<B>TH</B>
|
|
|
|
command:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="9"><DD>
|
|
<B>.TH</B>
|
|
|
|
<I>title section date source manual</I>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
where:
|
|
<DL COMPACT><DT id="10"><DD>
|
|
<DL COMPACT>
|
|
<DT id="11"><I>title</I>
|
|
|
|
<DD>
|
|
The title of the man page, written in all caps (e.g.,
|
|
<I>MAN-PAGES</I>).
|
|
|
|
<DT id="12"><I>section</I>
|
|
|
|
<DD>
|
|
The section number in which the man page should be placed (e.g.,
|
|
<I>7</I>).
|
|
|
|
<DT id="13"><I>date</I>
|
|
|
|
<DD>
|
|
The date of the last nontrivial change that was made to the man page.
|
|
(Within the
|
|
<I>man-pages</I>
|
|
|
|
project, the necessary updates to these timestamps 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.
|
|
<DT id="14"><I>source</I>
|
|
|
|
<DD>
|
|
The source of the command, function, or system call.
|
|
<DT id="15"><DD>
|
|
For those few <I>man-pages</I> pages in Sections 1 and 8,
|
|
probably you just want to write
|
|
<I>GNU</I>.
|
|
|
|
<DT id="16"><DD>
|
|
For system calls, just write
|
|
<I>Linux</I>.
|
|
|
|
(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.)
|
|
<DT id="17"><DD>
|
|
For library calls that are part of glibc or one of the
|
|
other common GNU libraries, just use
|
|
<I>GNU C Library</I>, <I>GNU</I>,
|
|
|
|
or an empty string.
|
|
<DT id="18"><DD>
|
|
For Section 4 pages, use
|
|
<I>Linux</I>.
|
|
|
|
<DT id="19"><DD>
|
|
In cases of doubt, just write
|
|
<I>Linux</I>, or <I>GNU</I>.
|
|
|
|
<DT id="20"><I>manual</I>
|
|
|
|
<DD>
|
|
The title of the manual (e.g., for Section 2 and 3 pages in
|
|
the <I>man-pages</I> package, use
|
|
<I>Linux Programmer's Manual</I>).
|
|
|
|
</DL>
|
|
</DL>
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H3>Sections within a manual page</H3>
|
|
|
|
The list below shows conventional or suggested sections.
|
|
Most manual pages should include at least the
|
|
<B>highlighted</B>
|
|
|
|
sections.
|
|
Arrange a new manual page so that sections
|
|
are placed in the order shown in the list.
|
|
<P>
|
|
|
|
|
|
<PRE>
|
|
<B>NAME</B>
|
|
<B>SYNOPSIS</B>
|
|
CONFIGURATION [Normally only in Section 4]
|
|
<B>DESCRIPTION</B>
|
|
OPTIONS [Normally only in Sections 1, 8]
|
|
EXIT STATUS [Normally only in Sections 1, 8]
|
|
RETURN VALUE [Normally only in Sections 2, 3]
|
|
ERRORS [Typically only in Sections 2, 3]
|
|
ENVIRONMENT
|
|
FILES
|
|
VERSIONS [Normally only in Sections 2, 3]
|
|
ATTRIBUTES [Normally only in Sections 2, 3]
|
|
CONFORMING TO
|
|
NOTES
|
|
BUGS
|
|
EXAMPLE
|
|
<B>SEE ALSO</B>
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
<I>Where a traditional heading would apply</I>, <I>please use it</I>;
|
|
|
|
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</I>) within
|
|
those sections.
|
|
<P>
|
|
|
|
The following list elaborates on the contents of each of
|
|
the above sections.
|
|
<DL COMPACT>
|
|
<DT id="21"><B>NAME</B>
|
|
|
|
<DD>
|
|
The name of this manual page.
|
|
<DT id="22"><DD>
|
|
See
|
|
<B><A HREF="/cgi-bin/man/man2html?7+man">man</A></B>(7)
|
|
|
|
for important details of the line(s) that should follow the
|
|
<B>.SH NAME</B> command.
|
|
All words in this line (including the word immediately
|
|
following the "\-") should be in lowercase,
|
|
except where English or technical terminological convention
|
|
dictates otherwise.
|
|
<DT id="23"><B>SYNOPSIS</B>
|
|
|
|
<DD>
|
|
A brief summary of the command or function's interface.
|
|
<DT id="24"><DD>
|
|
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</B>
|
|
|
|
directives, followed by the function declaration.
|
|
<DT id="25"><DD>
|
|
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><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7).
|
|
|
|
|
|
<DT id="26"><B>CONFIGURATION</B>
|
|
|
|
<DD>
|
|
Configuration details for a device.
|
|
<DT id="27"><DD>
|
|
This section normally appears only in Section 4 pages.
|
|
<DT id="28"><B>DESCRIPTION</B>
|
|
|
|
<DD>
|
|
An explanation of what the program, function, or format does.
|
|
<DT id="29"><DD>
|
|
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</B>
|
|
|
|
section.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<DT id="30"><DD>
|
|
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</B>
|
|
|
|
list, in the following form (here, for a new system call flag):
|
|
<DL COMPACT><DT id="31"><DD>
|
|
<DL COMPACT>
|
|
<DT id="32"><B>XYZ_FLAG</B> (since Linux 3.7)
|
|
|
|
<DD>
|
|
Description of flag...
|
|
</DL>
|
|
</DL>
|
|
|
|
<DT id="33"><DD>
|
|
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).
|
|
<DT id="34"><B>OPTIONS</B>
|
|
|
|
<DD>
|
|
A description of the command-line options accepted by a
|
|
program and how they change its behavior.
|
|
<DT id="35"><DD>
|
|
This section should appear only for Section 1 and 8 manual pages.
|
|
|
|
|
|
|
|
<DT id="36"><B>EXIT STATUS</B>
|
|
|
|
<DD>
|
|
A list of the possible exit status values of a program and
|
|
the conditions that cause these values to be returned.
|
|
<DT id="37"><DD>
|
|
This section should appear only for Section 1 and 8 manual pages.
|
|
<DT id="38"><B>RETURN VALUE</B>
|
|
|
|
<DD>
|
|
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.
|
|
<DT id="39"><B>ERRORS</B>
|
|
|
|
<DD>
|
|
For Section 2 and 3 manual pages, this is a list of the
|
|
values that may be placed in
|
|
<I>errno</I>
|
|
|
|
in the event of an error, along with information about the cause
|
|
of the errors.
|
|
<DT id="40"><DD>
|
|
Where several different conditions produce the same error,
|
|
the preferred approach is to create separate list entries
|
|
(with duplicate error names) for each of the conditions.
|
|
This makes the separate conditions clear, may make the list easier to read,
|
|
and allows metainformation
|
|
(e.g., kernel version number where the condition first became applicable)
|
|
to be more easily marked for each condition.
|
|
<DT id="41"><DD>
|
|
<I>The error list should be in alphabetical order</I>.
|
|
|
|
<DT id="42"><B>ENVIRONMENT</B>
|
|
|
|
<DD>
|
|
A list of all environment variables that affect the program or function
|
|
and how they affect it.
|
|
<DT id="43"><B>FILES</B>
|
|
|
|
<DD>
|
|
A list of the files the program or function uses, such as
|
|
configuration files, startup files,
|
|
and files the program directly operates on.
|
|
<DT id="44"><DD>
|
|
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</I>,
|
|
|
|
so your base manual page should use
|
|
<I>/usr/local</I>
|
|
|
|
as the base.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<DT id="45"><B>ATTRIBUTES</B>
|
|
|
|
<DD>
|
|
A summary of various attributes of the function(s) documented on this page.
|
|
See
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7)
|
|
|
|
for further details.
|
|
<DT id="46"><B>VERSIONS</B>
|
|
|
|
<DD>
|
|
A brief summary of the Linux kernel or glibc versions where a
|
|
system call or library function appeared,
|
|
or changed significantly in its operation.
|
|
<DT id="47"><DD>
|
|
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).
|
|
<DT id="48"><DD>
|
|
The
|
|
<B><A HREF="/cgi-bin/man/man2html?2+syscalls">syscalls</A></B>(2)
|
|
|
|
manual page also provides information about kernel versions
|
|
in which various system calls first appeared.
|
|
<DT id="49"><B>CONFORMING TO</B>
|
|
|
|
<DD>
|
|
A description of any standards or conventions that relate to the function
|
|
or command described by the manual page.
|
|
<DT id="50"><DD>
|
|
The preferred terms to use for the various standards are listed as
|
|
headings in
|
|
<B><A HREF="/cgi-bin/man/man2html?7+standards">standards</A></B>(7).
|
|
|
|
<DT id="51"><DD>
|
|
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.)
|
|
<DT id="52"><DD>
|
|
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.
|
|
<DT id="53"><DD>
|
|
If this section consists of just a list of standards
|
|
(which it commonly does),
|
|
terminate the list with a period ('.').
|
|
<DT id="54"><B>NOTES</B>
|
|
|
|
<DD>
|
|
Miscellaneous notes.
|
|
<DT id="55"><DD>
|
|
For Section 2 and 3 man pages you may find it useful to include
|
|
subsections (<B>SS</B>) named <I>Linux Notes</I> and <I>Glibc Notes</I>.
|
|
<DT id="56"><DD>
|
|
In Section 2, use the heading
|
|
<I>C library/kernel differences</I>
|
|
|
|
to mark off notes that describe the differences (if any) between
|
|
the C library wrapper function for a system call and
|
|
the raw system call interface provided by the kernel.
|
|
<DT id="57"><B>BUGS</B>
|
|
|
|
<DD>
|
|
A list of limitations, known defects or inconveniences,
|
|
and other questionable activities.
|
|
<DT id="58"><B>EXAMPLE</B>
|
|
|
|
<DD>
|
|
One or more examples demonstrating how this function, file or
|
|
command is used.
|
|
<DT id="59"><DD>
|
|
For details on writing example programs,
|
|
see <I>Example programs</I> below.
|
|
<DT id="60"><B>AUTHORS</B>
|
|
|
|
<DD>
|
|
A list of authors of the documentation or program.
|
|
<DT id="61"><DD>
|
|
<B>Use of an AUTHORS section is strongly discouraged</B>.
|
|
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.
|
|
<DT id="62"><B>SEE ALSO</B>
|
|
|
|
<DD>
|
|
A comma-separated list of related man pages, possibly followed by
|
|
other related pages or documents.
|
|
<DT id="63"><DD>
|
|
The list should be ordered by section number and
|
|
then alphabetically by name.
|
|
Do not terminate this list with a period.
|
|
<DT id="64"><DD>
|
|
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</I>
|
|
|
|
(don't right justify)
|
|
and
|
|
<I>.nh</I>
|
|
|
|
(don't hyphenate)
|
|
directives.
|
|
Hyphenation of individual page names can be prevented
|
|
by preceding words with the string "\%".
|
|
<DT id="65"><DD>
|
|
Given the distributed, autonomous nature of FOSS projects
|
|
and their documentation, it is sometimes necessary---and in many cases
|
|
desirable---that the SEE ALSO section includes references to
|
|
manual pages provided by other projects.
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>STYLE GUIDE</H2>
|
|
|
|
The following subsections describe the preferred style for the
|
|
<I>man-pages</I>
|
|
|
|
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.
|
|
<A NAME="lbAK"> </A>
|
|
<H3>Use of gender-neutral language</H3>
|
|
|
|
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.
|
|
|
|
<A NAME="lbAL"> </A>
|
|
<H3>Formatting conventions for manual pages describing commands</H3>
|
|
|
|
<P>
|
|
|
|
For manual pages that describe a command (typically in Sections 1 and 8),
|
|
the arguments are always specified using italics,
|
|
<I>even in the SYNOPSIS section</I>.
|
|
|
|
<P>
|
|
|
|
The name of the command, and its options, should
|
|
always be formatted in bold.
|
|
|
|
<A NAME="lbAM"> </A>
|
|
<H3>Formatting conventions for manual pages describing functions</H3>
|
|
|
|
For manual pages that describe functions (typically in Sections 2 and 3),
|
|
the arguments are always specified using italics,
|
|
<I>even in the SYNOPSIS section</I>,
|
|
|
|
where the rest of the function is specified in bold:
|
|
<P>
|
|
|
|
<B> int myfunction(int </B><I>argc</I><B>, char **</B><I>argv</I><B>);</B>
|
|
|
|
<P>
|
|
|
|
Variable names should, like argument names, be specified in italics.
|
|
<P>
|
|
|
|
Any reference to the subject of the current manual page
|
|
should be written with the name in bold followed by
|
|
a pair of parentheses in Roman (normal) font.
|
|
For example, in the
|
|
<B><A HREF="/cgi-bin/man/man2html?2+fcntl">fcntl</A></B>(2)
|
|
|
|
man page, references to the subject of the page would be written as:
|
|
<B>fcntl</B>().
|
|
|
|
The preferred way to write this in the source file is:
|
|
<P>
|
|
|
|
|
|
<BR> .BR fcntl ()
|
|
|
|
<P>
|
|
|
|
(Using this format, rather than the use of "\fB...\fP()"
|
|
makes it easier to write tools that parse man page source files.)
|
|
|
|
<A NAME="lbAN"> </A>
|
|
<H3>Use semantic newlines</H3>
|
|
|
|
In the source of a manual page,
|
|
new sentences should be started on new lines,
|
|
and long sentences should split into lines at clause breaks
|
|
(commas, semicolons, colons, and so on).
|
|
This convention, sometimes known as "semantic newlines",
|
|
makes it easier to see the effect of patches,
|
|
which often operate at the level of individual sentences or sentence clauses.
|
|
|
|
<A NAME="lbAO"> </A>
|
|
<H3>Formatting conventions (general)</H3>
|
|
|
|
<P>
|
|
|
|
Paragraphs should be separated by suitable markers (usually either
|
|
<I>.PP</I>
|
|
|
|
or
|
|
<I>.IP</I>).
|
|
|
|
Do
|
|
<I>not</I>
|
|
|
|
separate paragraphs using blank lines, as this results in poor rendering
|
|
in some output formats (such as PostScript and PDF).
|
|
<P>
|
|
|
|
Filenames (whether pathnames, or references to header files)
|
|
are always in italics (e.g.,
|
|
<I><<A HREF="file:///usr/include/stdio.h">stdio.h</A>></I>),
|
|
|
|
except in the SYNOPSIS section, where included files are in bold (e.g.,
|
|
<B>#include <<A HREF="file:///usr/include/stdio.h">stdio.h</A>></B>).
|
|
|
|
When referring to a standard header file include,
|
|
specify the header file surrounded by angle brackets,
|
|
in the usual C way (e.g.,
|
|
<I><<A HREF="file:///usr/include/stdio.h">stdio.h</A>></I>).
|
|
|
|
<P>
|
|
|
|
Special macros, which are usually in uppercase, are in bold (e.g.,
|
|
<B>MAXINT</B>).
|
|
|
|
Exception: don't boldface NULL.
|
|
<P>
|
|
|
|
When enumerating a list of error codes, the codes are in bold (this list
|
|
usually uses the
|
|
<B>.TP</B>
|
|
|
|
macro).
|
|
<P>
|
|
|
|
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
|
|
<P>
|
|
|
|
|
|
|
|
man 7 man-pages
|
|
|
|
|
|
<P>
|
|
|
|
If the command is short, then it can be included inline in the text,
|
|
in italic format, for example,
|
|
<I>man 7 man-pages</I>.
|
|
|
|
In this case, it may be worth using nonbreaking spaces
|
|
("\ ") at suitable places in the command.
|
|
Command options should be written in italics (e.g.,
|
|
<I>-l</I>).
|
|
|
|
<P>
|
|
|
|
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.
|
|
<P>
|
|
|
|
When showing example shell sessions, user input should be formatted in bold, for example
|
|
<P>
|
|
|
|
|
|
|
|
$ <B>date</B>
|
|
Thu Jul 7 13:01:27 CEST 2016
|
|
|
|
|
|
<P>
|
|
|
|
<P>
|
|
|
|
Any reference to another man page
|
|
should be written with the name in bold,
|
|
<I>always</I>
|
|
|
|
followed by the section number,
|
|
formatted in Roman (normal) font, without any
|
|
separating spaces (e.g.,
|
|
<B><A HREF="/cgi-bin/man/man2html?2+intro">intro</A></B>(2)).
|
|
|
|
The preferred way to write this in the source file is:
|
|
<P>
|
|
|
|
|
|
<BR> .BR intro (2)
|
|
|
|
<P>
|
|
|
|
(Including the section number in cross references lets tools like
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man2html">man2html</A></B>(1)
|
|
|
|
create properly hyperlinked pages.)
|
|
<P>
|
|
|
|
Control characters should be written in bold face,
|
|
with no quotes; for example,
|
|
<B>^X</B>.
|
|
|
|
<A NAME="lbAP"> </A>
|
|
<H3>Spelling</H3>
|
|
|
|
Starting with release 2.59,
|
|
<I>man-pages</I>
|
|
|
|
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.
|
|
<P>
|
|
|
|
Aside from the well-known spelling differences,
|
|
there are a few other subtleties to watch for:
|
|
<DL COMPACT>
|
|
<DT id="66">*<DD>
|
|
American English tends to use the forms "backward", "upward", "toward",
|
|
and so on
|
|
rather than the British forms "backwards", "upwards", "towards", and so on.
|
|
</DL>
|
|
<A NAME="lbAQ"> </A>
|
|
<H3>BSD version numbers</H3>
|
|
|
|
The classical scheme for writing BSD version numbers is
|
|
<I>x.yBSD</I>,
|
|
|
|
where
|
|
<I>x.y</I>
|
|
|
|
is the version number (e.g., 4.2BSD).
|
|
Avoid forms such as
|
|
<I>BSD 4.3</I>.
|
|
|
|
<A NAME="lbAR"> </A>
|
|
<H3>Capitalization</H3>
|
|
|
|
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:
|
|
<P>
|
|
|
|
|
|
<BR> .SS Unicode under Linux
|
|
|
|
|
|
<A NAME="lbAS"> </A>
|
|
<H3>Indentation of structure definitions, shell session logs, and so on</H3>
|
|
|
|
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</I>
|
|
|
|
and
|
|
<I>.in</I>),
|
|
|
|
format them using the
|
|
<I>.EX</I>
|
|
|
|
and
|
|
<I>EE</I>
|
|
|
|
macros, and surround them with suitable paragraph markers (either
|
|
<I>.PP</I>
|
|
|
|
or
|
|
<I>.IP</I>).
|
|
|
|
For example:
|
|
<P>
|
|
|
|
|
|
|
|
<BR> .PP
|
|
<BR> .in +4n
|
|
<BR> .EX
|
|
<BR> int
|
|
<BR> main(int argc, char *argv[])
|
|
<BR> {
|
|
<BR> return 0;
|
|
<BR> }
|
|
<BR> .EE
|
|
<BR> .in
|
|
<BR> .PP
|
|
|
|
|
|
<A NAME="lbAT"> </A>
|
|
<H3>Preferred terms</H3>
|
|
|
|
The following table lists some preferred terms to use in man pages,
|
|
mainly to ensure consistency across pages.
|
|
<TABLE>
|
|
<TR VALIGN=top><TD>Term</TD><TD>Avoid using</TD><TD>Notes<BR></TD></TR>
|
|
<TR VALIGN=top><TD></TD></TR>
|
|
<TR VALIGN=top><TD>bit mask</TD><TD>bitmask</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>built-in</TD><TD>builtin</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>Epoch</TD><TD>epoch</TD><TD>
|
|
For the UNIX Epoch (00:00:00, 1 Jan 1970 UTC)
|
|
<BR></TD></TR>
|
|
<TR VALIGN=top><TD>filename</TD><TD>file name</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>filesystem</TD><TD>file system</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>hostname</TD><TD>host name</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>inode</TD><TD>i-node</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>lowercase</TD><TD>lower case, lower-case</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>nonzero</TD><TD>non-zero</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>pathname</TD><TD>path name</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>pseudoterminal</TD><TD>pseudo-terminal</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>privileged port</TD><TD>
|
|
reserved port,
|
|
system port
|
|
</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>real-time</TD><TD>
|
|
realtime,
|
|
real time
|
|
</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>run time</TD><TD>runtime</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>saved set-group-ID</TD><TD>
|
|
saved group ID,
|
|
saved set-GID
|
|
</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>saved set-user-ID</TD><TD>
|
|
saved user ID,
|
|
saved set-UID
|
|
</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>set-group-ID</TD><TD>set-GID, setgid</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>set-user-ID</TD><TD>set-UID, setuid</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>superuser</TD><TD>
|
|
super user,
|
|
super-user
|
|
</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>superblock</TD><TD>
|
|
super block,
|
|
super-block
|
|
</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>timestamp</TD><TD>time stamp</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>timezone</TD><TD>time zone</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>uppercase</TD><TD>upper case, upper-case</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>usable</TD><TD>useable</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>user space</TD><TD>userspace</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>username</TD><TD>user name</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>x86-64</TD><TD>x86_64</TD><TD>
|
|
Except if referring to result of "uname -m" or similar
|
|
<BR></TD></TR>
|
|
<TR VALIGN=top><TD>zeros</TD><TD>zeroes</TD><TD><BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
See also the discussion
|
|
<I>Hyphenation of attributive compounds</I>
|
|
|
|
below.
|
|
<A NAME="lbAU"> </A>
|
|
<H3>Terms to avoid</H3>
|
|
|
|
The following table lists some terms to avoid using in man pages,
|
|
along with some suggested alternatives,
|
|
mainly to ensure consistency across pages.
|
|
<TABLE>
|
|
<TR VALIGN=top><TD>Avoid</TD><TD>Use instead</TD><TD>Notes<BR></TD></TR>
|
|
<TR VALIGN=top><TD></TD></TR>
|
|
<TR VALIGN=top><TD>32bit</TD><TD>32-bit</TD><TD>
|
|
same for 8-bit, 16-bit, etc.
|
|
<BR></TD></TR>
|
|
<TR VALIGN=top><TD>current process</TD><TD>calling process</TD><TD>
|
|
A common mistake made by kernel programmers when writing man pages
|
|
<BR></TD></TR>
|
|
<TR VALIGN=top><TD>manpage</TD><TD>
|
|
man page, manual page
|
|
</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>minus infinity</TD><TD>negative infinity</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>non-root</TD><TD>unprivileged user</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>non-superuser</TD><TD>unprivileged user</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>nonprivileged</TD><TD>unprivileged</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>OS</TD><TD>operating system</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>plus infinity</TD><TD>positive infinity</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>pty</TD><TD>pseudoterminal</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>tty</TD><TD>terminal</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>Unices</TD><TD>UNIX systems</TD><TD><BR></TD></TR>
|
|
<TR VALIGN=top><TD>Unixes</TD><TD>UNIX systems</TD><TD><BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<A NAME="lbAV"> </A>
|
|
<H3>Trademarks</H3>
|
|
|
|
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:
|
|
<P>
|
|
|
|
<BR> DG/UX
|
|
<BR> HP-UX
|
|
<BR> UNIX
|
|
<BR> UnixWare
|
|
<A NAME="lbAW"> </A>
|
|
<H3>NULL, NUL, null pointer, and null character</H3>
|
|
|
|
A
|
|
<I>null pointer</I>
|
|
|
|
is a pointer that points to nothing,
|
|
and is normally indicated by the constant
|
|
<I>NULL</I>.
|
|
|
|
On the other hand,
|
|
<I>NUL</I>
|
|
|
|
is the
|
|
<I>null byte,</I>
|
|
|
|
a byte with the value 0, represented in C via the character constant
|
|
<I>'\0'</I>.
|
|
|
|
<P>
|
|
|
|
The preferred term for the pointer is "null pointer" or simply "NULL";
|
|
avoid writing "NULL pointer".
|
|
<P>
|
|
|
|
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".
|
|
<A NAME="lbAX"> </A>
|
|
<H3>Hyperlinks</H3>
|
|
|
|
For hyperlinks, use the
|
|
<I>.UR</I>/<I>.UE</I>
|
|
|
|
macro pair
|
|
(see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+groff_man">groff_man</A></B>(7)).
|
|
|
|
This produces proper hyperlinks that can be used in a web browser,
|
|
when rendering a page with, say:
|
|
<P>
|
|
|
|
<BR> BROWSER=firefox man -H pagename
|
|
<A NAME="lbAY"> </A>
|
|
<H3>Use of e.g., i.e., etc., a.k.a., and similar</H3>
|
|
|
|
In general, the use of abbreviations such as "e.g.", "i.e.", "etc.",
|
|
"cf.", and "a.k.a." should be avoided,
|
|
in favor of suitable full wordings
|
|
("for example", "that is", "compare to", "and so on", "also known as").
|
|
<P>
|
|
|
|
The only place where such abbreviations may be acceptable is in
|
|
<I>short</I>
|
|
|
|
parenthetical asides (e.g., like this one).
|
|
<P>
|
|
|
|
Always include periods in such abbreviations, as shown here.
|
|
In addition, "e.g." and "i.e." should always be followed by a comma.
|
|
<A NAME="lbAZ"> </A>
|
|
<H3>Em-dashes</H3>
|
|
|
|
The way to write an em-dash---the glyph that appears
|
|
at either end of this subphrase---in *roff is with the macro "\(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</I>
|
|
|
|
surrounding spaces.
|
|
<A NAME="lbBA"> </A>
|
|
<H3>Hyphenation of attributive compounds</H3>
|
|
|
|
Compound terms should be hyphenated when used attributively
|
|
(i.e., to qualify a following noun). Some examples:
|
|
<P>
|
|
|
|
<BR> 32-bit value
|
|
<BR> command-line argument
|
|
<BR> floating-point number
|
|
<BR> run-time check
|
|
<BR> user-space function
|
|
<BR> wide-character string
|
|
<A NAME="lbBB"> </A>
|
|
<H3>Hyphenation with multi, non, pre, re, sub, and so on</H3>
|
|
|
|
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:
|
|
<P>
|
|
|
|
<BR> interprocess
|
|
<BR> multithreaded
|
|
<BR> multiprocess
|
|
<BR> nonblocking
|
|
<BR> nondefault
|
|
<BR> nonempty
|
|
<BR> noninteractive
|
|
<BR> nonnegative
|
|
<BR> nonportable
|
|
<BR> nonzero
|
|
<BR> preallocated
|
|
<BR> precreate
|
|
<BR> prerecorded
|
|
<BR> reestablished
|
|
<BR> reinitialize
|
|
<BR> rearm
|
|
<BR> reread
|
|
<BR> subcomponent
|
|
<BR> subdirectory
|
|
<BR> subsystem
|
|
<P>
|
|
|
|
Hyphens should be retained when the prefixes are used in nonstandard
|
|
English words, with trademarks, proper nouns, acronyms, or compound terms.
|
|
Some examples:
|
|
<P>
|
|
|
|
<BR> non-ASCII
|
|
<BR> non-English
|
|
<BR> non-NULL
|
|
<BR> non-real-time
|
|
<P>
|
|
|
|
Finally, note that "re-create" and "recreate" are two different verbs,
|
|
and the former is probably what you want.
|
|
<A NAME="lbBC"> </A>
|
|
<H3>Real minus character</H3>
|
|
|
|
Where a real minus character is required (e.g., for numbers such as -1,
|
|
for man page cross references such as
|
|
<B><A HREF="/cgi-bin/man/man2html?7+utf-8">utf-8</A></B>(7),
|
|
|
|
or when writing options that have a leading dash, such as in
|
|
<I>ls -l),</I>
|
|
|
|
use the following form in the man page source:
|
|
<P>
|
|
|
|
<BR> \-
|
|
<P>
|
|
|
|
This guideline applies also to code examples.
|
|
<A NAME="lbBD"> </A>
|
|
<H3>Character constants</H3>
|
|
|
|
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:
|
|
<P>
|
|
|
|
<BR> \(aqC\(aq
|
|
<P>
|
|
|
|
where
|
|
<I>C</I>
|
|
|
|
is the quoted character.
|
|
This guideline applies also to character constants used in code examples.
|
|
<A NAME="lbBE"> </A>
|
|
<H3>Example programs and shell sessions</H3>
|
|
|
|
Manual pages may include example programs demonstrating how to
|
|
use a system call or library function.
|
|
However, note the following:
|
|
<DL COMPACT>
|
|
<DT id="67">*<DD>
|
|
Example programs should be written in C.
|
|
<DT id="68">*<DD>
|
|
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.
|
|
<DT id="69">*<DD>
|
|
Example programs should be fairly short (preferably less than 100 lines;
|
|
ideally less than 50 lines).
|
|
<DT id="70">*<DD>
|
|
Example programs should do error checking after system calls and
|
|
library function calls.
|
|
<DT id="71">*<DD>
|
|
Example programs should be complete, and compile without
|
|
warnings when compiled with <I>cc -Wall</I>.
|
|
<DT id="72">*<DD>
|
|
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).
|
|
<DT id="73">*<DD>
|
|
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!)
|
|
The following command can be used to format your source code to
|
|
something close to the preferred style:
|
|
<DT id="74"><DD>
|
|
<BR> indent -npro -kr -i4 -ts4 -sob -l72 -ss -nut -psl prog.c
|
|
<DT id="75">*<DD>
|
|
For consistency, all example programs should terminate using either of:
|
|
<DT id="76"><DD>
|
|
<BR> exit(EXIT_SUCCESS);
|
|
<BR> exit(EXIT_FAILURE);
|
|
<DT id="77"><DD>
|
|
Avoid using the following forms to terminate a program:
|
|
<DT id="78"><DD>
|
|
<BR> exit(0);
|
|
<BR> <A HREF="/cgi-bin/man/man2html?1+exit">exit</A>(1);
|
|
<BR> return n;
|
|
<DT id="79">*<DD>
|
|
If there is extensive explanatory text before the
|
|
program source code, mark off the source code
|
|
with a subsection heading
|
|
<I>Program source</I>,
|
|
|
|
as in:
|
|
<DT id="80"><DD>
|
|
<BR> .SS Program source
|
|
<DT id="81"><DD>
|
|
Always do this if the explanatory text includes a shell session log.
|
|
</DL>
|
|
<P>
|
|
|
|
If you include a shell session log demonstrating the use of a program
|
|
or other system feature:
|
|
<DL COMPACT>
|
|
<DT id="82">*<DD>
|
|
Place the session log above the source code listing
|
|
<DT id="83">*<DD>
|
|
Indent the session log by four spaces.
|
|
<DT id="84">*<DD>
|
|
Boldface the user input text,
|
|
to distinguish it from output produced by the system.
|
|
</DL>
|
|
<P>
|
|
|
|
For some examples of what example programs should look like, see
|
|
<B><A HREF="/cgi-bin/man/man2html?2+wait">wait</A></B>(2)
|
|
|
|
and
|
|
<B><A HREF="/cgi-bin/man/man2html?2+pipe">pipe</A></B>(2).
|
|
|
|
<A NAME="lbBF"> </A>
|
|
<H2>EXAMPLE</H2>
|
|
|
|
For canonical examples of how man pages in the
|
|
<I>man-pages</I>
|
|
|
|
package should look, see
|
|
<B><A HREF="/cgi-bin/man/man2html?2+pipe">pipe</A></B>(2)
|
|
|
|
and
|
|
<B><A HREF="/cgi-bin/man/man2html?2+fcntl">fcntl</A></B>(2).
|
|
|
|
<A NAME="lbBG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man">man</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man2html">man2html</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+groff">groff</A></B>(7),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+groff_man">groff_man</A></B>(7),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+man">man</A></B>(7),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+mdoc">mdoc</A></B>(7)
|
|
|
|
<A NAME="lbBH"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="85"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="86"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="87"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DL>
|
|
<DT id="88"><A HREF="#lbAE">Sections of the manual pages</A><DD>
|
|
<DT id="89"><A HREF="#lbAF">Macro package</A><DD>
|
|
<DT id="90"><A HREF="#lbAG">Conventions for source file layout</A><DD>
|
|
<DT id="91"><A HREF="#lbAH">Title line</A><DD>
|
|
<DT id="92"><A HREF="#lbAI">Sections within a manual page</A><DD>
|
|
</DL>
|
|
<DT id="93"><A HREF="#lbAJ">STYLE GUIDE</A><DD>
|
|
<DL>
|
|
<DT id="94"><A HREF="#lbAK">Use of gender-neutral language</A><DD>
|
|
<DT id="95"><A HREF="#lbAL">Formatting conventions for manual pages describing commands</A><DD>
|
|
<DT id="96"><A HREF="#lbAM">Formatting conventions for manual pages describing functions</A><DD>
|
|
<DT id="97"><A HREF="#lbAN">Use semantic newlines</A><DD>
|
|
<DT id="98"><A HREF="#lbAO">Formatting conventions (general)</A><DD>
|
|
<DT id="99"><A HREF="#lbAP">Spelling</A><DD>
|
|
<DT id="100"><A HREF="#lbAQ">BSD version numbers</A><DD>
|
|
<DT id="101"><A HREF="#lbAR">Capitalization</A><DD>
|
|
<DT id="102"><A HREF="#lbAS">Indentation of structure definitions, shell session logs, and so on</A><DD>
|
|
<DT id="103"><A HREF="#lbAT">Preferred terms</A><DD>
|
|
<DT id="104"><A HREF="#lbAU">Terms to avoid</A><DD>
|
|
<DT id="105"><A HREF="#lbAV">Trademarks</A><DD>
|
|
<DT id="106"><A HREF="#lbAW">NULL, NUL, null pointer, and null character</A><DD>
|
|
<DT id="107"><A HREF="#lbAX">Hyperlinks</A><DD>
|
|
<DT id="108"><A HREF="#lbAY">Use of e.g., i.e., etc., a.k.a., and similar</A><DD>
|
|
<DT id="109"><A HREF="#lbAZ">Em-dashes</A><DD>
|
|
<DT id="110"><A HREF="#lbBA">Hyphenation of attributive compounds</A><DD>
|
|
<DT id="111"><A HREF="#lbBB">Hyphenation with multi, non, pre, re, sub, and so on</A><DD>
|
|
<DT id="112"><A HREF="#lbBC">Real minus character</A><DD>
|
|
<DT id="113"><A HREF="#lbBD">Character constants</A><DD>
|
|
<DT id="114"><A HREF="#lbBE">Example programs and shell sessions</A><DD>
|
|
</DL>
|
|
<DT id="115"><A HREF="#lbBF">EXAMPLE</A><DD>
|
|
<DT id="116"><A HREF="#lbBG">SEE ALSO</A><DD>
|
|
<DT id="117"><A HREF="#lbBH">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:09 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|