X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=bindings%2Fperl-shared%2FRRDs.pm;h=5fd1ced618086ac76a5b0d26f7390c442f1c5b12;hb=361a0fd38d7adf95847508f54c0bde9b3f98662e;hp=fbe44784cded7ca0fc691ca4f77baac1e113d238;hpb=bf7d0302ab2ff46038f7002a9eab76f4105c3cee;p=rrdtool.git

diff --git a/bindings/perl-shared/RRDs.pm b/bindings/perl-shared/RRDs.pm
index fbe4478..5fd1ced 100644
--- a/bindings/perl-shared/RRDs.pm
+++ b/bindings/perl-shared/RRDs.pm
@@ -7,7 +7,7 @@ use vars qw(@ISA $VERSION);
 
 require DynaLoader;
 
-$VERSION = 1.100001;
+$VERSION=1.2008;
 
 bootstrap RRDs $VERSION;
 
@@ -16,7 +16,7 @@ __END__
 
 =head1 NAME
 
-RRDs - Access rrdtool as a shared module
+RRDs - Access RRDtool as a shared module
 
 =head1 SYNOPSIS
 
@@ -26,17 +26,19 @@ RRDs - Access rrdtool as a shared module
   RRDs::info ...
   RRDs::create ...
   RRDs::update ...
+  RRDs::updatev ...
   RRDs::graph ...
   RRDs::fetch ...
   RRDs::tune ...
+  RRDs::times(start, end)
 
 =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 commandline call
 
  rrdtool update mydemo.rrd --template in:out N:12:13
 
@@ -50,6 +52,10 @@ Note that
 
 is also valid.
 
+The RRDs::times function takes two parameters:  a "start" and "end" time.
+These should be specified in the B<AT-STYLE TIME SPECIFICATION> format
+used by RRDtool.  See the B<rrdfetch> documentation for a detailed
+explanation on how to specify time.
 
 =head2 Error Handling
 
@@ -67,8 +73,8 @@ then the previous function has completed its task successfully.
 
 =head2 Return Values
 
-The functions RRDs::last, RRDs::graph, RRDs::info and RRDs::fetch return their
-findings.
+The functions RRDs::last, RRDs::graph, RRDs::info, RRDs::fetch and RRDs::times
+return their findings.
 
 B<RRDs::last> returns a single INTEGER representing the last update time.
 
@@ -82,7 +88,7 @@ created image and results of the PRINT arguments.
  print "Averages: ", (join ", ", @$averages);
 
 B<RRDs::info> returns a pointer to a hash. The keys of the hash
-represent the property names of the rrd and the values of the hash are
+represent the property names of the RRD and the values of the hash are
 the values of the properties.  
 
  $hash = RRDs::info "example.rrd";
@@ -114,6 +120,9 @@ integers, a pointer to an array and a pointer to a array of pointers.
     print "\n";
   }
 
+B<RRDs::times> returns two integers which are the number of seconds since
+epoch (1970-01-01) for the supplied "start" and "end" arguments, respectively.
+
 See the examples directory for more ways to use this extension.
 
 =head1 NOTE