rrdcached(1): Document which commands are aware of the daemon.

[rrdtool.git] / doc / rrdcached.pod

diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod
index f40f065..fd6bc6c 100644 (file)
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -74,6 +74,38 @@ used.
 
 =back
 
+=head1 EFFECTED RRDTOOL COMMANDS
+
+The following commands may be made aware of the B<rrdcached> using the command
+line argument B<--daemon> or the environment variable B<RRDCACHED_ADDRESS>:
+
+=over 4
+
+=item B<dump>
+
+=item B<fetch>
+
+=item B<flush>
+
+=item B<graph>
+
+=item B<info>
+
+=item B<last>
+
+=item B<lastupdate>
+
+=item B<update>
+
+=item B<xport>
+
+=back
+
+The B<update> command can send values to the daemon instead of writing them to
+the disk itself. All other commands can send a B<FLUSH> command (see below) to
+the daemon before accessing the files, so they work with up-to-date data even
+if the cache timeout is large.
+
 =head1 HOW IT WORKS
 
 When receiving an update, B<rrdcached> does not write to disk but looks for an
@@ -160,7 +192,7 @@ Timed out values are inserted at the "tail".
 
 =item
 
-Explicitely flushed values are inserted at the "head".
+Explicitly flushed values are inserted at the "head".
 
 =item
 
@@ -214,7 +246,7 @@ Example:
   FLUSH /tmp/foo.rrd<LF>
 
 The daemon answers with a line consisting of a status code and a short status
-message, seperated by one or more space characters. A negative status code
+message, separated by one or more space characters. A negative status code
 signals an error, a positive status code or zero signal success. If the status
 code is greater than zero, it indicates the number of lines that follow the
 status line.
@@ -243,7 +275,7 @@ sent B<after> the node has been dequeued.
 
 Returns a short usage message. If no command is given, or I<command> is
 B<HELP>, a list of commands supported by the daemon is returned. Otherwise a
-short description, possibly containing a pointer to a manpage, is returned.
+short description, possibly containing a pointer to a manual page, is returned.
 Obviously, this is meant for interactive usage and the format in which the
 commands and usage summaries are returned is not well defined.
 
@@ -269,8 +301,8 @@ Example:
 =item B<UPDATE> I<filename> I<values> [I<values> ...]
 
 Adds more data to a filename. This is B<the> operation the daemon was designed
-for, so describing the mechanism again is inappropriate. Read L<HOW IT WORKS>
-above for a detailed description.
+for, so describing the mechanism again is unnecessary. Read L<HOW IT WORKS>
+above for a detailed explanation.
 
 =back