1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
3 <!ENTITY % common SYSTEM "common/common.ent">
4 <!-- $Id: yaz-client-man.xml,v 1.7 2006-04-24 12:41:00 marc Exp $ --><!-- Index Data software --><!ENTITY url.indexdata "http://www.indexdata.com/">
5 <!ENTITY url.yaz "http://www.indexdata.com/yaz/">
6 <!ENTITY url.yaz.download "http://ftp.indexdata.com/pub/yaz/">
7 <!ENTITY url.yaz.download.win32 "http://ftp.indexdata.com/pub/yaz/win32/">
8 <!ENTITY url.yaz.mailinglist "http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist">
9 <!ENTITY url.yaz.mail "mailto:yaz-help@indexdata.dk">
10 <!ENTITY url.yazplusplus "http://www.indexdata.com/yazplusplus/">
11 <!ENTITY url.yazproxy "http://www.indexdata.com/yazproxy/">
12 <!ENTITY url.idzebra "http://www.indexdata.com/zebra/">
13 <!ENTITY url.idzebra.mailinglist "http://lists.indexdata.dk/cgi-bin/mailman/listinfo/zebralist">
14 <!ENTITY url.metaproxy "http://www.indexdata.com/metaproxy/">
15 <!-- Specifications and Standards --><!ENTITY url.w3c "http://www.w3.org/">
16 <!ENTITY url.xml "http://www.w3.org/XML/">
17 <!ENTITY url.sru "http://www.loc.gov/standards/sru/">
18 <!ENTITY url.sru.diagnostics "http://www.loc.gov/standards/sru/diagnostics.html">
19 <!ENTITY url.sru.diagnostics.list "http://www.loc.gov/standards/sru/diagnostics-list.html">
20 <!ENTITY url.srw "http://www.loc.gov/standards/sru/srw/">
21 <!ENTITY url.soap "http://www.w3.org/TR/soap/">
22 <!ENTITY url.z39.50 "http://www.loc.gov/z3950/agency/">
23 <!ENTITY url.z39.50.doc "http://www.loc.gov/z3950/agency/markup/toc.html">
24 <!ENTITY url.z39.50.asn.1 "http://www.loc.gov/z3950/agency/asn1.html">
25 <!ENTITY url.z39.50.diagnostics "http://www.loc.gov/z3950/agency/defns/bib1diag.html">
26 <!ENTITY url.z39.50.attset.bib1 "http://www.loc.gov/z3950/agency/defns/bib1.html">
27 <!ENTITY url.z39.50.charneg "http://www.loc.gov/z3950/agency/defns/charneg-3.html">
28 <!ENTITY url.z39.50.proximity "http://www.loc.gov/z3950/agency/markup/09.html#3.7.2">
29 <!ENTITY url.z39.50.proximity.asn1 "http://www.loc.gov/z3950/agency/asn1.html#ProximityOperator">
30 <!ENTITY url.z39.50.oids "http://www.loc.gov/z3950/agency/defns/oids.html">
31 <!ENTITY url.asn.1.tutorial "http://asn1.elibel.tm.fr/en/introduction/">
32 <!ENTITY url.asn.1.standards "http://asn1.elibel.tm.fr/en/standards/">
33 <!ENTITY url.cql "http://www.loc.gov/standards/sru/cql/">
34 <!ENTITY url.cql.intro "http://zing.z3950.org/cql/intro.html">
35 <!ENTITY url.xcql "http://www.loc.gov/standards/sru/xml-files/srw-types.xsd">
36 <!ENTITY url.zoom "http://zoom.z3950.org/">
37 <!ENTITY url.marc21 "http://www.loc.gov/marc/">
38 <!ENTITY url.marc8 "http://www.loc.gov/marc/specifications/speccharmarc8.html">
39 <!ENTITY url.marcxml "http://www.loc.gov/standards/marcxml/">
40 <!ENTITY url.ill "http://www.nlc-bnc.ca/iso/ill/">
41 <!ENTITY url.ber.over.tcpip "http://www.faqs.org/rfcs/rfc1729.html">
42 <!ENTITY url.http "http://www.w3.org/Protocols/">
43 <!ENTITY url.http.1.1 "http://www.w3.org/Protocols/rfc2616/rfc2616.html">
44 <!-- External libraries + tools --><!ENTITY url.apache "http://httpd.apache.org/">
45 <!ENTITY url.apache.directive.proxypass "http://httpd.apache.org/docs/mod/mod_proxy.html#proxypass">
46 <!ENTITY url.bison "http://www.gnu.org/software/bison/">
47 <!ENTITY url.libxml2 "http://xmlsoft.org/">
48 <!ENTITY url.libxml2.api "http://www.xmlsoft.org/html/index.html">
49 <!ENTITY url.libxml2.api.tree "http://www.xmlsoft.org/html/libxml-tree.html">
50 <!ENTITY url.libxslt "http://xmlsoft.org/XSLT/">
51 <!ENTITY url.libxml2.download.win32 "http://www.zlatkovic.com/libxml.en.html">
52 <!ENTITY url.autoconf "http://www.gnu.org/software/autoconf/">
53 <!ENTITY url.automake "http://www.gnu.org/software/automake/">
54 <!ENTITY url.libtool "http://www.gnu.org/software/libtool/">
55 <!ENTITY url.libiconv "http://www.gnu.org/software/libiconv/">
56 <!ENTITY url.tcl "http://www.tcl.tk/">
57 <!ENTITY url.perl "http://www.perl.com/">
58 <!ENTITY url.gcc "http://gcc.gnu.org/">
59 <!ENTITY url.vstudio "http://msdn.microsoft.com/vstudio/">
60 <!ENTITY url.boost "http://www.boost.org/">
61 <!ENTITY url.boost.compilers.status "http://www.boost.org/status/compiler_status.html">
62 <!ENTITY url.openssl "http://www.openssl.org/">
63 <!ENTITY url.unxutils "http://unxutils.sourceforge.net/">
64 <!ENTITY url.tcpwrapper "ftp://ftp.porcupine.org/pub/security/index.html">
65 <!-- Operating Systems --><!ENTITY url.linux.kernel "http://www.kernel.org/">
66 <!ENTITY url.debian "http://www.debian.org/">
67 <!ENTITY url.redhat "http://www.redhat.com/">
68 <!ENTITY url.gentoo "http://www.gentoo.org/">
69 <!ENTITY url.freebsd "http://www.freebsd.org/">
70 <!ENTITY url.macosx "http://www.apple.com/macosx/">
71 <!ENTITY url.solaris "http://www.sun.com/software/solaris/">
72 <!ENTITY url.windows2000 "http://www.microsoft.com/windows2000/">
73 <!ENTITY url.windows2003server "http://www.microsoft.com/windowsserver2003/default.mspx">
74 <!ENTITY url.netbsd "http://www.netbsd.org/">
75 <!ENTITY url.openbsd "http://www.openbsd.org/">
76 <!ENTITY url.ubunto "http://www.ubuntu.com/">
77 <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
79 <!-- $Id: yaz-client-man.xml,v 1.7 2006-04-24 12:41:00 marc Exp $ -->
80 <refentry id="yaz-client">
83 <refentrytitle>yaz-client</refentrytitle>
84 <manvolnum>1</manvolnum>
88 <refname>yaz-client</refname>
89 <refpurpose>Z39.50/SRW client for implementors</refpurpose>
94 <command>yaz-client</command>
95 <arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
96 <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
97 <arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
98 <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
99 <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
100 <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
101 <arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
102 <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
103 <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
104 <arg choice="opt"><option>-xV</option></arg>
105 <arg choice="opt">addr</arg>
110 <refsect1><title>DESCRIPTION</title>
112 <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
113 simple command line interface that allows you to test behavior and
114 performance of Z39.50 targets and SRW servers.
117 If the <replaceable>addr</replaceable> is specified, the client creates
118 a connection to the Z39.50/SRW target at the address given.
121 When <command>yaz-client</command> is invoked it attemps to read the
123 <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
124 <literal>.yazclientrc</literal> (current directory - any platform)
125 For those files that are readable, the YAZ client executes commands
126 in those files. See COMMANDS section for description of commands.
130 <title>OPTIONS</title>
133 <term>-a <replaceable>filename</replaceable></term>
135 If specified, logging of protocol packages will be appended
136 file given. If <replaceable>filename</replaceable> is
137 specified as <literal>-</literal>, the output is written
138 to <literal>stdout</literal>.
142 <term>-b <replaceable>filename</replaceable></term>
144 If specified, YAZ will dump BER data in readable notation
145 to the file specified. If <replaceable>filename</replaceable>
146 is specified as <literal>-</literal> the output is written
147 to <literal>stdout</literal>.
151 <term>-c <replaceable>filename</replaceable></term>
153 If specified, CCL configuration will be read from
158 <term>-d <replaceable>dump</replaceable></term>
160 If specified, YAZ will dump BER data for all PDUs sent and received
161 to individual files, named
162 <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
163 where DDD is 001, 002, 003, ..
167 <term>-k <replaceable>size</replaceable></term>
169 Sets preferred messages and maximum record size for Initialize
170 Request in kilobytes. Default value is 1024 (1 MB).
174 <term>-m <replaceable>filename</replaceable></term>
176 If specified, retrieved records will be appended to the file given.
180 <term>-p <replaceable>addr</replaceable></term>
182 If specified, the client will use the proxy at the address
187 <term>-q <replaceable>filename</replaceable></term>
189 If specified, CQL configuration will be read from
194 <term>-u <replaceable>auth</replaceable></term>
196 If specified, the <replaceable>auth</replaceable> string
197 will be used for authentication.
209 Makes the YAZ client print hex dumps of packages sent and received
216 <title>COMMANDS</title>
218 The YAZ client accepts the following commands.
222 $Id: yaz-client-man.xml,v 1.7 2006-04-24 12:41:00 marc Exp $
223 Commands for YAZ client.
224 Included in both manual and man page for yaz-client.
227 <varlistentry id="command-open"><term>
228 <literal>open </literal><replaceable>zurl</replaceable>
231 <para>Opens a connection to a server. The syntax for
232 <replaceable>zurl</replaceable> is the same as described
233 above for connecting from the command line.
239 [<literal>(tcp|ssl|unix|http)':'</literal>]<replaceable>host</replaceable>
240 [:<replaceable>port</replaceable>][/<replaceable>base</replaceable>]
245 <literal>quit</literal>
248 <para>Quits YAZ client</para>
251 <varlistentry id="command-find"><term>
252 <literal>find </literal><replaceable>query</replaceable></term>
254 <para>Sends a Search Request using the <replaceable>query</replaceable>
255 given. By default the query is assumed to be PQF. See command
256 <link linkend="command-querytype"><literal>querytype</literal></link>.
261 <literal>delete</literal> <replaceable>setname</replaceable></term>
263 <para>Deletes result set with name <replaceable>setname</replaceable>
264 on the server.</para>
268 <literal>base </literal><replaceable>base1</replaceable>
269 <replaceable>base2</replaceable> ...
272 <para>Sets the name(s) of the database(s) to search. One or more
273 databases may be specified separated by blanks. This commands overrides
274 the database given in <replaceable>zurl</replaceable>.
279 <literal>show </literal>
280 [<replaceable>start</replaceable>[+<replaceable>number</replaceable>]]
283 <para>Fetches records by sending a Present Request from the start
285 <replaceable>start</replaceable>
286 a number of records given by <replaceable>number</replaceable>. If
287 <replaceable>start</replaceable> is not given, then the client
288 will fetch from position of the last retrieved record plus 1. If
289 <replaceable>number</replaceable> is not given, then one record will
290 be fetched at a time.
295 <literal>scan</literal> <replaceable>term</replaceable>
299 database index for a term. The syntax resembles the syntax
300 for <link linkend="command-find"><literal>find</literal></link>.
301 If you want to scan for the word <literal>water</literal> you could
308 but if you want to scan only in, say the title field, you would write
316 <literal>scanpos</literal> <replaceable>pos</replaceable>
320 Sets preferred position for scan. This value
321 is used in next scan. By default position is 1.
326 <literal>scansize</literal> <replaceable>size</replaceable>
330 Sets number of entries to be returned by scan. Default
331 number of entries is 20.
336 <literal>scanstep</literal> <replaceable>step</replaceable>
340 Set step-size for scan. This value is used in next scan
341 sent to the target. By default step-size is 0.
345 <varlistentry id="sortspec"><term>
346 <literal>sort</literal> <replaceable>sortspecs</replaceable>
349 <para>Sorts a result set. The sort command takes a
350 sequence of space-separated sort specifications, with each sort
351 specification consisting of two space-separated words (so that the
352 whole specification list is made up of an even number of words).
353 The first word of each specification
354 holds a field (sort criterion) and the second holds flags.
355 If the sort criterion includes <literal>=</literal> it is assumed
356 that the <literal>SortKey</literal> is of type
357 <literal>sortAttributes</literal> using Bib-1: in this case
358 the integer before <literal>=</literal> is
359 the attribute type and the integer following <literal>=</literal>
360 is the attribute value.
361 If no <literal>=</literal> is in the criterion it is treated as a
362 sortfield of type InternationalString.
363 The flags word of each sort specification must consist of
365 for case sensitive or <literal>i</literal> for case insensitive, and
366 <literal><</literal> for ascending order or <literal>></literal>
367 for descending order.
372 <literal>sort+</literal>
375 <para>Same as <literal>sort</literal> but stores the sorted
376 result set in a new result set.
381 <literal>authentication</literal> <replaceable>openauth</replaceable>
384 <para>Sets up a authentication string if a server requires
385 authentication (v2 OpenStyle). The authentication string is first
386 sent to the server when the
387 <link linkend="command-open"><literal>open</literal></link> command is
388 issued and the Z39.50 Initialize Request is sent, so this command
389 must be used before <literal>open</literal> in order to be effective.
390 A common convention for the <replaceable>authopen</replaceable> string
391 is that the username - and password is separated by a slash, e.g.
392 <literal>myusername/mysecret</literal>.
398 <literal>list_all</literal>
401 <para>This command displays status and values for many settings.
407 <literal>lslb</literal> <replaceable>n</replaceable>
410 <para>Sets the limit for when no records should be returned
411 together with the search result.
413 <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
422 <literal>ssub</literal> <replaceable>n</replaceable>
425 <para>Sets the limit for when all records should be returned with
428 <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
430 </ulink> for more details.
436 <literal>mspn</literal> <replaceable>n</replaceable>
439 <para>Sets the number of records should be returned if the
440 number of records in the result set is between the values of
441 <literal>lslb</literal> and <literal>ssub</literal>.
443 <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
451 <literal>status</literal>
454 <para>Displays the values of <literal>lslb</literal>,
455 <literal>ssub</literal> and <literal>mspn</literal>.
460 <literal>setname</literal>
463 <para>Switches named result sets on and off. Default is on.
468 <literal>cancel</literal>
471 <para>Sends a Trigger Resource Control Request to the target.
476 <literal>format</literal> <replaceable>oid</replaceable>
479 <para>Sets the preferred transfer syntax for retrieved records.
480 yaz-client supports all the record syntaxes that currently
482 <ulink url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
485 for more details. Commonly used records syntaxes include usmarc,
491 <literal>elements</literal> <replaceable>e</replaceable>
494 <para>Sets the element set name for the records. Many targets support
495 element sets are B (for brief) and F (for full).
500 <literal>close</literal>
503 <para>Sends a Z39.50 Close APDU and closes connection with the peer
507 <varlistentry id="command-querytype"><term>
508 <literal>querytype</literal> <replaceable>type</replaceable>
511 <para>Sets the query type as used by command
512 <link linkend="command-find"><literal>find</literal></link>.
513 The following is supported:
514 <literal>prefix</literal> for
515 <link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
516 <literal>ccl</literal> for CCL search (Type-2 Query),
517 <literal>cql</literal> for CQL (Type-104 search with CQL OID),
518 <literal>ccl2rpn</literal> for
519 <link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
520 <literal>cql2rpn</literal> for
521 CQL to RPN conversion (Type-1 Query).
526 <literal>attributeset</literal> <replaceable>set</replaceable>
530 Sets attribute set OID for prefix queries (RPN, Type-1).
535 <literal>refid</literal> <replaceable>id</replaceable>
538 <para>Sets reference ID for Z39.50 Request(s).
543 <literal>itemorder</literal>
544 <replaceable>type</replaceable> <replaceable>no</replaceable>
547 <para>Sends an Item Order Request using the ILL External.
548 <replaceable>type</replaceable> is either 1 or 2 which corresponds to
549 ILL-Profile 1 and 2 respectively. The <replaceable>no</replaceable>
550 is the Result Set position of the record to be ordered.
555 <literal>update</literal>
556 <replaceable>action</replaceable>
557 <replaceable>recid</replaceable>
558 <replaceable>doc</replaceable>
561 <para>Sends Item Update Request. The <replaceable>action</replaceable>
562 argument must be the action type: one of <literal>insert</literal>,
563 <literal>replace</literal>, <literal>delete</literal> and
564 <literal>update</literal>. The second argument,
565 <replaceable>recid</replaceable>, is the
566 record identifier (any string). Third argument which is optional is
567 the record document for the request. If doc is a quoted string
568 (double quotes) the string content is used verbatim. If doc is not
569 a quoted string, it is assumed to be a filename which is read, then
570 sent as the docuemnt content. If doc is omitted, the last received
571 record (as parf of present response or piggybacked search response)
572 is used for the update.
579 <replaceable>filename</replaceable>
582 <para>Executes list of commands from
583 file <replaceable>filename</replaceable>, just like source on
591 <replaceable>args</replaceable>
594 <para>Executes command <replaceable>args</replaceable> in subshell
595 using the <literal>system</literal> call.
601 <literal>push_command</literal>
602 <replaceable>command</replaceable>
605 <para>The push_command takes another command as its argument.
606 That command is then added to the history information (so
607 you can retrieve it later). The command itself is not
608 executed. This command only works if you have GNU readline/history
615 <literal>set_apdufile</literal>
616 <replaceable>filename</replaceable>
619 <para>Sets that APDU should be logged to file
620 <replaceable>filename</replaceable>. Another way to achieve
621 APDU log is by using command-line option <literal>-a</literal>.
627 <literal>set_auto_reconnect</literal>
628 <replaceable>flag</replaceable>
631 <para>Specifies whether YAZ client automatically reconnect if
632 target closes connection (Z39.50 only).
635 <replaceable>flag</replaceable> must be either
636 <literal>on</literal> or <literal>off</literal>.
641 <varlistentry id="command-set-auto-wait"><term>
642 <literal>set_auto_wait</literal>
643 <replaceable>flag</replaceable>
646 <para>Specifies whether YAZ client should wait for
647 response protocol packages after a request.
648 By default YAZ client waits (on) for response packages immediately
649 after a command (find, show) has been issued. If <literal>off</literal>
650 is used, YAZ client does not attempt to receive packages automatically.
651 These will have to be manually received when command
652 <link linkend="command-wait-response">
653 <literal>wait_response</literal>
657 <replaceable>flag</replaceable> must be either
658 <literal>on</literal> or <literal>off</literal>.
664 <literal>set_marcdump</literal>
665 <replaceable>filename</replaceable>
668 <para>Specifies that all retrieved records should be appended to
669 file <replaceable>filename</replaceable>. This command does the
670 thing as option <literal>-m</literal>.
676 <literal>schema</literal>
677 <replaceable>schemaid</replaceable>
680 <para>Specifies schema for retrieval.
681 Schema may be specified as an OID for Z39.50.
682 For SRW, schema is a simple string URI.
687 <varlistentry id="command-charset"><term>
688 <literal>charset</literal>
689 <replaceable>negotiationcharset</replaceable>
690 [<replaceable>displaycharset</replaceable>]
691 [[<replaceable>marccharset</replaceable>]]
694 <para>Specifies character set (encoding) for Z39.50
695 negotiation / SRW encoding and/or character set for output (terminal).
698 <replaceable>negotiationcharset</replaceable> is the name
699 of the character set to be negotiated by the server. The special name
700 <literal>-</literal> for <replaceable>negotiationcharset</replaceable>
701 specifies <emphasis>no</emphasis> character set to be negotiated.
704 If <replaceable>displaycharset</replaceable> is given, it specifies name
705 of the character set of the output (on the terminal on which
706 YAZ client is running). To disable conversion of characters
707 to the output encoding, the special name <literal>-</literal> (dash)
709 If the special name <literal>auto</literal> is given, YAZ client will
710 convert strings to the encoding of the
711 terminal as returned by <function>nl_langinfo</function> call.
714 If <replaceable>marcharset</replaceable> is given, it specifies name
715 of the character set of retrieved MARC records from server. See
716 also <literal>marcharset</literal> command.
720 Since character set negotation takes effect in the Z39.50
721 Initialize Request you should issue this command before
722 command <link linkend="command-open"><literal>open</literal></link>
728 MARC records are not covered by Z39.50 character set negotiation,
729 so that's why there is a separate character that must be known
730 in order to do meaningful converson(s).
737 <literal>negcharset</literal>
738 <replaceable>charset</replaceable>
741 <para>Specifies character set for negotiation (Z39.50). The
742 argument is the same as second argument for command
743 <link linkend="command-charset"><literal>charset</literal></link>.
749 <literal>displaycharset</literal>
750 <replaceable>charset</replaceable>
753 <para>Specifies character set for output (display). The
754 argument is the same as second argument for command
755 <link linkend="command-charset"><literal>charset</literal></link>.
761 <literal>marccharset</literal>
762 <replaceable>charset</replaceable>
765 <para>Specifies character set for retrieved MARC records so
766 that YAZ client can display them in a character suitable
767 for your display. See <literal>charset</literal> command.
768 If <literal>auto</literal> is given, YAZ will assume
769 that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1
770 for all other MARC variants. The charset argument is the
771 same as third argument for command
772 <link linkend="command-charset"><literal>charset</literal></link>.
778 <literal>set_cclfile</literal>
779 <replaceable>filename</replaceable>
782 <para>Specifies that CCL fields should be read from file
783 file <replaceable>filename</replaceable>. This command does the
784 thing as option <literal>-c</literal>.
790 <literal>set_cqlfile</literal>
791 <replaceable>filename</replaceable>
794 <para>Specifies that CQL fields should be read from file
795 file <replaceable>filename</replaceable>. This command does the
796 thing as option <literal>-q</literal>.
802 <literal>register_oid</literal>
803 <replaceable>name</replaceable>
804 <replaceable>class</replaceable>
805 <replaceable>OID</replaceable>
808 <para>This command allows you to register your own object
809 identifier - so that instead of entering a long dot-notation
810 you can use a short name instead.
811 The <replaceable>name</replaceable> is your
812 name for the OID, <replaceable>class</replaceable> is the
813 class, and <replaceable>OID</replaceable> is the raw OID in
814 dot notation. Class is one <literal>appctx</literal>,
815 <literal>absyn</literal>, <literal>attet</literal>,
816 <literal>transyn</literal>, <literal>diagset</literal>,
817 <literal>recsyn</literal>, <literal>resform</literal>,
818 <literal>accform</literal>, <literal>extserv</literal>,
819 <literal>userinfo</literal>, <literal>elemspec</literal>,
820 <literal>varset</literal>, <literal>schema</literal>,
821 <literal>tagset</literal>, <literal>general</literal>.
822 If you're in doubt use the <literal>general</literal>
829 <literal>register_tab</literal>
830 <replaceable>command</replaceable>
831 <replaceable>string</replaceable>
834 <para>This command registers a TAB completion string for
841 <literal>sleep</literal>
842 <replaceable>seconds</replaceable>
845 <para>This command makes YAZ client sleep (be idle) for
846 the number of seconds given.
851 <varlistentry id="command-wait-response"><term>
852 <literal>wait_response</literal>
853 [ <replaceable>number</replaceable>]
856 <para>This command makes YAZ client wait for a number of
857 response packages from target. If <replaceable>number</replaceable> is
858 omitted, 1 is assumed.
860 <para>This command is rarely used and is only useful if command
861 <link linkend="command-set-auto-wait">
862 <literal>set_auto_wait</literal>
863 </link> is set to off.
868 <varlistentry id="command-xmles"><term>
869 <literal>xmles</literal>
870 <replaceable>OID</replaceable>
871 <replaceable>doc</replaceable>
874 <para>Sends XML Extended Services request using the OID and doc given.
880 <literal>zversion</literal>
881 <replaceable>ver</replaceable>
884 <para>This command sets Z39.50 version for negotiation.
885 Should be used before
886 <link linkend="command-open"><literal>open</literal></link>.
887 By default 3 (version 3) is used.
893 <literal>options</literal>
894 <replaceable>op1 op2..</replaceable>
897 <para>This command sets Z39.50 options for negotiation.
898 Should be used before
899 <link linkend="command-open"><literal>open</literal></link>.
902 The following options are supported:
903 <literal>search</literal>,
904 <literal>present</literal>,
905 <literal>delSet</literal>,
906 <literal>resourceReport</literal>,
907 <literal>triggerResourceCtrl</literal>,
908 <literal>resourceCtrl</literal>,
909 <literal>accessCtrl</literal>,
910 <literal>scan</literal>,
911 <literal>sort</literal>,
912 <literal>extendedServices</literal>,
913 <literal>level_1Segmentation</literal>,
914 <literal>level_2Segmentation</literal>,
915 <literal>concurrentOperations</literal>,
916 <literal>namedResultSets</literal>,
917 <literal>encapsulation</literal>,
918 <literal>resultCount</literal>,
919 <literal>negotiationModel</literal>,
920 <literal>duplicationDetection</literal>,
921 <literal>queryType104</literal>,
922 <literal>pQESCorrection</literal>,
923 <literal>stringSchema</literal>.
929 <!-- Keep this Emacs mode comment at the end of the file
937 <refsect1><title>FILES</title>
939 <filename>yaz-<version>/client/client.c</filename>
942 <filename>.yazclientrc</filename>
945 <filename>$HOME/.yazclientrc</filename>
948 <refsect1><title>SEE ALSO</title>
951 <refentrytitle>yaz</refentrytitle>
952 <manvolnum>7</manvolnum>
956 Section "The YAZ Client" in the YAZ manual.
959 Section "Prefix Query Format" in the YAZ manual.
962 Section "Common Command Language" in the YAZ manual.
965 Section "Common Query Language" in the YAZ manual.
969 <!-- Keep this Emacs mode comment at the end of the file