pisg documentation

How to install and configure pisg

-------------------------------------------------------------------------------

Table of Contents
1. What is pisg?
   
    1.1. What are the requirements to run pisg?
   
2. Setting up pisg for the first time
   
    2.1. Setting up a channel
    2.2. Specifying user options
    2.3. Setting global options
    2.4. Ignoring links
    2.5. Including common settings for various channels
    2.6. Changing the layout of your stats page
    2.7. Running pisg
    2.8. Obtaining help and reporting bugs
   
3. General pisg options
   
    Channel -- define channel name
    Format -- the logfile format
    Network -- the IRC network of the channel
    OutputFile -- name of the generated HTML page
    Logfile -- name of logfile to parse
    LogDir -- parse a directory full of logs
    Maintainer -- name of the maintainer
    ColorScheme -- use a different colorscheme for stats page
    Lang -- define the language / translation to use
    PageHead -- define a file as page header
    PageFoot -- define a file as page footer
    LogPrefix -- only parse logs LogPrefixed with a userdefined string
    LogSuffix -- Regex to sort logfiles by format month||day||year
    Silent -- make pisg silent, suppress messages
   
4. Options for various statistics features
   
    ShowActiveTimes -- enable/disable "Most Active Times"
    ShowBigNumbers -- enable/disable "Big Numbers" sections
    ShowTopics -- enable/disable "Latest topics" sections
    ShowWpl -- enable/disable "words per line"
    ShowCpl -- enable/disable "characters per line"
    ShowWords -- enable/disable "number of words"
    ShowLastSeen -- show when a user was last seen on a channel
    ShowTime -- show when a nick was active
    ShowLineTime -- mIRCStats like behaviour of timebar
    ShowWordTime -- ShowLineTime like behavior of words column
    ShowRandQuote -- enable or disable the random quotes
    ShowLegend -- enable or disable the legend of the timebars
    ShowKickLine -- enable or disable the kickline
    ShowActionLine -- enable or disable the actionline
    ShowShoutLine -- enable or disable the shoutline
    ShowFoulLine -- enable or disable the foulline
    ShowViolentLines -- enable or disable the violentlines
    ShowMuw -- enable or disable "Most used words"
    ShowMrn -- enable or disable "Most referenced nicks"
    ShowMru -- enable or disable "Most referenced URLs"
    ShowVoices -- enable or disable voice statistics
    ShowHalfops -- enable or disable halfop statistics
    ShowMostNicks -- show who changed nick most often
    ShowMostActiveByHour -- show most active nicks by hour
    ShowMostActiveByHourGraph -- show graphs in most active nicks by hour
    IgnoreWords -- ignore specified words
    FoulWords -- specify words considered to be bad/FoulWords language
    ViolentWords -- specify words considered to be aggressive/violent
    MinQuote -- minimum numbers of letters for a random quote
    MaxQuote -- maximum numbers of letters for a random quote
    WordLength -- minimum number of characters in an interesting word
    ActiveNicks -- nicks to show in "Most Active Nicks"
    ActiveNicks2 -- nicks to show in "These didn't make it.."
    ActiveNicksByHour -- number of nicks to show in "Most Active Nicks By Hour"
    MostNicksHistory -- maximum number of nicks to show in "most nicks"
    TopicHistory -- maximum number of topics to show
    UrlHistory -- maximum number of urls to show
    WordHistory -- maximum number of words to show
    NickHistory -- maximum number of nicks to show
    NickTracking -- track nickchanges and create aliases
    SortByWords -- Sort "most active nicks" by words
   
5. Picture options
   
    PicLocation -- path to images on stats page
    ImagePath -- path to user pictures
    DefaultPic -- use a default user picture
    PicWidth -- define a standard width for user pictures
    PicHeight -- define a standard height for user pictures
   
6. Misc options
   
    Charset -- Charset to use for stats page
    TimeOffset -- use a different time zone than the local machine
    RegexpAliases -- use regular expressions in user aliases
    LangFile -- filename of language file
    CssDir -- path to directory with css files
    LogType -- type of log (not the format of the log)
   
-------------------------------------------------------------------------------

Chapter 1. What is pisg?

pisg is an IRC statistics generator. It takes IRC logfiles and turns them into
nice looking stats.

In general, you would do something like this to get it running:

  * Enable logging in an IRC bot, or in your IRC client. The log will be
    outputted into a file.
   
  * You set up pisg, you define the channel name, and the path to the logfile
    you created.
   
  * You run pisg, pisg runs the log through and create statistics, it then
    creates an HTML page which you can upload to a server.
   
