Imported upstream version 1.4~rc2.

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

diff --git a/doc/rrdinfo.1 b/doc/rrdinfo.1
index 69f48fa98d527666bae9ff21be984d48abe3a308..51f096651ccbe5093005c1747b0c2b965c2f7edb 100644 (file)
--- a/doc/rrdinfo.1
+++ b/doc/rrdinfo.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -25,11 +25,11 @@
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
@@ -129,12 +129,13 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDINFO 1"
-.TH RRDINFO 1 "2007-11-20" "1.2.26" "rrdtool"
+.TH RRDINFO 1 "2009-04-20" "1.3.99909060808" "rrdtool"
 .SH "NAME"
 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
@@ -142,6 +143,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
@@ -151,11 +165,12 @@ stands for \fI*UNKNOWN*\fR data. In the example it means that this \s-1RRD\s0
 has neither minimum nor maximum values defined for either of its
 data sources.
 .PP
-.Vb 24
+.Vb 25
 \& filename = "random.rrd"
 \& rrd_version = "0001"
 \& step = 300
 \& last_update = 955892996
+\& header_size = 2872
 \& ds[a].type = "GAUGE"
 \& ds[a].minimal_heartbeat = 600
 \& ds[a].min = NaN
@@ -177,9 +192,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>