git.marmaro.de Git - mmh/blob - man/msgchk.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH MSGCHK %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 msgchk \- check for messages
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 msgchk
  15 \%[\-date] \%[\-nodate]
  16 \%[\-notify\ all/mail/nomail]
  17 .br
  18 \%[\-nonotify\ all/mail/nomail]
  19 .br
  20 %nmhbeginpop%
  21 \%[\-host\ hostname]
  22 \%[\-user\ username]
  23 \%[\-kpop]
  24 .br
  25 %nmhendpop%
  26 \%[users\ ...]
  27 \%[\-version]
  28 \%[\-help]
  29 .in -.5i
  30 .SH DESCRIPTION
  31 The \fImsgchk\fR program checks all known mail drops for mail waiting
  32 for you.  For those drops which have mail for you, \fImsgchk\fR will
  33 indicate if it believes that you have seen the mail in question before.
  34
  35 The `\-notify\ type' switch indicates under what circumstances
  36 \fImsgchk\fR should produce a message.  The default is `\-notify\ all'
  37 which says that \fImsgchk\fR should always report the status of the
  38 users maildrop.  Other values for `type' include `mail' which says that
  39 \fImsgchk\fR should report the status of waiting mail; and, `nomail'
  40 which says that \fImsgchk\fR should report the status of empty maildrops.
  41 The `\-nonotify\ type' switch has the inverted sense, so
  42 `\-nonotify\ all' directs \fImsgchk\fR to never report the status of
  43 maildrops.  This is useful if the user wishes to check \fImsgchk\fR's
  44 exit status.  A non\-zero exit status indicates that mail was \fBnot\fR
  45 waiting for at least one of the indicated users.
  46
  47 If \fImsgchk\fR produces output, then the `\-date' switch directs
  48 \fImsgchk\fR to print out the last date mail was read, if this can
  49 be determined.
  50 %nmhbeginpop%
  51
  52 .Uh "Using POP"
  53 \fImsgchk\fR will normally check all the local mail drops, but if
  54 the option \*(lqpophost:\*(rq is set in the mts configuration file
  55 \*(lqmts.conf\*(rq, or if the `\-host\ hostname' switch is given,
  56 \fImsgchk\fR will query this POP service host as to the status of
  57 mail waiting.
  58
  59 The default is for \fImsgchk\fR to assume that your account name
  60 on the POP server is the same as your current username.  To specify
  61 a different username, use the `\-user\ username' switch.
  62
  63 When using POP, you will normally need to type the password for
  64 your account on the POP server, in order to retrieve your messages.
  65 It is possible to automate this process by creating a \*(lq.netrc\*(rq
  66 file containing your login account information for this POP server.
  67 For each POP server, this file should have a line of the following
  68 form.  Replace the words mypopserver, mylogin, and mypassword with
  69 your own account information.
  70
  71 machine mypopserver login mylogin password mypassword
  72
  73 This \*(lq.netrc\*(rq file should be owned and readable only by
  74 you.
  75
  76 For debugging purposes, there is also a switch `\-snoop', which will
  77 allow you to watch the POP transaction take place between you and the
  78 POP server.
  79
  80 If nmh has been compiled with KPOP #defined, the `\-kpop' switch will allow
  81 \fImsgchk\fR to use Kerberized POP rather than standard POP3 on a given
  82 invocation.  If POPSERVICE was also #defined to "kpop", \fImsgchk\fR will be
  83 hardwired to always use KPOP.
  84 %nmhendpop%
  85 .Fi
  86 ^$HOME/\&.mh\(ruprofile~^The user profile
  87 ^%etcdir%/mts.conf~^nmh mts configuration file
  88 ^%mailspool%/$USER~^Location of mail drop
  89 .Pr
  90 None
  91 .Sa
  92 inc(1)
  93 .De
  94 `user' defaults to the current user
  95 .Ds
  96 `\-date'
  97 .Ds
  98 `\-notify\ all'
  99 .Co
 100 None
 101 .En