version 1.30, 2009/06/17 14:08:47 |
version 1.56, 2009/08/18 14:27:16 |
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" OR IN CONNECTION WITH THE USE OR 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 language 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. In this reference document, we describe the syntax, ontology |
manuals. In this reference document, we describe its syntax, structure, |
and structure of the |
and usage. Our reference implementation is |
.Nm |
. Xr mandoc 1 . |
language. Our reference implementation is |
|
.Xr mandoc 1 . |
|
The |
The |
.Sx COMPATIBILITY |
. Sx COMPATIBILITY |
section describes compatibility with |
section describes compatibility with |
.Xr groff 1 . |
. Xr groff 1 . |
.\" PARAGRAPH |
. Pp |
.Pp |
|
An |
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: |
prior macros: |
.Bd -literal -offset XXX |
. Bd -literal -offset indent |
\&.Sh Macro lines change control state. |
\&.Sh Macro lines change control state. |
Other lines are interpreted within the current state. |
Other lines are interpreted within the current state. |
.Ed |
. Ed |
.\" SECTION |
. |
.Sh INPUT ENCODING |
. |
.Nm |
.Sh LANGUAGE SYNTAX |
|
. Nm |
documents may contain only graphable 7-bit ASCII 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 |
. |
.Sq \en |
. |
line termination. |
. Ss Comments |
.Pp |
Text following a |
The only time a blank line is acceptable is within |
. Sq \e" , |
the context of |
whether in a macro or free-form text line, is ignored to the end of |
.Sq \&.Bd \-literal |
line. A macro line with only a control character and comment escape, |
or |
. Sq \&.\e" , |
.Sq \&.Bd \-unfilled . |
is also ignored. |
.Pp |
. |
Tab characters |
. |
.Pq \et |
. Ss Reserved Characters |
are only acceptable when delimiting |
|
.Sq \&.Bl \-column |
|
and in |
|
.Sq \&.Bd \-literal |
|
or |
|
.Sq \&.Bd \-unfilled |
|
contexts. |
|
.\" SUB-SECTION |
|
.Ss Comments |
|
Anything following a |
|
.Sq \e" |
|
delimiter is considered a comment (unless the |
|
.Sq \e |
|
itself has been escaped) and is ignored to the end of line. |
|
Furthermore, a macro line with only a control character |
|
.Sq \. , |
|
optionally followed by whitespace, is ignored. |
|
.\" SUB-SECTION |
|
.Ss Reserved Characters |
|
Within a macro line, the following characters are reserved: |
Within a macro line, the following characters are reserved: |
.Bl -tag -width Ds -offset XXXX -compact |
. Bl -tag -width Ds -offset indent -compact |
.It \&. |
. It \&. |
.Pq period |
. Pq period |
.It \&, |
. It \&, |
.Pq comma |
. Pq comma |
.It \&: |
. It \&: |
.Pq colon |
. Pq colon |
.It \&; |
. It \&; |
.Pq semicolon |
. Pq semicolon |
.It \&( |
. It \&( |
.Pq left-parenthesis |
. Pq left-parenthesis |
.It \&) |
. It \&) |
.Pq right-parenthesis |
. Pq right-parenthesis |
.It \&[ |
. It \&[ |
.Pq left-bracket |
. Pq left-bracket |
.It \&] |
. It \&] |
.Pq right-bracket |
. Pq right-bracket |
.It \&? |
. It \&? |
.Pq question |
. Pq question |
.It \&! |
. It \&! |
.Pq exclamation |
. Pq exclamation |
.It \&| |
. It \&| |
.Pq vertical bar |
. Pq vertical bar |
.El |
. El |
.\" PARAGRAPH |
. Pp |
.Pp |
|
Use of reserved characters is described in |
Use of reserved characters is described in |
.Sx Closure . |
. Sx MACRO SYNTAX . |
For general non-reserved use, characters must either be escaped with a |
For general use in macro lines, these characters must either be escaped |
non-breaking space |
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 |
. |
.Ss Special Characters |
. |
Special character sequences begin with the escape character |
. Ss Special Characters |
.Sq \e |
Special characters may occur in both macro and free-form lines. |
followed by either an open-parenthesis |
Sequences begin with the escape character |
.Sq \&( |
. 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 \e* , |
. Sq \e(em |
with the same combinations as described above. This form is deprecated. |
. Pq em-dash |
.\" SECTION |
and |
.Sh STRUCTURE |
. Sq \ee |
Macros are classified in an ontology described by their scope rules. |
. Pq back-slash . |
Some macros are allowed to deviate from their classifications to |
. |
preserve backward-compatibility with old macro combinations still found |
. |
in the manual corpus. These are specifically noted on a per-macro |
. Ss Text Decoration |
basis. |
Terms may be text-decorated using the |
.\" SUB-SECTION |
. Sq \ef |
.Ss Scope |
escape followed by an indicator: B (bold), I, (italic), or P and R |
.Bl -inset |
(Roman, or reset). This form is not recommended for |
.\" LIST-ITEM |
. Nm , |
.It Em Block |
which encourages semantic, not presentation, annotation. |
macros enclose other block macros, in-line macros or text, and |
. |
may span multiple lines. |
. |
.Bl -inset -offset XXXX |
. Ss Predefined Strings |
.\" LIST-ITEM |
Historically, |
.It Em Full-block |
. Xr groff 1 |
macros always span multiple lines. They consist of zero or |
also defined a set of package-specific |
more |
. Dq predefined strings , |
.Qq heads , |
which, like |
subsequent macros or text on the same line following invocation; an |
. Sx Special Characters , |
optional |
demark special output characters and strings by way of input codes. |
.Qq body , |
Predefined strings are escaped with the slash-asterisk, |
which spans subsequent lines of text or macros; and an optional |
. Sq \e* : |
.Qq tail , |
single-character |
macros or text on the same line following closure. |
. Sq \e*X , |
.\" LIST-ITEM |
two-character |
.It Em Partial-block |
. Sq \e*(XX , |
macros may span multiple lines. They consists of a optional |
and N-character |
.Qq head , |
. Sq \e*[N] . |
text immediately following invocation; always a |
See |
.Qq body , |
. Xr mandoc_char 7 |
text or macros following the head on the same and subsequent lines; and |
for a complete list. Examples include |
optionally a |
. Sq \e*(Am |
.Qq tail , |
. Pq ampersand |
text immediately following closure. |
and |
.\" LIST-ITEM |
. Sq \e*(Ba |
.It Em In-line |
. Pq vertical bar . |
macros may only enclose text and span at most a single line. |
. |
.El |
. |
.El |
. Ss Whitespace |
.\" SUB-SECTION |
In non-literal free-form lines, consecutive blocks of whitespace are |
.Ss Closure |
pruned from input and added later in the output filter, if applicable: |
Closure of a macro's scope depends first on its classification, then |
. Bd -literal -offset indent |
on whether it's parsable. In this table, |
These spaces are pruned from input. |
.Sq BFE |
\&.Bd \-literal |
refers to block full-explicit and so on. |
These are not. |
.\" PARAGRAPH |
\&.Ed |
.Pp |
. Ed |
.Bl -tag -width 12n -offset XXXX -compact |
. Pp |
.It BPE , BFE |
In macro lines, whitespace delimits arguments and is discarded. If |
corresponding explicit closure macro |
arguments are quoted, whitespace within the quotes is retained. |
.It BFI |
. Pp |
end-of-file or a corresponding implicit closure macro |
Blank lines are only permitted within literal contexts, as are lines |
.It BPI |
containing only whitespace. Tab characters are only acceptable when |
end-of-line (body may be closed by >0 space-separated |
delimiting |
.Sx Reserved Characters , |
. Sq \&Bl \-column |
although block scope will still be open) |
or when in a literal context. |
.It INL |
. |
end-of-line |
. |
.El |
. Ss Quotation |
.\" PARAGRAPH |
Macro arguments may be quoted with a double-quote to group |
.Pp |
space-delimited terms or to retain blocks of whitespace. A quoted |
If a macro (block or in-line) is parsable, it may also be closed out by |
argument begins with a double-quote preceded by whitespace. The next |
one of the following scenarios (unless specifically noted otherwise): |
double-quote not pair-wise adjacent to another double-quote terminates |
.\" PARAGRAPH |
the literal, regardless of surrounding whitespace. |
.Pp |
. Pp |
.Bl -dash -offset XXXX -compact |
This produces tokens |
.It |
. Sq a" , |
a sequence of >0 space-separated |
. Sq b c , |
.Sx Reserved Characters , |
. Sq de , |
.It |
and |
another macro, |
. Sq fg" . |
.It |
Note that any quoted term, be it argument or macro, is indiscriminately |
end-of-line, or |
considered literal text. Thus, the following produces |
.It |
. Sq \&Em a : |
completion of a set number of arguments. |
. Bd -literal -offset indent |
.El |
\&.Em "Em a" |
.\" PARAGRAPH |
. Ed |
.Pp |
. Pp |
If >0 space-separated |
In free-form mode, quotes are regarded as opaque text. |
.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: |
.Sh MANUAL STRUCTURE |
subsequent tokens are interpreted as if the scope had just been opened. |
Each |
In other circumstances, scope is simply closed out. |
. Nm |
.\" SECTION |
document must begin with a document prologue, containing, in order, |
.Sh SYNTAX |
. Sq \&Dd , |
Macros are two or three characters in length. The syntax of macro |
. Sq \&Dt , |
invocation depends on its classification. |
and |
.Qq \-arg |
. Sq \&Os , |
refers to the macro arguments (which may contain zero or more values). |
then the NAME section containing at least one |
In these illustrations, |
. Sq \&Nm |
.Sq \&.Yo |
followed by |
opens the scope of a macro, and if specified, |
. Sq \&Nd : |
.Sq \&.Yc |
. Bd -literal -offset indent |
closes it out (closure may be implicit at end-of-line or end-of-file). |
\&.Dd $\&Mdocdate$ |
.\" PARAGRAPH |
\&.Dt mdoc 7 |
.Pp |
\&.Os |
Block full-explicit (may contain head, body, tail). |
\&.Sh NAME |
.Bd -literal -offset XXXX |
\&.Nm mdoc |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
\&.Nd mdoc language reference |
\(lBbody...\(rB |
. Ed |
\&.Yc \(lBtail...\(rB |
. Pp |
.Ed |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
.\" PARAGRAPH |
but non-compulsory. |
.Pp |
. |
Block full-implicit (may contain zero or more heads, body, no tail). |
. |
.Bd -literal -offset XXXX |
.Sh MACRO SYNTAX |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
Macros are one to three three characters in length and begin with a |
\(lBbody...\(rB |
control character , |
|
. Sq \&. , |
|
at the beginning of the line. An arbitrary amount of whitespace may |
|
sit between the control character and the macro name. Thus, |
|
. Sq \&.Pp |
|
and |
|
. Sq \&.\ \ \ \&Pp |
|
are equivalent. Macro names are two or three characters in length. |
|
. Pp |
|
The syntax of a macro depends on its classification. In this section, |
|
. Sq \-arg |
|
refers to macro arguments, which may be followed by zero or more |
|
. Sq parm |
|
parameters; |
|
. Sq \&Yo |
|
opens the scope of a macro; and if specified, |
|
. Sq \&Yc |
|
closes it out. |
|
. Pp |
|
The |
|
. Em Callable |
|
column indicates that the macro may be called subsequent to the initial |
|
line-macro. If a macro is not callable, then its invocation after the |
|
initial line macro is interpreted as opaque text, such that |
|
. Sq \&.Fl Sh |
|
produces |
|
. Sq Fl Sh . |
|
. Pp |
|
The |
|
. Em Parsable |
|
column indicates whether the macro may be followed by further |
|
(ostensibly callable) macros. If a macro is not parsable, subsequent |
|
macro invocations on the line will be interpreted as opaque text. |
|
. Pp |
|
The |
|
. Em Scope |
|
column, if applicable, describes closure rules. |
|
. |
|
. |
|
. 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 |
\&.Yc |
.Ed |
. Ed |
.\" PARAGRAPH |
. Pp |
.Pp |
. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
Block partial-explicit (may contain head, multi-line body, tail). |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.Bd -literal -offset XXXX |
. It \&Bd Ta \&No Ta \&No Ta closed by \&Ed |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
. It \&Bf Ta \&No Ta \&No Ta closed by \&Ef |
\(lBbody...\(rB |
. It \&Bk Ta \&No Ta \&No Ta closed by \&Ek |
\&.Yc \(lBtail...\(rB |
. It \&Bl Ta \&No Ta \&No Ta closed by \&El |
|
. It \&Ed Ta \&No Ta \&No Ta opened by \&Bd |
|
. It \&Ef Ta \&No Ta \&No Ta opened by \&Bf |
|
. It \&Ek Ta \&No Ta \&No Ta opened by \&Bk |
|
. It \&El Ta \&No Ta \&No Ta opened by \&Bl |
|
. El |
|
. |
|
. |
|
. Ss Block full-implicit |
|
Multi-line scope closed by end-of-file or implicitly by another macro. |
|
All macros have bodies; some |
|
. Po |
|
. Sq \&It \-bullet , |
|
. Sq \-hyphen , |
|
. Sq \-dash , |
|
. Sq \-enum , |
|
. Sq \-item |
|
. Pc |
|
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 |
|
. Pp |
|
. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
|
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
|
. It \&It Ta \&No Ta Yes Ta closed by \&It, \&El |
|
. It \&Nd Ta \&No Ta \&No Ta closed by \&Sh |
|
. It \&Sh Ta \&No Ta \&No Ta closed by \&Sh |
|
. It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss |
|
. El |
|
. |
|
. |
|
. Ss Block partial-explicit |
|
Like block full-explicit, but also with single-line scope. Each |
|
has at least a body and, in limited circumstances, a head |
|
. Pq So \&Fo Sc , So \&Eo Sc |
|
and/or tail |
|
. Pq So \&Ec Sc . |
|
. Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc \(lBtail...\(rB |
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \ |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ |
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
.Ed |
. Ed |
.\" PARAGRAPH |
. Pp |
.Pp |
. Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent |
Block partial-implicit (no head, body, no tail). Note that the body |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
section may be followed by zero or more |
. It \&Ac Ta Yes Ta Yes Ta opened by \&Ao |
.Sx Reserved Words . |
. It \&Ao Ta Yes Ta Yes Ta closed by \&Ac |
These are in the block scope, but not in the body scope. |
. It \&Bc Ta Yes Ta Yes Ta closed by \&Bo |
.Bd -literal -offset XXXX |
. It \&Bo Ta Yes Ta Yes Ta opened by \&Bc |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB |
. It \&Brc Ta Yes Ta Yes Ta opened by \&Bro |
.Ed |
. It \&Bro Ta Yes Ta Yes Ta closed by \&Brc |
.\" PARAGRAPH |
. It \&Dc Ta Yes Ta Yes Ta opened by \&Do |
.Pp |
. It \&Do Ta Yes Ta Yes Ta closed by \&Dc |
In-lines have \(>=0 scoped arguments. |
. It \&Ec Ta Yes Ta Yes Ta opened by \&Eo |
.Bd -literal -offset XXX |
. It \&Eo Ta Yes Ta Yes Ta closed by \&Ec |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB |
. It \&Fc Ta Yes Ta Yes Ta opened by \&Fo |
|
. It \&Fo Ta \&No Ta \&No Ta closed by \&Fc |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
. It \&Oc Ta Yes Ta Yes Ta closed by \&Oo |
.Ed |
. It \&Oo Ta Yes Ta Yes Ta opened by \&Oc |
.\" |
. It \&Pc Ta Yes Ta Yes Ta closed by \&Po |
.Sh MACROS |
. It \&Po Ta Yes Ta Yes Ta opened by \&Pc |
This section contains a complete list of all |
. It \&Qc Ta Yes Ta Yes Ta opened by \&Oo |
.Nm |
. It \&Qo Ta Yes Ta Yes Ta closed by \&Oc |
macros, arranged ontologically. A |
. It \&Re Ta \&No Ta \&No Ta opened by \&Rs |
.Qq callable |
. It \&Rs Ta \&No Ta \&No Ta closed by \&Re |
macro is invoked subsequent to the initial macro-line macro. A |
. It \&Sc Ta Yes Ta Yes Ta opened by \&So |
.Qq parsable |
. It \&So Ta Yes Ta Yes Ta closed by \&Sc |
macro may be followed by further (ostensibly callable) macros. |
. It \&Xc Ta Yes Ta Yes Ta opened by \&Xo |
.\" SUB-SECTION |
. It \&Xo Ta Yes Ta Yes Ta closed by \&Xc |
.Ss Block full-implicit |
. El |
The head of these macros follows invocation; the body is the content of |
. |
subsequent lines prior to closure. None of these macros have tails; |
. |
some |
. Ss Block partial-implicit |
.Po |
Like block full-implicit, but with single-line scope closed by |
.Sq \&.It \-bullet , |
. Sx Reserved Characters |
.Sq \-hyphen , |
or end of line. |
.Sq \-dash , |
. Bd -literal -offset indent |
.Sq \-enum , |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
.Sq \-item |
. Ed |
.Pc |
. Pp |
don't have heads. |
. Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
.Pp |
. It Em Macro Ta Em Callable Ta Em Parsable |
.Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "Closing" |
. It \&Aq Ta Yes Ta Yes |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing |
. It \&Bq Ta Yes Ta Yes |
.It \&.Sh Ta \&No Ta \&No Ta \&.Sh |
. It \&Brq Ta Yes Ta Yes |
.It \&.Ss Ta \&No Ta \&No Ta \&.Sh, \&.Ss |
. It \&D1 Ta \&No Ta \&Yes |
.It \&.It Ta \&No Ta Yes Ta \&.It, \&.El |
. It \&Dl Ta \&No Ta Yes |
.El |
. It \&Dq Ta Yes Ta Yes |
.\" SUB-SECTION |
. It \&Op Ta Yes Ta Yes |
.Ss Block full-explicit |
. It \&Pq Ta Yes Ta Yes |
None of these macros are callable or parsed. The last column indicates |
. It \&Ql Ta Yes Ta Yes |
the explicit scope rules. All contains bodies, some may contain heads |
. It \&Qq Ta Yes Ta Yes |
.Pq So \&Bf Sc . |
. It \&Sq Ta Yes Ta Yes |
.Pp |
. El |
.Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "closed by XXX" |
. |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
. |
.It \&.Bd Ta \&No Ta \&No Ta closed by \&.Ed |
. Ss In-line |
.It \&.Ed Ta \&No Ta \&No Ta opened by \&.Bd |
Closed by |
.It \&.Bl Ta \&No Ta \&No Ta closed by \&.El |
. Sx Reserved Characters , |
.It \&.El Ta \&No Ta \&No Ta opened by \&.Bl |
end of line, fixed argument lengths, and/or subsequent macros. In-line |
.It \&.Bf Ta \&No Ta \&No Ta closed by \&.Ef |
macros have only text children. If a number (or inequality) of |
.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 |
|
.\" 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 |
|
.It \&.D1 Ta \&No Ta \&Yes |
|
.It \&.Dl Ta \&No Ta Yes |
|
.It \&.Ql Ta Yes Ta Yes |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
The |
|
.Sq \&.Op |
|
may be broken by |
|
.Sq \&.Oc |
|
as in the following example: |
|
.Bd -literal -offset XXXX |
|
\&.Oo |
|
\&.Op Fl a Oc |
|
.Ed |
|
.Pp |
|
In the above example, the scope of |
|
.Sq \&.Op |
|
is technically broken by |
|
.Sq \&.Oc , |
|
however, due to the overwhelming existence of this sequence, it's |
|
allowed. |
|
.\" SUB-SECTION |
|
.Ss Block partial-explicit |
|
Each of these contains at least a body and, in limited circumstances, a |
|
head |
|
.Pq So \&.Fo Sc , So \&.Eo Sc |
|
and/or tail |
|
.Pq So \&.Ec Sc . |
|
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX |
|
.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 \&.Bc Ta Yes Ta Yes Ta closed by \&.Bo |
|
.It \&.Bo Ta Yes Ta Yes Ta opened by \&.Bc |
|
.It \&.Pc Ta Yes Ta Yes Ta closed by \&.Po |
|
.It \&.Po Ta Yes Ta Yes Ta opened by \&.Pc |
|
.It \&.Do Ta Yes Ta Yes Ta closed by \&.Dc |
|
.It \&.Dc Ta Yes Ta Yes Ta opened by \&.Do |
|
.It \&.Xo Ta Yes Ta Yes Ta closed by \&.Xc |
|
.It \&.Xc Ta Yes Ta Yes Ta opened by \&.Xo |
|
.It \&.Bro Ta Yes Ta Yes Ta closed by \&.Brc |
|
.It \&.Brc Ta Yes Ta Yes Ta opened by \&.Bro |
|
.It \&.Oc Ta Yes Ta Yes Ta closed by \&.Oo |
|
.It \&.Oo Ta Yes Ta Yes Ta opened by \&.Oc |
|
.It \&.So Ta Yes Ta Yes Ta closed by \&.Sc |
|
.It \&.Sc Ta Yes Ta Yes Ta opened by \&.So |
|
.It \&.Fc Ta Yes Ta Yes Ta opened by \&.Fo |
|
.It \&.Fo Ta \&No Ta \&No Ta closed by \&.Fc |
|
.It \&.Ec Ta Yes Ta Yes Ta opened by \&.Eo |
|
.It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec |
|
.It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo |
|
.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 |
|
.\" SUB-SECTION |
|
.Ss In-line |
|
In-line macros have only text children. If a number (or inequality) of |
|
arguments is |
arguments is |
.Pq n , |
. Pq n , |
then the macro accepts an arbitrary number of arguments. |
then the macro accepts an arbitrary number of arguments. |
.Pp |
. Bd -literal -offset indent |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
|
.It \&.Dd Ta \&No Ta \&No Ta >0 |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
.It \&.Dt Ta \&No Ta \&No Ta n |
|
.It \&.Os Ta \&No Ta \&No Ta n |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
.It \&.Pp Ta \&No Ta \&No Ta 0 |
. Ed |
.It \&.Ad Ta Yes Ta Yes Ta n |
. Pp |
.It \&.An Ta Yes Ta Yes Ta n |
. Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent |
.It \&.Ar Ta Yes Ta Yes Ta n |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It \&.Cd Ta Yes Ta \&No Ta >0 |
. It \&%A Ta \&No Ta \&No Ta >0 |
.It \&.Cm Ta Yes Ta Yes Ta n |
. It \&%B Ta \&No Ta \&No Ta >0 |
.It \&.Dv Ta Yes Ta Yes Ta n |
. It \&%C Ta \&No Ta \&No Ta >0 |
.It \&.Er Ta Yes Ta Yes Ta >0 |
. It \&%D Ta \&No Ta \&No Ta >0 |
.It \&.Ev Ta Yes Ta Yes Ta n |
. It \&%I Ta \&No Ta \&No Ta >0 |
.It \&.Ex Ta \&No Ta \&No Ta 0 |
. It \&%J Ta \&No Ta \&No Ta >0 |
.It \&.Fa Ta Yes Ta Yes Ta n |
. It \&%N Ta \&No Ta \&No Ta >0 |
.It \&.Fd Ta \&No Ta \&No Ta >0 |
. It \&%O Ta \&No Ta \&No Ta >0 |
.It \&.Fl Ta Yes Ta Yes Ta n |
. It \&%P Ta \&No Ta \&No Ta >0 |
.It \&.Fn Ta Yes Ta Yes Ta >0 |
. It \&%R Ta \&No Ta \&No Ta >0 |
.It \&.Ft Ta Yes Ta Yes Ta n |
. It \&%T Ta \&No Ta \&No Ta >0 |
.It \&.Ic Ta Yes Ta Yes Ta >0 |
. It \&%V Ta \&No Ta \&No Ta >0 |
.It \&.In Ta \&No Ta \&No Ta n |
. It \&Ad Ta Yes Ta Yes Ta n |
.It \&.Li Ta Yes Ta Yes Ta n |
. It \&An Ta Yes Ta Yes Ta n |
.It \&.Nd Ta \&No Ta \&No Ta n |
. It \&Ap Ta Yes Ta Yes Ta 0 |
.It \&.Nm Ta Yes Ta Yes Ta n |
. It \&Ar Ta Yes Ta Yes Ta n |
.It \&.Ot Ta \&No Ta \&No Ta n |
. It \&At Ta Yes Ta Yes Ta 1 |
.It \&.Pa Ta Yes Ta Yes Ta n |
. It \&Bsx Ta Yes Ta Yes Ta n |
.It \&.Rv Ta \&No Ta \&No Ta 0 |
. It \&Bt Ta \&No Ta \&No Ta 0 |
.It \&.St Ta \&No Ta Yes Ta 1 |
. It \&Bx Ta Yes Ta Yes Ta n |
.It \&.Va Ta Yes Ta Yes Ta n |
. It \&Cd Ta Yes Ta Yes Ta >0 |
.It \&.Vt Ta Yes Ta Yes Ta >0 |
. It \&Cm Ta Yes Ta Yes Ta n |
.It \&.Xr Ta Yes Ta Yes Ta >0, <3 |
. It \&Db Ta \&No Ta \&No Ta 1 |
.It \&.%A Ta \&No Ta \&No Ta >0 |
. It \&Dd Ta \&No Ta \&No Ta >0 |
.It \&.%B Ta \&No Ta \&No Ta >0 |
. It \&Dt Ta \&No Ta \&No Ta n |
.It \&.%C Ta \&No Ta \&No Ta >0 |
. It \&Dv Ta Yes Ta Yes Ta n |
.It \&.%D Ta \&No Ta \&No Ta >0 |
. It \&Dx Ta Yes Ta Yes Ta n |
.It \&.%I Ta \&No Ta \&No Ta >0 |
. It \&Em Ta Yes Ta Yes Ta >0 |
.It \&.%J Ta \&No Ta \&No Ta >0 |
. It \&En Ta \&No Ta \&No Ta 0 |
.It \&.%N Ta \&No Ta \&No Ta >0 |
. It \&Er Ta Yes Ta Yes Ta >0 |
.It \&.%O Ta \&No Ta \&No Ta >0 |
. It \&Es Ta \&No Ta \&No Ta 0 |
.It \&.%P Ta \&No Ta \&No Ta >0 |
. It \&Ev Ta Yes Ta Yes Ta n |
.It \&.%R Ta \&No Ta \&No Ta >0 |
. It \&Ex Ta \&No Ta \&No Ta 0 |
.It \&.%T Ta \&No Ta \&No Ta >0 |
. It \&Fa Ta Yes Ta Yes Ta n |
.It \&.%V Ta \&No Ta \&No Ta >0 |
. It \&Fd Ta \&No Ta \&No Ta >0 |
.It \&.At Ta Yes Ta Yes Ta 1 |
. It \&Fl Ta Yes Ta Yes Ta n |
.It \&.Bsx Ta Yes Ta Yes Ta n |
. It \&Fn Ta Yes Ta Yes Ta >0 |
.It \&.Bx Ta Yes Ta Yes Ta n |
. It \&Fr Ta \&No Ta \&No Ta n |
.It \&.Db Ta \&No Ta \&No Ta 1 |
. It \&Ft Ta Yes Ta Yes Ta n |
.It \&.Em Ta Yes Ta Yes Ta >0 |
. It \&Fx Ta Yes Ta Yes Ta n |
.It \&.Fx Ta Yes Ta Yes Ta n |
. It \&Hf Ta \&No Ta \&No Ta n |
.It \&.Ms Ta Yes Ta Yes Ta >0 |
. It \&Ic Ta Yes Ta Yes Ta >0 |
.It \&.No Ta Yes Ta Yes Ta 0 |
. It \&In Ta \&No Ta \&No Ta n |
.It \&.Ns Ta Yes Ta Yes Ta 0 |
. It \&Lb Ta \&No Ta \&No Ta 1 |
.It \&.Nx Ta Yes Ta Yes Ta n |
. It \&Li Ta Yes Ta Yes Ta n |
.It \&.Ox Ta Yes Ta Yes Ta n |
. It \&Lk Ta Yes Ta Yes Ta n |
.It \&.Pf Ta \&No Ta Yes Ta 1 |
. It \&Lp Ta \&No Ta \&No Ta 0 |
.It \&.Sm Ta \&No Ta \&No Ta 1 |
. It \&Ms Ta Yes Ta Yes Ta >0 |
.It \&.Sx Ta Yes Ta Yes Ta >0 |
. It \&Mt Ta Yes Ta Yes Ta >0 |
.It \&.Sy Ta Yes Ta Yes Ta >0 |
. It \&Nm Ta Yes Ta Yes Ta n |
.It \&.Tn Ta Yes Ta Yes Ta >0 |
. It \&No Ta Yes Ta Yes Ta 0 |
.It \&.Ux Ta Yes Ta Yes Ta n |
. It \&Ns Ta Yes Ta Yes Ta 0 |
.It \&.Dx Ta Yes Ta Yes Ta n |
. It \&Nx Ta Yes Ta Yes Ta n |
.It \&.Bt Ta \&No Ta \&No Ta 0 |
. It \&Os Ta \&No Ta \&No Ta n |
.It \&.Hf Ta \&No Ta \&No Ta n |
. It \&Ot Ta \&No Ta \&No Ta n |
.It \&.Fr Ta \&No Ta \&No Ta n |
. It \&Ox Ta Yes Ta Yes Ta n |
.It \&.Ud Ta \&No Ta \&No Ta 0 |
. It \&Pa Ta Yes Ta Yes Ta n |
.It \&.Lb Ta \&No Ta \&No Ta 1 |
. It \&Pf Ta \&No Ta Yes Ta 1 |
.It \&.Ap Ta Yes Ta Yes Ta 0 |
. It \&Pp Ta \&No Ta \&No Ta 0 |
.It \&.Lp Ta \&No Ta \&No Ta 0 |
. It \&Rv Ta \&No Ta \&No Ta 0 |
.It \&.Lk Ta Yes Ta Yes Ta n |
. It \&Sm Ta \&No Ta \&No Ta 1 |
.It \&.Mt Ta Yes Ta Yes Ta >0 |
. It \&St Ta \&No Ta Yes Ta 1 |
.It \&.Es Ta \&No Ta \&No Ta 0 |
. It \&Sx Ta Yes Ta Yes Ta >0 |
.It \&.En Ta \&No Ta \&No Ta 0 |
. It \&Sy Ta Yes Ta Yes Ta >0 |
.El |
. It \&Tn Ta Yes Ta Yes Ta >0 |
.Pp |
. It \&Ud Ta \&No Ta \&No Ta 0 |
The |
. It \&Ux Ta Yes Ta Yes Ta n |
.Sq \&.Ot , |
. It \&Va Ta Yes Ta Yes Ta n |
.Sq \&.Fr , |
. It \&Vt Ta Yes Ta Yes Ta >0 |
.Sq \&.Es |
. It \&Xr Ta Yes Ta Yes Ta >0, <3 |
and |
. It \&br Ta \&No Ta \&No Ta 0 |
.Sq \&.En , |
. It \&sp Ta \&No Ta \&No Ta 1 |
macros are obsolete. |
. El |
.\" SECTION |
. |
|
. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility with other roff implementations, at |
This section documents compatibility with other roff implementations, at |
this time limited to |
this time limited to |
.Xr groff 1 . |
. Xr groff 1 . |
The term |
The term |
.Qq historic groff |
. Qq historic groff |
refers to those versions before the |
refers to those versions before the |
.Pa doc.tmac |
. Pa doc.tmac |
file re-write |
file re-write |
.Pq somewhere between 1.15 and 1.19 . |
. Pq somewhere between 1.15 and 1.19 . |
.Pp |
. Pp |
.Bl -dash -compact |
. Bl -dash -compact |
.\" LIST-ITEM |
. It |
.It |
The |
|
. Sq \-split |
|
or |
|
. Sq \-nosplit |
|
argument to |
|
. Sq \&An |
|
applies to the whole document, not just to the current section as it |
|
does in groff. |
|
. It |
|
In quoted literals, groff allowed pair-wise double-quotes to produce a |
|
standalone double-quote in formatted output. This idiosyncratic |
|
behaviour is no longer applicable. |
|
. It |
|
The |
|
. Sq \&sp |
|
macro does not accept negative numbers. |
|
. 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. |
|
. It |
Historic groff has many un-callable macros. Most of these (excluding |
Historic groff has many un-callable macros. Most of these (excluding |
some block-level macros) are now callable, conforming to the |
some block-level macros) are now callable, conforming to the |
non-historic groff version. |
non-historic groff version. |
.\" LIST-ITEM |
. It |
.It |
The vertical bar |
The vertical bar |
. Sq \(ba |
.Sq \(Ba |
|
made historic groff |
made historic groff |
.Qq go orbital |
. Qq go orbital |
but is a proper delimiter in this implementation. |
but is a proper delimiter in this implementation. |
.\" LIST-ITEM |
. It |
.It |
. Sq \&It \-nested |
.Sq \&.It \-nested |
|
is assumed for all lists (it wasn't in historic groff): any list may be |
is assumed for all lists (it wasn't in historic groff): any list may be |
nested and |
nested and |
.Sq \-enum |
. Sq \-enum |
lists will restart the sequence only for the sub-list. |
lists will restart the sequence only for the sub-list. |
.\" LIST-ITEM |
. It |
.It |
. Sq \&It \-column |
.Sq \&.It \-column |
|
syntax where column widths may be preceded by other arguments (instead |
syntax where column widths may be preceded by other arguments (instead |
of proceeded) is not supported. |
of proceeded) is not supported. |
.\" LIST-ITEM |
. It |
.It |
The |
The |
. Sq \&At |
.Sq \&.At |
|
macro only accepts a single parameter. |
macro only accepts a single parameter. |
.\" LIST-ITEM |
. It |
.It |
|
Some manuals use |
Some manuals use |
.Sq \&.Li |
. Sq \&Li |
incorrectly by following it with a reserved character and expecting the |
incorrectly by following it with a reserved character and expecting the |
delimiter to render. This is not supported. |
delimiter to render. This is not supported. |
.\" LIST-ITEM |
. It |
.It |
In groff, the |
If an special-character control character |
. Sq \&Fo |
.Sq \e |
macro only produces the first parameter. This is no longer the case. |
is escaped, it will |
. El |
obviously not render the sequence. Even newer versions of groff seem to |
. |
dither on this. |
. |
.El |
|
.\" SECTION |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
. Xr mandoc 1 , |
.Xr mandoc_char 7 |
. Xr mandoc_char 7 |
.\" SECTION |
. |
|
. |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
. Nm |
utility was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
. An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" SECTION |
. |
|
. |
.Sh CAVEATS |
.Sh CAVEATS |
There are many ambiguous parts of mdoc. |
There are many ambiguous parts of mdoc. |
.Pp |
. Pp |
.Bl -dash -compact |
. Bl -dash -compact |
.\" LIST-ITEM |
. It |
.It |
. Sq \&Fa |
.Sq \&.Fa |
should be |
should be |
. Sq \&Va |
.Sq \&.Va |
|
as function arguments are variables. |
as function arguments are variables. |
.\" LIST-ITEM |
. It |
.It |
. Sq \&Ft |
.Sq \&.Ft |
|
should be |
should be |
.Sq \&.Vt |
. Sq \&Vt |
as function return types are still types. Furthermore, the |
as function return types are still types. Furthermore, the |
.Sq \&.Ft |
. Sq \&Ft |
should be removed and |
should be removed and |
.Sq \&.Fo , |
. Sq \&Fo , |
which ostensibly follows it, should follow the same convention as |
which ostensibly follows it, should follow the same convention as |
.Sq \&.Va . |
. Sq \&Va . |
.\" LIST-ITEM |
. It |
.It |
. Sq \&Va |
.Sq \&.Va |
|
should formalise that only one or two arguments are acceptable: a |
should formalise that only one or two arguments are acceptable: a |
variable name and optional, preceding type. |
variable name and optional, preceding type. |
.\" LIST-ITEM |
. It |
.It |
. Sq \&Fd |
.Sq \&.Fd |
|
is ambiguous. It's commonly used to indicate an include file in the |
is ambiguous. It's commonly used to indicate an include file in the |
synopsis section. |
synopsis section. |
.Sq \&.In |
. Sq \&In |
should be used, instead. |
should be used, instead. |
.\" LIST-ITEM |
. It |
.It |
|
Only the |
Only the |
.Sq \-literal |
. Sq \-literal |
argument to |
argument to |
.Sq \&.Bd |
. Sq \&Bd |
makes sense. The remaining ones should be removed. |
makes sense. The remaining ones should be removed. |
.\" LIST-ITEM |
. It |
.It |
The |
The |
. Sq \&Xo |
.Sq \&.Xo |
|
and |
and |
.Sq \&.Xc |
. Sq \&Xc |
macros should be deprecated. |
macros should be deprecated. |
.\" LIST-ITEM |
. It |
.It |
|
The |
The |
.Sq \&.Dt |
. Sq \&Dt |
macro lacks clarity. It should be absolutely clear which title will |
macro lacks clarity. It should be absolutely clear which title will |
render when formatting the manual page. |
render when formatting the manual page. |
.\" LIST-ITEM |
. It |
.It |
|
A |
A |
.Sq \&.Lx |
. Sq \&Lx |
should be provided for Linux (\(`a la |
should be provided for Linux (\(`a la |
.Sq \&.Ox , |
. Sq \&Ox , |
.Sq \&.Nx |
. Sq \&Nx |
etc.). |
etc.). |
.\" LIST-ITEM |
. It |
.It |
|
There's no way to refer to references in |
There's no way to refer to references in |
.Sq \&.Rs/.Re |
. Sq \&Rs/Re |
blocks. |
blocks. |
.El |
. It |
|
The \-split and \-nosplit dictates via |
|
. Sq \&An |
|
are re-set when entering and leaving the AUTHORS section. |
|
. El |
|
. |