From cb174ea0861c6d6d902309f3a01ade3a24d5c148 Mon Sep 17 00:00:00 2001
From: David Schweikert <dws@open.ch>
Date: Thu, 20 Mar 2014 15:45:32 +0100
Subject: [PATCH] add documentation for RRDs::xport

---
 bindings/perl-shared/RRDs.pm | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/bindings/perl-shared/RRDs.pm b/bindings/perl-shared/RRDs.pm
index 211480c1..a861ff48 100644
--- a/bindings/perl-shared/RRDs.pm
+++ b/bindings/perl-shared/RRDs.pm
@@ -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.
 
-- 
2.47.2