From: Florian Forster <octo@verplant.org>
Date: Tue, 1 Jul 2008 05:52:18 +0000 (+0200)
Subject: rrdcached(1): Documented the `-p' and `-b' options.
X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=commitdiff_plain;h=40e7acb373399f3e1bfeabe9e14e36aa5117e8be

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

diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod
index 297f009..1429081 100644
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -42,15 +42,28 @@ written to disk. This only concerns files to which updates have stopped, so
 setting this to a high value, such as 3600E<nbsp>seconds, is acceptable in most
 cases. This timeout defaults to 3600E<nbsp>seconds.
 
-=back
-
-=head1 BUGS
-
-=over 4
-
-=item
-
-Base directory is currently hard coded. The daemon will chdir to C</tmp/>.
+=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