rrdcached(1): Documented the `-p' and `-b' options.

[rrdtool.git] / doc / rrdcached.pod

diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod
index 92c65cc..1429081 100644 (file)
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -23,30 +23,47 @@ work with up-to-date data.
 =item B<-l> I<address>
 
 Tells the daemon to bind to I<address> and accept incoming connections on that
-socket. If I<address> begins with C<unix:>, everthing following that prefix is
+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(3)>.
 
+If the B<-l> option is not specified the default address,
+C<unix:/tmp/rrdcached.sock>, will be used.
+
 =item B<-w> I<timeout>
 
-Data is written to disk every I<timeout> seconds.
+Data is written to disk every I<timeout> seconds. If this option is not
+specified the default interval of 300E<nbsp>seconds will be used.
 
 =item B<-f> I<timeout>
 
 Every I<timeout> seconds the entire cache is searched for old values which are
 written to disk. This only concerns files to which updates have stopped, so
-setting this to a high value, such as 3600 seconds, is acceptable in most
-cases.
-
-=back
-
-=head1 BUGS
-
-=over 4
-
-=item
-
-Base directory is currently hard coded. The daemon will chdir to C</tmp/>.
+setting this to a high value, such as 3600E<nbsp>seconds, is acceptable in most
+cases. This timeout defaults to 3600E<nbsp>seconds.
+
+=item B<-p> I<file>
+
+Sets the name and location of the PID-file. If not specified, the default,
+C<I<$localststedir>/run/rrdcached.pid> will be used.
+
+=item B<-b> I<dir>
+
+The daemon will change into a specific directory at startup. All files passed
+to the daemon, that are specified by a B<relative> path, will be interpreted
+to be relative to this directory. If not given the default, C</tmp>, will be
+used.
+
+  +------------------------+------------------------+
+  ! Command line           ! File updated           !
+  +------------------------+------------------------+
+  ! foo.rrd                ! /tmp/foo.rrd           !
+  ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
+  ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
+  +------------------------+------------------------+
+  Paths given on the command  line and paths actually
+  updated by the daemon,  assuming the base directory
+  "/tmp".
 
 =back