1 <chapter id="quick-start">
2 <!-- $Id: quickstart.xml,v 1.4 2002-10-11 09:05: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!
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:
18 # Where the schema files, attribute files, etc are located.
19 profilePath: .:../../tab:../../../yaz/tab:/usr/local/share/yaz/tab:/usr/share/yaz/tab
21 # Files that describe the attribute sets supported.
32 If necessary, edit the file and set <literal>profilePath</literal> to the path of the
33 YAZ profile tables (sub directory <literal>tab</literal> of the YAZ
34 distribution archive).
38 The 48 test records are located in the sub directory
39 <literal>records</literal>. To index these, type:
42 zebraidx update records
47 In the command above, the word <literal>update</literal> followed
48 by a directory root updates all files below that directory node.
52 If your indexing command was successful, you are now ready to
53 fire up a server. To start a server on port 2100, type:
62 The Zebra index that you have just created has a single database
63 named <literal>Default</literal>.
64 The database contains records structured according to
65 the GILS profile, and the server will
66 return records in either either USMARC, GRS-1, or SUTRS depending
67 on what your client asks for.
71 To test the server, you can use any Z39.50 client.
72 For instance, you can use the demo client that comes with YAZ:
76 yaz-client tcp:localhost:2100
81 When the client has connected, you can type:
92 The default retrieval syntax for the client is USMARC. To try other
93 formats for the same record, try:
109 <para>You may notice that more fields are returned when your
110 client requests SUTRS or GRS-1 records. When retrieving GILS records,
111 this is normal - not all of the GILS data elements have mappings in
112 the USMARC record format.
116 If you've made it this far, you know that your installation is
117 working, but there's a certain amount of voodoo going on - for
118 example, the mysterious incantations in the
119 <literal>zebra.cfg</literal> file. In order to help us understand
120 these fully, the next chapter will work through a series of
121 increasingly complex example configurations.
126 <!-- Keep this comment at the end of the file
131 sgml-minimize-attributes:nil
132 sgml-always-quote-attributes:t
135 sgml-parent-document: "zebra.xml"
136 sgml-local-catalogs: nil
137 sgml-namecase-general:t