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