Git

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>">
18 ]>
20 <refentry>
22   <refentryinfo>
23     <address>
24       &dhemail;
25     </address>
26     <author>
27       &dhfirstname;
28       &dhsurname;
29     </author>
30     <copyright>
31       <year>2004</year>
32       <holder>&dhusername;</holder>
33     </copyright>
34     &dhdate;
35   </refentryinfo>
36   
37   <refmeta>
38     &dhucpackage;
39     &dhsection;
40   </refmeta>
41   
42   <refnamediv>
43     <refname>&dhpackage;</refname>
44     <refpurpose>A tool to generate HTML IRC stats based on irssi logs.</refpurpose>
45   </refnamediv>
46   
47   <refsynopsisdiv>
48     <cmdsynopsis>
49       <command>&dhpackage;</command>
50       <arg><option><replaceable>/path/to/file.conf</replaceable></option></arg>
51     </cmdsynopsis>
52   </refsynopsisdiv>
53   
54   <refsect1>
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>
58   </refsect1>
59   
60   <refsect1>
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>
68   </refsect1>
69   
70   
71   <refsect1>
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>
82     
83     <para>Available options are :</para>
84     
85     <variablelist>
86       
87       <varlistentry>
88         <term>debug</term>
89         <listitem>
90           <para>Allows you to display debugging informations.</para>
91           <para>Values : normal / verbose / none</para>
92           <para>Default : normal</para>
93         </listitem>
94       </varlistentry>
95       
96       <varlistentry>
97         <term>channel</term>
98         <listitem><para>Specifies the name of the channel you are parsing.</para></listitem>
99       </varlistentry>
100       
101       <varlistentry>
102         <term>maintainer</term>
103         <listitem><para>Nickname of the person generating the statistics (you !).</para></listitem>
104       </varlistentry>
105       
106       <varlistentry>
107         <term>language</term>
108         <listitem>
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>
112         </listitem>
113       </varlistentry>
114       
115       <varlistentry>
116         <term>theme</term>
117         <listitem>
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>
122         </listitem>
123       </varlistentry>
124       
125       <varlistentry>
126         <term>top_words</term>
127         <listitem>
128           <para>Allows you to disable top words list which is using a lot of memory</para>
129           <para>Default : yes</para>
130         </listitem>
131       </varlistentry>
132       
133       <varlistentry>
134         <term>ranking</term>
135         <listitem>
136           <para>Specifies which ranking method to use</para>
137           <para>Values : lines / words / letters</para>
138           <para>Default : lines</para>
139         </listitem>
140       </varlistentry>
141       
142       <varlistentry>
143         <term>quarter</term>
144         <listitem>
145           <para>Display quarters in top hours (smoother graphs)</para>
146           <para>Default : no</para>
147         </listitem>
148       </varlistentry>
149       
150       <varlistentry>
151         <term>weeks</term>
152         <listitem>
153           <para>Display last week statistics</para>
154           <para>Default : no</para>
155         </listitem>
156       </varlistentry>
157       
158       <varlistentry>
159         <term>months</term>
160         <listitem>
161           <para>Display last months statistics</para>
162           <para>Default : no</para>
163         </listitem>
164       </varlistentry>
165       
166       <varlistentry>
167         <term>refresh_time</term>
168         <listitem>
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>
172         </listitem>
173       </varlistentry>
174       
175       <varlistentry>
176         <term>photo_size</term>
177         <listitem>
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>
182         </listitem>
183       </varlistentry>
184       
185       <varlistentry>
186         <term>w3c_link</term>
187         <listitem>
188           <para>Set this to "no" if you don't want the W3C logo.</para>
189           <para>Default : yes</para>
190         </listitem>
191       </varlistentry>
192       
193       <varlistentry>
194         <term>logo</term>
195         <listitem>
196           <para>Set this to "no" if you don't want the irssistats logo.</para>
197           <para>Default : yes</para>
198         </listitem>
199       </varlistentry>
200       
201       <varlistentry>
202         <term>header</term>
203         <listitem><para>Use your custom header file (HTML code between &lt;!DOCTYPE... and &lt;body&gt; included)</para></listitem>
204       </varlistentry>
205       
206       <varlistentry>
207         <term>footer</term>
208         <listitem><para>Use your custom footer file (HTML code between &lt;/body&gt; and &lt;/html&gt; included)</para>
209         </listitem>
210       </varlistentry>
211       
212       <varlistentry>
213         <term>input</term>
214         <listitem>
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>
217         </listitem>
218       </varlistentry>
219       
220       <varlistentry>
221         <term>nickfile</term>
222         <listitem>
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>
225         </listitem>
226       </varlistentry>
227       
228       <varlistentry>
229         <term>photofile</term>
230         <listitem>
231           <para>This allow you to display pictures for users.</para>
232         </listitem>
233       </varlistentry>
234       
235       <varlistentry>
236         <term>output</term>
237         <listitem>
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>
240         </listitem>
241       </varlistentry>
242       
243     </variablelist>
244     
245   </refsect1>
246   
247   
248   <refsect1>
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>
253     <variablelist>
254       <varlistentry>
255         <term>royale &circ;[Rr]oyale</term>
256         <listitem><para>join nicks starting with "Royale" or "royale" to the final nick "royale"</para></listitem>
257       </varlistentry>
258       <varlistentry>
259         <term>royale &circ;antoine$</term>
260         <listitem><para>also join the nick "antoine" to the final nick "royale"</para></listitem>
261       </varlistentry>
262       <varlistentry>
263         <term>djakette [Dd]ja</term>
264         <listitem><para>join any nick that contains "Dja" or "dja" to final nick "djakette"</para></listitem>
265       </varlistentry>
266       <varlistentry>
267         <term>&lt;NULL&gt; &circ;bot\|royale$</term>
268         <listitem><para>remove "bot|royale" from statistics</para></listitem>
269       </varlistentry>
270     </variablelist>
271     <para>The nickfile must not contain any comments.</para>
272     <para>The &lt;NULL&gt; 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>
274   </refsect1>
275   
276   
277   <refsect1>
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>
282     <variablelist>
283       <varlistentry>
284         <term>royale http://royale.zerezo.com/chat/faces/happy40.png</term>
285         <listitem><para>(a full address)</para></listitem>
286       </varlistentry>
287       <varlistentry>
288         <term>sektor ../chat/faces/happy40.png</term>
289         <listitem><para>(a relative address)</para></listitem>
290       </varlistentry>
291     </variablelist>
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>
294   </refsect1>
295   
296   
297   <refsect1>
298     <title>SEE ALSO</title>
299     <para><command>irssi</command> (1).</para>
300   </refsect1>
301   
302   <refsect1>
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>
306   </refsect1>
308   <refsect1>
309     <title>AUTHOR</title>
310     <para>Antoine Jacquet &dhemail;</para>
311   </refsect1>
313 </refentry>
315 <!-- Keep this comment at the end of the file
316 Local variables:
317 mode: sgml
318 sgml-omittag:t
319 sgml-shorttag:t
320 sgml-minimize-attributes:nil
321 sgml-always-quote-attributes:t
322 sgml-indent-step:2
323 sgml-indent-data: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
329 End:
330 -->