diplodocus.org Git - nmh/blob - man/rmf.man

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