Describe four more files.

[irspy-moved-to-github.git] / zebra / README

diff --git a/zebra/README b/zebra/README
index 6d757e8..407ff65 100644 (file)
--- a/zebra/README
+++ b/zebra/README
@@ -1,4 +1,4 @@
-$Id: README,v 1.13 2006-10-10 12:53:29 mike Exp $
+$Id: README,v 1.15 2006-12-08 15:57:52 mike Exp $
 
 What's what in this directory:
 
@@ -44,6 +44,9 @@ zebra.cfg -- Zebra-specific configuration, including the location of
        the register files, the location of the XSLT filter
        configuration (filterconf.xml), etc.
 
+htpasswd -- Password file for the "admin" user who has permission to
+       update the database remotely.
+
 filterconf.xml -- Configuration of Zebra's XSLT filter, which uses
        XSLT stylesheets to identify the indexable data in incoming
        files and to transform records for presentation.
@@ -55,6 +58,8 @@ zeerex2index.xsl -- The indexing stylesheet for ZeeRex records.  It's
 zeerex2zeerex.xsl -- The "no-op" stylesheet for presenting ZeeRex
        records.
 
+zeerex2dc.xsl -- A stylesheet for presenting Dublin Core records.
+
 zeerex2id.xsl -- A trivial stylesheet that just yields the record
        identifier (not as an XML document).
 
@@ -73,9 +78,17 @@ records -- A subdirectory containing ZeeRex records to be added to the
 db -- A subdirectory containing the actual database: register files,
        dictionaries and suchlike.
 
-form.html -- a simple HTML search form that submits SRU queries to a
+form.html -- A simple HTML search form that submits SRU queries to a
        server running on local port 3313.
 
+init-script -- A startup/shutdown script for controlling the zebra
+       server according to "System V init" rules.
+
+crontab -- An example file that can be used to automate periodic
+       running of a test or tests.  This can be installed using:
+               sudo crontab crontab
+       But you probably want to edit it first.
+
 --
 
 To create the database and start the server:
@@ -86,6 +99,9 @@ zebraidx-2.0 update records # The many records harvested from Index Data
 zebraidx-2.0 commit
 zebrasrv-2.0 -f yazserver.xml
 
+To run all these commands, use:
+sed -n '/^zebraidx/,+3p' README | while read line; do eval $line; done
+
 Then interrogate the database with SRU URLs such as:
        http://localhost:3313/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru