torrus/doc/manpages/torrus_genlist.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_genlist.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 genlist - Lists Torrus objects
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus genlist> --tree=I<TREENAME> [I<options...>]
  29
  30 =head1 DESCRIPTION
  31
  32 This command generates a listing of objects in Torrus
  33 configuration tree I<TREENAME>. Currently it lists the RRD files only.
  34
  35 =head1 OPTIONS
  36
  37 =over 4
  38
  39 =item B<--path>=I<PATH>
  40
  41 Sets the subtree path to I<PATH>. Default values is "/".
  42
  43 =item B<--what>=I<ITEMS>
  44
  45 Includes items I<ITEMS> in the listing. Currently only "rrdfiles" is
  46 a supported item.
  47
  48 =item B<--type>=I<TYPE>
  49
  50 Sets selection type. Currently supported values are "collector" (Collector
  51 leaves), "readonly" (read-only leaves) and "all" (this also happens to be
  52 default value).
  53
  54 =item B<--help>
  55
  56 Displays a help message.
  57
  58 =back
  59
  60 =head1 SEE ALSO
  61
  62 L<torrus(@mansec_usercmd@)>
  63
  64 =head1 NOTES
  65
  66 See more documentation at Torrus home page: http://torrus.org
  67
  68 =head1 AUTHOR
  69
  70 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>
  71