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

Diff for /mandoc/mdoc.7 between version 1.3 and 1.59

version 1.3, 2009/03/13 13:56:13 version 1.59, 2009/08/20 13:32:09
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,
   and usage.  Our reference implementation is
   .Xr mandoc 1 .
   The
   .Sx COMPATIBILITY
   section describes compatibility with
   .Xr groff 1 .
   .
   .Pp
   An
 .Nm  .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.
   .Ed
   .
   .
   .Sh LANGUAGE SYNTAX
 .Nm  .Nm
 documents may contain only printable alphanumeric characters, the space  documents may contain only graphable 7-bit ASCII characters, the space
 character  character, and, in certain circumstances, the tab character.  All
 .Sq \  ,  manuals must have
 and, in certain circumstances, the tab character  .Ux
 .Sq \et .  line terminators.
 All manuals must have  .
 .Sq \en  .
 line termination.  .Ss Comments
 .\" SUB-SECTION  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.  Macro lines with only a control charater and optionally
   whitespace are stripped from input.
   .
   .
 .Ss Reserved Characters  .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 \&,
Line 72  Within a macro line, the following characters are rese
Line 93  Within a macro line, the following characters are rese
 .It \&?  .It \&?
 .Pq question  .Pq question
 .It \&!  .It \&!
 .Pq exclmamation  .Pq exclamation
   .It \&|
   .Pq vertical bar
 .El  .El
   .
 .Pp  .Pp
 Use of these characters must either be escaped with a non-breaking space  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&  .Pq Sq \e&
 or, if applicable, an appropriate escape-sequence used.  Use of reserved  or, if applicable, an appropriate escape sequence used.
 characters is described later in this document.  .
 .\" SUB-SECTION  .
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special characters may occur in both macro and free-form lines.
 .Sq \\  Sequences begin with the escape character
 and followed by either an open-parenthesis  .Sq \e
   followed by either an open-parenthesis
 .Sq \&(  .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
   .Xr mandoc_char 7
   for a complete list.  Examples include
   .Sq \e(em
   .Pq em-dash
   and
   .Sq \ee
   .Pq back-slash .
   .
   .
   .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
   (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.
   \&.Bd \-literal
   These         are              not.
   \&.Ed
   .Ed
   .
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  In macro lines, whitespace delimits arguments and is discarded.  If
 .Sq \\* ,  arguments are quoted, whitespace within the quotes is retained.
 with the same combinations as described above.  This form, however, is  .
 deprecated.  The following is a table of all available escapes, arranged  
 by classification.  
 .Pp  .Pp
 Grammatic:  Blank lines are only permitted within literal contexts, as are lines
 .Bl -tag -width 12n -offset "XXXX" -compact  containing only whitespace.  Tab characters are only acceptable when
 .It \\(em  delimiting
 .Pq em-dash  .Sq \&Bl \-column
 .It \\(en  or when in a literal context.
 .Pq en-dash  .
 .It \e-  .
 .Pq hyphen  .Ss Quotation
 .It \\\\  Macro arguments may be quoted with a double-quote to group
 .Pq back-slash  space-delimited terms or to retain blocks of whitespace.  A quoted
 .It \e'  argument begins with a double-quote preceded by whitespace.  The next
 .Pq apostrophe  double-quote not pair-wise adjacent to another double-quote terminates
 .It \e`  the literal, regardless of surrounding whitespace.
 .Pq back-tick  .
 .It \\  
 .Pq space  
 .It \\.  
 .Pq period  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Enclosures:  This produces tokens
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq a" ,
 .It \\(rC  .Sq b c ,
 .Pq right brace  .Sq de ,
 .It \\(lC  and
 .Pq left brace  .Sq fg" .
 .It \\(ra  Note that any quoted term, be it argument or macro, is indiscriminately
 .Pq right angle  considered literal text.  Thus, the following produces
 .It \\(la  .Sq \&Em a :
 .Pq left angle  .Bd -literal -offset indent
 .It \\(rB  \&.Em "Em a"
 .Pq right bracket  .Ed
 .It \\(lB  .
 .Pq left bracket  
 .It \\q  
 .Pq double-quote  
 .It \\(lq  
 .Pq left double-quote  
 .It \\(Lq  
 .Pq left double-quote, deprecated  
 .It \\(rq  
 .Pq right double-quote  
 .It \\(Rq  
 .Pq right double-quote, deprecated  
 .It \\(oq  
 .Pq left single-quote  
 .It \\(aq  
 .Pq right single-quote  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Indicatives:  In free-form mode, quotes are regarded as opaque text.
 .Bl -tag -width 12n -offset "XXXX" -compact  .
 .It \\(<-  .
 .Pq left arrow  .Sh MANUAL STRUCTURE
 .It \\(->  Each
 .Pq right arrow  .Nm
 .It \\(ua  document must begin with a document prologue, containing, in order,
 .Pq up arrow  .Sq \&Dd ,
 .It \\(da  .Sq \&Dt ,
 .Pq down arrow  and
 .El  .Sq \&Os ,
 .\" PARAGRAPH  then the NAME section containing at least one
   .Sq \&Nm
   followed by
   .Sq \&Nd :
   .Bd -literal -offset indent
   \&.Dd $\&Mdocdate$
   \&.Dt mdoc 7
   \&.Os
   \&.
   \&.Sh NAME
   \&.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
   .
 .Pp  .Pp
 Mathematical:  Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
 .Bl -tag -width 12n -offset "XXXX" -compact  but non-compulsory.
 .It \\(Gt  .
 .Pq greater-than, deprecated  .
 .It \\(Lt  .Sh MACRO SYNTAX
 .Pq less-than, deprecated  Macros are one to three three characters in length and begin with a
 .It \\(<=  control character ,
 .Pq less-than-equal  .Sq \&. ,
 .It \\(Le  at the beginning of the line.  An arbitrary amount of whitespace may
 .Pq less-than-equal, deprecated  sit between the control character and the macro name.  Thus,
 .It \\(>=  .Sq \&.Pp
 .Pq greater-than-equal  and
 .It \\(Ge  .Sq \&.\ \ \ \&Pp
 .Pq greater-than-equal  are equivalent.  Macro names are two or three characters in length.
 .It \\(==  .
 .Pq equal  
 .It \\(!=  
 .Pq not equal  
 .It \\(Ne  
 .Pq not equal, deprecated  
 .It \\(if  
 .Pq infinity  
 .It \\(If  
 .Pq infinity, deprecated  
 .It \\(na  
 .Pq NaN , an extension  
 .It \\(Na  
 .Pq NaN, deprecated  
 .It \\(+-  
 .Pq plus-minus  
 .It \\(Pm  
 .Pq plus-minus, deprecated  
 .It \\(**  
 .Pq asterisk  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Diacritics:  The syntax of a macro depends on its classification.  In this section,
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq \-arg
 .It \\(ga  refers to macro arguments, which may be followed by zero or more
 .Pq accent grave  .Sq parm
 .It \\(aa  parameters;
 .Pq accent accute  .Sq \&Yo
 .El  opens the scope of a macro; and if specified,
 .\" PARAGRAPH  .Sq \&Yc
   closes it out.
   .
 .Pp  .Pp
 Special symbols:  The
 .Bl -tag -width 12n -offset "XXXX" -compact  .Em Callable
 .It \\(bu  column indicates that the macro may be called subsequent to the initial
 .Pq bullet  line-macro.  If a macro is not callable, then its invocation after the
 .It \\(ba  initial line macro is interpreted as opaque text, such that
 .Pq bar  .Sq \&.Fl Sh
 .It \\(Ba  produces
 .Pq bar, deprecated  .Sq Fl Sh .
 .It \\(co  .
 .Pq copyright  
 .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.  
 .Bl -inset  
 .\" LIST-ITEM  
 .It Em Block  
 macros enclose other block macros, in-line macros or text, and  
 may span multiple lines.  
 .Qq Implicit  
 block scope is closed by a subsequent invocation of the same macro,  
 one of a set of corresponding closure macros or end-of-file.  
 .Qq Explicit  
 block scope is closed by a corresponding closure macro.  
 .Bl -inset -offset XXXX  
 .\" LIST-ITEM  
 .It Em Full-block  
 macros always span multiple lines.  They consist optionally of one or  
 more  
 .Qq heads ,  
 subsequent macros or text on the same line following invocation; a  
 .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 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  
 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).  
 .Pp  .Pp
 Block full-explicit (may contain head, body, tail):  The
 .Bd -literal -offset XXXX  .Em Parsable
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  column indicates whether the macro may be followed by further
 \(lBbody...\(rB  (ostensibly callable) macros.  If a macro is not parsable, subsequent
 \&.Yc \(lBtail...\(rB  macro invocations on the line will be interpreted as opaque text.
 .Ed  .
 .Pp  .Pp
 Block full-implicit (may contain zero or more heads, body, no tail):  The
 .Bd -literal -offset XXXX  .Em Scope
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  column, if applicable, describes closure rules.
   .
   .
   .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  \(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
 \(lBbody...\(rB  .It \&Bf     Ta    \&No     Ta    \&No     Ta    closed by \&Ef
 \&.Yc \(lBtail...\(rB  .It \&Bk     Ta    \&No     Ta    \&No     Ta    closed by \&Ek
   .It \&Bl     Ta    \&No     Ta    \&No     Ta    closed by \&El
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \  .It \&Ed     Ta    \&No     Ta    \&No     Ta    opened by \&Bd
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  .It \&Ef     Ta    \&No     Ta    \&No     Ta    opened by \&Bf
 .Ed  .It \&Ek     Ta    \&No     Ta    \&No     Ta    opened by \&Bk
 .Pp  .It \&El     Ta    \&No     Ta    \&No     Ta    opened by \&Bl
 Block partial-implicit (no head, body, no tail):  .El
 .Bd -literal -offset XXXX  .
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB  .
 .Ed  
 .Pp  
 In-line (may be closed by end-of-line, reserved character, subsequent  
 macro invocation or finite number of arguments):  
 .Bd -literal -offset XXX  
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args...  
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args... ;  
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args... Xx  
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  
 .Ed  
 .\"  
 .Sh MACROS  
 This section contains a complete list of all  
 .Nm  
 macros, arranged ontologically.  A  
 .Qq callable  
 macro is may be invoked subsequent to the initial macro-line macro.  A  
 .Qq parsable  
 macro may be followed by further (ostensibly callable) macros.  
 .\" SUB-SECTION  
 .Ss Block full-implicit  .Ss Block full-implicit
 The head of these macros follows invocation; the body is the content of  Multi-line scope closed by end-of-file or implicitly by another macro.
 subsequent lines prior to closure.  None of these macros have tails;  All macros have bodies; some
 some  
 .Po  .Po
 .Sq \&It \-bullet ,  .Sq \&It \-bullet ,
 .Sq \-hyphen ,  .Sq \-hyphen ,
 .Sq \-dash ,  .Sq \-dash ,
 .Sq \-enum ,  .Sq \-enum ,
 .Sq \-item  .Sq \-item
 .Pc  .Pc
 don't have heads.  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  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  
 .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh  
 .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss  
 .It \&.It    Ta    \&No    Ta    Yes     Ta    \&.It, \&.El  
 .El  
 .\" SUB-SECTION  
 .Ss Block full-explicit  
 None of these macros are callable or parsed.  The last column indicates  
 the explicit scope rules.  All contains bodies, some may contain heads  
 .Pq So \&Bf Sc .  
 .Pp  
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX  
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .It \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed  .It \&It     Ta    \&No     Ta    Yes      Ta    closed by \&It, \&El
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  .It \&Nd     Ta    \&No     Ta    \&No     Ta    closed by \&Sh
 .It \&.Bl    Ta    \&No    Ta    \&No    Ta    closed by \&.El  .It \&Sh     Ta    \&No     Ta    \&No     Ta    closed by \&Sh
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  .It \&Ss     Ta    \&No     Ta    \&No     Ta    closed by \&Sh, \&Ss
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  
 .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  .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  .Ss Block partial-explicit
 Each of these contains at least a body and, in limited circumstances, a  Like block full-explicit, but also with single-line scope.  Each
 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 .  .Pq So \&Ec Sc .
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc \(lBtail...\(rB
   
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
   \(lBbody...\(rB \&Yc \(lBtail...\(rB
   .Ed
   .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX  .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .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 \&.Ac    Ta    Yes   Ta    Yes    Ta    opened by \&.Ao  .It \&Ao     Ta    Yes      Ta    Yes      Ta    closed by \&Ac
 .It \&.Bc    Ta    Yes   Ta    Yes    Ta    closed by \&.Bo  .It \&Bc     Ta    Yes      Ta    Yes      Ta    closed by \&Bo
 .It \&.Bo    Ta    Yes   Ta    Yes    Ta    opened by \&.Bc  .It \&Bo     Ta    Yes      Ta    Yes      Ta    opened by \&Bc
 .It \&.Pc    Ta    Yes   Ta    Yes    Ta    closed by \&.Po  .It \&Brc    Ta    Yes      Ta    Yes      Ta    opened by \&Bro
 .It \&.Po    Ta    Yes   Ta    Yes    Ta    opened by \&.Pc  .It \&Bro    Ta    Yes      Ta    Yes      Ta    closed by \&Brc
 .It \&.Do    Ta    Yes   Ta    Yes    Ta    closed by \&.Dc  .It \&Dc     Ta    Yes      Ta    Yes      Ta    opened by \&Do
 .It \&.Dc    Ta    Yes   Ta    Yes    Ta    opened by \&.Do  .It \&Do     Ta    Yes      Ta    Yes      Ta    closed by \&Dc
 .It \&.Xo    Ta    Yes   Ta    Yes    Ta    closed by \&.Xc  .It \&Ec     Ta    Yes      Ta    Yes      Ta    opened by \&Eo
 .It \&.Xc    Ta    Yes   Ta    Yes    Ta    opened by \&.Xo  .It \&Eo     Ta    Yes      Ta    Yes      Ta    closed by \&Ec
 .It \&.Bro   Ta    Yes   Ta    Yes    Ta    closed by \&.Brc  .It \&Fc     Ta    Yes      Ta    Yes      Ta    opened by \&Fo
 .It \&.Brc   Ta    Yes   Ta    Yes    Ta    opened by \&.Bro  .It \&Fo     Ta    \&No     Ta    \&No     Ta    closed by \&Fc
 .It \&.Oc    Ta    Yes   Ta    Yes    Ta    closed by \&.Oo  .It \&Oc     Ta    Yes      Ta    Yes      Ta    closed by \&Oo
 .It \&.Oo    Ta    Yes   Ta    Yes    Ta    opened by \&.Oc  .It \&Oo     Ta    Yes      Ta    Yes      Ta    opened by \&Oc
 .It \&.So    Ta    Yes   Ta    Yes    Ta    closed by \&.Sc  .It \&Pc     Ta    Yes      Ta    Yes      Ta    closed by \&Po
 .It \&.Sc    Ta    Yes   Ta    Yes    Ta    opened by \&.So  .It \&Po     Ta    Yes      Ta    Yes      Ta    opened by \&Pc
 .It \&.Fc    Ta    Yes   Ta    Yes    Ta    opened by \&.Fo  .It \&Qc     Ta    Yes      Ta    Yes      Ta    opened by \&Oo
 .It \&.Fo    Ta    \&No  Ta    \&No   Ta    closed by \&.Fc  .It \&Qo     Ta    Yes      Ta    Yes      Ta    closed by \&Oc
 .It \&.Ec    Ta    Yes   Ta    Yes    Ta    opened by \&.Eo  .It \&Re     Ta    \&No     Ta    \&No     Ta    opened by \&Rs
 .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec  .It \&Rs     Ta    \&No     Ta    \&No     Ta    closed by \&Re
 .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo  .It \&Sc     Ta    Yes      Ta    Yes      Ta    opened by \&So
 .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc  .It \&So     Ta    Yes      Ta    Yes      Ta    closed by \&Sc
 .It \&.Re    Ta    \&No  Ta    \&No   Ta    opened by \&.Rs  .It \&Xc     Ta    Yes      Ta    Yes      Ta    opened by \&Xo
 .It \&.Rs    Ta    \&No  Ta    \&No   Ta    closed by \&.Re  .It \&Xo     Ta    Yes      Ta    Yes      Ta    closed by \&Xc
 .El  .El
 .\" SUB-SECTION  .
 .Ss In-line  .
 In-line macros have only text children.  If a number (or inequality) of  .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  arguments is
 .Pq n ,  .Pq n ,
 then the macro accepts an arbitrary number of arguments.  then the macro accepts an arbitrary number of arguments.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
   .Ed
   .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX  .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
 .It \&.Dd    Ta    \&No  Ta    \&No    Ta    >0  .It \&%A     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n  .It \&%B     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Os    Ta    \&No  Ta    \&No    Ta    n  .It \&%C     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0  .It \&%D     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n  .It \&%I     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.An    Ta    \&No  Ta    Yes     Ta    n  .It \&%J     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n  .It \&%N     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0  .It \&%O     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n  .It \&%P     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Dv    Ta    Yes   Ta    Yes     Ta    >0  .It \&%R     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0  .It \&%T     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ev    Ta    Yes   Ta    Yes     Ta    >0  .It \&%V     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0  .It \&Ad     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Fa    Ta    Yes   Ta    Yes     Ta    >0  .It \&An     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0  .It \&Ap     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n  .It \&Ar     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0  .It \&At     Ta    Yes      Ta    Yes      Ta    1
 .It \&.Ft    Ta    \&No  Ta    Yes     Ta    n  .It \&Bsx    Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0  .It \&Bt     Ta    \&No     Ta    \&No     Ta    0
 .It \&.In    Ta    \&No  Ta    \&No    Ta    n  .It \&Bx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Li    Ta    Yes   Ta    Yes     Ta    >0  .It \&Cd     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Nd    Ta    \&No  Ta    \&No    Ta    n  .It \&Cm     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n  .It \&Db     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n  .It \&Dd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n  .It \&Dt     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0  .It \&Dv     Ta    Yes      Ta    Yes      Ta    n
 .It \&.St    Ta    \&No  Ta    Yes     Ta    1  .It \&Dx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Va    Ta    Yes   Ta    Yes     Ta    >0  .It \&Em     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0  .It \&En     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3  .It \&Er     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0  .It \&Es     Ta    \&No     Ta    \&No     Ta    0
 .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0  .It \&Ev     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0  .It \&Ex     Ta    \&No     Ta    \&No     Ta    n
 .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0  .It \&Fa     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0  .It \&Fd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0  .It \&Fl     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0  .It \&Fn     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0  .It \&Fr     Ta    \&No     Ta    \&No     Ta    n
 .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0  .It \&Ft     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0  .It \&Fx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0  .It \&Hf     Ta    \&No     Ta    \&No     Ta    n
 .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0  .It \&Ic     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.At    Ta    Yes   Ta    Yes     Ta    1  .It \&In     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n  .It \&Lb     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n  .It \&Li     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    1  .It \&Lk     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0  .It \&Lp     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n  .It \&Ms     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0  .It \&Mt     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.No    Ta    Yes   Ta    Yes     Ta    0  .It \&Nm     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0  .It \&No     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n  .It \&Ns     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n  .It \&Nx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1  .It \&Os     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1  .It \&Ot     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0  .It \&Ox     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0  .It \&Pa     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0  .It \&Pf     Ta    \&No     Ta    Yes      Ta    1
 .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n  .It \&Pp     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0  .It \&Rv     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n  .It \&Sm     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n  .It \&St     Ta    \&No     Ta    Yes      Ta    1
 .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0  .It \&Sx     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1  .It \&Sy     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0  .It \&Tn     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0  .It \&Ud     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Lk    Ta    \&No  Ta    Yes     Ta    >0  .It \&Ux     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Mt    Ta    \&No  Ta    Yes     Ta    >0  .It \&Va     Ta    Yes      Ta    Yes      Ta    n
   .It \&Vt     Ta    Yes      Ta    Yes      Ta    >0
   .It \&Xr     Ta    Yes      Ta    Yes      Ta    >0, <3
   .It \&br     Ta    \&No     Ta    \&No     Ta    0
   .It \&sp     Ta    \&No     Ta    \&No     Ta    1
   .El
   .
   .
   .Sh COMPATIBILITY
   This section documents compatibility with other roff implementations, at
   this time limited to
   .Xr groff 1 .
   The term
   .Qq historic groff
   refers to those versions before the
   .Pa doc.tmac
   file re-write
   .Pq somewhere between 1.15 and 1.19 .
   .
   .Pp
   .Bl -dash -compact
   .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
   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.
   .It
   .Sq \&It \-column
   syntax where column widths may be preceded by other arguments (instead
   of proceeded) is not supported.
   .It
   The
   .Sq \&At
   macro only accepts a single parameter.
   .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
   In groff, the
   .Sq \&Fo
   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 HISTORY  
 This manual describes the language accepted by  
 .Xr mdoc 3 ,  
 which implements the roff-mdoc macro package.  
 .\" 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.3  
changed lines
  Added in v.1.59
CVSweb