doc/yaz-client.sgml

   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.sgml,v 1.4 2002-10-23 10:11:44 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 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>-p <replaceable>addr</replaceable></option></arg>
  24    <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
  25    <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
  26    <arg choice="opt">addr</arg>
  27   </cmdsynopsis>
  28
  29   <cmdsynopsis>
  30    <command>yaz-client-ssl</command>
  31    <arg rep="repeat" choice="opt"><option>option</option></arg>
  32    <arg choice="opt">addr</arg>
  33   </cmdsynopsis>
  34
  35  </refsynopsisdiv>
  36
  37   <refsect1><title>DESCRIPTION</title>
  38    <para>
  39     <command>yaz-client</command> is a Z39.50 client (origin) with a
  40     simple command line interface that allows you to test behavior and
  41     performance of Z39.50 servers (targets).
  42    </para>
  43    <para>
  44     <command>yaz-client-ssl</command> is identical to
  45     <command>yaz-client</command> except that it supports SSL transport.
  46    </para>
  47    <para>
  48     If the <replaceable>addr</replaceable> is specified, the client creates
  49     a connection to the Z39.50 target at the address.
  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 MARC (ISO2709) records will
  59        be appended to the file given.
  60       </para></listitem>
  61     </varlistentry>
  62     <varlistentry>
  63      <term>-a <replaceable>filename</replaceable></term>
  64      <listitem><para>
  65        If specified, logging of protocol packages will be appended
  66        file given. The special filename <literal>-</literal>
  67        (dash) denotes standard output.
  68       </para></listitem>
  69     </varlistentry>
  70     <varlistentry>
  71      <term>-u <replaceable>auth</replaceable></term>
  72      <listitem><para>
  73        If specified, the <replaceable>auth</replaceable> string
  74        will be used for authentication.
  75       </para></listitem>
  76     </varlistentry>
  77     <varlistentry>
  78      <term>-c <replaceable>filename</replaceable></term>
  79      <listitem><para>
  80        If specified, CCL configuration will be read from
  81        the file given.
  82       </para></listitem>
  83     </varlistentry>
  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    </variablelist>
  92   </refsect1>
  93   <refsect1>
  94    <title>COMMANDS</title>
  95    <para>
  96     The YAZ client accepts the following commands.
  97    </para>
  98    &yaz-client-commands;
  99    </refsect1>
 100   <refsect1><title>FILES</title>
 101    <para>
 102     <filename>yaz-&lt;version&gt;/client/client.c</filename>
 103    </para>
 104   </refsect1>
 105   <refsect1><title>SEE ALSO</title>
 106    <para>
 107     <citerefentry>
 108      <refentrytitle>yaz</refentrytitle>
 109      <manvolnum>7</manvolnum>
 110     </citerefentry>
 111    </para>
 112    <para>
 113     Section "The YAZ Client" in the YAZ manual.
 114    </para>
 115    <para id="PQF">
 116     Section "Prefix Query Format" in the YAZ manual.
 117    </para>
 118    <para id="CCL">
 119     Section "Common Command Language" in the YAZ manual.
 120    </para>
 121   </refsect1>
 122 </refentry>
 123
 124 <!-- Keep this comment at the end of the file
 125 Local variables:
 126 mode: sgml
 127 sgml-omittag:t
 128 sgml-shorttag:t
 129 sgml-minimize-attributes:nil
 130 sgml-always-quote-attributes:t
 131 sgml-indent-step:1
 132 sgml-indent-data:t
 133 sgml-parent-document:nil
 134 sgml-local-catalogs: nil
 135 sgml-namecase-general:t
 136 End:
 137 -->