X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdinfo.pod;h=d147756c90be9e873c81983cd835b063f14dfa26;hb=0b2a8e05bce8b1a5d6448519356955125b01bfce;hp=98d7ba994d23419ea521c17edaa59b41fdea2654;hpb=a278779cdf2ded56b89fc404d6914bff7ad7dcbd;p=rrdtool.git
diff --git a/doc/rrdinfo.pod b/doc/rrdinfo.pod
index 98d7ba9..d147756 100644
--- a/doc/rrdinfo.pod
+++ b/doc/rrdinfo.pod
@@ -1,38 +1,51 @@
=head1 NAME
-rrdtool info - extract header information from an rrd
-
-=for html
+rrdinfo - extract header information from an RRD
=head1 SYNOPSIS
-B B I
+B B I
+S<[B<--daemon> I]>
=head1 DESCRIPTION
-The B function prints the header information from an rrd in
+The B function prints the header information from an RRD in
a parsing friendly format.
Check L if you are uncertain about the meaning of the
individual keys.
-The B function will always report the true version of the B;
-unlike B which will generate a current version (0002) xml dump for
-older version (0001) files (although the version of the B is unchanged).
+=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 datasources and one rra. Note that the number after the
+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
-datasources.
+stands for I<*UNKNOWN*> data. In the example it means that this RRD
+has neither minimum nor maximum values defined for either of its
+data sources.
- filename = "randome.rrd"
+ 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
@@ -54,15 +67,22 @@ datasources.
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