------------
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)  % vi ~/.wmmsgrc

  Adjust ~/.wmmsgrc to your preferences.  The comments within
	should be self explanatory.

5)  % wmmsg &

  Run the program.

6)  % wmmsg_notify <protocol>

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

7) 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
------------------
(versions prior to 2.0)

1) Download the XChat plugin "sndmgr". You can do a search
   from "Scripts/Addons" on xchat.org.

2) You don't need to compile it, just edit samples/sndmgr.conf.

3) Change "command=play" to "command=wmmsg_notify".

4) For every signal you want to be notified of, add "irc"
   for the last argument.  For example:

     signal=PRIVMSG,irc

   Leave the last argument for the rest of the signals blank.
	 For example, the author has only enabled events PRIVMSG,
	 CHANMSG, and HCHANMSG. 

5) Copy sndmgr.conf to the ~/.xchat folder.

6) sndmgr.so should now work. Copy it to the location of your
   choice (usually /usr/local/lib/xchat/plugins).

7) In XChat, select "Scripts & Plugins | Load | Plugin...",
   and select your sndmgr.so.  You may also run a command
	 like:

     /loaddll /usr/local/lib/xchat/plugins/sndmgr.so

	 to load the plugin.  This command can be put in the
	 "Connect Cmd" box of a server entry, so that it will
	 automatically load upon connection to a particular server.

