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.11 2006-06-13 16:01:51 adam Exp $ -->
12 <refentry id="yaz-client">
15 <refentrytitle>yaz-client</refentrytitle>
16 <manvolnum>1</manvolnum>
20 <refname>yaz-client</refname>
21 <refpurpose>Z39.50/SRU client for implementors</refpurpose>
26 <command>yaz-client</command>
27 <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
28 <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
29 <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
30 <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
31 <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
32 <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
33 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
34 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
35 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
36 <arg choice="opt"><option>-xV</option></arg>
37 <arg choice="opt">addr</arg>
42 <refsect1><title>DESCRIPTION</title>
44 <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
45 simple command line interface that allows you to test behavior and
46 performance of Z39.50 targets and SRU servers.
49 If the <replaceable>addr</replaceable> is specified, the client creates
50 a connection to the Z39.50/SRU target at the address given.
53 When <command>yaz-client</command> is invoked it attemps to read the
55 <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
56 <literal>.yazclientrc</literal> (current directory - any platform)
57 For those files that are readable, the YAZ client executes commands
58 in those files. See COMMANDS section for description of commands.
62 <title>OPTIONS</title>
65 <term>-a <replaceable>filename</replaceable></term>
67 If specified, logging of protocol packages will be appended
68 file given. If <replaceable>filename</replaceable> is
69 specified as <literal>-</literal>, the output is written
70 to <literal>stdout</literal>.
74 <term>-b <replaceable>filename</replaceable></term>
76 If specified, YAZ will dump BER data in readable notation
77 to the file specified. If <replaceable>filename</replaceable>
78 is specified as <literal>-</literal> the output is written
79 to <literal>stdout</literal>.
83 <term>-c <replaceable>filename</replaceable></term>
85 If specified, CCL configuration will be read from
90 <term>-d <replaceable>dump</replaceable></term>
92 If specified, YAZ will dump BER data for all PDUs sent and received
93 to individual files, named
94 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
95 where DDD is 001, 002, 003, ..
99 <term>-k <replaceable>size</replaceable></term>
101 Sets preferred messages and maximum record size for Initialize
102 Request in kilobytes. Default value is 1024 (1 MB).
106 <term>-m <replaceable>filename</replaceable></term>
108 If specified, retrieved records will be appended to the file given.
112 <term>-p <replaceable>addr</replaceable></term>
114 If specified, the client will use the proxy at the address
119 <term>-q <replaceable>filename</replaceable></term>
121 If specified, CQL configuration will be read from
126 <term>-u <replaceable>auth</replaceable></term>
128 If specified, the <replaceable>auth</replaceable> string
129 will be used for authentication.
141 Makes the YAZ client print hex dumps of packages sent and received
148 <title>COMMANDS</title>
150 The YAZ client accepts the following commands.
152 &yaz-client-commands;
154 <refsect1><title>FILES</title>
156 <filename>yaz-<version>/client/client.c</filename>
159 <filename>.yazclientrc</filename>
162 <filename>$HOME/.yazclientrc</filename>
165 <refsect1><title>SEE ALSO</title>
168 <refentrytitle>yaz</refentrytitle>
169 <manvolnum>7</manvolnum>
173 Section "The YAZ Client" in the YAZ manual.
176 Section "Prefix Query Format" in the YAZ manual.
179 Section "Common Command Language" in the YAZ manual.
182 Section "Common Query Language" in the YAZ manual.
187 <!-- Keep this comment at the end of the file
192 sgml-minimize-attributes:nil
193 sgml-always-quote-attributes:t
196 sgml-parent-document:nil
197 sgml-local-catalogs: nil
198 sgml-namecase-general:t