version 0.71
[irssistats] / irssistats.1
index 62c138b..4416cbd 100644 (file)
@@ -1,56 +1,3 @@
-.\" $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. 
@@ -83,7 +30,7 @@ The path to the configuration file can be given on the command line : \fBirssist
 .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). 
+Lines starting by ; # \-\- or // are ignored (comments). 
 .PP 
 This file is read sequencially, so it acts like a script. 
 .PP 
@@ -93,7 +40,7 @@ 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". 
+IMPORTANT : the order of options to parse a channel must allways be "input" THEN "nickfile" THEN "photofile" THEN "output". 
 .PP 
 Available options are : 
 .IP "debug" 10 
@@ -140,10 +87,22 @@ Specifies the refresh time in seconds (0 to disable)
 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 "photo_size" 10 
+Specifies the size in pixels of the thumbnails for users 
+.IP "" 10 
+This option has an effect only if there is a photofile (see below) 
+.IP "" 10 
+Set to 0 to disable (display pictures with their real size) 
+.IP "" 10 
+Default : 60 
 .IP "w3c_link" 10 
 Set this to "no" if you don't want the W3C logo. 
 .IP "" 10 
 Default : yes 
+.IP "logo" 10 
+Set this to "no" if you don't want the irssistats logo. 
+.IP "" 10 
+Default : yes 
 .IP "header" 10 
 Use your custom header file (HTML code between <!DOCTYPE... and <body> included) 
 .IP "footer" 10 
@@ -156,6 +115,8 @@ Note that irssistats will really parse the file as soon as it reads this option.
 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 "photofile" 10 
+This allow you to display pictures for users. 
 .IP "output" 10 
 This allow you to generate the HTML file. 
 .IP "" 10 
@@ -181,6 +142,21 @@ The nickfile must not contain any comments.
 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 "PHOTOFILE" 
+.PP 
+Since version 0.70 of \fBirssistats\fR, you can use a photofile to display pictures for users. 
+.PP 
+Each line of the photofile contains the final nick and an URL for the image. 
+.PP 
+Examples : 
+.IP "royale http://royale.zerezo.com/chat/faces/happy40.png" 10 
+(a full address) 
+.IP "sektor ../chat/faces/happy40.png" 10 
+(a relative address) 
+.PP 
+The photofile must not contain any comments. 
+.PP 
+You can also take a look at the "sample.photofile" in this package (in "/usr/share/doc/irssistats/"). 
 .SH "SEE ALSO" 
 .PP 
 \fBirssi\fR (1). 
@@ -192,4 +168,4 @@ Report bugs to royale@zerezo.com.
 .SH "AUTHOR" 
 .PP 
 Antoine Jacquet royale@zerezo.com 
-.\" created by instant / docbook-to-man, Mon 03 May 2004, 21:30 
+.\" created by instant / docbook-to-man, Sun 06 Feb 2005, 06:38