version 1.4, 2009/03/26 16:23:22 |
version 1.7, 2009/03/27 15:22:56 |
|
|
\&.SH Macro lines change control state. |
\&.SH Macro lines change control state. |
Other lines are interpreted within the current state. |
Other lines are interpreted within the current state. |
.Ed |
.Ed |
.\" PARAGRAPH |
|
.Pp |
|
Macros are character sequences whose structural rules are described |
|
later in this document. |
|
.\" SECTION |
.\" SECTION |
.Sh INPUT ENCODING |
.Sh INPUT ENCODING |
.Nm |
.Nm |
Line 64 documents may contain only graphable 7-bit ASCII chara |
|
Line 60 documents may contain only graphable 7-bit ASCII chara |
|
space character |
space character |
.Sq \ . |
.Sq \ . |
All manuals must have |
All manuals must have |
|
.Ux |
.Sq \en |
.Sq \en |
line termination. |
line termination. |
.Pp |
.Pp |
Blank lines are acceptable; where found, the output will also assert a |
Blank lines are acceptable; where found, the output will assert a |
vertical space. |
vertical space. |
.Pp |
.Pp |
The |
The |
Line 91 or a single one-character sequence. |
|
Line 88 or a single one-character sequence. |
|
Characters may alternatively be escaped by a slash-asterisk, |
Characters may alternatively be escaped by a slash-asterisk, |
.Sq \e* , |
.Sq \e* , |
with the same combinations as described above. This form is deprecated. |
with the same combinations as described above. This form is deprecated. |
.Pp |
|
The |
|
.Xr mdoc 7 |
|
contains a table of all available escapes. |
|
.\" SECTION |
.\" SECTION |
.Sh STRUCTURE |
.Sh STRUCTURE |
Macros are one to three three characters in length and begin with a |
Macros are one to three three characters in length and begin with a |
|
|
.Sq \&.RI . |
.Sq \&.RI . |
When these macros are invoked without arguments, the subsequent line is |
When these macros are invoked without arguments, the subsequent line is |
considered a continuation of the macro. Thus: |
considered a continuation of the macro. Thus: |
.Bd -literal -offset indent |
|
\&.RI foo |
|
.Ed |
|
.Pp |
|
and |
|
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.RI |
\&.RI |
foo |
foo |
.Ed |
.Ed |
.Pp |
.Pp |
are equivalent. If two consecutive lines exhibit the latter behaviour, |
is equivalent to |
an error is raised. Thus, the following is acceptable: |
.Sq \&.RI foo . |
|
If two consecutive lines exhibit the latter behaviour, |
|
an error is raised. Thus, the following is not acceptable: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.RI |
\&.RI |
\&.I Hello, world. |
|
foo |
|
.Ed |
|
.Pp |
|
The following, however, is not: |
|
.Bd -literal -offset indent |
|
\&.RI |
|
\&.I |
\&.I |
Hello, world. |
Hello, world. |
.Ed |
.Ed |
.Pp |
.Pp |
The |
The |
.Sq \&.TP |
.Sq \&.TP |
macro has similar behaviour, but does not need an empty argument line in |
macro is similar, but does not need an empty argument line to trigger |
order to trigger scope. |
the behaviour. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Sh MACROS |
.Sh MACROS |
This section contains a complete list of all |
This section contains a complete list of all |
.Nm |
.Nm |
macros, arranged alphabetically, with the number of arguments. |
macros and corresponding number of arguments. |
.Pp |
.Pp |
.Bl -column "MacroX" "Arguments" -compact -offset indent |
.Bl -column "MacroX" "Arguments" -compact -offset indent |
.It Em Macro Ta Em Arguments |
.It Em Macro Ta Em Arguments |
Line 193 macros, arranged alphabetically, with the number of ar |
|
Line 176 macros, arranged alphabetically, with the number of ar |
|
.It \&.IR Ta n |
.It \&.IR Ta n |
.It \&.RI Ta n |
.It \&.RI Ta n |
.El |
.El |
|
.Pp |
|
Although not historically part of the |
|
.Nm |
|
system, the following macros are also supported: |
|
.Pp |
|
.Bl -column "MacroX" "Arguments" -compact -offset indent |
|
.It Em Macro Ta Em Arguments |
|
.It \&.br Ta 0 |
|
.El |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 |
.Xr mandoc 1 , |
|
.Xr mandoc_char 7 |
.\" SECTION |
.\" SECTION |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |