1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
4 <!ENTITY % local SYSTEM "local.ent">
6 <!ENTITY % entities SYSTEM "entities.ent">
8 <!ENTITY % idcommon SYSTEM "common/common.ent">
11 <!-- $Id: yaz-client-man.xml,v 1.17 2007-11-21 09:04:46 adam Exp $ -->
12 <refentry id="yaz-client">
14 <productname>YAZ</productname>
15 <productnumber>&version;</productnumber>
19 <refentrytitle>yaz-client</refentrytitle>
20 <manvolnum>1</manvolnum>
24 <refname>yaz-client</refname>
25 <refpurpose>Z39.50/SRU client for implementors</refpurpose>
30 <command>yaz-client</command>
31 <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
32 <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
33 <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
34 <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
35 <arg choice="opt"><option>-f <replaceable>cmdfile</replaceable></option></arg>
36 <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
37 <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
38 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
39 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
40 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
41 <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
42 <arg choice="opt"><option>-xV</option></arg>
43 <arg choice="opt">addr</arg>
48 <refsect1><title>DESCRIPTION</title>
50 <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
51 simple command line interface that allows you to test behavior and
52 performance of Z39.50 targets and SRU servers.
55 If the <replaceable>addr</replaceable> is specified, the client creates
56 a connection to the Z39.50/SRU target at the address given.
59 When <command>yaz-client</command> is started it tries to read
60 commands from one of the following files:
63 Command file if it is given by option -f.
66 <filename>.yazclientrc</filename> in current working directory.
69 <filename>.yazclientrc</filename> in the user's home directory.
70 The value of the <literal>HOME</literal> is used to determine
71 the home directory. Normally, <literal>HOME</literal> is only set
72 on POSIX systems such as Linux, FreeBSD, Solaris.
78 <title>OPTIONS</title>
81 <term>-a <replaceable>filename</replaceable></term>
83 If specified, logging of protocol packages will be appended
84 file given. If <replaceable>filename</replaceable> is
85 specified as <literal>-</literal>, the output is written
86 to <literal>stdout</literal>.
90 <term>-b <replaceable>filename</replaceable></term>
92 If specified, YAZ will dump BER data in readable notation
93 to the file specified. If <replaceable>filename</replaceable>
94 is specified as <literal>-</literal> the output is written
95 to <literal>stdout</literal>.
99 <term>-c <replaceable>filename</replaceable></term>
101 If specified, CCL configuration will be read from
106 <term>-d <replaceable>dump</replaceable></term>
108 If specified, YAZ will dump BER data for all PDUs sent and received
109 to individual files, named
110 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
111 where DDD is 001, 002, 003, ..
116 <term>-f <replaceable>cmdfile</replaceable></term>
118 Reads commands from <replaceable>cmdfile</replaceable>. When
119 this option is used, YAZ client does not read .yazclientrc
120 from current directory or home directory.
125 <term>-k <replaceable>size</replaceable></term>
127 Sets preferred messages and maximum record size for Initialize
128 Request in kilobytes. Default value is 1024 (1 MB).
132 <term>-m <replaceable>filename</replaceable></term>
134 If specified, retrieved records will be appended to the file given.
138 <term>-p <replaceable>addr</replaceable></term>
140 If specified, the client will use the proxy at the address
141 given. YAZ client will
142 connect to a proxy on the address and port given.
143 The actual target will be specified as part of the InitRequest
144 to inform the proxy about actual target.
148 <term>-q <replaceable>filename</replaceable></term>
150 If specified, CQL configuration will be read from
155 <term>-u <replaceable>auth</replaceable></term>
157 If specified, the <replaceable>auth</replaceable> string
158 will be used for authentication.
162 <literal>-v</literal> <replaceable>level</replaceable>
164 <simpara>Sets the LOG level to <replaceable>level</replaceable>.
165 Level is a sequence of tokens separated by comma. Each token
166 is a integer or a named LOG item - one of
167 <literal>fatal</literal>,
168 <literal>debug</literal>,
169 <literal>warn</literal>,
170 <literal>log</literal>,
171 <literal>malloc</literal>,
172 <literal>all</literal>,
173 <literal>none</literal>.
174 </simpara></listitem>
185 Makes the YAZ client print hex dumps of packages sent and received
192 <title>COMMANDS</title>
194 The YAZ client accepts the following commands.
196 &yaz-client-commands;
198 <refsect1><title>EXAMPLE</title>
200 The simplest example of a Prefix Query would be something like
208 In those queries no attributes was specified.
209 This leaves it up to the server what fields to search but
210 most servers will search in all fields. Some servers does not
211 support this feature though, and require that some attributes
212 are defined. To add one attribute you could do:
216 where we search in the title field, since the use(1) is title(4).
217 If we want to search in the author field <emphasis>and</emphasis>
218 in the title field, and in the title field using right truncation
219 it could look something like this:
221 f @and @attr 1=1003 knuth @attr 1=4 @attr 5=1 computer
223 Finally using a mix of Bib-1 and GILS attributes could look
226 f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather
230 <refsect1><title>FILES</title>
232 <filename>yaz-<version>/client/client.c</filename>
235 <filename>$HOME/.yazclientrc</filename>
238 <filename>$HOME/.yazclient.history</filename>
241 <refsect1><title>SEE ALSO</title>
244 <refentrytitle>yaz</refentrytitle>
245 <manvolnum>7</manvolnum>
251 <!-- Keep this comment at the end of the file
256 sgml-minimize-attributes:nil
257 sgml-always-quote-attributes:t
260 sgml-parent-document:nil
261 sgml-local-catalogs: nil
262 sgml-namecase-general:t