$Id: README,v 1.115 2004/10/13 10:38:18 vanbaal Exp $

Installation
============

Read INSTALL for installation instructions.

Generating a Report From a Log File
===================================
 
Once Lire is installed, you can generate a report from a log file by
invoking the command: 

 $ lr_log2report sendmail > /tmp/report.txt < /var/log/maillog.2.gz

Of course, if your log file isn't a sendmail log file, you'll
need to change the 'sendmail' argument to the format of your log
file. This argument is what's called a Lire DLF converter. A list of
available converters (sometimes refered to as `Lire services') gets
printed by

 $ lr_log2report --help dlf-converters

This will learn you which log file types are supported. Some popular
services are `postfix', `combined' (for webserver logs) and
`bind9_query'.

By default, text report are generated, you can use the '-o' option to
specify another output format:

 $ lr_log2report -o html -i combined \
   < /var/log/apache/combined.log.gz \
   |  tar -xf -

The service argument is `combined' here, for webserver's combined, a.k.a.
"extended common log format" as first implemented by NSCA.  In this case, a
report in HTML format is generated in a newly created subdirectory ./report/.
You'll need ploticus for generating a report with images. PDF output is
supported too.

Read the lr_log2report manpage for more details.

Read the lire(7) manpage for an overview of all available documentation.

Configuring Lire
================

The lire(1) command should be used to modify Lire's configuration.  See the
lire(1) manpage for more information.

Automatic Report Generation
===========================

DLF Store
---------

The lire(1) command can also be used to enable automatic report generation by
creating and managing a DLF store.  See the lire(1) manpage for more
information.

Cron Configuration
------------------

To run the scheduled jobs, you will need to setup cron jobs.  See lr_cron(1)
for more information.

