fixed strerror_r usage ... #85
[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 or 
10
11 B<rrdtool> B<dump> I<filename.rrd> I<filename.xml>
12
13 =head1 DESCRIPTION
14
15 The B<dump> function writes the contents of an B<RRD> in human
16 readable (?) XML format to a file or to stdout. This format can
17 be read by rrdrestore. Together they allow you to transfer your
18 files from one computer architecture to another as well to
19 manipulate the contents of an B<RRD> file in a somewhat more
20 convenient manner.
21
22
23
24 =over 8
25
26 =item I<filename.rrd>
27
28 The name of the B<RRD> you want to dump.
29
30 =item I<filename.xml>
31
32 The (optional) filename that you want to write the XML output to.
33 If not specified, the XML will be printed to stdout.
34
35 =back
36
37 =head1 EXAMPLES
38
39 To transfer an RRD between architectures, follow these steps:
40
41 =over 4
42
43 =item 1.
44
45 On the same system where the RRD was created, use B<rrdtool> B<dump>
46 to export the data to XML format.
47
48 =item 2.
49
50 Transfer the XML dump to the target system.
51
52 =item 3.
53
54 Run B<rrdtool> B<restore> to create a new RRD from the XML dump. See
55 B<rrdrestore> for details.
56
57 =back
58
59 =head1 AUTHOR
60
61 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
62