[BACK]Return to mdoc.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.2 and 1.56

version 1.2, 2009/03/13 09:08:59 version 1.56, 2009/08/18 14:27:16
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the  .\" purpose with or without fee is hereby granted, provided that the above
 .\" above copyright notice and this permission notice appear in all  .\" copyright notice and this permission notice appear in all copies.
 .\" copies.  
 .\"  .\"
 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL  .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED  .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE  .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL  .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR  .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" PERFORMANCE OF THIS SOFTWARE.  .\"
 .\"  
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt mdoc 7  .Dt MDOC 7
 .Os  .Os
 .\" SECTION  .
   .
 .Sh NAME  .Sh NAME
 .Nm mdoc  . Nm mdoc
 .Nd mdoc macro reference  . Nd mdoc language reference
 .\" SECTION  .
   .
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mdoc  . Nm mdoc
 language is used to format  language is used to format
 .Bx  . Bx
 .Ux  . Ux
 manuals.  An  manuals.  In this reference document, we describe its syntax, structure,
 .Nm  and usage.  Our reference implementation is
   . Xr mandoc 1 .
   The
   . Sx COMPATIBILITY
   section describes compatibility with
   . Xr groff 1 .
   . Pp
   An
   . Nm
 document follows simple rules:  lines beginning with the control  document follows simple rules:  lines beginning with the control
 character  character
 .Sq \.  . Sq \.
 are parsed for macros.  Other lines are interpreted within the scope of  are parsed for macros.  Other lines are interpreted within the scope of
 prior macros.  Macros are either two or three characters in length.  prior macros:
 .\" SECTION  . Bd -literal -offset indent
 .Sh CHARACTER ENCODING  \&.Sh Macro lines change control state.
 .Nm  Other lines are interpreted within the current state.
 documents may contain only printable alphanumeric characters, the space  . Ed
 character  .
 .Sq \  ,  .
 and, in certain circumstances, the tab character  .Sh LANGUAGE SYNTAX
 .Sq \et .  . Nm
 All manuals must have  documents may contain only graphable 7-bit ASCII characters, the space
 .Sq \en  character, and, in certain circumstances, the tab character.  All
 line termination.  manuals must have
 .\" SUB-SECTION  . Ux
 .Ss Reserved Characters  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" ,
   is also ignored.
   .
   .
   . Ss Reserved Characters
 Within a macro line, the following characters are reserved:  Within a macro line, the following characters are reserved:
 .Bl -tag -width 12n -offset XXXX -compact  .  Bl -tag -width Ds -offset indent -compact
 .It \&.  .   It \&.
 .Pq period  .    Pq period
 .It \&,  .   It \&,
 .Pq comma  .    Pq comma
 .It \&:  .   It \&:
 .Pq colon  .    Pq colon
 .It \&;  .   It \&;
 .Pq semicolon  .    Pq semicolon
 .It \&(  .   It \&(
 .Pq left-parenthesis  .    Pq left-parenthesis
 .It \&)  .   It \&)
 .Pq right-parenthesis  .    Pq right-parenthesis
 .It \&[  .   It \&[
 .Pq left-bracket  .    Pq left-bracket
 .It \&]  .   It \&]
 .Pq right-bracket  .    Pq right-bracket
 .It \&?  .   It \&?
 .Pq question  .    Pq question
 .It \&!  .   It \&!
 .Pq exclmamation  .    Pq exclamation
 .El  .   It \&|
 .Pp  .    Pq vertical bar
 Use of these characters must either be escaped with a non-breaking space  .  El
 .Pq Sq \e&  .  Pp
 or, if applicable, an appropriate escape-sequence used.  Use of reserved  Use of reserved characters is described in
 characters is described later in this document.  .  Sx MACRO SYNTAX .
 .\" SUB-SECTION  For general use in macro lines, these characters must either be escaped
 .Ss Special Characters  with a non-breaking space
 Special character sequences begin with the escape character  .  Pq Sq \e&
 .Sq \\  or, if applicable, an appropriate escape sequence used.
 and followed by either an open-parenthesis  .
 .Sq \&(  .
   . 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
   .  Sq \&(
 for two-character sequences; an open-bracket  for two-character sequences; an open-bracket
 .Sq \&[  .  Sq \&[
 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.  or a single one-character sequence.  See
 .Pp  .  Xr mandoc_char 7
 Characters may alternatively be escaped by a slash-asterisk,  for a complete list.  Examples include
 .Sq \\* ,  .  Sq \e(em
 with the same combinations as described above.  This form, however, is  .  Pq em-dash
 deprecated.  The following is a table of all available escapes, arranged  and
 by classification.  .  Sq \ee
 .Pp  .  Pq back-slash .
 Grammatic:  .
 .Bl -tag -width 12n -offset "XXXX" -compact  .
 .It \\(em  . Ss Text Decoration
 .Pq em-dash  Terms may be text-decorated using the
 .It \\(en  .  Sq \ef
 .Pq en-dash  escape followed by an indicator: B (bold), I, (italic), or P and R
 .It \e-  (Roman, or reset).  This form is not recommended for
 .Pq hyphen  .  Nm ,
 .It \\\\  which encourages semantic, not presentation, annotation.
 .Pq back-slash  .
 .It \e'  .
 .Pq apostrophe  . Ss Predefined Strings
 .It \e`  Historically,
 .Pq back-tick  .  Xr groff 1
 .It \\  also defined a set of package-specific
 .Pq space  .  Dq predefined strings ,
 .It \\.  which, like
 .Pq period  .  Sx Special Characters ,
 .El  demark special output characters and strings by way of input codes.
 .\" PARAGRAPH  Predefined strings are escaped with the slash-asterisk,
 .Pp  .  Sq \e* :
 Enclosures:  single-character
 .Bl -tag -width 12n -offset "XXXX" -compact  .  Sq \e*X ,
 .It \\(rC  two-character
 .Pq right brace  .  Sq \e*(XX ,
 .It \\(lC  and N-character
 .Pq left brace  .  Sq \e*[N] .
 .It \\(ra  See
 .Pq right angle  .  Xr mandoc_char 7
 .It \\(la  for a complete list.  Examples include
 .Pq left angle  .  Sq \e*(Am
 .It \\(rB  .  Pq ampersand
 .Pq right bracket  and
 .It \\(lB  .  Sq \e*(Ba
 .Pq left bracket  .  Pq vertical bar .
 .It \\q  .
 .Pq double-quote  .
 .It \\(lq  . Ss Whitespace
 .Pq left double-quote  In non-literal free-form lines, consecutive blocks of whitespace are
 .It \\(Lq  pruned from input and added later in the output filter, if applicable:
 .Pq left double-quote, deprecated  .  Bd -literal -offset indent
 .It \\(rq  These     spaces   are    pruned       from    input.
 .Pq right double-quote  \&.Bd \-literal
 .It \\(Rq  These         are              not.
 .Pq right double-quote, deprecated  \&.Ed
 .It \\(oq  .  Ed
 .Pq left single-quote  .  Pp
 .It \\(aq  In macro lines, whitespace delimits arguments and is discarded.  If
 .Pq right single-quote  arguments are quoted, whitespace within the quotes is retained.
 .El  .  Pp
 .\" PARAGRAPH  Blank lines are only permitted within literal contexts, as are lines
 .Pp  containing only whitespace.  Tab characters are only acceptable when
 Indicatives:  delimiting
 .Bl -tag -width 12n -offset "XXXX" -compact  .  Sq \&Bl \-column
 .It \\(<-  or when in a literal context.
 .Pq left arrow  .
 .It \\(->  .
 .Pq right arrow  . Ss Quotation
 .It \\(ua  Macro arguments may be quoted with a double-quote to group
 .Pq up arrow  space-delimited terms or to retain blocks of whitespace.  A quoted
 .It \\(da  argument begins with a double-quote preceded by whitespace.  The next
 .Pq down arrow  double-quote not pair-wise adjacent to another double-quote terminates
 .El  the literal, regardless of surrounding whitespace.
 .\" PARAGRAPH  .  Pp
 .Pp  This produces tokens
 Mathematical:  .  Sq a" ,
 .Bl -tag -width 12n -offset "XXXX" -compact  .  Sq b c ,
 .It \\(Gt  .  Sq de ,
 .Pq greater-than, deprecated  and
 .It \\(Lt  .  Sq fg" .
 .Pq less-than, deprecated  Note that any quoted term, be it argument or macro, is indiscriminately
 .It \\(<=  considered literal text.  Thus, the following produces
 .Pq less-than-equal  .  Sq \&Em a :
 .It \\(Le  .  Bd -literal -offset indent
 .Pq less-than-equal, deprecated  \&.Em "Em a"
 .It \\(>=  .  Ed
 .Pq greater-than-equal  .  Pp
 .It \\(Ge  In free-form mode, quotes are regarded as opaque text.
 .Pq greater-than-equal  .
 .It \\(==  .
 .Pq equal  .Sh MANUAL STRUCTURE
 .It \\(!=  Each
 .Pq not equal  . Nm
 .It \\(Ne  document must begin with a document prologue, containing, in order,
 .Pq not equal, deprecated  . Sq \&Dd ,
 .It \\(if  . Sq \&Dt ,
 .Pq infinity  and
 .It \\(If  . Sq \&Os ,
 .Pq infinity, deprecated  then the NAME section containing at least one
 .It \\(na  . Sq \&Nm
 .Pq NaN , an extension  followed by
 .It \\(Na  . Sq \&Nd :
 .Pq NaN, deprecated  . Bd -literal -offset indent
 .It \\(+-  \&.Dd $\&Mdocdate$
 .Pq plus-minus  \&.Dt mdoc 7
 .It \\(Pm  \&.Os
 .Pq plus-minus, deprecated  \&.Sh NAME
 .It \\(**  \&.Nm mdoc
 .Pq asterisk  \&.Nd mdoc language reference
 .El  . Ed
 .\" PARAGRAPH  . Pp
 .Pp  Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
 Diacritics:  but non-compulsory.
 .Bl -tag -width 12n -offset "XXXX" -compact  .
 .It \\(ga  .
 .Pq accent grave  .Sh MACRO SYNTAX
 .It \\(aa  Macros are one to three three characters in length and begin with a
 .Pq accent accute  control character ,
 .El  . Sq \&. ,
 .\" PARAGRAPH  at the beginning of the line.  An arbitrary amount of whitespace may
 .Pp  sit between the control character and the macro name.  Thus,
 Special symbols:  . Sq \&.Pp
 .Bl -tag -width 12n -offset "XXXX" -compact  and
 .It \\(bu  . Sq \&.\ \ \ \&Pp
 .Pq bullet  are equivalent.  Macro names are two or three characters in length.
 .It \\(ba  . Pp
 .Pq bar  The syntax of a macro depends on its classification.  In this section,
 .It \\(Ba  . Sq \-arg
 .Pq bar, deprecated  refers to macro arguments, which may be followed by zero or more
 .It \\(co  . Sq parm
 .Pq copyright  parameters;
 .It \\&  . Sq \&Yo
 .Pq non-breaking space  opens the scope of a macro; and if specified,
 .It \\e  . Sq \&Yc
 .Pq escape  closes it out.
 .It \\(Am  . Pp
 .Pq ampersand, deprecated  The
 .El  . Em Callable
 .\" SECTION  column indicates that the macro may be called subsequent to the initial
 .Sh ONTOLOGY  line-macro.  If a macro is not callable, then its invocation after the
 Macros are classified in an ontology described by scope rules.  initial line macro is interpreted as opaque text, such that
 .Bl -inset  . Sq \&.Fl Sh
 .\" LIST-ITEM  produces
 .It Em Block  . Sq Fl Sh .
 macros enclose other block macros, in-line macros or text, and  . Pp
 may span multiple lines.  The
 .Qq Implicit  . Em Parsable
 block scope is closed by a subsequent invocation of the same macro,  column indicates whether the macro may be followed by further
 one of a set of corresponding closure macros or end-of-file.  (ostensibly callable) macros.  If a macro is not parsable, subsequent
 .Qq Explicit  macro invocations on the line will be interpreted as opaque text.
 block scope is closed by a corresponding closure macro.  . Pp
 .Bl -inset -offset XXXX  The
 .\" LIST-ITEM  . Em Scope
 .It Em Full-block  column, if applicable, describes closure rules.
 macros always span multiple lines.  They consist optionally of one or  .
 more  .
 .Qq heads ,  . Ss Block full-explicit
 subsequent macros or text on the same line following invocation; a  Multi-line scope closed by an explicit closing macro.  All macros
 .Qq body ,  contains bodies; only
 which spans subsequent lines of text or macros; and an optional  .  Pq Sq \&Bf
 .Qq tail ,  contains a head.
 macros or text on the same line following closure.  .  Bd -literal -offset indent
 .\" LIST-ITEM  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 .It Em Partial-block  
 macros may span multiple lines.  They consists optionally of a  
 .Qq head ,  
 text immediately following invocation; always a  
 .Qq body ,  
 text or macros following the head on the same and subsequent lines; and  
 optionally a  
 .Qq tail ,  
 text immediately following closure.  
 .El  
 .\" LIST-ITEM  
 .It Em In-line  
 macros may only enclose text and span at most a single line.  If  
 a macro is parsable, its scope may be closed by subsequent macros or  
 delimiting punctuation.  In-line macros follow different conventions for  
 closure; see  
 .Sx MACROS  
 for per-macro details.  
 .El  
 .\" .\" SUB-SECTION  
 .\" .Ss Examples  
 .\" The following examples illustrate each macro classification.  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit full-block.  Has head, body and no tail.  Scope closed by  
 .\" second  
 .\" .Sq \&Sh  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Sh SECTION 1  
 .\" body...  
 .\" \&.Sh SECTION 2  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Nested implicit full-block, where the subsection  
 .\" .Sq \&Ss  
 .\" is within the scope of the parent section  
 .\" .Sq \&Sh  
 .\" and closed along with its parent by the subsequent  
 .\" .Sq \&Sh .  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Sh SECTION 1  
 .\" \&.Ss Subsection 1  
 .\" body...  
 .\" \&.Sh SECTION 2  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit full-block.  Has a head, a body and no tail.  Scope closed by  
 .\" .Sq \&Ef  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Bf symbolic  
 .\" body...  
 .\" \&.Ef  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Nested explicit/implicit scope.  
 .\" .Sq \&It  
 .\" macro is an implicit block whose scope is closed by the explicit  
 .\" .Sq \&El  
 .\" closure.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Bl \-bullet  
 .\" \&.It head  
 .\" body...  
 .\" \&.El  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit partial-block.  Has head, body and tail.  Scope closed by  
 .\" .Sq \&Ec  
 .\" invocation.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Eo head body... \&Ec tail  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit partial-block.  Has only body.  Scope is closed by end-of-line.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Sq body...  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit partial-block with only body and scope closed by  
 .\" .Sq \&Ac  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Ao body... \&Ac  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit partial-block enclosing explicit partial-block.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Sq body... \&Ao body... \&Ac  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Inline macros, several in sequence.  Scope is closed for  
 .\" .Sq \&Fl  
 .\" by the punctuation delimiter and  
 .\" .Sq \&Ar  
 .\" by the end-of-line.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Fl text0 text1 ; Ar text0 text1  
 .\" .Ed  
 .\" SECTION  
 .Sh SYNTAX  
 The syntax of macro invocation depends on classification.  
 .Qq \-arg  
 refers to the macro arguments (which may contain zero or more values).  
 In these illustrations,  
 .Sq \&.Yo  
 opens the scope of a macro, and if specified,  
 .Sq \&.Yc  
 closes it out (closure may be implicit at end-of-line or end-of-file).  
 .Pp  
 Block full-explicit (may contain head, body, tail):  
 .Bd -literal -offset XXXX  
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  
 \(lBbody...\(rB  \(lBbody...\(rB
 \&.Yc \(lBtail...\(rB  
 .Ed  
 .Pp  
 Block full-implicit (may contain zero or more heads, body, no tail):  
 .Bd -literal -offset XXXX  
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  
 \(lBbody...\(rB  
 \&.Yc  \&.Yc
 .Ed  .  Ed
 .Pp  .  Pp
 Block partial-explicit (may contain head, multi-line body, tail):  .  Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
 .Bd -literal -offset XXXX  .   It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  .   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
   don't have heads, while
   .  Sq \&It \-column
   may have multiple heads.
   .  Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
   .  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
   and/or tail
   .  Pq So \&Ec Sc .
   .  Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
 \&.Yc \(lBtail...\(rB  \&.Yc \(lBtail...\(rB
   
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  \(lBbody...\(rB \&Yc \(lBtail...\(rB
 .Ed  .  Ed
 .Pp  .  Pp
 Block partial-implicit (no head, body, no tail):  .  Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 .Bd -literal -offset XXXX  .   It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB  .   It \&Ac     Ta    Yes      Ta    Yes      Ta    opened by \&Ao
 .Ed  .   It \&Ao     Ta    Yes      Ta    Yes      Ta    closed by \&Ac
 .Pp  .   It \&Bc     Ta    Yes      Ta    Yes      Ta    closed by \&Bo
 In-line (may be closed by end-of-line, reserved character, subsequent  .   It \&Bo     Ta    Yes      Ta    Yes      Ta    opened by \&Bc
 macro invocation or finite number of arguments):  .   It \&Brc    Ta    Yes      Ta    Yes      Ta    opened by \&Bro
 .Bd -literal -offset XXX  .   It \&Bro    Ta    Yes      Ta    Yes      Ta    closed by \&Brc
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args...  .   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
   or end of line.
   .  Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
   .  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 ,
   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 ,
   then the macro accepts an arbitrary number of arguments.
   .  Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args... ;  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args... Xx  \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
   .  Ed
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  .  Pp
 .Ed  .  Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
 .\"  .   It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
 .Sh MACROS  .   It \&%A     Ta    \&No     Ta    \&No     Ta    >0
 This section contains a complete list of all  .   It \&%B     Ta    \&No     Ta    \&No     Ta    >0
 .Nm  .   It \&%C     Ta    \&No     Ta    \&No     Ta    >0
 macros, arranged ontologically.  A  .   It \&%D     Ta    \&No     Ta    \&No     Ta    >0
 .Qq callable  .   It \&%I     Ta    \&No     Ta    \&No     Ta    >0
 macro is may be invoked subsequent to the initial macro-line macro.  A  .   It \&%J     Ta    \&No     Ta    \&No     Ta    >0
 .Qq parsable  .   It \&%N     Ta    \&No     Ta    \&No     Ta    >0
 macro may be followed by further (ostensibly callable) macros.  .   It \&%O     Ta    \&No     Ta    \&No     Ta    >0
 .\" SUB-SECTION  .   It \&%P     Ta    \&No     Ta    \&No     Ta    >0
 .Ss Block full-implicit  .   It \&%R     Ta    \&No     Ta    \&No     Ta    >0
 The head of these macros follows invocation; the body is the content of  .   It \&%T     Ta    \&No     Ta    \&No     Ta    >0
 subsequent lines prior to closure.  None of these macros have tails;  .   It \&%V     Ta    \&No     Ta    \&No     Ta    >0
 some  .   It \&Ad     Ta    Yes      Ta    Yes      Ta    n
 .Po  .   It \&An     Ta    Yes      Ta    Yes      Ta    n
 .Sq \&It \-bullet ,  .   It \&Ap     Ta    Yes      Ta    Yes      Ta    0
 .Sq \-hyphen ,  .   It \&Ar     Ta    Yes      Ta    Yes      Ta    n
 .Sq \-dash ,  .   It \&At     Ta    Yes      Ta    Yes      Ta    1
 .Sq \-enum ,  .   It \&Bsx    Ta    Yes      Ta    Yes      Ta    n
 .Sq \-item  .   It \&Bt     Ta    \&No     Ta    \&No     Ta    0
 .Pc  .   It \&Bx     Ta    Yes      Ta    Yes      Ta    n
 don't have heads.  .   It \&Cd     Ta    Yes      Ta    Yes      Ta    >0
 .Pp  .   It \&Cm     Ta    Yes      Ta    Yes      Ta    n
 .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX  .   It \&Db     Ta    \&No     Ta    \&No     Ta    1
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  .   It \&Dd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh  .   It \&Dt     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss  .   It \&Dv     Ta    Yes      Ta    Yes      Ta    n
 .It \&.It    Ta    \&No    Ta    Yes     Ta    \&.It, \&.El  .   It \&Dx     Ta    Yes      Ta    Yes      Ta    n
 .El  .   It \&Em     Ta    Yes      Ta    Yes      Ta    >0
 .\" SUB-SECTION  .   It \&En     Ta    \&No     Ta    \&No     Ta    0
 .Ss Block full-explicit  .   It \&Er     Ta    Yes      Ta    Yes      Ta    >0
 None of these macros are callable or parsed.  The last column indicates  .   It \&Es     Ta    \&No     Ta    \&No     Ta    0
 the explicit scope rules.  All contains bodies, some may contain heads  .   It \&Ev     Ta    Yes      Ta    Yes      Ta    n
 .Pq So \&Bf Sc .  .   It \&Ex     Ta    \&No     Ta    \&No     Ta    0
 .Pp  .   It \&Fa     Ta    Yes      Ta    Yes      Ta    n
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX  .   It \&Fd     Ta    \&No     Ta    \&No     Ta    >0
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .   It \&Fl     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed  .   It \&Fn     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  .   It \&Fr     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Bl    Ta    \&No    Ta    \&No    Ta    closed by \&.El  .   It \&Ft     Ta    Yes      Ta    Yes      Ta    n
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  .   It \&Fx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  .   It \&Hf     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf  .   It \&Ic     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Bk    Ta    \&No    Ta    \&No    Ta    closed by \&.Ek  .   It \&In     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Ek    Ta    \&No    Ta    \&No    Ta    opened by \&.Bk  .   It \&Lb     Ta    \&No     Ta    \&No     Ta    1
 .El  .   It \&Li     Ta    Yes      Ta    Yes      Ta    n
 .\" SUB-SECTION  .   It \&Lk     Ta    Yes      Ta    Yes      Ta    n
 .Ss Block partial-implicit  .   It \&Lp     Ta    \&No     Ta    \&No     Ta    0
 All of these are callable and parsed for further macros.  Their scopes  .   It \&Ms     Ta    Yes      Ta    Yes      Ta    >0
 close at the invocation's end-of-line.  .   It \&Mt     Ta    Yes      Ta    Yes      Ta    >0
 .Pp  .   It \&Nm     Ta    Yes      Ta    Yes      Ta    n
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX  .   It \&No     Ta    Yes      Ta    Yes      Ta    0
 .It Em Macro Ta Em Callable Ta Em Parsable  .   It \&Ns     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Aq    Ta    Yes   Ta    Yes  .   It \&Nx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Op    Ta    Yes   Ta    Yes  .   It \&Os     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Bq    Ta    Yes   Ta    Yes  .   It \&Ot     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Dq    Ta    Yes   Ta    Yes  .   It \&Ox     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Pq    Ta    Yes   Ta    Yes  .   It \&Pa     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Qq    Ta    Yes   Ta    Yes  .   It \&Pf     Ta    \&No     Ta    Yes      Ta    1
 .It \&.Sq    Ta    Yes   Ta    Yes  .   It \&Pp     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Brq   Ta    Yes   Ta    Yes  .   It \&Rv     Ta    \&No     Ta    \&No     Ta    0
 .It \&.D1    Ta    \&No  Ta    \&Yes  .   It \&Sm     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Dl    Ta    \&No  Ta    Yes  .   It \&St     Ta    \&No     Ta    Yes      Ta    1
 .It \&.Ql    Ta    Yes   Ta    Yes  .   It \&Sx     Ta    Yes      Ta    Yes      Ta    >0
 .El  .   It \&Sy     Ta    Yes      Ta    Yes      Ta    >0
 .\" SUB-SECTION  .   It \&Tn     Ta    Yes      Ta    Yes      Ta    >0
 .Ss Block partial-explicit  .   It \&Ud     Ta    \&No     Ta    \&No     Ta    0
 Each of these contains at least a body and, in limited circumstances, a  .   It \&Ux     Ta    Yes      Ta    Yes      Ta    n
 head  .   It \&Va     Ta    Yes      Ta    Yes      Ta    n
 .Pq So \&Fo Sc , So \&Eo Sc  .   It \&Vt     Ta    Yes      Ta    Yes      Ta    >0
 and/or tail  .   It \&Xr     Ta    Yes      Ta    Yes      Ta    >0, <3
 .Pq So \&Ec Sc .  .   It \&br     Ta    \&No     Ta    \&No     Ta    0
 .Pp  .   It \&sp     Ta    \&No     Ta    \&No     Ta    1
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX  .  El
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .
 .It \&.Ao    Ta    Yes   Ta    Yes    Ta    closed by \&.Ac  .
 .It \&.Ac    Ta    Yes   Ta    Yes    Ta    opened by \&.Ao  .Sh COMPATIBILITY
 .It \&.Bc    Ta    Yes   Ta    Yes    Ta    closed by \&.Bo  This section documents compatibility with other roff implementations, at
 .It \&.Bo    Ta    Yes   Ta    Yes    Ta    opened by \&.Bc  this time limited to
 .It \&.Pc    Ta    Yes   Ta    Yes    Ta    closed by \&.Po  . Xr groff 1 .
 .It \&.Po    Ta    Yes   Ta    Yes    Ta    opened by \&.Pc  The term
 .It \&.Do    Ta    Yes   Ta    Yes    Ta    closed by \&.Dc  . Qq historic groff
 .It \&.Dc    Ta    Yes   Ta    Yes    Ta    opened by \&.Do  refers to those versions before the
 .It \&.Xo    Ta    Yes   Ta    Yes    Ta    closed by \&.Xc  . Pa doc.tmac
 .It \&.Xc    Ta    Yes   Ta    Yes    Ta    opened by \&.Xo  file re-write
 .It \&.Bro   Ta    Yes   Ta    Yes    Ta    closed by \&.Brc  . Pq somewhere between 1.15 and 1.19 .
 .It \&.Brc   Ta    Yes   Ta    Yes    Ta    opened by \&.Bro  . Pp
 .It \&.Oc    Ta    Yes   Ta    Yes    Ta    closed by \&.Oo  . Bl -dash -compact
 .It \&.Oo    Ta    Yes   Ta    Yes    Ta    opened by \&.Oc  .  It
 .It \&.So    Ta    Yes   Ta    Yes    Ta    closed by \&.Sc  The
 .It \&.Sc    Ta    Yes   Ta    Yes    Ta    opened by \&.So  .   Sq \-split
 .It \&.Fc    Ta    Yes   Ta    Yes    Ta    opened by \&.Fo  or
 .It \&.Fo    Ta    \&No  Ta    \&No   Ta    closed by \&.Fc  .   Sq \-nosplit
 .It \&.Ec    Ta    Yes   Ta    Yes    Ta    opened by \&.Eo  argument to
 .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec  .   Sq \&An
 .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo  applies to the whole document, not just to the current section as it
 .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc  does in groff.
 .It \&.Re    Ta    \&No  Ta    \&No   Ta    opened by \&.Rs  .  It
 .It \&.Rs    Ta    \&No  Ta    \&No   Ta    closed by \&.Re  In quoted literals, groff allowed pair-wise double-quotes to produce a
 .El  standalone double-quote in formatted output.  This idiosyncratic
 .\" SUB-SECTION  behaviour is no longer applicable.
 .Ss In-line  .  It
 In-line macros have only text children.  The
 .Pp  .   Sq \&sp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX  macro does not accept negative numbers.
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments  .  It
 .It \&.Dd    Ta    \&No  Ta    \&No    Ta    \&  Blocks of whitespace are stripped from both macro and free-form text
 .It \&.Dt    Ta    \&No  Ta    \&No    Ta    \&  lines (except when in literal mode), while groff would retain whitespace
 .It \&.Os    Ta    \&No  Ta    \&No    Ta    \&  in free-form text lines.
 .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0  .  It
 .It \&.Ad    Ta    Yes   Ta    Yes     Ta    \&  Historic groff has many un-callable macros.  Most of these (excluding
 .It \&.An    Ta    \&No  Ta    Yes     Ta    \&  some block-level macros) are now callable, conforming to the
 .It \&.Ar    Ta    Yes   Ta    Yes     Ta    \&  non-historic groff version.
 .It \&.Cd    Ta    Yes   Ta    \&No    Ta    \&  .  It
 .It \&.Cm    Ta    Yes   Ta    Yes     Ta    \&  The vertical bar
 .It \&.Dv    Ta    Yes   Ta    Yes     Ta    \&  .   Sq \(ba
 .It \&.Er    Ta    Yes   Ta    Yes     Ta    \&  made historic groff
 .It \&.Ev    Ta    Yes   Ta    Yes     Ta    \&  .   Qq go orbital
 .It \&.Ex    Ta    \&No  Ta    \&No    Ta    \&  but is a proper delimiter in this implementation.
 .It \&.Fa    Ta    Yes   Ta    Yes     Ta    \&  .  It
 .It \&.Fd    Ta    \&No  Ta    \&No    Ta    \&  .   Sq \&It \-nested
 .It \&.Fl    Ta    Yes   Ta    Yes     Ta    \&  is assumed for all lists (it wasn't in historic groff): any list may be
 .It \&.Fn    Ta    Yes   Ta    Yes     Ta    \&  nested and
 .It \&.Ft    Ta    \&No  Ta    Yes     Ta    \&  .   Sq \-enum
 .It \&.Ic    Ta    Yes   Ta    Yes     Ta    \&  lists will restart the sequence only for the sub-list.
 .It \&.In    Ta    \&No  Ta    \&No    Ta    \&  .  It
 .It \&.Li    Ta    Yes   Ta    Yes     Ta    \&  .   Sq \&It \-column
 .It \&.Nd    Ta    \&No  Ta    \&No    Ta    \&  syntax where column widths may be preceded by other arguments (instead
 .It \&.Nm    Ta    Yes   Ta    Yes     Ta    \&  of proceeded) is not supported.
 .It \&.Ot    Ta    \&No  Ta    \&No    Ta    \&  .  It
 .It \&.Pa    Ta    Yes   Ta    Yes     Ta    \&  The
 .It \&.Rv    Ta    \&No  Ta    \&No    Ta    \&  .   Sq \&At
 .It \&.St    Ta    \&No  Ta    Yes     Ta    \&  macro only accepts a single parameter.
 .It \&.Va    Ta    Yes   Ta    Yes     Ta    \&  .  It
 .It \&.Vt    Ta    Yes   Ta    Yes     Ta    \&  Some manuals use
 .It \&.Xr    Ta    Yes   Ta    Yes     Ta    \&  .   Sq \&Li
 .It \&.%A    Ta    \&No  Ta    \&No    Ta    \&  incorrectly by following it with a reserved character and expecting the
 .It \&.%B    Ta    \&No  Ta    \&No    Ta    \&  delimiter to render.  This is not supported.
 .It \&.%C    Ta    \&No  Ta    \&No    Ta    \&  .  It
 .It \&.%D    Ta    \&No  Ta    \&No    Ta    \&  In groff, the
 .It \&.%I    Ta    \&No  Ta    \&No    Ta    \&  .   Sq \&Fo
 .It \&.%J    Ta    \&No  Ta    \&No    Ta    \&  macro only produces the first parameter.  This is no longer the case.
 .It \&.%N    Ta    \&No  Ta    \&No    Ta    \&  . El
 .It \&.%O    Ta    \&No  Ta    \&No    Ta    \&  .
 .It \&.%P    Ta    \&No  Ta    \&No    Ta    \&  .
 .It \&.%R    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.%T    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.%V    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.At    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Em    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    \&  
 .It \&.No    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Ns    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Nx    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Ox    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Pf    Ta    \&No  Ta    Yes     Ta    \&  
 .It \&.Sm    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Sx    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Sy    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Tn    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Ux    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Bt    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Hf    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Fr    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Ud    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Lb    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Ap    Ta    Yes   Ta    Yes     Ta    \&  
 .It \&.Lp    Ta    \&No  Ta    \&No    Ta    \&  
 .It \&.Lk    Ta    \&No  Ta    Yes     Ta    \&  
 .It \&.Mt    Ta    \&No  Ta    Yes     Ta    \&  
 .El  
 .\" SECTION  
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mdoctree 1 ,  . Xr mandoc 1 ,
 .Xr mdoclint 1 ,  . Xr mandoc_char 7
 .Xr mdocterm 1 ,  .
 .Xr mdoc 3  .
 .\" SECTION  
 .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 .
   .
   .
   .Sh CAVEATS
   There are many ambiguous parts of mdoc.
   . Pp
   . Bl -dash -compact
   .  It
   .   Sq \&Fa
   should be
   .   Sq \&Va
   as function arguments are variables.
   .  It
   .   Sq \&Ft
   should be
   .   Sq \&Vt
   as function return types are still types.  Furthermore, the
   .   Sq \&Ft
   should be removed and
   .   Sq \&Fo ,
   which ostensibly follows it, should follow the same convention as
   .   Sq \&Va .
   .  It
   .   Sq \&Va
   should formalise that only one or two arguments are acceptable: a
   variable name and optional, preceding type.
   .  It
   .   Sq \&Fd
   is ambiguous.  It's commonly used to indicate an include file in the
   synopsis section.
   .   Sq \&In
   should be used, instead.
   .  It
   Only the
   .   Sq \-literal
   argument to
   .   Sq \&Bd
   makes sense.  The remaining ones should be removed.
   .  It
   The
   .   Sq \&Xo
   and
   .   Sq \&Xc
   macros should be deprecated.
   .  It
   The
   .   Sq \&Dt
   macro lacks clarity.  It should be absolutely clear which title will
   render when formatting the manual page.
   .  It
   A
   .   Sq \&Lx
   should be provided for Linux (\(`a la
   .   Sq \&Ox ,
   .   Sq \&Nx
   etc.).
   .  It
   There's no way to refer to references in
   .   Sq \&Rs/Re
   blocks.
   .  It
   The \-split and \-nosplit dictates via
   .   Sq \&An
   are re-set when entering and leaving the AUTHORS section.
   . El
   .
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.56
CVSweb