Add zebrasrv.pid
[idzebra-moved-to-github.git] / doc / quickstart.xml
1 <chapter id="quick-start">
2  <!-- $Id: quickstart.xml,v 1.8 2002-12-01 23:26:26 mike Exp $ -->
3  <title>Quick Start </title>
4
5  <para>
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 Zebra a server against the newly created database, and
10   searching the indexes with a client that connects to that server.
11  </para>
12  <para>
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:
16   <screen>
17    zebraidx update records
18   </screen>
19  </para>
20  
21  <para>
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.
25  </para>
26  
27  <para>
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:
30   
31   <screen>
32    zebrasrv @:2100
33   </screen>
34   
35  </para>
36
37  <para>
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 USMARC, GRS-1, or SUTRS format depending
43   on what the client asks for.
44  </para>
45  
46  <para>
47   To test the server, you can use any Z39.50 client.
48   For instance, you can use the demo command-line client that comes
49   with YAZ:
50  </para>
51  <para>
52   <screen>
53    yaz-client localhost:2100
54   </screen>
55  </para>
56  
57  <para>
58   When the client has connected, you can type:
59  </para>
60  
61  <para>
62   <screen>
63    Z&#62; find surficial
64    Z&#62; show 1
65   </screen>
66  </para>
67  
68  <para>
69   The default retrieval syntax for the client is 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:
72  </para>
73  <para>
74   <screen>
75    Z&#62;format sutrs
76    Z&#62;show 1
77    Z&#62;format grs-1
78    Z&#62;show 1
79    Z&#62;format xml
80    Z&#62;show 1
81    Z&#62;elements B
82    Z&#62;show 1
83   </screen>
84  </para>
85  
86  <note>
87   <para>You may notice that more fields are returned when your
88    client requests SUTRS, GRS-1 or XML records.
89    This is normal - not all of the GILS data elements have mappings in
90    the USMARC record format.
91   </para>
92  </note>
93  <para>
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.
100  </para>
101  
102 </chapter>
103
104  <!-- Keep this comment at the end of the file
105  Local variables:
106  mode: sgml
107  sgml-omittag:t
108  sgml-shorttag:t
109  sgml-minimize-attributes:nil
110  sgml-always-quote-attributes:t
111  sgml-indent-step:1
112  sgml-indent-data:t
113  sgml-parent-document: "zebra.xml"
114  sgml-local-catalogs: nil
115  sgml-namecase-general:t
116  End:
117  -->