doc/yaz-client-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <!-- $Id: yaz-client-man.xml,v 1.16 2007-06-03 14:59:34 adam Exp $ -->
  12 <refentry id="yaz-client">
  13  <refentryinfo>
  14   <productname>YAZ</productname>
  15   <productnumber>&version;</productnumber>
  16  </refentryinfo>
  17
  18  <refmeta>
  19   <refentrytitle>yaz-client</refentrytitle>
  20   <manvolnum>1</manvolnum>
  21  </refmeta>
  22
  23  <refnamediv>
  24   <refname>yaz-client</refname>
  25   <refpurpose>Z39.50/SRU client for implementors</refpurpose>
  26  </refnamediv>
  27
  28  <refsynopsisdiv>
  29   <cmdsynopsis>
  30    <command>yaz-client</command>
  31    <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
  32    <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
  33    <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
  34    <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
  35    <arg choice="opt"><option>-f <replaceable>cmdfile</replaceable></option></arg>
  36    <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
  37    <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
  38    <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
  39    <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
  40    <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
  41    <arg choice="opt"><option>-xV</option></arg>
  42    <arg choice="opt">addr</arg>
  43   </cmdsynopsis>
  44
  45  </refsynopsisdiv>
  46
  47  <refsect1><title>DESCRIPTION</title>
  48   <para>
  49    <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
  50    simple command line interface that allows you to test behavior and
  51    performance of Z39.50 targets and SRU servers.
  52   </para>
  53   <para>
  54    If the <replaceable>addr</replaceable> is specified, the client creates
  55    a connection to the Z39.50/SRU target at the address given.
  56   </para>
  57   <para>
  58    When <command>yaz-client</command> is started it tries to read
  59    commands from one of the following files:
  60    <itemizedlist>
  61     <listitem><para>
  62       Command file if it is given by option -f.
  63      </para></listitem>
  64     <listitem><para>
  65       <filename>.yazclientrc</filename> in current working directory.
  66      </para></listitem>
  67     <listitem><para>
  68       <filename>.yazclientrc</filename> in the user's home directory.
  69       The value of the <literal>HOME</literal> is used to determine
  70       the home directory. Normally, <literal>HOME</literal> is only set
  71       on POSIX systems such as Linux, FreeBSD, Solaris.
  72      </para></listitem>
  73    </itemizedlist>
  74   </para>
  75  </refsect1>
  76   <refsect1>
  77    <title>OPTIONS</title>
  78    <variablelist>
  79     <varlistentry>
  80      <term>-a <replaceable>filename</replaceable></term>
  81      <listitem><para>
  82        If specified, logging of protocol packages will be appended
  83        file given. If <replaceable>filename</replaceable> is
  84        specified as <literal>-</literal>, the output is written
  85        to <literal>stdout</literal>.
  86       </para></listitem>
  87     </varlistentry>
  88     <varlistentry>
  89      <term>-b <replaceable>filename</replaceable></term>
  90      <listitem><para>
  91        If specified, YAZ will dump BER data in readable notation
  92        to the file specified. If <replaceable>filename</replaceable>
  93        is specified as <literal>-</literal> the output is written
  94        to <literal>stdout</literal>.
  95       </para></listitem>
  96     </varlistentry>
  97     <varlistentry>
  98      <term>-c <replaceable>filename</replaceable></term>
  99      <listitem><para>
 100        If specified, CCL configuration will be read from
 101        the file given.
 102       </para></listitem>
 103     </varlistentry>
 104     <varlistentry>
 105      <term>-d <replaceable>dump</replaceable></term>
 106      <listitem><para>
 107        If specified, YAZ will dump BER data for all PDUs sent and received
 108        to individual files, named
 109        <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
 110        where DDD is 001, 002, 003, ..
 111       </para></listitem>
 112     </varlistentry>
 113
 114     <varlistentry>
 115      <term>-f <replaceable>cmdfile</replaceable></term>
 116      <listitem><para>
 117       Reads commands from <replaceable>cmdfile</replaceable>. When
 118       this option is used, YAZ client does not read .yazclientrc
 119       from current directory or home directory.
 120       </para></listitem>
 121     </varlistentry>
 122
 123     <varlistentry>
 124      <term>-k <replaceable>size</replaceable></term>
 125      <listitem><para>
 126       Sets preferred messages and maximum record size for Initialize
 127       Request in kilobytes. Default value is 1024 (1 MB).
 128       </para></listitem>
 129     </varlistentry>
 130     <varlistentry>
 131      <term>-m <replaceable>filename</replaceable></term>
 132      <listitem><para>
 133        If specified, retrieved records will be appended to the file given.
 134       </para></listitem>
 135     </varlistentry>
 136     <varlistentry>
 137      <term>-p <replaceable>addr</replaceable></term>
 138      <listitem><para>
 139        If specified, the client will use the proxy at the address
 140        given.
 141       </para></listitem>
 142     </varlistentry>
 143     <varlistentry>
 144      <term>-q <replaceable>filename</replaceable></term>
 145      <listitem><para>
 146        If specified, CQL configuration will be read from
 147        the file given.
 148       </para></listitem>
 149     </varlistentry>
 150     <varlistentry>
 151      <term>-u <replaceable>auth</replaceable></term>
 152      <listitem><para>
 153        If specified, the <replaceable>auth</replaceable> string
 154        will be used for authentication.
 155       </para></listitem>
 156     </varlistentry>
 157     <varlistentry>
 158      <term>-V</term>
 159      <listitem><para>
 160        Prints YAZ version.
 161      </para></listitem>
 162     </varlistentry>
 163     <varlistentry>
 164      <term>-x</term>
 165      <listitem><para>
 166        Makes the YAZ client print hex dumps of packages sent and received
 167        on standard output.
 168        </para></listitem>
 169     </varlistentry>
 170    </variablelist>
 171   </refsect1>
 172   <refsect1>
 173    <title>COMMANDS</title>
 174    <para>
 175     The YAZ client accepts the following commands.
 176    </para>
 177    &yaz-client-commands;
 178    </refsect1>
 179   <refsect1><title>FILES</title>
 180    <para>
 181     <filename>yaz-&lt;version&gt;/client/client.c</filename>
 182    </para>
 183    <para>
 184     <filename>$HOME/.yazclientrc</filename>
 185    </para>
 186    <para>
 187     <filename>$HOME/.yazclient.history</filename>
 188    </para>
 189   </refsect1>
 190   <refsect1><title>SEE ALSO</title>
 191    <para>
 192     <citerefentry>
 193      <refentrytitle>yaz</refentrytitle>
 194      <manvolnum>7</manvolnum>
 195     </citerefentry>
 196    </para>
 197    <para>
 198     Section "The YAZ Client" in the YAZ manual.
 199    </para>
 200    <para id="PQF">
 201     Section "Prefix Query Format" in the YAZ manual.
 202    </para>
 203    <para id="CCL">
 204     Section "Common Command Language" in the YAZ manual.
 205    </para>
 206    <para id="CQL">
 207     Section "Common Query Language" in the YAZ manual.
 208    </para>
 209   </refsect1>
 210 </refentry>
 211
 212 <!-- Keep this comment at the end of the file
 213 Local variables:
 214 mode: sgml
 215 sgml-omittag:t
 216 sgml-shorttag:t
 217 sgml-minimize-attributes:nil
 218 sgml-always-quote-attributes:t
 219 sgml-indent-step:1
 220 sgml-indent-data:t
 221 sgml-parent-document:nil
 222 sgml-local-catalogs: nil
 223 sgml-namecase-general:t
 224 End:
 225 -->