version 1.234, 2014/08/08 16:38:06 |
version 1.243, 2014/11/28 18:09:01 |
|
|
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 |
|
|
.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 1383 where relevant, for example |
|
Line 1385 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: |
|
|
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 1567 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 2497 Based on POSIX.1 and POSIX.2, published in 1992. |
|
Line 2507 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 2544 The following refer to parts of it. |
|
Line 2556 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 and related standards |
.Pp |
.Pp |
Line 2564 POSIX software administration. |
|
Line 2567 POSIX software administration. |
|
.br |
.br |
Additional real-time extensions. |
Additional real-time extensions. |
.Pp |
.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 2586 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 2682 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 2707 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 . |