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 % idcommon SYSTEM "common/common.ent">
11 <!-- $Id: yaz-client-man.xml,v 1.15 2007-06-03 08:06:32 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
58 <filename>.yazclientrc</filename> from current working directory.
59 If <filename>.yazclientrc</filename> does not exist in current directory
60 YAZ client reads <filename>.yazclientrc</filename> from the
61 home directory, where the home directory is given by environment
62 variable <literal>HOME</literal>.
63 For those files that are readable, the YAZ client executes commands
64 in those files. See COMMANDS section for description of commands.
68 <title>OPTIONS</title>
71 <term>-a <replaceable>filename</replaceable></term>
73 If specified, logging of protocol packages will be appended
74 file given. If <replaceable>filename</replaceable> is
75 specified as <literal>-</literal>, the output is written
76 to <literal>stdout</literal>.
80 <term>-b <replaceable>filename</replaceable></term>
82 If specified, YAZ will dump BER data in readable notation
83 to the file specified. If <replaceable>filename</replaceable>
84 is specified as <literal>-</literal> the output is written
85 to <literal>stdout</literal>.
89 <term>-c <replaceable>filename</replaceable></term>
91 If specified, CCL configuration will be read from
96 <term>-d <replaceable>dump</replaceable></term>
98 If specified, YAZ will dump BER data for all PDUs sent and received
99 to individual files, named
100 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
101 where DDD is 001, 002, 003, ..
105 <term>-k <replaceable>size</replaceable></term>
107 Sets preferred messages and maximum record size for Initialize
108 Request in kilobytes. Default value is 1024 (1 MB).
112 <term>-m <replaceable>filename</replaceable></term>
114 If specified, retrieved records will be appended to the file given.
118 <term>-p <replaceable>addr</replaceable></term>
120 If specified, the client will use the proxy at the address
125 <term>-q <replaceable>filename</replaceable></term>
127 If specified, CQL configuration will be read from
132 <term>-u <replaceable>auth</replaceable></term>
134 If specified, the <replaceable>auth</replaceable> string
135 will be used for authentication.
147 Makes the YAZ client print hex dumps of packages sent and received
154 <title>COMMANDS</title>
156 The YAZ client accepts the following commands.
158 &yaz-client-commands;
160 <refsect1><title>FILES</title>
162 <filename>yaz-<version>/client/client.c</filename>
165 <filename>$HOME/.yazclientrc</filename>
168 <filename>$HOME/.yazclient.history</filename>
171 <refsect1><title>SEE ALSO</title>
174 <refentrytitle>yaz</refentrytitle>
175 <manvolnum>7</manvolnum>
179 Section "The YAZ Client" in the YAZ manual.
182 Section "Prefix Query Format" in the YAZ manual.
185 Section "Common Command Language" in the YAZ manual.
188 Section "Common Query Language" in the YAZ manual.
193 <!-- Keep this comment at the end of the file
198 sgml-minimize-attributes:nil
199 sgml-always-quote-attributes:t
202 sgml-parent-document:nil
203 sgml-local-catalogs: nil
204 sgml-namecase-general:t