Code

Imported upstream SVN snapshot 1.4~rc2+20090928.
[pkg-rrdtool.git] / doc / rrdupdate.txt
index af77a25f52ba33444b847e806760434e9ff032e0..8ff2503584016a046a9eb446705ce1b66d5e5038 100644 (file)
@@ -21,9 +21,9 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                and all consolidated data points (CDPs) written to disk as a
                result of the invocation of update. The values are indexed by
                timestamp (time_t), RRA (consolidation function and PDPs per
-               CDP), and data source (name).  Note that depending on the argu-
-               ments of the current and previous call to update, the list may
-               have no entries or a large number of entries.
+               CDP), and data source (name).  Note that depending on the
+               arguments of the current and previous call to update, the list
+               may have no entries or a large number of entries.
 
                Since u\bup\bpd\bda\bat\bte\bev\bv requires direct disk access, the -\b--\b-d\bda\bae\bem\bmo\bon\bn option
                cannot be used with this command.
@@ -34,10 +34,10 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        -\b--\b-t\bte\bem\bmp\bpl\bla\bat\bte\be|-\b-t\bt _\bd_\bs_\b-_\bn_\ba_\bm_\be[:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be]...
                By default, the u\bup\bpd\bda\bat\bte\be function expects its data input in the
                order the data sources are defined in the RRD, excluding any
-               COMPUTE data sources (i.e. if the third data source D\bDS\bST\bT is COM-
-               PUTE, the third input value will be mapped to the fourth data
-               source in the R\bRR\bRD\bD and so on). This is not very error resistant,
-               as you might be sending the wrong data into an RRD.
+               COMPUTE data sources (i.e. if the third data source D\bDS\bST\bT is
+               COMPUTE, the third input value will be mapped to the fourth
+               data source in the R\bRR\bRD\bD and so on). This is not very error
+               resistant, as you might be sending the wrong data into an RRD.
 
                The template switch allows you to specify which data sources
                you are going to update and in which order. If the data sources
@@ -49,10 +49,10 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                COMPUTE data sources missing from the template the _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*
                value.
 
-               Do not specify a value for a COMPUTE D\bDS\bST\bT in the u\bup\bpd\bda\bat\bte\be func-
-               tion. If this is done accidentally (and this can only be done
-               using the template switch), R\bRR\bRD\bDt\bto\boo\bol\bl will ignore the value spec-
-               ified for the COMPUTE D\bDS\bST\bT.
+               Do not specify a value for a COMPUTE D\bDS\bST\bT in the u\bup\bpd\bda\bat\bte\be
+               function. If this is done accidentally (and this can only be
+               done using the template switch), R\bRR\bRD\bDt\bto\boo\bol\bl will ignore the value
+               specified for the COMPUTE D\bDS\bST\bT.
 
        -\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs
                If given, R\bRR\bRD\bDT\bTo\boo\bol\bl will try to connect to the caching daemon
@@ -61,20 +61,20 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                values will be sent to the daemon instead of accessing the
                files directly.
 
-               For a list of accepted formats, see the -\b-l\bl option in the rrd-
-               cached manual.
+               For a list of accepted formats, see the -\b-l\bl option in the
+               rrdcached manual.
 
        N\bN|_\bt_\bi_\bm_\be_\bs_\bt_\ba_\bm_\bp:\b:_\bv_\ba_\bl_\bu_\be[:\b:_\bv_\ba_\bl_\bu_\be...]
                The data used for updating the RRD was acquired at a certain
                time. This time can either be defined in seconds since
                1970-01-01 or by using the letter 'N', in which case the update
                time is set to be the current time. Negative time values are
-               subtracted from the current time. An AT_STYLE TIME SPECIFICA-
-               TION (see the _\br_\br_\bd_\bf_\be_\bt_\bc_\bh documentation) may also be used by
-               delimiting the end of the time specification with the '@' char-
-               acter instead of a ':'. Getting the timing right to the second
-               is especially important when you are working with data-sources
-               of type C\bCO\bOU\bUN\bNT\bTE\bER\bR, D\bDE\bER\bRI\bIV\bVE\bE or A\bAB\bBS\bSO\bOL\bLU\bUT\bTE\bE.
+               subtracted from the current time. An AT_STYLE TIME
+               SPECIFICATION (see the _\br_\br_\bd_\bf_\be_\bt_\bc_\bh documentation) may also be used
+               by delimiting the end of the time specification with the '@'
+               character instead of a ':'. Getting the timing right to the
+               second is especially important when you are working with data-
+               sources of type C\bCO\bOU\bUN\bNT\bTE\bER\bR, D\bDE\bER\bRI\bIV\bVE\bE or A\bAB\bBS\bSO\bOL\bLU\bUT\bTE\bE.
 
                When using negative time values, options and data have to be
                separated by two dashes (-\b--\b-), else the time value would be
