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

   1 .TH irssistats 1 23-Nov-2002 "version 0.44" irssistats
   2
   3 .SH NAME
   4 irssistats - A tool to generate HTML IRC stats based on irssi logs.
   5
   6 .SH SYNOPSIS
   7 cat /path/to/file.log | \fBirssistats\fP \fI\\#channel\fP \fImaintainer\fP \fIlanguage\fP \fItheme\fP \fI[nickfile]\fP > /path/to/webdir/index.html
   8
   9 .SH DESCRIPTION
  10 \fBirssistats\fP is a tool that make HTML stats from \fIirssi\fP logfiles.
  11 .PP
  12 It works like a filter (it reads data in input and produces the HTML page on the output).
  13 .PP
  14 The statistics generated display many useful and funny informations about the channel.
  15
  16 .SH USING IT
  17 First you need to copy the images needed for the HTML page :
  18 .PP
  19 .B cp /usr/share/irssistats/pix/* /path/to/webdir/
  20 .PP
  21 Now you can generate the statistics for your channel :
  22 .PP
  23 .B cat /path/to/file.log | irssistats \\\\#channel maintainer language theme [nickfile] > /path/to/webdir/index.html
  24 .PP
  25 The logfiles for \fIirssi\fP are usually located in "~/irclogs/network/channel.log"
  26
  27 .SH COMMAND LINE OPTIONS
  28 All the options (except the nickfile) are mandatory and have to be set at the good place on the command line.
  29 .PP
  30 If you make any mistake on the command line, \fBirssistats\fP will remind you the usage.
  31 .PP
  32 Launching \fBirssistats\fP without any parameters is a good way to show the available options.
  33 .PP
  34 .TP 8
  35 .B \\\\#channel
  36 Specifies the name of the channel you are parsing. Don't forget to escape the '#' character in the channel name.
  37 .TP 8
  38 .B maintainer
  39 Nickname of the person generating the statistics (you !).
  40 .TP 8
  41 .B language
  42 Language you want to use to display the statistics (example : "en" for english).
  43 .TP 8
  44 .B theme
  45 Theme (colors) to use for the statistics (example : "default" for the default theme).
  46 .TP 8
  47 .B nickfile
  48 This is the only optional argument. Specifies an alias file for nicks. See Below.
  49
  50 .SH NICKFILE
  51 Since version 0.4 of \fBirssistats\fP, you can use a nickfile to specify nicks to join.
  52 .PP
  53 Each line of the nickfile contains the final nick and a regular expression.
  54 .PP
  55 Examples :
  56 .TP 8
  57 .B royale ^[Rr]oyale
  58 join nicks starting with "Royale" or "royale" to the final nick "royale"
  59 .TP 8
  60 .B royale ^antoine$
  61 also join the nick "antoine" to the final nick "royale"
  62 .TP 8
  63 .B djakette [Dd]ja
  64 join any nick that contains "Dja" or "dja" to final nick "djakette"
  65 .TP 8
  66 .B <NULL> ^bot\\\\|royale$
  67 remove "bot|royale" from statistics
  68 .PP
  69 The nickfile must not contain any comments.
  70 .PP
  71 The <NULL> final nick will remove matching nicks from all statistics, except from "Some URLs" and "Some topics"...
  72 .PP
  73 You can also take a look at the "sample.nickfile.txt" in this package (in "/usr/share/doc/irssistats/").
  74
  75 .SH SEE ALSO
  76 irssi(1)
  77
  78 .SH INFORMATIONS
  79 You can find informations and updates of \fBirssistats\fP at \fIhttp://royale.zerezo.com/irssistats/\fP.
  80 .PP
  81 Report bugs to \fIroyale@zerezo.com\fP.
  82
  83 .SH AUTHOR
  84 Antoine Jacquet <\fIroyale@zerezo.com\fP>