Imported upstream version 1.3.8.

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

index 56cd79e7644e52df3b02e82e87a61066cb2dc30b..a27a2118bf508afe0d8654c06f20aea3c534c92d 100644 (file)
--- a/doc/RRDp.html
+++ b/doc/RRDp.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>
@@ -22,7 +24,11 @@
         <li><a href="#see_also">SEE ALSO</a></li>
         <li><a href="#author">AUTHOR</a></li>
  </ul>
+
  -->
+
+
+</div>
  <!-- INDEX END -->
  
  <p>
@@ -51,23 +57,25 @@ data, <strong>RRDp::read</strong> will return an undefined variable.</p>
  <p>If you import the PERFORMANCE variables into your namespace, 
  you can access RRDtool's internal performance measurements.</p>
  <dl>
-<dt><strong><a name="item_use_rrdp">use <strong>RRDp</strong></a></strong></dt>
+<dt><strong><a name="use_rrdp" class="item">use <strong>RRDp</strong></a></strong></dt>
  
  <dd>
  <p>Load the RRDp::pipe module.</p>
  </dd>
-<dt><strong><a name="item_rrdp_3a_3astart_path_to_rrdtool_executable"><strong>RRDp::start</strong> <em>path to RRDtool executable</em></a></strong></dt>
+<dt><strong><a name="rrdp_start_path_to_rrdtool_executable" class="item"><strong>RRDp::start</strong> <em>path to RRDtool executable</em></a></strong></dt>
  
  <dd>
  <p>start RRDtool. The argument must be the path to the RRDtool executable</p>
  </dd>
-<dt><strong><a name="item_rrdp_3a_3acmd_rrdtool_commandline"><strong>RRDp::cmd</strong> <em>rrdtool commandline</em></a></strong></dt>
+<dt><strong><a name="rrdp_cmd_rrdtool_commandline" class="item"><strong>RRDp::cmd</strong> <em>rrdtool commandline</em></a></strong></dt>
  
  <dd>
  <p>pass commands on to RRDtool. check the RRDtool documentation for
  more info on the RRDtool commands.</p>
+<p><strong>Note</strong>: Due to design limitations, <strong>RRDp::cmd</strong> does not support the
+<code>graph -</code> command - use <code>graphv -</code> instead.</p>
  </dd>
-<dt><strong><a name="item__answer">$answer = <strong>RRDp::read</strong></a></strong></dt>
+<dt><strong><a name="_answer" class="item">$answer = <strong>RRDp::read</strong></a></strong></dt>
  
  <dd>
  <p>read RRDtool's response to your command. Note that the $answer variable will
@@ -77,12 +85,12 @@ and we don't want to copy this around in memory. So when you want to
  access the contents of $answer you have to use $$answer which dereferences
  the variable.</p>
  </dd>
-<dt><strong><a name="item__status">$status = <strong>RRDp::end</strong></a></strong></dt>
+<dt><strong><a name="_status" class="item">$status = <strong>RRDp::end</strong></a></strong></dt>
  
  <dd>
  <p>terminates RRDtool and returns RRDtool's status ...</p>
  </dd>
-<dt><strong><a name="item__rrdp__user_"><strong>$RRDp::user</strong>,  <strong>$RRDp::sys</strong>, <strong>$RRDp::real</strong></a></strong></dt>
+<dt><strong><a name="_rrdp__user_" class="item"><strong>$RRDp::user</strong>,  <strong>$RRDp::sys</strong>, <strong>$RRDp::real</strong></a></strong></dt>
  
  <dd>
  <p>these variables will contain totals of the user time, system time and
@@ -93,7 +101,7 @@ is the total time RRDtool has been running.</p>
  waiting for things like the hard disk and new input from the perl
  script.</p>
  </dd>
-<dt><strong><a name="item__rrdp__error_mode"><strong>$RRDp::error_mode</strong> and <strong>$RRDp::error</strong></a></strong></dt>
+<dt><strong><a name="_rrdp__error_mode" class="item"><strong>$RRDp::error_mode</strong> and <strong>$RRDp::error</strong></a></strong></dt>
  
  <dd>
  <p>If you set the variable $RRDp::error_mode to the value 'catch' before you run RRDp::read a potential