version 1.1, 2009/03/13 07:46:10 |
version 1.2, 2009/03/13 09:08:59 |
Line 49 All manuals must have |
|
Line 49 All manuals must have |
|
.Sq \en |
.Sq \en |
line termination. |
line termination. |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Special Characters |
.Ss Reserved Characters |
Within a macro line, the following characters are special: |
Within a macro line, the following characters are reserved: |
.\" PARAGRAPH |
.Bl -tag -width 12n -offset XXXX -compact |
.Pp |
|
.Bl -tag -width Ds -offset XXXX -compact |
|
.It \&. |
.It \&. |
period |
.Pq period |
.It \&, |
.It \&, |
comma |
.Pq comma |
.It \&: |
.It \&: |
colon |
.Pq colon |
.It \&; |
.It \&; |
semicolon |
.Pq semicolon |
.It \&( |
.It \&( |
left-parenthesis |
.Pq left-parenthesis |
.It \&) |
.It \&) |
right-parenthesis |
.Pq right-parenthesis |
.It \&[ |
.It \&[ |
left-bracket |
.Pq left-bracket |
.It \&] |
.It \&] |
right-bracket |
.Pq right-bracket |
.It \&? |
.It \&? |
question |
.Pq question |
.It \&! |
.It \&! |
exclmamation |
.Pq exclmamation |
.El |
.El |
.Pp |
.Pp |
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. |
or, if applicable, an appropriate escape-sequence used. Use of reserved |
|
characters is described later in this document. |
.\" 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 |
Line 98 deprecated. The following is a table of all available |
|
Line 97 deprecated. The following is a table of all available |
|
by classification. |
by classification. |
.Pp |
.Pp |
Grammatic: |
Grammatic: |
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(em |
.It \\(em |
.Pq em-dash |
.Pq em-dash |
|
|
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Enclosures: |
Enclosures: |
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(rC |
.It \\(rC |
.Pq right brace |
.Pq right brace |
|
|
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Indicatives: |
Indicatives: |
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(<- |
.It \\(<- |
.Pq left arrow |
.Pq left arrow |
|
|
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Mathematical: |
Mathematical: |
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(Gt |
.It \\(Gt |
.Pq greater-than, deprecated |
.Pq greater-than, deprecated |
|
|
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Diacritics: |
Diacritics: |
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(ga |
.It \\(ga |
.Pq accent grave |
.Pq accent grave |
|
|
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Special symbols: |
Special symbols: |
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(bu |
.It \\(bu |
.Pq bullet |
.Pq bullet |
Line 232 Special symbols: |
|
Line 225 Special symbols: |
|
.Pq ampersand, deprecated |
.Pq ampersand, deprecated |
.El |
.El |
.\" SECTION |
.\" SECTION |
.Sh CLASSIFICATION |
.Sh ONTOLOGY |
Macros are classified in an ontology described by scope rules. |
Macros are classified in an ontology described by scope rules. |
.Bl -tag -width "in-lineX" |
.Bl -inset |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Block |
.It Em Block |
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 |
.Qq Implicit |
block scope is closed by a subsequent invocation of the same macro, |
block scope is closed by a subsequent invocation of the same macro, |
one of a set of corresponding closure macros or end-of-file. |
one of a set of corresponding closure macros or end-of-file. |
.Qq Explicit |
.Qq Explicit |
block scope is closed by a corresponding closure macro. |
block scope is closed by a corresponding closure macro. |
.Bl -tag -width "partial-blockX" |
.Bl -inset -offset XXXX |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Full-block |
.It Em Full-block |
Always spans multiple lines. Consists optionally of one or more |
macros always span multiple lines. They consist optionally of one or |
|
more |
.Qq heads , |
.Qq heads , |
subsequent macros or text on the same line following invocation; a |
subsequent macros or text on the same line following invocation; a |
.Qq body , |
.Qq body , |
Line 256 which spans subsequent lines of text or macros; and an |
|
Line 250 which spans subsequent lines of text or macros; and an |
|
macros or text on the same line following closure. |
macros or text on the same line following closure. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Partial-block |
.It Em Partial-block |
May span multiple lines. Consists optionally of a |
macros may span multiple lines. They consists optionally of a |
.Qq head , |
.Qq head , |
text immediately following invocation; always a |
text immediately following invocation; always a |
.Qq body , |
.Qq body , |
Line 267 text immediately following closure. |
|
Line 261 text immediately following closure. |
|
.El |
.El |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em In-line |
.It Em In-line |
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. If |
a macro is parsable, its scope may be closed by subsequent macros or |
a macro is parsable, its scope may be closed by subsequent macros or |
delimiting punctuation. In-line macros follow different conventions for |
delimiting punctuation. In-line macros follow different conventions for |
closure; see |
closure; see |
Line 364 for per-macro details. |
|
Line 358 for per-macro details. |
|
.\" \&.Fl text0 text1 ; Ar text0 text1 |
.\" \&.Fl text0 text1 ; Ar text0 text1 |
.\" .Ed |
.\" .Ed |
.\" SECTION |
.\" SECTION |
|
.Sh SYNTAX |
|
The syntax of macro invocation depends on classification. |
|
.Qq \-arg |
|
refers to the macro arguments (which may contain zero or more values). |
|
In these illustrations, |
|
.Sq \&.Yo |
|
opens the scope of a macro, and if specified, |
|
.Sq \&.Yc |
|
closes it out (closure may be implicit at end-of-line or end-of-file). |
|
.Pp |
|
Block full-explicit (may contain head, body, tail): |
|
.Bd -literal -offset XXXX |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc \(lBtail...\(rB |
|
.Ed |
|
.Pp |
|
Block full-implicit (may contain zero or more heads, body, no tail): |
|
.Bd -literal -offset XXXX |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
|
\(lBbody...\(rB |
|
\&.Yc |
|
.Ed |
|
.Pp |
|
Block partial-explicit (may contain head, multi-line body, tail): |
|
.Bd -literal -offset XXXX |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc \(lBtail...\(rB |
|
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \ |
|
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
|
.Ed |
|
.Pp |
|
Block partial-implicit (no head, body, no tail): |
|
.Bd -literal -offset XXXX |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB |
|
.Ed |
|
.Pp |
|
In-line (may be closed by end-of-line, reserved character, subsequent |
|
macro invocation or finite number of arguments): |
|
.Bd -literal -offset XXX |
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB args... |
|
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB args... ; |
|
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB args... Xx |
|
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
|
.Ed |
|
.\" |
.Sh MACROS |
.Sh MACROS |
This section contains a complete list of all |
This section contains a complete list of all |
.Nm |
.Nm |
macros, arranged ontologically then alphanumerically by macro name. A |
macros, arranged ontologically. A |
.Qq callable |
.Qq callable |
macro is may be invoked subsequent to the initial macro-line macro. A |
macro is may be invoked subsequent to the initial macro-line macro. A |
.Qq parsable |
.Qq parsable |
macro May be followed by further (ostensibly callable) macros. |
macro may be followed by further (ostensibly callable) macros. |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Block full-implicit |
.Ss Block full-implicit |
The head of these macros follows invocation; the body is the content of |
The head of these macros follows invocation; the body is the content of |
|
|
.Sq \&It \-bullet , |
.Sq \&It \-bullet , |
.Sq \-hyphen , |
.Sq \-hyphen , |
.Sq \-dash , |
.Sq \-dash , |
.Sq \-enum |
.Sq \-enum , |
|
.Sq \-item |
.Pc |
.Pc |
don't have heads. |
don't have heads. |
.Pp |
.Pp |
Line 405 the explicit scope rules. All contains bodies, some m |
|
Line 451 the explicit scope rules. All contains bodies, some m |
|
.It \&.El Ta \&No Ta \&No Ta opened by \&.Bl |
.It \&.El Ta \&No Ta \&No Ta opened by \&.Bl |
.It \&.Bf Ta \&No Ta \&No Ta closed by \&.Ef |
.It \&.Bf Ta \&No Ta \&No Ta closed by \&.Ef |
.It \&.Ef Ta \&No Ta \&No Ta opened by \&.Bf |
.It \&.Ef Ta \&No Ta \&No Ta opened by \&.Bf |
|
.It \&.Bk Ta \&No Ta \&No Ta closed by \&.Ek |
|
.It \&.Ek Ta \&No Ta \&No Ta opened by \&.Bk |
.El |
.El |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Block partial-implicit |
.Ss Block partial-implicit |
Line 421 close at the invocation's end-of-line. |
|
Line 469 close at the invocation's end-of-line. |
|
.It \&.Qq Ta Yes Ta Yes |
.It \&.Qq Ta Yes Ta Yes |
.It \&.Sq Ta Yes Ta Yes |
.It \&.Sq Ta Yes Ta Yes |
.It \&.Brq Ta Yes Ta Yes |
.It \&.Brq Ta Yes Ta Yes |
|
.It \&.D1 Ta \&No Ta \&Yes |
|
.It \&.Dl Ta \&No Ta Yes |
|
.It \&.Ql Ta Yes Ta Yes |
.El |
.El |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Block partial-explicit |
.Ss Block partial-explicit |
|
|
.It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec |
.It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec |
.It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo |
.It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo |
.It \&.Qo Ta Yes Ta Yes Ta closed by \&.Oc |
.It \&.Qo Ta Yes Ta Yes Ta closed by \&.Oc |
|
.It \&.Re Ta \&No Ta \&No Ta opened by \&.Rs |
|
.It \&.Rs Ta \&No Ta \&No Ta closed by \&.Re |
.El |
.El |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss General |
.Ss In-line |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX |
In-line macros have only text children. |
.It Em Macro Ta Em Callable Ta Em Parsable |
.Pp |
.It \&.Dd Ta \& Ta \& |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX |
.It \&.Dt Ta \& Ta \& |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It \&.Os Ta \& Ta \& |
.It \&.Dd Ta \&No Ta \&No Ta \& |
.It \&.Pp Ta \& Ta \& |
.It \&.Dt Ta \&No Ta \&No Ta \& |
.It \&.D1 Ta \& Ta \& |
.It \&.Os Ta \&No Ta \&No Ta \& |
.It \&.Dl Ta \& Ta Yes |
.It \&.Pp Ta \&No Ta \&No Ta 0 |
.It \&.Ad Ta Yes Ta Yes |
.It \&.Ad Ta Yes Ta Yes Ta \& |
.It \&.An Ta \& Ta Yes |
.It \&.An Ta \&No Ta Yes Ta \& |
.It \&.Ar Ta Yes Ta Yes |
.It \&.Ar Ta Yes Ta Yes Ta \& |
.It \&.Cd Ta Yes Ta \& |
.It \&.Cd Ta Yes Ta \&No Ta \& |
.It \&.Cm Ta Yes Ta Yes |
.It \&.Cm Ta Yes Ta Yes Ta \& |
.It \&.Dv Ta Yes Ta Yes |
.It \&.Dv Ta Yes Ta Yes Ta \& |
.It \&.Er Ta Yes Ta Yes |
.It \&.Er Ta Yes Ta Yes Ta \& |
.It \&.Ev Ta Yes Ta Yes |
.It \&.Ev Ta Yes Ta Yes Ta \& |
.It \&.Ex Ta \& Ta \& |
.It \&.Ex Ta \&No Ta \&No Ta \& |
.It \&.Fa Ta Yes Ta Yes |
.It \&.Fa Ta Yes Ta Yes Ta \& |
.It \&.Fd Ta \& Ta \& |
.It \&.Fd Ta \&No Ta \&No Ta \& |
.It \&.Fl Ta Yes Ta Yes |
.It \&.Fl Ta Yes Ta Yes Ta \& |
.It \&.Fn Ta Yes Ta Yes |
.It \&.Fn Ta Yes Ta Yes Ta \& |
.It \&.Ft Ta \& Ta \& |
.It \&.Ft Ta \&No Ta Yes Ta \& |
.It \&.Ic Ta Yes Ta Yes |
.It \&.Ic Ta Yes Ta Yes Ta \& |
.It \&.In Ta \& Ta \& |
.It \&.In Ta \&No Ta \&No Ta \& |
.It \&.Li Ta Yes Ta Yes |
.It \&.Li Ta Yes Ta Yes Ta \& |
.It \&.Nd Ta \& Ta \& |
.It \&.Nd Ta \&No Ta \&No Ta \& |
.It \&.Nm Ta Yes Ta Yes |
.It \&.Nm Ta Yes Ta Yes Ta \& |
.It \&.Ot Ta \& Ta \& |
.It \&.Ot Ta \&No Ta \&No Ta \& |
.It \&.Pa Ta Yes Ta Yes |
.It \&.Pa Ta Yes Ta Yes Ta \& |
.It \&.Rv Ta \& Ta \& |
.It \&.Rv Ta \&No Ta \&No Ta \& |
.It \&.St Ta Yes Ta \& |
.It \&.St Ta \&No Ta Yes Ta \& |
.It \&.Va Ta Yes Ta Yes |
.It \&.Va Ta Yes Ta Yes Ta \& |
.It \&.Vt Ta Yes Ta Yes |
.It \&.Vt Ta Yes Ta Yes Ta \& |
.It \&.Xr Ta Yes Ta Yes |
.It \&.Xr Ta Yes Ta Yes Ta \& |
.It \&.%A Ta \& Ta \& |
.It \&.%A Ta \&No Ta \&No Ta \& |
.It \&.%B Ta \& Ta \& |
.It \&.%B Ta \&No Ta \&No Ta \& |
.It \&.%C Ta \& Ta \& |
.It \&.%C Ta \&No Ta \&No Ta \& |
.It \&.%D Ta \& Ta \& |
.It \&.%D Ta \&No Ta \&No Ta \& |
.It \&.%I Ta \& Ta \& |
.It \&.%I Ta \&No Ta \&No Ta \& |
.It \&.%J Ta \& Ta \& |
.It \&.%J Ta \&No Ta \&No Ta \& |
.It \&.%N Ta \& Ta \& |
.It \&.%N Ta \&No Ta \&No Ta \& |
.It \&.%O Ta \& Ta \& |
.It \&.%O Ta \&No Ta \&No Ta \& |
.It \&.%P Ta \& Ta \& |
.It \&.%P Ta \&No Ta \&No Ta \& |
.It \&.%R Ta \& Ta \& |
.It \&.%R Ta \&No Ta \&No Ta \& |
.It \&.%T Ta \& Ta \& |
.It \&.%T Ta \&No Ta \&No Ta \& |
.It \&.%V Ta \& Ta \& |
.It \&.%V Ta \&No Ta \&No Ta \& |
.It \&.At Ta Yes Ta Yes |
.It \&.At Ta Yes Ta Yes Ta \& |
.It \&.Bsx Ta Yes Ta Yes |
.It \&.Bsx Ta Yes Ta Yes Ta \& |
.It \&.Bx Ta Yes Ta Yes |
.It \&.Bx Ta Yes Ta Yes Ta \& |
.It \&.Db Ta \& Ta \& |
.It \&.Db Ta \&No Ta \&No Ta \& |
.It \&.Em Ta Yes Ta Yes |
.It \&.Em Ta Yes Ta Yes Ta \& |
.It \&.Fx Ta Yes Ta Yes |
.It \&.Fx Ta Yes Ta Yes Ta \& |
.It \&.Ms Ta \& Ta Yes |
.It \&.Ms Ta \&No Ta Yes Ta \& |
.It \&.No Ta Yes Ta Yes |
.It \&.No Ta Yes Ta Yes Ta \& |
.It \&.Ns Ta Yes Ta Yes |
.It \&.Ns Ta Yes Ta Yes Ta \& |
.It \&.Nx Ta Yes Ta Yes |
.It \&.Nx Ta Yes Ta Yes Ta \& |
.It \&.Ox Ta Yes Ta Yes |
.It \&.Ox Ta Yes Ta Yes Ta \& |
.It \&.Pf Ta \& Ta Yes |
.It \&.Pf Ta \&No Ta Yes Ta \& |
.It \&.Ql Ta Yes Ta Yes |
.It \&.Sm Ta \&No Ta \&No Ta \& |
.It \&.Re Ta \& Ta \& |
.It \&.Sx Ta Yes Ta Yes Ta \& |
.It \&.Rs Ta \& Ta \& |
.It \&.Sy Ta Yes Ta Yes Ta \& |
.It \&.Sm Ta \& Ta \& |
.It \&.Tn Ta Yes Ta Yes Ta \& |
.It \&.Sx Ta Yes Ta Yes |
.It \&.Ux Ta Yes Ta Yes Ta \& |
.It \&.Sy Ta Yes Ta Yes |
.It \&.Bt Ta \&No Ta \&No Ta \& |
.It \&.Tn Ta Yes Ta Yes |
.It \&.Hf Ta \&No Ta \&No Ta \& |
.It \&.Ux Ta Yes Ta Yes |
.It \&.Fr Ta \&No Ta \&No Ta \& |
.It \&.Bk Ta \& Ta \& |
.It \&.Ud Ta \&No Ta \&No Ta \& |
.It \&.Ek Ta \& Ta \& |
.It \&.Lb Ta \&No Ta \&No Ta \& |
.It \&.Bt Ta \& Ta \& |
.It \&.Ap Ta Yes Ta Yes Ta \& |
.It \&.Hf Ta \& Ta \& |
.It \&.Lp Ta \&No Ta \&No Ta \& |
.It \&.Fr Ta \& Ta \& |
.It \&.Lk Ta \&No Ta Yes Ta \& |
.It \&.Ud Ta \& Ta \& |
.It \&.Mt Ta \&No Ta Yes Ta \& |
.It \&.Lb Ta \& Ta \& |
|
.It \&.Ap Ta Yes Ta Yes |
|
.It \&.Lp Ta \& Ta \& |
|
.It \&.Lk Ta \& Ta Yes |
|
.It \&.Mt Ta \& Ta Yes |
|
.El |
.El |
|
.\" SECTION |
|
.Sh SEE ALSO |
|
.Xr mdoctree 1 , |
|
.Xr mdoclint 1 , |
|
.Xr mdocterm 1 , |
|
.Xr mdoc 3 |
|
.\" SECTION |
|
.Sh AUTHORS |
|
The |
|
.Nm |
|
utility was written by |
|
.An Kristaps Dzonsons Aq kristaps@kth.se . |