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

   1 .\" $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 $
   2 .\"
   3 .\"     transcript compatibility for postscript use.
   4 .\"
   5 .\"     synopsis:  .P! <file.ps>
   6 .\"
   7 .de P!
   8 .fl
   9 \!!1 setgray
  10 .fl
  11 \\&.\"
  12 .fl
  13 \!!0 setgray
  14 .fl                     \" force out current output buffer
  15 \!!save /psv exch def currentpoint translate 0 0 moveto
  16 \!!/showpage{}def
  17 .fl                     \" prolog
  18 .sy sed -e 's/^/!/' \\$1\" bring in postscript file
  19 \!!psv restore
  20 .
  21 .de pF
  22 .ie     \a\\*(f1\a\a .ds f1 \\n(.f
  23 .el .ie \a\\*(f2\a\a .ds f2 \\n(.f
  24 .el .ie \a\\*(f3\a\a .ds f3 \\n(.f
  25 .el .ie \a\\*(f4\a\a .ds f4 \\n(.f
  26 .el .tm ? font overflow
  27 .ft \\$1
  28 ..
  29 .de fP
  30 .ie     !\a\\*(f4\a\a \{\
  31 .       ft \\*(f4
  32 .       ds f4\"
  33 '       br \}
  34 .el .ie !\a\\*(f3\a\a \{\
  35 .       ft \\*(f3
  36 .       ds f3\"
  37 '       br \}
  38 .el .ie !\a\\*(f2\a\a \{\
  39 .       ft \\*(f2
  40 .       ds f2\"
  41 '       br \}
  42 .el .ie !\a\\*(f1\a\a \{\
  43 .       ft \\*(f1
  44 .       ds f1\"
  45 '       br \}
  46 .el .tm ? font underflow
  47 ..
  48 .ds f1\"
  49 .ds f2\"
  50 .ds f3\"
  51 .ds f4\"
  52 '\" t
  53 .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
  54 .TH "IRSSISTATS" "1"
  55 .SH "NAME"
  56 irssistats \(em A tool to generate HTML IRC stats based on irssi logs.
  57 .SH "SYNOPSIS"
  58 .PP
  59 \fBirssistats\fR [\fB\fI/path/to/file.conf\fR\fP]
  60 .SH "DESCRIPTION"
  61 .PP
  62 \fBirssistats\fR is a tool that make HTML stats from \fBirssi\fR logfiles.
  63 .PP
  64 The statistics generated display many useful and funny informations about the channel.
  65 .SH "USING IT"
  66 .PP
  67 First you need to copy the files needed for the HTML page :
  68 .PP
  69 \fBcp /usr/share/irssistats/data/* /path/to/webdir/\fR
  70 .PP
  71 Then you must edit a configuration file : "/etc/irssistats.conf", "~/.irssistats", or another file given as a parameter.
  72 .PP
  73 Now you can generate the statistics for your channel :
  74 .PP
  75 \fBirssistats \fB\fI[/path/to/file.conf]\fR\fP\fR
  76 .PP
  77 The logfiles for \fBirssi\fR are usually located in "~/irclogs/network/channel.log"
  78 .SH "CONFIGURATION FILE"
  79 .PP
  80 Please look at the sample configuration file in "/usr/share/docs/irssistats/sample.configfile" for an example.
  81 .PP
  82 The path to the configuration file can be given on the command line : \fBirssistats\fR \fI/path/to/irssistats.conf\fR
  83 .PP
  84 If no configuration file is given, irssistats looks for files ~/.irssistats.conf or then /etc/irssistats.conf
  85 .PP
  86 Lines starting by ; # -- or // are ignored (comments).
  87 .PP
  88 This file is read sequencially, so it acts like a script.
  89 .PP
  90 Each option keyword is case sensitive, and you must put separators around the ':' character.
  91 .PP
  92 Blank lines must not contain any spaces !
  93 .PP
  94 Each option keeps its value until erased by another value.
  95 .PP
  96 IMPORTANT : the order of options to parse a channel must allways be "input" THEN "nickfile" THEN "output".
  97 .PP
  98 Available options are :
  99 .IP "debug" 10
 100 Allows you to display debugging informations.
 101 .IP "" 10
 102 Values : normal / verbose / none
 103 .IP "" 10
 104 Default : normal
 105 .IP "channel" 10
 106 Specifies the name of the channel you are parsing.
 107 .IP "maintainer" 10
 108 Nickname of the person generating the statistics (you !).
 109 .IP "language" 10
 110 Language you want to use to display the statistics
 111 .IP "" 10
 112 Values : fr en de du es it fi ru
 113 .IP "" 10
 114 Default : en
 115 .IP "theme" 10
 116 Theme (colors) to use for the statistics, separated by comas
 117 .IP "" 10
 118 In fact this is the name of the CSS file to include.
 119 .IP "" 10
 120 This option has no effect if you use a custom header : you'll have to include the CSS yourself.
 121 .IP "" 10
 122 The first theme is the primary stylesheet, and the others are alternate themes
 123 .IP "top_words" 10
 124 Allows you to disable top words list which is using a lot of memory
 125 .IP "" 10
 126 Default : yes
 127 .IP "ranking" 10
 128 Specifies which ranking method to use
 129 .IP "" 10
 130 Values : lines / words / letters
 131 .IP "" 10
 132 Default : lines
 133 .IP "quarter" 10
 134 Display quarters in top hours (smoother graphs)
 135 .IP "" 10
 136 Default : no
 137 .IP "refresh_time" 10
 138 Specifies the refresh time in seconds (0 to disable)
 139 .IP "" 10
 140 This option has no effect if you use a custom header : you'll have to include the refresh code yourself.
 141 .IP "" 10
 142 Default : 3600
 143 .IP "w3c_link" 10
 144 Set this to "no" if you don't want the W3C logo.
 145 .IP "" 10
 146 Default : yes
 147 .IP "header" 10
 148 Use your custom header file (HTML code between <!DOCTYPE... and <body> included)
 149 .IP "footer" 10
 150 Use your custom footer file (HTML code between </body> and </html> included)
 151 .IP "input" 10
 152 This allow you to parse a file.
 153 .IP "" 10
 154 Note that irssistats will really parse the file as soon as it reads this option.
 155 .IP "nickfile" 10
 156 This allow you to group nick using a nickfile.
 157 .IP "" 10
 158 Note that irssistats will really merge the nicks as soon as it reads this option.
 159 .IP "output" 10
 160 This allow you to generate the HTML file.
 161 .IP "" 10
 162 Note that irssistats will really generate the HTML file as soon as it reads this option.
 163 .SH "NICKFILE"
 164 .PP
 165 Since version 0.4 of \fBirssistats\fR, you can use a nickfile to specify nicks to join.
 166 .PP
 167 Each line of the nickfile contains the final nick and a regular expression.
 168 .PP
 169 Examples :
 170 .IP "royale \(a^[Rr]oyale" 10
 171 join nicks starting with "Royale" or "royale" to the final nick "royale"
 172 .IP "royale \(a^antoine$" 10
 173 also join the nick "antoine" to the final nick "royale"
 174 .IP "djakette [Dd]ja" 10
 175 join any nick that contains "Dja" or "dja" to final nick "djakette"
 176 .IP "<NULL> \(a^bot\|royale$" 10
 177 remove "bot|royale" from statistics
 178 .PP
 179 The nickfile must not contain any comments.
 180 .PP
 181 The <NULL> final nick will remove matching nicks from all statistics, except from "Some URLs" and "Some topics"...
 182 .PP
 183 You can also take a look at the "sample.nickfile" in this package (in "/usr/share/doc/irssistats/").
 184 .SH "SEE ALSO"
 185 .PP
 186 \fBirssi\fR (1).
 187 .SH "INFORMATIONS"
 188 .PP
 189 You can find informations and updates of \fBirssistats\fR at \fIhttp://royale.zerezo.com/irssistats/ (link to URL http://royale.zerezo.com/irssistats/) \fR.
 190 .PP
 191 Report bugs to royale@zerezo.com.
 192 .SH "AUTHOR"
 193 .PP
 194 Antoine Jacquet royale@zerezo.com
 195 .\" created by instant / docbook-to-man, Mon 05 Apr 2004, 00:56