Imported upstream version 1.4~rc2.

[pkg-rrdtool.git] / doc / rrdtool.1

diff --git a/doc/rrdtool.1 b/doc/rrdtool.1
index 8212c4506d01c894d6e85ff193d74e6bd7e40890..e336c2ffa74c6c56b157c98b8a3207ab6f94d4f8 100644 (file)
--- a/doc/rrdtool.1
+++ b/doc/rrdtool.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -25,11 +25,11 @@
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDTOOL 1"
-.TH RRDTOOL 1 "2007-11-20" "1.2.26" "rrdtool"
+.TH RRDTOOL 1 "2009-05-26" "1.3.99909060808" "rrdtool"
 .SH "NAME"
 rrdtool \- Round Robin Database Tool
 .SH "SYNOPSIS"
@@ -162,9 +162,10 @@ While the man pages talk of command line switches you have to set in
 order to make \fBRRDtool\fR work it is important to note that
 \&\fBRRDtool\fR can be remotely controlled through a set of pipes. This
 saves a considerable amount of startup time when you plan to make
-\&\fBRRDtool\fR do a lot of things quickly. Check the section on \*(L"Remote Control\*(R" 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.
+\&\fBRRDtool\fR do a lot of things 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,
+\&\s-1PHP\s0, etc.
 .IP "\fBcreate\fR" 8
 .IX Item "create"
 Set up a new Round Robin Database (\s-1RRD\s0). Check rrdcreate.
@@ -204,7 +205,10 @@ Get information about an \s-1RRD\s0. Check rrdinfo.
 Change the size of individual RRAs. This is dangerous! Check rrdresize.
 .IP "\fBxport\fR" 8
 .IX Item "xport"
-Export data retrieved from one or several RRDs. Check rrdxport
+Export data retrieved from one or several RRDs. Check rrdxport.
+.IP "\fBflushcached\fR" 8
+.IX Item "flushcached"
+Flush the values for a specific \s-1RRD\s0 file from memory. Check rrdflushcached.
 .IP "\fBrrdcgi\fR" 8
 .IX Item "rrdcgi"
 This is a standalone tool for producing \s-1RRD\s0 graphs on the fly. Check
@@ -218,7 +222,7 @@ data available at a constant time interval. Unfortunately, you may not
 always be able to fetch data at exactly the time you want
 to. Therefore \fBRRDtool\fR lets you update the logfile at any time you
 want. It will automatically interpolate the value of the data-source
-(\fB\s-1DS\s0\fR) at the latest official time-slot (intervall) and write this
+(\fB\s-1DS\s0\fR) at the latest official time-slot (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.
@@ -362,7 +366,7 @@ followed by timing information of the form \fBu:\fR\fIusertime\fR
 \&\fBs:\fR\fIsystemtime\fR. Both values are the running totals of seconds since
 RRDtool was started. If an error occurs, a line of the form '\f(CW\*(C`ERROR:\*(C'\fR
 \&\fIDescription of error\fR' will be printed instead. \fBRRDtool\fR will not abort,
-unless something realy serious happens. If
+unless something really serious happens. If
 a \fBworkdir\fR is specified and the \s-1UID\s0 is 0, RRDtool will do a chroot to that
 workdir. If the \s-1UID\s0 is not 0, RRDtool only changes the current directory to
 \&\fBworkdir\fR.
@@ -389,15 +393,22 @@ With this configuration you can add RRDtool as meta-server to
 Don't forget to create the database directory /var/rrd and
 reinitialize your inetd.
 .PP
-If all was setup correctly, you can access the server with perl
+If all was setup correctly, you can access the server with Perl
 sockets, tools like netcat, or in a quick interactive test by using
 \&'telnet localhost rrdsrv'.
 .PP
 \&\fB\s-1NOTE:\s0\fR that there is no authentication with this feature! Do not setup
 such a port unless you are sure what you are doing.
+.SH "RRDCACHED, THE CACHING DAEMON"
+.IX Header "RRDCACHED, THE CACHING DAEMON"
+For very big setups, updating thousands of \s-1RRD\s0 files often becomes a serious \s-1IO\s0
+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.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
-rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast, rrdxport
+rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast, rrdxport,
+rrdflushcached, rrdcached
 .SH "BUGS"
 .IX Header "BUGS"
 Bugs? Features!