rrdlastupdate(1): Document the new `--daemon' option.
authorFlorian Forster <octo@leeloo.home.verplant.org>
Tue, 15 Jul 2008 18:06:13 +0000 (20:06 +0200)
committerFlorian Forster <octo@leeloo.home.verplant.org>
Tue, 15 Jul 2008 18:06:13 +0000 (20:06 +0200)
doc/rrdlastupdate.pod

index 37013cf..72b8682 100644 (file)
@@ -5,6 +5,7 @@ rrdlastupdate - Return the most recent update to an RRD
 =head1 SYNOPSIS
 
 B<rrdtool> B<lastupdate> I<filename>
+S<[B<--daemon> I<address>]>
 
 =head1 DESCRIPTION
 
@@ -17,11 +18,37 @@ value stored for each datum in the most recent update of an RRD.
 
 The name of the B<RRD> that contains the data.
 
+=item B<--daemon> I<address>
+
+Address of the L<rrdcached(1)> daemon. If specified, a C<flush> command is sent
+to the server before reading the RRD files. This allows B<rrdtool> to return
+fresh data even if the daemon is configured to cache values for a long time. To
+specify a UNIX domain socket use the prefix C<unix:>, see example below. Other
+addresses are interpreted as normal network addresses, i.E<nbsp>e. IPv4 or IPv6
+addresses in most cases.
+
+ rrdtool lastupdate --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+
+=back
+
+=head1 ENVIRONMENT VARIABLES
+
+The following environment variables may be used to change the behavior of
+C<rrdtoolE<nbsp>lastupdate>:
+
+=over 4
+
+=item B<RRDCACHED_ADDRESS>
+
+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
 
-Andy Riebs <andy.riebs@hp.com>
+Andy Riebs E<lt>andy.riebs@hp.comE<gt>