| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315 |
- <!doctype html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <title>pisg 1.0.a documentation</title>
- <style>
- :root { --bg:#fff; --fg:#1d2329; --muted:#5b6672; --line:#d9dee3; --code:#f3f5f7; --link:#0b6b3a; }
- @media (prefers-color-scheme: dark) {
- :root { --bg:#14181c; --fg:#e3e8ec; --muted:#98a4af; --line:#2a3138; --code:#1d2329; --link:#5fd08e; }
- }
- body { margin:0; background:var(--bg); color:var(--fg);
- font:16px/1.6 system-ui,-apple-system,"Segoe UI",Roboto,sans-serif; }
- main { max-width:60rem; margin:0 auto; padding:2rem 1rem 4rem; }
- a { color:var(--link); }
- h1 { margin-bottom:.2rem; } .sub { color:var(--muted); margin-top:0; }
- h2 { margin-top:3rem; padding-bottom:.3rem; border-bottom:2px solid var(--line); }
- h3 { margin-top:2rem; } h4 { margin:1rem 0 .2rem; color:var(--muted);
- text-transform:uppercase; font-size:.8rem; letter-spacing:.06em; }
- .purpose { font-weight:400; font-size:.85rem; color:var(--muted); margin-left:.5rem; }
- section.option { border-top:1px solid var(--line); padding-top:.5rem; }
- pre { background:var(--code); border:1px solid var(--line); border-radius:6px;
- padding:.75rem 1rem; overflow-x:auto; font-size:.85rem; }
- code { background:var(--code); padding:.1em .3em; border-radius:4px; font-size:.9em; }
- nav { border:1px solid var(--line); border-radius:8px; padding:.5rem 1.2rem; margin:1.5rem 0; }
- /* example config: code block with copy/download bar */
- .codewrap { border:1px solid var(--line); border-radius:8px; overflow:hidden; margin:1rem 0; }
- .codebar { display:flex; align-items:center; gap:.5rem; padding:.4rem .75rem; background:var(--code);
- border-bottom:1px solid var(--line); font-size:.85rem; color:var(--muted); }
- .codebar span { flex:1; font-family:ui-monospace,Menlo,Consolas,monospace; }
- .btn { font:inherit; font-size:.8rem; padding:.25rem .7rem; border:1px solid var(--line); border-radius:6px;
- background:var(--bg); color:var(--fg); cursor:pointer; text-decoration:none; }
- .btn:hover { border-color:var(--link); color:var(--link); }
- pre.cfg { margin:0; border:0; border-radius:0; max-height:36rem; overflow:auto; font-size:.8rem; line-height:1.45; }
- nav .opts a { display:inline-block; margin:.1rem .6rem .1rem 0; font-size:.85rem; }
- </style>
- </head>
- <body>
- <main>
- <h1>pisg 1.0.a documentation</h1>
- <p class="sub">How to install and configure pisg</p>
- <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>
- <section class="chapter" id="what-is-pisg"><h2>1. What is pisg?</h2>
- <p>pisg is an IRC statistics generator. It takes IRC logfiles and turns
- them into nice looking stats.</p>
- <p>In general, you would do something like this to get it running:
- <ul>
- <li><p>Enable logging in an IRC bot, or in your IRC client. The log will be
- outputted into a file.</p>
- </li>
- <li><p>You set up pisg, you define the channel name, and the path to the
- logfile you created.</p>
- </li>
- <li><p>You run pisg, pisg runs the log through and create statistics, it
- then creates an HTML page which you can upload to a webserver.</p>
- </li>
- </ul></p>
- <section id="requirements"><h3>What are the requirements to run pisg?</h3>
- <p><ul>
- <li><p>An IRC client or bot where pisg supports the output logfile.</p>
- </li>
- <li><p>Any operating system which Perl runs on, this includes popular OSes
- such as Linux, FreeBSD, Windows and Mac. You will have a hard time
- finding an OS where Perl isn't supported. For Windows this means
- that you need to download <a href="http://activestate.com/Products/ActivePerl/">ActivePerl</a>.</p>
- </li>
- <li><p><em>Optional</em> - a system to host the statistics page
- 24 hours a day, 7 days a week.</p>
- </li>
- <li><p><em>Optional</em> - a system to log the channel, 24 hours
- a day, 7 days a week.</p>
- </li>
- </ul></p>
- </section>
- </section>
- <section class="chapter" id="setting-up-pisg"><h2>2. Setting up pisg for the first time</h2>
- <p>Most configuration happens through the <code>pisg.cfg</code>
- file, the file format is made to be easy to read, and easy to extend for
- further use. It uses an XML-like format, with elements and attributes.</p>
- <section id="setting-up-a-channel"><h3>Setting up a channel</h3>
- <p>An element called <a href="#Channel">Channel</a> is made for defining
- channels, a quick example of a channel is here:
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- Maintainer = "John"
- OutputFile = "mychan.html"
- </channel></pre>
- The above will define a <a href="#Channel">Channel</a> called <code>#channel</code>, the
- logfile pisg will look for is called <code>channel.log</code> and
- the <a href="#Format">Format</a> of the logfile will be <code>mIRC</code>. The
- <a href="#Maintainer">Maintainer</a> (which will be stated on the output page) is
- <code>John</code>.</p>
- <p>That is basically it! Now, there are a lot more options that you can use
- for your channels, for this please refer to the reference documentation.</p>
- <p>Also be-aware of the fact that pisg uses various images to show the
- time-related bars. These images are placed in the
- <code>gfx/</code> folder and should be placed into the same
- directory as your outputted HTML file.</p>
- </section>
- <section id="user-options"><h3>Specifying user options</h3>
- <p>User options are set with a simple XML-like syntax in the form:
- <pre><user nick="NICK" option="VALUE"></pre>
- Remember, the nick is always required.
- For example to add aliases to a nick, then you could do this:
- <pre><user nick="Joe" alias="Joe^*"></pre>
- The asterisk (*) means that it will match all nicks starting with 'Joe^'. So
- it will add all Joe^'s to 'Joe' in the stats.
- Another thing you can do is to add a picture to a user:
- <pre><user nick="Ben" pic="ben_holiday.jpg"></pre>
- If you have a larger picture of the user as well, you can make the picture
- on the stats page link to it:
- <pre><user nick="Ben" pic="ben_holiday.jpg" bigpic="ben-big.jpg"></pre>
- You can include * or ? to enable filename globbing to randomly choose one
- from several pictures: (see documentation for the
- <a href="#ImageGlobPath">ImageGlobPath</a> option)
- <pre><user nick="Ben" pic="ben_*.jpg"></pre>
- You can also set a user's sex.
- The sex setting can be "f"emale, "m"ale, or "b"ot:
- <pre><user nick="Ben" sex="m"></pre>
- Also you can add links to URLs and e-mails:
- <pre><user nick="Christine" link="http://www.christine.com"></pre>
- or
- <pre><user nick="Chris" link="chris@host.com"></pre>
- The last thing you can do is to ignore nicks (for example bots):
- <pre><user nick="nameofbot" ignore="y"></pre>
- You don't have to do all this in many lines, you could just as easily do:
- <pre><user nick="Joe" alias="Joe^away Joe^work" pic="joe.jpg" link="joe@joe.com" sex="m"></pre>
- (Here the aliases are a space separated list of nicks, that also works! But *
- as a wildcard is smarter, although it is slower).</p>
- </section>
- <section id="global-options"><h3>Setting global options</h3>
- <p>Many times, it will be useful to set up global options, global options
- are set like this:
- <pre><set option="VALUE"></pre>
- Any global option will be overriden by anything defined within channel
- elements (see <a href="#setting-up-a-channel">Setting up a channel</a>)</p>
- <p>For example, to change the background color of the stats page, you
- could do:
- <pre><set bgcolor="black"></pre>
- You can set many options in a single <code>set</code>:
- <pre><set lang="DE" timeoffset="+1"></pre>
- The above will set the language on the statistics page to DE (Deutsch,
- German) and set the time offset to +1.
- All options available are mentioned in the reference documentation.</p>
- </section>
- <section id="ignoring-links"><h3>Ignoring links</h3>
- <p>It's possible to ignore links in the "Most referenced URLs" section:
- <pre><link url="http://www.slashdot.org" ignore="y"></pre></p>
- </section>
- <section id="including-config"><h3>Including common settings for various channels</h3>
- <p>If you have, for example, more than one channel, where the users are the
- same, or you don't want to maintain more than one user file, you can use
- the "include" setting in the main config file:
- <pre><include="/home/vetinari/pisg/users.cfg"></pre>
- This will include the file /home/vetinari/pisg/users.cfg in the config
- at the place where the include statement is set.</p>
- <p>Note, that you can NOT include a file from an included file!</p>
- </section>
- <section id="using-css"><h3>Changing the layout of your stats page</h3>
- <p>The standard layout and colors in the outputted HTML page are made to be
- somewhat clean and neutral. But you have the chance to change the layout
- yourself.</p>
- <p>There are a few predefined color schemes for you to use, use the
- <a href="#ColorScheme">ColorScheme</a> option when using them. The
- colorschemes distributed with pisg are: default (which is the default),
- darkgalaxy, darkred, justgrey, ocean, orange_grey, pisg, softgreen.</p>
- <p>When changing it, you need a fair knowledge of CSS (Cascading Style
- Sheets). CSS is what most of the web uses today to define styles and
- layout on HTML pages.
- With the pisg distribution, look in the <code>layout</code>
- directory. In it resides <code>default.css</code> which is the
- file being included onto the HTML page. Open it in a text editor like
- vi or notepad. Then change it until you're happy with it. Be aware that
- you might want to look at the <a href="#HiCell">HiCell and HiCell2</a>
- options through pisg.cfg for changing the last two colors.</p>
- <p>If you have created a nice stylesheet which other can take advantage of,
- you are encouraged to send it to the pisg mailing list so that it can be
- distributed with the next version of pisg.</p>
- <p>If you want to embed the statistics into another page, use the "none" color scheme.
- Pisg will then omit the HTML header and write only the body part.</p>
- </section>
- <section id="running-pisg"><h3>Running pisg</h3>
- <p>When everything is set up in the pisg configuration file (pisg.cfg),
- then you simply run pisg on the command-line.</p>
- <p>Using Linux, BSD or another UNIX-like system:
- <pre>user@host:pisg-0.37$ ./pisg</pre></p>
- <p>Using Windows:
- <pre>c:\pisg> perl pisg</pre></p>
- <p>The program will run and parse the logfiles you specified in the
- configuration file.</p>
- <p>If you are using Linux, BSD or another UNIX-like system and want run
- pisg automatically several times a day, then see the
- <code>crontab</code> file in the <code>scripts/</code>
- directory.</p>
- <p>For Windows, see the <code>windows-upload-ftp.txt</code> file
- with the pisg distribution, this file is also placed in the
- <code>scripts/</code> directory.</p>
- </section>
- <section id="mailing-list-and-bugs"><h3>Obtaining help and reporting bugs</h3>
- <p>If your problem could not be resolved through here, then you should send
- an e-mail to the pisg mailing list. You can subscribe and see more info
- at <a href="http://lists.sourceforge.net/lists/listinfo/pisg-general">http://lists.sourceforge.net/lists/listinfo/pisg-general</a>.</p>
- <p>If you believe that you have found a bug, you should use the SourceForge
- <a href="http://sourceforge.net/tracker/?group_id=31862&atid=403711">bug
- tracking system.</a></p>
- </section>
- </section>
- <section class="chapter" id="reference"><h2>3. General pisg options</h2>
- <section class="option" id="Channel"><h3>Channel <span class="purpose">define channel name</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- Maintainer = "John"
- </channel></pre>
- <h4>Description</h4>
- <p><code>Channel</code> is used in two contexts, globally when using
- <set> and when defining new channels. It sets the name of the
- channel.</p>
- <h4>Default</h4>
- <p>Unset</p>
- </section>
- <section class="option" id="Format"><h3>Format <span class="purpose">the logfile format</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "eggdrop"
- Maintainer = "John"
- </channel>
- <set Format="mIRC"></pre>
- <h4>Description</h4>
- <p><code>Format</code> is used to define the format of the logfile,
- pisg supports a various number of different logfiles, see the FORMATS
- file included with the pisg distribution. If your logfiles have the
- suffix .gz or .bz2, they will automatically be decompressed and read by
- pisg.
- See also <a href="#Maintainer">Maintainer</a>.</p>
- <h4>Default</h4>
- <p>Unset</p>
- </section>
- <section class="option" id="Network"><h3>Network <span class="purpose">the IRC network of the channel</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "eggdrop"
- Network = "Undernet"
- </channel>
- <set Network="Quakenet"></pre>
- <h4>Description</h4>
- <p><code>Network</code> is used to set the network which the channel
- resides on, this name is displayed on the stats page.</p>
- <h4>Default</h4>
- <p>SomeIRCNetwork</p>
- </section>
- <section class="option" id="OutputFile"><h3>OutputFile <span class="purpose">name of the generated HTML page</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "eggdrop"
- OutputFile = "mychan.html"
- </channel>
- <set OutputFile="mychan.html"></pre>
- <h4>Description</h4>
- <p><code>OutputFile</code> is used to define the name of the
- generated statistics page.</p>
- <h4>Default</h4>
- <p>index.html</p>
- </section>
- <section class="option" id="OutputTag"><h3>OutputTag <span class="purpose">tag to insert into OutputFile</span></h3>
- <pre><channel="#channel">
- LogDir = "logs/"
- Format = "eggdrop"
- OutputFile = "mychan%t.html"
- OutputTag = "-week"
- </channel>
- <set OutputTag="-week"></pre>
- <h4>Description</h4>
- <p><code>OutputTag</code> specifies a string that will replace
- occurrences of "%t" in <a href="#OutputFile">OutputFile</a>. This option is most
- useful when used as a command line switch (-t) to pisg in conjunction with
- <a href="#NFiles">NFiles</a> (-nf). Example:
- <pre>$ pisg -co pisg.conf
- $ pisg -co pisg.conf -nf 8 -t -week</pre>
- Leaving out the <code>OutputTag</code> settings from the above
- pisg.conf snippet, this writes both the full statistics (mychan.html) and
- statistics for the last week (mychan-week.html) using the same pisg config
- file. (Assuming that there are separate logfiles for each day.)</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- <section class="option" id="Logfile"><h3>Logfile <span class="purpose">name of logfile to parse</span></h3>
- <pre><channel="#channel">
- Logfile="/home/foo/eggdrop/logs/mylog.txt"
- Format = "eggdrop"
- </channel>
- <set Logfile="foo.log"></pre>
- <h4>Description</h4>
- <p>This defines the filename of the logfile to parse for the channel. If
- you want to parse a directory full of logfiles, you should use the
- <a href="#LogDir">LogDir</a> option instead. Providing this option multiple
- times will parse multiple files in the order the statements appear.
- Wildcards (* ? []) will be expanded.
- See also <a href="#LogDir">LogDir</a> and <a href="#NFiles">NFiles</a>.</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- <section class="option" id="LogDir"><h3>LogDir <span class="purpose">parse a directory full of logs</span></h3>
- <pre><channel="#channel">
- LogDir="/home/foo/eggdrop/logs/"
- Format = "eggdrop"
- </channel>
- <set LogDir="dailylogs/"></pre>
- <h4>Description</h4>
- <p>When <code>LogDir</code> is defined to valid path to a directory,
- then pisg will run through that directory, parse all logfiles in it and
- create one HTML page from it. Useful with for example eggdrop logs. Providing
- this option multiple times will parse all the files in multiple
- directories in the order the statements appear.
- See also <a href="#NFiles">NFiles</a>, <a href="#LogPrefix">LogPrefix</a>, and
- <a href="#LogSuffix">LogSuffix</a>.</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- <section class="option" id="NFiles"><h3>NFiles <span class="purpose">parse only the last files in</span></h3>
- <pre><channel="#channel">
- LogDir="/home/foo/eggdrop/logs/"
- NFiles="8"
- Format="eggdrop"
- </channel>
- <set NFiles="8"></pre>
- <h4>Description</h4>
- <p>When <code>NFiles</code> is set to a positive integer, pisg will
- process only the last that much logfiles from <a href="#Logfile">Logfile</a>
- and <a href="#LogDir">LogDir</a> options. Useful to create statistics that
- cover the last week or month (assuming there are separate logfile per
- day/week/etc.).</p>
- <h4>Default</h4>
- <p>0 (process all files)</p>
- </section>
- <section class="option" id="Maintainer"><h3>Maintainer <span class="purpose">name of the maintainer</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- Maintainer = "Benny"
- </channel>
- <set Maintainer="Benny"></pre>
- <h4>Description</h4>
- <p><code>Maintainer</code> is used to define the name of the
- maintainer of the statistics page, this can be either the person
- generating the stats or the bot/client doing the logging.
- The maintainer is displayed in the outputted stats page.
- This setting is also used by some log parsers where "You" is used
- instead of the nick in the log (e.g. "You have been kicked").
- See also <a href="#Format">Format</a>, <a href="#NickTracking">NickTracking</a>.</p>
- <h4>Default</h4>
- <p>MAINTAINER</p>
- </section>
- <section class="option" id="ColorScheme"><h3>ColorScheme <span class="purpose">use a different color scheme for stats page</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- ColorScheme = "darkgalaxy"
- Maintainer = "John"
- </channel>
- <set ColorScheme="default"></pre>
- <h4>Description</h4>
- <p><code>ColorScheme</code> is used to define the color scheme used
- for the statistics page. Actually it's the CSS file being included.
- CSS files distributed with pisg are: darkgalaxy, darkred, default,
- justgrey, ocean, orange_grey, pisg, softgreen (omit the .css). The file
- will be included statically in the generated HTML page. If you give a file
- name or URL (i.e. a color scheme name with .css or a path), the file will
- be linked to instead. Using "none" will cause pisg to write only the body
- of the page; use this to include the statistics into a custom page. See
- also <a href="#CssDir">CssDir</a>, <a href="#AltColorScheme">AltColorScheme</a>,
- <a href="#HiCell">HiCell/HiCell2</a>.</p>
- <h4>Default</h4>
- <p>default</p>
- </section>
- <section class="option" id="AltColorScheme"><h3>AltColorScheme <span class="purpose">alternate stylesheets for stats page</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- ColorScheme = "darkgalaxy"
- AltColorScheme = "layout/ocean.css"
- Maintainer = "John"
- </channel>
- <set AltColorScheme="layout/darkgalaxy.css layout/justgrey.css"></pre>
- <h4>Description</h4>
- <p><code>AltColorScheme</code> defines an alternate CSS file to
- be used for the statistics page. Multiple files can be given (space
- separated.) Note that this is not supported by all browsers.
- See also <a href="#ColorScheme">ColorScheme</a> and <a href="#CssDir">CssDir</a>.</p>
- <h4>Default</h4>
- <p>default</p>
- </section>
- <section class="option" id="Lang"><h3>Lang <span class="purpose">define the language / translation to use</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- Lang = "DE"
- OutputFile = "mychan-%l.html"
- </channel>
- <set Lang="FR,SE"></pre>
- <h4>Description</h4>
- <p><code>Lang</code> defines the language to use for the stats.
- Currently, lang.txt includes:
- EN (English),
- BG (Bulgarian),
- CA (Catalan),
- CZ (Czech),
- DA (Danish),
- DE (German),
- EE (Estonian),
- ES (Spanish),
- FI (Finnish),
- FR (French),
- GR (Greek),
- HE (Hebrew),
- HU (Hungarian),
- IS (Icelandic),
- IT (Italian),
- NL (Dutch),
- NL_BE (Flemish),
- NO (Norwegian),
- PL (Polish),
- PT (Portuguese),
- PT_BR (Portuguese/Brazil),
- RO (Romanian),
- RU (Russian),
- SE (Swedish),
- SI (Slovenian),
- SK (Slovak),
- SQ (Albanian),
- TR (Turkish),
- YU (Serbian).
- Output in several languages can be generated at the same time, separate the
- languages by comma. The tag %l in the output file name will be replaced by
- the language name. See also <a href="#LangFile">LangFile</a>.</p>
- <h4>Default</h4>
- <p>EN (English)</p>
- </section>
- <section class="option" id="PageHead"><h3>PageHead <span class="purpose">define a file as page header</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- OutputFile = "stats.html"
- PageHead = "myheader.txt"
- </channel>
- <set PageHead="someheader.txt"></pre>
- <h4>Description</h4>
- <p><code>PageHead</code> is used to include a file in the stats page,
- for example an introduction text, a link to an image or a banner. The
- file can hold anything, it will be included raw in the stats page -
- so HTML should be preferred. The file will be included in the top of
- the page. This option is the opposite of <a href="#PageFoot">PageFoot</a>.</p>
- <h4>Default</h4>
- <p>none</p>
- </section>
- <section class="option" id="PageFoot"><h3>PageFoot <span class="purpose">define a file as page footer</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- outputfile = "stats.html"
- PageFoot = "myfooter.txt"
- </channel>
- <set PageFoot="somefooter.txt"></pre>
- <h4>Description</h4>
- <p><code>PageFoot</code> is used to include a file in the stats page,
- for example an introduction text, a link to an image or a banner. The
- file can hold anything, it will be included raw in the stats page -
- so HTML should be preferred. The file will be included in the bottom of
- the page. This option is the opposite of <a href="#PageHead">PageHead</a>.</p>
- <h4>Default</h4>
- <p>none</p>
- </section>
- <section class="option" id="LogPrefix"><h3>LogPrefix <span class="purpose">only parse logs LogPrefixed with a user defined string</span></h3>
- <pre><channel="#channel">
- LogDir="/home/foo/eggdrop/logs/"
- Format = "eggdrop"
- LogPrefix = "logjun"
- </channel>
- <set LogPrefix="logjanuary"></pre>
- <h4>Description</h4>
- <p>When using the <a href="#LogDir">LogDir</a> option and you only want to use
- a slew of the files in it, you can have pisg choose only files which are
- prefixed with a special string.</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- <section class="option" id="LogSuffix"><h3>LogSuffix <span class="purpose">Regexp to sort logfiles by format month||day||year</span></h3>
- <pre><set LogSuffix="\.\d\d([A-Za-z]+)\d\d\d\d||\.(\d\d)[A-Za-z]+\d\d\d\d||\.\d\d[A-Za-z]+(\d\d\d\d)"></pre>
- <h4>Description</h4>
- <p><code>LogSuffix</code> is used to define the suffix of a logfile,
- it only works when <a href="#LogDir">LogDir</a> is defined. The example in
- the synopsis is for the eggdrop bots default format.</p>
- <h4>Default</h4>
- <p>Unset</p>
- </section>
- <section class="option" id="Silent"><h3>Silent <span class="purpose">make pisg silent, suppress messages</span></h3>
- <pre><set Silent="1"></pre>
- <h4>Description</h4>
- <p>This option is useful mainly from command line when invoking pisg with
- <code>--silent 1</code>. But it can also used in the configuration
- file. It will suppress all standard output from pisg. Error messages
- will still be sent.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="CacheDir"><h3>CacheDir <span class="purpose">use a cache to speed up log parsing</span></h3>
- <pre><set CacheDir="pisg_cache">
- <set CacheDir="/path/to/pisg_cache"></pre>
- <h4>Description</h4>
- <p>Setting this option makes pisg dump the results of log parsing into cache
- files. The next time pisg is run, it compares the timestamp of the log(s)
- with the timestamp stored in the cache file. When the log was not changed,
- the cached data is used. (This means that it does not work if you only
- have a single big logfile. Split the log at arbitrary points and use
- <a href="#LogDir">LogDir</a> or <a href="#Logfile">Logfile</a>="dir/*".)</p>
- <p>Note that the cache files should be deleted when the pisg config file is
- changed since the cache data uses the old config settings.
- <a href="#NickTracking">NickTracking</a> does not work especially well with the
- cache when using different <a href="#NFiles">NFiles</a> settings.</p>
- <h4>Default</h4>
- <p>Unset</p>
- </section>
- <section class="option" id="ChannelIndex"><h3>ChannelIndex <span class="purpose">name of the channel list file for a landing page</span></h3>
- <pre><set ChannelIndex="channels.json"></pre>
- <h4>Description</h4>
- <p>Each time pisg writes a channel page, it also updates a small JSON file, next to
- that page, listing the channels found in the same directory: the channel name as
- written in the <a href="#Channel">Channel</a> setting, the page file name, the network, when
- it was updated, and the number of days, nicks and lines. A landing page can read this
- file to offer a drop-down list of channels (see <code>site/index.html</code>), so
- nothing has to scan or scrape the HTML pages. Each run only changes the entry of its
- own channel, and entries whose page no longer exists are removed. Set it to "none"
- to switch this off.</p>
- <h4>Default</h4>
- <p>channels.json</p>
- </section>
- <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>
- <pre><set HomeLink="index.html"></pre>
- <h4>Description</h4>
- <p>Shows an "All channels" button above the title of each stats page (translated with the
- page language). Give the page it should lead to: a file name next to the stats page, such as
- <code>index.html</code> (the landing page in <code>site/</code>), or a full
- http(s) address. Leave it empty, or "none", for no button. Only the newer colour schemes
- draw it as a button; a scheme set to "none" does not show it.</p>
- <h4>Default</h4>
- <p>empty (no button)</p>
- </section>
- <section class="option" id="ShowNavBar"><h3>ShowNavBar <span class="purpose">enable/disable the section bar at the top of the page</span></h3>
- <pre><set ShowNavBar="1"></pre>
- <h4>Description</h4>
- <p>Adds a slim bar at the top of the stats page that stays in view while scrolling. It shows which
- section is being read, and a "Sections" button opens a list of every section, laid out in columns so
- nothing has to be scrolled sideways, whatever the number of sections or the language. It also works
- without JavaScript. The bar is left out when <a href="#ColorScheme">ColorScheme</a> is "none",
- since the page is then meant to be embedded in another one.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- </section>
- <section class="chapter" id="reference-stats"><h2>4. Options for various statistics features</h2>
- <section class="option" id="DailyActivity"><h3>DailyActivity <span class="purpose">number of days to show in "Daily Actitity"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- DailyActivity = "0"
- </channel>
- <set DailyActivity="31"></pre>
- <h4>Description</h4>
- <p>This option sets the number of days to show in the "Daily activity"
- section. Pisg will generate a graph that shows the actitivy during
- this timeframe. Setting the option to 0 disables the section.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowActiveTimes"><h3>ShowActiveTimes <span class="purpose">enable/disable "Most Active Times"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowActiveTimes = "0"
- </channel>
- <set ShowActiveTimes="1"></pre>
- <h4>Description</h4>
- <p>With this option you can disable the "Most Active Times" section on the
- stats page. It will simply disappear when specifying 0.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowActiveNicks"><h3>ShowActiveNicks <span class="purpose">enable/disable "Most Active Nicks"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowActiveNicks = "0"
- </channel>
- <set ShowActiveNicks="1"></pre>
- <h4>Description</h4>
- <p>With this option you can disable the "Most Active Nicks" section on the
- stats page.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowBigNumbers"><h3>ShowBigNumbers <span class="purpose">enable/disable "Big Numbers" sections</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowBigNumbers = "0"
- </channel>
- <set ShowBigNumbers="1"></pre>
- <h4>Description</h4>
- <p>With this option you can disable the "Big Numbers" and "Other
- Interesting numbers" sections on the stats page. They will simply
- disappear when specifying 0.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowTopics"><h3>ShowTopics <span class="purpose">enable/disable "Latest topics" sections</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowTopics = "0"
- </channel>
- <set ShowTopics="1"></pre>
- <h4>Description</h4>
- <p>With this option you can disable the "Latest topics" section on the
- stats page. It will simply disappear when specifying 0.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowLines"><h3>ShowLines <span class="purpose">enable/disable "number of lines"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowLines = "0"
- </channel>
- <set ShowLines="1"></pre>
- <h4>Description</h4>
- <p>The default behaviour is to add a column to the "Most Active Nicks"
- section displaying the number of lines a user wrote. With this option it
- can be disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowWpl"><h3>ShowWpl <span class="purpose">enable/disable "words per line"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowWpl = "0"
- </channel>
- <set ShowWpl="1"></pre>
- <h4>Description</h4>
- <p>With this option you can enable the "words per line" column in the
- "Most Active Nicks" section. It will add a column describing the average
- words per line for a person.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowCpl"><h3>ShowCpl <span class="purpose">enable/disable "characters per line"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowCpl = "0"
- </channel>
- <set ShowCpl="1"></pre>
- <h4>Description</h4>
- <p>With this option you can enable the "characters per line" column in the
- "Most Active Nicks" section. It will add a column describing the average
- number of characters per line for a person.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowWords"><h3>ShowWords <span class="purpose">enable/disable "number of words"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowWords = "0"
- </channel>
- <set ShowWords="1"></pre>
- <h4>Description</h4>
- <p>The <code>ShowWords</code> option adds a column to the "Most
- Active Nicks" list which list the total number of words a user has
- typed.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowLastSeen"><h3>ShowLastSeen <span class="purpose">show when a user was last seen on a channel</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowLastSeen = "0"
- </channel>
- <set ShowLastSeen="1"></pre>
- <h4>Description</h4>
- <p>With this option enabled, a column will be added to the "Most Active
- Nicks" section to display when a user was last seen. E.g. "2 days ago".</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowTime"><h3>ShowTime <span class="purpose">show when a nick was active</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowTime = "0"
- </channel>
- <set ShowTime="1"></pre>
- <h4>Description</h4>
- <p>The default behaviour is to add a column to the "Most Active Nicks"
- section displaying a fancy time bar to show when a user was active. With
- this option it can be disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowLineTime"><h3>ShowLineTime <span class="purpose">mIRCStats like behaviour of time bar</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowLineTime = "0"
- </channel>
- <set ShowLineTime="1"></pre>
- <h4>Description</h4>
- <p>The default behaviour is to add a column to the "Most Active Nicks"
- section displaying a fancy time bar to show when a user was active.
- With this option it can be done the same way as mIRCStats does it; that
- is, by putting that time bar next to the number of lines, in the same
- column.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowWordTime"><h3>ShowWordTime <span class="purpose">ShowLineTime like behavior of words column</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowWordTime = "0"
- </channel>
- <set ShowWordTime="1"></pre>
- <h4>Description</h4>
- <p>The default behaviour is to add a column to the "Most Active Nicks"
- section displaying a fancy time bar to show when a user was active.
- With this option it can be done similarly to mIRCStats does it and like
- the ShowLineTime option, but using words instead of lines; that is, by
- putting that time bar next to the number of words, in the same column.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowRandQuote"><h3>ShowRandQuote <span class="purpose">enable or disable the random quotes</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowRandQuote = "0"
- </channel>
- <set ShowRandQuote="1"></pre>
- <h4>Description</h4>
- <p>The default behaviour is to add a column to the "Most Active Nicks"
- section displaying a users random quote. With this option it can be
- disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowLegend"><h3>ShowLegend <span class="purpose">enable or disable the legend of the time bars</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowLegend = "0"
- </channel>
- <set ShowLegend="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg shows a legend below the "Most Active Times" displaying
- what the different colors means. With this option it can be disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowKickLine"><h3>ShowKickLine <span class="purpose">enable or disable the kick line</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowKickLine = "0"
- </channel>
- <set ShowKickLine="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg shows an example kick line in the "Most kicked"-stats.
- With this option it can be disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowActionLine"><h3>ShowActionLine <span class="purpose">enable or disable the action line</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowActionLine = "0"
- </channel>
- <set ShowActionLine="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg shows an example action line in the "Most actions"-stats.
- With this option it can be disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowShoutLine"><h3>ShowShoutLine <span class="purpose">enable or disable the shout line</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowShoutLine = "0"
- </channel>
- <set ShowShoutLine="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg shows an example shout line in the "Most shouting
- people"-stats. With this option it can be disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowFoulDecimals"><h3>ShowFoulDecimals <span class="purpose">set how many decimals to show</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowFoulDecimals = "2"
- </channel>
- <set ShowFoulDecimals="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg uses 1 decimal. With this option you could change
- it to whatever you like. Negative is treated as the default value.</p>
- <h4>Default</h4>
- <p>1 decimal</p>
- </section>
- <section class="option" id="ShowFoulLine"><h3>ShowFoulLine <span class="purpose">enable or disable the foul line</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowFoulLine = "0"
- </channel>
- <set ShowFoulLine="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg doesn't show an example foul line in the "Most
- fouls"-stats. With this option it can be enabled.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowViolentLines"><h3>ShowViolentLines <span class="purpose">enable or disable the violent lines</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "bobot"
- ShowViolentLines = "0"
- </channel>
- <set ShowViolentLines="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg shows example violent lines in the "Most aggressive"
- and "Most attacked"-stats. With this option it can be disabled.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowMuw"><h3>ShowMuw <span class="purpose">enable or disable "Most used words"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowMuw = "0"
- </channel>
- <set ShowMuw="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg adds an "Most used words" section to the stats page.
- With this option you can disable it from being shown.
- See also <a href="#WordHistory">WordHistory</a>.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowMrn"><h3>ShowMrn <span class="purpose">enable or disable "Most referenced nicks"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowMrn = "0"
- </channel>
- <set ShowMrn="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg adds an "Most referenced nicks" section to the stats
- page. With this option you can disable it from being shown.
- See also <a href="#NickHistory">NickHistory</a>.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowMru"><h3>ShowMru <span class="purpose">enable or disable "Most referenced URLs"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowMru = "0"
- </channel>
- <set ShowMru="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg adds an "Most referenced URLs" section to the stats
- page. With this option you can disable it from being shown.
- See also <a href="#UrlHistory">UrlHistory</a>.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowCharts"><h3>ShowCharts <span class="purpose">enable or disable channel music charts</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowCharts = "0"
- </channel>
- <set ShowCharts="1"></pre>
- <h4>Description</h4>
- <p>With this option set, pisg creates a chart listing of the top songs played
- on the channel. See also <a href="#ChartsHistory">ChartsHistory</a> and
- <a href="#ChartsRegexp">ChartsRegexp</a>.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowOps"><h3>ShowOps <span class="purpose">enable or disable op statistics</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowOps = "0"
- </channel>
- <set ShowOps="0"></pre>
- <h4>Description</h4>
- <p>By default, pisg has op statistics in the "Most interesting numbers"
- section. Here you can disable the feature, it's useful if you don't feel
- that the information is of any value, or your log format doesn't support
- ops/deops.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowVoices"><h3>ShowVoices <span class="purpose">enable or disable voice statistics</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowVoices = "0"
- </channel>
- <set ShowVoices="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg doesn't have voice statistics like it has op
- statistics. Enabling this option will add a section to the "Most
- interesting numbers" displaying who got most voices.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowHalfops"><h3>ShowHalfops <span class="purpose">enable or disable halfop statistics</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowHalfops = "0"
- </channel>
- <set ShowHalfops="1"></pre>
- <h4>Description</h4>
- <p>By default, pisg doesn't have halfop statistics (+h on some servers)
- like it has op statistics. Enabling this option will add a section to
- the "Most interesting numbers" displaying who gave most half-ops.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowMostNicks"><h3>ShowMostNicks <span class="purpose">show who changed nick most often</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowMostNicks = "0"
- </channel>
- <set ShowMostNicks="1"></pre>
- <h4>Description</h4>
- <p>By enabling this option, pisg will add a section to the stats showing
- who had the most nicks, and what the nicks were. This option only works
- properly when <a href="#NickTracking">NickTracking</a> is enabled or
- <a href="#user-options">user aliases</a> have been defined.
- See also <a href="#MostNicksHistory">MostNicksHistory</a>,
- <a href="#MostNicksVerbose">MostNicksVerbose</a>, and
- <a href="#NickLimit">NickLimit</a>.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowActiveGenders"><h3>ShowActiveGenders <span class="purpose">show stats on which gender talked most</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowActiveGenders = "0"
- </channel>
- <set ShowActiveGenders="1"></pre>
- <h4>Description</h4>
- <p>Setting this option will make pisg create statistics on which gender
- (female/male/bot) talked most (see the "sex" option in <a href="#user-options">Specifying user options</a>). See also <a href="#NickLimit">NickLimit</a>.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowSmileys"><h3>ShowSmileys <span class="purpose">show most used smileys</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowSmileys = "0"
- </channel>
- <set ShowSmileys="1"></pre>
- <h4>Description</h4>
- <p>With this option, pisg will make a list of the most used smileys in the
- channel. See also <a href="#SmileyHistory">SmileyHistory</a>.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowKarma"><h3>ShowKarma <span class="purpose">show channel karma</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowKarma = "0"
- </channel>
- <set ShowKarma="1"></pre>
- <h4>Description</h4>
- <p>With this option, pisg will analyze the channel karma. Users can give other
- users (or things) good or bad karma by saying "nickname++" or "nickname--";
- "nickname==" resets it to zero. Only the last karma is remembered per
- nick/nick combination, so there is at most +- 1 karma point.
- See also <a href="#KarmaHistory">KarmaHistory</a> and <a href="#NickLimit">NickLimit</a>.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowMostActiveByHour"><h3>ShowMostActiveByHour <span class="purpose">show most active nicks by hour</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowMostActiveByHour = "0"
- </channel>
- <set ShowMostActiveByHour="1"></pre>
- <h4>Description</h4>
- <p>By enabling this option, pisg will add a section to the stats showing
- "Most Active Nicks By Hour" - also look at the
- <a href="#ShowMostActiveByHourGraph">ShowMostActiveByHourGraph</a> and
- <a href="#ActiveNicksByHour">ActiveNicksByHour</a> settings.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowOnlyTop"><h3>ShowOnlyTop <span class="purpose">only count stats for top talkers, ignore less-active users</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowOnlyTop = "1"
- </channel>
- <set ShowOnlyTop="1"></pre>
- <h4>Description</h4>
- <p>By enabling this option, stats in the "Big Numbers" and "Interesting
- Numbers" section will only be counted for users who were the most
- active. E.g. users who appear in the "Most Active Nicks" section, as
- respected by the <a href="#ActiveNicks">ActiveNicks</a> and
- <a href="#ActiveNicks2">ActiveNicks2</a> options. See also
- <a href="#BigNumbersThreshold">BigNumbersThreshold</a>.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="ShowMostActiveByHourGraph"><h3>ShowMostActiveByHourGraph <span class="purpose">show graphs in most active nicks by hour</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- ShowMostActiveByHourGraph = "0"
- </channel>
- <set ShowMostActiveByHour="1">
- <set ShowMostActiveByHourGraph="1"></pre>
- <h4>Description</h4>
- <p>By enabling this option and the <a href="#ShowMostActiveByHour">ShowMostActiveByHour</a>
- option, pisg will show graphs in the "Most Active Nicks By Hour"
- section.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowOverview"><h3>ShowOverview <span class="purpose">enable/disable the channel overview</span></h3>
- <pre><set ShowOverview="1"></pre>
- <h4>Description</h4>
- <p>Shows a row of key numbers at the top of the page: lines, words, nicks, days covered, lines
- per day, the busiest and quietest hour, questions, links shared, the top talker and the
- number of joins and kicks.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowRelations"><h3>ShowRelations <span class="purpose">enable/disable the relation map and its tables</span></h3>
- <pre><set ShowRelations="1"></pre>
- <h4>Description</h4>
- <p>Shows who talks to whom: an interactive map (click a nick or a line for details), a table of
- the closest pairs, and the "social roles" (who is talked to the most, the best listener, ...).
- Two people are connected when one starts a line with the other's nick ("Bob: hi"), mentions
- them, or answers right after them. A line addressed to someone counts three times as much as
- a mention or a quick reply. Nicks that are joined by <a href="#NickTracking">NickTracking</a> or a user alias
- count as one person. Bots are left out: mark a bot with <user nick="Bot" sex="b"> to keep it in the
- other statistics but off the map, or with ignore="y" to remove it altogether. Nicks that are also
- ordinary words (and the channel name) are not counted as mentions.
- See also <a href="#RelationNicks">RelationNicks</a> and <a href="#RelationMinWeight">RelationMinWeight</a>.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="RelationNicks"><h3>RelationNicks <span class="purpose">number of nicks on the relation map</span></h3>
- <pre><set RelationNicks="30"></pre>
- <h4>Description</h4>
- <p>The map shows this many of the most active people (bots excluded). More than about 40 makes
- the picture crowded.</p>
- <h4>Default</h4>
- <p>30</p>
- </section>
- <section class="option" id="RelationMinWeight"><h3>RelationMinWeight <span class="purpose">minimum connection strength shown as a line on the relation map</span></h3>
- <pre><set RelationMinWeight="3"></pre>
- <h4>Description</h4>
- <p>Connections weaker than this are not drawn, which keeps the map readable. A line addressed to
- 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>
- <h4>Default</h4>
- <p>3</p>
- </section>
- <section class="option" id="ShowTimePersonalities"><h3>ShowTimePersonalities <span class="purpose">enable/disable the time personalities section</span></h3>
- <pre><set ShowTimePersonalities="1"></pre>
- <h4>Description</h4>
- <p>Shows who chats mostly at night (0-5h), in the morning (6-11h), in the afternoon (12-17h) and
- in the evening (18-23h), for the people with enough lines. The hours follow <a href="#TimeOffset">TimeOffset</a>.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowConcentration"><h3>ShowConcentration <span class="purpose">enable/disable the "who carries the channel" section</span></h3>
- <pre><set ShowConcentration="1"></pre>
- <h4>Description</h4>
- <p>Shows how much of the channel the busiest people write: the share of all lines written by the
- top 1, 3, 5, 10 and 20 nicks, and how many nicks wrote half of everything.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="ShowSignatureWords"><h3>ShowSignatureWords <span class="purpose">enable/disable the signature words section</span></h3>
- <pre><set ShowSignatureWords="1"></pre>
- <h4>Description</h4>
- <p>Shows, for each of the regular talkers, the word they use a lot and that hardly anyone else uses.
- Short words, nicks and links are ignored (see <a href="#WordLength">WordLength</a> and <a href="#IgnoreWords">IgnoreWords</a>).</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="IgnoreWords"><h3>IgnoreWords <span class="purpose">ignore specified words</span></h3>
- <pre><set IgnoreWords="there about"></pre>
- <h4>Description</h4>
- <p>Sometimes words in the "most used words" appears which you don't want to
- see, with this option you can ignore these words. It also applies to the
- "most referenced nicks" section. It's a space separated list of words.
- You can use * like in nick aliases.
- Can not be used in a channel-only context.</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- <section class="option" id="NoIgnoredQuotes"><h3>NoIgnoredQuotes <span class="purpose">Control random quote output</span></h3>
- <pre><set NoIgnoredQuotes="1"></pre>
- <h4>Description</h4>
- <p>When set to "1", pisg will not output quotes containing ignored words.
- Pisg will output a blank line after trying 20 random quotes if all 20 random quotes were ignored.</p>
- <h4>Default</h4>
- <p>0</p>
- </section>
- <section class="option" id="FoulWords"><h3>FoulWords <span class="purpose">specify words considered to be bad/FoulWords language</span></h3>
- <pre><set FoulWords="ass fuck bitch"></pre>
- <h4>Description</h4>
- <p>There is a section in the "Most interesting numbers" which tells who had
- a "dirty mouth" - here you can define which words are considered being
- bad/foul. It is a space separated list of words.
- You can use * like in nick aliases.
- Can not be used in a channel-only context.</p>
- <h4>Default</h4>
- <p>ass fuck bitch shit scheisse kacke arsch ficker ficken schlampe</p>
- </section>
- <section class="option" id="ViolentWords"><h3>ViolentWords <span class="purpose">specify words considered to be aggressive/violent</span></h3>
- <pre><set ViolentWords="slaps beats kick"></pre>
- <h4>Description</h4>
- <p>There is a section in the "Most interesting numbers" which tells who is
- most "aggressive" - here you can define which words are considered being
- "violent". It is a space separated list of words. You can use * like in
- nick aliases. Can not be used in a channel-only context.</p>
- <h4>Default</h4>
- <p>slaps beats smacks</p>
- </section>
- <section class="option" id="BadUrls"><h3>BadUrls <span class="purpose">words that keep a URL out of the URL statistics</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- BadUrls = "imagetwist imgur.com postimg.cc/*"
- </channel>
- <set BadUrls="imagetwist imgur.com postimg.cc/*"></pre>
- <h4>Description</h4>
- <p>BadUrls is a list of words, separated by spaces, much like <a href="#FoulWords">FoulWords</a>.
- A URL that contains any of the words is not counted, so it never shows up in
- "Most referenced URLs" (see <a href="#ShowMru">ShowMru</a>). Use it to keep spam and
- unwanted image hosts out of the statistics.
- A word matches anywhere in the URL, whatever the case, so "imgur.com" also
- removes "https://i.imgur.com/abc.png". Two wildcards are understood: * stands for
- any run of characters and ? for exactly one character. So "postimg.cc/*" removes
- every link to postimg.cc (including "i.postimg.cc/x.png") but not
- "example.org/postimg.cc", where nothing follows the name, and "*.example.org/*"
- removes links on any subdomain of example.org but not on example.org itself.
- Apart from the wildcards the words are plain text, not regular expressions, so
- characters such as . + ( ) [ ] | mean exactly themselves. A lone * would remove every
- URL. To hide a single exact address instead, use the
- <a href="#ignoring-links">link ignore</a> setting.</p>
- <h4>Default</h4>
- <p>unset (no URLs are removed)</p>
- </section>
- <section class="option" id="MinQuote"><h3>MinQuote <span class="purpose">minimum numbers of letters for a random quote</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- MinQuote = "10"
- </channel>
- <set MinQuote="5"></pre>
- <h4>Description</h4>
- <p>The random quotes displayed in the "Most Active Nicks" section will be
- picked from a length range. With this option you can change the minimum
- number of letters required for a random quote. Also see the
- <a href="#MaxQuote">MaxQuote</a> option. Note that pisg will still choose a
- short quote if it cannot find a longer one.</p>
- <h4>Default</h4>
- <p>25</p>
- </section>
- <section class="option" id="MaxQuote"><h3>MaxQuote <span class="purpose">maximum numbers of letters for a random quote</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- MaxQuote = "70"
- </channel>
- <set MaxQuote="100"></pre>
- <h4>Description</h4>
- <p>The random quotes displayed in the "Most Active Nicks" section will be
- picked from a length range. With this option you can change the maximum
- number of letters required for a random quote. Also see the
- <a href="#MinQuote">MinQuote</a> option.</p>
- <h4>Default</h4>
- <p>65</p>
- </section>
- <section class="option" id="WordLength"><h3>WordLength <span class="purpose">minimum number of characters in an interesting word</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- WordLength = "10"
- </channel>
- <set WordLength="2"></pre>
- <h4>Description</h4>
- <p>The "Most Used Words" section on the stats page display the most used
- words. The default is that a word only appears if it is longer than 5
- characters. With this option you can change that minimum.</p>
- <h4>Default</h4>
- <p>5</p>
- </section>
- <section class="option" id="QuoteWidth"><h3>QuoteWidth <span class="purpose">maximum allowed length of a "word" with no spaces</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- QuoteWidth = "48"
- </channel>
- <set QuoteWidth="48"></pre>
- <h4>Description</h4>
- <p>Pisg will automatically insert a space in words that have a length
- over the amount QuoteWidth is set to. When used in breaking up
- URLs it will insert a space in the displayed URL, but not in the
- actual URL referenced by the HREF.</p>
- <h4>Default</h4>
- <p>80</p>
- </section>
- <section class="option" id="BigNumbersThreshold"><h3>BigNumbersThreshold <span class="purpose">Minimum number of lines per user for some "Big Numbers" statistics</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- BigNumbersThreshold = "10"
- </channel>
- <set BigNumbersThreshold="sqrt"></pre>
- <h4>Description</h4>
- <p>Pisg will ignore users with less than this setting lines in the "questions
- asked", "shouts loudest", "CAPSLOCK", "longest line", "most sad", and "most
- happy" sections. If the setting is "sqrt" (the default), it will be
- dynamically replaced with the square root of the number of lines of the
- most active nick. See also <a href="#ShowOnlyTop">ShowOnlyTop</a>.</p>
- <h4>Default</h4>
- <p>sqrt</p>
- </section>
- <section class="option" id="ActiveNicks"><h3>ActiveNicks <span class="purpose">nicks to show in "Most Active Nicks"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- ActiveNicks = "50"
- </channel>
- <set ActiveNicks="10"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many nicks you want to appear in the
- "Most Active Nicks" section on the stats page.</p>
- <h4>Default</h4>
- <p>25</p>
- </section>
- <section class="option" id="ActiveNicks2"><h3>ActiveNicks2 <span class="purpose">nicks to show in "These didn't make it.."</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- ActiveNicks2 = "25"
- </channel>
- <set ActiveNicks2="10"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many nicks you want to appear in the
- "These didn't make it" section on the stats page.</p>
- <h4>Default</h4>
- <p>30</p>
- </section>
- <section class="option" id="ActiveNicksByHour"><h3>ActiveNicksByHour <span class="purpose">number of nicks to show in "Most Active Nicks By Hour"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- ActiveNicksByHour = "25"
- </channel>
- <set ActiveNicksByHour="10"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many nicks you want to appear in the
- "Most Active Nicks By Hour" section on the stats page.</p>
- <h4>Default</h4>
- <p>10</p>
- </section>
- <section class="option" id="MostNicksHistory"><h3>MostNicksHistory <span class="purpose">maximum number of nicks to show in "users with most nicknames"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- MostNicksHistory = "2"
- </channel>
- <set MostNicksHistory="10"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many nicks you want to appear in
- the "Users with most nicknames" section. See also
- <a href="#ShowMostNicks">ShowMostNicks</a> and <a href="#MostNicksVerbose">MostNicksVerbose</a>.</p>
- <h4>Default</h4>
- <p>5</p>
- </section>
- <section class="option" id="MostNicksVerbose"><h3>MostNicksVerbose <span class="purpose">show nicks used in "most nicks"</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- MostNicksVerbose = "0"
- </channel>
- <set MostNicksVerbose="1"></pre>
- <h4>Description</h4>
- <p>By disabling this option you can stop pisg from displaying all the nicks
- a user has had in the "Most used nicks" section.
- See also <a href="#ShowMostNicks">ShowMostNicks</a>,
- <a href="#MostNicksHistory">MostNicksHistory</a>, and <a href="#NickLimit">NickLimit</a>.</p>
- <h4>Default</h4>
- <p>1 (enabled)</p>
- </section>
- <section class="option" id="TopicHistory"><h3>TopicHistory <span class="purpose">maximum number of topics to show</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- TopicHistory = "2"
- </channel>
- <set TopicHistory="10"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many topics you want to appear in
- the "Latest topics" section.</p>
- <h4>Default</h4>
- <p>3</p>
- </section>
- <section class="option" id="UrlHistory"><h3>UrlHistory <span class="purpose">maximum number of URLs to show</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- UrlHistory = "2"
- </channel>
- <set UrlHistory="10"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many URLs you want to appear in
- the "Most referenced URLs" section. See also <a href="#ShowMru">ShowMru</a>.</p>
- <h4>Default</h4>
- <p>5</p>
- </section>
- <section class="option" id="ChartsHistory"><h3>ChartsHistory <span class="purpose">number of songs to show</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- ChartsHistory = "10"
- </channel>
- <set ChartsHistory="5"></pre>
- <h4>Description</h4>
- <p>This option sets the number of songs that will be show in the channel music
- charts. See also <a href="#ShowCharts">ShowCharts</a> and
- <a href="#ChartsRegexp">ChartsRegexp</a>.</p>
- <h4>Default</h4>
- <p>5 (the Top Five)</p>
- </section>
- <section class="option" id="ChartsRegexp"><h3>ChartsRegexp <span class="purpose">how to recognize songs played</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- ChartsRegexp = "(?:is )?(?:np:|(?:now )?playing:? |listening to:? )(?:MPEG stream from)?\s*(.*)"
- </channel></pre>
- <h4>Description</h4>
- <p>This option is a perl regexp that is used to recognize songs played. Please
- tell the pisg mailing list if you have a better default. The regexp MUST
- contain a single () pair to extract the song name. See also the perlre(1)
- manpage, <a href="#ShowCharts">ShowCharts</a> and <a href="#ChartsHistory">ChartsHistory</a>.</p>
- <h4>Default</h4>
- <p>"(?:np:|(?:now )?playing:? (?:MPEG stream from)?)\s*(.*)"</p>
- </section>
- <section class="option" id="WordHistory"><h3>WordHistory <span class="purpose">maximum number of words to show</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- WordHistory = "5"
- </channel>
- <set WordHistory="15"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many words you want to appear in
- the "Most used words" section. See also <a href="#ShowMuw">ShowMuw</a>.</p>
- <h4>Default</h4>
- <p>10</p>
- </section>
- <section class="option" id="NickHistory"><h3>NickHistory <span class="purpose">maximum number of nicks to show in "Most referenced nicks"</span></h3>
- <pre><channel="#channel">
- logfile = "channel.log"
- format = "mIRC"
- NickHistory = "3"
- </channel>
- <set NickHistory="15"></pre>
- <h4>Description</h4>
- <p>With this option you can define how many nicks you want to appear in
- the "Most referenced nicks" section. See also <a href="#ShowMrn">ShowMrn</a>.</p>
- <h4>Default</h4>
- <p>5</p>
- </section>
- <section class="option" id="SmileyHistory"><h3>SmileyHistory <span class="purpose">maximum number of smileys to show in smiley stats</span></h3>
- <pre><channel="#channel">
- logfile = "channel.log"
- format = "mIRC"
- SmileyHistory = "3"
- </channel>
- <set SmileyHistory="15"></pre>
- <h4>Description</h4>
- <p>At most this many smileys will appear in smiley stats.
- See also <a href="#ShowSmileys">ShowSmileys</a>.</p>
- <h4>Default</h4>
- <p>10</p>
- </section>
- <section class="option" id="KarmaHistory"><h3>KarmaHistory <span class="purpose">maximum number of nicks to show in "Karma"</span></h3>
- <pre><channel="#channel">
- logfile = "channel.log"
- format = "mIRC"
- KarmaHistory = "3"
- </channel>
- <set KarmaHistory="15"></pre>
- <h4>Description</h4>
- <p>At most this many nicks will appear in the good and bad karma stats.
- See also <a href="#ShowKarma">ShowKarma</a> and <a href="#NickLimit">NickLimit</a>.</p>
- <h4>Default</h4>
- <p>5</p>
- </section>
- <section class="option" id="NickTracking"><h3>NickTracking <span class="purpose">track nick changes and create aliases</span></h3>
- <pre><set NickTracking="1"></pre>
- <h4>Description</h4>
- <p>Enabling this option will track nick changes as well as it can. It will
- then automatically create aliases for these nicks. Useful for
- <a href="#ShowMostNicks">ShowMostNicks</a> and other stats.
- Nick tracking does not work for log formats that do not use the nickname
- for the person running the logger, but only show "You" there.
- See <a href="#Maintainer">Maintainer</a>.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="NickLimit"><h3>NickLimit <span class="purpose">maximum number of nicks in lists</span></h3>
- <pre><set NickLimit="0"></pre>
- <h4>Description</h4>
- <p>This option trims lists of nicks to a maximum length, replacing the rest
- with "...". Setting to 0 disables trimming. Affected are the used nicks in
- the "Users with most nicknames" section, nicks in "Most active genders",
- and nicks in the "Good/bad karma by" columns. See
- <a href="#ShowMostNicks">ShowMostNicks</a>, <a href="#ShowKarma">ShowKarma</a>, and
- <a href="#ShowActiveGenders">ShowActiveGenders</a>.</p>
- <h4>Default</h4>
- <p>10</p>
- </section>
- <section class="option" id="SortByWords"><h3>SortByWords <span class="purpose">sort "most active nicks" by words</span></h3>
- <pre><channel="#channel">
- logfile = "channel.log"
- format = "xchat"
- SortByWords = "0"
- </channel>
- <set SortByWords="1"></pre>
- <h4>Description</h4>
- <p>The default for the "Most Active Nicks" section - is to sort users by
- lines. Enabling this will sort it by words instead.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- </section>
- <section class="chapter" id="reference-pictures"><h2>5. Picture options</h2>
- <section class="option" id="PicLocation"><h3>PicLocation <span class="purpose">path to images on stats page</span></h3>
- <pre><set PicLocation="gfx/"></pre>
- <h4>Description</h4>
- <p>The location to the pictures used on the stats page - not the user
- pictures but the different bars in "Most Active Times".</p>
- <h4>Default</h4>
- <p>Current directory</p>
- </section>
- <section class="option" id="UserPics"><h3>UserPics <span class="purpose">number of user pictures per row</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- UserPics = "no"
- </channel>
- <set UserPics="3"></pre>
- <h4>Description</h4>
- <p><code>UserPics</code> allows you to configure the number of user
- pictures per row. Per default, one picture will be shown. Since pictures
- are usually higher than one line of text, this lets the table grow. With
- settings greater than 1, several pictures will be placed next to each
- other. A good setting would be <code>UserPics</code>=3 and pictures
- of size 60x60. Set <code>UserPics</code> to no or 0 to disable user
- pictures. The latter is useful if you share a user config file between
- channels and want to disable user pictures for some channels.</p>
- <h4>Default</h4>
- <p>yes (1)</p>
- </section>
- <section class="option" id="ImagePath"><h3>ImagePath <span class="purpose">path to user pictures (HTML page)</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- ImagePath = "userpics/"
- </channel>
- <set ImagePath="users/"></pre>
- <h4>Description</h4>
- <p><code>ImagePath</code> defines the path to where user
- pictures are located, relative to the HTML page generated. The default is
- that user pictures is located in the same directory as the HTML page.</p>
- <h4>Default</h4>
- <p>current directory</p>
- </section>
- <section class="option" id="DefaultPic"><h3>DefaultPic <span class="purpose">use a default user picture</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- DefaultPic = "not_available.jpg"
- </channel>
- <set DefaultPic="unknown.gif"></pre>
- <h4>Description</h4>
- <p><code>DefaultPic</code> defines a picture to be displayed for all
- users which have no other picture defined in the <code>user</code>
- element. This is good for showing "No picture available" or something.
- May contain globbing patterns, see <a href="#ImageGlobPath">ImageGlobPath</a> below.</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- <section class="option" id="ImageGlobPath"><h3>ImageGlobPath <span class="purpose">path to user pictures (output generation)</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- ImageGlobPath = "users/"
- </channel>
- <set ImageGlobPath="/var/www/pisg/">
- <set DefaultPic="default-??.gif"></pre>
- <h4>Description</h4>
- <p><code>ImageGlobPath</code> defines the path to the directory where
- user pictures are located, relative to the current directory. This setting
- is used to choose random pictures if ? or * (globbing characters) are used
- in the picture name. ? matches a single character, * matches a (possibly
- empty) string. The default is the <a href="#ImagePath">ImagePath</a> setting.
- (NB: This setting will be different from <a href="#ImagePath">ImagePath</a> if
- the latter is not relative to the current directory, e.g. if you are
- writing the HTML file outside of the current directory.)</p>
- <h4>Default</h4>
- <p>current <a href="#ImagePath">ImagePath</a> setting</p>
- </section>
- <section class="option" id="PicWidth"><h3>PicWidth <span class="purpose">define a standard width for user pictures</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- PicWidth = "500"
- </channel>
- <set PicWidth="500"></pre>
- <h4>Description</h4>
- <p><code>PicWidth</code> defines the standard width for user
- pictures. Setting the 'width' attribute of image-elements on the
- outputted stats page. See also <a href="#PicHeight">PicHeight</a>.</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- <section class="option" id="PicHeight"><h3>PicHeight <span class="purpose">define a standard height for user pictures</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- PicHeight = "500"
- </channel>
- <set PicHeight="500"></pre>
- <h4>Description</h4>
- <p><code>PicHeight</code> defines the standard height for user
- pictures. Setting the 'height' attribute of image-elements on the
- outputted stats page. See also <a href="#PicWidth">PicWidth</a>.</p>
- <h4>Default</h4>
- <p>unset</p>
- </section>
- </section>
- <section class="chapter" id="reference-misc"><h2>6. Misc options</h2>
- <section class="option" id="Charset"><h3>Charset <span class="purpose">character set to use for stats page</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- Charset = "utf-8"
- </channel>
- <set Charset="iso-8859-15"></pre>
- <h4>Description</h4>
- <p>The pisg stats page defines a character set in a meta tag, this can be
- used if your country is using a different one than the default. Pisg
- will also use this setting to convert the language templates from
- <a href="#LangFile">LangFile</a> if the language defines a source charset.
- Note: you also have to tell your webserver to transmit the charset to
- the browser. With Apache, use "AddDefaultCharset off" in the server
- config.</p>
- <h4>Default</h4>
- <p>iso-8859-1</p>
- </section>
- <section class="option" id="LogCharset"><h3>LogCharset <span class="purpose">character set for logfiles</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- Charset = "iso-8859-1"
- LogCharset = "utf-8"
- </channel>
- <set Charset="iso-8859-15">
- <set LogCharset="iso-8859-15"></pre>
- <h4>Description</h4>
- <p>If <code>LogCharset</code> is set and different from
- <a href="#Charset">Charset</a>, pisg will convert the charset using
- Text::Iconv. Using this option slows down log processing.</p>
- <h4>Default</h4>
- <p>empty (no conversion)</p>
- </section>
- <section class="option" id="LogCharsetFallback"><h3>LogCharsetFallback <span class="purpose">fallback character set for logfiles</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "xchat"
- Charset = "utf-8"
- LogCharset = "utf-8"
- LogCharsetFallback = "iso-8859-1"
- </channel>
- <set Charset="utf-8">
- <set LogCharset="utf-8">
- <set LogCharsetFallback="iso-8859-15"></pre>
- <h4>Description</h4>
- <p><code>LogCharsetFallback</code> defines a fallback charset for
- the <a href="#LogCharset">LogCharset</a> conversion. This is useful if you
- have mixed unicode/iso-8859-* logs. Pisg will first try the conversion
- from <a href="#LogCharset">LogCharset</a>. If that fails,
- <code>LogCharsetFallback</code> is used. Note that this only works
- for charsets where certain byte sequences are illegal, like UTF-8. (In
- short: <code>LogCharset</code> = utf-8,
- <code>LogCharsetFallback</code> = iso-8859-15 works, the other way
- round does not.)</p>
- <h4>Default</h4>
- <p>empty (no fallback conversion)</p>
- </section>
- <section class="option" id="TimeOffset"><h3>TimeOffset <span class="purpose">use a different time zone than the local machine</span></h3>
- <pre><channel="#channel">
- Logfile = "channel.log"
- Format = "mIRC"
- Maintainer = "John"
- TimeOffset = "+5"
- </channel>
- <set TimeOffset="+2"></pre>
- <h4>Description</h4>
- <p>By default, pisg uses the time of the local machine to display the time
- of the generated stats. Sometimes when you have a shell on an external
- box, and it's in another country, you want to use another time. This is
- accomplished by the <code>TimeOffset</code> command.</p>
- <h4>Default</h4>
- <p>+0</p>
- </section>
- <section class="option" id="RegexpAliases"><h3>RegexpAliases <span class="purpose">use regular expressions in user aliases</span></h3>
- <pre><user nick="Joe" alias="Joe\d+">
- <set RegexpAliases="1"></pre>
- <h4>Description</h4>
- <p>Enabling this option will make all aliases in <user> lines be
- parsed as regular expressions; this setting also applies to the
- <a href="#IgnoreWords">IgnoreWords</a>, <a href="#FoulWords">FoulWords</a>, and
- <a href="#ViolentWords">ViolentWords</a> settings.</p>
- <h4>Default</h4>
- <p>0 (disabled)</p>
- </section>
- <section class="option" id="LangFile"><h3>LangFile <span class="purpose">filename of language file</span></h3>
- <pre><set LangFile="mylang.txt"></pre>
- <h4>Description</h4>
- <p>With this option you have an alternative way to define the name and/or
- path to the language file. Usually you don't have to touch this option.</p>
- <h4>Default</h4>
- <p>lang.txt</p>
- </section>
- <section class="option" id="CssDir"><h3>CssDir <span class="purpose">path to directory with CSS files</span></h3>
- <pre><set CssDir="/usr/share/pisg/layout/"></pre>
- <h4>Description</h4>
- <p><code>CssDir</code> is used to define the paths to the CSS files
- (the <a href="#ColorScheme">ColorScheme</a>s). Usually you don't
- need to change this. This setting is only used when statically including
- the CSS file.</p>
- <h4>Default</h4>
- <p>layout/ (in current directory)</p>
- </section>
- <section class="option" id="HiCell"><h3>HiCell, HiCell2 <span class="purpose">colors for color gradient in most active nicks section</span></h3>
- <pre><set HiCell="#BABADD" HiCell2="#CCCCCC">
- <set HiCell=""></pre>
- <h4>Description</h4>
- <p><code>HiCell</code> and <code>HiCell2</code> define the colors
- to be used for the color gradient in the most active nicks section. They should
- match your <a href="#ColorScheme">ColorScheme</a>. When setting
- <code>HiCell</code> the empty string (""), pisg will not generate a color
- gradient; you might want to use this with <a href="#ColorScheme">ColorScheme</a>="none"
- or <a href="#AltColorScheme">AltColorScheme</a>.</p>
- <h4>Default</h4>
- <p>#BABADD, #CCCCCC</p>
- </section>
- <section class="option" id="LogType"><h3>LogType <span class="purpose">type of log (not the format of the log)</span></h3>
- <pre><set LogType="Logfile"></pre>
- <h4>Description</h4>
- <p>The type of logs kept for your channel. Currently only "Logfile" is
- supported, so you don't need to change this option.</p>
- <h4>Default</h4>
- <p>Logfile</p>
- </section>
- <section class="option" id="StatsDump"><h3>StatsDump <span class="purpose">dump raw statistics into file</span></h3>
- <pre><set StatsDump="statsdump"></pre>
- <h4>Description</h4>
- <p>This option is intended for debugging pisg, but might be useful to process
- the parsed logs with another program. The file contains the %stats and
- %lines hashes in perl's Data::Dumper format.</p>
- <h4>Default</h4>
- <p>Unset</p>
- </section>
- </section>
- <section class="chapter" id="copyright"><h2>7. Copyright and License</h2>
- <p>pisg - Perl IRC Statistics Generator</p>
- <p>Copyright (C) 2001-2012 The pisg project</p>
- <p>This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.</p>
- <p>This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.</p>
- <p>You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</p>
- </section>
- <section class="chapter" id="example-config">
- <h2>8. Complete example configuration</h2>
- <p>A ready-to-use <code>pisg.cfg</code> for a channel called <code>#example</code>. It lists every
- option pisg understands, with what it does, so you can copy it and change only the lines marked
- <code>EDIT</code>: the log file, its format, the network name, the output file and your name.
- Options are at pisg's own defaults unless the comment says <em>recommended</em>.</p>
- <ol>
- <li>Copy the file below (or download it) and save it as <code>pisg.cfg</code> next to <code>pisg</code>.</li>
- <li>Change the <code>EDIT</code> values in the <code><channel></code> block.</li>
- <li>Run <code>./pisg</code>.</li>
- </ol>
- <div class="codewrap">
- <div class="codebar"><span>pisg.cfg</span>
- <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%20canada%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%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>
- <button class="btn copy" type="button" data-target="cfg-example">Copy</button></div>
- <pre id="cfg-example" class="cfg"># pisg.cfg.example - a complete configuration for pisg, ready to copy.
- #
- # 1. Copy this file to pisg.cfg
- # 2. Change the values marked EDIT (log path, format, network, output file, name)
- # 3. Run ./pisg
- #
- # Every option pisg understands is listed below with its meaning. Options are set to
- # pisg's own default unless the comment says "recommended". Lines starting with # are
- # comments; an option shown commented out is off/unset - remove the # to use it.
- #
- # Syntax reminders:
- # <set Name="value"> a global option, applies to every channel
- # <channel="#name"> ... </channel> settings for one channel (they override <set>)
- # <user nick="..." ...> per-user settings
- # Each <set> must be on one line, and every value must be in quotes.
- ##############################################################################
- # GLOBAL OPTIONS - apply to every channel below
- ##############################################################################
- # ---- General options -------------------------------------------------------
- # use a different color scheme for stats page - recommended: modern, light/dark theme;
- # try midnight, amoled, terminal, canada, or default
- <set ColorScheme="modern">
- # alternate stylesheets for stats page - extra stylesheets the visitor can switch to
- #<set AltColorScheme="midnight.css amoled.css">
- # define the language / translation to use
- <set Lang="EN">
- # define a file as page header - HTML file inserted above the statistics
- #<set PageHead="header.html">
- # define a file as page footer - HTML file inserted below the statistics
- #<set PageFoot="footer.html">
- # make pisg silent, suppress messages
- <set Silent="0">
- # use a cache to speed up log parsing - cache parsed logs here to speed up runs (delete
- # it when you change settings)
- #<set CacheDir="cache/">
- # name of the channel list file for a landing page
- <set ChannelIndex="channels.json">
- # adds a button at the top of every stats page that leads back to your landing page
- <set HomeLink="">
- # enable/disable the section bar at the top of the page
- <set ShowNavBar="1">
- # ---- Options for various statistics features -------------------------------
- # number of days to show in "Daily Actitity" - recommended: show the last 14 days as a
- # bar chart
- <set DailyActivity="14">
- # enable/disable "Most Active Times"
- <set ShowActiveTimes="1">
- # enable/disable "Most Active Nicks"
- <set ShowActiveNicks="1">
- # enable/disable "Big Numbers" sections
- <set ShowBigNumbers="1">
- # enable/disable "Latest topics" sections
- <set ShowTopics="1">
- # enable/disable "number of lines"
- <set ShowLines="1">
- # enable/disable "words per line" - recommended: also show words per line
- <set ShowWpl="1">
- # enable/disable "characters per line" - recommended: also show characters per line
- <set ShowCpl="1">
- # enable/disable "number of words" - recommended: also show total words
- <set ShowWords="1">
- # show when a user was last seen on a channel
- <set ShowLastSeen="1">
- # show when a nick was active
- <set ShowTime="1">
- # mIRCStats like behaviour of time bar
- <set ShowLineTime="0">
- # ShowLineTime like behavior of words column
- <set ShowWordTime="0">
- # enable or disable the random quotes
- <set ShowRandQuote="1">
- # enable or disable the legend of the time bars
- <set ShowLegend="1">
- # enable or disable the kick line
- <set ShowKickLine="1">
- # enable or disable the action line
- <set ShowActionLine="1">
- # enable or disable the shout line
- <set ShowShoutLine="1">
- # set how many decimals to show
- <set ShowFoulDecimals="1">
- # enable or disable the foul line
- <set ShowFoulLine="0">
- # enable or disable the violent lines
- <set ShowViolentLines="1">
- # enable or disable "Most used words"
- <set ShowMuw="1">
- # enable or disable "Most referenced nicks"
- <set ShowMrn="1">
- # enable or disable "Most referenced URLs"
- <set ShowMru="1">
- # enable or disable channel music charts
- <set ShowCharts="0">
- # enable or disable op statistics
- <set ShowOps="1">
- # enable or disable voice statistics
- <set ShowVoices="0">
- # enable or disable halfop statistics
- <set ShowHalfops="0">
- # show who changed nick most often - recommended: show who changed nick most often
- <set ShowMostNicks="1">
- # show stats on which gender talked most
- <set ShowActiveGenders="0">
- # show most used smileys - recommended: show the most used smileys
- <set ShowSmileys="1">
- # show channel karma - recommended: show karma (nick++ / nick--)
- <set ShowKarma="1">
- # show most active nicks by hour - recommended: show the most active nicks by time of
- # day
- <set ShowMostActiveByHour="1">
- # only count stats for top talkers, ignore less-active users
- <set ShowOnlyTop="0">
- # show graphs in most active nicks by hour
- <set ShowMostActiveByHourGraph="1">
- # enable/disable the channel overview
- <set ShowOverview="1">
- # enable/disable the relation map and its tables
- <set ShowRelations="1">
- # number of nicks on the relation map
- <set RelationNicks="30">
- # minimum connection strength shown as a line on the relation map
- <set RelationMinWeight="3">
- # enable/disable the time personalities section
- <set ShowTimePersonalities="1">
- # enable/disable the "who carries the channel" section
- <set ShowConcentration="1">
- # enable/disable the signature words section
- <set ShowSignatureWords="1">
- # ignore specified words - words to leave out of the word statistics
- #<set IgnoreWords="badword otherword">
- # Control random quote output
- <set NoIgnoredQuotes="0">
- # specify words considered to be bad/FoulWords language
- <set FoulWords="ass fuck bitch shit scheisse scheiße kacke arsch ficker ficken schlampe">
- # specify words considered to be aggressive/violent
- <set ViolentWords="slaps beats smacks">
- # words that keep a URL out of the URL statistics - matched anywhere in a URL, any case;
- # * = any characters, ? = one; for spam and unwanted image hosts
- #<set BadUrls="imagetwist imgur.com postimg.cc/*">
- # minimum numbers of letters for a random quote
- <set MinQuote="25">
- # maximum numbers of letters for a random quote
- <set MaxQuote="65">
- # minimum number of characters in an interesting word
- <set WordLength="5">
- # maximum allowed length of a "word" with no spaces
- <set QuoteWidth="80">
- # Minimum number of lines per user for some "Big Numbers" statistics
- <set BigNumbersThreshold="sqrt">
- # nicks to show in "Most Active Nicks"
- <set ActiveNicks="25">
- # nicks to show in "These didn't make it.."
- <set ActiveNicks2="30">
- # number of nicks to show in "Most Active Nicks By Hour"
- <set ActiveNicksByHour="10">
- # maximum number of nicks to show in "users with most nicknames"
- <set MostNicksHistory="5">
- # show nicks used in "most nicks"
- <set MostNicksVerbose="1">
- # maximum number of topics to show - recommended: show the last 5 topics
- <set TopicHistory="5">
- # maximum number of URLs to show
- <set UrlHistory="5">
- # number of songs to show
- <set ChartsHistory="5">
- # how to recognize songs played
- <set ChartsRegexp="(?:is )?(?:np:|(?:now )?playing:? |listening to:? )(?:MPEG stream from)?\s*(.*)">
- # maximum number of words to show
- <set WordHistory="10">
- # maximum number of nicks to show in "Most referenced nicks"
- <set NickHistory="5">
- # maximum number of smileys to show in smiley stats
- <set SmileyHistory="10">
- # maximum number of nicks to show in "Karma"
- <set KarmaHistory="5">
- # track nick changes and create aliases - recommended: follow nick changes so Alice,
- # Alice_ and Alice- count as one person
- <set NickTracking="1">
- # maximum number of nicks in lists
- <set NickLimit="10">
- # sort "most active nicks" by words
- <set SortByWords="0">
- # ---- Picture options -------------------------------------------------------
- # path to images on stats page
- <set PicLocation=".">
- # number of user pictures per row
- <set UserPics="1">
- # path to user pictures (HTML page) - folder of user pictures, as seen by the web page
- #<set ImagePath="images/">
- # use a default user picture - picture shown for users who have none
- #<set DefaultPic="images/nobody.png">
- # path to user pictures (output generation) - folder of user pictures, as seen by pisg
- # (for pic="x_*.jpg" globs)
- #<set ImageGlobPath="/var/www/pisg/images/">
- # define a standard width for user pictures - show every user picture this wide, in
- # pixels
- #<set PicWidth="55">
- # define a standard height for user pictures - show every user picture this tall, in
- # pixels
- #<set PicHeight="55">
- # ---- Misc options ----------------------------------------------------------
- # character set to use for stats page - recommended: UTF-8 shows accents, emoji and non-
- # Latin scripts correctly
- <set Charset="utf-8">
- # character set for logfiles - convert logs from this charset (needs the Text::Iconv
- # perl module)
- #<set LogCharset="iso-8859-1">
- # fallback character set for logfiles - used for lines that are not valid in LogCharset
- # (needs Text::Iconv)
- #<set LogCharsetFallback="iso-8859-1">
- # use a different time zone than the local machine
- <set TimeOffset="+0">
- # use regular expressions in user aliases
- <set RegexpAliases="0">
- # filename of language file
- <set LangFile="lang.txt">
- # path to directory with CSS files
- <set CssDir="layout/">
- # colors for color gradient in most active nicks section
- <set HiCell="#BABADD">
- <set HiCell2="#CCCCCC">
- # colors for color gradient in most active nicks section
- <set HiCell2="#CCCCCC">
- # dump raw statistics into file - debugging: dump the raw statistics to this file
- #<set StatsDump="stats.dump">
- # ---- Advanced (not in the original documentation) -------------------------
- # nicks of bots, for log formats that cannot tell bots from people (DCpp)
- #<set BotNicks="bot1 bot2">
- # width in pixels of the statistics tables
- <set TableWidth="574">
- # image id of the horizontal bar for hours 0-5
- <set Pic_H_0="blue-h">
- # image id of the horizontal bar for hours 6-11
- <set Pic_H_6="green-h">
- # image id of the horizontal bar for hours 12-17
- <set Pic_H_12="yellow-h">
- # image id of the horizontal bar for hours 18-23
- <set Pic_H_18="red-h">
- # image id of the vertical bar for hours 0-5
- <set Pic_V_0="blue-v">
- # image id of the vertical bar for hours 6-11
- <set Pic_V_6="green-v">
- # image id of the vertical bar for hours 12-17
- <set Pic_V_12="yellow-v">
- # image id of the vertical bar for hours 18-23
- <set Pic_V_18="red-v">
- ##############################################################################
- # YOUR CHANNEL - copy this block for each extra channel
- ##############################################################################
- <channel="#example">
- # Logfile: the log to read; you can list several Logfile lines EDIT
- Logfile="/path/to/example.log"
- # LogDir: use INSTEAD of Logfile to read a whole folder of dated logs
- #LogDir="/path/to/logs/"
- # LogPrefix: with LogDir: only read files starting with this
- #LogPrefix="example.log."
- # LogSuffix: with LogDir: date format at the end of the file names, so they sort by
- # date
- #LogSuffix=".%d%b%Y"
- # NFiles: with LogDir: only parse the newest N files (0 = all)
- #NFiles="30"
- # Format: your log format: eggdrop, mIRC, xchat, irssi, ... (see docs/FORMATS) EDIT
- Format="eggdrop"
- # Network: the IRC network, shown on the page EDIT
- Network="ExampleNet"
- # OutputFile: the page pisg writes EDIT
- OutputFile="/var/www/html/example.html"
- # OutputTag: replaces %t in OutputFile; used with the -nf / -t command line options
- #OutputTag="-week"
- # Maintainer: who is named as maintainer on the page EDIT
- Maintainer="Your Name"
- # LogType: only "Logfile" exists, leave it
- LogType="Logfile"
- # Any global option can be overridden for this channel only, for example:
- #Lang="FR"
- #ColorScheme="midnight"
- </channel>
- ##############################################################################
- # USERS - link nicks together, add pictures, mark bots
- ##############################################################################
- # nick the name shown in the stats (required)
- # alias other nicks of the same person, space separated; * matches anything
- # (Joe* also counts Joe_, Joe^away ...). NickTracking="1" also finds many
- # pic picture shown next to the user bigpic larger picture it links to
- # link a web address or e-mail address sex m, f or b (bot)
- # ignore y = leave this nick out of the stats altogether (for bots)
- <user nick="Alice" alias="Alice_ Alice-* AliceAway" pic="alice.png" link="https://example.com/alice" sex="f">
- <user nick="Bob" alias="Bob_ Bobby" pic="bob.png" bigpic="bob-big.png" link="bob@example.com" sex="m">
- <user nick="ChanBot" sex="b" ignore="y">
- ##############################################################################
- # LINKS - keep addresses out of "Most referenced URLs"
- ##############################################################################
- <link url="https://example.com/spam" ignore="y">
- ##############################################################################
- # INCLUDE - share users between channels or config files
- ##############################################################################
- # Put your <user> lines in users.cfg and load them here (an included file cannot
- # include another file):
- #<include="users.cfg">
- </pre>
- </div>
- </section>
- </main>
- <script>
- document.querySelectorAll('.copy').forEach(function (b) {
- b.addEventListener('click', function () {
- var pre = document.getElementById(b.dataset.target), text = pre.textContent;
- function done(ok) { var old = b.textContent; b.textContent = ok ? 'Copied!' : 'Press Ctrl+C';
- setTimeout(function () { b.textContent = old; }, 1800); }
- function fallback() { var r = document.createRange(); r.selectNodeContents(pre);
- var s = window.getSelection(); s.removeAllRanges(); s.addRange(r);
- var ok = false; try { ok = document.execCommand('copy'); } catch (e) {} done(ok); }
- if (navigator.clipboard && window.isSecureContext) { navigator.clipboard.writeText(text).then(function () { done(true); }, fallback); }
- else { fallback(); }
- });
- });
- </script>
- </body>
- </html>
|