← Back to branch summary

~ubuntu-branches/ubuntu/saucy/rrdtool/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/rrddump.pod

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2010-07-22 08:07:01 UTC
  • mfrom: (1.2.8 upstream) (3.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100722080701-k46mgdfz6euxwqsm
Tags: 1.4.3-1ubuntu1
* Merge from debian unstable, Remaining changes:
  - debian/control: Don't build against ruby1.9 as we don't want
    it in main.
* require libdbi >= 0.8.3 to prevent aborts when using dbi datasources

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rrddump.pod
4
4
 
5
5
=head1 SYNOPSIS
6
6
 
7
 
B<rrdtool> B<dump> S<[B<--no-header>|B<-n>]> I<filename.rrd> E<gt> I<filename.xml>
8
 
 
9
 
or 
10
 
 
11
 
B<rrdtool> B<dump> S<[B<--no-header>|B<-n>]> I<filename.rrd> I<filename.xml>
 
7
B<rrdtool> B<dump> I<filename.rrd> [I<filename.xml>]
 
8
S<[B<--header>|B<-h> {none,xsd,dtd}]>
 
9
S<[B<--no-header>]>
 
10
S<[B<--daemon> I<address>]>
 
11
S<E<gt> I<filename.xml>>
12
12
 
13
13
=head1 DESCRIPTION
14
14
 
19
19
manipulate the contents of an B<RRD> file in a somewhat more
20
20
convenient manner.
21
21
 
22
 
 
23
22
=over 8
24
23
 
25
24
=item I<filename.rrd>
31
30
The (optional) filename that you want to write the XML output to.
32
31
If not specified, the XML will be printed to stdout.
33
32
 
34
 
=item S<[B<--no-header>|B<-n>]>
35
 
 
36
 
In rrdtool 1.3, the dump function started producing correct xml-headers.
37
 
Unfortunately the rrdtool restore function from the 1.2 series can not
38
 
handle these headers. With this option you can supress the creatinon of
39
 
the xml headers.
 
33
=item B<--header>|B<-h> {none,xsd,dtd}
 
34
 
 
35
By default RRDtool will add a dtd header to the xml file. Here
 
36
you can customize this to and xsd header or no header at all.
 
37
 
 
38
 
 
39
=item B<--no-header>
 
40
 
 
41
A shortcut for S<--header=none>.
 
42
 
 
43
If you want to restore the dump with RRDtool 1.2 you should use the
 
44
S<--no-header> option since 1.2 can not deal with xml headers.
 
45
 
 
46
=item B<--daemon> I<address>
 
47
 
 
48
Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
 
49
to the server before reading the RRD files. This allows B<rrdtool> to return
 
50
fresh data even if the daemon is configured to cache values for a long time.
 
51
For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
 
52
 
 
53
 rrdtool dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
40
54
 
41
55
=back
42
56
 
62
76
 
63
77
=back
64
78
 
 
79
=head1 ENVIRONMENT VARIABLES
 
80
 
 
81
The following environment variables may be used to change the behavior of
 
82
C<rrdtoolE<nbsp>dump>:
 
83
 
 
84
=over 4
 
85
 
 
86
=item B<RRDCACHED_ADDRESS>
 
87
 
 
88
If this environment variable is set it will have the same effect as specifying
 
89
the C<--daemon> option on the command line. If both are present, the command
 
90
line argument takes precedence.
 
91
 
 
92
=back
 
93
 
65
94
=head1 AUTHOR
66
95
 
67
96
Tobias Oetiker E<lt>tobi@oetiker.chE<gt>