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

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

version 1.13, 2009/03/22 08:52:27 version 1.34, 2009/06/25 11:35:28
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>  .\" 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.  In this reference document, we describe the syntax, ontology  manuals.  In this reference document, we describe the syntax and
 and structure of the  structure of the
 .Nm  .Nm
 language.  language.  Our reference implementation is
   .Xr mandoc 1 .
   The
   .Sx COMPATIBILITY
   section describes compatibility with
   .Xr groff 1 .
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 An  An
Line 47  prior macros:
Line 50  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
 .\" PARAGRAPH  
 .Pp  
 Macros are two- or three-character sequences whose scope rules, rules  
 that dictate handling of subsequent-line or same-line arguments, are  
 governed by one of five classifications described in this document.  
 .\" SECTION  .\" SECTION
 .Sh INPUT ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
Line 66  line termination.  
Line 64  line termination.  
 .Pp  .Pp
 The only time a blank line is acceptable is within  The only time a blank line is acceptable is within
 the context of  the context of
 .Sq \&Bd \-literal  .Sq \&.Bd \-literal
 or  or
 .Sq \&Bd \-unfilled .  .Sq \&.Bd \-unfilled .
 .Pp  .Pp
 Tab characters  Tab characters
 .Pq \et  .Pq \et
 are only acceptable when delimiting  are only acceptable when delimiting
 .Sq \&Bl \-column  .Sq \&.Bl \-column
 and in  and in
 .Sq \&Bd \-literal  .Sq \&.Bd \-literal
 or  or
 .Sq \&Bd \-unfilled  .Sq \&.Bd \-unfilled
 contexts.  contexts.
 .\" SUB-SECTION  .\" 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  .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 XXXX -compact
 .It \&.  .It \&.
 .Pq period  .Pq period
 .It \&,  .It \&,
Line 103  Within a macro line, the following characters are rese
Line 111  Within a macro line, the following characters are rese
 .Pq question  .Pq question
 .It \&!  .It \&!
 .Pq exclamation  .Pq exclamation
   .It \&|
   .Pq vertical bar
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
Line 115  or, if applicable, an appropriate escape-sequence used
Line 125  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
 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
