README

   1 ================================================================================
   2
   3                                  Checkmail @VERSION@
   4
   5                     (c) 2005--2014 Martin Mares <mj@ucw.cz>
   6                     (c) 2020--2021 Jiri Kalvoda <jirikalvoda@kam.mff.cuni.cz>
   7
   8 ================================================================================
   9
  10 Checkmail is nothing more than a smart textual menu allowing easy browsing
  11 through a set of mailboxes (or maildirs), displayed together with numbers of
  12 all messages and new messages. It is also able to notify the user that a new
  13 mail has arrived by means of beeps, keyboard LEDs and on-screen display.
  14
  15 Checkmail can be freely used and distributed according to the terms of the GNU
  16 General Public License version 2, as published by the Free Software Foundation.
  17
  18 Build requirements: libncurses, locales and iconv, and a decent C99 compiler
  19 (preferably GCC). For full UTF-8 support, libncursesw is necessary. Options
  20 for controlling XKB leds need libX11, on-screen display needs libX11 and OSDD.
  21 See Makefile for several build-time switches.
  22
  23 Usage:
  24 ~~~~~~
  25         see `cm --help'
  26
  27 Keys:
  28 ~~~~~
  29         q / Ctrl-C      quit
  30         arrow keys      moves through the list
  31         h, j, k, l      vi-like movement keys also work
  32         ENTER           invokes mutt (or a program specified with the -m option)
  33                         on the current mailbox
  34         TAB             jumps to the next mailbox with some new messages
  35                         (mailboxes with higher priority are preferred)
  36         `               TAB in reverse direction
  37         Ctrl-R          forces full reload of the list
  38                         (otherwise, it gets updated incrementally)
  39         Ctrl-L          redraw screen
  40         0...9           sets minimum priority of mailboxes to show (0=show all)
  41         b, B            enable/disable beeping
  42         d, D            enable/disable on-screen display
  43         /               start incremental search mode
  44         <hotkey>        activate a specific mailbox and invoke mutt on it
  45                         (hotkeys are defined as mailbox options and they override
  46                          the default key bindings)
  47
  48 OSD Messages:
  49 ~~~~~~~~~~~~~
  50 When OSDD is installed (see http://mj.ucw.cz/linux.html#osdd), Checkmail can
  51 send on-screen notifications on incoming mail. This can be enabled by the "d"
  52 mailbox option. Additionally, you can customize the OSD messages using the "-s"
  53 switch: "-s<key>=<value>" sets an OSD attribute (e.g., "-scolor=red" or
  54 "-sduration=3000" [ms]), "-s=<text>" adds a line to the message. If no text
  55 lines are defined, Checkmail uses built-in default.
  56
  57 Each <text> can contain the following formatting sequences:
  58
  59         %f              sender of the highest-priority new message
  60         %s              subject of the same message
  61         %n              total number of new messages
  62         %m              the number of more new messages (i.e., %n-1)
  63                         if it is 0, the whole <text> line is skipped
  64         %<width>...     you can add an optional maximum width in characters
  65
  66 Examples:
  67 ~~~~~~~~~
  68         cm -i                           display just the inbox
  69         cm -i '~/Mail/*_list'           display inbox and all mailing lists
  70         cm -i '~/Mail/*_list' -oINBOX=1t  highlight the inbox and prefer it on TAB
  71
  72 Caveats:
  73 ~~~~~~~~
  74
  75   - Checkmail currently does no mailbox locking, but the incremental update mechanism
  76     is able to recover from mailboxes caught in the middle of mail delivery.
  77
  78 Please send all bug reports and suggestions to mj@ucw.cz.
  79
  80                                 Have fun
  81                                                         Martin