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