doc/rrdflushcached.pod

   1 =head1 NAME
   2
   3 rrdflushcached - Flush the values for a spcific RRD file from memory.
   4
   5 =head1 SYNOPSIS
   6
   7 B<rrdtool> B<flushcached>
   8 S<[B<--daemon> I<address>]>
   9 I<filename> [I<filename> ...]
  10
  11 =head1 DESCRIPTION
  12
  13 The B<flushcached> function connects to L<rrdcached>, the RRD caching daemon,
  14 and issues a "flush" command for the given files. The daemon will put the
  15 files to the head of the update queue so they are written "soon". The
  16 status will be returned only after the files' pending updates have been
  17 written to disk.
  18
  19 =over 8
  20
  21 =item I<filename>
  22
  23 The name(s) of the B<RRD> file(s) that are to be written to disk.
  24
  25 =item B<--daemon> I<address>
  26
  27 Address of the L<rrdcached> daemon. If not specified, the
  28 RRDCACHED_ADDRESS environment variable must be set (see below).  For a
  29 list of accepted formats, see the B<-l> option in the L<rrdcached>
  30 manual.
  31
  32  rrdtool flush --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
  33
  34 =back
  35
  36 =head1 ENVIRONMENT VARIABLES
  37
  38 The following environment variables may be used to change the behavior of
  39 C<rrdtoolE<nbsp>flushcached>:
  40
  41 =over 4
  42
  43 =item B<RRDCACHED_ADDRESS>
  44
  45 If this environment variable is set it will have the same effect as specifying
  46 the C<--daemon> option on the command line. If both are present, the command
  47 line argument takes precedence.
  48
  49 =back
  50
  51 =head1 AUTHOR
  52
  53 Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>