Code

The tcl binding supports tcl < 8.5, too.
[pkg-rrdtool.git] / doc / rrdcreate.txt
index 64d1633d675ef91b5dd4324d8466d828b2c061e7..fafa9c39fe7cee4e3ea2e161d595c3fb1e42b3cb 100644 (file)
@@ -7,7 +7,7 @@ N\bNA\bAM\bME\bE
 
 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
        r\brr\brd\bdt\bto\boo\bol\bl c\bcr\bre\bea\bat\bte\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [-\b--\b-s\bst\bta\bar\brt\bt|-\b-b\bb _\bs_\bt_\ba_\br_\bt _\bt_\bi_\bm_\be] [-\b--\b-s\bst\bte\bep\bp|-\b-s\bs _\bs_\bt_\be_\bp]
-       [D\bDS\bS:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bD_\bS_\bT:\b:_\bd_\bs_\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs] [R\bRR\bRA\bA:\b:_\bC_\bF:\b:_\bc_\bf _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs]
+       [-\b--\b-n\bno\bo-\b-o\bov\bve\ber\brw\bwr\bri\bit\bte\be] [D\bDS\bS:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bD_\bS_\bT:\b:_\bd_\bs_\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs] [R\bRR\bRA\bA:\b:_\bC_\bF:\b:_\bc_\bf _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs]
 
 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        The create function of RRDtool lets you set up new Round Robin Database
@@ -30,6 +30,9 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        Specifies the base interval in seconds with which data will be fed into
        the R\bRR\bRD\bD.
 
+   -\b--\b-n\bno\bo-\b-o\bov\bve\ber\brw\bwr\bri\bit\bte\be
+       Do not clobber an existing file of the same name.
+
    D\bDS\bS:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bD_\bS_\bT:\b:_\bd_\bs_\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs
        A single R\bRR\bRD\bD can accept input from several data sources (D\bDS\bS), for
        example incoming and outgoing traffic on a specific communication line.
@@ -117,11 +120,12 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        assumed to be _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*.
 
        _\bm_\bi_\bn and _\bm_\ba_\bx define the expected range values for data supplied by a
-       data source. If _\bm_\bi_\bn and/or _\bm_\ba_\bx any value outside the defined range will
-       be regarded as _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*. If you do not know or care about min and max,
-       set them to U for unknown. Note that min and max always refer to the
-       processed values of the DS. For a traffic-C\bCO\bOU\bUN\bNT\bTE\bER\bR type DS this would be
-       the maximum and minimum data-rate expected from the device.
+       data source. If _\bm_\bi_\bn and/or _\bm_\ba_\bx are specified any value outside the
+       defined range will be regarded as _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*. If you do not know or care
+       about min and max, set them to U for unknown. Note that min and max
+       always refer to the processed values of the DS. For a traffic-C\bCO\bOU\bUN\bNT\bTE\bER\bR
+       type DS this would be the maximum and minimum data-rate expected from
+       the device.
 
        _\bI_\bf _\bi_\bn_\bf_\bo_\br_\bm_\ba_\bt_\bi_\bo_\bn _\bo_\bn _\bm_\bi_\bn_\bi_\bm_\ba_\bl_\b/_\bm_\ba_\bx_\bi_\bm_\ba_\bl _\be_\bx_\bp_\be_\bc_\bt_\be_\bd _\bv_\ba_\bl_\bu_\be_\bs _\bi_\bs _\ba_\bv_\ba_\bi_\bl_\ba_\bb_\bl_\be_\b, _\ba_\bl_\bw_\ba_\by_\bs
        _\bs_\be_\bt _\bt_\bh_\be _\bm_\bi_\bn _\ba_\bn_\bd_\b/_\bo_\br _\bm_\ba_\bx _\bp_\br_\bo_\bp_\be_\br_\bt_\bi_\be_\bs_\b. _\bT_\bh_\bi_\bs _\bw_\bi_\bl_\bl _\bh_\be_\bl_\bp _\bR_\bR_\bD_\bt_\bo_\bo_\bl _\bi_\bn _\bd_\bo_\bi_\bn_\bg _\ba
@@ -188,19 +192,19 @@ A\bAb\bbe\ber\brr\bra\ban\bnt\bt B\bBe\beh\bha\bav\bvi\bio\bor\br D\bDe\bet\bte\bec\bct\bti\bio\bon\bn w\b
        Winters forecasting algorithm), confidence bands, and the flagging
        aberrant behavior in the data source time series:
 
-       Â·   R\bRR\bRA\bA:\b:_\bH_\bW_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\ba_\bl_\bp_\bh_\ba:\b:_\bb_\be_\bt_\ba:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd[:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm]
+       ·   R\bRR\bRA\bA:\b:_\bH_\bW_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\ba_\bl_\bp_\bh_\ba:\b:_\bb_\be_\bt_\ba:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd[:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm]
 
-       Â·   R\bRR\bRA\bA:\b:_\bM_\bH_\bW_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\ba_\bl_\bp_\bh_\ba:\b:_\bb_\be_\bt_\ba:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd[:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm]
+       ·   R\bRR\bRA\bA:\b:_\bM_\bH_\bW_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\ba_\bl_\bp_\bh_\ba:\b:_\bb_\be_\bt_\ba:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd[:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm]
 
