Imported upstream version 1.4~rc2.

[pkg-rrdtool.git] / doc / rrdinfo.txt

diff --git a/doc/rrdinfo.txt b/doc/rrdinfo.txt
index ddea07f00365f7b83b3150cbd592247f12aef833..62314d38044ab988ede42ee5683906bf6d251bed 100644 (file)
--- a/doc/rrdinfo.txt
+++ b/doc/rrdinfo.txt
@@ -6,26 +6,39 @@ N\bNA\bAM\bME\bE
        rrdinfo - extract header information from an RRD
 
 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
-       r\brr\brd\bdt\bto\boo\bol\bl i\bin\bnf\bfo\bo _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\br_\br_\bd
+       r\brr\brd\bdt\bto\boo\bol\bl i\bin\bnf\bfo\bo _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [-\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 i\bin\bnf\bfo\bo function prints the header information from an RRD in a
-       parsing friendly format.
+       The i\bin\bnf\bfo\bo function prints the header information from an RRD in a pars-
+       ing friendly format.
 
-       Check rrdcreate if you are uncertain about the meaning of the
-       individual keys.
+       Check rrdcreate if you are uncertain about the meaning of the individ-
+       ual keys.
+
+       _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+               The name of the R\bRR\bRD\bD you want to examine.
+
+       -\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" com-
+               mand 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 con-
+               figured to cache values for a long time.  For a list of
+               accepted formats, see the -\b-l\bl option in the rrdcached manual.
+
+                rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 
 E\bEX\bXA\bAM\bMP\bPL\bLE\bE
-       This is the output generated by running i\bin\bnf\bfo\bo on a simple RRD which
-       contains two data sources and one RRA. Note that the number after the
+       This is the output generated by running i\bin\bnf\bfo\bo on a simple RRD which con-
+       tains two data sources and one RRA. Note that the number after the
        _\bl_\ba_\bs_\bt_\b__\bu_\bp_\bd_\ba_\bt_\be keyword is in seconds since 1970. The string N\bNa\baN\bN stands for
-       _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data. In the example it means that this RRD has neither
-       minimum nor maximum values defined for either of its data sources.
+       _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data. In the example it means that this RRD has neither mini-
+       mum nor maximum values defined for either of its data sources.
 
         filename = "random.rrd"
         rrd_version = "0001"
         step = 300
         last_update = 955892996
+        header_size = 2872
         ds[a].type = "GAUGE"
         ds[a].minimal_heartbeat = 600
         ds[a].min = NaN
@@ -47,12 +60,18 @@ E\bEX\bXA\bAM\bMP\bPL\bLE\bE
         rra[0].cdp_prep[1].value = nan
         rra[0].cdp_prep[1].unknown_datapoints = 0
 
-       _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\br_\br_\bd
-               The name of the R\bRR\bRD\bD you want to examine.
+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 info":
+
+       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                        RRDINFO(1)
+1.3.99909060808                   2009-04-20                        RRDINFO(1)