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);
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'
156 if (!defined $user && defined $ENV{HOME}) {
161 File::Glob::bsd_glob("~$user", File::Glob::GLOB_TILDE());
164 unless (defined $homedir) {
167 "Couldn't resolve homedir for "
168 .(defined $user ? $user : 'current user')
171 $path =~ s/^~[^\/]*/$homedir/;
175 sub resolve_relative_path {
176 my ($class, $path) = @_;
177 $path = File::Spec->rel2abs($path);
184 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
185 is($c->resolve_relative_path('bar'),'FOObar');
191 sub setup_local_lib_for {
192 my ($class, $path, $deactivating) = @_;
194 my $interpolate = LITERAL_ENV;
195 my @active_lls = $class->active_paths;
197 $class->ensure_dir_structure_for($path)
198 unless $deactivating;
200 # On Win32 directories often contain spaces. But some parts of the CPAN
201 # toolchain don't like that. To avoid this, GetShortPathName() gives us
202 # an alternate representation that has none.
203 # This only works if the directory already exists.
204 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
206 if (! $deactivating) {
207 if (@active_lls && $active_lls[0] eq $path) {
209 return; # Asked to add what's already at the top of the stack
210 } elsif (grep { $_ eq $path} @active_lls) {
211 # Asked to add a dir that's lower in the stack -- so we remove it from
212 # where it is, and then add it back at the top.
213 $class->setup_env_hash_for($path, DEACTIVATE_ONE);
214 # Which means we can no longer output "PERL5LIB=...:$PERL5LIB" stuff
215 # anymore because we're taking something *out*.
216 $interpolate = INTERPOLATE_ENV;
221 $class->print_environment_vars_for($path, $deactivating, $interpolate);
224 $class->setup_env_hash_for($path, $deactivating);
225 my $arch_dir = $Config{archname};
228 # Inject $path/$archname for each path in PERL5LIB
229 map { ( File::Spec->catdir($_, $arch_dir), $_ ) }
230 split($Config{path_sep}, $ENV{PERL5LIB})
237 sub install_base_bin_path {
238 my ($class, $path) = @_;
239 File::Spec->catdir($path, 'bin');
242 sub install_base_perl_path {
243 my ($class, $path) = @_;
244 File::Spec->catdir($path, 'lib', 'perl5');
247 sub install_base_arch_path {
248 my ($class, $path) = @_;
249 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
252 sub ensure_dir_structure_for {
253 my ($class, $path) = @_;
255 warn "Attempting to create directory ${path}\n";
257 require File::Basename;
261 $path = File::Basename::dirname($path);
263 mkdir $_ for reverse @dirs;
267 sub guess_shelltype {
269 if(defined $ENV{'SHELL'}) {
270 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
271 $shellbin = $shell_bin_path_parts[-1];
274 local $_ = $shellbin;
282 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
283 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
284 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
285 $shellbin = $shell_bin_path_parts[-1];
287 local $_ = $shellbin;
290 } elsif(/cmd\.exe/) {
292 } elsif(/4nt\.exe/) {
302 sub print_environment_vars_for {
303 my ($class, $path, $deactivating, $interpolate) = @_;
304 print $class->environment_vars_string_for($path, $deactivating, $interpolate);
307 sub environment_vars_string_for {
308 my ($class, $path, $deactivating, $interpolate) = @_;
309 my @envs = $class->build_environment_vars_for($path, $deactivating, $interpolate);
312 # rather basic csh detection, goes on the assumption that something won't
313 # call itself csh unless it really is. also, default to bourne in the
314 # pathological situation where a user doesn't have $ENV{SHELL} defined.
315 # note also that shells with funny names, like zoid, are assumed to be
318 my $shelltype = $class->guess_shelltype;
321 my ($name, $value) = (shift(@envs), shift(@envs));
322 $value =~ s/(\\")/\\$1/g if defined $value;
323 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
328 # simple routines that take two arguments: an %ENV key and a value. return
329 # strings that are suitable for passing directly to the relevant shell to set
330 # said key to said value.
331 sub build_bourne_env_declaration {
333 my($name, $value) = @_;
334 return defined($value) ? qq{export ${name}="${value}";\n} : qq{unset ${name};\n};
337 sub build_csh_env_declaration {
339 my($name, $value) = @_;
340 return defined($value) ? qq{setenv ${name} "${value}";\n} : qq{unsetenv ${name};\n};
343 sub build_win32_env_declaration {
345 my($name, $value) = @_;
346 return defined($value) ? qq{set ${name}=${value}\n} : qq{set ${name}=\n};
349 sub setup_env_hash_for {
350 my ($class, $path, $deactivating) = @_;
351 my %envs = $class->build_environment_vars_for($path, $deactivating, INTERPOLATE_ENV);
352 @ENV{keys %envs} = values %envs;
355 sub build_environment_vars_for {
356 my ($class, $path, $deactivating, $interpolate) = @_;
358 if ($deactivating && $deactivating == DEACTIVATE_ONE) {
359 return $class->build_deactivate_environment_vars_for($path, $interpolate);
360 } elsif ($deactivating && $deactivating == DEACTIVATE_ALL) {
361 return $class->build_deact_all_environment_vars_for($path, $interpolate);
363 return $class->build_activate_environment_vars_for($path, $interpolate);
367 # Build an environment value for a variable like PATH from a list of paths.
368 # References to existing variables are given as references to the variable name.
369 # Duplicates are removed.
372 # - interpolate: INTERPOLATE_ENV/LITERAL_ENV
373 # - exists: paths are included only if they exist (default: interpolate == INTERPOLATE_ENV)
374 # - filter: function to apply to each path do decide if it must be included
375 # - empty: the value to return in the case of empty value
376 my %ENV_LIST_VALUE_DEFAULTS = (
377 interpolate => INTERPOLATE_ENV,
382 sub _env_list_value {
384 die(sprintf "unknown option '$_' at %s line %u\n", (caller)[1..2])
385 for grep { !exists $ENV_LIST_VALUE_DEFAULTS{$_} } keys %$options;
386 my %options = (%ENV_LIST_VALUE_DEFAULTS, %{ $options });
387 $options{exists} = $options{interpolate} == INTERPOLATE_ENV
388 unless defined $options{exists};
392 my $value = join($Config{path_sep}, map {
393 ref $_ ? ($^O eq 'MSWin32' ? "%${$_}%" : "\$${$_}") : $_
395 ref $_ || (defined $_
398 && $options{filter}->($_)
399 && (!$options{exists} || -e $_))
401 if (ref $_ eq 'SCALAR' && $options{interpolate} == INTERPOLATE_ENV) {
402 defined $ENV{${$_}} ? (split /\Q$Config{path_sep}/, $ENV{${$_}}) : ()
407 return length($value) ? $value : $options{empty};
410 sub build_activate_environment_vars_for {
411 my ($class, $path, $interpolate) = @_;
413 PERL_LOCAL_LIB_ROOT =>
415 { interpolate => $interpolate, exists => 0, empty => '' },
417 \'PERL_LOCAL_LIB_ROOT',
419 PERL_MB_OPT => "--install_base " . _mb_escape_path($path),
420 PERL_MM_OPT => "INSTALL_BASE=" . _mm_escape_path($path),
423 { interpolate => $interpolate, exists => 0, empty => '' },
424 $class->install_base_perl_path($path),
427 PATH => _env_list_value(
428 { interpolate => $interpolate, exists => 0, empty => '' },
429 $class->install_base_bin_path($path),
435 sub _mm_escape_path {
437 $path =~ s/\\/\\\\\\\\/g;
438 if ($path =~ s/ /\\ /g) {
439 $path = qq{"\\"$path\\""};
444 sub _mb_escape_path {
446 $path =~ s/\\/\\\\/g;
453 return () unless defined $ENV{PERL_LOCAL_LIB_ROOT};
456 # screen out entries that aren't actually reflected in @INC
457 my $active_ll = $class->install_base_perl_path($_);
458 grep { $_ eq $active_ll } @INC
461 split /\Q$Config{path_sep}\E/, $ENV{PERL_LOCAL_LIB_ROOT};
464 sub build_deactivate_environment_vars_for {
465 my ($class, $path, $interpolate) = @_;
467 my @active_lls = $class->active_paths;
469 if (!grep { $_ eq $path } @active_lls) {
470 warn "Tried to deactivate inactive local::lib '$path'\n";
474 my $perl_path = $class->install_base_perl_path($path);
475 my $arch_path = $class->install_base_arch_path($path);
476 my $bin_path = $class->install_base_bin_path($path);
480 PERL_LOCAL_LIB_ROOT => _env_list_value(
484 grep { $_ ne $path } @active_lls
486 PERL5LIB => _env_list_value(
490 $_ ne $perl_path && $_ ne $arch_path
495 PATH => _env_list_value(
498 filter => sub { $_ ne $bin_path },
504 # If removing ourselves from the "top of the stack", set install paths to
505 # correspond with the new top of stack.
506 if ($active_lls[0] eq $path) {
507 my $new_top = $active_lls[1];
508 $env{PERL_MB_OPT} = defined($new_top) ? "--install_base "._mb_escape_path($new_top) : undef;
509 $env{PERL_MM_OPT} = defined($new_top) ? "INSTALL_BASE="._mm_escape_path($new_top) : undef;
515 sub build_deact_all_environment_vars_for {
516 my ($class, $path, $interpolate) = @_;
518 my @active_lls = $class->active_paths;
520 my %perl_paths = map { (
521 $class->install_base_perl_path($_) => 1,
522 $class->install_base_arch_path($_) => 1
524 my %bin_paths = map { (
525 $class->install_base_bin_path($_) => 1,
529 PERL_LOCAL_LIB_ROOT => undef,
530 PERL_MM_OPT => undef,
531 PERL_MB_OPT => undef,
532 PERL5LIB => _env_list_value(
536 ! scalar grep { exists $perl_paths{$_} } $_[0]
541 PATH => _env_list_value(
545 ! scalar grep { exists $bin_paths{$_} } $_[0]
559 File::Path::rmtree('t/var/splat');
561 $c->ensure_dir_structure_for('t/var/splat');
563 ok(-d 't/var/splat');
571 local::lib - create and use a local lib/ for perl modules with PERL5LIB
577 use local::lib; # sets up a local lib at ~/perl5
579 use local::lib '~/foo'; # same, but ~/foo
583 use local::lib "$FindBin::Bin/../support"; # app-local support library
587 # Install LWP and its missing dependencies to the '~/perl5' directory
588 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
590 # Just print out useful shell commands
592 export PERL_MB_OPT='--install_base /home/username/perl5'
593 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
594 export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5'
595 export PATH="/home/username/perl5/bin:$PATH"
597 =head2 The bootstrapping technique
599 A typical way to install local::lib is using what is known as the
600 "bootstrapping" technique. You would do this if your system administrator
601 hasn't already installed local::lib. In this case, you'll need to install
602 local::lib in your home directory.
604 Even if you do have administrative privileges, you will still want to set up your
605 environment variables, as discussed in step 4. Without this, you would still
606 install the modules into the system CPAN installation and also your Perl scripts
607 will not use the lib/ path you bootstrapped with local::lib.
609 By default local::lib installs itself and the CPAN modules into ~/perl5.
611 Windows users must also see L</Differences when using this module under Win32>.
613 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
614 on the CPAN page about local::lib). Do this as an ordinary user, not as root
615 or administrator. Unpack the file in your home directory or in any other
620 perl Makefile.PL --bootstrap
622 If the system asks you whether it should automatically configure as much
623 as possible, you would typically answer yes.
625 In order to install local::lib into a directory other than the default, you need
626 to specify the name of the directory when you call bootstrap, as follows:
628 perl Makefile.PL --bootstrap=~/foo
630 3. Run this: (local::lib assumes you have make installed on your system)
632 make test && make install
634 4. Now we need to setup the appropriate environment variables, so that Perl
635 starts using our newly generated lib/ directory. If you are using bash or
636 any other Bourne shells, you can add this to your shell startup script this
639 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
641 If you are using C shell, you can do this as follows:
646 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
648 If you passed to bootstrap a directory other than default, you also need to give that as
649 import parameter to the call of the local::lib module like this way:
651 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
653 After writing your shell configuration file, be sure to re-read it to get the
654 changed settings into your current shell's environment. Bourne shells use
655 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
657 If you're on a slower machine, or are operating under draconian disk space
658 limitations, you can disable the automatic generation of manpages from POD when
659 installing modules by using the C<--no-manpages> argument when bootstrapping:
661 perl Makefile.PL --bootstrap --no-manpages
663 To avoid doing several bootstrap for several Perl module environments on the
664 same account, for example if you use it for several different deployed
665 applications independently, you can use one bootstrapped local::lib
666 installation to install modules in different directories directly this way:
670 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
671 printenv ### You will see that ~/mydir1 is in the PERL5LIB
672 perl -MCPAN -e install ... ### whatever modules you want
676 If you are working with several C<local::lib> environments, you may want to
677 remove some of them from the current environment without disturbing the others.
678 You can deactivate one environment like this (using bourne sh):
680 eval $(perl -Mlocal::lib=--deactivate,~/path)
682 which will generate and run the commands needed to remove C<~/path> from your
683 various search paths. Whichever environment was B<activated most recently> will
684 remain the target for module installations. That is, if you activate
685 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
686 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
687 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
688 installed in C<~/pathB> because pathB was activated later.
690 You can also ask C<local::lib> to clean itself completely out of the current
691 shell's environment with the C<--deactivate-all> option.
692 For multiple environments for multiple apps you may need to include a modified
693 version of the C<< use FindBin >> instructions in the "In code" sample above.
694 If you did something like the above, you have a set of Perl modules at C<<
695 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
696 you need to tell it where to find the modules you installed for it at C<<
699 In C<< ~/mydir1/scripts/myscript.pl >>:
703 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
704 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
706 Put this before any BEGIN { ... } blocks that require the modules you installed.
708 =head2 Differences when using this module under Win32
710 To set up the proper environment variables for your current session of
711 C<CMD.exe>, you can use this:
713 C:\>perl -Mlocal::lib
714 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
715 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
716 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
717 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
719 ### To set the environment for this shell alone
720 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
721 ### instead of $(perl -Mlocal::lib=./)
723 If you want the environment entries to persist, you'll need to add then to the
724 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
726 The "~" is translated to the user's profile directory (the directory named for
727 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
728 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
729 directory is translated to a short name (which means the directory must exist)
730 and the subdirectories are created.
734 The version of a Perl package on your machine is not always the version you
735 need. Obviously, the best thing to do would be to update to the version you
736 need. However, you might be in a situation where you're prevented from doing
737 this. Perhaps you don't have system administrator privileges; or perhaps you
738 are using a package management system such as Debian, and nobody has yet gotten
739 around to packaging up the version you need.
741 local::lib solves this problem by allowing you to create your own directory of
742 Perl packages downloaded from CPAN (in a multi-user system, this would typically
743 be within your own home directory). The existing system Perl installation is
744 not affected; you simply invoke Perl with special options so that Perl uses the
745 packages in your own local package directory rather than the system packages.
746 local::lib arranges things so that your locally installed version of the Perl
747 packages takes precedence over the system installation.
749 If you are using a package management system (such as Debian), you don't need to
750 worry about Debian and CPAN stepping on each other's toes. Your local version
751 of the packages will be written to an entirely separate directory from those
756 This module provides a quick, convenient way of bootstrapping a user-local Perl
757 module library located within the user's home directory. It also constructs and
758 prints out for the user the list of environment variables using the syntax
759 appropriate for the user's current shell (as specified by the C<SHELL>
760 environment variable), suitable for directly adding to one's shell
763 More generally, local::lib allows for the bootstrapping and usage of a
764 directory containing Perl modules outside of Perl's C<@INC>. This makes it
765 easier to ship an application with an app-specific copy of a Perl module, or
766 collection of modules. Useful in cases like when an upstream maintainer hasn't
767 applied a patch to a module of theirs that you need for your application.
769 On import, local::lib sets the following environment variables to appropriate
782 PATH is appended to, rather than clobbered.
786 These values are then available for reference by any code after import.
788 =head1 CREATING A SELF-CONTAINED SET OF MODULES
790 See L<lib::core::only> for one way to do this - but note that
791 there are a number of caveats, and the best approach is always to perform a
792 build against a clean perl (i.e. site and vendor as close to empty as possible).
796 Options are values that can be passed to the C<local::lib> import besides the
797 directory to use. They are specified as C<use local::lib '--option'[, path];>
798 or C<perl -Mlocal::lib=--option[,path]>.
802 Remove the chosen path (or the default path) from the module search paths if it
803 was added by C<local::lib>, instead of adding it.
805 =head2 --deactivate-all
807 Remove all directories that were added to search paths by C<local::lib> from the
812 =head2 ensure_dir_structure_for
816 =item Arguments: $path
818 =item Return value: None
822 Attempts to create the given path, and all required parent directories. Throws
823 an exception on failure.
825 =head2 print_environment_vars_for
829 =item Arguments: $path
831 =item Return value: None
835 Prints to standard output the variables listed above, properly set to use the
836 given path as the base directory.
838 =head2 build_environment_vars_for
842 =item Arguments: $path, $interpolate
844 =item Return value: \%environment_vars
848 Returns a hash with the variables listed above, properly set to use the
849 given path as the base directory.
851 =head2 setup_env_hash_for
855 =item Arguments: $path
857 =item Return value: None
861 Constructs the C<%ENV> keys for the given path, by calling
862 L</build_environment_vars_for>.
868 =item Arguments: None
870 =item Return value: @paths
874 Returns a list of active C<local::lib> paths, according to the
875 C<PERL_LOCAL_LIB_ROOT> environment variable and verified against
876 what is really in C<@INC>.
878 =head2 install_base_perl_path
882 =item Arguments: $path
884 =item Return value: $install_base_perl_path
888 Returns a path describing where to install the Perl modules for this local
889 library installation. Appends the directories C<lib> and C<perl5> to the given
892 =head2 install_base_arch_path
896 =item Arguments: $path
898 =item Return value: $install_base_arch_path
902 Returns a path describing where to install the architecture-specific Perl
903 modules for this local library installation. Based on the
904 L</install_base_perl_path> method's return value, and appends the value of
905 C<$Config{archname}>.
907 =head2 install_base_bin_path
911 =item Arguments: $path
913 =item Return value: $install_base_bin_path
917 Returns a path describing where to install the executable programs for this
918 local library installation. Based on the L</install_base_perl_path> method's
919 return value, and appends the directory C<bin>.
921 =head2 resolve_empty_path
925 =item Arguments: $path
927 =item Return value: $base_path
931 Builds and returns the base path into which to set up the local module
932 installation. Defaults to C<~/perl5>.
934 =head2 resolve_home_path
938 =item Arguments: $path
940 =item Return value: $home_path
944 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
945 for this purpose. If no definite answer is available, throws an exception.
947 =head2 resolve_relative_path
951 =item Arguments: $path
953 =item Return value: $absolute_path
957 Translates the given path into an absolute path.
963 =item Arguments: $path
965 =item Return value: $absolute_path
969 Calls the following in a pipeline, passing the result from the previous to the
970 next, in an attempt to find where to configure the environment for a local
971 library installation: L</resolve_empty_path>, L</resolve_home_path>,
972 L</resolve_relative_path>. Passes the given path argument to
973 L</resolve_empty_path> which then returns a result that is passed to
974 L</resolve_home_path>, which then has its result passed to
975 L</resolve_relative_path>. The result of this final call is returned from
978 =head1 A WARNING ABOUT UNINST=1
980 Be careful about using local::lib in combination with "make install UNINST=1".
981 The idea of this feature is that will uninstall an old version of a module
982 before installing a new one. However it lacks a safety check that the old
983 version and the new version will go in the same directory. Used in combination
984 with local::lib, you can potentially delete a globally accessible version of a
985 module while installing the new version in a local place. Only combine "make
986 install UNINST=1" and local::lib if you understand these possible consequences.
992 =item * The perl toolchain is unable to handle directory names with spaces in it,
993 so you can't put your local::lib bootstrap into a directory with spaces. What
994 you can do is moving your local::lib to a directory with spaces B<after> you
995 installed all modules inside your local::lib bootstrap. But be aware that you
996 can't update or install CPAN modules after the move.
998 =item * Rather basic shell detection. Right now anything with csh in its name is
999 assumed to be a C shell or something compatible, and everything else is assumed
1000 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
1001 not set, a Bourne-compatible shell is assumed.
1003 =item * Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
1004 have CPANPLUS installed.
1006 =item * Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT.
1008 =item * Should probably auto-fixup CPAN config if not already done.
1012 Patches very much welcome for any of the above.
1016 =item * On Win32 systems, does not have a way to write the created environment variables
1017 to the registry, so that they can persist through a reboot.
1021 =head1 TROUBLESHOOTING
1023 If you've configured local::lib to install CPAN modules somewhere in to your
1024 home directory, and at some point later you try to install a module with C<cpan
1025 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1026 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1027 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1028 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1029 you've somehow lost your updated ExtUtils::MakeMaker module.
1031 To remedy this situation, rerun the bootstrapping procedure documented above.
1033 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1035 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1045 local::lib looks at the user's C<SHELL> environment variable when printing out
1046 commands to add to the shell configuration file.
1048 On Win32 systems, C<COMSPEC> is also examined.
1056 =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html>
1064 Join #local-lib on irc.perl.org.
1068 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1070 auto_install fixes kindly sponsored by http://www.takkle.com/
1074 Patches to correctly output commands for csh style shells, as well as some
1075 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1077 Doc patches for a custom local::lib directory, more cleanups in the english
1078 documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
1079 <torsten@raudssus.de>.
1081 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1082 things will install properly, submitted a fix for the bug causing problems with
1083 writing Makefiles during bootstrapping, contributed an example program, and
1084 submitted yet another fix to ensure that local::lib can install and bootstrap
1085 properly. Many, many thanks!
1087 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1088 section. Many thanks!
1090 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1092 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1093 by a patch from Marco Emilio Poleggi.
1095 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1096 '--self-contained' option.
1098 Documentation patches to make win32 usage clearer by
1099 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1101 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
1102 G. de Oliveira <garu@cpan.org>.
1104 Improvements to stacking multiple local::lib dirs and removing them from the
1105 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1107 Patch for Carp version mismatch contributed by Hakim Cassimally <osfameron@cpan.org>.
1111 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1116 This is free software; you can redistribute it and/or modify it under
1117 the same terms as the Perl 5 programming language system itself.