doc/zoomsh-man.xml

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