rrdtool dump is now backward compatible with rrdtool 1.3 dump again. Default is ...

[rrdtool.git] / doc / rrddump.pod

diff --git a/doc/rrddump.pod b/doc/rrddump.pod
index 2e4cd4b..f822e8e 100644 (file)
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -4,11 +4,11 @@ rrddump - dump the contents of an RRD to XML format
 
 =head1 SYNOPSIS
 
-B<rrdtool> B<dump> I<filename.rrd> E<gt> I<filename.xml>
-
-or 
-
-B<rrdtool> B<dump> I<filename.rrd> I<filename.xml>
+B<rrdtool> B<dump> I<filename.rrd> [I<filename.xml>]
+S<[B<--header>|B<-h> {none,xsd,dtd}]>
+S<[B<--no-header>]>
+S<[B<--daemon> I<address>]>
+S<E<gt> I<filename.xml>>
 
 =head1 DESCRIPTION
 
@@ -19,8 +19,6 @@ 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
 
 =item I<filename.rrd>
@@ -32,6 +30,28 @@ 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 B<--header>|B<-h> {none,xsd,dtd}
+
+By default rrdtool will add a dtd header to the xml file. Here
+you can customize this to and xsd header or no header at all.
+
+
+=item B<--no-header>
+
+A shortcut for S<--header=none>.
+
+If you want to restore the dump with rrdtool 1.2 you should use the
+S<--no-header> option since 1.2 can not deal with 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
@@ -56,6 +76,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>