README

   1 ================================================================================
   2
   3                                  Checkmail @VERSION@
   4
   5                        (c) 2005 Martin Mares <mj@ucw.cz>
   6
   7 ================================================================================
   8
   9 Checkmail is nothing more than a smart textual menu allowing easy browsing
  10 through a set of mailboxes, displayed together with numbers of all messages
  11 and new messages.
  12
  13 It can be freely used and distributed according to the terms of the GNU General
  14 Public License version 2, as published by the Free Software Foundation.
  15
  16 Requirements: libncurses and a decent C99 compiler (preferably GCC).
  17
  18 Keys:
  19         q                               quit
  20         arrow keys / vi-like movement   moves through the list
  21         ENTER                           invokes mutt (or a program specified
  22                                         with the -m option) on the current box
  23         TAB                             jump to the next mailbox with some new
  24                                         messages (highlighted mailboxes set with
  25                                         -h are preferred)
  26         Ctrl-R                          force full reload of the list (otherwise,
  27                                         it gets updated incrementally)
  28
  29 Examples:
  30
  31         cm -i                           display just the inbox
  32         cm -i '~/Mail/*_list'           display inbox and all mailing lists
  33         cm -i '~/Mail/*_list' -hINBOX   highlight the inbox and prefer it on TAB
  34
  35 Caveats:
  36
  37   - CheckMail currently does no mailbox locking (the -l switch does nothing
  38     so far), but the incremental update mechanism is able to recover from
  39     mailboxes caught in the middle of mail delivery. Will be fixed in the
  40     next version.
  41
  42 Please send all bug reports and suggestions to mj@ucw.cz.
  43
  44                                 Have fun
  45                                                         Martin