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