prep for 1.2rc4 release

[rrdtool.git] / bindings / perl-shared / RRDs.pm

diff --git a/bindings/perl-shared/RRDs.pm b/bindings/perl-shared/RRDs.pm
index fbe4478..e3677ff 100644 (file)
--- a/bindings/perl-shared/RRDs.pm
+++ b/bindings/perl-shared/RRDs.pm
@@ -7,7 +7,7 @@ use vars qw(@ISA $VERSION);
 
 require DynaLoader;
 
 
 require DynaLoader;
 

-$VERSION = 1.100001;
+$VERSION=1.199904;

 
 bootstrap RRDs $VERSION;
 
 
 bootstrap RRDs $VERSION;
 


@@ -16,7 +16,7 @@ __END__
 
 =head1 NAME
 
 
 =head1 NAME
 

-RRDs - Access rrdtool as a shared module
+RRDs - Access RRDtool as a shared module

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -29,14 +29,15 @@ RRDs - Access rrdtool as a shared module
   RRDs::graph ...
   RRDs::fetch ...
   RRDs::tune ...
   RRDs::graph ...
   RRDs::fetch ...
   RRDs::tune ...

+  RRDs::times(start, end)

 
 =head1 DESCRIPTION
 
 =head2 Calling Sequence
 
 
 =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
 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
 
 
  rrdtool update mydemo.rrd --template in:out N:12:13
 


@@ -50,6 +51,10 @@ Note that
 
 is also valid.
 
 
 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
 
 
 =head2 Error Handling
 


@@ -67,8 +72,8 @@ then the previous function has completed its task successfully.
 
 =head2 Return Values
 
 
 =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.
 
 
 B<RRDs::last> returns a single INTEGER representing the last update time.
 


@@ -82,7 +87,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
  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";
 the values of the properties.  
 
  $hash = RRDs::info "example.rrd";


@@ -114,6 +119,9 @@ integers, a pointer to an array and a pointer to a array of pointers.
     print "\n";
   }
 
     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
 See the examples directory for more ways to use this extension.
 
 =head1 NOTE