2 * Copyright (C) 1995-1997, Index Data.
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
6 Compilation and installation for YAZ
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
12 Windows programmers: refer to the file MSVC.txt which describes
13 how to compile the software using Microsoft Visual C++.
15 Two test-programs of interest are generated when you type 'make' at
16 the top level: ztest/ztest and client/client. 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.
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
26 client tcp:<hostname>:<port>
28 at the UNIX prompt, to connect to a Z39.50 server, or
30 client osi:[<tsel>'/']<hostname>:<port>
32 to connect to an OSI SR target (this requires mOSI-support). To connect to
33 the DANBIB test target, you might use:
35 client osi:0103/find2.denet.dk:4500
37 Use '?' to get a list of the available commands.
39 The current query language is a bit awkward, but functional:
41 query ::= ['@attrset' <attribute-set>] rpn
42 rpn ::= complex | simple | attr rpn
43 complex ::= operator rpn rpn
44 operator ::= '@and' | '@or' | '@not' | '@prox' proximity
45 simple ::= term | set.
46 term ::= <word> | '"' <term> ... '"'.
47 set ::= '@set' <setname>.
48 attr ::= '@attr' [<attribute-set>] <number> '=' <number>.
49 proximity ::= exclusion distance ordered relation which unit
50 exclusion ::= '1' | '0' | 'void'
54 which ::= 'known' | 'private'
63 @and @attr 1=1 andersen @attr 1=4 @attr 4=2 duckling
65 @attrset Bib-1 @and @attr GILS 2=2008 Washington @attr 1=21 weather
71 util - Various little utility functions. Logging, memory debugging,
72 primitive ISO 2709 presentation for the client, etc.
74 odr - Open Data Representation. This module implements the BER
75 encoding rules. Documentation is found in the files odr-use.man
78 asn - This module implements the Z39.50/SR protocol. The best way
79 to find out how it works is to look in the sample
80 client/server code in server/seshigh.c or yazlib/tst.c. The
81 interface is still wholly described by the file proto.h
82 which defines structure and type definitions for each of the
83 types introduced in the protocol specification.
85 comstack- This module implements the transport transparency
86 stack (COMSTACK). The comstack implements a generic interface
87 for exchanging BER-encoded records over a network. It supports
88 the 'American' mode of exchanging the records straight over
89 TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006.
90 Look for documentation in the file comstack.man.
92 rfc1006 - Xtimosi requires an implementation of the OSI transport
93 layer with an XTI-based API. Some systems (HP and DEC,
94 notably) provide this. For others, we provide an
95 implementation of the RFC1006 protocol (which is what
96 ISODE-based implementations often use). This module is not
97 neeeded if you don't use xtimosi, and it's not included in the
100 server - This is the implementation of the server frontend. It
101 provides event-handling and server managament functions,
102 and calls the backend primitives (best documentation of these
103 is in the file include/backend.h). See server.txt.
105 client - A demonstration client. If we come upon a good design for a
106 higher level client API, that will live here.
108 ztest - A demonstration server that implements a backend.
110 include - The various header files.
112 makelib - This is a simple utility that gathers the libraries from the
113 previous modules into libyaz.a.
115 lib - The libraries. Primarily libyaz.a.
117 To get more information or assistance, send mail to yaz-help@index.ping.dk.
119 We maintain a mailing-list for the purpose of announcing new versions of
120 the software, bug-reports, discussion etc. You can sign up by sending
121 mail to yaz-request@index.ping.dk.