Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrddump.html
index ba6e9619078a498a4528160300f00f7ebf74dcea..10818075b466d5f47445f846abfce5d83989d4ab 100644 (file)
@@ -1,18 +1,14 @@
-<?xml version="1.0" ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <title>rrddump</title>
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
 <link rev="made" href="mailto:root@localhost" />
 </head>
 
 <body style="background-color: white">
 
-
-<!-- INDEX BEGIN -->
-<div name="index">
 <p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
 <!--
 
 <ul>
        <li><a href="#synopsis">SYNOPSIS</a></li>
        <li><a href="#description">DESCRIPTION</a></li>
        <li><a href="#examples">EXAMPLES</a></li>
+       <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
        <li><a href="#author">AUTHOR</a></li>
 </ul>
-
 -->
-
-
-</div>
 <!-- INDEX END -->
 
 <p>
 </p>
 <hr />
 <h1><a name="synopsis">SYNOPSIS</a></h1>
-<p><strong>rrdtool</strong> <strong>dump</strong> [<strong>--no-header</strong>|<strong>-n</strong>] <em>filename.rrd</em> &gt; <em>filename.xml</em></p>
-<p>or</p>
-<p><strong>rrdtool</strong> <strong>dump</strong> [<strong>--no-header</strong>|<strong>-n</strong>] <em>filename.rrd</em> <em>filename.xml</em></p>
+<p><strong>rrdtool</strong> <strong>dump</strong> <em>filename.rrd</em> [<em>filename.xml</em>]
+[<strong>--header</strong>|<strong>-h</strong>&nbsp;{none,xsd,dtd}]
+[<strong>--no-header</strong>]
+[<strong>--daemon</strong>&nbsp;<em>address</em>]
+&gt;&nbsp;<em>filename.xml</em></p>
 <p>
 </p>
 <hr />
@@ -52,44 +47,81 @@ files from one computer architecture to another as well to
 manipulate the contents of an <strong>RRD</strong> file in a somewhat more
 convenient manner.</p>
 <dl>
-<dt><strong><a name="filename_rrd" class="item"><em>filename.rrd</em></a></strong></dt>
-
+<dt><strong><a name="item_filename_2errd"><em>filename.rrd</em></a></strong><br />
+</dt>
 <dd>
-<p>The name of the <strong>RRD</strong> you want to dump.</p>
+The name of the <strong>RRD</strong> you want to dump.
 </dd>
-<dt><strong><a name="filename_xml" class="item"><em>filename.xml</em></a></strong></dt>
-
+<p></p>
+<dt><strong><a name="item_filename_2exml"><em>filename.xml</em></a></strong><br />
+</dt>
 <dd>
-<p>The (optional) filename that you want to write the XML output to.
-If not specified, the XML will be printed to stdout.</p>
+The (optional) filename that you want to write the XML output to.
+If not specified, the XML will be printed to stdout.
 </dd>
-<dt><strong><a name="no_header_n" class="item">[<strong>--no-header</strong>|<strong>-n</strong>]</a></strong></dt>
-
+<p></p>
+<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 />
+</dt>
 <dd>
-<p>In rrdtool 1.3, the dump function started producing correct xml-headers.
-Unfortunately the rrdtool restore function from the 1.2 series can not
-handle these headers. With this option you can supress the creatinon of
-the xml headers.</p>
+By default rrdtool will add a dtd header to the xml file. Here
+you can customize this to and xsd header or no header at all.
 </dd>
-</dl>
+<p></p>
+<dt><strong><a name="item__2d_2dno_2dheader"><strong>--no-header</strong></a></strong><br />
+</dt>
+<dd>
+A shortcut for --header=none.
+</dd>
+<dd>
+<p>If you want to restore the dump with rrdtool 1.2 you should use the
+--no-header option since 1.2 can not deal with xml headers.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2ddaemon_address"><strong>--daemon</strong> <em>address</em></a></strong><br />
+</dt>
+<dd>
+Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If specified, a <code>flush</code> command is sent
+to the server before reading the RRD files. This allows <strong>rrdtool</strong> to return
+fresh data even if the daemon is configured to cache values for a long time.
+For a list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.
+</dd>
+<dd>
+<pre>
+ rrdtool dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
+</dd>
+<p></p></dl>
 <p>
 </p>
 <hr />
 <h1><a name="examples">EXAMPLES</a></h1>
 <p>To transfer an RRD between architectures, follow these steps:</p>
 <ol>
-<li>
-<p>On the same system where the RRD was created, use <strong>rrdtool</strong> <strong>dump</strong>
-to export the data to XML format.</p>
-</li>
-<li>
-<p>Transfer the XML dump to the target system.</p>
-</li>
-<li>
-<p>Run <strong>rrdtool</strong> <strong>restore</strong> to create a new RRD from the XML dump. See
-<strong>rrdrestore</strong> for details.</p>
-</li>
-</ol>
+<li></li>
+On the same system where the RRD was created, use <strong>rrdtool</strong> <strong>dump</strong>
+to export the data to XML format.
+<p></p>
+<li></li>
+Transfer the XML dump to the target system.
+<p></p>
+<li></li>
+Run <strong>rrdtool</strong> <strong>restore</strong> to create a new RRD from the XML dump. See
+<strong>rrdrestore</strong> for details.
+<p></p></ol>
+<p>
+</p>
+<hr />
+<h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
+<p>The following environment variables may be used to change the behavior of
+<code>rrdtooldump</code>:</p>
+<dl>
+<dt><strong><a name="item_rrdcached_address"><strong>RRDCACHED_ADDRESS</strong></a></strong><br />
+</dt>
+<dd>
+If this environment variable is set it will have the same effect as specifying
+the <code>--daemon</code> option on the command line. If both are present, the command
+line argument takes precedence.
+</dd>
+<p></p></dl>
 <p>
 </p>
 <hr />