From: Adam Dickmeiss <adam@indexdata.dk>
Date: Thu, 12 Jun 2014 09:30:34 +0000 (+0200)
Subject: Describe redis conf option + ZOOM redis option
X-Git-Tag: v5.2.0~10
X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=8904a5b136d3d9bf359a1de242f554d009ab9888

Describe redis conf option + ZOOM redis option
---

diff --git a/doc/book.xml b/doc/book.xml
index a737c75..2107746 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -705,6 +705,20 @@
        </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term>
+        <literal>--with-redis</literal>
+       </term>
+       <listitem>
+	<para>&yaz; will be linked with the hiredis C library
+	to allow for result-set caching for ZOOM on a
+	<ulink url="&url.redis;">redis</ulink> server.
+	The prefix can not be given. Note that YAZ will only search
+	for hiredis if Libgcrypt is also enabled.
+       </para>
+       </listitem>
+      </varlistentry>
+
      </variablelist>
     </para>
     <para>
@@ -1543,6 +1557,23 @@
        <literal>--server=</literal><replaceable>host</replaceable> may
        be given (YAZ emulates that part of libMemcached).
       </entry><entry>none</entry></row>
+      <row><entry>
+       redis</entry><entry>
+       If given and non-empty,
+       a <ulink url="&url.redis;">redis</ulink> context will be created
+       for the connection.
+       This option is inspected by ZOOM when a connection is established.
+       If the <literal>redis</literal> option is given
+       and YAZ is compiled without redis support, an internal
+       diagnostic (10018) will be thrown.
+       redis support is available for YAZ 5.2.0 or later. If this
+       option is supplied for an earlier version of YAZ, it is
+       <emphasis>ignored</emphasis>.
+       The value of this option is a set options, similar to that
+       of the memcached function. At this stage only --server=host[:port]
+       is supported. Later versions of YAZ might honor expiry for various
+       items and other things that tune the redis usage.
+      </entry><entry>none</entry></row>
      </tbody>
     </tgroup>
    </table>