Imported upstream SVN snapshot 1.4~rc2+20090928.

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

diff --git a/doc/rrdxport.1 b/doc/rrdxport.1
index 92d4869881d20cfe26ab5e4a039a4b946faa565d..e5a7dd9fc0997521aa67bb56d643a17778ada723 100644 (file)
--- a/doc/rrdxport.1
+++ b/doc/rrdxport.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.08)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDXPORT 1"
-.TH RRDXPORT 1 "2008-03-15" "1.3.8" "rrdtool"
+.TH RRDXPORT 1 "2009-06-09" "1.3.999" "rrdtool"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -138,6 +138,7 @@ rrdxport \- Export data in XML format based on data from one or several RRD
 [\fB\-e\fR|\fB\-\-end\fR\ \fIseconds\fR]
 [\fB\-m\fR|\fB\-\-maxrows\fR\ \fIrows\fR]
 [\fB\-\-step\fR\ \fIvalue\fR]
+[\fB\-\-daemon\fR\ \fIaddress\fR]
 [\fB\s-1DEF:\s0\fR\fIvname\fR\fB=\fR\fIrrd\fR\fB:\fR\fIds-name\fR\fB:\fR\fI\s-1CF\s0\fR]
 [\fB\s-1CDEF:\s0\fR\fIvname\fR\fB=\fR\fIrpn-expression\fR]
 [\fB\s-1XPORT\s0\fR\fB:\fR\fIvname\fR[\fB:\fR\fIlegend\fR]]
@@ -169,6 +170,16 @@ for details.
 .IP "\fB\-\-step\fR \fIvalue\fR (default automatic)" 4
 .IX Item "--step value (default automatic)"
 See rrdgraph documentation.
+.IP "\fB\-\-daemon\fR \fIaddress\fR" 4
+.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 xport \-\-daemon unix:/var/run/rrdcached.sock ...
+.Ve
 .IP "\fB\-\-enumds\fR" 4
 .IX Item "--enumds"
 The generated xml should contain the data values in enumerated tags.
@@ -260,6 +271,15 @@ The resulting data section is:
 \&          XPORT:out2:"if2 out bytes" \e
 \&          XPORT:sum:"output sum"
 .Ve
+.SH "ENVIRONMENT VARIABLES"
+.IX Header "ENVIRONMENT VARIABLES"
+The following environment variables may be used to change the behavior of
+\&\f(CW\*(C`rrdtool\ xport\*(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>