------------
Requirements
------------
* UNIX compatible system running X11
* GTK libraries
* imlib2 libraries

------------
Installation
------------
1)  % ./configure
2)  % make
3)  % make install

  Install is optional.  You might need to be root to install.

4)  % cp wmmsgrc ~/.wmmsgrc

  Installs a default preferences file in your home directory.

5)  % your_favorite_editor ~/.wmmsgrc

  Edit the preferences file to your liking.  The comments
    within should be self explanatory.

6)  % wmmsg &

  Run the program.

7)  % wmmsg_notify <protocol>

  Notify wmmsg of an incoming event. For example:
    % wmmsg_notify icq

8) Interface wmmsg with your program(s):

--------------------
Generic Installation
--------------------
The basic idea behind using wmmsg is to have your program
run 'wmmsg_notify <protocol>' whenever you want to be notified
of an event.  Most instant messaging programs have options
for running a command to play sounds on certain events.  You
can usually leverage this functionality to run any command
you like (such as wmmsg_notify).  This allows you to see when
messages arrive by way of a blinking icon of your choice in
the dockapp, even if your chat window is covered up or on
another virtual desktop ("Workspace" in WindowMaker terms).

We have provided some instructions below for interfacing
wmmsg with a few common instant messaging programs.  There
are also many other ways to use wmmsg.  For example,
you could have a log parser notify you of specific errors
that occur on your system.  You could have a calendar
application remind you of important events that are about to
occur.  You could even use it for email notification.  If
you think of some great way to use wmmsg, please email one
of the authors a description of how you set it up and we'll
include installation instructions below.


-----------------
Gaim Installation
-----------------
1) Open Gaim preferences

2) Set the sound method to "Command"

3) For the sound command, enter:  wmmsg_notify aim

4) Check the "Sound played when:" boxes to your liking. You
   can leave the sounds as default.


------------------
XChat Installation
------------------

1) Edit plugins/xchat_wmmsg.pl and copy it wherever you'd like.  For example:
    cp plugins/xchat_wmmsg.pl ~/.xchat/plugins/

2) From xchat type:
    /load ~/.xchat/plugins/xchat_wmmsg.pl

3) To automatically load the plugin each time you connect to
   a server, you can type the command from step 2 into the
   "Connect Command:" box.

