56
56
<li><a href="http://search.cpan.org">CPAN</a></li>
57
<li><a href="http://www.perl.org">Perl.org</a></li>
57
58
<li><a href="http://www.perl.com">Perl.com</a></li>
58
<li><a href="http://www.perl.org">Perl.org</a></li>
59
<li><a href="http://perlbuzz.com">Perl Buzz</a></li>
60
<li><a href="http://www.perlfoundation.org/perl5/index.cgi">Perl 5 Wiki</a></li>
61
<li><a href="http://jobs.perl.org">Perl Jobs</a></li>
59
62
<li><a href="http://www.pm.org">Perl Mongers</a></li>
60
63
<li><a href="http://www.perlmonks.org">Perl Monks</a></li>
61
64
<li><a href="http://planet.perl.org">Planet Perl</a></li>
66
69
<li>Site maintained by<br><a href="http://perl.jonallen.info">Jon Allen</a>
67
70
(<a href="http://perl.jonallen.info">JJ</a>)</li>
68
<li class="spaced">Last updated on<br>23 April 2006</li>
71
<li class="spaced">Last updated on<br>23 December 2007</li>
69
72
<li class="spaced">See the <a href="http://perl.jonallen.info/projects/perldoc">project page</a> for
76
79
<div id="centerContent">
77
80
<div id="contentHeader">
78
81
<div id="contentHeaderLeft"><a href="#" onClick="showLeft()">Show navigation</a></div>
79
<div id="contentHeaderCentre">-- Perl 5.8.8 documentation --</div>
82
<div id="contentHeaderCentre">-- Perl 5.10.0 documentation --</div>
80
83
<div id="contentHeaderRight"><a href="#" onClick="showRight()">Show toolbar</a></div>
82
85
<div id="breadCrumbs"><a href="../index.html">Home</a> > <a href="../index-modules-A.html">Core modules</a> > <a href="../index-modules-E.html">E</a> > ExtUtils::Install</div>
84
87
<div id="contentBody"><div class="title_container"><div class="page_title">ExtUtils::Install</div></div><ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Functions">Functions</a></ul><li><a href="#ENVIRONMENT">ENVIRONMENT</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#LICENSE">LICENSE</a></ul><a name="NAME"></a><h1>NAME</h1>
85
88
<p>ExtUtils::Install - install files from here to there</p>
86
89
<a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>
87
<pre class="verbatim"> <a class="l_k" href="../functions/use.html">use</a> <a class="l_w" href="../ExtUtils/Install.html">ExtUtils::Install</a><span class="sc">;</span></pre>
90
<pre class="verbatim"> <a class="l_k" href="../functions/use.html">use</a> <span class="w">ExtUtils::Install</span><span class="sc">;</span></pre>
88
91
<pre class="verbatim"> <span class="i">install</span><span class="s">(</span><span class="s">{</span> <span class="q">'blib/lib'</span> <span class="cm">=></span> <span class="q">'some/install/dir'</span> <span class="s">}</span> <span class="s">)</span><span class="sc">;</span></pre>
89
92
<pre class="verbatim"> <span class="i">uninstall</span><span class="s">(</span><span class="i">$packlist</span><span class="s">)</span><span class="sc">;</span></pre>
90
93
<pre class="verbatim"> <span class="i">pm_to_blib</span><span class="s">(</span><span class="s">{</span> <span class="q">'lib/Foo/Bar.pm'</span> <span class="cm">=></span> <span class="q">'blib/lib/Foo/Bar.pm'</span> <span class="s">}</span><span class="s">)</span><span class="sc">;</span></pre>
94
97
<p>Both install() and uninstall() are specific to the way
95
98
ExtUtils::MakeMaker handles the installation and deinstallation of
96
99
perl modules. They are not designed as general purpose tools.</p>
100
<p>On some operating systems such as Win32 installation may not be possible
101
until after a reboot has occured. This can have varying consequences:
102
removing an old DLL does not impact programs using the new one, but if
103
a new DLL cannot be installed properly until reboot then anything
104
depending on it must wait. The package variable</p>
105
<pre class="verbatim"> <span class="i">$ExtUtils::Install::MUST_REBOOT</span></pre>
106
<p>is used to store this status.</p>
107
<p>If this variable is true then such an operation has occured and
108
anything depending on this module cannot proceed until a reboot
110
<p>If this value is defined but false then such an operation has
111
ocurred, but should not impact later operations.</p>
97
112
<a name="Functions"></a><h2>Functions</h2>
99
114
<li><a name="*install*"></a><b><b>install</b></b>
100
115
<pre class="verbatim"> <span class="i">install</span><span class="s">(</span>\<span class="i">%from_to</span><span class="s">)</span><span class="sc">;</span>
101
<span class="i">install</span><span class="s">(</span>\<span class="i">%from_to</span><span class="cm">,</span> <span class="i">$verbose</span><span class="cm">,</span> <span class="i">$dont_execute</span><span class="cm">,</span> <span class="i">$uninstall_shadows</span><span class="s">)</span><span class="sc">;</span></pre>
116
<span class="i">install</span><span class="s">(</span>\<span class="i">%from_to</span><span class="cm">,</span> <span class="i">$verbose</span><span class="cm">,</span> <span class="i">$dont_execute</span><span class="cm">,</span> <span class="i">$uninstall_shadows</span><span class="cm">,</span> <span class="i">$skip</span><span class="s">)</span><span class="sc">;</span></pre>
102
117
<p>Copies each directory tree of %from_to to its corresponding value
103
118
preserving timestamps and permissions.</p>
104
119
<p>There are two keys with a special meaning in the hash: "read" and
109
124
on AFS it is quite likely that people are installing to a different
110
125
directory than the one where the files later appear.</p>
111
126
<p>If $verbose is true, will print out each file removed. Default is
112
false. This is "make install VERBINST=1"</p>
127
false. This is "make install VERBINST=1". $verbose values going
128
up to 5 show increasingly more diagnostics output.</p>
113
129
<p>If $dont_execute is true it will only print what it was going to do
114
130
without actually doing it. Default is false.</p>
115
131
<p>If $uninstall_shadows is true any differing versions throughout @INC
116
132
will be uninstalled. This is "make install UNINST=1"</p>
133
<p>As of 1.37_02 install() supports the use of a list of patterns to filter
134
out files that shouldn't be installed. If $skip is omitted or undefined
135
then install will try to read the list from INSTALL.SKIP in the CWD.
136
This file is a list of regular expressions and is just like the
137
MANIFEST.SKIP file used by <a href="../ExtUtils/Manifest.html">ExtUtils::Manifest</a>.</p>
138
<p>A default site INSTALL.SKIP may be provided by setting then environment
139
variable EU_INSTALL_SITE_SKIPFILE, this will only be used when there
140
isn't a distribution specific INSTALL.SKIP. If the environment variable
141
EU_INSTALL_IGNORE_SKIP is true then no install file filtering will be
143
<p>If $skip is undefined then the skip file will be autodetected and used if it
144
is found. If $skip is a reference to an array then it is assumed
145
the array contains the list of patterns, if $skip is a true non reference it is
146
assumed to be the filename holding the list of patterns, any other value of
147
$skip is taken to mean that no install filtering should occur.</p>
118
149
<li><a name="*install_default*-_DISCOURAGED_"></a><b><b>install_default</b> <i>DISCOURAGED</i></b>
119
150
<pre class="verbatim"> <span class="i">install_default</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
150
181
<p>You can have an environment variable PERL_INSTALL_ROOT set which will
151
182
be prepended as a directory to each installed file (and directory).</p>
153
<li><a name="_autosplit"></a><b>_autosplit</b>
154
<p>From 1.0307 back, AutoSplit will sometimes leave an open filehandle to
155
the file being split. This causes problems on systems with mandatory
156
locking (ie. Windows). So we wrap it and close the filehandle.</p>
159
185
<a name="ENVIRONMENT"></a><h1>ENVIRONMENT</h1>
161
187
<li><a name="*PERL_INSTALL_ROOT*"></a><b><b>PERL_INSTALL_ROOT</b></b>
162
188
<p>Will be prepended to each install path.</p>
190
<li><a name="*EU_INSTALL_IGNORE_SKIP*"></a><b><b>EU_INSTALL_IGNORE_SKIP</b></b>
191
<p>Will prevent the automatic use of INSTALL.SKIP as the install skip file.</p>
193
<li><a name="*EU_INSTALL_SITE_SKIPFILE*"></a><b><b>EU_INSTALL_SITE_SKIPFILE</b></b>
194
<p>If there is no INSTALL.SKIP file in the make directory then this value
195
can be used to provide a default.</p>
165
198
<a name="AUTHOR"></a><h1>AUTHOR</h1>
166
199
<p>Original author lost in the mists of time. Probably the same as Makemaker.</p>
167
<p>Currently maintained by Michael G Schwern <code class="inline">schwern<span class="i">@pobox</span>.com</code>
200
<p>Production release currently maintained by demerphq <code class="inline"><span class="w">yves</span> <span class="w">at</span> <span class="w">cpan</span>.<span class="w">org</span></code>
169
<p>Send patches and ideas to <code class="inline">makemaker<span class="i">@perl</span>.org</code>
171
202
<p>Send bug reports via <a href="http://rt.cpan.org/">http://rt.cpan.org/</a>. Please send your
172
203
generated Makefile along with your report.</p>
173
<p>For more up-to-date information, see <a href="http://www.makemaker.org">http://www.makemaker.org</a>.</p>
174
204
<a name="LICENSE"></a><h1>LICENSE</h1>
175
<p>This program is free software; you can redistribute it and/or
205
<p>This program is free software; you can redistribute it and/or
176
206
modify it under the same terms as Perl itself.</p>
177
207
<p>See <a href="http://www.perl.com/perl/misc/Artistic.html">http://www.perl.com/perl/misc/Artistic.html</a></p>
added
removed
ExtUtils/Install.html
