.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "LrCommand 3pm"
.TH LrCommand 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::LrCommand \- Base class for command line programs.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 7
\&  my $prog = new Lire::LrCommand();
\&  $prog\->init();
\&  $prog\->add_section( \*(Aqmyprog\*(Aq, _\|_( \*(AqMy Program Options\*(Aq ) );
\&  $prog\->add_option( \*(Aqname\*(Aq => \*(Aqmyoption\*(Aq, \*(Aqtype\*(Aq => \*(Aq=s\*(Aq,
\&                     \*(Aqhelp\*(Aq => _\|_( \*(AqMy option help.\*(Aq ) );
\&  $prog\->add_common_options();
\&  $prog\->parse_options();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Class which is used to create command line program which shares
functionaliy.
.SH METHODS
.IX Header "METHODS"
.SS "new( [$usage], [$help] )"
.IX Subsection "new( [$usage], [$help] )"
Creates a new Lire::LrCommon instance. Initializes the usage string
and the help message to \f(CW$usage\fR and \f(CW$help\fR.
.SS "set_usage( [$usage] )"
.IX Subsection "set_usage( [$usage] )"
.SS "set_help( [$help] )"
.IX Subsection "set_help( [$help] )"
.SS "set_section( [$name], [$label] )"
.IX Subsection "set_section( [$name], [$label] )"
.SS "add_option( [%args] )"
.IX Subsection "add_option( [%args] )"
.SS \fBadd_common_options()\fP
.IX Subsection "add_common_options()"
.SS "import_log( [$converter], [$logfile] )"
.IX Subsection "import_log( [$converter], [$logfile] )"
import_log invokes Lire::ImportJob and Lire::DlfConverterProcess.
It uses &handle_logfile.
.PP
This means that in case the \f(CW$logfile\fR is compressed, it is decompressed to a
file in \f(CW$TMPDIR\fR.  In case the \f(CW$logfile\fR is read from a pipe or from STDIN, it is
written to a file in \f(CW$TMPDIR\fR.  So, if you\*(Aqre short on discspace, pass the
logfile as an uncompressed file.
.SS "generate_report( [$converter], [$logfile] )"
.IX Subsection "generate_report( [$converter], [$logfile] )"
Generate a report from a \f(CW$logfile\fR, using \f(CW$converter\fR.  Returns \f(CW$reportfile\fR.
Uses Lire::ReportConfig::generate_report to do the real work.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlr_log2report\fR\|(1), \fBlr_log2mail\fR\|(1), \fBlr_xml2mail\fR\|(1), \fBlr_xml2report\fR\|(1),
\&\fBLire::Config\fR\|(3pm), \fBLire::ReportConfig\fR\|(3pm), \fBLire::PluginManager\fR\|(3pm),
\&\fBLire::DlfStore\fR\|(3pm), \fBLire::ImportJob\fR\|(3pm), \fBLire::OutputJob\fR\|(3pm),
\&\fBLire::DlfConverterProcess\fR\|(3pm)
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR LrCommand.pm,v 1.9 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogRepor
t.org
.PP
This file is part of Lire.
.PP
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.
.PP
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.
.PP
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.