I've made a patch to rrdcgi to add <RRD::TIME::STRFTIME ...> which allows

[rrdtool.git] / doc / rrdupdate.pod

diff --git a/doc/rrdupdate.pod b/doc/rrdupdate.pod
index 1fd3210..d10846f 100644 (file)
--- a/doc/rrdupdate.pod
+++ b/doc/rrdupdate.pod
@@ -6,7 +6,7 @@ rrdtool update - Store a new set of values into the rrd
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<rrdtool> B<update> I<filename> 
+B<rrdtool> {B<update> | B<updatev>} I<filename> 

 S<[B<--template>|B<-t> I<ds-name>[B<:>I<ds-name>]...]> 
 S<B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]> 
 S<I<at-timestamp>B<@>I<value>[B<:>I<value>...]> 
 S<[B<--template>|B<-t> I<ds-name>[B<:>I<ds-name>]...]> 
 S<B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]> 
 S<I<at-timestamp>B<@>I<value>[B<:>I<value>...]> 


@@ -20,6 +20,17 @@ which the data is written.
 
 =over 8
 
 
 =over 8
 

+=item B<updatev>
+
+This alternate version of B<update> takes the same arguments and
+performs the same function. The I<v> stands for I<verbose>, which
+describes the output returned. B<updatev> 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<filename>
 
 The name of the B<RRD> you want to update.
 =item I<filename>
 
 The name of the B<RRD> you want to update.


@@ -65,7 +76,7 @@ B<U> (eg. 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
 
 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 my impose their very own parsing of this parameter as long as the colon
+modules may impose their very own parsing of this parameter as long as the colon

 (B<:>) remains the data source value separator.
 
 =back
 (B<:>) remains the data source value separator.
 
 =back