1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
4 <!ENTITY % common SYSTEM "common/common.ent">
6 <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
8 <!-- $Id: yaz-client-man.xml,v 1.9 2006-05-24 12:33:21 adam Exp $ -->
9 <refentry id="yaz-client">
12 <refentrytitle>yaz-client</refentrytitle>
13 <manvolnum>1</manvolnum>
17 <refname>yaz-client</refname>
18 <refpurpose>Z39.50/SRW client for implementors</refpurpose>
23 <command>yaz-client</command>
24 <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
25 <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
26 <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
27 <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
28 <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
29 <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
30 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
31 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
32 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
33 <arg choice="opt"><option>-xV</option></arg>
34 <arg choice="opt">addr</arg>
39 <refsect1><title>DESCRIPTION</title>
41 <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
42 simple command line interface that allows you to test behavior and
43 performance of Z39.50 targets and SRW servers.
46 If the <replaceable>addr</replaceable> is specified, the client creates
47 a connection to the Z39.50/SRW target at the address given.
50 When <command>yaz-client</command> is invoked it attemps to read the
52 <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
53 <literal>.yazclientrc</literal> (current directory - any platform)
54 For those files that are readable, the YAZ client executes commands
55 in those files. See COMMANDS section for description of commands.
59 <title>OPTIONS</title>
62 <term>-a <replaceable>filename</replaceable></term>
64 If specified, logging of protocol packages will be appended
65 file given. If <replaceable>filename</replaceable> is
66 specified as <literal>-</literal>, the output is written
67 to <literal>stdout</literal>.
71 <term>-b <replaceable>filename</replaceable></term>
73 If specified, YAZ will dump BER data in readable notation
74 to the file specified. If <replaceable>filename</replaceable>
75 is specified as <literal>-</literal> the output is written
76 to <literal>stdout</literal>.
80 <term>-c <replaceable>filename</replaceable></term>
82 If specified, CCL configuration will be read from
87 <term>-d <replaceable>dump</replaceable></term>
89 If specified, YAZ will dump BER data for all PDUs sent and received
90 to individual files, named
91 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
92 where DDD is 001, 002, 003, ..
96 <term>-k <replaceable>size</replaceable></term>
98 Sets preferred messages and maximum record size for Initialize
99 Request in kilobytes. Default value is 1024 (1 MB).
103 <term>-m <replaceable>filename</replaceable></term>
105 If specified, retrieved records will be appended to the file given.
109 <term>-p <replaceable>addr</replaceable></term>
111 If specified, the client will use the proxy at the address
116 <term>-q <replaceable>filename</replaceable></term>
118 If specified, CQL configuration will be read from
123 <term>-u <replaceable>auth</replaceable></term>
125 If specified, the <replaceable>auth</replaceable> string
126 will be used for authentication.
138 Makes the YAZ client print hex dumps of packages sent and received
145 <title>COMMANDS</title>
147 The YAZ client accepts the following commands.
149 &yaz-client-commands;
151 <refsect1><title>FILES</title>
153 <filename>yaz-<version>/client/client.c</filename>
156 <filename>.yazclientrc</filename>
159 <filename>$HOME/.yazclientrc</filename>
162 <refsect1><title>SEE ALSO</title>
165 <refentrytitle>yaz</refentrytitle>
166 <manvolnum>7</manvolnum>
170 Section "The YAZ Client" in the YAZ manual.
173 Section "Prefix Query Format" in the YAZ manual.
176 Section "Common Command Language" in the YAZ manual.
179 Section "Common Query Language" in the YAZ manual.
184 <!-- Keep this comment at the end of the file
189 sgml-minimize-attributes:nil
190 sgml-always-quote-attributes:t
193 sgml-parent-document:nil
194 sgml-local-catalogs: nil
195 sgml-namecase-general:t