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