X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdupdate.pod;h=d10846f99a42162d6f690b753ec3c079dd7c1cb2;hb=e802fe69a7551c4a84c4f57f68a6f2c8685969a1;hp=1fd3210bd5fa8d6e6062bd50e41a3e4b9ccd8293;hpb=a278779cdf2ded56b89fc404d6914bff7ad7dcbd;p=rrdtool.git diff --git a/doc/rrdupdate.pod b/doc/rrdupdate.pod index 1fd3210..d10846f 100644 --- 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 -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. @@ -65,7 +76,7 @@ B (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 -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