1 <chapter id="quick-start">
2 <!-- $Id: quickstart.xml,v 1.2 2002-04-10 14:47:49 heikki 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 are the YAZ tables located.
19 profilePath: ../../../yaz/tab ../../tab
21 # Files that describe the attribute sets supported.
28 Now, edit the file and set <literal>profilePath</literal> to the path of the
29 YAZ profile tables (sub directory <literal>tab</literal> of the YAZ
30 distribution archive).
34 The 48 test records are located in the sub directory
35 <literal>records</literal>. To index these, type:
38 $ ../../index/zebraidx -t grs.sgml update records
43 In the command above the option <literal>-t</literal> specified the record
44 type — in this case <literal>grs.sgml</literal>.
45 The word <literal>update</literal> followed
46 by a directory root updates all files below that directory node.
50 If your indexing command was successful, you are now ready to
51 fire up a server. To start a server on port 2100, type:
54 $ ../../index/zebrasrv tcp:@:2100
60 The Zebra index that you have just created has a single database
61 named <literal>Default</literal>.
62 The database contains records structured according to
63 the GILS profile, and the server will
64 return records in either either USMARC, GRS-1, or SUTRS depending
65 on what your client asks for.
69 To test the server, you can use any Z39.50 client (1992 or later).
70 For instance, you can use the demo client that comes with YAZ: Just
71 cd to the <literal>client</literal> subdirectory of the YAZ distribution
76 $ ./yaz-client tcp:localhost:2100
81 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, there's a good chance that
118 you've got through the compilation OK.
123 <!-- Keep this comment at the end of the file
128 sgml-minimize-attributes:nil
129 sgml-always-quote-attributes:t
132 sgml-parent-document: "zebra.xml"
133 sgml-local-catalogs: nil
134 sgml-namecase-general:t