bindings should invoke new rrd_flushcached (instead of rrd_cmd_flush) -- kevin
[rrdtool.git] / bindings / perl-shared / RRDs.pm
index b75c9f0..33dd529 100644 (file)
@@ -7,7 +7,7 @@ use vars qw(@ISA $VERSION);
 
 require DynaLoader;
 
-$VERSION=1.299908051800;
+$VERSION=1.3002;
 
 bootstrap RRDs $VERSION;
 
@@ -33,14 +33,15 @@ RRDs - Access RRDtool as a shared module
   RRDs::times(start, end)
   RRDs::dump ...
   RRDs::restore ...
+  RRDs::flushcached ...
 
 =head1 DESCRIPTION
 
 =head2 Calling Sequence
 
-This module accesses RRDtool functionality directly from within perl. The
+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
+RRDtool documentation. The command line call
 
  rrdtool update mydemo.rrd --template in:out N:12:13
 
@@ -82,10 +83,10 @@ B<RRDs::last> returns a single INTEGER representing the last update time.
 
  $lastupdate = RRDs::last ...
 
-B<RRDs::graph> returns an pointer to an ARRAY containing the x-size and y-size of the
-created image and results of the PRINT arguments.
+B<RRDs::graph> 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.
 
- ($averages,$xsize,$ysize) = RRDs::graph ...
+ ($result_arr,$xsize,$ysize) = RRDs::graph ...
  print "Imagesize: ${xsize}x${ysize}\n";
  print "Averages: ", (join ", ", @$averages);
 
@@ -98,7 +99,7 @@ the values of the properties.
    print "$key = $$hash{$key}\n";
  }
 
-B<RRDs::graphv> takes the same paramters as B<RRDs::graph> but it returns a
+B<RRDs::graphv> takes the same parameters as B<RRDs::graph> 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
@@ -119,10 +120,10 @@ integers, a pointer to an array and a pointer to a array of pointers.
   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";
@@ -135,8 +136,8 @@ See the examples directory for more ways to use this extension.
 
 =head1 NOTE
 
-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
+If you are manipulating the TZ variable you should also call the POSIX
+function L<tzset(3)> to initialize all internal state of the library for properly
 operating in the timezone of your choice.
 
  use POSIX qw(tzset);