1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2 <!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
4 <!-- $Id: zoomsh.sgml,v 1.2 2002-09-17 20:17:44 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>
23 <refsect1><title>DESCRIPTION</title>
25 <command>zoomsh</command> is a ZOOM client with a simple
26 command line interface. The client demonstrates the ZOOM
27 API and is useful for testing targets.
30 You may parse one or more commands to <command>zoomsh</command>.
31 These commands are invoked first.
34 <refsect1><title>EXAMPLES</title>
36 If you start the <command>yaz-ztest</command> in one console you
37 can use the ZOOM shell as follows:
40 ZOOM>connect localhost:9999
42 localhost:9999: 7 hits
48 008 910710c19910701nju 00010 eng
52 100 10 $a Jack Collins
53 245 10 $a How to program a computer
62 You can also achieve the same result by passing the commands
63 as arguments on a single command line:
66 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
67 <literal>"show 0 1" quit</literal>
70 <refsect1><title>COMMANDS</title>
73 <varlistentry><term><literal>connect</literal>
74 <replaceable>zurl</replaceable></term>
76 Connects to the target given by <replaceable>zurl</replaceable>.
77 </para></listitem></varlistentry>
79 <varlistentry><term><literal>close</literal>
80 [<replaceable>zurl</replaceable>]</term>
82 Closes connection to target given by
83 <replaceable>zurl</replaceable> or all targets if
84 <replaceable>zurl</replaceable> was omitted.
85 </para></listitem></varlistentry>
87 <varlistentry><term><literal>show</literal>
88 [<replaceable>start</replaceable>
89 [<replaceable>count</replaceable>]]
92 Displays <literal>count</literal> records starting at offset given
93 by <replaceable>start</replaceable>. First records has offset 0
94 (unlike the Z39.50 protocol).
95 </para></listitem></varlistentry>
97 <varlistentry><term><literal>quit</literal>
100 Quits <command>zoomsh</command>.
101 </para></listitem></varlistentry>
103 <varlistentry><term><literal>set</literal>
104 <replaceable>name</replaceable>
105 [<replaceable>value</replaceable>]
108 Sets option <replaceable>name</replaceable> to
109 <replaceable>value</replaceable>.
110 </para></listitem></varlistentry>
112 <varlistentry><term><literal>get</literal>
113 <replaceable>name</replaceable>
116 Prints value of option <replaceable>name</replaceable>.
117 </para></listitem></varlistentry>
119 <varlistentry><term><literal>help</literal>
122 Prints list of available commands.
123 </para></listitem></varlistentry>
128 <refsect1><title>SEE ALSO</title>
131 <refentrytitle>yaz</refentrytitle>
132 <manvolnum>7</manvolnum>
135 <refentrytitle>yaz-ztest</refentrytitle>
136 <manvolnum>8</manvolnum>
140 Section "Building clients with ZOOM" in the YAZ manual.
143 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
148 <!-- Keep this comment at the end of the file
153 sgml-minimize-attributes:nil
154 sgml-always-quote-attributes:t
157 sgml-parent-document:nil
158 sgml-local-catalogs: nil
159 sgml-namecase-general:t