Squirrelmail Logging Plugin (squirrel_logger)
------------------------------------------------------------------------------
coded by Ron Chinn, <ron@amalgasys.com>  ICQ#: 4479244
version 1.1

This is a short bit of code that will log user logins and logouts to a 
user specified file.  It's useful if you want to know who's using your
Squirrelmail installation, for how long, etc.  I wrote it when the 
subject came up on the SquirrelMail users mailing list.

The output is in the format:

event,user,IP,date

Where event is either "LOGIN" or "LOGOUT.  The delimiter is changeable.
You can turn on/off hostname lookups.  You can specify what date format to 
use, also.

I welcome any comments (positive or negative) you might have.  If you want
an additional feature, let me know.  I'll try to accomodate it as best I 
can.  My email address is ron@amalgasys.com.

This plugin has been reported to work with SquirrelMail 1.0.6, 1.1.2 and 
1.2.0[rc1].  If you get it to work with a different version, I'd like to 
know about it.


Instructions 
-----------------------------------------------------------------------------
1. Change to the plugins/ directory of your SquirrelMail installation.

2. Unpack the Squirrel_Logger archive

   tar xvzf <path_to_archive>/squirrel_logger.tgz

   (the command for your system may vary)

3. Edit the setup.php file in the squirrel_logger directory.  There
   are instructions at the top of the file to help you.

4. Activate the plugin in SquirrelMail by using SquirrelMail's configuration
   script.  For more detailed instructions, see SquirrelMail's web page:

   http://www.squirrelmail.org/wiki/index.php?page=InstallingPlugins


Tips
-----------------------------------------------------------------------------

If the log file doesn't get updated and/or doesn't get created, check your
web server error log file (probably error_log if you're using apache).
It's likely that your web server doesn't have permission to write to the
log file.

If you want a human readable log format, consider using tab ("\t") as your 
field delimiter.  It'll space things out nicely and make it a lot easier
to read. 


ChangeLog
-----------------------------------------------------------------------------

1.1	Oct 12, 2001
        Added hostname lookup feature (set $sl_namelookups)
	Changed default time format to show date before time.

1.0     Oct 11, 2001
        Initial Release
