X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/cbce5e434f84af560946e16709d3c2ad10eb8942..9f8418e870a70c264eda1598f2d470e5428c216d:/man/rmm.man diff --git a/man/rmm.man b/man/rmm.man index dbd24373..05081756 100644 --- a/man/rmm.man +++ b/man/rmm.man @@ -1,4 +1,4 @@ -.TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH RMM %manext1% "March 18, 2013" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -8,11 +8,14 @@ rmm \- remove messages .HP 5 .na .B rmm +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] .RI [ msgs ] .RB [ \-unlink " | " \-nounlink ] -.RB [ \-version ] -.RB [ \-help ] +.RB [ \-rmmproc +.IR program ] +.RB [ \-normmproc ] .ad .SH DESCRIPTION By default, @@ -44,11 +47,27 @@ add a profile component such as 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. +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 a +.I rmmproc +component that names it to your profile. .PP Some users of .B csh @@ -70,12 +89,12 @@ The current message is not changed by .BR rmm , so a .B next - will +will advance to the next message in the folder as expected. .SH FILES .fc ^ ~ .nf -.ta \w'%etcdir%/ExtraBigFileName 'u +.ta \w'%nmhetcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile .fi .SH "PROFILE COMPONENTS" @@ -88,7 +107,7 @@ advance to the next message in the folder as expected. ^rmmproc:~^Program to delete the message .fi .SH "SEE ALSO" -refile(1), rmf(1) +.IR rmf (1) .SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" @@ -99,8 +118,10 @@ refile(1), rmf(1) If a folder is given, it will become the current folder. .SH BUGS Since +.B rmm +and .B refile -uses your +use your .I rmmproc to delete the message, the @@ -108,7 +129,9 @@ the must .B NOT call +.B rmm +or .B refile without specifying .BR \-normmproc , -or you will create an infinte loop. +or you will create an infinite loop.