X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=aaf482428fa2850f6dd2fd2065da86f25bacfe47;hb=78786494a1fd16e59db481444e042737cabd5cd1;hp=c9e9a8b778f46e66078f4e0aafe20112cd362760;hpb=245a9ee60bf478011acf24aaa235a4ca7c575bf8;p=yaz-moved-to-github.git

diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index c9e9a8b..aaf4824 100644
--- 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">
 ]>
-<!-- $Id: yaz-client-man.xml,v 1.3 2004-09-22 19:22:24 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.5 2005-06-21 07:34:26 adam Exp $ -->
 <refentry id="yaz-client">
  
  <refmeta>
@@ -17,14 +17,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>
 
@@ -38,31 +40,36 @@
    </para>
    <para>
     If the <replaceable>addr</replaceable> is specified, the client creates
-    a connection to the Z39.50/SRW target at the address.
+    a connection to the Z39.50/SRW target at the address given.
    </para>
-  </refsect1>
+  <para>
+   When <command>yaz-client</command> is invoked it attemps to read the
+   following files:
+   <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
+   <literal>.yazclientrc</literal> (current directory - any platform)
+   For those files that are readable, the YAZ client executes commands
+   in those files. See COMMANDS section for description of commands.
+  </para>
+ </refsect1>
   <refsect1>
    <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>
@@ -73,13 +80,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>
@@ -87,22 +108,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>
@@ -116,6 +148,12 @@
    <para>
     <filename>yaz-&lt;version&gt;/client/client.c</filename>
    </para>
+   <para>
+    <filename>.yazclientrc</filename>
+   </para>
+   <para>
+    <filename>$HOME/.yazclientrc</filename>
+   </para>
   </refsect1>
   <refsect1><title>SEE ALSO</title>
    <para>
@@ -134,7 +172,7 @@
     Section "Common Command Language" in the YAZ manual.
    </para>
    <para id="CQL">
-    Section "Common QUery Language" in the YAZ manual.
+    Section "Common Query Language" in the YAZ manual.
    </para>
   </refsect1>
 </refentry>