===================================================================
RCS file: /cvs/mandoc/man.7,v
retrieving revision 1.37
retrieving revision 1.43
diff -u -p -r1.37 -r1.43
--- mandoc/man.7	2009/09/05 10:37:09	1.37
+++ mandoc/man.7	2009/11/02 06:22:45	1.43
@@ -1,4 +1,4 @@
-.\"	$Id: man.7,v 1.37 2009/09/05 10:37:09 kristaps Exp $
+.\"	$Id: man.7,v 1.43 2009/11/02 06:22:45 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: September 5 2009 $
+.Dd $Mdocdate: November 2 2009 $
 .Dt MAN 7
 .Os
 .
@@ -119,23 +119,107 @@ from input.  These are later re-added, if applicable, 
 utility such as
 .Xr mandoc 1 .
 .
+.Ss Dates
+The
+.Sx \&TH
+macro is the only
+.Nm
+macro that requires a date.  The form for this date is the ISO-8601
+standard
+.Cm YYYY-MM-DD .
 .
+.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 paragraph indentation with the following:
+.Bd -literal -offset indent
+\&.HP 2i
+.Ed
+.
+.Pp
+The syntax for scaled widths is
+.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,
+where a decimal must be preceded or proceeded by at least one digit.
+Negative numbers, while accepted, are truncated to zero.  The following
+scaling units are accepted:
+.
+.Pp
+.Bl -tag -width Ds -offset indent -compact
+.It c
+centimetre
+.It i
+inch
+.It P
+pica (~1/6 inch)
+.It p
+point (~1/72 inch)
+.It f
+synonym for
+.Sq u
+.It v
+default vertical span
+.It m
+width of rendered
+.Sq m
+.Pq em
+character
+.It n
+width of rendered
+.Sq n
+.Pq en
+character
+.It u
+default horizontal span
+.It M
+mini-em (~1/100 em)
+.El
+.Pp
+Using anything other than
+.Sq m ,
+.Sq n ,
+.Sq u ,
+or
+.Sq v
+is necessarily non-portable across output media.  See 
+.Sx COMPATIBILITY .
+.
+.Pp
+If a scaling unit is not provided, the numerical value is interpreted
+under the default rules of
+.Sq v
+for vertical spaces and
+.Sq u
+for horizontal ones.
+.Em Note :
+this differs from
+.Xr mdoc 7 ,
+which, if a unit is not provided, will instead interpret the string as
+literal text.
+.
+.
 .Sh MANUAL STRUCTURE
 Each
 .Nm
 document must contain contains at least the
-.Sq TH
+.Sx \&TH
 macro describing the document's section and title.  It may occur
 anywhere in the document, although conventionally, it appears as the
 first macro.
 .
 .Pp
 Beyond
-.Sq TH ,
+.Sx \&TH ,
 at least one macro or text node must appear in the document.  Documents
 are generally structured as follows:
 .Bd -literal -offset indent
