- * Copyright (C) 1995, Index Data.
- * 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
+$Id: README,v 1.37 2001-10-25 12:28:07 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 YAZ library, which
+contains support functions for implementing the server or client
+role of Z39.50.
-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 build the software using Microsoft Visual C++.
-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
-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.
+On Unix, GNU configure is used to configure YAZ and generate Makefiles.
+Type "./configure", then "make" to build YAZ.
-Cli 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 by
-recompilation. Its primary purpose is to excersise the package, and
-verify that the protocol works OK. It can be started by typing
+Note: If you are using the CVS snapshot of YAZ you must have autoconf,
+automake and libtool installed. Before running configure, create
+support files by running buildconf.sh in the top-level directory of YAZ.
-cli tcp:<hostname>:<port>
+In any case refer to the documentation in sub directory doc or read
+it online at http://www.indexdata.dk/yaz/
-at the UNIX prompt, to connect to a Z39.50 server, or
+File organisation:
-cli osi:[<tsel>'/']<hostname>:<port>
+doc Documentation.
-to connect to an OSI SR target (this requires mOSI-support). To connect to
-the DANBIB test target, you might use:
+util Various little utility functions. Logging, memory debugging,
+ primitive ISO 2709 presentation for the yaz-client, etc. You'll
+ find the ASN.1 Compiler for YAZ here as well (yaz-comp).
-cli osi:0103/find2.denet.dk:4500
+odr Open Data Representation. This module implements the BER
+ encoding rules.
-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.
+z39.50 codecs for the Z39.50 protocol. This module 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).
-The directories:
+zutil This module implements a collection of Z39.50 utilities, such
+ as query parsing, etc.
-doc - Documentation.
+ill codesc for the ISO ILL protocol.
-util - Various little utility functions. Logging, memory debugging,
- primitive ISO 2709 presentation for the client, etc.
+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
+ TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006.
+ Look for documentation in the file comstack.man.
-odr - Open Data Representation. This module implements the BER
- encoding rules. Documentation is found in the files odr-use.man
- and odr.txt.
+zoom An implementation of Mike Taylors Z39.50 Object Oriented
+ Model : ZOOM. If you'd like to build Z39.50 client applications
+ in C this may be good start. You'll find example programs in
+ this directory too.
-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.
+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/yaz/backend.h).
-yazlib - 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
- TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006.
- Look for documentation in the file comstack.man.
+client A demonstration client for testing the protocol. It's bug'n
+ ugly. But, it supports many features.
-rfc1006 - Xtimosi requires an implementation of the OSI transport
- layer with an XTI-based API. Some systems (HP and DEC,
- notably) provide this. For others, we provide an
- implementation of the RFC1006 protocol (which is what
- ISODE-based implementations often use). This module is not
- neeeded if you don't use xtimosi, and it's not included in the
- libyaz.a library.
+ztest A demonstration server that implements a backend.
-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). See server.txt.
+include/yaz The various header files.
-include - The various header files.
+lib The libraries. Primarily libyaz.la. The makefile gathers the
+ libraries from previous modules into libyaz.la.
-makelib - This is a simple utility that gathers the libraries from the
- previous modules into libyaz.a.
+To get more information or assistance, send mail to yaz-help@indexdata.dk.
+Even better, sign on to the YAZ mailing list here:
+http://www.indexdata.dk/mailman/listinfo/yazlist
-lib - The libraries. Primarily libyaz.a.
projects / yaz-moved-to-github.git / blobdiff