X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrddump.pod;h=a698d841eaa5387580fa9000e0c43020eab8de84;hb=4d750c3e02acd806f8db83b4737afac2110cfa0f;hp=d07ea19bae329db355e9936d456f502cdeafdb02;hpb=5837606887a6d81e8b1f7588525cb1c8783fb62b;p=rrdtool.git

diff --git a/doc/rrddump.pod b/doc/rrddump.pod
index d07ea19..a698d84 100644
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -1,21 +1,23 @@
 =head1 NAME
 
-rrdtool dump - dump the contents of an B<RRD> to XML format
-
-=for html <div align="right"><a href="rrddump.pdf">PDF</a> version.</div>
+rrddump - dump the contents of an RRD to XML format
 
 =head1 SYNOPSIS
 
-B<rrdtool> B<dump> I<filename.rrd> E<gt> I<filename.xml> 
+B<rrdtool> B<dump> S<[B<--no-header>|B<-n>]> I<filename.rrd> 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> S<[B<--no-header>|B<-n>]> I<filename.rrd> I<filename.xml>
 
+=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,9 +26,43 @@ 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 S<[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.
+
+=back
+
+=head1 EXAMPLES
+
+To transfer an RRD between architectures, follow these steps:
+
+=over 4
+
+=item 1.
+
+On the same system where the RRD was created, use B<rrdtool> B<dump>
+to export the data to XML format.
+
+=item 2.
+
+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
+B<rrdrestore> for details.
+
 =back
 
 =head1 AUTHOR
 
-Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+Tobias Oetiker E<lt>tobi@oetiker.chE<gt>