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