Debian Codegraph @

libconcord/bindings/perl/README

raw
1 ==== BASIC INSTALLATION ====
2
3 0. INSTALL REQUIRED SOFTWARE
4
5 Swig is required to generate the perl bindings
6
7 1. GENERATE THE BINDINGS
8
9 $ swig -perl5 concord.i
10
11 2. BUILD THE BINDINGS
12
13 $ perl Makefile.PL
14 $ make
15
16 3. INSTALL THE BINDINGS
17
18 $ sudo make install
19
20
21 ==== USAGE ====
22
23 Simply use the module with:
24
25 use concord;
26
27 Then every call available in the C API is available to you. Various functions
28 are slightly modified to provide a more perlish feel. See
29 libconcord/bindings/perl/test.pl for an example.
30
31 NOTE: You do *NOT* need to call delete_key_names() in perl, and in fact, it's
32 not available.
33
34
35 ==== DIRECT USAGE ====
36
37 You can use the bindings from a non-system directory by specifying a
38 library path in your perl:
39
40 use lib '/path/to/perl/module';
41 use concord;
42
43 Or you can set your PERL5LIB environment variable:
44
45 PERL5LIB=/path/to/perl/module ./perl-script
46
47 Note that since this perl module has a compiled object associated with
48 it, if the .so file isn't installed in a system library directory, you will
49 need to set your LD_LIBRARY_PATH environment variable, or otherwise tell your
50 linker where to find it.
51