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>
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:
13 # Where are the YAZ tables located.
14 profilePath: ../../../yaz/tab ../../tab
16 # Files that describe the attribute sets supported.
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).
29 The 48 test records are located in the sub directory
30 <literal>records</literal>. To index these, type:
33 $ ../../index/zebraidx -t grs.sgml update records
38 In the command above the option <literal>-t</literal> specified the record
39 type — 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.
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:
49 $ ../../index/zebrasrv tcp:@:2100
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.
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
71 $ ./yaz-client tcp:localhost:2100
76 When the client has connected, you can type:
88 The default retrieval syntax for the client is USMARC. To try other
89 formats for the same record, try:
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.
112 If you've made it this far, there's a good chance that
113 you've got through the compilation OK.
118 <!-- Keep this comment at the end of the file
123 sgml-minimize-attributes:nil
124 sgml-always-quote-attributes:t
127 sgml-parent-document: "zebra.xml"
128 sgml-local-catalogs: nil
129 sgml-namecase-general:t