Remove TODO from prior commit of lifting warnings from `Sh', `Ss', `SH',

[mandoc.git] / mdoc.7

diff --git a/mdoc.7 b/mdoc.7
index 1f94e32808fc67f38e2b667c60ee22827262f939..5a108d5b7652d827b4c5114a31c28583a25bff6f 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,6 +1,6 @@
-.\"    $Id: mdoc.7,v 1.158 2010/09/04 17:22:41 kristaps Exp $
+.\"    $Id: mdoc.7,v 1.185 2011/04/06 11:39:25 kristaps Exp $

 .\"
 .\"

-.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" 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
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any


@@ -15,7 +15,7 @@
 .\" 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: September 4 2010 $
+.Dd $Mdocdate: April 6 2011 $

 .Dt MDOC 7
 .Os
 .Sh NAME
 .Dt MDOC 7
 .Os
 .Sh NAME


@@ -40,37 +40,39 @@ An
 .Nm
 document follows simple rules: lines beginning with the control
 character
 .Nm
 document follows simple rules: lines beginning with the control
 character

-.Sq \.
+.Sq \&.

 are parsed for macros.
 are parsed for macros.

-Other lines are interpreted within the scope of
-prior 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
 .Sh LANGUAGE SYNTAX
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the space
 character, and, in certain circumstances, the tab character.
 .Ed
 .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.
+.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
 .Sq \e\*q ,
 .Ss Comments
 Text following a
 .Sq \e\*q ,

-whether in a macro or free-form text line, is ignored to the end of
+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.
 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 Characters
-Within a macro line, the following characters are reserved:
+.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 \&:


@@ -91,16 +93,18 @@ 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
 .Pp
 .El
 .Pp

-Use of reserved characters is described in
+Use of reserved terms is described in

 .Sx MACRO SYNTAX .
 .Sx MACRO SYNTAX .

-For general use in macro lines, these characters can either be escaped
-with a non-breaking space
-.Pq Sq \e&
-or, if applicable, an appropriate escape sequence can be 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


@@ -125,22 +129,19 @@ Terms may be text-decorated using the
 escape followed by an indicator: B (bold), I (italic), R (Roman), or P
 (revert to previous mode):
 .Pp
 escape followed by an indicator: B (bold), I (italic), R (Roman), or P
 (revert to previous mode):
 .Pp

-.D1 \efBbold\efR \efIitalic\efP
+.Dl \efBbold\efR \efIitalic\efP

 .Pp
 A numerical representation 3, 2, or 1 (bold, italic, and Roman,
 respectively) may be used instead.
 .Pp
 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
+If a macro opens a font scope after calling
+.Sq \ef ,
+such as with
+.Sx \&Bf ,
+the

 .Sq \ef
 .Sq \ef

-is specified outside of any font scope, such as in unenclosed, free-form
-text, it will affect the remainder of the document.
+mode will be restored upon exiting the
+.Sx \&Bf
+scope.

 .Pp
 Note this form is
 .Em not
 .Pp
 Note this form is
 .Em not


@@ -174,9 +175,9 @@ and
 .Pq vertical bar .
 .Ss Whitespace
 Whitespace consists of the space character.
 .Pq vertical bar .
 .Ss Whitespace
 Whitespace consists of the space character.

-In free-form lines, whitespace is preserved within a line; unescaped
+In text lines, whitespace is preserved within a line; unescaped

 trailing spaces are stripped from input (unless in a literal context).
 trailing spaces are stripped from input (unless in a literal context).

-Blank free-form lines, which may include whitespace, are only permitted
+Blank text lines, which may include whitespace, are only permitted

 within literal contexts.
 .Pp
 In macro lines, whitespace delimits arguments and is discarded.
 within literal contexts.
 .Pp
 In macro lines, whitespace delimits arguments and is discarded.


@@ -196,35 +197,7 @@ Thus, the following produces
 \&.Op "Fl a"
 .Ed
 .Pp
 \&.Op "Fl 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
+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:
 .Ss Scaling Widths
 Many macros support scaled widths for their arguments, such as
 stipulating a two-inch list indentation with the following:


@@ -283,18 +256,20 @@ 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
 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 (
-.Ns Sq \&) ,
+delimiters
+.Po
+.Sq \&) ,

 .Sq \&] ,
 .Sq \&' ,
 .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
 .Pp
 The proper spacing is also intelligently preserved if a sentence ends at
 the boundary of a macro line.
 For example:
 .Pp

-.D1 \&Xr mandoc 1 \.
-.D1 \&Fl T \&Ns \&Cm ascii \.
+.Dl \&.Xr mandoc 1 \&.
+.Dl \&.Fl T \&Ns \&Cm ascii \&.

 .Sh MANUAL STRUCTURE
 A well-formed
 .Nm
 .Sh MANUAL STRUCTURE
 A well-formed
 .Nm


@@ -343,13 +318,14 @@ The
 \&.Nm
 utility processes files ...
 \&.\e\*q .Sh IMPLEMENTATION NOTES
 \&.Nm
 utility processes files ...
 \&.\e\*q .Sh IMPLEMENTATION NOTES

