Clarified EXIT STATUS sections. Discussed among schwarze@, Thomas, and

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index 82bd30a42e79b1275a4e2a3b61af2183ea582cea..894631ab6355d1d279f7b73e47445deab279c9bc 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.80 2010/07/26 10:00:03 kristaps Exp $
+.\"    $Id: man.7,v 1.88 2010/09/04 17:22:41 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: July 26 2010 $
+.Dd $Mdocdate: September 4 2010 $

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


@@ -219,25 +219,26 @@ Documents are generally structured as follows:
 \&.TH FOO 1 2009-10-10
 \&.SH NAME
 \efBfoo\efR \e(en a description goes here
 \&.TH FOO 1 2009-10-10
 \&.SH NAME
 \efBfoo\efR \e(en a description goes here

-\&.\e\*q The next is for sections 2 & 3 only.

 \&.\e\*q .SH LIBRARY
 \&.\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...
 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES
 \&.SH SYNOPSIS
 \efBfoo\efR [\efB\e-options\efR] arguments...
 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES

-\&.\e\*q The next is for sections 2, 3, & 9 only.

 \&.\e\*q .SH RETURN VALUES
 \&.\e\*q .SH RETURN VALUES

-\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q For sections 2, 3, & 9 only.

 \&.\e\*q .SH ENVIRONMENT
 \&.\e\*q .SH ENVIRONMENT

+\&.\e\*q For sections 1, 6, 7, & 8 only.

 \&.\e\*q .SH FILES
 \&.\e\*q .SH FILES

-\&.\e\*q The next is for sections 1 & 8 only.

 \&.\e\*q .SH EXIT STATUS
 \&.\e\*q .SH EXIT STATUS

+\&.\e\*q For sections 1, 6 & 8 only.

 \&.\e\*q .SH EXAMPLES
 \&.\e\*q .SH EXAMPLES

-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.

 \&.\e\*q .SH DIAGNOSTICS
 \&.\e\*q .SH DIAGNOSTICS

-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q For sections 1, 4, 6, 7, & 8 only.

 \&.\e\*q .SH ERRORS
 \&.\e\*q .SH ERRORS

+\&.\e\*q For sections 2, 3, & 9 only.

 \&.\e\*q .SH SEE ALSO
 \&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS
 \&.\e\*q .SH SEE ALSO
 \&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS


@@ -246,6 +247,7 @@ The \efBfoo\efR utility processes files...
 \&.\e\*q .SH CAVEATS
 \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS
 \&.\e\*q .SH CAVEATS
 \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS

+\&.\e\*q Not used in OpenBSD.

 .Ed
 .Pp
 The sections in a
 .Ed
 .Pp
 The sections in a


@@ -338,11 +340,9 @@ If not adhering to any standards, the
 .Em HISTORY
 section should be used.
 .It Em HISTORY
 .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.
+A brief history of the subject, including where support first appeared.

 .It Em AUTHORS
 .It Em AUTHORS

-Credits to authors, if applicable, should appear in this section.
+Credits to the person or persons who wrote the code and/or documentation.

 Authors should generally be noted by both name and email address.
 .It Em CAVEATS
 Common misuses and misunderstandings should be explained
 Authors should generally be noted by both name and email address.
 .It Em CAVEATS
 Common misuses and misunderstandings should be explained


@@ -919,24 +919,46 @@ language.
 .Pp
 .Bl -dash -compact
 .It
 .Pp
 .Bl -dash -compact
 .It

-The \es (font size), \em (font colour), and \eM (font filling colour)
-font decoration escapes are all discarded in mandoc.
-.It

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

+troff suppresses a newline before
+.Sq \(aq
+macro output; in mandoc, it is an alias for the standard
+.Sq \&.
+control character.
+.It
+The
+.Sq \eh
+.Pq horizontal position ,
+.Sq \ev
+.Pq vertical position ,
+.Sq \em
+.Pq text colour ,
+.Sq \eM
+.Pq text filling colour ,
+.Sq \ez
+.Pq zero-length character ,
+.Sq \ew
+.Pq string length ,
+.Sq \ek
+.Pq horizontal position marker ,
+.Sq \eo
+.Pq text overstrike ,
+and
+.Sq \es
+.Pq text size
+escape sequences are all discarded in mandoc.
+.It
+The
+.Sq \ef
+scaling unit is accepted by mandoc, but rendered as the default unit.
+.It

 The
 .Sx \&sp
 macro does not accept negative values in mandoc.
 In GNU troff, this would result in strange behaviour.
 The
 .Sx \&sp
 macro does not accept negative values in mandoc.
 In GNU troff, this would result in strange behaviour.

-.It
-The
-.Sq \(aq
-macro control character, in GNU troff (and prior troffs) suppresses a
-newline before macro output; in mandoc, it is an alias for the standard
-.Sq \&.
-control character.

 .El
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .El
 .Sh SEE ALSO
 .Xr mandoc 1 ,