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

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH MSGCHK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 msgchk \- check system mail drop 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 .RI [ users
  17 \&... ]
  18 .RB [ \-Version ]
  19 .RB [ \-help ]
  20 .ad
  21 .SH DESCRIPTION
  22 The
  23 .B msgchk
  24 program checks your system mail drop for mail waiting
  25 for you, or the given users.
  26 If the requested users have mail,
  27 .B msgchk
  28 will
  29 indicate if it believes that they have seen the mail in question before.
  30 .PP
  31 The
  32 .B \-notify
  33 .I type
  34 switch indicates under what circumstances
  35 .B msgchk
  36 should produce a message.  The default is
  37 .B \-notify
  38 .I all
  39 which says that
  40 .B msgchk
  41 should always report the status of the
  42 users maildrop.  Other values for `type' include `mail' which says that
  43 .B msgchk
  44 should report the status of waiting mail; and, `nomail'
  45 which says that
  46 .B msgchk
  47 should report the status of empty maildrops.
  48 The
  49 .B \-nonotify
  50 .I type
  51 switch has the inverted sense, so
  52 .B \-nonotify
  53 .I all
  54 directs
  55 .B msgchk
  56 to never report the status of
  57 maildrops.  This is useful if the user wishes to check
  58 .BR msgchk 's
  59 exit status.  A non\-zero exit status indicates that mail was
  60 .B not
  61 waiting for at least one of the indicated users.
  62 .PP
  63 If
  64 .B msgchk
  65 produces output, then the
  66 .B \-date
  67 switch directs
  68 .B msgchk
  69 to print out the last date mail was read, if this can
  70 be determined.
  71 .PP
  72 If
  73 .I users
  74 are given, then
  75 .B msgchk
  76 will only check the default system mail drops.
  77 Otherwise,
  78 .B msgchk
  79 will evaluate the environment variable
  80 .I MAILDROP
  81 and profile component
  82 .I MailDrop
  83 (in this order) first and, if they are set and non-empty,
  84 checks that mail drop instead of the system default mail drop.
  85
  86 .SH FILES
  87 .fc ^ ~
  88 .nf
  89 .ta \w'%etcdir%/ExtraBigFileName  'u
  90 ^$HOME/.mmh/profile~^The user profile
  91 ^%mailspool%/$USER~^Location of mail drop
  92 .fi
  93
  94 .SH "PROFILE COMPONENTS"
  95 .fc ^ ~
  96 .nf
  97 .ta 2.4i
  98 .ta \w'ExtraBigName  'u
  99 ^MailDrop~^Supersedes the default mail drop location
 100 .fi
 101
 102 .SH ENVIRONMENT
 103 .fc ^ ~
 104 .nf
 105 .ta \w'ExtraBigName  'u
 106 ^MAILDROP~^Highest priority alternative mail drop location
 107 .fi
 108
 109
 110 .SH "SEE ALSO"
 111 inc(1)
 112
 113 .SH DEFAULTS
 114 .nf
 115 .RB ` user "' defaults to the current user"
 116 .RB ` \-date '
 117 .RB ` "\-notify\ all" '
 118 .fi
 119
 120 .SH CONTEXT
 121 None