← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/rrddump.1

  • 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.1
124
124
.\" ========================================================================
125
125
.\"
126
126
.IX Title "RRDDUMP 1"
127
 
.TH RRDDUMP 1 "2008-05-16" "1.3.8" "rrdtool"
 
127
.TH RRDDUMP 1 "2009-10-14" "1.4.3" "rrdtool"
128
128
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129
129
.\" way too many mistakes in technical documents.
130
130
.if n .ad l
133
133
rrddump \- dump the contents of an RRD to XML format
134
134
.SH "SYNOPSIS"
135
135
.IX Header "SYNOPSIS"
136
 
\&\fBrrdtool\fR \fBdump\fR [\fB\-\-no\-header\fR|\fB\-n\fR] \fIfilename.rrd\fR > \fIfilename.xml\fR
137
 
.PP
138
 
or
139
 
.PP
140
 
\&\fBrrdtool\fR \fBdump\fR [\fB\-\-no\-header\fR|\fB\-n\fR] \fIfilename.rrd\fR \fIfilename.xml\fR
 
136
\&\fBrrdtool\fR \fBdump\fR \fIfilename.rrd\fR [\fIfilename.xml\fR]
 
137
[\fB\-\-header\fR|\fB\-h\fR\ {none,xsd,dtd}]
 
138
[\fB\-\-no\-header\fR]
 
139
[\fB\-\-daemon\fR\ \fIaddress\fR]
 
140
>\ \fIfilename.xml\fR
141
141
.SH "DESCRIPTION"
142
142
.IX Header "DESCRIPTION"
143
143
The \fBdump\fR function writes the contents of an \fB\s-1RRD\s0\fR in human
153
153
.IX Item "filename.xml"
154
154
The (optional) filename that you want to write the \s-1XML\s0 output to.
155
155
If not specified, the \s-1XML\s0 will be printed to stdout.
156
 
.IP "[\fB\-\-no\-header\fR|\fB\-n\fR]" 8
157
 
.IX Item "[--no-header|-n]"
158
 
In rrdtool 1.3, the dump function started producing correct xml-headers.
159
 
Unfortunately the rrdtool restore function from the 1.2 series can not
160
 
handle these headers. With this option you can supress the creatinon of
161
 
the xml headers.
 
156
.IP "\fB\-\-header\fR|\fB\-h\fR {none,xsd,dtd}" 8
 
157
.IX Item "--header|-h {none,xsd,dtd}"
 
158
By default RRDtool will add a dtd header to the xml file. Here
 
159
you can customize this to and xsd header or no header at all.
 
160
.IP "\fB\-\-no\-header\fR" 8
 
161
.IX Item "--no-header"
 
162
A shortcut for \-\-header=none.
 
163
.Sp
 
164
If you want to restore the dump with RRDtool 1.2 you should use the
 
165
\&\-\-no\-header option since 1.2 can not deal with xml headers.
 
166
.IP "\fB\-\-daemon\fR \fIaddress\fR" 8
 
167
.IX Item "--daemon address"
 
168
Address of the rrdcached daemon. If specified, a \f(CW\*(C`flush\*(C'\fR command is sent
 
169
to the server before reading the \s-1RRD\s0 files. This allows \fBrrdtool\fR to return
 
170
fresh data even if the daemon is configured to cache values for a long time.
 
171
For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual.
 
172
.Sp
 
173
.Vb 1
 
174
\& rrdtool dump \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 
175
.Ve
162
176
.SH "EXAMPLES"
163
177
.IX Header "EXAMPLES"
164
178
To transfer an \s-1RRD\s0 between architectures, follow these steps:
170
184
.IP "3." 4
171
185
Run \fBrrdtool\fR \fBrestore\fR to create a new \s-1RRD\s0 from the \s-1XML\s0 dump. See
172
186
\&\fBrrdrestore\fR for details.
 
187
.SH "ENVIRONMENT VARIABLES"
 
188
.IX Header "ENVIRONMENT VARIABLES"
 
189
The following environment variables may be used to change the behavior of
 
190
\&\f(CW\*(C`rrdtool\ dump\*(C'\fR:
 
191
.IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4
 
192
.IX Item "RRDCACHED_ADDRESS"
 
193
If this environment variable is set it will have the same effect as specifying
 
194
the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command
 
195
line argument takes precedence.
173
196
.SH "AUTHOR"
174
197
.IX Header "AUTHOR"
175
198
Tobias Oetiker <tobi@oetiker.ch>