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

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