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

[mandoc.git] / mdoc.template

diff --git a/mdoc.template b/mdoc.template
index e9f7066543eb18d8db99fa91794858054e782580..f1b406efdc1c1b8226ff44e550ca6aa1c79898f2 100644 (file)
--- a/mdoc.template
+++ b/mdoc.template
@@ -2,37 +2,41 @@
 .\"
 .\" Copyright notice goes here.
 .\"
-.\" The uncommented requests are required for all man pages.
+.\" The uncommented requests are required for all manual pages.
 .\" The commented requests should be uncommented and used where appropriate.
 .\"
 .\" See mdoc(7) for further reference.
 .\"
 .Dd $\&Mdocdate$
-.Dt DOCUMENT_TITLE SECTION
+.Dt title section
 .Os
 .Sh NAME
-.\" The next request should be used for sections 2 and 3 only.
+.Nm name
+.Nd short description
 .\" .Sh LIBRARY
+.\" For sections 2, 3, & 9 only.
+.\" Not used in OpenBSD.
 .Sh SYNOPSIS
 .Sh DESCRIPTION
-.\" This next request is for sections 1 and 8 exit statuses only.
-.\" .Sh EXIT STATUS
-.\" This next request is for sections 2 and 3 function return values only.
+.\" .Sh IMPLEMENTATION NOTES
 .\" .Sh RETURN VALUES
-.\" This next request is for sections 1, 6, 7 & 8 only.
+.\" For sections 2, 3, & 9 only.
 .\" .Sh ENVIRONMENT
+.\" For sections 1, 6, 7 & 8 only.
 .\" .Sh FILES
+.\" .Sh EXIT STATUS
+.\" For sections 1, 6 & 8 only.
 .\" .Sh EXAMPLES
-.\" This next request is for sections 1, 6, 7 & 8 only
 .\" .Sh DIAGNOSTICS
-.\" The next request is for sections 2 and 3 error and signal handling only.
+.\" For sections 1, 4, 6, 7, & 8 only
 .\" .Sh ERRORS
+.\" For sections 2, 3, & 9 only.
 .\" .Sh SEE ALSO
-.\" Cross-references should be ordered by section (low to high), then in
-.\"     alphabetical order.
+.\" .Xr foobar 1
 .\" .Sh STANDARDS
 .\" .Sh HISTORY
 .\" .Sh AUTHORS
 .\" .Sh CAVEATS
 .\" .Sh BUGS
 .\" .Sh SECURITY CONSIDERATIONS
+.\" Not used in OpenBSD.