version 1.46, 2009/07/17 14:51:04 |
version 1.54, 2009/07/27 12:35:54 |
|
|
.\" 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 |
|
|
.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------------ |
.\" 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: |
Line 55 documents may contain only graphable 7-bit ASCII chara |
|
Line 55 documents may contain only graphable 7-bit ASCII chara |
|
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---------------------- |
.\" SUB-SECTION---------------------- |
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
Line 87 Within a macro line, the following characters are rese |
|
Line 87 Within a macro line, the following characters are rese |
|
.It \&? |
.It \&? |
.Pq question |
.Pq question |
.It \&! |
.It \&! |
.Pq exclamation |
.Pq exclamation |
.It \&| |
.It \&| |
.Pq vertical bar |
.Pq vertical bar |
.El |
.El |
.\" PARAGRAPH------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
Line 98 Use of reserved characters is described in |
|
Line 98 Use of reserved characters is described in |
|
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---------------------- |
.\" 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 1 |
.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 . |
.\" PARAGRAPH------------ |
.\" SUB-SECTION---------------------- |
.Pp |
.Ss Text Decoration |
An alternative escape sequence is |
Terms may be text-decorated using the |
the slash-asterisk, |
|
.Sq \e* , |
|
but this method is discouraged for compatibility reasons. |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
Terms may |
|
also 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. |
(Roman, or reset). This form is not recommended for |
|
.Nm , |
|
which encourages semantic, not presentation, annotation. |
.\" SUB-SECTION---------------------- |
.\" SUB-SECTION---------------------- |
|
.Ss Predefined Strings |
|
Historically, |
|
.Xr groff 1 |
|
also defined a set of package-specific |
|
.Dq predefined strings , |
|
which, like |
|
.Sx Special Characters , |
|
demark special output characters and strings by way of input codes. |
|
Predefined strings are escaped with the slash-asterisk, |
|
.Sq \e* : |
|
single-character |
|
.Sq \e*X , |
|
two-character |
|
.Sq \e*(XX , |
|
and N-character |
|
.Sq \e*[N] . |
|
See |
|
.Xr mandoc_char 7 |
|
for a complete list. Examples include |
|
.Sq \e*(Am |
|
.Pq ampersand |
|
and |
|
.Sq \e*(Ba |
|
.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------------ |
.\" 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 is conditionally retained within the |
arguments are quoted, whitespace within the quotes is retained. |
quotes. |
|
.\" TODO: which do and which don't? |
|
.\" PARAGRAPH------------ |
.\" 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---------------------- |
.\" SUB-SECTION---------------------- |
Line 159 or when in a literal context. |
|
Line 177 or when in a literal context. |
|
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 terminates the term, regardless of surrounding whitespace. |
double-quote not pair-wise adjacent to another double-quote terminates |
|
the literal, regardless of surrounding whitespace. |
.\" PARAGRAPH------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
|
This produces tokens |
|
.Sq a" , |
|
.Sq b c , |
|
.Sq de , |
|
and |
|
.Sq fg" . |
|
Note that any quoted term, be it argument or macro, is indiscriminately |
|
considered literal text. Thus, the following produces |
|
.Sq \&Em a : |
|
.Bd -literal -offset indent |
|
\&.Em "Em a" |
|
.Ed |
|
.\" PARAGRAPH------------ |
|
.Pp |
In free-form mode, quotes are regarded as opaque text. |
In free-form mode, quotes are regarded as opaque text. |
.\" SECTION--------------------------------------------- |
.\" 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$ |
|
|
.\" PARAGRAPH------------ |
.\" 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--------------------------------------------- |
.\" SECTION--------------------------------------------- |
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
Every line beginning with the control character |
Every line beginning with the control character |
.Sq \. |
.Sq \. |
is processed for macros, two- or three-character sequences. |
is processed for macros, two- or three-character sequences. |
.\" PARAGRAPH------------ |
.\" PARAGRAPH------------ |
.Pp |
.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; |
|
|
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. The |
.Em Parsable |
.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. The |
Line 222 contains bodies; only |
|
Line 255 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------------ |
.\" PARAGRAPH------------ |
Line 242 contains a head. |
|
Line 275 contains a head. |
|
.\" SUB-SECTION---------------------- |
.\" 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------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
Line 269 may have multiple heads. |
|
Line 302 may have multiple heads. |
|
.\" SUB-SECTION---------------------- |
.\" 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------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
|
|
.El |
.El |
.\" SUB-SECTION---------------------- |
.\" 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 |
|
|
.El |
.El |
.\" SUB-SECTION---------------------- |
.\" 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 |
Line 374 then the macro accepts an arbitrary number of argument |
|
Line 407 then the macro accepts an arbitrary number of argument |
|
.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 \&No 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 |
Line 430 then the macro accepts an arbitrary number of argument |
|
Line 463 then the macro accepts an arbitrary number of argument |
|
.\" SECTION--------------------------------------------- |
.\" 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------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The |
The |
.Sq \&sp |
.Sq \-split |
macro does not accept negative numbers. |
or |
|
.Sq \-nosplit |
|
argument to |
|
.Sq \&An |
|
applies to the whole document, not just to the current section as it |
|
does in groff. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
Some character sequences in groff are not handled depending on escape |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
style, e.g., |
standalone double-quote in formatted output. This idiosyncratic |
.Sq \e(ba |
behaviour is no longer applicable. |
and |
|
.Sq \e*(Ba |
|
may not be interchanged. This is no longer the case: all character |
|
sequences resolve to the same symbol, regardless the escape style. |
|
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
|
The |
|
.Sq \&sp |
|
macro does not accept negative numbers. |
|
.\" LIST-ITEM |
|
.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. |
Line 467 some block-level macros) are now callable, conforming |
|
Line 506 some block-level macros) are now callable, conforming |
|
non-historic groff version. |
non-historic groff version. |
.\" LIST-ITEM |
.\" 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 |
Line 486 syntax where column widths may be preceded by other ar |
|
Line 525 syntax where column widths may be preceded by other ar |
|
of proceeded) is not supported. |
of proceeded) is not supported. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The |
The |
.Sq \&At |
.Sq \&At |
macro only accepts a single parameter. |
macro only accepts a single parameter. |
.\" LIST-ITEM |
.\" LIST-ITEM |
Line 497 incorrectly by following it with a reserved character |
|
Line 536 incorrectly by following it with a reserved character |
|
delimiter to render. This is not supported. |
delimiter to render. This is not supported. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
If an special-character control character is escaped |
In groff, the |
.Sq \e\e , |
|
it will obviously not render the subsequent sequence. Even newer |
|
versions of groff seem to dither on this. |
|
.\" LIST-ITEM |
|
.It |
|
In groff, the |
|
.Sq \&Fo |
.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 |
Line 515 macro only produces the first parameter. This is no l |
|
Line 548 macro only produces the first parameter. This is no l |
|
.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--------------------------------------------- |
.\" SECTION--------------------------------------------- |
.Sh CAVEATS |
.Sh CAVEATS |
Line 526 There are many ambiguous parts of mdoc. |
|
Line 559 There are many ambiguous parts of mdoc. |
|
.\" LIST-ITEM |
.\" 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 |
.\" LIST-ITEM |
Line 549 variable name and optional, preceding type. |
|
Line 582 variable name and optional, preceding type. |
|
.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 |
.\" LIST-ITEM |
|
|
makes sense. The remaining ones should be removed. |
makes sense. The remaining ones should be removed. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The |
The |
.Sq \&Xo |
.Sq \&Xo |
and |
and |
.Sq \&Xc |
.Sq \&Xc |
Line 576 render when formatting the manual page. |
|
Line 609 render when formatting the manual page. |
|
.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 |
.\" LIST-ITEM |
.It |
.It |
Line 587 There's no way to refer to references in |
|
Line 620 There's no way to refer to references in |
|
blocks. |
blocks. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The \-split and \-nosplit arguments to |
The \-split and \-nosplit dictates via |
.Sq \&An |
.Sq \&An |
are inane. |
are re-set when entering and leaving the AUTHORS section. |
.El |
.El |