yaala - README - 2005-07-08
===================================
http://yaala.org/


 Table of Contents
-------------------
1. Brief description
2. Setting it up
3. Using it


 1. Brief description
======================
"yaala" parses logfiles and generates statistics in the HTML-format. In
theory just about every (non-binary) logfile in existance can be parsed.
However, you might need to write the parser yourself. The parsing modules
that come with the package are: NCSA (= Apache Combined logs), Apache
Common logs (= access logs)wnserver logs (the verbose format), squid's
access logs, Postfix entries in the maillog and the xferlog used by some
FTP servers.

Since I do not have any logfiles for ``wnserver'' I could not test the
parser for it!


 2. Setting it up
==================
You need to edit the "config" file. It is documented and shouldn't be a
problem. Take a close look at the 'select'-statement. It is used to select
the information you want to have reported. The syntax is being described
in ``README.selections''.

Once you're familiar with all the config options you may use _ALL_ of them
in the command line. This is usefull for scripts which generate more than
one report automatically. However, it sometimes is handy to do thing
without touching the config file..


 3. Using it
=============
That's really simple, once it's configured:

octo@leeloo:~/yaala-0.7.1 $ ./yaala <FILE1> [FILE2 FILE3 ...]

You can define as much logfiles as you want, but keep in mind that you
might get really big html-files. "yaala" will automatically create and/or
overwrite existing files. Please make sure to set the 'directory' option
appropriately.

--
octo (at verplant.org)