README

   1 ================================================================================
   2
   3                                  Checkmail @VERSION@
   4
   5                     (c) 2005--2008 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 Build requirements: libncurses, locales and iconv and a decent C99 compiler
  17 (preferably GCC). For full UTF-8 support libncursesw is necessary, options
  18 for controlling XKB leds need libX11. See Makefile for several build-time
  19 switches.
  20
  21 Usage:
  22         see `cm --help'
  23
  24 Keys:
  25         q / Ctrl-C                      quit
  26         arrow keys / vi-like movement   moves through the list
  27         ENTER                           invokes mutt (or a program specified
  28                                         with the -m option) on the current mailbox
  29         TAB                             jumps to the next mailbox with some new
  30                                         messages (mailboxes with higher priority
  31                                         are preferred)
  32         `                               TAB in reverse direction
  33         Ctrl-R                          forces full reload of the list (otherwise,
  34                                         it gets updated incrementally)
  35         Ctrl-L                          redraw screen
  36         0...9                           sets minimum priority of mailboxes to show
  37                                         (0=show all)
  38         b, B                            enable/disable beeping
  39         <hotkey>                        activate a specific mailbox and invoke mutt
  40                                         on it (hotkeys are defined as mailbox options
  41                                         and they override the default key bindings)
  42
  43 Examples:
  44
  45         cm -i                           display just the inbox
  46         cm -i '~/Mail/*_list'           display inbox and all mailing lists
  47         cm -i '~/Mail/*_list' -oINBOX=1t  highlight the inbox and prefer it on TAB
  48
  49 Caveats:
  50
  51   - CheckMail currently does no mailbox locking, but the incremental update mechanism
  52     is able to recover from mailboxes caught in the middle of mail delivery.
  53
  54 Please send all bug reports and suggestions to mj@ucw.cz.
  55
  56                                 Have fun
  57                                                         Martin