1 # Copyright (C) 2010 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_nodeid.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
24 nodeid - Torrus utility
28 B<torrus nodeid> --tree=I<TREENAME> --cmd=CMD I<options...>
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
36 The command prints the data on the standard output in JSON data format.
44 [Mandatory] Defines the datasouerce tree.
49 [Mandatory] Defines the action command. The following commands are supported:
55 Prints information about the nodeid. Requires B<--nodeid>.
59 Performs a prefix or substring search on node IDs and prints the results.
60 Requires B<--prefix> or B<--substring>.
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.
71 =item B<--nodeid=NODEID>
73 Specifies the Node ID string for the commands I<info> and I<render>.
78 Toggles verbose output for the commands I<info> and I<search>.
83 Specifies the prefix search string for the command I<search>.
86 =item B<--substring=STR>
88 Specifies the search substring for the command I<search>.
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>.
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
109 Displays a help message.
116 L<torrus(@mansec_usercmd@)>
120 See more documentation at Torrus home page: http://torrus.org
124 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>