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