version 1.1, 2009/03/13 07:46:10 |
version 1.46, 2009/07/17 14:51:04 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" above copyright notice and this permission notice appear in all |
.\" copyright notice and this permission notice appear in all copies. |
.\" copies. |
|
.\" |
.\" |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" PERFORMANCE OF THIS SOFTWARE. |
|
.\" |
.\" |
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt mdoc 7 |
.Dt MDOC 7 |
.Os |
.Os |
.\" SECTION |
.\" SECTION--------------------------------------------- |
.Sh NAME |
.Sh NAME |
.Nm mdoc |
.Nm mdoc |
.Nd mdoc macro reference |
.Nd mdoc language reference |
.\" SECTION |
.\" SECTION--------------------------------------------- |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm mdoc |
.Nm mdoc |
language is used to format |
language is used to format |
.Bx |
.Bx |
.Ux |
.Ux |
manuals. An |
manuals. In this reference document, we describe its syntax, structure, |
|
and usage. Our reference implementation is |
|
.Xr mandoc 1 . |
|
The |
|
.Sx COMPATIBILITY |
|
section describes compatibility with |
|
.Xr groff 1 . |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
An |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document follows simple rules: lines beginning with the control |
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: |
.\" SECTION |
.Bd -literal -offset indent |
.Sh CHARACTER ENCODING |
\&.Sh Macro lines change control state. |
|
Other lines are interpreted within the current state. |
|
.Ed |
|
.\" SECTION--------------------------------------------- |
|
.Sh LANGUAGE SYNTAX |
.Nm |
.Nm |
documents may contain only printable alphanumeric characters, the space |
documents may contain only graphable 7-bit ASCII characters, the space |
character |
character, and, in certain circumstances, the tab character. All |
.Sq \ , |
manuals must have |
and, in certain circumstances, the tab character |
.Ux |
.Sq \et . |
line terminators. |
All manuals must have |
.\" SUB-SECTION---------------------- |
.Sq \en |
.Ss Comments |
line termination. |
Text following a |
.\" SUB-SECTION |
.Sq \e" , |
.Ss Special Characters |
whether in a macro or free-form text line, is ignored to the end of |
Within a macro line, the following characters are special: |
line. A macro line with only a control character and comment escape, |
.\" PARAGRAPH |
.Sq \&.\e" , |
.Pp |
is also ignored. |
.Bl -tag -width Ds -offset XXXX -compact |
.\" SUB-SECTION---------------------- |
|
.Ss Reserved Characters |
|
Within a macro line, the following characters are reserved: |
|
.Bl -tag -width Ds -offset indent -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 exclamation |
|
.It \&| |
|
.Pq vertical bar |
.El |
.El |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
Use of these characters must either be escaped with a non-breaking space |
Use of reserved characters is described in |
|
.Sx MACRO SYNTAX . |
|
For general use in macro lines, 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. |
.\" SUB-SECTION |
.\" SUB-SECTION---------------------- |
.Ss Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special characters may occur in both macro and free-form lines. |
.Sq \\ |
Sequences begin with the escape character |
and followed by either an open-parenthesis |
.Sq \e |
|
followed by either an open-parenthesis |
.Sq \&( |
.Sq \&( |
for two-character sequences; an open-bracket |
for two-character sequences; an open-bracket |
.Sq \&[ |
.Sq \&[ |
for n-character sequences (terminated at a close-bracket |
for n-character sequences (terminated at a close-bracket |
.Sq \&] ) ; |
.Sq \&] ) ; |
or a single one-character sequence. |
or a single one-character sequence. See |
|
.Xr mandoc_char 1 |
|
for a complete list. Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
|
and |
|
.Sq \ee |
|
.Pq back-slash . |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
An alternative escape sequence is |
.Sq \\* , |
the slash-asterisk, |
with the same combinations as described above. This form, however, is |
.Sq \e* , |
deprecated. The following is a table of all available escapes, arranged |
but this method is discouraged for compatibility reasons. |
by classification. |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
Grammatic: |
Terms may |
|
also be text-decorated using the |
|
.Sq \ef |
|
escape followed by an indicator: B (bold), I, (italic), or P and R |
|
(Roman, or reset). This form is not recommended. |
|
.\" SUB-SECTION---------------------- |
|
.Ss Whitespace |
|
In non-literal free-form lines, consecutive blocks of whitespace are |
|
pruned from input and added later in the output filter, if applicable: |
|
.Bd -literal -offset indent |
|
These spaces are pruned from input. |
|
\&.Bd \-literal |
|
These are not. |
|
\&.Ed |
|
.Ed |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
.Bl -tag -width 12n -offset "XXXX" -compact |
In macro lines, whitespace delimits arguments and is discarded. If |
.It \\(em |
arguments are quoted, whitespace is conditionally retained within the |
.Pq em-dash |
quotes. |
.It \\(en |
.\" TODO: which do and which don't? |
.Pq en-dash |
.\" PARAGRAPH------------ |
.It \e- |
|
.Pq hyphen |
|
.It \\\\ |
|
.Pq back-slash |
|
.It \e' |
|
.Pq apostrophe |
|
.It \e` |
|
.Pq back-tick |
|
.It \\ |
|
.Pq space |
|
.It \\. |
|
.Pq period |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Enclosures: |
Blank lines are only permitted within literal contexts, as are lines |
|
containing only whitespace. Tab characters are only acceptable when |
|
delimiting |
|
.Sq \&Bl \-column |
|
or when in a literal context. |
|
.\" SUB-SECTION---------------------- |
|
.Ss Quotation |
|
Macro arguments may be quoted with a double-quote to group |
|
space-delimited terms or to retain blocks of whitespace. A quoted |
|
argument begins with a double-quote preceded by whitespace. The next |
|
double-quote terminates the term, regardless of surrounding whitespace. |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
.Bl -tag -width 12n -offset "XXXX" -compact |
In free-form mode, quotes are regarded as opaque text. |
.It \\(rC |
.\" SECTION--------------------------------------------- |
.Pq right brace |
.Sh MANUAL STRUCTURE |
.It \\(lC |
Each |
.Pq left brace |
.Nm |
.It \\(ra |
document must begin with a document prologue, containing, in order, |
.Pq right angle |
.Sq \&Dd , |
.It \\(la |
.Sq \&Dt , |
.Pq left angle |
and |
.It \\(rB |
.Sq \&Os , |
.Pq right bracket |
then the NAME section containing at least one |
.It \\(lB |
.Sq \&Nm |
.Pq left bracket |
followed by |
.It \\q |
.Sq \&Nd : |
.Pq double-quote |
.Bd -literal -offset indent |
.It \\(lq |
\&.Dd $\&Mdocdate$ |
.Pq left double-quote |
\&.Dt mdoc 7 |
.It \\(Lq |
\&.Os |
.Pq left double-quote, deprecated |
\&.Sh NAME |
.It \\(rq |
\&.Nm mdoc |
.Pq right double-quote |
\&.Nd mdoc language reference |
.It \\(Rq |
.Ed |
.Pq right double-quote, deprecated |
.\" PARAGRAPH------------ |
.It \\(oq |
|
.Pq left single-quote |
|
.It \\(aq |
|
.Pq right single-quote |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Indicatives: |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
|
but non-compulsory. |
|
.\" SECTION--------------------------------------------- |
|
.Sh MACRO SYNTAX |
|
Every line beginning with the control character |
|
.Sq \. |
|
is processed for macros, two- or three-character sequences. |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
.Bl -tag -width 12n -offset "XXXX" -compact |
The syntax of a macro depends on its classification. In this section, |
.It \\(<- |
.Sq \-arg |
.Pq left arrow |
refers to macro arguments, which may be followed by zero or more |
.It \\(-> |
.Sq parm |
.Pq right arrow |
parameters; |
.It \\(ua |
.Sq \&Yo |
.Pq up arrow |
opens the scope of a macro; and if specified, |
.It \\(da |
.Sq \&Yc |
.Pq down arrow |
closes it out. |
.El |
.\" PARAGRAPH------------ |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Mathematical: |
The |
|
.Em Callable |
|
column indicates that the macro may be called subsequent to the initial |
|
line-macro. The |
|
.Em Parsable |
|
column indicates whether the macro may be followed by further |
|
(ostensibly callable) macros. The |
|
.Em Scope |
|
column, if applicable, describes closure rules. |
|
.\" SUB-SECTION---------------------- |
|
.Ss Block full-explicit |
|
Multi-line scope closed by an explicit closing macro. All macros |
|
contains bodies; only |
|
.Pq Sq \&Bf |
|
contains a head. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc |
|
.Ed |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
.It \\(Gt |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.Pq greater-than, deprecated |
.It \&Bd Ta \&No Ta \&No Ta closed by \&Ed |
.It \\(Lt |
.It \&Bf Ta \&No Ta \&No Ta closed by \&Ef |
.Pq less-than, deprecated |
.It \&Bk Ta \&No Ta \&No Ta closed by \&Ek |
.It \\(<= |
.It \&Bl Ta \&No Ta \&No Ta closed by \&El |
.Pq less-than-equal |
.It \&Ed Ta \&No Ta \&No Ta opened by \&Bd |
.It \\(Le |
.It \&Ef Ta \&No Ta \&No Ta opened by \&Bf |
.Pq less-than-equal, deprecated |
.It \&Ek Ta \&No Ta \&No Ta opened by \&Bk |
.It \\(>= |
.It \&El Ta \&No Ta \&No Ta opened by \&Bl |
.Pq greater-than-equal |
|
.It \\(Ge |
|
.Pq greater-than-equal |
|
.It \\(== |
|
.Pq equal |
|
.It \\(!= |
|
.Pq not equal |
|
.It \\(Ne |
|
.Pq not equal, deprecated |
|
.It \\(if |
|
.Pq infinity |
|
.It \\(If |
|
.Pq infinity, deprecated |
|
.It \\(na |
|
.Pq NaN , an extension |
|
.It \\(Na |
|
.Pq NaN, deprecated |
|
.It \\(+- |
|
.Pq plus-minus |
|
.It \\(Pm |
|
.Pq plus-minus, deprecated |
|
.It \\(** |
|
.Pq asterisk |
|
.El |
.El |
.\" PARAGRAPH |
.\" SUB-SECTION---------------------- |
.Pp |
|
Diacritics: |
|
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(ga |
|
.Pq accent grave |
|
.It \\(aa |
|
.Pq accent accute |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Special symbols: |
|
.Pp |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(bu |
|
.Pq bullet |
|
.It \\(ba |
|
.Pq bar |
|
.It \\(Ba |
|
.Pq bar, deprecated |
|
.It \\(co |
|
.Pq copyright |
|
.It \\& |
|
.Pq non-breaking space |
|
.It \\e |
|
.Pq escape |
|
.It \\(Am |
|
.Pq ampersand, deprecated |
|
.El |
|
.\" SECTION |
|
.Sh CLASSIFICATION |
|
Macros are classified in an ontology described by scope rules. |
|
.Bl -tag -width "in-lineX" |
|
.\" LIST-ITEM |
|
.It Em Block |
|
Block macros enclose other block macros, in-line macros or text, and |
|
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 -tag -width "partial-blockX" |
|
.\" LIST-ITEM |
|
.It Em Full-block |
|
Always spans multiple lines. Consists optionally of one or more |
|
.Qq heads , |
|
subsequent macros or text on the same line following invocation; a |
|
.Qq body , |
|
which spans subsequent lines of text or macros; and an optional |
|
.Qq tail , |
|
macros or text on the same line following closure. |
|
.\" LIST-ITEM |
|
.It Em Partial-block |
|
May span multiple lines. Consists optionally of a |
|
.Qq head , |
|
text immediately following invocation; always a |
|
.Qq body , |
|
text or macros following the head on the same and subsequent lines; and |
|
optionally a |
|
.Qq tail , |
|
text immediately following closure. |
|
.El |
|
.\" LIST-ITEM |
|
.It Em In-line |
|
In-line 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 |
|
delimiting punctuation. In-line macros follow different conventions for |
|
closure; see |
|
.Sx MACROS |
|
for per-macro details. |
|
.El |
|
.\" .\" SUB-SECTION |
|
.\" .Ss Examples |
|
.\" The following examples illustrate each macro classification. |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit full-block. Has head, body and no tail. Scope closed by |
|
.\" second |
|
.\" .Sq \&Sh |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Sh SECTION 1 |
|
.\" body... |
|
.\" \&.Sh SECTION 2 |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Nested implicit full-block, where the subsection |
|
.\" .Sq \&Ss |
|
.\" is within the scope of the parent section |
|
.\" .Sq \&Sh |
|
.\" and closed along with its parent by the subsequent |
|
.\" .Sq \&Sh . |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Sh SECTION 1 |
|
.\" \&.Ss Subsection 1 |
|
.\" body... |
|
.\" \&.Sh SECTION 2 |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit full-block. Has a head, a body and no tail. Scope closed by |
|
.\" .Sq \&Ef |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Bf symbolic |
|
.\" body... |
|
.\" \&.Ef |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Nested explicit/implicit scope. |
|
.\" .Sq \&It |
|
.\" macro is an implicit block whose scope is closed by the explicit |
|
.\" .Sq \&El |
|
.\" closure. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Bl \-bullet |
|
.\" \&.It head |
|
.\" body... |
|
.\" \&.El |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit partial-block. Has head, body and tail. Scope closed by |
|
.\" .Sq \&Ec |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Eo head body... \&Ec tail |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit partial-block. Has only body. Scope is closed by end-of-line. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Sq body... |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit partial-block with only body and scope closed by |
|
.\" .Sq \&Ac |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Ao body... \&Ac |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit partial-block enclosing explicit partial-block. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Sq body... \&Ao body... \&Ac |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Inline macros, several in sequence. Scope is closed for |
|
.\" .Sq \&Fl |
|
.\" by the punctuation delimiter and |
|
.\" .Sq \&Ar |
|
.\" by the end-of-line. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Fl text0 text1 ; Ar text0 text1 |
|
.\" .Ed |
|
.\" SECTION |
|
.Sh MACROS |
|
This section contains a complete list of all |
|
.Nm |
|
macros, arranged ontologically then alphanumerically by macro name. A |
|
.Qq callable |
|
macro is may be invoked subsequent to the initial macro-line macro. A |
|
.Qq parsable |
|
macro May be followed by further (ostensibly callable) macros. |
|
.\" SUB-SECTION |
|
.Ss Block full-implicit |
.Ss Block full-implicit |
The head of these macros follows invocation; the body is the content of |
Multi-line scope closed by end-of-file or implicitly by another macro. |
subsequent lines prior to closure. None of these macros have tails; |
All macros have bodies; some |
some |
|
.Po |
.Po |
.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, while |
|
.Sq \&It \-column |
|
may have multiple heads. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
|
\(lBbody...\(rB |
|
.Ed |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing |
|
.It \&.Sh Ta \&No Ta \&No Ta \&.Sh |
|
.It \&.Ss Ta \&No Ta \&No Ta \&.Sh, \&.Ss |
|
.It \&.It Ta \&No Ta Yes Ta \&.It, \&.El |
|
.El |
|
.\" SUB-SECTION |
|
.Ss Block full-explicit |
|
None of these macros are callable or parsed. The last column indicates |
|
the explicit scope rules. All contains bodies, some may contain heads |
|
.Pq So \&Bf Sc . |
|
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX |
|
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It \&.Bd Ta \&No Ta \&No Ta closed by \&.Ed |
.It \&It Ta \&No Ta Yes Ta closed by \&It, \&El |
.It \&.Ed Ta \&No Ta \&No Ta opened by \&.Bd |
.It \&Nd Ta \&No Ta \&No Ta closed by \&Sh |
.It \&.Bl Ta \&No Ta \&No Ta closed by \&.El |
.It \&Sh Ta \&No Ta \&No Ta closed by \&Sh |
.It \&.El Ta \&No Ta \&No Ta opened by \&.Bl |
.It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss |
.It \&.Bf Ta \&No Ta \&No Ta closed by \&.Ef |
|
.It \&.Ef Ta \&No Ta \&No Ta opened by \&.Bf |
|
.El |
.El |
.\" SUB-SECTION |
.\" SUB-SECTION---------------------- |
.Ss Block partial-implicit |
|
All of these are callable and parsed for further macros. Their scopes |
|
close at the invocation's end-of-line. |
|
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX |
|
.It Em Macro Ta Em Callable Ta Em Parsable |
|
.It \&.Aq Ta Yes Ta Yes |
|
.It \&.Op Ta Yes Ta Yes |
|
.It \&.Bq Ta Yes Ta Yes |
|
.It \&.Dq Ta Yes Ta Yes |
|
.It \&.Pq Ta Yes Ta Yes |
|
.It \&.Qq Ta Yes Ta Yes |
|
.It \&.Sq Ta Yes Ta Yes |
|
.It \&.Brq Ta Yes Ta Yes |
|
.El |
|
.\" SUB-SECTION |
|
.Ss Block partial-explicit |
.Ss Block partial-explicit |
Each of these contains at least a body and, in limited circumstances, a |
Like block full-explicit, but also with single-line scope. Each |
head |
has at least a body and, in limited circumstances, a head |
.Pq So \&Fo Sc , So \&Eo Sc |
.Pq So \&Fo Sc , So \&Eo Sc |
and/or tail |
and/or tail |
.Pq So \&Ec Sc . |
.Pq So \&Ec Sc . |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc \(lBtail...\(rB |
|
|
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ |
|
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
|
.Ed |
|
.\" PARAGRAPH------------ |
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It \&.Ao Ta Yes Ta Yes Ta closed by \&.Ac |
.It \&Ac Ta Yes Ta Yes Ta opened by \&Ao |
.It \&.Ac Ta Yes Ta Yes Ta opened by \&.Ao |
.It \&Ao Ta Yes Ta Yes Ta closed by \&Ac |
.It \&.Bc Ta Yes Ta Yes Ta closed by \&.Bo |
.It \&Bc Ta Yes Ta Yes Ta closed by \&Bo |
.It \&.Bo Ta Yes Ta Yes Ta opened by \&.Bc |
.It \&Bo Ta Yes Ta Yes Ta opened by \&Bc |
.It \&.Pc Ta Yes Ta Yes Ta closed by \&.Po |
.It \&Brc Ta Yes Ta Yes Ta opened by \&Bro |
.It \&.Po Ta Yes Ta Yes Ta opened by \&.Pc |
.It \&Bro Ta Yes Ta Yes Ta closed by \&Brc |
.It \&.Do Ta Yes Ta Yes Ta closed by \&.Dc |
.It \&Dc Ta Yes Ta Yes Ta opened by \&Do |
.It \&.Dc Ta Yes Ta Yes Ta opened by \&.Do |
.It \&Do Ta Yes Ta Yes Ta closed by \&Dc |
.It \&.Xo Ta Yes Ta Yes Ta closed by \&.Xc |
.It \&Ec Ta Yes Ta Yes Ta opened by \&Eo |
.It \&.Xc Ta Yes Ta Yes Ta opened by \&.Xo |
.It \&Eo Ta Yes Ta Yes Ta closed by \&Ec |
.It \&.Bro Ta Yes Ta Yes Ta closed by \&.Brc |
.It \&Fc Ta Yes Ta Yes Ta opened by \&Fo |
.It \&.Brc Ta Yes Ta Yes Ta opened by \&.Bro |
.It \&Fo Ta \&No Ta \&No Ta closed by \&Fc |
.It \&.Oc Ta Yes Ta Yes Ta closed by \&.Oo |
.It \&Oc Ta Yes Ta Yes Ta closed by \&Oo |
.It \&.Oo Ta Yes Ta Yes Ta opened by \&.Oc |
.It \&Oo Ta Yes Ta Yes Ta opened by \&Oc |
.It \&.So Ta Yes Ta Yes Ta closed by \&.Sc |
.It \&Pc Ta Yes Ta Yes Ta closed by \&Po |
.It \&.Sc Ta Yes Ta Yes Ta opened by \&.So |
.It \&Po Ta Yes Ta Yes Ta opened by \&Pc |
.It \&.Fc Ta Yes Ta Yes Ta opened by \&.Fo |
.It \&Qc Ta Yes Ta Yes Ta opened by \&Oo |
.It \&.Fo Ta \&No Ta \&No Ta closed by \&.Fc |
.It \&Qo Ta Yes Ta Yes Ta closed by \&Oc |
.It \&.Ec Ta Yes Ta Yes Ta opened by \&.Eo |
.It \&Re Ta \&No Ta \&No Ta opened by \&Rs |
.It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec |
.It \&Rs Ta \&No Ta \&No Ta closed by \&Re |
.It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo |
.It \&Sc Ta Yes Ta Yes Ta opened by \&So |
.It \&.Qo Ta Yes Ta Yes Ta closed by \&.Oc |
.It \&So Ta Yes Ta Yes Ta closed by \&Sc |
|
.It \&Xc Ta Yes Ta Yes Ta opened by \&Xo |
|
.It \&Xo Ta Yes Ta Yes Ta closed by \&Xc |
.El |
.El |
.\" SUB-SECTION |
.\" SUB-SECTION---------------------- |
.Ss General |
.Ss Block partial-implicit |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX |
Like block full-implicit, but with single-line scope closed by |
|
.Sx Reserved Characters |
|
or end of line. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
|
.Ed |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
.It Em Macro Ta Em Callable Ta Em Parsable |
.It Em Macro Ta Em Callable Ta Em Parsable |
.It \&.Dd Ta \& Ta \& |
.It \&Aq Ta Yes Ta Yes |
.It \&.Dt Ta \& Ta \& |
.It \&Bq Ta Yes Ta Yes |
.It \&.Os Ta \& Ta \& |
.It \&Brq Ta Yes Ta Yes |
.It \&.Pp Ta \& Ta \& |
.It \&D1 Ta \&No Ta \&Yes |
.It \&.D1 Ta \& Ta \& |
.It \&Dl Ta \&No Ta Yes |
.It \&.Dl Ta \& Ta Yes |
.It \&Dq Ta Yes Ta Yes |
.It \&.Ad Ta Yes Ta Yes |
.It \&Op Ta Yes Ta Yes |
.It \&.An Ta \& Ta Yes |
.It \&Pq Ta Yes Ta Yes |
.It \&.Ar Ta Yes Ta Yes |
.It \&Ql Ta Yes Ta Yes |
.It \&.Cd Ta Yes Ta \& |
.It \&Qq Ta Yes Ta Yes |
.It \&.Cm Ta Yes Ta Yes |
.It \&Sq Ta Yes Ta Yes |
.It \&.Dv Ta Yes Ta Yes |
.El |
.It \&.Er Ta Yes Ta Yes |
.\" SUB-SECTION---------------------- |
.It \&.Ev Ta Yes Ta Yes |
.Ss In-line |
.It \&.Ex Ta \& Ta \& |
Closed by |
.It \&.Fa Ta Yes Ta Yes |
.Sx Reserved Characters , |
.It \&.Fd Ta \& Ta \& |
end of line, fixed argument lengths, and/or subsequent macros. In-line |
.It \&.Fl Ta Yes Ta Yes |
macros have only text children. If a number (or inequality) of |
.It \&.Fn Ta Yes Ta Yes |
arguments is |
.It \&.Ft Ta \& Ta \& |
.Pq n , |
.It \&.Ic Ta Yes Ta Yes |
then the macro accepts an arbitrary number of arguments. |
.It \&.In Ta \& Ta \& |
.Bd -literal -offset indent |
.It \&.Li Ta Yes Ta Yes |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb |
.It \&.Nd Ta \& Ta \& |
|
.It \&.Nm Ta Yes Ta Yes |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
.It \&.Ot Ta \& Ta \& |
|
.It \&.Pa Ta Yes Ta Yes |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
.It \&.Rv Ta \& Ta \& |
.Ed |
.It \&.St Ta Yes Ta \& |
.\" PARAGRAPH------------ |
.It \&.Va Ta Yes Ta Yes |
.Pp |
.It \&.Vt Ta Yes Ta Yes |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent |
.It \&.Xr Ta Yes Ta Yes |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It \&.%A Ta \& Ta \& |
.It \&%A Ta \&No Ta \&No Ta >0 |
.It \&.%B Ta \& Ta \& |
.It \&%B Ta \&No Ta \&No Ta >0 |
.It \&.%C Ta \& Ta \& |
.It \&%C Ta \&No Ta \&No Ta >0 |
.It \&.%D Ta \& Ta \& |
.It \&%D Ta \&No Ta \&No Ta >0 |
.It \&.%I Ta \& Ta \& |
.It \&%I Ta \&No Ta \&No Ta >0 |
.It \&.%J Ta \& Ta \& |
.It \&%J Ta \&No Ta \&No Ta >0 |
.It \&.%N Ta \& Ta \& |
.It \&%N Ta \&No Ta \&No Ta >0 |
.It \&.%O Ta \& Ta \& |
.It \&%O Ta \&No Ta \&No Ta >0 |
.It \&.%P Ta \& Ta \& |
.It \&%P Ta \&No Ta \&No Ta >0 |
.It \&.%R Ta \& Ta \& |
.It \&%R Ta \&No Ta \&No Ta >0 |
.It \&.%T Ta \& Ta \& |
.It \&%T Ta \&No Ta \&No Ta >0 |
.It \&.%V Ta \& Ta \& |
.It \&%V Ta \&No Ta \&No Ta >0 |
.It \&.At Ta Yes Ta Yes |
.It \&Ad Ta Yes Ta Yes Ta n |
.It \&.Bsx Ta Yes Ta Yes |
.It \&An Ta Yes Ta Yes Ta n |
.It \&.Bx Ta Yes Ta Yes |
.It \&Ap Ta Yes Ta Yes Ta 0 |
.It \&.Db Ta \& Ta \& |
.It \&Ar Ta Yes Ta Yes Ta n |
.It \&.Em Ta Yes Ta Yes |
.It \&At Ta Yes Ta Yes Ta 1 |
.It \&.Fx Ta Yes Ta Yes |
.It \&Bsx Ta Yes Ta Yes Ta n |
.It \&.Ms Ta \& Ta Yes |
.It \&Bt Ta \&No Ta \&No Ta 0 |
.It \&.No Ta Yes Ta Yes |
.It \&Bx Ta Yes Ta Yes Ta n |
.It \&.Ns Ta Yes Ta Yes |
.It \&Cd Ta Yes Ta \&No Ta >0 |
.It \&.Nx Ta Yes Ta Yes |
.It \&Cm Ta Yes Ta Yes Ta n |
.It \&.Ox Ta Yes Ta Yes |
.It \&Db Ta \&No Ta \&No Ta 1 |
.It \&.Pf Ta \& Ta Yes |
.It \&Dd Ta \&No Ta \&No Ta >0 |
.It \&.Ql Ta Yes Ta Yes |
.It \&Dt Ta \&No Ta \&No Ta n |
.It \&.Re Ta \& Ta \& |
.It \&Dv Ta Yes Ta Yes Ta n |
.It \&.Rs Ta \& Ta \& |
.It \&Dx Ta Yes Ta Yes Ta n |
.It \&.Sm Ta \& Ta \& |
.It \&Em Ta Yes Ta Yes Ta >0 |
.It \&.Sx Ta Yes Ta Yes |
.It \&En Ta \&No Ta \&No Ta 0 |
.It \&.Sy Ta Yes Ta Yes |
.It \&Er Ta Yes Ta Yes Ta >0 |
.It \&.Tn Ta Yes Ta Yes |
.It \&Es Ta \&No Ta \&No Ta 0 |
.It \&.Ux Ta Yes Ta Yes |
.It \&Ev Ta Yes Ta Yes Ta n |
.It \&.Bk Ta \& Ta \& |
.It \&Ex Ta \&No Ta \&No Ta 0 |
.It \&.Ek Ta \& Ta \& |
.It \&Fa Ta Yes Ta Yes Ta n |
.It \&.Bt Ta \& Ta \& |
.It \&Fd Ta \&No Ta \&No Ta >0 |
.It \&.Hf Ta \& Ta \& |
.It \&Fl Ta Yes Ta Yes Ta n |
.It \&.Fr Ta \& Ta \& |
.It \&Fn Ta Yes Ta Yes Ta >0 |
.It \&.Ud Ta \& Ta \& |
.It \&Fr Ta \&No Ta \&No Ta n |
.It \&.Lb Ta \& Ta \& |
.It \&Ft Ta Yes Ta Yes Ta n |
.It \&.Ap Ta Yes Ta Yes |
.It \&Fx Ta Yes Ta Yes Ta n |
.It \&.Lp Ta \& Ta \& |
.It \&Hf Ta \&No Ta \&No Ta n |
.It \&.Lk Ta \& Ta Yes |
.It \&Ic Ta Yes Ta Yes Ta >0 |
.It \&.Mt Ta \& Ta Yes |
.It \&In Ta \&No Ta \&No Ta n |
|
.It \&Lb Ta \&No Ta \&No Ta 1 |
|
.It \&Li Ta Yes Ta Yes Ta n |
|
.It \&Lk Ta Yes Ta Yes Ta n |
|
.It \&Lp Ta \&No Ta \&No Ta 0 |
|
.It \&Ms Ta Yes Ta Yes Ta >0 |
|
.It \&Mt Ta Yes Ta Yes Ta >0 |
|
.It \&Nm Ta Yes Ta Yes Ta n |
|
.It \&No Ta Yes Ta Yes Ta 0 |
|
.It \&Ns Ta Yes Ta Yes Ta 0 |
|
.It \&Nx Ta Yes Ta Yes Ta n |
|
.It \&Os Ta \&No Ta \&No Ta n |
|
.It \&Ot Ta \&No Ta \&No Ta n |
|
.It \&Ox Ta Yes Ta Yes Ta n |
|
.It \&Pa Ta Yes Ta Yes Ta n |
|
.It \&Pf Ta \&No Ta Yes Ta 1 |
|
.It \&Pp Ta \&No Ta \&No Ta 0 |
|
.It \&Rv Ta \&No Ta \&No Ta 0 |
|
.It \&Sm Ta \&No Ta \&No Ta 1 |
|
.It \&St Ta \&No Ta Yes Ta 1 |
|
.It \&Sx Ta Yes Ta Yes Ta >0 |
|
.It \&Sy Ta Yes Ta Yes Ta >0 |
|
.It \&Tn Ta Yes Ta Yes Ta >0 |
|
.It \&Ud Ta \&No Ta \&No Ta 0 |
|
.It \&Ux Ta Yes Ta Yes Ta n |
|
.It \&Va Ta Yes Ta Yes Ta n |
|
.It \&Vt Ta Yes Ta Yes Ta >0 |
|
.It \&Xr Ta Yes Ta Yes Ta >0, <3 |
|
.It \&br Ta \&No Ta \&No Ta 0 |
|
.It \&sp Ta \&No Ta \&No Ta 1 |
|
.El |
|
.\" SECTION--------------------------------------------- |
|
.Sh COMPATIBILITY |
|
This section documents compatibility with other roff implementations, at |
|
this time limited to |
|
.Xr groff 1 . |
|
The term |
|
.Qq historic groff |
|
refers to those versions before the |
|
.Pa doc.tmac |
|
file re-write |
|
.Pq somewhere between 1.15 and 1.19 . |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
.Bl -dash -compact |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&sp |
|
macro does not accept negative numbers. |
|
.\" LIST-ITEM |
|
.It |
|
Some character sequences in groff are not handled depending on escape |
|
style, e.g., |
|
.Sq \e(ba |
|
and |
|
.Sq \e*(Ba |
|
may not be interchanged. This is no longer the case: all character |
|
sequences resolve to the same symbol, regardless the escape style. |
|
.\" LIST-ITEM |
|
.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. |
|
.\" LIST-ITEM |
|
.It |
|
Historic groff has many un-callable macros. Most of these (excluding |
|
some block-level macros) are now callable, conforming to the |
|
non-historic groff version. |
|
.\" LIST-ITEM |
|
.It |
|
The vertical bar |
|
.Sq \(ba |
|
made historic groff |
|
.Qq go orbital |
|
but is a proper delimiter in this implementation. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&It \-nested |
|
is assumed for all lists (it wasn't in historic groff): 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 preceded by other arguments (instead |
|
of proceeded) is not supported. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&At |
|
macro only accepts a single parameter. |
|
.\" 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 |
|
If an special-character control character is escaped |
|
.Sq \e\e , |
|
it will obviously not render the subsequent sequence. Even newer |
|
versions of groff seem to dither on this. |
|
.\" LIST-ITEM |
|
.It |
|
In groff, the |
|
.Sq \&Fo |
|
macro only produces the first parameter. This is no longer the case. |
|
.El |
|
.\" SECTION--------------------------------------------- |
|
.Sh SEE ALSO |
|
.Xr mandoc 1 , |
|
.Xr mandoc_char 7 |
|
.\" SECTION--------------------------------------------- |
|
.Sh AUTHORS |
|
The |
|
.Nm |
|
reference was written by |
|
.An Kristaps Dzonsons Aq kristaps@kth.se . |
|
.\" SECTION--------------------------------------------- |
|
.Sh CAVEATS |
|
There are many ambiguous parts of mdoc. |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
.Bl -dash -compact |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Fa |
|
should be |
|
.Sq \&Va |
|
as function arguments are variables. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Ft |
|
should be |
|
.Sq \&Vt |
|
as function return types are still types. Furthermore, the |
|
.Sq \&Ft |
|
should be removed and |
|
.Sq \&Fo , |
|
which ostensibly follows it, should follow the same convention as |
|
.Sq \&Va . |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Va |
|
should formalise that only one or two arguments are acceptable: a |
|
variable name and optional, preceding type. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Fd |
|
is ambiguous. It's commonly used to indicate an include file in the |
|
synopsis section. |
|
.Sq \&In |
|
should be used, instead. |
|
.\" LIST-ITEM |
|
.It |
|
Only the |
|
.Sq \-literal |
|
argument to |
|
.Sq \&Bd |
|
makes sense. The remaining ones should be removed. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&Xo |
|
and |
|
.Sq \&Xc |
|
macros should be deprecated. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&Dt |
|
macro lacks clarity. It should be absolutely clear which title will |
|
render when formatting the manual page. |
|
.\" LIST-ITEM |
|
.It |
|
A |
|
.Sq \&Lx |
|
should be provided for Linux (\(`a la |
|
.Sq \&Ox , |
|
.Sq \&Nx |
|
etc.). |
|
.\" LIST-ITEM |
|
.It |
|
There's no way to refer to references in |
|
.Sq \&Rs/Re |
|
blocks. |
|
.\" LIST-ITEM |
|
.It |
|
The \-split and \-nosplit arguments to |
|
.Sq \&An |
|
are inane. |
.El |
.El |