doc/quickstart.xml

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