version 1.24, 2009/08/13 12:31:50 |
version 1.26, 2009/08/17 11:03:07 |
|
|
This section is a canonical reference to all macros, arranged |
This section is a canonical reference to all macros, arranged |
alphabetically. For the scoping of individual macros, see |
alphabetically. For the scoping of individual macros, see |
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
|
.\" SUBSECTION |
|
.Ss Terms |
|
In this reference, a numerical width may be either a standalone natural |
|
number (such as 3, 4, 10, etc.) or a natural number followed by a width |
|
multiplier |
|
.Qq n , |
|
corresponding to the width of the formatted letter n, or |
|
.Qq m , |
|
corresponding to the width of the formatted letter m. The latter is the |
|
default, if unspecified. |
|
.\" SUBSECTION |
|
.Ss Macro Reference |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It \&B |
.It \&B |
Text is rendered in bold face. |
Text is rendered in bold face. |
Line 283 Whitespace between arguments is omitted in output. |
|
Line 295 Whitespace between arguments is omitted in output. |
|
.It \&HP |
.It \&HP |
Begin a paragraph whose initial output line is left-justified, but |
Begin a paragraph whose initial output line is left-justified, but |
subsequent output lines are indented. |
subsequent output lines are indented. |
.\" TODO. |
|
.It \&I |
.It \&I |
Text is rendered in italics. |
Text is rendered in italics. |
.It \&IB |
.It \&IB |
Text is rendered alternately in italics and bold face. Whitespace |
Text is rendered alternately in italics and bold face. Whitespace |
between arguments is omitted in output. |
between arguments is omitted in output. |
.It \&IP |
.It \&IP |
.\" TODO. |
Begin a paragraph with the following syntax: |
|
.Bd -literal -offset indent |
|
\&.IP [head [width]] |
|
.Ed |
|
.Pp |
|
This follows the behaviour of the |
|
.Sq \&TP |
|
except for the macro syntax (all arguments on the line, instead of |
|
having next-line scope). |
.It \&IR |
.It \&IR |
Text is rendered alternately in italics and roman (the default font). |
Text is rendered alternately in italics and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
Line 339 string specifies the organisation providing the utilit |
|
Line 358 string specifies the organisation providing the utilit |
|
.Va volume |
.Va volume |
replaces the default rendered volume as dictated by the manual section. |
replaces the default rendered volume as dictated by the manual section. |
.It \&TP |
.It \&TP |
Begin a paragraph where the head, if exceeding the indentation point, is |
Begin a paragraph where the head, if exceeding the indentation width, is |
followed by a newline; if not, the body follows on the same line after a |
followed by a newline; if not, the body follows on the same line after a |
buffer to the indentation point. Subsequent output lines are indented. |
buffer to the indentation width. Subsequent output lines are indented. |
|
.Pp |
|
The indentation width may be set as follows: |
|
.Bd -literal -offset indent |
|
\&.TP [width] |
|
.Ed |
|
.Pp |
|
Where |
|
.Va width |
|
must be a properly-formed numeric width. If unspecified or improperly |
|
formed, the default indentation width is used. |
.It \&br |
.It \&br |
Breaks the current line. Consecutive invocations have no further effect. |
Breaks the current line. Consecutive invocations have no further effect. |
.\" TODO. |
|
.It \&fi |
.It \&fi |
End literal mode begun by |
End literal mode begun by |
.Sq \&nf . |
.Sq \&nf . |