From: Florian Forster <octo@verplant.org>
Date: Wed, 2 Jul 2008 19:52:52 +0000 (+0200)
Subject: rrdxport(1): Document the new `--daemon' option.
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;ds=sidebyside;h=5db3db77a2e30fbb4b7e6f7f24babb75ebdc9c9b;hp=7dec93900504d48edecc2e0a93b4b8f5949d0331;p=rrdtool.git

rrdxport(1): Document the new `--daemon' option.
---

diff --git a/doc/rrdxport.pod b/doc/rrdxport.pod
index a668a20..dd604d3 100644
--- a/doc/rrdxport.pod
+++ b/doc/rrdxport.pod
@@ -48,6 +48,17 @@ for details.
 
 See L<rrdgraph> documentation.
 
+=item B<--daemon> I<address>
+
+Address of the L<rrdcached(1)> 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 xport --daemon unix:/var/run/rrdcached.sock ...
+
 =item B<--enumds> 
 
 The generated xml should contain the data values in enumerated tags.
@@ -137,6 +148,20 @@ The resulting data section is:
           XPORT:out2:"if2 out bytes" \
 	  XPORT:sum:"output sum"
 
+=head1 ENVIRONMENT VARIABLES
+
+The following environment variables may be used to change the behavior of
+C<rrdtoolE<nbsp>xport>:
+
+=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
 
 =head1 AUTHOR