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

Diff for /mandoc/mdoc.7 between version 1.16 and 1.78

version 1.16, 2009/03/26 16:23:22 version 1.78, 2009/11/16 09:52:47
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>  .\" 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 language 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.  In this reference document, we describe the syntax, ontology  manuals.  In this reference document, we describe its syntax, structure,
 and structure of the  and usage.  Our reference implementation is
 .Nm  .Xr mandoc 1 .
 language.  The
 .\" PARAGRAPH  .Sx COMPATIBILITY
   section describes compatibility with
   .Xr groff 1 .
   .
 .Pp  .Pp
 An  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:  prior macros:
 .Bd -literal -offset XXX  .Bd -literal -offset indent
 \&.Sh Macro lines change control state.  \&.Sh Macro lines change control state.
 Other lines are interpreted within the current state.  Other lines are interpreted within the current state.
 .Ed  .Ed
 .\" PARAGRAPH  .
 .Pp  .
 Macros are two- or three-character sequences whose scope rules, rules  .Sh LANGUAGE SYNTAX
 that dictate handling of subsequent-line or same-line arguments, are  
 governed by one of five classifications described in this document.  
 .\" SECTION  
 .Sh INPUT ENCODING  
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII 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
 .Pp  Text following a
 The only time a blank line is acceptable is within  .Sq \e" ,
 the context of  whether in a macro or free-form text line, is ignored to the end of
 .Sq \&.Bd \-literal  line.  A macro line with only a control character and comment escape,
 or  .Sq \&.\e" ,
 .Sq \&.Bd \-unfilled .  is also ignored.  Macro lines with only a control charater and optionally
 .Pp  whitespace are stripped from input.
 Tab characters  .
 .Pq \et  .
 are only acceptable when delimiting  
 .Sq \&.Bl \-column  
 and in  
 .Sq \&.Bd \-literal  
 or  
 .Sq \&.Bd \-unfilled  
 contexts.  
 .\" SUB-SECTION  
 .Ss Reserved Characters  .Ss Reserved Characters
 Within a macro line, the following characters are reserved:  Within a macro line, the following characters are reserved:
 .Bl -tag -width 12n -offset XXXX -compact  .Pp
   .Bl -tag -width Ds -offset indent -compact
 .It \&.  .It \&.
 .Pq period  .Pq period
 .It \&,  .It \&,
