1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/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>
15 <info><orgname>Index Data</orgname></info>
19 <refentrytitle>zoomsh</refentrytitle>
20 <manvolnum>1</manvolnum>
21 <refmiscinfo class="manual">Commands</refmiscinfo>
25 <refname>zoomsh</refname>
26 <refpurpose>ZOOM shell</refpurpose>
31 <command>zoomsh</command>
32 <arg choice="opt"><option>-e</option></arg>
33 <arg choice="opt"><option>-v <replaceable>loglevel</replaceable></option></arg>
34 <arg choice="opt" rep="repeat">commands</arg>
38 <refsect1><title>DESCRIPTION</title>
40 <command>zoomsh</command> is a ZOOM client with a simple
41 command line interface. The client demonstrates the ZOOM
42 API and is useful for testing targets.
45 You may pass one or more commands to <command>zoomsh</command>.
46 These commands are invoked first.
51 <title>OPTIONS</title>
56 Makes zoomsh stop processing commands as soon as an error occur.
57 The exit code of zoomsh is 1 if error occurs; 0 otherwise.
61 <term>-v <replaceable>loglevel</replaceable></term>
68 <refsect1><title>EXAMPLES</title>
70 If you start the <command>yaz-ztest</command> in one console you
71 can use the ZOOM shell as follows:
74 ZOOM>connect localhost:9999
76 localhost:9999: 7 hits
82 008 910710c19910701nju 00010 eng
86 100 10 $a Jack Collins
87 245 10 $a How to program a computer
96 You can also achieve the same result by passing the commands
97 as arguments on a single command line:
100 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
101 <literal>"show 0 1" quit</literal>
104 <refsect1><title>COMMANDS</title>
107 <varlistentry><term><literal>connect</literal>
108 <replaceable>zurl</replaceable></term>
110 Connects to the target given by <replaceable>zurl</replaceable>.
111 </para></listitem></varlistentry>
113 <varlistentry><term><literal>close</literal>
114 [<replaceable>zurl</replaceable>]</term>
116 Closes connection to target given by
117 <replaceable>zurl</replaceable> or all targets if
118 <replaceable>zurl</replaceable> was omitted.
119 </para></listitem></varlistentry>
121 <varlistentry><term><literal>show</literal>
122 [<replaceable>start</replaceable>
123 [<replaceable>count</replaceable>]]
126 Displays <literal>count</literal> records starting at offset given
127 by <replaceable>start</replaceable>. First records has offset 0
128 (unlike the Z39.50 protocol).
129 </para></listitem></varlistentry>
131 <varlistentry><term><literal>quit</literal>
134 Quits <command>zoomsh</command>.
135 </para></listitem></varlistentry>
137 <varlistentry><term><literal>set</literal>
138 <replaceable>name</replaceable>
139 [<replaceable>value</replaceable>]
142 Sets option <replaceable>name</replaceable> to
143 <replaceable>value</replaceable>.
144 </para></listitem></varlistentry>
146 <varlistentry><term><literal>get</literal>
147 <replaceable>name</replaceable>
150 Prints value of option <replaceable>name</replaceable>.
151 </para></listitem></varlistentry>
153 <varlistentry><term><literal>help</literal>
156 Prints list of available commands.
157 </para></listitem></varlistentry>
162 <refsect1><title>SEE ALSO</title>
165 <refentrytitle>yaz</refentrytitle>
166 <manvolnum>7</manvolnum>
169 <refentrytitle>yaz-ztest</refentrytitle>
170 <manvolnum>8</manvolnum>
174 Section "Building clients with ZOOM" in the YAZ manual.
177 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
182 <!-- Keep this comment at the end of the file
187 sgml-minimize-attributes:nil
188 sgml-always-quote-attributes:t
191 sgml-parent-document:nil
192 sgml-local-catalogs: nil
193 sgml-namecase-general:t