royale.zerezo.com Git - irssistats/blob - irssistats.sgml

   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">
  14
  15   <!ENTITY debian      "<productname>Debian</productname>">
  16   <!ENTITY gnu         "<acronym>GNU</acronym>">
  17   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  18 ]>
  19
  20 <refentry>
  21
  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>refresh_time</term>
 152         <listitem>
 153           <para>Specifies the refresh time in seconds (0 to disable)</para>
 154           <para>This option has no effect if you use a custom header : you'll have to include the refresh code yourself.</para>
 155           <para>Default : 3600</para>
 156         </listitem>
 157       </varlistentry>
 158
 159       <varlistentry>
 160         <term>photo_size</term>
 161         <listitem>
 162           <para>Specifies the size in pixels of the thumbnails for users</para>
 163           <para>This option has an effect only if there is a photofile (see below)</para>
 164           <para>Set to 0 to disable (display pictures with their real size)</para>
 165           <para>Default : 60</para>
 166         </listitem>
 167       </varlistentry>
 168
 169       <varlistentry>
 170         <term>w3c_link</term>
 171         <listitem>
 172           <para>Set this to "no" if you don't want the W3C logo.</para>
 173           <para>Default : yes</para>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry>
 178         <term>logo</term>
 179         <listitem>
 180           <para>Set this to "no" if you don't want the irssistats logo.</para>
 181           <para>Default : yes</para>
 182         </listitem>
 183       </varlistentry>
 184
 185       <varlistentry>
 186         <term>header</term>
 187         <listitem><para>Use your custom header file (HTML code between &lt;!DOCTYPE... and &lt;body&gt; included)</para></listitem>
 188       </varlistentry>
 189
 190       <varlistentry>
 191         <term>footer</term>
 192         <listitem><para>Use your custom footer file (HTML code between &lt;/body&gt; and &lt;/html&gt; included)</para>
 193         </listitem>
 194       </varlistentry>
 195
 196       <varlistentry>
 197         <term>input</term>
 198         <listitem>
 199           <para>This allow you to parse a file.</para>
 200           <para>Note that irssistats will really parse the file as soon as it reads this option.</para>
 201         </listitem>
 202       </varlistentry>
 203
 204       <varlistentry>
 205         <term>nickfile</term>
 206         <listitem>
 207           <para>This allow you to group nick using a nickfile.</para>
 208           <para>Note that irssistats will really merge the nicks as soon as it reads this option.</para>
 209         </listitem>
 210       </varlistentry>
 211
 212       <varlistentry>
 213         <term>photofile</term>
 214         <listitem>
 215           <para>This allow you to display pictures for users.</para>
 216         </listitem>
 217       </varlistentry>
 218
 219       <varlistentry>
 220         <term>output</term>
 221         <listitem>
 222           <para>This allow you to generate the HTML file.</para>
 223           <para>Note that irssistats will really generate the HTML file as soon as it reads this option.</para>
 224         </listitem>
 225       </varlistentry>
 226
 227     </variablelist>
 228
 229   </refsect1>
 230
 231
 232   <refsect1>
 233     <title>NICKFILE</title>
 234     <para>Since version 0.4 of <command>irssistats</command>, you can use a nickfile to specify nicks to join.</para>
 235     <para>Each line of the nickfile contains the final nick and a regular expression.</para>
 236     <para>Examples :</para>
 237     <variablelist>
 238       <varlistentry>
 239         <term>royale &circ;[Rr]oyale</term>
 240         <listitem><para>join nicks starting with "Royale" or "royale" to the final nick "royale"</para></listitem>
 241       </varlistentry>
 242       <varlistentry>
 243         <term>royale &circ;antoine$</term>
 244         <listitem><para>also join the nick "antoine" to the final nick "royale"</para></listitem>
 245       </varlistentry>
 246       <varlistentry>
 247         <term>djakette [Dd]ja</term>
 248         <listitem><para>join any nick that contains "Dja" or "dja" to final nick "djakette"</para></listitem>
 249       </varlistentry>
 250       <varlistentry>
 251         <term>&lt;NULL&gt; &circ;bot\|royale$</term>
 252         <listitem><para>remove "bot|royale" from statistics</para></listitem>
 253       </varlistentry>
 254     </variablelist>
 255     <para>The nickfile must not contain any comments.</para>
 256     <para>The &lt;NULL&gt; final nick will remove matching nicks from all statistics, except from "Some URLs" and "Some topics"...</para>
 257     <para>You can also take a look at the "sample.nickfile" in this package (in "/usr/share/doc/irssistats/").</para>
 258   </refsect1>
 259
 260
 261   <refsect1>
 262     <title>PHOTOFILE</title>
 263     <para>Since version 0.70 of <command>irssistats</command>, you can use a photofile to display pictures for users.</para>
 264     <para>Each line of the photofile contains the final nick and an URL for the image.</para>
 265     <para>Examples :</para>
 266     <variablelist>
 267       <varlistentry>
 268         <term>royale http://royale.zerezo.com/chat/faces/happy40.png</term>
 269         <listitem><para>(a full address)</para></listitem>
 270       </varlistentry>
 271       <varlistentry>
 272         <term>sektor ../chat/faces/happy40.png</term>
 273         <listitem><para>(a relative address)</para></listitem>
 274       </varlistentry>
 275     </variablelist>
 276     <para>The photofile must not contain any comments.</para>
 277     <para>You can also take a look at the "sample.photofile" in this package (in "/usr/share/doc/irssistats/").</para>
 278   </refsect1>
 279
 280
 281   <refsect1>
 282     <title>SEE ALSO</title>
 283     <para><command>irssi</command> (1).</para>
 284   </refsect1>
 285
 286   <refsect1>
 287     <title>INFORMATIONS</title>
 288     <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>
 289     <para>Report bugs to &dhemail;.</para>
 290   </refsect1>
 291
 292   <refsect1>
 293     <title>AUTHOR</title>
 294     <para>Antoine Jacquet &dhemail;</para>
 295   </refsect1>
 296
 297 </refentry>
 298
 299 <!-- Keep this comment at the end of the file
 300 Local variables:
 301 mode: sgml
 302 sgml-omittag:t
 303 sgml-shorttag:t
 304 sgml-minimize-attributes:nil
 305 sgml-always-quote-attributes:t
 306 sgml-indent-step:2
 307 sgml-indent-data:t
 308 sgml-parent-document:nil
 309 sgml-default-dtd-file:nil
 310 sgml-exposed-tags:nil
 311 sgml-local-catalogs:nil
 312 sgml-local-ecat-files:nil
 313 End:
 314 -->
 315
 316