README

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