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.1 2002-09-16 14:16:31 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   <refsect1><title>DESCRIPTION</title>
  36    <para>
  37     <command>yaz-client</command> is a Z39.50 client (origin) with a
  38     simple command line interface that allows you to test behavior and
  39     performance of Z39.50 servers (targets).
  40    </para>
  41    <para>
  42     <command>yaz-client-ssl</command> is identical to
  43     <command>yaz-client</command> except that it supports SSL transport.
  44    </para>
  45    <para>
  46     If the <replaceable>addr</replaceable> is specified, the client creates
  47     a connection to the Z39.50 target at the address.
  48    </para>
  49   </refsect1>
  50   <refsect1>
  51    <title>OPTIONS</title>
  52    <variablelist>
  53     <varlistentry>
  54      <term>-m <replaceable>filename</replaceable></term>
  55      <listitem><para>
  56        If specified, retrieved MARC (ISO2709) records will
  57        be appended to the file given.
  58       </para></listitem>
  59     </varlistentry>
  60     <varlistentry>
  61      <term>-a <replaceable>filename</replaceable></term>
  62      <listitem><para>
  63        If specified, logging of protocol packages will be appended
  64        file given. The special filename <literal>-</literal>
  65        (dash) denotes standard output.
  66       </para></listitem>
  67     </varlistentry>
  68     <varlistentry>
  69      <term>-u <replaceable>auth</replaceable></term>
  70      <listitem><para>
  71        If specified, the <replaceable>auth</replaceable> string
  72        will be used for authentication.
  73       </para></listitem>
  74     </varlistentry>
  75     <varlistentry>
  76      <term>-c <replaceable>filename</replaceable></term>
  77      <listitem><para>
  78        If specified, CCL configuration will be read from
  79        the file given.
  80       </para></listitem>
  81     </varlistentry>
  82     <varlistentry>
  83      <term>-p <replaceable>addr</replaceable></term>
  84      <listitem><para>
  85        If specified, the client will use the proxy at the address
  86        given.
  87       </para></listitem>
  88     </varlistentry>
  89    </variablelist>
  90   </refsect1>
  91   <refsect1>
  92    <title>COMMANDS</title>
  93    <para>
  94     The YAZ client accepts the following commands.
  95    </para>
  96    &yaz-client-commands;
  97    </refsect1>
  98   <refsect1><title>FILES</title>
  99    <para>
 100     <filename>yaz-&lt;version&gt;/client/client.c</filename>
 101    </para>
 102   </refsect1>
 103   <refsect1><title>SEE ALSO</title>
 104    <para>yaz(7)</para>
 105    <para>
 106     Section "The YAZ Client" in the YAZ manual.
 107    </para>
 108    <para id="PQF">
 109     Section "Prefix Query Format" in the YAZ manual.
 110    </para>
 111    <para id="CCL">
 112     Section "Common Command Language" in the YAZ manual.
 113    </para>
 114   </refsect1>
 115 </refentry>
 116
 117 <!-- Keep this comment at the end of the file
 118 Local variables:
 119 mode: sgml
 120 sgml-omittag:t
 121 sgml-shorttag:t
 122 sgml-minimize-attributes:nil
 123 sgml-always-quote-attributes:t
 124 sgml-indent-step:1
 125 sgml-indent-data:t
 126 sgml-parent-document:nil
 127 sgml-local-catalogs: nil
 128 sgml-namecase-general:t
 129 End:
 130 -->