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

Diff for /mandoc/mdoc.7 between version 1.63 and 1.64

version 1.63, 2009/10/19 07:34:43 version 1.64, 2009/10/19 10:18:05
Line 270  is necessarily non-portable across output media.  See
Line 270  is necessarily non-portable across output media.  See
 Each  Each
 .Nm  .Nm
 document must begin with a document prologue, containing, in order,  document must begin with a document prologue, containing, in order,
 .Sq \&Dd ,  .Sx \&Dd ,
 .Sq \&Dt ,  .Sx \&Dt ,
 and  and
 .Sq \&Os ,  .Sx \&Os ,
 then the NAME section containing at least one  then the NAME section containing at least one
 .Sq \&Nm  .Sx \&Nm
 followed by  followed by
 .Sq \&Nd :  .Sx \&Nd :
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$  \&.Dd $\&Mdocdate$
 \&.Dt mdoc 7  \&.Dt mdoc 7
Line 331  Macros are one to three three characters in length and
Line 331  Macros are one to three three characters in length and
 control character ,  control character ,
 .Sq \&. ,  .Sq \&. ,
 at the beginning of the line.  An arbitrary amount of whitespace may  at the beginning of the line.  An arbitrary amount of whitespace may
 sit between the control character and the macro name.  Thus,  sit between the control character and the macro name.  Thus, the
 .Sq \&.Pp  following are equivalent:
 and  .Bd -literal -offset indent
 .Sq \&.\ \ \ \&Pp  \&.Pp
 are equivalent.  Macro names are two or three characters in length.  \&.\ \ \ \&Pp
   .Ed
 .  .
 .Pp  .Pp
 The syntax of a macro depends on its classification.  In this section,  The syntax of a macro depends on its classification.  In this section,
Line 374  column, if applicable, describes closure rules.
Line 375  column, if applicable, describes closure rules.
 .Ss Block full-explicit  .Ss Block full-explicit
 Multi-line scope closed by an explicit closing macro.  All macros  Multi-line scope closed by an explicit closing macro.  All macros
 contains bodies; only  contains bodies; only
 .Pq Sq \&Bf  .Sx \&Bf
 contains a head.  contains a head.
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
Line 385  contains a head.
Line 386  contains a head.
 .Pp  .Pp
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .It \&Bd     Ta    \&No     Ta    \&No     Ta    closed by \&Ed  .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
 .It \&Bf     Ta    \&No     Ta    \&No     Ta    closed by \&Ef  .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
 .It \&Bk     Ta    \&No     Ta    \&No     Ta    closed by \&Ek  .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
 .It \&Bl     Ta    \&No     Ta    \&No     Ta    closed by \&El  .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El
 .It \&Ed     Ta    \&No     Ta    \&No     Ta    opened by \&Bd  .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd
 .It \&Ef     Ta    \&No     Ta    \&No     Ta    opened by \&Bf  .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf
 .It \&Ek     Ta    \&No     Ta    \&No     Ta    opened by \&Bk  .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk
 .It \&El     Ta    \&No     Ta    \&No     Ta    opened by \&Bl  .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl
 .El  .El
 .  .
 .  .
