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

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

version 1.5, 2009/03/16 22:19:19 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.  This document describes the encoding, ontology and syntax  prior macros:
 of these macros.  . Bd -literal -offset indent
 .\" SECTION  \&.Sh Macro lines change control state.
 .Sh CHARACTER ENCODING  Other lines are interpreted within the current state.
 .Nm  . Ed
 documents may contain only printable alphanumeric characters, the space  .
 character  .
 .Sq \  ,  .Sh LANGUAGE SYNTAX
 and, in certain circumstances, the tab character  . Nm
 .Sq \et .  documents may contain only graphable 7-bit ASCII characters, the space
 All manuals must have  character, and, in certain circumstances, the tab character.  All
 .Sq \en  manuals must have
 line termination.  . Ux
 .\" SUB-SECTION  line terminators.
 .Ss Reserved Characters  .
   .
   . 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 exclamation  .    Pq exclamation
 .El  .   It \&|
 .\" PARAGRAPH  .    Pq vertical bar
 .Pp  .  El
   .  Pp
 Use of reserved characters is described in  Use of reserved characters is described in
 .Sx Closure .  .  Sx MACRO SYNTAX .
 For general non-reserved use, characters must either be escaped with a  For general use in macro lines, these characters must either be escaped
 non-breaking space  with a non-breaking space
 .Pq Sq \e&  .  Pq Sq \e&
 or, if applicable, an appropriate escape-sequence used.  or, if applicable, an appropriate escape sequence used.
 .\" SUB-SECTION  .
 .Ss Special Characters  .
 Special character sequences begin with the escape character  . Ss Special Characters
 .Sq \\  Special characters may occur in both macro and free-form lines.
 followed by either an open-parenthesis  Sequences begin with the escape character
 .Sq \&(  .  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 is deprecated.  .  Pq em-dash
 .Pp  and
 The following is a table of all available escapes.  .  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 \\(lh  two-character
 .Pq left hand  .  Sq \e*(XX ,
 .It \\(rh  and N-character
 .Pq right hand  .  Sq \e*[N] .
 .It \\(<<  See
 .Pq left guillemot  .  Xr mandoc_char 7
 .It \\(>>  for a complete list.  Examples include
 .Pq right guillemot  .  Sq \e*(Am
 .It \\(rC  .  Pq ampersand
 .Pq right brace  and
 .It \\(lC  .  Sq \e*(Ba
 .Pq left brace  .  Pq vertical bar .
 .It \\(ra  .
 .Pq right angle  .
 .It \\(la  . Ss Whitespace
 .Pq left angle  In non-literal free-form lines, consecutive blocks of whitespace are
 .It \\(rB  pruned from input and added later in the output filter, if applicable:
 .Pq right bracket  .  Bd -literal -offset indent
 .It \\(lB  These     spaces   are    pruned       from    input.
 .Pq left bracket  \&.Bd \-literal
 .It \\q  These         are              not.
 .Pq double-quote  \&.Ed
 .It \\(lq  .  Ed
 .Pq left double-quote  .  Pp
 .It \\(Lq  In macro lines, whitespace delimits arguments and is discarded.  If
 .Pq left double-quote, deprecated  arguments are quoted, whitespace within the quotes is retained.
 .It \\(rq  .  Pp
 .Pq right double-quote  Blank lines are only permitted within literal contexts, as are lines
 .It \\(Rq  containing only whitespace.  Tab characters are only acceptable when
 .Pq right double-quote, deprecated  delimiting
 .It \\(oq  .  Sq \&Bl \-column
 .Pq left single-quote  or when in a literal context.
 .It \\(aq  .
 .Pq right single-quote  .
 .El  . Ss Quotation
 .\" PARAGRAPH  Macro arguments may be quoted with a double-quote to group
 .Pp  space-delimited terms or to retain blocks of whitespace.  A quoted
 Indicatives:  argument begins with a double-quote preceded by whitespace.  The next
 .Bl -tag -width 12n -offset "XXXX" -compact  double-quote not pair-wise adjacent to another double-quote terminates
 .It \\(<-  the literal, regardless of surrounding whitespace.
 .Pq left arrow  .  Pp
 .It \\(->  This produces tokens
 .Pq right arrow  .  Sq a" ,
 .It \\(ua  .  Sq b c ,
 .Pq up arrow  .  Sq de ,
 .It \\(da  and
 .Pq down arrow  .  Sq fg" .
 .It \\(<>  Note that any quoted term, be it argument or macro, is indiscriminately
 .Pq left-right arrow  considered literal text.  Thus, the following produces
 .It \\(lA  .  Sq \&Em a :
 .Pq left double-arrow  .  Bd -literal -offset indent
 .It \\(rA  \&.Em "Em a"
 .Pq right double-arrow  .  Ed
 .It \\(uA  .  Pp
 .Pq up double-arrow  In free-form mode, quotes are regarded as opaque text.
 .It \\(dA  .
 .Pq down double-arrow  .
 .It \\(hA  .Sh MANUAL STRUCTURE
 .Pq left-right double-arrow  Each
 .El  . Nm
 .\" PARAGRAPH  document must begin with a document prologue, containing, in order,
 .Pp  . Sq \&Dd ,
 Mathematical:  . Sq \&Dt ,
 .Bl -tag -width 12n -offset "XXXX" -compact  and
 .It \\(Gt  . Sq \&Os ,
 .Pq greater-than, deprecated  then the NAME section containing at least one
 .It \\(Lt  . Sq \&Nm
 .Pq less-than, deprecated  followed by
 .It \\(<=  . Sq \&Nd :
 .Pq less-than-equal  . Bd -literal -offset indent
 .It \\(Le  \&.Dd $\&Mdocdate$
 .Pq less-than-equal, deprecated  \&.Dt mdoc 7
 .It \\(>=  \&.Os
 .Pq greater-than-equal  \&.Sh NAME
 .It \\(Ge  \&.Nm mdoc
 .Pq greater-than-equal  \&.Nd mdoc language reference
 .It \\(==  . Ed
 .Pq equal  . Pp
 .It \\(!=  Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
 .Pq not equal  but non-compulsory.
 .It \\(Ne  .
 .Pq not equal, deprecated  .
 .It \\(if  .Sh MACRO SYNTAX
 .Pq infinity  Macros are one to three three characters in length and begin with a
 .It \\(If  control character ,
 .Pq infinity, deprecated  . Sq \&. ,
 .It \\(na  at the beginning of the line.  An arbitrary amount of whitespace may
 .Pq NaN , an extension  sit between the control character and the macro name.  Thus,
 .It \\(Na  . Sq \&.Pp
 .Pq NaN, deprecated  and
 .It \\(+-  . Sq \&.\ \ \ \&Pp
 .Pq plus-minus  are equivalent.  Macro names are two or three characters in length.
 .It \\(Pm  . Pp
 .Pq plus-minus, deprecated  The syntax of a macro depends on its classification.  In this section,
 .It \\(**  . Sq \-arg
 .Pq asterisk  refers to macro arguments, which may be followed by zero or more
 .El  . Sq parm
 .\" PARAGRAPH  parameters;
 .Pp  . Sq \&Yo
 Diacritics and letter combinations:  opens the scope of a macro; and if specified,
 .Bl -tag -width 12n -offset "XXXX" -compact  . Sq \&Yc
 .It \\(ga  closes it out.
 .Pq accent grave  . Pp
 .It \\(aa  The
 .Pq accent accute  . Em Callable
 .It \\(ad  column indicates that the macro may be called subsequent to the initial
 .Pq accent dieresis  line-macro.  If a macro is not callable, then its invocation after the
 .It \\(a~  initial line macro is interpreted as opaque text, such that
 .Pq accent tilde  . Sq \&.Fl Sh
 .It \\(AE  produces
 .Pq upper-case AE  . Sq Fl Sh .
 .It \\(ae  . Pp
 .Pq lower-case AE  The
 .It \\(OE  . Em Parsable
 .Pq upper-case OE  column indicates whether the macro may be followed by further
 .It \\(oe  (ostensibly callable) macros.  If a macro is not parsable, subsequent
 .Pq lower-case OE  macro invocations on the line will be interpreted as opaque text.
 .It \\('A  . Pp
 .Pq upper-case acute A  The
 .It \\('E  . Em Scope
 .Pq upper-case acute E  column, if applicable, describes closure rules.
 .It \\('I  .
 .Pq upper-case acute I  .
 .It \\('O  . Ss Block full-explicit
 .Pq upper-case acute O  Multi-line scope closed by an explicit closing macro.  All macros
 .It \\('U  contains bodies; only
 .Pq upper-case acute U  .  Pq Sq \&Bf
 .It \\('a  contains a head.
 .Pq lower-case acute a  .  Bd -literal -offset indent
 .It \\('e  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 .Pq lower-case acute e  \(lBbody...\(rB
 .It \\('i  
 .Pq lower-case acute i  
 .It \\('o  
 .Pq lower-case acute o  
 .It \\('u  
 .Pq lower-case acute u  
 .It \\(`A  
 .Pq upper-case grave A  
 .It \\(`E  
 .Pq upper-case grave E  
 .It \\(`I  
 .Pq upper-case grave I  
 .It \\(`O  
 .Pq upper-case grave O  
 .It \\(`U  
 .Pq upper-case grave U  
 .It \\(`a  
 .Pq lower-case grave a  
 .It \\(`e  
 .Pq lower-case grave e  
 .It \\(`i  
 .Pq lower-case grave i  
 .It \\(`o  
 .Pq lower-case grave o  
 .It \\(`u  
 .Pq lower-case grave u  
 .It \\(~A  
 .Pq upper-case tilde A  
 .It \\(~N  
 .Pq upper-case tilde N  
 .It \\(~O  
 .Pq upper-case tilde O  
 .It \\(~a  
 .Pq lower-case tilde a  
 .It \\(~n  
 .Pq lower-case tilde n  
 .It \\(~o  
 .Pq lower-case tilde o  
 .It \\(:A  
 .Pq upper-case dieresis A  
 .It \\(:E  
 .Pq upper-case dieresis E  
 .It \\(:I  
 .Pq upper-case dieresis I  
 .It \\(:O  
 .Pq upper-case dieresis O  
 .It \\(:U  
 .Pq upper-case dieresis U  
 .It \\(:a  
 .Pq lower-case dieresis a  
 .It \\(:e  
 .Pq lower-case dieresis e  
 .It \\(:i  
 .Pq lower-case dieresis i  
 .It \\(:o  
 .Pq lower-case dieresis o  
 .It \\(:u  
 .Pq lower-case dieresis u  
 .It \\(:y  
 .Pq lower-case dieresis y  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Special symbols:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(bu  
 .Pq bullet  
 .It \\(ba  
 .Pq bar  
 .It \\(Ba  
 .Pq bar, deprecated  
 .It \\(co  
 .Pq copyright  
 .It \\(rg  
 .Pq registered  
 .It \\(tm  
 .Pq trademarked  
 .It \\&  
 .Pq non-breaking space  
 .It \\e  
 .Pq escape  
 .It \\(Am  
 .Pq ampersand, deprecated  
 .El  
 .\" SECTION  
 .Sh ONTOLOGY  
 Macros are classified in an ontology described by scope rules.  
 .\" SUB-SECTION  
 .Ss Scope  
 .Bl -inset  
 .\" LIST-ITEM  
 .It Em Block  
 macros enclose other block macros, in-line macros or text, and  
 may span multiple lines.  
 .Bl -inset -offset XXXX  
 .\" LIST-ITEM  
 .It Em Full-block  
 macros always span multiple lines.  They consist of zero or  
 more  
 .Qq heads ,  
 subsequent macros or text on the same line following invocation; an  
 optional  
 .Qq body ,  
 which spans subsequent lines of text or macros; and an optional  
 .Qq tail ,  
 macros or text on the same line following closure.  
 .\" LIST-ITEM  
 .It Em Partial-block  
 macros may span multiple lines.  They consists of a optional  
 .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.  
 .\" LIST-ITEM  
 .It Em In-line  
 macros may only enclose text and span at most a single line.  
 .El  
 .El  
 .\" SUB-SECTION  
 .Ss Closure  
 Closure of a macro's scope depends first on its classification, then  
 on whether it's parsable.  In this table,  
 .Sq BFE  
 refers to block full-explicit and so on.  
 .\" PARAGRAPH  
 .Pp  
 .Bl -tag -width 12n -offset XXXX -compact  
 .It BPE , BFE  
 corresponding explicit closure macro  
 .It BFI  
 end-of-file or a corresponding implicit closure macro  
 .It BPI  
 end-of-line (body may be closed by >0 space-separated  
 .Sx Reserved Characters ,  
 although block scope will still be open)  
 .It INL  
 end-of-line  
 .El  
 .\" PARAGRAPH  
 .Pp  
 If a macro (block or in-line) is parsable, it may also be closed out by  
 one of the following scenarios (unless specifically noted otherwise):  
 .\" PARAGRAPH  
 .Pp  
 .Bl -dash -offset XXXX -compact  
 .It  
 a sequence of >0 space-separated  
 .Sx Reserved Characters ,  
 .It  
 another macro,  
 .It  
 end-of-line, or  
 .It  
 completion of a set number of arguments.  
 .El  
 .\" PARAGRAPH  
 .Pp  
 If >0 space-separated  
 .Sx Reserved Characters  
 are followed by non-reserved characters, the behaviour differs per  
 macro.  In general, scope of the macro is closed and re-opened:  
 subsequent tokens are interpreted as if the scope had just been opened.  
 In other circumstances, scope is simply closed out.  
 .\" SECTION  
 .Sh SYNTAX  
 Macros are generally two and at times three characters in length.  The  
 syntax of macro invocation depends on its 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).  
 .\" PARAGRAPH  
 .Pp  
 Block full-explicit (may contain head, body, tail).  
 .Bd -literal -offset XXXX  
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  
 \(lBbody...\(rB  
 \&.Yc \(lBtail...\(rB  
 .Ed  
 .\" PARAGRAPH  
 .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
 .\" PARAGRAPH  .  Pp
 .Pp  .  Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
 Block partial-explicit (may contain head, multi-line body, tail).  .   It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .Bd -literal -offset XXXX  .   It \&Bd     Ta    \&No     Ta    \&No     Ta    closed by \&Ed
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  .   It \&Bf     Ta    \&No     Ta    \&No     Ta    closed by \&Ef
 \(lBbody...\(rB  .   It \&Bk     Ta    \&No     Ta    \&No     Ta    closed by \&Ek
 \&.Yc \(lBtail...\(rB  .   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
   .  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
   
 \&.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
 .\" PARAGRAPH  .  Pp
 .Pp  .  Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 Block partial-implicit (no head, body, no tail).  Note that the body  .   It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 section may be followed by zero or more  .   It \&Ac     Ta    Yes      Ta    Yes      Ta    opened by \&Ao
 .Sx Reserved Words .  .   It \&Ao     Ta    Yes      Ta    Yes      Ta    closed by \&Ac
 These are in the block scope, but not in the body scope.  .   It \&Bc     Ta    Yes      Ta    Yes      Ta    closed by \&Bo
 .Bd -literal -offset XXXX  .   It \&Bo     Ta    Yes      Ta    Yes      Ta    opened by \&Bc
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB  .   It \&Brc    Ta    Yes      Ta    Yes      Ta    opened by \&Bro
 .Ed  .   It \&Bro    Ta    Yes      Ta    Yes      Ta    closed by \&Brc
 .\" PARAGRAPH  .   It \&Dc     Ta    Yes      Ta    Yes      Ta    opened by \&Do
 .Pp  .   It \&Do     Ta    Yes      Ta    Yes      Ta    closed by \&Dc
 In-lines have \(>=0 scoped arguments.  .   It \&Ec     Ta    Yes      Ta    Yes      Ta    opened by \&Eo
 .Bd -literal -offset XXX  .   It \&Eo     Ta    Yes      Ta    Yes      Ta    closed by \&Ec
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB  .   It \&Fc     Ta    Yes      Ta    Yes      Ta    opened by \&Fo
   .   It \&Fo     Ta    \&No     Ta    \&No     Ta    closed by \&Fc
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  .   It \&Oc     Ta    Yes      Ta    Yes      Ta    closed by \&Oo
 .Ed  .   It \&Oo     Ta    Yes      Ta    Yes      Ta    opened by \&Oc
 .\"  .   It \&Pc     Ta    Yes      Ta    Yes      Ta    closed by \&Po
 .Sh MACROS  .   It \&Po     Ta    Yes      Ta    Yes      Ta    opened by \&Pc
 This section contains a complete list of all  .   It \&Qc     Ta    Yes      Ta    Yes      Ta    opened by \&Oo
 .Nm  .   It \&Qo     Ta    Yes      Ta    Yes      Ta    closed by \&Oc
 macros, arranged ontologically.  A  .   It \&Re     Ta    \&No     Ta    \&No     Ta    opened by \&Rs
 .Qq callable  .   It \&Rs     Ta    \&No     Ta    \&No     Ta    closed by \&Re
 macro is may be invoked subsequent to the initial macro-line macro.  A  .   It \&Sc     Ta    Yes      Ta    Yes      Ta    opened by \&So
 .Qq parsable  .   It \&So     Ta    Yes      Ta    Yes      Ta    closed by \&Sc
 macro may be followed by further (ostensibly callable) macros.  .   It \&Xc     Ta    Yes      Ta    Yes      Ta    opened by \&Xo
 .\" SUB-SECTION  .   It \&Xo     Ta    Yes      Ta    Yes      Ta    closed by \&Xc
 .Ss Block full-implicit  .  El
 The head of these macros follows invocation; the body is the content of  .
 subsequent lines prior to closure.  None of these macros have tails;  .
 some  . Ss Block partial-implicit
 .Po  Like block full-implicit, but with single-line scope closed by
 .Sq \&It \-bullet ,  .  Sx Reserved Characters
 .Sq \-hyphen ,  or end of line.
 .Sq \-dash ,  .  Bd -literal -offset indent
 .Sq \-enum ,  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
 .Sq \-item  .  Ed
 .Pc  .  Pp
 don't have heads.  .  Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
 .Pp  .   It Em Macro Ta Em Callable Ta Em Parsable
 .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX  .   It \&Aq     Ta    Yes      Ta    Yes
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  .   It \&Bq     Ta    Yes      Ta    Yes
 .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh  .   It \&Brq    Ta    Yes      Ta    Yes
 .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss  .   It \&D1     Ta    \&No     Ta    \&Yes
 .It \&.It    Ta    \&No    Ta    Yes     Ta    \&.It, \&.El  .   It \&Dl     Ta    \&No     Ta    Yes
 .El  .   It \&Dq     Ta    Yes      Ta    Yes
 .\" SUB-SECTION  .   It \&Op     Ta    Yes      Ta    Yes
 .Ss Block full-explicit  .   It \&Pq     Ta    Yes      Ta    Yes
 None of these macros are callable or parsed.  The last column indicates  .   It \&Ql     Ta    Yes      Ta    Yes
 the explicit scope rules.  All contains bodies, some may contain heads  .   It \&Qq     Ta    Yes      Ta    Yes
 .Pq So \&Bf Sc .  .   It \&Sq     Ta    Yes      Ta    Yes
 .Pp  .  El
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX  .
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .
 .It \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed  . Ss In-line
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  Closed by
 .It \&.Bl    Ta    \&No    Ta    \&No    Ta    closed by \&.El  .  Sx Reserved Characters ,
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  end of line, fixed argument lengths, and/or subsequent macros.  In-line
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  macros have only text children.  If a number (or inequality) of
 .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf  
 .It \&.Bk    Ta    \&No    Ta    \&No    Ta    closed by \&.Ek  
 .It \&.Ek    Ta    \&No    Ta    \&No    Ta    opened by \&.Bk  
 .El  
 .\" SUB-SECTION  
 .Ss Block partial-implicit  
 All of these are callable and parsed for further macros.  Their scopes  
 close at the invocation's end-of-line.  
 .Pp  
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX  
 .It Em Macro Ta Em Callable Ta Em Parsable  
 .It \&.Aq    Ta    Yes   Ta    Yes  
 .It \&.Op    Ta    Yes   Ta    Yes  
 .It \&.Bq    Ta    Yes   Ta    Yes  
 .It \&.Dq    Ta    Yes   Ta    Yes  
 .It \&.Pq    Ta    Yes   Ta    Yes  
 .It \&.Qq    Ta    Yes   Ta    Yes  
 .It \&.Sq    Ta    Yes   Ta    Yes  
 .It \&.Brq   Ta    Yes   Ta    Yes  
 .It \&.D1    Ta    \&No  Ta    \&Yes  
 .It \&.Dl    Ta    \&No  Ta    Yes  
 .It \&.Ql    Ta    Yes   Ta    Yes  
 .El  
 .\" SUB-SECTION  
 .Ss Block partial-explicit  
 Each of these contains at least a body and, in limited circumstances, a  
 head  
 .Pq So \&Fo Sc , So \&Eo Sc  
 and/or tail  
 .Pq So \&Ec Sc .  
 .Pp  
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX  
 .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  
 .It \&.Bc    Ta    Yes   Ta    Yes    Ta    closed by \&.Bo  
 .It \&.Bo    Ta    Yes   Ta    Yes    Ta    opened by \&.Bc  
 .It \&.Pc    Ta    Yes   Ta    Yes    Ta    closed by \&.Po  
 .It \&.Po    Ta    Yes   Ta    Yes    Ta    opened by \&.Pc  
 .It \&.Do    Ta    Yes   Ta    Yes    Ta    closed by \&.Dc  
 .It \&.Dc    Ta    Yes   Ta    Yes    Ta    opened by \&.Do  
 .It \&.Xo    Ta    Yes   Ta    Yes    Ta    closed by \&.Xc  
 .It \&.Xc    Ta    Yes   Ta    Yes    Ta    opened by \&.Xo  
 .It \&.Bro   Ta    Yes   Ta    Yes    Ta    closed by \&.Brc  
 .It \&.Brc   Ta    Yes   Ta    Yes    Ta    opened by \&.Bro  
 .It \&.Oc    Ta    Yes   Ta    Yes    Ta    closed by \&.Oo  
 .It \&.Oo    Ta    Yes   Ta    Yes    Ta    opened by \&.Oc  
 .It \&.So    Ta    Yes   Ta    Yes    Ta    closed by \&.Sc  
 .It \&.Sc    Ta    Yes   Ta    Yes    Ta    opened by \&.So  
 .It \&.Fc    Ta    Yes   Ta    Yes    Ta    opened by \&.Fo  
 .It \&.Fo    Ta    \&No  Ta    \&No   Ta    closed by \&.Fc  
 .It \&.Ec    Ta    Yes   Ta    Yes    Ta    opened by \&.Eo  
 .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec  
 .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  
 .El  
 .\" SUB-SECTION  
 .Ss In-line  
 In-line macros have only text children.  If a number (or inequality) of  
 arguments is  arguments is
 .Pq n ,  .  Pq n ,
 then the macro accepts an arbitrary number of arguments.  then the macro accepts an arbitrary number of arguments.
 .Pp  .  Bd -literal -offset indent
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments  
 .It \&.Dd    Ta    \&No  Ta    \&No    Ta    >0  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
 .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n  
 .It \&.Os    Ta    \&No  Ta    \&No    Ta    n  \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
 .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0  .  Ed
 .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n  .  Pp
 .It \&.An    Ta    \&No  Ta    Yes     Ta    n  .  Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
 .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n  .   It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
 .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0  .   It \&%A     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n  .   It \&%B     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Dv    Ta    Yes   Ta    Yes     Ta    >0  .   It \&%C     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0  .   It \&%D     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ev    Ta    Yes   Ta    Yes     Ta    >0  .   It \&%I     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0  .   It \&%J     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Fa    Ta    Yes   Ta    Yes     Ta    >0  .   It \&%N     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0  .   It \&%O     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n  .   It \&%P     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0  .   It \&%R     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ft    Ta    \&No  Ta    Yes     Ta    n  .   It \&%T     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0  .   It \&%V     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.In    Ta    \&No  Ta    \&No    Ta    n  .   It \&Ad     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Li    Ta    Yes   Ta    Yes     Ta    >0  .   It \&An     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Nd    Ta    \&No  Ta    \&No    Ta    n  .   It \&Ap     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n  .   It \&Ar     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n  .   It \&At     Ta    Yes      Ta    Yes      Ta    1
 .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n  .   It \&Bsx    Ta    Yes      Ta    Yes      Ta    n
 .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0  .   It \&Bt     Ta    \&No     Ta    \&No     Ta    0
 .It \&.St    Ta    \&No  Ta    Yes     Ta    1  .   It \&Bx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Va    Ta    Yes   Ta    Yes     Ta    >0  .   It \&Cd     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0  .   It \&Cm     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3  .   It \&Db     Ta    \&No     Ta    \&No     Ta    1
 .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Dd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Dt     Ta    \&No     Ta    \&No     Ta    n
 .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Dv     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Dx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Em     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0  .   It \&En     Ta    \&No     Ta    \&No     Ta    0
 .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Er     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Es     Ta    \&No     Ta    \&No     Ta    0
 .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Ev     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Ex     Ta    \&No     Ta    \&No     Ta    0
 .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Fa     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0  .   It \&Fd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.At    Ta    Yes   Ta    Yes     Ta    1  .   It \&Fl     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n  .   It \&Fn     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n  .   It \&Fr     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    1  .   It \&Ft     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0  .   It \&Fx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n  .   It \&Hf     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0  .   It \&Ic     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.No    Ta    Yes   Ta    Yes     Ta    0  .   It \&In     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0  .   It \&Lb     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n  .   It \&Li     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n  .   It \&Lk     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1  .   It \&Lp     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1  .   It \&Ms     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0  .   It \&Mt     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0  .   It \&Nm     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0  .   It \&No     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n  .   It \&Ns     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0  .   It \&Nx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n  .   It \&Os     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n  .   It \&Ot     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0  .   It \&Ox     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1  .   It \&Pa     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0  .   It \&Pf     Ta    \&No     Ta    Yes      Ta    1
 .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0  .   It \&Pp     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Lk    Ta    \&No  Ta    Yes     Ta    >0  .   It \&Rv     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Mt    Ta    \&No  Ta    Yes     Ta    >0  .   It \&Sm     Ta    \&No     Ta    \&No     Ta    1
 .El  .   It \&St     Ta    \&No     Ta    Yes      Ta    1
 .\" SECTION  .   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  .Sh COMPATIBILITY
 The mdoc language was traditionally a  This section documents compatibility with other roff implementations, at
 .Qq roff  this time limited to
 macro package; most existing manuals were written with mdoc syntax  . Xr groff 1 .
 dictated by system-dependent roff installations.  This section documents  The term
 compatibility with these systems.  . Qq historic groff
 .Pp  refers to those versions before the
 .Bl -dash -compact  . Pa doc.tmac
 .\" LIST-ITEM  file re-write
 .It  . Pq somewhere between 1.15 and 1.19 .
 .Sq \&Fo  . Pp
 and  . Bl -dash -compact
 .Sq \&St  .  It
 historically weren't always callable.  Both are now correctly callable.  The
 .\" LIST-ITEM  .   Sq \-split
 .It  or
 .Sq \&It \-nested  .   Sq \-nosplit
 is assumed for all lists: any list may be nested and  argument to
 .Sq \-enum  .   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
   The
   .   Sq \&sp
   macro does not accept negative numbers.
   .  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
   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
   The vertical bar
   .   Sq \(ba
   made historic groff
   .   Qq go orbital
   but is a proper delimiter in this implementation.
   .  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.  lists will restart the sequence only for the sub-list.
 .\" LIST-ITEM  .  It
 .It  .   Sq \&It \-column
 .Sq \&It \-column  syntax where column widths may be preceded by other arguments (instead
 syntax where column widths may be preceeded by other arguments (instead  
 of proceeded) is not supported.  of proceeded) is not supported.
 .\" LIST-ITEM  .  It
 .It  The
 The  .   Sq \&At
 .Sq \&At  
 macro only accepts a single parameter.  macro only accepts a single parameter.
 .\" LIST-ITEM  .  It
 .It  
 The system-name macros (  
 .Ns Sq \&At ,  
 .Sq \&Bsx ,  
 .Sq \&Bx ,  
 .Sq \&Fx ,  
 .Sq \&Nx ,  
 .Sq \&Ox ,  
 and  
 .Sq \&Ux )  
 are callable.  
 .\" LIST-ITEM  
 .It  
 Some manuals use  Some manuals use
 .Sq \&Li  .   Sq \&Li
 incorrectly by following it with a reserved character and expecting the  incorrectly by following it with a reserved character and expecting the
 delimiter to render.  This is not supported.  delimiter to render.  This is not supported.
 .\" LIST-ITEM  .  It
 .It  In groff, the
 .Sq \&Cd  .   Sq \&Fo
 is callable.  macro only produces the first parameter.  This is no longer the case.
 .El  . 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 .
 .\" SECTION  .
   .
 .Sh CAVEATS  .Sh CAVEATS
 There are several ambiguous parts of mdoc.  There are many ambiguous parts of mdoc.
 .Pp  . Pp
 .Bl -dash -compact  . Bl -dash -compact
 .\" LIST-ITEM  .  It
 .It  .   Sq \&Fa
 .Sq \&Fa  should be
 should be  .   Sq \&Va
 .Sq \&Va  
 as function arguments are variables.  as function arguments are variables.
 .\" LIST-ITEM  .  It
 .It  .   Sq \&Ft
 .Sq \&Ft  
 should be  should be
 .Sq \&Vt  .   Sq \&Vt
 as function return types are still types.  Furthermore, the  as function return types are still types.  Furthermore, the
 .Sq \&Ft  .   Sq \&Ft
 should be removed and  should be removed and
 .Sq \&Fo ,  .   Sq \&Fo ,
 which ostensibly follows it, should follow the same convention as  which ostensibly follows it, should follow the same convention as
 .Sq \&Va .  .   Sq \&Va .
 .\" LIST-ITEM  .  It
 .It  .   Sq \&Va
 .Sq \&Va  
 should formalise that only one or two arguments are acceptable: a  should formalise that only one or two arguments are acceptable: a
 variable name and optional, preceeding type.  variable name and optional, preceding type.
 .\" LIST-ITEM  .  It
 .It  .   Sq \&Fd
 .Sq \&Fd  
 is ambiguous.  It's commonly used to indicate an include file in the  is ambiguous.  It's commonly used to indicate an include file in the
 synopsis section.  synopsis section.
 .Sq \&In  .   Sq \&In
 should be used, instead.  should be used, instead.
 .\" LIST-ITEM  .  It
 .It  
 Only the  Only the
 .Sq \-literal  .   Sq \-literal
 argument to  argument to
 .Sq \&Bd  .   Sq \&Bd
 makes sense.  The remaining ones should be removed.  makes sense.  The remaining ones should be removed.
 .\" LIST-ITEM  .  It
 .It  The
 The  .   Sq \&Xo
 .Sq \&Xo  
 and  and
 .Sq \&Xc  .   Sq \&Xc
 macros should be deprecated.  macros should be deprecated.
 .\" LIST-ITEM  .  It
 .It  
 The  The
 .Sq \&Dt  .   Sq \&Dt
 macro lacks clarity.  It should be absolutely clear which title will  macro lacks clarity.  It should be absolutely clear which title will
 render when formatting the manual page.  render when formatting the manual page.
 .El  .  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.5  
changed lines
  Added in v.1.56
CVSweb