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 % common SYSTEM "common/common.ent">
   9      %common;
  10 ]>
  11 <!-- $Id: yaz-client-man.xml,v 1.13 2007-01-24 11:50:18 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 the
  58    following files:
  59    <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
  60    <literal>.yazclientrc</literal> (current directory - any platform)
  61    For those files that are readable, the YAZ client executes commands
  62    in those files. See COMMANDS section for description of commands.
  63   </para>
  64  </refsect1>
  65   <refsect1>
  66    <title>OPTIONS</title>
  67    <variablelist>
  68     <varlistentry>
  69      <term>-a <replaceable>filename</replaceable></term>
  70      <listitem><para>
  71        If specified, logging of protocol packages will be appended
  72        file given. If <replaceable>filename</replaceable> is
  73        specified as <literal>-</literal>, the output is written
  74        to <literal>stdout</literal>.
  75       </para></listitem>
  76     </varlistentry>
  77     <varlistentry>
  78      <term>-b <replaceable>filename</replaceable></term>
  79      <listitem><para>
  80        If specified, YAZ will dump BER data in readable notation
  81        to the file specified. If <replaceable>filename</replaceable>
  82        is specified as <literal>-</literal> the output is written
  83        to <literal>stdout</literal>.
  84       </para></listitem>
  85     </varlistentry>
  86     <varlistentry>
  87      <term>-c <replaceable>filename</replaceable></term>
  88      <listitem><para>
  89        If specified, CCL configuration will be read from
  90        the file given.
  91       </para></listitem>
  92     </varlistentry>
  93     <varlistentry>
  94      <term>-d <replaceable>dump</replaceable></term>
  95      <listitem><para>
  96        If specified, YAZ will dump BER data for all PDUs sent and received
  97        to individual files, named
  98        <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
  99        where DDD is 001, 002, 003, ..
 100       </para></listitem>
 101     </varlistentry>
 102     <varlistentry>
 103      <term>-k <replaceable>size</replaceable></term>
 104      <listitem><para>
 105       Sets preferred messages and maximum record size for Initialize
 106       Request in kilobytes. Default value is 1024 (1 MB).
 107       </para></listitem>
 108     </varlistentry>
 109     <varlistentry>
 110      <term>-m <replaceable>filename</replaceable></term>
 111      <listitem><para>
 112        If specified, retrieved records will be appended to the file given.
 113       </para></listitem>
 114     </varlistentry>
 115     <varlistentry>
 116      <term>-p <replaceable>addr</replaceable></term>
 117      <listitem><para>
 118        If specified, the client will use the proxy at the address
 119        given.
 120       </para></listitem>
 121     </varlistentry>
 122     <varlistentry>
 123      <term>-q <replaceable>filename</replaceable></term>
 124      <listitem><para>
 125        If specified, CQL configuration will be read from
 126        the file given.
 127       </para></listitem>
 128     </varlistentry>
 129     <varlistentry>
 130      <term>-u <replaceable>auth</replaceable></term>
 131      <listitem><para>
 132        If specified, the <replaceable>auth</replaceable> string
 133        will be used for authentication.
 134       </para></listitem>
 135     </varlistentry>
 136     <varlistentry>
 137      <term>-V</term>
 138      <listitem><para>
 139        Prints YAZ version.
 140      </para></listitem>
 141     </varlistentry>
 142     <varlistentry>
 143      <term>-x</term>
 144      <listitem><para>
 145        Makes the YAZ client print hex dumps of packages sent and received
 146        on standard output.
 147        </para></listitem>
 148     </varlistentry>
 149    </variablelist>
 150   </refsect1>
 151   <refsect1>
 152    <title>COMMANDS</title>
 153    <para>
 154     The YAZ client accepts the following commands.
 155    </para>
 156    &yaz-client-commands;
 157    </refsect1>
 158   <refsect1><title>FILES</title>
 159    <para>
 160     <filename>yaz-&lt;version&gt;/client/client.c</filename>
 161    </para>
 162    <para>
 163     <filename>$HOME/.yazclientrc</filename>
 164    </para>
 165    <para>
 166     <filename>$HOME/.yazclient.history</filename>
 167    </para>
 168   </refsect1>
 169   <refsect1><title>SEE ALSO</title>
 170    <para>
 171     <citerefentry>
 172      <refentrytitle>yaz</refentrytitle>
 173      <manvolnum>7</manvolnum>
 174     </citerefentry>
 175    </para>
 176    <para>
 177     Section "The YAZ Client" in the YAZ manual.
 178    </para>
 179    <para id="PQF">
 180     Section "Prefix Query Format" in the YAZ manual.
 181    </para>
 182    <para id="CCL">
 183     Section "Common Command Language" in the YAZ manual.
 184    </para>
 185    <para id="CQL">
 186     Section "Common Query Language" in the YAZ manual.
 187    </para>
 188   </refsect1>
 189 </refentry>
 190
 191 <!-- Keep this comment at the end of the file
 192 Local variables:
 193 mode: sgml
 194 sgml-omittag:t
 195 sgml-shorttag:t
 196 sgml-minimize-attributes:nil
 197 sgml-always-quote-attributes:t
 198 sgml-indent-step:1
 199 sgml-indent-data:t
 200 sgml-parent-document:nil
 201 sgml-local-catalogs: nil
 202 sgml-namecase-general:t
 203 End:
 204 -->