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

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

version 1.1, 2009/03/13 07:46:10 version 1.16, 2009/03/26 16:23:22
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 22 
Line 22 
 .\" 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
   .\" 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 CHARACTER ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
 documents may contain only printable alphanumeric characters, the space  documents may contain only graphable 7-bit ASCII characters, the space
 character  character
 .Sq \  ,  .Sq \  ,
 and, in certain circumstances, the tab character  and, in certain circumstances, the tab character
 .Sq \et .  .Sq \et .
 All manuals must have  All manuals must have
 .Sq \en  .Sq \en
 line termination.  line termination.
 .\" SUB-SECTION  
 .Ss Special Characters  
 Within a macro line, the following characters are special:  
 .\" PARAGRAPH  
 .Pp  .Pp
 .Bl -tag -width Ds -offset XXXX -compact  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 Reserved Characters
   Within a macro line, the following characters are reserved:
   .Bl -tag -width 12n -offset XXXX -compact
 .It \&.  .It \&.
 period  .Pq period
 .It \&,  .It \&,
 comma  .Pq comma
 .It \&:  .It \&:
 colon  .Pq colon
 .It \&;  .It \&;
 semicolon  .Pq semicolon
 .It \&(  .It \&(
 left-parenthesis  .Pq left-parenthesis
 .It \&)  .It \&)
 right-parenthesis  .Pq right-parenthesis
 .It \&[  .It \&[
 left-bracket  .Pq left-bracket
 .It \&]  .It \&]
 right-bracket  .Pq right-bracket
 .It \&?  .It \&?
 question  .Pq question
 .It \&!  .It \&!
 exclmamation  .Pq exclamation
 .El  .El
   .\" PARAGRAPH
 .Pp  .Pp
 Use of these characters must either be escaped with a non-breaking space  Use of reserved characters is described in
   .Sx Closure .
   For general non-reserved use, characters must either be escaped with a
   non-breaking space
 .Pq Sq \e&  .Pq Sq \e&
 or, if applicable, an appropriate escape-sequence used.  or, if applicable, an appropriate escape-sequence used.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special character sequences begin with the escape character
 .Sq \\  .Sq \e
 and followed by either an open-parenthesis  followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
 for two-character sequences; an open-bracket  for two-character sequences; an open-bracket
 .Sq \&[  .Sq \&[
Line 92  for n-character sequences (terminated at a close-brack
Line 125  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  .Pp
 Grammatic:  The following is a table of all available escapes.
 .Pp  .Pp
   Grammatic:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width 12n -offset "XXXX" -compact
 .It \\(em  .It \e(em
 .Pq em-dash  .Pq em-dash
 .It \\(en  .It \e(en
 .Pq en-dash  .Pq en-dash
 .It \e-  .It \e-
 .Pq hyphen  .Pq hyphen
 .It \\\\  .It \e\e
 .Pq back-slash  .Pq back-slash
 .It \e'  .It \e'
 .Pq apostrophe  .Pq apostrophe
 .It \e`  .It \e`
 .Pq back-tick  .Pq back-tick
 .It \\  .It \e
 .Pq space  .Pq space
 .It \\.  .It \e.
 .Pq period  .Pq period
   .It \e(r!
   .Pq upside-down exclamation
   .It \e(r?
   .Pq upside-down question
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Enclosures:  Enclosures:
 .Pp  
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width 12n -offset "XXXX" -compact
 .It \\(rC  .It \e(lh
   .Pq left hand
   .It \e(rh
   .Pq right hand
   .It \e(Fo
   .Pq left guillemet
   .It \e(Fc
   .Pq right guillemet
   .It \e(fo
   .Pq left guilsing
   .It \e(fc
   .Pq right guilsing
   .It \e(rC
 .Pq right brace  .Pq right brace
 .It \\(lC  .It \e(lC
 .Pq left brace  .Pq left brace
 .It \\(ra  .It \e(ra
 .Pq right angle  .Pq right angle
 .It \\(la  .It \e(la
 .Pq left angle  .Pq left angle
 .It \\(rB  .It \e(rB
 .Pq right bracket  .Pq right bracket
 .It \\(lB  .It \e(lB
 .Pq left bracket  .Pq left bracket
 .It \\q  .It \eq
 .Pq double-quote  .Pq double-quote
 .It \\(lq  .It \e(lq
 .Pq left double-quote  .Pq left double-quote
 .It \\(Lq  .It \e(Lq
 .Pq left double-quote, deprecated  .Pq left double-quote, deprecated
 .It \\(rq  .It \e(rq
 .Pq right double-quote  .Pq right double-quote
 .It \\(Rq  .It \e(Rq
 .Pq right double-quote, deprecated  .Pq right double-quote, deprecated
 .It \\(oq  .It \e(oq
 .Pq left single-quote  .Pq left single-quote
 .It \\(aq  .It \e(aq
 .Pq right single-quote  .Pq right single-quote
   .It \e(Bq
   .Pq right low double-quote
   .It \e(bq
   .Pq right low single-quote
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Indicatives:  Indicatives:
 .Pp  
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width 12n -offset "XXXX" -compact
 .It \\(<-  .It \e(<-
 .Pq left arrow  .Pq left arrow
 .It \\(->  .It \e(->
 .Pq right arrow  .Pq right arrow
 .It \\(ua  .It \e(ua
 .Pq up arrow  .Pq up arrow
 .It \\(da  .It \e(da
 .Pq down arrow  .Pq down arrow
   .It \e(<>
   .Pq left-right arrow
   .It \e(lA
   .Pq left double-arrow
   .It \e(rA
   .Pq right double-arrow
   .It \e(uA
   .Pq up double-arrow
   .It \e(dA
   .Pq down double-arrow
   .It \e(hA
   .Pq left-right double-arrow
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Mathematical:  Mathematical:
 .Pp  
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width 12n -offset "XXXX" -compact
 .It \\(Gt  .It \e(es
   .Pq empty set
   .It \e(ca
   .Pq intersection
   .It \e(cu
   .Pq union
   .It \e(gr
   .Pq gradient
   .It \e(pd
   .Pq partial differential
   .It \e(ap
   .Pq similarity
   .It \e(=)
   .Pq proper superset
   .It \e((=
   .Pq proper subset
   .It \e(eq
   .Pq equals
   .It \e(di
   .Pq division
   .It \e(mu
   .Pq multiplication
   .It \e(pl
   .Pq addition
   .It \e(nm
   .Pq not element
   .It \e(mo
   .Pq element
   .It \e(Im
   .Pq imaginary
   .It \e(Re
   .Pq real
   .It \e(Ah
   .Pq aleph
   .It \e(te
   .Pq existential quantifier
   .It \e(fa
   .Pq universal quantifier
   .It \e(AN
   .Pq logical AND
   .It \e(OR
   .Pq logical OR
   .It \e(no
   .Pq logical NOT
   .It \e(st
   .Pq such that
   .It \e(tf
   .Pq therefore
   .It \e(~~
   .Pq approximate
   .It \e(~=
   .Pq approximately equals
   .It \e(=~
   .Pq congruent
   .It \e(Gt
 .Pq greater-than, deprecated  .Pq greater-than, deprecated
 .It \\(Lt  .It \e(Lt
 .Pq less-than, deprecated  .Pq less-than, deprecated
 .It \\(<=  .It \e(<=
 .Pq less-than-equal  .Pq less-than-equal
 .It \\(Le  .It \e(Le
 .Pq less-than-equal, deprecated  .Pq less-than-equal, deprecated
 .It \\(>=  .It \e(>=
 .Pq greater-than-equal  .Pq greater-than-equal
 .It \\(Ge  .It \e(Ge
 .Pq greater-than-equal  .Pq greater-than-equal
 .It \\(==  .It \e(==
 .Pq equal  .Pq equal
 .It \\(!=  .It \e(!=
 .Pq not equal  .Pq not equal
 .It \\(Ne  .It \e(Ne
 .Pq not equal, deprecated  .Pq not equal, deprecated
 .It \\(if  .It \e(if
 .Pq infinity  .Pq infinity
 .It \\(If  .It \e(If
 .Pq infinity, deprecated  .Pq infinity, deprecated
 .It \\(na  .It \e(na
 .Pq NaN , an extension  .Pq NaN , an extension
 .It \\(Na  .It \e(Na
 .Pq NaN, deprecated  .Pq NaN, deprecated
 .It \\(+-  .It \e(+-
 .Pq plus-minus  .Pq plus-minus
 .It \\(Pm  .It \e(Pm
 .Pq plus-minus, deprecated  .Pq plus-minus, deprecated
 .It \\(**  .It \e(**
 .Pq asterisk  .Pq asterisk
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Diacritics:  Ligatures:
   .Bl -tag -width 12n -offset "XXXX" -compact
   .It \e(ss
   .Pq German eszett
   .It \e(AE
   .Pq upper-case AE
   .It \e(ae
   .Pq lower-case AE
   .It \e(OE
   .Pq upper-case OE
   .It \e(oe
   .Pq lower-case OE
   .It \e(ff
   .Pq ff ligature
   .It \e(fi
   .Pq fi ligature
   .It \e(fl
   .Pq fl ligature
   .It \e(Fi
   .Pq ffi ligature
   .It \e(Fl
   .Pq ffl ligature
   .El
   .\" PARAGRAPH
 .Pp  .Pp
   Diacritics and letters:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width 12n -offset "XXXX" -compact
 .It \\(ga  .It \e(ga
 .Pq accent grave  .Pq grave accent
 .It \\(aa  .It \e(aa
 .Pq accent accute  .Pq accute accent
   .It \e(a"
   .Pq umlaut accent
   .It \e(ad
   .Pq dieresis accent
   .It \e(a~
   .Pq tilde accent
   .It \e(a^
   .Pq circumflex accent
   .It \e(ac
   .Pq cedilla accent
   .It \e(ad
   .Pq dieresis accent
   .It \e(ah
   .Pq caron accent
   .It \e(ao
   .Pq ring accent
   .It \e(ho
   .Pq hook accent
   .It \e(ab
   .Pq breve accent
   .It \e(a-
   .Pq macron accent
   .It \e(-D
   .Pq upper-case eth
   .It \e(Sd
   .Pq lower-case eth
   .It \e(TP
   .Pq upper-case thorn
   .It \e(Tp
   .Pq lower-case thorn
   .It \e('A
   .Pq upper-case acute A
   .It \e('E
   .Pq upper-case acute E
   .It \e('I
   .Pq upper-case acute I
   .It \e('O
   .Pq upper-case acute O
   .It \e('U
   .Pq upper-case acute U
   .It \e('a
   .Pq lower-case acute a
   .It \e('e
   .Pq lower-case acute e
   .It \e('i
   .Pq lower-case acute i
   .It \e('o
   .Pq lower-case acute o
   .It \e('u
   .Pq lower-case acute u
   .It \e(`A
   .Pq upper-case grave A
   .It \e(`E
   .Pq upper-case grave E
   .It \e(`I
   .Pq upper-case grave I
   .It \e(`O
   .Pq upper-case grave O
   .It \e(`U
   .Pq upper-case grave U
   .It \e(`a
   .Pq lower-case grave a
   .It \e(`e
   .Pq lower-case grave e
   .It \e(`i
   .Pq lower-case grave i
   .It \e(`o
   .Pq lower-case grave o
   .It \e(`u
   .Pq lower-case grave u
   .It \e(~A
   .Pq upper-case tilde A
   .It \e(~N
   .Pq upper-case tilde N
   .It \e(~O
   .Pq upper-case tilde O
   .It \e(~a
   .Pq lower-case tilde a
   .It \e(~n
   .Pq lower-case tilde n
   .It \e(~o
   .Pq lower-case tilde o
   .It \e(:A
   .Pq upper-case dieresis A
   .It \e(:E
   .Pq upper-case dieresis E
   .It \e(:I
   .Pq upper-case dieresis I
   .It \e(:O
   .Pq upper-case dieresis O
   .It \e(:U
   .Pq upper-case dieresis U
   .It \e(:a
   .Pq lower-case dieresis a
   .It \e(:e
   .Pq lower-case dieresis e
   .It \e(:i
   .Pq lower-case dieresis i
   .It \e(:o
   .Pq lower-case dieresis o
   .It \e(:u
   .Pq lower-case dieresis u
   .It \e(:y
   .Pq lower-case dieresis y
   .It \e(^A
   .Pq upper-case circumflex A
   .It \e(^E
   .Pq upper-case circumflex E
   .It \e(^I
   .Pq upper-case circumflex I
   .It \e(^O
   .Pq upper-case circumflex O
   .It \e(^U
   .Pq upper-case circumflex U
   .It \e(^a
   .Pq lower-case circumflex a
   .It \e(^e
   .Pq lower-case circumflex e
   .It \e(^i
   .Pq lower-case circumflex i
   .It \e(^o
   .Pq lower-case circumflex o
   .It \e(^u
   .Pq lower-case circumflex u
   .It \e(,C
   .Pq upper-case cedilla C
   .It \e(,c
   .Pq lower-case cedilla c
   .It \e(/L
   .Pq upper-case stroke L
   .It \e(/l
   .Pq lower-case stroke l
   .It \e(/O
   .Pq upper-case stroke O
   .It \e(/o
   .Pq lower-case stroke o
   .It \e(oA
   .Pq upper-case ring A
   .It \e(oa
   .Pq lower-case ring a
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Special symbols:  Monetary:
   .Bl -tag -width 12n -offset "XXXX" -compact
   .It \e(Cs
   .Pq Scandinavian
   .It \e(Do
   .Pq dollar
   .It \e(Po
   .Pq pound
   .It \e(Ye
   .Pq yen
   .It \e(Fn
   .Pq florin
   .It \e(ct
   .Pq cent
   .El
   .\" PARAGRAPH
 .Pp  .Pp
   Special symbols:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width 12n -offset "XXXX" -compact
 .It \\(bu  .It \e(de
 .Pq bullet  .Pq degree
 .It \\(ba  .It \e(ps
   .Pq paragraph
   .It \e(sc
   .Pq section
   .It \e(dg
   .Pq dagger
   .It \e(dd
   .Pq double dagger
   .It \e(ci
   .Pq circle
   .It \e(ba
 .Pq bar  .Pq bar
 .It \\(Ba  .It \e(bb
   .Pq broken bar
   .It \e(Ba
 .Pq bar, deprecated  .Pq bar, deprecated
 .It \\(co  .It \e(co
 .Pq copyright  .Pq copyright
 .It \\&  .It \e(rg
   .Pq registered
   .It \e(tm
   .Pq trademarked
   .It \e&
 .Pq non-breaking space  .Pq non-breaking space
 .It \\e  .It \ee
 .Pq escape  .Pq escape
 .It \\(Am  .It \e(Am
 .Pq ampersand, deprecated  .Pq ampersand, deprecated
 .El  .El
 .\" SECTION  .\" SECTION
 .Sh CLASSIFICATION  .Sh ONTOLOGY
 Macros are classified in an ontology described by scope rules.  Macros are classified in an ontology described by their scope rules.
 .Bl -tag -width "in-lineX"  Some macros are allowed to deviate from their classifications to
   preserve backward-compatibility with old macro combinations still found
   in the manual corpus.  These are specifically noted on a per-macro
   basis.
   .\" SUB-SECTION
   .Ss Scope
   .Bl -inset
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em Block  .It Em Block
 Block macros enclose other block macros, in-line macros or text, and  macros enclose other block macros, in-line macros or text, and
 may span multiple lines.  may span multiple lines.
 .Qq Implicit  .Bl -inset -offset XXXX
 block scope is closed by a subsequent invocation of the same macro,  
 one of a set of corresponding closure macros or end-of-file.  
 .Qq Explicit  
 block scope is closed by a corresponding closure macro.  
 .Bl -tag -width "partial-blockX"  
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em Full-block  .It Em Full-block
 Always spans multiple lines.  Consists optionally of one or more  macros always span multiple lines.  They consist of zero or
   more
 .Qq heads ,  .Qq heads ,
 subsequent macros or text on the same line following invocation; a  subsequent macros or text on the same line following invocation; an
   optional
 .Qq body ,  .Qq body ,
 which spans subsequent lines of text or macros; and an optional  which spans subsequent lines of text or macros; and an optional
 .Qq tail ,  .Qq tail ,
 macros or text on the same line following closure.  macros or text on the same line following closure.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em Partial-block  .It Em Partial-block
 May span multiple lines.  Consists optionally of a  macros may span multiple lines.  They consists of a optional
 .Qq head ,  .Qq head ,
 text immediately following invocation; always a  text immediately following invocation; always a
 .Qq body ,  .Qq body ,
Line 264  text or macros following the head on the same and subs
Line 578  text or macros following the head on the same and subs
 optionally a  optionally a
 .Qq tail ,  .Qq tail ,
 text immediately following closure.  text immediately following closure.
 .El  
 .\" LIST-ITEM  .\" LIST-ITEM
 .It Em In-line  .It Em In-line
 In-line macros may only enclose text and span at most a single line.  If  macros may only enclose text and span at most a single line.
 a macro is parsable, its scope may be closed by subsequent macros or  
 delimiting punctuation.  In-line macros follow different conventions for  
 closure; see  
 .Sx MACROS  
 for per-macro details.  
 .El  .El
 .\" .\" SUB-SECTION  .El
 .\" .Ss Examples  .\" SUB-SECTION
 .\" The following examples illustrate each macro classification.  .Ss Closure
 .\" .\" PARAGRAPH  Closure of a macro's scope depends first on its classification, then
 .\" .Pp  on whether it's parsable.  In this table,
 .\" Implicit full-block.  Has head, body and no tail.  Scope closed by  .Sq BFE
 .\" second  refers to block full-explicit and so on.
 .\" .Sq \&Sh  .\" PARAGRAPH
 .\" invocation.  .Pp
 .\" .Bd -literal -offset XXXX  .Bl -tag -width 12n -offset XXXX -compact
 .\" \&.Sh SECTION 1  .It BPE , BFE
 .\" body...  corresponding explicit closure macro
 .\" \&.Sh SECTION 2  .It BFI
 .\" .Ed  end-of-file or a corresponding implicit closure macro
 .\" .\" PARAGRAPH  .It BPI
 .\" .Pp  end-of-line (body may be closed by >0 space-separated
 .\" Nested implicit full-block, where the subsection  .Sx Reserved Characters ,
 .\" .Sq \&Ss  although block scope will still be open)
 .\" is within the scope of the parent section  .It INL
 .\" .Sq \&Sh  end-of-line
 .\" and closed along with its parent by the subsequent  .El
 .\" .Sq \&Sh .  .\" PARAGRAPH
 .\" .Bd -literal -offset XXXX  .Pp
 .\" \&.Sh SECTION 1  If a macro (block or in-line) is parsable, it may also be closed out by
 .\" \&.Ss Subsection 1  one of the following scenarios (unless specifically noted otherwise):
 .\" body...  .\" PARAGRAPH
 .\" \&.Sh SECTION 2  .Pp
 .\" .Ed  .Bl -dash -offset XXXX -compact
 .\" .\" PARAGRAPH  .It
 .\" .Pp  a sequence of >0 space-separated
 .\" Explicit full-block.  Has a head, a body and no tail.  Scope closed by  .Sx Reserved Characters ,
 .\" .Sq \&Ef  .It
 .\" invocation.  another macro,
 .\" .Bd -literal -offset XXXX  .It
 .\" \&.Bf symbolic  end-of-line, or
 .\" body...  .It
 .\" \&.Ef  completion of a set number of arguments.
 .\" .Ed  .El
 .\" .\" PARAGRAPH  .\" PARAGRAPH
 .\" .Pp  .Pp
 .\" Nested explicit/implicit scope.  If >0 space-separated
 .\" .Sq \&It  .Sx Reserved Characters
 .\" macro is an implicit block whose scope is closed by the explicit  are followed by non-reserved characters, the behaviour differs per
 .\" .Sq \&El  macro.  In general, scope of the macro is closed and re-opened:
 .\" closure.  subsequent tokens are interpreted as if the scope had just been opened.
 .\" .Bd -literal -offset XXXX  In other circumstances, scope is simply closed out.
 .\" \&.Bl \-bullet  
 .\" \&.It head  
 .\" body...  
 .\" \&.El  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit partial-block.  Has head, body and tail.  Scope closed by  
 .\" .Sq \&Ec  
 .\" invocation.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Eo head body... \&Ec tail  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit partial-block.  Has only body.  Scope is closed by end-of-line.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Sq body...  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit partial-block with only body and scope closed by  
 .\" .Sq \&Ac  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Ao body... \&Ac  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit partial-block enclosing explicit partial-block.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Sq body... \&Ao body... \&Ac  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Inline macros, several in sequence.  Scope is closed for  
 .\" .Sq \&Fl  
 .\" by the punctuation delimiter and  
 .\" .Sq \&Ar  
 .\" by the end-of-line.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Fl text0 text1 ; Ar text0 text1  
 .\" .Ed  
 .\" SECTION  .\" SECTION
   .Sh SYNTAX
   Macros are generally two and at times three characters in length.  The
   syntax of macro invocation depends on its classification.
   .Qq \-arg
   refers to the macro arguments (which may contain zero or more values).
   In these illustrations,
   .Sq \&.Yo
   opens the scope of a macro, and if specified,
   .Sq \&.Yc
   closes it out (closure may be implicit at end-of-line or end-of-file).
   .\" PARAGRAPH
   .Pp
   Block full-explicit (may contain head, body, tail).
   .Bd -literal -offset XXXX
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc \(lBtail...\(rB
   .Ed
   .\" PARAGRAPH
   .Pp
   Block full-implicit (may contain zero or more heads, body, no tail).
   .Bd -literal -offset XXXX
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
   \(lBbody...\(rB
   \&.Yc
   .Ed
   .\" PARAGRAPH
   .Pp
   Block partial-explicit (may contain head, multi-line body, tail).
   .Bd -literal -offset XXXX
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc \(lBtail...\(rB
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \
   \(lBbody...\(rB \&Yc \(lBtail...\(rB
   .Ed
   .\" PARAGRAPH
   .Pp
   Block partial-implicit (no head, body, no tail).  Note that the body
   section may be followed by zero or more
   .Sx Reserved Words .
   These are in the block scope, but not in the body scope.
   .Bd -literal -offset XXXX
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB
   .Ed
   .\" PARAGRAPH
   .Pp
   In-lines have \(>=0 scoped arguments.
   .Bd -literal -offset XXX
   \&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB
   
   \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
   .Ed
   .\"
 .Sh MACROS  .Sh MACROS
 This section contains a complete list of all  This section contains a complete list of all
 .Nm  .Nm
 macros, arranged ontologically then alphanumerically by macro name.  A  macros, arranged ontologically.  A
 .Qq callable  .Qq callable
 macro is may be invoked subsequent to the initial macro-line macro.  A  macro is may be invoked subsequent to the initial macro-line macro.  A
 .Qq parsable  .Qq parsable
 macro May be followed by further (ostensibly callable) macros.  macro may be followed by further (ostensibly callable) macros.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Block full-implicit  .Ss Block full-implicit
 The head of these macros follows invocation; the body is the content of  The head of these macros follows invocation; the body is the content of
 subsequent lines prior to closure.  None of these macros have tails;  subsequent lines prior to closure.  None of these macros have tails;
 some  some
 .Po  .Po
 .Sq \&It \-bullet ,  .Sq \&.It \-bullet ,
 .Sq \-hyphen ,  .Sq \-hyphen ,
 .Sq \-dash ,  .Sq \-dash ,
 .Sq \-enum  .Sq \-enum ,
   .Sq \-item
 .Pc  .Pc
 don't have heads.  don't have heads.
 .Pp  .Pp
Line 405  the explicit scope rules.  All contains bodies, some m
Line 726  the explicit scope rules.  All contains bodies, some m
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef
 .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf  .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf
   .It \&.Bk    Ta    \&No    Ta    \&No    Ta    closed by \&.Ek
   .It \&.Ek    Ta    \&No    Ta    \&No    Ta    opened by \&.Bk
 .El  .El
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Block partial-implicit  .Ss Block partial-implicit
Line 421  close at the invocation's end-of-line.
Line 744  close at the invocation's end-of-line.
 .It \&.Qq    Ta    Yes   Ta    Yes  .It \&.Qq    Ta    Yes   Ta    Yes
 .It \&.Sq    Ta    Yes   Ta    Yes  .It \&.Sq    Ta    Yes   Ta    Yes
 .It \&.Brq   Ta    Yes   Ta    Yes  .It \&.Brq   Ta    Yes   Ta    Yes
   .It \&.D1    Ta    \&No  Ta    \&Yes
   .It \&.Dl    Ta    \&No  Ta    Yes
   .It \&.Ql    Ta    Yes   Ta    Yes
 .El  .El
   .\" PARAGRAPH
   .Pp
   The
   .Sq \&.Op
   may be broken by
   .Sq \&.Oc
   as in the following example:
   .Bd -literal -offset XXXX
   \&.Oo
   \&.Op Fl a Oc
   .Ed
   .Pp
   In the above example, the scope of
   .Sq \&.Op
   is technically broken by
   .Sq \&.Oc ,
   however, due to the overwhelming existence of this sequence, it's
   allowed.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Block partial-explicit  .Ss Block partial-explicit
 Each of these contains at least a body and, in limited circumstances, a  Each of these contains at least a body and, in limited circumstances, a
 head  head
 .Pq So \&Fo Sc , So \&Eo Sc  .Pq So \&.Fo Sc , So \&.Eo Sc
 and/or tail  and/or tail
 .Pq So \&Ec Sc .  .Pq So \&.Ec Sc .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX  .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
Line 454  and/or tail 
Line 798  and/or tail 
 .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec  .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec
 .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo  .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo
 .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc  .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc
   .It \&.Re    Ta    \&No  Ta    \&No   Ta    opened by \&.Rs
   .It \&.Rs    Ta    \&No  Ta    \&No   Ta    closed by \&.Re
 .El  .El
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss General  .Ss In-line
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX  In-line macros have only text children.  If a number (or inequality) of
 .It Em Macro Ta Em Callable Ta Em Parsable  arguments is
 .It \&.Dd    Ta    \&    Ta    \&  .Pq n ,
 .It \&.Dt    Ta    \&    Ta    \&  then the macro accepts an arbitrary number of arguments.
 .It \&.Os    Ta    \&    Ta    \&  .Pp
 .It \&.Pp    Ta    \&    Ta    \&  .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX
 .It \&.D1    Ta    \&    Ta    \&  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
 .It \&.Dl    Ta    \&    Ta    Yes  .It \&.Dd    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Ad    Ta    Yes   Ta    Yes  .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n
 .It \&.An    Ta    \&    Ta    Yes  .It \&.Os    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Ar    Ta    Yes   Ta    Yes  .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Cd    Ta    Yes   Ta    \&  .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Cm    Ta    Yes   Ta    Yes  .It \&.An    Ta    \&No  Ta    Yes     Ta    n
 .It \&.Dv    Ta    Yes   Ta    Yes  .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Er    Ta    Yes   Ta    Yes  .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0
 .It \&.Ev    Ta    Yes   Ta    Yes  .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ex    Ta    \&    Ta    \&  .It \&.Dv    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fa    Ta    Yes   Ta    Yes  .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Fd    Ta    \&    Ta    \&  .It \&.Ev    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fl    Ta    Yes   Ta    Yes  .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Fn    Ta    Yes   Ta    Yes  .It \&.Fa    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ft    Ta    \&    Ta    \&  .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Ic    Ta    Yes   Ta    Yes  .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n
 .It \&.In    Ta    \&    Ta    \&  .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Li    Ta    Yes   Ta    Yes  .It \&.Ft    Ta    \&No  Ta    Yes     Ta    n
 .It \&.Nd    Ta    \&    Ta    \&  .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Nm    Ta    Yes   Ta    Yes  .It \&.In    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Ot    Ta    \&    Ta    \&  .It \&.Li    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Pa    Ta    Yes   Ta    Yes  .It \&.Nd    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Rv    Ta    \&    Ta    \&  .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n
 .It \&.St    Ta    Yes   Ta    \&  .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Va    Ta    Yes   Ta    Yes  .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Vt    Ta    Yes   Ta    Yes  .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Xr    Ta    Yes   Ta    Yes  .It \&.St    Ta    \&No  Ta    Yes     Ta    1
 .It \&.%A    Ta    \&    Ta    \&  .It \&.Va    Ta    Yes   Ta    Yes     Ta    n
 .It \&.%B    Ta    \&    Ta    \&  .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.%C    Ta    \&    Ta    \&  .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3
 .It \&.%D    Ta    \&    Ta    \&  .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%I    Ta    \&    Ta    \&  .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%J    Ta    \&    Ta    \&  .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%N    Ta    \&    Ta    \&  .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%O    Ta    \&    Ta    \&  .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%P    Ta    \&    Ta    \&  .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%R    Ta    \&    Ta    \&  .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%T    Ta    \&    Ta    \&  .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.%V    Ta    \&    Ta    \&  .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.At    Ta    Yes   Ta    Yes  .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Bsx   Ta    Yes   Ta    Yes  .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Bx    Ta    Yes   Ta    Yes  .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Db    Ta    \&    Ta    \&  .It \&.At    Ta    Yes   Ta    Yes     Ta    1
 .It \&.Em    Ta    Yes   Ta    Yes  .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fx    Ta    Yes   Ta    Yes  .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ms    Ta    \&    Ta    Yes  .It \&.Db    Ta    \&No  Ta    \&No    Ta    1
 .It \&.No    Ta    Yes   Ta    Yes  .It \&.Em    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ns    Ta    Yes   Ta    Yes  .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Nx    Ta    Yes   Ta    Yes  .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0
 .It \&.Ox    Ta    Yes   Ta    Yes  .It \&.No    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Pf    Ta    \&    Ta    Yes  .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Ql    Ta    Yes   Ta    Yes  .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Re    Ta    \&    Ta    \&  .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Rs    Ta    \&    Ta    \&  .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1
 .It \&.Sm    Ta    \&    Ta    \&  .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Sx    Ta    Yes   Ta    Yes  .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Sy    Ta    Yes   Ta    Yes  .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Tn    Ta    Yes   Ta    Yes  .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ux    Ta    Yes   Ta    Yes  .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Bk    Ta    \&    Ta    \&  .It \&.Dx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ek    Ta    \&    Ta    \&  .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Bt    Ta    \&    Ta    \&  .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Hf    Ta    \&    Ta    \&  .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Fr    Ta    \&    Ta    \&  .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Ud    Ta    \&    Ta    \&  .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Lb    Ta    \&    Ta    \&  .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Ap    Ta    Yes   Ta    Yes  .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Lp    Ta    \&    Ta    \&  .It \&.Lk    Ta    \&No  Ta    Yes     Ta    >0
 .It \&.Lk    Ta    \&    Ta    Yes  .It \&.Mt    Ta    \&No  Ta    Yes     Ta    >0
 .It \&.Mt    Ta    \&    Ta    Yes  .It \&.Es    Ta    \&No  Ta    \&No    Ta    0
   .It \&.En    Ta    \&No  Ta    \&No    Ta    0
   .El
   .Pp
   The
   .Sq \&.Ot ,
   .Sq \&.Fr ,
   .Sq \&.Es
   and
   .Sq \&.En ,
   macros are obsolete.
   .\" SECTION
   .Sh COMPATIBILITY
   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
   .Xr mandoc 1
   .\" SECTION
   .Sh AUTHORS
   The
   .Nm
   utility was written by
   .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  .El
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.16
CVSweb