X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=cbee5dae405825877e12029649da82e89ab7df0a;hb=adf315c350d17e2f931cec03be3f93d708056b63;hp=d1d2f66e2719ca65e7c5e15158604f9d20f958b0;hpb=898f36cf124d4d8a3e17ce1f7db773f41ab84618;p=p5sagit%2Flocal-lib.git diff --git a/lib/local/lib.pm b/lib/local/lib.pm index d1d2f66..cbee5da 100755 --- a/lib/local/lib.pm +++ b/lib/local/lib.pm @@ -11,7 +11,7 @@ use File::Path (); use Carp (); use Config; -our $VERSION = '1.006001'; # 1.6.1 +our $VERSION = '1.006007'; # 1.6.7 our @KNOWN_FLAGS = qw(--self-contained); @@ -369,8 +369,6 @@ ok(-f 't/var/splat/.modulebuildrc'); local::lib - create and use a local lib/ for perl modules with PERL5LIB -L - =head1 SYNOPSIS In code - @@ -407,6 +405,8 @@ environment variables, as discussed in step 4. Without this, you would still install the modules into the system CPAN installation and also your Perl scripts will not use the lib/ path you bootstrapped with local::lib. +By default local::lib installs itself and the CPAN modules into ~/perl5. + Windows users must also see L. 1. Download and unpack the local::lib tarball from CPAN (search for "Download" @@ -421,8 +421,8 @@ convenient location. If the system asks you whether it should automatically configure as much as possible, you would typically answer yes. -In order to install local::lib into a directory other than default, you need -to give that directory on the call of bootstrap like this: +In order to install local::lib into a directory other than the default, you need +to specify the name of the directory when you call bootstrap, as follows: perl Makefile.PL --bootstrap=~/foo @@ -508,7 +508,7 @@ Control Panel's System applet yourself or use L. 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" -(Windows Vista or later) unless $ENV{HOME} exists. After that, the home +(Windows Vista or later)) unless $ENV{HOME} exists. After that, the home directory is translated to a short name (which means the directory must exist) and the subdirectories are created. @@ -570,17 +570,19 @@ These values are then available for reference by any code after import. =head1 CREATING A SELF-CONTAINED SET OF MODULES -See L for one way to do this - but note that +See L 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 +=head2 ensure_dir_structure_for =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back @@ -591,29 +593,48 @@ an exception on failure. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back Prints to standard output the variables listed above, properly set to use the given path as the base directory. +=head2 build_environment_vars_for + +=over 4 + +=item Arguments: $path, $interpolate + +=item Return value: \%environment_vars + +=back + +Returns a hash with the variables listed above, properly set to use the +given path as the base directory. + =head2 setup_env_hash_for =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back Constructs the C<%ENV> keys for the given path, by calling -C. +L. =head2 install_base_perl_path =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_perl_path =back @@ -625,7 +646,9 @@ path. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_arch_path =back @@ -638,7 +661,9 @@ C<$Config{archname}>. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_bin_path =back @@ -650,7 +675,9 @@ return value, and appends the directory C. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $modulebuildrc_path =back @@ -661,7 +688,9 @@ the given path. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $base_path =back @@ -672,7 +701,9 @@ installation. Defaults to C<~/perl5>. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $home_path =back @@ -683,7 +714,9 @@ for this purpose. If no definite answer is available, throws an exception. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $absolute_path =back @@ -693,7 +726,9 @@ Translates the given path into an absolute path. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $absolute_path =back @@ -718,6 +753,12 @@ install UNINST=1" and local::lib if you understand these possible consequences. =head1 LIMITATIONS +The perl toolchain is unable to handle directory names with spaces in it, +so you cant put your local::lib bootstrap into a directory with spaces. What +you can do is moving your local::lib to a directory with spaces B you +installed all modules inside your local::lib bootstrap. But be aware that you +cant update or install CPAN modules after the move. + Rather basic shell detection. Right now anything with csh in its name is assumed to be a C shell or something compatible, and everything else is assumed to be Bourne, except on Win32 systems. If the C environment variable is @@ -766,6 +807,12 @@ On Win32 systems, C is also examined. =back +=head1 SUPPORT + +IRC: + + Join #local-lib on irc.perl.org. + =head1 AUTHOR Matt S Trout http://www.shadowcat.co.uk/ @@ -777,7 +824,8 @@ auto_install fixes kindly sponsored by http://www.takkle.com/ Patches to correctly output commands for csh style shells, as well as some documentation additions, contributed by Christopher Nehren . -Doc patches for a custom local::lib directory contributed by Torsten Raudssus +Doc patches for a custom local::lib directory, more cleanups in the english +documentation and a L contributed by Torsten Raudssus . Hans Dieter Pearcey sent in some additional tests for ensuring @@ -800,9 +848,12 @@ Mark Stosberg provided the code for the now deleted Documentation patches to make win32 usage clearer by David Mertens (run4flat). +Brazilian L and minor doc patches contributed by Breno +G. de Oliveira . + =head1 COPYRIGHT -Copyright (c) 2007 - 2009 the local::lib L and L as +Copyright (c) 2007 - 2010 the local::lib L and L as listed above. =head1 LICENSE