Line 400  contains a head.
Line 401  contains a head.
 Multi-line scope closed by end-of-file or implicitly by another macro.  Multi-line scope closed by end-of-file or implicitly by another macro.
 All macros have bodies; some  All macros have bodies; some
 .Po  .Po
 .Sq \&It \-bullet ,  .Sx \&It Fl bullet ,
 .Sq \-hyphen ,  .Fl hyphen ,
 .Sq \-dash ,  .Fl dash ,
 .Sq \-enum ,  .Fl enum ,
 .Sq \-item  .Fl item
 .Pc  .Pc
 don't have heads, while  don't have heads; only one
 .Sq \&It \-column  .Po
 may have multiple heads.  .Sx \&It Fl column
   .Pc
   has multiple heads.
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
Line 417  may have multiple heads.
Line 420  may have multiple heads.
 .Pp  .Pp
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
 .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 \&It     Ta    \&No     Ta    Yes      Ta    closed by \&It, \&El  .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
 .It \&Nd     Ta    \&No     Ta    \&No     Ta    closed by \&Sh  .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .It \&Sh     Ta    \&No     Ta    \&No     Ta    closed by \&Sh  .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .It \&Ss     Ta    \&No     Ta    \&No     Ta    closed by \&Sh, \&Ss  .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss
 .El  .El
 .  .
 .  .
 .Ss Block partial-explicit  .Ss Block partial-explicit
 Like block full-explicit, but also with single-line scope.  Each  Like block full-explicit, but also with single-line scope.  Each
 has at least a body and, in limited circumstances, a head  has at least a body and, in limited circumstances, a head
 .Pq So \&Fo Sc , So \&Eo Sc  .Po
   .Sx \&Fo ,
   .Sx \&Eo
   .Pc
 and/or tail  and/or tail
 .Pq So \&Ec Sc .  .Pq Sx \&Ec .
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
Line 442  and/or tail
Line 448  and/or tail
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent  .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 .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 \&Ac     Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao  .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
 .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac  .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
 .It \&Bc     Ta    Yes      Ta    Yes      Ta    closed by \&Bo  .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
 .It \&Bo     Ta    Yes      Ta    Yes      Ta    opened by \&Bc  .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc
 .It \&Brc    Ta    Yes      Ta    Yes      Ta    opened by \&Bro  .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro
 .It \&Bro    Ta    Yes      Ta    Yes      Ta    closed by \&Brc  .It Sx \&Bro Ta    Yes      Ta    Yes      Ta    closed by Sx \&Brc
 .It \&Dc     Ta    Yes      Ta    Yes      Ta    opened by \&Do  .It Sx \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Do
 .It \&Do     Ta    Yes      Ta    Yes      Ta    closed by \&Dc  .It Sx \&Do  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Dc
 .It \&Ec     Ta    Yes      Ta    Yes      Ta    opened by \&Eo  .It Sx \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Eo
 .It \&Eo     Ta    Yes      Ta    Yes      Ta    closed by \&Ec  .It Sx \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ec
 .It \&Fc     Ta    Yes      Ta    Yes      Ta    opened by \&Fo  .It Sx \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Fo
 .It \&Fo     Ta    \&No     Ta    \&No     Ta    closed by \&Fc  .It Sx \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Fc
 .It \&Oc     Ta    Yes      Ta    Yes      Ta    closed by \&Oo  .It Sx \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oo
 .It \&Oo     Ta    Yes      Ta    Yes      Ta    opened by \&Oc  .It Sx \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oc
 .It \&Pc     Ta    Yes      Ta    Yes      Ta    closed by \&Po  .It Sx \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Po
 .It \&Po     Ta    Yes      Ta    Yes      Ta    opened by \&Pc  .It Sx \&Po  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Pc
 .It \&Qc     Ta    Yes      Ta    Yes      Ta    opened by \&Oo  .It Sx \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oo
 .It \&Qo     Ta    Yes      Ta    Yes      Ta    closed by \&Oc  .It Sx \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oc
 .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs  .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs
 .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re  .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re
 .It \&Sc     Ta    Yes      Ta    Yes      Ta    opened by \&So  .It Sx \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&So
 .It \&So     Ta    Yes      Ta    Yes      Ta    closed by \&Sc  .It Sx \&So  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Sc
 .It \&Xc     Ta    Yes      Ta    Yes      Ta    opened by \&Xo  .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo
 .It \&Xo     Ta    Yes      Ta    Yes      Ta    closed by \&Xc  .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc
 .El  .El
 .  .
 .  .
Line 480  or end of line.
Line 486  or end of line.
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent  .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable  .It Em Macro Ta Em Callable Ta Em Parsable
 .It \&Aq     Ta    Yes      Ta    Yes  .It Sx \&Aq  Ta    Yes      Ta    Yes
 .It \&Bq     Ta    Yes      Ta    Yes  .It Sx \&Bq  Ta    Yes      Ta    Yes
 .It \&Brq    Ta    Yes      Ta    Yes  .It Sx \&Brq Ta    Yes      Ta    Yes
 .It \&D1     Ta    \&No     Ta    \&Yes  .It Sx \&D1  Ta    \&No     Ta    \&Yes
 .It \&Dl     Ta    \&No     Ta    Yes  .It Sx \&Dl  Ta    \&No     Ta    Yes
 .It \&Dq     Ta    Yes      Ta    Yes  .It Sx \&Dq  Ta    Yes      Ta    Yes
 .It \&Op     Ta    Yes      Ta    Yes  .It Sx \&Op  Ta    Yes      Ta    Yes
 .It \&Pq     Ta    Yes      Ta    Yes  .It Sx \&Pq  Ta    Yes      Ta    Yes
 .It \&Ql     Ta    Yes      Ta    Yes  .It Sx \&Ql  Ta    Yes      Ta    Yes
 .It \&Qq     Ta    Yes      Ta    Yes  .It Sx \&Qq  Ta    Yes      Ta    Yes
 .It \&Sq     Ta    Yes      Ta    Yes  .It Sx \&Sq  Ta    Yes      Ta    Yes
 .El  .El
 .  .
 .  .
