README

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