1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2 <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
4 <!-- $Id: yaz-client-man.xml,v 1.5 2005-06-21 07:34:26 adam Exp $ -->
5 <refentry id="yaz-client">
8 <refentrytitle>yaz-client</refentrytitle>
9 <manvolnum>1</manvolnum>
13 <refname>yaz-client</refname>
14 <refpurpose>Z39.50/SRW client for implementors</refpurpose>
19 <command>yaz-client</command>
20 <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
21 <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
22 <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
23 <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
24 <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
25 <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
26 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
27 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
28 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
29 <arg choice="opt"><option>-xV</option></arg>
30 <arg choice="opt">addr</arg>
35 <refsect1><title>DESCRIPTION</title>
37 <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
38 simple command line interface that allows you to test behavior and
39 performance of Z39.50 targets and SRW servers.
42 If the <replaceable>addr</replaceable> is specified, the client creates
43 a connection to the Z39.50/SRW target at the address given.
46 When <command>yaz-client</command> is invoked it attemps to read the
48 <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
49 <literal>.yazclientrc</literal> (current directory - any platform)
50 For those files that are readable, the YAZ client executes commands
51 in those files. See COMMANDS section for description of commands.
55 <title>OPTIONS</title>
58 <term>-a <replaceable>filename</replaceable></term>
60 If specified, logging of protocol packages will be appended
61 file given. If <replaceable>filename</replaceable> is
62 specified as <literal>-</literal>, the output is written
63 to <literal>stdout</literal>.
67 <term>-b <replaceable>filename</replaceable></term>
69 If specified, YAZ will dump BER data in readable notation
70 to the file specified. If <replaceable>filename</replaceable>
71 is specified as <literal>-</literal> the output is written
72 to <literal>stdout</literal>.
76 <term>-c <replaceable>filename</replaceable></term>
78 If specified, CCL configuration will be read from
83 <term>-d <replaceable>dump</replaceable></term>
85 If specified, YAZ will dump BER data for all PDUs sent and received
86 to individual files, named
87 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
88 where DDD is 001, 002, 003, ..
92 <term>-k <replaceable>size</replaceable></term>
94 Sets preferred messages and maximum record size for Initialize
95 Request in kilobytes. Default value is 1024 (1 MB).
99 <term>-m <replaceable>filename</replaceable></term>
101 If specified, retrieved records will be appended to the file given.
105 <term>-p <replaceable>addr</replaceable></term>
107 If specified, the client will use the proxy at the address
112 <term>-q <replaceable>filename</replaceable></term>
114 If specified, CQL configuration will be read from
119 <term>-u <replaceable>auth</replaceable></term>
121 If specified, the <replaceable>auth</replaceable> string
122 will be used for authentication.
134 Makes the YAZ client print hex dumps of packages sent and received
141 <title>COMMANDS</title>
143 The YAZ client accepts the following commands.
145 &yaz-client-commands;
147 <refsect1><title>FILES</title>
149 <filename>yaz-<version>/client/client.c</filename>
152 <filename>.yazclientrc</filename>
155 <filename>$HOME/.yazclientrc</filename>
158 <refsect1><title>SEE ALSO</title>
161 <refentrytitle>yaz</refentrytitle>
162 <manvolnum>7</manvolnum>
166 Section "The YAZ Client" in the YAZ manual.
169 Section "Prefix Query Format" in the YAZ manual.
172 Section "Common Command Language" in the YAZ manual.
175 Section "Common Query Language" in the YAZ manual.
180 <!-- Keep this comment at the end of the file
185 sgml-minimize-attributes:nil
186 sgml-always-quote-attributes:t
189 sgml-parent-document:nil
190 sgml-local-catalogs: nil
191 sgml-namecase-general:t