PISG/CONFIG-README

README for pisg.cfg - the configuration file for pisg
------------------
This file is used for two things:
 - Setting user options (for user aliases, pics, ignores and links)
 - Setting up channel(s) to be parsed.
 - Setting pisg config options (for general things with pisg)
 - Word options (for adding words that are meant to be 'foul(bad) language')
 

USER OPTIONS
------------------
User options are set with a simple SGML like syntax; remember the nick is
always required.

For example to add aliases to a nick, then you could do this:
    <user nick="Joe" alias="Joe^*">

This will add all Joe^'s to 'Joe' in the stats.

Another thing you can do is to add a picture to a user:
    <user nick="Ben" pic="ben_holiday.jpg">

You can also set a user's sex:
    <user nick="Ben" sex="m">

Also you can add links to URLs and e-mails:
    <user nick="Christine" link="http://www.christine.com">

    or

    <user nick="Chris" link="chris@host.com">

The last thing you can do is to ignore nicks (for example bots):
    <user nick="nameofbot" ignore="y">

You don't have to do all this in many lines, you could just as easily do:
<user nick="Joe" alias="Joe^away Joe^work" pic="joe.jpg" link="joe@joe.com" sex="m">

(Here the aliases is a space seperated list of nicks, that also works! But *
as a wildcard is smarter, but also slower).

CHANNELS SETUP
------------------

For each of your channels which you want to parse through, you make
something like this:

<channel="#channel" logfile="channel.log">
 format = "mIRC"
 maintainer = "NameOfMaintainer"
</channel>

Any options in the <channel *> section will be forced, even over commandline
options... any options before </channel> can be overridden from command line

There is a lot of variables which you can set between the <channel> and
</channel> tags, these are listed in the next section.

PISG OPTIONS
------------------
If you have multiple channels, then you can set some defaults for them, for
example you can do.

<set format="mIRC">

And you won't have to worry about setting the format for every channel.

You can also combine settings into one line such as:
<set channel="#channel" logfile="/var/log/channel.log">

All the differents variables are listed below.

Other examples:
<set lang='EN' langfile='lang.txt'>
<set bgcolor="#dedeee" text="black" hbgcolor="#666699" hcolor="white" hicell="#BABADD" hicell2="#CCCCCC">
<set activenicks="25" activenicks2="30" topichistory="3" nicktracking="0" timeoffset="+0">


There is many variables which can be set, here's a list of them all (not
casesensitive):

 * The most useful ones *

channel              The name of your channel.
logfile              The exact filename of the logfile
format               logfile format. see FORMATS file
network              Network the channels is using.
outputfile           The name of the html file to be generated
maintainer           The maintainer or bot which makes the logfile
pagehead             Some 'page header' file which you want to include in top
                     of the stats

imagepath            If your user pictures is located some special directory,
                     set the path here.

logdir               If you specify a path to a dir here, then pisg will
                     take that dir, and parse ALL logfiles in it, and create
                     1 HTML file from it

lang                 Language to use (see lang.txt)
                     EN | DE | DK | FR | ES | PL | NO | NL | SE

langfile             Filename of language file

timeoffset           A time offset on the stats page - if your country has
                     a different timezone than the machine where the stats
                     are being generated, then for example do +1

show_wpl             1 or 0, this enables pisg to show 'words per line' for
                     each person in 'most active nicks'

show_cpl             Same as above, this is just 'chars per line'

show_words           1 or 0, this will enable/disable both of the 2 above
                     options.

show_time            1 or 0, this will enable/disable the showing of the
                     fancy timebars indicating when a nick was active.

show_linetime        1 or 0, the same as above, except this will show the
                     bar next to the number of lines like in mIRCStats

show_legend          1 or 0, this will add a legend of the different time-
                     bars.

show_kickline        1 or 0, this will add an example-kickline to the
                     "Most kicked"-stats

show_actionline      1 or 0, this will add an example-actionline to the
                     "Most actions"-stats

show_shoutline       1 or 0, this will add an example-shoutline to the
                     "Most shouting people"-stats

show_violentlines    1 or 0, this will add an example-attack to the
                     "Most aggressive" and "Most attacked"-stats

ignorewords          A space seperated list of words to ignore in 'most
                     referenced words'

foul                 Space seperated list of words considered to be 'foul'
                     language, look in the bottom for a better explanation.

regexp_alises        1 or 0, enabling this will make aliases in <user> tags
                     regex-able.

 * Colors / layout for your stats page *

bgcolor              Background color of the page
bgpic                Background picture of the page
text                 Normal text color
hbgcolor             Background color in headlines
hcolor               Text color in headline
hicell               Background color in highlighted cells
hicell2              Background color in highlighted cells
tdcolor              Color of text in tables
tdtop                Top color in some tables.
link                 Color of links
vlink                Color of visited links
hlink                Color of hovered links
headline             Border color of headlines
rankc                Colors of 'ranks' (1,2,3,4)

pic_v_0              Below settings are the filenames of the images to be
pic_v_6              shown on thepage on timebars, the names should be 
pic_v_12             self-explainable.
pic_v_18
pic_h_0
pic_h_6
pic_h_12
pic_h_18

  * Small things, useful for some people *

minquote             Minimal value of letters for a random quote
maxquote             Maximum value of letters for a random quote
wordlength           The minimum number of chars an interesting word may be
                     (in 'most referenced words')
activenicks          Number of nicks to show in the 'top 25'
activenicks2         Nicks to show in 'these didnt make it...'
topichistory         How many topics to show in 'latest topics'
nicktracking         Track nickchanges and create aliases [1 or 0, enabled
                     by default]



WORD OPTIONS
------------------
pisg has the feature of making stats of people using "foul words" or bad
language, like fuck, shit, etc. but this is something people would like to
configure to their own language and slang.

So this option configures which words which are considered to be "foul":

<set foul="ass bitch fuck">

Or in German:
<set foul="scheisse scheiße kacke">

pisg also recognizes that people may attack others in a variety of ways.
The words that pisg considers to be attacks may be set with the "violent"
option:

<set violent="slaps beats kicks">

Have fun configuring pisg! :)