version 1.44, 2009/07/17 12:08:08 |
version 1.48, 2009/07/18 23:31:04 |
|
|
Other lines are interpreted within the current state. |
Other lines are interpreted within the current state. |
.Ed |
.Ed |
.\" SECTION--------------------------------------------- |
.\" SECTION--------------------------------------------- |
.Sh INPUT ENCODING |
.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 termination. |
line terminators. |
.\" SUB-SECTION---------------------- |
.\" SUB-SECTION---------------------- |
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
Line 133 escape followed by an indicator: B (bold), I, (italic) |
|
Line 133 escape followed by an indicator: B (bold), I, (italic) |
|
(Roman, or reset). This form is not recommended. |
(Roman, or reset). This form is not recommended. |
.\" SUB-SECTION---------------------- |
.\" SUB-SECTION---------------------- |
.Ss Whitespace |
.Ss Whitespace |
In general, consecutive blocks of whitespace are pruned from input. |
In non-literal free-form lines, consecutive blocks of whitespace are |
These are later re-added, when applicable, by |
pruned from input and added later in the output filter, if applicable: |
.Xr mandoc 1 . |
.Bd -literal -offset indent |
|
These spaces are pruned from input. |
|
\&.Bd \-literal |
|
These are not. |
|
\&.Ed |
|
.Ed |
.\" PARAGRAPH------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
Blank lines are permitted within |
In macro lines, whitespace delimits arguments and is discarded. If |
.Sq \&Bd \-literal |
arguments are quoted, whitespace within the quotes is retained. |
or |
.\" PARAGRAPH------------ |
.Sq \&Bd \-unfilled |
.Pp |
contexts. Tab characters are only acceptable when delimiting |
Blank lines are only permitted within literal contexts, as are lines |
|
containing only whitespace. Tab characters are only acceptable when |
|
delimiting |
.Sq \&Bl \-column |
.Sq \&Bl \-column |
and in |
or when in a literal context. |
.Sq \&Bd \-literal |
.\" SUB-SECTION---------------------- |
or |
.Ss Quotation |
.Sq \&Bd \-unfilled |
Macro arguments may be quoted with a double-quote to group |
contexts. |
space-delimited terms or to retain blocks of whitespace. A quoted |
|
argument begins with a double-quote preceded by whitespace. The next |
|
double-quote not pair-wise adjacent to another double-quote terminates |
|
the literal, regardless of surrounding whitespace. |
|
.\" PARAGRAPH------------ |
|
.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. |
.\" SECTION--------------------------------------------- |
.\" SECTION--------------------------------------------- |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
Each |
Line 157 document must begin with a document prologue, containi |
|
Line 184 document must begin with a document prologue, containi |
|
.Sq \&Dd , |
.Sq \&Dd , |
.Sq \&Dt , |
.Sq \&Dt , |
and |
and |
.Sq \&Os |
.Sq \&Os , |
(using this manual as an example): |
then the NAME section containing at least one |
|
.Sq \&Nm |
|
followed by |
|
.Sq \&Nd : |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Dd $\&Mdocdate$ |
\&.Dd $\&Mdocdate$ |
\&.Dt mdoc 7 |
\&.Dt mdoc 7 |
|
|
\&.Nm mdoc |
\&.Nm mdoc |
\&.Nd mdoc language reference |
\&.Nd mdoc language reference |
.Ed |
.Ed |
.Pp |
|
Following these, the document body must begin with the NAME section |
|
containing at least one |
|
.Sq \&Nm |
|
followed by |
|
.Sq \&Nd . |
|
.\" PARAGRAPH------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
Line 181 but non-compulsory. |
|
Line 205 but non-compulsory. |
|
.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 semantic annotations. |
is processed for macros, two- or three-character sequences. |
.\" PARAGRAPH------------ |
.\" PARAGRAPH------------ |
.Pp |
.Pp |
The syntax of 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 |
|
|
.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 |
.Qq 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 |
.Em Scope |
.Em Scope |
Line 414 then the macro accepts an arbitrary number of argument |
|
Line 438 then the macro accepts an arbitrary number of argument |
|
.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 |
.El |
.El |
.\" SECTION--------------------------------------------- |
.\" SECTION--------------------------------------------- |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
|
|
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.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. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&sp |
|
macro does not accept negative numbers. |
|
.\" LIST-ITEM |
|
.It |
Some character sequences in groff are not handled depending on escape |
Some character sequences in groff are not handled depending on escape |
style, e.g., |
style, e.g., |
.Sq \e(ba |
.Sq \e(ba |
Line 457 made historic groff |
|
Line 492 made historic groff |
|
but is a proper delimiter in this implementation. |
but is a proper delimiter in this implementation. |
.\" LIST-ITEM |
.\" 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 |
.\" 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 |
.\" 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 |
.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 |
.\" LIST-ITEM |
Line 487 versions of groff seem to dither on this. |
|
Line 522 versions of groff seem to dither on this. |
|
.\" LIST-ITEM |
.\" 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--------------------------------------------- |
.\" SECTION--------------------------------------------- |
Line 498 macro only produces the first parameter. This is no l |
|
Line 533 macro only produces the first parameter. This is no l |
|
.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--------------------------------------------- |
.\" SECTION--------------------------------------------- |
.Sh CAVEATS |
.Sh CAVEATS |
Line 508 There are many ambiguous parts of mdoc. |
|
Line 543 There are many ambiguous parts of mdoc. |
|
.Bl -dash -compact |
.Bl -dash -compact |
.\" 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 |
.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 |
.\" 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 |
.\" 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 |
.\" 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 |
.\" 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 |
.\" 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 |
.\" 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 |
.\" 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 |
.\" LIST-ITEM |
.It |
.It |
The \-split and \-nosplit arguments to |
The \-split and \-nosplit arguments to |
.Sq \&.An |
.Sq \&An |
are inane. |
are inane. |
.El |
.El |