From: Florian Forster <octo@leeloo.home.verplant.org>
Date: Tue, 15 Jul 2008 18:05:11 +0000 (+0200)
Subject: rrddump(1): Document the new `--daemon' option.
X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=commitdiff_plain;h=9f989b1cb659d98016404f9f594e9f1643909982

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

diff --git a/doc/rrddump.pod b/doc/rrddump.pod
index a698d84..f48a6d4 100644
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -4,11 +4,16 @@ rrddump - dump the contents of an RRD to XML format
 
 =head1 SYNOPSIS
 
-B<rrdtool> B<dump> S<[B<--no-header>|B<-n>]> I<filename.rrd> E<gt> I<filename.xml>
+B<rrdtool> B<dump> I<filename.rrd>
+S<[B<--no-header>|B<-n>]>
+S<[B<--daemon> I<address>]>
+S<E<gt> I<filename.xml>>
 
 or 
 
-B<rrdtool> B<dump> S<[B<--no-header>|B<-n>]> I<filename.rrd> I<filename.xml>
+B<rrdtool> B<dump> I<filename.rrd> I<filename.xml>
+S<[B<--no-header>|B<-n>]>
+S<[B<--daemon> I<address>]>
 
 =head1 DESCRIPTION
 
@@ -31,13 +36,24 @@ The name of the B<RRD> you want to dump.
 The (optional) filename that you want to write the XML output to.
 If not specified, the XML will be printed to stdout.
 
-=item S<[B<--no-header>|B<-n>]>
+=item B<--no-header>|B<-n>
 
 In rrdtool 1.3, the dump function started producing correct xml-headers.
 Unfortunately the rrdtool restore function from the 1.2 series can not
 handle these headers. With this option you can supress the creatinon of
 the xml headers.
 
+=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 dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+
 =back
 
 =head1 EXAMPLES
@@ -62,6 +78,21 @@ B<rrdrestore> for details.
 
 =back
 
+=head1 ENVIRONMENT VARIABLES
+
+The following environment variables may be used to change the behavior of
+C<rrdtoolE<nbsp>dump>:
+
+=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
 
 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>