Imported upstream version 1.4~rc2.

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

index 3c2e933a008a9f740e308baf32416938904c0dbb..1b973e87785ba33357eb5ea46c020bc47d0f1e4a 100644 (file)
--- a/doc/rrdinfo.html
+++ b/doc/rrdinfo.html
@@ -1,18 +1,14 @@
-<?xml version="1.0" ?>
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
  <head>
  <title>rrdinfo</title>
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
  <link rev="made" href="mailto:root@localhost" />
  </head>
  
  <body style="background-color: white">
  
-
-<!-- INDEX BEGIN -->
-<div name="index">
  <p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
  <!--
  
  <ul>
@@ -21,13 +17,10 @@
         <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>
@@ -38,7 +31,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 />
@@ -47,6 +41,26 @@
  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="item_filename"><em>filename</em></a></strong><br />
+</dt>
+<dd>
+The name of the <strong>RRD</strong> you want to examine.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2ddaemon_address"><strong>--daemon</strong> <em>address</em></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<pre>
+ rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
+</dd>
+<p></p></dl>
  <p>
  </p>
  <hr />
@@ -62,6 +76,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
@@ -82,13 +97,21 @@ 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="filename_rrd" class="item"><em>filename.rrd</em></a></strong></dt>
-
+<dt><strong><a name="item_rrdcached_address"><strong>RRDCACHED_ADDRESS</strong></a></strong><br />
+</dt>
  <dd>
-<p>The name of the <strong>RRD</strong> you want to examine.</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.
  </dd>
-</dl>
+<p></p></dl>
  <p>
  </p>
  <hr />