git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/doc/mhook.me

   1 .\"     This file is automatically generated.  Do not edit!
   2 .\" @(#)$Id: mhook.rf,v 1.16 1995/12/06 23:31:56 jromine Exp $
   3 .SC MHOOK 1
   4 .NA
   5 mhook, rcvdist, rcvpack, rcvtty  \- MH receive-mail hooks
   6 .SY
   7 .na
   8 .ti .5i
   9 /opt/mh-6.8.5/lib/rcvdist
  10 \%[\-form\ formfile]
  11 \%[switches\ for\ \fIpostproc\fR]
  12 address\ ...
  13 \%[\-help]
  14
  15 .ti .5i
  16 /opt/mh-6.8.5/lib/rcvpack
  17 file
  18 \%[\-help]
  19
  20 .ti .5i
  21 /opt/mh-6.8.5/lib/rcvtty
  22 \%[command]
  23 \%[\-form\ formatfile]
  24 \%[\-format\ string]
  25 \%[\-bell] \%[\-nobell]
  26 \%[\-newline] \%[\-nonewline]
  27 \%[\-biff]
  28 \%[\-help]
  29 .ad
  30 .DE
  31 A receive\-mail hook is a program that is run whenever you receive a
  32 mail message.
  33 You do \fBNOT\fR invoke the hook yourself,
  34 rather the hook is invoked on your behalf by your
  35 system's Message Transport Agent.  See \fIslocal\fP\0(1)
  36 for details on how to activate receive\-mail hooks on your system.
  37
  38 Four programs are currently available as part of \fIMH\fP,
  39 \fIrcvdist\fR (redistribute incoming messages to additional recipients),
  40 \fIrcvpack\fR (save incoming messages in a \fIpackf\fR'd file),
  41 and \fIrcvtty\fR (notify user of incoming messages).
  42 The fourth program,
  43 \fIrcvstore\fR\0(1) is described separately.
  44 They all reside in the \fI/opt/mh-6.8.5/lib/\fR directory.
  45
  46 The \fIrcvdist\fR program will resend a copy of the message to all of the
  47 addresses listed on its command line.
  48 It uses the format string facility described in \fImh\-format\fR\0(5).
  49 In addition, \fIrcvdist\fP
  50 also recognizes the following additional \fIcomponent\fR escape:
  51 .sp 1
  52 .ne 5
  53 .nf
  54 .ta \w'Dtimenow  'u +\w'Returns  'u
  55 \fIEscape\fR    \fIReturns\fR   \fIDescription\fR
  56 addresses       string  the addresses to distribute to
  57 .re
  58 .fi
  59
  60 The \fIrcvpack\fR program will append a copy of the message to the file listed
  61 on its command line.
  62 Its use is obsoleted by the \*(lqfile\*(rq action of \fIslocal\fR.
  63
  64 The \fIrcvtty\fR program executes the named file with the message as its
  65 standard input,
  66 and writes the resulting output
  67 on your terminal.
  68
  69 If no file is specified, or is bogus, etc.,
  70 then \fIrcvtty\fR will instead write a one\-line scan listing.
  71 Either the `\-form\ formatfile' or `\-format\ string' option may be used
  72 to override the default output format (see \fImh\-format\fP\0(5)).
  73 A newline is output before the
  74 message output, and the terminal bell is rung
  75 after the output.  The `\-nonewline' and `\-nobell' options
  76 will inhibit these functions.
  77
  78 In addition to the standard \fImh\-format\fR\0(5) escapes,
  79 \fIrcvtty\fR also recognizes the following additional \fIcomponent\fR escapes:
  80 .sp 1
  81 .ne 5
  82 .nf
  83 .ta \w'Dtimenow  'u +\w'Returns  'u
  84 \fIEscape\fR    \fIReturns\fR   \fIDescription\fR
  85 body    string  the (compressed) first part of the body
  86 dtimenow        date    the current date
  87 folder  string  the name of the current folder
  88 .re
  89 .fi
  90
  91 Normally, \fIrcvtty\fP obeys
  92 write permission as granted by \fImesg\fP\0(1).
  93 With the `\-biff' option, \fIrcvtty\fP will obey the notification
  94 status set by \fIbiff\fP\0(1) instead.
  95 If the terminal access daemon (TTYD) is available on your system,
  96 then \fIrcvtty\fR will give its output to the daemon for output
  97 instead of writing on the user's terminal.
  98 .Fi
  99 ^/opt/mh-6.8.5/lib/mtstailor~^tailor file
 100 ^$HOME/\&.maildelivery~^The file controlling local delivery
 101 ^/opt/mh-6.8.5/lib/maildelivery~^Rather than the standard file
 102 .Sa
 103 rcvstore (1), mh\-format(5), slocal(1)
 104 .Bu
 105 Only two return codes are meaningful, others should be.
 106 .En