doc/rrddump.1

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