aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/man.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-05-12 08:41:17 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-05-12 08:41:17 +0000
commit9f11efb0307eb4c4dbb4a8fff243321100e27573 (patch)
tree1eec3760c1790106496b536cde695f4912d0278e /man.7
parentbc0b057e87136f91e81cd2c0f344327dabd21c7f (diff)
downloadmandoc-9f11efb0307eb4c4dbb4a8fff243321100e27573.tar.gz
mandoc-9f11efb0307eb4c4dbb4a8fff243321100e27573.tar.zst
mandoc-9f11efb0307eb4c4dbb4a8fff243321100e27573.zip
mdoc_atosec -> mdoc_str2sec (consistent with str2 being different from a2).
Changed ordering of sections (EXIT STATUS moved around), argued for by Ulrich Sporlein. Fixed mdoc_str2sec not to use weird structure.
Diffstat (limited to 'man.7')
-rw-r--r--man.724
1 files changed, 12 insertions, 12 deletions
diff --git a/man.7 b/man.7
index f410ced3..42a4044d 100644
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\" $Id: man.7,v 1.66 2010/05/08 22:26:39 kristaps Exp $
+.\" $Id: man.7,v 1.67 2010/05/12 08:41:17 kristaps Exp $
.\"
.\" Copyright (c) 2009 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.
.\"
-.Dd $Mdocdate: May 8 2010 $
+.Dd $Mdocdate: May 12 2010 $
.Dt MAN 7
.Os
.Sh NAME
@@ -232,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
@@ -298,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 ,
@@ -317,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