lire(7)
NAME
Lire - generate reports from various log files
INTRODUCTION
Lire allows one to generate reports from various log files.
- In this manpage, we give an overview of the Lire documentation.
- Documentation on installing Lire
- For installation instructions, read the file INSTALL. This file is shipped with the Lire tarball, lire-version.tar.gz. It is available from the World Wide Web at http://logreport.org/pub/current/INSTALL.
- Documentation for users
- Read the Lire README file for a quick start on Lire's usage. This file
is shipped with the Lire tarball. If you've installed Lire from a
package for your Operating System, it might be installed in a location like /usr/share/doc/lire/README . - Read the Lire User's Manual for a more in-depth overview. This manual
is available in various formats, and installed in
/usr/[local/]share/doc/lire/user-manual* . It is available online, at http://logreport.org/pub/current/doc/user-manual/ . - The main Lire commands (lire(1), lr_cron(1), lr_log2mail(1),
lr_log2report(1), lr_xml2report(1), ...) should be in your PATH. The
usage of these commands is documented in man pages; running e.g.
man lr_log2report - should show you the lr_log2report manpage.
- Documentation for developers
- If you plan to change the Lire internals, or if you are trying to fix a
bug, you should consult the Lire Developer's Manual. This document is
available in various formats, and installed in
/usr/[local/]share/doc/lire/dev-manual* . - A lot of Lire Perl modules get installed in the Lire:: namespace in the
Perl module hierarchy. Likely, this is something like
/usr/[local/]share/perl5/Lire/. Most of these come with their own man page. If you plan to write customized Lire extensions, you should read these manpages. - Lire convertors, which take care of log file specific processing, are
installed as Perl modules, named something like FooDlfConvertor.pm, and
come with their own man page. (Some old-style convertors come with
their own script, in /usr/[local/]libexec/lire/convertors/foo2dlf). If you're looking for information, specifically for your log file type,
you should look here. - If you plan to cooperate with the LogReport team, you might want to
take a look at the BUGS file, as distributed with the Lire tarball, too. - The file COPYING documents terms and conditions for copying,
distribution and modification of Lire. Some extra explanation about
this is given in Frequently Asked Question About Lire, online at http://logreport.org/lire/faq.php . - Other sources of information
- Some documentation on Lire and LogReport is not distributed with the
Lire tarball. Documentation is available from the LogReport website on http://www.logreport.org/ . It offers mailing list archives on
http://www.logreport.org/contact/lists/ . - You can get in touch with other Lire users on the Lire mailing lists,
see http://logreport.org/contact/lists/ . The LogReport team can be
contacted directly too (email, irc, snailmail), see
http://logreport.org/contact/ for details.
VERSION
This manpage: $Id: lire.pod,v 1.5 2006/07/23 13:16:32 vanbaal Exp $
COPYRIGHT
Copyright (C) 2002, 2003, 2004 Stichting LogReport Foundation
LogReport@LogReport.org
This manpage is part of Lire.
Lire is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.
AUTHOR
- Joost van Baal <joostvb@logreport.org>