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