doc/yaz-client-man.xml

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