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.15 2007-06-03 08:06:32 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>-k <replaceable>size</replaceable></option></arg>
  36    <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
  37    <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
  38    <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
  39    <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
  40    <arg choice="opt"><option>-xV</option></arg>
  41    <arg choice="opt">addr</arg>
  42   </cmdsynopsis>
  43
  44  </refsynopsisdiv>
  45
  46   <refsect1><title>DESCRIPTION</title>
  47    <para>
  48     <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
  49     simple command line interface that allows you to test behavior and
  50     performance of Z39.50 targets and SRU servers.
  51    </para>
  52    <para>
  53     If the <replaceable>addr</replaceable> is specified, the client creates
  54     a connection to the Z39.50/SRU target at the address given.
  55    </para>
  56   <para>
  57    When <command>yaz-client</command> is invoked it attemps to read
  58    <filename>.yazclientrc</filename> from current working directory.
  59    If <filename>.yazclientrc</filename> does not exist in current directory
  60    YAZ client reads <filename>.yazclientrc</filename> from the
  61    home directory, where the home directory is given by environment
  62    variable <literal>HOME</literal>.
  63    For those files that are readable, the YAZ client executes commands
  64    in those files. See COMMANDS section for description of commands.
  65   </para>
  66  </refsect1>
  67   <refsect1>
  68    <title>OPTIONS</title>
  69    <variablelist>
  70     <varlistentry>
  71      <term>-a <replaceable>filename</replaceable></term>
  72      <listitem><para>
  73        If specified, logging of protocol packages will be appended
  74        file given. If <replaceable>filename</replaceable> is
  75        specified as <literal>-</literal>, the output is written
  76        to <literal>stdout</literal>.
  77       </para></listitem>
  78     </varlistentry>
  79     <varlistentry>
  80      <term>-b <replaceable>filename</replaceable></term>
  81      <listitem><para>
  82        If specified, YAZ will dump BER data in readable notation
  83        to the file specified. If <replaceable>filename</replaceable>
  84        is specified as <literal>-</literal> the output is written
  85        to <literal>stdout</literal>.
  86       </para></listitem>
  87     </varlistentry>
  88     <varlistentry>
  89      <term>-c <replaceable>filename</replaceable></term>
  90      <listitem><para>
  91        If specified, CCL configuration will be read from
  92        the file given.
  93       </para></listitem>
  94     </varlistentry>
  95     <varlistentry>
  96      <term>-d <replaceable>dump</replaceable></term>
  97      <listitem><para>
  98        If specified, YAZ will dump BER data for all PDUs sent and received
  99        to individual files, named
 100        <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
 101        where DDD is 001, 002, 003, ..
 102       </para></listitem>
 103     </varlistentry>
 104     <varlistentry>
 105      <term>-k <replaceable>size</replaceable></term>
 106      <listitem><para>
 107       Sets preferred messages and maximum record size for Initialize
 108       Request in kilobytes. Default value is 1024 (1 MB).
 109       </para></listitem>
 110     </varlistentry>
 111     <varlistentry>
 112      <term>-m <replaceable>filename</replaceable></term>
 113      <listitem><para>
 114        If specified, retrieved records will be appended to the file given.
 115       </para></listitem>
 116     </varlistentry>
 117     <varlistentry>
 118      <term>-p <replaceable>addr</replaceable></term>
 119      <listitem><para>
 120        If specified, the client will use the proxy at the address
 121        given.
 122       </para></listitem>
 123     </varlistentry>
 124     <varlistentry>
 125      <term>-q <replaceable>filename</replaceable></term>
 126      <listitem><para>
 127        If specified, CQL configuration will be read from
 128        the file given.
 129       </para></listitem>
 130     </varlistentry>
 131     <varlistentry>
 132      <term>-u <replaceable>auth</replaceable></term>
 133      <listitem><para>
 134        If specified, the <replaceable>auth</replaceable> string
 135        will be used for authentication.
 136       </para></listitem>
 137     </varlistentry>
 138     <varlistentry>
 139      <term>-V</term>
 140      <listitem><para>
 141        Prints YAZ version.
 142      </para></listitem>
 143     </varlistentry>
 144     <varlistentry>
 145      <term>-x</term>
 146      <listitem><para>
 147        Makes the YAZ client print hex dumps of packages sent and received
 148        on standard output.
 149        </para></listitem>
 150     </varlistentry>
 151    </variablelist>
 152   </refsect1>
 153   <refsect1>
 154    <title>COMMANDS</title>
 155    <para>
 156     The YAZ client accepts the following commands.
 157    </para>
 158    &yaz-client-commands;
 159    </refsect1>
 160   <refsect1><title>FILES</title>
 161    <para>
 162     <filename>yaz-&lt;version&gt;/client/client.c</filename>
 163    </para>
 164    <para>
 165     <filename>$HOME/.yazclientrc</filename>
 166    </para>
 167    <para>
 168     <filename>$HOME/.yazclient.history</filename>
 169    </para>
 170   </refsect1>
 171   <refsect1><title>SEE ALSO</title>
 172    <para>
 173     <citerefentry>
 174      <refentrytitle>yaz</refentrytitle>
 175      <manvolnum>7</manvolnum>
 176     </citerefentry>
 177    </para>
 178    <para>
 179     Section "The YAZ Client" in the YAZ manual.
 180    </para>
 181    <para id="PQF">
 182     Section "Prefix Query Format" in the YAZ manual.
 183    </para>
 184    <para id="CCL">
 185     Section "Common Command Language" in the YAZ manual.
 186    </para>
 187    <para id="CQL">
 188     Section "Common Query Language" in the YAZ manual.
 189    </para>
 190   </refsect1>
 191 </refentry>
 192
 193 <!-- Keep this comment at the end of the file
 194 Local variables:
 195 mode: sgml
 196 sgml-omittag:t
 197 sgml-shorttag:t
 198 sgml-minimize-attributes:nil
 199 sgml-always-quote-attributes:t
 200 sgml-indent-step:1
 201 sgml-indent-data:t
 202 sgml-parent-document:nil
 203 sgml-local-catalogs: nil
 204 sgml-namecase-general:t
 205 End:
 206 -->