X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=1114339cbce50931215eb15314cf2fb929a05dc5;hb=797335bc656ffda99eddacfb5fdf344f716c5f80;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..1114339 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.3 2004-09-22 19:22:24 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.16 2007-06-03 14:59:34 adam Exp $ -->
 <refentry id="yaz-client">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
  
  <refmeta>
   <refentrytitle>yaz-client</refentrytitle>
@@ -11,58 +22,76 @@
  
  <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>-f <replaceable>cmdfile</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>
 
  </refsynopsisdiv>
   
-  <refsect1><title>DESCRIPTION</title>
-   <para>
-    <command>yaz-client</command> is a Z39.50/SRW 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>
-    If the <replaceable>addr</replaceable> is specified, the client creates
-    a connection to the Z39.50/SRW target at the address.
-   </para>
-  </refsect1>
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <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 SRU servers.
+  </para>
+  <para>
+   If the <replaceable>addr</replaceable> is specified, the client creates
+   a connection to the Z39.50/SRU target at the address given.
+  </para>
+  <para>
+   When <command>yaz-client</command> is started it tries to read
+   commands from one of the following files:
+   <itemizedlist>
+    <listitem><para>
+      Command file if it is given by option -f. 
+     </para></listitem>
+    <listitem><para>
+      <filename>.yazclientrc</filename> in current working directory.
+     </para></listitem>
+    <listitem><para>
+      <filename>.yazclientrc</filename> in the user's home directory.
+      The value of the <literal>HOME</literal> is used to determine
+      the home directory. Normally, <literal>HOME</literal> is only set
+      on POSIX systems such as Linux, FreeBSD, Solaris.
+     </para></listitem>
+   </itemizedlist>
+  </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,18 +102,21 @@
       </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>-p <replaceable>addr</replaceable></term>
+     <term>-f <replaceable>cmdfile</replaceable></term>
      <listitem><para>
-       If specified, the client will use the proxy at the address
-       given.
+      Reads commands from <replaceable>cmdfile</replaceable>. When
+      this option is used, YAZ client does not read .yazclientrc
+      from current directory or home directory.
       </para></listitem>
     </varlistentry>
 
@@ -95,14 +127,46 @@
       Request in kilobytes. Default value is 1024 (1 MB).
       </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>-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>
+       If specified, the client will use the proxy at the address
+       given.
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-q <replaceable>filename</replaceable></term>
+     <listitem><para>
+       If specified, CQL configuration will be read from
+       the file given.
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <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 +180,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>
@@ -134,7 +204,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>