11 our $VERSION = '1.008026'; # 1.8.26
12 $VERSION = eval $VERSION;
15 my ($class, @args) = @_;
22 my $arg = shift @args;
23 # check for lethal dash first to stop processing before causing problems
24 # the fancy dash is U+2212 or \xE2\x88\x92
25 if ($arg =~ /\xE2\x88\x92/ or $arg =~ /−/) {
27 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
28 These are *not* the traditional -- dashes that software recognizes. You
29 probably got these by copy-pasting from the perldoc for this module as
30 rendered by a UTF8-capable formatter. This most typically happens on an OS X
31 terminal, but can happen elsewhere too. Please try again after replacing the
32 dashes with normal minus signs.
35 elsif ($arg eq '--self-contained') {
37 FATAL: The local::lib --self-contained flag has never worked reliably and the
38 original author, Mark Stosberg, was unable or unwilling to maintain it. As
39 such, this flag has been removed from the local::lib codebase in order to
40 prevent misunderstandings and potentially broken builds. The local::lib authors
41 recommend that you look at the lib::core::only module shipped with this
42 distribution in order to create a more robust environment that is equivalent to
43 what --self-contained provided (although quite possibly not what you originally
44 thought it provided due to the poor quality of the documentation, for which we
48 elsif( $arg =~ /^--deactivate(?:=(.*))?$/ ) {
49 my $path = defined $1 ? $1 : shift @args;
50 push @steps, ['deactivate', $path];
52 elsif ( $arg eq '--deactivate-all' ) {
53 push @steps, ['deactivate_all'];
55 elsif ( $arg =~ /^--shelltype(?:=(.*))?$/ ) {
56 $shelltype = defined $1 ? $1 : shift @args;
58 elsif ( $arg eq '--no-create' ) {
61 elsif ( $arg =~ /^--/ ) {
62 die "Unknown import argument: $arg";
65 push @steps, ['activate', $arg];
69 push @steps, ['activate', undef];
72 my $self = $class->new(%opts);
75 my ($method, @args) = @$_;
76 $self = $self->$method(@args);
80 print $self->environment_vars_string($shelltype);
84 $self->setup_local_lib;
95 bless {%$self, @_}, ref $self;
98 sub inc { $_[0]->{inc} ||= \@INC }
99 sub libs { $_[0]->{libs} ||= [ \'PERL5LIB' ] }
100 sub bins { $_[0]->{bins} ||= [ \'PATH' ] }
101 sub roots { $_[0]->{roots} ||= [ \'PERL_LOCAL_LIB_ROOT' ] }
102 sub extra { $_[0]->{extra} ||= {} }
103 sub shelltype { $_[0]->{shelltype} ||= $_[0]->guess_shelltype }
104 sub no_create { $_[0]->{no_create} }
106 my $_archname = $Config{archname};
107 my $_version = $Config{version};
108 my @_inc_version_list = reverse split / /, $Config{inc_version_list};
109 my $_path_sep = $Config{path_sep};
114 !(ref $_ && ref $_ eq 'SCALAR') ? $_ : (
115 defined $ENV{$$_} ? split(/\Q$_path_sep/, $ENV{$$_})
118 } ref $list ? @$list : $list;
121 my ($list, @remove) = @_;
124 my %remove = map { $_ => 1 } @remove;
125 grep !$remove{$_}, _as_list($list);
129 [$_version, $_archname],
132 (@_inc_version_list ? \@_inc_version_list : ()),
136 sub install_base_bin_path {
137 my ($class, $path) = @_;
138 return File::Spec->catdir($path, 'bin');
140 sub install_base_perl_path {
141 my ($class, $path) = @_;
142 return File::Spec->catdir($path, 'lib', 'perl5');
144 sub install_base_arch_path {
145 my ($class, $path) = @_;
146 File::Spec->catdir($class->install_base_perl_path($path), $_archname);
150 my ($class, $path) = @_;
151 my $base = $class->install_base_perl_path($path);
152 return map { File::Spec->catdir($base, @$_) } @_lib_subdirs;
155 sub _mm_escape_path {
157 $path =~ s/\\/\\\\\\\\/g;
158 if ($path =~ s/ /\\ /g) {
159 $path = qq{"\\"$path\\""};
164 sub _mb_escape_path {
166 $path =~ s/\\/\\\\/g;
170 sub installer_options_for {
171 my ($class, $path) = @_;
174 defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef,
176 defined $path ? "--install_base "._mb_escape_path($path) : undef,
182 $self = ref $self ? $self : $self->new;
185 # screen out entries that aren't actually reflected in @INC
186 my $active_ll = $self->install_base_perl_path($_);
187 grep { $_ eq $active_ll } @{$self->inc};
188 } _as_list($self->roots);
193 my ($self, $path) = @_;
194 $self = $self->new unless ref $self;
195 $path = $self->resolve_path($path);
196 $path = $self->normalize_path($path);
198 my @active_lls = $self->active_paths;
200 if (!grep { $_ eq $path } @active_lls) {
201 warn "Tried to deactivate inactive local::lib '$path'\n";
206 bins => [ _remove_from($self->bins,
207 $self->install_base_bin_path($path)) ],
208 libs => [ _remove_from($self->libs,
209 $self->install_base_perl_path($path)) ],
210 inc => [ _remove_from($self->inc,
211 $self->lib_paths_for($path)) ],
212 roots => [ _remove_from($self->roots, $path) ],
215 $args{extra} = $self->installer_options_for($args{roots}[0]);
222 $self = $self->new unless ref $self;
224 my @active_lls = $self->active_paths;
229 bins => [ _remove_from($self->bins,
230 map $self->install_base_bin_path($_), @active_lls) ],
231 libs => [ _remove_from($self->libs,
232 map $self->install_base_perl_path($_), @active_lls) ],
233 inc => [ _remove_from($self->inc,
234 map $self->lib_paths_for($_), @active_lls) ],
235 roots => [ _remove_from($self->roots, @active_lls) ],
239 $args{extra} = $self->installer_options_for(undef);
245 my ($self, $path) = @_;
246 $self = $self->new unless ref $self;
247 $path = $self->resolve_path($path);
248 $self->ensure_dir_structure_for($path)
249 unless $self->no_create;
251 $path = $self->normalize_path($path);
253 my @active_lls = $self->active_paths;
255 if (grep { $_ eq $path } @active_lls[1 .. $#active_lls]) {
256 $self = $self->deactivate($path);
260 if (!@active_lls || $active_lls[0] ne $path) {
262 bins => [ $self->install_base_bin_path($path), @{$self->bins} ],
263 libs => [ $self->install_base_perl_path($path), @{$self->libs} ],
264 inc => [ $self->lib_paths_for($path), @{$self->inc} ],
265 roots => [ $path, @{$self->roots} ],
269 $args{extra} = $self->installer_options_for($path);
275 my ($self, $path) = @_;
276 $path = ( Win32::GetShortPathName($path) || $path )
281 sub build_environment_vars_for {
282 my $self = $_[0]->new->activate($_[1]);
283 $self->build_environment_vars;
285 sub build_environment_vars {
288 PATH => join($_path_sep, _as_list($self->bins)),
289 PERL5LIB => join($_path_sep, _as_list($self->libs)),
290 PERL_LOCAL_LIB_ROOT => join($_path_sep, _as_list($self->roots)),
295 sub setup_local_lib_for {
296 my $self = $_[0]->new->activate($_[1]);
297 $self->setup_local_lib;
300 sub setup_local_lib {
302 $self->setup_env_hash;
303 @INC = @{$self->inc};
306 sub setup_env_hash_for {
307 my $self = $_[0]->new->activate($_[1]);
308 $self->setup_env_hash;
312 my %env = $self->build_environment_vars;
313 for my $key (keys %env) {
314 if (defined $env{$key}) {
315 $ENV{$key} = $env{$key};
323 sub print_environment_vars_for {
324 my $self = $_[0]->new->activate($_[1]);
325 $self->print_environment_vars;
327 sub print_environment_vars {
329 print $self->environment_vars_string;
332 sub environment_vars_string_for {
333 my $self = $_[0]->new->activate($_[1]);
334 $self->environment_vars_string;
336 sub environment_vars_string {
337 my ($self, $shelltype) = @_;
339 $shelltype ||= $self->guess_shelltype;
341 my $build_method = "build_${shelltype}_env_declaration";
345 PERL5LIB => $self->libs,
346 PERL_LOCAL_LIB_ROOT => $self->roots,
351 my ($name, $value) = (shift(@envs), shift(@envs));
356 && ref $value->[0] eq 'SCALAR'
357 && ${$value->[0]} eq $name) {
363 ? (defined $ENV{$name} && $value eq $ENV{$name})
364 : !defined $ENV{$name}
368 $out .= $self->$build_method($name, $value);
370 my $wrap_method = 'wrap_' . $self->shelltype . '_output';
371 if ($self->can($wrap_method)) {
372 return $self->$wrap_method($out);
377 sub build_bourne_env_declaration {
378 my ($class, $name, $args) = @_;
379 my $value = $class->_interpolate($args, '$%s', '"', '\\%s');
381 if (!defined $value) {
382 return qq{unset $name;\n};
385 $value =~ s/(^|\G|$_path_sep)\$$name$_path_sep/$1\$$name\${$name+$_path_sep}/g;
386 $value =~ s/$_path_sep\$$name$/\${$name+$_path_sep}\$$name/;
388 qq{export ${name}="$value";\n}
391 sub build_csh_env_declaration {
392 my ($class, $name, $args) = @_;
393 my ($value, @vars) = $class->_interpolate($args, '$%s', '"', '"\\%s"');
394 if (!defined $value) {
395 return qq{unsetenv $name;\n};
399 for my $var (@vars) {
400 $out .= qq{if ! \$?$name setenv $name '';\n};
403 my $value_without = $value;
404 if ($value_without =~ s/(?:^|$_path_sep)\$$name(?:$_path_sep|$)//g) {
405 $out .= qq{if "\$$name" != '' setenv $name "$value";\n};
406 $out .= qq{if "\$$name" == '' };
408 $out .= qq{setenv $name "$value_without";\n};
412 sub build_cmd_env_declaration {
413 my ($class, $name, $args) = @_;
414 my $value = $class->_interpolate($args, '%%%s%%', qr([()!^"<>&|]), '^%s');
416 return qq{\@set $name=\n};
420 my $value_without = $value;
421 if ($value_without =~ s/(?:^|$_path_sep)%$name%(?:$_path_sep|$)//g) {
422 $out .= qq{\@if not "%$name%"=="" set $name=$value\n};
423 $out .= qq{\@if "%$name%"=="" };
425 $out .= qq{\@set $name=$value_without\n};
429 sub build_powershell_env_declaration {
430 my ($class, $name, $args) = @_;
431 my $value = $class->_interpolate($args, '$env:%s', '"', '`%s');
434 return qq{Remove-Item Env:\\$name;\n};
437 my $maybe_path_sep = qq{\$(if("\$env:$name"-eq""){""}else{"$_path_sep"})};
438 $value =~ s/(^|\G|$_path_sep)\$env:$name$_path_sep/$1\$env:$name"+$maybe_path_sep+"/g;
439 $value =~ s/$_path_sep\$env:$name$/"+$maybe_path_sep+\$env:$name+"/;
441 qq{\$env:$name = \$("$value");\n};
443 sub wrap_powershell_output {
444 my ($class, $out) = @_;
445 return $out || " \n";
449 my ($class, $args, $var_pat, $escape, $escape_pat) = @_;
451 unless defined $args;
452 my @args = ref $args ? @$args : $args;
455 my @vars = map { $$_ } grep { ref $_ eq 'SCALAR' } @args;
456 my $string = join $_path_sep, map {
457 ref $_ eq 'SCALAR' ? sprintf($var_pat, $$_) : do {
458 s/($escape)/sprintf($escape_pat, $1)/ge; $_;
461 return wantarray ? ($string, \@vars) : $string;
468 my $last = pop(@methods);
471 my ($obj, @args) = @_;
472 $obj->${pipeline @methods}(
489 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
490 my $foo = bless({}, 'Foo');
491 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
498 my ($class, $path) = @_;
500 $path = $class->${pipeline qw(
501 resolve_relative_path
509 sub resolve_empty_path {
510 my ($class, $path) = @_;
520 #:: test classmethod setup
522 my $c = 'local::lib';
530 is($c->resolve_empty_path, '~/perl5');
531 is($c->resolve_empty_path('foo'), 'foo');
537 sub resolve_home_path {
538 my ($class, $path) = @_;
539 return $path unless ($path =~ /^~/);
540 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
542 if (!defined $user && defined $ENV{HOME}) {
547 File::Glob::bsd_glob("~$user", File::Glob::GLOB_TILDE());
550 unless (defined $homedir) {
553 "Couldn't resolve homedir for "
554 .(defined $user ? $user : 'current user')
557 $path =~ s/^~[^\/]*/$homedir/;
561 sub resolve_relative_path {
562 my ($class, $path) = @_;
563 $path = File::Spec->rel2abs($path);
570 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
571 is($c->resolve_relative_path('bar'),'FOObar');
577 sub ensure_dir_structure_for {
578 my ($class, $path) = @_;
580 warn "Attempting to create directory ${path}\n";
582 require File::Basename;
586 $path = File::Basename::dirname($path);
588 mkdir $_ for reverse @dirs;
596 File::Path::rmtree('t/var/splat');
598 $c->ensure_dir_structure_for('t/var/splat');
600 ok(-d 't/var/splat');
606 sub guess_shelltype {
608 = defined $ENV{SHELL}
609 ? (File::Spec->splitpath($ENV{SHELL}))[-1]
610 : ( $^O eq 'MSWin32' && exists $ENV{'!EXITCODE'} )
612 : ( $^O eq 'MSWin32' && $ENV{PROMPT} && $ENV{COMSPEC} )
613 ? (File::Spec->splitpath($ENV{COMSPEC}))[-1]
614 : ( $^O eq 'MSWin32' && !$ENV{PROMPT} )
621 : /command\.com/i ? 'cmd'
622 : /cmd\.exe/i ? 'cmd'
623 : /4nt\.exe/i ? 'cmd'
624 : /powershell\.exe/i ? 'powershell'
636 local::lib - create and use a local lib/ for perl modules with PERL5LIB
642 use local::lib; # sets up a local lib at ~/perl5
644 use local::lib '~/foo'; # same, but ~/foo
648 use local::lib "$FindBin::Bin/../support"; # app-local support library
652 # Install LWP and its missing dependencies to the '~/perl5' directory
653 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
655 # Just print out useful shell commands
657 export PERL_MB_OPT='--install_base /home/username/perl5'
658 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
659 export PERL5LIB="/home/username/perl5/lib/perl5"
660 export PATH="/home/username/perl5/bin:$PATH"
662 =head2 The bootstrapping technique
664 A typical way to install local::lib is using what is known as the
665 "bootstrapping" technique. You would do this if your system administrator
666 hasn't already installed local::lib. In this case, you'll need to install
667 local::lib in your home directory.
669 Even if you do have administrative privileges, you will still want to set up your
670 environment variables, as discussed in step 4. Without this, you would still
671 install the modules into the system CPAN installation and also your Perl scripts
672 will not use the lib/ path you bootstrapped with local::lib.
674 By default local::lib installs itself and the CPAN modules into ~/perl5.
676 Windows users must also see L</Differences when using this module under Win32>.
678 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
679 on the CPAN page about local::lib). Do this as an ordinary user, not as root
680 or administrator. Unpack the file in your home directory or in any other
685 perl Makefile.PL --bootstrap
687 If the system asks you whether it should automatically configure as much
688 as possible, you would typically answer yes.
690 In order to install local::lib into a directory other than the default, you need
691 to specify the name of the directory when you call bootstrap, as follows:
693 perl Makefile.PL --bootstrap=~/foo
695 3. Run this: (local::lib assumes you have make installed on your system)
697 make test && make install
699 4. Now we need to setup the appropriate environment variables, so that Perl
700 starts using our newly generated lib/ directory. If you are using bash or
701 any other Bourne shells, you can add this to your shell startup script this
704 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
706 If you are using C shell, you can do this as follows:
711 echo 'eval `perl -I$HOME/perl5/lib/perl5 -Mlocal::lib`' >> ~/.cshrc
713 If you passed to bootstrap a directory other than default, you also need to
714 give that as import parameter to the call of the local::lib module like this
717 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
719 After writing your shell configuration file, be sure to re-read it to get the
720 changed settings into your current shell's environment. Bourne shells use
721 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
723 If you're on a slower machine, or are operating under draconian disk space
724 limitations, you can disable the automatic generation of manpages from POD when
725 installing modules by using the C<--no-manpages> argument when bootstrapping:
727 perl Makefile.PL --bootstrap --no-manpages
729 To avoid doing several bootstrap for several Perl module environments on the
730 same account, for example if you use it for several different deployed
731 applications independently, you can use one bootstrapped local::lib
732 installation to install modules in different directories directly this way:
736 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
737 printenv ### You will see that ~/mydir1 is in the PERL5LIB
738 perl -MCPAN -e install ... ### whatever modules you want
742 If you are working with several C<local::lib> environments, you may want to
743 remove some of them from the current environment without disturbing the others.
744 You can deactivate one environment like this (using bourne sh):
746 eval $(perl -Mlocal::lib=--deactivate,~/path)
748 which will generate and run the commands needed to remove C<~/path> from your
749 various search paths. Whichever environment was B<activated most recently> will
750 remain the target for module installations. That is, if you activate
751 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
752 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
753 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
754 installed in C<~/pathB> because pathB was activated later.
756 You can also ask C<local::lib> to clean itself completely out of the current
757 shell's environment with the C<--deactivate-all> option.
758 For multiple environments for multiple apps you may need to include a modified
759 version of the C<< use FindBin >> instructions in the "In code" sample above.
760 If you did something like the above, you have a set of Perl modules at C<<
761 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
762 you need to tell it where to find the modules you installed for it at C<<
765 In C<< ~/mydir1/scripts/myscript.pl >>:
769 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
770 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
772 Put this before any BEGIN { ... } blocks that require the modules you installed.
774 =head2 Differences when using this module under Win32
776 To set up the proper environment variables for your current session of
777 C<CMD.exe>, you can use this:
779 C:\>perl -Mlocal::lib
780 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
781 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
782 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5
783 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
785 ### To set the environment for this shell alone
786 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
787 ### instead of $(perl -Mlocal::lib=./)
789 If you want the environment entries to persist, you'll need to add them to the
790 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
792 The "~" is translated to the user's profile directory (the directory named for
793 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
794 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
795 directory is translated to a short name (which means the directory must exist)
796 and the subdirectories are created.
800 local::lib also supports PowerShell, and an be used with the
801 C<Invoke-Expression> cmdlet.
803 Invoke-Expression "$(perl -Mlocal::lib)"
807 The version of a Perl package on your machine is not always the version you
808 need. Obviously, the best thing to do would be to update to the version you
809 need. However, you might be in a situation where you're prevented from doing
810 this. Perhaps you don't have system administrator privileges; or perhaps you
811 are using a package management system such as Debian, and nobody has yet gotten
812 around to packaging up the version you need.
814 local::lib solves this problem by allowing you to create your own directory of
815 Perl packages downloaded from CPAN (in a multi-user system, this would typically
816 be within your own home directory). The existing system Perl installation is
817 not affected; you simply invoke Perl with special options so that Perl uses the
818 packages in your own local package directory rather than the system packages.
819 local::lib arranges things so that your locally installed version of the Perl
820 packages takes precedence over the system installation.
822 If you are using a package management system (such as Debian), you don't need to
823 worry about Debian and CPAN stepping on each other's toes. Your local version
824 of the packages will be written to an entirely separate directory from those
829 This module provides a quick, convenient way of bootstrapping a user-local Perl
830 module library located within the user's home directory. It also constructs and
831 prints out for the user the list of environment variables using the syntax
832 appropriate for the user's current shell (as specified by the C<SHELL>
833 environment variable), suitable for directly adding to one's shell
836 More generally, local::lib allows for the bootstrapping and usage of a
837 directory containing Perl modules outside of Perl's C<@INC>. This makes it
838 easier to ship an application with an app-specific copy of a Perl module, or
839 collection of modules. Useful in cases like when an upstream maintainer hasn't
840 applied a patch to a module of theirs that you need for your application.
842 On import, local::lib sets the following environment variables to appropriate
857 When possible, these will be appended to instead of overwritten entirely.
859 These values are then available for reference by any code after import.
861 =head1 CREATING A SELF-CONTAINED SET OF MODULES
863 See L<lib::core::only> for one way to do this - but note that
864 there are a number of caveats, and the best approach is always to perform a
865 build against a clean perl (i.e. site and vendor as close to empty as possible).
869 Options are values that can be passed to the C<local::lib> import besides the
870 directory to use. They are specified as C<use local::lib '--option'[, path];>
871 or C<perl -Mlocal::lib=--option[,path]>.
875 Remove the chosen path (or the default path) from the module search paths if it
876 was added by C<local::lib>, instead of adding it.
878 =head2 --deactivate-all
880 Remove all directories that were added to search paths by C<local::lib> from the
885 Specify the shell type to use for output. By default, the shell will be
886 detected based on the environment. Should be one of: C<bourne>, C<csh>,
887 C<cmd>, or C<powershell>.
891 Prevents C<local::lib> from creating directories when activating dirs. This is
892 likely to cause issues on Win32 systems.
896 =head2 ensure_dir_structure_for
900 =item Arguments: $path
902 =item Return value: None
906 Attempts to create the given path, and all required parent directories. Throws
907 an exception on failure.
909 =head2 print_environment_vars_for
913 =item Arguments: $path
915 =item Return value: None
919 Prints to standard output the variables listed above, properly set to use the
920 given path as the base directory.
922 =head2 build_environment_vars_for
926 =item Arguments: $path
928 =item Return value: %environment_vars
932 Returns a hash with the variables listed above, properly set to use the
933 given path as the base directory.
935 =head2 setup_env_hash_for
939 =item Arguments: $path
941 =item Return value: None
945 Constructs the C<%ENV> keys for the given path, by calling
946 L</build_environment_vars_for>.
952 =item Arguments: None
954 =item Return value: @paths
958 Returns a list of active C<local::lib> paths, according to the
959 C<PERL_LOCAL_LIB_ROOT> environment variable and verified against
960 what is really in C<@INC>.
962 =head2 install_base_perl_path
966 =item Arguments: $path
968 =item Return value: $install_base_perl_path
972 Returns a path describing where to install the Perl modules for this local
973 library installation. Appends the directories C<lib> and C<perl5> to the given
976 =head2 install_base_bin_path
980 =item Arguments: $path
982 =item Return value: $install_base_bin_path
986 Returns a path describing where to install the executable programs for this
987 local library installation. Appends the directory C<bin> to the given path.
989 =head2 resolve_empty_path
993 =item Arguments: $path
995 =item Return value: $base_path
999 Builds and returns the base path into which to set up the local module
1000 installation. Defaults to C<~/perl5>.
1002 =head2 resolve_home_path
1006 =item Arguments: $path
1008 =item Return value: $home_path
1012 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
1013 for this purpose. If no definite answer is available, throws an exception.
1015 =head2 resolve_relative_path
1019 =item Arguments: $path
1021 =item Return value: $absolute_path
1025 Translates the given path into an absolute path.
1031 =item Arguments: $path
1033 =item Return value: $absolute_path
1037 Calls the following in a pipeline, passing the result from the previous to the
1038 next, in an attempt to find where to configure the environment for a local
1039 library installation: L</resolve_empty_path>, L</resolve_home_path>,
1040 L</resolve_relative_path>. Passes the given path argument to
1041 L</resolve_empty_path> which then returns a result that is passed to
1042 L</resolve_home_path>, which then has its result passed to
1043 L</resolve_relative_path>. The result of this final call is returned from
1046 =head1 A WARNING ABOUT UNINST=1
1048 Be careful about using local::lib in combination with "make install UNINST=1".
1049 The idea of this feature is that will uninstall an old version of a module
1050 before installing a new one. However it lacks a safety check that the old
1051 version and the new version will go in the same directory. Used in combination
1052 with local::lib, you can potentially delete a globally accessible version of a
1053 module while installing the new version in a local place. Only combine "make
1054 install UNINST=1" and local::lib if you understand these possible consequences.
1060 =item * Directory names with spaces in them are not well supported by the perl
1061 toolchain and the programs it uses. Pure-perl distributions should support
1062 spaces, but problems are more likely with dists that require compilation. A
1063 workaround you can do is moving your local::lib to a directory with spaces
1064 B<after> you installed all modules inside your local::lib bootstrap. But be
1065 aware that you can't update or install CPAN modules after the move.
1067 =item * Rather basic shell detection. Right now anything with csh in its name is
1068 assumed to be a C shell or something compatible, and everything else is assumed
1069 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
1070 not set, a Bourne-compatible shell is assumed.
1072 =item * Kills any existing PERL_MM_OPT or PERL_MB_OPT.
1074 =item * Should probably auto-fixup CPAN config if not already done.
1078 Patches very much welcome for any of the above.
1082 =item * On Win32 systems, does not have a way to write the created environment
1083 variables to the registry, so that they can persist through a reboot.
1087 =head1 TROUBLESHOOTING
1089 If you've configured local::lib to install CPAN modules somewhere in to your
1090 home directory, and at some point later you try to install a module with C<cpan
1091 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1092 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1093 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1094 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1095 you've somehow lost your updated ExtUtils::MakeMaker module.
1097 To remedy this situation, rerun the bootstrapping procedure documented above.
1099 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1101 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1111 local::lib looks at the user's C<SHELL> environment variable when printing out
1112 commands to add to the shell configuration file.
1114 On Win32 systems, C<COMSPEC> is also examined.
1122 =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html>
1130 Join #local-lib on irc.perl.org.
1134 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1136 auto_install fixes kindly sponsored by http://www.takkle.com/
1140 Patches to correctly output commands for csh style shells, as well as some
1141 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1143 Doc patches for a custom local::lib directory, more cleanups in the english
1144 documentation and a L<german documentation|POD2::DE::local::lib> contributed by
1145 Torsten Raudssus <torsten@raudssus.de>.
1147 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1148 things will install properly, submitted a fix for the bug causing problems with
1149 writing Makefiles during bootstrapping, contributed an example program, and
1150 submitted yet another fix to ensure that local::lib can install and bootstrap
1151 properly. Many, many thanks!
1153 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1154 section. Many thanks!
1156 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1158 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1159 by a patch from Marco Emilio Poleggi.
1161 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1162 '--self-contained' option.
1164 Documentation patches to make win32 usage clearer by
1165 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1167 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc
1168 patches contributed by Breno G. de Oliveira <garu@cpan.org>.
1170 Improvements to stacking multiple local::lib dirs and removing them from the
1171 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1173 Patch for Carp version mismatch contributed by Hakim Cassimally
1174 <osfameron@cpan.org>.
1178 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1183 This is free software; you can redistribute it and/or modify it under
1184 the same terms as the Perl 5 programming language system itself.