--------------------
Introduction
--------------------

This is the README file for tkbiff, a program that announces incoming
mail.  This directory contains tkbiff's source, man page, and FAQ.

A brief description:

  tkbiff allows arbitrary commands (play audio clip, metamail, etc) to
  be executed upon mail reception.  (If you like xbiff++ but wish it
  were more flexible or more portable, then you'll like tkbiff.)
  tkbiff is flexible enough that you can make it do anything.  Default
  behavior: fast and convenient access to new email using very little
  screen real estate.

For more info, read "Using Tkbiff" below.  For a very thorough
description, see its man page, tkbiff(1).

--------------------
Compatibility
--------------------

tkbiff requires production versions (not alpha or beta!) of Tcl (7.4,
7.5, or 7.6) and Tk (4.0, 4.1, or 4.2) to use tkbiff.  It might work
with newer production versions, of course, but I have no knowledge of
them at this time.

tkbiff itself should be compatible with all mailers on all UNIX
platforms.  Of course, you can customize tkbiff in non-portable ways.
See the porting.notes file for any information for specific platforms.

--------------------
Using Tkbiff - In just a couple of sentences
--------------------

0) Install Tk if you haven't already.  If you don't know what Tk is,
read http://www.sunlabs.com:80/research/tcl/

1) Run tkbiff by typing "wish4.1 tkbiff".  (You can drop the "wish4.1"
by editing the first line of tkbiff appropriately and marking it
executable.)  tkbiff also works with wish4.0.

2a) If you don't have any unread mail, tkbiff will say that.  Send
yourself some mail and see what happens.

2b) If you have unread mail, look at it by pressing the left or middle
mouse buttons.  Press "?" in the tkbiff window for more quick info.

3) You'll eventually want to customize tkbiff to yourself.  You'll get
instructions for doing that when the program first runs.

For a thorough description, see the man page, tkbiff(1).

--------------------
Installing tkbiff
--------------------

To install tkbiff, simply copy it to an appropriate directory (e.g.,
/usr/local/bin), edit the first line to reflect where wish is on your
system, and mark the file executable).

If you want to modify any of the tkbiff defaults for all of your
users, read the section of the man page "FOR SYSTEM ADMINISTRATORS".
(You can do this before or after installation.)

--------------------
Support from Don Libes or NIST
--------------------

Although I can't promise anything in the way of support, I'd be
interested to hear about your experiences using it (good or bad).  I'm
also interested in hearing bug reports and suggestions for improvement
even though I can't promise to implement them.

If you send me a bug, fix, or question, include the version of tkbiff
(as reported by "?"), version of Tcl and Tk, and name and version of
the OS that you are using.  Before sending mail, it may be helpful to
verify that your problem still exists in the latest version.

Awards, love letters, and bug reports may be sent to:

Don Libes
National Institute of Standards and Technology
Bldg 220, Rm A-127
Gaithersburg, MD  20899
(301) 975-3535
libes@nist.gov

I hereby place this software in the public domain.  NIST and I would
appreciate credit if this program or parts of it are used.
