pisg documentation
How to install and configure pisg
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 webserver.
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 OSes
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 ActivePerl.
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.
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.
Setting up a channel
An element called channel is made for defining
channels, a quick example of a channel is here:
Logfile = "channel.log"
Format = "mIRC"
Maintainer = "John"
OutputFile = "mychan.html"
]]>
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 placed into the same
directory as your outputted HTML file.
Specifying user options
User options are set with a simple XML-like syntax in the form:
]]>
Remember, the nick is always required.
For example to add aliases to a nick, then you could do this:
]]>
The asterisk (*) 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:
]]>
If you have a larger picture of the user as well, you can make the picture
on the stats page link to it:
]]>
You can include * or ? to enable filename globbing to randomly choose one
from several pictures: (see documentation for the
ImageGlobPath option)
]]>
You can also set a user's sex:
]]>
Also you can add links to URLs and e-mails:
]]>
or
]]>
The last thing you can do is to ignore nicks (for example bots):
]]>
You don't have to do all this in many lines, you could just as easily do:
]]>
(Here the aliases are a space separated list of nicks, that also works! But *
as a wildcard is smarter, although it is slower).
Setting global options
Many times, it will be useful to set up global options, global options
are set like this:
]]>
Any global option will override anything defined within channel
elements (see )
For example, to change the background color of the stats page, you
could do:
]]>
You can set many options in a single set:
]]>
The above will set the language on the statistics page to DE (Deutsch,
German) and set the time offset to +1.
All options available are mentioned in the reference documentation.
Ignoring links
It's possible to ignore links in the "Most referenced URLs" section:
]]>
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:
]]>
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!
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 color schemes 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.
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:\pisg> perl pisg
The program will run and parse the logfiles you specified in the
configuration file.
If you are using Linux, BSD or another UNIX-like system 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.
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.
General pisg options
Channel
Channel
define channel name
Logfile = "channel.log"
Format = "mIRC"
Maintainer = "John"
]]>
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
the logfile format
Logfile = "channel.log"
Format = "eggdrop"
Maintainer = "John"
]]>
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
Unset
Network
Network
the IRC network of the channel
Logfile = "channel.log"
Format = "eggdrop"
Network = "Undernet"
]]>
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
name of the generated HTML page
Logfile = "channel.log"
Format = "eggdrop"
OutputFile = "mychan.html"
]]>
Description
OutputFile is used to define the name of the
generated statistics page.
Default
index.html
OutputTag
OutputTag
tag to insert into OutputFile
LogDir = "logs/"
Format = "eggdrop"
OutputFile = "mychan%t.html"
OutputTag = "-week"
]]>
Description
OutputTag specifies a string that will replace
occurrences of "%t" in OutputFile. This option is most
useful when used as a command line switch (-t) to pisg in conjunction with
NFiles (-nf). Example:
Leaving out the OutputTag settings from the above
pisg.conf snippet, this writes both the full statistics (mychan.html) and
statistics for the last week (mychan-week.html) using the same pisg config
file. (Assuming that there are separate logfiles for each day.)
Default
unset
Logfile
Logfile
name of logfile to parse
Logfile="/home/foo/eggdrop/logs/mylog.txt"
Format = "eggdrop"
]]>
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. Providing this option multiple
times will parse multiple files in the order the statements appear.
Default
unset
LogDir
LogDir
parse a directory full of logs
LogDir="/home/foo/eggdrop/logs/"
Format = "eggdrop"
]]>
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. Providing
this option multiple times will parse all the files in multiple
directories in the order the statements appear.
Default
unset
NFiles
NFiles
parse only the last files in LogDir
LogDir="/home/foo/eggdrop/logs/"
NFiles="8"
Format="eggdrop"
]]>
Description
When NFiles is set to a positive integer, pisg will
process at most that much files from LogDir. Useful to
create statistics that cover the last week or month. Note that if multiple
LogDir options are provided, NFiles
refers to the number of files which will be processed from each
LogDir
Default
0 (process all files)
Maintainer
Maintainer
name of the maintainer
Logfile = "channel.log"
Format = "mIRC"
Maintainer = "Benny"
]]>
Description
Maintainer is used to define the name of the
maintainer 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
use a different color scheme for stats page
Logfile = "channel.log"
ColorScheme = "darkgalaxy"
Maintainer = "John"
]]>
Description
ColorScheme is used to define the color scheme used
for the statistics page. Actually it's the CSS file being included.
Available options are: default, darkgalaxy, darkred, justgrey, ocean,
softgreen, orange_grey.
Default
default
Lang
Lang
define the language / translation to use
Logfile = "channel.log"
Format = "mIRC"
Lang = "DE"
]]>
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 are: EN | DE | NO | PT | PT-BR | DA | FR | ES | PL | NL | SE |
FI | SI | HU | EE | IT | CA | TR | RO | IS | CZ | SK | RU | GR | HE | BG
| YU | SQ
Default
EN (English)
PageHead
PageHead
define a file as page header
Logfile = "channel.log"
Format = "mIRC"
OutputFile = "stats.html"
PageHead = "myheader.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
LogPrefix
LogPrefix
only parse logs LogPrefixed with a user defined string
LogDir="/home/foo/eggdrop/logs/"
Format = "eggdrop"
LogPrefix = "logjun"
]]>
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
Regexp to sort logfiles by format month||day||year
]]>
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 format.
Default
Unset
Silent
Silent
make pisg silent, suppress messages
]]>
Description
This option is useful mainly from command line 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)
Options for various statistics features
ShowActiveTimes
ShowActiveTimes
enable/disable "Most Active Times"
Logfile = "channel.log"
Format = "xchat"
ShowActiveTimes = "0"
]]>
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
enable/disable "Big Numbers" sections
Logfile = "channel.log"
Format = "xchat"
ShowBigNumbers = "0"
]]>
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
enable/disable "Latest topics" sections
Logfile = "channel.log"
Format = "xchat"
ShowTopics = "0"
]]>
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
enable/disable "words per line"
Logfile = "channel.log"
Format = "xchat"
ShowWpl = "0"
]]>
Description
With this option you can enable the "words per line" column 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
enable/disable "characters per line"
Logfile = "channel.log"
Format = "xchat"
ShowCpl = "0"
]]>
Description
With this option you can enable the "characters per line" column 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
enable/disable "number of words"
Logfile = "channel.log"
Format = "xchat"
ShowWords = "0"
]]>
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
show when a user was last seen on a channel
Logfile = "channel.log"
Format = "xchat"
ShowLastSeen = "0"
]]>
Description
With this option enabled, a column will be added to the "Most Active
Nicks" section to display when a user was last seen. E.g. "2 days ago".
Default
0 (disabled)
ShowTime
ShowTime
show when a nick was active
Logfile = "channel.log"
Format = "xchat"
ShowTime = "0"
]]>
Description
The default behaviour is to add a column to the "Most Active Nicks"
section displaying a fancy time bar to show when a user was active. With
this option it can be disabled.
Default
1 (enabled)
ShowLineTime
ShowLineTime
mIRCStats like behaviour of time bar
Logfile = "channel.log"
Format = "bobot"
ShowLineTime = "0"
]]>
Description
The default behaviour is to add a column to the "Most Active Nicks"
section displaying a fancy time bar 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 time bar next to the number of lines, in the same
column.
Default
0 (disabled)
ShowWordTime
ShowWordTime
ShowLineTime like behavior of words column
Logfile = "channel.log"
Format = "bobot"
ShowWordTime = "0"
]]>
Description
The default behaviour is to add a column to the "Most Active Nicks"
section displaying a fancy time bar 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 time bar next to the number of words, in the same column.
Default
0 (disabled)
ShowRandQuote
ShowRandQuote
enable or disable the random quotes
Logfile = "channel.log"
Format = "bobot"
ShowRandQuote = "0"
]]>
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
enable or disable the legend of the time bars
Logfile = "channel.log"
Format = "bobot"
ShowLegend = "0"
]]>
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
enable or disable the kick line
Logfile = "channel.log"
Format = "bobot"
ShowKickLine = "0"
]]>
Description
By default, pisg shows an example kick line in the "Most kicked"-stats.
With this option it can be disabled.
Default
1 (enabled)
ShowActionLine
ShowActionLine
enable or disable the action line
Logfile = "channel.log"
Format = "bobot"
ShowActionLine = "0"
]]>
Description
By default, pisg shows an example action line in the "Most actions"-stats.
With this option it can be disabled.
Default
1 (enabled)
ShowShoutLine
ShowShoutLine
enable or disable the shout line
Logfile = "channel.log"
Format = "bobot"
ShowShoutLine = "0"
]]>
Description
By default, pisg shows an example shout line in the "Most shouting
people"-stats. With this option it can be disabled.
Default
1 (enabled)
ShowFoulDecimals
ShowFoulDecimals
set how many decimals to show
Logfile = "channel.log"
Format = "bobot"
ShowFoulDecimals = "2"
]]>
Description
By default, pisg uses 1 decimal. With this option you could change
it to whatever you like. Negative is treated as the default value.
Default
1 decimal
ShowFoulLine
ShowFoulLine
enable or disable the foul line
Logfile = "channel.log"
Format = "bobot"
ShowFoulLine = "0"
]]>
Description
By default, pisg doesn't show an example foul line in the "Most
fouls"-stats. With this option it can be enabled.
Default
0 (disabled)
ShowViolentLines
ShowViolentLines
enable or disable the violent lines
Logfile = "channel.log"
Format = "bobot"
ShowViolentLines = "0"
]]>
Description
By default, pisg shows example violent lines in the "Most aggressive"
and "Most attacked"-stats. With this option it can be disabled.
Default
1 (enabled)
ShowMuw
ShowMuw
enable or disable "Most used words"
Logfile = "channel.log"
Format = "xchat"
ShowMuw = "0"
]]>
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
enable or disable "Most referenced nicks"
Logfile = "channel.log"
Format = "xchat"
ShowMrn = "0"
]]>
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
enable or disable "Most referenced URLs"
Logfile = "channel.log"
Format = "xchat"
ShowMru = "0"
]]>
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)
ShowOps
ShowOps
enable or disable op statistics
Logfile = "channel.log"
Format = "xchat"
ShowOps = "0"
]]>
Description
By default, pisg has op statistics in the "Most interesting numbers"
section. Here you can disable the feature, it's useful if you don't feel
that the information is of any value, or your log format doesn't support
ops/deops.
Default
1 (enabled)
ShowVoices
ShowVoices
enable or disable voice statistics
Logfile = "channel.log"
Format = "xchat"
ShowVoices = "0"
]]>
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
enable or disable halfop statistics
Logfile = "channel.log"
Format = "xchat"
ShowHalfops = "0"
]]>
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
show who changed nick most often
Logfile = "channel.log"
Format = "xchat"
ShowMostNicks = "0"
]]>
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
show most active nicks by hour
Logfile = "channel.log"
Format = "xchat"
ShowMostActiveByHour = "0"
]]>
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)
ShowOnlyTop
ShowOnlyTop
only count stats for top talkers, ignore less-active users
Logfile = "channel.log"
Format = "xchat"
ShowOnlyTop = "1"
]]>
Description
By enabling this option, stats in the "Big Numbers" and "Interesting
Numbers" section will only be counted for users who were the most
active. E.g. users who appear in the "Most Active Nicks" section, as
respected by the ActiveNicks and ActiveNicks2 options.
Default
0 (disabled)
ShowMostActiveByHourGraph
ShowMostActiveByHourGraph
show graphs in most active nicks by hour
Logfile = "channel.log"
Format = "xchat"
ShowMostActiveByHourGraph = "0"
]]>
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
ignore specified words
]]>
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 separated list of words.
You can use * like in nick aliases.
Can not be used in a channel-only context.
Default
unset
NoIgnoredQuotes
NoIgnoredQuotes
Control random quote output
]]>
Description
When set to "1", pisg will not output quotes containing ignored words.
Pisg will output a blank line after trying 20 random quotes if all 20 random quotes were ignored.
Default
0
FoulWords
FoulWords
specify words considered to be bad/FoulWords language
]]>
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 separated list of words.
You can use * like in nick aliases.
Can not be used in a channel-only context.
Default
ass fuck bitch shit scheisse kacke arsch ficker ficken schlampe
ViolentWords
ViolentWords
specify words considered to be aggressive/violent
]]>
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 separated list of words. You can use * like in
nick aliases. Can not be used in a channel-only context.
Default
slaps beats smacks
MinQuote
MinQuote
minimum numbers of letters for a random quote
Logfile = "channel.log"
Format = "xchat"
MinQuote = "10"
]]>
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
maximum numbers of letters for a random quote
Logfile = "channel.log"
Format = "xchat"
MaxQuote = "70"
]]>
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
minimum number of characters in an interesting word
Logfile = "channel.log"
Format = "xchat"
WordLength = "10"
]]>
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
QuoteWidth
QuoteWidth
maximum allowed length of a "word" with no spaces
Logfile = "channel.log"
Format = "xchat"
QuoteWidth = "48"
]]>
Description
Pisg will automatically insert a space in words that have a length
over the amount QuoteWidth is set to. When used in breaking up
URLs it will insert a space in the displayed URL, but not in the
actual URL referenced by the HREF.
Default
80
BigNumbersThreshold
BigNumbersThreshold
Minimum number of lines per user for some "Big Numbers" statistics
Logfile = "channel.log"
Format = "xchat"
BigNumbersThreshold = "10"
]]>
Description
Pisg will ignore users with less than this setting lines in the "questions
asked", "shouts loudest", "CAPSLOCK", "longest line", "most sad", and "most
happy" sections. If the setting is "sqrt" (the default), it will be
dynamically replaced with the square root of the number of lines of the
most active nick.
Default
sqrt
ActiveNicks
ActiveNicks
nicks to show in "Most Active Nicks"
Logfile = "channel.log"
Format = "mIRC"
ActiveNicks = "50"
]]>
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
nicks to show in "These didn't make it.."
Logfile = "channel.log"
Format = "mIRC"
ActiveNicks2 = "25"
]]>
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
number of nicks to show in "Most Active Nicks By Hour"
Logfile = "channel.log"
Format = "mIRC"
ActiveNicksByHour = "25"
]]>
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
maximum number of nicks to show in "most nicks"
Logfile = "channel.log"
Format = "mIRC"
MostNicksHistory = "2"
]]>
Description
With this option you can define how many nicks you want to appear in
the "Most used nicks" section.
Default
5
MostNicksVerbose
MostNicksVerbose
show nicks used in "most nicks"
Logfile = "channel.log"
Format = "mIRC"
MostNicksVerbose = "0"
]]>
Description
By disabling this option you can stop pisg from displaying all the nicks
a user has had in the "Most used nicks" section.
Default
1
TopicHistory
TopicHistory
maximum number of topics to show
Logfile = "channel.log"
Format = "mIRC"
TopicHistory = "2"
]]>
Description
With this option you can define how many topics you want to appear in
the "Latest topics" section.
Default
3
UrlHistory
UrlHistory
maximum number of URLs to show
Logfile = "channel.log"
Format = "mIRC"
UrlHistory = "2"
]]>
Description
With this option you can define how many URLs you want to appear in
the "Most referenced URLs" section.
Default
5
WordHistory
WordHistory
maximum number of words to show
Logfile = "channel.log"
Format = "mIRC"
WordHistory = "5"
]]>
Description
With this option you can define how many words you want to appear in
the "Most used words" section.
Default
10
NickHistory
NickHistory
maximum number of nicks to show
logfile = "channel.log"
format = "mIRC"
NickHistory = "3"
]]>
Description
With this option you can define how many nicks you want to appear in
the "Most referenced nicks" section.
Default
5
NickTracking
NickTracking
track nick changes and create aliases
]]>
Description
Enabling this option will track nick changes as well as it can. It will
then automatically create aliases for these nicks.
Default
0 (disabled)
SortByWords
SortByWords
sort "most active nicks" by words
logfile = "channel.log"
format = "xchat"
SortByWords = "0"
]]>
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)
Picture options
PicLocation
PicLocation
path to images on stats page
]]>
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
UserPics
UserPics
number of user pictures per row
Logfile = "channel.log"
UserPics = "no"
]]>
Description
UserPics allows you to configure the number of user
pictures per row. Per default, one picture will be shown. Since pictures
are usually higher than one line of text, this lets the table grow. With
settings greater than 1, several pictures will be placed next to each
other. A good setting would be UserPics=3 and pictures
of size 60x60. Set UserPics to no or 0 to disable user
pictures. The latter is useful if you share a user config file between
channels and want to disable user pictures for some channels.
Default
yes (1)
ImagePath
ImagePath
path to user pictures (HTML page)
Logfile = "channel.log"
Format = "mIRC"
ImagePath = "userpics/"
]]>
Description
ImagePath defines the path to where user
pictures are located, relative to the HTML page generated. The default is
that user pictures is located in the same directory as the HTML page.
Default
current directory
DefaultPic
DefaultPic
use a default user picture
Logfile = "channel.log"
Format = "mIRC"
DefaultPic = "not_available.jpg"
]]>
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.
May contain globbing patterns, see ImageGlobPath below.
Default
unset
ImageGlobPath
ImageGlobPath
path to user pictures (output generation)
Logfile = "channel.log"
Format = "mIRC"
ImageGlobPath = "users/"
]]>
Description
ImageGlobPath defines the path to the directory where
user pictures are located, relative to the current directory. This setting
is used to choose random pictures if ? or * (globbing characters) are used
in the picture name. ? matches a single character, * matches a (possibly
empty) string. The default is the ImagePath setting.
(NB: This setting will be different from ImagePath if
the latter is not relative to the current directory, e.g. if you are
writing the HTML file outside of the current directory.)
Default
current ImagePath setting
PicWidth
PicWidth
define a standard width for user pictures
Logfile = "channel.log"
Format = "mIRC"
PicWidth = "500"
]]>
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
define a standard height for user pictures
Logfile = "channel.log"
Format = "mIRC"
PicHeight = "500"
]]>
Description
PicHeight defines the standard height for user
pictures. Setting the 'height' attribute of image-elements on the
outputted stats page. See also PicWidth
Default
unset
Misc options
Charset
Charset
character set to use for stats page
Logfile = "channel.log"
Format = "xchat"
Charset = "utf-8"
]]>
Description
The pisg stats page defines a character set in a meta tag, this can be
used if your country is using a different one than the default. Pisg
will also use this setting to convert the language templates from
LangFile if the language defines a source charset.
Note: you also have to tell your webserver to transmit the charset to
the browser. With Apache, use "AddDefaultCharset off" in the server
config.
Default
iso-8859-1
LogCharset
LogCharset
character set for logfiles
Logfile = "channel.log"
Format = "xchat"
Charset = "iso-8859-1"
LogCharset = "utf-8"
]]>
Description
If LogCharset is set and different from
Charset, pisg will convert the charset using
Text::Iconv. Using this option slows down log processing.
Default
empty (no conversion)
LogCharsetFallback
LogCharsetFallback
fallback character set for logfiles
Logfile = "channel.log"
Format = "xchat"
Charset = "utf-8"
LogCharset = "utf-8"
LogCharsetFallback = "iso-8859-1"
]]>
Description
LogCharsetFallback defines a fallback charset for
the LogCharset conversion. This is useful if you
have mixed unicode/iso-8859-* logs. Pisg will first try the conversion
from LogCharset. If that fails,
LogCharsetFallback is used. Note that this only works
for charsets where certain byte sequences are illegal, like UTF-8. (In
short: LogCharset = utf-8,
LogCharsetFallback = iso-8859-15 works, the other way
round does not.)
Default
empty (no fallback conversion)
TimeOffset
TimeOffset
use a different time zone than the local machine
Logfile = "channel.log"
Format = "mIRC"
Maintainer = "John"
TimeOffset = "+5"
]]>
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
use regular expressions in user aliases
]]>
Description
Enabling this option will make all aliases in <user> lines be
parsed as regular expressions; this setting also applies to the
IgnoreWords, FoulWords, and
ViolentWords settings.
Default
0 (disabled)
LangFile
LangFile
filename of language file
]]>
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
path to directory with CSS files
]]>
Description
CssDir is used to define the paths to the CSS files
(the color schemes). Usually you don't need to change this.
Default
layout/ (in current directory)
LogType
LogType
type of log (not the format of the log)
]]>
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