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 after the node has been B<dequeued> by the update thread. By the time
  16 execution of this command ends it is very likely that the update thread has
  17 just updated the requested file, though this is not guaranteed.
  18
  19 =over 8
  20
  21 =item I<filename>
  22
  23 The name of the B<RRD> that is to be written to disk.
  24
  25 =item B<--daemon> I<address>
  26
  27 Address of the L<rrdcached> daemon. If not specified, the RRDCACHED_ADDRESS
  28 environment variable must be set (see below). To specify a UNIX domain socket
  29 use the prefix C<unix:>, see example below. Other addresses are interpreted as
  30 normal network addresses, i.E<nbsp>e. IPv4 or IPv6 addresses in most cases.
  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>flush>:
  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>
  54