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