summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--libmdoc.h1
-rw-r--r--man.7443
-rw-r--r--mdoc.7805
-rw-r--r--mdoc.c28
4 files changed, 641 insertions, 636 deletions
diff --git a/libmdoc.h b/libmdoc.h
index 794300c3..9e0caf82 100644
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -92,7 +92,6 @@ enum merr {
EOPEN,
EQUOTPHR,
ENOCTX,
- ESPACE,
ELIB,
MERRMAX
};
diff --git a/man.7 b/man.7
index 882ea321..c8bbd638 100644
--- a/man.7
+++ b/man.7
@@ -17,112 +17,119 @@
.Dd $Mdocdate$
.Dt MAN 7
.Os
-.\" SECTION
+.
+.
.Sh NAME
-.Nm man
-.Nd man language reference
-.\" SECTION
+. Nm man
+. Nd man language reference
+.
+.
.Sh DESCRIPTION
The
-.Nm man
+. Nm man
language was historically used to format
-.Ux
+. Ux
manuals. This reference document describes its syntax, structure, and
usage.
-.Pp
-.Bf -emphasis
+. Pp
+. Bf -emphasis
Do not use
-.Nm
+. Nm
to write your manuals.
-.Ef
+. Ef
Use the
-.Xr mdoc 7
+. Xr mdoc 7
language, instead.
-.\" PARAGRAPH
-.Pp
+. Pp
An
-.Nm
+. Nm
document follows simple rules: lines beginning with the control
character
-.Sq \&.
+. Sq \&.
are parsed for macros. Other lines are interpreted within the scope of
prior macros:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.SH Macro lines change control state.
Other lines are interpreted within the current state.
-.Ed
-.\" SECTION
+. Ed
+.
+.
.Sh INPUT ENCODING
-.Nm
+. Nm
documents may contain only graphable 7-bit ASCII characters, the
space character, and the tabs character. All manuals must have
-.Ux
+. Ux
line termination.
-.Pp
+. Pp
Blank lines are acceptable; where found, the output will assert a
vertical space.
-.Pp
+. Pp
The
-.Sq \ec
+. Sq \ec
escape is common in historical
-.Nm
+. Nm
documents; if encountered at the end of a word, it ensures that the
subsequent word isn't off-set by whitespace.
-.\" SUB-SECTION
-.Ss Comments
+.
+.
+. Ss Comments
Text following a
-.Sq \e\*" ,
+. Sq \e\*" ,
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,
-.Sq \&.\e" ,
+. Sq \&.\e" ,
is also ignored. Macro lines with only a control charater and
optionally whitespace are stripped from input.
-.\" SUB-SECTION
-.Ss Special Characters
+.
+.
+. Ss Special Characters
Special characters may occur in both macro and free-form lines.
Sequences begin with the escape character
-.Sq \e
+. Sq \e
followed by either an open-parenthesis
-.Sq \&(
+. Sq \&(
for two-character sequences; an open-bracket
-.Sq \&[
+. Sq \&[
for n-character sequences (terminated at a close-bracket
-.Sq \&] ) ;
+. Sq \&] ) ;
or a single one-character sequence. See
-.Xr mandoc_char 7
+. Xr mandoc_char 7
for a complete list. Examples include
-.Sq \e(em
-.Pq em-dash
+. Sq \e(em
+. Pq em-dash
and
-.Sq \ee
-.Pq back-slash .
-.\" SUB-SECTION----------------------
-.Ss Text Decoration
+. Sq \ee
+. Pq back-slash .
+.
+.
+. Ss Text Decoration
Terms may be text-decorated using the
-.Sq \ef
+. Sq \ef
escape followed by an indicator: B (bold), I, (italic), or P and R
(Roman, or reset).
-.\" SUB-SECTION----------------------
-.Ss Whitespace
+.
+.
+. Ss Whitespace
Unless specifically escaped, consecutive blocks of whitespace are pruned
from input. These are later re-added, if applicable, by a front-end
utility such as
-.Xr mandoc 1 .
-.\" SECTION
+. Xr mandoc 1 .
+.
+.
.Sh MANUAL STRUCTURE
Each
-.Nm
+. Nm
document must contain contains at least the
-.Sq \&TH
+. Sq \&TH
macro describing the document's section and title. It may occur
anywhere in the document, although conventionally, it appears as the
first macro.
-.Pp
+. Pp
Beyond
-.Sq \&TH ,
+. Sq \&TH ,
at least one macro or text node must appear in the document. Documents
are generally structured as follows:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.TH FOO 1 "13 Aug 2009"
\&.
\&.SH NAME
@@ -147,308 +154,314 @@ The \efBfoo\efR utility does...
\&.\e\*q .SH AUTHORS
\&.\e\*q .SH CAVEATS
\&.\e\*q .SH BUGS
-.Ed
-.\" SECTION
+. Ed
+.
+.
.Sh MACRO SYNTAX
Macros are one to three three characters in length and begin with a
control character ,
-.Sq \&. ,
+. Sq \&. ,
at the beginning of the line. An arbitrary amount of whitespace may
sit between the control character and the macro name. Thus,
-.Sq \&.PP
+. Sq \&.PP
and
-.Sq \&.\ \ \ \&PP
+. Sq \&.\ \ \ \&PP
are equivalent.
-.Pp
+. Pp
The
-.Nm
+. Nm
macros are classified by scope: line scope or block scope. Line-scoped
macros are only scoped to the current line (and, in some situations,
the subsequent line). Block macros are scoped to the current line and
subsequent lines until closed by another block macro.
-.\" SUBSECTION
-.Ss Line Macros
+.
+.
+. Ss Line Macros
Line-macros are scoped to the current line, with the body consisting of
zero or more arguments. If a macro is next-line scoped and the line
arguments are empty, the next line is used instead. Thus:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.RI
foo
-.Ed
-.\" PARAGRAPH
-.Pp
+. Ed
+. Pp
is equivalent to
-.Sq \&.RI foo .
+. Sq \&.RI foo .
.\" PARAGRAPH
Consecutive next-line invocations are disallowed.
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.YO \(lBbody...\(rB
\(lBbody...\(rB
-.Ed
-.\" PARAGRAPH
-.Pp
-.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
-.It Em Macro Ta Em Arguments Ta Em Scope
-.It \&B Ta n Ta next-line
-.It \&BI Ta n Ta current
-.It \&BR Ta n Ta current
-.It \&I Ta n Ta next-line
-.It \&IB Ta n Ta current
-.It \&IR Ta n Ta current
-.It \&R Ta n Ta next-line
-.It \&RB Ta n Ta current
-.It \&RI Ta n Ta current
-.It \&SB Ta n Ta next-line
-.It \&SM Ta n Ta next-line
-.It \&TH Ta >1, <6 Ta current
-.It \&br Ta 0 Ta current
-.It \&fi Ta 0 Ta current
-.It \&i Ta n Ta current
-.It \&na Ta 0 Ta current
-.It \&nf Ta 0 Ta current
-.It \&r Ta 0 Ta current
-.It \&sp Ta 1 Ta current
-.El
-.\" PARAGRAPH
-.Pp
+. Ed
+. Pp
+. Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
+. It Em Macro Ta Em Arguments Ta Em Scope
+. It \&B Ta n Ta next-line
+. It \&BI Ta n Ta current
+. It \&BR Ta n Ta current
+. It \&I Ta n Ta next-line
+. It \&IB Ta n Ta current
+. It \&IR Ta n Ta current
+. It \&R Ta n Ta next-line
+. It \&RB Ta n Ta current
+. It \&RI Ta n Ta current
+. It \&SB Ta n Ta next-line
+. It \&SM Ta n Ta next-line
+. It \&TH Ta >1, <6 Ta current
+. It \&br Ta 0 Ta current
+. It \&fi Ta 0 Ta current
+. It \&i Ta n Ta current
+. It \&na Ta 0 Ta current
+. It \&nf Ta 0 Ta current
+. It \&r Ta 0 Ta current
+. It \&sp Ta 1 Ta current
+. El
+. Pp
The lower-case
-.Sq \&br ,
-.Sq \&fi ,
-.Sq \&i ,
-.Sq \&na ,
-.Sq \&nf ,
-.Sq \&r ,
+. Sq \&br ,
+. Sq \&fi ,
+. Sq \&i ,
+. Sq \&na ,
+. Sq \&nf ,
+. Sq \&r ,
and
-.Sq \&sp
+. Sq \&sp
macros aren't historically part of
-.Nm
+. Nm
and should not be used. They're included for compatibility.
-.\" SUBSECTION
-.Ss Block Macros
+.
+.
+. Ss Block Macros
Block macros are comprised of a head and body. The head is scoped to
the current line and, in one circumstance, the next line; the body is
scoped to subsequent lines and is closed out by a subsequent block macro
invocation.
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.YO \(lBhead...\(rB
\(lBhead...\(rB
\(lBbody...\(rB
-.Ed
-.\" PARAGRAPH
-.Pp
+. Ed
+. Pp
If a block macro is next-line scoped, it may only be followed by in-line
macros (excluding
-.Sq br ,
-.Sq na ,
-.Sq sp ,
-.Sq nf ,
-.Sq fi ,
+. Sq br ,
+. Sq na ,
+. Sq sp ,
+. Sq nf ,
+. Sq fi ,
and
-.Sq TH ) .
-.\" PARAGRAPH
-.Pp
-.Bl -column "MacroX" "Arguments" "ScopeXXXX" -compact -offset indent
-.It Em Macro Ta Em Arguments Ta Em Scope
-.It \&HP Ta <2 Ta current
-.It \&IP Ta <3 Ta current
-.It \&LP Ta 0 Ta current
-.It \&P Ta 0 Ta current
-.It \&PP Ta 0 Ta current
-.It \&SH Ta >0 Ta current
-.It \&SS Ta >0 Ta current
-.It \&TP Ta n Ta next-line
-.El
-.\" SECTION
+. Sq TH ) .
+. Pp
+. Bl -column "MacroX" "Arguments" "ScopeXXXX" -compact -offset indent
+. It Em Macro Ta Em Arguments Ta Em Scope
+. It \&HP Ta <2 Ta current
+. It \&IP Ta <3 Ta current
+. It \&LP Ta 0 Ta current
+. It \&P Ta 0 Ta current
+. It \&PP Ta 0 Ta current
+. It \&SH Ta >0 Ta current
+. It \&SS Ta >0 Ta current
+. It \&TP Ta n Ta next-line
+. El
+.
+.
.Sh REFERENCE
This section is a canonical reference to all macros, arranged
alphabetically. For the scoping of individual macros, see
-.Sx MACRO SYNTAX .
-.\" SUBSECTION
-.Ss Terms
+. Sx MACRO SYNTAX .
+.
+.
+. Ss Terms
In this reference, a numerical width may be either a standalone natural
number (such as 3, 4, 10, etc.) or a natural number followed by a width
multiplier
-.Qq n ,
+. Qq n ,
corresponding to the width of the formatted letter n, or
-.Qq m ,
+. Qq m ,
corresponding to the width of the formatted letter m. The latter is the
default, if unspecified. Thus,
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.HP 12n
-.Ed
-.Pp
+. Ed
+. Pp
indicates an offset of 12
-.Qq n
-.Ns -sized
+. Qq n
+. Ns -sized
letters.
-.\" SUBSECTION
-.Ss Macro Reference
-.Bl -tag -width Ds
-.It \&B
+.
+.
+. Ss Macro Reference
+. Bl -tag -width Ds
+. It \&B
Text is rendered in bold face.
-.It \&BI
+. It \&BI
Text is rendered alternately in bold face and italic. Thus,
-.Sq \&.BI this word and that
+. Sq \&.BI this word and that
causes
-.Sq this
+. Sq this
and
-.Sq and
+. Sq and
to render in bold face, while
-.Sq word
+. Sq word
and
-.Sq that
+. Sq that
render in italics. Whitespace between arguments is omitted in output.
-.It \&BR
+. It \&BR
Text is rendered alternately in bold face and roman (the default font).
Whitespace between arguments is omitted in output.
-.It \&HP
+. It \&HP
Begin a paragraph whose initial output line is left-justified, but
subsequent output lines are indented, with the following syntax:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.HP [width]
-.Ed
-.Pp
+. Ed
+. Pp
If
-.Va width
+. Va width
is specified, it's saved for later paragraph left-margins; if
unspecified, the saved or default width is used.
-.It \&I
+. It \&I
Text is rendered in italics.
-.It \&IB
+. It \&IB
Text is rendered alternately in italics and bold face. Whitespace
between arguments is omitted in output.
-.It \&IP
+. It \&IP
Begin a paragraph with the following syntax:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.IP [head [width]]
-.Ed
-.Pp
+. Ed
+. Pp
This follows the behaviour of the
-.Sq \&TP
+. Sq \&TP
except for the macro syntax (all arguments on the line, instead of
having next-line scope). If
-.Va width
+. Va width
is specified, it's saved for later paragraph left-margins; if
unspecified, the saved or default width is used.
-.It \&IR
+. It \&IR
Text is rendered alternately in italics and roman (the default font).
Whitespace between arguments is omitted in output.
-.It \&LP, \&P, \&PP
+. It \&LP, \&P, \&PP
Begin an undecorated paragraph. The scope of a paragraph is closed by a
subsequent paragraph, sub-section, section, or end of file. The saved
paragraph left-margin width is re-set to the default.
-.It \&R
+. It \&R
Text is rendered in roman (the default font).
-.It \&RB
+. It \&RB
Text is rendered alternately in roman (the default font) and bold face.
Whitespace between arguments is omitted in output.
-.It \&RI
+. It \&RI
Text is rendered alternately in roman (the default font) and italics.
Whitespace between arguments is omitted in output.
-.It \&SB
+. It \&SB
Text is rendered in small size (one point smaller than the default font)
bold face.
-.It \&SH
+. It \&SH
Begin a section. The scope of a section is only closed by another
section or the end of file. The paragraph left-margin width is re-set
to the default.
-.It \&SM
+. It \&SM
Text is rendered in small size (one point smaller than the default
font).
-.It \&SS
+. It \&SS
Begin a sub-section. The scope of a sub-section is closed by a
subsequent sub-section, section, or end of file. The paragraph
left-margin width is re-set to the default.
-.It \&TH
+. It \&TH
Sets the title of the manual page with the following syntax:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.TH title section date source volume
-.Ed
-.Pp
+. Ed
+. Pp
At least the
-.Va title
+. Va title
and
-.Va section
+. Va section
arguments must be provided. The
-.Va date
+. Va date
argument should be formatted as
-.Qq %b [%d] %Y
+. Qq %b [%d] %Y
format, described in
-.Xr strptime 3 .
+. Xr strptime 3 .
The
-.Va source
+. Va source
string specifies the organisation providing the utility. The
-.Va volume
+. Va volume
replaces the default rendered volume as dictated by the manual section.
-.It \&TP
+. It \&TP
Begin a paragraph where the head, if exceeding the indentation width, is
followed by a newline; if not, the body follows on the same line after a
buffer to the indentation width. Subsequent output lines are indented.
-.Pp
+. Pp
The indentation width may be set as follows:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.TP [width]
-.Ed
-.Pp
+. Ed
+. Pp
Where
-.Va width
+. Va width
must be a properly-formed numeric width. If
-.Va width
+. Va width
is specified, it's saved for later paragraph left-margins; if
unspecified, the saved or default width is used.
-.It \&br
+. It \&br
Breaks the current line. Consecutive invocations have no further effect.
-.It \&fi
+. It \&fi
End literal mode begun by
-.Sq \&nf .
-.It \&i
+. Sq \&nf .
+. It \&i
Italicise arguments. If no arguments are specified, all subsequent text
is italicised.
-.It \&na
+. It \&na
No alignment to the right margin.
-.It \&nf
+. It \&nf
Begin literal mode: all subsequent free-form lines have their end of
line boundaries preserved. May be ended by
-.Sq \&fi .
-.It \&r
+. Sq \&fi .
+. It \&r
Fonts and styles (bold face, italics) reset to roman (default font).
-.It \&sp
+. It \&sp
Insert n spaces, where n is the macro's positive numeric argument. If
0, this is equivalent to the
-.Sq br
+. Sq br
macro.
-.El
-.\" SECTION
+. El
+.
+.
.Sh COMPATIBILITY
This section documents compatibility with other roff implementations, at
this time limited to
-.Xr groff 1 .
-.Bl -hyphen
-.It
+. Xr groff 1 .
+. Bl -hyphen
+. 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.
-.It
+. It
The
-.Sq \&sp
+. Sq \&sp
macro does not accept negative numbers.
-.It
+. It
Blocks of whitespace are stripped from both macro and free-form text
lines (except when in literal mode), while groff would retain whitespace
in free-form text lines.
-.El
-.\" SECTION
+. El
+.
+.
.Sh SEE ALSO
-.Xr mandoc 1 ,
-.Xr mandoc_char 7
-.\" SECTION
+. Xr mandoc 1 ,
+. Xr mandoc_char 7
+.
+.
.Sh AUTHORS
The
-.Nm
+. Nm
reference was written by
-.An Kristaps Dzonsons Aq kristaps@kth.se .
-.\" SECTION
+. An Kristaps Dzonsons Aq kristaps@kth.se .
+.
+.
.Sh CAVEATS
Do not use this language. Use
-.Xr mdoc 7 ,
+. Xr mdoc 7 ,
instead.
+.
diff --git a/mdoc.7 b/mdoc.7
index ed77f450..44fd5faa 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -17,621 +17,610 @@
.Dd $Mdocdate$
.Dt MDOC 7
.Os
-.\" SECTION---------------------------------------------
+.
+.
.Sh NAME
-.Nm mdoc
-.Nd mdoc language reference
-.\" SECTION---------------------------------------------
+. Nm mdoc
+. Nd mdoc language reference
+.
+.
.Sh DESCRIPTION
The
-.Nm mdoc
+. Nm mdoc
language is used to format
-.Bx
-.Ux
+. Bx
+. Ux
manuals. In this reference document, we describe its syntax, structure,
and usage. Our reference implementation is
-.Xr mandoc 1 .
+. Xr mandoc 1 .
The
-.Sx COMPATIBILITY
+. Sx COMPATIBILITY
section describes compatibility with
-.Xr groff 1 .
-.\" PARAGRAPH------------
-.Pp
+. Xr groff 1 .
+. Pp
An
-.Nm
+. Nm
document follows simple rules: lines beginning with the control
character
-.Sq \.
+. Sq \.
are parsed for macros. Other lines are interpreted within the scope of
prior macros:
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.Sh Macro lines change control state.
Other lines are interpreted within the current state.
-.Ed
-.\" SECTION---------------------------------------------
+. Ed
+.
+.
.Sh LANGUAGE SYNTAX
-.Nm
+. Nm
documents may contain only graphable 7-bit ASCII characters, the space
character, and, in certain circumstances, the tab character. All
manuals must have
-.Ux
+. Ux
line terminators.
-.\" SUB-SECTION----------------------
-.Ss Comments
+.
+.
+. Ss Comments
Text following a
-.Sq \e" ,
+. Sq \e" ,
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,
-.Sq \&.\e" ,
+. Sq \&.\e" ,
is also ignored.
-.\" SUB-SECTION----------------------
-.Ss Reserved Characters
+.
+.
+. Ss Reserved Characters
Within a macro line, the following characters are reserved:
-.Bl -tag -width Ds -offset indent -compact
-.It \&.
-.Pq period
-.It \&,
-.Pq comma
-.It \&:
-.Pq colon
-.It \&;
-.Pq semicolon
-.It \&(
-.Pq left-parenthesis
-.It \&)
-.Pq right-parenthesis
-.It \&[
-.Pq left-bracket
-.It \&]
-.Pq right-bracket
-.It \&?
-.Pq question
-.It \&!
-.Pq exclamation
-.It \&|
-.Pq vertical bar
-.El
-.\" PARAGRAPH------------
-.Pp
+. Bl -tag -width Ds -offset indent -compact
+. It \&.
+. Pq period
+. It \&,
+. Pq comma
+. It \&:
+. Pq colon
+. It \&;
+. Pq semicolon
+. It \&(
+. Pq left-parenthesis
+. It \&)
+. Pq right-parenthesis
+. It \&[
+. Pq left-bracket
+. It \&]
+. Pq right-bracket
+. It \&?
+. Pq question
+. It \&!
+. Pq exclamation
+. It \&|
+. Pq vertical bar
+. El
+. Pp
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
with a non-breaking space
-.Pq Sq \e&
+. Pq Sq \e&
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.
Sequences begin with the escape character
-.Sq \e
+. Sq \e
followed by either an open-parenthesis
-.Sq \&(
+. Sq \&(
for two-character sequences; an open-bracket
-.Sq \&[
+. Sq \&[
for n-character sequences (terminated at a close-bracket
-.Sq \&] ) ;
+. Sq \&] ) ;
or a single one-character sequence. See
-.Xr mandoc_char 7
+. Xr mandoc_char 7
for a complete list. Examples include
-.Sq \e(em
-.Pq em-dash
+. Sq \e(em
+. Pq em-dash
and
-.Sq \ee
-.Pq back-slash .
-.\" SUB-SECTION----------------------
-.Ss Text Decoration
+. Sq \ee
+. Pq back-slash .
+.
+.
+. Ss Text Decoration
Terms may be text-decorated using the
-.Sq \ef
+. Sq \ef
escape followed by an indicator: B (bold), I, (italic), or P and R
(Roman, or reset). This form is not recommended for
-.Nm ,
+. Nm ,
which encourages semantic, not presentation, annotation.
-.\" SUB-SECTION----------------------
-.Ss Predefined Strings
+.
+.
+. Ss Predefined Strings
Historically,
-.Xr groff 1
+. Xr groff 1
also defined a set of package-specific
-.Dq predefined strings ,
+. Dq predefined strings ,
which, like
-.Sx Special Characters ,
+. Sx Special Characters ,
demark special output characters and strings by way of input codes.
Predefined strings are escaped with the slash-asterisk,
-.Sq \e* :
+. Sq \e* :
single-character
-.Sq \e*X ,
+. Sq \e*X ,
two-character
-.Sq \e*(XX ,
+. Sq \e*(XX ,
and N-character
-.Sq \e*[N] .
+. Sq \e*[N] .
See
-.Xr mandoc_char 7
+. Xr mandoc_char 7
for a complete list. Examples include
-.Sq \e*(Am
-.Pq ampersand
+. Sq \e*(Am
+. Pq ampersand
and
-.Sq \e*(Ba
-.Pq vertical bar .
-.\" SUB-SECTION----------------------
-.Ss Whitespace
+. Sq \e*(Ba
+. Pq vertical bar .
+.
+.
+. Ss Whitespace
In non-literal free-form lines, consecutive blocks of whitespace are
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.
\&.Bd \-literal
These are not.
\&.Ed
-.Ed
-.\" PARAGRAPH------------
-.Pp
+. Ed
+. Pp
In macro lines, whitespace delimits arguments and is discarded. If
arguments are quoted, whitespace within the quotes is retained.
-.\" PARAGRAPH------------
-.Pp
+. Pp
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
or when in a literal context.
-.\" SUB-SECTION----------------------
-.Ss Quotation
+.
+.
+. Ss Quotation
Macro arguments may be quoted with a double-quote to group
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
+. Pp
This produces tokens
-.Sq a" ,
-.Sq b c ,
-.Sq de ,
+. Sq a" ,
+. Sq b c ,
+. Sq de ,
and
-.Sq fg" .
+. 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
+. Sq \&Em a :
+. Bd -literal -offset indent
\&.Em "Em a"
-.Ed
-.\" PARAGRAPH------------
-.Pp
+. Ed
+. Pp
In free-form mode, quotes are regarded as opaque text.
-.\" SECTION---------------------------------------------
+.
+.
.Sh MANUAL STRUCTURE
Each
-.Nm
+. Nm
document must begin with a document prologue, containing, in order,
-.Sq \&Dd ,
-.Sq \&Dt ,
+. Sq \&Dd ,
+. Sq \&Dt ,
and
-.Sq \&Os ,
+. Sq \&Os ,
then the NAME section containing at least one
-.Sq \&Nm
+. Sq \&Nm
followed by
-.Sq \&Nd :
-.Bd -literal -offset indent
+. Sq \&Nd :
+. Bd -literal -offset indent
\&.Dd $\&Mdocdate$
\&.Dt mdoc 7
\&.Os
\&.Sh NAME
\&.Nm mdoc
\&.Nd mdoc language reference
-.Ed
-.\" PARAGRAPH------------
-.Pp
+. Ed
+. Pp
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
but non-compulsory.
-.\" SECTION---------------------------------------------
+.
+.
.Sh MACRO SYNTAX
-Every line beginning with the control character
-.Sq \.
-is processed for macros, two- or three-character sequences.
-.\" PARAGRAPH------------
-.Pp
+Macros are one to three three characters in length and begin with a
+control character ,
+. Sq \&. ,
+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
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
-.Sq parm
+. Sq parm
parameters;
-.Sq \&Yo
+. Sq \&Yo
opens the scope of a macro; and if specified,
-.Sq \&Yc
+. Sq \&Yc
closes it out.
-.\" PARAGRAPH------------
-.Pp
+. Pp
The
-.Em Callable
+. Em Callable
column indicates that the macro may be called subsequent to the initial
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
+. Sq \&.Fl Sh
produces
-.Sq Fl Sh .
-.\" PARAGRAPH------------
-.Pp
+. Sq Fl Sh .
+. Pp
The
-.Em Parsable
+. Em Parsable
column indicates whether the macro may be followed by further
(ostensibly callable) macros. If a macro is not parsable, subsequent
macro invocations on the line will be interpreted as opaque text.
-.\" PARAGRAPH------------
-.Pp
+. Pp
The
-.Em Scope
+. Em Scope
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
contains bodies; only
-.Pq Sq \&Bf
+. Pq Sq \&Bf
contains a head.
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
\(lBbody...\(rB
\&.Yc
-.Ed
-.\" PARAGRAPH------------
-.Pp
-.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
-.It \&Bd Ta \&No Ta \&No Ta closed by \&Ed
-.It \&Bf Ta \&No Ta \&No Ta closed by \&Ef
-.It \&Bk Ta \&No Ta \&No Ta closed by \&Ek
-.It \&Bl Ta \&No Ta \&No Ta closed by \&El
-.It \&Ed Ta \&No Ta \&No Ta opened by \&Bd
-.It \&Ef Ta \&No Ta \&No Ta opened by \&Bf
-.It \&Ek Ta \&No Ta \&No Ta opened by \&Bk
-.It \&El Ta \&No Ta \&No Ta opened by \&Bl
-.El
-.\" SUB-SECTION----------------------
-.Ss Block full-implicit
+. Ed
+. Pp
+. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
+. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
+. It \&Bd Ta \&No Ta \&No Ta closed by \&Ed
+. It \&Bf Ta \&No Ta \&No Ta closed by \&Ef
+. It \&Bk Ta \&No Ta \&No Ta closed by \&Ek
+. It \&Bl Ta \&No Ta \&No Ta closed by \&El
+. It \&Ed Ta \&No Ta \&No Ta opened by \&Bd
+. It \&Ef Ta \&No Ta \&No Ta opened by \&Bf
+. It \&Ek Ta \&No Ta \&No Ta opened by \&Bk
+. It \&El Ta \&No Ta \&No Ta opened by \&Bl
+. El
+.
+.
+. Ss Block full-implicit
Multi-line scope closed by end-of-file or implicitly by another macro.
All macros have bodies; some
-.Po
-.Sq \&It \-bullet ,
-.Sq \-hyphen ,
-.Sq \-dash ,
-.Sq \-enum ,
-.Sq \-item
-.Pc
+. Po
+. Sq \&It \-bullet ,
+. Sq \-hyphen ,
+. Sq \-dash ,
+. Sq \-enum ,
+. Sq \-item
+. Pc
don't have heads, while
-.Sq \&It \-column
+. Sq \&It \-column
may have multiple heads.
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
\(lBbody...\(rB
-.Ed
-.\" PARAGRAPH------------
-.Pp
-.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
-.It \&It Ta \&No Ta Yes Ta closed by \&It, \&El
-.It \&Nd 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
-.El
-.\" SUB-SECTION----------------------
-.Ss Block partial-explicit
+. Ed
+. Pp
+. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
+. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
+. It \&It Ta \&No Ta Yes Ta closed by \&It, \&El
+. It \&Nd 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
+. El
+.
+.
+. Ss Block partial-explicit
Like block full-explicit, but also with single-line scope. Each
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
-.Pq So \&Ec Sc .
-.Bd -literal -offset indent
+. Pq So \&Ec Sc .
+. Bd -literal -offset indent
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
\(lBbody...\(rB
\&.Yc \(lBtail...\(rB
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
\(lBbody...\(rB \&Yc \(lBtail...\(rB
-.Ed
-.\" PARAGRAPH------------
-.Pp
-.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
-.It \&Ac Ta Yes Ta Yes Ta opened by \&Ao
-.It \&Ao Ta Yes Ta Yes Ta closed by \&Ac
-.It \&Bc Ta Yes Ta Yes Ta closed by \&Bo
-.It \&Bo Ta Yes Ta Yes Ta opened by \&Bc
-.It \&Brc Ta Yes Ta Yes Ta opened by \&Bro
-.It \&Bro Ta Yes Ta Yes Ta closed by \&Brc
-.It \&Dc Ta Yes Ta Yes Ta opened by \&Do
-.It \&Do Ta Yes Ta Yes Ta closed by \&Dc
-.It \&Ec Ta Yes Ta Yes Ta opened by \&Eo
-.It \&Eo Ta Yes Ta Yes Ta closed by \&Ec
-.It \&Fc Ta Yes Ta Yes Ta opened by \&Fo
-.It \&Fo Ta \&No Ta \&No Ta closed by \&Fc
-.It \&Oc Ta Yes Ta Yes Ta closed by \&Oo
-.It \&Oo Ta Yes Ta Yes Ta opened by \&Oc
-.It \&Pc Ta Yes Ta Yes Ta closed by \&Po
-.It \&Po Ta Yes Ta Yes Ta opened by \&Pc
-.It \&Qc Ta Yes Ta Yes Ta opened by \&Oo
-.It \&Qo Ta Yes Ta Yes Ta closed by \&Oc
-.It \&Re Ta \&No Ta \&No Ta opened by \&Rs
-.It \&Rs Ta \&No Ta \&No Ta closed by \&Re
-.It \&Sc Ta Yes Ta Yes Ta opened by \&So
-.It \&So Ta Yes Ta Yes Ta closed by \&Sc
-.It \&Xc Ta Yes Ta Yes Ta opened by \&Xo
-.It \&Xo Ta Yes Ta Yes Ta closed by \&Xc
-.El
-.\" SUB-SECTION----------------------
-.Ss Block partial-implicit
+. Ed
+. Pp
+. Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
+. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
+. It \&Ac Ta Yes Ta Yes Ta opened by \&Ao
+. It \&Ao Ta Yes Ta Yes Ta closed by \&Ac
+. It \&Bc Ta Yes Ta Yes Ta closed by \&Bo
+. It \&Bo Ta Yes Ta Yes Ta opened by \&Bc
+. It \&Brc Ta Yes Ta Yes Ta opened by \&Bro
+. It \&Bro Ta Yes Ta Yes Ta closed by \&Brc
+. It \&Dc Ta Yes Ta Yes Ta opened by \&Do
+. It \&Do Ta Yes Ta Yes Ta closed by \&Dc
+. It \&Ec Ta Yes Ta Yes Ta opened by \&Eo
+. It \&Eo Ta Yes Ta Yes Ta closed by \&Ec
+. It \&Fc Ta Yes Ta Yes Ta opened by \&Fo
+. It \&Fo Ta \&No Ta \&No Ta closed by \&Fc
+. It \&Oc Ta Yes Ta Yes Ta closed by \&Oo
+. It \&Oo Ta Yes Ta Yes Ta opened by \&Oc
+. It \&Pc Ta Yes Ta Yes Ta closed by \&Po
+. It \&Po Ta Yes Ta Yes Ta opened by \&Pc
+. It \&Qc Ta Yes Ta Yes Ta opened by \&Oo
+. It \&Qo Ta Yes Ta Yes Ta closed by \&Oc
+. It \&Re Ta \&No Ta \&No Ta opened by \&Rs
+. It \&Rs Ta \&No Ta \&No Ta closed by \&Re
+. It \&Sc Ta Yes Ta Yes Ta opened by \&So
+. It \&So Ta Yes Ta Yes Ta closed by \&Sc
+. It \&Xc Ta Yes Ta Yes Ta opened by \&Xo
+. It \&Xo Ta Yes Ta Yes Ta closed by \&Xc
+. El
+.
+.
+. Ss Block partial-implicit
Like block full-implicit, but with single-line scope closed by
-.Sx Reserved Characters
+. Sx Reserved Characters
or end of line.
-.Bd -literal -offset indent
+. Bd -literal -offset indent
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
-.Ed
-.\" PARAGRAPH------------
-.Pp
-.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsable
-.It \&Aq Ta Yes Ta Yes
-.It \&Bq Ta Yes Ta Yes
-.It \&Brq Ta Yes Ta Yes
-.It \&D1 Ta \&No Ta \&Yes
-.It \&Dl Ta \&No Ta Yes
-.It \&Dq Ta Yes Ta Yes
-.It \&Op Ta Yes Ta Yes
-.It \&Pq Ta Yes Ta Yes
-.It \&Ql Ta Yes Ta Yes
-.It \&Qq Ta Yes Ta Yes
-.It \&Sq Ta Yes Ta Yes
-.El
-.\" SUB-SECTION----------------------
-.Ss In-line
+. Ed
+. Pp
+. Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
+. It Em Macro Ta Em Callable Ta Em Parsable
+. It \&Aq Ta Yes Ta Yes
+. It \&Bq Ta Yes Ta Yes
+. It \&Brq Ta Yes Ta Yes
+. It \&D1 Ta \&No Ta \&Yes
+. It \&Dl Ta \&No Ta Yes
+. It \&Dq Ta Yes Ta Yes
+. It \&Op Ta Yes Ta Yes
+. It \&Pq Ta Yes Ta Yes
+. It \&Ql Ta Yes Ta Yes
+. It \&Qq Ta Yes Ta Yes
+. It \&Sq Ta Yes Ta Yes
+. El
+.
+.
+. Ss In-line
Closed by
-.Sx Reserved Characters ,
+. Sx Reserved Characters ,
end of line, fixed argument lengths, and/or subsequent macros. In-line
macros have only text children. If a number (or inequality) of
arguments is
-.Pq n ,
+. Pq n ,
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 Yc...
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
-.Ed
-.\" PARAGRAPH------------
-.Pp
-.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
-.It \&%A Ta \&No Ta \&No Ta >0
-.It \&%B Ta \&No Ta \&No Ta >0
-.It \&%C Ta \&No Ta \&No Ta >0
-.It \&%D Ta \&No Ta \&No Ta >0
-.It \&%I Ta \&No Ta \&No Ta >0
-.It \&%J Ta \&No Ta \&No Ta >0
-.It \&%N Ta \&No Ta \&No Ta >0
-.It \&%O Ta \&No Ta \&No Ta >0
-.It \&%P Ta \&No Ta \&No Ta >0
-.It \&%R Ta \&No Ta \&No Ta >0
-.It \&%T Ta \&No Ta \&No Ta >0
-.It \&%V Ta \&No Ta \&No Ta >0
-.It \&Ad Ta Yes Ta Yes Ta n
-.It \&An Ta Yes Ta Yes Ta n
-.It \&Ap Ta Yes Ta Yes Ta 0
-.It \&Ar Ta Yes Ta Yes Ta n
-.It \&At Ta Yes Ta Yes Ta 1
-.It \&Bsx Ta Yes Ta Yes Ta n
-.It \&Bt Ta \&No Ta \&No Ta 0
-.It \&Bx Ta Yes Ta Yes Ta n
-.It \&Cd Ta Yes Ta Yes Ta >0
-.It \&Cm Ta Yes Ta Yes Ta n
-.It \&Db Ta \&No Ta \&No Ta 1
-.It \&Dd Ta \&No Ta \&No Ta >0
-.It \&Dt Ta \&No Ta \&No Ta n
-.It \&Dv Ta Yes Ta Yes Ta n
-.It \&Dx Ta Yes Ta Yes Ta n
-.It \&Em Ta Yes Ta Yes Ta >0
-.It \&En Ta \&No Ta \&No Ta 0
-.It \&Er Ta Yes Ta Yes Ta >0
-.It \&Es Ta \&No Ta \&No Ta 0
-.It \&Ev Ta Yes Ta Yes Ta n
-.It \&Ex Ta \&No Ta \&No Ta 0
-.It \&Fa Ta Yes Ta Yes Ta n
-.It \&Fd Ta \&No Ta \&No Ta >0
-.It \&Fl Ta Yes Ta Yes Ta n
-.It \&Fn Ta Yes Ta Yes Ta >0
-.It \&Fr Ta \&No Ta \&No Ta n
-.It \&Ft Ta Yes Ta Yes Ta n
-.It \&Fx Ta Yes Ta Yes Ta n
-.It \&Hf Ta \&No Ta \&No Ta n
-.It \&Ic Ta Yes Ta Yes Ta >0
-.It \&In Ta \&No Ta \&No Ta n
-.It \&Lb Ta \&No Ta \&No Ta 1
-.It \&Li Ta Yes Ta Yes Ta n
-.It \&Lk Ta Yes Ta Yes Ta n
-.It \&Lp Ta \&No Ta \&No Ta 0
-.It \&Ms Ta Yes Ta Yes Ta >0
-.It \&Mt Ta Yes Ta Yes Ta >0
-.It \&Nm Ta Yes Ta Yes Ta n
-.It \&No Ta Yes Ta Yes Ta 0
-.It \&Ns Ta Yes Ta Yes Ta 0
-.It \&Nx Ta Yes Ta Yes Ta n
-.It \&Os Ta \&No Ta \&No Ta n
-.It \&Ot Ta \&No Ta \&No Ta n
-.It \&Ox Ta Yes Ta Yes Ta n
-.It \&Pa Ta Yes Ta Yes Ta n
-.It \&Pf Ta \&No Ta Yes Ta 1
-.It \&Pp Ta \&No Ta \&No Ta 0
-.It \&Rv Ta \&No Ta \&No Ta 0
-.It \&Sm Ta \&No Ta \&No Ta 1
-.It \&St Ta \&No Ta Yes Ta 1
-.It \&Sx Ta Yes Ta Yes Ta >0
-.It \&Sy Ta Yes Ta Yes Ta >0
-.It \&Tn Ta Yes Ta Yes Ta >0
-.It \&Ud Ta \&No Ta \&No Ta 0
-.It \&Ux Ta Yes Ta Yes Ta n
-.It \&Va Ta Yes Ta Yes Ta n
-.It \&Vt Ta Yes Ta Yes Ta >0
-.It \&Xr Ta Yes Ta Yes Ta >0, <3
-.It \&br Ta \&No Ta \&No Ta 0
-.It \&sp Ta \&No Ta \&No Ta 1
-.El
-.\" SECTION---------------------------------------------
+. Ed
+. Pp
+. Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
+. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
+. It \&%A Ta \&No Ta \&No Ta >0
+. It \&%B Ta \&No Ta \&No Ta >0
+. It \&%C Ta \&No Ta \&No Ta >0
+. It \&%D Ta \&No Ta \&No Ta >0
+. It \&%I Ta \&No Ta \&No Ta >0
+. It \&%J Ta \&No Ta \&No Ta >0
+. It \&%N Ta \&No Ta \&No Ta >0
+. It \&%O Ta \&No Ta \&No Ta >0
+. It \&%P Ta \&No Ta \&No Ta >0
+. It \&%R Ta \&No Ta \&No Ta >0
+. It \&%T Ta \&No Ta \&No Ta >0
+. It \&%V Ta \&No Ta \&No Ta >0
+. It \&Ad Ta Yes Ta Yes Ta n
+. It \&An Ta Yes Ta Yes Ta n
+. It \&Ap Ta Yes Ta Yes Ta 0
+. It \&Ar Ta Yes Ta Yes Ta n
+. It \&At Ta Yes Ta Yes Ta 1
+. It \&Bsx Ta Yes Ta Yes Ta n
+. It \&Bt Ta \&No Ta \&No Ta 0
+. It \&Bx Ta Yes Ta Yes Ta n
+. It \&Cd Ta Yes Ta Yes Ta >0
+. It \&Cm Ta Yes Ta Yes Ta n
+. It \&Db Ta \&No Ta \&No Ta 1
+. It \&Dd Ta \&No Ta \&No Ta >0
+. It \&Dt Ta \&No Ta \&No Ta n
+. It \&Dv Ta Yes Ta Yes Ta n
+. It \&Dx Ta Yes Ta Yes Ta n
+. It \&Em Ta Yes Ta Yes Ta >0
+. It \&En Ta \&No Ta \&No Ta 0
+. It \&Er Ta Yes Ta Yes Ta >0
+. It \&Es Ta \&No Ta \&No Ta 0
+. It \&Ev Ta Yes Ta Yes Ta n
+. It \&Ex Ta \&No Ta \&No Ta 0
+. It \&Fa Ta Yes Ta Yes Ta n
+. It \&Fd Ta \&No Ta \&No Ta >0
+. It \&Fl Ta Yes Ta Yes Ta n
+. It \&Fn Ta Yes Ta Yes Ta >0
+. It \&Fr Ta \&No Ta \&No Ta n
+. It \&Ft Ta Yes Ta Yes Ta n
+. It \&Fx Ta Yes Ta Yes Ta n
+. It \&Hf Ta \&No Ta \&No Ta n
+. It \&Ic Ta Yes Ta Yes Ta >0
+. It \&In Ta \&No Ta \&No Ta n
+. It \&Lb Ta \&No Ta \&No Ta 1
+. It \&Li Ta Yes Ta Yes Ta n
+. It \&Lk Ta Yes Ta Yes Ta n
+. It \&Lp Ta \&No Ta \&No Ta 0
+. It \&Ms Ta Yes Ta Yes Ta >0
+. It \&Mt Ta Yes Ta Yes Ta >0
+. It \&Nm Ta Yes Ta Yes Ta n
+. It \&No Ta Yes Ta Yes Ta 0
+. It \&Ns Ta Yes Ta Yes Ta 0
+. It \&Nx Ta Yes Ta Yes Ta n
+. It \&Os Ta \&No Ta \&No Ta n
+. It \&Ot Ta \&No Ta \&No Ta n
+. It \&Ox Ta Yes Ta Yes Ta n
+. It \&Pa Ta Yes Ta Yes Ta n
+. It \&Pf Ta \&No Ta Yes Ta 1
+. It \&Pp Ta \&No Ta \&No Ta 0
+. It \&Rv Ta \&No Ta \&No Ta 0
+. It \&Sm Ta \&No Ta \&No Ta 1
+. It \&St Ta \&No Ta Yes Ta 1
+. It \&Sx Ta Yes Ta Yes Ta >0
+. It \&Sy Ta Yes Ta Yes Ta >0
+. It \&Tn Ta Yes Ta Yes Ta >0
+. It \&Ud Ta \&No Ta \&No Ta 0
+. It \&Ux Ta Yes Ta Yes Ta n
+. It \&Va Ta Yes Ta Yes Ta n
+. It \&Vt Ta Yes Ta Yes Ta >0
+. It \&Xr Ta Yes Ta Yes Ta >0, <3
+. It \&br Ta \&No Ta \&No Ta 0
+. It \&sp Ta \&No Ta \&No Ta 1
+. El
+.
+.
.Sh COMPATIBILITY
This section documents compatibility with other roff implementations, at
this time limited to
-.Xr groff 1 .
+. Xr groff 1 .
The term
-.Qq historic groff
+. Qq historic groff
refers to those versions before the
-.Pa doc.tmac
+. Pa doc.tmac
file re-write
-.Pq somewhere between 1.15 and 1.19 .
-.\" PARAGRAPH------------
-.Pp
-.Bl -dash -compact
-.\" LIST-ITEM
-.It
+. Pq somewhere between 1.15 and 1.19 .
+. Pp
+. Bl -dash -compact
+. It
The
-.Sq \-split
+. Sq \-split
or
-.Sq \-nosplit
+. Sq \-nosplit
argument to
-.Sq \&An
+. Sq \&An
applies to the whole document, not just to the current section as it
does in groff.
-.\" 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
+. It
The
-.Sq \&sp
+. Sq \&sp
macro does not accept negative numbers.
-.\" LIST-ITEM
-.It
+. It
Blocks of whitespace are stripped from both macro and free-form text
lines (except when in literal mode), while groff would retain whitespace
in free-form text lines.
-.\" LIST-ITEM
-.It
+. It
Historic groff has many un-callable macros. Most of these (excluding
some block-level macros) are now callable, conforming to the
non-historic groff version.
-.\" LIST-ITEM
-.It
+. It
The vertical bar
-.Sq \(ba
+. Sq \(ba
made historic groff
-.Qq go orbital
+. Qq go orbital
but is a proper delimiter in this implementation.
-.\" LIST-ITEM
-.It
-.Sq \&It \-nested
+. It
+. Sq \&It \-nested
is assumed for all lists (it wasn't in historic groff): any list may be
nested and
-.Sq \-enum
+. Sq \-enum
lists will restart the sequence only for the sub-list.
-.\" LIST-ITEM
-.It
-.Sq \&It \-column
+. It
+. Sq \&It \-column
syntax where column widths may be preceded by other arguments (instead
of proceeded) is not supported.
-.\" LIST-ITEM
-.It
+. It
The
-.Sq \&At
+. Sq \&At
macro only accepts a single parameter.
-.\" LIST-ITEM
-.It
+. It
Some manuals use
-.Sq \&Li
+. Sq \&Li
incorrectly by following it with a reserved character and expecting the
delimiter to render. This is not supported.
-.\" LIST-ITEM
-.It
+. It
In groff, the
-.Sq \&Fo
+. Sq \&Fo
macro only produces the first parameter. This is no longer the case.
-.El
-.\" SECTION---------------------------------------------
+. El
+.
+.
.Sh SEE ALSO
-.Xr mandoc 1 ,
-.Xr mandoc_char 7
-.\" SECTION---------------------------------------------
+. Xr mandoc 1 ,
+. Xr mandoc_char 7
+.
+.
.Sh AUTHORS
The
-.Nm
+. Nm
reference was written by
-.An Kristaps Dzonsons Aq kristaps@kth.se .
-.\" SECTION---------------------------------------------
+. An Kristaps Dzonsons Aq kristaps@kth.se .
+.
+.
.Sh CAVEATS
There are many ambiguous parts of mdoc.
-.\" PARAGRAPH------------
-.Pp
-.Bl -dash -compact
-.\" LIST-ITEM
-.It
-.Sq \&Fa
+. Pp
+. Bl -dash -compact
+. It
+. Sq \&Fa
should be
-.Sq \&Va
+. Sq \&Va
as function arguments are variables.
-.\" LIST-ITEM
-.It
-.Sq \&Ft
+. It
+. Sq \&Ft
should be
-.Sq \&Vt
+. Sq \&Vt
as function return types are still types. Furthermore, the
-.Sq \&Ft
+. Sq \&Ft
should be removed and
-.Sq \&Fo ,
+. Sq \&Fo ,
which ostensibly follows it, should follow the same convention as
-.Sq \&Va .
-.\" LIST-ITEM
-.It
-.Sq \&Va
+. Sq \&Va .
+. It
+. Sq \&Va
should formalise that only one or two arguments are acceptable: a
variable name and optional, preceding type.
-.\" LIST-ITEM
-.It
-.Sq \&Fd
+. It
+. Sq \&Fd
is ambiguous. It's commonly used to indicate an include file in the
synopsis section.
-.Sq \&In
+. Sq \&In
should be used, instead.
-.\" LIST-ITEM
-.It
+. It
Only the
-.Sq \-literal
+. Sq \-literal
argument to
-.Sq \&Bd
+. Sq \&Bd
makes sense. The remaining ones should be removed.
-.\" LIST-ITEM
-.It
+. It
The
-.Sq \&Xo
+. Sq \&Xo
and
-.Sq \&Xc
+. Sq \&Xc
macros should be deprecated.
-.\" LIST-ITEM
-.It
+. It
The
-.Sq \&Dt
+. Sq \&Dt
macro lacks clarity. It should be absolutely clear which title will
render when formatting the manual page.
-.\" LIST-ITEM
-.It
+. It
A
-.Sq \&Lx
+. Sq \&Lx
should be provided for Linux (\(`a la
-.Sq \&Ox ,
-.Sq \&Nx
+. Sq \&Ox ,
+. Sq \&Nx
etc.).
-.\" LIST-ITEM
-.It
+. It
There's no way to refer to references in
-.Sq \&Rs/Re
+. Sq \&Rs/Re
blocks.
-.\" LIST-ITEM
-.It
+. It
The \-split and \-nosplit dictates via
-.Sq \&An
+. Sq \&An
are re-set when entering and leaving the AUTHORS section.
-.El
+. El
+.
diff --git a/mdoc.c b/mdoc.c
index f518c37a..f9ae1ede 100644
--- a/mdoc.c
+++ b/mdoc.c
@@ -74,7 +74,6 @@ const char *const __mdoc_merrnames[MERRMAX] = {
"unclosed explicit scope", /* EOPEN */
"unterminated quoted phrase", /* EQUOTPHR */
"closure macro without prior context", /* ENOCTX */
- "invalid whitespace after control character", /* ESPACE */
"no description found for library" /* ELIB */
};
@@ -670,37 +669,40 @@ macrowarn(struct mdoc *m, int ln, const char *buf)
int
parsemacro(struct mdoc *m, int ln, char *buf)
{
- int i, c;
+ int i, j, c, ppos;
char mac[5];
/* Empty lines are ignored. */
- /* FIXME: this can accept `. xx' like libman! */
-
if (0 == buf[1])
return(1);
- if (' ' == buf[1]) {
- i = 2;
+ i = 1;
+
+ /* Accept whitespace after the initial control char. */
+
+ if (' ' == buf[i]) {
+ i++;
while (buf[i] && ' ' == buf[i])
i++;
if (0 == buf[i])
return(1);
- return(mdoc_perr(m, ln, 1, ESPACE));
}
+ ppos = i;
+
/* Copy the first word into a nil-terminated buffer. */
- for (i = 1; i < 5; i++) {
- if (0 == (mac[i - 1] = buf[i]))
+ for (j = 0; j < 4; j++, i++) {
+ if (0 == (mac[j] = buf[i]))
break;
else if (' ' == buf[i])
break;
}
- mac[i - 1] = 0;
+ mac[j] = 0;
- if (i == 5 || i <= 2) {
+ if (j == 4 || j < 2) {
if ( ! macrowarn(m, ln, mac))
goto err;
return(1);
@@ -721,7 +723,7 @@ parsemacro(struct mdoc *m, int ln, char *buf)
* Begin recursive parse sequence. Since we're at the start of
* the line, we don't need to do callable/parseable checks.
*/
- if ( ! mdoc_macro(m, c, ln, 1, &i, buf))
+ if ( ! mdoc_macro(m, c, ln, ppos, &i, buf))
goto err;
return(1);
@@ -731,3 +733,5 @@ err: /* Error out. */
m->flags |= MDOC_HALT;
return(0);
}
+
+