-------------------------------------------------------------------------------

1.1. What are the requirements to run pisg?

 

  * An IRC client or bot where pisg supports the output logfile.
   
  * Any operating system which Perl runs on, this includes popular OS'es such
    as Linux, FreeBSD, Windows and Mac. You will have a hard time finding an OS
    where Perl isn't supported. For Windows this means that you need to
    download Active State Perl (ASPN Perl).
   
  * Optional - a system to host the statistics page 24 hours a day, 7 days a
    week.
   
  * Optional - a system to log the channel, 24 hours a day, 7 days a week.
   
-------------------------------------------------------------------------------

Chapter 2. Setting up pisg for the first time

Most configuration happens through the pisg.cfg file, the file format is made
to be easy to read, and easy to extend for further use. It uses an XML-like
format, with elements and attributes.

-------------------------------------------------------------------------------

2.1. Setting up a channel

An element called channel is made for defining channels, a quick example of a
channel is this:
   
    <channel="#channel">
     Logfile = "channel.log"
     Format = "mIRC"
     Maintainer = "John"
     OutputFile = "mychan.html"
    </channel>
   
   
The above will define a channel called #channel, the logfile pisg will look for
is called channel.log and the format of the logfile will be mIRC. The
maintainer (which will be stated on the output page) is John.

That is basically it! Now, there are a lot more options that you can use for
your channels, for this please refer to the reference documentation.

Also be-aware of the fact that pisg uses various images to show the
time-related bars. These images are placed in the gfx/ folder and should be
putted into the same directory as your outputted HTML file.

-------------------------------------------------------------------------------

2.2. Specifying user options

User options are set with a simple XML-like syntax in the form:
   <user nick="NICK" option="VALUE">
   
Remember, the nick is always required. For example to add aliases to a nick,
then you could do this:
    <user nick="Joe" alias="Joe^*">
    
The asterix (*) means that it will match all nicks starting with 'Joe^'. So it
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">
    
If you have a larger picture of the user as well, you can make the picture on
the stats page link to it:
     <user nick="Ben" pic="ben_holiday.jpg" bigpic="ben-big.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 are a space separated list of nicks, that also works! But *
as a wildcard is smarter, although it is slower).

-------------------------------------------------------------------------------

2.3. Setting global options

Many times, it will be useful to set up global options, global options are set
like this:
     <set option="VALUE">
     
Any global option will override anything defined within channel elements (see 
Section 2.1)

For example, to change the background color of the stats page, you could do:
     <set bgcolor="black">
     
You can set many options in a single set:
     <set lang="DE" timeoffset="+1">
     
The above will set the language on the statistics page to DE (Deutch, German)
and set the timeoffset to +1. All options available are mentioned in the
reference documentation.

-------------------------------------------------------------------------------

2.4. Ignoring links

It's possible to ignore links in the "Most referenced URLs" section:
    
     <link url="http://www.slashdot.org" ignore="y">
    
    

-------------------------------------------------------------------------------

2.5. Including common settings for various channels

If you have, for example, more than one channel, where the users are the same,
or you don't want to maintain more than one user file, you can use the
"include" setting in the main config file:
    
     <include="/home/vetinari/pisg/users.cfg">
    
    
This will include the file /home/vetinari/pisg/users.cfg in the config at the
place where the include statement is set.

Note, that you can NOT include a file from an included file!

-------------------------------------------------------------------------------

2.6. Changing the layout of your stats page

The standard layout and colors in the outputted HTML page are made to be
somewhat clean and neutral. But you have the chance to change the layout
yourself.

There are a few predefined colorschemes for you to use, use the ColorScheme
option when using them. The available colorschemes are: 'default',
'darkgalaxy', 'ocean', 'darkred'.

When changing it, you need a fair knowledge of CSS (Cascading Style Sheets).
CSS is what most of the web uses today to define styles and layout on HTML
pages.

With the pisg distribution, look in the layout directory. In it resides
default.css which is the file being included onto the HTML page. Open it in a
text editor like vi or notepad. Then change it until you're happy with it. Be
aware that you might want to look at the hicell and hicell2 options through
pisg.cfg for changing the last two colors.

If you have created a nice stylesheet which other can take advantage of, you
are encouraged to send it to the pisg mailing list so that it can be
distributed with the next version of pisg.

-------------------------------------------------------------------------------

2.7. Running pisg

When everything is set up in the pisg configuration file (pisg.cfg), then you
simply run pisg on the command-line.

Using Linux, BSD or another UNIX-like system:
    user@host:pisg-0.37$ ./pisg
    

