torrus/doc/manpages/torrus_srvderive.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_srvderive.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 srvderive - Derive a new service ID from sum or maximum of other service values
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus srvderive> I<TIMESPAN> I<OUTPUT> I<FUNCTION> I<SOURCES>...
  29
  30 =head1 DESCRIPTION
  31
  32 When the Torrus Reporting engine is set up, this command is used
  33 to combine several services data into a new service ID. The output data
  34 is either the maximum or the sum of input services.
  35
  36 See I<Torrus Reporting Setup Guide> for more information.
  37
  38 =head1 TIMESPAN
  39
  40 Either --month or --end option must be defined
  41
  42 =over 4
  43
  44 =item B<--start>=I<YYYY-MM-DD>
  45
  46 Sets the start date of the calculation.
  47
  48 =item B<--end>=I<YYYY-MM-DD>
  49
  50 Sets the next day after the eond of the period.
  51
  52 =item B<--month>
  53
  54 Instead of setting the end data, it is convenient to use this option. It sets
  55 the end data in one calendar month after the start date.
  56
  57 =back
  58
  59
  60 =head1 OUTPUT
  61
  62 =over 4
  63
  64 =item B<--out>=I<SERVICEID>
  65
  66 Sets the output service ID. This should not be a service ID used in the
  67 Torrus datasource trees. B<Note:> if I<srvderive> command is run twice
  68 with the same arguments, the produced data is doubled for the output
  69 service ID.
  70
  71 =back
  72
  73
  74
  75 =head1 FUNCTION
  76
  77 =over 4
  78
  79 =item B<--func>=C<MAX>|C<SUM>
  80
  81 Sets the function to be used when combining the input service data.
  82 Currently only C<MAX> and C<SUM> are supportted.
  83
  84 =back
  85
  86
  87 =head1 SOURCES
  88
  89 =over 4
  90
  91 =item B<--in>=I<SERVICEID> ...
  92
  93 Input service IDs are specified either by B<--in> option, or as command line
  94 arguments. At least 2 input service IDs should be specified.
  95
  96 =back
  97
  98
  99
 100 =head1 OPTIONS
 101
 102 =over 4
 103
 104 =item B<--step>
 105
 106 Default: 300. Sets the data interval for derived service ID. It is recommended
 107 to leave this option at default value.
 108
 109 =item B<--verbose>
 110
 111 Prints extra informatgion.
 112
 113 =item B<--debug>
 114
 115 Prints debugging information.
 116
 117 =item B<--help>
 118
 119 Prints command usage information.
 120
 121 =back
 122
 123
 124
 125 =head1 SEE ALSO
 126
 127 L<torrus(@mansec_usercmd@)>
 128
 129 =head1 NOTES
 130
 131 See more documentation at Torrus home page: http://torrus.org
 132
 133 =head1 AUTHOR
 134
 135 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>
 136