src/doc/manpages/torrus_nodeid.pod.in

   1 #  Copyright (C) 2010  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 nodeid - Torrus utility
  24
  25 =head1 SYNOPSIS
  26
  27 B<torrus nodeid> --tree=I<TREENAME> --cmd=CMD I<options...>
  28
  29 =head1 DESCRIPTION
  30
  31 This command provides a way to integrate Torrus with external OSS systems.
  32 It operates with I<nodeid>, a unique identifier for Torrus datasource
  33 subtrees and leaves.
  34
  35 The command prints the data on the standard output in JSON data format.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<--tree=TREE>
  42
  43 [Mandatory] Defines the datasouerce tree.
  44
  45
  46 =item B<--cmd=CMD>
  47
  48 [Mandatory] Defines the action command. The following commands are supported:
  49
  50 =over 8
  51
  52 =item * info
  53
  54 Prints information about the nodeid. Requires B<--nodeid>.
  55
  56 =item * search
  57
  58 Performs a prefix or substring search on node IDs and prints the results.
  59 Requires B<--prefix> or B<--substring>.
  60
  61 =item * render
  62
  63 Renders a specified datasource node and prints the resulting MIME type and the
  64 file name. Requires B<--nodeid> and B<--view>. Optional B<--out> defines
  65 a file name to copy the output to.
  66
  67 =back
  68
  69
  70 =item B<--nodeid=NODEID>
  71
  72 Specifies the Node ID string for the commands I<info> and I<render>.
  73
  74
  75 =item B<--details>
  76
  77 Toggles verbose output for the commands I<info> and I<search>.
  78
  79
  80 =item B<--prefix=STR>
  81
  82 Specifies the prefix search string for the command I<search>.
  83
  84
  85 =item B<--substring=STR>
  86
  87 Specifies the search substring for the command I<search>.
  88
  89
  90 =item B<--view=VIEW>
  91
  92 Specifies the view name for the command I<render>. The following views are
  93 defined by standard Torrus XML files and render a PNG graph:
  94 C<short>, C<last24h-small>, C<last24h>, C<lastweek>,
  95 C<lastmonth>, C<lastyear>. The following views are printing the datasource
  96 value in a text format: C<rrd-print-daily>, C<rrd-print-last>.
  97
  98
  99 =item B<--out=FILE>
 100
 101 If defined, instructs the utility to copy the rendered data into a
 102 specified file. Otherwise the file is created in the standard renderer's cache
 103 directory.
 104
 105
 106 =item B<--help>
 107
 108 Displays a help message.
 109
 110 =back
 111
 112
 113 =head1 SEE ALSO
 114
 115 L<torrus(@mansec_usercmd@)>
 116
 117 =head1 NOTES
 118
 119 See more documentation at Torrus home page: http://torrus.org
 120
 121 =head1 AUTHOR
 122
 123 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>