Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrdtool.1
index baa71dfe532ec0b842e53e66af7de9f1c30a80a9..e336c2ffa74c6c56b157c98b8a3207ab6f94d4f8 100644 (file)
@@ -1,7 +1,15 @@
-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" 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
 ..
 .\" 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-
 .    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 (.SS), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.ie \nF \{\
+.if \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.el \{\
-.    de IX
-..
-.\}
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "RRDTOOL 1"
-.TH RRDTOOL 1 "2008-12-22" "1.3.8" "rrdtool"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.if n .ad l
-.nh
+.TH RRDTOOL 1 "2009-05-26" "1.3.99909060808" "rrdtool"
 .SH "NAME"
 rrdtool \- Round Robin Database Tool
 .SH "SYNOPSIS"
@@ -136,7 +137,7 @@ rrdtool \- Round Robin Database Tool
 \&\fBrrdtool\fR \fB\-\fR [workdir]| \fIfunction\fR
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
-.SS "\s-1OVERVIEW\s0"
+.Sh "\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
@@ -155,7 +156,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.
-.SS "\s-1FUNCTIONS\s0"
+.Sh "\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
@@ -204,12 +205,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.
-.SS "\s-1HOW\s0 \s-1DOES\s0 \s-1RRDTOOL\s0 \s-1WORK\s0?"
+.Sh "\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"
@@ -293,12 +297,12 @@ by Jake Brutlag
 \&\fBRRDtool\fR provides the building blocks for near real-time aberrant
 behavior detection. These components include:
 .RS 8
-.IP "\(bu" 4
+.IP "*" 4
 An algorithm for predicting the value of a time series one time step
 into the future.
-.IP "\(bu" 4
+.IP "*" 4
 A measure of deviation between predicted and observed values.
-.IP "\(bu" 4
+.IP "*" 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 +347,7 @@ initiate real-time alerts.
 .Sp
 For a detailed description on how to set this up, see rrdcreate.
 .RE
-.SS "\s-1REMOTE\s0 \s-1CONTROL\s0"
+.Sh "\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
@@ -366,9 +370,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.
-.SS "\s-1RRD\s0 Server"
+.Sh "\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
@@ -395,9 +399,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!