Line 525  then the macro accepts an arbitrary number of argument
Line 531  then the macro accepts an arbitrary number of argument
 .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0
 .It \&Ad     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    n
 .It \&An     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&An  Ta    Yes      Ta    Yes      Ta    n
 .It \&Ap     Ta    Yes      Ta    Yes      Ta    0  .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0
 .It \&Ar     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n
 .It \&At     Ta    Yes      Ta    Yes      Ta    1  .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1
 .It \&Bsx    Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n
 .It \&Bt     Ta    \&No     Ta    \&No     Ta    0  .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0
 .It \&Bx     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n
 .It \&Cd     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Cm     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    n
 .It \&Db     Ta    \&No     Ta    \&No     Ta    1  .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
 .It \&Dd     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    >0
 .It \&Dt     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
 .It \&Dv     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n
 .It \&Dx     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
 .It \&Em     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0
 .It \&En     Ta    \&No     Ta    \&No     Ta    0  .It Sx \&En  Ta    \&No     Ta    \&No     Ta    0
 .It \&Er     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Es     Ta    \&No     Ta    \&No     Ta    0  .It Sx \&Es  Ta    \&No     Ta    \&No     Ta    0
 .It \&Ev     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Ev  Ta    Yes      Ta    Yes      Ta    n
 .It \&Ex     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n
 .It \&Fa     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    n
 .It \&Fd     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0
 .It \&Fl     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n
 .It \&Fn     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Fr     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Fr  Ta    \&No     Ta    \&No     Ta    n
 .It \&Ft     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Ft  Ta    Yes      Ta    Yes      Ta    n
 .It \&Fx     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n
 .It \&Hf     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n
 .It \&Ic     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0
 .It \&In     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&In  Ta    \&No     Ta    \&No     Ta    n
 .It \&Lb     Ta    \&No     Ta    \&No     Ta    1  .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1
 .It \&Li     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    n
 .It \&Lk     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    n
 .It \&Lp     Ta    \&No     Ta    \&No     Ta    0  .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0
 .It \&Ms     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Mt     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Nm     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Nm  Ta    Yes      Ta    Yes      Ta    n
 .It \&No     Ta    Yes      Ta    Yes      Ta    0  .It Sx \&No  Ta    Yes      Ta    Yes      Ta    0
 .It \&Ns     Ta    Yes      Ta    Yes      Ta    0  .It Sx \&Ns  Ta    Yes      Ta    Yes      Ta    0
 .It \&Nx     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Nx  Ta    Yes      Ta    Yes      Ta    n
 .It \&Os     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Os  Ta    \&No     Ta    \&No     Ta    n
 .It \&Ot     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Ot  Ta    \&No     Ta    \&No     Ta    n
 .It \&Ox     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Ox  Ta    Yes      Ta    Yes      Ta    n
 .It \&Pa     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Pa  Ta    Yes      Ta    Yes      Ta    n
 .It \&Pf     Ta    \&No     Ta    Yes      Ta    1  .It Sx \&Pf  Ta    \&No     Ta    Yes      Ta    1
 .It \&Pp     Ta    \&No     Ta    \&No     Ta    0  .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0
 .It \&Rv     Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n
 .It \&Sm     Ta    \&No     Ta    \&No     Ta    1  .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    1
 .It \&St     Ta    \&No     Ta    Yes      Ta    1  .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1
 .It \&Sx     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Sy     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Tn     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Tn  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Ud     Ta    \&No     Ta    \&No     Ta    0  .It Sx \&Ud  Ta    \&No     Ta    \&No     Ta    0
 .It \&Ux     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n
 .It \&Va     Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n
 .It \&Vt     Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0
 .It \&Xr     Ta    Yes      Ta    Yes      Ta    >0, <3  .It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    >0, <3
 .It \&br     Ta    \&No     Ta    \&No     Ta    0  .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0
 .It \&sp     Ta    \&No     Ta    \&No     Ta    1  .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1
 .El  .El
 .  .
 .  .
