| 1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 | .tr \(*W-|\(bv\*(Tr |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 | .\" output yourself in some meaningful fashion. |
| 55 | .if \nF \{\ |
| 56 | . de IX |
| 57 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 58 | .. |
| 59 | . nr % 0 |
| 60 | . rr F |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 | .\" way too many mistakes in technical documents. |
| 65 | .hy 0 |
| 66 | .if n .na |
| 67 | .\" |
| 68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 | . \" fudge factors for nroff and troff |
| 71 | .if n \{\ |
| 72 | . ds #H 0 |
| 73 | . ds #V .8m |
| 74 | . ds #F .3m |
| 75 | . ds #[ \f1 |
| 76 | . ds #] \fP |
| 77 | .\} |
| 78 | .if t \{\ |
| 79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 | . ds #V .6m |
| 81 | . ds #F 0 |
| 82 | . ds #[ \& |
| 83 | . ds #] \& |
| 84 | .\} |
| 85 | . \" simple accents for nroff and troff |
| 86 | .if n \{\ |
| 87 | . ds ' \& |
| 88 | . ds ` \& |
| 89 | . ds ^ \& |
| 90 | . ds , \& |
| 91 | . ds ~ ~ |
| 92 | . ds / |
| 93 | .\} |
| 94 | .if t \{\ |
| 95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 | .\} |
| 102 | . \" troff and (daisy-wheel) nroff accents |
| 103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 | . \" corrections for vroff |
| 113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 | . \" for low resolution devices (crt and lpr) |
| 116 | .if \n(.H>23 .if \n(.V>19 \ |
| 117 | \{\ |
| 118 | . ds : e |
| 119 | . ds 8 ss |
| 120 | . ds o a |
| 121 | . ds d- d\h'-1'\(ga |
| 122 | . ds D- D\h'-1'\(hy |
| 123 | . ds th \o'bp' |
| 124 | . ds Th \o'LP' |
| 125 | . ds ae ae |
| 126 | . ds Ae AE |
| 127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
| 130 | .\" |
| 131 | .IX Title "ExtUtils::Install 3" |
| 132 | .TH ExtUtils::Install 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" |
| 133 | .SH "NAME" |
| 134 | ExtUtils::Install \- install files from here to there |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 1 |
| 138 | \& use ExtUtils::Install; |
| 139 | .Ve |
| 140 | .PP |
| 141 | .Vb 1 |
| 142 | \& install({ 'blib/lib' => 'some/install/dir' } ); |
| 143 | .Ve |
| 144 | .PP |
| 145 | .Vb 1 |
| 146 | \& uninstall($packlist); |
| 147 | .Ve |
| 148 | .PP |
| 149 | .Vb 1 |
| 150 | \& pm_to_blib({ 'lib/Foo/Bar.pm' => 'blib/lib/Foo/Bar.pm' }); |
| 151 | .Ve |
| 152 | .SH "DESCRIPTION" |
| 153 | .IX Header "DESCRIPTION" |
| 154 | Handles the installing and uninstalling of perl modules, scripts, man |
| 155 | pages, etc... |
| 156 | .PP |
| 157 | Both \fIinstall()\fR and \fIuninstall()\fR are specific to the way |
| 158 | ExtUtils::MakeMaker handles the installation and deinstallation of |
| 159 | perl modules. They are not designed as general purpose tools. |
| 160 | .Sh "Functions" |
| 161 | .IX Subsection "Functions" |
| 162 | .IP "\fBinstall\fR" 4 |
| 163 | .IX Item "install" |
| 164 | .Vb 2 |
| 165 | \& install(\e%from_to); |
| 166 | \& install(\e%from_to, $verbose, $dont_execute, $uninstall_shadows); |
| 167 | .Ve |
| 168 | .Sp |
| 169 | Copies each directory tree of \f(CW%from_to\fR to its corresponding value |
| 170 | preserving timestamps and permissions. |
| 171 | .Sp |
| 172 | There are two keys with a special meaning in the hash: \*(L"read\*(R" and |
| 173 | \&\*(L"write\*(R". These contain packlist files. After the copying is done, |
| 174 | \&\fIinstall()\fR will write the list of target files to \f(CW$from_to\fR{write}. If |
| 175 | \&\f(CW$from_to\fR{read} is given the contents of this file will be merged into |
| 176 | the written file. The read and the written file may be identical, but |
| 177 | on \s-1AFS\s0 it is quite likely that people are installing to a different |
| 178 | directory than the one where the files later appear. |
| 179 | .Sp |
| 180 | If \f(CW$verbose\fR is true, will print out each file removed. Default is |
| 181 | false. This is \*(L"make install VERBINST=1\*(R" |
| 182 | .Sp |
| 183 | If \f(CW$dont_execute\fR is true it will only print what it was going to do |
| 184 | without actually doing it. Default is false. |
| 185 | .Sp |
| 186 | If \f(CW$uninstall_shadows\fR is true any differing versions throughout \f(CW@INC\fR |
| 187 | will be uninstalled. This is \*(L"make install UNINST=1\*(R" |
| 188 | .IP "\fBinstall_default\fR \fI\s-1DISCOURAGED\s0\fR" 4 |
| 189 | .IX Item "install_default DISCOURAGED" |
| 190 | .Vb 2 |
| 191 | \& install_default(); |
| 192 | \& install_default($fullext); |
| 193 | .Ve |
| 194 | .Sp |
| 195 | Calls \fIinstall()\fR with arguments to copy a module from blib/ to the |
| 196 | default site installation location. |
| 197 | .Sp |
| 198 | $fullext is the name of the module converted to a directory |
| 199 | (ie. Foo::Bar would be Foo/Bar). If \f(CW$fullext\fR is not specified, it |
| 200 | will attempt to read it from \f(CW@ARGV\fR. |
| 201 | .Sp |
| 202 | This is primarily useful for install scripts. |
| 203 | .Sp |
| 204 | \&\fB\s-1NOTE\s0\fR This function is not really useful because of the hard-coded |
| 205 | install location with no way to control site vs core vs vendor |
| 206 | directories and the strange way in which the module name is given. |
| 207 | Consider its use discouraged. |
| 208 | .IP "\fBuninstall\fR" 4 |
| 209 | .IX Item "uninstall" |
| 210 | .Vb 2 |
| 211 | \& uninstall($packlist_file); |
| 212 | \& uninstall($packlist_file, $verbose, $dont_execute); |
| 213 | .Ve |
| 214 | .Sp |
| 215 | Removes the files listed in a \f(CW$packlist_file\fR. |
| 216 | .Sp |
| 217 | If \f(CW$verbose\fR is true, will print out each file removed. Default is |
| 218 | false. |
| 219 | .Sp |
| 220 | If \f(CW$dont_execute\fR is true it will only print what it was going to do |
| 221 | without actually doing it. Default is false. |
| 222 | .IP "\fBpm_to_blib\fR" 4 |
| 223 | .IX Item "pm_to_blib" |
| 224 | .Vb 2 |
| 225 | \& pm_to_blib(\e%from_to, $autosplit_dir); |
| 226 | \& pm_to_blib(\e%from_to, $autosplit_dir, $filter_cmd); |
| 227 | .Ve |
| 228 | .Sp |
| 229 | Copies each key of \f(CW%from_to\fR to its corresponding value efficiently. |
| 230 | Filenames with the extension .pm are autosplit into the \f(CW$autosplit_dir\fR. |
| 231 | Any destination directories are created. |
| 232 | .Sp |
| 233 | $filter_cmd is an optional shell command to run each .pm file through |
| 234 | prior to splitting and copying. Input is the contents of the module, |
| 235 | output the new module contents. |
| 236 | .Sp |
| 237 | You can have an environment variable \s-1PERL_INSTALL_ROOT\s0 set which will |
| 238 | be prepended as a directory to each installed file (and directory). |
| 239 | .SH "ENVIRONMENT" |
| 240 | .IX Header "ENVIRONMENT" |
| 241 | .IP "\fB\s-1PERL_INSTALL_ROOT\s0\fR" 4 |
| 242 | .IX Item "PERL_INSTALL_ROOT" |
| 243 | Will be prepended to each install path. |
| 244 | .SH "AUTHOR" |
| 245 | .IX Header "AUTHOR" |
| 246 | Original author lost in the mists of time. Probably the same as Makemaker. |
| 247 | .PP |
| 248 | Currently maintained by Michael G Schwern \f(CW\*(C`schwern@pobox.com\*(C'\fR |
| 249 | .PP |
| 250 | Send patches and ideas to \f(CW\*(C`makemaker@perl.org\*(C'\fR. |
| 251 | .PP |
| 252 | Send bug reports via http://rt.cpan.org/. Please send your |
| 253 | generated Makefile along with your report. |
| 254 | .PP |
| 255 | For more up-to-date information, see <http://www.makemaker.org>. |
| 256 | .SH "LICENSE" |
| 257 | .IX Header "LICENSE" |
| 258 | This program is free software; you can redistribute it and/or |
| 259 | modify it under the same terms as Perl itself. |
| 260 | .PP |
| 261 | See <http://www.perl.com/perl/misc/Artistic.html> |