use Carp ();
use Config;
-our $VERSION = '1.005001'; # 1.5.1
+our $VERSION = '1.006004'; # 1.6.4
our @KNOWN_FLAGS = qw(--self-contained);
=end testing
+=encoding utf8
+
=head1 NAME
local::lib - create and use a local lib/ for perl modules with PERL5LIB
A typical way to install local::lib is using what is known as the
"bootstrapping" technique. You would do this if your system administrator
hasn't already installed local::lib. In this case, you'll need to install
-local::lib in your home directory. If you do have administrative priveleges,
-you will still want to set up your environment variables, as discussed in
-step 4 (and for Windows users, see L</Differences when using this module under Win32>).
+local::lib in your home directory.
+
+If you do have administrative privileges, you will still want to set up your
+environment variables, as discussed in step 4. Without this, you would still
+install the modules into the system CPAN installation and also your Perl scripts
+will not use the lib/ path you bootstrapped with local::lib.
+
+Windows users must also see L</Differences when using this module under Win32>.
1. Download and unpack the local::lib tarball from CPAN (search for "Download"
on the CPAN page about local::lib). Do this as an ordinary user, not as root
If the system asks you whether it should automatically configure as much
as possible, you would typically answer yes.
-3. Run this:
+In order to install local::lib into a directory other than default, you need
+to give that directory on the call of bootstrap like this:
+
+ perl Makefile.PL --bootstrap=~/foo
+
+3. Run this: (local::lib assumes you have make installed on your system)
make test && make install
-4. Arrange for Perl to use your own packages instead of the system
-packages. If you are using bash, you can do this as follows:
+4. Now we need to setup the appropriate environment variables, so that Perl
+starts using our newly generated lib/ directory. If you are using bash or
+any other Bourne shells, you can add this to your shell startup script this
+way:
echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
/bin/csh
perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
-You can also pass --bootstrap=~/foo to get a different location -
-
- perl Makefile.PL --bootstrap=~/foo
- make test && make install
+If you passed to bootstrap a directory other than default, you also need to give that as
+import parameter to the call of the local::lib module like this way:
echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
After writing your shell configuration file, be sure to re-read it to get the
-changed settings into your current shell's environment. Bourne shells use C<.
-~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>. Replace .bashrc or
-.cshrc with the name of the file you wrote above with the echo command.
+changed settings into your current shell's environment. Bourne shells use
+C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
If you're on a slower machine, or are operating under draconian disk space
limitations, you can disable the automatic generation of manpages from POD when
perl Makefile.PL --bootstrap --no-manpages
-If you want to install multiple Perl module environments, say for application development,
-install local::lib globally and then:
+To avoid doing several bootstrap for several Perl module environments on the
+same account, for example if you use it for several different deployed
+applications independently, you can use one bootstrapped local::lib
+installation to install modules in different directories directly this way:
cd ~/mydir1
perl -Mlocal::lib=./
eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
- printenv ### You will see that ~/mydir1 is in the PERL5LIB
+ printenv ### You will see that ~/mydir1 is in the PERL5LIB
perl -MCPAN -e install ... ### whatever modules you want
cd ../mydir2
... REPEAT ...
set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
- ### To set the environment for this shell alone
+ ### To set the environment for this shell alone
C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
### instead of $(perl -Mlocal::lib=./)
directory is translated to a short name (which means the directory must exist)
and the subdirectories are created.
+=head2 Some bash script magic
+
+Usually you set up separate local::lib destinations for different projects.
+So either you need to remember to run
+C<< `eval $(perl -Mlocal::lib=~/llib/project)` >>
+each time you start working on project foo, or you add this line to your
+scripts:
+
+ use local::lib '~/llib/project';
+
+Instead of doing this, you could load some magic bash script via C<< ~/.bashrc >>:
+
+ [[ -s $HOME/.local-lib.bash ]] && source $HOME/.local-lib.bash
+
+Content of C<< $HOME/.local-lib.bash >>:
+
+ #!/usr/bin/env bash
+ cd() {
+ builtin cd "$@"
+ local cwd ; cwd=$(pwd)
+ unset PERL5LIB
+ if [[ -f "$cwd/.llrc" ]] ; then
+ eval $(perl -Mlocal::lib=`cat $cwd/.llrc`)
+ else
+ if [[ -f "~/.llrc" ]] ; then
+ eval $(perl -Mlocal::lib=`cat ~/.llrc`)
+ else
+ eval $(perl -Mlocal::lib)
+ fi
+ fi
+ }
+
+So you just drop a C<< .llrc >> into all of your projects folders containing the
+destination of your local::lib directory for the project. You can also create
+the file C<< .llrc >> in your home directory and put a default local::lib
+destination in there.
+
+See it in action:
+
+ ~# cat .llrc
+ ~/perl5/locallib/default
+
+ ~# cat Development/OpenSource/perl-beetle/.llrc
+ ~/perl5/locallib/perl-beetle
+
+ ~# env | grep PERL5
+ PERL5LIB=/Users/plu/perl5/locallib/default/lib/perl5/darwin-2level:/Users/plu/perl5/locallib/default/lib/perl5
+
+ ~# cd Development/OpenSource/perl-beetle/
+ ~/Development/OpenSource/perl-beetle# env | grep PERL5
+ PERL5LIB=/Users/plu/perl5/locallib/perl-beetle/lib/perl5/darwin-2level:/Users/plu/perl5/locallib/perl-beetle/lib/perl5
+
+ ~/Development/OpenSource/perl-beetle# cd
+ ~# env | grep PERL5
+ PERL5LIB=/Users/plu/perl5/locallib/default/lib/perl5/darwin-2level:/Users/plu/perl5/locallib/default/lib/perl5
+
=head1 RATIONALE
The version of a Perl package on your machine is not always the version you