-.Pp
-Note that the
-.Sx \&Nm
-macro is a
-.Sx Block full-implicit
-macro only when invoked as the first macro
-in a
-.Em SYNOPSIS
-section line, else it is
-.Sx In-line .
-.Ss Block partial-explicit
-Like block full-explicit, but also with single-line scope.
-Each has at least a body and, in limited circumstances, a head
-.Po
-.Sx \&Fo ,
-.Sx \&Eo
-.Pc
-and/or tail
-.Pq Sx \&Ec .
-.Bd -literal -offset indent
-\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
-\(lBbody...\(rB
-\&.Yc \(lBtail...\(rB
-
-\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
-\(lBbody...\(rB \&Yc \(lBtail...\(rB
-.Ed
-.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
-.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 \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo
-.It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc
-.It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro
-.It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc
-.It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do
-.It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc
-.It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo
-.It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec
-.It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo
-.It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc
-.It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo
-.It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc
-.It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po
-.It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc
-.It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo
-.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 \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re
-.It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So
-.It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc
-.It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo
-.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc
-.El
-.Ss Block partial-implicit
-Like block full-implicit, but with single-line scope closed by the
-end of the line.
-.Bd -literal -offset indent
-\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
-.Ed
-.Bl -column "MacroX" "CallableX" "ParsedX" -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsed
-.It Sx \&Aq Ta Yes Ta Yes
-.It Sx \&Bq Ta Yes Ta Yes
-.It Sx \&Brq Ta Yes Ta Yes
-.It Sx \&D1 Ta \&No Ta \&Yes
-.It Sx \&Dl Ta \&No Ta Yes
-.It Sx \&Dq Ta Yes Ta Yes
-.It Sx \&Op Ta Yes Ta Yes
-.It Sx \&Pq Ta Yes Ta Yes
-.It Sx \&Ql Ta Yes Ta Yes
-.It Sx \&Qq Ta Yes Ta Yes
-.It Sx \&Sq Ta Yes Ta Yes
-.It Sx \&Vt Ta Yes Ta Yes
-.El
-.Pp
-Note that the
-.Sx \&Vt
-macro is a
-.Sx Block partial-implicit
-only when invoked as the first macro
-in a
-.Em SYNOPSIS
-section line, else it is
-.Sx In-line .
-.Ss Special block macro
-The
-.Sx \&Ta
-macro can only be used below
-.Sx \&It
-in
-.Sx \&Bl Fl column
-lists.
-It delimits blocks representing table cells;
-these blocks have bodies, but no heads.
-.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
-.It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It
-.El
-.Ss In-line
-Closed by the end of the line, fixed argument lengths,
-and/or subsequent macros.
-In-line macros have only text children.
-If a number (or inequality) of arguments is
-.Pq n ,
-then the macro accepts an arbitrary number of arguments.
-.Bd -literal -offset indent
-\&.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
-.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -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 >0
-.It Sx \&An Ta Yes Ta Yes Ta >0
-.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 >0
-.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 >0
-.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 >0
-.It Sx \&Ex Ta \&No Ta \&No Ta n
-.It Sx \&Fa Ta Yes Ta Yes Ta >0
-.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 >0
-.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 1
-.It Sx \&Lb Ta \&No Ta \&No Ta 1
-.It Sx \&Li Ta Yes Ta Yes Ta >0
-.It Sx \&Lk Ta Yes Ta Yes Ta >0
-.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
-.Ss Delimiters
-When a macro argument consists of one single input character
-considered as a delimiter, the argument gets special handling.
-This does not apply when delimiters appear in arguments containing
-more than one character.
-Consequently, to prevent special handling and just handle it
-like any other argument, a delimiter can be escaped by prepending
-a zero-width space
-.Pq Sq \e& .
-In text lines, delimiters never need escaping, but may be used
-as normal punctuation.
-.Pp
-For many macros, when the leading arguments are opening delimiters,
-these delimiters are put before the macro scope,
-and when the trailing arguments are closing delimiters,
-these delimiters are put after the macro scope.
-For example,
-.Pp
-.D1 Pf \. \&Aq "( [ word ] ) ."
-.Pp
-renders as:
-.Pp
-.D1 Aq ( [ word ] ) .
-.Pp
-Opening delimiters are:
-.Pp
-.Bl -tag -width Ds -offset indent -compact
-.It \&(
-left parenthesis
-.It \&[
-left bracket
-.El
-.Pp
-Closing delimiters are:
-.Pp
-.Bl -tag -width Ds -offset indent -compact
-.It \&.
-period
-.It \&,
-comma
-.It \&:
-colon
-.It \&;
-semicolon
-.It \&)
-right parenthesis
-.It \&]
-right bracket
-.It \&?
-question mark
-.It \&!
-exclamation mark
-.El
-.Pp
-Note that even a period preceded by a backslash
-.Pq Sq \e.\&
-gets this special handling; use
-.Sq \e&.
-to prevent that.
-.Pp
-Many in-line macros interrupt their scope when they encounter
-delimiters, and resume their scope when more arguments follow that
-are not delimiters.
-For example,
-.Pp
-.D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e"
-.Pp
-renders as:
-.Pp
-.D1 Fl a ( b | c \*(Ba d ) e
-.Pp
-This applies to both opening and closing delimiters,
-and also to the middle delimiter:
-.Pp
-.Bl -tag -width Ds -offset indent -compact
-.It \&|
-vertical bar
-.El
-.Pp
-As a special case, the predefined string \e*(Ba is handled and rendered
-in the same way as a plain
-.Sq \&|
-character.
-Using this predefined string is not recommended in new manuals.
-.Sh MACRO OVERVIEW
-This overview is sorted such that macros of similar purpose are listed
-together, to help find the best macro for any given purpose.
-Deprecated macros are not included in the overview, but can be found
-in the alphabetical reference below.
-.Ss Document preamble and NAME section macros
-.Bl -column "Brq, Bro, Brc" description
-.It Sx \&Dd Ta document date: Cm $Mdocdate: September 18 2011 $ | Ar month day , year
-.It Sx \&Dt Ta document title: Ar TITLE section Op Ar volume | arch
-.It Sx \&Os Ta operating system version: Op Ar system Op Ar version
-.It Sx \&Nm Ta document name (one argument)
-.It Sx \&Nd Ta document description (one line)
-.El
-.Ss Sections and cross references
-.Bl -column "Brq, Bro, Brc" description
-.It Sx \&Sh Ta section header (one line)
-.It Sx \&Ss Ta subsection header (one line)
-.It Sx \&Sx Ta internal cross reference to a section or subsection
-.It Sx \&Xr Ta cross reference to another manual page: Ar name section
-.It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)
-.El
-.Ss Displays and lists
-.Bl -column "Brq, Bro, Brc" description
-.It Sx \&Bd , \&Ed Ta display block:
-.Fl Ar type
-.Op Fl offset Ar width
-.Op Fl compact
-.It Sx \&D1 Ta indented display (one line)
-.It Sx \&Dl Ta indented literal display (one line)
-.It Sx \&Bl , \&El Ta list block:
-.Fl Ar type
-.Op Fl width Ar val
-.Op Fl offset Ar val
-.Op Fl compact
-.It Sx \&It Ta list item (syntax depends on Fl Ar type )
-.It Sx \&Ta Ta table cell separator in Sx Bl Fl column No lists
-.It Sx \&Rs , \&%* , \&Re Ta bibliographic block (references)
git.ckatri.com / mandoc.git / blobdiff