-\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
-
-\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
-
-\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
-.Ed
-.Pp
-.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
-.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 n
-.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 Yes 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
-.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 or canonical form syntax described in
-.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
-.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 reference document.
-.Ss \&%V
-Volume number of an
-.Sx \&Rs
-block.
-.Ss \&Ac
-Close an
-.Sx \&Ao
-block.
-Does not have any tail arguments.
-.Ss \&Ad
-Memory address.
-Do not use this for postal addresses.
-.Pp
-Examples:
-.D1 \&.Ad [0,$]
-.D1 \&.Ad 0x00000000
-.Ss \&An
-Author name.
-Requires either the name of an author or one of the following arguments:
-.Pp
-.Bl -tag -width "-nosplitX" -offset indent -compact
-.It Fl split
-Start a new output line before each subsequent invocation of
-.Sx \&An .
-.It Fl nosplit
-The opposite of
-.Fl split .
-.El
-.Pp
-The default is
-.Fl nosplit .
-The effect of selecting either of the
-.Fl split
-modes ends at the beginning of the
-.Em AUTHORS
-section.
-In the
-.Em AUTHORS
-section, the default is
-.Fl nosplit
-for the first author listing and
-.Fl split
-for all other author listings.
-.Pp
-Examples:
-.D1 \&.An -nosplit
-.D1 \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv
-.Ss \&Ao
-Begin a block enclosed by angle brackets.
-Does not have any head arguments.
-.Pp
-Examples:
-.D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
-.Pp
-See also
-.Sx \&Aq .
-.Ss \&Ap
-Inserts an apostrophe without any surrounding whitespace.
-This is generally used as a grammatical device when referring to the verb
-form of a function.
-.Pp
-Examples:
-.D1 \&.Fn execve \&Ap d
-.Ss \&Aq
-Encloses its arguments in angle brackets.
-.Pp
-Examples:
-.D1 \&.Fl -key= \&Ns \&Aq \&Ar val
-.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:
-.D1 \&.Fl o \&Ns \&Ar file1
-.D1 \&.Ar
-.D1 \&.Ar arg1 , arg2 .
-.Ss \&At
-Formats an AT&T version.
-Accepts one optional argument:
-.Pp
-.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
-.It Cm v[1-7] | 32v
-A version of
-.At .
-.It Cm V[.[1-4]]?
-A version of
-.At V .
-.El
-.Pp
-Note that these arguments do not begin with a hyphen.
-.Pp
-Examples:
-.D1 \&.At
-.D1 \&.At V.1
-.Pp
-See also
-.Sx \&Bsx ,
-.Sx \&Bx ,
-.Sx \&Dx ,
-.Sx \&Fx ,
-.Sx \&Nx ,
-.Sx \&Ox ,
-and
-.Sx \&Ux .
-.Ss \&Bc
-Close a
-.Sx \&Bo
-block.
-Does not have any tail arguments.
-.Ss \&Bd
-Begin a display block.
-Its syntax is as follows:
-.Bd -ragged -offset indent
-.Pf \. Sx \&Bd
-.Fl Ns Ar type
-.Op Fl offset Ar width
-.Op Fl compact
-.Ed
-.Pp
-Display blocks are used to select a different indentation and
-justification than the one used by the surrounding text.
-They may contain both macro lines and free-form text lines.
-By default, a display block is preceded by a vertical space.
-.Pp
-The
-.Ar type
-must be one of the following:
-.Bl -tag -width 13n -offset indent
-.It Fl centered
-Centre-justify each line.
-Using this display type is not recommended; many
-.Nm
-implementations render it poorly.
-.It Fl filled
-Left- and right-justify the block.
-.It Fl literal
-Do not justify the block at all.
-Preserve white space as it appears in the input.
-.It Fl ragged
-Only left-justify the block.
-.It Fl unfilled
-An alias for
-.Fl literal .
-.El
-.Pp
-The
-.Ar type
-must be provided first.
-Additional arguments may follow:
-.Bl -tag -width 13n -offset indent
-.It Fl offset Ar width
-Indent the display by the
-.Ar width ,
-which may be one of the following:
-.Bl -item
-.It
-One of the pre-defined strings
-.Cm indent ,
-the width of standard indentation;
-.Cm indent-two ,
-twice
-.Cm indent ;
-.Cm left ,
-which has no effect;
-.Cm right ,
-which justifies to the right margin; or
-.Cm center ,
-which aligns around an imagined centre axis.
-.It
-A macro invocation, which selects a predefined width
-associated with that macro.
-The most popular is the imaginary macro
-.Ar \&Ds ,
-which resolves to
-.Sy 6n .
-.It
-A width using the syntax described in
-.Sx Scaling Widths .
-.It
-An arbitrary string, which indents by the length of this string.
-.El
-.Pp
-When the argument is missing,
-.Fl offset
-is ignored.
-.It Fl compact
-Do not assert vertical space before the display.
-.El
-.Pp
-Examples:
-.Bd -literal -offset indent
-\&.Bd \-literal \-offset indent \-compact
- Hello world.
-\&.Ed
git.ckatri.com / mandoc.git / blobdiff