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

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