fix wording for min/max ... they are not optional
[rrdtool.git] / doc / rrddump.pod
index d07ea19..f0b446a 100644 (file)
@@ -1,8 +1,6 @@
 =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
 
@@ -12,8 +10,8 @@ B<rrdtool> B<dump> I<filename.rrd> E<gt> I<filename.xml>
 
 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
+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.
 
 
@@ -26,6 +24,28 @@ The name of the B<RRD> you want to dump.
 
 =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>