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

   1 .TH MSGCHK %manext1% "January 27, 2012" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 msgchk \- check for messages
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B msgchk
  11 .RB [ \-date " | " \-nodate ]
  12 .RB [ \-notify
  13 all/mail/nomail ]
  14 .RB [ \-nonotify
  15 all/mail/nomail ]
  16 .RB [ \-host
  17 .IR hostname ]
  18 .RB [ \-user
  19 .IR username ]
  20 .RB [ \-sasl ]
  21 .RB [ \-saslmech
  22 .IR mechanism ]
  23 .RB [ \-snoop ]
  24 .RI [ users
  25 \&... ]
  26 .RB [ \-version ]
  27 .RB [ \-help ]
  28 .ad
  29 .SH DESCRIPTION
  30 The
  31 .B msgchk
  32 program checks all known mail drops for mail waiting
  33 for you.  For those drops which have mail for you,
  34 .B msgchk
  35 will
  36 indicate if it believes that you have seen the mail in question before.
  37 .PP
  38 The
  39 .B \-notify
  40 .I type
  41 switch indicates under what circumstances
  42 .B msgchk
  43 should produce a message.  The default is
  44 .B \-notify
  45 .I all
  46 which says that
  47 .B msgchk
  48 should always report the status of the
  49 users maildrop.  Other values for `type' include `mail' which says that
  50 .B msgchk
  51 should report the status of waiting mail; and, `nomail'
  52 which says that
  53 .B msgchk
  54 should report the status of empty maildrops.
  55 The
  56 .B \-nonotify
  57 .I type
  58 switch has the inverted sense, so
  59 .B \-nonotify
  60 .I all
  61 directs
  62 .B msgchk
  63 to never report the status of
  64 maildrops.  This is useful if the user wishes to check
  65 .BR msgchk 's
  66 exit status.  A non\-zero exit status indicates that mail was
  67 .B not
  68 waiting for at least one of the indicated users.
  69 .PP
  70 If
  71 .B msgchk
  72 produces output, then the
  73 .B \-date
  74 switch directs
  75 .B msgchk
  76 to print out the last date mail was read, if this can
  77 be determined.
  78 .SS "Using POP"
  79 .B msgchk
  80 will normally check all the local mail drops, but if
  81 the option \*(lqpophost:\*(rq is set in the mts configuration file
  82 \*(lqmts.conf\*(rq, or if the
  83 .B \-host
  84 .I hostname
  85 switch is given,
  86 .B msgchk
  87 will query this POP service host as to the status of
  88 mail waiting.
  89 .PP
  90 The default is for
  91 .B msgchk
  92 to assume that your account name
  93 on the POP server is the same as your current username.  To specify
  94 a different username, use the `\-user\ username' switch.
  95 .PP
  96 When using POP, you will normally need to type the password for
  97 your account on the POP server, in order to retrieve your messages.
  98 It is possible to automate this process by creating a
  99 .RI \*(lq \&.netrc \*(rq
 100 file containing your login account information for this POP server.
 101 For each POP server, this file should have a line of the following
 102 form.  Replace the words
 103 .IR mypopserver ,
 104 .IR mylogin ,
 105 and
 106 .I mypassword
 107 with
 108 your own account information.
 109 .PP
 110 .RS 5
 111 machine
 112 .I mypopserver
 113 login
 114 .I mylogin
 115 password
 116 .I mypassword
 117 .RE
 118 .PP
 119 This
 120 .RI \*(lq \&.netrc \*(rq
 121 file should be owned and readable only by you.
 122 .PP
 123 For debugging purposes, there is also a switch
 124 .BR \-snoop ,
 125 which will
 126 allow you to watch the POP transaction take place between you and the
 127 POP server.
 128 .PP
 129 If
 130 .B nmh
 131 has been compiled with SASL support, the
 132 .B \-sasl
 133 switch will enable
 134 the use of SASL authentication.  Depending on the SASL mechanism used, this
 135 may require an additional password prompt from the user (but the
 136 .RI \*(lq \&.netrc \*(rq
 137 file can be used to store this password).  The
 138 .B \-saslmech
 139 switch can be used to select a particular SASL mechanism.
 140 .PP
 141 If SASL authentication is successful,
 142 .B inc
 143 will attempt to negotiate
 144 a security layer for session encryption.  Encrypted traffic is labelled
 145 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 146 with the
 147 .B \-snoop
 148 switch.
 149 .SH FILES
 150 .fc ^ ~
 151 .nf
 152 .ta \w'%etcdir%/ExtraBigFileName  'u
 153 ^$HOME/\&.mh\(ruprofile~^The user profile
 154 ^%etcdir%/mts.conf~^nmh mts configuration file
 155 ^%mailspool%/$USER~^Location of mail drop
 156 .fi
 157 .SH "PROFILE COMPONENTS"
 158 .fc ^ ~
 159 .nf
 160 .ta 2.4i
 161 .ta \w'ExtraBigProfileName  'u
 162 None
 163 .fi
 164 .SH "SEE ALSO"
 165 .IR inc (1)
 166 .SH DEFAULTS
 167 .nf
 168 .RB ` user "' defaults to the current user"
 169 .RB ` \-date '
 170 .RB ` "\-notify\ all" '
 171 .fi
 172 .SH CONTEXT
 173 None