Imported upstream version 1.3rc9.

[pkg-rrdtool.git] / doc / rrdtune.html

diff --git a/doc/rrdtune.html b/doc/rrdtune.html
index 7bd6cce32e49890ee45cf740b914e0b4fe8e049c..fe809e45ef4e011a1ed5fb41b310d7732a986c29 100644 (file)
--- a/doc/rrdtune.html
+++ b/doc/rrdtune.html
@@ -66,46 +66,40 @@ the data source header in the <strong>RRD</strong>.</p>
 <p>A second application of the <strong>tune</strong> function is to set or alter parameters
 used by the specialized function <strong>RRAs</strong> for aberrant behavior detection.</p>
 <dl>
-<dt><strong><a name="item_filename"><em>filename</em></a></strong>
+<dt><strong><a name="item_filename"><em>filename</em></a></strong></dt>
 
 <dd>
 <p>The name of the <strong>RRD</strong> you want to tune.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dheartbeat_7c_2dh_ds_2dname_3aheartbeat"><strong>--heartbeat</strong>|<strong>-h</strong>&nbsp;<em>ds-name</em>:<em>heartbeat</em></a></strong>
+<dt><strong><a name="item__2d_2dheartbeat_7c_2dh_ds_2dname_3aheartbeat"><strong>--heartbeat</strong>|<strong>-h</strong>&nbsp;<em>ds-name</em>:<em>heartbeat</em></a></strong></dt>
 
 <dd>
 <p>modify the <em>heartbeat</em> of a data source. By setting this to a high
 value the RRD will accept things like one value per day.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dminimum_7c_2di_ds_2dname_3amin"><strong>--minimum</strong>|<strong>-i</strong>&nbsp;<em>ds-name</em>:<em>min</em></a></strong>
+<dt><strong><a name="item__2d_2dminimum_7c_2di_ds_2dname_3amin"><strong>--minimum</strong>|<strong>-i</strong>&nbsp;<em>ds-name</em>:<em>min</em></a></strong></dt>
 
 <dd>
 <p>alter the minimum value acceptable as input from the data source.
 Setting <em>min</em> to 'U' will disable this limit.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dmaximum_7c_2da_ds_2dname_3amax"><strong>--maximum</strong>|<strong>-a</strong>&nbsp;<em>ds-name</em>:<em>max</em></a></strong>
+<dt><strong><a name="item__2d_2dmaximum_7c_2da_ds_2dname_3amax"><strong>--maximum</strong>|<strong>-a</strong>&nbsp;<em>ds-name</em>:<em>max</em></a></strong></dt>
 
 <dd>
 <p>alter the maximum value acceptable as input from the data source.
 Setting <em>max</em> to 'U' will disable this limit.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2ddata_2dsource_2dtype_7c_2dd_ds_2dname_3adst"><strong>--data-source-type</strong>|<strong>-d</strong>&nbsp;<em>ds-name</em>:<em>DST</em></a></strong>
+<dt><strong><a name="item__2d_2ddata_2dsource_2dtype_7c_2dd_ds_2dname_3adst"><strong>--data-source-type</strong>|<strong>-d</strong>&nbsp;<em>ds-name</em>:<em>DST</em></a></strong></dt>
 
 <dd>
 <p>alter the type <strong>DST</strong> of a data source.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2ddata_2dsource_2drename_7c_2dr_old_2dname_3an"><strong>--data-source-rename</strong>|<strong>-r</strong>&nbsp;<em>old-name</em>:<em>new-name</em></a></strong>
+<dt><strong><a name="item__2d_2ddata_2dsource_2drename_7c_2dr_old_2dname_3an"><strong>--data-source-rename</strong>|<strong>-r</strong>&nbsp;<em>old-name</em>:<em>new-name</em></a></strong></dt>
 
 <dd>
 <p>rename a data source.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2ddeltapos_scale_2dvalue"><strong>--deltapos</strong>&nbsp;<em>scale-value</em></a></strong>
+<dt><strong><a name="item__2d_2ddeltapos_scale_2dvalue"><strong>--deltapos</strong>&nbsp;<em>scale-value</em></a></strong></dt>
 
 <dd>
 <p>Alter the deviation scaling factor for the upper bound of the
@@ -116,8 +110,7 @@ CDEF argument to generate a graph with confidence bounds. The graph
 scale factor need not to agree with the value used internally by the
 FAILURES <strong>RRA</strong>.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2ddeltaneg_scale_2dvalue"><strong>--deltaneg</strong>&nbsp;<em>scale-value</em></a></strong>
+<dt><strong><a name="item__2d_2ddeltaneg_scale_2dvalue"><strong>--deltaneg</strong>&nbsp;<em>scale-value</em></a></strong></dt>
 
 <dd>
 <p>Alter the deviation scaling factor for the lower bound of the confidence band
@@ -125,8 +118,7 @@ used internally to calculate violations for the FAILURES <strong>RRA</strong>. T
 value is 2. As with <strong>--deltapos</strong>, this argument is unrelated to the scale
 factor chosen when graphing confidence bounds.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dfailure_2dthreshold_failure_2dthreshold"><strong>--failure-threshold</strong>&nbsp;<em>failure-threshold</em></a></strong>
