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