<!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.6 2006/04/24 09:21:35 adam Exp $ -->
<refentry id="yaz-client">
 
 <refmeta>
  <refentrytitle>yaz-client</refentrytitle>
  <manvolnum>1</manvolnum>
 </refmeta>
 
 <refnamediv>
  <refname>yaz-client</refname>
  <refpurpose>Z39.50/SRW client for implementors</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>yaz-client</command>
   <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>-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>-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 given.
   </para>
  <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>-a <replaceable>filename</replaceable></term>
     <listitem><para>
       If specified, logging of protocol packages will be appended
       file given. If <replaceable>filename</replaceable> is
       specified as <literal>-</literal>, the output is written
       to <literal>stdout</literal>.
      </para></listitem>
    </varlistentry>
    <varlistentry>
     <term>-b <replaceable>filename</replaceable></term>
     <listitem><para>
       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>
     <term>-c <replaceable>filename</replaceable></term>
     <listitem><para>
       If specified, CCL configuration will be read from
       the file given.
      </para></listitem>
    </varlistentry>
    <varlistentry>
     <term>-d <replaceable>dump</replaceable></term>
     <listitem><para>
       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>
       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>
   <title>COMMANDS</title>
   <para>
    The YAZ client accepts the following commands.
   </para>
   &yaz-client-commands;
   </refsect1>
  <refsect1><title>FILES</title>
   <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>
    <citerefentry>
     <refentrytitle>yaz</refentrytitle>
     <manvolnum>7</manvolnum>
    </citerefentry>
   </para>
   <para>
    Section "The YAZ Client" in the YAZ manual.
   </para>
   <para id="PQF">
    Section "Prefix Query Format" in the YAZ manual.
   </para>
   <para id="CCL">
    Section "Common Command Language" in the YAZ manual.
   </para>
   <para id="CQL">
    Section "Common Query Language" in the YAZ manual.
   </para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-local-catalogs: nil
sgml-namecase-general:t
End:
-->
