This adds support for <address>:<port> in the rrd client library.

[rrdtool.git] / doc / rrdcached.pod

diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod
index 7631351..bdb8949 100644 (file)
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -34,6 +34,16 @@ socket. If I<address> begins with C<unix:>, everything following that prefix is
 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.
+
+These formats are accepted:
+
+   unix:</path/to/unix.sock>
+   </path/to/unix.sock>
+   <hostname-or-ip>
+   <hostname-or-ip>:<port>
+
 If the B<-l> option is not specified the default address,
 C<unix:/tmp/rrdcached.sock>, will be used.
 
@@ -128,6 +138,15 @@ 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 ERROR REPORTING
+
+The daemon reports errors in one of two ways: During startup, error messages
+are printed to C<STDERR>. One of the steps when starting up is to fork to the
+background and closing C<STDERR> - after this writing directly to the user is
+no longer possible. Once this has happened, the daemon will send log messages
+to the system logging daemon using L<syslog(3)>. The facility used it
+C<LOG_DAEMON>.
+
 =head1 HOW IT WORKS
 
 When receiving an update, B<rrdcached> does not write to disk but looks for an