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