From: David Schweikert <dws@open.ch>
Date: Thu, 20 Mar 2014 14:45:32 +0000 (+0100)
Subject: add documentation for RRDs::xport
X-Git-Tag: v1.4.9~17
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c39343498798fcb3295be8daf69f3eb121656285;p=thirdparty%2Frrdtool-1.x.git

add documentation for RRDs::xport
---

diff --git a/bindings/perl-shared/RRDs.pm b/bindings/perl-shared/RRDs.pm
index 6bbf404b..f31e8327 100644
--- a/bindings/perl-shared/RRDs.pm
+++ b/bindings/perl-shared/RRDs.pm
@@ -129,6 +129,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.