fix my mail address
[rrdtool.git] / doc / rrdinfo.pod
1 =head1 NAME
2
3 rrdinfo - extract header information from an RRD
4
5 =head1 SYNOPSIS
6
7 B<rrdtool> B<info> I<filename.rrd>
8
9 =head1 DESCRIPTION
10
11 The B<info> function prints the header information from an RRD in
12 a parsing friendly format.
13
14 Check L<rrdcreate> if you are uncertain about the meaning of the
15 individual keys.
16
17 =head1 EXAMPLE
18
19 This is the output generated by running B<info> on a simple RRD which
20 contains two data sources and one RRA. Note that the number after the
21 I<last_update> keyword is in seconds since 1970. The string B<NaN>
22 stands for I<*UNKNOWN*> data. In the example it means that this RRD
23 has neither minimum nor maximum values defined for either of its
24 data sources.
25
26  filename = "random.rrd"
27  rrd_version = "0001"
28  step = 300
29  last_update = 955892996
30  ds[a].type = "GAUGE"
31  ds[a].minimal_heartbeat = 600
32  ds[a].min = NaN
33  ds[a].max = NaN
34  ds[a].last_ds = "UNKN"
35  ds[a].value = 2.1824421548e+04
36  ds[a].unknown_sec = 0
37  ds[b].type = "GAUGE"
38  ds[b].minimal_heartbeat = 600
39  ds[b].min = NaN
40  ds[b].max = NaN
41  ds[b].last_ds = "UNKN"
42  ds[b].value = 3.9620838224e+03
43  ds[b].unknown_sec = 0
44  rra[0].cf = "AVERAGE"
45  rra[0].pdp_per_row = 1
46  rra[0].cdp_prep[0].value = nan
47  rra[0].cdp_prep[0].unknown_datapoints = 0
48  rra[0].cdp_prep[1].value = nan
49  rra[0].cdp_prep[1].unknown_datapoints = 0
50
51 =over 8
52
53 =item I<filename.rrd>
54
55 The name of the B<RRD> you want to examine.
56
57 =back
58
59 =head1 AUTHOR
60
61 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
62