-       Â·   R\bRR\bRA\bA:\b:_\bS_\bE_\bA_\bS_\bO_\bN_\bA_\bL:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd:\b:_\bg_\ba_\bm_\bm_\ba:\b:_\br_\br_\ba_\b-
+       ·   R\bRR\bRA\bA:\b:_\bS_\bE_\bA_\bS_\bO_\bN_\bA_\bL:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd:\b:_\bg_\ba_\bm_\bm_\ba:\b:_\br_\br_\ba_\b-
            _\bn_\bu_\bm[:\b:s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw=\b=_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn]
 
-       Â·   R\bRR\bRA\bA:\b:_\bD_\bE_\bV_\bS_\bE_\bA_\bS_\bO_\bN_\bA_\bL:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd:\b:_\bg_\ba_\bm_\bm_\ba:\b:_\br_\br_\ba_\b-
+       ·   R\bRR\bRA\bA:\b:_\bD_\bE_\bV_\bS_\bE_\bA_\bS_\bO_\bN_\bA_\bL:\b:_\bs_\be_\ba_\bs_\bo_\bn_\ba_\bl _\bp_\be_\br_\bi_\bo_\bd:\b:_\bg_\ba_\bm_\bm_\ba:\b:_\br_\br_\ba_\b-
            _\bn_\bu_\bm[:\b:s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw=\b=_\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn]
 
-       Â·   R\bRR\bRA\bA:\b:_\bD_\bE_\bV_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm
+       ·   R\bRR\bRA\bA:\b:_\bD_\bE_\bV_\bP_\bR_\bE_\bD_\bI_\bC_\bT:\b:_\br_\bo_\bw_\bs:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm
 
-       Â·   R\bRR\bRA\bA:\b:_\bF_\bA_\bI_\bL_\bU_\bR_\bE_\bS:\b:_\br_\bo_\bw_\bs:\b:_\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd:\b:_\bw_\bi_\bn_\bd_\bo_\bw _\bl_\be_\bn_\bg_\bt_\bh:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm
+       ·   R\bRR\bRA\bA:\b:_\bF_\bA_\bI_\bL_\bU_\bR_\bE_\bS:\b:_\br_\bo_\bw_\bs:\b:_\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd:\b:_\bw_\bi_\bn_\bd_\bo_\bw _\bl_\be_\bn_\bg_\bt_\bh:\b:_\br_\br_\ba_\b-_\bn_\bu_\bm
 
        These R\bRR\bRA\bAs\bs differ from the true consolidation functions in several
        ways.  First, each of the R\bRR\bRA\bAs is updated once for every primary data
@@ -310,15 +314,15 @@ A\bAb\bbe\ber\brr\bra\ban\bnt\bt B\bBe\beh\bha\bav\bvi\bio\bor\br D\bDe\bet\bte\bec\bct\bti\bio\bon\bn w\b
        The dependent R\bRR\bRA\bA for each R\bRR\bRA\bA requiring the _\br_\br_\ba_\b-_\bn_\bu_\bm argument is listed
        here:
 
-       Â·   HWPREDICT _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the SEASONAL R\bRR\bRA\bA.
+       ·   HWPREDICT _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the SEASONAL R\bRR\bRA\bA.
 
-       Â·   SEASONAL _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the HWPREDICT R\bRR\bRA\bA.
+       ·   SEASONAL _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the HWPREDICT R\bRR\bRA\bA.
 
-       Â·   DEVPREDICT _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the DEVSEASONAL R\bRR\bRA\bA.
+       ·   DEVPREDICT _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the DEVSEASONAL R\bRR\bRA\bA.
 
-       Â·   DEVSEASONAL _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the HWPREDICT R\bRR\bRA\bA.
+       ·   DEVSEASONAL _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the HWPREDICT R\bRR\bRA\bA.
 
-       Â·   FAILURES _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the DEVSEASONAL R\bRR\bRA\bA.
+       ·   FAILURES _\br_\br_\ba_\b-_\bn_\bu_\bm is the index of the DEVSEASONAL R\bRR\bRA\bA.
 
        _\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd is the minimum number of violations (observed values outside
        the confidence bounds) within a window that constitutes a failure. If
@@ -352,8 +356,8 @@ T\bTh\bhe\be H\bHE\bEA\bAR\bRT\bTB\bBE\bEA\bAT\bT a\ban\bnd\bd t\bth\bhe\be S\bST\bTE\bEP\bP
        average rate for that PDP. If the total "unknown" time accounts for
        more than h\bha\bal\blf\bf the "step", the entire PDP is marked as "unknown". This
        means that a mixture of known and "unknown" sample times in a single
-       PDP "step" may or may not add up to enough "known" time to warrent for
-       known PDP.
+       PDP "step" may or may not add up to enough "known" time to warrant a
+       known PDP.
 
        The "heartbeat" can be short (unusual) or long (typical) relative to
        the "step" interval between PDPs. A short "heartbeat" means you require
@@ -415,7 +419,7 @@ H\bHO\bOW\bW T\bTO\bO M\bME\bEA\bAS\bSU\bUR\bRE\bE
 
        Mail Messages
            Assume you have a method to count the number of messages
-           transported by your mailserver in a certain amount of time, giving
+           transported by your mail server in a certain amount of time, giving
            you data like '5 messages in the last 65 seconds'. If you look at
            the count of 5 like an A\bAB\bBS\bSO\bOL\bLU\bUT\bTE\bE data type you can simply update the
            RRD with the number 5 and the end time of your monitoring period.
@@ -528,4 +532,4 @@ A\bAU\bUT\bTH\bHO\bOR\bR
 
 
 
-1.3.999                           2009-04-19                      RRDCREATE(1)
+1.4.7                             2011-01-06                      RRDCREATE(1)