Line 597  alphabetically.  For the scoping of individual macros,
Line 603  alphabetically.  For the scoping of individual macros,
 Author name of an  Author name of an
 .Sx \&Rs  .Sx \&Rs
 block.  Multiple authors should each be accorded their own  block.  Multiple authors should each be accorded their own
 .Sq \%%A  .Sx \%%A
 line.  line.
 .Pp  .Pp
 Author names should be ordered with full or abbreviated forename(s)  Author names should be ordered with full or abbreviated forename(s)
 first, then full surname.  first, then full surname.
   .
 .Ss \&%B  .Ss \&%B
 Book title of an  Book title of an
 .Sx \&Rs  .Sx \&Rs
 block.  This macro may also be used in a non-bibliographic context when  block.  This macro may also be used in a non-bibliographic context when
 referring to book titles.  referring to book titles.
   .
 .Ss \&%C  .Ss \&%C
 Publication city or location of an  Publication city or location of an
 .Sx \&Rs  .Sx \&Rs
Line 615  block.
Line 623  block.
 .Em Compatibility remark :  .Em Compatibility remark :
 this macro is not implemented in  this macro is not implemented in
 .Xr groff 1 .  .Xr groff 1 .
   .
 .Ss \&%D  .Ss \&%D
 Publication date of an  Publication date of an
 .Sx \&Rs  .Sx \&Rs
 block.  This should follow the canonical syntax for  block.  This should follow the canonical syntax for
 .Sx Dates .  .Sx Dates .
   .
 .Ss \&%I  .Ss \&%I
 Publisher or issuer name of an  Publisher or issuer name of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
   .
 .Ss \&%J  .Ss \&%J
 Journal name of an  Journal name of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
   .
 .Ss \&%N  .Ss \&%N
 Issue number (usually for journals) of an  Issue number (usually for journals) of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
   .
 .Ss \&%O  .Ss \&%O
 Optional information of an  Optional information of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
   .
 .Ss \&%P  .Ss \&%P
 Book or journal page number of an  Book or journal page number of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
   .
 .Ss \&%Q  .Ss \&%Q
 Institutional author (school, government, etc.) of an  Institutional author (school, government, etc.) of an
 .Sx \&Rs  .Sx \&Rs
 block.  Multiple institutional authors should each be accorded their own  block.  Multiple institutional authors should each be accorded their own
 .Sq \&%Q  .Sx \&%Q
 line.  line.
   .
 .Ss \&%R  .Ss \&%R
 Technical report name of an  Technical report name of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
   .
 .Ss \&%T  .Ss \&%T
 Article title of an  Article title of an
 .Sx \&Rs  .Sx \&Rs
 block.  This macro may also be used in a non-bibliographical context  block.  This macro may also be used in a non-bibliographical context
 when referring to article titles.  when referring to article titles.
   .
 .Ss \&%V  .Ss \&%V
 Volume number of an  Volume number of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
   .
 .Ss \&Ac  .Ss \&Ac
 Closes an  Closes an
 .Sx \&Ao  .Sx \&Ao
 block.  Does not have any tail arguments.  block.  Does not have any tail arguments.
   .
 .Ss \&Ad  .Ss \&Ad
 Address construct: usually in the context of an computational address in  Address construct: usually in the context of an computational address in
 memory, not a physical (post) address.  memory, not a physical (post) address.
 .Pp  .Pp
 Example:  Examples:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Ad [0,$]  \&.Ad [0,$]
 \&.Ad 0x00000000  \&.Ad 0x00000000
 .Ed  .Ed
   .
 .Ss \&An  .Ss \&An
   Author name.  This macro may alternatively accepts the following
   arguments, although these may not be specified along with a parameter:
   .Bl -tag -width 12n -offset indent
   .It Fl split
   Renders a line break is rendered before each author listing.
   .It Fl nosplit
   The opposite of
   .Fl split .
   .El
   .Pp
   In the AUTHORS section, the default is not to split the first author
   listing, but all subsequent author listings, whether or not they're
   interspersed by other macros or text, are split.  Thus, specifying
   .Fl split
   will cause the first listing also to be split.  If not in the AUTHORS
   section, the default is not to split.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.An -nosplit
   \&.An J. E. Hopcraft ,
   \&.An J. D. Ullman .
   .Ed
   .Pp
   .Em Remarks :
   the effects of
   .Fl split
   or
   .Fl nosplit
   are re-set when entering the AUTHORS section, so if one specifies
   .Sx \&An Fl nosplit
   in the general document body, it must be re-specified in the AUTHORS
   section.
   .
 .Ss \&Ao  .Ss \&Ao
 Begins a block enclosed by angled brackets.  Does not have any head  Begins a block enclosed by angled brackets.  Does not have any head
 arguments.  arguments.
 .Pp  .Pp
 Example:  Examples:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Fl -key= Ns Ao Ar val Ac  \&.Fl -key= Ns Ao Ar val Ac
 .Ed  .Ed
 .Pp  .Pp
 Note that, although this is overwhelmingly used to note URIs, the  See also
 .Sx \&Lk  .Sx \&Aq .
 and  .
 .Sx \&Mt  
 macros are better suited for this purpose.  
 .Ss \&Ap  .Ss \&Ap
   Inserts an apostrophe without any surrounding white-space.  This is
   generally used as a grammatic device when referring to the verb form of
   a function:
   .Bd -literal -offset indent
   \&.Fn execve Ap d
   .Ed
   .
 .Ss \&Aq  .Ss \&Aq
   Encloses its arguments in angled brackets.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Fl -key= Ns Aq Ar val
   .Ed
   .Pp
   .Em Remarks :
   this macro is often abused for rendering URIs, which should instead use
   .Sx \&Lk
   or
   .Sx \&Mt ,
   or to note pre-processor
   .Dq Li #include
   statements, which should use
   .Sx \&In .
   .Pp
   See also
   .Sx \&Ao .
   .
 .Ss \&Ar  .Ss \&Ar
   Command arguments.  If an argument is not provided, the strings
   .Dq file ...
   are used as a default.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Fl o Ns Ar file1
   \&.Ar
   \&.Ar arg1 , arg2 .
   .Ed
   .
 .Ss \&At  .Ss \&At
   Formats an AT&T version.  Accepts at most one parameter:
   .Bl -tag -width 12n -offset indent
   .It Cm v[1-7] | 32v
   A version of
   .At .
   .It Cm V[.[1-4]]?
   A system version of
   .At .
   .El
   .Pp
   Note that these parameters do not begin with a hyphen.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.At
   \&.At V.1
   .Ed
   .
 .Ss \&Bc  .Ss \&Bc
   Closes a
   .Sx \&Bo
   block.  Does not have any tail arguments.
   .
 .Ss \&Bd  .Ss \&Bd
   Begins a display block.  A display is collection of macros or text which
   may be collectively offset or justified in a manner different from that
   of the enclosing context.  By default, the block is preceded by a
   vertical space.
   .Pp
   Each display is associated with a type, which must be one of the
   following arguments:
   .Bl -tag -width 12n -offset indent
   .It Fl ragged
   Only left-justify the block.
   .It Fl unfilled
   Do not justify the block at all.
   .It Fl filled
   Left- and right-justify the block.
   .It Fl literal
   Alias for
   .Fl unfilled .
   .It Fl centered
   Centre-justify each line.
   .El
   .Pp
   The type must be provided first.  Secondary arguments are as follows:
   .Bl -tag -width 12n -offset indent
   .It Fl offset Ar width
   Offset by the value of
   .Ar width ,
   which is interpreted as one of the following, specified in order:
   .Bl -item
   .It
   As one of the pre-defined strings
   .Ar indent ,
   the width of standard indentation;
   .Ar indent-two ,
   twice
   .Ar indent ;
   .Ar left ,
   which has no effect ;
   .Ar right ,
   which justifies to the right margin; and
   .Ar center ,
   which aligns around an imagined centre axis.
   .It
   As a precalculated width for a named macro.  The most popular is the
   imaginary macro
   .Ar Ds ,
   which resolves to
   .Ar 6n .
   .It
   As a scaling unit following the syntax described in
   .Sx Scaling Widths .
   .It
   As the calculated string length of the opaque string.
   .El
   .Pp
   If unset, it will revert to the value of
   .Ar 8n
   as described in
   .Sx Scaling Widths .
   .It Fl compact
   Do not assert a vertical space before the block.
   .It Fl file Ar file
   Prepend the file
   .Ar file
   before any text or macros within the block.
   .El
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bd \-literal \-offset indent
   int
   main(void)
   {
           printf("Hello, world!\en");
   }
   \&.Ed
   
   \&.Bd \-unfilled \-offset two-indent \-compact
   Hello
         world.
   \&.Ed
   .Ed
   .
 .Ss \&Bf  .Ss \&Bf
 .Ss \&Bk  .Ss \&Bk
 .Ss \&Bl  .Ss \&Bl
