X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=doc%2Frrdinfo.pod;h=d147756c90be9e873c81983cd835b063f14dfa26;hp=3558d7a8dc99b6b942b9ef5c24d9c75ad6b199eb;hb=1d0d1678df2083bc996d579e0c5d0cc46fff6745;hpb=d828f3eccac8dbad7bfc14812e406377669baaa4 diff --git a/doc/rrdinfo.pod b/doc/rrdinfo.pod index 3558d7a..d147756 100644 --- a/doc/rrdinfo.pod +++ b/doc/rrdinfo.pod @@ -1,12 +1,11 @@ =head1 NAME -rrdtool info - extract header information from an RRD - -=for html
PDF version.
+rrdinfo - extract header information from an RRD =head1 SYNOPSIS -B B I +B B I +S<[B<--daemon> I
]> =head1 DESCRIPTION @@ -16,19 +15,37 @@ a parsing friendly format. Check L if you are uncertain about the meaning of the individual keys. +=over 8 + +=item I + +The name of the B you want to examine. + +=item B<--daemon> I
+ +Address of the L daemon. If specified, a C command is sent +to the server before reading the RRD files. This allows B to return +fresh data even if the daemon is configured to cache values for a long time. +For a list of accepted formats, see the B<-l> option in the L manual. + + rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd + +=back + =head1 EXAMPLE This is the output generated by running B on a simple RRD which contains two data sources and one RRA. Note that the number after the I keyword is in seconds since 1970. The string B stands for I<*UNKNOWN*> data. In the example it means that this RRD -has neither minimum not maximum values defined for either of its +has neither minimum nor maximum values defined for either of its data sources. filename = "random.rrd" rrd_version = "0001" step = 300 last_update = 955892996 + header_size = 2872 ds[a].type = "GAUGE" ds[a].minimal_heartbeat = 600 ds[a].min = NaN @@ -50,15 +67,22 @@ data sources. rra[0].cdp_prep[1].value = nan rra[0].cdp_prep[1].unknown_datapoints = 0 -=over 8 +=head1 ENVIRONMENT VARIABLES + +The following environment variables may be used to change the behavior of +Cinfo>: + +=over 4 -=item I +=item B -The name of the B you want to dump. +If this environment variable is set it will have the same effect as specifying +the C<--daemon> option on the command line. If both are present, the command +line argument takes precedence. =back =head1 AUTHOR -Tobias Oetiker Eoetiker@ee.ethz.chE +Tobias Oetiker Etobi@oetiker.chE