+\&.\e\*q Not used in OpenBSD.

 \&.\e\*q .Sh RETURN VALUES
 \&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .Sh ENVIRONMENT
 \&.\e\*q For sections 1, 6, 7, & 8 only.
 \&.\e\*q .Sh FILES
 \&.\e\*q .Sh EXIT STATUS
 \&.\e\*q .Sh RETURN VALUES
 \&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .Sh ENVIRONMENT
 \&.\e\*q For sections 1, 6, 7, & 8 only.
 \&.\e\*q .Sh FILES
 \&.\e\*q .Sh EXIT STATUS

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

 \&.\e\*q .Sh EXAMPLES
 \&.\e\*q .Sh DIAGNOSTICS
 \&.\e\*q For sections 1, 4, 6, 7, & 8 only.
 \&.\e\*q .Sh EXAMPLES
 \&.\e\*q .Sh DIAGNOSTICS
 \&.\e\*q For sections 1, 4, 6, 7, & 8 only.


@@ -381,6 +357,10 @@ The syntax for this as follows:
 \&.Nd a one line description
 .Ed
 .Pp
 \&.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
 The
 .Sx \&Nm
 macro(s) must precede the


@@ -408,16 +388,18 @@ configuration.
 For the first, utilities (sections 1, 6, and 8), this is
 generally structured as follows:
 .Bd -literal -offset indent
 For the first, utilities (sections 1, 6, and 8), this is
 generally structured as follows:
 .Bd -literal -offset indent

-\&.Nm foo
+\&.Nm bar

 \&.Op Fl v
 \&.Op Fl o Ar file
 \&.Op Ar
 \&.Op Fl v
 \&.Op Fl o Ar file
 \&.Op Ar

-\&.Nm bar
+\&.Nm foo

 \&.Op Fl v
 \&.Op Fl o Ar file
 \&.Op Ar
 .Ed
 .Pp
 \&.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
 For the second, function calls (sections 2, 3, 9):
 .Bd -literal -offset indent
 \&.In header.h


@@ -428,6 +410,14 @@ For the second, function calls (sections 2, 3, 9):
 \&.Fn bar "const char *src"
 .Ed
 .Pp
 \&.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
 And for the third, configurations (section 4):
 .Bd -literal -offset indent
 \&.Cd \*qit* at isa? port 0x2e\*q


@@ -476,9 +466,15 @@ or
 .Sx \&Ss
 macro or the end of an enclosing block, whichever comes first.
 .It Em DESCRIPTION
 .Sx \&Ss
 macro or the end of an enclosing block, whichever comes first.
 .It Em DESCRIPTION

-This expands upon the brief, one line description in
-.Em NAME .
-It usually contains a breakdown of the options (if documenting a
+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:
 command), such as:
 .Bd -literal -offset indent
 The arguments are as follows:


@@ -603,20 +599,21 @@ 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 .
 .Pp
 The
 .Em Parsed
 .Sq \&.Fl \&Sh
 produces
 .Sq Fl \&Sh .
 .Pp
 The
 .Em Parsed

-column indicates whether the macro may be followed by further
-(ostensibly callable) macros.
-If a macro is not parsed, subsequent macro invocations on the line
-will be interpreted as opaque text.
+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
 .Pp
 The
 .Em Scope


@@ -625,7 +622,10 @@ column, if applicable, describes closure rules.
 Multi-line scope closed by an explicit closing macro.
 All macros contains bodies; only
 .Sx \&Bf
 Multi-line scope closed by an explicit closing macro.
 All macros contains bodies; only
 .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
 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB


@@ -730,7 +730,7 @@ and/or tail
 .El
 .Ss Block partial-implicit
 Like block full-implicit, but with single-line scope closed by
 .El
 .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
 or end of line.
 .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB


@@ -763,7 +763,7 @@ section line, else it is
 .Sx In-line .
 .Ss In-line
 Closed by
 .Sx In-line .
 .Ss In-line
 Closed by

-.Sx Reserved Characters ,
+.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
 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


@@ -793,8 +793,8 @@ then the macro accepts an arbitrary number of arguments.
 .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 \&%T  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0

-.It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    n
-.It Sx \&An  Ta    Yes      Ta    Yes      Ta    n
+.It Sx \&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


@@ -802,31 +802,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 \&Dd  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n

-.It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n
+.It Sx \&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


@@ -882,8 +882,10 @@ block.
 Publication date of an
 .Sx \&Rs
 block.
 Publication date of an
 .Sx \&Rs
 block.

-This should follow the reduced or canonical form syntax described in
-.Sx Dates .
+Recommended formats of arguments are
+.Ar month day , year
+or just
+.Ar year .

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


@@ -937,8 +939,8 @@ Memory address.
 Do not use this for postal addresses.
 .Pp
 Examples:
 Do not use this for postal addresses.
 .Pp
 Examples:

-.D1 \&.Ad [0,$]
-.D1 \&.Ad 0x00000000
+.Dl \&.Ad [0,$]
+.Dl \&.Ad 0x00000000

 .Ss \&An
 Author name.
 Requires either the name of an author or one of the following arguments:
 .Ss \&An
 Author name.
 Requires either the name of an author or one of the following arguments:


