README

   1 $Id: README,v 1.5 2006-04-07 12:00:31 mike Exp $
   2
   3 The Net::Z3950::ZOOM, ZOOM and Net::Z3950 modules
   4 =================================================
   5
   6 This distribution contains three Perl modules for the price of one.
   7 They all provide facilities for building information retrieval clients
   8 using the standard Z39.50 and SRW/U protocols, but do so using
   9 different APIs.
  10
  11 - If you are new to this distribution, then you should use the ZOOM
  12   API, and ignore the others.  It is the cleanest, most elegant and
  13   intuitive, and most closely follows the letter as well as the spirit
  14   of the Abstract ZOOM API as specified at http://zoom.z3950.org/api/
  15
  16 - If you have used the old Net::Z3950 module and have to maintain an
  17   application that calls that API, then you will want to use the
  18   Net::Z3950 classes provided in this distribution, which provide an
  19   API compatible with the old module's implemented on top of the new
  20   ZOOM code.
  21
  22 - You should definitely not use the Net::Z3950::ZOOM API, which is not
  23   object-oriented, and instead provides the thinnest possible layer on
  24   top of the ZOOM-C functions in the YAZ toolkit.  This API exists
  25   only in order to have ZOOM API built on top of it.
  26
  27
  28 INSTALLATION
  29
  30 To install this module type the following:
  31
  32    perl Makefile.PL
  33    make
  34    make test
  35    make install
  36
  37
  38 DEPENDENCIES
  39
  40 This module requires these other modules and libraries:
  41
  42 - The YAZ toolkit for Z39.50 and SRW/U communication.  This is
  43   available as a package on several platform -- for example, Debian
  44   GNU/Linux supports "apt-get install yaz".  For others, you will need
  45   to download and build the source-code, which is much more
  46   straightforward that you probably expect.  You can get it from
  47   http://indexdata.com/yaz/
  48
  49   NOTE THAT THE ZOOM-Perl MODULE ABSOLUTELY REQUIRES RELEASE 2.0.11 OR
  50   BETTER OF THE YAZ TOOLKIT.  You need version 2.1.17 or better if you
  51   want to run clever asynchronous programs that use the END event,
  52   which did not exist prior to that release.
  53
  54 COPYRIGHT AND LICENCE
  55
  56 Copyright (C) 2005 by Index Data.
  57
  58 This library is free software; you can redistribute it and/or modify
  59 it under the same terms as Perl itself, either Perl version 5.8.4 or,
  60 at your option, any later version of Perl 5 you may have available.
  61
  62