X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=2fffa3ac64fa64fca7b08347493aa0932c83bf07;hb=5fca2e8ca1775ad5adceb1568508d911d646a01b;hp=ba3b9bb3254120cd22f44c11ce8512a6849a6001;hpb=c6e47cbbff56f39f6d81b079ebaeac41d793d4d9;p=yaz-moved-to-github.git

diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index ba3b9bb..2fffa3a 100644
--- a/doc/yaz-client-man.xml
+++ b/doc/yaz-client-man.xml
@@ -1,8 +1,19 @@
-<!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" 
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: yaz-client-man.xml,v 1.1 2003-10-27 12:21:24 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.15 2007-06-03 08:06:32 adam Exp $ -->
 <refentry id="yaz-client">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
  
  <refmeta>
   <refentrytitle>yaz-client</refentrytitle>
@@ -11,26 +22,22 @@
  
  <refnamediv>
   <refname>yaz-client</refname>
-  <refpurpose>Z39.50/SRW client for implementors</refpurpose>
+  <refpurpose>Z39.50/SRU client for implementors</refpurpose>
  </refnamediv>
 
  <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">addr</arg>
-  </cmdsynopsis>
-
-  <cmdsynopsis>
-   <command>yaz-client-ssl</command>
-   <arg rep="repeat" choice="opt"><option>option</option></arg>
+   <arg choice="opt"><option>-xV</option></arg>
    <arg choice="opt">addr</arg>
   </cmdsynopsis>
 
@@ -38,42 +45,44 @@
   
   <refsect1><title>DESCRIPTION</title>
    <para>
-    <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
+    <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
     simple command line interface that allows you to test behavior and
-    performance of Z39.50 targets and SRW servers.
-   </para>
-   <para>
-    <command>yaz-client-ssl</command> is identical to
-    <command>yaz-client</command> except that it supports SSL transport.
+    performance of Z39.50 targets and SRU servers.
    </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/SRU target at the address given.
    </para>
-  </refsect1>
+  <para>
+   When <command>yaz-client</command> is invoked it attemps to read
+   <filename>.yazclientrc</filename> from current working directory.
+   If <filename>.yazclientrc</filename> does not exist in current directory
+   YAZ client reads <filename>.yazclientrc</filename> from the
+   home directory, where the home directory is given by environment
+   variable <literal>HOME</literal>. 
+   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 MARC (ISO2709) 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>
@@ -84,13 +93,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>
@@ -98,22 +121,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>
@@ -127,6 +161,12 @@
    <para>
     <filename>yaz-&lt;version&gt;/client/client.c</filename>
    </para>
+   <para>
+    <filename>$HOME/.yazclientrc</filename>
+   </para>
+   <para>
+    <filename>$HOME/.yazclient.history</filename>
+   </para>
   </refsect1>
   <refsect1><title>SEE ALSO</title>
    <para>
@@ -145,7 +185,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>