big spell checking patch -- slif@bellsouth.net
[rrdtool.git] / doc / rrddump.pod
1 =head1 NAME
2
3 rrdtool dump - dump the contents of an B<RRD> to XML format
4
5 =for html <div align="right"><a href="rrddump.pdf">PDF</a> version.</div>
6
7 =head1 SYNOPSIS
8
9 B<rrdtool> B<dump> I<filename.rrd> E<gt> I<filename.xml> 
10
11 =head1 DESCRIPTION
12
13 The B<dump> function prints the contents of an B<RRD> in human
14 readable (?) XML format. This format can be read by rrdrestore.
15 Together they allow you to transfer your files from one architecture
16 to another as well as manipulating the contents of an B<RRD> file in a
17 somewhat more convenient manner.
18
19
20
21 =over 8
22
23 =item I<filename.rrd>
24
25 The name of the B<RRD> you want to dump.
26
27 =back
28
29 =head1 EXAMPLES
30
31 To transfer an RRD between architectures, follow these steps:
32
33 =over 4
34
35 =item 1.
36
37 On the same system where the RRD was created, use B<rrdtool> B<dump>
38 to export the data to XML format.
39
40 =item 2. 
41
42 Transfer the XML dump to the target system
43
44 =item 3.
45
46 Run B<rrdtool> B<restore> to create a new RRD from the XML dump.  See
47 B<rrdrestore> for details.
48
49 =back
50
51 =head1 AUTHOR
52
53 Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
54