trusty (3) Lire::LrCommand.3pm.gz

Provided by: lire-devel-doc_2.1.1-2.1_all bug

NAME
       Lire::LrCommand - Base class for command line programs.


SYNOPSIS
         my $prog = new Lire::LrCommand();
         $prog->init();
         $prog->add_section( 'myprog', __( 'My Program Options' ) );
         $prog->add_option( 'name' => 'myoption', 'type' => '=s',
                            'help' => __( 'My option help.' ) );
         $prog->add_common_options();
         $prog->parse_options();


DESCRIPTION
       Class which is used to create command line program which shares functionaliy.


METHODS
   new( [$usage], [$help] )
       Creates a new Lire::LrCommon instance. Initializes the usage string and the help message to $usage and
       $help.

   set_usage( [$usage] )
   set_help( [$help] )
   set_section( [$name], [$label] )
   add_option( [%args] )
   add_common_options()
   import_log( [$converter], [$logfile] )
       import_log invokes Lire::ImportJob and Lire::DlfConverterProcess.  It uses &handle_logfile.

       This means that in case the $logfile is compressed, it is decompressed to a file in $TMPDIR.  In case the
       $logfile is read from a pipe or from STDIN, it is written to a file in $TMPDIR.  So, if you're short on
       discspace, pass the logfile as an uncompressed file.

   generate_report( [$converter], [$logfile] )
       Generate a report from a $logfile, using $converter.  Returns $reportfile.  Uses
       Lire::ReportConfig::generate_report to do the real work.


SEE ALSO
       lr_log2report(1), lr_log2mail(1), lr_xml2mail(1), lr_xml2report(1), Lire::Config(3pm),
       Lire::ReportConfig(3pm), Lire::PluginManager(3pm), Lire::DlfStore(3pm), Lire::ImportJob(3pm),
       Lire::OutputJob(3pm), Lire::DlfConverterProcess(3pm)


AUTHOR
         Francis J. Lacoste <flacoste@logreport.org>


VERSION
       $Id: LrCommand.pm,v 1.9 2006/07/23 13:16:29 vanbaal Exp $


       Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogRepor t.org

       This file 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.