Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / conf / doc / rmf.rf
1 .\"     @(MHWARNING)
2 .\" @(#)$Id: rmf.rf,v 1.7 1992/05/12 22:24:59 jromine Exp $
3 .SC RMF 1
4 .NA
5 rmf \- remove an MH folder
6 .SY
7 rmf 
8 \%[+folder]
9 \%[\-interactive] \%[\-nointeractive]
10 \%[\-help]
11 .DE
12 \fIRmf\fR removes all of the messages (files) within the specified
13 (or default) folder,
14 and then removes the folder (directory) itself.
15 If there are any files within the folder which are not a part of \fIMH\fR,
16 they will \fInot\fR be removed, and an error will be produced.
17 If the folder is given explicitly or the `\-nointeractive' option is given,
18 then the folder will be removed without confirmation.
19 Otherwise, the user will be asked for confirmation.
20 If \fIrmf\fR can't find the current folder, for some reason,
21 the folder to be removed defaults to `+inbox' (unless overridden by
22 user's profile entry \*(lqInbox\*(rq) with confirmation.
23
24 \fIRmf\fR irreversibly deletes messages that don't have other links,
25 so use it with caution.
26
27 If the folder being removed is a subfolder, the parent
28 folder will become the new current folder, and \fIrmf\fR will
29 produce a message telling the user this has happened.
30 This provides an easy mechanism for selecting a set of messages,
31 operating on the list, then removing the list and returning to
32 the current folder from which the list was extracted.
33
34 \fIRmf\fR of a read\-only folder will delete the private sequence
35 and cur information
36 (i.e., \*(lqatr\-\fIseq\fR\-\fIfolder\fR\*(rq entries)
37 from the profile without affecting the folder itself.
38 .Fi
39 ^$HOME/\&.mh\(ruprofile~^The user profile
40 .Pr
41 ^Path:~^To determine the user's MH directory
42 .Ps
43 ^Current\-Folder:~^To find the default current folder
44 .Ps
45 ^Inbox:~^To find the default inbox
46 .Sa
47 rmm(1)
48 .De
49 `+folder' defaults to the current folder, usually with confirmation
50 .Ds
51 `\-interactive' if +folder' not given, `\-nointeractive' otherwise
52 .Co
53 \fIRmf\fR will set the current folder to the parent folder if a
54 subfolder is removed; or if the current folder is removed,
55 it will make \*(lqinbox\*(rq current.
56 Otherwise, it doesn't change the
57 current folder or message.
58 .Bu
59 Although intuitively one would suspect that \fIrmf\fR works recursively,
60 it does not.
61 Hence if you have a sub\-folder within a folder,
62 in order to \fIrmf\fR the parent,
63 you must first \fIrmf\fR each of the children.
64 .En