Imported upstream version 1.4~rc2.

[pkg-rrdtool.git] / doc / rrdflushcached.pod

diff --git a/doc/rrdflushcached.pod b/doc/rrdflushcached.pod
new file mode 100644 (file)
index 0000000..3c14201
--- /dev/null
+++ b/doc/rrdflushcached.pod
@@ -0,0 +1,53 @@
+=head1 NAME
+
+rrdflush - Flush the values for a spcific RRD file from memory.
+
+=head1 SYNOPSIS
+
+B<rrdtool> B<flushcached>
+S<[B<--daemon> I<address>]>
+I<filename> [I<filename> ...]
+
+=head1 DESCRIPTION
+
+The B<flushcached> function connects to L<rrdcached>, the RRD caching daemon,
+and issues a "flush" command for the given files. The daemon will put the
+files to the head of the update queue so they are written "soon". The
+status will be returned only after the files' pending updates have been
+written to disk.
+
+=over 8
+
+=item I<filename>
+
+The name(s) of the B<RRD> file(s) that are to be written to disk.
+
+=item B<--daemon> I<address>
+
+Address of the L<rrdcached> daemon. If not specified, the
+RRDCACHED_ADDRESS environment variable must be set (see below).  For a
+list of accepted formats, see the B<-l> option in the L<rrdcached>
+manual.
+
+ rrdtool flush --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>flushcached>:
+
+=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
+
+Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>