Code

Imported upstream version 1.4.8
[pkg-rrdtool.git] / doc / rrddump.1
index a3c8799931c5545a65ea0c6f44754f279c7a9ead..bbeef0f254e82016acfde1114f72012588631549 100644 (file)
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "RRDDUMP 1"
-.TH RRDDUMP 1 "2008-05-16" "1.3rc4" "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
+.nh
 .SH "NAME"
 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
@@ -154,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:
@@ -171,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>