← Back to branch summary

~ubuntu-branches/ubuntu/saucy/rrdtool/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/rrdinfo.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/rrdinfo.1
124
124
.\" ========================================================================
125
125
.\"
126
126
.IX Title "RRDINFO 1"
127
 
.TH RRDINFO 1 "2008-03-15" "1.3.8" "rrdtool"
 
127
.TH RRDINFO 1 "2009-04-20" "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
rrdinfo \- extract header information from an RRD
134
134
.SH "SYNOPSIS"
135
135
.IX Header "SYNOPSIS"
136
 
\&\fBrrdtool\fR \fBinfo\fR \fIfilename.rrd\fR
 
136
\&\fBrrdtool\fR \fBinfo\fR \fIfilename\fR
 
137
[\fB\-\-daemon\fR\ \fIaddress\fR]
137
138
.SH "DESCRIPTION"
138
139
.IX Header "DESCRIPTION"
139
140
The \fBinfo\fR function prints the header information from an \s-1RRD\s0 in
141
142
.PP
142
143
Check rrdcreate if you are uncertain about the meaning of the
143
144
individual keys.
 
145
.IP "\fIfilename\fR" 8
 
146
.IX Item "filename"
 
147
The name of the \fB\s-1RRD\s0\fR you want to examine.
 
148
.IP "\fB\-\-daemon\fR \fIaddress\fR" 8
 
149
.IX Item "--daemon address"
 
150
Address of the rrdcached daemon. If specified, a \f(CW\*(C`flush\*(C'\fR command is sent
 
151
to the server before reading the \s-1RRD\s0 files. This allows \fBrrdtool\fR to return
 
152
fresh data even if the daemon is configured to cache values for a long time.
 
153
For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual.
 
154
.Sp
 
155
.Vb 1
 
156
\& rrdtool info \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 
157
.Ve
144
158
.SH "EXAMPLE"
145
159
.IX Header "EXAMPLE"
146
160
This is the output generated by running \fBinfo\fR on a simple \s-1RRD\s0 which
155
169
\& rrd_version = "0001"
156
170
\& step = 300
157
171
\& last_update = 955892996
 
172
\& header_size = 2872
158
173
\& ds[a].type = "GAUGE"
159
174
\& ds[a].minimal_heartbeat = 600
160
175
\& ds[a].min = NaN
176
191
\& rra[0].cdp_prep[1].value = nan
177
192
\& rra[0].cdp_prep[1].unknown_datapoints = 0
178
193
.Ve
179
 
.IP "\fIfilename.rrd\fR" 8
180
 
.IX Item "filename.rrd"
181
 
The name of the \fB\s-1RRD\s0\fR you want to examine.
 
194
.SH "ENVIRONMENT VARIABLES"
 
195
.IX Header "ENVIRONMENT VARIABLES"
 
196
The following environment variables may be used to change the behavior of
 
197
\&\f(CW\*(C`rrdtool\ info\*(C'\fR:
 
198
.IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4
 
199
.IX Item "RRDCACHED_ADDRESS"
 
200
If this environment variable is set it will have the same effect as specifying
 
201
the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command
 
202
line argument takes precedence.
182
203
.SH "AUTHOR"
183
204
.IX Header "AUTHOR"
184
205
Tobias Oetiker <tobi@oetiker.ch>