Renamed -version switch to -Version to remove the conflict with -verbose.

[mmh] / docs / README.manpages

diff --git a/docs/README.manpages b/docs/README.manpages
index 84275e9..a6edee8 100644 (file)
--- a/docs/README.manpages
+++ b/docs/README.manpages
@@ -4,20 +4,19 @@ nmh manpages should be in this general form:
 
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
 .TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 comp \- compose a message
 .SH SYNOPSIS
 .HP 5
-.B comp 
+.B comp
 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-form
 .IR formfile ]
 .RB [ \-use " | " \-nouse ]
-.RB [ \-version ]
+.RB [ \-Version ]
 .RB [ \-help ]
 .SH DESCRIPTION
 .B Comp
@@ -70,8 +69,8 @@ Source files
                .PP
 
        Of course, replace "components" with a unique identifier that
-       reflects the content being included, like "mts_conf" for
-       etc/mts.conf. Then, add two lines to the man.sed target in
+       reflects the content being included, like "mhl_reply" for
+       etc/mhl.reply. Then, add two lines to the man.sed target in
        Makefile.in like:
 
                echo '/%components%/r $(top_srcdir)/etc/components' >> $@
@@ -106,7 +105,7 @@ SYNPOSIS section
 
                .RI [ +folder ]              <---- parameter
                .RI [ msgs ]                 <---- parameter
-               .RB [ \-version ]            <---- flag
+               .RB [ \-Version ]            <---- flag
                .RB [ \-editor               <---- flag with
                .IR editor ]                       parameter
                .RB [ \-use " | " \-nouse ]  <---- exclusive parameters
@@ -171,3 +170,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