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

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

version 1.61, 2009/10/18 13:58:48 version 1.63, 2009/10/19 07:34:43
Line 209  considered literal text.  Thus, the following produces
Line 209  considered literal text.  Thus, the following produces
 .Pp  .Pp
 In free-form mode, quotes are regarded as opaque text.  In free-form mode, quotes are regarded as opaque text.
 .  .
   .Ss Dates
   TODO.
   .
 .Ss Scaling Widths  .Ss Scaling Widths
 Many macros support scaled widths for their arguments, such as  Many macros support scaled widths for their arguments, such as
 stipulating a two-inch list indentation with the following:  stipulating a two-inch list indentation with the following:
Line 218  stipulating a two-inch list indentation with the follo
Line 221  stipulating a two-inch list indentation with the follo
 .  .
 .Pp  .Pp
 The syntax for scaled widths is  The syntax for scaled widths is
 .Sq Li [+-]?[0-9]*.[0-9]*[unit] ,  .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
 where a decimal must be preceded or proceeded by at least one digit.  where a decimal must be preceded or proceeded by at least one digit.
 Negative numbers, while accepted, are truncated to zero.  The following  Negative numbers, while accepted, are truncated to zero.  The following
 scaling units are accepted:  scaling units are accepted:
Line 439  and/or tail
Line 442  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 \&Ao  .It \&Ac     Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
 .It \&Ao     Ta    Yes      Ta    Yes      Ta    closed by \&Ac  .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
 .It \&Bc     Ta    Yes      Ta    Yes      Ta    closed by \&Bo  .It \&Bc     Ta    Yes      Ta    Yes      Ta    closed by \&Bo
 .It \&Bo     Ta    Yes      Ta    Yes      Ta    opened by \&Bc  .It \&Bo     Ta    Yes      Ta    Yes      Ta    opened by \&Bc
 .It \&Brc    Ta    Yes      Ta    Yes      Ta    opened by \&Bro  .It \&Brc    Ta    Yes      Ta    Yes      Ta    opened by \&Bro
Line 457  and/or tail
Line 460  and/or tail
 .It \&Po     Ta    Yes      Ta    Yes      Ta    opened by \&Pc  .It \&Po     Ta    Yes      Ta    Yes      Ta    opened by \&Pc
 .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 Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs
 .It \&Rs     Ta    \&No     Ta    \&No     Ta    closed by \&Re  .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re
 .It \&Sc     Ta    Yes      Ta    Yes      Ta    opened by \&So  .It \&Sc     Ta    Yes      Ta    Yes      Ta    opened by \&So
 .It \&So     Ta    Yes      Ta    Yes      Ta    closed by \&Sc  .It \&So     Ta    Yes      Ta    Yes      Ta    closed by \&Sc
 .It \&Xc     Ta    Yes      Ta    Yes      Ta    opened by \&Xo  .It \&Xc     Ta    Yes      Ta    Yes      Ta    opened by \&Xo
Line 510  then the macro accepts an arbitrary number of argument
Line 513  then the macro accepts an arbitrary number of argument
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent  .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
 .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 \&%A     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%B     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%C     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%D     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%I     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%J     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%N     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%O     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%P     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%R     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%T     Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0
 .It \&%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 \&Ad     Ta    Yes      Ta    Yes      Ta    n
 .It \&An     Ta    Yes      Ta    Yes      Ta    n  .It \&An     Ta    Yes      Ta    Yes      Ta    n
 .It \&Ap     Ta    Yes      Ta    Yes      Ta    0  .It \&Ap     Ta    Yes      Ta    Yes      Ta    0
