X-Git-Url: http://royale.zerezo.com/git/?p=irssistats;a=blobdiff_plain;f=irssistats.1;fp=irssistats.1;h=21230cd25edcb0c7357e548fa2b9d423dbdbd202;hp=0000000000000000000000000000000000000000;hb=1002bb1c28a6fac71b2360782305e45bae0dd072;hpb=22a4230dfc105e0160ba50e737a430ad60fb2cad

diff --git a/irssistats.1 b/irssistats.1
new file mode 100644
index 0000000..21230cd
--- /dev/null
+++ b/irssistats.1
@@ -0,0 +1,84 @@
+.TH irssistats 1 23-Nov-2002 "version 0.43" irssistats
+
+.SH NAME
+irssistats - A tool to generate HTML IRC stats based on irssi logs.
+
+.SH SYNOPSIS
+cat /path/to/file.log | \fBirssistats\fP \fI\\#channel\fP \fImaintainer\fP \fIlanguage\fP \fItheme\fP \fI[nickfile]\fP > /path/to/webdir/index.html
+
+.SH DESCRIPTION
+\fBirssistats\fP is a tool that make HTML stats from \fIirssi\fP logfiles.
+.PP
+It works like a filter (it reads data in input and produces the HTML page on the output).
+.PP
+The statistics generated display many useful and funny informations about the channel.
+
+.SH USING IT
+First you need to copy the images needed for the HTML page :
+.PP
+.B cp /usr/share/irssistats/pix/* /path/to/webdir/
+.PP
+Now you can generate the statistics for your channel :
+.PP
+.B cat /path/to/file.log | irssistats \\\\#channel maintainer language theme [nickfile] > /path/to/webdir/index.html
+.PP
+The logfiles for \fIirssi\fP are usually located in "~/irclogs/network/channel.log"
+
+.SH COMMAND LINE OPTIONS
+All the options (except the nickfile) are mandatory and have to be set at the good place on the command line.
+.PP
+If you make any mistake on the command line, \fBirssistats\fP will remind you the usage.
+.PP
+Launching \fBirssistats\fP without any parameters is a good way to show the available options.
+.PP
+.TP 8
+.B \\\\#channel
+Specifies the name of the channel you are parsing. Don't forget to escape the '#' character in the channel name.
+.TP 8
+.B maintainer
+Nickname of the person generating the statistics (you !).
+.TP 8
+.B language
+Language you want to use to display the statistics (example : "en" for english).
+.TP 8
+.B theme
+Theme (colors) to use for the statistics (example : "default" for the default theme).
+.TP 8
+.B nickfile
+This is the only optional argument. Specifies an alias file for nicks. See Below.
+
+.SH NICKFILE
+Since version 0.4 of \fBirssistats\fP, 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 :
+.TP 8
+.B royale ^[Rr]oyale
+join nicks starting with "Royale" or "royale" to the final nick "royale"
+.TP 8
+.B royale ^antoine$
+also join the nick "antoine" to the final nick "royale"
+.TP 8
+.B djakette [Dd]ja
+join any nick that contains "Dja" or "dja" to final nick "djakette"
+.TP 8
+.B <NULL> ^bot\\\\|royale$
+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.txt" in this package (in "/usr/share/doc/irssistats/").
+
+.SH SEE ALSO
+irssi(1)
+
+.SH INFORMATIONS
+You can find informations and updates of \fBirssistats\fP at \fIhttp://royale.zerezo.com/programmation/irssistats/\fP.
+.PP
+Report bugs to \fIroyale@zerezo.com\fP.
+
+.SH AUTHOR
+Antoine Jacquet <\fIroyale@zerezo.com\fP>