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