How to install and configure 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. 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. 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. An element called 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 called #channel, the logfile pisg will look for is called channel.log and the of the logfile will be mIRC. The (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. 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 option) ]]> You can also set a user's sex. The sex setting can be "f"emale, "m"ale, or "b"ot: ]]> 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). Many times, it will be useful to set up global options, global options are set like this: ]]> Any global option will be overriden by 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. It's possible to ignore links in the "Most referenced URLs" section: ]]> 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! 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 option when using them. The colorschemes distributed with pisg are: default (which is the default), darkgalaxy, darkred, justgrey, ocean, orange_grey, pisg, softgreen. 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. If you want to embed the statistics into another page, use the "none" color scheme. Pisg will then omit the HTML header and write only the body part. 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. 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. Channel Channel define channel name Logfile = "channel.log" Format = "mIRC" Maintainer = "John" ]]> Channel is used in two contexts, globally when using <set> and when defining new channels. It sets the name of the channel. Unset Format Format the logfile format Logfile = "channel.log" Format = "eggdrop" Maintainer = "John" ]]> 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. If your logfiles have the suffix .gz or .bz2, they will automatically be decompressed and read by pisg. See also . Unset Network Network the IRC network of the channel Logfile = "channel.log" Format = "eggdrop" Network = "Undernet" ]]> Network is used to set the network which the channel resides on, this name is displayed on the stats page. SomeIRCNetwork OutputFile OutputFile name of the generated HTML page Logfile = "channel.log" Format = "eggdrop" OutputFile = "mychan.html" ]]> OutputFile is used to define the name of the generated statistics page. index.html OutputTag OutputTag tag to insert into OutputFile LogDir = "logs/" Format = "eggdrop" OutputFile = "mychan%t.html" OutputTag = "-week" ]]> OutputTag specifies a string that will replace occurrences of "%t" in . This option is most useful when used as a command line switch (-t) to pisg in conjunction with (-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.) unset Logfile Logfile name of logfile to parse Logfile="/home/foo/eggdrop/logs/mylog.txt" Format = "eggdrop" ]]> 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 option instead. Providing this option multiple times will parse multiple files in the order the statements appear. Wildcards (* ? []) will be expanded. See also and . unset LogDir LogDir parse a directory full of logs LogDir="/home/foo/eggdrop/logs/" Format = "eggdrop" ]]> When LogDir is defined to valid path to a directory, then pisg will run through that directory, parse all logfiles in it and create one HTML page 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. See also , , and . unset NFiles NFiles parse only the last files in LogDir="/home/foo/eggdrop/logs/" NFiles="8" Format="eggdrop" ]]> When NFiles is set to a positive integer, pisg will process only the last that much logfiles from and options. Useful to create statistics that cover the last week or month (assuming there are separate logfile per day/week/etc.). 0 (process all files) Maintainer Maintainer name of the maintainer Logfile = "channel.log" Format = "mIRC" Maintainer = "Benny" ]]> 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. This setting is also used by some log parsers where "You" is used instead of the nick in the log (e.g. "You have been kicked"). See also , . MAINTAINER ColorScheme ColorScheme use a different color scheme for stats page Logfile = "channel.log" ColorScheme = "darkgalaxy" Maintainer = "John" ]]> ColorScheme is used to define the color scheme used for the statistics page. Actually it's the CSS file being included. CSS files distributed with pisg are: darkgalaxy, darkred, default, justgrey, ocean, orange_grey, pisg, softgreen (omit the .css). The file will be included statically in the generated HTML page. If you give a file name or URL (i.e. a color scheme name with .css or a path), the file will be linked to instead. Using "none" will cause pisg to write only the body of the page; use this to include the statistics into a custom page. See also , , HiCell/HiCell2. default AltColorScheme AltColorScheme alternate stylesheets for stats page Logfile = "channel.log" ColorScheme = "darkgalaxy" AltColorScheme = "layout/ocean.css" Maintainer = "John" ]]> AltColorScheme defines an alternate CSS file to be used for the statistics page. Multiple files can be given (space separated.) Note that this is not supported by all browsers. See also and . default Lang Lang define the language / translation to use Logfile = "channel.log" Format = "mIRC" Lang = "DE" OutputFile = "mychan-%l.html" ]]> Lang defines the language to use for the stats. Currently, lang.txt includes: EN (English), BG (Bulgarian), CA (Catalan), CZ (Czech), DA (Danish), DE (German), EE (Estonian), ES (Spanish), FI (Finnish), FR (French), GR (Greek), HE (Hebrew), HU (Hungarian), IS (Icelandic), IT (Italian), NL (Dutch), NL_BE (Flemish), NO (Norwegian), PL (Polish), PT (Portuguese), PT_BR (Portuguese/Brazil), RO (Romanian), RU (Russian), SE (Swedish), SI (Slovenian), SK (Slovak), SQ (Albanian), TR (Turkish), YU (Serbian). Output in several languages can be generated at the same time, separate the languages by comma. The tag %l in the output file name will be replaced by the language name. See also . EN (English) PageHead PageHead define a file as page header Logfile = "channel.log" Format = "mIRC" OutputFile = "stats.html" PageHead = "myheader.txt" ]]> 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 . none PageFoot PageFoot define a file as page footer Logfile = "channel.log" Format = "mIRC" outputfile = "stats.html" PageFoot = "myfooter.txt" ]]> 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 . none LogPrefix LogPrefix only parse logs LogPrefixed with a user defined string LogDir="/home/foo/eggdrop/logs/" Format = "eggdrop" LogPrefix = "logjun" ]]> When using the 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. unset LogSuffix LogSuffix Regexp to sort logfiles by format month||day||year ]]> LogSuffix is used to define the suffix of a logfile, it only works when is defined. The example in the synopsis is for the eggdrop bots default format. Unset Silent Silent make pisg silent, suppress messages ]]> 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. 0 (disabled) CacheDir CacheDir use a cache to speed up log parsing ]]> Setting this option makes pisg dump the results of log parsing into cache files. The next time pisg is run, it compares the timestamp of the log(s) with the timestamp stored in the cache file. When the log was not changed, the cached data is used. (This means that it does not work if you only have a single big logfile. Split the log at arbitrary points and use or ="dir/*".) Note that the cache files should be deleted when the pisg config file is changed since the cache data uses the old config settings. does not work especially well with the cache when using different settings. Unset DailyActivity DailyActivity number of days to show in "Daily Actitity" Logfile = "channel.log" Format = "xchat" DailyActivity = "0" ]]> This option sets the number of days to show in the "Daily activity" section. Pisg will generate a graph that shows the actitivy during this timeframe. Setting the option to 0 disables the section. 0 (disabled) ShowActiveTimes ShowActiveTimes enable/disable "Most Active Times" Logfile = "channel.log" Format = "xchat" ShowActiveTimes = "0" ]]> With this option you can disable the "Most Active Times" section on the stats page. It will simply disappear when specifying 0. 1 (enabled) ShowActiveNicks ShowActiveNicks enable/disable "Most Active Nicks" Logfile = "channel.log" Format = "xchat" ShowActiveNicks = "0" ]]> With this option you can disable the "Most Active Nicks" section on the stats page. 1 (enabled) ShowBigNumbers ShowBigNumbers enable/disable "Big Numbers" sections Logfile = "channel.log" Format = "xchat" ShowBigNumbers = "0" ]]> 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. 1 (enabled) ShowTopics ShowTopics enable/disable "Latest topics" sections Logfile = "channel.log" Format = "xchat" ShowTopics = "0" ]]> With this option you can disable the "Latest topics" section on the stats page. It will simply disappear when specifying 0. 1 (enabled) ShowLines ShowLines enable/disable "number of lines" Logfile = "channel.log" Format = "xchat" ShowLines = "0" ]]> The default behaviour is to add a column to the "Most Active Nicks" section displaying the number of lines a user wrote. With this option it can be disabled. 1 (enabled) ShowWpl ShowWpl enable/disable "words per line" Logfile = "channel.log" Format = "xchat" ShowWpl = "0" ]]> 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. 0 (disabled) ShowCpl ShowCpl enable/disable "characters per line" Logfile = "channel.log" Format = "xchat" ShowCpl = "0" ]]> 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. 0 (disabled) ShowWords ShowWords enable/disable "number of words" Logfile = "channel.log" Format = "xchat" ShowWords = "0" ]]> The ShowWords option adds a column to the "Most Active Nicks" list which list the total number of words a user has typed. 0 (disabled) ShowLastSeen ShowLastSeen show when a user was last seen on a channel Logfile = "channel.log" Format = "xchat" ShowLastSeen = "0" ]]> 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". 1 (enabled) ShowTime ShowTime show when a nick was active Logfile = "channel.log" Format = "xchat" ShowTime = "0" ]]> 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. 1 (enabled) ShowLineTime ShowLineTime mIRCStats like behaviour of time bar Logfile = "channel.log" Format = "bobot" ShowLineTime = "0" ]]> 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. 0 (disabled) ShowWordTime ShowWordTime ShowLineTime like behavior of words column Logfile = "channel.log" Format = "bobot" ShowWordTime = "0" ]]> 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. 0 (disabled) ShowRandQuote ShowRandQuote enable or disable the random quotes Logfile = "channel.log" Format = "bobot" ShowRandQuote = "0" ]]> 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. 1 (enabled) ShowLegend ShowLegend enable or disable the legend of the time bars Logfile = "channel.log" Format = "bobot" ShowLegend = "0" ]]> By default, pisg shows a legend below the "Most Active Times" displaying what the different colors means. With this option it can be disabled. 1 (enabled) ShowKickLine ShowKickLine enable or disable the kick line Logfile = "channel.log" Format = "bobot" ShowKickLine = "0" ]]> By default, pisg shows an example kick line in the "Most kicked"-stats. With this option it can be disabled. 1 (enabled) ShowActionLine ShowActionLine enable or disable the action line Logfile = "channel.log" Format = "bobot" ShowActionLine = "0" ]]> By default, pisg shows an example action line in the "Most actions"-stats. With this option it can be disabled. 1 (enabled) ShowShoutLine ShowShoutLine enable or disable the shout line Logfile = "channel.log" Format = "bobot" ShowShoutLine = "0" ]]> By default, pisg shows an example shout line in the "Most shouting people"-stats. With this option it can be disabled. 1 (enabled) ShowFoulDecimals ShowFoulDecimals set how many decimals to show Logfile = "channel.log" Format = "bobot" ShowFoulDecimals = "2" ]]> By default, pisg uses 1 decimal. With this option you could change it to whatever you like. Negative is treated as the default value. 1 decimal ShowFoulLine ShowFoulLine enable or disable the foul line Logfile = "channel.log" Format = "bobot" ShowFoulLine = "0" ]]> By default, pisg doesn't show an example foul line in the "Most fouls"-stats. With this option it can be enabled. 0 (disabled) ShowViolentLines ShowViolentLines enable or disable the violent lines Logfile = "channel.log" Format = "bobot" ShowViolentLines = "0" ]]> By default, pisg shows example violent lines in the "Most aggressive" and "Most attacked"-stats. With this option it can be disabled. 1 (enabled) ShowMuw ShowMuw enable or disable "Most used words" Logfile = "channel.log" Format = "xchat" ShowMuw = "0" ]]> By default, pisg adds an "Most used words" section to the stats page. With this option you can disable it from being shown. See also . 1 (enabled) ShowMrn ShowMrn enable or disable "Most referenced nicks" Logfile = "channel.log" Format = "xchat" ShowMrn = "0" ]]> By default, pisg adds an "Most referenced nicks" section to the stats page. With this option you can disable it from being shown. See also . 1 (enabled) ShowMru ShowMru enable or disable "Most referenced URLs" Logfile = "channel.log" Format = "xchat" ShowMru = "0" ]]> By default, pisg adds an "Most referenced URLs" section to the stats page. With this option you can disable it from being shown. See also . 1 (enabled) ShowCharts ShowCharts enable or disable channel music charts Logfile = "channel.log" Format = "xchat" ShowCharts = "0" ]]> With this option set, pisg creates a chart listing of the top songs played on the channel. See also and . 0 (disabled) ShowOps ShowOps enable or disable op statistics Logfile = "channel.log" Format = "xchat" ShowOps = "0" ]]> 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. 1 (enabled) ShowVoices ShowVoices enable or disable voice statistics Logfile = "channel.log" Format = "xchat" ShowVoices = "0" ]]> 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. 0 (disabled) ShowHalfops ShowHalfops enable or disable halfop statistics Logfile = "channel.log" Format = "xchat" ShowHalfops = "0" ]]> 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. 0 (disabled) ShowMostNicks ShowMostNicks show who changed nick most often Logfile = "channel.log" Format = "xchat" ShowMostNicks = "0" ]]> 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 is enabled or user aliases have been defined. See also , , and . 0 (disabled) ShowActiveGenders ShowActiveGenders show stats on which gender talked most Logfile = "channel.log" Format = "xchat" ShowActiveGenders = "0" ]]> Setting this option will make pisg create statistics on which gender (female/male/bot) talked most (see the "sex" option in ). See also . 0 (disabled) ShowSmileys ShowSmileys show most used smileys Logfile = "channel.log" Format = "xchat" ShowSmileys = "0" ]]> With this option, pisg will make a list of the most used smileys in the channel. See also . 0 (disabled) ShowKarma ShowKarma show channel karma Logfile = "channel.log" Format = "xchat" ShowKarma = "0" ]]> With this option, pisg will analyze the channel karma. Users can give other users (or things) good or bad karma by saying "nickname++" or "nickname--"; "nickname==" resets it to zero. Only the last karma is remembered per nick/nick combination, so there is at most +- 1 karma point. See also and . 0 (disabled) ShowMostActiveByHour ShowMostActiveByHour show most active nicks by hour Logfile = "channel.log" Format = "xchat" ShowMostActiveByHour = "0" ]]> By enabling this option, pisg will add a section to the stats showing "Most Active Nicks By Hour" - also look at the and settings. 0 (disabled) ShowOnlyTop ShowOnlyTop only count stats for top talkers, ignore less-active users Logfile = "channel.log" Format = "xchat" ShowOnlyTop = "1" ]]> 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 and options. See also . 0 (disabled) ShowMostActiveByHourGraph ShowMostActiveByHourGraph show graphs in most active nicks by hour Logfile = "channel.log" Format = "xchat" ShowMostActiveByHourGraph = "0" ]]> By enabling this option and the option, pisg will show graphs in the "Most Active Nicks By Hour" section. 1 (enabled) IgnoreWords IgnoreWords ignore specified words ]]> 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. unset NoIgnoredQuotes NoIgnoredQuotes Control random quote output ]]> 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. 0 FoulWords FoulWords specify words considered to be bad/FoulWords language ]]> 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. ass fuck bitch shit scheisse kacke arsch ficker ficken schlampe ViolentWords ViolentWords specify words considered to be aggressive/violent ]]> 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. slaps beats smacks MinQuote MinQuote minimum numbers of letters for a random quote Logfile = "channel.log" Format = "xchat" MinQuote = "10" ]]> The random quotes displayed in the "Most Active Nicks" section will be picked from a length range. With this option you can change the minimum number of letters required for a random quote. Also see the option. Note that pisg will still choose a short quote if it cannot find a longer one. 25 MaxQuote MaxQuote maximum numbers of letters for a random quote Logfile = "channel.log" Format = "xchat" MaxQuote = "70" ]]> The random quotes displayed in the "Most Active Nicks" section will be picked from a length range. With this option you can change the maximum number of letters required for a random quote. Also see the option. 65 WordLength WordLength minimum number of characters in an interesting word Logfile = "channel.log" Format = "xchat" WordLength = "10" ]]> 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. 5 QuoteWidth QuoteWidth maximum allowed length of a "word" with no spaces Logfile = "channel.log" Format = "xchat" QuoteWidth = "48" ]]> 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. 80 BigNumbersThreshold BigNumbersThreshold Minimum number of lines per user for some "Big Numbers" statistics Logfile = "channel.log" Format = "xchat" BigNumbersThreshold = "10" ]]> 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. See also . sqrt ActiveNicks ActiveNicks nicks to show in "Most Active Nicks" Logfile = "channel.log" Format = "mIRC" ActiveNicks = "50" ]]> With this option you can define how many nicks you want to appear in the "Most Active Nicks" section on the stats page. 25 ActiveNicks2 ActiveNicks2 nicks to show in "These didn't make it.." Logfile = "channel.log" Format = "mIRC" ActiveNicks2 = "25" ]]> 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. 30 ActiveNicksByHour ActiveNicksByHour number of nicks to show in "Most Active Nicks By Hour" Logfile = "channel.log" Format = "mIRC" ActiveNicksByHour = "25" ]]> 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. 10 MostNicksHistory MostNicksHistory maximum number of nicks to show in "users with most nicknames" Logfile = "channel.log" Format = "mIRC" MostNicksHistory = "2" ]]> With this option you can define how many nicks you want to appear in the "Users with most nicknames" section. See also and . 5 MostNicksVerbose MostNicksVerbose show nicks used in "most nicks" Logfile = "channel.log" Format = "mIRC" MostNicksVerbose = "0" ]]> By disabling this option you can stop pisg from displaying all the nicks a user has had in the "Most used nicks" section. See also , , and . 1 (enabled) TopicHistory TopicHistory maximum number of topics to show Logfile = "channel.log" Format = "mIRC" TopicHistory = "2" ]]> With this option you can define how many topics you want to appear in the "Latest topics" section. 3 UrlHistory UrlHistory maximum number of URLs to show Logfile = "channel.log" Format = "mIRC" UrlHistory = "2" ]]> With this option you can define how many URLs you want to appear in the "Most referenced URLs" section. See also . 5 ChartsHistory ChartsHistory number of songs to show Logfile = "channel.log" Format = "mIRC" ChartsHistory = "10" ]]> This option sets the number of songs that will be show in the channel music charts. See also and . 5 (the Top Five) ChartsRegexp ChartsRegexp how to recognize songs played Logfile = "channel.log" Format = "mIRC" ChartsRegexp = "(?:is )?(?:np:|(?:now )?playing:? |listening to:? )(?:MPEG stream from)?\s*(.*)" ]]> This option is a perl regexp that is used to recognize songs played. Please tell the pisg mailing list if you have a better default. The regexp MUST contain a single () pair to extract the song name. See also the perlre(1) manpage, and . "(?:np:|(?:now )?playing:? (?:MPEG stream from)?)\s*(.*)" WordHistory WordHistory maximum number of words to show Logfile = "channel.log" Format = "mIRC" WordHistory = "5" ]]> With this option you can define how many words you want to appear in the "Most used words" section. See also . 10 NickHistory NickHistory maximum number of nicks to show in "Most referenced nicks" logfile = "channel.log" format = "mIRC" NickHistory = "3" ]]> With this option you can define how many nicks you want to appear in the "Most referenced nicks" section. See also . 5 SmileyHistory SmileyHistory maximum number of smileys to show in smiley stats logfile = "channel.log" format = "mIRC" SmileyHistory = "3" ]]> At most this many smileys will appear in smiley stats. See also . 10 KarmaHistory KarmaHistory maximum number of nicks to show in "Karma" logfile = "channel.log" format = "mIRC" KarmaHistory = "3" ]]> At most this many nicks will appear in the good and bad karma stats. See also and . 5 NickTracking NickTracking track nick changes and create aliases ]]> Enabling this option will track nick changes as well as it can. It will then automatically create aliases for these nicks. Useful for and other stats. Nick tracking does not work for log formats that do not use the nickname for the person running the logger, but only show "You" there. See . 0 (disabled) NickLimit NickLimit maximum number of nicks in lists ]]> This option trims lists of nicks to a maximum length, replacing the rest with "...". Setting to 0 disables trimming. Affected are the used nicks in the "Users with most nicknames" section, nicks in "Most active genders", and nicks in the "Good/bad karma by" columns. See , , and . 10 SortByWords SortByWords sort "most active nicks" by words logfile = "channel.log" format = "xchat" SortByWords = "0" ]]> The default for the "Most Active Nicks" section - is to sort users by lines. Enabling this will sort it by words instead. 0 (disabled) PicLocation PicLocation path to images on stats page ]]> The location to the pictures used on the stats page - not the user pictures but the different bars in "Most Active Times". Current directory UserPics UserPics number of user pictures per row Logfile = "channel.log" UserPics = "no" ]]> 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. yes (1) ImagePath ImagePath path to user pictures (HTML page) Logfile = "channel.log" Format = "mIRC" ImagePath = "userpics/" ]]> 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. current directory DefaultPic DefaultPic use a default user picture Logfile = "channel.log" Format = "mIRC" DefaultPic = "not_available.jpg" ]]> 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 below. unset ImageGlobPath ImageGlobPath path to user pictures (output generation) Logfile = "channel.log" Format = "mIRC" ImageGlobPath = "users/" ]]> 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 setting. (NB: This setting will be different from if the latter is not relative to the current directory, e.g. if you are writing the HTML file outside of the current directory.) current setting PicWidth PicWidth define a standard width for user pictures Logfile = "channel.log" Format = "mIRC" PicWidth = "500" ]]> PicWidth defines the standard width for user pictures. Setting the 'width' attribute of image-elements on the outputted stats page. See also . unset PicHeight PicHeight define a standard height for user pictures Logfile = "channel.log" Format = "mIRC" PicHeight = "500" ]]> PicHeight defines the standard height for user pictures. Setting the 'height' attribute of image-elements on the outputted stats page. See also . unset Charset Charset character set to use for stats page Logfile = "channel.log" Format = "xchat" Charset = "utf-8" ]]> 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 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. iso-8859-1 LogCharset LogCharset character set for logfiles Logfile = "channel.log" Format = "xchat" Charset = "iso-8859-1" LogCharset = "utf-8" ]]> If LogCharset is set and different from , pisg will convert the charset using Text::Iconv. Using this option slows down log processing. 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" ]]> LogCharsetFallback defines a fallback charset for the conversion. This is useful if you have mixed unicode/iso-8859-* logs. Pisg will first try the conversion from . 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.) empty (no fallback conversion) TimeOffset TimeOffset use a different time zone than the local machine Logfile = "channel.log" Format = "mIRC" Maintainer = "John" TimeOffset = "+5" ]]> 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. +0 RegexpAliases RegexpAliases use regular expressions in user aliases ]]> Enabling this option will make all aliases in <user> lines be parsed as regular expressions; this setting also applies to the , , and settings. 0 (disabled) LangFile LangFile filename of language file ]]> 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. lang.txt CssDir CssDir path to directory with CSS files ]]> CssDir is used to define the paths to the CSS files (the s). Usually you don't need to change this. This setting is only used when statically including the CSS file. layout/ (in current directory) HiCell, HiCell2 HiCell, HiCell2 colors for color gradient in most active nicks section ]]> HiCell and HiCell2 define the colors to be used for the color gradient in the most active nicks section. They should match your . When setting HiCell the empty string (""), pisg will not generate a color gradient; you might want to use this with ="none" or . #BABADD, #CCCCCC LogType LogType type of log (not the format of the log) ]]> The type of logs kept for your channel. Currently only "Logfile" is supported, so you don't need to change this option. Logfile StatsDump StatsDump dump raw statistics into file ]]> This option is intended for debugging pisg, but might be useful to process the parsed logs with another program. The file contains the %stats and %lines hashes in perl's Data::Dumper format. Unset pisg - Perl IRC Statistics Generator Copyright (C) 2001-2012 The pisg project This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA