# 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)

|  | Next
|  | What is pisg?