Code

10818075b466d5f47445f846abfce5d83989d4ab
[pkg-rrdtool.git] / doc / rrddump.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <title>rrddump</title>
5 <link rev="made" href="mailto:root@localhost" />
6 </head>
8 <body style="background-color: white">
10 <p><a name="__index__"></a></p>
11 <!-- INDEX BEGIN -->
12 <!--
14 <ul>
16         <li><a href="#name">NAME</a></li>
17         <li><a href="#synopsis">SYNOPSIS</a></li>
18         <li><a href="#description">DESCRIPTION</a></li>
19         <li><a href="#examples">EXAMPLES</a></li>
20         <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
21         <li><a href="#author">AUTHOR</a></li>
22 </ul>
23 -->
24 <!-- INDEX END -->
26 <p>
27 </p>
28 <h1><a name="name">NAME</a></h1>
29 <p>rrddump - dump the contents of an RRD to XML format</p>
30 <p>
31 </p>
32 <hr />
33 <h1><a name="synopsis">SYNOPSIS</a></h1>
34 <p><strong>rrdtool</strong> <strong>dump</strong> <em>filename.rrd</em> [<em>filename.xml</em>]
35 [<strong>--header</strong>|<strong>-h</strong>&nbsp;{none,xsd,dtd}]
36 [<strong>--no-header</strong>]
37 [<strong>--daemon</strong>&nbsp;<em>address</em>]
38 &gt;&nbsp;<em>filename.xml</em></p>
39 <p>
40 </p>
41 <hr />
42 <h1><a name="description">DESCRIPTION</a></h1>
43 <p>The <strong>dump</strong> function writes the contents of an <strong>RRD</strong> in human
44 readable (?) XML format to a file or to stdout. This format can
45 be read by rrdrestore. Together they allow you to transfer your
46 files from one computer architecture to another as well to
47 manipulate the contents of an <strong>RRD</strong> file in a somewhat more
48 convenient manner.</p>
49 <dl>
50 <dt><strong><a name="item_filename_2errd"><em>filename.rrd</em></a></strong><br />
51 </dt>
52 <dd>
53 The name of the <strong>RRD</strong> you want to dump.
54 </dd>
55 <p></p>
56 <dt><strong><a name="item_filename_2exml"><em>filename.xml</em></a></strong><br />
57 </dt>
58 <dd>
59 The (optional) filename that you want to write the XML output to.
60 If not specified, the XML will be printed to stdout.
61 </dd>
62 <p></p>
63 <dt><strong><a name="item__2d_2dheader_7c_2dh__7bnone_2cxsd_2cdtd_7d"><strong>--header</strong>|<strong>-h</strong> {none,xsd,dtd}</a></strong><br />
64 </dt>
65 <dd>
66 By default rrdtool will add a dtd header to the xml file. Here
67 you can customize this to and xsd header or no header at all.
68 </dd>
69 <p></p>
70 <dt><strong><a name="item__2d_2dno_2dheader"><strong>--no-header</strong></a></strong><br />
71 </dt>
72 <dd>
73 A shortcut for --header=none.
74 </dd>
75 <dd>
76 <p>If you want to restore the dump with rrdtool 1.2 you should use the
77 --no-header option since 1.2 can not deal with xml headers.</p>
78 </dd>
79 <p></p>
80 <dt><strong><a name="item__2d_2ddaemon_address"><strong>--daemon</strong> <em>address</em></a></strong><br />
81 </dt>
82 <dd>
83 Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If specified, a <code>flush</code> command is sent
84 to the server before reading the RRD files. This allows <strong>rrdtool</strong> to return
85 fresh data even if the daemon is configured to cache values for a long time.
86 For a list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.
87 </dd>
88 <dd>
89 <pre>
90  rrdtool dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
91 </dd>
92 <p></p></dl>
93 <p>
94 </p>
95 <hr />
96 <h1><a name="examples">EXAMPLES</a></h1>
97 <p>To transfer an RRD between architectures, follow these steps:</p>
98 <ol>
99 <li></li>
100 On the same system where the RRD was created, use <strong>rrdtool</strong> <strong>dump</strong>
101 to export the data to XML format.
102 <p></p>
103 <li></li>
104 Transfer the XML dump to the target system.
105 <p></p>
106 <li></li>
107 Run <strong>rrdtool</strong> <strong>restore</strong> to create a new RRD from the XML dump. See
108 <strong>rrdrestore</strong> for details.
109 <p></p></ol>
110 <p>
111 </p>
112 <hr />
113 <h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
114 <p>The following environment variables may be used to change the behavior of
115 <code>rrdtooldump</code>:</p>
116 <dl>
117 <dt><strong><a name="item_rrdcached_address"><strong>RRDCACHED_ADDRESS</strong></a></strong><br />
118 </dt>
119 <dd>
120 If this environment variable is set it will have the same effect as specifying
121 the <code>--daemon</code> option on the command line. If both are present, the command
122 line argument takes precedence.
123 </dd>
124 <p></p></dl>
125 <p>
126 </p>
127 <hr />
128 <h1><a name="author">AUTHOR</a></h1>
129 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
131 </body>
133 </html>