Imported upstream version 1.4~rc2.

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

index f5f4c1e1ca5391084e6a53d6d83b5169e4f88c63..45da6e7a27278bf3ae8e16a762301c6e57beb559 100644 (file)
--- a/doc/RRDs.html
+++ b/doc/RRDs.html
@@ -1,9 +1,7 @@
-<?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>RRDs</title>
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
  <link rev="made" href="mailto:root@localhost" />
  </head>
  
@@ -52,7 +50,8 @@
    RRDs::tune ...
    RRDs::times(start, end)
    RRDs::dump ...
-  RRDs::restore ...</pre>
+  RRDs::restore ...
+  RRDs::flushcached ...</pre>
  <p>
  </p>
  <hr />
@@ -60,9 +59,9 @@
  <p>
  </p>
  <h2><a name="calling_sequence">Calling Sequence</a></h2>
-<p>This module accesses RRDtool functionality directly from within perl. The
+<p>This module accesses RRDtool functionality directly from within Perl. The
  arguments to the functions listed in the SYNOPSIS are explained in the regular
-RRDtool documentation. The commandline call</p>
+RRDtool documentation. The command line call</p>
  <pre>
   rrdtool update mydemo.rrd --template in:out N:12:13</pre>
  <p>gets turned into</p>
@@ -97,10 +96,10 @@ return their findings.</p>
  <p><strong>RRDs::last</strong> returns a single INTEGER representing the last update time.</p>
  <pre>
   $lastupdate = RRDs::last ...</pre>
-<p><strong>RRDs::graph</strong> returns an pointer to an ARRAY containing the x-size and y-size of the
-created image and results of the PRINT arguments.</p>
+<p><strong>RRDs::graph</strong> returns an ARRAY containing the x-size and y-size of the
+created image and a pointer to an array with the results of the PRINT arguments.</p>
  <pre>
- ($averages,$xsize,$ysize) = RRDs::graph ...
+ ($result_arr,$xsize,$ysize) = RRDs::graph ...
   print &quot;Imagesize: ${xsize}x${ysize}\n&quot;;
   print &quot;Averages: &quot;, (join &quot;, &quot;, @$averages);</pre>
  <p><strong>RRDs::info</strong> returns a pointer to a hash. The keys of the hash
@@ -111,7 +110,7 @@ the values of the properties.</p>
   foreach my $key (keys %$hash){
     print &quot;$key = $$hash{$key}\n&quot;;
   }</pre>
-<p><strong>RRDs::graphv</strong> takes the same paramters as <strong>RRDs::graph</strong> but it returns a
+<p><strong>RRDs::graphv</strong> takes the same parameters as <strong>RRDs::graph</strong> but it returns a
  pointer to hash. The hash returned contains meta information about the
  graph. Like its size as well as the position of the graph area on the image.
  When calling with and empty filename than the contents of the graph will be
@@ -130,10 +129,10 @@ integers, a pointer to an array and a pointer to a array of pointers.</p>
    print &quot;DS names:    &quot;, join (&quot;, &quot;, @$names).&quot;\n&quot;;
    print &quot;Data points: &quot;, $#$data + 1, &quot;\n&quot;;
    print &quot;Data:\n&quot;;
-  foreach my $line (@$data) {
+  for my $line (@$data) {
      print &quot;  &quot;, scalar localtime($start), &quot; ($start) &quot;;
      $start += $step;
-    foreach my $val (@$line) {
+    for my $val (@$line) {
        printf &quot;%12.1f &quot;, $val;
      }
      print &quot;\n&quot;;
@@ -145,8 +144,8 @@ epoch (1970-01-01) for the supplied ``start'' and ``end'' arguments, respectivel
  </p>
  <hr />
  <h1><a name="note">NOTE</a></h1>
-<p>If you are manipulating the TZ variable you should also call the posixs
-function tzset to initialize all internal state of the library for properly
+<p>If you are manipulating the TZ variable you should also call the POSIX
+function <em>tzset(3)</em> to initialize all internal state of the library for properly
  operating in the timezone of your choice.</p>
  <pre>
   use POSIX qw(tzset);