Using Windows:
    c:\perl\bin> perl c:\pisg\pisg
    

The program will run and parse the logfiles you specified in the configuration
file.

If you are using Linux and want run pisg automatically several times a day,
then see the crontab file in the scripts/ directory.

For Windows, see the windows-upload-ftp.txt file with the pisg distribution,
this file is also placed in the scripts/ directory.

-------------------------------------------------------------------------------

2.8. Obtaining help and reporting bugs

If your problem could not be resolved through here, then you should send an
e-mail to the pisg mailing list. You can subscribe and see more info at http://
lists.sourceforge.net/lists/listinfo/pisg-general.

If you believe that you have found a bug, you should use the Sourceforge bug
tracking system.

-------------------------------------------------------------------------------

Chapter 3. General pisg options

Channel

-----------------------
Channel option
-----------------------

Channel -- define channel name

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         Maintainer = "John"
        </channel>
      
     

Description
-----------

Channel is used in two contexts, globally when using <set> and when defining
new channels. It sets the name of the channel.

Default

Unset

Format

-----------------------
Format option
-----------------------

Format -- the logfile format

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "eggdrop"
         Maintainer = "John"
        </channel>

        <set Format="mIRC">
      
    

Description
-----------

Format is used to define the format of the logfile, pisg supports a various
number of different logfiles, see the FORMATS file included with the pisg
distribution.

Default

mIRC

Network

-----------------------
Network option
-----------------------

Network -- the IRC network of the channel

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "eggdrop"
         Network = "Undernet"
        </channel>

        <set Network="Quakenet">
      
    

Description
-----------

Network is used to set the network which the channel resides on, this name is
displayed on the stats page.

Default

SomeIRCNetwork

OutputFile

-----------------------
OutputFile option
-----------------------

OutputFile -- name of the generated HTML page

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "eggdrop"
         OutputFile = "mychan.html"
        </channel>

        <set OutputFile="mychan.html">
      
    

Description
-----------

OutputFile is used to define the name of the generated statistics page.

Default

index.html

Logfile

-----------------------
Logfile option
-----------------------

Logfile -- name of logfile to parse

Synopsis
--------

      
        <channel="#channel">
         Logfile="/home/foo/eggdrop/logs/mylog.txt"
         Format = "eggdrop"
        </channel>

        <set Logfile="foo.log">
      
    

Description
-----------

This defines the filename of the logfile to parse for the channel. If you want
to parse a directory full of logfiles, you should use the LogDir option
instead.

Default

unset

LogDir

-----------------------
LogDir option
-----------------------

LogDir -- parse a directory full of logs

Synopsis
--------

      
        <channel="#channel">
         LogDir="/home/foo/eggdrop/logs/"
         Format = "eggdrop"
        </channel>

        <set LogDir="dailylogs/">
      
    

Description
-----------

When LogDir is defined to valid path to a directory, then pisg will run through
that directory, parse all logfiles in it and create 1 HTML from it. Useful with
for example eggdrop logs.

Default

unset

Maintainer

-----------------------
Maintainer option
-----------------------

Maintainer -- name of the maintainer

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         Maintainer = "Benny"
        </channel>

        <set Maintainer="Benny">
      
    

Description
-----------

Maintainer is used to define the name of the maintaner of the statistics page,
this can be either the person generating the stats or the bot/client doing the
logging. The maintainer is displayed in the outputted stats page.

Default

MAINTAINER

ColorScheme

-----------------------
ColorScheme option
-----------------------

ColorScheme -- use a different colorscheme for stats page

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         ColorScheme = "darkgalaxy"
         Maintainer = "John"
        </channel>

        <set ColorScheme="default">
      
    

Description
-----------

ColorScheme is used to define the colorscheme used for the statistics page.
Actually it's the CSS file being included. Available options are: default,
darkgalaxy.

Default

default

Lang

-----------------------
Lang option
-----------------------

Lang -- define the language / translation to use

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         Lang = "DE"
        </channel>

        <set Lang="FR">
      
    

Description
-----------

Lang is used to define the language translation to use, if the language support
is there, the text on the stats page will be outputted in that language. All
supported languages is mentioned in the lang.txt file with the pisg
distribution. Some of the languages supported is: EN | DE | DK | FR | ES | PL |
PT | NO | NL | SE | EE | IT | HU | SI | FI

Default

EN (English)

PageHead

-----------------------
PageHead option
-----------------------

PageHead -- define a file as page header

