doc/rrddump.1

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "RRDDUMP 1"
 127 .TH RRDDUMP 1 "2013-05-23" "1.4.8" "rrdtool"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 rrddump \- dump the contents of an RRD to XML format
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\fBrrdtool\fR \fBdump\fR \fIfilename.rrd\fR [\fIfilename.xml\fR]
 137 [\fB\-\-header\fR|\fB\-h\fR\ {none,xsd,dtd}]
 138 [\fB\-\-no\-header\fR]
 139 [\fB\-\-daemon\fR\ \fIaddress\fR]
 140 >\ \fIfilename.xml\fR
 141 .SH "DESCRIPTION"
 142 .IX Header "DESCRIPTION"
 143 The \fBdump\fR function writes the contents of an \fB\s-1RRD\s0\fR in human
 144 readable (?) \s-1XML\s0 format to a file or to stdout. This format can
 145 be read by rrdrestore. Together they allow you to transfer your
 146 files from one computer architecture to another as well to
 147 manipulate the contents of an \fB\s-1RRD\s0\fR file in a somewhat more
 148 convenient manner.
 149 .IP "\fIfilename.rrd\fR" 8
 150 .IX Item "filename.rrd"
 151 The name of the \fB\s-1RRD\s0\fR you want to dump.
 152 .IP "\fIfilename.xml\fR" 8
 153 .IX Item "filename.xml"
 154 The (optional) filename that you want to write the \s-1XML\s0 output to.
 155 If not specified, the \s-1XML\s0 will be printed to stdout.
 156 .IP "\fB\-\-header\fR|\fB\-h\fR {none,xsd,dtd}" 8
 157 .IX Item "--header|-h {none,xsd,dtd}"
 158 By default RRDtool will add a dtd header to the xml file. Here
 159 you can customize this to and xsd header or no header at all.
 160 .IP "\fB\-\-no\-header\fR" 8
 161 .IX Item "--no-header"
 162 A shortcut for \-\-header=none.
 163 .Sp
 164 If you want to restore the dump with RRDtool 1.2 you should use the
 165 \&\-\-no\-header option since 1.2 can not deal with xml headers.
 166 .IP "\fB\-\-daemon\fR \fIaddress\fR" 8
 167 .IX Item "--daemon address"
 168 Address of the rrdcached daemon. If specified, a \f(CW\*(C`flush\*(C'\fR command is sent
 169 to the server before reading the \s-1RRD\s0 files. This allows \fBrrdtool\fR to return
 170 fresh data even if the daemon is configured to cache values for a long time.
 171 For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual.
 172 .Sp
 173 .Vb 1
 174 \& rrdtool dump \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 175 .Ve
 176 .SH "EXAMPLES"
 177 .IX Header "EXAMPLES"
 178 To transfer an \s-1RRD\s0 between architectures, follow these steps:
 179 .IP "1." 4
 180 On the same system where the \s-1RRD\s0 was created, use \fBrrdtool\fR \fBdump\fR
 181 to export the data to \s-1XML\s0 format.
 182 .IP "2." 4
 183 Transfer the \s-1XML\s0 dump to the target system.
 184 .IP "3." 4
 185 Run \fBrrdtool\fR \fBrestore\fR to create a new \s-1RRD\s0 from the \s-1XML\s0 dump. See
 186 \&\fBrrdrestore\fR for details.
 187 .SH "ENVIRONMENT VARIABLES"
 188 .IX Header "ENVIRONMENT VARIABLES"
 189 The following environment variables may be used to change the behavior of
 190 \&\f(CW\*(C`rrdtool\ dump\*(C'\fR:
 191 .IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4
 192 .IX Item "RRDCACHED_ADDRESS"
 193 If this environment variable is set it will have the same effect as specifying
 194 the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command
 195 line argument takes precedence.
 196 .SH "AUTHOR"
 197 .IX Header "AUTHOR"
 198 Tobias Oetiker <tobi@oetiker.ch>