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