Copyright (c) 1999 W. Michael Petullo <speak@flyn.org>
All rights reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

=============================== OVERVIEW =======================================

Speak is a text to speech script which provides a simple interface to the
Festival speech synthesis package.  The script attempts to detect when
EsounD is running and takes advantage of it.  Otherwise, speak uses the
computer's sound device directly.  Speak can be used for tasks such as
reading incoming email.

=============================== INSTALLING =====================================

To use speak to read the subject and sender of incoming email, first
install the Festival speech synthesis package.  Next install the scripts
into your PATH.  Finally, add entries such as the following to your
.procmailrc and crontab file, respectively:

# Append subject and sender to file.  A cron job can have festival read
# this file occasionally.
:0 hwc:
| egrep 'From:|Subject:' | cat >> $HOME/mail/recent_headers

# Speak $HOME/mail/recent-headers, which contains the subject and 
# sender of new messages.
05,15,25,35,45,55	*	*	*	* /usr/local/bin/speak_and_delete.sh $HOME/mail/recent_headers > /dev/null 2> /dev/null
