README

   1  yaala 0.7.3 - README - 2004-11-10
   2 ===================================
   3 http://yaala.org/
   4
   5
   6  Table of Contents
   7 -------------------
   8 1. Brief description
   9 2. Setting it up
  10 3. Using it
  11
  12
  13  1. Brief description
  14 ======================
  15 "yaala" parses logfiles and generates statistics in the HTML-format. In
  16 theory just about every (non-binary) logfile in existance can be parsed.
  17 However, you might need to write the parser yourself. The parsing modules
  18 that come with the package are: NCSA (= Apache Combined logs), Apache
  19 Common logs (= access logs)wnserver logs (the verbose format), squid's
  20 access logs, Postfix entries in the maillog and the xferlog used by some
  21 FTP servers.
  22
  23 Since I do not have any logfiles for ``wnserver'' I could not test the
  24 parser for it!
  25
  26
  27  2. Setting it up
  28 ==================
  29 You need to edit the "config" file. It is documented and shouldn't be a
  30 problem. Take a close look at the 'select'-statement. It is used to select
  31 the information you want to have reported. The syntax is being described
  32 in ``README.selections''.
  33
  34 Once you're familiar with all the config options you may use _ALL_ of them
  35 in the command line. This is usefull for scripts which generate more than
  36 one report automatically. However, it sometimes is handy to do thing
  37 without touching the config file..
  38
  39
  40  3. Using it
  41 =============
  42 That's really simple, once it's configured:
  43
  44 octo@leeloo:~/yaala-0.7.1 $ ./yaala <FILE1> [FILE2 FILE3 ...]
  45
  46 You can define as much logfiles as you want, but keep in mind that you
  47 might get really big html-files. "yaala" will automatically create and/or
  48 overwrite existing files. Please make sure to set the 'directory' option
  49 appropriately.
  50
  51 --
  52 octo (at verplant.org)