README: Documented OSD formatting

diff --git a/README b/README
index e684aebdfa952d116bf37bdd0f261ea28ae892e0..b7a22226412a12deda4bd5d10103815e90f60df1 100644 (file)
--- a/README
+++ b/README
@@ -20,9 +20,11 @@ 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 / Ctrl-C      quit
        arrow keys      moves through the list
        h, j, k, l      vi-like movement keys also work
@@ -42,15 +44,34 @@ Keys:
                        (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' -oINBOX=1t  highlight the inbox and prefer it on TAB
 
 Caveats:
+~~~~~~~~
 
-  - CheckMail currently does no mailbox locking, but the incremental update mechanism
+  - 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.