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

Diff for /mandoc/mdoc.7 between version 1.2 and 1.20

version 1.2, 2009/03/13 09:08:59 version 1.20, 2009/04/12 19:19:57
Line 1 
Line 1 
 .\" $Id$  .\" $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
 .\"  .\"
 .\" 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
Line 17 
Line 17 
 .\" 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 30  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, ontology
   and structure of the
 .Nm  .Nm
   language.
   .\" 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.
   .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  .\" 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:
Line 71  Within a macro line, the following characters are rese
Line 97  Within a macro line, the following characters are rese
 .It \&?  .It \&?
 .Pq question  .Pq question
 .It \&!  .It \&!
 .Pq exclmamation  .Pq exclamation
 .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.  Use of reserved  or, if applicable, an appropriate escape-sequence used.
 characters is described later in this document.  
 .\" 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 91  for n-character sequences (terminated at a close-brack
Line 120  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  
 by classification.  
 .Pp  
 Grammatic:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .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:  
 .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:  
 .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:  
 .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:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(ga  
 .Pq accent grave  
 .It \\(aa  
 .Pq accent accute  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Special symbols:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(bu  
 .Pq bullet  
 .It \\(ba  
 .Pq bar  
 .It \\(Ba  
 .Pq bar, deprecated  
 .It \\(co  
 .Pq copyright  
 .It \\&  
 .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 scope rules.  Macros are classified in an ontology described 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  .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.
 .Qq Implicit  
 block scope is closed by a subsequent invocation of the same macro,  
 one of a set of corresponding closure macros or end-of-file.  
 .Qq Explicit  
 block scope is closed by a corresponding closure macro.  
 .Bl -inset -offset XXXX  .Bl -inset -offset XXXX
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em Full-block  .It Em Full-block
 macros always span multiple lines.  They consist optionally of one 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; 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
 macros may span multiple lines.  They 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 258  text or macros following the head on the same and subs
Line 158  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
 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  .Sh SYNTAX
 The syntax of macro invocation depends on classification.  Macros are two or three characters in length.  The syntax of macro
   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 367  In these illustrations, 
Line 219  In these illustrations, 
 opens the scope of a macro, and if specified,  opens the scope of a macro, and if specified,
 .Sq \&.Yc  .Sq \&.Yc
 closes it out (closure may be implicit at end-of-line or end-of-file).  closes it out (closure may be implicit at end-of-line or end-of-file).
   .\" PARAGRAPH
 .Pp  .Pp
 Block full-explicit (may contain head, body, tail):  Block full-explicit (may contain head, body, tail).
 .Bd -literal -offset XXXX  .Bd -literal -offset XXXX
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
 \&.Yc \(lBtail...\(rB  \&.Yc \(lBtail...\(rB
 .Ed  .Ed
   .\" PARAGRAPH
 .Pp  .Pp
 Block full-implicit (may contain zero or more heads, body, no tail):  Block full-implicit (may contain zero or more heads, body, no tail).
 .Bd -literal -offset XXXX  .Bd -literal -offset XXXX
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
 \&.Yc  \&.Yc
 .Ed  .Ed
   .\" PARAGRAPH
 .Pp  .Pp
 Block partial-explicit (may contain head, multi-line body, tail):  Block partial-explicit (may contain head, multi-line body, tail).
 .Bd -literal -offset XXXX  .Bd -literal -offset XXXX
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBval...\(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 \(lBval...\(rB\(rB \(lBhead...\(rB \
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  \(lBbody...\(rB \&Yc \(lBtail...\(rB
 .Ed  .Ed
   .\" PARAGRAPH
 .Pp  .Pp
 Block partial-implicit (no head, body, no tail):  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  .Bd -literal -offset XXXX
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB
 .Ed  .Ed
   .\" PARAGRAPH
 .Pp  .Pp
 In-line (may be closed by end-of-line, reserved character, subsequent  In-lines have \(>=0 scoped arguments.
 macro invocation or finite number of arguments):  
 .Bd -literal -offset XXX  .Bd -literal -offset XXX
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args...  \&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args... ;  
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB args... Xx  
   
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
 .Ed  .Ed
 .\"  .\"
Line 414  This section contains a complete list of all 
Line 269  This section contains a complete list of all 
 .Nm  .Nm
 macros, arranged ontologically.  A  macros, arranged ontologically.  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 423  The head of these macros follows invocation; the body 
Line 278  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 473  close at the invocation's end-of-line.
Line 328  close at the invocation's end-of-line.
 .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
   .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 510  and/or tail 
Line 383  and/or tail 
 .El  .El
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss In-line  .Ss In-line
 In-line macros have only text children.  In-line macros have only text children.  If a number (or inequality) of
   arguments is
   .Pq n ,
   then the macro accepts an arbitrary number of arguments.
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX  .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX
 .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    \&  .It \&.Dd    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Dt    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Os    Ta    \&No  Ta    \&No    Ta    \&  .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    \&  .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n
 .It \&.An    Ta    \&No  Ta    Yes     Ta    \&  .It \&.An    Ta    \&No  Ta    Yes     Ta    n
 .It \&.Ar    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Cd    Ta    Yes   Ta    \&No    Ta    \&  .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0
 .It \&.Cm    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Dv    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Dv    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Er    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ev    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Ev    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ex    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Fa    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Fa    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fd    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Fl    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fn    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ft    Ta    \&No  Ta    Yes     Ta    \&  .It \&.Ft    Ta    \&No  Ta    Yes     Ta    n
 .It \&.Ic    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.In    Ta    \&No  Ta    \&No    Ta    \&  .It \&.In    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Li    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Li    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Nd    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Nd    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Nm    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ot    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Pa    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Rv    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0
 .It \&.St    Ta    \&No  Ta    Yes     Ta    \&  .It \&.St    Ta    \&No  Ta    Yes     Ta    1
 .It \&.Va    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Va    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Vt    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Xr    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3
 .It \&.%A    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%B    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%C    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%D    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%I    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%J    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%N    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%O    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%P    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%R    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%T    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%V    Ta    \&No  Ta    \&No    Ta    \&  .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.At    Ta    Yes   Ta    Yes     Ta    \&  .It \&.At    Ta    Yes   Ta    Yes     Ta    1
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    \&  .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Db    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Em    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    \&  .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0
 .It \&.No    Ta    Yes   Ta    Yes     Ta    \&  .It \&.No    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Ns    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Nx    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ox    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Pf    Ta    \&No  Ta    Yes     Ta    \&  .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1
 .It \&.Sm    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Sx    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Sy    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Tn    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ux    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Bt    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Dx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Hf    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Fr    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Ud    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Lb    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Ap    Ta    Yes   Ta    Yes     Ta    \&  .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Lp    Ta    \&No  Ta    \&No    Ta    \&  .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Lk    Ta    \&No  Ta    Yes     Ta    \&  .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Mt    Ta    \&No  Ta    Yes     Ta    \&  .It \&.Lk    Ta    \&No  Ta    Yes     Ta    >0
   .It \&.Mt    Ta    \&No  Ta    Yes     Ta    >0
   .It \&.Es    Ta    \&No  Ta    \&No    Ta    0
   .It \&.En    Ta    \&No  Ta    \&No    Ta    0
 .El  .El
   .Pp
   The
   .Sq \&.Ot ,
   .Sq \&.Fr ,
   .Sq \&.Es
   and
   .Sq \&.En ,
   macros are obsolete.
 .\" SECTION  .\" SECTION
   .Sh COMPATIBILITY
   The mdoc language was traditionally a
   .Qq roff
   macro package; most existing manuals were written with mdoc syntax
   dictated by system-dependent roff installations.  This section documents
   compatibility with these systems.
   .Pp
   .Bl -dash -compact
   .\" LIST-ITEM
   .It
   .Sq \&.Fo
   and
   .Sq \&.St
   historically weren't always callable.  Both are now correctly callable.
   .\" LIST-ITEM
   .It
   .Sq \&.It \-nested
   is assumed for all lists: 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 preceeded by other arguments (instead
   of proceeded) is not supported.
   .\" LIST-ITEM
   .It
   The
   .Sq \&.At
   macro only accepts a single parameter.
   .\" LIST-ITEM
   .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
   .Sq \&.Li
   incorrectly by following it with a reserved character and expecting the
   delimiter to render.  This is not supported.
   .\" LIST-ITEM
   .It
   .Sq \&.Cd
   is callable.
   .El
   .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mdoctree 1 ,  .Xr mandoc 1 ,
 .Xr mdoclint 1 ,  .Xr mandoc_char 7
 .Xr mdocterm 1 ,  
 .Xr mdoc 3  
 .\" SECTION  .\" 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@openbsd.org .
   .\" SECTION
   .Sh CAVEATS
   There are several 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, preceeding 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.
   .El
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.20
CVSweb