git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/conf/doc/msgchk.rf

   1 .\"     @(MHWARNING)
   2 .\" @(#)$Id: msgchk.rf,v 1.7 1992/02/04 21:41:41 jromine Exp $
   3 .SC MSGCHK 1
   4 .NA
   5 msgchk \- check for messages
   6 .SY
   7 msgchk
   8 \%[\-date] \%[\-nodate]
   9 \%[\-notify\ all/mail/nomail] \%[\-nonotify\ all/mail/nomail]
  10 @BEGIN: POP
  11 \%[\-host\ host] \%[\-user\ user]
  12 \%[\-apop] \%[\-noapop]
  13 \%[\-rpop] \%[\-norpop]
  14 @END: POP
  15 \%[users\ ...]
  16 \%[\-help]
  17 .DE
  18 The \fImsgchk\fR program checks all known mail drops for mail waiting
  19 for you.
  20 For those drops which have mail for you,
  21 \fImsgchk\fR will indicate if it believes that you have seen the mail
  22 in question before.
  23
  24 The `\-notify\ type' switch indicates under what circumstances \fImsgchk\fR
  25 should produce a message.
  26 The default is `\-notify\ all' which says that \fImsgchk\fR should always
  27 report the status of the users maildrop.
  28 Other values for `type' include `mail' which says that \fImsgchk\fR should
  29 report the status of waiting mail;
  30 and, `nomail' which says that \fImsgchk\fR should report the status of empty
  31 maildrops.
  32 The `\-nonotify\ type' switch has the inverted sense,
  33 so `\-nonotify\ all' directs \fImsgchk\fR to never report the status of
  34 maildrops.
  35 This is useful if the user wishes to check \fImsgchk\fR's exit status.
  36 A non\-zero exit status indicates that mail was \fBnot\fR waiting for at
  37 least one of the indicated users.
  38
  39 If \fImsgchk\fR produces output,
  40 then the `\-date' switch directs \fImsgchk\fR to print out the last date mail
  41 was read,
  42 if this can be determined.
  43 @BEGIN: POP
  44
  45 If the local host is configured as a POP client,
  46 or if the `\-host\ host' switch is given,
  47 \fImsgchk\fR will query the POP service host as to the status of mail waiting.
  48 If the `\-user\ user' switch is not given,
  49 then the current username is used.
  50 Normally,
  51 \fImsgchk\fR will prompt for a password to use.
  52 However,
  53 if the `\-apop' switch is given,
  54 \fImsgchk\fR will generate authentication credentials to provide
  55 for origin authentication and replay protection,
  56 but which do not involve sending a password in the clear over the network.
  57 Otherwise,
  58 if the `\-rpop' switch is given,
  59 then \fImsgchk\fR will try to use a \*(lqtrusted\*(rq connection
  60 (ala the BSD r-commands).
  61 @END: POP
  62 .Fi
  63 ^$HOME/\&.mh\(ruprofile~^The user profile
  64 ^@(MHETCPATH)/mtstailor~^tailor file
  65 ^@(MHDROPLOC)~^Location of mail drop
  66 .Pr
  67 None
  68 .Sa
  69 @BEGIN: POP
  70 \fIPost Office Protocol - version 3\fR (aka RFC\-1081),
  71 .br
  72 @END: POP
  73 inc(1)
  74 .De
  75 `user' defaults to the current user
  76 .Ds
  77 `\-date'
  78 .Ds
  79 `\-notify\ all'
  80 @BEGIN: POP
  81 .Ds
  82 `\-rpop'
  83 @END: POP
  84 .Co
  85 None
  86 .En