summaryrefslogtreecommitdiff
path: root/share/misc/mdoc.template
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2003-05-29 08:46:23 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2003-05-29 08:46:23 +0000
commit4da74f74dd5be6b35f22c14569ada2c7a8dcbad3 (patch)
treed95a4262374a237c3eabbd5cdb4e275297a1893c /share/misc/mdoc.template
parent3029fa71f4bce0d5607e03ff3d679491b99999ce (diff)
sync docs to agree on section header (.Sh) order for man pages. This also
matches order used by NetBSD, though we don't use all their sections. Order is: NAME SYNOPSIS DESCRIPTION RETURN VALUES ENVIRONMENT FILES EXAMPLES DIAGNOSTICS ERRORS SEE ALSO STANDARDS HISTORY AUTHORS CAVEATS BUGS ok krw@ millert@
Diffstat (limited to 'share/misc/mdoc.template')
-rw-r--r--share/misc/mdoc.template19
1 files changed, 9 insertions, 10 deletions
diff --git a/share/misc/mdoc.template b/share/misc/mdoc.template
index b4fd352c126..918f7faa9eb 100644
--- a/share/misc/mdoc.template
+++ b/share/misc/mdoc.template
@@ -1,4 +1,4 @@
-.\" $OpenBSD: mdoc.template,v 1.6 2001/02/03 08:22:44 niklas Exp $
+.\" $OpenBSD: mdoc.template,v 1.7 2003/05/29 08:46:22 jmc Exp $
.\"
.\" The following requests are required for all man pages.
.Dd Month DD, YYYY
@@ -6,7 +6,7 @@
.Os
.Sh NAME
.Nm program
-.Nd one line about what it does
+.Nd one line about what it does
.Sh SYNOPSIS
.\" For a program: program [-abc] file ...
.Nm program
@@ -17,21 +17,20 @@ The
.Nm
utility processes files ...
.\" The following requests should be uncommented and used where appropriate.
-.\" .Sh EXAMPLES
.\" This next request is for sections 2 and 3 function return values only.
.\" .Sh RETURN VALUES
-.\" The next request is for sections 2 and 3 error and signal handling only.
-.\" .Sh ERRORS
-.\" This next request is for section 4 only.
-.\" .Sh DIAGNOSTICS
.\" This next request is for sections 1, 6, 7 & 8 only.
.\" .Sh ENVIRONMENT
.\" .Sh FILES
+.\" .Sh EXAMPLES
+.\" This next request is for section 4 only.
+.\" .Sh DIAGNOSTICS
+.\" The next request is for sections 2 and 3 error and signal handling only.
+.\" .Sh ERRORS
.\" .Sh SEE ALSO
.\" .Xr foobar 1
-.\" .Sh COMPATIBILITY
.\" .Sh STANDARDS
-.\" .Sh AUTHORS
.\" .Sh HISTORY
-.\" .Sh BUGS
+.\" .Sh AUTHORS
.\" .Sh CAVEATS
+.\" .Sh BUGS