X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=README;h=ae0e61ba017d740fe8d4a6d4873acf29dbcd0adf;hp=a4005892a8678076279023397f2033817fb25203;hb=59526fbbf2e3b54ce94b3e79e6c7fef9e4f456fb;hpb=30cfc59b71c25923e2e9cfb63c310c095bb3b6c1 diff --git a/README b/README index a400589..ae0e61b 100644 --- a/README +++ b/README @@ -1,13 +1,13 @@ -Copyright (C) 1995-1999, Index Data ApS. +Copyright (C) 1995-2001, Index Data ApS. See the file LICENSE for details. Compilation and installation instructions for YAZ - $Id: README,v 1.28 1999-12-02 13:54:56 adam Exp $ + $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 -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++. @@ -15,6 +15,10 @@ 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. +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 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 @@ -86,20 +90,15 @@ 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 - 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. +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 @@ -118,18 +117,22 @@ 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 - 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. -include - The various header files. +include/yaz - The various header files. lib - The libraries. Primarily libyaz.a. The makefile gathers the libraries from previous modules into 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. We maintain a mailing-list for the purpose of announcing new versions of