Note IRSpy's need for the libindexdata-utils-perl Debian package.
[irspy-moved-to-github.git] / README
1 ZOOM::IRSpy
2 ===========
3
4 This module exists to implement the IRspy program, which discovers,
5 analyses and monitors IR servers implementing the Z39.50 and SRU/W
6 protocols.  It is a successor to the ZSpy program.
7
8 INSTALLATION
9
10 for debian/ubuntu:
11 -------------------
12
13 DEBIAN DEPENDENCIES
14
15 If you have a Debian-based operating system, you can get what you need
16 by installing the following packages from the operating system's
17 package store, using apt-get:
18
19 sudo apt-get install \
20         libindexdata-utils-perl \
21         libnet-z3950-zoom-perl \
22         libxml-libxml-perl \
23         liburi-perl \
24         libxml-libxml-perl \
25         libapache2-mod-perl2 \
26         libhtml-mason-perl \
27         libapache2-request-perl \
28         libapache2-mod-apreq2 \
29         libxml-libxslt-perl \
30         idzebra-2.0 \
31         time
32
33 you may need one of the following packages for development:
34
35 sudo apt-get install \
36         make perl-doc libxml2-utils tidy yaz libyaz4-dev 
37
38 and may enable mod_apreq: sudo a2enmod apreq
39
40 Note: mod_perl works only safe without threads. Please use the non-threaded 
41 debian package: sudo apt-get install apache2-mpm-prefork
42
43
44 To install this module type the following:
45
46    perl Makefile.PL
47    make
48    make test
49    make install
50
51 DEPENDENCIES
52
53 This module requires these other modules and libraries, in addition to
54 those specified in Makefile.PL:
55
56   Zebra, release 2.0 or later: see http://www.indexdata.com/zebra/
57
58 COPYRIGHT AND LICENCE
59
60 Copyright (C) 2006-2010 by Index Data ApS.
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.7 or,
64 at your option, any later version of Perl 5 you may have available.
65
66 --
67
68 Notes to self: everyone else please ignore these
69
70 $ cd /usr/local/src/cvs/irspy && YAZ_LOG=irspy,irspy_test,irspy_debug,pod perl -I lib bin/irspy.pl -t "bagel.indexdata.dk/gils foo.bar.baz:12345/fish z3950.loc.gov:7090/Voyager" localhost:8018/IR-Explain---1
71
72 To get a list of all Danish domains in the database:
73 .../ZOOM-Perl/samples/zoom/zselect -t q localhost:8018/IR-Explain---1 'net.host = *.dk' //zeerex:host
74