patches: Added bts573299-rrdgraph-M.

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

diff --git a/doc/rrdfetch.1 b/doc/rrdfetch.1
index dca9c9350d7a395d41ddb496c13ba1c24529be1e..3a48a60558f592d69999ba038096a49c0df4bc2e 100644 (file)
--- a/doc/rrdfetch.1
+++ b/doc/rrdfetch.1
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDFETCH 1"
-.TH RRDFETCH 1 "2008-03-15" "1.3.8" "rrdtool"
+.TH RRDFETCH 1 "2008-09-25" "1.4.2" "rrdtool"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -137,6 +137,7 @@ rrdfetch \- Fetch data from an RRD.
 [\fB\-\-resolution\fR|\fB\-r\fR\ \fIresolution\fR]
 [\fB\-\-start\fR|\fB\-s\fR\ \fIstart\fR]
 [\fB\-\-end\fR|\fB\-e\fR\ \fIend\fR]
+[\fB\-\-daemon\fR\ \fIaddress\fR]
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 The \fBfetch\fR function is normally used internally by the graph
@@ -168,6 +169,16 @@ section for a detailed explanation on  ways to specify the start time.
 the end of the time series in seconds since epoch. See also AT-STYLE
 \&\s-1TIME\s0 \s-1SPECIFICATION\s0 section for a detailed explanation of how to
 specify the end time.
+.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 fetch \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd AVERAGE
+.Ve
 .SS "\s-1RESOLUTION\s0 \s-1INTERVAL\s0"
 .IX Subsection "RESOLUTION INTERVAL"
 In order to get RRDtool to fetch anything other than the finest resolution \s-1RRA\s0
@@ -361,6 +372,15 @@ as \fI9am\-1day\fR.
 .PP
 \&\fI19970703 12:45\fR \*(-- 12:45  July 3th, 1997
 (my favorite, and its even got an \s-1ISO\s0 number (8601)).
+.SH "ENVIRONMENT VARIABLES"
+.IX Header "ENVIRONMENT VARIABLES"
+The following environment variables may be used to change the behavior of
+\&\f(CW\*(C`rrdtool\ fetch\*(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>