Moved signal handler setup out of daemonize(). Coalesced common code

[rrdtool.git] / doc / rrdcached.pod
diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod

index bdb8949..d8d88c5 100644 (file)
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -35,14 +35,19 @@ interpreted as the path to a UNIX domain socket. Otherwise the address or node
  name are resolved using L<getaddrinfo>.
  
  For network sockets, a port may be specified by using the form
-I<address>:I<port>.  The default port is 42217.
+C<B<[>I<address>B<]:>I<port>>. If the address is an IPv4 address or a fully
+qualified domain name (i.E<nbsp>e. the address contains at least one dot
+(C<.>)), the square brackets can be omitted, resulting in the (simpler)
+C<I<address>B<:>I<port>> pattern.. The default port is B<42217/udp>.
  
-These formats are accepted:
+The following formats are accepted. Please note that the address of the UNIX
+domain socket B<must> start with a slash in the second case!
  
     unix:</path/to/unix.sock>
-   </path/to/unix.sock>
+   /<path/to/unix.sock>
     <hostname-or-ip>
-   <hostname-or-ip>:<port>
+   [<hostname-or-ip>]:<port>
+   <hostname-or-ipv4>:<port>
  
  If the B<-l> option is not specified the default address,
  C<unix:/tmp/rrdcached.sock>, will be used.
@@ -182,9 +187,8 @@ The downside of caching values is that they won't show up in graphs generated
  from the RRDE<nbsp>files. To get around this, the daemon provides the "flush
  command" to flush specific files. This means that the file is inserted at the
  B<head> of the update queue or moved there if it is already enqueued. The flush
-command will return after the update thread has dequeued the file, so there is
-a good chance that the file has been updated by the time the client receives
-the response from the daemon, but there is no guarantee.
+command will return only after the file's pending updates have been written
+to disk.
  
   +------+   +------+                               +------+
   ! head !   ! root !                               ! tail !
@@ -312,6 +316,11 @@ Causes the daemon to put I<filename> to the B<head> of the update queue
  (possibly moving it there if the node is already enqueued). The answer will be
  sent B<after> the node has been dequeued.
  
+=item B<FLUSHALL>
+
+Causes the daemon to start flushing ALL pending values to disk.  This
+returns immediately, even though the writes may take a long time.
+
  =item B<HELP> [I<command>]
  
  Returns a short usage message. If no command is given, or I<command> is
@@ -406,6 +415,16 @@ Number of times the journal has been rotated since startup.
  
  =back
  
+=head1 SIGNALS
+
+=over 4
+
+=item SIGINT and SIGTERM
+
+The daemon exits normally on receipt of either of these signals.
+
+=back
+
  =head1 BUGS
  
  No known bugs at the moment.