index 98d7ba994d23419ea521c17edaa59b41fdea2654..1752b69366265b9e9111c0811302136c928830a3 100644 (file)
--- a/program/doc/rrdinfo.pod
+++ b/program/doc/rrdinfo.pod
=head1 NAME
-rrdtool info - extract header information from an rrd
-
-=for html <div align="right"><a href="rrdinfo.pdf">PDF</a> version.</div>
+rrdinfo - extract header information from an RRD
=head1 SYNOPSIS
-B<rrdtool> B<info> I<filename.rrd>
+B<rrdtool> B<info> I<filename>
+S<[B<--daemon> I<address>]>
=head1 DESCRIPTION
-The B<info> function prints the header information from an rrd in
+The B<info> function prints the header information from an RRD in
a parsing friendly format.
Check L<rrdcreate> if you are uncertain about the meaning of the
individual keys.
-The B<info> function will always report the true version of the B<RRD>;
-unlike B<dump> which will generate a current version (0002) xml dump for
-older version (0001) files (although the version of the B<RRD> is unchanged).
+=over 8
+
+=item I<filename>
+
+The name of the B<RRD> you want to examine.
+
+=item B<--daemon> I<address>
+
+Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
+to the server before reading the RRD files. This allows B<rrdtool> to return
+fresh data even if the daemon is configured to cache values for a long time.
+For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
+
+ rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+
+=item B<--noflush>
+
+Omit the C<flush> command usually sent to the daemon prior to retrieving the
+data. If all you are interested in the the RRD Structure, and not the last update
+time or current values, then this will improve efficiency.
+
+=back
=head1 EXAMPLE
-This is the output generated by running B<info> on a simple rrd which
-contains two datasources and one rra. Note that the number after the
+This is the output generated by running B<info> on a simple RRD which
+contains two data sources and one RRA. Note that the number after the
I<last_update> keyword is in seconds since 1970. The string B<NaN>
-stands for I<*UNKNOWN*> data. In the example it means that this rrd
-has neither minimum not maximum values defined for either of its
-datasources.
+stands for I<*UNKNOWN*> data. In the example it means that this RRD
+has neither minimum nor maximum values defined for either of its
+data sources.
- filename = "randome.rrd"
+ filename = "random.rrd"
rrd_version = "0001"
step = 300
last_update = 955892996
+ header_size = 2872
ds[a].type = "GAUGE"
ds[a].minimal_heartbeat = 600
ds[a].min = NaN
rra[0].cdp_prep[1].value = nan
rra[0].cdp_prep[1].unknown_datapoints = 0
-=over 8
+=head1 ENVIRONMENT VARIABLES
+
+The following environment variables may be used to change the behavior of
+C<rrdtoolE<nbsp>info>:
+
+=over 4
-=item I<filename.rrd>
+=item B<RRDCACHED_ADDRESS>
-The name of the B<RRD> you want to dump.
+If this environment variable is set it will have the same effect as specifying
+the C<--daemon> option on the command line. If both are present, the command
+line argument takes precedence.
=back
=head1 AUTHOR
-Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+Tobias Oetiker E<lt>tobi@oetiker.chE<gt>