version 1.45, 2009/07/17 12:40:48 |
version 1.47, 2009/07/18 18:49:19 |
|
|
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 131 also be text-decorated using the |
|
Line 131 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. |
|
.Pp |
|
Lastly, a standalone double-quote may be produced in a macro line by |
|
using two consecutive double-quotes within a quoted literal. See |
|
.Sx Quotation |
|
for details. |
.\" 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 that is |
|
.Em |
|
preceded by a double-quote terminates the term, regardless of |
|
surrounding whitespace. Thus, the following construction produces |
|
.Sq "a""b" , |
|
since, as mentioned in |
|
.Sx Special Characters , |
|
two consecutive double-quotes in a quoted literal produce a standalone |
|
double-quote: |
|
.Bd -literal -offset indent |
|
\&.Em "a""""b" |
|
.Ed |
|
.\" 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 199 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 220 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 504 macro only produces the first parameter. This is no l |
|
Line 543 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 |