1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
3 <!ENTITY dhfirstname "<firstname>JACQUET</firstname>">
4 <!ENTITY dhsurname "<surname>ANTOINE</surname>">
5 <!-- Please adjust the date whenever revising the manpage. -->
6 <!ENTITY dhdate "<date>april 4, 2004</date>">
7 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
8 allowed: see man(7), man(1). -->
9 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
10 <!ENTITY dhemail "<email>royale@zerezo.com</email>">
11 <!ENTITY dhusername "Antoine Jacquet">
12 <!ENTITY dhucpackage "<refentrytitle>IRSSISTATS</refentrytitle>">
13 <!ENTITY dhpackage "irssistats">
15 <!ENTITY debian "<productname>Debian</productname>">
16 <!ENTITY gnu "<acronym>GNU</acronym>">
17 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
32 <holder>&dhusername;</holder>
43 <refname>&dhpackage;</refname>
44 <refpurpose>A tool to generate HTML IRC stats based on irssi logs.</refpurpose>
49 <command>&dhpackage;</command>
50 <arg><option><replaceable>/path/to/file.conf</replaceable></option></arg>
55 <title>DESCRIPTION</title>
56 <para><command>irssistats</command> is a tool that make HTML stats from <command>irssi</command> logfiles.</para>
57 <para>The statistics generated display many useful and funny informations about the channel.</para>
61 <title>USING IT</title>
62 <para>First you need to copy the files needed for the HTML page :</para>
63 <para><command>cp /usr/share/irssistats/data/* /path/to/webdir/</command></para>
64 <para>Then you must edit a configuration file : "/etc/irssistats.conf", "~/.irssistats", or another file given as a parameter.</para>
65 <para>Now you can generate the statistics for your channel :</para>
66 <para><command>irssistats <option><replaceable>[/path/to/file.conf]</replaceable></option></command></para>
67 <para>The logfiles for <command>irssi</command> are usually located in "~/irclogs/network/channel.log"</para>
72 <title>CONFIGURATION FILE</title>
73 <para>Please look at the sample configuration file in "/usr/share/docs/irssistats/sample.configfile" for an example.</para>
74 <para>The path to the configuration file can be given on the command line : <command>irssistats</command> <replaceable>/path/to/irssistats.conf</replaceable></para>
75 <para>If no configuration file is given, irssistats looks for files ~/.irssistats.conf or then /etc/irssistats.conf</para>
76 <para>Lines starting by ; # -- or // are ignored (comments).</para>
77 <para>This file is read sequencially, so it acts like a script.</para>
78 <para>Each option keyword is case sensitive, and you must put separators around the ':' character.</para>
79 <para>Blank lines must not contain any spaces !</para>
80 <para>Each option keeps its value until erased by another value.</para>
81 <para>IMPORTANT : the order of options to parse a channel must allways be "input" THEN "nickfile" THEN "photofile" THEN "output".</para>
83 <para>Available options are :</para>
90 <para>Allows you to display debugging informations.</para>
91 <para>Values : normal / verbose / none</para>
92 <para>Default : normal</para>
98 <listitem><para>Specifies the name of the channel you are parsing.</para></listitem>
102 <term>maintainer</term>
103 <listitem><para>Nickname of the person generating the statistics (you !).</para></listitem>
107 <term>language</term>
109 <para>Language you want to use to display the statistics</para>
110 <para>Values : fr en de du es it fi ru et</para>
111 <para>Default : en</para>
118 <para>Theme (colors) to use for the statistics, separated by comas</para>
119 <para>In fact this is the name of the CSS file to include.</para>
120 <para>This option has no effect if you use a custom header : you'll have to include the CSS yourself.</para>
121 <para>The first theme is the primary stylesheet, and the others are alternate themes</para>
126 <term>top_words</term>
128 <para>Allows you to disable top words list which is using a lot of memory</para>
129 <para>Default : yes</para>
136 <para>Specifies which ranking method to use</para>
137 <para>Values : lines / words / letters</para>
138 <para>Default : lines</para>
145 <para>Display quarters in top hours (smoother graphs)</para>
146 <para>Default : no</para>
153 <para>Display last week statistics</para>
154 <para>Default : no</para>
161 <para>Display last months statistics</para>
162 <para>Default : no</para>
167 <term>refresh_time</term>
169 <para>Specifies the refresh time in seconds (0 to disable)</para>
170 <para>This option has no effect if you use a custom header : you'll have to include the refresh code yourself.</para>
171 <para>Default : 3600</para>
176 <term>photo_size</term>
178 <para>Specifies the size in pixels of the thumbnails for users</para>
179 <para>This option has an effect only if there is a photofile (see below)</para>
180 <para>Set to 0 to disable (display pictures with their real size)</para>
181 <para>Default : 60</para>
186 <term>w3c_link</term>
188 <para>Set this to "no" if you don't want the W3C logo.</para>
189 <para>Default : yes</para>
196 <para>Set this to "no" if you don't want the irssistats logo.</para>
197 <para>Default : yes</para>
203 <listitem><para>Use your custom header file (HTML code between <!DOCTYPE... and <body> included)</para></listitem>
208 <listitem><para>Use your custom footer file (HTML code between </body> and </html> included)</para>
215 <para>This allow you to parse a file.</para>
216 <para>Note that irssistats will really parse the file as soon as it reads this option.</para>
221 <term>nickfile</term>
223 <para>This allow you to group nick using a nickfile.</para>
224 <para>Note that irssistats will really merge the nicks as soon as it reads this option.</para>
229 <term>photofile</term>
231 <para>This allow you to display pictures for users.</para>
238 <para>This allow you to generate the HTML file.</para>
239 <para>Note that irssistats will really generate the HTML file as soon as it reads this option.</para>
249 <title>NICKFILE</title>
250 <para>Since version 0.4 of <command>irssistats</command>, you can use a nickfile to specify nicks to join.</para>
251 <para>Each line of the nickfile contains the final nick and a regular expression.</para>
252 <para>Examples :</para>
255 <term>royale ˆ[Rr]oyale</term>
256 <listitem><para>join nicks starting with "Royale" or "royale" to the final nick "royale"</para></listitem>
259 <term>royale ˆantoine$</term>
260 <listitem><para>also join the nick "antoine" to the final nick "royale"</para></listitem>
263 <term>djakette [Dd]ja</term>
264 <listitem><para>join any nick that contains "Dja" or "dja" to final nick "djakette"</para></listitem>
267 <term><NULL> ˆbot\|royale$</term>
268 <listitem><para>remove "bot|royale" from statistics</para></listitem>
271 <para>The nickfile must not contain any comments.</para>
272 <para>The <NULL> final nick will remove matching nicks from all statistics, except from "Some URLs" and "Some topics"...</para>
273 <para>You can also take a look at the "sample.nickfile" in this package (in "/usr/share/doc/irssistats/").</para>
278 <title>PHOTOFILE</title>
279 <para>Since version 0.70 of <command>irssistats</command>, you can use a photofile to display pictures for users.</para>
280 <para>Each line of the photofile contains the final nick and an URL for the image.</para>
281 <para>Examples :</para>
284 <term>royale http://royale.zerezo.com/chat/faces/happy40.png</term>
285 <listitem><para>(a full address)</para></listitem>
288 <term>sektor ../chat/faces/happy40.png</term>
289 <listitem><para>(a relative address)</para></listitem>
292 <para>The photofile must not contain any comments.</para>
293 <para>You can also take a look at the "sample.photofile" in this package (in "/usr/share/doc/irssistats/").</para>
298 <title>SEE ALSO</title>
299 <para><command>irssi</command> (1).</para>
303 <title>INFORMATIONS</title>
304 <para>You can find informations and updates of <command>irssistats</command> at <ulink url="http://royale.zerezo.com/irssistats/">http://royale.zerezo.com/irssistats/</ulink>.</para>
305 <para>Report bugs to &dhemail;.</para>
309 <title>AUTHOR</title>
310 <para>Antoine Jacquet &dhemail;</para>
315 <!-- Keep this comment at the end of the file
320 sgml-minimize-attributes:nil
321 sgml-always-quote-attributes:t
324 sgml-parent-document:nil
325 sgml-default-dtd-file:nil
326 sgml-exposed-tags:nil
327 sgml-local-catalogs:nil
328 sgml-local-ecat-files:nil