Describe new comman xmles. Update doc for Item Update.

diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml
index d96e56c..fd98374 100644 (file)
--- a/doc/yaz-client-commands.xml
+++ b/doc/yaz-client-commands.xml
@@ -1,5 +1,5 @@
 <!-- 
 <!-- 

-   $Id: yaz-client-commands.xml,v 1.8 2005-06-08 11:22:15 adam Exp $
+   $Id: yaz-client-commands.xml,v 1.9 2005-06-21 07:34:26 adam Exp $

    Commands for YAZ client.
    Included in both manual and man page for yaz-client.
 -->
    Commands for YAZ client.
    Included in both manual and man page for yaz-client.
 -->

@@ -332,13 +332,23 @@
  </varlistentry>
  <varlistentry><term>
    <literal>update</literal>
  </varlistentry>
  <varlistentry><term>
    <literal>update</literal>

+   <replaceable>action</replaceable>
+   <replaceable>recid</replaceable>
+   <replaceable>doc</replaceable>

   </term>
   <listitem>
   </term>
   <listitem>

-   <para>Sends Item Update Request. This command sends a "minimal"
-    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>Sends Item Update Request. The <replaceable>action</replaceable>
+    argument must be the action type: one of <literal>insert</literal>,
+    <literal>replace</literal>, <literal>delete</literal> and
+    <literal>update</literal>. The second argument, 
+    <replaceable>recid</replaceable>, is the
+    record identifier (any string). Third argument which is optional is
+    the record document for the request. If doc is a quoted string
+    (double quotes) the string content is used verbatim. If doc is not
+    a quoted string, it is assumed to be a filename which is read, then
+    sent as the docuemnt content. If doc is omitted, the last received
+    record (as parf of present response or piggybacked search response) 
+    is used for the update.

    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>

@@ -623,7 +633,7 @@
   </term>
   <listitem>
    <para>This command makes YAZ client wait for a number of
   </term>
   <listitem>
    <para>This command makes YAZ client wait for a number of

-    response packages from target. If <literal>number</literal> is
+    response packages from target. If <replaceable>number</replaceable> is

     omitted, 1 is assumed. 
    </para>
    <para>This command is rarely used and is only useful if command
     omitted, 1 is assumed. 
    </para>
    <para>This command is rarely used and is only useful if command

@@ -634,6 +644,18 @@
   </listitem>
  </varlistentry>
 
   </listitem>
  </varlistentry>
 

+ <varlistentry id="command-xmles"><term>
+   <literal>xmles</literal>
+   <replaceable>doc</replaceable>
+  </term>
+  <listitem>
+   <para>Sends XML Extended Services request using the doc given.
+    This is a privately defined Extended Service using OID
+    1.2.840.10003.9.1000.105.4.
+   </para>
+  </listitem>
+ </varlistentry>
+

  <varlistentry><term>
    <literal>zversion</literal>
    <replaceable>ver</replaceable>
  <varlistentry><term>
    <literal>zversion</literal>
    <replaceable>ver</replaceable>

diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index 016d485..aaf4824 100644 (file)
--- a/doc/yaz-client-man.xml
+++ b/doc/yaz-client-man.xml
@@ -1,7 +1,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
 ]>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
 ]>

-<!-- $Id: yaz-client-man.xml,v 1.4 2004-12-09 09:27:51 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.5 2005-06-21 07:34:26 adam Exp $ -->

 <refentry id="yaz-client">
  
  <refmeta>
 <refentry id="yaz-client">
  
  <refmeta>

@@ -17,14 +17,16 @@
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>yaz-client</command>
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>yaz-client</command>

-   <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>

    <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
    <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>

+   <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>

    <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
    <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>

-   <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
+   <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
+   <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
+   <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>

    <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
    <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>

+   <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>

    <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
    <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>

-   <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
-   <arg choice="opt"><option>-x</option></arg>
+   <arg choice="opt"><option>-xV</option></arg>

    <arg choice="opt">addr</arg>
   </cmdsynopsis>
 
    <arg choice="opt">addr</arg>
   </cmdsynopsis>
 

@@ -53,24 +55,21 @@
    <title>OPTIONS</title>
    <variablelist>
     <varlistentry>
    <title>OPTIONS</title>
    <variablelist>
     <varlistentry>

