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 <refentry id="zoomsh">
13 <productname>YAZ</productname>
14 <productnumber>&version;</productnumber>
18 <refentrytitle>zoomsh</refentrytitle>
19 <manvolnum>1</manvolnum>
23 <refname>zoomsh</refname>
24 <refpurpose>ZOOM shell</refpurpose>
29 <command>zoomsh</command>
30 <arg choice="opt" rep="repeat">commands</arg>
34 <refsect1><title>DESCRIPTION</title>
36 <command>zoomsh</command> is a ZOOM client with a simple
37 command line interface. The client demonstrates the ZOOM
38 API and is useful for testing targets.
41 You may pass one or more commands to <command>zoomsh</command>.
42 These commands are invoked first.
45 <refsect1><title>EXAMPLES</title>
47 If you start the <command>yaz-ztest</command> in one console you
48 can use the ZOOM shell as follows:
51 ZOOM>connect localhost:9999
53 localhost:9999: 7 hits
59 008 910710c19910701nju 00010 eng
63 100 10 $a Jack Collins
64 245 10 $a How to program a computer
73 You can also achieve the same result by passing the commands
74 as arguments on a single command line:
77 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
78 <literal>"show 0 1" quit</literal>
81 <refsect1><title>COMMANDS</title>
84 <varlistentry><term><literal>connect</literal>
85 <replaceable>zurl</replaceable></term>
87 Connects to the target given by <replaceable>zurl</replaceable>.
88 </para></listitem></varlistentry>
90 <varlistentry><term><literal>close</literal>
91 [<replaceable>zurl</replaceable>]</term>
93 Closes connection to target given by
94 <replaceable>zurl</replaceable> or all targets if
95 <replaceable>zurl</replaceable> was omitted.
96 </para></listitem></varlistentry>
98 <varlistentry><term><literal>show</literal>
99 [<replaceable>start</replaceable>
100 [<replaceable>count</replaceable>]]
103 Displays <literal>count</literal> records starting at offset given
104 by <replaceable>start</replaceable>. First records has offset 0
105 (unlike the Z39.50 protocol).
106 </para></listitem></varlistentry>
108 <varlistentry><term><literal>quit</literal>
111 Quits <command>zoomsh</command>.
112 </para></listitem></varlistentry>
114 <varlistentry><term><literal>set</literal>
115 <replaceable>name</replaceable>
116 [<replaceable>value</replaceable>]
119 Sets option <replaceable>name</replaceable> to
120 <replaceable>value</replaceable>.
121 </para></listitem></varlistentry>
123 <varlistentry><term><literal>get</literal>
124 <replaceable>name</replaceable>
127 Prints value of option <replaceable>name</replaceable>.
128 </para></listitem></varlistentry>
130 <varlistentry><term><literal>help</literal>
133 Prints list of available commands.
134 </para></listitem></varlistentry>
139 <refsect1><title>SEE ALSO</title>
142 <refentrytitle>yaz</refentrytitle>
143 <manvolnum>7</manvolnum>
146 <refentrytitle>yaz-ztest</refentrytitle>
147 <manvolnum>8</manvolnum>
151 Section "Building clients with ZOOM" in the YAZ manual.
154 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
159 <!-- Keep this comment at the end of the file
164 sgml-minimize-attributes:nil
165 sgml-always-quote-attributes:t
168 sgml-parent-document:nil
169 sgml-local-catalogs: nil
170 sgml-namecase-general:t