Add note about libmemcached version

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

diff --git a/doc/book.xml b/doc/book.xml
index df5021d..403bc9c 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>
@@ -1543,6 +1558,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>
@@ -5693,6 +5725,15 @@ typedef struct {
           <literal>r=r</literal> is available in YAZ 2.0.24 or later.
          </entry>
          </row>
+         <row><entry><literal>r=omiteq</literal></entry>
+         <entry>
+          This will omit relation=equals (@attr 2=3) when r=o / r=r
+          is used. This is useful for servers that somehow breaks
+          when an explicit relation=equals is used. Omitting the
+          relation is usually safe because "equals" is the default
+          behavior. This tweak was added in YAZ version 5.1.2.
+         </entry>
+         </row>
          <row><entry><literal>t=l</literal></entry>
          <entry>
           Allows term to be left-truncated.