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