version 0.61

* russian support (thank you kamikaze)
* manpage was rewritten in SGML, updated and restored

diff --git a/CHANGELOG b/CHANGELOG
index ecb08b7..2e16413 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,5 +1,9 @@
 Change log file for irssistats
 
 Change log file for irssistats
 

+version 0.61   (2004-04-05)
+       * russian support (thank you kamikaze)
+       * manpage was rewritten in SGML, updated and restored
+

 version 0.6    (2004-03-21)
        * no hard user limit anymore (dynamic table size)
        * alternate CSS themes
 version 0.6    (2004-03-21)
        * no hard user limit anymore (dynamic table size)
        * alternate CSS themes


@@ -7,74 +11,74 @@ version 0.6  (2004-03-21)
        * words/letters ranking
        * top words can be disabled to use less memory
        * old polish translation was restored
        * words/letters ranking
        * top words can be disabled to use less memory
        * old polish translation was restored

-\r
-version 0.51   (2003-12-14)\r
-       * bugfixes and polish language updated (thank you Jakub Jankowski) \r
-       * "CHARSET" is now a language parameter \r
-       * Internet Explorer specific bugfix in themes \r
-\r
-version 0.5    (2003-12-07)\r
-       * configuration file \r
-       * it is now possible to build multiple stats in one run \r
-       * customizable header and footer \r
-       * now produces XHTML with CSS templates as suggested by some users \r
-       * "grayscale" and "pisg" theme were added \r
-       * italian support (thank you Coviello Giuseppe) \r
-       * dutch support and BSD include patch (thank you Jeroen Ubbink) \r
-       * patch nickmode (thank you Philipp Haegi) \r
-\r
-version 0.44   (2003-05-25)\r
-       * finnish support (thank you Antti Huopana) \r
-       * minor updates \r
-\r
-version 0.43   (2002-11-24)\r
-       * manpage was added \r
-       * increased number of users \r
-       * "blue" theme was added \r
-       * improved Makefile \r
-\r
-version 0.42   (2002-11-16)\r
-       * W3C validated HTML \r
-       * better quote selection during nick alias \r
-       * auto refresh (suggested by Charles Blackburn) \r
-\r
-version 0.41   (2002-10-19)\r
-       * polish support (thank you Piotr Jarmuz) \r
-       * you can now ignore some users \r
-       * improved Makefile \r
-       * the # in channel name is not imposed anymore (to support "&channels") \r
-       * number of total days are now displayed \r
-\r
-version 0.4    (2002-10-14)\r
-       * nick alias support using regular expression \r
-       * some code fix \r
-\r
-version 0.32   (2002-09-30)\r
-       * german support (thank you Valentin Gelhorn) \r
-\r
-version 0.31   (2002-09-01)\r
-       * spanish support (thank you Alex) \r
-       * minor code changes \r
-       * bugfix : division by 0 (thank you Qball) \r
-       * better random topics / urls algorithm \r
-\r
-version 0.3    (2002-05-29)\r
-       * top users by time of day \r
-       * some big numbers \r
-       * some new themes \r
-       * increased number of users \r
-       * better HTML output \r
-\r
-version 0.2    (2002-05-16)\r
-       * languages support (currently english and french) \r
-       * themes support \r
-       * most used words \r
-       * now handles personal messages and "/me" \r
-       * parameters on command line \r
-       * some code change \r
-       * faster \r
-       * no more image when 0 lines \r
-       * maximum height for graph is now calculated \r
-\r
-version 0.1    (2002-05-01)\r
+
+version 0.51   (2003-12-14)
+       * bugfixes and polish language updated (thank you Jakub Jankowski) 
+       * "CHARSET" is now a language parameter 
+       * Internet Explorer specific bugfix in themes 
+
+version 0.5    (2003-12-07)
+       * configuration file 
+       * it is now possible to build multiple stats in one run 
+       * customizable header and footer 
+       * now produces XHTML with CSS templates as suggested by some users 
+       * "grayscale" and "pisg" theme were added 
+       * italian support (thank you Coviello Giuseppe) 
+       * dutch support and BSD include patch (thank you Jeroen Ubbink) 
+       * patch nickmode (thank you Philipp Haegi) 
+
+version 0.44   (2003-05-25)
+       * finnish support (thank you Antti Huopana) 
+       * minor updates 
+
+version 0.43   (2002-11-24)
+       * manpage was added 
+       * increased number of users 
+       * "blue" theme was added 
+       * improved Makefile 
+
+version 0.42   (2002-11-16)
+       * W3C validated HTML 
+       * better quote selection during nick alias 
+       * auto refresh (suggested by Charles Blackburn) 
+
+version 0.41   (2002-10-19)
+       * polish support (thank you Piotr Jarmuz) 
+       * you can now ignore some users 
+       * improved Makefile 
+       * the # in channel name is not imposed anymore (to support "&channels") 
+       * number of total days are now displayed 
+
+version 0.4    (2002-10-14)
+       * nick alias support using regular expression 
+       * some code fix 
+
+version 0.32   (2002-09-30)
+       * german support (thank you Valentin Gelhorn) 
+
+version 0.31   (2002-09-01)
+       * spanish support (thank you Alex) 
+       * minor code changes 
+       * bugfix : division by 0 (thank you Qball) 
+       * better random topics / urls algorithm 
+
+version 0.3    (2002-05-29)
+       * top users by time of day 
+       * some big numbers 
+       * some new themes 
+       * increased number of users 
+       * better HTML output 
+
+version 0.2    (2002-05-16)
+       * languages support (currently english and french) 
+       * themes support 
+       * most used words 
+       * now handles personal messages and "/me" 
+       * parameters on command line 
+       * some code change 
+       * faster 
+       * no more image when 0 lines 
+       * maximum height for graph is now calculated 
+
+version 0.1    (2002-05-01)

        * initial release
