perl 5.003: hints/bsdos.sh
[p5sagit/p5-mst-13.2.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 are:
8
9         rm -f config.sh
10         sh Configure
11         make
12         make test
13         make install
14
15 Each of these is explained in further detail below.
16
17 You should probably at least skim through this entire document before
18 proceeding.  Special notes specific to this release are identified
19 by B<NOTE>.
20
21 =head1 BUILDING PERL5
22
23 =head1 Start with a Fresh Distribution.
24
25 If you have built perl before, you should clean out the build directory
26 with the command
27
28         make realclean
29         
30 The results of a Configure run are stored in the config.sh file.  If
31 you are upgrading from a previous version of perl, or if you change
32 systems or compilers or make other significant changes, or if you are
33 experiencing difficulties building perl, you should probably I<not>
34 re-use your old config.sh.  Simply remove it or rename it, e.g.
35
36         mv config.sh config.sh.old
37
38 Then run Configure.
39
40 =head1 Run Configure.
41
42 Configure will figure out various things about your system.  Some
43 things Configure will figure out for itself, other things it will ask
44 you about.  To accept the default, just press C<RETURN>.   The default
45 is almost always ok.
46
47 After it runs, Configure will perform variable substitution on all the
48 F<*.SH> files and offer to run B<make depend>.
49
50 Configure supports a number of useful options.  Run B<Configure -h>
51 to get a listing.  To compile with gcc, for example, you can run
52
53         sh Configure -Dcc=gcc
54
55 This is the preferred way to specify gcc (or another alternative
56 compiler) so that the hints files can set appropriate defaults.
57
58 If you want to use your old config.sh but override some of the items
59 with command line options, you need to use B<Configure -O>.
60
61 If you are willing to accept all the defaults, and you want terse
62 output, you can run
63
64         sh Configure -des
65
66 By default, for most systems, perl will be installed in
67 /usr/local/{bin, lib, man}.  You can specify a different 'prefix' for
68 the default installation directory, when Configure prompts you or by
69 using the Configure command line option -Dprefix='/some/directory',
70 e.g.
71
72         sh Configure -Dprefix=/opt/perl
73
74 If your prefix contains the string "perl", then the directories
75 are simplified.  For example, if you use prefix=/opt/perl,
76 then Configure will suggest /opt/perl/lib instead of
77 /usr/local/lib/perl5/.
78
79 By default, Configure will compile perl to use dynamic loading, if
80 your system supports it.  If you want to force perl to be compiled
81 statically, you can either choose this when Configure prompts you or by
82 using the Configure command line option -Uusedl.
83
84 =head2 Extensions
85
86 By default, Configure will offer to build every extension which appears
87 to be supported.  For example, Configure will offer to build GDBM_File
88 only if it is able to find the gdbm library.  (See examples below.)
89 DynaLoader, Fcntl and FileHandle are always built by default.
90 Configure does not contain code to test for POSIX compliance, so POSIX
91 is always built by default as well.  If you wish to skip POSIX, you can
92 set the Configure variable useposix=false either in a hint file or from
93 the Configure command line.  Similarly, the Safe extension is always
94 built by default, but you can skip it by setting the Configure variable
95 usesafe=false either in a hint file for from the command line.
96
97 In summary, here are the Configure command-line variables you can set
98 to turn off each extension:
99
100     DB_File             i_db
101     DynaLoader          (Must always be included)
102     Fcntl               (Always included by default)
103     FileHandle          (Always included by default)
104     GDBM_File           i_gdbm
105     NDBM_File           i_ndbm
106     ODBM_File           i_dbm
107     POSIX               useposix
108     SDBM_File           (Always included by default)
109     Safe                usesafe
110     Socket              d_socket
111
112 Thus to skip the NDBM_File extension, you can use
113
114         sh Configure -Ui_ndbm
115
116 Again, this is taken care of automatically if you don't have the ndbm
117 library.
118
119 Of course, you may always run Configure interactively and select only
120 the Extensions you want.
121
122 Finally, if you have dynamic loading (most modern Unix systems do)
123 remember that these extensions do not increase the size of your perl
124 executable, nor do they impact start-up time, so you probably might as
125 well build all the ones that will work on your system.
126
127 =head2 GNU-style configure
128
129 If you prefer the GNU-style B<configure> command line interface, you can
130 use the supplied B<configure> command, e.g.
131
132         CC=gcc ./configure
133
134 The B<configure> script emulates several of the more common configure
135 options.  Try
136
137         ./configure --help
138
139 for a listing.
140
141 Cross compiling is currently not supported.
142
143 =head2 Including locally-installed libraries
144
145 Perl5 comes with interfaces to number of database extensions, including
146 dbm, ndbm, gdbm, and Berkeley db.  For each extension, if
147 Configure can find the appropriate header files and libraries, it will
148 automatically include that extension.  The gdbm and db libraries
149 are B<not> included with perl.  See the library documentation for
150 how to obtain the libraries.
151
152 I<Note:>  If your database header (.h) files are not in a
153 directory normally searched by your C compiler, then you will need to
154 include the appropriate B<-I/your/directory> option when prompted by
155 Configure.  If your database library (.a) files are not in a directory
156 normally searched by your C compiler and linker, then you will need to
157 include the appropriate B<-L/your/directory> option when prompted by
158 Configure.  See the examples below.
159
160 =head2 Examples
161
162 =over 4
163
164 =item gdbm in /usr/local.
165
166 Suppose you have gdbm and want Configure to find it and build the
167 GDBM_File extension.  This examples assumes you have F<gdbm.h>
168 installed in F</usr/local/include/gdbm.h> and F<libgdbm.a> installed in
169 F</usr/local/lib/libgdbm.a>.  Configure should figure all the
170 necessary steps out automatically.
171
172 Specifically, when Configure prompts you for flags for
173 your C compiler, you should include  C<-I/usr/local/include>.
174
175 When Configure prompts you for linker flags, you should include
176 C<-L/usr/local/lib>.
177
178 If you are using dynamic loading, then when Configure prompts you for
179 linker flags for dynamic loading, you should again include
180 C<-L/usr/local/lib>.
181
182 Again, this should all happen automatically.  If you want to accept the
183 defaults for all the questions and have Configure print out only terse
184 messages, then you can just run
185
186         sh Configure -des
187
188 and Configure should include the GDBM_File extension automatically.
189
190 This should actually work if you have gdbm installed in any of
191 (/usr/local, /opt/local, /usr/gnu, /opt/gnu, /usr/GNU, or /opt/GNU).
192
193 =item gdbm in /usr/you
194
195 Suppose you have gdbm installed in some place other than /usr/local/,
196 but you still want Configure to find it.  To be specific, assume  you
197 have F</usr/you/include/gdbm.h> and F</usr/you/lib/libgdbm.a>.  You
198 still have to add B<-I/usr/you/include> to cc flags, but you have to take
199 an extra step to help Configure find F<libgdbm.a>.  Specifically, when
200 Configure prompts you for library directories, you have to add
201 F</usr/you/lib> to the list.
202
203 It is possible to specify this from the command line too (all on one
204 line):
205
206         sh Configure -des \
207                 -Dlocincpth="/usr/you/include" \
208                 -Dloclibpth="/usr/you/lib"
209
210 C<locincpth> is a space-separated list of include directories to search.
211 Configure will automatically add the appropriate B<-I> directives.
212
213 C<loclibpth> is a space-separated list of library directories to search.
214 Configure will automatically add the appropriate B<-L> directives.  If
215 you have some libraries under F</usr/local/> and others under
216 F</usr/you>, then you have to include both, namely
217
218         sh Configure -des \
219                 -Dlocincpth="/usr/you/include /usr/local/include" \
220                 -Dloclibpth="/usr/you/lib /usr/local/lib"
221
222 =back
223
224 =head2 Installation Directories.
225
226 The installation directories can all be changed by answering the
227 appropriate questions in Configure.  For convenience, all the
228 installation questions are near the beginning of Configure.
229
230 By default, Configure uses the following directories for
231 library files  (archname is a string like sun4-sunos, determined
232 by Configure)
233
234         /usr/local/lib/perl5/archname/5.002
235         /usr/local/lib/perl5/
236         /usr/local/lib/perl5/site_perl/archname
237         /usr/local/lib/perl5/site_perl
238
239 and the following directories for manual pages:
240
241         /usr/local/man/man1
242         /usr/local/lib/perl5/man/man3
243
244 (Actually, Configure recognizes the SVR3-style
245 /usr/local/man/l_man/man1 directories, if present, and uses those
246 instead.) The module man pages are stuck in that strange spot so that
247 they don't collide with other man pages stored in /usr/local/man/man3,
248 and so that Perl's man pages don't hide system man pages.  On some
249 systems, B<man less> would end up calling up Perl's less.pm module man
250 page, rather than the B<less> program.
251
252 If you specify a prefix that contains the string "perl", then the
253 directory structure is simplified.  For example, if you Configure
254 with -Dprefix=/opt/perl, then the defaults are
255
256         /opt/perl/lib/archname/5.002
257         /opt/perl/lib
258         /opt/perl/lib/site_perl/archname
259         /opt/perl/lib/site_perl
260
261         /opt/perl/man/man1
262         /opt/perl/man/man3
263
264 The perl executable will search the libraries in the order given
265 above.
266
267 The  directories site_perl and site_perl/archname are empty, but are
268 intended to be used for installing local or site-wide extensions.  Perl
269 will automatically look in these directories.  Previously, most sites
270 just put their local extensions in with the standard distribution.
271
272 In order to support using things like #!/usr/local/bin/perl5.002 after
273 a later version is released, architecture-dependent libraries are
274 stored in a version-specific directory, such as
275 /usr/local/lib/perl5/archname/5.002/.  In 5.000 and 5.001, these files
276 were just stored in /usr/local/lib/perl5/archname/.  If you will not be
277 using 5.001 binaries, you can delete the standard extensions from the
278 /usr/local/lib/perl5/archname/ directory.  Locally-added extensions can
279 be moved to the site_perl and site_perl/archname directories.
280
281 Again, these are just the defaults, and can be changed as you run
282 Configure.
283
284 =head2 Changing the installation directory
285
286 Configure distinguishes between the directory in which perl (and its
287 associated files) should be installed and the directory in which it
288 will eventually reside.  For most sites, these two are the same; for
289 sites that use AFS, this distinction is handled automatically.
290 However, sites that use software such as B<depot> to manage software
291 packages may also wish to install perl into a different directory and
292 use that management software to move perl to its final destination.
293 This section describes how to do this.  Someday, Configure may support
294 an option C<-Dinstallprefix=/foo> to simplify this.
295
296 Suppose you want to install perl under the F</tmp/perl5> directory.
297 You can edit F<config.sh> and change all the install* variables to
298 point to F</tmp/perl5> instead of F</usr/local/wherever>.  You could
299 also set them all from the Configure command line.  Or, you can
300 automate this process by placing the following lines in a file
301 F<config.over> B<before> you run Configure (replace /tmp/perl5 by a
302 directory of your choice):
303
304     installprefix=/tmp/perl5
305     test -d $installprefix || mkdir $installprefix
306     test -d $installprefix/bin || mkdir $installprefix/bin
307     installarchlib=`echo $installarchlib | sed "s!$prefix!$installprefix!"`
308     installbin=`echo $installbin | sed "s!$prefix!$installprefix!"`
309     installman1dir=`echo $installman1dir | sed "s!$prefix!$installprefix!"`
310     installman3dir=`echo $installman3dir | sed "s!$prefix!$installprefix!"`
311     installprivlib=`echo $installprivlib | sed "s!$prefix!$installprefix!"`
312     installscript=`echo $installscript | sed "s!$prefix!$installprefix!"`
313     installsitelib=`echo $installsitelib | sed "s!$prefix!$installprefix!"`
314     installsitearch=`echo $installsitearch | sed "s!$prefix!$installprefix!"`
315     shrpdir=`echo $shrpdir | sed "s!$prefix!$installprefix!"`
316
317 Then, you can Configure and install in the usual way:
318
319     sh Configure -des
320     make
321     make test
322     make install
323
324 =head2 Creating an installable tar archive
325
326 If you need to install perl on many identical systems, it is
327 convenient to compile it once and create an archive that can be
328 installed on multiple systems.  Here's one way to do that:
329
330     # Set up config.over to install perl into a different directory,
331     # e.g. /tmp/perl5 (see previous part).
332     sh Configure -des
333     make
334     make test
335     make install
336     cd /tmp/perl5
337     tar cvf ../perl5-archive.tar .
338     # Then, on each machine where you want to install perl,
339     cd /usr/local  # Or wherever you specified as $prefix
340     tar xvf perl5-archive.tar
341
342 =head2 What if it doesn't work?
343
344 =over 4
345
346 =item Running Configure Interactively
347
348 If Configure runs into trouble, remember that you can always run
349 Configure interactively so that you can check (and correct) its
350 guesses.
351
352 All the installation questions have been moved to the top, so you don't
353 have to wait for them.  Once you've handled them (and your C compiler &
354 flags) you can type   '&-d'  at the next Configure prompt and Configure
355 will use the defaults from then on.
356
357 If you find yourself trying obscure command line incantations and
358 config.over tricks, I recommend you run Configure interactively
359 instead.  You'll probably save yourself time in the long run.
360
361 =item Hint files.
362
363 The perl distribution includes a number of system-specific hints files
364 in the hints/ directory.  If one of them matches your system, Configure
365 will offer to use that hint file.
366
367 Several of the hint files contain additional important information.
368 If you have any problems, it is a good idea to read the relevant hint
369 file for further information.  See F<hints/solaris_2.sh> for an
370 extensive example.
371
372 =item *** WHOA THERE!!! ***
373
374 Occasionally, Configure makes a wrong guess.  For example, on SunOS
375 4.1.3, Configure incorrectly concludes that tzname[] is in the
376 standard C library.  The hint file is set up to correct for this.  You
377 will see a message:
378
379     *** WHOA THERE!!! ***
380         The recommended value for $d_tzname on this machine was "undef"!
381         Keep the recommended value? [y]
382
383 You should always keep the recommended value unless, after reading the
384 relevant section of the hint file, you are sure you want to try
385 overriding it.
386
387 If you are re-using an old config.sh, the word "previous" will be
388 used instead of "recommended".  Again, you will almost always want
389 to keep the previous value, unless you have changed something on your
390 system.
391
392 For example, suppose you have added libgdbm.a to your system
393 and you decide to reconfigure perl to use GDBM_File.  When you run
394 Configure again, you will need to add -lgdbm to the list of libraries.
395 Now, Configure will find your gdbm library and will issue a message:
396
397     *** WHOA THERE!!! ***
398         The previous value for $i_gdbm on this machine was "undef"!
399         Keep the previous value? [y]
400
401 In this case, you do I<not> want to keep the previous value, so you
402 should answer 'n'.  (You'll also have to manuually add GDBM_File to
403 the list of dynamic extensions to build.)
404
405 =item Changing Compilers
406
407 If you change compilers or make other significant changes, you should
408 probably I<not> re-use your old config.sh.  Simply remove it or
409 rename it, e.g. mv config.sh config.sh.old.  Then rerun Configure
410 with the options you want to use.
411
412 This is a common source of problems.  If you change from B<cc> to
413 B<gcc>, you should almost always remove your old config.sh.
414
415 =item Propagating your changes
416
417 If you later make any changes to F<config.sh>, you should propagate
418 them to all the .SH files by running  B<sh Configure -S>.
419
420 =item config.over
421
422 You can also supply a shell script config.over to over-ride Configure's
423 guesses.  It will get loaded up at the very end, just before config.sh
424 is created.  You have to be careful with this, however, as Configure
425 does no checking that your changes make sense.  See the section on
426 changing the installation directory for an example.
427
428 =item config.h
429
430 Many of the system dependencies are contained in F<config.h>.
431 F<Configure> builds F<config.h> by running the F<config_h.SH> script.
432 The values for the variables are taken from F<config.sh>.
433
434 If there are any problems, you can edit F<config.h> directly.  Beware,
435 though, that the next time you run B<Configure>, your changes will be
436 lost.
437
438 =item cflags
439
440 If you have any additional changes to make to the C compiler command
441 line, they can be made in F<cflags.SH>.  For instance, to turn off the
442 optimizer on F<toke.c>, find the line in the switch structure for
443 F<toke.c> and put the command C<optimize='-g'> before the C<;;>.  You
444 can also edit F<cflags> directly, but beware that your changes will be
445 lost the next time you run B<Configure>.
446
447 To change the C flags for all the files, edit F<config.sh>
448 and change either C<$ccflags> or C<$optimize>,
449 and then re-run  B<sh Configure -S ; make depend>.
450
451 =item No sh.
452
453 If you don't have sh, you'll have to copy the sample file config_H to
454 config.h and edit the config.h to reflect your system's peculiarities.
455 You'll probably also have to extensively modify the extension building
456 mechanism.
457
458 =back
459
460 =head1 make depend
461
462 This will look for all the includes.
463 The output is stored in F<makefile>.  The only difference between
464 F<Makefile> and F<makefile> is the dependencies at the bottom of
465 F<makefile>.  If you have to make any changes, you should edit
466 F<makefile>, not F<Makefile> since the Unix B<make> command reads
467 F<makefile> first.
468
469 Configure will offer to do this step for you, so it isn't listed
470 explicitly above.
471
472 =head1 make
473
474 This will attempt to make perl in the current directory.
475
476 If you can't compile successfully, try some of the following ideas.
477
478 =over 4
479
480 =item *
481
482 If you used a hint file, try reading the comments in the hint file
483 for further tips and information.
484
485 =item *
486
487 If you can't compile successfully, try adding a C<-DCRIPPLED_CC> flag.
488 (Just because you get no errors doesn't mean it compiled right!)
489 This simplifies some complicated expressions for compilers that
490 get indigestion easily.  If that has no effect, try turning off
491 optimization.  If you have missing routines, you probably need to
492 add some library or other, or you need to undefine some feature that
493 Configure thought was there but is defective or incomplete.
494
495 =item *
496
497 Some compilers will not compile or optimize the larger files without
498 some extra switches to use larger jump offsets or allocate larger
499 internal tables.  You can customize the switches for each file in
500 F<cflags>.  It's okay to insert rules for specific files into
501 F<makefile> since a default rule only takes effect in the absence of a
502 specific rule.
503
504 =item *
505
506 If you can successfully build F<miniperl>, but the process crashes
507 during the building of extensions, you should run
508
509         make minitest
510
511 to test your version of miniperl.
512
513 =item *
514
515 Some additional things that have been reported for either perl4 or perl5:
516
517 Genix may need to use libc rather than libc_s, or #undef VARARGS.
518
519 NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
520
521 UTS may need one or more of B<-DCRIPPLED_CC>, B<-K> or B<-g>, and undef LSTAT.
522
523 If you get syntax errors on '(', try -DCRIPPLED_CC.
524
525 Machines with half-implemented dbm routines will need to #undef I_ODBM
526
527 SCO prior to 3.2.4 may be missing dbmclose().  An upgrade to 3.2.4
528 that includes libdbm.nfs (which includes dbmclose()) may be available.
529
530 If you get duplicates upon linking for malloc et al, say -DHIDEMYMALLOC.
531
532 If you get duplicate function definitions (a perl function has the
533 same name as another function on your system) try -DEMBED.
534
535 If you get varags problems with gcc, be sure that gcc is installed
536 correctly.  When using gcc, you should probably have i_stdarg='define'
537 and i_varags='undef' in config.sh.  The problem is usually solved
538 by running fixincludes correctly.
539
540 If you have problems with dynamic loading using gcc on SunOS or
541 Solaris, and you are using GNU as and GNU ld, you may need to add
542 B<-B/bin/> (for SunOS) or B<-B/usr/ccs/bin> (for Solaris) to your
543 $ccflags, $ldflags, and $lddlflags so that the system's versions of as
544 and ld are used.
545
546 If you run into dynamic loading problems, check your setting of
547 the LD_LIBRARY_PATH environment variable.  Perl should build
548 fine with LD_LIBRARY_PATH unset, though that may depend on details
549 of your local set-up.
550
551 If Configure seems to be having trouble finding library functions,
552 try not using nm extraction.  You can do this from the command line
553 with
554
555         sh Configure -Uusenm
556
557 =back
558
559 =head1 make test
560
561 This will run the regression tests on the perl you just made.  If it
562 doesn't say "All tests successful" then something went wrong.  See the
563 file F<t/README> in the F<t> subdirectory.  Note that you can't run it
564 in background if this disables opening of /dev/tty.  If B<make test>
565 bombs out, just B<cd> to the F<t> directory and run B<TEST> by hand
566 to see if it makes any difference.
567 If individual tests bomb, you can run them by hand, e.g.,
568
569         ./perl op/groups.t
570
571 B<Note>: one possible reason for errors is that some external programs
572 may be broken due to the combination of your environment and the way
573 C<make test> exercises them. This may happen for example if you have
574 one or more of these environment variables set:
575 C<LC_ALL LC_CTYPE LANG>. In certain UNIXes especially the non-English
576 locales are known to cause programs to exhibit mysterious errors.
577 If you have any of the above environment variables set, please try
578 C<setenv LC_ALL C> or <LC_ALL=C;export LC_ALL>, for C<csh>-style and
579 C<Bourne>-style shells, respectively, from the command line and then
580 retry C<make test>. If the tests then succeed, you may have a broken
581 program that is confusing the testing. Please run the troublesome test
582 by hand as shown above and see whether you can locate the program.
583 Look for things like:
584 C<exec, `backquoted command`, system, open("|...")> or C<open("...|")>.
585 All these mean that Perl is trying to run some external program.
586 =head1 INSTALLING PERL5
587
588 =head1 make install
589
590 This will put perl into the public directory you specified to
591 B<Configure>; by default this is F</usr/local/bin>.  It will also try
592 to put the man pages in a reasonable place.  It will not nroff the man
593 page, however.  You may need to be root to run B<make install>.  If you
594 are not root, you must own the directories in question and you should
595 ignore any messages about chown not working.
596
597 B<NOTE:>  In the 5.002 release, you will see some harmless error
598 messages and warnings from pod2man.  You may safely ignore them.  (Yes,
599 they should be fixed, but they didn't seem important enough to warrant
600 holding up the entire 5.002 release.)
601
602 If you want to see exactly what will happen without installing
603 anything, you can run
604
605         ./perl installperl -n
606         ./perl installman -n
607
608 B<make install> will install the following:
609
610         perl,
611             perl5.nnn   where nnn is the current release number.  This
612                         will be a link to perl.
613         suidperl,
614             sperl5.nnn  If you requested setuid emulation.
615         a2p             awk-to-perl translator
616         cppstdin        This is used by perl -P, if your cc -E can't
617                         read from stdin.
618         c2ph, pstruct   Scripts for handling C structures in header files.
619         s2p             sed-to-perl translator
620         find2perl       find-to-perl translator
621         h2xs            Converts C .h header files to Perl extensions.
622         perlbug         Tool to report bugs in Perl.
623         perldoc         Tool to read perl's pod documentation.
624         pod2html,       Converters from perl's pod documentation format
625         pod2latex, and  to other useful formats.
626         pod2man
627
628         library files   in $privlib and $archlib specified to
629                         Configure, usually under /usr/local/lib/perl5/.
630         man pages       in the location specified to Configure, usually
631                         something like /usr/local/man/man1.
632         module          in the location specified to Configure, usually
633         man pages       under /usr/local/lib/perl5/man/man3.
634         pod/*.pod       in $privlib/pod/.
635
636 Installperl will also create the library directories $siteperl and
637 $sitearch listed in config.sh.  Usually, these are something like
638         /usr/local/lib/perl5/site_perl/
639         /usr/local/lib/perl5/site_perl/$archname
640 where $archname is something like sun4-sunos.  These directories
641 will be used for installing extensions.
642
643 Perl's *.h header files and the libperl.a library are also
644 installed under $archlib so that any user may later build new
645 extensions even if the Perl source is no longer available.
646
647 The libperl.a library is only needed for building new
648 extensions and linking them statically into a new perl executable.
649 If you will not be doing that, then you may safely delete
650 $archlib/libperl.a after perl is installed.
651
652 make install may also offer to install perl in a "standard" location.
653
654 Most of the documentation in the pod/ directory is also available
655 in HTML and LaTeX format.  Type
656
657         cd pod; make html; cd ..
658
659 to generate the html versions, and
660
661         cd pod; make tex; cd ..
662
663 to generate the LaTeX versions.
664
665 =head1 Coexistence with earlier versions of perl5.
666
667 You can safely install the current version of perl5 and still run
668 scripts under the old binaries.  Instead of starting your script with
669 #!/usr/local/bin/perl, just start it with #!/usr/local/bin/perl5.001
670 (or whatever version you want to run.)
671
672 The architecture-dependent files are stored in a version-specific
673 directory (such as F</usr/local/lib/perl5/sun4-sunos/5.002>) so that
674 they are still accessible.  I<Note:> perl5.000 and perl5.001 did not
675 put their architecture-dependent libraries in a version-specific
676 directory.  They are simply in F</usr/local/lib/perl5/$archname>.  If
677 you will not be using 5.000 or 5.001, you may safely remove those
678 files.
679
680 The standard library files in F</usr/local/lib/perl5>
681 should be useable by all versions of perl5.
682
683 Most extensions will probably not need to be recompiled to use with a newer
684 version of perl.  If you do run into problems, and you want to continue
685 to use the old version of perl along with your extension, simply move
686 those extension files to the appropriate version directory, such as
687 F</usr/local/lib/perl/archname/5.002>.  Then perl5.002 will find your
688 files in the 5.002 directory, and newer versions of perl will find your
689 newer extension in the site_perl directory.
690
691 Some users may prefer to keep all versions of perl in completely
692 separate directories.  One convenient way to do this is by
693 using a separate prefix for each version, such as
694
695         sh Configure -Dprefix=/opt/perl5.002
696
697 and adding /opt/perl5.002/bin to the shell PATH variable.  Such users
698 may also wish to add a symbolic link /usr/local/bin/perl so that
699 scripts can still start with #!/usr/local/bin/perl.
700
701 B<NOTE>: Starting with 5.002_01, all functions in the perl C source
702 code are protected by default by the prefix Perl_ (or perl_) so that
703 you may link with third-party libraries without fear of namespace
704 collisons.  This breaks compatability with the initially released
705 version of 5.002, so once you install 5.002_01 (or higher) you will
706 need to re-build and install all of your dynamically loadable
707 extensions.  (The standard extensions supplied with Perl are handled
708 automatically).  You can turn off this namespace protection by adding
709 -DNO_EMBED to your ccflags variable in config.sh.  This is a one-time
710 change.  In the future, we certainly hope that most extensions won't
711 need to be recompiled for use with a newer version of perl.
712
713 =head1 Coexistence with perl4
714
715 You can safely install perl5 even if you want to keep perl4 around.
716
717 By default, the perl5 libraries go into F</usr/local/lib/perl5/>, so
718 they don't override the perl4 libraries in F</usr/local/lib/perl/>.
719
720 In your /usr/local/bin directory, you should have a binary named
721 F<perl4.036>.  That will not be touched by the perl5 installation
722 process.  Most perl4 scripts should run just fine under perl5.
723 However, if you have any scripts that require perl4, you can replace
724 the C<#!> line at the top of them by C<#!/usr/local/bin/perl4.036>
725 (or whatever the appropriate pathname is).  See pod/perltrap.pod
726 for possible problems running perl4 scripts under perl5.
727
728 =head1 DOCUMENTATION
729
730 Read the manual entries before running perl.  The main documentation is
731 in the pod/ subdirectory and should have been installed during the
732 build process.  Type B<man perl> to get started.  Alternatively, you
733 can type B<perldoc perl> to use the supplied B<perldoc> script.  This
734 is sometimes useful for finding things in the library modules.
735
736 =head1 AUTHOR
737
738 Andy Dougherty <doughera@lafcol.lafayette.edu>, borrowing I<very> heavily
739 from the original README by Larry Wall.
740
741 =head1 LAST MODIFIED
742
743 19 March 1996