doc/rrddump.pod

   1 =head1 NAME
   2
   3 rrddump - dump the contents of an RRD to XML format
   4
   5 =head1 SYNOPSIS
   6
   7 B<rrdtool> B<dump> I<filename.rrd>
   8 S<[B<--header>|B<-h> {xsd,dtd}]>
   9 S<[B<--daemon> I<address>]>
  10 S<E<gt> I<filename.xml>>
  11
  12 or
  13
  14 B<rrdtool> B<dump> I<filename.rrd> I<filename.xml>
  15 S<[B<--header>|B<-h> {xsd,dtd}]>
  16 S<[B<--daemon> I<address>]>
  17
  18 =head1 DESCRIPTION
  19
  20 The B<dump> function writes the contents of an B<RRD> in human
  21 readable (?) XML format to a file or to stdout. This format can
  22 be read by rrdrestore. Together they allow you to transfer your
  23 files from one computer architecture to another as well to
  24 manipulate the contents of an B<RRD> file in a somewhat more
  25 convenient manner.
  26
  27
  28 =over 8
  29
  30 =item I<filename.rrd>
  31
  32 The name of the B<RRD> you want to dump.
  33
  34 =item I<filename.xml>
  35
  36 The (optional) filename that you want to write the XML output to.
  37 If not specified, the XML will be printed to stdout.
  38
  39 =item B<--header>|B<-h> {xsd,dtd}
  40
  41 Optionally rrdtool can add a xsd or dtd header to the dump output.
  42
  43 =item B<--daemon> I<address>
  44
  45 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
  46 to the server before reading the RRD files. This allows B<rrdtool> to return
  47 fresh data even if the daemon is configured to cache values for a long time.
  48 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
  49
  50  rrdtool dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
  51
  52 =back
  53
  54 =head1 EXAMPLES
  55
  56 To transfer an RRD between architectures, follow these steps:
  57
  58 =over 4
  59
  60 =item 1.
  61
  62 On the same system where the RRD was created, use B<rrdtool> B<dump>
  63 to export the data to XML format.
  64
  65 =item 2.
  66
  67 Transfer the XML dump to the target system.
  68
  69 =item 3.
  70
  71 Run B<rrdtool> B<restore> to create a new RRD from the XML dump. See
  72 B<rrdrestore> for details.
  73
  74 =back
  75
  76 =head1 ENVIRONMENT VARIABLES
  77
  78 The following environment variables may be used to change the behavior of
  79 C<rrdtoolE<nbsp>dump>:
  80
  81 =over 4
  82
  83 =item B<RRDCACHED_ADDRESS>
  84
  85 If this environment variable is set it will have the same effect as specifying
  86 the C<--daemon> option on the command line. If both are present, the command
  87 line argument takes precedence.
  88
  89 =back
  90
  91 =head1 AUTHOR
  92
  93 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
  94