pisg-doc.html 125 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <title>pisg 1.0a documentation</title>
  7. <style>
  8. :root { --bg:#fff; --fg:#1d2329; --muted:#5b6672; --line:#d9dee3; --code:#f3f5f7; --link:#0b6b3a; }
  9. @media (prefers-color-scheme: dark) {
  10. :root { --bg:#14181c; --fg:#e3e8ec; --muted:#98a4af; --line:#2a3138; --code:#1d2329; --link:#5fd08e; }
  11. }
  12. body { margin:0; background:var(--bg); color:var(--fg);
  13. font:16px/1.6 system-ui,-apple-system,"Segoe UI",Roboto,sans-serif; }
  14. main { max-width:60rem; margin:0 auto; padding:2rem 1rem 4rem; }
  15. a { color:var(--link); }
  16. h1 { margin-bottom:.2rem; } .sub { color:var(--muted); margin-top:0; }
  17. h2 { margin-top:3rem; padding-bottom:.3rem; border-bottom:2px solid var(--line); }
  18. h3 { margin-top:2rem; } h4 { margin:1rem 0 .2rem; color:var(--muted);
  19. text-transform:uppercase; font-size:.8rem; letter-spacing:.06em; }
  20. .purpose { font-weight:400; font-size:.85rem; color:var(--muted); margin-left:.5rem; }
  21. section.option { border-top:1px solid var(--line); padding-top:.5rem; }
  22. pre { background:var(--code); border:1px solid var(--line); border-radius:6px;
  23. padding:.75rem 1rem; overflow-x:auto; font-size:.85rem; }
  24. code { background:var(--code); padding:.1em .3em; border-radius:4px; font-size:.9em; }
  25. nav { border:1px solid var(--line); border-radius:8px; padding:.5rem 1.2rem; margin:1.5rem 0; }
  26. /* example config: code block with copy/download bar */
  27. .codewrap { border:1px solid var(--line); border-radius:8px; overflow:hidden; margin:1rem 0; }
  28. .codebar { display:flex; align-items:center; gap:.5rem; padding:.4rem .75rem; background:var(--code);
  29. border-bottom:1px solid var(--line); font-size:.85rem; color:var(--muted); }
  30. .codebar span { flex:1; font-family:ui-monospace,Menlo,Consolas,monospace; }
  31. .btn { font:inherit; font-size:.8rem; padding:.25rem .7rem; border:1px solid var(--line); border-radius:6px;
  32. background:var(--bg); color:var(--fg); cursor:pointer; text-decoration:none; }
  33. .btn:hover { border-color:var(--link); color:var(--link); }
  34. pre.cfg { margin:0; border:0; border-radius:0; max-height:36rem; overflow:auto; font-size:.8rem; line-height:1.45; }
  35. nav .opts a { display:inline-block; margin:.1rem .6rem .1rem 0; font-size:.85rem; }
  36. </style>
  37. </head>
  38. <body>
  39. <main>
  40. <h1>pisg 1.0a documentation</h1>
  41. <p class="sub">How to install and configure pisg</p>
  42. <nav aria-label="Contents"><ul><li><a href="#what-is-pisg">1. What is pisg?</a><ul><li><a href="#requirements">What are the requirements to run pisg?</a></li></ul></li><li><a href="#setting-up-pisg">2. Setting up pisg for the first time</a><ul><li><a href="#setting-up-a-channel">Setting up a channel</a></li><li><a href="#user-options">Specifying user options</a></li><li><a href="#global-options">Setting global options</a></li><li><a href="#ignoring-links">Ignoring links</a></li><li><a href="#including-config">Including common settings for various channels</a></li><li><a href="#using-css">Changing the layout of your stats page</a></li><li><a href="#running-pisg">Running pisg</a></li><li><a href="#mailing-list-and-bugs">Obtaining help and reporting bugs</a></li></ul></li><li><a href="#reference">3. General pisg options</a><div class="opts"><a href="#Channel">Channel</a> <a href="#Format">Format</a> <a href="#Network">Network</a> <a href="#OutputFile">OutputFile</a> <a href="#OutputTag">OutputTag</a> <a href="#Logfile">Logfile</a> <a href="#LogDir">LogDir</a> <a href="#NFiles">NFiles</a> <a href="#Maintainer">Maintainer</a> <a href="#ColorScheme">ColorScheme</a> <a href="#AltColorScheme">AltColorScheme</a> <a href="#Lang">Lang</a> <a href="#PageHead">PageHead</a> <a href="#PageFoot">PageFoot</a> <a href="#LogPrefix">LogPrefix</a> <a href="#LogSuffix">LogSuffix</a> <a href="#Silent">Silent</a> <a href="#CacheDir">CacheDir</a> <a href="#ChannelIndex">ChannelIndex</a> <a href="#HomeLink">HomeLink</a> <a href="#ShowNavBar">ShowNavBar</a></div></li><li><a href="#reference-stats">4. Options for various statistics features</a><div class="opts"><a href="#DailyActivity">DailyActivity</a> <a href="#ShowActiveTimes">ShowActiveTimes</a> <a href="#ShowActiveNicks">ShowActiveNicks</a> <a href="#ShowBigNumbers">ShowBigNumbers</a> <a href="#ShowTopics">ShowTopics</a> <a href="#ShowLines">ShowLines</a> <a href="#ShowWpl">ShowWpl</a> <a href="#ShowCpl">ShowCpl</a> <a href="#ShowWords">ShowWords</a> <a href="#ShowLastSeen">ShowLastSeen</a> <a href="#ShowTime">ShowTime</a> <a href="#ShowLineTime">ShowLineTime</a> <a href="#ShowWordTime">ShowWordTime</a> <a href="#ShowRandQuote">ShowRandQuote</a> <a href="#ShowLegend">ShowLegend</a> <a href="#ShowKickLine">ShowKickLine</a> <a href="#ShowActionLine">ShowActionLine</a> <a href="#ShowShoutLine">ShowShoutLine</a> <a href="#ShowFoulDecimals">ShowFoulDecimals</a> <a href="#ShowFoulLine">ShowFoulLine</a> <a href="#ShowViolentLines">ShowViolentLines</a> <a href="#ShowMuw">ShowMuw</a> <a href="#ShowMrn">ShowMrn</a> <a href="#ShowMru">ShowMru</a> <a href="#ShowCharts">ShowCharts</a> <a href="#ShowOps">ShowOps</a> <a href="#ShowVoices">ShowVoices</a> <a href="#ShowHalfops">ShowHalfops</a> <a href="#ShowMostNicks">ShowMostNicks</a> <a href="#ShowActiveGenders">ShowActiveGenders</a> <a href="#ShowSmileys">ShowSmileys</a> <a href="#ShowKarma">ShowKarma</a> <a href="#ShowMostActiveByHour">ShowMostActiveByHour</a> <a href="#ShowOnlyTop">ShowOnlyTop</a> <a href="#ShowMostActiveByHourGraph">ShowMostActiveByHourGraph</a> <a href="#ShowOverview">ShowOverview</a> <a href="#ShowRelations">ShowRelations</a> <a href="#RelationNicks">RelationNicks</a> <a href="#RelationMinWeight">RelationMinWeight</a> <a href="#ShowTimePersonalities">ShowTimePersonalities</a> <a href="#ShowConcentration">ShowConcentration</a> <a href="#ShowSignatureWords">ShowSignatureWords</a> <a href="#IgnoreWords">IgnoreWords</a> <a href="#NoIgnoredQuotes">NoIgnoredQuotes</a> <a href="#FoulWords">FoulWords</a> <a href="#ViolentWords">ViolentWords</a> <a href="#BadUrls">BadUrls</a> <a href="#MinQuote">MinQuote</a> <a href="#MaxQuote">MaxQuote</a> <a href="#WordLength">WordLength</a> <a href="#QuoteWidth">QuoteWidth</a> <a href="#BigNumbersThreshold">BigNumbersThreshold</a> <a href="#ActiveNicks">ActiveNicks</a> <a href="#ActiveNicks2">ActiveNicks2</a> <a href="#ActiveNicksByHour">ActiveNicksByHour</a> <a href="#MostNicksHistory">MostNicksHistory</a> <a href="#MostNicksVerbose">MostNicksVerbose</a> <a href="#TopicHistory">TopicHistory</a> <a href="#UrlHistory">UrlHistory</a> <a href="#ChartsHistory">ChartsHistory</a> <a href="#ChartsRegexp">ChartsRegexp</a> <a href="#WordHistory">WordHistory</a> <a href="#NickHistory">NickHistory</a> <a href="#SmileyHistory">SmileyHistory</a> <a href="#KarmaHistory">KarmaHistory</a> <a href="#NickTracking">NickTracking</a> <a href="#NickLimit">NickLimit</a> <a href="#SortByWords">SortByWords</a></div></li><li><a href="#reference-pictures">5. Picture options</a><ul><li><a href="#PicLocation">PicLocation</a></li><li><a href="#UserPics">UserPics</a></li><li><a href="#ImagePath">ImagePath</a></li><li><a href="#DefaultPic">DefaultPic</a></li><li><a href="#ImageGlobPath">ImageGlobPath</a></li><li><a href="#PicWidth">PicWidth</a></li><li><a href="#PicHeight">PicHeight</a></li></ul></li><li><a href="#reference-misc">6. Misc options</a><ul><li><a href="#Charset">Charset</a></li><li><a href="#LogCharset">LogCharset</a></li><li><a href="#LogCharsetFallback">LogCharsetFallback</a></li><li><a href="#TimeOffset">TimeOffset</a></li><li><a href="#RegexpAliases">RegexpAliases</a></li><li><a href="#LangFile">LangFile</a></li><li><a href="#CssDir">CssDir</a></li><li><a href="#HiCell">HiCell, HiCell2</a></li><li><a href="#LogType">LogType</a></li><li><a href="#StatsDump">StatsDump</a></li></ul></li><li><a href="#copyright">7. Copyright and License</a></li><li><a href="#example-config">8. Complete example configuration</a></li></ul></nav>
  43. <section class="chapter" id="what-is-pisg"><h2>1. What is pisg?</h2>
  44. <p>pisg is an IRC statistics generator. It takes IRC logfiles and turns
  45. them into nice looking stats.</p>
  46. <p>In general, you would do something like this to get it running:
  47. <ul>
  48. <li><p>Enable logging in an IRC bot, or in your IRC client. The log will be
  49. outputted into a file.</p>
  50. </li>
  51. <li><p>You set up pisg, you define the channel name, and the path to the
  52. logfile you created.</p>
  53. </li>
  54. <li><p>You run pisg, pisg runs the log through and create statistics, it
  55. then creates an HTML page which you can upload to a webserver.</p>
  56. </li>
  57. </ul></p>
  58. <section id="requirements"><h3>What are the requirements to run pisg?</h3>
  59. <p><ul>
  60. <li><p>An IRC client or bot where pisg supports the output logfile.</p>
  61. </li>
  62. <li><p>Any operating system which Perl runs on, this includes popular OSes
  63. such as Linux, FreeBSD, Windows and Mac. You will have a hard time
  64. finding an OS where Perl isn&#x27;t supported. For Windows this means
  65. that you need to download <a href="http://activestate.com/Products/ActivePerl/">ActivePerl</a>.</p>
  66. </li>
  67. <li><p><em>Optional</em> - a system to host the statistics page
  68. 24 hours a day, 7 days a week.</p>
  69. </li>
  70. <li><p><em>Optional</em> - a system to log the channel, 24 hours
  71. a day, 7 days a week.</p>
  72. </li>
  73. </ul></p>
  74. </section>
  75. </section>
  76. <section class="chapter" id="setting-up-pisg"><h2>2. Setting up pisg for the first time</h2>
  77. <p>Most configuration happens through the <code>pisg.cfg</code>
  78. file, the file format is made to be easy to read, and easy to extend for
  79. further use. It uses an XML-like format, with elements and attributes.</p>
  80. <section id="setting-up-a-channel"><h3>Setting up a channel</h3>
  81. <p>An element called <a href="#Channel">Channel</a> is made for defining
  82. channels, a quick example of a channel is here:
  83. <pre>&lt;channel=&quot;#channel&quot;&gt;
  84. Logfile = &quot;channel.log&quot;
  85. Format = &quot;mIRC&quot;
  86. Maintainer = &quot;John&quot;
  87. OutputFile = &quot;mychan.html&quot;
  88. &lt;/channel&gt;</pre>
  89. The above will define a <a href="#Channel">Channel</a> called <code>#channel</code>, the
  90. logfile pisg will look for is called <code>channel.log</code> and
  91. the <a href="#Format">Format</a> of the logfile will be <code>mIRC</code>. The
  92. <a href="#Maintainer">Maintainer</a> (which will be stated on the output page) is
  93. <code>John</code>.</p>
  94. <p>That is basically it! Now, there are a lot more options that you can use
  95. for your channels, for this please refer to the reference documentation.</p>
  96. <p>Also be-aware of the fact that pisg uses various images to show the
  97. time-related bars. These images are placed in the
  98. <code>gfx/</code> folder and should be placed into the same
  99. directory as your outputted HTML file.</p>
  100. </section>
  101. <section id="user-options"><h3>Specifying user options</h3>
  102. <p>User options are set with a simple XML-like syntax in the form:
  103. <pre>&lt;user nick=&quot;NICK&quot; option=&quot;VALUE&quot;&gt;</pre>
  104. Remember, the nick is always required.
  105. For example to add aliases to a nick, then you could do this:
  106. <pre>&lt;user nick=&quot;Joe&quot; alias=&quot;Joe^*&quot;&gt;</pre>
  107. The asterisk (*) means that it will match all nicks starting with &#x27;Joe^&#x27;. So
  108. it will add all Joe^&#x27;s to &#x27;Joe&#x27; in the stats.
  109. Another thing you can do is to add a picture to a user:
  110. <pre>&lt;user nick=&quot;Ben&quot; pic=&quot;ben_holiday.jpg&quot;&gt;</pre>
  111. If you have a larger picture of the user as well, you can make the picture
  112. on the stats page link to it:
  113. <pre>&lt;user nick=&quot;Ben&quot; pic=&quot;ben_holiday.jpg&quot; bigpic=&quot;ben-big.jpg&quot;&gt;</pre>
  114. You can include * or ? to enable filename globbing to randomly choose one
  115. from several pictures: (see documentation for the
  116. <a href="#ImageGlobPath">ImageGlobPath</a> option)
  117. <pre>&lt;user nick=&quot;Ben&quot; pic=&quot;ben_*.jpg&quot;&gt;</pre>
  118. You can also set a user&#x27;s sex.
  119. The sex setting can be &quot;f&quot;emale, &quot;m&quot;ale, or &quot;b&quot;ot:
  120. <pre>&lt;user nick=&quot;Ben&quot; sex=&quot;m&quot;&gt;</pre>
  121. Also you can add links to URLs and e-mails:
  122. <pre>&lt;user nick=&quot;Christine&quot; link=&quot;http://www.christine.com&quot;&gt;</pre>
  123. or
  124. <pre>&lt;user nick=&quot;Chris&quot; link=&quot;chris@host.com&quot;&gt;</pre>
  125. The last thing you can do is to ignore nicks (for example bots):
  126. <pre>&lt;user nick=&quot;nameofbot&quot; ignore=&quot;y&quot;&gt;</pre>
  127. You don&#x27;t have to do all this in many lines, you could just as easily do:
  128. <pre>&lt;user nick=&quot;Joe&quot; alias=&quot;Joe^away Joe^work&quot; pic=&quot;joe.jpg&quot; link=&quot;joe@joe.com&quot; sex=&quot;m&quot;&gt;</pre>
  129. (Here the aliases are a space separated list of nicks, that also works! But *
  130. as a wildcard is smarter, although it is slower).</p>
  131. </section>
  132. <section id="global-options"><h3>Setting global options</h3>
  133. <p>Many times, it will be useful to set up global options, global options
  134. are set like this:
  135. <pre>&lt;set option=&quot;VALUE&quot;&gt;</pre>
  136. Any global option will be overriden by anything defined within channel
  137. elements (see <a href="#setting-up-a-channel">Setting up a channel</a>)</p>
  138. <p>For example, to change the background color of the stats page, you
  139. could do:
  140. <pre>&lt;set bgcolor=&quot;black&quot;&gt;</pre>
  141. You can set many options in a single <code>set</code>:
  142. <pre>&lt;set lang=&quot;DE&quot; timeoffset=&quot;+1&quot;&gt;</pre>
  143. The above will set the language on the statistics page to DE (Deutsch,
  144. German) and set the time offset to +1.
  145. All options available are mentioned in the reference documentation.</p>
  146. </section>
  147. <section id="ignoring-links"><h3>Ignoring links</h3>
  148. <p>It&#x27;s possible to ignore links in the &quot;Most referenced URLs&quot; section:
  149. <pre>&lt;link url=&quot;http://www.slashdot.org&quot; ignore=&quot;y&quot;&gt;</pre></p>
  150. </section>
  151. <section id="including-config"><h3>Including common settings for various channels</h3>
  152. <p>If you have, for example, more than one channel, where the users are the
  153. same, or you don&#x27;t want to maintain more than one user file, you can use
  154. the &quot;include&quot; setting in the main config file:
  155. <pre>&lt;include=&quot;/home/vetinari/pisg/users.cfg&quot;&gt;</pre>
  156. This will include the file /home/vetinari/pisg/users.cfg in the config
  157. at the place where the include statement is set.</p>
  158. <p>Note, that you can NOT include a file from an included file!</p>
  159. </section>
  160. <section id="using-css"><h3>Changing the layout of your stats page</h3>
  161. <p>The standard layout and colors in the outputted HTML page are made to be
  162. somewhat clean and neutral. But you have the chance to change the layout
  163. yourself.</p>
  164. <p>There are a few predefined color schemes for you to use, use the
  165. <a href="#ColorScheme">ColorScheme</a> option when using them. The
  166. colorschemes distributed with pisg are: default (which is the default),
  167. darkgalaxy, darkred, justgrey, ocean, orange_grey, pisg, softgreen.</p>
  168. <p>When changing it, you need a fair knowledge of CSS (Cascading Style
  169. Sheets). CSS is what most of the web uses today to define styles and
  170. layout on HTML pages.
  171. With the pisg distribution, look in the <code>layout</code>
  172. directory. In it resides <code>default.css</code> which is the
  173. file being included onto the HTML page. Open it in a text editor like
  174. vi or notepad. Then change it until you&#x27;re happy with it. Be aware that
  175. you might want to look at the <a href="#HiCell">HiCell and HiCell2</a>
  176. options through pisg.cfg for changing the last two colors.</p>
  177. <p>If you have created a nice stylesheet which others can take advantage of,
  178. open a pull request at <a href="https://github.com/PISG/pisg">https://github.com/PISG/pisg</a>
  179. so that it can be distributed with the next version of pisg. The theme
  180. creator at <a href="https://pisg.github.io/themes/">https://pisg.github.io/themes/</a>
  181. builds a stylesheet from a palette and previews it on a full stats page.</p>
  182. <p>If you want to embed the statistics into another page, use the &quot;none&quot; color scheme.
  183. Pisg will then omit the HTML header and write only the body part.</p>
  184. </section>
  185. <section id="running-pisg"><h3>Running pisg</h3>
  186. <p>When everything is set up in the pisg configuration file (pisg.cfg),
  187. then you simply run pisg on the command-line.</p>
  188. <p>Using Linux, BSD or another UNIX-like system:
  189. <pre>user@host:~/pisg$ ./pisg</pre></p>
  190. <p>Using Windows:
  191. <pre>c:\pisg&gt; perl pisg</pre></p>
  192. <p>The program will run and parse the logfiles you specified in the
  193. configuration file.</p>
  194. <p>If you are using Linux, BSD or another UNIX-like system and want run
  195. pisg automatically several times a day, then see the
  196. <code>crontab</code> file in the <code>scripts/</code>
  197. directory.</p>
  198. <p>For Windows, see the <code>windows-upload-ftp.txt</code> file
  199. with the pisg distribution, this file is also placed in the
  200. <code>scripts/</code> directory.</p>
  201. </section>
  202. <section id="mailing-list-and-bugs"><h3>Obtaining help and reporting bugs</h3>
  203. <p>If your problem could not be resolved through here, ask in #pisg on
  204. Undernet (irc.undernet.org). That is where the people who work on pisg are.</p>
  205. <p>If you believe that you have found a bug, open an issue at
  206. <a href="https://github.com/PISG/pisg/issues">https://github.com/PISG/pisg/issues</a>.
  207. Say which pisg version you run and which log format, and paste the error.
  208. The old SourceForge mailing list and tracker are read-only history.</p>
  209. </section>
  210. </section>
  211. <section class="chapter" id="reference"><h2>3. General pisg options</h2>
  212. <section class="option" id="Channel"><h3>Channel <span class="purpose">define channel name</span></h3>
  213. <pre>&lt;channel=&quot;#channel&quot;&gt;
  214. Logfile = &quot;channel.log&quot;
  215. Format = &quot;mIRC&quot;
  216. Maintainer = &quot;John&quot;
  217. &lt;/channel&gt;</pre>
  218. <h4>Description</h4>
  219. <p><code>Channel</code> is used in two contexts, globally when using
  220. &lt;set&gt; and when defining new channels. It sets the name of the
  221. channel.</p>
  222. <h4>Default</h4>
  223. <p>Unset</p>
  224. </section>
  225. <section class="option" id="Format"><h3>Format <span class="purpose">the logfile format</span></h3>
  226. <pre>&lt;channel=&quot;#channel&quot;&gt;
  227. Logfile = &quot;channel.log&quot;
  228. Format = &quot;eggdrop&quot;
  229. Maintainer = &quot;John&quot;
  230. &lt;/channel&gt;
  231. &lt;set Format=&quot;mIRC&quot;&gt;</pre>
  232. <h4>Description</h4>
  233. <p><code>Format</code> is used to define the format of the logfile,
  234. pisg supports a various number of different logfiles, see the FORMATS
  235. file included with the pisg distribution. If your logfiles have the
  236. suffix .gz or .bz2, they will automatically be decompressed and read by
  237. pisg.
  238. See also <a href="#Maintainer">Maintainer</a>.</p>
  239. <h4>Default</h4>
  240. <p>Unset</p>
  241. </section>
  242. <section class="option" id="Network"><h3>Network <span class="purpose">the IRC network of the channel</span></h3>
  243. <pre>&lt;channel=&quot;#channel&quot;&gt;
  244. Logfile = &quot;channel.log&quot;
  245. Format = &quot;eggdrop&quot;
  246. Network = &quot;Undernet&quot;
  247. &lt;/channel&gt;
  248. &lt;set Network=&quot;Quakenet&quot;&gt;</pre>
  249. <h4>Description</h4>
  250. <p><code>Network</code> is used to set the network which the channel
  251. resides on, this name is displayed on the stats page.</p>
  252. <h4>Default</h4>
  253. <p>SomeIRCNetwork</p>
  254. </section>
  255. <section class="option" id="OutputFile"><h3>OutputFile <span class="purpose">name of the generated HTML page</span></h3>
  256. <pre>&lt;channel=&quot;#channel&quot;&gt;
  257. Logfile = &quot;channel.log&quot;
  258. Format = &quot;eggdrop&quot;
  259. OutputFile = &quot;mychan.html&quot;
  260. &lt;/channel&gt;
  261. &lt;set OutputFile=&quot;mychan.html&quot;&gt;</pre>
  262. <h4>Description</h4>
  263. <p><code>OutputFile</code> is used to define the name of the
  264. generated statistics page.</p>
  265. <h4>Default</h4>
  266. <p>index.html</p>
  267. </section>
  268. <section class="option" id="OutputTag"><h3>OutputTag <span class="purpose">tag to insert into OutputFile</span></h3>
  269. <pre>&lt;channel=&quot;#channel&quot;&gt;
  270. LogDir = &quot;logs/&quot;
  271. Format = &quot;eggdrop&quot;
  272. OutputFile = &quot;mychan%t.html&quot;
  273. OutputTag = &quot;-week&quot;
  274. &lt;/channel&gt;
  275. &lt;set OutputTag=&quot;-week&quot;&gt;</pre>
  276. <h4>Description</h4>
  277. <p><code>OutputTag</code> specifies a string that will replace
  278. occurrences of &quot;%t&quot; in <a href="#OutputFile">OutputFile</a>. This option is most
  279. useful when used as a command line switch (-t) to pisg in conjunction with
  280. <a href="#NFiles">NFiles</a> (-nf). Example:
  281. <pre>$ pisg -co pisg.conf
  282. $ pisg -co pisg.conf -nf 8 -t -week</pre>
  283. Leaving out the <code>OutputTag</code> settings from the above
  284. pisg.conf snippet, this writes both the full statistics (mychan.html) and
  285. statistics for the last week (mychan-week.html) using the same pisg config
  286. file. (Assuming that there are separate logfiles for each day.)</p>
  287. <h4>Default</h4>
  288. <p>unset</p>
  289. </section>
  290. <section class="option" id="Logfile"><h3>Logfile <span class="purpose">name of logfile to parse</span></h3>
  291. <pre>&lt;channel=&quot;#channel&quot;&gt;
  292. Logfile=&quot;/home/foo/eggdrop/logs/mylog.txt&quot;
  293. Format = &quot;eggdrop&quot;
  294. &lt;/channel&gt;
  295. &lt;set Logfile=&quot;foo.log&quot;&gt;</pre>
  296. <h4>Description</h4>
  297. <p>This defines the filename of the logfile to parse for the channel. If
  298. you want to parse a directory full of logfiles, you should use the
  299. <a href="#LogDir">LogDir</a> option instead. Providing this option multiple
  300. times will parse multiple files in the order the statements appear.
  301. Wildcards (* ? []) will be expanded.
  302. See also <a href="#LogDir">LogDir</a> and <a href="#NFiles">NFiles</a>.</p>
  303. <h4>Default</h4>
  304. <p>unset</p>
  305. </section>
  306. <section class="option" id="LogDir"><h3>LogDir <span class="purpose">parse a directory full of logs</span></h3>
  307. <pre>&lt;channel=&quot;#channel&quot;&gt;
  308. LogDir=&quot;/home/foo/eggdrop/logs/&quot;
  309. Format = &quot;eggdrop&quot;
  310. &lt;/channel&gt;
  311. &lt;set LogDir=&quot;dailylogs/&quot;&gt;</pre>
  312. <h4>Description</h4>
  313. <p>When <code>LogDir</code> is defined to valid path to a directory,
  314. then pisg will run through that directory, parse all logfiles in it and
  315. create one HTML page from it. Useful with for example eggdrop logs. Providing
  316. this option multiple times will parse all the files in multiple
  317. directories in the order the statements appear.
  318. See also <a href="#NFiles">NFiles</a>, <a href="#LogPrefix">LogPrefix</a>, and
  319. <a href="#LogSuffix">LogSuffix</a>.</p>
  320. <h4>Default</h4>
  321. <p>unset</p>
  322. </section>
  323. <section class="option" id="NFiles"><h3>NFiles <span class="purpose">parse only the last files in</span></h3>
  324. <pre>&lt;channel=&quot;#channel&quot;&gt;
  325. LogDir=&quot;/home/foo/eggdrop/logs/&quot;
  326. NFiles=&quot;8&quot;
  327. Format=&quot;eggdrop&quot;
  328. &lt;/channel&gt;
  329. &lt;set NFiles=&quot;8&quot;&gt;</pre>
  330. <h4>Description</h4>
  331. <p>When <code>NFiles</code> is set to a positive integer, pisg will
  332. process only the last that much logfiles from <a href="#Logfile">Logfile</a>
  333. and <a href="#LogDir">LogDir</a> options. Useful to create statistics that
  334. cover the last week or month (assuming there are separate logfile per
  335. day/week/etc.).</p>
  336. <h4>Default</h4>
  337. <p>0 (process all files)</p>
  338. </section>
  339. <section class="option" id="Maintainer"><h3>Maintainer <span class="purpose">name of the maintainer</span></h3>
  340. <pre>&lt;channel=&quot;#channel&quot;&gt;
  341. Logfile = &quot;channel.log&quot;
  342. Format = &quot;mIRC&quot;
  343. Maintainer = &quot;Benny&quot;
  344. &lt;/channel&gt;
  345. &lt;set Maintainer=&quot;Benny&quot;&gt;</pre>
  346. <h4>Description</h4>
  347. <p><code>Maintainer</code> is used to define the name of the
  348. maintainer of the statistics page, this can be either the person
  349. generating the stats or the bot/client doing the logging.
  350. The maintainer is displayed in the outputted stats page.
  351. This setting is also used by some log parsers where &quot;You&quot; is used
  352. instead of the nick in the log (e.g. &quot;You have been kicked&quot;).
  353. See also <a href="#Format">Format</a>, <a href="#NickTracking">NickTracking</a>.</p>
  354. <h4>Default</h4>
  355. <p>MAINTAINER</p>
  356. </section>
  357. <section class="option" id="ColorScheme"><h3>ColorScheme <span class="purpose">use a different color scheme for stats page</span></h3>
  358. <pre>&lt;channel=&quot;#channel&quot;&gt;
  359. Logfile = &quot;channel.log&quot;
  360. ColorScheme = &quot;darkgalaxy&quot;
  361. Maintainer = &quot;John&quot;
  362. &lt;/channel&gt;
  363. &lt;set ColorScheme=&quot;default&quot;&gt;</pre>
  364. <h4>Description</h4>
  365. <p><code>ColorScheme</code> is used to define the color scheme used
  366. for the statistics page. Actually it&#x27;s the CSS file being included.
  367. CSS files distributed with pisg are: darkgalaxy, darkred, default,
  368. justgrey, ocean, orange_grey, pisg, softgreen (omit the .css). The file
  369. will be included statically in the generated HTML page. If you give a file
  370. name or URL (i.e. a color scheme name with .css or a path), the file will
  371. be linked to instead. Using &quot;none&quot; will cause pisg to write only the body
  372. of the page; use this to include the statistics into a custom page. See
  373. also <a href="#CssDir">CssDir</a>, <a href="#AltColorScheme">AltColorScheme</a>,
  374. <a href="#HiCell">HiCell/HiCell2</a>.</p>
  375. <h4>Default</h4>
  376. <p>default</p>
  377. </section>
  378. <section class="option" id="AltColorScheme"><h3>AltColorScheme <span class="purpose">alternate stylesheets for stats page</span></h3>
  379. <pre>&lt;channel=&quot;#channel&quot;&gt;
  380. Logfile = &quot;channel.log&quot;
  381. ColorScheme = &quot;darkgalaxy&quot;
  382. AltColorScheme = &quot;layout/ocean.css&quot;
  383. Maintainer = &quot;John&quot;
  384. &lt;/channel&gt;
  385. &lt;set AltColorScheme=&quot;layout/darkgalaxy.css layout/justgrey.css&quot;&gt;</pre>
  386. <h4>Description</h4>
  387. <p><code>AltColorScheme</code> defines an alternate CSS file to
  388. be used for the statistics page. Multiple files can be given (space
  389. separated.) Note that this is not supported by all browsers.
  390. See also <a href="#ColorScheme">ColorScheme</a> and <a href="#CssDir">CssDir</a>.</p>
  391. <h4>Default</h4>
  392. <p>default</p>
  393. </section>
  394. <section class="option" id="Lang"><h3>Lang <span class="purpose">define the language / translation to use</span></h3>
  395. <pre>&lt;channel=&quot;#channel&quot;&gt;
  396. Logfile = &quot;channel.log&quot;
  397. Format = &quot;mIRC&quot;
  398. Lang = &quot;DE&quot;
  399. OutputFile = &quot;mychan-%l.html&quot;
  400. &lt;/channel&gt;
  401. &lt;set Lang=&quot;FR,SE&quot;&gt;</pre>
  402. <h4>Description</h4>
  403. <p><code>Lang</code> defines the language to use for the stats.
  404. Currently, lang.txt includes:
  405. EN (English),
  406. BG (Bulgarian),
  407. CA (Catalan),
  408. CZ (Czech),
  409. DA (Danish),
  410. DE (German),
  411. EE (Estonian),
  412. ES (Spanish),
  413. FI (Finnish),
  414. FR (French),
  415. GR (Greek),
  416. HE (Hebrew),
  417. HU (Hungarian),
  418. IS (Icelandic),
  419. IT (Italian),
  420. NL (Dutch),
  421. NL_BE (Flemish),
  422. NO (Norwegian),
  423. PL (Polish),
  424. PT (Portuguese),
  425. PT_BR (Portuguese/Brazil),
  426. RO (Romanian),
  427. RU (Russian),
  428. SE (Swedish),
  429. SI (Slovenian),
  430. SK (Slovak),
  431. SQ (Albanian),
  432. TR (Turkish),
  433. YU (Serbian).
  434. Output in several languages can be generated at the same time, separate the
  435. languages by comma. The tag %l in the output file name will be replaced by
  436. the language name. See also <a href="#LangFile">LangFile</a>.</p>
  437. <h4>Default</h4>
  438. <p>EN (English)</p>
  439. </section>
  440. <section class="option" id="PageHead"><h3>PageHead <span class="purpose">define a file as page header</span></h3>
  441. <pre>&lt;channel=&quot;#channel&quot;&gt;
  442. Logfile = &quot;channel.log&quot;
  443. Format = &quot;mIRC&quot;
  444. OutputFile = &quot;stats.html&quot;
  445. PageHead = &quot;myheader.txt&quot;
  446. &lt;/channel&gt;
  447. &lt;set PageHead=&quot;someheader.txt&quot;&gt;</pre>
  448. <h4>Description</h4>
  449. <p><code>PageHead</code> is used to include a file in the stats page,
  450. for example an introduction text, a link to an image or a banner. The
  451. file can hold anything, it will be included raw in the stats page -
  452. so HTML should be preferred. The file will be included in the top of
  453. the page. This option is the opposite of <a href="#PageFoot">PageFoot</a>.</p>
  454. <h4>Default</h4>
  455. <p>none</p>
  456. </section>
  457. <section class="option" id="PageFoot"><h3>PageFoot <span class="purpose">define a file as page footer</span></h3>
  458. <pre>&lt;channel=&quot;#channel&quot;&gt;
  459. Logfile = &quot;channel.log&quot;
  460. Format = &quot;mIRC&quot;
  461. outputfile = &quot;stats.html&quot;
  462. PageFoot = &quot;myfooter.txt&quot;
  463. &lt;/channel&gt;
  464. &lt;set PageFoot=&quot;somefooter.txt&quot;&gt;</pre>
  465. <h4>Description</h4>
  466. <p><code>PageFoot</code> is used to include a file in the stats page,
  467. for example an introduction text, a link to an image or a banner. The
  468. file can hold anything, it will be included raw in the stats page -
  469. so HTML should be preferred. The file will be included in the bottom of
  470. the page. This option is the opposite of <a href="#PageHead">PageHead</a>.</p>
  471. <h4>Default</h4>
  472. <p>none</p>
  473. </section>
  474. <section class="option" id="LogPrefix"><h3>LogPrefix <span class="purpose">only parse logs LogPrefixed with a user defined string</span></h3>
  475. <pre>&lt;channel=&quot;#channel&quot;&gt;
  476. LogDir=&quot;/home/foo/eggdrop/logs/&quot;
  477. Format = &quot;eggdrop&quot;
  478. LogPrefix = &quot;logjun&quot;
  479. &lt;/channel&gt;
  480. &lt;set LogPrefix=&quot;logjanuary&quot;&gt;</pre>
  481. <h4>Description</h4>
  482. <p>When using the <a href="#LogDir">LogDir</a> option and you only want to use
  483. a slew of the files in it, you can have pisg choose only files which are
  484. prefixed with a special string.</p>
  485. <h4>Default</h4>
  486. <p>unset</p>
  487. </section>
  488. <section class="option" id="LogSuffix"><h3>LogSuffix <span class="purpose">Regexp to sort logfiles by format month||day||year</span></h3>
  489. <pre>&lt;set LogSuffix=&quot;\.\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)&quot;&gt;</pre>
  490. <h4>Description</h4>
  491. <p><code>LogSuffix</code> is used to define the suffix of a logfile,
  492. it only works when <a href="#LogDir">LogDir</a> is defined. The example in
  493. the synopsis is for the eggdrop bots default format.</p>
  494. <h4>Default</h4>
  495. <p>Unset</p>
  496. </section>
  497. <section class="option" id="Silent"><h3>Silent <span class="purpose">make pisg silent, suppress messages</span></h3>
  498. <pre>&lt;set Silent=&quot;1&quot;&gt;</pre>
  499. <h4>Description</h4>
  500. <p>This option is useful mainly from command line when invoking pisg with
  501. <code>--silent 1</code>. But it can also used in the configuration
  502. file. It will suppress all standard output from pisg. Error messages
  503. will still be sent.</p>
  504. <h4>Default</h4>
  505. <p>0 (disabled)</p>
  506. </section>
  507. <section class="option" id="CacheDir"><h3>CacheDir <span class="purpose">use a cache to speed up log parsing</span></h3>
  508. <pre>&lt;set CacheDir=&quot;pisg_cache&quot;&gt;
  509. &lt;set CacheDir=&quot;/path/to/pisg_cache&quot;&gt;</pre>
  510. <h4>Description</h4>
  511. <p>Setting this option makes pisg dump the results of log parsing into cache
  512. files. The next time pisg is run, it compares the timestamp of the log(s)
  513. with the timestamp stored in the cache file. When the log was not changed,
  514. the cached data is used. (This means that it does not work if you only
  515. have a single big logfile. Split the log at arbitrary points and use
  516. <a href="#LogDir">LogDir</a> or <a href="#Logfile">Logfile</a>=&quot;dir/*&quot;.)</p>
  517. <p>Note that the cache files should be deleted when the pisg config file is
  518. changed since the cache data uses the old config settings.
  519. <a href="#NickTracking">NickTracking</a> does not work especially well with the
  520. cache when using different <a href="#NFiles">NFiles</a> settings.</p>
  521. <h4>Default</h4>
  522. <p>Unset</p>
  523. </section>
  524. <section class="option" id="ChannelIndex"><h3>ChannelIndex <span class="purpose">name of the channel list file for a landing page</span></h3>
  525. <pre>&lt;set ChannelIndex=&quot;channels.json&quot;&gt;</pre>
  526. <h4>Description</h4>
  527. <p>Each time pisg writes a channel page, it also updates a small JSON file, next to
  528. that page, listing the channels found in the same directory: the channel name as
  529. written in the <a href="#Channel">Channel</a> setting, the page file name, the network, when
  530. it was updated, and the number of days, nicks and lines. A landing page can read this
  531. file to offer a drop-down list of channels (see <code>site/index.html</code>), so
  532. nothing has to scan or scrape the HTML pages. Each run only changes the entry of its
  533. own channel, and entries whose page no longer exists are removed. Set it to &quot;none&quot;
  534. to switch this off.</p>
  535. <h4>Default</h4>
  536. <p>channels.json</p>
  537. </section>
  538. <section class="option" id="HomeLink"><h3>HomeLink <span class="purpose">adds a button at the top of every stats page that leads back to your landing page</span></h3>
  539. <pre>&lt;set HomeLink=&quot;index.html&quot;&gt;</pre>
  540. <h4>Description</h4>
  541. <p>Shows an &quot;All channels&quot; button above the title of each stats page (translated with the
  542. page language). Give the page it should lead to: a file name next to the stats page, such as
  543. <code>index.html</code> (the landing page in <code>site/</code>), or a full
  544. http(s) address. Leave it empty, or &quot;none&quot;, for no button. Only the newer colour schemes
  545. draw it as a button; a scheme set to &quot;none&quot; does not show it.</p>
  546. <h4>Default</h4>
  547. <p>empty (no button)</p>
  548. </section>
  549. <section class="option" id="ShowNavBar"><h3>ShowNavBar <span class="purpose">enable/disable the section bar at the top of the page</span></h3>
  550. <pre>&lt;set ShowNavBar=&quot;1&quot;&gt;</pre>
  551. <h4>Description</h4>
  552. <p>Adds a slim bar at the top of the stats page that stays in view while scrolling. It shows which
  553. section is being read, and a &quot;Sections&quot; button opens a list of every section, laid out in columns so
  554. nothing has to be scrolled sideways, whatever the number of sections or the language. It also works
  555. without JavaScript. The bar is left out when <a href="#ColorScheme">ColorScheme</a> is &quot;none&quot;,
  556. since the page is then meant to be embedded in another one.</p>
  557. <h4>Default</h4>
  558. <p>1 (enabled)</p>
  559. </section>
  560. </section>
  561. <section class="chapter" id="reference-stats"><h2>4. Options for various statistics features</h2>
  562. <section class="option" id="DailyActivity"><h3>DailyActivity <span class="purpose">number of days to show in &quot;Daily Actitity&quot;</span></h3>
  563. <pre>&lt;channel=&quot;#channel&quot;&gt;
  564. Logfile = &quot;channel.log&quot;
  565. Format = &quot;xchat&quot;
  566. DailyActivity = &quot;0&quot;
  567. &lt;/channel&gt;
  568. &lt;set DailyActivity=&quot;31&quot;&gt;</pre>
  569. <h4>Description</h4>
  570. <p>This option sets the number of days to show in the &quot;Daily activity&quot;
  571. section. Pisg will generate a graph that shows the actitivy during
  572. this timeframe. Setting the option to 0 disables the section.</p>
  573. <h4>Default</h4>
  574. <p>0 (disabled)</p>
  575. </section>
  576. <section class="option" id="ShowActiveTimes"><h3>ShowActiveTimes <span class="purpose">enable/disable &quot;Most Active Times&quot;</span></h3>
  577. <pre>&lt;channel=&quot;#channel&quot;&gt;
  578. Logfile = &quot;channel.log&quot;
  579. Format = &quot;xchat&quot;
  580. ShowActiveTimes = &quot;0&quot;
  581. &lt;/channel&gt;
  582. &lt;set ShowActiveTimes=&quot;1&quot;&gt;</pre>
  583. <h4>Description</h4>
  584. <p>With this option you can disable the &quot;Most Active Times&quot; section on the
  585. stats page. It will simply disappear when specifying 0.</p>
  586. <h4>Default</h4>
  587. <p>1 (enabled)</p>
  588. </section>
  589. <section class="option" id="ShowActiveNicks"><h3>ShowActiveNicks <span class="purpose">enable/disable &quot;Most Active Nicks&quot;</span></h3>
  590. <pre>&lt;channel=&quot;#channel&quot;&gt;
  591. Logfile = &quot;channel.log&quot;
  592. Format = &quot;xchat&quot;
  593. ShowActiveNicks = &quot;0&quot;
  594. &lt;/channel&gt;
  595. &lt;set ShowActiveNicks=&quot;1&quot;&gt;</pre>
  596. <h4>Description</h4>
  597. <p>With this option you can disable the &quot;Most Active Nicks&quot; section on the
  598. stats page.</p>
  599. <h4>Default</h4>
  600. <p>1 (enabled)</p>
  601. </section>
  602. <section class="option" id="ShowBigNumbers"><h3>ShowBigNumbers <span class="purpose">enable/disable &quot;Big Numbers&quot; sections</span></h3>
  603. <pre>&lt;channel=&quot;#channel&quot;&gt;
  604. Logfile = &quot;channel.log&quot;
  605. Format = &quot;xchat&quot;
  606. ShowBigNumbers = &quot;0&quot;
  607. &lt;/channel&gt;
  608. &lt;set ShowBigNumbers=&quot;1&quot;&gt;</pre>
  609. <h4>Description</h4>
  610. <p>With this option you can disable the &quot;Big Numbers&quot; and &quot;Other
  611. Interesting numbers&quot; sections on the stats page. They will simply
  612. disappear when specifying 0.</p>
  613. <h4>Default</h4>
  614. <p>1 (enabled)</p>
  615. </section>
  616. <section class="option" id="ShowTopics"><h3>ShowTopics <span class="purpose">enable/disable &quot;Latest topics&quot; sections</span></h3>
  617. <pre>&lt;channel=&quot;#channel&quot;&gt;
  618. Logfile = &quot;channel.log&quot;
  619. Format = &quot;xchat&quot;
  620. ShowTopics = &quot;0&quot;
  621. &lt;/channel&gt;
  622. &lt;set ShowTopics=&quot;1&quot;&gt;</pre>
  623. <h4>Description</h4>
  624. <p>With this option you can disable the &quot;Latest topics&quot; section on the
  625. stats page. It will simply disappear when specifying 0.</p>
  626. <h4>Default</h4>
  627. <p>1 (enabled)</p>
  628. </section>
  629. <section class="option" id="ShowLines"><h3>ShowLines <span class="purpose">enable/disable &quot;number of lines&quot;</span></h3>
  630. <pre>&lt;channel=&quot;#channel&quot;&gt;
  631. Logfile = &quot;channel.log&quot;
  632. Format = &quot;xchat&quot;
  633. ShowLines = &quot;0&quot;
  634. &lt;/channel&gt;
  635. &lt;set ShowLines=&quot;1&quot;&gt;</pre>
  636. <h4>Description</h4>
  637. <p>The default behaviour is to add a column to the &quot;Most Active Nicks&quot;
  638. section displaying the number of lines a user wrote. With this option it
  639. can be disabled.</p>
  640. <h4>Default</h4>
  641. <p>1 (enabled)</p>
  642. </section>
  643. <section class="option" id="ShowWpl"><h3>ShowWpl <span class="purpose">enable/disable &quot;words per line&quot;</span></h3>
  644. <pre>&lt;channel=&quot;#channel&quot;&gt;
  645. Logfile = &quot;channel.log&quot;
  646. Format = &quot;xchat&quot;
  647. ShowWpl = &quot;0&quot;
  648. &lt;/channel&gt;
  649. &lt;set ShowWpl=&quot;1&quot;&gt;</pre>
  650. <h4>Description</h4>
  651. <p>With this option you can enable the &quot;words per line&quot; column in the
  652. &quot;Most Active Nicks&quot; section. It will add a column describing the average
  653. words per line for a person.</p>
  654. <h4>Default</h4>
  655. <p>0 (disabled)</p>
  656. </section>
  657. <section class="option" id="ShowCpl"><h3>ShowCpl <span class="purpose">enable/disable &quot;characters per line&quot;</span></h3>
  658. <pre>&lt;channel=&quot;#channel&quot;&gt;
  659. Logfile = &quot;channel.log&quot;
  660. Format = &quot;xchat&quot;
  661. ShowCpl = &quot;0&quot;
  662. &lt;/channel&gt;
  663. &lt;set ShowCpl=&quot;1&quot;&gt;</pre>
  664. <h4>Description</h4>
  665. <p>With this option you can enable the &quot;characters per line&quot; column in the
  666. &quot;Most Active Nicks&quot; section. It will add a column describing the average
  667. number of characters per line for a person.</p>
  668. <h4>Default</h4>
  669. <p>0 (disabled)</p>
  670. </section>
  671. <section class="option" id="ShowWords"><h3>ShowWords <span class="purpose">enable/disable &quot;number of words&quot;</span></h3>
  672. <pre>&lt;channel=&quot;#channel&quot;&gt;
  673. Logfile = &quot;channel.log&quot;
  674. Format = &quot;xchat&quot;
  675. ShowWords = &quot;0&quot;
  676. &lt;/channel&gt;
  677. &lt;set ShowWords=&quot;1&quot;&gt;</pre>
  678. <h4>Description</h4>
  679. <p>The <code>ShowWords</code> option adds a column to the &quot;Most
  680. Active Nicks&quot; list which list the total number of words a user has
  681. typed.</p>
  682. <h4>Default</h4>
  683. <p>0 (disabled)</p>
  684. </section>
  685. <section class="option" id="ShowLastSeen"><h3>ShowLastSeen <span class="purpose">show when a user was last seen on a channel</span></h3>
  686. <pre>&lt;channel=&quot;#channel&quot;&gt;
  687. Logfile = &quot;channel.log&quot;
  688. Format = &quot;xchat&quot;
  689. ShowLastSeen = &quot;0&quot;
  690. &lt;/channel&gt;
  691. &lt;set ShowLastSeen=&quot;1&quot;&gt;</pre>
  692. <h4>Description</h4>
  693. <p>With this option enabled, a column will be added to the &quot;Most Active
  694. Nicks&quot; section to display when a user was last seen. E.g. &quot;2 days ago&quot;.</p>
  695. <h4>Default</h4>
  696. <p>1 (enabled)</p>
  697. </section>
  698. <section class="option" id="ShowTime"><h3>ShowTime <span class="purpose">show when a nick was active</span></h3>
  699. <pre>&lt;channel=&quot;#channel&quot;&gt;
  700. Logfile = &quot;channel.log&quot;
  701. Format = &quot;xchat&quot;
  702. ShowTime = &quot;0&quot;
  703. &lt;/channel&gt;
  704. &lt;set ShowTime=&quot;1&quot;&gt;</pre>
  705. <h4>Description</h4>
  706. <p>The default behaviour is to add a column to the &quot;Most Active Nicks&quot;
  707. section displaying a fancy time bar to show when a user was active. With
  708. this option it can be disabled.</p>
  709. <h4>Default</h4>
  710. <p>1 (enabled)</p>
  711. </section>
  712. <section class="option" id="ShowLineTime"><h3>ShowLineTime <span class="purpose">mIRCStats like behaviour of time bar</span></h3>
  713. <pre>&lt;channel=&quot;#channel&quot;&gt;
  714. Logfile = &quot;channel.log&quot;
  715. Format = &quot;bobot&quot;
  716. ShowLineTime = &quot;0&quot;
  717. &lt;/channel&gt;
  718. &lt;set ShowLineTime=&quot;1&quot;&gt;</pre>
  719. <h4>Description</h4>
  720. <p>The default behaviour is to add a column to the &quot;Most Active Nicks&quot;
  721. section displaying a fancy time bar to show when a user was active.
  722. With this option it can be done the same way as mIRCStats does it; that
  723. is, by putting that time bar next to the number of lines, in the same
  724. column.</p>
  725. <h4>Default</h4>
  726. <p>0 (disabled)</p>
  727. </section>
  728. <section class="option" id="ShowWordTime"><h3>ShowWordTime <span class="purpose">ShowLineTime like behavior of words column</span></h3>
  729. <pre>&lt;channel=&quot;#channel&quot;&gt;
  730. Logfile = &quot;channel.log&quot;
  731. Format = &quot;bobot&quot;
  732. ShowWordTime = &quot;0&quot;
  733. &lt;/channel&gt;
  734. &lt;set ShowWordTime=&quot;1&quot;&gt;</pre>
  735. <h4>Description</h4>
  736. <p>The default behaviour is to add a column to the &quot;Most Active Nicks&quot;
  737. section displaying a fancy time bar to show when a user was active.
  738. With this option it can be done similarly to mIRCStats does it and like
  739. the ShowLineTime option, but using words instead of lines; that is, by
  740. putting that time bar next to the number of words, in the same column.</p>
  741. <h4>Default</h4>
  742. <p>0 (disabled)</p>
  743. </section>
  744. <section class="option" id="ShowRandQuote"><h3>ShowRandQuote <span class="purpose">enable or disable the random quotes</span></h3>
  745. <pre>&lt;channel=&quot;#channel&quot;&gt;
  746. Logfile = &quot;channel.log&quot;
  747. Format = &quot;bobot&quot;
  748. ShowRandQuote = &quot;0&quot;
  749. &lt;/channel&gt;
  750. &lt;set ShowRandQuote=&quot;1&quot;&gt;</pre>
  751. <h4>Description</h4>
  752. <p>The default behaviour is to add a column to the &quot;Most Active Nicks&quot;
  753. section displaying a users random quote. With this option it can be
  754. disabled.</p>
  755. <h4>Default</h4>
  756. <p>1 (enabled)</p>
  757. </section>
  758. <section class="option" id="ShowLegend"><h3>ShowLegend <span class="purpose">enable or disable the legend of the time bars</span></h3>
  759. <pre>&lt;channel=&quot;#channel&quot;&gt;
  760. Logfile = &quot;channel.log&quot;
  761. Format = &quot;bobot&quot;
  762. ShowLegend = &quot;0&quot;
  763. &lt;/channel&gt;
  764. &lt;set ShowLegend=&quot;1&quot;&gt;</pre>
  765. <h4>Description</h4>
  766. <p>By default, pisg shows a legend below the &quot;Most Active Times&quot; displaying
  767. what the different colors means. With this option it can be disabled.</p>
  768. <h4>Default</h4>
  769. <p>1 (enabled)</p>
  770. </section>
  771. <section class="option" id="ShowKickLine"><h3>ShowKickLine <span class="purpose">enable or disable the kick line</span></h3>
  772. <pre>&lt;channel=&quot;#channel&quot;&gt;
  773. Logfile = &quot;channel.log&quot;
  774. Format = &quot;bobot&quot;
  775. ShowKickLine = &quot;0&quot;
  776. &lt;/channel&gt;
  777. &lt;set ShowKickLine=&quot;1&quot;&gt;</pre>
  778. <h4>Description</h4>
  779. <p>By default, pisg shows an example kick line in the &quot;Most kicked&quot;-stats.
  780. With this option it can be disabled.</p>
  781. <h4>Default</h4>
  782. <p>1 (enabled)</p>
  783. </section>
  784. <section class="option" id="ShowActionLine"><h3>ShowActionLine <span class="purpose">enable or disable the action line</span></h3>
  785. <pre>&lt;channel=&quot;#channel&quot;&gt;
  786. Logfile = &quot;channel.log&quot;
  787. Format = &quot;bobot&quot;
  788. ShowActionLine = &quot;0&quot;
  789. &lt;/channel&gt;
  790. &lt;set ShowActionLine=&quot;1&quot;&gt;</pre>
  791. <h4>Description</h4>
  792. <p>By default, pisg shows an example action line in the &quot;Most actions&quot;-stats.
  793. With this option it can be disabled.</p>
  794. <h4>Default</h4>
  795. <p>1 (enabled)</p>
  796. </section>
  797. <section class="option" id="ShowShoutLine"><h3>ShowShoutLine <span class="purpose">enable or disable the shout line</span></h3>
  798. <pre>&lt;channel=&quot;#channel&quot;&gt;
  799. Logfile = &quot;channel.log&quot;
  800. Format = &quot;bobot&quot;
  801. ShowShoutLine = &quot;0&quot;
  802. &lt;/channel&gt;
  803. &lt;set ShowShoutLine=&quot;1&quot;&gt;</pre>
  804. <h4>Description</h4>
  805. <p>By default, pisg shows an example shout line in the &quot;Most shouting
  806. people&quot;-stats. With this option it can be disabled.</p>
  807. <h4>Default</h4>
  808. <p>1 (enabled)</p>
  809. </section>
  810. <section class="option" id="ShowFoulDecimals"><h3>ShowFoulDecimals <span class="purpose">set how many decimals to show</span></h3>
  811. <pre>&lt;channel=&quot;#channel&quot;&gt;
  812. Logfile = &quot;channel.log&quot;
  813. Format = &quot;bobot&quot;
  814. ShowFoulDecimals = &quot;2&quot;
  815. &lt;/channel&gt;
  816. &lt;set ShowFoulDecimals=&quot;1&quot;&gt;</pre>
  817. <h4>Description</h4>
  818. <p>By default, pisg uses 1 decimal. With this option you could change
  819. it to whatever you like. Negative is treated as the default value.</p>
  820. <h4>Default</h4>
  821. <p>1 decimal</p>
  822. </section>
  823. <section class="option" id="ShowFoulLine"><h3>ShowFoulLine <span class="purpose">enable or disable the foul line</span></h3>
  824. <pre>&lt;channel=&quot;#channel&quot;&gt;
  825. Logfile = &quot;channel.log&quot;
  826. Format = &quot;bobot&quot;
  827. ShowFoulLine = &quot;0&quot;
  828. &lt;/channel&gt;
  829. &lt;set ShowFoulLine=&quot;1&quot;&gt;</pre>
  830. <h4>Description</h4>
  831. <p>By default, pisg doesn&#x27;t show an example foul line in the &quot;Most
  832. fouls&quot;-stats. With this option it can be enabled.</p>
  833. <h4>Default</h4>
  834. <p>0 (disabled)</p>
  835. </section>
  836. <section class="option" id="ShowViolentLines"><h3>ShowViolentLines <span class="purpose">enable or disable the violent lines</span></h3>
  837. <pre>&lt;channel=&quot;#channel&quot;&gt;
  838. Logfile = &quot;channel.log&quot;
  839. Format = &quot;bobot&quot;
  840. ShowViolentLines = &quot;0&quot;
  841. &lt;/channel&gt;
  842. &lt;set ShowViolentLines=&quot;1&quot;&gt;</pre>
  843. <h4>Description</h4>
  844. <p>By default, pisg shows example violent lines in the &quot;Most aggressive&quot;
  845. and &quot;Most attacked&quot;-stats. With this option it can be disabled.</p>
  846. <h4>Default</h4>
  847. <p>1 (enabled)</p>
  848. </section>
  849. <section class="option" id="ShowMuw"><h3>ShowMuw <span class="purpose">enable or disable &quot;Most used words&quot;</span></h3>
  850. <pre>&lt;channel=&quot;#channel&quot;&gt;
  851. Logfile = &quot;channel.log&quot;
  852. Format = &quot;xchat&quot;
  853. ShowMuw = &quot;0&quot;
  854. &lt;/channel&gt;
  855. &lt;set ShowMuw=&quot;1&quot;&gt;</pre>
  856. <h4>Description</h4>
  857. <p>By default, pisg adds an &quot;Most used words&quot; section to the stats page.
  858. With this option you can disable it from being shown.
  859. See also <a href="#WordHistory">WordHistory</a>.</p>
  860. <h4>Default</h4>
  861. <p>1 (enabled)</p>
  862. </section>
  863. <section class="option" id="ShowMrn"><h3>ShowMrn <span class="purpose">enable or disable &quot;Most referenced nicks&quot;</span></h3>
  864. <pre>&lt;channel=&quot;#channel&quot;&gt;
  865. Logfile = &quot;channel.log&quot;
  866. Format = &quot;xchat&quot;
  867. ShowMrn = &quot;0&quot;
  868. &lt;/channel&gt;
  869. &lt;set ShowMrn=&quot;1&quot;&gt;</pre>
  870. <h4>Description</h4>
  871. <p>By default, pisg adds an &quot;Most referenced nicks&quot; section to the stats
  872. page. With this option you can disable it from being shown.
  873. See also <a href="#NickHistory">NickHistory</a>.</p>
  874. <h4>Default</h4>
  875. <p>1 (enabled)</p>
  876. </section>
  877. <section class="option" id="ShowMru"><h3>ShowMru <span class="purpose">enable or disable &quot;Most referenced URLs&quot;</span></h3>
  878. <pre>&lt;channel=&quot;#channel&quot;&gt;
  879. Logfile = &quot;channel.log&quot;
  880. Format = &quot;xchat&quot;
  881. ShowMru = &quot;0&quot;
  882. &lt;/channel&gt;
  883. &lt;set ShowMru=&quot;1&quot;&gt;</pre>
  884. <h4>Description</h4>
  885. <p>By default, pisg adds an &quot;Most referenced URLs&quot; section to the stats
  886. page. With this option you can disable it from being shown.
  887. See also <a href="#UrlHistory">UrlHistory</a>.</p>
  888. <h4>Default</h4>
  889. <p>1 (enabled)</p>
  890. </section>
  891. <section class="option" id="ShowCharts"><h3>ShowCharts <span class="purpose">enable or disable channel music charts</span></h3>
  892. <pre>&lt;channel=&quot;#channel&quot;&gt;
  893. Logfile = &quot;channel.log&quot;
  894. Format = &quot;xchat&quot;
  895. ShowCharts = &quot;0&quot;
  896. &lt;/channel&gt;
  897. &lt;set ShowCharts=&quot;1&quot;&gt;</pre>
  898. <h4>Description</h4>
  899. <p>With this option set, pisg creates a chart listing of the top songs played
  900. on the channel. See also <a href="#ChartsHistory">ChartsHistory</a> and
  901. <a href="#ChartsRegexp">ChartsRegexp</a>.</p>
  902. <h4>Default</h4>
  903. <p>0 (disabled)</p>
  904. </section>
  905. <section class="option" id="ShowOps"><h3>ShowOps <span class="purpose">enable or disable op statistics</span></h3>
  906. <pre>&lt;channel=&quot;#channel&quot;&gt;
  907. Logfile = &quot;channel.log&quot;
  908. Format = &quot;xchat&quot;
  909. ShowOps = &quot;0&quot;
  910. &lt;/channel&gt;
  911. &lt;set ShowOps=&quot;0&quot;&gt;</pre>
  912. <h4>Description</h4>
  913. <p>By default, pisg has op statistics in the &quot;Most interesting numbers&quot;
  914. section. Here you can disable the feature, it&#x27;s useful if you don&#x27;t feel
  915. that the information is of any value, or your log format doesn&#x27;t support
  916. ops/deops.</p>
  917. <h4>Default</h4>
  918. <p>1 (enabled)</p>
  919. </section>
  920. <section class="option" id="ShowVoices"><h3>ShowVoices <span class="purpose">enable or disable voice statistics</span></h3>
  921. <pre>&lt;channel=&quot;#channel&quot;&gt;
  922. Logfile = &quot;channel.log&quot;
  923. Format = &quot;xchat&quot;
  924. ShowVoices = &quot;0&quot;
  925. &lt;/channel&gt;
  926. &lt;set ShowVoices=&quot;1&quot;&gt;</pre>
  927. <h4>Description</h4>
  928. <p>By default, pisg doesn&#x27;t have voice statistics like it has op
  929. statistics. Enabling this option will add a section to the &quot;Most
  930. interesting numbers&quot; displaying who got most voices.</p>
  931. <h4>Default</h4>
  932. <p>0 (disabled)</p>
  933. </section>
  934. <section class="option" id="ShowHalfops"><h3>ShowHalfops <span class="purpose">enable or disable halfop statistics</span></h3>
  935. <pre>&lt;channel=&quot;#channel&quot;&gt;
  936. Logfile = &quot;channel.log&quot;
  937. Format = &quot;xchat&quot;
  938. ShowHalfops = &quot;0&quot;
  939. &lt;/channel&gt;
  940. &lt;set ShowHalfops=&quot;1&quot;&gt;</pre>
  941. <h4>Description</h4>
  942. <p>By default, pisg doesn&#x27;t have halfop statistics (+h on some servers)
  943. like it has op statistics. Enabling this option will add a section to
  944. the &quot;Most interesting numbers&quot; displaying who gave most half-ops.</p>
  945. <h4>Default</h4>
  946. <p>0 (disabled)</p>
  947. </section>
  948. <section class="option" id="ShowMostNicks"><h3>ShowMostNicks <span class="purpose">show who changed nick most often</span></h3>
  949. <pre>&lt;channel=&quot;#channel&quot;&gt;
  950. Logfile = &quot;channel.log&quot;
  951. Format = &quot;xchat&quot;
  952. ShowMostNicks = &quot;0&quot;
  953. &lt;/channel&gt;
  954. &lt;set ShowMostNicks=&quot;1&quot;&gt;</pre>
  955. <h4>Description</h4>
  956. <p>By enabling this option, pisg will add a section to the stats showing
  957. who had the most nicks, and what the nicks were. This option only works
  958. properly when <a href="#NickTracking">NickTracking</a> is enabled or
  959. <a href="#user-options">user aliases</a> have been defined.
  960. See also <a href="#MostNicksHistory">MostNicksHistory</a>,
  961. <a href="#MostNicksVerbose">MostNicksVerbose</a>, and
  962. <a href="#NickLimit">NickLimit</a>.</p>
  963. <h4>Default</h4>
  964. <p>0 (disabled)</p>
  965. </section>
  966. <section class="option" id="ShowActiveGenders"><h3>ShowActiveGenders <span class="purpose">show stats on which gender talked most</span></h3>
  967. <pre>&lt;channel=&quot;#channel&quot;&gt;
  968. Logfile = &quot;channel.log&quot;
  969. Format = &quot;xchat&quot;
  970. ShowActiveGenders = &quot;0&quot;
  971. &lt;/channel&gt;
  972. &lt;set ShowActiveGenders=&quot;1&quot;&gt;</pre>
  973. <h4>Description</h4>
  974. <p>Setting this option will make pisg create statistics on which gender
  975. (female/male/bot) talked most (see the &quot;sex&quot; option in <a href="#user-options">Specifying user options</a>). See also <a href="#NickLimit">NickLimit</a>.</p>
  976. <h4>Default</h4>
  977. <p>0 (disabled)</p>
  978. </section>
  979. <section class="option" id="ShowSmileys"><h3>ShowSmileys <span class="purpose">show most used smileys</span></h3>
  980. <pre>&lt;channel=&quot;#channel&quot;&gt;
  981. Logfile = &quot;channel.log&quot;
  982. Format = &quot;xchat&quot;
  983. ShowSmileys = &quot;0&quot;
  984. &lt;/channel&gt;
  985. &lt;set ShowSmileys=&quot;1&quot;&gt;</pre>
  986. <h4>Description</h4>
  987. <p>With this option, pisg will make a list of the most used smileys in the
  988. channel. See also <a href="#SmileyHistory">SmileyHistory</a>.</p>
  989. <h4>Default</h4>
  990. <p>0 (disabled)</p>
  991. </section>
  992. <section class="option" id="ShowKarma"><h3>ShowKarma <span class="purpose">show channel karma</span></h3>
  993. <pre>&lt;channel=&quot;#channel&quot;&gt;
  994. Logfile = &quot;channel.log&quot;
  995. Format = &quot;xchat&quot;
  996. ShowKarma = &quot;0&quot;
  997. &lt;/channel&gt;
  998. &lt;set ShowKarma=&quot;1&quot;&gt;</pre>
  999. <h4>Description</h4>
  1000. <p>With this option, pisg will analyze the channel karma. Users can give other
  1001. users (or things) good or bad karma by saying &quot;nickname++&quot; or &quot;nickname--&quot;;
  1002. &quot;nickname==&quot; resets it to zero. Only the last karma is remembered per
  1003. nick/nick combination, so there is at most +- 1 karma point.
  1004. See also <a href="#KarmaHistory">KarmaHistory</a> and <a href="#NickLimit">NickLimit</a>.</p>
  1005. <h4>Default</h4>
  1006. <p>0 (disabled)</p>
  1007. </section>
  1008. <section class="option" id="ShowMostActiveByHour"><h3>ShowMostActiveByHour <span class="purpose">show most active nicks by hour</span></h3>
  1009. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1010. Logfile = &quot;channel.log&quot;
  1011. Format = &quot;xchat&quot;
  1012. ShowMostActiveByHour = &quot;0&quot;
  1013. &lt;/channel&gt;
  1014. &lt;set ShowMostActiveByHour=&quot;1&quot;&gt;</pre>
  1015. <h4>Description</h4>
  1016. <p>By enabling this option, pisg will add a section to the stats showing
  1017. &quot;Most Active Nicks By Hour&quot; - also look at the
  1018. <a href="#ShowMostActiveByHourGraph">ShowMostActiveByHourGraph</a> and
  1019. <a href="#ActiveNicksByHour">ActiveNicksByHour</a> settings.</p>
  1020. <h4>Default</h4>
  1021. <p>0 (disabled)</p>
  1022. </section>
  1023. <section class="option" id="ShowOnlyTop"><h3>ShowOnlyTop <span class="purpose">only count stats for top talkers, ignore less-active users</span></h3>
  1024. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1025. Logfile = &quot;channel.log&quot;
  1026. Format = &quot;xchat&quot;
  1027. ShowOnlyTop = &quot;1&quot;
  1028. &lt;/channel&gt;
  1029. &lt;set ShowOnlyTop=&quot;1&quot;&gt;</pre>
  1030. <h4>Description</h4>
  1031. <p>By enabling this option, stats in the &quot;Big Numbers&quot; and &quot;Interesting
  1032. Numbers&quot; section will only be counted for users who were the most
  1033. active. E.g. users who appear in the &quot;Most Active Nicks&quot; section, as
  1034. respected by the <a href="#ActiveNicks">ActiveNicks</a> and
  1035. <a href="#ActiveNicks2">ActiveNicks2</a> options. See also
  1036. <a href="#BigNumbersThreshold">BigNumbersThreshold</a>.</p>
  1037. <h4>Default</h4>
  1038. <p>0 (disabled)</p>
  1039. </section>
  1040. <section class="option" id="ShowMostActiveByHourGraph"><h3>ShowMostActiveByHourGraph <span class="purpose">show graphs in most active nicks by hour</span></h3>
  1041. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1042. Logfile = &quot;channel.log&quot;
  1043. Format = &quot;xchat&quot;
  1044. ShowMostActiveByHourGraph = &quot;0&quot;
  1045. &lt;/channel&gt;
  1046. &lt;set ShowMostActiveByHour=&quot;1&quot;&gt;
  1047. &lt;set ShowMostActiveByHourGraph=&quot;1&quot;&gt;</pre>
  1048. <h4>Description</h4>
  1049. <p>By enabling this option and the <a href="#ShowMostActiveByHour">ShowMostActiveByHour</a>
  1050. option, pisg will show graphs in the &quot;Most Active Nicks By Hour&quot;
  1051. section.</p>
  1052. <h4>Default</h4>
  1053. <p>1 (enabled)</p>
  1054. </section>
  1055. <section class="option" id="ShowOverview"><h3>ShowOverview <span class="purpose">enable/disable the channel overview</span></h3>
  1056. <pre>&lt;set ShowOverview=&quot;1&quot;&gt;</pre>
  1057. <h4>Description</h4>
  1058. <p>Shows a row of key numbers at the top of the page: lines, words, nicks, days covered, lines
  1059. per day, the busiest and quietest hour, questions, links shared, the top talker and the
  1060. number of joins and kicks.</p>
  1061. <h4>Default</h4>
  1062. <p>1 (enabled)</p>
  1063. </section>
  1064. <section class="option" id="ShowRelations"><h3>ShowRelations <span class="purpose">enable/disable the relation map and its tables</span></h3>
  1065. <pre>&lt;set ShowRelations=&quot;1&quot;&gt;</pre>
  1066. <h4>Description</h4>
  1067. <p>Shows who talks to whom: an interactive map (click a nick or a line for details), a table of
  1068. the closest pairs, and the &quot;social roles&quot; (who is talked to the most, the best listener, ...).
  1069. Two people are connected when one starts a line with the other&#x27;s nick (&quot;Bob: hi&quot;), mentions
  1070. them, or answers right after them. A line addressed to someone counts three times as much as
  1071. a mention or a quick reply. Nicks that are joined by <a href="#NickTracking">NickTracking</a> or a user alias
  1072. count as one person. Bots are left out: mark a bot with &lt;user nick=&quot;Bot&quot; sex=&quot;b&quot;&gt; to keep it in the
  1073. other statistics but off the map, or with ignore=&quot;y&quot; to remove it altogether. Nicks that are also
  1074. ordinary words (and the channel name) are not counted as mentions.
  1075. See also <a href="#RelationNicks">RelationNicks</a> and <a href="#RelationMinWeight">RelationMinWeight</a>.</p>
  1076. <h4>Default</h4>
  1077. <p>1 (enabled)</p>
  1078. </section>
  1079. <section class="option" id="RelationNicks"><h3>RelationNicks <span class="purpose">number of nicks on the relation map</span></h3>
  1080. <pre>&lt;set RelationNicks=&quot;30&quot;&gt;</pre>
  1081. <h4>Description</h4>
  1082. <p>The map shows this many of the most active people (bots excluded). More than about 40 makes
  1083. the picture crowded.</p>
  1084. <h4>Default</h4>
  1085. <p>30</p>
  1086. </section>
  1087. <section class="option" id="RelationMinWeight"><h3>RelationMinWeight <span class="purpose">minimum connection strength shown as a line on the relation map</span></h3>
  1088. <pre>&lt;set RelationMinWeight=&quot;3&quot;&gt;</pre>
  1089. <h4>Description</h4>
  1090. <p>Connections weaker than this are not drawn, which keeps the map readable. A line addressed to
  1091. someone is worth 3, a mention 1 and a quick reply 1. Raise it for a busy channel, lower it for a quiet one.</p>
  1092. <h4>Default</h4>
  1093. <p>3</p>
  1094. </section>
  1095. <section class="option" id="ShowTimePersonalities"><h3>ShowTimePersonalities <span class="purpose">enable/disable the time personalities section</span></h3>
  1096. <pre>&lt;set ShowTimePersonalities=&quot;1&quot;&gt;</pre>
  1097. <h4>Description</h4>
  1098. <p>Shows who chats mostly at night (0-5h), in the morning (6-11h), in the afternoon (12-17h) and
  1099. in the evening (18-23h), for the people with enough lines. The hours follow <a href="#TimeOffset">TimeOffset</a>.</p>
  1100. <h4>Default</h4>
  1101. <p>1 (enabled)</p>
  1102. </section>
  1103. <section class="option" id="ShowConcentration"><h3>ShowConcentration <span class="purpose">enable/disable the &quot;who carries the channel&quot; section</span></h3>
  1104. <pre>&lt;set ShowConcentration=&quot;1&quot;&gt;</pre>
  1105. <h4>Description</h4>
  1106. <p>Shows how much of the channel the busiest people write: the share of all lines written by the
  1107. top 1, 3, 5, 10 and 20 nicks, and how many nicks wrote half of everything.</p>
  1108. <h4>Default</h4>
  1109. <p>1 (enabled)</p>
  1110. </section>
  1111. <section class="option" id="ShowSignatureWords"><h3>ShowSignatureWords <span class="purpose">enable/disable the signature words section</span></h3>
  1112. <pre>&lt;set ShowSignatureWords=&quot;1&quot;&gt;</pre>
  1113. <h4>Description</h4>
  1114. <p>Shows, for each of the regular talkers, the word they use a lot and that hardly anyone else uses.
  1115. Short words, nicks and links are ignored (see <a href="#WordLength">WordLength</a> and <a href="#IgnoreWords">IgnoreWords</a>).</p>
  1116. <h4>Default</h4>
  1117. <p>1 (enabled)</p>
  1118. </section>
  1119. <section class="option" id="IgnoreWords"><h3>IgnoreWords <span class="purpose">ignore specified words</span></h3>
  1120. <pre>&lt;set IgnoreWords=&quot;there about&quot;&gt;</pre>
  1121. <h4>Description</h4>
  1122. <p>Sometimes words in the &quot;most used words&quot; appears which you don&#x27;t want to
  1123. see, with this option you can ignore these words. It also applies to the
  1124. &quot;most referenced nicks&quot; section. It&#x27;s a space separated list of words.
  1125. You can use * like in nick aliases.
  1126. Can not be used in a channel-only context.</p>
  1127. <h4>Default</h4>
  1128. <p>unset</p>
  1129. </section>
  1130. <section class="option" id="NoIgnoredQuotes"><h3>NoIgnoredQuotes <span class="purpose">Control random quote output</span></h3>
  1131. <pre>&lt;set NoIgnoredQuotes=&quot;1&quot;&gt;</pre>
  1132. <h4>Description</h4>
  1133. <p>When set to &quot;1&quot;, pisg will not output quotes containing ignored words.
  1134. Pisg will output a blank line after trying 20 random quotes if all 20 random quotes were ignored.</p>
  1135. <h4>Default</h4>
  1136. <p>0</p>
  1137. </section>
  1138. <section class="option" id="FoulWords"><h3>FoulWords <span class="purpose">specify words considered to be bad/FoulWords language</span></h3>
  1139. <pre>&lt;set FoulWords=&quot;ass fuck bitch&quot;&gt;</pre>
  1140. <h4>Description</h4>
  1141. <p>There is a section in the &quot;Most interesting numbers&quot; which tells who had
  1142. a &quot;dirty mouth&quot; - here you can define which words are considered being
  1143. bad/foul. It is a space separated list of words.
  1144. You can use * like in nick aliases.
  1145. Can not be used in a channel-only context.</p>
  1146. <h4>Default</h4>
  1147. <p>ass fuck bitch shit scheisse kacke arsch ficker ficken schlampe</p>
  1148. </section>
  1149. <section class="option" id="ViolentWords"><h3>ViolentWords <span class="purpose">specify words considered to be aggressive/violent</span></h3>
  1150. <pre>&lt;set ViolentWords=&quot;slaps beats kick&quot;&gt;</pre>
  1151. <h4>Description</h4>
  1152. <p>There is a section in the &quot;Most interesting numbers&quot; which tells who is
  1153. most &quot;aggressive&quot; - here you can define which words are considered being
  1154. &quot;violent&quot;. It is a space separated list of words. You can use * like in
  1155. nick aliases. Can not be used in a channel-only context.</p>
  1156. <h4>Default</h4>
  1157. <p>slaps beats smacks</p>
  1158. </section>
  1159. <section class="option" id="BadUrls"><h3>BadUrls <span class="purpose">words that keep a URL out of the URL statistics</span></h3>
  1160. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1161. Logfile = &quot;channel.log&quot;
  1162. Format = &quot;xchat&quot;
  1163. BadUrls = &quot;imagetwist imgur.com postimg.cc/*&quot;
  1164. &lt;/channel&gt;
  1165. &lt;set BadUrls=&quot;imagetwist imgur.com postimg.cc/*&quot;&gt;</pre>
  1166. <h4>Description</h4>
  1167. <p>BadUrls is a list of words, separated by spaces, much like <a href="#FoulWords">FoulWords</a>.
  1168. A URL that contains any of the words is not counted, so it never shows up in
  1169. &quot;Most referenced URLs&quot; (see <a href="#ShowMru">ShowMru</a>). Use it to keep spam and
  1170. unwanted image hosts out of the statistics.
  1171. A word matches anywhere in the URL, whatever the case, so &quot;imgur.com&quot; also
  1172. removes &quot;https://i.imgur.com/abc.png&quot;. Two wildcards are understood: * stands for
  1173. any run of characters and ? for exactly one character. So &quot;postimg.cc/*&quot; removes
  1174. every link to postimg.cc (including &quot;i.postimg.cc/x.png&quot;) but not
  1175. &quot;example.org/postimg.cc&quot;, where nothing follows the name, and &quot;*.example.org/*&quot;
  1176. removes links on any subdomain of example.org but not on example.org itself.
  1177. Apart from the wildcards the words are plain text, not regular expressions, so
  1178. characters such as . + ( ) [ ] | mean exactly themselves. A lone * would remove every
  1179. URL. To hide a single exact address instead, use the
  1180. <a href="#ignoring-links">link ignore</a> setting.</p>
  1181. <h4>Default</h4>
  1182. <p>unset (no URLs are removed)</p>
  1183. </section>
  1184. <section class="option" id="MinQuote"><h3>MinQuote <span class="purpose">minimum numbers of letters for a random quote</span></h3>
  1185. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1186. Logfile = &quot;channel.log&quot;
  1187. Format = &quot;xchat&quot;
  1188. MinQuote = &quot;10&quot;
  1189. &lt;/channel&gt;
  1190. &lt;set MinQuote=&quot;5&quot;&gt;</pre>
  1191. <h4>Description</h4>
  1192. <p>The random quotes displayed in the &quot;Most Active Nicks&quot; section will be
  1193. picked from a length range. With this option you can change the minimum
  1194. number of letters required for a random quote. Also see the
  1195. <a href="#MaxQuote">MaxQuote</a> option. Note that pisg will still choose a
  1196. short quote if it cannot find a longer one.</p>
  1197. <h4>Default</h4>
  1198. <p>25</p>
  1199. </section>
  1200. <section class="option" id="MaxQuote"><h3>MaxQuote <span class="purpose">maximum numbers of letters for a random quote</span></h3>
  1201. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1202. Logfile = &quot;channel.log&quot;
  1203. Format = &quot;xchat&quot;
  1204. MaxQuote = &quot;70&quot;
  1205. &lt;/channel&gt;
  1206. &lt;set MaxQuote=&quot;100&quot;&gt;</pre>
  1207. <h4>Description</h4>
  1208. <p>The random quotes displayed in the &quot;Most Active Nicks&quot; section will be
  1209. picked from a length range. With this option you can change the maximum
  1210. number of letters required for a random quote. Also see the
  1211. <a href="#MinQuote">MinQuote</a> option.</p>
  1212. <h4>Default</h4>
  1213. <p>65</p>
  1214. </section>
  1215. <section class="option" id="WordLength"><h3>WordLength <span class="purpose">minimum number of characters in an interesting word</span></h3>
  1216. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1217. Logfile = &quot;channel.log&quot;
  1218. Format = &quot;xchat&quot;
  1219. WordLength = &quot;10&quot;
  1220. &lt;/channel&gt;
  1221. &lt;set WordLength=&quot;2&quot;&gt;</pre>
  1222. <h4>Description</h4>
  1223. <p>The &quot;Most Used Words&quot; section on the stats page display the most used
  1224. words. The default is that a word only appears if it is longer than 5
  1225. characters. With this option you can change that minimum.</p>
  1226. <h4>Default</h4>
  1227. <p>5</p>
  1228. </section>
  1229. <section class="option" id="QuoteWidth"><h3>QuoteWidth <span class="purpose">maximum allowed length of a &quot;word&quot; with no spaces</span></h3>
  1230. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1231. Logfile = &quot;channel.log&quot;
  1232. Format = &quot;xchat&quot;
  1233. QuoteWidth = &quot;48&quot;
  1234. &lt;/channel&gt;
  1235. &lt;set QuoteWidth=&quot;48&quot;&gt;</pre>
  1236. <h4>Description</h4>
  1237. <p>Pisg will automatically insert a space in words that have a length
  1238. over the amount QuoteWidth is set to. When used in breaking up
  1239. URLs it will insert a space in the displayed URL, but not in the
  1240. actual URL referenced by the HREF.</p>
  1241. <h4>Default</h4>
  1242. <p>80</p>
  1243. </section>
  1244. <section class="option" id="BigNumbersThreshold"><h3>BigNumbersThreshold <span class="purpose">Minimum number of lines per user for some &quot;Big Numbers&quot; statistics</span></h3>
  1245. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1246. Logfile = &quot;channel.log&quot;
  1247. Format = &quot;xchat&quot;
  1248. BigNumbersThreshold = &quot;10&quot;
  1249. &lt;/channel&gt;
  1250. &lt;set BigNumbersThreshold=&quot;sqrt&quot;&gt;</pre>
  1251. <h4>Description</h4>
  1252. <p>Pisg will ignore users with less than this setting lines in the &quot;questions
  1253. asked&quot;, &quot;shouts loudest&quot;, &quot;CAPSLOCK&quot;, &quot;longest line&quot;, &quot;most sad&quot;, and &quot;most
  1254. happy&quot; sections. If the setting is &quot;sqrt&quot; (the default), it will be
  1255. dynamically replaced with the square root of the number of lines of the
  1256. most active nick. See also <a href="#ShowOnlyTop">ShowOnlyTop</a>.</p>
  1257. <h4>Default</h4>
  1258. <p>sqrt</p>
  1259. </section>
  1260. <section class="option" id="ActiveNicks"><h3>ActiveNicks <span class="purpose">nicks to show in &quot;Most Active Nicks&quot;</span></h3>
  1261. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1262. Logfile = &quot;channel.log&quot;
  1263. Format = &quot;mIRC&quot;
  1264. ActiveNicks = &quot;50&quot;
  1265. &lt;/channel&gt;
  1266. &lt;set ActiveNicks=&quot;10&quot;&gt;</pre>
  1267. <h4>Description</h4>
  1268. <p>With this option you can define how many nicks you want to appear in the
  1269. &quot;Most Active Nicks&quot; section on the stats page.</p>
  1270. <h4>Default</h4>
  1271. <p>25</p>
  1272. </section>
  1273. <section class="option" id="ActiveNicks2"><h3>ActiveNicks2 <span class="purpose">nicks to show in &quot;These didn&#x27;t make it..&quot;</span></h3>
  1274. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1275. Logfile = &quot;channel.log&quot;
  1276. Format = &quot;mIRC&quot;
  1277. ActiveNicks2 = &quot;25&quot;
  1278. &lt;/channel&gt;
  1279. &lt;set ActiveNicks2=&quot;10&quot;&gt;</pre>
  1280. <h4>Description</h4>
  1281. <p>With this option you can define how many nicks you want to appear in the
  1282. &quot;These didn&#x27;t make it&quot; section on the stats page.</p>
  1283. <h4>Default</h4>
  1284. <p>30</p>
  1285. </section>
  1286. <section class="option" id="ActiveNicksByHour"><h3>ActiveNicksByHour <span class="purpose">number of nicks to show in &quot;Most Active Nicks By Hour&quot;</span></h3>
  1287. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1288. Logfile = &quot;channel.log&quot;
  1289. Format = &quot;mIRC&quot;
  1290. ActiveNicksByHour = &quot;25&quot;
  1291. &lt;/channel&gt;
  1292. &lt;set ActiveNicksByHour=&quot;10&quot;&gt;</pre>
  1293. <h4>Description</h4>
  1294. <p>With this option you can define how many nicks you want to appear in the
  1295. &quot;Most Active Nicks By Hour&quot; section on the stats page.</p>
  1296. <h4>Default</h4>
  1297. <p>10</p>
  1298. </section>
  1299. <section class="option" id="MostNicksHistory"><h3>MostNicksHistory <span class="purpose">maximum number of nicks to show in &quot;users with most nicknames&quot;</span></h3>
  1300. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1301. Logfile = &quot;channel.log&quot;
  1302. Format = &quot;mIRC&quot;
  1303. MostNicksHistory = &quot;2&quot;
  1304. &lt;/channel&gt;
  1305. &lt;set MostNicksHistory=&quot;10&quot;&gt;</pre>
  1306. <h4>Description</h4>
  1307. <p>With this option you can define how many nicks you want to appear in
  1308. the &quot;Users with most nicknames&quot; section. See also
  1309. <a href="#ShowMostNicks">ShowMostNicks</a> and <a href="#MostNicksVerbose">MostNicksVerbose</a>.</p>
  1310. <h4>Default</h4>
  1311. <p>5</p>
  1312. </section>
  1313. <section class="option" id="MostNicksVerbose"><h3>MostNicksVerbose <span class="purpose">show nicks used in &quot;most nicks&quot;</span></h3>
  1314. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1315. Logfile = &quot;channel.log&quot;
  1316. Format = &quot;mIRC&quot;
  1317. MostNicksVerbose = &quot;0&quot;
  1318. &lt;/channel&gt;
  1319. &lt;set MostNicksVerbose=&quot;1&quot;&gt;</pre>
  1320. <h4>Description</h4>
  1321. <p>By disabling this option you can stop pisg from displaying all the nicks
  1322. a user has had in the &quot;Most used nicks&quot; section.
  1323. See also <a href="#ShowMostNicks">ShowMostNicks</a>,
  1324. <a href="#MostNicksHistory">MostNicksHistory</a>, and <a href="#NickLimit">NickLimit</a>.</p>
  1325. <h4>Default</h4>
  1326. <p>1 (enabled)</p>
  1327. </section>
  1328. <section class="option" id="TopicHistory"><h3>TopicHistory <span class="purpose">maximum number of topics to show</span></h3>
  1329. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1330. Logfile = &quot;channel.log&quot;
  1331. Format = &quot;mIRC&quot;
  1332. TopicHistory = &quot;2&quot;
  1333. &lt;/channel&gt;
  1334. &lt;set TopicHistory=&quot;10&quot;&gt;</pre>
  1335. <h4>Description</h4>
  1336. <p>With this option you can define how many topics you want to appear in
  1337. the &quot;Latest topics&quot; section.</p>
  1338. <h4>Default</h4>
  1339. <p>3</p>
  1340. </section>
  1341. <section class="option" id="UrlHistory"><h3>UrlHistory <span class="purpose">maximum number of URLs to show</span></h3>
  1342. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1343. Logfile = &quot;channel.log&quot;
  1344. Format = &quot;mIRC&quot;
  1345. UrlHistory = &quot;2&quot;
  1346. &lt;/channel&gt;
  1347. &lt;set UrlHistory=&quot;10&quot;&gt;</pre>
  1348. <h4>Description</h4>
  1349. <p>With this option you can define how many URLs you want to appear in
  1350. the &quot;Most referenced URLs&quot; section. See also <a href="#ShowMru">ShowMru</a>.</p>
  1351. <h4>Default</h4>
  1352. <p>5</p>
  1353. </section>
  1354. <section class="option" id="ChartsHistory"><h3>ChartsHistory <span class="purpose">number of songs to show</span></h3>
  1355. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1356. Logfile = &quot;channel.log&quot;
  1357. Format = &quot;mIRC&quot;
  1358. ChartsHistory = &quot;10&quot;
  1359. &lt;/channel&gt;
  1360. &lt;set ChartsHistory=&quot;5&quot;&gt;</pre>
  1361. <h4>Description</h4>
  1362. <p>This option sets the number of songs that will be show in the channel music
  1363. charts. See also <a href="#ShowCharts">ShowCharts</a> and
  1364. <a href="#ChartsRegexp">ChartsRegexp</a>.</p>
  1365. <h4>Default</h4>
  1366. <p>5 (the Top Five)</p>
  1367. </section>
  1368. <section class="option" id="ChartsRegexp"><h3>ChartsRegexp <span class="purpose">how to recognize songs played</span></h3>
  1369. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1370. Logfile = &quot;channel.log&quot;
  1371. Format = &quot;mIRC&quot;
  1372. ChartsRegexp = &quot;(?:is )?(?:np:|(?:now )?playing:? |listening to:? )(?:MPEG stream from)?\s*(.*)&quot;
  1373. &lt;/channel&gt;</pre>
  1374. <h4>Description</h4>
  1375. <p>This option is a perl regexp that is used to recognize songs played. Please
  1376. open an issue at https://github.com/PISG/pisg/issues if you have a better default. The regexp MUST
  1377. contain a single () pair to extract the song name. See also the perlre(1)
  1378. manpage, <a href="#ShowCharts">ShowCharts</a> and <a href="#ChartsHistory">ChartsHistory</a>.</p>
  1379. <h4>Default</h4>
  1380. <p>&quot;(?:np:|(?:now )?playing:? (?:MPEG stream from)?)\s*(.*)&quot;</p>
  1381. </section>
  1382. <section class="option" id="WordHistory"><h3>WordHistory <span class="purpose">maximum number of words to show</span></h3>
  1383. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1384. Logfile = &quot;channel.log&quot;
  1385. Format = &quot;mIRC&quot;
  1386. WordHistory = &quot;5&quot;
  1387. &lt;/channel&gt;
  1388. &lt;set WordHistory=&quot;15&quot;&gt;</pre>
  1389. <h4>Description</h4>
  1390. <p>With this option you can define how many words you want to appear in
  1391. the &quot;Most used words&quot; section. See also <a href="#ShowMuw">ShowMuw</a>.</p>
  1392. <h4>Default</h4>
  1393. <p>10</p>
  1394. </section>
  1395. <section class="option" id="NickHistory"><h3>NickHistory <span class="purpose">maximum number of nicks to show in &quot;Most referenced nicks&quot;</span></h3>
  1396. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1397. logfile = &quot;channel.log&quot;
  1398. format = &quot;mIRC&quot;
  1399. NickHistory = &quot;3&quot;
  1400. &lt;/channel&gt;
  1401. &lt;set NickHistory=&quot;15&quot;&gt;</pre>
  1402. <h4>Description</h4>
  1403. <p>With this option you can define how many nicks you want to appear in
  1404. the &quot;Most referenced nicks&quot; section. See also <a href="#ShowMrn">ShowMrn</a>.</p>
  1405. <h4>Default</h4>
  1406. <p>5</p>
  1407. </section>
  1408. <section class="option" id="SmileyHistory"><h3>SmileyHistory <span class="purpose">maximum number of smileys to show in smiley stats</span></h3>
  1409. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1410. logfile = &quot;channel.log&quot;
  1411. format = &quot;mIRC&quot;
  1412. SmileyHistory = &quot;3&quot;
  1413. &lt;/channel&gt;
  1414. &lt;set SmileyHistory=&quot;15&quot;&gt;</pre>
  1415. <h4>Description</h4>
  1416. <p>At most this many smileys will appear in smiley stats.
  1417. See also <a href="#ShowSmileys">ShowSmileys</a>.</p>
  1418. <h4>Default</h4>
  1419. <p>10</p>
  1420. </section>
  1421. <section class="option" id="KarmaHistory"><h3>KarmaHistory <span class="purpose">maximum number of nicks to show in &quot;Karma&quot;</span></h3>
  1422. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1423. logfile = &quot;channel.log&quot;
  1424. format = &quot;mIRC&quot;
  1425. KarmaHistory = &quot;3&quot;
  1426. &lt;/channel&gt;
  1427. &lt;set KarmaHistory=&quot;15&quot;&gt;</pre>
  1428. <h4>Description</h4>
  1429. <p>At most this many nicks will appear in the good and bad karma stats.
  1430. See also <a href="#ShowKarma">ShowKarma</a> and <a href="#NickLimit">NickLimit</a>.</p>
  1431. <h4>Default</h4>
  1432. <p>5</p>
  1433. </section>
  1434. <section class="option" id="NickTracking"><h3>NickTracking <span class="purpose">track nick changes and create aliases</span></h3>
  1435. <pre>&lt;set NickTracking=&quot;1&quot;&gt;</pre>
  1436. <h4>Description</h4>
  1437. <p>Enabling this option will track nick changes as well as it can. It will
  1438. then automatically create aliases for these nicks. Useful for
  1439. <a href="#ShowMostNicks">ShowMostNicks</a> and other stats.
  1440. Nick tracking does not work for log formats that do not use the nickname
  1441. for the person running the logger, but only show &quot;You&quot; there.
  1442. See <a href="#Maintainer">Maintainer</a>.</p>
  1443. <h4>Default</h4>
  1444. <p>0 (disabled)</p>
  1445. </section>
  1446. <section class="option" id="NickLimit"><h3>NickLimit <span class="purpose">maximum number of nicks in lists</span></h3>
  1447. <pre>&lt;set NickLimit=&quot;0&quot;&gt;</pre>
  1448. <h4>Description</h4>
  1449. <p>This option trims lists of nicks to a maximum length, replacing the rest
  1450. with &quot;...&quot;. Setting to 0 disables trimming. Affected are the used nicks in
  1451. the &quot;Users with most nicknames&quot; section, nicks in &quot;Most active genders&quot;,
  1452. and nicks in the &quot;Good/bad karma by&quot; columns. See
  1453. <a href="#ShowMostNicks">ShowMostNicks</a>, <a href="#ShowKarma">ShowKarma</a>, and
  1454. <a href="#ShowActiveGenders">ShowActiveGenders</a>.</p>
  1455. <h4>Default</h4>
  1456. <p>10</p>
  1457. </section>
  1458. <section class="option" id="SortByWords"><h3>SortByWords <span class="purpose">sort &quot;most active nicks&quot; by words</span></h3>
  1459. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1460. logfile = &quot;channel.log&quot;
  1461. format = &quot;xchat&quot;
  1462. SortByWords = &quot;0&quot;
  1463. &lt;/channel&gt;
  1464. &lt;set SortByWords=&quot;1&quot;&gt;</pre>
  1465. <h4>Description</h4>
  1466. <p>The default for the &quot;Most Active Nicks&quot; section - is to sort users by
  1467. lines. Enabling this will sort it by words instead.</p>
  1468. <h4>Default</h4>
  1469. <p>0 (disabled)</p>
  1470. </section>
  1471. </section>
  1472. <section class="chapter" id="reference-pictures"><h2>5. Picture options</h2>
  1473. <section class="option" id="PicLocation"><h3>PicLocation <span class="purpose">path to images on stats page</span></h3>
  1474. <pre>&lt;set PicLocation=&quot;gfx/&quot;&gt;</pre>
  1475. <h4>Description</h4>
  1476. <p>The location to the pictures used on the stats page - not the user
  1477. pictures but the different bars in &quot;Most Active Times&quot;.</p>
  1478. <h4>Default</h4>
  1479. <p>Current directory</p>
  1480. </section>
  1481. <section class="option" id="UserPics"><h3>UserPics <span class="purpose">number of user pictures per row</span></h3>
  1482. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1483. Logfile = &quot;channel.log&quot;
  1484. UserPics = &quot;no&quot;
  1485. &lt;/channel&gt;
  1486. &lt;set UserPics=&quot;3&quot;&gt;</pre>
  1487. <h4>Description</h4>
  1488. <p><code>UserPics</code> allows you to configure the number of user
  1489. pictures per row. Per default, one picture will be shown. Since pictures
  1490. are usually higher than one line of text, this lets the table grow. With
  1491. settings greater than 1, several pictures will be placed next to each
  1492. other. A good setting would be <code>UserPics</code>=3 and pictures
  1493. of size 60x60. Set <code>UserPics</code> to no or 0 to disable user
  1494. pictures. The latter is useful if you share a user config file between
  1495. channels and want to disable user pictures for some channels.</p>
  1496. <h4>Default</h4>
  1497. <p>yes (1)</p>
  1498. </section>
  1499. <section class="option" id="ImagePath"><h3>ImagePath <span class="purpose">path to user pictures (HTML page)</span></h3>
  1500. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1501. Logfile = &quot;channel.log&quot;
  1502. Format = &quot;mIRC&quot;
  1503. ImagePath = &quot;userpics/&quot;
  1504. &lt;/channel&gt;
  1505. &lt;set ImagePath=&quot;users/&quot;&gt;</pre>
  1506. <h4>Description</h4>
  1507. <p><code>ImagePath</code> defines the path to where user
  1508. pictures are located, relative to the HTML page generated. The default is
  1509. that user pictures is located in the same directory as the HTML page.</p>
  1510. <h4>Default</h4>
  1511. <p>current directory</p>
  1512. </section>
  1513. <section class="option" id="DefaultPic"><h3>DefaultPic <span class="purpose">use a default user picture</span></h3>
  1514. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1515. Logfile = &quot;channel.log&quot;
  1516. Format = &quot;mIRC&quot;
  1517. DefaultPic = &quot;not_available.jpg&quot;
  1518. &lt;/channel&gt;
  1519. &lt;set DefaultPic=&quot;unknown.gif&quot;&gt;</pre>
  1520. <h4>Description</h4>
  1521. <p><code>DefaultPic</code> defines a picture to be displayed for all
  1522. users which have no other picture defined in the <code>user</code>
  1523. element. This is good for showing &quot;No picture available&quot; or something.
  1524. May contain globbing patterns, see <a href="#ImageGlobPath">ImageGlobPath</a> below.</p>
  1525. <h4>Default</h4>
  1526. <p>unset</p>
  1527. </section>
  1528. <section class="option" id="ImageGlobPath"><h3>ImageGlobPath <span class="purpose">path to user pictures (output generation)</span></h3>
  1529. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1530. Logfile = &quot;channel.log&quot;
  1531. Format = &quot;mIRC&quot;
  1532. ImageGlobPath = &quot;users/&quot;
  1533. &lt;/channel&gt;
  1534. &lt;set ImageGlobPath=&quot;/var/www/pisg/&quot;&gt;
  1535. &lt;set DefaultPic=&quot;default-??.gif&quot;&gt;</pre>
  1536. <h4>Description</h4>
  1537. <p><code>ImageGlobPath</code> defines the path to the directory where
  1538. user pictures are located, relative to the current directory. This setting
  1539. is used to choose random pictures if ? or * (globbing characters) are used
  1540. in the picture name. ? matches a single character, * matches a (possibly
  1541. empty) string. The default is the <a href="#ImagePath">ImagePath</a> setting.
  1542. (NB: This setting will be different from <a href="#ImagePath">ImagePath</a> if
  1543. the latter is not relative to the current directory, e.g. if you are
  1544. writing the HTML file outside of the current directory.)</p>
  1545. <h4>Default</h4>
  1546. <p>current <a href="#ImagePath">ImagePath</a> setting</p>
  1547. </section>
  1548. <section class="option" id="PicWidth"><h3>PicWidth <span class="purpose">define a standard width for user pictures</span></h3>
  1549. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1550. Logfile = &quot;channel.log&quot;
  1551. Format = &quot;mIRC&quot;
  1552. PicWidth = &quot;500&quot;
  1553. &lt;/channel&gt;
  1554. &lt;set PicWidth=&quot;500&quot;&gt;</pre>
  1555. <h4>Description</h4>
  1556. <p><code>PicWidth</code> defines the standard width for user
  1557. pictures. Setting the &#x27;width&#x27; attribute of image-elements on the
  1558. outputted stats page. See also <a href="#PicHeight">PicHeight</a>.</p>
  1559. <h4>Default</h4>
  1560. <p>unset</p>
  1561. </section>
  1562. <section class="option" id="PicHeight"><h3>PicHeight <span class="purpose">define a standard height for user pictures</span></h3>
  1563. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1564. Logfile = &quot;channel.log&quot;
  1565. Format = &quot;mIRC&quot;
  1566. PicHeight = &quot;500&quot;
  1567. &lt;/channel&gt;
  1568. &lt;set PicHeight=&quot;500&quot;&gt;</pre>
  1569. <h4>Description</h4>
  1570. <p><code>PicHeight</code> defines the standard height for user
  1571. pictures. Setting the &#x27;height&#x27; attribute of image-elements on the
  1572. outputted stats page. See also <a href="#PicWidth">PicWidth</a>.</p>
  1573. <h4>Default</h4>
  1574. <p>unset</p>
  1575. </section>
  1576. </section>
  1577. <section class="chapter" id="reference-misc"><h2>6. Misc options</h2>
  1578. <section class="option" id="Charset"><h3>Charset <span class="purpose">character set to use for stats page</span></h3>
  1579. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1580. Logfile = &quot;channel.log&quot;
  1581. Format = &quot;xchat&quot;
  1582. Charset = &quot;utf-8&quot;
  1583. &lt;/channel&gt;
  1584. &lt;set Charset=&quot;iso-8859-15&quot;&gt;</pre>
  1585. <h4>Description</h4>
  1586. <p>The pisg stats page defines a character set in a meta tag, this can be
  1587. used if your country is using a different one than the default. Pisg
  1588. will also use this setting to convert the language templates from
  1589. <a href="#LangFile">LangFile</a> if the language defines a source charset.
  1590. Note: you also have to tell your webserver to transmit the charset to
  1591. the browser. With Apache, use &quot;AddDefaultCharset off&quot; in the server
  1592. config.</p>
  1593. <h4>Default</h4>
  1594. <p>iso-8859-1</p>
  1595. </section>
  1596. <section class="option" id="LogCharset"><h3>LogCharset <span class="purpose">character set for logfiles</span></h3>
  1597. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1598. Logfile = &quot;channel.log&quot;
  1599. Format = &quot;xchat&quot;
  1600. Charset = &quot;iso-8859-1&quot;
  1601. LogCharset = &quot;utf-8&quot;
  1602. &lt;/channel&gt;
  1603. &lt;set Charset=&quot;iso-8859-15&quot;&gt;
  1604. &lt;set LogCharset=&quot;iso-8859-15&quot;&gt;</pre>
  1605. <h4>Description</h4>
  1606. <p>If <code>LogCharset</code> is set and different from
  1607. <a href="#Charset">Charset</a>, pisg will convert the charset using
  1608. Text::Iconv. Using this option slows down log processing.</p>
  1609. <h4>Default</h4>
  1610. <p>empty (no conversion)</p>
  1611. </section>
  1612. <section class="option" id="LogCharsetFallback"><h3>LogCharsetFallback <span class="purpose">fallback character set for logfiles</span></h3>
  1613. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1614. Logfile = &quot;channel.log&quot;
  1615. Format = &quot;xchat&quot;
  1616. Charset = &quot;utf-8&quot;
  1617. LogCharset = &quot;utf-8&quot;
  1618. LogCharsetFallback = &quot;iso-8859-1&quot;
  1619. &lt;/channel&gt;
  1620. &lt;set Charset=&quot;utf-8&quot;&gt;
  1621. &lt;set LogCharset=&quot;utf-8&quot;&gt;
  1622. &lt;set LogCharsetFallback=&quot;iso-8859-15&quot;&gt;</pre>
  1623. <h4>Description</h4>
  1624. <p><code>LogCharsetFallback</code> defines a fallback charset for
  1625. the <a href="#LogCharset">LogCharset</a> conversion. This is useful if you
  1626. have mixed unicode/iso-8859-* logs. Pisg will first try the conversion
  1627. from <a href="#LogCharset">LogCharset</a>. If that fails,
  1628. <code>LogCharsetFallback</code> is used. Note that this only works
  1629. for charsets where certain byte sequences are illegal, like UTF-8. (In
  1630. short: <code>LogCharset</code> = utf-8,
  1631. <code>LogCharsetFallback</code> = iso-8859-15 works, the other way
  1632. round does not.)</p>
  1633. <h4>Default</h4>
  1634. <p>empty (no fallback conversion)</p>
  1635. </section>
  1636. <section class="option" id="TimeOffset"><h3>TimeOffset <span class="purpose">use a different time zone than the local machine</span></h3>
  1637. <pre>&lt;channel=&quot;#channel&quot;&gt;
  1638. Logfile = &quot;channel.log&quot;
  1639. Format = &quot;mIRC&quot;
  1640. Maintainer = &quot;John&quot;
  1641. TimeOffset = &quot;+5&quot;
  1642. &lt;/channel&gt;
  1643. &lt;set TimeOffset=&quot;+2&quot;&gt;</pre>
  1644. <h4>Description</h4>
  1645. <p>By default, pisg uses the time of the local machine to display the time
  1646. of the generated stats. Sometimes when you have a shell on an external
  1647. box, and it&#x27;s in another country, you want to use another time. This is
  1648. accomplished by the <code>TimeOffset</code> command.</p>
  1649. <h4>Default</h4>
  1650. <p>+0</p>
  1651. </section>
  1652. <section class="option" id="RegexpAliases"><h3>RegexpAliases <span class="purpose">use regular expressions in user aliases</span></h3>
  1653. <pre>&lt;user nick=&quot;Joe&quot; alias=&quot;Joe\d+&quot;&gt;
  1654. &lt;set RegexpAliases=&quot;1&quot;&gt;</pre>
  1655. <h4>Description</h4>
  1656. <p>Enabling this option will make all aliases in &lt;user&gt; lines be
  1657. parsed as regular expressions; this setting also applies to the
  1658. <a href="#IgnoreWords">IgnoreWords</a>, <a href="#FoulWords">FoulWords</a>, and
  1659. <a href="#ViolentWords">ViolentWords</a> settings.</p>
  1660. <h4>Default</h4>
  1661. <p>0 (disabled)</p>
  1662. </section>
  1663. <section class="option" id="LangFile"><h3>LangFile <span class="purpose">filename of language file</span></h3>
  1664. <pre>&lt;set LangFile=&quot;mylang.txt&quot;&gt;</pre>
  1665. <h4>Description</h4>
  1666. <p>With this option you have an alternative way to define the name and/or
  1667. path to the language file. Usually you don&#x27;t have to touch this option.</p>
  1668. <h4>Default</h4>
  1669. <p>lang.txt</p>
  1670. </section>
  1671. <section class="option" id="CssDir"><h3>CssDir <span class="purpose">path to directory with CSS files</span></h3>
  1672. <pre>&lt;set CssDir=&quot;/usr/share/pisg/layout/&quot;&gt;</pre>
  1673. <h4>Description</h4>
  1674. <p><code>CssDir</code> is used to define the paths to the CSS files
  1675. (the <a href="#ColorScheme">ColorScheme</a>s). Usually you don&#x27;t
  1676. need to change this. This setting is only used when statically including
  1677. the CSS file.</p>
  1678. <h4>Default</h4>
  1679. <p>layout/ (in current directory)</p>
  1680. </section>
  1681. <section class="option" id="HiCell"><h3>HiCell, HiCell2 <span class="purpose">colors for color gradient in most active nicks section</span></h3>
  1682. <pre>&lt;set HiCell=&quot;#BABADD&quot; HiCell2=&quot;#CCCCCC&quot;&gt;
  1683. &lt;set HiCell=&quot;&quot;&gt;</pre>
  1684. <h4>Description</h4>
  1685. <p><code>HiCell</code> and <code>HiCell2</code> define the colors
  1686. to be used for the color gradient in the most active nicks section. They should
  1687. match your <a href="#ColorScheme">ColorScheme</a>. When setting
  1688. <code>HiCell</code> the empty string (&quot;&quot;), pisg will not generate a color
  1689. gradient; you might want to use this with <a href="#ColorScheme">ColorScheme</a>=&quot;none&quot;
  1690. or <a href="#AltColorScheme">AltColorScheme</a>.</p>
  1691. <h4>Default</h4>
  1692. <p>#BABADD, #CCCCCC</p>
  1693. </section>
  1694. <section class="option" id="LogType"><h3>LogType <span class="purpose">type of log (not the format of the log)</span></h3>
  1695. <pre>&lt;set LogType=&quot;Logfile&quot;&gt;</pre>
  1696. <h4>Description</h4>
  1697. <p>The type of logs kept for your channel. Currently only &quot;Logfile&quot; is
  1698. supported, so you don&#x27;t need to change this option.</p>
  1699. <h4>Default</h4>
  1700. <p>Logfile</p>
  1701. </section>
  1702. <section class="option" id="StatsDump"><h3>StatsDump <span class="purpose">dump raw statistics into file</span></h3>
  1703. <pre>&lt;set StatsDump=&quot;statsdump&quot;&gt;</pre>
  1704. <h4>Description</h4>
  1705. <p>This option is intended for debugging pisg, but might be useful to process
  1706. the parsed logs with another program. The file contains the %stats and
  1707. %lines hashes in perl&#x27;s Data::Dumper format.</p>
  1708. <h4>Default</h4>
  1709. <p>Unset</p>
  1710. </section>
  1711. </section>
  1712. <section class="chapter" id="copyright"><h2>7. Copyright and License</h2>
  1713. <p>pisg - Perl IRC Statistics Generator</p>
  1714. <p>Copyright (C) 2001-2012 The pisg project</p>
  1715. <p>This program is free software; you can redistribute it and/or modify
  1716. it under the terms of the GNU General Public License as published by
  1717. the Free Software Foundation; either version 2 of the License, or
  1718. (at your option) any later version.</p>
  1719. <p>This program is distributed in the hope that it will be useful,
  1720. but WITHOUT ANY WARRANTY; without even the implied warranty of
  1721. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  1722. GNU General Public License for more details.</p>
  1723. <p>You should have received a copy of the GNU General Public License
  1724. along with this program; if not, write to the Free Software
  1725. Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</p>
  1726. </section>
  1727. <section class="chapter" id="example-config">
  1728. <h2>8. Complete example configuration</h2>
  1729. <p>A ready-to-use <code>pisg.cfg</code> for a channel called <code>#example</code>. It lists every
  1730. option pisg understands, with what it does, so you can copy it and change only the lines marked
  1731. <code>EDIT</code>: the log file, its format, the network name, the output file and your name.
  1732. Options are at pisg's own defaults unless the comment says <em>recommended</em>.</p>
  1733. <ol>
  1734. <li>Copy the file below (or download it) and save it as <code>pisg.cfg</code> next to <code>pisg</code>.</li>
  1735. <li>Change the <code>EDIT</code> values in the <code>&lt;channel&gt;</code> block.</li>
  1736. <li>Run <code>./pisg</code>.</li>
  1737. </ol>
  1738. <div class="codewrap">
  1739. <div class="codebar"><span>pisg.cfg</span>
  1740. <a class="btn" href="data:text/plain;charset=utf-8,%23%20pisg.cfg.example%20-%20a%20complete%20configuration%20for%20pisg%2C%20ready%20to%20copy.%0A%23%0A%23%20%20%201.%20Copy%20this%20file%20to%20pisg.cfg%0A%23%20%20%202.%20Change%20the%20values%20marked%20%20EDIT%20%20%28log%20path%2C%20format%2C%20network%2C%20output%20file%2C%20name%29%0A%23%20%20%203.%20Run%20./pisg%0A%23%0A%23%20Every%20option%20pisg%20understands%20is%20listed%20below%20with%20its%20meaning.%20Options%20are%20set%20to%0A%23%20pisg%27s%20own%20default%20unless%20the%20comment%20says%20%22recommended%22.%20Lines%20starting%20with%20%23%20are%0A%23%20comments%3B%20an%20option%20shown%20commented%20out%20is%20off/unset%20-%20remove%20the%20%23%20to%20use%20it.%0A%23%0A%23%20Syntax%20reminders%3A%0A%23%20%20%20%3Cset%20Name%3D%22value%22%3E%20%20%20%20%20%20a%20global%20option%2C%20applies%20to%20every%20channel%0A%23%20%20%20%3Cchannel%3D%22%23name%22%3E%20...%20%3C/channel%3E%20%20%20settings%20for%20one%20channel%20%28they%20override%20%3Cset%3E%29%0A%23%20%20%20%3Cuser%20nick%3D%22...%22%20...%3E%20%20%20per-user%20settings%0A%23%20Each%20%3Cset%3E%20must%20be%20on%20one%20line%2C%20and%20every%20value%20must%20be%20in%20quotes.%0A%0A%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%23%20%20GLOBAL%20OPTIONS%20-%20apply%20to%20every%20channel%20below%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%0A%23%20----%20General%20options%20-------------------------------------------------------%0A%0A%23%20use%20a%20different%20color%20scheme%20for%20stats%20page%20-%20recommended%3A%20modern%2C%20light/dark%20theme%3B%0A%23%20try%20midnight%2C%20amoled%2C%20terminal%2C%20or%20default%0A%3Cset%20ColorScheme%3D%22modern%22%3E%0A%0A%23%20alternate%20stylesheets%20for%20stats%20page%20-%20extra%20stylesheets%20the%20visitor%20can%20switch%20to%0A%23%3Cset%20AltColorScheme%3D%22midnight.css%20amoled.css%22%3E%0A%0A%23%20define%20the%20language%20/%20translation%20to%20use%0A%3Cset%20Lang%3D%22EN%22%3E%0A%0A%23%20define%20a%20file%20as%20page%20header%20-%20HTML%20file%20inserted%20above%20the%20statistics%0A%23%3Cset%20PageHead%3D%22header.html%22%3E%0A%0A%23%20define%20a%20file%20as%20page%20footer%20-%20HTML%20file%20inserted%20below%20the%20statistics%0A%23%3Cset%20PageFoot%3D%22footer.html%22%3E%0A%0A%23%20make%20pisg%20silent%2C%20suppress%20messages%0A%3Cset%20Silent%3D%220%22%3E%0A%0A%23%20use%20a%20cache%20to%20speed%20up%20log%20parsing%20-%20cache%20parsed%20logs%20here%20to%20speed%20up%20runs%20%28delete%0A%23%20it%20when%20you%20change%20settings%29%0A%23%3Cset%20CacheDir%3D%22cache/%22%3E%0A%0A%23%20name%20of%20the%20channel%20list%20file%20for%20a%20landing%20page%0A%3Cset%20ChannelIndex%3D%22channels.json%22%3E%0A%0A%23%20adds%20a%20button%20at%20the%20top%20of%20every%20stats%20page%20that%20leads%20back%20to%20your%20landing%20page%0A%3Cset%20HomeLink%3D%22%22%3E%0A%0A%23%20enable/disable%20the%20section%20bar%20at%20the%20top%20of%20the%20page%0A%3Cset%20ShowNavBar%3D%221%22%3E%0A%0A%23%20----%20Options%20for%20various%20statistics%20features%20-------------------------------%0A%0A%23%20number%20of%20days%20to%20show%20in%20%22Daily%20Actitity%22%20-%20recommended%3A%20show%20the%20last%2014%20days%20as%20a%0A%23%20bar%20chart%0A%3Cset%20DailyActivity%3D%2214%22%3E%0A%0A%23%20enable/disable%20%22Most%20Active%20Times%22%0A%3Cset%20ShowActiveTimes%3D%221%22%3E%0A%0A%23%20enable/disable%20%22Most%20Active%20Nicks%22%0A%3Cset%20ShowActiveNicks%3D%221%22%3E%0A%0A%23%20enable/disable%20%22Big%20Numbers%22%20sections%0A%3Cset%20ShowBigNumbers%3D%221%22%3E%0A%0A%23%20enable/disable%20%22Latest%20topics%22%20sections%0A%3Cset%20ShowTopics%3D%221%22%3E%0A%0A%23%20enable/disable%20%22number%20of%20lines%22%0A%3Cset%20ShowLines%3D%221%22%3E%0A%0A%23%20enable/disable%20%22words%20per%20line%22%20-%20recommended%3A%20also%20show%20words%20per%20line%0A%3Cset%20ShowWpl%3D%221%22%3E%0A%0A%23%20enable/disable%20%22characters%20per%20line%22%20-%20recommended%3A%20also%20show%20characters%20per%20line%0A%3Cset%20ShowCpl%3D%221%22%3E%0A%0A%23%20enable/disable%20%22number%20of%20words%22%20-%20recommended%3A%20also%20show%20total%20words%0A%3Cset%20ShowWords%3D%221%22%3E%0A%0A%23%20show%20when%20a%20user%20was%20last%20seen%20on%20a%20channel%0A%3Cset%20ShowLastSeen%3D%221%22%3E%0A%0A%23%20show%20when%20a%20nick%20was%20active%0A%3Cset%20ShowTime%3D%221%22%3E%0A%0A%23%20mIRCStats%20like%20behaviour%20of%20time%20bar%0A%3Cset%20ShowLineTime%3D%220%22%3E%0A%0A%23%20ShowLineTime%20like%20behavior%20of%20words%20column%0A%3Cset%20ShowWordTime%3D%220%22%3E%0A%0A%23%20enable%20or%20disable%20the%20random%20quotes%0A%3Cset%20ShowRandQuote%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20the%20legend%20of%20the%20time%20bars%0A%3Cset%20ShowLegend%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20the%20kick%20line%0A%3Cset%20ShowKickLine%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20the%20action%20line%0A%3Cset%20ShowActionLine%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20the%20shout%20line%0A%3Cset%20ShowShoutLine%3D%221%22%3E%0A%0A%23%20set%20how%20many%20decimals%20to%20show%0A%3Cset%20ShowFoulDecimals%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20the%20foul%20line%0A%3Cset%20ShowFoulLine%3D%220%22%3E%0A%0A%23%20enable%20or%20disable%20the%20violent%20lines%0A%3Cset%20ShowViolentLines%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20%22Most%20used%20words%22%0A%3Cset%20ShowMuw%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20%22Most%20referenced%20nicks%22%0A%3Cset%20ShowMrn%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20%22Most%20referenced%20URLs%22%0A%3Cset%20ShowMru%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20channel%20music%20charts%0A%3Cset%20ShowCharts%3D%220%22%3E%0A%0A%23%20enable%20or%20disable%20op%20statistics%0A%3Cset%20ShowOps%3D%221%22%3E%0A%0A%23%20enable%20or%20disable%20voice%20statistics%0A%3Cset%20ShowVoices%3D%220%22%3E%0A%0A%23%20enable%20or%20disable%20halfop%20statistics%0A%3Cset%20ShowHalfops%3D%220%22%3E%0A%0A%23%20show%20who%20changed%20nick%20most%20often%20-%20recommended%3A%20show%20who%20changed%20nick%20most%20often%0A%3Cset%20ShowMostNicks%3D%221%22%3E%0A%0A%23%20show%20stats%20on%20which%20gender%20talked%20most%0A%3Cset%20ShowActiveGenders%3D%220%22%3E%0A%0A%23%20show%20most%20used%20smileys%20-%20recommended%3A%20show%20the%20most%20used%20smileys%0A%3Cset%20ShowSmileys%3D%221%22%3E%0A%0A%23%20show%20channel%20karma%20-%20recommended%3A%20show%20karma%20%28nick%2B%2B%20/%20nick--%29%0A%3Cset%20ShowKarma%3D%221%22%3E%0A%0A%23%20show%20most%20active%20nicks%20by%20hour%20-%20recommended%3A%20show%20the%20most%20active%20nicks%20by%20time%20of%0A%23%20day%0A%3Cset%20ShowMostActiveByHour%3D%221%22%3E%0A%0A%23%20only%20count%20stats%20for%20top%20talkers%2C%20ignore%20less-active%20users%0A%3Cset%20ShowOnlyTop%3D%220%22%3E%0A%0A%23%20show%20graphs%20in%20most%20active%20nicks%20by%20hour%0A%3Cset%20ShowMostActiveByHourGraph%3D%221%22%3E%0A%0A%23%20enable/disable%20the%20channel%20overview%0A%3Cset%20ShowOverview%3D%221%22%3E%0A%0A%23%20enable/disable%20the%20relation%20map%20and%20its%20tables%0A%3Cset%20ShowRelations%3D%221%22%3E%0A%0A%23%20number%20of%20nicks%20on%20the%20relation%20map%0A%3Cset%20RelationNicks%3D%2230%22%3E%0A%0A%23%20minimum%20connection%20strength%20shown%20as%20a%20line%20on%20the%20relation%20map%0A%3Cset%20RelationMinWeight%3D%223%22%3E%0A%0A%23%20enable/disable%20the%20time%20personalities%20section%0A%3Cset%20ShowTimePersonalities%3D%221%22%3E%0A%0A%23%20enable/disable%20the%20%22who%20carries%20the%20channel%22%20section%0A%3Cset%20ShowConcentration%3D%221%22%3E%0A%0A%23%20enable/disable%20the%20signature%20words%20section%0A%3Cset%20ShowSignatureWords%3D%221%22%3E%0A%0A%23%20ignore%20specified%20words%20-%20words%20to%20leave%20out%20of%20the%20word%20statistics%0A%23%3Cset%20IgnoreWords%3D%22badword%20otherword%22%3E%0A%0A%23%20Control%20random%20quote%20output%0A%3Cset%20NoIgnoredQuotes%3D%220%22%3E%0A%0A%23%20specify%20words%20considered%20to%20be%20bad/FoulWords%20language%0A%3Cset%20FoulWords%3D%22ass%20fuck%20bitch%20shit%20scheisse%20schei%C3%9Fe%20kacke%20arsch%20ficker%20ficken%20schlampe%22%3E%0A%0A%23%20specify%20words%20considered%20to%20be%20aggressive/violent%0A%3Cset%20ViolentWords%3D%22slaps%20beats%20smacks%22%3E%0A%0A%23%20words%20that%20keep%20a%20URL%20out%20of%20the%20URL%20statistics%20-%20matched%20anywhere%20in%20a%20URL%2C%20any%20case%3B%0A%23%20%2A%20%3D%20any%20characters%2C%20%3F%20%3D%20one%3B%20for%20spam%20and%20unwanted%20image%20hosts%0A%23%3Cset%20BadUrls%3D%22imagetwist%20imgur.com%20postimg.cc/%2A%22%3E%0A%0A%23%20minimum%20numbers%20of%20letters%20for%20a%20random%20quote%0A%3Cset%20MinQuote%3D%2225%22%3E%0A%0A%23%20maximum%20numbers%20of%20letters%20for%20a%20random%20quote%0A%3Cset%20MaxQuote%3D%2265%22%3E%0A%0A%23%20minimum%20number%20of%20characters%20in%20an%20interesting%20word%0A%3Cset%20WordLength%3D%225%22%3E%0A%0A%23%20maximum%20allowed%20length%20of%20a%20%22word%22%20with%20no%20spaces%0A%3Cset%20QuoteWidth%3D%2280%22%3E%0A%0A%23%20Minimum%20number%20of%20lines%20per%20user%20for%20some%20%22Big%20Numbers%22%20statistics%0A%3Cset%20BigNumbersThreshold%3D%22sqrt%22%3E%0A%0A%23%20nicks%20to%20show%20in%20%22Most%20Active%20Nicks%22%0A%3Cset%20ActiveNicks%3D%2225%22%3E%0A%0A%23%20nicks%20to%20show%20in%20%22These%20didn%27t%20make%20it..%22%0A%3Cset%20ActiveNicks2%3D%2230%22%3E%0A%0A%23%20number%20of%20nicks%20to%20show%20in%20%22Most%20Active%20Nicks%20By%20Hour%22%0A%3Cset%20ActiveNicksByHour%3D%2210%22%3E%0A%0A%23%20maximum%20number%20of%20nicks%20to%20show%20in%20%22users%20with%20most%20nicknames%22%0A%3Cset%20MostNicksHistory%3D%225%22%3E%0A%0A%23%20show%20nicks%20used%20in%20%22most%20nicks%22%0A%3Cset%20MostNicksVerbose%3D%221%22%3E%0A%0A%23%20maximum%20number%20of%20topics%20to%20show%20-%20recommended%3A%20show%20the%20last%205%20topics%0A%3Cset%20TopicHistory%3D%225%22%3E%0A%0A%23%20maximum%20number%20of%20URLs%20to%20show%0A%3Cset%20UrlHistory%3D%225%22%3E%0A%0A%23%20number%20of%20songs%20to%20show%0A%3Cset%20ChartsHistory%3D%225%22%3E%0A%0A%23%20how%20to%20recognize%20songs%20played%0A%3Cset%20ChartsRegexp%3D%22%28%3F%3Ais%20%29%3F%28%3F%3Anp%3A%7C%28%3F%3Anow%20%29%3Fplaying%3A%3F%20%7Clistening%20to%3A%3F%20%29%28%3F%3AMPEG%20stream%20from%29%3F%5Cs%2A%28.%2A%29%22%3E%0A%0A%23%20maximum%20number%20of%20words%20to%20show%0A%3Cset%20WordHistory%3D%2210%22%3E%0A%0A%23%20maximum%20number%20of%20nicks%20to%20show%20in%20%22Most%20referenced%20nicks%22%0A%3Cset%20NickHistory%3D%225%22%3E%0A%0A%23%20maximum%20number%20of%20smileys%20to%20show%20in%20smiley%20stats%0A%3Cset%20SmileyHistory%3D%2210%22%3E%0A%0A%23%20maximum%20number%20of%20nicks%20to%20show%20in%20%22Karma%22%0A%3Cset%20KarmaHistory%3D%225%22%3E%0A%0A%23%20track%20nick%20changes%20and%20create%20aliases%20-%20recommended%3A%20follow%20nick%20changes%20so%20Alice%2C%0A%23%20Alice_%20and%20Alice-%20count%20as%20one%20person%0A%3Cset%20NickTracking%3D%221%22%3E%0A%0A%23%20maximum%20number%20of%20nicks%20in%20lists%0A%3Cset%20NickLimit%3D%2210%22%3E%0A%0A%23%20sort%20%22most%20active%20nicks%22%20by%20words%0A%3Cset%20SortByWords%3D%220%22%3E%0A%0A%23%20----%20Picture%20options%20-------------------------------------------------------%0A%0A%23%20path%20to%20images%20on%20stats%20page%0A%3Cset%20PicLocation%3D%22.%22%3E%0A%0A%23%20number%20of%20user%20pictures%20per%20row%0A%3Cset%20UserPics%3D%221%22%3E%0A%0A%23%20path%20to%20user%20pictures%20%28HTML%20page%29%20-%20folder%20of%20user%20pictures%2C%20as%20seen%20by%20the%20web%20page%0A%23%3Cset%20ImagePath%3D%22images/%22%3E%0A%0A%23%20use%20a%20default%20user%20picture%20-%20picture%20shown%20for%20users%20who%20have%20none%0A%23%3Cset%20DefaultPic%3D%22images/nobody.png%22%3E%0A%0A%23%20path%20to%20user%20pictures%20%28output%20generation%29%20-%20folder%20of%20user%20pictures%2C%20as%20seen%20by%20pisg%0A%23%20%28for%20pic%3D%22x_%2A.jpg%22%20globs%29%0A%23%3Cset%20ImageGlobPath%3D%22/var/www/pisg/images/%22%3E%0A%0A%23%20define%20a%20standard%20width%20for%20user%20pictures%20-%20show%20every%20user%20picture%20this%20wide%2C%20in%0A%23%20pixels%0A%23%3Cset%20PicWidth%3D%2255%22%3E%0A%0A%23%20define%20a%20standard%20height%20for%20user%20pictures%20-%20show%20every%20user%20picture%20this%20tall%2C%20in%0A%23%20pixels%0A%23%3Cset%20PicHeight%3D%2255%22%3E%0A%0A%23%20----%20Misc%20options%20----------------------------------------------------------%0A%0A%23%20character%20set%20to%20use%20for%20stats%20page%20-%20recommended%3A%20UTF-8%20shows%20accents%2C%20emoji%20and%20non-%0A%23%20Latin%20scripts%20correctly%0A%3Cset%20Charset%3D%22utf-8%22%3E%0A%0A%23%20character%20set%20for%20logfiles%20-%20convert%20logs%20from%20this%20charset%20%28needs%20the%20Text%3A%3AIconv%0A%23%20perl%20module%29%0A%23%3Cset%20LogCharset%3D%22iso-8859-1%22%3E%0A%0A%23%20fallback%20character%20set%20for%20logfiles%20-%20used%20for%20lines%20that%20are%20not%20valid%20in%20LogCharset%0A%23%20%28needs%20Text%3A%3AIconv%29%0A%23%3Cset%20LogCharsetFallback%3D%22iso-8859-1%22%3E%0A%0A%23%20use%20a%20different%20time%20zone%20than%20the%20local%20machine%0A%3Cset%20TimeOffset%3D%22%2B0%22%3E%0A%0A%23%20use%20regular%20expressions%20in%20user%20aliases%0A%3Cset%20RegexpAliases%3D%220%22%3E%0A%0A%23%20filename%20of%20language%20file%0A%3Cset%20LangFile%3D%22lang.txt%22%3E%0A%0A%23%20path%20to%20directory%20with%20CSS%20files%0A%3Cset%20CssDir%3D%22layout/%22%3E%0A%0A%23%20colors%20for%20color%20gradient%20in%20most%20active%20nicks%20section%0A%3Cset%20HiCell%3D%22%23BABADD%22%3E%0A%3Cset%20HiCell2%3D%22%23CCCCCC%22%3E%0A%0A%23%20colors%20for%20color%20gradient%20in%20most%20active%20nicks%20section%0A%3Cset%20HiCell2%3D%22%23CCCCCC%22%3E%0A%0A%23%20dump%20raw%20statistics%20into%20file%20-%20debugging%3A%20dump%20the%20raw%20statistics%20to%20this%20file%0A%23%3Cset%20StatsDump%3D%22stats.dump%22%3E%0A%0A%23%20----%20Advanced%20%28not%20in%20the%20original%20documentation%29%20-------------------------%0A%0A%23%20nicks%20of%20bots%2C%20for%20log%20formats%20that%20cannot%20tell%20bots%20from%20people%20%28DCpp%29%0A%23%3Cset%20BotNicks%3D%22bot1%20bot2%22%3E%0A%0A%23%20width%20in%20pixels%20of%20the%20statistics%20tables%0A%3Cset%20TableWidth%3D%22574%22%3E%0A%0A%23%20image%20id%20of%20the%20horizontal%20bar%20for%20hours%200-5%0A%3Cset%20Pic_H_0%3D%22blue-h%22%3E%0A%0A%23%20image%20id%20of%20the%20horizontal%20bar%20for%20hours%206-11%0A%3Cset%20Pic_H_6%3D%22green-h%22%3E%0A%0A%23%20image%20id%20of%20the%20horizontal%20bar%20for%20hours%2012-17%0A%3Cset%20Pic_H_12%3D%22yellow-h%22%3E%0A%0A%23%20image%20id%20of%20the%20horizontal%20bar%20for%20hours%2018-23%0A%3Cset%20Pic_H_18%3D%22red-h%22%3E%0A%0A%23%20image%20id%20of%20the%20vertical%20bar%20for%20hours%200-5%0A%3Cset%20Pic_V_0%3D%22blue-v%22%3E%0A%0A%23%20image%20id%20of%20the%20vertical%20bar%20for%20hours%206-11%0A%3Cset%20Pic_V_6%3D%22green-v%22%3E%0A%0A%23%20image%20id%20of%20the%20vertical%20bar%20for%20hours%2012-17%0A%3Cset%20Pic_V_12%3D%22yellow-v%22%3E%0A%0A%23%20image%20id%20of%20the%20vertical%20bar%20for%20hours%2018-23%0A%3Cset%20Pic_V_18%3D%22red-v%22%3E%0A%0A%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%23%20%20YOUR%20CHANNEL%20-%20copy%20this%20block%20for%20each%20extra%20channel%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%0A%3Cchannel%3D%22%23example%22%3E%0A%20%20%23%20Logfile%3A%20the%20log%20to%20read%3B%20you%20can%20list%20several%20Logfile%20lines%20%20EDIT%0A%20%20Logfile%3D%22/path/to/example.log%22%0A%0A%20%20%23%20LogDir%3A%20use%20INSTEAD%20of%20Logfile%20to%20read%20a%20whole%20folder%20of%20dated%20logs%0A%20%20%23LogDir%3D%22/path/to/logs/%22%0A%0A%20%20%23%20LogPrefix%3A%20with%20LogDir%3A%20only%20read%20files%20starting%20with%20this%0A%20%20%23LogPrefix%3D%22example.log.%22%0A%0A%20%20%23%20LogSuffix%3A%20with%20LogDir%3A%20date%20format%20at%20the%20end%20of%20the%20file%20names%2C%20so%20they%20sort%20by%0A%20%20%23%20date%0A%20%20%23LogSuffix%3D%22.%25d%25b%25Y%22%0A%0A%20%20%23%20NFiles%3A%20with%20LogDir%3A%20only%20parse%20the%20newest%20N%20files%20%280%20%3D%20all%29%0A%20%20%23NFiles%3D%2230%22%0A%0A%20%20%23%20Format%3A%20your%20log%20format%3A%20eggdrop%2C%20mIRC%2C%20xchat%2C%20irssi%2C%20...%20%28see%20docs/FORMATS%29%20%20EDIT%0A%20%20Format%3D%22eggdrop%22%0A%0A%20%20%23%20Network%3A%20the%20IRC%20network%2C%20shown%20on%20the%20page%20%20EDIT%0A%20%20Network%3D%22ExampleNet%22%0A%0A%20%20%23%20OutputFile%3A%20the%20page%20pisg%20writes%20%20EDIT%0A%20%20OutputFile%3D%22/var/www/html/example.html%22%0A%0A%20%20%23%20OutputTag%3A%20replaces%20%25t%20in%20OutputFile%3B%20used%20with%20the%20-nf%20/%20-t%20command%20line%20options%0A%20%20%23OutputTag%3D%22-week%22%0A%0A%20%20%23%20Maintainer%3A%20who%20is%20named%20as%20maintainer%20on%20the%20page%20%20EDIT%0A%20%20Maintainer%3D%22Your%20Name%22%0A%0A%20%20%23%20LogType%3A%20only%20%22Logfile%22%20exists%2C%20leave%20it%0A%20%20LogType%3D%22Logfile%22%0A%0A%20%20%23%20Any%20global%20option%20can%20be%20overridden%20for%20this%20channel%20only%2C%20for%20example%3A%0A%20%20%23Lang%3D%22FR%22%0A%20%20%23ColorScheme%3D%22midnight%22%0A%3C/channel%3E%0A%0A%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%23%20%20USERS%20-%20link%20nicks%20together%2C%20add%20pictures%2C%20mark%20bots%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%23%20nick%20%20%20%20the%20name%20shown%20in%20the%20stats%20%28required%29%0A%23%20alias%20%20%20other%20nicks%20of%20the%20same%20person%2C%20space%20separated%3B%20%2A%20matches%20anything%0A%23%20%20%20%20%20%20%20%20%20%28Joe%2A%20also%20counts%20Joe_%2C%20Joe%5Eaway%20...%29.%20NickTracking%3D%221%22%20also%20finds%20many%0A%23%20pic%20%20%20%20%20picture%20shown%20next%20to%20the%20user%20%20%20%20%20%20bigpic%20%20larger%20picture%20it%20links%20to%0A%23%20link%20%20%20%20a%20web%20address%20or%20e-mail%20address%20%20%20%20%20%20sex%20%20%20%20%20m%2C%20f%20or%20b%20%28bot%29%0A%23%20ignore%20%20y%20%3D%20leave%20this%20nick%20out%20of%20the%20stats%20altogether%20%28for%20bots%29%0A%0A%3Cuser%20nick%3D%22Alice%22%20alias%3D%22Alice_%20Alice-%2A%20AliceAway%22%20pic%3D%22alice.png%22%20link%3D%22https%3A//example.com/alice%22%20sex%3D%22f%22%3E%0A%3Cuser%20nick%3D%22Bob%22%20alias%3D%22Bob_%20Bobby%22%20pic%3D%22bob.png%22%20bigpic%3D%22bob-big.png%22%20link%3D%22bob%40example.com%22%20sex%3D%22m%22%3E%0A%3Cuser%20nick%3D%22ChanBot%22%20sex%3D%22b%22%20ignore%3D%22y%22%3E%0A%3Cuser%20nick%3D%22Seb%22%20alias%3D%22Seb-%20Seb_%22%20pic%3D%22https%3A//r2.fivemanage.com/X8I0LGoLdHY2Wx9DdTrvx/Pics/me.png%22%20sex%3D%22m%22%20link%3D%22https%3A//dooubletap.github.io/%22%3E%0A%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%23%20%20LINKS%20-%20keep%20addresses%20out%20of%20%22Most%20referenced%20URLs%22%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%3Clink%20url%3D%22https%3A//example.com/spam%22%20ignore%3D%22y%22%3E%0A%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%23%20%20INCLUDE%20-%20share%20users%20between%20channels%20or%20config%20files%0A%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%23%0A%23%20Put%20your%20%3Cuser%3E%20lines%20in%20users.cfg%20and%20load%20them%20here%20%28an%20included%20file%20cannot%0A%23%20include%20another%20file%29%3A%0A%23%3Cinclude%3D%22users.cfg%22%3E%0A" download="pisg.cfg">Download</a>
  1741. <button class="btn copy" type="button" data-target="cfg-example">Copy</button></div>
  1742. <pre id="cfg-example" class="cfg"># pisg.cfg.example - a complete configuration for pisg, ready to copy.
  1743. #
  1744. # 1. Copy this file to pisg.cfg
  1745. # 2. Change the values marked EDIT (log path, format, network, output file, name)
  1746. # 3. Run ./pisg
  1747. #
  1748. # Every option pisg understands is listed below with its meaning. Options are set to
  1749. # pisg&#x27;s own default unless the comment says &quot;recommended&quot;. Lines starting with # are
  1750. # comments; an option shown commented out is off/unset - remove the # to use it.
  1751. #
  1752. # Syntax reminders:
  1753. # &lt;set Name=&quot;value&quot;&gt; a global option, applies to every channel
  1754. # &lt;channel=&quot;#name&quot;&gt; ... &lt;/channel&gt; settings for one channel (they override &lt;set&gt;)
  1755. # &lt;user nick=&quot;...&quot; ...&gt; per-user settings
  1756. # Each &lt;set&gt; must be on one line, and every value must be in quotes.
  1757. ##############################################################################
  1758. # GLOBAL OPTIONS - apply to every channel below
  1759. ##############################################################################
  1760. # ---- General options -------------------------------------------------------
  1761. # use a different color scheme for stats page - recommended: modern, light/dark theme;
  1762. # try midnight, amoled, terminal, or default
  1763. &lt;set ColorScheme=&quot;modern&quot;&gt;
  1764. # alternate stylesheets for stats page - extra stylesheets the visitor can switch to
  1765. #&lt;set AltColorScheme=&quot;midnight.css amoled.css&quot;&gt;
  1766. # define the language / translation to use
  1767. &lt;set Lang=&quot;EN&quot;&gt;
  1768. # define a file as page header - HTML file inserted above the statistics
  1769. #&lt;set PageHead=&quot;header.html&quot;&gt;
  1770. # define a file as page footer - HTML file inserted below the statistics
  1771. #&lt;set PageFoot=&quot;footer.html&quot;&gt;
  1772. # make pisg silent, suppress messages
  1773. &lt;set Silent=&quot;0&quot;&gt;
  1774. # use a cache to speed up log parsing - cache parsed logs here to speed up runs (delete
  1775. # it when you change settings)
  1776. #&lt;set CacheDir=&quot;cache/&quot;&gt;
  1777. # name of the channel list file for a landing page
  1778. &lt;set ChannelIndex=&quot;channels.json&quot;&gt;
  1779. # adds a button at the top of every stats page that leads back to your landing page
  1780. &lt;set HomeLink=&quot;&quot;&gt;
  1781. # enable/disable the section bar at the top of the page
  1782. &lt;set ShowNavBar=&quot;1&quot;&gt;
  1783. # ---- Options for various statistics features -------------------------------
  1784. # number of days to show in &quot;Daily Actitity&quot; - recommended: show the last 14 days as a
  1785. # bar chart
  1786. &lt;set DailyActivity=&quot;14&quot;&gt;
  1787. # enable/disable &quot;Most Active Times&quot;
  1788. &lt;set ShowActiveTimes=&quot;1&quot;&gt;
  1789. # enable/disable &quot;Most Active Nicks&quot;
  1790. &lt;set ShowActiveNicks=&quot;1&quot;&gt;
  1791. # enable/disable &quot;Big Numbers&quot; sections
  1792. &lt;set ShowBigNumbers=&quot;1&quot;&gt;
  1793. # enable/disable &quot;Latest topics&quot; sections
  1794. &lt;set ShowTopics=&quot;1&quot;&gt;
  1795. # enable/disable &quot;number of lines&quot;
  1796. &lt;set ShowLines=&quot;1&quot;&gt;
  1797. # enable/disable &quot;words per line&quot; - recommended: also show words per line
  1798. &lt;set ShowWpl=&quot;1&quot;&gt;
  1799. # enable/disable &quot;characters per line&quot; - recommended: also show characters per line
  1800. &lt;set ShowCpl=&quot;1&quot;&gt;
  1801. # enable/disable &quot;number of words&quot; - recommended: also show total words
  1802. &lt;set ShowWords=&quot;1&quot;&gt;
  1803. # show when a user was last seen on a channel
  1804. &lt;set ShowLastSeen=&quot;1&quot;&gt;
  1805. # show when a nick was active
  1806. &lt;set ShowTime=&quot;1&quot;&gt;
  1807. # mIRCStats like behaviour of time bar
  1808. &lt;set ShowLineTime=&quot;0&quot;&gt;
  1809. # ShowLineTime like behavior of words column
  1810. &lt;set ShowWordTime=&quot;0&quot;&gt;
  1811. # enable or disable the random quotes
  1812. &lt;set ShowRandQuote=&quot;1&quot;&gt;
  1813. # enable or disable the legend of the time bars
  1814. &lt;set ShowLegend=&quot;1&quot;&gt;
  1815. # enable or disable the kick line
  1816. &lt;set ShowKickLine=&quot;1&quot;&gt;
  1817. # enable or disable the action line
  1818. &lt;set ShowActionLine=&quot;1&quot;&gt;
  1819. # enable or disable the shout line
  1820. &lt;set ShowShoutLine=&quot;1&quot;&gt;
  1821. # set how many decimals to show
  1822. &lt;set ShowFoulDecimals=&quot;1&quot;&gt;
  1823. # enable or disable the foul line
  1824. &lt;set ShowFoulLine=&quot;0&quot;&gt;
  1825. # enable or disable the violent lines
  1826. &lt;set ShowViolentLines=&quot;1&quot;&gt;
  1827. # enable or disable &quot;Most used words&quot;
  1828. &lt;set ShowMuw=&quot;1&quot;&gt;
  1829. # enable or disable &quot;Most referenced nicks&quot;
  1830. &lt;set ShowMrn=&quot;1&quot;&gt;
  1831. # enable or disable &quot;Most referenced URLs&quot;
  1832. &lt;set ShowMru=&quot;1&quot;&gt;
  1833. # enable or disable channel music charts
  1834. &lt;set ShowCharts=&quot;0&quot;&gt;
  1835. # enable or disable op statistics
  1836. &lt;set ShowOps=&quot;1&quot;&gt;
  1837. # enable or disable voice statistics
  1838. &lt;set ShowVoices=&quot;0&quot;&gt;
  1839. # enable or disable halfop statistics
  1840. &lt;set ShowHalfops=&quot;0&quot;&gt;
  1841. # show who changed nick most often - recommended: show who changed nick most often
  1842. &lt;set ShowMostNicks=&quot;1&quot;&gt;
  1843. # show stats on which gender talked most
  1844. &lt;set ShowActiveGenders=&quot;0&quot;&gt;
  1845. # show most used smileys - recommended: show the most used smileys
  1846. &lt;set ShowSmileys=&quot;1&quot;&gt;
  1847. # show channel karma - recommended: show karma (nick++ / nick--)
  1848. &lt;set ShowKarma=&quot;1&quot;&gt;
  1849. # show most active nicks by hour - recommended: show the most active nicks by time of
  1850. # day
  1851. &lt;set ShowMostActiveByHour=&quot;1&quot;&gt;
  1852. # only count stats for top talkers, ignore less-active users
  1853. &lt;set ShowOnlyTop=&quot;0&quot;&gt;
  1854. # show graphs in most active nicks by hour
  1855. &lt;set ShowMostActiveByHourGraph=&quot;1&quot;&gt;
  1856. # enable/disable the channel overview
  1857. &lt;set ShowOverview=&quot;1&quot;&gt;
  1858. # enable/disable the relation map and its tables
  1859. &lt;set ShowRelations=&quot;1&quot;&gt;
  1860. # number of nicks on the relation map
  1861. &lt;set RelationNicks=&quot;30&quot;&gt;
  1862. # minimum connection strength shown as a line on the relation map
  1863. &lt;set RelationMinWeight=&quot;3&quot;&gt;
  1864. # enable/disable the time personalities section
  1865. &lt;set ShowTimePersonalities=&quot;1&quot;&gt;
  1866. # enable/disable the &quot;who carries the channel&quot; section
  1867. &lt;set ShowConcentration=&quot;1&quot;&gt;
  1868. # enable/disable the signature words section
  1869. &lt;set ShowSignatureWords=&quot;1&quot;&gt;
  1870. # ignore specified words - words to leave out of the word statistics
  1871. #&lt;set IgnoreWords=&quot;badword otherword&quot;&gt;
  1872. # Control random quote output
  1873. &lt;set NoIgnoredQuotes=&quot;0&quot;&gt;
  1874. # specify words considered to be bad/FoulWords language
  1875. &lt;set FoulWords=&quot;ass fuck bitch shit scheisse scheiße kacke arsch ficker ficken schlampe&quot;&gt;
  1876. # specify words considered to be aggressive/violent
  1877. &lt;set ViolentWords=&quot;slaps beats smacks&quot;&gt;
  1878. # words that keep a URL out of the URL statistics - matched anywhere in a URL, any case;
  1879. # * = any characters, ? = one; for spam and unwanted image hosts
  1880. #&lt;set BadUrls=&quot;imagetwist imgur.com postimg.cc/*&quot;&gt;
  1881. # minimum numbers of letters for a random quote
  1882. &lt;set MinQuote=&quot;25&quot;&gt;
  1883. # maximum numbers of letters for a random quote
  1884. &lt;set MaxQuote=&quot;65&quot;&gt;
  1885. # minimum number of characters in an interesting word
  1886. &lt;set WordLength=&quot;5&quot;&gt;
  1887. # maximum allowed length of a &quot;word&quot; with no spaces
  1888. &lt;set QuoteWidth=&quot;80&quot;&gt;
  1889. # Minimum number of lines per user for some &quot;Big Numbers&quot; statistics
  1890. &lt;set BigNumbersThreshold=&quot;sqrt&quot;&gt;
  1891. # nicks to show in &quot;Most Active Nicks&quot;
  1892. &lt;set ActiveNicks=&quot;25&quot;&gt;
  1893. # nicks to show in &quot;These didn&#x27;t make it..&quot;
  1894. &lt;set ActiveNicks2=&quot;30&quot;&gt;
  1895. # number of nicks to show in &quot;Most Active Nicks By Hour&quot;
  1896. &lt;set ActiveNicksByHour=&quot;10&quot;&gt;
  1897. # maximum number of nicks to show in &quot;users with most nicknames&quot;
  1898. &lt;set MostNicksHistory=&quot;5&quot;&gt;
  1899. # show nicks used in &quot;most nicks&quot;
  1900. &lt;set MostNicksVerbose=&quot;1&quot;&gt;
  1901. # maximum number of topics to show - recommended: show the last 5 topics
  1902. &lt;set TopicHistory=&quot;5&quot;&gt;
  1903. # maximum number of URLs to show
  1904. &lt;set UrlHistory=&quot;5&quot;&gt;
  1905. # number of songs to show
  1906. &lt;set ChartsHistory=&quot;5&quot;&gt;
  1907. # how to recognize songs played
  1908. &lt;set ChartsRegexp=&quot;(?:is )?(?:np:|(?:now )?playing:? |listening to:? )(?:MPEG stream from)?\s*(.*)&quot;&gt;
  1909. # maximum number of words to show
  1910. &lt;set WordHistory=&quot;10&quot;&gt;
  1911. # maximum number of nicks to show in &quot;Most referenced nicks&quot;
  1912. &lt;set NickHistory=&quot;5&quot;&gt;
  1913. # maximum number of smileys to show in smiley stats
  1914. &lt;set SmileyHistory=&quot;10&quot;&gt;
  1915. # maximum number of nicks to show in &quot;Karma&quot;
  1916. &lt;set KarmaHistory=&quot;5&quot;&gt;
  1917. # track nick changes and create aliases - recommended: follow nick changes so Alice,
  1918. # Alice_ and Alice- count as one person
  1919. &lt;set NickTracking=&quot;1&quot;&gt;
  1920. # maximum number of nicks in lists
  1921. &lt;set NickLimit=&quot;10&quot;&gt;
  1922. # sort &quot;most active nicks&quot; by words
  1923. &lt;set SortByWords=&quot;0&quot;&gt;
  1924. # ---- Picture options -------------------------------------------------------
  1925. # path to images on stats page
  1926. &lt;set PicLocation=&quot;.&quot;&gt;
  1927. # number of user pictures per row
  1928. &lt;set UserPics=&quot;1&quot;&gt;
  1929. # path to user pictures (HTML page) - folder of user pictures, as seen by the web page
  1930. #&lt;set ImagePath=&quot;images/&quot;&gt;
  1931. # use a default user picture - picture shown for users who have none
  1932. #&lt;set DefaultPic=&quot;images/nobody.png&quot;&gt;
  1933. # path to user pictures (output generation) - folder of user pictures, as seen by pisg
  1934. # (for pic=&quot;x_*.jpg&quot; globs)
  1935. #&lt;set ImageGlobPath=&quot;/var/www/pisg/images/&quot;&gt;
  1936. # define a standard width for user pictures - show every user picture this wide, in
  1937. # pixels
  1938. #&lt;set PicWidth=&quot;55&quot;&gt;
  1939. # define a standard height for user pictures - show every user picture this tall, in
  1940. # pixels
  1941. #&lt;set PicHeight=&quot;55&quot;&gt;
  1942. # ---- Misc options ----------------------------------------------------------
  1943. # character set to use for stats page - recommended: UTF-8 shows accents, emoji and non-
  1944. # Latin scripts correctly
  1945. &lt;set Charset=&quot;utf-8&quot;&gt;
  1946. # character set for logfiles - convert logs from this charset (needs the Text::Iconv
  1947. # perl module)
  1948. #&lt;set LogCharset=&quot;iso-8859-1&quot;&gt;
  1949. # fallback character set for logfiles - used for lines that are not valid in LogCharset
  1950. # (needs Text::Iconv)
  1951. #&lt;set LogCharsetFallback=&quot;iso-8859-1&quot;&gt;
  1952. # use a different time zone than the local machine
  1953. &lt;set TimeOffset=&quot;+0&quot;&gt;
  1954. # use regular expressions in user aliases
  1955. &lt;set RegexpAliases=&quot;0&quot;&gt;
  1956. # filename of language file
  1957. &lt;set LangFile=&quot;lang.txt&quot;&gt;
  1958. # path to directory with CSS files
  1959. &lt;set CssDir=&quot;layout/&quot;&gt;
  1960. # colors for color gradient in most active nicks section
  1961. &lt;set HiCell=&quot;#BABADD&quot;&gt;
  1962. &lt;set HiCell2=&quot;#CCCCCC&quot;&gt;
  1963. # colors for color gradient in most active nicks section
  1964. &lt;set HiCell2=&quot;#CCCCCC&quot;&gt;
  1965. # dump raw statistics into file - debugging: dump the raw statistics to this file
  1966. #&lt;set StatsDump=&quot;stats.dump&quot;&gt;
  1967. # ---- Advanced (not in the original documentation) -------------------------
  1968. # nicks of bots, for log formats that cannot tell bots from people (DCpp)
  1969. #&lt;set BotNicks=&quot;bot1 bot2&quot;&gt;
  1970. # width in pixels of the statistics tables
  1971. &lt;set TableWidth=&quot;574&quot;&gt;
  1972. # image id of the horizontal bar for hours 0-5
  1973. &lt;set Pic_H_0=&quot;blue-h&quot;&gt;
  1974. # image id of the horizontal bar for hours 6-11
  1975. &lt;set Pic_H_6=&quot;green-h&quot;&gt;
  1976. # image id of the horizontal bar for hours 12-17
  1977. &lt;set Pic_H_12=&quot;yellow-h&quot;&gt;
  1978. # image id of the horizontal bar for hours 18-23
  1979. &lt;set Pic_H_18=&quot;red-h&quot;&gt;
  1980. # image id of the vertical bar for hours 0-5
  1981. &lt;set Pic_V_0=&quot;blue-v&quot;&gt;
  1982. # image id of the vertical bar for hours 6-11
  1983. &lt;set Pic_V_6=&quot;green-v&quot;&gt;
  1984. # image id of the vertical bar for hours 12-17
  1985. &lt;set Pic_V_12=&quot;yellow-v&quot;&gt;
  1986. # image id of the vertical bar for hours 18-23
  1987. &lt;set Pic_V_18=&quot;red-v&quot;&gt;
  1988. ##############################################################################
  1989. # YOUR CHANNEL - copy this block for each extra channel
  1990. ##############################################################################
  1991. &lt;channel=&quot;#example&quot;&gt;
  1992. # Logfile: the log to read; you can list several Logfile lines EDIT
  1993. Logfile=&quot;/path/to/example.log&quot;
  1994. # LogDir: use INSTEAD of Logfile to read a whole folder of dated logs
  1995. #LogDir=&quot;/path/to/logs/&quot;
  1996. # LogPrefix: with LogDir: only read files starting with this
  1997. #LogPrefix=&quot;example.log.&quot;
  1998. # LogSuffix: with LogDir: date format at the end of the file names, so they sort by
  1999. # date
  2000. #LogSuffix=&quot;.%d%b%Y&quot;
  2001. # NFiles: with LogDir: only parse the newest N files (0 = all)
  2002. #NFiles=&quot;30&quot;
  2003. # Format: your log format: eggdrop, mIRC, xchat, irssi, ... (see docs/FORMATS) EDIT
  2004. Format=&quot;eggdrop&quot;
  2005. # Network: the IRC network, shown on the page EDIT
  2006. Network=&quot;ExampleNet&quot;
  2007. # OutputFile: the page pisg writes EDIT
  2008. OutputFile=&quot;/var/www/html/example.html&quot;
  2009. # OutputTag: replaces %t in OutputFile; used with the -nf / -t command line options
  2010. #OutputTag=&quot;-week&quot;
  2011. # Maintainer: who is named as maintainer on the page EDIT
  2012. Maintainer=&quot;Your Name&quot;
  2013. # LogType: only &quot;Logfile&quot; exists, leave it
  2014. LogType=&quot;Logfile&quot;
  2015. # Any global option can be overridden for this channel only, for example:
  2016. #Lang=&quot;FR&quot;
  2017. #ColorScheme=&quot;midnight&quot;
  2018. &lt;/channel&gt;
  2019. ##############################################################################
  2020. # USERS - link nicks together, add pictures, mark bots
  2021. ##############################################################################
  2022. # nick the name shown in the stats (required)
  2023. # alias other nicks of the same person, space separated; * matches anything
  2024. # (Joe* also counts Joe_, Joe^away ...). NickTracking=&quot;1&quot; also finds many
  2025. # pic picture shown next to the user bigpic larger picture it links to
  2026. # link a web address or e-mail address sex m, f or b (bot)
  2027. # ignore y = leave this nick out of the stats altogether (for bots)
  2028. &lt;user nick=&quot;Alice&quot; alias=&quot;Alice_ Alice-* AliceAway&quot; pic=&quot;alice.png&quot; link=&quot;https://example.com/alice&quot; sex=&quot;f&quot;&gt;
  2029. &lt;user nick=&quot;Bob&quot; alias=&quot;Bob_ Bobby&quot; pic=&quot;bob.png&quot; bigpic=&quot;bob-big.png&quot; link=&quot;bob@example.com&quot; sex=&quot;m&quot;&gt;
  2030. &lt;user nick=&quot;ChanBot&quot; sex=&quot;b&quot; ignore=&quot;y&quot;&gt;
  2031. &lt;user nick=&quot;Seb&quot; alias=&quot;Seb- Seb_&quot; pic=&quot;https://r2.fivemanage.com/X8I0LGoLdHY2Wx9DdTrvx/Pics/me.png&quot; sex=&quot;m&quot; link=&quot;https://dooubletap.github.io/&quot;&gt;
  2032. ##############################################################################
  2033. # LINKS - keep addresses out of &quot;Most referenced URLs&quot;
  2034. ##############################################################################
  2035. &lt;link url=&quot;https://example.com/spam&quot; ignore=&quot;y&quot;&gt;
  2036. ##############################################################################
  2037. # INCLUDE - share users between channels or config files
  2038. ##############################################################################
  2039. # Put your &lt;user&gt; lines in users.cfg and load them here (an included file cannot
  2040. # include another file):
  2041. #&lt;include=&quot;users.cfg&quot;&gt;
  2042. </pre>
  2043. </div>
  2044. </section>
  2045. </main>
  2046. <script>
  2047. document.querySelectorAll('.copy').forEach(function (b) {
  2048. b.addEventListener('click', function () {
  2049. var pre = document.getElementById(b.dataset.target), text = pre.textContent;
  2050. function done(ok) { var old = b.textContent; b.textContent = ok ? 'Copied!' : 'Press Ctrl+C';
  2051. setTimeout(function () { b.textContent = old; }, 1800); }
  2052. function fallback() { var r = document.createRange(); r.selectNodeContents(pre);
  2053. var s = window.getSelection(); s.removeAllRanges(); s.addRange(r);
  2054. var ok = false; try { ok = document.execCommand('copy'); } catch (e) {} done(ok); }
  2055. if (navigator.clipboard && window.isSecureContext) { navigator.clipboard.writeText(text).then(function () { done(true); }, fallback); }
  2056. else { fallback(); }
  2057. });
  2058. });
  2059. </script>
  2060. </body>
  2061. </html>