@@ -968,14 +970,14 @@ for the first author listing and
 for all other author listings.
 .Pp
 Examples:
 for all other author listings.
 .Pp
 Examples:

-.D1 \&.An -nosplit
-.D1 \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv
+.Dl \&.An -nosplit
+.Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv

 .Ss \&Ao
 Begin a block enclosed by angle brackets.
 Does not have any head arguments.
 .Pp
 Examples:
 .Ss \&Ao
 Begin a block enclosed by angle brackets.
 Does not have any head arguments.
 .Pp
 Examples:

-.D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
+.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac

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


@@ -985,12 +987,12 @@ This is generally used as a grammatical device when referring to the verb
 form of a function.
 .Pp
 Examples:
 form of a function.
 .Pp
 Examples:

-.D1 \&.Fn execve \&Ap d
+.Dl \&.Fn execve \&Ap d

 .Ss \&Aq
 Encloses its arguments in angle brackets.
 .Pp
 Examples:
 .Ss \&Aq
 Encloses its arguments in angle brackets.
 .Pp
 Examples:

-.D1 \&.Fl -key= \&Ns \&Aq \&Ar val
+.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


@@ -1011,9 +1013,9 @@ If an argument is not provided, the string
 is used as a default.
 .Pp
 Examples:
 is used as a default.
 .Pp
 Examples:

-.D1 \&.Fl o \&Ns \&Ar file1
-.D1 \&.Ar
-.D1 \&.Ar arg1 , arg2 .
+.Dl \&.Fl o \&Ns \&Ar file1
+.Dl \&.Ar
+.Dl \&.Ar arg1 , arg2 .

 .Ss \&At
 Formats an AT&T version.
 Accepts one optional argument:
 .Ss \&At
 Formats an AT&T version.
 Accepts one optional argument:


@@ -1030,8 +1032,8 @@ A version of
 Note that these arguments do not begin with a hyphen.
 .Pp
 Examples:
 Note that these arguments do not begin with a hyphen.
 .Pp
 Examples:

-.D1 \&.At
-.D1 \&.At V.1
+.Dl \&.At
+.Dl \&.At V.1

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


@@ -1059,7 +1061,7 @@ Its syntax is as follows:
 .Pp
 Display blocks are used to select a different indentation and
 justification than the one used by the surrounding text.
 .Pp
 Display blocks are used to select a different indentation and
 justification than the one used by the surrounding text.

-They may contain both macro lines and free-form text lines.
+They may contain both macro lines and text lines.

 By default, a display block is preceded by a vertical space.
 .Pp
 The
 By default, a display block is preceded by a vertical space.
 .Pp
 The


@@ -1176,7 +1178,7 @@ and
 .Ss \&Bk
 Keep the output generated from each macro input line together
 on one single output line.
 .Ss \&Bk
 Keep the output generated from each macro input line together
 on one single output line.

-Line breaks in free-form text lines are unaffected.
+Line breaks in text lines are unaffected.

 The syntax is as follows:
 .Pp
 .D1 Pf \. Sx \&Bk Fl words
 The syntax is as follows:
 .Pp
 .D1 Pf \. Sx \&Bk Fl words


@@ -1199,7 +1201,7 @@ Be careful in using over-long lines within a keep block!
 Doing so will clobber the right margin.
 .Ss \&Bl
 Begin a list.
 Doing so will clobber the right margin.
 .Ss \&Bl
 Begin a list.

-Lists consist of items started by the
+Lists consist of items specified using the

 .Sx \&It
 macro, containing a head or a body or both.
 The list syntax is as follows:
 .Sx \&It
 macro, containing a head or a body or both.
 The list syntax is as follows:


@@ -1334,7 +1336,7 @@ See also
 Encloses its arguments in square brackets.
 .Pp
 Examples:
 Encloses its arguments in square brackets.
 .Pp
 Examples:

-.D1 \&.Bq 1 , \&Dv BUFSIZ
+.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


@@ -1367,7 +1369,7 @@ See also
 Encloses its arguments in curly braces.
 .Pp
 Examples:
 Encloses its arguments in curly braces.
 .Pp
 Examples:

-.D1 \&.Brq 1 , ... , \&Va n
+.Dl \&.Brq 1 , ... , \&Va n

 .Pp
 See also
 .Sx \&Bro .
 .Pp
 See also
 .Sx \&Bro .


@@ -1376,8 +1378,8 @@ Format the BSD/OS version provided as an argument, or a default value if
 no argument is provided.
 .Pp
 Examples:
 no argument is provided.
 .Pp
 Examples:

-.D1 \&.Bsx 1.0
-.D1 \&.Bsx
+.Dl \&.Bsx 1.0
+.Dl \&.Bsx

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


@@ -1396,8 +1398,8 @@ Format the BSD version provided as an argument, or a default value if no
 argument is provided.
 .Pp
 Examples:
 argument is provided.
 .Pp
 Examples:

-.D1 \&.Bx 4.4
-.D1 \&.Bx
+.Dl \&.Bx 4.4
+.Dl \&.Bx

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


@@ -1414,7 +1416,7 @@ This denotes strings accepted by
 .Xr config 8 .
 .Pp
 Examples:
 .Xr config 8 .
 .Pp
 Examples:

