Imported upstream version 1.4.2.

[pkg-rrdtool.git] / doc / rrdcached.txt

diff --git a/doc/rrdcached.txt b/doc/rrdcached.txt
index fdacd186880328a23acaf738bed73492233e0f1e..a550a5613af4ce7025839b4f7df1e03f41e2b9cd 100644 (file)
--- a/doc/rrdcached.txt
+++ b/doc/rrdcached.txt
@@ -19,7 +19,7 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
 
        The daemon was written with big setups in mind. Those setups usually
        run into IO related problems sooner or later for reasons that are
-       beyond the scope of this document. Check the wiki at the RRDTool
+       beyond the scope of this document. Check the wiki at the RRDtool
        homepage for details. Also check "SECURITY CONSIDERATIONS" below before
        using this daemon! A detailed description of how the daemon operates
        can be found in the "HOW IT WORKS" section below.
@@ -73,9 +73,9 @@ O\bOP\bPT\bTI\bIO\bON\bNS\bS
            A complete list of available commands can be found in the section
            "Valid Commands" below. There are two minor special exceptions:
 
-           ·   The "HELP" and "QUIT" commands are always allowed.
+           ·   The "HELP" and "QUIT" commands are always allowed.
 
-           ·   If the "BATCH" command is accepted, the .\b. command will
+           ·   If the "BATCH" command is accepted, the .\b. command will
                automatically be accepted, too.
 
            Please also read "SECURITY CONSIDERATIONS" below.
@@ -173,16 +173,25 @@ A\bAF\bFF\bFE\bEC\bCT\bTE\bED\bD R\bRR\bRD\bDT\bTO\bOO\bOL\bL C\bCO\bOM\bMM\bMA\bAN\bND\bDS\bS
        command line argument -\b--\b-d\bda\bae\bem\bmo\bon\bn or the environment variable
        R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS:
 
-       d\bdu\bum\bmp\bp
-       f\bfe\bet\btc\bch\bh
-       f\bfl\blu\bus\bsh\bh
-       g\bgr\bra\bap\bph\bh
-       g\bgr\bra\bap\bph\bhv\bv
-       i\bin\bnf\bfo\bo
-       l\bla\bas\bst\bt
-       l\bla\bas\bst\btu\bup\bpd\bda\bat\bte\be
-       u\bup\bpd\bda\bat\bte\be
-       x\bxp\bpo\bor\brt\bt
+       ·   dump
+
+       ·   fetch
+
+       ·   flush
+
+       ·   graph
+
+       ·   graphv
+
+       ·   info
+
+       ·   last
+
+       ·   lastupdate
+
+       ·   update
+
+       ·   xport
 
        The u\bup\bpd\bda\bat\bte\be command can send values to the daemon instead of writing
        them to the disk itself. All other commands can send a F\bFL\bLU\bUS\bSH\bH command
@@ -209,7 +218,7 @@ H\bHO\bOW\bW I\bIT\bT W\bWO\bOR\bRK\bKS\bS
        When appending a value to a tree node, it is checked whether it's time
        to write the values to disk. Values are written to disk if
        "now() - First >= timeout", where "timeout" is the timeout specified
-       using the -\b-w\bw option, see OPTIONS. If the values are "old enough" they
+       using the -\b-w\bw option, see "OPTIONS". If the values are "old enough" they
        will be enqueued in the "update queue", i. e. they will be appended to
        the linked list shown below.  Because the tree nodes and the elements
        of the linked list are the same data structures in memory, any update
@@ -264,19 +273,19 @@ H\bHO\bOW\bW I\bIT\bT W\bWO\bOR\bRK\bKS\bS
 
        The above diagram demonstrates:
 
-       ·   Files/values are stored in a (balanced) tree.
+       ·   Files/values are stored in a (balanced) tree.
 
-       ·   Tree nodes and entries in the update queue are the same data
+       ·   Tree nodes and entries in the update queue are the same data
            structure.
 
-       ·   The local time ("First") and the time specified in updates ("Time")
+       ·   The local time ("First") and the time specified in updates ("Time")
            may differ.
 
-       ·   Timed out values are inserted at the "tail".
+       ·   Timed out values are inserted at the "tail".
 
-       ·   Explicitly flushed values are inserted at the "head".
+       ·   Explicitly flushed values are inserted at the "head".
 
-       ·   ASCII art rocks.
+       ·   ASCII art rocks.
 
 S\bSE\bEC\bCU\bUR\bRI\bIT\bTY\bY C\bCO\bON\bNS\bSI\bID\bDE\bER\bRA\bAT\bTI\bIO\bON\bNS\bS
    A\bAu\but\bth\bhe\ben\bnt\bti\bic\bca\bat\bti\bio\bon\bn
@@ -322,11 +331,11 @@ S\bSE\bEC\bCU\bUR\bRI\bIT\bTY\bY C\bCO\bON\bNS\bSI\bID\bDE\bER\bRA\bAT\bTI\bIO\bON\bNS\bS
        the future, your files will be messed up good!
 
    C\bCo\bon\bnc\bcl\blu\bus\bsi\bio\bon\bn
-       ·   Security is the job of the administrator.
+       ·   Security is the job of the administrator.
 
-       ·   We recommend to allow write access via UNIX domain sockets only.
+       ·   We recommend to allow write access via UNIX domain sockets only.
 
-       ·   You have been warned.
+       ·   You have been warned.
 
 P\bPR\bRO\bOT\bTO\bOC\bCO\bOL\bL
        The daemon communicates with clients using a line based ASCII protocol
@@ -525,12 +534,13 @@ S\bSE\bEE\bE A\bAL\bLS\bSO\bO
        rrdtool, rrdgraph
 
 A\bAU\bUT\bTH\bHO\bOR\bR
-       r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd and this manual page have been written by Florian Forster
-       <octo at verplant.org>.
+       Florian Forster <octo at verplant.org>
+
+       Both r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd and this manual page have been written by Florian.
 
 C\bCO\bON\bNT\bTR\bRI\bIB\bBU\bUT\bTO\bOR\bRS\bS
        kevin brintnall <kbrint@rufus.net>
 
 
 
-1.3.999                           2009-09-24                      RRDCACHED(1)
+1.4.2                             2009-11-15                      RRDCACHED(1)