Line 768  macros are better suited for this purpose.
Line 963  macros are better suited for this purpose.
 .Ss \&Ql  .Ss \&Ql
 .Ss \&Qo  .Ss \&Qo
 .Ss \&Qq  .Ss \&Qq
   .
 .Ss \&Re  .Ss \&Re
 Closes a  Closes a
 .Sx \&Rs  .Sx \&Rs
 block.  Does not have any tail arguments.  block.  Does not have any tail arguments.
   .
 .Ss \&Rs  .Ss \&Rs
 Begins a bibliographic  Begins a bibliographic
 .Pq Dq reference  .Pq Dq reference
Line 793  and
Line 990  and
 .Sx \&%V  .Sx \&%V
 child macros (at least one must be specified).  child macros (at least one must be specified).
 .Pp  .Pp
 Example:  Examples:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Rs  \&.Rs
 \&.%A J. E. Hopcroft  \&.%A J. E. Hopcroft
Line 810  If an
Line 1007  If an
 block is used within a SEE ALSO section, a vertical space is asserted  block is used within a SEE ALSO section, a vertical space is asserted
 before the rendered output, else the block continues on the current  before the rendered output, else the block continues on the current
 line.  line.
   .
 .Ss \&Rv  .Ss \&Rv
 .Ss \&Sc  .Ss \&Sc
 .Ss \&Sh  .Ss \&Sh
