This patch introduces a feature whereby rrdcached will disallow updates
[rrdtool.git] / doc / rrdlastupdate.pod
1 =head1 NAME
2
3 rrdlastupdate - Return the most recent update to an RRD
4
5 =head1 SYNOPSIS
6
7 B<rrdtool> B<lastupdate> I<filename>
8 S<[B<--daemon> I<address>]>
9
10 =head1 DESCRIPTION
11
12 The B<lastupdate> function returns the UNIX timestamp and the 
13 value stored for each datum in the most recent update of an RRD.
14
15 =over 8
16
17 =item I<filename>
18
19 The name of the B<RRD> that contains the data.
20
21 =item B<--daemon> I<address>
22
23 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
24 to the server before reading the RRD files. This allows B<rrdtool> to return
25 fresh data even if the daemon is configured to cache values for a long time.
26 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
27
28  rrdtool lastupdate --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
29
30 =back
31
32 =head1 ENVIRONMENT VARIABLES
33
34 The following environment variables may be used to change the behavior of
35 C<rrdtoolE<nbsp>lastupdate>:
36
37 =over 4
38
39 =item B<RRDCACHED_ADDRESS>
40
41 If this environment variable is set it will have the same effect as specifying
42 the C<--daemon> option on the command line. If both are present, the command
43 line argument takes precedence.
44
45 =back
46
47 =head1 AUTHOR
48
49 Andy Riebs E<lt>andy.riebs@hp.comE<gt>
50
51
52