clarified output -- alex
[rrdtool.git] / doc / rrdresize.pod
1 =head1 NAME
2
3 rrdtool resize - alters the size of an RRA and creates new .rrd file
4
5 =for html <div align="right"><a href="rrdresize.pdf">PDF</a> version.</div>
6
7 =head1 SYNOPSIS
8
9 B<rrdtool> B<resize> I<filename> I<rra-num>  B<GROW>I<|>B<SHRINK> I<rows>
10
11 =head1 DESCRIPTION
12
13 The B<resize> function is used to modify the number of rows in
14 an B<RRA>.
15
16 =over 8
17
18 =item I<filename> 
19
20 the name of the B<RRD> you want to alter.
21
22 =item I<rra-num> 
23
24 the B<RRA> you want to alter. You can find the number using B<rrdtool info>.
25
26 =item B<GROW> 
27
28 used if you want to add extra rows to an RRA. The extra rows will be inserted
29 as the rows that are oldest.
30
31 =item B<SHRINK> 
32
33 used if you want to remove rows from an RRA. The rows that will be removed
34 are the oldest rows.
35
36 =item I<rows> 
37
38 the number of rows you want to add or remove.
39
40 =back
41
42 =head1 NOTES
43
44 The new .rrd file, with the modified RRAs, is written to the file 
45 B<resize.rrd> in the current directory.  B<The original .rrd file is not
46 modified>.
47
48 It is possible to abuse this tool and get strange results
49 by first removing some rows and then reinsert the same amount (effectively
50 clearing them to be Unknown). You may thus end up with unknown data in one
51 RRA while at the same timestamp this data is available in another RRA.
52
53 =head1 AUTHOR
54
55 Alex van den Bogaerdt <alex@ergens.op.het.net>
56