diff options
Diffstat (limited to 'torrus/doc/manpages/torrus_genlist.pod.in')
| -rw-r--r-- | torrus/doc/manpages/torrus_genlist.pod.in | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/torrus/doc/manpages/torrus_genlist.pod.in b/torrus/doc/manpages/torrus_genlist.pod.in new file mode 100644 index 000000000..a3e112c56 --- /dev/null +++ b/torrus/doc/manpages/torrus_genlist.pod.in @@ -0,0 +1,71 @@ +# Copyright (C) 2004 Stanislav Sinyagin +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + +# $Id: torrus_genlist.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +genlist - Lists Torrus objects + +=head1 SYNOPSIS + +B<torrus genlist> --tree=I<TREENAME> [I<options...>] + +=head1 DESCRIPTION + +This command generates a listing of objects in Torrus +configuration tree I<TREENAME>. Currently it lists the RRD files only. + +=head1 OPTIONS + +=over 4 + +=item B<--path>=I<PATH> + +Sets the subtree path to I<PATH>. Default values is "/". + +=item B<--what>=I<ITEMS> + +Includes items I<ITEMS> in the listing. Currently only "rrdfiles" is +a supported item. + +=item B<--type>=I<TYPE> + +Sets selection type. Currently supported values are "collector" (Collector +leaves), "readonly" (read-only leaves) and "all" (this also happens to be +default value). + +=item B<--help> + +Displays a help message. + +=back + +=head1 SEE ALSO + +L<torrus(@mansec_usercmd@)> + +=head1 NOTES + +See more documentation at Torrus home page: http://torrus.org + +=head1 AUTHOR + +Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt> + |