]> diplodocus.org Git - nmh/blob - docs/historical/mh-jun-1982/man/rmf.1
Replaced use of snprintf() with memcpy()/memmove().
[nmh] / docs / historical / mh-jun-1982 / man / rmf.1
1 .TH RMF 1 RAND
2 .SH NAME
3 rmf \- remove folder
4 .SH SYNOPSIS
5 .B rmf
6 \%[+folder] \%[
7 .B \-help
8 ]
9 .SH DESCRIPTION
10 \fIRmf\fR removes all of the files (messages) within the specified
11 (or default) folder, and then removes the directory (folder).
12 If
13 there are any files within the folder which are not a part of MH,
14 they will \fInot\fR be removed, and an error will be produced.
15 If the
16 folder is given explicitly or the current folder is a
17 subfolder (i.e., a selection list from \fIpick\fR), it will be
18 removed without confirmation.
19 If no argument is specified and
20 the current folder is not a selection-list folder, the
21 user will be asked for confirmation.
22
23 \fIRmf\fR irreversibly deletes messages that don't have other links,
24 so use it with caution.
25
26 If the folder being removed is a subfolder, the parent
27 folder will become the new current folder, and \fIrmf\fR will
28 produce a message telling the user this has happened.
29 This
30 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 (See the
34 example under \fIpick\fR.)
35
36 The files that \fIrmf\fR will delete are cur, any file beginning
37 with a comma, and files with purely numeric names.
38 All others
39 will produce error messages.
40
41 \fIRmf\fR of a read-only folder will delete the ``cur\-'' entry from the
42 profile without affecting the folder itself.
43 .SH FILES
44 .ta 2.4i
45 $HOME/\*.mh\(ruprofile The user profile
46 .SH PROFILE COMPONENTS
47 Path: To determine the user's MH directory
48 .br
49 Current-Folder: To find the default current folder
50 .SH SEE ALSO
51 rmm(1)
52 .SH DEFAULTS
53 `+folder' defaults to current, usually with confirmation
54 .SH CONTEXT
55 \fIRmf\fR will set the current folder to the parent folder if a
56 subfolder is removed; or if the current folder is removed,
57 it will make ``inbox'' current.
58 Otherwise, it doesn't change the
59 current folder or message.