1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
4 <!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
6 <!-- $Id: zoomsh-man.xml,v 1.4 2006-05-24 12:33:21 adam Exp $ -->
10 <refentrytitle>zoomsh</refentrytitle>
11 <manvolnum>1</manvolnum>
15 <refname>zoomsh</refname>
16 <refpurpose>ZOOM shell</refpurpose>
21 <command>zoomsh</command>
22 <arg choice="opt" rep="repeat">commands</arg>
26 <refsect1><title>DESCRIPTION</title>
28 <command>zoomsh</command> is a ZOOM client with a simple
29 command line interface. The client demonstrates the ZOOM
30 API and is useful for testing targets.
33 You may pass one or more commands to <command>zoomsh</command>.
34 These commands are invoked first.
37 <refsect1><title>EXAMPLES</title>
39 If you start the <command>yaz-ztest</command> in one console you
40 can use the ZOOM shell as follows:
43 ZOOM>connect localhost:9999
45 localhost:9999: 7 hits
51 008 910710c19910701nju 00010 eng
55 100 10 $a Jack Collins
56 245 10 $a How to program a computer
65 You can also achieve the same result by passing the commands
66 as arguments on a single command line:
69 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
70 <literal>"show 0 1" quit</literal>
73 <refsect1><title>COMMANDS</title>
76 <varlistentry><term><literal>connect</literal>
77 <replaceable>zurl</replaceable></term>
79 Connects to the target given by <replaceable>zurl</replaceable>.
80 </para></listitem></varlistentry>
82 <varlistentry><term><literal>close</literal>
83 [<replaceable>zurl</replaceable>]</term>
85 Closes connection to target given by
86 <replaceable>zurl</replaceable> or all targets if
87 <replaceable>zurl</replaceable> was omitted.
88 </para></listitem></varlistentry>
90 <varlistentry><term><literal>show</literal>
91 [<replaceable>start</replaceable>
92 [<replaceable>count</replaceable>]]
95 Displays <literal>count</literal> records starting at offset given
96 by <replaceable>start</replaceable>. First records has offset 0
97 (unlike the Z39.50 protocol).
98 </para></listitem></varlistentry>
100 <varlistentry><term><literal>quit</literal>
103 Quits <command>zoomsh</command>.
104 </para></listitem></varlistentry>
106 <varlistentry><term><literal>set</literal>
107 <replaceable>name</replaceable>
108 [<replaceable>value</replaceable>]
111 Sets option <replaceable>name</replaceable> to
112 <replaceable>value</replaceable>.
113 </para></listitem></varlistentry>
115 <varlistentry><term><literal>get</literal>
116 <replaceable>name</replaceable>
119 Prints value of option <replaceable>name</replaceable>.
120 </para></listitem></varlistentry>
122 <varlistentry><term><literal>help</literal>
125 Prints list of available commands.
126 </para></listitem></varlistentry>
131 <refsect1><title>SEE ALSO</title>
134 <refentrytitle>yaz</refentrytitle>
135 <manvolnum>7</manvolnum>
138 <refentrytitle>yaz-ztest</refentrytitle>
139 <manvolnum>8</manvolnum>
143 Section "Building clients with ZOOM" in the YAZ manual.
146 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
151 <!-- Keep this comment at the end of the file
156 sgml-minimize-attributes:nil
157 sgml-always-quote-attributes:t
160 sgml-parent-document:nil
161 sgml-local-catalogs: nil
162 sgml-namecase-general:t