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: zoomsh-man.xml,v 1.5 2006-08-28 19:18:02 adam Exp $ -->
12 <refentry id="zoomsh">
14 <productname>YAZ</productname>
15 <productnumber>&version;</productnumber>
19 <refentrytitle>zoomsh</refentrytitle>
20 <manvolnum>1</manvolnum>
24 <refname>zoomsh</refname>
25 <refpurpose>ZOOM shell</refpurpose>
30 <command>zoomsh</command>
31 <arg choice="opt" rep="repeat">commands</arg>
35 <refsect1><title>DESCRIPTION</title>
37 <command>zoomsh</command> is a ZOOM client with a simple
38 command line interface. The client demonstrates the ZOOM
39 API and is useful for testing targets.
42 You may pass one or more commands to <command>zoomsh</command>.
43 These commands are invoked first.
46 <refsect1><title>EXAMPLES</title>
48 If you start the <command>yaz-ztest</command> in one console you
49 can use the ZOOM shell as follows:
52 ZOOM>connect localhost:9999
54 localhost:9999: 7 hits
60 008 910710c19910701nju 00010 eng
64 100 10 $a Jack Collins
65 245 10 $a How to program a computer
74 You can also achieve the same result by passing the commands
75 as arguments on a single command line:
78 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
79 <literal>"show 0 1" quit</literal>
82 <refsect1><title>COMMANDS</title>
85 <varlistentry><term><literal>connect</literal>
86 <replaceable>zurl</replaceable></term>
88 Connects to the target given by <replaceable>zurl</replaceable>.
89 </para></listitem></varlistentry>
91 <varlistentry><term><literal>close</literal>
92 [<replaceable>zurl</replaceable>]</term>
94 Closes connection to target given by
95 <replaceable>zurl</replaceable> or all targets if
96 <replaceable>zurl</replaceable> was omitted.
97 </para></listitem></varlistentry>
99 <varlistentry><term><literal>show</literal>
100 [<replaceable>start</replaceable>
101 [<replaceable>count</replaceable>]]
104 Displays <literal>count</literal> records starting at offset given
105 by <replaceable>start</replaceable>. First records has offset 0
106 (unlike the Z39.50 protocol).
107 </para></listitem></varlistentry>
109 <varlistentry><term><literal>quit</literal>
112 Quits <command>zoomsh</command>.
113 </para></listitem></varlistentry>
115 <varlistentry><term><literal>set</literal>
116 <replaceable>name</replaceable>
117 [<replaceable>value</replaceable>]
120 Sets option <replaceable>name</replaceable> to
121 <replaceable>value</replaceable>.
122 </para></listitem></varlistentry>
124 <varlistentry><term><literal>get</literal>
125 <replaceable>name</replaceable>
128 Prints value of option <replaceable>name</replaceable>.
129 </para></listitem></varlistentry>
131 <varlistentry><term><literal>help</literal>
134 Prints list of available commands.
135 </para></listitem></varlistentry>
140 <refsect1><title>SEE ALSO</title>
143 <refentrytitle>yaz</refentrytitle>
144 <manvolnum>7</manvolnum>
147 <refentrytitle>yaz-ztest</refentrytitle>
148 <manvolnum>8</manvolnum>
152 Section "Building clients with ZOOM" in the YAZ manual.
155 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
160 <!-- Keep this comment at the end of the file
165 sgml-minimize-attributes:nil
166 sgml-always-quote-attributes:t
169 sgml-parent-document:nil
170 sgml-local-catalogs: nil
171 sgml-namecase-general:t