New ZOOM option schema.

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

diff --git a/doc/client.xml b/doc/client.xml
index 5ec2cd4..978d3bc 100644 (file)
--- a/doc/client.xml
+++ b/doc/client.xml
@@ -1,4 +1,4 @@
-<!-- $Id: client.xml,v 1.5 2001-10-26 20:13:44 adam Exp $ -->
+<!-- $Id: client.xml,v 1.7 2001-11-27 22:12:24 adam Exp $ -->
  <chapter id="client"><title>The YAZ client</title>
   <sect1 id="client.introduction"><title>Introduction</title>
    <para>
@@ -114,7 +114,7 @@
        Syntax:
       </para>
       <para>
-       [<literal>(tcp|osi)':'</literal><[<replaceable>tsel/</replaceable>]]<replaceable>host</replaceable>[:<replaceable>port</replaceable>][/<replaceable>base&gt</replaceable>]
+       [<literal>(tcp|ssl)':'</literal>]<replaceable>host</replaceable>[:<replaceable>port</replaceable>][/<replaceable>base&gt</replaceable>]
       </para>
      </listitem>
     </varlistentry>
@@ -128,9 +128,8 @@
     </varlistentry>
     <varlistentry><term>
       <literal>f </literal><replaceable>query</replaceable></term>
-     <term><literal>f</literal></term>
      <listitem>
-      <para>Sends Search Request using the <replaceable>query</replaceable>
+      <para>Sends a Search Request using the <replaceable>query</replaceable>
        given.
       </para>
      </listitem>
@@ -162,10 +161,10 @@
        position given by
        <replaceable>start</replaceable>
        a number of records given by <replaceable>number</replaceable>. If
-       <replaceable>start</replaceable> is not given the client will 
-       fetch from position of the last retrieved record plus 1. If
-       <replaceable>number</replaceable> is not given one record will be
-       fetched at a time.
+       <replaceable>start</replaceable> is not given, then the client
+       will fetch from position of the last retrieved record plus 1. If
+       <replaceable>number</replaceable> is not given, then one record will
+       be fetched at a time.
       </para>
       </listitem>
     </varlistentry>
@@ -229,6 +228,9 @@
        sent to the server when the <literal>open</literal> command is
        issued and the Z39.50 Initialize Request is sent, so this command
        must be used before <literal>open</literal> in order to be effective.
+       A common convention for the <replaceable>authopen</replaceable> string
+       is that the username - and password is separated by a slash, e.g.
+       <literal>myusername/mysecret</literal>.
       </para>
      </listitem>
     </varlistentry>