X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=9959754e00bd1f1ea322c5266ce6cb8253d99be6;hb=60f5103f542e3f6dd2e22b6df7015f7bc4b3a937;hp=016d4858a33236a67c67e9972718ad06924e3663;hpb=307671c871f04d55325ed94fc2c403797376efa3;p=yaz-moved-to-github.git

diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index 016d485..9959754 100644
--- a/doc/yaz-client-man.xml
+++ b/doc/yaz-client-man.xml
@@ -1,7 +1,9 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+     <!ENTITY % common  SYSTEM "common/common.ent">
+     %common;
      <!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.8 2006-04-25 11:25:08 marc Exp $ -->
 <refentry id="yaz-client">
  
  <refmeta>
@@ -17,14 +19,16 @@
  <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>-b <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>-q <replaceable>filename</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>
 
@@ -53,24 +57,21 @@
    <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
-       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>
-     <term>-u <replaceable>auth</replaceable></term>
+     <term>-b <replaceable>filename</replaceable></term>
      <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>
@@ -81,13 +82,27 @@
       </para></listitem>
     </varlistentry>
     <varlistentry>
-     <term>-q <replaceable>filename</replaceable></term>
+     <term>-d <replaceable>dump</replaceable></term>
      <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>
-
     <varlistentry>
      <term>-p <replaceable>addr</replaceable></term>
      <listitem><para>
@@ -95,22 +110,33 @@
        given.
       </para></listitem>
     </varlistentry>
-
     <varlistentry>
-     <term>-k <replaceable>size</replaceable></term>
+     <term>-q <replaceable>filename</replaceable></term>
      <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>
-
     <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>
+    <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>