===================================================================
RCS file: /cvs/mandoc/mdoc.7,v
retrieving revision 1.87
retrieving revision 1.93
diff -u -p -r1.87 -r1.93
--- mandoc/mdoc.7	2010/03/31 07:13:53	1.87
+++ mandoc/mdoc.7	2010/04/07 19:37:54	1.93
@@ -1,4 +1,4 @@
-.\"	$Id: mdoc.7,v 1.87 2010/03/31 07:13:53 kristaps Exp $
+.\"	$Id: mdoc.7,v 1.93 2010/04/07 19:37:54 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: March 31 2010 $
+.Dd $Mdocdate: April 7 2010 $
 .Dt MDOC 7
 .Os
 .
@@ -31,12 +31,9 @@ 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
+and usage.  Our reference implementation is mandoc; the
 .Sx COMPATIBILITY
-section describes compatibility with
-.Xr groff 1 .
+section describes compatibility with other troff \-mdoc implementations.
 .
 .Pp
 An
@@ -860,7 +857,7 @@ then the macro accepts an arbitrary number of argument
 .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
@@ -974,10 +971,8 @@ Address construct: usually in the context of an comput
 memory, not a physical (post) address.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Ad [0,$]
-\&.Ad 0x00000000
-.Ed
+.D1 \&.Ad [0,$]
+.D1 \&.Ad 0x00000000
 .
 .Ss \&An
 Author name.  This macro may alternatively accepts the following
@@ -998,11 +993,8 @@ will cause the first listing also to be split.  If not
 section, the default is not to split.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.An -nosplit
-\&.An J. E. Hopcraft ,
-\&.An J. D. Ullman .
-.Ed
+.D1 \&.An -nosplit
+.D1 \&.An J. D. Ullman .
 .Pp
 .Em Remarks :
 the effects of
@@ -1019,9 +1011,7 @@ Begins a block enclosed by angled brackets.  Does not 
 arguments.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Fl -key= Ns Ao Ar val Ac
-.Ed
+.D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
 .Pp
 See also
 .Sx \&Aq .
@@ -1038,9 +1028,7 @@ a function:
 Encloses its arguments in angled brackets.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Fl -key= Ns Aq Ar val
-.Ed
+.D1 \&.Fl -key= \&Ns \&Aq \&Ar val
 .Pp
 .Em Remarks :
 this macro is often abused for rendering URIs, which should instead use
@@ -1061,11 +1049,9 @@ Command arguments.  If an argument is not provided, th
 is used as a default.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Fl o Ns Ar file1
-\&.Ar
-\&.Ar arg1 , arg2 .
-.Ed
+.D1 \&.Fl o \&Ns \&Ar file1
+.D1 \&.Ar
+.D1 \&.Ar arg1 , arg2 .
 .
 .Ss \&At
 Formats an AT&T version.  Accepts at most one parameter:
@@ -1081,10 +1067,8 @@ A system version of
 Note that these parameters do not begin with a hyphen.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.At
-\&.At V.1
-.Ed
+.D1 \&.At
+.D1 \&.At V.1
 .Pp
 See also
 .Sx \&Bsx ,
@@ -1244,7 +1228,7 @@ arguments.
 Examples:
 .Bd -literal -offset indent
 \&.Bo 1 ,
-\&.Dv BUFSIZ Bc
+\&.Dv BUFSIZ \&Bc
 .Ed
 .Pp
 See also
@@ -1254,9 +1238,7 @@ See also
 Encloses its arguments in square brackets.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Bq 1 , Dv BUFSIZ
-.Ed
+.D1 \&.Bq 1 , \&Dv BUFSIZ
 .Pp
 .Em Remarks :
 this macro is sometimes abused to emulate optional arguments for
@@ -1281,7 +1263,7 @@ arguments.
 Examples:
 .Bd -literal -offset indent
 \&.Bro 1 , ... ,
-\&.Va n Brc
+\&.Va n \&Brc
 .Ed
 .Pp
 See also
@@ -1291,9 +1273,7 @@ See also
 Encloses its arguments in curly braces.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Brq 1 , ... , Va n
-.Ed
+.D1 \&.Brq 1 , ... , \&Va n
 .Pp
 See also
 .Sx \&Bro .
