lib/local/lib.pm

   1 use strict;
   2 use warnings;
   3
   4 package local::lib;
   5
   6 use 5.008001; # probably works with earlier versions but I'm not supporting them
   7               # (patches would, of course, be welcome)
   8
   9 use File::Spec ();
  10 use File::Path ();
  11 use Carp ();
  12 use Config;
  13
  14 our $VERSION = '1.005001'; # 1.5.1
  15
  16 our @KNOWN_FLAGS = qw(--self-contained);
  17
  18 sub import {
  19   my ($class, @args) = @_;
  20
  21   # Remember what PERL5LIB was when we started
  22   my $perl5lib = $ENV{PERL5LIB} || '';
  23
  24   my %arg_store;
  25   for my $arg (@args) {
  26     # check for lethal dash first to stop processing before causing problems
  27     if ($arg =~ /−/) {
  28       die <<'DEATH';
  29 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
  30 These are *not* the traditional -- dashes that software recognizes. You
  31 probably got these by copy-pasting from the perldoc for this module as
  32 rendered by a UTF8-capable formatter. This most typically happens on an OS X
  33 terminal, but can happen elsewhere too. Please try again after replacing the
  34 dashes with normal minus signs.
  35 DEATH
  36     }
  37     elsif(grep { $arg eq $_ } @KNOWN_FLAGS) {
  38       (my $flag = $arg) =~ s/--//;
  39       $arg_store{$flag} = 1;
  40     }
  41     elsif($arg =~ /^--/) {
  42       die "Unknown import argument: $arg";
  43     }
  44     else {
  45       # assume that what's left is a path
  46       $arg_store{path} = $arg;
  47     }
  48   }
  49
  50   if($arg_store{'self-contained'}) {
  51     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";
  52   }
  53
  54   $arg_store{path} = $class->resolve_path($arg_store{path});
  55   $class->setup_local_lib_for($arg_store{path});
  56
  57   for (@INC) { # Untaint @INC
  58     next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc.
  59     m/(.*)/ and $_ = $1;
  60   }
  61 }
  62
  63 sub pipeline;
  64
  65 sub pipeline {
  66   my @methods = @_;
  67   my $last = pop(@methods);
  68   if (@methods) {
  69     \sub {
  70       my ($obj, @args) = @_;
  71       $obj->${pipeline @methods}(
  72         $obj->$last(@args)
  73       );
  74     };
  75   } else {
  76     \sub {
  77       shift->$last(@_);
  78     };
  79   }
  80 }
  81
  82 =begin testing
  83
  84 #:: test pipeline
  85
  86 package local::lib;
  87
  88 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
  89 my $foo = bless({}, 'Foo');
  90 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
  91
  92 =end testing
  93
  94 =cut
  95
  96 sub _uniq {
  97     my %seen;
  98     grep { ! $seen{$_}++ } @_;
  99 }
 100
 101 sub resolve_path {
 102   my ($class, $path) = @_;
 103   $class->${pipeline qw(
 104     resolve_relative_path
 105     resolve_home_path
 106     resolve_empty_path
 107   )}($path);
 108 }
 109
 110 sub resolve_empty_path {
 111   my ($class, $path) = @_;
 112   if (defined $path) {
 113     $path;
 114   } else {
 115     '~/perl5';
 116   }
 117 }
 118
 119 =begin testing
 120
 121 #:: test classmethod setup
 122
 123 my $c = 'local::lib';
 124
 125 =end testing
 126
 127 =begin testing
 128
 129 #:: test classmethod
 130
 131 is($c->resolve_empty_path, '~/perl5');
 132 is($c->resolve_empty_path('foo'), 'foo');
 133
 134 =end testing
 135
 136 =cut
 137
 138 sub resolve_home_path {
 139   my ($class, $path) = @_;
 140   return $path unless ($path =~ /^~/);
 141   my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
 142   my $tried_file_homedir;
 143   my $homedir = do {
 144     if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) {
 145       $tried_file_homedir = 1;
 146       if (defined $user) {
 147         File::HomeDir->users_home($user);
 148       } else {
 149         File::HomeDir->my_home;
 150       }
 151     } else {
 152       if (defined $user) {
 153         (getpwnam $user)[7];
 154       } else {
 155         if (defined $ENV{HOME}) {
 156           $ENV{HOME};
 157         } else {
 158           (getpwuid $<)[7];
 159         }
 160       }
 161     }
 162   };
 163   unless (defined $homedir) {
 164     Carp::croak(
 165       "Couldn't resolve homedir for "
 166       .(defined $user ? $user : 'current user')
 167       .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
 168     );
 169   }
 170   $path =~ s/^~[^\/]*/$homedir/;
 171   $path;
 172 }
 173
 174 sub resolve_relative_path {
 175   my ($class, $path) = @_;
 176   $path = File::Spec->rel2abs($path);
 177 }
 178
 179 =begin testing
 180
 181 #:: test classmethod
 182
 183 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
 184 is($c->resolve_relative_path('bar'),'FOObar');
 185
 186 =end testing
 187
 188 =cut
 189
 190 sub setup_local_lib_for {
 191   my ($class, $path) = @_;
 192   $path = $class->ensure_dir_structure_for($path);
 193   if ($0 eq '-') {
 194     $class->print_environment_vars_for($path);
 195     exit 0;
 196   } else {
 197     $class->setup_env_hash_for($path);
 198     @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC);
 199   }
 200 }
 201
 202 sub modulebuildrc_path {
 203   my ($class, $path) = @_;
 204   File::Spec->catfile($path, '.modulebuildrc');
 205 }
 206
 207 sub install_base_bin_path {
 208   my ($class, $path) = @_;
 209   File::Spec->catdir($path, 'bin');
 210 }
 211
 212 sub install_base_perl_path {
 213   my ($class, $path) = @_;
 214   File::Spec->catdir($path, 'lib', 'perl5');
 215 }
 216
 217 sub install_base_arch_path {
 218   my ($class, $path) = @_;
 219   File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
 220 }
 221
 222 sub ensure_dir_structure_for {
 223   my ($class, $path) = @_;
 224   unless (-d $path) {
 225     warn "Attempting to create directory ${path}\n";
 226   }
 227   File::Path::mkpath($path);
 228   # Need to have the path exist to make a short name for it, so
 229   # converting to a short name here.
 230   $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
 231   my $modulebuildrc_path = $class->modulebuildrc_path($path);
 232   if (-e $modulebuildrc_path) {
 233     unless (-f _) {
 234       Carp::croak("${modulebuildrc_path} exists but is not a plain file");
 235     }
 236   } else {
 237     warn "Attempting to create file ${modulebuildrc_path}\n";
 238     open MODULEBUILDRC, '>', $modulebuildrc_path
 239       || Carp::croak("Couldn't open ${modulebuildrc_path} for writing: $!");
 240     print MODULEBUILDRC qq{install  --install_base  ${path}\n}
 241       || Carp::croak("Couldn't write line to ${modulebuildrc_path}: $!");
 242     close MODULEBUILDRC
 243       || Carp::croak("Couldn't close file ${modulebuildrc_path}: $@");
 244   }
 245
 246   return $path;
 247 }
 248
 249 sub INTERPOLATE_ENV () { 1 }
 250 sub LITERAL_ENV     () { 0 }
 251
 252 sub print_environment_vars_for {
 253   my ($class, $path) = @_;
 254   my @envs = $class->build_environment_vars_for($path, LITERAL_ENV);
 255   my $out = '';
 256
 257   # rather basic csh detection, goes on the assumption that something won't
 258   # call itself csh unless it really is. also, default to bourne in the
 259   # pathological situation where a user doesn't have $ENV{SHELL} defined.
 260   # note also that shells with funny names, like zoid, are assumed to be
 261   # bourne.
 262   my $shellbin = 'sh';
 263   if(defined $ENV{'SHELL'}) {
 264       my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
 265       $shellbin = $shell_bin_path_parts[-1];
 266   }
 267   my $shelltype = do {
 268       local $_ = $shellbin;
 269       if(/csh/) {
 270           'csh'
 271       } else {
 272           'bourne'
 273       }
 274   };
 275
 276   # Both Win32 and Cygwin have $ENV{COMSPEC} set.
 277   if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
 278       my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
 279       $shellbin = $shell_bin_path_parts[-1];
 280          $shelltype = do {
 281                  local $_ = $shellbin;
 282                  if(/command\.com/) {
 283                          'win32'
 284                  } elsif(/cmd\.exe/) {
 285                          'win32'
 286                  } elsif(/4nt\.exe/) {
 287                          'win32'
 288                  } else {
 289                          $shelltype
 290                  }
 291          };
 292   }
 293
 294   while (@envs) {
 295     my ($name, $value) = (shift(@envs), shift(@envs));
 296     $value =~ s/(\\")/\\$1/g;
 297     $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
 298   }
 299   print $out;
 300 }
 301
 302 # simple routines that take two arguments: an %ENV key and a value. return
 303 # strings that are suitable for passing directly to the relevant shell to set
 304 # said key to said value.
 305 sub build_bourne_env_declaration {
 306   my $class = shift;
 307   my($name, $value) = @_;
 308   return qq{export ${name}="${value}"\n};
 309 }
 310
 311 sub build_csh_env_declaration {
 312   my $class = shift;
 313   my($name, $value) = @_;
 314   return qq{setenv ${name} "${value}"\n};
 315 }
 316
 317 sub build_win32_env_declaration {
 318   my $class = shift;
 319   my($name, $value) = @_;
 320   return qq{set ${name}=${value}\n};
 321 }
 322
 323 sub setup_env_hash_for {
 324   my ($class, $path) = @_;
 325   my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV);
 326   @ENV{keys %envs} = values %envs;
 327 }
 328
 329 sub build_environment_vars_for {
 330   my ($class, $path, $interpolate) = @_;
 331   return (
 332     MODULEBUILDRC => $class->modulebuildrc_path($path),
 333     PERL_MM_OPT => "INSTALL_BASE=${path}",
 334     PERL5LIB => join($Config{path_sep},
 335                   $class->install_base_perl_path($path),
 336                   $class->install_base_arch_path($path),
 337                   (($ENV{PERL5LIB}||()) ?
 338                     ($interpolate == INTERPOLATE_ENV
 339                       ? ($ENV{PERL5LIB})
 340                       : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' ))
 341                     : ())
 342                 ),
 343     PATH => join($Config{path_sep},
 344               $class->install_base_bin_path($path),
 345               ($interpolate == INTERPOLATE_ENV
 346                 ? ($ENV{PATH}||())
 347                 : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' ))
 348              ),
 349   )
 350 }
 351
 352 =begin testing
 353
 354 #:: test classmethod
 355
 356 File::Path::rmtree('t/var/splat');
 357
 358 $c->ensure_dir_structure_for('t/var/splat');
 359
 360 ok(-d 't/var/splat');
 361
 362 ok(-f 't/var/splat/.modulebuildrc');
 363
 364 =end testing
 365
 366 =head1 NAME
 367
 368 local::lib - create and use a local lib/ for perl modules with PERL5LIB
 369
 370 =head1 SYNOPSIS
 371
 372 In code -
 373
 374   use local::lib; # sets up a local lib at ~/perl5
 375
 376   use local::lib '~/foo'; # same, but ~/foo
 377
 378   # Or...
 379   use FindBin;
 380   use local::lib "$FindBin::Bin/../support";  # app-local support library
 381
 382 From the shell -
 383
 384   # Install LWP and its missing dependencies to the '~/perl5' directory
 385   perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
 386
 387   # Install LWP and *all non-core* dependencies to the 'my_lwp' directory
 388   perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)'
 389
 390   # Just print out useful shell commands
 391   $ perl -Mlocal::lib
 392   export MODULEBUILDRC=/home/username/perl/.modulebuildrc
 393   export PERL_MM_OPT='INSTALL_BASE=/home/username/perl'
 394   export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux'
 395   export PATH="/home/username/perl/bin:$PATH"
 396
 397 =head2 The bootstrapping technique
 398
 399 A typical way to install local::lib is using what is known as the
 400 "bootstrapping" technique.  You would do this if your system administrator
 401 hasn't already installed local::lib.  In this case, you'll need to install
 402 local::lib in your home directory.
 403
 404 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
 405 on the CPAN page about local::lib).  Do this as an ordinary user, not as root
 406 or administrator.  Unpack the file in your home directory or in any other
 407 convenient location.
 408
 409 2. Run this:
 410
 411   perl Makefile.PL --bootstrap
 412
 413 If the system asks you whether it should automatically configure as much
 414 as possible, you would typically answer yes.
 415
 416 3. Run this:
 417
 418   make test && make install
 419
 420 4. Arrange for Perl to use your own packages instead of the system
 421 packages.  If you are using bash, you can do this as follows:
 422
 423   echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
 424
 425 If you are using C shell, you can do this as follows:
 426
 427   /bin/csh
 428   echo $SHELL
 429   /bin/csh
 430   perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
 431
 432 You can also pass --bootstrap=~/foo to get a different location -
 433
 434   perl Makefile.PL --bootstrap=~/foo
 435   make test && make install
 436
 437   echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
 438
 439 After writing your shell configuration file, be sure to re-read it to get the
 440 changed settings into your current shell's environment. Bourne shells use C<.
 441 ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>. Replace .bashrc or
 442 .cshrc with the name of the file you wrote above with the echo command.
 443
 444 If you're on a slower machine, or are operating under draconian disk space
 445 limitations, you can disable the automatic generation of manpages from POD when
 446 installing modules by using the C<--no-manpages> argument when bootstrapping:
 447
 448   perl Makefile.PL --bootstrap --no-manpages
 449
 450 If you want to install multiple Perl module environments, say for application development,
 451 install local::lib globally and then:
 452
 453   cd ~/mydir1
 454   perl -Mlocal::lib=./
 455   eval $(perl -Mlocal::lib=./)  ### To set the environment for this shell alone
 456   printenv  ### You will see that ~/mydir1 is in the PERL5LIB
 457   perl -MCPAN -e install ...    ### whatever modules you want
 458   cd ../mydir2
 459   ... REPEAT ...
 460
 461 For multiple environments for multiple apps you may need to include a modified
 462 version of the C<< use FindBin >> instructions in the "In code" sample above.
 463 If you did something like the above, you have a set of Perl modules at C<<
 464 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
 465 you need to tell it where to find the modules you installed for it at C<<
 466 ~/mydir1/lib >>.
 467
 468 In C<< ~/mydir1/scripts/myscript.pl >>:
 469
 470   use strict;
 471   use warnings;
 472   use local::lib "$FindBin::Bin/..";  ### points to ~/mydir1 and local::lib finds lib
 473   use lib "$FindBin::Bin/../lib";     ### points to ~/mydir1/lib
 474
 475 Put this before any BEGIN { ... } blocks that require the modules you installed.
 476
 477 =head2 Differences when using this module under Win32
 478
 479   C:\>perl -Mlocal::lib
 480   set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc
 481   set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
 482   set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
 483   set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
 484
 485     ### To set the environment for this shell alone
 486   C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
 487   ### instead of $(perl -Mlocal::lib=./)
 488
 489 If you want the environment entries to persist, you'll need to add then to the
 490 Control Panel's System applet yourself at the moment.
 491
 492 The "~" is translated to the user's profile directory (the directory named for
 493 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
 494 (Windows Vista or later) unless $ENV{HOME} exists. After that, the home
 495 directory is translated to a short name (which means the directory must exist)
 496 and the subdirectories are created.
 497
 498 =head1 RATIONALE
 499
 500 The version of a Perl package on your machine is not always the version you
 501 need.  Obviously, the best thing to do would be to update to the version you
 502 need.  However, you might be in a situation where you're prevented from doing
 503 this.  Perhaps you don't have system administrator privileges; or perhaps you
 504 are using a package management system such as Debian, and nobody has yet gotten
 505 around to packaging up the version you need.
 506
 507 local::lib solves this problem by allowing you to create your own directory of
 508 Perl packages downloaded from CPAN (in a multi-user system, this would typically
 509 be within your own home directory).  The existing system Perl installation is
 510 not affected; you simply invoke Perl with special options so that Perl uses the
 511 packages in your own local package directory rather than the system packages.
 512 local::lib arranges things so that your locally installed version of the Perl
 513 packages takes precedence over the system installation.
 514
 515 If you are using a package management system (such as Debian), you don't need to
 516 worry about Debian and CPAN stepping on each other's toes.  Your local version
 517 of the packages will be written to an entirely separate directory from those
 518 installed by Debian.
 519
 520 =head1 DESCRIPTION
 521
 522 This module provides a quick, convenient way of bootstrapping a user-local Perl
 523 module library located within the user's home directory. It also constructs and
 524 prints out for the user the list of environment variables using the syntax
 525 appropriate for the user's current shell (as specified by the C<SHELL>
 526 environment variable), suitable for directly adding to one's shell
 527 configuration file.
 528
 529 More generally, local::lib allows for the bootstrapping and usage of a
 530 directory containing Perl modules outside of Perl's C<@INC>. This makes it
 531 easier to ship an application with an app-specific copy of a Perl module, or
 532 collection of modules. Useful in cases like when an upstream maintainer hasn't
 533 applied a patch to a module of theirs that you need for your application.
 534
 535 On import, local::lib sets the following environment variables to appropriate
 536 values:
 537
 538 =over 4
 539
 540 =item MODULEBUILDRC
 541
 542 =item PERL_MM_OPT
 543
 544 =item PERL5LIB
 545
 546 =item PATH
 547
 548 PATH is appended to, rather than clobbered.
 549
 550 =back
 551
 552 These values are then available for reference by any code after import.
 553
 554 =head1 CREATING A SELF-CONTAINED SET OF MODULES
 555
 556 You can use local::lib to prepare a directory which contains a module and all
 557 of its non-core dependencies.  The C<--self-contained> option ignores any
 558 globally installed modules when resolving dependencies, only considering
 559 modules installed in a "local::lib" directory or provided by core Perl.
 560
 561 A use-case for this feature would be to prepare to deploy a whole "stack" of
 562 module dependencies on a new machine, even if you have copies of the same
 563 dependencies installed globally already.
 564
 565 The C<--self-contained> option should be used like this:
 566
 567   # Install LWP and *all non-core* dependencies to the 'my_lwp' directory
 568   perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)'
 569
 570 Note that some dependencies may involve C-based "XS" code even if your target
 571 module doesn't. The issue of dealing with XS vs Pure Perl code is beyond the scope
 572 of what local::lib provides.
 573
 574 =head1 METHODS
 575
 576 =head2 ensure_directory_structure_for
 577
 578 =over 4
 579
 580 =item Arguments: path
 581
 582 =back
 583
 584 Attempts to create the given path, and all required parent directories. Throws
 585 an exception on failure.
 586
 587 =head2 print_environment_vars_for
 588
 589 =over 4
 590
 591 =item Arguments: path
 592
 593 =back
 594
 595 Prints to standard output the variables listed above, properly set to use the
 596 given path as the base directory.
 597
 598 =head2 setup_env_hash_for
 599
 600 =over 4
 601
 602 =item Arguments: path
 603
 604 =back
 605
 606 Constructs the C<%ENV> keys for the given path, by calling
 607 C<build_environment_vars_for>.
 608
 609 =head2 install_base_perl_path
 610
 611 =over 4
 612
 613 =item Arguments: path
 614
 615 =back
 616
 617 Returns a path describing where to install the Perl modules for this local
 618 library installation. Appends the directories C<lib> and C<perl5> to the given
 619 path.
 620
 621 =head2 install_base_arch_path
 622
 623 =over 4
 624
 625 =item Arguments: path
 626
 627 =back
 628
 629 Returns a path describing where to install the architecture-specific Perl
 630 modules for this local library installation. Based on the
 631 L</install_base_perl_path> method's return value, and appends the value of
 632 C<$Config{archname}>.
 633
 634 =head2 install_base_bin_path
 635
 636 =over 4
 637
 638 =item Arguments: path
 639
 640 =back
 641
 642 Returns a path describing where to install the executable programs for this
 643 local library installation. Based on the L</install_base_perl_path> method's
 644 return value, and appends the directory C<bin>.
 645
 646 =head2 modulebuildrc_path
 647
 648 =over 4
 649
 650 =item Arguments: path
 651
 652 =back
 653
 654 Returns a path describing where to install the C<.modulebuildrc> file, based on
 655 the given path.
 656
 657 =head2 resolve_empty_path
 658
 659 =over 4
 660
 661 =item Arguments: path
 662
 663 =back
 664
 665 Builds and returns the base path into which to set up the local module
 666 installation. Defaults to C<~/perl5>.
 667
 668 =head2 resolve_home_path
 669
 670 =over 4
 671
 672 =item Arguments: path
 673
 674 =back
 675
 676 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
 677 for this purpose. If no definite answer is available, throws an exception.
 678
 679 =head2 resolve_relative_path
 680
 681 =over 4
 682
 683 =item Arguments: path
 684
 685 =back
 686
 687 Translates the given path into an absolute path.
 688
 689 =head2 resolve_path
 690
 691 =over 4
 692
 693 =item Arguments: path
 694
 695 =back
 696
 697 Calls the following in a pipeline, passing the result from the previous to the
 698 next, in an attempt to find where to configure the environment for a local
 699 library installation: L</resolve_empty_path>, L</resolve_home_path>,
 700 L</resolve_relative_path>. Passes the given path argument to
 701 L</resolve_empty_path> which then returns a result that is passed to
 702 L</resolve_home_path>, which then has its result passed to
 703 L</resolve_relative_path>. The result of this final call is returned from
 704 L</resolve_path>.
 705
 706 =head1 A WARNING ABOUT UNINST=1
 707
 708 Be careful about using local::lib in combination with "make install UNINST=1".
 709 The idea of this feature is that will uninstall an old version of a module
 710 before installing a new one. However it lacks a safety check that the old
 711 version and the new version will go in the same directory. Used in combination
 712 with local::lib, you can potentially delete a globally accessible version of a
 713 module while installing the new version in a local place. Only combine "make
 714 install UNINST=1" and local::lib if you understand these possible consequences.
 715
 716 =head1 LIMITATIONS
 717
 718 Rather basic shell detection. Right now anything with csh in its name is
 719 assumed to be a C shell or something compatible, and everything else is assumed
 720 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
 721 not set, a Bourne-compatible shell is assumed.
 722
 723 Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
 724 have CPANPLUS installed.
 725
 726 Kills any existing PERL5LIB, PERL_MM_OPT or MODULEBUILDRC.
 727
 728 Should probably auto-fixup CPAN config if not already done.
 729
 730 Patches very much welcome for any of the above.
 731
 732 On Win32 systems, does not have a way to write the created environment variables
 733 to the registry, so that they can persist through a reboot.
 734
 735 =head1 TROUBLESHOOTING
 736
 737 If you've configured local::lib to install CPAN modules somewhere in to your
 738 home directory, and at some point later you try to install a module with C<cpan
 739 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
 740 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
 741 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
 742 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
 743 you've somehow lost your updated ExtUtils::MakeMaker module.
 744
 745 To remedy this situation, rerun the bootstrapping procedure documented above.
 746
 747 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
 748
 749 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
 750
 751 =head1 ENVIRONMENT
 752
 753 =over 4
 754
 755 =item SHELL
 756
 757 =item COMSPEC
 758
 759 local::lib looks at the user's C<SHELL> environment variable when printing out
 760 commands to add to the shell configuration file.
 761
 762 On Win32 systems, C<COMSPEC> is also examined.
 763
 764 =back
 765
 766 =head1 AUTHOR
 767
 768 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
 769
 770 auto_install fixes kindly sponsored by http://www.takkle.com/
 771
 772 =head1 CONTRIBUTORS
 773
 774 Patches to correctly output commands for csh style shells, as well as some
 775 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
 776
 777 Doc patches for a custom local::lib directory contributed by Torsten Raudssus
 778 <torsten@raudssus.de>.
 779
 780 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
 781 things will install properly, submitted a fix for the bug causing problems with
 782 writing Makefiles during bootstrapping, contributed an example program, and
 783 submitted yet another fix to ensure that local::lib can install and bootstrap
 784 properly. Many, many thanks!
 785
 786 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
 787 section. Many thanks!
 788
 789 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
 790
 791 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
 792 by a patch from Marco Emilio Poleggi.
 793
 794 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
 795 '--self-contained' option.
 796
 797 =head1 COPYRIGHT
 798
 799 Copyright (c) 2007 - 2009 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
 800 listed above.
 801
 802 =head1 LICENSE
 803
 804 This library is free software and may be distributed under the same terms
 805 as perl itself.
 806
 807 =cut
 808
 809 1;