doc/yaz-illclient-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <refentry id="yaz-illclient">
  12  <refentryinfo>
  13   <productname>YAZ</productname>
  14   <productnumber>&version;</productnumber>
  15  </refentryinfo>
  16
  17  <refmeta>
  18   <refentrytitle>yaz-illclient</refentrytitle>
  19   <manvolnum>1</manvolnum>
  20  </refmeta>
  21
  22  <refnamediv>
  23   <refname>yaz-illclient</refname>
  24   <refpurpose>ILL client</refpurpose>
  25  </refnamediv>
  26
  27  <refsynopsisdiv>
  28   <cmdsynopsis>
  29    <command>yaz-illclient</command>
  30    <arg choice="opt"><option>-f <replaceable>filename</replaceable></option></arg>
  31    <arg choice="opt"><option>-v <replaceable>loglevel</replaceable></option></arg>
  32    <arg choice="opt" rep="repeat"><option>-D</option> <replaceable>name=value</replaceable></arg>
  33    <arg choice="opt"><option>-o</option></arg>
  34    <arg choice="opt"><option>-u <replaceable>user</replaceable></option></arg>
  35    <arg choice="opt"><option>-p <replaceable>password</replaceable></option></arg>
  36    <arg choice="opt"><option>-V</option></arg>
  37    <arg choice="opt">server-addr</arg>
  38   </cmdsynopsis>
  39  </refsynopsisdiv>
  40
  41  <refsect1><title>DESCRIPTION</title>
  42   <para>
  43    <command>yaz-illclient</command> is an client which sends an ISO
  44    ILL request to a remote server and decodes the response from it.
  45    Exactly one server address ( <replaceable>server-addr</replaceable> )
  46    must be specified.
  47   </para>
  48  </refsect1>
  49
  50  <refsect1><title>OPTIONS</title>
  51
  52   <variablelist>
  53    <varlistentry>
  54     <term>-f <replaceable>filename</replaceable>]</term>
  55     <listitem><para>
  56       Specify filename.
  57      </para></listitem>
  58    </varlistentry>
  59
  60    <varlistentry>
  61     <term>-v <replaceable>loglevel</replaceable>]</term>
  62     <listitem><para>
  63       Specify the log level
  64      </para></listitem>
  65    </varlistentry>
  66
  67    <varlistentry>
  68     <term>-D <replaceable>name=value</replaceable>]</term>
  69     <listitem><para>
  70       Defines name &amp; value pair.
  71      </para></listitem>
  72    </varlistentry>
  73
  74    <varlistentry>
  75     <term>-o</term>
  76     <listitem><para>
  77       Enable OCLC authentication.
  78      </para></listitem>
  79    </varlistentry>
  80
  81    <varlistentry>
  82     <term>-u <replaceable>user</replaceable>]</term>
  83     <listitem><para>
  84       Specify user.
  85      </para></listitem>
  86    </varlistentry>
  87
  88    <varlistentry>
  89     <term>-p <replaceable>password</replaceable>]</term>
  90     <listitem><para>
  91       Specify password.
  92      </para></listitem>
  93    </varlistentry>
  94
  95    <varlistentry>
  96     <term>-V</term>
  97     <listitem><para>
  98       Show yaz-illclient version.
  99      </para></listitem>
 100    </varlistentry>
 101
 102   </variablelist>
 103  </refsect1>
 104
 105  <refsect1><title>EXAMPLES</title>
 106   <para>
 107    None yet.
 108   </para>
 109  </refsect1>
 110
 111  <refsect1><title>FILES</title>
 112   <para>
 113    None yet.
 114   </para>
 115  </refsect1>
 116  <refsect1><title>SEE ALSO</title>
 117   <para>
 118    yaz(7)
 119   </para>
 120  </refsect1>
 121 </refentry>
 122
 123 <!-- Keep this comment at the end of the file
 124 Local variables:
 125 mode: sgml
 126 sgml-omittag:t
 127 sgml-shorttag:t
 128 sgml-minimize-attributes:nil
 129 sgml-always-quote-attributes:t
 130 sgml-indent-step:1
 131 sgml-indent-data:t
 132 sgml-parent-document:nil
 133 sgml-local-catalogs: nil
 134 sgml-namecase-general:t
 135 End:
 136 -->