aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/man.7
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
commitd5be9ce161a224472554ef4e69c35d03cb6e0e2d (patch)
treeabe4302795c6aa96d53fb5f21c0fc176df98f3b4 /man.7
parent2a0ea14f99cf58c73ef77bab9135cd3f9f72d944 (diff)
downloadmandoc-d5be9ce161a224472554ef4e69c35d03cb6e0e2d.tar.gz
mandoc-d5be9ce161a224472554ef4e69c35d03cb6e0e2d.tar.zst
mandoc-d5be9ce161a224472554ef4e69c35d03cb6e0e2d.zip
Noticed that our skeleton mdoc.7 had lower-case `Dt'. Fixed and added
some language for clarity.
Diffstat (limited to 'man.7')
-rw-r--r--man.716
1 files changed, 10 insertions, 6 deletions
diff --git a/man.7 b/man.7
index 876f32a3..8aa1f2c0 100644
--- 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