-.\"
+.TH RMM %manext1% 2013-03-19 "%nmhversion%"
+.
.\" %nmhwarning%
-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.
.SH NAME
-rmm \- remove messages
+rmm \- remove nmh messages
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-rmm
-\%[+folder] \%[msgs]
-\%[\-unlink] \%[\-nounlink]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B rmm
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-unlink " | " \-nounlink ]
+.RB [ \-rmmproc
+.IR program ]
+.RB [ \-normmproc ]
+.ad
.SH DESCRIPTION
-By default, \fIrmm\fR 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 \fIcron\fR\0(8) to remove these files once a day, so check
-with your system administrator.
-
-Alternately, if you wish for \fIrmm\fR to really remove the files
-representing these messages, you can use the `-unlink' switch. But
-messages removed by this method cannot be later recovered.
-
+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 period of
+time.
+Many sites arrange for
+.B cron
+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
+.B \-unlink
+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 \fIrmmproc\fR profile component. For example, you can
-add a profile component such as
-
- rmmproc: /home/coleman/bin/rmm_msgs
-
-then instead of simply renaming the message file, \fIrmm\fR will call
-the named program or script to handle the files that represent the
-messages to be deleted.
-
-Some users of csh prefer the following:
-
- alias rmm 'refile +d'
-
-where folder +d is a folder for deleted messages, and
-
- alias mexp 'rm `mhpath +d all`'
-
+can define the
+.I rmmproc
+profile component.
+For example, you can add a profile component such as
+.PP
+.RS 5
+rmmproc: /home/foouser/bin/rmm_msgs
+.RE
+.PP
+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 an
+.I rmmproc
+component that names it, to your profile.
+.PP
+Some users of
+.B csh
+prefer the following:
+.PP
+.RS 5
+alias rmm 'refile +d'
+.RE
+.PP
+where folder `+d' is a folder for deleted messages, and
+.PP
+.RS 5
+alias mexp 'rm `mhpath +d all`'
+.RE
+.PP
is used to \*(lqexpunge\*(rq deleted messages.
-
-The current message is not changed by \fIrmm\fR, so a \fInext\fR will
-advance to the next message in the folder as expected.
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+.PP
+The current message is not changed by
+.BR rmm ,
+so a
+.B next
+will advance to the next message in the folder as expected.
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%nmhetcdir%/ExtraBigFileName 'u
+^$HOME/.mh_profile~^The user profile
+.fi
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName 'u
^Path:~^To determine the user's nmh directory
-.Ps
^Current\-Folder:~^To find the default current folder
-.Ps
^rmmproc:~^Program to delete the message
-.Sa
-refile(1), rmf(1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to cur
-.Ds
-`-nounlink'
-.Co
+.fi
+.SH "SEE ALSO"
+.IR rmf (1)
+.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.
-.Bu
-Since \fIrefile\fR uses your \fIrmmproc\fP to delete the message,
-the \fIrmmproc\fP must \fBNOT\fP call \fIrefile\fP without specifying
-`\-normmproc', or you will create an infinte loop.
-.En
+.SH BUGS
+Since
+.B rmm
+and
+.B refile
+use your
+.I rmmproc
+to delete the message, the
+.I rmmproc
+must
+.I not
+call
+.B rmm
+or
+.B refile
+without specifying
+.BR \-normmproc ,
+or you will create an infinite loop.
projects / nmh / blobdiff