]> git.cameronkatri.com Git - mandoc.git/commitdiff
Noticed that our skeleton mdoc.7 had lower-case `Dt'. Fixed and added
authorKristaps Dzonsons <kristaps@bsd.lv>
Thu, 26 May 2011 09:26:16 +0000 (09:26 +0000)
committerKristaps Dzonsons <kristaps@bsd.lv>
Thu, 26 May 2011 09:26:16 +0000 (09:26 +0000)
some language for clarity.

man.7
mdoc.7

diff --git a/man.7 b/man.7
index 876f32a3122d3622cdb6cba39659f2e70b8a0b78..8aa1f2c0ec0539ba39b2c35a5aafdcaa45df7a12 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.99 2011/03/07 01:35:51 schwarze Exp $
+.\"    $Id: man.7,v 1.100 2011/05/26 09:26:16 kristaps Exp $
 .\"
 .\" Copyright (c) 2009, 2010 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: March 7 2011 $
+.Dd $Mdocdate: May 26 2011 $
 .Dt MAN 7
 .Os
 .Sh NAME
@@ -205,16 +205,20 @@ appears as the first macro.
 Beyond
 .Sx \&TH ,
 at least one macro or text node must appear in the document.
-Documents are generally structured as follows:
+.Pp
+The following is a well-formed skeleton
+.Nm
+file for a utility
+.Qq progname :
 .Bd -literal -offset indent
-\&.TH FOO 1 2009-10-10
+\&.TH PROGNAME 1 2009-10-10
 \&.SH NAME
-\efBfoo\efR \e(en a description goes here
+\efBprogname\efR \e(en a description goes here
 \&.\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...
+\efBprogname\efR [\efB\e-options\efR] arguments...
 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES
diff --git a/mdoc.7 b/mdoc.7
index e52eb49f3b0fc122090f46cfa86f4c00e9499090..5bd8aa109fd7c8ede9bdfbba123cde6d62e3e2fc 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\"    $Id: mdoc.7,v 1.187 2011/05/21 15:55:42 schwarze Exp $
+.\"    $Id: mdoc.7,v 1.188 2011/05/26 09:26:16 kristaps Exp $
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,7 +15,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 21 2011 $
+.Dd $Mdocdate: May 26 2011 $
 .Dt MDOC 7
 .Os
 .Sh NAME
@@ -296,19 +296,20 @@ sections, although this varies between manual sections.
 .Pp
 The following is a well-formed skeleton
 .Nm
-file:
+file for a utility
+.Qq progname :
 .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$
-\&.Dt mdoc 7
+\&.Dt PROGNAME section
 \&.Os
 \&.Sh NAME
-\&.Nm foo
+\&.Nm progname
 \&.Nd a description goes here
 \&.\e\*q .Sh LIBRARY
 \&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q Not used in OpenBSD.
 \&.Sh SYNOPSIS
-\&.Nm foo
+\&.Nm progname
 \&.Op Fl options
 \&.Ar
 \&.Sh DESCRIPTION