FISG - Fast IRC Stats Generator
===============================
Programmed and designed by Matti 'ccr' Hamalainen
(C) Copyright 2003-2004 Tecnic Software productions (TNSP)

-------------------------------------------------
!!! NOTICE TO USERS OF OLDER VERSIONS OF FISG !!!
-------------------------------------------------
Some of FISG's behavior has changed slightly after version 0.3.8!
Few commandline options have been renamed and there is NO default
input format anymore, you will always have to specify one!

So, please check your scripts, etc. to be sure that everything is
okay after upgrading. Refer to FISG's commandline help (fisg --help)
and man-page for more information about the new options.


Introduction
============
FISG is a logfile analyzer for IRC logs. It has a template-string
based parsing engine, and by default supports few different log
formats for input, including Irssi, Eggdrop and mIRC. Additional
logfile formats can be specified via external template files.

As a result of parsing, FISG calculates all kinds of statistics
which can be outputted to an XHTML page. In future, other output
modules will be added. Few nice CSS-stylesheets are included that
can be used with FISG produced stats-pages.


If you know PISG (Perl IRC Statistics Generator, http://pisg.sf.net/),
then you know what FISG is mostly about. However, FISG is not a
drop-in replacement for PISG. Please don't expect it to be or expect
that it will become one. Unlike PISG, FISG was designed from ground
up for speed and minimum resource consumption, without sacrificing
flexibility too much (thus the template-based extensible parser).

Although some PISG's features are not possible for FISG due to various
differences in design and some just won't be implemented because of
speed/resource issues (see the FAQ), I am hoping that FISG is a viable
alternative for those who cannot sacrifice efficiency.


For some additional FISG marketing propaganda, please refer to
FISG's homepage in World Wide Web: http://www.tnsp.org/fisg.php


How to use
==========
After installation (see INSTALL), basic usage is quite simple if you
are familiar with basic commandline interfaces.

First step is to use your favorite editor to create configuration and
user-files for the channel you want to have the statistics for. After
that, you need to run FISG, specifying the configuration and logfiles.

Because FISG by default supports very few logfile formats, you may
want and/or need to roll your own "parsing-template" for your format.
Built-in supported formats can be listed via commandline option "-L".
Refer to files "logformat.cfg", "PARSER" and FAQ for more information.

Some simple example scenarios of usage:

Example #1
----------
If you have log for channel #kewlchan produced by Irssi in directory
"~/irclogs/IRCNet/"  (aka under your home directory), you could use
the following command:

fisg -c kewlchan.cfg -f irssi ~/irclogs/IRCNet/\#kewlchan.log -o kewlstats.html

Simple enough. The above works as follows:

 - Parses configuration file "kewlchan.cfg" and applies given settings.
 - Parses given log-files, in this case "#kewlchan.log"
 - Compute statistics
 - Output to HTML-file "kewlstats.html"

Example #2
----------
If there are multiple logfiles, you need to specify them all. Under UNIX
you might wish to use find(1) -command, for example:

fisg -c kewlchan.cfg -f irssi `find ~/irclogs -iname "*kewlchan.*"` -o kewlstats.html

Under Windows you can only use the standard filename matching:

fisg.exe -c kewlchan.cfg -f irssi c:\irssilogs\*.log -o kewlstats.html

Example #3
----------
In some cases you may have many logfiles of different formats, but we
can handle them all. All files given after "-f" option are interpreted
as the given format. Example:

fisg -f eggdrop ~/mybot/logs/kewlchan.* -f irssi ~/irclogs/\#kewlchan.log


For more information, read FISG's commandline help (fisg --help),
the example configuration- and user-files ("example.cfg" and
"users.cfg") and the FAQ. There are some good tips in the FAQ.


License
=======
FISG is distributed under GNU General Public License version 2,
see COPYING for more information.

If you like FISG, you can thank me by distributing message about
it's existence and voting it on freshmeat.net.


Contact, support and new versions
=================================
For contacting me you can either use IRC or e-mail, see below.
Bug-reports, suggestions, patches, etc. can be submitted to
FISG's Alioth project-page (preferred) or via email/IRC. New
versions will be available from FISG's homepage and freshmeat.

IRC       : #fisg at irc.freenode.net (see http://www.freenode.net/)

E-mail    : ccr@tnsp.org

Homepage  : http://www.tnsp.org/fisg.php

Freshmeat : http://freshmeat.net/projects/fisg/

Project   : http://alioth.debian.org/projects/fisg/

