X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=doc%2Frrdupdate.pod;h=2d4ee8c7dd4d94dfe7336f205dce1f00cacc5091;hb=cc75a60ee08484b09d9ce51a54383523c581bf96;hp=d35b35ba648e3498f2416435bfdacdfcbc4a4490;hpb=5571bcfcae02ea6cca124844489d683ff04a7502;p=rrdtool.git
diff --git a/doc/rrdupdate.pod b/doc/rrdupdate.pod
index d35b35b..2d4ee8c 100644
--- a/doc/rrdupdate.pod
+++ b/doc/rrdupdate.pod
@@ -1,12 +1,12 @@
=head1 NAME
-rrdtool update - Store a new set of values into the rrd
+rrdtool update - Store a new set of values into the RRD
=for html
=head1 SYNOPSIS
-B B I
+B {B | B} I
S<[B<--template>|B<-t> I[B<:>I]...]>
S|IB<:>I[B<:>I...]>
SB<@>I[B<:>I...]>
@@ -20,6 +20,17 @@ which the data is written.
=over 8
+=item B
+
+This alternate version of B takes the same arguments and
+performs the same function. The I stands for I, which
+describes the output returned. B returns a list of any and all
+consolidated data points (CDPs) written to disk as a result of the
+invocation of update. The values are indexed by timestamp (time_t),
+RRA (consolidation function and PDPs per CDP), and data source (name).
+Note that depending on the arguments of the current and previous call to
+update, the list may have no entries or a large number of entries.
+
=item I
The name of the B you want to update.
@@ -34,7 +45,7 @@ error resistant, as you might be sending the wrong data into a 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
-the template are not available in the rrd file, the update process
+the template are not available in the RRD file, the update process
will abort with an error message.
While it appears possible with the template switch to update data sources
@@ -42,7 +53,7 @@ asynchronously, B implicitly assigns non-COMPUTE data sources missing
from the template the I<*UNKNOWN*> value.
Do not specify a value for a COMPUTE B in the B function. If
-this is done accidently (and this can only be done using the template switch),
+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...]
@@ -59,9 +70,9 @@ 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.
+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 (eg. N:0.1:U:1) can be defined.
+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
@@ -77,7 +88,7 @@ C
Update the database file demo1.rrd with 3 known and one I<*UNKNOWN*>
value. Use the current time as the update time.
-C
+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