diff --git a/doc/rrdinfo.pod b/doc/rrdinfo.pod
index e83d8d6138279af4e4fbd9eb4b38b494357a3e9e..d147756c90be9e873c81983cd835b063f14dfa26 100644 (file)
--- a/doc/rrdinfo.pod
+++ b/doc/rrdinfo.pod
=head1 SYNOPSIS
-B<rrdtool> B<info> I<filename.rrd>
+B<rrdtool> B<info> I<filename>
+S<[B<--daemon> I<address>]>
=head1 DESCRIPTION
Check L<rrdcreate> if you are uncertain about the meaning of the
individual keys.
+=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
+
+=back
+
=head1 EXAMPLE
This is the output generated by running B<info> on a simple RRD which
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
-=item I<filename.rrd>
+The following environment variables may be used to change the behavior of
+C<rrdtoolE<nbsp>info>:
-The name of the B<RRD> you want to examine.
+=over 4
+
+=item B<RRDCACHED_ADDRESS>
+
+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