misc fixes for better display

[rrdtool.git] / doc / rrdcreate.pod

diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod
index 91e63d6..80f3970 100644 (file)
--- a/doc/rrdcreate.pod
+++ b/doc/rrdcreate.pod
@@ -1,8 +1,6 @@
 =head1 NAME
 
-rrdtool create - Set up a new Round Robin Database
-
-=for html <div align="right"><a href="rrdcreate.pdf">PDF</a> version.</div>
+rrdcreate - Set up a new Round Robin Database
 
 =head1 SYNOPSIS
 
@@ -10,7 +8,6 @@ B<rrdtool> B<create> I<filename>
 S<[B<--start>|B<-b> I<start time>]> 
 S<[B<--step>|B<-s> I<step>]> 
 S<[B<DS:>I<ds-name>B<:>I<DST>B<:>I<dst arguments>]>
-I<heartbeat>B<:>I<min>B<:>I<max>]>
 S<[B<RRA:>I<CF>B<:>I<cf arguments>]>
 
 =head1 DESCRIPTION
@@ -190,24 +187,32 @@ I<rows> defines how many generations of data values are kept in an B<RRA>.
 
 =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
 aberrant behavior in the data source time series:
 
-=over 4
+=over
+
+=item *
+
+B<RRA:>I<HWPREDICT>B<:>I<rows>B<:>I<alpha>B<:>I<beta>B<:>I<seasonal period>B<:>I<rra-num>
+
+=item *
+
+B<RRA:>I<SEASONAL>B<:>I<seasonal period>B<:>I<gamma>B<:>I<rra-num>
+
+=item *
 
-=item B<RRA:>I<HWPREDICT>B<:>I<rows>B<:>I<alpha>B<:>I<beta>B<:>I<seasonal period>B<:>I<rra-num>
+B<RRA:>I<DEVSEASONAL>B<:>I<seasonal period>B<:>I<gamma>B<:>I<rra-num>
 
-=item B<RRA:>I<SEASONAL>B<:>I<seasonal period>B<:>I<gamma>B<:>I<rra-num>
+=item *
 
-=item B<RRA:>I<DEVSEASONAL>B<:>I<seasonal period>B<:>I<gamma>B<:>I<rra-num>
+B<RRA:>I<DEVPREDICT>B<:>I<rows>B<:>I<rra-num>
 
-=item B<RRA:>I<DEVPREDICT>B<:>I<rows>B<:>I<rra-num>
+=item *
 
-=item B<RRA:>I<FAILURES>B<:>I<rows>B<:>I<threshold>B<:>I<window length>B<:>I<rra-num>
+B<RRA:>I<FAILURES>B<:>I<rows>B<:>I<threshold>B<:>I<window length>B<:>I<rra-num>
 
 =back
 
@@ -258,7 +263,7 @@ they are explicitly created, the creator should verify that all three
 I<seasonal period> arguments agree.
 
 I<alpha> is the adaption parameter of the intercept (or baseline)
-coefficient in the Holt-Winters forecasting algorithm. See L<RRDtool> for a
+coefficient in the Holt-Winters forecasting algorithm. See L<rrdtool> for a
 description of this algorithm. I<alpha> must lie between 0 and 1. A value
 closer to 1 means that more recent observations carry greater weight in
 predicting the baseline component of the forecast. A value closer to 0 mean
@@ -295,7 +300,7 @@ I<rra-num> argument is the 1-based index in the order of B<RRA> creation
 (that is, the order they appear in the I<create> command). The dependent
 B<RRA> for each B<RRA> requiring the I<rra-num> argument is listed here:
 
-=over 4
+=over
 
 =item *
 
@@ -415,9 +420,12 @@ days on the x axis and one bar for each day).
 
 =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
@@ -433,10 +441,10 @@ average temperature, respectively.
 
 =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
@@ -459,25 +467,25 @@ the FAILURES B<RRA>.
 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.