11 our $VERSION = '1.008026'; # 1.8.26
12 $VERSION = eval $VERSION;
15 my ($class, @args) = @_;
21 my $arg = shift @args;
22 # check for lethal dash first to stop processing before causing problems
23 # the fancy dash is U+2212 or \xE2\x88\x92
24 if ($arg =~ /\xE2\x88\x92/ or $arg =~ /−/) {
26 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
27 These are *not* the traditional -- dashes that software recognizes. You
28 probably got these by copy-pasting from the perldoc for this module as
29 rendered by a UTF8-capable formatter. This most typically happens on an OS X
30 terminal, but can happen elsewhere too. Please try again after replacing the
31 dashes with normal minus signs.
34 elsif ($arg eq '--self-contained') {
35 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";
37 elsif( $arg =~ /^--deactivate(?:=(.*))?$/ ) {
38 my $path = defined $1 ? $1 : shift @args;
39 push @steps, ['deactivate', $path];
41 elsif ( $arg eq '--deactivate-all' ) {
42 push @steps, ['deactivate_all'];
44 elsif ( $arg =~ /^--shelltype(?:=(.*))?$/ ) {
45 my $shell = defined $1 ? $1 : shift @args;
46 $opts{shelltype} = $shell;
48 elsif ( $arg eq '--no-create' ) {
51 elsif ( $arg =~ /^--/ ) {
52 die "Unknown import argument: $arg";
55 push @steps, ['activate', $arg];
59 push @steps, ['activate', undef];
62 my $self = $class->new(%opts);
65 my ($method, @args) = @$_;
66 $self = $self->$method(@args);
70 $self->print_environment_vars_for;
74 $self->setup_local_lib_for;
85 bless {%$self, @_}, ref $self;
88 sub inc { $_[0]->{inc} ||= \@INC }
89 sub libs { $_[0]->{libs} ||= [ \'PERL5LIB' ] }
90 sub bins { $_[0]->{bins} ||= [ \'PATH' ] }
91 sub roots { $_[0]->{roots} ||= [ \'PERL_LOCAL_LIB_ROOT' ] }
92 sub extra { $_[0]->{extra} ||= {} }
93 sub shelltype { $_[0]->{shelltype} ||= $_[0]->guess_shelltype }
94 sub no_create { $_[0]->{no_create} }
96 my $_archname = $Config{archname};
97 my $_version = $Config{version};
98 my @_inc_version_list = reverse split / /, $Config{inc_version_list};
99 my $_path_sep = $Config{path_sep};
104 !(ref $_ && ref $_ eq 'SCALAR') ? $_ : (
105 defined $ENV{$$_} ? split(/\Q$_path_sep/, $ENV{$$_})
108 } ref $list ? @$list : $list;
111 my ($list, @remove) = @_;
114 my %remove = map { $_ => 1 } @remove;
115 grep !$remove{$_}, _as_list($list);
119 [$_version, $_archname],
122 (@_inc_version_list ? \@_inc_version_list : ()),
126 sub install_base_bin_path {
127 my ($class, $path) = @_;
128 return File::Spec->catdir($path, 'bin');
130 sub install_base_perl_path {
131 my ($class, $path) = @_;
132 return File::Spec->catdir($path, 'lib', 'perl5');
134 sub install_base_arch_path {
135 my ($class, $path) = @_;
136 File::Spec->catdir($class->install_base_perl_path($path), $_archname);
140 my ($class, $path) = @_;
141 my $base = $class->install_base_perl_path($path);
142 return map { File::Spec->catdir($base, @$_) } @_lib_subdirs;
145 sub _mm_escape_path {
147 $path =~ s/\\/\\\\\\\\/g;
148 if ($path =~ s/ /\\ /g) {
149 $path = qq{"\\"$path\\""};
154 sub _mb_escape_path {
156 $path =~ s/\\/\\\\/g;
160 sub installer_options_for {
161 my ($class, $path) = @_;
163 PERL_MM_OPT => defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef,
164 PERL_MB_OPT => defined $path ? "--install_base "._mb_escape_path($path) : undef,
170 $self = ref $self ? $self : $self->new;
173 # screen out entries that aren't actually reflected in @INC
174 my $active_ll = $self->install_base_perl_path($_);
175 grep { $_ eq $active_ll } @{$self->inc};
176 } _as_list($self->roots);
181 my ($self, $path) = @_;
182 $self = $self->new unless ref $self;
183 $path = $self->resolve_path($path);
184 $path = $self->normalize_path($path);
186 my @active_lls = $self->active_paths;
188 if (!grep { $_ eq $path } @active_lls) {
189 warn "Tried to deactivate inactive local::lib '$path'\n";
194 bins => [ _remove_from($self->bins, $self->install_base_bin_path($path)) ],
195 libs => [ _remove_from($self->libs, $self->install_base_perl_path($path)) ],
196 inc => [ _remove_from($self->inc, $self->lib_paths_for($path)) ],
197 roots => [ _remove_from($self->roots, $path) ],
200 $args{extra} = $self->installer_options_for($args{roots}[0]);
207 $self = $self->new unless ref $self;
209 my @active_lls = $self->active_paths;
214 bins => [ _remove_from($self->bins,
215 map $self->install_base_bin_path($_), @active_lls) ],
216 libs => [ _remove_from($self->libs,
217 map $self->install_base_perl_path($_), @active_lls) ],
218 inc => [ _remove_from($self->inc,
219 map $self->lib_paths_for($_), @active_lls) ],
220 roots => [ _remove_from($self->roots, @active_lls) ],
224 $args{extra} = $self->installer_options_for(undef);
230 my ($self, $path) = @_;
231 $self = $self->new unless ref $self;
232 $path = $self->resolve_path($path);
233 $self->ensure_dir_structure_for($path)
234 unless $self->no_create;
236 $path = $self->normalize_path($path);
238 my @active_lls = $self->active_paths;
240 if (grep { $_ eq $path } @active_lls[1 .. $#active_lls]) {
241 $self = $self->deactivate($path);
245 if (!@active_lls || $active_lls[0] ne $path) {
247 bins => [ $self->install_base_bin_path($path), @{$self->bins} ],
248 libs => [ $self->install_base_perl_path($path), @{$self->libs} ],
249 inc => [ $self->lib_paths_for($path), @{$self->inc} ],
250 roots => [ $path, @{$self->roots} ],
254 $args{extra} = $self->installer_options_for($path);
260 my ($self, $path) = @_;
261 $path = ( Win32::GetShortPathName($path) || $path )
267 my ($self, $path) = @_;
268 $self = $self->new unless ref $self;
270 $self = $self->activate($path);
275 sub build_environment_vars_for {
276 my ($self) = _legacy(@_);
278 PATH => join($_path_sep, _as_list($self->bins)),
279 PERL5LIB => join($_path_sep, _as_list($self->libs)),
280 PERL_LOCAL_LIB_ROOT => join($_path_sep, _as_list($self->roots)),
285 sub setup_local_lib_for {
286 my ($self) = _legacy(@_);
287 $self->setup_env_hash_for;
288 @INC = @{$self->inc};
291 sub setup_env_hash_for {
293 my %env = $self->build_environment_vars_for(@_);
294 for my $key (keys %env) {
295 if (defined $env{$key}) {
296 $ENV{$key} = $env{$key};
304 sub print_environment_vars_for {
306 print $self->environment_vars_string_for(@_);
309 sub environment_vars_string_for {
310 my $self = _legacy(@_);
312 my $build_method = 'build_' . $self->shelltype . '_env_declaration';
316 PERL5LIB => $self->libs,
317 PERL_LOCAL_LIB_ROOT => $self->roots,
322 my ($name, $value) = (shift(@envs), shift(@envs));
327 && ref $value->[0] eq 'SCALAR'
328 && ${$value->[0]} eq $name) {
334 ? (defined $ENV{$name} && $value eq $ENV{$name})
335 : !defined $ENV{$name}
339 $out .= $self->$build_method($name, $value);
341 my $wrap_method = 'wrap_' . $self->shelltype . '_output';
342 if ($self->can($wrap_method)) {
343 return $self->$wrap_method($out);
348 sub build_bourne_env_declaration {
349 my ($class, $name, $args) = @_;
350 my $value = $class->_interpolate($args);
353 if (!defined $joined) {
356 elsif ($_ eq "\$$name") {
357 $joined .= "\${$name+$Config{path_sep}}$_";
360 $joined .= "$Config{path_sep}$_";
364 ? qq{export ${name}="$joined";\n}
365 : qq{unset ${name};\n};
367 sub build_csh_env_declaration {
368 my ($class, $name, $args) = @_;
369 my ($value, @vars) = $class->_interpolate($args, undef, undef, '"', qq{"\\"});
373 $out = qq{if \$?$name };
375 $out .= defined $value ? qq{setenv $name "}.join($Config{path_sep},@$value).qq{";\n} : qq{unsetenv $name;\n};
377 my $no_var = $class->_interpolate([ grep { !ref } @$args ], undef, undef, '"', qq{"\\"});
378 if (defined $no_var) {
379 $out .= qq{if ! \$?$name setenv $name "}.join($Config{path_sep},@$no_var).qq{";\n};
384 sub build_cmd_env_declaration {
385 my ($class, $name, $args) = @_;
386 my $value = $class->_interpolate($args, '%', '%', qr([()!^"<>&|]), '^');
388 ? qq{\@set $name=}.join($Config{path_sep},@$value).qq{\n}
389 : qq{\@set $name=\n};
391 sub build_powershell_env_declaration {
392 my ($class, $name, $args) = @_;
393 my $value = $class->_interpolate($args, '$env:', '', '"', '`');
395 ? qq{\$env:$name = "}.join($Config{path_sep},@$value).qq{";\n}
396 : "Remove-Item Env:\\$name;\n";
398 sub wrap_powershell_output {
399 my ($class, $out) = @_;
400 return $out || " \n";
405 my ($class, $args, $start, $end, $escape, $escape_char) = @_;
407 unless defined $args;
412 $start = '$' unless defined $start;
413 $end = '' unless defined $end;
414 $escape = '"' unless defined $escape;
415 $escape_char = "\\" unless defined $escape_char;
418 if (ref $_ && ref $_ eq 'SCALAR') {
424 $str =~ s/($escape)/$escape_char$1/g;
428 return wantarray ? ($string, @vars) : $string;
435 my $last = pop(@methods);
438 my ($obj, @args) = @_;
439 $obj->${pipeline @methods}(
456 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
457 my $foo = bless({}, 'Foo');
458 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
465 my ($class, $path) = @_;
467 $path = $class->${pipeline qw(
468 resolve_relative_path
476 sub resolve_empty_path {
477 my ($class, $path) = @_;
487 #:: test classmethod setup
489 my $c = 'local::lib';
497 is($c->resolve_empty_path, '~/perl5');
498 is($c->resolve_empty_path('foo'), 'foo');
504 sub resolve_home_path {
505 my ($class, $path) = @_;
506 return $path unless ($path =~ /^~/);
507 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
509 if (!defined $user && defined $ENV{HOME}) {
514 File::Glob::bsd_glob("~$user", File::Glob::GLOB_TILDE());
517 unless (defined $homedir) {
520 "Couldn't resolve homedir for "
521 .(defined $user ? $user : 'current user')
524 $path =~ s/^~[^\/]*/$homedir/;
528 sub resolve_relative_path {
529 my ($class, $path) = @_;
530 $path = File::Spec->rel2abs($path);
537 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
538 is($c->resolve_relative_path('bar'),'FOObar');
544 sub ensure_dir_structure_for {
545 my ($class, $path) = @_;
547 warn "Attempting to create directory ${path}\n";
549 require File::Basename;
553 $path = File::Basename::dirname($path);
555 mkdir $_ for reverse @dirs;
563 File::Path::rmtree('t/var/splat');
565 $c->ensure_dir_structure_for('t/var/splat');
567 ok(-d 't/var/splat');
573 sub guess_shelltype {
575 = defined $ENV{SHELL}
576 ? (File::Spec->splitpath($ENV{SHELL}))[-1]
577 : ( $^O eq 'MSWin32' && exists $ENV{'!EXITCODE'} )
579 : ( $^O eq 'MSWin32' && $ENV{PROMPT} && $ENV{COMSPEC} )
580 ? (File::Spec->splitpath($ENV{COMSPEC}))[-1]
581 : ( $^O eq 'MSWin32' && !$ENV{PROMPT} )
588 : /command\.com/i ? 'cmd'
589 : /cmd\.exe/i ? 'cmd'
590 : /4nt\.exe/i ? 'cmd'
591 : /powershell\.exe/i ? 'powershell'
603 local::lib - create and use a local lib/ for perl modules with PERL5LIB
609 use local::lib; # sets up a local lib at ~/perl5
611 use local::lib '~/foo'; # same, but ~/foo
615 use local::lib "$FindBin::Bin/../support"; # app-local support library
619 # Install LWP and its missing dependencies to the '~/perl5' directory
620 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
622 # Just print out useful shell commands
624 export PERL_MB_OPT='--install_base /home/username/perl5'
625 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
626 export PERL5LIB="/home/username/perl5/lib/perl5"
627 export PATH="/home/username/perl5/bin:$PATH"
629 =head2 The bootstrapping technique
631 A typical way to install local::lib is using what is known as the
632 "bootstrapping" technique. You would do this if your system administrator
633 hasn't already installed local::lib. In this case, you'll need to install
634 local::lib in your home directory.
636 Even if you do have administrative privileges, you will still want to set up your
637 environment variables, as discussed in step 4. Without this, you would still
638 install the modules into the system CPAN installation and also your Perl scripts
639 will not use the lib/ path you bootstrapped with local::lib.
641 By default local::lib installs itself and the CPAN modules into ~/perl5.
643 Windows users must also see L</Differences when using this module under Win32>.
645 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
646 on the CPAN page about local::lib). Do this as an ordinary user, not as root
647 or administrator. Unpack the file in your home directory or in any other
652 perl Makefile.PL --bootstrap
654 If the system asks you whether it should automatically configure as much
655 as possible, you would typically answer yes.
657 In order to install local::lib into a directory other than the default, you need
658 to specify the name of the directory when you call bootstrap, as follows:
660 perl Makefile.PL --bootstrap=~/foo
662 3. Run this: (local::lib assumes you have make installed on your system)
664 make test && make install
666 4. Now we need to setup the appropriate environment variables, so that Perl
667 starts using our newly generated lib/ directory. If you are using bash or
668 any other Bourne shells, you can add this to your shell startup script this
671 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
673 If you are using C shell, you can do this as follows:
678 echo 'eval `perl -I$HOME/perl5/lib/perl5 -Mlocal::lib`' >> ~/.cshrc
680 If you passed to bootstrap a directory other than default, you also need to
681 give that as import parameter to the call of the local::lib module like this
684 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
686 After writing your shell configuration file, be sure to re-read it to get the
687 changed settings into your current shell's environment. Bourne shells use
688 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
690 If you're on a slower machine, or are operating under draconian disk space
691 limitations, you can disable the automatic generation of manpages from POD when
692 installing modules by using the C<--no-manpages> argument when bootstrapping:
694 perl Makefile.PL --bootstrap --no-manpages
696 To avoid doing several bootstrap for several Perl module environments on the
697 same account, for example if you use it for several different deployed
698 applications independently, you can use one bootstrapped local::lib
699 installation to install modules in different directories directly this way:
703 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
704 printenv ### You will see that ~/mydir1 is in the PERL5LIB
705 perl -MCPAN -e install ... ### whatever modules you want
709 If you are working with several C<local::lib> environments, you may want to
710 remove some of them from the current environment without disturbing the others.
711 You can deactivate one environment like this (using bourne sh):
713 eval $(perl -Mlocal::lib=--deactivate,~/path)
715 which will generate and run the commands needed to remove C<~/path> from your
716 various search paths. Whichever environment was B<activated most recently> will
717 remain the target for module installations. That is, if you activate
718 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
719 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
720 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
721 installed in C<~/pathB> because pathB was activated later.
723 You can also ask C<local::lib> to clean itself completely out of the current
724 shell's environment with the C<--deactivate-all> option.
725 For multiple environments for multiple apps you may need to include a modified
726 version of the C<< use FindBin >> instructions in the "In code" sample above.
727 If you did something like the above, you have a set of Perl modules at C<<
728 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
729 you need to tell it where to find the modules you installed for it at C<<
732 In C<< ~/mydir1/scripts/myscript.pl >>:
736 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
737 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
739 Put this before any BEGIN { ... } blocks that require the modules you installed.
741 =head2 Differences when using this module under Win32
743 To set up the proper environment variables for your current session of
744 C<CMD.exe>, you can use this:
746 C:\>perl -Mlocal::lib
747 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
748 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
749 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5
750 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
752 ### To set the environment for this shell alone
753 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
754 ### instead of $(perl -Mlocal::lib=./)
756 If you want the environment entries to persist, you'll need to add them to the
757 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
759 The "~" is translated to the user's profile directory (the directory named for
760 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
761 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
762 directory is translated to a short name (which means the directory must exist)
763 and the subdirectories are created.
767 local::lib also supports PowerShell, and an be used with the
768 C<Invoke-Expression> cmdlet.
770 Invoke-Expression "$(perl -Mlocal::lib)"
774 The version of a Perl package on your machine is not always the version you
775 need. Obviously, the best thing to do would be to update to the version you
776 need. However, you might be in a situation where you're prevented from doing
777 this. Perhaps you don't have system administrator privileges; or perhaps you
778 are using a package management system such as Debian, and nobody has yet gotten
779 around to packaging up the version you need.
781 local::lib solves this problem by allowing you to create your own directory of
782 Perl packages downloaded from CPAN (in a multi-user system, this would typically
783 be within your own home directory). The existing system Perl installation is
784 not affected; you simply invoke Perl with special options so that Perl uses the
785 packages in your own local package directory rather than the system packages.
786 local::lib arranges things so that your locally installed version of the Perl
787 packages takes precedence over the system installation.
789 If you are using a package management system (such as Debian), you don't need to
790 worry about Debian and CPAN stepping on each other's toes. Your local version
791 of the packages will be written to an entirely separate directory from those
796 This module provides a quick, convenient way of bootstrapping a user-local Perl
797 module library located within the user's home directory. It also constructs and
798 prints out for the user the list of environment variables using the syntax
799 appropriate for the user's current shell (as specified by the C<SHELL>
800 environment variable), suitable for directly adding to one's shell
803 More generally, local::lib allows for the bootstrapping and usage of a
804 directory containing Perl modules outside of Perl's C<@INC>. This makes it
805 easier to ship an application with an app-specific copy of a Perl module, or
806 collection of modules. Useful in cases like when an upstream maintainer hasn't
807 applied a patch to a module of theirs that you need for your application.
809 On import, local::lib sets the following environment variables to appropriate
824 When possible, these will be appended to instead of overwritten entirely.
826 These values are then available for reference by any code after import.
828 =head1 CREATING A SELF-CONTAINED SET OF MODULES
830 See L<lib::core::only> for one way to do this - but note that
831 there are a number of caveats, and the best approach is always to perform a
832 build against a clean perl (i.e. site and vendor as close to empty as possible).
836 Options are values that can be passed to the C<local::lib> import besides the
837 directory to use. They are specified as C<use local::lib '--option'[, path];>
838 or C<perl -Mlocal::lib=--option[,path]>.
842 Remove the chosen path (or the default path) from the module search paths if it
843 was added by C<local::lib>, instead of adding it.
845 =head2 --deactivate-all
847 Remove all directories that were added to search paths by C<local::lib> from the
852 Specify the shell type to use for output. By default, the shell will be
853 detected based on the environment. Should be one of: C<bourne>, C<csh>,
854 C<cmd>, or C<powershell>.
858 Prevents C<local::lib> from creating directories when activating dirs. This is
859 likely to cause issues on Win32 systems.
863 =head2 ensure_dir_structure_for
867 =item Arguments: $path
869 =item Return value: None
873 Attempts to create the given path, and all required parent directories. Throws
874 an exception on failure.
876 =head2 print_environment_vars_for
880 =item Arguments: $path
882 =item Return value: None
886 Prints to standard output the variables listed above, properly set to use the
887 given path as the base directory.
889 =head2 build_environment_vars_for
893 =item Arguments: $path
895 =item Return value: %environment_vars
899 Returns a hash with the variables listed above, properly set to use the
900 given path as the base directory.
902 =head2 setup_env_hash_for
906 =item Arguments: $path
908 =item Return value: None
912 Constructs the C<%ENV> keys for the given path, by calling
913 L</build_environment_vars_for>.
919 =item Arguments: None
921 =item Return value: @paths
925 Returns a list of active C<local::lib> paths, according to the
926 C<PERL_LOCAL_LIB_ROOT> environment variable and verified against
927 what is really in C<@INC>.
929 =head2 install_base_perl_path
933 =item Arguments: $path
935 =item Return value: $install_base_perl_path
939 Returns a path describing where to install the Perl modules for this local
940 library installation. Appends the directories C<lib> and C<perl5> to the given
943 =head2 install_base_bin_path
947 =item Arguments: $path
949 =item Return value: $install_base_bin_path
953 Returns a path describing where to install the executable programs for this
954 local library installation. Appends the directory C<bin> to the given path.
956 =head2 resolve_empty_path
960 =item Arguments: $path
962 =item Return value: $base_path
966 Builds and returns the base path into which to set up the local module
967 installation. Defaults to C<~/perl5>.
969 =head2 resolve_home_path
973 =item Arguments: $path
975 =item Return value: $home_path
979 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
980 for this purpose. If no definite answer is available, throws an exception.
982 =head2 resolve_relative_path
986 =item Arguments: $path
988 =item Return value: $absolute_path
992 Translates the given path into an absolute path.
998 =item Arguments: $path
1000 =item Return value: $absolute_path
1004 Calls the following in a pipeline, passing the result from the previous to the
1005 next, in an attempt to find where to configure the environment for a local
1006 library installation: L</resolve_empty_path>, L</resolve_home_path>,
1007 L</resolve_relative_path>. Passes the given path argument to
1008 L</resolve_empty_path> which then returns a result that is passed to
1009 L</resolve_home_path>, which then has its result passed to
1010 L</resolve_relative_path>. The result of this final call is returned from
1013 =head1 A WARNING ABOUT UNINST=1
1015 Be careful about using local::lib in combination with "make install UNINST=1".
1016 The idea of this feature is that will uninstall an old version of a module
1017 before installing a new one. However it lacks a safety check that the old
1018 version and the new version will go in the same directory. Used in combination
1019 with local::lib, you can potentially delete a globally accessible version of a
1020 module while installing the new version in a local place. Only combine "make
1021 install UNINST=1" and local::lib if you understand these possible consequences.
1027 =item * Directory names with spaces in them are not well supported by the perl
1028 toolchain and the programs it uses. Pure-perl distributions should support
1029 spaces, but problems are more likely with dists that require compilation. A
1030 workaround you can do is moving your local::lib to a directory with spaces
1031 B<after> you installed all modules inside your local::lib bootstrap. But be
1032 aware that you can't update or install CPAN modules after the move.
1034 =item * Rather basic shell detection. Right now anything with csh in its name is
1035 assumed to be a C shell or something compatible, and everything else is assumed
1036 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
1037 not set, a Bourne-compatible shell is assumed.
1039 =item * Kills any existing PERL_MM_OPT or PERL_MB_OPT.
1041 =item * Should probably auto-fixup CPAN config if not already done.
1045 Patches very much welcome for any of the above.
1049 =item * On Win32 systems, does not have a way to write the created environment
1050 variables to the registry, so that they can persist through a reboot.
1054 =head1 TROUBLESHOOTING
1056 If you've configured local::lib to install CPAN modules somewhere in to your
1057 home directory, and at some point later you try to install a module with C<cpan
1058 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1059 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1060 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1061 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1062 you've somehow lost your updated ExtUtils::MakeMaker module.
1064 To remedy this situation, rerun the bootstrapping procedure documented above.
1066 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1068 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1078 local::lib looks at the user's C<SHELL> environment variable when printing out
1079 commands to add to the shell configuration file.
1081 On Win32 systems, C<COMSPEC> is also examined.
1089 =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html>
1097 Join #local-lib on irc.perl.org.
1101 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1103 auto_install fixes kindly sponsored by http://www.takkle.com/
1107 Patches to correctly output commands for csh style shells, as well as some
1108 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1110 Doc patches for a custom local::lib directory, more cleanups in the english
1111 documentation and a L<german documentation|POD2::DE::local::lib> contributed by
1112 Torsten Raudssus <torsten@raudssus.de>.
1114 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1115 things will install properly, submitted a fix for the bug causing problems with
1116 writing Makefiles during bootstrapping, contributed an example program, and
1117 submitted yet another fix to ensure that local::lib can install and bootstrap
1118 properly. Many, many thanks!
1120 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1121 section. Many thanks!
1123 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1125 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1126 by a patch from Marco Emilio Poleggi.
1128 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1129 '--self-contained' option.
1131 Documentation patches to make win32 usage clearer by
1132 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1134 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc
1135 patches contributed by Breno G. de Oliveira <garu@cpan.org>.
1137 Improvements to stacking multiple local::lib dirs and removing them from the
1138 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1140 Patch for Carp version mismatch contributed by Hakim Cassimally
1141 <osfameron@cpan.org>.
1145 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1150 This is free software; you can redistribute it and/or modify it under
1151 the same terms as the Perl 5 programming language system itself.