@@ -89,8 +89,8 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                were defined in the RRA. If there is no data for a certain
                data-source, the letter U\bU (e.g., N:0.1:U:1) can be specified.
 
-               The format of the value acquired from the data source is depen-
-               dent on the data source type chosen. Normally it will be
+               The format of the value acquired from the data source is
+               dependent on the data source type chosen. Normally it will be
                numeric, but the data acquisition modules may impose their very
                own parsing of this parameter as long as the colon (:\b:) remains
                the data source value separator.
@@ -105,45 +105,45 @@ E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
            present, the command line argument takes precedence.
 
 E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
-       ·   "rrdtool update demo1.rrd N:3.44:3.15:U:23"
+       Â·   "rrdtool update demo1.rrd N:3.44:3.15:U:23"
 
            Update the database file demo1.rrd with 3 known and one _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b*
            value. Use the current time as the update time.
 
-       ·   "rrdtool update demo2.rrd 887457267:U 887457521:22 887457903:2.7"
+       Â·   "rrdtool update demo2.rrd 887457267:U 887457521:22 887457903:2.7"
 
            Update the database file demo2.rrd which expects data from a single
            data-source, three times. First with an _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* value then with
            two regular readings. The update interval seems to be around 300
            seconds.
 
-       ·   "rrdtool update demo3.rrd -- -5:21 N:42"
+       Â·   "rrdtool update demo3.rrd -- -5:21 N:42"
 
            Update the database file demo3.rrd two times, using five seconds in
            the past and the current time as the update times.
 
-       ·   "rrdtool update --cache /var/lib/rrd/demo3.rrd N:42"
+       Â·   "rrdtool update --cache /var/lib/rrd/demo3.rrd N:42"
 
            Update the file "/var/lib/rrd/demo3.rrd" with a single data source,
            using the current time. If the caching daemon cannot be reached, do
            n\bno\bot\bt fall back to direct file access.
 
-       ·   "rrdtool update --daemon unix:/tmp/rrdd.sock demo4.rrd N:23"
+       Â·   "rrdtool update --daemon unix:/tmp/rrdd.sock demo4.rrd N:23"
 
            Use the UNIX domain socket "/tmp/rrdd.sock" to contact the caching
            daemon. If the caching daemon is not available, update the file
            "demo4.rrd" directly.  W\bWA\bAR\bRN\bNI\bIN\bNG\bG:\b: Since a relative path is specified,
-           the following disturbing effect may occur: If the daemon is avail-
-           able, the file relative to the working directory o\bof\bf t\bth\bhe\be d\bda\bae\bem\bmo\bon\bn is
-           used. If the daemon is not available, the file relative to the cur-
-           rent working directory of the invoking process is used.  T\bTh\bhi\bis\bs m\bma\bay\by
-           u\bup\bpd\bda\bat\bte\be t\btw\bwo\bo d\bdi\bif\bff\bfe\ber\bre\ben\bnt\bt f\bfi\bil\ble\bes\bs d\bde\bep\bpe\ben\bnd\bdi\bin\bng\bg o\bon\bn w\bwh\bhe\bet\bth\bhe\ber\br t\bth\bhe\be d\bda\bae\bem\bmo\bon\bn c\bco\bou\bul\bld\bd b\bbe\be
-           r\bre\bea\bac\bch\bhe\bed\bd o\bor\br n\bno\bot\bt.\b. Don't do relative paths, kids!
+           the following disturbing effect may occur: If the daemon is
+           available, the file relative to the working directory o\bof\bf t\bth\bhe\be d\bda\bae\bem\bmo\bon\bn
+           is used. If the daemon is not available, the file relative to the
+           current working directory of the invoking process is used.  T\bTh\bhi\bis\bs
+           m\bma\bay\by u\bup\bpd\bda\bat\bte\be t\btw\bwo\bo d\bdi\bif\bff\bfe\ber\bre\ben\bnt\bt f\bfi\bil\ble\bes\bs d\bde\bep\bpe\ben\bnd\bdi\bin\bng\bg o\bon\bn w\bwh\bhe\bet\bth\bhe\ber\br t\bth\bhe\be d\bda\bae\bem\bmo\bon\bn
+           c\bco\bou\bul\bld\bd b\bbe\br\bre\bea\bac\bch\bhe\bed\bd o\bor\br n\bno\bot\bt.\b. Don't do relative paths, kids!
 
 A\bAU\bUT\bTH\bHO\bOR\bRS\bS
-       Tobias Oetiker <tobi@oetiker.ch>, Florian Forster <octo at ver-
-       plant.org>
+       Tobias Oetiker <tobi@oetiker.ch>, Florian Forster
+       <octo at verplant.org>
 
 
 
-1.3.99909060808                   2009-06-02                      RRDUPDATE(1)
+1.3.999                           2009-06-09                      RRDUPDATE(1)