@@ -1303,10 +1283,8 @@ Format the BSD/OS version provided as an argument, or 
 no argument is provided.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Bsx 1.0
-\&.Bsx
-.Ed
+.D1 \&.Bsx 1.0
+.D1 \&.Bsx
 .Pp
 See also
 .Sx \&At ,
@@ -1327,10 +1305,8 @@ Format the BSD version provided as an argument, or a d
 argument is provided.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Bx 4.4
-\&.Bx
-.Ed
+.D1 \&.Bx 4.4
+.D1 \&.Bx
 .Pp
 See also
 .Sx \&At ,
@@ -1343,14 +1319,11 @@ and
 .Sx \&Ux .
 .
 .Ss \&Cd
-Configuration declaration (suggested for use only in section four
-manuals).  This denotes strings accepted by
+Configuration declaration.  This denotes strings accepted by
 .Xr config 8 .
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Cd device le0 at scode?
-.Ed
+.D1 \&.Cd device le0 at scode?
 .Pp
 .Em Remarks :
 this macro is commonly abused by using quoted literals to retain
@@ -1363,10 +1336,8 @@ Command modifiers.  Useful when specifying configurati
 keys.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Cm ControlPath
-\&.Cm ControlMaster
-.Ed
+.D1 \&.Cm ControlPath
+.D1 \&.Cm ControlMaster
 .Pp
 See also
 .Sx \&Fl .
@@ -1376,9 +1347,7 @@ One-line indented display.  This is formatted by the d
 is useful for simple indented statements.  It is followed by a newline.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.D1 Fl abcdefgh
-.Ed
+.D1 \&.D1 \&Fl abcdefgh
 .Pp
 See also
 .Sx \&Bd
@@ -1409,11 +1378,9 @@ or instead a valid canonical date as specified by
 If a date does not conform, the current date is used instead.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Dd $\&Mdocdate$
-\&.Dd $\&Mdocdate: July 21 2007$
-\&.Dd July 21, 2007
-.Ed
+.D1 \&.Dd $\&Mdocdate$
+.D1 \&.Dd $\&Mdocdate: July 21 2007$
+.D1 \&.Dd July 21, 2007
 .Pp
 See also
 .Sx \&Dt
@@ -1425,9 +1392,7 @@ One-line intended display.  This is formatted as liter
 useful for commands and invocations.  It is followed by a newline.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Dl % mandoc mdoc.7 | less
-.Ed
+.D1 \&.Dl % mandoc mdoc.7 | less
 .Pp
 See also
 .Sx \&Bd
