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

Diff for /mandoc/mdoc.7 between version 1.42 and 1.43

version 1.42, 2009/07/13 07:23:07 version 1.43, 2009/07/14 15:57:08
Line 17 
Line 17 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MDOC 7  .Dt MDOC 7
 .Os  .Os
 .\" SECTION  .\" SECTION---------------------------------------------
 .Sh NAME  .Sh NAME
 .Nm mdoc  .Nm mdoc
 .Nd mdoc language reference  .Nd mdoc language reference
 .\" SECTION  .\" 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.  In this reference document, we describe the syntax and  manuals.  In this reference document, we describe its syntax, structure,
 structure of the  and usage.  Our reference implementation is
 .Nm  
 language.  Our reference implementation is  
 .Xr mandoc 1 .  .Xr mandoc 1 .
 The  The
 .Sx COMPATIBILITY  .Sx COMPATIBILITY
 section describes compatibility with  section describes compatibility with
 .Xr groff 1 .  .Xr groff 1 .
 .\" PARAGRAPH  .\" PARAGRAPH------------
 .Pp  .Pp
 An  An
 .Nm  .Nm
Line 50  prior macros:
Line 48  prior macros:
 \&.Sh Macro lines change control state.  \&.Sh Macro lines change control state.
 Other lines are interpreted within the current state.  Other lines are interpreted within the current state.
 .Ed  .Ed
 .\" SECTION  .\" SECTION---------------------------------------------
 .Sh INPUT ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII 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 .  
 All manuals must have  
 .Sq \en  
 line termination.  line termination.
 .Pp  .\" SUB-SECTION----------------------
 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  .Ss Comments
 Anything following a  Text following a
 .Sq \e"  .Sq \e" ,
 delimiter is considered a comment (unless the  whether in a macro or free-form text line, is ignored to the end of
 .Sq \e  line.  A macro line with only a control character and comment escape,
 itself has been escaped) and is ignored to the end of line.  .Sq \&.\e" ,
 Furthermore, a macro line with only a control character  is also ignored.
 .Sq \. ,  .\" SUB-SECTION----------------------
 optionally followed by whitespace, is ignored.  
 .\" SUB-SECTION  
 .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 Ds -offset indent -compact  .Bl -tag -width Ds -offset indent -compact
Line 114  Within a macro line, the following characters are rese
Line 91  Within a macro line, the following characters are rese
 .It \&|  .It \&|
 .Pq vertical bar  .Pq vertical bar
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH------------
 .Pp  .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  .\" 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.
   Sequences begin with the escape character
 .Sq \e  .Sq \e
 followed by either an open-parenthesis  followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
