1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2 <!ENTITY % common SYSTEM "common/common.ent">
4 <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
6 <!-- $Id: yaz-client-man.xml,v 1.8 2006-04-25 11:25:08 marc Exp $ -->
7 <refentry id="yaz-client">
10 <refentrytitle>yaz-client</refentrytitle>
11 <manvolnum>1</manvolnum>
15 <refname>yaz-client</refname>
16 <refpurpose>Z39.50/SRW client for implementors</refpurpose>
21 <command>yaz-client</command>
22 <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
23 <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
24 <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
25 <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
26 <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
27 <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
28 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
29 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
30 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
31 <arg choice="opt"><option>-xV</option></arg>
32 <arg choice="opt">addr</arg>
37 <refsect1><title>DESCRIPTION</title>
39 <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
40 simple command line interface that allows you to test behavior and
41 performance of Z39.50 targets and SRW servers.
44 If the <replaceable>addr</replaceable> is specified, the client creates
45 a connection to the Z39.50/SRW target at the address given.
48 When <command>yaz-client</command> is invoked it attemps to read the
50 <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
51 <literal>.yazclientrc</literal> (current directory - any platform)
52 For those files that are readable, the YAZ client executes commands
53 in those files. See COMMANDS section for description of commands.
57 <title>OPTIONS</title>
60 <term>-a <replaceable>filename</replaceable></term>
62 If specified, logging of protocol packages will be appended
63 file given. If <replaceable>filename</replaceable> is
64 specified as <literal>-</literal>, the output is written
65 to <literal>stdout</literal>.
69 <term>-b <replaceable>filename</replaceable></term>
71 If specified, YAZ will dump BER data in readable notation
72 to the file specified. If <replaceable>filename</replaceable>
73 is specified as <literal>-</literal> the output is written
74 to <literal>stdout</literal>.
78 <term>-c <replaceable>filename</replaceable></term>
80 If specified, CCL configuration will be read from
85 <term>-d <replaceable>dump</replaceable></term>
87 If specified, YAZ will dump BER data for all PDUs sent and received
88 to individual files, named
89 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
90 where DDD is 001, 002, 003, ..
94 <term>-k <replaceable>size</replaceable></term>
96 Sets preferred messages and maximum record size for Initialize
97 Request in kilobytes. Default value is 1024 (1 MB).
101 <term>-m <replaceable>filename</replaceable></term>
103 If specified, retrieved records will be appended to the file given.
107 <term>-p <replaceable>addr</replaceable></term>
109 If specified, the client will use the proxy at the address
114 <term>-q <replaceable>filename</replaceable></term>
116 If specified, CQL configuration will be read from
121 <term>-u <replaceable>auth</replaceable></term>
123 If specified, the <replaceable>auth</replaceable> string
124 will be used for authentication.
136 Makes the YAZ client print hex dumps of packages sent and received
143 <title>COMMANDS</title>
145 The YAZ client accepts the following commands.
147 &yaz-client-commands;
149 <refsect1><title>FILES</title>
151 <filename>yaz-<version>/client/client.c</filename>
154 <filename>.yazclientrc</filename>
157 <filename>$HOME/.yazclientrc</filename>
160 <refsect1><title>SEE ALSO</title>
163 <refentrytitle>yaz</refentrytitle>
164 <manvolnum>7</manvolnum>
168 Section "The YAZ Client" in the YAZ manual.
171 Section "Prefix Query Format" in the YAZ manual.
174 Section "Common Command Language" in the YAZ manual.
177 Section "Common Query Language" in the YAZ manual.
182 <!-- Keep this comment at the end of the file
187 sgml-minimize-attributes:nil
188 sgml-always-quote-attributes:t
191 sgml-parent-document:nil
192 sgml-local-catalogs: nil
193 sgml-namecase-general:t