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