Significant improvements to man(7). More or less finished.

1 files changed, 314 insertions, 65 deletions

diff --git a/man.7 b/man.7
index c3b313a9..a0b5ee72 100644
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"	$Id: man.7,v 1.43 2009/11/02 06:22:45 kristaps Exp $
+.\"	$Id: man.7,v 1.44 2009/11/02 09:53:15 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
@@ -82,7 +82,7 @@ Text following a
 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
+is also ignored.  Macro lines with only a control character and
 optionally whitespace are stripped from input.
 .
 .
@@ -119,6 +119,7 @@ from input.  These are later re-added, if applicable, by a front-end
 utility such as
 .Xr mandoc 1 .
 .
+.
 .Ss Dates
 The
 .Sx \&TH
@@ -128,13 +129,6 @@ 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
@@ -187,8 +181,7 @@ Using anything other than
 .Sq u ,
 or
 .Sq v
-is necessarily non-portable across output media.  See 
-.Sx COMPATIBILITY .
+is necessarily non-portable across output media.
 .
 .Pp
 If a scaling unit is not provided, the numerical value is interpreted
@@ -282,11 +275,11 @@ generally structured as follows:
 .Pp
 For the second, function calls (sections 2, 3, 9):
 .Pp
-.D1 \. Ns Sx \&B No char *name(char *\efIarg\efR);
+.D1 \&.B char *name(char *\efIarg\efR);
 .Pp
 And for the third, configurations (section 4):
 .Pp
-.D1 \. Ns Sx \&B No name* at cardbus ? function ?
+.D1 \&.B name* at cardbus ? function ?
 .Pp
 Manuals not in these sections generally don't need a 
 .Em SYNOPSIS .
@@ -325,8 +318,7 @@ 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.
+properly!
 .
 .It Em DIAGNOSTICS
 Documents error conditions.  This is most useful in section 4 manuals.
@@ -340,12 +332,12 @@ 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.
+for most manuals.  
 .Pp
-.D1 \. Ns Sx \&BR No bar \&( 1 \&),
-.D1 \. Ns Sx \&BR No foo \&( 1 \&),
-.D1 \. Ns Sx \&BR No baz \&( 2 \&).
+.D1 \&.BR bar \&( 1 \&),
+.Pp
+Cross-references should conventionally be ordered
+first by section, then alphabetically.
 .
 .It Em STANDARDS
 References any standards implemented or used, such as
@@ -412,8 +404,9 @@ foo
 .Pp
 is equivalent to
 .Sq \&.I foo .
