README
1README, pisg - by me and others (see CREDITS file)
2------------------
3pisg - Perl IRC Statistics Generator, is a Perl script which takes IRC
4logfiles and turns them into nice looking stats, which can be amusing to
5show for the users of your channel.
6
7The supported logfile formats is explained in the FORMATS file included with
8this distribution in the 'docs' directory.
9
10SETTING UP PISG
11---------------
12Full documentation for pisg is located in 'docs/pisg-doc.txt' and
13'docs/html/index.html' for a HTML version.
14
15Quick usage instructions below:
16
17It's quite simple to set up pisg. You have 2 choices:
18
19 * Set settings from commandline (try pisg --help)
20 * Configure pisg from the pisg.cfg file (more flexible and configurable)
21
22If you look in the example pisg.cfg, you will see a small working sample
23where you can insert your own data.
24
25The commandline version has the disadvantage that you can only set up one
26channel to be run.
27
28RUNNING PISG
29------------
30If you have setup everything inside the config file, then you just need to
31run it. If you're on a Linux/BSD/Unix system, this should do the work:
32
33 $ ./pisg
34
35Running pisg like this will just use the settings in pisg.cfg.
36
37If you want to specify things on commandline instead of in the config file,
38you could do:
39
40 $ ./pisg -ch \#channel -l logfile.log -f mIRC -o index.html
41
42The syntax and options is explained when doing:
43
44 $ ./pisg --help
45
46Setting settings on commandline, will override the relevant settings in
47pisg.cfg.
48
49NOTES
50-----
51There is some graphics in the gfx/ folder which pisg uses, you should put
52these in the same directory as your stats file(s) or use the 'PicLocation'
53configuration option.
54
55The stats will look best with a logfile which is at least one day long.
56Some stats (like smilies, exclamation marks, etc) doesn't get counted before
57a special amount of time.
58
59pisg supports multiple languages so the texts on the stats page will
60be in your own language; look in lang.txt to see the supported languages.
61The language can be changed from within the pisg.cfg file.
62
63If you have any corrections to the language file, or you want to add a new
64translation, then send it to the mailing list.
65
66CONTACT INFORMATION
67-------------------
68If you have any issues with pisg, such as problems with installing or
69running pisg, then send an e-mail to the pisg mailing list:
70
71http://lists.sourceforge.net/mailman/listinfo/pisg-general
72
73You can report bugs or add feature requests here:
74http://sourceforge.net/tracker/?group_id=31862
75
76The pisg homepage is located at http://pisg.sourceforge.net/.
77
78Have fun :)
79
80 - Morten Brix Pedersen
81