Fix in -Tascii where `Lb' causes line-break in any section (should only happen in...

[mandoc.git] / mdoc.7

diff --git a/mdoc.7 b/mdoc.7
index 1d95a6908f31301bbeb912b837a526b0e9cb2cad..f0864db818509d1e1edfb1258c280547daef881b 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\"    $Id: mdoc.7,v 1.48 2009/07/18 23:31:04 kristaps Exp $
+.\"    $Id: mdoc.7,v 1.59 2009/08/20 13:32:09 kristaps Exp $

 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"


@@ -13,34 +13,36 @@
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

-.\" 
-.Dd $Mdocdate: July 18 2009 $
+.\"
+.Dd $Mdocdate: August 20 2009 $

 .Dt MDOC 7
 .Os
 .Dt MDOC 7
 .Os

-.\" SECTION---------------------------------------------
+.
+.

 .Sh NAME
 .Nm mdoc
 .Nd mdoc language reference
 .Sh NAME
 .Nm mdoc
 .Nd mdoc language reference

-.\" SECTION---------------------------------------------
+.
+.

 .Sh DESCRIPTION
 The
 .Nm mdoc
 .Sh DESCRIPTION
 The
 .Nm mdoc

-language is used to format 
-.Bx 
+language is used to format
+.Bx

 .Ux
 manuals.  In this reference document, we describe its syntax, structure,
 and usage.  Our reference implementation is
 .Xr mandoc 1 .
 The
 .Sx COMPATIBILITY
 .Ux
 manuals.  In this reference document, we describe its syntax, structure,
 and usage.  Our reference implementation is
 .Xr mandoc 1 .
 The
 .Sx COMPATIBILITY

-section describes compatibility with 
+section describes compatibility with

 .Xr groff 1 .
 .Xr groff 1 .

-.\" PARAGRAPH------------
+.

 .Pp
 An
 .Nm
 document follows simple rules:  lines beginning with the control
 .Pp
 An
 .Nm
 document follows simple rules:  lines beginning with the control

-character 
+character

 .Sq \.
 are parsed for macros.  Other lines are interpreted within the scope of
 prior macros:
 .Sq \.
 are parsed for macros.  Other lines are interpreted within the scope of
 prior macros:


@@ -48,23 +50,27 @@ prior macros:
 \&.Sh Macro lines change control state.
 Other lines are interpreted within the current state.
 .Ed
 \&.Sh Macro lines change control state.
 Other lines are interpreted within the current state.
 .Ed

-.\" SECTION---------------------------------------------
+.
+.

 .Sh LANGUAGE SYNTAX
 .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
 .Sh LANGUAGE SYNTAX
 .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

-line terminators.  
-.\" SUB-SECTION----------------------
+line terminators.
+.
+.

 .Ss Comments
 Text following a
 .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" ,
 .Ss Comments
 Text following a
 .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" ,

-is also ignored.
-.\" SUB-SECTION----------------------
+is also ignored.  Macro lines with only a control charater and optionally
+whitespace are stripped from input.
+.
+.

 .Ss Reserved Characters
 Within a macro line, the following characters are reserved:
 .Bl -tag -width Ds -offset indent -compact
 .Ss Reserved Characters
 Within a macro line, the following characters are reserved:
 .Bl -tag -width Ds -offset indent -compact


@@ -87,129 +93,196 @@ Within a macro line, the following characters are reserved:
 .It \&?
 .Pq question
 .It \&!
 .It \&?
 .Pq question
 .It \&!

-.Pq exclamation 
+.Pq exclamation

 .It \&|
 .It \&|

-.Pq vertical bar 
+.Pq vertical bar

 .El
 .El

-.\" PARAGRAPH------------
+.

 .Pp
 Use of reserved characters is described in
 .Sx MACRO SYNTAX .
 For general use in macro lines, these characters must either be escaped
 with a non-breaking space
 .Pq Sq \e&
 .Pp
 Use of reserved characters is described in
 .Sx MACRO SYNTAX .
 For general use in macro lines, these characters must either be escaped
 with a non-breaking space
 .Pq Sq \e&

-or, if applicable, an appropriate escape sequence used.  
-.\" SUB-SECTION----------------------
+or, if applicable, an appropriate escape sequence used.
+.
+.

 .Ss Special Characters
 Special characters may occur in both macro and free-form lines.
 Sequences begin with the escape character
 .Sq \e
 .Ss Special Characters
 Special characters may occur in both macro and free-form lines.
 Sequences begin with the escape character
 .Sq \e

-followed by either an open-parenthesis 
+followed by either an open-parenthesis

 .Sq \&(
 for two-character sequences; an open-bracket
 .Sq \&[
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;
 or a single one-character sequence.  See
 .Sq \&(
 for two-character sequences; an open-bracket
 .Sq \&[
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;
 or a single one-character sequence.  See

-.Xr mandoc_char 1
-for a complete list.  Examples include 
-.Sq \e(em 
-.Pq em-dash 
-and 
+.Xr mandoc_char 7
+for a complete list.  Examples include
+.Sq \e(em
+.Pq em-dash
+and

 .Sq \ee
 .Pq back-slash .
 .Sq \ee
 .Pq back-slash .

-.\" PARAGRAPH------------
-.Pp
-An alternative escape sequence is
-the slash-asterisk,
-.Sq \e* ,
-but this method is discouraged for compatibility reasons.
-.\" PARAGRAPH------------
-.Pp
-Terms may
-also be text-decorated using the
+.
+.
+.Ss Text Decoration
+Terms may be text-decorated using the

 .Sq \ef
 escape followed by an indicator: B (bold), I, (italic), or P and R
 .Sq \ef
 escape followed by an indicator: B (bold), I, (italic), or P and R

-(Roman, or reset).  This form is not recommended.
-.\" SUB-SECTION----------------------
+(Roman, or reset).  This form is not recommended for 
+.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
 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
 These     spaces   are    pruned       from    input.
 .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
 These     spaces   are    pruned       from    input.

-\&.Bd \-literal 
+\&.Bd \-literal

 These         are              not.
 \&.Ed
 .Ed
 These         are              not.
 \&.Ed
 .Ed

-.\" PARAGRAPH------------
+.

 .Pp
 In macro lines, whitespace delimits arguments and is discarded.  If
 arguments are quoted, whitespace within the quotes is retained.
 .Pp
 In macro lines, whitespace delimits arguments and is discarded.  If
 arguments are quoted, whitespace within the quotes is retained.

-.\" PARAGRAPH------------
+.

 .Pp
 Blank lines are only permitted within literal contexts, as are lines
 containing only whitespace.  Tab characters are only acceptable when
 .Pp
 Blank lines are only permitted within literal contexts, as are lines
 containing only whitespace.  Tab characters are only acceptable when

-delimiting 
+delimiting

 .Sq \&Bl \-column
 or when in a literal context.
 .Sq \&Bl \-column
 or when in a literal context.

-.\" SUB-SECTION----------------------
+.
+.

 .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
 .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------------
+the literal, regardless of surrounding whitespace.
+.

 .Pp
 .Pp

-This produces tokens 
+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
 .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 
+considered literal text.  Thus, the following produces

 .Sq \&Em a :
 .Bd -literal -offset indent
 \&.Em "Em a"
 .Ed
 .Sq \&Em a :
 .Bd -literal -offset indent
 \&.Em "Em a"
 .Ed

-.\" PARAGRAPH------------
+.

 .Pp
 In free-form mode, quotes are regarded as opaque text.
 .Pp
 In free-form mode, quotes are regarded as opaque text.

-.\" SECTION---------------------------------------------
+.
+.

 .Sh MANUAL STRUCTURE
 Each
 .Nm
 .Sh MANUAL STRUCTURE
 Each
 .Nm

-document must begin with a document prologue, containing, in order, 
+document must begin with a document prologue, containing, in order,

 .Sq \&Dd ,
 .Sq \&Dt ,
 and
 .Sq \&Os ,
 then the NAME section containing at least one
 .Sq \&Nm
 .Sq \&Dd ,
 .Sq \&Dt ,
 and
 .Sq \&Os ,
 then the NAME section containing at least one
 .Sq \&Nm

-followed by 
+followed by

 .Sq \&Nd :
 .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$
 \&.Dt mdoc 7
 \&.Os
 .Sq \&Nd :
 .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$
 \&.Dt mdoc 7
 \&.Os

+\&.

 \&.Sh NAME
 \&.Sh NAME

-\&.Nm mdoc
-\&.Nd mdoc language reference
+\&.Nm foo
+\&.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
 Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
 .Pp
 Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,

-but non-compulsory. 
-.\" SECTION---------------------------------------------
+but non-compulsory.
+.
+.

 .Sh MACRO SYNTAX
 .Sh MACRO SYNTAX

-Every line beginning with the control character 
-.Sq \.
-is processed for macros, two- or three-character sequences.
-.\" PARAGRAPH------------
+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,
 .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
 parameters;
 refers to macro arguments, which may be followed by zero or more
 .Sq parm
 parameters;


@@ -217,29 +290,41 @@ parameters;
 opens the scope of a macro; and if specified,
 .Sq \&Yc
 closes it out.
 opens the scope of a macro; and if specified,
 .Sq \&Yc
 closes it out.

-.\" PARAGRAPH------------
+.

 .Pp
 The
 .Em Callable
 column indicates that the macro may be called subsequent to the initial
 .Pp
 The
 .Em Callable
 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
 column indicates whether the macro may be followed by further
 .Em Parsable
 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
 column, if applicable, describes closure rules.
 .Em Scope
 column, if applicable, describes closure rules.

-.\" SUB-SECTION----------------------
+.
+.

 .Ss Block full-explicit
 Multi-line scope closed by an explicit closing macro.  All macros
 contains bodies; only
 .Pq Sq \&Bf
 contains a head.
 .Bd -literal -offset indent
 .Ss Block full-explicit
 Multi-line scope closed by an explicit closing macro.  All macros
 contains bodies; only
 .Pq Sq \&Bf
 contains a head.
 .Bd -literal -offset indent

-\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB 
-\(lBbody...\(rB 
+\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
+\(lBbody...\(rB

 \&.Yc
 .Ed
 \&.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
 .Pp
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope


@@ -252,25 +337,26 @@ contains a head.
 .It \&Ek     Ta    \&No     Ta    \&No     Ta    opened by \&Bk
 .It \&El     Ta    \&No     Ta    \&No     Ta    opened by \&Bl
 .El
 .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
 Multi-line scope closed by end-of-file or implicitly by another macro.
 .Ss Block full-implicit
 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 \-hyphen , 
+.Sq \&It \-bullet ,
+.Sq \-hyphen ,

 .Sq \-dash ,
 .Sq \-enum ,
 .Sq \-dash ,
 .Sq \-enum ,

-.Sq \-item 
+.Sq \-item

 .Pc
 .Pc

-don't have heads, while 
+don't have heads, while

 .Sq \&It \-column
 may have multiple heads.
 .Bd -literal -offset indent
 .Sq \&It \-column
 may have multiple heads.
 .Bd -literal -offset indent

-\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB 
-\(lBbody...\(rB 
+\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
+\(lBbody...\(rB

 .Ed
 .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
 .Pp
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope


@@ -279,22 +365,23 @@ may have multiple heads.
 .It \&Sh     Ta    \&No     Ta    \&No     Ta    closed by \&Sh
 .It \&Ss     Ta    \&No     Ta    \&No     Ta    closed by \&Sh, \&Ss
 .El
 .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
 Like block full-explicit, but also with single-line scope.  Each
 .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 
+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 .
 .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

 
 \&.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
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope


@@ -323,15 +410,16 @@ and/or tail
 .It \&Xc     Ta    Yes      Ta    Yes      Ta    opened by \&Xo
 .It \&Xo     Ta    Yes      Ta    Yes      Ta    closed by \&Xc
 .El
 .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
 .Ss Block partial-implicit

-Like block full-implicit, but with single-line scope closed by 
-.Sx Reserved Characters 
+Like block full-implicit, but with single-line scope closed by
+.Sx Reserved Characters

 or end of line.
 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
 .Ed
 or end of line.
 .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
 .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable


@@ -347,14 +435,15 @@ or end of line.
 .It \&Qq     Ta    Yes      Ta    Yes
 .It \&Sq     Ta    Yes      Ta    Yes
 .El
 .It \&Qq     Ta    Yes      Ta    Yes
 .It \&Sq     Ta    Yes      Ta    Yes
 .El

-.\" SUB-SECTION----------------------
+.
+.

 .Ss In-line
 .Ss In-line

-Closed by 
+Closed by

 .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
 .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
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
 then the macro accepts an arbitrary number of arguments.
 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb


@@ -363,7 +452,7 @@ then the macro accepts an arbitrary number of arguments.
 
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
 .Ed
 
 \&.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
 .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments


@@ -387,7 +476,7 @@ then the macro accepts an arbitrary number of arguments.
 .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 \&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    \&No     Ta    >0
+.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 \&Cm     Ta    Yes      Ta    Yes      Ta    n
 .It \&Db     Ta    \&No     Ta    \&No     Ta    1
 .It \&Dd     Ta    \&No     Ta    \&No     Ta    >0


@@ -399,7 +488,7 @@ then the macro accepts an arbitrary number of arguments.
 .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 \&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 \&Ex     Ta    \&No     Ta    \&No     Ta    n

 .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 \&Fa     Ta    Yes      Ta    Yes      Ta    n
 .It \&Fd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&Fl     Ta    Yes      Ta    Yes      Ta    n


@@ -426,7 +515,7 @@ then the macro accepts an arbitrary number of arguments.
 .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 \&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 \&Rv     Ta    \&No     Ta    \&No     Ta    n

 .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 \&Sm     Ta    \&No     Ta    \&No     Ta    1
 .It \&St     Ta    \&No     Ta    Yes      Ta    1
 .It \&Sx     Ta    Yes      Ta    Yes      Ta    >0


@@ -439,115 +528,101 @@ then the macro accepts an arbitrary number of arguments.
 .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
 .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---------------------------------------------
+.El   
+.
+.

 .Sh COMPATIBILITY
 This section documents compatibility with other roff implementations, at
 .Sh COMPATIBILITY
 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------------
+.

 .Pp
 .Bl -dash -compact
 .Pp
 .Bl -dash -compact

-.\" LIST-ITEM
+.It
+The
+.Sq \-split
+or
+.Sq \-nosplit
+argument to 
+.Sq \&An
+applies to the whole document, not just to the current section as it
+does in groff.

 .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
 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 
+The

 .Sq \&sp
 macro does not accept negative numbers.
 .Sq \&sp
 macro does not accept negative numbers.

-.\" LIST-ITEM
-.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
 lines (except when in literal mode), while groff would retain whitespace
 in free-form text lines.
 .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
 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.
 .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 
+The vertical bar

 .Sq \(ba
 made historic groff
 .Qq go orbital
 but is a proper delimiter in this implementation.
 .Sq \(ba
 made historic groff
 .Qq go orbital
 but is a proper delimiter in this implementation.

-.\" LIST-ITEM

 .It
 .Sq \&It \-nested
 is assumed for all lists (it wasn't in historic groff): any list may be
 nested and
 .Sq \-enum
 lists will restart the sequence only for the sub-list.
 .It
 .Sq \&It \-nested
 is assumed for all lists (it wasn't in historic groff): any list may be
 nested and
 .Sq \-enum
 lists will restart the sequence only for the sub-list.

-.\" LIST-ITEM

 .It
 .Sq \&It \-column
 syntax where column widths may be preceded by other arguments (instead
 of proceeded) is not supported.
 .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 
+The

 .Sq \&At
 macro only accepts a single parameter.
 .Sq \&At
 macro only accepts a single parameter.

-.\" LIST-ITEM

 .It
 Some manuals use
 .Sq \&Li
 incorrectly by following it with a reserved character and expecting the
 delimiter to render.  This is not supported.
 .It
 Some manuals use
 .Sq \&Li
 incorrectly by following it with a reserved character and expecting the
 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
 macro only produces the first parameter.  This is no longer the case.
 .El
 .Sq \&Fo
 macro only produces the first parameter.  This is no longer the case.
 .El

-.\" SECTION---------------------------------------------
+.
+.

 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr mandoc_char 7
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr mandoc_char 7

-.\" SECTION---------------------------------------------
+.
+.

 .Sh AUTHORS
 The
 .Nm
 .Sh AUTHORS
 The
 .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
 There are many ambiguous parts of mdoc.
 .Sh CAVEATS
 There are many ambiguous parts of mdoc.

-.\" PARAGRAPH------------
+.

 .Pp
 .Bl -dash -compact
 .Pp
 .Bl -dash -compact

-.\" LIST-ITEM

 .It
 .Sq \&Fa
 .It
 .Sq \&Fa

-should be 
+should be

 .Sq \&Va
 as function arguments are variables.
 .Sq \&Va
 as function arguments are variables.

-.\" LIST-ITEM

 .It
 .Sq \&Ft
 should be
 .It
 .Sq \&Ft
 should be


@@ -558,54 +633,47 @@ should be removed and
 .Sq \&Fo ,
 which ostensibly follows it, should follow the same convention as
 .Sq \&Va .
 .Sq \&Fo ,
 which ostensibly follows it, should follow the same convention as
 .Sq \&Va .

-.\" LIST-ITEM

 .It
 .Sq \&Va
 should formalise that only one or two arguments are acceptable: a
 variable name and optional, preceding type.
 .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
 is ambiguous.  It's commonly used to indicate an include file in the
 .It
 .Sq \&Fd
 is ambiguous.  It's commonly used to indicate an include file in the

-synopsis section.  
+synopsis section.

 .Sq \&In
 should be used, instead.
 .Sq \&In
 should be used, instead.

-.\" LIST-ITEM

 .It
 Only the
 .Sq \-literal
 argument to
 .Sq \&Bd
 makes sense.  The remaining ones should be removed.
 .It
 Only the
 .Sq \-literal
 argument to
 .Sq \&Bd
 makes sense.  The remaining ones should be removed.

-.\" LIST-ITEM

 .It
 .It

-The 
+The

 .Sq \&Xo
 and
 .Sq \&Xc
 macros should be deprecated.
 .Sq \&Xo
 and
 .Sq \&Xc
 macros should be deprecated.

-.\" LIST-ITEM

 .It
 The
 .Sq \&Dt
 macro lacks clarity.  It should be absolutely clear which title will
 render when formatting the manual page.
 .It
 The
 .Sq \&Dt
 macro lacks clarity.  It should be absolutely clear which title will
 render when formatting the manual page.

-.\" LIST-ITEM

 .It
 A
 .Sq \&Lx
 .It
 A
 .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

 .It
 There's no way to refer to references in
 .Sq \&Rs/Re
 blocks.
 .It
 There's no way to refer to references in
 .Sq \&Rs/Re
 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

+.