head	1.2;
access;
symbols;
locks; strict;
comment	@# @;


1.2
date	95.04.07.03.47.07;	author dglo;	state Exp;
branches;
next	1.1;

1.1
date	95.04.07.03.41.40;	author dglo;	state Exp;
branches;
next	;


desc
@Distributed README
@


1.2
log
@Lose references to GIF cruft
@
text
@This is an enhanced version of the X11 R4 xbiff. The two major
enhancements are the support for playing sounds on the Sun
SPARCstation, and the ability to display a different "mailFull"
bitmap depending on who the mail is from or to.  A minor
enhancement is how it checks for new mail.  The old version just
checked to see if the size had changed. This version actually
scans the mail file and determines which messages have not been
read (by looking for "Status:" lines in the headers.)

Sound support is provided in two flavors. First you can specify a
list of bindings of sounds to patterns. The patterns are matched
against lines in the message headers and if a match is made, the
corresponding sound is played (given that the message is new).
Second, a default sound can be given which is played for each
message that doesn't match a sound binding pattern. In the
simplest case, the default sound can be used to replace the beep
sound played by the old version of xbiff. 

Bitmap bindings work the same way; bitmap bindings always work, but
sounds only work on SparcStations.

The bitmap files must be in "xbm" format.

You can also configure it to light a particular keyboard LED if and
only if you have mail (assuming your machine has some LEDs on it.)

The format of sound and face bindings is given in the man page.
Simply put, it is a string made up of comma separated substrings.
Each substring specifies a binding. A binding is a pattern and
sound pair, separated by a vertical bar ('|'). Here's an example
resource specification illustrating the binding format.

! xbiff++
!
xbiff++.Geometry:		48x48+1032+6
xbiff++*showTitle:	off
xbiff++*shapeWindow:	on
xbiff++*fullPixmap:	/home/kong/wagner/X/bitmaps/mailbox_full.xbm
xbiff++*fullPixmapMask:	/home/kong/wagner/X/bitmaps/mailbox_full_msk.xbm
xbiff++*emptyPixmap:	/home/kong/wagner/X/bitmaps/mailbox_empty.xbm
xbiff++*emptyPixmapMask: /home/kong/wagner/X/bitmaps/mailbox_empty_msk.xbm
xbiff++*sound:		/home/kong/wagner/sound/new/OhmyGod.au

xbiff++*caseSensitive:	false

xbiff++*soundBindings:\
From:.*wagner|/home/kong/wagner/sound/Musical/Flourish6.au,\
From:.*jcc|/home/kong/wagner/sound/Beeps/jazz_piano_beep.au,\
From:.*root|/home/kong/wagner/sound/Misc/EvilLaugh.au,\
From:.*Mailer-Daemon|/home/kong/wagner/sound/Misc/Moron.au,\
Subject:.*Homebrew.*|/home/kong/wagner/sound/SFX/Slurp.au

xbiff++*faceBindings:\
From:.*root|faces/root.xbm,\
From:.*uucp|faces/uucp.xbm,\
From:.*daemon|faces/mailer-daemon.xbm,\
From:.*jamie.*zawinski|faces/jwz.xbm

Note that the "xbiff++*soundBindings" and "xbiff++*faceBindings"
resources use escaped newlines for readability.  Also, xbiff++ uses
Henry Spencer's regular expression package for the patterns. See
the included man page for a description of the regular expression
syntax supported.

The order of the fields in the sound and bitmap bindings matters, 
while the order of the fields in the incoming mail message does not.
Therefore, if, when a message matches (for example) a "Subject"
template as well as a "From" template, the one which you wish to
be displayed/played should appear earlier in your bindings list.

XBiff++ is smart enough to not play sounds if it is not running on
display 0 of the console of a sparcstation (since X has no sound
support, if you ran XBiff++ with $DISPLAY pointing at some other 
machine, it would play the sounds on the console speaker instead 
of the speaker associated with $DISPLAY were it not clever in this
way.)

The Imakefile should compile right out of the box as long as
you're not running SunOS 4.0.3 on a SPARCstation. If you are, you
need to uncomment the "#define SUNOS4_0_3" line in the Imakefile.
Also included are a few sounds which make good mail-beeps.

The name of the executable has been changed from the R4 xbiff and
also the previous public release of audio-xbiff. This requires changes
to existing resource descriptions.

--
Mike Wagner			Jamie Zawinski
wagner@@cadillac.siemens.com	jwz@@lucid.com
Jan. 17, 1991			July 3, 1991
@


1.1
log
@Initial revision
@
text
@d22 1
a22 4
The bitmap files must be in "xbm" format.  There is code to read GIF
format color images, but it doesn't work yet, and X's interface to
color is such an incredible pain in the ass that if this code is ever
made to work, you can rest assured that it wasn't done by me.  
@
