X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=README;h=0fce06f8494bf8ba33f14e3bb7abcef05915be42;hp=889f14ac98f350e956e01ab2c6cef7e777e39601;hb=bb84694ae5b1951689fe049bef536e5a73deb208;hpb=4d531a1a9131d69c3b6c27fbac42837e22cff61c diff --git a/README b/README index 889f14a..0fce06f 100644 --- a/README +++ b/README @@ -1,81 +1,46 @@ -YAZ toolkit - $Id: README,v 1.42 2003-01-06 08:20:26 adam Exp $ +YAZ toolkit -Copyright (C) 1995-2003, Index Data ApS. +Copyright (C) 1995-2015 Index Data. See the file LICENSE for details. 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 and SRW. - -Windows programmers: refer to the file windows.txt which describes how -to build the software using Microsoft Visual C++. +role of Z39.50 and SRU. On Unix, GNU configure is used to configure YAZ and generate Makefiles. -Type "./configure", then "make" to build YAZ. +Type "./configure", then "make" to build YAZ. Read +doc/installation.unix.html for details. + +On Windows, a MS Visual Studio makefile is provided (nmake). The commands + cd \win + nmake +should do. Refer to doc/installation.win32.html for details. -Note: If you are using the CVS snapshot of YAZ you must have autoconf, -automake and libtool installed. Before running configure, create +Note: If you are using the Git snapshot of YAZ you must have autoconf, +automake, libtool and xsltproc installed. Before running configure, create support files by running buildconf.sh in the top-level directory of YAZ. In any case refer to the documentation in sub directory doc or read -it online at http://www.indexdata.dk/yaz/ +it online at http://www.indexdata.com/yaz/ File organisation: doc Documentation. -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). - -odr Open Data Representation. This module implements the BER - encoding rules. - -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). - -zutil This module implements a collection of Z39.50 utilities, such - as query parsing, etc. - -ill Codecs for 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 - 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. +src Source for the YAZ library. -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. - -server This is the implementation of the Z39.50 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). - -ccl CCL parser. - -cql CQL parser. - -srw SRW support (based on gSOAP). - -srwapps SRW applicaions, most notably a SRW-to-Z39.50 gateway. +util Utility programs, ASN.1 compiler, MARC dump utility, and others. client A demonstration client for testing the protocol. It's bug'n ugly. But, it supports many features. ztest A demonstration server that implements a backend. -include/yaz The various header files. +etc Various configuration files. -lib The libraries. Primarily libyaz.la. The makefile gathers the - libraries from previous modules into libyaz.la. +include/yaz The various header files. 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 +http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist