Alternate update interface, updatev. Returns info about CDPs written to disk as resul...
[rrdtool.git] / bindings / perl-shared / RRDs.pm
index 7ed87c2..fbe4478 100644 (file)
@@ -7,7 +7,7 @@ use vars qw(@ISA $VERSION);
 
 require DynaLoader;
 
-$VERSION = 1.000331;
+$VERSION = 1.100001;
 
 bootstrap RRDs $VERSION;
 
@@ -75,10 +75,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 gif and results of the PRINT arguments.
+created image and results of the PRINT arguments.
 
  ($averages,$xsize,$ysize) = RRDs::graph ...
- print "Gifsize: ${xsize}x${ysize}\n";
+ print "Imagesize: ${xsize}x${ysize}\n";
  print "Averages: ", (join ", ", @$averages);
 
 B<RRDs::info> returns a pointer to a hash. The keys of the hash
@@ -90,6 +90,11 @@ the values of the properties.
    print "$key = $$hash{$key}\n";
  }
 
+B<RRDs::updatev> also returns a pointer to hash. The keys of the hash
+are concatenated strings of a timestamp, RRA index, and data source name for
+each consolidated data point (CDP) written to disk as a result of the
+current update call. The hash values are CDP values.
+
 B<RRDs::fetch> is the most complex of
 the pack regarding return values. There are 4 values. Two normal
 integers, a pointer to an array and a pointer to a array of pointers.
@@ -111,6 +116,17 @@ integers, a pointer to an array and a pointer to a array of pointers.
 
 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
+operating in the timezone of your choice.
+
+ use POSIX qw(tzset);
+ $ENV{TZ} = 'CET';   
+ POSIX::tzset();     
+
+
 =head1 AUTHOR
 
 Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>