README

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