6 use 5.008001; # probably works with earlier versions but I'm not supporting them
7 # (patches would, of course, be welcome)
14 our $VERSION = '1.008004'; # 1.8.4
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
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) {
179 "Couldn't resolve homedir for "
180 .(defined $user ? $user : 'current user')
181 .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
184 $path =~ s/^~[^\/]*/$homedir/;
188 sub resolve_relative_path {
189 my ($class, $path) = @_;
190 $path = File::Spec->rel2abs($path);
197 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
198 is($c->resolve_relative_path('bar'),'FOObar');
204 sub setup_local_lib_for {
205 my ($class, $path, $deactivating) = @_;
207 my $interpolate = LITERAL_ENV;
208 my @active_lls = $class->active_paths;
210 $path = $class->ensure_dir_structure_for($path);
212 if (! $deactivating) {
213 if (@active_lls && $active_lls[-1] eq $path) {
215 return; # Asked to add what's already at the top of the stack
216 } elsif (grep { $_ eq $path} @active_lls) {
217 # Asked to add a dir that's lower in the stack -- so we remove it from
218 # where it is, and then add it back at the top.
219 $class->setup_env_hash_for($path, DEACTIVATE_ONE);
220 # Which means we can no longer output "PERL5LIB=...:$PERL5LIB" stuff
221 # anymore because we're taking something *out*.
222 $interpolate = INTERPOLATE_ENV;
227 $class->print_environment_vars_for($path, $deactivating, $interpolate);
230 $class->setup_env_hash_for($path, $deactivating);
231 @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC);
235 sub install_base_bin_path {
236 my ($class, $path) = @_;
237 File::Spec->catdir($path, 'bin');
240 sub install_base_perl_path {
241 my ($class, $path) = @_;
242 File::Spec->catdir($path, 'lib', 'perl5');
245 sub install_base_arch_path {
246 my ($class, $path) = @_;
247 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
250 sub ensure_dir_structure_for {
251 my ($class, $path) = @_;
253 warn "Attempting to create directory ${path}\n";
255 File::Path::mkpath($path);
256 # Need to have the path exist to make a short name for it, so
257 # converting to a short name here.
258 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
263 sub guess_shelltype {
265 if(defined $ENV{'SHELL'}) {
266 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
267 $shellbin = $shell_bin_path_parts[-1];
270 local $_ = $shellbin;
278 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
279 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
280 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
281 $shellbin = $shell_bin_path_parts[-1];
283 local $_ = $shellbin;
286 } elsif(/cmd\.exe/) {
288 } elsif(/4nt\.exe/) {
298 sub print_environment_vars_for {
299 my ($class, $path, $deactivating, $interpolate) = @_;
300 print $class->environment_vars_string_for($path, $deactivating, $interpolate);
303 sub environment_vars_string_for {
304 my ($class, $path, $deactivating, $interpolate) = @_;
305 my @envs = $class->build_environment_vars_for($path, $deactivating, $interpolate);
308 # rather basic csh detection, goes on the assumption that something won't
309 # call itself csh unless it really is. also, default to bourne in the
310 # pathological situation where a user doesn't have $ENV{SHELL} defined.
311 # note also that shells with funny names, like zoid, are assumed to be
314 my $shelltype = $class->guess_shelltype;
317 my ($name, $value) = (shift(@envs), shift(@envs));
318 $value =~ s/(\\")/\\$1/g if defined $value;
319 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
324 # simple routines that take two arguments: an %ENV key and a value. return
325 # strings that are suitable for passing directly to the relevant shell to set
326 # said key to said value.
327 sub build_bourne_env_declaration {
329 my($name, $value) = @_;
330 return defined($value) ? qq{export ${name}="${value}";\n} : qq{unset ${name};\n};
333 sub build_csh_env_declaration {
335 my($name, $value) = @_;
336 return defined($value) ? qq{setenv ${name} "${value}"\n} : qq{unsetenv ${name}\n};
339 sub build_win32_env_declaration {
341 my($name, $value) = @_;
342 return defined($value) ? qq{set ${name}=${value}\n} : qq{set ${name}=\n};
345 sub setup_env_hash_for {
346 my ($class, $path, $deactivating) = @_;
347 my %envs = $class->build_environment_vars_for($path, $deactivating, INTERPOLATE_ENV);
348 @ENV{keys %envs} = values %envs;
351 sub build_environment_vars_for {
352 my ($class, $path, $deactivating, $interpolate) = @_;
354 if ($deactivating == DEACTIVATE_ONE) {
355 return $class->build_deactivate_environment_vars_for($path, $interpolate);
356 } elsif ($deactivating == DEACTIVATE_ALL) {
357 return $class->build_deact_all_environment_vars_for($path, $interpolate);
359 return $class->build_activate_environment_vars_for($path, $interpolate);
363 sub build_activate_environment_vars_for {
364 my ($class, $path, $interpolate) = @_;
366 PERL_LOCAL_LIB_ROOT => join($Config{path_sep},
367 (($ENV{PERL_LOCAL_LIB_ROOT}||()) ?
368 ($interpolate == INTERPOLATE_ENV
369 ? ($ENV{PERL_LOCAL_LIB_ROOT}||())
370 : (($^O ne 'MSWin32') ? '$PERL_LOCAL_LIB_ROOT'
371 : '%PERL_LOCAL_LIB_ROOT%' ))
375 PERL_MB_OPT => "--install_base ${path}",
376 PERL_MM_OPT => "INSTALL_BASE=${path}",
377 PERL5LIB => join($Config{path_sep},
378 $class->install_base_arch_path($path),
379 $class->install_base_perl_path($path),
380 (($ENV{PERL5LIB}||()) ?
381 ($interpolate == INTERPOLATE_ENV
383 : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' ))
386 PATH => join($Config{path_sep},
387 $class->install_base_bin_path($path),
388 ($interpolate == INTERPOLATE_ENV
390 : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' ))
398 return () unless defined $ENV{PERL_LOCAL_LIB_ROOT};
399 return split /\Q$Config{path_sep}/, $ENV{PERL_LOCAL_LIB_ROOT};
402 sub build_deactivate_environment_vars_for {
403 my ($class, $path, $interpolate) = @_;
405 my @active_lls = $class->active_paths;
407 if (!grep { $_ eq $path } @active_lls) {
408 warn "Tried to deactivate inactive local::lib '$path'\n";
412 my @new_ll_root = grep { $_ ne $path } @active_lls;
413 my @new_perl5lib = grep {
414 $_ ne $class->install_base_arch_path($path) &&
415 $_ ne $class->install_base_perl_path($path)
416 } split /\Q$Config{path_sep}/, $ENV{PERL5LIB};
419 PERL_LOCAL_LIB_ROOT => (@new_ll_root ?
420 join($Config{path_sep}, @new_ll_root) : undef
422 PERL5LIB => (@new_perl5lib ?
423 join($Config{path_sep}, @new_perl5lib) : undef
425 PATH => join($Config{path_sep},
426 grep { $_ ne $class->install_base_bin_path($path) }
427 split /\Q$Config{path_sep}/, $ENV{PATH}
431 # If removing ourselves from the "top of the stack", set install paths to
432 # correspond with the new top of stack.
433 if ($active_lls[-1] eq $path) {
434 if (@active_lls > 1) {
435 my $new_top = $active_lls[-2];
437 PERL_MB_OPT => "--install_base ${new_top}",
438 PERL_MM_OPT => "INSTALL_BASE=${new_top}",
442 PERL_MB_OPT => undef,
443 PERL_MM_OPT => undef,
451 sub build_deact_all_environment_vars_for {
452 my ($class, $path, $interpolate) = @_;
454 my @active_lls = $class->active_paths;
456 my @new_perl5lib = split /\Q$Config{path_sep}/, $ENV{PERL5LIB};
457 my @new_path = split /\Q$Config{path_sep}/, $ENV{PATH};
459 for my $path (@active_lls) {
460 @new_perl5lib = grep {
461 $_ ne $class->install_base_arch_path($path) &&
462 $_ ne $class->install_base_perl_path($path)
466 $_ ne $class->install_base_bin_path($path)
471 PERL_LOCAL_LIB_ROOT => undef,
472 PERL_MM_OPT => undef,
473 PERL_MB_OPT => undef,
474 PERL5LIB => (@new_perl5lib ?
475 join($Config{path_sep}, @new_perl5lib) : undef
477 PATH => join($Config{path_sep}, @new_path),
487 File::Path::rmtree('t/var/splat');
489 $c->ensure_dir_structure_for('t/var/splat');
491 ok(-d 't/var/splat');
499 local::lib - create and use a local lib/ for perl modules with PERL5LIB
505 use local::lib; # sets up a local lib at ~/perl5
507 use local::lib '~/foo'; # same, but ~/foo
511 use local::lib "$FindBin::Bin/../support"; # app-local support library
515 # Install LWP and its missing dependencies to the '~/perl5' directory
516 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
518 # Just print out useful shell commands
520 export PERL_MB_OPT='--install_base /home/username/perl5'
521 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
522 export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5'
523 export PATH="/home/username/perl5/bin:$PATH"
525 =head2 The bootstrapping technique
527 A typical way to install local::lib is using what is known as the
528 "bootstrapping" technique. You would do this if your system administrator
529 hasn't already installed local::lib. In this case, you'll need to install
530 local::lib in your home directory.
532 If you do have administrative privileges, you will still want to set up your
533 environment variables, as discussed in step 4. Without this, you would still
534 install the modules into the system CPAN installation and also your Perl scripts
535 will not use the lib/ path you bootstrapped with local::lib.
537 By default local::lib installs itself and the CPAN modules into ~/perl5.
539 Windows users must also see L</Differences when using this module under Win32>.
541 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
542 on the CPAN page about local::lib). Do this as an ordinary user, not as root
543 or administrator. Unpack the file in your home directory or in any other
548 perl Makefile.PL --bootstrap
550 If the system asks you whether it should automatically configure as much
551 as possible, you would typically answer yes.
553 In order to install local::lib into a directory other than the default, you need
554 to specify the name of the directory when you call bootstrap, as follows:
556 perl Makefile.PL --bootstrap=~/foo
558 3. Run this: (local::lib assumes you have make installed on your system)
560 make test && make install
562 4. Now we need to setup the appropriate environment variables, so that Perl
563 starts using our newly generated lib/ directory. If you are using bash or
564 any other Bourne shells, you can add this to your shell startup script this
567 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
569 If you are using C shell, you can do this as follows:
574 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
576 If you passed to bootstrap a directory other than default, you also need to give that as
577 import parameter to the call of the local::lib module like this way:
579 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
581 After writing your shell configuration file, be sure to re-read it to get the
582 changed settings into your current shell's environment. Bourne shells use
583 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
585 If you're on a slower machine, or are operating under draconian disk space
586 limitations, you can disable the automatic generation of manpages from POD when
587 installing modules by using the C<--no-manpages> argument when bootstrapping:
589 perl Makefile.PL --bootstrap --no-manpages
591 To avoid doing several bootstrap for several Perl module environments on the
592 same account, for example if you use it for several different deployed
593 applications independently, you can use one bootstrapped local::lib
594 installation to install modules in different directories directly this way:
598 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
599 printenv ### You will see that ~/mydir1 is in the PERL5LIB
600 perl -MCPAN -e install ... ### whatever modules you want
604 If you are working with several C<local::lib> environments, you may want to
605 remove some of them from the current environment without disturbing the others.
606 You can deactivate one environment like this (using bourne sh):
608 eval $(perl -Mlocal::lib=--deactivate,~/path)
610 which will generate and run the commands needed to remove C<~/path> from your
611 various search paths. Whichever environment was B<activated most recently> will
612 remain the target for module installations. That is, if you activate
613 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
614 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
615 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
616 installed in C<~/pathB> because pathB was activated later.
618 You can also ask C<local::lib> to clean itself completely out of the current
619 shell's environment with the C<--deactivate-all> option.
620 For multiple environments for multiple apps you may need to include a modified
621 version of the C<< use FindBin >> instructions in the "In code" sample above.
622 If you did something like the above, you have a set of Perl modules at C<<
623 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
624 you need to tell it where to find the modules you installed for it at C<<
627 In C<< ~/mydir1/scripts/myscript.pl >>:
631 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
632 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
634 Put this before any BEGIN { ... } blocks that require the modules you installed.
636 =head2 Differences when using this module under Win32
638 To set up the proper environment variables for your current session of
639 C<CMD.exe>, you can use this:
641 C:\>perl -Mlocal::lib
642 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
643 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
644 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
645 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
647 ### To set the environment for this shell alone
648 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
649 ### instead of $(perl -Mlocal::lib=./)
651 If you want the environment entries to persist, you'll need to add then to the
652 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
654 The "~" is translated to the user's profile directory (the directory named for
655 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
656 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
657 directory is translated to a short name (which means the directory must exist)
658 and the subdirectories are created.
662 The version of a Perl package on your machine is not always the version you
663 need. Obviously, the best thing to do would be to update to the version you
664 need. However, you might be in a situation where you're prevented from doing
665 this. Perhaps you don't have system administrator privileges; or perhaps you
666 are using a package management system such as Debian, and nobody has yet gotten
667 around to packaging up the version you need.
669 local::lib solves this problem by allowing you to create your own directory of
670 Perl packages downloaded from CPAN (in a multi-user system, this would typically
671 be within your own home directory). The existing system Perl installation is
672 not affected; you simply invoke Perl with special options so that Perl uses the
673 packages in your own local package directory rather than the system packages.
674 local::lib arranges things so that your locally installed version of the Perl
675 packages takes precedence over the system installation.
677 If you are using a package management system (such as Debian), you don't need to
678 worry about Debian and CPAN stepping on each other's toes. Your local version
679 of the packages will be written to an entirely separate directory from those
684 This module provides a quick, convenient way of bootstrapping a user-local Perl
685 module library located within the user's home directory. It also constructs and
686 prints out for the user the list of environment variables using the syntax
687 appropriate for the user's current shell (as specified by the C<SHELL>
688 environment variable), suitable for directly adding to one's shell
691 More generally, local::lib allows for the bootstrapping and usage of a
692 directory containing Perl modules outside of Perl's C<@INC>. This makes it
693 easier to ship an application with an app-specific copy of a Perl module, or
694 collection of modules. Useful in cases like when an upstream maintainer hasn't
695 applied a patch to a module of theirs that you need for your application.
697 On import, local::lib sets the following environment variables to appropriate
710 PATH is appended to, rather than clobbered.
714 These values are then available for reference by any code after import.
716 =head1 CREATING A SELF-CONTAINED SET OF MODULES
718 See L<lib::core::only> for one way to do this - but note that
719 there are a number of caveats, and the best approach is always to perform a
720 build against a clean perl (i.e. site and vendor as close to empty as possible).
724 Options are values that can be passed to the C<local::lib> import besides the
725 directory to use. They are specified as C<use local::lib '--option'[, path];>
726 or C<perl -Mlocal::lib=--option[,path]>.
730 Remove the chosen path (or the default path) from the module search paths if it
731 was added by C<local::lib>, instead of adding it.
733 =head2 --deactivate-all
735 Remove all directories that were added to search paths by C<local::lib> from the
740 =head2 ensure_dir_structure_for
744 =item Arguments: $path
746 =item Return value: None
750 Attempts to create the given path, and all required parent directories. Throws
751 an exception on failure.
753 =head2 print_environment_vars_for
757 =item Arguments: $path
759 =item Return value: None
763 Prints to standard output the variables listed above, properly set to use the
764 given path as the base directory.
766 =head2 build_environment_vars_for
770 =item Arguments: $path, $interpolate
772 =item Return value: \%environment_vars
776 Returns a hash with the variables listed above, properly set to use the
777 given path as the base directory.
779 =head2 setup_env_hash_for
783 =item Arguments: $path
785 =item Return value: None
789 Constructs the C<%ENV> keys for the given path, by calling
790 L</build_environment_vars_for>.
796 =item Arguments: None
798 =item Return value: @paths
802 Returns a list of active C<local::lib> paths, according to the
803 C<PERL_LOCAL_LIB_ROOT> environment variable.
805 =head2 install_base_perl_path
809 =item Arguments: $path
811 =item Return value: $install_base_perl_path
815 Returns a path describing where to install the Perl modules for this local
816 library installation. Appends the directories C<lib> and C<perl5> to the given
819 =head2 install_base_arch_path
823 =item Arguments: $path
825 =item Return value: $install_base_arch_path
829 Returns a path describing where to install the architecture-specific Perl
830 modules for this local library installation. Based on the
831 L</install_base_perl_path> method's return value, and appends the value of
832 C<$Config{archname}>.
834 =head2 install_base_bin_path
838 =item Arguments: $path
840 =item Return value: $install_base_bin_path
844 Returns a path describing where to install the executable programs for this
845 local library installation. Based on the L</install_base_perl_path> method's
846 return value, and appends the directory C<bin>.
848 =head2 resolve_empty_path
852 =item Arguments: $path
854 =item Return value: $base_path
858 Builds and returns the base path into which to set up the local module
859 installation. Defaults to C<~/perl5>.
861 =head2 resolve_home_path
865 =item Arguments: $path
867 =item Return value: $home_path
871 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
872 for this purpose. If no definite answer is available, throws an exception.
874 =head2 resolve_relative_path
878 =item Arguments: $path
880 =item Return value: $absolute_path
884 Translates the given path into an absolute path.
890 =item Arguments: $path
892 =item Return value: $absolute_path
896 Calls the following in a pipeline, passing the result from the previous to the
897 next, in an attempt to find where to configure the environment for a local
898 library installation: L</resolve_empty_path>, L</resolve_home_path>,
899 L</resolve_relative_path>. Passes the given path argument to
900 L</resolve_empty_path> which then returns a result that is passed to
901 L</resolve_home_path>, which then has its result passed to
902 L</resolve_relative_path>. The result of this final call is returned from
905 =head1 A WARNING ABOUT UNINST=1
907 Be careful about using local::lib in combination with "make install UNINST=1".
908 The idea of this feature is that will uninstall an old version of a module
909 before installing a new one. However it lacks a safety check that the old
910 version and the new version will go in the same directory. Used in combination
911 with local::lib, you can potentially delete a globally accessible version of a
912 module while installing the new version in a local place. Only combine "make
913 install UNINST=1" and local::lib if you understand these possible consequences.
917 The perl toolchain is unable to handle directory names with spaces in it,
918 so you cant put your local::lib bootstrap into a directory with spaces. What
919 you can do is moving your local::lib to a directory with spaces B<after> you
920 installed all modules inside your local::lib bootstrap. But be aware that you
921 cant update or install CPAN modules after the move.
923 Rather basic shell detection. Right now anything with csh in its name is
924 assumed to be a C shell or something compatible, and everything else is assumed
925 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
926 not set, a Bourne-compatible shell is assumed.
928 Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
929 have CPANPLUS installed.
931 Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT.
933 Should probably auto-fixup CPAN config if not already done.
935 Patches very much welcome for any of the above.
937 On Win32 systems, does not have a way to write the created environment variables
938 to the registry, so that they can persist through a reboot.
940 =head1 TROUBLESHOOTING
942 If you've configured local::lib to install CPAN modules somewhere in to your
943 home directory, and at some point later you try to install a module with C<cpan
944 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
945 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
946 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
947 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
948 you've somehow lost your updated ExtUtils::MakeMaker module.
950 To remedy this situation, rerun the bootstrapping procedure documented above.
952 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
954 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
964 local::lib looks at the user's C<SHELL> environment variable when printing out
965 commands to add to the shell configuration file.
967 On Win32 systems, C<COMSPEC> is also examined.
975 Join #local-lib on irc.perl.org.
979 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
981 auto_install fixes kindly sponsored by http://www.takkle.com/
985 Patches to correctly output commands for csh style shells, as well as some
986 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
988 Doc patches for a custom local::lib directory, more cleanups in the english
989 documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
990 <torsten@raudssus.de>.
992 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
993 things will install properly, submitted a fix for the bug causing problems with
994 writing Makefiles during bootstrapping, contributed an example program, and
995 submitted yet another fix to ensure that local::lib can install and bootstrap
996 properly. Many, many thanks!
998 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
999 section. Many thanks!
1001 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1003 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1004 by a patch from Marco Emilio Poleggi.
1006 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1007 '--self-contained' option.
1009 Documentation patches to make win32 usage clearer by
1010 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1012 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
1013 G. de Oliveira <garu@cpan.org>.
1015 Improvements to stacking multiple local::lib dirs and removing them from the
1016 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1020 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1025 This library is free software and may be distributed under the same terms