Don't clobber "cp"; use dp instead.

[nmh] / docs / README.manpages

diff --git a/docs/README.manpages b/docs/README.manpages
index 33693df31a7a173447d0043b1d89fafefff3dc21..86cd725cafd3f500cadbdd31182b5fabb3bbf8b4 100644 (file)
--- a/docs/README.manpages
+++ b/docs/README.manpages
@@ -1,6 +1,6 @@
 NMH MANPAGE STYLE GUIDE
 
 NMH MANPAGE STYLE GUIDE
 

-nmh manpages should be in this general form:
+nmh manpages should be in this general form and section order:

 
 .TH COMP %manext1% "DATE" "%nmhversion%"
 .\"
 
 .TH COMP %manext1% "DATE" "%nmhversion%"
 .\"


@@ -8,6 +8,7 @@ nmh manpages should be in this general form:
 .\"
 .SH NAME
 comp \- compose a message
 .\"
 .SH NAME
 comp \- compose a message

+.\"

 .SH SYNOPSIS
 .HP 5
 .na
 .SH SYNOPSIS
 .HP 5
 .na


@@ -23,13 +24,7 @@ comp \- compose a message
 .SH DESCRIPTION
 .B Comp
 is used to create a new message to be mailed.  It copies something.
 .SH DESCRIPTION
 .B Comp
 is used to create a new message to be mailed.  It copies something.

-.SH FILES
-.TP
-filename1
-description of filename1
-.TP
-filename2
-description of filename2
+.\"

 .SH "PROFILE COMPONENTS"
 .TP
 Path
 .SH "PROFILE COMPONENTS"
 .TP
 Path


@@ -37,13 +32,7 @@ Location of the user's MH folder directory
 .TP
 moreproc
 The pager command name
 .TP
 moreproc
 The pager command name

-.SH "SEE ALSO"
-.IR dist (1),
-.IR forw (1),
-.IR repl (1),
-.IR send (1),
-.IR whatnow (1),
-.IR mh-profile (5)
+.\"

 .SH DEFAULTS
 .TP
 .RI + folder
 .SH DEFAULTS
 .TP
 .RI + folder


@@ -51,6 +40,22 @@ defaults to the current folder
 .\"
 .SH CONTEXT
 None
 .\"
 .SH CONTEXT
 None

+.\"
+.SH FILES
+.TP
+filename1
+description of filename1
+.TP
+filename2
+description of filename2
+.\"
+.SH "SEE ALSO"
+.BR dist (1),
+.BR forw (1),
+.BR repl (1),
+.BR send (1),
+.BR whatnow (1),
+.BR mh-profile (5)

 .\" Leave out the BUGS section if there are none worth describing.
 .SH BUGS
 None
 .\" Leave out the BUGS section if there are none worth describing.
 .SH BUGS
 None


@@ -71,7 +76,7 @@ Don't abbreviate the month.
 
 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
 
 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.
+work for someone using a different directory layout.

 
 
 Source files
 
 
 Source files


@@ -112,9 +117,10 @@ Program names
                .B comp
                .BR comp ,
 
                .B comp
                .BR comp ,
 

-       If this is a manpage reference, use:
+       The first reference to a documented command should be in the form of
+       a manpage reference:

 
 

-               .IR mh-draft (5)
+               .BR comp (1)

 
 SYNPOSIS section
 
 
 SYNPOSIS section
 


@@ -202,7 +208,8 @@ Pointer manpages
        
 
 CONTEXT
        
 
 CONTEXT

-    Don't include a CONTEXT section when contexts are out of context.
+    Don't include a CONTEXT section when contexts are not
+    applicable.

 
 
 AUTHOR and HISTORY sections
 
 
 AUTHOR and HISTORY sections


@@ -212,4 +219,4 @@ AUTHOR and HISTORY sections
 
 BUGS
 
 
 BUGS
 

-    The BUGS section goes last.
+    The BUGS section goes last.