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