\ No newline at end of file
        * initial release
\ No newline at end of file

diff --git a/Makefile b/Makefile
index aae279c..954a34d 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,8 @@
 PRE = /usr/local
 BIN = $(PRE)/bin
 DAT = $(PRE)/share/irssistats/data
 PRE = /usr/local
 BIN = $(PRE)/bin
 DAT = $(PRE)/share/irssistats/data

-DOC = $(PRE)/doc/irssistats
+DOC = $(PRE)/share/doc/irssistats
+MAN = $(PRE)/share/man/man1

 
 irssistats:irssistats.c
        gcc -o irssistats irssistats.c
 
 irssistats:irssistats.c
        gcc -o irssistats irssistats.c


@@ -10,11 +11,13 @@ clean:
        rm -f irssistats 
 
 install:irssistats
        rm -f irssistats 
 
 install:irssistats

-       mkdir -p $(BIN) $(DAT) $(DOC)
+       mkdir -p $(BIN) $(DAT) $(DOC) $(MAN)

        cp -f irssistats $(BIN)
        cp -f data/* $(DAT)
        cp -f irssistats $(BIN)
        cp -f data/* $(DAT)

-       cp -f COPYING README sample.nickfile sample.configfile $(DOC)
+       cp -f COPYING README sample.nickfile sample.configfile irssistats.sgml $(DOC)
+       cp -f irssistats.1 $(MAN)

 
 uninstall:
        rm -f $(BIN)/irssistats
        rm -rf $(DAT) $(DOC)
 
 uninstall:
        rm -f $(BIN)/irssistats
        rm -rf $(DAT) $(DOC)

+       rm -f $(MAN)/irssistats.1

diff --git a/README b/README
index 53a1565..d9c58ea 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-irssistats 0.6
+irssistats 0.61

 site: http://royale.zerezo.com/irssistats/
 mail: royale@zerezo.com
 
 site: http://royale.zerezo.com/irssistats/
 mail: royale@zerezo.com
 

diff --git a/irssistats.1 b/irssistats.1
new file mode 100644 (file)
index 0000000..16fd0a7
--- /dev/null
+++ b/irssistats.1
@@ -0,0 +1,195 @@
+.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
+.\"
+.\"    transcript compatibility for postscript use.
+.\"
+.\"    synopsis:  .P! <file.ps>
+.\"
+.de P!
+.fl
+\!!1 setgray
+.fl
+\\&.\"
+.fl
+\!!0 setgray
+.fl                    \" force out current output buffer
+\!!save /psv exch def currentpoint translate 0 0 moveto
+\!!/showpage{}def
+.fl                    \" prolog
+.sy sed -e 's/^/!/' \\$1\" bring in postscript file
+\!!psv restore
+.
+.de pF
+.ie     \a\\*(f1\a\a .ds f1 \\n(.f
+.el .ie \a\\*(f2\a\a .ds f2 \\n(.f
+.el .ie \a\\*(f3\a\a .ds f3 \\n(.f
+.el .ie \a\\*(f4\a\a .ds f4 \\n(.f
+.el .tm ? font overflow
+.ft \\$1
+..
+.de fP
+.ie     !\a\\*(f4\a\a \{\
+.      ft \\*(f4
+.      ds f4\"
+'      br \}
+.el .ie !\a\\*(f3\a\a \{\
+.      ft \\*(f3
+.      ds f3\"
+'      br \}
+.el .ie !\a\\*(f2\a\a \{\
+.      ft \\*(f2
+.      ds f2\"
+'      br \}
+.el .ie !\a\\*(f1\a\a \{\
+.      ft \\*(f1
+.      ds f1\"
+'      br \}
+.el .tm ? font underflow
+..
+.ds f1\"
+.ds f2\"
+.ds f3\"
+.ds f4\"
+'\" t 
+.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
+.TH "IRSSISTATS" "1" 
+.SH "NAME" 
+irssistats \(em A tool to generate HTML IRC stats based on irssi logs. 
+.SH "SYNOPSIS" 
+.PP 
+\fBirssistats\fR [\fB\fI/path/to/file.conf\fR\fP]  
+.SH "DESCRIPTION" 
+.PP 
+\fBirssistats\fR is a tool that make HTML stats from \fBirssi\fR logfiles. 
+.PP 
+The statistics generated display many useful and funny informations about the channel. 
+.SH "USING IT" 
+.PP 
+First you need to copy the files needed for the HTML page : 
+.PP 
+\fBcp /usr/share/irssistats/data/* /path/to/webdir/\fR 
+.PP 
+Then you must edit a configuration file : "/etc/irssistats.conf", "~/.irssistats", or another file given as a parameter. 
+.PP 
+Now you can generate the statistics for your channel : 
+.PP 
+\fBirssistats \fB\fI[/path/to/file.conf]\fR\fP\fR 
+.PP 
+The logfiles for \fBirssi\fR are usually located in "~/irclogs/network/channel.log" 
+.SH "CONFIGURATION FILE" 
+.PP 
+Please look at the sample configuration file in "/usr/share/docs/irssistats/sample.configfile" for an example. 
+.PP 
+The path to the configuration file can be given on the command line : \fBirssistats\fR \fI/path/to/irssistats.conf\fR 
+.PP 
+If no configuration file is given, irssistats looks for files ~/.irssistats.conf or then /etc/irssistats.conf 
+.PP 
+Lines starting by ; # -- or // are ignored (comments). 
+.PP 
+This file is read sequencially, so it acts like a script. 
+.PP 
+Each option keyword is case sensitive, and you must put separators around the ':' character. 
+.PP 
+Blank lines must not contain any spaces ! 
+.PP 
+Each option keeps its value until erased by another value. 
+.PP 
+IMPORTANT : the order of options to parse a channel must allways be "input" THEN "nickfile" THEN "output". 
+.PP 
+Available options are : 
+.IP "debug" 10 
+Allows you to display debugging informations. 
+.IP "" 10 
+Values : normal / verbose / none 
+.IP "" 10 
+Default : normal 
+.IP "channel" 10 
+Specifies the name of the channel you are parsing. 
+.IP "maintainer" 10 
+Nickname of the person generating the statistics (you !). 
+.IP "language" 10 
+Language you want to use to display the statistics 
+.IP "" 10 
+Values : fr en de du es it fi ru 
+.IP "" 10 
+Default : en 
+.IP "theme" 10 
+Theme (colors) to use for the statistics, separated by comas 
+.IP "" 10 
+In fact this is the name of the CSS file to include. 
+.IP "" 10 
+This option has no effect if you use a custom header : you'll have to include the CSS yourself. 
+.IP "" 10 
+The first theme is the primary stylesheet, and the others are alternate themes 
+.IP "top_words" 10 
+Allows you to disable top words list which is using a lot of memory 
+.IP "" 10 
+Default : yes 
+.IP "ranking" 10 
+Specifies which ranking method to use 
+.IP "" 10 
+Values : lines / words / letters 
+.IP "" 10 
+Default : lines 
+.IP "quarter" 10 
+Display quarters in top hours (smoother graphs) 
+.IP "" 10 
+Default : no 
+.IP "refresh_time" 10 
+Specifies the refresh time in seconds (0 to disable) 
+.IP "" 10 
+This option has no effect if you use a custom header : you'll have to include the refresh code yourself. 
+.IP "" 10 
+Default : 3600 
+.IP "w3c_link" 10 
+Set this to "no" if you don't want the W3C logo. 
+.IP "" 10 
+Default : yes 
+.IP "header" 10 
+Use your custom header file (HTML code between <!DOCTYPE... and <body> included) 
+.IP "footer" 10 
+Use your custom footer file (HTML code between </body> and </html> included) 
+.IP "input" 10 
+This allow you to parse a file. 
+.IP "" 10 
+Note that irssistats will really parse the file as soon as it reads this option. 
+.IP "nickfile" 10 
+This allow you to group nick using a nickfile. 
+.IP "" 10 
+Note that irssistats will really merge the nicks as soon as it reads this option. 
+.IP "output" 10 
+This allow you to generate the HTML file. 
+.IP "" 10 
+Note that irssistats will really generate the HTML file as soon as it reads this option. 
+.SH "NICKFILE" 
+.PP 
+Since version 0.4 of \fBirssistats\fR, you can use a nickfile to specify nicks to join. 
+.PP 
+Each line of the nickfile contains the final nick and a regular expression. 
+.PP 
+Examples : 
+.IP "royale \(a^[Rr]oyale" 10 
+join nicks starting with "Royale" or "royale" to the final nick "royale" 
+.IP "royale \(a^antoine$" 10 
+also join the nick "antoine" to the final nick "royale" 
+.IP "djakette [Dd]ja" 10 
+join any nick that contains "Dja" or "dja" to final nick "djakette" 
+.IP "<NULL> \(a^bot\|royale$" 10 
+remove "bot|royale" from statistics 
+.PP 
+The nickfile must not contain any comments. 
+.PP 
+The <NULL> final nick will remove matching nicks from all statistics, except from "Some URLs" and "Some topics"... 
+.PP 
+You can also take a look at the "sample.nickfile" in this package (in "/usr/share/doc/irssistats/"). 
+.SH "SEE ALSO" 
+.PP 
+\fBirssi\fR (1). 
+.SH "INFORMATIONS" 
+.PP 
+You can find informations and updates of \fBirssistats\fR at \fIhttp://royale.zerezo.com/irssistats/ (link to URL http://royale.zerezo.com/irssistats/) \fR. 
+.PP 
+Report bugs to royale@zerezo.com. 
+.SH "AUTHOR" 
+.PP 
+Antoine Jacquet royale@zerezo.com 
+.\" created by instant / docbook-to-man, Mon 05 Apr 2004, 00:56 

diff --git a/irssistats.c b/irssistats.c
index 7bb52cf..662e150 100644 (file)
--- a/irssistats.c
+++ b/irssistats.c
@@ -1,5 +1,5 @@
 /*
 /*

- * irssistats version 0.6
+ * irssistats version 0.61

  *
  * This tool generates IRC stats based on irssi logs.
  * Usage: irssistats [/path/to/file.conf]
  *
  * This tool generates IRC stats based on irssi logs.
  * Usage: irssistats [/path/to/file.conf]


@@ -43,7 +43,7 @@
 #define MINWORDLENGTH 5
 
 /* irssistats */
 #define MINWORDLENGTH 5
 
 /* irssistats */

