Describe new options-within-host-string syntax:

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

diff --git a/doc/zoom.xml b/doc/zoom.xml
index 3bd7080..4c697ae 100644 (file)
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -3,6 +3,8 @@
 ZOOM_connection_errcode(c)
 ZOOM_connection_errmsg(c)
 ZOOM_connection_addinfo(c)
+ZOOM_connection_addinfo(c)
+ZOOM_connection_diagset(c);
 ZOOM_diag_str(error)
 ZOOM_resultset_record_immediate(s, pos)
 ZOOM_resultset_cache_reset(r)
@@ -16,7 +18,7 @@ ZOOM_options_get_bool(opt, name, defa)
 ZOOM_options_get_int(opt, name, defa)
 ZOOM_options_set_int(opt, name, value)
 -->
-<!-- $Id: zoom.xml,v 1.43 2005-11-08 21:53:01 adam Exp $ -->
+<!-- $Id: zoom.xml,v 1.45 2005-12-12 12:09:29 mike Exp $ -->
  <chapter id="zoom"><title>ZOOM</title>
   <para>
     &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
@@ -107,6 +109,17 @@ ZOOM_options_set_int(opt, name, value)
     The scheme <literal>http</literal> selects SRW over HTTP.
    </para>
    <para>
+    You can prefix the scheme-qualified host-string with one or more
+    comma-separated
+    <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
+    sequences, each of which represents an option to be set into the
+    connection structure <emphasis>before</emphasis> the
+    protocol-level connection is forged and the initialisation
+    handshake takes place.  This facility can be used to provide
+    authentication credentials, as in host-strings such as:
+    <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
+   </para>
+   <para>
     Connection objects should be destroyed using the function
     <function>ZOOM_connection_destroy</function>.
    </para>