version 1.53, 2009/07/26 19:30:50 |
version 1.60, 2009/09/28 22:09:08 |
|
|
.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 |
|
|
.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 |
|
|
\&.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 |
Line 56 character, and, in certain circumstances, the tab char |
|
Line 59 character, and, in certain circumstances, the tab char |
|
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. Macro lines with only a control charater and optionally |
.\" SUB-SECTION---------------------- |
whitespace are stripped from input. |
|
. |
|
. |
.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 |
Line 91 Within a macro line, the following characters are rese |
|
Line 97 Within a macro line, the following characters are rese |
|
.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 . |
Line 99 For general use in macro lines, these characters must |
|
Line 105 For general use in macro lines, these characters must |
|
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 |
Line 111 for two-character sequences; an open-bracket |
|
Line 118 for two-character sequences; an open-bracket |
|
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------------ |
. |
.Pp |
. |
An alternative escape sequence is |
.Ss Text Decoration |
the slash-asterisk, |
Terms may be text-decorated using the |
.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 |
.\" SUB-SECTION---------------------- |
.Nm , |
|
which encourages semantic, not presentation, annotation. |
|
. |
|
. |
|
.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 . |
|
. |
|
. |
.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: |
Line 141 These spaces are pruned from input. |
|
Line 171 These spaces are pruned from input. |
|
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" , |
Line 173 considered literal text. Thus, the following produces |
|
Line 204 considered literal text. Thus, the following produces |
|
.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 |
|
|
\&.Dd $\&Mdocdate$ |
\&.Dd $\&Mdocdate$ |
\&.Dt mdoc 7 |
\&.Dt mdoc 7 |
\&.Os |
\&.Os |
|
\&. |
\&.Sh NAME |
\&.Sh NAME |
\&.Nm mdoc |
\&.Nm foo |
\&.Nd mdoc language reference |
\&.Nd a description goes here |
|
\&.\e\*q The next is for sections 2 & 3 only. |
|
\&.\e\*q .Sh LIBRARY |
|
\&. |
|
\&.Sh SYNOPSIS |
|
\&.Nm foo |
|
\&.Op Fl options |
|
\&.Ar |
|
\&. |
|
\&.Sh DESCRIPTION |
|
The |
|
\&.Nm |
|
utility processes files ... |
|
\&.\e\*q .Sh IMPLEMENTATION NOTES |
|
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .Sh EXIT STATUS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .Sh RETURN VALUES |
|
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
|
\&.\e\*q .Sh ENVIRONMENT |
|
\&.\e\*q .Sh FILES |
|
\&.\e\*q .Sh EXAMPLES |
|
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
|
\&.\e\*q .Sh DIAGNOSTICS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .Sh ERRORS |
|
\&.\e\*q .Sh SEE ALSO |
|
\&.\e\*q .Xr foobar 1 |
|
\&.\e\*q .Sh STANDARDS |
|
\&.\e\*q .Sh HISTORY |
|
\&.\e\*q .Sh AUTHORS |
|
\&.\e\*q .Sh CAVEATS |
|
\&.\e\*q .Sh BUGS |
|
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
.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 |
|
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 |
.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 |
|
|
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 |
|
initial line macro is interpreted as opaque text, such that |
|
.Sq \&.Fl \&Sh |
|
produces |
|
.Sq Fl \&Sh . |
|
. |
|
.Pp |
|
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. If a macro is not parsable, subsequent |
|
macro invocations on the line will be interpreted as opaque text. |
|
. |
|
.Pp |
|
The |
.Em Scope |
.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 |
Line 239 contains a head. |
|
Line 324 contains a head. |
|
\(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 |
Line 252 contains a head. |
|
Line 337 contains a head. |
|
.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 |
Line 270 may have multiple heads. |
|
Line 356 may have multiple heads. |
|
\&.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 |
Line 279 may have multiple heads. |
|
Line 365 may have multiple heads. |
|
.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 |
|
|
\&.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 \&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 |
|
|
.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 \&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 , |
Line 363 then the macro accepts an arbitrary number of argument |
|
Line 452 then the macro accepts an arbitrary number of argument |
|
|
|
\&.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 |
Line 399 then the macro accepts an arbitrary number of argument |
|
Line 488 then the macro accepts an arbitrary number of argument |
|
.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 n |
.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 |
Line 426 then the macro accepts an arbitrary number of argument |
|
Line 515 then the macro accepts an arbitrary number of argument |
|
.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 n |
.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 |
Line 439 then the macro accepts an arbitrary number of argument |
|
Line 528 then the macro accepts an arbitrary number of argument |
|
.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 |
Line 451 refers to those versions before the |
|
Line 541 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 |
.\" LIST-ITEM |
|
.It |
.It |
The |
The |
.Sq \-split |
.Sq \-split |
|
|
.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 |
Some character sequences in groff are not handled depending on escape |
|
style, e.g., |
|
.Sq \e(ba |
|
and |
|
.Sq \e*(Ba |
|
may not be interchanged. This is no longer the case: all character |
|
sequences resolve to the same symbol, regardless the escape style. |
|
.\" LIST-ITEM |
|
.It |
|
Blocks of whitespace are stripped from both macro and free-form text |
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 |
If an special-character control character is escaped |
|
.Sq \e\e , |
|
it will obviously not render the subsequent sequence. Even newer |
|
versions of groff seem to dither on this. |
|
.\" LIST-ITEM |
|
.It |
|
In groff, the |
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 |
.\" 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 |
Line 568 should be removed and |
|
Line 633 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 |
Line 608 should be provided for Linux (\(`a la |
|
Line 667 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 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 |
|
. |