src/doc/manpages/torrus_rrddir2xml.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 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  18 #
  19 #
  20
  21 =head1 NAME
  22
  23 rrddir2xml - Searches a directory for RRD files and generates Torrus XML
  24 configuration file.
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus rrddir2xml> --dir=I<DIR> [I<options...>]
  29
  30 =head1 DESCRIPTION
  31
  32 B<rrddir2xml> searches in a given directory for RRD files and
  33 creates Torrus XML configuration file suitable for browsing ofthose data
  34 files.
  35
  36 With default options, it is usable for RRD files generated by Torrus'
  37 SNMP collector, where the file name starts with the host name, separated by
  38 underscore from interface name or other MIB specifics. With these
  39 defaults, it creates a subtree per each host name, and all RRD files belonging
  40 top that host name are sorted alphabetically in that subtree.
  41
  42 =head1 OPTIONS
  43
  44 =over 4
  45
  46 =item B<--dir>=I<DIR>
  47
  48 Absolute path to the directory for searching. The directory may contain also
  49 non-RRD files. Only regular files are processed, and the symlinks are ignored.
  50
  51 =item B<--recursive>
  52
  53 If specified, the directory will be searched recursively. All file names
  54 across all subdirectories must be unique. Symlinks to other directories
  55 are ignored.
  56
  57 =item B<--filter>=I<Regexp>
  58
  59 If the filter is specified, then B<rrddir2xml> lists only those files and
  60 subdirectories whose names match the given regular expression.
  61
  62 =item B<--out>=I<FILE>
  63
  64 Output XML file name. If relative path given, the file is placed in
  65 F<@sitexmldir@>. Default: F<rrddir.xml>.
  66
  67 =item B<--subtree>=I<SUBTREE>
  68
  69 Top subtree path in the generted XML. Default is the top of the tree (C</>).
  70
  71 =item B<--split>=I<REGEXP>
  72
  73 Regular expression used for splitting the file name into parts
  74 to build the subtree hierarchy. Default is a sequence of underscores (C<_+>).
  75
  76 =item B<--levels>=I<INTEGER>
  77
  78 Number of levels of hierarchy to build by splitting the file names.
  79 Default is 2 levels.
  80
  81 =item B<--comment>=I<TEXT>
  82
  83 Text to put as C<comment> parameter to the top subtree.
  84
  85 =item B<--holtwinters>
  86
  87 If specified, Holt-Winters prediciton boundaries and failures are displayed
  88 in the graphs.
  89
  90 =item B<--verbose>
  91
  92 Prints extra diagnosics.
  93
  94 =item B<--debug>
  95
  96 Prints debugging information.
  97
  98 =back
  99
 100
 101 =head1 SEE ALSO
 102
 103 L<torrus(@mansec_usercmd@)>
 104
 105 =head1 NOTES
 106
 107 See more documentation at Torrus home page: http://torrus.org
 108
 109 =head1 AUTHOR
 110
 111 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>