use Carp ();
use Config;
-our $VERSION = '1.004004'; # 1.4.4
+our $VERSION = '1.006001'; # 1.6.1
+
+our @KNOWN_FLAGS = qw(--self-contained);
sub import {
my ($class, @args) = @_;
# Remember what PERL5LIB was when we started
- my $perl5lib = $ENV{PERL5LIB};
-
- # The path is required, but last in the list, so we pop, not shift here.
- my $path = pop @args;
- $path = $class->resolve_path($path);
- $class->setup_local_lib_for($path);
-
- # Handle the '--self-contained' option
- my $flag = shift @args;
- no warnings 'uninitialized'; # the flag is optional
- # make sure fancy dashes cause an error
- if ($flag =~ /−/) {
+ my $perl5lib = $ENV{PERL5LIB} || '';
+
+ my %arg_store;
+ for my $arg (@args) {
+ # check for lethal dash first to stop processing before causing problems
+ if ($arg =~ /−/) {
die <<'DEATH';
WHOA THERE! It looks like you've got some fancy dashes in your commandline!
These are *not* the traditional -- dashes that software recognizes. You
terminal, but can happen elsewhere too. Please try again after replacing the
dashes with normal minus signs.
DEATH
+ }
+ elsif(grep { $arg eq $_ } @KNOWN_FLAGS) {
+ (my $flag = $arg) =~ s/--//;
+ $arg_store{$flag} = 1;
+ }
+ elsif($arg =~ /^--/) {
+ die "Unknown import argument: $arg";
+ }
+ else {
+ # assume that what's left is a path
+ $arg_store{path} = $arg;
+ }
}
- if ($flag eq '--self-contained') {
- # The only directories that remain are those that we just defined and those where core modules are stored.
- # We put PERL5LIB first, so it'll be favored over privlibexp and archlibexp
- my %seen;
- @INC = grep { ! $seen{$_}++ } (
- $class->install_base_perl_path($path),
- $class->install_base_arch_path($path),
- split( $Config{path_sep}, $perl5lib ),
- $Config::Config{privlibexp},
- $Config::Config{archlibexp}
- );
-
- # We explicitly set PERL5LIB here to the above de-duped list to prevent
- # @INC from growing with each invocation
- $ENV{PERL5LIB} = join( $Config{path_sep}, @INC );
- }
- elsif (defined $flag) {
- die "unrecognized import argument: $flag";
+
+ if($arg_store{'self-contained'}) {
+ 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";
}
+ $arg_store{path} = $class->resolve_path($arg_store{path});
+ $class->setup_local_lib_for($arg_store{path});
+
for (@INC) { # Untaint @INC
next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc.
m/(.*)/ and $_ = $1;
=cut
+sub _uniq {
+ my %seen;
+ grep { ! $seen{$_}++ } @_;
+}
+
sub resolve_path {
my ($class, $path) = @_;
$class->${pipeline qw(
exit 0;
} else {
$class->setup_env_hash_for($path);
- unshift(@INC, split($Config{path_sep}, $ENV{PERL5LIB}));
+ @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC);
}
}
MODULEBUILDRC => $class->modulebuildrc_path($path),
PERL_MM_OPT => "INSTALL_BASE=${path}",
PERL5LIB => join($Config{path_sep},
- $class->install_base_perl_path($path),
$class->install_base_arch_path($path),
- ($ENV{PERL5LIB} ?
+ $class->install_base_perl_path($path),
+ (($ENV{PERL5LIB}||()) ?
($interpolate == INTERPOLATE_ENV
? ($ENV{PERL5LIB})
: (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' ))
PATH => join($Config{path_sep},
$class->install_base_bin_path($path),
($interpolate == INTERPOLATE_ENV
- ? $ENV{PATH}
+ ? ($ENV{PATH}||())
: (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' ))
),
)
From the shell -
- # Install LWP and it's missing dependencies to the 'my_lwp' directory
- perl -MCPAN -Mlocal::lib=my_lwp -e 'CPAN::install(LWP)'
-
- # Install LWP and *all non-core* dependencies to the 'my_lwp' directory
- perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)'
+ # Install LWP and its missing dependencies to the '~/perl5' directory
+ perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
# Just print out useful shell commands
$ perl -Mlocal::lib
export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux'
export PATH="/home/username/perl/bin:$PATH"
-To bootstrap if you don't have local::lib itself installed -
+=head2 The bootstrapping technique
+
+A typical way to install local::lib is using what is known as the
+"bootstrapping" technique. You would do this if your system administrator
+hasn't already installed local::lib. In this case, you'll need to install
+local::lib in your home directory. If you do have administrative priveleges,
+you will still want to set up your environment variables, as discussed in
+step 4 (and for Windows users, see L</Differences when using this module under Win32>).
+
+1. Download and unpack the local::lib tarball from CPAN (search for "Download"
+on the CPAN page about local::lib). Do this as an ordinary user, not as root
+or administrator. Unpack the file in your home directory or in any other
+convenient location.
+
+2. Run this:
+
+ perl Makefile.PL --bootstrap
- <download local::lib tarball from CPAN, unpack and cd into dir>
+If the system asks you whether it should automatically configure as much
+as possible, you would typically answer yes.
- $ perl Makefile.PL --bootstrap
- $ make test && make install
+3. Run this:
- $ echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
+ make test && make install
- # Or for C shells...
+4. Arrange for Perl to use your own packages instead of the system
+packages. If you are using bash, you can do this as follows:
- $ /bin/csh
- % echo $SHELL
+ echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
+
+If you are using C shell, you can do this as follows:
+
+ /bin/csh
+ echo $SHELL
/bin/csh
- % perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
+ perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
You can also pass --bootstrap=~/foo to get a different location -
- $ perl Makefile.PL --bootstrap=~/foo
- $ make test && make install
+ perl Makefile.PL --bootstrap=~/foo
+ make test && make install
- $ echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
+ echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
-If you want to install multiple Perl module environments, say for application evelopment,
-install local::lib globally and then:
+After writing your shell configuration file, be sure to re-read it to get the
+changed settings into your current shell's environment. Bourne shells use C<.
+~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>. Replace .bashrc or
+.cshrc with the name of the file you wrote above with the echo command.
+
+If you're on a slower machine, or are operating under draconian disk space
+limitations, you can disable the automatic generation of manpages from POD when
+installing modules by using the C<--no-manpages> argument when bootstrapping:
- $ cd ~/mydir1
- $ perl -Mlocal::lib=./
- $ eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
- $ printenv ### You will see that ~/mydir1 is in the PERL5LIB
- $ perl -MCPAN -e install ... ### whatever modules you want
- $ cd ../mydir2
- ... REPEAT ...
+ perl Makefile.PL --bootstrap --no-manpages
-For multiple environments for multiple apps you may need to include a modified version of
-the C<< use FindBin >> instructions in the "In code" sample above. If you did something like
-the above, you have a set of Perl modules at C<< ~/mydir1/lib >>. If you have a script at
-C<< ~/mydir1/scripts/myscript.pl >>, you need to tell it where to find the modules you installed
-for it at C<< ~/mydir1/lib >>.
+If you want to install multiple Perl module environments, say for application development,
+install local::lib globally and then:
+
+ cd ~/mydir1
+ perl -Mlocal::lib=./
+ eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
+ printenv ### You will see that ~/mydir1 is in the PERL5LIB
+ perl -MCPAN -e install ... ### whatever modules you want
+ cd ../mydir2
+ ... REPEAT ...
+
+For multiple environments for multiple apps you may need to include a modified
+version of the C<< use FindBin >> instructions in the "In code" sample above.
+If you did something like the above, you have a set of Perl modules at C<<
+~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
+you need to tell it where to find the modules you installed for it at C<<
+~/mydir1/lib >>.
In C<< ~/mydir1/scripts/myscript.pl >>:
- use strict;
- use warnings;
- use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
- use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
+ use strict;
+ use warnings;
+ use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
+ use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
Put this before any BEGIN { ... } blocks that require the modules you installed.
=head2 Differences when using this module under Win32
- C:\>perl -Mlocal::lib
- set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc
- set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
- set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
- set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
+To set up the proper environment variables for your current session of
+C<CMD.exe>, you can use this:
- ### To set the environment for this shell alone
- C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
- ### instead of $(perl -Mlocal::lib=./)
+ C:\>perl -Mlocal::lib
+ set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc
+ set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
+ set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
+ set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
+
+ ### To set the environment for this shell alone
+ C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
+ ### instead of $(perl -Mlocal::lib=./)
If you want the environment entries to persist, you'll need to add then to the
-Control Panel's System applet yourself at the moment.
+Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
The "~" is translated to the user's profile directory (the directory named for
the user under "Documents and Settings" (Windows XP or earlier) or "Users"
directory is translated to a short name (which means the directory must exist)
and the subdirectories are created.
+=head1 RATIONALE
+
+The version of a Perl package on your machine is not always the version you
+need. Obviously, the best thing to do would be to update to the version you
+need. However, you might be in a situation where you're prevented from doing
+this. Perhaps you don't have system administrator privileges; or perhaps you
+are using a package management system such as Debian, and nobody has yet gotten
+around to packaging up the version you need.
+
+local::lib solves this problem by allowing you to create your own directory of
+Perl packages downloaded from CPAN (in a multi-user system, this would typically
+be within your own home directory). The existing system Perl installation is
+not affected; you simply invoke Perl with special options so that Perl uses the
+packages in your own local package directory rather than the system packages.
+local::lib arranges things so that your locally installed version of the Perl
+packages takes precedence over the system installation.
+
+If you are using a package management system (such as Debian), you don't need to
+worry about Debian and CPAN stepping on each other's toes. Your local version
+of the packages will be written to an entirely separate directory from those
+installed by Debian.
+
=head1 DESCRIPTION
This module provides a quick, convenient way of bootstrapping a user-local Perl
module library located within the user's home directory. It also constructs and
prints out for the user the list of environment variables using the syntax
appropriate for the user's current shell (as specified by the C<SHELL>
-environment variable), suitable for directly adding to one's shell configuration
-file.
+environment variable), suitable for directly adding to one's shell
+configuration file.
-More generally, local::lib allows for the bootstrapping and usage of a directory
-containing Perl modules outside of Perl's C<@INC>. This makes it easier to ship
-an application with an app-specific copy of a Perl module, or collection of
-modules. Useful in cases like when an upstream maintainer hasn't applied a patch
-to a module of theirs that you need for your application.
+More generally, local::lib allows for the bootstrapping and usage of a
+directory containing Perl modules outside of Perl's C<@INC>. This makes it
+easier to ship an application with an app-specific copy of a Perl module, or
+collection of modules. Useful in cases like when an upstream maintainer hasn't
+applied a patch to a module of theirs that you need for your application.
On import, local::lib sets the following environment variables to appropriate
values:
These values are then available for reference by any code after import.
+=head1 CREATING A SELF-CONTAINED SET OF MODULES
+
+See L<lib::core::only|lib::core::only> for one way to do this - but note that
+there are a number of caveats, and the best approach is always to perform a
+build against a clean perl (i.e. site and vendor as close to empty as possible).
+
=head1 METHODS
=head2 ensure_directory_structure_for
Patches to correctly output commands for csh style shells, as well as some
documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
-'--self-contained' feature contributed by Mark Stosberg <mark@summersault.com>.
-
Doc patches for a custom local::lib directory contributed by Torsten Raudssus
<torsten@raudssus.de>.
Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
+Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
+by a patch from Marco Emilio Poleggi.
+
+Mark Stosberg <mark@summersault.com> provided the code for the now deleted
+'--self-contained' option.
+
+Documentation patches to make win32 usage clearer by
+David Mertens <dcmertens.perl@gmail.com> (run4flat).
+
+=head1 COPYRIGHT
+
+Copyright (c) 2007 - 2009 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
+listed above.
+
=head1 LICENSE
-This library is free software under the same license as perl itself.
+This library is free software and may be distributed under the same terms
+as perl itself.
=cut
projects / p5sagit/local-lib.git / blobdiff