ZOOM: expire times set for redis/memcached YAZ-772

[yaz-moved-to-github.git] / doc / book.xml

diff --git a/doc/book.xml b/doc/book.xml
index a737c75..e1988c2 100644 (file)
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -702,9 +702,24 @@
        for result-set caching for ZOOM.
        The prefix can not be given. Note that YAZ will only search
        for libMemcached if Libgcrypt is also enabled.
+       Note that 0.40 of libmemcached is required.
        </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>
@@ -1527,21 +1542,35 @@
        If given and non-empty,
        <ulink url="&url.libmemcached;">libMemcached</ulink>
        will be configured for the connection.
-       This option is inspected by ZOOM when a connection is  established.
+       This option is inspected by ZOOM when a connection is established.
        If the <literal>memcached</literal> option is given
        and YAZ is compiled without libMemcached support, an internal
        diagnostic (10018) will be thrown.
        libMemcached support is available for YAZ 5.0.13 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 string passed verbatim to
-       the <function>memcached</function> function part of libMemcached.
-       Refer to man page
-       <ulink url="http://manned.org/memcached.3">memcached(3)</ulink>.
-       Earlier versions of libMemcached
-       do not offer this function. In this case only the option
-       <literal>--server=</literal><replaceable>host</replaceable> may
-       be given (YAZ emulates that part of libMemcached).
+       The value of this option is a list options - each is of the
+       form <literal>--name=value</literal>.
+       Option <literal>--server=</literal>host[:port] specifies a memcached
+       server. It may be repeated for multiple memcached servers.
+       Option <literal>--expire=</literal>seconds sets expiry time in seconds
+       for how long result sets are to be cached.
+      </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 setting. At this stage only --server=host[:port]
+       and --expire=seconds is supported.
       </entry><entry>none</entry></row>
      </tbody>
     </tgroup>