Code

Imported upstream version 1.3.8.
[pkg-rrdtool.git] / doc / rrddump.html
1 <?xml version="1.0" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <title>rrddump</title>
6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
7 <link rev="made" href="mailto:root@localhost" />
8 </head>
10 <body style="background-color: white">
13 <!-- INDEX BEGIN -->
14 <div name="index">
15 <p><a name="__index__"></a></p>
16 <!--
18 <ul>
20         <li><a href="#name">NAME</a></li>
21         <li><a href="#synopsis">SYNOPSIS</a></li>
22         <li><a href="#description">DESCRIPTION</a></li>
23         <li><a href="#examples">EXAMPLES</a></li>
24         <li><a href="#author">AUTHOR</a></li>
25 </ul>
27 -->
30 </div>
31 <!-- INDEX END -->
33 <p>
34 </p>
35 <h1><a name="name">NAME</a></h1>
36 <p>rrddump - dump the contents of an RRD to XML format</p>
37 <p>
38 </p>
39 <hr />
40 <h1><a name="synopsis">SYNOPSIS</a></h1>
41 <p><strong>rrdtool</strong> <strong>dump</strong> [<strong>--no-header</strong>|<strong>-n</strong>] <em>filename.rrd</em> &gt; <em>filename.xml</em></p>
42 <p>or</p>
43 <p><strong>rrdtool</strong> <strong>dump</strong> [<strong>--no-header</strong>|<strong>-n</strong>] <em>filename.rrd</em> <em>filename.xml</em></p>
44 <p>
45 </p>
46 <hr />
47 <h1><a name="description">DESCRIPTION</a></h1>
48 <p>The <strong>dump</strong> function writes the contents of an <strong>RRD</strong> in human
49 readable (?) XML format to a file or to stdout. This format can
50 be read by rrdrestore. Together they allow you to transfer your
51 files from one computer architecture to another as well to
52 manipulate the contents of an <strong>RRD</strong> file in a somewhat more
53 convenient manner.</p>
54 <dl>
55 <dt><strong><a name="filename_rrd" class="item"><em>filename.rrd</em></a></strong></dt>
57 <dd>
58 <p>The name of the <strong>RRD</strong> you want to dump.</p>
59 </dd>
60 <dt><strong><a name="filename_xml" class="item"><em>filename.xml</em></a></strong></dt>
62 <dd>
63 <p>The (optional) filename that you want to write the XML output to.
64 If not specified, the XML will be printed to stdout.</p>
65 </dd>
66 <dt><strong><a name="no_header_n" class="item">[<strong>--no-header</strong>|<strong>-n</strong>]</a></strong></dt>
68 <dd>
69 <p>In rrdtool 1.3, the dump function started producing correct xml-headers.
70 Unfortunately the rrdtool restore function from the 1.2 series can not
71 handle these headers. With this option you can supress the creatinon of
72 the xml headers.</p>
73 </dd>
74 </dl>
75 <p>
76 </p>
77 <hr />
78 <h1><a name="examples">EXAMPLES</a></h1>
79 <p>To transfer an RRD between architectures, follow these steps:</p>
80 <ol>
81 <li>
82 <p>On the same system where the RRD was created, use <strong>rrdtool</strong> <strong>dump</strong>
83 to export the data to XML format.</p>
84 </li>
85 <li>
86 <p>Transfer the XML dump to the target system.</p>
87 </li>
88 <li>
89 <p>Run <strong>rrdtool</strong> <strong>restore</strong> to create a new RRD from the XML dump. See
90 <strong>rrdrestore</strong> for details.</p>
91 </li>
92 </ol>
93 <p>
94 </p>
95 <hr />
96 <h1><a name="author">AUTHOR</a></h1>
97 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
99 </body>
101 </html>