Commit | Line | Data |
---|---|---|
8e07c86e AD |
1 | =head1 NAME |
2 | ||
3 | Install - Build and Installation guide for perl5. | |
4 | ||
5 | =head1 SYNOPSIS | |
6 | ||
3ce0d271 GS |
7 | First, make sure you are installing an up-to-date version of Perl. If |
8 | you didn't get your Perl source from CPAN, check the latest version at | |
16dc217a | 9 | <URL:http://www.cpan.org/src/>. |
3ce0d271 | 10 | |
c42e3e15 GS |
11 | The basic steps to build and install perl5 on a Unix system |
12 | with all the defaults are: | |
8e07c86e | 13 | |
dc45a647 | 14 | rm -f config.sh Policy.sh |
491517e0 | 15 | sh Configure -de |
8e07c86e AD |
16 | make |
17 | make test | |
18 | make install | |
36477c24 | 19 | |
aa689395 | 20 | # You may also wish to add these: |
21 | (cd /usr/include && h2ph *.h sys/*.h) | |
3e3baf6d | 22 | (installhtml --help) |
aa689395 | 23 | (cd pod && make tex && <process the latex files>) |
8e07c86e AD |
24 | |
25 | Each of these is explained in further detail below. | |
26 | ||
cc65bb49 | 27 | B<NOTE>: starting from the release 5.6.0, Perl uses a version |
fe23a901 | 28 | scheme where even-numbered subreleases (like 5.6 and 5.8) are stable |
b88cc0eb JH |
29 | maintenance releases and odd-numbered subreleases (like 5.7) are |
30 | unstable development releases. Development releases should not be | |
31 | used in production environments. Fixes and new features are first | |
32 | carefully tested in development releases and only if they prove | |
33 | themselves to be worthy will they be migrated to the maintenance | |
34 | releases. | |
35 | ||
cc65bb49 AD |
36 | The above commands will install Perl to /usr/local (or some other |
37 | platform-specific directory -- see the appropriate file in hints/.) | |
38 | If that's not okay with you, use | |
491517e0 JA |
39 | |
40 | rm -f config.sh Policy.sh | |
41 | sh Configure | |
42 | make | |
43 | make test | |
44 | make install | |
45 | ||
adbebc0b JH |
46 | For information on non-Unix systems, see the section on L<"Porting |
47 | information"> below. | |
48 | ||
49 | If "make install" just says "`install' is up to date" or something | |
cc65bb49 AD |
50 | similar, you may be on a case-insensitive filesystems such as Mac's HFS+, |
51 | and you should say "make install-all". (This confusion is brought to you | |
adbebc0b | 52 | by the Perl distribution having a file called INSTALL.) |
7f678428 | 53 | |
8d74ce1c AD |
54 | If you have problems, corrections, or questions, please see |
55 | L<"Reporting Problems"> below. | |
56 | ||
7beaa944 AD |
57 | For information on what's new in this release, see the |
58 | pod/perldelta.pod file. For more detailed information about specific | |
59 | changes, see the Changes file. | |
c3edaffb | 60 | |
1ec51d55 | 61 | =head1 DESCRIPTION |
edb1cbcb | 62 | |
c3edaffb | 63 | This document is written in pod format as an easy way to indicate its |
64 | structure. The pod format is described in pod/perlpod.pod, but you can | |
1ec51d55 CS |
65 | read it as is with any pager or editor. Headings and items are marked |
66 | by lines beginning with '='. The other mark-up used is | |
67 | ||
68 | B<text> embolden text, used for switches, programs or commands | |
69 | C<code> literal code | |
70 | L<name> A link (cross reference) to name | |
71 | ||
c42e3e15 GS |
72 | Although most of the defaults are probably fine for most users, |
73 | you should probably at least skim through this entire document before | |
1ec51d55 | 74 | proceeding. |
c3edaffb | 75 | |
eed2e782 | 76 | If you're building Perl on a non-Unix system, you should also read |
77 | the README file specific to your operating system, since this may | |
c35d5681 PN |
78 | provide additional or different instructions for building Perl. There |
79 | are also README files for several flavors of Unix systems, such as | |
80 | Solaris, HP-UX, and AIX; if you have one of those systems, you should | |
81 | also read the README file specific to that system. | |
eed2e782 | 82 | |
203c3eec AD |
83 | If there is a hint file for your system (in the hints/ directory) you |
84 | should also read that hint file for specific information for your | |
70cc50ef | 85 | system. (Unixware users should use the svr4.sh or the svr5.sh hint file.) |
cc65bb49 | 86 | Additional information is in the Porting/ directory. |
203c3eec | 87 | |
c42e3e15 GS |
88 | =head1 WARNING: This version requires an extra step to build old extensions. |
89 | ||
90 | 5.005_53 and later releases do not export unadorned | |
64fa5b0b DM |
91 | global symbols anymore. This means you may need to build rather old |
92 | extensions that have not been updated for the current naming convention | |
c42e3e15 GS |
93 | with: |
94 | ||
95 | perl Makefile.PL POLLUTE=1 | |
d56c5707 | 96 | |
c42e3e15 GS |
97 | Alternatively, you can enable CPP symbol pollution wholesale by |
98 | building perl itself with: | |
99 | ||
100 | sh Configure -Accflags=-DPERL_POLLUTE | |
101 | ||
5cda700b | 102 | pod/perl56delta.pod contains more details about this. |
c42e3e15 | 103 | |
64fa5b0b DM |
104 | =head1 WARNING: This version is not binary compatible with releases of |
105 | Perl prior to 5.8.0. | |
1b1c1ae2 | 106 | |
cc65bb49 | 107 | If you have built extensions (i.e. modules that include C code) |
64fa5b0b DM |
108 | using an earlier version of Perl, you will need to rebuild and reinstall |
109 | those extensions. | |
1b1c1ae2 GS |
110 | |
111 | Pure perl modules without XS or C code should continue to work fine | |
112 | without reinstallation. See the discussions below on | |
113 | L<"Coexistence with earlier versions of perl5"> and | |
fe23a901 | 114 | L<"Upgrading from 5.005 or 5.6 to 5.8.0"> for more details. |
693762b4 AD |
115 | |
116 | The standard extensions supplied with Perl will be handled automatically. | |
117 | ||
1b1c1ae2 | 118 | On a related issue, old modules may possibly be affected by the |
693762b4 | 119 | changes in the Perl language in the current release. Please see |
5cda700b | 120 | pod/perldelta.pod (and the earlier pod/perl5Xdelta.pod) for a description of |
c42e3e15 | 121 | what's changed. See your installed copy of the perllocal.pod |
d6baa268 JH |
122 | file for a (possibly incomplete) list of locally installed modules. |
123 | Also see CPAN::autobundle for one way to make a "bundle" of your | |
124 | currently installed modules. | |
693762b4 | 125 | |
5effff0b GS |
126 | =head1 WARNING: This version requires a compiler that supports ANSI C. |
127 | ||
16dc217a GS |
128 | Most C compilers are now ANSI-compliant. However, a few current |
129 | computers are delivered with an older C compiler expressly for | |
130 | rebuilding the system kernel, or for some other historical reason. | |
131 | Alternatively, you may have an old machine which was shipped before | |
132 | ANSI compliance became widespread. Such compilers are not suitable | |
133 | for building Perl. | |
134 | ||
135 | If you find that your default C compiler is not ANSI-capable, but you | |
136 | know that an ANSI-capable compiler is installed on your system, you | |
137 | can tell F<Configure> to use the correct compiler by means of the | |
138 | C<-Dcc=> command-line option -- see L<"gcc">. | |
139 | ||
cc65bb49 AD |
140 | If do not have an ANSI-capable compiler there are a couple of avenues |
141 | open to you: | |
16dc217a GS |
142 | |
143 | =over 4 | |
144 | ||
145 | =item * | |
146 | ||
147 | You may try obtaining GCC, available from GNU mirrors worldwide, | |
148 | listed at <URL:http://www.gnu.org/order/ftp.html>. If, rather than | |
149 | building gcc from source code, you locate a binary version configured | |
150 | for your platform, be sure that it is compiled for the version of the | |
151 | operating system that you are using. | |
152 | ||
153 | =item * | |
154 | ||
155 | You may purchase a commercial ANSI C compiler from your system | |
156 | supplier or elsewhere. (Or your organization may already have | |
157 | licensed such software -- ask your colleagues to find out how to | |
158 | access it.) If there is a README file for your system in the Perl | |
159 | distribution (for example, F<README.hpux>), it may contain advice on | |
160 | suitable compilers. | |
161 | ||
16dc217a GS |
162 | =back |
163 | ||
df41b452 GS |
164 | Although Perl can be compiled using a C++ compiler, the Configure script |
165 | does not work with some C++ compilers. | |
166 | ||
aa689395 | 167 | =head1 Space Requirements |
eed2e782 | 168 | |
8756f06c JH |
169 | The complete perl5 source tree takes up about 50 MB of disk space. |
170 | After completing make, it takes up roughly 100 MB, though the actual | |
d6baa268 | 171 | total is likely to be quite system-dependent. The installation |
8756f06c | 172 | directories need something on the order of 45 MB, though again that |
1ec51d55 | 173 | value is system-dependent. |
8e07c86e | 174 | |
aa689395 | 175 | =head1 Start with a Fresh Distribution |
8e07c86e | 176 | |
edb1cbcb | 177 | If you have built perl before, you should clean out the build directory |
178 | with the command | |
179 | ||
dc45a647 MB |
180 | make distclean |
181 | ||
182 | or | |
183 | ||
edb1cbcb | 184 | make realclean |
c3edaffb | 185 | |
dc45a647 MB |
186 | The only difference between the two is that make distclean also removes |
187 | your old config.sh and Policy.sh files. | |
188 | ||
189 | The results of a Configure run are stored in the config.sh and Policy.sh | |
190 | files. If you are upgrading from a previous version of perl, or if you | |
191 | change systems or compilers or make other significant changes, or if | |
192 | you are experiencing difficulties building perl, you should probably | |
d6baa268 | 193 | not re-use your old config.sh. Simply remove it |
8e07c86e | 194 | |
d6baa268 | 195 | rm -f config.sh |
4633a7c4 | 196 | |
e57fd563 | 197 | If you wish to use your old config.sh, be especially attentive to the |
198 | version and architecture-specific questions and answers. For example, | |
199 | the default directory for architecture-dependent library modules | |
200 | includes the version name. By default, Configure will reuse your old | |
201 | name (e.g. /opt/perl/lib/i86pc-solaris/5.003) even if you're running | |
202 | Configure for a different version, e.g. 5.004. Yes, Configure should | |
5cda700b | 203 | probably check and correct for this, but it doesn't. |
e57fd563 | 204 | Similarly, if you used a shared libperl.so (see below) with version |
205 | numbers, you will probably want to adjust them as well. | |
206 | ||
d6baa268 JH |
207 | Also, be careful to check your architecture name. For example, some |
208 | Linux distributions use i386, while others may use i486. If you build | |
209 | it yourself, Configure uses the output of the arch command, which | |
210 | might be i586 or i686 instead. If you pick up a precompiled binary, or | |
211 | compile extensions on different systems, they might not all agree on | |
212 | the architecture name. | |
e57fd563 | 213 | |
214 | In short, if you wish to use your old config.sh, I recommend running | |
215 | Configure interactively rather than blindly accepting the defaults. | |
8e07c86e | 216 | |
d6baa268 JH |
217 | If your reason to reuse your old config.sh is to save your particular |
218 | installation choices, then you can probably achieve the same effect by | |
219 | using the Policy.sh file. See the section on L<"Site-wide Policy | |
220 | settings"> below. If you wish to start with a fresh distribution, you | |
221 | also need to remove any old Policy.sh files you may have with | |
222 | ||
223 | rm -f Policy.sh | |
dc45a647 | 224 | |
aa689395 | 225 | =head1 Run Configure |
8e07c86e AD |
226 | |
227 | Configure will figure out various things about your system. Some | |
228 | things Configure will figure out for itself, other things it will ask | |
d6baa268 JH |
229 | you about. To accept the default, just press RETURN. The default is |
230 | almost always okay. It is normal for some things to be "NOT found", | |
231 | since Configure often searches for many different ways of performing | |
232 | the same function. | |
233 | ||
234 | At any Configure prompt, you can type &-d and Configure will use the | |
235 | defaults from then on. | |
8e07c86e AD |
236 | |
237 | After it runs, Configure will perform variable substitution on all the | |
1ec51d55 | 238 | *.SH files and offer to run make depend. |
8e07c86e | 239 | |
1b1c1ae2 GS |
240 | =head2 Altering config.sh variables for C compiler switches etc. |
241 | ||
242 | For most users, all of the Configure defaults are fine. Configure | |
cc65bb49 | 243 | also has several convenient options which are described below. |
1b1c1ae2 GS |
244 | However, if Configure doesn't have an option to do what you want, |
245 | you can change Configure variables after the platform hints have been | |
246 | run, by using Configure's -A switch. For example, here's how to add | |
247 | a couple of extra flags to C compiler invocations: | |
248 | ||
249 | sh Configure -Accflags="-DPERL_Y2KWARN -DPERL_POLLUTE_MALLOC" | |
250 | ||
251 | For more help on Configure switches, run: | |
252 | ||
253 | sh Configure -h | |
254 | ||
844fc9f4 JH |
255 | =head2 Building Perl outside of the source directory |
256 | ||
257 | Sometimes it is desirable to build Perl in a directory different from | |
258 | where the sources are, for example if you want to keep your sources | |
259 | read-only, or if you want to share the sources between different binary | |
cc65bb49 AD |
260 | architectures. You can do this (if your file system supports symbolic |
261 | links) by | |
5cda700b | 262 | |
844fc9f4 JH |
263 | mkdir /tmp/perl/build/directory |
264 | cd /tmp/perl/build/directory | |
265 | sh /path/to/perl/source/Configure -Dmksymlinks ... | |
266 | ||
267 | This will create in /tmp/perl/build/directory a tree of symbolic links | |
268 | pointing to files in /path/to/perl/source. The original files are left | |
269 | unaffected. After Configure has finished you can just say | |
270 | ||
271 | make all test | |
272 | ||
273 | and Perl will be built and tested, all in /tmp/perl/build/directory. | |
274 | ||
d6baa268 JH |
275 | =head2 Common Configure options |
276 | ||
fb73857a | 277 | Configure supports a number of useful options. Run B<Configure -h> to |
278 | get a listing. See the Porting/Glossary file for a complete list of | |
279 | Configure variables you can set and their definitions. | |
280 | ||
d6baa268 JH |
281 | =over 4 |
282 | ||
283 | =item gcc | |
284 | ||
285 | To compile with gcc you should run | |
8e07c86e AD |
286 | |
287 | sh Configure -Dcc=gcc | |
288 | ||
289 | This is the preferred way to specify gcc (or another alternative | |
290 | compiler) so that the hints files can set appropriate defaults. | |
291 | ||
d6baa268 | 292 | =item Installation prefix |
4633a7c4 | 293 | |
8e07c86e | 294 | By default, for most systems, perl will be installed in |
8d74ce1c AD |
295 | /usr/local/{bin, lib, man}. (See L<"Installation Directories"> |
296 | and L<"Coexistence with earlier versions of perl5"> below for | |
297 | further details.) | |
298 | ||
299 | You can specify a different 'prefix' for the default installation | |
300 | directory, when Configure prompts you or by using the Configure command | |
301 | line option -Dprefix='/some/directory', e.g. | |
8e07c86e | 302 | |
25f94b33 | 303 | sh Configure -Dprefix=/opt/perl |
4633a7c4 | 304 | |
d6baa268 JH |
305 | If your prefix contains the string "perl", then the suggested |
306 | directory structure is simplified. For example, if you use | |
307 | prefix=/opt/perl, then Configure will suggest /opt/perl/lib instead of | |
308 | /opt/perl/lib/perl5/. Again, see L<"Installation Directories"> below | |
bc70e9ec JH |
309 | for more details. Do not include a trailing slash, (i.e. /opt/perl/) |
310 | or you may experience odd test failures. | |
8e07c86e | 311 | |
8d74ce1c AD |
312 | NOTE: You must not specify an installation directory that is the same |
313 | as or below your perl source directory. If you do, installperl will | |
314 | attempt infinite recursion. | |
84902520 | 315 | |
d6baa268 JH |
316 | =item /usr/bin/perl |
317 | ||
318 | It may seem obvious, but Perl is useful only when users can easily | |
319 | find it. It's often a good idea to have both /usr/bin/perl and | |
dd64f1c3 | 320 | /usr/local/bin/perl be symlinks to the actual binary. Be especially |
d6baa268 JH |
321 | careful, however, not to overwrite a version of perl supplied by your |
322 | vendor unless you are sure you know what you are doing. | |
323 | ||
7d9a7e35 JH |
324 | By default, Configure will not try to link /usr/bin/perl to |
325 | the current version of perl. You can turn on that behavior by running | |
d6baa268 | 326 | |
7d9a7e35 | 327 | Configure -Dinstallusrbinperl |
d6baa268 | 328 | |
7d9a7e35 JH |
329 | or by answering 'yes' to the appropriate Configure prompt. |
330 | (Note that before perl 5.8.1, the default behavior was to create | |
331 | or overwrite /usr/bin/perl even if it already existed.) | |
d6baa268 JH |
332 | |
333 | In any case, system administrators are strongly encouraged to | |
dd64f1c3 | 334 | put (symlinks to) perl and its accompanying utilities, such as perldoc, |
4682965a MB |
335 | into a directory typically found along a user's PATH, or in another |
336 | obvious and convenient place. | |
337 | ||
d6baa268 | 338 | =item Overriding an old config.sh |
04d420f9 | 339 | |
d6baa268 JH |
340 | If you want to use your old config.sh but override some of the items |
341 | with command line options, you need to use B<Configure -O>. | |
342 | ||
343 | =back | |
8e07c86e | 344 | |
203c3eec AD |
345 | If you are willing to accept all the defaults, and you want terse |
346 | output, you can run | |
347 | ||
348 | sh Configure -des | |
349 | ||
cc65bb49 | 350 | Note: for development releases (odd subreleases, like 5.9, as opposed |
fe23a901 | 351 | to maintenance releases which have even subreleases, like 5.6 and 5.8) |
b88cc0eb JH |
352 | if you want to use Configure -d, you will also need to supply -Dusedevel |
353 | to Configure, because the default answer to the question "do you really | |
354 | want to Configure a development version?" is "no". The -Dusedevel | |
355 | skips that sanity check. | |
356 | ||
357 | For example for my Solaris system, I usually use | |
203c3eec AD |
358 | |
359 | sh Configure -Dprefix=/opt/perl -Doptimize='-xpentium -xO4' -des | |
360 | ||
46bb10fb CS |
361 | =head2 GNU-style configure |
362 | ||
1ec51d55 | 363 | If you prefer the GNU-style configure command line interface, you can |
dc45a647 | 364 | use the supplied configure.gnu command, e.g. |
46bb10fb | 365 | |
693762b4 | 366 | CC=gcc ./configure.gnu |
46bb10fb | 367 | |
dc45a647 | 368 | The configure.gnu script emulates a few of the more common configure |
46bb10fb CS |
369 | options. Try |
370 | ||
693762b4 | 371 | ./configure.gnu --help |
46bb10fb CS |
372 | |
373 | for a listing. | |
374 | ||
dc45a647 | 375 | (The file is called configure.gnu to avoid problems on systems |
693762b4 | 376 | that would not distinguish the files "Configure" and "configure".) |
46bb10fb | 377 | |
cc65bb49 AD |
378 | See L<Cross-compilation> below for information on cross-compiling. |
379 | ||
aa689395 | 380 | =head2 Installation Directories |
4633a7c4 LW |
381 | |
382 | The installation directories can all be changed by answering the | |
383 | appropriate questions in Configure. For convenience, all the | |
384 | installation questions are near the beginning of Configure. | |
cc65bb49 | 385 | Do not include trailing slashes on directory names. |
4633a7c4 | 386 | |
7beaa944 AD |
387 | I highly recommend running Configure interactively to be sure it puts |
388 | everything where you want it. At any point during the Configure | |
d6baa268 | 389 | process, you can answer a question with &-d and Configure will use |
cc65bb49 AD |
390 | the defaults from then on. Alternatively, you can |
391 | ||
392 | grep '^install' config.sh | |
393 | ||
394 | after Configure has run to verify the installation paths. | |
d6baa268 JH |
395 | |
396 | The defaults are intended to be reasonable and sensible for most | |
397 | people building from sources. Those who build and distribute binary | |
398 | distributions or who export perl to a range of systems will probably | |
399 | need to alter them. If you are content to just accept the defaults, | |
400 | you can safely skip the next section. | |
401 | ||
402 | The directories set up by Configure fall into three broad categories. | |
403 | ||
404 | =over 4 | |
405 | ||
406 | =item Directories for the perl distribution | |
407 | ||
fe23a901 | 408 | By default, Configure will use the following directories for 5.8.0. |
d6baa268 | 409 | $version is the full perl version number, including subversion, e.g. |
fe23a901 | 410 | 5.8.0 or 5.8.1, and $archname is a string like sun4-sunos, |
d6baa268 JH |
411 | determined by Configure. The full definitions of all Configure |
412 | variables are in the file Porting/Glossary. | |
413 | ||
414 | Configure variable Default value | |
415 | $prefix /usr/local | |
416 | $bin $prefix/bin | |
417 | $scriptdir $prefix/bin | |
418 | $privlib $prefix/lib/perl5/$version | |
419 | $archlib $prefix/lib/perl5/$version/$archname | |
420 | $man1dir $prefix/man/man1 | |
421 | $man3dir $prefix/man/man3 | |
422 | $html1dir (none) | |
423 | $html3dir (none) | |
424 | ||
425 | Actually, Configure recognizes the SVR3-style | |
426 | /usr/local/man/l_man/man1 directories, if present, and uses those | |
427 | instead. Also, if $prefix contains the string "perl", the library | |
428 | directories are simplified as described below. For simplicity, only | |
429 | the common style is shown here. | |
430 | ||
431 | =item Directories for site-specific add-on files | |
432 | ||
433 | After perl is installed, you may later wish to add modules (e.g. from | |
434 | CPAN) or scripts. Configure will set up the following directories to | |
c42e3e15 | 435 | be used for installing those add-on modules and scripts. |
d6baa268 JH |
436 | |
437 | Configure variable Default value | |
438 | $siteprefix $prefix | |
439 | $sitebin $siteprefix/bin | |
49c10eea | 440 | $sitescript $siteprefix/bin |
273cf8d1 GS |
441 | $sitelib $siteprefix/lib/perl5/site_perl/$version |
442 | $sitearch $siteprefix/lib/perl5/site_perl/$version/$archname | |
3bb95762 JH |
443 | $siteman1dir $siteprefix/man/man1 |
444 | $siteman3dir $siteprefix/man/man3 | |
445 | $sitehtml1dir (none) | |
446 | $sitehtml3dir (none) | |
d6baa268 JH |
447 | |
448 | By default, ExtUtils::MakeMaker will install architecture-independent | |
273cf8d1 | 449 | modules into $sitelib and architecture-dependent modules into $sitearch. |
d6baa268 JH |
450 | |
451 | =item Directories for vendor-supplied add-on files | |
452 | ||
453 | Lastly, if you are building a binary distribution of perl for | |
454 | distribution, Configure can optionally set up the following directories | |
455 | for you to use to distribute add-on modules. | |
456 | ||
457 | Configure variable Default value | |
458 | $vendorprefix (none) | |
459 | (The next ones are set only if vendorprefix is set.) | |
460 | $vendorbin $vendorprefix/bin | |
49c10eea | 461 | $vendorscript $vendorprefix/bin |
273cf8d1 GS |
462 | $vendorlib $vendorprefix/lib/perl5/vendor_perl/$version |
463 | $vendorarch $vendorprefix/lib/perl5/vendor_perl/$version/$archname | |
3bb95762 JH |
464 | $vendorman1dir $vendorprefix/man/man1 |
465 | $vendorman3dir $vendorprefix/man/man3 | |
466 | $vendorhtml1dir (none) | |
467 | $vendorhtml3dir (none) | |
d6baa268 JH |
468 | |
469 | These are normally empty, but may be set as needed. For example, | |
470 | a vendor might choose the following settings: | |
471 | ||
345c69e9 A |
472 | $prefix /usr |
473 | $siteprefix /usr/local | |
474 | $vendorprefix /usr | |
d6baa268 JH |
475 | |
476 | This would have the effect of setting the following: | |
477 | ||
478 | $bin /usr/bin | |
479 | $scriptdir /usr/bin | |
480 | $privlib /usr/lib/perl5/$version | |
481 | $archlib /usr/lib/perl5/$version/$archname | |
482 | $man1dir /usr/man/man1 | |
483 | $man3dir /usr/man/man3 | |
484 | ||
485 | $sitebin /usr/local/bin | |
49c10eea | 486 | $sitescript /usr/local/bin |
273cf8d1 GS |
487 | $sitelib /usr/local/lib/perl5/site_perl/$version |
488 | $sitearch /usr/local/lib/perl5/site_perl/$version/$archname | |
3bb95762 JH |
489 | $siteman1dir /usr/local/man/man1 |
490 | $siteman3dir /usr/local/man/man3 | |
d6baa268 | 491 | |
49c10eea JH |
492 | $vendorbin /usr/bin |
493 | $vendorscript /usr/bin | |
273cf8d1 GS |
494 | $vendorlib /usr/lib/perl5/vendor_perl/$version |
495 | $vendorarch /usr/lib/perl5/vendor_perl/$version/$archname | |
3bb95762 JH |
496 | $vendorman1dir /usr/man/man1 |
497 | $vendorman3dir /usr/man/man3 | |
d6baa268 JH |
498 | |
499 | Note how in this example, the vendor-supplied directories are in the | |
500 | /usr hierarchy, while the directories reserved for the end-user are in | |
273cf8d1 GS |
501 | the /usr/local hierarchy. |
502 | ||
503 | The entire installed library hierarchy is installed in locations with | |
504 | version numbers, keeping the installations of different versions distinct. | |
505 | However, later installations of Perl can still be configured to search the | |
506 | installed libraries corresponding to compatible earlier versions. | |
507 | See L<"Coexistence with earlier versions of perl5"> below for more details | |
508 | on how Perl can be made to search older version directories. | |
d6baa268 JH |
509 | |
510 | Of course you may use these directories however you see fit. For | |
511 | example, you may wish to use $siteprefix for site-specific files that | |
512 | are stored locally on your own disk and use $vendorprefix for | |
513 | site-specific files that are stored elsewhere on your organization's | |
514 | network. One way to do that would be something like | |
515 | ||
516 | sh Configure -Dsiteprefix=/usr/local -Dvendorprefix=/usr/share/perl | |
517 | ||
518 | =item otherlibdirs | |
519 | ||
520 | As a final catch-all, Configure also offers an $otherlibdirs | |
521 | variable. This variable contains a colon-separated list of additional | |
3b777bb4 GS |
522 | directories to add to @INC. By default, it will be empty. |
523 | Perl will search these directories (including architecture and | |
524 | version-specific subdirectories) for add-on modules and extensions. | |
d6baa268 | 525 | |
fe23a901 RF |
526 | For example, if you have a bundle of perl libraries from a previous |
527 | installation, perhaps in a strange place: | |
528 | ||
529 | Configure -Dotherlibdirs=/usr/lib/perl5/site_perl/5.6.1 | |
530 | ||
a61357a9 JA |
531 | =item APPLLIB_EXP |
532 | ||
533 | There is one other way of adding paths to @INC at perl build time, and | |
534 | that is by setting the APPLLIB_EXP C pre-processor token to a colon- | |
535 | separated list of directories, like this | |
536 | ||
537 | sh Configure -Accflags='-DAPPLLIB_EXP=\"/usr/libperl\"' | |
538 | ||
539 | The directories defined by APPLLIB_EXP get added to @INC I<first>, | |
540 | ahead of any others, and so provide a way to override the standard perl | |
541 | modules should you, for example, want to distribute fixes without | |
542 | touching the perl distribution proper. And, like otherlib dirs, | |
543 | version and architecture specific subdirectories are also searched, if | |
544 | present, at run time. Of course, you can still search other @INC | |
545 | directories ahead of those in APPLLIB_EXP by using any of the standard | |
546 | run-time methods: $PERLLIB, $PERL5LIB, -I, use lib, etc. | |
547 | ||
d6baa268 | 548 | =item Man Pages |
1ec51d55 | 549 | |
d6baa268 JH |
550 | In versions 5.005_57 and earlier, the default was to store module man |
551 | pages in a version-specific directory, such as | |
552 | /usr/local/lib/perl5/$version/man/man3. The default for 5.005_58 and | |
553 | after is /usr/local/man/man3 so that most users can find the man pages | |
554 | without resetting MANPATH. | |
4633a7c4 | 555 | |
d6baa268 | 556 | You can continue to use the old default from the command line with |
4633a7c4 | 557 | |
fe23a901 | 558 | sh Configure -Dman3dir=/usr/local/lib/perl5/5.8.0/man/man3 |
8d74ce1c | 559 | |
d6baa268 JH |
560 | Some users also prefer to use a .3pm suffix. You can do that with |
561 | ||
562 | sh Configure -Dman3ext=3pm | |
563 | ||
564 | Again, these are just the defaults, and can be changed as you run | |
565 | Configure. | |
566 | ||
567 | =item HTML pages | |
568 | ||
cc65bb49 AD |
569 | Currently, the standard perl installation does not do anything with |
570 | HTML documentation, but that may change in the future. Further, some | |
571 | add-on modules may wish to install HTML documents. The html Configure | |
572 | variables listed above are provided if you wish to specify where such | |
573 | documents should be placed. The default is "none", but will likely | |
574 | eventually change to something useful based on user feedback. | |
8d74ce1c | 575 | |
d6baa268 | 576 | =back |
8d74ce1c | 577 | |
3a6175e1 AD |
578 | Some users prefer to append a "/share" to $privlib and $sitelib |
579 | to emphasize that those directories can be shared among different | |
580 | architectures. | |
4633a7c4 | 581 | |
8d74ce1c AD |
582 | Note that these are just the defaults. You can actually structure the |
583 | directories any way you like. They don't even have to be on the same | |
584 | filesystem. | |
585 | ||
586 | Further details about the installation directories, maintenance and | |
587 | development subversions, and about supporting multiple versions are | |
588 | discussed in L<"Coexistence with earlier versions of perl5"> below. | |
589 | ||
590 | If you specify a prefix that contains the string "perl", then the | |
d6baa268 JH |
591 | library directory structure is slightly simplified. Instead of |
592 | suggesting $prefix/lib/perl5/, Configure will suggest $prefix/lib. | |
8d74ce1c | 593 | |
d6baa268 | 594 | Thus, for example, if you Configure with |
fe23a901 | 595 | -Dprefix=/opt/perl, then the default library directories for 5.8.0 are |
3a6175e1 | 596 | |
d6baa268 | 597 | Configure variable Default value |
fe23a901 RF |
598 | $privlib /opt/perl/lib/5.8.0 |
599 | $archlib /opt/perl/lib/5.8.0/$archname | |
600 | $sitelib /opt/perl/lib/site_perl/5.8.0 | |
601 | $sitearch /opt/perl/lib/site_perl/5.8.0/$archname | |
4633a7c4 | 602 | |
aa689395 | 603 | =head2 Changing the installation directory |
604 | ||
605 | Configure distinguishes between the directory in which perl (and its | |
606 | associated files) should be installed and the directory in which it | |
607 | will eventually reside. For most sites, these two are the same; for | |
608 | sites that use AFS, this distinction is handled automatically. | |
1ec51d55 | 609 | However, sites that use software such as depot to manage software |
d6baa268 JH |
610 | packages, or users building binary packages for distribution may also |
611 | wish to install perl into a different directory and use that | |
612 | management software to move perl to its final destination. This | |
613 | section describes how to do that. | |
aa689395 | 614 | |
0dcb58f4 | 615 | Suppose you want to install perl under the /tmp/perl5 directory. You |
d6baa268 JH |
616 | could edit config.sh and change all the install* variables to point to |
617 | /tmp/perl5 instead of /usr/local, or you could simply use the | |
618 | following command line: | |
619 | ||
620 | sh Configure -Dinstallprefix=/tmp/perl5 | |
621 | ||
622 | (replace /tmp/perl5 by a directory of your choice). | |
aa689395 | 623 | |
693762b4 | 624 | Beware, though, that if you go to try to install new add-on |
d6baa268 | 625 | modules, they too will get installed in under '/tmp/perl5' if you |
693762b4 AD |
626 | follow this example. The next section shows one way of dealing with |
627 | that problem. | |
628 | ||
aa689395 | 629 | =head2 Creating an installable tar archive |
630 | ||
631 | If you need to install perl on many identical systems, it is | |
632 | convenient to compile it once and create an archive that can be | |
d6c1b5d3 AD |
633 | installed on multiple systems. Suppose, for example, that you want to |
634 | create an archive that can be installed in /opt/perl. | |
635 | Here's one way to do that: | |
aa689395 | 636 | |
d6baa268 | 637 | # Set up to install perl into a different directory, |
aa689395 | 638 | # e.g. /tmp/perl5 (see previous part). |
d6baa268 | 639 | sh Configure -Dinstallprefix=/tmp/perl5 -Dprefix=/opt/perl -des |
aa689395 | 640 | make |
641 | make test | |
d6c1b5d3 | 642 | make install # This will install everything into /tmp/perl5. |
aa689395 | 643 | cd /tmp/perl5 |
d6c1b5d3 | 644 | # Edit $archlib/Config.pm and $archlib/.packlist to change all the |
fb73857a | 645 | # install* variables back to reflect where everything will |
d6c1b5d3 AD |
646 | # really be installed. (That is, change /tmp/perl5 to /opt/perl |
647 | # everywhere in those files.) | |
648 | # Check the scripts in $scriptdir to make sure they have the correct | |
bfb7748a | 649 | # #!/wherever/perl line. |
aa689395 | 650 | tar cvf ../perl5-archive.tar . |
651 | # Then, on each machine where you want to install perl, | |
d6c1b5d3 | 652 | cd /opt/perl # Or wherever you specified as $prefix |
aa689395 | 653 | tar xvf perl5-archive.tar |
654 | ||
f73bace3 JH |
655 | Alternatively, the DESTDIR variable is honored during C<make install>. |
656 | The DESTDIR is automatically prepended to all the installation paths | |
657 | (and there is no need to edit anything). With DESTDIR, the above | |
658 | example can we written as: | |
2ee2a917 JH |
659 | |
660 | sh Configure -Dprefix=/opt/perl -des | |
661 | make | |
662 | make test | |
663 | make install DESTDIR=/tmp/perl5 | |
664 | cd /tmp/perl5/opt/perl | |
665 | tar cvf /tmp/perl5-archive.tar . | |
666 | ||
dc45a647 | 667 | =head2 Site-wide Policy settings |
693762b4 AD |
668 | |
669 | After Configure runs, it stores a number of common site-wide "policy" | |
670 | answers (such as installation directories and the local perl contact | |
671 | person) in the Policy.sh file. If you want to build perl on another | |
672 | system using the same policy defaults, simply copy the Policy.sh file | |
673 | to the new system and Configure will use it along with the appropriate | |
674 | hint file for your system. | |
675 | ||
dc45a647 MB |
676 | Alternatively, if you wish to change some or all of those policy |
677 | answers, you should | |
678 | ||
679 | rm -f Policy.sh | |
680 | ||
681 | to ensure that Configure doesn't re-use them. | |
682 | ||
683 | Further information is in the Policy_sh.SH file itself. | |
684 | ||
8d74ce1c AD |
685 | If the generated Policy.sh file is unsuitable, you may freely edit it |
686 | to contain any valid shell commands. It will be run just after the | |
687 | platform-specific hints files. | |
688 | ||
aa689395 | 689 | =head2 Configure-time Options |
690 | ||
691 | There are several different ways to Configure and build perl for your | |
692 | system. For most users, the defaults are sensible and will work. | |
693 | Some users, however, may wish to further customize perl. Here are | |
694 | some of the main things you can change. | |
695 | ||
693762b4 | 696 | =head2 Threads |
aa689395 | 697 | |
cc65bb49 AD |
698 | On some platforms, perl can be compiled with |
699 | support for threads. To enable this, run | |
f7542a9d | 700 | |
693762b4 | 701 | sh Configure -Dusethreads |
aa689395 | 702 | |
693762b4 AD |
703 | Currently, you need to specify -Dusethreads on the Configure command |
704 | line so that the hint files can make appropriate adjustments. | |
705 | ||
706 | The default is to compile without thread support. | |
3fe9a6f1 | 707 | |
6d5328bc JH |
708 | Perl has two different internal threads implementations. The current |
709 | model (available internally since 5.6, and as a user-level module | |
710 | since 5.8) is called interpreter-based implementation (ithreads), | |
711 | with one interpreter per thread, and explicit sharing of data. | |
aaacdc8b | 712 | |
6d5328bc JH |
713 | The 5.005 version (5005threads) is considered obsolete, buggy, and |
714 | unmaintained. | |
715 | ||
716 | By default, Configure selects ithreads if -Dusethreads is specified. | |
aaacdc8b | 717 | |
cc65bb49 | 718 | (You need to also use the PerlIO layer, explained later, if you decide |
b29b105d JH |
719 | to use ithreads, to guarantee the good interworking of threads and I/O.) |
720 | ||
cc65bb49 | 721 | However, if you wish, you can select the unsupported old 5005threads behavior |
aaacdc8b | 722 | |
6d5328bc JH |
723 | sh Configure -Dusethreads -Duse5005threads |
724 | ||
725 | If you decide to use ithreads, the 'threads' module allows their use, | |
726 | and the 'Thread' module offers an interface to both 5005threads and | |
727 | ithreads (whichever has been configured). | |
aaacdc8b | 728 | |
5b7ea690 JH |
729 | When building threaded for certain library calls like the getgr*() and |
730 | the getpw*() there is a dynamically sized result buffer: the buffer | |
731 | starts small but Perl will keep growing the buffer until the result fits. | |
732 | To get a fixed upper limit you will have to recompile Perl with | |
733 | PERL_REENTRANT_MAXSIZE defined to be the number of bytes you want. | |
734 | One way to do this is to run Configure with | |
735 | C<-Accflags=-DPERL_REENTRANT_MAXSIZE=65536> | |
736 | ||
766b63c4 JH |
737 | =head2 Large file support. |
738 | ||
5cda700b | 739 | Since Perl 5.6.0, Perl has supported large files (files larger than |
766b63c4 JH |
740 | 2 gigabytes), and in many common platforms like Linux or Solaris this |
741 | support is on by default. | |
742 | ||
743 | This is both good and bad. It is good in that you can use large files, | |
5cda700b AD |
744 | seek(), stat(), and -s them. It is bad in that if you are interfacing Perl |
745 | using some extension, the components you are connecting to must also | |
766b63c4 JH |
746 | be large file aware: if Perl thinks files can be large but the other |
747 | parts of the software puzzle do not understand the concept, bad things | |
748 | will happen. One popular extension suffering from this ailment is the | |
749 | Apache extension mod_perl. | |
750 | ||
751 | There's also one known limitation with the current large files | |
752 | implementation: unless you also have 64-bit integers (see the next | |
753 | section), you cannot use the printf/sprintf non-decimal integer | |
754 | formats like C<%x> to print filesizes. You can use C<%d>, though. | |
755 | ||
9d5a2765 A |
756 | =head2 64 bit support. |
757 | ||
766b63c4 JH |
758 | If your platform does not have 64 bits natively, but can simulate them |
759 | with compiler flags and/or C<long long> or C<int64_t>, you can build a | |
760 | perl that uses 64 bits. | |
9d5a2765 A |
761 | |
762 | There are actually two modes of 64-bitness: the first one is achieved | |
763 | using Configure -Duse64bitint and the second one using Configure | |
764 | -Duse64bitall. The difference is that the first one is minimal and | |
765 | the second one maximal. The first works in more places than the second. | |
766 | ||
767 | The C<use64bitint> does only as much as is required to get 64-bit | |
768 | integers into Perl (this may mean, for example, using "long longs") | |
769 | while your memory may still be limited to 2 gigabytes (because your | |
770 | pointers could still be 32-bit). Note that the name C<64bitint> does | |
771 | not imply that your C compiler will be using 64-bit C<int>s (it might, | |
772 | but it doesn't have to): the C<use64bitint> means that you will be | |
773 | able to have 64 bits wide scalar values. | |
774 | ||
775 | The C<use64bitall> goes all the way by attempting to switch also | |
776 | integers (if it can), longs (and pointers) to being 64-bit. This may | |
777 | create an even more binary incompatible Perl than -Duse64bitint: the | |
778 | resulting executable may not run at all in a 32-bit box, or you may | |
779 | have to reboot/reconfigure/rebuild your operating system to be 64-bit | |
780 | aware. | |
781 | ||
782 | Natively 64-bit systems like Alpha and Cray need neither -Duse64bitint | |
783 | nor -Duse64bitall. | |
784 | ||
785 | NOTE: 64-bit support is still experimental on most platforms. | |
786 | Existing support only covers the LP64 data model. In particular, the | |
787 | LLP64 data model is not yet supported. 64-bit libraries and system | |
788 | APIs on many platforms have not stabilized--your mileage may vary. | |
789 | ||
790 | =head2 Long doubles | |
791 | ||
792 | In some systems you may be able to use long doubles to enhance the | |
793 | range and precision of your double precision floating point numbers | |
794 | (that is, Perl's numbers). Use Configure -Duselongdouble to enable | |
795 | this support (if it is available). | |
796 | ||
797 | =head2 "more bits" | |
798 | ||
799 | You can "Configure -Dusemorebits" to turn on both the 64-bit support | |
800 | and the long double support. | |
801 | ||
46bb10fb CS |
802 | =head2 Selecting File IO mechanisms |
803 | ||
365d6a78 | 804 | Executive summary: in Perl 5.8, you should use the default "PerlIO" |
dd2bab0f JH |
805 | as the IO mechanism unless you have a good reason not to. |
806 | ||
807 | In more detail: previous versions of perl used the standard IO | |
808 | mechanisms as defined in stdio.h. Versions 5.003_02 and later of perl | |
365d6a78 PN |
809 | introduced alternate IO mechanisms via a "PerlIO" abstraction, but up |
810 | until and including Perl 5.6, the stdio mechanism was still the default | |
811 | and the only supported mechanism. | |
46bb10fb | 812 | |
365d6a78 | 813 | Starting from Perl 5.8, the default mechanism is to use the PerlIO |
6d5328bc JH |
814 | abstraction, because it allows better control of I/O mechanisms, |
815 | instead of having to work with (often, work around) vendors' I/O | |
816 | implementations. | |
46bb10fb | 817 | |
365d6a78 PN |
818 | This PerlIO abstraction can be (but again, unless you know what you |
819 | are doing, should not be) disabled either on the Configure command | |
820 | line with | |
46bb10fb | 821 | |
6d5328bc | 822 | sh Configure -Uuseperlio |
46bb10fb | 823 | |
6d5328bc | 824 | or interactively at the appropriate Configure prompt. |
46bb10fb | 825 | |
6d5328bc JH |
826 | With the PerlIO abstraction layer, there is another possibility for |
827 | the underlying IO calls, AT&T's "sfio". This has superior performance | |
828 | to stdio.h in many cases, and is extensible by the use of "discipline" | |
829 | modules ("Native" PerlIO has them too). Sfio currently only builds on | |
830 | a subset of the UNIX platforms perl supports. Because the data | |
831 | structures are completely different from stdio, perl extension modules | |
832 | or external libraries may not work. This configuration exists to | |
833 | allow these issues to be worked on. | |
46bb10fb CS |
834 | |
835 | This option requires the 'sfio' package to have been built and installed. | |
1b9c9cf5 | 836 | The latest sfio is available from http://www.research.att.com/sw/tools/sfio/ |
46bb10fb CS |
837 | |
838 | You select this option by | |
839 | ||
840 | sh Configure -Duseperlio -Dusesfio | |
841 | ||
842 | If you have already selected -Duseperlio, and if Configure detects | |
843 | that you have sfio, then sfio will be the default suggested by | |
844 | Configure. | |
845 | ||
d6baa268 JH |
846 | Note: On some systems, sfio's iffe configuration script fails to |
847 | detect that you have an atexit function (or equivalent). Apparently, | |
848 | this is a problem at least for some versions of Linux and SunOS 4. | |
849 | Configure should detect this problem and warn you about problems with | |
850 | _exit vs. exit. If you have this problem, the fix is to go back to | |
851 | your sfio sources and correct iffe's guess about atexit. | |
33e6ee5f | 852 | |
c71f9582 PN |
853 | =head2 Algorithmic Complexity Attacks on Hashes |
854 | ||
855 | In Perls 5.8.0 and earlier it was easy to create degenerate hashes. | |
856 | Processing such hashes would consume large amounts of CPU time, | |
1aa6899f | 857 | enabling a "Denial of Service" attack against Perl. Such hashes may be |
c71f9582 PN |
858 | a problem for example for mod_perl sites, sites with Perl CGI scripts |
859 | and web services, that process data originating from external sources. | |
860 | ||
861 | In Perl 5.8.1 a security feature was introduced to make it harder | |
862 | to create such degenerate hashes. | |
863 | ||
a8770bf5 JH |
864 | Because of this feature the keys(), values(), and each() functions may |
865 | return the hash elements in different order between different runs of | |
866 | Perl even with the same data. One can still revert to the old | |
aa69cd32 | 867 | repeatable order by setting the environment variable PERL_HASH_SEED, |
a8770bf5 JH |
868 | see L<perlrun/PERL_HASH_SEED>. Another option is to add |
869 | -DUSE_HASH_SEED_EXPLICIT to the compilation flags (for example by | |
870 | using C<Configure -Accflags=-DUSE_HAS_SEED_EXPLICIT>), in which case | |
871 | one has to explicitly set the PERL_HASH_SEED environment variable to | |
872 | enable the security feature, or by adding -DNO_HASH_SEED to the compilation | |
873 | flags to completely disable the randomisation feature. | |
c71f9582 | 874 | |
1aa6899f | 875 | B<Perl has never guaranteed any ordering of the hash keys>, and the |
c71f9582 | 876 | ordering has already changed several times during the lifetime of |
1aa6899f JH |
877 | Perl 5. Also, the ordering of hash keys has always been, and |
878 | continues to be, affected by the insertion order. | |
c71f9582 PN |
879 | |
880 | Note that because of this randomisation for example the Data::Dumper | |
881 | results will be different between different runs of Perl since | |
882 | Data::Dumper by default dumps hashes "unordered". The use of the | |
1aa6899f | 883 | Data::Dumper C<Sortkeys> option is recommended. |
c71f9582 | 884 | |
1b9c9cf5 DH |
885 | =head2 SOCKS |
886 | ||
887 | Perl can be configured to be 'socksified', that is, to use the SOCKS | |
888 | TCP/IP proxy protocol library. SOCKS is used to give applications | |
889 | access to transport layer network proxies. Perl supports only SOCKS | |
890 | Version 5. You can find more about SOCKS from http://www.socks.nec.com/ | |
891 | ||
d6baa268 JH |
892 | =head2 Dynamic Loading |
893 | ||
894 | By default, Configure will compile perl to use dynamic loading if | |
895 | your system supports it. If you want to force perl to be compiled | |
896 | statically, you can either choose this when Configure prompts you or | |
897 | you can use the Configure command line option -Uusedl. | |
898 | ||
10c7e831 | 899 | =head2 Building a shared Perl library |
c3edaffb | 900 | |
901 | Currently, for most systems, the main perl executable is built by | |
902 | linking the "perl library" libperl.a with perlmain.o, your static | |
903 | extensions (usually just DynaLoader.a) and various extra libraries, | |
904 | such as -lm. | |
905 | ||
9d67150a | 906 | On some systems that support dynamic loading, it may be possible to |
907 | replace libperl.a with a shared libperl.so. If you anticipate building | |
c3edaffb | 908 | several different perl binaries (e.g. by embedding libperl into |
909 | different programs, or by using the optional compiler extension), then | |
9d67150a | 910 | you might wish to build a shared libperl.so so that all your binaries |
c3edaffb | 911 | can share the same library. |
912 | ||
913 | The disadvantages are that there may be a significant performance | |
9d67150a | 914 | penalty associated with the shared libperl.so, and that the overall |
aa689395 | 915 | mechanism is still rather fragile with respect to different versions |
c3edaffb | 916 | and upgrades. |
917 | ||
918 | In terms of performance, on my test system (Solaris 2.5_x86) the perl | |
9d67150a | 919 | test suite took roughly 15% longer to run with the shared libperl.so. |
c3edaffb | 920 | Your system and typical applications may well give quite different |
921 | results. | |
922 | ||
923 | The default name for the shared library is typically something like | |
a6006777 | 924 | libperl.so.3.2 (for Perl 5.003_02) or libperl.so.302 or simply |
9d67150a | 925 | libperl.so. Configure tries to guess a sensible naming convention |
c3edaffb | 926 | based on your C library name. Since the library gets installed in a |
927 | version-specific architecture-dependent directory, the exact name | |
928 | isn't very important anyway, as long as your linker is happy. | |
929 | ||
930 | For some systems (mostly SVR4), building a shared libperl is required | |
931 | for dynamic loading to work, and hence is already the default. | |
932 | ||
933 | You can elect to build a shared libperl by | |
934 | ||
935 | sh Configure -Duseshrplib | |
936 | ||
2bf2710f GS |
937 | To build a shared libperl, the environment variable controlling shared |
938 | library search (LD_LIBRARY_PATH in most systems, DYLD_LIBRARY_PATH for | |
78be1e1a JH |
939 | NeXTSTEP/OPENSTEP/Darwin, LIBRARY_PATH for BeOS, LD_LIBRARY_PATH/SHLIB_PATH |
940 | for HP-UX, LIBPATH for AIX, PATH for Cygwin) must be set up to include | |
2bf2710f | 941 | the Perl build directory because that's where the shared libperl will |
d6baa268 | 942 | be created. Configure arranges makefile to have the correct shared |
10c7e831 JH |
943 | library search settings. You can find the name of the environment |
944 | variable Perl thinks works in your your system by | |
945 | ||
946 | grep ldlibpthname config.sh | |
2bf2710f GS |
947 | |
948 | However, there are some special cases where manually setting the | |
949 | shared library path might be required. For example, if you want to run | |
950 | something like the following with the newly-built but not-yet-installed | |
951 | ./perl: | |
952 | ||
953 | cd t; ./perl misc/failing_test.t | |
954 | or | |
955 | ./perl -Ilib ~/my_mission_critical_test | |
956 | ||
957 | then you need to set up the shared library path explicitly. | |
958 | You can do this with | |
c3edaffb | 959 | |
960 | LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH | |
961 | ||
962 | for Bourne-style shells, or | |
963 | ||
964 | setenv LD_LIBRARY_PATH `pwd` | |
965 | ||
2bf2710f | 966 | for Csh-style shells. (This procedure may also be needed if for some |
10c7e831 | 967 | unexpected reason Configure fails to set up makefile correctly.) (And |
5cda700b | 968 | again, it may be something other than LD_LIBRARY_PATH for you, see above.) |
2bf2710f GS |
969 | |
970 | You can often recognize failures to build/use a shared libperl from error | |
971 | messages complaining about a missing libperl.so (or libperl.sl in HP-UX), | |
972 | for example: | |
973 | 18126:./miniperl: /sbin/loader: Fatal Error: cannot map libperl.so | |
c3edaffb | 974 | |
9d67150a | 975 | There is also an potential problem with the shared perl library if you |
976 | want to have more than one "flavor" of the same version of perl (e.g. | |
977 | with and without -DDEBUGGING). For example, suppose you build and | |
cc65bb49 AD |
978 | install a standard Perl 5.8.0 with a shared library. Then, suppose you |
979 | try to build Perl 5.8.0 with -DDEBUGGING enabled, but everything else | |
9d67150a | 980 | the same, including all the installation directories. How can you |
981 | ensure that your newly built perl will link with your newly built | |
cc65bb49 | 982 | libperl.so.8 rather with the installed libperl.so.8? The answer is |
9d67150a | 983 | that you might not be able to. The installation directory is encoded |
56c6f531 JH |
984 | in the perl binary with the LD_RUN_PATH environment variable (or |
985 | equivalent ld command-line option). On Solaris, you can override that | |
68da2b4b JH |
986 | with LD_LIBRARY_PATH; on Linux, you can only override at runtime via |
987 | LD_PRELOAD, specifying the exact filename you wish to be used; and on | |
988 | Digital Unix, you can override LD_LIBRARY_PATH by setting the | |
989 | _RLD_ROOT environment variable to point to the perl build directory. | |
9d67150a | 990 | |
4e58e0cf JH |
991 | In other words, it is generally not a good idea to try to build a perl |
992 | with a shared library if $archlib/CORE/$libperl already exists from a | |
993 | previous build. | |
994 | ||
995 | A good workaround is to specify a different directory for the | |
996 | architecture-dependent library for your -DDEBUGGING version of perl. | |
997 | You can do this by changing all the *archlib* variables in config.sh to | |
998 | point to your new architecture-dependent library. | |
9d67150a | 999 | |
55479bb6 AD |
1000 | =head2 Malloc Issues |
1001 | ||
d6baa268 JH |
1002 | Perl relies heavily on malloc(3) to grow data structures as needed, |
1003 | so perl's performance can be noticeably affected by the performance of | |
1004 | the malloc function on your system. The perl source is shipped with a | |
1005 | version of malloc that has been optimized for the typical requests from | |
1006 | perl, so there's a chance that it may be both faster and use less memory | |
1007 | than your system malloc. | |
55479bb6 | 1008 | |
d6baa268 JH |
1009 | However, if your system already has an excellent malloc, or if you are |
1010 | experiencing difficulties with extensions that use third-party libraries | |
1011 | that call malloc, then you should probably use your system's malloc. | |
1012 | (Or, you might wish to explore the malloc flags discussed below.) | |
c3edaffb | 1013 | |
aa689395 | 1014 | =over 4 |
1015 | ||
d6baa268 | 1016 | =item Using the system malloc |
2ae324a7 | 1017 | |
d6baa268 | 1018 | To build without perl's malloc, you can use the Configure command |
aa689395 | 1019 | |
d6baa268 | 1020 | sh Configure -Uusemymalloc |
aa689395 | 1021 | |
d6baa268 | 1022 | or you can answer 'n' at the appropriate interactive Configure prompt. |
aa689395 | 1023 | |
86058a2d GS |
1024 | =item -DPERL_POLLUTE_MALLOC |
1025 | ||
d953f698 JH |
1026 | NOTE: This flag is enabled automatically on some platforms if you just |
1027 | run Configure to accept all the defaults on those platforms. | |
b2a6d19e | 1028 | |
5cda700b AD |
1029 | Perl's malloc family of functions are normally called Perl_malloc(), |
1030 | Perl_realloc(), Perl_calloc() and Perl_mfree(). | |
1031 | These names do not clash with the system versions of these functions. | |
d6baa268 | 1032 | |
5cda700b AD |
1033 | If this flag is enabled, however, Perl's malloc family of functions |
1034 | will have the same names as the system versions. This may be required | |
1035 | sometimes if you have libraries that like to free() data that may have | |
1036 | been allocated by Perl_malloc() and vice versa. | |
86058a2d | 1037 | |
d6baa268 JH |
1038 | Note that enabling this option may sometimes lead to duplicate symbols |
1039 | from the linker for malloc et al. In such cases, the system probably | |
1040 | does not allow its malloc functions to be fully replaced with custom | |
1041 | versions. | |
86058a2d | 1042 | |
e3b9cd39 JH |
1043 | =item -DPERL_DEBUGGING_MSTATS |
1044 | ||
1045 | This flag enables debugging mstats, which is required to use the | |
1046 | Devel::Peek::mstat() function. You cannot enable this unless you are | |
1047 | using Perl's malloc, so a typical Configure command would be | |
1048 | ||
67bae6b3 | 1049 | sh Configure -Accflags=-DPERL_DEBUGGING_MSTATS -Dusemymalloc='y' |
e3b9cd39 JH |
1050 | |
1051 | to enable this option. | |
1052 | ||
aa689395 | 1053 | =back |
1054 | ||
3bf462b8 CS |
1055 | =head2 Building a debugging perl |
1056 | ||
1057 | You can run perl scripts under the perl debugger at any time with | |
3fe9a6f1 | 1058 | B<perl -d your_script>. If, however, you want to debug perl itself, |
3bf462b8 CS |
1059 | you probably want to do |
1060 | ||
1061 | sh Configure -Doptimize='-g' | |
1062 | ||
203c3eec AD |
1063 | This will do two independent things: First, it will force compilation |
1064 | to use cc -g so that you can use your system's debugger on the | |
1065 | executable. (Note: Your system may actually require something like | |
d6baa268 JH |
1066 | cc -g2. Check your man pages for cc(1) and also any hint file for |
1067 | your system.) Second, it will add -DDEBUGGING to your ccflags | |
1068 | variable in config.sh so that you can use B<perl -D> to access perl's | |
1069 | internal state. (Note: Configure will only add -DDEBUGGING by default | |
1070 | if you are not reusing your old config.sh. If you want to reuse your | |
1071 | old config.sh, then you can just edit it and change the optimize and | |
1072 | ccflags variables by hand and then propagate your changes as shown in | |
1073 | L<"Propagating your changes to config.sh"> below.) | |
203c3eec AD |
1074 | |
1075 | You can actually specify -g and -DDEBUGGING independently, but usually | |
1076 | it's convenient to have both. | |
3bf462b8 CS |
1077 | |
1078 | If you are using a shared libperl, see the warnings about multiple | |
1079 | versions of perl under L<Building a shared libperl.so Perl library>. | |
1080 | ||
8d74ce1c AD |
1081 | =head2 Extensions |
1082 | ||
80c1f5de AD |
1083 | Perl ships with a number of standard extensions. These are contained |
1084 | in the ext/ subdirectory. | |
1085 | ||
8d74ce1c AD |
1086 | By default, Configure will offer to build every extension which appears |
1087 | to be supported. For example, Configure will offer to build GDBM_File | |
1088 | only if it is able to find the gdbm library. (See examples below.) | |
8d74ce1c AD |
1089 | Configure does not contain code to test for POSIX compliance, so POSIX |
1090 | is always built by default as well. If you wish to skip POSIX, you can | |
1091 | set the Configure variable useposix=false either in a hint file or from | |
80c1f5de | 1092 | the Configure command line. |
8d74ce1c | 1093 | |
c42e3e15 GS |
1094 | If you unpack any additional extensions in the ext/ directory before |
1095 | running Configure, then Configure will offer to build those additional | |
1096 | extensions as well. Most users probably shouldn't have to do this -- | |
1097 | it is usually easier to build additional extensions later after perl | |
1098 | has been installed. However, if you wish to have those additional | |
1099 | extensions statically linked into the perl binary, then this offers a | |
1100 | convenient way to do that in one step. (It is not necessary, however; | |
1101 | you can build and install extensions just fine even if you don't have | |
1102 | dynamic loading. See lib/ExtUtils/MakeMaker.pm for more details.) | |
1103 | ||
1104 | You can learn more about each of the supplied extensions by consulting the | |
8d74ce1c AD |
1105 | documentation in the individual .pm modules, located under the |
1106 | ext/ subdirectory. | |
1107 | ||
1108 | Even if you do not have dynamic loading, you must still build the | |
1109 | DynaLoader extension; you should just build the stub dl_none.xs | |
1110 | version. (Configure will suggest this as the default.) | |
1111 | ||
5a29c6bc JH |
1112 | To disable certain extensions so that they are not built, use |
1113 | the -Dnoextensions=... and -Donlyextensions=... options. They both | |
1114 | accept a space-separated list of extensions. The extensions listed | |
1115 | in C<noextensions> are removed from the list of extensions to build, | |
1116 | while the C<onlyextensions> is rather more severe and builds only | |
1117 | the listed extensions. The latter should be used with extreme caution | |
1118 | since certain extensions are used by many other extensions and modules: | |
1119 | such modules include Fcntl and IO. The order of processing these | |
1120 | options is first C<only> (if present), then C<no> (if present). | |
1121 | ||
1122 | Another, older way to turn off various extensions (which is still good | |
1123 | to know if you have to work with older Perl) exists. Here are the | |
1124 | Configure command-line variables you can set to turn off various | |
1125 | extensions. All others are included by default. | |
8d74ce1c | 1126 | |
8d74ce1c AD |
1127 | DB_File i_db |
1128 | DynaLoader (Must always be included as a static extension) | |
8d74ce1c | 1129 | GDBM_File i_gdbm |
8d74ce1c AD |
1130 | NDBM_File i_ndbm |
1131 | ODBM_File i_dbm | |
1132 | POSIX useposix | |
8d74ce1c AD |
1133 | Opcode useopcode |
1134 | Socket d_socket | |
a2dab6bc | 1135 | Threads use5005threads |
8d74ce1c AD |
1136 | |
1137 | Thus to skip the NDBM_File extension, you can use | |
1138 | ||
1139 | sh Configure -Ui_ndbm | |
1140 | ||
1141 | Again, this is taken care of automatically if you don't have the ndbm | |
1142 | library. | |
1143 | ||
1144 | Of course, you may always run Configure interactively and select only | |
1145 | the extensions you want. | |
1146 | ||
1147 | Note: The DB_File module will only work with version 1.x of Berkeley | |
1148 | DB or newer releases of version 2. Configure will automatically detect | |
1149 | this for you and refuse to try to build DB_File with earlier | |
1150 | releases of version 2. | |
1151 | ||
1152 | If you re-use your old config.sh but change your system (e.g. by | |
1153 | adding libgdbm) Configure will still offer your old choices of extensions | |
1154 | for the default answer, but it will also point out the discrepancy to | |
1155 | you. | |
1156 | ||
80c1f5de | 1157 | Finally, if you have dynamic loading (most modern systems do) |
8d74ce1c AD |
1158 | remember that these extensions do not increase the size of your perl |
1159 | executable, nor do they impact start-up time, so you probably might as | |
1160 | well build all the ones that will work on your system. | |
1161 | ||
1162 | =head2 Including locally-installed libraries | |
1163 | ||
1164 | Perl5 comes with interfaces to number of database extensions, including | |
1165 | dbm, ndbm, gdbm, and Berkeley db. For each extension, if | |
1166 | Configure can find the appropriate header files and libraries, it will | |
1167 | automatically include that extension. The gdbm and db libraries | |
1168 | are not included with perl. See the library documentation for | |
1169 | how to obtain the libraries. | |
1170 | ||
d6baa268 JH |
1171 | If your database header (.h) files are not in a directory normally |
1172 | searched by your C compiler, then you will need to include the | |
1173 | appropriate -I/your/directory option when prompted by Configure. If | |
1174 | your database library (.a) files are not in a directory normally | |
1175 | searched by your C compiler and linker, then you will need to include | |
1176 | the appropriate -L/your/directory option when prompted by Configure. | |
1177 | See the examples below. | |
8d74ce1c AD |
1178 | |
1179 | =head2 Examples | |
1180 | ||
1181 | =over 4 | |
1182 | ||
1183 | =item gdbm in /usr/local | |
1184 | ||
1185 | Suppose you have gdbm and want Configure to find it and build the | |
d6baa268 | 1186 | GDBM_File extension. This example assumes you have gdbm.h |
8d74ce1c AD |
1187 | installed in /usr/local/include/gdbm.h and libgdbm.a installed in |
1188 | /usr/local/lib/libgdbm.a. Configure should figure all the | |
1189 | necessary steps out automatically. | |
1190 | ||
1191 | Specifically, when Configure prompts you for flags for | |
1192 | your C compiler, you should include -I/usr/local/include. | |
1193 | ||
1194 | When Configure prompts you for linker flags, you should include | |
1195 | -L/usr/local/lib. | |
1196 | ||
1197 | If you are using dynamic loading, then when Configure prompts you for | |
1198 | linker flags for dynamic loading, you should again include | |
1199 | -L/usr/local/lib. | |
1200 | ||
d6baa268 JH |
1201 | Again, this should all happen automatically. This should also work if |
1202 | you have gdbm installed in any of (/usr/local, /opt/local, /usr/gnu, | |
1203 | /opt/gnu, /usr/GNU, or /opt/GNU). | |
8d74ce1c AD |
1204 | |
1205 | =item gdbm in /usr/you | |
1206 | ||
1207 | Suppose you have gdbm installed in some place other than /usr/local/, | |
1208 | but you still want Configure to find it. To be specific, assume you | |
1209 | have /usr/you/include/gdbm.h and /usr/you/lib/libgdbm.a. You | |
1210 | still have to add -I/usr/you/include to cc flags, but you have to take | |
1211 | an extra step to help Configure find libgdbm.a. Specifically, when | |
1212 | Configure prompts you for library directories, you have to add | |
1213 | /usr/you/lib to the list. | |
1214 | ||
1215 | It is possible to specify this from the command line too (all on one | |
1216 | line): | |
1217 | ||
d6baa268 | 1218 | sh Configure -de \ |
8d74ce1c AD |
1219 | -Dlocincpth="/usr/you/include" \ |
1220 | -Dloclibpth="/usr/you/lib" | |
1221 | ||
1222 | locincpth is a space-separated list of include directories to search. | |
1223 | Configure will automatically add the appropriate -I directives. | |
1224 | ||
1225 | loclibpth is a space-separated list of library directories to search. | |
1226 | Configure will automatically add the appropriate -L directives. If | |
1227 | you have some libraries under /usr/local/ and others under | |
1228 | /usr/you, then you have to include both, namely | |
1229 | ||
d6baa268 | 1230 | sh Configure -de \ |
8d74ce1c AD |
1231 | -Dlocincpth="/usr/you/include /usr/local/include" \ |
1232 | -Dloclibpth="/usr/you/lib /usr/local/lib" | |
1233 | ||
1234 | =back | |
1235 | ||
bb636fa4 JH |
1236 | =head2 Building DB, NDBM, and ODBM interfaces with Berkeley DB 3 |
1237 | ||
1238 | Perl interface for DB3 is part of Berkeley DB, but if you want to | |
1239 | compile standard Perl DB/ODBM/NDBM interfaces, you must follow | |
1240 | following instructions. | |
1241 | ||
1242 | Berkeley DB3 from Sleepycat Software is by default installed without | |
1243 | DB1 compatibility code (needed for DB_File interface) and without | |
1244 | links to compatibility files. So if you want to use packages written | |
1245 | for DB/ODBM/NDBM interfaces, you need to configure DB3 with | |
1246 | --enable-compat185 (and optionally with --enable-dump185) and create | |
1247 | additional references (suppose you are installing DB3 with | |
1248 | --prefix=/usr): | |
1249 | ||
1250 | ln -s libdb-3.so /usr/lib/libdbm.so | |
1251 | ln -s libdb-3.so /usr/lib/libndbm.so | |
1252 | echo '#define DB_DBM_HSEARCH 1' >dbm.h | |
1253 | echo '#include <db.h>' >>dbm.h | |
1254 | install -m 0644 dbm.h /usr/include/dbm.h | |
1255 | install -m 0644 dbm.h /usr/include/ndbm.h | |
1256 | ||
1257 | Optionally, if you have compiled with --enable-compat185 (not needed | |
1258 | for ODBM/NDBM): | |
1259 | ||
1260 | ln -s libdb-3.so /usr/lib/libdb1.so | |
1261 | ln -s libdb-3.so /usr/lib/libdb.so | |
1262 | ||
1263 | ODBM emulation seems not to be perfect, but is quite usable, | |
1264 | using DB 3.1.17: | |
1265 | ||
1266 | lib/odbm.............FAILED at test 9 | |
1267 | Failed 1/64 tests, 98.44% okay | |
1268 | ||
8e07c86e AD |
1269 | =head2 What if it doesn't work? |
1270 | ||
8d74ce1c AD |
1271 | If you run into problems, try some of the following ideas. |
1272 | If none of them help, then see L<"Reporting Problems"> below. | |
1273 | ||
8e07c86e AD |
1274 | =over 4 |
1275 | ||
25f94b33 AD |
1276 | =item Running Configure Interactively |
1277 | ||
1278 | If Configure runs into trouble, remember that you can always run | |
1279 | Configure interactively so that you can check (and correct) its | |
1280 | guesses. | |
1281 | ||
1282 | All the installation questions have been moved to the top, so you don't | |
aa689395 | 1283 | have to wait for them. Once you've handled them (and your C compiler and |
1ec51d55 | 1284 | flags) you can type &-d at the next Configure prompt and Configure |
25f94b33 AD |
1285 | will use the defaults from then on. |
1286 | ||
1287 | If you find yourself trying obscure command line incantations and | |
1288 | config.over tricks, I recommend you run Configure interactively | |
1289 | instead. You'll probably save yourself time in the long run. | |
1290 | ||
aa689395 | 1291 | =item Hint files |
8e07c86e AD |
1292 | |
1293 | The perl distribution includes a number of system-specific hints files | |
1294 | in the hints/ directory. If one of them matches your system, Configure | |
1295 | will offer to use that hint file. | |
1296 | ||
1297 | Several of the hint files contain additional important information. | |
f5b3b617 AD |
1298 | If you have any problems, it is a good idea to read the relevant hint file |
1299 | for further information. See hints/solaris_2.sh for an extensive example. | |
1300 | More information about writing good hints is in the hints/README.hints | |
1301 | file. | |
8e07c86e | 1302 | |
edb1cbcb | 1303 | =item *** WHOA THERE!!! *** |
1304 | ||
1305 | Occasionally, Configure makes a wrong guess. For example, on SunOS | |
1306 | 4.1.3, Configure incorrectly concludes that tzname[] is in the | |
1307 | standard C library. The hint file is set up to correct for this. You | |
1308 | will see a message: | |
1309 | ||
1310 | *** WHOA THERE!!! *** | |
1311 | The recommended value for $d_tzname on this machine was "undef"! | |
1312 | Keep the recommended value? [y] | |
1313 | ||
1314 | You should always keep the recommended value unless, after reading the | |
1315 | relevant section of the hint file, you are sure you want to try | |
1316 | overriding it. | |
1317 | ||
1318 | If you are re-using an old config.sh, the word "previous" will be | |
1319 | used instead of "recommended". Again, you will almost always want | |
1320 | to keep the previous value, unless you have changed something on your | |
1321 | system. | |
1322 | ||
1323 | For example, suppose you have added libgdbm.a to your system | |
1324 | and you decide to reconfigure perl to use GDBM_File. When you run | |
1325 | Configure again, you will need to add -lgdbm to the list of libraries. | |
bfb7748a AD |
1326 | Now, Configure will find your gdbm include file and library and will |
1327 | issue a message: | |
edb1cbcb | 1328 | |
1329 | *** WHOA THERE!!! *** | |
1330 | The previous value for $i_gdbm on this machine was "undef"! | |
1331 | Keep the previous value? [y] | |
1332 | ||
1ec51d55 | 1333 | In this case, you do not want to keep the previous value, so you |
c3edaffb | 1334 | should answer 'n'. (You'll also have to manually add GDBM_File to |
edb1cbcb | 1335 | the list of dynamic extensions to build.) |
1336 | ||
8e07c86e AD |
1337 | =item Changing Compilers |
1338 | ||
1339 | If you change compilers or make other significant changes, you should | |
1ec51d55 | 1340 | probably not re-use your old config.sh. Simply remove it or |
8e07c86e AD |
1341 | rename it, e.g. mv config.sh config.sh.old. Then rerun Configure |
1342 | with the options you want to use. | |
1343 | ||
1ec51d55 CS |
1344 | This is a common source of problems. If you change from cc to |
1345 | gcc, you should almost always remove your old config.sh. | |
8e07c86e | 1346 | |
c3edaffb | 1347 | =item Propagating your changes to config.sh |
8e07c86e | 1348 | |
1ec51d55 CS |
1349 | If you make any changes to config.sh, you should propagate |
1350 | them to all the .SH files by running | |
1351 | ||
1352 | sh Configure -S | |
1353 | ||
1354 | You will then have to rebuild by running | |
9d67150a | 1355 | |
1356 | make depend | |
1357 | make | |
8e07c86e | 1358 | |
48370efc JH |
1359 | =item config.over and config.arch |
1360 | ||
1361 | You can also supply a shell script config.over to over-ride | |
1362 | Configure's guesses. It will get loaded up at the very end, just | |
1363 | before config.sh is created. You have to be careful with this, | |
1364 | however, as Configure does no checking that your changes make sense. | |
1365 | This file is usually good for site-specific customizations. | |
1366 | ||
1367 | There is also another file that, if it exists, is loaded before the | |
1368 | config.over, called config.arch. This file is intended to be per | |
1369 | architecture, not per site, and usually it's the architecture-specific | |
1370 | hints file that creates the config.arch. | |
8e07c86e AD |
1371 | |
1372 | =item config.h | |
1373 | ||
1ec51d55 CS |
1374 | Many of the system dependencies are contained in config.h. |
1375 | Configure builds config.h by running the config_h.SH script. | |
1376 | The values for the variables are taken from config.sh. | |
8e07c86e | 1377 | |
1ec51d55 CS |
1378 | If there are any problems, you can edit config.h directly. Beware, |
1379 | though, that the next time you run Configure, your changes will be | |
8e07c86e AD |
1380 | lost. |
1381 | ||
1382 | =item cflags | |
1383 | ||
1384 | If you have any additional changes to make to the C compiler command | |
1ec51d55 CS |
1385 | line, they can be made in cflags.SH. For instance, to turn off the |
1386 | optimizer on toke.c, find the line in the switch structure for | |
1387 | toke.c and put the command optimize='-g' before the ;; . You | |
1388 | can also edit cflags directly, but beware that your changes will be | |
1389 | lost the next time you run Configure. | |
8e07c86e | 1390 | |
f5b3b617 AD |
1391 | To explore various ways of changing ccflags from within a hint file, |
1392 | see the file hints/README.hints. | |
1393 | ||
1394 | To change the C flags for all the files, edit config.sh and change either | |
1395 | $ccflags or $optimize, and then re-run | |
1ec51d55 CS |
1396 | |
1397 | sh Configure -S | |
1398 | make depend | |
8e07c86e | 1399 | |
aa689395 | 1400 | =item No sh |
8e07c86e | 1401 | |
c42e3e15 GS |
1402 | If you don't have sh, you'll have to copy the sample file |
1403 | Porting/config.sh to config.sh and edit your config.sh to reflect your | |
1404 | system's peculiarities. See Porting/pumpkin.pod for more information. | |
8e07c86e AD |
1405 | You'll probably also have to extensively modify the extension building |
1406 | mechanism. | |
1407 | ||
d6baa268 JH |
1408 | =item Digital UNIX/Tru64 UNIX and BIN_SH |
1409 | ||
1410 | In Digital UNIX/Tru64 UNIX, Configure might abort with | |
1411 | ||
1412 | Build a threading Perl? [n] | |
1413 | Configure[2437]: Syntax error at line 1 : `config.sh' is not expected. | |
1414 | ||
1415 | This indicates that Configure is being run with a broken Korn shell | |
1416 | (even though you think you are using a Bourne shell by using | |
1417 | "sh Configure" or "./Configure"). The Korn shell bug has been reported | |
1418 | to Compaq as of February 1999 but in the meanwhile, the reason ksh is | |
1419 | being used is that you have the environment variable BIN_SH set to | |
1420 | 'xpg4'. This causes /bin/sh to delegate its duties to /bin/posix/sh | |
1421 | (a ksh). Unset the environment variable and rerun Configure. | |
1422 | ||
1423 | =item HP-UX 11, pthreads, and libgdbm | |
1424 | ||
1425 | If you are running Configure with -Dusethreads in HP-UX 11, be warned | |
1426 | that POSIX threads and libgdbm (the GNU dbm library) compiled before | |
1427 | HP-UX 11 do not mix. This will cause a basic test run by Configure to | |
1428 | fail | |
1429 | ||
1430 | Pthread internal error: message: __libc_reinit() failed, file: ../pthreads/pthread.c, line: 1096 | |
1431 | Return Pointer is 0xc082bf33 | |
1432 | sh: 5345 Quit(coredump) | |
1433 | ||
1434 | and Configure will give up. The cure is to recompile and install | |
1435 | libgdbm under HP-UX 11. | |
1436 | ||
c3edaffb | 1437 | =item Porting information |
1438 | ||
e6f03d26 | 1439 | Specific information for the OS/2, Plan 9, VMS and Win32 ports is in the |
1ec51d55 CS |
1440 | corresponding README files and subdirectories. Additional information, |
1441 | including a glossary of all those config.sh variables, is in the Porting | |
c42e3e15 | 1442 | subdirectory. Especially Porting/Glossary should come in handy. |
c3edaffb | 1443 | |
7f678428 | 1444 | Ports for other systems may also be available. You should check out |
468f45d5 | 1445 | http://www.cpan.org/ports for current information on ports to |
7f678428 | 1446 | various other operating systems. |
1447 | ||
491517e0 JA |
1448 | If you plan to port Perl to a new architecture study carefully the |
1449 | section titled "Philosophical Issues in Patching and Porting Perl" | |
1450 | in the file Porting/pumpkin.pod and the file Porting/patching.pod. | |
1451 | Study also how other non-UNIX ports have solved problems. | |
1452 | ||
8e07c86e AD |
1453 | =back |
1454 | ||
fadf0ef5 JH |
1455 | =head1 Adding extra modules to the build |
1456 | ||
1457 | You can specify extra modules or module bundles to be fetched from the | |
1458 | CPAN and installed as part of the Perl build. Either use the -Dextras=... | |
1459 | command line parameter to Configure, for example like this: | |
1460 | ||
1461 | Configure -Dextras="Compress::Zlib Bundle::LWP DBI" | |
1462 | ||
1463 | or answer first 'y' to the question 'Install any extra modules?' and | |
1464 | then answer "Compress::Zlib Bundle::LWP DBI" to the 'Extras?' question. | |
1465 | The module or the bundle names are as for the CPAN module 'install' command. | |
1466 | ||
1467 | Notice that because the CPAN module will be used to fetch the extra | |
1468 | modules, you will need access to the CPAN, either via the Internet, | |
1469 | or via a local copy such as a CD-ROM or a local CPAN mirror. If you | |
1470 | do not, using the extra modules option will die horribly. | |
1471 | ||
1472 | Also notice that you yourself are responsible for satisfying any extra | |
1473 | dependencies such as external headers or libraries BEFORE trying the build. | |
1474 | For example: you will need to have the zlib.h header and the libz | |
1475 | library installed for the Compress::Zlib, or the Foo database specific | |
1476 | headers and libraries installed for the DBD::Foo module. The Configure | |
1477 | process or the Perl build process will not help you with these. | |
1478 | ||
03739d21 JH |
1479 | =head1 suidperl |
1480 | ||
c80c8d62 | 1481 | suidperl is an optional component, which is built or installed by default. |
03739d21 JH |
1482 | From perlfaq1: |
1483 | ||
1484 | On some systems, setuid and setgid scripts (scripts written | |
1485 | in the C shell, Bourne shell, or Perl, for example, with the | |
1486 | set user or group ID permissions enabled) are insecure due to | |
1487 | a race condition in the kernel. For those systems, Perl versions | |
1488 | 5 and 4 attempt to work around this vulnerability with an optional | |
1489 | component, a special program named suidperl, also known as sperl. | |
1490 | This program attempts to emulate the set-user-ID and set-group-ID | |
1491 | features of the kernel. | |
1492 | ||
1493 | Because of the buggy history of suidperl, and the difficulty | |
1494 | of properly security auditing as large and complex piece of | |
1495 | software as Perl, we cannot recommend using suidperl and the feature | |
1496 | should be considered deprecated. | |
1497 | Instead use for example 'sudo': http://www.courtesan.com/sudo/ | |
1498 | ||
8e07c86e AD |
1499 | =head1 make depend |
1500 | ||
bfb7748a AD |
1501 | This will look for all the includes. The output is stored in makefile. |
1502 | The only difference between Makefile and makefile is the dependencies at | |
1503 | the bottom of makefile. If you have to make any changes, you should edit | |
1504 | makefile, not Makefile since the Unix make command reads makefile first. | |
1505 | (On non-Unix systems, the output may be stored in a different file. | |
1506 | Check the value of $firstmakefile in your config.sh if in doubt.) | |
8e07c86e AD |
1507 | |
1508 | Configure will offer to do this step for you, so it isn't listed | |
1509 | explicitly above. | |
1510 | ||
1511 | =head1 make | |
1512 | ||
1513 | This will attempt to make perl in the current directory. | |
1514 | ||
8d74ce1c AD |
1515 | =head2 What if it doesn't work? |
1516 | ||
8e07c86e | 1517 | If you can't compile successfully, try some of the following ideas. |
7f678428 | 1518 | If none of them help, and careful reading of the error message and |
8d74ce1c AD |
1519 | the relevant manual pages on your system doesn't help, |
1520 | then see L<"Reporting Problems"> below. | |
8e07c86e AD |
1521 | |
1522 | =over 4 | |
1523 | ||
1ec51d55 | 1524 | =item hints |
8e07c86e AD |
1525 | |
1526 | If you used a hint file, try reading the comments in the hint file | |
1527 | for further tips and information. | |
1528 | ||
1ec51d55 | 1529 | =item extensions |
8e07c86e | 1530 | |
1ec51d55 | 1531 | If you can successfully build miniperl, but the process crashes |
c3edaffb | 1532 | during the building of extensions, you should run |
1533 | ||
3a6175e1 | 1534 | make minitest |
c3edaffb | 1535 | |
1536 | to test your version of miniperl. | |
1537 | ||
e57fd563 | 1538 | =item locale |
1539 | ||
bfb7748a AD |
1540 | If you have any locale-related environment variables set, try unsetting |
1541 | them. I have some reports that some versions of IRIX hang while | |
1542 | running B<./miniperl configpm> with locales other than the C locale. | |
1543 | See the discussion under L<"make test"> below about locales and the | |
1544 | whole L<"Locale problems"> section in the file pod/perllocale.pod. | |
3e6e419a JH |
1545 | The latter is especially useful if you see something like this |
1546 | ||
1547 | perl: warning: Setting locale failed. | |
1548 | perl: warning: Please check that your locale settings: | |
1549 | LC_ALL = "En_US", | |
1550 | LANG = (unset) | |
1551 | are supported and installed on your system. | |
1552 | perl: warning: Falling back to the standard locale ("C"). | |
1553 | ||
1554 | at Perl startup. | |
e57fd563 | 1555 | |
7f678428 | 1556 | =item varargs |
c3edaffb | 1557 | |
1558 | If you get varargs problems with gcc, be sure that gcc is installed | |
bfb7748a AD |
1559 | correctly and that you are not passing -I/usr/include to gcc. When using |
1560 | gcc, you should probably have i_stdarg='define' and i_varargs='undef' | |
1561 | in config.sh. The problem is usually solved by running fixincludes | |
1562 | correctly. If you do change config.sh, don't forget to propagate | |
1563 | your changes (see L<"Propagating your changes to config.sh"> below). | |
7f678428 | 1564 | See also the L<"vsprintf"> item below. |
c3edaffb | 1565 | |
bfb7748a | 1566 | =item util.c |
c3edaffb | 1567 | |
1568 | If you get error messages such as the following (the exact line | |
bfb7748a | 1569 | numbers and function name may vary in different versions of perl): |
c3edaffb | 1570 | |
bfb7748a AD |
1571 | util.c: In function `Perl_form': |
1572 | util.c:1107: number of arguments doesn't match prototype | |
1573 | proto.h:125: prototype declaration | |
c3edaffb | 1574 | |
1575 | it might well be a symptom of the gcc "varargs problem". See the | |
7f678428 | 1576 | previous L<"varargs"> item. |
c3edaffb | 1577 | |
1ec51d55 | 1578 | =item LD_LIBRARY_PATH |
c3edaffb | 1579 | |
1580 | If you run into dynamic loading problems, check your setting of | |
aa689395 | 1581 | the LD_LIBRARY_PATH environment variable. If you're creating a static |
1582 | Perl library (libperl.a rather than libperl.so) it should build | |
c3edaffb | 1583 | fine with LD_LIBRARY_PATH unset, though that may depend on details |
1584 | of your local set-up. | |
1585 | ||
aa689395 | 1586 | =item nm extraction |
c3edaffb | 1587 | |
1588 | If Configure seems to be having trouble finding library functions, | |
1589 | try not using nm extraction. You can do this from the command line | |
1590 | with | |
1591 | ||
1592 | sh Configure -Uusenm | |
1593 | ||
1594 | or by answering the nm extraction question interactively. | |
1ec51d55 | 1595 | If you have previously run Configure, you should not reuse your old |
c3edaffb | 1596 | config.sh. |
1597 | ||
bfb7748a AD |
1598 | =item umask not found |
1599 | ||
1600 | If the build processes encounters errors relating to umask(), the problem | |
1601 | is probably that Configure couldn't find your umask() system call. | |
1602 | Check your config.sh. You should have d_umask='define'. If you don't, | |
1603 | this is probably the L<"nm extraction"> problem discussed above. Also, | |
1604 | try reading the hints file for your system for further information. | |
1605 | ||
7f678428 | 1606 | =item vsprintf |
c3edaffb | 1607 | |
1608 | If you run into problems with vsprintf in compiling util.c, the | |
1609 | problem is probably that Configure failed to detect your system's | |
1610 | version of vsprintf(). Check whether your system has vprintf(). | |
1611 | (Virtually all modern Unix systems do.) Then, check the variable | |
1612 | d_vprintf in config.sh. If your system has vprintf, it should be: | |
1613 | ||
1614 | d_vprintf='define' | |
1615 | ||
1616 | If Configure guessed wrong, it is likely that Configure guessed wrong | |
bfb7748a AD |
1617 | on a number of other common functions too. This is probably |
1618 | the L<"nm extraction"> problem discussed above. | |
c3edaffb | 1619 | |
3fe9a6f1 | 1620 | =item do_aspawn |
1621 | ||
1622 | If you run into problems relating to do_aspawn or do_spawn, the | |
1623 | problem is probably that Configure failed to detect your system's | |
bfb7748a AD |
1624 | fork() function. Follow the procedure in the previous item |
1625 | on L<"nm extraction">. | |
3fe9a6f1 | 1626 | |
84902520 TB |
1627 | =item __inet_* errors |
1628 | ||
1629 | If you receive unresolved symbol errors during Perl build and/or test | |
1630 | referring to __inet_* symbols, check to see whether BIND 8.1 is | |
1631 | installed. It installs a /usr/local/include/arpa/inet.h that refers to | |
1632 | these symbols. Versions of BIND later than 8.1 do not install inet.h | |
1633 | in that location and avoid the errors. You should probably update to a | |
5b7ea690 JH |
1634 | newer version of BIND (and remove the files the old one left behind). |
1635 | If you can't, you can either link with the updated resolver library provided | |
1636 | with BIND 8.1 or rename /usr/local/bin/arpa/inet.h during the Perl build and | |
1637 | test process to avoid the problem. | |
1638 | ||
1639 | =item *_r() prototype NOT found | |
1640 | ||
1641 | On a related note, if you see a bunch of complaints like the above about | |
1642 | reentrant functions - specifically networking-related ones - being present | |
1643 | but without prototypes available, check to see if BIND 8.1 (or possibly | |
1644 | other BIND 8 versions) is (or has been) installed. They install | |
1645 | header files such as netdb.h into places such as /usr/local/include (or into | |
1646 | another directory as specified at build/install time), at least optionally. | |
1647 | Remove them or put them in someplace that isn't in the C preprocessor's | |
1648 | header file include search path (determined by -I options plus defaults, | |
1649 | normally /usr/include). | |
84902520 | 1650 | |
d6baa268 JH |
1651 | =item #error "No DATAMODEL_NATIVE specified" |
1652 | ||
1653 | This is a common error when trying to build perl on Solaris 2.6 with a | |
1654 | gcc installation from Solaris 2.5 or 2.5.1. The Solaris header files | |
1655 | changed, so you need to update your gcc installation. You can either | |
1656 | rerun the fixincludes script from gcc or take the opportunity to | |
1657 | update your gcc installation. | |
1658 | ||
aa689395 | 1659 | =item Optimizer |
c3edaffb | 1660 | |
9d67150a | 1661 | If you can't compile successfully, try turning off your compiler's |
aa689395 | 1662 | optimizer. Edit config.sh and change the line |
9d67150a | 1663 | |
1664 | optimize='-O' | |
1665 | ||
bfb7748a | 1666 | to |
9d67150a | 1667 | |
1668 | optimize=' ' | |
1669 | ||
1670 | then propagate your changes with B<sh Configure -S> and rebuild | |
1671 | with B<make depend; make>. | |
1672 | ||
9d67150a | 1673 | =item Missing functions |
1674 | ||
1675 | If you have missing routines, you probably need to add some library or | |
1676 | other, or you need to undefine some feature that Configure thought was | |
1677 | there but is defective or incomplete. Look through config.h for | |
bfb7748a AD |
1678 | likely suspects. If Configure guessed wrong on a number of functions, |
1679 | you might have the L<"nm extraction"> problem discussed above. | |
8e07c86e | 1680 | |
1ec51d55 | 1681 | =item toke.c |
8e07c86e | 1682 | |
1ec51d55 CS |
1683 | Some compilers will not compile or optimize the larger files (such as |
1684 | toke.c) without some extra switches to use larger jump offsets or | |
1685 | allocate larger internal tables. You can customize the switches for | |
1686 | each file in cflags. It's okay to insert rules for specific files into | |
1687 | makefile since a default rule only takes effect in the absence of a | |
8e07c86e AD |
1688 | specific rule. |
1689 | ||
7f678428 | 1690 | =item Missing dbmclose |
8e07c86e | 1691 | |
c3edaffb | 1692 | SCO prior to 3.2.4 may be missing dbmclose(). An upgrade to 3.2.4 |
1693 | that includes libdbm.nfs (which includes dbmclose()) may be available. | |
8e07c86e | 1694 | |
f3d9a6ba | 1695 | =item Note (probably harmless): No library found for -lsomething |
7f678428 | 1696 | |
1697 | If you see such a message during the building of an extension, but | |
1698 | the extension passes its tests anyway (see L<"make test"> below), | |
1699 | then don't worry about the warning message. The extension | |
1700 | Makefile.PL goes looking for various libraries needed on various | |
aa689395 | 1701 | systems; few systems will need all the possible libraries listed. |
7f678428 | 1702 | For example, a system may have -lcposix or -lposix, but it's |
1703 | unlikely to have both, so most users will see warnings for the one | |
f3d9a6ba CS |
1704 | they don't have. The phrase 'probably harmless' is intended to |
1705 | reassure you that nothing unusual is happening, and the build | |
1706 | process is continuing. | |
7f678428 | 1707 | |
1708 | On the other hand, if you are building GDBM_File and you get the | |
1709 | message | |
1710 | ||
f3d9a6ba | 1711 | Note (probably harmless): No library found for -lgdbm |
7f678428 | 1712 | |
1713 | then it's likely you're going to run into trouble somewhere along | |
1714 | the line, since it's hard to see how you can use the GDBM_File | |
1715 | extension without the -lgdbm library. | |
1716 | ||
1717 | It is true that, in principle, Configure could have figured all of | |
1718 | this out, but Configure and the extension building process are not | |
1719 | quite that tightly coordinated. | |
1720 | ||
aa689395 | 1721 | =item sh: ar: not found |
1722 | ||
1723 | This is a message from your shell telling you that the command 'ar' | |
1724 | was not found. You need to check your PATH environment variable to | |
1725 | make sure that it includes the directory with the 'ar' command. This | |
1ec51d55 | 1726 | is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin |
aa689395 | 1727 | directory. |
1728 | ||
1729 | =item db-recno failure on tests 51, 53 and 55 | |
1730 | ||
1731 | Old versions of the DB library (including the DB library which comes | |
1732 | with FreeBSD 2.1) had broken handling of recno databases with modified | |
1733 | bval settings. Upgrade your DB library or OS. | |
1734 | ||
6087ac44 JH |
1735 | =item Bad arg length for semctl, is XX, should be ZZZ |
1736 | ||
efb84706 | 1737 | If you get this error message from the ext/IPC/SysV/t/sem test, your System |
6087ac44 JH |
1738 | V IPC may be broken. The XX typically is 20, and that is what ZZZ |
1739 | also should be. Consider upgrading your OS, or reconfiguring your OS | |
1740 | to include the System V semaphores. | |
1741 | ||
efb84706 | 1742 | =item ext/IPC/SysV/t/sem........semget: No space left on device |
220f3621 GS |
1743 | |
1744 | Either your account or the whole system has run out of semaphores. Or | |
1745 | both. Either list the semaphores with "ipcs" and remove the unneeded | |
1746 | ones (which ones these are depends on your system and applications) | |
1747 | with "ipcrm -s SEMAPHORE_ID_HERE" or configure more semaphores to your | |
1748 | system. | |
1749 | ||
d6baa268 JH |
1750 | =item GNU binutils |
1751 | ||
1752 | If you mix GNU binutils (nm, ld, ar) with equivalent vendor-supplied | |
1753 | tools you may be in for some trouble. For example creating archives | |
1754 | with an old GNU 'ar' and then using a new current vendor-supplied 'ld' | |
1755 | may lead into linking problems. Either recompile your GNU binutils | |
1756 | under your current operating system release, or modify your PATH not | |
1757 | to include the GNU utils before running Configure, or specify the | |
1758 | vendor-supplied utilities explicitly to Configure, for example by | |
1759 | Configure -Dar=/bin/ar. | |
1760 | ||
16dc217a GS |
1761 | =item THIS PACKAGE SEEMS TO BE INCOMPLETE |
1762 | ||
1763 | The F<Configure> program has not been able to find all the files which | |
1764 | make up the complete Perl distribution. You may have a damaged source | |
1765 | archive file (in which case you may also have seen messages such as | |
1766 | C<gzip: stdin: unexpected end of file> and C<tar: Unexpected EOF on | |
1767 | archive file>), or you may have obtained a structurally-sound but | |
1768 | incomplete archive. In either case, try downloading again from the | |
1769 | official site named at the start of this document. If you do find | |
1770 | that any site is carrying a corrupted or incomplete source code | |
1771 | archive, please report it to the site's maintainer. | |
1772 | ||
16dc217a GS |
1773 | =item invalid token: ## |
1774 | ||
1775 | You are using a non-ANSI-compliant C compiler. See L<WARNING: This | |
1776 | version requires a compiler that supports ANSI C>. | |
1777 | ||
1ec51d55 | 1778 | =item Miscellaneous |
8e07c86e AD |
1779 | |
1780 | Some additional things that have been reported for either perl4 or perl5: | |
1781 | ||
1782 | Genix may need to use libc rather than libc_s, or #undef VARARGS. | |
1783 | ||
1784 | NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR. | |
1785 | ||
9ede5bc8 | 1786 | UTS may need one or more of -K or -g, and undef LSTAT. |
8e07c86e | 1787 | |
efb84706 | 1788 | FreeBSD can fail the ext/IPC/SysV/t/sem.t test if SysV IPC has not been |
5cda700b | 1789 | configured in the kernel. Perl tries to detect this, though, and |
220f3621 | 1790 | you will get a message telling what to do. |
6087ac44 | 1791 | |
d6baa268 JH |
1792 | HP-UX 11 Y2K patch "Y2K-1100 B.11.00.B0125 HP-UX Core OS Year 2000 |
1793 | Patch Bundle" has been reported to break the io/fs test #18 which | |
1794 | tests whether utime() can change timestamps. The Y2K patch seems to | |
1795 | break utime() so that over NFS the timestamps do not get changed | |
1796 | (on local filesystems utime() still works). | |
1797 | ||
5a4eec7a JH |
1798 | Building Perl on a system that has also BIND (headers and libraries) |
1799 | installed may run into troubles because BIND installs its own netdb.h | |
1800 | and socket.h, which may not agree with the operating system's ideas of | |
1801 | the same files. Similarly, including -lbind may conflict with libc's | |
1802 | view of the world. You may have to tweak -Dlocincpth and -Dloclibpth | |
1803 | to avoid the BIND. | |
1804 | ||
8e07c86e AD |
1805 | =back |
1806 | ||
58a21a9b JH |
1807 | =head2 Cross-compilation |
1808 | ||
1809 | Starting from Perl 5.8 Perl has the beginnings of cross-compilation | |
1810 | support. What is known to work is running Configure in a | |
1811 | cross-compilation environment and building the miniperl executable. | |
65090350 | 1812 | What is known not to work is building the perl executable because |
58a21a9b JH |
1813 | that would require building extensions: Dynaloader statically and |
1814 | File::Glob dynamically, for extensions one needs MakeMaker and | |
1815 | MakeMaker is not yet cross-compilation aware, and neither is | |
1816 | the main Makefile. | |
1817 | ||
93bc48fa JH |
1818 | Since the functionality is so lacking, it must be considered |
1819 | highly experimental. It is so experimental that it is not even | |
c80c8d62 | 1820 | mentioned during an interactive Configure session, a direct command |
93bc48fa JH |
1821 | line invocation (detailed shortly) is required to access the |
1822 | functionality. | |
1823 | ||
58a21a9b | 1824 | NOTE: Perl is routinely built using cross-compilation |
403fd3c3 JH |
1825 | in the EPOC environment, in the WinCE, and in the OpenZaurus |
1826 | project, but all those use something slightly different setup | |
1827 | than what described here. For the WinCE setup, read the | |
1828 | wince/README.compile. For the OpenZaurus setup, read the | |
1829 | Cross/README. | |
1830 | ||
1831 | The one environment where this cross-compilation setup has | |
1832 | successfully been used as of this writing is the Compaq iPAQ running | |
1833 | ARM Linux. The build host was Intel Linux, the networking setup was | |
1834 | PPP + SSH. The exact setup details are beyond the scope of this | |
1835 | document, see http://www.handhelds.org/ for more information. | |
58a21a9b JH |
1836 | |
1837 | To run Configure in cross-compilation mode the basic switch is | |
1838 | C<-Dusecrosscompile>. | |
1839 | ||
1840 | sh ./Configure -des -Dusecrosscompile -D... | |
1841 | ||
1842 | This will make the cpp symbol USE_CROSS_COMPILE and the %Config | |
1843 | symbol C<usecrosscompile> available. | |
1844 | ||
1845 | During the Configure and build, certain helper scripts will be created | |
1846 | into the Cross/ subdirectory. The scripts are used to execute a | |
1847 | cross-compiled executable, and to transfer files to and from the | |
1848 | target host. The execution scripts are named F<run-*> and the | |
1849 | transfer scripts F<to-*> and F<from-*>. The part after the dash is | |
1850 | the method to use for remote execution and transfer: by default the | |
1851 | methods are B<ssh> and B<scp>, thus making the scripts F<run-ssh>, | |
1852 | F<to-scp>, and F<from-scp>. | |
1853 | ||
1854 | To configure the scripts for a target host and a directory (in which | |
1855 | the execution will happen and which is to and from where the transfer | |
1856 | happens), supply Configure with | |
1857 | ||
1858 | -Dtargethost=so.me.ho.st -Dtargetdir=/tar/get/dir | |
1859 | ||
1860 | The targethost is what e.g. ssh will use as the hostname, the targetdir | |
93bc48fa JH |
1861 | must exist (the scripts won't create it), the targetdir defaults to /tmp. |
1862 | You can also specify a username to use for ssh/rsh logins | |
58a21a9b JH |
1863 | |
1864 | -Dtargetuser=luser | |
1865 | ||
1866 | but in case you don't, "root" will be used. | |
1867 | ||
93bc48fa JH |
1868 | Because this is a cross-compilation effort, you will also need to specify |
1869 | which target environment and which compilation environment to use. | |
1870 | This includes the compiler, the header files, and the libraries. | |
1871 | In the below we use the usual settings for the iPAQ cross-compilation | |
1872 | environment: | |
58a21a9b JH |
1873 | |
1874 | -Dtargetarch=arm-linux | |
1875 | -Dcc=arm-linux-gcc | |
1876 | -Dusrinc=/skiff/local/arm-linux/include | |
1877 | -Dincpth=/skiff/local/arm-linux/include | |
1878 | -Dlibpth=/skiff/local/arm-linux/lib | |
1879 | ||
1880 | If the name of the C<cc> has the usual GNU C semantics for cross | |
1881 | compilers, that is, CPU-OS-gcc, the names of the C<ar>, C<nm>, and | |
1882 | C<ranlib> will also be automatically chosen to be CPU-OS-ar and so on. | |
93bc48fa JH |
1883 | (The C<ld> requires more thought and will be chosen later by Configure |
1884 | as appropriate.) Also, in this case the incpth, libpth, and usrinc | |
1885 | will be guessed by Configure (unless explicitly set to something else, | |
1886 | in which case Configure's guesses with be appended). | |
58a21a9b JH |
1887 | |
1888 | In addition to the default execution/transfer methods you can also | |
1889 | choose B<rsh> for execution, and B<rcp> or B<cp> for transfer, | |
1890 | for example: | |
1891 | ||
1892 | -Dtargetrun=rsh -Dtargetto=rcp -Dtargetfrom=cp | |
1893 | ||
1894 | Putting it all together: | |
1895 | ||
1896 | sh ./Configure -des -Dusecrosscompile \ | |
93bc48fa JH |
1897 | -Dtargethost=so.me.ho.st \ |
1898 | -Dtargetdir=/tar/get/dir \ | |
58a21a9b JH |
1899 | -Dtargetuser=root \ |
1900 | -Dtargetarch=arm-linux \ | |
1901 | -Dcc=arm-linux-gcc \ | |
1902 | -Dusrinc=/skiff/local/arm-linux/include \ | |
1903 | -Dincpth=/skiff/local/arm-linux/include \ | |
1904 | -Dlibpth=/skiff/local/arm-linux/lib \ | |
1905 | -D... | |
1906 | ||
93bc48fa JH |
1907 | or if you are happy with the defaults |
1908 | ||
1909 | sh ./Configure -des -Dusecrosscompile \ | |
1910 | -Dtargethost=so.me.ho.st \ | |
1911 | -Dcc=arm-linux-gcc \ | |
1912 | -D... | |
1913 | ||
8e07c86e AD |
1914 | =head1 make test |
1915 | ||
d6baa268 JH |
1916 | This will run the regression tests on the perl you just made. If |
1917 | 'make test' doesn't say "All tests successful" then something went | |
1918 | wrong. See the file t/README in the t subdirectory. | |
84902520 | 1919 | |
84902520 | 1920 | Note that you can't run the tests in background if this disables |
fb73857a | 1921 | opening of /dev/tty. You can use 'make test-notty' in that case but |
1922 | a few tty tests will be skipped. | |
c3edaffb | 1923 | |
c4f23d77 AD |
1924 | =head2 What if make test doesn't work? |
1925 | ||
1ec51d55 CS |
1926 | If make test bombs out, just cd to the t directory and run ./TEST |
1927 | by hand to see if it makes any difference. If individual tests | |
c3edaffb | 1928 | bomb, you can run them by hand, e.g., |
8e07c86e AD |
1929 | |
1930 | ./perl op/groups.t | |
1931 | ||
aa689395 | 1932 | Another way to get more detailed information about failed tests and |
1ec51d55 | 1933 | individual subtests is to cd to the t directory and run |
aa689395 | 1934 | |
1935 | ./perl harness | |
1936 | ||
fb73857a | 1937 | (this assumes that most basic tests succeed, since harness uses |
10c7e831 JH |
1938 | complicated constructs). For extension and library tests you |
1939 | need a little bit more: you need to setup your environment variable | |
1940 | PERL_CORE to a true value (like "1"), and you need to supply the | |
1941 | right Perl library path: | |
1942 | ||
1943 | setenv PERL_CORE 1 | |
1944 | ./perl -I../lib ../ext/Socket/Socket.t | |
1945 | ./perl -I../lib ../lib/less.t | |
aa689395 | 1946 | |
5cda700b | 1947 | (For csh-like shells on UNIX; adjust appropriately for other platforms.) |
fb73857a | 1948 | You should also read the individual tests to see if there are any helpful |
10c7e831 JH |
1949 | comments that apply to your system. You may also need to setup your |
1950 | shared library path if you get errors like: | |
1951 | ||
1952 | /sbin/loader: Fatal Error: cannot map libperl.so | |
1953 | ||
1954 | See L</"Building a shared Perl library"> earlier in this document. | |
c3edaffb | 1955 | |
c4f23d77 AD |
1956 | =over 4 |
1957 | ||
1958 | =item locale | |
1959 | ||
1ec51d55 | 1960 | Note: One possible reason for errors is that some external programs |
c07a80fd | 1961 | may be broken due to the combination of your environment and the way |
3fe9a6f1 | 1962 | B<make test> exercises them. For example, this may happen if you have |
1ec51d55 CS |
1963 | one or more of these environment variables set: LC_ALL LC_CTYPE |
1964 | LC_COLLATE LANG. In some versions of UNIX, the non-English locales | |
e57fd563 | 1965 | are known to cause programs to exhibit mysterious errors. |
1966 | ||
1967 | If you have any of the above environment variables set, please try | |
aa689395 | 1968 | |
1969 | setenv LC_ALL C | |
1970 | ||
1971 | (for C shell) or | |
1972 | ||
1973 | LC_ALL=C;export LC_ALL | |
1974 | ||
1ec51d55 CS |
1975 | for Bourne or Korn shell) from the command line and then retry |
1976 | make test. If the tests then succeed, you may have a broken program that | |
aa689395 | 1977 | is confusing the testing. Please run the troublesome test by hand as |
e57fd563 | 1978 | shown above and see whether you can locate the program. Look for |
1ec51d55 CS |
1979 | things like: exec, `backquoted command`, system, open("|...") or |
1980 | open("...|"). All these mean that Perl is trying to run some | |
e57fd563 | 1981 | external program. |
eed2e782 | 1982 | |
0740bb5b AD |
1983 | =item Timing problems |
1984 | ||
c29923ff JH |
1985 | Several tests in the test suite check timing functions, such as |
1986 | sleep(), and see if they return in a reasonable amount of time. | |
9341413f JH |
1987 | If your system is quite busy and doesn't respond quickly enough, |
1988 | these tests might fail. If possible, try running the tests again | |
1989 | with the system under a lighter load. These timing-sensitive | |
1990 | and load-sensitive tests include F<t/op/alarm.t>, | |
1991 | F<ext/Time/HiRes/HiRes.t>, F<lib/Benchmark.t>, | |
1992 | F<lib/Memoize/t/expmod_t.t>, and F<lib/Memoize/t/speed.t>. | |
0740bb5b | 1993 | |
c4f23d77 AD |
1994 | =item Out of memory |
1995 | ||
1996 | On some systems, particularly those with smaller amounts of RAM, some | |
1997 | of the tests in t/op/pat.t may fail with an "Out of memory" message. | |
7970f296 GS |
1998 | For example, on my SparcStation IPC with 12 MB of RAM, in perl5.5.670, |
1999 | test 85 will fail if run under either t/TEST or t/harness. | |
c4f23d77 AD |
2000 | |
2001 | Try stopping other jobs on the system and then running the test by itself: | |
2002 | ||
2003 | cd t; ./perl op/pat.t | |
2004 | ||
2005 | to see if you have any better luck. If your perl still fails this | |
2006 | test, it does not necessarily mean you have a broken perl. This test | |
2007 | tries to exercise the regular expression subsystem quite thoroughly, | |
2008 | and may well be far more demanding than your normal usage. | |
2009 | ||
650939d2 JH |
2010 | =item Failures from lib/File/Temp/t/security saying "system possibly insecure" |
2011 | ||
2012 | First, such warnings are not necessarily serious or indicative of a | |
2013 | real security threat. That being said, they bear investigating. | |
2014 | ||
2015 | Note that each of the tests is run twice. The first time is in the | |
2016 | directory returned by File::Spec->tmpdir() (often /tmp on Unix | |
2017 | systems), and the second time in the directory from which the test was | |
2018 | run (usually the 't' directory, if the test was run as part of 'make | |
2019 | test'). | |
2020 | ||
2021 | The tests may fail for the following reasons: | |
2022 | ||
2023 | (1) If the directory the tests are being run in is owned by somebody | |
2024 | other than the user running the tests, or by root (uid 0). | |
2025 | ||
2026 | This failure can happen if the Perl source code distribution is | |
2027 | unpacked in such a way that the user ids in the distribution package | |
2028 | are used as-is. Some tar programs do this. | |
2029 | ||
2030 | (2) If the directory the tests are being run in is writable by group or | |
2031 | by others, and there is no sticky bit set for the directory. (With | |
2032 | UNIX/POSIX semantics, write access to a directory means the right to | |
2033 | add or remove files in that directory. The 'sticky bit' is a feature | |
2034 | used in some UNIXes to give extra protection to files: if the bit is | |
2035 | set for a directory, no one but the owner (or root) can remove that | |
2036 | file even if the permissions would otherwise allow file removal by | |
2037 | others.) | |
2038 | ||
2039 | This failure may or may not be a real problem: it depends on the | |
2040 | permissions policy used on this particular system. This failure can | |
2041 | also happen if the system either doesn't support the sticky bit (this | |
2042 | is the case with many non-UNIX platforms: in principle File::Temp | |
2043 | should know about these platforms and skip the tests), or if the system | |
2044 | supports the sticky bit but for some reason or reasons it is not being | |
2045 | used. This is, for example, the case with HP-UX: as of HP-UX release | |
2046 | 11.00, the sticky bit is very much supported, but HP-UX doesn't use it | |
2047 | on its /tmp directory as shipped. Also, as with the permissions, some | |
2048 | local policy might dictate that the stickiness is not used. | |
781948c1 | 2049 | |
b2b23189 JH |
2050 | (3) If the system supports the POSIX 'chown giveaway' feature and if |
2051 | any of the parent directories of the temporary file back to the root | |
2052 | directory are 'unsafe', using the definitions given above in (1) and | |
650939d2 JH |
2053 | (2). For Unix systems, this is usually not an issue if you are |
2054 | building on a local disk. See the documentation for the File::Temp | |
2055 | module for more information about 'chown giveaway'. | |
781948c1 JH |
2056 | |
2057 | See the documentation for the File::Temp module for more information | |
650939d2 | 2058 | about the various security aspects of temporary files. |
781948c1 | 2059 | |
c4f23d77 AD |
2060 | =back |
2061 | ||
8e07c86e AD |
2062 | =head1 make install |
2063 | ||
2064 | This will put perl into the public directory you specified to | |
1ec51d55 | 2065 | Configure; by default this is /usr/local/bin. It will also try |
8e07c86e | 2066 | to put the man pages in a reasonable place. It will not nroff the man |
aa689395 | 2067 | pages, however. You may need to be root to run B<make install>. If you |
8e07c86e AD |
2068 | are not root, you must own the directories in question and you should |
2069 | ignore any messages about chown not working. | |
2070 | ||
dd64f1c3 AD |
2071 | =head2 Installing perl under different names |
2072 | ||
2073 | If you want to install perl under a name other than "perl" (for example, | |
2074 | when installing perl with special features enabled, such as debugging), | |
2075 | indicate the alternate name on the "make install" line, such as: | |
2076 | ||
2077 | make install PERLNAME=myperl | |
2078 | ||
beb13193 RS |
2079 | You can separately change the base used for versioned names (like |
2080 | "perl5.005") by setting PERLNAME_VERBASE, like | |
2081 | ||
2082 | make install PERLNAME=perl5 PERLNAME_VERBASE=perl | |
2083 | ||
5cda700b AD |
2084 | This can be useful if you have to install perl as "perl5" (e.g. to |
2085 | avoid conflicts with an ancient version in /usr/bin supplied by your vendor). | |
2086 | Without this the versioned binary would be called "perl55.005". | |
beb13193 | 2087 | |
dd64f1c3 AD |
2088 | =head2 Installed files |
2089 | ||
8e07c86e AD |
2090 | If you want to see exactly what will happen without installing |
2091 | anything, you can run | |
4633a7c4 | 2092 | |
8e07c86e AD |
2093 | ./perl installperl -n |
2094 | ./perl installman -n | |
2095 | ||
1ec51d55 | 2096 | make install will install the following: |
8e07c86e | 2097 | |
d56c5707 JH |
2098 | binaries |
2099 | ||
8e07c86e AD |
2100 | perl, |
2101 | perl5.nnn where nnn is the current release number. This | |
2102 | will be a link to perl. | |
2103 | suidperl, | |
2104 | sperl5.nnn If you requested setuid emulation. | |
2105 | a2p awk-to-perl translator | |
d56c5707 JH |
2106 | |
2107 | scripts | |
2108 | ||
8e07c86e AD |
2109 | cppstdin This is used by perl -P, if your cc -E can't |
2110 | read from stdin. | |
2111 | c2ph, pstruct Scripts for handling C structures in header files. | |
2112 | s2p sed-to-perl translator | |
2113 | find2perl find-to-perl translator | |
aa689395 | 2114 | h2ph Extract constants and simple macros from C headers |
8e07c86e | 2115 | h2xs Converts C .h header files to Perl extensions. |
24b3df7f | 2116 | perlbug Tool to report bugs in Perl. |
8e07c86e | 2117 | perldoc Tool to read perl's pod documentation. |
aa689395 | 2118 | pl2pm Convert Perl 4 .pl files to Perl 5 .pm modules |
8e07c86e | 2119 | pod2html, Converters from perl's pod documentation format |
aa689395 | 2120 | pod2latex, to other useful formats. |
d56c5707 JH |
2121 | pod2man, |
2122 | pod2text, | |
2123 | pod2checker, | |
2124 | pod2select, | |
2125 | pod2usage | |
aa689395 | 2126 | splain Describe Perl warnings and errors |
95667ae4 | 2127 | dprofpp Perl code profile post-processor |
8e07c86e | 2128 | |
d56c5707 JH |
2129 | library files |
2130 | ||
2131 | in $privlib and $archlib specified to | |
8e07c86e | 2132 | Configure, usually under /usr/local/lib/perl5/. |
d56c5707 JH |
2133 | |
2134 | documentation | |
2135 | ||
d6baa268 JH |
2136 | man pages in $man1dir, usually /usr/local/man/man1. |
2137 | module man | |
2138 | pages in $man3dir, usually /usr/local/man/man3. | |
8e07c86e AD |
2139 | pod/*.pod in $privlib/pod/. |
2140 | ||
d6baa268 JH |
2141 | Installperl will also create the directories listed above |
2142 | in L<"Installation Directories">. | |
4633a7c4 | 2143 | |
d56c5707 | 2144 | Perl's *.h header files and the libperl library are also installed |
d6baa268 | 2145 | under $archlib so that any user may later build new modules, run the |
56c6f531 JH |
2146 | optional Perl compiler, or embed the perl interpreter into another |
2147 | program even if the Perl source is no longer available. | |
8e07c86e | 2148 | |
d56c5707 JH |
2149 | Sometimes you only want to install the version-specific parts of the perl |
2150 | installation. For example, you may wish to install a newer version of | |
2151 | perl alongside an already installed production version of perl without | |
2152 | disabling installation of new modules for the production version. | |
2153 | To only install the version-specific parts of the perl installation, run | |
2154 | ||
2155 | Configure -Dversiononly | |
2156 | ||
2157 | or answer 'y' to the appropriate Configure prompt. Alternatively, | |
2158 | you can just manually run | |
2159 | ||
2160 | ./perl installperl -v | |
2161 | ||
2162 | and skip installman altogether. | |
2163 | See also L<"Maintaining completely separate versions"> for another | |
2164 | approach. | |
2165 | ||
aa689395 | 2166 | =head1 Coexistence with earlier versions of perl5 |
4633a7c4 | 2167 | |
14eee2f1 | 2168 | Perl 5.8 is not binary compatible with earlier versions of Perl. |
cc65bb49 | 2169 | In other words, you will have to recompile your XS modules. |
14eee2f1 | 2170 | |
693762b4 AD |
2171 | In general, you can usually safely upgrade from one version of Perl (e.g. |
2172 | 5.004_04) to another similar version (e.g. 5.004_05) without re-compiling | |
2173 | all of your add-on extensions. You can also safely leave the old version | |
2174 | around in case the new version causes you problems for some reason. | |
2175 | For example, if you want to be sure that your script continues to run | |
dc45a647 | 2176 | with 5.004_04, simply replace the '#!/usr/local/bin/perl' line at the |
693762b4 AD |
2177 | top of the script with the particular version you want to run, e.g. |
2178 | #!/usr/local/bin/perl5.00404. | |
2179 | ||
e655887d CB |
2180 | Usually, most extensions will probably not need to be recompiled to |
2181 | use with a newer version of Perl (the Perl 5.6 to Perl 5.8 transition | |
2182 | being an exception). Here is how it is supposed to work. (These | |
2183 | examples assume you accept all the Configure defaults.) | |
693762b4 | 2184 | |
d6baa268 JH |
2185 | Suppose you already have version 5.005_03 installed. The directories |
2186 | searched by 5.005_03 are | |
2187 | ||
2188 | /usr/local/lib/perl5/5.00503/$archname | |
2189 | /usr/local/lib/perl5/5.00503 | |
2190 | /usr/local/lib/perl5/site_perl/5.005/$archname | |
2191 | /usr/local/lib/perl5/site_perl/5.005 | |
2192 | ||
0a08c020 GS |
2193 | Beginning with 5.6.0 the version number in the site libraries are |
2194 | fully versioned. Now, suppose you install version 5.6.0. The directories | |
2195 | searched by version 5.6.0 will be | |
d6baa268 | 2196 | |
0a08c020 GS |
2197 | /usr/local/lib/perl5/5.6.0/$archname |
2198 | /usr/local/lib/perl5/5.6.0 | |
2199 | /usr/local/lib/perl5/site_perl/5.6.0/$archname | |
2200 | /usr/local/lib/perl5/site_perl/5.6.0 | |
d6baa268 JH |
2201 | |
2202 | /usr/local/lib/perl5/site_perl/5.005/$archname | |
2203 | /usr/local/lib/perl5/site_perl/5.005 | |
c42e3e15 | 2204 | /usr/local/lib/perl5/site_perl/ |
bfb7748a | 2205 | |
c42e3e15 | 2206 | Notice the last three entries -- Perl understands the default structure |
d6baa268 JH |
2207 | of the $sitelib directories and will look back in older, compatible |
2208 | directories. This way, modules installed under 5.005_03 will continue | |
0a08c020 | 2209 | to be usable by 5.005_03 but will also accessible to 5.6.0. Further, |
d6baa268 | 2210 | suppose that you upgrade a module to one which requires features |
0a08c020 GS |
2211 | present only in 5.6.0. That new module will get installed into |
2212 | /usr/local/lib/perl5/site_perl/5.6.0 and will be available to 5.6.0, | |
d6baa268 | 2213 | but will not interfere with the 5.005_03 version. |
bfb7748a | 2214 | |
c42e3e15 | 2215 | The last entry, /usr/local/lib/perl5/site_perl/, is there so that |
fe23a901 | 2216 | 5.6.0 and above will look for 5.004-era pure perl modules. |
d6baa268 | 2217 | |
cc65bb49 AD |
2218 | Lastly, suppose you now install 5.8.0, which is not binary compatible |
2219 | with 5.6.0. The directories searched by 5.8.0 (if you don't change the | |
fe23a901 RF |
2220 | Configure defaults) will be: |
2221 | ||
2222 | /usr/local/lib/perl5/5.8.0/$archname | |
2223 | /usr/local/lib/perl5/5.8.0 | |
2224 | /usr/local/lib/perl5/site_perl/5.8.0/$archname | |
2225 | /usr/local/lib/perl5/site_perl/5.8.0 | |
d6baa268 | 2226 | |
0a08c020 | 2227 | /usr/local/lib/perl5/site_perl/5.6.0 |
d6baa268 | 2228 | |
d6baa268 | 2229 | /usr/local/lib/perl5/site_perl/5.005 |
fe23a901 | 2230 | |
d6baa268 | 2231 | /usr/local/lib/perl5/site_perl/ |
bfb7748a | 2232 | |
cc65bb49 AD |
2233 | Note that the earlier $archname entries are now gone, but pure perl |
2234 | modules from earlier versions will still be found. | |
2235 | ||
0a08c020 | 2236 | Assuming the users in your site are still actively using perl 5.6.0 and |
fe23a901 | 2237 | 5.005 after you installed 5.8.0, you can continue to install add-on |
cc65bb49 AD |
2238 | extensions using any of perl 5.8.0, 5.6.0, or 5.005. The installations |
2239 | of these different versions remain distinct, but remember that the | |
2240 | newer versions of perl are automatically set up to search the | |
2241 | compatible site libraries of the older ones. This means that | |
2242 | installing a new XS extension with 5.005 will make it visible to both | |
2243 | 5.005 and 5.6.0, but not to 5.8.0. Installing a pure perl module with | |
2244 | 5.005 will make it visible to all three versions. Later, if you | |
2245 | install the same extension using, say, perl 5.8.0, it will override the | |
2246 | 5.005-installed version, but only for perl 5.8.0. | |
0a08c020 GS |
2247 | |
2248 | This way, you can choose to share compatible extensions, but also upgrade | |
2249 | to a newer version of an extension that may be incompatible with earlier | |
2250 | versions, without breaking the earlier versions' installations. | |
693762b4 AD |
2251 | |
2252 | =head2 Maintaining completely separate versions | |
4633a7c4 | 2253 | |
1ec51d55 | 2254 | Many users prefer to keep all versions of perl in completely |
d6baa268 | 2255 | separate directories. This guarantees that an update to one version |
0a08c020 GS |
2256 | won't interfere with another version. (The defaults guarantee this for |
2257 | libraries after 5.6.0, but not for executables. TODO?) One convenient | |
2258 | way to do this is by using a separate prefix for each version, such as | |
d52d4e46 | 2259 | |
46bb10fb | 2260 | sh Configure -Dprefix=/opt/perl5.004 |
d52d4e46 | 2261 | |
46bb10fb | 2262 | and adding /opt/perl5.004/bin to the shell PATH variable. Such users |
d52d4e46 | 2263 | may also wish to add a symbolic link /usr/local/bin/perl so that |
2264 | scripts can still start with #!/usr/local/bin/perl. | |
2265 | ||
693762b4 | 2266 | Others might share a common directory for maintenance sub-versions |
cc65bb49 | 2267 | (e.g. 5.8 for all 5.8.x versions), but change directory with |
693762b4 AD |
2268 | each major version. |
2269 | ||
6877a1cf AD |
2270 | If you are installing a development subversion, you probably ought to |
2271 | seriously consider using a separate directory, since development | |
2272 | subversions may not have all the compatibility wrinkles ironed out | |
2273 | yet. | |
2274 | ||
e655887d | 2275 | =head2 Upgrading from 5.005 or 5.6 to 5.8.0 |
693762b4 | 2276 | |
e655887d CB |
2277 | B<Perl 5.8.0 is binary incompatible with Perl 5.6.1, 5.6.0, 5.005, |
2278 | and any earlier Perl release.> Perl modules having binary parts | |
2279 | (meaning that a C compiler is used) will have to be recompiled to be | |
2280 | used with 5.8.0. If you find you do need to rebuild an extension with | |
2281 | 5.8.0, you may safely do so without disturbing the 5.005 or 5.6.0 | |
2282 | installations. (See L<"Coexistence with earlier versions of perl5"> | |
2283 | above.) | |
c42e3e15 GS |
2284 | |
2285 | See your installed copy of the perllocal.pod file for a (possibly | |
2286 | incomplete) list of locally installed modules. Note that you want | |
cc65bb49 | 2287 | perllocal.pod, not perllocale.pod, for installed module information. |
693762b4 | 2288 | |
8e07c86e AD |
2289 | =head1 Coexistence with perl4 |
2290 | ||
2291 | You can safely install perl5 even if you want to keep perl4 around. | |
2292 | ||
1ec51d55 CS |
2293 | By default, the perl5 libraries go into /usr/local/lib/perl5/, so |
2294 | they don't override the perl4 libraries in /usr/local/lib/perl/. | |
8e07c86e AD |
2295 | |
2296 | In your /usr/local/bin directory, you should have a binary named | |
1ec51d55 | 2297 | perl4.036. That will not be touched by the perl5 installation |
8e07c86e AD |
2298 | process. Most perl4 scripts should run just fine under perl5. |
2299 | However, if you have any scripts that require perl4, you can replace | |
d6baa268 JH |
2300 | the #! line at the top of them by #!/usr/local/bin/perl4.036 (or |
2301 | whatever the appropriate pathname is). See pod/perltrap.pod for | |
2302 | possible problems running perl4 scripts under perl5. | |
8e07c86e | 2303 | |
aa689395 | 2304 | =head1 cd /usr/include; h2ph *.h sys/*.h |
2305 | ||
d6baa268 JH |
2306 | Some perl scripts need to be able to obtain information from the |
2307 | system header files. This command will convert the most commonly used | |
1ec51d55 | 2308 | header files in /usr/include into files that can be easily interpreted |
d6baa268 JH |
2309 | by perl. These files will be placed in the architecture-dependent |
2310 | library ($archlib) directory you specified to Configure. | |
aa689395 | 2311 | |
d6baa268 JH |
2312 | Note: Due to differences in the C and perl languages, the conversion |
2313 | of the header files is not perfect. You will probably have to | |
2314 | hand-edit some of the converted files to get them to parse correctly. | |
2315 | For example, h2ph breaks spectacularly on type casting and certain | |
2316 | structures. | |
aa689395 | 2317 | |
fb73857a | 2318 | =head1 installhtml --help |
aa689395 | 2319 | |
3e3baf6d TB |
2320 | Some sites may wish to make perl documentation available in HTML |
2321 | format. The installhtml utility can be used to convert pod | |
fb73857a | 2322 | documentation into linked HTML files and install them. |
aa689395 | 2323 | |
d6baa268 JH |
2324 | Currently, the supplied ./installhtml script does not make use of the |
2325 | html Configure variables. This should be fixed in a future release. | |
2326 | ||
fb73857a | 2327 | The following command-line is an example of one used to convert |
3e3baf6d | 2328 | perl documentation: |
aa689395 | 2329 | |
3e3baf6d TB |
2330 | ./installhtml \ |
2331 | --podroot=. \ | |
2332 | --podpath=lib:ext:pod:vms \ | |
2333 | --recurse \ | |
2334 | --htmldir=/perl/nmanual \ | |
2335 | --htmlroot=/perl/nmanual \ | |
2336 | --splithead=pod/perlipc \ | |
2337 | --splititem=pod/perlfunc \ | |
2338 | --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \ | |
2339 | --verbose | |
2340 | ||
2341 | See the documentation in installhtml for more details. It can take | |
2342 | many minutes to execute a large installation and you should expect to | |
2343 | see warnings like "no title", "unexpected directive" and "cannot | |
2344 | resolve" as the files are processed. We are aware of these problems | |
2345 | (and would welcome patches for them). | |
aa689395 | 2346 | |
fb73857a | 2347 | You may find it helpful to run installhtml twice. That should reduce |
2348 | the number of "cannot resolve" warnings. | |
2349 | ||
aa689395 | 2350 | =head1 cd pod && make tex && (process the latex files) |
2351 | ||
2352 | Some sites may also wish to make the documentation in the pod/ directory | |
2353 | available in TeX format. Type | |
2354 | ||
2355 | (cd pod && make tex && <process the latex files>) | |
2356 | ||
8ebf57cf JH |
2357 | =head1 Minimizing the Perl installation |
2358 | ||
2359 | The following section is meant for people worrying about squeezing the | |
2360 | Perl installation into minimal systems (for example when installing | |
2361 | operating systems, or in really small filesystems). | |
2362 | ||
c8214fdf | 2363 | Leaving out as many extensions as possible is an obvious way: |
5cda700b AD |
2364 | Encode, with its big conversion tables, consumes a lot of |
2365 | space. On the other hand, you cannot throw away everything. The | |
2366 | Fcntl module is pretty essential. If you need to do network | |
c8214fdf JH |
2367 | programming, you'll appreciate the Socket module, and so forth: it all |
2368 | depends on what do you need to do. | |
2369 | ||
8ebf57cf JH |
2370 | In the following we offer two different slimmed down installation |
2371 | recipes. They are informative, not normative: the choice of files | |
2372 | depends on what you need. | |
2373 | ||
2374 | Firstly, the bare minimum to run this script | |
2375 | ||
2376 | use strict; | |
2377 | use warnings; | |
2378 | foreach my $f (</*>) { | |
2379 | print("$f\n"); | |
2380 | } | |
2381 | ||
2382 | in Solaris is as follows (under $Config{prefix}): | |
2383 | ||
2384 | ./bin/perl | |
2385 | ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/autosplit.ix | |
2386 | ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/dl_expandspec.al | |
2387 | ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/dl_find_symbol_anywhere.al | |
2388 | ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/dl_findfile.al | |
2389 | ./lib/perl5/5.6.1/sun4-solaris-64int/auto/File/Glob/Glob.so | |
2390 | ./lib/perl5/5.6.1/sun4-solaris-64int/auto/File/Glob/autosplit.ix | |
2391 | ./lib/perl5/5.6.1/sun4-solaris-64int/Config.pm | |
2392 | ./lib/perl5/5.6.1/sun4-solaris-64int/XSLoader.pm | |
2393 | ./lib/perl5/5.6.1/sun4-solaris-64int/DynaLoader.pm | |
2394 | ./lib/perl5/5.6.1/sun4-solaris-64int/CORE/libperl.so | |
2395 | ./lib/perl5/5.6.1/strict.pm | |
2396 | ./lib/perl5/5.6.1/warnings.pm | |
2397 | ./lib/perl5/5.6.1/Carp.pm | |
2398 | ./lib/perl5/5.6.1/Exporter.pm | |
2399 | ./lib/perl5/5.6.1/File/Glob.pm | |
2400 | ./lib/perl5/5.6.1/AutoLoader.pm | |
2401 | ./lib/perl5/5.6.1/vars.pm | |
2402 | ./lib/perl5/5.6.1/warnings/register.pm | |
2403 | ./lib/perl5/5.6.1/Carp/Heavy.pm | |
2404 | ./lib/perl5/5.6.1/Exporter/Heavy.pm | |
2405 | ||
2406 | Secondly, Debian perl-base package contains the following files, | |
2407 | size about 1.2MB in its i386 version: | |
2408 | ||
2409 | /usr/share/doc/perl/Documentation | |
2410 | /usr/share/doc/perl/README.Debian | |
2411 | /usr/share/doc/perl/copyright | |
2412 | /usr/share/doc/perl/AUTHORS.gz | |
2413 | /usr/share/doc/perl/changelog.Debian.gz | |
2414 | /usr/share/man/man1/perl.1.gz | |
2415 | /usr/share/perl/5.6.1/AutoLoader.pm | |
2416 | /usr/share/perl/5.6.1/Carp.pm | |
2417 | /usr/share/perl/5.6.1/Carp/Heavy.pm | |
2418 | /usr/share/perl/5.6.1/Cwd.pm | |
2419 | /usr/share/perl/5.6.1/Exporter.pm | |
2420 | /usr/share/perl/5.6.1/Exporter/Heavy.pm | |
2421 | /usr/share/perl/5.6.1/File/Spec.pm | |
2422 | /usr/share/perl/5.6.1/File/Spec/Unix.pm | |
2423 | /usr/share/perl/5.6.1/FileHandle.pm | |
2424 | /usr/share/perl/5.6.1/Getopt/Long.pm | |
2425 | /usr/share/perl/5.6.1/IO/Socket/INET.pm | |
2426 | /usr/share/perl/5.6.1/IO/Socket/UNIX.pm | |
2427 | /usr/share/perl/5.6.1/IPC/Open2.pm | |
2428 | /usr/share/perl/5.6.1/IPC/Open3.pm | |
2429 | /usr/share/perl/5.6.1/SelectSaver.pm | |
2430 | /usr/share/perl/5.6.1/Symbol.pm | |
2431 | /usr/share/perl/5.6.1/Text/Tabs.pm | |
2432 | /usr/share/perl/5.6.1/Text/Wrap.pm | |
2433 | /usr/share/perl/5.6.1/attributes.pm | |
2434 | /usr/share/perl/5.6.1/auto/Getopt/Long/GetOptions.al | |
2435 | /usr/share/perl/5.6.1/auto/Getopt/Long/FindOption.al | |
2436 | /usr/share/perl/5.6.1/auto/Getopt/Long/Configure.al | |
2437 | /usr/share/perl/5.6.1/auto/Getopt/Long/config.al | |
2438 | /usr/share/perl/5.6.1/auto/Getopt/Long/Croak.al | |
2439 | /usr/share/perl/5.6.1/auto/Getopt/Long/autosplit.ix | |
2440 | /usr/share/perl/5.6.1/base.pm | |
2441 | /usr/share/perl/5.6.1/constant.pm | |
2442 | /usr/share/perl/5.6.1/fields.pm | |
2443 | /usr/share/perl/5.6.1/integer.pm | |
2444 | /usr/share/perl/5.6.1/lib.pm | |
2445 | /usr/share/perl/5.6.1/locale.pm | |
2446 | /usr/share/perl/5.6.1/overload.pm | |
2447 | /usr/share/perl/5.6.1/strict.pm | |
2448 | /usr/share/perl/5.6.1/vars.pm | |
2449 | /usr/share/perl/5.6.1/warnings.pm | |
2450 | /usr/share/perl/5.6.1/warnings/register.pm | |
2451 | /usr/bin/perl | |
2452 | /usr/lib/perl/5.6.1/Config.pm | |
2453 | /usr/lib/perl/5.6.1/Data/Dumper.pm | |
2454 | /usr/lib/perl/5.6.1/DynaLoader.pm | |
2455 | /usr/lib/perl/5.6.1/Errno.pm | |
2456 | /usr/lib/perl/5.6.1/Fcntl.pm | |
2457 | /usr/lib/perl/5.6.1/File/Glob.pm | |
2458 | /usr/lib/perl/5.6.1/IO.pm | |
2459 | /usr/lib/perl/5.6.1/IO/File.pm | |
2460 | /usr/lib/perl/5.6.1/IO/Handle.pm | |
2461 | /usr/lib/perl/5.6.1/IO/Pipe.pm | |
2462 | /usr/lib/perl/5.6.1/IO/Seekable.pm | |
2463 | /usr/lib/perl/5.6.1/IO/Select.pm | |
2464 | /usr/lib/perl/5.6.1/IO/Socket.pm | |
2465 | /usr/lib/perl/5.6.1/POSIX.pm | |
2466 | /usr/lib/perl/5.6.1/Socket.pm | |
2467 | /usr/lib/perl/5.6.1/XSLoader.pm | |
2468 | /usr/lib/perl/5.6.1/auto/Data/Dumper/Dumper.so | |
2469 | /usr/lib/perl/5.6.1/auto/Data/Dumper/Dumper.bs | |
2470 | /usr/lib/perl/5.6.1/auto/DynaLoader/dl_findfile.al | |
2471 | /usr/lib/perl/5.6.1/auto/DynaLoader/dl_expandspec.al | |
2472 | /usr/lib/perl/5.6.1/auto/DynaLoader/dl_find_symbol_anywhere.al | |
2473 | /usr/lib/perl/5.6.1/auto/DynaLoader/autosplit.ix | |
2474 | /usr/lib/perl/5.6.1/auto/DynaLoader/DynaLoader.a | |
2475 | /usr/lib/perl/5.6.1/auto/DynaLoader/extralibs.ld | |
2476 | /usr/lib/perl/5.6.1/auto/Fcntl/Fcntl.so | |
2477 | /usr/lib/perl/5.6.1/auto/Fcntl/Fcntl.bs | |
2478 | /usr/lib/perl/5.6.1/auto/File/Glob/Glob.bs | |
2479 | /usr/lib/perl/5.6.1/auto/File/Glob/Glob.so | |
2480 | /usr/lib/perl/5.6.1/auto/File/Glob/autosplit.ix | |
2481 | /usr/lib/perl/5.6.1/auto/IO/IO.so | |
2482 | /usr/lib/perl/5.6.1/auto/IO/IO.bs | |
2483 | /usr/lib/perl/5.6.1/auto/POSIX/POSIX.bs | |
2484 | /usr/lib/perl/5.6.1/auto/POSIX/POSIX.so | |
2485 | /usr/lib/perl/5.6.1/auto/POSIX/autosplit.ix | |
2486 | /usr/lib/perl/5.6.1/auto/POSIX/load_imports.al | |
2487 | /usr/lib/perl/5.6.1/auto/Socket/Socket.so | |
2488 | /usr/lib/perl/5.6.1/auto/Socket/Socket.bs | |
2489 | ||
aa689395 | 2490 | =head1 Reporting Problems |
2491 | ||
bfb7748a AD |
2492 | If you have difficulty building perl, and none of the advice in this file |
2493 | helps, and careful reading of the error message and the relevant manual | |
2494 | pages on your system doesn't help either, then you should send a message | |
7f2de2d2 | 2495 | to either the comp.lang.perl.misc newsgroup or to perlbug@perl.org with |
bfb7748a | 2496 | an accurate description of your problem. |
aa689395 | 2497 | |
bfb7748a AD |
2498 | Please include the output of the ./myconfig shell script that comes with |
2499 | the distribution. Alternatively, you can use the perlbug program that | |
2500 | comes with the perl distribution, but you need to have perl compiled | |
2501 | before you can use it. (If you have not installed it yet, you need to | |
f5b3b617 | 2502 | run C<./perl -Ilib utils/perlbug> instead of a plain C<perlbug>.) |
aa689395 | 2503 | |
694a7e45 AD |
2504 | Please try to make your message brief but clear. Trim out unnecessary |
2505 | information. Do not include large files (such as config.sh or a complete | |
2506 | Configure or make log) unless absolutely necessary. Do not include a | |
2507 | complete transcript of your build session. Just include the failing | |
d6baa268 | 2508 | commands, the relevant error messages, and whatever preceding commands |
694a7e45 AD |
2509 | are necessary to give the appropriate context. Plain text should |
2510 | usually be sufficient--fancy attachments or encodings may actually | |
2511 | reduce the number of people who read your message. Your message | |
2512 | will get relayed to over 400 subscribers around the world so please | |
2513 | try to keep it brief but clear. | |
aa689395 | 2514 | |
8e07c86e AD |
2515 | =head1 DOCUMENTATION |
2516 | ||
bfb7748a AD |
2517 | Read the manual entries before running perl. The main documentation |
2518 | is in the pod/ subdirectory and should have been installed during the | |
8e07c86e | 2519 | build process. Type B<man perl> to get started. Alternatively, you |
bfb7748a AD |
2520 | can type B<perldoc perl> to use the supplied perldoc script. This is |
2521 | sometimes useful for finding things in the library modules. | |
8e07c86e | 2522 | |
1ec51d55 | 2523 | Under UNIX, you can produce a documentation book in postscript form, |
bfb7748a AD |
2524 | along with its table of contents, by going to the pod/ subdirectory and |
2525 | running (either): | |
34a2a22e RM |
2526 | |
2527 | ./roffitall -groff # If you have GNU groff installed | |
aa689395 | 2528 | ./roffitall -psroff # If you have psroff |
34a2a22e RM |
2529 | |
2530 | This will leave you with two postscript files ready to be printed. | |
aa689395 | 2531 | (You may need to fix the roffitall command to use your local troff |
2532 | set-up.) | |
34a2a22e | 2533 | |
bfb7748a AD |
2534 | Note that you must have performed the installation already before running |
2535 | the above, since the script collects the installed files to generate | |
2536 | the documentation. | |
34a2a22e | 2537 | |
8e07c86e AD |
2538 | =head1 AUTHOR |
2539 | ||
bfb7748a AD |
2540 | Original author: Andy Dougherty doughera@lafayette.edu , borrowing very |
2541 | heavily from the original README by Larry Wall, with lots of helpful | |
2542 | feedback and additions from the perl5-porters@perl.org folks. | |
fb73857a | 2543 | |
f5b3b617 AD |
2544 | If you have problems, corrections, or questions, please see |
2545 | L<"Reporting Problems"> above. | |
2546 | ||
2547 | =head1 REDISTRIBUTION | |
2548 | ||
2549 | This document is part of the Perl package and may be distributed under | |
d6baa268 | 2550 | the same terms as perl itself, with the following additional request: |
f5b3b617 | 2551 | If you are distributing a modified version of perl (perhaps as part of |
d6baa268 JH |
2552 | a larger package) please B<do> modify these installation instructions |
2553 | and the contact information to match your distribution. |