lib(3pm) [redhat man page]

lib(3pm)						 Perl Programmers Reference Guide						  lib(3pm)

NAME

       lib - manipulate @INC at compile time

SYNOPSIS

	   use lib LIST;

	   no lib LIST;

DESCRIPTION

       This is a small simple module which simplifies the manipulation of @INC at compile time.

       It is typically used to add extra directories to perl's search path so that later "use" or "require" statements will find modules which are
       not located on perl's default search path.

       Adding directories to @INC

       The parameters to "use lib" are added to the start of the perl search path. Saying

	   use lib LIST;

       is almost the same as saying

	   BEGIN { unshift(@INC, LIST) }

       For each directory in LIST (called $dir here) the lib module also checks to see if a directory called $dir/$archname/auto exists.  If so
       the $dir/$archname directory is assumed to be a corresponding architecture specific directory and is added to @INC in front of $dir.

       To avoid memory leaks, all trailing duplicate entries in @INC are removed.

       Deleting directories from @INC

       You should normally only add directories to @INC.  If you need to delete directories from @INC take care to only delete those which you
       added yourself or which you are certain are not needed by other modules in your script.	Other modules may have added directories which
       they need for correct operation.

       The "no lib" statement deletes all instances of each named directory from @INC.

       For each directory in LIST (called $dir here) the lib module also checks to see if a directory called $dir/$archname/auto exists.  If so
       the $dir/$archname directory is assumed to be a corresponding architecture specific directory and is also deleted from @INC.

       Restoring original @INC

       When the lib module is first loaded it records the current value of @INC in an array @lib::ORIG_INC. To restore @INC to that value you can
       say

	   @INC = @lib::ORIG_INC;

CAVEATS

       In order to keep lib.pm small and simple, it only works with Unix filepaths.  This doesn't mean it only works on Unix, but non-Unix users
       must first translate their file paths to Unix conventions.

	   # VMS users wanting to put [.stuff.moo] into
	   # their @INC would write
	   use lib 'stuff/moo';

NOTES

       In the future, this module will likely use File::Spec for determining paths, as it does now for Mac OS (where Unix-style or Mac-style paths
       work, and Unix-style paths are converted properly to Mac-style paths before being added to @INC).

SEE ALSO

       FindBin - optional module which deals with paths relative to the source file.

AUTHOR

       Tim Bunce, 2nd June 1995.

perl v5.8.0							    2002-06-01								  lib(3pm)

Check Out this Related Man Page

FindBin(3pm)						 Perl Programmers Reference Guide					      FindBin(3pm)

NAME

       FindBin - Locate directory of original perl script

SYNOPSIS

	use FindBin;
	use lib "$FindBin::Bin/../lib";

	or

	use FindBin qw($Bin);
	use lib "$Bin/../lib";

DESCRIPTION

       Locates the full path to the script bin directory to allow the use of paths relative to the bin directory.

       This allows a user to setup a directory tree for some software with directories "<root>/bin" and "<root>/lib", and then the above example
       will allow the use of modules in the lib directory without knowing where the software tree is installed.

       If perl is invoked using the -e option or the perl script is read from "STDIN" then FindBin sets both $Bin and $RealBin to the current
       directory.

EXPORTABLE VARIABLES

	$Bin	     - path to bin directory from where script was invoked
	$Script      - basename of script from which perl was invoked
	$RealBin     - $Bin with all links resolved
	$RealScript  - $Script with all links resolved

KNOWN ISSUES

       If there are two modules using "FindBin" from different directories under the same interpreter, this won't work. Since "FindBin" uses a
       "BEGIN" block, it'll be executed only once, and only the first caller will get it right. This is a problem under mod_perl and other
       persistent Perl environments, where you shouldn't use this module. Which also means that you should avoid using "FindBin" in modules that
       you plan to put on CPAN. To make sure that "FindBin" will work is to call the "again" function:

	 use FindBin;
	 FindBin::again(); # or FindBin->again;

       In former versions of FindBin there was no "again" function. The workaround was to force the "BEGIN" block to be executed again:

	 delete $INC{'FindBin.pm'};
	 require FindBin;

AUTHORS

       FindBin is supported as part of the core perl distribution. Please send bug reports to <perlbug@perl.org> using the perlbug program
       included with perl.

       Graham Barr <gbarr@pobox.com> Nick Ing-Simmons <nik@tiuk.ti.com>

COPYRIGHT

       Copyright (c) 1995 Graham Barr & Nick Ing-Simmons. All rights reserved.	This program is free software; you can redistribute it and/or
       modify it under the same terms as Perl itself.

perl v5.18.2							    2013-11-04							      FindBin(3pm)

Linux and UNIX Man Pages

lib(3pm) [redhat man page]

Check Out this Related Man Page