]> mj.ucw.cz Git - checkmail.git/blob - README
5dc446e2449a77df785c294956cea19c45e60a13
[checkmail.git] / 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 / vi-like movement   moves through the list
28         ENTER                           invokes mutt (or a program specified
29                                         with the -m option) on the current mailbox
30         TAB                             jumps to the next mailbox with some new
31                                         messages (mailboxes with higher priority
32                                         are preferred)
33         `                               TAB in reverse direction
34         Ctrl-R                          forces full reload of the list (otherwise,
35                                         it gets updated incrementally)
36         Ctrl-L                          redraw screen
37         0...9                           sets minimum priority of mailboxes to show
38                                         (0=show all)
39         b, B                            enable/disable beeping
40         d, D                            enable/disable on-screen display
41         /                               start incremental search mode
42         <hotkey>                        activate a specific mailbox and invoke mutt
43                                         on it (hotkeys are defined as mailbox options
44                                         and they override the default key bindings)
45
46 Examples:
47
48         cm -i                           display just the inbox
49         cm -i '~/Mail/*_list'           display inbox and all mailing lists
50         cm -i '~/Mail/*_list' -oINBOX=1t  highlight the inbox and prefer it on TAB
51
52 Caveats:
53
54   - CheckMail currently does no mailbox locking, but the incremental update mechanism
55     is able to recover from mailboxes caught in the middle of mail delivery.
56
57 Please send all bug reports and suggestions to mj@ucw.cz.
58
59                                 Have fun
60                                                         Martin