]> git.ipfire.org Git - thirdparty/rrdtool-1.x.git/commitdiff
add documentation for RRDs::xport 455/head
authorDavid Schweikert <dws@open.ch>
Thu, 20 Mar 2014 14:45:32 +0000 (15:45 +0100)
committerDavid Schweikert <dws@open.ch>
Thu, 20 Mar 2014 14:45:32 +0000 (15:45 +0100)
bindings/perl-shared/RRDs.pm

index 211480c1a8570536afe6aa7e43114857e9105a49..a861ff48e20ef8eee759adbcc44620c7bfa79ea6 100644 (file)
@@ -130,6 +130,18 @@ integers, a pointer to an array and a pointer to a array of pointers.
     print "\n";
   }
 
+B<RRDs::xport> exposes the L<rrdxport(1)> functionality and returns data
+with the following structure:
+
+  my ($start,$end,$step,$cols,$names,$data) = RRDs::xport ...
+  
+  # $start : timestamp
+  # $end   : timestamp
+  # $step  : seconds
+  # $cols  : number of returned columns
+  # $names : arrayref with the names of the columns
+  # $data  : arrayref of arrayrefs with the data (first index is time, second is column)
+
 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.