X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/2e768e3cc0ce768373d3320eca4cdd08b8cf646a..94187a80bd60baab4b9c4b949ad820d730578123:/man/rmm.man diff --git a/man/rmm.man b/man/rmm.man index 52ac7f4d..818c8f17 100644 --- a/man/rmm.man +++ b/man/rmm.man @@ -1,61 +1,70 @@ -.TH RMM %manext1% "February 13, 2013" "%nmhversion%" -.\" +.TH RMM %manext1% 2013-03-19 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -rmm \- remove messages +rmm \- remove nmh messages .SH SYNOPSIS .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, .B rmm -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 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 -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 -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 -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 -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 -rmmproc: /home/foouser/bin/rmm_msgs +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. +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 +%nmhetcdir%/rmmproc.messageid. To enable it, simply add an .I rmmproc -component that names it to your profile. +component that names it, to your profile. .PP Some users of .B csh @@ -68,7 +77,7 @@ alias rmm 'refile +d' where folder `+d' is a folder for deleted messages, and .PP .RS 5 -alias mexp 'rm `mhpath +d all`' +alias mexp 'rm \`mhpath +d all\`' .RE .PP is used to \*(lqexpunge\*(rq deleted messages. @@ -77,13 +86,12 @@ The current message is not changed by .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 -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile +.ta \w'%nmhetcdir%/ExtraBigFileName 'u +^$HOME/.mh_profile~^The user profile .fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -106,16 +114,19 @@ advance to the next message in the folder as expected. 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 +to delete the message, the .I rmmproc must -.B NOT +.I 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.