README for XCallerID-1.1
------------------------
XCallerID is a caller ID program for linux.  It consists of two
separate entities: the xcid daemon which stores incoming calls in a
database, and the XCallerID client which allows updating of the database.

When the daemon receives a call, it pops up a window with the 
call number, and uses wavplay to announce the incoming call.
It defaults to an unknown name and announcement; both can be 
changed in the client.  If wavplay is not available, the 
daemon simply pops up the number.

The client is a Gtk driven interface to the database.
Users can update call names and announcements for calls.  When 
a call has been updated, all calls with the same number are 
likewise updated, and any future calls from that number will 
keep the name and announcement.


REQUIREMENTS
------------
1. caller ID capable modem
2. mSQL 2.0 (http://www.hughes.com.au)
3. Gtk+
4. wavplay 1.0 (optional)


INSTALLATION
------------
First, edit the Makefile.  This should be self explanatory; you will
be asked for modem initialization strings, and locations of various
libraries.

Once the configuration is done, type 'make' and everything should 
compile.  There will be a number of warnings; ignore them.

Before running the daemon, you need to set up the database.
Make sure msql2d is running, then

	cd /usr/local/Hughes/bin; msqladmin create CallerID

This will create the CallerID database.  The daemon should now work.


RUNNING
-------
First, make sure msql2d is running:

	/usr/local/Hughes/bin/msql2d &

As of v1.1, it is no longer necessary to run the daemon separately.
The client automatically runs the daemon at startup, so all that is 
necessary is to run:

	/usr/local/XCallerID-1.1/XCallerID &

The daemon can be started and stopped at will from within the client,
using the Daemon pulldown menu.

To search the database, use the search menu.  You can search by
number, name, or date (dd-mmm-yyyy, i.e. 26-Jun-1998).  XCallerID
will the list all matching calls.

To update a call (and all the calls with the same number), select a 
call from the list and use the update menu.

If you choose name, you will be given a dialog box to type the new 
name in.  If you choose number, you will be given a file selection
dialog to choose a wav file from.


LICENSE
-------
This program is distributed under the GPL.  See the file COPYING
for details.


CONTACT
-------
Copyright (c) 1998 Joe Yandle <yandle@cs.unc.edu>

XCallerID homepage:	

	http://www.cs.unc.edu/~yandle/XCallerID/

	
