Code

Imported Upstream version 1.4.7
[pkg-rrdtool.git] / doc / rrdfetch.txt
index 9e00cbc4d18f721f4b94d8b15cb11d53b79c50cc..eb6dd0b95c9353926b36574637d9a35036f1337c 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 f\bfe\bet\btc\bch\bh _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be _\bC_\bF [-\b--\b-r\bre\bes\bso\bol\blu\but\bti\bio\bon\bn|-\b-r\br _\br_\be_\bs_\bo_\bl_\bu_\bt_\bi_\bo_\bn]
-       [-\b--\b-s\bst\bta\bar\brt\bt|-\b-s\bs _\bs_\bt_\ba_\br_\bt] [-\b--\b-e\ben\bnd\bd|-\b-e\be _\be_\bn_\bd]
+       [-\b--\b-s\bst\bta\bar\brt\bt|-\b-s\bs _\bs_\bt_\ba_\br_\bt] [-\b--\b-e\ben\bnd\bd|-\b-e\be _\be_\bn_\bd] [-\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs]
 
 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        The f\bfe\bet\btc\bch\bh function is normally used internally by the graph function to
@@ -39,6 +39,15 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                STYLE TIME SPECIFICATION section for a detailed explanation of
                how to specify the end time.
 
+       -\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs
+               Address of the rrdcached daemon. If specified, a "flush"
+               command is sent to the server before reading the RRD files.
+               This allows r\brr\brd\bdt\bto\boo\bol\bl to return fresh data even if the daemon is
+               configured to cache values for a long time.  For a list of
+               accepted formats, see the -\b-l\bl option in the rrdcached manual.
+
+                rrdtool fetch --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd AVERAGE
+
    R\bRE\bES\bSO\bOL\bLU\bUT\bTI\bIO\bON\bN I\bIN\bNT\bTE\bER\bRV\bVA\bAL\bL
        In order to get RRDtool to fetch anything other than the finest
        resolution RRA b\bbo\bot\bth\bh the start and end time must be specified on
@@ -123,11 +132,16 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        _\bN_\bO_\bT_\bE_\b2: if you specify the _\bd_\ba_\by in this way, the _\bt_\bi_\bm_\be_\b-_\bo_\bf_\b-_\bd_\ba_\by is REQUIRED
        as well.
 
-       Finally, you can use the words n\bno\bow\bw, s\bst\bta\bar\brt\bt, or e\ben\bnd\bd as your time
+       Finally, you can use the words n\bno\bow\bw, s\bst\bta\bar\brt\bt, e\ben\bnd\bd or e\bep\bpo\boc\bch\bh as your time
        reference. N\bNo\bow\bw refers to the current moment (and is also the default
        time reference). S\bSt\bta\bar\brt\bt (e\ben\bnd\bd) can be used to specify a time relative to
        the start (end) time for those tools that use these categories
-       (r\brr\brd\bdf\bfe\bet\btc\bch\bh, rrdgraph).
+       (r\brr\brd\bdf\bfe\bet\btc\bch\bh, rrdgraph) and e\bep\bpo\boc\bch\bh indicates the *IX epoch (*IX timestamp 0
+       = 1970-01-01 00:00:00 UTC). e\bep\bpo\boc\bch\bh is useful to disambiguate between a
+       timestamp value and some forms of abbreviated date/time specifications,
+       because it allows to use time offset specifications using units, eg.
+       e\bep\bpo\boc\bch\bh+19711205s unambiguously denotes timestamp 19711205 and not
+       1971-12-05 00:00:00 UTC.
 
        Month and day of the week names can be used in their naturally
        abbreviated form (e.g., Dec for December, Sun for Sunday, etc.). The
@@ -218,9 +232,18 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        _\b1_\b9_\b9_\b7_\b0_\b7_\b0_\b3 _\b1_\b2_\b:_\b4_\b5 -- 12:45  July 3th, 1997 (my favorite, and its even got
        an ISO number (8601)).
 
+E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
+       The following environment variables may be used to change the behavior
+       of "rrdtool fetch":
+
+       R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS
+           If this environment variable is set it will have the same effect as
+           specifying the "--daemon" option on the command line. If both are
+           present, the command line argument takes precedence.
+
 A\bAU\bUT\bTH\bHO\bOR\bR
        Tobias Oetiker <tobi@oetiker.ch>
 
 
 
-1.3.8                             2008-03-15                       RRDFETCH(1)
+1.4.7                             2010-11-11                       RRDFETCH(1)