Code

Imported upstream version 1.3rc4.
[pkg-rrdtool.git] / doc / rrdtune.txt
index 0ce504666de1d35b164a71e40a983375b57a0b30..2d6d9e94a04626050abc019218562c045bdf7eed 100644 (file)
@@ -12,8 +12,9 @@ S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
        _\bn_\ba_\bm_\be:_\bn_\be_\bw_\b-_\bn_\ba_\bm_\be] [-\b--\b-d\bde\bel\blt\bta\bap\bpo\bos\bs _\bs_\bc_\ba_\bl_\be_\b-_\bv_\ba_\bl_\bu_\be] [-\b--\b-d\bde\bel\blt\bta\ban\bne\beg\bg _\bs_\bc_\ba_\bl_\be_\b-_\bv_\ba_\bl_\bu_\be]
        [-\b--\b-f\bfa\bai\bil\blu\bur\bre\be-\b-t\bth\bhr\bre\bes\bsh\bho\bol\bld\bd _\bf_\ba_\bi_\bl_\bu_\br_\be_\b-_\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd] [-\b--\b-w\bwi\bin\bnd\bdo\bow\bw-\b-l\ble\ben\bng\bgt\bth\bh _\bw_\bi_\bn_\bd_\bo_\bw_\b-_\bl_\be_\bn_\bg_\bt_\bh]
        [-\b--\b-a\bal\blp\bph\bha\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-b\bbe\bet\bta\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-g\bga\bam\bmm\bma\ba _\ba_\bd_\ba_\bp_\b-
-       _\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-g\bga\bam\bmm\bma\ba-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-a\bab\bbe\ber\br-\b-
-       r\bra\ban\bnt\bt-\b-r\bre\bes\bse\bet\bt _\bd_\bs_\b-_\bn_\ba_\bm_\be]
+       _\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-g\bga\bam\bmm\bma\ba-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-s\bsm\bmo\boo\bot\bth\bh-\b-
+       i\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-_\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn] [-\b--\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-
+       _\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn] [-\b--\b-a\bab\bbe\ber\brr\bra\ban\bnt\bt-\b-r\bre\bes\bse\bet\bt _\bd_\bs_\b-_\bn_\ba_\bm_\be]
 
 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        The tune option allows you to alter some of the basic configuration
@@ -99,19 +100,28 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                Alter the seasonal deviation adaptation parameter for the
                DEVSEASONAL R\bRR\bRA\bA. This parameter must be between 0 and 1.
 
+       -\b--\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-_\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn
+               Alter the size of the smoothing window for the SEASONAL R\bRR\bRA\bA.
+               This must be between 0 and 1.
+
+       -\b--\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-_\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn
+               Alter the size of the smoothing window for the DEVSEASONAL R\bRR\bRA\bA.
+               This must be between 0 and 1.
+
        -\b--\b-a\bab\bbe\ber\brr\bra\ban\bnt\bt-\b-r\bre\bes\bse\bet\bt _\bd_\bs_\b-_\bn_\ba_\bm_\be
                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 HWPREDICT R\bRR\bRA\bA, it
-               sets the intercept and slope coefficients to unknown. For the
-               SEASONAL R\bRR\bRA\bA, it sets all seasonal coefficients to unknown. For
-               the DEVSEASONAL R\bRR\bRA\bA, it sets all seasonal deviation coeffi-
-               cients to unknown. For the FAILURES R\bRR\bRA\bA, it erases the viola-
-               tion history. Note that reset does not erase past predictions
-               (the values of the HWPREDICT R\bRR\bRA\bA), predicted deviations (the
-               values of the DEVPREDICT R\bRR\bRA\bA), or failure history (the values
-               of the FAILURES R\bRR\bRA\bA).  This option will function even if not
-               all the listed R\bRR\bRA\bAs\bs are present.
+               has learnt so far.  Specifically, for the HWPREDICT or MHWPRE-
+               DICT R\bRR\bRA\bA, it sets the intercept and slope coefficients to
+               unknown. For the SEASONAL R\bRR\bRA\bA, it sets all seasonal coeffi-
+               cients to unknown. For the DEVSEASONAL R\bRR\bRA\bA, it sets all sea-
+               sonal deviation coefficients to unknown. For the FAILURES R\bRR\bRA\bA,
+               it erases the violation history. Note that reset does not erase
+               past predictions (the values of the HWPREDICT or MHWPREDICT
+               R\bRR\bRA\bA), predicted deviations (the values of the DEVPREDICT R\bRR\bRA\bA),
+               or failure history (the values of the FAILURES R\bRR\bRA\bA).  This
+               option will function even if not all the listed R\bRR\bRA\bAs\bs are
+               present.
 
                Due to the implementation of this option, there is an indirect
                impact on other data sources in the RRD. A smoothing algorithm
@@ -149,4 +159,4 @@ A\bAU\bUT\bTH\bHO\bOR\bR
 
 
 
-1.2.27                            2008-02-17                        RRDTUNE(1)
+1.3rc4                            2008-03-15                        RRDTUNE(1)