Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrdtool.txt
index fba608aa6e164ab84832cc92379d7b4652219028..113857ef4b10f51d817969067f5796c51a911bbe 100644 (file)
@@ -35,9 +35,9 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        order to make R\bRR\bRD\bDt\bto\boo\bol\bl work it is important to note that R\bRR\bRD\bDt\bto\boo\bol\bl can be
        remotely controlled through a set of pipes. This saves a considerable
        amount of startup time when you plan to make R\bRR\bRD\bDt\bto\boo\bol\bl do a lot of things
-       quickly. Check the section on "Remote Control" further down. There is
+       quickly. Check the section on Remote_Control further down. There is
        also a number of language bindings for RRDtool which allow you to use
-       it directly from perl, python, tcl, php, etc.
+       it directly from Perl, python, Tcl, PHP, etc.
 
        c\bcr\bre\bea\bat\bte\be  Set up a new Round Robin Database (RRD). Check rrdcreate.
 
@@ -70,7 +70,11 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                Change the size of individual RRAs. This is dangerous! Check
                rrdresize.
 
-       x\bxp\bpo\bor\brt\bt   Export data retrieved from one or several RRDs. Check rrdxport
+       x\bxp\bpo\bor\brt\bt   Export data retrieved from one or several RRDs. Check rrdxport.
+
+       f\bfl\blu\bus\bsh\bhc\bca\bac\bch\bhe\bed\bd
+               Flush the values for a specific RRD file from memory. Check
+               rrdflushcached.
 
        r\brr\brd\bdc\bcg\bgi\bi  This is a standalone tool for producing RRD graphs on the fly.
                Check rrdcgi.
@@ -85,7 +89,7 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                you want to. Therefore R\bRR\bRD\bDt\bto\boo\bol\bl lets you update the logfile at
                any time you want. It will automatically interpolate the value
                of the data-source (D\bDS\bS) at the latest official time-slot
-               (intervall) and write this interpolated value to the log. The
+               (interval) and write this interpolated value to the log. The
                original value you have supplied is stored as well and is also
                taken into account when interpolating the next log entry.
 
@@ -231,7 +235,7 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        Both values are the running totals of seconds since RRDtool was
        started. If an error occurs, a line of the form '"ERROR:" _\bD_\be_\bs_\bc_\br_\bi_\bp_\bt_\bi_\bo_\bn
        _\bo_\bf _\be_\br_\br_\bo_\br' will be printed instead. R\bRR\bRD\bDt\bto\boo\bol\bl will not abort, unless some-
-       thing realy serious happens. If a w\bwo\bor\brk\bkd\bdi\bir\br is specified and the UID is
+       thing really serious happens. If a w\bwo\bor\brk\bkd\bdi\bir\br is specified and the UID is
        0, RRDtool will do a chroot to that workdir. If the UID is not 0, RRD-
        tool only changes the current directory to w\bwo\bor\brk\bkd\bdi\bir\br.
 
@@ -254,16 +258,22 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        Don't forget to create the database directory /var/rrd and reinitialize
        your inetd.
 
-       If all was setup correctly, you can access the server with perl sock-
+       If all was setup correctly, you can access the server with Perl sock-
        ets, tools like netcat, or in a quick interactive test by using 'telnet
        localhost rrdsrv'.
 
        N\bNO\bOT\bTE\bE:\b: that there is no authentication with this feature! Do not setup
        such a port unless you are sure what you are doing.
 
+R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD,\b, T\bTH\bHE\bE C\bCA\bAC\bCH\bHI\bIN\bNG\bG D\bDA\bAE\bEM\bMO\bON\bN
+       For very big setups, updating thousands of RRD files often becomes a
+       serious IO problem. If you run into such problems, you might want to
+       take a look at rrdcached, a caching daemon for RRDTool which may help
+       you lessen the stress on your disks.
+
 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
        rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast,
-       rrdxport
+       rrdxport, rrdflushcached, rrdcached
 
 B\bBU\bUG\bGS\bS
        Bugs? Features!
@@ -273,4 +283,4 @@ A\bAU\bUT\bTH\bHO\bOR\bR
 
 
 
-1.3rc9                            2008-03-15                        RRDTOOL(1)
+1.3.99909060808                   2009-05-26                        RRDTOOL(1)