1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2 <!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
4 <!-- $Id: zoomsh.sgml,v 1.3 2002-10-08 09:07:29 adam Exp $ -->
8 <refentrytitle>zoomsh</refentrytitle>
9 <manvolnum>1</manvolnum>
13 <refname>zoomsh</refname>
14 <refpurpose>ZOOM shell</refpurpose>
19 <command>zoomsh</command>
20 <arg choice="opt" rep="repeat">commands</arg>
24 <refsect1><title>DESCRIPTION</title>
26 <command>zoomsh</command> is a ZOOM client with a simple
27 command line interface. The client demonstrates the ZOOM
28 API and is useful for testing targets.
31 You may parse one or more commands to <command>zoomsh</command>.
32 These commands are invoked first.
35 <refsect1><title>EXAMPLES</title>
37 If you start the <command>yaz-ztest</command> in one console you
38 can use the ZOOM shell as follows:
41 ZOOM>connect localhost:9999
43 localhost:9999: 7 hits
49 008 910710c19910701nju 00010 eng
53 100 10 $a Jack Collins
54 245 10 $a How to program a computer
63 You can also achieve the same result by passing the commands
64 as arguments on a single command line:
67 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
68 <literal>"show 0 1" quit</literal>
71 <refsect1><title>COMMANDS</title>
74 <varlistentry><term><literal>connect</literal>
75 <replaceable>zurl</replaceable></term>
77 Connects to the target given by <replaceable>zurl</replaceable>.
78 </para></listitem></varlistentry>
80 <varlistentry><term><literal>close</literal>
81 [<replaceable>zurl</replaceable>]</term>
83 Closes connection to target given by
84 <replaceable>zurl</replaceable> or all targets if
85 <replaceable>zurl</replaceable> was omitted.
86 </para></listitem></varlistentry>
88 <varlistentry><term><literal>show</literal>
89 [<replaceable>start</replaceable>
90 [<replaceable>count</replaceable>]]
93 Displays <literal>count</literal> records starting at offset given
94 by <replaceable>start</replaceable>. First records has offset 0
95 (unlike the Z39.50 protocol).
96 </para></listitem></varlistentry>
98 <varlistentry><term><literal>quit</literal>
101 Quits <command>zoomsh</command>.
102 </para></listitem></varlistentry>
104 <varlistentry><term><literal>set</literal>
105 <replaceable>name</replaceable>
106 [<replaceable>value</replaceable>]
109 Sets option <replaceable>name</replaceable> to
110 <replaceable>value</replaceable>.
111 </para></listitem></varlistentry>
113 <varlistentry><term><literal>get</literal>
114 <replaceable>name</replaceable>
117 Prints value of option <replaceable>name</replaceable>.
118 </para></listitem></varlistentry>
120 <varlistentry><term><literal>help</literal>
123 Prints list of available commands.
124 </para></listitem></varlistentry>
129 <refsect1><title>SEE ALSO</title>
132 <refentrytitle>yaz</refentrytitle>
133 <manvolnum>7</manvolnum>
136 <refentrytitle>yaz-ztest</refentrytitle>
137 <manvolnum>8</manvolnum>
141 Section "Building clients with ZOOM" in the YAZ manual.
144 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
149 <!-- Keep this comment at the end of the file
154 sgml-minimize-attributes:nil
155 sgml-always-quote-attributes:t
158 sgml-parent-document:nil
159 sgml-local-catalogs: nil
160 sgml-namecase-general:t