summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-05-26 09:26:16 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-05-26 09:26:16 +0000
commit4b1ca02b9a9143c6c456632f7853d28bcf8bd38c (patch)
tree328ef73e8e0557c8f32e5b180789e9d560a6bd56
parentd3d4c18faefb1af859eae78c494eba84bd618743 (diff)
downloadmandoc-4b1ca02b9a9143c6c456632f7853d28bcf8bd38c.tar.gz
Noticed that our skeleton mdoc.7 had lower-case `Dt'. Fixed and added
some language for clarity.
-rw-r--r--man.712
-rw-r--r--mdoc.79
2 files changed, 13 insertions, 8 deletions
diff --git a/man.7 b/man.7
index dc8fb568..1b271f1f 100644
--- a/man.7
+++ b/man.7
@@ -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 aa2579df..2669d66e 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -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