Line 125  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 is deprecated.  with the same combinations as described above.  This form is deprecated.
 .Pp  .\" SUB-SECTION
 The following is a table of all available escapes.  .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
 .Bl -tag -width 12n -offset "XXXX" -compact  applicable, by a front-end utility such as
 .It \\(em  .Xr mandoc 1 .
 .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  
 .It \\(r!  
 .Pq upside-down exclamation  
 .It \\(r?  
 .Pq upside-down question  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Enclosures:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(lh  
 .Pq left hand  
 .It \\(rh  
 .Pq right hand  
 .It \\(Fo  
 .Pq left guillemet  
 .It \\(Fc  
 .Pq right guillemet  
 .It \\(fo  
 .Pq left guilsing  
 .It \\(fc  
 .Pq right guilsing  
 .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  
 .It \\(Bq  
 .Pq right low double-quote  
 .It \\(bq  
 .Pq right low single-quote  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Indicatives:  
 .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  
 .It \\(<>  
 .Pq left-right arrow  
 .It \\(lA  
 .Pq left double-arrow  
 .It \\(rA  
 .Pq right double-arrow  
 .It \\(uA  
 .Pq up double-arrow  
 .It \\(dA  
 .Pq down double-arrow  
 .It \\(hA  
 .Pq left-right double-arrow  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Mathematical:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(es  
 .Pq empty set  
 .It \\(ca  
 .Pq intersection  
 .It \\(cu  
 .Pq union  
 .It \\(gr  
 .Pq gradient  
 .It \\(pd  
 .Pq partial differential  
 .It \\(ap  
 .Pq similarity  
 .It \\(=)  
 .Pq proper superset  
 .It \\((=  
 .Pq proper subset  
 .It \\(eq  
 .Pq equals  
 .It \\(di  
 .Pq division  
 .It \\(mu  
 .Pq multiplication  
 .It \\(pl  
 .Pq addition  
 .It \\(nm  
 .Pq not element  
 .It \\(mo  
 .Pq element  
 .It \\(Im  
 .Pq imaginary  
 .It \\(Re  
 .Pq real  
 .It \\(Ah  
 .Pq aleph  
 .It \\(te  
 .Pq existential quantifier  
 .It \\(fa  
 .Pq universal quantifier  
 .It \\(AN  
 .Pq logical AND  
 .It \\(OR  
 .Pq logical OR  
 .It \\(no  
 .Pq logical NOT  
 .It \\(st  
 .Pq such that  
 .It \\(tf  
 .Pq therefore  
 .It \\(~~  
 .Pq approximate  
 .It \\(~=  
 .Pq approximately equals  
 .It \\(=~  
 .Pq congruent  
 .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  
 Ligatures:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(ss  
 .Pq German eszett  
 .It \\(AE  
 .Pq upper-case AE  
 .It \\(ae  
 .Pq lower-case AE  
 .It \\(OE  
 .Pq upper-case OE  
 .It \\(oe  
 .Pq lower-case OE  
 .It \\(ff  
 .Pq ff ligature  
 .It \\(fi  
 .Pq fi ligature  
 .It \\(fl  
 .Pq fl ligature  
 .It \\(Fi  
 .Pq ffi ligature  
 .It \\(Fl  
 .Pq ffl ligature  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Diacritics and letters:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(ga  
 .Pq grave accent  
 .It \\(aa  
 .Pq accute accent  
 .It \\(a"  
 .Pq umlaut accent  
 .It \\(ad  
 .Pq dieresis accent  
 .It \\(a~  
 .Pq tilde accent  
 .It \\(a^  
 .Pq circumflex accent  
 .It \\(ac  
 .Pq cedilla accent  
 .It \\(ad  
 .Pq dieresis accent  
 .It \\(ah  
 .Pq caron accent  
 .It \\(ao  
 .Pq ring accent  
 .It \\(ho  
 .Pq hook accent  
 .It \\(ab  
 .Pq breve accent  
 .It \\(a-  
 .Pq macron accent  
 .It \\(-D  
 .Pq upper-case eth  
 .It \\(Sd  
 .Pq lower-case eth  
 .It \\(TP  
 .Pq upper-case thorn  
 .It \\(Tp  
 .Pq lower-case thorn  
 .It \\('A  
 .Pq upper-case acute A  
 .It \\('E  
 .Pq upper-case acute E  
 .It \\('I  
 .Pq upper-case acute I  
 .It \\('O  
 .Pq upper-case acute O  
 .It \\('U  
 .Pq upper-case acute U  
 .It \\('a  
 .Pq lower-case acute a  
 .It \\('e  
 .Pq lower-case acute e  
 .It \\('i  
 .Pq lower-case acute i  
 .It \\('o  
 .Pq lower-case acute o  
 .It \\('u  
 .Pq lower-case acute u  
 .It \\(`A  
 .Pq upper-case grave A  
 .It \\(`E  
 .Pq upper-case grave E  
 .It \\(`I  
 .Pq upper-case grave I  
 .It \\(`O  
 .Pq upper-case grave O  
 .It \\(`U  
 .Pq upper-case grave U  
 .It \\(`a  
 .Pq lower-case grave a  
 .It \\(`e  
 .Pq lower-case grave e  
 .It \\(`i  
 .Pq lower-case grave i  
 .It \\(`o  
 .Pq lower-case grave o  
 .It \\(`u  
 .Pq lower-case grave u  
 .It \\(~A  
 .Pq upper-case tilde A  
 .It \\(~N  
 .Pq upper-case tilde N  
 .It \\(~O  
 .Pq upper-case tilde O  
 .It \\(~a  
 .Pq lower-case tilde a  
 .It \\(~n  
 .Pq lower-case tilde n  
 .It \\(~o  
 .Pq lower-case tilde o  
 .It \\(:A  
 .Pq upper-case dieresis A  
 .It \\(:E  
 .Pq upper-case dieresis E  
 .It \\(:I  
 .Pq upper-case dieresis I  
 .It \\(:O  
 .Pq upper-case dieresis O  
 .It \\(:U  
 .Pq upper-case dieresis U  
 .It \\(:a  
 .Pq lower-case dieresis a  
 .It \\(:e  
 .Pq lower-case dieresis e  
 .It \\(:i  
 .Pq lower-case dieresis i  
 .It \\(:o  
 .Pq lower-case dieresis o  
 .It \\(:u  
 .Pq lower-case dieresis u  
 .It \\(:y  
 .Pq lower-case dieresis y  
 .It \\(^A  
 .Pq upper-case circumflex A  
 .It \\(^E  
 .Pq upper-case circumflex E  
 .It \\(^I  
 .Pq upper-case circumflex I  
 .It \\(^O  
 .Pq upper-case circumflex O  
 .It \\(^U  
 .Pq upper-case circumflex U  
 .It \\(^a  
 .Pq lower-case circumflex a  
 .It \\(^e  
 .Pq lower-case circumflex e  
 .It \\(^i  
 .Pq lower-case circumflex i  
 .It \\(^o  
 .Pq lower-case circumflex o  
 .It \\(^u  
 .Pq lower-case circumflex u  
 .It \\(,C  
 .Pq upper-case cedilla C  
 .It \\(,c  
 .Pq lower-case cedilla c  
 .It \\(/L  
 .Pq upper-case stroke L  
 .It \\(/l  
 .Pq lower-case stroke l  
 .It \\(/O  
 .Pq upper-case stroke O  
 .It \\(/o  
 .Pq lower-case stroke o  
 .It \\(oA  
 .Pq upper-case ring A  
 .It \\(oa  
 .Pq lower-case ring a  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Monetary:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(Cs  
 .Pq Scandinavian  
 .It \\(Do  
 .Pq dollar  
 .It \\(Po  
 .Pq pound  
 .It \\(Ye  
 .Pq yen  
 .It \\(Fn  
 .Pq florin  
 .It \\(ct  
 .Pq cent  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Special symbols:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(de  
 .Pq degree  
 .It \\(ps  
 .Pq paragraph  
 .It \\(sc  
 .Pq section  
 .It \\(dg  
 .Pq dagger  
 .It \\(dd  
 .Pq double dagger  
 .It \\(ci  
 .Pq circle  
 .It \\(ba  
 .Pq bar  
 .It \\(bb  
 .Pq broken bar  
 .It \\(Ba  
 .Pq bar, deprecated  
 .It \\(co  
 .Pq copyright  
 .It \\(rg  
 .Pq registered  
 .It \\(tm  
 .Pq trademarked  
 .It \\&  
 .Pq non-breaking space  
 .It \\e  
 .Pq escape  
 .It \\(Am  
 .Pq ampersand, deprecated  
 .El  
 .\" SECTION  .\" SECTION
 .Sh ONTOLOGY  .Sh STRUCTURE
 Macros are classified in an ontology described by their scope rules.  Each
 Some macros are allowed to deviate from their classifications to  .Nm
 preserve backward-compatibility with old macro combinations still found  document must begin with the document prologue, containing, in order,
 in the manual corpus.  These are specifically noted on a per-macro  .Sq \&.Dd ,
 basis.  .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  .\" SUB-SECTION
 .Ss Scope  .Ss Scope
 .Bl -inset  .Bl -inset
Line 630  subsequent tokens are interpreted as if the scope had 
Line 247  subsequent tokens are interpreted as if the scope had 
 In other circumstances, scope is simply closed out.  In other circumstances, scope is simply closed out.
 .\" SECTION  .\" SECTION
 .Sh SYNTAX  .Sh SYNTAX
 Macros are generally two and at times three characters in length.  The  Macros are two or three characters in length.  The syntax of macro
 syntax of macro invocation depends on its classification.  invocation depends on its classification.
 .Qq \-arg  .Qq \-arg
 refers to the macro arguments (which may contain zero or more values).  refers to the macro arguments (which may contain zero or more values).
 In these illustrations,  In these illustrations,
Line 683  In-lines have \(>=0 scoped arguments.
Line 300  In-lines have \(>=0 scoped arguments.
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
 .Ed  .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.  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
Line 698  The head of these macros follows invocation; the body 
Line 315  The head of these macros follows invocation; the body 
 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 ,
Line 706  some 
Line 323  some 
 .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 718  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 751  close at the invocation's end-of-line.
Line 368  close at the invocation's end-of-line.
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 The  The
 .Sq \&Op  .Sq \&.Op
 may be broken by \&Oc as in the following example:  may be broken by
   .Sq \&.Oc
   as in the following example:
 .Bd -literal -offset XXXX  .Bd -literal -offset XXXX
 \&.Oo  \&.Oo
 \&.Op Fl a Oc  \&.Op Fl a Oc
 .Ed  .Ed
 .Pp  .Pp
 In the above example, the scope of  In the above example, the scope of
 .Sq \&Op  .Sq \&.Op
 is technically broken by  is technically broken by
 .Sq \&Oc ,  .Sq \&.Oc ,
 however, due to the overwhelming existence of this sequence, it's  however, due to the overwhelming existence of this sequence, it's
 allowed.  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 813  then the macro accepts an arbitrary number of argument
Line 432  then the macro accepts an arbitrary number of argument
 .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    \&No  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
Line 825  then the macro accepts an arbitrary number of argument
Line 444  then the macro accepts an arbitrary number of argument
 .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    \&No  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
Line 854  then the macro accepts an arbitrary number of argument
Line 473  then the macro accepts an arbitrary number of argument
 .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    n  .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n  .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ms    Ta    \&No  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
Line 875  then the macro accepts an arbitrary number of argument
Line 494  then the macro accepts an arbitrary number of argument
 .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    \&No  Ta    Yes     Ta    >0  .It \&.Lk    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Mt    Ta    \&No  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  .Pp
 The  The
 .Sq \&Ot ,  .Sq \&.Ot ,
 .Sq \&Fr ,  .Sq \&.Fr ,
 .Sq \&Es  .Sq \&.Es
 and  and
 .Sq \&En ,  .Sq \&.En ,
 macros are obsolete.  macros are obsolete.
 .\" SECTION  .\" SECTION
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 The mdoc language was traditionally a  This section documents compatibility with other roff implementations, at
 .Qq roff  this time limited to
 macro package; most existing manuals were written with mdoc syntax  .Xr groff 1 .
 dictated by system-dependent roff installations.  This section documents  The term
 compatibility with these systems.  .Qq historic groff
   refers to those versions before the
   .Pa doc.tmac
   file re-write
   .Pq somewhere between 1.15 and 1.19 .
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&Fo  Historic groff has many un-callable macros.  Most of these (excluding
 and  some block-level macros) are now callable, conforming to the
 .Sq \&St  non-historic groff version.
 historically weren't always callable.  Both are now correctly callable.  
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&It \-nested  The vertical bar
 is assumed for all lists: any list may be nested and  .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  .Sq \-enum
 lists will restart the sequence only for the sub-list.  lists will restart the sequence only for the sub-list.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&It \-column  .Sq \&.It \-column
 syntax where column widths may be preceeded by other arguments (instead  syntax where column widths may be preceded by other arguments (instead
 of proceeded) is not supported.  of proceeded) is not supported.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 The  The
 .Sq \&At  .Sq \&.At
 macro only accepts a single parameter.  macro only accepts a single parameter.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 The system-name macros (  
 .Ns Sq \&At ,  
 .Sq \&Bsx ,  
 .Sq \&Bx ,  
 .Sq \&Fx ,  
 .Sq \&Nx ,  
 .Sq \&Ox ,  
 and  
 .Sq \&Ux )  
 are callable.  
 .\" LIST-ITEM  
 .It  
 Some manuals use  Some manuals use
 .Sq \&Li  .Sq \&.Li
 incorrectly by following it with a reserved character and expecting the  incorrectly by following it with a reserved character and expecting the
 delimiter to render.  This is not supported.  delimiter to render.  This is not supported.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&Cd  If an special-character control character
 is callable.  .Sq \e
   is escaped, it will
   obviously not render the sequence.  Even newer versions of groff seem to
   dither on this.
 .El  .El
 .\" SECTION  .\" 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  .\" SECTION
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .\" SECTION
 .Sh CAVEATS  .Sh CAVEATS
 There are several ambiguous parts of mdoc.  There are many ambiguous parts of mdoc.
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&Fa  .Sq \&.Fa
 should be  should be
 .Sq \&Va  .Sq \&.Va
 as function arguments are variables.  as function arguments are variables.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&Ft  .Sq \&.Ft
 should be  should be
 .Sq \&Vt  .Sq \&.Vt
 as function return types are still types.  Furthermore, the  as function return types are still types.  Furthermore, the
 .Sq \&Ft  .Sq \&.Ft
 should be removed and  should be removed and
 .Sq \&Fo ,  .Sq \&.Fo ,
 which ostensibly follows it, should follow the same convention as  which ostensibly follows it, should follow the same convention as
 .Sq \&Va .  .Sq \&.Va .
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&Va  .Sq \&.Va
 should formalise that only one or two arguments are acceptable: a  should formalise that only one or two arguments are acceptable: a
 variable name and optional, preceeding type.  variable name and optional, preceding type.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&Fd  .Sq \&.Fd
 is ambiguous.  It's commonly used to indicate an include file in the  is ambiguous.  It's commonly used to indicate an include file in the
 synopsis section.  synopsis section.
 .Sq \&In  .Sq \&.In
 should be used, instead.  should be used, instead.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 Only the  Only the
 .Sq \-literal  .Sq \-literal
 argument to  argument to
 .Sq \&Bd  .Sq \&.Bd
 makes sense.  The remaining ones should be removed.  makes sense.  The remaining ones should be removed.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 The  The
 .Sq \&Xo  .Sq \&.Xo
 and  and
 .Sq \&Xc  .Sq \&.Xc
 macros should be deprecated.  macros should be deprecated.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 The  The
 .Sq \&Dt  .Sq \&.Dt
 macro lacks clarity.  It should be absolutely clear which title will  macro lacks clarity.  It should be absolutely clear which title will
 render when formatting the manual page.  render when formatting the manual page.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 A  A
 .Sq \&Lx  .Sq \&.Lx
 should be provided for Linux (\(`a la  should be provided for Linux (\(`a la
 .Sq \&Ox ,  .Sq \&.Ox ,
 .Sq \&Nx  .Sq \&.Nx
 etc.).  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.13  
changed lines
  Added in v.1.34
CVSweb