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

Diff for /mandoc/mdoc.7 between version 1.4 and 1.10

version 1.4, 2009/03/14 05:21:58 version 1.10, 2009/03/20 15:14:01
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 41  of these macros.
Line 41  of these macros.
 .\" SECTION  .\" SECTION
 .Sh CHARACTER ENCODING  .Sh CHARACTER ENCODING
 .Nm  .Nm
 documents may contain only printable alphanumeric characters, the space  documents may contain only printable 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 72  Within a macro line, the following characters are rese
Line 87  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
 .Pq Sq \e&  
 or, if applicable, an appropriate escape-sequence used.  Use of reserved  
 characters is described in  
 .Sx Closure .  .Sx Closure .
   For general non-reserved use, characters must either be escaped with a
   non-breaking space
   .Pq Sq \e&
   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
Line 116  Grammatic:
Line 133  Grammatic:
 .Pq space  .Pq space
 .It \\.  .It \\.
 .Pq period  .Pq period
   .It \\(r!
   .Pq upside-down exclamation
   .It \\(r?
   .Pq upside-down question
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Enclosures:  Enclosures:
 .Bl -tag -width 12n -offset "XXXX" -compact  .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  .It \\(rC
 .Pq right brace  .Pq right brace
 .It \\(lC  .It \\(lC
Line 147  Enclosures:
Line 180  Enclosures:
 .Pq left single-quote  .Pq left single-quote
 .It \\(aq  .It \\(aq
 .Pq right single-quote  .Pq right single-quote
   .It \\(Bq
   .Pq right low double-quote
   .It \\(bq
   .Pq right low single-quote
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
Line 160  Indicatives:
Line 197  Indicatives:
 .Pq up arrow  .Pq up arrow
 .It \\(da  .It \\(da
 .Pq down arrow  .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  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Mathematical:  Mathematical:
 .Bl -tag -width 12n -offset "XXXX" -compact  .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  .It \\(Gt
 .Pq greater-than, deprecated  .Pq greater-than, deprecated
 .It \\(Lt  .It \\(Lt
Line 200  Mathematical:
Line 303  Mathematical:
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Diacritics:  Ligatures:
 .Bl -tag -width 12n -offset "XXXX" -compact  .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  .It \\(ga
 .Pq accent grave  .Pq grave accent
 .It \\(aa  .It \\(aa
 .Pq accent accute  .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  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .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:  Special symbols:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width 12n -offset "XXXX" -compact
 .It \\(bu  .It \\(de
 .Pq bullet  .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  .It \\(ba
 .Pq bar  .Pq bar
   .It \\(bb
   .Pq broken bar
 .It \\(Ba  .It \\(Ba
 .Pq bar, deprecated  .Pq bar, deprecated
 .It \\(co  .It \\(co
 .Pq copyright  .Pq copyright
   .It \\(rg
   .Pq registered
   .It \\(tm
   .Pq trademarked
 .It \\&  .It \\&
 .Pq non-breaking space  .Pq non-breaking space
 .It \\e  .It \\e
Line 239  may span multiple lines.
Line 540  may span multiple lines.
 .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 307  are followed by non-reserved characters, the behaviour
Line 609  are followed by non-reserved characters, the behaviour
 macro.  In general, scope of the macro is closed and re-opened:  macro.  In general, scope of the macro is closed and re-opened:
 subsequent tokens are interpreted as if the scope had just been opened.  subsequent tokens are interpreted as if the scope had just been opened.
 In other circumstances, scope is simply closed out.  In other circumstances, scope is simply closed out.
 .\" .\" SUB-SECTION  
 .\" .Ss Examples  
 .\" The following examples illustrate each macro classification.  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit full-block.  Has head, body and no tail.  Scope closed by  
 .\" second  
 .\" .Sq \&Sh  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Sh SECTION 1  
 .\" body...  
 .\" \&.Sh SECTION 2  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Nested implicit full-block, where the subsection  
 .\" .Sq \&Ss  
 .\" is within the scope of the parent section  
 .\" .Sq \&Sh  
 .\" and closed along with its parent by the subsequent  
 .\" .Sq \&Sh .  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Sh SECTION 1  
 .\" \&.Ss Subsection 1  
 .\" body...  
 .\" \&.Sh SECTION 2  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit full-block.  Has a head, a body and no tail.  Scope closed by  
 .\" .Sq \&Ef  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Bf symbolic  
 .\" body...  
 .\" \&.Ef  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Nested explicit/implicit scope.  
 .\" .Sq \&It  
 .\" macro is an implicit block whose scope is closed by the explicit  
 .\" .Sq \&El  
 .\" closure.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.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
 Macros are generally two and at times three characters in length.  The  Macros are generally two and at times three characters in length.  The
Line 619  then the macro accepts an arbitrary number of argument
Line 832  then the macro accepts an arbitrary number of argument
 .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0  .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0  .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n  .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n
   .It \&.Dx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0  .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n  .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n  .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n
Line 628  then the macro accepts an arbitrary number of argument
Line 842  then the macro accepts an arbitrary number of argument
 .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    \&No  Ta    Yes     Ta    >0
 .It \&.Mt    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  .Sh COMPATIBILITY
 The mdoc language was traditionally a  The mdoc language was traditionally a
Line 640  compatibility with these systems.
Line 864  compatibility with these systems.
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
   .Sq \&Fo
   and
   .Sq \&St
   historically weren't always callable.  Both are now correctly callable.
   .\" LIST-ITEM
   .It
 .Sq \&It \-nested  .Sq \&It \-nested
 is assumed for all lists: any list may be nested and  is assumed for all lists: any list may be nested and
 .Sq \-enum  .Sq \-enum
Line 688  is callable.
Line 918  is callable.
 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.).
   .El
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.10
CVSweb