-If next-line macros are invoked consecutively, only the last is used.
-If a next-line macro is proceded by a block macro, it is ignored.
+If next-line macros are invoked consecutively, only the last is used; in
+other words, if a next-line macro is preceded by a block macro, it is
+ignored.
 .Bd -literal -offset indent
 \&.YO \(lBbody...\(rB
 \(lBbody...\(rB
@@ -527,8 +520,19 @@ This section is a canonical reference to all macros, arranged
 alphabetically.  For the scoping of individual macros, see
 .Sx MACRO SYNTAX .
 .
+.
 .Ss \&B
 Text is rendered in bold face.
+.Pp
+See also
+.Sx \&I ,
+.Sx \&R ,
+.Sx \&b ,
+.Sx \&i ,
+and
+.Sx \&r .
+.
+.
 .Ss \&BI
 Text is rendered alternately in bold face and italic.  Thus, 
 .Sq .BI this word and that
@@ -541,160 +545,405 @@ to render in bold face, while
 and
 .Sq that
 render in italics.  Whitespace between arguments is omitted in output.
+.Pp
+Examples:
+.Bd -filled -offset indent
+.Pf \. Sx \&BI
+bold italic bold italic
+.Ed
+.Pp
+The output of this example will be emboldened
+.Dq bold
+and italicised
+.Dq italic ,
+with spaces stripped between arguments.
+.Pp
+See also
+.Sx \&IB ,
+.Sx \&BR ,
+.Sx \&RB ,
+.Sx \&RI ,
+and
+.Sx \&IR .
+.
+.
 .Ss \&BR
 Text is rendered alternately in bold face and roman (the default font).
 Whitespace between arguments is omitted in output.
+.Pp
+See
+.Sx \&BI
+for an equivalent example.
+.Pp
+See also
+.Sx \&BI ,
+.Sx \&IB ,
+.Sx \&RB ,
+.Sx \&RI ,
+and
+.Sx \&IR .
+.
+.
 .Ss \&DT
 Has no effect.  Included for compatibility.
+.
+.
 .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
-\&.HP [width]
+.Bd -filled -offset indent
+.Pf \. Sx \&HP
+.Op Cm width
 .Ed
-.
 .Pp
-If scaling width
-.Va width
-is specified, it's saved for later paragraph left-margins; if
-unspecified, the saved or default width is used.
+The
+.Cm width
+argument must conform to
+.Sx Scaling Widths .
+If specified, it's saved for later paragraph left-margins; if unspecified, the
+saved or default width is used.
+.Pp
+See also
+.Sx IP ,
+.Sx LP ,
+.Sx P ,
+.Sx PP ,
+and
+.Sx TP .
+.
+.
 .Ss \&I
 Text is rendered in italics.
+.Pp
+See also
+.Sx \&B ,
+.Sx \&R ,
+.Sx \&b ,
+.Sx \&i ,
+and
+.Sx \&r .
+.
+.
 .Ss \&IB
 Text is rendered alternately in italics and bold face.  Whitespace
 between arguments is omitted in output.
+.Pp
+See
+.Sx \&BI
+for an equivalent example.
+.Pp
+See also
+.Sx \&BI ,
+.Sx \&BR ,
+.Sx \&RB ,
+.Sx \&RI ,
+and
+.Sx \&IR .
+.
+.
 .Ss \&IP
-Begin a paragraph with the following syntax:
-.Bd -literal -offset indent
-\&.IP [head [width]]
+Begin an indented paragraph with the following syntax:
+.Bd -filled -offset indent
+.Pf \. Sx \&IP
+.Op Cm head Op Cm width
 .Ed
-.
 .Pp
-This follows the behaviour of the
-.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.
+The
+.Cm width
+argument defines the width of the left margin and is defined by
+.Sx Scaling Widths ,
+It's saved for later paragraph left-margins; if unspecified, the saved or
+default width is used.
+.Pp
+The
+.Cm head
+argument is used as a leading term, flushed to the left margin.  This is
+useful for bulleted paragraphs and so on.
+.Pp
+See also
+.Sx HP ,
+.Sx LP ,
+.Sx P ,
+.Sx PP ,
+and
+.Sx TP .
+.
+.
 .Ss \&IR
 Text is rendered alternately in italics and roman (the default font).
 Whitespace between arguments is omitted in output.
+.Pp
+See
+.Sx \&BI
+for an equivalent example.
+.Pp
+See also
+.Sx \&BI ,
+.Sx \&IB ,
+.Sx \&BR ,
+.Sx \&RB ,
+and
+.Sx \&RI .
+.
+.
 .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.
+.Pp
+See also
+.Sx HP ,
+.Sx IP ,
+.Sx P ,
+.Sx PP ,
+and
+.Sx TP .
+.
+.
 .Ss \&P
 Synonym for
 .Sx \&LP .
+.Pp
+See also
+.Sx HP ,
+.Sx IP ,
+.Sx LP ,
+.Sx PP ,
+and
+.Sx TP .
+.
+.
 .Ss \&PP
 Synonym for
 .Sx \&LP .
+.Pp
+See also
+.Sx HP ,
+.Sx IP ,
+.Sx LP ,
+.Sx P ,
+and
+.Sx TP .
+.
+.
 .Ss \&R
 Text is rendered in roman (the default font).
+.Pp
+See also
+.Sx \&I ,
+.Sx \&B ,
+.Sx \&b ,
+.Sx \&i ,
+and
+.Sx \&r .
+.
+.
 .Ss \&RB
 Text is rendered alternately in roman (the default font) and bold face.
 Whitespace between arguments is omitted in output.
+.Pp
+See
+.Sx \&BI
+for an equivalent example.
+.Pp
+See also
+.Sx \&BI ,
+.Sx \&IB ,
+.Sx \&BR ,
+.Sx \&RI ,
+and
+.Sx \&IR .
+.
+.
 .Ss \&RE
 Explicitly close out the scope of a prior
 .Sx \&RS .
+.
+.
 .Ss \&RI
 Text is rendered alternately in roman (the default font) and italics.
 Whitespace between arguments is omitted in output.
+.Pp
+See
+.Sx \&BI
+for an equivalent example.
+.Pp
+See also
+.Sx \&BI ,
+.Sx \&IB ,
+.Sx \&BR ,
+.Sx \&RB ,
+and
+.Sx \&IR .
+.
+.
 .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
 .Sx \&PP .
-A scaling width may be specified as following:
-.Bd -literal -offset indent
-\&.RS [width]
+This has the following syntax:
+.Bd -filled -offset indent
+.Pf \. Sx \&Rs
+.Op Cm width
 .Ed
-.
 .Pp
-If
-.Va width
-is not specified, the saved or default width is used. 
+The
+.Cm width
+argument must conform to
+.Sx Scaling Widths .
+If not specified, the saved or default width is used. 
+.
+.
 .Ss \&SB
 Text is rendered in small size (one point smaller than the default font)
 bold face.
+.
+.
 .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.
+.
+.
 .Ss \&SM
 Text is rendered in small size (one point smaller than the default
 font).
+.
+.
 .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.
+.
+.
 .Ss \&TH
 Sets the title of the manual page with the following syntax:
-.Pp
-.D1 \. Ns Sx \&TH No Cm title msec Op Cm date Op Cm src Op Cm vol
+.Bd -filled -offset indent
+.Pf \. Sx \&TH
+.Cm title section
+.Op Cm date Op Cm source Op Cm volume
+.Ed
 .Pp
 At least the upper-case document title
 .Cm title
 and numeric manual section
-.Cm msec
+.Cm section
 arguments must be provided.  The
 .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
+.Cm source
 string specifies the organisation providing the utility.  The
-.Cm vol
+.Cm volume
 string replaces the default rendered volume, which is dictated by the
 manual section.
 .Pp
 Examples:
-.Bd -literal -offset indent
+.Bd -filled -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 scaling width may be set as follows:
-.Bd -literal -offset indent
-\&.TP [width]
+The syntax is as follows:
+.Bd -filled -offset indent
+.Pf \. Sx \&TP
+.Op Cm width
 .Ed
-.
 .Pp
-If
-.Va width
-is specified, it's saved for later paragraph left-margins; if
+The
+.Cm width
+argument must conform to
+.Sx Scaling Widths .
+If specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.
+.Pp
+See also
+.Sx HP ,
+.Sx IP ,
+.Sx LP ,
+.Sx P ,
+and
+.Sx PP .
+.
+.
 .Ss \&PD
 Has no effect.  Included for compatibility.
+.
+.
 .Ss \&UC
 Has no effect.  Included for compatibility.
+.
+.
 .Ss \&br
 Breaks the current line.  Consecutive invocations have no further effect.
+.Pp
+See also
+.Sx \&sp .
+.
+.
 .Ss \&fi
 End literal mode begun by
 .Sx \&nf .
+.
+.
 .Ss \&i
 Italicise arguments.  If no arguments are specified, all subsequent text
 is italicised.
+.Pp
+See also
+.Sx \&B ,
+.Sx \&I ,
+.Sx \&R .
+.Sx \&b ,
+and
+.Sx \&r .
+.
+.
 .Ss \&na
 Don't align to the right margin.
+.
+.
 .Ss \&nf
 Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.  May be ended by
 .Sx \&fi .
+.
+.
 .Ss \&r
 Fonts and styles (bold face, italics) reset to roman (default font).
+.Pp
+See also
+.Sx \&B ,
+.Sx \&I ,
+.Sx \&R ,
+.Sx \&b ,
+and
+.Sx \&i .
+.
+.
 .Ss \&sp
-Insert n spaces, where n is the macro's positive numeric argument.  If
-0, this is equivalent to the
+Insert vertical spaces into output with the following syntax:
+.Bd -filled -offset indent
+.Pf \. Sx \&sp
+.Op Cm height
+.Ed
+.Pp
+Insert 
+.Cm height
+spaces, which must conform to
+.Sx Scaling Widths .
+If 0, this is equivalent to the
 .Sx \&br
-macro.
+macro.  Defaults to 1, if unspecified.
+.Pp
+See also
+.Sx \&br .
 .
 .
 .Sh COMPATIBILITY