6 use 5.008001; # probably works with earlier versions but I'm not supporting them
7 # (patches would, of course, be welcome)
13 our $VERSION = '1.008007'; # 1.8.4
15 our @KNOWN_FLAGS = qw(--self-contained --deactivate --deactivate-all);
17 sub DEACTIVATE_ONE () { 1 }
18 sub DEACTIVATE_ALL () { 2 }
20 sub INTERPOLATE_ENV () { 1 }
21 sub LITERAL_ENV () { 0 }
24 my ($class, @args) = @_;
26 # Remember what PERL5LIB was when we started
27 my $perl5lib = $ENV{PERL5LIB} || '';
31 # check for lethal dash first to stop processing before causing problems
34 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
35 These are *not* the traditional -- dashes that software recognizes. You
36 probably got these by copy-pasting from the perldoc for this module as
37 rendered by a UTF8-capable formatter. This most typically happens on an OS X
38 terminal, but can happen elsewhere too. Please try again after replacing the
39 dashes with normal minus signs.
42 elsif(grep { $arg eq $_ } @KNOWN_FLAGS) {
43 (my $flag = $arg) =~ s/--//;
44 $arg_store{$flag} = 1;
46 elsif($arg =~ /^--/) {
47 die "Unknown import argument: $arg";
50 # assume that what's left is a path
51 $arg_store{path} = $arg;
55 if($arg_store{'self-contained'}) {
56 die "FATAL: The local::lib --self-contained flag has never worked reliably and the original author, Mark Stosberg, was unable or unwilling to maintain it. As such, this flag has been removed from the local::lib codebase in order to prevent misunderstandings and potentially broken builds. The local::lib authors recommend that you look at the lib::core::only module shipped with this distribution in order to create a more robust environment that is equivalent to what --self-contained provided (although quite possibly not what you originally thought it provided due to the poor quality of the documentation, for which we apologise).\n";
60 if ($arg_store{deactivate}) {
61 $deactivating = DEACTIVATE_ONE;
63 if ($arg_store{'deactivate-all'}) {
64 $deactivating = DEACTIVATE_ALL;
67 $arg_store{path} = $class->resolve_path($arg_store{path});
68 $class->setup_local_lib_for($arg_store{path}, $deactivating);
70 for (@INC) { # Untaint @INC
71 next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc.
80 my $last = pop(@methods);
83 my ($obj, @args) = @_;
84 $obj->${pipeline @methods}(
101 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
102 my $foo = bless({}, 'Foo');
103 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
111 grep { ! $seen{$_}++ } @_;
115 my ($class, $path) = @_;
116 $class->${pipeline qw(
117 resolve_relative_path
123 sub resolve_empty_path {
124 my ($class, $path) = @_;
134 #:: test classmethod setup
136 my $c = 'local::lib';
144 is($c->resolve_empty_path, '~/perl5');
145 is($c->resolve_empty_path('foo'), 'foo');
151 sub resolve_home_path {
152 my ($class, $path) = @_;
153 return $path unless ($path =~ /^~/);
154 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
155 my $tried_file_homedir;
157 if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) {
158 $tried_file_homedir = 1;
160 File::HomeDir->users_home($user);
162 File::HomeDir->my_home;
168 if (defined $ENV{HOME}) {
176 unless (defined $homedir) {
179 "Couldn't resolve homedir for "
180 .(defined $user ? $user : 'current user')
181 .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
184 $path =~ s/^~[^\/]*/$homedir/;
188 sub resolve_relative_path {
189 my ($class, $path) = @_;
190 $path = File::Spec->rel2abs($path);
197 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
198 is($c->resolve_relative_path('bar'),'FOObar');
204 sub setup_local_lib_for {
205 my ($class, $path, $deactivating) = @_;
207 my $interpolate = LITERAL_ENV;
208 my @active_lls = $class->active_paths;
210 $path = $class->ensure_dir_structure_for($path);
212 if (! $deactivating) {
213 if (@active_lls && $active_lls[-1] eq $path) {
215 return; # Asked to add what's already at the top of the stack
216 } elsif (grep { $_ eq $path} @active_lls) {
217 # Asked to add a dir that's lower in the stack -- so we remove it from
218 # where it is, and then add it back at the top.
219 $class->setup_env_hash_for($path, DEACTIVATE_ONE);
220 # Which means we can no longer output "PERL5LIB=...:$PERL5LIB" stuff
221 # anymore because we're taking something *out*.
222 $interpolate = INTERPOLATE_ENV;
227 $class->print_environment_vars_for($path, $deactivating, $interpolate);
230 $class->setup_env_hash_for($path, $deactivating);
231 @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC);
235 sub install_base_bin_path {
236 my ($class, $path) = @_;
237 File::Spec->catdir($path, 'bin');
240 sub install_base_perl_path {
241 my ($class, $path) = @_;
242 File::Spec->catdir($path, 'lib', 'perl5');
245 sub install_base_arch_path {
246 my ($class, $path) = @_;
247 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
250 sub ensure_dir_structure_for {
251 my ($class, $path) = @_;
253 warn "Attempting to create directory ${path}\n";
255 File::Path::mkpath($path);
256 # Need to have the path exist to make a short name for it, so
257 # converting to a short name here.
258 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
263 sub guess_shelltype {
265 if(defined $ENV{'SHELL'}) {
266 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
267 $shellbin = $shell_bin_path_parts[-1];
270 local $_ = $shellbin;
278 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
279 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
280 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
281 $shellbin = $shell_bin_path_parts[-1];
283 local $_ = $shellbin;
286 } elsif(/cmd\.exe/) {
288 } elsif(/4nt\.exe/) {
298 sub print_environment_vars_for {
299 my ($class, $path, $deactivating, $interpolate) = @_;
300 print $class->environment_vars_string_for($path, $deactivating, $interpolate);
303 sub environment_vars_string_for {
304 my ($class, $path, $deactivating, $interpolate) = @_;
305 my @envs = $class->build_environment_vars_for($path, $deactivating, $interpolate);
308 # rather basic csh detection, goes on the assumption that something won't
309 # call itself csh unless it really is. also, default to bourne in the
310 # pathological situation where a user doesn't have $ENV{SHELL} defined.
311 # note also that shells with funny names, like zoid, are assumed to be
314 my $shelltype = $class->guess_shelltype;
317 my ($name, $value) = (shift(@envs), shift(@envs));
318 $value =~ s/(\\")/\\$1/g if defined $value;
319 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
324 # simple routines that take two arguments: an %ENV key and a value. return
325 # strings that are suitable for passing directly to the relevant shell to set
326 # said key to said value.
327 sub build_bourne_env_declaration {
329 my($name, $value) = @_;
330 return defined($value) ? qq{export ${name}="${value}";\n} : qq{unset ${name};\n};
333 sub build_csh_env_declaration {
335 my($name, $value) = @_;
336 return defined($value) ? qq{setenv ${name} "${value}"\n} : qq{unsetenv ${name}\n};
339 sub build_win32_env_declaration {
341 my($name, $value) = @_;
342 return defined($value) ? qq{set ${name}=${value}\n} : qq{set ${name}=\n};
345 sub setup_env_hash_for {
346 my ($class, $path, $deactivating) = @_;
347 my %envs = $class->build_environment_vars_for($path, $deactivating, INTERPOLATE_ENV);
348 @ENV{keys %envs} = values %envs;
351 sub build_environment_vars_for {
352 my ($class, $path, $deactivating, $interpolate) = @_;
354 if ($deactivating == DEACTIVATE_ONE) {
355 return $class->build_deactivate_environment_vars_for($path, $interpolate);
356 } elsif ($deactivating == DEACTIVATE_ALL) {
357 return $class->build_deact_all_environment_vars_for($path, $interpolate);
359 return $class->build_activate_environment_vars_for($path, $interpolate);
363 # Build an environment value for a variable like PATH from a list of paths.
364 # References to existing variables are given as references to the variable name.
365 # Duplicates are removed.
368 # - interpolate: INTERPOLATE_ENV/LITERAL_ENV
369 # - exists: paths are included only if they exist (default: interpolate == INTERPOLATE_ENV)
370 # - filter: function to apply to each path do decide if it must be included
371 # - empty: the value to return in the case of empty value
372 my %_env_list_value_defaults = (
373 interpolate => INTERPOLATE_ENV,
378 sub _env_list_value(%@) {
380 die(sprintf "unknown option '$_' at %s line %u\n", (caller)[1..2])
381 for grep { !exists $_env_list_value_defaults{$_} } keys %$options;
382 my %options = (%_env_list_value_defaults, %{ $options });
383 $options{exists} = $options{interpolate} == INTERPOLATE_ENV
384 unless defined $options{exists};
388 my $value = join($Config{path_sep}, map {
389 ref $_ ? ($^O eq 'MSWin32' ? "%${$_}%" : "\$${$_}") : $_
391 ref $_ || (defined $_
394 && $options{filter}->($_)
395 && (!$options{exists} || -e $_))
397 if (ref $_ eq 'SCALAR' && $options{interpolate} == INTERPOLATE_ENV) {
398 exists $ENV{${$_}} ? (split /\Q$Config{path_sep}/, $ENV{${$_}}) : ()
403 return length($value) ? $value : $options{empty};
406 sub build_activate_environment_vars_for {
407 my ($class, $path, $interpolate) = @_;
409 PERL_LOCAL_LIB_ROOT =>
411 { interpolate => $interpolate, exists => 0, empty => '' },
412 \'PERL_LOCAL_LIB_ROOT',
415 PERL_MB_OPT => "--install_base ${path}",
416 PERL_MM_OPT => "INSTALL_BASE=${path}",
419 { interpolate => $interpolate, exists => 0, empty => '' },
420 $class->install_base_arch_path($path),
421 $class->install_base_perl_path($path),
424 PATH => _env_list_value(
425 { interpolate => $interpolate, exists => 0, empty => '' },
434 return () unless defined $ENV{PERL_LOCAL_LIB_ROOT};
435 return split /\Q$Config{path_sep}/, $ENV{PERL_LOCAL_LIB_ROOT};
438 sub build_deactivate_environment_vars_for {
439 my ($class, $path, $interpolate) = @_;
441 my @active_lls = $class->active_paths;
443 if (!grep { $_ eq $path } @active_lls) {
444 warn "Tried to deactivate inactive local::lib '$path'\n";
448 my $perl_path = $class->install_base_perl_path($path);
449 my $arch_path = $class->install_base_arch_path($path);
450 my $bin_path = $class->install_base_bin_path($path);
454 PERL_LOCAL_LIB_ROOT => _env_list_value(
458 grep { $_ ne $path } @active_lls
460 PERL5LIB => _env_list_value(
464 $_ ne $perl_path && $_ ne $arch_path
469 PATH => _env_list_value(
472 filter => sub { $_ ne $bin_path },
478 # If removing ourselves from the "top of the stack", set install paths to
479 # correspond with the new top of stack.
480 if ($active_lls[-1] eq $path) {
481 if (@active_lls > 1) {
482 my $new_top = $active_lls[-2];
484 PERL_MB_OPT => "--install_base ${new_top}",
485 PERL_MM_OPT => "INSTALL_BASE=${new_top}",
489 PERL_MB_OPT => undef,
490 PERL_MM_OPT => undef,
498 sub build_deact_all_environment_vars_for {
499 my ($class, $path, $interpolate) = @_;
501 my @active_lls = $class->active_paths;
503 my %perl_paths = map { (
504 $class->install_base_perl_path($_) => 1,
505 $class->install_base_arch_path($_) => 1
507 my %bin_paths = map { (
508 $class->install_base_bin_path($_) => 1,
512 PERL_LOCAL_LIB_ROOT => undef,
513 PERL_MM_OPT => undef,
514 PERL_MB_OPT => undef,
515 PERL5LIB => _env_list_value(
519 ! scalar grep { exists $perl_paths{$_} } $_[0]
524 PATH => _env_list_value(
528 ! scalar grep { exists $bin_paths{$_} } $_[0]
542 File::Path::rmtree('t/var/splat');
544 $c->ensure_dir_structure_for('t/var/splat');
546 ok(-d 't/var/splat');
554 local::lib - create and use a local lib/ for perl modules with PERL5LIB
560 use local::lib; # sets up a local lib at ~/perl5
562 use local::lib '~/foo'; # same, but ~/foo
566 use local::lib "$FindBin::Bin/../support"; # app-local support library
570 # Install LWP and its missing dependencies to the '~/perl5' directory
571 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
573 # Just print out useful shell commands
575 export PERL_MB_OPT='--install_base /home/username/perl5'
576 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
577 export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5'
578 export PATH="/home/username/perl5/bin:$PATH"
580 =head2 The bootstrapping technique
582 A typical way to install local::lib is using what is known as the
583 "bootstrapping" technique. You would do this if your system administrator
584 hasn't already installed local::lib. In this case, you'll need to install
585 local::lib in your home directory.
587 If you do have administrative privileges, you will still want to set up your
588 environment variables, as discussed in step 4. Without this, you would still
589 install the modules into the system CPAN installation and also your Perl scripts
590 will not use the lib/ path you bootstrapped with local::lib.
592 By default local::lib installs itself and the CPAN modules into ~/perl5.
594 Windows users must also see L</Differences when using this module under Win32>.
596 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
597 on the CPAN page about local::lib). Do this as an ordinary user, not as root
598 or administrator. Unpack the file in your home directory or in any other
603 perl Makefile.PL --bootstrap
605 If the system asks you whether it should automatically configure as much
606 as possible, you would typically answer yes.
608 In order to install local::lib into a directory other than the default, you need
609 to specify the name of the directory when you call bootstrap, as follows:
611 perl Makefile.PL --bootstrap=~/foo
613 3. Run this: (local::lib assumes you have make installed on your system)
615 make test && make install
617 4. Now we need to setup the appropriate environment variables, so that Perl
618 starts using our newly generated lib/ directory. If you are using bash or
619 any other Bourne shells, you can add this to your shell startup script this
622 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
624 If you are using C shell, you can do this as follows:
629 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
631 If you passed to bootstrap a directory other than default, you also need to give that as
632 import parameter to the call of the local::lib module like this way:
634 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
636 After writing your shell configuration file, be sure to re-read it to get the
637 changed settings into your current shell's environment. Bourne shells use
638 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
640 If you're on a slower machine, or are operating under draconian disk space
641 limitations, you can disable the automatic generation of manpages from POD when
642 installing modules by using the C<--no-manpages> argument when bootstrapping:
644 perl Makefile.PL --bootstrap --no-manpages
646 To avoid doing several bootstrap for several Perl module environments on the
647 same account, for example if you use it for several different deployed
648 applications independently, you can use one bootstrapped local::lib
649 installation to install modules in different directories directly this way:
653 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
654 printenv ### You will see that ~/mydir1 is in the PERL5LIB
655 perl -MCPAN -e install ... ### whatever modules you want
659 If you are working with several C<local::lib> environments, you may want to
660 remove some of them from the current environment without disturbing the others.
661 You can deactivate one environment like this (using bourne sh):
663 eval $(perl -Mlocal::lib=--deactivate,~/path)
665 which will generate and run the commands needed to remove C<~/path> from your
666 various search paths. Whichever environment was B<activated most recently> will
667 remain the target for module installations. That is, if you activate
668 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
669 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
670 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
671 installed in C<~/pathB> because pathB was activated later.
673 You can also ask C<local::lib> to clean itself completely out of the current
674 shell's environment with the C<--deactivate-all> option.
675 For multiple environments for multiple apps you may need to include a modified
676 version of the C<< use FindBin >> instructions in the "In code" sample above.
677 If you did something like the above, you have a set of Perl modules at C<<
678 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
679 you need to tell it where to find the modules you installed for it at C<<
682 In C<< ~/mydir1/scripts/myscript.pl >>:
686 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
687 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
689 Put this before any BEGIN { ... } blocks that require the modules you installed.
691 =head2 Differences when using this module under Win32
693 To set up the proper environment variables for your current session of
694 C<CMD.exe>, you can use this:
696 C:\>perl -Mlocal::lib
697 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
698 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
699 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
700 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
702 ### To set the environment for this shell alone
703 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
704 ### instead of $(perl -Mlocal::lib=./)
706 If you want the environment entries to persist, you'll need to add then to the
707 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
709 The "~" is translated to the user's profile directory (the directory named for
710 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
711 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
712 directory is translated to a short name (which means the directory must exist)
713 and the subdirectories are created.
717 The version of a Perl package on your machine is not always the version you
718 need. Obviously, the best thing to do would be to update to the version you
719 need. However, you might be in a situation where you're prevented from doing
720 this. Perhaps you don't have system administrator privileges; or perhaps you
721 are using a package management system such as Debian, and nobody has yet gotten
722 around to packaging up the version you need.
724 local::lib solves this problem by allowing you to create your own directory of
725 Perl packages downloaded from CPAN (in a multi-user system, this would typically
726 be within your own home directory). The existing system Perl installation is
727 not affected; you simply invoke Perl with special options so that Perl uses the
728 packages in your own local package directory rather than the system packages.
729 local::lib arranges things so that your locally installed version of the Perl
730 packages takes precedence over the system installation.
732 If you are using a package management system (such as Debian), you don't need to
733 worry about Debian and CPAN stepping on each other's toes. Your local version
734 of the packages will be written to an entirely separate directory from those
739 This module provides a quick, convenient way of bootstrapping a user-local Perl
740 module library located within the user's home directory. It also constructs and
741 prints out for the user the list of environment variables using the syntax
742 appropriate for the user's current shell (as specified by the C<SHELL>
743 environment variable), suitable for directly adding to one's shell
746 More generally, local::lib allows for the bootstrapping and usage of a
747 directory containing Perl modules outside of Perl's C<@INC>. This makes it
748 easier to ship an application with an app-specific copy of a Perl module, or
749 collection of modules. Useful in cases like when an upstream maintainer hasn't
750 applied a patch to a module of theirs that you need for your application.
752 On import, local::lib sets the following environment variables to appropriate
765 PATH is appended to, rather than clobbered.
769 These values are then available for reference by any code after import.
771 =head1 CREATING A SELF-CONTAINED SET OF MODULES
773 See L<lib::core::only> for one way to do this - but note that
774 there are a number of caveats, and the best approach is always to perform a
775 build against a clean perl (i.e. site and vendor as close to empty as possible).
779 Options are values that can be passed to the C<local::lib> import besides the
780 directory to use. They are specified as C<use local::lib '--option'[, path];>
781 or C<perl -Mlocal::lib=--option[,path]>.
785 Remove the chosen path (or the default path) from the module search paths if it
786 was added by C<local::lib>, instead of adding it.
788 =head2 --deactivate-all
790 Remove all directories that were added to search paths by C<local::lib> from the
795 =head2 ensure_dir_structure_for
799 =item Arguments: $path
801 =item Return value: None
805 Attempts to create the given path, and all required parent directories. Throws
806 an exception on failure.
808 =head2 print_environment_vars_for
812 =item Arguments: $path
814 =item Return value: None
818 Prints to standard output the variables listed above, properly set to use the
819 given path as the base directory.
821 =head2 build_environment_vars_for
825 =item Arguments: $path, $interpolate
827 =item Return value: \%environment_vars
831 Returns a hash with the variables listed above, properly set to use the
832 given path as the base directory.
834 =head2 setup_env_hash_for
838 =item Arguments: $path
840 =item Return value: None
844 Constructs the C<%ENV> keys for the given path, by calling
845 L</build_environment_vars_for>.
851 =item Arguments: None
853 =item Return value: @paths
857 Returns a list of active C<local::lib> paths, according to the
858 C<PERL_LOCAL_LIB_ROOT> environment variable.
860 =head2 install_base_perl_path
864 =item Arguments: $path
866 =item Return value: $install_base_perl_path
870 Returns a path describing where to install the Perl modules for this local
871 library installation. Appends the directories C<lib> and C<perl5> to the given
874 =head2 install_base_arch_path
878 =item Arguments: $path
880 =item Return value: $install_base_arch_path
884 Returns a path describing where to install the architecture-specific Perl
885 modules for this local library installation. Based on the
886 L</install_base_perl_path> method's return value, and appends the value of
887 C<$Config{archname}>.
889 =head2 install_base_bin_path
893 =item Arguments: $path
895 =item Return value: $install_base_bin_path
899 Returns a path describing where to install the executable programs for this
900 local library installation. Based on the L</install_base_perl_path> method's
901 return value, and appends the directory C<bin>.
903 =head2 resolve_empty_path
907 =item Arguments: $path
909 =item Return value: $base_path
913 Builds and returns the base path into which to set up the local module
914 installation. Defaults to C<~/perl5>.
916 =head2 resolve_home_path
920 =item Arguments: $path
922 =item Return value: $home_path
926 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
927 for this purpose. If no definite answer is available, throws an exception.
929 =head2 resolve_relative_path
933 =item Arguments: $path
935 =item Return value: $absolute_path
939 Translates the given path into an absolute path.
945 =item Arguments: $path
947 =item Return value: $absolute_path
951 Calls the following in a pipeline, passing the result from the previous to the
952 next, in an attempt to find where to configure the environment for a local
953 library installation: L</resolve_empty_path>, L</resolve_home_path>,
954 L</resolve_relative_path>. Passes the given path argument to
955 L</resolve_empty_path> which then returns a result that is passed to
956 L</resolve_home_path>, which then has its result passed to
957 L</resolve_relative_path>. The result of this final call is returned from
960 =head1 A WARNING ABOUT UNINST=1
962 Be careful about using local::lib in combination with "make install UNINST=1".
963 The idea of this feature is that will uninstall an old version of a module
964 before installing a new one. However it lacks a safety check that the old
965 version and the new version will go in the same directory. Used in combination
966 with local::lib, you can potentially delete a globally accessible version of a
967 module while installing the new version in a local place. Only combine "make
968 install UNINST=1" and local::lib if you understand these possible consequences.
972 The perl toolchain is unable to handle directory names with spaces in it,
973 so you cant put your local::lib bootstrap into a directory with spaces. What
974 you can do is moving your local::lib to a directory with spaces B<after> you
975 installed all modules inside your local::lib bootstrap. But be aware that you
976 cant update or install CPAN modules after the move.
978 Rather basic shell detection. Right now anything with csh in its name is
979 assumed to be a C shell or something compatible, and everything else is assumed
980 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
981 not set, a Bourne-compatible shell is assumed.
983 Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
984 have CPANPLUS installed.
986 Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT.
988 Should probably auto-fixup CPAN config if not already done.
990 Patches very much welcome for any of the above.
992 On Win32 systems, does not have a way to write the created environment variables
993 to the registry, so that they can persist through a reboot.
995 =head1 TROUBLESHOOTING
997 If you've configured local::lib to install CPAN modules somewhere in to your
998 home directory, and at some point later you try to install a module with C<cpan
999 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1000 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1001 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1002 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1003 you've somehow lost your updated ExtUtils::MakeMaker module.
1005 To remedy this situation, rerun the bootstrapping procedure documented above.
1007 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1009 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1019 local::lib looks at the user's C<SHELL> environment variable when printing out
1020 commands to add to the shell configuration file.
1022 On Win32 systems, C<COMSPEC> is also examined.
1030 Join #local-lib on irc.perl.org.
1034 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1036 auto_install fixes kindly sponsored by http://www.takkle.com/
1040 Patches to correctly output commands for csh style shells, as well as some
1041 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1043 Doc patches for a custom local::lib directory, more cleanups in the english
1044 documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
1045 <torsten@raudssus.de>.
1047 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1048 things will install properly, submitted a fix for the bug causing problems with
1049 writing Makefiles during bootstrapping, contributed an example program, and
1050 submitted yet another fix to ensure that local::lib can install and bootstrap
1051 properly. Many, many thanks!
1053 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1054 section. Many thanks!
1056 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1058 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1059 by a patch from Marco Emilio Poleggi.
1061 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1062 '--self-contained' option.
1064 Documentation patches to make win32 usage clearer by
1065 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1067 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
1068 G. de Oliveira <garu@cpan.org>.
1070 Improvements to stacking multiple local::lib dirs and removing them from the
1071 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1073 Patch for Carp version mismatch contributed by Hakim Cassimally <osfameron@cpan.org>.
1077 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1082 This library is free software and may be distributed under the same terms