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