patches: Added bts573299-rrdgraph-M.

[pkg-rrdtool.git] / doc / rrdinfo.html
diff --git a/doc/rrdinfo.html b/doc/rrdinfo.html

index 8490112a2b39328d76ced2cfce54a7669974f9ed..76863527fb631a42c2200c4c1fb583224a62340c 100644 (file)
--- a/doc/rrdinfo.html
+++ b/doc/rrdinfo.html
@@ -9,8 +9,10 @@
  
  <body style="background-color: white">
  
-<p><a name="__index__"></a></p>
+
  <!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
  <!--
  
  <ul>
@@ -19,9 +21,14 @@
         <li><a href="#synopsis">SYNOPSIS</a></li>
         <li><a href="#description">DESCRIPTION</a></li>
         <li><a href="#example">EXAMPLE</a></li>
+       <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
         <li><a href="#author">AUTHOR</a></li>
  </ul>
+
  -->
+
+
+</div>
  <!-- INDEX END -->
  
  <p>
@@ -32,7 +39,8 @@
  </p>
  <hr />
  <h1><a name="synopsis">SYNOPSIS</a></h1>
-<p><strong>rrdtool</strong> <strong>info</strong> <em>filename.rrd</em></p>
+<p><strong>rrdtool</strong> <strong>info</strong> <em>filename</em>
+[<strong>--daemon</strong>&nbsp;<em>address</em>]</p>
  <p>
  </p>
  <hr />
@@ -41,6 +49,23 @@
  a parsing friendly format.</p>
  <p>Check <a href="././rrdcreate.html">the rrdcreate manpage</a> if you are uncertain about the meaning of the
  individual keys.</p>
+<dl>
+<dt><strong><a name="filename" class="item"><em>filename</em></a></strong></dt>
+
+<dd>
+<p>The name of the <strong>RRD</strong> you want to examine.</p>
+</dd>
+<dt><strong><a name="daemon_address" class="item"><strong>--daemon</strong> <em>address</em></a></strong></dt>
+
+<dd>
+<p>Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If specified, a <code>flush</code> command is sent
+to the server before reading the RRD files. This allows <strong>rrdtool</strong> 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 <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.</p>
+<pre>
+ rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
+</dd>
+</dl>
  <p>
  </p>
  <hr />
@@ -56,6 +81,7 @@ data sources.</p>
   rrd_version = &quot;0001&quot;
   step = 300
   last_update = 955892996
+ header_size = 2872
   ds[a].type = &quot;GAUGE&quot;
   ds[a].minimal_heartbeat = 600
   ds[a].min = NaN
@@ -76,13 +102,20 @@ data sources.</p>
   rra[0].cdp_prep[0].unknown_datapoints = 0
   rra[0].cdp_prep[1].value = nan
   rra[0].cdp_prep[1].unknown_datapoints = 0</pre>
+<p>
+</p>
+<hr />
+<h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
+<p>The following environment variables may be used to change the behavior of
+<code>rrdtoolinfo</code>:</p>
  <dl>
-<dt><strong><a name="item_filename_2errd"><em>filename.rrd</em></a></strong>
+<dt><strong><a name="rrdcached_address" class="item"><strong>RRDCACHED_ADDRESS</strong></a></strong></dt>
  
  <dd>
-<p>The name of the <strong>RRD</strong> you want to examine.</p>
+<p>If this environment variable is set it will have the same effect as specifying
+the <code>--daemon</code> option on the command line. If both are present, the command
+line argument takes precedence.</p>
  </dd>
-</li>
  </dl>
  <p>
  </p>