README.md

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