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 % common SYSTEM "common/common.ent">
11 <!-- $Id: yaz-client-man.xml,v 1.12 2006-08-28 19:18:02 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>-k <replaceable>size</replaceable></option></arg>
36 <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
37 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
38 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
39 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
40 <arg choice="opt"><option>-xV</option></arg>
41 <arg choice="opt">addr</arg>
46 <refsect1><title>DESCRIPTION</title>
48 <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
49 simple command line interface that allows you to test behavior and
50 performance of Z39.50 targets and SRU servers.
53 If the <replaceable>addr</replaceable> is specified, the client creates
54 a connection to the Z39.50/SRU target at the address given.
57 When <command>yaz-client</command> is invoked it attemps to read the
59 <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
60 <literal>.yazclientrc</literal> (current directory - any platform)
61 For those files that are readable, the YAZ client executes commands
62 in those files. See COMMANDS section for description of commands.
66 <title>OPTIONS</title>
69 <term>-a <replaceable>filename</replaceable></term>
71 If specified, logging of protocol packages will be appended
72 file given. If <replaceable>filename</replaceable> is
73 specified as <literal>-</literal>, the output is written
74 to <literal>stdout</literal>.
78 <term>-b <replaceable>filename</replaceable></term>
80 If specified, YAZ will dump BER data in readable notation
81 to the file specified. If <replaceable>filename</replaceable>
82 is specified as <literal>-</literal> the output is written
83 to <literal>stdout</literal>.
87 <term>-c <replaceable>filename</replaceable></term>
89 If specified, CCL configuration will be read from
94 <term>-d <replaceable>dump</replaceable></term>
96 If specified, YAZ will dump BER data for all PDUs sent and received
97 to individual files, named
98 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
99 where DDD is 001, 002, 003, ..
103 <term>-k <replaceable>size</replaceable></term>
105 Sets preferred messages and maximum record size for Initialize
106 Request in kilobytes. Default value is 1024 (1 MB).
110 <term>-m <replaceable>filename</replaceable></term>
112 If specified, retrieved records will be appended to the file given.
116 <term>-p <replaceable>addr</replaceable></term>
118 If specified, the client will use the proxy at the address
123 <term>-q <replaceable>filename</replaceable></term>
125 If specified, CQL configuration will be read from
130 <term>-u <replaceable>auth</replaceable></term>
132 If specified, the <replaceable>auth</replaceable> string
133 will be used for authentication.
145 Makes the YAZ client print hex dumps of packages sent and received
152 <title>COMMANDS</title>
154 The YAZ client accepts the following commands.
156 &yaz-client-commands;
158 <refsect1><title>FILES</title>
160 <filename>yaz-<version>/client/client.c</filename>
163 <filename>.yazclientrc</filename>
166 <filename>$HOME/.yazclientrc</filename>
169 <refsect1><title>SEE ALSO</title>
172 <refentrytitle>yaz</refentrytitle>
173 <manvolnum>7</manvolnum>
177 Section "The YAZ Client" in the YAZ manual.
180 Section "Prefix Query Format" in the YAZ manual.
183 Section "Common Command Language" in the YAZ manual.
186 Section "Common Query Language" in the YAZ manual.
191 <!-- Keep this comment at the end of the file
196 sgml-minimize-attributes:nil
197 sgml-always-quote-attributes:t
200 sgml-parent-document:nil
201 sgml-local-catalogs: nil
202 sgml-namecase-general:t