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