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

Diff for /mandoc/mdoc.7 between version 1.1 and 1.65

version 1.1, 2009/03/13 07:46:10 version 1.65, 2009/10/19 11:02:23
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the  .\" purpose with or without fee is hereby granted, provided that the above
 .\" above copyright notice and this permission notice appear in all  .\" copyright notice and this permission notice appear in all copies.
 .\" copies.  
 .\"  .\"
 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL  .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED  .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE  .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL  .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR  .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" PERFORMANCE OF THIS SOFTWARE.  .\"
 .\"  
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt mdoc 7  .Dt MDOC 7
 .Os  .Os
 .\" SECTION  .
   .
 .Sh NAME  .Sh NAME
 .Nm mdoc  .Nm mdoc
 .Nd mdoc macro reference  .Nd mdoc language reference
 .\" SECTION  .
   .
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mdoc  .Nm mdoc
 language is used to format  language is used to format
 .Bx  .Bx
 .Ux  .Ux
 manuals.  An  manuals.  In this reference document, we describe its syntax, structure,
   and usage.  Our reference implementation is
   .Xr mandoc 1 .
   The
   .Sx COMPATIBILITY
   section describes compatibility with
   .Xr groff 1 .
   .
   .Pp
   An
 .Nm  .Nm
 document follows simple rules:  lines beginning with the control  document follows simple rules:  lines beginning with the control
 character  character
 .Sq \.  .Sq \.
 are parsed for macros.  Other lines are interpreted within the scope of  are parsed for macros.  Other lines are interpreted within the scope of
 prior macros.  Macros are either two or three characters in length.  prior macros:
 .\" SECTION  .Bd -literal -offset indent
 .Sh CHARACTER ENCODING  \&.Sh Macro lines change control state.
   Other lines are interpreted within the current state.
   .Ed
   .
   .
   .Sh LANGUAGE SYNTAX
 .Nm  .Nm
 documents may contain only printable alphanumeric characters, the space  documents may contain only graphable 7-bit ASCII characters, the space
 character  character, and, in certain circumstances, the tab character.  All
 .Sq \  ,  manuals must have
 and, in certain circumstances, the tab character  .Ux
 .Sq \et .  line terminators.
 All manuals must have  .
 .Sq \en  .
 line termination.  .Ss Comments
 .\" SUB-SECTION  Text following a
 .Ss Special Characters  .Sq \e" ,
 Within a macro line, the following characters are special:  whether in a macro or free-form text line, is ignored to the end of
 .\" PARAGRAPH  line.  A macro line with only a control character and comment escape,
   .Sq \&.\e" ,
   is also ignored.  Macro lines with only a control charater and optionally
   whitespace are stripped from input.
   .
   .
   .Ss Reserved Characters
   Within a macro line, the following characters are reserved:
 .Pp  .Pp
 .Bl -tag -width Ds -offset XXXX -compact  .Bl -tag -width Ds -offset indent -compact
 .It \&.  .It \&.
 period  .Pq period
 .It \&,  .It \&,
 comma  .Pq comma
 .It \&:  .It \&:
 colon  .Pq colon
 .It \&;  .It \&;
 semicolon  .Pq semicolon
 .It \&(  .It \&(
 left-parenthesis  .Pq left-parenthesis
 .It \&)  .It \&)
 right-parenthesis  .Pq right-parenthesis
 .It \&[  .It \&[
 left-bracket  .Pq left-bracket
 .It \&]  .It \&]
 right-bracket  .Pq right-bracket
 .It \&?  .It \&?
 question  .Pq question
 .It \&!  .It \&!
 exclmamation  .Pq exclamation
   .It \&|
   .Pq vertical bar
 .El  .El
   .
 .Pp  .Pp
 Use of these characters must either be escaped with a non-breaking space  Use of reserved characters is described in
   .Sx MACRO SYNTAX .
   For general use in macro lines, these characters must either be escaped
   with a non-breaking space
 .Pq Sq \e&  .Pq Sq \e&
 or, if applicable, an appropriate escape-sequence used.  or, if applicable, an appropriate escape sequence used.
 .\" SUB-SECTION  .
   .
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special characters may occur in both macro and free-form lines.
 .Sq \\  Sequences begin with the escape character
 and followed by either an open-parenthesis  .Sq \e
   followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
 for two-character sequences; an open-bracket  for two-character sequences; an open-bracket
 .Sq \&[  .Sq \&[
 for n-character sequences (terminated at a close-bracket  for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;  .Sq \&] ) ;
 or a single one-character sequence.  or a single one-character sequence.  See
   .Xr mandoc_char 7
   for a complete list.  Examples include
   .Sq \e(em
   .Pq em-dash
   and
   .Sq \ee
   .Pq back-slash .
   .
   .
   .Ss Text Decoration
   Terms may be text-decorated using the
   .Sq \ef
   escape followed by an indicator: B (bold), I, (italic), or P and R
   (Roman, or reset).  This form is not recommended for
   .Nm ,
   which encourages semantic, not presentation, annotation.
   .
   .
   .Ss Predefined Strings
   Historically,
   .Xr groff 1
   also defined a set of package-specific
   .Dq predefined strings ,
   which, like
   .Sx Special Characters ,
   demark special output characters and strings by way of input codes.
   Predefined strings are escaped with the slash-asterisk,
   .Sq \e* :
   single-character
   .Sq \e*X ,
   two-character
   .Sq \e*(XX ,
   and N-character
   .Sq \e*[N] .
   See
   .Xr mandoc_char 7
   for a complete list.  Examples include
   .Sq \e*(Am
   .Pq ampersand
   and
   .Sq \e*(Ba
   .Pq vertical bar .
   .
   .
   .Ss Whitespace
   In non-literal free-form lines, consecutive blocks of whitespace are
   pruned from input and added later in the output filter, if applicable:
   .Bd -literal -offset indent
   These     spaces   are    pruned       from    input.
   \&.Bd \-literal
   These         are              not.
   \&.Ed
   .Ed
   .
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  In macro lines, whitespace delimits arguments and is discarded.  If
 .Sq \\* ,  arguments are quoted, whitespace within the quotes is retained.
 with the same combinations as described above.  This form, however, is  .
 deprecated.  The following is a table of all available escapes, arranged  
 by classification.  
 .Pp  .Pp
 Grammatic:  Blank lines are only permitted within literal contexts, as are lines
   containing only whitespace.  Tab characters are only acceptable when
   delimiting
   .Sq \&Bl \-column
   or when in a literal context.
   .
   .
   .Ss Quotation
   Macro arguments may be quoted with a double-quote to group
   space-delimited terms or to retain blocks of whitespace.  A quoted
   argument begins with a double-quote preceded by whitespace.  The next
   double-quote not pair-wise adjacent to another double-quote terminates
   the literal, regardless of surrounding whitespace.
   .
 .Pp  .Pp
 .Bl -tag -width 12n -offset "XXXX" -compact  This produces tokens
 .It \\(em  .Sq a" ,
 .Pq em-dash  .Sq b c ,
 .It \\(en  .Sq de ,
 .Pq en-dash  and
 .It \e-  .Sq fg" .
 .Pq hyphen  Note that any quoted term, be it argument or macro, is indiscriminately
 .It \\\\  considered literal text.  Thus, the following produces
 .Pq back-slash  .Sq \&Em a :
 .It \e'  .Bd -literal -offset indent
 .Pq apostrophe  \&.Em "Em a"
 .It \e`  .Ed
 .Pq back-tick  .
 .It \\  
 .Pq space  
 .It \\.  
 .Pq period  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Enclosures:  In free-form mode, quotes are regarded as opaque text.
   .
   .Ss Dates
   TODO.
   .
   .Ss Scaling Widths
   Many macros support scaled widths for their arguments, such as
   stipulating a two-inch list indentation with the following:
   .Bd -literal -offset indent
   \&.Bl -tag -width 2i
   .Ed
   .
 .Pp  .Pp
 .Bl -tag -width 12n -offset "XXXX" -compact  The syntax for scaled widths is
 .It \\(rC  .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
 .Pq right brace  where a decimal must be preceded or proceeded by at least one digit.
 .It \\(lC  Negative numbers, while accepted, are truncated to zero.  The following
 .Pq left brace  scaling units are accepted:
 .It \\(ra  
 .Pq right angle  
 .It \\(la  
 .Pq left angle  
 .It \\(rB  
 .Pq right bracket  
 .It \\(lB  
 .Pq left bracket  
 .It \\q  
 .Pq double-quote  
 .It \\(lq  
 .Pq left double-quote  
 .It \\(Lq  
 .Pq left double-quote, deprecated  
 .It \\(rq  
 .Pq right double-quote  
 .It \\(Rq  
 .Pq right double-quote, deprecated  
 .It \\(oq  
 .Pq left single-quote  
 .It \\(aq  
 .Pq right single-quote  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Indicatives:  .Bl -tag -width Ds -offset indent -compact
 .Pp  .It c
 .Bl -tag -width 12n -offset "XXXX" -compact  centimetre
 .It \\(<-  .It i
 .Pq left arrow  inch
 .It \\(->  .It P
 .Pq right arrow  pica (~1/6 inch)
 .It \\(ua  .It p
 .Pq up arrow  point (~1/72 inch)
 .It \\(da  .It f
 .Pq down arrow  synonym for
   .Sq u
   .It v
   default vertical span
   .It m
   width of rendered
   .Sq m
   .Pq em
   character
   .It n
   width of rendered
   .Sq n
   .Pq en
   character
   .It u
   default horizontal span
   .It M
   mini-em (~1/100 em)
 .El  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 Mathematical:  Using anything other than
   .Sq m ,
   .Sq n ,
   .Sq u ,
   or
   .Sq v
   is necessarily non-portable across output media.  See
   .Sx COMPATIBILITY .
   .
   .
   .Sh MANUAL STRUCTURE
   Each
   .Nm
   document must begin with a document prologue, containing, in order,
   .Sx \&Dd ,
   .Sx \&Dt ,
   and
   .Sx \&Os ,
   then the NAME section containing at least one
   .Sx \&Nm
   followed by
   .Sx \&Nd :
   .Bd -literal -offset indent
   \&.Dd $\&Mdocdate$
   \&.Dt mdoc 7
   \&.Os
   \&.
   \&.Sh NAME
   \&.Nm foo
   \&.Nd a description goes here
   \&.\e\*q The next is for sections 2 & 3 only.
   \&.\e\*q .Sh LIBRARY
   \&.
   \&.Sh SYNOPSIS
   \&.Nm foo
   \&.Op Fl options
   \&.Ar
   \&.
   \&.Sh DESCRIPTION
   The
   \&.Nm
   utility processes files ...
   \&.\e\*q .Sh IMPLEMENTATION NOTES
   \&.\e\*q The next is for sections 1 & 8 only.
   \&.\e\*q .Sh EXIT STATUS
   \&.\e\*q The next is for sections 2, 3, & 9 only.
   \&.\e\*q .Sh RETURN VALUES
   \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
   \&.\e\*q .Sh ENVIRONMENT
   \&.\e\*q .Sh FILES
   \&.\e\*q .Sh EXAMPLES
   \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
   \&.\e\*q .Sh DIAGNOSTICS
   \&.\e\*q The next is for sections 2, 3, & 9 only.
   \&.\e\*q .Sh ERRORS
   \&.\e\*q .Sh SEE ALSO
   \&.\e\*q .Xr foobar 1
   \&.\e\*q .Sh STANDARDS
   \&.\e\*q .Sh HISTORY
   \&.\e\*q .Sh AUTHORS
   \&.\e\*q .Sh CAVEATS
   \&.\e\*q .Sh BUGS
   \&.\e\*q .Sh SECURITY CONSIDERATIONS
   .Ed
   .
 .Pp  .Pp
 .Bl -tag -width 12n -offset "XXXX" -compact  Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
 .It \\(Gt  but non-compulsory.
 .Pq greater-than, deprecated  .
 .It \\(Lt  .
 .Pq less-than, deprecated  .Sh MACRO SYNTAX
 .It \\(<=  Macros are one to three three characters in length and begin with a
 .Pq less-than-equal  control character ,
 .It \\(Le  .Sq \&. ,
 .Pq less-than-equal, deprecated  at the beginning of the line.  An arbitrary amount of whitespace may
 .It \\(>=  sit between the control character and the macro name.  Thus, the
 .Pq greater-than-equal  following are equivalent:
 .It \\(Ge  .Bd -literal -offset indent
 .Pq greater-than-equal  \&.Pp
 .It \\(==  \&.\ \ \ \&Pp
 .Pq equal  .Ed
 .It \\(!=  .
 .Pq not equal  
 .It \\(Ne  
 .Pq not equal, deprecated  
 .It \\(if  
 .Pq infinity  
 .It \\(If  
 .Pq infinity, deprecated  
 .It \\(na  
 .Pq NaN , an extension  
 .It \\(Na  
 .Pq NaN, deprecated  
 .It \\(+-  
 .Pq plus-minus  
 .It \\(Pm  
 .Pq plus-minus, deprecated  
 .It \\(**  
 .Pq asterisk  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Diacritics:  The syntax of a macro depends on its classification.  In this section,
   .Sq \-arg
   refers to macro arguments, which may be followed by zero or more
   .Sq parm
   parameters;
   .Sq \&Yo
   opens the scope of a macro; and if specified,
   .Sq \&Yc
   closes it out.
   .
 .Pp  .Pp
 .Bl -tag -width 12n -offset "XXXX" -compact  The
 .It \\(ga  .Em Callable
 .Pq accent grave  column indicates that the macro may be called subsequent to the initial
 .It \\(aa  line-macro.  If a macro is not callable, then its invocation after the
 .Pq accent accute  initial line macro is interpreted as opaque text, such that
 .El  .Sq \&.Fl \&Sh
 .\" PARAGRAPH  produces
   .Sq Fl \&Sh .
   .
 .Pp  .Pp
 Special symbols:  The
   .Em Parsable
   column indicates whether the macro may be followed by further
   (ostensibly callable) macros.  If a macro is not parsable, subsequent
   macro invocations on the line will be interpreted as opaque text.
   .
 .Pp  .Pp
 .Bl -tag -width 12n -offset "XXXX" -compact  The
 .It \\(bu  .Em Scope
 .Pq bullet  column, if applicable, describes closure rules.
 .It \\(ba  .
 .Pq bar  .
 .It \\(Ba  .Ss Block full-explicit
 .Pq bar, deprecated  Multi-line scope closed by an explicit closing macro.  All macros
 .It \\(co  contains bodies; only
 .Pq copyright  .Sx \&Bf
 .It \\&  contains a head.
 .Pq non-breaking space  .Bd -literal -offset indent
 .It \\e  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 .Pq escape  \(lBbody...\(rB
 .It \\(Am  \&.Yc
 .Pq ampersand, deprecated  .Ed
 .El  .
 .\" SECTION  .Pp
 .Sh CLASSIFICATION  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
 Macros are classified in an ontology described by scope rules.  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .Bl -tag -width "in-lineX"  .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
 .\" LIST-ITEM  .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
 .It Em Block  .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
 Block macros enclose other block macros, in-line macros or text, and  .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El
 may span multiple lines.  .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd
 .Qq Implicit  .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf
 block scope is closed by a subsequent invocation of the same macro,  .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk
 one of a set of corresponding closure macros or end-of-file.  .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl
 .Qq Explicit  
 block scope is closed by a corresponding closure macro.  
 .Bl -tag -width "partial-blockX"  
 .\" LIST-ITEM  
 .It Em Full-block  
 Always spans multiple lines.  Consists optionally of one or more  
 .Qq heads ,  
 subsequent macros or text on the same line following invocation; a  
 .Qq body ,  
 which spans subsequent lines of text or macros; and an optional  
 .Qq tail ,  
 macros or text on the same line following closure.  
 .\" LIST-ITEM  
 .It Em Partial-block  
 May span multiple lines.  Consists optionally of a  
 .Qq head ,  
 text immediately following invocation; always a  
 .Qq body ,  
 text or macros following the head on the same and subsequent lines; and  
 optionally a  
 .Qq tail ,  
 text immediately following closure.  
 .El  .El
 .\" LIST-ITEM  .
 .It Em In-line  .
 In-line macros may only enclose text and span at most a single line.  If  
 a macro is parsable, its scope may be closed by subsequent macros or  
 delimiting punctuation.  In-line macros follow different conventions for  
 closure; see  
 .Sx MACROS  
 for per-macro details.  
 .El  
 .\" .\" SUB-SECTION  
 .\" .Ss Examples  
 .\" The following examples illustrate each macro classification.  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit full-block.  Has head, body and no tail.  Scope closed by  
 .\" second  
 .\" .Sq \&Sh  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Sh SECTION 1  
 .\" body...  
 .\" \&.Sh SECTION 2  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Nested implicit full-block, where the subsection  
 .\" .Sq \&Ss  
 .\" is within the scope of the parent section  
 .\" .Sq \&Sh  
 .\" and closed along with its parent by the subsequent  
 .\" .Sq \&Sh .  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Sh SECTION 1  
 .\" \&.Ss Subsection 1  
 .\" body...  
 .\" \&.Sh SECTION 2  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit full-block.  Has a head, a body and no tail.  Scope closed by  
 .\" .Sq \&Ef  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Bf symbolic  
 .\" body...  
 .\" \&.Ef  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Nested explicit/implicit scope.  
 .\" .Sq \&It  
 .\" macro is an implicit block whose scope is closed by the explicit  
 .\" .Sq \&El  
 .\" closure.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Bl \-bullet  
 .\" \&.It head  
 .\" body...  
 .\" \&.El  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit partial-block.  Has head, body and tail.  Scope closed by  
 .\" .Sq \&Ec  
 .\" invocation.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Eo head body... \&Ec tail  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit partial-block.  Has only body.  Scope is closed by end-of-line.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Sq body...  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Explicit partial-block with only body and scope closed by  
 .\" .Sq \&Ac  
 .\" invocation.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Ao body... \&Ac  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Implicit partial-block enclosing explicit partial-block.  
 .\" .Bd -literal -offset XXX  
 .\" \&.Sq body... \&Ao body... \&Ac  
 .\" .Ed  
 .\" .\" PARAGRAPH  
 .\" .Pp  
 .\" Inline macros, several in sequence.  Scope is closed for  
 .\" .Sq \&Fl  
 .\" by the punctuation delimiter and  
 .\" .Sq \&Ar  
 .\" by the end-of-line.  
 .\" .Bd -literal -offset XXXX  
 .\" \&.Fl text0 text1 ; Ar text0 text1  
 .\" .Ed  
 .\" SECTION  
 .Sh MACROS  
 This section contains a complete list of all  
 .Nm  
 macros, arranged ontologically then alphanumerically by macro name.  A  
 .Qq callable  
 macro is may be invoked subsequent to the initial macro-line macro.  A  
 .Qq parsable  
 macro May be followed by further (ostensibly callable) macros.  
 .\" SUB-SECTION  
 .Ss Block full-implicit  .Ss Block full-implicit
 The head of these macros follows invocation; the body is the content of  Multi-line scope closed by end-of-file or implicitly by another macro.
 subsequent lines prior to closure.  None of these macros have tails;  All macros have bodies; some
 some  
 .Po  .Po
 .Sq \&It \-bullet ,  .Sx \&It Fl bullet ,
 .Sq \-hyphen ,  .Fl hyphen ,
 .Sq \-dash ,  .Fl dash ,
 .Sq \-enum  .Fl enum ,
   .Fl item
 .Pc  .Pc
 don't have heads.  don't have heads; only one
   .Po
   .Sx \&It Fl column
   .Pc
   has multiple heads.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
   \(lBbody...\(rB
   .Ed
   .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh  .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
 .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss  .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .It \&.It    Ta    \&No    Ta    Yes     Ta    \&.It, \&.El  .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
   .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss
 .El  .El
 .\" SUB-SECTION  .
 .Ss Block full-explicit  .
 None of these macros are callable or parsed.  The last column indicates  .Ss Block partial-explicit
 the explicit scope rules.  All contains bodies, some may contain heads  Like block full-explicit, but also with single-line scope.  Each
 .Pq So \&Bf Sc .  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
   .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX  .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 \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed  .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
 .It \&.Bl    Ta    \&No    Ta    \&No    Ta    closed by \&.El  .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro
 .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf  .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  .El
 .\" SUB-SECTION  .
   .
 .Ss Block partial-implicit  .Ss Block partial-implicit
 All of these are callable and parsed for further macros.  Their scopes  Like block full-implicit, but with single-line scope closed by
 close at the invocation's end-of-line.  .Sx Reserved Characters
   or end of line.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
   .Ed
   .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX  .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 \&.Op    Ta    Yes   Ta    Yes  .It Sx \&Bq  Ta    Yes      Ta    Yes
 .It \&.Bq    Ta    Yes   Ta    Yes  .It Sx \&Brq Ta    Yes      Ta    Yes
 .It \&.Dq    Ta    Yes   Ta    Yes  .It Sx \&D1  Ta    \&No     Ta    \&Yes
 .It \&.Pq    Ta    Yes   Ta    Yes  .It Sx \&Dl  Ta    \&No     Ta    Yes
 .It \&.Qq    Ta    Yes   Ta    Yes  .It Sx \&Dq  Ta    Yes      Ta    Yes
 .It \&.Sq    Ta    Yes   Ta    Yes  .It Sx \&Op  Ta    Yes      Ta    Yes
 .It \&.Brq   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
 .El  .El
 .\" SUB-SECTION  .
 .Ss Block partial-explicit  .
 Each of these contains at least a body and, in limited circumstances, a  .Ss In-line
 head  Closed by
 .Pq So \&Fo Sc , So \&Eo Sc  .Sx Reserved Characters ,
 and/or tail  end of line, fixed argument lengths, and/or subsequent macros.  In-line
 .Pq So \&Ec Sc .  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
   .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX  .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -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 Arguments
 .It \&.Ao    Ta    Yes   Ta    Yes    Ta    closed by \&.Ac  .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Ac    Ta    Yes   Ta    Yes    Ta    opened by \&.Ao  .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Bc    Ta    Yes   Ta    Yes    Ta    closed by \&.Bo  .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Bo    Ta    Yes   Ta    Yes    Ta    opened by \&.Bc  .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Pc    Ta    Yes   Ta    Yes    Ta    closed by \&.Po  .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Po    Ta    Yes   Ta    Yes    Ta    opened by \&.Pc  .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Do    Ta    Yes   Ta    Yes    Ta    closed by \&.Dc  .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Dc    Ta    Yes   Ta    Yes    Ta    opened by \&.Do  .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Xo    Ta    Yes   Ta    Yes    Ta    closed by \&.Xc  .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Xc    Ta    Yes   Ta    Yes    Ta    opened by \&.Xo  .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Bro   Ta    Yes   Ta    Yes    Ta    closed by \&.Brc  .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Brc   Ta    Yes   Ta    Yes    Ta    opened by \&.Bro  .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0
 .It \&.Oc    Ta    Yes   Ta    Yes    Ta    closed by \&.Oo  .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    n
 .It \&.Oo    Ta    Yes   Ta    Yes    Ta    opened by \&.Oc  .It Sx \&An  Ta    Yes      Ta    Yes      Ta    n
 .It \&.So    Ta    Yes   Ta    Yes    Ta    closed by \&.Sc  .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0
 .It \&.Sc    Ta    Yes   Ta    Yes    Ta    opened by \&.So  .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n
 .It \&.Fc    Ta    Yes   Ta    Yes    Ta    opened by \&.Fo  .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1
 .It \&.Fo    Ta    \&No  Ta    \&No   Ta    closed by \&.Fc  .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n
 .It \&.Ec    Ta    Yes   Ta    Yes    Ta    opened by \&.Eo  .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0
 .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec  .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n
 .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo  .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
 .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc  .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.
   .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 Remarks :
   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
   .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 \&%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 is rendered before each author listing.
   .It Fl nosplit
   The opposite of
   .Fl split .
 .El  .El
 .\" SUB-SECTION  .Pp
 .Ss General  In the AUTHORS section, the default is not to split the first author
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX  listing, but all subsequent author listings, whether or not they're
 .It Em Macro Ta Em Callable Ta Em Parsable  interspersed by other macros or text, are split.  Thus, specifying
 .It \&.Dd    Ta    \&    Ta    \&  .Fl split
 .It \&.Dt    Ta    \&    Ta    \&  will cause the first listing also to be split.  If not in the AUTHORS
 .It \&.Os    Ta    \&    Ta    \&  section, the default is not to split.
 .It \&.Pp    Ta    \&    Ta    \&  .Pp
 .It \&.D1    Ta    \&    Ta    \&  Examples:
 .It \&.Dl    Ta    \&    Ta    Yes  .Bd -literal -offset indent
 .It \&.Ad    Ta    Yes   Ta    Yes  \&.An -nosplit
 .It \&.An    Ta    \&    Ta    Yes  \&.An J. E. Hopcraft ,
 .It \&.Ar    Ta    Yes   Ta    Yes  \&.An J. D. Ullman .
 .It \&.Cd    Ta    Yes   Ta    \&  .Ed
 .It \&.Cm    Ta    Yes   Ta    Yes  .Pp
 .It \&.Dv    Ta    Yes   Ta    Yes  .Em Remarks :
 .It \&.Er    Ta    Yes   Ta    Yes  the effects of
 .It \&.Ev    Ta    Yes   Ta    Yes  .Fl split
 .It \&.Ex    Ta    \&    Ta    \&  or
 .It \&.Fa    Ta    Yes   Ta    Yes  .Fl nosplit
 .It \&.Fd    Ta    \&    Ta    \&  are re-set when entering the AUTHORS section, so if one specifies
 .It \&.Fl    Ta    Yes   Ta    Yes  .Sx \&An Fl nosplit
 .It \&.Fn    Ta    Yes   Ta    Yes  in the general document body, it must be re-specified in the AUTHORS
 .It \&.Ft    Ta    \&    Ta    \&  section.
 .It \&.Ic    Ta    Yes   Ta    Yes  .
 .It \&.In    Ta    \&    Ta    \&  .Ss \&Ao
 .It \&.Li    Ta    Yes   Ta    Yes  Begins a block enclosed by angled brackets.  Does not have any head
 .It \&.Nd    Ta    \&    Ta    \&  arguments.
 .It \&.Nm    Ta    Yes   Ta    Yes  .Pp
 .It \&.Ot    Ta    \&    Ta    \&  Examples:
 .It \&.Pa    Ta    Yes   Ta    Yes  .Bd -literal -offset indent
 .It \&.Rv    Ta    \&    Ta    \&  \&.Fl -key= Ns Ao Ar val Ac
 .It \&.St    Ta    Yes   Ta    \&  .Ed
 .It \&.Va    Ta    Yes   Ta    Yes  .Pp
 .It \&.Vt    Ta    Yes   Ta    Yes  See also
 .It \&.Xr    Ta    Yes   Ta    Yes  .Sx \&Aq .
 .It \&.%A    Ta    \&    Ta    \&  .
 .It \&.%B    Ta    \&    Ta    \&  .Ss \&Ap
 .It \&.%C    Ta    \&    Ta    \&  Inserts an apostrophe without any surrounding white-space.  This is
 .It \&.%D    Ta    \&    Ta    \&  generally used as a grammatic device when referring to the verb form of
 .It \&.%I    Ta    \&    Ta    \&  a function:
 .It \&.%J    Ta    \&    Ta    \&  .Bd -literal -offset indent
 .It \&.%N    Ta    \&    Ta    \&  \&.Fn execve Ap d
 .It \&.%O    Ta    \&    Ta    \&  .Ed
 .It \&.%P    Ta    \&    Ta    \&  .
 .It \&.%R    Ta    \&    Ta    \&  .Ss \&Aq
 .It \&.%T    Ta    \&    Ta    \&  Encloses its arguments in angled brackets.
 .It \&.%V    Ta    \&    Ta    \&  .Pp
 .It \&.At    Ta    Yes   Ta    Yes  Examples:
 .It \&.Bsx   Ta    Yes   Ta    Yes  .Bd -literal -offset indent
 .It \&.Bx    Ta    Yes   Ta    Yes  \&.Fl -key= Ns Aq Ar val
 .It \&.Db    Ta    \&    Ta    \&  .Ed
 .It \&.Em    Ta    Yes   Ta    Yes  .Pp
 .It \&.Fx    Ta    Yes   Ta    Yes  .Em Remarks :
 .It \&.Ms    Ta    \&    Ta    Yes  this macro is often abused for rendering URIs, which should instead use
 .It \&.No    Ta    Yes   Ta    Yes  .Sx \&Lk
 .It \&.Ns    Ta    Yes   Ta    Yes  or
 .It \&.Nx    Ta    Yes   Ta    Yes  .Sx \&Mt ,
 .It \&.Ox    Ta    Yes   Ta    Yes  or to note pre-processor
 .It \&.Pf    Ta    \&    Ta    Yes  .Dq Li #include
 .It \&.Ql    Ta    Yes   Ta    Yes  statements, which should use
 .It \&.Re    Ta    \&    Ta    \&  .Sx \&In .
 .It \&.Rs    Ta    \&    Ta    \&  .Pp
 .It \&.Sm    Ta    \&    Ta    \&  See also
 .It \&.Sx    Ta    Yes   Ta    Yes  .Sx \&Ao .
 .It \&.Sy    Ta    Yes   Ta    Yes  .
 .It \&.Tn    Ta    Yes   Ta    Yes  .Ss \&Ar
 .It \&.Ux    Ta    Yes   Ta    Yes  Command arguments.  If an argument is not provided, the strings
 .It \&.Bk    Ta    \&    Ta    \&  .Dq file ...
 .It \&.Ek    Ta    \&    Ta    \&  are used as a default.
 .It \&.Bt    Ta    \&    Ta    \&  .Pp
 .It \&.Hf    Ta    \&    Ta    \&  Examples:
 .It \&.Fr    Ta    \&    Ta    \&  .Bd -literal -offset indent
 .It \&.Ud    Ta    \&    Ta    \&  \&.Fl o Ns Ar file1
 .It \&.Lb    Ta    \&    Ta    \&  \&.Ar
 .It \&.Ap    Ta    Yes   Ta    Yes  \&.Ar arg1 , arg2 .
 .It \&.Lp    Ta    \&    Ta    \&  .Ed
 .It \&.Lk    Ta    \&    Ta    Yes  .
 .It \&.Mt    Ta    \&    Ta    Yes  .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  .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 \&Bx ,
   .Sx \&Bsx ,
   .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.
   .El
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bd \-unfilled \-offset two-indent \-compact
      Hello       world.
   \&.Ed
   .Ed
   .
   .Ss \&Bf
   .Ss \&Bk
   .Ss \&Bl
   .
   .Ss \&Bo
   Begins a block enclosed by square brackets.  Does not have any head
   arguments.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bo 1 ,
   \&.Dv BUFSIZ Bc
   .Ed
   .Pp
   See also
   .Sx \&Bq .
   .
   .Ss \&Bq
   Encloses its arguments in square brackets.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bq 1 , Dv BUFSIZ
   .Ed
   .Pp
   .Em Remarks :
   this macro is sometimes abused to emulate optional arguments for
   commands; the correct macros to use for this purpose are
   .Sx \&Op ,
   .Sx \&Oo ,
   and
   .Sx \&Oc .
   .Pp
   See also
   .Sx \&Bo .
   .
   .Ss \&Brc
   Closes a
   .Sx \&Bro
   block.  Does not have any tail arguments.
   .
   .Ss \&Bro
   Begins a block enclosed by curly braces.  Does not have any head
   arguments.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bro 1 , ... ,
   \&.Va n Brc
   .Ed
   .Pp
   See also
   .Sx \&Brq .
   .
   .Ss \&Brq
   Encloses its arguments in curly braces.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Brq 1 , ... , Va n
   .Ed
   .Pp
   See also
   .Sx \&Bro .
   .
   .Ss \&Bsx
   Format the BSD/OS version provided as an argument, or a default value if
   no argument is provided.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bsx 1.0
   \&.Bsx
   .Ed
   .Pp
   See also
   .Sx \&At ,
   .Sx \&Bx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .Ss \&Bt
   .Ss \&Bx
   Format the BSD version provided as an argument, or a default value if no
   argument is provided.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bx 4.4
   \&.Bx
   .Ed
   .Pp
   See also
   .Sx \&At ,
   .Sx \&Bsx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .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
   Format the FreeBSD version provided as an argument, or a default value
   if no argument is provided.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Fx 7.1
   \&.Fx
   .Ed
   .Pp
   See also
   .Sx \&At ,
   .Sx \&Bx ,
   .Sx \&Bsx ,
   .Sx \&Nx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .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
   Format the NetBSD version provided as an argument, or a default value if
   no argument is provided.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Nx 5.01
   \&.Nx
   .Ed
   .Pp
   See also
   .Sx \&At ,
   .Sx \&Bx ,
   .Sx \&Bsx ,
   .Sx \&Fx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .Ss \&Oc
   .Ss \&Oo
   .Ss \&Op
   .Ss \&Os
   .Ss \&Ot
   .Ss \&Ox
   Format the OpenBSD version provided as an argument, or a default value
   if no argument is provided.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Ox 4.5
   \&.Ox
   .Ed
   .Pp
   See also
   .Sx \&At ,
   .Sx \&Bsx ,
   .Sx \&Bx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   and
   .Sx \&Ux .
   .
   .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
   Examples:
   .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
   Format the UNIX name.  Accepts no argument.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Ux
   .Ed
   .Pp
   See also
   .Sx \&At ,
   .Sx \&Bx ,
   .Sx \&Bsx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   and
   .Sx \&Ox .
   .
   .Ss \&Va
   .Ss \&Vt
   .Ss \&Xc
   .Ss \&Xo
   .Ss \&Xr
   .Ss \&br
   .Ss \&sp
   .
   .
   .Sh COMPATIBILITY
   This section documents compatibility with other roff implementations, at
   this time limited to
   .Xr groff 1 .
   The term
   .Qq historic groff
   refers to those versions before the
   .Pa doc.tmac
   file re-write
   .Pq somewhere between 1.15 and 1.19 .
   .
   .Pp
   .Bl -dash -compact
   .It
   Negative scaling units are now truncated to zero instead of creating
   interesting conditions, such as with
   .Sq \&sp -1i .
   Furthermore, the
   .Sq f
   scaling unit, while accepted, is rendered as the default unit.
   .It
   In quoted literals, groff allowed pair-wise double-quotes to produce a
   standalone double-quote in formatted output.  This idiosyncratic
   behaviour is no longer applicable.
   .It
   Display types
   .Sx \&Bd Fl center
   and
   .Fl right
   are aliases for
   .Fl left .
   The
   .Fl file Ar file
   argument is ignored.  Since text is not right-justified,
   .Fl ragged
   and
   .Fl filled
   are aliases, as are
   .Fl literal
   and
   .Fl unfilled .
   .It
   Blocks of whitespace are stripped from both macro and free-form text
   lines (except when in literal mode), while groff would retain whitespace
   in free-form text lines.
   .It
   Historic groff has many un-callable macros.  Most of these (excluding
   some block-level macros) are now callable, conforming to the
   non-historic groff version.
   .It
   The vertical bar
   .Sq \(ba
   made historic groff
   .Qq go orbital
   but is a proper delimiter in this implementation.
   .It
   .Sx \&It Fl nested
   is assumed for all lists (it wasn't in historic groff): any list may be
   nested and
   .Fl enum
   lists will restart the sequence only for the sub-list.
   .It
   Some manuals use
   .Sx \&Li
   incorrectly by following it with a reserved character and expecting the
   delimiter to render.  This is not supported.
   .It
   In groff, the
   .Sx \&Fo
   macro only produces the first parameter.  This is no longer the case.
   .El
   .
   .
   .Sh SEE ALSO
   .Xr mandoc 1 ,
   .Xr mandoc_char 7
   .
   .
   .Sh AUTHORS
   The
   .Nm
   reference was written by
   .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.
   .\" .
   .\" .Pp
   .\" .Bl -dash -compact
   .\" .It
   .\" .Sq \&Fa
   .\" should be
   .\" .Sq \&Va
   .\" as function arguments are variables.
   .\" .It
   .\" .Sq \&Ft
   .\" should be
   .\" .Sq \&Vt
   .\" as function return types are still types.  Furthermore, the
   .\" .Sq \&Ft
   .\" should be removed and
   .\" .Sq \&Fo ,
   .\" which ostensibly follows it, should follow the same convention as
   .\" .Sq \&Va .
   .\" .It
   .\" .Sq \&Va
   .\" should formalise that only one or two arguments are acceptable: a
   .\" variable name and optional, preceding type.
   .\" .It
   .\" .Sq \&Fd
   .\" is ambiguous.  It's commonly used to indicate an include file in the
   .\" synopsis section.
   .\" .Sq \&In
   .\" should be used, instead.
   .\" .It
   .\" Only the
   .\" .Sq \-literal
   .\" argument to
   .\" .Sq \&Bd
   .\" makes sense.  The remaining ones should be removed.
   .\" .It
   .\" The
   .\" .Sq \&Xo
   .\" and
   .\" .Sq \&Xc
   .\" macros should be deprecated.
   .\" .It
   .\" The
   .\" .Sq \&Dt
   .\" macro lacks clarity.  It should be absolutely clear which title will
   .\" render when formatting the manual page.
   .\" .It
   .\" A
   .\" .Sq \&Lx
   .\" should be provided for Linux (\(`a la
   .\" .Sq \&Ox ,
   .\" .Sq \&Nx
   .\" etc.).
   .\" .It
   .\" There's no way to refer to references in
   .\" .Sq \&Rs/Re
   .\" blocks.
   .\" .It
   .\" The \-split and \-nosplit dictates via
   .\" .Sq \&An
   .\" are re-set when entering and leaving the AUTHORS section.
   .\" .El
   .\" .
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.65
CVSweb