Fix a TODO noted by schwarze@, originally by Christian Weisgerber:

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index c12bd51cf25433ff94f7f872ad1ef39debbcfd58..65947f5350d76750cfa9d714e600757e004c65c4 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.92 2010/12/08 10:58:22 kristaps Exp $
+.\"    $Id: man.7,v 1.101 2011/07/03 22:57:32 kristaps Exp $

 .\"
 .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\"
 .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"


@@ -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.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: December 8 2010 $
+.Dd $Mdocdate: July 3 2011 $

 .Dt MAN 7
 .Os
 .Sh NAME
 .Dt MAN 7
 .Os
 .Sh NAME


@@ -53,12 +53,12 @@ Other lines are interpreted within the current state.
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the
 space character, and the tab character.
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the
 space character, and the tab character.

-All manuals must have
-.Ux
-line termination.

 .Pp
 Blank lines are acceptable; where found, the output will assert a
 vertical space.
 .Pp
 Blank lines are acceptable; where found, the output will assert a
 vertical space.

+.Pp
+If the first character of a 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 ,


@@ -118,15 +118,6 @@ rendered as an empty line.
 .Pp
 In macro lines, whitespace delimits arguments and is discarded.
 If arguments are quoted, whitespace within the quotes is retained.
 .Pp
 In macro lines, whitespace delimits arguments and is discarded.
 If arguments are quoted, whitespace within the quotes is retained.

-.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 paragraph indentation with the following:
 .Ss Scaling Widths
 Many macros support scaled widths for their arguments, such as
 stipulating a two-inch paragraph indentation with the following:


@@ -214,16 +205,20 @@ appears as the first macro.
 Beyond
 .Sx \&TH ,
 at least one macro or text node must appear in the document.
 Beyond
 .Sx \&TH ,
 at least one macro or text node must appear in the document.

-Documents are generally structured as follows:
+.Pp
+The following is a well-formed skeleton
+.Nm
+file for a utility
+.Qq progname :

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

-\&.TH FOO 1 2009-10-10
+\&.TH PROGNAME 1 2009-10-10

 \&.SH NAME
 \&.SH NAME

-\efBfoo\efR \e(en a description goes here
+\efBprogname\efR \e(en a description goes here

 \&.\e\*q .SH LIBRARY
 \&.\e\*q For sections 2 & 3 only.
 \&.\e\*q Not used in OpenBSD.
 \&.SH SYNOPSIS
 \&.\e\*q .SH LIBRARY
 \&.\e\*q For sections 2 & 3 only.
 \&.\e\*q Not used in OpenBSD.
 \&.SH SYNOPSIS

-\efBfoo\efR [\efB\e-options\efR] arguments...
+\efBprogname\efR [\efB\e-options\efR] arguments...

 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES
 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES


@@ -370,6 +365,13 @@ Thus, the following are equivalent:
 \&.\ \ \ PP
 .Ed
 .Pp
 \&.\ \ \ PP
 .Ed
 .Pp

+To include space characters in macro arguments, arguments may be quoted;
+see the
+.Sq MACRO SYNTAX
+section in the
+.Xr roff 7
+manual for details.
+.Pp

 The
 .Nm
 macros are classified by scope: line scope or block scope.
 The
 .Nm
 macros are classified by scope: line scope or block scope.


@@ -527,7 +529,7 @@ Whitespace between arguments is omitted in output.
 .Pp
 Examples:
 .Pp
 .Pp
 Examples:
 .Pp

-.D1 \&.BI bold italic bold italic
+.Dl \&.BI bold italic bold italic

 .Pp
 The output of this example will be emboldened
 .Dq bold
 .Pp
 The output of this example will be emboldened
 .Dq bold


@@ -756,32 +758,33 @@ The paragraph left-margin width is reset to the default.
 Sets the title of the manual page with the following syntax:
 .Bd -filled -offset indent
 .Pf \. Sx \&TH
 Sets the title of the manual page with the following syntax:
 .Bd -filled -offset indent
 .Pf \. Sx \&TH

-.Cm title section
-.Op Cm date Op Cm source Op Cm volume
+.Ar title section date
+.Op Ar source Op Ar volume

 .Ed
 .Pp
 .Ed
 .Pp

-At least the upper-case document
-.Cm title
-and the manual
-.Cm section
-arguments must be provided.
-The
-.Cm date
-argument should be formatted as described in
-.Sx Dates ,
-but will be printed verbatim if it is not.
-If the date is not specified, the current date is used.
-The
-.Cm source
+Conventionally, the document
+.Ar title
+is given in all caps.
+The recommended
+.Ar date
+format is
+.Sy YYYY-MM-DD
+as specified in the ISO-8601 standard;
+if the argument does not conform, it is printed verbatim.
+If the
+.Ar date
+is empty or not specified, the current date is used.
+The optional
+.Ar source

 string specifies the organisation providing the utility.
 The
 string specifies the organisation providing the utility.
 The

-.Cm volume
+.Ar volume

 string replaces the default rendered volume, which is dictated by the
 manual section.
 .Pp
 Examples:
 .Pp
 string replaces the default rendered volume, which is dictated by the
 manual section.
 .Pp
 Examples:
 .Pp

-.D1 \&.TH CVS 5 "1992-02-12" GNU
+.Dl \&.TH CVS 5 "1992-02-12" GNU

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


@@ -842,6 +845,10 @@ Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.
 May be ended by
 .Sx \&fi .
 line boundaries preserved.
 May be ended by
 .Sx \&fi .

+Literal mode is implicitly ended by
+.Sx \&SH
+or
+.Sx \&SS .

 .Ss \&sp
 Insert vertical spaces into output with the following syntax:
 .Bd -filled -offset indent
 .Ss \&sp
 Insert vertical spaces into output with the following syntax:
 .Bd -filled -offset indent


@@ -912,8 +919,11 @@ In GNU troff, this would result in strange behaviour.
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr mandoc 1 ,
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr mandoc 1 ,

+.Xr eqn 7 ,

 .Xr mandoc_char 7 ,
 .Xr mandoc_char 7 ,

-.Xr mdoc 7
+.Xr mdoc 7 ,
+.Xr roff 7 ,
+.Xr tbl 7

 .Sh HISTORY
 The
 .Nm
 .Sh HISTORY
 The
 .Nm