X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdtool.1;h=3fe94f609035d1b653a79ebdd07cc0f5b9debb20;hb=645054bac6187b0e83fd4125fd59e4feda216b64;hp=eb7a463483c78e91f132ea78de06ec5b004319ff;hpb=ba531669d795b10244c358135249016c5898519b;p=pkg-rrdtool.git

diff --git a/doc/rrdtool.1 b/doc/rrdtool.1
index eb7a463..3fe94f6 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.08)
 .\"
 .\" 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-03-15" "1.3rc6" "rrdtool"
+.TH RRDTOOL 1 "2009-06-09" "1.3.999" "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,15 +155,16 @@ 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
 \&\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,12 +204,15 @@ 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"
@@ -218,7 +221,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.
@@ -293,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
@@ -343,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
@@ -362,13 +365,13 @@ 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.
-.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
@@ -389,15 +392,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!