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