MirBSD manpage: ExtUtils::Install(3p)

ExtUtils::InstallPerl Programmers Reference ExtUtils::Install(3p)

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 pages, etc...

     Both install() and uninstall() are specific to the way
     ExtUtils::MakeMaker handles the installation and deinstalla-
     tion of perl modules. They are not designed as general pur-
     pose 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 permis-
         sions.

         There are two keys with a special meaning in the hash:
         "read" and "write".  These contain packlist files.
         After the copying is done, install() will write the list
         of target files to $from_to{write}. If $from_to{read} is
         given the contents of this file will be merged into the
         written file. The read and the written file may be
         identical, 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 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"

perl v5.8.8                2005-02-05                           1

ExtUtils::InstallPerl Programmers Reference ExtUtils::Install(3p)

     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 direc-
         tory (ie. Foo::Bar would be Foo/Bar).  If $fullext is
         not specified, it will attempt to read 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
         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 a $packlist_file.

         If $verbose is true, will print out each file 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 autos-
         plit into the $autosplit_dir. Any destination direc-
         tories are created.

         $filter_cmd is an optional shell command to run each .pm
         file through prior to splitting and copying.  Input is
         the contents of the module, output the new module con-
         tents.

         You can have an environment variable PERL_INSTALL_ROOT
         set which will be prepended as a directory to each
         installed file (and directory).

ENVIRONMENT

     PERL_INSTALL_ROOT

perl v5.8.8                2005-02-05                           2

ExtUtils::InstallPerl Programmers Reference ExtUtils::Install(3p)

         Will be prepended to each install path.

AUTHOR

     Original author lost in the mists of time.  Probably the
     same as Makemaker.

     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 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.8                2005-02-05                           3