rrdupdate(1): Documented the new options --[no]cache and --daemon.
authorFlorian Forster <octo@leeloo.home.verplant.org>
Sun, 22 Jun 2008 15:38:16 +0000 (17:38 +0200)
committerFlorian Forster <octo@leeloo.home.verplant.org>
Sun, 22 Jun 2008 15:38:16 +0000 (17:38 +0200)
doc/rrdupdate.pod

index cc0b452..5d6044a 100644 (file)
@@ -6,6 +6,8 @@ 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<--cache> | B<--nocache>]>
+S<[B<--daemon> I<address>]>
 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>...] ...]>
@@ -56,6 +58,36 @@ 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>.
 
+=item B<--cache> | B<--nocache>
+
+Force the use of the caching daemon or force direct file access. If B<--cache>
+is given, B<RRDTool> will try to contact the caching daemon B<RRDd> and will
+fail if it cannot connect to the daemon. If the connection is successfully
+established the values will be sent to the daemon instead of accessing the
+files directly. If B<--nocache> is given no connection attempt is made. If
+neither option is specified B<RRDTool> will try to contact the daemon and, if
+no connection may be established, will fall back to direct file access.
+
+Examples:
+
+  rrdtool update --cache /var/lib/rrd/foo.rrd N:123
+  rrdtool update --nocache /var/lib/rrd/bar.rrd N:234
+
+=item B<--daemon> I<address>
+
+Specifies the address of the caching daemon. If I<address> begins with C<unix:>
+the everything after this prefix will be considered to be a UNIX domain socket.
+Otherwise the address is interpreted as network address or node name as
+understood by L<getaddrinfo(3)>. One practical consequence is that both, IPv4
+and IPv6, may be used if the system supports it.
+
+Examples:
+
+  rrdtool update --daemon unix:/tmp/rrdd.sock /var/lib/rrd/foo.rrd N:123
+  rrdtool update --daemon ::1 /var/lib/rrd/bar.rrd N:234
+  rrdtool update --daemon 10.0.0.2 /var/lib/rrd/baz.rrd N:345
+  rrdtool update --daemon rrdtool.example.com /var/lib/rrd/qux.rrd N:456
+
 =item B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]
 
 The data used for updating the RRD was acquired at a certain
@@ -95,7 +127,8 @@ 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
 regular readings. The update interval seems to be around 300 seconds.
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Tobias Oetiker <tobi@oetiker.ch>
+Tobias Oetiker <tobi@oetiker.ch>,
+Florian Forster <octoE<nbsp>atE<nbsp>verplant.org>