1 <chapter id="quick-start">
2 <!-- $Id: quickstart.xml,v 1.14 2007-05-24 13:44:09 adam Exp $ -->
3 <title>Quick Start </title>
6 <!-- ### ulink to GILS profile: what's the URL? -->
7 In this section, we will test the system by indexing a small set of
8 sample GILS records that are included with the &zebra; distribution,
9 running a &zebra; server against the newly created database, and
10 searching the indexes with a client that connects to that server.
13 Go to the <literal>examples/gils</literal> subdirectory of the
14 distribution archive. The 48 test records are located in the sub
15 directory <literal>records</literal>. To index these, type:
17 zebraidx update records
22 In this command, the word <literal>update</literal> is followed
23 by the name of a directory: <literal>zebraidx</literal> updates all
24 files in the hierarchy rooted at that directory.
28 If your indexing command was successful, you are now ready to
29 fire up a server. To start a server on port 2100, type:
38 The &zebra; index that you have just created has a single database
39 named <literal>Default</literal>.
40 The database contains records structured according to
41 the GILS profile, and the server will
42 return records in &acro.usmarc;, &acro.grs1;, or &acro.sutrs; format depending
43 on what the client asks for.
47 To test the server, you can use any &acro.z3950; client.
48 For instance, you can use the demo command-line client that comes
53 yaz-client localhost:2100
58 When the client has connected, you can type:
69 The default retrieval syntax for the client is &acro.usmarc;, and the
70 default element set is <literal>F</literal> (``full record''). To
71 try other formats and element sets for the same record, try:
87 <para>You may notice that more fields are returned when your
88 client requests &acro.sutrs;, &acro.grs1; or &acro.xml; records.
89 This is normal - not all of the GILS data elements have mappings in
90 the &acro.usmarc; record format.
94 If you've made it this far, you know that your installation is
95 working, but there's a certain amount of voodoo going on - for
96 example, the mysterious incantations in the
97 <literal>zebra.cfg</literal> file. In order to help us understand
98 these fully, the next chapter will work through a series of
99 increasingly complex example configurations.
104 <!-- Keep this comment at the end of the file
109 sgml-minimize-attributes:nil
110 sgml-always-quote-attributes:t
113 sgml-parent-document: "zebra.xml"
114 sgml-local-catalogs: nil
115 sgml-namecase-general:t