Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrdflushcached.html
diff --git a/doc/rrdflushcached.html b/doc/rrdflushcached.html
new file mode 100644 (file)
index 0000000..ba633d8
--- /dev/null
@@ -0,0 +1,88 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>rrdflushcached</title>
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
+<!--
+
+<ul>
+
+       <li><a href="#name">NAME</a></li>
+       <li><a href="#synopsis">SYNOPSIS</a></li>
+       <li><a href="#description">DESCRIPTION</a></li>
+       <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
+       <li><a href="#author">AUTHOR</a></li>
+</ul>
+-->
+<!-- INDEX END -->
+
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>rrdflush - Flush the values for a spcific RRD file from memory.</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<p><strong>rrdtool</strong> <strong>flushcached</strong>
+[<strong>--daemon</strong>&nbsp;<em>address</em>]
+<em>filename</em> [<em>filename</em> ...]</p>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>The <strong>flushcached</strong> function connects to <a href="././rrdcached.html">the rrdcached manpage</a>, the RRD caching daemon,
+and issues a ``flush'' command for the given files. The daemon will put the
+files to the head of the update queue so they are written ``soon''. The
+status will be returned only after the files' pending updates have been
+written to disk.</p>
+<dl>
+<dt><strong><a name="item_filename"><em>filename</em></a></strong><br />
+</dt>
+<dd>
+The <code>name(s)</code> of the <strong>RRD</strong> <code>file(s)</code> that are to be written to disk.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2ddaemon_address"><strong>--daemon</strong> <em>address</em></a></strong><br />
+</dt>
+<dd>
+Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If not specified, the
+RRDCACHED_ADDRESS environment variable must be set (see below).  For a
+list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a>
+manual.
+</dd>
+<dd>
+<pre>
+ rrdtool flush --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
+</dd>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
+<p>The following environment variables may be used to change the behavior of
+<code>rrdtoolflushcached</code>:</p>
+<dl>
+<dt><strong><a name="item_rrdcached_address"><strong>RRDCACHED_ADDRESS</strong></a></strong><br />
+</dt>
+<dd>
+If this environment variable is set it will have the same effect as specifying
+the <code>--daemon</code> option on the command line. If both are present, the command
+line argument takes precedence.
+</dd>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="author">AUTHOR</a></h1>
+<p>Florian Forster &lt;octo&nbsp;at&nbsp;verplant.org&gt;</p>
+
+</body>
+
+</html>