$Id: INSTALL,v 1.82 2004/10/08 18:12:55 flacoste Exp $

The Lire software can be installed in a user's home directory or it
can be installed at the system level.

If you are upgrading from an earlier version of Lire, consult the
section upgrading from previous release.

Binary Release
==============

We suggest that you use a binary distribution of Lire when available
for your platform. Currently, we offer binary distributions of Lire for Debian
and GNU/Linux RPM based distributions. See http://logreport.org/lire/dl.php
for details.

Requirements
============

Before installing Lire, you should have the following available on your
system :

    - GNU gzip
    - Perl 5.6.1 or newer. Perl 5.8.0 is required to support non-ASCII
      encoding.
    - expat 1.9.x and XML::Parser 2.29 or later. You can download expat from 
      http://expat.sourceforge.net/ and XML::Parser from your local
      CPAN mirror.
    - The DBI perl module available from your local CPAN mirror.
    - DBD::SQLite2 0.32 or later.
    - The Curses::UI CPAN module (which also requires Curses and TermReadKey).
    - The libintl-perl module suite.
    - The Digest::MD5 module if you are running any version of Perl earlier
      than 5.8.0.

    - Standard Unix utilities like sh(1), cut(1), head(1), sort(1), grep(1),
      and cat(1) should be in your PATH.  You'll need an MTA supplying
      (/usr/sbin/)sendmail if you want to use lr_log2mail (./configure will
      fail if you lack one.)
    - Optionally, Lire can send its messages to syslog if you have
      logger(1) installed.

If you want to generate graphics, you will also need ploticus which you can 
download from http://ploticus.sf.net/.

To generate DVI or PostScript reports you will need a recent TeX
that includes the commands, lambda and odvips. In addition, ps2pdf which
comes with GhostScript is required for PDF output.

To send reports by email or to install an online responder, you'll need the 
MIME::Tools package available from you local CPAN mirror.

If you plan to use the anonymizer, you will need:

    - The DB_File perl module and Berkeley DB (libdb.so). DB_File is
      included with the standard perl distribution.

If you plan to process log files larger than 2 Gb, your perl should
be compiled with large file support. You can check whether your perl is
OK by running `perl -V' and inspecting the value displayed for
`uselargefiles' (The default Red Hat Linux 7.2 perl RPM is reported to
lack this support).
See also http://logreport.org/contact/lists/development/msg00575.php .

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

Lire follows the standard GNU practice of the ./configure script for its
configuration.

To install Lire, do this: (<version> is e.g. "1.5")

 ~$ gzip -dc lire-<version>.tar.gz | tar xf -
 ~$ cd lire-<version>

 ~/lire-version$ ./configure [ --prefix=$HOME/lire ]
 ~/lire-version$ make
 ~/lire-version$ make install

All Lire software is now installed under the directory you specified
using the --prefix argument. The default prefix is /usr/local.

Note: Be sure to keep the Lire Makefiles in its build tree on your
system.  This will make it easy to uninstall or upgrade Lire later.
If you care about your diskspace, do a 'make clean': this will give you
some diskspace back and won't harm.

If you use a private installation prefix, you will need to add those
directories to your paths. For example, if you installed Lire under
$HOME/lire, you will need to add $HOME/lire/bin to your PATH and
$HOME/lire/man to your MANPATH.

You should have some Lire man pages installed on your system now.  If your
default shell is bourne-shell compatible (sh, bash, zsh, ksh...), append
something like

MANPATH=/usr/share/man:$HOME/lire/man
PATH=$PATH:$HOME/lire/bin
export MANPATH PATH

to your shell's startup script.

Consult the README file for more information regarding Lire use.

Removing Lire From Your System
==============================

If you want to uninstall the software, make sure you keep your Makefile
in the lire source tree. From there, run

 $ make uninstall

This will remove all files which were installed. (Newly created directories
will stay.)


Options For ./configure
=======================

After install, these directories will be present on your system:

 <sysconfdir>/lire             - configuration files
 <mandir>/man1                 - manpages
 <mandir>/man3                 - manpages
 <datadir>/doc/lire            - documentation
 <datadir>/lire/filters        - XML files, used in reports
 <datadir>/lire/reports        - XML files, used in reports
 <datadir>/lire/schemas        - XML files, used for Lire internals
 <datadir>/lire/templates      - XML files, used for reports
 <datadir>/lire/xml            - XML stylesheets and DTD's
 <datadir>/perl5               - perl modules
 <libexecdir>/lire             - scripts, not to be run manually
 <bindir>                      - scripts
 $HOME/tmp                     - tmp files (directory gets created on the fly)
 <localstatedir>/lib/lire/data - the Lire archive, containing reports and
                                  logfiles, gets build here

Run

  ./configure --help

to see what the default for <sysconfdir>, <mandir>, <datadir>, <prefix>, 
<bindir> and <libexecdir> are.

One can even tweak internal configure variables, which lack a commandline
option.  One could e.g. run

 JADE=/opt/jade/jade
 ./configure

to force the jade used to be the one under /opt. Other settings that can be
overwritten in this manner are, for example, TAR, GZIP, PERL.
Inspect the configure script itself (or configure.in) to find out more about
this advanced usage.

Upgrading From An Earlier Version Of Lire
=========================================

Upgrading from Lire 1.5
-----------------------

Lire 2.0 now stores report configuration data (the old .cfg files) in
XML. There is a lr_report_cfg2spec(1) command available to convert
your old report configuration files as a XML report template. Any
report configuration files that was specified in ReportJobs will be
automatically migrated when you open the DlfStore (either using
lire(1) or lr_cron(1)).

If you used the merging feature of lr_xml2report or used the
lr_xml2mail command, consult their man pages since their usage
changed.

Upgrading from Lire 1.3 or 1.4
------------------------------

The global parameters from Lire 1.3 and later will continue to work
under Lire 1.5. Configuration from earlier release will need to be
entered anew.

Cron configuration from earlier release aren't supported under Lire
1.5. You should either use the lire(1) command to create and configure
a DlfStore or use directly lr_log2report in your cron jobs.

More Information
================

For information on how to test and use this software, refer to the Lire User
Manual in doc/.

