From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 19 Feb 2014 10:38:55 +0000 (+0100)
Subject: Describe memcached ZOOM option
X-Git-Tag: v5.0.14~2
X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=8b1b8e01c59549991c29393276fd56e78b3909f7;hp=b41eafb39bc0ee50b4c5988f5ecfc6aad91933d5

Describe memcached ZOOM option
---

diff --git a/doc/zoom.xml b/doc/zoom.xml
index d1ccf8e..116970c 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -325,6 +325,25 @@ ZOOM_options_set_int(opt, name, value)
 	in call to <function>ZOOM_connection_option_get</function> or
 	<function>ZOOM_connection_option_getl</function>.
        </entry><entry></entry></row>
+      <row><entry>
+        memcached</entry><entry>
+        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.
+        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 memcached(3). 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).
+       </entry><entry>none</entry></row>
      </tbody>
     </tgroup>
    </table>