Line 583  then the macro accepts an arbitrary number of argument
Line 586  then the macro accepts an arbitrary number of argument
 .It \&br     Ta    \&No     Ta    \&No     Ta    0  .It \&br     Ta    \&No     Ta    \&No     Ta    0
 .It \&sp     Ta    \&No     Ta    \&No     Ta    1  .It \&sp     Ta    \&No     Ta    \&No     Ta    1
 .El  .El
   .
   .
   .Sh REFERENCE
   This section is a canonical reference of all macros, arranged
   alphabetically.  For the scoping of individual macros, see
   .Sx MACRO SYNTAX .
   .
   .Ss \&%A
   Author name of an
   .Sx \&Rs
   block.  Multiple authors should each be accorded their own
   .Sq \%%A
   line.
   .Pp
   Author names should be ordered with full or abbreviated forename(s)
   first, then full surname.
   .Ss \&%B
   Book title of an
   .Sx \&Rs
   block.  This macro may also be used in a non-bibliographic context when
   referring to book titles.
   .Ss \&%C
   Publication city or location of an
   .Sx \&Rs
   block.
   .Pp
   .Em Compatibility remark :
   this macro is not implemented in
   .Xr groff 1 .
   .Ss \&%D
   Publication date of an
   .Sx \&Rs
   block.  This should follow the canonical syntax for
   .Sx Dates .
   .Ss \&%I
   Publisher or issuer name of an
   .Sx \&Rs
   block.
   .Ss \&%J
   Journal name of an
   .Sx \&Rs
   block.
   .Ss \&%N
   Issue number (usually for journals) of an
   .Sx \&Rs
   block.
   .Ss \&%O
   Optional information of an
   .Sx \&Rs
   block.
   .Ss \&%P
   Book or journal page number of an
   .Sx \&Rs
   block.
   .Ss \&%Q
   Institutional author (school, government, etc.) of an
   .Sx \&Rs
   block.  Multiple institutional authors should each be accorded their own
   .Sq \&%Q
   line.
   .Ss \&%R
   Technical report name of an
   .Sx \&Rs
   block.
   .Ss \&%T
   Article title of an
   .Sx \&Rs
   block.  This macro may also be used in a non-bibliographical context
   when referring to article titles.
   .Ss \&%V
   Volume number of an
   .Sx \&Rs
   block.
   .Ss \&Ac
   Closes an
   .Sx \&Ao
   block.  Does not have any tail arguments.
   .Ss \&Ad
   Address construct: usually in the context of an computational address in
   memory, not a physical (post) address.
   .Pp
   Example:
   .Bd -literal -offset indent
   \&.Ad [0,$]
   \&.Ad 0x00000000
   .Ed
   .Ss \&An
   .Ss \&Ao
   Begins a block enclosed by angled brackets.  Does not have any head
   arguments.
   .Pp
   Example:
   .Bd -literal -offset indent
   \&.Fl -key= Ns Ao Ar val Ac
   .Ed
   .Pp
   Note that, although this is overwhelmingly used to note URIs, the
   .Sx \&Lk
   and
   .Sx \&Mt
   macros are better suited for this purpose.
   .Ss \&Ap
   .Ss \&Aq
   .Ss \&Ar
   .Ss \&At
   .Ss \&Bc
   .Ss \&Bd
   .Ss \&Bf
   .Ss \&Bk
   .Ss \&Bl
   .Ss \&Bo
   .Ss \&Bq
   .Ss \&Brc
   .Ss \&Bro
   .Ss \&Brq
   .Ss \&Bsx
   .Ss \&Bt
   .Ss \&Bx
   .Ss \&Cd
   .Ss \&Cm
   .Ss \&D1
   .Ss \&Db
   .Ss \&Dc
   .Ss \&Dd
   .Ss \&Dl
   .Ss \&Do
   .Ss \&Dq
   .Ss \&Dt
   .Ss \&Dv
   .Ss \&Dx
   .Ss \&Ec
   .Ss \&Ed
   .Ss \&Ef
   .Ss \&Ek
   .Ss \&El
   .Ss \&Em
   .Ss \&En
   .Ss \&Eo
   .Ss \&Er
   .Ss \&Es
   .Ss \&Ev
   .Ss \&Ex
   .Ss \&Fa
   .Ss \&Fc
   .Ss \&Fd
   .Ss \&Fl
   .Ss \&Fn
   .Ss \&Fo
   .Ss \&Fr
   .Ss \&Ft
   .Ss \&Fx
   .Ss \&Hf
   .Ss \&Ic
   .Ss \&In
   .Ss \&It
   .Ss \&Lb
   .Ss \&Li
   .Ss \&Lk
   .Ss \&Lp
   .Ss \&Ms
   .Ss \&Mt
   .Ss \&Nd
   .Ss \&Nm
   .Ss \&No
   .Ss \&Ns
   .Ss \&Nx
   .Ss \&Oc
   .Ss \&Oo
   .Ss \&Op
   .Ss \&Os
   .Ss \&Ot
   .Ss \&Ox
   .Ss \&Pa
   .Ss \&Pc
   .Ss \&Pf
   .Ss \&Po
   .Ss \&Pp
   .Ss \&Pq
   .Ss \&Qc
   .Ss \&Ql
   .Ss \&Qo
   .Ss \&Qq
   .Ss \&Re
   Closes a
   .Sx \&Rs
   block.  Does not have any tail arguments.
   .Ss \&Rs
   Begins a bibliographic
   .Pq Dq reference
   block.  Does not have any head arguments.  The block macro and may only
   contain
   .Sx \&%A ,
   .Sx \&%B ,
   .Sx \&%C ,
   .Sx \&%D ,
   .Sx \&%I ,
   .Sx \&%J ,
   .Sx \&%N ,
   .Sx \&%O ,
   .Sx \&%P ,
   .Sx \&%Q ,
   .Sx \&%R ,
   .Sx \&%T ,
   and
   .Sx \&%V
   child macros (at least one must be specified).
   .Pp
   Example:
   .Bd -literal -offset indent
   \&.Rs
   \&.%A J. E. Hopcroft
   \&.%A J. D. Ullman
   \&.%B Introduction to Automata Theory, Languages, and Computation
   \&.%I Addison-Wesley
   \&.%C Reading, Massachusettes
   \&.%D 1979
   \&.Re
   .Ed
   .Pp
   If an
   .Sx \&Rs
   block is used within a SEE ALSO section, a vertical space is asserted
   before the rendered output, else the block continues on the current
   line.
   .Ss \&Rv
   .Ss \&Sc
   .Ss \&Sh
   .Ss \&Sm
   .Ss \&So
   .Ss \&Sq
   .Ss \&Ss
   .Ss \&St
   .Ss \&Sx
   .Ss \&Sy
   .Ss \&Tn
   .Ss \&Ud
   .Ss \&Ux
   .Ss \&Va
   .Ss \&Vt
   .Ss \&Xc
   .Ss \&Xo
   .Ss \&Xr
   .Ss \&br
   .Ss \&sp
 .  .
 .  .
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
Legend:
Removed from v.1.61  
changed lines
  Added in v.1.63
CVSweb