new.c: Order two return statements to match comment.

[nmh] / man / rmm.man

diff --git a/man/rmm.man b/man/rmm.man
index d8cdf8bc479d719c97757ffe629e265689b8f57f..2a352e0f98484f0ace0fe650068643e95c633122 100644 (file)
--- a/man/rmm.man
+++ b/man/rmm.man
@@ -1,54 +1,70 @@
-.\"
+.TH RMM %manext1% 2013-03-19 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\" $Id$
-.\"
-.TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

-rmm \- remove messages
+rmm \- remove nmh messages

 .SH SYNOPSIS
 .HP 5
 .na
 .B rmm
 .SH SYNOPSIS
 .HP 5
 .na
 .B rmm

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ msgs ]
 .RI [ +folder ]
 .RI [ msgs ]

-.RB [ \-link " | " \-nolink ]
-.RB [ \-version ]
-.RB [ \-help ]
+.RB [ \-unlink " | " \-nounlink ]
+.RB [ \-rmmproc
+.IR program ]
+.RB [ \-normmproc ]

 .ad
 .SH DESCRIPTION
 By default,
 .B rmm
 .ad
 .SH DESCRIPTION
 By default,
 .B rmm

-will remove the specified messages by renaming
-the message files with preceding commas.  Such files will then need to
-be removed in some manner after a certain amount of time.  Many sites
-arrange for
+will remove the specified messages by renaming each of the message files
+with a site-dependent prefix (usually a comma).
+Such files will then need to be removed in some manner after a period of
+time.
+Many sites arrange for

 .B cron
 .B cron

-to remove these files once a day, so check
-with your system administrator.
+to remove these files once a day, so check with your system administrator.

 .PP
 Alternately, if you wish for
 .B rmm
 .PP
 Alternately, if you wish for
 .B rmm

-to really remove the files
-representing these messages, you can use the
+to really remove the files representing these messages, you can use the

 .B \-unlink
 .B \-unlink

-switch.  But
-messages removed by this method cannot be later recovered.
+switch.
+But messages removed by this method cannot be later recovered.

 .PP
 If you prefer a more sophisticated method of `removing' messages, you
 can define the
 .I rmmproc
 .PP
 If you prefer a more sophisticated method of `removing' messages, you
 can define the
 .I rmmproc

-profile component.  For example, you can
-add a profile component such as
+profile component.
+For example, you can add a profile component such as

 .PP
 .RS 5
 .PP
 .RS 5

-rmmproc:       /home/foouser/bin/rmm_msgs
+rmmproc:    /home/foouser/bin/rmm_msgs

 .RE
 .PP
 .RE
 .PP

-then instead of simply renaming the message file,
+Then instead of simply renaming the message file,

 .B rmm
 .B rmm

-will call
-the named program or script to handle the files that represent the
-messages to be deleted.
+will call the named program or script to handle the files that
+represent the messages to be deleted.
+The
+.B \-rmmproc
+switch may be used to override this profile component.  The
+.B \-normmproc
+switch disables the use of any
+.I rmmproc
+profile component and negates all prior
+.B \-rmmproc
+switches.
+.PP
+An example of a
+.I rmmproc
+script that saves a message based in its Message-ID is provided in
+%nmhetcdir%/rmmproc.messageid.  To enable it, simply add an
+.I rmmproc
+component that names it, to your profile.

 .PP
 Some users of
 .B csh
 .PP
 Some users of
 .B csh


@@ -70,16 +86,13 @@ The current message is not changed by
 .BR rmm ,
 so a
 .B next
 .BR rmm ,
 so a
 .B next

- will
-advance to the next message in the folder as expected.
-
+will advance to the next message in the folder as expected.

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile

 .fi
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf


@@ -89,32 +102,31 @@ advance to the next message in the folder as expected.
 ^Current\-Folder:~^To find the default current folder
 ^rmmproc:~^Program to delete the message
 .fi
 ^Current\-Folder:~^To find the default current folder
 ^rmmproc:~^Program to delete the message
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-refile(1), rmf(1)
-
+.IR rmf (1)

 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"
 .RB ` -nounlink '
 .fi
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"
 .RB ` -nounlink '
 .fi

-

 .SH CONTEXT
 If a folder is given, it will become the current folder.
 .SH CONTEXT
 If a folder is given, it will become the current folder.

-

 .SH BUGS
 Since
 .SH BUGS
 Since

+.B rmm
+and

 .B refile
 .B refile

-uses your
+use your

 .I rmmproc
 .I rmmproc

-to delete the message,
-the
+to delete the message, the

 .I rmmproc
 must
 .I rmmproc
 must

-.B NOT
+.I not

 call
 call

+.B rmm
+or

 .B refile
 without specifying
 .BR \-normmproc ,
 .B refile
 without specifying
 .BR \-normmproc ,

-or you will create an infinte loop.
+or you will create an infinite loop.