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.008023'; # 1.8.23
14 $VERSION = eval $VERSION;
16 our @KNOWN_FLAGS = qw(--self-contained --deactivate --deactivate-all);
18 sub DEACTIVATE_ONE () { 1 }
19 sub DEACTIVATE_ALL () { 2 }
21 sub INTERPOLATE_ENV () { 1 }
22 sub LITERAL_ENV () { 0 }
25 my ($class, @args) = @_;
27 # Remember what PERL5LIB was when we started
28 my $perl5lib = $ENV{PERL5LIB} || '';
32 # check for lethal dash first to stop processing before causing problems
33 # the fancy dash is U+2212 or \xE2\x88\x92
34 if ($arg =~ /\xE2\x88\x92/ or $arg =~ /−/) {
36 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
37 These are *not* the traditional -- dashes that software recognizes. You
38 probably got these by copy-pasting from the perldoc for this module as
39 rendered by a UTF8-capable formatter. This most typically happens on an OS X
40 terminal, but can happen elsewhere too. Please try again after replacing the
41 dashes with normal minus signs.
44 elsif(grep { $arg eq $_ } @KNOWN_FLAGS) {
45 (my $flag = $arg) =~ s/--//;
46 $arg_store{$flag} = 1;
48 elsif($arg =~ /^--/) {
49 die "Unknown import argument: $arg";
52 # assume that what's left is a path
53 $arg_store{path} = $arg;
57 if($arg_store{'self-contained'}) {
58 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";
62 if ($arg_store{deactivate}) {
63 $deactivating = DEACTIVATE_ONE;
65 if ($arg_store{'deactivate-all'}) {
66 $deactivating = DEACTIVATE_ALL;
69 $arg_store{path} = $class->resolve_path($arg_store{path});
70 $class->setup_local_lib_for($arg_store{path}, $deactivating);
72 for (@INC) { # Untaint @INC
73 next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc.
82 my $last = pop(@methods);
85 my ($obj, @args) = @_;
86 $obj->${pipeline @methods}(
103 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
104 my $foo = bless({}, 'Foo');
105 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
113 grep { ! $seen{$_}++ } @_;
117 my ($class, $path) = @_;
118 $class->${pipeline qw(
119 resolve_relative_path
125 sub resolve_empty_path {
126 my ($class, $path) = @_;
136 #:: test classmethod setup
138 my $c = 'local::lib';
146 is($c->resolve_empty_path, '~/perl5');
147 is($c->resolve_empty_path('foo'), 'foo');
153 sub resolve_home_path {
154 my ($class, $path) = @_;
155 return $path unless ($path =~ /^~/);
156 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
157 my $tried_file_homedir;
159 if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) {
160 $tried_file_homedir = 1;
162 File::HomeDir->users_home($user);
164 File::HomeDir->my_home;
170 if (defined $ENV{HOME}) {
178 unless (defined $homedir) {
181 "Couldn't resolve homedir for "
182 .(defined $user ? $user : 'current user')
183 .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
186 $path =~ s/^~[^\/]*/$homedir/;
190 sub resolve_relative_path {
191 my ($class, $path) = @_;
192 $path = File::Spec->rel2abs($path);
199 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
200 is($c->resolve_relative_path('bar'),'FOObar');
206 sub setup_local_lib_for {
207 my ($class, $path, $deactivating) = @_;
209 my $interpolate = LITERAL_ENV;
210 my @active_lls = $class->active_paths;
212 $class->ensure_dir_structure_for($path);
214 # On Win32 directories often contain spaces. But some parts of the CPAN
215 # toolchain don't like that. To avoid this, GetShortPathName() gives us
216 # an alternate representation that has none.
217 # This only works if the directory already exists.
218 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
220 if (! $deactivating) {
221 if (@active_lls && $active_lls[-1] eq $path) {
223 return; # Asked to add what's already at the top of the stack
224 } elsif (grep { $_ eq $path} @active_lls) {
225 # Asked to add a dir that's lower in the stack -- so we remove it from
226 # where it is, and then add it back at the top.
227 $class->setup_env_hash_for($path, DEACTIVATE_ONE);
228 # Which means we can no longer output "PERL5LIB=...:$PERL5LIB" stuff
229 # anymore because we're taking something *out*.
230 $interpolate = INTERPOLATE_ENV;
235 $class->print_environment_vars_for($path, $deactivating, $interpolate);
238 $class->setup_env_hash_for($path, $deactivating);
239 my $arch_dir = $Config{archname};
242 # Inject $path/$archname for each path in PERL5LIB
243 map { ( File::Spec->catdir($_, $arch_dir), $_ ) }
244 split($Config{path_sep}, $ENV{PERL5LIB})
251 sub install_base_bin_path {
252 my ($class, $path) = @_;
253 File::Spec->catdir($path, 'bin');
256 sub install_base_perl_path {
257 my ($class, $path) = @_;
258 File::Spec->catdir($path, 'lib', 'perl5');
261 sub install_base_arch_path {
262 my ($class, $path) = @_;
263 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
266 sub ensure_dir_structure_for {
267 my ($class, $path) = @_;
269 warn "Attempting to create directory ${path}\n";
271 File::Path::mkpath($path);
275 sub guess_shelltype {
277 if(defined $ENV{'SHELL'}) {
278 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
279 $shellbin = $shell_bin_path_parts[-1];
282 local $_ = $shellbin;
290 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
291 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
292 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
293 $shellbin = $shell_bin_path_parts[-1];
295 local $_ = $shellbin;
298 } elsif(/cmd\.exe/) {
300 } elsif(/4nt\.exe/) {
310 sub print_environment_vars_for {
311 my ($class, $path, $deactivating, $interpolate) = @_;
312 print $class->environment_vars_string_for($path, $deactivating, $interpolate);
315 sub environment_vars_string_for {
316 my ($class, $path, $deactivating, $interpolate) = @_;
317 my @envs = $class->build_environment_vars_for($path, $deactivating, $interpolate);
320 # rather basic csh detection, goes on the assumption that something won't
321 # call itself csh unless it really is. also, default to bourne in the
322 # pathological situation where a user doesn't have $ENV{SHELL} defined.
323 # note also that shells with funny names, like zoid, are assumed to be
326 my $shelltype = $class->guess_shelltype;
329 my ($name, $value) = (shift(@envs), shift(@envs));
330 $value =~ s/(\\")/\\$1/g if defined $value;
331 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
336 # simple routines that take two arguments: an %ENV key and a value. return
337 # strings that are suitable for passing directly to the relevant shell to set
338 # said key to said value.
339 sub build_bourne_env_declaration {
341 my($name, $value) = @_;
342 return defined($value) ? qq{export ${name}="${value}";\n} : qq{unset ${name};\n};
345 sub build_csh_env_declaration {
347 my($name, $value) = @_;
348 return defined($value) ? qq{setenv ${name} "${value}"\n} : qq{unsetenv ${name}\n};
351 sub build_win32_env_declaration {
353 my($name, $value) = @_;
354 return defined($value) ? qq{set ${name}=${value}\n} : qq{set ${name}=\n};
357 sub setup_env_hash_for {
358 my ($class, $path, $deactivating) = @_;
359 my %envs = $class->build_environment_vars_for($path, $deactivating, INTERPOLATE_ENV);
360 @ENV{keys %envs} = values %envs;
363 sub build_environment_vars_for {
364 my ($class, $path, $deactivating, $interpolate) = @_;
366 if ($deactivating == DEACTIVATE_ONE) {
367 return $class->build_deactivate_environment_vars_for($path, $interpolate);
368 } elsif ($deactivating == DEACTIVATE_ALL) {
369 return $class->build_deact_all_environment_vars_for($path, $interpolate);
371 return $class->build_activate_environment_vars_for($path, $interpolate);
375 # Build an environment value for a variable like PATH from a list of paths.
376 # References to existing variables are given as references to the variable name.
377 # Duplicates are removed.
380 # - interpolate: INTERPOLATE_ENV/LITERAL_ENV
381 # - exists: paths are included only if they exist (default: interpolate == INTERPOLATE_ENV)
382 # - filter: function to apply to each path do decide if it must be included
383 # - empty: the value to return in the case of empty value
384 my %ENV_LIST_VALUE_DEFAULTS = (
385 interpolate => INTERPOLATE_ENV,
390 sub _env_list_value {
392 die(sprintf "unknown option '$_' at %s line %u\n", (caller)[1..2])
393 for grep { !exists $ENV_LIST_VALUE_DEFAULTS{$_} } keys %$options;
394 my %options = (%ENV_LIST_VALUE_DEFAULTS, %{ $options });
395 $options{exists} = $options{interpolate} == INTERPOLATE_ENV
396 unless defined $options{exists};
400 my $value = join($Config{path_sep}, map {
401 ref $_ ? ($^O eq 'MSWin32' ? "%${$_}%" : "\$${$_}") : $_
403 ref $_ || (defined $_
406 && $options{filter}->($_)
407 && (!$options{exists} || -e $_))
409 if (ref $_ eq 'SCALAR' && $options{interpolate} == INTERPOLATE_ENV) {
410 defined $ENV{${$_}} ? (split /\Q$Config{path_sep}/, $ENV{${$_}}) : ()
415 return length($value) ? $value : $options{empty};
418 sub build_activate_environment_vars_for {
419 my ($class, $path, $interpolate) = @_;
421 PERL_LOCAL_LIB_ROOT =>
423 { interpolate => $interpolate, exists => 0, empty => '' },
424 \'PERL_LOCAL_LIB_ROOT',
427 PERL_MB_OPT => "--install_base " . _mb_escape_path($path),
428 PERL_MM_OPT => "INSTALL_BASE=" . _mm_escape_path($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 $arch_path = $class->install_base_arch_path($path);
484 my $bin_path = $class->install_base_bin_path($path);
488 PERL_LOCAL_LIB_ROOT => _env_list_value(
492 grep { $_ ne $path } @active_lls
494 PERL5LIB => _env_list_value(
498 $_ ne $perl_path && $_ ne $arch_path
503 PATH => _env_list_value(
506 filter => sub { $_ ne $bin_path },
512 # If removing ourselves from the "top of the stack", set install paths to
513 # correspond with the new top of stack.
514 if ($active_lls[-1] eq $path) {
515 my $new_top = $active_lls[-2];
516 $env{PERL_MB_OPT} = defined($new_top) ? "--install_base "._mb_escape_path($new_top) : undef;
517 $env{PERL_MM_OPT} = defined($new_top) ? "INSTALL_BASE="._mm_escape_path($new_top) : undef;
523 sub build_deact_all_environment_vars_for {
524 my ($class, $path, $interpolate) = @_;
526 my @active_lls = $class->active_paths;
528 my %perl_paths = map { (
529 $class->install_base_perl_path($_) => 1,
530 $class->install_base_arch_path($_) => 1
532 my %bin_paths = map { (
533 $class->install_base_bin_path($_) => 1,
537 PERL_LOCAL_LIB_ROOT => undef,
538 PERL_MM_OPT => undef,
539 PERL_MB_OPT => undef,
540 PERL5LIB => _env_list_value(
544 ! scalar grep { exists $perl_paths{$_} } $_[0]
549 PATH => _env_list_value(
553 ! scalar grep { exists $bin_paths{$_} } $_[0]
567 File::Path::rmtree('t/var/splat');
569 $c->ensure_dir_structure_for('t/var/splat');
571 ok(-d 't/var/splat');
579 local::lib - create and use a local lib/ for perl modules with PERL5LIB
585 use local::lib; # sets up a local lib at ~/perl5
587 use local::lib '~/foo'; # same, but ~/foo
591 use local::lib "$FindBin::Bin/../support"; # app-local support library
595 # Install LWP and its missing dependencies to the '~/perl5' directory
596 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
598 # Just print out useful shell commands
600 export PERL_MB_OPT='--install_base /home/username/perl5'
601 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
602 export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5'
603 export PATH="/home/username/perl5/bin:$PATH"
605 =head2 The bootstrapping technique
607 A typical way to install local::lib is using what is known as the
608 "bootstrapping" technique. You would do this if your system administrator
609 hasn't already installed local::lib. In this case, you'll need to install
610 local::lib in your home directory.
612 Even if you do have administrative privileges, you will still want to set up your
613 environment variables, as discussed in step 4. Without this, you would still
614 install the modules into the system CPAN installation and also your Perl scripts
615 will not use the lib/ path you bootstrapped with local::lib.
617 By default local::lib installs itself and the CPAN modules into ~/perl5.
619 Windows users must also see L</Differences when using this module under Win32>.
621 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
622 on the CPAN page about local::lib). Do this as an ordinary user, not as root
623 or administrator. Unpack the file in your home directory or in any other
628 perl Makefile.PL --bootstrap
630 If the system asks you whether it should automatically configure as much
631 as possible, you would typically answer yes.
633 In order to install local::lib into a directory other than the default, you need
634 to specify the name of the directory when you call bootstrap, as follows:
636 perl Makefile.PL --bootstrap=~/foo
638 3. Run this: (local::lib assumes you have make installed on your system)
640 make test && make install
642 4. Now we need to setup the appropriate environment variables, so that Perl
643 starts using our newly generated lib/ directory. If you are using bash or
644 any other Bourne shells, you can add this to your shell startup script this
647 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
649 If you are using C shell, you can do this as follows:
654 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
656 If you passed to bootstrap a directory other than default, you also need to give that as
657 import parameter to the call of the local::lib module like this way:
659 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
661 After writing your shell configuration file, be sure to re-read it to get the
662 changed settings into your current shell's environment. Bourne shells use
663 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
665 If you're on a slower machine, or are operating under draconian disk space
666 limitations, you can disable the automatic generation of manpages from POD when
667 installing modules by using the C<--no-manpages> argument when bootstrapping:
669 perl Makefile.PL --bootstrap --no-manpages
671 To avoid doing several bootstrap for several Perl module environments on the
672 same account, for example if you use it for several different deployed
673 applications independently, you can use one bootstrapped local::lib
674 installation to install modules in different directories directly this way:
678 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
679 printenv ### You will see that ~/mydir1 is in the PERL5LIB
680 perl -MCPAN -e install ... ### whatever modules you want
684 If you are working with several C<local::lib> environments, you may want to
685 remove some of them from the current environment without disturbing the others.
686 You can deactivate one environment like this (using bourne sh):
688 eval $(perl -Mlocal::lib=--deactivate,~/path)
690 which will generate and run the commands needed to remove C<~/path> from your
691 various search paths. Whichever environment was B<activated most recently> will
692 remain the target for module installations. That is, if you activate
693 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
694 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
695 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
696 installed in C<~/pathB> because pathB was activated later.
698 You can also ask C<local::lib> to clean itself completely out of the current
699 shell's environment with the C<--deactivate-all> option.
700 For multiple environments for multiple apps you may need to include a modified
701 version of the C<< use FindBin >> instructions in the "In code" sample above.
702 If you did something like the above, you have a set of Perl modules at C<<
703 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
704 you need to tell it where to find the modules you installed for it at C<<
707 In C<< ~/mydir1/scripts/myscript.pl >>:
711 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
712 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
714 Put this before any BEGIN { ... } blocks that require the modules you installed.
716 =head2 Differences when using this module under Win32
718 To set up the proper environment variables for your current session of
719 C<CMD.exe>, you can use this:
721 C:\>perl -Mlocal::lib
722 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
723 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
724 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
725 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
727 ### To set the environment for this shell alone
728 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
729 ### instead of $(perl -Mlocal::lib=./)
731 If you want the environment entries to persist, you'll need to add then to the
732 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
734 The "~" is translated to the user's profile directory (the directory named for
735 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
736 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
737 directory is translated to a short name (which means the directory must exist)
738 and the subdirectories are created.
742 The version of a Perl package on your machine is not always the version you
743 need. Obviously, the best thing to do would be to update to the version you
744 need. However, you might be in a situation where you're prevented from doing
745 this. Perhaps you don't have system administrator privileges; or perhaps you
746 are using a package management system such as Debian, and nobody has yet gotten
747 around to packaging up the version you need.
749 local::lib solves this problem by allowing you to create your own directory of
750 Perl packages downloaded from CPAN (in a multi-user system, this would typically
751 be within your own home directory). The existing system Perl installation is
752 not affected; you simply invoke Perl with special options so that Perl uses the
753 packages in your own local package directory rather than the system packages.
754 local::lib arranges things so that your locally installed version of the Perl
755 packages takes precedence over the system installation.
757 If you are using a package management system (such as Debian), you don't need to
758 worry about Debian and CPAN stepping on each other's toes. Your local version
759 of the packages will be written to an entirely separate directory from those
764 This module provides a quick, convenient way of bootstrapping a user-local Perl
765 module library located within the user's home directory. It also constructs and
766 prints out for the user the list of environment variables using the syntax
767 appropriate for the user's current shell (as specified by the C<SHELL>
768 environment variable), suitable for directly adding to one's shell
771 More generally, local::lib allows for the bootstrapping and usage of a
772 directory containing Perl modules outside of Perl's C<@INC>. This makes it
773 easier to ship an application with an app-specific copy of a Perl module, or
774 collection of modules. Useful in cases like when an upstream maintainer hasn't
775 applied a patch to a module of theirs that you need for your application.
777 On import, local::lib sets the following environment variables to appropriate
790 PATH is appended to, rather than clobbered.
794 These values are then available for reference by any code after import.
796 =head1 CREATING A SELF-CONTAINED SET OF MODULES
798 See L<lib::core::only> for one way to do this - but note that
799 there are a number of caveats, and the best approach is always to perform a
800 build against a clean perl (i.e. site and vendor as close to empty as possible).
804 Options are values that can be passed to the C<local::lib> import besides the
805 directory to use. They are specified as C<use local::lib '--option'[, path];>
806 or C<perl -Mlocal::lib=--option[,path]>.
810 Remove the chosen path (or the default path) from the module search paths if it
811 was added by C<local::lib>, instead of adding it.
813 =head2 --deactivate-all
815 Remove all directories that were added to search paths by C<local::lib> from the
820 =head2 ensure_dir_structure_for
824 =item Arguments: $path
826 =item Return value: None
830 Attempts to create the given path, and all required parent directories. Throws
831 an exception on failure.
833 =head2 print_environment_vars_for
837 =item Arguments: $path
839 =item Return value: None
843 Prints to standard output the variables listed above, properly set to use the
844 given path as the base directory.
846 =head2 build_environment_vars_for
850 =item Arguments: $path, $interpolate
852 =item Return value: \%environment_vars
856 Returns a hash with the variables listed above, properly set to use the
857 given path as the base directory.
859 =head2 setup_env_hash_for
863 =item Arguments: $path
865 =item Return value: None
869 Constructs the C<%ENV> keys for the given path, by calling
870 L</build_environment_vars_for>.
876 =item Arguments: None
878 =item Return value: @paths
882 Returns a list of active C<local::lib> paths, according to the
883 C<PERL_LOCAL_LIB_ROOT> environment variable and verified against
884 what is really in C<@INC>.
886 =head2 install_base_perl_path
890 =item Arguments: $path
892 =item Return value: $install_base_perl_path
896 Returns a path describing where to install the Perl modules for this local
897 library installation. Appends the directories C<lib> and C<perl5> to the given
900 =head2 install_base_arch_path
904 =item Arguments: $path
906 =item Return value: $install_base_arch_path
910 Returns a path describing where to install the architecture-specific Perl
911 modules for this local library installation. Based on the
912 L</install_base_perl_path> method's return value, and appends the value of
913 C<$Config{archname}>.
915 =head2 install_base_bin_path
919 =item Arguments: $path
921 =item Return value: $install_base_bin_path
925 Returns a path describing where to install the executable programs for this
926 local library installation. Based on the L</install_base_perl_path> method's
927 return value, and appends the directory C<bin>.
929 =head2 resolve_empty_path
933 =item Arguments: $path
935 =item Return value: $base_path
939 Builds and returns the base path into which to set up the local module
940 installation. Defaults to C<~/perl5>.
942 =head2 resolve_home_path
946 =item Arguments: $path
948 =item Return value: $home_path
952 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
953 for this purpose. If no definite answer is available, throws an exception.
955 =head2 resolve_relative_path
959 =item Arguments: $path
961 =item Return value: $absolute_path
965 Translates the given path into an absolute path.
971 =item Arguments: $path
973 =item Return value: $absolute_path
977 Calls the following in a pipeline, passing the result from the previous to the
978 next, in an attempt to find where to configure the environment for a local
979 library installation: L</resolve_empty_path>, L</resolve_home_path>,
980 L</resolve_relative_path>. Passes the given path argument to
981 L</resolve_empty_path> which then returns a result that is passed to
982 L</resolve_home_path>, which then has its result passed to
983 L</resolve_relative_path>. The result of this final call is returned from
986 =head1 A WARNING ABOUT UNINST=1
988 Be careful about using local::lib in combination with "make install UNINST=1".
989 The idea of this feature is that will uninstall an old version of a module
990 before installing a new one. However it lacks a safety check that the old
991 version and the new version will go in the same directory. Used in combination
992 with local::lib, you can potentially delete a globally accessible version of a
993 module while installing the new version in a local place. Only combine "make
994 install UNINST=1" and local::lib if you understand these possible consequences.
1000 =item * The perl toolchain is unable to handle directory names with spaces in it,
1001 so you can't put your local::lib bootstrap into a directory with spaces. What
1002 you can do is moving your local::lib to a directory with spaces B<after> you
1003 installed all modules inside your local::lib bootstrap. But be aware that you
1004 can't update or install CPAN modules after the move.
1006 =item * Rather basic shell detection. Right now anything with csh in its name is
1007 assumed to be a C shell or something compatible, and everything else is assumed
1008 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
1009 not set, a Bourne-compatible shell is assumed.
1011 =item * Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
1012 have CPANPLUS installed.
1014 =item * Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT.
1016 =item * Should probably auto-fixup CPAN config if not already done.
1020 Patches very much welcome for any of the above.
1024 =item * On Win32 systems, does not have a way to write the created environment variables
1025 to the registry, so that they can persist through a reboot.
1029 =head1 TROUBLESHOOTING
1031 If you've configured local::lib to install CPAN modules somewhere in to your
1032 home directory, and at some point later you try to install a module with C<cpan
1033 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1034 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1035 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1036 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1037 you've somehow lost your updated ExtUtils::MakeMaker module.
1039 To remedy this situation, rerun the bootstrapping procedure documented above.
1041 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1043 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1053 local::lib looks at the user's C<SHELL> environment variable when printing out
1054 commands to add to the shell configuration file.
1056 On Win32 systems, C<COMSPEC> is also examined.
1064 =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html>
1072 Join #local-lib on irc.perl.org.
1076 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1078 auto_install fixes kindly sponsored by http://www.takkle.com/
1082 Patches to correctly output commands for csh style shells, as well as some
1083 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1085 Doc patches for a custom local::lib directory, more cleanups in the english
1086 documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
1087 <torsten@raudssus.de>.
1089 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1090 things will install properly, submitted a fix for the bug causing problems with
1091 writing Makefiles during bootstrapping, contributed an example program, and
1092 submitted yet another fix to ensure that local::lib can install and bootstrap
1093 properly. Many, many thanks!
1095 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1096 section. Many thanks!
1098 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1100 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1101 by a patch from Marco Emilio Poleggi.
1103 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1104 '--self-contained' option.
1106 Documentation patches to make win32 usage clearer by
1107 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1109 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
1110 G. de Oliveira <garu@cpan.org>.
1112 Improvements to stacking multiple local::lib dirs and removing them from the
1113 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1115 Patch for Carp version mismatch contributed by Hakim Cassimally <osfameron@cpan.org>.
1119 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1124 This is free software; you can redistribute it and/or modify it under
1125 the same terms as the Perl 5 programming language system itself.