version 1.231, 2014/07/02 03:48:07 |
version 1.234, 2014/08/08 16:38:06 |
Line 468 in the alphabetical |
|
Line 468 in the alphabetical |
|
.It Sx \&Pf Ta prefix, no following horizontal space (one argument) |
.It Sx \&Pf Ta prefix, no following horizontal space (one argument) |
.It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments) |
.It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments) |
.It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments) |
.It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments) |
.It Sx \&Sm Ta switch horizontal spacing mode: Cm on | off |
.It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off |
.It Sx \&Bk , \&Ek Ta keep block: Fl words |
.It Sx \&Bk , \&Ek Ta keep block: Fl words |
.It Sx \&br Ta force output line break in text mode (no arguments) |
.It Sx \&br Ta force output line break in text mode (no arguments) |
.It Sx \&sp Ta force vertical space: Op Ar height |
.It Sx \&sp Ta force vertical space: Op Ar height |
|
|
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
.Ss \&Dd |
.Ss \&Dd |
Document date. |
Document date for display in the page footer. |
This is the mandatory first macro of any |
This is the mandatory first macro of any |
.Nm |
.Nm |
manual. |
manual. |
Line 1224 the special string |
|
Line 1224 the special string |
|
.Dq $\&Mdocdate$ |
.Dq $\&Mdocdate$ |
can be given as an argument. |
can be given as an argument. |
.It |
.It |
A few alternative date formats are accepted as well |
The traditional, purely numeric |
and converted to the standard form. |
.Xr man 7 |
|
format |
|
.Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day |
|
is accepted, too. |
.It |
.It |
If a date string cannot be parsed, it is used verbatim. |
If a date string cannot be parsed, it is used verbatim. |
.It |
.It |
|
|
and |
and |
.Sx \&Do . |
.Sx \&Do . |
.Ss \&Dt |
.Ss \&Dt |
Document title. |
Document title for display in the page header. |
This is the mandatory second macro of any |
This is the mandatory second macro of any |
.Nm |
.Nm |
file. |
file. |
Its syntax is as follows: |
Its syntax is as follows: |
.Bd -ragged -offset indent |
.Bd -ragged -offset indent |
.Pf \. Sx \&Dt |
.Pf \. Sx \&Dt |
.Oo |
.Ar TITLE |
.Ar title |
|
.Oo |
|
.Ar section |
.Ar section |
.Op Ar volume |
.Op Ar volume | arch |
.Op Ar arch |
|
.Oc |
|
.Oc |
|
.Ed |
.Ed |
.Pp |
.Pp |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds -offset Ds |
.Bl -tag -width section -offset 2n |
.It Ar title |
.It Ar TITLE |
The document's title (name), defaulting to |
The document's title (name), defaulting to |
.Dq UNKNOWN |
.Dq UNTITLED |
if unspecified. |
if unspecified. |
It should be capitalised. |
To achieve a uniform appearance of page header lines, |
|
it should by convention be all caps. |
.It Ar section |
.It Ar section |
The manual section. |
The manual section. |
This may be one of |
This may be one of |
|
|
.Cm paper |
.Cm paper |
.Pq paper . |
.Pq paper . |
It should correspond to the manual's filename suffix and defaults to |
It should correspond to the manual's filename suffix and defaults to |
.Cm 1 |
the empty string if unspecified. |
if unspecified. |
|
.It Ar volume |
.It Ar volume |
This overrides the volume inferred from |
This overrides the volume inferred from |
.Ar section . |
.Ar section . |
Line 1563 Function argument. |
|
Line 1561 Function argument. |
|
Its syntax is as follows: |
Its syntax is as follows: |
.Bd -ragged -offset indent |
.Bd -ragged -offset indent |
.Pf \. Sx \&Fa |
.Pf \. Sx \&Fa |
.Op Cm argtype |
.Qo |
.Cm argname |
.Op Ar argtype |
|
.Op Ar argname |
|
.Qc Ar \&... |
.Ed |
.Ed |
.Pp |
.Pp |
This may be invoked for names with or without the corresponding type. |
Each argument may be a name and a type (recommended for the |
It is also used to specify the field name of a structure. |
.Em SYNOPSIS |
|
section), a name alone (for function invocations), |
|
or a type alone (for function prototypes). |
|
If both a type and a name are given or if the type consists of multiple |
|
words, all words belonging to the same function argument have to be |
|
given in a single argument to the |
|
.Sx \&Fa |
|
macro. |
|
.Pp |
|
This macro is also used to specify the field name of a structure. |
|
.Pp |
Most often, the |
Most often, the |
.Sx \&Fa |
.Sx \&Fa |
macro is used in the |
macro is used in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
within |
within |
.Sx \&Fo |
.Sx \&Fo |
section when documenting multi-line function prototypes. |
blocks when documenting multi-line function prototypes. |
If invoked with multiple arguments, the arguments are separated by a |
If invoked with multiple arguments, the arguments are separated by a |
comma. |
comma. |
Furthermore, if the following macro is another |
Furthermore, if the following macro is another |
Line 1585 the last argument will also have a trailing comma. |
|
Line 1595 the last argument will also have a trailing comma. |
|
Examples: |
Examples: |
.Dl \&.Fa \(dqconst char *p\(dq |
.Dl \&.Fa \(dqconst char *p\(dq |
.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.Dl \&.Fa foo |
.Dl \&.Fa \(dqchar *\(dq size_t |
.Pp |
.Pp |
See also |
See also |
.Sx \&Fo . |
.Sx \&Fo . |
Line 1688 Invocations usually occur in the following context: |
|
Line 1698 Invocations usually occur in the following context: |
|
.br |
.br |
.Pf \. Sx \&Fo Ar funcname |
.Pf \. Sx \&Fo Ar funcname |
.br |
.br |
.Pf \. Sx \&Fa Oo Ar argtype Oc Ar argname |
.Pf \. Sx \&Fa Qq Ar argtype Ar argname |
.br |
.br |
\&.\.\. |
\&.\.\. |
.br |
.br |
|
|
See also |
See also |
.Sx \&Oo . |
.Sx \&Oo . |
.Ss \&Os |
.Ss \&Os |
Document operating system version. |
Operating system version for display in the page footer. |
This is the mandatory third macro of |
This is the mandatory third macro of |
any |
any |
.Nm |
.Nm |
|
|
Switches the spacing mode for output generated from macros. |
Switches the spacing mode for output generated from macros. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Sm Cm on | off |
.D1 Pf \. Sx \&Sm Op Cm on | off |
.Pp |
.Pp |
By default, spacing is |
By default, spacing is |
.Cm on . |
.Cm on . |
|
|
no white space is inserted between macro arguments and between the |
no white space is inserted between macro arguments and between the |
output generated from adjacent macros, but text lines |
output generated from adjacent macros, but text lines |
still get normal spacing between words and sentences. |
still get normal spacing between words and sentences. |
|
.Pp |
|
When called without an argument, the |
|
.Sx \&Sm |
|
macro toggles the spacing mode. |
|
Using this is not recommended because it makes the code harder to read. |
.Ss \&So |
.Ss \&So |
Multi-line version of |
Multi-line version of |
.Sx \&Sq . |
.Sx \&Sq . |
Line 3012 then the macro accepts an arbitrary number of argument |
|
Line 3027 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Pf Ta Yes Ta Yes Ta 1 |
.It Sx \&Pf Ta Yes Ta Yes Ta 1 |
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
.It Sx \&Rv Ta \&No Ta \&No Ta n |
.It Sx \&Rv Ta \&No Ta \&No Ta n |
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
.It Sx \&Sm Ta \&No Ta \&No Ta <2 |
.It Sx \&St Ta \&No Ta Yes Ta 1 |
.It Sx \&St Ta \&No Ta Yes Ta 1 |
.It Sx \&Sx Ta Yes Ta Yes Ta >0 |
.It Sx \&Sx Ta Yes Ta Yes Ta >0 |
.It Sx \&Sy Ta Yes Ta Yes Ta >0 |
.It Sx \&Sy Ta Yes Ta Yes Ta >0 |