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.1 2003-10-27 12:21: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   <cmdsynopsis>
  32    <command>yaz-client-ssl</command>
  33    <arg rep="repeat" choice="opt"><option>option</option></arg>
  34    <arg choice="opt">addr</arg>
  35   </cmdsynopsis>
  36
  37  </refsynopsisdiv>
  38
  39   <refsect1><title>DESCRIPTION</title>
  40    <para>
  41     <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
  42     simple command line interface that allows you to test behavior and
  43     performance of Z39.50 targets and SRW servers.
  44    </para>
  45    <para>
  46     <command>yaz-client-ssl</command> is identical to
  47     <command>yaz-client</command> except that it supports SSL transport.
  48    </para>
  49    <para>
  50     If the <replaceable>addr</replaceable> is specified, the client creates
  51     a connection to the Z39.50/SRW target at the address.
  52    </para>
  53   </refsect1>
  54   <refsect1>
  55    <title>OPTIONS</title>
  56    <variablelist>
  57     <varlistentry>
  58      <term>-m <replaceable>filename</replaceable></term>
  59      <listitem><para>
  60        If specified, retrieved MARC (ISO2709) records will
  61        be appended to the file given.
  62       </para></listitem>
  63     </varlistentry>
  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. The special filename <literal>-</literal>
  69        (dash) denotes standard output.
  70       </para></listitem>
  71     </varlistentry>
  72     <varlistentry>
  73      <term>-u <replaceable>auth</replaceable></term>
  74      <listitem><para>
  75        If specified, the <replaceable>auth</replaceable> string
  76        will be used for authentication.
  77       </para></listitem>
  78     </varlistentry>
  79     <varlistentry>
  80      <term>-c <replaceable>filename</replaceable></term>
  81      <listitem><para>
  82        If specified, CCL configuration will be read from
  83        the file given.
  84       </para></listitem>
  85     </varlistentry>
  86     <varlistentry>
  87      <term>-q <replaceable>filename</replaceable></term>
  88      <listitem><para>
  89        If specified, CQL configuration will be read from
  90        the file given.
  91       </para></listitem>
  92     </varlistentry>
  93
  94     <varlistentry>
  95      <term>-p <replaceable>addr</replaceable></term>
  96      <listitem><para>
  97        If specified, the client will use the proxy at the address
  98        given.
  99       </para></listitem>
 100     </varlistentry>
 101
 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
 110     <varlistentry>
 111      <term>-x</term>
 112     <listitem><para>
 113       Makes the YAZ client print hex dumps of packages sent and received
 114       on standard output.
 115       </para></listitem>
 116     </varlistentry>
 117    </variablelist>
 118   </refsect1>
 119   <refsect1>
 120    <title>COMMANDS</title>
 121    <para>
 122     The YAZ client accepts the following commands.
 123    </para>
 124    &yaz-client-commands;
 125    </refsect1>
 126   <refsect1><title>FILES</title>
 127    <para>
 128     <filename>yaz-&lt;version&gt;/client/client.c</filename>
 129    </para>
 130   </refsect1>
 131   <refsect1><title>SEE ALSO</title>
 132    <para>
 133     <citerefentry>
 134      <refentrytitle>yaz</refentrytitle>
 135      <manvolnum>7</manvolnum>
 136     </citerefentry>
 137    </para>
 138    <para>
 139     Section "The YAZ Client" in the YAZ manual.
 140    </para>
 141    <para id="PQF">
 142     Section "Prefix Query Format" in the YAZ manual.
 143    </para>
 144    <para id="CCL">
 145     Section "Common Command Language" in the YAZ manual.
 146    </para>
 147    <para id="CQL">
 148     Section "Common QUery Language" in the YAZ manual.
 149    </para>
 150   </refsect1>
 151 </refentry>
 152
 153 <!-- Keep this comment at the end of the file
 154 Local variables:
 155 mode: sgml
 156 sgml-omittag:t
 157 sgml-shorttag:t
 158 sgml-minimize-attributes:nil
 159 sgml-always-quote-attributes:t
 160 sgml-indent-step:1
 161 sgml-indent-data:t
 162 sgml-parent-document:nil
 163 sgml-local-catalogs: nil
 164 sgml-namecase-general:t
 165 End:
 166 -->