doc/rrdflushcached.html

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