Noticed that our skeleton mdoc.7 had lower-case `Dt'. Fixed and added

[mandoc.git] / mdoc.7

diff --git a/mdoc.7 b/mdoc.7
index 6c00e540110b40ec634db05cb765f3f0d84abfc7..5bd8aa109fd7c8ede9bdfbba123cde6d62e3e2fc 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,6 +1,7 @@
-.\"    $Id: mdoc.7,v 1.65 2009/10/19 11:02:23 kristaps Exp $
+.\"    $Id: mdoc.7,v 1.188 2011/05/26 09:26:16 kristaps Exp $

 .\"
 .\"

-.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -14,69 +15,64 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: October 19 2009 $
+.Dd $Mdocdate: May 26 2011 $

 .Dt MDOC 7
 .Os
 .Dt MDOC 7
 .Os

-.
-.

 .Sh NAME
 .Nm mdoc
 .Nd mdoc language reference
 .Sh NAME
 .Nm mdoc
 .Nd mdoc language reference

-.
-.

 .Sh DESCRIPTION
 The
 .Nm mdoc
 language is used to format
 .Bx
 .Ux
 .Sh DESCRIPTION
 The
 .Nm mdoc
 language is used to format
 .Bx
 .Ux

-manuals.  In this reference document, we describe its syntax, structure,
-and usage.  Our reference implementation is
-.Xr mandoc 1 .
-The
+manuals.
+This reference document describes its syntax, structure, and
+usage.
+The reference implementation is
+.Xr mandoc 1 ;
+the

 .Sx COMPATIBILITY
 .Sx COMPATIBILITY

-section describes compatibility with
-.Xr groff 1 .
-.
+section describes compatibility with other troff \-mdoc implementations.

 .Pp
 An
 .Nm
 .Pp
 An
 .Nm

-document follows simple rules:  lines beginning with the control
+document follows simple rules: lines beginning with the control

 character
 character

-.Sq \.
-are parsed for macros.  Other lines are interpreted within the scope of
-prior macros:
+.Sq \&.
+are parsed for macros.
+Text lines, those not beginning with the control character, are
+interpreted within the scope of prior macros:

 .Bd -literal -offset indent
 \&.Sh Macro lines change control state.
 .Bd -literal -offset indent
 \&.Sh Macro lines change control state.

-Other lines are interpreted within the current state.
+Text lines are interpreted within the current state.

 .Ed
 .Ed

-.
-.

 .Sh LANGUAGE SYNTAX
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the space
 .Sh LANGUAGE SYNTAX
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the space

-character, and, in certain circumstances, the tab character.  All
-manuals must have
-.Ux
-line terminators.
-.
-.
+character, and, in certain circumstances, the tab character.
+.Pp
+If the first character of a text line is a space, that line is printed
+with a leading newline.

 .Ss Comments
 Text following a
 .Ss Comments
 Text following a

-.Sq \e" ,
-whether in a macro or free-form text line, is ignored to the end of
-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:
+.Sq \e\*q ,
+whether in a macro or text line, is ignored to the end of
+line.
+A macro line with only a control character and comment escape,
+.Sq \&.\e\*q ,
+is also ignored.
+Macro lines with only a control character and optional whitespace are
+stripped from input.
+.Ss Reserved Terms
+Within a macro line, the following terms are reserved:

 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It \&.
 .Pq period
 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It \&.
 .Pq period

+.It \e.
+.Pq escaped period

 .It \&,
 .Pq comma
 .It \&:
 .It \&,
 .Pq comma
 .It \&:


@@ -97,19 +93,16 @@ Within a macro line, the following characters are reserved:
 .Pq exclamation
 .It \&|
 .Pq vertical bar
 .Pq exclamation
 .It \&|
 .Pq vertical bar

+.It \e*(Ba
+.Pq reserved-word vertical bar

 .El
 .El

-.

 .Pp
 .Pp

-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&
-or, if applicable, an appropriate escape sequence used.
-.
-.
+For general use in macro lines, these can be escaped with a non-breaking
+space
+.Pq Sq \e& .
+In text lines, these may be used as normal punctuation.

 .Ss Special Characters
 .Ss Special Characters

-Special characters may occur in both macro and free-form lines.
+Special characters may occur in both macro and text lines.

 Sequences begin with the escape character
 .Sq \e
 followed by either an open-parenthesis
 Sequences begin with the escape character
 .Sq \e
 followed by either an open-parenthesis


@@ -118,33 +111,49 @@ for two-character sequences; an open-bracket
 .Sq \&[
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;
 .Sq \&[
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;

-or a single one-character sequence.  See
+or a single one character sequence.
+See

 .Xr mandoc_char 7
 .Xr mandoc_char 7

-for a complete list.  Examples include
+for a complete list.
+Examples include

 .Sq \e(em
 .Pq em-dash
 and
 .Sq \ee
 .Pq back-slash .
 .Sq \e(em
 .Pq em-dash
 and
 .Sq \ee
 .Pq back-slash .

-.
-.

 .Ss Text Decoration
 Terms may be text-decorated using the
 .Sq \ef
 .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 
+escape followed by an indicator: B (bold), I (italic), R (Roman), or P
+(revert to previous mode):
+.Pp
+.Dl \efBbold\efR \efIitalic\efP
+.Pp
+A numerical representation 3, 2, or 1 (bold, italic, and Roman,
+respectively) may be used instead.
+If a macro opens a font scope after calling
+.Sq \ef ,
+such as with
+.Sx \&Bf ,
+the
+.Sq \ef
+mode will be restored upon exiting the
+.Sx \&Bf
+scope.
+.Pp
+Note this form is
+.Em not
+recommended for

 .Nm ,
 .Nm ,

-which encourages semantic, not presentation, annotation.
-.
-.
+which encourages semantic annotation.

 .Ss Predefined Strings
 .Ss Predefined Strings

-Historically, 
-.Xr groff 1
-also defined a set of package-specific 
+Historically,
+troff
+also defined a set of package-specific

 .Dq predefined strings ,
 .Dq predefined strings ,

-which, like 
+which, like

 .Sx Special Characters ,
 .Sx Special Characters ,

-demark special output characters and strings by way of input codes.
+mark special output characters and strings by way of input codes.

 Predefined strings are escaped with the slash-asterisk,
 .Sq \e* :
 single-character
 Predefined strings are escaped with the slash-asterisk,
 .Sq \e* :
 single-character


@@ -155,76 +164,50 @@ and N-character
 .Sq \e*[N] .
 See
 .Xr mandoc_char 7
 .Sq \e*[N] .
 See
 .Xr mandoc_char 7

-for a complete list.  Examples include
+for a complete list.
+Examples include

 .Sq \e*(Am
 .Pq ampersand
 and
 .Sq \e*(Ba
 .Pq vertical bar .
 .Sq \e*(Am
 .Pq ampersand
 and
 .Sq \e*(Ba
 .Pq vertical bar .

-.
-.

 .Ss Whitespace
 .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
-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.
-.
-.
+Whitespace consists of the space character.
+In text lines, whitespace is preserved within a line; unescaped
+trailing spaces are stripped from input (unless in a literal context).
+Blank text lines, which may include whitespace, are only permitted
+within literal contexts.
+.Pp
+In macro lines, whitespace delimits arguments and is discarded.
+If arguments are quoted, whitespace within the quotes is retained.

 .Ss Quotation
 .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 :
+Macro arguments may be quoted with double-quotes 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 pairwise adjacent to another double-quote
+terminates the literal, regardless of surrounding whitespace.
+.Pp
+Note that any quoted text, even if it would cause a macro invocation
+when unquoted, is considered literal text.
+Thus, the following produces
+.Sq Op "Fl a" :

 .Bd -literal -offset indent
 .Bd -literal -offset indent

-\&.Em "Em a"
+\&.Op "Fl a"

 .Ed
 .Ed

-.

 .Pp
 .Pp

-In free-form mode, quotes are regarded as opaque text.
-.
-.Ss Dates
-TODO.
-.
+In text lines, quotes are regarded as opaque text.

 .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
 .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.
 .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:
+Negative numbers, while accepted, are truncated to zero.
+The following scaling units are accepted:

 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It c
 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It c


@@ -262,55 +245,91 @@ Using anything other than
 .Sq u ,
 or
 .Sq v
 .Sq u ,
 or
 .Sq v

-is necessarily non-portable across output media.  See
+is necessarily non-portable across output media.
+See

 .Sx COMPATIBILITY .
 .Sx COMPATIBILITY .

-.
-.
+.Ss Sentence Spacing
+When composing a manual, make sure that sentences end at the end of
+a line.
+By doing so, front-ends will be able to apply the proper amount of
+spacing after the end of sentence (unescaped) period, exclamation mark,
+or question mark followed by zero or more non-sentence closing
+delimiters
+.Po
+.Sq \&) ,
+.Sq \&] ,
+.Sq \&' ,
+.Sq \&"
+.Pc .
+.Pp
+The proper spacing is also intelligently preserved if a sentence ends at
+the boundary of a macro line.
+For example:
+.Pp
+.Dl \&.Xr mandoc 1 \&.
+.Dl \&.Fl T \&Ns \&Cm ascii \&.

 .Sh MANUAL STRUCTURE
 .Sh MANUAL STRUCTURE

-Each
+A well-formed

 .Nm
 .Nm

-document must begin with a document prologue, containing, in order,
+document consists of a document prologue followed by one or more
+sections.
+.Pp
+The prologue, which consists of the

 .Sx \&Dd ,
 .Sx \&Dt ,
 and
 .Sx \&Dd ,
 .Sx \&Dt ,
 and

-.Sx \&Os ,
-then the NAME section containing at least one
+.Sx \&Os
+macros in that order, 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 \&Nm
 followed by

-.Sx \&Nd :
+.Sx \&Nd .
+.Pp
+Following that, convention dictates specifying at least the
+.Em SYNOPSIS
+and
+.Em DESCRIPTION
+sections, although this varies between manual sections.
+.Pp
+The following is a well-formed skeleton
+.Nm
+file for a utility
+.Qq progname :

 .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$
 .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$

-\&.Dt mdoc 7
+\&.Dt PROGNAME section

 \&.Os
 \&.Os

-\&.

 \&.Sh NAME
 \&.Sh NAME

-\&.Nm foo
+\&.Nm progname

 \&.Nd a description goes here
 \&.Nd a description goes here

-\&.\e\*q The next is for sections 2 & 3 only.

 \&.\e\*q .Sh LIBRARY
 \&.\e\*q .Sh LIBRARY

-\&.
+\&.\e\*q For sections 2, 3, & 9 only.
+\&.\e\*q Not used in OpenBSD.

 \&.Sh SYNOPSIS
 \&.Sh SYNOPSIS

-\&.Nm foo
+\&.Nm progname

 \&.Op Fl options
 \&.Ar
 \&.Op Fl options
 \&.Ar

-\&.

 \&.Sh DESCRIPTION
 The
 \&.Nm
 utility processes files ...
 \&.\e\*q .Sh IMPLEMENTATION NOTES
 \&.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 Not used in OpenBSD.

 \&.\e\*q .Sh RETURN VALUES
 \&.\e\*q .Sh RETURN VALUES

-\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q For sections 2, 3, & 9 only.

 \&.\e\*q .Sh ENVIRONMENT
 \&.\e\*q .Sh ENVIRONMENT

+\&.\e\*q For sections 1, 6, 7, & 8 only.

 \&.\e\*q .Sh FILES
 \&.\e\*q .Sh FILES

+\&.\e\*q .Sh EXIT STATUS
+\&.\e\*q For sections 1, 6, & 8 only.

 \&.\e\*q .Sh EXAMPLES
 \&.\e\*q .Sh EXAMPLES

-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.

 \&.\e\*q .Sh DIAGNOSTICS
 \&.\e\*q .Sh DIAGNOSTICS

-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q For sections 1, 4, 6, 7, & 8 only.

 \&.\e\*q .Sh ERRORS
 \&.\e\*q .Sh ERRORS

+\&.\e\*q For sections 2, 3, & 9 only.

 \&.\e\*q .Sh SEE ALSO
 \&.\e\*q .Xr foobar 1
 \&.\e\*q .Sh STANDARDS
 \&.\e\*q .Sh SEE ALSO
 \&.\e\*q .Xr foobar 1
 \&.\e\*q .Sh STANDARDS


@@ -319,27 +338,255 @@ utility processes files ...
 \&.\e\*q .Sh CAVEATS
 \&.\e\*q .Sh BUGS
 \&.\e\*q .Sh SECURITY CONSIDERATIONS
 \&.\e\*q .Sh CAVEATS
 \&.\e\*q .Sh BUGS
 \&.\e\*q .Sh SECURITY CONSIDERATIONS

+\&.\e\*q Not used in OpenBSD.
+.Ed
+.Pp
+The sections in an
+.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 one line description of the documented material.
+The syntax for this as follows:
+.Bd -literal -offset indent
+\&.Nm name0 ,
+\&.Nm name1 ,
+\&.Nm name2
+\&.Nd a one line description
+.Ed
+.Pp
+Multiple
+.Sq \&Nm
+names should be separated by commas.
+.Pp
+The
+.Sx \&Nm
+macro(s) must precede the
+.Sx \&Nd
+macro.
+.Pp
+See
+.Sx \&Nm
+and
+.Sx \&Nd .
+.It Em LIBRARY
+The name of the library containing the documented material, which is
+assumed to be a function in a section 2, 3, or 9 manual.
+The syntax for this is as follows:
+.Bd -literal -offset indent
+\&.Lb libarm
+.Ed
+.Pp
+See
+.Sx \&Lb .
+.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 bar
+\&.Op Fl v
+\&.Op Fl o Ar file
+\&.Op Ar
+\&.Nm foo
+\&.Op Fl v
+\&.Op Fl o Ar file
+\&.Op Ar
+.Ed
+.Pp
+Commands should be ordered alphabetically.
+.Pp
+For the second, function calls (sections 2, 3, 9):
+.Bd -literal -offset indent
+\&.In header.h
+\&.Vt extern const char *global;
+\&.Ft "char *"
+\&.Fn foo "const char *src"
+\&.Ft "char *"
+\&.Fn bar "const char *src"
+.Ed
+.Pp
+Ordering of
+.Sx \&In ,
+.Sx \&Vt ,
+.Sx \&Fn ,
+and
+.Sx \&Fo
+macros should follow C header-file conventions.
+.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 .
+.Pp
+Some macros are displayed differently in the
+.Em SYNOPSIS
+section, particularly
+.Sx \&Nm ,
+.Sx \&Cd ,
+.Sx \&Fd ,
+.Sx \&Fn ,
+.Sx \&Fo ,
+.Sx \&In ,
+.Sx \&Vt ,
+and
+.Sx \&Ft .
+All of these macros are output on their own line.
+If two such dissimilar macros are pairwise invoked (except for
+.Sx \&Ft
+before
+.Sx \&Fo
+or
+.Sx \&Fn ) ,
+they are separated by a vertical space, unless in the case of
+.Sx \&Fo ,
+.Sx \&Fn ,
+and
+.Sx \&Ft ,
+which are always separated by vertical space.
+.Pp
+When text and macros following an
+.Sx \&Nm
+macro starting an input line span multiple output lines,
+all output lines but the first will be indented to align
+with the text immediately following the
+.Sx \&Nm
+macro, up to the next
+.Sx \&Nm ,
+.Sx \&Sh ,
+or
+.Sx \&Ss
+macro or the end of an enclosing block, whichever comes first.
+.It Em DESCRIPTION
+This begins with an expansion of the brief, one line description in
+.Em NAME :
+.Bd -literal -offset indent
+The
+\&.Nm
+utility does this, that, and the other.
+.Ed
+.Pp
+It usually follows with a breakdown 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
 .Ed

-.

 .Pp
 .Pp

-Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
-but non-compulsory.
-.
-.
+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 RETURN VALUES
+This section documents the
+return values of functions in sections 2, 3, and 9.
+.Pp
+See
+.Sx \&Rv .
+.It Em ENVIRONMENT
+Lists the environment variables used by the utility,
+and explains the syntax and semantics of their values.
+The
+.Xr environ 7
+manual provides examples of typical content and formatting.
+.Pp
+See
+.Sx \&Ev .
+.It Em FILES
+Documents files used.
+It's helpful to document both the file name and a short description of how
+the file is used (created, modified, etc.).
+.Pp
+See
+.Sx \&Pa .
+.It Em EXIT STATUS
+This section documents the
+command exit status for section 1, 6, and 8 utilities.
+Historically, this information was described in
+.Em DIAGNOSTICS ,
+a practise that is now discouraged.
+.Pp
+See
+.Sx \&Ex .
+.It Em EXAMPLES
+Example usages.
+This often contains snippets of well-formed, well-tested invocations.
+Make sure that 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
+.Fl 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
+A brief history of the subject, including where support first appeared.
+.It Em AUTHORS
+Credits to the person or persons who wrote the code and/or documentation.
+Authors should generally be noted by both name and email address.
+.Pp
+See
+.Sx \&An .
+.It Em CAVEATS
+Common misuses and misunderstandings should be explained
+in this section.
+.It Em BUGS
+Known bugs, limitations, and work-arounds should be described
+in this section.
+.It Em SECURITY CONSIDERATIONS
+Documents any security precautions that operators should consider.
+.El

 .Sh MACRO SYNTAX
 Macros are one to three three characters in length and begin with a
 .Sh MACRO SYNTAX
 Macros are one to three three characters in length and begin with a

-control character ,
+control character,

 .Sq \&. ,
 .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:
+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
 .Bd -literal -offset indent
 \&.Pp
 \&.\ \ \ \&Pp
 .Ed

-.

 .Pp
 .Pp

-The syntax of a macro depends on its classification.  In this section,
+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
 .Sq \-arg
 refers to macro arguments, which may be followed by zero or more
 .Sq parm


@@ -348,44 +595,44 @@ parameters;
 opens the scope of a macro; and if specified,
 .Sq \&Yc
 closes it out.
 opens the scope of a macro; and if specified,
 .Sq \&Yc
 closes it out.

-.

 .Pp
 The
 .Em Callable
 .Pp
 The
 .Em Callable

-column indicates that the macro may be called subsequent to the initial
-line-macro.  If a macro is not callable, then its invocation after the
-initial line macro is interpreted as opaque text, such that
+column indicates that the macro may also be called by passing its name
+as an argument to another macro.
+If a macro is not callable but its name appears as an argument
+to another macro, it is interpreted as opaque text.
+For example,

 .Sq \&.Fl \&Sh
 produces
 .Sq Fl \&Sh .
 .Sq \&.Fl \&Sh
 produces
 .Sq Fl \&Sh .

-.

 .Pp
 The
 .Pp
 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.
-.
+.Em Parsed
+column indicates whether the macro may call other macros by receiving
+their names as arguments.
+If a macro is not parsed but the name of another macro appears
+as an argument, it is interpreted as opaque text.

 .Pp
 The
 .Em Scope
 column, if applicable, describes closure rules.
 .Pp
 The
 .Em Scope
 column, if applicable, describes closure rules.

-.
-.

 .Ss Block full-explicit
 .Ss Block full-explicit

-Multi-line scope closed by an explicit closing macro.  All macros
-contains bodies; only
+Multi-line scope closed by an explicit closing macro.
+All macros contains bodies; only

 .Sx \&Bf
 .Sx \&Bf

-contains a head.
+and
+.Pq optionally
+.Sx \&Bl
+contain a head.

 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB
 \&.Yc
 .Ed
 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB
 \&.Yc
 .Ed

-.

 .Pp
 .Pp

-.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
+.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX"
+.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope

 .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
 .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
 .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
 .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
 .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
 .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek


@@ -395,8 +642,6 @@ contains a head.
 .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk
 .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl
 .El
 .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk
 .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl
 .El

-.
-.

 .Ss Block full-implicit
 Multi-line scope closed by end-of-file or implicitly by another macro.
 All macros have bodies; some
 .Ss Block full-implicit
 Multi-line scope closed by end-of-file or implicitly by another macro.
 All macros have bodies; some


@@ -409,27 +654,37 @@ All macros have bodies; some
 .Pc
 don't have heads; only one
 .Po
 .Pc
 don't have heads; only one
 .Po

-.Sx \&It Fl column
-.Pc 
+.Sx \&It
+in
+.Sx \&Bl Fl column
+.Pc

 has multiple heads.
 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
 \(lBbody...\(rB
 .Ed
 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 -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
+.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX"
+.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope

 .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
 .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
 .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh

+.It Sx \&Nm  Ta    \&No     Ta  Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss

 .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
 .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

-.
-.
+.Pp
+Note that the
+.Sx \&Nm
+macro is a
+.Sx Block full-implicit
+macro only when invoked as the first macro
+in a
+.Em SYNOPSIS
+section line, else it is
+.Sx In-line .

 .Ss Block partial-explicit
 .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
+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
 .Po
 .Sx \&Fo ,
 .Sx \&Eo


@@ -444,10 +699,9 @@ and/or tail
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
 \(lBbody...\(rB \&Yc \(lBtail...\(rB
 .Ed
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
 \(lBbody...\(rB \&Yc \(lBtail...\(rB
 .Ed

-.

 .Pp
 .Pp

-.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
+.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent
+.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope

 .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
 .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
 .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
 .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
 .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
 .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo


@@ -473,19 +727,16 @@ and/or tail
 .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
 .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo
 .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc
 .El

-.
-.

 .Ss Block partial-implicit
 Like block full-implicit, but with single-line scope closed by
 .Ss Block partial-implicit
 Like block full-implicit, but with single-line scope closed by

-.Sx Reserved Characters
+.Sx Reserved Terms

 or end of line.
 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
 .Ed
 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 indent
-.It Em Macro Ta Em Callable Ta Em Parsable
+.Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent
+.It Em Macro Ta Em Callable Ta Em Parsed

 .It Sx \&Aq  Ta    Yes      Ta    Yes
 .It Sx \&Bq  Ta    Yes      Ta    Yes
 .It Sx \&Brq Ta    Yes      Ta    Yes
 .It Sx \&Aq  Ta    Yes      Ta    Yes
 .It Sx \&Bq  Ta    Yes      Ta    Yes
 .It Sx \&Brq Ta    Yes      Ta    Yes


@@ -497,28 +748,36 @@ or end of line.
 .It Sx \&Ql  Ta    Yes      Ta    Yes
 .It Sx \&Qq  Ta    Yes      Ta    Yes
 .It Sx \&Sq  Ta    Yes      Ta    Yes
 .It Sx \&Ql  Ta    Yes      Ta    Yes
 .It Sx \&Qq  Ta    Yes      Ta    Yes
 .It Sx \&Sq  Ta    Yes      Ta    Yes

+.It Sx \&Vt  Ta    Yes      Ta    Yes

 .El
 .El

-.
-.
+.Pp
+Note that the
+.Sx \&Vt
+macro is a
+.Sx Block partial-implicit
+only when invoked as the first macro
+in a
+.Em SYNOPSIS
+section line, else it is
+.Sx In-line .

 .Ss In-line
 Closed by
 .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
+.Sx Reserved Terms ,
+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
 .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 \(lBres...\(rB

 
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
 
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
 .Ed
 
 \&.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" "Arguments" -compact -offset indent
-.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
+.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent
+.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments

 .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0


@@ -528,11 +787,13 @@ then the macro accepts an arbitrary number of arguments.
 .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0

+.It Sx \&%Q  Ta    \&No     Ta    \&No     Ta    >0

 .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0

+.It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0

 .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0

-.It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    n
-.It Sx \&An  Ta    Yes      Ta    Yes      Ta    n
+.It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    >0
+.It Sx \&An  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0
 .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1
 .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0
 .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1


@@ -540,31 +801,31 @@ then the macro accepts an arbitrary number of arguments.
 .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0

-.It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    n
+.It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1

-.It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    >0
+.It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n

 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n

-.It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n
+.It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&En  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Es  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&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 \&Ev  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n

-.It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    n
+.It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Fr  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&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 \&Ft  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&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 \&In  Ta    \&No     Ta    \&No     Ta    1

 .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1
 .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 \&Li  Ta    Yes      Ta    Yes      Ta    >0
+.It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&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


@@ -576,7 +837,7 @@ then the macro accepts an arbitrary number of arguments.
 .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 \&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 \&Pf  Ta    Yes      Ta    Yes      Ta    1

 .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&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


@@ -588,173 +849,149 @@ then the macro accepts an arbitrary number of arguments.
 .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 \&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 \&Xr  Ta    Yes      Ta    Yes      Ta    >0

 .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1

-.El   
-.
-.
+.El

 .Sh REFERENCE
 This section is a canonical reference of all macros, arranged
 .Sh REFERENCE
 This section is a canonical reference of all macros, arranged

-alphabetically.  For the scoping of individual macros, see
+alphabetically.
+For the scoping of individual macros, see

 .Sx MACRO SYNTAX .
 .Sx MACRO SYNTAX .

-.

 .Ss \&%A
 Author name of an
 .Sx \&Rs
 .Ss \&%A
 Author name of an
 .Sx \&Rs

-block.  Multiple authors should each be accorded their own
+block.
+Multiple authors should each be accorded their own

 .Sx \%%A
 line.
 .Sx \%%A
 line.

-.Pp

 Author names should be ordered with full or abbreviated forename(s)
 first, then full surname.
 Author names should be ordered with full or abbreviated forename(s)
 first, then full surname.

-.

 .Ss \&%B
 Book title of an
 .Sx \&Rs
 .Ss \&%B
 Book title of an
 .Sx \&Rs

-block.  This macro may also be used in a non-bibliographic context when
+block.
+This macro may also be used in a non-bibliographic context when

 referring to book titles.
 referring to book titles.

-.

 .Ss \&%C
 Publication city or location of an
 .Sx \&Rs
 block.
 .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
 .Ss \&%D
 Publication date of an
 .Sx \&Rs

-block.  This should follow the canonical syntax for 
-.Sx Dates .
-.
+block.
+Recommended formats of arguments are
+.Ar month day , year
+or just
+.Ar year .

 .Ss \&%I
 Publisher or issuer name of an
 .Sx \&Rs
 block.
 .Ss \&%I
 Publisher or issuer name of an
 .Sx \&Rs
 block.

-.

 .Ss \&%J
 Journal 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 \&%N
 Issue number (usually for journals) of an
 .Sx \&Rs
 block.

-.

 .Ss \&%O
 Optional information 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 \&%P
 Book or journal page number of an
 .Sx \&Rs
 block.

-.

 .Ss \&%Q
 Institutional author (school, government, etc.) of an
 .Sx \&Rs
 .Ss \&%Q
 Institutional author (school, government, etc.) of an
 .Sx \&Rs

-block.  Multiple institutional authors should each be accorded their own
+block.
+Multiple institutional authors should each be accorded their own

 .Sx \&%Q
 line.
 .Sx \&%Q
 line.

-.

 .Ss \&%R
 Technical report name of an
 .Sx \&Rs
 block.
 .Ss \&%R
 Technical report name of an
 .Sx \&Rs
 block.

-.

 .Ss \&%T
 Article title of an
 .Sx \&Rs
 .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.
-.
+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 \&%V
 Volume number of an
 .Sx \&Rs
 block.

-.

 .Ss \&Ac
 .Ss \&Ac

-Closes an
+Close an

 .Sx \&Ao
 .Sx \&Ao

-block.  Does not have any tail arguments.
-.
+block.
+Does not have any tail arguments.

 .Ss \&Ad
 .Ss \&Ad

-Address construct: usually in the context of an computational address in
-memory, not a physical (post) address.
+Memory address.
+Do not use this for postal addresses.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Ad [0,$]
-\&.Ad 0x00000000
-.Ed
-.
+.Dl \&.Ad [0,$]
+.Dl \&.Ad 0x00000000

 .Ss \&An
 .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
+Author name.
+Requires either the name of an author or one of the following arguments:
+.Pp
+.Bl -tag -width "-nosplitX" -offset indent -compact

 .It Fl split
 .It Fl split

-Renders a line break is rendered before each author listing.
+Start a new output line before each subsequent invocation of
+.Sx \&An .

 .It Fl nosplit
 The opposite of
 .Fl split .
 .El
 .Pp
 .It Fl nosplit
 The opposite of
 .Fl split .
 .El
 .Pp

-In the AUTHORS section, the default is not to split the first author
-listing, but all subsequent author listings, whether or not they're
-interspersed by other macros or text, are split.  Thus, specifying
+The default is
+.Fl nosplit .
+The effect of selecting either of the

 .Fl split
 .Fl split

-will cause the first listing also to be split.  If not in the AUTHORS
-section, the default is not to split.
+modes ends at the beginning of the
+.Em AUTHORS
+section.
+In the
+.Em AUTHORS
+section, the default is
+.Fl nosplit
+for the first author listing and
+.Fl split
+for all other author listings.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.An -nosplit
-\&.An J. E. Hopcraft ,
-\&.An J. D. Ullman .
-.Ed
-.Pp
-.Em Remarks :
-the effects of
-.Fl split
-or
-.Fl nosplit
-are re-set when entering the AUTHORS section, so if one specifies
-.Sx \&An Fl nosplit
-in the general document body, it must be re-specified in the AUTHORS
-section.
-.
+.Dl \&.An -nosplit
+.Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv

 .Ss \&Ao
 .Ss \&Ao

-Begins a block enclosed by angled brackets.  Does not have any head
-arguments.
+Begin a block enclosed by angle brackets.
+Does not have any head arguments.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Fl -key= Ns Ao Ar val Ac
-.Ed
+.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac

 .Pp
 See also
 .Sx \&Aq .
 .Pp
 See also
 .Sx \&Aq .

-.

 .Ss \&Ap
 .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
-.
+Inserts an apostrophe without any surrounding whitespace.
+This is generally used as a grammatical device when referring to the verb
+form of a function.
+.Pp
+Examples:
+.Dl \&.Fn execve \&Ap d

 .Ss \&Aq
 .Ss \&Aq

-Encloses its arguments in angled brackets.  
+Encloses its arguments in angle brackets.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Fl -key= Ns Aq Ar val
-.Ed
+.Dl \&.Fl -key= \&Ns \&Aq \&Ar val

 .Pp
 .Em Remarks :
 this macro is often abused for rendering URIs, which should instead use
 .Pp
 .Em Remarks :
 this macro is often abused for rendering URIs, which should instead use


@@ -768,150 +1005,338 @@ statements, which should use
 .Pp
 See also
 .Sx \&Ao .
 .Pp
 See also
 .Sx \&Ao .

-.

 .Ss \&Ar
 .Ss \&Ar

-Command arguments.  If an argument is not provided, the strings
-.Dq file ...
-are used as a default.
+Command arguments.
+If an argument is not provided, the string
+.Dq file ...\&
+is used as a default.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Fl o Ns Ar file1
-\&.Ar
-\&.Ar arg1 , arg2 .
-.Ed
-.
+.Dl \&.Fl o \&Ns \&Ar file1
+.Dl \&.Ar
+.Dl \&.Ar arg1 , arg2 .

 .Ss \&At
 .Ss \&At

-Formats an AT&T version.  Accepts at most one parameter:
-.Bl -tag -width 12n -offset indent
+Formats an AT&T version.
+Accepts one optional argument:
+.Pp
+.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact

 .It Cm v[1-7] | 32v
 A version of
 .At .
 .It Cm V[.[1-4]]?
 .It Cm v[1-7] | 32v
 A version of
 .At .
 .It Cm V[.[1-4]]?

-A system version of
-.At .
+A version of
+.At V .

 .El
 .Pp
 .El
 .Pp

-Note that these parameters do not begin with a hyphen.
+Note that these arguments do not begin with a hyphen.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.At 
-\&.At V.1
-.Ed
+.Dl \&.At
+.Dl \&.At V.1

 .Pp
 See also
 .Pp
 See also

-.Sx \&Bx ,

 .Sx \&Bsx ,
 .Sx \&Bsx ,

+.Sx \&Bx ,
+.Sx \&Dx ,

 .Sx \&Fx ,
 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .
 .Sx \&Fx ,
 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .

-.

 .Ss \&Bc
 .Ss \&Bc

-Closes a
+Close a

 .Sx \&Bo
 .Sx \&Bo

-block.  Does not have any tail arguments.
-.
+block.
+Does not have any tail arguments.

 .Ss \&Bd
 .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.
+Begin a display block.
+Its syntax is as follows:
+.Bd -ragged -offset indent
+.Pf \. Sx \&Bd
+.Fl Ns Ar type
+.Op Fl offset Ar width
+.Op Fl compact
+.Ed

 .Pp
 .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.
+Display blocks are used to select a different indentation and
+justification than the one used by the surrounding text.
+They may contain both macro lines and text lines.
+By default, a display block is preceded by a vertical space.
+.Pp
+The
+.Ar type
+must be one of the following:
+.Bl -tag -width 13n -offset indent
+.It Fl centered
+Centre-justify each line.
+Using this display type is not recommended; many
+.Nm
+implementations render it poorly.

 .It Fl filled
 Left- and right-justify the block.
 .It Fl literal
 .It Fl filled
 Left- and right-justify the block.
 .It Fl literal

-Alias for
-.Fl unfilled .
-.It Fl centered
-Centre-justify each line.
+Do not justify the block at all.
+Preserve white space as it appears in the input.
+.It Fl ragged
+Only left-justify the block.
+.It Fl unfilled
+An alias for
+.Fl literal .

 .El
 .Pp
 .El
 .Pp

-The type must be provided first.  Secondary arguments are as follows:
-.Bl -tag -width 12n -offset indent
+The
+.Ar type
+must be provided first.
+Additional arguments may follow:
+.Bl -tag -width 13n -offset indent

 .It Fl offset Ar width
 .It Fl offset Ar width

-Offset by the value of
+Indent the display by the

 .Ar width ,
 .Ar width ,

-which is interpreted as one of the following, specified in order:
+which may be one of the following:

 .Bl -item
 .It
 .Bl -item
 .It

-As one of the pre-defined strings
-.Ar indent ,
+One of the pre-defined strings
+.Cm indent ,

 the width of standard indentation;
 the width of standard indentation;

-.Ar indent-two ,
+.Cm indent-two ,

 twice
 twice

-.Ar indent ;
-.Ar left ,
-which has no effect ;
-.Ar right ,
-which justifies to the right margin; and
-.Ar center ,
+.Cm indent ;
+.Cm left ,
+which has no effect;
+.Cm right ,
+which justifies to the right margin; or
+.Cm center ,

 which aligns around an imagined centre axis.
 .It
 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 ,
+A macro invocation, which selects a predefined width
+associated with that macro.
+The most popular is the imaginary macro
+.Ar \&Ds ,

 which resolves to
 which resolves to

-.Ar 6n .
+.Sy 6n .

 .It
 .It

-As a scaling unit following the syntax described in
+A width using the syntax described in

 .Sx Scaling Widths .
 .It
 .Sx Scaling Widths .
 .It

-As the calculated string length of the opaque string.
+An arbitrary string, which indents by the length of this string.

 .El
 .Pp
 .El
 .Pp

-If unset, it will revert to the value of
-.Ar 8n
-as described in
-.Sx Scaling Widths .
+When the argument is missing,
+.Fl offset
+is ignored.

 .It Fl compact
 .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.
+Do not assert vertical space before the display.

 .El
 .Pp
 Examples:
 .Bd -literal -offset indent
 .El
 .Pp
 Examples:
 .Bd -literal -offset indent

-\&.Bd \-unfilled \-offset two-indent \-compact
+\&.Bd \-literal \-offset indent \-compact

    Hello       world.
 \&.Ed
 .Ed
    Hello       world.
 \&.Ed
 .Ed

-.
+.Pp
+See also
+.Sx \&D1
+and
+.Sx \&Dl .

 .Ss \&Bf
 .Ss \&Bf

+Change the font mode for a scoped block of text.
+Its syntax is as follows:
+.Bd -ragged -offset indent
+.Pf \. Sx \&Bf
+.Oo
+.Fl emphasis | literal | symbolic |
+.Cm \&Em | \&Li | \&Sy
+.Oc
+.Ed
+.Pp
+The
+.Fl emphasis
+and
+.Cm \&Em
+argument are equivalent, as are
+.Fl symbolic
+and
+.Cm \&Sy ,
+and
+.Fl literal
+and
+.Cm \&Li .
+Without an argument, this macro does nothing.
+The font mode continues until broken by a new font mode in a nested
+scope or
+.Sx \&Ef
+is encountered.
+.Pp
+See also
+.Sx \&Li ,
+.Sx \&Ef ,
+.Sx \&Em ,
+and
+.Sx \&Sy .

 .Ss \&Bk
 .Ss \&Bk

+For each macro, keep its output together on the same output line,
+until the end of the macro or the end of the input line is reached,
+whichever comes first.
+Line breaks in text lines are unaffected.
+The syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Bk Fl words
+.Pp
+The
+.Fl words
+argument is required; additional arguments are ignored.
+.Pp
+The following example will not break within each
+.Sx \&Op
+macro line:
+.Bd -literal -offset indent
+\&.Bk \-words
+\&.Op Fl f Ar flags
+\&.Op Fl o Ar output
+\&.Ek
+.Ed
+.Pp
+Be careful in using over-long lines within a keep block!
+Doing so will clobber the right margin.

 .Ss \&Bl
 .Ss \&Bl

-.
+Begin a list.
+Lists consist of items specified using the
+.Sx \&It
+macro, containing a head or a body or both.
+The list syntax is as follows:
+.Bd -ragged -offset indent
+.Pf \. Sx \&Bl
+.Fl Ns Ar type
+.Op Fl width Ar val
+.Op Fl offset Ar val
+.Op Fl compact
+.Op HEAD ...
+.Ed
+.Pp
+The list
+.Ar type
+is mandatory and must be specified first.
+The
+.Fl width
+and
+.Fl offset
+arguments accept
+.Sx Scaling Widths
+or use the length of the given string.
+The
+.Fl offset
+is a global indentation for the whole list, affecting both item heads
+and bodies.
+For those list types supporting it, the
+.Fl width
+argument requests an additional indentation of item bodies,
+to be added to the
+.Fl offset .
+Unless the
+.Fl compact
+argument is specified, list entries are separated by vertical space.
+.Pp
+A list must specify one of the following list types:
+.Bl -tag -width 12n -offset indent
+.It Fl bullet
+No item heads can be specified, but a bullet will be printed at the head
+of each item.
+Item bodies start on the same output line as the bullet
+and are indented according to the
+.Fl width
+argument.
+.It Fl column
+A columnated list.
+The
+.Fl width
+argument has no effect; instead, each argument specifies the width
+of one column, using either the
+.Sx Scaling Widths
+syntax or the string length of the argument.
+If the first line of the body of a
+.Fl column
+list is not an
+.Sx \&It
+macro line,
+.Sx \&It
+contexts spanning one input line each are implied until an
+.Sx \&It
+macro line is encountered, at which point items start being interpreted as
+described in the
+.Sx \&It
+documentation.
+.It Fl dash
+Like
+.Fl bullet ,
+except that dashes are used in place of bullets.
+.It Fl diag
+Like
+.Fl inset ,
+except that item heads are not parsed for macro invocations.
+.\" but with additional formatting to the head.
+.It Fl enum
+A numbered list.
+Formatted like
+.Fl bullet ,
+except that cardinal numbers are used in place of bullets,
+starting at 1.
+.It Fl hang
+Like
+.Fl tag ,
+except that the first lines of item bodies are not indented, but follow
+the item heads like in
+.Fl inset
+lists.
+.It Fl hyphen
+Synonym for
+.Fl dash .
+.It Fl inset
+Item bodies follow items heads on the same line, using normal inter-word
+spacing.
+Bodies are not indented, and the
+.Fl width
+argument is ignored.
+.It Fl item
+No item heads can be specified, and none are printed.
+Bodies are not indented, and the
+.Fl width
+argument is ignored.
+.It Fl ohang
+Item bodies start on the line following item heads and are not indented.
+The
+.Fl width
+argument is ignored.
+.It Fl tag
+Item bodies are indented according to the
+.Fl width
+argument.
+When an item head fits inside the indentation, the item body follows
+this head on the same output line.
+Otherwise, the body starts on the output line following the head.
+.El
+.Pp
+See also
+.Sx \&El
+and
+.Sx \&It .

 .Ss \&Bo
 .Ss \&Bo

-Begins a block enclosed by square brackets.  Does not have any head
-arguments.
+Begin a block enclosed by square brackets.
+Does not have any head arguments.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
+.Bd -literal -offset indent -compact

 \&.Bo 1 ,
 \&.Bo 1 ,

-\&.Dv BUFSIZ Bc
+\&.Dv BUFSIZ \&Bc

 .Ed
 .Pp
 See also
 .Sx \&Bq .
 .Ed
 .Pp
 See also
 .Sx \&Bq .

-.

 .Ss \&Bq
 .Ss \&Bq

-Encloses its arguments in square brackets.  
+Encloses its arguments in square brackets.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Bq 1 , Dv BUFSIZ
-.Ed
+.Dl \&.Bq 1 , \&Dv BUFSIZ

 .Pp
 .Em Remarks :
 this macro is sometimes abused to emulate optional arguments for
 .Pp
 .Em Remarks :
 this macro is sometimes abused to emulate optional arguments for


@@ -923,204 +1348,1058 @@ and
 .Pp
 See also
 .Sx \&Bo .
 .Pp
 See also
 .Sx \&Bo .

-.

 .Ss \&Brc
 .Ss \&Brc

-Closes a
+Close a

 .Sx \&Bro
 .Sx \&Bro

-block.  Does not have any tail arguments.
-.
+block.
+Does not have any tail arguments.

 .Ss \&Bro
 .Ss \&Bro

-Begins a block enclosed by curly braces.  Does not have any head
-arguments.
+Begin a block enclosed by curly braces.
+Does not have any head arguments.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
+.Bd -literal -offset indent -compact

 \&.Bro 1 , ... ,
 \&.Bro 1 , ... ,

-\&.Va n Brc
+\&.Va n \&Brc

 .Ed
 .Pp
 See also
 .Sx \&Brq .
 .Ed
 .Pp
 See also
 .Sx \&Brq .

-.

 .Ss \&Brq
 Encloses its arguments in curly braces.
 .Pp
 Examples:
 .Ss \&Brq
 Encloses its arguments in curly braces.
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Brq 1 , ... , Va n
-.Ed
+.Dl \&.Brq 1 , ... , \&Va n

 .Pp
 See also
 .Sx \&Bro .
 .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:
 .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
+.Dl \&.Bsx 1.0
+.Dl \&.Bsx

 .Pp
 See also
 .Sx \&At ,
 .Sx \&Bx ,
 .Pp
 See also
 .Sx \&At ,
 .Sx \&Bx ,

+.Sx \&Dx ,

 .Sx \&Fx ,
 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .
 .Sx \&Fx ,
 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .

-.

 .Ss \&Bt
 .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:
 .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
+.Dl \&.Bx 4.4
+.Dl \&.Bx

 .Pp
 See also
 .Sx \&At ,
 .Sx \&Bsx ,
 .Pp
 See also
 .Sx \&At ,
 .Sx \&Bsx ,

+.Sx \&Dx ,

 .Sx \&Fx ,
 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .
 .Sx \&Fx ,
 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .

-.

 .Ss \&Cd
 .Ss \&Cd

+Kernel configuration declaration.
+This denotes strings accepted by
+.Xr config 8 .
+.Pp
+Examples:
+.Dl \&.Cd device le0 at scode?
+.Pp
+.Em Remarks :
+this macro is commonly abused by using quoted literals to retain
+whitespace and align consecutive
+.Sx \&Cd
+declarations.
+This practise is discouraged.

 .Ss \&Cm
 .Ss \&Cm

+Command modifiers.
+Useful when specifying configuration options or keys.
+.Pp
+Examples:
+.Dl \&.Cm ControlPath
+.Dl \&.Cm ControlMaster
+.Pp
+See also
+.Sx \&Fl .

 .Ss \&D1
 .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:
+.Dl \&.D1 \&Fl abcdefgh
+.Pp
+See also
+.Sx \&Bd
+and
+.Sx \&Dl .

 .Ss \&Db
 .Ss \&Db

+Switch debugging mode.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Db Cm on | off
+.Pp
+This macro is ignored by
+.Xr mandoc 1 .

 .Ss \&Dc
 .Ss \&Dc

+Close a
+.Sx \&Do
+block.
+Does not have any tail arguments.

 .Ss \&Dd
 .Ss \&Dd

+Document date.
+This is the mandatory first macro of any
+.Nm
+manual.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Dd Ar month day , year
+.Pp
+The
+.Ar month
+is the full English month name, the
+.Ar day
+is an optionally zero-padded numeral, and the
+.Ar year
+is the full four-digit year.
+.Pp
+Other arguments are not portable; the
+.Xr mandoc 1
+utility handles them as follows:
+.Bl -dash -offset 3n -compact
+.It
+To have the date automatically filled in by the
+.Ox
+version of
+.Xr cvs 1 ,
+the special string
+.Dq $\&Mdocdate$
+can be given as an argument.
+.It
+A few alternative date formats are accepted as well
+and converted to the standard form.
+.It
+If a date string cannot be parsed, it is used verbatim.
+.It
+If no date string is given, the current date is used.
+.El
+.Pp
+Examples:
+.Dl \&.Dd $\&Mdocdate$
+.Dl \&.Dd $\&Mdocdate: July 21 2007$
+.Dl \&.Dd July 21, 2007
+.Pp
+See also
+.Sx \&Dt
+and
+.Sx \&Os .

 .Ss \&Dl
 .Ss \&Dl

+One-line intended display.
+This is formatted as literal text and is useful for commands and
+invocations.
+It is followed by a newline.
+.Pp
+Examples:
+.Dl \&.Dl % mandoc mdoc.7 \e(ba less
+.Pp
+See also
+.Sx \&Bd
+and
+.Sx \&D1 .

 .Ss \&Do
 .Ss \&Do

-.Ss \&Dq
-.Ss \&Dt
-.Ss \&Dv
+Begin a block enclosed by double quotes.
+Does not have any head arguments.
+.Pp
+Examples:
+.Bd -literal -offset indent -compact
+\&.Do
+April is the cruellest month
+\&.Dc
+\e(em T.S. Eliot
+.Ed
+.Pp
+See also
+.Sx \&Dq .
+.Ss \&Dq
+Encloses its arguments in
+.Dq typographic
+double-quotes.
+.Pp
+Examples:
+.Bd -literal -offset indent -compact
+\&.Dq April is the cruellest month
+\e(em T.S. Eliot
+.Ed
+.Pp
+See also
+.Sx \&Qq ,
+.Sx \&Sq ,
+and
+.Sx \&Do .
+.Ss \&Dt
+Document title.
+This is the mandatory second macro of any
+.Nm
+file.
+Its syntax is as follows:
+.Bd -ragged -offset indent
+.Pf \. Sx \&Dt
+.Oo
+.Ar title
+.Oo
+.Ar section
+.Op Ar volume | arch
+.Oc
+.Oc
+.Ed
+.Pp
+Its arguments are as follows:
+.Bl -tag -width Ds -offset Ds
+.It Ar title
+The document's title (name), defaulting to
+.Dq UNKNOWN
+if unspecified.
+It should be capitalised.
+.It Ar section
+The manual section.
+This may be one of
+.Ar 1
+.Pq utilities ,
+.Ar 2
+.Pq system calls ,
+.Ar 3
+.Pq libraries ,
+.Ar 3p
+.Pq Perl libraries ,
+.Ar 4
+.Pq devices ,
+.Ar 5
+.Pq file formats ,
+.Ar 6
+.Pq games ,
+.Ar 7
+.Pq miscellaneous ,
+.Ar 8
+.Pq system utilities ,
+.Ar 9
+.Pq kernel functions ,
+.Ar X11
+.Pq X Window System ,
+.Ar X11R6
+.Pq X Window System ,
+.Ar unass
+.Pq unassociated ,
+.Ar local
+.Pq local system ,
+.Ar draft
+.Pq draft manual ,
+or
+.Ar paper
+.Pq paper .
+It should correspond to the manual's filename suffix and defaults to
+.Dq 1
+if unspecified.
+.It Ar volume
+This overrides the volume inferred from
+.Ar section .
+This field is optional, and if specified, must be one of
+.Ar USD
+.Pq users' supplementary documents ,
+.Ar PS1
+.Pq programmers' supplementary documents ,
+.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 Ar arch
+This specifies a specific relevant architecture.
+If
+.Ar 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 loongson ,
+.Ar luna88k ,
+.Ar mac68k ,
+.Ar macppc ,
+.Ar mips64 ,
+.Ar mvme68k ,
+.Ar mvme88k ,
+.Ar mvmeppc ,
+.Ar pmax ,
+.Ar sgi ,
+.Ar socppc ,
+.Ar sparc ,
+.Ar sparc64 ,
+.Ar sun3 ,
+.Ar vax ,
+or
+.Ar zaurus .
+.El
+.Pp
+Examples:
+.Dl \&.Dt FOO 1
+.Dl \&.Dt FOO 4 KM
+.Dl \&.Dt FOO 9 i386
+.Pp
+See also
+.Sx \&Dd
+and
+.Sx \&Os .
+.Ss \&Dv
+Defined variables such as preprocessor constants.
+.Pp
+Examples:
+.Dl \&.Dv BUFSIZ
+.Dl \&.Dv STDOUT_FILENO
+.Pp
+See also
+.Sx \&Er .

 .Ss \&Dx
 .Ss \&Dx

+Format the DragonFly BSD version provided as an argument, or a default
+value if no argument is provided.
+.Pp
+Examples:
+.Dl \&.Dx 2.4.1
+.Dl \&.Dx
+.Pp
+See also
+.Sx \&At ,
+.Sx \&Bsx ,
+.Sx \&Bx ,
+.Sx \&Fx ,
+.Sx \&Nx ,
+.Sx \&Ox ,
+and
+.Sx \&Ux .

 .Ss \&Ec
 .Ss \&Ec

+Close a scope started by
+.Sx \&Eo .
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Ec Op Ar TERM
+.Pp
+The
+.Ar TERM
+argument is used as the enclosure tail, for example, specifying \e(rq
+will emulate
+.Sx \&Dc .

 .Ss \&Ed
 .Ss \&Ed

+End a display context started by
+.Sx \&Bd .

 .Ss \&Ef
 .Ss \&Ef

+End a font mode context started by
+.Sx \&Bf .

 .Ss \&Ek
 .Ss \&Ek

+End a keep context started by
+.Sx \&Bk .

 .Ss \&El
 .Ss \&El

+End a list context started by
+.Sx \&Bl .
+.Pp
+See also
+.Sx \&Bl
+and
+.Sx \&It .

 .Ss \&Em
 .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:
+.Dl \&.Em Warnings!
+.Dl \&.Em Remarks :
+.Pp
+See also
+.Sx \&Bf ,
+.Sx \&Sy ,
+and
+.Sx \&Li .

 .Ss \&En
 .Ss \&En

+This macro is obsolete and not implemented in
+.Xr mandoc 1 .

 .Ss \&Eo
 .Ss \&Eo

+An arbitrary enclosure.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Eo Op Ar TERM
+.Pp
+The
+.Ar TERM
+argument is used as the enclosure head, for example, specifying \e(lq
+will emulate
+.Sx \&Do .

 .Ss \&Er
 .Ss \&Er

+Display error constants.
+.Pp
+Examples:
+.Dl \&.Er EPERM
+.Dl \&.Er ENOENT
+.Pp
+See also
+.Sx \&Dv .

 .Ss \&Es
 .Ss \&Es

+This macro is obsolete and not implemented.

 .Ss \&Ev
 .Ss \&Ev

+Environmental variables such as those specified in
+.Xr environ 7 .
+.Pp
+Examples:
+.Dl \&.Ev DISPLAY
+.Dl \&.Ev PATH

 .Ss \&Ex
 .Ss \&Ex

+Insert a standard sentence regarding exit values.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Ex Fl std Op Ar utility
+.Pp
+When
+.Ar utility
+is not specified, the document's name set by
+.Sx \&Nm
+is used.
+.Pp
+See also
+.Sx \&Rv .

 .Ss \&Fa
 .Ss \&Fa

+Function argument.
+Its syntax is as follows:
+.Bd -ragged -offset indent
+.Pf \. Sx \&Fa
+.Op Cm argtype
+.Cm argname
+.Ed
+.Pp
+This may be invoked for names with or without the corresponding type.
+It is also used to specify the field name of a structure.
+Most often, the
+.Sx \&Fa
+macro is used in the
+.Em SYNOPSIS
+within
+.Sx \&Fo
+section when documenting multi-line function prototypes.
+If invoked with multiple arguments, the arguments are separated by a
+comma.
+Furthermore, if the following macro is another
+.Sx \&Fa ,
+the last argument will also have a trailing comma.
+.Pp
+Examples:
+.Dl \&.Fa \(dqconst char *p\(dq
+.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
+.Dl \&.Fa foo
+.Pp
+See also
+.Sx \&Fo .

 .Ss \&Fc
 .Ss \&Fc

+End a function context started by
+.Sx \&Fo .

 .Ss \&Fd
 .Ss \&Fd

+Historically used to document include files.
+This usage has been deprecated in favour of
+.Sx \&In .
+Do not use this macro.
+.Pp
+See also
+.Sx MANUAL STRUCTURE
+and
+.Sx \&In .

 .Ss \&Fl
 .Ss \&Fl

+Command-line flag.
+Used when listing arguments to command-line utilities.
+Prints a fixed-width hyphen
+.Sq \-
+directly followed by each argument.
+If no arguments are provided, a hyphen is printed followed by a space.
+If the argument is a macro, a hyphen is prefixed to the subsequent macro
+output.
+.Pp
+Examples:
+.Dl \&.Fl a b c
+.Dl \&.Fl \&Pf a b
+.Dl \&.Fl
+.Dl \&.Op \&Fl o \&Ns \&Ar file
+.Pp
+See also
+.Sx \&Cm .

 .Ss \&Fn
 .Ss \&Fn

+A function name.
+Its syntax is as follows:
+.Bd -ragged -offset indent
+.Pf \. Ns Sx \&Fn
+.Op Ar functype
+.Ar funcname
+.Op Oo Ar argtype Oc Ar argname
+.Ed
+.Pp
+Function arguments are surrounded in parenthesis and
+are delimited by commas.
+If no arguments are specified, blank parenthesis are output.
+.Pp
+Examples:
+.Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q
+.Dl \&.Fn funcname \*qint arg0\*q
+.Dl \&.Fn funcname arg0
+.Bd -literal -offset indent -compact
+\&.Ft functype
+\&.Fn funcname
+.Ed
+.Pp
+When referring to a function documented in another manual page, use
+.Sx \&Xr
+instead.
+See also
+.Sx MANUAL STRUCTURE
+and
+.Sx \&Ft .

 .Ss \&Fo
 .Ss \&Fo

-.Ss \&Fr
+Begin a function block.
+This is a multi-line version of
+.Sx \&Fn .
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Fo Ar funcname
+.Pp
+Invocations usually occur in the following context:
+.Bd -ragged -offset indent
+.Pf \. Sx \&Ft Ar functype
+.br
+.Pf \. Sx \&Fo Ar funcname
+.br
+.Pf \. Sx \&Fa Oo Ar argtype Oc Ar argname
+.br
+\&.\.\.
+.br
+.Pf \. Sx \&Fc
+.Ed
+.Pp
+A
+.Sx \&Fo
+scope is closed by
+.Pp
+See also
+.Sx MANUAL STRUCTURE ,
+.Sx \&Fa ,
+.Sx \&Fc ,
+and
+.Sx \&Ft .

 .Ss \&Ft
 .Ss \&Ft

+A function type.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Ft Ar functype
+.Pp
+Examples:
+.Dl \&.Ft int
+.Bd -literal -offset indent -compact
+\&.Ft functype
+\&.Fn funcname
+.Ed
+.Pp
+See also
+.Sx MANUAL STRUCTURE ,
+.Sx \&Fn ,
+and
+.Sx \&Fo .

 .Ss \&Fx
 .Ss \&Fx

-Format the FreeBSD version provided as an argument, or a default value
+Format the
+.Fx
+version provided as an argument, or a default value

 if no argument is provided.
 .Pp
 Examples:
 if no argument is provided.
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Fx 7.1
-\&.Fx
-.Ed
+.Dl \&.Fx 7.1
+.Dl \&.Fx

 .Pp
 See also
 .Sx \&At ,
 .Pp
 See also
 .Sx \&At ,

-.Sx \&Bx ,

 .Sx \&Bsx ,
 .Sx \&Bsx ,

+.Sx \&Bx ,
+.Sx \&Dx ,

 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .
 .Sx \&Nx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .

-.

 .Ss \&Hf
 .Ss \&Hf

+This macro is obsolete and not implemented.

 .Ss \&Ic
 .Ss \&Ic

+Designate an internal or interactive command.
+This is similar to
+.Sx \&Cm
+but used for instructions rather than values.
+.Pp
+Examples:
+.Dl \&.Ic hash
+.Dl \&.Ic alias
+.Pp
+Note that using
+.Sx \&Bd Fl literal
+or
+.Sx \&D1
+is preferred for displaying code; the
+.Sx \&Ic
+macro is used when referring to specific instructions.

 .Ss \&In
 .Ss \&In

+An
+.Dq include
+file.
+In the
+.Em SYNOPSIS
+section (only if invoked as the line macro), the first argument is
+preceded by
+.Dq #include ,
+the arguments is enclosed in angle brackets.
+.Pp
+Examples:
+.Dl \&.In sys/types
+.Pp
+See also
+.Sx MANUAL STRUCTURE .

 .Ss \&It
 .Ss \&It

+A list item.
+The syntax of this macro depends on the list type.
+.Pp
+Lists
+of type
+.Fl hang ,
+.Fl ohang ,
+.Fl inset ,
+and
+.Fl diag
+have the following syntax:
+.Pp
+.D1 Pf \. Sx \&It Ar args
+.Pp
+Lists of type
+.Fl bullet ,
+.Fl dash ,
+.Fl enum ,
+.Fl hyphen
+and
+.Fl item
+have the following syntax:
+.Pp
+.D1 Pf \. Sx \&It
+.Pp
+with subsequent lines interpreted within the scope of the
+.Sx \&It
+until either a closing
+.Sx \&El
+or another
+.Sx \&It .
+.Pp
+The
+.Fl tag
+list has the following syntax:
+.Pp
+.D1 Pf \. Sx \&It Op Cm args
+.Pp
+Subsequent lines are interpreted as with
+.Fl bullet
+and family.
+The line arguments correspond to the list's left-hand side; body
+arguments correspond to the list's contents.
+.Pp
+The
+.Fl column
+list is the most complicated.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&It Op Cm args
+.Pp
+The
+.Cm args
+are phrases, a mix of macros and text corresponding to a line column,
+delimited by tabs or the special
+.Sq \&Ta
+pseudo-macro.
+Lines subsequent the
+.Sx \&It
+are interpreted within the scope of the last phrase.
+Calling the pseudo-macro
+.Sq \&Ta
+will open a new phrase scope (this must occur on a macro line to be
+interpreted as a macro).
+Note that the tab phrase delimiter may only be used within the
+.Sx \&It
+line itself.
+Subsequent this, only the
+.Sq \&Ta
+pseudo-macro may be used to delimit phrases.
+Furthermore, note that quoted sections propagate over tab-delimited
+phrases on an
+.Sx \&It ,
+for example,
+.Pp
+.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
+.Pp
+will preserve the semicolon whitespace except for the last.
+.Pp
+See also
+.Sx \&Bl .

 .Ss \&Lb
 .Ss \&Lb

+Specify a library.
+The syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Lb Ar library
+.Pp
+The
+.Ar library
+parameter may be a system library, such as
+.Ar libz
+or
+.Ar libpam ,
+in which case a small library description is printed next to the linker
+invocation; or a custom library, in which case the library name is
+printed in quotes.
+This is most commonly used in the
+.Em SYNOPSIS
+section as described in
+.Sx MANUAL STRUCTURE .
+.Pp
+Examples:
+.Dl \&.Lb libz
+.Dl \&.Lb mdoc

 .Ss \&Li
 .Ss \&Li

+Denotes text that should be in a literal font mode.
+Note that this is a presentation term and should not be used for
+stylistically decorating technical terms.
+.Pp
+See also
+.Sx \&Bf ,
+.Sx \&Sy ,
+and
+.Sx \&Em .

 .Ss \&Lk
 .Ss \&Lk

+Format a hyperlink.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Lk Ar uri Op Ar name
+.Pp
+Examples:
+.Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q
+.Dl \&.Lk http://bsd.lv
+.Pp
+See also
+.Sx \&Mt .

 .Ss \&Lp
 .Ss \&Lp

+Synonym for
+.Sx \&Pp .

 .Ss \&Ms
 .Ss \&Ms

+Display a mathematical symbol.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Ms Ar symbol
+.Pp
+Examples:
+.Dl \&.Ms sigma
+.Dl \&.Ms aleph

 .Ss \&Mt
 .Ss \&Mt

+Format a
+.Dq mailto:
+hyperlink.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Mt Ar address
+.Pp
+Examples:
+.Dl \&.Mt discuss@manpages.bsd.lv

 .Ss \&Nd
 .Ss \&Nd

+A one line description of the manual's content.
+This may only be invoked in the
+.Em SYNOPSIS
+section subsequent the
+.Sx \&Nm
+macro.
+.Pp
+Examples:
+.Dl \&.Sx \&Nd mdoc language reference
+.Dl \&.Sx \&Nd format and display UNIX manuals
+.Pp
+The
+.Sx \&Nd
+macro technically accepts child macros and terminates with a subsequent
+.Sx \&Sh
+invocation.
+Do not assume this behaviour: some
+.Xr whatis 1
+database generators are not smart enough to parse more than the line
+arguments and will display macros verbatim.
+.Pp
+See also
+.Sx \&Nm .

 .Ss \&Nm
 .Ss \&Nm

+The name of the manual page, or \(em in particular in section 1, 6,
+and 8 pages \(em of an additional command or feature documented in
+the manual page.
+When first invoked, the
+.Sx \&Nm
+macro expects a single argument, the name of the manual page.
+Usually, the first invocation happens in the
+.Em NAME
+section of the page.
+The specified name will be remembered and used whenever the macro is
+called again without arguments later in the page.
+The
+.Sx \&Nm
+macro uses
+.Sx Block full-implicit
+semantics when invoked as the first macro on an input line in the
+.Em SYNOPSIS
+section; otherwise, it uses ordinary
+.Sx In-line
+semantics.
+.Pp
+Examples:
+.Bd -literal -offset indent
+\&.Sh SYNOPSIS
+\&.Nm cat
+\&.Op Fl benstuv
+\&.Op Ar
+.Ed
+.Pp
+In the
+.Em SYNOPSIS
+of section 2, 3 and 9 manual pages, use the
+.Sx \&Fn
+macro rather than
+.Sx \&Nm
+to mark up the name of the manual page.

 .Ss \&No
 .Ss \&No

+A
+.Dq noop
+macro used to terminate prior macro contexts.
+.Pp
+Examples:
+.Dl \&.Sx \&Fl ab \&No cd \&Fl ef

 .Ss \&Ns
 .Ss \&Ns

+Suppress a space.
+Following invocation, text is interpreted as free-form text until a
+macro is encountered.
+.Pp
+This has no effect when invoked at the start of a macro line.
+.Pp
+Examples:
+.Dl \&.Fl o \&Ns \&Ar output
+.Pp
+See also
+.Sx \&No
+and
+.Sx \&Sm .

 .Ss \&Nx
 .Ss \&Nx

-Format the NetBSD version provided as an argument, or a default value if
+Format the
+.Nx
+version provided as an argument, or a default value if

 no argument is provided.
 .Pp
 Examples:
 no argument is provided.
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Nx 5.01
-\&.Nx
-.Ed
+.Dl \&.Nx 5.01
+.Dl \&.Nx

 .Pp
 See also
 .Sx \&At ,
 .Pp
 See also
 .Sx \&At ,

-.Sx \&Bx ,

 .Sx \&Bsx ,
 .Sx \&Bsx ,

+.Sx \&Bx ,
+.Sx \&Dx ,

 .Sx \&Fx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .
 .Sx \&Fx ,
 .Sx \&Ox ,
 and
 .Sx \&Ux .

-.

 .Ss \&Oc
 .Ss \&Oc

+Close multi-line
+.Sx \&Oo
+context.

 .Ss \&Oo
 .Ss \&Oo

+Multi-line version of
+.Sx \&Op .
+.Pp
+Examples:
+.Bd -literal -offset indent -compact
+\&.Oo
+\&.Op Fl flag Ns Ar value
+\&.Oc
+.Ed

 .Ss \&Op
 .Ss \&Op

+Command-line option.
+Used when listing options to command-line utilities.
+Prints the argument(s) in brackets.
+.Pp
+Examples:
+.Dl \&.Op \&Fl a \&Ar b
+.Dl \&.Op \&Ar a | b
+.Pp
+See also
+.Sx \&Oo .

 .Ss \&Os
 .Ss \&Os

+Document operating system version.
+This is the mandatory third macro of
+any
+.Nm
+file.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Os Op Ar system Op Ar version
+.Pp
+The optional
+.Ar 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:
+.Dl \&.Os
+.Dl \&.Os KTH/CSC/TCS
+.Dl \&.Os BSD 4.3
+.Pp
+See also
+.Sx \&Dd
+and
+.Sx \&Dt .

 .Ss \&Ot
 .Ss \&Ot

+Unknown usage.
+.Pp
+.Em Remarks :
+this macro has been deprecated.

 .Ss \&Ox
 .Ss \&Ox

-Format the OpenBSD version provided as an argument, or a default value
+Format the
+.Ox
+version provided as an argument, or a default value

 if no argument is provided.
 .Pp
 Examples:
 if no argument is provided.
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Ox 4.5
-\&.Ox
-.Ed
+.Dl \&.Ox 4.5
+.Dl \&.Ox

 .Pp
 See also
 .Sx \&At ,
 .Sx \&Bsx ,
 .Sx \&Bx ,
 .Pp
 See also
 .Sx \&At ,
 .Sx \&Bsx ,
 .Sx \&Bx ,

+.Sx \&Dx ,

 .Sx \&Fx ,
 .Sx \&Nx ,
 and
 .Sx \&Ux .
 .Sx \&Fx ,
 .Sx \&Nx ,
 and
 .Sx \&Ux .

-.

 .Ss \&Pa
 .Ss \&Pa

+A file-system path.
+If an argument is not provided, the string
+.Dq \(ti
+is used as a default.
+.Pp
+Examples:
+.Dl \&.Pa /usr/bin/mandoc
+.Dl \&.Pa /usr/share/man/man7/mdoc.7
+.Pp
+See also
+.Sx \&Lk .

 .Ss \&Pc
 .Ss \&Pc

+Close parenthesised context opened by
+.Sx \&Po .

 .Ss \&Pf
 .Ss \&Pf

+Removes the space
+.Pq Dq prefix
+between its arguments.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. \&Pf Ar prefix suffix
+.Pp
+The
+.Ar suffix
+argument may be a macro.
+.Pp
+Examples:
+.Dl \&.Pf \e. \&Sx \&Pf \&Ar prefix suffix

 .Ss \&Po
 .Ss \&Po

+Multi-line version of
+.Sx \&Pq .

 .Ss \&Pp
 .Ss \&Pp

+Break a paragraph.
+This will assert vertical space between prior and subsequent macros
+and/or text.

 .Ss \&Pq
 .Ss \&Pq

+Parenthesised enclosure.
+.Pp
+See also
+.Sx \&Po .

 .Ss \&Qc
 .Ss \&Qc

+Close quoted context opened by
+.Sx \&Qo .

 .Ss \&Ql
 .Ss \&Ql

+Format a single-quoted literal.
+See also
+.Sx \&Qq
+and
+.Sx \&Sq .

 .Ss \&Qo
 .Ss \&Qo

+Multi-line version of
+.Sx \&Qq .

 .Ss \&Qq
 .Ss \&Qq

-.
+Encloses its arguments in
+.Dq typewriter
+double-quotes.
+Consider using
+.Sx \&Dq .
+.Pp
+See also
+.Sx \&Dq ,
+.Sx \&Sq ,
+and
+.Sx \&Qo .

 .Ss \&Re
 .Ss \&Re

-Closes a
+Close an

 .Sx \&Rs
 .Sx \&Rs

-block.  Does not have any tail arguments.
-.
+block.
+Does not have any tail arguments.

 .Ss \&Rs
 .Ss \&Rs

-Begins a bibliographic
+Begin a bibliographic

 .Pq Dq reference
 .Pq Dq reference

-block.  Does not have any head arguments.  The block macro and may only
-contain
+block.
+Does not have any head arguments.
+The block macro may only contain

 .Sx \&%A ,
 .Sx \&%B ,
 .Sx \&%C ,
 .Sx \&%A ,
 .Sx \&%B ,
 .Sx \&%C ,


@@ -1133,12 +2412,13 @@ contain
 .Sx \&%Q ,
 .Sx \&%R ,
 .Sx \&%T ,
 .Sx \&%Q ,
 .Sx \&%R ,
 .Sx \&%T ,

+.Sx \&%U ,

 and
 .Sx \&%V
 child macros (at least one must be specified).
 .Pp
 Examples:
 and
 .Sx \&%V
 child macros (at least one must be specified).
 .Pp
 Examples:

-.Bd -literal -offset indent
+.Bd -literal -offset indent -compact

 \&.Rs
 \&.%A J. E. Hopcroft
 \&.%A J. D. Ullman
 \&.Rs
 \&.%A J. E. Hopcroft
 \&.%A J. D. Ullman


@@ -1154,193 +2434,517 @@ If an
 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.
 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 \&Rv

+Inserts text regarding a function call's return value.
+This macro must consist of the
+.Fl std
+argument followed by an optional
+.Ar function .
+If
+.Ar function
+is not provided, the document's name as stipulated by the first
+.Sx \&Nm
+is provided.
+.Pp
+See also
+.Sx \&Ex .

 .Ss \&Sc
 .Ss \&Sc

+Close single-quoted context opened by
+.Sx \&So .

 .Ss \&Sh
 .Ss \&Sh

+Begin a new section.
+For a list of conventional manual sections, see
+.Sx MANUAL STRUCTURE .
+These sections should be used unless it's absolutely necessary that
+custom sections be used.
+.Pp
+Section names should be unique so that they may be keyed by
+.Sx \&Sx .
+.Pp
+See also
+.Sx \&Pp ,
+.Sx \&Ss ,
+and
+.Sx \&Sx .

 .Ss \&Sm
 .Ss \&Sm

+Switches the spacing mode for output generated from macros.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Sm Cm on | off
+.Pp
+By default, spacing is
+.Ar on .
+When switched
+.Ar off ,
+no white space is inserted between macro arguments and between the
+output generated from adjacent macros, but text lines
+still get normal spacing between words and sentences.

 .Ss \&So
 .Ss \&So

+Multi-line version of
+.Sx \&Sq .

 .Ss \&Sq
 .Ss \&Sq

+Encloses its arguments in
+.Dq typewriter
+single-quotes.
+.Pp
+See also
+.Sx \&Dq ,
+.Sx \&Qq ,
+and
+.Sx \&So .

 .Ss \&Ss
 .Ss \&Ss

+Begin a new sub-section.
+Unlike with
+.Sx \&Sh ,
+there's no convention for sub-sections.
+Conventional sections, as described in
+.Sx MANUAL STRUCTURE ,
+rarely have sub-sections.
+.Pp
+Sub-section names should be unique so that they may be keyed by
+.Sx \&Sx .
+.Pp
+See also
+.Sx \&Pp ,
+.Sx \&Sh ,
+and
+.Sx \&Sx .

 .Ss \&St
 .Ss \&St

+Replace an abbreviation for a standard with the full form.
+The following standards are recognised:
+.Pp
+.Bl -tag -width "-p1003.1g-2000X" -compact
+.It \-p1003.1-88
+.St -p1003.1-88
+.It \-p1003.1-90
+.St -p1003.1-90
+.It \-p1003.1-96
+.St -p1003.1-96
+.It \-p1003.1-2001
+.St -p1003.1-2001
+.It \-p1003.1-2004
+.St -p1003.1-2004
+.It \-p1003.1-2008
+.St -p1003.1-2008
+.It \-p1003.1
+.St -p1003.1
+.It \-p1003.1b
+.St -p1003.1b
+.It \-p1003.1b-93
+.St -p1003.1b-93
+.It \-p1003.1c-95
+.St -p1003.1c-95
+.It \-p1003.1g-2000
+.St -p1003.1g-2000
+.It \-p1003.1i-95
+.St -p1003.1i-95
+.It \-p1003.2-92
+.St -p1003.2-92
+.It \-p1003.2a-92
+.St -p1003.2a-92
+.It \-p1387.2-95
+.St -p1387.2-95
+.It \-p1003.2
+.St -p1003.2
+.It \-p1387.2
+.St -p1387.2
+.It \-isoC
+.St -isoC
+.It \-isoC-90
+.St -isoC-90
+.It \-isoC-amd1
+.St -isoC-amd1
+.It \-isoC-tcor1
+.St -isoC-tcor1
+.It \-isoC-tcor2
+.St -isoC-tcor2
+.It \-isoC-99
+.St -isoC-99
+.It \-iso9945-1-90
+.St -iso9945-1-90
+.It \-iso9945-1-96
+.St -iso9945-1-96
+.It \-iso9945-2-93
+.St -iso9945-2-93
+.It \-ansiC
+.St -ansiC
+.It \-ansiC-89
+.St -ansiC-89
+.It \-ansiC-99
+.St -ansiC-99
+.It \-ieee754
+.St -ieee754
+.It \-iso8802-3
+.St -iso8802-3
+.It \-ieee1275-94
+.St -ieee1275-94
+.It \-xpg3
+.St -xpg3
+.It \-xpg4
+.St -xpg4
+.It \-xpg4.2
+.St -xpg4.2
+.St -xpg4.3
+.It \-xbd5
+.St -xbd5
+.It \-xcu5
+.St -xcu5
+.It \-xsh5
+.St -xsh5
+.It \-xns5
+.St -xns5
+.It \-xns5.2
+.St -xns5.2
+.It \-xns5.2d2.0
+.St -xns5.2d2.0
+.It \-xcurses4.2
+.St -xcurses4.2
+.It \-susv2
+.St -susv2
+.It \-susv3
+.St -susv3
+.It \-svid4
+.St -svid4
+.El

 .Ss \&Sx
 .Ss \&Sx

+Reference a section or sub-section.
+The referenced section or sub-section name must be identical to the
+enclosed argument, including whitespace.
+.Pp
+Examples:
+.Dl \&.Sx MANUAL STRUCTURE
+.Pp
+See also
+.Sx \&Sh
+and
+.Sx \&Ss .

 .Ss \&Sy
 .Ss \&Sy

+Format enclosed arguments in symbolic
+.Pq Dq boldface .
+Note that this is a presentation term and should not be used for
+stylistically decorating technical terms.
+.Pp
+See also
+.Sx \&Bf ,
+.Sx \&Li ,
+and
+.Sx \&Em .

 .Ss \&Tn
 .Ss \&Tn

+Format a tradename.
+.Pp
+Examples:
+.Dl \&.Tn IBM

 .Ss \&Ud
 .Ss \&Ud

+Prints out
+.Dq currently under development .

 .Ss \&Ux
 .Ss \&Ux

-Format the UNIX name.  Accepts no argument.
+Format the UNIX name.
+Accepts no argument.

 .Pp
 Examples:
 .Pp
 Examples:

-.Bd -literal -offset indent
-\&.Ux
-.Ed
+.Dl \&.Ux

 .Pp
 See also
 .Sx \&At ,
 .Pp
 See also
 .Sx \&At ,

-.Sx \&Bx ,

 .Sx \&Bsx ,
 .Sx \&Bsx ,

+.Sx \&Bx ,
+.Sx \&Dx ,

 .Sx \&Fx ,
 .Sx \&Nx ,
 and
 .Sx \&Ox .
 .Sx \&Fx ,
 .Sx \&Nx ,
 and
 .Sx \&Ox .

-.

 .Ss \&Va
 .Ss \&Va

+A variable name.
+.Pp
+Examples:
+.Dl \&.Va foo
+.Dl \&.Va const char *bar ;

 .Ss \&Vt
 .Ss \&Vt

+A variable type.
+This is also used for indicating global variables in the
+.Em SYNOPSIS
+section, in which case a variable name is also specified.
+Note that it accepts
+.Sx Block partial-implicit
+syntax when invoked as the first macro in the
+.Em SYNOPSIS
+section, else it accepts ordinary
+.Sx In-line
+syntax.
+.Pp
+Note that this should not be confused with
+.Sx \&Ft ,
+which is used for function return types.
+.Pp
+Examples:
+.Dl \&.Vt unsigned char
+.Dl \&.Vt extern const char * const sys_signame[] \&;
+.Pp
+See also
+.Sx MANUAL STRUCTURE
+and
+.Sx \&Va .

 .Ss \&Xc
 .Ss \&Xc

+Close a scope opened by
+.Sx \&Xo .

 .Ss \&Xo
 .Ss \&Xo

+Extend the header of an
+.Sx \&It
+macro or the body of a partial-implicit block macro
+beyond the end of the input line.
+This macro originally existed to work around the 9-argument limit
+of historic
+.Xr roff 7 .

 .Ss \&Xr
 .Ss \&Xr

+Link to another manual
+.Pq Qq cross-reference .
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Xr Ar name section
+.Pp
+The
+.Ar name
+and
+.Ar section
+are the name and section of the linked manual.
+If
+.Ar section
+is followed by non-punctuation, an
+.Sx \&Ns
+is inserted into the token stream.
+This behaviour is for compatibility with
+GNU troff.
+.Pp
+Examples:
+.Dl \&.Xr mandoc 1
+.Dl \&.Xr mandoc 1 \&;
+.Dl \&.Xr mandoc 1 \&Ns s behaviour

 .Ss \&br
 .Ss \&br

+Emits a line-break.
+This macro should not be used; it is implemented for compatibility with
+historical manuals.
+.Pp
+Consider using
+.Sx \&Pp
+in the event of natural paragraph breaks.

 .Ss \&sp
 .Ss \&sp

-.
-.
+Emits vertical space.
+This macro should not be used; it is implemented for compatibility with
+historical manuals.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&sp Op Ar height
+.Pp
+The
+.Ar height
+argument must be formatted as described in
+.Sx Scaling Widths .
+If unspecified,
+.Sx \&sp
+asserts a single vertical space.

 .Sh COMPATIBILITY
 .Sh COMPATIBILITY

-This section documents compatibility with other roff implementations, at
-this time limited to
-.Xr groff 1 .
+This section documents compatibility between mandoc and other other
+troff implementations, at this time limited to GNU troff
+.Pq Qq groff .

 The term
 .Qq historic groff
 The term
 .Qq historic groff

-refers to those versions before the
+refers to groff versions before 1.17,
+which featured a significant update of the

 .Pa doc.tmac
 .Pa doc.tmac

-file re-write
-.Pq somewhere between 1.15 and 1.19 .
-.
+file.
+.Pp
+Heirloom troff, the other significant troff implementation accepting
+\-mdoc, is similar to historic groff.
+.Pp
+The following problematic behaviour is found in groff:
+.ds hist (Historic groff only.)

 .Pp
 .Bl -dash -compact
 .It
 .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.
+Display macros
+.Po
+.Sx \&Bd ,
+.Sx \&Dl ,
+and
+.Sx \&D1
+.Pc
+may not be nested.
+\*[hist]

 .It
 .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.
+.Sx \&At
+with unknown arguments produces no output at all.
+\*[hist]
+Newer groff and mandoc print
+.Qq AT&T UNIX
+and the arguments.

 .It
 .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 .
+.Sx \&Bd Fl column
+does not recognize trailing punctuation characters when they immediately
+precede tabulator characters, but treats them as normal text and
+outputs a space before them.

 .It
 .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.
+.Sx \&Bd Fl ragged compact
+does not start a new line.
+\*[hist]

 .It
 .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.
+.Sx \&Dd
+with non-standard arguments behaves very strangely.
+When there are three arguments, they are printed verbatim.
+Any other number of arguments is replaced by the current date,
+but without any arguments the string
+.Dq Epoch
+is printed.

 .It
 .It

-The vertical bar
-.Sq \(ba
-made historic groff
-.Qq go orbital
-but is a proper delimiter in this implementation.
+.Sx \&Fl
+does not print a dash for an empty argument.
+\*[hist]
+.It
+.Sx \&Fn
+does not start a new line unless invoked as the line macro in the
+.Em SYNOPSIS
+section.
+\*[hist]
+.It
+.Sx \&Fo
+with
+.Pf non- Sx \&Fa
+children causes inconsistent spacing between arguments.
+In mandoc, a single space is always inserted between arguments.

 .It
 .It

-.Sx \&It Fl nested
-is assumed for all lists (it wasn't in historic groff): any list may be
-nested and
+.Sx \&Ft
+in the
+.Em SYNOPSIS
+causes inconsistent vertical spacing, depending on whether a prior
+.Sx \&Fn
+has been invoked.
+See
+.Sx \&Ft
+and
+.Sx \&Fn
+for the normalised behaviour in mandoc.
+.It
+.Sx \&In
+ignores additional arguments and is not treated specially in the
+.Em SYNOPSIS .
+\*[hist]
+.It
+.Sx \&It
+sometimes requires a
+.Fl nested
+flag.
+\*[hist]
+In new groff and mandoc, any list may be nested by default and

 .Fl enum
 lists will restart the sequence only for the sub-list.
 .It
 .Fl enum
 lists will restart the sequence only for the sub-list.
 .It

-Some manuals use

 .Sx \&Li
 .Sx \&Li

-incorrectly by following it with a reserved character and expecting the
-delimiter to render.  This is not supported.
+followed by a reserved character is incorrectly used in some manuals
+instead of properly quoting that character, which sometimes works with
+historic groff.

 .It
 .It

-In groff, the
-.Sx \&Fo
-macro only produces the first parameter.  This is no longer the case.
+.Sx \&Lk
+only accepts a single link-name argument; the remainder is misformatted.
+.It
+.Sx \&Pa
+does not format its arguments when used in the FILES section under
+certain list types.
+.It
+.Sx \&Ta
+can only be called by other macros, but not at the beginning of a line.
+.It
+.Sx \&%C
+is not implemented.
+.It
+Historic groff only allows up to eight or nine arguments per macro input
+line, depending on the exact situation.
+Providing more arguments causes garbled output.
+The number of arguments on one input line is not limited with mandoc.
+.It
+Historic groff has many un-callable macros.
+Most of these (excluding some block-level macros) are callable
+in new groff and mandoc.
+.It
+.Sq \(ba
+(vertical bar) is not fully supported as a delimiter.
+\*[hist]
+.It
+.Sq \ef
+.Pq font face
+and
+.Sq \ef
+.Pq font family face
+.Sx Text Decoration
+escapes behave irregularly when specified within line-macro scopes.
+.It
+Negative scaling units return to prior lines.
+Instead, mandoc truncates them to zero.
+.El
+.Pp
+The following features are unimplemented in mandoc:
+.Pp
+.Bl -dash -compact
+.It
+.Sx \&Bd
+.Fl file Ar file .
+.It
+.Sx \&Bd
+.Fl offset Ar center
+and
+.Fl offset Ar right .
+Groff does not implement centered and flush-right rendering either,
+but produces large indentations.
+.It
+The
+.Sq \eh
+.Pq horizontal position ,
+.Sq \ev
+.Pq vertical position ,
+.Sq \em
+.Pq text colour ,
+.Sq \eM
+.Pq text filling colour ,
+.Sq \ez
+.Pq zero-length character ,
+.Sq \ew
+.Pq string length ,
+.Sq \ek
+.Pq horizontal position marker ,
+.Sq \eo
+.Pq text overstrike ,
+and
+.Sq \es
+.Pq text size
+escape sequences are all discarded in mandoc.
+.It
+The
+.Sq \ef
+scaling unit is accepted by mandoc, but rendered as the default unit.
+.It
+In quoted literals, groff allows pairwise double-quotes to produce a
+standalone double-quote in formatted output.
+This is not supported by mandoc.

 .El
 .El

-.
-.

 .Sh SEE ALSO
 .Sh SEE ALSO

+.Xr man 1 ,

 .Xr mandoc 1 ,
 .Xr mandoc 1 ,

+.Xr eqn 7 ,
+.Xr man 7 ,

 .Xr mandoc_char 7
 .Xr mandoc_char 7

-.
-.
+.Xr roff 7 ,
+.Xr tbl 7
+.Sh HISTORY
+The
+.Nm
+language first appeared as a troff macro package in
+.Bx 4.4 .
+It was later significantly updated by Werner Lemberg and Ruslan Ermilov
+in groff-1.17.
+The standalone implementation that is part of the
+.Xr mandoc 1
+utility written by Kristaps Dzonsons appeared in
+.Ox 4.6 .

 .Sh AUTHORS
 The
 .Nm
 reference was written by
 .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
-.\" .
+.An Kristaps Dzonsons Aq kristaps@bsd.lv .