version 1.234, 2014/08/08 16:38:06 |
version 1.247, 2014/12/31 20:42:31 |
|
|
References other manuals with related topics. |
References other manuals with related topics. |
This section should exist for most manuals. |
This section should exist for most manuals. |
Cross-references should conventionally be ordered first by section, then |
Cross-references should conventionally be ordered first by section, then |
alphabetically. |
alphabetically (ignoring case). |
.Pp |
.Pp |
References to other documentation concerning the topic of the manual page, |
References to other documentation concerning the topic of the manual page, |
for example authoritative books or journal articles, may also be |
for example authoritative books or journal articles, may also be |
Line 433 in the alphabetical |
|
Line 433 in the alphabetical |
|
.Ss Document preamble and NAME section macros |
.Ss Document preamble and NAME section macros |
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year |
.It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year |
.It Sx \&Dt Ta document title: Ar TITLE section Op Ar volume | arch |
.It Sx \&Dt Ta document title: Ar TITLE section Op Ar arch |
.It Sx \&Os Ta operating system version: Op Ar system Op Ar version |
.It Sx \&Os Ta operating system version: Op Ar system Op Ar version |
.It Sx \&Nm Ta document name (one argument) |
.It Sx \&Nm Ta document name (one argument) |
.It Sx \&Nd Ta document description (one line) |
.It Sx \&Nd Ta document description (one line) |
|
|
.Fl width |
.Fl width |
and |
and |
.Fl offset |
.Fl offset |
arguments accept scaling widths as described in |
arguments accept macro names as described for |
.Xr roff 7 |
.Sx \&Bd |
|
.Fl offset , |
|
scaling widths as described in |
|
.Xr roff 7 , |
or use the length of the given string. |
or use the length of the given string. |
The |
The |
.Fl offset |
.Fl offset |
|
|
and |
and |
.Sx \&Dl . |
.Sx \&Dl . |
.Ss \&Db |
.Ss \&Db |
Switch debugging mode. |
This macro is obsolete. |
Its syntax is as follows: |
No replacement is needed. |
.Pp |
It is ignored by |
.D1 Pf \. Sx \&Db Cm on | off |
.Xr mandoc 1 |
.Pp |
and groff including its arguments. |
This macro is ignored by |
It was formerly used to toggle a debugging mode. |
.Xr mandoc 1 . |
|
.Ss \&Dc |
.Ss \&Dc |
Close a |
Close a |
.Sx \&Do |
.Sx \&Do |
|
|
and |
and |
.Sx \&Os . |
.Sx \&Os . |
.Ss \&Dl |
.Ss \&Dl |
One-line intended display. |
One-line indented display. |
This is formatted as literal text and is useful for commands and |
This is formatted as literal text and is useful for commands and |
invocations. |
invocations. |
It is followed by a newline. |
It is followed by a newline. |
Line 1297 Its syntax is as follows: |
|
Line 1299 Its syntax is as follows: |
|
.Pf \. Sx \&Dt |
.Pf \. Sx \&Dt |
.Ar TITLE |
.Ar TITLE |
.Ar section |
.Ar section |
.Op Ar volume | arch |
.Op Ar arch |
.Ed |
.Ed |
.Pp |
.Pp |
Its arguments are as follows: |
Its arguments are as follows: |
Line 1312 it should by convention be all caps. |
|
Line 1314 it should by convention be all caps. |
|
The manual section. |
The manual section. |
This may be one of |
This may be one of |
.Cm 1 |
.Cm 1 |
.Pq utilities , |
.Pq General Commands , |
.Cm 2 |
.Cm 2 |
.Pq system calls , |
.Pq System Calls , |
.Cm 3 |
.Cm 3 |
.Pq libraries , |
.Pq Library Functions , |
.Cm 3p |
.Cm 3p |
.Pq Perl libraries , |
.Pq Perl Library , |
.Cm 4 |
.Cm 4 |
.Pq devices , |
.Pq Device Drivers , |
.Cm 5 |
.Cm 5 |
.Pq file formats , |
.Pq File Formats , |
.Cm 6 |
.Cm 6 |
.Pq games , |
.Pq Games , |
.Cm 7 |
.Cm 7 |
.Pq miscellaneous , |
.Pq Miscellaneous Information , |
.Cm 8 |
.Cm 8 |
.Pq system utilities , |
.Pq System Manager's Manual , |
.Cm 9 |
|
.Pq kernel functions , |
|
.Cm X11 |
|
.Pq X Window System , |
|
.Cm X11R6 |
|
.Pq X Window System , |
|
.Cm unass |
|
.Pq unassociated , |
|
.Cm local |
|
.Pq local system , |
|
.Cm draft |
|
.Pq draft manual , |
|
or |
or |
.Cm paper |
.Cm 9 |
.Pq paper . |
.Pq Kernel Developer's Manual . |
It should correspond to the manual's filename suffix and defaults to |
It should correspond to the manual's filename suffix and defaults to |
the empty string if unspecified. |
the empty string if unspecified. |
.It Ar volume |
|
This overrides the volume inferred from |
|
.Ar section . |
|
This field is optional, and if specified, must be one of |
|
.Cm USD |
|
.Pq users' supplementary documents , |
|
.Cm PS1 |
|
.Pq programmers' supplementary documents , |
|
.Cm AMD |
|
.Pq administrators' supplementary documents , |
|
.Cm SMM |
|
.Pq system managers' manuals , |
|
.Cm URM |
|
.Pq users' reference manuals , |
|
.Cm PRM |
|
.Pq programmers' reference manuals , |
|
.Cm KM |
|
.Pq kernel manuals , |
|
.Cm IND |
|
.Pq master index , |
|
.Cm MMI |
|
.Pq master index , |
|
.Cm LOCAL |
|
.Pq local manuals , |
|
.Cm LOC |
|
.Pq local manuals , |
|
or |
|
.Cm CON |
|
.Pq contributed manuals . |
|
.It Ar arch |
.It Ar arch |
This specifies the machine architecture a manual page applies to, |
This specifies the machine architecture a manual page applies to, |
where relevant, for example |
where relevant, for example |
Line 1383 where relevant, for example |
|
Line 1344 where relevant, for example |
|
.Cm i386 , |
.Cm i386 , |
or |
or |
.Cm sparc64 . |
.Cm sparc64 . |
The list of supported architectures varies by operating system. |
The list of valid architectures varies by operating system. |
For the full list of all architectures recognized by |
|
.Xr mandoc 1 , |
|
see the file |
|
.Pa arch.in |
|
in the source distribution. |
|
.El |
.El |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Dt FOO 1 |
.Dl \&.Dt FOO 1 |
.Dl \&.Dt FOO 4 KM |
|
.Dl \&.Dt FOO 9 i386 |
.Dl \&.Dt FOO 9 i386 |
.Pp |
.Pp |
See also |
See also |
|
|
and |
and |
.Sx \&It . |
.Sx \&It . |
.Ss \&Em |
.Ss \&Em |
Denotes text that should be |
Request an italic font. |
.Em emphasised . |
If the output device does not provide that, underline. |
Note that this is a presentation term and should not be used for |
|
stylistically decorating technical terms. |
|
Depending on the output device, this is usually represented |
|
using an italic font or underlined characters. |
|
.Pp |
.Pp |
|
This is most often used for stress emphasis (not to be confused with |
|
importance, see |
|
.Sx \&Sy ) . |
|
In the rare cases where none of the semantic markup macros fit, |
|
it can also be used for technical terms and placeholders, except |
|
that for syntax elements, |
|
.Sx \&Sy |
|
and |
|
.Sx \&Ar |
|
are preferred, respectively. |
|
.Pp |
Examples: |
Examples: |
.Dl \&.Em Warnings! |
.Bd -literal -compact -offset indent |
.Dl \&.Em Remarks : |
Selected lines are those |
|
\&.Em not |
|
matching any of the specified patterns. |
|
Some of the functions use a |
|
\&.Em hold space |
|
to save the pattern space for subsequent retrieval. |
|
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bf , |
.Sx \&Bf , |
Line 1557 arguments are treated as separate utilities. |
|
Line 1525 arguments are treated as separate utilities. |
|
See also |
See also |
.Sx \&Rv . |
.Sx \&Rv . |
.Ss \&Fa |
.Ss \&Fa |
Function argument. |
Function argument or parameter. |
Its syntax is as follows: |
Its syntax is as follows: |
.Bd -ragged -offset indent |
.Bd -ragged -offset indent |
.Pf \. Sx \&Fa |
.Pf \. Sx \&Fa |
Line 2120 Its syntax is as follows: |
|
Line 2088 Its syntax is as follows: |
|
The optional |
The optional |
.Ar system |
.Ar system |
parameter specifies the relevant operating system or environment. |
parameter specifies the relevant operating system or environment. |
Left unspecified, it defaults to the local operating system version. |
It is suggested to leave it unspecified, in which case |
This is the suggested form. |
.Xr mandoc 1 |
|
uses its |
|
.Fl Ios |
|
argument, or, if that isn't specified either, |
|
.Fa sysname |
|
and |
|
.Fa release |
|
as returned by |
|
.Xr uname 3 . |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Os |
.Dl \&.Os |
|
|
Close quoted context opened by |
Close quoted context opened by |
.Sx \&Qo . |
.Sx \&Qo . |
.Ss \&Ql |
.Ss \&Ql |
Format a single-quoted literal. |
Request a literal font and enclose in single quotes. |
|
For arguments of three or more characters, formatters other than |
|
.Xr mandoc 1 |
|
usually omit the quotes on non-terminal output devices. |
See also |
See also |
.Sx \&Qq |
.Sx \&Li |
and |
and |
.Sx \&Sq . |
.Sx \&Sq . |
.Ss \&Qo |
.Ss \&Qo |
Line 2416 The original C standard. |
|
Line 2395 The original C standard. |
|
.Pp |
.Pp |
.It \-isoC-99 |
.It \-isoC-99 |
.St -isoC-99 |
.St -isoC-99 |
.It \-ansiC-99 |
|
.St -ansiC-99 |
|
.br |
.br |
The second major version of the C language standard. |
The second major version of the C language standard. |
.Pp |
.Pp |
Line 2497 Based on POSIX.1 and POSIX.2, published in 1992. |
|
Line 2474 Based on POSIX.1 and POSIX.2, published in 1992. |
|
.It Single UNIX Specification version 1 and related standards |
.It Single UNIX Specification version 1 and related standards |
.Pp |
.Pp |
.Bl -tag -width "-p1003.1g-2000" -compact |
.Bl -tag -width "-p1003.1g-2000" -compact |
|
.It \-susv1 |
|
.St -susv1 |
.It \-xpg4.2 |
.It \-xpg4.2 |
.St -xpg4.2 |
.St -xpg4.2 |
.br |
.br |
This standard was published in 1994 and is also called SUSv1. |
This standard was published in 1994. |
It was used as the basis for UNIX 95 certification. |
It was used as the basis for UNIX 95 certification. |
The following three refer to parts of it. |
The following three refer to parts of it. |
.Pp |
.Pp |
Line 2515 The following three refer to parts of it. |
|
Line 2494 The following three refer to parts of it. |
|
.br |
.br |
Networking APIs, including sockets. |
Networking APIs, including sockets. |
.Pp |
.Pp |
.It \-xpg4.3 |
|
.St -xpg4.3 |
|
.Pp |
|
.It \-svid4 |
.It \-svid4 |
.St -svid4 , |
.St -svid4 , |
.br |
.br |
Line 2544 The following refer to parts of it. |
|
Line 2520 The following refer to parts of it. |
|
.Pp |
.Pp |
.It \-xns5 |
.It \-xns5 |
.St -xns5 |
.St -xns5 |
.It \-xns5.2d2.0 |
|
.St -xns5.2d2.0 |
|
.It \-xns5.2 |
.It \-xns5.2 |
.St -xns5.2 |
.St -xns5.2 |
.Pp |
|
.It \-p1387.2 |
|
.St -p1387.2 |
|
.It \-p1387.2-95 |
|
.St -p1387.2-95 |
|
.br |
|
POSIX software administration. |
|
.El |
.El |
.It Single UNIX Specification version 3 and related standards |
.It Single UNIX Specification version 3 |
.Pp |
.Pp |
.Bl -tag -width "-p1003.1g-2000X" -compact |
.Bl -tag -width "-p1003.1-2001" -compact |
.It \-p1003.1d-99 |
|
.St -p1003.1d-99 |
|
.br |
|
Additional real-time extensions. |
|
.Pp |
|
.It \-p1003.1j-2000 |
|
.St -p1003.1j-2000 |
|
.br |
|
Advanced real-time extensions. |
|
.Pp |
|
.It \-p1003.1q-2000 |
|
.St -p1003.1q-2000 |
|
.br |
|
Amendment 7: Tracing [C Language]. |
|
.Pp |
|
.It \-p1003.1-2001 |
.It \-p1003.1-2001 |
.St -p1003.1-2001 |
.St -p1003.1-2001 |
.It \-susv3 |
.It \-susv3 |
Line 2593 The second and last Technical Corrigendum. |
|
Line 2545 The second and last Technical Corrigendum. |
|
.Bl -tag -width "-p1003.1g-2000" -compact |
.Bl -tag -width "-p1003.1g-2000" -compact |
.It \-p1003.1-2008 |
.It \-p1003.1-2008 |
.St -p1003.1-2008 |
.St -p1003.1-2008 |
|
.It \-susv4 |
|
.St -susv4 |
.br |
.br |
This standard is also called SUSv4 and |
This standard is also called |
X/Open Portability Guide version 7. |
X/Open Portability Guide version 7. |
.Pp |
.Pp |
.It \-p1003.1-2013 |
.It \-p1003.1-2013 |
|
|
and |
and |
.Sx \&Ss . |
.Sx \&Ss . |
.Ss \&Sy |
.Ss \&Sy |
Format enclosed arguments in symbolic |
Request a boldface font. |
.Pq Dq boldface . |
|
Note that this is a presentation term and should not be used for |
|
stylistically decorating technical terms. |
|
.Pp |
.Pp |
|
This is most often used to indicate importance or seriousness (not to be |
|
confused with stress emphasis, see |
|
.Sx \&Em ) . |
|
When none of the semantic macros fit, it is also adequate for syntax |
|
elements that have to be given or that appear verbatim. |
|
.Pp |
|
Examples: |
|
.Bd -literal -compact -offset indent |
|
\&.Sy Warning : |
|
If |
|
\&.Sy s |
|
appears in the owner permissions, set-user-ID mode is set. |
|
This utility replaces the former |
|
\&.Sy dumpdir |
|
program. |
|
.Ed |
|
.Pp |
See also |
See also |
.Sx \&Bf , |
.Sx \&Bf , |
.Sx \&Em , |
.Sx \&Em , |
Line 2673 A variable name. |
|
Line 2641 A variable name. |
|
Examples: |
Examples: |
.Dl \&.Va foo |
.Dl \&.Va foo |
.Dl \&.Va const char *bar ; |
.Dl \&.Va const char *bar ; |
|
.Pp |
|
For function arguments and parameters, use |
|
.Sx \&Fa |
|
instead. |
|
For declarations of global variables in the |
|
.Em SYNOPSIS |
|
section, use |
|
.Sx \&Vt . |
.Ss \&Vt |
.Ss \&Vt |
A variable type. |
A variable type. |
|
.Pp |
This is also used for indicating global variables in the |
This is also used for indicating global variables in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
section, in which case a variable name is also specified. |
section, in which case a variable name is also specified. |
Line 2689 In the former case, this macro starts a new output lin |
|
Line 2666 In the former case, this macro starts a new output lin |
|
and a blank line is inserted in front if there is a preceding |
and a blank line is inserted in front if there is a preceding |
function definition or include directive. |
function definition or include directive. |
.Pp |
.Pp |
Note that this should not be confused with |
|
.Sx \&Ft , |
|
which is used for function return types. |
|
.Pp |
|
Examples: |
Examples: |
.Dl \&.Vt unsigned char |
.Dl \&.Vt unsigned char |
.Dl \&.Vt extern const char * const sys_signame[] \&; |
.Dl \&.Vt extern const char * const sys_signame[] \&; |
.Pp |
.Pp |
|
For parameters in function prototypes, use |
|
.Sx \&Fa |
|
instead, for function return types |
|
.Sx \&Ft , |
|
and for variable names outside the |
|
.Em SYNOPSIS |
|
section |
|
.Sx \&Va , |
|
even when including a type with the name. |
See also |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE . |
and |
|
.Sx \&Va . |
|
.Ss \&Xc |
.Ss \&Xc |
Close a scope opened by |
Close a scope opened by |
.Sx \&Xo . |
.Sx \&Xo . |