Added yaz-illclient man page.

[yaz-moved-to-github.git] / doc / yaz-illclient-man.xml

diff --git a/doc/yaz-illclient-man.xml b/doc/yaz-illclient-man.xml
new file mode 100644 (file)
index 0000000..e70436d
--- /dev/null
+++ b/doc/yaz-illclient-man.xml
@@ -0,0 +1,137 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
+]>
+<!-- $Id: yaz-illclient-man.xml,v 1.1 2007-06-03 09:56:50 adam Exp $ -->
+<refentry id="yaz-illclient">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
+ 
+ <refmeta>
+  <refentrytitle>yaz-illclient</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>yaz-illclient</refname>
+  <refpurpose>ILL client</refpurpose>
+ </refnamediv>
+ 
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>yaz-illclient</command>
+   <arg choice="opt"><option>-f <replaceable>filename</replaceable></option></arg>
+   <arg choice="opt"><option>-v <replaceable>loglevel</replaceable></option></arg>
+   <arg choice="opt" rep="repeat"><option>-D</option> <replaceable>name=value</replaceable></arg>
+   <arg choice="opt"><option>-o</option></arg>
+   <arg choice="opt"><option>-u <replaceable>user</replaceable></option></arg>
+   <arg choice="opt"><option>-p <replaceable>password</replaceable></option></arg>   
+   <arg choice="opt"><option>-V</option></arg>
+   <arg choice="opt">server-addr</arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>yaz-illclient</command> is an client which sends an ISO
+   ILL request to a remote server and decodes the response from it.
+   Exactly one server address ( <replaceable>server-addr</replaceable> )
+   must be specified.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>OPTIONS</title>
+  
+  <variablelist>
+   <varlistentry>
+    <term>-f <replaceable>filename</replaceable>]</term>
+    <listitem><para>
+      Specify filename.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-v <replaceable>loglevel</replaceable>]</term>
+    <listitem><para>
+      Specify the log level
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-D <replaceable>name=value</replaceable>]</term>
+    <listitem><para>
+      Defines name &amp; value pair.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-o</term>
+    <listitem><para>
+      Enable OCLC authentication.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-u <replaceable>user</replaceable>]</term>
+    <listitem><para>
+      Specify user.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-p <replaceable>password</replaceable>]</term>
+    <listitem><para>
+      Specify password.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-V</term>
+    <listitem><para>
+      Show yaz-illclient version.
+     </para></listitem>
+   </varlistentry>
+
+  </variablelist>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   None yet.
+  </para>
+ </refsect1> 
+
+ <refsect1><title>FILES</title>
+  <para>
+   None yet.
+  </para>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   yaz(7)
+  </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:
+-->