Synopsis
--------

      
        <channel="#channel">
         Logfile = "chaNnel.log"
         Format = "mIRC"
         OutputFile = "stats.html"
         PageHead = "myheader.txt"
        </channel>

        <set PageHead="someheader.txt">
      
    

Description
-----------

PageHead is used to include a file in the stats page, for example an
introduction text, a link to an image or a banner. The file can hold anything,
it will be included raw in the stats page - so HTML should be preferred. The
file will be included in the top of the page. This option is the opposite of 
PageFoot.

Default

none

PageFoot

-----------------------
PageFoot option
-----------------------

PageFoot -- define a file as page footer

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         outputfile = "stats.html"
         PageFoot = "myfooter.txt"
        </channel>

        <set PageFoot="somefooter.txt">
      
    

Description
-----------

PageFoot is used to include a file in the stats page, for example an
introduction text, a link to an image or a banner. The file can hold anything,
it will be included raw in the stats page - so HTML should be preferred. The
file will be included in the bottom of the page. This option is the opposite of
PageHead.

Default

none

LogPrefix

-----------------------
LogPrefix option
-----------------------

LogPrefix -- only parse logs LogPrefixed with a userdefined string

Synopsis
--------

      
        <channel="#channel">
         LogDir="/home/foo/eggdrop/logs/"
         Format = "eggdrop"
         LogPrefix = "logjun"
        </channel>

        <set LogPrefix="logjanuary">
      
    

Description
-----------

When using the LogDir option and you only want to use a slew of the files in
it, you can have pisg choose only files which are prefixed with a special
string.

Default

unset

LogSuffix

-----------------------
LogSuffix option
-----------------------

LogSuffix -- Regex to sort logfiles by format month||day||year

Synopsis
--------

      
        <set LogSuffix="\.\d\d([A-Za-z]+)\d\d\d\d||\.(\d\d)[A-Za-z]+\d\d\d\d||\.\d\d[A-Za-z]+(\d\d\d\d)">
      
     

Description
-----------

LogSuffix is used to define the suffix of a logfile, it only works when LogDir
is defined. The example in the synopsis is for the eggdrop bots default foramt.

Default

Unset

Silent

-----------------------
Silent option
-----------------------

Silent -- make pisg silent, suppress messages

Synopsis
--------

      
        <set Silent="1">
      
    

Description
-----------

This option is useful mainly from commandline when invoking pisg with --silent
1. But it can also used in the configuration file. It will suppress all
standard output from pisg. Error messages will still be sent.

Default

0 (disabled)

-------------------------------------------------------------------------------

Chapter 4. Options for various statistics features

ShowActiveTimes

-----------------------
ShowActiveTimes option
-----------------------

ShowActiveTimes -- enable/disable "Most Active Times"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowActiveTimes = "0"
        </channel>

        <set ShowActiveTimes="1">
      
    

Description
-----------

With this option you can disable the "Most Active Times" section on the stats
page. It will simply disappear when specifying 0.

Default

1 (enabled)

ShowBigNumbers

-----------------------
ShowBigNumbers option
-----------------------

ShowBigNumbers -- enable/disable "Big Numbers" sections

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowBigNumbers = "0"
        </channel>

        <set ShowBigNumbers="1">
      
    

Description
-----------

With this option you can disable the "Big Numbers" and "Other Interesting
numbers" sections on the stats page. They will simply disappear when specifying
0.

Default

1 (enabled)

ShowTopics

-----------------------
ShowTopics option
-----------------------

ShowTopics -- enable/disable "Latest topics" sections

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowTopics = "0"
        </channel>

        <set ShowTopics="1">
      
    

Description
-----------

With this option you can disable the "Latest topics" section on the stats page.
It will simply disappear when specifying 0.

Default

1 (enabled)

ShowWpl

-----------------------
ShowWpl option
-----------------------

ShowWpl -- enable/disable "words per line"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowWpl = "0"
        </channel>

        <set ShowWpl="1">
      
    

Description
-----------

With this option you can enable the "words per line" coloumn in the "Most
Active Nicks" section. It will add a column describing the average words per
line for a person.

Default

0 (disabled)

ShowCpl

-----------------------
ShowCpl option
-----------------------

ShowCpl -- enable/disable "characters per line"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowCpl = "0"
        </channel>

        <set ShowCpl="1">
      
    

Description
-----------

With this option you can enable the "characters per line" coloumn in the "Most
Active Nicks" section. It will add a column describing the average number of
characters per line for a person.

Default

0 (disabled)

ShowWords

-----------------------
ShowWords option
-----------------------

