Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

lire::lrcommand(3pm) [debian man page]

LrCommand(3pm)						  LogReport's Lire Documentation					    LrCommand(3pm)

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

       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.

Lire 2.1.1							    2006-07-23							    LrCommand(3pm)

Check Out this Related Man Page

ReportJob(3pm)						  LogReport's Lire Documentation					    ReportJob(3pm)

NAME

       Lire::ReportJob - Object used to configure periodical report generation

SYNOPSIS

	 use Lire::ReportJob;
	 use Lire::ReportSchedule;

	 my $store = Lire::DlfStore->open( 'aStore' );
	 my $job = new Lire::ReportJob( "webServer" );
	 my $cfg = $store->get_report_config( 'my_report' );
	 $job->add_schedule( new Lire::ReportSchedule( 'daily', $cfg );
	 $job->run( $store, 'daily' );

DESCRIPTION

       The Lire::ReportJob object is used to configure and execute report generation jobs. These objects are usually configured in a store through
       the lire(1) command.

   new( $name, );
       Create a new Lire::ReportJob(). The constructor takes one parameter which is an identifier.

   name()
       Returns the name of this ReportJob.

   add_schedule( $schedule, ... )
       Adds one or more Lire::ReportSchedule to the ReportJob objects.

   schedules()
       Returns the Lire::ReportSchedule related to this object.

   run( $store, $period, [$time]  )
       Executes all the configured generation with a period of 'period' using the $store DlfStore. Once the method returns, XML report will have
       been generated in the DlfStore and OutputJob associated with the ScheduleJob will have been sent. The $time parameter will be used to
       determine the time window covered by period. It defaults to the current time.

SEE ALSO

       Lire::DlfStore(3pm) Lire::ImportJob(3pm) Lire::ReportSchedule(3pm) lire(1) Lire::OutputJob(3pm)

AUTHOR

	 Francis J. Lacoste <flacoste@logreport.org>

VERSION

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

COPYRIGHT

       Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.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.

Lire 2.1.1							    2006-07-23							    ReportJob(3pm)
Man Page