This patch introduces a feature whereby rrdcached will disallow updates

[rrdtool.git] / doc / rrddump.pod

diff --git a/doc/rrddump.pod b/doc/rrddump.pod
index aa2a7e7..c26d31b 100644 (file)
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -4,11 +4,16 @@ rrddump - dump the contents of an RRD to XML format
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<rrdtool> B<dump> 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> I<filename.rrd> I<filename.xml>
 
 or 
 
 B<rrdtool> B<dump> I<filename.rrd> I<filename.xml>

+S<[B<--no-header>|B<-n>]>
+S<[B<--daemon> I<address>]>

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -20,7 +25,6 @@ manipulate the contents of an B<RRD> file in a somewhat more
 convenient manner.
 
 
 convenient manner.
 
 

-

 =over 8
 
 =item I<filename.rrd>
 =over 8
 
 =item I<filename.rrd>


@@ -32,6 +36,22 @@ 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.
 
 The (optional) filename that you want to write the XML output to.
 If not specified, the XML will be printed to stdout.
 

+=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> 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 dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+

 =back
 
 =head1 EXAMPLES
 =back
 
 =head1 EXAMPLES


@@ -56,7 +76,22 @@ B<rrdrestore> for details.
 
 =back
 
 
 =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
 
 =head1 AUTHOR
 

-Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+Tobias Oetiker E<lt>tobi@oetiker.chE<gt>