...

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..18d6c67
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+================================================================================
+
+                                Checkmail 0.1
+
+                      (c) 2005 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.
+
+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.
+
+Requirements: libncurses and a decent C99 compiler (preferably GCC).
+
+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)
+
+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
+
+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.
+
+Please send all bug reports and suggestions to mj@ucw.cz.
+
+                               Have fun
+                                                       Martin

diff --git a/cm.c b/cm.c
index 8b4e3e5ce18adc3fcb6e4079cfbac0fba7f09722..6a421e042f2f66b8e82255bf1e13ecdddf2359e4 100644 (file)
--- a/cm.c
+++ b/cm.c
@@ -557,6 +557,9 @@ Options:\n\
 -i\t\t\tInclude user's INBOX\n\
 -l\t\t\tLock mailboxes when scanning\n\
 -m <cmd>\t\tCommand to run on the selected mailbox, %%s gets replaced by mailbox path\n\
+\n\
+CheckMail 0.1, (c) 2005 Martin Mares <mj@ucw.cz>\n\
+It can be freely distributed and used according to the GNU GPL v2.\n\
 ");
   exit(1);
 }

diff --git a/log b/log
deleted file mode 100644 (file)
index ecc2b07..0000000
--- a/log
+++ /dev/null
@@ -1,10 +0,0 @@
-./cm: invalid option -- -
-Usage: cm [<options>] <mbox-patterns>
-
-Options:
--c <interval>          Scan mailboxes every <interval> seconds (default is 30)
--d                     Log debug messages to stderr
--h <mbox>              Highlight and prefer the specified mailbox
--i                     Include user's INBOX
--l                     Lock mailboxes when scanning
--m <cmd>               Command to run on the selected mailbox, %s gets replaced by mailbox path