documentation cleanup
[irspy-moved-to-github.git] / README
1 $Id: README,v 1.6 2007-04-18 15:22:48 mike Exp $
2
3 ZOOM::IRSpy
4 ===========
5
6 This module exists to implement the IRspy program, which discovers,
7 analyses and monitors IR servers implementing the Z39.50 and SRU/W
8 protocols.  It is a successor to the ZSpy program.
9
10 INSTALLATION
11
12 for debian/ubuntu:
13 -------------------
14
15 DEBIAN DEPENDENCIES
16
17 If you have a Debian-based operating system, you can get what you need
18 by installing the following packages from the operating system's
19 package store, using apt-get:
20
21 sudo apt-get install \
22         libnet-z3950-zoom-perl \
23         libxml-libxml-common-perl \
24         liburi-perl \
25         libxml-libxml-perl \
26         libapache2-mod-perl2 \
27         libhtml-mason-perl \
28         libapache2-request-perl \
29         libapache2-mod-apreq2 \
30         libxml-libxslt-perl \
31         idzebra-2.0 \
32
33 you may need one of the following packages for development:
34
35 sudo apt-get install \
36         make perl-doc
37
38
39
40 To install this module type the following:
41
42    perl Makefile.PL
43    make
44    make test
45    make install
46
47 DEPENDENCIES
48
49 This module requires these other modules and libraries, in addition to
50 those specified in Makefile.PL:
51
52   Zebra, release 1.4.0 or later: see http://indexdata.com/zebra/
53
54 COPYRIGHT AND LICENCE
55
56 Copyright (C) 2006 by Index Data ApS.
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.7 or,
60 at your option, any later version of Perl 5 you may have available.
61
62 --
63
64 Notes to self: everyone else please ignore these
65
66 $ 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
67
68 To get a list of all Danish domains in the database:
69 .../ZOOM-Perl/samples/zoom/zselect -t q localhost:8018/IR-Explain---1 'net.host = *.dk' //zeerex:host
70