Code

Imported upstream version 1.4.2.
[pkg-rrdtool.git] / doc / rrdcached.html
index 717be17ef38ce967e2c5f135a3527a9264351b43..1ad399ac6f643f751ecc133be2c43f43cccf7e02 100644 (file)
@@ -86,7 +86,7 @@ force writing of values to disk, so that graphing facilities and similar can
 work with up-to-date data.</p>
 <p>The daemon was written with big setups in mind. Those setups usually run into
 IO&nbsp;related problems sooner or later for reasons that are beyond the scope
-of this document. Check the wiki at the RRDTool homepage for details. Also
+of this document. Check the wiki at the RRDtool homepage for details. Also
 check <a href="#security_considerations">SECURITY CONSIDERATIONS</a> below before using this daemon! A detailed
 description of how the daemon operates can be found in the <a href="#how_it_works">HOW IT WORKS</a>
 section below.</p>
@@ -101,7 +101,7 @@ section below.</p>
 <p>Tells the daemon to bind to <em>address</em> and accept incoming connections on that
 socket. If <em>address</em> begins with <code>unix:</code>, everything following that prefix is
 interpreted as the path to a UNIX domain socket. Otherwise the address or node
-name are resolved using <em>getaddrinfo</em>.</p>
+name are resolved using getaddrinfo.</p>
 <p>For network sockets, a port may be specified by using the form
 <code>[address]:port</code>. If the address is an IPv4 address or a fully
 qualified domain name (i.&nbsp;e. the address contains at least one dot
@@ -256,28 +256,38 @@ containing <code>../</code> will also be blocked.</p>
 <h1><a name="affected_rrdtool_commands">AFFECTED RRDTOOL COMMANDS</a></h1>
 <p>The following commands may be made aware of the <strong>rrdcached</strong> using the command
 line argument <strong>--daemon</strong> or the environment variable <strong>RRDCACHED_ADDRESS</strong>:</p>
-<dl>
-<dt><strong><a name="dump" class="item"><strong>dump</strong></a></strong></dt>
-
-<dt><strong><a name="fetch" class="item"><strong>fetch</strong></a></strong></dt>
-
-<dt><strong><a name="flush" class="item"><strong>flush</strong></a></strong></dt>
-
-<dt><strong><a name="graph" class="item"><strong>graph</strong></a></strong></dt>
-
-<dt><strong><a name="graphv" class="item"><strong>graphv</strong></a></strong></dt>
-
-<dt><strong><a name="info" class="item"><strong>info</strong></a></strong></dt>
-
-<dt><strong><a name="last" class="item"><strong>last</strong></a></strong></dt>
-
-<dt><strong><a name="lastupdate" class="item"><strong>lastupdate</strong></a></strong></dt>
-
-<dt><strong><a name="update" class="item"><strong>update</strong></a></strong></dt>
-
-<dt><strong><a name="xport" class="item"><strong>xport</strong></a></strong></dt>
-
-</dl>
+<ul>
+<li>
+<p>dump</p>
+</li>
+<li>
+<p>fetch</p>
+</li>
+<li>
+<p>flush</p>
+</li>
+<li>
+<p>graph</p>
+</li>
+<li>
+<p>graphv</p>
+</li>
+<li>
+<p>info</p>
+</li>
+<li>
+<p>last</p>
+</li>
+<li>
+<p>lastupdate</p>
+</li>
+<li>
+<p>update</p>
+</li>
+<li>
+<p>xport</p>
+</li>
+</ul>
 <p>The <strong>update</strong> command can send values to the daemon instead of writing them to
 the disk itself. All other commands can send a <strong>FLUSH</strong> command (see below) to
 the daemon before accessing the files, so they work with up-to-date data even
@@ -290,7 +300,7 @@ if the cache timeout is large.</p>
 are printed to <code>STDERR</code>. One of the steps when starting up is to fork to the
 background and closing <code>STDERR</code> - 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 <em>syslog(3)</em>. The facility used is
+to the system logging daemon using <code>syslog(3)</code>. The facility used is
 <code>LOG_DAEMON</code>.</p>
 <p>
 </p>
@@ -305,7 +315,7 @@ diagram below) are appended to the tree node.</p>
 <p>When appending a value to a tree node, it is checked whether it's time to write
 the values to disk. Values are written to disk if
 <code>now()&nbsp;-&nbsp;First&nbsp;&gt;=&nbsp;timeout</code>, where <code>timeout</code> is the timeout specified
-using the <strong>-w</strong> option, see <em>OPTIONS</em>. If the values are &quot;old enough&quot; they
+using the <strong>-w</strong> option, see <a href="#options">OPTIONS</a>. If the values are &quot;old enough&quot; they
 will be enqueued in the &quot;update queue&quot;, i.&nbsp;e. they will be appended to
 the linked list shown below.  Because the tree nodes and the elements of the
 linked list are the same data structures in memory, any update to a file that
@@ -436,7 +446,7 @@ files will be messed up good!</p>
 <h1><a name="protocol">PROTOCOL</a></h1>
 <p>The daemon communicates with clients using a line based ASCII protocol which is
 easy to read and easy to type. This makes it easy for scripts to implement the
-protocol and possible for users to use <em>telnet</em> to connect to the daemon
+protocol and possible for users to use telnet to connect to the daemon
 and test stuff &quot;by hand&quot;.</p>
 <p>The protocol is line based, this means that each record consists of one or more
 lines. A line is terminated by the line feed character <code>0x0A</code>, commonly
@@ -675,8 +685,8 @@ updates WILL BE LOST</strong>.</p>
 </p>
 <hr />
 <h1><a name="author">AUTHOR</a></h1>
-<p><strong>rrdcached</strong> and this manual page have been written by Florian Forster
-&lt;octo&nbsp;at&nbsp;verplant.org&gt;.</p>
+<p>Florian Forster &lt;octo&nbsp;at&nbsp;verplant.org&gt;</p>
+<p>Both <strong>rrdcached</strong> and this manual page have been written by Florian.</p>
 <p>
 </p>
 <hr />