X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdinfo.pod;h=2af411a5595a61694c233288e383d2525ec3a21d;hb=e2d66d6782fe88a3900908c76b3a6fd7affbaea0;hp=08f8633f4a805a52f2c34710edfdeef41ef73f34;hpb=ca6179e6c82724063f16403815aba140604bd59f;p=rrdtool.git

diff --git a/doc/rrdinfo.pod b/doc/rrdinfo.pod
index 08f8633..2af411a 100644
--- a/doc/rrdinfo.pod
+++ b/doc/rrdinfo.pod
@@ -1,10 +1,11 @@
 =head1 NAME
 
-rrdinfo - Extract header information from an RRD
+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
 
@@ -14,13 +15,32 @@ a parsing friendly format.
 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. To
+specify a UNIX domain socket use the prefix C<unix:>, see example below. Other
+addresses are interpreted as normal network addresses, i.E<nbsp>e. IPv4 or IPv6
+addresses in most cases.
+
+ 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
 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
+has neither minimum nor maximum values defined for either of its
 data sources.
 
  filename = "random.rrd"
@@ -48,15 +68,22 @@ data sources.
  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>