Line 132  for two-character sequences; an open-bracket
Line 110  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 1
   for a complete list.  Examples include
   .Sq \e(em
   .Pq em-dash
   and
   .Sq \ee
   .Pq back-slash .
   .\" PARAGRAPH------------
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  An alternative escape sequence is
   the slash-asterisk,
 .Sq \e* ,  .Sq \e* ,
 with the same combinations as described above.  but this method is discouraged for compatibility reasons.
   .\" PARAGRAPH------------
 .Pp  .Pp
 Terms may also be text-decorated using the  Terms may
   also be text-decorated using the
 .Sq \ef  .Sq \ef
 escape followed by a text-decoration letter: B (bold), I, (italic), or P  escape followed by an indicator: B (bold), I, (italic), or P and R
 and R (Roman, or reset).  This form is not recommended.  (Roman, or reset).  This form is not recommended.
 .\" SUB-SECTION  .\" SUB-SECTION----------------------
 .Ss Whitespace  .Ss Whitespace
 Unless in literal mode or specifically escaped, consecutive blocks of  In general, consecutive blocks of whitespace are pruned from input.
 whitespace are pruned from input.  These are later re-added, if  These are later re-added, when applicable, by
 applicable, by a front-end utility such as  
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .\" SECTION  .\" PARAGRAPH------------
 .Sh STRUCTURE  .Pp
   Blank lines are permitted within
   .Sq \&Bd \-literal
   or
   .Sq \&Bd \-unfilled
   contexts.  Tab characters are only acceptable when delimiting
   .Sq \&Bl \-column
   and in
   .Sq \&Bd \-literal
   or
   .Sq \&Bd \-unfilled
   contexts.
   .\" SECTION---------------------------------------------
   .Sh MANUAL STRUCTURE
 Each  Each
 .Nm  .Nm
 document must begin with the document prologue, containing, in order,  document must begin with a document prologue, containing, in order,
 .Sq \&.Dd ,  .Sq \&Dd ,
 .Sq \&.Dt ,  .Sq \&Dt ,
 and  and
 .Sq \&.Os .  .Sq \&Os
   (using this manual as an example):
   .Bd -literal -offset indent
   \&.Dd $\&Mdocdate$
   \&.Dt mdoc 7
   \&.Os
   \&.Sh NAME
   \&.Nm mdoc
   \&.Nd mdoc language reference
   .Ed
   .Pp
 Following these, the document body must begin with the NAME section  Following these, the document body must begin with the NAME section
 containing at least one  containing at least one
 .Sq \&.Nm  .Sq \&Nm
 followed by a  followed by
 .Sq \&.Nd  .Sq \&Nd .
 macro.  .\" PARAGRAPH------------
 .Pp  .Pp
 At least one free-form or macro line must follow this prologue.  Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
 .\"  but non-compulsory.
 .Ss Classification  .\" SUB-SECTION----------------------
 Macros are classified by their scope rules.  Some macros are allowed to  .\" .Ss Classification
 deviate from their classifications to preserve backward-compatibility  .\" Macros are classified by their scope rules: block full-explicit (BFE),
 with old macro combinations still found in the manual corpus.  These are  .\" block partial-explicit (BPE), block full-implicit (BFI), block
 specifically noted on a per-macro basis.  .\" partial-implicit (BPI), and in-line.
 .\" SUB-SECTION  .\" SUB-SECTION----------------------
 .Ss Scope  .\" .Ss Scope
 .Bl -inset  .\" .Bl -inset
 .\" LIST-ITEM  .\" .\" LIST-ITEM
 .It Em Block  .\" .It Em 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.
 .Bl -inset -offset indent  .\" .Bl -inset -offset indent
 .\" LIST-ITEM  .\" .\" LIST-ITEM
 .It Em Full-block  .\" .It Em Full-block
 macros always span multiple lines.  They consist of zero or  .\" macros always span multiple lines.  They consist of zero or
 more  .\" more
 .Qq heads ,  .\" .Qq heads ,
 subsequent macros or text on the same line following invocation; an  .\" subsequent macros or text on the same line following invocation; an
 optional  .\" 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
 macros may span multiple lines.  They consists of a optional  .\" 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 ,
 text or macros following the head on the same and subsequent lines; and  .\" text or macros following the head on the same and subsequent lines; and
 optionally a  .\" optionally a
 .Qq tail ,  .\" .Qq tail ,
 text immediately following closure.  .\" text immediately following closure.
 .\" LIST-ITEM  .\" .\" LIST-ITEM
 .It Em In-line  .\" .It Em In-line
 macros may only enclose text and span at most a single line.  .\" macros may only enclose text and span at most a single line.
 .El  .\" .El
 .El  .\" .El
 .\" SUB-SECTION  .\" SUB-SECTION----------------------
 .Ss Closure  .\" .Ss Closure
 Closure of a macro's scope depends first on its classification, then  .\" Closure of a macro's scope depends first on its classification, then
 on whether it's parsable.  In this table,  .\" on whether it's parsable.  In this table,
 .Sq BFE  .\" .Sq BFE
 refers to block full-explicit and so on.  .\" refers to block full-explicit and so on.
 .\" PARAGRAPH  .\" .\" PARAGRAPH------------
   .\" .Pp
   .\" .Bl -tag -width 12n -offset indent -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 indent -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 MACRO SYNTAX
   Every line beginning with the control character
   .Sq \.
   is processed for macros, two- or three-character semantic annotations.
   .\" PARAGRAPH------------
 .Pp  .Pp
 .Bl -tag -width 12n -offset indent -compact  The syntax of macro depends on its classification.  In this section,
 .It BPE , BFE  .Sq \-arg
 corresponding explicit closure macro  refers to macro arguments, which may be followed by zero or more
 .It BFI  .Sq parm
 end-of-file or a corresponding implicit closure macro  parameters;
 .It BPI  .Sq \&Yo
 end-of-line (body may be closed by >0 space-separated  opens the scope of a macro; and if specified,
 .Sx Reserved Characters ,  .Sq \&Yc
 although block scope will still be open)  closes it out.
 .It INL  .\" PARAGRAPH------------
 end-of-line  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 If a macro (block or in-line) is parsable, it may also be closed out by  The
 one of the following scenarios (unless specifically noted otherwise):  .Em Callable
 .\" PARAGRAPH  column indicates that the macro may be called subsequent to the initial
 .Pp  line-macro.  The
 .Bl -dash -offset indent -compact  .Qq Parsable
 .It  column indicates whether the macro may be followed by further
 a sequence of >0 space-separated  (ostensibly callable) macros.  The
 .Sx Reserved Characters ,  .Em Scope
 .It  column, if applicable, describes closure rules.
 another macro,  .\" SUB-SECTION----------------------
 .It  .Ss Block full-explicit
 end-of-line, or  Multi-line scope closed by an explicit closing macro.  All macros
 .It  contains bodies; only
 completion of a set number of arguments.  .Pq Sq \&Bf
 .El  contains a head.
 .\" 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 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 indent  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
 \&.Yc \(lBtail...\(rB  \&.Yc
 .Ed  .Ed
 .\" PARAGRAPH  .\" PARAGRAPH------------
 .Pp  .Pp
 Block full-implicit (may contain zero or more heads, body, no tail).  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
   .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
   .It \&Bd     Ta    \&No     Ta    \&No     Ta    closed by \&Ed
   .It \&Ed     Ta    \&No     Ta    \&No     Ta    opened by \&Bd
   .It \&Bl     Ta    \&No     Ta    \&No     Ta    closed by \&El
   .It \&El     Ta    \&No     Ta    \&No     Ta    opened by \&Bl
   .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
   .\" SUB-SECTION----------------------
   .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  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
 \&.Yc  
 .Ed  .Ed
 .\" PARAGRAPH  .\" PARAGRAPH------------
 .Pp  .Pp
 Block partial-explicit (may contain head, multi-line body, tail).  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
   .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
   .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
   .It \&It     Ta    \&No     Ta    Yes      Ta    closed by \&It, \&El
   .El
   .\" SUB-SECTION----------------------
   .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  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
 \&.Yc \(lBtail...\(rB  \&.Yc \(lBtail...\(rB
   
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  \(lBbody...\(rB \&Yc \(lBtail...\(rB
 .Ed  .Ed
 .\" PARAGRAPH  .\" PARAGRAPH------------
 .Pp  .Pp
 Block partial-implicit (no head, body, no tail).  Note that the body  .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 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 indent  
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB  
 .Ed  
 .\" PARAGRAPH  
 .Pp  
 In-lines have \(>=0 scoped arguments.  
 .Bd -literal -offset indent  
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB  
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  
 .Ed  
 .\" SECTION  
 .Sh MACROS  
 This section contains a complete list of all  
 .Nm  
 macros, arranged by classification.  A  
 .Qq callable  
 macro is 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  
 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  
 .Po  
 .Sq \&.It \-bullet ,  
 .Sq \-hyphen ,  
 .Sq \-dash ,  
 .Sq \-enum ,  
 .Sq \-item  
 .Pc  
 don't have heads.  
 .Pp  
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "Closing"  
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  
 .It \&.Nd    Ta    \&No    Ta    \&No    Ta    \&.Sh  
 .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 -compact -offset indent "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 \&Ao     Ta    Yes      Ta    Yes      Ta    closed by \&Ac
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  .It \&Ac     Ta    Yes      Ta    Yes      Ta    opened by \&Ao
 .It \&.Bl    Ta    \&No    Ta    \&No    Ta    closed by \&.El  .It \&Bc     Ta    Yes      Ta    Yes      Ta    closed by \&Bo
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  .It \&Bo     Ta    Yes      Ta    Yes      Ta    opened by \&Bc
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  .It \&Pc     Ta    Yes      Ta    Yes      Ta    closed by \&Po
 .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf  .It \&Po     Ta    Yes      Ta    Yes      Ta    opened by \&Pc
 .It \&.Bk    Ta    \&No    Ta    \&No    Ta    closed by \&.Ek  .It \&Do     Ta    Yes      Ta    Yes      Ta    closed by \&Dc
 .It \&.Ek    Ta    \&No    Ta    \&No    Ta    opened by \&.Bk  .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  .El
 .\" SUB-SECTION  .\" SUB-SECTION----------------------
 .Ss Block partial-implicit  .Ss Block partial-implicit
 All of these are callable and parsed for further macros.  Their scopes  Like block full-implicit, but with single-line scope closed by
 close at the invocation's end-of-line.  .Sx Reserved Characters
   or end of line.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
   .Ed
   .\" PARAGRAPH------------
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent  .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable  .It Em Macro Ta Em Callable Ta Em Parsable
 .It \&.Aq    Ta    Yes   Ta    Yes  .It \&Aq     Ta    Yes      Ta    Yes
 .It \&.Op    Ta    Yes   Ta    Yes  .It \&Op     Ta    Yes      Ta    Yes
 .It \&.Bq    Ta    Yes   Ta    Yes  .It \&Bq     Ta    Yes      Ta    Yes
 .It \&.Dq    Ta    Yes   Ta    Yes  .It \&Dq     Ta    Yes      Ta    Yes
 .It \&.Pq    Ta    Yes   Ta    Yes  .It \&Pq     Ta    Yes      Ta    Yes
 .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 \&D1     Ta    \&No     Ta    \&Yes
 .It \&.Dl    Ta    \&No  Ta    Yes  .It \&Dl     Ta    \&No     Ta    Yes
 .It \&.Ql    Ta    Yes   Ta    Yes  .It \&Ql     Ta    Yes      Ta    Yes
 .El  .El
 .\" PARAGRAPH  .\" SUB-SECTION----------------------
 .Pp  .Ss In-line
 The  Closed by
 .Sq \&.Op  .Sx Reserved Characters ,
 may be broken by  end of line, fixed argument lengths, and/or subsequent macros.  In-line
 .Sq \&.Oc  macros have only text children.  If a number (or inequality) of
 as in the following example:  
 .Bd -literal -offset indent  
 \&.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  
 .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 indent  
 .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.
   .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
   .\" PARAGRAPH------------
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent  .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 \&Dd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n  .It \&Dt     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Os    Ta    \&No  Ta    \&No    Ta    n  .It \&Os     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0  .It \&Pp     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n  .It \&Ad     Ta    Yes      Ta    Yes      Ta    n
 .It \&.An    Ta    Yes   Ta    Yes     Ta    n  .It \&An     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n  .It \&Ar     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0  .It \&Cd     Ta    Yes      Ta    \&No     Ta    >0
 .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n  .It \&Cm     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Dv    Ta    Yes   Ta    Yes     Ta    n  .It \&Dv     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0  .It \&Er     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Ev    Ta    Yes   Ta    Yes     Ta    n  .It \&Ev     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0  .It \&Ex     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Fa    Ta    Yes   Ta    Yes     Ta    n  .It \&Fa     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0  .It \&Fd     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n  .It \&Fl     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0  .It \&Fn     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Ft    Ta    Yes   Ta    Yes     Ta    n  .It \&Ft     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0  .It \&Ic     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.In    Ta    \&No  Ta    \&No    Ta    n  .It \&In     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Li    Ta    Yes   Ta    Yes     Ta    n  .It \&Li     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n  .It \&Nm     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n  .It \&Ot     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n  .It \&Pa     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0  .It \&Rv     Ta    \&No     Ta    \&No     Ta    0
 .It \&.St    Ta    \&No  Ta    Yes     Ta    1  .It \&St     Ta    \&No     Ta    Yes      Ta    1
 .It \&.Va    Ta    Yes   Ta    Yes     Ta    n  .It \&Va     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0  .It \&Vt     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3  .It \&Xr     Ta    Yes      Ta    Yes      Ta    >0, <3
 .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0  .It \&%A     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0  .It \&%B     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0  .It \&%C     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0  .It \&%D     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0  .It \&%I     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0  .It \&%J     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0  .It \&%N     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0  .It \&%O     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0  .It \&%P     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0  .It \&%R     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0  .It \&%T     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0  .It \&%V     Ta    \&No     Ta    \&No     Ta    >0
 .It \&.At    Ta    Yes   Ta    Yes     Ta    1  .It \&At     Ta    Yes      Ta    Yes      Ta    1
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n  .It \&Bsx    Ta    Yes      Ta    Yes      Ta    n
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n  .It \&Bx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    1  .It \&Db     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0  .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 \&.Ms    Ta    Yes   Ta    Yes     Ta    >0  .It \&Ms     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.No    Ta    Yes   Ta    Yes     Ta    0  .It \&No     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0  .It \&Ns     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n  .It \&Nx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n  .It \&Ox     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1  .It \&Pf     Ta    \&No     Ta    Yes      Ta    1
 .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1  .It \&Sm     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0  .It \&Sx     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0  .It \&Sy     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0  .It \&Tn     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n  .It \&Ux     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Dx    Ta    Yes   Ta    Yes     Ta    n  .It \&Dx     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0  .It \&Bt     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n  .It \&Hf     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n  .It \&Fr     Ta    \&No     Ta    \&No     Ta    n
 .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0  .It \&Ud     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1  .It \&Lb     Ta    \&No     Ta    \&No     Ta    1
 .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0  .It \&Ap     Ta    Yes      Ta    Yes      Ta    0
 .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0  .It \&Lp     Ta    \&No     Ta    \&No     Ta    0
 .It \&.Lk    Ta    Yes   Ta    Yes     Ta    n  .It \&Lk     Ta    Yes      Ta    Yes      Ta    n
 .It \&.Mt    Ta    Yes   Ta    Yes     Ta    >0  .It \&Mt     Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Es    Ta    \&No  Ta    \&No    Ta    0  .It \&Es     Ta    \&No     Ta    \&No     Ta    0
 .It \&.En    Ta    \&No  Ta    \&No    Ta    0  .It \&En     Ta    \&No     Ta    \&No     Ta    0
 .El  .El
 .Pp  .\" SECTION---------------------------------------------
 The  
 .Sq \&.Ot ,  
 .Sq \&.Fr ,  
 .Sq \&.Es  
 and  
 .Sq \&.En ,  
 macros are obsolete.  
 .\" SECTION  
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility with other roff implementations, at  This section documents compatibility with other roff implementations, at
 this time limited to  this time limited to
Line 523  refers to those versions before the 
Line 509  refers to those versions before the 
 .Pa doc.tmac  .Pa doc.tmac
 file re-write  file re-write
 .Pq somewhere between 1.15 and 1.19 .  .Pq somewhere between 1.15 and 1.19 .
   .\" PARAGRAPH------------
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  .\" LIST-ITEM
Line 586  In groff, the 
Line 573  In groff, the 
 .Sq \&.Fo  .Sq \&.Fo
 macro only produces the first parameter.  This is no longer the case.  macro only produces the first parameter.  This is no longer the case.
 .El  .El
 .\" SECTION  .\" SECTION---------------------------------------------
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr mandoc_char 7  .Xr mandoc_char 7
 .\" SECTION  .\" SECTION---------------------------------------------
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .\" SECTION---------------------------------------------
 .Sh CAVEATS  .Sh CAVEATS
 There are many ambiguous parts of mdoc.  There are many ambiguous parts of mdoc.
   .\" PARAGRAPH------------
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  .\" LIST-ITEM
Legend:
Removed from v.1.42  
changed lines
  Added in v.1.43
CVSweb