Finally switch over from vfork() to fork() completely.

[nmh] / docs / README.manpages

diff --git a/docs/README.manpages b/docs/README.manpages
index 8c6516a57dcf8b61373faef6cb6582d887fc9ffd..6d6111df8eb7616b768bf9a02866613154b6938f 100644 (file)
--- a/docs/README.manpages
+++ b/docs/README.manpages
@@ -1,13 +1,14 @@
 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% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH COMP %manext1% "DATE" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .SH NAME
 comp \- compose a message
 .\"
 .\" %nmhwarning%
 .\"
 .SH NAME
 comp \- compose a message

+.\"

 .SH SYNOPSIS
 .B comp 
 .RI [ +folder ]
 .SH SYNOPSIS
 .B comp 
 .RI [ +folder ]


@@ -20,13 +21,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


@@ -34,13 +29,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


@@ -48,14 +37,43 @@ 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"
+.IR dist (1),
+.IR forw (1),
+.IR repl (1),
+.IR send (1),
+.IR whatnow (1),
+.IR 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
 
 ---------------------------------------

+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 (no abbreviations or shortcuts):
+
+  January 2, 1904
+
+not the unparseable
+
+  01/02/04
+
+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


@@ -96,8 +114,7 @@ Program names
                .B comp
                .BR comp ,
 
                .B comp
                .BR comp ,
 

-       If this is a manpage reference (outside of the SEE ALSO
-       section, which just uses regular text), use:
+       If this is a manpage reference, use:

 
                .IR mh-draft (5)
 
 
                .IR mh-draft (5)
 


@@ -184,3 +201,18 @@ Pointer manpages
                .so man1/folder.1
 
        Also, add this manpage to the appropriate section in Makefile.in
                .so man1/folder.1
 
        Also, add this manpage to the appropriate section in Makefile.in

+       
+
+CONTEXT
+    Don't include a CONTEXT section when contexts are not
+    applicable.
+
+
+AUTHOR and HISTORY sections
+
+    These have no place in a manpage.  If you want everlasting glory,
+    try the release notes.
+
+BUGS
+
+    The BUGS section goes last.