let 'out-of tree' builds work for everythin but the perl module -- Peter Breitenlohner

[rrdtool.git] / doc / rrdcreate.pod

diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod
index 5c44562..3d4b8dd 100644 (file)
--- a/doc/rrdcreate.pod
+++ b/doc/rrdcreate.pod
@@ -4,9 +4,9 @@ rrdcreate - Set up a new Round Robin Database
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<rrdtool> B<create> I<filename> 
-S<[B<--start>|B<-b> I<start time>]> 
-S<[B<--step>|B<-s> I<step>]> 
+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>]>
 S<[B<RRA:>I<CF>B<:>I<cf arguments>]>
 
 S<[B<DS:>I<ds-name>B<:>I<DST>B<:>I<dst arguments>]>
 S<[B<RRA:>I<CF>B<:>I<cf arguments>]>
 


@@ -65,7 +65,7 @@ for further insight.
 
 =over 4
 
 
 =over 4
 

-=item B<GAUGE> 
+=item B<GAUGE>

 
 is for things like temperatures or number of people in a room or the
 value of a RedHat share.
 
 is for things like temperatures or number of people in a room or the
 value of a RedHat share.


@@ -112,7 +112,7 @@ wrap.
 
 =back
 
 
 =back
 

-=item B<ABSOLUTE> 
+=item B<ABSOLUTE>

 
 is for counters which get reset upon reading. This is used for fast counters
 which tend to overflow. So instead of reading them normally you reset them
 
 is for counters which get reset upon reading. This is used for fast counters
 which tend to overflow. So instead of reading them normally you reset them


@@ -134,16 +134,15 @@ to as "virtual" or "computed" columns.
 =back
 
 I<heartbeat> defines the maximum number of seconds that may pass
 =back
 
 I<heartbeat> defines the maximum number of seconds that may pass

-between two updates of this data source before the value of the 
+between two updates of this data source before the value of the

 data source is assumed to be I<*UNKNOWN*>.
 
 data source is assumed to be I<*UNKNOWN*>.
 

-I<min> and I<max> are optional entries defining the expected range of
-the data supplied by this data source. If I<min> and/or I<max> are
-defined, any value outside the defined range will be regarded as
-I<*UNKNOWN*>. If you do not know or care about min and max, set them
-to U for unknown. Note that min and max always refer to the processed
-values of the DS. For a traffic-B<COUNTER> type DS this would be the
-maximum and minimum data-rate expected from the device.
+I<min> and I<max> define the expected range values for data supplied by a
+data source. If I<min> and/or I<max> any value outside the defined range
+will be regarded as I<*UNKNOWN*>. If you do not know or care about min and
+max, set them to U for unknown. Note that min and max always refer to the
+processed values of the DS. For a traffic-B<COUNTER> type DS this would be
+the maximum and minimum data-rate expected from the device.

 
 I<If information on minimal/maximal expected values is available,
 always set the min and/or max properties. This will help RRDtool in
 
 I<If information on minimal/maximal expected values is available,
 always set the min and/or max properties. This will help RRDtool in


@@ -164,7 +163,7 @@ and B<CDEF>s previously defined in the same graph command.
 
 
 The purpose of an B<RRD> is to store data in the round robin archives
 
 
 The purpose of an B<RRD> is to store data in the round robin archives

-(B<RRA>). An archive consists of a number of data values or statistics for 
+(B<RRA>). An archive consists of a number of data values or statistics for

 each of the defined data-sources (B<DS>) and is defined with an B<RRA> line.
 
 When data is entered into an B<RRD>, it is first fit into time slots
 each of the defined data-sources (B<DS>) and is defined with an B<RRA> line.
 
 When data is entered into an B<RRD>, it is first fit into time slots


@@ -312,11 +311,11 @@ requiring the I<rra-num> argument is listed here:
 
 HWPREDICT I<rra-num> is the index of the SEASONAL B<RRA>.
 
 
 HWPREDICT I<rra-num> is the index of the SEASONAL B<RRA>.
 

-=item * 
+=item *

 
 SEASONAL I<rra-num> is the index of the HWPREDICT B<RRA>.
 
 
 SEASONAL I<rra-num> is the index of the HWPREDICT B<RRA>.
 

-=item * 
+=item *

 
 DEVPREDICT I<rra-num> is the index of the DEVSEASONAL B<RRA>.
 
 
 DEVPREDICT I<rra-num> is the index of the DEVSEASONAL B<RRA>.
 


@@ -324,7 +323,7 @@ DEVPREDICT I<rra-num> is the index of the DEVSEASONAL B<RRA>.
 
 DEVSEASONAL I<rra-num> is the index of the HWPREDICT B<RRA>.
 
 
 DEVSEASONAL I<rra-num> is the index of the HWPREDICT B<RRA>.
 

-=item * 
+=item *

 
 FAILURES I<rra-num> is the index of the DEVSEASONAL B<RRA>.
 
 
 FAILURES I<rra-num> is the index of the DEVSEASONAL B<RRA>.
 


@@ -448,10 +447,10 @@ average temperature, respectively.
 
 =head1 EXAMPLE 2
 
 
 =head1 EXAMPLE 2
 

- rrdtool create monitor.rrd --step 300        \ 
-   DS:ifOutOctets:COUNTER:1800:0:4294967295   \ 
+ rrdtool create monitor.rrd --step 300        \
+   DS:ifOutOctets:COUNTER:1800:0:4294967295   \

    RRA:AVERAGE:0.5:1:2016                     \
    RRA:AVERAGE:0.5:1:2016                     \

-   RRA:HWPREDICT:1440:0.1:0.0035:288 
+   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
 
 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


@@ -474,27 +473,27 @@ 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>.
 
 The same RRD file and B<RRAs> are created with the following command,
 which explicitly creates all specialized function B<RRAs>.
 

- 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
 
 
 Of course, explicit creation need not replicate implicit create, a
 number of arguments could be changed.
 
 =head1 EXAMPLE 3
 

- 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 
+ 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 
+This example is monitoring the average request duration during each 300 sec

 interval for requests processed by a web proxy during the interval.
 In this case, the proxy exposes two counters, the number of requests
 processed since boot and the total cumulative duration of all processed
 interval for requests processed by a web proxy during the interval.
 In this case, the proxy exposes two counters, the number of requests
 processed since boot and the total cumulative duration of all processed