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>
   9
  10 <body style="background-color: white">
  11
  12
  13 <!-- INDEX BEGIN -->
  14 <div name="index">
  15 <p><a name="__index__"></a></p>
  16 <!--
  17
  18 <ul>
  19
  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="#environment_variables">ENVIRONMENT VARIABLES</a></li>
  25         <li><a href="#author">AUTHOR</a></li>
  26 </ul>
  27
  28 -->
  29
  30
  31 </div>
  32 <!-- INDEX END -->
  33
  34 <p>
  35 </p>
  36 <h1><a name="name">NAME</a></h1>
  37 <p>rrddump - dump the contents of an RRD to XML format</p>
  38 <p>
  39 </p>
  40 <hr />
  41 <h1><a name="synopsis">SYNOPSIS</a></h1>
  42 <p><strong>rrdtool</strong> <strong>dump</strong> <em>filename.rrd</em> [<em>filename.xml</em>]
  43 [<strong>--header</strong>|<strong>-h</strong>&nbsp;{none,xsd,dtd}]
  44 [<strong>--no-header</strong>]
  45 [<strong>--daemon</strong>&nbsp;<em>address</em>]
  46 &gt;&nbsp;<em>filename.xml</em></p>
  47 <p>
  48 </p>
  49 <hr />
  50 <h1><a name="description">DESCRIPTION</a></h1>
  51 <p>The <strong>dump</strong> function writes the contents of an <strong>RRD</strong> in human
  52 readable (?) XML format to a file or to stdout. This format can
  53 be read by rrdrestore. Together they allow you to transfer your
  54 files from one computer architecture to another as well to
  55 manipulate the contents of an <strong>RRD</strong> file in a somewhat more
  56 convenient manner.</p>
  57 <dl>
  58 <dt><strong><a name="filename_rrd" class="item"><em>filename.rrd</em></a></strong></dt>
  59
  60 <dd>
  61 <p>The name of the <strong>RRD</strong> you want to dump.</p>
  62 </dd>
  63 <dt><strong><a name="filename_xml" class="item"><em>filename.xml</em></a></strong></dt>
  64
  65 <dd>
  66 <p>The (optional) filename that you want to write the XML output to.
  67 If not specified, the XML will be printed to stdout.</p>
  68 </dd>
  69 <dt><strong><a name="header_h_none_xsd_dtd" class="item"><strong>--header</strong>|<strong>-h</strong> {none,xsd,dtd}</a></strong></dt>
  70
  71 <dd>
  72 <p>By default rrdtool will add a dtd header to the xml file. Here
  73 you can customize this to and xsd header or no header at all.</p>
  74 </dd>
  75 <dt><strong><a name="no_header" class="item"><strong>--no-header</strong></a></strong></dt>
  76
  77 <dd>
  78 <p>A shortcut for --header=none.</p>
  79 <p>If you want to restore the dump with rrdtool 1.2 you should use the
  80 --no-header option since 1.2 can not deal with xml headers.</p>
  81 </dd>
  82 <dt><strong><a name="daemon_address" class="item"><strong>--daemon</strong> <em>address</em></a></strong></dt>
  83
  84 <dd>
  85 <p>Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If specified, a <code>flush</code> command is sent
  86 to the server before reading the RRD files. This allows <strong>rrdtool</strong> to return
  87 fresh data even if the daemon is configured to cache values for a long time.
  88 For a list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.</p>
  89 <pre>
  90  rrdtool dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
  91 </dd>
  92 </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>
 100 <p>On the same system where the RRD was created, use <strong>rrdtool</strong> <strong>dump</strong>
 101 to export the data to XML format.</p>
 102 </li>
 103 <li>
 104 <p>Transfer the XML dump to the target system.</p>
 105 </li>
 106 <li>
 107 <p>Run <strong>rrdtool</strong> <strong>restore</strong> to create a new RRD from the XML dump. See
 108 <strong>rrdrestore</strong> for details.</p>
 109 </li>
 110 </ol>
 111 <p>
 112 </p>
 113 <hr />
 114 <h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
 115 <p>The following environment variables may be used to change the behavior of
 116 <code>rrdtooldump</code>:</p>
 117 <dl>
 118 <dt><strong><a name="rrdcached_address" class="item"><strong>RRDCACHED_ADDRESS</strong></a></strong></dt>
 119
 120 <dd>
 121 <p>If this environment variable is set it will have the same effect as specifying
 122 the <code>--daemon</code> option on the command line. If both are present, the command
 123 line argument takes precedence.</p>
 124 </dd>
 125 </dl>
 126 <p>
 127 </p>
 128 <hr />
 129 <h1><a name="author">AUTHOR</a></h1>
 130 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 131
 132 </body>
 133
 134 </html>