11 our $VERSION = '1.008026'; # 1.8.26
12 $VERSION = eval $VERSION;
14 our @KNOWN_FLAGS = qw(--self-contained --deactivate --deactivate-all);
16 sub DEACTIVATE_ONE () { 1 }
17 sub DEACTIVATE_ALL () { 2 }
19 sub INTERPOLATE_ENV () { 1 }
20 sub LITERAL_ENV () { 0 }
23 my ($class, @args) = @_;
25 # Remember what PERL5LIB was when we started
26 my $perl5lib = $ENV{PERL5LIB} || '';
30 # check for lethal dash first to stop processing before causing problems
31 # the fancy dash is U+2212 or \xE2\x88\x92
32 if ($arg =~ /\xE2\x88\x92/ or $arg =~ /−/) {
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);
75 my $last = pop(@methods);
78 my ($obj, @args) = @_;
79 $obj->${pipeline @methods}(
96 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
97 my $foo = bless({}, 'Foo');
98 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
106 grep { ! $seen{$_}++ } @_;
110 my ($class, $path) = @_;
111 $class->${pipeline qw(
112 resolve_relative_path
118 sub resolve_empty_path {
119 my ($class, $path) = @_;
129 #:: test classmethod setup
131 my $c = 'local::lib';
139 is($c->resolve_empty_path, '~/perl5');
140 is($c->resolve_empty_path('foo'), 'foo');
146 sub resolve_home_path {
147 my ($class, $path) = @_;
148 return $path unless ($path =~ /^~/);
149 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
151 if (!defined $user && defined $ENV{HOME}) {
156 File::Glob::bsd_glob("~$user", File::Glob::GLOB_TILDE());
159 unless (defined $homedir) {
162 "Couldn't resolve homedir for "
163 .(defined $user ? $user : 'current user')
166 $path =~ s/^~[^\/]*/$homedir/;
170 sub resolve_relative_path {
171 my ($class, $path) = @_;
172 $path = File::Spec->rel2abs($path);
179 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
180 is($c->resolve_relative_path('bar'),'FOObar');
186 sub setup_local_lib_for {
187 my ($class, $path, $deactivating) = @_;
189 my $interpolate = LITERAL_ENV;
190 my @active_lls = $class->active_paths;
192 $class->ensure_dir_structure_for($path)
193 unless $deactivating;
195 # On Win32 directories often contain spaces. But some parts of the CPAN
196 # toolchain don't like that. To avoid this, GetShortPathName() gives us
197 # an alternate representation that has none.
198 # This only works if the directory already exists.
199 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
201 if (! $deactivating) {
202 if (@active_lls && $active_lls[0] eq $path) {
204 return; # Asked to add what's already at the top of the stack
205 } elsif (grep { $_ eq $path} @active_lls) {
206 # Asked to add a dir that's lower in the stack -- so we remove it from
207 # where it is, and then add it back at the top.
208 $class->setup_env_hash_for($path, DEACTIVATE_ONE);
209 # Which means we can no longer output "PERL5LIB=...:$PERL5LIB" stuff
210 # anymore because we're taking something *out*.
211 $interpolate = INTERPOLATE_ENV;
216 $class->print_environment_vars_for($path, $deactivating, $interpolate);
219 $class->setup_env_hash_for($path, $deactivating);
220 my $arch_dir = $Config{archname};
223 # Inject $path/$archname for each path in PERL5LIB
224 map { ( File::Spec->catdir($_, $arch_dir), $_ ) }
225 split($Config{path_sep}, $ENV{PERL5LIB})
232 sub install_base_bin_path {
233 my ($class, $path) = @_;
234 File::Spec->catdir($path, 'bin');
237 sub install_base_perl_path {
238 my ($class, $path) = @_;
239 File::Spec->catdir($path, 'lib', 'perl5');
242 sub install_base_arch_path {
243 my ($class, $path) = @_;
244 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
247 sub ensure_dir_structure_for {
248 my ($class, $path) = @_;
250 warn "Attempting to create directory ${path}\n";
252 require File::Basename;
256 $path = File::Basename::dirname($path);
258 mkdir $_ for reverse @dirs;
266 File::Path::rmtree('t/var/splat');
268 $c->ensure_dir_structure_for('t/var/splat');
270 ok(-d 't/var/splat');
276 sub guess_shelltype {
278 if(defined $ENV{'SHELL'}) {
279 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
280 $shellbin = $shell_bin_path_parts[-1];
283 local $_ = $shellbin;
291 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
292 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
293 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
294 $shellbin = $shell_bin_path_parts[-1];
296 local $_ = $shellbin;
299 } elsif(/cmd\.exe/) {
301 } elsif(/4nt\.exe/) {
311 sub print_environment_vars_for {
312 my ($class, $path, $deactivating, $interpolate) = @_;
313 print $class->environment_vars_string_for($path, $deactivating, $interpolate);
316 sub environment_vars_string_for {
317 my ($class, $path, $deactivating, $interpolate) = @_;
318 my @envs = $class->build_environment_vars_for($path, $deactivating, $interpolate);
321 # rather basic csh detection, goes on the assumption that something won't
322 # call itself csh unless it really is. also, default to bourne in the
323 # pathological situation where a user doesn't have $ENV{SHELL} defined.
324 # note also that shells with funny names, like zoid, are assumed to be
327 my $shelltype = $class->guess_shelltype;
330 my ($name, $value) = (shift(@envs), shift(@envs));
331 $value =~ s/(\\")/\\$1/g if defined $value;
332 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
337 # simple routines that take two arguments: an %ENV key and a value. return
338 # strings that are suitable for passing directly to the relevant shell to set
339 # said key to said value.
340 sub build_bourne_env_declaration {
342 my($name, $value) = @_;
343 return defined($value) ? qq{export ${name}="${value}";\n} : qq{unset ${name};\n};
346 sub build_csh_env_declaration {
348 my($name, $value) = @_;
349 return defined($value) ? qq{setenv ${name} "${value}";\n} : qq{unsetenv ${name};\n};
352 sub build_win32_env_declaration {
354 my($name, $value) = @_;
355 return defined($value) ? qq{set ${name}=${value}\n} : qq{set ${name}=\n};
358 sub setup_env_hash_for {
359 my ($class, $path, $deactivating) = @_;
360 my %envs = $class->build_environment_vars_for($path, $deactivating, INTERPOLATE_ENV);
361 @ENV{keys %envs} = values %envs;
364 sub build_environment_vars_for {
365 my ($class, $path, $deactivating, $interpolate) = @_;
367 if ($deactivating && $deactivating == DEACTIVATE_ONE) {
368 return $class->build_deactivate_environment_vars_for($path, $interpolate);
369 } elsif ($deactivating && $deactivating == DEACTIVATE_ALL) {
370 return $class->build_deact_all_environment_vars_for($path, $interpolate);
372 return $class->build_activate_environment_vars_for($path, $interpolate);
376 # Build an environment value for a variable like PATH from a list of paths.
377 # References to existing variables are given as references to the variable name.
378 # Duplicates are removed.
381 # - interpolate: INTERPOLATE_ENV/LITERAL_ENV
382 # - exists: paths are included only if they exist (default: interpolate == INTERPOLATE_ENV)
383 # - filter: function to apply to each path do decide if it must be included
384 # - empty: the value to return in the case of empty value
385 my %ENV_LIST_VALUE_DEFAULTS = (
386 interpolate => INTERPOLATE_ENV,
391 sub _env_list_value {
393 die(sprintf "unknown option '$_' at %s line %u\n", (caller)[1..2])
394 for grep { !exists $ENV_LIST_VALUE_DEFAULTS{$_} } keys %$options;
395 my %options = (%ENV_LIST_VALUE_DEFAULTS, %{ $options });
396 $options{exists} = $options{interpolate} == INTERPOLATE_ENV
397 unless defined $options{exists};
401 my $value = join($Config{path_sep}, map {
402 ref $_ ? ($^O eq 'MSWin32' ? "%${$_}%" : "\$${$_}") : $_
404 ref $_ || (defined $_
407 && $options{filter}->($_)
408 && (!$options{exists} || -e $_))
410 if (ref $_ eq 'SCALAR' && $options{interpolate} == INTERPOLATE_ENV) {
411 defined $ENV{${$_}} ? (split /\Q$Config{path_sep}/, $ENV{${$_}}) : ()
416 return length($value) ? $value : $options{empty};
419 sub build_activate_environment_vars_for {
420 my ($class, $path, $interpolate) = @_;
422 PERL_LOCAL_LIB_ROOT =>
424 { interpolate => $interpolate, exists => 0, empty => '' },
426 \'PERL_LOCAL_LIB_ROOT',
428 $class->installer_options_for($path),
431 { interpolate => $interpolate, exists => 0, empty => '' },
432 $class->install_base_perl_path($path),
435 PATH => _env_list_value(
436 { interpolate => $interpolate, exists => 0, empty => '' },
437 $class->install_base_bin_path($path),
443 sub _mm_escape_path {
445 $path =~ s/\\/\\\\\\\\/g;
446 if ($path =~ s/ /\\ /g) {
447 $path = qq{"\\"$path\\""};
452 sub _mb_escape_path {
454 $path =~ s/\\/\\\\/g;
461 return () unless defined $ENV{PERL_LOCAL_LIB_ROOT};
464 # screen out entries that aren't actually reflected in @INC
465 my $active_ll = $class->install_base_perl_path($_);
466 grep { $_ eq $active_ll } @INC
469 split /\Q$Config{path_sep}\E/, $ENV{PERL_LOCAL_LIB_ROOT};
472 sub build_deactivate_environment_vars_for {
473 my ($class, $path, $interpolate) = @_;
475 my @active_lls = $class->active_paths;
477 if (!grep { $_ eq $path } @active_lls) {
478 warn "Tried to deactivate inactive local::lib '$path'\n";
482 my $perl_path = $class->install_base_perl_path($path);
483 my $bin_path = $class->install_base_bin_path($path);
487 PERL_LOCAL_LIB_ROOT => _env_list_value(
491 grep { $_ ne $path } @active_lls
493 PERL5LIB => _env_list_value(
502 PATH => _env_list_value(
505 filter => sub { $_ ne $bin_path },
511 # If removing ourselves from the "top of the stack", set install paths to
512 # correspond with the new top of stack.
513 if ($active_lls[0] eq $path) {
514 my $new_top = $active_lls[1];
515 my %opts = $class->installer_options_for($new_top);
516 $env{keys %opts} = values %opts;
522 sub installer_options_for {
523 my ($class, $path) = @_;
525 PERL_MM_OPT => defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef,
526 PERL_MB_OPT => defined $path ? "--install_base "._mb_escape_path($path) : undef,
530 sub build_deact_all_environment_vars_for {
531 my ($class, $path, $interpolate) = @_;
533 my @active_lls = $class->active_paths;
535 my %perl_paths = map { (
536 $class->install_base_perl_path($_) => 1,
538 my %bin_paths = map { (
539 $class->install_base_bin_path($_) => 1,
543 PERL_LOCAL_LIB_ROOT => undef,
544 PERL_MM_OPT => undef,
545 PERL_MB_OPT => undef,
546 PERL5LIB => _env_list_value(
550 ! scalar grep { exists $perl_paths{$_} } $_[0]
555 PATH => _env_list_value(
559 ! scalar grep { exists $bin_paths{$_} } $_[0]
576 local::lib - create and use a local lib/ for perl modules with PERL5LIB
582 use local::lib; # sets up a local lib at ~/perl5
584 use local::lib '~/foo'; # same, but ~/foo
588 use local::lib "$FindBin::Bin/../support"; # app-local support library
592 # Install LWP and its missing dependencies to the '~/perl5' directory
593 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
595 # Just print out useful shell commands
597 export PERL_MB_OPT='--install_base /home/username/perl5'
598 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
599 export PERL5LIB="/home/username/perl5/lib/perl5"
600 export PATH="/home/username/perl5/bin:$PATH"
602 =head2 The bootstrapping technique
604 A typical way to install local::lib is using what is known as the
605 "bootstrapping" technique. You would do this if your system administrator
606 hasn't already installed local::lib. In this case, you'll need to install
607 local::lib in your home directory.
609 Even if you do have administrative privileges, you will still want to set up your
610 environment variables, as discussed in step 4. Without this, you would still
611 install the modules into the system CPAN installation and also your Perl scripts
612 will not use the lib/ path you bootstrapped with local::lib.
614 By default local::lib installs itself and the CPAN modules into ~/perl5.
616 Windows users must also see L</Differences when using this module under Win32>.
618 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
619 on the CPAN page about local::lib). Do this as an ordinary user, not as root
620 or administrator. Unpack the file in your home directory or in any other
625 perl Makefile.PL --bootstrap
627 If the system asks you whether it should automatically configure as much
628 as possible, you would typically answer yes.
630 In order to install local::lib into a directory other than the default, you need
631 to specify the name of the directory when you call bootstrap, as follows:
633 perl Makefile.PL --bootstrap=~/foo
635 3. Run this: (local::lib assumes you have make installed on your system)
637 make test && make install
639 4. Now we need to setup the appropriate environment variables, so that Perl
640 starts using our newly generated lib/ directory. If you are using bash or
641 any other Bourne shells, you can add this to your shell startup script this
644 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
646 If you are using C shell, you can do this as follows:
651 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
653 If you passed to bootstrap a directory other than default, you also need to
654 give that as import parameter to the call of the local::lib module like this
657 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
659 After writing your shell configuration file, be sure to re-read it to get the
660 changed settings into your current shell's environment. Bourne shells use
661 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
663 If you're on a slower machine, or are operating under draconian disk space
664 limitations, you can disable the automatic generation of manpages from POD when
665 installing modules by using the C<--no-manpages> argument when bootstrapping:
667 perl Makefile.PL --bootstrap --no-manpages
669 To avoid doing several bootstrap for several Perl module environments on the
670 same account, for example if you use it for several different deployed
671 applications independently, you can use one bootstrapped local::lib
672 installation to install modules in different directories directly this way:
676 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
677 printenv ### You will see that ~/mydir1 is in the PERL5LIB
678 perl -MCPAN -e install ... ### whatever modules you want
682 If you are working with several C<local::lib> environments, you may want to
683 remove some of them from the current environment without disturbing the others.
684 You can deactivate one environment like this (using bourne sh):
686 eval $(perl -Mlocal::lib=--deactivate,~/path)
688 which will generate and run the commands needed to remove C<~/path> from your
689 various search paths. Whichever environment was B<activated most recently> will
690 remain the target for module installations. That is, if you activate
691 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
692 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
693 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
694 installed in C<~/pathB> because pathB was activated later.
696 You can also ask C<local::lib> to clean itself completely out of the current
697 shell's environment with the C<--deactivate-all> option.
698 For multiple environments for multiple apps you may need to include a modified
699 version of the C<< use FindBin >> instructions in the "In code" sample above.
700 If you did something like the above, you have a set of Perl modules at C<<
701 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
702 you need to tell it where to find the modules you installed for it at C<<
705 In C<< ~/mydir1/scripts/myscript.pl >>:
709 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
710 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
712 Put this before any BEGIN { ... } blocks that require the modules you installed.
714 =head2 Differences when using this module under Win32
716 To set up the proper environment variables for your current session of
717 C<CMD.exe>, you can use this:
719 C:\>perl -Mlocal::lib
720 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
721 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
722 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5
723 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
725 ### To set the environment for this shell alone
726 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
727 ### instead of $(perl -Mlocal::lib=./)
729 If you want the environment entries to persist, you'll need to add then to the
730 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
732 The "~" is translated to the user's profile directory (the directory named for
733 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
734 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
735 directory is translated to a short name (which means the directory must exist)
736 and the subdirectories are created.
740 The version of a Perl package on your machine is not always the version you
741 need. Obviously, the best thing to do would be to update to the version you
742 need. However, you might be in a situation where you're prevented from doing
743 this. Perhaps you don't have system administrator privileges; or perhaps you
744 are using a package management system such as Debian, and nobody has yet gotten
745 around to packaging up the version you need.
747 local::lib solves this problem by allowing you to create your own directory of
748 Perl packages downloaded from CPAN (in a multi-user system, this would typically
749 be within your own home directory). The existing system Perl installation is
750 not affected; you simply invoke Perl with special options so that Perl uses the
751 packages in your own local package directory rather than the system packages.
752 local::lib arranges things so that your locally installed version of the Perl
753 packages takes precedence over the system installation.
755 If you are using a package management system (such as Debian), you don't need to
756 worry about Debian and CPAN stepping on each other's toes. Your local version
757 of the packages will be written to an entirely separate directory from those
762 This module provides a quick, convenient way of bootstrapping a user-local Perl
763 module library located within the user's home directory. It also constructs and
764 prints out for the user the list of environment variables using the syntax
765 appropriate for the user's current shell (as specified by the C<SHELL>
766 environment variable), suitable for directly adding to one's shell
769 More generally, local::lib allows for the bootstrapping and usage of a
770 directory containing Perl modules outside of Perl's C<@INC>. This makes it
771 easier to ship an application with an app-specific copy of a Perl module, or
772 collection of modules. Useful in cases like when an upstream maintainer hasn't
773 applied a patch to a module of theirs that you need for your application.
775 On import, local::lib sets the following environment variables to appropriate
790 When possible, these will be appended to instead of overwritten entirely.
792 These values are then available for reference by any code after import.
794 =head1 CREATING A SELF-CONTAINED SET OF MODULES
796 See L<lib::core::only> for one way to do this - but note that
797 there are a number of caveats, and the best approach is always to perform a
798 build against a clean perl (i.e. site and vendor as close to empty as possible).
802 Options are values that can be passed to the C<local::lib> import besides the
803 directory to use. They are specified as C<use local::lib '--option'[, path];>
804 or C<perl -Mlocal::lib=--option[,path]>.
808 Remove the chosen path (or the default path) from the module search paths if it
809 was added by C<local::lib>, instead of adding it.
811 =head2 --deactivate-all
813 Remove all directories that were added to search paths by C<local::lib> from the
818 =head2 ensure_dir_structure_for
822 =item Arguments: $path
824 =item Return value: None
828 Attempts to create the given path, and all required parent directories. Throws
829 an exception on failure.
831 =head2 print_environment_vars_for
835 =item Arguments: $path
837 =item Return value: None
841 Prints to standard output the variables listed above, properly set to use the
842 given path as the base directory.
844 =head2 build_environment_vars_for
848 =item Arguments: $path, $interpolate
850 =item Return value: %environment_vars
854 Returns a hash with the variables listed above, properly set to use the
855 given path as the base directory.
857 =head2 setup_env_hash_for
861 =item Arguments: $path
863 =item Return value: None
867 Constructs the C<%ENV> keys for the given path, by calling
868 L</build_environment_vars_for>.
874 =item Arguments: None
876 =item Return value: @paths
880 Returns a list of active C<local::lib> paths, according to the
881 C<PERL_LOCAL_LIB_ROOT> environment variable and verified against
882 what is really in C<@INC>.
884 =head2 install_base_perl_path
888 =item Arguments: $path
890 =item Return value: $install_base_perl_path
894 Returns a path describing where to install the Perl modules for this local
895 library installation. Appends the directories C<lib> and C<perl5> to the given
898 =head2 install_base_bin_path
902 =item Arguments: $path
904 =item Return value: $install_base_bin_path
908 Returns a path describing where to install the executable programs for this
909 local library installation. Appends the directory C<bin> to the given path.
911 =head2 resolve_empty_path
915 =item Arguments: $path
917 =item Return value: $base_path
921 Builds and returns the base path into which to set up the local module
922 installation. Defaults to C<~/perl5>.
924 =head2 resolve_home_path
928 =item Arguments: $path
930 =item Return value: $home_path
934 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
935 for this purpose. If no definite answer is available, throws an exception.
937 =head2 resolve_relative_path
941 =item Arguments: $path
943 =item Return value: $absolute_path
947 Translates the given path into an absolute path.
953 =item Arguments: $path
955 =item Return value: $absolute_path
959 Calls the following in a pipeline, passing the result from the previous to the
960 next, in an attempt to find where to configure the environment for a local
961 library installation: L</resolve_empty_path>, L</resolve_home_path>,
962 L</resolve_relative_path>. Passes the given path argument to
963 L</resolve_empty_path> which then returns a result that is passed to
964 L</resolve_home_path>, which then has its result passed to
965 L</resolve_relative_path>. The result of this final call is returned from
968 =head1 A WARNING ABOUT UNINST=1
970 Be careful about using local::lib in combination with "make install UNINST=1".
971 The idea of this feature is that will uninstall an old version of a module
972 before installing a new one. However it lacks a safety check that the old
973 version and the new version will go in the same directory. Used in combination
974 with local::lib, you can potentially delete a globally accessible version of a
975 module while installing the new version in a local place. Only combine "make
976 install UNINST=1" and local::lib if you understand these possible consequences.
982 =item * Directory names with spaces in them are not well supported by the perl
983 toolchain and the programs it uses. Pure-perl distributions should support
984 spaces, but problems are more likely with dists that require compilation. A
985 workaround you can do is moving your local::lib to a directory with spaces
986 B<after> you installed all modules inside your local::lib bootstrap. But be
987 aware that you can't update or install CPAN modules after the move.
989 =item * Rather basic shell detection. Right now anything with csh in its name is
990 assumed to be a C shell or something compatible, and everything else is assumed
991 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
992 not set, a Bourne-compatible shell is assumed.
994 =item * Kills any existing PERL_MM_OPT or PERL_MB_OPT.
996 =item * Should probably auto-fixup CPAN config if not already done.
1000 Patches very much welcome for any of the above.
1004 =item * On Win32 systems, does not have a way to write the created environment
1005 variables to the registry, so that they can persist through a reboot.
1009 =head1 TROUBLESHOOTING
1011 If you've configured local::lib to install CPAN modules somewhere in to your
1012 home directory, and at some point later you try to install a module with C<cpan
1013 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1014 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1015 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1016 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1017 you've somehow lost your updated ExtUtils::MakeMaker module.
1019 To remedy this situation, rerun the bootstrapping procedure documented above.
1021 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1023 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1033 local::lib looks at the user's C<SHELL> environment variable when printing out
1034 commands to add to the shell configuration file.
1036 On Win32 systems, C<COMSPEC> is also examined.
1044 =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html>
1052 Join #local-lib on irc.perl.org.
1056 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1058 auto_install fixes kindly sponsored by http://www.takkle.com/
1062 Patches to correctly output commands for csh style shells, as well as some
1063 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1065 Doc patches for a custom local::lib directory, more cleanups in the english
1066 documentation and a L<german documentation|POD2::DE::local::lib> contributed by
1067 Torsten Raudssus <torsten@raudssus.de>.
1069 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1070 things will install properly, submitted a fix for the bug causing problems with
1071 writing Makefiles during bootstrapping, contributed an example program, and
1072 submitted yet another fix to ensure that local::lib can install and bootstrap
1073 properly. Many, many thanks!
1075 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1076 section. Many thanks!
1078 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1080 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1081 by a patch from Marco Emilio Poleggi.
1083 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1084 '--self-contained' option.
1086 Documentation patches to make win32 usage clearer by
1087 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1089 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc
1090 patches contributed by Breno G. de Oliveira <garu@cpan.org>.
1092 Improvements to stacking multiple local::lib dirs and removing them from the
1093 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1095 Patch for Carp version mismatch contributed by Hakim Cassimally
1096 <osfameron@cpan.org>.
1100 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1105 This is free software; you can redistribute it and/or modify it under
1106 the same terms as the Perl 5 programming language system itself.