doc/rrdflush.pod

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