Seth Woolley's Man Viewer

ExtUtils::Install(3) - ExtUtils::Install - install files from here to there - man 3 ExtUtils::Install

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

ExtUtils::Install(3)   Perl Programmers Reference Guide   ExtUtils::Install(3)



NAME
       ExtUtils::Install - install files from here to there

SYNOPSIS
         use ExtUtils::Install;

         install({ 'blib/lib' => 'some/install/dir' } );

         uninstall($packlist);

         pm_to_blib({ 'lib/Foo/Bar.pm' => 'blib/lib/Foo/Bar.pm' });

DESCRIPTION
       Handles the installing and uninstalling of perl modules, scripts, man(1,5,7)
       pages, etc...

       Both install() and uninstall() are specific to the way ExtUtils::Make-
       Maker handles the installation and deinstallation of perl modules. They
       are not designed as general purpose tools.

       Functions


       install
               install(\%from_to);
               install(\%from_to, $verbose, $dont_execute, $uninstall_shadows);

           Copies each directory tree of %from_to to its corresponding value
           preserving timestamps and permissions.

           There are two keys with a special meaning in(1,8) the hash: "read(2,n,1 builtins)" and
           "write(1,2)".  These contain packlist files.  After the copying is done,
           install() will write(1,2) the list of target files to $from_to{write(1,2)}.
           If $from_to{read(2,n,1 builtins)} is given the contents of this file(1,n) will be merged
           into the written file. The read(2,n,1 builtins) and the written file(1,n) may be identi-
           cal, but on AFS it is quite likely that people are installing to a
           different directory than the one where the files later appear.

           If $verbose is true, will print out each file(1,n) removed.  Default is
           false.  This is "make install VERBINST=1"

           If $dont_execute is true it will only print what it was going to do
           without actually doing it.  Default is false.

           If $uninstall_shadows is true any differing versions throughout
           @INC will be uninstalled.  This is "make install UNINST=1"

       install_default DISCOURAGED
               install_default();
               install_default($fullext);

           Calls install() with arguments to copy a module from blib/ to the
           default site installation location.

           $fullext is the name of the module converted to a directory (ie.
           Foo::Bar would be Foo/Bar).  If $fullext is not specified, it will
           attempt to read(2,n,1 builtins) it from @ARGV.

           This is primarily useful for install scripts.

           NOTE This function is not really useful because of the hard-coded
           install location with no way to control site vs core vs vendor
           directories and the strange way in(1,8) which the module name is given.
           Consider its use discouraged.

       uninstall
               uninstall($packlist_file);
               uninstall($packlist_file, $verbose, $dont_execute);

           Removes the files listed in(1,8) a $packlist_file.

           If $verbose is true, will print out each file(1,n) removed.  Default is
           false.

           If $dont_execute is true it will only print what it was going to do
           without actually doing it.  Default is false.

       pm_to_blib
               pm_to_blib(\%from_to, $autosplit_dir);
               pm_to_blib(\%from_to, $autosplit_dir, $filter_cmd);

           Copies each key of %from_to to its corresponding value efficiently.
           Filenames with the extension .pm are autosplit into the
           $autosplit_dir.

           $filter_cmd is an optional shell command to run each .pm file(1,n)
           through prior to splitting and copying.  Input is the contents of
           the module, output the new module contents.

           You can have an environment variable PERL_INSTALL_ROOT set(7,n,1 builtins) which
           will be prepended as a directory to each installed file(1,n) (and direc-
           tory).

ENVIRONMENT
       PERL_INSTALL_ROOT
           Will be prepended to each install path.

AUTHOR
       Original author lost in(1,8) the mists of time.  Probably the same as Make-
       maker.

       Currently maintained by Michael G Schwern <schwern@pobox.com>

       Send patches and ideas to <makemaker@perl.org>.

       Send bug reports via http://rt.cpan.org/.  Please send(2,n) your generated
       Makefile along with your report.

       For more up-to-date information, see http://www.makemaker.org.

LICENSE
       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

       See http://www.perl.com/perl/misc/Artistic.html



perl v5.8.5                       2001-09-21              ExtUtils::Install(3)

References for this manual (incoming links)