-.D1 \&.Cd device le0 at scode?
+.Dl \&.Cd device le0 at scode?

 .Pp
 .Em Remarks :
 this macro is commonly abused by using quoted literals to retain
 .Pp
 .Em Remarks :
 this macro is commonly abused by using quoted literals to retain


@@ -1427,8 +1429,8 @@ Command modifiers.
 Useful when specifying configuration options or keys.
 .Pp
 Examples:
 Useful when specifying configuration options or keys.
 .Pp
 Examples:

-.D1 \&.Cm ControlPath
-.D1 \&.Cm ControlMaster
+.Dl \&.Cm ControlPath
+.Dl \&.Cm ControlMaster

 .Pp
 See also
 .Sx \&Fl .
 .Pp
 See also
 .Sx \&Fl .


@@ -1439,7 +1441,7 @@ statements.
 It is followed by a newline.
 .Pp
 Examples:
 It is followed by a newline.
 .Pp
 Examples:

-.D1 \&.D1 \&Fl abcdefgh
+.Dl \&.D1 \&Fl abcdefgh

 .Pp
 See also
 .Sx \&Bd
 .Pp
 See also
 .Sx \&Bd


@@ -1465,22 +1467,41 @@ This is the mandatory first macro of any
 manual.
 Its syntax is as follows:
 .Pp
 manual.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Dd Op Ar date
+.D1 Pf \. Sx \&Dd Ar month day , year

 .Pp
 The
 .Pp
 The

-.Ar date
-may be either
-.Ar $\&Mdocdate$ ,
-which signifies the current manual revision date dictated by
+.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 ,
 .Xr cvs 1 ,

-or instead a valid canonical date as specified by
-.Sx Dates .
-If a date does not conform or is empty, the current date is used.
+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:
 .Pp
 Examples:

-.D1 \&.Dd $\&Mdocdate$
-.D1 \&.Dd $\&Mdocdate: July 21 2007$
-.D1 \&.Dd July 21, 2007
+.Dl \&.Dd $\&Mdocdate$
+.Dl \&.Dd $\&Mdocdate: July 21 2007$
+.Dl \&.Dd July 21, 2007

 .Pp
 See also
 .Sx \&Dt
 .Pp
 See also
 .Sx \&Dt


@@ -1493,7 +1514,7 @@ invocations.
 It is followed by a newline.
 .Pp
 Examples:
 It is followed by a newline.
 .Pp
 Examples:

