cwbiff Version 0.3.0 (2013-02-14)
---------------------------------
http://fkurz.net/ham/cwbiff.html

cwbiff is a small Perl program which queries a mailbox and notifies the user
about new incoming mail by sending the From: and Subject: lines in morse code.
Before and after playing CW, an arbitrary command line action can be triggered,
for example to stop and start a media player like 'xmms' if it's playing.

cwbiff currently supports:
* IMAP (optionally SSL encrypted)
* mbox (plain mbox file)

IMAP functionality is provided by the Perl module Mail::IMAPClient by David J.
Kernen. As of 0.1.0 (2007-12-13) SSL is supported, thanks to some code from
Nick Burch (http://gagravarr.org/).

MIME Message headers
--------------------
As of version 0.3.0, the decoding of MIME message headers for non-ASCII
messages according to RFC 2047 has been improved significantly. They are
decoded by Perl's "Encode" module to UTF-8.

Morse Output 
------------
Morse output can be achieved by several different programs:

* ebook2cw: recommended option, with included wrapper script ebook2cwwrap;
            supports UTF-8 input in Latin, Cyrillic, Greek and Arabic
            character sets.

* morse by Jochen Kunz (http://www.unixag-kl.fh-kl.de/~jkunz/projekte/morse.c) 
* 'classic morse' (http://www.catb.org/~esr/morse/)
* 'cw' from the 'unixcw' package.

Configuration
-------------
The configuration of cwbiff is saved in ~/.cwbiff; a sample config file is
included in the distribution, which contains explanations where neccessary.


Author: Fabian Kurz, DJ1YFK <fabian@fkurz.net>
Web:    http://fkurz.net/ham/cwbiff.html

cwbiff is licensed under the GNU GPLv2.