doc/quickstart.xml

   1 <chapter id="quick-start">
   2  <!-- $Id: quickstart.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
   3  <title>Quick Start </title>
   4
   5  <para>
   6   In this section, we will test the system by indexing a small set of sample
   7   GILS records that are included with the software distribution. Go to the
   8   <literal>test/gils</literal> subdirectory of the distribution archive.
   9   There you will find a configuration
  10   file named <literal>zebra.cfg</literal> with the following contents:
  11
  12   <screen>
  13    # Where are the YAZ tables located.
  14    profilePath: ../../../yaz/tab ../../tab
  15
  16    # Files that describe the attribute sets supported.
  17    attset: bib1.att
  18    attset: gils.att
  19   </screen>
  20  </para>
  21
  22  <para>
  23   Now, edit the file and set <literal>profilePath</literal> to the path of the
  24   YAZ profile tables (sub directory <literal>tab</literal> of the YAZ
  25   distribution archive).
  26  </para>
  27
  28  <para>
  29   The 48 test records are located in the sub directory
  30   <literal>records</literal>. To index these, type:
  31
  32   <screen>
  33    $ ../../index/zebraidx -t grs.sgml update records
  34   </screen>
  35  </para>
  36
  37  <para>
  38   In the command above the option <literal>-t</literal> specified the record
  39   type &mdash; in this case <literal>grs.sgml</literal>.
  40   The word <literal>update</literal> followed
  41   by a directory root updates all files below that directory node.
  42  </para>
  43
  44  <para>
  45   If your indexing command was successful, you are now ready to
  46   fire up a server. To start a server on port 2100, type:
  47
  48   <screen>
  49    $ ../../index/zebrasrv tcp:@:2100
  50   </screen>
  51
  52  </para>
  53
  54  <para>
  55   The Zebra index that you have just created has a single database
  56   named <literal>Default</literal>.
  57   The database contains records structured according to
  58   the GILS profile, and the server will
  59   return records in either either USMARC, GRS-1, or SUTRS depending
  60   on what your client asks for.
  61  </para>
  62
  63  <para>
  64   To test the server, you can use any Z39.50 client (1992 or later).
  65   For instance, you can use the demo client that comes with YAZ: Just
  66   cd to the <literal>client</literal> subdirectory of the YAZ distribution
  67   and type:
  68  </para>
  69  <para>
  70   <screen>
  71    $ ./yaz-client tcp:localhost:2100
  72   </screen>
  73  </para>
  74
  75  <para>
  76   When the client has connected, you can type:
  77  </para>
  78
  79 <para>
  80
  81   <screen>
  82    Z&#62; find surficial
  83    Z&#62; show 1
  84   </screen>
  85  </para>
  86
  87  <para>
  88   The default retrieval syntax for the client is USMARC. To try other
  89   formats for the same record, try:
  90  </para>
  91  <para>
  92   <screen>
  93    Z&#62;format sutrs
  94    Z&#62;show 1
  95    Z&#62;format grs-1
  96    Z&#62;show 1
  97    Z&#62;format xml
  98    Z&#62;show 1
  99    Z&#62;elements B
 100    Z&#62;show 1
 101   </screen>
 102  </para>
 103
 104  <note>
 105   <para>You may notice that more fields are returned when your
 106    client requests SUTRS or GRS-1 records. When retrieving GILS records,
 107    this is normal - not all of the GILS data elements have mappings in
 108    the USMARC record format.
 109   </para>
 110  </note>
 111  <para>
 112   If you've made it this far, there's a good chance that
 113   you've got through the compilation OK.
 114  </para>
 115
 116 </chapter>
 117
 118  <!-- Keep this comment at the end of the file
 119  Local variables:
 120  mode: sgml
 121  sgml-omittag:t
 122  sgml-shorttag:t
 123  sgml-minimize-attributes:nil
 124  sgml-always-quote-attributes:t
 125  sgml-indent-step:1
 126  sgml-indent-data:t
 127  sgml-parent-document: "zebra.xml"
 128  sgml-local-catalogs: nil
 129  sgml-namecase-general:t
 130  End:
 131  -->