12 our $VERSION = '1.008026'; # 1.8.26
13 $VERSION = eval $VERSION;
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
32 # the fancy dash is U+2212 or \xE2\x88\x92
33 if ($arg =~ /\xE2\x88\x92/ or $arg =~ /−/) {
35 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
36 These are *not* the traditional -- dashes that software recognizes. You
37 probably got these by copy-pasting from the perldoc for this module as
38 rendered by a UTF8-capable formatter. This most typically happens on an OS X
39 terminal, but can happen elsewhere too. Please try again after replacing the
40 dashes with normal minus signs.
43 elsif(grep { $arg eq $_ } @KNOWN_FLAGS) {
44 (my $flag = $arg) =~ s/--//;
45 $arg_store{$flag} = 1;
47 elsif($arg =~ /^--/) {
48 die "Unknown import argument: $arg";
51 # assume that what's left is a path
52 $arg_store{path} = $arg;
56 if($arg_store{'self-contained'}) {
57 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";
61 if ($arg_store{deactivate}) {
62 $deactivating = DEACTIVATE_ONE;
64 if ($arg_store{'deactivate-all'}) {
65 $deactivating = DEACTIVATE_ALL;
68 $arg_store{path} = $class->resolve_path($arg_store{path});
69 $class->setup_local_lib_for($arg_store{path}, $deactivating);
71 for (@INC) { # Untaint @INC
72 next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc.
81 my $last = pop(@methods);
84 my ($obj, @args) = @_;
85 $obj->${pipeline @methods}(
102 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
103 my $foo = bless({}, 'Foo');
104 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
112 grep { ! $seen{$_}++ } @_;
116 my ($class, $path) = @_;
117 $class->${pipeline qw(
118 resolve_relative_path
124 sub resolve_empty_path {
125 my ($class, $path) = @_;
135 #:: test classmethod setup
137 my $c = 'local::lib';
145 is($c->resolve_empty_path, '~/perl5');
146 is($c->resolve_empty_path('foo'), 'foo');
152 sub resolve_home_path {
153 my ($class, $path) = @_;
154 return $path unless ($path =~ /^~/);
155 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
156 my $tried_file_homedir;
158 if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) {
159 $tried_file_homedir = 1;
161 File::HomeDir->users_home($user);
163 File::HomeDir->my_home;
169 if (defined $ENV{HOME}) {
177 unless (defined $homedir) {
180 "Couldn't resolve homedir for "
181 .(defined $user ? $user : 'current user')
182 .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
185 $path =~ s/^~[^\/]*/$homedir/;
189 sub resolve_relative_path {
190 my ($class, $path) = @_;
191 $path = File::Spec->rel2abs($path);
198 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
199 is($c->resolve_relative_path('bar'),'FOObar');
205 sub setup_local_lib_for {
206 my ($class, $path, $deactivating) = @_;
208 my $interpolate = LITERAL_ENV;
209 my @active_lls = $class->active_paths;
211 $class->ensure_dir_structure_for($path);
213 # On Win32 directories often contain spaces. But some parts of the CPAN
214 # toolchain don't like that. To avoid this, GetShortPathName() gives us
215 # an alternate representation that has none.
216 # This only works if the directory already exists.
217 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
219 if (! $deactivating) {
220 if (@active_lls && $active_lls[0] eq $path) {
222 return; # Asked to add what's already at the top of the stack
223 } elsif (grep { $_ eq $path} @active_lls) {
224 # Asked to add a dir that's lower in the stack -- so we remove it from
225 # where it is, and then add it back at the top.
226 $class->setup_env_hash_for($path, DEACTIVATE_ONE);
227 # Which means we can no longer output "PERL5LIB=...:$PERL5LIB" stuff
228 # anymore because we're taking something *out*.
229 $interpolate = INTERPOLATE_ENV;
234 $class->print_environment_vars_for($path, $deactivating, $interpolate);
237 $class->setup_env_hash_for($path, $deactivating);
238 my $arch_dir = $Config{archname};
241 # Inject $path/$archname for each path in PERL5LIB
242 map { ( File::Spec->catdir($_, $arch_dir), $_ ) }
243 split($Config{path_sep}, $ENV{PERL5LIB})
250 sub install_base_bin_path {
251 my ($class, $path) = @_;
252 File::Spec->catdir($path, 'bin');
255 sub install_base_perl_path {
256 my ($class, $path) = @_;
257 File::Spec->catdir($path, 'lib', 'perl5');
260 sub install_base_arch_path {
261 my ($class, $path) = @_;
262 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
265 sub ensure_dir_structure_for {
266 my ($class, $path) = @_;
268 warn "Attempting to create directory ${path}\n";
270 File::Path::mkpath($path);
274 sub guess_shelltype {
276 if(defined $ENV{'SHELL'}) {
277 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
278 $shellbin = $shell_bin_path_parts[-1];
281 local $_ = $shellbin;
289 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
290 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
291 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
292 $shellbin = $shell_bin_path_parts[-1];
294 local $_ = $shellbin;
297 } elsif(/cmd\.exe/) {
299 } elsif(/4nt\.exe/) {
309 sub print_environment_vars_for {
310 my ($class, $path, $deactivating, $interpolate) = @_;
311 print $class->environment_vars_string_for($path, $deactivating, $interpolate);
314 sub environment_vars_string_for {
315 my ($class, $path, $deactivating, $interpolate) = @_;
316 my @envs = $class->build_environment_vars_for($path, $deactivating, $interpolate);
319 # rather basic csh detection, goes on the assumption that something won't
320 # call itself csh unless it really is. also, default to bourne in the
321 # pathological situation where a user doesn't have $ENV{SHELL} defined.
322 # note also that shells with funny names, like zoid, are assumed to be
325 my $shelltype = $class->guess_shelltype;
328 my ($name, $value) = (shift(@envs), shift(@envs));
329 $value =~ s/(\\")/\\$1/g if defined $value;
330 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
335 # simple routines that take two arguments: an %ENV key and a value. return
336 # strings that are suitable for passing directly to the relevant shell to set
337 # said key to said value.
338 sub build_bourne_env_declaration {
340 my($name, $value) = @_;
341 return defined($value) ? qq{export ${name}="${value}";\n} : qq{unset ${name};\n};
344 sub build_csh_env_declaration {
346 my($name, $value) = @_;
347 return defined($value) ? qq{setenv ${name} "${value}";\n} : qq{unsetenv ${name};\n};
350 sub build_win32_env_declaration {
352 my($name, $value) = @_;
353 return defined($value) ? qq{set ${name}=${value}\n} : qq{set ${name}=\n};
356 sub setup_env_hash_for {
357 my ($class, $path, $deactivating) = @_;
358 my %envs = $class->build_environment_vars_for($path, $deactivating, INTERPOLATE_ENV);
359 @ENV{keys %envs} = values %envs;
362 sub build_environment_vars_for {
363 my ($class, $path, $deactivating, $interpolate) = @_;
365 if ($deactivating == DEACTIVATE_ONE) {
366 return $class->build_deactivate_environment_vars_for($path, $interpolate);
367 } elsif ($deactivating == DEACTIVATE_ALL) {
368 return $class->build_deact_all_environment_vars_for($path, $interpolate);
370 return $class->build_activate_environment_vars_for($path, $interpolate);
374 # Build an environment value for a variable like PATH from a list of paths.
375 # References to existing variables are given as references to the variable name.
376 # Duplicates are removed.
379 # - interpolate: INTERPOLATE_ENV/LITERAL_ENV
380 # - exists: paths are included only if they exist (default: interpolate == INTERPOLATE_ENV)
381 # - filter: function to apply to each path do decide if it must be included
382 # - empty: the value to return in the case of empty value
383 my %ENV_LIST_VALUE_DEFAULTS = (
384 interpolate => INTERPOLATE_ENV,
389 sub _env_list_value {
391 die(sprintf "unknown option '$_' at %s line %u\n", (caller)[1..2])
392 for grep { !exists $ENV_LIST_VALUE_DEFAULTS{$_} } keys %$options;
393 my %options = (%ENV_LIST_VALUE_DEFAULTS, %{ $options });
394 $options{exists} = $options{interpolate} == INTERPOLATE_ENV
395 unless defined $options{exists};
399 my $value = join($Config{path_sep}, map {
400 ref $_ ? ($^O eq 'MSWin32' ? "%${$_}%" : "\$${$_}") : $_
402 ref $_ || (defined $_
405 && $options{filter}->($_)
406 && (!$options{exists} || -e $_))
408 if (ref $_ eq 'SCALAR' && $options{interpolate} == INTERPOLATE_ENV) {
409 defined $ENV{${$_}} ? (split /\Q$Config{path_sep}/, $ENV{${$_}}) : ()
414 return length($value) ? $value : $options{empty};
417 sub build_activate_environment_vars_for {
418 my ($class, $path, $interpolate) = @_;
420 PERL_LOCAL_LIB_ROOT =>
422 { interpolate => $interpolate, exists => 0, empty => '' },
424 \'PERL_LOCAL_LIB_ROOT',
426 PERL_MB_OPT => "--install_base " . _mb_escape_path($path),
427 PERL_MM_OPT => "INSTALL_BASE=" . _mm_escape_path($path),
430 { interpolate => $interpolate, exists => 0, empty => '' },
431 $class->install_base_perl_path($path),
434 PATH => _env_list_value(
435 { interpolate => $interpolate, exists => 0, empty => '' },
436 $class->install_base_bin_path($path),
442 sub _mm_escape_path {
444 $path =~ s/\\/\\\\\\\\/g;
445 if ($path =~ s/ /\\ /g) {
446 $path = qq{"\\"$path\\""};
451 sub _mb_escape_path {
453 $path =~ s/\\/\\\\/g;
460 return () unless defined $ENV{PERL_LOCAL_LIB_ROOT};
463 # screen out entries that aren't actually reflected in @INC
464 my $active_ll = $class->install_base_perl_path($_);
465 grep { $_ eq $active_ll } @INC
468 split /\Q$Config{path_sep}\E/, $ENV{PERL_LOCAL_LIB_ROOT};
471 sub build_deactivate_environment_vars_for {
472 my ($class, $path, $interpolate) = @_;
474 my @active_lls = $class->active_paths;
476 if (!grep { $_ eq $path } @active_lls) {
477 warn "Tried to deactivate inactive local::lib '$path'\n";
481 my $perl_path = $class->install_base_perl_path($path);
482 my $arch_path = $class->install_base_arch_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(
497 $_ ne $perl_path && $_ ne $arch_path
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 $env{PERL_MB_OPT} = defined($new_top) ? "--install_base "._mb_escape_path($new_top) : undef;
516 $env{PERL_MM_OPT} = defined($new_top) ? "INSTALL_BASE="._mm_escape_path($new_top) : undef;
522 sub build_deact_all_environment_vars_for {
523 my ($class, $path, $interpolate) = @_;
525 my @active_lls = $class->active_paths;
527 my %perl_paths = map { (
528 $class->install_base_perl_path($_) => 1,
529 $class->install_base_arch_path($_) => 1
531 my %bin_paths = map { (
532 $class->install_base_bin_path($_) => 1,
536 PERL_LOCAL_LIB_ROOT => undef,
537 PERL_MM_OPT => undef,
538 PERL_MB_OPT => undef,
539 PERL5LIB => _env_list_value(
543 ! scalar grep { exists $perl_paths{$_} } $_[0]
548 PATH => _env_list_value(
552 ! scalar grep { exists $bin_paths{$_} } $_[0]
566 File::Path::rmtree('t/var/splat');
568 $c->ensure_dir_structure_for('t/var/splat');
570 ok(-d 't/var/splat');
578 local::lib - create and use a local lib/ for perl modules with PERL5LIB
584 use local::lib; # sets up a local lib at ~/perl5
586 use local::lib '~/foo'; # same, but ~/foo
590 use local::lib "$FindBin::Bin/../support"; # app-local support library
594 # Install LWP and its missing dependencies to the '~/perl5' directory
595 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
597 # Just print out useful shell commands
599 export PERL_MB_OPT='--install_base /home/username/perl5'
600 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
601 export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5'
602 export PATH="/home/username/perl5/bin:$PATH"
604 =head2 The bootstrapping technique
606 A typical way to install local::lib is using what is known as the
607 "bootstrapping" technique. You would do this if your system administrator
608 hasn't already installed local::lib. In this case, you'll need to install
609 local::lib in your home directory.
611 Even if you do have administrative privileges, you will still want to set up your
612 environment variables, as discussed in step 4. Without this, you would still
613 install the modules into the system CPAN installation and also your Perl scripts
614 will not use the lib/ path you bootstrapped with local::lib.
616 By default local::lib installs itself and the CPAN modules into ~/perl5.
618 Windows users must also see L</Differences when using this module under Win32>.
620 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
621 on the CPAN page about local::lib). Do this as an ordinary user, not as root
622 or administrator. Unpack the file in your home directory or in any other
627 perl Makefile.PL --bootstrap
629 If the system asks you whether it should automatically configure as much
630 as possible, you would typically answer yes.
632 In order to install local::lib into a directory other than the default, you need
633 to specify the name of the directory when you call bootstrap, as follows:
635 perl Makefile.PL --bootstrap=~/foo
637 3. Run this: (local::lib assumes you have make installed on your system)
639 make test && make install
641 4. Now we need to setup the appropriate environment variables, so that Perl
642 starts using our newly generated lib/ directory. If you are using bash or
643 any other Bourne shells, you can add this to your shell startup script this
646 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
648 If you are using C shell, you can do this as follows:
653 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
655 If you passed to bootstrap a directory other than default, you also need to give that as
656 import parameter to the call of the local::lib module like this way:
658 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
660 After writing your shell configuration file, be sure to re-read it to get the
661 changed settings into your current shell's environment. Bourne shells use
662 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
664 If you're on a slower machine, or are operating under draconian disk space
665 limitations, you can disable the automatic generation of manpages from POD when
666 installing modules by using the C<--no-manpages> argument when bootstrapping:
668 perl Makefile.PL --bootstrap --no-manpages
670 To avoid doing several bootstrap for several Perl module environments on the
671 same account, for example if you use it for several different deployed
672 applications independently, you can use one bootstrapped local::lib
673 installation to install modules in different directories directly this way:
677 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
678 printenv ### You will see that ~/mydir1 is in the PERL5LIB
679 perl -MCPAN -e install ... ### whatever modules you want
683 If you are working with several C<local::lib> environments, you may want to
684 remove some of them from the current environment without disturbing the others.
685 You can deactivate one environment like this (using bourne sh):
687 eval $(perl -Mlocal::lib=--deactivate,~/path)
689 which will generate and run the commands needed to remove C<~/path> from your
690 various search paths. Whichever environment was B<activated most recently> will
691 remain the target for module installations. That is, if you activate
692 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
693 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
694 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
695 installed in C<~/pathB> because pathB was activated later.
697 You can also ask C<local::lib> to clean itself completely out of the current
698 shell's environment with the C<--deactivate-all> option.
699 For multiple environments for multiple apps you may need to include a modified
700 version of the C<< use FindBin >> instructions in the "In code" sample above.
701 If you did something like the above, you have a set of Perl modules at C<<
702 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
703 you need to tell it where to find the modules you installed for it at C<<
706 In C<< ~/mydir1/scripts/myscript.pl >>:
710 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
711 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
713 Put this before any BEGIN { ... } blocks that require the modules you installed.
715 =head2 Differences when using this module under Win32
717 To set up the proper environment variables for your current session of
718 C<CMD.exe>, you can use this:
720 C:\>perl -Mlocal::lib
721 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
722 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
723 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
724 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
726 ### To set the environment for this shell alone
727 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
728 ### instead of $(perl -Mlocal::lib=./)
730 If you want the environment entries to persist, you'll need to add then to the
731 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
733 The "~" is translated to the user's profile directory (the directory named for
734 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
735 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
736 directory is translated to a short name (which means the directory must exist)
737 and the subdirectories are created.
741 The version of a Perl package on your machine is not always the version you
742 need. Obviously, the best thing to do would be to update to the version you
743 need. However, you might be in a situation where you're prevented from doing
744 this. Perhaps you don't have system administrator privileges; or perhaps you
745 are using a package management system such as Debian, and nobody has yet gotten
746 around to packaging up the version you need.
748 local::lib solves this problem by allowing you to create your own directory of
749 Perl packages downloaded from CPAN (in a multi-user system, this would typically
750 be within your own home directory). The existing system Perl installation is
751 not affected; you simply invoke Perl with special options so that Perl uses the
752 packages in your own local package directory rather than the system packages.
753 local::lib arranges things so that your locally installed version of the Perl
754 packages takes precedence over the system installation.
756 If you are using a package management system (such as Debian), you don't need to
757 worry about Debian and CPAN stepping on each other's toes. Your local version
758 of the packages will be written to an entirely separate directory from those
763 This module provides a quick, convenient way of bootstrapping a user-local Perl
764 module library located within the user's home directory. It also constructs and
765 prints out for the user the list of environment variables using the syntax
766 appropriate for the user's current shell (as specified by the C<SHELL>
767 environment variable), suitable for directly adding to one's shell
770 More generally, local::lib allows for the bootstrapping and usage of a
771 directory containing Perl modules outside of Perl's C<@INC>. This makes it
772 easier to ship an application with an app-specific copy of a Perl module, or
773 collection of modules. Useful in cases like when an upstream maintainer hasn't
774 applied a patch to a module of theirs that you need for your application.
776 On import, local::lib sets the following environment variables to appropriate
789 PATH is appended to, rather than clobbered.
793 These values are then available for reference by any code after import.
795 =head1 CREATING A SELF-CONTAINED SET OF MODULES
797 See L<lib::core::only> for one way to do this - but note that
798 there are a number of caveats, and the best approach is always to perform a
799 build against a clean perl (i.e. site and vendor as close to empty as possible).
803 Options are values that can be passed to the C<local::lib> import besides the
804 directory to use. They are specified as C<use local::lib '--option'[, path];>
805 or C<perl -Mlocal::lib=--option[,path]>.
809 Remove the chosen path (or the default path) from the module search paths if it
810 was added by C<local::lib>, instead of adding it.
812 =head2 --deactivate-all
814 Remove all directories that were added to search paths by C<local::lib> from the
819 =head2 ensure_dir_structure_for
823 =item Arguments: $path
825 =item Return value: None
829 Attempts to create the given path, and all required parent directories. Throws
830 an exception on failure.
832 =head2 print_environment_vars_for
836 =item Arguments: $path
838 =item Return value: None
842 Prints to standard output the variables listed above, properly set to use the
843 given path as the base directory.
845 =head2 build_environment_vars_for
849 =item Arguments: $path, $interpolate
851 =item Return value: \%environment_vars
855 Returns a hash with the variables listed above, properly set to use the
856 given path as the base directory.
858 =head2 setup_env_hash_for
862 =item Arguments: $path
864 =item Return value: None
868 Constructs the C<%ENV> keys for the given path, by calling
869 L</build_environment_vars_for>.
875 =item Arguments: None
877 =item Return value: @paths
881 Returns a list of active C<local::lib> paths, according to the
882 C<PERL_LOCAL_LIB_ROOT> environment variable and verified against
883 what is really in C<@INC>.
885 =head2 install_base_perl_path
889 =item Arguments: $path
891 =item Return value: $install_base_perl_path
895 Returns a path describing where to install the Perl modules for this local
896 library installation. Appends the directories C<lib> and C<perl5> to the given
899 =head2 install_base_arch_path
903 =item Arguments: $path
905 =item Return value: $install_base_arch_path
909 Returns a path describing where to install the architecture-specific Perl
910 modules for this local library installation. Based on the
911 L</install_base_perl_path> method's return value, and appends the value of
912 C<$Config{archname}>.
914 =head2 install_base_bin_path
918 =item Arguments: $path
920 =item Return value: $install_base_bin_path
924 Returns a path describing where to install the executable programs for this
925 local library installation. Based on the L</install_base_perl_path> method's
926 return value, and appends the directory C<bin>.
928 =head2 resolve_empty_path
932 =item Arguments: $path
934 =item Return value: $base_path
938 Builds and returns the base path into which to set up the local module
939 installation. Defaults to C<~/perl5>.
941 =head2 resolve_home_path
945 =item Arguments: $path
947 =item Return value: $home_path
951 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
952 for this purpose. If no definite answer is available, throws an exception.
954 =head2 resolve_relative_path
958 =item Arguments: $path
960 =item Return value: $absolute_path
964 Translates the given path into an absolute path.
970 =item Arguments: $path
972 =item Return value: $absolute_path
976 Calls the following in a pipeline, passing the result from the previous to the
977 next, in an attempt to find where to configure the environment for a local
978 library installation: L</resolve_empty_path>, L</resolve_home_path>,
979 L</resolve_relative_path>. Passes the given path argument to
980 L</resolve_empty_path> which then returns a result that is passed to
981 L</resolve_home_path>, which then has its result passed to
982 L</resolve_relative_path>. The result of this final call is returned from
985 =head1 A WARNING ABOUT UNINST=1
987 Be careful about using local::lib in combination with "make install UNINST=1".
988 The idea of this feature is that will uninstall an old version of a module
989 before installing a new one. However it lacks a safety check that the old
990 version and the new version will go in the same directory. Used in combination
991 with local::lib, you can potentially delete a globally accessible version of a
992 module while installing the new version in a local place. Only combine "make
993 install UNINST=1" and local::lib if you understand these possible consequences.
999 =item * The perl toolchain is unable to handle directory names with spaces in it,
1000 so you can't put your local::lib bootstrap into a directory with spaces. What
1001 you can do is moving your local::lib to a directory with spaces B<after> you
1002 installed all modules inside your local::lib bootstrap. But be aware that you
1003 can't update or install CPAN modules after the move.
1005 =item * Rather basic shell detection. Right now anything with csh in its name is
1006 assumed to be a C shell or something compatible, and everything else is assumed
1007 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
1008 not set, a Bourne-compatible shell is assumed.
1010 =item * Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
1011 have CPANPLUS installed.
1013 =item * Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT.
1015 =item * Should probably auto-fixup CPAN config if not already done.
1019 Patches very much welcome for any of the above.
1023 =item * On Win32 systems, does not have a way to write the created environment variables
1024 to the registry, so that they can persist through a reboot.
1028 =head1 TROUBLESHOOTING
1030 If you've configured local::lib to install CPAN modules somewhere in to your
1031 home directory, and at some point later you try to install a module with C<cpan
1032 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1033 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1034 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1035 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1036 you've somehow lost your updated ExtUtils::MakeMaker module.
1038 To remedy this situation, rerun the bootstrapping procedure documented above.
1040 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1042 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1052 local::lib looks at the user's C<SHELL> environment variable when printing out
1053 commands to add to the shell configuration file.
1055 On Win32 systems, C<COMSPEC> is also examined.
1063 =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html>
1071 Join #local-lib on irc.perl.org.
1075 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1077 auto_install fixes kindly sponsored by http://www.takkle.com/
1081 Patches to correctly output commands for csh style shells, as well as some
1082 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1084 Doc patches for a custom local::lib directory, more cleanups in the english
1085 documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
1086 <torsten@raudssus.de>.
1088 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1089 things will install properly, submitted a fix for the bug causing problems with
1090 writing Makefiles during bootstrapping, contributed an example program, and
1091 submitted yet another fix to ensure that local::lib can install and bootstrap
1092 properly. Many, many thanks!
1094 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1095 section. Many thanks!
1097 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1099 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1100 by a patch from Marco Emilio Poleggi.
1102 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1103 '--self-contained' option.
1105 Documentation patches to make win32 usage clearer by
1106 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1108 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
1109 G. de Oliveira <garu@cpan.org>.
1111 Improvements to stacking multiple local::lib dirs and removing them from the
1112 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1114 Patch for Carp version mismatch contributed by Hakim Cassimally <osfameron@cpan.org>.
1118 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1123 This is free software; you can redistribute it and/or modify it under
1124 the same terms as the Perl 5 programming language system itself.