ShowWords -- enable/disable "number of words"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowWords = "0"
        </channel>

        <set ShowWords="1">
      
    

Description
-----------

The ShowWords option adds a column to the "Most Active Nicks" list which list
the total number of words a user has typed.

Default

0 (disabled)

ShowLastSeen

-----------------------
ShowLastSeen option
-----------------------

ShowLastSeen -- show when a user was last seen on a channel

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowLastSeen = "0"
        </channel>

        <set ShowLastSeen="1">
      
    

Description
-----------

With this option enabled, a column will be added to the "Most Active Nicks"
section to display when a user was last seen. Eg. "2 days ago".

Default

0 (disabled)

ShowTime

-----------------------
ShowTime option
-----------------------

ShowTime -- show when a nick was active

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowTime = "0"
        </channel>

        <set ShowTime="1">
      
    

Description
-----------

The default behaviour is to add a column to the "Most Active Nicks" section
displaying a fancy timebar to show when a user was active. With this option it
can be disabled.

Default

1 (enabled)

ShowLineTime

-----------------------
ShowLineTime option
-----------------------

ShowLineTime -- mIRCStats like behaviour of timebar

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowLineTime = "0"
        </channel>

        <set ShowLineTime="1">
      
    

Description
-----------

The default behaviour is to add a column to the "Most Active Nicks" section
displaying a fancy linetimebar to show when a user was active. With this option
it can be done the same way as mIRCStats does it; that is, by putting that
timebar next to the number of lines, in the same column.

Default

0 (disabled)

ShowWordTime

-----------------------
ShowWordTime option
-----------------------

ShowWordTime -- ShowLineTime like behavior of words column

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowWordTime = "0"
        </channel>

        <set ShowWordTime="1">
      
    

Description
-----------

The default behaviour is to add a column to the "Most Active Nicks" section
displaying a fancy linetimebar to show when a user was active. With this option
it can be done similarly to mIRCStats does it and like the ShowLineTime option,
but using words instead of lines; that is, by putting that timebar next to the
number of words, in the same column.

Default

0 (disabled)

ShowRandQuote

-----------------------
ShowRandQuote option
-----------------------

ShowRandQuote -- enable or disable the random quotes

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowRandQuote = "0"
        </channel>

        <set ShowRandQuote="1">
      
    

Description
-----------

The default behaviour is to add a column to the "Most Active Nicks" section
displaying a users random quote. With this option it can be disabled.

Default

1 (enabled)

ShowLegend

-----------------------
ShowLegend option
-----------------------

ShowLegend -- enable or disable the legend of the timebars

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowLegend = "0"
        </channel>

        <set ShowLegend="1">
      
    

Description
-----------

By default, pisg shows a legend below the "Most Active Times" displaying what
the different colors means. With this option it can be disabled.

Default

1 (enabled)

ShowKickLine

-----------------------
ShowKickLine option
-----------------------

ShowKickLine -- enable or disable the kickline

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowKickLine = "0"
        </channel>

        <set ShowKickLine="1">
      
    

Description
-----------

By default, pisg shows an example kickline in the "Most kicked"-stats. With
this option it can be disabled.

Default

1 (enabled)

ShowActionLine

-----------------------
ShowActionLine option
-----------------------

ShowActionLine -- enable or disable the actionline

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowActionLine = "0"
        </channel>

        <set ShowActionLine="1">
      
    

Description
-----------

By default, pisg shows an example actionline in the "Most actions"-stats. With
this option it can be disabled.

Default

1 (enabled)

ShowShoutLine

-----------------------
ShowShoutLine option
-----------------------

ShowShoutLine -- enable or disable the shoutline

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowShoutLine = "0"
        </channel>

        <set ShowShoutLine="1">
      
    

Description
-----------

By default, pisg shows an example shoutline in the "Most shouting
people"-stats. With this option it can be disabled.

Default

1 (enabled)

ShowFoulLine

-----------------------
ShowFoulLine option
-----------------------

ShowFoulLine -- enable or disable the foulline

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowFoulLine = "0"
        </channel>

        <set ShowFoulLine="1">
      
    

Description
-----------

By default, pisg doesn't show an example foulline in the "Most fouls"-stats.
With this option it can be enabled.

Default

0 (disabled)

ShowViolentLines

-----------------------
ShowViolentLines option
-----------------------

ShowViolentLines -- enable or disable the violentlines

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "bobot"
         ShowViolentLines = "0"
        </channel>

        <set ShowViolentLines="1">
      
    

Description
-----------

By default, pisg shows example violentlines in the "Most aggresive" and "Most
attacked"-stats. With this option it can be disabled.