@@ -1439,9 +1404,7 @@ Begins a block enclosed by double quotes.  Does not ha
 arguments.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.D1 Do April is the cruellest month Dc \e(em T.S. Eliot
-.Ed
+.D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot
 .Pp
 See also
 .Sx \&Dq .
@@ -1450,7 +1413,7 @@ See also
 Encloses its arguments in double quotes.
 .Pp
 Examples:
-.Bd -literal -offset indent
+.Bd -literal -offset indent -compact
 \&.Dq April is the cruellest month
 \e(em T.S. Eliot
 .Ed
@@ -1572,12 +1535,10 @@ or
 .El
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Dt FOO 1
-\&.Dt FOO 4 KM
-\&.Dt FOO 9 i386
-\&.Dt FOO 9 KM i386
-.Ed
+.D1 \&.Dt FOO 1
+.D1 \&.Dt FOO 4 KM
+.D1 \&.Dt FOO 9 i386
+.D1 \&.Dt FOO 9 KM i386
 .Pp
 See also
 .Sx \&Dd
@@ -1588,10 +1549,8 @@ and
 Defined variables such as preprocessor constants.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Dv BUFSIZ
-\&.Dv STDOUT_FILENO
-.Ed
+.D1 \&.Dv BUFSIZ
+.D1 \&.Dv STDOUT_FILENO
 .Pp
 See also
 .Sx \&Er .
@@ -1601,10 +1560,8 @@ Format the DragonFly BSD version provided as an argume
 value if no argument is provided.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Dx 2.4.1
-\&.Dx
-.Ed
+.D1 \&.Dx 2.4.1
+.D1 \&.Dx
 .Pp
 See also
 .Sx \&At ,
@@ -1621,27 +1578,24 @@ and
 .Ss \&Ef
 .Ss \&Ek
 .Ss \&El
+.
 .Ss \&Em
 Denotes text that should be emphasised.  Note that this is a
 presentation term and should not be used for stylistically decorating
 technical terms.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Ed Warnings!
-\&.Ed Remarks :
-.Ed
+.D1 \&.Em Warnings!
+.D1 \&.Em Remarks :
 .
 .Ss \&En
 .Ss \&Eo
 .Ss \&Er
-Error constants (suggested for use only in section two manuals).
+Display error constants.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Er EPERM
-\&.Er ENOENT
-.Ed
+.D1 \&.Er EPERM
+.D1 \&.Er ENOENT
 .Pp
 See also
 .Sx \&Dv .
@@ -1653,10 +1607,8 @@ Environmental variables such as those specified in
 .Xr environ 7 .
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Ev DISPLAY
-\&.Ev PATH
-.Ed
+.D1 \&.Ev DISPLAY
+.D1 \&.Ev PATH
 .
 .Ss \&Ex
 Inserts text regarding a utility's exit values.  This macro must have
@@ -1676,15 +1628,15 @@ is provided.
 Command-line flag.  Used when listing arguments to command-line
 utilities.  Prints a fixed-width hyphen
 .Sq \-
-before each delimited argument.  If no arguments are provided, a hyphen
-is still printed.
+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:
-.Bd -literal -offset indent
-\&.Fl a b c
-\&.Fl
-\&.Op Fl o Ns Ar file
-.Ed
+.D1 \&.Fl a b c
+.D1 \&.Fl \&Pf a b
+.D1 \&.Fl
+.D1 \&.Op \&Fl o \&Ns \&Ar file
 .Pp
 See also
 .Sx \&Cm .
@@ -1698,10 +1650,8 @@ Format the FreeBSD version provided as an argument, or
 if no argument is provided.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Fx 7.1
-\&.Fx
-.Ed
+.D1 \&.Fx 7.1
+.D1 \&.Fx
 .Pp
 See also
 .Sx \&At ,
@@ -1725,10 +1675,8 @@ Format a hyperlink.  The calling syntax is as follows:
 .D1 \. Ns Sx \&Lk Cm uri Op Cm name
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Lk http://bsd.lv "The BSD.lv Project"
-\&.Lk http://bsd.lv
-.Ed
+.D1 \&.Lk http://bsd.lv "The BSD.lv Project"
+.D1 \&.Lk http://bsd.lv
 .Pp
 See also
 .Sx \&Mt .
@@ -1745,10 +1693,8 @@ Format the NetBSD version provided as an argument, or 
 no argument is provided.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Nx 5.01
-\&.Nx
-.Ed
+.D1 \&.Nx 5.01
+.D1 \&.Nx
 .Pp
 See also
 .Sx \&At ,
@@ -1778,11 +1724,9 @@ unspecified, it defaults to the local operating system
 the suggested form.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Os
-\&.Os KTH/CSC/TCS
-\&.Os BSD 4.3
-.Ed
+.D1 \&.Os
+.D1 \&.Os KTH/CSC/TCS
+.D1 \&.Os BSD 4.3
 .Pp
 See also
 .Sx \&Dd
@@ -1800,10 +1744,8 @@ Format the OpenBSD version provided as an argument, or
 if no argument is provided.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Ox 4.5
-\&.Ox
-.Ed
+.D1 \&.Ox 4.5
+.D1 \&.Ox
 .Pp
 See also
 .Sx \&At ,
@@ -1853,7 +1795,7 @@ and
 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
@@ -1886,9 +1828,7 @@ line.
 Format the UNIX name.  Accepts no argument.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Ux
-.Ed
+.D1 \&.Ux
 .Pp
 See also
 .Sx \&At ,
@@ -1916,10 +1856,8 @@ Note that this should not be confused with
 which is used for function return types.
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Vt unsigned char
-\&.Vt extern const char * const sys_signame[] ;
-.Ed
+.D1 \&.Vt unsigned char
+.D1 \&.Vt extern const char * const sys_signame[] ;
 .Pp
 See also
 .Sx \&Ft
@@ -1955,64 +1893,63 @@ with
 .Xr groff 1 .
 .Pp
 Examples:
-.Bd -literal -offset indent
-\&.Xr mandoc 1
-\&.Xr mandoc 1 ;
-\&.Xr mandoc 1 s behaviour
-.Ed
+.D1 \&.Xr mandoc 1
+.D1 \&.Xr mandoc 1 ;
+.D1 \&.Xr mandoc 1 \&Ns s behaviour
 .
 .Ss \&br
 .Ss \&sp
 .
 .
 .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
-refers to those versions before the
+refers to groff versions before the
 .Pa doc.tmac
 file re-write
 .Pq somewhere between 1.15 and 1.19 .
 .
 .Pp
+Heirloom troff, the other significant troff implementation accepting
+\-mdoc, is similar to historic groff.
+.
+.Pp
 .Bl -dash -compact
 .It
 The comment syntax
 .Sq \e."
 is no longer accepted.
+.
 .It
-In
-.Xr groff 1 ,
-the
+In groff, the
 .Sx \&Pa
 macro does not format its arguments when used in the FILES section under
-certain list types.  This irregular behaviour has been discontinued.
+certain list types.  mandoc does.
+.
 .It
-Historic
-.Xr groff 1
-does not print a dash for empty
+Historic groff does not print a dash for empty
 .Sx \&Fl
-arguments.  This behaviour has been discontinued.
+arguments.  mandoc and newer groff implementations do.
 .It
-.Xr groff 1
-behaves strangely (even between versions) when specifying
+groff behaves irregularly when specifying
 .Sq \ef
-escapes within line-macro scopes.  These aberrations have been
-normalised.
+.Sx Text Decoration
+within line-macro scopes.  mandoc follows a consistent system.
+.
 .It
-Negative scaling units are now truncated to zero instead of creating
-interesting conditions, such as with
-.Sx \&sp
-.Fl 1i .
-Furthermore, the
+In mandoc, negative scaling units are truncated to zero; groff would
+move to prior lines.  Furthermore, the
 .Sq f
 scaling unit, while accepted, is rendered as the default unit.
+.
 .It
 In quoted literals, groff allowed pair-wise double-quotes to produce a
 standalone double-quote in formatted output.  This idiosyncratic
-behaviour is no longer applicable.
+behaviour is not applicable in mandoc.
+.
 .It
 Display types
 .Sx \&Bd
@@ -2020,10 +1957,11 @@ Display types
 and
 .Fl right
 are aliases for
-.Fl left .
-The
+.Fl left
+in manodc.  Furthermore, the
 .Fl file Ar file
-argument is ignored.  Since text is not right-justified,
+argument is ignored.  Lastly, since text is not right-justified in
+mandoc (or even groff),
 .Fl ragged
 and
 .Fl filled
@@ -2031,36 +1969,50 @@ are aliases, as are
 .Fl literal
 and
 .Fl unfilled .
+.
 .It
-Blocks of whitespace are stripped from both macro and free-form text
-lines (except when in literal mode), while groff would retain whitespace
-in free-form text lines.
+In mandoc, blocks of whitespace are stripped from both macro and
+free-form text lines (except when in literal mode); groff would retain
+whitespace in free-form text lines.
+.
 .It
 Historic groff has many un-callable macros.  Most of these (excluding
-some block-level macros) are now callable, conforming to the
-non-historic groff version.
+some block-level macros) are now callable.
+.
 .It
 The vertical bar
 .Sq \(ba
 made historic groff
 .Qq go orbital
-but is a proper delimiter in this implementation.
+but has been a proper delimiter since then.
+.
 .It
-.Sx \&It
-.Fl nested
+.Sx \&It Fl nested
 is assumed for all lists (it wasn't in historic groff): any list may be
 nested and
 .Fl enum
 lists will restart the sequence only for the sub-list.
+.
 .It
 Some manuals use
 .Sx \&Li
 incorrectly by following it with a reserved character and expecting the
-delimiter to render.  This is not supported.
+delimiter to render.  This is not supported in mandoc.
+.
 .It
 In groff, the
 .Sx \&Fo
-macro only produces the first parameter.  This is no longer the case.
+macro only produces the first parameter.  This is not the case in
+mandoc.
+.
+.It
+In groff, the
+.Sx \&Cd ,
+.Sx \&Er ,
+and
+.Sx \&Ex
+macros were stipulated only to occur in certain manual sections.  mandoc
+does not have these restrictions.
 .El
 .
 .