New function: dict_delete.

[idzebra-moved-to-github.git] / doc / zebra.sgml

diff --git a/doc/zebra.sgml b/doc/zebra.sgml
index 2a748e5..a925992 100644 (file)
--- a/doc/zebra.sgml
+++ b/doc/zebra.sgml
@@ -1,13 +1,13 @@
 <!doctype linuxdoc system>
 
 <!--
 <!doctype linuxdoc system>
 
 <!--

-  $Id: zebra.sgml,v 1.5 1995-11-28 16:34:43 quinn Exp $
+  $Id: zebra.sgml,v 1.9 1995-12-01 11:37:31 adam Exp $

 -->
 
 <article>
 <title>Zebra Server - Administrators's Guide and Reference
 <author>Index Data, <tt/info@index.ping.dk/
 -->
 
 <article>
 <title>Zebra Server - Administrators's Guide and Reference
 <author>Index Data, <tt/info@index.ping.dk/

-<date>$Revision: 1.5 $
+<date>$Revision: 1.9 $

 <abstract>
 The Zebra information server combines a versatile fielded/free-text
 search engine with a Z39.50-1995 frontend to provide a powerful and flexible
 <abstract>
 The Zebra information server combines a versatile fielded/free-text
 search engine with a Z39.50-1995 frontend to provide a powerful and flexible

@@ -48,6 +48,9 @@ Profiles/, which is bundled with the YAZ documentation, to learn how
 records are formatted, and how you can configure Zebra to handle
 different types of Z39.50 application profiles.
 
 records are formatted, and how you can configure Zebra to handle
 different types of Z39.50 application profiles.
 

+If you are interested in using the software, you should join the support
+mailing-list by sending Email to <tt/zebra-request@index.ping.dk/.
+

 <sect1>Features
 
 <p>
 <sect1>Features
 
 <p>

@@ -405,6 +408,9 @@ explained further in the following sections.
 <tag>register</tag> 
  Specifies the location of the various files that Zebra uses to represent
  your system.
 <tag>register</tag> 
  Specifies the location of the various files that Zebra uses to represent
  your system.

+<tag>tempSetPath</tag>
+ Specifies the directory that the server uses for temporary result sets.
+ If not specified <tt>/tmp</tt> will be used.

 <tag>profilePath</tag>
  Specifies the location of profile specification paths.
 <tag>attset</tag> 
 <tag>profilePath</tag>
  Specifies the location of profile specification paths.
 <tag>attset</tag> 

@@ -451,6 +457,9 @@ simple.recordType: text
 simple.database: textbase
 </verb></tscreen>
 
 simple.database: textbase
 </verb></tscreen>
 

+Since the existing records in an index can not be addressed by their
+IDs, it is impossible to delete records when using this method.
+

 <sect1>Indexing with File Record IDs
 
 <p>
 <sect1>Indexing with File Record IDs
 
 <p>

@@ -499,6 +508,10 @@ index the group that
 the files should be indexed with file record IDs.
 </em>
 
 the files should be indexed with file record IDs.
 </em>
 

+You cannot explicitly delete records when using this method. Instead
+you have to delete the files from the file system (or remove them)
+and then run <tt>zebraidx</tt> with the <tt>update</tt> again.
+

 <sect1>Indexing with General Record IDs
 <p>
 When using this method you specify an (almost) arbritrary record key
 <sect1>Indexing with General Record IDs
 <p>
 When using this method you specify an (almost) arbritrary record key

@@ -523,7 +536,7 @@ extracted from the record. The syntax of this token is
  <tt/(/ <em/set/ <tt/,/ <em/use/ <tt/)/, where <em/set/ is the
 attribute set ordinal number and <em/use/ is the use value of the attribute.
 <tag>System variable</tag> The system variables are preceded by
  <tt/(/ <em/set/ <tt/,/ <em/use/ <tt/)/, where <em/set/ is the
 attribute set ordinal number and <em/use/ is the use value of the attribute.
 <tag>System variable</tag> The system variables are preceded by

-<tt>$</tt> and immediately followed by the system variable name, which
+<verb>$</verb> and immediately followed by the system variable name, which

 may one of
  <descrip>
  <tag>group</tag> Group name.
 may one of
  <descrip>
  <tag>group</tag> Group name.

@@ -554,6 +567,12 @@ with the <tt>update</tt> command. However, the update with general
 keys is considerably slower than with file record IDs, since all files
 visited must be (re)read to find their IDs. 
 
 keys is considerably slower than with file record IDs, since all files
 visited must be (re)read to find their IDs. 
 

+You may have noticed that when using the general record IDs
+method, you can only add or modify existing records with the <tt>update</tt>
+command. If you wish to delete records, you must use another command,
+<tt>delete</tt>, which a root directory as a parameter. This will remove
+all records that match the files below the root directory.
+

 <sect1>Register location
 
 <p>
 <sect1>Register location
 
 <p>

@@ -601,11 +620,6 @@ This is useful if you don't happen to know what attributes your client sends.
 
 Note that the server doesn't support the static mode (-S). 
 
 
 Note that the server doesn't support the static mode (-S). 
 

-<sect1>How the server handles queries
-<p>
-What elements of Bib-1 are supported and where are result sets
-stored.
-

 <sect>License
 
 <p>
 <sect>License
 
 <p>

@@ -680,6 +694,5 @@ Zebra, n., any of several horselike, African mammals of the genus Equus,
 having a characteristic pattern of black or dark-brown stripes on
 a whitish background.
 </it>
 having a characteristic pattern of black or dark-brown stripes on
 a whitish background.
 </it>

-<sect>References

 
 </article>
 
 </article>