File: rmf.man

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