New client commands: . (to source YAZ client commands) and !
[yaz-moved-to-github.git] / doc / client.xml
index 2995c50..88e7c2b 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $Id: client.xml,v 1.3 2001-10-24 09:27:59 adam Exp $ -->
+<!-- $Id: client.xml,v 1.6 2001-11-19 14:06:11 adam Exp $ -->
  <chapter id="client"><title>The YAZ client</title>
   <sect1 id="client.introduction"><title>Introduction</title>
    <para>
@@ -88,7 +88,7 @@
     yaz-client -a - localhost
    </screen>
   </sect1>
-  <sect1 id="client.commands"><title>YAZ client commands</title>
+  <sect1 id="client.commands"><title>Commands</title>
    <para>
     When the YAZ client has read options and connected to a target, if given,
     it will display <literal>Z &gt;</literal> and away your command.
        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>tsel/</replaceable>]]<replaceable>host</replaceable>[:<replaceable>port</replaceable>][/<replaceable>base&gt</replaceable>]
       </para>
      </listitem>
     </varlistentry>
        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>
        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>
  sgml-indent-step:1
  sgml-indent-data:t
  sgml-parent-document: "yaz.xml"
- sgml-local-catalogs: "../../docbook/docbook.cat"
+ sgml-local-catalogs: nil
  sgml-namecase-general:t
  End:
  -->