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

   1 .TH RMM %manext1% "February 13, 2013" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 rmm \- remove messages
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B rmm
  11 .RI [ +folder ]
  12 .RI [ msgs ]
  13 .RB [ \-unlink " | " \-nounlink ]
  14 .RB [ \-version ]
  15 .RB [ \-help ]
  16 .ad
  17 .SH DESCRIPTION
  18 By default,
  19 .B rmm
  20 will remove the specified messages by renaming
  21 each of the message files with a site-dependent prefix (usually a
  22 comma).  Such files will then need to
  23 be removed in some manner after a certain amount of time.  Many sites
  24 arrange for
  25 .B cron
  26 to remove these files once a day, so check
  27 with your system administrator.
  28 .PP
  29 Alternately, if you wish for
  30 .B rmm
  31 to really remove the files
  32 representing these messages, you can use the
  33 .B \-unlink
  34 switch.  But
  35 messages removed by this method cannot be later recovered.
  36 .PP
  37 If you prefer a more sophisticated method of `removing' messages, you
  38 can define the
  39 .I rmmproc
  40 profile component.  For example, you can
  41 add a profile component such as
  42 .PP
  43 .RS 5
  44 rmmproc:        /home/foouser/bin/rmm_msgs
  45 .RE
  46 .PP
  47 then instead of simply renaming the message file,
  48 .B rmm
  49 will call
  50 the named program or script to handle the files that represent the
  51 messages to be deleted.
  52 .PP
  53 An example of a
  54 .I rmmproc
  55 script that saves a message based in its Message-ID is provided in
  56 %etcdir%/rmmproc.messageid.  To enable it, simply add a
  57 .I rmmproc
  58 component that names it to your profile.
  59 .PP
  60 Some users of
  61 .B csh
  62 prefer the following:
  63 .PP
  64 .RS 5
  65 alias rmm 'refile +d'
  66 .RE
  67 .PP
  68 where folder `+d' is a folder for deleted messages, and
  69 .PP
  70 .RS 5
  71 alias mexp 'rm `mhpath +d all`'
  72 .RE
  73 .PP
  74 is used to \*(lqexpunge\*(rq deleted messages.
  75 .PP
  76 The current message is not changed by
  77 .BR rmm ,
  78 so a
  79 .B next
  80 will
  81 advance to the next message in the folder as expected.
  82 .SH FILES
  83 .fc ^ ~
  84 .nf
  85 .ta \w'%etcdir%/ExtraBigFileName  'u
  86 ^$HOME/\&.mh\(ruprofile~^The user profile
  87 .fi
  88 .SH "PROFILE COMPONENTS"
  89 .fc ^ ~
  90 .nf
  91 .ta 2.4i
  92 .ta \w'ExtraBigProfileName  'u
  93 ^Path:~^To determine the user's nmh directory
  94 ^Current\-Folder:~^To find the default current folder
  95 ^rmmproc:~^Program to delete the message
  96 .fi
  97 .SH "SEE ALSO"
  98 .IR rmf (1)
  99 .SH DEFAULTS
 100 .nf
 101 .RB ` +folder "' defaults to the current folder"
 102 .RB ` msgs "' defaults to cur"
 103 .RB ` -nounlink '
 104 .fi
 105 .SH CONTEXT
 106 If a folder is given, it will become the current folder.
 107 .SH BUGS
 108 Since
 109 .B refile
 110 uses your
 111 .I rmmproc
 112 to delete the message,
 113 the
 114 .I rmmproc
 115 must
 116 .B NOT
 117 call
 118 .B refile
 119 without specifying
 120 .BR \-normmproc ,
 121 or you will create an infinte loop.