doc/zoomsh-man.xml

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