diff --git a/doc/rrdtune.1 b/doc/rrdtune.1
index a961ee86f35fd7dfa7bfbcd62628d59b91ae73aa..ca04a686e11ba501949c50095b907f86dc8d728d 100644 (file)
--- a/doc/rrdtune.1
+++ b/doc/rrdtune.1
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
. 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.
.\" ========================================================================
.\"
.IX Title "RRDTUNE 1"
-.TH RRDTUNE 1 "2008-02-17" "1.2.27" "rrdtool"
+.TH RRDTUNE 1 "2013-05-23" "1.4.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
.SH "NAME"
rrdtune \- Modify some basic properties of a Round Robin Database
.SH "SYNOPSIS"
[\fB\-\-beta\fR\ \fIadaption-parameter\fR]
[\fB\-\-gamma\fR\ \fIadaption-parameter\fR]
[\fB\-\-gamma\-deviation\fR\ \fIadaption-parameter\fR]
+[\fB\-\-smoothing\-window\fR\ \fIfraction-of-season\fR]
+[\fB\-\-smoothing\-window\-deviation\fR\ \fIfraction-of-season\fR]
[\fB\-\-aberrant\-reset\fR\ \fIds-name\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.IX Item "--gamma-deviationadaption-parameter"
Alter the seasonal deviation adaptation parameter for the \s-1DEVSEASONAL\s0
\&\fB\s-1RRA\s0\fR. This parameter must be between 0 and 1.
+.IP "\fB\-\-smoothing\-window\fR\ \fIfraction-of-season\fR" 8
+.IX Item "--smoothing-windowfraction-of-season"
+Alter the size of the smoothing window for the \s-1SEASONAL\s0 \fB\s-1RRA\s0\fR. This must
+be between 0 and 1.
+.IP "\fB\-\-smoothing\-window\-deviation\fR\ \fIfraction-of-season\fR" 8
+.IX Item "--smoothing-window-deviationfraction-of-season"
+Alter the size of the smoothing window for the \s-1DEVSEASONAL\s0 \fB\s-1RRA\s0\fR. This must
+be between 0 and 1.
.IP "\fB\-\-aberrant\-reset\fR\ \fIds-name\fR" 8
.IX Item "--aberrant-resetds-name"
This option causes the aberrant behavior detection algorithm to reset
for the specified data source; that is, forget all it is has learnt so far.
-Specifically, for the \s-1HWPREDICT\s0 \fB\s-1RRA\s0\fR, it sets the intercept and slope
-coefficients to unknown. For the \s-1SEASONAL\s0 \fB\s-1RRA\s0\fR, it sets all seasonal
+Specifically, for the \s-1HWPREDICT\s0 or \s-1MHWPREDICT\s0 \fB\s-1RRA\s0\fR, it sets the intercept and
+slope coefficients to unknown. For the \s-1SEASONAL\s0 \fB\s-1RRA\s0\fR, it sets all seasonal
coefficients to unknown. For the \s-1DEVSEASONAL\s0 \fB\s-1RRA\s0\fR, it sets all seasonal
-deviation coefficients to unknown. For the \s-1FAILURES\s0 \fB\s-1RRA\s0\fR, it erases
-the violation history. Note that reset does not erase past predictions
-(the values of the \s-1HWPREDICT\s0 \fB\s-1RRA\s0\fR), predicted deviations (the values of the
-\&\s-1DEVPREDICT\s0 \fB\s-1RRA\s0\fR), or failure history (the values of the \s-1FAILURES\s0 \fB\s-1RRA\s0\fR).
-This option will function even if not all the listed \fBRRAs\fR are present.
+deviation coefficients to unknown. For the \s-1FAILURES\s0 \fB\s-1RRA\s0\fR, it erases the
+violation history. Note that reset does not erase past predictions
+(the values of the \s-1HWPREDICT\s0 or \s-1MHWPREDICT\s0 \fB\s-1RRA\s0\fR), predicted deviations (the
+values of the \s-1DEVPREDICT\s0 \fB\s-1RRA\s0\fR), or failure history (the values of the
+\&\s-1FAILURES\s0 \fB\s-1RRA\s0\fR). This option will function even if not all the listed
+\&\fBRRAs\fR are present.
.Sp
Due to the implementation of this option, there is an indirect impact on
other data sources in the \s-1RRD\s0. A smoothing algorithm is applied to