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