op.c: Confusing comment typo
[perl.git] / INSTALL
1 If you read this file _as_is_, just ignore the funny characters you see.
2 It is written in the POD format (see pod/perlpod.pod) which is specially
3 designed to be readable as is.
4
5 =head1 NAME
6
7 INSTALL - Build and Installation guide for perl 5.
8
9 =head1 SYNOPSIS
10
11 First, make sure you have an up-to-date version of Perl.  If you
12 didn't get your Perl source from CPAN, check the latest version at
13 http://www.cpan.org/src/.  Perl uses a version scheme where even-numbered
14 subreleases (like 5.8.x and 5.10.x) are stable maintenance releases and
15 odd-numbered subreleases (like 5.7.x and 5.9.x) are unstable
16 development releases.  Development releases should not be used in
17 production environments.  Fixes and new features are first carefully
18 tested in development releases and only if they prove themselves to be
19 worthy will they be migrated to the maintenance releases.
20
21 The basic steps to build and install perl 5 on a Unix system with all
22 the defaults are to run, from a freshly unpacked source tree:
23
24         sh Configure -de
25         make
26         make test
27         make install
28
29 Each of these is explained in further detail below.
30
31 The above commands will install Perl to /usr/local (or some other
32 platform-specific directory -- see the appropriate file in hints/.)
33 If that's not okay with you, you can run Configure interactively, by
34 just typing "sh Configure" (without the -de args). You can also specify
35 any prefix location by adding "-Dprefix='/some/dir'" to Configure's args.
36 To explicitly name the perl binary, use the command
37 "make install PERLNAME=myperl".
38
39 Building perl from source requires an ANSI compliant C compiler.
40 A minimum of C89 is required. Some features available in C99 will
41 be probed for and used when found. The perl build process does not
42 rely on anything more than C89.
43
44 These options, and many more, are explained in further detail below.
45
46 If you're building perl from a git repository, you should also consult
47 the documentation in pod/perlgit.pod for information on that special
48 circumstance.
49
50 If you have problems, corrections, or questions, please see
51 L<"Reporting Problems"> below.
52
53 For information on what's new in this release, see the
54 pod/perldelta.pod file.  For more information about how to find more
55 specific detail about changes, see the Changes file.
56
57 =head1 DESCRIPTION
58
59 This document is written in pod format as an easy way to indicate its
60 structure.  The pod format is described in pod/perlpod.pod, but you can
61 read it as is with any pager or editor.  Headings and items are marked
62 by lines beginning with '='.  The other mark-up used is
63
64     B<text>     embolden text, used for switches, programs or commands
65     C<code>     literal code
66     L<name>     A link (cross reference) to name
67     F<file>     A filename
68
69 Although most of the defaults are probably fine for most users,
70 you should probably at least skim through this document before
71 proceeding.
72
73 In addition to this file, check if there is a README file specific to
74 your operating system, since it may provide additional or different
75 instructions for building Perl.  If there is a hint file for your
76 system (in the hints/ directory) you might also want to read it
77 for even more information.
78
79 For additional information about porting Perl, see the section on
80 L<"Porting information"> below, and look at the files in the Porting/
81 directory.
82
83 =head1 PRELIMINARIES
84
85 =head2 Changes and Incompatibilities
86
87 Please see pod/perldelta.pod for a description of the changes and
88 potential incompatibilities introduced with this release.  A few of
89 the most important issues are listed below, but you should refer
90 to pod/perldelta.pod for more detailed information.
91
92 B<WARNING:> This version is not binary compatible with earlier versions
93 of Perl.  If you have built extensions (i.e. modules that include C code)
94 using an earlier version of Perl, you will need to rebuild and reinstall
95 those extensions.
96
97 Pure perl modules without XS or C code should continue to work fine
98 without reinstallation.  See the discussion below on
99 L<"Coexistence with earlier versions of perl 5"> for more details.
100
101 The standard extensions supplied with Perl will be handled automatically.
102
103 On a related issue, old modules may possibly be affected by the changes
104 in the Perl language in the current release.  Please see
105 pod/perldelta.pod for a description of what's changed.  See your
106 installed copy of the perllocal.pod file for a (possibly incomplete)
107 list of locally installed modules.  Also see the L<CPAN> module's
108 C<autobundle> function for one way to make a "bundle" of your currently
109 installed modules.
110
111 =head1 Run Configure
112
113 Configure will figure out various things about your system.  Some
114 things Configure will figure out for itself, other things it will ask
115 you about.  To accept the default, just press RETURN.   The default is
116 almost always okay.  It is normal for some things to be "NOT found",
117 since Configure often searches for many different ways of performing
118 the same function.
119
120 At any Configure prompt, you can type  &-d  and Configure will use the
121 defaults from then on.
122
123 After it runs, Configure will perform variable substitution on all the
124 *.SH files and offer to run make depend.
125
126 The results of a Configure run are stored in the config.sh and Policy.sh
127 files.
128
129 =head2 Common Configure options
130
131 Configure supports a number of useful options.  Run
132
133         Configure -h
134
135 to get a listing.  See the Porting/Glossary file for a complete list of
136 Configure variables you can set and their definitions.
137
138 =over 4
139
140 =item C compiler
141
142 To compile with gcc, if it's not the default compiler on your
143 system, you should run
144
145         sh Configure -Dcc=gcc
146
147 This is the preferred way to specify gcc (or any another alternative
148 compiler) so that the hints files can set appropriate defaults.
149
150 =item Installation prefix
151
152 By default, for most systems, perl will be installed in
153 /usr/local/{bin, lib, man}.  (See L<"Installation Directories">
154 and L<"Coexistence with earlier versions of perl 5"> below for
155 further details.)
156
157 You can specify a different 'prefix' for the default installation
158 directory when Configure prompts you, or by using the Configure command
159 line option -Dprefix='/some/directory', e.g.
160
161         sh Configure -Dprefix=/opt/perl
162
163 If your prefix contains the string "perl", then the suggested
164 directory structure is simplified.  For example, if you use
165 prefix=/opt/perl, then Configure will suggest /opt/perl/lib instead of
166 /opt/perl/lib/perl5/.  Again, see L<"Installation Directories"> below
167 for more details.  Do not include a trailing slash, (i.e. /opt/perl/)
168 or you may experience odd test failures.
169
170 NOTE:  You must not specify an installation directory that is the same
171 as or below your perl source directory.  If you do, installperl will
172 attempt infinite recursion.
173
174 =item /usr/bin/perl
175
176 It may seem obvious, but Perl is useful only when users can easily
177 find it.  It's often a good idea to have both /usr/bin/perl and
178 /usr/local/bin/perl be symlinks to the actual binary.  Be especially
179 careful, however, not to overwrite a version of perl supplied by your
180 vendor unless you are sure you know what you are doing.  If you insist
181 on replacing your vendor's perl, useful information on how it was
182 configured may be found with
183
184         perl -V:config_args
185
186 (Check the output carefully, however, since this doesn't preserve
187 spaces in arguments to Configure.  For that, you have to look carefully
188 at config_arg1, config_arg2, etc.)
189
190 By default, Configure will not try to link /usr/bin/perl to the current
191 version of perl.  You can turn on that behavior by running
192
193         Configure -Dinstallusrbinperl
194
195 or by answering 'yes' to the appropriate Configure prompt.
196
197 In any case, system administrators are strongly encouraged to put
198 (symlinks to) perl and its accompanying utilities, such as perldoc,
199 into a directory typically found along a user's PATH, or in another
200 obvious and convenient place.
201
202 =item Building a development release
203
204 For development releases (odd subreleases, like 5.9.x) if you want to
205 use Configure -d, you will also need to supply -Dusedevel to Configure,
206 because the default answer to the question "do you really want to
207 Configure a development version?" is "no".  The -Dusedevel skips that
208 sanity check.
209
210 =back
211
212 If you are willing to accept all the defaults, and you want terse
213 output, you can run
214
215         sh Configure -des
216
217 =head2 Altering Configure variables for C compiler switches etc.
218
219 For most users, most of the Configure defaults are fine, or can easily
220 be set on the Configure command line.  However, if Configure doesn't
221 have an option to do what you want, you can change Configure variables
222 after the platform hints have been run by using Configure's -A switch.
223 For example, here's how to add a couple of extra flags to C compiler
224 invocations:
225
226         sh Configure -Accflags="-DPERL_EXTERNAL_GLOB -DNO_HASH_SEED"
227
228 To clarify, those ccflags values are not Configure options; if passed to
229 Configure directly, they won't do anything useful (they will define a
230 variable in config.sh, but without taking any action based upon it).
231 But when passed to the compiler, those flags will activate #ifdefd code.
232
233 For more help on Configure switches, run
234
235         sh Configure -h
236
237 =head2 Major Configure-time Build Options
238
239 There are several different ways to Configure and build perl for your
240 system.  For most users, the defaults are sensible and will work.
241 Some users, however, may wish to further customize perl.  Here are
242 some of the main things you can change.
243
244 =head3 Threads
245
246 On some platforms, perl can be compiled with support for threads.  To
247 enable this, run
248
249         sh Configure -Dusethreads
250
251 The default is to compile without thread support.
252
253 Perl used to have two different internal threads implementations.  The
254 current model (available internally since 5.6, and as a user-level module
255 since 5.8) is called interpreter-based implementation (ithreads), with
256 one interpreter per thread, and explicit sharing of data. The (deprecated)
257 5.005 version (5005threads) was removed for release 5.10.
258
259 The 'threads' module is for use with the ithreads implementation.  The
260 'Thread' module emulates the old 5005threads interface on top of the
261 current ithreads model.
262
263 When using threads, perl uses a dynamically-sized buffer for some of
264 the thread-safe library calls, such as those in the getpw*() family.
265 This buffer starts small, but it will keep growing until the result
266 fits.  To get a fixed upper limit, you should compile Perl with
267 PERL_REENTRANT_MAXSIZE defined to be the number of bytes you want.  One
268 way to do this is to run Configure with
269 C<-Accflags=-DPERL_REENTRANT_MAXSIZE=65536>.
270
271 =head3 Large file support
272
273 Since Perl 5.6.0, Perl has supported large files (files larger than
274 2 gigabytes), and in many common platforms like Linux or Solaris this
275 support is on by default.
276
277 This is both good and bad. It is good in that you can use large files,
278 seek(), stat(), and -s them.  It is bad in that if you are interfacing
279 Perl using some extension, the components you are connecting to must also
280 be large file aware: if Perl thinks files can be large but the other
281 parts of the software puzzle do not understand the concept, bad things
282 will happen.
283
284 There's also one known limitation with the current large files
285 implementation: unless you also have 64-bit integers (see the next
286 section), you cannot use the printf/sprintf non-decimal integer formats
287 like C<%x> to print filesizes.  You can use C<%d>, though.
288
289 If you want to compile perl without large file support, use
290
291     sh Configure -Uuselargefiles
292
293 =head3 64 bit support
294
295 If your platform does not run natively at 64 bits, but can simulate
296 them with compiler flags and/or C<long long> or C<int64_t>,
297 you can build a perl that uses 64 bits.
298
299 There are actually two modes of 64-bitness: the first one is achieved
300 using Configure -Duse64bitint and the second one using Configure
301 -Duse64bitall.  The difference is that the first one is minimal and
302 the second one maximal.  The first works in more places than the second.
303
304 The C<use64bitint> option does only as much as is required to get
305 64-bit integers into Perl (this may mean, for example, using "long
306 longs") while your memory may still be limited to 2 gigabytes (because
307 your pointers could still be 32-bit).  Note that the name C<64bitint>
308 does not imply that your C compiler will be using 64-bit C<int>s (it
309 might, but it doesn't have to).  The C<use64bitint> simply means that
310 you will be able to have 64 bit-wide scalar values.
311
312 The C<use64bitall> option goes all the way by attempting to switch
313 integers (if it can), longs (and pointers) to being 64-bit.  This may
314 create an even more binary incompatible Perl than -Duse64bitint: the
315 resulting executable may not run at all in a 32-bit box, or you may
316 have to reboot/reconfigure/rebuild your operating system to be 64-bit
317 aware.
318
319 Natively 64-bit systems need neither -Duse64bitint nor -Duse64bitall.
320 On these systems, it might be the default compilation mode, and there
321 is currently no guarantee that passing no use64bitall option to the
322 Configure process will build a 32bit perl. Implementing -Duse32bit*
323 options is planned for a future release of perl.
324
325 =head3 Long doubles
326
327 In some systems you may be able to use long doubles to enhance the
328 range and precision of your double precision floating point numbers
329 (that is, Perl's numbers).  Use Configure -Duselongdouble to enable
330 this support (if it is available).
331
332 Note that the exact format and range of long doubles varies:
333 the most common is the x86 80-bit (64 bits of mantissa) format,
334 but there are others, with different mantissa and exponent ranges.
335
336 =head3 "more bits"
337
338 You can "Configure -Dusemorebits" to turn on both the 64-bit support
339 and the long double support.
340
341 =head3 quadmath
342
343 One option for more precision is that gcc 4.6 and later have a library
344 called quadmath, which implements the IEEE 754 quadruple precision
345 (128-bit, 113 bits of mantissa) floating point numbers.  The library
346 works at least on x86 and ia64 platforms.  It may be part of your gcc
347 installation, or you may need to install it separately.
348
349 With "Configure -Dusequadmath" you can try enabling its use, but note
350 the compiler dependency, you may need to also add "-Dcc=...".
351 At C level the type is called C<__float128> (note, not "long double"),
352 but Perl source knows it as NV.  (This is not "long doubles".)
353
354 =head3 Algorithmic Complexity Attacks on Hashes
355
356 Perl 5.18 reworked the measures used to secure its hash function
357 from algorithmic complexity attacks.  By default it will build with
358 all of these measures enabled along with support for controlling and
359 disabling them via environment variables.
360
361 You can override various aspects of this feature by defining various
362 symbols during configure. An example might be:
363
364     sh Configure -Accflags=-DPERL_HASH_FUNC_SIPHASH
365
366 B<Unless stated otherwise these options are considered experimental or
367 insecure and are not recommended for production use.>
368
369 Since Perl 5.18 we have included support for multiple hash functions,
370 although from time to time we change which functions we support,
371 and which function is default (currently SBOX+STADTX on 64 bit builds
372 and SBOX+ZAPHOD32 for 32 bit builds). You can choose a different
373 algorithm by defining one of the following symbols during configure.
374 Note that there security implications of which hash function you choose
375 to use. The functions are listed roughly by how secure they are believed
376 to be, with the one believed to be most secure at release time being PERL_HASH_FUNC_SIPHASH.
377
378     PERL_HASH_FUNC_SIPHASH
379     PERL_HASH_FUNC_SIPHASH13
380     PERL_HASH_FUNC_ZAPHOD32
381     PERL_HASH_FUNC_STADTX
382
383 In addition, these, (or custom hash functions), may be "fronted" by the
384 SBOX32 hash function for keys under a chosen size. This hash function is
385 special in that it has proven theoretical security properties, and is very
386 fast to hash, but which by nature is restricted to a maximum key length,
387 and which has rather expensive setup costs (relatively speaking), both in
388 terms of performance and more importantly in terms of memory. SBOX32
389 requires 1k of storage per character it can hash, and it must populate that
390 storage with 256 32-bit random values as well. In practice the RNG we use
391 for seeding the SBOX32 storage is very efficient and populating the table
392 required for hashing even fairly long keys is negligble as we only do it
393 during startup. By default we build with SBOX32 enabled, but you change that
394 by setting
395
396    PERL_HASH_USE_SBOX32_ALSO
397
398 to zero in configure. By default Perl will use SBOX32 to hash strings 24 bytes
399 or shorter, you can change this length by setting
400
401     SBOX32_MAX_LEN
402
403 to the desired length, with the maximum length being 256.
404
405 As of Perl 5.18 the order returned by keys(), values(), and each() is
406 non-deterministic and distinct per hash, and the insert order for
407 colliding keys is randomized as well, and perl allows for controlling this
408 by the PERL_PERTURB_KEYS environment setting. You can disable this behavior
409 entirely with the define
410
411     PERL_PERTURB_KEYS_DISABLED
412
413 You can disable the environment variable checks and compile time specify
414 the type of key traversal randomization to be used by defining one of these:
415
416     PERL_PERTURB_KEYS_RANDOM
417     PERL_PERTURB_KEYS_DETERMINISTIC
418
419 Since Perl 5.18 the seed used for the hash function is randomly selected
420 at process start, which can be overridden by specifying a seed by setting
421 the PERL_HASH_SEED environment variable.
422
423 You can change this behavior so that your perl is built with a hard coded
424 seed with the define
425
426     NO_HASH_SEED
427
428 Note that if you do this you should modify the code in hv_func.h to specify
429 your own key. In the future this define may be renamed and replaced with one
430 that requires you to specify the key to use.
431
432 B<NOTE WELL: Perl has never guaranteed any ordering of the hash keys>, and the
433 ordering has already changed several times during the lifetime of Perl
434 5.  Also, the ordering of hash keys has always been, and continues to
435 be, affected by the insertion order regardless of whether you build with
436 or without the randomization features.  Note that because of this
437 and especially with randomization that the key order of a hash is *undefined*
438 and that things like Data::Dumper, for example, may produce different output
439 between different runs of Perl, since Data::Dumper serializes the key in the
440 native order for the hash.  The use of the Data::Dumper C<Sortkeys> option is
441 recommended if you are comparing dumps between different invocations of perl.
442
443 See L<perlrun/PERL_HASH_SEED> and L<perlrun/PERL_PERTURB_KEYS> for
444 details on the environment variables, and L<perlsec/Algorithmic
445 Complexity Attacks> for further security details.
446
447 The C<PERL_HASH_SEED> and PERL_PERTURB_KEYS> environment variables can
448 be disabled by building configuring perl with
449 C<-Accflags=-DNO_PERL_HASH_ENV>.
450
451 The C<PERL_HASH_SEED_DEBUG> environment variable can be disabled by
452 configuring perl with C<-Accflags=-DNO_PERL_HASH_SEED_DEBUG>.
453
454 =head3 SOCKS
455
456 Perl can be configured to be 'socksified', that is, to use the SOCKS
457 TCP/IP proxy protocol library.  SOCKS is used to give applications
458 access to transport layer network proxies.  Perl supports only SOCKS
459 Version 5.  The corresponding Configure option is -Dusesocks.
460 You can find more about SOCKS from wikipedia at
461 L<http://en.wikipedia.org/wiki/SOCKS>.
462
463 =head3 Dynamic Loading
464
465 By default, Configure will compile perl to use dynamic loading.
466 If you want to force perl to be compiled completely
467 statically, you can either choose this when Configure prompts you or
468 you can use the Configure command line option -Uusedl.
469 With this option, you won't be able to use any new extension
470 (XS) module without recompiling perl itself.
471
472 =head3 Building a shared Perl library
473
474 Currently, for most systems, the main perl executable is built by
475 linking the "perl library" libperl.a with perlmain.o, your static
476 extensions, and various extra libraries, such as -lm.
477
478 On systems that support dynamic loading, it may be possible to
479 replace libperl.a with a shared libperl.so.  If you anticipate building
480 several different perl binaries (e.g. by embedding libperl into
481 different programs, or by using the optional compiler extension), then
482 you might wish to build a shared libperl.so so that all your binaries
483 can share the same library.
484
485 The disadvantages are that there may be a significant performance
486 penalty associated with the shared libperl.so, and that the overall
487 mechanism is still rather fragile with respect to different versions
488 and upgrades.
489
490 In terms of performance, on my test system (Solaris 2.5_x86) the perl
491 test suite took roughly 15% longer to run with the shared libperl.so.
492 Your system and typical applications may well give quite different
493 results.
494
495 The default name for the shared library is typically something like
496 libperl.so.5.8.8 (for Perl 5.8.8), or libperl.so.588, or simply
497 libperl.so.  Configure tries to guess a sensible naming convention
498 based on your C library name.  Since the library gets installed in a
499 version-specific architecture-dependent directory, the exact name
500 isn't very important anyway, as long as your linker is happy.
501
502 You can elect to build a shared libperl by
503
504         sh Configure -Duseshrplib
505
506 To build a shared libperl, the environment variable controlling shared
507 library search (LD_LIBRARY_PATH in most systems, DYLD_LIBRARY_PATH for
508 Darwin, LD_LIBRARY_PATH/SHLIB_PATH
509 for HP-UX, LIBPATH for AIX, PATH for Cygwin) must be set up to include
510 the Perl build directory because that's where the shared libperl will
511 be created.  Configure arranges makefile to have the correct shared
512 library search settings.  You can find the name of the environment
513 variable Perl thinks works in your your system by
514
515         grep ldlibpthname config.sh
516
517 However, there are some special cases where manually setting the
518 shared library path might be required.  For example, if you want to run
519 something like the following with the newly-built but not-yet-installed
520 ./perl:
521
522         ./perl -MTestInit t/misc/failing_test.t
523
524 or
525
526         ./perl -Ilib ~/my_mission_critical_test
527
528 then you need to set up the shared library path explicitly.
529 You can do this with
530
531    LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
532
533 for Bourne-style shells, or
534
535    setenv LD_LIBRARY_PATH `pwd`
536
537 for Csh-style shells.  (This procedure may also be needed if for some
538 unexpected reason Configure fails to set up makefile correctly.) (And
539 again, it may be something other than LD_LIBRARY_PATH for you, see above.)
540
541 You can often recognize failures to build/use a shared libperl from error
542 messages complaining about a missing libperl.so (or libperl.sl in HP-UX),
543 for example:
544
545     18126:./miniperl: /sbin/loader: Fatal Error: cannot map libperl.so
546
547 There is also an potential problem with the shared perl library if you
548 want to have more than one "flavor" of the same version of perl (e.g.
549 with and without -DDEBUGGING).  For example, suppose you build and
550 install a standard Perl 5.10.0 with a shared library.  Then, suppose you
551 try to build Perl 5.10.0 with -DDEBUGGING enabled, but everything else
552 the same, including all the installation directories.  How can you
553 ensure that your newly built perl will link with your newly built
554 libperl.so.8 rather with the installed libperl.so.8?  The answer is
555 that you might not be able to.  The installation directory is encoded
556 in the perl binary with the LD_RUN_PATH environment variable (or
557 equivalent ld command-line option).  On Solaris, you can override that
558 with LD_LIBRARY_PATH; on Linux, you can only override at runtime via
559 LD_PRELOAD, specifying the exact filename you wish to be used; and on
560 Digital Unix, you can override LD_LIBRARY_PATH by setting the
561 _RLD_ROOT environment variable to point to the perl build directory.
562
563 In other words, it is generally not a good idea to try to build a perl
564 with a shared library if $archlib/CORE/$libperl already exists from a
565 previous build.
566
567 A good workaround is to specify a different directory for the
568 architecture-dependent library for your -DDEBUGGING version of perl.
569 You can do this by changing all the *archlib* variables in config.sh to
570 point to your new architecture-dependent library.
571
572 =head3 Environment access
573
574 Perl often needs to write to the program's environment, such as when
575 C<%ENV> is assigned to. Many implementations of the C library function
576 C<putenv()> leak memory, so where possible perl will manipulate the
577 environment directly to avoid these leaks. The default is now to perform
578 direct manipulation whenever perl is running as a stand alone interpreter,
579 and to call the safe but potentially leaky C<putenv()> function when the
580 perl interpreter is embedded in another application. You can force perl
581 to always use C<putenv()> by compiling with
582 C<-Accflags="-DPERL_USE_SAFE_PUTENV">, see section L</"Altering Configure
583 variables for C compiler switches etc.">.  You can force an embedded perl
584 to use direct manipulation by setting C<PL_use_safe_putenv = 0;> after
585 the C<perl_construct()> call.
586
587 =head2 Installation Directories
588
589 The installation directories can all be changed by answering the
590 appropriate questions in Configure.  For convenience, all the installation
591 questions are near the beginning of Configure.  Do not include trailing
592 slashes on directory names.  At any point during the Configure process,
593 you can answer a question with  &-d  and Configure will use the defaults
594 from then on.  Alternatively, you can
595
596         grep '^install' config.sh
597
598 after Configure has run to verify the installation paths.
599
600 The defaults are intended to be reasonable and sensible for most
601 people building from sources.  Those who build and distribute binary
602 distributions or who export perl to a range of systems will probably
603 need to alter them.  If you are content to just accept the defaults,
604 you can safely skip the next section.
605
606 The directories set up by Configure fall into three broad categories.
607
608 =over 4
609
610 =item Directories for the perl distribution
611
612 By default, Configure will use the following directories for 5.27.3.
613 $version is the full perl version number, including subversion, e.g.
614 5.12.3, and $archname is a string like sun4-sunos,
615 determined by Configure.  The full definitions of all Configure
616 variables are in the file Porting/Glossary.
617
618     Configure variable  Default value
619     $prefixexp          /usr/local
620     $binexp             $prefixexp/bin
621     $scriptdirexp       $prefixexp/bin
622     $privlibexp         $prefixexp/lib/perl5/$version
623     $archlibexp         $prefixexp/lib/perl5/$version/$archname
624     $man1direxp         $prefixexp/man/man1
625     $man3direxp         $prefixexp/man/man3
626     $html1direxp        (none)
627     $html3direxp        (none)
628
629 $prefixexp is generated from $prefix, with ~ expansion done to convert
630 home directories into absolute paths. Similarly for the other variables
631 listed. As file system calls do not do this, you should always reference
632 the ...exp variables, to support users who build perl in their home
633 directory.
634
635 Actually, Configure recognizes the SVR3-style
636 /usr/local/man/l_man/man1 directories, if present, and uses those
637 instead.  Also, if $prefix contains the string "perl", the library
638 directories are simplified as described below.  For simplicity, only
639 the common style is shown here.
640
641 =item Directories for site-specific add-on files
642
643 After perl is installed, you may later wish to add modules (e.g. from
644 CPAN) or scripts.  Configure will set up the following directories to
645 be used for installing those add-on modules and scripts.
646
647    Configure        Default
648    variable          value
649  $siteprefixexp    $prefixexp
650  $sitebinexp       $siteprefixexp/bin
651  $sitescriptexp    $siteprefixexp/bin
652  $sitelibexp       $siteprefixexp/lib/perl5/site_perl/$version
653  $sitearchexp
654                $siteprefixexp/lib/perl5/site_perl/$version/$archname
655  $siteman1direxp   $siteprefixexp/man/man1
656  $siteman3direxp   $siteprefixexp/man/man3
657  $sitehtml1direxp  (none)
658  $sitehtml3direxp  (none)
659
660 By default, ExtUtils::MakeMaker will install architecture-independent
661 modules into $sitelib and architecture-dependent modules into $sitearch.
662
663 =item Directories for vendor-supplied add-on files
664
665 Lastly, if you are building a binary distribution of perl for
666 distribution, Configure can optionally set up the following directories
667 for you to use to distribute add-on modules.
668
669    Configure          Default
670    variable            value
671  $vendorprefixexp    (none)
672
673  (The next ones are set only if vendorprefix is set.)
674
675  $vendorbinexp       $vendorprefixexp/bin
676  $vendorscriptexp    $vendorprefixexp/bin
677  $vendorlibexp       $vendorprefixexp/lib/perl5/vendor_perl/$version
678  $vendorarchexp
679            $vendorprefixexp/lib/perl5/vendor_perl/$version/$archname
680  $vendorman1direxp   $vendorprefixexp/man/man1
681  $vendorman3direxp   $vendorprefixexp/man/man3
682  $vendorhtml1direxp  (none)
683  $vendorhtml3direxp  (none)
684
685 These are normally empty, but may be set as needed.  For example,
686 a vendor might choose the following settings:
687
688  $prefix           /usr
689  $siteprefix       /usr/local
690  $vendorprefix     /usr
691
692 This would have the effect of setting the following:
693
694  $binexp           /usr/bin
695  $scriptdirexp     /usr/bin
696  $privlibexp       /usr/lib/perl5/$version
697  $archlibexp       /usr/lib/perl5/$version/$archname
698  $man1direxp       /usr/man/man1
699  $man3direxp       /usr/man/man3
700
701  $sitebinexp       /usr/local/bin
702  $sitescriptexp    /usr/local/bin
703  $sitelibexp       /usr/local/lib/perl5/site_perl/$version
704  $sitearchexp      /usr/local/lib/perl5/site_perl/$version/$archname
705  $siteman1direxp   /usr/local/man/man1
706  $siteman3direxp   /usr/local/man/man3
707
708  $vendorbinexp     /usr/bin
709  $vendorscriptexp  /usr/bin
710  $vendorlibexp     /usr/lib/perl5/vendor_perl/$version
711  $vendorarchexp    /usr/lib/perl5/vendor_perl/$version/$archname
712  $vendorman1direxp /usr/man/man1
713  $vendorman3direxp /usr/man/man3
714
715 Note how in this example, the vendor-supplied directories are in the
716 /usr hierarchy, while the directories reserved for the end user are in
717 the /usr/local hierarchy.
718
719 The entire installed library hierarchy is installed in locations with
720 version numbers, keeping the installations of different versions distinct.
721 However, later installations of Perl can still be configured to search
722 the installed libraries corresponding to compatible earlier versions.
723 See L<"Coexistence with earlier versions of perl 5"> below for more
724 details on how Perl can be made to search older version directories.
725
726 Of course you may use these directories however you see fit.  For
727 example, you may wish to use $siteprefix for site-specific files that
728 are stored locally on your own disk and use $vendorprefix for
729 site-specific files that are stored elsewhere on your organization's
730 network.  One way to do that would be something like
731
732  sh Configure -Dsiteprefix=/usr/local -Dvendorprefix=/usr/share/perl
733
734 =item otherlibdirs
735
736 As a final catch-all, Configure also offers an $otherlibdirs
737 variable.  This variable contains a colon-separated list of additional
738 directories to add to @INC.  By default, it will be empty.
739 Perl will search these directories (including architecture and
740 version-specific subdirectories) for add-on modules and extensions.
741
742 For example, if you have a bundle of perl libraries from a previous
743 installation, perhaps in a strange place:
744
745         sh Configure -Dotherlibdirs=/usr/lib/perl5/site_perl/5.8.1
746
747 =item APPLLIB_EXP
748
749 There is one other way of adding paths to @INC at perl build time, and
750 that is by setting the APPLLIB_EXP C pre-processor token to a colon-
751 separated list of directories, like this
752
753        sh Configure -Accflags='-DAPPLLIB_EXP=\"/usr/libperl\"'
754
755 The directories defined by APPLLIB_EXP get added to @INC I<first>,
756 ahead of any others, and so provide a way to override the standard perl
757 modules should you, for example, want to distribute fixes without
758 touching the perl distribution proper.  And, like otherlib dirs,
759 version and architecture specific subdirectories are also searched, if
760 present, at run time.  Of course, you can still search other @INC
761 directories ahead of those in APPLLIB_EXP by using any of the standard
762 run-time methods: $PERLLIB, $PERL5LIB, -I, use lib, etc.
763
764 =item default_inc_excludes_dot
765
766 Since version 5.26.0, default perl builds no longer includes C<'.'> as the
767 last element of @INC. The old behaviour can restored using 
768
769         sh Configure -Udefault_inc_excludes_dot
770
771 Note that this is likely to make programs run under such a perl
772 interpreter less secure.
773
774 =item usesitecustomize
775
776 Run-time customization of @INC can be enabled with:
777
778         sh Configure -Dusesitecustomize
779
780 which will define USE_SITECUSTOMIZE and $Config{usesitecustomize}.
781 When enabled, this makes perl run F<$sitelibexp/sitecustomize.pl> before
782 anything else.  This script can then be set up to add additional
783 entries to @INC.
784
785 =item Man Pages
786
787 By default, man pages will be installed in $man1dir and $man3dir, which
788 are normally /usr/local/man/man1 and /usr/local/man/man3.  If you
789 want to use a .3pm suffix for perl man pages, you can do that with
790
791         sh Configure -Dman3ext=3pm
792
793 =item HTML pages
794
795 Currently, the standard perl installation does not do anything with
796 HTML documentation, but that may change in the future.  Further, some
797 add-on modules may wish to install HTML documents.  The html Configure
798 variables listed above are provided if you wish to specify where such
799 documents should be placed.  The default is "none", but will likely
800 eventually change to something useful based on user feedback.
801
802 =back
803
804 Some users prefer to append a "/share" to $privlib and $sitelib
805 to emphasize that those directories can be shared among different
806 architectures.
807
808 Note that these are just the defaults.  You can actually structure the
809 directories any way you like.  They don't even have to be on the same
810 filesystem.
811
812 Further details about the installation directories, maintenance and
813 development subversions, and about supporting multiple versions are
814 discussed in L<"Coexistence with earlier versions of perl 5"> below.
815
816 If you specify a prefix that contains the string "perl", then the
817 library directory structure is slightly simplified.  Instead of
818 suggesting $prefix/lib/perl5/, Configure will suggest $prefix/lib.
819
820 Thus, for example, if you Configure with
821 -Dprefix=/opt/perl, then the default library directories for 5.9.0 are
822
823     Configure variable  Default value
824         $privlib        /opt/perl/lib/5.9.0
825         $archlib        /opt/perl/lib/5.9.0/$archname
826         $sitelib        /opt/perl/lib/site_perl/5.9.0
827         $sitearch       /opt/perl/lib/site_perl/5.9.0/$archname
828
829 =head2 Changing the installation directory
830
831 Configure distinguishes between the directory in which perl (and its
832 associated files) should be installed, and the directory in which it
833 will eventually reside.  For most sites, these two are the same; for
834 sites that use AFS, this distinction is handled automatically.
835 However, sites that use package management software such as rpm or
836 dpkg, or users building binary packages for distribution may also
837 wish to install perl into a different directory before moving perl
838 to its final destination.  There are two ways to do that:
839
840 =over 4
841
842 =item installprefix
843
844 To install perl under the /tmp/perl5 directory, use the following
845 command line:
846
847     sh Configure -Dinstallprefix=/tmp/perl5
848
849 (replace /tmp/perl5 by a directory of your choice).
850
851 Beware, though, that if you go to try to install new add-on
852 modules, they too will get installed in under '/tmp/perl5' if you
853 follow this example.  That's why it's usually better to use DESTDIR,
854 as shown in the next section.
855
856 =item DESTDIR
857
858 If you need to install perl on many identical systems, it is convenient
859 to compile it once and create an archive that can be installed on
860 multiple systems.  Suppose, for example, that you want to create an
861 archive that can be installed in /opt/perl.  One way to do that is by
862 using the DESTDIR variable during C<make install>.  The DESTDIR is
863 automatically prepended to all the installation paths.  Thus you
864 simply do:
865
866     sh Configure -Dprefix=/opt/perl -des
867     make
868     make test
869     make install DESTDIR=/tmp/perl5
870     cd /tmp/perl5/opt/perl
871     tar cvf /tmp/perl5-archive.tar .
872
873 =back
874
875 =head2 Relocatable @INC
876
877 To create a relocatable perl tree, use the following command line:
878
879     sh Configure -Duserelocatableinc
880
881 Then the paths in @INC (and everything else in %Config) can be
882 optionally located via the path of the perl executable.
883
884 That means that, if the string ".../" is found at the start of any
885 path, it's substituted with the directory of $^X. So, the relocation
886 can be configured on a per-directory basis, although the default with
887 "-Duserelocatableinc" is that everything is relocated. The initial
888 install is done to the original configured prefix.
889
890 This option is not compatible with the building of a shared libperl
891 ("-Duseshrplib"), because in that case perl is linked with an hard-coded
892 rpath that points at the libperl.so, that cannot be relocated.
893
894 =head2 Site-wide Policy settings
895
896 After Configure runs, it stores a number of common site-wide "policy"
897 answers (such as installation directories) in the Policy.sh file.
898 If you want to build perl on another system using the same policy
899 defaults, simply copy the Policy.sh file to the new system's perl build
900 directory, and Configure will use it. This will work even if Policy.sh was
901 generated for another version of Perl, or on a system with a
902 different architecture and/or operating system. However, in such cases,
903 you should review the contents of the file before using it: for
904 example, your new target may not keep its man pages in the same place
905 as the system on which the file was generated.
906
907 Alternatively, if you wish to change some or all of those policy
908 answers, you should
909
910         rm -f Policy.sh
911
912 to ensure that Configure doesn't re-use them.
913
914 Further information is in the Policy_sh.SH file itself.
915
916 If the generated Policy.sh file is unsuitable, you may freely edit it
917 to contain any valid shell commands.  It will be run just after the
918 platform-specific hints files.
919
920 =head2 Disabling older versions of Perl
921
922 Configure will search for binary compatible versions of previously
923 installed perl binaries in the tree that is specified as target tree,
924 and these will be used as locations to search for modules by the perl
925 being built. The list of perl versions found will be put in the Configure
926 variable inc_version_list.
927
928 To disable this use of older perl modules, even completely valid pure
929 perl modules, you can specify to not include the paths found:
930
931        sh Configure -Dinc_version_list=none ...
932
933 If you do want to use modules from some previous perl versions, the
934 variable must contain a space separated list of directories under the
935 site_perl directory, and has to include architecture-dependent
936 directories separately, eg.
937
938        sh Configure -Dinc_version_list="5.16.0/x86_64-linux 5.16.0" ...
939
940 When using the newer perl, you can add these paths again in the
941 PERL5LIB environment variable or with perl's -I runtime option.
942
943 =head2 Building Perl outside of the source directory
944
945 Sometimes it is desirable to build Perl in a directory different from
946 where the sources are, for example if you want to keep your sources
947 read-only, or if you want to share the sources between different binary
948 architectures.  You can do this (if your file system supports symbolic
949 links) by
950
951         mkdir /tmp/perl/build/directory
952         cd /tmp/perl/build/directory
953         sh /path/to/perl/source/Configure -Dmksymlinks ...
954
955 This will create in /tmp/perl/build/directory a tree of symbolic links
956 pointing to files in /path/to/perl/source.  The original files are left
957 unaffected.  After Configure has finished you can just say
958
959         make
960         make test
961         make install
962
963 as usual, and Perl will be built in /tmp/perl/build/directory.
964
965 =head2 Building a debugging perl
966
967 You can run perl scripts under the perl debugger at any time with
968 B<perl -d your_script>.  If, however, you want to debug perl itself,
969 you probably want to have support for perl internal debugging code
970 (activated by adding -DDEBUGGING to ccflags), and/or support for the
971 system debugger by adding -g to the optimisation flags.
972
973 A perl compiled with the DEBUGGING C preprocessor macro will support the
974 C<-D> perl command-line switch, have assertions enabled, and have many
975 extra checks compiled into the code; but will execute much more slowly
976 (typically 2-3x) and the binary will be much larger (typically 2-3x).
977
978 As a convenience, debugging code (-DDEBUGGING) and debugging symbols (-g)
979 can be enabled jointly or separately using a Configure switch, also
980 (somewhat confusingly) named -DDEBUGGING.  For a more eye appealing call,
981 -DEBUGGING is defined to be an alias for -DDEBUGGING. For both, the -U
982 calls are also supported, in order to be able to overrule the hints or
983 Policy.sh settings.
984
985 Here are the DEBUGGING modes:
986
987 =over 4
988
989 =item Configure -DDEBUGGING
990
991 =item Configure -DEBUGGING
992
993 =item Configure -DEBUGGING=both
994
995 Sets both -DDEBUGGING in the ccflags, and adds -g to optimize.
996
997 You can actually specify -g and -DDEBUGGING independently (see below),
998 but usually it's convenient to have both.
999
1000 =item Configure -DEBUGGING=-g
1001
1002 =item Configure -Doptimize=-g
1003
1004 Adds -g to optimize, but does not set -DDEBUGGING.
1005
1006 (Note:  Your system may actually require something like cc -g2.
1007 Check your man pages for cc(1) and also any hint file for your system.)
1008
1009 =item Configure -DEBUGGING=none
1010
1011 =item Configure -UDEBUGGING
1012
1013 Removes -g from optimize, and -DDEBUGGING from ccflags.
1014
1015 =back
1016
1017 If you are using a shared libperl, see the warnings about multiple
1018 versions of perl under L<Building a shared Perl library>.
1019
1020 Note that a perl built with -DDEBUGGING will be much bigger and will run
1021 much, much more slowly than a standard perl.
1022
1023 =head2 DTrace support
1024
1025 On platforms where DTrace is available, it may be enabled by
1026 using the -Dusedtrace option to Configure. DTrace probes are available
1027 for subroutine entry (sub-entry) and subroutine exit (sub-exit). Here's a
1028 simple D script that uses them:
1029
1030   perl$target:::sub-entry, perl$target:::sub-return {
1031     printf("%s %s (%s:%d)\n", probename == "sub-entry" ? "->" : "<-",
1032               copyinstr(arg0), copyinstr(arg1), arg2);
1033   }
1034
1035
1036 =head2 Extensions
1037
1038 Perl ships with a number of standard extensions.  These are contained
1039 in the ext/ subdirectory.
1040
1041 By default, Configure will offer to build every extension which appears
1042 to be supported.  For example, Configure will offer to build GDBM_File
1043 only if it is able to find the gdbm library.
1044
1045 To disable certain extensions so that they are not built, use the
1046 -Dnoextensions=... and -Donlyextensions=... options.  They both accept
1047 a space-separated list of extensions, such as C<IPC/SysV>. The extensions
1048 listed in
1049 C<noextensions> are removed from the list of extensions to build, while
1050 the C<onlyextensions> is rather more severe and builds only the listed
1051 extensions.  The latter should be used with extreme caution since
1052 certain extensions are used by many other extensions and modules:
1053 examples of such modules include Fcntl and IO.  The order of processing
1054 these options is first C<only> (if present), then C<no> (if present).
1055
1056 Of course, you may always run Configure interactively and select only
1057 the extensions you want.
1058
1059 If you unpack any additional extensions in the ext/ directory before
1060 running Configure, then Configure will offer to build those additional
1061 extensions as well.  Most users probably shouldn't have to do this --
1062 it is usually easier to build additional extensions later after perl
1063 has been installed.  However, if you wish to have those additional
1064 extensions statically linked into the perl binary, then this offers a
1065 convenient way to do that in one step.  (It is not necessary, however;
1066 you can build and install extensions just fine even if you don't have
1067 dynamic loading.  See lib/ExtUtils/MakeMaker.pm for more details.)
1068 Another way of specifying extra modules is described in
1069 L<"Adding extra modules to the build"> below.
1070
1071 If you re-use an old config.sh but change your system (e.g. by
1072 adding libgdbm) Configure will still offer your old choices of extensions
1073 for the default answer, but it will also point out the discrepancy to
1074 you.
1075
1076 =head2 Including locally-installed libraries
1077
1078 Perl comes with interfaces to number of libraries, including threads,
1079 dbm, ndbm, gdbm, and Berkeley db.  For the *db* extension, if
1080 Configure can find the appropriate header files and libraries, it will
1081 automatically include that extension.  The threading extension needs
1082 to be specified explicitly (see L</Threads>).
1083
1084 Those libraries are not distributed with perl. If your header (.h) files
1085 for those libraries are not in a directory normally searched by your C
1086 compiler, then you will need to include the appropriate -I/your/directory
1087 option when prompted by Configure.  If your libraries are not in a
1088 directory normally searched by your C compiler and linker, then you will
1089 need to include the appropriate -L/your/directory option when prompted
1090 by Configure. See the examples below.
1091
1092 =head3 Examples
1093
1094 =over 4
1095
1096 =item gdbm in /usr/local
1097
1098 Suppose you have gdbm and want Configure to find it and build the
1099 GDBM_File extension.  This example assumes you have gdbm.h
1100 installed in /usr/local/include/gdbm.h and libgdbm.a installed in
1101 /usr/local/lib/libgdbm.a.  Configure should figure all the
1102 necessary steps out automatically.
1103
1104 Specifically, when Configure prompts you for flags for
1105 your C compiler, you should include -I/usr/local/include, if it's
1106 not here yet. Similarly, when Configure prompts you for linker flags,
1107 you should include -L/usr/local/lib.
1108
1109 If you are using dynamic loading, then when Configure prompts you for
1110 linker flags for dynamic loading, you should again include
1111 -L/usr/local/lib.
1112
1113 Again, this should all happen automatically.  This should also work if
1114 you have gdbm installed in any of (/usr/local, /opt/local, /usr/gnu,
1115 /opt/gnu, /usr/GNU, or /opt/GNU).
1116
1117 =item BerkeleyDB in /usr/local/BerkeleyDB
1118
1119 The version of BerkeleyDB distributed by Oracle installs in a
1120 version-specific directory by default, typically something like
1121 /usr/local/BerkeleyDB.4.7.  To have Configure find that, you need to add
1122 -I/usr/local/BerkeleyDB.4.7/include to cc flags, as in the previous
1123 example, and you will also have to take extra steps to help Configure
1124 find -ldb.  Specifically, when Configure prompts you for library
1125 directories, add /usr/local/BerkeleyDB.4.7/lib to the list.  Also, you
1126 will need to add appropriate linker flags to tell the runtime linker
1127 where to find the BerkeleyDB shared libraries.
1128
1129 It is possible to specify this from the command line (all on one
1130 line):
1131
1132  sh Configure -de \
1133     -Dlocincpth='/usr/local/BerkeleyDB.4.7/include             \
1134                                            /usr/local/include' \
1135     -Dloclibpth='/usr/local/BerkeleyDB.4.7/lib /usr/local/lib' \
1136     -Aldflags='-R/usr/local/BerkeleyDB.4.7/lib'
1137
1138 locincpth is a space-separated list of include directories to search.
1139 Configure will automatically add the appropriate -I directives.
1140
1141 loclibpth is a space-separated list of library directories to search.
1142 Configure will automatically add the appropriate -L directives.
1143
1144 The addition to ldflags is so that the dynamic linker knows where to find
1145 the BerkeleyDB libraries.  For Linux and Solaris, the -R option does that.
1146 Other systems may use different flags.  Use the appropriate flag for your
1147 system.
1148
1149 =back
1150
1151 =head2 Specifying a logical root directory
1152
1153 If you are cross-compiling, or are using a compiler which has it's own
1154 headers and libraries in a nonstandard location, and your compiler
1155 understands the C<--sysroot> option, you can use the C<-Dsysroot> option
1156 to specify the logical root directory under which all libraries and
1157 headers are searched for. This patch adjusts Configure to search under
1158 $sysroot, instead of /.
1159
1160 --sysroot is added to ccflags and friends so that make in
1161 ExtUtils::MakeMaker, and other extensions, will use it.
1162
1163 =head2 Overriding an old config.sh
1164
1165 If you want to use an old config.sh produced by a previous run of
1166 Configure, but override some of the items with command line options, you
1167 need to use B<Configure -O>.
1168
1169 =head2 GNU-style configure
1170
1171 If you prefer the GNU-style configure command line interface, you can
1172 use the supplied configure.gnu command, e.g.
1173
1174         CC=gcc ./configure.gnu
1175
1176 The configure.gnu script emulates a few of the more common configure
1177 options.  Try
1178
1179         ./configure.gnu --help
1180
1181 for a listing.
1182
1183 (The file is called configure.gnu to avoid problems on systems
1184 that would not distinguish the files "Configure" and "configure".)
1185
1186 =head2 Malloc Issues
1187
1188 Perl relies heavily on malloc(3) to grow data structures as needed,
1189 so perl's performance can be noticeably affected by the performance of
1190 the malloc function on your system.  The perl source is shipped with a
1191 version of malloc that has been optimized for the typical requests from
1192 perl, so there's a chance that it may be both faster and use less memory
1193 than your system malloc.
1194
1195 However, if your system already has an excellent malloc, or if you are
1196 experiencing difficulties with extensions that use third-party libraries
1197 that call malloc, then you should probably use your system's malloc.
1198 (Or, you might wish to explore the malloc flags discussed below.)
1199
1200 =over 4
1201
1202 =item Using the system malloc
1203
1204 To build without perl's malloc, you can use the Configure command
1205
1206         sh Configure -Uusemymalloc
1207
1208 or you can answer 'n' at the appropriate interactive Configure prompt.
1209
1210 Note that Perl's malloc isn't always used by default; that actually
1211 depends on your system. For example, on Linux and FreeBSD (and many more
1212 systems), Configure chooses to use the system's malloc by default.
1213 See the appropriate file in the F<hints/> directory to see how the
1214 default is set.
1215
1216 =item -DPERL_POLLUTE_MALLOC
1217
1218 NOTE: This flag is enabled automatically on some platforms if you just
1219 run Configure to accept all the defaults.
1220
1221 Perl's malloc family of functions are normally called Perl_malloc(),
1222 Perl_realloc(), Perl_calloc() and Perl_mfree().
1223 These names do not clash with the system versions of these functions.
1224
1225 If this flag is enabled, however, Perl's malloc family of functions
1226 will have the same names as the system versions.  This may be required
1227 sometimes if you have libraries that like to free() data that may have
1228 been allocated by Perl_malloc() and vice versa.
1229
1230 Note that enabling this option may sometimes lead to duplicate symbols
1231 from the linker for malloc et al.  In such cases, the system probably
1232 does not allow its malloc functions to be fully replaced with custom
1233 versions.
1234
1235 =item -DPERL_DEBUGGING_MSTATS
1236
1237 This flag enables debugging mstats, which is required to use the
1238 Devel::Peek::mstat() function. You cannot enable this unless you are
1239 using Perl's malloc, so a typical Configure command would be
1240
1241        sh Configure -Accflags=-DPERL_DEBUGGING_MSTATS -Dusemymalloc
1242
1243 to enable this option.
1244
1245 =back
1246
1247 =head2 What if it doesn't work?
1248
1249 If you run into problems, try some of the following ideas.
1250 If none of them help, then see L<"Reporting Problems"> below.
1251
1252 =over 4
1253
1254 =item Running Configure Interactively
1255
1256 If Configure runs into trouble, remember that you can always run
1257 Configure interactively so that you can check (and correct) its
1258 guesses.
1259
1260 All the installation questions have been moved to the top, so you don't
1261 have to wait for them.  Once you've handled them (and your C compiler and
1262 flags) you can type  &-d  at the next Configure prompt and Configure
1263 will use the defaults from then on.
1264
1265 If you find yourself trying obscure command line incantations and
1266 config.over tricks, I recommend you run Configure interactively
1267 instead.  You'll probably save yourself time in the long run.
1268
1269 =item Hint files
1270
1271 Hint files tell Configure about a number of things:
1272
1273 =over 4
1274
1275 =item o
1276
1277 The peculiarities or conventions of particular platforms -- non-standard
1278 library locations and names, default installation locations for binaries,
1279 and so on.
1280
1281 =item o
1282
1283 The deficiencies of the platform -- for example, library functions that,
1284 although present, are too badly broken to be usable; or limits on
1285 resources that are generously available on most platforms.
1286
1287 =item o
1288
1289 How best to optimize for the platform, both in terms of binary size
1290 and/or speed, and for Perl feature support. Because of wide variations in
1291 the implementation of shared libraries and of threading, for example,
1292 Configure often needs hints in order to be able to use these features.
1293
1294 =back
1295
1296 The perl distribution includes many system-specific hints files
1297 in the hints/ directory. If one of them matches your system, Configure
1298 will offer to use that hint file. Unless you have a very good reason
1299 not to, you should accept its offer.
1300
1301 Several of the hint files contain additional important information.
1302 If you have any problems, it is a good idea to read the relevant hint
1303 file for further information.  See hints/solaris_2.sh for an extensive
1304 example.  More information about writing good hints is in the
1305 hints/README.hints file, which also explains hint files known as
1306 callback-units.
1307
1308 Note that any hint file is read before any Policy file, meaning that
1309 Policy overrides hints -- see L</Site-wide Policy settings>.
1310
1311 =item WHOA THERE!!!
1312
1313 If you are re-using an old config.sh, it's possible that Configure
1314 detects different values from the ones specified in this file.  You will
1315 almost always want to keep the previous value, unless you have changed
1316 something on your system.
1317
1318 For example, suppose you have added libgdbm.a to your system
1319 and you decide to reconfigure perl to use GDBM_File.  When you run
1320 Configure again, you will need to add -lgdbm to the list of libraries.
1321 Now, Configure will find your gdbm include file and library and will
1322 issue a message:
1323
1324     *** WHOA THERE!!! ***
1325         The previous value for $i_gdbm on this machine was "undef"!
1326         Keep the previous value? [y]
1327
1328 In this case, you do not want to keep the previous value, so you
1329 should answer 'n'.  (You'll also have to manually add GDBM_File to
1330 the list of dynamic extensions to build.)
1331
1332 =item Changing Compilers
1333
1334 If you change compilers or make other significant changes, you should
1335 probably not re-use your old config.sh.  Simply remove it or
1336 rename it, then rerun Configure with the options you want to use.
1337
1338 =item Propagating your changes to config.sh
1339
1340 If you make any changes to config.sh, you should propagate
1341 them to all the .SH files by running
1342
1343         sh Configure -S
1344
1345 You will then have to rebuild by running
1346
1347         make depend
1348         make
1349
1350 =item config.over and config.arch
1351
1352 You can also supply a shell script config.over to override
1353 Configure's guesses.  It will get loaded up at the very end, just
1354 before config.sh is created.  You have to be careful with this,
1355 however, as Configure does no checking that your changes make sense.
1356 This file is usually good for site-specific customizations.
1357
1358 There is also another file that, if it exists, is loaded before the
1359 config.over, called config.arch.  This file is intended to be per
1360 architecture, not per site, and usually it's the architecture-specific
1361 hints file that creates the config.arch.
1362
1363 =item config.h
1364
1365 Many of the system dependencies are contained in config.h.
1366 Configure builds config.h by running the config_h.SH script.
1367 The values for the variables are taken from config.sh.
1368
1369 If there are any problems, you can edit config.h directly.  Beware,
1370 though, that the next time you run Configure, your changes will be
1371 lost.
1372
1373 =item cflags
1374
1375 If you have any additional changes to make to the C compiler command
1376 line, they can be made in cflags.SH.  For instance, to turn off the
1377 optimizer on toke.c, find the switch structure marked 'or customize here',
1378 and add a line for toke.c ahead of the catch-all *) so that it now reads:
1379
1380     : or customize here
1381
1382     case "$file" in
1383     toke) optimize='-g' ;;
1384     *) ;;
1385
1386 You should not edit the generated file cflags directly, as your changes
1387 will be lost the next time you run Configure, or if you edit config.sh.
1388
1389 To explore various ways of changing ccflags from within a hint file,
1390 see the file hints/README.hints.
1391
1392 To change the C flags for all the files, edit config.sh and change either
1393 $ccflags or $optimize, and then re-run
1394
1395         sh Configure -S
1396         make depend
1397
1398 =item No sh
1399
1400 If you don't have sh, you'll have to copy the sample file
1401 Porting/config.sh to config.sh and edit your config.sh to reflect your
1402 system's peculiarities.  See Porting/pumpkin.pod for more information.
1403 You'll probably also have to extensively modify the extension building
1404 mechanism.
1405
1406 =item Porting information
1407
1408 Specific information for the OS/2, Plan 9, VMS and Win32 ports is in the
1409 corresponding README files and subdirectories.  Additional information,
1410 including a glossary of all those config.sh variables, is in the Porting
1411 subdirectory.  Porting/Glossary should especially come in handy.
1412
1413 Ports for other systems may also be available.  You should check out
1414 http://www.cpan.org/ports for current information on ports to
1415 various other operating systems.
1416
1417 If you plan to port Perl to a new architecture, study carefully the
1418 section titled "Philosophical Issues in Patching and Porting Perl"
1419 in the file Porting/pumpkin.pod and the file pod/perlgit.pod.
1420 Study also how other non-UNIX ports have solved problems.
1421
1422 =back
1423
1424 =head2 Adding extra modules to the build
1425
1426 You can specify extra modules or module bundles to be fetched from the
1427 CPAN and installed as part of the Perl build.  Either use the -Dextras=...
1428 command line parameter to Configure, for example like this:
1429
1430         Configure -Dextras="Bundle::LWP DBI"
1431
1432 or answer first 'y' to the question 'Install any extra modules?' and
1433 then answer "Bundle::LWP DBI" to the 'Extras?' question.
1434 The module or the bundle names are as for the CPAN module 'install'
1435 command.  This will only work if those modules are to be built as dynamic
1436 extensions.  If you wish to include those extra modules as static
1437 extensions, see L<"Extensions"> above.
1438
1439 Notice that because the CPAN module will be used to fetch the extra
1440 modules, you will need access to the CPAN, either via the Internet,
1441 or via a local copy such as a CD-ROM or a local CPAN mirror.  If you
1442 do not, using the extra modules option will die horribly.
1443
1444 Also notice that you yourself are responsible for satisfying any extra
1445 dependencies such as external headers or libraries BEFORE trying the
1446 build.  For example: you will need to have the Foo database specific
1447 headers and libraries installed for the DBD::Foo module.  The Configure
1448 process or the Perl build process will not help you with these.
1449
1450 =head2 suidperl
1451
1452 suidperl was an optional component of earlier releases of perl. It is no
1453 longer available.  Instead, use a tool specifically designed to handle
1454 changes in privileges, such as B<sudo>.
1455
1456 =head1 make depend
1457
1458 This will look for all the includes.  The output is stored in makefile.
1459 The only difference between Makefile and makefile is the dependencies at
1460 the bottom of makefile.  If you have to make any changes, you should edit
1461 makefile, not Makefile, since the Unix make command reads makefile first.
1462 (On non-Unix systems, the output may be stored in a different file.
1463 Check the value of $firstmakefile in your config.sh if in doubt.)
1464
1465 Configure will offer to do this step for you, so it isn't listed
1466 explicitly above.
1467
1468 =head1 make
1469
1470 This will attempt to make perl in the current directory.
1471
1472 =head2 Expected errors
1473
1474 These error reports are normal, and can be ignored:
1475
1476   ...
1477   make: [extra.pods] Error 1 (ignored)
1478   ...
1479   make: [extras.make] Error 1 (ignored)
1480
1481 =head2 What if it doesn't work?
1482
1483 If you can't compile successfully, try some of the following ideas.
1484 If none of them help, and careful reading of the error message and
1485 the relevant manual pages on your system doesn't help,
1486 then see L<"Reporting Problems"> below.
1487
1488 =over 4
1489
1490 =item hints
1491
1492 If you used a hint file, try reading the comments in the hint file
1493 for further tips and information.
1494
1495 =item extensions
1496
1497 If you can successfully build miniperl, but the process crashes
1498 during the building of extensions, run
1499
1500         make minitest
1501
1502 to test your version of miniperl.
1503
1504 =item locale
1505
1506 If you have any locale-related environment variables set, try unsetting
1507 them.  I have some reports that some versions of IRIX hang while
1508 running B<./miniperl configpm> with locales other than the C locale.
1509 See the discussion under L<"make test"> below about locales and the
1510 whole L<perllocale/"LOCALE PROBLEMS"> section in the file
1511 pod/perllocale.pod.  The latter is especially useful if you see something
1512 like this
1513
1514         perl: warning: Setting locale failed.
1515         perl: warning: Please check that your locale settings:
1516                 LC_ALL = "En_US",
1517                 LANG = (unset)
1518             are supported and installed on your system.
1519         perl: warning: Falling back to the standard locale ("C").
1520
1521 at Perl startup.
1522
1523 =item other environment variables
1524
1525 Configure does not check for environment variables that can sometimes
1526 have a major influence on how perl is built or tested. For example,
1527 OBJECT_MODE on AIX determines the way the compiler and linker deal with
1528 their objects, but this is a variable that only influences build-time
1529 behaviour, and should not affect the perl scripts that are eventually
1530 executed by the perl binary. Other variables, like PERL_UNICODE,
1531 PERL5LIB, and PERL5OPT will influence the behaviour of the test suite.
1532 So if you are getting strange test failures, you may want to try
1533 retesting with the various PERL variables unset.
1534
1535 =item varargs
1536
1537 If you get varargs problems with gcc, be sure that gcc is installed
1538 correctly and that you are not passing -I/usr/include to gcc.  When using
1539 gcc, you should probably have i_stdarg='define' and i_varargs='undef'
1540 in config.sh.  The problem is usually solved by installing gcc
1541 correctly.  If you do change config.sh, don't forget to propagate
1542 your changes (see L<"Propagating your changes to config.sh"> below).
1543 See also the L<"vsprintf"> item below.
1544
1545 =item util.c
1546
1547 If you get error messages such as the following (the exact line
1548 numbers and function name may vary in different versions of perl):
1549
1550     util.c: In function 'Perl_form':
1551     util.c:1107: number of arguments doesn't match prototype
1552     proto.h:125: prototype declaration
1553
1554 it might well be a symptom of the gcc "varargs problem".  See the
1555 previous L<"varargs"> item.
1556
1557 =item LD_LIBRARY_PATH
1558
1559 If you run into dynamic loading problems, check your setting of
1560 the LD_LIBRARY_PATH environment variable.  If you're creating a static
1561 Perl library (libperl.a rather than libperl.so) it should build
1562 fine with LD_LIBRARY_PATH unset, though that may depend on details
1563 of your local setup.
1564
1565 =item nm extraction
1566
1567 If Configure seems to be having trouble finding library functions,
1568 try not using nm extraction.  You can do this from the command line
1569 with
1570
1571         sh Configure -Uusenm
1572
1573 or by answering the nm extraction question interactively.
1574 If you have previously run Configure, you should not reuse your old
1575 config.sh.
1576
1577 =item umask not found
1578
1579 If the build processes encounters errors relating to umask(), the problem
1580 is probably that Configure couldn't find your umask() system call.
1581 Check your config.sh.  You should have d_umask='define'.  If you don't,
1582 this is probably the L<"nm extraction"> problem discussed above.  Also,
1583 try reading the hints file for your system for further information.
1584
1585 =item vsprintf
1586
1587 If you run into problems with vsprintf in compiling util.c, the
1588 problem is probably that Configure failed to detect your system's
1589 version of vsprintf().  Check whether your system has vprintf().
1590 (Virtually all modern Unix systems do.)  Then, check the variable
1591 d_vprintf in config.sh.  If your system has vprintf, it should be:
1592
1593         d_vprintf='define'
1594
1595 If Configure guessed wrong, it is likely that Configure guessed wrong
1596 on a number of other common functions too.  This is probably
1597 the L<"nm extraction"> problem discussed above.
1598
1599 =item do_aspawn
1600
1601 If you run into problems relating to do_aspawn or do_spawn, the
1602 problem is probably that Configure failed to detect your system's
1603 fork() function.  Follow the procedure in the previous item
1604 on L<"nm extraction">.
1605
1606 =item __inet_* errors
1607
1608 If you receive unresolved symbol errors during Perl build and/or test
1609 referring to __inet_* symbols, check to see whether BIND 8.1 is
1610 installed.  It installs a /usr/local/include/arpa/inet.h that refers to
1611 these symbols.  Versions of BIND later than 8.1 do not install inet.h
1612 in that location and avoid the errors.  You should probably update to a
1613 newer version of BIND (and remove the files the old one left behind).
1614 If you can't, you can either link with the updated resolver library
1615 provided with BIND 8.1 or rename /usr/local/bin/arpa/inet.h during the
1616 Perl build and test process to avoid the problem.
1617
1618 =item .*_r() prototype NOT found
1619
1620 On a related note, if you see a bunch of complaints like the above about
1621 reentrant functions -- specifically networking-related ones -- being
1622 present but without prototypes available, check to see if BIND 8.1 (or
1623 possibly other BIND 8 versions) is (or has been) installed. They install
1624 header files such as netdb.h into places such as /usr/local/include (or
1625 into another directory as specified at build/install time), at least
1626 optionally.  Remove them or put them in someplace that isn't in the C
1627 preprocessor's header file include search path (determined by -I options
1628 plus defaults, normally /usr/include).
1629
1630 =item #error "No DATAMODEL_NATIVE specified"
1631
1632 This is a common error when trying to build perl on Solaris 2.6 with a
1633 gcc installation from Solaris 2.5 or 2.5.1.  The Solaris header files
1634 changed, so you need to update your gcc installation.  You can either
1635 rerun the fixincludes script from gcc or take the opportunity to
1636 update your gcc installation.
1637
1638 =item Optimizer
1639
1640 If you can't compile successfully, try turning off your compiler's
1641 optimizer.  Edit config.sh and change the line
1642
1643         optimize='-O'
1644
1645 to
1646
1647         optimize=' '
1648
1649 then propagate your changes with B<sh Configure -S> and rebuild
1650 with B<make depend; make>.
1651
1652 =item Missing functions and Undefined symbols
1653
1654 If the build of miniperl fails with a long list of missing functions or
1655 undefined symbols, check the libs variable in the config.sh file.  It
1656 should look something like
1657
1658         libs='-lsocket -lnsl -ldl -lm -lc'
1659
1660 The exact libraries will vary from system to system, but you typically
1661 need to include at least the math library -lm.  Normally, Configure
1662 will suggest the correct defaults.  If the libs variable is empty, you
1663 need to start all over again.  Run
1664
1665         make distclean
1666
1667 and start from the very beginning.  This time, unless you are sure of
1668 what you are doing, accept the default list of libraries suggested by
1669 Configure.
1670
1671 If the libs variable is missing -lm, there is a chance that libm.so.1
1672 is available, but the required (symbolic) link to libm.so is missing.
1673 (same could be the case for other libraries like libcrypt.so).  You
1674 should check your installation for packages that create that link, and
1675 if no package is installed that supplies that link or you cannot install
1676 them, make the symbolic link yourself e.g.:
1677
1678  $ rpm -qf /usr/lib64/libm.so
1679  glibc-devel-2.15-22.17.1.x86_64
1680  $ ls -lgo /usr/lib64/libm.so
1681  lrwxrwxrwx 1 16 Jan  7  2013 /usr/lib64/libm.so -> /lib64/libm.so.6
1682
1683  or
1684
1685  $ sudo ln -s /lib64/libm.so.6 /lib64/libm.so
1686
1687 If the libs variable looks correct, you might have the
1688 L<"nm extraction"> problem discussed above.
1689
1690 If you still have missing routines or undefined symbols, you probably
1691 need to add some library or other, make a symbolic link like described
1692 above, or you need to undefine some feature that Configure thought was
1693 there but is defective or incomplete.  If you used a hint file, see if
1694 it has any relevant advice.  You can also look through through config.h
1695 for likely suspects.
1696
1697 =item toke.c
1698
1699 Some compilers will not compile or optimize the larger files (such as
1700 toke.c) without some extra switches to use larger jump offsets or
1701 allocate larger internal tables.  You can customize the switches for
1702 each file in cflags.SH.  It's okay to insert rules for specific files
1703 into makefile since a default rule only takes effect in the absence of a
1704 specific rule.
1705
1706 =item Missing dbmclose
1707
1708 SCO prior to 3.2.4 may be missing dbmclose().  An upgrade to 3.2.4
1709 that includes libdbm.nfs (which includes dbmclose()) may be available.
1710
1711 =item error: too few arguments to function 'dbmclose'
1712
1713 Building ODBM_File on some (Open)SUSE distributions might run into this
1714 error, as the header file is broken. There are two ways to deal with this
1715
1716  1. Disable the use of ODBM_FILE
1717
1718     sh Configure ... -Dnoextensions=ODBM_File
1719
1720  2. Fix the header file, somewhat like this:
1721
1722     --- a/usr/include/dbm.h  2010-03-24 08:54:59.000000000 +0100
1723     +++ b/usr/include/dbm.h  2010-03-24 08:55:15.000000000 +0100
1724     @@ -59,4 +59,4 @@ extern datum  firstkey __P((void));
1725
1726      extern datum   nextkey __P((datum key));
1727
1728     -extern int     dbmclose __P((DBM *));
1729     +extern int     dbmclose __P((void));
1730
1731 =item Warning (mostly harmless): No library found for -lsomething
1732
1733 If you see such a message during the building of an extension, but
1734 the extension passes its tests anyway (see L<"make test"> below),
1735 then don't worry about the warning message.  The extension
1736 Makefile.PL goes looking for various libraries needed on various
1737 systems; few systems will need all the possible libraries listed.
1738 Most users will see warnings for the ones they don't have.  The
1739 phrase 'mostly harmless' is intended to reassure you that nothing
1740 unusual is happening, and the build process is continuing.
1741
1742 On the other hand, if you are building GDBM_File and you get the
1743 message
1744
1745     Warning (mostly harmless): No library found for -lgdbm
1746
1747 then it's likely you're going to run into trouble somewhere along
1748 the line, since it's hard to see how you can use the GDBM_File
1749 extension without the -lgdbm library.
1750
1751 It is true that, in principle, Configure could have figured all of
1752 this out, but Configure and the extension building process are not
1753 quite that tightly coordinated.
1754
1755 =item sh: ar: not found
1756
1757 This is a message from your shell telling you that the command 'ar'
1758 was not found.  You need to check your PATH environment variable to
1759 make sure that it includes the directory with the 'ar' command.  This
1760 is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin
1761 directory.
1762
1763 =item db-recno failure on tests 51, 53 and 55
1764
1765 Old versions of the DB library (including the DB library which comes
1766 with FreeBSD 2.1) had broken handling of recno databases with modified
1767 bval settings.  Upgrade your DB library or OS.
1768
1769 =item Bad arg length for semctl, is XX, should be ZZZ
1770
1771 If you get this error message from the F<cpan/IPC-SysV/t/sem.t> test, your
1772 System V IPC may be broken.  The XX typically is 20, and that is what ZZZ
1773 also should be.  Consider upgrading your OS, or reconfiguring your OS
1774 to include the System V semaphores.
1775
1776 =item cpan/IPC-SysV/t/sem........semget: No space left on device
1777
1778 Either your account or the whole system has run out of semaphores.  Or
1779 both.  Either list the semaphores with "ipcs" and remove the unneeded
1780 ones (which ones these are depends on your system and applications)
1781 with "ipcrm -s SEMAPHORE_ID_HERE" or configure more semaphores to your
1782 system.
1783
1784 =item GNU binutils
1785
1786 If you mix GNU binutils (nm, ld, ar) with equivalent vendor-supplied
1787 tools you may be in for some trouble.  For example creating archives
1788 with an old GNU 'ar' and then using a new current vendor-supplied 'ld'
1789 may lead into linking problems.  Either recompile your GNU binutils
1790 under your current operating system release, or modify your PATH not
1791 to include the GNU utils before running Configure, or specify the
1792 vendor-supplied utilities explicitly to Configure, for example by
1793 Configure -Dar=/bin/ar.
1794
1795 =item THIS PACKAGE SEEMS TO BE INCOMPLETE
1796
1797 The F<Configure> program has not been able to find all the files which
1798 make up the complete Perl distribution.  You may have a damaged source
1799 archive file (in which case you may also have seen messages such as
1800 C<gzip: stdin: unexpected end of file> and C<tar: Unexpected EOF on
1801 archive file>), or you may have obtained a structurally-sound but
1802 incomplete archive.  In either case, try downloading again from the
1803 official site named at the start of this document.  If you do find
1804 that any site is carrying a corrupted or incomplete source code
1805 archive, please report it to the site's maintainer.
1806
1807 =item invalid token: ##
1808
1809 You are using a non-ANSI-compliant C compiler.  To compile Perl, you
1810 need to use a compiler that supports ANSI C.  If there is a README
1811 file for your system, it may have further details on your compiler
1812 options.
1813
1814 =item Miscellaneous
1815
1816 Some additional things that have been reported:
1817
1818 Genix may need to use libc rather than libc_s, or #undef VARARGS.
1819
1820 NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
1821
1822 UTS may need one or more of -K or -g, and #undef LSTAT.
1823
1824 FreeBSD can fail the F<cpan/IPC-SysV/t/sem.t> test if SysV IPC has not been
1825 configured in the kernel.  Perl tries to detect this, though, and
1826 you will get a message telling you what to do.
1827
1828 Building Perl on a system that has also BIND (headers and libraries)
1829 installed may run into troubles because BIND installs its own netdb.h
1830 and socket.h, which may not agree with the operating system's ideas of
1831 the same files.  Similarly, including -lbind may conflict with libc's
1832 view of the world.  You may have to tweak -Dlocincpth and -Dloclibpth
1833 to avoid the BIND.
1834
1835 =back
1836
1837 =head2 Cross-compilation
1838
1839 Perl can be cross-compiled.  It is just not trivial, cross-compilation
1840 rarely is.  Perl is routinely cross-compiled for several platforms: as of
1841 January 2014, these include Android, Blackberry 10, PocketPC aka
1842 WinCE, ARM Linux, and Solaris.  Previous versions of
1843 Perl also provided support for Open Zaurus, Symbian, and
1844 the IBM OS/400, but it's unknown if those ports are still functional.
1845 These platforms are known as the B<target> platforms, while the systems
1846 where the compilation takes place are the B<host> platforms.
1847
1848 What makes the situation difficult is that first of all,
1849 cross-compilation environments vary significantly in how they are set
1850 up and used, and secondly because the primary way of configuring Perl
1851 (using the rather large Unix-tool-dependent Configure script) is not
1852 awfully well suited for cross-compilation.  However, starting from
1853 version 5.18.0, the Configure script also knows two ways of supporting
1854 cross-compilation, so please keep reading.
1855
1856 See the following files for more information about compiling Perl for
1857 the particular platforms:
1858
1859 =over 4
1860
1861 =item WinCE/PocketPC
1862
1863 L<README.ce or perlce|perlce>
1864
1865 =item Android
1866
1867 L<"Cross-compilation" in README.android or
1868 perlandroid|perlandroid/Cross-compilation>
1869
1870 =item Blackberry
1871
1872 L<"Cross-compilation" in README.qnx or perlqnx|perlqnx/Cross-compilation>
1873
1874 =item Solaris
1875
1876 L<"CROSS-COMPILATION" in README.solaris or
1877 perlsolaris|perlsolaris/CROSS-COMPILATION>
1878
1879 =item Linux
1880
1881 This document; See below.
1882
1883 =back
1884
1885 Packaging and transferring either the core Perl modules or CPAN
1886 modules to the target platform is also left up to the each
1887 cross-compilation environment.  Often the cross-compilation target
1888 platforms are somewhat limited in diskspace: see the section
1889 L<Minimizing the Perl installation> to learn more of the minimal set
1890 of files required for a functional Perl installation.
1891
1892 For some cross-compilation environments the Configure option
1893 C<-Dinstallprefix=...> might be handy, see L<Changing the installation
1894 directory>.
1895
1896 About the cross-compilation support of Configure: There's two forms.
1897 The more common one requires some way of transferring and running
1898 executables in the target system, such as an ssh connection; this is the
1899 C<./Configure -Dusecrosscompile -Dtargethost=...> route.  The second
1900 method doesn't need access to the target system, but requires you to
1901 provide a config.sh, and and a canned Makefile; the rest of this section
1902 describes the former.
1903
1904 This cross-compilation setup of Configure has successfully been used in
1905 a wide variety of setups, such as a 64-bit OS X host for an Android ARM
1906 target, or an amd64 Linux host targeting x86 Solaris, or even Windows.
1907
1908 To run Configure in cross-compilation mode the basic switch that
1909 has to be used is C<-Dusecrosscompile>:
1910
1911    sh ./Configure -des -Dusecrosscompile -D...
1912
1913 This will make the cpp symbol USE_CROSS_COMPILE and the %Config
1914 symbol C<usecrosscompile> available.
1915
1916 During the Configure and build, certain helper scripts will be created
1917 into the Cross/ subdirectory.  The scripts are used to execute a
1918 cross-compiled executable, and to transfer files to and from the
1919 target host.  The execution scripts are named F<run-*> and the
1920 transfer scripts F<to-*> and F<from-*>.  The part after the dash is
1921 the method to use for remote execution and transfer: by default the
1922 methods are B<ssh> and B<scp>, thus making the scripts F<run-ssh>,
1923 F<to-scp>, and F<from-scp>.
1924
1925 To configure the scripts for a target host and a directory (in which
1926 the execution will happen and which is to and from where the transfer
1927 happens), supply Configure with
1928
1929     -Dtargethost=so.me.ho.st -Dtargetdir=/tar/get/dir
1930
1931 The targethost is what e.g. ssh will use as the hostname, the targetdir
1932 must exist (the scripts won't create it), the targetdir defaults to /tmp.
1933 You can also specify a username to use for ssh/rsh logins
1934
1935     -Dtargetuser=luser
1936
1937 but in case you don't, "root" will be used.  Similarly, you can specify
1938 a non-standard (i.e. not 22) port for the connection, if applicable,
1939 through
1940
1941     -Dtargetport=2222
1942
1943 If the name of C<cc> has the usual GNU C semantics for cross
1944 compilers, that is, CPU-OS-gcc, the target architecture (C<targetarch>),
1945 plus names of the C<ar>, C<nm>, and C<ranlib> will also be automatically
1946 chosen to be CPU-OS-ar and so on.
1947 (The C<ld> requires more thought and will be chosen later by Configure
1948 as appropriate).  This will also aid in guessing the proper
1949 operating system name for the target, which has other repercussions, like
1950 better defaults and possibly critical fixes for the platform.  If
1951 Configure isn't guessing the OS name properly, you may need to either add
1952 a hint file redirecting Configure's guess, or modify Configure to make
1953 the correct choice.
1954
1955 If your compiler doesn't follow that convention, you will also need to
1956 specify which target environment to use, as well as C<ar> and friends:
1957
1958     -Dtargetarch=arm-linux
1959     -Dcc=mycrossgcc
1960     -Dar=...
1961
1962 Additionally, a cross-compilation toolchain will usually install it's own
1963 logical system root somewhere -- that is, it'll create a directory
1964 somewhere which includes subdirectories like C<'include'> or C<'lib'>.  For
1965 example, you may end up with F</skiff/local/arm-linux>, where
1966 F</skiff/local/arm-linux/bin> holds the binaries for cross-compilation,
1967 F</skiff/local/arm-linux/include> has the headers, and
1968 F</skiff/local/arm-linux/lib> has the library files.
1969 If this is the case, and you are using a compiler that understands
1970 C<--sysroot>, like gcc or clang, you'll want to specify the
1971 C<-Dsysroot> option for Configure:
1972
1973     -Dsysroot=/skiff/local/arm-linux
1974
1975 However, if your don't have a suitable directory to pass to C<-Dsysroot>,
1976 you will also need to specify which target environment to use:
1977
1978     -Dusrinc=/skiff/local/arm-linux/include
1979     -Dincpth=/skiff/local/arm-linux/include
1980     -Dlibpth=/skiff/local/arm-linux/lib
1981
1982 In addition to the default execution/transfer methods you can also
1983 choose B<rsh> for execution, and B<rcp> or B<cp> for transfer,
1984 for example:
1985
1986     -Dtargetrun=rsh -Dtargetto=rcp -Dtargetfrom=cp
1987
1988 Putting it all together:
1989
1990     sh ./Configure -des -Dusecrosscompile \
1991         -Dtargethost=so.me.ho.st \
1992         -Dtargetdir=/tar/get/dir \
1993         -Dtargetuser=root \
1994         -Dtargetarch=arm-linux \
1995         -Dcc=arm-linux-gcc \
1996         -Dsysroot=/skiff/local/arm-linux \
1997         -D...
1998
1999 or if you are happy with the defaults:
2000
2001     sh ./Configure -des -Dusecrosscompile \
2002         -Dtargethost=so.me.ho.st \
2003         -Dcc=arm-linux-gcc \
2004         -D...
2005
2006 Another example where the cross-compiler has been installed under
2007 F</usr/local/arm/2.95.5>:
2008
2009     sh ./Configure -des -Dusecrosscompile \
2010         -Dtargethost=so.me.ho.st \
2011         -Dcc=/usr/local/arm/2.95.5/bin/arm-linux-gcc \
2012         -Dsysroot=/usr/local/arm/2.95.5
2013
2014 There is also a C<targetenv> option for Configure which can be used
2015 to modify the environment of the target just before testing begins
2016 during 'make test'.  For example, if the target system has a nonstandard
2017 /tmp location, you could do this:
2018
2019     -Dtargetenv="export TMPDIR=/other/tmp;"
2020
2021 If you are planning on cross-compiling to several platforms, or some
2022 other thing that would involve running Configure several times, there are
2023 two options that can be used to speed things up considerably.
2024 As a bit of background, when you
2025 call Configure with C<-Dusecrosscompile>, it begins by actually partially
2026 building a miniperl on the host machine, as well as the generate_uudmap
2027 binary, and we end up using that during the build.
2028 So instead of building that new perl every single time, you can build it
2029 just once in a separate directory, and then pass the resulting binaries
2030 to Configure like this:
2031
2032     -Dhostperl=/path/to/second/build/dir/miniperl
2033     -Dhostgenerate=/path/to/second/build/dir/generate_uudmap
2034
2035 Much less commonly, if you are cross-compiling from an ASCII host to an
2036 EBCDIC target, or vise versa, you'll have to pass C<-Uhostgenerate> to
2037 Configure, to signify that you want to build a generate_uudmap binary
2038 that, during make, will be run on the target system.
2039
2040 =head1 make test
2041
2042 This will run the regression tests on the perl you just made.  If
2043 'make test' doesn't say "All tests successful" then something went
2044 wrong.
2045
2046 Note that you can't run the tests in background if this disables
2047 opening of /dev/tty. You can use 'make test-notty' in that case but
2048 a few tty tests will be skipped.
2049
2050 =head2 What if make test doesn't work?
2051
2052 If make test bombs out, just cd to the t directory and run ./TEST
2053 by hand to see if it makes any difference.
2054
2055 One way to get more detailed information about failed tests and
2056 individual subtests is to run the harness from the t directory:
2057
2058         cd t ; ./perl harness <list of tests>
2059
2060 (this assumes that most basic tests succeed, since harness uses
2061 complicated constructs). If no list of tests is provided, harness
2062 will run all tests.
2063
2064 If individual tests fail, you can often run them by hand (from the main
2065 perl directory), e.g.,
2066
2067         ./perl -MTestInit t/op/groups.t
2068
2069 You should also read the individual tests to see if there are any helpful
2070 comments that apply to your system.  You may also need to setup your
2071 shared library path if you get errors like:
2072
2073         /sbin/loader: Fatal Error: cannot map libperl.so
2074
2075 The file t/README in the t subdirectory contains more information about
2076 running and modifying tests.
2077
2078 See L</"Building a shared Perl library"> earlier in this document.
2079
2080 =over 4
2081
2082 =item locale
2083
2084 Note:  One possible reason for errors is that some external programs
2085 may be broken due to the combination of your environment and the way
2086 'make test' exercises them.  For example, this may happen if you have
2087 one or more of these environment variables set:  LC_ALL LC_CTYPE
2088 LC_COLLATE LANG.  In some versions of UNIX, the non-English locales
2089 are known to cause programs to exhibit mysterious errors.
2090
2091 If you have any of the above environment variables set, please try
2092
2093         setenv LC_ALL C
2094
2095 (for C shell) or
2096
2097         LC_ALL=C;export LC_ALL
2098
2099 for Bourne or Korn shell) from the command line and then retry
2100 make test.  If the tests then succeed, you may have a broken program that
2101 is confusing the testing.  Please run the troublesome test by hand as
2102 shown above and see whether you can locate the program.  Look for
2103 things like:  exec, `backquoted command`, system, open("|...") or
2104 open("...|").  All these mean that Perl is trying to run some
2105 external program.
2106
2107 =item Timing problems
2108
2109 Several tests in the test suite check timing functions, such as
2110 sleep(), and see if they return in a reasonable amount of time.
2111 If your system is quite busy and doesn't respond quickly enough,
2112 these tests might fail.  If possible, try running the tests again
2113 with the system under a lighter load.  These timing-sensitive
2114 and load-sensitive tests include F<t/op/alarm.t>,
2115 F<dist/Time-HiRes/t/alarm.t>, F<dist/Time-HiRes/t/clock.t>,
2116 F<dist/Time-HiRes/t/itimer.t>, F<dist/Time-HiRes/t/usleep.t>,
2117 F<dist/threads-shared/t/waithires.t>,
2118 F<dist/threads-shared/t/stress.t>, F<lib/Benchmark.t>,
2119 F<lib/Memoize/t/expmod_t.t>, and F<lib/Memoize/t/speed.t>.
2120
2121 You might also experience some failures in F<t/op/stat.t> if you build
2122 perl on an NFS filesystem, if the remote clock and the system clock are
2123 different.
2124
2125 =item Out of memory
2126
2127 On some systems, particularly those with smaller amounts of RAM, some
2128 of the tests in t/op/pat.t may fail with an "Out of memory" message.
2129 For example, on my SparcStation IPC with 12 MB of RAM, in perl5.5.670,
2130 test 85 will fail if run under either t/TEST or t/harness.
2131
2132 Try stopping other jobs on the system and then running the test by itself:
2133
2134         ./perl -MTestInit t/op/pat.t
2135
2136 to see if you have any better luck.  If your perl still fails this
2137 test, it does not necessarily mean you have a broken perl.  This test
2138 tries to exercise the regular expression subsystem quite thoroughly,
2139 and may well be far more demanding than your normal usage.
2140
2141 =item libgcc_s.so.1: cannot open shared object file
2142
2143 This message has been reported on gcc-3.2.3 and earlier installed with
2144 a non-standard prefix.  Setting the LD_LIBRARY_PATH environment variable
2145 (or equivalent) to include gcc's lib/ directory with the libgcc_s.so.1
2146 shared library should fix the problem.
2147
2148 =item Failures from lib/File/Temp/t/security saying "system possibly insecure"
2149
2150 First, such warnings are not necessarily serious or indicative of a
2151 real security threat.  That being said, they bear investigating.
2152
2153 Note that each of the tests is run twice.  The first time is in the
2154 directory returned by File::Spec->tmpdir() (often /tmp on Unix
2155 systems), and the second time in the directory from which the test was
2156 run (usually the 't' directory, if the test was run as part of 'make
2157 test').
2158
2159 The tests may fail for the following reasons:
2160
2161 (1) If the directory the tests are being run in is owned by somebody
2162 other than the user running the tests, or by root (uid 0).
2163
2164 This failure can happen if the Perl source code distribution is
2165 unpacked in such a way that the user IDs in the distribution package
2166 are used as-is.  Some tar programs do this.
2167
2168 (2) If the directory the tests are being run in is writable by group or
2169 by others, and there is no sticky bit set for the directory.  (With
2170 UNIX/POSIX semantics, write access to a directory means the right to
2171 add or remove files in that directory.  The 'sticky bit' is a feature
2172 used in some UNIXes to give extra protection to files: if the bit is
2173 set for a directory, no one but the owner (or root) can remove that
2174 file even if the permissions would otherwise allow file removal by
2175 others.)
2176
2177 This failure may or may not be a real problem: it depends on the
2178 permissions policy used on this particular system.  This failure can
2179 also happen if the system either doesn't support the sticky bit (this
2180 is the case with many non-UNIX platforms: in principle File::Temp
2181 should know about these platforms and skip the tests), or if the system
2182 supports the sticky bit but for some reason or reasons it is not being
2183 used.  This is, for example, the case with HP-UX: as of HP-UX release
2184 11.00, the sticky bit is very much supported, but HP-UX doesn't use it
2185 on its /tmp directory as shipped.  Also, as with the permissions, some
2186 local policy might dictate that the stickiness is not used.
2187
2188 (3) If the system supports the POSIX 'chown giveaway' feature and if
2189 any of the parent directories of the temporary file back to the root
2190 directory are 'unsafe', using the definitions given above in (1) and
2191 (2).  For Unix systems, this is usually not an issue if you are
2192 building on a local disk.  See the documentation for the File::Temp
2193 module for more information about 'chown giveaway'.
2194
2195 See the documentation for the File::Temp module for more information
2196 about the various security aspects of temporary files.
2197
2198 =back
2199
2200 The core distribution can now run its regression tests in parallel on
2201 Unix-like platforms. Instead of running C<make test>, set C<TEST_JOBS>
2202 in your environment to the number of tests to run in parallel, and run
2203 C<make test_harness>. On a Bourne-like shell, this can be done as
2204
2205     TEST_JOBS=3 make test_harness  # Run 3 tests in parallel
2206
2207 An environment variable is used, rather than parallel make itself,
2208 because L<TAP::Harness> needs to be able to schedule individual
2209 non-conflicting test scripts itself, and there is no standard interface
2210 to C<make> utilities to interact with their job schedulers.
2211
2212 =head1 make install
2213
2214 This will put perl into the public directory you specified to
2215 Configure; by default this is /usr/local/bin.  It will also try to put
2216 the man pages in a reasonable place.  It will not nroff the man pages,
2217 however.  You may need to be root to run B<make install>.  If you are not
2218 root, you must still have permission to install into the directories
2219 in question and you should ignore any messages about chown not working.
2220
2221 If "make install" just says "'install' is up to date" or something
2222 similar, you may be on a case-insensitive filesystems such as Mac's HFS+,
2223 and you should say "make install-all".  (This confusion is brought to you
2224 by the Perl distribution having a file called INSTALL.)
2225
2226 =head2 Installing perl under different names
2227
2228 If you want to install perl under a name other than "perl" (for example,
2229 when installing perl with special features enabled, such as debugging),
2230 indicate the alternate name on the "make install" line, such as:
2231
2232     make install PERLNAME=myperl
2233
2234 You can separately change the base used for versioned names (like
2235 "perl5.8.9") by setting PERLNAME_VERBASE, like
2236
2237     make install PERLNAME=perl5 PERLNAME_VERBASE=perl
2238
2239 This can be useful if you have to install perl as "perl5" (e.g. to avoid
2240 conflicts with an ancient version in /usr/bin supplied by your vendor).
2241 Without this the versioned binary would be called "perl55.8.8".
2242
2243 =head2 Installing perl under a different directory
2244
2245 You can install perl under a different destination directory by using
2246 the DESTDIR variable during C<make install>, with a command like
2247
2248         make install DESTDIR=/tmp/perl5
2249
2250 DESTDIR is automatically prepended to all the installation paths.  See
2251 the example in L<"DESTDIR"> above.
2252
2253 =head2 Installed files
2254
2255 If you want to see exactly what will happen without installing
2256 anything, you can run
2257
2258         ./perl installperl -n
2259         ./perl installman -n
2260
2261 make install will install the following:
2262
2263     binaries
2264
2265         perl,
2266             perl5.n.n   where 5.n.n is the current release number.  This
2267                         will be a link to perl.
2268
2269     scripts
2270
2271         cppstdin        This is used by the deprecated switch perl -P,
2272                         if your cc -E can't read from stdin.
2273         corelist        Shows versions of modules that come with
2274                         different
2275                         versions of perl.
2276         cpan            The CPAN shell.
2277         enc2xs          Encoding module generator.
2278         h2ph            Extract constants and simple macros from C
2279                         headers.
2280         h2xs            Converts C .h header files to Perl extensions.
2281         instmodsh       A shell to examine installed modules.
2282         libnetcfg       Configure libnet.
2283         perlbug         Tool to report bugs in Perl.
2284         perldoc         Tool to read perl's pod documentation.
2285         perlivp         Perl Installation Verification Procedure.
2286         piconv          A Perl implementation of the encoding conversion
2287                         utility iconv.
2288         pl2pm           Convert Perl 4 .pl files to Perl 5 .pm modules.
2289         pod2html,       Converters from perl's pod documentation format
2290         pod2man,
2291         pod2text,
2292         pod2usage
2293         podchecker      POD syntax checker.
2294         podselect       Prints sections of POD documentation.
2295         prove           A command-line tool for running tests.
2296         psed            A Perl implementation of sed.
2297         ptar            A Perl implementation of tar.
2298         ptardiff        A diff for tar archives.
2299         ptargrep        A grep for tar archives.
2300         shasum          A tool to print or check SHA checksums.
2301         splain          Describe Perl warnings and errors.
2302         xsubpp          Compiler to convert Perl XS code into C code.
2303         zipdetails      display the internal structure of zip files
2304
2305     library files
2306
2307                         in $privlib and $archlib specified to
2308                         Configure, usually under /usr/local/lib/perl5/.
2309
2310     documentation
2311
2312         man pages       in $man1dir, usually /usr/local/man/man1.
2313         module man
2314         pages           in $man3dir, usually /usr/local/man/man3.
2315         pod/*.pod       in $privlib/pod/.
2316
2317 installperl will also create the directories listed above
2318 in L<"Installation Directories">.
2319
2320 Perl's *.h header files and the libperl library are also installed
2321 under $archlib so that any user may later build new modules, run the
2322 optional Perl compiler, or embed the perl interpreter into another
2323 program even if the Perl source is no longer available.
2324
2325 =head2 Installing with a version-specific suffix
2326
2327 Sometimes you only want to install the perl distribution with a
2328 version-specific suffix.  For example, you may wish to install a newer
2329 version of perl alongside an already installed production version.
2330 To only install the version-specific parts of the perl installation, run
2331
2332         Configure -Dversiononly
2333
2334 or answer 'y' to the appropriate Configure prompt.  Alternatively,
2335 you can just manually run
2336
2337         ./perl installperl -v
2338
2339 and skip installman altogether.
2340
2341 See also L<"Maintaining completely separate versions"> for another
2342 approach.
2343
2344 =head1 cd /usr/include; h2ph *.h sys/*.h
2345
2346 Some perl scripts need to be able to obtain information from the
2347 system header files.  This command will convert the most commonly used
2348 header files in /usr/include into files that can be easily interpreted
2349 by perl.  These files will be placed in the architecture-dependent
2350 library ($archlib) directory you specified to Configure.
2351
2352 Note: Due to differences in the C and perl languages, the conversion
2353 of the header files is not perfect.  You will probably have to
2354 hand-edit some of the converted files to get them to parse correctly.
2355 For example, h2ph breaks spectacularly on type casting and certain
2356 structures.
2357
2358 =head1 installhtml --help
2359
2360 Some sites may wish to make perl documentation available in HTML
2361 format.  The installhtml utility can be used to convert pod
2362 documentation into linked HTML files and install them.
2363
2364 Currently, the supplied ./installhtml script does not make use of the
2365 html Configure variables.  This should be fixed in a future release.
2366
2367 The following command-line is an example of one used to convert
2368 perl documentation:
2369
2370   ./installhtml                   \
2371       --podroot=.                 \
2372       --podpath=lib:ext:pod:vms   \
2373       --recurse                   \
2374       --htmldir=/perl/nmanual     \
2375       --htmlroot=/perl/nmanual    \
2376       --splithead=pod/perlipc     \
2377       --splititem=pod/perlfunc    \
2378       --verbose
2379
2380 See the documentation in installhtml for more details.  It can take
2381 many minutes to execute a large installation and you should expect to
2382 see warnings like "no title", "unexpected directive" and "cannot
2383 resolve" as the files are processed. We are aware of these problems
2384 (and would welcome patches for them).
2385
2386 You may find it helpful to run installhtml twice. That should reduce
2387 the number of "cannot resolve" warnings.
2388
2389 =head1 cd pod && make tex && (process the latex files)
2390
2391 Some sites may also wish to make the documentation in the pod/ directory
2392 available in TeX format.  Type
2393
2394         (cd pod && make tex && <process the latex files>)
2395
2396 =head1 Starting all over again
2397
2398 If you wish to rebuild perl from the same build directory, you should
2399 clean it out with the command
2400
2401         make distclean
2402
2403 or
2404
2405         make realclean
2406
2407 The only difference between the two is that make distclean also removes
2408 your old config.sh and Policy.sh files.  (A plain 'make clean' is now
2409 equivalent to 'make realclean'.)
2410
2411 If you are upgrading from a previous version of perl, or if you
2412 change systems or compilers or make other significant changes, or if
2413 you are experiencing difficulties building perl, you should not reuse
2414 your old config.sh.
2415
2416 If your reason to reuse your old config.sh is to save your particular
2417 installation choices, then you can probably achieve the same effect by
2418 using the Policy.sh file.  See the section on L<"Site-wide Policy
2419 settings"> above.
2420
2421 =head1 Reporting Problems
2422
2423 Wherever possible please use the perlbug tool supplied with this Perl
2424 to report problems, as it automatically includes summary configuration
2425 information about your perl, which may help us track down problems far
2426 more quickly. But first you should read the advice in this file,
2427 carefully re-read the error message and check the relevant manual pages
2428 on your system, as these may help you find an immediate solution.
2429 Once you've exhausted the documentation, please report bugs to us using
2430 the 'perlbug' tool.
2431
2432 The perlbug tool is installed along with perl, so after you have
2433 completed C<make install> it should be possible to run it with plain
2434 C<perlbug>.  If the install fails, or you want to report problems with
2435 C<make test> without installing perl, then you can use C<make nok> to
2436 run perlbug to report the problem, or run it by hand from this source
2437 directory with C<./perl -Ilib utils/perlbug>
2438
2439 If the build fails too early to run perlbug uninstalled, then please
2440 B<run> the C<./myconfig> shell script, and mail its output along with
2441 an accurate description of your problem to perlbug@perl.org
2442
2443 If Configure itself fails, and does not generate a config.sh file
2444 (needed to run C<./myconfig>), then please mail perlbug@perl.org the
2445 description of how Configure fails along with details of your system
2446 -- for example the output from running C<uname -a>
2447
2448 Please try to make your message brief but clear.  Brief, clear bug
2449 reports tend to get answered more quickly.  Please don't worry if your
2450 written English is not great -- what matters is how well you describe
2451 the important technical details of the problem you have encountered,
2452 not whether your grammar and spelling is flawless.
2453
2454 Trim out unnecessary information.  Do not include large files (such as
2455 config.sh or a complete Configure or make log) unless absolutely
2456 necessary.  Do not include a complete transcript of your build
2457 session.  Just include the failing commands, the relevant error
2458 messages, and whatever preceding commands are necessary to give the
2459 appropriate context.  Plain text should usually be sufficient -- fancy
2460 attachments or encodings may actually reduce the number of people who
2461 read your message.  Your message will get relayed to over 400
2462 subscribers around the world so please try to keep it brief but clear.
2463
2464 If the bug you are reporting has security implications which make it
2465 inappropriate to send to a publicly archived mailing list, then see
2466 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
2467 for details of how to report the issue.
2468
2469 If you are unsure what makes a good bug report please read "How to
2470 report Bugs Effectively" by Simon Tatham:
2471 http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
2472
2473 =head1 Coexistence with earlier versions of perl 5
2474
2475 Perl 5.27.3 is not binary compatible with earlier versions of Perl.
2476 In other words, you will have to recompile your XS modules.
2477
2478 In general, you can usually safely upgrade from one version of Perl
2479 (e.g.  5.X.Y) to another similar minor version (e.g. 5.X.(Y+1))) without
2480 re-compiling all of your extensions.  You can also safely leave the old
2481 version around in case the new version causes you problems for some
2482 reason.
2483
2484 Usually, most extensions will probably not need to be recompiled to be
2485 used with a newer version of Perl.  Here is how it is supposed to work.
2486 (These examples assume you accept all the Configure defaults.)
2487
2488 Suppose you already have version 5.8.7 installed.  The directories
2489 searched by 5.8.7 are typically like:
2490
2491         /usr/local/lib/perl5/5.8.7/$archname
2492         /usr/local/lib/perl5/5.8.7
2493         /usr/local/lib/perl5/site_perl/5.8.7/$archname
2494         /usr/local/lib/perl5/site_perl/5.8.7
2495
2496 Now, suppose you install version 5.8.8.  The directories
2497 searched by version 5.8.8 will be:
2498
2499         /usr/local/lib/perl5/5.8.8/$archname
2500         /usr/local/lib/perl5/5.8.8
2501         /usr/local/lib/perl5/site_perl/5.8.8/$archname
2502         /usr/local/lib/perl5/site_perl/5.8.8
2503
2504         /usr/local/lib/perl5/site_perl/5.8.7/$archname
2505         /usr/local/lib/perl5/site_perl/5.8.7
2506         /usr/local/lib/perl5/site_perl/
2507
2508 Notice the last three entries -- Perl understands the default structure
2509 of the $sitelib directories and will look back in older, compatible
2510 directories.  This way, modules installed under 5.8.7 will continue
2511 to be usable by 5.8.7 but will also accessible to 5.8.8.  Further,
2512 suppose that you upgrade a module to one which requires features
2513 present only in 5.8.8.  That new module will get installed into
2514 /usr/local/lib/perl5/site_perl/5.8.8 and will be available to 5.8.8,
2515 but will not interfere with the 5.8.7 version.
2516
2517 The last entry, /usr/local/lib/perl5/site_perl/, is there so that
2518 5.6.0 and above will look for 5.004-era pure perl modules.
2519
2520 Lastly, suppose you now install 5.10.0, which is not binary compatible
2521 with 5.8.x.  The directories searched by 5.10.0 (if you don't change the
2522 Configure defaults) will be:
2523
2524         /usr/local/lib/perl5/5.10.0/$archname
2525         /usr/local/lib/perl5/5.10.0
2526         /usr/local/lib/perl5/site_perl/5.10.0/$archname
2527         /usr/local/lib/perl5/site_perl/5.10.0
2528
2529         /usr/local/lib/perl5/site_perl/5.8.8
2530
2531         /usr/local/lib/perl5/site_perl/5.8.7
2532
2533         /usr/local/lib/perl5/site_perl/
2534
2535 Note that the earlier $archname entries are now gone, but pure perl
2536 modules from earlier versions will still be found.
2537
2538 This way, you can choose to share compatible extensions, but also upgrade
2539 to a newer version of an extension that may be incompatible with earlier
2540 versions, without breaking the earlier versions' installations.
2541
2542 =head2 Maintaining completely separate versions
2543
2544 Many users prefer to keep all versions of perl in completely
2545 separate directories.  This guarantees that an update to one version
2546 won't interfere with another version.  (The defaults guarantee this for
2547 libraries after 5.6.0, but not for executables. TODO?)  One convenient
2548 way to do this is by using a separate prefix for each version, such as
2549
2550         sh Configure -Dprefix=/opt/perl5.27.3
2551
2552 and adding /opt/perl5.27.3/bin to the shell PATH variable.  Such users
2553 may also wish to add a symbolic link /usr/local/bin/perl so that
2554 scripts can still start with #!/usr/local/bin/perl.
2555
2556 Others might share a common directory for maintenance sub-versions
2557 (e.g. 5.10 for all 5.10.x versions), but change directory with
2558 each major version.
2559
2560 If you are installing a development subversion, you probably ought to
2561 seriously consider using a separate directory, since development
2562 subversions may not have all the compatibility wrinkles ironed out
2563 yet.
2564
2565 =head2 Upgrading from 5.25.12 or earlier
2566
2567 B<Perl 5.27.3 may not be binary compatible with Perl 5.25.12 or
2568 earlier Perl releases.>  Perl modules having binary parts
2569 (meaning that a C compiler is used) will have to be recompiled to be
2570 used with 5.27.3.  If you find you do need to rebuild an extension with
2571 5.27.3, you may safely do so without disturbing the older
2572 installations.  (See L<"Coexistence with earlier versions of perl 5">
2573 above.)
2574
2575 See your installed copy of the perllocal.pod file for a (possibly
2576 incomplete) list of locally installed modules.  Note that you want
2577 perllocal.pod, not perllocale.pod, for installed module information.
2578
2579 =head1 Minimizing the Perl installation
2580
2581 The following section is meant for people worrying about squeezing the
2582 Perl installation into minimal systems (for example when installing
2583 operating systems, or in really small filesystems).
2584
2585 Leaving out as many extensions as possible is an obvious way:
2586 Encode, with its big conversion tables, consumes a lot of
2587 space.  On the other hand, you cannot throw away everything.  The
2588 Fcntl module is pretty essential.  If you need to do network
2589 programming, you'll appreciate the Socket module, and so forth: it all
2590 depends on what do you need to do.
2591
2592 In the following we offer two different slimmed down installation
2593 recipes.  They are informative, not normative: the choice of files
2594 depends on what you need.
2595
2596 Firstly, the bare minimum to run this script
2597
2598   use strict;
2599   use warnings;
2600   foreach my $f (</*>) {
2601      print("$f\n");
2602   }
2603
2604 in Linux with perl-5.27.3 is as follows (under $Config{prefix}):
2605
2606   ./bin/perl
2607   ./lib/perl5/5.27.3/strict.pm
2608   ./lib/perl5/5.27.3/warnings.pm
2609   ./lib/perl5/5.27.3/i686-linux/File/Glob.pm
2610   ./lib/perl5/5.27.3/feature.pm
2611   ./lib/perl5/5.27.3/XSLoader.pm
2612   ./lib/perl5/5.27.3/i686-linux/auto/File/Glob/Glob.so
2613
2614 Secondly, for perl-5.10.1, the Debian perl-base package contains 591
2615 files, (of which 510 are for lib/unicore) totaling about 3.5MB in its
2616 i386 version.  Omitting the lib/unicore/* files for brevity, the
2617 remaining files are:
2618
2619   /usr/bin/perl
2620   /usr/bin/perl5.10.1
2621   /usr/lib/perl/5.10.1/Config.pm
2622   /usr/lib/perl/5.10.1/Config_git.pl
2623   /usr/lib/perl/5.10.1/Config_heavy.pl
2624   /usr/lib/perl/5.10.1/Cwd.pm
2625   /usr/lib/perl/5.10.1/DynaLoader.pm
2626   /usr/lib/perl/5.10.1/Errno.pm
2627   /usr/lib/perl/5.10.1/Fcntl.pm
2628   /usr/lib/perl/5.10.1/File/Glob.pm
2629   /usr/lib/perl/5.10.1/Hash/Util.pm
2630   /usr/lib/perl/5.10.1/IO.pm
2631   /usr/lib/perl/5.10.1/IO/File.pm
2632   /usr/lib/perl/5.10.1/IO/Handle.pm
2633   /usr/lib/perl/5.10.1/IO/Pipe.pm
2634   /usr/lib/perl/5.10.1/IO/Seekable.pm
2635   /usr/lib/perl/5.10.1/IO/Select.pm
2636   /usr/lib/perl/5.10.1/IO/Socket.pm
2637   /usr/lib/perl/5.10.1/IO/Socket/INET.pm
2638   /usr/lib/perl/5.10.1/IO/Socket/UNIX.pm
2639   /usr/lib/perl/5.10.1/List/Util.pm
2640   /usr/lib/perl/5.10.1/POSIX.pm
2641   /usr/lib/perl/5.10.1/Scalar/Util.pm
2642   /usr/lib/perl/5.10.1/Socket.pm
2643   /usr/lib/perl/5.10.1/XSLoader.pm
2644   /usr/lib/perl/5.10.1/auto/Cwd/Cwd.so
2645   /usr/lib/perl/5.10.1/auto/DynaLoader/autosplit.ix
2646   /usr/lib/perl/5.10.1/auto/DynaLoader/dl_expandspec.al
2647   /usr/lib/perl/5.10.1/auto/DynaLoader/dl_find_symbol_anywhere.al
2648   /usr/lib/perl/5.10.1/auto/DynaLoader/dl_findfile.al
2649   /usr/lib/perl/5.10.1/auto/Fcntl/Fcntl.so
2650   /usr/lib/perl/5.10.1/auto/File/Glob/Glob.so
2651   /usr/lib/perl/5.10.1/auto/Hash/Util/Util.so
2652   /usr/lib/perl/5.10.1/auto/IO/IO.so
2653   /usr/lib/perl/5.10.1/auto/List/Util/Util.so
2654   /usr/lib/perl/5.10.1/auto/POSIX/POSIX.so
2655   /usr/lib/perl/5.10.1/auto/POSIX/autosplit.ix
2656   /usr/lib/perl/5.10.1/auto/POSIX/load_imports.al
2657   /usr/lib/perl/5.10.1/auto/Socket/Socket.so
2658   /usr/lib/perl/5.10.1/lib.pm
2659   /usr/lib/perl/5.10.1/re.pm
2660   /usr/share/doc/perl/AUTHORS.gz
2661   /usr/share/doc/perl/Documentation
2662   /usr/share/doc/perl/README.Debian
2663   /usr/share/doc/perl/changelog.Debian.gz
2664   /usr/share/doc/perl/copyright
2665   /usr/share/lintian/overrides/perl-base
2666   /usr/share/man/man1/perl.1.gz
2667   /usr/share/man/man1/perl5.10.1.1.gz
2668   /usr/share/perl/5.10.1/AutoLoader.pm
2669   /usr/share/perl/5.10.1/Carp.pm
2670   /usr/share/perl/5.10.1/Carp/Heavy.pm
2671   /usr/share/perl/5.10.1/Exporter.pm
2672   /usr/share/perl/5.10.1/Exporter/Heavy.pm
2673   /usr/share/perl/5.10.1/File/Spec.pm
2674   /usr/share/perl/5.10.1/File/Spec/Unix.pm
2675   /usr/share/perl/5.10.1/FileHandle.pm
2676   /usr/share/perl/5.10.1/Getopt/Long.pm
2677   /usr/share/perl/5.10.1/IPC/Open2.pm
2678   /usr/share/perl/5.10.1/IPC/Open3.pm
2679   /usr/share/perl/5.10.1/SelectSaver.pm
2680   /usr/share/perl/5.10.1/Symbol.pm
2681   /usr/share/perl/5.10.1/Text/ParseWords.pm
2682   /usr/share/perl/5.10.1/Text/Tabs.pm
2683   /usr/share/perl/5.10.1/Text/Wrap.pm
2684   /usr/share/perl/5.10.1/Tie/Hash.pm
2685   /usr/share/perl/5.10.1/attributes.pm
2686   /usr/share/perl/5.10.1/base.pm
2687   /usr/share/perl/5.10.1/bytes.pm
2688   /usr/share/perl/5.10.1/bytes_heavy.pl
2689   /usr/share/perl/5.10.1/constant.pm
2690   /usr/share/perl/5.10.1/fields.pm
2691   /usr/share/perl/5.10.1/integer.pm
2692   /usr/share/perl/5.10.1/locale.pm
2693   /usr/share/perl/5.10.1/overload.pm
2694   /usr/share/perl/5.10.1/strict.pm
2695   /usr/share/perl/5.10.1/unicore/*
2696   /usr/share/perl/5.10.1/utf8.pm
2697   /usr/share/perl/5.10.1/utf8_heavy.pl
2698   /usr/share/perl/5.10.1/vars.pm
2699   /usr/share/perl/5.10.1/warnings.pm
2700   /usr/share/perl/5.10.1/warnings/register.pm
2701
2702 A nice trick to find out the minimal set of Perl library files you will
2703 need to run a Perl program is
2704
2705    perl -e 'do "prog.pl"; END { print "$_\n" for sort keys %INC }'
2706
2707 (this will not find libraries required in runtime, unfortunately, but
2708 it's a minimal set) and if you want to find out all the files you can
2709 use something like the below
2710
2711  strace perl -le 'do "x.pl"' 2>&1 \
2712                              | perl -nle '/^open\(\"(.+?)"/ && print $1'
2713
2714 (The 'strace' is Linux-specific, other similar utilities include 'truss'
2715 and 'ktrace'.)
2716
2717 =head2 C<-DNO_MATHOMS>
2718
2719 If you configure perl with C<-Accflags=-DNO_MATHOMS>, the functions from
2720 F<mathoms.c> will not be compiled in. Those functions are no longer used
2721 by perl itself; for source compatibility reasons, though, they weren't
2722 completely removed.
2723
2724 =head1 DOCUMENTATION
2725
2726 Read the manual entries before running perl.  The main documentation
2727 is in the pod/ subdirectory and should have been installed during the
2728 build process.  Type B<man perl> to get started.  Alternatively, you
2729 can type B<perldoc perl> to use the supplied perldoc script.  This is
2730 sometimes useful for finding things in the library modules.
2731
2732 =head1 AUTHOR
2733
2734 Original author:  Andy Dougherty doughera@lafayette.edu , borrowing very
2735 heavily from the original README by Larry Wall, with lots of helpful
2736 feedback and additions from the perl5-porters@perl.org folks.
2737
2738 If you have problems, corrections, or questions, please see
2739 L<"Reporting Problems"> above.
2740
2741 =head1 REDISTRIBUTION
2742
2743 This document is part of the Perl package and may be distributed under
2744 the same terms as perl itself, with the following additional request:
2745 If you are distributing a modified version of perl (perhaps as part of
2746 a larger package) please B<do> modify these installation instructions
2747 and the contact information to match your distribution.