doc/quickstart.xml

   1 <chapter id="quick-start">
   2  <title>Quick Start </title>
   3
   4  <para>
   5   <!-- ### ulink to GILS profile: what's the URL? -->
   6   In this section, we will test the system by indexing a small set of
   7   sample GILS records that are included with the &zebra; distribution,
   8   running a &zebra; server against the newly created database, and
   9   searching the indexes with a client that connects to that server.
  10  </para>
  11  <para>
  12   Go to the <literal>examples/gils</literal> subdirectory of the
  13   distribution archive.  The 48 test records are located in the sub
  14   directory <literal>records</literal>. To index these, type:
  15   <screen>
  16    zebraidx update records
  17   </screen>
  18  </para>
  19
  20  <para>
  21   In this command, the word <literal>update</literal> is followed
  22   by the name of a directory: <literal>zebraidx</literal> updates all
  23   files in the hierarchy rooted at that directory.
  24  </para>
  25
  26  <para>
  27   If your indexing command was successful, you are now ready to
  28   fire up a server. To start a server on port 2100, type:
  29
  30   <screen>
  31    zebrasrv @:2100
  32   </screen>
  33
  34  </para>
  35
  36  <para>
  37   The &zebra; index that you have just created has a single database
  38   named <literal>Default</literal>.
  39   The database contains records structured according to
  40   the GILS profile, and the server will
  41   return records in &acro.usmarc;, &acro.grs1;, or &acro.sutrs; format depending
  42   on what the client asks for.
  43  </para>
  44
  45  <para>
  46   To test the server, you can use any &acro.z3950; client.
  47   For instance, you can use the demo command-line client that comes
  48   with &yaz;:
  49  </para>
  50  <para>
  51   <screen>
  52    yaz-client localhost:2100
  53   </screen>
  54  </para>
  55
  56  <para>
  57   When the client has connected, you can type:
  58  </para>
  59
  60  <para>
  61   <screen>
  62    Z&#62; find surficial
  63    Z&#62; show 1
  64   </screen>
  65  </para>
  66
  67  <para>
  68   The default retrieval syntax for the client is &acro.usmarc;, and the
  69   default element set is <literal>F</literal> (``full record''). To
  70   try other formats and element sets for the same record, try:
  71  </para>
  72  <para>
  73   <screen>
  74    Z&#62;format sutrs
  75    Z&#62;show 1
  76    Z&#62;format grs-1
  77    Z&#62;show 1
  78    Z&#62;format xml
  79    Z&#62;show 1
  80    Z&#62;elements B
  81    Z&#62;show 1
  82   </screen>
  83  </para>
  84
  85  <note>
  86   <para>You may notice that more fields are returned when your
  87    client requests &acro.sutrs;, &acro.grs1; or &acro.xml; records.
  88    This is normal - not all of the GILS data elements have mappings in
  89    the &acro.usmarc; record format.
  90   </para>
  91  </note>
  92  <para>
  93   If you've made it this far, you know that your installation is
  94   working, but there's a certain amount of voodoo going on - for
  95   example, the mysterious incantations in the
  96   <literal>zebra.cfg</literal> file.  In order to help us understand
  97   these fully, the next chapter will work through a series of
  98   increasingly complex example configurations.
  99  </para>
 100
 101 </chapter>
 102
 103  <!-- Keep this comment at the end of the file
 104  Local variables:
 105  mode: sgml
 106  sgml-omittag:t
 107  sgml-shorttag:t
 108  sgml-minimize-attributes:nil
 109  sgml-always-quote-attributes:t
 110  sgml-indent-step:1
 111  sgml-indent-data:t
 112  sgml-parent-document: "zebra.xml"
 113  sgml-local-catalogs: nil
 114  sgml-namecase-general:t
 115  End:
 116  -->