Commit | Line | Data |
8e07c86e |
1 | =head1 NAME |
2 | |
3 | Install - Build and Installation guide for perl5. |
4 | |
5 | =head1 SYNOPSIS |
6 | |
7f678428 |
7 | The basic steps to build and install perl5 on a Unix system are: |
8e07c86e |
8 | |
dc45a647 |
9 | rm -f config.sh Policy.sh |
8e07c86e |
10 | sh Configure |
11 | make |
12 | make test |
13 | make install |
36477c24 |
14 | |
aa689395 |
15 | # You may also wish to add these: |
16 | (cd /usr/include && h2ph *.h sys/*.h) |
3e3baf6d |
17 | (installhtml --help) |
aa689395 |
18 | (cd pod && make tex && <process the latex files>) |
8e07c86e |
19 | |
20 | Each of these is explained in further detail below. |
21 | |
7beaa944 |
22 | For information on non-Unix systems, see the section on |
23 | L<"Porting information"> below. |
7f678428 |
24 | |
7beaa944 |
25 | For information on what's new in this release, see the |
26 | pod/perldelta.pod file. For more detailed information about specific |
27 | changes, see the Changes file. |
c3edaffb |
28 | |
e02fdbd2 |
29 | IMPORTANT NOTE: 5.005_53 and later releases do not export unadorned |
30 | global symbols anymore. This means most CPAN modules probably won't |
31 | build under this release without adding '-DPERL_POLLUTE' to ccflags |
32 | in config.sh. This is not the default because we want the modules |
33 | to get fixed *before* the 5.006 release. pod/perldelta.pod contains |
34 | additional notes about this. |
35 | |
1ec51d55 |
36 | =head1 DESCRIPTION |
edb1cbcb |
37 | |
c3edaffb |
38 | This document is written in pod format as an easy way to indicate its |
39 | structure. The pod format is described in pod/perlpod.pod, but you can |
1ec51d55 |
40 | read it as is with any pager or editor. Headings and items are marked |
41 | by lines beginning with '='. The other mark-up used is |
42 | |
43 | B<text> embolden text, used for switches, programs or commands |
44 | C<code> literal code |
45 | L<name> A link (cross reference) to name |
46 | |
47 | You should probably at least skim through this entire document before |
48 | proceeding. |
c3edaffb |
49 | |
eed2e782 |
50 | If you're building Perl on a non-Unix system, you should also read |
51 | the README file specific to your operating system, since this may |
52 | provide additional or different instructions for building Perl. |
53 | |
203c3eec |
54 | If there is a hint file for your system (in the hints/ directory) you |
55 | should also read that hint file for specific information for your |
56 | system. (Unixware users should use the svr4.sh hint file.) |
57 | |
bfb7748a |
58 | =head1 WARNING: This version is not binary compatible with Perl 5.004. |
693762b4 |
59 | |
bfb7748a |
60 | Starting with Perl 5.004_50 there were many deep and far-reaching changes |
61 | to the language internals. If you have dynamically loaded extensions |
62 | that you built under perl 5.003 or 5.004, you can continue to use them |
63 | with 5.004, but you will need to rebuild and reinstall those extensions |
64 | to use them 5.005. See the discussions below on |
65 | L<"Coexistence with earlier versions of perl5"> and |
66 | L<"Upgrading from 5.004 to 5.005"> for more details. |
693762b4 |
67 | |
68 | The standard extensions supplied with Perl will be handled automatically. |
69 | |
70 | In a related issue, old extensions may possibly be affected by the |
71 | changes in the Perl language in the current release. Please see |
e02fdbd2 |
72 | pod/perldelta.pod (and pod/perl500Xdelta.pod) for a description of |
73 | what's changed. |
693762b4 |
74 | |
5effff0b |
75 | =head1 WARNING: This version requires a compiler that supports ANSI C. |
76 | |
77 | If you find that your C compiler is not ANSI-capable, try obtaining |
78 | GCC, available from GNU mirrors worldwide (e.g. ftp://ftp.gnu.org/pub/gnu). |
79 | Another alternative may be to use a tool like C<ansi2knr> to convert the |
80 | sources back to K&R style, but there is no guarantee this route will get |
81 | you anywhere, since the prototypes are not the only ANSI features used |
82 | in the Perl sources. C<ansi2knr> is usually found as part of the freely |
83 | available C<Ghostscript> distribution. Another similar tool is |
84 | C<unprotoize>, distributed with GCC. Since C<unprotoize> requires GCC to |
85 | run, you may have to run it on a platform where GCC is available, and move |
86 | the sources back to the platform without GCC. |
87 | |
88 | If you succeed in automatically converting the sources to a K&R compatible |
89 | form, be sure to email perlbug@perl.com to let us know the steps you |
90 | followed. This will enable us to officially support this option. |
91 | |
aa689395 |
92 | =head1 Space Requirements |
eed2e782 |
93 | |
dc45a647 |
94 | The complete perl5 source tree takes up about 10 MB of disk space. The |
95 | complete tree after completing make takes roughly 20 MB, though the |
1ec51d55 |
96 | actual total is likely to be quite system-dependent. The installation |
dc45a647 |
97 | directories need something on the order of 10 MB, though again that |
1ec51d55 |
98 | value is system-dependent. |
8e07c86e |
99 | |
aa689395 |
100 | =head1 Start with a Fresh Distribution |
8e07c86e |
101 | |
edb1cbcb |
102 | If you have built perl before, you should clean out the build directory |
103 | with the command |
104 | |
dc45a647 |
105 | make distclean |
106 | |
107 | or |
108 | |
edb1cbcb |
109 | make realclean |
c3edaffb |
110 | |
dc45a647 |
111 | The only difference between the two is that make distclean also removes |
112 | your old config.sh and Policy.sh files. |
113 | |
114 | The results of a Configure run are stored in the config.sh and Policy.sh |
115 | files. If you are upgrading from a previous version of perl, or if you |
116 | change systems or compilers or make other significant changes, or if |
117 | you are experiencing difficulties building perl, you should probably |
118 | not re-use your old config.sh. Simply remove it or rename it, e.g. |
8e07c86e |
119 | |
120 | mv config.sh config.sh.old |
4633a7c4 |
121 | |
e57fd563 |
122 | If you wish to use your old config.sh, be especially attentive to the |
123 | version and architecture-specific questions and answers. For example, |
124 | the default directory for architecture-dependent library modules |
125 | includes the version name. By default, Configure will reuse your old |
126 | name (e.g. /opt/perl/lib/i86pc-solaris/5.003) even if you're running |
127 | Configure for a different version, e.g. 5.004. Yes, Configure should |
128 | probably check and correct for this, but it doesn't, presently. |
129 | Similarly, if you used a shared libperl.so (see below) with version |
130 | numbers, you will probably want to adjust them as well. |
131 | |
132 | Also, be careful to check your architecture name. Some Linux systems |
bfb7748a |
133 | (such as Debian) use i386, while others may use i486, i586, or i686. |
134 | If you pick up a precompiled binary, it might not use the same name. |
e57fd563 |
135 | |
136 | In short, if you wish to use your old config.sh, I recommend running |
137 | Configure interactively rather than blindly accepting the defaults. |
8e07c86e |
138 | |
dc45a647 |
139 | If your reason to reuse your old config.sh is to save your |
140 | particular installation choices, then you can probably achieve the |
141 | same effect by using the new Policy.sh file. See the section on |
142 | L<"Site-wide Policy settings"> below. |
143 | |
aa689395 |
144 | =head1 Run Configure |
8e07c86e |
145 | |
146 | Configure will figure out various things about your system. Some |
147 | things Configure will figure out for itself, other things it will ask |
1ec51d55 |
148 | you about. To accept the default, just press RETURN. The default |
a3cb178b |
149 | is almost always okay. At any Configure prompt, you can type &-d |
203c3eec |
150 | and Configure will use the defaults from then on. |
8e07c86e |
151 | |
152 | After it runs, Configure will perform variable substitution on all the |
1ec51d55 |
153 | *.SH files and offer to run make depend. |
8e07c86e |
154 | |
fb73857a |
155 | Configure supports a number of useful options. Run B<Configure -h> to |
156 | get a listing. See the Porting/Glossary file for a complete list of |
157 | Configure variables you can set and their definitions. |
158 | |
159 | To compile with gcc, for example, you should run |
8e07c86e |
160 | |
161 | sh Configure -Dcc=gcc |
162 | |
163 | This is the preferred way to specify gcc (or another alternative |
164 | compiler) so that the hints files can set appropriate defaults. |
165 | |
4633a7c4 |
166 | If you want to use your old config.sh but override some of the items |
167 | with command line options, you need to use B<Configure -O>. |
168 | |
8e07c86e |
169 | By default, for most systems, perl will be installed in |
170 | /usr/local/{bin, lib, man}. You can specify a different 'prefix' for |
171 | the default installation directory, when Configure prompts you or by |
172 | using the Configure command line option -Dprefix='/some/directory', |
173 | e.g. |
174 | |
25f94b33 |
175 | sh Configure -Dprefix=/opt/perl |
4633a7c4 |
176 | |
177 | If your prefix contains the string "perl", then the directories |
178 | are simplified. For example, if you use prefix=/opt/perl, |
179 | then Configure will suggest /opt/perl/lib instead of |
4fdae800 |
180 | /opt/perl/lib/perl5/. |
8e07c86e |
181 | |
84902520 |
182 | NOTE: You must not specify an installation directory that is below |
183 | your perl source directory. If you do, installperl will attempt |
184 | infinite recursion. |
185 | |
a3cb178b |
186 | It may seem obvious to say, but Perl is useful only when users can |
dd64f1c3 |
187 | easily find it. It's often a good idea to have both /usr/bin/perl and |
188 | /usr/local/bin/perl be symlinks to the actual binary. Be especially |
189 | careful, however, of overwriting a version of perl supplied by your |
190 | vendor. In any case, system administrators are strongly encouraged to |
191 | put (symlinks to) perl and its accompanying utilities, such as perldoc, |
4682965a |
192 | into a directory typically found along a user's PATH, or in another |
193 | obvious and convenient place. |
194 | |
04d420f9 |
195 | You can use "Configure -Uinstallusrbinperl" which causes installperl |
196 | to skip installing perl also as /usr/bin/perl. |
197 | |
aa689395 |
198 | By default, Configure will compile perl to use dynamic loading if |
8e07c86e |
199 | your system supports it. If you want to force perl to be compiled |
56c6f531 |
200 | statically, you can either choose this when Configure prompts you or |
201 | you can use the Configure command line option -Uusedl. |
8e07c86e |
202 | |
203c3eec |
203 | If you are willing to accept all the defaults, and you want terse |
204 | output, you can run |
205 | |
206 | sh Configure -des |
207 | |
208 | For my Solaris system, I usually use |
209 | |
210 | sh Configure -Dprefix=/opt/perl -Doptimize='-xpentium -xO4' -des |
211 | |
46bb10fb |
212 | =head2 GNU-style configure |
213 | |
1ec51d55 |
214 | If you prefer the GNU-style configure command line interface, you can |
dc45a647 |
215 | use the supplied configure.gnu command, e.g. |
46bb10fb |
216 | |
693762b4 |
217 | CC=gcc ./configure.gnu |
46bb10fb |
218 | |
dc45a647 |
219 | The configure.gnu script emulates a few of the more common configure |
46bb10fb |
220 | options. Try |
221 | |
693762b4 |
222 | ./configure.gnu --help |
46bb10fb |
223 | |
224 | for a listing. |
225 | |
aa689395 |
226 | Cross compiling is not supported. |
46bb10fb |
227 | |
dc45a647 |
228 | (The file is called configure.gnu to avoid problems on systems |
693762b4 |
229 | that would not distinguish the files "Configure" and "configure".) |
46bb10fb |
230 | |
24b3df7f |
231 | =head2 Extensions |
232 | |
edb1cbcb |
233 | By default, Configure will offer to build every extension which appears |
234 | to be supported. For example, Configure will offer to build GDBM_File |
235 | only if it is able to find the gdbm library. (See examples below.) |
693762b4 |
236 | B, DynaLoader, Fcntl, IO, and attrs are always built by default. |
237 | Configure does not contain code to test for POSIX compliance, so POSIX |
238 | is always built by default as well. If you wish to skip POSIX, you can |
239 | set the Configure variable useposix=false either in a hint file or from |
240 | the Configure command line. Similarly, the Opcode extension is always |
241 | built by default, but you can skip it by setting the Configure variable |
c3edaffb |
242 | useopcode=false either in a hint file for from the command line. |
24b3df7f |
243 | |
1ec51d55 |
244 | You can learn more about each of these extensions by consulting the |
245 | documentation in the individual .pm modules, located under the |
246 | ext/ subdirectory. |
247 | |
56c6f531 |
248 | Even if you do not have dynamic loading, you must still build the |
249 | DynaLoader extension; you should just build the stub dl_none.xs |
250 | version. (Configure will suggest this as the default.) |
251 | |
24b3df7f |
252 | In summary, here are the Configure command-line variables you can set |
253 | to turn off each extension: |
254 | |
693762b4 |
255 | B (Always included by default) |
24b3df7f |
256 | DB_File i_db |
56c6f531 |
257 | DynaLoader (Must always be included as a static extension) |
24b3df7f |
258 | Fcntl (Always included by default) |
259 | GDBM_File i_gdbm |
9d67150a |
260 | IO (Always included by default) |
24b3df7f |
261 | NDBM_File i_ndbm |
262 | ODBM_File i_dbm |
263 | POSIX useposix |
264 | SDBM_File (Always included by default) |
c3edaffb |
265 | Opcode useopcode |
24b3df7f |
266 | Socket d_socket |
693762b4 |
267 | Threads usethreads |
268 | attrs (Always included by default) |
24b3df7f |
269 | |
270 | Thus to skip the NDBM_File extension, you can use |
271 | |
272 | sh Configure -Ui_ndbm |
273 | |
274 | Again, this is taken care of automatically if you don't have the ndbm |
275 | library. |
276 | |
277 | Of course, you may always run Configure interactively and select only |
aa689395 |
278 | the extensions you want. |
24b3df7f |
279 | |
693762b4 |
280 | Note: The DB_File module will only work with version 1.x of Berkeley |
281 | DB or newer releases of version 2. Configure will automatically detect |
282 | this for you and refuse to try to build DB_File with version 2. |
1ec51d55 |
283 | |
dc45a647 |
284 | If you re-use your old config.sh but change your system (e.g. by |
285 | adding libgdbm) Configure will still offer your old choices of extensions |
286 | for the default answer, but it will also point out the discrepancy to |
287 | you. |
288 | |
24b3df7f |
289 | Finally, if you have dynamic loading (most modern Unix systems do) |
290 | remember that these extensions do not increase the size of your perl |
291 | executable, nor do they impact start-up time, so you probably might as |
292 | well build all the ones that will work on your system. |
293 | |
8e07c86e |
294 | =head2 Including locally-installed libraries |
295 | |
4633a7c4 |
296 | Perl5 comes with interfaces to number of database extensions, including |
297 | dbm, ndbm, gdbm, and Berkeley db. For each extension, if |
298 | Configure can find the appropriate header files and libraries, it will |
299 | automatically include that extension. The gdbm and db libraries |
1ec51d55 |
300 | are not included with perl. See the library documentation for |
4633a7c4 |
301 | how to obtain the libraries. |
8e07c86e |
302 | |
1ec51d55 |
303 | Note: If your database header (.h) files are not in a |
8e07c86e |
304 | directory normally searched by your C compiler, then you will need to |
1ec51d55 |
305 | include the appropriate -I/your/directory option when prompted by |
8e07c86e |
306 | Configure. If your database library (.a) files are not in a directory |
307 | normally searched by your C compiler and linker, then you will need to |
1ec51d55 |
308 | include the appropriate -L/your/directory option when prompted by |
8e07c86e |
309 | Configure. See the examples below. |
310 | |
311 | =head2 Examples |
312 | |
313 | =over 4 |
314 | |
aa689395 |
315 | =item gdbm in /usr/local |
8e07c86e |
316 | |
317 | Suppose you have gdbm and want Configure to find it and build the |
1ec51d55 |
318 | GDBM_File extension. This examples assumes you have gdbm.h |
319 | installed in /usr/local/include/gdbm.h and libgdbm.a installed in |
320 | /usr/local/lib/libgdbm.a. Configure should figure all the |
8e07c86e |
321 | necessary steps out automatically. |
322 | |
323 | Specifically, when Configure prompts you for flags for |
1ec51d55 |
324 | your C compiler, you should include -I/usr/local/include. |
8e07c86e |
325 | |
326 | When Configure prompts you for linker flags, you should include |
1ec51d55 |
327 | -L/usr/local/lib. |
8e07c86e |
328 | |
329 | If you are using dynamic loading, then when Configure prompts you for |
330 | linker flags for dynamic loading, you should again include |
1ec51d55 |
331 | -L/usr/local/lib. |
8e07c86e |
332 | |
333 | Again, this should all happen automatically. If you want to accept the |
334 | defaults for all the questions and have Configure print out only terse |
335 | messages, then you can just run |
336 | |
337 | sh Configure -des |
338 | |
339 | and Configure should include the GDBM_File extension automatically. |
340 | |
341 | This should actually work if you have gdbm installed in any of |
342 | (/usr/local, /opt/local, /usr/gnu, /opt/gnu, /usr/GNU, or /opt/GNU). |
343 | |
344 | =item gdbm in /usr/you |
345 | |
346 | Suppose you have gdbm installed in some place other than /usr/local/, |
3a6175e1 |
347 | but you still want Configure to find it. To be specific, assume you |
1ec51d55 |
348 | have /usr/you/include/gdbm.h and /usr/you/lib/libgdbm.a. You |
349 | still have to add -I/usr/you/include to cc flags, but you have to take |
350 | an extra step to help Configure find libgdbm.a. Specifically, when |
8e07c86e |
351 | Configure prompts you for library directories, you have to add |
1ec51d55 |
352 | /usr/you/lib to the list. |
8e07c86e |
353 | |
354 | It is possible to specify this from the command line too (all on one |
355 | line): |
356 | |
357 | sh Configure -des \ |
358 | -Dlocincpth="/usr/you/include" \ |
359 | -Dloclibpth="/usr/you/lib" |
360 | |
1ec51d55 |
361 | locincpth is a space-separated list of include directories to search. |
362 | Configure will automatically add the appropriate -I directives. |
8e07c86e |
363 | |
1ec51d55 |
364 | loclibpth is a space-separated list of library directories to search. |
365 | Configure will automatically add the appropriate -L directives. If |
366 | you have some libraries under /usr/local/ and others under |
367 | /usr/you, then you have to include both, namely |
8e07c86e |
368 | |
369 | sh Configure -des \ |
370 | -Dlocincpth="/usr/you/include /usr/local/include" \ |
371 | -Dloclibpth="/usr/you/lib /usr/local/lib" |
372 | |
373 | =back |
374 | |
aa689395 |
375 | =head2 Installation Directories |
4633a7c4 |
376 | |
377 | The installation directories can all be changed by answering the |
378 | appropriate questions in Configure. For convenience, all the |
379 | installation questions are near the beginning of Configure. |
380 | |
7beaa944 |
381 | I highly recommend running Configure interactively to be sure it puts |
382 | everything where you want it. At any point during the Configure |
383 | process, you can answer a question with &-d and Configure |
384 | will use the defaults from then on. |
1ec51d55 |
385 | |
3a6175e1 |
386 | By default, Configure will use the following directories for library files |
387 | for 5.005 (archname is a string like sun4-sunos, determined by Configure). |
4633a7c4 |
388 | |
3a6175e1 |
389 | Configure variable Default value |
390 | $archlib /usr/local/lib/perl5/5.005/archname |
391 | $privlib /usr/local/lib/perl5/5.005 |
392 | $sitearch /usr/local/lib/perl5/site_perl/5.005/archname |
393 | $sitelib /usr/local/lib/perl5/site_perl/5.005 |
4633a7c4 |
394 | |
3a6175e1 |
395 | Some users prefer to append a "/share" to $privlib and $sitelib |
396 | to emphasize that those directories can be shared among different |
397 | architectures. |
4633a7c4 |
398 | |
3a6175e1 |
399 | By default, Configure will use the following directories for manual pages: |
400 | |
401 | Configure variable Default value |
402 | $man1dir /usr/local/man/man1 |
403 | $man3dir /usr/local/lib/perl5/man/man3 |
4633a7c4 |
404 | |
405 | (Actually, Configure recognizes the SVR3-style |
406 | /usr/local/man/l_man/man1 directories, if present, and uses those |
fb73857a |
407 | instead.) |
408 | |
409 | The module man pages are stuck in that strange spot so that |
4633a7c4 |
410 | they don't collide with other man pages stored in /usr/local/man/man3, |
411 | and so that Perl's man pages don't hide system man pages. On some |
412 | systems, B<man less> would end up calling up Perl's less.pm module man |
fb73857a |
413 | page, rather than the less program. (This default location will likely |
414 | change to /usr/local/man/man3 in a future release of perl.) |
1ec51d55 |
415 | |
416 | Note: Many users prefer to store the module man pages in |
417 | /usr/local/man/man3. You can do this from the command line with |
418 | |
419 | sh Configure -Dman3dir=/usr/local/man/man3 |
420 | |
421 | Some users also prefer to use a .3pm suffix. You can do that with |
422 | |
423 | sh Configure -Dman3ext=3pm |
4633a7c4 |
424 | |
425 | If you specify a prefix that contains the string "perl", then the |
aa689395 |
426 | directory structure is simplified. For example, if you Configure with |
bfb7748a |
427 | -Dprefix=/opt/perl, then the defaults for 5.005 are |
4633a7c4 |
428 | |
3a6175e1 |
429 | Configure variable Default value |
430 | $archlib /opt/perl/lib/5.005/archname |
431 | $privlib /opt/perl/lib/5.005 |
432 | $sitearch /opt/perl/lib/site_perl/5.005/archname |
433 | $sitelib /opt/perl/lib/site_perl/5.005 |
4633a7c4 |
434 | |
3a6175e1 |
435 | $man1dir /opt/perl/man/man1 |
436 | $man3dir /opt/perl/man/man3 |
4633a7c4 |
437 | |
438 | The perl executable will search the libraries in the order given |
439 | above. |
440 | |
3a6175e1 |
441 | The directories under site_perl are empty, but are intended to be used |
bfb7748a |
442 | for installing local or site-wide extensions. Perl will automatically |
443 | look in these directories. |
4633a7c4 |
444 | |
bfb7748a |
445 | In order to support using things like #!/usr/local/bin/perl5.005 after |
4633a7c4 |
446 | a later version is released, architecture-dependent libraries are |
447 | stored in a version-specific directory, such as |
bfb7748a |
448 | /usr/local/lib/perl5/archname/5.005/. |
449 | |
450 | Further details about the installation directories, maintenance and |
451 | development subversions, and about supporting multiple versions are |
452 | discussed in L<"Coexistence with earlier versions of perl5"> below. |
4633a7c4 |
453 | |
454 | Again, these are just the defaults, and can be changed as you run |
455 | Configure. |
456 | |
aa689395 |
457 | =head2 Changing the installation directory |
458 | |
459 | Configure distinguishes between the directory in which perl (and its |
460 | associated files) should be installed and the directory in which it |
461 | will eventually reside. For most sites, these two are the same; for |
462 | sites that use AFS, this distinction is handled automatically. |
1ec51d55 |
463 | However, sites that use software such as depot to manage software |
aa689395 |
464 | packages may also wish to install perl into a different directory and |
465 | use that management software to move perl to its final destination. |
466 | This section describes how to do this. Someday, Configure may support |
467 | an option -Dinstallprefix=/foo to simplify this. |
468 | |
0dcb58f4 |
469 | Suppose you want to install perl under the /tmp/perl5 directory. You |
470 | can edit config.sh and change all the install* variables to point to |
471 | /tmp/perl5 instead of /usr/local/wherever. Or, you can automate this |
472 | process by placing the following lines in a file config.over before you |
473 | run Configure (replace /tmp/perl5 by a directory of your choice): |
aa689395 |
474 | |
475 | installprefix=/tmp/perl5 |
476 | test -d $installprefix || mkdir $installprefix |
477 | test -d $installprefix/bin || mkdir $installprefix/bin |
478 | installarchlib=`echo $installarchlib | sed "s!$prefix!$installprefix!"` |
479 | installbin=`echo $installbin | sed "s!$prefix!$installprefix!"` |
480 | installman1dir=`echo $installman1dir | sed "s!$prefix!$installprefix!"` |
481 | installman3dir=`echo $installman3dir | sed "s!$prefix!$installprefix!"` |
482 | installprivlib=`echo $installprivlib | sed "s!$prefix!$installprefix!"` |
483 | installscript=`echo $installscript | sed "s!$prefix!$installprefix!"` |
484 | installsitelib=`echo $installsitelib | sed "s!$prefix!$installprefix!"` |
485 | installsitearch=`echo $installsitearch | sed "s!$prefix!$installprefix!"` |
486 | |
487 | Then, you can Configure and install in the usual way: |
488 | |
489 | sh Configure -des |
490 | make |
491 | make test |
492 | make install |
493 | |
693762b4 |
494 | Beware, though, that if you go to try to install new add-on |
495 | extensions, they too will get installed in under '/tmp/perl5' if you |
496 | follow this example. The next section shows one way of dealing with |
497 | that problem. |
498 | |
aa689395 |
499 | =head2 Creating an installable tar archive |
500 | |
501 | If you need to install perl on many identical systems, it is |
502 | convenient to compile it once and create an archive that can be |
d6c1b5d3 |
503 | installed on multiple systems. Suppose, for example, that you want to |
504 | create an archive that can be installed in /opt/perl. |
505 | Here's one way to do that: |
aa689395 |
506 | |
507 | # Set up config.over to install perl into a different directory, |
508 | # e.g. /tmp/perl5 (see previous part). |
d6c1b5d3 |
509 | sh Configure -Dprefix=/opt/perl -des |
aa689395 |
510 | make |
511 | make test |
d6c1b5d3 |
512 | make install # This will install everything into /tmp/perl5. |
aa689395 |
513 | cd /tmp/perl5 |
d6c1b5d3 |
514 | # Edit $archlib/Config.pm and $archlib/.packlist to change all the |
fb73857a |
515 | # install* variables back to reflect where everything will |
d6c1b5d3 |
516 | # really be installed. (That is, change /tmp/perl5 to /opt/perl |
517 | # everywhere in those files.) |
518 | # Check the scripts in $scriptdir to make sure they have the correct |
bfb7748a |
519 | # #!/wherever/perl line. |
aa689395 |
520 | tar cvf ../perl5-archive.tar . |
521 | # Then, on each machine where you want to install perl, |
d6c1b5d3 |
522 | cd /opt/perl # Or wherever you specified as $prefix |
aa689395 |
523 | tar xvf perl5-archive.tar |
524 | |
dc45a647 |
525 | =head2 Site-wide Policy settings |
693762b4 |
526 | |
527 | After Configure runs, it stores a number of common site-wide "policy" |
528 | answers (such as installation directories and the local perl contact |
529 | person) in the Policy.sh file. If you want to build perl on another |
530 | system using the same policy defaults, simply copy the Policy.sh file |
531 | to the new system and Configure will use it along with the appropriate |
532 | hint file for your system. |
533 | |
dc45a647 |
534 | Alternatively, if you wish to change some or all of those policy |
535 | answers, you should |
536 | |
537 | rm -f Policy.sh |
538 | |
539 | to ensure that Configure doesn't re-use them. |
540 | |
541 | Further information is in the Policy_sh.SH file itself. |
542 | |
aa689395 |
543 | =head2 Configure-time Options |
544 | |
545 | There are several different ways to Configure and build perl for your |
546 | system. For most users, the defaults are sensible and will work. |
547 | Some users, however, may wish to further customize perl. Here are |
548 | some of the main things you can change. |
549 | |
693762b4 |
550 | =head2 Threads |
aa689395 |
551 | |
99ed61e6 |
552 | On some platforms, perl5.005 can be compiled with experimental support |
553 | for threads. To enable this, read the file README.threads, and then |
554 | try: |
f7542a9d |
555 | |
693762b4 |
556 | sh Configure -Dusethreads |
aa689395 |
557 | |
693762b4 |
558 | Currently, you need to specify -Dusethreads on the Configure command |
559 | line so that the hint files can make appropriate adjustments. |
560 | |
561 | The default is to compile without thread support. |
3fe9a6f1 |
562 | |
46bb10fb |
563 | =head2 Selecting File IO mechanisms |
564 | |
565 | Previous versions of perl used the standard IO mechanisms as defined in |
1ec51d55 |
566 | stdio.h. Versions 5.003_02 and later of perl allow alternate IO |
46bb10fb |
567 | mechanisms via a "PerlIO" abstraction, but the stdio mechanism is still |
568 | the default and is the only supported mechanism. |
569 | |
570 | This PerlIO abstraction can be enabled either on the Configure command |
571 | line with |
572 | |
573 | sh Configure -Duseperlio |
574 | |
575 | or interactively at the appropriate Configure prompt. |
576 | |
577 | If you choose to use the PerlIO abstraction layer, there are two |
578 | (experimental) possibilities for the underlying IO calls. These have been |
579 | tested to some extent on some platforms, but are not guaranteed to work |
580 | everywhere. |
581 | |
582 | =over 4 |
583 | |
584 | =item 1. |
585 | |
1ec51d55 |
586 | AT&T's "sfio". This has superior performance to stdio.h in many |
aa689395 |
587 | cases, and is extensible by the use of "discipline" modules. Sfio |
46bb10fb |
588 | currently only builds on a subset of the UNIX platforms perl supports. |
589 | Because the data structures are completely different from stdio, perl |
590 | extension modules or external libraries may not work. This |
591 | configuration exists to allow these issues to be worked on. |
592 | |
593 | This option requires the 'sfio' package to have been built and installed. |
bfb7748a |
594 | A (fairly old) version of sfio is in CPAN. |
46bb10fb |
595 | |
596 | You select this option by |
597 | |
598 | sh Configure -Duseperlio -Dusesfio |
599 | |
600 | If you have already selected -Duseperlio, and if Configure detects |
601 | that you have sfio, then sfio will be the default suggested by |
602 | Configure. |
603 | |
1ec51d55 |
604 | Note: On some systems, sfio's iffe configuration script fails |
605 | to detect that you have an atexit function (or equivalent). |
33e6ee5f |
606 | Apparently, this is a problem at least for some versions of Linux |
607 | and SunOS 4. |
608 | |
609 | You can test if you have this problem by trying the following shell |
610 | script. (You may have to add some extra cflags and libraries. A |
611 | portable version of this may eventually make its way into Configure.) |
612 | |
613 | #!/bin/sh |
614 | cat > try.c <<'EOCP' |
615 | #include <stdio.h> |
616 | main() { printf("42\n"); } |
617 | EOCP |
618 | cc -o try try.c -lsfio |
619 | val=`./try` |
620 | if test X$val = X42; then |
621 | echo "Your sfio looks ok" |
622 | else |
623 | echo "Your sfio has the exit problem." |
624 | fi |
625 | |
626 | If you have this problem, the fix is to go back to your sfio sources |
bfb7748a |
627 | and correct iffe's guess about atexit. |
33e6ee5f |
628 | |
629 | There also might be a more recent release of Sfio that fixes your |
630 | problem. |
631 | |
46bb10fb |
632 | =item 2. |
633 | |
634 | Normal stdio IO, but with all IO going through calls to the PerlIO |
635 | abstraction layer. This configuration can be used to check that perl and |
636 | extension modules have been correctly converted to use the PerlIO |
637 | abstraction. |
638 | |
639 | This configuration should work on all platforms (but might not). |
640 | |
aa689395 |
641 | You select this option via: |
46bb10fb |
642 | |
643 | sh Configure -Duseperlio -Uusesfio |
644 | |
645 | If you have already selected -Duseperlio, and if Configure does not |
646 | detect sfio, then this will be the default suggested by Configure. |
647 | |
648 | =back |
649 | |
aa689395 |
650 | =head2 Building a shared libperl.so Perl library |
c3edaffb |
651 | |
652 | Currently, for most systems, the main perl executable is built by |
653 | linking the "perl library" libperl.a with perlmain.o, your static |
654 | extensions (usually just DynaLoader.a) and various extra libraries, |
655 | such as -lm. |
656 | |
9d67150a |
657 | On some systems that support dynamic loading, it may be possible to |
658 | replace libperl.a with a shared libperl.so. If you anticipate building |
c3edaffb |
659 | several different perl binaries (e.g. by embedding libperl into |
660 | different programs, or by using the optional compiler extension), then |
9d67150a |
661 | you might wish to build a shared libperl.so so that all your binaries |
c3edaffb |
662 | can share the same library. |
663 | |
664 | The disadvantages are that there may be a significant performance |
9d67150a |
665 | penalty associated with the shared libperl.so, and that the overall |
aa689395 |
666 | mechanism is still rather fragile with respect to different versions |
c3edaffb |
667 | and upgrades. |
668 | |
669 | In terms of performance, on my test system (Solaris 2.5_x86) the perl |
9d67150a |
670 | test suite took roughly 15% longer to run with the shared libperl.so. |
c3edaffb |
671 | Your system and typical applications may well give quite different |
672 | results. |
673 | |
674 | The default name for the shared library is typically something like |
a6006777 |
675 | libperl.so.3.2 (for Perl 5.003_02) or libperl.so.302 or simply |
9d67150a |
676 | libperl.so. Configure tries to guess a sensible naming convention |
c3edaffb |
677 | based on your C library name. Since the library gets installed in a |
678 | version-specific architecture-dependent directory, the exact name |
679 | isn't very important anyway, as long as your linker is happy. |
680 | |
681 | For some systems (mostly SVR4), building a shared libperl is required |
682 | for dynamic loading to work, and hence is already the default. |
683 | |
684 | You can elect to build a shared libperl by |
685 | |
686 | sh Configure -Duseshrplib |
687 | |
688 | To actually build perl, you must add the current working directory to your |
aa689395 |
689 | LD_LIBRARY_PATH environment variable before running make. You can do |
c3edaffb |
690 | this with |
691 | |
692 | LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH |
693 | |
694 | for Bourne-style shells, or |
695 | |
696 | setenv LD_LIBRARY_PATH `pwd` |
697 | |
698 | for Csh-style shells. You *MUST* do this before running make. |
699 | Folks running NeXT OPENSTEP must substitute DYLD_LIBRARY_PATH for |
700 | LD_LIBRARY_PATH above. |
701 | |
9d67150a |
702 | There is also an potential problem with the shared perl library if you |
703 | want to have more than one "flavor" of the same version of perl (e.g. |
704 | with and without -DDEBUGGING). For example, suppose you build and |
a6006777 |
705 | install a standard Perl 5.004 with a shared library. Then, suppose you |
706 | try to build Perl 5.004 with -DDEBUGGING enabled, but everything else |
9d67150a |
707 | the same, including all the installation directories. How can you |
708 | ensure that your newly built perl will link with your newly built |
7f678428 |
709 | libperl.so.4 rather with the installed libperl.so.4? The answer is |
9d67150a |
710 | that you might not be able to. The installation directory is encoded |
56c6f531 |
711 | in the perl binary with the LD_RUN_PATH environment variable (or |
712 | equivalent ld command-line option). On Solaris, you can override that |
7beaa944 |
713 | with LD_LIBRARY_PATH; on Linux you can't. On Digital Unix, you can |
0dcb58f4 |
714 | override LD_LIBRARY_PATH by setting the _RLD_ROOT environment variable |
7beaa944 |
715 | to point to the perl build directory. |
9d67150a |
716 | |
717 | The only reliable answer is that you should specify a different |
718 | directory for the architecture-dependent library for your -DDEBUGGING |
fb73857a |
719 | version of perl. You can do this by changing all the *archlib* |
9d67150a |
720 | variables in config.sh, namely archlib, archlib_exp, and |
721 | installarchlib, to point to your new architecture-dependent library. |
722 | |
55479bb6 |
723 | =head2 Malloc Issues |
724 | |
725 | Perl relies heavily on malloc(3) to grow data structures as needed, so |
726 | perl's performance can be noticeably affected by the performance of |
727 | the malloc function on your system. |
728 | |
bfb7748a |
729 | The perl source is shipped with a version of malloc that is very fast but |
730 | somewhat wasteful of space. On the other hand, your system's malloc |
731 | function may be a bit slower but also a bit more frugal. However, |
732 | as of 5.004_68, perl's malloc has been optimized for the typical |
733 | requests from perl, so there's a chance that it may be both faster and |
734 | use less memory. |
55479bb6 |
735 | |
736 | For many uses, speed is probably the most important consideration, so |
737 | the default behavior (for most systems) is to use the malloc supplied |
738 | with perl. However, if you will be running very large applications |
739 | (e.g. Tk or PDL) or if your system already has an excellent malloc, or |
740 | if you are experiencing difficulties with extensions that use |
741 | third-party libraries that call malloc, then you might wish to use |
87c6202a |
742 | your system's malloc. (Or, you might wish to explore the malloc flags |
743 | discussed below.) |
55479bb6 |
744 | |
745 | To build without perl's malloc, you can use the Configure command |
746 | |
747 | sh Configure -Uusemymalloc |
748 | |
749 | or you can answer 'n' at the appropriate interactive Configure prompt. |
750 | |
86058a2d |
751 | Note that Perl's malloc family of functions are called Perl_malloc(), |
752 | Perl_realloc(), Perl_calloc() and Perl_mfree(). The names do not clash |
753 | with the system versions of these functions. See -DPERL_POLLUTE_MALLOC |
754 | below if you want to do that for some reason. |
755 | |
aa689395 |
756 | =head2 Malloc Performance Flags |
c3edaffb |
757 | |
87c6202a |
758 | If you are using Perl's malloc, you may add one or more of the following |
808270a4 |
759 | items to your ccflags config.sh variable to change its behavior. You can |
87c6202a |
760 | find out more about these and other flags by reading the commentary near |
bfb7748a |
761 | the top of the malloc.c source. The defaults should be fine for |
762 | nearly everyone. |
c3edaffb |
763 | |
aa689395 |
764 | =over 4 |
765 | |
87c6202a |
766 | =item -DNO_FANCY_MALLOC |
2ae324a7 |
767 | |
bfb7748a |
768 | Undefined by default. Defining it returns malloc to the version used |
769 | in Perl 5.004. |
aa689395 |
770 | |
87c6202a |
771 | =item -DPLAIN_MALLOC |
aa689395 |
772 | |
87c6202a |
773 | Undefined by default. Defining it in addition to NO_FANCY_MALLOC returns |
bfb7748a |
774 | malloc to the version used in Perl version 5.000. |
aa689395 |
775 | |
86058a2d |
776 | =item -DPERL_POLLUTE_MALLOC |
777 | |
778 | Undefined by default. This is used to force Perl's malloc family of functions |
779 | to have the same names as the system versions. This is normally only required |
780 | when you have a need to replace the system versions of these functions. |
781 | This may be sometimes required when you have libraries that like to free() |
782 | data that may have been allocated by Perl_malloc() and vice versa. |
783 | |
784 | Note that enabling this option may sometimes lead to duplicate symbols from |
785 | the linker for malloc et al. In such cases, the system probably does not |
786 | allow its malloc functions to be fully replaced with custom versions. |
787 | |
aa689395 |
788 | =back |
789 | |
3bf462b8 |
790 | =head2 Building a debugging perl |
791 | |
792 | You can run perl scripts under the perl debugger at any time with |
3fe9a6f1 |
793 | B<perl -d your_script>. If, however, you want to debug perl itself, |
3bf462b8 |
794 | you probably want to do |
795 | |
796 | sh Configure -Doptimize='-g' |
797 | |
203c3eec |
798 | This will do two independent things: First, it will force compilation |
799 | to use cc -g so that you can use your system's debugger on the |
800 | executable. (Note: Your system may actually require something like |
a3cb178b |
801 | cc -g2. Check your man pages for cc(1) and also any hint file for your |
203c3eec |
802 | system.) Second, it will add -DDEBUGGING to your ccflags variable in |
1ec51d55 |
803 | config.sh so that you can use B<perl -D> to access perl's internal |
203c3eec |
804 | state. (Note: Configure will only add -DDEBUGGING by |
1ec51d55 |
805 | default if you are not reusing your old config.sh. If you want to |
806 | reuse your old config.sh, then you can just edit it and change the |
3fe9a6f1 |
807 | optimize and ccflags variables by hand and then propagate your changes |
203c3eec |
808 | as shown in L<"Propagating your changes to config.sh"> below.) |
809 | |
810 | You can actually specify -g and -DDEBUGGING independently, but usually |
811 | it's convenient to have both. |
3bf462b8 |
812 | |
813 | If you are using a shared libperl, see the warnings about multiple |
814 | versions of perl under L<Building a shared libperl.so Perl library>. |
815 | |
aa689395 |
816 | =head2 Other Compiler Flags |
817 | |
818 | For most users, all of the Configure defaults are fine. However, |
819 | you can change a number of factors in the way perl is built |
1ec51d55 |
820 | by adding appropriate -D directives to your ccflags variable in |
aa689395 |
821 | config.sh. |
822 | |
85ab1d1d |
823 | Starting from Perl 5.005_53 you no more need to replace the rand() and |
824 | srand() functions in the perl source by any other random number |
825 | generator because Configure chooses the widest one available |
826 | (drand48(), srandom(), or rand()). |
203c3eec |
827 | |
828 | You should also run Configure interactively to verify that a hint file |
829 | doesn't inadvertently override your ccflags setting. (Hints files |
830 | shouldn't do that, but some might.) |
c3edaffb |
831 | |
8e07c86e |
832 | =head2 What if it doesn't work? |
833 | |
834 | =over 4 |
835 | |
25f94b33 |
836 | =item Running Configure Interactively |
837 | |
838 | If Configure runs into trouble, remember that you can always run |
839 | Configure interactively so that you can check (and correct) its |
840 | guesses. |
841 | |
842 | All the installation questions have been moved to the top, so you don't |
aa689395 |
843 | have to wait for them. Once you've handled them (and your C compiler and |
1ec51d55 |
844 | flags) you can type &-d at the next Configure prompt and Configure |
25f94b33 |
845 | will use the defaults from then on. |
846 | |
847 | If you find yourself trying obscure command line incantations and |
848 | config.over tricks, I recommend you run Configure interactively |
849 | instead. You'll probably save yourself time in the long run. |
850 | |
aa689395 |
851 | =item Hint files |
8e07c86e |
852 | |
853 | The perl distribution includes a number of system-specific hints files |
854 | in the hints/ directory. If one of them matches your system, Configure |
855 | will offer to use that hint file. |
856 | |
857 | Several of the hint files contain additional important information. |
f5b3b617 |
858 | If you have any problems, it is a good idea to read the relevant hint file |
859 | for further information. See hints/solaris_2.sh for an extensive example. |
860 | More information about writing good hints is in the hints/README.hints |
861 | file. |
8e07c86e |
862 | |
edb1cbcb |
863 | =item *** WHOA THERE!!! *** |
864 | |
865 | Occasionally, Configure makes a wrong guess. For example, on SunOS |
866 | 4.1.3, Configure incorrectly concludes that tzname[] is in the |
867 | standard C library. The hint file is set up to correct for this. You |
868 | will see a message: |
869 | |
870 | *** WHOA THERE!!! *** |
871 | The recommended value for $d_tzname on this machine was "undef"! |
872 | Keep the recommended value? [y] |
873 | |
874 | You should always keep the recommended value unless, after reading the |
875 | relevant section of the hint file, you are sure you want to try |
876 | overriding it. |
877 | |
878 | If you are re-using an old config.sh, the word "previous" will be |
879 | used instead of "recommended". Again, you will almost always want |
880 | to keep the previous value, unless you have changed something on your |
881 | system. |
882 | |
883 | For example, suppose you have added libgdbm.a to your system |
884 | and you decide to reconfigure perl to use GDBM_File. When you run |
885 | Configure again, you will need to add -lgdbm to the list of libraries. |
bfb7748a |
886 | Now, Configure will find your gdbm include file and library and will |
887 | issue a message: |
edb1cbcb |
888 | |
889 | *** WHOA THERE!!! *** |
890 | The previous value for $i_gdbm on this machine was "undef"! |
891 | Keep the previous value? [y] |
892 | |
1ec51d55 |
893 | In this case, you do not want to keep the previous value, so you |
c3edaffb |
894 | should answer 'n'. (You'll also have to manually add GDBM_File to |
edb1cbcb |
895 | the list of dynamic extensions to build.) |
896 | |
8e07c86e |
897 | =item Changing Compilers |
898 | |
899 | If you change compilers or make other significant changes, you should |
1ec51d55 |
900 | probably not re-use your old config.sh. Simply remove it or |
8e07c86e |
901 | rename it, e.g. mv config.sh config.sh.old. Then rerun Configure |
902 | with the options you want to use. |
903 | |
1ec51d55 |
904 | This is a common source of problems. If you change from cc to |
905 | gcc, you should almost always remove your old config.sh. |
8e07c86e |
906 | |
c3edaffb |
907 | =item Propagating your changes to config.sh |
8e07c86e |
908 | |
1ec51d55 |
909 | If you make any changes to config.sh, you should propagate |
910 | them to all the .SH files by running |
911 | |
912 | sh Configure -S |
913 | |
914 | You will then have to rebuild by running |
9d67150a |
915 | |
916 | make depend |
917 | make |
8e07c86e |
918 | |
919 | =item config.over |
920 | |
921 | You can also supply a shell script config.over to over-ride Configure's |
922 | guesses. It will get loaded up at the very end, just before config.sh |
923 | is created. You have to be careful with this, however, as Configure |
d52d4e46 |
924 | does no checking that your changes make sense. See the section on |
7f678428 |
925 | L<"Changing the installation directory"> for an example. |
8e07c86e |
926 | |
927 | =item config.h |
928 | |
1ec51d55 |
929 | Many of the system dependencies are contained in config.h. |
930 | Configure builds config.h by running the config_h.SH script. |
931 | The values for the variables are taken from config.sh. |
8e07c86e |
932 | |
1ec51d55 |
933 | If there are any problems, you can edit config.h directly. Beware, |
934 | though, that the next time you run Configure, your changes will be |
8e07c86e |
935 | lost. |
936 | |
937 | =item cflags |
938 | |
939 | If you have any additional changes to make to the C compiler command |
1ec51d55 |
940 | line, they can be made in cflags.SH. For instance, to turn off the |
941 | optimizer on toke.c, find the line in the switch structure for |
942 | toke.c and put the command optimize='-g' before the ;; . You |
943 | can also edit cflags directly, but beware that your changes will be |
944 | lost the next time you run Configure. |
8e07c86e |
945 | |
f5b3b617 |
946 | To explore various ways of changing ccflags from within a hint file, |
947 | see the file hints/README.hints. |
948 | |
949 | To change the C flags for all the files, edit config.sh and change either |
950 | $ccflags or $optimize, and then re-run |
1ec51d55 |
951 | |
952 | sh Configure -S |
953 | make depend |
8e07c86e |
954 | |
aa689395 |
955 | =item No sh |
8e07c86e |
956 | |
dfe9444c |
957 | If you don't have sh, you'll have to copy the sample file Porting/config_H |
958 | to config.h and edit the config.h to reflect your system's peculiarities. |
8e07c86e |
959 | You'll probably also have to extensively modify the extension building |
960 | mechanism. |
961 | |
c3edaffb |
962 | =item Porting information |
963 | |
2ae324a7 |
964 | Specific information for the OS/2, Plan9, VMS and Win32 ports is in the |
1ec51d55 |
965 | corresponding README files and subdirectories. Additional information, |
966 | including a glossary of all those config.sh variables, is in the Porting |
c3edaffb |
967 | subdirectory. |
968 | |
7f678428 |
969 | Ports for other systems may also be available. You should check out |
1ec51d55 |
970 | http://www.perl.com/CPAN/ports for current information on ports to |
7f678428 |
971 | various other operating systems. |
972 | |
8e07c86e |
973 | =back |
974 | |
975 | =head1 make depend |
976 | |
bfb7748a |
977 | This will look for all the includes. The output is stored in makefile. |
978 | The only difference between Makefile and makefile is the dependencies at |
979 | the bottom of makefile. If you have to make any changes, you should edit |
980 | makefile, not Makefile since the Unix make command reads makefile first. |
981 | (On non-Unix systems, the output may be stored in a different file. |
982 | Check the value of $firstmakefile in your config.sh if in doubt.) |
8e07c86e |
983 | |
984 | Configure will offer to do this step for you, so it isn't listed |
985 | explicitly above. |
986 | |
987 | =head1 make |
988 | |
989 | This will attempt to make perl in the current directory. |
990 | |
991 | If you can't compile successfully, try some of the following ideas. |
7f678428 |
992 | If none of them help, and careful reading of the error message and |
993 | the relevant manual pages on your system doesn't help, you can |
994 | send a message to either the comp.lang.perl.misc newsgroup or to |
995 | perlbug@perl.com with an accurate description of your problem. |
aa689395 |
996 | See L<"Reporting Problems"> below. |
8e07c86e |
997 | |
998 | =over 4 |
999 | |
1ec51d55 |
1000 | =item hints |
8e07c86e |
1001 | |
1002 | If you used a hint file, try reading the comments in the hint file |
1003 | for further tips and information. |
1004 | |
1ec51d55 |
1005 | =item extensions |
8e07c86e |
1006 | |
1ec51d55 |
1007 | If you can successfully build miniperl, but the process crashes |
c3edaffb |
1008 | during the building of extensions, you should run |
1009 | |
3a6175e1 |
1010 | make minitest |
c3edaffb |
1011 | |
1012 | to test your version of miniperl. |
1013 | |
e57fd563 |
1014 | =item locale |
1015 | |
bfb7748a |
1016 | If you have any locale-related environment variables set, try unsetting |
1017 | them. I have some reports that some versions of IRIX hang while |
1018 | running B<./miniperl configpm> with locales other than the C locale. |
1019 | See the discussion under L<"make test"> below about locales and the |
1020 | whole L<"Locale problems"> section in the file pod/perllocale.pod. |
3e6e419a |
1021 | The latter is especially useful if you see something like this |
1022 | |
1023 | perl: warning: Setting locale failed. |
1024 | perl: warning: Please check that your locale settings: |
1025 | LC_ALL = "En_US", |
1026 | LANG = (unset) |
1027 | are supported and installed on your system. |
1028 | perl: warning: Falling back to the standard locale ("C"). |
1029 | |
1030 | at Perl startup. |
e57fd563 |
1031 | |
7f678428 |
1032 | =item varargs |
c3edaffb |
1033 | |
1034 | If you get varargs problems with gcc, be sure that gcc is installed |
bfb7748a |
1035 | correctly and that you are not passing -I/usr/include to gcc. When using |
1036 | gcc, you should probably have i_stdarg='define' and i_varargs='undef' |
1037 | in config.sh. The problem is usually solved by running fixincludes |
1038 | correctly. If you do change config.sh, don't forget to propagate |
1039 | your changes (see L<"Propagating your changes to config.sh"> below). |
7f678428 |
1040 | See also the L<"vsprintf"> item below. |
c3edaffb |
1041 | |
bfb7748a |
1042 | =item util.c |
c3edaffb |
1043 | |
1044 | If you get error messages such as the following (the exact line |
bfb7748a |
1045 | numbers and function name may vary in different versions of perl): |
c3edaffb |
1046 | |
bfb7748a |
1047 | util.c: In function `Perl_form': |
1048 | util.c:1107: number of arguments doesn't match prototype |
1049 | proto.h:125: prototype declaration |
c3edaffb |
1050 | |
1051 | it might well be a symptom of the gcc "varargs problem". See the |
7f678428 |
1052 | previous L<"varargs"> item. |
c3edaffb |
1053 | |
9d67150a |
1054 | =item Solaris and SunOS dynamic loading |
c3edaffb |
1055 | |
1056 | If you have problems with dynamic loading using gcc on SunOS or |
1057 | Solaris, and you are using GNU as and GNU ld, you may need to add |
1ec51d55 |
1058 | -B/bin/ (for SunOS) or -B/usr/ccs/bin/ (for Solaris) to your |
c3edaffb |
1059 | $ccflags, $ldflags, and $lddlflags so that the system's versions of as |
6877a1cf |
1060 | and ld are used. Note that the trailing '/' is required. |
1061 | Alternatively, you can use the GCC_EXEC_PREFIX |
c3edaffb |
1062 | environment variable to ensure that Sun's as and ld are used. Consult |
1ec51d55 |
1063 | your gcc documentation for further information on the -B option and |
c3edaffb |
1064 | the GCC_EXEC_PREFIX variable. |
1065 | |
7beaa944 |
1066 | One convenient way to ensure you are not using GNU as and ld is to |
1067 | invoke Configure with |
1068 | |
1069 | sh Configure -Dcc='gcc -B/usr/ccs/bin/' |
1070 | |
1071 | for Solaris systems. For a SunOS system, you must use -B/bin/ |
1072 | instead. |
1073 | |
84902520 |
1074 | Alternatively, recent versions of GNU ld reportedly work if you |
1075 | include C<-Wl,-export-dynamic> in the ccdlflags variable in |
1076 | config.sh. |
1077 | |
9d67150a |
1078 | =item ld.so.1: ./perl: fatal: relocation error: |
1079 | |
1080 | If you get this message on SunOS or Solaris, and you're using gcc, |
7f678428 |
1081 | it's probably the GNU as or GNU ld problem in the previous item |
1082 | L<"Solaris and SunOS dynamic loading">. |
9d67150a |
1083 | |
1ec51d55 |
1084 | =item LD_LIBRARY_PATH |
c3edaffb |
1085 | |
1086 | If you run into dynamic loading problems, check your setting of |
aa689395 |
1087 | the LD_LIBRARY_PATH environment variable. If you're creating a static |
1088 | Perl library (libperl.a rather than libperl.so) it should build |
c3edaffb |
1089 | fine with LD_LIBRARY_PATH unset, though that may depend on details |
1090 | of your local set-up. |
1091 | |
1092 | =item dlopen: stub interception failed |
1093 | |
1094 | The primary cause of the 'dlopen: stub interception failed' message is |
1095 | that the LD_LIBRARY_PATH environment variable includes a directory |
1096 | which is a symlink to /usr/lib (such as /lib). |
1097 | |
aa689395 |
1098 | The reason this causes a problem is quite subtle. The file libdl.so.1.0 |
c3edaffb |
1099 | actually *only* contains functions which generate 'stub interception |
1100 | failed' errors! The runtime linker intercepts links to |
1101 | "/usr/lib/libdl.so.1.0" and links in internal implementation of those |
1102 | functions instead. [Thanks to Tim Bunce for this explanation.] |
1103 | |
aa689395 |
1104 | =item nm extraction |
c3edaffb |
1105 | |
1106 | If Configure seems to be having trouble finding library functions, |
1107 | try not using nm extraction. You can do this from the command line |
1108 | with |
1109 | |
1110 | sh Configure -Uusenm |
1111 | |
1112 | or by answering the nm extraction question interactively. |
1ec51d55 |
1113 | If you have previously run Configure, you should not reuse your old |
c3edaffb |
1114 | config.sh. |
1115 | |
bfb7748a |
1116 | =item umask not found |
1117 | |
1118 | If the build processes encounters errors relating to umask(), the problem |
1119 | is probably that Configure couldn't find your umask() system call. |
1120 | Check your config.sh. You should have d_umask='define'. If you don't, |
1121 | this is probably the L<"nm extraction"> problem discussed above. Also, |
1122 | try reading the hints file for your system for further information. |
1123 | |
7f678428 |
1124 | =item vsprintf |
c3edaffb |
1125 | |
1126 | If you run into problems with vsprintf in compiling util.c, the |
1127 | problem is probably that Configure failed to detect your system's |
1128 | version of vsprintf(). Check whether your system has vprintf(). |
1129 | (Virtually all modern Unix systems do.) Then, check the variable |
1130 | d_vprintf in config.sh. If your system has vprintf, it should be: |
1131 | |
1132 | d_vprintf='define' |
1133 | |
1134 | If Configure guessed wrong, it is likely that Configure guessed wrong |
bfb7748a |
1135 | on a number of other common functions too. This is probably |
1136 | the L<"nm extraction"> problem discussed above. |
c3edaffb |
1137 | |
3fe9a6f1 |
1138 | =item do_aspawn |
1139 | |
1140 | If you run into problems relating to do_aspawn or do_spawn, the |
1141 | problem is probably that Configure failed to detect your system's |
bfb7748a |
1142 | fork() function. Follow the procedure in the previous item |
1143 | on L<"nm extraction">. |
3fe9a6f1 |
1144 | |
84902520 |
1145 | =item __inet_* errors |
1146 | |
1147 | If you receive unresolved symbol errors during Perl build and/or test |
1148 | referring to __inet_* symbols, check to see whether BIND 8.1 is |
1149 | installed. It installs a /usr/local/include/arpa/inet.h that refers to |
1150 | these symbols. Versions of BIND later than 8.1 do not install inet.h |
1151 | in that location and avoid the errors. You should probably update to a |
1152 | newer version of BIND. If you can't, you can either link with the |
1153 | updated resolver library provided with BIND 8.1 or rename |
1154 | /usr/local/bin/arpa/inet.h during the Perl build and test process to |
1155 | avoid the problem. |
1156 | |
aa689395 |
1157 | =item Optimizer |
c3edaffb |
1158 | |
9d67150a |
1159 | If you can't compile successfully, try turning off your compiler's |
aa689395 |
1160 | optimizer. Edit config.sh and change the line |
9d67150a |
1161 | |
1162 | optimize='-O' |
1163 | |
bfb7748a |
1164 | to |
9d67150a |
1165 | |
1166 | optimize=' ' |
1167 | |
1168 | then propagate your changes with B<sh Configure -S> and rebuild |
1169 | with B<make depend; make>. |
1170 | |
1ec51d55 |
1171 | =item CRIPPLED_CC |
9d67150a |
1172 | |
1ec51d55 |
1173 | If you still can't compile successfully, try adding a -DCRIPPLED_CC |
56c6f531 |
1174 | flag. (Just because you get no errors doesn't mean it compiled right!) |
1175 | This simplifies some complicated expressions for compilers that get |
1176 | indigestion easily. |
9d67150a |
1177 | |
1178 | =item Missing functions |
1179 | |
1180 | If you have missing routines, you probably need to add some library or |
1181 | other, or you need to undefine some feature that Configure thought was |
1182 | there but is defective or incomplete. Look through config.h for |
bfb7748a |
1183 | likely suspects. If Configure guessed wrong on a number of functions, |
1184 | you might have the L<"nm extraction"> problem discussed above. |
8e07c86e |
1185 | |
1ec51d55 |
1186 | =item toke.c |
8e07c86e |
1187 | |
1ec51d55 |
1188 | Some compilers will not compile or optimize the larger files (such as |
1189 | toke.c) without some extra switches to use larger jump offsets or |
1190 | allocate larger internal tables. You can customize the switches for |
1191 | each file in cflags. It's okay to insert rules for specific files into |
1192 | makefile since a default rule only takes effect in the absence of a |
8e07c86e |
1193 | specific rule. |
1194 | |
7f678428 |
1195 | =item Missing dbmclose |
8e07c86e |
1196 | |
c3edaffb |
1197 | SCO prior to 3.2.4 may be missing dbmclose(). An upgrade to 3.2.4 |
1198 | that includes libdbm.nfs (which includes dbmclose()) may be available. |
8e07c86e |
1199 | |
f3d9a6ba |
1200 | =item Note (probably harmless): No library found for -lsomething |
7f678428 |
1201 | |
1202 | If you see such a message during the building of an extension, but |
1203 | the extension passes its tests anyway (see L<"make test"> below), |
1204 | then don't worry about the warning message. The extension |
1205 | Makefile.PL goes looking for various libraries needed on various |
aa689395 |
1206 | systems; few systems will need all the possible libraries listed. |
7f678428 |
1207 | For example, a system may have -lcposix or -lposix, but it's |
1208 | unlikely to have both, so most users will see warnings for the one |
f3d9a6ba |
1209 | they don't have. The phrase 'probably harmless' is intended to |
1210 | reassure you that nothing unusual is happening, and the build |
1211 | process is continuing. |
7f678428 |
1212 | |
1213 | On the other hand, if you are building GDBM_File and you get the |
1214 | message |
1215 | |
f3d9a6ba |
1216 | Note (probably harmless): No library found for -lgdbm |
7f678428 |
1217 | |
1218 | then it's likely you're going to run into trouble somewhere along |
1219 | the line, since it's hard to see how you can use the GDBM_File |
1220 | extension without the -lgdbm library. |
1221 | |
1222 | It is true that, in principle, Configure could have figured all of |
1223 | this out, but Configure and the extension building process are not |
1224 | quite that tightly coordinated. |
1225 | |
aa689395 |
1226 | =item sh: ar: not found |
1227 | |
1228 | This is a message from your shell telling you that the command 'ar' |
1229 | was not found. You need to check your PATH environment variable to |
1230 | make sure that it includes the directory with the 'ar' command. This |
1ec51d55 |
1231 | is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin |
aa689395 |
1232 | directory. |
1233 | |
1234 | =item db-recno failure on tests 51, 53 and 55 |
1235 | |
1236 | Old versions of the DB library (including the DB library which comes |
1237 | with FreeBSD 2.1) had broken handling of recno databases with modified |
1238 | bval settings. Upgrade your DB library or OS. |
1239 | |
6087ac44 |
1240 | =item Bad arg length for semctl, is XX, should be ZZZ |
1241 | |
1242 | If you get this error message from the lib/ipc_sysv test, your System |
1243 | V IPC may be broken. The XX typically is 20, and that is what ZZZ |
1244 | also should be. Consider upgrading your OS, or reconfiguring your OS |
1245 | to include the System V semaphores. |
1246 | |
220f3621 |
1247 | =item lib/ipc_sysv........semget: No space left on device |
1248 | |
1249 | Either your account or the whole system has run out of semaphores. Or |
1250 | both. Either list the semaphores with "ipcs" and remove the unneeded |
1251 | ones (which ones these are depends on your system and applications) |
1252 | with "ipcrm -s SEMAPHORE_ID_HERE" or configure more semaphores to your |
1253 | system. |
1254 | |
1ec51d55 |
1255 | =item Miscellaneous |
8e07c86e |
1256 | |
1257 | Some additional things that have been reported for either perl4 or perl5: |
1258 | |
1259 | Genix may need to use libc rather than libc_s, or #undef VARARGS. |
1260 | |
1261 | NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR. |
1262 | |
1ec51d55 |
1263 | UTS may need one or more of -DCRIPPLED_CC, -K or -g, and undef LSTAT. |
8e07c86e |
1264 | |
220f3621 |
1265 | FreeBSD can fail the lib/ipc_sysv.t test if SysV IPC has not been |
1266 | configured to the kernel. Perl tries to detect this, though, and |
1267 | you will get a message telling what to do. |
6087ac44 |
1268 | |
8e07c86e |
1269 | If you get syntax errors on '(', try -DCRIPPLED_CC. |
1270 | |
1271 | Machines with half-implemented dbm routines will need to #undef I_ODBM |
1272 | |
8e07c86e |
1273 | =back |
1274 | |
1275 | =head1 make test |
1276 | |
84902520 |
1277 | This will run the regression tests on the perl you just made (you |
1278 | should run plain 'make' before 'make test' otherwise you won't have a |
1279 | complete build). If 'make test' doesn't say "All tests successful" |
1280 | then something went wrong. See the file t/README in the t subdirectory. |
1281 | |
84902520 |
1282 | Note that you can't run the tests in background if this disables |
fb73857a |
1283 | opening of /dev/tty. You can use 'make test-notty' in that case but |
1284 | a few tty tests will be skipped. |
c3edaffb |
1285 | |
c4f23d77 |
1286 | =head2 What if make test doesn't work? |
1287 | |
1ec51d55 |
1288 | If make test bombs out, just cd to the t directory and run ./TEST |
1289 | by hand to see if it makes any difference. If individual tests |
c3edaffb |
1290 | bomb, you can run them by hand, e.g., |
8e07c86e |
1291 | |
1292 | ./perl op/groups.t |
1293 | |
aa689395 |
1294 | Another way to get more detailed information about failed tests and |
1ec51d55 |
1295 | individual subtests is to cd to the t directory and run |
aa689395 |
1296 | |
1297 | ./perl harness |
1298 | |
fb73857a |
1299 | (this assumes that most basic tests succeed, since harness uses |
aa689395 |
1300 | complicated constructs). |
1301 | |
fb73857a |
1302 | You should also read the individual tests to see if there are any helpful |
c3edaffb |
1303 | comments that apply to your system. |
1304 | |
c4f23d77 |
1305 | =over 4 |
1306 | |
1307 | =item locale |
1308 | |
1ec51d55 |
1309 | Note: One possible reason for errors is that some external programs |
c07a80fd |
1310 | may be broken due to the combination of your environment and the way |
3fe9a6f1 |
1311 | B<make test> exercises them. For example, this may happen if you have |
1ec51d55 |
1312 | one or more of these environment variables set: LC_ALL LC_CTYPE |
1313 | LC_COLLATE LANG. In some versions of UNIX, the non-English locales |
e57fd563 |
1314 | are known to cause programs to exhibit mysterious errors. |
1315 | |
1316 | If you have any of the above environment variables set, please try |
aa689395 |
1317 | |
1318 | setenv LC_ALL C |
1319 | |
1320 | (for C shell) or |
1321 | |
1322 | LC_ALL=C;export LC_ALL |
1323 | |
1ec51d55 |
1324 | for Bourne or Korn shell) from the command line and then retry |
1325 | make test. If the tests then succeed, you may have a broken program that |
aa689395 |
1326 | is confusing the testing. Please run the troublesome test by hand as |
e57fd563 |
1327 | shown above and see whether you can locate the program. Look for |
1ec51d55 |
1328 | things like: exec, `backquoted command`, system, open("|...") or |
1329 | open("...|"). All these mean that Perl is trying to run some |
e57fd563 |
1330 | external program. |
eed2e782 |
1331 | |
c4f23d77 |
1332 | =item Out of memory |
1333 | |
1334 | On some systems, particularly those with smaller amounts of RAM, some |
1335 | of the tests in t/op/pat.t may fail with an "Out of memory" message. |
1336 | Specifically, in perl5.004_64, tests 74 and 78 have been reported to |
1337 | fail on some systems. On my SparcStation IPC with 8 MB of RAM, test 78 |
1338 | will fail if the system is running any other significant tasks at the |
1339 | same time. |
1340 | |
1341 | Try stopping other jobs on the system and then running the test by itself: |
1342 | |
1343 | cd t; ./perl op/pat.t |
1344 | |
1345 | to see if you have any better luck. If your perl still fails this |
1346 | test, it does not necessarily mean you have a broken perl. This test |
1347 | tries to exercise the regular expression subsystem quite thoroughly, |
1348 | and may well be far more demanding than your normal usage. |
1349 | |
c4f23d77 |
1350 | =back |
1351 | |
8e07c86e |
1352 | =head1 make install |
1353 | |
1354 | This will put perl into the public directory you specified to |
1ec51d55 |
1355 | Configure; by default this is /usr/local/bin. It will also try |
8e07c86e |
1356 | to put the man pages in a reasonable place. It will not nroff the man |
aa689395 |
1357 | pages, however. You may need to be root to run B<make install>. If you |
8e07c86e |
1358 | are not root, you must own the directories in question and you should |
1359 | ignore any messages about chown not working. |
1360 | |
dd64f1c3 |
1361 | =head2 Installing perl under different names |
1362 | |
1363 | If you want to install perl under a name other than "perl" (for example, |
1364 | when installing perl with special features enabled, such as debugging), |
1365 | indicate the alternate name on the "make install" line, such as: |
1366 | |
1367 | make install PERLNAME=myperl |
1368 | |
1369 | =head2 Installed files |
1370 | |
8e07c86e |
1371 | If you want to see exactly what will happen without installing |
1372 | anything, you can run |
4633a7c4 |
1373 | |
8e07c86e |
1374 | ./perl installperl -n |
1375 | ./perl installman -n |
1376 | |
1ec51d55 |
1377 | make install will install the following: |
8e07c86e |
1378 | |
1379 | perl, |
1380 | perl5.nnn where nnn is the current release number. This |
1381 | will be a link to perl. |
1382 | suidperl, |
1383 | sperl5.nnn If you requested setuid emulation. |
1384 | a2p awk-to-perl translator |
1385 | cppstdin This is used by perl -P, if your cc -E can't |
1386 | read from stdin. |
1387 | c2ph, pstruct Scripts for handling C structures in header files. |
1388 | s2p sed-to-perl translator |
1389 | find2perl find-to-perl translator |
aa689395 |
1390 | h2ph Extract constants and simple macros from C headers |
8e07c86e |
1391 | h2xs Converts C .h header files to Perl extensions. |
24b3df7f |
1392 | perlbug Tool to report bugs in Perl. |
8e07c86e |
1393 | perldoc Tool to read perl's pod documentation. |
aa689395 |
1394 | pl2pm Convert Perl 4 .pl files to Perl 5 .pm modules |
8e07c86e |
1395 | pod2html, Converters from perl's pod documentation format |
aa689395 |
1396 | pod2latex, to other useful formats. |
1397 | pod2man, and |
1398 | pod2text |
1399 | splain Describe Perl warnings and errors |
8e07c86e |
1400 | |
1401 | library files in $privlib and $archlib specified to |
1402 | Configure, usually under /usr/local/lib/perl5/. |
1403 | man pages in the location specified to Configure, usually |
1404 | something like /usr/local/man/man1. |
1405 | module in the location specified to Configure, usually |
1406 | man pages under /usr/local/lib/perl5/man/man3. |
1407 | pod/*.pod in $privlib/pod/. |
1408 | |
4633a7c4 |
1409 | Installperl will also create the library directories $siteperl and |
1410 | $sitearch listed in config.sh. Usually, these are something like |
bfb7748a |
1411 | |
3a6175e1 |
1412 | /usr/local/lib/perl5/site_perl/5.005 |
bfb7748a |
1413 | /usr/local/lib/perl5/site_perl/5.005/archname |
1414 | |
1415 | where archname is something like sun4-sunos. These directories |
4633a7c4 |
1416 | will be used for installing extensions. |
1417 | |
56c6f531 |
1418 | Perl's *.h header files and the libperl.a library are also installed |
1419 | under $archlib so that any user may later build new extensions, run the |
1420 | optional Perl compiler, or embed the perl interpreter into another |
1421 | program even if the Perl source is no longer available. |
8e07c86e |
1422 | |
aa689395 |
1423 | =head1 Coexistence with earlier versions of perl5 |
4633a7c4 |
1424 | |
693762b4 |
1425 | WARNING: The upgrade from 5.004_0x to 5.005 is going to be a bit |
1426 | tricky. See L<"Upgrading from 5.004 to 5.005"> below. |
1427 | |
1428 | In general, you can usually safely upgrade from one version of Perl (e.g. |
1429 | 5.004_04) to another similar version (e.g. 5.004_05) without re-compiling |
1430 | all of your add-on extensions. You can also safely leave the old version |
1431 | around in case the new version causes you problems for some reason. |
1432 | For example, if you want to be sure that your script continues to run |
dc45a647 |
1433 | with 5.004_04, simply replace the '#!/usr/local/bin/perl' line at the |
693762b4 |
1434 | top of the script with the particular version you want to run, e.g. |
1435 | #!/usr/local/bin/perl5.00404. |
1436 | |
693762b4 |
1437 | Most extensions will probably not need to be recompiled to use |
1438 | with a newer version of perl. Here is how it is supposed to work. |
1439 | (These examples assume you accept all the Configure defaults.) |
1440 | |
bfb7748a |
1441 | The directories searched by version 5.005 will be |
1442 | |
1443 | Configure variable Default value |
1444 | $archlib /usr/local/lib/perl5/5.005/archname |
3a6175e1 |
1445 | $privlib /usr/local/lib/perl5/5.005 |
bfb7748a |
1446 | $sitearch /usr/local/lib/perl5/site_perl/5.005/archname |
3a6175e1 |
1447 | $sitelib /usr/local/lib/perl5/site_perl/5.005 |
bfb7748a |
1448 | |
1449 | while the directories searched by version 5.005_01 will be |
1450 | |
1451 | $archlib /usr/local/lib/perl5/5.00501/archname |
3a6175e1 |
1452 | $privlib /usr/local/lib/perl5/5.00501 |
bfb7748a |
1453 | $sitearch /usr/local/lib/perl5/site_perl/5.005/archname |
3a6175e1 |
1454 | $sitelib /usr/local/lib/perl5/site_perl/5.005 |
bfb7748a |
1455 | |
1456 | When you install an add-on extension, it gets installed into $sitelib (or |
1457 | $sitearch if it is architecture-specific). This directory deliberately |
1458 | does NOT include the sub-version number (01) so that both 5.005 and |
1459 | 5.005_01 can use the extension. Only when a perl version changes to |
1460 | break backwards compatibility will the default suggestions for the |
1461 | $sitearch and $sitelib version numbers be increased. |
1462 | |
1463 | However, if you do run into problems, and you want to continue to use the |
1464 | old version of perl along with your extension, move those extension files |
1465 | to the appropriate version directory, such as $privlib (or $archlib). |
1466 | (The extension's .packlist file lists the files installed with that |
1467 | extension. For the Tk extension, for example, the list of files installed |
1468 | is in $sitearch/auto/Tk/.packlist.) Then use your newer version of perl |
1469 | to rebuild and re-install the extension into $sitelib. This way, Perl |
1470 | 5.005 will find your files in the 5.005 directory, and newer versions |
1471 | of perl will find your newer extension in the $sitelib directory. |
1472 | (This is also why perl searches the site-specific libraries last.) |
1473 | |
1474 | Alternatively, if you are willing to reinstall all your extensions |
1475 | every time you upgrade perl, then you can include the subversion |
1476 | number in $sitearch and $sitelib when you run Configure. |
693762b4 |
1477 | |
1478 | =head2 Maintaining completely separate versions |
4633a7c4 |
1479 | |
1ec51d55 |
1480 | Many users prefer to keep all versions of perl in completely |
d52d4e46 |
1481 | separate directories. One convenient way to do this is by |
1482 | using a separate prefix for each version, such as |
1483 | |
46bb10fb |
1484 | sh Configure -Dprefix=/opt/perl5.004 |
d52d4e46 |
1485 | |
46bb10fb |
1486 | and adding /opt/perl5.004/bin to the shell PATH variable. Such users |
d52d4e46 |
1487 | may also wish to add a symbolic link /usr/local/bin/perl so that |
1488 | scripts can still start with #!/usr/local/bin/perl. |
1489 | |
693762b4 |
1490 | Others might share a common directory for maintenance sub-versions |
1491 | (e.g. 5.004 for all 5.004_0x versions), but change directory with |
1492 | each major version. |
1493 | |
6877a1cf |
1494 | If you are installing a development subversion, you probably ought to |
1495 | seriously consider using a separate directory, since development |
1496 | subversions may not have all the compatibility wrinkles ironed out |
1497 | yet. |
1498 | |
693762b4 |
1499 | =head2 Upgrading from 5.004 to 5.005 |
1500 | |
bfb7748a |
1501 | Extensions built and installed with versions of perl prior to 5.004_50 |
1502 | will need to be recompiled to be used with 5.004_50 and later. You will, |
1503 | however, be able to continue using 5.004 even after you install 5.005. |
1504 | The 5.004 binary will still be able to find the extensions built under |
1505 | 5.004; the 5.005 binary will look in the new $sitearch and $sitelib |
1506 | directories, and will not find them. |
693762b4 |
1507 | |
8e07c86e |
1508 | =head1 Coexistence with perl4 |
1509 | |
1510 | You can safely install perl5 even if you want to keep perl4 around. |
1511 | |
1ec51d55 |
1512 | By default, the perl5 libraries go into /usr/local/lib/perl5/, so |
1513 | they don't override the perl4 libraries in /usr/local/lib/perl/. |
8e07c86e |
1514 | |
1515 | In your /usr/local/bin directory, you should have a binary named |
1ec51d55 |
1516 | perl4.036. That will not be touched by the perl5 installation |
8e07c86e |
1517 | process. Most perl4 scripts should run just fine under perl5. |
1518 | However, if you have any scripts that require perl4, you can replace |
1ec51d55 |
1519 | the #! line at the top of them by #!/usr/local/bin/perl4.036 |
edb1cbcb |
1520 | (or whatever the appropriate pathname is). See pod/perltrap.pod |
1521 | for possible problems running perl4 scripts under perl5. |
8e07c86e |
1522 | |
aa689395 |
1523 | =head1 cd /usr/include; h2ph *.h sys/*.h |
1524 | |
1525 | Some perl scripts need to be able to obtain information from |
1526 | the system header files. This command will convert the most commonly used |
1ec51d55 |
1527 | header files in /usr/include into files that can be easily interpreted |
bfb7748a |
1528 | by perl. These files will be placed in the architecture-dependent library |
1529 | ($archlib) directory you specified to Configure. |
aa689395 |
1530 | |
1ec51d55 |
1531 | Note: Due to differences in the C and perl languages, the |
aa689395 |
1532 | conversion of the header files is not perfect. You will probably have |
1533 | to hand-edit some of the converted files to get them to parse |
1534 | correctly. For example, h2ph breaks spectacularly on type casting and |
1535 | certain structures. |
1536 | |
fb73857a |
1537 | =head1 installhtml --help |
aa689395 |
1538 | |
3e3baf6d |
1539 | Some sites may wish to make perl documentation available in HTML |
1540 | format. The installhtml utility can be used to convert pod |
fb73857a |
1541 | documentation into linked HTML files and install them. |
aa689395 |
1542 | |
fb73857a |
1543 | The following command-line is an example of one used to convert |
3e3baf6d |
1544 | perl documentation: |
aa689395 |
1545 | |
3e3baf6d |
1546 | ./installhtml \ |
1547 | --podroot=. \ |
1548 | --podpath=lib:ext:pod:vms \ |
1549 | --recurse \ |
1550 | --htmldir=/perl/nmanual \ |
1551 | --htmlroot=/perl/nmanual \ |
1552 | --splithead=pod/perlipc \ |
1553 | --splititem=pod/perlfunc \ |
1554 | --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \ |
1555 | --verbose |
1556 | |
1557 | See the documentation in installhtml for more details. It can take |
1558 | many minutes to execute a large installation and you should expect to |
1559 | see warnings like "no title", "unexpected directive" and "cannot |
1560 | resolve" as the files are processed. We are aware of these problems |
1561 | (and would welcome patches for them). |
aa689395 |
1562 | |
fb73857a |
1563 | You may find it helpful to run installhtml twice. That should reduce |
1564 | the number of "cannot resolve" warnings. |
1565 | |
aa689395 |
1566 | =head1 cd pod && make tex && (process the latex files) |
1567 | |
1568 | Some sites may also wish to make the documentation in the pod/ directory |
1569 | available in TeX format. Type |
1570 | |
1571 | (cd pod && make tex && <process the latex files>) |
1572 | |
1573 | =head1 Reporting Problems |
1574 | |
bfb7748a |
1575 | If you have difficulty building perl, and none of the advice in this file |
1576 | helps, and careful reading of the error message and the relevant manual |
1577 | pages on your system doesn't help either, then you should send a message |
1578 | to either the comp.lang.perl.misc newsgroup or to perlbug@perl.com with |
1579 | an accurate description of your problem. |
aa689395 |
1580 | |
bfb7748a |
1581 | Please include the output of the ./myconfig shell script that comes with |
1582 | the distribution. Alternatively, you can use the perlbug program that |
1583 | comes with the perl distribution, but you need to have perl compiled |
1584 | before you can use it. (If you have not installed it yet, you need to |
f5b3b617 |
1585 | run C<./perl -Ilib utils/perlbug> instead of a plain C<perlbug>.) |
aa689395 |
1586 | |
bfb7748a |
1587 | You might also find helpful information in the Porting directory of the |
1588 | perl distribution. |
aa689395 |
1589 | |
8e07c86e |
1590 | =head1 DOCUMENTATION |
1591 | |
bfb7748a |
1592 | Read the manual entries before running perl. The main documentation |
1593 | is in the pod/ subdirectory and should have been installed during the |
8e07c86e |
1594 | build process. Type B<man perl> to get started. Alternatively, you |
bfb7748a |
1595 | can type B<perldoc perl> to use the supplied perldoc script. This is |
1596 | sometimes useful for finding things in the library modules. |
8e07c86e |
1597 | |
1ec51d55 |
1598 | Under UNIX, you can produce a documentation book in postscript form, |
bfb7748a |
1599 | along with its table of contents, by going to the pod/ subdirectory and |
1600 | running (either): |
34a2a22e |
1601 | |
1602 | ./roffitall -groff # If you have GNU groff installed |
aa689395 |
1603 | ./roffitall -psroff # If you have psroff |
34a2a22e |
1604 | |
1605 | This will leave you with two postscript files ready to be printed. |
aa689395 |
1606 | (You may need to fix the roffitall command to use your local troff |
1607 | set-up.) |
34a2a22e |
1608 | |
bfb7748a |
1609 | Note that you must have performed the installation already before running |
1610 | the above, since the script collects the installed files to generate |
1611 | the documentation. |
34a2a22e |
1612 | |
8e07c86e |
1613 | =head1 AUTHOR |
1614 | |
bfb7748a |
1615 | Original author: Andy Dougherty doughera@lafayette.edu , borrowing very |
1616 | heavily from the original README by Larry Wall, with lots of helpful |
1617 | feedback and additions from the perl5-porters@perl.org folks. |
fb73857a |
1618 | |
f5b3b617 |
1619 | If you have problems, corrections, or questions, please see |
1620 | L<"Reporting Problems"> above. |
1621 | |
1622 | =head1 REDISTRIBUTION |
1623 | |
1624 | This document is part of the Perl package and may be distributed under |
1625 | the same terms as perl itself. |
1626 | |
1627 | If you are distributing a modified version of perl (perhaps as part of |
1628 | a larger package) please do modify these installation instructions and |
1629 | the contact information to match your distribution. |
8e07c86e |
1630 | |
a5f75d66 |
1631 | =head1 LAST MODIFIED |
24b3df7f |
1632 | |
56cb0a1c |
1633 | $Id: INSTALL,v 1.42 1998/07/15 18:04:44 doughera Released $ |