From: Tobias Oetiker <tobi@oetiker.ch>
Date: Sun, 13 Mar 2005 15:16:05 +0000 (+0000)
Subject: add the documentation for first
X-Git-Tag: 1.2rc1~28
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=50448728dfff909740b5bb02fed0030d8d8787af;p=thirdparty%2Frrdtool-1.x.git

add the documentation for first

git-svn-id: svn://svn.oetiker.ch/rrdtool/trunk/program@312 a5681a0c-68f1-0310-ab6d-d61299d08faa
---

diff --git a/doc/rrdfirst.pod b/doc/rrdfirst.pod
new file mode 100644
index 00000000..4d01273e
--- /dev/null
+++ b/doc/rrdfirst.pod
@@ -0,0 +1,34 @@
+=head1 NAME
+
+rrdfirst - Return the date of the first data sample in an B<RRA> within an B<RRD>
+
+=for html <div align="right"><a href="rrdfirst.pdf">PDF</a> version.</div>
+
+=head1 SYNOPSIS
+
+B<rrdtool> B<first> I<filename> [I<--rraindex number>]
+
+=head1 DESCRIPTION
+
+The B<first> function returns the UNIX timestamp of the first data sample for
+the specified RRA of the RRD file.
+
+=over 8
+
+=item I<filename>
+
+The name of the B<RRD> that contains the data.
+
+=item I<--rraindex number>
+
+The index number of the B<RRA> that is to be examined.  If not specified, the
+index defaults to zero. B<RRA> index numbers can be determined through 
+B<rrdtool info>.
+
+=back
+
+=head1 AUTHOR
+
+Burton Strauss <Burton@ntopSupport.com>
+
+