ZOOM_record_get returns const char pointer instead of void.

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

diff --git a/doc/client.xml b/doc/client.xml
index 2995c50..dede72e 100644 (file)
--- a/doc/client.xml
+++ b/doc/client.xml
@@ -1,4 +1,4 @@
-<!-- $Id: client.xml,v 1.3 2001-10-24 09:27:59 adam Exp $ -->
+<!-- $Id: client.xml,v 1.9 2002-01-28 09:25:08 adam Exp $ -->
  <chapter id="client"><title>The YAZ client</title>
   <sect1 id="client.introduction"><title>Introduction</title>
    <para>
@@ -71,6 +71,27 @@
        <literal>none</literal>.
       </simpara></listitem>
     </varlistentry>
+
+    <varlistentry><term>
+      <literal>-p</literal> <replaceable>target</replaceable>
+     </term><listitem>
+      <simpara>Specifies proxy address. When set YAZ client will
+       connect to a proxy on the address and port given. 
+       The actual target will be specifed as part of the InitRequest
+       to inform the proxy about actual target.
+      </simpara></listitem>
+    </varlistentry>
+
+    <varlistentry><term>
+      <literal>-u</literal> <replaceable>authentication</replaceable>
+     </term><listitem>
+      <simpara>Specifies authentication. Usually the form
+       <replaceable>user</replaceable>/<replaceable>password</replaceable>
+       is used. This option does the same thing as the
+       <literal>auth</literal> command.
+      </simpara></listitem>
+    </varlistentry>
+
    </variablelist>
    <para>
     In order to connect to Index Data's test Z39.50 server on
@@ -88,10 +109,10 @@
     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.
+    it will display <literal>Z&gt;</literal> and await your command.
     Commands are executed by hitting the return key.
     You can always issue the command <literal>?</literal> to see the list
     of available commands.
@@ -114,7 +135,8 @@
        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 +150,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>
@@ -154,7 +175,8 @@
      </listitem>
     </varlistentry>
     <varlistentry><term>
-      <literal>show </literal> [<replaceable>start</replaceable>[+<replaceable>number</replaceable>]]
+      <literal>show </literal>
+      [<replaceable>start</replaceable>[+<replaceable>number</replaceable>]]
       </term>
      <term><literal>s</literal></term>
      <listitem>
@@ -162,10 +184,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 +251,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>
@@ -384,12 +409,37 @@
      </term>
      <listitem>
       <para>Sends Item Update Request. This command sends a "minimal"
-       PDU to the target supplying the last received record from the target.
+       PDU Update to the target supplying the last received record from
+       the target.
        If no record has been received from the target this command is ignored
        and nothing is sent to the target.
       </para>
      </listitem>
     </varlistentry>
+
+    <varlistentry><term>
+      <literal>.</literal>
+      <replaceable>filename</replaceable>
+     </term>
+     <listitem>
+      <para>Executes list of commands from
+       file <replaceable>filename</replaceable>, just like source on
+       some UNIX shells.
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry><term>
+      <literal>!</literal>
+      <replaceable>args</replaceable>
+     </term>
+     <listitem>
+      <para>Executes command <replaceable>args</replaceable> in subshell
+       using the <literal>system</literal> call.
+      </para>
+     </listitem>
+    </varlistentry>
+
    </variablelist>
   </sect1>
   <sect1 id="client.searching"><title>Searching</title>
@@ -438,7 +488,7 @@
  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:
  -->