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