doc/rrdflushcached.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <title>rrdflushcached</title>
   5 <link rev="made" href="mailto:root@localhost" />
   6 </head>
   7
   8 <body style="background-color: white">
   9
  10 <p><a name="__index__"></a></p>
  11 <!-- INDEX BEGIN -->
  12 <!--
  13
  14 <ul>
  15
  16         <li><a href="#name">NAME</a></li>
  17         <li><a href="#synopsis">SYNOPSIS</a></li>
  18         <li><a href="#description">DESCRIPTION</a></li>
  19         <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
  20         <li><a href="#author">AUTHOR</a></li>
  21 </ul>
  22 -->
  23 <!-- INDEX END -->
  24
  25 <p>
  26 </p>
  27 <h1><a name="name">NAME</a></h1>
  28 <p>rrdflush - Flush the values for a spcific RRD file from memory.</p>
  29 <p>
  30 </p>
  31 <hr />
  32 <h1><a name="synopsis">SYNOPSIS</a></h1>
  33 <p><strong>rrdtool</strong> <strong>flushcached</strong>
  34 [<strong>--daemon</strong>&nbsp;<em>address</em>]
  35 <em>filename</em> [<em>filename</em> ...]</p>
  36 <p>
  37 </p>
  38 <hr />
  39 <h1><a name="description">DESCRIPTION</a></h1>
  40 <p>The <strong>flushcached</strong> function connects to <a href="././rrdcached.html">the rrdcached manpage</a>, the RRD caching daemon,
  41 and issues a ``flush'' command for the given files. The daemon will put the
  42 files to the head of the update queue so they are written ``soon''. The
  43 status will be returned only after the files' pending updates have been
  44 written to disk.</p>
  45 <dl>
  46 <dt><strong><a name="item_filename"><em>filename</em></a></strong><br />
  47 </dt>
  48 <dd>
  49 The <code>name(s)</code> of the <strong>RRD</strong> <code>file(s)</code> that are to be written to disk.
  50 </dd>
  51 <p></p>
  52 <dt><strong><a name="item__2d_2ddaemon_address"><strong>--daemon</strong> <em>address</em></a></strong><br />
  53 </dt>
  54 <dd>
  55 Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If not specified, the
  56 RRDCACHED_ADDRESS environment variable must be set (see below).  For a
  57 list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a>
  58 manual.
  59 </dd>
  60 <dd>
  61 <pre>
  62  rrdtool flush --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
  63 </dd>
  64 <p></p></dl>
  65 <p>
  66 </p>
  67 <hr />
  68 <h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
  69 <p>The following environment variables may be used to change the behavior of
  70 <code>rrdtoolflushcached</code>:</p>
  71 <dl>
  72 <dt><strong><a name="item_rrdcached_address"><strong>RRDCACHED_ADDRESS</strong></a></strong><br />
  73 </dt>
  74 <dd>
  75 If this environment variable is set it will have the same effect as specifying
  76 the <code>--daemon</code> option on the command line. If both are present, the command
  77 line argument takes precedence.
  78 </dd>
  79 <p></p></dl>
  80 <p>
  81 </p>
  82 <hr />
  83 <h1><a name="author">AUTHOR</a></h1>
  84 <p>Florian Forster &lt;octo&nbsp;at&nbsp;verplant.org&gt;</p>
  85
  86 </body>
  87
  88 </html>