version 1.54, 2009/07/27 12:35:54 |
version 1.56, 2009/08/18 14:27:16 |
|
|
.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 its syntax, structure, |
manuals. In this reference document, we describe its syntax, structure, |
and usage. Our reference implementation is |
and usage. Our reference implementation is |
.Xr mandoc 1 . |
. 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 indent |
. 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 LANGUAGE SYNTAX |
.Sh LANGUAGE SYNTAX |
.Nm |
. Nm |
documents may contain only graphable 7-bit ASCII characters, the space |
documents may contain only graphable 7-bit ASCII characters, the space |
character, and, in certain circumstances, the tab character. All |
character, and, in certain circumstances, the tab character. All |
manuals must have |
manuals must have |
.Ux |
. Ux |
line terminators. |
line terminators. |
.\" SUB-SECTION---------------------- |
. |
.Ss Comments |
. |
|
. Ss Comments |
Text following a |
Text following a |
.Sq \e" , |
. Sq \e" , |
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or free-form text line, is ignored to the end of |
line. A macro line with only a control character and comment escape, |
line. A macro line with only a control character and comment escape, |
.Sq \&.\e" , |
. Sq \&.\e" , |
is also ignored. |
is also ignored. |
.\" SUB-SECTION---------------------- |
. |
.Ss Reserved Characters |
. |
|
. 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 indent -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 MACRO SYNTAX . |
. Sx MACRO SYNTAX . |
For general use in macro lines, these characters must either be escaped |
For general use in macro lines, these characters must either be escaped |
with a 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 |
. |
|
. Ss Special Characters |
Special characters may occur in both macro and free-form lines. |
Special characters may occur in both macro and free-form lines. |
Sequences begin with the escape character |
Sequences begin with the escape character |
.Sq \e |
. Sq \e |
followed by either an open-parenthesis |
followed by either an open-parenthesis |
.Sq \&( |
. Sq \&( |
for two-character sequences; an open-bracket |
for two-character sequences; an open-bracket |
.Sq \&[ |
. Sq \&[ |
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. See |
or a single one-character sequence. See |
.Xr mandoc_char 7 |
. Xr mandoc_char 7 |
for a complete list. Examples include |
for a complete list. Examples include |
.Sq \e(em |
. Sq \e(em |
.Pq em-dash |
. Pq em-dash |
and |
and |
.Sq \ee |
. Sq \ee |
.Pq back-slash . |
. Pq back-slash . |
.\" SUB-SECTION---------------------- |
. |
.Ss Text Decoration |
. |
|
. Ss Text Decoration |
Terms may be text-decorated using the |
Terms may be text-decorated using the |
.Sq \ef |
. Sq \ef |
escape followed by an indicator: B (bold), I, (italic), or P and R |
escape followed by an indicator: B (bold), I, (italic), or P and R |
(Roman, or reset). This form is not recommended for |
(Roman, or reset). This form is not recommended for |
.Nm , |
. Nm , |
which encourages semantic, not presentation, annotation. |
which encourages semantic, not presentation, annotation. |
.\" SUB-SECTION---------------------- |
. |
.Ss Predefined Strings |
. |
|
. Ss Predefined Strings |
Historically, |
Historically, |
.Xr groff 1 |
. Xr groff 1 |
also defined a set of package-specific |
also defined a set of package-specific |
.Dq predefined strings , |
. Dq predefined strings , |
which, like |
which, like |
.Sx Special Characters , |
. Sx Special Characters , |
demark special output characters and strings by way of input codes. |
demark special output characters and strings by way of input codes. |
Predefined strings are escaped with the slash-asterisk, |
Predefined strings are escaped with the slash-asterisk, |
.Sq \e* : |
. Sq \e* : |
single-character |
single-character |
.Sq \e*X , |
. Sq \e*X , |
two-character |
two-character |
.Sq \e*(XX , |
. Sq \e*(XX , |
and N-character |
and N-character |
.Sq \e*[N] . |
. Sq \e*[N] . |
See |
See |
.Xr mandoc_char 7 |
. Xr mandoc_char 7 |
for a complete list. Examples include |
for a complete list. Examples include |
.Sq \e*(Am |
. Sq \e*(Am |
.Pq ampersand |
. Pq ampersand |
and |
and |
.Sq \e*(Ba |
. Sq \e*(Ba |
.Pq vertical bar . |
. Pq vertical bar . |
.\" SUB-SECTION---------------------- |
. |
.Ss Whitespace |
. |
|
. Ss Whitespace |
In non-literal free-form lines, consecutive blocks of whitespace are |
In non-literal free-form lines, consecutive blocks of whitespace are |
pruned from input and added later in the output filter, if applicable: |
pruned from input and added later in the output filter, if applicable: |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
These spaces are pruned from input. |
These spaces are pruned from input. |
\&.Bd \-literal |
\&.Bd \-literal |
These are not. |
These are not. |
\&.Ed |
\&.Ed |
.Ed |
. Ed |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
|
In macro lines, whitespace delimits arguments and is discarded. If |
In macro lines, whitespace delimits arguments and is discarded. If |
arguments are quoted, whitespace within the quotes is retained. |
arguments are quoted, whitespace within the quotes is retained. |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
|
Blank lines are only permitted within literal contexts, as are lines |
Blank lines are only permitted within literal contexts, as are lines |
containing only whitespace. Tab characters are only acceptable when |
containing only whitespace. Tab characters are only acceptable when |
delimiting |
delimiting |
.Sq \&Bl \-column |
. Sq \&Bl \-column |
or when in a literal context. |
or when in a literal context. |
.\" SUB-SECTION---------------------- |
. |
.Ss Quotation |
. |
|
. Ss Quotation |
Macro arguments may be quoted with a double-quote to group |
Macro arguments may be quoted with a double-quote to group |
space-delimited terms or to retain blocks of whitespace. A quoted |
space-delimited terms or to retain blocks of whitespace. A quoted |
argument begins with a double-quote preceded by whitespace. The next |
argument begins with a double-quote preceded by whitespace. The next |
double-quote not pair-wise adjacent to another double-quote terminates |
double-quote not pair-wise adjacent to another double-quote terminates |
the literal, regardless of surrounding whitespace. |
the literal, regardless of surrounding whitespace. |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
|
This produces tokens |
This produces tokens |
.Sq a" , |
. Sq a" , |
.Sq b c , |
. Sq b c , |
.Sq de , |
. Sq de , |
and |
and |
.Sq fg" . |
. Sq fg" . |
Note that any quoted term, be it argument or macro, is indiscriminately |
Note that any quoted term, be it argument or macro, is indiscriminately |
considered literal text. Thus, the following produces |
considered literal text. Thus, the following produces |
.Sq \&Em a : |
. Sq \&Em a : |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
\&.Em "Em a" |
\&.Em "Em a" |
.Ed |
. Ed |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
|
In free-form mode, quotes are regarded as opaque text. |
In free-form mode, quotes are regarded as opaque text. |
.\" SECTION--------------------------------------------- |
. |
|
. |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
Each |
.Nm |
. Nm |
document must begin with a document prologue, containing, in order, |
document must begin with a document prologue, containing, in order, |
.Sq \&Dd , |
. Sq \&Dd , |
.Sq \&Dt , |
. Sq \&Dt , |
and |
and |
.Sq \&Os , |
. Sq \&Os , |
then the NAME section containing at least one |
then the NAME section containing at least one |
.Sq \&Nm |
. Sq \&Nm |
followed by |
followed by |
.Sq \&Nd : |
. Sq \&Nd : |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
\&.Dd $\&Mdocdate$ |
\&.Dd $\&Mdocdate$ |
\&.Dt mdoc 7 |
\&.Dt mdoc 7 |
\&.Os |
\&.Os |
\&.Sh NAME |
\&.Sh NAME |
\&.Nm mdoc |
\&.Nm mdoc |
\&.Nd mdoc language reference |
\&.Nd mdoc language reference |
.Ed |
. Ed |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
|
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
but non-compulsory. |
but non-compulsory. |
.\" SECTION--------------------------------------------- |
. |
|
. |
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
Every line beginning with the control character |
Macros are one to three three characters in length and begin with a |
.Sq \. |
control character , |
is processed for macros, two- or three-character sequences. |
. Sq \&. , |
.\" PARAGRAPH------------ |
at the beginning of the line. An arbitrary amount of whitespace may |
.Pp |
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, |
The syntax of a macro depends on its classification. In this section, |
.Sq \-arg |
. Sq \-arg |
refers to macro arguments, which may be followed by zero or more |
refers to macro arguments, which may be followed by zero or more |
.Sq parm |
. Sq parm |
parameters; |
parameters; |
.Sq \&Yo |
. Sq \&Yo |
opens the scope of a macro; and if specified, |
opens the scope of a macro; and if specified, |
.Sq \&Yc |
. Sq \&Yc |
closes it out. |
closes it out. |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
|
The |
The |
.Em Callable |
. Em Callable |
column indicates that the macro may be called subsequent to the initial |
column indicates that the macro may be called subsequent to the initial |
line-macro. The |
line-macro. If a macro is not callable, then its invocation after the |
.Em Parsable |
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 |
column indicates whether the macro may be followed by further |
(ostensibly callable) macros. The |
(ostensibly callable) macros. If a macro is not parsable, subsequent |
.Em Scope |
macro invocations on the line will be interpreted as opaque text. |
|
. Pp |
|
The |
|
. Em Scope |
column, if applicable, describes closure rules. |
column, if applicable, describes closure rules. |
.\" SUB-SECTION---------------------- |
. |
.Ss Block full-explicit |
. |
|
. Ss Block full-explicit |
Multi-line scope closed by an explicit closing macro. All macros |
Multi-line scope closed by an explicit closing macro. All macros |
contains bodies; only |
contains bodies; only |
.Pq Sq \&Bf |
. Pq Sq \&Bf |
contains a head. |
contains a head. |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
\&.Yc |
\&.Yc |
.Ed |
. Ed |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
. 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 \&Bd Ta \&No Ta \&No Ta closed by \&Ed |
. It \&Bf Ta \&No Ta \&No Ta closed by \&Ef |
.It \&Bf Ta \&No Ta \&No Ta closed by \&Ef |
. It \&Bk Ta \&No Ta \&No Ta closed by \&Ek |
.It \&Bk Ta \&No Ta \&No Ta closed by \&Ek |
. It \&Bl Ta \&No Ta \&No Ta closed by \&El |
.It \&Bl Ta \&No Ta \&No Ta closed by \&El |
. It \&Ed Ta \&No Ta \&No Ta opened by \&Bd |
.It \&Ed Ta \&No Ta \&No Ta opened by \&Bd |
. It \&Ef Ta \&No Ta \&No Ta opened by \&Bf |
.It \&Ef Ta \&No Ta \&No Ta opened by \&Bf |
. It \&Ek Ta \&No Ta \&No Ta opened by \&Bk |
.It \&Ek Ta \&No Ta \&No Ta opened by \&Bk |
. It \&El Ta \&No Ta \&No Ta opened by \&Bl |
.It \&El Ta \&No Ta \&No Ta opened by \&Bl |
. El |
.El |
. |
.\" SUB-SECTION---------------------- |
. |
.Ss Block full-implicit |
. Ss Block full-implicit |
Multi-line scope closed by end-of-file or implicitly by another macro. |
Multi-line scope closed by end-of-file or implicitly by another macro. |
All macros have bodies; some |
All macros have bodies; some |
.Po |
. Po |
.Sq \&It \-bullet , |
. Sq \&It \-bullet , |
.Sq \-hyphen , |
. Sq \-hyphen , |
.Sq \-dash , |
. Sq \-dash , |
.Sq \-enum , |
. Sq \-enum , |
.Sq \-item |
. Sq \-item |
.Pc |
. Pc |
don't have heads, while |
don't have heads, while |
.Sq \&It \-column |
. Sq \&It \-column |
may have multiple heads. |
may have multiple heads. |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
.Ed |
. Ed |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
. 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 \&It Ta \&No Ta Yes Ta closed by \&It, \&El |
.It \&It Ta \&No Ta Yes Ta closed by \&It, \&El |
. It \&Nd Ta \&No Ta \&No Ta closed by \&Sh |
.It \&Nd Ta \&No Ta \&No Ta closed by \&Sh |
. It \&Sh 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 |
.It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss |
. El |
.El |
. |
.\" SUB-SECTION---------------------- |
. |
.Ss Block partial-explicit |
. Ss Block partial-explicit |
Like block full-explicit, but also with single-line scope. Each |
Like block full-explicit, but also with single-line scope. Each |
has at least a body and, in limited circumstances, a 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 |
. Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
\&.Yc \(lBtail...\(rB |
\&.Yc \(lBtail...\(rB |
|
|
\&.Yo \(lB\-arg \(lBparm...\(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 |
.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 \&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 \&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 \&Brc Ta Yes Ta Yes Ta opened by \&Bro |
.It \&Brc Ta Yes Ta Yes Ta opened by \&Bro |
. It \&Bro Ta Yes Ta Yes Ta closed by \&Brc |
.It \&Bro Ta Yes Ta Yes Ta closed by \&Brc |
. 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 \&Do Ta Yes Ta Yes Ta closed by \&Dc |
. It \&Ec Ta Yes Ta Yes Ta opened by \&Eo |
.It \&Ec Ta Yes Ta Yes Ta opened by \&Eo |
. It \&Eo Ta Yes Ta Yes Ta closed by \&Ec |
.It \&Eo Ta Yes Ta Yes Ta closed by \&Ec |
. It \&Fc Ta Yes Ta Yes Ta opened by \&Fo |
.It \&Fc Ta Yes Ta Yes Ta opened by \&Fo |
. It \&Fo Ta \&No Ta \&No Ta closed by \&Fc |
.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 \&Pc Ta Yes Ta Yes Ta closed by \&Po |
.It \&Pc Ta Yes Ta Yes Ta closed by \&Po |
. It \&Po Ta Yes Ta Yes Ta opened by \&Pc |
.It \&Po Ta Yes Ta Yes Ta opened by \&Pc |
. It \&Qc Ta Yes Ta Yes Ta opened by \&Oo |
.It \&Qc Ta Yes Ta Yes Ta opened by \&Oo |
. It \&Qo Ta Yes Ta Yes Ta closed by \&Oc |
.It \&Qo Ta Yes Ta Yes Ta closed by \&Oc |
. It \&Re Ta \&No Ta \&No Ta opened by \&Rs |
.It \&Re Ta \&No Ta \&No Ta opened by \&Rs |
. It \&Rs Ta \&No Ta \&No Ta closed by \&Re |
.It \&Rs Ta \&No Ta \&No Ta closed by \&Re |
. It \&Sc Ta Yes Ta Yes Ta opened by \&So |
.It \&Sc Ta Yes Ta Yes Ta opened by \&So |
. It \&So Ta Yes Ta Yes Ta closed by \&Sc |
.It \&So Ta Yes Ta Yes Ta closed by \&Sc |
. It \&Xc Ta Yes Ta Yes Ta opened by \&Xo |
.It \&Xc Ta Yes Ta Yes Ta opened by \&Xo |
. It \&Xo Ta Yes Ta Yes Ta closed by \&Xc |
.It \&Xo Ta Yes Ta Yes Ta closed by \&Xc |
. El |
.El |
. |
.\" SUB-SECTION---------------------- |
. |
.Ss Block partial-implicit |
. Ss Block partial-implicit |
Like block full-implicit, but with single-line scope closed by |
Like block full-implicit, but with single-line scope closed by |
.Sx Reserved Characters |
. Sx Reserved Characters |
or end of line. |
or end of line. |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
.Ed |
. Ed |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
. Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
.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 \&Aq Ta Yes Ta Yes |
.It \&Aq Ta Yes Ta Yes |
. It \&Bq Ta Yes Ta Yes |
.It \&Bq Ta Yes Ta Yes |
. It \&Brq Ta Yes Ta Yes |
.It \&Brq Ta Yes Ta Yes |
. It \&D1 Ta \&No Ta \&Yes |
.It \&D1 Ta \&No Ta \&Yes |
. It \&Dl Ta \&No Ta Yes |
.It \&Dl Ta \&No Ta Yes |
. It \&Dq Ta Yes Ta Yes |
.It \&Dq Ta Yes Ta Yes |
. It \&Op Ta Yes Ta Yes |
.It \&Op Ta Yes Ta Yes |
. It \&Pq Ta Yes Ta Yes |
.It \&Pq Ta Yes Ta Yes |
. It \&Ql Ta Yes Ta Yes |
.It \&Ql Ta Yes Ta Yes |
. It \&Qq Ta Yes Ta Yes |
.It \&Qq Ta Yes Ta Yes |
. It \&Sq Ta Yes Ta Yes |
.It \&Sq Ta Yes Ta Yes |
. El |
.El |
. |
.\" SUB-SECTION---------------------- |
. |
.Ss In-line |
. Ss In-line |
Closed by |
Closed by |
.Sx Reserved Characters , |
. Sx Reserved Characters , |
end of line, fixed argument lengths, and/or subsequent macros. In-line |
end of line, fixed argument lengths, and/or subsequent macros. In-line |
macros have only text children. If a number (or inequality) of |
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. |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb |
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
.Ed |
. Ed |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
. Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent |
. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
. It \&%A Ta \&No Ta \&No Ta >0 |
.It \&%A Ta \&No Ta \&No Ta >0 |
. It \&%B Ta \&No Ta \&No Ta >0 |
.It \&%B Ta \&No Ta \&No Ta >0 |
. It \&%C Ta \&No Ta \&No Ta >0 |
.It \&%C Ta \&No Ta \&No Ta >0 |
. It \&%D Ta \&No Ta \&No Ta >0 |
.It \&%D Ta \&No Ta \&No Ta >0 |
. It \&%I Ta \&No Ta \&No Ta >0 |
.It \&%I Ta \&No Ta \&No Ta >0 |
. It \&%J Ta \&No Ta \&No Ta >0 |
.It \&%J Ta \&No Ta \&No Ta >0 |
. It \&%N Ta \&No Ta \&No Ta >0 |
.It \&%N Ta \&No Ta \&No Ta >0 |
. It \&%O Ta \&No Ta \&No Ta >0 |
.It \&%O Ta \&No Ta \&No Ta >0 |
. It \&%P Ta \&No Ta \&No Ta >0 |
.It \&%P Ta \&No Ta \&No Ta >0 |
. It \&%R Ta \&No Ta \&No Ta >0 |
.It \&%R Ta \&No Ta \&No Ta >0 |
. It \&%T Ta \&No Ta \&No Ta >0 |
.It \&%T Ta \&No Ta \&No Ta >0 |
. It \&%V Ta \&No Ta \&No Ta >0 |
.It \&%V Ta \&No Ta \&No Ta >0 |
. It \&Ad Ta Yes Ta Yes Ta n |
.It \&Ad Ta Yes Ta Yes Ta n |
. It \&An Ta Yes Ta Yes Ta n |
.It \&An Ta Yes Ta Yes Ta n |
. It \&Ap Ta Yes Ta Yes Ta 0 |
.It \&Ap Ta Yes Ta Yes Ta 0 |
. It \&Ar Ta Yes Ta Yes Ta n |
.It \&Ar Ta Yes Ta Yes Ta n |
. It \&At Ta Yes Ta Yes Ta 1 |
.It \&At Ta Yes Ta Yes Ta 1 |
. It \&Bsx Ta Yes Ta Yes Ta n |
.It \&Bsx Ta Yes Ta Yes Ta n |
. It \&Bt Ta \&No Ta \&No Ta 0 |
.It \&Bt Ta \&No Ta \&No Ta 0 |
. It \&Bx Ta Yes Ta Yes Ta n |
.It \&Bx Ta Yes Ta Yes Ta n |
. It \&Cd Ta Yes Ta Yes Ta >0 |
.It \&Cd Ta Yes Ta Yes Ta >0 |
. It \&Cm Ta Yes Ta Yes Ta n |
.It \&Cm Ta Yes Ta Yes Ta n |
. It \&Db Ta \&No Ta \&No Ta 1 |
.It \&Db Ta \&No Ta \&No Ta 1 |
. It \&Dd Ta \&No Ta \&No Ta >0 |
.It \&Dd Ta \&No Ta \&No Ta >0 |
. It \&Dt Ta \&No Ta \&No Ta n |
.It \&Dt Ta \&No Ta \&No Ta n |
. It \&Dv Ta Yes Ta Yes Ta n |
.It \&Dv Ta Yes Ta Yes Ta n |
. It \&Dx Ta Yes Ta Yes Ta n |
.It \&Dx Ta Yes Ta Yes Ta n |
. It \&Em Ta Yes Ta Yes Ta >0 |
.It \&Em Ta Yes Ta Yes Ta >0 |
. It \&En Ta \&No Ta \&No Ta 0 |
.It \&En Ta \&No Ta \&No Ta 0 |
. It \&Er Ta Yes Ta Yes Ta >0 |
.It \&Er Ta Yes Ta Yes Ta >0 |
. It \&Es Ta \&No Ta \&No Ta 0 |
.It \&Es Ta \&No Ta \&No Ta 0 |
. It \&Ev Ta Yes Ta Yes Ta n |
.It \&Ev Ta Yes Ta Yes Ta n |
. It \&Ex Ta \&No Ta \&No Ta 0 |
.It \&Ex Ta \&No Ta \&No Ta 0 |
. It \&Fa Ta Yes Ta Yes Ta n |
.It \&Fa Ta Yes Ta Yes Ta n |
. It \&Fd Ta \&No Ta \&No Ta >0 |
.It \&Fd Ta \&No Ta \&No Ta >0 |
. It \&Fl Ta Yes Ta Yes Ta n |
.It \&Fl Ta Yes Ta Yes Ta n |
. It \&Fn Ta Yes Ta Yes Ta >0 |
.It \&Fn Ta Yes Ta Yes Ta >0 |
. It \&Fr Ta \&No Ta \&No Ta n |
.It \&Fr Ta \&No Ta \&No Ta n |
. It \&Ft Ta Yes Ta Yes Ta n |
.It \&Ft Ta Yes Ta Yes Ta n |
. 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 \&Hf Ta \&No Ta \&No Ta n |
. It \&Ic Ta Yes Ta Yes Ta >0 |
.It \&Ic Ta Yes Ta Yes Ta >0 |
. It \&In Ta \&No Ta \&No Ta n |
.It \&In Ta \&No Ta \&No Ta n |
. It \&Lb Ta \&No Ta \&No Ta 1 |
.It \&Lb Ta \&No Ta \&No Ta 1 |
. It \&Li Ta Yes Ta Yes Ta n |
.It \&Li Ta Yes Ta Yes Ta n |
. It \&Lk Ta Yes Ta Yes Ta n |
.It \&Lk Ta Yes Ta Yes Ta n |
. It \&Lp Ta \&No Ta \&No Ta 0 |
.It \&Lp Ta \&No Ta \&No Ta 0 |
. It \&Ms Ta Yes Ta Yes Ta >0 |
.It \&Ms Ta Yes Ta Yes Ta >0 |
. It \&Mt Ta Yes Ta Yes Ta >0 |
.It \&Mt Ta Yes Ta Yes Ta >0 |
. It \&Nm Ta Yes Ta Yes Ta n |
.It \&Nm Ta Yes Ta Yes Ta n |
. It \&No Ta Yes Ta Yes Ta 0 |
.It \&No Ta Yes Ta Yes Ta 0 |
. It \&Ns Ta Yes Ta Yes Ta 0 |
.It \&Ns Ta Yes Ta Yes Ta 0 |
. It \&Nx Ta Yes Ta Yes Ta n |
.It \&Nx Ta Yes Ta Yes Ta n |
. It \&Os Ta \&No Ta \&No Ta n |
.It \&Os Ta \&No Ta \&No Ta n |
. It \&Ot Ta \&No Ta \&No Ta n |
.It \&Ot Ta \&No Ta \&No Ta n |
. It \&Ox Ta Yes Ta Yes Ta n |
.It \&Ox Ta Yes Ta Yes Ta n |
. It \&Pa Ta Yes Ta Yes Ta n |
.It \&Pa Ta Yes Ta Yes Ta n |
. It \&Pf Ta \&No Ta Yes Ta 1 |
.It \&Pf Ta \&No Ta Yes Ta 1 |
. It \&Pp Ta \&No Ta \&No Ta 0 |
.It \&Pp Ta \&No Ta \&No Ta 0 |
. It \&Rv Ta \&No Ta \&No Ta 0 |
.It \&Rv Ta \&No Ta \&No Ta 0 |
. It \&Sm Ta \&No Ta \&No Ta 1 |
.It \&Sm Ta \&No Ta \&No Ta 1 |
. It \&St Ta \&No Ta Yes Ta 1 |
.It \&St Ta \&No Ta Yes Ta 1 |
. It \&Sx Ta Yes Ta Yes Ta >0 |
.It \&Sx Ta Yes Ta Yes Ta >0 |
. It \&Sy Ta Yes Ta Yes Ta >0 |
.It \&Sy Ta Yes Ta Yes Ta >0 |
. It \&Tn Ta Yes Ta Yes Ta >0 |
.It \&Tn Ta Yes Ta Yes Ta >0 |
. It \&Ud Ta \&No Ta \&No Ta 0 |
.It \&Ud Ta \&No Ta \&No Ta 0 |
. It \&Ux Ta Yes Ta Yes Ta n |
.It \&Ux Ta Yes Ta Yes Ta n |
. It \&Va Ta Yes Ta Yes Ta n |
.It \&Va Ta Yes Ta Yes Ta n |
. It \&Vt Ta Yes Ta Yes Ta >0 |
.It \&Vt Ta Yes Ta Yes Ta >0 |
. It \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&Xr Ta Yes Ta Yes Ta >0, <3 |
. It \&br Ta \&No Ta \&No Ta 0 |
.It \&br Ta \&No Ta \&No Ta 0 |
. It \&sp Ta \&No Ta \&No Ta 1 |
.It \&sp Ta \&No Ta \&No Ta 1 |
. El |
.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 . |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
. Bl -dash -compact |
.Bl -dash -compact |
. It |
.\" LIST-ITEM |
|
.It |
|
The |
The |
.Sq \-split |
. Sq \-split |
or |
or |
.Sq \-nosplit |
. Sq \-nosplit |
argument to |
argument to |
.Sq \&An |
. Sq \&An |
applies to the whole document, not just to the current section as it |
applies to the whole document, not just to the current section as it |
does in groff. |
does in groff. |
.\" LIST-ITEM |
. It |
.It |
|
In quoted literals, groff allowed pair-wise double-quotes to produce a |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
standalone double-quote in formatted output. This idiosyncratic |
standalone double-quote in formatted output. This idiosyncratic |
behaviour is no longer applicable. |
behaviour is no longer applicable. |
.\" LIST-ITEM |
. It |
.It |
|
The |
The |
.Sq \&sp |
. Sq \&sp |
macro does not accept negative numbers. |
macro does not accept negative numbers. |
.\" LIST-ITEM |
. It |
.It |
|
Blocks of whitespace are stripped from both macro and free-form text |
Blocks of whitespace are stripped from both macro and free-form text |
lines (except when in literal mode), while groff would retain whitespace |
lines (except when in literal mode), while groff would retain whitespace |
in free-form text lines. |
in free-form text lines. |
.\" LIST-ITEM |
. It |
.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 |
In groff, the |
.Sq \&Fo |
. Sq \&Fo |
macro only produces the first parameter. This is no longer the case. |
macro only produces the first parameter. This is no longer the case. |
.El |
. 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 |
reference 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. |
.\" PARAGRAPH------------ |
. Pp |
.Pp |
. Bl -dash -compact |
.Bl -dash -compact |
. It |
.\" LIST-ITEM |
. Sq \&Fa |
.It |
|
.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. |
.\" LIST-ITEM |
. It |
.It |
|
The \-split and \-nosplit dictates via |
The \-split and \-nosplit dictates via |
.Sq \&An |
. Sq \&An |
are re-set when entering and leaving the AUTHORS section. |
are re-set when entering and leaving the AUTHORS section. |
.El |
. El |
|
. |