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