X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=README;h=8096b34ede3b81882d0c6b36aa45e69726234e84;hp=402f3e497f05da3b347b66885daabe87eefd0548;hb=4eec94579e5ca6f1121ed12ce26945ed23bbea74;hpb=1479cd42ce8537af61e2883d9567b0e13bd37197 diff --git a/README b/README index 402f3e4..8096b34 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ - * Copyright (C) 1995, Index Data. + * Copyright (C) 1995-1996, Index Data. * See the file LICENSE for details. * Sebastian Hammer, Adam Dickmeiss @@ -9,11 +9,8 @@ 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. @@ -27,16 +24,35 @@ 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 + +Use '?' to get a list of the available commands. + +The current query language is a bit awkward, but functional: + +query ::= ['@attrset' ] rpn +rpn ::= complex | simple | attr rpn +complex ::= operator rpn rpn +operator ::= '@and' | '@or' | '@not'. +simple ::= term | set. +term ::= | '"' ... '"'. +set ::= '@set' . +attr ::= '@attr' [] '=' . + +Eg.: -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. +Andersen + +"Hans Andersen" + +@and @attr 1=1 andersen @attr 1=4 @attr 4=2 duckling + +@attrset Bib-1 @and @attr GILS 2=2008 Washington @attr 1=21 weather The directories: @@ -56,7 +72,7 @@ asn - This module implements the Z39.50/SR protocol. The best way which defines structure and type definitions for each of the types introduced in the protocol specification. -yazlib - This module implements the transport transparency +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 @@ -85,3 +101,9 @@ makelib - This is a simple utility that gathers the libraries from the previous modules into libyaz.a. lib - The libraries. Primarily libyaz.a. + +To get more information or assistance, send mail to yaz-help@index.ping.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.