README

   1
   2  * Copyright (C) 1995, Index Data.
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5
   6 Compilation and installation
   7
   8 The primary output of the source here is the lib/libyaz.a library,
   9 which contains support functions for implementing the server or client
  10 role of Z39.50/SR.
  11
  12 Two test-programs of interest are generated when you type 'make' at
  13 the top level. server/ztest and client/client. Ztest is a dummy database
  14 server which returns canned responses to all queries. It's good for
  15 verifying that the protocol works ok, and ztest.c shows a minimalistic
  16 implementation of the 'backend' interface.
  17
  18 Client is a linemode Z39.50 client. It supports a fair amount of the
  19 functionality of Z39.50v2/SR, but some things you need to enable or disable
  20 by recompilation. Its primary purpose is to excersise the package, and
  21 verify that the protocol works OK. It can be started by typing
  22
  23 client tcp:<hostname>:<port>
  24
  25 at the UNIX prompt, to connect to a Z39.50 server, or
  26
  27 client osi:[<tsel>'/']<hostname>:<port>
  28
  29 to connect to an OSI SR target (this requires mOSI-support). To connect to
  30 the DANBIB test target, you might use:
  31
  32 client osi:0103/find2.denet.dk:4500
  33
  34 Use '?' to get a list of the available commands.
  35
  36 The current query language is a bit awkward, but functional:
  37
  38 query    ::= ['@attrset' <attribute-set>] rpn
  39 rpn      ::= complex | simple | attr rpn
  40 complex  ::= operator rpn rpn
  41 operator ::= '@and' | '@or' | '@not'.
  42 simple   ::= term | set.
  43 term     ::= <word> | '"' <term> ... '"'.
  44 set      ::= '@set' <setname>.
  45 attr     ::= '@attr' [<attribute-set>] <number> '=' <number>.
  46
  47 Eg.:
  48
  49 Andersen
  50
  51 "Hans Andersen"
  52
  53 @and @attr 1=1 andersen @attr 1=4 @attr 4=2 duckling
  54
  55 @attrset Bib-1 @and @attr GILS 2=2008 Washington @attr 1=21 weather
  56
  57 The directories:
  58
  59 doc     - Documentation.
  60
  61 util    - Various little utility functions. Logging, memory debugging,
  62         primitive ISO 2709 presentation for the client, etc.
  63
  64 odr     - Open Data Representation. This module implements the BER
  65         encoding rules. Documentation is found in the files odr-use.man
  66         and odr.txt.
  67
  68 asn     - This module implements the Z39.50/SR protocol. The best way
  69         to find out how it works is to look in the sample
  70         client/server code in server/seshigh.c or yazlib/tst.c. The
  71         interface is still wholly described by the file proto.h
  72         which defines structure and type definitions for each of the
  73         types introduced in the protocol specification.
  74
  75 comstack- This module implements the transport transparency
  76         stack (COMSTACK). The comstack implements a generic interface
  77         for exchanging BER-encoded records over a network. It supports
  78         the 'American' mode of exchanging the records straight over
  79         TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006.
  80         Look for documentation in the file comstack.man.
  81
  82 rfc1006 - Xtimosi requires an implementation of the OSI transport
  83         layer with an XTI-based API. Some systems (HP and DEC,
  84         notably) provide this. For others, we provide an
  85         implementation of the RFC1006 protocol (which is what
  86         ISODE-based implementations often use). This module is not
  87         neeeded if you don't use xtimosi, and it's not included in the
  88         libyaz.a library.
  89
  90 server  - This is the implementation of the server frontend. It
  91         provides event-handling and server managament functions,
  92         and calls the backend primitives (best documentation of these
  93         is in the file include/backend.h). See server.txt.
  94
  95 client  - A demonstration client. If we come upon a good design for a
  96         higher level client API, that will live here.
  97
  98 include - The various header files.
  99
 100 makelib - This is a simple utility that gathers the libraries from the
 101         previous modules into libyaz.a.
 102
 103 lib     - The libraries. Primarily libyaz.a.
 104
 105 To get more information or assistance, send mail to yaz-help@index.ping.dk.
 106
 107 We maintain a mailing-list for the purpose of announcing new versions of
 108 the software, bug-reports, discussion etc. You can sign up by sending
 109 mail to yaz-request@index.ping.dk.