PISG/README

README, pisg - by me and others (see CREDITS file)
------------------
pisg - Perl IRC Statistics Generator, is a Perl script which takes IRC
logfiles and turns them into nice looking stats, which can be amusing to
show for the users of your channel.

The supported logfile formats is explained in the FORMATS file included with
this distribution in the 'docs' directory.

SETTING UP PISG
---------------
It's quite simple to set up pisg. You have 2 choices:

 * Set settings from commandline (try pisg.pl --help)
 * Configure pisg from the pisg.cfg file (more flexible and configurable)

If you look in the example pisg.cfg, you will see a small working sample
where you can insert your own data.

The most important things to set is the name of the logfile, the channel
name, the format of your logfile and the maintainers name.

The commandline version has the disadvantage that you can only set up one
channel to be run.

NOTE: The stats will look best with a logfile which is at least one day
long.  Some stats (like smilies, exclamation marks, etc) doesn't get counted
before a special amount of time.

Also, pisg supports multiple languages so the texts on the stats page will
be in your own language; look in lang.txt to see the supported languages.
The language can be changed from within the pisg.cfg file.

If you have any corrections to the language file, or you want to add a new
translation, then send it to the mailing list.

And a last note: there is some graphics in the gfx/ folder which pisg uses,
you should put these in the same directory as your stats file(s) or use the
'pic_loc' configuration variable.

RUNNING PISG
------------
If you have setup everything inside the config file, then you just need to
run it. If you're on a Linux/BSD/Unix system, this should do the work:

    $ ./pisg.pl

Running pisg like this will just use the settings in pisg.cfg.

If you want to specify things on commandline instead of in the config file,
you could do:

    $ ./pisg.pl -ch \#channel -l logfile.log -f mIRC -o index.html
   
The syntax and options is explained when doing:

    $ ./pisg.pl --help

Setting settings on commandline, will override the relevant settings in
pisg.cfg.

CONTACT INFORMATION
-------------------
If you have any problems with setting up or running pisg, you should send an
e-mail to the pisg mailing list:

http://lists.sourceforge.net/mailman/listinfo/pisg-general

You can report bugs or add feature requests here:
http://sourceforge.net/tracker/?group_id=31862

The pisg homepage is located at http://pisg.sourceforge.net/.

If you use pisg, and have a permanent URL for the location of your generated
stats, I'd be delighted if you'd add your page on the pisg homepage. Just go
to the 'examples' page and follow the instructions.

Have fun :)

 - Morten Brix Pedersen <morten@wtf.dk>