Summary of changes:

[rrdtool.git] / doc / rrdcached.pod

diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod
index 9aebfe7..57b54b2 100644 (file)
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -20,6 +20,7 @@ B<rrdcached>
 [-g]
 [B<-b>E<nbsp>I<base_dir>E<nbsp>[B<-B>]]
 [B<-a>E<nbsp>I<alloc_size>]
 [-g]
 [B<-b>E<nbsp>I<base_dir>E<nbsp>[B<-B>]]
 [B<-a>E<nbsp>I<alloc_size>]

+[-O]

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -245,6 +246,11 @@ exchange for slightly higher memory utilization.  The default isE<nbsp>1.
 Do not set this more than the B<-w> value divided by your average RRD step
 size.
 
 Do not set this more than the B<-w> value divided by your average RRD step
 size.
 

+=item B<-O> 
+
+Preven the CREATE command from overwriting existing files, even when it is
+instructed to do so.  This is for added security.
+

 =back
 
 =head1 AFFECTED RRDTOOL COMMANDS
 =back
 
 =head1 AFFECTED RRDTOOL COMMANDS


@@ -280,6 +286,10 @@ info
 
 =item *
 
 
 =item *
 

+first
+
+=item *
+

 last
 
 =item *
 last
 
 =item *


@@ -294,6 +304,10 @@ update
 
 xport
 
 
 xport
 

+=item *
+
+create
+

 =back
 
 The B<update> command can send values to the daemon instead of writing them to
 =back
 
 The B<update> command can send values to the daemon instead of writing them to


@@ -592,6 +606,34 @@ written out to disk.  It is used during journal replay to determine which
 updates have already been applied.  It is I<only> valid in the journal; it
 is not accepted from the other command channels.
 
 updates have already been applied.  It is I<only> valid in the journal; it
 is not accepted from the other command channels.
 

+=item B<FIRST> I<filename> [I<rranum>]
+
+Return the timestamp for the first CDP in the specified RRA.  Default is to 
+use RRA zero if none is specified.
+
+=item B<LAST> I<filename> 
+
+Return the timestamp for the last update to the specified RRD. Note that the
+cache is I<not> flushed before checking, as the client is expected to request
+this separately if it is required.
+
+=item B<INFO> I<filename> 
+
+Return the configuration information for the specified RRD. Note that the
+cache is I<not> flushed before checking, as the client is expected to request
+this separately if it is required.
+
+The information is returned, one item per line, with the format:
+
+ I<keyname> I<type> I<value>
+
+=item B<CREATE> I<filename> [-s I<stepsize>] [-b I<begintime>] [-O] I<DSdefinitions> ... I<RRAdefinitions> ...
+
+This will create the RRD file according to the supplied parameters, provided
+the parameters are valid, and (if the -O option is given or if the rrdcached
+was started with the -O flag) the specified I<filename> does not already
+exist.
+

 =item B<BATCH>
 
 This command initiates the bulk load of multiple commands.  This is
 =item B<BATCH>
 
 This command initiates the bulk load of multiple commands.  This is


@@ -713,6 +755,7 @@ Both B<rrdcached> and this manual page have been written by Florian.
 =head1 CONTRIBUTORS
 
 kevin brintnall E<lt>kbrint@rufus.netE<gt>
 =head1 CONTRIBUTORS
 
 kevin brintnall E<lt>kbrint@rufus.netE<gt>

+Steve Shipway E<lt>steve@steveshipway.orgE<gt> 

 
 =cut
 
 
 =cut