-#define VERSION "0.6"
+#define VERSION "0.61"

 #define URL "http://royale.zerezo.com/irssistats/"
 
 /* Counters */
 #define URL "http://royale.zerezo.com/irssistats/"
 
 /* Counters */


@@ -64,7 +64,7 @@
 char *counters[NBCOUNTERS]={"C_SMILE","C_FROWN","C_EXCLAM","C_QUESTION","C_ME","C_TOPIC","C_MODE","C_KICK","C_KICKED","C_URL","C_JOIN","C_NICK","C_MONOLOGUE"};
 
 /* Languages */
 char *counters[NBCOUNTERS]={"C_SMILE","C_FROWN","C_EXCLAM","C_QUESTION","C_ME","C_TOPIC","C_MODE","C_KICK","C_KICKED","C_URL","C_JOIN","C_NICK","C_MONOLOGUE"};
 
 /* Languages */

-#define NBLANGUAGES 9
+#define NBLANGUAGES 10

 #define NBKEYS 39
 char *keys[NBLANGUAGES][NBKEYS+1][2]= /* first key used for language name and abbreviation */
 {
 #define NBKEYS 39
 char *keys[NBLANGUAGES][NBKEYS+1][2]= /* first key used for language name and abbreviation */
 {


@@ -452,7 +452,49 @@ char *keys[NBLANGUAGES][NBKEYS+1][2]= /* first key used for language name and ab
     { "C_JOIN",       "twijfelt tussen blijven of gaan" },
     { "C_NICK",       "verandert vaak van nick" },
     { "C_MONOLOGUE",  "spreekt veel monologen" }
     { "C_JOIN",       "twijfelt tussen blijven of gaan" },
     { "C_NICK",       "verandert vaak van nick" },
     { "C_MONOLOGUE",  "spreekt veel monologen" }

-  }  
+  }, 
+  { /* Russian language */
+    { "Russian",      "ru" },
+    { "CHARSET",      "KOI8-R" },
+    { "HEADER",       "óÔÁÔÉÓÔÉËÁ ÄÌÑ %s ÏÔ %s" },
+    { "LEGEND",       "ïÂÏÚÎÁÞÅÎÉÑ" },
+    { "LASTDAYS",     "óÔÁÔÉÓÔÉËÁ ÐÏÓÌÅÄÎÉÈ ÄÎÅÊ" },
+    { "TOPHOURS",     "ðÏÞÁÓÏ×ÁÑ ÓÔÁÔÉÓÔÉËÁ" },
+    { "TOPUSERS",     "áËÔÉ×ÎÅÊÛÉÅ ÌÀÄÉ" },
+    { "OTHERS",       "ïÓÔÁÌÏÓØ %d ÎÅÐÏÄÓÞÉÔÁÎÙÈ..." },
+    { "NBLINES",      "ÓÔÒÏËÉ" },
+    { "NICK",         "ÎÉË" },
+    { "AVGLETTERS",   "ÂÕË×Ù/ÓÔÒÏËÉ" },
+    { "HOURS",        "ÞÁÓÙ" },
+    { "QUOTE",        "ÓÌÕÞÁÊÎÏÅ ÓÏÏÂÝÅÎÉÅ" },
+    { "TOPUSERSTIME", "áËÔÉ×ÎÅÊÛÉÅ ÌÀÄÉ ÐÏ ×ÒÅÍÅÎÉ ÄÎÑ" },
+    { "RANDTOPICS",   "îÅÓËÏÌØËÏ ÔÏÐÉËÏ×" },
+    { "CHANGEDBY",    "ÉÚÍÅΣÎ" },
+    { "NEWTOPIC",     "ÎÏ×ÙÊ ÔÏÐÉË" },
+    { "RANDURLS",     "îÅÓËÏÌØËÏ URLÏ×" },
+    { "POSTEDBY",     "ÏÐÕÂÌÉËÏ×ÁÌ" },
+    { "POSTEDURL",    "URL" },
+    { "TOPWORDS",     "þÁÓÔÏ ÉÓÐÏÌØÚÕÅÍÙÅ ÓÌÏ×Á" },
+    { "WORD",         "ÓÌÏ×Ï" },
+    { "OCCURRENCES",  "ÐÒÏÉÛÅÓÔ×ÉÑ" },
+    { "BIGNUMBERS",   "îÅÓËÏÌØËÏ ÂÏÌØÛÉÈ ÞÉÓÅÌ..." },
+    { "NUMBERS",      "ÞÉÓÌÁ" },
+    { "TIME",         "%d ÓÔÒÏË (%d ÄÎÅÊ) ÏÂÒÁÂÏÔÁÎÏ ÚÁ %d ÓÅËÕÎÄ" },
+    { "FOOTER",       "óÔÁÔÉÓÔÉËÁ ÓÇÅÎÅÒÉÒÏ×ÁÎÁ" },
+    { "C_SMILE",      "ÞÁÓÔÏ ÓÞÁÓÌÉ× :)" },
+    { "C_FROWN",      "ÞÁÓÔÏ ÎÅÓÞÁÓÔÅÎ :(" },
+    { "C_EXCLAM",     "ÍÎÏÇÏ ×ÏÓËÌÉÃÁÅÔ !" },
+    { "C_QUESTION",   "ÚÁÄÁ£Ô ÍÎÏÇÏ ×ÏÐÒÏÓÏ× ?" },
+    { "C_ME",         "ÌÀÂÉÔ /me command" },
+    { "C_TOPIC",      "ÞÁÓÔÏ ÍÅÎÑÅÔ ÔÏÐÉË" },
+    { "C_MODE",       "ÞÁÓÔÏ ÍÅÎÑÅÔ ÒÅÖÉÍÙ" },
+    { "C_KICK",       "ÌÀÂÉÔ /kick" },
+    { "C_KICKED",     "ÞÁÓÔÏ ×ÙËÉÄÙ×ÁÀÔ" },
+    { "C_URL",        "ÐÕÂÌÉËÕÅÔ ÍÎÏÇÏ URLÏ×" },
+    { "C_JOIN",       "ÎÅ ÚÎÁÅÔ - ÏÓÔÁÔØÓÑ ÉÌÉ ÕÊÔÉ" },
+    { "C_NICK",       "ÞÁÓÔÏ ÍÅÎÑÅÔ Ó×ÏÊ ÎÉË" },
+    { "C_MONOLOGUE",  "éÓÐÏÌØÚÕÅÔ ÍÎÏÇÏ ÍÏÎÏÌÏÇÏ×" }
+  }

 };
 
 int language=0; /* default to english */
 };
 
 int language=0; /* default to english */

