X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=README;h=bc365da4cf46391ac5dfecf49dde6ddc3787a639;hp=2597288cfac3125879a8153185dbf2cf714a4a7e;hb=0abf92a5ba3132c9727bec630ed1f04bc51b4f04;hpb=28df1d8cbdbee7b3e9b5a23e340e63c7b852841c diff --git a/README b/README index 2597288..bc365da 100644 --- a/README +++ b/README @@ -9,32 +9,29 @@ 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. -See doc/osi.txt for instructions on how to download and install Peter -Furniss' ThinOSI-implementation, to provide YAZ with OSI support. - 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 +the top level. server/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 a minimalistic implementation of the 'backend' interface. -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 +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 -cli tcp:: +client tcp:: at the UNIX prompt, to connect to a Z39.50 server, or -cli osi:['/']: +client osi:['/']: to connect to an OSI SR target (this requires mOSI-support). To connect to the DANBIB test target, you might use: -cli osi:0103/find2.denet.dk:4500 +client osi:0103/find2.denet.dk:4500 -CLI supports CCL-queries, with the mapping between qualifiers and +Client 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. @@ -76,6 +73,9 @@ server - This is the implementation of the server frontend. It and calls the backend primitives (best documentation of these is in the file include/backend.h). See server.txt. +client - A demonstration client. If we come upon a good design for a + higher level client API, that will live here. + include - The various header files. makelib - This is a simple utility that gathers the libraries from the