version 1.139, 2010/07/19 15:43:10 |
version 1.140, 2010/07/19 21:59:48 |
|
|
Author name. |
Author name. |
This macro may alternatively accepts the following arguments, although |
This macro may alternatively accepts the following arguments, although |
these may not be specified along with a parameter: |
these may not be specified along with a parameter: |
.Bl -tag -width 12n -offset indent |
.Pp |
|
.Bl -tag -width "-nosplitX" -offset indent -compact |
.It Fl split |
.It Fl split |
Renders a line break before each author listing. |
Renders a line break before each author listing. |
.It Fl nosplit |
.It Fl nosplit |
|
|
.Fl split . |
.Fl split . |
.El |
.El |
.Pp |
.Pp |
In the AUTHORS section, the default is not to split the first author |
In the |
|
.Em AUTHORS |
|
section, the default is not to split the first author |
listing, but all subsequent author listings, whether or not they're |
listing, but all subsequent author listings, whether or not they're |
interspersed by other macros or text, are split. |
interspersed by other macros or text, are split. |
Thus, specifying |
Thus, specifying |
.Fl split |
.Fl split |
will cause the first listing also to be split. |
will cause the first listing also to be split. |
If not in the AUTHORS section, the default is not to split. |
If not in the |
|
.Em AUTHORS |
|
section, the default is not to split. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.An -nosplit |
.D1 \&.An -nosplit |
|
|
.Fl split |
.Fl split |
or |
or |
.Fl nosplit |
.Fl nosplit |
are re-set when entering the AUTHORS section, so if one specifies |
are re-set when entering the |
|
.Em AUTHORS |
|
section, so if one specifies |
.Sx \&An Fl nosplit |
.Sx \&An Fl nosplit |
in the general document body, it must be re-specified in the AUTHORS |
in the general document body, it must be re-specified in the |
|
.Em AUTHORS |
section. |
section. |
.Ss \&Ao |
.Ss \&Ao |
Begins a block enclosed by angled brackets. |
Begins a block enclosed by angled brackets. |
|
|
.Ss \&Ap |
.Ss \&Ap |
Inserts an apostrophe without any surrounding whitespace. |
Inserts an apostrophe without any surrounding whitespace. |
This is generally used as a grammatical device when referring to the verb |
This is generally used as a grammatical device when referring to the verb |
form of a function: |
form of a function. |
.Bd -literal -offset indent |
.Pp |
\&.Fn execve Ap d |
Examples: |
.Ed |
.D1 \&.Fn execve \&Ap d |
.Ss \&Aq |
.Ss \&Aq |
Encloses its arguments in angled brackets. |
Encloses its arguments in angled brackets. |
.Pp |
.Pp |
|
|
.Ss \&At |
.Ss \&At |
Formats an AT&T version. |
Formats an AT&T version. |
Accepts at most one parameter: |
Accepts at most one parameter: |
.Bl -tag -width 12n -offset indent |
.Pp |
|
.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact |
.It Cm v[1-7] | 32v |
.It Cm v[1-7] | 32v |
A version of |
A version of |
.At . |
.At . |
Line 1314 Begins a block enclosed by square brackets. |
|
Line 1323 Begins a block enclosed by square brackets. |
|
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent -compact |
\&.Bo 1 , |
\&.Bo 1 , |
\&.Dv BUFSIZ \&Bc |
\&.Dv BUFSIZ \&Bc |
.Ed |
.Ed |
Line 1347 Begins a block enclosed by curly braces. |
|
Line 1356 Begins a block enclosed by curly braces. |
|
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent -compact |
\&.Bro 1 , ... , |
\&.Bro 1 , ... , |
\&.Va n \&Brc |
\&.Va n \&Brc |
.Ed |
.Ed |
|
|
It is followed by a newline. |
It is followed by a newline. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dl % mandoc mdoc.7 | less |
.D1 \&.Dl % mandoc mdoc.7 \e(ba less |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bd |
.Sx \&Bd |
Line 1493 Begins a block enclosed by double quotes. |
|
Line 1502 Begins a block enclosed by double quotes. |
|
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot |
.Bd -literal -offset indent -compact |
|
\&.Do |
|
April is the cruellest month |
|
\&.Dc |
|
\e(em T.S. Eliot |
|
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dq . |
.Sx \&Dq . |
|
|
.Sx \&Pp . |
.Sx \&Pp . |
.Ss \&Ms |
.Ss \&Ms |
Display a mathematical symbol. |
Display a mathematical symbol. |
|
Its syntax is as follows: |
.Pp |
.Pp |
|
.D1 Pf \. Sx \&Ms Cm symbol |
|
.Pp |
Examples: |
Examples: |
.D1 \&.Ms sigma |
.D1 \&.Ms sigma |
.D1 \&.Ms aleph |
.D1 \&.Ms aleph |
|
|
.D1 \&.Xr mandoc 1 \&; |
.D1 \&.Xr mandoc 1 \&; |
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
.Ss \&br |
.Ss \&br |
|
Emits a line-break. |
|
This macro should not be used; it is implemented for compatibility with |
|
historical manuals. |
|
.Pp |
|
Consider using |
|
.Sx \&Pp |
|
in the event of natural paragraph breaks. |
.Ss \&sp |
.Ss \&sp |
|
Emits vertical space. |
|
This macro should not be used; it is implemented for compatibility with |
|
historical manuals. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&sp Op Cm height |
|
.Pp |
|
The |
|
.Cm height |
|
argument must be formatted as described in |
|
.Sx Scaling Widths . |
|
If unspecified, |
|
.Sx \&sp |
|
asserts a single vertical space. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility between mandoc and other other |
This section documents compatibility between mandoc and other other |
troff implementations, at this time limited to GNU troff |
troff implementations, at this time limited to GNU troff |