2 Copyright (C) 1995-2001, Index Data ApS.
3 See the file LICENSE for details.
5 $Id: README,v 1.37 2001-10-25 12:28:07 adam Exp $
7 The primary output of the source here is the YAZ library, which
8 contains support functions for implementing the server or client
11 Windows programmers: refer to the file windows.txt which describes how
12 to build the software using Microsoft Visual C++.
14 On Unix, GNU configure is used to configure YAZ and generate Makefiles.
15 Type "./configure", then "make" to build YAZ.
17 Note: If you are using the CVS snapshot of YAZ you must have autoconf,
18 automake and libtool installed. Before running configure, create
19 support files by running buildconf.sh in the top-level directory of YAZ.
21 In any case refer to the documentation in sub directory doc or read
22 it online at http://www.indexdata.dk/yaz/
28 util Various little utility functions. Logging, memory debugging,
29 primitive ISO 2709 presentation for the yaz-client, etc. You'll
30 find the ASN.1 Compiler for YAZ here as well (yaz-comp).
32 odr Open Data Representation. This module implements the BER
35 z39.50 codecs for the Z39.50 protocol. This module does the same job
36 as the old 'asn' module except that the source files are
37 auto-generated using an YAZ' ASN.1 Compiler (yaz-comp).
39 zutil This module implements a collection of Z39.50 utilities, such
40 as query parsing, etc.
42 ill codesc for the ISO ILL protocol.
44 comstack This module implements the transport transparency
45 stack (COMSTACK). The comstack implements a generic interface
46 for exchanging BER-encoded records over a network. It supports
47 the 'American' mode of exchanging the records straight over
48 TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006.
49 Look for documentation in the file comstack.man.
51 zoom An implementation of Mike Taylors Z39.50 Object Oriented
52 Model : ZOOM. If you'd like to build Z39.50 client applications
53 in C this may be good start. You'll find example programs in
56 server This is the implementation of the server frontend. It
57 provides event-handling and server managament functions,
58 and calls the backend primitives (best documentation of these
59 is in the file include/yaz/backend.h).
61 client A demonstration client for testing the protocol. It's bug'n
62 ugly. But, it supports many features.
64 ztest A demonstration server that implements a backend.
66 include/yaz The various header files.
68 lib The libraries. Primarily libyaz.la. The makefile gathers the
69 libraries from previous modules into libyaz.la.
71 To get more information or assistance, send mail to yaz-help@indexdata.dk.
72 Even better, sign on to the YAZ mailing list here:
73 http://www.indexdata.dk/mailman/listinfo/yazlist