doc/zoomsh.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2      <!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
   3 ]>
   4 <!-- $Id: zoomsh.sgml,v 1.2 2002-09-17 20:17:44 adam Exp $ -->
   5 <refentry id="zoomsh">
   6
   7  <refmeta>
   8   <refentrytitle>zoomsh</refentrytitle>
   9   <manvolnum>1</manvolnum>
  10  </refmeta>
  11
  12  <refnamediv>
  13   <refname>zoomsh</refname>
  14   <refpurpose>ZOOM shell</refpurpose>
  15  </refnamediv>
  16
  17  <refsynopsisdiv>
  18   <cmdsynopsis>
  19    <command>zoomsh</command>
  20    <arg choice="opt" rep="repeat">commands</arg>
  21   </cmdsynopsis>
  22
  23   <refsect1><title>DESCRIPTION</title>
  24    <para>
  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.
  28    </para>
  29    <para>
  30     You may parse one or more commands to <command>zoomsh</command>.
  31     These commands are invoked first.
  32    </para>
  33   </refsect1>
  34   <refsect1><title>EXAMPLES</title>
  35    <para>
  36     If you start the <command>yaz-ztest</command> in one console you
  37     can use the ZOOM shell as follows:
  38     <screen><![CDATA[
  39 $ zoomsh
  40 ZOOM>connect localhost:9999
  41 ZOOM>search computer
  42 localhost:9999: 7 hits
  43 ZOOM>show 0 1
  44 1 Default USmarc
  45 001    11224466
  46 003 DLC
  47 005 00000000000000.0
  48 008 910710c19910701nju           00010 eng
  49 010    $a    11224466
  50 040    $a DLC $c DLC
  51 050 00 $a 123-xyz
  52 100 10 $a Jack Collins
  53 245 10 $a How to program a computer
  54 260 1  $a Penguin
  55 263    $a 8710
  56 300    $a p. cm.
  57 ZOOM>quit
  58 ]]>
  59     </screen>
  60    </para>
  61    <para>
  62     You can also achieve the same result by passing the commands
  63     as arguments on a single command line:
  64    </para>
  65    <para>
  66     <literal>$ zoomsh "connect localhost:9999" "search computer"</literal>
  67     <literal>"show 0 1" quit</literal>
  68    </para>
  69   </refsect1>
  70   <refsect1><title>COMMANDS</title>
  71    <variablelist>
  72
  73     <varlistentry><term><literal>connect</literal>
  74       <replaceable>zurl</replaceable></term>
  75      <listitem><para>
  76        Connects to the target given by <replaceable>zurl</replaceable>.
  77       </para></listitem></varlistentry>
  78
  79     <varlistentry><term><literal>close</literal>
  80       [<replaceable>zurl</replaceable>]</term>
  81      <listitem><para>
  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>
  86
  87     <varlistentry><term><literal>show</literal>
  88       [<replaceable>start</replaceable>
  89       [<replaceable>count</replaceable>]]
  90      </term>
  91      <listitem><para>
  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>
  96
  97     <varlistentry><term><literal>quit</literal>
  98      </term>
  99      <listitem><para>
 100        Quits <command>zoomsh</command>.
 101       </para></listitem></varlistentry>
 102
 103     <varlistentry><term><literal>set</literal>
 104       <replaceable>name</replaceable>
 105       [<replaceable>value</replaceable>]
 106      </term>
 107      <listitem><para>
 108        Sets option <replaceable>name</replaceable> to
 109        <replaceable>value</replaceable>.
 110       </para></listitem></varlistentry>
 111
 112     <varlistentry><term><literal>get</literal>
 113       <replaceable>name</replaceable>
 114      </term>
 115      <listitem><para>
 116        Prints value of option <replaceable>name</replaceable>.
 117       </para></listitem></varlistentry>
 118
 119     <varlistentry><term><literal>help</literal>
 120      </term>
 121      <listitem><para>
 122        Prints list of available commands.
 123       </para></listitem></varlistentry>
 124
 125    </variablelist>
 126
 127   </refsect1>
 128   <refsect1><title>SEE ALSO</title>
 129    <para>
 130     <citerefentry>
 131      <refentrytitle>yaz</refentrytitle>
 132      <manvolnum>7</manvolnum>
 133     </citerefentry>,
 134     <citerefentry>
 135      <refentrytitle>yaz-ztest</refentrytitle>
 136      <manvolnum>8</manvolnum>
 137     </citerefentry>,
 138    </para>
 139    <para>
 140     Section "Building clients with ZOOM" in the YAZ manual.
 141    </para>
 142    <para>
 143     <ulink url="http://zoom.z3950.org/">ZOOM home page</ulink>.
 144    </para>
 145   </refsect1>
 146 </refentry>
 147
 148 <!-- Keep this comment at the end of the file
 149 Local variables:
 150 mode: sgml
 151 sgml-omittag:t
 152 sgml-shorttag:t
 153 sgml-minimize-attributes:nil
 154 sgml-always-quote-attributes:t
 155 sgml-indent-step:1
 156 sgml-indent-data:t
 157 sgml-parent-document:nil
 158 sgml-local-catalogs: nil
 159 sgml-namecase-general:t
 160 End:
 161 -->