man pages

[yaz-moved-to-github.git] / doc / yaz-client.sgml

diff --git a/doc/yaz-client.sgml b/doc/yaz-client.sgml
new file mode 100644 (file)
index 0000000..3742846
--- /dev/null
+++ b/doc/yaz-client.sgml
@@ -0,0 +1,130 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+     <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
+]>
+<!-- $Id: yaz-client.sgml,v 1.1 2002-09-16 14:16:31 adam Exp $ -->
+<refentry id="yaz-client">
+ 
+ <refmeta>
+  <refentrytitle>yaz-client</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>yaz-client</refname>
+  <refpurpose>Z39.50 client for implementors</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>yaz-client</command>
+   <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
+   <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
+   <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
+   <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
+   <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
+   <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
+   <arg choice="opt">addr</arg>
+  </cmdsynopsis>
+
+  <cmdsynopsis>
+   <command>yaz-client-ssl</command>
+   <arg rep="repeat" choice="opt"><option>option</option></arg>
+   <arg choice="opt">addr</arg>
+  </cmdsynopsis>
+  
+  <refsect1><title>DESCRIPTION</title>
+   <para>
+    <command>yaz-client</command> is a Z39.50 client (origin) with a
+    simple command line interface that allows you to test behavior and
+    performance of Z39.50 servers (targets).
+   </para>
+   <para>
+    <command>yaz-client-ssl</command> is identical to
+    <command>yaz-client</command> except that it supports SSL transport.
+   </para>
+   <para>
+    If the <replaceable>addr</replaceable> is specified, the client creates
+    a connection to the Z39.50 target at the address.
+   </para>
+  </refsect1>
+  <refsect1>
+   <title>OPTIONS</title>
+   <variablelist>
+    <varlistentry>
+     <term>-m <replaceable>filename</replaceable></term>
+     <listitem><para>
+       If specified, retrieved MARC (ISO2709) records will
+       be appended to the file given.
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-a <replaceable>filename</replaceable></term>
+     <listitem><para>
+       If specified, logging of protocol packages will be appended
+       file given. The special filename <literal>-</literal>
+       (dash) denotes standard output.
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-u <replaceable>auth</replaceable></term>
+     <listitem><para>
+       If specified, the <replaceable>auth</replaceable> string
+       will be used for authentication.
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-c <replaceable>filename</replaceable></term>
+     <listitem><para>
+       If specified, CCL configuration will be read from
+       the file given.
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>-p <replaceable>addr</replaceable></term>
+     <listitem><para>
+       If specified, the client will use the proxy at the address
+       given.
+      </para></listitem>
+    </varlistentry>
+   </variablelist>
+  </refsect1>
+  <refsect1>
+   <title>COMMANDS</title>
+   <para>
+    The YAZ client accepts the following commands.
+   </para>
+   &yaz-client-commands;
+   </refsect1>
+  <refsect1><title>FILES</title>
+   <para>
+    <filename>yaz-&lt;version&gt;/client/client.c</filename>
+   </para>
+  </refsect1>
+  <refsect1><title>SEE ALSO</title>
+   <para>yaz(7)</para>
+   <para>
+    Section "The YAZ Client" in the YAZ manual.
+   </para>
+   <para id="PQF">
+    Section "Prefix Query Format" in the YAZ manual.
+   </para>
+   <para id="CCL">
+    Section "Common Command Language" in the YAZ manual.
+   </para>
+  </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->