prepare for the release of rrdtool-1.3.0

[rrdtool.git] / doc / rrdtool.pod

diff --git a/doc/rrdtool.pod b/doc/rrdtool.pod
index 281b331..cd3c785 100644 (file)
--- a/doc/rrdtool.pod
+++ b/doc/rrdtool.pod
@@ -154,7 +154,7 @@ The use of B<RRA>s guarantees that the B<RRD> does not grow over
 time and that old data is automatically eliminated. By using the
 consolidation feature, you can still keep data for a very long time,
 while gradually reducing the resolution of the data along the time
-axis. 
+axis.
 
 Using different consolidation functions (B<CF>) allows you to store
 exactly the type of information that actually interests you: the maximum
@@ -186,12 +186,12 @@ for more information on this.
 
 =item Aberrant Behavior Detection
 
-by Jake Brutlag E<lt>jakeb@corp.webtv.netE<gt>
+by Jake Brutlag
 
 B<RRDtool> provides the building blocks for near real-time aberrant
 behavior detection. These components include:
 
-=over 12
+=over
 
 =item *
 
@@ -260,21 +260,21 @@ accepts the same arguments as on the command line and some special
 commands like B<quit, cd, mkdir> and B<ls>. For detailed help on the
 server commands type:
 
-   rrdtool help cd|mkdir|ls|quit
+   rrdtool help cd|mkdir|pwd|ls|quit
 
-When a command is completed, RRDtool will print the string  'C<OK>', 
-followed by timing information of the form B<u:>I<usertime> 
-B<s:>I<systemtime>. Both values are the running totals of seconds 
-since RRDtool was started. If an error occurs, a line of the 
-form 'C<ERROR:> I<Description of error>' will be printed. B<RRDtool>
-will not abort, if possible, but follow the ERROR line with an OK line.
-If a B<workdir> is specified and the UID is 0, RRDtool will do a 
-chroot to that workdir. If the UID is not 0, RRDtool only changes the
-current directory to B<workdir>.
+When a command is completed, RRDtool will print the string  'C<OK>',
+followed by timing information of the form B<u:>I<usertime>
+B<s:>I<systemtime>. Both values are the running totals of seconds since
+RRDtool was started. If an error occurs, a line of the form 'C<ERROR:>
+I<Description of error>' will be printed instead. B<RRDtool> will not abort,
+unless something realy serious happens. If
+a B<workdir> is specified and the UID is 0, RRDtool will do a chroot to that
+workdir. If the UID is not 0, RRDtool only changes the current directory to
+B<workdir>.
 
 =head2 RRD Server
 
-If you want to create a RRD-Server, you must choose a TCP/IP Service 
+If you want to create a RRD-Server, you must choose a TCP/IP Service
 number and add them to I</etc/services> like this:
 
  rrdsrv      13900/tcp                       # RRD server
@@ -285,7 +285,7 @@ server and the client system must use the same port, of course.
 
 With this configuration you can add RRDtool as meta-server to
 I</etc/inetd.conf>. For example:
-  
+
  rrdsrv stream tcp nowait root /opt/rrd/bin/rrdtool rrdtool - /var/rrd
 
 Don't forget to create the database directory /var/rrd and
@@ -295,6 +295,8 @@ If all was setup correctly, you can access the server with perl
 sockets, tools like netcat, or in a quick interactive test by using
 'telnet localhost rrdsrv'.
 
+B<NOTE:> that there is no authentication with this feature! Do not setup
+such a port unless you are sure what you are doing.
 
 =head1 SEE ALSO
 
@@ -306,5 +308,5 @@ Bugs? Features!
 
 =head1 AUTHOR
 
-Tobias Oetiker <oetiker@ee.ethz.ch>
+Tobias Oetiker <tobi@oetiker.ch>