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" rep="repeat">commands</arg>
36 <refsect1><title>DESCRIPTION</title>
38 <command>zoomsh</command> is a ZOOM client with a simple
39 command line interface. The client demonstrates the ZOOM
40 API and is useful for testing targets.
43 You may pass one or more commands to <command>zoomsh</command>.
44 These commands are invoked first.
47 <refsect1><title>EXAMPLES</title>
49 If you start the <command>yaz-ztest</command> in one console you
50 can use the ZOOM shell as follows:
53 ZOOM>connect localhost:9999
55 localhost:9999: 7 hits
61 008 910710c19910701nju 00010 eng
65 100 10 $a Jack Collins
66 245 10 $a How to program a computer
75 You can also achieve the same result by passing the commands
76 as arguments on a single command line:
79 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
80 <literal>"show 0 1" quit</literal>
83 <refsect1><title>COMMANDS</title>
86 <varlistentry><term><literal>connect</literal>
87 <replaceable>zurl</replaceable></term>
89 Connects to the target given by <replaceable>zurl</replaceable>.
90 </para></listitem></varlistentry>
92 <varlistentry><term><literal>close</literal>
93 [<replaceable>zurl</replaceable>]</term>
95 Closes connection to target given by
96 <replaceable>zurl</replaceable> or all targets if
97 <replaceable>zurl</replaceable> was omitted.
98 </para></listitem></varlistentry>
100 <varlistentry><term><literal>show</literal>
101 [<replaceable>start</replaceable>
102 [<replaceable>count</replaceable>]]
105 Displays <literal>count</literal> records starting at offset given
106 by <replaceable>start</replaceable>. First records has offset 0
107 (unlike the Z39.50 protocol).
108 </para></listitem></varlistentry>
110 <varlistentry><term><literal>quit</literal>
113 Quits <command>zoomsh</command>.
114 </para></listitem></varlistentry>
116 <varlistentry><term><literal>set</literal>
117 <replaceable>name</replaceable>
118 [<replaceable>value</replaceable>]
121 Sets option <replaceable>name</replaceable> to
122 <replaceable>value</replaceable>.
123 </para></listitem></varlistentry>
125 <varlistentry><term><literal>get</literal>
126 <replaceable>name</replaceable>
129 Prints value of option <replaceable>name</replaceable>.
130 </para></listitem></varlistentry>
132 <varlistentry><term><literal>help</literal>
135 Prints list of available commands.
136 </para></listitem></varlistentry>
141 <refsect1><title>SEE ALSO</title>
144 <refentrytitle>yaz</refentrytitle>
145 <manvolnum>7</manvolnum>
148 <refentrytitle>yaz-ztest</refentrytitle>
149 <manvolnum>8</manvolnum>
153 Section "Building clients with ZOOM" in the YAZ manual.
156 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
161 <!-- Keep this comment at the end of the file
166 sgml-minimize-attributes:nil
167 sgml-always-quote-attributes:t
170 sgml-parent-document:nil
171 sgml-local-catalogs: nil
172 sgml-namecase-general:t