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.4 2004-12-09 09:27:51 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>-m <replaceable>filename</replaceable></option></arg>
21 <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
22 <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
23 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
24 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
25 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
26 <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
27 <arg choice="opt"><option>-x</option></arg>
28 <arg choice="opt">addr</arg>
33 <refsect1><title>DESCRIPTION</title>
35 <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
36 simple command line interface that allows you to test behavior and
37 performance of Z39.50 targets and SRW servers.
40 If the <replaceable>addr</replaceable> is specified, the client creates
41 a connection to the Z39.50/SRW target at the address given.
44 When <command>yaz-client</command> is invoked it attemps to read the
46 <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
47 <literal>.yazclientrc</literal> (current directory - any platform)
48 For those files that are readable, the YAZ client executes commands
49 in those files. See COMMANDS section for description of commands.
53 <title>OPTIONS</title>
56 <term>-m <replaceable>filename</replaceable></term>
58 If specified, retrieved records will be appended to the file given.
62 <term>-a <replaceable>filename</replaceable></term>
64 If specified, logging of protocol packages will be appended
65 file given. The special filename <literal>-</literal>
66 (dash) denotes standard output.
70 <term>-u <replaceable>auth</replaceable></term>
72 If specified, the <replaceable>auth</replaceable> string
73 will be used for authentication.
77 <term>-c <replaceable>filename</replaceable></term>
79 If specified, CCL configuration will be read from
84 <term>-q <replaceable>filename</replaceable></term>
86 If specified, CQL configuration will be read from
92 <term>-p <replaceable>addr</replaceable></term>
94 If specified, the client will use the proxy at the address
100 <term>-k <replaceable>size</replaceable></term>
102 Sets preferred messages and maximum record size for Initialize
103 Request in kilobytes. Default value is 1024 (1 MB).
110 Makes the YAZ client print hex dumps of packages sent and received
117 <title>COMMANDS</title>
119 The YAZ client accepts the following commands.
121 &yaz-client-commands;
123 <refsect1><title>FILES</title>
125 <filename>yaz-<version>/client/client.c</filename>
128 <filename>.yazclientrc</filename>
131 <filename>$HOME/.yazclientrc</filename>
134 <refsect1><title>SEE ALSO</title>
137 <refentrytitle>yaz</refentrytitle>
138 <manvolnum>7</manvolnum>
142 Section "The YAZ Client" in the YAZ manual.
145 Section "Prefix Query Format" in the YAZ manual.
148 Section "Common Command Language" in the YAZ manual.
151 Section "Common Query Language" in the YAZ manual.
156 <!-- Keep this comment at the end of the file
161 sgml-minimize-attributes:nil
162 sgml-always-quote-attributes:t
165 sgml-parent-document:nil
166 sgml-local-catalogs: nil
167 sgml-namecase-general:t