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