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

Diff for /mandoc/mdoc.7 between version 1.1 and 1.34

version 1.1, 2009/03/13 07:46:10 version 1.34, 2009/06/25 11:35:28
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  .\" SECTION
 .Sh NAME  .Sh NAME
 .Nm mdoc  .Nm mdoc
 .Nd mdoc macro reference  .Nd mdoc language reference
 .\" SECTION  .\" SECTION
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
Line 30  The
Line 28  The
 language is used to format  language is used to format
 .Bx  .Bx
 .Ux  .Ux
 manuals.  An  manuals.  In this reference document, we describe the syntax and
   structure of the
 .Nm  .Nm
   language.  Our reference implementation is
   .Xr mandoc 1 .
   The
   .Sx COMPATIBILITY
   section describes compatibility with
   .Xr groff 1 .
   .\" PARAGRAPH
   .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:
   .Bd -literal -offset XXX
   \&.Sh Macro lines change control state.
   Other lines are interpreted within the current state.
   .Ed
 .\" SECTION  .\" SECTION
 .Sh CHARACTER ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
 documents may contain only printable alphanumeric characters, the space  documents may contain only graphable 7-bit ASCII characters, the space
 character  character
 .Sq \  ,  .Sq \  ,
 and, in certain circumstances, the tab character  and, in certain circumstances, the tab character
 .Sq \et .  .Sq \et .
 All manuals must have  All manuals must have
 .Sq \en  .Sq \en
 line termination.  line termination.
 .\" SUB-SECTION  
 .Ss Special Characters  
 Within a macro line, the following characters are special:  
 .\" PARAGRAPH  
 .Pp  .Pp
   The only time a blank line is acceptable is within
   the context of
   .Sq \&.Bd \-literal
   or
   .Sq \&.Bd \-unfilled .
   .Pp
   Tab characters
   .Pq \et
   are only acceptable when delimiting
   .Sq \&.Bl \-column
   and in
   .Sq \&.Bd \-literal
   or
   .Sq \&.Bd \-unfilled
   contexts.
   .\" SUB-SECTION
   .Ss Comments
   Anything following a
   .Sq \e"
   delimiter is considered a comment (unless the
   .Sq \e
   itself has been escaped) and is ignored to the end of line.
   Furthermore, a macro line with only a control character
   .Sq \. ,
   optionally followed by whitespace, is ignored.
   .\" SUB-SECTION
   .Ss Reserved Characters
   Within a macro line, the following characters are reserved:
 .Bl -tag -width Ds -offset XXXX -compact  .Bl -tag -width Ds -offset XXXX -compact
 .It \&.  .It \&.
 period  .Pq period
 .It \&,  .It \&,
 comma  .Pq comma
 .It \&:  .It \&:
 colon  .Pq colon
 .It \&;  .It \&;
 semicolon  .Pq semicolon
 .It \&(  .It \&(
 left-parenthesis  .Pq left-parenthesis
 .It \&)  .It \&)
 right-parenthesis  .Pq right-parenthesis
 .It \&[  .It \&[
 left-bracket  .Pq left-bracket
 .It \&]  .It \&]
 right-bracket  .Pq right-bracket
 .It \&?  .It \&?
 question  .Pq question
 .It \&!  .It \&!
 exclmamation  .Pq exclamation
   .It \&|
   .Pq vertical bar
 .El  .El
   .\" PARAGRAPH
 .Pp  .Pp
 Use of these characters must either be escaped with a non-breaking space  Use of reserved characters is described in
   .Sx Closure .
   For general non-reserved use, characters must either be escaped 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  .\" SUB-SECTION
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special character sequences begin with the escape character
 .Sq \\  .Sq \e
 and followed by either an open-parenthesis  followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
 for two-character sequences; an open-bracket  for two-character sequences; an open-bracket
 .Sq \&[  .Sq \&[
Line 92  for n-character sequences (terminated at a close-brack
Line 135  for n-character sequences (terminated at a close-brack
 or a single one-character sequence.  or a single one-character sequence.
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  Characters may alternatively be escaped by a slash-asterisk,
 .Sq \\* ,  .Sq \e* ,
 with the same combinations as described above.  This form, however, is  with the same combinations as described above.  This form is deprecated.
 deprecated.  The following is a table of all available escapes, arranged  .\" SUB-SECTION
 by classification.  .Ss Whitespace
 .Pp  Unless in literal mode or specifically escaped, consecutive blocks of
 Grammatic:  whitespace are pruned from input.  These are later re-added, if
 .Pp  applicable, by a front-end utility such as
 .Bl -tag -width 12n -offset "XXXX" -compact  .Xr mandoc 1 .
 .It \\(em  
 .Pq em-dash  
 .It \\(en  
 .Pq en-dash  
 .It \e-  
 .Pq hyphen  
 .It \\\\  
 .Pq back-slash  
 .It \e'  
 .Pq apostrophe  
 .It \e`  
 .Pq back-tick  
 .It \\  
 .Pq space  
 .It \\.  
 .Pq period  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Enclosures:  
 .Pp  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(rC  
 .Pq right brace  
 .It \\(lC  
 .Pq left brace  
 .It \\(ra  
 .Pq right angle  
 .It \\(la  
 .Pq left angle  
 .It \\(rB  
 .Pq right bracket  
 .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  
 Indicatives:  
 .Pp  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(<-  
 .Pq left arrow  
 .It \\(->  
 .Pq right arrow  
 .It \\(ua  
 .Pq up arrow  
 .It \\(da  
 .Pq down arrow  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Mathematical:  
 .Pp  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(Gt  
 .Pq greater-than, deprecated  
 .It \\(Lt  
 .Pq less-than, deprecated  
 .It \\(<=  
 .Pq less-than-equal  
 .It \\(Le  
 .Pq less-than-equal, deprecated  
 .It \\(>=  
 .Pq greater-than-equal  
 .It \\(Ge  
 .Pq greater-than-equal  
 .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  
 Diacritics:  
 .Pp  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(ga  
 .Pq accent grave  
 .It \\(aa  
 .Pq accent accute  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Special symbols:  
 .Pp  
 .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 \\&  
 .Pq non-breaking space  
 .It \\e  
 .Pq escape  
 .It \\(Am  
 .Pq ampersand, deprecated  
 .El  
 .\" SECTION  .\" SECTION
 .Sh CLASSIFICATION  .Sh STRUCTURE
 Macros are classified in an ontology described by scope rules.  Each
 .Bl -tag -width "in-lineX"  .Nm
   document must begin with the document prologue, containing, in order,
   .Sq \&.Dd ,
   .Sq \&.Dt ,
   and
   .Sq \&.Os .
   Following these, the document body must begin with the NAME section
   containing at least one
   .Sq \&.Nm
   followed by a
   .Sq \&.Nd
   macro.
   .Pp
   At least one free-form or macro line must follow this prologue.
   .\"
   .Ss Classification
   Macros are classified by their scope rules.  Some macros are allowed to
   deviate from their classifications to preserve backward-compatibility
   with old macro combinations still found in the manual corpus.  These are
   specifically noted on a per-macro basis.
   .\" SUB-SECTION
   .Ss Scope
   .Bl -inset
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em Block  .It Em Block
 Block macros enclose other block macros, in-line macros or text, and  macros enclose other block macros, in-line macros or text, and
 may span multiple lines.  may span multiple lines.
 .Qq Implicit  .Bl -inset -offset XXXX
 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 -tag -width "partial-blockX"  
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em Full-block  .It Em Full-block
 Always spans multiple lines.  Consists optionally of one or more  macros always span multiple lines.  They consist of zero or
   more
 .Qq heads ,  .Qq heads ,
 subsequent macros or text on the same line following invocation; a  subsequent macros or text on the same line following invocation; an
   optional
 .Qq body ,  .Qq body ,
 which spans subsequent lines of text or macros; and an optional  which spans subsequent lines of text or macros; and an optional
 .Qq tail ,  .Qq tail ,
 macros or text on the same line following closure.  macros or text on the same line following closure.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em Partial-block  .It Em Partial-block
 May span multiple lines.  Consists optionally of a  macros may span multiple lines.  They consists of a optional
 .Qq head ,  .Qq head ,
 text immediately following invocation; always a  text immediately following invocation; always a
 .Qq body ,  .Qq body ,
Line 264  text or macros following the head on the same and subs
Line 195  text or macros following the head on the same and subs
 optionally a  optionally a
 .Qq tail ,  .Qq tail ,
 text immediately following closure.  text immediately following closure.
 .El  
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em In-line  .It Em In-line
 In-line macros may only enclose text and span at most a single line.  If  macros may only enclose text and span at most a single line.
 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  .El
 .\" .\" SUB-SECTION  .El
 .\" .Ss Examples  .\" SUB-SECTION
 .\" The following examples illustrate each macro classification.  .Ss Closure
 .\" .\" PARAGRAPH  Closure of a macro's scope depends first on its classification, then
 .\" .Pp  on whether it's parsable.  In this table,
 .\" Implicit full-block.  Has head, body and no tail.  Scope closed by  .Sq BFE
 .\" second  refers to block full-explicit and so on.
 .\" .Sq \&Sh  .\" PARAGRAPH
 .\" invocation.  .Pp
 .\" .Bd -literal -offset XXXX  .Bl -tag -width 12n -offset XXXX -compact
 .\" \&.Sh SECTION 1  .It BPE , BFE
 .\" body...  corresponding explicit closure macro
 .\" \&.Sh SECTION 2  .It BFI
 .\" .Ed  end-of-file or a corresponding implicit closure macro
 .\" .\" PARAGRAPH  .It BPI
 .\" .Pp  end-of-line (body may be closed by >0 space-separated
 .\" Nested implicit full-block, where the subsection  .Sx Reserved Characters ,
 .\" .Sq \&Ss  although block scope will still be open)
 .\" is within the scope of the parent section  .It INL
 .\" .Sq \&Sh  end-of-line
 .\" and closed along with its parent by the subsequent  .El
 .\" .Sq \&Sh .  .\" PARAGRAPH
 .\" .Bd -literal -offset XXXX  .Pp
 .\" \&.Sh SECTION 1  If a macro (block or in-line) is parsable, it may also be closed out by
 .\" \&.Ss Subsection 1  one of the following scenarios (unless specifically noted otherwise):
 .\" body...  .\" PARAGRAPH
 .\" \&.Sh SECTION 2  .Pp
 .\" .Ed  .Bl -dash -offset XXXX -compact
 .\" .\" PARAGRAPH  .It
 .\" .Pp  a sequence of >0 space-separated
 .\" Explicit full-block.  Has a head, a body and no tail.  Scope closed by  .Sx Reserved Characters ,
 .\" .Sq \&Ef  .It
 .\" invocation.  another macro,
 .\" .Bd -literal -offset XXXX  .It
 .\" \&.Bf symbolic  end-of-line, or
 .\" body...  .It
 .\" \&.Ef  completion of a set number of arguments.
 .\" .Ed  .El
 .\" .\" PARAGRAPH  .\" PARAGRAPH
 .\" .Pp  .Pp
 .\" Nested explicit/implicit scope.  If >0 space-separated
 .\" .Sq \&It  .Sx Reserved Characters
 .\" macro is an implicit block whose scope is closed by the explicit  are followed by non-reserved characters, the behaviour differs per
 .\" .Sq \&El  macro.  In general, scope of the macro is closed and re-opened:
 .\" closure.  subsequent tokens are interpreted as if the scope had just been opened.
 .\" .Bd -literal -offset XXXX  In other circumstances, scope is simply closed out.
 .\" \&.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  .\" SECTION
   .Sh SYNTAX
   Macros are two or 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
   .Ed
   .\" PARAGRAPH
   .Pp
   Block partial-explicit (may contain head, multi-line body, tail).
   .Bd -literal -offset XXXX
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc \(lBtail...\(rB
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \
   \(lBbody...\(rB \&Yc \(lBtail...\(rB
   .Ed
   .\" PARAGRAPH
   .Pp
   Block partial-implicit (no head, body, no tail).  Note that the body
   section may be followed by zero or more
   .Sx Reserved Words .
   These are in the block scope, but not in the body scope.
   .Bd -literal -offset XXXX
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB
   .Ed
   .\" PARAGRAPH
   .Pp
   In-lines have \(>=0 scoped arguments.
   .Bd -literal -offset XXX
   \&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB
   
   \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
   .Ed
   .\" SECTION
 .Sh MACROS  .Sh MACROS
 This section contains a complete list of all  This section contains a complete list of all
 .Nm  .Nm
 macros, arranged ontologically then alphanumerically by macro name.  A  macros, arranged by classification.  A
 .Qq callable  .Qq callable
 macro is may be invoked subsequent to the initial macro-line macro.  A  macro is invoked subsequent to the initial macro-line macro.  A
 .Qq parsable  .Qq parsable
 macro May be followed by further (ostensibly callable) macros.  macro may be followed by further (ostensibly callable) macros.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Block full-implicit  .Ss Block full-implicit
 The head of these macros follows invocation; the body is the content of  The head of these macros follows invocation; the body is the content of
 subsequent lines prior to closure.  None of these macros have tails;  subsequent lines prior to closure.  None of these macros have tails;
 some  some
 .Po  .Po
 .Sq \&It \-bullet ,  .Sq \&.It \-bullet ,
 .Sq \-hyphen ,  .Sq \-hyphen ,
 .Sq \-dash ,  .Sq \-dash ,
 .Sq \-enum  .Sq \-enum ,
   .Sq \-item
 .Pc  .Pc
 don't have heads.  don't have heads.
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX  .Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "Closing"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing
 .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh  .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh
 .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss  .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss
Line 397  None of these macros are callable or parsed.  The last
Line 335  None of these macros are callable or parsed.  The last
 the explicit scope rules.  All contains bodies, some may contain heads  the explicit scope rules.  All contains bodies, some may contain heads
 .Pq So \&Bf Sc .  .Pq So \&Bf Sc .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX  .Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "closed by XXX"
 .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 \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd
Line 405  the explicit scope rules.  All contains bodies, some m
Line 343  the explicit scope rules.  All contains bodies, some m
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef
 .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf  .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  .\" SUB-SECTION
 .Ss Block partial-implicit  .Ss Block partial-implicit
Line 421  close at the invocation's end-of-line.
Line 361  close at the invocation's end-of-line.
 .It \&.Qq    Ta    Yes   Ta    Yes  .It \&.Qq    Ta    Yes   Ta    Yes
 .It \&.Sq    Ta    Yes   Ta    Yes  .It \&.Sq    Ta    Yes   Ta    Yes
 .It \&.Brq   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  .El
   .\" PARAGRAPH
   .Pp
   The
   .Sq \&.Op
   may be broken by
   .Sq \&.Oc
   as in the following example:
   .Bd -literal -offset XXXX
   \&.Oo
   \&.Op Fl a Oc
   .Ed
   .Pp
   In the above example, the scope of
   .Sq \&.Op
   is technically broken by
   .Sq \&.Oc ,
   however, due to the overwhelming existence of this sequence, it's
   allowed.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Block partial-explicit  .Ss Block partial-explicit
 Each of these contains at least a body and, in limited circumstances, a  Each of these contains at least a body and, in limited circumstances, a
 head  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 .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX  .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -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
Line 454  and/or tail 
Line 415  and/or tail 
 .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec  .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec
 .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo  .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo
 .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc  .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  .El
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss General  .Ss In-line
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX  In-line macros have only text children.  If a number (or inequality) of
 .It Em Macro Ta Em Callable Ta Em Parsable  arguments is
 .It \&.Dd    Ta    \&    Ta    \&  .Pq n ,
 .It \&.Dt    Ta    \&    Ta    \&  then the macro accepts an arbitrary number of arguments.
 .It \&.Os    Ta    \&    Ta    \&  .Pp
 .It \&.Pp    Ta    \&    Ta    \&  .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX
 .It \&.D1    Ta    \&    Ta    \&  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
 .It \&.Dl    Ta    \&    Ta    Yes  .It \&.Dd    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Ad    Ta    Yes   Ta    Yes  .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n
 .It \&.An    Ta    \&    Ta    Yes  .It \&.Os    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Ar    Ta    Yes   Ta    Yes  .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Cd    Ta    Yes   Ta    \&  .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Cm    Ta    Yes   Ta    Yes  .It \&.An    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Dv    Ta    Yes   Ta    Yes  .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Er    Ta    Yes   Ta    Yes  .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0
 .It \&.Ev    Ta    Yes   Ta    Yes  .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ex    Ta    \&    Ta    \&  .It \&.Dv    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fa    Ta    Yes   Ta    Yes  .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Fd    Ta    \&    Ta    \&  .It \&.Ev    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fl    Ta    Yes   Ta    Yes  .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Fn    Ta    Yes   Ta    Yes  .It \&.Fa    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ft    Ta    \&    Ta    \&  .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Ic    Ta    Yes   Ta    Yes  .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n
 .It \&.In    Ta    \&    Ta    \&  .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Li    Ta    Yes   Ta    Yes  .It \&.Ft    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Nd    Ta    \&    Ta    \&  .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Nm    Ta    Yes   Ta    Yes  .It \&.In    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Ot    Ta    \&    Ta    \&  .It \&.Li    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Pa    Ta    Yes   Ta    Yes  .It \&.Nd    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Rv    Ta    \&    Ta    \&  .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n
 .It \&.St    Ta    Yes   Ta    \&  .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Va    Ta    Yes   Ta    Yes  .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Vt    Ta    Yes   Ta    Yes  .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Xr    Ta    Yes   Ta    Yes  .It \&.St    Ta    \&No  Ta    Yes     Ta    1
 .It \&.%A    Ta    \&    Ta    \&  .It \&.Va    Ta    Yes   Ta    Yes     Ta    n
 .It \&.%B    Ta    \&    Ta    \&  .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.%C    Ta    \&    Ta    \&  .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3
 .It \&.%D    Ta    \&    Ta    \&  .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%I    Ta    \&    Ta    \&  .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%J    Ta    \&    Ta    \&  .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%N    Ta    \&    Ta    \&  .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%O    Ta    \&    Ta    \&  .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%P    Ta    \&    Ta    \&  .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%R    Ta    \&    Ta    \&  .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%T    Ta    \&    Ta    \&  .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%V    Ta    \&    Ta    \&  .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.At    Ta    Yes   Ta    Yes  .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Bsx   Ta    Yes   Ta    Yes  .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Bx    Ta    Yes   Ta    Yes  .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Db    Ta    \&    Ta    \&  .It \&.At    Ta    Yes   Ta    Yes     Ta    1
 .It \&.Em    Ta    Yes   Ta    Yes  .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fx    Ta    Yes   Ta    Yes  .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ms    Ta    \&    Ta    Yes  .It \&.Db    Ta    \&No  Ta    \&No    Ta    1
 .It \&.No    Ta    Yes   Ta    Yes  .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ns    Ta    Yes   Ta    Yes  .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Nx    Ta    Yes   Ta    Yes  .It \&.Ms    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ox    Ta    Yes   Ta    Yes  .It \&.No    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Pf    Ta    \&    Ta    Yes  .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Ql    Ta    Yes   Ta    Yes  .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Re    Ta    \&    Ta    \&  .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Rs    Ta    \&    Ta    \&  .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1
 .It \&.Sm    Ta    \&    Ta    \&  .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Sx    Ta    Yes   Ta    Yes  .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Sy    Ta    Yes   Ta    Yes  .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Tn    Ta    Yes   Ta    Yes  .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ux    Ta    Yes   Ta    Yes  .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Bk    Ta    \&    Ta    \&  .It \&.Dx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ek    Ta    \&    Ta    \&  .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Bt    Ta    \&    Ta    \&  .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Hf    Ta    \&    Ta    \&  .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Fr    Ta    \&    Ta    \&  .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Ud    Ta    \&    Ta    \&  .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Lb    Ta    \&    Ta    \&  .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Ap    Ta    Yes   Ta    Yes  .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Lp    Ta    \&    Ta    \&  .It \&.Lk    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Lk    Ta    \&    Ta    Yes  .It \&.Mt    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Mt    Ta    \&    Ta    Yes  .It \&.Es    Ta    \&No  Ta    \&No    Ta    0
   .It \&.En    Ta    \&No  Ta    \&No    Ta    0
   .El
   .Pp
   The
   .Sq \&.Ot ,
   .Sq \&.Fr ,
   .Sq \&.Es
   and
   .Sq \&.En ,
   macros are obsolete.
   .\" SECTION
   .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
   .\" LIST-ITEM
   .It
   Historic groff has many un-callable macros.  Most of these (excluding
   some block-level macros) are now callable, conforming to the
   non-historic groff version.
   .\" LIST-ITEM
   .It
   The vertical bar
   .Sq \(Ba
   made historic groff
   .Qq go orbital
   but is a proper delimiter in this implementation.
   .\" LIST-ITEM
   .It
   .Sq \&.It \-nested
   is assumed for all lists (it wasn't in historic groff): any list may be
   nested and
   .Sq \-enum
   lists will restart the sequence only for the sub-list.
   .\" LIST-ITEM
   .It
   .Sq \&.It \-column
   syntax where column widths may be preceded by other arguments (instead
   of proceeded) is not supported.
   .\" LIST-ITEM
   .It
   The
   .Sq \&.At
   macro only accepts a single parameter.
   .\" LIST-ITEM
   .It
   Some manuals use
   .Sq \&.Li
   incorrectly by following it with a reserved character and expecting the
   delimiter to render.  This is not supported.
   .\" LIST-ITEM
   .It
   If an special-character control character
   .Sq \e
   is escaped, it will
   obviously not render the sequence.  Even newer versions of groff seem to
   dither on this.
   .El
   .\" SECTION
   .Sh SEE ALSO
   .Xr mandoc 1 ,
   .Xr mandoc_char 7
   .\" SECTION
   .Sh AUTHORS
   The
   .Nm
   utility was written by
   .An Kristaps Dzonsons Aq kristaps@kth.se .
   .\" SECTION
   .Sh CAVEATS
   There are many ambiguous parts of mdoc.
   .Pp
   .Bl -dash -compact
   .\" LIST-ITEM
   .It
   .Sq \&.Fa
   should be
   .Sq \&.Va
   as function arguments are variables.
   .\" LIST-ITEM
   .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 .
   .\" LIST-ITEM
   .It
   .Sq \&.Va
   should formalise that only one or two arguments are acceptable: a
   variable name and optional, preceding type.
   .\" LIST-ITEM
   .It
   .Sq \&.Fd
   is ambiguous.  It's commonly used to indicate an include file in the
   synopsis section.
   .Sq \&.In
   should be used, instead.
   .\" LIST-ITEM
   .It
   Only the
   .Sq \-literal
   argument to
   .Sq \&.Bd
   makes sense.  The remaining ones should be removed.
   .\" LIST-ITEM
   .It
   The
   .Sq \&.Xo
   and
   .Sq \&.Xc
   macros should be deprecated.
   .\" LIST-ITEM
   .It
   The
   .Sq \&.Dt
   macro lacks clarity.  It should be absolutely clear which title will
   render when formatting the manual page.
   .\" LIST-ITEM
   .It
   A
   .Sq \&.Lx
   should be provided for Linux (\(`a la
   .Sq \&.Ox ,
   .Sq \&.Nx
   etc.).
   .\" LIST-ITEM
   .It
   There's no way to refer to references in
   .Sq \&.Rs/.Re
   blocks.
   .\" LIST-ITEM
   .It
   The \-split and \-nosplit arguments to
   .Sq \&.An
   are inane.
 .El  .El
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.34
CVSweb