ircGraph 0.6.7 - 08/12/2002 - Ricardo Sartori <sartori@lrv.ufsc.br>

Requirements:
 - Perl >= 5.0 (http://www.perl.org)
 - RRDTool >= 1.0.32 (http://ee-staff.ethz.ch/~oetiker/webtools/rrdtool/)

Quick steps to start using ircgraph:
1 - Unpack the program:
	tar xvfz ircgraph-0.6.x.tar.gz
2 - Change to the program dir:
	cd ircgraph-0.6.x/
3 - Now you must edit the ircgraph.conf to fit your needs:
	vi ircgraph.conf
    The ircservers directive must have at least one irc server defined. This directive
    accepts a list of servers separated by commas. The 1st server of this list
    is the one that will provide the network information. IMHO, this server should
    be the same of the connectto directive, avoiding possible lag and netsplit.
    ********* OBS *********
    ircgraph.pl *IS* case sensitive. If you server is named irc.MyName.com, ircgraph
    will create an RRD Database named irc.MyName.com.rrd and will use only this database.
    If you define ircservers = irc.myname.com, ircgraph will not work very well! Use
    ircservers = irc.MyName.com. Define the name of your servers in a case sensitive way. 
    For now, thats how it works!
    ********* END OF OBS *********
    You must also set the responses directive. Read the README.responses to know more.
4 - Run the ircgraph program:
    /path/to/ircgraph.pl [-d] [-l] [-c configfile] [-i IP ADDRESS] [-h]
    The options are:
    -d = debug information to stdout
    -l = log information to the logfile specified in the configuration
    -c = this is the config file the program shoul read. If this flag isn't used, the
	 program will search for this files:
		/usr/local/etc/ircgraph.conf
		./ircgraph.conf
    -i = program will bind to ip address specified in the argument. You must
    	 use the 4 dotted decimal notation. (ex: 201.202.203.204)
    -h = show program help
	
5 - Each 5 minutes you may create the images using makegraph.pl:
    /path/to/makegraph.pl [-c configfile] [-h] [-d]
	The option -c follows the same logic above.
	-h = show program help
	-d = debug information to stdout

6 - To make things easyer, use this line in your cron file:
*/5 * * * * /path/to/makegraph.pl -c /path/to/ircgraph.conf >> /dev/null
*/10 * * * * /path/to/igcheck.pl /path/to/ircgraph.conf

The igcheck.pl is a perl script that will read the pidfile,
checking if the the program is running or not. To make it work,
edit it's line 27, according to your paths:
my($command)="/some/path/to/ircgraph.pl -c /some/path/to/ircgraph.conf &";
If the igcheck finds out that the pid file is not a stable one and the program
is not running, it'll run the command above.

OBS: Some ircds will refuse to send information about the servers requested
by the LUSERS * server. In this case, ircgraph will be able to fetch only
local data.

------------------------------------------
Ricardo Sartori
sartori@lrv.ufsc.br
