Directive s=pw sets structure to phrase if term includes blank(s).

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

diff --git a/README b/README
index 4b7b088..ae0e61b 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,13 @@
 
 

- * Copyright (C) 1995-1999, Index Data ApS.
- * See the file LICENSE for details.
- * Sebastian Hammer, Adam Dickmeiss
+Copyright (C) 1995-2001, Index Data ApS.
+See the file LICENSE for details.

 
 

-Compilation and installation for YAZ 
-  $Id: README,v 1.27 1999-08-27 09:40:31 adam Exp $
+Compilation and installation instructions for YAZ 
+  $Id: README,v 1.34 2001-03-13 18:11:38 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
 
 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.
+role of Z39.50.

 
 Windows programmers: refer to the file windows.txt which describes how
 to build the software using Microsoft Visual C++.
 
 Windows programmers: refer to the file windows.txt which describes how
 to build the software using Microsoft Visual C++.

@@ -16,19 +15,23 @@ to build the software using Microsoft Visual C++.
 On Unix, GNU configure is used to configure YAZ and generate Makefiles.
 Type "./configure", then "make" to build YAZ.
 
 On Unix, GNU configure is used to configure YAZ and generate Makefiles.
 Type "./configure", then "make" to build YAZ.
 

+Note: If you are using the CVS snapshot of YAZ you must have autoconf,
+automake and libtool installed. Before running configure generate
+support files by running buildconf.sh which is part of YAZ.  
+

 Two test-programs of interest are generated when you type 'make' at the
 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 an
+top level: ztest/yaz-ztest and client/yaz-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 an

 implementation of a 'backend' interface.
 
 implementation of a 'backend' interface.
 

-Client is a linemode Z39.50 client. It supports a fair amount of the
+yaz-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>[/<database>]
+  yaz-client tcp:<hostname>:<port>[/<database>]

 
 at the UNIX prompt, to connect to a Z39.50 server.
 
 
 at the UNIX prompt, to connect to a Z39.50 server.
 

@@ -80,27 +83,22 @@ The directories:
 doc     - Documentation.
 
 util    - Various little utility functions. Logging, memory debugging,
 doc     - Documentation.
 
 util    - Various little utility functions. Logging, memory debugging,

-       primitive ISO 2709 presentation for the client, etc. You'll
+       primitive ISO 2709 presentation for the yaz-client, etc. You'll

        find the ASN.1 Compiler for YAZ here as well (yc.tcl).
 
 odr    - Open Data Representation. This module implements the BER
        encoding rules. Documentation is found in the files odr-use.man
        and odr.txt.
 
        find the ASN.1 Compiler for YAZ here as well (yc.tcl).
 
 odr    - Open Data Representation. This module implements the BER
        encoding rules. Documentation is found in the files odr-use.man
        and odr.txt.
 

-asn     - This module implements the Z39.50/SR protocol. The best way
-       to find out how it works is to look in the sample
-       client/server code in server/seshigh.c or yazlib/tst.c. The
-       interface is still wholly described by the file proto.h
-       which defines structure and type definitions for each of the
-       types introduced in the protocol specification.
-

 z39.50  - This module implements the Z39.50 protocol. This module
 z39.50  - This module implements the Z39.50 protocol. This module

-        does the same job as the 'asn' module except that the source
-        files are auto-generated using an YAZ' ASN.1 Compiler (YC).
+        does the same job as the old 'asn' module except that the source
+        files are auto-generated using an YAZ' ASN.1 Compiler (yaz-comp).

 
 zutil   - This module implements a collection of Z39.50 utilities, such
         as query parsing, EXTERNAL handling, etc.
 
 
 zutil   - This module implements a collection of Z39.50 utilities, such
         as query parsing, EXTERNAL handling, etc.
 

+ill     - This module implements the ISO ILL protocol.
+

 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
 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

@@ -119,19 +117,21 @@ rfc1006 - Xtimosi requires an implementation of the OSI transport
 server  - This is the implementation of the server frontend. It
        provides event-handling and server managament functions,
        and calls the backend primitives (best documentation of these
 server  - This is the implementation of the server frontend. It
        provides event-handling and server managament functions,
        and calls the backend primitives (best documentation of these

-       is in the file include/backend.h).
+       is in the file include/yaz/backend.h).

 
 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.
 
 
 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.
+include/yaz - 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. The makefile gathers the
+          libraries from previous modules into libyaz.a.

 
 

-lib     - The libraries. Primarily libyaz.a.
+asn     - Obsolete - replaced by the codecs in directory z39.50.
+        This module implements the Z39.50 protocol and is only provided
+        for backwareds compatibility. 

 
 To get more information or assistance, send mail to yaz-help@indexdata.dk.
 
 
 To get more information or assistance, send mail to yaz-help@indexdata.dk.