=================================================================== RCS file: /cvs/mandoc/man.7,v retrieving revision 1.62 retrieving revision 1.67 diff -u -p -r1.62 -r1.67 --- mandoc/man.7 2010/04/13 05:26:49 1.62 +++ mandoc/man.7 2010/05/12 08:41:17 1.67 @@ -1,4 +1,4 @@ -.\" $Id: man.7,v 1.62 2010/04/13 05:26:49 kristaps Exp $ +.\" $Id: man.7,v 1.67 2010/05/12 08:41:17 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -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: April 13 2010 $ +.Dd $Mdocdate: May 12 2010 $ .Dt MAN 7 .Os .Sh NAME @@ -126,10 +126,14 @@ and .Sq \ef attributes are forgotten when entering or exiting a macro block. .Ss Whitespace -Unless specifically escaped, consecutive blocks of whitespace are pruned -from input. These are later re-added, if applicable, by a front-end -utility such as -.Xr mandoc 1 . +Whitespace consists of the space character. +In free-form lines, whitespace is preserved within a line; un-escaped +trailing spaces are stripped from input (unless in a literal context). +Blank free-form lines, which may include spaces, are permitted and +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. .Ss Dates The .Sx \&TH @@ -228,13 +232,13 @@ are generally structured as follows: The \efBfoo\efR utility processes files... \&. \&.\e\*q .SH IMPLEMENTATION NOTES -\&.\e\*q The next is for sections 1 & 8 only. -\&.\e\*q .SH EXIT STATUS \&.\e\*q The next is for sections 2, 3, & 9 only. \&.\e\*q .SH RETURN VALUES \&.\e\*q The next is for sections 1, 6, 7, & 8 only. \&.\e\*q .SH ENVIRONMENT \&.\e\*q .SH FILES +\&.\e\*q The next is for sections 1 & 8 only. +\&.\e\*q .SH EXIT STATUS \&.\e\*q .SH EXAMPLES \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. \&.\e\*q .SH DIAGNOSTICS @@ -294,14 +298,6 @@ command). 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 , @@ -313,6 +309,14 @@ Documents any usages of environment variables, e.g., .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 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 EXAMPLES Example usages. This often contains snippets of well-formed, well-tested invocations. Make doubly sure that your examples work @@ -886,11 +890,6 @@ language. In quoted literals, GNU troff allowed pair-wise double-quotes to produce a standalone double-quote in formatted output. It is not known whether this behaviour is exhibited by other formatters. -.It -Blocks of whitespace are stripped from macro and free-form text lines -(except when in literal mode) in mandoc. This is not the case for GNU -troff: for maximum portability, whitespace sensitive blocks should be -enclosed in literal contexts. .It The .Sx \&sp