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                             jumps to the next mailbox with some new
  24                                         messages (mailboxes with higher priority
  25                                         are preferred)
  26         `                               TAB in reverse direction
  27         Ctrl-R                          forces full reload of the list (otherwise,
  28                                         it gets updated incrementally)
  29         0...9                           sets minimum priority of mailboxes to show
  30                                         (0=show all)
  31
  32 Examples:
  33
  34         cm -i                           display just the inbox
  35         cm -i '~/Mail/*_list'           display inbox and all mailing lists
  36         cm -i '~/Mail/*_list' -oINBOX=1t  highlight the inbox and prefer it on TAB
  37
  38 Caveats:
  39
  40   - CheckMail currently does no mailbox locking, but the incremental update mechanism
  41     is able to recover from mailboxes caught in the middle of mail delivery. Will be
  42     fixed soon.
  43
  44 Please send all bug reports and suggestions to mj@ucw.cz.
  45
  46                                 Have fun
  47                                                         Martin