Line 853  Furthermore, the
Line 1051  Furthermore, the
 .Sq f  .Sq f
 scaling unit, while accepted, is rendered as the default unit.  scaling unit, while accepted, is rendered as the default unit.
 .It  .It
 The  
 .Sq \-split  
 or  
 .Sq \-nosplit  
 argument to  
 .Sq \&An  
 applies to the whole document, not just to the current section as it  
 does in groff.  
 .It  
 In quoted literals, groff allowed pair-wise double-quotes to produce a  In quoted literals, groff allowed pair-wise double-quotes to produce a
 standalone double-quote in formatted output.  This idiosyncratic  standalone double-quote in formatted output.  This idiosyncratic
 behaviour is no longer applicable.  behaviour is no longer applicable.
 .It  .It
   Display types
   .Sx \&Bd Fl center
   and
   .Fl right
   are aliases for
   .Fl left .
 The  The
 .Sq \&sp  .Fl file Ar file
 macro does not accept negative numbers.  argument is ignored.  Since text is not right-justified,
   .Fl ragged
   and
   .Fl filled
   are aliases, as are
   .Fl literal
   and
   .Fl unfilled .
 .It  .It
 Blocks of whitespace are stripped from both macro and free-form text  Blocks of whitespace are stripped from both macro and free-form text
 lines (except when in literal mode), while groff would retain whitespace  lines (except when in literal mode), while groff would retain whitespace
Line 884  made historic groff
Line 1086  made historic groff
 .Qq go orbital  .Qq go orbital
 but is a proper delimiter in this implementation.  but is a proper delimiter in this implementation.
 .It  .It
 .Sq \&It \-nested  .Sx \&It Fl nested
 is assumed for all lists (it wasn't in historic groff): any list may be  is assumed for all lists (it wasn't in historic groff): any list may be
 nested and  nested and
 .Sq \-enum  .Fl enum
 lists will restart the sequence only for the sub-list.  lists will restart the sequence only for the sub-list.
 .It  .It
 .Sq \&It \-column  
 syntax where column widths may be preceded by other arguments (instead  
 of proceeded) is not supported.  
 .It  
 The  
 .Sq \&At  
 macro only accepts a single parameter.  
 .It  
 Some manuals use  Some manuals use
 .Sq \&Li  .Sx \&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.
 .It  .It
 In groff, the  In groff, the
 .Sq \&Fo  .Sx \&Fo
 macro only produces the first parameter.  This is no longer the case.  macro only produces the first parameter.  This is no longer the case.
 .El  .El
 .  .
