From: moli <phpmoli@users.noreply.github.com>
Date: Mon, 19 May 2014 18:58:38 +0000 (+0200)
Subject: mods of #477 added clarifications
X-Git-Tag: v1.5.0-rc1~80^2~2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=1287ce48a6e8468d093781bd226483052ac2c79f;p=thirdparty%2Frrdtool-1.x.git

mods of #477 added clarifications

added text explaining templates cannot be used with rrdcached
rewrote timestamp syntax, maybe now it went to the other extreme..
removed deprecated --cache parameter from the example section
fixed --daemon behaviour description, please check if it is true
---

diff --git a/doc/rrdupdate.pod b/doc/rrdupdate.pod
index 7be2da08..221aad57 100644
--- a/doc/rrdupdate.pod
+++ b/doc/rrdupdate.pod
@@ -7,9 +7,7 @@ rrdupdate - Store a new set of values into the RRD
 B<rrdtool> {B<update> | B<updatev>} I<filename>
 S<[B<--template>|B<-t> I<ds-name>[B<:>I<ds-name>]...]>
 S<[B<--daemon>|B<-d> I<address>]> [B<-->]
-S<B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]>
-S<I<at-timestamp>B<@>I<value>[B<:>I<value>...]>
-S<[I<timestamp>B<:>I<value>[B<:>I<value>...] ...]>
+S<{{B<N> | I<timestamp>}B<:> | I<at-timestamp>B<@>}I<value>[B<:>I<value>]... ...> 
 
 =head1 DESCRIPTION
 
@@ -60,6 +58,8 @@ function. If this is done accidentally (and this can only be done
 using the template switch), B<RRDtool> will ignore the value specified
 for the COMPUTE B<DST>.
 
+The caching daemon L<rrdcached> cannot be used together with templates yet.
+
 =item B<--skip-past-updates>
 
 When updateing an rrd file with data earlier than the latest update already
@@ -71,13 +71,15 @@ been applied.
 =item B<--daemon>|B<-d> I<address>
 
 If given, B<RRDTool> will try to connect to the caching daemon L<rrdcached>
-at I<address> and will fail if the connection cannot be established. If the
-connection is successfully established the values will be sent to the daemon
-instead of accessing the files directly.
+at I<address>. If the connection is successfully established the values will
+be sent to the daemon instead of accessing the files directly. If the
+connection cannot be established it will fall back to direct file-access.
+While this is convenient, it can silently create problems so please read
+the warning in the examples.
 
 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
 
-=item B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]
+=item {B<N> | I<timestamp>}B<:>I<value>[B<:>I<value>]...
 
 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
@@ -157,14 +159,6 @@ past and the current time as the update times.
 
 =item *
 
-C<rrdtool update --cache /var/lib/rrd/demo3.rrd N:42>
-
-Update the file C</var/lib/rrd/demo3.rrd> with a single data source, using the
-current time. If the caching daemon cannot be reached, do B<not> fall back to
-direct file access.
-
-=item *
-
 C<rrdtool update --daemon unix:/tmp/rrdd.sock demo4.rrd N:23>
 
 Use the UNIX domain socket C</tmp/rrdd.sock> to contact the caching daemon. If