Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
IRSSISTATS(1)		    General Commands Manual		 IRSSISTATS(1)

NAME
       irssistats -- A tool to generate	HTML IRC stats based on	irssi logs.

SYNOPSIS
       irssistats [/path/to/file.conf]

DESCRIPTION
       irssistats is a tool that make HTML stats from irssi logfiles.

       The  statistics	generated  display  many useful	and funny informations
       about the channel.

USING IT
       First you need to copy the files	needed for the HTML page :

       cp /usr/share/irssistats/data/* /path/to/webdir/

       Then you	must  edit  a  configuration  file  :  "/etc/irssistats.conf",
       "~/.irssistats",	or another file	given as a parameter.

       Now you can generate the	statistics for your channel :

       irssistats [/path/to/file.conf]

       The  logfiles for irssi are usually located in "~/irclogs/network/chan-
       nel.log"

CONFIGURATION FILE
       Please	 look	 at    the    sample	 configuration	   file	    in
       "/usr/share/docs/irssistats/sample.configfile" for an example.

       The  path  to the configuration file can	be given on the	command	line :
       irssistats /path/to/irssistats.conf

       If  no  configuration  file  is	given,	irssistats  looks  for	 files
       ~/.irssistats.conf or then /etc/irssistats.conf

       Lines starting by ; # --	or // are ignored (comments).

       This file is read sequencially, so it acts like a script.

       Each  option  keyword  is  case	sensitive, and you must	put separators
       around the ':' character.

       Blank lines must	not contain any	spaces !

       Each option keeps its value until erased	by another value.

       IMPORTANT : the order of	options	to parse a  channel  must  allways  be
       "input" THEN "nickfile" THEN "photofile"	THEN "output".

       Available options are :

       debug	 Allows	you to display debugging informations.

		 Values	: normal / verbose / none

		 Default : normal

       channel	 Specifies the name of the channel you are parsing.

       maintainer
		 Nickname of the person	generating the statistics (you !).

       language	 Language you want to use to display the statistics

		 Values	: fr en	de du es it fi ru et

		 Default : en

       theme	 Theme (colors)	to use for the statistics, separated by	comas

		 In fact this is the name of the CSS file to include.

		 This option has no effect if you use a	custom header :	you'll
		 have to include the CSS yourself.

		 The first theme is the	primary	stylesheet, and	the others are
		 alternate themes

       top_words Allows	 you to	disable	top words list which is	using a	lot of
		 memory

		 Default : yes

       ranking	 Specifies which ranking method	to use

		 Values	: lines	/ words	/ letters

		 Default : lines

       quarter	 Display quarters in top hours (smoother graphs)

		 Default : no

       weeks	 Display last week statistics

		 Default : no

       months	 Display last months statistics

		 Default : no

       refresh_time
		 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.

		 Default : 3600

       photo_size
		 Specifies the size in pixels of the thumbnails	for users

		 This  option  has an effect only if there is a	photofile (see
		 below)

		 Set to	0 to disable (display pictures with their real size)

		 Default : 60

       w3c_link	 Set this to "no" if you don't want the	W3C logo.

		 Default : yes

       logo	 Set this to "no" if you don't want the	irssistats logo.

		 Default : yes

       header	 Use your custom header	file (HTML code	 between  <!DOCTYPE...
		 and <body> included)

       footer	 Use  your  custom  footer file	(HTML code between </body> and
		 </html> included)

       input	 This allow you	to parse a file.

		 Note that irssistats will really parse	the file as soon as it
		 reads this option.

       nickfile	 This allow you	to group nick using a nickfile.

		 Note  that  irssistats	will really merge the nicks as soon as
		 it reads this option.

       photofile This allow you	to display pictures for	users.

       output	 This allow you	to generate the	HTML file.

		 Note that irssistats will really generate the	HTML  file  as
		 soon as it reads this option.

NICKFILE
       Since  version  0.4  of	irssistats,  you can use a nickfile to specify
       nicks to	join.

       Each line of the	nickfile contains the final nick and a regular expres-
       sion.

       Examples	:

       royale ^[Rr]oyale
		 join  nicks  starting	with "Royale" or "royale" to the final
		 nick "royale"

       royale ^antoine$
		 also join the nick "antoine" to the final nick	"royale"

       djakette	[Dd]ja
		 join any nick that contains "Dja"  or	"dja"  to  final  nick
		 "djakette"

       <NULL> ^botroyale$
		 remove	"bot|royale" from statistics

       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"...

       You can also take a look	at the "sample.nickfile" in this  package  (in
       "/usr/share/doc/irssistats/").

PHOTOFILE
       Since  version  0.70  of	irssistats, you	can use	a photofile to display
       pictures	for users.

       Each line of the	photofile contains the final nick and an URL  for  the
       image.

       Examples	:

       royale http://royale.zerezo.com/chat/faces/happy40.png
		 (a full address)

       sektor ../chat/faces/happy40.png
		 (a relative address)

       The photofile must not contain any comments.

       You  can	also take a look at the	"sample.photofile" in this package (in
       "/usr/share/doc/irssistats/").

SEE ALSO
       irssi (1).

INFORMATIONS
       You   can   find	  informations	 and   updates	 of   irssistats    at
       http://royale.zerezo.com/irssistats/	    (link	 to	   URL
       http://royale.zerezo.com/irssistats/) .

       Report bugs to royale@zerezo.com.

AUTHOR
       Antoine Jacquet royale@zerezo.com

								 IRSSISTATS(1)

NAME | SYNOPSIS | DESCRIPTION | USING IT | CONFIGURATION FILE | NICKFILE | PHOTOFILE | SEE ALSO | INFORMATIONS | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=irssistats&sektion=1&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help