1 # Copyright (C) 2004 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_rrddir2xml.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $
18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
24 rrddir2xml - Searches a directory for RRD files and generates Torrus XML
29 B<torrus rrddir2xml> --dir=I<DIR> [I<options...>]
33 B<rrddir2xml> searches in a given directory for RRD files and
34 creates Torrus XML configuration file suitable for browsing ofthose data
37 With default options, it is usable for RRD files generated by Torrus'
38 SNMP collector, where the file name starts with the host name, separated by
39 underscore from interface name or other MIB specifics. With these
40 defaults, it creates a subtree per each host name, and all RRD files belonging
41 top that host name are sorted alphabetically in that subtree.
49 Absolute path to the directory for searching. The directory may contain also
50 non-RRD files. Only regular files are processed, and the symlinks are ignored.
54 If specified, the directory will be searched recursively. All file names
55 across all subdirectories must be unique. Symlinks to other directories
58 =item B<--filter>=I<Regexp>
60 If the filter is specified, then B<rrddir2xml> lists only those files and
61 subdirectories whose names match the given regular expression.
63 =item B<--out>=I<FILE>
65 Output XML file name. If relative path given, the file is placed in
66 F<@sitexmldir@>. Default: F<rrddir.xml>.
68 =item B<--subtree>=I<SUBTREE>
70 Top subtree path in the generted XML. Default is the top of the tree (C</>).
72 =item B<--split>=I<REGEXP>
74 Regular expression used for splitting the file name into parts
75 to build the subtree hierarchy. Default is a sequence of underscores (C<_+>).
77 =item B<--levels>=I<INTEGER>
79 Number of levels of hierarchy to build by splitting the file names.
82 =item B<--comment>=I<TEXT>
84 Text to put as C<comment> parameter to the top subtree.
86 =item B<--holtwinters>
88 If specified, Holt-Winters prediciton boundaries and failures are displayed
93 Prints extra diagnosics.
97 Prints debugging information.
104 L<torrus(@mansec_usercmd@)>
108 See more documentation at Torrus home page: http://torrus.org
112 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>