← Back to branch summary

~ubuntu-branches/ubuntu/maverick/rrdtool/maverick

« back to all changes in this revision

Viewing changes to doc/rrddump.html

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2010-07-22 08:07:01 UTC
  • mfrom: (1.2.8 upstream) (3.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100722080701-k46mgdfz6euxwqsm
Tags: 1.4.3-1ubuntu1
* Merge from debian unstable, Remaining changes:
  - debian/control: Don't build against ruby1.9 as we don't want
    it in main.
* require libdbi >= 0.8.3 to prevent aborts when using dbi datasources

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rrddump.html
21
21
        <li><a href="#synopsis">SYNOPSIS</a></li>
22
22
        <li><a href="#description">DESCRIPTION</a></li>
23
23
        <li><a href="#examples">EXAMPLES</a></li>
 
24
        <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
24
25
        <li><a href="#author">AUTHOR</a></li>
25
26
</ul>
26
27
 
38
39
</p>
39
40
<hr />
40
41
<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>
 
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>
44
47
<p>
45
48
</p>
46
49
<hr />
63
66
<p>The (optional) filename that you want to write the XML output to.
64
67
If not specified, the XML will be printed to stdout.</p>
65
68
</dd>
66
 
<dt><strong><a name="no_header_n" class="item">[<strong>--no-header</strong>|<strong>-n</strong>]</a></strong></dt>
67
 
 
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>
 
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>
73
91
</dd>
74
92
</dl>
75
93
<p>
93
111
<p>
94
112
</p>
95
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 />
96
129
<h1><a name="author">AUTHOR</a></h1>
97
130
<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
98
131