X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=README;h=2521a65db8d569cb55718feadbbf31b2094129a8;hp=dd7207a87c8ed4d5778368cc6457141337d9b8ff;hb=8030536c98d595898b316df5eb118b1d6398450c;hpb=beea0cfaabaad70258dcaaa6b082a324e8f7e60f diff --git a/README b/README index dd7207a..2521a65 100644 --- a/README +++ b/README @@ -1,28 +1,32 @@ - * Copyright (C) 1995-1997, Index Data. + * Copyright (C) 1995-1998, Index Data. * See the file LICENSE for details. * Sebastian Hammer, Adam Dickmeiss Compilation and installation for YAZ - $Id: README,v 1.18 1997-09-18 08:47:17 adam Exp $ + $Id: README,v 1.23 1998-09-22 09:41:21 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. -Windows programmers: refer to the file MSVC.txt which describes +Windows programmers: refer to the file windows.txt which describes how to compile the software using Microsoft Visual C++. -Two test-programs of interest are generated when you type 'make' at -the top level: ztest/ztest and client/client. Ztest is a dummy database +On Unix, GNU configure is used to configure YAZ and generate Makefiles. +Type "./configure", then "make" to build YAZ. + +Two test-programs of interest are generated when you type 'make' at the +top level: ztest/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. 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 +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 client tcp:: @@ -30,14 +34,15 @@ at the UNIX prompt, to connect to a Z39.50 server, or client osi:['/']: -to connect to an OSI SR target (this requires mOSI-support). To connect to -the DANBIB test target, you might use: +to connect to an OSI SR target (this requires mOSI-support). To connect +to the DANBIB test target, you might use: client osi:0103/find2.denet.dk:4500 Use '?' to get a list of the available commands. -The current query language is a bit awkward, but functional: +The current query language for the find command is a bit awkward, but +functional: query ::= ['@attrset' ] rpn rpn ::= complex | simple | attr rpn @@ -65,6 +70,18 @@ Andersen @attrset Bib-1 @and @attr GILS 2=2008 Washington @attr 1=21 weather +The sort command takes a sequence of sort specifications. A sort +specification holds a field (sort criteria) and is followed by flags. +If the sort critieria includes = it is assumed that the sort SortKey +is of type sortAttributes using Bib-1. The integer before the = is +the attribute type and the integer following the = is the attribute +value. If no = is in the SortKey it is treated as a sortfield-type +of type InternationalString. Flags observed are s (sort case +sensitive), i (sort case insensitive), < (ascending), > (descending). +Eg.: + 1=4 i< (use is title, insensitive, ascending). + Title s> (String Title, sensitive, descending). + The directories: doc - Documentation. @@ -101,7 +118,7 @@ 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). See server.txt. + is in the file include/backend.h). client - A demonstration client. If we come upon a good design for a higher level client API, that will live here. @@ -115,8 +132,11 @@ makelib - This is a simple utility that gathers the libraries from the lib - The libraries. Primarily libyaz.a. -To get more information or assistance, send mail to yaz-help@index.ping.dk. +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 the software, bug-reports, discussion etc. You can sign up by sending -mail to yaz-request@index.ping.dk. +mail to yaz-request@indexdata.dk and include the following command +command in your email: + subscribe yaz-l +