summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-08-28 22:08:38 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-08-28 22:08:38 +0000
commitf42092d362ac5b29c3cd9487593bf65790c21f3f (patch)
treecda5ada5f24b9ff5f73ad240c6f8c4b347c8e433
parentbbd2dbe296f7aef56589a057052529265159e85f (diff)
downloadmandoc-f42092d362ac5b29c3cd9487593bf65790c21f3f.tar.gz
Move mdoc/man template "The next is for" into the section itself. Added
OpenBSD compatibility notes. Based on a patch by Jason McIntyre.
-rw-r--r--man.714
-rw-r--r--mdoc.714
-rw-r--r--mdoc.template14
3 files changed, 24 insertions, 18 deletions
diff --git a/man.7 b/man.7
index ca607f1a..e587e094 100644
--- a/man.7
+++ b/man.7
@@ -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
-\&.\e\*q The next is for sections 2 & 3 only.
\&.\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
-\&.\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 For sections 2, 3, & 9 only.
\&.\e\*q .SH ENVIRONMENT
+\&.\e\*q For sections 1, 6, 7, & 8 only.
\&.\e\*q .SH FILES
-\&.\e\*q The next is for sections 1 & 8 only.
\&.\e\*q .SH EXIT STATUS
+\&.\e\*q For sections 1 & 8 only.
\&.\e\*q .SH EXAMPLES
-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
\&.\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 For sections 2, 3, & 9 only.
\&.\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 Not used in OpenBSD.
.Ed
.Pp
The sections in a
diff --git a/mdoc.7 b/mdoc.7
index 5bc5f736..358a1c38 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -331,8 +331,9 @@ file:
\&.Sh NAME
\&.Nm foo
\&.Nd a description goes here
-\&.\e\*q The next is for sections 2, 3, & 9 only.
\&.\e\*q .Sh LIBRARY
+\&.\e\*q For sections 2, 3, & 9 only.
+\&.\e\*q Not used in OpenBSD.
\&.Sh SYNOPSIS
\&.Nm foo
\&.Op Fl options
@@ -342,18 +343,18 @@ The
\&.Nm
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 The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q For sections 2, 3, & 9 only.
\&.\e\*q .Sh ENVIRONMENT
+\&.\e\*q For sections 1, 6, 7, & 8 only.
\&.\e\*q .Sh FILES
-\&.\e\*q The next is for sections 1 & 8 only.
\&.\e\*q .Sh EXIT STATUS
+\&.\e\*q For sections 1 & 8 only.
\&.\e\*q .Sh EXAMPLES
-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
\&.\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 For sections 2, 3, & 9 only.
\&.\e\*q .Sh SEE ALSO
\&.\e\*q .Xr foobar 1
\&.\e\*q .Sh STANDARDS
@@ -362,6 +363,7 @@ utility processes files ...
\&.\e\*q .Sh CAVEATS
\&.\e\*q .Sh BUGS
\&.\e\*q .Sh SECURITY CONSIDERATIONS
+\&.\e\*q Not used in OpenBSD.
.Ed
.Pp
The sections in an
diff --git a/mdoc.template b/mdoc.template
index 034304a4..ba39fcce 100644
--- a/mdoc.template
+++ b/mdoc.template
@@ -13,23 +13,24 @@
.Sh NAME
.Nm name
.Nd short description
-.\" The next is for sections 2, 3, & 9 only.
.\" .Sh LIBRARY
+.\" For sections 2, 3, & 9 only.
+.\" Not used in OpenBSD.
.Sh SYNOPSIS
.Sh DESCRIPTION
.\" .Sh IMPLEMENTATION NOTES
-.\" The next is for sections 2, 3, & 9 only.
.\" .Sh RETURN VALUES
-.\" The next 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
-.\" The next is for sections 1 & 8 only.
.\" .Sh EXIT STATUS
+.\" For sections 1 & 8 only.
.\" .Sh EXAMPLES
-.\" The next is for sections 1, 4, 6, 7, & 8 only
.\" .Sh DIAGNOSTICS
-.\" The next is for sections 2, 3, & 9 only.
+.\" For sections 1, 4, 6, 7, & 8 only
.\" .Sh ERRORS
+.\" For sections 2, 3, & 9 only.
.\" .Sh SEE ALSO
.\" .Xr foobar 1
.\" .Sh STANDARDS
@@ -38,3 +39,4 @@
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
+.\" Not used in OpenBSD.