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