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 877385378cec76a00c2cefd616bbaf742a8b44cf..d1b12c83a98771b728341e7fcb2b9b6181749fa8 100644 (file)
--- a/man/rmm.man
+++ b/man/rmm.man
@@ -1,76 +1,137 @@
+.TH RMM %manext1% "March 18, 2013" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH RMM %manext1% MH.6.8 [%nmhversion%]

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

-.in +.5i
-.ti -.5i
-rmm
-\%[+folder] \%[msgs]
-\%[\-unlink] \%[\-nounlink]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B rmm
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-unlink " | " \-nounlink ]
+.RB [ \-rmmproc
+.IR program ]
+.RB [ \-normmproc ]
+.RB [ \-version ]
+.RB [ \-help ]
+.ad

 .SH DESCRIPTION
 .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
+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
 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
+arrange for
+.B cron
+to remove these files once a day, so check

 with your system administrator.
 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
+.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.
 messages removed by this method cannot be later recovered.

-
+.PP

 If you prefer a more sophisticated method of `removing' messages, you
 If you prefer a more sophisticated method of `removing' messages, you

-can define the \fIrmmproc\fR profile component.  For example, you can
+can define the
+.I rmmproc
+profile component.  For example, you can

 add a profile component such as
 add a profile component such as

-
-       rmmproc:        /home/coleman/bin/rmm_msgs
-
-then instead of simply renaming the message file, \fIrmm\fR will call
+.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 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`'
-
+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
+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.
 is used to \*(lqexpunge\*(rq deleted messages.

-
-The current message is not changed by \fIrmm\fR, so a \fInext\fR  will
+.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.
 advance to the next message in the folder as expected.

-.Fi
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%etcdir%/ExtraBigFileName  'u

 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^$HOME/\&.mh\(ruprofile~^The user profile

-.Pr
+.fi
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u

 ^Path:~^To determine the user's nmh directory
 ^Path:~^To determine the user's nmh directory

-.Ps

 ^Current\-Folder:~^To find the default current folder
 ^Current\-Folder:~^To find the default current folder

-.Ps

 ^rmmproc:~^Program to delete the message
 ^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.
 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
+.B NOT
+call
+.B rmm
+or
+.B refile
+without specifying
+.BR \-normmproc ,
+or you will create an infinite loop.