X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrddump.pod;h=f822e8e5efb81c5368b44ce36cfbf2006eaef09f;hb=688e28761c377cae99630846f68adaca3008ad56;hp=f1e653f7164e7b63553337ab18b864b557844ec1;hpb=d50afc217aaec57e418a55bbe2d20fe996c6e026;p=rrdtool.git
diff --git a/doc/rrddump.pod b/doc/rrddump.pod
index f1e653f..f822e8e 100644
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -2,21 +2,22 @@
rrddump - dump the contents of an RRD to XML format
-=for html
-
=head1 SYNOPSIS
-B B I E I
+B B I [I]
+S<[B<--header>|B<-h> {none,xsd,dtd}]>
+S<[B<--no-header>]>
+S<[B<--daemon> I]>
+S I>
=head1 DESCRIPTION
-The B function prints the contents of an B 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 file in a
-somewhat more convenient manner.
-
-
+The B function writes the contents of an B 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 file in a somewhat more
+convenient manner.
=over 8
@@ -24,6 +25,33 @@ somewhat more convenient manner.
The name of the B you want to dump.
+=item I
+
+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 of the L daemon. If specified, a C command is sent
+to the server before reading the RRD files. This allows B 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 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 B
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 B to create a new RRD from the XML dump. See
+Run B B to create a new RRD from the XML dump. See
B for details.
=back
+=head1 ENVIRONMENT VARIABLES
+
+The following environment variables may be used to change the behavior of
+Cdump>:
+
+=over 4
+
+=item B
+
+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 Eoetiker@ee.ethz.chE
+Tobias Oetiker Etobi@oetiker.chE