Default

1 (enabled)

ShowMuw

-----------------------
ShowMuw option
-----------------------

ShowMuw -- enable or disable "Most used words"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowMuw = "0"
        </channel>

        <set ShowMuw="1">
      
    

Description
-----------

By default, pisg adds an "Most used words" section to the stats page. With this
option you can disable it from being shown.

Default

1 (enabled)

ShowMrn

-----------------------
ShowMrn option
-----------------------

ShowMrn -- enable or disable "Most referenced nicks"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowMrn = "0"
        </channel>

        <set ShowMrn="1">
      
    

Description
-----------

By default, pisg adds an "Most referenced nicks" section to the stats page.
With this option you can disable it from being shown.

Default

1 (enabled)

ShowMru

-----------------------
ShowMru option
-----------------------

ShowMru -- enable or disable "Most referenced URLs"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowMru = "0"
        </channel>

        <set ShowMru="1">
      
    

Description
-----------

By default, pisg adds an "Most referenced URLs" section to the stats page. With
this option you can disable it from being shown.

Default

1 (enabled)

ShowVoices

-----------------------
ShowVoices option
-----------------------

ShowVoices -- enable or disable voice statistics

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowVoices = "0"
        </channel>

        <set ShowVoices="1">
      
    

Description
-----------

By default, pisg doesn't have voice statistics like it has op statistics.
Enabling this option will add a section to the "Most interesting numbers"
displaying who got most voices.

Default

0 (disabled)

ShowHalfops

-----------------------
ShowHalfops option
-----------------------

ShowHalfops -- enable or disable halfop statistics

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowHalfops = "0"
        </channel>

        <set ShowHalfops="1">
      
    

Description
-----------

By default, pisg doesn't have halfop statistics (+h on some servers) like it
has op statistics. Enabling this option will add a section to the "Most
interesting numbers" displaying who gave most half-ops.

Default

0 (disabled)

ShowMostNicks

-----------------------
ShowMostNicks option
-----------------------

ShowMostNicks -- show who changed nick most often

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowMostNicks = "0"
        </channel>

        <set ShowMostNicks="1">
      
    

Description
-----------

By enabling this option, pisg will add a section to the stats showing who had
the most nicks, and what the nicks were. This option only works properly when 
NickTracking is enabled.

Default

0 (disabled)

ShowMostActiveByHour

-----------------------
ShowMostActiveByHour option
-----------------------

ShowMostActiveByHour -- show most active nicks by hour

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowMostActiveByHour = "0"
        </channel>

        <set ShowMostActiveByHour="1">
      
    

Description
-----------

By enabling this option, pisg will add a section to the stats showing "Most
Active Nicks By Hour" - also look at the ShowMostActiveByHourGraph and 
ActiveNicksByHour settings.

Default

0 (disabled)

ShowMostActiveByHourGraph

-----------------------
ShowMostActiveByHourGraph option
-----------------------

ShowMostActiveByHourGraph -- show graphs in most active nicks by hour

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         ShowMostActiveByHourGraph = "0"
        </channel>

        <set ShowMostActiveByHour="1">
        <set ShowMostActiveByHourGraph="1">
      
    

Description
-----------

By enabling this option and the ShowMostActiveByHour option, pisg will show
graphs in the "Most Active Nicks By Hour" section.

Default

0 (disabled)

IgnoreWords

-----------------------
IgnoreWords option
-----------------------

IgnoreWords -- ignore specified words

Synopsis
--------

      
        <set IgnoreWords="you me">
      
    

Description
-----------

Sometimes words in the "most used words" appears which you don't want to see,
with this option you can ignore these words. It also applies to the "most
referenced nicks" section. It's a space seperated list of words. Can not be
used in a channel-only context.

Default

unset

FoulWords

-----------------------
FoulWords option
-----------------------

FoulWords -- specify words considered to be bad/FoulWords language

Synopsis
--------

      
        <set FoulWords="ass fuck bitch">
      
    

Description
-----------

There is a section in the "Most interesting numbers" which tells who had a
"dirty mouth" - here you can define which words are considered being bad/foul.
It is a space seperated list of words. Can not be used in a channel-only
context.

Default

ass fuck bitch shit scheisse scheiße kacke arsch ficker ficken schlampe

ViolentWords

-----------------------
ViolentWords option
-----------------------

ViolentWords -- specify words considered to be aggressive/violent

Synopsis
--------

      
        <set ViolentWords="slaps beats kick">
      
    

Description
-----------

