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

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