1 <chapter id="quick-start">
2 <!-- $Id: quickstart.xml,v 1.5 2002-10-16 20:33:31 mike 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>test/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:../../../yaz/tab:/usr/local/share/yaz/tab:/usr/share/yaz/tab
22 # Files that describe the attribute sets supported.
33 If necessary, edit the file and set <literal>profilePath</literal> to the path of the
34 YAZ profile tables (sub directory <literal>tab</literal> of the YAZ
35 distribution archive).
39 The 48 test records are located in the sub directory
40 <literal>records</literal>. To index these, type:
43 zebraidx update records
48 In the command above, the word <literal>update</literal> followed
49 by a directory root updates all files below that directory node.
53 If your indexing command was successful, you are now ready to
54 fire up a server. To start a server on port 2100, type:
63 The Zebra index that you have just created has a single database
64 named <literal>Default</literal>.
65 The database contains records structured according to
66 the GILS profile, and the server will
67 return records in either either USMARC, GRS-1, or SUTRS depending
68 on what your client asks for.
72 To test the server, you can use any Z39.50 client.
73 For instance, you can use the demo client that comes with YAZ:
77 yaz-client tcp:localhost:2100
82 When the client has connected, you can type:
93 The default retrieval syntax for the client is USMARC. To try other
94 formats for the same record, try:
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.
117 If you've made it this far, you know that your installation is
118 working, but there's a certain amount of voodoo going on - for
119 example, the mysterious incantations in the
120 <literal>zebra.cfg</literal> file. In order to help us understand
121 these fully, the next chapter will work through a series of
122 increasingly complex example configurations.
127 <!-- Keep this comment at the end of the file
132 sgml-minimize-attributes:nil
133 sgml-always-quote-attributes:t
136 sgml-parent-document: "zebra.xml"
137 sgml-local-catalogs: nil
138 sgml-namecase-general:t