There is a section in the "Most interesting numbers" which tells who is most
"aggressive" - here you can define which words are considered being "violent".
It is a space seperated list of words. Can not be used in a channel-only
context.

Default

slaps beats smacks

MinQuote

-----------------------
MinQuote option
-----------------------

MinQuote -- minimum numbers of letters for a random quote

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         MinQuote = "10"
        </channel>

        <set MinQuote="5">
      
    

Description
-----------

The random quotes displayed in the "Most Active Nicks" section has a certain
range specified. With this option you can change the minimum number of letters
required for a random quote. Also see the maxquote option.

Default

25

MaxQuote

-----------------------
MaxQuote option
-----------------------

MaxQuote -- maximum numbers of letters for a random quote

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         MaxQuote = "70"
        </channel>

        <set MaxQuote="100">
      
    

Description
-----------

The random quotes displayed in the "Most Active Nicks" section has a certain
range specified. With this option you can change the maximum number of letters
required for a random quote. Also see the minquote option.

Default

65

WordLength

-----------------------
WordLength option
-----------------------

WordLength -- minimum number of characters in an interesting word

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         WordLength = "10"
        </channel>

        <set WordLength="2">
      
    

Description
-----------

The "Most Used Words" section on the stats page display the most used words.
The default is that a word only appears if it is longer than 5 characters. With
this option you can change that minimum.

Default

5

ActiveNicks

-----------------------
ActiveNicks option
-----------------------

ActiveNicks -- nicks to show in "Most Active Nicks"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         ActiveNicks = "50"
        </channel>

        <set ActiveNicks="10">
      
    

Description
-----------

With this option you can define how many nicks you want to appear in the "Most
Active Nicks" section on the stats page.

Default

25

ActiveNicks2

-----------------------
ActiveNicks2 option
-----------------------

ActiveNicks2 -- nicks to show in "These didn't make it.."

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         ActiveNicks2 = "25"
        </channel>

        <set ActiveNicks2="10">
      
    

Description
-----------

With this option you can define how many nicks you want to appear in the "These
didn't make it" section on the stats page.

Default

30

ActiveNicksByHour

-----------------------
ActiveNicksByHour option
-----------------------

ActiveNicksByHour -- number of nicks to show in "Most Active Nicks By Hour"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         ActiveNicksByHour = "25"
        </channel>

        <set ActiveNicksByHour="10">
      
    

Description
-----------

With this option you can define how many nicks you want to appear in the "Most
Active Nicks By Hour" section on the stats page.

Default

10

MostNicksHistory

-----------------------
MostNicksHistory option
-----------------------

MostNicksHistory -- maximum number of nicks to show in "most nicks"

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         MostNicksHistory = "2"
        </channel>

        <set MostNicksHistory="10">
      
    

Description
-----------

With this option you can define how many nicks you want to appear in the "Most
used nicks" section.

Default

5

TopicHistory

-----------------------
TopicHistory option
-----------------------

TopicHistory -- maximum number of topics to show

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         TopicHistory = "2"
        </channel>

        <set TopicHistory="10">
      
    

Description
-----------

With this option you can define how many topics you want to appear in the
"Latest topics" section.

Default

3

UrlHistory

-----------------------
UrlHistory option
-----------------------

UrlHistory -- maximum number of urls to show

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         UrlHistory = "2"
        </channel>

        <set UrlHistory="10">
      
    

Description
-----------

With this option you can define how many urls you want to appear in the "Most
referenced URLs" section.

Default

5

WordHistory

-----------------------
WordHistory option
-----------------------

WordHistory -- maximum number of words to show

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         WordHistory = "5"
        </channel>

        <set WordHistory="15">
      
    

Description
-----------

With this option you can define how many words you want to appear in the "Most
used words" section.

Default

10

NickHistory

-----------------------
NickHistory option
-----------------------

NickHistory -- maximum number of nicks to show

Synopsis
--------

      
        <channel="#channel">
         logfile = "channel.log"
         format = "mIRC"
         NickHistory = "3"
        </channel>

        <set NickHistory="15">
      
    

Description
-----------

With this option you can define how many nicks you want to appear in the "Most
referenced nicks" section.

Default

5

NickTracking

-----------------------
NickTracking option
-----------------------

NickTracking -- track nickchanges and create aliases

Synopsis
--------

      
        <set NickTracking="1">
      
    

Description
-----------

Enabling this option will track nickchanges as well as it can. It will then
automatically create aliases for these nicks.

Default

0 (disabled)

SortByWords

-----------------------
SortByWords option
-----------------------

