version 1.2, 2009/03/13 09:08:59 |
version 1.4, 2009/03/14 05:21:58 |
Line 36 document follows simple rules: lines beginning with t |
|
Line 36 document follows simple rules: lines beginning with t |
|
character |
character |
.Sq \. |
.Sq \. |
are parsed for macros. Other lines are interpreted within the scope of |
are parsed for macros. Other lines are interpreted within the scope of |
prior macros. Macros are either two or three characters in length. |
prior macros. This document describes the encoding, ontology and syntax |
|
of these macros. |
.\" SECTION |
.\" SECTION |
.Sh CHARACTER ENCODING |
.Sh CHARACTER ENCODING |
.Nm |
.Nm |
Line 77 Within a macro line, the following characters are rese |
|
Line 78 Within a macro line, the following characters are rese |
|
Use of these characters must either be escaped with a non-breaking space |
Use of these characters must either be escaped with a non-breaking space |
.Pq Sq \e& |
.Pq Sq \e& |
or, if applicable, an appropriate escape-sequence used. Use of reserved |
or, if applicable, an appropriate escape-sequence used. Use of reserved |
characters is described later in this document. |
characters is described in |
|
.Sx Closure . |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special character sequences begin with the escape character |
.Sq \\ |
.Sq \\ |
and followed by either an open-parenthesis |
followed by either an open-parenthesis |
.Sq \&( |
.Sq \&( |
for two-character sequences; an open-bracket |
for two-character sequences; an open-bracket |
.Sq \&[ |
.Sq \&[ |
Line 92 or a single one-character sequence. |
|
Line 94 or a single one-character sequence. |
|
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
Characters may alternatively be escaped by a slash-asterisk, |
.Sq \\* , |
.Sq \\* , |
with the same combinations as described above. This form, however, is |
with the same combinations as described above. This form is deprecated. |
deprecated. The following is a table of all available escapes, arranged |
|
by classification. |
|
.Pp |
.Pp |
|
The following is a table of all available escapes. |
|
.Pp |
Grammatic: |
Grammatic: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(em |
.It \\(em |
Line 227 Special symbols: |
|
Line 229 Special symbols: |
|
.\" SECTION |
.\" SECTION |
.Sh ONTOLOGY |
.Sh ONTOLOGY |
Macros are classified in an ontology described by scope rules. |
Macros are classified in an ontology described by scope rules. |
|
.\" SUB-SECTION |
|
.Ss Scope |
.Bl -inset |
.Bl -inset |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Block |
.It Em Block |
macros enclose other block macros, in-line macros or text, and |
macros enclose other block macros, in-line macros or text, and |
may span multiple lines. |
may span multiple lines. |
.Qq Implicit |
|
block scope is closed by a subsequent invocation of the same macro, |
|
one of a set of corresponding closure macros or end-of-file. |
|
.Qq Explicit |
|
block scope is closed by a corresponding closure macro. |
|
.Bl -inset -offset XXXX |
.Bl -inset -offset XXXX |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Full-block |
.It Em Full-block |
Line 258 text or macros following the head on the same and subs |
|
Line 257 text or macros following the head on the same and subs |
|
optionally a |
optionally a |
.Qq tail , |
.Qq tail , |
text immediately following closure. |
text immediately following closure. |
.El |
|
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em In-line |
.It Em In-line |
macros may only enclose text and span at most a single line. If |
macros may only enclose text and span at most a single line. |
a macro is parsable, its scope may be closed by subsequent macros or |
|
delimiting punctuation. In-line macros follow different conventions for |
|
closure; see |
|
.Sx MACROS |
|
for per-macro details. |
|
.El |
.El |
|
.El |
|
.\" SUB-SECTION |
|
.Ss Closure |
|
Closure of a macro's scope depends first on its classification, then |
|
on whether it's parsable. In this table, |
|
.Sq BFE |
|
refers to block full-explicit and so on. |
|
.\" PARAGRAPH |
|
.Pp |
|
.Bl -tag -width 12n -offset XXXX -compact |
|
.It BPE , BFE |
|
corresponding explicit closure macro |
|
.It BFI |
|
end-of-file or a corresponding implicit closure macro |
|
.It BPI |
|
end-of-line (body may be closed by >0 space-separated |
|
.Sx Reserved Characters , |
|
although block scope will still be open) |
|
.It INL |
|
end-of-line |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
If a macro (block or in-line) is parsable, it may also be closed out by |
|
one of the following scenarios (unless specifically noted otherwise): |
|
.\" PARAGRAPH |
|
.Pp |
|
.Bl -dash -offset XXXX -compact |
|
.It |
|
a sequence of >0 space-separated |
|
.Sx Reserved Characters , |
|
.It |
|
another macro, |
|
.It |
|
end-of-line, or |
|
.It |
|
completion of a set number of arguments. |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
If >0 space-separated |
|
.Sx Reserved Characters |
|
are followed by non-reserved characters, the behaviour differs per |
|
macro. In general, scope of the macro is closed and re-opened: |
|
subsequent tokens are interpreted as if the scope had just been opened. |
|
In other circumstances, scope is simply closed out. |
.\" .\" SUB-SECTION |
.\" .\" SUB-SECTION |
.\" .Ss Examples |
.\" .Ss Examples |
.\" The following examples illustrate each macro classification. |
.\" The following examples illustrate each macro classification. |
Line 359 for per-macro details. |
|
Line 398 for per-macro details. |
|
.\" .Ed |
.\" .Ed |
.\" SECTION |
.\" SECTION |
.Sh SYNTAX |
.Sh SYNTAX |
The syntax of macro invocation depends on classification. |
Macros are generally two and at times three characters in length. The |
|
syntax of macro invocation depends on its classification. |
.Qq \-arg |
.Qq \-arg |
refers to the macro arguments (which may contain zero or more values). |
refers to the macro arguments (which may contain zero or more values). |
In these illustrations, |
In these illustrations, |
Line 367 In these illustrations, |
|
Line 407 In these illustrations, |
|
opens the scope of a macro, and if specified, |
opens the scope of a macro, and if specified, |
.Sq \&.Yc |
.Sq \&.Yc |
closes it out (closure may be implicit at end-of-line or end-of-file). |
closes it out (closure may be implicit at end-of-line or end-of-file). |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Block full-explicit (may contain head, body, tail): |
Block full-explicit (may contain head, body, tail). |
.Bd -literal -offset XXXX |
.Bd -literal -offset XXXX |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
\&.Yc \(lBtail...\(rB |
\&.Yc \(lBtail...\(rB |
.Ed |
.Ed |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Block full-implicit (may contain zero or more heads, body, no tail): |
Block full-implicit (may contain zero or more heads, body, no tail). |
.Bd -literal -offset XXXX |
.Bd -literal -offset XXXX |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
\&.Yc |
\&.Yc |
.Ed |
.Ed |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Block partial-explicit (may contain head, multi-line body, tail): |
Block partial-explicit (may contain head, multi-line body, tail). |
.Bd -literal -offset XXXX |
.Bd -literal -offset XXXX |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
\&.Yc \(lBtail...\(rB |
\&.Yc \(lBtail...\(rB |
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \ |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \ |
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
.Ed |
.Ed |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Block partial-implicit (no head, body, no tail): |
Block partial-implicit (no head, body, no tail). Note that the body |
|
section may be followed by zero or more |
|
.Sx Reserved Words . |
|
These are in the block scope, but not in the body scope. |
.Bd -literal -offset XXXX |
.Bd -literal -offset XXXX |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB |
.Ed |
.Ed |
|
.\" PARAGRAPH |
.Pp |
.Pp |
In-line (may be closed by end-of-line, reserved character, subsequent |
In-lines have \(>=0 scoped arguments. |
macro invocation or finite number of arguments): |
|
.Bd -literal -offset XXX |
.Bd -literal -offset XXX |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB args... |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB |
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB args... ; |
|
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB args... Xx |
|
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
.Ed |
.Ed |
.\" |
.\" |
|
|
.El |
.El |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss In-line |
.Ss In-line |
In-line macros have only text children. |
In-line macros have only text children. If a number (or inequality) of |
|
arguments is |
|
.Pq n , |
|
then the macro accepts an arbitrary number of arguments. |
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It \&.Dd Ta \&No Ta \&No Ta \& |
.It \&.Dd Ta \&No Ta \&No Ta >0 |
.It \&.Dt Ta \&No Ta \&No Ta \& |
.It \&.Dt Ta \&No Ta \&No Ta n |
.It \&.Os Ta \&No Ta \&No Ta \& |
.It \&.Os Ta \&No Ta \&No Ta n |
.It \&.Pp Ta \&No Ta \&No Ta 0 |
.It \&.Pp Ta \&No Ta \&No Ta 0 |
.It \&.Ad Ta Yes Ta Yes Ta \& |
.It \&.Ad Ta Yes Ta Yes Ta n |
.It \&.An Ta \&No Ta Yes Ta \& |
.It \&.An Ta \&No Ta Yes Ta n |
.It \&.Ar Ta Yes Ta Yes Ta \& |
.It \&.Ar Ta Yes Ta Yes Ta n |
.It \&.Cd Ta Yes Ta \&No Ta \& |
.It \&.Cd Ta Yes Ta \&No Ta >0 |
.It \&.Cm Ta Yes Ta Yes Ta \& |
.It \&.Cm Ta Yes Ta Yes Ta n |
.It \&.Dv Ta Yes Ta Yes Ta \& |
.It \&.Dv Ta Yes Ta Yes Ta >0 |
.It \&.Er Ta Yes Ta Yes Ta \& |
.It \&.Er Ta Yes Ta Yes Ta >0 |
.It \&.Ev Ta Yes Ta Yes Ta \& |
.It \&.Ev Ta Yes Ta Yes Ta >0 |
.It \&.Ex Ta \&No Ta \&No Ta \& |
.It \&.Ex Ta \&No Ta \&No Ta 0 |
.It \&.Fa Ta Yes Ta Yes Ta \& |
.It \&.Fa Ta Yes Ta Yes Ta >0 |
.It \&.Fd Ta \&No Ta \&No Ta \& |
.It \&.Fd Ta \&No Ta \&No Ta >0 |
.It \&.Fl Ta Yes Ta Yes Ta \& |
.It \&.Fl Ta Yes Ta Yes Ta n |
.It \&.Fn Ta Yes Ta Yes Ta \& |
.It \&.Fn Ta Yes Ta Yes Ta >0 |
.It \&.Ft Ta \&No Ta Yes Ta \& |
.It \&.Ft Ta \&No Ta Yes Ta n |
.It \&.Ic Ta Yes Ta Yes Ta \& |
.It \&.Ic Ta Yes Ta Yes Ta >0 |
.It \&.In Ta \&No Ta \&No Ta \& |
.It \&.In Ta \&No Ta \&No Ta n |
.It \&.Li Ta Yes Ta Yes Ta \& |
.It \&.Li Ta Yes Ta Yes Ta >0 |
.It \&.Nd Ta \&No Ta \&No Ta \& |
.It \&.Nd Ta \&No Ta \&No Ta n |
.It \&.Nm Ta Yes Ta Yes Ta \& |
.It \&.Nm Ta Yes Ta Yes Ta n |
.It \&.Ot Ta \&No Ta \&No Ta \& |
.It \&.Ot Ta \&No Ta \&No Ta n |
.It \&.Pa Ta Yes Ta Yes Ta \& |
.It \&.Pa Ta Yes Ta Yes Ta n |
.It \&.Rv Ta \&No Ta \&No Ta \& |
.It \&.Rv Ta \&No Ta \&No Ta 0 |
.It \&.St Ta \&No Ta Yes Ta \& |
.It \&.St Ta \&No Ta Yes Ta 1 |
.It \&.Va Ta Yes Ta Yes Ta \& |
.It \&.Va Ta Yes Ta Yes Ta >0 |
.It \&.Vt Ta Yes Ta Yes Ta \& |
.It \&.Vt Ta Yes Ta Yes Ta >0 |
.It \&.Xr Ta Yes Ta Yes Ta \& |
.It \&.Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&.%A Ta \&No Ta \&No Ta \& |
.It \&.%A Ta \&No Ta \&No Ta >0 |
.It \&.%B Ta \&No Ta \&No Ta \& |
.It \&.%B Ta \&No Ta \&No Ta >0 |
.It \&.%C Ta \&No Ta \&No Ta \& |
.It \&.%C Ta \&No Ta \&No Ta >0 |
.It \&.%D Ta \&No Ta \&No Ta \& |
.It \&.%D Ta \&No Ta \&No Ta >0 |
.It \&.%I Ta \&No Ta \&No Ta \& |
.It \&.%I Ta \&No Ta \&No Ta >0 |
.It \&.%J Ta \&No Ta \&No Ta \& |
.It \&.%J Ta \&No Ta \&No Ta >0 |
.It \&.%N Ta \&No Ta \&No Ta \& |
.It \&.%N Ta \&No Ta \&No Ta >0 |
.It \&.%O Ta \&No Ta \&No Ta \& |
.It \&.%O Ta \&No Ta \&No Ta >0 |
.It \&.%P Ta \&No Ta \&No Ta \& |
.It \&.%P Ta \&No Ta \&No Ta >0 |
.It \&.%R Ta \&No Ta \&No Ta \& |
.It \&.%R Ta \&No Ta \&No Ta >0 |
.It \&.%T Ta \&No Ta \&No Ta \& |
.It \&.%T Ta \&No Ta \&No Ta >0 |
.It \&.%V Ta \&No Ta \&No Ta \& |
.It \&.%V Ta \&No Ta \&No Ta >0 |
.It \&.At Ta Yes Ta Yes Ta \& |
.It \&.At Ta Yes Ta Yes Ta 1 |
.It \&.Bsx Ta Yes Ta Yes Ta \& |
.It \&.Bsx Ta Yes Ta Yes Ta n |
.It \&.Bx Ta Yes Ta Yes Ta \& |
.It \&.Bx Ta Yes Ta Yes Ta n |
.It \&.Db Ta \&No Ta \&No Ta \& |
.It \&.Db Ta \&No Ta \&No Ta 1 |
.It \&.Em Ta Yes Ta Yes Ta \& |
.It \&.Em Ta Yes Ta Yes Ta >0 |
.It \&.Fx Ta Yes Ta Yes Ta \& |
.It \&.Fx Ta Yes Ta Yes Ta n |
.It \&.Ms Ta \&No Ta Yes Ta \& |
.It \&.Ms Ta \&No Ta Yes Ta >0 |
.It \&.No Ta Yes Ta Yes Ta \& |
.It \&.No Ta Yes Ta Yes Ta 0 |
.It \&.Ns Ta Yes Ta Yes Ta \& |
.It \&.Ns Ta Yes Ta Yes Ta 0 |
.It \&.Nx Ta Yes Ta Yes Ta \& |
.It \&.Nx Ta Yes Ta Yes Ta n |
.It \&.Ox Ta Yes Ta Yes Ta \& |
.It \&.Ox Ta Yes Ta Yes Ta n |
.It \&.Pf Ta \&No Ta Yes Ta \& |
.It \&.Pf Ta \&No Ta Yes Ta 1 |
.It \&.Sm Ta \&No Ta \&No Ta \& |
.It \&.Sm Ta \&No Ta \&No Ta 1 |
.It \&.Sx Ta Yes Ta Yes Ta \& |
.It \&.Sx Ta Yes Ta Yes Ta >0 |
.It \&.Sy Ta Yes Ta Yes Ta \& |
.It \&.Sy Ta Yes Ta Yes Ta >0 |
.It \&.Tn Ta Yes Ta Yes Ta \& |
.It \&.Tn Ta Yes Ta Yes Ta >0 |
.It \&.Ux Ta Yes Ta Yes Ta \& |
.It \&.Ux Ta Yes Ta Yes Ta n |
.It \&.Bt Ta \&No Ta \&No Ta \& |
.It \&.Bt Ta \&No Ta \&No Ta 0 |
.It \&.Hf Ta \&No Ta \&No Ta \& |
.It \&.Hf Ta \&No Ta \&No Ta n |
.It \&.Fr Ta \&No Ta \&No Ta \& |
.It \&.Fr Ta \&No Ta \&No Ta n |
.It \&.Ud Ta \&No Ta \&No Ta \& |
.It \&.Ud Ta \&No Ta \&No Ta 0 |
.It \&.Lb Ta \&No Ta \&No Ta \& |
.It \&.Lb Ta \&No Ta \&No Ta 1 |
.It \&.Ap Ta Yes Ta Yes Ta \& |
.It \&.Ap Ta Yes Ta Yes Ta 0 |
.It \&.Lp Ta \&No Ta \&No Ta \& |
.It \&.Lp Ta \&No Ta \&No Ta 0 |
.It \&.Lk Ta \&No Ta Yes Ta \& |
.It \&.Lk Ta \&No Ta Yes Ta >0 |
.It \&.Mt Ta \&No Ta Yes Ta \& |
.It \&.Mt Ta \&No Ta Yes Ta >0 |
|
.El |
|
.\" SECTION |
|
.Sh COMPATIBILITY |
|
The mdoc language was traditionally a |
|
.Qq roff |
|
macro package; most existing manuals were written with mdoc syntax |
|
dictated by system-dependent roff installations. This section documents |
|
compatibility with these systems. |
|
.Pp |
|
.Bl -dash -compact |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&It \-nested |
|
is assumed for all lists: any list may be nested and |
|
.Sq \-enum |
|
lists will restart the sequence only for the sub-list. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&It \-column |
|
syntax where column widths may be preceeded by other arguments (instead |
|
of proceeded) is not supported. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&At |
|
macro only accepts a single parameter. |
|
.\" LIST-ITEM |
|
.It |
|
The system-name macros ( |
|
.Ns Sq \&At , |
|
.Sq \&Bsx , |
|
.Sq \&Bx , |
|
.Sq \&Fx , |
|
.Sq \&Nx , |
|
.Sq \&Ox , |
|
and |
|
.Sq \&Ux ) |
|
are callable. |
|
.\" LIST-ITEM |
|
.It |
|
Some manuals use |
|
.Sq \&Li |
|
incorrectly by following it with a reserved character and expecting the |
|
delimiter to render. This is not supported. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Cd |
|
is callable. |
.El |
.El |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |