updated ali-flist, with batch edit of others
[mmh] / man / rmm.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
9 .SH NAME
10 rmm \- remove messages
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 rmm
15 \%[+folder] \%[msgs]
16 \%[\-unlink] \%[\-nounlink]
17 .br
18 \%[\-version]
19 \%[\-help]
20 .in -.5i
21 .SH DESCRIPTION
22 By default, \fIrmm\fR will remove the specified messages by renaming
23 the message files with preceding commas.  Such files will then need to
24 be removed in some manner after a certain amount of time.  Many sites
25 arrange for \fIcron\fR\0(8) to remove these files once a day, so check
26 with your system administrator.
27
28 Alternately, if you wish for \fIrmm\fR to really remove the files
29 representing these messages, you can use the `-unlink' switch.  But
30 messages removed by this method cannot be later recovered.
31
32 If you prefer a more sophisticated method of `removing' messages, you
33 can define the \fIrmmproc\fR profile component.  For example, you can
34 add a profile component such as
35
36         rmmproc:        /home/coleman/bin/rmm_msgs
37
38 then instead of simply renaming the message file, \fIrmm\fR will call
39 the named program or script to handle the files that represent the
40 messages to be deleted.
41
42 Some users of csh prefer the following:
43
44         alias rmm 'refile +d'
45
46 where folder +d is a folder for deleted messages, and
47
48         alias mexp 'rm `mhpath +d all`'
49
50 is used to \*(lqexpunge\*(rq deleted messages.
51
52 The current message is not changed by \fIrmm\fR, so a \fInext\fR  will
53 advance to the next message in the folder as expected.
54 .Fi
55 ^$HOME/\&.mh\(ruprofile~^The user profile
56 .Pr
57 ^Path:~^To determine the user's nmh directory
58 .Ps
59 ^Current\-Folder:~^To find the default current folder
60 .Ps
61 ^rmmproc:~^Program to delete the message
62 .Sa
63 refile(1), rmf(1)
64 .De
65 `+folder' defaults to the current folder
66 .Ds
67 `msgs' defaults to cur
68 .Ds
69 `-nounlink'
70 .Co
71 If a folder is given, it will become the current folder.
72 .Bu
73 Since \fIrefile\fR uses your \fIrmmproc\fP to delete the message,
74 the \fIrmmproc\fP must \fBNOT\fP call \fIrefile\fP without specifying
75 `\-normmproc', or you will create an infinte loop.
76 .En