diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-05-12 08:41:17 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-05-12 08:41:17 +0000 |
commit | 2e08684b6f7079837888e14e0a2129df281b31e8 (patch) | |
tree | 1114a34b670fa4462fe646d8deae3992e3d3eb70 /man.7 | |
parent | 1caded1c8245d6b49a1f14453cd477f5c5920a15 (diff) | |
download | mandoc-2e08684b6f7079837888e14e0a2129df281b31e8.tar.gz |
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.7 | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -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 |