Update version for RPM package

[idzebra-moved-to-github.git] / doc / quickstart.xml

diff --git a/doc/quickstart.xml b/doc/quickstart.xml
index e1dd699..d7f0d00 100644 (file)
--- a/doc/quickstart.xml
+++ b/doc/quickstart.xml
@@ -1,43 +1,53 @@
 <chapter id="quick-start">
- <!-- $Id: quickstart.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: quickstart.xml,v 1.7 2002-10-30 14:35:09 adam Exp $ -->
  <title>Quick Start </title>
  
+ <!--
+  FIXME - Start with the new improved example scripts that run 
+  without any configuration file changes!
+       ### do we want this now we have "examples.html"? - mike, 15/10/02
+ -->
+
  <para>
   In this section, we will test the system by indexing a small set of sample
   GILS records that are included with the software distribution. Go to the
-  <literal>test/gils</literal> subdirectory of the distribution archive.
+  <literal>examples/gils</literal> subdirectory of the distribution archive.
   There you will find a configuration
   file named <literal>zebra.cfg</literal> with the following contents:
   
   <screen>
-   # Where are the YAZ tables located.
-   profilePath: ../../../yaz/tab ../../tab
-   
+   # Where the schema files, attribute files, etc are located.
+   profilePath: ../../tab
+
    # Files that describe the attribute sets supported.
    attset: bib1.att
    attset: gils.att
+   attset: explain.att
+
+   recordtype: grs.sgml
+   isam: c
   </screen>
  </para>
- 
+
+ <!--  No longer necessary
  <para>
-  Now, edit the file and set <literal>profilePath</literal> to the path of the
+  If necessary, edit the file and set <literal>profilePath</literal> to the path of the
   YAZ profile tables (sub directory <literal>tab</literal> of the YAZ
   distribution archive).
  </para>
+ -->
  
  <para>
   The 48 test records are located in the sub directory
   <literal>records</literal>. To index these, type:
   
   <screen>
-   $ ../../index/zebraidx -t grs.sgml update records
+   zebraidx update records
   </screen>
  </para>
  
  <para>
-  In the command above the option <literal>-t</literal> specified the record
-  type &mdash; in this case <literal>grs.sgml</literal>.
-  The word <literal>update</literal> followed
+  In the command above, the word <literal>update</literal> followed
   by a directory root updates all files below that directory node.
  </para>
  
@@ -46,7 +56,7 @@
   fire up a server. To start a server on port 2100, type:
   
   <screen>
-   $ ../../index/zebrasrv tcp:@:2100
+   zebrasrv tcp:@:2100
   </screen>
   
  </para>
@@ -61,14 +71,12 @@
  </para>
  
  <para>
-  To test the server, you can use any Z39.50 client (1992 or later).
-  For instance, you can use the demo client that comes with YAZ: Just
-  cd to the <literal>client</literal> subdirectory of the YAZ distribution
-  and type:
+  To test the server, you can use any Z39.50 client.
+  For instance, you can use the demo client that comes with YAZ:
  </para>
  <para>
   <screen>
-   $ ./yaz-client tcp:localhost:2100
+   yaz-client tcp:localhost:2100
   </screen>
  </para>
  
@@ -76,8 +84,7 @@
   When the client has connected, you can type:
  </para>
  
-<para>
-  
+ <para>
   <screen>
    Z&#62; find surficial
    Z&#62; show 1
@@ -109,8 +116,12 @@
   </para>
  </note>
  <para>
-  If you've made it this far, there's a good chance that
-  you've got through the compilation OK.
+  If you've made it this far, you know that your installation is
+  working, but there's a certain amount of voodoo going on - for
+  example, the mysterious incantations in the
+  <literal>zebra.cfg</literal> file.  In order to help us understand
+  these fully, the next chapter will work through a series of
+  increasingly complex example configurations.
  </para>
  
 </chapter>