torrus/doc/manpages/torrus_genreport.pod.in

   1 #  Copyright (C) 2007  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: torrus_genreport.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 genreport - Generate the Usage Report
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus genreport> --report=I<ReportName> --date=I<YYYY-MM-DD> [I<options...>]
  29 B<torrus genreport> --genhtml [I<options...>]
  30
  31
  32 =head1 DESCRIPTION
  33
  34 When the Torrus Reporting engine is set up, this command is used
  35 to generate the reports from the collected data.
  36 See I<Torrus Reporting Setup Guide> for more information.
  37
  38 =head1 OPTIONS
  39
  40 =over 4
  41
  42 =item B<--report>=I<ReportName>
  43
  44 The name of the report that is to be generated. Currently supported:
  45 C<MonthlyUsage>.
  46
  47 =item B<--date>=I<YYYY-MM-DD>
  48
  49 Specifies the start date of the reported period. For the monthly report,
  50 this should be any day within the calendar month.
  51
  52 =item B<--time>=I<hh:mm>
  53
  54 Specifies the start time of the reported period. This option
  55 is ignored for the monthly reports.
  56
  57 =item B<--genhtml>
  58
  59 Instructs the report engine to build the HTML output from the generated
  60 reports.
  61
  62 =item B<--tree=TREE>
  63
  64 When used with C<--genhtml>, generates the HTML reports only for
  65 the specified tree.
  66
  67 =item B<--all2tree=TREE>
  68
  69 When used with C<--genhtml>, generates the HTML reports only for
  70 all available service IDs in the specified tree.
  71
  72 =item B<--verbose>
  73
  74 Prints extra informatgion.
  75
  76 =item B<--debug>
  77
  78 Prints debugging information.
  79
  80 =back
  81
  82 =head1 SEE ALSO
  83
  84 L<torrus(@mansec_usercmd@)>
  85
  86 =head1 NOTES
  87
  88 See more documentation at Torrus home page: http://torrus.org
  89
  90 =head1 AUTHOR
  91
  92 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>
  93