X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdtool.1;h=5f82b61f07c558c39f14334e6552723d7d7d136e;hb=fd248121a4d1324289fcb6d0429613c6708cd559;hp=634b4a1eec9d60d466a151231c673d71440a424c;hpb=1559397b94b4af3de73cfa23c04be31d8bee53e7;p=pkg-rrdtool.git

diff --git a/doc/rrdtool.1 b/doc/rrdtool.1
index 634b4a1..5f82b61 100644
--- a/doc/rrdtool.1
+++ b/doc/rrdtool.1
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
@@ -48,22 +40,25 @@
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
@@ -129,7 +124,11 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDTOOL 1"
-.TH RRDTOOL 1 "2008-12-22" "1.3.7" "rrdtool"
+.TH RRDTOOL 1 "2009-10-14" "1.4.3" "rrdtool"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
 .SH "NAME"
 rrdtool \- Round Robin Database Tool
 .SH "SYNOPSIS"
@@ -137,7 +136,7 @@ rrdtool \- Round Robin Database Tool
 \&\fBrrdtool\fR \fB\-\fR [workdir]| \fIfunction\fR
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
-.Sh "\s-1OVERVIEW\s0"
+.SS "\s-1OVERVIEW\s0"
 .IX Subsection "OVERVIEW"
 It is pretty easy to gather status information from all sorts of
 things, ranging from the temperature in your office to the number of
@@ -156,7 +155,7 @@ detailed description of how to use the individual functions of
 .PP
 For an introduction to the usage of RRDtool make sure you consult the
 rrdtutorial.
-.Sh "\s-1FUNCTIONS\s0"
+.SS "\s-1FUNCTIONS\s0"
 .IX Subsection "FUNCTIONS"
 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
@@ -205,19 +204,22 @@ 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
 rrdcgi.
-.Sh "\s-1HOW\s0 \s-1DOES\s0 \s-1RRDTOOL\s0 \s-1WORK\s0?"
+.SS "\s-1HOW\s0 \s-1DOES\s0 \s-1RRDTOOL\s0 \s-1WORK\s0?"
 .IX Subsection "HOW DOES RRDTOOL WORK?"
 .IP "Data Acquisition" 8
 .IX Item "Data Acquisition"
 When monitoring the state of a system, it is convenient to have the
 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
+to. Therefore \fBRRDtool\fR lets you update the log file 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 (interval) and write this
 interpolated value to the log. The original value you have supplied is
@@ -294,12 +296,12 @@ by Jake Brutlag
 \&\fBRRDtool\fR provides the building blocks for near real-time aberrant
 behavior detection. These components include:
 .RS 8
-.IP "*" 4
+.IP "\(bu" 4
 An algorithm for predicting the value of a time series one time step
 into the future.
-.IP "*" 4
+.IP "\(bu" 4
 A measure of deviation between predicted and observed values.
-.IP "*" 4
+.IP "\(bu" 4
 A mechanism to decide if and when an observed value or sequence of
 observed values is \fItoo deviant\fR from the predicted value(s).
 .RE
@@ -344,7 +346,7 @@ initiate real-time alerts.
 .Sp
 For a detailed description on how to set this up, see rrdcreate.
 .RE
-.Sh "\s-1REMOTE\s0 \s-1CONTROL\s0"
+.SS "\s-1REMOTE\s0 \s-1CONTROL\s0"
 .IX Subsection "REMOTE CONTROL"
 When you start \fBRRDtool\fR with the command line option '\fB\-\fR' it waits
 for input via standard input (\s-1STDIN\s0). With this feature you can
@@ -367,9 +369,9 @@ 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.
-.Sh "\s-1RRD\s0 Server"
+.SS "\s-1RRD\s0 Server"
 .IX Subsection "RRD Server"
-If you want to create a RRD\-Server, you must choose a \s-1TCP/IP\s0 Service
+If you want to create a RRD-Server, you must choose a \s-1TCP/IP\s0 Service
 number and add them to \fI/etc/services\fR like this:
 .PP
 .Vb 1
@@ -396,9 +398,16 @@ sockets, tools like netcat, or in a quick interactive test by using
 .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!