Ok, this was very optimistic. This try will probably have ended with
configure complaining about several missing libraries.
@@ -376,7 +376,7 @@ because it seems that a fair number of people have ill configured python and
tcl setups that would prevent rrdtool from building if they are included in
their current state.
- cd $BUILD_DIR/rrdtool-1.3rc9
+ cd $BUILD_DIR/rrdtool-1.3.0
./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
$MAKE clean
$MAKE
diff --git a/doc/rrdbuild.pod b/doc/rrdbuild.pod
index d244137..1a281e5 100644
--- a/doc/rrdbuild.pod
+++ b/doc/rrdbuild.pod
@@ -41,7 +41,7 @@ Where you want to install the software.
Once you have decided. Save the two locations into environment variables.
BUILD_DIR=/tmp/rrdbuild
- INSTALL_DIR=/usr/local/rrdtool-1.3rc9
+ INSTALL_DIR=/usr/local/rrdtool-1.3.0
If your F is mounted with the option noexec (RHEL seems todo that) you have to choose
@@ -55,9 +55,9 @@ Now make sure the BUILD_DIR exists and go there:
Lets first assume you already have all the necessary libraries
pre-installed.
- wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3rc9.tar.gz
- gunzip -c rrdtool-1.3rc9.tar.gz | tar xf -
- cd rrdtool-1.3rc9
+ wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3.0.tar.gz
+ gunzip -c rrdtool-1.3.0.tar.gz | tar xf -
+ cd rrdtool-1.3.0
./configure --prefix=$INSTALL_DIR && make && make install
Ok, this was very optimistic. This try will probably have ended with
@@ -336,7 +336,7 @@ because it seems that a fair number of people have ill configured python and
tcl setups that would prevent rrdtool from building if they are included in
their current state.
- cd $BUILD_DIR/rrdtool-1.3rc9
+ cd $BUILD_DIR/rrdtool-1.3.0
./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
$MAKE clean
$MAKE
diff --git a/doc/rrdbuild.txt b/doc/rrdbuild.txt
index f3f0846..b16b571 100644
--- a/doc/rrdbuild.txt
+++ b/doc/rrdbuild.txt
@@ -35,7 +35,7 @@ OOPPTTIIMMIISSTTIICC BBUUIILLDD
ables.
BUILD_DIR=/tmp/rrdbuild
- INSTALL_DIR=/usr/local/rrdtool-1.3rc9
+ INSTALL_DIR=/usr/local/rrdtool-1.3.0
If your _/_t_m_p is mounted with the option noexec (RHEL seems todo that)
you have to choose a different directory!
@@ -48,9 +48,9 @@ OOPPTTIIMMIISSTTIICC BBUUIILLDD
Lets first assume you already have all the necessary libraries
pre-installed.
- wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3rc9.tar.gz
- gunzip -c rrdtool-1.3rc9.tar.gz | tar xf -
- cd rrdtool-1.3rc9
+ wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3.0.tar.gz
+ gunzip -c rrdtool-1.3.0.tar.gz | tar xf -
+ cd rrdtool-1.3.0
./configure --prefix=$INSTALL_DIR && make && make install
Ok, this was very optimistic. This try will probably have ended with
@@ -304,7 +304,7 @@ BBUUIILLDDIINNGG DDEEPPEENNDDEENNCCIIEESS
python and tcl setups that would prevent rrdtool from building if they
are included in their current state.
- cd $BUILD_DIR/rrdtool-1.3rc9
+ cd $BUILD_DIR/rrdtool-1.3.0
./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
$MAKE clean
$MAKE
@@ -323,4 +323,4 @@ AAUUTTHHOORR
-1.3rc9 2008-06-08 RRDBUILD(1)
+1.3.0 2008-06-11 RRDBUILD(1)
diff --git a/doc/rrdcgi.1 b/doc/rrdcgi.1
index 6c63592..5607901 100644
--- a/doc/rrdcgi.1
+++ b/doc/rrdcgi.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "RRDCGI 1"
-.TH RRDCGI 1 "2008-03-15" "1.3rc9" "rrdtool"
+.TH RRDCGI 1 "2008-03-15" "1.3.0" "rrdtool"
.SH "NAME"
rrdcgi \- Create web pages containing RRD graphs based on templates
.SH "SYNOPSIS"
diff --git a/doc/rrdcgi.txt b/doc/rrdcgi.txt
index 39bd614..7325ba8 100644
--- a/doc/rrdcgi.txt
+++ b/doc/rrdcgi.txt
@@ -204,4 +204,4 @@ AAUUTTHHOORR
-1.3rc9 2008-03-15 RRDCGI(1)
+1.3.0 2008-03-15 RRDCGI(1)
diff --git a/doc/rrdcreate.1 b/doc/rrdcreate.1
index 53fc8d9..8809ca0 100644
--- a/doc/rrdcreate.1
+++ b/doc/rrdcreate.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "RRDCREATE 1"
-.TH RRDCREATE 1 "2008-05-12" "1.3rc9" "rrdtool"
+.TH RRDCREATE 1 "2008-06-11" "1.3.0" "rrdtool"
.SH "NAME"
rrdcreate \- Set up a new Round Robin Database
.SH "SYNOPSIS"
@@ -144,48 +144,47 @@ rrdcreate \- Set up a new Round Robin Database
The create function of RRDtool lets you set up new Round Robin
Database (\fB\s-1RRD\s0\fR) files. The file is created at its final, full size
and filled with \fI*UNKNOWN*\fR data.
-.IP "\fIfilename\fR" 8
-.IX Item "filename"
+.Sh "\fIfilename\fP"
+.IX Subsection "filename"
The name of the \fB\s-1RRD\s0\fR you want to create. \fB\s-1RRD\s0\fR files should end
with the extension \fI.rrd\fR. However, \fBRRDtool\fR will accept any
filename.
-.IP "\fB\-\-start\fR|\fB\-b\fR \fIstart time\fR (default: now \- 10s)" 8
-.IX Item "--start|-b start time (default: now - 10s)"
+.Sh "\fB\-\-start\fP|\fB\-b\fP \fIstart time\fP (default: now \- 10s)"
+.IX Subsection "--start|-b start time (default: now - 10s)"
Specifies the time in seconds since 1970\-01\-01 \s-1UTC\s0 when the first
value should be added to the \fB\s-1RRD\s0\fR. \fBRRDtool\fR will not accept
any data timed before or at the time specified.
-.Sp
+.PP
See also AT-STYLE \s-1TIME\s0 \s-1SPECIFICATION\s0 section in the
\&\fIrrdfetch\fR documentation for other ways to specify time.
-.IP "\fB\-\-step\fR|\fB\-s\fR \fIstep\fR (default: 300 seconds)" 8
-.IX Item "--step|-s step (default: 300 seconds)"
+.Sh "\fB\-\-step\fP|\fB\-s\fP \fIstep\fP (default: 300 seconds)"
+.IX Subsection "--step|-s step (default: 300 seconds)"
Specifies the base interval in seconds with which data will be fed
into the \fB\s-1RRD\s0\fR.
-.IP "\fB\s-1DS:\s0\fR\fIds-name\fR\fB:\fR\fI\s-1DST\s0\fR\fB:\fR\fIdst arguments\fR" 8
-.IX Item "DS:ds-name:DST:dst arguments"
+.Sh "\fB\s-1DS:\s0\fP\fIds-name\fP\fB:\fP\fI\s-1DST\s0\fP\fB:\fP\fIdst arguments\fP"
+.IX Subsection "DS:ds-name:DST:dst arguments"
A single \fB\s-1RRD\s0\fR can accept input from several data sources (\fB\s-1DS\s0\fR),
for example incoming and outgoing traffic on a specific communication
line. With the \fB\s-1DS\s0\fR configuration option you must define some basic
properties of each data source you want to store in the \fB\s-1RRD\s0\fR.
-.Sp
+.PP
\&\fIds-name\fR is the name you will use to reference this particular data
source from an \fB\s-1RRD\s0\fR. A \fIds-name\fR must be 1 to 19 characters long in
the characters [a\-zA\-Z0\-9_].
-.Sp
+.PP
\&\fI\s-1DST\s0\fR defines the Data Source Type. The remaining arguments of a
data source entry depend on the data source type. For \s-1GAUGE\s0, \s-1COUNTER\s0,
\&\s-1DERIVE\s0, and \s-1ABSOLUTE\s0 the format for a data source entry is:
-.Sp
+.PP
\&\fB\s-1DS:\s0\fR\fIds-name\fR\fB:\fR\fI\s-1GAUGE\s0 | \s-1COUNTER\s0 | \s-1DERIVE\s0 | \s-1ABSOLUTE\s0\fR\fB:\fR\fIheartbeat\fR\fB:\fR\fImin\fR\fB:\fR\fImax\fR
-.Sp
+.PP
For \s-1COMPUTE\s0 data sources, the format is:
-.Sp
+.PP
\&\fB\s-1DS:\s0\fR\fIds-name\fR\fB:\fR\fI\s-1COMPUTE\s0\fR\fB:\fR\fIrpn-expression\fR
-.Sp
+.PP
In order to decide which data source type to use, review the
definitions that follow. Also consult the section on \*(L"\s-1HOW\s0 \s-1TO\s0 \s-1MEASURE\s0\*(R"
for further insight.
-.RS 8
.IP "\fB\s-1GAUGE\s0\fR" 4
.IX Item "GAUGE"
is for things like temperatures or number of people in a room or the
@@ -207,9 +206,9 @@ example, to measure the rate of people entering or leaving a
room. Internally, derive works exactly like \s-1COUNTER\s0 but without
overflow checks. So if your counter does not reset at 32 or 64 bit you
might want to use \s-1DERIVE\s0 and combine it with a \s-1MIN\s0 value of 0.
-.RS 4
-.IP "\s-1NOTE\s0 on \s-1COUNTER\s0 vs \s-1DERIVE\s0" 4
-.IX Item "NOTE on COUNTER vs DERIVE"
+.Sp
+\&\fB\s-1NOTE\s0 on \s-1COUNTER\s0 vs \s-1DERIVE\s0\fR
+.Sp
by Don Baarda
.Sp
If you cannot tolerate ever mistaking the occasional counter reset for a
@@ -226,9 +225,6 @@ for high bandwidth interfaces and a 32bit counter, \s-1DERIVE\s0 with min=0 is
probably preferable. If you are using a 64bit counter, just about any max
setting will eliminate the possibility of mistaking a reset for a counter
wrap.
-.RE
-.RS 4
-.RE
.IP "\fB\s-1ABSOLUTE\s0\fR" 4
.IX Item "ABSOLUTE"
is for counters which get reset upon reading. This is used for fast counters
@@ -246,24 +242,22 @@ formula. Consolidation functions are then applied normally to the PDPs
of the \s-1COMPUTE\s0 data source (that is the rpn-expression is only applied
to generate PDPs). In database software, such data sets are referred
to as \*(L"virtual\*(R" or \*(L"computed\*(R" columns.
-.RE
-.RS 8
-.Sp
+.PP
\&\fIheartbeat\fR defines the maximum number of seconds that may pass
between two updates of this data source before the value of the
data source is assumed to be \fI*UNKNOWN*\fR.
-.Sp
+.PP
\&\fImin\fR and \fImax\fR define the expected range values for data supplied by a
data source. If \fImin\fR and/or \fImax\fR any value outside the defined range
will be regarded as \fI*UNKNOWN*\fR. 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 \s-1DS\s0. For a traffic\-\fB\s-1COUNTER\s0\fR type \s-1DS\s0 this would be
the maximum and minimum data-rate expected from the device.
-.Sp
+.PP
\&\fIIf information on minimal/maximal expected values is available,
always set the min and/or max properties. This will help RRDtool in
doing a simple sanity check on the data supplied when running update.\fR
-.Sp
+.PP
\&\fIrpn-expression\fR defines the formula used to compute the PDPs of a
\&\s-1COMPUTE\s0 data source from other data sources in the same <\s-1RRD\s0>. It is
similar to defining a \fB\s-1CDEF\s0\fR argument for the graph command. Please
@@ -274,22 +268,20 @@ the \s-1RPN\s0 expression, the \s-1COMPUTE\s0 data source may only refer to the
names of data source listed previously in the create command. This is
similar to the restriction that \fB\s-1CDEF\s0\fRs must refer only to \fB\s-1DEF\s0\fRs
and \fB\s-1CDEF\s0\fRs previously defined in the same graph command.
-.RE
-.IP "\fB\s-1RRA:\s0\fR\fI\s-1CF\s0\fR\fB:\fR\fIcf arguments\fR" 8
-.IX Item "RRA:CF:cf arguments"
+.Sh "\fB\s-1RRA:\s0\fP\fI\s-1CF\s0\fP\fB:\fP\fIcf arguments\fP"
+.IX Subsection "RRA:CF:cf arguments"
The purpose of an \fB\s-1RRD\s0\fR is to store data in the round robin archives
(\fB\s-1RRA\s0\fR). An archive consists of a number of data values or statistics for
each of the defined data-sources (\fB\s-1DS\s0\fR) and is defined with an \fB\s-1RRA\s0\fR line.
-.Sp
+.PP
When data is entered into an \fB\s-1RRD\s0\fR, it is first fit into time slots
of the length defined with the \fB\-s\fR option, thus becoming a \fIprimary
data point\fR.
-.Sp
+.PP
The data is also processed with the consolidation function (\fI\s-1CF\s0\fR) of
the archive. There are several consolidation functions that
consolidate primary data points via an aggregate function: \fB\s-1AVERAGE\s0\fR,
\&\fB\s-1MIN\s0\fR, \fB\s-1MAX\s0\fR, \fB\s-1LAST\s0\fR.
-.RS 8
.IP "\s-1AVERAGE\s0" 4
.IX Item "AVERAGE"
the average of the data points is stored.
@@ -302,29 +294,27 @@ the largest of the data points is stored.
.IP "\s-1LAST\s0" 4
.IX Item "LAST"
the last data points is used.
-.RE
-.RS 8
-.Sp
+.PP
Note that data aggregation inevitably leads to loss of precision and
information. The trick is to pick the aggregate function such that the
\&\fIinteresting\fR properties of your data is kept across the aggregation
process.
-.Sp
+.PP
The format of \fB\s-1RRA\s0\fR line for these
consolidation functions is:
-.Sp
+.PP
\&\fB\s-1RRA:\s0\fR\fI\s-1AVERAGE\s0 | \s-1MIN\s0 | \s-1MAX\s0 | \s-1LAST\s0\fR\fB:\fR\fIxff\fR\fB:\fR\fIsteps\fR\fB:\fR\fIrows\fR
-.Sp
+.PP
\&\fIxff\fR The xfiles factor defines what part of a consolidation interval may
be made up from \fI*UNKNOWN*\fR data while the consolidated value is still
regarded as known. It is given as the ratio of allowed \fI*UNKNOWN*\fR PDPs
to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive).
-.Sp
+.PP
\&\fIsteps\fR defines how many of these \fIprimary data points\fR are used to build
a \fIconsolidated data point\fR which then goes into the archive.
-.Sp
+.PP
\&\fIrows\fR defines how many generations of data values are kept in an \fB\s-1RRA\s0\fR.
-.RE
+Obviously, this has to be greater than zero.
.SH "Aberrant Behavior Detection with Holt-Winters Forecasting"
.IX Header "Aberrant Behavior Detection with Holt-Winters Forecasting"
In addition to the aggregate functions, there are a set of specialized
diff --git a/doc/rrdcreate.html b/doc/rrdcreate.html
index 52b82c1..97172f6 100644
--- a/doc/rrdcreate.html
+++ b/doc/rrdcreate.html
@@ -18,6 +18,15 @@
The create function of RRDtool lets you set up new Round Robin
Database (RRD) files. The file is created at its final, full size
and filled with *UNKNOWN* data.
Specifies the time in seconds since 1970-01-01 UTC when the first
value should be added to the RRD. RRDtool will not accept
any data timed before or at the time specified.
See also AT-STYLE TIME SPECIFICATION section in the
rrdfetch documentation for other ways to specify time.
A single RRD can accept input from several data sources (DS),
for example incoming and outgoing traffic on a specific communication
line. With the DS configuration option you must define some basic
@@ -118,10 +123,7 @@ example, to measure the rate of people entering or leaving a
room. Internally, derive works exactly like COUNTER but without
overflow checks. So if your counter does not reset at 32 or 64 bit you
might want to use DERIVE and combine it with a MIN value of 0.
If you cannot tolerate ever mistaking the occasional counter reset for a
legitimate counter wrap, and would prefer ``Unknowns'' for all legitimate
@@ -137,8 +139,6 @@ probably preferable. If you are using a 64bit counter, just about any max
setting will eliminate the possibility of mistaking a reset for a counter
wrap.
@@ -183,10 +183,9 @@ the RPN expression, the COMPUTE data source may only refer to the
names of data source listed previously in the create command. This is
similar to the restriction that CDEFs must refer only to DEFs
and CDEFs previously defined in the same graph command.
-
The purpose of an RRD is to store data in the round robin archives
(RRA). An archive consists of a number of data values or statistics for
each of the defined data-sources (DS) and is defined with an RRA line.
@@ -232,9 +231,8 @@ regarded as known. It is given as the ratio of allowed *UNKNOWN* PDPs
to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive).
steps defines how many of these primary data points are used to build
a consolidated data point which then goes into the archive.
-
rows defines how many generations of data values are kept in an RRA.
-
-
+
rows defines how many generations of data values are kept in an RRA.
+Obviously, this has to be greater than zero.
diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod
index 86817bd..abb42fc 100644
--- a/doc/rrdcreate.pod
+++ b/doc/rrdcreate.pod
@@ -16,15 +16,13 @@ The create function of RRDtool lets you set up new Round Robin
Database (B) files. The file is created at its final, full size
and filled with I<*UNKNOWN*> data.
-=over 8
-
-=item I
+=head2 I
The name of the B you want to create. B files should end
with the extension F<.rrd>. However, B will accept any
filename.
-=item B<--start>|B<-b> I (default: now - 10s)
+=head2 B<--start>|B<-b> I (default: now - 10s)
Specifies the time in seconds since 1970-01-01 UTC when the first
value should be added to the B. B will not accept
@@ -33,12 +31,12 @@ any data timed before or at the time specified.
See also AT-STYLE TIME SPECIFICATION section in the
I documentation for other ways to specify time.
-=item B<--step>|B<-s> I (default: 300 seconds)
+=head2 B<--step>|B<-s> I (default: 300 seconds)
Specifies the base interval in seconds with which data will be fed
into the B.
-=item BIB<:>IB<:>I
+=head2 BIB<:>IB<:>I
A single B can accept input from several data sources (B),
for example incoming and outgoing traffic on a specific communication
@@ -63,7 +61,7 @@ In order to decide which data source type to use, review the
definitions that follow. Also consult the section on "HOW TO MEASURE"
for further insight.
-=over 4
+=over
=item B
@@ -89,9 +87,7 @@ room. Internally, derive works exactly like COUNTER but without
overflow checks. So if your counter does not reset at 32 or 64 bit you
might want to use DERIVE and combine it with a MIN value of 0.
-=over
-
-=item NOTE on COUNTER vs DERIVE
+B
by Don Baarda Edon.baarda@baesystems.comE
@@ -110,8 +106,6 @@ probably preferable. If you are using a 64bit counter, just about any max
setting will eliminate the possibility of mistaking a reset for a counter
wrap.
-=back
-
=item B
is for counters which get reset upon reading. This is used for fast counters
@@ -159,8 +153,7 @@ names of data source listed previously in the create command. This is
similar to the restriction that Bs must refer only to Bs
and Bs previously defined in the same graph command.
-=item BIB<:>I
-
+=head2 BIB<:>I
The purpose of an B is to store data in the round robin archives
(B). An archive consists of a number of data values or statistics for
@@ -216,8 +209,7 @@ I defines how many of these I are used to build
a I which then goes into the archive.
I defines how many generations of data values are kept in an B.
-
-=back
+Obviously, this has to be greater than zero.
=head1 Aberrant Behavior Detection with Holt-Winters Forecasting
diff --git a/doc/rrdcreate.txt b/doc/rrdcreate.txt
index 1e361a8..22a83a6 100644
--- a/doc/rrdcreate.txt
+++ b/doc/rrdcreate.txt
@@ -15,188 +15,177 @@ DDEESSCCRRIIPPTTIIOONN
with _*_U_N_K_N_O_W_N_* data.
_f_i_l_e_n_a_m_e
- The name of the RRRRDD you want to create. RRRRDD files should end
- with the extension _._r_r_d. However, RRRRDDttooooll will accept any file-
- name.
- ----ssttaarrtt|--bb _s_t_a_r_t _t_i_m_e (default: now - 10s)
- Specifies the time in seconds since 1970-01-01 UTC when the
- first value should be added to the RRRRDD. RRRRDDttooooll will not accept
- any data timed before or at the time specified.
+ The name of the RRRRDD you want to create. RRRRDD files should end with the
+ extension _._r_r_d. However, RRRRDDttooooll will accept any filename.
- See also AT-STYLE TIME SPECIFICATION section in the _r_r_d_f_e_t_c_h
- documentation for other ways to specify time.
+ ----ssttaarrtt||--bb _s_t_a_r_t _t_i_m_e ((ddeeffaauulltt:: nnooww -- 1100ss))
- ----sstteepp|--ss _s_t_e_p (default: 300 seconds)
- Specifies the base interval in seconds with which data will be
- fed into the RRRRDD.
+ Specifies the time in seconds since 1970-01-01 UTC when the first value
+ should be added to the RRRRDD. RRRRDDttooooll will not accept any data timed
+ before or at the time specified.
+
+ See also AT-STYLE TIME SPECIFICATION section in the _r_r_d_f_e_t_c_h documenta-
+ tion for other ways to specify time.
+
+ ----sstteepp||--ss _s_t_e_p ((ddeeffaauulltt:: 330000 sseeccoonnddss))
+
+ Specifies the base interval in seconds with which data will be fed into
+ the RRRRDD.
DDSS::_d_s_-_n_a_m_e::_D_S_T::_d_s_t _a_r_g_u_m_e_n_t_s
- A single RRRRDD can accept input from several data sources (DDSS),
- for example incoming and outgoing traffic on a specific commu-
- nication line. With the DDSS configuration option you must define
- some basic properties of each data source you want to store in
- the RRRRDD.
-
- _d_s_-_n_a_m_e is the name you will use to reference this particular
- data source from an RRRRDD. A _d_s_-_n_a_m_e must be 1 to 19 characters
- long in the characters [a-zA-Z0-9_].
-
- _D_S_T defines the Data Source Type. The remaining arguments of a
- data source entry depend on the data source type. For GAUGE,
- COUNTER, DERIVE, and ABSOLUTE the format for a data source
- entry is:
-
- DDSS::_d_s_-_n_a_m_e::_G_A_U_G_E _| _C_O_U_N_T_E_R _| _D_E_R_I_V_E _| _A_B_S_O_L_U_T_E::_h_e_a_r_t_-
- _b_e_a_t::_m_i_n::_m_a_x
-
- For COMPUTE data sources, the format is:
-
- DDSS::_d_s_-_n_a_m_e::_C_O_M_P_U_T_E::_r_p_n_-_e_x_p_r_e_s_s_i_o_n
-
- In order to decide which data source type to use, review the
- definitions that follow. Also consult the section on "HOW TO
- MEASURE" for further insight.
-
- GGAAUUGGEE
- is for things like temperatures or number of people in a
- room or the value of a RedHat share.
-
- CCOOUUNNTTEERR
- is for continuous incrementing counters like the ifInOctets
- counter in a router. The CCOOUUNNTTEERR data source assumes that
- the counter never decreases, except when a counter over-
- flows. The update function takes the overflow into
- account. The counter is stored as a per-second rate. When
- the counter overflows, RRDtool checks if the overflow hap-
- pened at the 32bit or 64bit border and acts accordingly by
- adding an appropriate value to the result.
-
- DDEERRIIVVEE
- will store the derivative of the line going from the last
- to the current value of the data source. This can be useful
- for gauges, for example, to measure the rate of people
- entering or leaving a room. Internally, derive works
- exactly like COUNTER but without overflow checks. So if
- your counter does not reset at 32 or 64 bit you might want
- to use DERIVE and combine it with a MIN value of 0.
-
- NOTE on COUNTER vs DERIVE
- by Don Baarda
-
- If you cannot tolerate ever mistaking the occasional
- counter reset for a legitimate counter wrap, and would
- prefer "Unknowns" for all legitimate counter wraps and
- resets, always use DERIVE with min=0. Otherwise, using
- COUNTER with a suitable max will return correct values
- for all legitimate counter wraps, mark some counter
- resets as "Unknown", but can mistake some counter
- resets for a legitimate counter wrap.
-
- For a 5 minute step and 32-bit counter, the probability
- of mistaking a counter reset for a legitimate wrap is
- arguably about 0.8% per 1Mbps of maximum bandwidth.
- Note that this equates to 80% for 100Mbps interfaces,
- so for high bandwidth interfaces and a 32bit counter,
- DERIVE with min=0 is probably preferable. If you are
- using a 64bit counter, just about any max setting will
- eliminate the possibility of mistaking a reset for a
- counter wrap.
-
- AABBSSOOLLUUTTEE
- 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 after every read to
- make sure you have a maximum time available before the next
- overflow. Another usage is for things you count like number
- of messages since the last update.
-
- CCOOMMPPUUTTEE
- is for storing the result of a formula applied to other
- data sources in the RRRRDD. This data source is not supplied a
- value on update, but rather its Primary Data Points (PDPs)
- are computed from the PDPs of the data sources according to
- the rpn-expression that defines the formula. Consolidation
- functions are then applied normally to the PDPs of the COM-
- PUTE data source (that is the rpn-expression is only
- applied to generate PDPs). In database software, such data
- sets are referred to as "virtual" or "computed" columns.
-
- _h_e_a_r_t_b_e_a_t defines the maximum number of seconds that may pass
- between two updates of this data source before the value of the
- data source is assumed to be _*_U_N_K_N_O_W_N_*.
-
- _m_i_n and _m_a_x define the expected range values for data supplied
- by a data source. If _m_i_n and/or _m_a_x any value outside the
- defined range will be regarded as _*_U_N_K_N_O_W_N_*. 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-CCOOUUNNTTEERR type DS this would be the maximum and minimum
- data-rate expected from the device.
-
- _I_f _i_n_f_o_r_m_a_t_i_o_n _o_n _m_i_n_i_m_a_l_/_m_a_x_i_m_a_l _e_x_p_e_c_t_e_d _v_a_l_u_e_s _i_s _a_v_a_i_l_a_b_l_e_,
- _a_l_w_a_y_s _s_e_t _t_h_e _m_i_n _a_n_d_/_o_r _m_a_x _p_r_o_p_e_r_t_i_e_s_. _T_h_i_s _w_i_l_l _h_e_l_p _R_R_D_-
- _t_o_o_l _i_n _d_o_i_n_g _a _s_i_m_p_l_e _s_a_n_i_t_y _c_h_e_c_k _o_n _t_h_e _d_a_t_a _s_u_p_p_l_i_e_d _w_h_e_n
- _r_u_n_n_i_n_g _u_p_d_a_t_e_.
-
- _r_p_n_-_e_x_p_r_e_s_s_i_o_n defines the formula used to compute the PDPs of
- a COMPUTE data source from other data sources in the same
- . It is similar to defining a CCDDEEFF argument for the graph
- command. Please refer to that manual page for a list and
- description of RPN operations supported. For COMPUTE data
- sources, the following RPN operations are not supported: COUNT,
- PREV, TIME, and LTIME. In addition, in defining the RPN expres-
- sion, the COMPUTE data source may only refer to the names of
- data source listed previously in the create command. This is
- similar to the restriction that CCDDEEFFs must refer only to DDEEFFs
- and CCDDEEFFs previously defined in the same graph command.
+
+ A single RRRRDD can accept input from several data sources (DDSS), for exam-
+ ple incoming and outgoing traffic on a specific communication line.
+ With the DDSS configuration option you must define some basic properties
+ of each data source you want to store in the RRRRDD.
+
+ _d_s_-_n_a_m_e is the name you will use to reference this particular data
+ source from an RRRRDD. A _d_s_-_n_a_m_e must be 1 to 19 characters long in the
+ characters [a-zA-Z0-9_].
+
+ _D_S_T defines the Data Source Type. The remaining arguments of a data
+ source entry depend on the data source type. For GAUGE, COUNTER,
+ DERIVE, and ABSOLUTE the format for a data source entry is:
+
+ DDSS::_d_s_-_n_a_m_e::_G_A_U_G_E _| _C_O_U_N_T_E_R _| _D_E_R_I_V_E _| _A_B_S_O_L_U_T_E::_h_e_a_r_t_b_e_a_t::_m_i_n::_m_a_x
+
+ For COMPUTE data sources, the format is:
+
+ DDSS::_d_s_-_n_a_m_e::_C_O_M_P_U_T_E::_r_p_n_-_e_x_p_r_e_s_s_i_o_n
+
+ In order to decide which data source type to use, review the defini-
+ tions that follow. Also consult the section on "HOW TO MEASURE" for
+ further insight.
+
+ GGAAUUGGEE
+ is for things like temperatures or number of people in a room or
+ the value of a RedHat share.
+
+ CCOOUUNNTTEERR
+ is for continuous incrementing counters like the ifInOctets counter
+ in a router. The CCOOUUNNTTEERR data source assumes that the counter never
+ decreases, except when a counter overflows. The update function
+ takes the overflow into account. The counter is stored as a per-
+ second rate. When the counter overflows, RRDtool checks if the
+ overflow happened at the 32bit or 64bit border and acts accordingly
+ by adding an appropriate value to the result.
+
+ DDEERRIIVVEE
+ will store the derivative of the line going from the last to the
+ current value of the data source. This can be useful for gauges,
+ for example, to measure the rate of people entering or leaving a
+ room. Internally, derive works exactly like COUNTER but without
+ overflow checks. So if your counter does not reset at 32 or 64 bit
+ you might want to use DERIVE and combine it with a MIN value of 0.
+
+ NNOOTTEE oonn CCOOUUNNTTEERR vvss DDEERRIIVVEE
+
+ by Don Baarda
+
+ If you cannot tolerate ever mistaking the occasional counter reset
+ for a legitimate counter wrap, and would prefer "Unknowns" for all
+ legitimate counter wraps and resets, always use DERIVE with min=0.
+ Otherwise, using COUNTER with a suitable max will return correct
+ values for all legitimate counter wraps, mark some counter resets
+ as "Unknown", but can mistake some counter resets for a legitimate
+ counter wrap.
+
+ For a 5 minute step and 32-bit counter, the probability of mistak-
+ ing a counter reset for a legitimate wrap is arguably about 0.8%
+ per 1Mbps of maximum bandwidth. Note that this equates to 80% for
+ 100Mbps interfaces, so for high bandwidth interfaces and a 32bit
+ counter, DERIVE with min=0 is probably preferable. If you are using
+ a 64bit counter, just about any max setting will eliminate the pos-
+ sibility of mistaking a reset for a counter wrap.
+
+ AABBSSOOLLUUTTEE
+ is for counters which get reset upon reading. This is used for fast
+ counters which tend to overflow. So instead of reading them nor-
+ mally you reset them after every read to make sure you have a maxi-
+ mum time available before the next overflow. Another usage is for
+ things you count like number of messages since the last update.
+
+ CCOOMMPPUUTTEE
+ is for storing the result of a formula applied to other data
+ sources in the RRRRDD. This data source is not supplied a value on
+ update, but rather its Primary Data Points (PDPs) are computed from
+ the PDPs of the data sources according to the rpn-expression that
+ defines the formula. Consolidation functions are then applied nor-
+ mally to the PDPs of the COMPUTE data source (that is the rpn-
+ expression is only applied to generate PDPs). In database software,
+ such data sets are referred to as "virtual" or "computed" columns.
+
+ _h_e_a_r_t_b_e_a_t defines the maximum number of seconds that may pass between
+ two updates of this data source before the value of the data source is
+ assumed to be _*_U_N_K_N_O_W_N_*.
+
+ _m_i_n and _m_a_x define the expected range values for data supplied by a
+ data source. If _m_i_n and/or _m_a_x any value outside the defined range will
+ be regarded as _*_U_N_K_N_O_W_N_*. 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-CCOOUUNNTTEERR type DS this would be
+ the maximum and minimum data-rate expected from the device.
+
+ _I_f _i_n_f_o_r_m_a_t_i_o_n _o_n _m_i_n_i_m_a_l_/_m_a_x_i_m_a_l _e_x_p_e_c_t_e_d _v_a_l_u_e_s _i_s _a_v_a_i_l_a_b_l_e_, _a_l_w_a_y_s
+ _s_e_t _t_h_e _m_i_n _a_n_d_/_o_r _m_a_x _p_r_o_p_e_r_t_i_e_s_. _T_h_i_s _w_i_l_l _h_e_l_p _R_R_D_t_o_o_l _i_n _d_o_i_n_g _a
+ _s_i_m_p_l_e _s_a_n_i_t_y _c_h_e_c_k _o_n _t_h_e _d_a_t_a _s_u_p_p_l_i_e_d _w_h_e_n _r_u_n_n_i_n_g _u_p_d_a_t_e_.
+
+ _r_p_n_-_e_x_p_r_e_s_s_i_o_n defines the formula used to compute the PDPs of a
+ COMPUTE data source from other data sources in the same . It is
+ similar to defining a CCDDEEFF argument for the graph command. Please refer
+ to that manual page for a list and description of RPN operations sup-
+ ported. For COMPUTE data sources, the following RPN operations are not
+ supported: COUNT, PREV, TIME, and LTIME. In addition, in defining the
+ RPN expression, the COMPUTE data source may only refer to the names of
+ data source listed previously in the create command. This is similar to
+ the restriction that CCDDEEFFs must refer only to DDEEFFs and CCDDEEFFs previously
+ defined in the same graph command.
RRRRAA::_C_F::_c_f _a_r_g_u_m_e_n_t_s
- The purpose of an RRRRDD is to store data in the round robin
- archives (RRRRAA). An archive consists of a number of data values
- or statistics for each of the defined data-sources (DDSS) and is
- defined with an RRRRAA line.
- When data is entered into an RRRRDD, it is first fit into time
- slots of the length defined with the --ss option, thus becoming a
- _p_r_i_m_a_r_y _d_a_t_a _p_o_i_n_t.
+ The purpose of an RRRRDD is to store data in the round robin archives
+ (RRRRAA). An archive consists of a number of data values or statistics for
+ each of the defined data-sources (DDSS) and is defined with an RRRRAA line.
+
+ When data is entered into an RRRRDD, it is first fit into time slots of
+ the length defined with the --ss option, thus becoming a _p_r_i_m_a_r_y _d_a_t_a
+ _p_o_i_n_t.
- The data is also processed with the consolidation function (_C_F)
- of the archive. There are several consolidation functions that
- consolidate primary data points via an aggregate function:
- AAVVEERRAAGGEE, MMIINN, MMAAXX, LLAASSTT.
+ The data is also processed with the consolidation function (_C_F) of the
+ archive. There are several consolidation functions that consolidate
+ primary data points via an aggregate function: AAVVEERRAAGGEE, MMIINN, MMAAXX, LLAASSTT.
- AVERAGE
- the average of the data points is stored.
+ AVERAGE
+ the average of the data points is stored.
- MIN the smallest of the data points is stored.
+ MIN the smallest of the data points is stored.
- MAX the largest of the data points is stored.
+ MAX the largest of the data points is stored.
- LAST
- the last data points is used.
+ LAST
+ the last data points is used.
- Note that data aggregation inevitably leads to loss of preci-
- sion and information. The trick is to pick the aggregate func-
- tion such that the _i_n_t_e_r_e_s_t_i_n_g properties of your data is kept
- across the aggregation process.
+ Note that data aggregation inevitably leads to loss of precision and
+ information. The trick is to pick the aggregate function such that the
+ _i_n_t_e_r_e_s_t_i_n_g properties of your data is kept across the aggregation pro-
+ cess.
- The format of RRRRAA line for these consolidation functions is:
+ The format of RRRRAA line for these consolidation functions is:
- RRRRAA::_A_V_E_R_A_G_E _| _M_I_N _| _M_A_X _| _L_A_S_T::_x_f_f::_s_t_e_p_s::_r_o_w_s
+ RRRRAA::_A_V_E_R_A_G_E _| _M_I_N _| _M_A_X _| _L_A_S_T::_x_f_f::_s_t_e_p_s::_r_o_w_s
- _x_f_f The xfiles factor defines what part of a consolidation
- interval may be made up from _*_U_N_K_N_O_W_N_* data while the consoli-
- dated value is still regarded as known. It is given as the
- ratio of allowed _*_U_N_K_N_O_W_N_* PDPs to the number of PDPs in the
- interval. Thus, it ranges from 0 to 1 (exclusive).
+ _x_f_f The xfiles factor defines what part of a consolidation interval may
+ be made up from _*_U_N_K_N_O_W_N_* data while the consolidated value is still
+ regarded as known. It is given as the ratio of allowed _*_U_N_K_N_O_W_N_* PDPs
+ to the number of PDPs in the interval. Thus, it ranges from 0 to 1
+ (exclusive).
- _s_t_e_p_s defines how many of these _p_r_i_m_a_r_y _d_a_t_a _p_o_i_n_t_s are used to
- build a _c_o_n_s_o_l_i_d_a_t_e_d _d_a_t_a _p_o_i_n_t which then goes into the
- archive.
+ _s_t_e_p_s defines how many of these _p_r_i_m_a_r_y _d_a_t_a _p_o_i_n_t_s are used to build a
+ _c_o_n_s_o_l_i_d_a_t_e_d _d_a_t_a _p_o_i_n_t which then goes into the archive.
- _r_o_w_s defines how many generations of data values are kept in an
- RRRRAA.
+ _r_o_w_s defines how many generations of data values are kept in an RRRRAA.
+ Obviously, this has to be greater than zero.
AAbbeerrrraanntt BBeehhaavviioorr DDeetteeccttiioonn wwiitthh HHoolltt--WWiinntteerrss FFoorreeccaassttiinngg
In addition to the aggregate functions, there are a set of specialized
@@ -541,4 +530,4 @@ AAUUTTHHOORR
-1.3rc9 2008-05-12 RRDCREATE(1)
+1.3.0 2008-06-11 RRDCREATE(1)
diff --git a/doc/rrddump.1 b/doc/rrddump.1
index 9d444b1..cd71311 100644
--- a/doc/rrddump.1
+++ b/doc/rrddump.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "RRDDUMP 1"
-.TH RRDDUMP 1 "2008-05-16" "1.3rc9" "rrdtool"
+.TH RRDDUMP 1 "2008-05-16" "1.3.0" "rrdtool"
.SH "NAME"
rrddump \- dump the contents of an RRD to XML format
.SH "SYNOPSIS"
diff --git a/doc/rrddump.txt b/doc/rrddump.txt
index 164af9d..ca0c8c4 100644
--- a/doc/rrddump.txt
+++ b/doc/rrddump.txt
@@ -48,4 +48,4 @@ AAUUTTHHOORR
-1.3rc9 2008-05-16 RRDDUMP(1)
+1.3.0 2008-05-16 RRDDUMP(1)
diff --git a/doc/rrdfetch.1 b/doc/rrdfetch.1
index 5c7de01..9685270 100644
--- a/doc/rrdfetch.1
+++ b/doc/rrdfetch.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "RRDFETCH 1"
-.TH RRDFETCH 1 "2008-03-15" "1.3rc9" "rrdtool"
+.TH RRDFETCH 1 "2008-03-15" "1.3.0" "rrdtool"
.SH "NAME"
rrdfetch \- Fetch data from an RRD.
.SH "SYNOPSIS"
diff --git a/doc/rrdfetch.txt b/doc/rrdfetch.txt
index 702903d..6033e37 100644
--- a/doc/rrdfetch.txt
+++ b/doc/rrdfetch.txt
@@ -228,4 +228,4 @@ AAUUTTHHOORR
-1.3rc9 2008-03-15 RRDFETCH(1)
+1.3.0 2008-03-15 RRDFETCH(1)
diff --git a/doc/rrdfirst.1 b/doc/rrdfirst.1
index 128bcd9..212e086 100644
--- a/doc/rrdfirst.1
+++ b/doc/rrdfirst.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "RRDFIRST 1"
-.TH RRDFIRST 1 "2008-03-15" "1.3rc9" "rrdtool"
+.TH RRDFIRST 1 "2008-03-15" "1.3.0" "rrdtool"
.SH "NAME"
rrdfirst \- Return the date of the first data sample in an RRA within an RRD
.SH "SYNOPSIS"
diff --git a/doc/rrdfirst.txt b/doc/rrdfirst.txt
index ee3541c..659b106 100644
--- a/doc/rrdfirst.txt
+++ b/doc/rrdfirst.txt
@@ -26,4 +26,4 @@ AAUUTTHHOORR
-1.3rc9 2008-03-15 RRDFIRST(1)
+1.3.0 2008-03-15 RRDFIRST(1)
diff --git a/doc/rrdgraph.1 b/doc/rrdgraph.1
index 096f25b..4983013 100644
--- a/doc/rrdgraph.1
+++ b/doc/rrdgraph.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "RRDGRAPH 1"
-.TH RRDGRAPH 1 "2008-06-05" "1.3rc9" "rrdtool"
+.TH RRDGRAPH 1 "2008-06-11" "1.3.0" "rrdtool"
.SH "NAME"
rrdgraph \- Round Robin Database tool grapher functions
.SH "SYNOPSIS"
@@ -176,25 +176,25 @@ When you are done fetching and processing the data, it is time to
graph it (or print it). This ends the \fBrrdtool graph\fR sequence.
.SH "OPTIONS"
.IX Header "OPTIONS"
-.IP "\fBgraphv\fR" 4
-.IX Item "graphv"
+.Sh "\fBgraphv\fP"
+.IX Subsection "graphv"
This alternate version of \fBgraph\fR takes the same arguments and performs the
same function. The \fIv\fR stands for \fIverbose\fR, which describes the output
returned. \fBgraphv\fR will return a lot of information about the graph using
the same format as rrdtool info (key = value). See the bottom of the document for more information.
-.IP "filename" 4
-.IX Item "filename"
+.Sh "\fIfilename\fP"
+.IX Subsection "filename"
The name and path of the graph to generate. It is recommended to
end this in \f(CW\*(C`.png\*(C'\fR, \f(CW\*(C`.svg\*(C'\fR or \f(CW\*(C`.eps\*(C'\fR, but \fBRRDtool\fR does not enforce this.
-.Sp
+.PP
\&\fIfilename\fR can be '\f(CW\*(C`\-\*(C'\fR' to send the image to \f(CW\*(C`stdout\*(C'\fR. In
this case, no other output is generated.
-.IP "Time range" 4
-.IX Item "Time range"
+.Sh "Time range"
+.IX Subsection "Time range"
[\fB\-s\fR|\fB\-\-start\fR \fItime\fR]
[\fB\-e\fR|\fB\-\-end\fR \fItime\fR]
[\fB\-S\fR|\fB\-\-step\fR \fIseconds\fR]
-.Sp
+.PP
The start and end of the time series you would like to display, and which
\&\fB\s-1RRA\s0\fR the data should come from. Defaults are: 1 day ago until
now, with the best possible resolution. \fBStart\fR and \fBend\fR can
@@ -206,46 +206,46 @@ resolution. With the \fBstep\fR option you can alter this behaviour.
If you want \fBrrdtool graph\fR to get data at a one-hour resolution
from the \fB\s-1RRD\s0\fR, set \fBstep\fR to 3'600. Note: a step smaller than
one pixel will silently be ignored.
-.IP "Labels" 4
-.IX Item "Labels"
+.Sh "Labels"
+.IX Subsection "Labels"
[\fB\-t\fR|\fB\-\-title\fR \fIstring\fR]
[\fB\-v\fR|\fB\-\-vertical\-label\fR \fIstring\fR]
-.Sp
+.PP
A horizontal string at the top of the graph and/or a vertically
placed string at the left hand side of the graph.
-.IP "Size" 4
-.IX Item "Size"
+.Sh "Size"
+.IX Subsection "Size"
[\fB\-w\fR|\fB\-\-width\fR \fIpixels\fR]
[\fB\-h\fR|\fB\-\-height\fR \fIpixels\fR]
[\fB\-j\fR|\fB\-\-only\-graph\fR]
[\fB\-D\fR|\fB\-\-full\-size\-mode\fR]
-.Sp
+.PP
By default, the width and height of the \fBcanvas\fR (the part with
the actual data and such). This defaults to 400 pixels by 100 pixels.
-.Sp
+.PP
If you specify the \fB\-\-full\-size\-mode\fR option, the width and height
specify the final dimensions of the output image and the canvas
is automatically resized to fit.
-.Sp
+.PP
If you specify the \fB\-\-only\-graph\fR option and set the height < 32
pixels you will get a tiny graph image (thumbnail) to use as an icon
for use in an overview, for example. All labeling will be stripped off
the graph.
-.IP "Limits" 4
-.IX Item "Limits"
+.Sh "Limits"
+.IX Subsection "Limits"
[\fB\-u\fR|\fB\-\-upper\-limit\fR \fIvalue\fR]
[\fB\-l\fR|\fB\-\-lower\-limit\fR \fIvalue\fR]
[\fB\-r\fR|\fB\-\-rigid\fR]
-.Sp
+.PP
By default the graph will be autoscaling so that it will adjust the
y\-axis to the range of the data. You can change this behaviour by
explicitly setting the limits. The displayed y\-axis will then range at
least from \fBlower-limit\fR to \fBupper-limit\fR. Autoscaling will still
permit those boundaries to be stretched unless the \fBrigid\fR option is
set.
-.Sp
+.PP
[\fB\-A\fR|\fB\-\-alt\-autoscale\fR]
-.Sp
+.PP
Sometimes the default algorithm for selecting the y\-axis scale is not
satisfactory. Normally the scale is selected from a predefined
set of ranges and this fails miserably when you need to graph something
@@ -253,38 +253,35 @@ like \f(CW\*(C`260 + 0.001 * sin(x)\*(C'\fR. This option calculates the minimum
maximum y\-axis from the actual minimum and maximum data values. Our example
would display slightly less than \f(CW\*(C`260\-0.001\*(C'\fR to slightly more than
\&\f(CW\*(C`260+0.001\*(C'\fR (this feature was contributed by Sasha Mikheev).
-.Sp
+.PP
[\fB\-J\fR|\fB\-\-alt\-autoscale\-min\fR]
-.Sp
+.PP
Where \f(CW\*(C`\-\-alt\-autoscale\*(C'\fR will modify both the absolute maximum \s-1AND\s0 minimum
values, this option will only affect the minimum value. The maximum
value, if not defined on the command line, will be 0. This option can
be useful when graphing router traffic when the \s-1WAN\s0 line uses compression,
and thus the throughput may be higher than the \s-1WAN\s0 line speed.
-.Sp
+.PP
[\fB\-M\fR|\fB\-\-alt\-autoscale\-max\fR]
-.Sp
+.PP
Where \f(CW\*(C`\-\-alt\-autoscale\*(C'\fR will modify both the absolute maximum \s-1AND\s0 minimum
values, this option will only affect the maximum value. The minimum
value, if not defined on the command line, will be 0. This option can
be useful when graphing router traffic when the \s-1WAN\s0 line uses compression,
and thus the throughput may be higher than the \s-1WAN\s0 line speed.
-.Sp
+.PP
[\fB\-N\fR|\fB\-\-no\-gridfit\fR]
-.Sp
+.PP
In order to avoid anti-aliasing blurring effects rrdtool snaps
points to device resolution pixels, this results in a crisper
aperance. If this is not to your liking, you can use this switch
to turn this behaviour off.
-.Sp
+.PP
Gridfitting is turned off for \s-1PDF\s0, \s-1EPS\s0, \s-1SVG\s0 output by default.
-.IP "Grid" 4
-.IX Item "Grid"
-.RS 4
-.PD 0
+.Sh "Grid"
+.IX Subsection "Grid"
.IP "X\-Axis" 4
.IX Item "X-Axis"
-.PD
[\fB\-x\fR|\fB\-\-x\-grid\fR \fI\s-1GTM\s0\fR\fB:\fR\fI\s-1GST\s0\fR\fB:\fR\fI\s-1MTM\s0\fR\fB:\fR\fI\s-1MST\s0\fR\fB:\fR\fI\s-1LTM\s0\fR\fB:\fR\fI\s-1LST\s0\fR\fB:\fR\fI\s-1LPR\s0\fR\fB:\fR\fI\s-1LFM\s0\fR]
.Sp
[\fB\-x\fR|\fB\-\-x\-grid\fR \fBnone\fR]
@@ -377,31 +374,28 @@ fideling with the y\-axis labeling.
With this option y\-axis values on logarithmic graphs will be scaled to
the appropriate units (k, M, etc.) instead of using exponential notation.
Note that for linear graphs, \s-1SI\s0 notation is used by default.
-.RE
-.RS 4
-.RE
-.IP "Miscellaneous" 4
-.IX Item "Miscellaneous"
+.Sh "Miscellaneous"
+.IX Subsection "Miscellaneous"
[\fB\-z\fR|\fB\-\-lazy\fR]
-.Sp
+.PP
Only generate the graph if the current graph is out of date or not
existent.
-.Sp
+.PP
[\fB\-f\fR|\fB\-\-imginfo\fR \fIprintfstr\fR]
-.Sp
+.PP
After the image has been created, the graph function uses printf
together with this format string to create output similar to the \s-1PRINT\s0
function, only that the printf function is supplied with the parameters
\&\fIfilename\fR, \fIxsize\fR and \fIysize\fR. In order to generate an \fB\s-1IMG\s0\fR tag
suitable for including the graph into a web page, the command line
would look like this:
-.Sp
+.PP
.Vb 1
\& \-\-imginfo \(aq\(aq
.Ve
-.Sp
+.PP
[\fB\-c\fR|\fB\-\-color\fR \fI\s-1COLORTAG\s0\fR#\fIrrggbb\fR[\fIaa\fR]]
-.Sp
+.PP
Override the default colors for the standard elements of the graph. The
\&\fI\s-1COLORTAG\s0\fR is one of \f(CW\*(C`BACK\*(C'\fR background, \f(CW\*(C`CANVAS\*(C'\fR for the background of
the actual graph, \f(CW\*(C`SHADEA\*(C'\fR for the left and top border, \f(CW\*(C`SHADEB\*(C'\fR for the
@@ -413,35 +407,35 @@ specifying its rgb color component (00 is off, \s-1FF\s0 is maximum) of red, gre
and blue. Optionally you may add another hexadecimal number specifying the
transparency (\s-1FF\s0 is solid). You may set this option several times to alter
multiple defaults.
-.Sp
+.PP
A green arrow is made by: \f(CW\*(C`\-\-color ARROW#00FF00\*(C'\fR
-.Sp
+.PP
[\fB\-\-zoom\fR \fIfactor\fR]
-.Sp
+.PP
Zoom the graphics by the given amount. The factor must be > 0
-.Sp
+.PP
[\fB\-n\fR|\fB\-\-font\fR \fI\s-1FONTTAG\s0\fR\fB:\fR\fIsize\fR\fB:\fR[\fIfont\fR]]
-.Sp
+.PP
This lets you customize which font to use for the various text
elements on the \s-1RRD\s0 graphs. \f(CW\*(C`DEFAULT\*(C'\fR sets the default value for all
elements, \f(CW\*(C`TITLE\*(C'\fR for the title, \f(CW\*(C`AXIS\*(C'\fR for the axis labels, \f(CW\*(C`UNIT\*(C'\fR
for the vertical unit label, \f(CW\*(C`LEGEND\*(C'\fR for the graph legend.
-.Sp
+.PP
Use Times for the title: \f(CW\*(C`\-\-font TITLE:13:Times\*(C'\fR
-.Sp
+.PP
If you do not give a font string you can modify just the sice of the default font:
\&\f(CW\*(C`\-\-font TITLE:13:\*(C'\fR.
-.Sp
+.PP
If you specify the size 0 then you can modify just the font without touching
the size. This is especially usefull for altering the default font without
resetting the default fontsizes: \f(CW\*(C`\-\-font DEFAULT:0:Courier\*(C'\fR.
-.Sp
+.PP
RRDtool comes with a preset default font. You can set the environment
variable \f(CW\*(C`RRD_DEFAULT_FONT\*(C'\fR if you want to change this.
-.Sp
+.PP
RRDtool uses Pango for its font handling. This means you can to use
the full Pango syntax when selecting your font:
-.Sp
+.PP
The font name has the form "[\fIFAMILY-LIST\fR] [\fISTYLE-OPTIONS\fR] [\fI\s-1SIZE\s0\fR]",
where \fIFAMILY-LIST\fR is a comma separated list of families optionally
terminated by a comma, \fI\s-1STYLE_OPTIONS\s0\fR is a whitespace separated list of
@@ -449,37 +443,37 @@ words where each \s-1WORD\s0 describes one of style, variant, weight, stretch, o
gravity, and \fI\s-1SIZE\s0\fR is a decimal number (size in points) or optionally
followed by the unit modifier \*(L"px\*(R" for absolute size. Any one of the options
may be absent.
-.Sp
+.PP
[\fB\-R\fR|\fB\-\-font\-render\-mode\fR {\fBnormal\fR,\fBlight\fR,\fBmono\fR}]
-.Sp
+.PP
There are 3 font render modes:
-.Sp
+.PP
\&\fBnormal\fR: Full Hinting and Antialiasing (default)
-.Sp
+.PP
\&\fBlight\fR: Slight Hinting and Antialiasing
-.Sp
+.PP
\&\fBmono\fR: Full Hinting and \s-1NO\s0 Antialiasing
-.Sp
+.PP
[\fB\-B\fR|\fB\-\-font\-smoothing\-threshold\fR \fIsize\fR]
-.Sp
+.PP
(this gets ignored in 1.3 for now!)
-.Sp
+.PP
This specifies the largest font size which will be rendered
bitmapped, that is, without any font smoothing. By default,
no text is rendered bitmapped.
-.Sp
+.PP
[\fB\-P\fR|\fB\-\-pango\-markup\fR]
-.Sp
+.PP
All text in rrdtool is rendered using Pango. With the \fB\-\-pango\-markup\fR option, all
text will be processed by pango markup. This allows to embed some simple html
like markup tags using
-.Sp
+.PP
.Vb 1
\& text
.Ve
-.Sp
+.PP
Apart from the verbose syntax, there are also the following short tags available.
-.Sp
+.PP
.Vb 9
\& b Bold
\& big Makes font relatively larger, equivalent to
@@ -491,74 +485,74 @@ Apart from the verbose syntax, there are also the following short tags available
\& tt Monospace font
\& u Underline
.Ve
-.Sp
+.PP
More details on .
-.Sp
+.PP
[\fB\-G\fR|\fB\-\-graph\-render\-mode\fR {\fBnormal\fR,\fBmono\fR}]
-.Sp
+.PP
There are 2 render modes:
-.Sp
+.PP
\&\fBnormal\fR: Graphs are fully Antialiased (default)
-.Sp
+.PP
\&\fBmono\fR: No Antialiasing
-.Sp
+.PP
[\fB\-E\fR|\fB\-\-slope\-mode\fR]
-.Sp
+.PP
RRDtool graphs are composed of stair case curves by default. This is in line with
the way RRDtool calculates its data. Some people favor a more 'organic' look
for their graphs even though it is not all that true.
-.Sp
+.PP
[\fB\-a\fR|\fB\-\-imgformat\fR \fB\s-1PNG\s0\fR|\fB\s-1SVG\s0\fR|\fB\s-1EPS\s0\fR|\fB\s-1PDF\s0\fR]
-.Sp
+.PP
Image format for the generated graph. For the vector formats you can
choose among the standard Postscript fonts Courier\-Bold,
Courier\-BoldOblique, Courier\-Oblique, Courier, Helvetica\-Bold,
Helvetica\-BoldOblique, Helvetica\-Oblique, Helvetica, Symbol,
Times\-Bold, Times\-BoldItalic, Times\-Italic, Times\-Roman, and ZapfDingbats.
-.Sp
+.PP
[\fB\-i\fR|\fB\-\-interlaced\fR]
-.Sp
+.PP
(this gets ignored in 1.3 for now!)
-.Sp
+.PP
If images are interlaced they become visible on browsers more quickly.
-.Sp
+.PP
[\fB\-g\fR|\fB\-\-no\-legend\fR]
-.Sp
+.PP
Suppress generation of the legend; only render the graph.
-.Sp
+.PP
[\fB\-F\fR|\fB\-\-force\-rules\-legend\fR]
-.Sp
+.PP
Force the generation of \s-1HRULE\s0 and \s-1VRULE\s0 legends even if those \s-1HRULE\s0 or
\&\s-1VRULE\s0 will not be drawn because out of graph boundaries (mimics
behaviour of pre 1.0.42 versions).
-.Sp
+.PP
[\fB\-T\fR|\fB\-\-tabwidth\fR \fIvalue\fR]
-.Sp
+.PP
By default the tab-width is 40 pixels, use this option to change it.
-.Sp
+.PP
[\fB\-b\fR|\fB\-\-base\fR \fIvalue\fR]
-.Sp
+.PP
If you are graphing memory (and \s-1NOT\s0 network traffic) this switch
should be set to 1024 so that one Kb is 1024 byte. For traffic
measurement, 1 kb/s is 1000 b/s.
-.Sp
+.PP
[\fB\-W\fR|\fB\-\-watermark\fR \fIstring\fR]
-.Sp
+.PP
Adds the given string as a watermark, horizontally centred, at the bottom
of the graph.
-.IP "Data and variables" 4
-.IX Item "Data and variables"
+.Sh "Data and variables"
+.IX Subsection "Data and variables"
\&\fB\s-1DEF:\s0\fR\fIvname\fR\fB=\fR\fIrrdfile\fR\fB:\fR\fIds-name\fR\fB:\fR\fI\s-1CF\s0\fR[\fB:step=\fR\fIstep\fR][\fB:start=\fR\fItime\fR][\fB:end=\fR\fItime\fR]
-.Sp
+.PP
\&\fB\s-1CDEF:\s0\fR\fIvname\fR\fB=\fR\fI\s-1RPN\s0 expression\fR
-.Sp
+.PP
\&\fB\s-1VDEF:\s0\fR\fIvname\fR\fB=\fR\fI\s-1RPN\s0 expression\fR
-.Sp
+.PP
You need at least one \fB\s-1DEF\s0\fR statement to generate anything. The
other statements are useful but optional.
See rrdgraph_data and rrdgraph_rpn for the exact format.
-.IP "Graph and print elements" 4
-.IX Item "Graph and print elements"
+.Sh "Graph and print elements"
+.IX Subsection "Graph and print elements"
You need at least one graph element to generate an image and/or
at least one print statement to generate a report.
See rrdgraph_graph for the exact format.
diff --git a/doc/rrdgraph.html b/doc/rrdgraph.html
index 5415923..b4db55e 100644
--- a/doc/rrdgraph.html
+++ b/doc/rrdgraph.html
@@ -22,6 +22,16 @@
This alternate version of graph takes the same arguments and performs the
same function. The v stands for verbose, which describes the output
returned. graphv will return a lot of information about the graph using
the same format as rrdtool info (key = value). See the bottom of the document for more information.
@@ -117,18 +124,16 @@ resolution. With the step option you can alter this behaviour.
If you want rrdtool graph to get data at a one-hour resolution
from the RRD, set step to 3'600. Note: a step smaller than
one pixel will silently be ignored.
-
[-w|--widthpixels]
[-h|--heightpixels]
[-j|--only-graph]
@@ -142,10 +147,9 @@ is automatically resized to fit.
pixels you will get a tiny graph image (thumbnail) to use as an icon
for use in an overview, for example. All labeling will be stripped off
the graph.
-
@@ -181,9 +185,9 @@ points to device resolution pixels, this results in a crisper
aperance. If this is not to your liking, you can use this switch
to turn this behaviour off.
Gridfitting is turned off for PDF, EPS, SVG output by default.
@@ -261,10 +265,9 @@ the appropriate units (k, M, etc.) instead of using exponential notation.
Note that for linear graphs, SI notation is used by default.
You need at least one graph element to generate an image and/or
at least one print statement to generate a report.
See the rrdgraph_graph manpage for the exact format.
diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod
index 159d6af..048171a 100644
--- a/doc/rrdgraph.pod
+++ b/doc/rrdgraph.pod
@@ -50,9 +50,8 @@ graph it (or print it). This ends the B sequence.
=head1 OPTIONS
-=over 4
-=item B
+=head2 B
This alternate version of B takes the same arguments and performs the
same function. The I stands for I, which describes the output
@@ -60,7 +59,7 @@ returned. B will return a lot of information about the graph using
the same format as rrdtool info (key = value). See the bottom of the document for more information.
-=item filename
+=head2 I
The name and path of the graph to generate. It is recommended to
end this in C<.png>, C<.svg> or C<.eps>, but B does not enforce this.
@@ -68,7 +67,7 @@ end this in C<.png>, C<.svg> or C<.eps>, but B does not enforce this.
I can be 'C<->' to send the image to C. In
this case, no other output is generated.
-=item Time range
+=head2 Time range
[B<-s>|B<--start> I