← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/rrdinfo.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/rrdinfo.pod
4
4
 
5
5
=head1 SYNOPSIS
6
6
 
7
 
B<rrdtool> B<info> I<filename.rrd>
 
7
B<rrdtool> B<info> I<filename>
 
8
S<[B<--daemon> I<address>]>
8
9
 
9
10
=head1 DESCRIPTION
10
11
 
14
15
Check L<rrdcreate> if you are uncertain about the meaning of the
15
16
individual keys.
16
17
 
 
18
=over 8
 
19
 
 
20
=item I<filename>
 
21
 
 
22
The name of the B<RRD> you want to examine.
 
23
 
 
24
=item B<--daemon> I<address>
 
25
 
 
26
Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
 
27
to the server before reading the RRD files. This allows B<rrdtool> to return
 
28
fresh data even if the daemon is configured to cache values for a long time.
 
29
For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
 
30
 
 
31
 rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 
32
 
 
33
=back
 
34
 
17
35
=head1 EXAMPLE
18
36
 
19
37
This is the output generated by running B<info> on a simple RRD which
27
45
 rrd_version = "0001"
28
46
 step = 300
29
47
 last_update = 955892996
 
48
 header_size = 2872
30
49
 ds[a].type = "GAUGE"
31
50
 ds[a].minimal_heartbeat = 600
32
51
 ds[a].min = NaN
48
67
 rra[0].cdp_prep[1].value = nan
49
68
 rra[0].cdp_prep[1].unknown_datapoints = 0
50
69
 
51
 
=over 8
52
 
 
53
 
=item I<filename.rrd>
54
 
 
55
 
The name of the B<RRD> you want to examine.
 
70
=head1 ENVIRONMENT VARIABLES
 
71
 
 
72
The following environment variables may be used to change the behavior of
 
73
C<rrdtoolE<nbsp>info>:
 
74
 
 
75
=over 4
 
76
 
 
77
=item B<RRDCACHED_ADDRESS>
 
78
 
 
79
If this environment variable is set it will have the same effect as specifying
 
80
the C<--daemon> option on the command line. If both are present, the command
 
81
line argument takes precedence.
56
82
 
57
83
=back
58
84