rrdcgi - Create web pages containing RRD graphs based on templates
-=for html <div align="right"><a href="rrdcgi.pdf">PDF</a> version.</div>
-
=head1 SYNOPSIS
-#!/path/to/B<rrdcgi>
-S<[B<--filter>]>
+C<#!/path/to/>B<rrdcgi> S<[B<--filter>]>
=head1 DESCRIPTION
rrdcreate - Set up a new Round Robin Database
-=for html <div align="right"><a href="rrdcreate.pdf">PDF</a> version.</div>
-
=head1 SYNOPSIS
B<rrdtool> B<create> I<filename>
=head1 Aberrant Behavior Detection with Holt-Winters Forecasting
-by Jake Brutlag E<lt>jakeb@corp.webtv.netE<gt>
-
In addition to the aggregate functions, there are a set of specialized
functions that enable B<RRDtool> to provide data smoothing (via the
Holt-Winters forecasting algorithm), confidence bands, and the flagging
=head1 EXAMPLE
-C<rrdtool create temperature.rrd --step 300 DS:temp:GAUGE:600:-273:5000
-RRA:AVERAGE:0.5:1:1200 RRA:MIN:0.5:12:2400 RRA:MAX:0.5:12:2400
-RRA:AVERAGE:0.5:12:2400>
+ rrdtool create temperature.rrd --step 300 \
+ DS:temp:GAUGE:600:-273:5000 \
+ RRA:AVERAGE:0.5:1:1200 \
+ RRA:MIN:0.5:12:2400 \
+ RRA:MAX:0.5:12:2400 \
+ RRA:AVERAGE:0.5:12:2400
This sets up an B<RRD> called F<temperature.rrd> which accepts one
temperature value every 300 seconds. If no new data is supplied for
=head1 EXAMPLE 2
-C<rrdtool create monitor.rrd --step 300
-DS:ifOutOctets:COUNTER:1800:0:4294967295
-RRA:AVERAGE:0.5:1:2016
-RRA:HWPREDICT:1440:0.1:0.0035:288>
+ rrdtool create monitor.rrd --step 300 \
+ DS:ifOutOctets:COUNTER:1800:0:4294967295 \
+ RRA:AVERAGE:0.5:1:2016 \
+ RRA:HWPREDICT:1440:0.1:0.0035:288
This example is a monitor of a router interface. The first B<RRA> tracks the
traffic flow in octets; the second B<RRA> generates the specialized
The same RRD file and B<RRAs> are created with the following command, which explicitly
creates all specialized function B<RRAs>.
-C<rrdtool create monitor.rrd --step 300
-DS:ifOutOctets:COUNTER:1800:0:4294967295
-RRA:AVERAGE:0.5:1:2016
-RRA:HWPREDICT:1440:0.1:0.0035:288:3
-RRA:SEASONAL:288:0.1:2
-RRA:DEVPREDICT:1440:5
-RRA:DEVSEASONAL:288:0.1:2
-RRA:FAILURES:288:7:9:5>
+ rrdtool create monitor.rrd --step 300 \
+ DS:ifOutOctets:COUNTER:1800:0:4294967295 \
+ RRA:AVERAGE:0.5:1:2016 \
+ RRA:HWPREDICT:1440:0.1:0.0035:288:3 \
+ RRA:SEASONAL:288:0.1:2 \
+ RRA:DEVPREDICT:1440:5 \
+ RRA:DEVSEASONAL:288:0.1:2 \
+ RRA:FAILURES:288:7:9:5
Of course, explicit creation need not replicate implicit create, a number of arguments
could be changed.
=head1 EXAMPLE 3
-C<rrdtool create proxy.rrd --step 300
-DS:TotalRequests:DERIVE:1800:0:U
-DS:AccumDuration:DERIVE:1800:0:U
-DS:AvgReqDuration:COMPUTE:AccumDuration,TotalRequests,0,EQ,1,TotalRequests,IF,/
-RRA:AVERAGE:0.5:1:2016>
+ rrdtool create proxy.rrd --step 300 \
+ DS:Total:DERIVE:1800:0:U \
+ DS:Duration:DERIVE:1800:0:U \
+ DS:AvgReqDur:COMPUTE:Duration,Requests,0,EQ,1,Requests,IF,/ \
+ RRA:AVERAGE:0.5:1:2016
This example is monitoring the average request duration during each 300 sec
interval for requests processed by a web proxy during the interval.
rrddump - dump the contents of an RRD to XML format
-=for html <div align="right"><a href="rrddump.pdf">PDF</a> version.</div>
-
=head1 SYNOPSIS
B<rrdtool> B<dump> I<filename.rrd> E<gt> I<filename.xml>
rrdfetch - Fetch data from an RRD.
-=for html <div align="right"><a href="rrdfetch.pdf">PDF</a> version.</div>
-
=head1 SYNOPSIS
B<rrdtool> B<fetch> I<filename> I<CF>
In e.g. bash this could look as:
- TIME=$(date +%s); RRDRES=900; rrdtool fetch subdata.rrd AVERAGE -r $RRDRES \
- -e $(echo $(($TIME/$RRDRES*$RRDRES))) -s e-1h
+ TIME=$(date +%s)
+ RRDRES=900
+ rrdtool fetch subdata.rrd AVERAGE -r $RRDRES \
+ -e $(echo $(($TIME/$RRDRES*$RRDRES))) -s e-1h
Or in Perl:
- perl -e '$ctime = time; $rrdres = 900; system "rrdtool fetch subdata.rrd AVERAGE \
- -r $rrdres -e @{[int($ctime/$rrdres)*$rrdres]} -s e-1h"'
+ perl -e '$ctime = time; $rrdres = 900; \
+ system "rrdtool fetch subdata.rrd AVERAGE \
+ -r $rrdres -e @{[int($ctime/$rrdres)*$rrdres]} -s e-1h"'
=head2 AT-STYLE TIME SPECIFICATION
=head1 AUTHOR
Tobias Oetiker <oetiker@ee.ethz.ch>
-
rrdfirst - Return the date of the first data sample in an RRA within an 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>]
rrdgraph - Round Robin Database tool grapher functions
-=include name
-
=head1 SYNOPSIS
B<rrdtool graph> I<filename>
at least one print statement to generate a report.
See L<rrdgraph_graph> for exact format.
-=back
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
-=include see_also
=head1 NAME
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
rrdgraph_data - preparing data for graphing in rrdtool graph
=head1 SYNOPSIS
Example: C<CDEF:mydatabits=mydata,8,*>
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
=head1 NAME
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
rrdgraph_examples - Examples for rrdtool graph
=head1 SYNOPSIS
AREA:lastweek#0000FF:Last\ week
LINE1:thisweek#FF0000:This\ week
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
=head1 NAME
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
rrdgraph_graph - rrdtool graph command reference
=head1 SYNOPSIS
or the sequence B<\t> to lin-up legend elements. Note that the tabs inserted are
relative to the start of the current legend element!
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
=head1 NAME
-=cut
-
-WARNING: DO NOT EDIT THE POD FILES. THEY ARE AUTO-GENERATED
-
-=pod
-
rrdgraph_rpn - About RPN Math in rrdtool graph
=head1 SYNOPSIS
=back
-=include see_also
+=head1 SEE ALSO
+
+L<rrdgraph> gives an overview of how B<rrdtool graph> works.
+L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail,
+L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements,
+L<rrdgraph_graph> page describes all of the graph and print functions.
+
+Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
+
+=head1 AUTHOR
+
+Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
+
+This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>
=head1 NAME
-rrdtool - round robin database tool
-
-=for html <div align="right"><a href="rrdtool.pdf">PDF</a> version.</div>
+rrdtool - Round Robin Database Tool
=head1 SYNOPSIS
projects / rrdtool.git / commitdiff