-.D1 \&.Dl % mandoc mdoc.7 \e(ba less
+.Dl \&.Dl % mandoc mdoc.7 \e(ba less

 .Pp
 See also
 .Sx \&Bd
 .Pp
 See also
 .Sx \&Bd


@@ -1645,6 +1666,7 @@ It must be one of
 .Ar luna88k ,
 .Ar mac68k ,
 .Ar macppc ,
 .Ar luna88k ,
 .Ar mac68k ,
 .Ar macppc ,

+.Ar mips64 ,

 .Ar mvme68k ,
 .Ar mvme88k ,
 .Ar mvmeppc ,
 .Ar mvme68k ,
 .Ar mvme88k ,
 .Ar mvmeppc ,


@@ -1660,9 +1682,9 @@ or
 .El
 .Pp
 Examples:
 .El
 .Pp
 Examples:

-.D1 \&.Dt FOO 1
-.D1 \&.Dt FOO 4 KM
-.D1 \&.Dt FOO 9 i386
+.Dl \&.Dt FOO 1
+.Dl \&.Dt FOO 4 KM
+.Dl \&.Dt FOO 9 i386

 .Pp
 See also
 .Sx \&Dd
 .Pp
 See also
 .Sx \&Dd


@@ -1672,8 +1694,8 @@ and
 Defined variables such as preprocessor constants.
 .Pp
 Examples:
 Defined variables such as preprocessor constants.
 .Pp
 Examples:

-.D1 \&.Dv BUFSIZ
-.D1 \&.Dv STDOUT_FILENO
+.Dl \&.Dv BUFSIZ
+.Dl \&.Dv STDOUT_FILENO

 .Pp
 See also
 .Sx \&Er .
 .Pp
 See also
 .Sx \&Er .


@@ -1682,8 +1704,8 @@ Format the DragonFly BSD version provided as an argument, or a default
 value if no argument is provided.
 .Pp
 Examples:
 value if no argument is provided.
 .Pp
 Examples:

-.D1 \&.Dx 2.4.1
-.D1 \&.Dx
+.Dl \&.Dx 2.4.1
+.Dl \&.Dx

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


@@ -1729,8 +1751,8 @@ Note that this is a presentation term and should not be used for
 stylistically decorating technical terms.
 .Pp
 Examples:
 stylistically decorating technical terms.
 .Pp
 Examples:

-.D1 \&.Em Warnings!
-.D1 \&.Em Remarks :
+.Dl \&.Em Warnings!
+.Dl \&.Em Remarks :

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


@@ -1755,8 +1777,8 @@ will emulate
 Display error constants.
 .Pp
 Examples:
 Display error constants.
 .Pp
 Examples:

-.D1 \&.Er EPERM
-.D1 \&.Er ENOENT
+.Dl \&.Er EPERM
+.Dl \&.Er ENOENT

 .Pp
 See also
 .Sx \&Dv .
 .Pp
 See also
 .Sx \&Dv .


@@ -1767,8 +1789,8 @@ Environmental variables such as those specified in
 .Xr environ 7 .
 .Pp
 Examples:
 .Xr environ 7 .
 .Pp
 Examples:

-.D1 \&.Ev DISPLAY
-.D1 \&.Ev PATH
+.Dl \&.Ev DISPLAY
+.Dl \&.Ev PATH

 .Ss \&Ex
 Insert a standard sentence regarding exit values.
 Its syntax is as follows:
 .Ss \&Ex
 Insert a standard sentence regarding exit values.
 Its syntax is as follows:


@@ -1808,9 +1830,9 @@ Furthermore, if the following macro is another
 the last argument will also have a trailing comma.
 .Pp
 Examples:
 the last argument will also have a trailing comma.
 .Pp
 Examples:

-.D1 \&.Fa \(dqconst char *p\(dq
-.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
-.D1 \&.Fa foo
+.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 .
 .Pp
 See also
 .Sx \&Fo .


@@ -1838,10 +1860,10 @@ If the argument is a macro, a hyphen is prefixed to the subsequent macro
 output.
 .Pp
 Examples:
 output.
 .Pp
 Examples:

-.D1 \&.Fl a b c
-.D1 \&.Fl \&Pf a b
-.D1 \&.Fl
-.D1 \&.Op \&Fl o \&Ns \&Ar file
+.Dl \&.Fl a b c
+.Dl \&.Fl \&Pf a b
+.Dl \&.Fl
+.Dl \&.Op \&Fl o \&Ns \&Ar file

 .Pp
 See also
 .Sx \&Cm .
 .Pp
 See also
 .Sx \&Cm .


@@ -1850,9 +1872,9 @@ A function name.
 Its syntax is as follows:
 .Bd -ragged -offset indent
 .Pf \. Ns Sx \&Fn
 Its syntax is as follows:
 .Bd -ragged -offset indent
 .Pf \. Ns Sx \&Fn

-.Op Cm functype
-.Cm funcname
-.Op Oo Cm argtype Oc Cm argname
+.Op Ar functype
+.Ar funcname
+.Op Oo Ar argtype Oc Ar argname

 .Ed
 .Pp
 Function arguments are surrounded in parenthesis and
 .Ed
 .Pp
 Function arguments are surrounded in parenthesis and


@@ -1860,14 +1882,17 @@ are delimited by commas.
 If no arguments are specified, blank parenthesis are output.
 .Pp
 Examples:
 If no arguments are specified, blank parenthesis are output.
 .Pp
 Examples:

-.D1 \&.Fn "int funcname" "int arg0" "int arg1"
-.D1 \&.Fn funcname "int arg0"
-.D1 \&.Fn funcname arg0
+.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
 .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
 See also
 .Sx MANUAL STRUCTURE
 and


@@ -1878,17 +1903,17 @@ This is a multi-line version of
 .Sx \&Fn .
 Its syntax is as follows:
 .Pp
 .Sx \&Fn .
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Fo Cm funcname
+.D1 Pf \. Sx \&Fo Ar funcname

 .Pp
 Invocations usually occur in the following context:
 .Bd -ragged -offset indent
 .Pp
 Invocations usually occur in the following context:
 .Bd -ragged -offset indent

-.Pf \. Sx \&Ft Cm functype
+.Pf \. Sx \&Ft Ar functype

 .br
 .br

-.Pf \. Sx \&Fo Cm funcname
+.Pf \. Sx \&Fo Ar funcname

 .br
 .br

-.Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname
+.Pf \. Sx \&Fa Oo Ar argtype Oc Ar argname

 .br
 .br

-\.\.\.
+\&.\.\.

 .br
 .Pf \. Sx \&Fc
 .Ed
 .br
 .Pf \. Sx \&Fc
 .Ed


@@ -1907,10 +1932,10 @@ and
 A function type.
 Its syntax is as follows:
 .Pp
 A function type.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Ft Cm functype
+.D1 Pf \. Sx \&Ft Ar functype

 .Pp
 Examples:
 .Pp
 Examples:

-.D1 \&.Ft int
+.Dl \&.Ft int

 .Bd -literal -offset indent -compact
 \&.Ft functype
 \&.Fn funcname
 .Bd -literal -offset indent -compact
 \&.Ft functype
 \&.Fn funcname


@@ -1928,8 +1953,8 @@ version provided as an argument, or a default value
 if no argument is provided.
 .Pp
 Examples:
 if no argument is provided.
 .Pp
 Examples:

-.D1 \&.Fx 7.1
-.D1 \&.Fx
+.Dl \&.Fx 7.1
+.Dl \&.Fx

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


@@ -1949,8 +1974,8 @@ This is similar to
 but used for instructions rather than values.
 .Pp
 Examples:
 but used for instructions rather than values.
 .Pp
 Examples:

-.D1 \&.Ic hash
-.D1 \&.Ic alias
+.Dl \&.Ic hash
+.Dl \&.Ic alias

 .Pp
 Note that using
 .Sx \&Bd Fl literal
 .Pp
 Note that using
 .Sx \&Bd Fl literal


@@ -1971,7 +1996,7 @@ preceded by
 the arguments is enclosed in angle brackets.
 .Pp
 Examples:
 the arguments is enclosed in angle brackets.
 .Pp
 Examples:

-.D1 \&.In sys/types
+.Dl \&.In sys/types

 .Pp
 See also
 .Sx MANUAL STRUCTURE .
 .Pp
 See also
 .Sx MANUAL STRUCTURE .


@@ -1988,7 +2013,7 @@ and
 .Fl diag
 have the following syntax:
 .Pp
 .Fl diag
 have the following syntax:
 .Pp

-.D1 Pf \. Sx \&It Cm args
+.D1 Pf \. Sx \&It Ar args

 .Pp
 Lists of type
 .Fl bullet ,
 .Pp
 Lists of type
 .Fl bullet ,


@@ -2051,7 +2076,7 @@ phrases on an
 .Sx \&It ,
 for example,
 .Pp
 .Sx \&It ,
 for example,
 .Pp

-.D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
+.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;

 .Pp
 will preserve the semicolon whitespace except for the last.
 .Pp
 .Pp
 will preserve the semicolon whitespace except for the last.
 .Pp


@@ -2061,14 +2086,14 @@ See also
 Specify a library.
 The syntax is as follows:
 .Pp
 Specify a library.
 The syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Lb Cm library
+.D1 Pf \. Sx \&Lb Ar library

 .Pp
 The
 .Pp
 The

-.Cm library
+.Ar library

 parameter may be a system library, such as
 parameter may be a system library, such as

-.Cm libz
+.Ar libz

 or
 or

-.Cm libpam ,
+.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.
 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.


@@ -2078,8 +2103,8 @@ section as described in
 .Sx MANUAL STRUCTURE .
 .Pp
 Examples:
 .Sx MANUAL STRUCTURE .
 .Pp
 Examples:

-.D1 \&.Lb libz
-.D1 \&.Lb mdoc
+.Dl \&.Lb libz
+.Dl \&.Lb mdoc

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


@@ -2094,11 +2119,11 @@ and
 Format a hyperlink.
 Its syntax is as follows:
 .Pp
 Format a hyperlink.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Lk Cm uri Op Cm name
+.D1 Pf \. Sx \&Lk Ar uri Op Ar name

 .Pp
 Examples:
 .Pp
 Examples:

-.D1 \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q
-.D1 \&.Lk http://bsd.lv
+.Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q
+.Dl \&.Lk http://bsd.lv

 .Pp
 See also
 .Sx \&Mt .
 .Pp
 See also
 .Sx \&Mt .


@@ -2109,21 +2134,21 @@ Synonym for
 Display a mathematical symbol.
 Its syntax is as follows:
 .Pp
 Display a mathematical symbol.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Ms Cm symbol
+.D1 Pf \. Sx \&Ms Ar symbol

 .Pp
 Examples:
 .Pp
 Examples:

-.D1 \&.Ms sigma
-.D1 \&.Ms aleph
+.Dl \&.Ms sigma
+.Dl \&.Ms aleph

 .Ss \&Mt
 Format a
 .Dq mailto:
 hyperlink.
 Its syntax is as follows:
 .Pp
 .Ss \&Mt
 Format a
 .Dq mailto:
 hyperlink.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Mt Cm address
+.D1 Pf \. Sx \&Mt Ar address

 .Pp
 Examples:
 .Pp
 Examples:

-.D1 \&.Mt discuss@manpages.bsd.lv
+.Dl \&.Mt discuss@manpages.bsd.lv

 .Ss \&Nd
 A one line description of the manual's content.
 This may only be invoked in the
 .Ss \&Nd
 A one line description of the manual's content.
 This may only be invoked in the


@@ -2133,8 +2158,8 @@ section subsequent the
 macro.
 .Pp
 Examples:
 macro.
 .Pp
 Examples:

-.D1 \&.Sx \&Nd mdoc language reference
-.D1 \&.Sx \&Nd format and display UNIX manuals
+.Dl \&.Sx \&Nd mdoc language reference
+.Dl \&.Sx \&Nd format and display UNIX manuals

 .Pp
 The
 .Sx \&Nd
 .Pp
 The
 .Sx \&Nd


@@ -2191,14 +2216,16 @@ A
 macro used to terminate prior macro contexts.
 .Pp
 Examples:
 macro used to terminate prior macro contexts.
 .Pp
 Examples:

-.D1 \&.Sx \&Fl ab \&No cd \&Fl ef
+.Dl \&.Sx \&Fl ab \&No cd \&Fl ef

 .Ss \&Ns
 Suppress a space.
 Following invocation, text is interpreted as free-form text until a
 macro is encountered.
 .Pp
 .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:
 Examples:

-.D1 \&.Fl o \&Ns \&Ar output
+.Dl \&.Fl o \&Ns \&Ar output

 .Pp
 See also
 .Sx \&No
 .Pp
 See also
 .Sx \&No


@@ -2211,8 +2238,8 @@ version provided as an argument, or a default value if
 no argument is provided.
 .Pp
 Examples:
 no argument is provided.
 .Pp
 Examples:

-.D1 \&.Nx 5.01
-.D1 \&.Nx
+.Dl \&.Nx 5.01
+.Dl \&.Nx

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


@@ -2243,8 +2270,8 @@ Used when listing options to command-line utilities.
 Prints the argument(s) in brackets.
 .Pp
 Examples:
 Prints the argument(s) in brackets.
 .Pp
 Examples:

-.D1 \&.Op \&Fl a \&Ar b
-.D1 \&.Op \&Ar a | b
+.Dl \&.Op \&Fl a \&Ar b
+.Dl \&.Op \&Ar a | b

 .Pp
 See also
 .Sx \&Oo .
 .Pp
 See also
 .Sx \&Oo .


@@ -2256,18 +2283,18 @@ any
 file.
 Its syntax is as follows:
 .Pp
 file.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Os Op Cm system Op Cm version
+.D1 Pf \. Sx \&Os Op Ar system Op Ar version

 .Pp
 The optional
 .Pp
 The optional

-.Cm system
+.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:
 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:

-.D1 \&.Os
-.D1 \&.Os KTH/CSC/TCS
-.D1 \&.Os BSD 4.3
+.Dl \&.Os
+.Dl \&.Os KTH/CSC/TCS
+.Dl \&.Os BSD 4.3

 .Pp
 See also
 .Sx \&Dd
 .Pp
 See also
 .Sx \&Dd


@@ -2285,8 +2312,8 @@ version provided as an argument, or a default value
 if no argument is provided.
 .Pp
 Examples:
 if no argument is provided.
 .Pp
 Examples:

-.D1 \&.Ox 4.5
-.D1 \&.Ox
+.Dl \&.Ox 4.5
+.Dl \&.Ox

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


@@ -2299,10 +2326,13 @@ and
 .Sx \&Ux .
 .Ss \&Pa
 A file-system path.
 .Sx \&Ux .
 .Ss \&Pa
 A file-system path.

+If an argument is not provided, the string
+.Dq \(ti
+is used as a default.

 .Pp
 Examples:
 .Pp
 Examples:

-.D1 \&.Pa /usr/bin/mandoc
-.D1 \&.Pa /usr/share/man/man7/mdoc.7
+.Dl \&.Pa /usr/bin/mandoc
+.Dl \&.Pa /usr/share/man/man7/mdoc.7

 .Pp
 See also
 .Sx \&Lk .
 .Pp
 See also
 .Sx \&Lk .


@@ -2315,14 +2345,14 @@ Removes the space
 between its arguments.
 Its syntax is as follows:
 .Pp
 between its arguments.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. \&Pf Cm prefix suffix
+.D1 Pf \. \&Pf Ar prefix suffix

 .Pp
 The
 .Pp
 The

-.Cm suffix
+.Ar suffix

 argument may be a macro.
 .Pp
 Examples:
 argument may be a macro.
 .Pp
 Examples:

-.D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix
+.Dl \&.Pf \e. \&Sx \&Pf \&Ar prefix suffix

 .Ss \&Po
 Multi-line version of
 .Sx \&Pq .
 .Ss \&Po
 Multi-line version of
 .Sx \&Pq .


@@ -2443,11 +2473,11 @@ Its syntax is as follows:
 .D1 Pf \. Sx \&Sm Cm on | off
 .Pp
 By default, spacing is
 .D1 Pf \. Sx \&Sm Cm on | off
 .Pp
 By default, spacing is

-.Cm on .
+.Ar on .

 When switched
 When switched

-.Cm off ,
+.Ar off ,

 no white space is inserted between macro arguments and between the
 no white space is inserted between macro arguments and between the

-output generated from adjacent macros, but free-form text lines
+output generated from adjacent macros, but text lines

 still get normal spacing between words and sentences.
 .Ss \&So
 Multi-line version of
 still get normal spacing between words and sentences.
 .Ss \&So
 Multi-line version of


@@ -2582,7 +2612,12 @@ The referenced section or sub-section name must be identical to the
 enclosed argument, including whitespace.
 .Pp
 Examples:
 enclosed argument, including whitespace.
 .Pp
 Examples:

-.D1 \&.Sx MANUAL STRUCTURE
+.Dl \&.Sx MANUAL STRUCTURE
+.Pp
+See also
+.Sx \&Sh
+and
+.Sx \&Ss .

 .Ss \&Sy
 Format enclosed arguments in symbolic
 .Pq Dq boldface .
 .Ss \&Sy
 Format enclosed arguments in symbolic
 .Pq Dq boldface .


@@ -2598,7 +2633,7 @@ and
 Format a tradename.
 .Pp
 Examples:
 Format a tradename.
 .Pp
 Examples:

-.D1 \&.Tn IBM
+.Dl \&.Tn IBM

 .Ss \&Ud
 Prints out
 .Dq currently under development .
 .Ss \&Ud
 Prints out
 .Dq currently under development .


@@ -2607,7 +2642,7 @@ Format the UNIX name.
 Accepts no argument.
 .Pp
 Examples:
 Accepts no argument.
 .Pp
 Examples:

-.D1 \&.Ux
+.Dl \&.Ux

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


@@ -2622,8 +2657,8 @@ and
 A variable name.
 .Pp
 Examples:
 A variable name.
 .Pp
 Examples:

-.D1 \&.Va foo
-.D1 \&.Va const char *bar ;
+.Dl \&.Va foo
+.Dl \&.Va const char *bar ;

 .Ss \&Vt
 A variable type.
 This is also used for indicating global variables in the
 .Ss \&Vt
 A variable type.
 This is also used for indicating global variables in the


@@ -2642,8 +2677,8 @@ Note that this should not be confused with
 which is used for function return types.
 .Pp
 Examples:
 which is used for function return types.
 .Pp
 Examples:

-.D1 \&.Vt unsigned char
-.D1 \&.Vt extern const char * const sys_signame[] \&;
+.Dl \&.Vt unsigned char
+.Dl \&.Vt extern const char * const sys_signame[] \&;

 .Pp
 See also
 .Sx MANUAL STRUCTURE
 .Pp
 See also
 .Sx MANUAL STRUCTURE


@@ -2653,23 +2688,27 @@ and
 Close a scope opened by
 .Sx \&Xo .
 .Ss \&Xo
 Close a scope opened by
 .Sx \&Xo .
 .Ss \&Xo

-Open an extension scope.
-This macro originally existed to extend the 9-argument limit of troff;
-since this limit has been lifted, the macro has been deprecated.
+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
 Link to another manual
 .Pq Qq cross-reference .
 Its syntax is as follows:
 .Pp
 .Ss \&Xr
 Link to another manual
 .Pq Qq cross-reference .
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Xr Cm name section
+.D1 Pf \. Sx \&Xr Ar name section

 .Pp
 The
 .Pp
 The

-.Cm name
+.Ar name

 and
 and

-.Cm section
+.Ar section

 are the name and section of the linked manual.
 If
 are the name and section of the linked manual.
 If

-.Cm section
+.Ar section

 is followed by non-punctuation, an
 .Sx \&Ns
 is inserted into the token stream.
 is followed by non-punctuation, an
 .Sx \&Ns
 is inserted into the token stream.


@@ -2677,9 +2716,9 @@ This behaviour is for compatibility with
 GNU troff.
 .Pp
 Examples:
 GNU troff.
 .Pp
 Examples:

-.D1 \&.Xr mandoc 1
-.D1 \&.Xr mandoc 1 \&;
-.D1 \&.Xr mandoc 1 \&Ns s behaviour
+.Dl \&.Xr mandoc 1
+.Dl \&.Xr mandoc 1 \&;
+.Dl \&.Xr mandoc 1 \&Ns s behaviour

 .Ss \&br
 Emits a line-break.
 This macro should not be used; it is implemented for compatibility with
 .Ss \&br
 Emits a line-break.
 This macro should not be used; it is implemented for compatibility with


@@ -2694,10 +2733,10 @@ This macro should not be used; it is implemented for compatibility with
 historical manuals.
 Its syntax is as follows:
 .Pp
 historical manuals.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&sp Op Cm height
+.D1 Pf \. Sx \&sp Op Ar height

 .Pp
 The
 .Pp
 The

-.Cm height
+.Ar height

 argument must be formatted as described in
 .Sx Scaling Widths .
 If unspecified,
 argument must be formatted as described in
 .Sx Scaling Widths .
 If unspecified,


@@ -2709,10 +2748,10 @@ troff implementations, at this time limited to GNU troff
 .Pq Qq groff .
 The term
 .Qq historic groff
 .Pq Qq groff .
 The term
 .Qq historic groff

-refers to groff 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
 Heirloom troff, the other significant troff implementation accepting
 \-mdoc, is similar to historic groff.


@@ -2722,6 +2761,16 @@ The following problematic behaviour is found in groff:
 .Pp
 .Bl -dash -compact
 .It
 .Pp
 .Bl -dash -compact
 .It

+Display macros
+.Po
+.Sx \&Bd ,
+.Sx \&Dl ,
+and
+.Sx \&D1
+.Pc
+may not be nested.
+\*[hist]
+.It

 .Sx \&At
 with unknown arguments produces no output at all.
 \*[hist]
 .Sx \&At
 with unknown arguments produces no output at all.
 \*[hist]


@@ -2739,9 +2788,12 @@ does not start a new line.
 \*[hist]
 .It
 .Sx \&Dd
 \*[hist]
 .It
 .Sx \&Dd

-without an argument prints
-.Dq Epoch .
-In mandoc, it resolves to the current date.
+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
 .Sx \&Fl
 does not print a dash for an empty argument.
 .It
 .Sx \&Fl
 does not print a dash for an empty argument.


@@ -2803,6 +2855,11 @@ can only be called by other macros, but not at the beginning of a line.
 .Sx \&%C
 is not implemented.
 .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.
 Historic groff has many un-callable macros.
 Most of these (excluding some block-level macros) are callable
 in new groff and mandoc.


@@ -2868,8 +2925,13 @@ standalone double-quote in formatted output.
 This is not supported by mandoc.
 .El
 .Sh SEE ALSO
 This is not supported by mandoc.
 .El
 .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
 .Sh HISTORY
 The
 .Nm