git.marmaro.de Git - mmh/blob - man/rmf.man

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