README

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