Removed leading space from lines in mhbuild and rmm man pages
[mmh] / man / rmm.man
1 .TH RMM %manext1% "November 9, 2010" "%nmhversion%"
2 .\"
3 .\" %nmhwarning%
4 .\"
5 .SH NAME
6 rmm \- remove messages
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B rmm
11 .RI [ +folder ]
12 .RI [ msgs ]
13 .RB [ \-unlink " | " \-nounlink ]
14 .RB [ \-version ]
15 .RB [ \-help ]
16 .ad
17 .SH DESCRIPTION
18 By default,
19 .B rmm
20 will remove the specified messages by renaming
21 each of the message files with a site-dependent prefix (usually a
22 comma).  Such files will then need to
23 be removed in some manner after a certain amount of time.  Many sites
24 arrange for
25 .B cron
26 to remove these files once a day, so check
27 with your system administrator.
28 .PP
29 Alternately, if you wish for
30 .B rmm
31 to really remove the files
32 representing these messages, you can use the
33 .B \-unlink
34 switch.  But
35 messages removed by this method cannot be later recovered.
36 .PP
37 If you prefer a more sophisticated method of `removing' messages, you
38 can define the
39 .I rmmproc
40 profile component.  For example, you can
41 add a profile component such as
42 .PP
43 .RS 5
44 rmmproc:        /home/foouser/bin/rmm_msgs
45 .RE
46 .PP
47 then instead of simply renaming the message file,
48 .B rmm
49 will call
50 the named program or script to handle the files that represent the
51 messages to be deleted.
52 .PP
53 Some users of
54 .B csh
55 prefer the following:
56 .PP
57 .RS 5
58 alias rmm 'refile +d'
59 .RE
60 .PP
61 where folder `+d' is a folder for deleted messages, and
62 .PP
63 .RS 5
64 alias mexp 'rm `mhpath +d all`'
65 .RE
66 .PP
67 is used to \*(lqexpunge\*(rq deleted messages.
68 .PP
69 The current message is not changed by
70 .BR rmm ,
71 so a
72 .B next
73 will
74 advance to the next message in the folder as expected.
75 .SH FILES
76 .fc ^ ~
77 .nf
78 .ta \w'%etcdir%/ExtraBigFileName  'u
79 ^$HOME/\&.mh\(ruprofile~^The user profile
80 .fi
81 .SH "PROFILE COMPONENTS"
82 .fc ^ ~
83 .nf
84 .ta 2.4i
85 .ta \w'ExtraBigProfileName  'u
86 ^Path:~^To determine the user's nmh directory
87 ^Current\-Folder:~^To find the default current folder
88 ^rmmproc:~^Program to delete the message
89 .fi
90 .SH "SEE ALSO"
91 .IR rmf (1)
92 .SH DEFAULTS
93 .nf
94 .RB ` +folder "' defaults to the current folder"
95 .RB ` msgs "' defaults to cur"
96 .RB ` -nounlink '
97 .fi
98 .SH CONTEXT
99 If a folder is given, it will become the current folder.
100 .SH BUGS
101 Since
102 .B refile
103 uses your
104 .I rmmproc
105 to delete the message,
106 the
107 .I rmmproc
108 must
109 .B NOT
110 call
111 .B refile
112 without specifying
113 .BR \-normmproc ,
114 or you will create an infinte loop.