Line 102  Within a macro line, the following characters are rese
Line 94  Within a macro line, the following characters are rese
 .It \&?  .It \&?
 .Pq question  .Pq question
 .It \&!  .It \&!
 .Pq exclamation  .Pq exclamation
   .It \&|
   .Pq vertical bar
 .El  .El
 .\" PARAGRAPH  .
 .Pp  .Pp
 Use of reserved characters is described in  Use of reserved characters is described in
 .Sx Closure .  .Sx MACRO SYNTAX .
 For general non-reserved use, characters must either be escaped with a  For general use in macro lines, these characters must either be escaped
 non-breaking space  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.
   Sequences begin with the escape character
 .Sq \e  .Sq \e
 followed by either an open-parenthesis  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), R (Roman), or P
   (revert to previous mode):
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  .D1 \efBbold\efR \efIitalic\efP
 .Sq \e* ,  
 with the same combinations as described above.  This form is deprecated.  
 .Pp  .Pp
 The following is a table of all available escapes.  A numerical representation 3, 2, or 1 (bold, italic, and Roman,
   respectively) may be used instead.  A text decoration is valid within
   the current font scope only:  if a macro opens a font scope alongside
   its own scope, such as
   .Sx \&Bf
   .Cm \&Sy ,
   in-scope invocations of
   .Sq \ef
   are only valid within the font scope of the macro.  If
   .Sq \ef
   is specified outside of any font scope, such as in unenclosed, free-form
   text, it will affect the remainder of the document.
 .Pp  .Pp
 Grammatic:  Text may also be sized with the
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq \es
 .It \e(em  escape, whose syntax is one of
 .Pq em-dash  .Sq \es+-n
 .It \e(en  for one-digit numerals;
 .Pq en-dash  .Sq \es(+-nn
 .It \e-  or
 .Pq hyphen  .Sq \es+-(nn
 .It \e\e  for two-digit numerals; and
 .Pq back-slash  .Sq \es[+-N] ,
 .It \e'  .Sq \es+-[N] ,
 .Pq apostrophe  .Sq \es'+-N' ,
 .It \e`  or
 .Pq back-tick  .Sq \es+-'N'
 .It \e  for arbitrary-digit numerals:
 .Pq space  
 .It \e.  
 .Pq period  
 .It \e(r!  
 .Pq upside-down exclamation  
 .It \e(r?  
 .Pq upside-down question  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Enclosures:  .D1 \es+1bigger\es-1
 .Bl -tag -width 12n -offset "XXXX" -compact  .D1 \es[+10]much bigger\es[-10]
 .It \e(lh  .D1 \es+(10much bigger\es-(10
 .Pq left hand  .D1 \es+'100'much much bigger\es-'100'
 .It \e(rh  .Pp
 .Pq right hand  Note these forms are
 .It \e(Fo  .Em not
 .Pq left guillemet  recommended for
 .It \e(Fc  .Nm ,
 .Pq right guillemet  which encourages semantic annotation.
 .It \e(fo  .
 .Pq left guilsing  .
 .It \e(fc  .Ss Predefined Strings
 .Pq right guilsing  Historically,
 .It \e(rC  .Xr groff 1
 .Pq right brace  also defined a set of package-specific
 .It \e(lC  .Dq predefined strings ,
 .Pq left brace  which, like
 .It \e(ra  .Sx Special Characters ,
 .Pq right angle  demark special output characters and strings by way of input codes.
 .It \e(la  Predefined strings are escaped with the slash-asterisk,
 .Pq left angle  .Sq \e* :
 .It \e(rB  single-character
 .Pq right bracket  .Sq \e*X ,
 .It \e(lB  two-character
 .Pq left bracket  .Sq \e*(XX ,
 .It \eq  and N-character
 .Pq double-quote  .Sq \e*[N] .
 .It \e(lq  See
 .Pq left double-quote  .Xr mandoc_char 7
 .It \e(Lq  for a complete list.  Examples include
 .Pq left double-quote, deprecated  .Sq \e*(Am
 .It \e(rq  .Pq ampersand
 .Pq right double-quote  and
 .It \e(Rq  .Sq \e*(Ba
 .Pq right double-quote, deprecated  .Pq vertical bar .
 .It \e(oq  .
 .Pq left single-quote  .
 .It \e(aq  .Ss Whitespace
 .Pq right single-quote  In non-literal free-form lines, consecutive blocks of whitespace are
 .It \e(Bq  pruned from input and added later in the output filter, if applicable:
 .Pq right low double-quote  .Bd -literal -offset indent
 .It \e(bq  These     spaces   are    pruned       from    input.
 .Pq right low single-quote  \&.Bd \-literal
   These         are              not.
   \&.Ed
   .Ed
   .
   .Pp
   In macro lines, whitespace delimits arguments and is discarded.  If
   arguments are quoted, whitespace within the quotes is retained.
   .
   .Pp
   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
   This produces tokens
   .Sq a" ,
   .Sq b c ,
   .Sq de ,
   and
   .Sq fg" .
   Note that any quoted term, be it argument or macro, is indiscriminately
   considered literal text.  Thus, the following produces
   .Sq \&Em a :
   .Bd -literal -offset indent
   \&.Em "Em a"
   .Ed
   .
   .Pp
   In free-form mode, quotes are regarded as opaque text.
   .
   .Ss Dates
   There are several macros in
   .Nm
   that require a date argument.  The canonical form for dates is the
   American format:
   .Pp
   .D1 Cm Month Day , Year
   .Pp
   The
   .Cm Day
   value is an optionally zero-padded numeral.  The
   .Cm Month
   value is the full month name.  The
   .Cm Year
   value is the full four-digit year.
   .Pp
   Reduced form dates are broken-down canonical form dates:
   .Pp
   .D1 Cm Month , Year
   .D1 Cm Year
   .Pp
   Some examples of valid dates follow:
   .Pp
   .D1 "May, 2009" Pq reduced form
   .D1 "2009" Pq reduced form
   .D1 "May 20, 2009" Pq canonical form
   .
   .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
   The syntax for scaled widths is
   .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
   where a decimal must be preceded or proceeded by at least one digit.
   Negative numbers, while accepted, are truncated to zero.  The following
   scaling units are accepted:
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It c
   centimetre
   .It i
   inch
   .It P
   pica (~1/6 inch)
   .It p
   point (~1/72 inch)
   .It f
   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
 Indicatives:  Using anything other than
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq m ,
 .It \e(<-  .Sq n ,
 .Pq left arrow  .Sq u ,
 .It \e(->  or
 .Pq right arrow  .Sq v
 .It \e(ua  is necessarily non-portable across output media.  See
 .Pq up arrow  .Sx COMPATIBILITY .
 .It \e(da  .
 .Pq down arrow  .
 .It \e(<>  .Sh MANUAL STRUCTURE
 .Pq left-right arrow  A well-formed
 .It \e(lA  .Nm
 .Pq left double-arrow  document consists of a document prologue followed by one or more
 .It \e(rA  sections.
 .Pq right double-arrow  .Pp
 .It \e(uA  The prologue, which consists of (in order) the
 .Pq up double-arrow  .Sx \&Dd ,
 .It \e(dA  .Sx \&Dt ,
 .Pq down double-arrow  and
 .It \e(hA  .Sx \&Os
 .Pq left-right double-arrow  macros, is required for every document.
   .Pp
   The first section (sections are denoted by
   .Sx \&Sh )
   must be the NAME section, consisting of at least one
   .Sx \&Nm
   followed by
   .Sx \&Nd .
   .Pp
   Following that, convention dictates specifying at least the SYNOPSIS and
   DESCRIPTION sections, although this varies between manual sections.
   .Pp
   The following is a well-formed skeleton
   .Nm
   file:
   .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
   The sections in a
   .Nm
   document are conventionally ordered as they appear above.  Sections
   should be composed as follows:
   .Bl -ohang -offset Ds
   .It Em NAME
   The name(s) and a short description of the documented material.  The
   syntax for this as follows:
   .Bd -literal -offset indent
   \&.Nm name0
   \&.Nm name1
   \&.Nm name2
   \&.Nd a short description
   .Ed
   .Pp
   The
   .Sx \&Nm
   macro(s) must precede the
   .Sx \&Nd
   macro.
   .
   .It Em LIBRARY
   The name of the library containing the documented material, which is
   assumed to be a function in a section 2 or 3 manual.  The syntax for
   this is as follows:
   .Bd -literal -offset indent
   \&.Lb libarm
   .Ed
   .Pp
   See
   .Sx \&Lb
   for details.
   .
   .It Em SYNOPSIS
   Documents the utility invocation syntax, function call syntax, or device
   configuration.
   .Pp
   For the first, utilities (sections 1, 6, and 8), this is
   generally structured as follows:
   .Bd -literal -offset indent
   \&.Nm foo
   \&.Op Fl v
   \&.Op Fl o Ar file
   \&.Op Ar
   \&.Nm bar
   \&.Op Fl v
   \&.Op Fl o Ar file
   \&.Op Ar
   .Ed
   .Pp
   For the second, function calls (sections 2, 3, 9):
   .Bd -literal -offset indent
   \&.Vt extern const char *global;
   \&.In header.h
   \&.Ft "char *"
   \&.Fn foo "const char *src"
   \&.Ft "char *"
   \&.Fn bar "const char *src"
   .Ed
   .Pp
   And for the third, configurations (section 4):
   .Bd -literal -offset indent
   \&.Cd \*qit* at isa? port 0x2e\*q
   \&.Cd \*qit* at isa? port 0x4e\*q
   .Ed
   .Pp
   Manuals not in these sections generally don't need a
   .Em SYNOPSIS .
   .
   .It Em DESCRIPTION
   This expands upon the brief, one-line description in
   .Em NAME .
   It usually contains a break-down of the options (if documenting a
   command), such as:
   .Bd -literal -offset indent
   The arguments are as follows:
   \&.Bl \-tag \-width Ds
   \&.It Fl v
   Print verbose information.
   \&.El
   .Ed
   Manuals not documenting a command won't include the above fragment.
   .
   .It Em IMPLEMENTATION NOTES
   Implementation-specific notes should be kept here.  This is useful when
   implementing standard functions that may have side effects or notable
   algorithmic implications.
   .
   .It Em EXIT STATUS
   Command exit status for section 1, 6, and 8 manuals.  This section is
   the dual of
   .Em RETURN VALUES ,
   which is used for functions.  Historically, this information was
   described in
   .Em DIAGNOSTICS ,
   a practise that is now discouraged.
   .Pp
   See
   .Sx \&Ex .
   .
   .It Em RETURN VALUES
   This section is the dual of
   .Em EXIT STATUS ,
   which is used for commands.  It documents the return values of functions
   in sections 2, 3, and 9.
   .Pp
   See
   .Sx \&Rv .
   .
   .It Em ENVIRONMENT
   Documents any usages of environment variables, e.g.,
   .Xr environ 7 .
   .Pp
   See
   .Sx \&Ev .
   .
   .It Em FILES
   Documents files used.  It's helpful to document both the file and a
   short description of how the file is used (created, modified, etc.).
   .Pp
   See
   .Sx \&Pa .
   .
   .It Em EXAMPLES
   Example usages.  This often contains snippets of well-formed,
   well-tested invocations.  Make doubly sure that your examples work
   properly!
   .
   .It Em DIAGNOSTICS
   Documents error conditions.  This is most useful in section 4 manuals.
   Historically, this section was used in place of
   .Em EXIT STATUS
   for manuals in sections 1, 6, and 8; however, this practise is
   discouraged.
   .Pp
   See
   .Sx \&Bl No \-diag .
   .
   .It Em ERRORS
   Documents error handling in sections 2, 3, and 9.
   .Pp
   See
   .Sx \&Er .
   .
   .It Em SEE ALSO
   References other manuals with related topics.  This section should exist
   for most manuals.  Cross-references should conventionally be ordered
   first by section, then alphabetically.
   .Pp
   See
   .Sx \&Xr .
   .
   .It Em STANDARDS
   References any standards implemented or used.  If not adhering to any
   standards, the
   .Em HISTORY
   section should be used instead.
   .Pp
   See
   .Sx \&St .
   .
   .It Em HISTORY
   The history of any manual without a
   .Em STANDARDS
   section should be described in this section.
   .
   .It Em AUTHORS
   Credits to authors, if applicable, should appear in this section.
   Authors should generally be noted by both name and an e-mail address.
   .Pp
   See
   .Sx \&An .
   .
   .It Em CAVEATS
   Explanations of common misuses and misunderstandings should be explained
   in this section.
   .
   .It Em BUGS
   Extant bugs should be described in this section.
   .
   .It Em SECURITY CONSIDERATIONS
   Documents any security precautions that operators should consider.
   .
 .El  .El
 .\" PARAGRAPH  .
   .
   .Sh MACRO SYNTAX
   Macros are one to three three characters in length and begin with a
   control character ,
   .Sq \&. ,
   at the beginning of the line.  An arbitrary amount of whitespace may
   sit between the control character and the macro name.  Thus, the
   following are equivalent:
   .Bd -literal -offset indent
   \&.Pp
   \&.\ \ \ \&Pp
   .Ed
   .
 .Pp  .Pp
 Mathematical:  The syntax of a macro depends on its classification.  In this section,
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq \-arg
 .It \e(es  refers to macro arguments, which may be followed by zero or more
 .Pq empty set  .Sq parm
 .It \e(ca  parameters;
 .Pq intersection  .Sq \&Yo
 .It \e(cu  opens the scope of a macro; and if specified,
 .Pq union  .Sq \&Yc
 .It \e(gr  closes it out.
 .Pq gradient  .
 .It \e(pd  .Pp
 .Pq partial differential  The
 .It \e(ap  .Em Callable
 .Pq similarity  column indicates that the macro may be called subsequent to the initial
 .It \e(=)  line-macro.  If a macro is not callable, then its invocation after the
 .Pq proper superset  initial line macro is interpreted as opaque text, such that
 .It \e((=  .Sq \&.Fl \&Sh
 .Pq proper subset  produces
 .It \e(eq  .Sq Fl \&Sh .
 .Pq equals  .
 .It \e(di  .Pp
 .Pq division  The
 .It \e(mu  .Em Parsable
 .Pq multiplication  column indicates whether the macro may be followed by further
 .It \e(pl  (ostensibly callable) macros.  If a macro is not parsable, subsequent
 .Pq addition  macro invocations on the line will be interpreted as opaque text.
 .It \e(nm  .
 .Pq not element  .Pp
 .It \e(mo  The
 .Pq element  .Em Scope
 .It \e(Im  column, if applicable, describes closure rules.
 .Pq imaginary  .
 .It \e(Re  .
 .Pq real  .Ss Block full-explicit
 .It \e(Ah  Multi-line scope closed by an explicit closing macro.  All macros
 .Pq aleph  contains bodies; only
 .It \e(te  .Sx \&Bf
 .Pq existential quantifier  contains a head.
 .It \e(fa  .Bd -literal -offset indent
 .Pq universal quantifier  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 .It \e(AN  \(lBbody...\(rB
 .Pq logical AND  \&.Yc
 .It \e(OR  .Ed
 .Pq logical OR  .
 .It \e(no  .Pp
 .Pq logical NOT  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
 .It \e(st  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .Pq such that  .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
 .It \e(tf  .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
 .Pq therefore  .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
 .It \e(~~  .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El
 .Pq approximate  .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd
 .It \e(~=  .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf
 .Pq approximately equals  .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk
 .It \e(=~  .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl
 .Pq congruent  
 .It \e(Gt  
 .Pq greater-than, deprecated  
 .It \e(Lt  
 .Pq less-than, deprecated  
 .It \e(<=  
 .Pq less-than-equal  
 .It \e(Le  
 .Pq less-than-equal, deprecated  
 .It \e(>=  
 .Pq greater-than-equal  
 .It \e(Ge  
 .Pq greater-than-equal  
 .It \e(==  
 .Pq equal  
 .It \e(!=  
 .Pq not equal  
 .It \e(Ne  
 .Pq not equal, deprecated  
 .It \e(if  
 .Pq infinity  
 .It \e(If  
 .Pq infinity, deprecated  
 .It \e(na  
 .Pq NaN , an extension  
 .It \e(Na  
 .Pq NaN, deprecated  
 .It \e(+-  
 .Pq plus-minus  
 .It \e(Pm  
 .Pq plus-minus, deprecated  
 .It \e(**  
 .Pq asterisk  
 .El  .El
 .\" PARAGRAPH  .
   .
   .Ss Block full-implicit
   Multi-line scope closed by end-of-file or implicitly by another macro.
   All macros have bodies; some
   .Po
   .Sx \&It Fl bullet ,
   .Fl hyphen ,
   .Fl dash ,
   .Fl enum ,
   .Fl item
   .Pc
   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
 Ligatures:  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
 .Bl -tag -width 12n -offset "XXXX" -compact  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .It \e(ss  .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
 .Pq German eszett  .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .It \e(AE  .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .Pq upper-case AE  .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss
 .It \e(ae  
 .Pq lower-case AE  
 .It \e(OE  
 .Pq upper-case OE  
 .It \e(oe  
 .Pq lower-case OE  
 .It \e(ff  
 .Pq ff ligature  
 .It \e(fi  
 .Pq fi ligature  
 .It \e(fl  
 .Pq fl ligature  
 .It \e(Fi  
 .Pq ffi ligature  
 .It \e(Fl  
 .Pq ffl ligature  
 .El  .El
 .\" PARAGRAPH  .
   .
   .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
   .
 .Pp  .Pp
 Diacritics and letters:  .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
 .Bl -tag -width 12n -offset "XXXX" -compact  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .It \e(ga  .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
 .Pq grave accent  .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
 .It \e(aa  .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
 .Pq accute accent  .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc
 .It \e(a"  .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro
 .Pq umlaut accent  .It Sx \&Bro Ta    Yes      Ta    Yes      Ta    closed by Sx \&Brc
 .It \e(ad  .It Sx \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Do
 .Pq dieresis accent  .It Sx \&Do  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Dc
 .It \e(a~  .It Sx \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Eo
 .Pq tilde accent  .It Sx \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ec
 .It \e(a^  .It Sx \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Fo
 .Pq circumflex accent  .It Sx \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Fc
 .It \e(ac  .It Sx \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oo
 .Pq cedilla accent  .It Sx \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oc
 .It \e(ad  .It Sx \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Po
 .Pq dieresis accent  .It Sx \&Po  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Pc
 .It \e(ah  .It Sx \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oo
 .Pq caron accent  .It Sx \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oc
 .It \e(ao  .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs
 .Pq ring accent  .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re
 .It \e(ho  .It Sx \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&So
 .Pq hook accent  .It Sx \&So  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Sc
 .It \e(ab  .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo
 .Pq breve accent  .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc
 .It \e(a-  
 .Pq macron accent  
 .It \e(-D  
 .Pq upper-case eth  
 .It \e(Sd  
 .Pq lower-case eth  
 .It \e(TP  
 .Pq upper-case thorn  
 .It \e(Tp  
 .Pq lower-case thorn  
 .It \e('A  
 .Pq upper-case acute A  
 .It \e('E  
 .Pq upper-case acute E  
 .It \e('I  
 .Pq upper-case acute I  
 .It \e('O  
 .Pq upper-case acute O  
 .It \e('U  
 .Pq upper-case acute U  
 .It \e('a  
 .Pq lower-case acute a  
 .It \e('e  
 .Pq lower-case acute e  
 .It \e('i  
 .Pq lower-case acute i  
 .It \e('o  
 .Pq lower-case acute o  
 .It \e('u  
 .Pq lower-case acute u  
 .It \e(`A  
 .Pq upper-case grave A  
 .It \e(`E  
 .Pq upper-case grave E  
 .It \e(`I  
 .Pq upper-case grave I  
 .It \e(`O  
 .Pq upper-case grave O  
 .It \e(`U  
 .Pq upper-case grave U  
 .It \e(`a  
 .Pq lower-case grave a  
 .It \e(`e  
 .Pq lower-case grave e  
 .It \e(`i  
 .Pq lower-case grave i  
 .It \e(`o  
 .Pq lower-case grave o  
 .It \e(`u  
 .Pq lower-case grave u  
 .It \e(~A  
 .Pq upper-case tilde A  
 .It \e(~N  
 .Pq upper-case tilde N  
 .It \e(~O  
 .Pq upper-case tilde O  
 .It \e(~a  
 .Pq lower-case tilde a  
 .It \e(~n  
 .Pq lower-case tilde n  
 .It \e(~o  
 .Pq lower-case tilde o  
 .It \e(:A  
 .Pq upper-case dieresis A  
 .It \e(:E  
 .Pq upper-case dieresis E  
 .It \e(:I  
 .Pq upper-case dieresis I  
 .It \e(:O  
 .Pq upper-case dieresis O  
 .It \e(:U  
 .Pq upper-case dieresis U  
 .It \e(:a  
 .Pq lower-case dieresis a  
 .It \e(:e  
 .Pq lower-case dieresis e  
 .It \e(:i  
 .Pq lower-case dieresis i  
 .It \e(:o  
 .Pq lower-case dieresis o  
 .It \e(:u  
 .Pq lower-case dieresis u  
 .It \e(:y  
 .Pq lower-case dieresis y  
 .It \e(^A  
 .Pq upper-case circumflex A  
 .It \e(^E  
 .Pq upper-case circumflex E  
 .It \e(^I  
 .Pq upper-case circumflex I  
 .It \e(^O  
 .Pq upper-case circumflex O  
 .It \e(^U  
 .Pq upper-case circumflex U  
 .It \e(^a  
 .Pq lower-case circumflex a  
 .It \e(^e  
 .Pq lower-case circumflex e  
 .It \e(^i  
 .Pq lower-case circumflex i  
 .It \e(^o  
 .Pq lower-case circumflex o  
 .It \e(^u  
 .Pq lower-case circumflex u  
 .It \e(,C  
 .Pq upper-case cedilla C  
 .It \e(,c  
 .Pq lower-case cedilla c  
 .It \e(/L  
 .Pq upper-case stroke L  
 .It \e(/l  
 .Pq lower-case stroke l  
 .It \e(/O  
 .Pq upper-case stroke O  
 .It \e(/o  
 .Pq lower-case stroke o  
 .It \e(oA  
 .Pq upper-case ring A  
 .It \e(oa  
 .Pq lower-case ring a  
 .El  .El
 .\" PARAGRAPH  .
   .
   .Ss Block partial-implicit
   Like block full-implicit, but with single-line scope closed by
   .Sx Reserved Characters
   or end of line.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
   .Ed
   .
 .Pp  .Pp
 Monetary:  .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
 .Bl -tag -width 12n -offset "XXXX" -compact  .It Em Macro Ta Em Callable Ta Em Parsable
 .It \e(Cs  .It Sx \&Aq  Ta    Yes      Ta    Yes
 .Pq Scandinavian  .It Sx \&Bq  Ta    Yes      Ta    Yes
 .It \e(Do  .It Sx \&Brq Ta    Yes      Ta    Yes
 .Pq dollar  .It Sx \&D1  Ta    \&No     Ta    \&Yes
 .It \e(Po  .It Sx \&Dl  Ta    \&No     Ta    Yes
 .Pq pound  .It Sx \&Dq  Ta    Yes      Ta    Yes
 .It \e(Ye  .It Sx \&Op  Ta    Yes      Ta    Yes
 .Pq yen  .It Sx \&Pq  Ta    Yes      Ta    Yes
 .It \e(Fn  .It Sx \&Ql  Ta    Yes      Ta    Yes
 .Pq florin  .It Sx \&Qq  Ta    Yes      Ta    Yes
 .It \e(ct  .It Sx \&Sq  Ta    Yes      Ta    Yes
 .Pq cent  
 .El  .El
 .\" PARAGRAPH  .
   .
   .Ss In-line
   Closed by
   .Sx Reserved Characters ,
   end of 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
   .
 .Pp  .Pp
 Special symbols:  .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
 .Bl -tag -width 12n -offset "XXXX" -compact  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
 .It \e(de  .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
 .Pq degree  .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
 .It \e(ps  .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
 .Pq paragraph  .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0
 .It \e(sc  .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0
 .Pq section  .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0
 .It \e(dg  .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0
 .Pq dagger  .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0
 .It \e(dd  .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0
 .Pq double dagger  .It Sx \&%Q  Ta    \&No     Ta    \&No     Ta    >0
 .It \e(ci  .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
 .Pq circle  .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0
 .It \e(ba  .It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0
 .Pq bar  .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0
 .It \e(bb  .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    n
 .Pq broken bar  .It Sx \&An  Ta    Yes      Ta    Yes      Ta    n
 .It \e(Ba  .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0
 .Pq bar, deprecated  .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n
 .It \e(co  .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1
 .Pq copyright  .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n
 .It \e(rg  .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0
 .Pq registered  .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n
 .It \e(tm  .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
 .Pq trademarked  .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    n
 .It \e&  .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
 .Pq non-breaking space  .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    >0
 .It \ee  .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
 .Pq escape  .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n
 .It \e(Am  .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
 .Pq ampersand, deprecated  .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0
 .El  .It Sx \&En  Ta    \&No     Ta    \&No     Ta    0
 .\" SECTION  .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0
 .Sh ONTOLOGY  .It Sx \&Es  Ta    \&No     Ta    \&No     Ta    0
 Macros are classified in an ontology described by their scope rules.  .It Sx \&Ev  Ta    Yes      Ta    Yes      Ta    n
 Some macros are allowed to deviate from their classifications to  .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n
 preserve backward-compatibility with old macro combinations still found  .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    n
 in the manual corpus.  These are specifically noted on a per-macro  .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0
 basis.  .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n
 .\" SUB-SECTION  .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0
 .Ss Scope  .It Sx \&Fr  Ta    \&No     Ta    \&No     Ta    n
 .Bl -inset  .It Sx \&Ft  Ta    Yes      Ta    Yes      Ta    n
 .\" LIST-ITEM  .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n
 .It Em Block  .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n
 macros enclose other block macros, in-line macros or text, and  .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0
 may span multiple lines.  .It Sx \&In  Ta    \&No     Ta    \&No     Ta    n
 .Bl -inset -offset XXXX  .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1
 .\" LIST-ITEM  .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    n
 .It Em Full-block  .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    n
 macros always span multiple lines.  They consist of zero or  .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0
 more  .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0
 .Qq heads ,  .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0
 subsequent macros or text on the same line following invocation; an  .It Sx \&Nm  Ta    Yes      Ta    Yes      Ta    n
 optional  .It Sx \&No  Ta    Yes      Ta    Yes      Ta    0
 .Qq body ,  .It Sx \&Ns  Ta    Yes      Ta    Yes      Ta    0
 which spans subsequent lines of text or macros; and an optional  .It Sx \&Nx  Ta    Yes      Ta    Yes      Ta    n
 .Qq tail ,  .It Sx \&Os  Ta    \&No     Ta    \&No     Ta    n
 macros or text on the same line following closure.  .It Sx \&Ot  Ta    \&No     Ta    \&No     Ta    n
 .\" LIST-ITEM  .It Sx \&Ox  Ta    Yes      Ta    Yes      Ta    n
 .It Em Partial-block  .It Sx \&Pa  Ta    Yes      Ta    Yes      Ta    n
 macros may span multiple lines.  They consists of a optional  .It Sx \&Pf  Ta    \&No     Ta    Yes      Ta    1
 .Qq head ,  .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0
 text immediately following invocation; always a  .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n
 .Qq body ,  .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    1
 text or macros following the head on the same and subsequent lines; and  .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1
 optionally a  .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0
 .Qq tail ,  .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0
 text immediately following closure.  .It Sx \&Tn  Ta    Yes      Ta    Yes      Ta    >0
 .\" LIST-ITEM  .It Sx \&Ud  Ta    \&No     Ta    \&No     Ta    0
 .It Em In-line  .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n
 macros may only enclose text and span at most a single line.  .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 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
   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  .El
 .El  
 .\" SUB-SECTION  
 .Ss Closure  
 Closure of a macro's scope depends first on its classification, then  
 on whether it's parsable.  In this table,  
 .Sq BFE  
 refers to block full-explicit and so on.  
 .\" PARAGRAPH  
 .Pp  .Pp
 .Bl -tag -width 12n -offset XXXX -compact  In the AUTHORS section, the default is not to split the first author
 .It BPE , BFE  listing, but all subsequent author listings, whether or not they're
 corresponding explicit closure macro  interspersed by other macros or text, are split.  Thus, specifying
 .It BFI  .Fl split
 end-of-file or a corresponding implicit closure macro  will cause the first listing also to be split.  If not in the AUTHORS
 .It BPI  section, the default is not to split.
 end-of-line (body may be closed by >0 space-separated  .Pp
 .Sx Reserved Characters ,  Examples:
 although block scope will still be open)  .Bd -literal -offset indent
 .It INL  \&.An -nosplit
 end-of-line  \&.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  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 If a macro (block or in-line) is parsable, it may also be closed out by  Note that these parameters do not begin with a hyphen.
 one of the following scenarios (unless specifically noted otherwise):  
 .\" PARAGRAPH  
 .Pp  .Pp
 .Bl -dash -offset XXXX -compact  Examples:
 .It  .Bd -literal -offset indent
 a sequence of >0 space-separated  \&.At
 .Sx Reserved Characters ,  \&.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  .It
 another macro,  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  .It
 end-of-line, or  As a precalculated width for a named macro.  The most popular is the
   imaginary macro
   .Ar \&Ds ,
   which resolves to
   .Ar 6n .
 .It  .It
 completion of a set number of arguments.  As a scaling unit following the syntax described in
   .Sx Scaling Widths .
   .It
   As the calculated string length of the opaque string.
 .El  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 If >0 space-separated  If unset, it will revert to the value of
 .Sx Reserved Characters  .Ar 8n
 are followed by non-reserved characters, the behaviour differs per  as described in
 macro.  In general, scope of the macro is closed and re-opened:  .Sx Scaling Widths .
 subsequent tokens are interpreted as if the scope had just been opened.  .It Fl compact
 In other circumstances, scope is simply closed out.  Do not assert a vertical space before the block.
 .\" SECTION  .It Fl file Ar file
 .Sh SYNTAX  Prepend the file
 Macros are generally two and at times three characters in length.  The  .Ar file
 syntax of macro invocation depends on its classification.  before any text or macros within the block.
 .Qq \-arg  .El
 refers to the macro arguments (which may contain zero or more values).  
 In these illustrations,  
 .Sq \&.Yo  
 opens the scope of a macro, and if specified,  
 .Sq \&.Yc  
 closes it out (closure may be implicit at end-of-line or end-of-file).  
 .\" PARAGRAPH  
 .Pp  .Pp
 Block full-explicit (may contain head, body, tail).  Examples:
 .Bd -literal -offset XXXX  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  \&.Bd \-unfilled \-offset two-indent \-compact
 \(lBbody...\(rB     Hello       world.
 \&.Yc \(lBtail...\(rB  \&.Ed
 .Ed  .Ed
 .\" PARAGRAPH  
 .Pp  .Pp
 Block full-implicit (may contain zero or more heads, body, no tail).  See also
 .Bd -literal -offset XXXX  .Sx \&D1
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  and
 \(lBbody...\(rB  .Sx \&Dl .
 \&.Yc  .
   .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  .Ed
 .\" PARAGRAPH  
 .Pp  .Pp
 Block partial-explicit (may contain head, multi-line body, tail).  See also
 .Bd -literal -offset XXXX  .Sx \&Bq .
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB  .
 \(lBbody...\(rB  .Ss \&Bq
 \&.Yc \(lBtail...\(rB  Encloses its arguments in square brackets.
   .Pp
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \  Examples:
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  .Bd -literal -offset indent
   \&.Bq 1 , Dv BUFSIZ
 .Ed  .Ed
 .\" PARAGRAPH  
 .Pp  .Pp
 Block partial-implicit (no head, body, no tail).  Note that the body  .Em Remarks :
 section may be followed by zero or more  this macro is sometimes abused to emulate optional arguments for
 .Sx Reserved Words .  commands; the correct macros to use for this purpose are
 These are in the block scope, but not in the body scope.  .Sx \&Op ,
 .Bd -literal -offset XXXX  .Sx \&Oo ,
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB  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  .Ed
 .\" PARAGRAPH  
 .Pp  .Pp
 In-lines have \(>=0 scoped arguments.  See also
 .Bd -literal -offset XXX  .Sx \&Brq .
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB  .
   .Ss \&Brq
 \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  Encloses its arguments in curly braces.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Brq 1 , ... , Va n
 .Ed  .Ed
 .\"  .Pp
 .Sh MACROS  See also
 This section contains a complete list of all  .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 \&Dx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .Ss \&Bt
   Prints
   .Dq is currently in beta test.
   .
   .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 \&Dx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .Ss \&Cd
   Configuration declaration (suggested for use only in section four
   manuals).  This denotes strings accepted by
   .Xr config 8 .
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Cd device le0 at scode?
   .Ed
   .Pp
   .Em Remarks :
   this macro is commonly abused by using quoted literals to retain
   white-space and align consecutive
   .Sx \&Cd
   declarations.  This practise is discouraged.
   .
   .Ss \&Cm
   Command modifiers.  Useful when specifying configuration options or
   keys.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Cm ControlPath
   \&.Cm ControlMaster
   .Ed
   .Pp
   See also
   .Sx \&Fl .
   .
   .Ss \&D1
   One-line indented display.  This is formatted by the default rules and
   is useful for simple indented statements.  It is followed by a newline.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.D1 Fl abcdefgh
   .Ed
   .Pp
   See also
   .Sx \&Bd
   and
   .Sx \&Dl .
   .
   .Ss \&Db
   .Ss \&Dc
   Closes a
   .Sx \&Do
   block.  Does not have any tail arguments.
   .
   .Ss \&Dd
   Document date.  This is the mandatory first macro of any
 .Nm  .Nm
 macros, arranged ontologically.  A  manual.  Its calling syntax is as follows:
 .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  
 The head of these macros follows invocation; the body is the content of  
 subsequent lines prior to closure.  None of these macros have tails;  
 some  
 .Po  
 .Sq \&.It \-bullet ,  
 .Sq \-hyphen ,  
 .Sq \-dash ,  
 .Sq \-enum ,  
 .Sq \-item  
 .Pc  
 don't have heads.  
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX  .D1 \. Ns Sx \&Dd Cm date
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  
 .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh  
 .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss  
 .It \&.It    Ta    \&No    Ta    Yes     Ta    \&.It, \&.El  
 .El  
 .\" SUB-SECTION  
 .Ss Block full-explicit  
 None of these macros are callable or parsed.  The last column indicates  
 the explicit scope rules.  All contains bodies, some may contain heads  
 .Pq So \&Bf Sc .  
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX  The
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .Cm date
 .It \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed  field may be either
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  .Ar $\&Mdocdate$ ,
 .It \&.Bl    Ta    \&No    Ta    \&No    Ta    closed by \&.El  which signifies the current manual revision date dictated by
 .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl  .Xr cvs 1 ,
 .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef  or instead a valid canonical date as specified by
 .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf  .Sx Dates .
 .It \&.Bk    Ta    \&No    Ta    \&No    Ta    closed by \&.Ek  If a date does not conform, the current date is used instead.
 .It \&.Ek    Ta    \&No    Ta    \&No    Ta    opened by \&.Bk  
 .El  
 .\" SUB-SECTION  
 .Ss Block partial-implicit  
 All of these are callable and parsed for further macros.  Their scopes  
 close at the invocation's end-of-line.  
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX  Examples:
 .It Em Macro Ta Em Callable Ta Em Parsable  .Bd -literal -offset indent
 .It \&.Aq    Ta    Yes   Ta    Yes  \&.Dd $\&Mdocdate$
 .It \&.Op    Ta    Yes   Ta    Yes  \&.Dd $\&Mdocdate: July 21 2007$
 .It \&.Bq    Ta    Yes   Ta    Yes  \&.Dd July 21, 2007
 .It \&.Dq    Ta    Yes   Ta    Yes  .Ed
 .It \&.Pq    Ta    Yes   Ta    Yes  
 .It \&.Qq    Ta    Yes   Ta    Yes  
 .It \&.Sq    Ta    Yes   Ta    Yes  
 .It \&.Brq   Ta    Yes   Ta    Yes  
 .It \&.D1    Ta    \&No  Ta    \&Yes  
 .It \&.Dl    Ta    \&No  Ta    Yes  
 .It \&.Ql    Ta    Yes   Ta    Yes  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 The  See also
 .Sq \&.Op  .Sx \&Dt
 may be broken by  and
 .Sq \&.Oc  .Sx \&Os .
 as in the following example:  .
 .Bd -literal -offset XXXX  .Ss \&Dl
 \&.Oo  One-line intended display.  This is formatted as literal text and is
 \&.Op Fl a Oc  useful for commands and invocations.  It is followed by a newline.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Dl % mandoc mdoc.7 | less
 .Ed  .Ed
 .Pp  .Pp
 In the above example, the scope of  See also
 .Sq \&.Op  .Sx \&Bd
 is technically broken by  and
 .Sq \&.Oc ,  .Sx \&D1 .
 however, due to the overwhelming existence of this sequence, it's  .
 allowed.  .Ss \&Do
 .\" SUB-SECTION  Begins a block enclosed by double quotes.  Does not have any head
 .Ss Block partial-explicit  arguments.
 Each of these contains at least a body and, in limited circumstances, a  
 head  
 .Pq So \&.Fo Sc , So \&.Eo Sc  
 and/or tail  
 .Pq So \&.Ec Sc .  
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX  Examples:
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .Bd -literal -offset indent
 .It \&.Ao    Ta    Yes   Ta    Yes    Ta    closed by \&.Ac  \&.D1 Do April is the cruellest month Dc \e(em T.S. Eliot
 .It \&.Ac    Ta    Yes   Ta    Yes    Ta    opened by \&.Ao  .Ed
 .It \&.Bc    Ta    Yes   Ta    Yes    Ta    closed by \&.Bo  
 .It \&.Bo    Ta    Yes   Ta    Yes    Ta    opened by \&.Bc  
 .It \&.Pc    Ta    Yes   Ta    Yes    Ta    closed by \&.Po  
 .It \&.Po    Ta    Yes   Ta    Yes    Ta    opened by \&.Pc  
 .It \&.Do    Ta    Yes   Ta    Yes    Ta    closed by \&.Dc  
 .It \&.Dc    Ta    Yes   Ta    Yes    Ta    opened by \&.Do  
 .It \&.Xo    Ta    Yes   Ta    Yes    Ta    closed by \&.Xc  
 .It \&.Xc    Ta    Yes   Ta    Yes    Ta    opened by \&.Xo  
 .It \&.Bro   Ta    Yes   Ta    Yes    Ta    closed by \&.Brc  
 .It \&.Brc   Ta    Yes   Ta    Yes    Ta    opened by \&.Bro  
 .It \&.Oc    Ta    Yes   Ta    Yes    Ta    closed by \&.Oo  
 .It \&.Oo    Ta    Yes   Ta    Yes    Ta    opened by \&.Oc  
 .It \&.So    Ta    Yes   Ta    Yes    Ta    closed by \&.Sc  
 .It \&.Sc    Ta    Yes   Ta    Yes    Ta    opened by \&.So  
 .It \&.Fc    Ta    Yes   Ta    Yes    Ta    opened by \&.Fo  
 .It \&.Fo    Ta    \&No  Ta    \&No   Ta    closed by \&.Fc  
 .It \&.Ec    Ta    Yes   Ta    Yes    Ta    opened by \&.Eo  
 .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec  
 .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo  
 .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc  
 .It \&.Re    Ta    \&No  Ta    \&No   Ta    opened by \&.Rs  
 .It \&.Rs    Ta    \&No  Ta    \&No   Ta    closed by \&.Re  
 .El  
 .\" SUB-SECTION  
 .Ss In-line  
 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.  
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX  See also
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments  .Sx \&Dq .
 .It \&.Dd    Ta    \&No  Ta    \&No    Ta    >0  .
 .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n  .Ss \&Dq
 .It \&.Os    Ta    \&No  Ta    \&No    Ta    n  Encloses its arguments in double quotes.
 .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0  .Pp
 .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n  Examples:
 .It \&.An    Ta    \&No  Ta    Yes     Ta    n  .Bd -literal -offset indent
 .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n  \&.Dq April is the cruellest month
 .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0  \e(em T.S. Eliot
 .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n  .Ed
 .It \&.Dv    Ta    Yes   Ta    Yes     Ta    n  .Pp
 .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0  See also
 .It \&.Ev    Ta    Yes   Ta    Yes     Ta    n  .Sx \&Do .
 .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0  .
 .It \&.Fa    Ta    Yes   Ta    Yes     Ta    n  .Ss \&Dt
 .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0  Document title.  This is the mandatory second macro of any
 .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n  .Nm
 .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0  file.  Its calling syntax is as follows:
 .It \&.Ft    Ta    \&No  Ta    Yes     Ta    n  .Pp
 .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0  .D1 \. Ns Sx \&Dt Cm title section Op Cm volume | arch
 .It \&.In    Ta    \&No  Ta    \&No    Ta    n  .Pp
 .It \&.Li    Ta    Yes   Ta    Yes     Ta    n  Its arguments are as follows:
 .It \&.Nd    Ta    \&No  Ta    \&No    Ta    n  .Bl -tag -width Ds -offset Ds
 .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n  .It Cm title
 .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n  The document's title (name).  This should be capitalised and is
 .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n  required.
 .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0  .It Cm section
 .It \&.St    Ta    \&No  Ta    Yes     Ta    1  The manual section.  This may be one of
 .It \&.Va    Ta    Yes   Ta    Yes     Ta    n  .Ar 1
 .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0  .Pq utilities ,
 .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3  .Ar 2
 .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0  .Pq system calls ,
 .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0  .Ar 3
 .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0  .Pq libraries ,
 .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0  .Ar 3p
 .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0  .Pq Perl libraries ,
 .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0  .Ar 4
 .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0  .Pq devices ,
 .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0  .Ar 5
 .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0  .Pq file formats ,
 .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0  .Ar 6
 .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0  .Pq games ,
 .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0  .Ar 7
 .It \&.At    Ta    Yes   Ta    Yes     Ta    1  .Pq miscellaneous ,
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n  .Ar 8
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n  .Pq system utilities ,
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    1  .Ar 9
 .It \&.Em    Ta    Yes   Ta    Yes     Ta    n  .Pq kernel functions ,
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n  .Ar X11
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0  .Pq X Window System ,
 .It \&.No    Ta    Yes   Ta    Yes     Ta    0  .Ar X11R6
 .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0  .Pq X Window System ,
 .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n  .Ar unass
 .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n  .Pq unassociated ,
 .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1  .Ar local
 .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1  .Pq local system ,
 .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0  .Ar draft
 .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0  .Pq draft manual ,
 .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0  or
 .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n  .Ar paper
 .It \&.Dx    Ta    Yes   Ta    Yes     Ta    n  .Pq paper .
 .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0  It is also required and should correspond to the manual's filename
 .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n  suffix.
 .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n  .It Cm volume
 .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0  This overrides the volume inferred from
 .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1  .Ar section .
 .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0  This field is optional, and if specified, must be one of
 .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0  .Ar USD
 .It \&.Lk    Ta    \&No  Ta    Yes     Ta    >0  .Pq users' supplementary documents ,
 .It \&.Mt    Ta    \&No  Ta    Yes     Ta    >0  .Ar PS1
 .It \&.Es    Ta    \&No  Ta    \&No    Ta    0  .Pq programmers' supplementary documents ,
 .It \&.En    Ta    \&No  Ta    \&No    Ta    0  .Ar AMD
   .Pq administrators' supplementary documents ,
   .Ar SMM
   .Pq system managers' manuals ,
   .Ar URM
   .Pq users' reference manuals ,
   .Ar PRM
   .Pq programmers' reference manuals ,
   .Ar KM
   .Pq kernel manuals ,
   .Ar IND
   .Pq master index ,
   .Ar MMI
   .Pq master index ,
   .Ar LOCAL
   .Pq local manuals ,
   .Ar LOC
   .Pq local manuals ,
   or
   .Ar CON
   .Pq contributed manuals .
   .It Cm arch
   This specifies a specific relevant architecture.  If
   .Cm volume
   is not provided, it may be used in its place, else it may be used
   subsequent that.  It, too, is optional.  It must be one of
   .Ar alpha ,
   .Ar amd64 ,
   .Ar amiga ,
   .Ar arc ,
   .Ar arm ,
   .Ar armish ,
   .Ar aviion ,
   .Ar hp300 ,
   .Ar hppa ,
   .Ar hppa64 ,
   .Ar i386 ,
   .Ar landisk ,
   .Ar luna88k ,
   .Ar mac68k ,
   .Ar macppc ,
   .Ar mvme68k ,
   .Ar mvme88k ,
   .Ar mvmeppc ,
   .Ar pmax ,
   .Ar sgi ,
   .Ar socppc ,
   .Ar sparc ,
   .Ar sparc64 ,
   .Ar sun3 ,
   .Ar vax ,
   or
   .Ar zaurus .
 .El  .El
 .Pp  .Pp
 The  Examples:
 .Sq \&.Ot ,  .Bd -literal -offset indent
 .Sq \&.Fr ,  \&.Dt FOO 1
 .Sq \&.Es  \&.Dt FOO 4 KM
   \&.Dt FOO 9 i386
   \&.Dt FOO 9 KM i386
   .Ed
   .Pp
   See also
   .Sx \&Dd
 and  and
 .Sq \&.En ,  .Sx \&Os .
 macros are obsolete.  .
 .\" SECTION  .Ss \&Dv
   Defined variables such as preprocessor constants.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Dv BUFSIZ
   \&.Dv STDOUT_FILENO
   .Ed
   .Pp
   See also
   .Sx \&Er .
   .
   .Ss \&Dx
   Format the DragonFly BSD version provided as an argument, or a default
   value if no argument is provided.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Dx 2.4.1
   \&.Dx
   .Ed
   .Pp
   See also
   .Sx \&At ,
   .Sx \&Bsx ,
   .Sx \&Bx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .Ss \&Ec
   .Ss \&Ed
   .Ss \&Ef
   .Ss \&Ek
   .Ss \&El
   .Ss \&Em
   Denotes text that should be emphasised.  Note that this is a
   presentation term and should not be used for stylistically decorating
   technical terms.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Ed Warnings!
   \&.Ed Remarks :
   .Ed
   .
   .Ss \&En
   .Ss \&Eo
   .Ss \&Er
   Error constants (suggested for use only in section two manuals).
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Er EPERM
   \&.Er ENOENT
   .Ed
   .Pp
   See also
   .Sx \&Dv .
   .
   .Ss \&Es
   .
   .Ss \&Ev
   Environmental variables such as those specified in
   .Xr environ 7 .
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Ev DISPLAY
   \&.Ev PATH
   .Ed
   .
   .Ss \&Ex
   Inserts text regarding a utility's exit values.  This macro must have
   first the
   .Fl std
   argument specified, then an optional
   .Ar utility .
   If
   .Ar utility
   is not provided, the document's name as stipulated in
   .Sx \&Nm
   is provided.
   .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 \&Bsx ,
   .Sx \&Bx ,
   .Sx \&Dx ,
   .Sx \&Nx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .Ss \&Hf
   .Ss \&Ic
   .Ss \&In
   .Ss \&It
   .Ss \&Lb
   .Ss \&Li
   .Ss \&Lk
   Format a hyperlink.  The calling syntax is as follows:
   .Pp
   .D1 \. Ns Sx \&Lk Cm uri Op Cm name
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Lk http://bsd.lv "The BSD.lv Project"
   \&.Lk http://bsd.lv
   .Ed
   .Pp
   See also
   .Sx \&Mt .
   .
   .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 \&Bsx ,
   .Sx \&Bx ,
   .Sx \&Dx ,
   .Sx \&Fx ,
   .Sx \&Ox ,
   and
   .Sx \&Ux .
   .
   .Ss \&Oc
   .Ss \&Oo
   .Ss \&Op
   .Ss \&Os
   Document operating system version.  This is the mandatory third macro of
   any
   .Nm
   file.  Its calling syntax is as follows:
   .Pp
   .D1 \. Ns Sx \&Os Op Cm system
   .Pp
   The optional
   .Cm system
   parameter specifies the relevant operating system or environment.  Left
   unspecified, it defaults to the local operating system version.  This is
   the suggested form.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Os
   \&.Os KTH/CSC/TCS
   \&.Os BSD 4.3
   .Ed
   .Pp
   See also
   .Sx \&Dd
   and
   .Sx \&Dt .
   .
   .Ss \&Ot
   Unknown usage.
   .Pp
   .Em Remarks :
   this macro has been deprecated.
   .
   .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 \&Dx ,
   .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 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 \&Bsx ,
   .Sx \&Bx ,
   .Sx \&Dx ,
   .Sx \&Fx ,
   .Sx \&Nx ,
   and
   .Sx \&Ox .
   .
   .Ss \&Va
   .Ss \&Vt
   .Ss \&Xc
   .Ss \&Xo
   .Ss \&Xr
   .Ss \&br
   .Ss \&sp
   .
   .
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 The mdoc language was traditionally a  This section documents compatibility with other roff implementations, at
 .Qq roff  this time limited to
 macro package; most existing manuals were written with mdoc syntax  .Xr groff 1 .
 dictated by system-dependent roff installations.  This section documents  The term
 compatibility with these systems.  .Qq historic groff
   refers to those versions before the
   .Pa doc.tmac
   file re-write
   .Pq somewhere between 1.15 and 1.19 .
   .
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  
 .It  .It
 .Sq \&.Fo  .Xr groff 1
   behaves strangely (even between versions) when specifying
   .Sq \ef
   escapes within line-macro scopes.  These aberrations have been
   normalised.
   .It
   Negative scaling units are now truncated to zero instead of creating
   interesting conditions, such as with
   .Sx \&sp
   .Cm \-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  and
 .Sq \&.St  .Fl right
 historically weren't always callable.  Both are now correctly callable.  are aliases for
 .\" LIST-ITEM  .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  .It
 .Sq \&.It \-nested  Blocks of whitespace are stripped from both macro and free-form text
 is assumed for all lists: any list may be nested and  lines (except when in literal mode), while groff would retain whitespace
 .Sq \-enum  in free-form text lines.
 lists will restart the sequence only for the sub-list.  
 .\" LIST-ITEM  
 .It  .It
 .Sq \&.It \-column  Historic groff has many un-callable macros.  Most of these (excluding
 syntax where column widths may be preceeded by other arguments (instead  some block-level macros) are now callable, conforming to the
 of proceeded) is not supported.  non-historic groff version.
 .\" LIST-ITEM  
 .It  .It
 The  The vertical bar
 .Sq \&.At  .Sq \(ba
 macro only accepts a single parameter.  made historic groff
 .\" LIST-ITEM  .Qq go orbital
   but is a proper delimiter in this implementation.
 .It  .It
 The system-name macros (  .Sx \&It
 .Ns Sq \&.At ,  .Fl nested
 .Sq \&.Bsx ,  is assumed for all lists (it wasn't in historic groff): any list may be
 .Sq \&.Bx ,  nested and
 .Sq \&.Fx ,  .Fl enum
 .Sq \&.Nx ,  lists will restart the sequence only for the sub-list.
 .Sq \&.Ox ,  
 and  
 .Sq \&.Ux )  
 are callable.  
 .\" LIST-ITEM  
 .It  .It
 Some manuals use  Some manuals use
 .Sq \&.Li  .Sx \&Li
 incorrectly by following it with a reserved character and expecting the  incorrectly by following it with a reserved character and expecting the
 delimiter to render.  This is not supported.  delimiter to render.  This is not supported.
 .\" LIST-ITEM  
 .It  .It
 .Sq \&.Cd  In groff, the
 is callable.  .Sx \&Fo
   macro only produces the first parameter.  This is no longer the case.
 .El  .El
 .\" SECTION  .
   .
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1  .Xr mandoc 1 ,
 .\" SECTION  .Xr mandoc_char 7
   .
   .
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .\"
 .Sh CAVEATS  .\" XXX: this really isn't the place for these caveats.
 There are several ambiguous parts of mdoc.  .\" .
 .Pp  .\" .
 .Bl -dash -compact  .\" .Sh CAVEATS
 .\" LIST-ITEM  .\" There are many ambiguous parts of mdoc.
 .It  .\" .
 .Sq \&.Fa  .\" .Pp
 should be  .\" .Bl -dash -compact
 .Sq \&.Va  .\" .It
 as function arguments are variables.  .\" .Sq \&Fa
 .\" LIST-ITEM  .\" should be
 .It  .\" .Sq \&Va
 .Sq \&.Ft  .\" as function arguments are variables.
 should be  .\" .It
 .Sq \&.Vt  .\" .Sq \&Ft
 as function return types are still types.  Furthermore, the  .\" should be
 .Sq \&.Ft  .\" .Sq \&Vt
 should be removed and  .\" as function return types are still types.  Furthermore, the
 .Sq \&.Fo ,  .\" .Sq \&Ft
 which ostensibly follows it, should follow the same convention as  .\" should be removed and
 .Sq \&.Va .  .\" .Sq \&Fo ,
 .\" LIST-ITEM  .\" which ostensibly follows it, should follow the same convention as
 .It  .\" .Sq \&Va .
 .Sq \&.Va  .\" .It
 should formalise that only one or two arguments are acceptable: a  .\" .Sq \&Va
 variable name and optional, preceeding type.  .\" should formalise that only one or two arguments are acceptable: a
 .\" LIST-ITEM  .\" variable name and optional, preceding type.
 .It  .\" .It
 .Sq \&.Fd  .\" .Sq \&Fd
 is ambiguous.  It's commonly used to indicate an include file in the  .\" is ambiguous.  It's commonly used to indicate an include file in the
 synopsis section.  .\" synopsis section.
 .Sq \&.In  .\" .Sq \&In
 should be used, instead.  .\" should be used, instead.
 .\" LIST-ITEM  .\" .It
 .It  .\" Only the
 Only the  .\" .Sq \-literal
 .Sq \-literal  .\" argument to
 argument to  .\" .Sq \&Bd
 .Sq \&.Bd  .\" makes sense.  The remaining ones should be removed.
 makes sense.  The remaining ones should be removed.  .\" .It
 .\" LIST-ITEM  .\" The
 .It  .\" .Sq \&Xo
 The  .\" and
 .Sq \&.Xo  .\" .Sq \&Xc
 and  .\" macros should be deprecated.
 .Sq \&.Xc  .\" .It
 macros should be deprecated.  .\" The
 .\" LIST-ITEM  .\" .Sq \&Dt
 .It  .\" macro lacks clarity.  It should be absolutely clear which title will
 The  .\" render when formatting the manual page.
 .Sq \&.Dt  .\" .It
 macro lacks clarity.  It should be absolutely clear which title will  .\" A
 render when formatting the manual page.  .\" .Sq \&Lx
 .\" LIST-ITEM  .\" should be provided for Linux (\(`a la
 .It  .\" .Sq \&Ox ,
 A  .\" .Sq \&Nx
 .Sq \&.Lx  .\" etc.).
 should be provided for Linux (\(`a la  .\" .It
 .Sq \&.Ox ,  .\" There's no way to refer to references in
 .Sq \&.Nx  .\" .Sq \&Rs/Re
 etc.).  .\" blocks.
 .\" LIST-ITEM  .\" .It
 .It  .\" The \-split and \-nosplit dictates via
 There's no way to refer to references in  .\" .Sq \&An
 .Sq \&.Rs/.Re  .\" are re-set when entering and leaving the AUTHORS section.
 blocks.  .\" .El
 .El  .\" .
Legend:
Removed from v.1.16  
changed lines
  Added in v.1.78
CVSweb