X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdupdate.pod;h=d362f14e93e778ec28fcb6c27c6526e8c6d226ba;hb=9470c36a8d025ff8888f0b76264968ac0342aa9e;hp=fe5ff6d73124e5c99b26f99a1fe959a375c29a08;hpb=d50afc217aaec57e418a55bbe2d20fe996c6e026;p=rrdtool.git
diff --git a/doc/rrdupdate.pod b/doc/rrdupdate.pod
index fe5ff6d..d362f14 100644
--- a/doc/rrdupdate.pod
+++ b/doc/rrdupdate.pod
@@ -2,21 +2,19 @@
rrdupdate - Store a new set of values into the RRD
-=for html
-
=head1 SYNOPSIS
-B {B | B} I
-S<[B<--template>|B<-t> I[B<:>I]...]>
-S|IB<:>I[B<:>I...]>
-SB<@>I[B<:>I...]>
+B {B | B} I
+S<[B<--template>|B<-t> I[B<:>I]...]>
+S|IB<:>I[B<:>I...]>
+SB<@>I[B<:>I...]>
S<[IB<:>I[B<:>I...] ...]>
=head1 DESCRIPTION
-The B function feeds new data values into an B. The
-data gets time aligned according to the properties of the B to
-which the data is written.
+The B function feeds new data values into an B. The data
+is time aligned (interpolated) according to the properties of the
+B to which the data is written.
=over 8
@@ -37,11 +35,12 @@ The name of the B you want to update.
=item B<--template>|B<-t> I[B<:>I]...
-by default, the B function expects the data input in the order
-the data sources are defined in the RRD, excluding any COMPUTE data sources
-(i.e. if the third data source B is COMPUTE, the third input value
-will be mapped to the fourth data source in the B). This is not very
-error resistant, as you might be sending the wrong data into a RRD.
+By default, the B function expects its data input in the order
+the data sources are defined in the RRD, excluding any COMPUTE data
+sources (i.e. if the third data source B is COMPUTE, the third
+input value will be mapped to the fourth data source in the B and
+so on). This is not very error resistant, as you might be sending the
+wrong data into an RRD.
The template switch allows you to specify which data sources you are
going to update and in which order. If the data sources specified in
@@ -50,34 +49,36 @@ will abort with an error message.
While it appears possible with the template switch to update data sources
asynchronously, B implicitly assigns non-COMPUTE data sources missing
-from the template the I<*UNKNOWN*> value.
+from the template the I<*UNKNOWN*> value.
-Do not specify a value for a COMPUTE B in the B function. If
-this is done accidentally (and this can only be done using the template switch),
-B will ignore the value specified for the COMPUTE B.
+Do not specify a value for a COMPUTE B in the B
+function. If this is done accidentally (and this can only be done
+using the template switch), B will ignore the value specified
+for the COMPUTE B.
=item B|IB<:>I[B<:>I...]
-The data used for updating the RRD was acquired at a certain time. This
-time can either be defined in seconds since 1970-01-01. Or by using the
-letter 'N' the update time is set to be the current time. Negative time
-values are subtracted from the current time.
-An AT_STYLE TIME SPECIFICATION (see the I documentation) may
-also be used by delimiting the end of the time specification with the '@' character
-instead of a ':'.
-Getting the timing right to the second is especially
-important when you are working with data-sources of type B,
-B or B.
-
-The remaining elements of the argument are DS updates. The order of this list is
-the same as the order the data sources were defined in the RRA.
-If there is no data for a certain data-source, the letter
-B (e.g., N:0.1:U:1) can be defined.
-
-The format of the value acquired from the data source is dependent of the
-data source type chosen. Normally it will be numeric, but the data acquisition
-modules may impose their very own parsing of this parameter as long as the colon
-(B<:>) remains the data source value separator.
+The data used for updating the RRD was acquired at a certain
+time. This time can either be defined in seconds since 1970-01-01 or
+by using the letter 'N', in which case the update time is set to be
+the current time. Negative time values are subtracted from the current
+time. An AT_STYLE TIME SPECIFICATION (see the I
+documentation) may also be used by delimiting the end of the time
+specification with the '@' character instead of a ':'. Getting the
+timing right to the second is especially important when you are
+working with data-sources of type B, B or
+B.
+
+The remaining elements of the argument are DS updates. The order of
+this list is the same as the order the data sources were defined in
+the RRA. If there is no data for a certain data-source, the letter
+B (e.g., N:0.1:U:1) can be specified.
+
+The format of the value acquired from the data source is dependent on
+the data source type chosen. Normally it will be numeric, but the data
+acquisition modules may impose their very own parsing of this
+parameter as long as the colon (B<:>) remains the data source value
+separator.
=back
@@ -92,7 +93,7 @@ C
Update the database file demo2.rrd which expects data from a single
data-source, three times. First with an I<*UNKNOWN*> value then with two
-normal readings. The update interval seems to be around 300 seconds.
+regular readings. The update interval seems to be around 300 seconds.
=head1 AUTHOR