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