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