README

   1 ================================================================================
   2
   3                                  Checkmail @VERSION@
   4
   5                     (c) 2005--2014 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 ~~~~~~
  24         see `cm --help'
  25
  26 Keys:
  27 ~~~~~
  28         q / Ctrl-C      quit
  29         arrow keys      moves through the list
  30         h, j, k, l      vi-like movement keys also work
  31         ENTER           invokes mutt (or a program specified with the -m option)
  32                         on the current mailbox
  33         TAB             jumps to the next mailbox with some new messages
  34                         (mailboxes with higher priority are preferred)
  35         `               TAB in reverse direction
  36         Ctrl-R          forces full reload of the list
  37                         (otherwise, it gets updated incrementally)
  38         Ctrl-L          redraw screen
  39         0...9           sets minimum priority of mailboxes to show (0=show all)
  40         b, B            enable/disable beeping
  41         d, D            enable/disable on-screen display
  42         /               start incremental search mode
  43         <hotkey>        activate a specific mailbox and invoke mutt on it
  44                         (hotkeys are defined as mailbox options and they override
  45                          the default key bindings)
  46
  47 OSD Messages:
  48 ~~~~~~~~~~~~~
  49 When OSDD is installed (see http://mj.ucw.cz/linux.html#osdd), Checkmail can
  50 send on-screen notifications on incoming mail. This can be enabled by the "d"
  51 mailbox option. Additionally, you can customize the OSD messages using the "-s"
  52 switch: "-s<key>=<value>" sets an OSD attribute (e.g., "-scolor=red" or
  53 "-sduration=3000" [ms]), "-s=<text>" adds a line to the message. If no text
  54 lines are defined, Checkmail uses built-in default.
  55
  56 Each <text> can contain the following formatting sequences:
  57
  58         %f              sender of the highest-priority new message
  59         %s              subject of the same message
  60         %n              total number of new messages
  61         %m              the number of more new messages (i.e., %m-1)
  62                         if it is 0, the whole <text> line is skipped
  63         %<width>...     you can add an optional maximum width in characters
  64
  65 Examples:
  66 ~~~~~~~~~
  67         cm -i                           display just the inbox
  68         cm -i '~/Mail/*_list'           display inbox and all mailing lists
  69         cm -i '~/Mail/*_list' -oINBOX=1t  highlight the inbox and prefer it on TAB
  70
  71 Caveats:
  72 ~~~~~~~~
  73
  74   - Checkmail currently does no mailbox locking, but the incremental update mechanism
  75     is able to recover from mailboxes caught in the middle of mail delivery.
  76
  77 Please send all bug reports and suggestions to mj@ucw.cz.
  78
  79                                 Have fun
  80                                                         Martin