Factor trim format function out
[mmh] / man / rmf.man1
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH RMF %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 rmf \- remove an mh folder
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B rmf
11 .RI [ +folder ]
12 .RB [ \-interactive " | " \-nointeractive ]
13 .RB [ \-Version ]
14 .RB [ \-help ]
15 .ad
16 .SH DESCRIPTION
17 .B Rmf
18 removes all of the messages (files) within the specified
19 (or default) folder, and then removes the folder (directory) itself.
20 .PP
21 If there are any files within the folder which are not a part of
22 .BR mmh ,
23 they will
24 .B not
25 be removed, and an error will be produced.
26 If the folder is given explicitly or the
27 .B \-nointeractive
28 option is
29 given, then the folder will be removed without confirmation.  Otherwise,
30 the user will be asked for confirmation.  If
31 .B rmf
32 can't find the
33 current folder, for some reason, the folder to be removed defaults to
34 `+inbox' (unless overridden by user's profile entry `Inbox')
35 with confirmation.
36 .PP
37 If the folder being removed is a subfolder, the parent folder will become
38 the new current folder, and
39 .B rmf
40 will produce a message telling the
41 user this has happened.  This provides an easy mechanism for selecting
42 a set of messages, operating on the list, then removing the list and
43 returning to the current folder from which the list was extracted.
44 .PP
45 If
46 .B rmf
47 s used on a read\-only folder, it will delete all the
48 (private) sequences
49 (i.e.,
50 .RI `atr\- seq \- folder '
51 entries) for this folder
52 from your context without affecting the folder itself.
53 .PP
54 .B Rmf
55 irreversibly deletes messages that don't have other links, so
56 use it with caution.
57
58 .SH FILES
59 .fc ^ ~
60 .nf
61 .ta \w'%etcdir%/ExtraBigFileName  'u
62 ^$HOME/.mmh/profile~^The user profile
63 .fi
64
65 .SH "PROFILE COMPONENTS"
66 .fc ^ ~
67 .nf
68 .ta 2.4i
69 .ta \w'ExtraBigProfileName  'u
70 ^Path:~^To determine the user's mail storage
71 ^Current\-Folder:~^To find the default current folder
72 ^Inbox:~^To find the default inbox
73 .fi
74
75 .SH "SEE ALSO"
76 rmm(1)
77
78 .SH DEFAULTS
79 .nf
80 .RB ` +folder "' defaults to the current folder, usually with confirmation"
81 .RB ` \-interactive "' if +folder' not given, `\-nointeractive' otherwise"
82 .fi
83
84 .SH CONTEXT
85 .B Rmf
86 will set the current folder to the parent folder if a
87 subfolder is removed; or if the current folder is removed, it will make
88 `inbox' current.  Otherwise, it doesn't change the current folder
89 or message.
90
91 .SH BUGS
92 Although intuitively one would suspect that
93 .B rmf
94 works recursively,
95 it does not.  Hence if you have a sub\-folder within a folder, in order
96 to
97 .B rmf
98 the parent, you must first
99 .B rmf
100 each of the children.