diplodocus.org Git - nmh/blob - man/msgchk.man

   1 .TH MSGCHK %manext1% "April 14, 2013" "%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 To specify a username for authentication with the POP server, use the
  91 .B \-user
  92 .I username
  93 switch.  The credentials profile entry in the mh_profile(5) man page
  94 describes the ways to supply a username and password.
  95 .PP
  96 For debugging purposes, there is also a switch
  97 .BR \-snoop ,
  98 which will
  99 allow you to watch the POP transaction take place between you and the
 100 POP server.
 101 .PP
 102 If
 103 .B nmh
 104 has been compiled with SASL support, the
 105 .B \-sasl
 106 switch will enable
 107 the use of SASL authentication.  Depending on the SASL mechanism used, this
 108 may require an additional password prompt from the user (but the
 109 .I netrc
 110 file can be used to store this password, as described in the
 111 mh-profile(5) man page).  The
 112 .B \-saslmech
 113 switch can be used to select a particular SASL mechanism.
 114 .PP
 115 If SASL authentication is successful,
 116 .B inc
 117 will attempt to negotiate
 118 a security layer for session encryption.  Encrypted traffic is labelled
 119 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 120 with the
 121 .B \-snoop
 122 switch.
 123 .SH FILES
 124 .fc ^ ~
 125 .nf
 126 .ta \w'%etcdir%/ExtraBigFileName  'u
 127 ^$HOME/\&.mh\(ruprofile~^The user profile
 128 ^%etcdir%/mts.conf~^nmh mts configuration file
 129 ^%mailspool%/$USER~^Location of mail drop
 130 .fi
 131 .SH "PROFILE COMPONENTS"
 132 .fc ^ ~
 133 .nf
 134 .ta 2.4i
 135 .ta \w'ExtraBigProfileName  'u
 136 None
 137 .fi
 138 .SH "SEE ALSO"
 139 .IR inc (1),
 140 .IR mh\-mail (5)
 141 .SH DEFAULTS
 142 .nf
 143 .RB ` user "' defaults to the current user"
 144 .RB ` \-date '
 145 .RB ` "\-notify\ all" '
 146 .fi
 147 .SH CONTEXT
 148 None