1 # Copyright (C) 2007 Stanislav Sinyagin
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.
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.
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.
17 # $Id: torrus_srvderive.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
24 srvderive - Derive a new service ID from sum or maximum of other service values
28 B<torrus srvderive> I<TIMESPAN> I<OUTPUT> I<FUNCTION> I<SOURCES>...
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.
36 See I<Torrus Reporting Setup Guide> for more information.
40 Either --month or --end option must be defined
44 =item B<--start>=I<YYYY-MM-DD>
46 Sets the start date of the calculation.
48 =item B<--end>=I<YYYY-MM-DD>
50 Sets the next day after the eond of the period.
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.
64 =item B<--out>=I<SERVICEID>
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
79 =item B<--func>=C<MAX>|C<SUM>
81 Sets the function to be used when combining the input service data.
82 Currently only C<MAX> and C<SUM> are supportted.
91 =item B<--in>=I<SERVICEID> ...
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.
106 Default: 300. Sets the data interval for derived service ID. It is recommended
107 to leave this option at default value.
111 Prints extra informatgion.
115 Prints debugging information.
119 Prints command usage information.
127 L<torrus(@mansec_usercmd@)>
131 See more documentation at Torrus home page: http://torrus.org
135 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>