Documentation

There are several documents available on the IRC Collective. Most importantly are the installation guide and the user's manual. If you already have any questions at this point you may want to read the FAQ first.

Currently only English versions are available. If you are willing to help translate the documentation to other language, please let us know.

Installation Guide

version 0.1.4
ENGLISH	Plain text
	Online (HTML)

User's Manual

version 0.1.4
ENGLISH	Plain text
	Online (HTML)

Developer's Reference

Database layout
Parser API
How to define a new input format
How to write a new output handler

FAQ

Q: Which logfile formats can the parser parse?

A: Currently Eggdrop, Irssi, mIRC and X-Chat are supported.

Q: What about unsupported logfile formats?

A: You can add other logfile formats yourself by defining a new input format. There is a template included in the distribution archive that you can use as a basis.

Q: What operating systems are supported?

A: Virtually all operating systems that support Perl.

Q: What databases can be used as a backend?

A: Currently MySQL, PostgreSQL and SQLite are supported.

Q: What web servers can be used to host the web application?

A: Apache and Microsoft IIS. Maybe others as well, let us know if it worked with another web server.

Q: Why is Perl chosen as the scripting language?

A: Perl is very good at parsing plain text and because Perl is available on a lot of platforms.

Q: How should my logfiles be named so the parser can find them?

A: Your logfiles must be rotated daily and conform to a certain naming convention, see the note on logfiles in the installation guide.