+<dt><strong><a name="item__2d_2dfailure_2dthreshold_failure_2dthreshold"><strong>--failure-threshold</strong>&nbsp;<em>failure-threshold</em></a></strong></dt>
 
 <dd>
 <p>Alter the number of confidence bound violations that constitute a failure for
@@ -135,8 +127,7 @@ the window length of the FAILURES <strong>RRA</strong>. This restriction is not
 the tune option, so one can reset failure-threshold and window-length
 simultaneously. Setting this option will reset the count of violations to 0.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dwindow_2dlength_window_2dlength"><strong>--window-length</strong>&nbsp;<em>window-length</em></a></strong>
+<dt><strong><a name="item__2d_2dwindow_2dlength_window_2dlength"><strong>--window-length</strong>&nbsp;<em>window-length</em></a></strong></dt>
 
 <dd>
 <p>Alter the number of time points in the temporal window for determining
@@ -144,50 +135,43 @@ failures. This must be an integer greater than or equal to the window
 length of the FAILURES <strong>RRA</strong> and less than or equal to 28. Setting
 this option will reset the count of violations to 0.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dalpha_adaption_2dparameter"><strong>--alpha</strong>&nbsp;<em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dalpha_adaption_2dparameter"><strong>--alpha</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 
 <dd>
 <p>Alter the intercept adaptation parameter for the Holt-Winters
 forecasting algorithm. This parameter must be between 0 and 1.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dbeta_adaption_2dparameter"><strong>--beta</strong>&nbsp;<em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dbeta_adaption_2dparameter"><strong>--beta</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 
 <dd>
 <p>Alter the slope adaptation parameter for the Holt-Winters forecasting
 algorithm. This parameter must be between 0 and 1.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dgamma_adaption_2dparameter"><strong>--gamma</strong>&nbsp;<em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dgamma_adaption_2dparameter"><strong>--gamma</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 
 <dd>
 <p>Alter the seasonal coefficient adaptation parameter for the SEASONAL
 <strong>RRA</strong>. This parameter must be between 0 and 1.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dgamma_2ddeviation_adaption_2dparameter"><strong>--gamma-deviation</strong>&nbsp;<em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dgamma_2ddeviation_adaption_2dparameter"><strong>--gamma-deviation</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 
 <dd>
 <p>Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
 <strong>RRA</strong>. This parameter must be between 0 and 1.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dsmoothing_2dwindow_fraction_2dof_2dseason"><strong>--smoothing-window</strong>&nbsp;<em>fraction-of-season</em></a></strong>
+<dt><strong><a name="item__2d_2dsmoothing_2dwindow_fraction_2dof_2dseason"><strong>--smoothing-window</strong>&nbsp;<em>fraction-of-season</em></a></strong></dt>
 
 <dd>
 <p>Alter the size of the smoothing window for the SEASONAL <strong>RRA</strong>. This must
 be between 0 and 1.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2dsmoothing_2dwindow_2ddeviation_fraction_2dof"><strong>--smoothing-window-deviation</strong>&nbsp;<em>fraction-of-season</em></a></strong>
+<dt><strong><a name="item__2d_2dsmoothing_2dwindow_2ddeviation_fraction_2dof"><strong>--smoothing-window-deviation</strong>&nbsp;<em>fraction-of-season</em></a></strong></dt>
 
 <dd>
 <p>Alter the size of the smoothing window for the DEVSEASONAL <strong>RRA</strong>. This must
 be between 0 and 1.</p>
 </dd>
-</li>
-<dt><strong><a name="item__2d_2daberrant_2dreset_ds_2dname"><strong>--aberrant-reset</strong>&nbsp;<em>ds-name</em></a></strong>
+<dt><strong><a name="item__2d_2daberrant_2dreset_ds_2dname"><strong>--aberrant-reset</strong>&nbsp;<em>ds-name</em></a></strong></dt>
 
 <dd>
 <p>This option causes the aberrant behavior detection algorithm to reset
@@ -201,8 +185,6 @@ violation history. Note that reset does not erase past predictions
 values of the DEVPREDICT <strong>RRA</strong>), or failure history (the values of the 
 FAILURES <strong>RRA</strong>).  This option will function even if not all the listed 
 <strong>RRAs</strong> are present.</p>
-</dd>
-<dd>
 <p>Due to the implementation of this option, there is an indirect impact on
 other data sources in the RRD. A smoothing algorithm is applied to
 SEASONAL and DEVSEASONAL values on a periodic basis. During bootstrap
@@ -213,12 +195,9 @@ for all data sources in the file. This is unlikely to have serious
 consequences, unless the data being collected for the non-reset data sources
 is unusually volatile during the reinitialization period of the reset
 data source.</p>
-</dd>
-<dd>
 <p>Use of this tuning option is advised when the behavior of the data source
 time series changes in a drastic and permanent manner.</p>
 </dd>
-</li>
 </dl>
 <p>
 </p>