Added note that suffixes were removed from filenames of temporary files.

[nmh] / man / rmm.man

diff --git a/man/rmm.man b/man/rmm.man
index d8cdf8bc479d719c97757ffe629e265689b8f57f..d1b12c83a98771b728341e7fcb2b9b6181749fa8 100644 (file)
--- a/man/rmm.man
+++ b/man/rmm.man
@@ -1,8 +1,7 @@
+.TH RMM %manext1% "March 18, 2013" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 rmm \- remove messages
 .SH SYNOPSIS
 .SH NAME
 rmm \- remove messages
 .SH SYNOPSIS


@@ -11,7 +10,10 @@ rmm \- remove messages
 .B rmm
 .RI [ +folder ]
 .RI [ msgs ]
 .B rmm
 .RI [ +folder ]
 .RI [ msgs ]

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

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


@@ -19,7 +21,8 @@ rmm \- remove messages
 By default,
 .B rmm
 will remove the specified messages by renaming
 By default,
 .B rmm
 will remove the specified messages by renaming

-the message files with preceding commas.  Such files will then need to
+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 certain amount of time.  Many sites
 arrange for
 .B cron
 be removed in some manner after a certain amount of time.  Many sites
 arrange for
 .B cron


@@ -44,11 +47,27 @@ add a profile component such as
 rmmproc:       /home/foouser/bin/rmm_msgs
 .RE
 .PP
 rmmproc:       /home/foouser/bin/rmm_msgs
 .RE
 .PP

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

 .B rmm
 will call
 the named program or script to handle the files that represent the
 messages to be deleted.
 .B rmm
 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
+%etcdir%/rmmproc.messageid.  To enable it, simply add a
+.I rmmproc
+component that names it to your profile.

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


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

- will
+will

 advance to the next message in the folder as expected.
 advance to the next message in the folder as expected.

-

 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi

-

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


@@ -89,24 +106,22 @@ 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
 to delete the message,
 the
 .I rmmproc
 to delete the message,
 the


@@ -114,7 +129,9 @@ the
 must
 .B NOT
 call
 must
 .B NOT
 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.