-.It \&%A Ta \&No Ta \&No Ta >0
-.It \&%B Ta \&No Ta \&No Ta >0
-.It \&%C Ta \&No Ta \&No Ta >0
-.It \&%D Ta \&No Ta \&No Ta >0
-.It \&%I Ta \&No Ta \&No Ta >0
-.It \&%J Ta \&No Ta \&No Ta >0
-.It \&%N Ta \&No Ta \&No Ta >0
-.It \&%O Ta \&No Ta \&No Ta >0
-.It \&%P Ta \&No Ta \&No Ta >0
-.It \&%R Ta \&No Ta \&No Ta >0
-.It \&%T Ta \&No Ta \&No Ta >0
-.It \&%V Ta \&No Ta \&No Ta >0
-.It \&Ad Ta Yes Ta Yes Ta n
-.It \&An Ta Yes Ta Yes Ta n
-.It \&Ap Ta Yes Ta Yes Ta 0
-.It \&Ar Ta Yes Ta Yes Ta n
-.It \&At Ta Yes Ta Yes Ta 1
-.It \&Bsx Ta Yes Ta Yes Ta n
-.It \&Bt Ta \&No Ta \&No Ta 0
-.It \&Bx Ta Yes Ta Yes Ta n
-.It \&Cd Ta Yes Ta Yes Ta >0
-.It \&Cm Ta Yes Ta Yes Ta n
-.It \&Db Ta \&No Ta \&No Ta 1
-.It \&Dd Ta \&No Ta \&No Ta >0
-.It \&Dt Ta \&No Ta \&No Ta n
-.It \&Dv Ta Yes Ta Yes Ta n
-.It \&Dx Ta Yes Ta Yes Ta n
-.It \&Em Ta Yes Ta Yes Ta >0
-.It \&En Ta \&No Ta \&No Ta 0
-.It \&Er Ta Yes Ta Yes Ta >0
-.It \&Es Ta \&No Ta \&No Ta 0
-.It \&Ev Ta Yes Ta Yes Ta n
-.It \&Ex Ta \&No Ta \&No Ta 0
-.It \&Fa Ta Yes Ta Yes Ta n
-.It \&Fd Ta \&No Ta \&No Ta >0
-.It \&Fl Ta Yes Ta Yes Ta n
-.It \&Fn Ta Yes Ta Yes Ta >0
-.It \&Fr Ta \&No Ta \&No Ta n
-.It \&Ft Ta Yes Ta Yes Ta n
-.It \&Fx Ta Yes Ta Yes Ta n
-.It \&Hf Ta \&No Ta \&No Ta n
-.It \&Ic Ta Yes Ta Yes Ta >0
-.It \&In Ta \&No Ta \&No Ta n
-.It \&Lb Ta \&No Ta \&No Ta 1
-.It \&Li Ta Yes Ta Yes Ta n
-.It \&Lk Ta Yes Ta Yes Ta n
-.It \&Lp Ta \&No Ta \&No Ta 0
-.It \&Ms Ta Yes Ta Yes Ta >0
-.It \&Mt Ta Yes Ta Yes Ta >0
-.It \&Nm Ta Yes Ta Yes Ta n
-.It \&No Ta Yes Ta Yes Ta 0
-.It \&Ns Ta Yes Ta Yes Ta 0
-.It \&Nx Ta Yes Ta Yes Ta n
-.It \&Os Ta \&No Ta \&No Ta n
-.It \&Ot Ta \&No Ta \&No Ta n
-.It \&Ox Ta Yes Ta Yes Ta n
-.It \&Pa Ta Yes Ta Yes Ta n
-.It \&Pf Ta \&No Ta Yes Ta 1
-.It \&Pp Ta \&No Ta \&No Ta 0
-.It \&Rv Ta \&No Ta \&No Ta 0
-.It \&Sm Ta \&No Ta \&No Ta 1
-.It \&St Ta \&No Ta Yes Ta 1
-.It \&Sx Ta Yes Ta Yes Ta >0
-.It \&Sy Ta Yes Ta Yes Ta >0
-.It \&Tn Ta Yes Ta Yes Ta >0
-.It \&Ud Ta \&No Ta \&No Ta 0
-.It \&Ux Ta Yes Ta Yes Ta n
-.It \&Va Ta Yes Ta Yes Ta n
-.It \&Vt Ta Yes Ta Yes Ta >0
-.It \&Xr Ta Yes Ta Yes Ta >0, <3
-.It \&br Ta \&No Ta \&No Ta 0
-.It \&sp Ta \&No Ta \&No Ta 1
+.It Sx \&%A Ta \&No Ta \&No Ta >0
+.It Sx \&%B Ta \&No Ta \&No Ta >0
+.It Sx \&%C Ta \&No Ta \&No Ta >0
+.It Sx \&%D Ta \&No Ta \&No Ta >0
+.It Sx \&%I Ta \&No Ta \&No Ta >0
+.It Sx \&%J Ta \&No Ta \&No Ta >0
+.It Sx \&%N Ta \&No Ta \&No Ta >0
+.It Sx \&%O Ta \&No Ta \&No Ta >0
+.It Sx \&%P Ta \&No Ta \&No Ta >0
+.It Sx \&%Q 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 \&%U Ta \&No Ta \&No Ta >0
+.It Sx \&%V Ta \&No Ta \&No Ta >0
+.It Sx \&Ad Ta Yes Ta Yes Ta n
+.It Sx \&An Ta Yes Ta Yes Ta n
+.It Sx \&Ap Ta Yes Ta Yes Ta 0
+.It Sx \&Ar Ta Yes Ta Yes Ta n
+.It Sx \&At Ta Yes Ta Yes Ta 1
+.It Sx \&Bsx Ta Yes Ta Yes Ta n
+.It Sx \&Bt Ta \&No Ta \&No Ta 0
+.It Sx \&Bx Ta Yes Ta Yes Ta n
+.It Sx \&Cd Ta Yes Ta Yes Ta >0
+.It Sx \&Cm Ta Yes Ta Yes Ta n
+.It Sx \&Db Ta \&No Ta \&No Ta 1
+.It Sx \&Dd Ta \&No Ta \&No Ta >0
+.It Sx \&Dt Ta \&No Ta \&No Ta n
+.It Sx \&Dv Ta Yes Ta Yes Ta n
+.It Sx \&Dx Ta Yes Ta Yes Ta n
+.It Sx \&Em Ta Yes Ta Yes Ta >0
+.It Sx \&En Ta \&No Ta \&No Ta 0
+.It Sx \&Er Ta Yes Ta Yes Ta >0
+.It Sx \&Es Ta \&No Ta \&No Ta 0
+.It Sx \&Ev Ta Yes Ta Yes Ta n
+.It Sx \&Ex Ta \&No Ta \&No Ta n
+.It Sx \&Fa Ta Yes Ta Yes Ta n
+.It Sx \&Fd Ta \&No Ta \&No Ta >0
+.It Sx \&Fl Ta Yes Ta Yes Ta n
+.It Sx \&Fn Ta Yes Ta Yes Ta >0
+.It Sx \&Fr Ta \&No Ta \&No Ta n
+.It Sx \&Ft Ta Yes Ta Yes Ta n
+.It Sx \&Fx Ta Yes Ta Yes Ta n
+.It Sx \&Hf Ta \&No Ta \&No Ta n
+.It Sx \&Ic Ta Yes Ta Yes Ta >0
+.It Sx \&In Ta \&No Ta \&No Ta n
+.It Sx \&Lb Ta \&No Ta \&No Ta 1
+.It Sx \&Li Ta Yes Ta Yes Ta n
+.It Sx \&Lk Ta Yes Ta Yes Ta n
+.It Sx \&Lp Ta \&No Ta \&No Ta 0
+.It Sx \&Ms Ta Yes Ta Yes Ta >0
+.It Sx \&Mt Ta Yes Ta Yes Ta >0
+.It Sx \&Nm Ta Yes Ta Yes Ta n
+.It Sx \&No Ta Yes Ta Yes Ta 0
+.It Sx \&Ns Ta Yes Ta Yes Ta 0
+.It Sx \&Nx Ta Yes Ta Yes Ta n
+.It Sx \&Os Ta \&No Ta \&No Ta n
+.It Sx \&Ot Ta \&No Ta \&No Ta n
+.It Sx \&Ox Ta Yes Ta Yes Ta n
+.It Sx \&Pa Ta Yes Ta Yes Ta n
+.It Sx \&Pf Ta \&No Ta Yes Ta 1
+.It Sx \&Pp Ta \&No Ta \&No Ta 0
+.It Sx \&Rv Ta \&No Ta \&No Ta n
+.It Sx \&Sm Ta \&No Ta \&No Ta 1
+.It Sx \&St Ta \&No Ta Yes Ta 1
+.It Sx \&Sx Ta Yes Ta Yes Ta >0
+.It Sx \&Sy Ta Yes Ta Yes Ta >0
+.It Sx \&Tn Ta Yes Ta Yes Ta >0
+.It Sx \&Ud Ta \&No Ta \&No Ta 0
+.It Sx \&Ux Ta Yes Ta Yes Ta n
+.It Sx \&Va Ta Yes Ta Yes Ta n
+.It Sx \&Vt Ta Yes Ta Yes Ta >0
+.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3
+.It Sx \&br Ta \&No Ta \&No Ta 0
+.It Sx \&sp Ta \&No Ta \&No Ta 1
+.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
+.Sx \%%A
+line. 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 Remarks :
+this macro is not implemented in
+.Xr groff 1 .
+.
+.Ss \&%D
+Publication date of an
+.Sx \&Rs
+block. This should follow the reduced syntax for
+.Sx Dates .
+Canonical or non-canonical form is not necessary since publications are
+often referenced only by year, or month and year.
+.
+.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
+.Sx \&%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 \&%U
+URI of current document.
+.
+.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
+Examples:
+.Bd -literal -offset indent
+\&.Ad [0,$]
+\&.Ad 0x00000000
+.Ed
+.
+.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 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
+Begins a block enclosed by angled brackets. Does not have any head
+arguments.
+.Pp
+Examples:
+.Bd -literal -offset indent
+\&.Fl -key= Ns Ao Ar val Ac
+.Ed
+.Pp
+See also
+.Sx \&Aq .
+.
+.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
+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
+Command arguments. If an argument is not provided, the string
+.Dq file ...
+is used as a default.
+.Pp
+Examples:
+.Bd -literal -offset indent
+\&.Fl o Ns Ar file1
+\&.Ar
+\&.Ar arg1 , arg2 .
+.Ed
+.
+.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
+.Pp
+See also
+.Sx \&Bsx ,
+.Sx \&Bx ,
+.Sx \&Dx ,
+.Sx \&Fx ,
+.Sx \&Nx ,
+.Sx \&Ox ,
+and
+.Sx \&Ux .
+.
+.Ss \&Bc
+Closes a
+.Sx \&Bo
+block. Does not have any tail arguments.
+.
+.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.
git.ckatri.com / mandoc.git / blobdiff