X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=docs%2FREADME.manpages;h=ce9ac26e4b4c8e0549253815b0ac2416feaf7b01;hb=d1cb667bddf8d1c5c0721fc7ab642c22946baf1f;hp=84275e946b58c18193631cff508d9f7ba8745b17;hpb=5459cb05a6f5bba960e6501b9f03d7e16bc54f41;p=mmh

diff --git a/docs/README.manpages b/docs/README.manpages
index 84275e9..ce9ac26 100644
--- a/docs/README.manpages
+++ b/docs/README.manpages
@@ -2,15 +2,13 @@ NMH MANPAGE STYLE GUIDE
 
 nmh manpages should be in this general form:
 
+.TH COMP %manext1% "DATE" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 comp \- compose a message
 .SH SYNOPSIS
-.HP 5
 .B comp 
 .RI [ +folder ]
 .RI [ msgs ]
@@ -22,36 +20,61 @@ comp \- compose a message
 .SH DESCRIPTION
 .B Comp
 is used to create a new message to be mailed.  It copies something.
-
 .SH FILES
-.fc ^ ~
-.nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^%etcdir%/components~^The standard message skeleton
-
+.TP
+filename1
+description of filename1
+.TP
+filename2
+description of filename2
 .SH "PROFILE COMPONENTS"
-.fc ^ ~
-.nf
-.ta 2.4i
-.ta \w'ExtraBigProfileName  'u
-^Path:~^To determine the user's nmh directory
-
+.TP
+Path
+Location of the user's MH folder directory
+.TP
+moreproc
+The pager command name
 .SH "SEE ALSO"
-dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)
-
+.IR dist (1),
+.IR forw (1),
+.IR repl (1),
+.IR send (1),
+.IR whatnow (1),
+.IR mh-profile (5)
 .SH DEFAULTS
-.nf
-.RB ` +folder "' defaults to the current folder"
-
+.TP
+.RI + folder
+defaults to the current folder
+.\"
 .SH CONTEXT
 None
-
+.\" Leave out the BUGS section if there are none worth describing.
 .SH BUGS
 None
 
----------------------------------------
-In the FILES section, use a spacer of "/usr/local/nmh/etc" for now,
-we'll parametrize that into %etcdir% later.
+---------------------------------------------------------------------
+
+The DATE in the .TH macro should reflect the most recent non-trivial
+update to the content of the manpage; formatting changes don't count.
+Spell out the date in English prose:  Month Day, Year
+
+  January 2, 1904
+
+not the unparseable
+
+  01/02/04
+
+
+Don't include a CONTEXT section if contexts don't directly apply to what the
+manpage describes.
+
+
+In the FILES section, prefer the default .TP indent. The pathnames are
+variable and long, so any indentation value that works for you won't
+work for someone else.
+
+
+The BUGS section goes last.
 
 
 Source files
@@ -95,7 +118,7 @@ Program names
 	If this is a manpage reference (outside of the SEE ALSO
 	section, which just uses regular text), use:
 
-		.BR mh-draft (5)
+		.IR mh-draft (5)
 
 SYNPOSIS section
 
@@ -171,3 +194,12 @@ Other italicized text
 	Enclose the file names and profile entries in lq/rq
 	quotes, too.
 
+Pointer manpages
+
+	Certain manpages are shared between one or more programs
+	(such as folder/folders). The secondary program should
+	have a man page that only contains:
+
+		.so man1/folder.1
+
+	Also, add this manpage to the appropriate section in Makefile.in