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);
185 my @active_lls = $self->active_paths;
187 if (!grep { $_ eq $path } @active_lls) {
188 warn "Tried to deactivate inactive local::lib '$path'\n";
193 bins => [ _remove_from($self->bins, $self->install_base_bin_path($path)) ],
194 libs => [ _remove_from($self->libs, $self->install_base_perl_path($path)) ],
195 inc => [ _remove_from($self->inc, $self->lib_paths_for($path)) ],
196 roots => [ _remove_from($self->roots, $path) ],
199 $args{extra} = $self->installer_options_for($args{roots}[0]);
206 $self = $self->new unless ref $self;
208 my @active_lls = $self->active_paths;
213 bins => [ _remove_from($self->bins,
214 map $self->install_base_bin_path($_), @active_lls) ],
215 libs => [ _remove_from($self->libs,
216 map $self->install_base_perl_path($_), @active_lls) ],
217 inc => [ _remove_from($self->inc,
218 map $self->lib_paths_for($_), @active_lls) ],
219 roots => [ _remove_from($self->roots, @active_lls) ],
223 $args{extra} = $self->installer_options_for(undef);
229 my ($self, $path) = @_;
230 $self = $self->new unless ref $self;
231 $path = $self->resolve_path($path);
232 $self->ensure_dir_structure_for($path)
233 unless $self->no_create;
235 $path = ( Win32::GetShortPathName($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 $self = $self->new unless ref $self;
263 $self = $self->activate($path);
268 sub build_environment_vars_for {
269 my ($self) = _legacy(@_);
271 PATH => join($_path_sep, _as_list($self->bins)),
272 PERL5LIB => join($_path_sep, _as_list($self->libs)),
273 PERL_LOCAL_LIB_ROOT => join($_path_sep, _as_list($self->roots)),
278 sub setup_local_lib_for {
279 my ($self) = _legacy(@_);
280 $self->setup_env_hash_for;
281 @INC = @{$self->inc};
284 sub setup_env_hash_for {
286 my %env = $self->build_environment_vars_for(@_);
287 for my $key (keys %env) {
288 if (defined $env{$key}) {
289 $ENV{$key} = $env{$key};
297 sub print_environment_vars_for {
299 print $self->environment_vars_string_for(@_);
302 sub environment_vars_string_for {
303 my $self = _legacy(@_);
305 my $build_method = 'build_' . $self->shelltype . '_env_declaration';
309 PERL5LIB => $self->libs,
310 PERL_LOCAL_LIB_ROOT => $self->roots,
315 my ($name, $value) = (shift(@envs), shift(@envs));
320 && ref $value->[0] eq 'SCALAR'
321 && ${$value->[0]} eq $name) {
327 ? (defined $ENV{$name} && $value eq $ENV{$name})
328 : !defined $ENV{$name}
332 $out .= $self->$build_method($name, $value);
334 my $wrap_method = 'wrap_' . $self->shelltype . '_output';
335 if ($self->can($wrap_method)) {
336 return $self->$wrap_method($out);
341 sub build_bourne_env_declaration {
342 my ($class, $name, $args) = @_;
343 my $value = $class->_interpolate($args);
345 ? qq{export ${name}="${value}";\n}
346 : qq{unset ${name};\n};
348 sub build_csh_env_declaration {
349 my ($class, $name, $args) = @_;
350 my ($value, @vars) = $class->_interpolate($args, undef, undef, '"', qq{"\\"});
351 (join '', map qq{if ! \$?$_ setenv $_ "";\n}, @vars)
353 ? qq{setenv $name "$value";\n}
354 : qq{unsetenv $name;\n};
356 sub build_cmd_env_declaration {
357 my ($class, $name, $args) = @_;
358 my $value = $class->_interpolate($args, '%', '%', qr([()!^"<>&|]), '^');
360 ? qq{\@set $name=$value\n}
361 : qq{\@set $name=\n};
363 sub build_powershell_env_declaration {
364 my ($class, $name, $args) = @_;
365 my $value = $class->_interpolate($args, '$env:', '', '"', '`');
367 ? qq{\$env:$name = "$value";\n}
368 : "Remove-Item Env:\\$name;\n";
370 sub wrap_powershell_output {
371 my ($class, $out) = @_;
372 return $out || " \n";
377 my ($class, $args, $start, $end, $escape, $escape_char) = @_;
379 unless defined $args;
384 $start = '$' unless defined $start;
385 $end = '' unless defined $end;
386 $escape = '"' unless defined $escape;
387 $escape_char = "\\" unless defined $escape_char;
389 my $string = join($Config{path_sep}, map {
390 if (ref $_ && ref $_ eq 'SCALAR') {
396 $str =~ s/($escape)/$escape_char$1/g;
400 return wantarray ? ($string, @vars) : $string;
407 my $last = pop(@methods);
410 my ($obj, @args) = @_;
411 $obj->${pipeline @methods}(
428 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
429 my $foo = bless({}, 'Foo');
430 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
437 my ($class, $path) = @_;
439 $path = $class->${pipeline qw(
440 resolve_relative_path
448 sub resolve_empty_path {
449 my ($class, $path) = @_;
459 #:: test classmethod setup
461 my $c = 'local::lib';
469 is($c->resolve_empty_path, '~/perl5');
470 is($c->resolve_empty_path('foo'), 'foo');
476 sub resolve_home_path {
477 my ($class, $path) = @_;
478 return $path unless ($path =~ /^~/);
479 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
481 if (!defined $user && defined $ENV{HOME}) {
486 File::Glob::bsd_glob("~$user", File::Glob::GLOB_TILDE());
489 unless (defined $homedir) {
492 "Couldn't resolve homedir for "
493 .(defined $user ? $user : 'current user')
496 $path =~ s/^~[^\/]*/$homedir/;
500 sub resolve_relative_path {
501 my ($class, $path) = @_;
502 $path = File::Spec->rel2abs($path);
509 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
510 is($c->resolve_relative_path('bar'),'FOObar');
516 sub ensure_dir_structure_for {
517 my ($class, $path) = @_;
519 warn "Attempting to create directory ${path}\n";
521 require File::Basename;
525 $path = File::Basename::dirname($path);
527 mkdir $_ for reverse @dirs;
535 File::Path::rmtree('t/var/splat');
537 $c->ensure_dir_structure_for('t/var/splat');
539 ok(-d 't/var/splat');
545 sub guess_shelltype {
547 = defined $ENV{SHELL}
548 ? (File::Spec->splitpath($ENV{SHELL}))[-1]
549 : ( $^O eq 'MSWin32' && exists $ENV{'!EXITCODE'} )
551 : ( $^O eq 'MSWin32' && $ENV{PROMPT} && $ENV{COMSPEC} )
552 ? (File::Spec->splitpath($ENV{COMSPEC}))[-1]
553 : ( $^O eq 'MSWin32' && !$ENV{PROMPT} )
560 : /command\.com/ ? 'cmd'
563 : /powershell\.exe/ ? 'powershell'
575 local::lib - create and use a local lib/ for perl modules with PERL5LIB
581 use local::lib; # sets up a local lib at ~/perl5
583 use local::lib '~/foo'; # same, but ~/foo
587 use local::lib "$FindBin::Bin/../support"; # app-local support library
591 # Install LWP and its missing dependencies to the '~/perl5' directory
592 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
594 # Just print out useful shell commands
596 export PERL_MB_OPT='--install_base /home/username/perl5'
597 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
598 export PERL5LIB="/home/username/perl5/lib/perl5"
599 export PATH="/home/username/perl5/bin:$PATH"
601 =head2 The bootstrapping technique
603 A typical way to install local::lib is using what is known as the
604 "bootstrapping" technique. You would do this if your system administrator
605 hasn't already installed local::lib. In this case, you'll need to install
606 local::lib in your home directory.
608 Even if you do have administrative privileges, you will still want to set up your
609 environment variables, as discussed in step 4. Without this, you would still
610 install the modules into the system CPAN installation and also your Perl scripts
611 will not use the lib/ path you bootstrapped with local::lib.
613 By default local::lib installs itself and the CPAN modules into ~/perl5.
615 Windows users must also see L</Differences when using this module under Win32>.
617 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
618 on the CPAN page about local::lib). Do this as an ordinary user, not as root
619 or administrator. Unpack the file in your home directory or in any other
624 perl Makefile.PL --bootstrap
626 If the system asks you whether it should automatically configure as much
627 as possible, you would typically answer yes.
629 In order to install local::lib into a directory other than the default, you need
630 to specify the name of the directory when you call bootstrap, as follows:
632 perl Makefile.PL --bootstrap=~/foo
634 3. Run this: (local::lib assumes you have make installed on your system)
636 make test && make install
638 4. Now we need to setup the appropriate environment variables, so that Perl
639 starts using our newly generated lib/ directory. If you are using bash or
640 any other Bourne shells, you can add this to your shell startup script this
643 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
645 If you are using C shell, you can do this as follows:
650 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
652 If you passed to bootstrap a directory other than default, you also need to
653 give that as import parameter to the call of the local::lib module like this
656 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
658 After writing your shell configuration file, be sure to re-read it to get the
659 changed settings into your current shell's environment. Bourne shells use
660 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
662 If you're on a slower machine, or are operating under draconian disk space
663 limitations, you can disable the automatic generation of manpages from POD when
664 installing modules by using the C<--no-manpages> argument when bootstrapping:
666 perl Makefile.PL --bootstrap --no-manpages
668 To avoid doing several bootstrap for several Perl module environments on the
669 same account, for example if you use it for several different deployed
670 applications independently, you can use one bootstrapped local::lib
671 installation to install modules in different directories directly this way:
675 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
676 printenv ### You will see that ~/mydir1 is in the PERL5LIB
677 perl -MCPAN -e install ... ### whatever modules you want
681 If you are working with several C<local::lib> environments, you may want to
682 remove some of them from the current environment without disturbing the others.
683 You can deactivate one environment like this (using bourne sh):
685 eval $(perl -Mlocal::lib=--deactivate,~/path)
687 which will generate and run the commands needed to remove C<~/path> from your
688 various search paths. Whichever environment was B<activated most recently> will
689 remain the target for module installations. That is, if you activate
690 C<~/path_A> and then you activate C<~/path_B>, new modules you install will go
691 in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed
692 into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be
693 installed in C<~/pathB> because pathB was activated later.
695 You can also ask C<local::lib> to clean itself completely out of the current
696 shell's environment with the C<--deactivate-all> option.
697 For multiple environments for multiple apps you may need to include a modified
698 version of the C<< use FindBin >> instructions in the "In code" sample above.
699 If you did something like the above, you have a set of Perl modules at C<<
700 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
701 you need to tell it where to find the modules you installed for it at C<<
704 In C<< ~/mydir1/scripts/myscript.pl >>:
708 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
709 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
711 Put this before any BEGIN { ... } blocks that require the modules you installed.
713 =head2 Differences when using this module under Win32
715 To set up the proper environment variables for your current session of
716 C<CMD.exe>, you can use this:
718 C:\>perl -Mlocal::lib
719 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
720 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
721 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5
722 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
724 ### To set the environment for this shell alone
725 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat
726 ### instead of $(perl -Mlocal::lib=./)
728 If you want the environment entries to persist, you'll need to add then to the
729 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
731 The "~" is translated to the user's profile directory (the directory named for
732 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
733 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
734 directory is translated to a short name (which means the directory must exist)
735 and the subdirectories are created.
739 The version of a Perl package on your machine is not always the version you
740 need. Obviously, the best thing to do would be to update to the version you
741 need. However, you might be in a situation where you're prevented from doing
742 this. Perhaps you don't have system administrator privileges; or perhaps you
743 are using a package management system such as Debian, and nobody has yet gotten
744 around to packaging up the version you need.
746 local::lib solves this problem by allowing you to create your own directory of
747 Perl packages downloaded from CPAN (in a multi-user system, this would typically
748 be within your own home directory). The existing system Perl installation is
749 not affected; you simply invoke Perl with special options so that Perl uses the
750 packages in your own local package directory rather than the system packages.
751 local::lib arranges things so that your locally installed version of the Perl
752 packages takes precedence over the system installation.
754 If you are using a package management system (such as Debian), you don't need to
755 worry about Debian and CPAN stepping on each other's toes. Your local version
756 of the packages will be written to an entirely separate directory from those
761 This module provides a quick, convenient way of bootstrapping a user-local Perl
762 module library located within the user's home directory. It also constructs and
763 prints out for the user the list of environment variables using the syntax
764 appropriate for the user's current shell (as specified by the C<SHELL>
765 environment variable), suitable for directly adding to one's shell
768 More generally, local::lib allows for the bootstrapping and usage of a
769 directory containing Perl modules outside of Perl's C<@INC>. This makes it
770 easier to ship an application with an app-specific copy of a Perl module, or
771 collection of modules. Useful in cases like when an upstream maintainer hasn't
772 applied a patch to a module of theirs that you need for your application.
774 On import, local::lib sets the following environment variables to appropriate
789 When possible, these will be appended to instead of overwritten entirely.
791 These values are then available for reference by any code after import.
793 =head1 CREATING A SELF-CONTAINED SET OF MODULES
795 See L<lib::core::only> for one way to do this - but note that
796 there are a number of caveats, and the best approach is always to perform a
797 build against a clean perl (i.e. site and vendor as close to empty as possible).
801 Options are values that can be passed to the C<local::lib> import besides the
802 directory to use. They are specified as C<use local::lib '--option'[, path];>
803 or C<perl -Mlocal::lib=--option[,path]>.
807 Remove the chosen path (or the default path) from the module search paths if it
808 was added by C<local::lib>, instead of adding it.
810 =head2 --deactivate-all
812 Remove all directories that were added to search paths by C<local::lib> from the
817 Specify the shell type to use for output. By default, the shell will be
818 detected based on the environment. Should be one of: C<bourne>, C<csh>,
819 C<cmd>, or C<powershell>.
823 Prevents C<local::lib> from creating directories when activating dirs. This is
824 likely to cause issues on Win32 systems.
828 =head2 ensure_dir_structure_for
832 =item Arguments: $path
834 =item Return value: None
838 Attempts to create the given path, and all required parent directories. Throws
839 an exception on failure.
841 =head2 print_environment_vars_for
845 =item Arguments: $path
847 =item Return value: None
851 Prints to standard output the variables listed above, properly set to use the
852 given path as the base directory.
854 =head2 build_environment_vars_for
858 =item Arguments: $path
860 =item Return value: %environment_vars
864 Returns a hash with the variables listed above, properly set to use the
865 given path as the base directory.
867 =head2 setup_env_hash_for
871 =item Arguments: $path
873 =item Return value: None
877 Constructs the C<%ENV> keys for the given path, by calling
878 L</build_environment_vars_for>.
884 =item Arguments: None
886 =item Return value: @paths
890 Returns a list of active C<local::lib> paths, according to the
891 C<PERL_LOCAL_LIB_ROOT> environment variable and verified against
892 what is really in C<@INC>.
894 =head2 install_base_perl_path
898 =item Arguments: $path
900 =item Return value: $install_base_perl_path
904 Returns a path describing where to install the Perl modules for this local
905 library installation. Appends the directories C<lib> and C<perl5> to the given
908 =head2 install_base_bin_path
912 =item Arguments: $path
914 =item Return value: $install_base_bin_path
918 Returns a path describing where to install the executable programs for this
919 local library installation. Appends the directory C<bin> to the given path.
921 =head2 resolve_empty_path
925 =item Arguments: $path
927 =item Return value: $base_path
931 Builds and returns the base path into which to set up the local module
932 installation. Defaults to C<~/perl5>.
934 =head2 resolve_home_path
938 =item Arguments: $path
940 =item Return value: $home_path
944 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
945 for this purpose. If no definite answer is available, throws an exception.
947 =head2 resolve_relative_path
951 =item Arguments: $path
953 =item Return value: $absolute_path
957 Translates the given path into an absolute path.
963 =item Arguments: $path
965 =item Return value: $absolute_path
969 Calls the following in a pipeline, passing the result from the previous to the
970 next, in an attempt to find where to configure the environment for a local
971 library installation: L</resolve_empty_path>, L</resolve_home_path>,
972 L</resolve_relative_path>. Passes the given path argument to
973 L</resolve_empty_path> which then returns a result that is passed to
974 L</resolve_home_path>, which then has its result passed to
975 L</resolve_relative_path>. The result of this final call is returned from
978 =head1 A WARNING ABOUT UNINST=1
980 Be careful about using local::lib in combination with "make install UNINST=1".
981 The idea of this feature is that will uninstall an old version of a module
982 before installing a new one. However it lacks a safety check that the old
983 version and the new version will go in the same directory. Used in combination
984 with local::lib, you can potentially delete a globally accessible version of a
985 module while installing the new version in a local place. Only combine "make
986 install UNINST=1" and local::lib if you understand these possible consequences.
992 =item * Directory names with spaces in them are not well supported by the perl
993 toolchain and the programs it uses. Pure-perl distributions should support
994 spaces, but problems are more likely with dists that require compilation. A
995 workaround you can do is moving your local::lib to a directory with spaces
996 B<after> you installed all modules inside your local::lib bootstrap. But be
997 aware that you can't update or install CPAN modules after the move.
999 =item * Rather basic shell detection. Right now anything with csh in its name is
1000 assumed to be a C shell or something compatible, and everything else is assumed
1001 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
1002 not set, a Bourne-compatible shell is assumed.
1004 =item * Kills any existing PERL_MM_OPT or PERL_MB_OPT.
1006 =item * Should probably auto-fixup CPAN config if not already done.
1010 Patches very much welcome for any of the above.
1014 =item * On Win32 systems, does not have a way to write the created environment
1015 variables to the registry, so that they can persist through a reboot.
1019 =head1 TROUBLESHOOTING
1021 If you've configured local::lib to install CPAN modules somewhere in to your
1022 home directory, and at some point later you try to install a module with C<cpan
1023 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
1024 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
1025 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
1026 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
1027 you've somehow lost your updated ExtUtils::MakeMaker module.
1029 To remedy this situation, rerun the bootstrapping procedure documented above.
1031 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
1033 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
1043 local::lib looks at the user's C<SHELL> environment variable when printing out
1044 commands to add to the shell configuration file.
1046 On Win32 systems, C<COMSPEC> is also examined.
1054 =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html>
1062 Join #local-lib on irc.perl.org.
1066 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
1068 auto_install fixes kindly sponsored by http://www.takkle.com/
1072 Patches to correctly output commands for csh style shells, as well as some
1073 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
1075 Doc patches for a custom local::lib directory, more cleanups in the english
1076 documentation and a L<german documentation|POD2::DE::local::lib> contributed by
1077 Torsten Raudssus <torsten@raudssus.de>.
1079 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
1080 things will install properly, submitted a fix for the bug causing problems with
1081 writing Makefiles during bootstrapping, contributed an example program, and
1082 submitted yet another fix to ensure that local::lib can install and bootstrap
1083 properly. Many, many thanks!
1085 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
1086 section. Many thanks!
1088 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
1090 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
1091 by a patch from Marco Emilio Poleggi.
1093 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
1094 '--self-contained' option.
1096 Documentation patches to make win32 usage clearer by
1097 David Mertens <dcmertens.perl@gmail.com> (run4flat).
1099 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc
1100 patches contributed by Breno G. de Oliveira <garu@cpan.org>.
1102 Improvements to stacking multiple local::lib dirs and removing them from the
1103 environment later on contributed by Andrew Rodland <arodland@cpan.org>.
1105 Patch for Carp version mismatch contributed by Hakim Cassimally
1106 <osfameron@cpan.org>.
1110 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
1115 This is free software; you can redistribute it and/or modify it under
1116 the same terms as the Perl 5 programming language system itself.