Code

Imported upstream SVN snapshot 1.4~rc2+20090928.
[pkg-rrdtool.git] / doc / RRDp.html
index 295e62f84617902c668b4d9530c792d9de3b3798..a27a2118bf508afe0d8654c06f20aea3c534c92d 100644 (file)
@@ -1,14 +1,18 @@
+<?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>RRDp</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">
 
-<p><a name="__index__"></a></p>
+
 <!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
 <!--
 
 <ul>
        <li><a href="#see_also">SEE ALSO</a></li>
        <li><a href="#author">AUTHOR</a></li>
 </ul>
+
 -->
+
+
+</div>
 <!-- INDEX END -->
 
 <p>
@@ -49,74 +57,62 @@ 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><br />
-</dt>
-<dd>
-Load the RRDp::pipe module.
-</dd>
-<p></p>
-<dt><strong><a name="item_rrdp_3a_3astart_path_to_rrdtool_executable"><strong>RRDp::start</strong> <em>path to RRDtool executable</em></a></strong><br />
-</dt>
+<dt><strong><a name="use_rrdp" class="item">use <strong>RRDp</strong></a></strong></dt>
+
 <dd>
-start RRDtool. The argument must be the path to the RRDtool executable
+<p>Load the RRDp::pipe module.</p>
 </dd>
-<p></p>
-<dt><strong><a name="item_rrdp_3a_3acmd_rrdtool_commandline"><strong>RRDp::cmd</strong> <em>rrdtool commandline</em></a></strong><br />
-</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>
-pass commands on to RRDtool. check the RRDtool documentation for
-more info on the RRDtool commands.
+<p>start RRDtool. The argument must be the path to the RRDtool executable</p>
 </dd>
+<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>
-<p></p>
-<dt><strong><a name="item__24answer__3d_rrdp_3a_3aread">$answer = <strong>RRDp::read</strong></a></strong><br />
-</dt>
+<dt><strong><a name="_answer" class="item">$answer = <strong>RRDp::read</strong></a></strong></dt>
+
 <dd>
-read RRDtool's response to your command. Note that the $answer variable will
+<p>read RRDtool's response to your command. Note that the $answer variable will
 only contain a pointer to the returned data. The reason for this is, that
 RRDtool can potentially return quite excessive amounts of data
 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.
+the variable.</p>
 </dd>
-<p></p>
-<dt><strong><a name="item__24status__3d_rrdp_3a_3aend">$status = <strong>RRDp::end</strong></a></strong><br />
-</dt>
+<dt><strong><a name="_status" class="item">$status = <strong>RRDp::end</strong></a></strong></dt>
+
 <dd>
-terminates RRDtool and returns RRDtool's status ...
+<p>terminates RRDtool and returns RRDtool's status ...</p>
 </dd>
-<p></p>
-<dt><strong><a name="item__24rrdp_3a_3auser_2c__24rrdp_3a_3asys_2c__24rrdp_3"><strong>$RRDp::user</strong>,  <strong>$RRDp::sys</strong>, <strong>$RRDp::real</strong></a></strong><br />
-</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>
-these variables will contain totals of the user time, system time and
+<p>these variables will contain totals of the user time, system time and
 real time as seen by RRDtool.  User time is the time RRDtool is
 running, System time is the time spend in system calls and real time
-is the total time RRDtool has been running.
-</dd>
-<dd>
+is the total time RRDtool has been running.</p>
 <p>The difference between user + system and real is the time spent
 waiting for things like the hard disk and new input from the perl
 script.</p>
 </dd>
-<p></p>
-<dt><strong><a name="item__24rrdp_3a_3aerror_mode_and__24rrdp_3a_3aerror"><strong>$RRDp::error_mode</strong> and <strong>$RRDp::error</strong></a></strong><br />
-</dt>
+<dt><strong><a name="_rrdp__error_mode" class="item"><strong>$RRDp::error_mode</strong> and <strong>$RRDp::error</strong></a></strong></dt>
+
 <dd>
-If you set the variable $RRDp::error_mode to the value 'catch' before you run RRDp::read a potential
+<p>If you set the variable $RRDp::error_mode to the value 'catch' before you run RRDp::read a potential
 ERROR message will not cause the program to abort but will be returned in this variable. If no error
-occurs the variable will be empty.
-</dd>
-<dd>
+occurs the variable will be empty.</p>
 <pre>
  $RRDp::error_mode = 'catch';
  RRDp::cmd qw(info file.rrd);
  print $RRDp::error if $RRDp::error;</pre>
 </dd>
-<p></p></dl>
+</dl>
 <p>
 </p>
 <hr />