started updating for 1.2 release
[rrdtool.git] / doc / rrdfirst.pod
1 =head1 NAME
2
3 rrdfirst - Return the date of the first data sample in an B<RRA> within an B<RRD>
4
5 =for html <div align="right"><a href="rrdfirst.pdf">PDF</a> version.</div>
6
7 =head1 SYNOPSIS
8
9 B<rrdtool> B<first> I<filename> [I<--rraindex number>]
10
11 =head1 DESCRIPTION
12
13 The B<first> function returns the UNIX timestamp of the first data sample for
14 the specified RRA of the RRD file.
15
16 =over 8
17
18 =item I<filename>
19
20 The name of the B<RRD> that contains the data.
21
22 =item I<--rraindex number>
23
24 The index number of the B<RRA> that is to be examined.  If not specified, the
25 index defaults to zero. B<RRA> index numbers can be determined through 
26 B<rrdtool info>.
27
28 =back
29
30 =head1 AUTHOR
31
32 Burton Strauss <Burton@ntopSupport.com>
33
34