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