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