X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=README;h=4b4f6223ec6eac427948afcdc775a595a39de09e;hb=3278801ebd7ff511bb1f20b12b71b8e749377688;hp=18d6c678d119cb9d0ce51816e8d8a1bd6e5a2063;hpb=a60c7135c07d5978890ee94dee2fc0bde26c8df9;p=checkmail.git

diff --git a/README b/README
index 18d6c67..4b4f622 100644
--- a/README
+++ b/README
@@ -1,43 +1,78 @@
 ================================================================================
 
-				 Checkmail 0.1
+				 Checkmail @VERSION@
 
-		       (c) 2005 Martin Mares <mj@ucw.cz>
+		    (c) 2005--2014 Martin Mares <mj@ucw.cz>
 
 ================================================================================
 
 Checkmail is nothing more than a smart textual menu allowing easy browsing
 through a set of mailboxes, displayed together with numbers of all messages
-and new messages.
+and new messages. It is also able to notify the user that a new mail has
+arrived by means of beeps, keyboard LEDs and on-screen display.
 
-It can be freely used and distributed according to the terms of the GNU General
-Public License version 2, as published by the Free Software Foundation.
+Checkmail can be freely used and distributed according to the terms of the GNU
+General Public License version 2, as published by the Free Software Foundation.
 
-Requirements: libncurses and a decent C99 compiler (preferably GCC).
+Build requirements: libncurses, locales and iconv, and a decent C99 compiler
+(preferably GCC). For full UTF-8 support, libncursesw is necessary. Options
+for controlling XKB leds need libX11, on-screen display needs libX11 and OSDD.
+See Makefile for several build-time switches.
+
+Usage:
+~~~~~~
+	see `cm --help'
 
 Keys:
-	q				quit
-	arrow keys / vi-like movement	moves through the list
-	ENTER				invokes mutt (or a program specified
-					with the -m option) on the current box
-	TAB				jump to the next mailbox with some new
-					messages (highlighted mailboxes set with
-					-h are preferred)
-	Ctrl-R				force full reload of the list (otherwise,
-					it gets updated incrementally)
+~~~~~
+	q / Ctrl-C	quit
+	arrow keys	moves through the list
+	h, j, k, l	vi-like movement keys also work
+	ENTER		invokes mutt (or a program specified with the -m option)
+			on the current mailbox
+	TAB		jumps to the next mailbox with some new messages
+			(mailboxes with higher priority are preferred)
+	`		TAB in reverse direction
+	Ctrl-R		forces full reload of the list
+			(otherwise, it gets updated incrementally)
+	Ctrl-L		redraw screen
+	0...9		sets minimum priority of mailboxes to show (0=show all)
+	b, B		enable/disable beeping
+	d, D		enable/disable on-screen display
+	/		start incremental search mode
+	<hotkey>	activate a specific mailbox and invoke mutt on it
+			(hotkeys are defined as mailbox options and they override
+			 the default key bindings)
 
-Examples:
+OSD Messages:
+~~~~~~~~~~~~~
+When OSDD is installed (see http://mj.ucw.cz/linux.html#osdd), Checkmail can
+send on-screen notifications on incoming mail. This can be enabled by the "d"
+mailbox option. Additionally, you can customize the OSD messages using the "-s"
+switch: "-s<key>=<value>" sets an OSD attribute (e.g., "-scolor=red" or
+"-sduration=3000" [ms]), "-s=<text>" adds a line to the message. If no text
+lines are defined, Checkmail uses built-in default.
+
+Each <text> can contain the following formatting sequences:
 
+	%f		sender of the highest-priority new message
+	%s		subject of the same message
+	%n		total number of new messages
+	%m		the number of more new messages (i.e., %m-1)
+			if it is 0, the whole <text> line is skipped
+	%<width>...	you can add an optional maximum width in characters
+
+Examples:
+~~~~~~~~~
 	cm -i				display just the inbox
 	cm -i '~/Mail/*_list'		display inbox and all mailing lists
-	cm -i '~/Mail/*_list' -hINBOX	highlight the inbox and prefer it on TAB
+	cm -i '~/Mail/*_list' -oINBOX=1t  highlight the inbox and prefer it on TAB
 
 Caveats:
+~~~~~~~~
 
-  - CheckMail currently does no mailbox locking (the -l switch does nothing
-    so far), but the incremental update mechanism is able to recover from
-    mailboxes caught in the middle of mail delivery. Will be fixed in the
-    next version.
+  - Checkmail currently does no mailbox locking, but the incremental update mechanism
+    is able to recover from mailboxes caught in the middle of mail delivery.
 
 Please send all bug reports and suggestions to mj@ucw.cz.