Perl Library Mechanics – 6 ways to add a library path
Perl Library Mechanics – 6 ways to add a library path
A ncode solutions technology guide – visit us at http://www.ncode.ch
Objectives
Run a perl script using libraries in nonstandard locations.
We use the location /opt/special/plib for our samples.
Perl uses by default the array @INC as include path when searching for modules to load.
This path is
compiled into the perl binary when building it from source and can be printed by running
perl -V
, which will show something like:
..
Compiled at Jan 24 2004 21:39:16
@INC:
/etc/perl
/usr/lib/perl5/site_perl/5.8.0/i686-linux
/usr/lib/perl5/site_perl/5.8.0
/usr/lib/perl5/site_perl/5.6.1
..
1. Using the module lib
The standard module lib can be used to specify an explicit path to include. It must be stated at the
top
of the script:
#!/usr/bin/perl
#
use lib “/opt/special/plib”;
use strict;
use warnings;
..
2. Using the switch I at the command line
The switch I can be used to specify additional library locations when invoking the interpreter.
perl -I /opt/special/plib script.pl
23.09.2005 / Oli Kessler / info@ncode.ch © 2005 ncode solutions GmbH
Page 2
3. Using the switch I in the first line of the script
The same I switch can be added to the interpreter specification.
#!/usr/bin/perl -I /opt/special/plib
#
use strict;
use warnings;
..
This works when invoking the script via the shell (which will run the interpreter with full
options and arguments as specified in the first line) and also when invoking the interpreter
directly: It apparently scans the first line for options.
4. Manipulating @INC directly
The array @INC can be manipulated directly using array operations
#!/usr/bin/perl
#
BEGIN {
unshift(@INC, “/opt/special/plib”);
}
use strict;
use warnings;
This is the same as using the module lib, which in fact does something like this.
5. Using the environment variable PERL5LIB
The environment variable PERL5LIB can be used to specify additional include directories when
running a perl script.
> export PERL5LIB=/opt/special/plib
> /path/to/script.pl
6. Changing @INC at compile time
When running
Configure
to compile the perl interpreter itself, there are several possibilities to add
additional library path elements:
•
Using the variable vendorprefix
•
Using the variable otherlibdirs
Both must be specified when calling Configure as a define, eg
> sh Configure -Dotherlibdirs=/opt/special/plib
The variable otherlibdirs is preferred, as it can hold mutliple values separated by a colon just like
the familiar PATH environment variable.
Details about compiling perl can be found on the CPAN network :