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