doc/zoomsh-man.xml

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