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 See doc/osi.txt for instructions on how to download and install Peter
  13 Furniss' ThinOSI-implementation, to provide YAZ with OSI support.
  14
  15 Two test-programs of interest are generated when you type 'make' at
  16 the top level. server/ztest and yazlib/cli. Ztest is a dummy database
  17 server which returns canned responses to all queries. It's good for
  18 verifying that the protocol works ok, and ztest.c shows a minimalistic
  19 implementation of the 'backend' interface.
  20
  21 Client is a linemode Z39.50 client. It supports a fair amount of the
  22 functionality of Z39.50v2/SR, but some things you need to enable or disable
  23 by recompilation. Its primary purpose is to excersise the package, and
  24 verify that the protocol works OK. It can be started by typing
  25
  26 client tcp:<hostname>:<port>
  27
  28 at the UNIX prompt, to connect to a Z39.50 server, or
  29
  30 cli osi:[<tsel>'/']<hostname>:<port>
  31
  32 to connect to an OSI SR target (this requires mOSI-support). To connect to
  33 the DANBIB test target, you might use:
  34
  35 cli osi:0103/find2.denet.dk:4500
  36
  37 CLI supports CCL-queries, with the mapping between qualifiers and
  38 attribute values specified in the file default.bib in the working
  39 directory. Use '?' to get a list of the available commands.
  40
  41 The directories:
  42
  43 doc     - Documentation.
  44
  45 util    - Various little utility functions. Logging, memory debugging,
  46         primitive ISO 2709 presentation for the client, etc.
  47
  48 odr     - Open Data Representation. This module implements the BER
  49         encoding rules. Documentation is found in the files odr-use.man
  50         and odr.txt.
  51
  52 asn     - This module implements the Z39.50/SR protocol. The best way
  53         to find out how it works is to look in the sample
  54         client/server code in server/seshigh.c or yazlib/tst.c. The
  55         interface is still wholly described by the file proto.h
  56         which defines structure and type definitions for each of the
  57         types introduced in the protocol specification.
  58
  59 yazlib  - This module implements the transport transparency
  60         stack (COMSTACK). The comstack implements a generic interface
  61         for exchanging BER-encoded records over a network. It supports
  62         the 'American' mode of exchanging the records straight over
  63         TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006.
  64         Look for documentation in the file comstack.man.
  65
  66 rfc1006 - Xtimosi requires an implementation of the OSI transport
  67         layer with an XTI-based API. Some systems (HP and DEC,
  68         notably) provide this. For others, we provide an
  69         implementation of the RFC1006 protocol (which is what
  70         ISODE-based implementations often use). This module is not
  71         neeeded if you don't use xtimosi, and it's not included in the
  72         libyaz.a library.
  73
  74 server  - This is the implementation of the server frontend. It
  75         provides event-handling and server managament functions,
  76         and calls the backend primitives (best documentation of these
  77         is in the file include/backend.h). See server.txt.
  78
  79 client  - A demonstration client. If we come upon a good design for a
  80         higher level client API, that will live here.
  81
  82 include - The various header files.
  83
  84 makelib - This is a simple utility that gathers the libraries from the
  85         previous modules into libyaz.a.
  86
  87 lib     - The libraries. Primarily libyaz.a.