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"><option>-a <replaceable>apdufile</replaceable></option></arg>
33 <arg choice="opt"><option>-e</option></arg>
34 <arg choice="opt"><option>-v <replaceable>loglevel</replaceable></option></arg>
35 <arg choice="opt" rep="repeat">commands</arg>
39 <refsect1><title>DESCRIPTION</title>
41 <command>zoomsh</command> is a ZOOM client with a simple
42 command line interface. The client demonstrates the ZOOM
43 API and is useful for testing targets.
46 You may pass one or more commands to <command>zoomsh</command>.
47 These commands are invoked first.
52 <title>OPTIONS</title>
55 <term>-a <replaceable>apdufile</replaceable></term>
57 Logs protocol packages into apdufile (APDU log).
63 Makes zoomsh stop processing commands as soon as an error occur.
64 The exit code of zoomsh is 1 if error occurs; 0 otherwise.
68 <term>-v <replaceable>loglevel</replaceable></term>
70 Sets YAZ log level to <replaceable>loglevel</replaceable>.
75 <refsect1><title>EXAMPLES</title>
77 If you start the <command>yaz-ztest</command> in one console you
78 can use the ZOOM shell as follows:
81 ZOOM>connect localhost:9999
83 localhost:9999: 7 hits
89 008 910710c19910701nju 00010 eng
93 100 10 $a Jack Collins
94 245 10 $a How to program a computer
103 You can also achieve the same result by passing the commands
104 as arguments on a single command line:
107 <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
108 <literal>"show 0 1" quit</literal>
111 <refsect1><title>COMMANDS</title>
114 <varlistentry><term><literal>connect</literal>
115 <replaceable>zurl</replaceable></term>
117 Connects to the target given by <replaceable>zurl</replaceable>.
118 </para></listitem></varlistentry>
120 <varlistentry><term><literal>close</literal>
121 [<replaceable>zurl</replaceable>]</term>
123 Closes connection to target given by
124 <replaceable>zurl</replaceable> or all targets if
125 <replaceable>zurl</replaceable> was omitted.
126 </para></listitem></varlistentry>
128 <varlistentry><term><literal>show</literal>
129 [<replaceable>start</replaceable>
130 [<replaceable>count</replaceable>]]
133 Displays <literal>count</literal> records starting at offset given
134 by <replaceable>start</replaceable>. First records has offset 0
135 (unlike the Z39.50 protocol).
136 </para></listitem></varlistentry>
138 <varlistentry><term><literal>quit</literal>
141 Quits <command>zoomsh</command>.
142 </para></listitem></varlistentry>
144 <varlistentry><term><literal>set</literal>
145 <replaceable>name</replaceable>
146 [<replaceable>value</replaceable>]
149 Sets option <replaceable>name</replaceable> to
150 <replaceable>value</replaceable>.
151 </para></listitem></varlistentry>
153 <varlistentry><term><literal>get</literal>
154 <replaceable>name</replaceable>
157 Prints value of option <replaceable>name</replaceable>.
158 </para></listitem></varlistentry>
160 <varlistentry><term><literal>help</literal>
163 Prints list of available commands.
164 </para></listitem></varlistentry>
169 <refsect1><title>SEE ALSO</title>
172 <refentrytitle>yaz</refentrytitle>
173 <manvolnum>7</manvolnum>
176 <refentrytitle>yaz-ztest</refentrytitle>
177 <manvolnum>8</manvolnum>
181 Section "Building clients with ZOOM" in the YAZ manual.
184 <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
189 <!-- Keep this comment at the end of the file