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