doc/yaz-client-man.xml

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