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 89e378b..f822e8e 100644 (file)
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -4,17 +4,12 @@ rrddump - dump the contents of an RRD to XML format
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<rrdtool> B<dump> I<filename.rrd>
-S<[B<--no-header>|B<-n>]>
+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>>
 
 S<[B<--daemon> I<address>]>
 S<E<gt> 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
 
 The B<dump> function writes the contents of an B<RRD> in human
 =head1 DESCRIPTION
 
 The B<dump> function writes the contents of an B<RRD> in human


@@ -24,7 +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.
 
 manipulate the contents of an B<RRD> file in a somewhat more
 convenient manner.
 

-

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


@@ -36,21 +30,25 @@ 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>
+=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>.

 
 

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