Fixed Makefile(s).

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

diff --git a/README b/README
index 402f3e4..054c9bd 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +1,20 @@
 
 

- * Copyright (C) 1995, Index Data.
+ * Copyright (C) 1995-1998, Index Data.

  * See the file LICENSE for details.
  * Sebastian Hammer, Adam Dickmeiss
 
  * See the file LICENSE for details.
  * Sebastian Hammer, Adam Dickmeiss
 

-Compilation and installation
+Compilation and installation for YAZ 
+  $Id: README,v 1.19 1998-01-07 12:59:27 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.
 
 
 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.
 

-See doc/osi.txt for instructions on how to download and install Peter
-Furniss' ThinOSI-implementation, to provide YAZ with OSI support.
+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
 
 Two test-programs of interest are generated when you type 'make' at

-the top level. server/ztest and yazlib/cli. Ztest is a dummy database
+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.
 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.

@@ -27,16 +28,42 @@ client tcp:<hostname>:<port>
 
 at the UNIX prompt, to connect to a Z39.50 server, or
 
 
 at the UNIX prompt, to connect to a Z39.50 server, or
 

-cli osi:[<tsel>'/']<hostname>:<port>
+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:
 

-cli osi:0103/find2.denet.dk:4500
+client osi:0103/find2.denet.dk:4500

 
 

-CLI supports CCL-queries, with the mapping between qualifiers and
-attribute values specified in the file default.bib in the working
-directory. Use '?' to get a list of the available commands.
+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' | '@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.:
+
+Andersen
+
+"Hans Andersen"
+
+@and @attr 1=1 andersen @attr 1=4 @attr 4=2 duckling
+
+@attrset Bib-1 @and @attr GILS 2=2008 Washington @attr 1=21 weather

 
 The directories:
 
 
 The directories:
 

@@ -56,7 +83,7 @@ asn     - This module implements the Z39.50/SR protocol. The best way
        which defines structure and type definitions for each of the
        types introduced in the protocol specification.
 
        which defines structure and type definitions for each of the
        types introduced in the protocol specification.
 

-yazlib  - This module implements the transport transparency
+comstack- This module implements the transport transparency

        stack (COMSTACK). The comstack implements a generic interface
        for exchanging BER-encoded records over a network. It supports
        the 'American' mode of exchanging the records straight over
        stack (COMSTACK). The comstack implements a generic interface
        for exchanging BER-encoded records over a network. It supports
        the 'American' mode of exchanging the records straight over

@@ -79,9 +106,17 @@ 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.
 
 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
        previous modules into libyaz.a.
 
 lib     - The libraries. Primarily libyaz.a.
 include - The various header files.
 
 makelib - This is a simple utility that gathers the libraries from the
        previous modules into libyaz.a.
 
 lib     - The libraries. Primarily libyaz.a.

+
+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@indexdata.dk.