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