Imported upstream version 1.4.8

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

diff --git a/doc/rrddump.1 b/doc/rrddump.1
index 8f47694c2f108a0afba2c1e8baa7ca67e9c8d7b7..bbeef0f254e82016acfde1114f72012588631549 100644 (file)
--- a/doc/rrddump.1
+++ b/doc/rrddump.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 "RRDDUMP 1"
-.TH RRDDUMP 1 "2008-05-16" "1.3.8" "rrdtool"
+.TH RRDDUMP 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,11 +133,11 @@
 rrddump \- dump the contents of an RRD to XML format
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-\&\fBrrdtool\fR \fBdump\fR [\fB\-\-no\-header\fR|\fB\-n\fR] \fIfilename.rrd\fR > \fIfilename.xml\fR
-.PP
-or
-.PP
-\&\fBrrdtool\fR \fBdump\fR [\fB\-\-no\-header\fR|\fB\-n\fR] \fIfilename.rrd\fR \fIfilename.xml\fR
+\&\fBrrdtool\fR \fBdump\fR \fIfilename.rrd\fR [\fIfilename.xml\fR]
+[\fB\-\-header\fR|\fB\-h\fR\ {none,xsd,dtd}]
+[\fB\-\-no\-header\fR]
+[\fB\-\-daemon\fR\ \fIaddress\fR]
+>\ \fIfilename.xml\fR
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 The \fBdump\fR function writes the contents of an \fB\s-1RRD\s0\fR in human
@@ -153,12 +153,26 @@ The name of the \fB\s-1RRD\s0\fR you want to dump.
 .IX Item "filename.xml"
 The (optional) filename that you want to write the \s-1XML\s0 output to.
 If not specified, the \s-1XML\s0 will be printed to stdout.
-.IP "[\fB\-\-no\-header\fR|\fB\-n\fR]" 8
-.IX Item "[--no-header|-n]"
-In rrdtool 1.3, the dump function started producing correct xml-headers.
-Unfortunately the rrdtool restore function from the 1.2 series can not
-handle these headers. With this option you can supress the creatinon of
-the xml headers.
+.IP "\fB\-\-header\fR|\fB\-h\fR {none,xsd,dtd}" 8
+.IX Item "--header|-h {none,xsd,dtd}"
+By default RRDtool will add a dtd header to the xml file. Here
+you can customize this to and xsd header or no header at all.
+.IP "\fB\-\-no\-header\fR" 8
+.IX Item "--no-header"
+A shortcut for \-\-header=none.
+.Sp
+If you want to restore the dump with RRDtool 1.2 you should use the
+\&\-\-no\-header option since 1.2 can not deal with xml headers.
+.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 dump \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+.Ve
 .SH "EXAMPLES"
 .IX Header "EXAMPLES"
 To transfer an \s-1RRD\s0 between architectures, follow these steps:
@@ -170,6 +184,15 @@ Transfer the \s-1XML\s0 dump to the target system.
 .IP "3." 4
 Run \fBrrdtool\fR \fBrestore\fR to create a new \s-1RRD\s0 from the \s-1XML\s0 dump. See
 \&\fBrrdrestore\fR for details.
+.SH "ENVIRONMENT VARIABLES"
+.IX Header "ENVIRONMENT VARIABLES"
+The following environment variables may be used to change the behavior of
+\&\f(CW\*(C`rrdtool\ dump\*(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>