Line 919  The
Line 1113  The
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .  .\"
 .  .\" XXX: this really isn't the place for these caveats.
 .Sh CAVEATS  .\" .
 There are many ambiguous parts of mdoc.  .\" .
 .  .\" .Sh CAVEATS
 .Pp  .\" There are many ambiguous parts of mdoc.
 .Bl -dash -compact  .\" .
 .It  .\" .Pp
 .Sq \&Fa  .\" .Bl -dash -compact
 should be  .\" .It
 .Sq \&Va  .\" .Sq \&Fa
 as function arguments are variables.  .\" should be
 .It  .\" .Sq \&Va
 .Sq \&Ft  .\" as function arguments are variables.
 should be  .\" .It
 .Sq \&Vt  .\" .Sq \&Ft
 as function return types are still types.  Furthermore, the  .\" should be
 .Sq \&Ft  .\" .Sq \&Vt
 should be removed and  .\" as function return types are still types.  Furthermore, the
 .Sq \&Fo ,  .\" .Sq \&Ft
 which ostensibly follows it, should follow the same convention as  .\" should be removed and
 .Sq \&Va .  .\" .Sq \&Fo ,
 .It  .\" which ostensibly follows it, should follow the same convention as
 .Sq \&Va  .\" .Sq \&Va .
 should formalise that only one or two arguments are acceptable: a  .\" .It
 variable name and optional, preceding type.  .\" .Sq \&Va
 .It  .\" should formalise that only one or two arguments are acceptable: a
 .Sq \&Fd  .\" variable name and optional, preceding type.
 is ambiguous.  It's commonly used to indicate an include file in the  .\" .It
 synopsis section.  .\" .Sq \&Fd
 .Sq \&In  .\" is ambiguous.  It's commonly used to indicate an include file in the
 should be used, instead.  .\" synopsis section.
 .It  .\" .Sq \&In
 Only the  .\" should be used, instead.
 .Sq \-literal  .\" .It
 argument to  .\" Only the
 .Sq \&Bd  .\" .Sq \-literal
 makes sense.  The remaining ones should be removed.  .\" argument to
 .It  .\" .Sq \&Bd
 The  .\" makes sense.  The remaining ones should be removed.
 .Sq \&Xo  .\" .It
 and  .\" The
 .Sq \&Xc  .\" .Sq \&Xo
 macros should be deprecated.  .\" and
 .It  .\" .Sq \&Xc
 The  .\" macros should be deprecated.
 .Sq \&Dt  .\" .It
 macro lacks clarity.  It should be absolutely clear which title will  .\" The
 render when formatting the manual page.  .\" .Sq \&Dt
 .It  .\" macro lacks clarity.  It should be absolutely clear which title will
 A  .\" render when formatting the manual page.
 .Sq \&Lx  .\" .It
 should be provided for Linux (\(`a la  .\" A
 .Sq \&Ox ,  .\" .Sq \&Lx
 .Sq \&Nx  .\" should be provided for Linux (\(`a la
 etc.).  .\" .Sq \&Ox ,
 .It  .\" .Sq \&Nx
 There's no way to refer to references in  .\" etc.).
 .Sq \&Rs/Re  .\" .It
 blocks.  .\" There's no way to refer to references in
 .It  .\" .Sq \&Rs/Re
 The \-split and \-nosplit dictates via  .\" blocks.
 .Sq \&An  .\" .It
 are re-set when entering and leaving the AUTHORS section.  .\" The \-split and \-nosplit dictates via
 .El  .\" .Sq \&An
 .  .\" are re-set when entering and leaving the AUTHORS section.
   .\" .El
   .\" .
Legend:
Removed from v.1.63  
changed lines
  Added in v.1.64
CVSweb