|
|
@@ -1,354 +0,0 @@
|
|
|
-README for pisg.cfg - the configuration file for pisg
|
|
|
-------------------
|
|
|
-This file is used for:
|
|
|
- - 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 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 is a space separated 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 options 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 different options are listed below.
|
|
|
-
|
|
|
-Other examples:
|
|
|
-<set lang='EN'>
|
|
|
-<set bgcolor="#dedeee" text="black" hbgcolor="#666699" hcolor="white" hicell="#BABADD" hicell2="#CCCCCC">
|
|
|
-<set show_voices="1" show_wpl="1">
|
|
|
-<set topichistory="3" timeoffset="+0">
|
|
|
-
|
|
|
-There is many options which can be set, here is a list of them all (not
|
|
|
-case sensitive):
|
|
|
-
|
|
|
---- The most useful ones ---
|
|
|
-
|
|
|
-channel The name of your channel. E.g. '#mychannel'
|
|
|
- (default: unset)
|
|
|
-
|
|
|
-logfile The exact filename of the logfile. E.g. 'mylog.log'
|
|
|
- (default: unset)
|
|
|
-
|
|
|
-logsuffix Regexes to sort logfiles by in format month||day||year
|
|
|
- Note: example will work for eggdrop's default format
|
|
|
- Example: 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)"
|
|
|
- (default: unset)
|
|
|
-
|
|
|
-format The logfile format. See FORMATS file for supported formats
|
|
|
-
|
|
|
-network Network the channel is using. E.g. 'Undernet'
|
|
|
-
|
|
|
-outputfile Outputted stats goes to this HTML file.
|
|
|
- (default: index.html)
|
|
|
-
|
|
|
-maintainer The maintainer or bot which makes the logfile.
|
|
|
-
|
|
|
-lang Language to use (see lang.txt)
|
|
|
- EN | DE | DK | FR | ES | PL | PT | NO | NL | SE | EE | IT
|
|
|
- HU | SI | FI
|
|
|
-
|
|
|
-pagehead Some 'page header' file which you want to include in top
|
|
|
- of the output file.
|
|
|
- (default: none)
|
|
|
-
|
|
|
-pagefoot Same as above, this is just the footer.
|
|
|
- (default: none)
|
|
|
-
|
|
|
-imagepath If your user pictures is located in a special directory,
|
|
|
- set the path here. E.g. 'userpics/'
|
|
|
- (default: current directory)
|
|
|
-
|
|
|
-default_pic If no picture defined for a user, use this default
|
|
|
- picture, good for example to display 'No picture
|
|
|
- available'.
|
|
|
-
|
|
|
-logdir If you specify a path to a directory here, then pisg will
|
|
|
- run through the files in that directory, parse all
|
|
|
- logfiles in it and create 1 HTML file from it. Useful
|
|
|
- with eggdrops.
|
|
|
-
|
|
|
-prefix Works when logdir is set, only analyze files in logdirs
|
|
|
- prefixed by xxx
|
|
|
-
|
|
|
-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 set '+1' to add
|
|
|
- one hour to the stats.
|
|
|
- (default: +0)
|
|
|
-
|
|
|
-show_activetimes 1 or 0, this enables/disables the 'Most Active Times'
|
|
|
- section.
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_bignumbers 1 or 0, enable/disable 'Big Numbers' and 'Other
|
|
|
- interesting numbers'.
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_topics 1 or 0, enable/disable 'Latest topics'.
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_wpl 1 or 0, this enables pisg to show 'words per line' for
|
|
|
- each person in 'most active nicks'
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-show_cpl Same as above, this is just 'characters per line'
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-show_words 1 or 0, this will enable/disable both of the 2 above
|
|
|
- options.
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-show_lastseen 1 or 0, display a column showing when the user was last
|
|
|
- on the channel (how many days ago)
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-show_time 1 or 0, this will enable/disable the showing of the
|
|
|
- fancy timebars indicating when a nick was active.
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_linetime 1 or 0, the same as above, except this will show the
|
|
|
- bar next to the number of lines like in mIRCStats
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-show_randquote 1 or 0, this will enable or disable the random quote
|
|
|
- displayed in the "active nick list"
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_legend 1 or 0, this will add a legend of the different time-
|
|
|
- bars.
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_kickline 1 or 0, this will add an example-kickline to the
|
|
|
- "Most kicked"-stats
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_actionline 1 or 0, this will add an example-actionline to the
|
|
|
- "Most actions"-stats
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_shoutline 1 or 0, this will add an example-shoutline to the
|
|
|
- "Most shouting people"-stats
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_violentlines 1 or 0, this will add an example-attack to the
|
|
|
- "Most aggressive" and "Most attacked"-stats
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_muw 1 or 0, this will enable or disable the "most used
|
|
|
- words" list
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_mrn 1 or 0, this will enable or disable the "most
|
|
|
- referenced nicks" list
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_mru 1 or 0, this will enable or disable the "most
|
|
|
- referenced urls" list
|
|
|
- (default: 1)
|
|
|
-
|
|
|
-show_voices 1 or 0, this will enable or disable the voice statistics
|
|
|
- (those who got voice and those who voiced).
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-show_mostnicks 1 or 0, this will enable or disble a list with "users
|
|
|
- who had most nicks" (those who changed nicks often),
|
|
|
- only works properly when nicktracking is set to 1
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-ignorewords A space separated list of words to ignore in 'most
|
|
|
- referenced words'
|
|
|
- (default: "")
|
|
|
-
|
|
|
-foul Space separated list of words considered to be 'foul'
|
|
|
- language, look in the bottom for a better explanation.
|
|
|
-
|
|
|
-regexp_aliases 1 or 0, enabling this will make aliases in <user> tags
|
|
|
- regex-able.
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-silent 1 or 0. Enabling this will suppress all standard output
|
|
|
- from pisg. Error messages will still be sent to STDOUT.
|
|
|
- (default: 0)
|
|
|
-
|
|
|
---- 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 in tables
|
|
|
-vlink Color of visited links in tables
|
|
|
-hlink Color of hovered links in tables
|
|
|
-
|
|
|
-bg_link Color of links on background
|
|
|
-bg_vlink Color of visited links on background
|
|
|
-bg_hlink Color of hovered links on background
|
|
|
-
|
|
|
-headline Border color of headlines
|
|
|
-rankc Colors of 'ranks' (1,2,3,4) and active times
|
|
|
-hi_rankc Highlighted ranks
|
|
|
-
|
|
|
-pic_height Hardcode user picture sizes on stats page. This is when
|
|
|
- user has a pic, and you want to make it smaller.
|
|
|
-pic_width
|
|
|
-
|
|
|
-pic_v_0 Below settings are the filenames of the images to be
|
|
|
-pic_v_6 shown on the page 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
|
|
|
-
|
|
|
-pic_loc Directory containing your png graphics files.
|
|
|
- (default: current dir)
|
|
|
-
|
|
|
---- Less important things, useful for some people ---
|
|
|
-
|
|
|
-charset Charset to use for stats page.
|
|
|
- (default: iso-8859-1)
|
|
|
-
|
|
|
-use_activetime_alt Use an alternative way to highlight the number under the
|
|
|
- time bars, if set to 1, will highlight the hour in which
|
|
|
- the stats were generated.
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-minquote Minimal number of letters for a random quote
|
|
|
- (default: 25)
|
|
|
-
|
|
|
-maxquote Maximum number of letters for a random quote
|
|
|
- (default: 65)
|
|
|
-
|
|
|
-wordlength The minimum number of chars an interesting word may be
|
|
|
- in 'most used words'
|
|
|
- (default: 5)
|
|
|
-
|
|
|
-activenicks Number of nicks to show in 'most active nicks'
|
|
|
- (default: 25)
|
|
|
-
|
|
|
-activenicks2 Nicks to show in 'these didn't make it...'
|
|
|
- (default: 30)
|
|
|
-
|
|
|
-topichistory Maximum number of topics to show in 'latest topics'
|
|
|
- (default: 3)
|
|
|
-
|
|
|
-urlhistory Maximum number of URLs to show in 'most referenced URLs'
|
|
|
- (default: 5)
|
|
|
-
|
|
|
-wordhistory Maximum number of words to show in 'Most used words'
|
|
|
- (default: 10)
|
|
|
-
|
|
|
-nickhistory Maximum number of nicks to show in 'Most referenced
|
|
|
- nicks'
|
|
|
- (default: 5)
|
|
|
-
|
|
|
-langfile Filename of language file.
|
|
|
- (default: lang.txt)
|
|
|
-
|
|
|
-nicktracking 1 or 0, track nickchanges and create aliases?
|
|
|
- (default: 0)
|
|
|
-
|
|
|
-logtype The type of logs kept for your channel. Currently only
|
|
|
- "Logfile" is supported, so you don't need to change this
|
|
|
- option.
|
|
|
-
|
|
|
-
|
|
|
-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! :)
|
|
|
-
|
|
|
-
|
|
|
-LINKS
|
|
|
-------------------
|
|
|
-It's possible to ignore links in the 'most referenced URLs' section:
|
|
|
-<link url="http://www.slashdot.org" ignore="y">
|