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