Fixed bug in inetd code. The server listened on tcp:@:9999 even

[yaz-moved-to-github.git] / README

diff --git a/README b/README
index 5079588..79ec0a5 100644 (file)
--- a/README
+++ b/README
@@ -1,24 +1,29 @@
 
- * Copyright (C) 1995, Index Data.
+ * Copyright (C) 1995-1998, Index Data.
  * See the file LICENSE for details.
  * Sebastian Hammer, Adam Dickmeiss
 
-Compilation and installation
+Compilation and installation for YAZ 
+  $Id: README,v 1.21 1998-01-29 14:08:43 adam Exp $
 
 The primary output of the source here is the lib/libyaz.a library,
 which contains support functions for implementing the server or client
 role of Z39.50/SR.
 
-Two test-programs of interest are generated when you type 'make' at
-the top level. server/ztest and client/client. Ztest is a dummy database
+Windows programmers: refer to the file windows.txt which describes
+how to compile the software using Microsoft Visual C++.
+
+Two test-programs of interest are generated when you type 'make' at the
+top level: ztest/ztest and client/client. Ztest is a dummy database
 server which returns canned responses to all queries. It's good for
 verifying that the protocol works ok, and ztest.c shows a minimalistic
 implementation of the 'backend' interface.
 
 Client is a linemode Z39.50 client. It supports a fair amount of the
-functionality of Z39.50v2/SR, but some things you need to enable or disable
-by recompilation. Its primary purpose is to excersise the package, and
-verify that the protocol works OK. It can be started by typing
+functionality of Z39.50v2/SR, but some things you need to enable or
+disable by recompilation. Its primary purpose is to excersise the
+package, and verify that the protocol works OK. It can be started
+by typing
 
 client tcp:<hostname>:<port>
 
@@ -26,23 +31,31 @@ at the UNIX prompt, to connect to a Z39.50 server, or
 
 client osi:[<tsel>'/']<hostname>:<port>
 
-to connect to an OSI SR target (this requires mOSI-support). To connect to
-the DANBIB test target, you might use:
+to connect to an OSI SR target (this requires mOSI-support). To connect
+to the DANBIB test target, you might use:
 
 client osi:0103/find2.denet.dk:4500
 
 Use '?' to get a list of the available commands.
 
-The current query language is a bit awkward, but functional:
-
-query    ::= ['@attrset' <attribute-set>] rpn
-rpn      ::= complex | simple | attr rpn
-complex  ::= operator rpn rpn
-operator ::= '@and' | '@or' | '@not'.
-simple   ::= term | set.
-term     ::= <word> | '"' <term> ... '"'.
-set      ::= '@set' <setname>.
-attr     ::= '@attr' [<attribute-set>] <number> '=' <number>.
+The current query language for the find command is a bit awkward, but
+functional:
+
+query     ::= ['@attrset' <attribute-set>] rpn
+rpn       ::= complex | simple | attr rpn
+complex   ::= operator rpn rpn
+operator  ::= '@and' | '@or' | '@not' | '@prox' proximity
+simple    ::= term | set.
+term      ::= <word> | '"' <term> ... '"'.
+set       ::= '@set' <setname>.
+attr      ::= '@attr' [<attribute-set>] <number> '=' <number>.
+proximity ::= exclusion distance ordered relation which unit
+exclusion ::= '1' | '0' | 'void'
+distance  ::= <number>
+ordered   ::= '1' | '0'
+relation  ::= <number>
+which     ::= 'known' | 'private'
+unit      ::= <number>
 
 Eg.:
 
@@ -54,6 +67,18 @@ Andersen
 
 @attrset Bib-1 @and @attr GILS 2=2008 Washington @attr 1=21 weather
 
+The sort command takes a sequence of sort specifications. A sort
+specification holds a field (sort criteria) and is followed by flags.
+If the sort critieria includes = it is assumed that the sort SortKey
+is of type sortAttributes using Bib-1. The integer before the = is
+the attribute type and the integer following the = is the attribute
+value. If no = is in the SortKey it is treated as a sortfield-type
+of type InternationalString. Flags observed are s (sort case
+sensitive), i (sort case insensitive), < (ascending), > (descending).
+Eg.:
+   1=4   i>                  (use is title, insensitive, ascending).
+   Title s<                  (String Title, sensitive, descending).
+
 The directories:
 
 doc     - Documentation.
@@ -95,6 +120,8 @@ server  - This is the implementation of the server frontend. It
 client  - A demonstration client. If we come upon a good design for a
        higher level client API, that will live here.
 
+ztest   - A demonstration server that implements a backend.
+
 include - The various header files.
 
 makelib - This is a simple utility that gathers the libraries from the
@@ -102,8 +129,11 @@ makelib - This is a simple utility that gathers the libraries from the
 
 lib     - The libraries. Primarily libyaz.a.
 
-To get more information or assistance, send mail to yaz-help@index.ping.dk.
+To get more information or assistance, send mail to yaz-help@indexdata.dk.
 
 We maintain a mailing-list for the purpose of announcing new versions of
 the software, bug-reports, discussion etc. You can sign up by sending
-mail to yaz-request@index.ping.dk.
+mail to yaz-request@indexdata.dk and include the following command
+command in your email:
+    subscribe yaz-l
+