torrus/doc/manpages/torrus.pod.in

   1 #  Copyright (C) 2004  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.pod.in,v 1.1 2010-12-27 00:04:37 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 torrus - Commandline wrapper for Torrus utilities
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus> I<command> [I<options...>]
  29
  30 =head1 DESCRIPTION
  31
  32 All Torrus utilities use this common command-line wrapper, which simply
  33 passes all arguments to the appropriate utility.
  34
  35 Accepted commands:
  36
  37 =over 4
  38
  39 =item B<acledit>
  40
  41 =item B<cleanup>
  42
  43 =item B<clearcache>
  44
  45 =item B<collector>
  46
  47 =item B<compilexml>
  48
  49 =item B<configinfo>
  50
  51 =item B<configsnapshot>
  52
  53 =item B<devdiscover>
  54
  55 =item B<genddx>
  56
  57 =item B<genlist>
  58
  59 =item B<install_plugin>
  60
  61 =item B<monitor>
  62
  63 =item B<rrddir2xml>
  64
  65 =item B<schedulerinfo>
  66
  67 =item B<srvderive>
  68
  69 =back
  70
  71 =head1 OPTIONS
  72
  73 Refer to approproate manpages for options for each Torrus command.
  74
  75 =head1 SEE ALSO
  76
  77 L<torrus_acledit(@mansec_usercmd@)>,
  78 L<torrus_action_printemail(@mansec_misc@)>,
  79 L<torrus_action_snmptrap(@mansec_misc@)>,
  80 L<torrus_clearcache(@mansec_usercmd@)>,
  81 L<torrus_collector(@mansec_usercmd@)>,
  82 L<torrus_compilexml(@mansec_usercmd@)>,
  83 L<torrus_configinfo(@mansec_usercmd@)>,
  84 L<torrus_configsnapshot(@mansec_usercmd@)>,
  85 L<torrus_devdiscover(@mansec_usercmd@)>,
  86 L<torrus_genddx(@mansec_usercmd@)>,
  87 L<torrus_monitor(@mansec_usercmd@)>,
  88 L<torrus_rrddir2xml(@mansec_usercmd@)>,
  89 L<torrus_schedulerinfo(@mansec_usercmd@)>
  90 L<torrus_srvderive(@mansec_usercmd@)>
  91
  92 =head1 NOTES
  93
  94 See more documentation at Torrus home page: http://torrus.org
  95
  96 =head1 AUTHOR
  97
  98 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>