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