-\&.TH FOO 1 "13 Aug 2009"
+\&.TH FOO 1 2009-10-10
 \&.
 \&.SH NAME
 \efBfoo\efR \e(en a description goes here
@@ -162,7 +246,7 @@ The \efBfoo\efR utility processes files...
 \&.\e\*q The next is for sections 2, 3, & 9 only.
 \&.\e\*q .SH ERRORS
 \&.\e\*q .SH SEE ALSO
-\&.\e\*q \efBbar\efR(1)
+\&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS
 \&.\e\*q .SH HISTORY
 \&.\e\*q .SH AUTHORS
@@ -170,18 +254,141 @@ The \efBfoo\efR utility processes files...
 \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS
 .Ed
+.Pp
+The sections in a
+.Nm
+document are conventionally ordered as they appear above.  Sections
+should be composed as follows:
+.Bl -ohang -offset indent
+.It Em NAME
+The name(s) and a short description of the documented material.  The
+syntax for this is generally as follows:
+.Pp
+.D1 \efBname\efR \e(en description
+.It Em LIBRARY
+The name of the library containing the documented material, which is
+assumed to be a function in a section 2 or 3 manual.  For functions in
+the C library, this may be as follows:
+.Pp
+.D1 Standard C Library (libc, -lc)
+.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:
+.Pp
+.D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
+.Pp
+For the second, function calls (sections 2, 3, 9):
+.Pp
+.D1 \. Ns Sx \&B No char *name(char *\efIarg\efR);
+.Pp
+And for the third, configurations (section 4):
+.Pp
+.D1 \. Ns Sx \&B No name* at cardbus ? function ?
+.Pp
+Manuals not in these sections generally don't need a 
+.Em SYNOPSIS .
+.It Em DESCRIPTION
+This expands upon the brief, one-line description in 
+.Em NAME .
+It usually contains a break-down of the options (if documenting a
+command).
+.It Em IMPLEMENTATION NOTES
+Implementation-specific notes should be kept here.  This is useful when
+implementing standard functions that may have side effects or notable
+algorithmic implications.
+.It Em EXIT STATUS
+Command exit status for section 1, 6, and 8 manuals.  This section is
+the dual of
+.Em RETURN VALUES ,
+which is used for functions.  Historically, this information was
+described in
+.Em DIAGNOSTICS ,
+a practise that is now discouraged.
 .
+.It Em RETURN VALUES
+This section is the dual of
+.Em EXIT STATUS ,
+which is used for commands.  It documents the return values of functions
+in sections 2, 3, and 9.
 .
+.It Em ENVIRONMENT
+Documents any usages of environment variables, e.g.,
+.Xr environ 7 .
+.
+.It Em FILES
+Documents files used.  It's helpful to document both the file and a
+short description of how the file is used (created, modified, etc.).
+.
+.It Em EXAMPLES
+Example usages.  This often contains snippets of well-formed,
+well-tested invocations.  Make doubly sure that your examples work
+properly!  Assume that users will skip to this section and use your
+example verbatim.
+.
+.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.
+.
+.It Em ERRORS
+Documents error handling in sections 2, 3, and 9.
+.
+.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
+.D1 \. Ns Sx \&BR No bar \&( 1 \&),
+.D1 \. Ns Sx \&BR No foo \&( 1 \&),
+.D1 \. Ns Sx \&BR No baz \&( 2 \&).
+.
+.It Em STANDARDS
+References any standards implemented or used, such as
+.Pp
+.D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
+.Pp
+If not adhering to any standards, the
+.Em HISTORY
+section should be used.
+.
+.It Em HISTORY
+The history of any manual without a
+.Em STANDARDS
+section should be described in this section.
+.
+.It Em AUTHORS
+Credits to authors, if applicable, should appear in this section.
+Authors should generally be noted by both name and an e-mail address.
+.
+.It Em CAVEATS
+Explanations of common misuses and misunderstandings should be explained
+in this section.
+.
+.It Em BUGS
+Extant bugs should be described in this section.
+.
+.It Em SECURITY CONSIDERATIONS
+Documents any security precautions that operators should consider.
+.
+.El
+.
+.
 .Sh MACRO SYNTAX
 Macros are one to three three characters in length and begin with a
 control character ,
 .Sq \&. ,
 at the beginning of the line.  An arbitrary amount of whitespace may
-sit between the control character and the macro name.  Thus,
-.Sq .PP
-and
-.Sq \&.\ \ \ PP
-are equivalent.
+sit between the control character and the macro name.  Thus, the
+following are equivalent:
+.Bd -literal -offset indent
+\&.PP
+\&.\ \ \ PP
+.Ed
 .
 .Pp
 The
@@ -215,42 +422,44 @@ If a next-line macro is proceded by a block macro, it 
 .Pp
 .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
 .It Em Macro Ta Em Arguments Ta Em Scope
-.It    B     Ta    n         Ta    next-line
-.It    BI    Ta    n         Ta    current
-.It    BR    Ta    n         Ta    current
-.It    DT    Ta    0         Ta    current
-.It    I     Ta    n         Ta    next-line
-.It    IB    Ta    n         Ta    current
-.It    IR    Ta    n         Ta    current
-.It    R     Ta    n         Ta    next-line
-.It    RB    Ta    n         Ta    current
-.It    RI    Ta    n         Ta    current
-.It    SB    Ta    n         Ta    next-line
-.It    SM    Ta    n         Ta    next-line
-.It    TH    Ta    >1, <6    Ta    current
-.It    UC    Ta    n         Ta    current
-.It    br    Ta    0         Ta    current
-.It    fi    Ta    0         Ta    current
-.It    i     Ta    n         Ta    current
-.It    na    Ta    0         Ta    current
-.It    nf    Ta    0         Ta    current
-.It    r     Ta    0         Ta    current
-.It    sp    Ta    1         Ta    current
+.It Sx \&B   Ta    n         Ta    next-line
+.It Sx \&BI  Ta    n         Ta    current
+.It Sx \&BR  Ta    n         Ta    current
+.It Sx \&DT  Ta    0         Ta    current
+.It Sx \&I   Ta    n         Ta    next-line
+.It Sx \&IB  Ta    n         Ta    current
+.It Sx \&IR  Ta    n         Ta    current
+.It Sx \&PD  Ta    n         Ta    current
+.It Sx \&R   Ta    n         Ta    next-line
+.It Sx \&RB  Ta    n         Ta    current
+.It Sx \&RI  Ta    n         Ta    current
+.It Sx \&SB  Ta    n         Ta    next-line
+.It Sx \&SM  Ta    n         Ta    next-line
+.It Sx \&TH  Ta    >1, <6    Ta    current
+.It Sx \&UC  Ta    n         Ta    current
+.It Sx \&br  Ta    0         Ta    current
+.It Sx \&fi  Ta    0         Ta    current
+.It Sx \&i   Ta    n         Ta    current
+.It Sx \&na  Ta    0         Ta    current
+.It Sx \&nf  Ta    0         Ta    current
+.It Sx \&r   Ta    0         Ta    current
+.It Sx \&sp  Ta    1         Ta    current
 .El
 .
 .Pp
 The
-.Sq RS ,
-.Sq RE ,
-.Sq UC ,
-.Sq br ,
-.Sq fi ,
-.Sq i ,
-.Sq na ,
-.Sq nf ,
-.Sq r ,
+.Sx \&PD ,
+.Sx \&RS ,
+.Sx \&RE ,
+.Sx \&UC ,
+.Sx \&br ,
+.Sx \&fi ,
+.Sx \&i ,
+.Sx \&na ,
+.Sx \&nf ,
+.Sx \&r ,
 and
-.Sq sp
+.Sx \&sp
 macros should not be used.  They're included for compatibility.
 .
 .
@@ -268,48 +477,49 @@ subsequent block macro invocation.
 .Pp
 The closure of body scope may be to the section, where a macro is closed
 by
-.Sq SH ;
+.Sx \&SH ;
 sub-section, closed by a section or
-.Sq SS ;
+.Sx \&SS ;
 part, closed by a section, sub-section, or
-.Sq RE ;
+.Sx \&RE ;
 or paragraph, closed by a section, sub-section, part, 
-.Sq HP ,
-.Sq IP ,
-.Sq LP ,
-.Sq P ,
-.Sq PP ,
+.Sx \&HP ,
+.Sx \&IP ,
+.Sx \&LP ,
+.Sx \&P ,
+.Sx \&PP ,
 or
-.Sq TP .
+.Sx \&TP .
 No closure refers to an explicit block closing macro.
 .
 .Pp
 .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
 .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
-.It   HP     Ta    <2        Ta    current    Ta    paragraph
-.It   IP     Ta    <3        Ta    current    Ta    paragraph
-.It   LP     Ta    0         Ta    current    Ta    paragraph
-.It   P      Ta    0         Ta    current    Ta    paragraph
-.It   PP     Ta    0         Ta    current    Ta    paragraph
-.It   RE     Ta    0         Ta    current    Ta    none
-.It   RS     Ta    1         Ta    current    Ta    part
-.It   SH     Ta    >0        Ta    next-line  Ta    section
-.It   SS     Ta    >0        Ta    next-line  Ta    sub-section
-.It   TP     Ta    n         Ta    next-line  Ta    paragraph
+.It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph
+.It Sx \&IP  Ta    <3        Ta    current    Ta    paragraph
+.It Sx \&LP  Ta    0         Ta    current    Ta    paragraph
+.It Sx \&P   Ta    0         Ta    current    Ta    paragraph
+.It Sx \&PP  Ta    0         Ta    current    Ta    paragraph
+.It Sx \&RE  Ta    0         Ta    current    Ta    none
+.It Sx \&RS  Ta    1         Ta    current    Ta    part
+.It Sx \&SH  Ta    >0        Ta    next-line  Ta    section
+.It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section
+.It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph
 .El
 .
 .Pp
 If a block macro is next-line scoped, it may only be followed by in-line
 macros (excluding
-.Sq DT ,
-.Sq TH ,
-.Sq UC ,
-.Sq br ,
-.Sq na ,
-.Sq sp ,
-.Sq nf ,
+.Sx \&DT ,
+.Sx \&PD ,
+.Sx \&TH ,
+.Sx \&UC ,
+.Sx \&br ,
+.Sx \&na ,
+.Sx \&sp ,
+.Sx \&nf ,
 and
-.Sq fi ) .
+.Sx \&fi ) .
 .
 .
 .Sh REFERENCE
@@ -317,32 +527,9 @@ This section is a canonical reference to all macros, a
 alphabetically.  For the scoping of individual macros, see
 .Sx MACRO SYNTAX .
 .
-.
-.Ss Definitions
-In this reference, a numerical width may be either a standalone natural
-number (such as 3, 4, 10, etc.) or a natural number followed by a width
-multiplier 
-.Qq n ,
-corresponding to the width of the formatted letter n, or
-.Qq m ,
-corresponding to the width of the formatted letter m.  The latter is the
-default, if unspecified.  Thus,
-.Bd -literal -offset indent
-\&.HP 12n
-.Ed
-.
-.Pp
-indicates an offset of 12 
-.Qq n
-.Ns -sized
-letters.
-.
-.
-.Ss Macro Reference
-.Bl -tag -width Ds
-.It B
+.Ss \&B
 Text is rendered in bold face.
-.It BI
+.Ss \&BI
 Text is rendered alternately in bold face and italic.  Thus, 
 .Sq .BI this word and that
 causes
@@ -354,12 +541,12 @@ to render in bold face, while 
 and
 .Sq that
 render in italics.  Whitespace between arguments is omitted in output.
-.It BR
+.Ss \&BR
 Text is rendered alternately in bold face and roman (the default font).
 Whitespace between arguments is omitted in output.
-.It DT
+.Ss \&DT
 Has no effect.  Included for compatibility.
-.It HP
+.Ss \&HP
 Begin a paragraph whose initial output line is left-justified, but
 subsequent output lines are indented, with the following syntax:
 .Bd -literal -offset indent
@@ -367,16 +554,16 @@ subsequent output lines are indented, with the followi
 .Ed
 .
 .Pp
-If 
+If scaling width
 .Va width
 is specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.
-.It I
+.Ss \&I
 Text is rendered in italics.
-.It IB
+.Ss \&IB
 Text is rendered alternately in italics and bold face.  Whitespace
 between arguments is omitted in output.
-.It IP
+.Ss \&IP
 Begin a paragraph with the following syntax:
 .Bd -literal -offset indent
 \&.IP [head [width]]
@@ -384,36 +571,42 @@ Begin a paragraph with the following syntax:
 .
 .Pp
 This follows the behaviour of the
-.Sq TP
+.Sx \&TP
 except for the macro syntax (all arguments on the line, instead of
 having next-line scope).  If
 .Va width
 is specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.
-.It IR
+.Ss \&IR
 Text is rendered alternately in italics and roman (the default font).
 Whitespace between arguments is omitted in output.
-.It LP, P, PP
+.Ss \&LP
 Begin an undecorated paragraph.  The scope of a paragraph is closed by a
 subsequent paragraph, sub-section, section, or end of file.  The saved
 paragraph left-margin width is re-set to the default.
-.It R
+.Ss \&P
+Synonym for
+.Sx \&LP .
+.Ss \&PP
+Synonym for
+.Sx \&LP .
+.Ss \&R
 Text is rendered in roman (the default font).
-.It RB
+.Ss \&RB
 Text is rendered alternately in roman (the default font) and bold face.
 Whitespace between arguments is omitted in output.
-.It RE
+.Ss \&RE
 Explicitly close out the scope of a prior
-.Sq RS .
-.It RI
+.Sx \&RS .
+.Ss \&RI
 Text is rendered alternately in roman (the default font) and italics.
 Whitespace between arguments is omitted in output.
-.It RS
+.Ss \&RS
 Begin a part setting the left margin.  The left margin controls the
 offset, following an initial indentation, to un-indented text such as
 that of
-.Sq PP .
-The width may be specified as following:
+.Sx \&PP .
+A scaling width may be specified as following:
 .Bd -literal -offset indent
 \&.RS [width]
 .Ed
@@ -422,84 +615,86 @@ The width may be specified as following:
 If
 .Va width
 is not specified, the saved or default width is used. 
-.It SB
+.Ss \&SB
 Text is rendered in small size (one point smaller than the default font)
 bold face.
-.It SH
+.Ss \&SH
 Begin a section.  The scope of a section is only closed by another
 section or the end of file.  The paragraph left-margin width is re-set
 to the default.
-.It SM
+.Ss \&SM
 Text is rendered in small size (one point smaller than the default
 font).
-.It SS
+.Ss \&SS
 Begin a sub-section.  The scope of a sub-section is closed by a
 subsequent sub-section, section, or end of file.  The paragraph
 left-margin width is re-set to the default.
-.It TH
+.Ss \&TH
 Sets the title of the manual page with the following syntax:
-.Bd -literal -offset indent
-\&.TH title section [date [source [volume]]]
-.Ed
-.
 .Pp
-At least the 
-.Va title
-and
-.Va section
+.D1 \. Ns Sx \&TH No Cm title msec Op Cm date Op Cm src Op Cm vol
+.Pp
+At least the upper-case document title
+.Cm title
+and numeric manual section
+.Cm msec
 arguments must be provided.  The
-.Va date
-argument should be formatted as
-.Qq %b [%d] %Y
-format, described in
-.Xr strptime 3 .
-The
-.Va source
+.Cm date
+argument should be formatted as described in
+.Sx Dates :
+if it does not conform, the current date is used instead.  The
+.Cm src
 string specifies the organisation providing the utility.  The
-.Va volume
-replaces the default rendered volume as dictated by the manual section.
-.It TP
+.Cm vol
+string replaces the default rendered volume, which is dictated by the
+manual section.
+.Pp
+Examples:
+.Bd -literal -offset indent
+\&.TH CVS 5 "1992-02-12" GNU
+.Ed
+.
+.Ss \&TP
 Begin a paragraph where the head, if exceeding the indentation width, is
 followed by a newline; if not, the body follows on the same line after a
 buffer to the indentation width.  Subsequent output lines are indented.
 .
 .Pp
-The indentation width may be set as follows:
+The indentation scaling width may be set as follows:
 .Bd -literal -offset indent
 \&.TP [width]
 .Ed
 .
 .Pp
-Where
+If
 .Va width
-must be a properly-formed numeric width.  If
-.Va width
 is specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.
-.It UC
+.Ss \&PD
 Has no effect.  Included for compatibility.
-.It br
+.Ss \&UC
+Has no effect.  Included for compatibility.
+.Ss \&br
 Breaks the current line.  Consecutive invocations have no further effect.
-.It fi
+.Ss \&fi
 End literal mode begun by
-.Sq nf .
-.It i
+.Sx \&nf .
+.Ss \&i
 Italicise arguments.  If no arguments are specified, all subsequent text
 is italicised.
-.It na
+.Ss \&na
 Don't align to the right margin.
-.It nf
+.Ss \&nf
 Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.  May be ended by
-.Sq fi .
-.It r
+.Sx \&fi .
+.Ss \&r
 Fonts and styles (bold face, italics) reset to roman (default font).
-.It sp
+.Ss \&sp
 Insert n spaces, where n is the macro's positive numeric argument.  If
 0, this is equivalent to the
-.Sq br
+.Sx \&br
 macro.
-.El
 .
 .
 .Sh COMPATIBILITY