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 f1e653f..c26d31b 100644 (file)
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -2,20 +2,27 @@
 
 rrddump - dump the contents of an RRD to XML format
 
-=for html <div align="right"><a href="rrddump.pdf">PDF</a> version.</div>
-
 =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>>
 
-=head1 DESCRIPTION
+or 
 
-The B<dump> function prints the contents of an B<RRD> in human
-readable (?) XML format. This format can be read by rrdrestore.
-Together they allow you to transfer your files from one architecture
-to another as well as manipulating the contents of an B<RRD> file in a
-somewhat more convenient manner.
+B<rrdtool> B<dump> I<filename.rrd> I<filename.xml>
+S<[B<--no-header>|B<-n>]>
+S<[B<--daemon> I<address>]>
 
+=head1 DESCRIPTION
+
+The B<dump> function writes the contents of an B<RRD> in human
+readable (?) XML format to a file or to stdout. This format can
+be read by rrdrestore. Together they allow you to transfer your
+files from one computer architecture to another as well to
+manipulate the contents of an B<RRD> file in a somewhat more
+convenient manner.
 
 
 =over 8
@@ -24,6 +31,27 @@ somewhat more convenient manner.
 
 The name of the B<RRD> you want to dump.
 
+=item I<filename.xml>
+
+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
@@ -37,18 +65,33 @@ To transfer an RRD between architectures, follow these steps:
 On the same system where the RRD was created, use B<rrdtool> B<dump>
 to export the data to XML format.
 
-=item 2. 
+=item 2.
 
-Transfer the XML dump to the target system
+Transfer the XML dump to the target system.
 
 =item 3.
 
-Run B<rrdtool> B<restore> to create a new RRD from the XML dump.  See
+Run B<rrdtool> B<restore> to create a new RRD from the XML dump. See
 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>oetiker@ee.ethz.chE<gt>
+Tobias Oetiker E<lt>tobi@oetiker.chE<gt>