X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=README;h=0fce06f8494bf8ba33f14e3bb7abcef05915be42;hp=9f29dd6ae267c657082bdcc843a3563bfd245e0b;hb=df60350f9737923dce347e59b9c4cafa789ab7aa;hpb=99268f722648e84bf5c54eb685a1434e100f38a1 diff --git a/README b/README index 9f29dd6..0fce06f 100644 --- a/README +++ b/README @@ -1,92 +1,46 @@ +YAZ toolkit - * Copyright (C) 1995, Index Data. - * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss +Copyright (C) 1995-2015 Index Data. +See the file LICENSE for details. -Compilation and installation +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 SRU. -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. +On Unix, GNU configure is used to configure YAZ and generate Makefiles. +Type "./configure", then "make" to build YAZ. Read +doc/installation.unix.html for details. -The toplevel makefile contains directions on how to enable Peter -Furniss' XTIMOSI package. The package can be downloaded from -ftp://pluto.ulcc.ac.uk/ulcc/thinosi/... (or something close to that). -If you place the xtimosi directory on the same level as the yaz -directory, and simply follow the directions in the toplevel YAZ -makefile, the libmosi.a library from xtimosi should link in with no -problems. The xtimosi library is needed to support a full OSI stack, -but is *not* required to talk to American-style Z39.50 implementations -over TCP/IP. Don't worry about compiling the test applications in the -xtimosi package. Just do a "make libmosi.a", and do whatever is -required to make the compilation complete on your local ystem. +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. -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. +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. -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 +In any case refer to the documentation in sub directory doc or read +it online at http://www.indexdata.com/yaz/ -cli tcp:: +File organisation: -at the UNIX prompt, to connect to a Z39.50 server, or +doc Documentation. -cli osi:['/']: +src Source for the YAZ library. -to connect to an OSI SR target (this requires XTIMOSI). To connect to -the DANBIB test target, you might use: +util Utility programs, ASN.1 compiler, MARC dump utility, and others. -cli osi:0103/find2.denet.dk:4500 +client A demonstration client for testing the protocol. It's bug'n + ugly. But, it supports many features. -CLI supports CCL-queries, with the mapping between qualifiers and -attribute values specified in the file default.bib in the working -directory. +ztest A demonstration server that implements a backend. -The directories: +etc Various configuration files. -doc - Documentation. +include/yaz The various header files. -util - Various little utility functions. Logging, memory debugging, - primitive ISO 2709 presentation for the client, etc. +To get more information or assistance, send mail to yaz-help@indexdata.dk. +Even better, sign on to the YAZ mailing list here: +http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist -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. - -yazlib - This module primarily 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. - -rfc1006 - Xtimosi requires an implementation of the OSI transport - 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 - typically use). This module is not neeeded if you don't use - xtimosi. - -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 - 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.