version 1.1, 2009/03/13 07:46:10 |
version 1.56, 2009/08/18 14:27:16 |
|
|
.\" $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 |
. |
|
. |
.Sh NAME |
.Sh NAME |
.Nm mdoc |
. Nm mdoc |
.Nd mdoc macro reference |
. Nd mdoc language reference |
.\" 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, |
.Nm |
and usage. Our reference implementation is |
|
. Xr mandoc 1 . |
|
The |
|
. Sx COMPATIBILITY |
|
section describes compatibility with |
|
. Xr groff 1 . |
|
. Pp |
|
An |
|
. 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. |
.Nm |
Other lines are interpreted within the current state. |
documents may contain only printable alphanumeric characters, the space |
. Ed |
character |
. |
.Sq \ , |
. |
and, in certain circumstances, the tab character |
.Sh LANGUAGE SYNTAX |
.Sq \et . |
. Nm |
All manuals must have |
documents may contain only graphable 7-bit ASCII characters, the space |
.Sq \en |
character, and, in certain circumstances, the tab character. All |
line termination. |
manuals must have |
.\" SUB-SECTION |
. Ux |
.Ss Special Characters |
line terminators. |
Within a macro line, the following characters are special: |
. |
.\" PARAGRAPH |
. |
.Pp |
. Ss Comments |
.Bl -tag -width Ds -offset XXXX -compact |
Text following a |
.It \&. |
. Sq \e" , |
period |
whether in a macro or free-form text line, is ignored to the end of |
.It \&, |
line. A macro line with only a control character and comment escape, |
comma |
. Sq \&.\e" , |
.It \&: |
is also ignored. |
colon |
. |
.It \&; |
. |
semicolon |
. Ss Reserved Characters |
.It \&( |
Within a macro line, the following characters are reserved: |
left-parenthesis |
. Bl -tag -width Ds -offset indent -compact |
.It \&) |
. It \&. |
right-parenthesis |
. Pq period |
.It \&[ |
. It \&, |
left-bracket |
. Pq comma |
.It \&] |
. It \&: |
right-bracket |
. Pq colon |
.It \&? |
. It \&; |
question |
. Pq semicolon |
.It \&! |
. It \&( |
exclmamation |
. Pq left-parenthesis |
.El |
. It \&) |
.Pp |
. Pq right-parenthesis |
Use of these characters must either be escaped with a non-breaking space |
. It \&[ |
.Pq Sq \e& |
. Pq left-bracket |
or, if applicable, an appropriate escape-sequence used. |
. It \&] |
.\" SUB-SECTION |
. Pq right-bracket |
.Ss Special Characters |
. It \&? |
Special character sequences begin with the escape character |
. Pq question |
.Sq \\ |
. It \&! |
and followed by either an open-parenthesis |
. Pq exclamation |
.Sq \&( |
. It \&| |
|
. Pq vertical bar |
|
. El |
|
. Pp |
|
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& |
|
or, if applicable, an appropriate escape sequence used. |
|
. |
|
. |
|
. Ss Special Characters |
|
Special characters may occur in both macro and free-form lines. |
|
Sequences begin with the escape character |
|
. Sq \e |
|
followed by either an open-parenthesis |
|
. 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 |
.Pp |
. Xr mandoc_char 7 |
Characters may alternatively be escaped by a slash-asterisk, |
for a complete list. Examples include |
.Sq \\* , |
. Sq \e(em |
with the same combinations as described above. This form, however, is |
. Pq em-dash |
deprecated. The following is a table of all available escapes, arranged |
and |
by classification. |
. Sq \ee |
.Pp |
. Pq back-slash . |
Grammatic: |
. |
.Pp |
. |
.Bl -tag -width 12n -offset "XXXX" -compact |
. Ss Text Decoration |
.It \\(em |
Terms may be text-decorated using the |
.Pq em-dash |
. Sq \ef |
.It \\(en |
escape followed by an indicator: B (bold), I, (italic), or P and R |
.Pq en-dash |
(Roman, or reset). This form is not recommended for |
.It \e- |
. Nm , |
.Pq hyphen |
which encourages semantic, not presentation, annotation. |
.It \\\\ |
. |
.Pq back-slash |
. |
.It \e' |
. Ss Predefined Strings |
.Pq apostrophe |
Historically, |
.It \e` |
. Xr groff 1 |
.Pq back-tick |
also defined a set of package-specific |
.It \\ |
. Dq predefined strings , |
.Pq space |
which, like |
.It \\. |
. Sx Special Characters , |
.Pq period |
demark special output characters and strings by way of input codes. |
.El |
Predefined strings are escaped with the slash-asterisk, |
.\" PARAGRAPH |
. Sq \e* : |
.Pp |
single-character |
Enclosures: |
. Sq \e*X , |
.Pp |
two-character |
.Bl -tag -width 12n -offset "XXXX" -compact |
. Sq \e*(XX , |
.It \\(rC |
and N-character |
.Pq right brace |
. Sq \e*[N] . |
.It \\(lC |
See |
.Pq left brace |
. Xr mandoc_char 7 |
.It \\(ra |
for a complete list. Examples include |
.Pq right angle |
. Sq \e*(Am |
.It \\(la |
. Pq ampersand |
.Pq left angle |
and |
.It \\(rB |
. Sq \e*(Ba |
.Pq right bracket |
. Pq vertical bar . |
.It \\(lB |
. |
.Pq left bracket |
. |
.It \\q |
. Ss Whitespace |
.Pq double-quote |
In non-literal free-form lines, consecutive blocks of whitespace are |
.It \\(lq |
pruned from input and added later in the output filter, if applicable: |
.Pq left double-quote |
. Bd -literal -offset indent |
.It \\(Lq |
These spaces are pruned from input. |
.Pq left double-quote, deprecated |
\&.Bd \-literal |
.It \\(rq |
These are not. |
.Pq right double-quote |
\&.Ed |
.It \\(Rq |
. Ed |
.Pq right double-quote, deprecated |
. Pp |
.It \\(oq |
In macro lines, whitespace delimits arguments and is discarded. If |
.Pq left single-quote |
arguments are quoted, whitespace within the quotes is retained. |
.It \\(aq |
. Pp |
.Pq right single-quote |
Blank lines are only permitted within literal contexts, as are lines |
.El |
containing only whitespace. Tab characters are only acceptable when |
.\" PARAGRAPH |
delimiting |
.Pp |
. Sq \&Bl \-column |
Indicatives: |
or when in a literal context. |
.Pp |
. |
.Bl -tag -width 12n -offset "XXXX" -compact |
. |
.It \\(<- |
. Ss Quotation |
.Pq left arrow |
Macro arguments may be quoted with a double-quote to group |
.It \\(-> |
space-delimited terms or to retain blocks of whitespace. A quoted |
.Pq right arrow |
argument begins with a double-quote preceded by whitespace. The next |
.It \\(ua |
double-quote not pair-wise adjacent to another double-quote terminates |
.Pq up arrow |
the literal, regardless of surrounding whitespace. |
.It \\(da |
. Pp |
.Pq down arrow |
This produces tokens |
.El |
. Sq a" , |
.\" PARAGRAPH |
. Sq b c , |
.Pp |
. Sq de , |
Mathematical: |
and |
.Pp |
. Sq fg" . |
.Bl -tag -width 12n -offset "XXXX" -compact |
Note that any quoted term, be it argument or macro, is indiscriminately |
.It \\(Gt |
considered literal text. Thus, the following produces |
.Pq greater-than, deprecated |
. Sq \&Em a : |
.It \\(Lt |
. Bd -literal -offset indent |
.Pq less-than, deprecated |
\&.Em "Em a" |
.It \\(<= |
. Ed |
.Pq less-than-equal |
. Pp |
.It \\(Le |
In free-form mode, quotes are regarded as opaque text. |
.Pq less-than-equal, deprecated |
. |
.It \\(>= |
. |
.Pq greater-than-equal |
.Sh MANUAL STRUCTURE |
.It \\(Ge |
Each |
.Pq greater-than-equal |
. Nm |
.It \\(== |
document must begin with a document prologue, containing, in order, |
.Pq equal |
. Sq \&Dd , |
.It \\(!= |
. Sq \&Dt , |
.Pq not equal |
and |
.It \\(Ne |
. Sq \&Os , |
.Pq not equal, deprecated |
then the NAME section containing at least one |
.It \\(if |
. Sq \&Nm |
.Pq infinity |
followed by |
.It \\(If |
. Sq \&Nd : |
.Pq infinity, deprecated |
. Bd -literal -offset indent |
.It \\(na |
\&.Dd $\&Mdocdate$ |
.Pq NaN , an extension |
\&.Dt mdoc 7 |
.It \\(Na |
\&.Os |
.Pq NaN, deprecated |
\&.Sh NAME |
.It \\(+- |
\&.Nm mdoc |
.Pq plus-minus |
\&.Nd mdoc language reference |
.It \\(Pm |
. Ed |
.Pq plus-minus, deprecated |
. Pp |
.It \\(** |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
.Pq asterisk |
but non-compulsory. |
.El |
. |
.\" PARAGRAPH |
. |
.Pp |
.Sh MACRO SYNTAX |
Diacritics: |
Macros are one to three three characters in length and begin with a |
.Pp |
control character , |
.Bl -tag -width 12n -offset "XXXX" -compact |
. Sq \&. , |
.It \\(ga |
at the beginning of the line. An arbitrary amount of whitespace may |
.Pq accent grave |
sit between the control character and the macro name. Thus, |
.It \\(aa |
. Sq \&.Pp |
.Pq accent accute |
and |
.El |
. Sq \&.\ \ \ \&Pp |
.\" PARAGRAPH |
are equivalent. Macro names are two or three characters in length. |
.Pp |
. Pp |
Special symbols: |
The syntax of a macro depends on its classification. In this section, |
.Pp |
. Sq \-arg |
.Bl -tag -width 12n -offset "XXXX" -compact |
refers to macro arguments, which may be followed by zero or more |
.It \\(bu |
. Sq parm |
.Pq bullet |
parameters; |
.It \\(ba |
. Sq \&Yo |
.Pq bar |
opens the scope of a macro; and if specified, |
.It \\(Ba |
. Sq \&Yc |
.Pq bar, deprecated |
closes it out. |
.It \\(co |
. Pp |
.Pq copyright |
The |
.It \\& |
. Em Callable |
.Pq non-breaking space |
column indicates that the macro may be called subsequent to the initial |
.It \\e |
line-macro. If a macro is not callable, then its invocation after the |
.Pq escape |
initial line macro is interpreted as opaque text, such that |
.It \\(Am |
. Sq \&.Fl Sh |
.Pq ampersand, deprecated |
produces |
.El |
. Sq Fl Sh . |
.\" SECTION |
. Pp |
.Sh CLASSIFICATION |
The |
Macros are classified in an ontology described by scope rules. |
. Em Parsable |
.Bl -tag -width "in-lineX" |
column indicates whether the macro may be followed by further |
.\" LIST-ITEM |
(ostensibly callable) macros. If a macro is not parsable, subsequent |
.It Em Block |
macro invocations on the line will be interpreted as opaque text. |
Block macros enclose other block macros, in-line macros or text, and |
. Pp |
may span multiple lines. |
The |
.Qq Implicit |
. Em Scope |
block scope is closed by a subsequent invocation of the same macro, |
column, if applicable, describes closure rules. |
one of a set of corresponding closure macros or end-of-file. |
. |
.Qq Explicit |
. |
block scope is closed by a corresponding closure macro. |
. Ss Block full-explicit |
.Bl -tag -width "partial-blockX" |
Multi-line scope closed by an explicit closing macro. All macros |
.\" LIST-ITEM |
contains bodies; only |
.It Em Full-block |
. Pq Sq \&Bf |
Always spans multiple lines. Consists optionally of one or more |
contains a head. |
.Qq heads , |
. Bd -literal -offset indent |
subsequent macros or text on the same line following invocation; a |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
.Qq body , |
\(lBbody...\(rB |
which spans subsequent lines of text or macros; and an optional |
\&.Yc |
.Qq tail , |
. Ed |
macros or text on the same line following closure. |
. Pp |
.\" LIST-ITEM |
. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
.It Em Partial-block |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
May span multiple lines. Consists optionally of a |
. It \&Bd Ta \&No Ta \&No Ta closed by \&Ed |
.Qq head , |
. It \&Bf Ta \&No Ta \&No Ta closed by \&Ef |
text immediately following invocation; always a |
. It \&Bk Ta \&No Ta \&No Ta closed by \&Ek |
.Qq body , |
. It \&Bl Ta \&No Ta \&No Ta closed by \&El |
text or macros following the head on the same and subsequent lines; and |
. It \&Ed Ta \&No Ta \&No Ta opened by \&Bd |
optionally a |
. It \&Ef Ta \&No Ta \&No Ta opened by \&Bf |
.Qq tail , |
. It \&Ek Ta \&No Ta \&No Ta opened by \&Bk |
text immediately following closure. |
. It \&El Ta \&No Ta \&No Ta opened by \&Bl |
.El |
. El |
.\" LIST-ITEM |
. |
.It Em In-line |
. |
In-line macros may only enclose text and span at most a single line. If |
. Ss Block full-implicit |
a macro is parsable, its scope may be closed by subsequent macros or |
Multi-line scope closed by end-of-file or implicitly by another macro. |
delimiting punctuation. In-line macros follow different conventions for |
All macros have bodies; some |
closure; see |
. Po |
.Sx MACROS |
. Sq \&It \-bullet , |
for per-macro details. |
. Sq \-hyphen , |
.El |
. Sq \-dash , |
.\" .\" SUB-SECTION |
. Sq \-enum , |
.\" .Ss Examples |
. Sq \-item |
.\" The following examples illustrate each macro classification. |
. Pc |
.\" .\" PARAGRAPH |
don't have heads, while |
.\" .Pp |
. Sq \&It \-column |
.\" Implicit full-block. Has head, body and no tail. Scope closed by |
may have multiple heads. |
.\" second |
. Bd -literal -offset indent |
.\" .Sq \&Sh |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
.\" invocation. |
\(lBbody...\(rB |
.\" .Bd -literal -offset XXXX |
. Ed |
.\" \&.Sh SECTION 1 |
. Pp |
.\" body... |
. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
.\" \&.Sh SECTION 2 |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.\" .Ed |
. It \&It Ta \&No Ta Yes Ta closed by \&It, \&El |
.\" .\" PARAGRAPH |
. It \&Nd Ta \&No Ta \&No Ta closed by \&Sh |
.\" .Pp |
. It \&Sh Ta \&No Ta \&No Ta closed by \&Sh |
.\" Nested implicit full-block, where the subsection |
. It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss |
.\" .Sq \&Ss |
. El |
.\" is within the scope of the parent section |
. |
.\" .Sq \&Sh |
. |
.\" and closed along with its parent by the subsequent |
. Ss Block partial-explicit |
.\" .Sq \&Sh . |
Like block full-explicit, but also with single-line scope. Each |
.\" .Bd -literal -offset XXXX |
has at least a body and, in limited circumstances, a head |
.\" \&.Sh SECTION 1 |
. Pq So \&Fo Sc , So \&Eo Sc |
.\" \&.Ss Subsection 1 |
and/or tail |
.\" body... |
. Pq So \&Ec Sc . |
.\" \&.Sh SECTION 2 |
. Bd -literal -offset indent |
.\" .Ed |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
.\" .\" PARAGRAPH |
\(lBbody...\(rB |
.\" .Pp |
\&.Yc \(lBtail...\(rB |
.\" Explicit full-block. Has a head, a body and no tail. Scope closed by |
|
.\" .Sq \&Ef |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ |
.\" invocation. |
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
.\" .Bd -literal -offset XXXX |
. Ed |
.\" \&.Bf symbolic |
. Pp |
.\" body... |
. Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent |
.\" \&.Ef |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.\" .Ed |
. It \&Ac Ta Yes Ta Yes Ta opened by \&Ao |
.\" .\" PARAGRAPH |
. It \&Ao Ta Yes Ta Yes Ta closed by \&Ac |
.\" .Pp |
. It \&Bc Ta Yes Ta Yes Ta closed by \&Bo |
.\" Nested explicit/implicit scope. |
. It \&Bo Ta Yes Ta Yes Ta opened by \&Bc |
.\" .Sq \&It |
. It \&Brc Ta Yes Ta Yes Ta opened by \&Bro |
.\" macro is an implicit block whose scope is closed by the explicit |
. It \&Bro Ta Yes Ta Yes Ta closed by \&Brc |
.\" .Sq \&El |
. It \&Dc Ta Yes Ta Yes Ta opened by \&Do |
.\" closure. |
. It \&Do Ta Yes Ta Yes Ta closed by \&Dc |
.\" .Bd -literal -offset XXXX |
. It \&Ec Ta Yes Ta Yes Ta opened by \&Eo |
.\" \&.Bl \-bullet |
. It \&Eo Ta Yes Ta Yes Ta closed by \&Ec |
.\" \&.It head |
. It \&Fc Ta Yes Ta Yes Ta opened by \&Fo |
.\" body... |
. It \&Fo Ta \&No Ta \&No Ta closed by \&Fc |
.\" \&.El |
. It \&Oc Ta Yes Ta Yes Ta closed by \&Oo |
.\" .Ed |
. It \&Oo Ta Yes Ta Yes Ta opened by \&Oc |
.\" .\" PARAGRAPH |
. It \&Pc Ta Yes Ta Yes Ta closed by \&Po |
.\" .Pp |
. It \&Po Ta Yes Ta Yes Ta opened by \&Pc |
.\" Explicit partial-block. Has head, body and tail. Scope closed by |
. It \&Qc Ta Yes Ta Yes Ta opened by \&Oo |
.\" .Sq \&Ec |
. It \&Qo Ta Yes Ta Yes Ta closed by \&Oc |
.\" invocation. |
. It \&Re Ta \&No Ta \&No Ta opened by \&Rs |
.\" .Bd -literal -offset XXX |
. It \&Rs Ta \&No Ta \&No Ta closed by \&Re |
.\" \&.Eo head body... \&Ec tail |
. It \&Sc Ta Yes Ta Yes Ta opened by \&So |
.\" .Ed |
. It \&So Ta Yes Ta Yes Ta closed by \&Sc |
.\" .\" PARAGRAPH |
. It \&Xc Ta Yes Ta Yes Ta opened by \&Xo |
.\" .Pp |
. It \&Xo Ta Yes Ta Yes Ta closed by \&Xc |
.\" Implicit partial-block. Has only body. Scope is closed by end-of-line. |
. El |
.\" .Bd -literal -offset XXX |
. |
.\" \&.Sq body... |
. |
.\" .Ed |
. Ss Block partial-implicit |
.\" .\" PARAGRAPH |
Like block full-implicit, but with single-line scope closed by |
.\" .Pp |
. Sx Reserved Characters |
.\" Explicit partial-block with only body and scope closed by |
or end of line. |
.\" .Sq \&Ac |
. Bd -literal -offset indent |
.\" invocation. |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
.\" .Bd -literal -offset XXXX |
. Ed |
.\" \&.Ao body... \&Ac |
. Pp |
.\" .Ed |
. Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
.\" .\" PARAGRAPH |
. It Em Macro Ta Em Callable Ta Em Parsable |
.\" .Pp |
. It \&Aq Ta Yes Ta Yes |
.\" Implicit partial-block enclosing explicit partial-block. |
. It \&Bq Ta Yes Ta Yes |
.\" .Bd -literal -offset XXX |
. It \&Brq Ta Yes Ta Yes |
.\" \&.Sq body... \&Ao body... \&Ac |
. It \&D1 Ta \&No Ta \&Yes |
.\" .Ed |
. It \&Dl Ta \&No Ta Yes |
.\" .\" PARAGRAPH |
. It \&Dq Ta Yes Ta Yes |
.\" .Pp |
. It \&Op Ta Yes Ta Yes |
.\" Inline macros, several in sequence. Scope is closed for |
. It \&Pq Ta Yes Ta Yes |
.\" .Sq \&Fl |
. It \&Ql Ta Yes Ta Yes |
.\" by the punctuation delimiter and |
. It \&Qq Ta Yes Ta Yes |
.\" .Sq \&Ar |
. It \&Sq Ta Yes Ta Yes |
.\" by the end-of-line. |
. El |
.\" .Bd -literal -offset XXXX |
. |
.\" \&.Fl text0 text1 ; Ar text0 text1 |
. |
.\" .Ed |
. Ss In-line |
.\" SECTION |
Closed by |
.Sh MACROS |
. Sx Reserved Characters , |
This section contains a complete list of all |
end of line, fixed argument lengths, and/or subsequent macros. In-line |
.Nm |
macros have only text children. If a number (or inequality) of |
macros, arranged ontologically then alphanumerically by macro name. A |
arguments is |
.Qq callable |
. Pq n , |
macro is may be invoked subsequent to the initial macro-line macro. A |
then the macro accepts an arbitrary number of arguments. |
.Qq parsable |
. Bd -literal -offset indent |
macro May be followed by further (ostensibly callable) macros. |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb |
.\" SUB-SECTION |
|
.Ss Block full-implicit |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
The head of these macros follows invocation; the body is the content of |
|
subsequent lines prior to closure. None of these macros have tails; |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
some |
. Ed |
.Po |
. Pp |
.Sq \&It \-bullet , |
. Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent |
.Sq \-hyphen , |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.Sq \-dash , |
. It \&%A Ta \&No Ta \&No Ta >0 |
.Sq \-enum |
. It \&%B Ta \&No Ta \&No Ta >0 |
.Pc |
. It \&%C Ta \&No Ta \&No Ta >0 |
don't have heads. |
. It \&%D Ta \&No Ta \&No Ta >0 |
.Pp |
. It \&%I Ta \&No Ta \&No Ta >0 |
.Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX |
. It \&%J Ta \&No Ta \&No Ta >0 |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing |
. It \&%N Ta \&No Ta \&No Ta >0 |
.It \&.Sh Ta \&No Ta \&No Ta \&.Sh |
. It \&%O Ta \&No Ta \&No Ta >0 |
.It \&.Ss Ta \&No Ta \&No Ta \&.Sh, \&.Ss |
. It \&%P Ta \&No Ta \&No Ta >0 |
.It \&.It Ta \&No Ta Yes Ta \&.It, \&.El |
. It \&%R Ta \&No Ta \&No Ta >0 |
.El |
. It \&%T Ta \&No Ta \&No Ta >0 |
.\" SUB-SECTION |
. It \&%V Ta \&No Ta \&No Ta >0 |
.Ss Block full-explicit |
. It \&Ad Ta Yes Ta Yes Ta n |
None of these macros are callable or parsed. The last column indicates |
. It \&An Ta Yes Ta Yes Ta n |
the explicit scope rules. All contains bodies, some may contain heads |
. It \&Ap Ta Yes Ta Yes Ta 0 |
.Pq So \&Bf Sc . |
. It \&Ar Ta Yes Ta Yes Ta n |
.Pp |
. It \&At Ta Yes Ta Yes Ta 1 |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX |
. It \&Bsx Ta Yes Ta Yes Ta n |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
. It \&Bt Ta \&No Ta \&No Ta 0 |
.It \&.Bd Ta \&No Ta \&No Ta closed by \&.Ed |
. It \&Bx Ta Yes Ta Yes Ta n |
.It \&.Ed Ta \&No Ta \&No Ta opened by \&.Bd |
. It \&Cd Ta Yes Ta Yes Ta >0 |
.It \&.Bl Ta \&No Ta \&No Ta closed by \&.El |
. It \&Cm Ta Yes Ta Yes Ta n |
.It \&.El Ta \&No Ta \&No Ta opened by \&.Bl |
. It \&Db Ta \&No Ta \&No Ta 1 |
.It \&.Bf Ta \&No Ta \&No Ta closed by \&.Ef |
. It \&Dd Ta \&No Ta \&No Ta >0 |
.It \&.Ef Ta \&No Ta \&No Ta opened by \&.Bf |
. It \&Dt Ta \&No Ta \&No Ta n |
.El |
. It \&Dv Ta Yes Ta Yes Ta n |
.\" SUB-SECTION |
. It \&Dx Ta Yes Ta Yes Ta n |
.Ss Block partial-implicit |
. It \&Em Ta Yes Ta Yes Ta >0 |
All of these are callable and parsed for further macros. Their scopes |
. It \&En Ta \&No Ta \&No Ta 0 |
close at the invocation's end-of-line. |
. It \&Er Ta Yes Ta Yes Ta >0 |
.Pp |
. It \&Es Ta \&No Ta \&No Ta 0 |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX |
. It \&Ev Ta Yes Ta Yes Ta n |
.It Em Macro Ta Em Callable Ta Em Parsable |
. It \&Ex Ta \&No Ta \&No Ta 0 |
.It \&.Aq Ta Yes Ta Yes |
. It \&Fa Ta Yes Ta Yes Ta n |
.It \&.Op Ta Yes Ta Yes |
. It \&Fd Ta \&No Ta \&No Ta >0 |
.It \&.Bq Ta Yes Ta Yes |
. It \&Fl Ta Yes Ta Yes Ta n |
.It \&.Dq Ta Yes Ta Yes |
. It \&Fn Ta Yes Ta Yes Ta >0 |
.It \&.Pq Ta Yes Ta Yes |
. It \&Fr Ta \&No Ta \&No Ta n |
.It \&.Qq Ta Yes Ta Yes |
. It \&Ft Ta Yes Ta Yes Ta n |
.It \&.Sq Ta Yes Ta Yes |
. It \&Fx Ta Yes Ta Yes Ta n |
.It \&.Brq Ta Yes Ta Yes |
. It \&Hf Ta \&No Ta \&No Ta n |
.El |
. It \&Ic Ta Yes Ta Yes Ta >0 |
.\" SUB-SECTION |
. It \&In Ta \&No Ta \&No Ta n |
.Ss Block partial-explicit |
. It \&Lb Ta \&No Ta \&No Ta 1 |
Each of these contains at least a body and, in limited circumstances, a |
. It \&Li Ta Yes Ta Yes Ta n |
head |
. It \&Lk Ta Yes Ta Yes Ta n |
.Pq So \&Fo Sc , So \&Eo Sc |
. It \&Lp Ta \&No Ta \&No Ta 0 |
and/or tail |
. It \&Ms Ta Yes Ta Yes Ta >0 |
.Pq So \&Ec Sc . |
. It \&Mt Ta Yes Ta Yes Ta >0 |
.Pp |
. It \&Nm Ta Yes Ta Yes Ta n |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX |
. It \&No Ta Yes Ta Yes Ta 0 |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
. It \&Ns Ta Yes Ta Yes Ta 0 |
.It \&.Ao Ta Yes Ta Yes Ta closed by \&.Ac |
. It \&Nx Ta Yes Ta Yes Ta n |
.It \&.Ac Ta Yes Ta Yes Ta opened by \&.Ao |
. It \&Os Ta \&No Ta \&No Ta n |
.It \&.Bc Ta Yes Ta Yes Ta closed by \&.Bo |
. It \&Ot Ta \&No Ta \&No Ta n |
.It \&.Bo Ta Yes Ta Yes Ta opened by \&.Bc |
. It \&Ox Ta Yes Ta Yes Ta n |
.It \&.Pc Ta Yes Ta Yes Ta closed by \&.Po |
. It \&Pa Ta Yes Ta Yes Ta n |
.It \&.Po Ta Yes Ta Yes Ta opened by \&.Pc |
. It \&Pf Ta \&No Ta Yes Ta 1 |
.It \&.Do Ta Yes Ta Yes Ta closed by \&.Dc |
. It \&Pp Ta \&No Ta \&No Ta 0 |
.It \&.Dc Ta Yes Ta Yes Ta opened by \&.Do |
. It \&Rv Ta \&No Ta \&No Ta 0 |
.It \&.Xo Ta Yes Ta Yes Ta closed by \&.Xc |
. It \&Sm Ta \&No Ta \&No Ta 1 |
.It \&.Xc Ta Yes Ta Yes Ta opened by \&.Xo |
. It \&St Ta \&No Ta Yes Ta 1 |
.It \&.Bro Ta Yes Ta Yes Ta closed by \&.Brc |
. It \&Sx Ta Yes Ta Yes Ta >0 |
.It \&.Brc Ta Yes Ta Yes Ta opened by \&.Bro |
. It \&Sy Ta Yes Ta Yes Ta >0 |
.It \&.Oc Ta Yes Ta Yes Ta closed by \&.Oo |
. It \&Tn Ta Yes Ta Yes Ta >0 |
.It \&.Oo Ta Yes Ta Yes Ta opened by \&.Oc |
. It \&Ud Ta \&No Ta \&No Ta 0 |
.It \&.So Ta Yes Ta Yes Ta closed by \&.Sc |
. It \&Ux Ta Yes Ta Yes Ta n |
.It \&.Sc Ta Yes Ta Yes Ta opened by \&.So |
. It \&Va Ta Yes Ta Yes Ta n |
.It \&.Fc Ta Yes Ta Yes Ta opened by \&.Fo |
. It \&Vt Ta Yes Ta Yes Ta >0 |
.It \&.Fo Ta \&No Ta \&No Ta closed by \&.Fc |
. It \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&.Ec Ta Yes Ta Yes Ta opened by \&.Eo |
. It \&br Ta \&No Ta \&No Ta 0 |
.It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec |
. It \&sp Ta \&No Ta \&No Ta 1 |
.It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo |
. El |
.It \&.Qo Ta Yes Ta Yes Ta closed by \&.Oc |
. |
.El |
. |
.\" SUB-SECTION |
.Sh COMPATIBILITY |
.Ss General |
This section documents compatibility with other roff implementations, at |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX |
this time limited to |
.It Em Macro Ta Em Callable Ta Em Parsable |
. Xr groff 1 . |
.It \&.Dd Ta \& Ta \& |
The term |
.It \&.Dt Ta \& Ta \& |
. Qq historic groff |
.It \&.Os Ta \& Ta \& |
refers to those versions before the |
.It \&.Pp Ta \& Ta \& |
. Pa doc.tmac |
.It \&.D1 Ta \& Ta \& |
file re-write |
.It \&.Dl Ta \& Ta Yes |
. Pq somewhere between 1.15 and 1.19 . |
.It \&.Ad Ta Yes Ta Yes |
. Pp |
.It \&.An Ta \& Ta Yes |
. Bl -dash -compact |
.It \&.Ar Ta Yes Ta Yes |
. It |
.It \&.Cd Ta Yes Ta \& |
The |
.It \&.Cm Ta Yes Ta Yes |
. Sq \-split |
.It \&.Dv Ta Yes Ta Yes |
or |
.It \&.Er Ta Yes Ta Yes |
. Sq \-nosplit |
.It \&.Ev Ta Yes Ta Yes |
argument to |
.It \&.Ex Ta \& Ta \& |
. Sq \&An |
.It \&.Fa Ta Yes Ta Yes |
applies to the whole document, not just to the current section as it |
.It \&.Fd Ta \& Ta \& |
does in groff. |
.It \&.Fl Ta Yes Ta Yes |
. It |
.It \&.Fn Ta Yes Ta Yes |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
.It \&.Ft Ta \& Ta \& |
standalone double-quote in formatted output. This idiosyncratic |
.It \&.Ic Ta Yes Ta Yes |
behaviour is no longer applicable. |
.It \&.In Ta \& Ta \& |
. It |
.It \&.Li Ta Yes Ta Yes |
The |
.It \&.Nd Ta \& Ta \& |
. Sq \&sp |
.It \&.Nm Ta Yes Ta Yes |
macro does not accept negative numbers. |
.It \&.Ot Ta \& Ta \& |
. It |
.It \&.Pa Ta Yes Ta Yes |
Blocks of whitespace are stripped from both macro and free-form text |
.It \&.Rv Ta \& Ta \& |
lines (except when in literal mode), while groff would retain whitespace |
.It \&.St Ta Yes Ta \& |
in free-form text lines. |
.It \&.Va Ta Yes Ta Yes |
. It |
.It \&.Vt Ta Yes Ta Yes |
Historic groff has many un-callable macros. Most of these (excluding |
.It \&.Xr Ta Yes Ta Yes |
some block-level macros) are now callable, conforming to the |
.It \&.%A Ta \& Ta \& |
non-historic groff version. |
.It \&.%B Ta \& Ta \& |
. It |
.It \&.%C Ta \& Ta \& |
The vertical bar |
.It \&.%D Ta \& Ta \& |
. Sq \(ba |
.It \&.%I Ta \& Ta \& |
made historic groff |
.It \&.%J Ta \& Ta \& |
. Qq go orbital |
.It \&.%N Ta \& Ta \& |
but is a proper delimiter in this implementation. |
.It \&.%O Ta \& Ta \& |
. It |
.It \&.%P Ta \& Ta \& |
. Sq \&It \-nested |
.It \&.%R Ta \& Ta \& |
is assumed for all lists (it wasn't in historic groff): any list may be |
.It \&.%T Ta \& Ta \& |
nested and |
.It \&.%V Ta \& Ta \& |
. Sq \-enum |
.It \&.At Ta Yes Ta Yes |
lists will restart the sequence only for the sub-list. |
.It \&.Bsx Ta Yes Ta Yes |
. It |
.It \&.Bx Ta Yes Ta Yes |
. Sq \&It \-column |
.It \&.Db Ta \& Ta \& |
syntax where column widths may be preceded by other arguments (instead |
.It \&.Em Ta Yes Ta Yes |
of proceeded) is not supported. |
.It \&.Fx Ta Yes Ta Yes |
. It |
.It \&.Ms Ta \& Ta Yes |
The |
.It \&.No Ta Yes Ta Yes |
. Sq \&At |
.It \&.Ns Ta Yes Ta Yes |
macro only accepts a single parameter. |
.It \&.Nx Ta Yes Ta Yes |
. It |
.It \&.Ox Ta Yes Ta Yes |
Some manuals use |
.It \&.Pf Ta \& Ta Yes |
. Sq \&Li |
.It \&.Ql Ta Yes Ta Yes |
incorrectly by following it with a reserved character and expecting the |
.It \&.Re Ta \& Ta \& |
delimiter to render. This is not supported. |
.It \&.Rs Ta \& Ta \& |
. It |
.It \&.Sm Ta \& Ta \& |
In groff, the |
.It \&.Sx Ta Yes Ta Yes |
. Sq \&Fo |
.It \&.Sy Ta Yes Ta Yes |
macro only produces the first parameter. This is no longer the case. |
.It \&.Tn Ta Yes Ta Yes |
. El |
.It \&.Ux Ta Yes Ta Yes |
. |
.It \&.Bk Ta \& Ta \& |
. |
.It \&.Ek Ta \& Ta \& |
.Sh SEE ALSO |
.It \&.Bt Ta \& Ta \& |
. Xr mandoc 1 , |
.It \&.Hf Ta \& Ta \& |
. Xr mandoc_char 7 |
.It \&.Fr Ta \& Ta \& |
. |
.It \&.Ud Ta \& Ta \& |
. |
.It \&.Lb Ta \& Ta \& |
.Sh AUTHORS |
.It \&.Ap Ta Yes Ta Yes |
The |
.It \&.Lp Ta \& Ta \& |
. Nm |
.It \&.Lk Ta \& Ta Yes |
reference was written by |
.It \&.Mt Ta \& Ta Yes |
. An Kristaps Dzonsons Aq kristaps@kth.se . |
.El |
. |
|
. |
|
.Sh CAVEATS |
|
There are many ambiguous parts of mdoc. |
|
. Pp |
|
. Bl -dash -compact |
|
. It |
|
. Sq \&Fa |
|
should be |
|
. Sq \&Va |
|
as function arguments are variables. |
|
. 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 . |
|
. It |
|
. Sq \&Va |
|
should formalise that only one or two arguments are acceptable: a |
|
variable name and optional, preceding type. |
|
. It |
|
. Sq \&Fd |
|
is ambiguous. It's commonly used to indicate an include file in the |
|
synopsis section. |
|
. Sq \&In |
|
should be used, instead. |
|
. It |
|
Only the |
|
. Sq \-literal |
|
argument to |
|
. Sq \&Bd |
|
makes sense. The remaining ones should be removed. |
|
. It |
|
The |
|
. Sq \&Xo |
|
and |
|
. Sq \&Xc |
|
macros should be deprecated. |
|
. It |
|
The |
|
. Sq \&Dt |
|
macro lacks clarity. It should be absolutely clear which title will |
|
render when formatting the manual page. |
|
. It |
|
A |
|
. Sq \&Lx |
|
should be provided for Linux (\(`a la |
|
. Sq \&Ox , |
|
. Sq \&Nx |
|
etc.). |
|
. It |
|
There's no way to refer to references in |
|
. Sq \&Rs/Re |
|
blocks. |
|
. It |
|
The \-split and \-nosplit dictates via |
|
. Sq \&An |
|
are re-set when entering and leaving the AUTHORS section. |
|
. El |
|
. |