local::lib 1.006000

local::lib is a Perl module that provides a quick, convenient way of bootstrapping a user-local Perl module library located within the user's home directory. It also constructs and prints out for the user the list of environment variables using the syntax appropriate for the user's current shell (as specified by the SHELL environment variable), suitable for directly adding to one's shell configuration file.<br /><br />More generally, local::lib allows for the bootstrapping and usage of a directory containing Perl modules outside of Perl's @INC. This makes it easier to ship an application with an app-specific copy of a Perl module, or collection of modules. Useful in cases like when an upstream maintainer hasn't applied a patch to a module of theirs that you need for your application.<br /><br />On import, local::lib sets the following environment variables to appropriate values:<br /><br />MODULEBUILDRC<br />PERL_MM_OPT<br />PERL5LIB<br />PATH<br /><br /> PATH is appended to, rather than clobbered.<br /><br />These values are then available for reference by any code after import.<br /><br />SYNOPSIS<br /><br />In code -<br /><br /> use local::lib; # sets up a local lib at ~/perl5<br /><br /> use local::lib '~/foo'; # same, but ~/foo<br /><br /> # Or...<br /> use FindBin;<br /> use local::lib "$FindBin::Bin/../support"; # app-local support library<br /><br />From the shell -<br /><br /> # Install LWP and its missing dependencies to the '~/perl5' directory<br /> perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'<br /><br /> # Just print out useful shell commands<br /> $ perl -Mlocal::lib<br /> export MODULEBUILDRC=/home/username/perl/.modulebuildrc<br /> export PERL_MM_OPT='INSTALL_BASE=/home/username/perl'<br /> export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux'<br /> export PATH="/home/username/perl/bin:$PATH"

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Bootstrapping,  Directory,  Environment,  Export,  Importsynopsisin,  Lib,  Local,  Local Lib,  Locallib,  Mlocallib,  Module,  Modules,  Perl,  Reference,  Shell,  User,  Values,  Variables
Users rating:	0/10