![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/RRDs.html b/doc/RRDs.html
index f5f4c1e1ca5391084e6a53d6d83b5169e4f88c63..71b6a68bbefe76abd93df66469f793f8219d6ba0 100644 (file)
--- a/doc/RRDs.html
+++ b/doc/RRDs.html
<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="#note">NOTE</a></li>
<li><a href="#author">AUTHOR</a></li>
</ul>
+
-->
+
+
+</div>
<!-- INDEX END -->
<p>
RRDs::tune ...
RRDs::times(start, end)
RRDs::dump ...
- RRDs::restore ...</pre>
+ RRDs::restore ...
+ RRDs::flushcached ...</pre>
<p>
</p>
<hr />
<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>
<pre>
--template=in:out</pre>
<p>is also valid.</p>
-<p>The RRDs::times function takes two parameters: a ``start'' and ``end'' time.
+<p>The RRDs::times function takes two parameters: a "start" and "end" time.
These should be specified in the <strong>AT-STYLE TIME SPECIFICATION</strong> format
used by RRDtool. See the <strong>rrdfetch</strong> documentation for a detailed
explanation on how to specify time.</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 "Imagesize: ${xsize}x${ysize}\n";
print "Averages: ", (join ", ", @$averages);</pre>
<p><strong>RRDs::info</strong> returns a pointer to a hash. The keys of the hash
foreach my $key (keys %$hash){
print "$key = $$hash{$key}\n";
}</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
print "DS names: ", join (", ", @$names)."\n";
print "Data points: ", $#$data + 1, "\n";
print "Data:\n";
- foreach my $line (@$data) {
+ for my $line (@$data) {
print " ", scalar localtime($start), " ($start) ";
$start += $step;
- foreach my $val (@$line) {
+ for my $val (@$line) {
printf "%12.1f ", $val;
}
print "\n";
}</pre>
<p><strong>RRDs::times</strong> returns two integers which are the number of seconds since
-epoch (1970-01-01) for the supplied ``start'' and ``end'' arguments, respectively.</p>
+epoch (1970-01-01) for the supplied "start" and "end" arguments, respectively.</p>
<p>See the examples directory for more ways to use this extension.</p>
<p>
</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);