-     <term>-m <replaceable>filename</replaceable></term>
-     <listitem><para>
-       If specified, retrieved records will be appended to the file given.
-      </para></listitem>
-    </varlistentry>
-    <varlistentry>

      <term>-a <replaceable>filename</replaceable></term>
      <listitem><para>
        If specified, logging of protocol packages will be appended
      <term>-a <replaceable>filename</replaceable></term>
      <listitem><para>
        If specified, logging of protocol packages will be appended

-       file given. The special filename <literal>-</literal>
-       (dash) denotes standard output.
+       file given. If <replaceable>filename</replaceable> is
+       specified as <literal>-</literal>, the output is written
+       to <literal>stdout</literal>.

       </para></listitem>
     </varlistentry>
     <varlistentry>
       </para></listitem>
     </varlistentry>
     <varlistentry>

-     <term>-u <replaceable>auth</replaceable></term>
+     <term>-b <replaceable>filename</replaceable></term>

      <listitem><para>
      <listitem><para>

-       If specified, the <replaceable>auth</replaceable> string
-       will be used for authentication.
+       If specified, YAZ will dump BER data in readable notation
+       to the file specified. If <replaceable>filename</replaceable>
+       is specified as <literal>-</literal> the output is written
+       to <literal>stdout</literal>.

       </para></listitem>
     </varlistentry>
     <varlistentry>
       </para></listitem>
     </varlistentry>
     <varlistentry>

@@ -81,13 +80,27 @@
       </para></listitem>
     </varlistentry>
     <varlistentry>
       </para></listitem>
     </varlistentry>
     <varlistentry>

-     <term>-q <replaceable>filename</replaceable></term>
+     <term>-d <replaceable>dump</replaceable></term>

      <listitem><para>
      <listitem><para>

-       If specified, CQL configuration will be read from
-       the file given.
+       If specified, YAZ will dump BER data for all PDUs sent and received 
+       to individual files, named
+       <replaceable>dump</replaceable>.DDD.<literal>raw</literal>, 
+       where DDD is 001, 002, 003, ..
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-k <replaceable>size</replaceable></term>
+     <listitem><para>
+      Sets preferred messages and maximum record size for Initialize
+      Request in kilobytes. Default value is 1024 (1 MB).
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-m <replaceable>filename</replaceable></term>
+     <listitem><para>
+       If specified, retrieved records will be appended to the file given.

       </para></listitem>
     </varlistentry>
       </para></listitem>
     </varlistentry>

-

     <varlistentry>
      <term>-p <replaceable>addr</replaceable></term>
      <listitem><para>
     <varlistentry>
      <term>-p <replaceable>addr</replaceable></term>
      <listitem><para>

@@ -95,22 +108,33 @@
        given.
       </para></listitem>
     </varlistentry>
        given.
       </para></listitem>
     </varlistentry>

-

     <varlistentry>
     <varlistentry>

-     <term>-k <replaceable>size</replaceable></term>
+     <term>-q <replaceable>filename</replaceable></term>

      <listitem><para>
      <listitem><para>

-      Sets preferred messages and maximum record size for Initialize
-      Request in kilobytes. Default value is 1024 (1 MB).
+       If specified, CQL configuration will be read from
+       the file given.

       </para></listitem>
     </varlistentry>
       </para></listitem>
     </varlistentry>

-

     <varlistentry>
     <varlistentry>

-     <term>-x</term>
-    <listitem><para>
-      Makes the YAZ client print hex dumps of packages sent and received
-      on standard output.
+     <term>-u <replaceable>auth</replaceable></term>
+     <listitem><para>
+       If specified, the <replaceable>auth</replaceable> string
+       will be used for authentication.

       </para></listitem>
     </varlistentry>
       </para></listitem>
     </varlistentry>

+    <varlistentry>
+     <term>-V</term>
+     <listitem><para>
+       Prints YAZ version.
+     </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-x</term>
+     <listitem><para>
+       Makes the YAZ client print hex dumps of packages sent and received
+       on standard output.
+       </para></listitem>
+    </varlistentry>

    </variablelist>
   </refsect1>
   <refsect1>
    </variablelist>
   </refsect1>
   <refsect1>