SortByWords -- Sort "most active nicks" by words

Synopsis
--------

      
        <channel="#channel">
         logfile = "channel.log"
         format = "xchat"
         SortByWords = "0"
        </channel>

        <set SortByWords="1">
      
    

Description
-----------

The default for the "Most Active Nicks" section - is to sort users by lines.
Enabling this will sort it by words instead.

Default

0 (disabled)

-------------------------------------------------------------------------------

Chapter 5. Picture options

PicLocation

-----------------------
PicLocation option
-----------------------

PicLocation -- path to images on stats page

Synopsis
--------

      
        <set PicLocation="userpics/">
      
    

Description
-----------

The location to the pictures used on the stats page - not the user pictures but
the different bars in "Most Active Times".

Default

Current directory

ImagePath

-----------------------
ImagePath option
-----------------------

ImagePath -- path to user pictures

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         ImagePath = "userpics/"
        </channel>

        <set ImagePath="alt_users/">
      
    

Description
-----------

ImagePath defines an alternative path to where user pictures is located. The
default is that user pictures is located in the same directory as the HTML
page.

Default

current directory

DefaultPic

-----------------------
DefaultPic option
-----------------------

DefaultPic -- use a default user picture

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         DefaultPic = "not_available.jpg"
        </channel>

        <set DefaultPic="unknown.gif">
      
    

Description
-----------

DefaultPic defines a picture to be displayed for all users which have no other
picture defined in the user element. This is good for showing "No picture
available" or something.

Default

unset

PicWidth

-----------------------
PicWidth option
-----------------------

PicWidth -- define a standard width for user pictures

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         PicWidth = "not_available.jpg"
        </channel>

        <set PicWidth="unknown.gif">
      
    

Description
-----------

PicWidth defines the standard width for user pictures. Setting the 'width'
attribute of image-elements on the outputted stats page. See also PicHeight

Default

unset

PicHeight

-----------------------
PicHeight option
-----------------------

PicHeight -- define a standard height for user pictures

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         PicHeight = "not_available.jpg"
        </channel>

        <set PicHeight="unknown.gif">
      
    

Description
-----------

PicHeight defines the standard height for user pictures. Setting the 'height'
attribute of image-elements on the outputted stats page. See also PicHeight

Default

unset

-------------------------------------------------------------------------------

Chapter 6. Misc options

Charset

-----------------------
Charset option
-----------------------

Charset -- Charset to use for stats page

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "xchat"
         Charset = "utf-8"
        </channel>

        <set Charset="iso-8859-15">
      
    

Description
-----------

The pisg stats page defines a charset in a meta tag, this can be used if your
country is using a different one than the default.

Default

iso-8859-1

TimeOffset

-----------------------
TimeOffset option
-----------------------

TimeOffset -- use a different time zone than the local machine

Synopsis
--------

      
        <channel="#channel">
         Logfile = "channel.log"
         Format = "mIRC"
         Maintainer = "John"
         TimeOffset = "+5"
        </channel>

        <set TimeOffset="+2">
      
    

Description
-----------

By default, pisg uses the time of the local machine to display the time of the
generated stats. Sometimes when you have a shell on an external box, and it's
in another country, you want to use another time. This is accomplished by the 
TimeOffset command.

Default

+0

RegexpAliases

-----------------------
RegexpAliases option
-----------------------

RegexpAliases -- use regular expressions in user aliases

Synopsis
--------

      
        <user nick="Joe" alias="Joe\d+">

        <set RegexpAliases="1">
      
    

Description
-----------

Enabling this option will make all aliases in <user> lines be parsed as regular
expressions.

Default

0 (disabled)

LangFile

-----------------------
LangFile option
-----------------------

LangFile -- filename of language file

Synopsis
--------

      
        <set LangFile="mylang.txt">
      
    

Description
-----------

With this option you have an alternative way to define the name and/or path to
the language file. Usually you don't have to touch this option.

Default

lang.txt

CssDir

-----------------------
CssDir option
-----------------------

CssDir -- path to directory with css files

Synopsis
--------

      
        <set CssDir="/usr/share/pisg/layout/">
      
    

Description
-----------

CssDir is used to define the paths to the CSS files (the colorschemes). Usually
you don't need to change this.

Default

layout/ (in current directory)

LogType

-----------------------
LogType option
-----------------------

LogType -- type of log (not the format of the log)

Synopsis
--------

      
        <set LogType="Logfile">
      
    

Description
-----------

The type of logs kept for your channel. Currently only "Logfile" is supported,
so you don't need to change this option.

Default

Logfile

