Code

Imported upstream version 1.4~rc2.
[pkg-rrdtool.git] / doc / rrdxport.txt
index 2930d1b98fbe0b508d959e23abcbeb3f0569298b..ba2c353ba4e328cc6ab12fc0ae4bf0320756f2ef 100644 (file)
@@ -8,12 +8,13 @@ N\bNA\bAM\bME\bE
 
 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
        r\brr\brd\bdt\bto\boo\bol\bl x\bxp\bpo\bor\brt\bt [-\b-s\bs|-\b--\b-s\bst\bta\bar\brt\bt _\bs_\be_\bc_\bo_\bn_\bd_\bs] [-\b-e\be|-\b--\b-e\ben\bnd\bd _\bs_\be_\bc_\bo_\bn_\bd_\bs]
-       [-\b-m\bm|-\b--\b-m\bma\bax\bxr\bro\bow\bws\bs _\br_\bo_\bw_\bs] [-\b--\b-s\bst\bte\bep\bp _\bv_\ba_\bl_\bu_\be] [D\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\br_\br_\bd:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bC_\bF]
-       [C\bCD\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\br_\bp_\bn_\b-_\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn] [X\bXP\bPO\bOR\bRT\bT:\b:_\bv_\bn_\ba_\bm_\be[:\b:_\bl_\be_\bg_\be_\bn_\bd]]
+       [-\b-m\bm|-\b--\b-m\bma\bax\bxr\bro\bow\bws\bs _\br_\bo_\bw_\bs] [-\b--\b-s\bst\bte\bep\bp _\bv_\ba_\bl_\bu_\be] [-\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs]
+       [D\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\br_\br_\bd:\b:_\bd_\bs_\b-_\bn_\ba_\bm_\be:\b:_\bC_\bF] [C\bCD\bDE\bEF\bF:\b:_\bv_\bn_\ba_\bm_\be=\b=_\br_\bp_\bn_\b-_\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn]
+       [X\bXP\bPO\bOR\bRT\bT:\b:_\bv_\bn_\ba_\bm_\be[:\b:_\bl_\be_\bg_\be_\bn_\bd]]
 
 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
-       The x\bxp\bpo\bor\brt\bt function's main purpose is to write an XML formatted
-       representation of the data stored in one or several R\bRR\bRD\bDs. It can also
+       The x\bxp\bpo\bor\brt\bt function's main purpose is to write an XML formatted repre-
+       sentation of the data stored in one or several R\bRR\bRD\bDs. It can also
        extract numerical reports.
 
        If no _\bX_\bP_\bO_\bR_\bT statements are found, there will be no output.
@@ -22,15 +23,15 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
            The time when the exported range should begin. Time in seconds
            since epoch (1970-01-01) is required. Negative numbers are relative
            to the current time. By default one day worth of data will be
-           printed.  See also AT-STYLE TIME SPECIFICATION section in the
-           _\br_\br_\bd_\bf_\be_\bt_\bc_\bh documentation for a detailed explanation on how to specify
+           printed.  See also AT-STYLE TIME SPECIFICATION section in the _\br_\br_\bd_\b-
+           _\bf_\be_\bt_\bc_\bh documentation for a detailed explanation on how to specify
            time.
 
        -\b-e\be|-\b--\b-e\ben\bnd\bd _\bs_\be_\bc_\bo_\bn_\bd_\bs (default now)
            The time when the exported range should end. Time in seconds since
-           epoch.  See also AT-STYLE TIME SPECIFICATION section in the
-           _\br_\br_\bd_\bf_\be_\bt_\bc_\bh documentation for a detailed explanation of ways to
-           specify time.
+           epoch.  See also AT-STYLE TIME SPECIFICATION section in the _\br_\br_\bd_\b-
+           _\bf_\be_\bt_\bc_\bh documentation for a detailed explanation of ways to specify
+           time.
 
        -\b-m\bm|-\b--\b-m\bma\bax\bxr\bro\bow\bws\bs _\br_\bo_\bw_\bs (default 400 rows)
            This works like the -\b-w\bw|-\b--\b-w\bwi\bid\bdt\bth\bh parameter of _\br_\br_\bd_\bg_\br_\ba_\bp_\bh.  In fact it
@@ -40,6 +41,15 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        -\b--\b-s\bst\bte\bep\bp _\bv_\ba_\bl_\bu_\be (default automatic)
            See rrdgraph documentation.
 
+       -\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\bd-\b-
+           t\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 xport --daemon unix:/var/run/rrdcached.sock ...
+
        -\b--\b-e\ben\bnu\bum\bmd\bds\bs
            The generated xml should contain the data values in enumerated
            tags.
@@ -53,8 +63,8 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
            See _\br_\br_\bd_\bg_\br_\ba_\bp_\bh documentation.
 
        X\bXP\bPO\bOR\bRT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b::\b:_\bl_\be_\bg_\be_\bn_\bd
-           At least one _\bX_\bP_\bO_\bR_\bT statement should be present. The values
-           referenced by _\bv_\bn_\ba_\bm_\be are printed. Optionally add a legend.
+           At least one _\bX_\bP_\bO_\bR_\bT statement should be present. The values refer-
+           enced by _\bv_\bn_\ba_\bm_\be are printed. Optionally add a legend.
 
 O\bOu\but\btp\bpu\but\bt f\bfo\bor\brm\bma\bat\bt
        The output is enclosed in an x\bxp\bpo\bor\brt\bt element and contains two blocks. The
@@ -120,9 +130,18 @@ E\bEX\bXA\bAM\bMP\bPL\bLE\bE 2\b2
                  XPORT:out2:"if2 out bytes" \
                  XPORT:sum:"output sum"
 
+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 xport":
+
+       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                       RRDXPORT(1)
+1.3.99909060808                   2008-09-25                       RRDXPORT(1)