1 <chapter id="quick-start">
2 <!-- $Id: quickstart.xml,v 1.7 2002-10-30 14:35:09 adam Exp $ -->
3 <title>Quick Start </title>
6 FIXME - Start with the new improved example scripts that run
7 without any configuration file changes!
8 ### do we want this now we have "examples.html"? - mike, 15/10/02
12 In this section, we will test the system by indexing a small set of sample
13 GILS records that are included with the software distribution. Go to the
14 <literal>examples/gils</literal> subdirectory of the distribution archive.
15 There you will find a configuration
16 file named <literal>zebra.cfg</literal> with the following contents:
19 # Where the schema files, attribute files, etc are located.
20 profilePath: ../../tab
22 # Files that describe the attribute sets supported.
32 <!-- No longer necessary
34 If necessary, edit the file and set <literal>profilePath</literal> to the path of the
35 YAZ profile tables (sub directory <literal>tab</literal> of the YAZ
36 distribution archive).
41 The 48 test records are located in the sub directory
42 <literal>records</literal>. To index these, type:
45 zebraidx update records
50 In the command above, the word <literal>update</literal> followed
51 by a directory root updates all files below that directory node.
55 If your indexing command was successful, you are now ready to
56 fire up a server. To start a server on port 2100, type:
65 The Zebra index that you have just created has a single database
66 named <literal>Default</literal>.
67 The database contains records structured according to
68 the GILS profile, and the server will
69 return records in either either USMARC, GRS-1, or SUTRS depending
70 on what your client asks for.
74 To test the server, you can use any Z39.50 client.
75 For instance, you can use the demo client that comes with YAZ:
79 yaz-client tcp:localhost:2100
84 When the client has connected, you can type:
95 The default retrieval syntax for the client is USMARC. To try other
96 formats for the same record, try:
112 <para>You may notice that more fields are returned when your
113 client requests SUTRS or GRS-1 records. When retrieving GILS records,
114 this is normal - not all of the GILS data elements have mappings in
115 the USMARC record format.
119 If you've made it this far, you know that your installation is
120 working, but there's a certain amount of voodoo going on - for
121 example, the mysterious incantations in the
122 <literal>zebra.cfg</literal> file. In order to help us understand
123 these fully, the next chapter will work through a series of
124 increasingly complex example configurations.
129 <!-- Keep this comment at the end of the file
134 sgml-minimize-attributes:nil
135 sgml-always-quote-attributes:t
138 sgml-parent-document: "zebra.xml"
139 sgml-local-catalogs: nil
140 sgml-namecase-general:t