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.3 2004-09-22 19:22:24 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.
  42    </para>
  43   </refsect1>
  44   <refsect1>
  45    <title>OPTIONS</title>
  46    <variablelist>
  47     <varlistentry>
  48      <term>-m <replaceable>filename</replaceable></term>
  49      <listitem><para>
  50        If specified, retrieved records will be appended to the file given.
  51       </para></listitem>
  52     </varlistentry>
  53     <varlistentry>
  54      <term>-a <replaceable>filename</replaceable></term>
  55      <listitem><para>
  56        If specified, logging of protocol packages will be appended
  57        file given. The special filename <literal>-</literal>
  58        (dash) denotes standard output.
  59       </para></listitem>
  60     </varlistentry>
  61     <varlistentry>
  62      <term>-u <replaceable>auth</replaceable></term>
  63      <listitem><para>
  64        If specified, the <replaceable>auth</replaceable> string
  65        will be used for authentication.
  66       </para></listitem>
  67     </varlistentry>
  68     <varlistentry>
  69      <term>-c <replaceable>filename</replaceable></term>
  70      <listitem><para>
  71        If specified, CCL configuration will be read from
  72        the file given.
  73       </para></listitem>
  74     </varlistentry>
  75     <varlistentry>
  76      <term>-q <replaceable>filename</replaceable></term>
  77      <listitem><para>
  78        If specified, CQL configuration will be read from
  79        the file given.
  80       </para></listitem>
  81     </varlistentry>
  82
  83     <varlistentry>
  84      <term>-p <replaceable>addr</replaceable></term>
  85      <listitem><para>
  86        If specified, the client will use the proxy at the address
  87        given.
  88       </para></listitem>
  89     </varlistentry>
  90
  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
  99     <varlistentry>
 100      <term>-x</term>
 101     <listitem><para>
 102       Makes the YAZ client print hex dumps of packages sent and received
 103       on standard output.
 104       </para></listitem>
 105     </varlistentry>
 106    </variablelist>
 107   </refsect1>
 108   <refsect1>
 109    <title>COMMANDS</title>
 110    <para>
 111     The YAZ client accepts the following commands.
 112    </para>
 113    &yaz-client-commands;
 114    </refsect1>
 115   <refsect1><title>FILES</title>
 116    <para>
 117     <filename>yaz-&lt;version&gt;/client/client.c</filename>
 118    </para>
 119   </refsect1>
 120   <refsect1><title>SEE ALSO</title>
 121    <para>
 122     <citerefentry>
 123      <refentrytitle>yaz</refentrytitle>
 124      <manvolnum>7</manvolnum>
 125     </citerefentry>
 126    </para>
 127    <para>
 128     Section "The YAZ Client" in the YAZ manual.
 129    </para>
 130    <para id="PQF">
 131     Section "Prefix Query Format" in the YAZ manual.
 132    </para>
 133    <para id="CCL">
 134     Section "Common Command Language" in the YAZ manual.
 135    </para>
 136    <para id="CQL">
 137     Section "Common QUery Language" in the YAZ manual.
 138    </para>
 139   </refsect1>
 140 </refentry>
 141
 142 <!-- Keep this comment at the end of the file
 143 Local variables:
 144 mode: sgml
 145 sgml-omittag:t
 146 sgml-shorttag:t
 147 sgml-minimize-attributes:nil
 148 sgml-always-quote-attributes:t
 149 sgml-indent-step:1
 150 sgml-indent-data:t
 151 sgml-parent-document:nil
 152 sgml-local-catalogs: nil
 153 sgml-namecase-general:t
 154 End:
 155 -->