version 1.22, 2009/08/13 11:45:29 |
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 . |
.Bl -tag -width Ds -offset indent |
.\" 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 |
.It \&B |
.It \&B |
Text is rendered in bold face. |
Text is rendered in bold face. |
.It \&BI |
.It \&BI |
Line 281 render in italics. Whitespace between arguments is om |
|
Line 293 render in italics. Whitespace between arguments is om |
|
Text is rendered alternately in bold face and roman (the default font). |
Text is rendered alternately in bold face and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.It \&HP |
.It \&HP |
.\" TODO. |
Begin a paragraph whose initial output line is left-justified, but |
|
subsequent output lines are indented. |
.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 337 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 |
.\" TODO. |
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 |
|
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 . |
|
|
.El |
.El |
.\" SECTION |
.\" SECTION |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
See |
This section documents compatibility with other roff implementations, at |
.Xr mdoc 7 |
this time limited to |
for groff compatibility notes. |
.Xr groff 1 . |
|
.Bl -hyphen |
|
.It |
|
In quoted literals, groff allowed pair-wise double-quotes to produce a |
|
standalone double-quote in formatted output. This idiosyncratic |
|
behaviour is no longer applicable. |
|
.It |
|
The |
|
.Sq \&sp |
|
macro does not accept negative numbers. |
|
.It |
|
Blocks of whitespace are stripped from both macro and free-form text |
|
lines (except when in literal mode), while groff would retain whitespace |
|
in free-form text lines. |
|
.El |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
Line 374 for groff compatibility notes. |
|
Line 420 for groff compatibility notes. |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" SECTION |
.\" SECTION |
.Sh CAVEATS |
.Sh CAVEATS |