Imported upstream version 1.4.8

[pkg-rrdtool.git] / doc / rrdinfo.1

diff --git a/doc/rrdinfo.1 b/doc/rrdinfo.1
index 50165e1abb631c5c7946c48ec34e3a034f73f47b..1a98912e531248765669cac7761726b306776326 100644 (file)
--- a/doc/rrdinfo.1
+++ b/doc/rrdinfo.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDINFO 1"
-.TH RRDINFO 1 "2008-03-15" "1.3.8" "rrdtool"
+.TH RRDINFO 1 "2013-05-23" "1.4.8" "rrdtool"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -133,7 +133,8 @@
 rrdinfo \- extract header information from an RRD
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-\&\fBrrdtool\fR \fBinfo\fR \fIfilename.rrd\fR
+\&\fBrrdtool\fR \fBinfo\fR \fIfilename\fR
+[\fB\-\-daemon\fR\ \fIaddress\fR]
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 The \fBinfo\fR function prints the header information from an \s-1RRD\s0 in
@@ -141,6 +142,19 @@ a parsing friendly format.
 .PP
 Check rrdcreate if you are uncertain about the meaning of the
 individual keys.
+.IP "\fIfilename\fR" 8
+.IX Item "filename"
+The name of the \fB\s-1RRD\s0\fR you want to examine.
+.IP "\fB\-\-daemon\fR \fIaddress\fR" 8
+.IX Item "--daemon address"
+Address of the rrdcached daemon. If specified, a \f(CW\*(C`flush\*(C'\fR command is sent
+to the server before reading the \s-1RRD\s0 files. This allows \fBrrdtool\fR 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 \fB\-l\fR option in the rrdcached manual.
+.Sp
+.Vb 1
+\& rrdtool info \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+.Ve
 .SH "EXAMPLE"
 .IX Header "EXAMPLE"
 This is the output generated by running \fBinfo\fR on a simple \s-1RRD\s0 which
@@ -155,6 +169,7 @@ data sources.
 \& rrd_version = "0001"
 \& step = 300
 \& last_update = 955892996
+\& header_size = 2872
 \& ds[a].type = "GAUGE"
 \& ds[a].minimal_heartbeat = 600
 \& ds[a].min = NaN
@@ -176,9 +191,15 @@ data sources.
 \& rra[0].cdp_prep[1].value = nan
 \& rra[0].cdp_prep[1].unknown_datapoints = 0
 .Ve
-.IP "\fIfilename.rrd\fR" 8
-.IX Item "filename.rrd"
-The name of the \fB\s-1RRD\s0\fR you want to examine.
+.SH "ENVIRONMENT VARIABLES"
+.IX Header "ENVIRONMENT VARIABLES"
+The following environment variables may be used to change the behavior of
+\&\f(CW\*(C`rrdtool\ info\*(C'\fR:
+.IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4
+.IX Item "RRDCACHED_ADDRESS"
+If this environment variable is set it will have the same effect as specifying
+the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command
+line argument takes precedence.
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Tobias Oetiker <tobi@oetiker.ch>