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.21 1998-01-29 14:08:43 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 the
  17 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
  24 disable by recompilation. Its primary purpose is to excersise the
  25 package, and verify that the protocol works OK. It can be started
  26 by typing
  27
  28 client tcp:<hostname>:<port>
  29
  30 at the UNIX prompt, to connect to a Z39.50 server, or
  31
  32 client osi:[<tsel>'/']<hostname>:<port>
  33
  34 to connect to an OSI SR target (this requires mOSI-support). To connect
  35 to the DANBIB test target, you might use:
  36
  37 client osi:0103/find2.denet.dk:4500
  38
  39 Use '?' to get a list of the available commands.
  40
  41 The current query language for the find command is a bit awkward, but
  42 functional:
  43
  44 query     ::= ['@attrset' <attribute-set>] rpn
  45 rpn       ::= complex | simple | attr rpn
  46 complex   ::= operator rpn rpn
  47 operator  ::= '@and' | '@or' | '@not' | '@prox' proximity
  48 simple    ::= term | set.
  49 term      ::= <word> | '"' <term> ... '"'.
  50 set       ::= '@set' <setname>.
  51 attr      ::= '@attr' [<attribute-set>] <number> '=' <number>.
  52 proximity ::= exclusion distance ordered relation which unit
  53 exclusion ::= '1' | '0' | 'void'
  54 distance  ::= <number>
  55 ordered   ::= '1' | '0'
  56 relation  ::= <number>
  57 which     ::= 'known' | 'private'
  58 unit      ::= <number>
  59
  60 Eg.:
  61
  62 Andersen
  63
  64 "Hans Andersen"
  65
  66 @and @attr 1=1 andersen @attr 1=4 @attr 4=2 duckling
  67
  68 @attrset Bib-1 @and @attr GILS 2=2008 Washington @attr 1=21 weather
  69
  70 The sort command takes a sequence of sort specifications. A sort
  71 specification holds a field (sort criteria) and is followed by flags.
  72 If the sort critieria includes = it is assumed that the sort SortKey
  73 is of type sortAttributes using Bib-1. The integer before the = is
  74 the attribute type and the integer following the = is the attribute
  75 value. If no = is in the SortKey it is treated as a sortfield-type
  76 of type InternationalString. Flags observed are s (sort case
  77 sensitive), i (sort case insensitive), < (ascending), > (descending).
  78 Eg.:
  79    1=4   i>                  (use is title, insensitive, ascending).
  80    Title s<                  (String Title, sensitive, descending).
  81
  82 The directories:
  83
  84 doc     - Documentation.
  85
  86 util    - Various little utility functions. Logging, memory debugging,
  87         primitive ISO 2709 presentation for the client, etc.
  88
  89 odr     - Open Data Representation. This module implements the BER
  90         encoding rules. Documentation is found in the files odr-use.man
  91         and odr.txt.
  92
  93 asn     - This module implements the Z39.50/SR protocol. The best way
  94         to find out how it works is to look in the sample
  95         client/server code in server/seshigh.c or yazlib/tst.c. The
  96         interface is still wholly described by the file proto.h
  97         which defines structure and type definitions for each of the
  98         types introduced in the protocol specification.
  99
 100 comstack- This module implements the transport transparency
 101         stack (COMSTACK). The comstack implements a generic interface
 102         for exchanging BER-encoded records over a network. It supports
 103         the 'American' mode of exchanging the records straight over
 104         TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006.
 105         Look for documentation in the file comstack.man.
 106
 107 rfc1006 - Xtimosi requires an implementation of the OSI transport
 108         layer with an XTI-based API. Some systems (HP and DEC,
 109         notably) provide this. For others, we provide an
 110         implementation of the RFC1006 protocol (which is what
 111         ISODE-based implementations often use). This module is not
 112         neeeded if you don't use xtimosi, and it's not included in the
 113         libyaz.a library.
 114
 115 server  - This is the implementation of the server frontend. It
 116         provides event-handling and server managament functions,
 117         and calls the backend primitives (best documentation of these
 118         is in the file include/backend.h). See server.txt.
 119
 120 client  - A demonstration client. If we come upon a good design for a
 121         higher level client API, that will live here.
 122
 123 ztest   - A demonstration server that implements a backend.
 124
 125 include - The various header files.
 126
 127 makelib - This is a simple utility that gathers the libraries from the
 128         previous modules into libyaz.a.
 129
 130 lib     - The libraries. Primarily libyaz.a.
 131
 132 To get more information or assistance, send mail to yaz-help@indexdata.dk.
 133
 134 We maintain a mailing-list for the purpose of announcing new versions of
 135 the software, bug-reports, discussion etc. You can sign up by sending
 136 mail to yaz-request@indexdata.dk and include the following command
 137 command in your email:
 138     subscribe yaz-l
 139