diff --git a/irssistats.sgml b/irssistats.sgml
new file mode 100644 (file)
index 0000000..586cec1
--- /dev/null
+++ b/irssistats.sgml
@@ -0,0 +1,271 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+  <!ENTITY dhfirstname "<firstname>JACQUET</firstname>">
+  <!ENTITY dhsurname   "<surname>ANTOINE</surname>">
+  <!-- Please adjust the date whenever revising the manpage. -->
+  <!ENTITY dhdate      "<date>april 4, 2004</date>">
+  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+       allowed: see man(7), man(1). -->
+  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
+  <!ENTITY dhemail     "<email>royale@zerezo.com</email>">
+  <!ENTITY dhusername  "Antoine Jacquet">
+  <!ENTITY dhucpackage "<refentrytitle>IRSSISTATS</refentrytitle>">
+  <!ENTITY dhpackage   "irssistats">
+
+  <!ENTITY debian      "<productname>Debian</productname>">
+  <!ENTITY gnu         "<acronym>GNU</acronym>">
+  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
+]>
+
+<refentry>
+
+  <refentryinfo>
+    <address>
+      &dhemail;
+    </address>
+    <author>
+      &dhfirstname;
+      &dhsurname;
+    </author>
+    <copyright>
+      <year>2004</year>
+      <holder>&dhusername;</holder>
+    </copyright>
+    &dhdate;
+  </refentryinfo>
+  
+  <refmeta>
+    &dhucpackage;
+    &dhsection;
+  </refmeta>
+  
+  <refnamediv>
+    <refname>&dhpackage;</refname>
+    <refpurpose>A tool to generate HTML IRC stats based on irssi logs.</refpurpose>
+  </refnamediv>
+  
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <arg><option><replaceable>/path/to/file.conf</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+  
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para><command>irssistats</command> is a tool that make HTML stats from <command>irssi</command> logfiles.</para>
+    <para>The statistics generated display many useful and funny informations about the channel.</para>
+  </refsect1>
+  
+  <refsect1>
+    <title>USING IT</title>
+    <para>First you need to copy the files needed for the HTML page :</para>
+    <para><command>cp /usr/share/irssistats/data/* /path/to/webdir/</command></para>
+    <para>Then you must edit a configuration file : "/etc/irssistats.conf", "~/.irssistats", or another file given as a parameter.</para>
+    <para>Now you can generate the statistics for your channel :</para>
+    <para><command>irssistats <option><replaceable>[/path/to/file.conf]</replaceable></option></command></para>
+    <para>The logfiles for <command>irssi</command> are usually located in "~/irclogs/network/channel.log"</para>
+  </refsect1>
+  
+  
+  <refsect1>
+    <title>CONFIGURATION FILE</title>
+    <para>Please look at the sample configuration file in "/usr/share/docs/irssistats/sample.configfile" for an example.</para>
+    <para>The path to the configuration file can be given on the command line : <command>irssistats</command> <replaceable>/path/to/irssistats.conf</replaceable></para>
+    <para>If no configuration file is given, irssistats looks for files ~/.irssistats.conf or then /etc/irssistats.conf</para>
+    <para>Lines starting by ; # -- or // are ignored (comments).</para>
+    <para>This file is read sequencially, so it acts like a script.</para>
+    <para>Each option keyword is case sensitive, and you must put separators around the ':' character.</para>
+    <para>Blank lines must not contain any spaces !</para>
+    <para>Each option keeps its value until erased by another value.</para>
+    <para>IMPORTANT : the order of options to parse a channel must allways be "input" THEN "nickfile" THEN "output".</para>
+    
+    <para>Available options are :</para>
+    
+    <variablelist>
+      
+      <varlistentry>
+        <term>debug</term>
+        <listitem>
+          <para>Allows you to display debugging informations.</para>
+          <para>Values : normal / verbose / none</para>
+          <para>Default : normal</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>channel</term>
+        <listitem><para>Specifies the name of the channel you are parsing.</para></listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>maintainer</term>
+        <listitem><para>Nickname of the person generating the statistics (you !).</para></listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>language</term>
+        <listitem>
+          <para>Language you want to use to display the statistics</para>
+          <para>Values : fr en de du es it fi ru</para>
+          <para>Default : en</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>theme</term>
+        <listitem>
+          <para>Theme (colors) to use for the statistics, separated by comas</para>
+          <para>In fact this is the name of the CSS file to include.</para>
+          <para>This option has no effect if you use a custom header : you'll have to include the CSS yourself.</para>
+          <para>The first theme is the primary stylesheet, and the others are alternate themes</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>top_words</term>
+        <listitem>
+          <para>Allows you to disable top words list which is using a lot of memory</para>
+          <para>Default : yes</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>ranking</term>
+        <listitem>
+          <para>Specifies which ranking method to use</para>
+          <para>Values : lines / words / letters</para>
+          <para>Default : lines</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>quarter</term>
+        <listitem>
+          <para>Display quarters in top hours (smoother graphs)</para>
+          <para>Default : no</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>refresh_time</term>
+        <listitem>
+          <para>Specifies the refresh time in seconds (0 to disable)</para>
+          <para>This option has no effect if you use a custom header : you'll have to include the refresh code yourself.</para>
+          <para>Default : 3600</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>w3c_link</term>
+        <listitem>
+          <para>Set this to "no" if you don't want the W3C logo.</para>
+          <para>Default : yes</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>header</term>
+        <listitem><para>Use your custom header file (HTML code between &lt;!DOCTYPE... and &lt;body&gt; included)</para></listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>footer</term>
+        <listitem><para>Use your custom footer file (HTML code between &lt;/body&gt; and &lt;/html&gt; included)</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>input</term>
+        <listitem>
+          <para>This allow you to parse a file.</para>
+          <para>Note that irssistats will really parse the file as soon as it reads this option.</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>nickfile</term>
+        <listitem>
+          <para>This allow you to group nick using a nickfile.</para>
+          <para>Note that irssistats will really merge the nicks as soon as it reads this option.</para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term>output</term>
+        <listitem>
+          <para>This allow you to generate the HTML file.</para>
+          <para>Note that irssistats will really generate the HTML file as soon as it reads this option.</para>
+        </listitem>
+      </varlistentry>
+      
+    </variablelist>
+    
+  </refsect1>
+  
+  
+  <refsect1>
+    <title>NICKFILE</title>
+    <para>Since version 0.4 of <command>irssistats</command>, you can use a nickfile to specify nicks to join.</para>
+    <para>Each line of the nickfile contains the final nick and a regular expression.</para>
+    <para>Examples :</para>
+    <variablelist>
+      <varlistentry>
+        <term>royale &circ;[Rr]oyale</term>
+        <listitem><para>join nicks starting with "Royale" or "royale" to the final nick "royale"</para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>royale &circ;antoine$</term>
+        <listitem><para>also join the nick "antoine" to the final nick "royale"</para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>djakette [Dd]ja</term>
+        <listitem><para>join any nick that contains "Dja" or "dja" to final nick "djakette"</para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>&lt;NULL&gt; &circ;bot\|royale$</term>
+        <listitem><para>remove "bot|royale" from statistics</para></listitem>
+      </varlistentry>
+    </variablelist>
+    <para>The nickfile must not contain any comments.</para>
+    <para>The &lt;NULL&gt; final nick will remove matching nicks from all statistics, except from "Some URLs" and "Some topics"...</para>
+    <para>You can also take a look at the "sample.nickfile" in this package (in "/usr/share/doc/irssistats/").</para>
+  </refsect1>
+  
+  
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para><command>irssi</command> (1).</para>
+  </refsect1>
+  
+  <refsect1>
+    <title>INFORMATIONS</title>
+    <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>
+    <para>Report bugs to &dhemail;.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>AUTHOR</title>
+    <para>Antoine Jacquet &dhemail;</para>
+  </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
+
+