Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrdflushcached.txt
diff --git a/doc/rrdflushcached.txt b/doc/rrdflushcached.txt
new file mode 100644 (file)
index 0000000..ef7be78
--- /dev/null
@@ -0,0 +1,43 @@
+RRDFLUSHCACHED(1)                   rrdtool                  RRDFLUSHCACHED(1)
+
+
+
+N\bNA\bAM\bME\bE
+       rrdflush - Flush the values for a spcific RRD file from memory.
+
+S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
+       r\brr\brd\bdt\bto\boo\bol\bl f\bfl\blu\bus\bsh\bhc\bca\bac\bch\bhe\bed\bd [-\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs] _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [_\bf_\bi_\bl_\be_\bn_\ba_\bm_\be ...]
+
+D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
+       The f\bfl\blu\bus\bsh\bhc\bca\bac\bch\bhe\bed\bd function connects to rrdcached, 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.
+
+       _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+               The name(s) of the R\bRR\bRD\bD file(s) that are to be written to disk.
+
+       -\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs
+               Address of the rrdcached daemon. If not specified, the RRD-
+               CACHED_ADDRESS environment variable must be set (see below).
+               For a list of accepted formats, see the -\b-l\bl option in the rrd-
+               cached manual.
+
+                rrdtool flush --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
+
+E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
+       The following environment variables may be used to change the behavior
+       of "rrdtool flushcached":
+
+       R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS
+           If this environment variable is set it will have the same effect as
+           specifying the "--daemon" option on the command line. If both are
+           present, the command line argument takes precedence.
+
+A\bAU\bUT\bTH\bHO\bOR\bR
+       Florian Forster <octo at verplant.org>
+
+
+
+1.3.99909060808                   2009-05-26                 RRDFLUSHCACHED(1)