Re: [MacOS X] consider useshrplib='false' by default
[perl.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 =head2 Site-wide Policy settings
654
655 After Configure runs, it stores a number of common site-wide "policy"
656 answers (such as installation directories and the local perl contact
657 person) in the Policy.sh file.  If you want to build perl on another
658 system using the same policy defaults, simply copy the Policy.sh file
659 to the new system and Configure will use it along with the appropriate
660 hint file for your system.
661
662 Alternatively, if you wish to change some or all of those policy
663 answers, you should
664
665         rm -f Policy.sh
666
667 to ensure that Configure doesn't re-use them.
668
669 Further information is in the Policy_sh.SH file itself.
670
671 If the generated Policy.sh file is unsuitable, you may freely edit it
672 to contain any valid shell commands.  It will be run just after the
673 platform-specific hints files.
674
675 =head2 Configure-time Options
676
677 There are several different ways to Configure and build perl for your
678 system.  For most users, the defaults are sensible and will work.
679 Some users, however, may wish to further customize perl.  Here are
680 some of the main things you can change.
681
682 =head2 Threads
683
684 On some platforms, perl can be compiled with
685 support for threads.  To enable this, run
686
687         sh Configure -Dusethreads
688
689 Currently, you need to specify -Dusethreads on the Configure command
690 line so that the hint files can make appropriate adjustments.
691
692 The default is to compile without thread support.
693
694 Perl has two different internal threads implementations.  The current
695 model (available internally since 5.6, and as a user-level module
696 since 5.8) is called interpreter-based implementation (ithreads),
697 with one interpreter per thread, and explicit sharing of data.
698
699 The 5.005 version (5005threads) is considered obsolete, buggy, and
700 unmaintained.
701
702 By default, Configure selects ithreads if -Dusethreads is specified.
703
704 (You need to also use the PerlIO layer, explained later, if you decide
705 to use ithreads, to guarantee the good interworking of threads and I/O.)
706
707 However, if you wish, you can select the unsupported old 5005threads behavior
708
709         sh Configure -Dusethreads -Duse5005threads
710
711 If you decide to use ithreads, the 'threads' module allows their use,
712 and the 'Thread' module offers an interface to both 5005threads and
713 ithreads (whichever has been configured).
714
715 When building threaded for certain library calls like the getgr*() and
716 the getpw*() there is a dynamically sized result buffer: the buffer
717 starts small but Perl will keep growing the buffer until the result fits.
718 To get a fixed upper limit you will have to recompile Perl with
719 PERL_REENTRANT_MAXSIZE defined to be the number of bytes you want.
720 One way to do this is to run Configure with
721 C<-Accflags=-DPERL_REENTRANT_MAXSIZE=65536>
722
723 =head2 Large file support.
724
725 Since Perl 5.6.0, Perl has supported large files (files larger than
726 2 gigabytes), and in many common platforms like Linux or Solaris this
727 support is on by default.
728
729 This is both good and bad. It is good in that you can use large files,
730 seek(), stat(), and -s them.  It is bad in that if you are interfacing Perl
731 using some extension, the components you are connecting to must also
732 be large file aware: if Perl thinks files can be large but the other
733 parts of the software puzzle do not understand the concept, bad things
734 will happen.  One popular extension suffering from this ailment is the
735 Apache extension mod_perl.
736
737 There's also one known limitation with the current large files
738 implementation: unless you also have 64-bit integers (see the next
739 section), you cannot use the printf/sprintf non-decimal integer
740 formats like C<%x> to print filesizes.  You can use C<%d>, though.
741
742 =head2 64 bit support.
743
744 If your platform does not have 64 bits natively, but can simulate them
745 with compiler flags and/or C<long long> or C<int64_t>, you can build a
746 perl that uses 64 bits.
747
748 There are actually two modes of 64-bitness: the first one is achieved
749 using Configure -Duse64bitint and the second one using Configure
750 -Duse64bitall.  The difference is that the first one is minimal and
751 the second one maximal.  The first works in more places than the second.
752
753 The C<use64bitint> does only as much as is required to get 64-bit
754 integers into Perl (this may mean, for example, using "long longs")
755 while your memory may still be limited to 2 gigabytes (because your
756 pointers could still be 32-bit).  Note that the name C<64bitint> does
757 not imply that your C compiler will be using 64-bit C<int>s (it might,
758 but it doesn't have to): the C<use64bitint> means that you will be
759 able to have 64 bits wide scalar values.
760
761 The C<use64bitall> goes all the way by attempting to switch also
762 integers (if it can), longs (and pointers) to being 64-bit.  This may
763 create an even more binary incompatible Perl than -Duse64bitint: the
764 resulting executable may not run at all in a 32-bit box, or you may
765 have to reboot/reconfigure/rebuild your operating system to be 64-bit
766 aware.
767
768 Natively 64-bit systems like Alpha and Cray need neither -Duse64bitint
769 nor -Duse64bitall.
770
771     NOTE: 64-bit support is still experimental on most platforms.
772     Existing support only covers the LP64 data model.  In particular, the
773     LLP64 data model is not yet supported.  64-bit libraries and system
774     APIs on many platforms have not stabilized--your mileage may vary.
775
776 =head2 Long doubles
777
778 In some systems you may be able to use long doubles to enhance the
779 range and precision of your double precision floating point numbers
780 (that is, Perl's numbers).  Use Configure -Duselongdouble to enable
781 this support (if it is available).
782
783 =head2 "more bits"
784
785 You can "Configure -Dusemorebits" to turn on both the 64-bit support
786 and the long double support.
787
788 =head2 Selecting File IO mechanisms
789
790 Executive summary: in Perl 5.8, you should use the default "PerlIO"
791 as the IO mechanism unless you have a good reason not to.
792
793 In more detail: previous versions of perl used the standard IO
794 mechanisms as defined in stdio.h.  Versions 5.003_02 and later of perl
795 introduced alternate IO mechanisms via a "PerlIO" abstraction, but up
796 until and including Perl 5.6, the stdio mechanism was still the default
797 and the only supported mechanism.
798
799 Starting from Perl 5.8, the default mechanism is to use the PerlIO
800 abstraction, because it allows better control of I/O mechanisms,
801 instead of having to work with (often, work around) vendors' I/O
802 implementations.
803
804 This PerlIO abstraction can be (but again, unless you know what you
805 are doing, should not be) disabled either on the Configure command
806 line with
807
808         sh Configure -Uuseperlio
809
810 or interactively at the appropriate Configure prompt.
811
812 With the PerlIO abstraction layer, there is another possibility for
813 the underlying IO calls, AT&T's "sfio".  This has superior performance
814 to stdio.h in many cases, and is extensible by the use of "discipline"
815 modules ("Native" PerlIO has them too).  Sfio currently only builds on
816 a subset of the UNIX platforms perl supports.  Because the data
817 structures are completely different from stdio, perl extension modules
818 or external libraries may not work.  This configuration exists to
819 allow these issues to be worked on.
820
821 This option requires the 'sfio' package to have been built and installed.
822 The latest sfio is available from http://www.research.att.com/sw/tools/sfio/
823
824 You select this option by
825
826         sh Configure -Duseperlio -Dusesfio
827
828 If you have already selected -Duseperlio, and if Configure detects
829 that you have sfio, then sfio will be the default suggested by
830 Configure.
831
832 Note:  On some systems, sfio's iffe configuration script fails to
833 detect that you have an atexit function (or equivalent).  Apparently,
834 this is a problem at least for some versions of Linux and SunOS 4.
835 Configure should detect this problem and warn you about problems with
836 _exit vs. exit.  If you have this problem, the fix is to go back to
837 your sfio sources and correct iffe's guess about atexit.
838
839 =head2 SOCKS
840
841 Perl can be configured to be 'socksified', that is, to use the SOCKS
842 TCP/IP proxy protocol library.  SOCKS is used to give applications
843 access to transport layer network proxies.  Perl supports only SOCKS
844 Version 5.  You can find more about SOCKS from http://www.socks.nec.com/
845
846 =head2 Dynamic Loading
847
848 By default, Configure will compile perl to use dynamic loading if
849 your system supports it.  If you want to force perl to be compiled
850 statically, you can either choose this when Configure prompts you or
851 you can use the Configure command line option -Uusedl.
852
853 =head2 Building a shared Perl library
854
855 Currently, for most systems, the main perl executable is built by
856 linking the "perl library" libperl.a with perlmain.o, your static
857 extensions (usually just DynaLoader.a) and various extra libraries,
858 such as -lm.
859
860 On some systems that support dynamic loading, it may be possible to
861 replace libperl.a with a shared libperl.so.  If you anticipate building
862 several different perl binaries (e.g. by embedding libperl into
863 different programs, or by using the optional compiler extension), then
864 you might wish to build a shared libperl.so so that all your binaries
865 can share the same library.
866
867 The disadvantages are that there may be a significant performance
868 penalty associated with the shared libperl.so, and that the overall
869 mechanism is still rather fragile with respect to different versions
870 and upgrades.
871
872 In terms of performance, on my test system (Solaris 2.5_x86) the perl
873 test suite took roughly 15% longer to run with the shared libperl.so.
874 Your system and typical applications may well give quite different
875 results.
876
877 The default name for the shared library is typically something like
878 libperl.so.3.2 (for Perl 5.003_02) or libperl.so.302 or simply
879 libperl.so.  Configure tries to guess a sensible naming convention
880 based on your C library name.  Since the library gets installed in a
881 version-specific architecture-dependent directory, the exact name
882 isn't very important anyway, as long as your linker is happy.
883
884 For some systems (mostly SVR4), building a shared libperl is required
885 for dynamic loading to work, and hence is already the default.
886
887 You can elect to build a shared libperl by
888
889         sh Configure -Duseshrplib
890
891 To build a shared libperl, the environment variable controlling shared
892 library search (LD_LIBRARY_PATH in most systems, DYLD_LIBRARY_PATH for
893 NeXTSTEP/OPENSTEP/Darwin, LIBRARY_PATH for BeOS, LD_LIBRARY_PATH/SHLIB_PATH
894 for HP-UX, LIBPATH for AIX, PATH for Cygwin) must be set up to include
895 the Perl build directory because that's where the shared libperl will
896 be created.  Configure arranges makefile to have the correct shared
897 library search settings.  You can find the name of the environment
898 variable Perl thinks works in your your system by
899
900         grep ldlibpthname config.sh
901
902 However, there are some special cases where manually setting the
903 shared library path might be required.  For example, if you want to run
904 something like the following with the newly-built but not-yet-installed
905 ./perl:
906
907         cd t; ./perl misc/failing_test.t
908 or
909         ./perl -Ilib ~/my_mission_critical_test
910
911 then you need to set up the shared library path explicitly.
912 You can do this with
913
914    LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
915
916 for Bourne-style shells, or
917
918    setenv LD_LIBRARY_PATH `pwd`
919
920 for Csh-style shells.  (This procedure may also be needed if for some
921 unexpected reason Configure fails to set up makefile correctly.) (And
922 again, it may be something other than LD_LIBRARY_PATH for you, see above.)
923
924 You can often recognize failures to build/use a shared libperl from error
925 messages complaining about a missing libperl.so (or libperl.sl in HP-UX),
926 for example:
927 18126:./miniperl: /sbin/loader: Fatal Error: cannot map libperl.so
928
929 There is also an potential problem with the shared perl library if you
930 want to have more than one "flavor" of the same version of perl (e.g.
931 with and without -DDEBUGGING).  For example, suppose you build and
932 install a standard Perl 5.8.0 with a shared library.  Then, suppose you
933 try to build Perl 5.8.0 with -DDEBUGGING enabled, but everything else
934 the same, including all the installation directories.  How can you
935 ensure that your newly built perl will link with your newly built
936 libperl.so.8 rather with the installed libperl.so.8?  The answer is
937 that you might not be able to.  The installation directory is encoded
938 in the perl binary with the LD_RUN_PATH environment variable (or
939 equivalent ld command-line option).  On Solaris, you can override that
940 with LD_LIBRARY_PATH; on Linux, you can only override at runtime via
941 LD_PRELOAD, specifying the exact filename you wish to be used; and on
942 Digital Unix, you can override LD_LIBRARY_PATH by setting the
943 _RLD_ROOT environment variable to point to the perl build directory.
944
945 The only reliable answer is that you should specify a different
946 directory for the architecture-dependent library for your -DDEBUGGING
947 version of perl.  You can do this by changing all the *archlib*
948 variables in config.sh to point to your new architecture-dependent library.
949
950 =head2 Malloc Issues
951
952 Perl relies heavily on malloc(3) to grow data structures as needed,
953 so perl's performance can be noticeably affected by the performance of
954 the malloc function on your system.  The perl source is shipped with a
955 version of malloc that has been optimized for the typical requests from
956 perl, so there's a chance that it may be both faster and use less memory
957 than your system malloc.
958
959 However, if your system already has an excellent malloc, or if you are
960 experiencing difficulties with extensions that use third-party libraries
961 that call malloc, then you should probably use your system's malloc.
962 (Or, you might wish to explore the malloc flags discussed below.)
963
964 =over 4
965
966 =item Using the system malloc
967
968 To build without perl's malloc, you can use the Configure command
969
970         sh Configure -Uusemymalloc
971
972 or you can answer 'n' at the appropriate interactive Configure prompt.
973
974 =item -DPERL_POLLUTE_MALLOC
975
976 NOTE: This flag is enabled automatically on some platforms if you just
977 run Configure to accept all the defaults on those platforms.
978
979 Perl's malloc family of functions are normally called Perl_malloc(),
980 Perl_realloc(), Perl_calloc() and Perl_mfree().
981 These names do not clash with the system versions of these functions.
982
983 If this flag is enabled, however, Perl's malloc family of functions
984 will have the same names as the system versions.  This may be required
985 sometimes if you have libraries that like to free() data that may have
986 been allocated by Perl_malloc() and vice versa.
987
988 Note that enabling this option may sometimes lead to duplicate symbols
989 from the linker for malloc et al.  In such cases, the system probably
990 does not allow its malloc functions to be fully replaced with custom
991 versions.
992
993 =item -DPERL_DEBUGGING_MSTATS
994
995 This flag enables debugging mstats, which is required to use the
996 Devel::Peek::mstat() function. You cannot enable this unless you are
997 using Perl's malloc, so a typical Configure command would be
998
999        sh Configure -DPERL_DEBUGGING_MSTATS -Dusemymalloc='y'
1000
1001 to enable this option.
1002
1003 =back
1004
1005 =head2 Building a debugging perl
1006
1007 You can run perl scripts under the perl debugger at any time with
1008 B<perl -d your_script>.  If, however, you want to debug perl itself,
1009 you probably want to do
1010
1011         sh Configure -Doptimize='-g'
1012
1013 This will do two independent things:  First, it will force compilation
1014 to use cc -g so that you can use your system's debugger on the
1015 executable.  (Note:  Your system may actually require something like
1016 cc -g2.  Check your man pages for cc(1) and also any hint file for
1017 your system.)  Second, it will add -DDEBUGGING to your ccflags
1018 variable in config.sh so that you can use B<perl -D> to access perl's
1019 internal state.  (Note: Configure will only add -DDEBUGGING by default
1020 if you are not reusing your old config.sh.  If you want to reuse your
1021 old config.sh, then you can just edit it and change the optimize and
1022 ccflags variables by hand and then propagate your changes as shown in
1023 L<"Propagating your changes to config.sh"> below.)
1024
1025 You can actually specify -g and -DDEBUGGING independently, but usually
1026 it's convenient to have both.
1027
1028 If you are using a shared libperl, see the warnings about multiple
1029 versions of perl under L<Building a shared libperl.so Perl library>.
1030
1031 =head2 Extensions
1032
1033 Perl ships with a number of standard extensions.  These are contained
1034 in the ext/ subdirectory.
1035
1036 By default, Configure will offer to build every extension which appears
1037 to be supported.  For example, Configure will offer to build GDBM_File
1038 only if it is able to find the gdbm library.  (See examples below.)
1039 Configure does not contain code to test for POSIX compliance, so POSIX
1040 is always built by default as well.  If you wish to skip POSIX, you can
1041 set the Configure variable useposix=false either in a hint file or from
1042 the Configure command line.
1043
1044 If you unpack any additional extensions in the ext/ directory before
1045 running Configure, then Configure will offer to build those additional
1046 extensions as well.  Most users probably shouldn't have to do this --
1047 it is usually easier to build additional extensions later after perl
1048 has been installed.  However, if you wish to have those additional
1049 extensions statically linked into the perl binary, then this offers a
1050 convenient way to do that in one step.  (It is not necessary, however;
1051 you can build and install extensions just fine even if you don't have
1052 dynamic loading.  See lib/ExtUtils/MakeMaker.pm for more details.)
1053
1054 You can learn more about each of the supplied extensions by consulting the
1055 documentation in the individual .pm modules, located under the
1056 ext/ subdirectory.
1057
1058 Even if you do not have dynamic loading, you must still build the
1059 DynaLoader extension; you should just build the stub dl_none.xs
1060 version.  (Configure will suggest this as the default.)
1061
1062 To disable certain extensions so that they are not built, use
1063 the -Dnoextensions=... and -Donlyextensions=... options.  They both
1064 accept a space-separated list of extensions.  The extensions listed
1065 in C<noextensions> are removed from the list of extensions to build,
1066 while the C<onlyextensions> is rather more severe and builds only
1067 the listed extensions.  The latter should be used with extreme caution
1068 since certain extensions are used by many other extensions and modules:
1069 such modules include Fcntl and IO.  The order of processing these
1070 options is first C<only> (if present), then C<no> (if present).
1071
1072 Another, older way to turn off various extensions (which is still good
1073 to know if you have to work with older Perl) exists.  Here are the
1074 Configure command-line variables you can set to turn off various
1075 extensions.  All others are included by default.
1076
1077     DB_File             i_db
1078     DynaLoader          (Must always be included as a static extension)
1079     GDBM_File           i_gdbm
1080     NDBM_File           i_ndbm
1081     ODBM_File           i_dbm
1082     POSIX               useposix
1083     Opcode              useopcode
1084     Socket              d_socket
1085     Threads             use5005threads
1086
1087 Thus to skip the NDBM_File extension, you can use
1088
1089         sh Configure -Ui_ndbm
1090
1091 Again, this is taken care of automatically if you don't have the ndbm
1092 library.
1093
1094 Of course, you may always run Configure interactively and select only
1095 the extensions you want.
1096
1097 Note:  The DB_File module will only work with version 1.x of Berkeley
1098 DB or newer releases of version 2.  Configure will automatically detect
1099 this for you and refuse to try to build DB_File with earlier
1100 releases of version 2.
1101
1102 If you re-use your old config.sh but change your system (e.g. by
1103 adding libgdbm) Configure will still offer your old choices of extensions
1104 for the default answer, but it will also point out the discrepancy to
1105 you.
1106
1107 Finally, if you have dynamic loading (most modern systems do)
1108 remember that these extensions do not increase the size of your perl
1109 executable, nor do they impact start-up time, so you probably might as
1110 well build all the ones that will work on your system.
1111
1112 =head2 Including locally-installed libraries
1113
1114 Perl5 comes with interfaces to number of database extensions, including
1115 dbm, ndbm, gdbm, and Berkeley db.  For each extension, if
1116 Configure can find the appropriate header files and libraries, it will
1117 automatically include that extension.  The gdbm and db libraries
1118 are not included with perl.  See the library documentation for
1119 how to obtain the libraries.
1120
1121 If your database header (.h) files are not in a directory normally
1122 searched by your C compiler, then you will need to include the
1123 appropriate -I/your/directory option when prompted by Configure.  If
1124 your database library (.a) files are not in a directory normally
1125 searched by your C compiler and linker, then you will need to include
1126 the appropriate -L/your/directory option when prompted by Configure.
1127 See the examples below.
1128
1129 =head2 Examples
1130
1131 =over 4
1132
1133 =item gdbm in /usr/local
1134
1135 Suppose you have gdbm and want Configure to find it and build the
1136 GDBM_File extension.  This example assumes you have gdbm.h
1137 installed in /usr/local/include/gdbm.h and libgdbm.a installed in
1138 /usr/local/lib/libgdbm.a.  Configure should figure all the
1139 necessary steps out automatically.
1140
1141 Specifically, when Configure prompts you for flags for
1142 your C compiler, you should include  -I/usr/local/include.
1143
1144 When Configure prompts you for linker flags, you should include
1145 -L/usr/local/lib.
1146
1147 If you are using dynamic loading, then when Configure prompts you for
1148 linker flags for dynamic loading, you should again include
1149 -L/usr/local/lib.
1150
1151 Again, this should all happen automatically.  This should also work if
1152 you have gdbm installed in any of (/usr/local, /opt/local, /usr/gnu,
1153 /opt/gnu, /usr/GNU, or /opt/GNU).
1154
1155 =item gdbm in /usr/you
1156
1157 Suppose you have gdbm installed in some place other than /usr/local/,
1158 but you still want Configure to find it.  To be specific, assume you
1159 have /usr/you/include/gdbm.h and /usr/you/lib/libgdbm.a.  You
1160 still have to add -I/usr/you/include to cc flags, but you have to take
1161 an extra step to help Configure find libgdbm.a.  Specifically, when
1162 Configure prompts you for library directories, you have to add
1163 /usr/you/lib to the list.
1164
1165 It is possible to specify this from the command line too (all on one
1166 line):
1167
1168         sh Configure -de \
1169                 -Dlocincpth="/usr/you/include" \
1170                 -Dloclibpth="/usr/you/lib"
1171
1172 locincpth is a space-separated list of include directories to search.
1173 Configure will automatically add the appropriate -I directives.
1174
1175 loclibpth is a space-separated list of library directories to search.
1176 Configure will automatically add the appropriate -L directives.  If
1177 you have some libraries under /usr/local/ and others under
1178 /usr/you, then you have to include both, namely
1179
1180         sh Configure -de \
1181                 -Dlocincpth="/usr/you/include /usr/local/include" \
1182                 -Dloclibpth="/usr/you/lib /usr/local/lib"
1183
1184 =back
1185
1186 =head2 Building DB, NDBM, and ODBM interfaces with Berkeley DB 3
1187
1188 Perl interface for DB3 is part of Berkeley DB, but if you want to
1189 compile standard Perl DB/ODBM/NDBM interfaces, you must follow
1190 following instructions.
1191
1192 Berkeley DB3 from Sleepycat Software is by default installed without
1193 DB1 compatibility code (needed for DB_File interface) and without
1194 links to compatibility files. So if you want to use packages written
1195 for DB/ODBM/NDBM interfaces, you need to configure DB3 with
1196 --enable-compat185 (and optionally with --enable-dump185) and create
1197 additional references (suppose you are installing DB3 with
1198 --prefix=/usr):
1199
1200     ln -s libdb-3.so /usr/lib/libdbm.so
1201     ln -s libdb-3.so /usr/lib/libndbm.so
1202     echo '#define DB_DBM_HSEARCH 1' >dbm.h 
1203     echo '#include <db.h>' >>dbm.h
1204     install -m 0644 dbm.h /usr/include/dbm.h 
1205     install -m 0644 dbm.h /usr/include/ndbm.h
1206
1207 Optionally, if you have compiled with --enable-compat185 (not needed
1208 for ODBM/NDBM):
1209
1210     ln -s libdb-3.so /usr/lib/libdb1.so
1211     ln -s libdb-3.so /usr/lib/libdb.so
1212
1213 ODBM emulation seems not to be perfect, but is quite usable,
1214 using DB 3.1.17:
1215
1216     lib/odbm.............FAILED at test 9
1217         Failed 1/64 tests, 98.44% okay
1218
1219 =head2 What if it doesn't work?
1220
1221 If you run into problems, try some of the following ideas.
1222 If none of them help, then see L<"Reporting Problems"> below.
1223
1224 =over 4
1225
1226 =item Running Configure Interactively
1227
1228 If Configure runs into trouble, remember that you can always run
1229 Configure interactively so that you can check (and correct) its
1230 guesses.
1231
1232 All the installation questions have been moved to the top, so you don't
1233 have to wait for them.  Once you've handled them (and your C compiler and
1234 flags) you can type  &-d  at the next Configure prompt and Configure
1235 will use the defaults from then on.
1236
1237 If you find yourself trying obscure command line incantations and
1238 config.over tricks, I recommend you run Configure interactively
1239 instead.  You'll probably save yourself time in the long run.
1240
1241 =item Hint files
1242
1243 The perl distribution includes a number of system-specific hints files
1244 in the hints/ directory.  If one of them matches your system, Configure
1245 will offer to use that hint file.
1246
1247 Several of the hint files contain additional important information.
1248 If you have any problems, it is a good idea to read the relevant hint file
1249 for further information.  See hints/solaris_2.sh for an extensive example.
1250 More information about writing good hints is in the hints/README.hints
1251 file.
1252
1253 =item *** WHOA THERE!!! ***
1254
1255 Occasionally, Configure makes a wrong guess.  For example, on SunOS
1256 4.1.3, Configure incorrectly concludes that tzname[] is in the
1257 standard C library.  The hint file is set up to correct for this.  You
1258 will see a message:
1259
1260     *** WHOA THERE!!! ***
1261         The recommended value for $d_tzname on this machine was "undef"!
1262         Keep the recommended value? [y]
1263
1264 You should always keep the recommended value unless, after reading the
1265 relevant section of the hint file, you are sure you want to try
1266 overriding it.
1267
1268 If you are re-using an old config.sh, the word "previous" will be
1269 used instead of "recommended".  Again, you will almost always want
1270 to keep the previous value, unless you have changed something on your
1271 system.
1272
1273 For example, suppose you have added libgdbm.a to your system
1274 and you decide to reconfigure perl to use GDBM_File.  When you run
1275 Configure again, you will need to add -lgdbm to the list of libraries.
1276 Now, Configure will find your gdbm include file and library and will
1277 issue a message:
1278
1279     *** WHOA THERE!!! ***
1280         The previous value for $i_gdbm on this machine was "undef"!
1281         Keep the previous value? [y]
1282
1283 In this case, you do not want to keep the previous value, so you
1284 should answer 'n'.  (You'll also have to manually add GDBM_File to
1285 the list of dynamic extensions to build.)
1286
1287 =item Changing Compilers
1288
1289 If you change compilers or make other significant changes, you should
1290 probably not re-use your old config.sh.  Simply remove it or
1291 rename it, e.g. mv config.sh config.sh.old.  Then rerun Configure
1292 with the options you want to use.
1293
1294 This is a common source of problems.  If you change from cc to
1295 gcc, you should almost always remove your old config.sh.
1296
1297 =item Propagating your changes to config.sh
1298
1299 If you make any changes to config.sh, you should propagate
1300 them to all the .SH files by running
1301
1302         sh Configure -S
1303
1304 You will then have to rebuild by running
1305
1306         make depend
1307         make
1308
1309 =item config.over and config.arch
1310
1311 You can also supply a shell script config.over to over-ride
1312 Configure's guesses.  It will get loaded up at the very end, just
1313 before config.sh is created.  You have to be careful with this,
1314 however, as Configure does no checking that your changes make sense.
1315 This file is usually good for site-specific customizations.
1316
1317 There is also another file that, if it exists, is loaded before the
1318 config.over, called config.arch.  This file is intended to be per
1319 architecture, not per site, and usually it's the architecture-specific
1320 hints file that creates the config.arch.
1321
1322 =item config.h
1323
1324 Many of the system dependencies are contained in config.h.
1325 Configure builds config.h by running the config_h.SH script.
1326 The values for the variables are taken from config.sh.
1327
1328 If there are any problems, you can edit config.h directly.  Beware,
1329 though, that the next time you run Configure, your changes will be
1330 lost.
1331
1332 =item cflags
1333
1334 If you have any additional changes to make to the C compiler command
1335 line, they can be made in cflags.SH.  For instance, to turn off the
1336 optimizer on toke.c, find the line in the switch structure for
1337 toke.c and put the command optimize='-g' before the ;; .  You
1338 can also edit cflags directly, but beware that your changes will be
1339 lost the next time you run Configure.
1340
1341 To explore various ways of changing ccflags from within a hint file,
1342 see the file hints/README.hints.
1343
1344 To change the C flags for all the files, edit config.sh and change either
1345 $ccflags or $optimize, and then re-run
1346
1347         sh Configure -S
1348         make depend
1349
1350 =item No sh
1351
1352 If you don't have sh, you'll have to copy the sample file
1353 Porting/config.sh to config.sh and edit your config.sh to reflect your
1354 system's peculiarities.  See Porting/pumpkin.pod for more information.
1355 You'll probably also have to extensively modify the extension building
1356 mechanism.
1357
1358 =item Digital UNIX/Tru64 UNIX and BIN_SH
1359
1360 In Digital UNIX/Tru64 UNIX, Configure might abort with
1361
1362 Build a threading Perl? [n]
1363 Configure[2437]: Syntax error at line 1 : `config.sh' is not expected.
1364
1365 This indicates that Configure is being run with a broken Korn shell
1366 (even though you think you are using a Bourne shell by using
1367 "sh Configure" or "./Configure").  The Korn shell bug has been reported
1368 to Compaq as of February 1999 but in the meanwhile, the reason ksh is
1369 being used is that you have the environment variable BIN_SH set to
1370 'xpg4'.  This causes /bin/sh to delegate its duties to /bin/posix/sh
1371 (a ksh).  Unset the environment variable and rerun Configure.
1372
1373 =item HP-UX 11, pthreads, and libgdbm
1374
1375 If you are running Configure with -Dusethreads in HP-UX 11, be warned
1376 that POSIX threads and libgdbm (the GNU dbm library) compiled before
1377 HP-UX 11 do not mix.  This will cause a basic test run by Configure to
1378 fail
1379
1380 Pthread internal error: message: __libc_reinit() failed, file: ../pthreads/pthread.c, line: 1096
1381 Return Pointer is 0xc082bf33
1382 sh: 5345 Quit(coredump)
1383
1384 and Configure will give up.  The cure is to recompile and install
1385 libgdbm under HP-UX 11.
1386
1387 =item Porting information
1388
1389 Specific information for the OS/2, Plan 9, VMS and Win32 ports is in the
1390 corresponding README files and subdirectories.  Additional information,
1391 including a glossary of all those config.sh variables, is in the Porting
1392 subdirectory.  Especially Porting/Glossary should come in handy.
1393
1394 Ports for other systems may also be available.  You should check out
1395 http://www.cpan.org/ports for current information on ports to
1396 various other operating systems.
1397
1398 If you plan to port Perl to a new architecture study carefully the
1399 section titled "Philosophical Issues in Patching and Porting Perl"
1400 in the file Porting/pumpkin.pod and the file Porting/patching.pod.
1401 Study also how other non-UNIX ports have solved problems.
1402
1403 =back
1404
1405 =head1 Adding extra modules to the build
1406
1407 You can specify extra modules or module bundles to be fetched from the
1408 CPAN and installed as part of the Perl build.  Either use the -Dextras=...
1409 command line parameter to Configure, for example like this:
1410
1411         Configure -Dextras="Compress::Zlib Bundle::LWP DBI"
1412
1413 or answer first 'y' to the question 'Install any extra modules?' and
1414 then answer "Compress::Zlib Bundle::LWP DBI" to the 'Extras?' question.
1415 The module or the bundle names are as for the CPAN module 'install' command.
1416
1417 Notice that because the CPAN module will be used to fetch the extra
1418 modules, you will need access to the CPAN, either via the Internet,
1419 or via a local copy such as a CD-ROM or a local CPAN mirror.  If you
1420 do not, using the extra modules option will die horribly.
1421
1422 Also notice that you yourself are responsible for satisfying any extra
1423 dependencies such as external headers or libraries BEFORE trying the build.
1424 For example: you will need to have the zlib.h header and the libz
1425 library installed for the Compress::Zlib, or the Foo database specific
1426 headers and libraries installed for the DBD::Foo module.  The Configure
1427 process or the Perl build process will not help you with these.
1428
1429 =head1 suidperl
1430
1431 suidperl is an optional component, which is built or installed by default.
1432 From perlfaq1:
1433
1434         On some systems, setuid and setgid scripts (scripts written
1435         in the C shell, Bourne shell, or Perl, for example, with the
1436         set user or group ID permissions enabled) are insecure due to
1437         a race condition in the kernel. For those systems, Perl versions
1438         5 and 4 attempt to work around this vulnerability with an optional
1439         component, a special program named suidperl, also known as sperl.
1440         This program attempts to emulate the set-user-ID and set-group-ID
1441         features of the kernel.
1442
1443 Because of the buggy history of suidperl, and the difficulty
1444 of properly security auditing as large and complex piece of
1445 software as Perl, we cannot recommend using suidperl and the feature
1446 should be considered deprecated.
1447 Instead use for example 'sudo': http://www.courtesan.com/sudo/
1448
1449 =head1 make depend
1450
1451 This will look for all the includes.  The output is stored in makefile.
1452 The only difference between Makefile and makefile is the dependencies at
1453 the bottom of makefile.  If you have to make any changes, you should edit
1454 makefile, not Makefile since the Unix make command reads makefile first.
1455 (On non-Unix systems, the output may be stored in a different file.
1456 Check the value of $firstmakefile in your config.sh if in doubt.)
1457
1458 Configure will offer to do this step for you, so it isn't listed
1459 explicitly above.
1460
1461 =head1 make
1462
1463 This will attempt to make perl in the current directory.
1464
1465 =head2 What if it doesn't work?
1466
1467 If you can't compile successfully, try some of the following ideas.
1468 If none of them help, and careful reading of the error message and
1469 the relevant manual pages on your system doesn't help,
1470 then see L<"Reporting Problems"> below.
1471
1472 =over 4
1473
1474 =item hints
1475
1476 If you used a hint file, try reading the comments in the hint file
1477 for further tips and information.
1478
1479 =item extensions
1480
1481 If you can successfully build miniperl, but the process crashes
1482 during the building of extensions, you should run
1483
1484         make minitest
1485
1486 to test your version of miniperl.
1487
1488 =item locale
1489
1490 If you have any locale-related environment variables set, try unsetting
1491 them.  I have some reports that some versions of IRIX hang while
1492 running B<./miniperl configpm> with locales other than the C locale.
1493 See the discussion under L<"make test"> below about locales and the
1494 whole L<"Locale problems"> section in the file pod/perllocale.pod.
1495 The latter is especially useful if you see something like this
1496
1497         perl: warning: Setting locale failed.
1498         perl: warning: Please check that your locale settings:
1499                 LC_ALL = "En_US",
1500                 LANG = (unset)
1501             are supported and installed on your system.
1502         perl: warning: Falling back to the standard locale ("C").
1503
1504 at Perl startup.
1505
1506 =item varargs
1507
1508 If you get varargs problems with gcc, be sure that gcc is installed
1509 correctly and that you are not passing -I/usr/include to gcc.  When using
1510 gcc, you should probably have i_stdarg='define' and i_varargs='undef'
1511 in config.sh.  The problem is usually solved by running fixincludes
1512 correctly.  If you do change config.sh, don't forget to propagate
1513 your changes (see L<"Propagating your changes to config.sh"> below).
1514 See also the L<"vsprintf"> item below.
1515
1516 =item util.c
1517
1518 If you get error messages such as the following (the exact line
1519 numbers and function name may vary in different versions of perl):
1520
1521     util.c: In function `Perl_form':
1522     util.c:1107: number of arguments doesn't match prototype
1523     proto.h:125: prototype declaration
1524
1525 it might well be a symptom of the gcc "varargs problem".  See the
1526 previous L<"varargs"> item.
1527
1528 =item LD_LIBRARY_PATH
1529
1530 If you run into dynamic loading problems, check your setting of
1531 the LD_LIBRARY_PATH environment variable.  If you're creating a static
1532 Perl library (libperl.a rather than libperl.so) it should build
1533 fine with LD_LIBRARY_PATH unset, though that may depend on details
1534 of your local set-up.
1535
1536 =item nm extraction
1537
1538 If Configure seems to be having trouble finding library functions,
1539 try not using nm extraction.  You can do this from the command line
1540 with
1541
1542         sh Configure -Uusenm
1543
1544 or by answering the nm extraction question interactively.
1545 If you have previously run Configure, you should not reuse your old
1546 config.sh.
1547
1548 =item umask not found
1549
1550 If the build processes encounters errors relating to umask(), the problem
1551 is probably that Configure couldn't find your umask() system call.
1552 Check your config.sh.  You should have d_umask='define'.  If you don't,
1553 this is probably the L<"nm extraction"> problem discussed above.  Also,
1554 try reading the hints file for your system for further information.
1555
1556 =item vsprintf
1557
1558 If you run into problems with vsprintf in compiling util.c, the
1559 problem is probably that Configure failed to detect your system's
1560 version of vsprintf().  Check whether your system has vprintf().
1561 (Virtually all modern Unix systems do.)  Then, check the variable
1562 d_vprintf in config.sh.  If your system has vprintf, it should be:
1563
1564         d_vprintf='define'
1565
1566 If Configure guessed wrong, it is likely that Configure guessed wrong
1567 on a number of other common functions too.  This is probably
1568 the L<"nm extraction"> problem discussed above.
1569
1570 =item do_aspawn
1571
1572 If you run into problems relating to do_aspawn or do_spawn, the
1573 problem is probably that Configure failed to detect your system's
1574 fork() function.  Follow the procedure in the previous item
1575 on L<"nm extraction">.
1576
1577 =item __inet_* errors
1578
1579 If you receive unresolved symbol errors during Perl build and/or test
1580 referring to __inet_* symbols, check to see whether BIND 8.1 is
1581 installed.  It installs a /usr/local/include/arpa/inet.h that refers to
1582 these symbols.  Versions of BIND later than 8.1 do not install inet.h
1583 in that location and avoid the errors.  You should probably update to a
1584 newer version of BIND (and remove the files the old one left behind).
1585 If you can't, you can either link with the updated resolver library provided
1586 with BIND 8.1 or rename /usr/local/bin/arpa/inet.h during the Perl build and
1587 test process to avoid the problem.
1588
1589 =item *_r() prototype NOT found
1590
1591 On a related note, if you see a bunch of complaints like the above about
1592 reentrant functions - specifically networking-related ones - being present
1593 but without prototypes available, check to see if BIND 8.1 (or possibly
1594 other BIND 8 versions) is (or has been) installed. They install
1595 header files such as netdb.h into places such as /usr/local/include (or into
1596 another directory as specified at build/install time), at least optionally.
1597 Remove them or put them in someplace that isn't in the C preprocessor's 
1598 header file include search path (determined by -I options plus defaults,
1599 normally /usr/include).
1600
1601 =item #error "No DATAMODEL_NATIVE specified"
1602
1603 This is a common error when trying to build perl on Solaris 2.6 with a
1604 gcc installation from Solaris 2.5 or 2.5.1.  The Solaris header files
1605 changed, so you need to update your gcc installation.  You can either
1606 rerun the fixincludes script from gcc or take the opportunity to
1607 update your gcc installation.
1608
1609 =item Optimizer
1610
1611 If you can't compile successfully, try turning off your compiler's
1612 optimizer.  Edit config.sh and change the line
1613
1614         optimize='-O'
1615
1616 to
1617
1618         optimize=' '
1619
1620 then propagate your changes with B<sh Configure -S> and rebuild
1621 with B<make depend; make>.
1622
1623 =item Missing functions
1624
1625 If you have missing routines, you probably need to add some library or
1626 other, or you need to undefine some feature that Configure thought was
1627 there but is defective or incomplete.  Look through config.h for
1628 likely suspects.  If Configure guessed wrong on a number of functions,
1629 you might have the L<"nm extraction"> problem discussed above.
1630
1631 =item toke.c
1632
1633 Some compilers will not compile or optimize the larger files (such as
1634 toke.c) without some extra switches to use larger jump offsets or
1635 allocate larger internal tables.  You can customize the switches for
1636 each file in cflags.  It's okay to insert rules for specific files into
1637 makefile since a default rule only takes effect in the absence of a
1638 specific rule.
1639
1640 =item Missing dbmclose
1641
1642 SCO prior to 3.2.4 may be missing dbmclose().  An upgrade to 3.2.4
1643 that includes libdbm.nfs (which includes dbmclose()) may be available.
1644
1645 =item Note (probably harmless): No library found for -lsomething
1646
1647 If you see such a message during the building of an extension, but
1648 the extension passes its tests anyway (see L<"make test"> below),
1649 then don't worry about the warning message.  The extension
1650 Makefile.PL goes looking for various libraries needed on various
1651 systems; few systems will need all the possible libraries listed.
1652 For example, a system may have -lcposix or -lposix, but it's
1653 unlikely to have both, so most users will see warnings for the one
1654 they don't have.  The phrase 'probably harmless' is intended to
1655 reassure you that nothing unusual is happening, and the build
1656 process is continuing.
1657
1658 On the other hand, if you are building GDBM_File and you get the
1659 message
1660
1661     Note (probably harmless): No library found for -lgdbm
1662
1663 then it's likely you're going to run into trouble somewhere along
1664 the line, since it's hard to see how you can use the GDBM_File
1665 extension without the -lgdbm library.
1666
1667 It is true that, in principle, Configure could have figured all of
1668 this out, but Configure and the extension building process are not
1669 quite that tightly coordinated.
1670
1671 =item sh: ar: not found
1672
1673 This is a message from your shell telling you that the command 'ar'
1674 was not found.  You need to check your PATH environment variable to
1675 make sure that it includes the directory with the 'ar' command.  This
1676 is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin
1677 directory.
1678
1679 =item db-recno failure on tests 51, 53 and 55
1680
1681 Old versions of the DB library (including the DB library which comes
1682 with FreeBSD 2.1) had broken handling of recno databases with modified
1683 bval settings.  Upgrade your DB library or OS.
1684
1685 =item Bad arg length for semctl, is XX, should be ZZZ
1686
1687 If you get this error message from the ext/IPC/SysV/t/sem test, your System
1688 V IPC may be broken.  The XX typically is 20, and that is what ZZZ
1689 also should be.  Consider upgrading your OS, or reconfiguring your OS
1690 to include the System V semaphores.
1691
1692 =item ext/IPC/SysV/t/sem........semget: No space left on device
1693
1694 Either your account or the whole system has run out of semaphores.  Or
1695 both.  Either list the semaphores with "ipcs" and remove the unneeded
1696 ones (which ones these are depends on your system and applications)
1697 with "ipcrm -s SEMAPHORE_ID_HERE" or configure more semaphores to your
1698 system.
1699
1700 =item GNU binutils
1701
1702 If you mix GNU binutils (nm, ld, ar) with equivalent vendor-supplied
1703 tools you may be in for some trouble.  For example creating archives
1704 with an old GNU 'ar' and then using a new current vendor-supplied 'ld'
1705 may lead into linking problems.  Either recompile your GNU binutils
1706 under your current operating system release, or modify your PATH not
1707 to include the GNU utils before running Configure, or specify the
1708 vendor-supplied utilities explicitly to Configure, for example by
1709 Configure -Dar=/bin/ar.
1710
1711 =item THIS PACKAGE SEEMS TO BE INCOMPLETE
1712
1713 The F<Configure> program has not been able to find all the files which
1714 make up the complete Perl distribution.  You may have a damaged source
1715 archive file (in which case you may also have seen messages such as
1716 C<gzip: stdin: unexpected end of file> and C<tar: Unexpected EOF on
1717 archive file>), or you may have obtained a structurally-sound but
1718 incomplete archive.  In either case, try downloading again from the
1719 official site named at the start of this document.  If you do find
1720 that any site is carrying a corrupted or incomplete source code
1721 archive, please report it to the site's maintainer.
1722
1723 =item invalid token: ##
1724
1725 You are using a non-ANSI-compliant C compiler.  See L<WARNING:  This
1726 version requires a compiler that supports ANSI C>.
1727
1728 =item Miscellaneous
1729
1730 Some additional things that have been reported for either perl4 or perl5:
1731
1732 Genix may need to use libc rather than libc_s, or #undef VARARGS.
1733
1734 NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
1735
1736 UTS may need one or more of -K or -g, and undef LSTAT.
1737
1738 FreeBSD can fail the ext/IPC/SysV/t/sem.t test if SysV IPC has not been
1739 configured in the kernel.  Perl tries to detect this, though, and
1740 you will get a message telling what to do.
1741
1742 HP-UX 11 Y2K patch "Y2K-1100 B.11.00.B0125 HP-UX Core OS Year 2000
1743 Patch Bundle" has been reported to break the io/fs test #18 which
1744 tests whether utime() can change timestamps.  The Y2K patch seems to
1745 break utime() so that over NFS the timestamps do not get changed
1746 (on local filesystems utime() still works).
1747
1748 Building Perl on a system that has also BIND (headers and libraries)
1749 installed may run into troubles because BIND installs its own netdb.h
1750 and socket.h, which may not agree with the operating system's ideas of
1751 the same files.  Similarly, including -lbind may conflict with libc's
1752 view of the world.  You may have to tweak -Dlocincpth and -Dloclibpth
1753 to avoid the BIND.
1754
1755 =back
1756
1757 =head2 Cross-compilation
1758
1759 Starting from Perl 5.8 Perl has the beginnings of cross-compilation
1760 support.  What is known to work is running Configure in a
1761 cross-compilation environment and building the miniperl executable.
1762 What is known not to work is building the perl executable because
1763 that would require building extensions: Dynaloader statically and
1764 File::Glob dynamically, for extensions one needs MakeMaker and
1765 MakeMaker is not yet cross-compilation aware, and neither is
1766 the main Makefile.
1767
1768 Since the functionality is so lacking, it must be considered
1769 highly experimental.  It is so experimental that it is not even
1770 mentioned during an interactive Configure session, a direct command
1771 line invocation (detailed shortly) is required to access the
1772 functionality.
1773
1774     NOTE: Perl is routinely built using cross-compilation
1775     in the EPOC environment, in the WinCE, and in the OpenZaurus
1776     project, but all those use something slightly different setup
1777     than what described here.  For the WinCE setup, read the
1778     wince/README.compile.  For the OpenZaurus setup, read the
1779     Cross/README.
1780
1781 The one environment where this cross-compilation setup has
1782 successfully been used as of this writing is the Compaq iPAQ running
1783 ARM Linux.  The build host was Intel Linux, the networking setup was
1784 PPP + SSH.  The exact setup details are beyond the scope of this
1785 document, see http://www.handhelds.org/ for more information.
1786
1787 To run Configure in cross-compilation mode the basic switch is
1788 C<-Dusecrosscompile>.
1789
1790    sh ./Configure -des -Dusecrosscompile -D...
1791
1792 This will make the cpp symbol USE_CROSS_COMPILE and the %Config
1793 symbol C<usecrosscompile> available.
1794
1795 During the Configure and build, certain helper scripts will be created
1796 into the Cross/ subdirectory.  The scripts are used to execute a
1797 cross-compiled executable, and to transfer files to and from the
1798 target host.  The execution scripts are named F<run-*> and the
1799 transfer scripts F<to-*> and F<from-*>.  The part after the dash is
1800 the method to use for remote execution and transfer: by default the
1801 methods are B<ssh> and B<scp>, thus making the scripts F<run-ssh>,
1802 F<to-scp>, and F<from-scp>.
1803
1804 To configure the scripts for a target host and a directory (in which
1805 the execution will happen and which is to and from where the transfer
1806 happens), supply Configure with
1807
1808     -Dtargethost=so.me.ho.st -Dtargetdir=/tar/get/dir
1809
1810 The targethost is what e.g. ssh will use as the hostname, the targetdir
1811 must exist (the scripts won't create it), the targetdir defaults to /tmp.
1812 You can also specify a username to use for ssh/rsh logins
1813
1814     -Dtargetuser=luser
1815
1816 but in case you don't, "root" will be used.
1817
1818 Because this is a cross-compilation effort, you will also need to specify
1819 which target environment and which compilation environment to use.
1820 This includes the compiler, the header files, and the libraries.
1821 In the below we use the usual settings for the iPAQ cross-compilation
1822 environment:
1823
1824     -Dtargetarch=arm-linux
1825     -Dcc=arm-linux-gcc
1826     -Dusrinc=/skiff/local/arm-linux/include
1827     -Dincpth=/skiff/local/arm-linux/include
1828     -Dlibpth=/skiff/local/arm-linux/lib
1829
1830 If the name of the C<cc> has the usual GNU C semantics for cross
1831 compilers, that is, CPU-OS-gcc, the names of the C<ar>, C<nm>, and
1832 C<ranlib> will also be automatically chosen to be CPU-OS-ar and so on.
1833 (The C<ld> requires more thought and will be chosen later by Configure
1834 as appropriate.)  Also, in this case the incpth, libpth, and usrinc
1835 will be guessed by Configure (unless explicitly set to something else,
1836 in which case Configure's guesses with be appended).
1837
1838 In addition to the default execution/transfer methods you can also
1839 choose B<rsh> for execution, and B<rcp> or B<cp> for transfer,
1840 for example:
1841
1842     -Dtargetrun=rsh -Dtargetto=rcp -Dtargetfrom=cp
1843
1844 Putting it all together:
1845
1846     sh ./Configure -des -Dusecrosscompile \
1847         -Dtargethost=so.me.ho.st \
1848         -Dtargetdir=/tar/get/dir \
1849         -Dtargetuser=root \
1850         -Dtargetarch=arm-linux \
1851         -Dcc=arm-linux-gcc \
1852         -Dusrinc=/skiff/local/arm-linux/include \
1853         -Dincpth=/skiff/local/arm-linux/include \
1854         -Dlibpth=/skiff/local/arm-linux/lib \
1855         -D...
1856
1857 or if you are happy with the defaults
1858
1859     sh ./Configure -des -Dusecrosscompile \
1860         -Dtargethost=so.me.ho.st \
1861         -Dcc=arm-linux-gcc \
1862         -D...
1863
1864 =head1 make test
1865
1866 This will run the regression tests on the perl you just made.  If
1867 'make test' doesn't say "All tests successful" then something went
1868 wrong.  See the file t/README in the t subdirectory.
1869
1870 Note that you can't run the tests in background if this disables
1871 opening of /dev/tty. You can use 'make test-notty' in that case but
1872 a few tty tests will be skipped.
1873
1874 =head2 What if make test doesn't work?
1875
1876 If make test bombs out, just cd to the t directory and run ./TEST
1877 by hand to see if it makes any difference.  If individual tests
1878 bomb, you can run them by hand, e.g.,
1879
1880         ./perl op/groups.t
1881
1882 Another way to get more detailed information about failed tests and
1883 individual subtests is to cd to the t directory and run
1884
1885         ./perl harness
1886
1887 (this assumes that most basic tests succeed, since harness uses
1888 complicated constructs).  For extension and library tests you
1889 need a little bit more: you need to setup your environment variable
1890 PERL_CORE to a true value (like "1"), and you need to supply the
1891 right Perl library path:
1892
1893         setenv PERL_CORE 1
1894         ./perl -I../lib ../ext/Socket/Socket.t
1895         ./perl -I../lib ../lib/less.t
1896
1897 (For csh-like shells on UNIX; adjust appropriately for other platforms.)
1898 You should also read the individual tests to see if there are any helpful
1899 comments that apply to your system.  You may also need to setup your
1900 shared library path if you get errors like:
1901
1902         /sbin/loader: Fatal Error: cannot map libperl.so
1903
1904 See L</"Building a shared Perl library"> earlier in this document.
1905
1906 =over 4
1907
1908 =item locale
1909
1910 Note:  One possible reason for errors is that some external programs
1911 may be broken due to the combination of your environment and the way
1912 B<make test> exercises them.  For example, this may happen if you have
1913 one or more of these environment variables set:  LC_ALL LC_CTYPE
1914 LC_COLLATE LANG.  In some versions of UNIX, the non-English locales
1915 are known to cause programs to exhibit mysterious errors.
1916
1917 If you have any of the above environment variables set, please try
1918
1919         setenv LC_ALL C
1920
1921 (for C shell) or
1922
1923         LC_ALL=C;export LC_ALL
1924
1925 for Bourne or Korn shell) from the command line and then retry
1926 make test.  If the tests then succeed, you may have a broken program that
1927 is confusing the testing.  Please run the troublesome test by hand as
1928 shown above and see whether you can locate the program.  Look for
1929 things like:  exec, `backquoted command`, system, open("|...") or
1930 open("...|").  All these mean that Perl is trying to run some
1931 external program.
1932
1933 =item Timing problems
1934
1935 Several tests in the test suite check timing functions, such as
1936 sleep(), and see if they return in a reasonable amount of time.
1937 If your system is quite busy and doesn't respond quickly enough,
1938 these tests might fail.  If possible, try running the tests again
1939 with the system under a lighter load.  These timing-sensitive
1940 and load-sensitive tests include F<t/op/alarm.t>,
1941 F<ext/Time/HiRes/HiRes.t>, F<lib/Benchmark.t>,
1942 F<lib/Memoize/t/expmod_t.t>, and F<lib/Memoize/t/speed.t>.
1943
1944 =item Out of memory
1945
1946 On some systems, particularly those with smaller amounts of RAM, some
1947 of the tests in t/op/pat.t may fail with an "Out of memory" message.
1948 For example, on my SparcStation IPC with 12 MB of RAM, in perl5.5.670,
1949 test 85 will fail if run under either t/TEST or t/harness.
1950
1951 Try stopping other jobs on the system and then running the test by itself:
1952
1953         cd t; ./perl op/pat.t
1954
1955 to see if you have any better luck.  If your perl still fails this
1956 test, it does not necessarily mean you have a broken perl.  This test
1957 tries to exercise the regular expression subsystem quite thoroughly,
1958 and may well be far more demanding than your normal usage.
1959
1960 =item Test failures from lib/ftmp-security saying "system possibly insecure"
1961
1962 Firstly, test failures from the ftmp-security are not necessarily
1963 serious or indicative of a real security threat.  That being said,
1964 they bear investigating.
1965
1966 The tests may fail for the following reasons.   Note that each of the
1967 tests is run both in the building directory and the temporary
1968 directory, as returned by File::Spec->tmpdir().
1969
1970 (1) If the directory the tests are being run is owned by somebody else
1971 than the user running the tests, or root (uid 0).  This failure can
1972 happen if the Perl source code distribution is unpacked in a way that
1973 the user ids in the distribution package are used as-is.  Some tar
1974 programs do this.
1975
1976 (2) If the directory the tests are being run in is writable by group
1977 or by others (remember: with UNIX/POSIX semantics, write access to
1978 a directory means the right to add/remove files in that directory),
1979 and there is no sticky bit set in the directory.  'Sticky bit' is
1980 a feature used in some UNIXes to give extra protection to files: if
1981 the bit is on a directory, no one but the owner (or the root) can remove
1982 that file even if the permissions of the directory would allow file
1983 removal by others.  This failure can happen if the permissions in the
1984 directory simply are a bit too liberal for the tests' liking.  This
1985 may or may not be a real problem: it depends on the permissions policy
1986 used on this particular directory/project/system/site.  This failure
1987 can also happen if the system either doesn't support the sticky bit
1988 (this is the case with many non-UNIX platforms: in principle
1989 File::Temp should know about these platforms and skip the tests), or
1990 if the system supports the sticky bit but for some reason or reasons
1991 it is not being used.  This is for example the case with HP-UX: as of
1992 HP-UX release 11.00, the sticky bit is very much supported, but HP-UX
1993 doesn't use it on its /tmp directory as shipped.  Also, as with the
1994 permissions, some local policy might dictate that the stickiness is
1995 not used.
1996
1997 (3) If the system supports the POSIX 'chown giveaway' feature and if
1998 any of the parent directories of the temporary file back to the root
1999 directory are 'unsafe', using the definitions given above in (1) and
2000 (2).
2001
2002 See the documentation for the File::Temp module for more information
2003 about the various security aspects.
2004
2005 =back
2006
2007 =head1 make install
2008
2009 This will put perl into the public directory you specified to
2010 Configure; by default this is /usr/local/bin.  It will also try
2011 to put the man pages in a reasonable place.  It will not nroff the man
2012 pages, however.  You may need to be root to run B<make install>.  If you
2013 are not root, you must own the directories in question and you should
2014 ignore any messages about chown not working.
2015
2016 =head2 Installing perl under different names
2017
2018 If you want to install perl under a name other than "perl" (for example,
2019 when installing perl with special features enabled, such as debugging),
2020 indicate the alternate name on the "make install" line, such as:
2021
2022     make install PERLNAME=myperl
2023
2024 You can separately change the base used for versioned names (like
2025 "perl5.005") by setting PERLNAME_VERBASE, like
2026
2027     make install PERLNAME=perl5 PERLNAME_VERBASE=perl
2028
2029 This can be useful if you have to install perl as "perl5" (e.g. to
2030 avoid conflicts with an ancient version in /usr/bin supplied by your vendor).
2031 Without this the versioned binary would be called "perl55.005".
2032
2033 =head2 Installed files
2034
2035 If you want to see exactly what will happen without installing
2036 anything, you can run
2037
2038         ./perl installperl -n
2039         ./perl installman -n
2040
2041 make install will install the following:
2042
2043     binaries
2044
2045         perl,
2046             perl5.nnn   where nnn is the current release number.  This
2047                         will be a link to perl.
2048         suidperl,
2049             sperl5.nnn  If you requested setuid emulation.
2050         a2p             awk-to-perl translator
2051
2052     scripts
2053
2054         cppstdin        This is used by perl -P, if your cc -E can't
2055                         read from stdin.
2056         c2ph, pstruct   Scripts for handling C structures in header files.
2057         s2p             sed-to-perl translator
2058         find2perl       find-to-perl translator
2059         h2ph            Extract constants and simple macros from C headers
2060         h2xs            Converts C .h header files to Perl extensions.
2061         perlbug         Tool to report bugs in Perl.
2062         perldoc         Tool to read perl's pod documentation.
2063         pl2pm           Convert Perl 4 .pl files to Perl 5 .pm modules
2064         pod2html,       Converters from perl's pod documentation format
2065         pod2latex,      to other useful formats.
2066         pod2man,
2067         pod2text,
2068         pod2checker,
2069         pod2select,
2070         pod2usage
2071         splain          Describe Perl warnings and errors
2072         dprofpp         Perl code profile post-processor
2073
2074     library files
2075
2076                         in $privlib and $archlib specified to
2077                         Configure, usually under /usr/local/lib/perl5/.
2078
2079     documentation
2080
2081         man pages       in $man1dir, usually /usr/local/man/man1.
2082         module man
2083         pages           in $man3dir, usually /usr/local/man/man3.
2084         pod/*.pod       in $privlib/pod/.
2085
2086 Installperl will also create the directories listed above
2087 in L<"Installation Directories">.
2088
2089 Perl's *.h header files and the libperl library are also installed
2090 under $archlib so that any user may later build new modules, run the
2091 optional Perl compiler, or embed the perl interpreter into another
2092 program even if the Perl source is no longer available.
2093
2094 Sometimes you only want to install the version-specific parts of the perl
2095 installation.  For example, you may wish to install a newer version of
2096 perl alongside an already installed production version of perl without
2097 disabling installation of new modules for the production version.
2098 To only install the version-specific parts of the perl installation, run
2099
2100         Configure -Dversiononly
2101
2102 or answer 'y' to the appropriate Configure prompt.  Alternatively,
2103 you can just manually run
2104
2105         ./perl installperl -v
2106
2107 and skip installman altogether.
2108 See also L<"Maintaining completely separate versions"> for another
2109 approach.
2110
2111 =head1 Coexistence with earlier versions of perl5
2112
2113 Perl 5.8 is not binary compatible with earlier versions of Perl.
2114 In other words, you will have to recompile your XS modules.
2115
2116 In general, you can usually safely upgrade from one version of Perl (e.g.
2117 5.004_04) to another similar version (e.g. 5.004_05) without re-compiling
2118 all of your add-on extensions.  You can also safely leave the old version
2119 around in case the new version causes you problems for some reason.
2120 For example, if you want to be sure that your script continues to run
2121 with 5.004_04, simply replace the '#!/usr/local/bin/perl' line at the
2122 top of the script with the particular version you want to run, e.g.
2123 #!/usr/local/bin/perl5.00404.
2124
2125 Usually, most extensions will probably not need to be recompiled to
2126 use with a newer version of Perl (the Perl 5.6 to Perl 5.8 transition
2127 being an exception).  Here is how it is supposed to work.  (These
2128 examples assume you accept all the Configure defaults.)
2129
2130 Suppose you already have version 5.005_03 installed.  The directories
2131 searched by 5.005_03 are
2132
2133         /usr/local/lib/perl5/5.00503/$archname
2134         /usr/local/lib/perl5/5.00503
2135         /usr/local/lib/perl5/site_perl/5.005/$archname
2136         /usr/local/lib/perl5/site_perl/5.005
2137
2138 Beginning with 5.6.0 the version number in the site libraries are
2139 fully versioned.  Now, suppose you install version 5.6.0.  The directories
2140 searched by version 5.6.0 will be
2141
2142         /usr/local/lib/perl5/5.6.0/$archname
2143         /usr/local/lib/perl5/5.6.0
2144         /usr/local/lib/perl5/site_perl/5.6.0/$archname
2145         /usr/local/lib/perl5/site_perl/5.6.0
2146
2147         /usr/local/lib/perl5/site_perl/5.005/$archname
2148         /usr/local/lib/perl5/site_perl/5.005
2149         /usr/local/lib/perl5/site_perl/
2150
2151 Notice the last three entries -- Perl understands the default structure
2152 of the $sitelib directories and will look back in older, compatible
2153 directories.  This way, modules installed under 5.005_03 will continue
2154 to be usable by 5.005_03 but will also accessible to 5.6.0.  Further,
2155 suppose that you upgrade a module to one which requires features
2156 present only in 5.6.0.  That new module will get installed into
2157 /usr/local/lib/perl5/site_perl/5.6.0 and will be available to 5.6.0,
2158 but will not interfere with the 5.005_03 version.
2159
2160 The last entry, /usr/local/lib/perl5/site_perl/, is there so that
2161 5.6.0 and above will look for 5.004-era pure perl modules.
2162
2163 Lastly, suppose you now install 5.8.0, which is not binary compatible
2164 with 5.6.0.  The directories searched by 5.8.0 (if you don't change the
2165 Configure defaults) will be:
2166
2167         /usr/local/lib/perl5/5.8.0/$archname
2168         /usr/local/lib/perl5/5.8.0
2169         /usr/local/lib/perl5/site_perl/5.8.0/$archname
2170         /usr/local/lib/perl5/site_perl/5.8.0
2171
2172         /usr/local/lib/perl5/site_perl/5.6.0
2173
2174         /usr/local/lib/perl5/site_perl/5.005
2175
2176         /usr/local/lib/perl5/site_perl/
2177
2178 Note that the earlier $archname entries are now gone, but pure perl
2179 modules from earlier versions will still be found.
2180
2181 Assuming the users in your site are still actively using perl 5.6.0 and
2182 5.005 after you installed 5.8.0, you can continue to install add-on
2183 extensions using any of perl 5.8.0, 5.6.0, or 5.005.  The installations
2184 of these different versions remain distinct, but remember that the
2185 newer versions of perl are automatically set up to search the
2186 compatible site libraries of the older ones.  This means that
2187 installing a new XS extension with 5.005 will make it visible to both
2188 5.005 and 5.6.0, but not to 5.8.0.  Installing a pure perl module with
2189 5.005 will make it visible to all three versions.  Later, if you
2190 install the same extension using, say, perl 5.8.0, it will override the
2191 5.005-installed version, but only for perl 5.8.0.
2192
2193 This way, you can choose to share compatible extensions, but also upgrade
2194 to a newer version of an extension that may be incompatible with earlier
2195 versions, without breaking the earlier versions' installations.
2196
2197 =head2 Maintaining completely separate versions
2198
2199 Many users prefer to keep all versions of perl in completely
2200 separate directories.  This guarantees that an update to one version
2201 won't interfere with another version.  (The defaults guarantee this for
2202 libraries after 5.6.0, but not for executables. TODO?)  One convenient
2203 way to do this is by using a separate prefix for each version, such as
2204
2205         sh Configure -Dprefix=/opt/perl5.004
2206
2207 and adding /opt/perl5.004/bin to the shell PATH variable.  Such users
2208 may also wish to add a symbolic link /usr/local/bin/perl so that
2209 scripts can still start with #!/usr/local/bin/perl.
2210
2211 Others might share a common directory for maintenance sub-versions
2212 (e.g. 5.8 for all 5.8.x versions), but change directory with
2213 each major version.
2214
2215 If you are installing a development subversion, you probably ought to
2216 seriously consider using a separate directory, since development
2217 subversions may not have all the compatibility wrinkles ironed out
2218 yet.
2219
2220 =head2 Upgrading from 5.005 or 5.6 to 5.8.0
2221
2222 B<Perl 5.8.0 is binary incompatible with Perl 5.6.1, 5.6.0, 5.005,
2223 and any earlier Perl release.>  Perl modules having binary parts
2224 (meaning that a C compiler is used) will have to be recompiled to be
2225 used with 5.8.0.  If you find you do need to rebuild an extension with
2226 5.8.0, you may safely do so without disturbing the 5.005 or 5.6.0
2227 installations.  (See L<"Coexistence with earlier versions of perl5">
2228 above.)
2229
2230 See your installed copy of the perllocal.pod file for a (possibly
2231 incomplete) list of locally installed modules.  Note that you want
2232 perllocal.pod, not perllocale.pod, for installed module information.
2233
2234 =head1 Coexistence with perl4
2235
2236 You can safely install perl5 even if you want to keep perl4 around.
2237
2238 By default, the perl5 libraries go into /usr/local/lib/perl5/, so
2239 they don't override the perl4 libraries in /usr/local/lib/perl/.
2240
2241 In your /usr/local/bin directory, you should have a binary named
2242 perl4.036.  That will not be touched by the perl5 installation
2243 process.  Most perl4 scripts should run just fine under perl5.
2244 However, if you have any scripts that require perl4, you can replace
2245 the #! line at the top of them by #!/usr/local/bin/perl4.036 (or
2246 whatever the appropriate pathname is).  See pod/perltrap.pod for
2247 possible problems running perl4 scripts under perl5.
2248
2249 =head1 cd /usr/include; h2ph *.h sys/*.h
2250
2251 Some perl scripts need to be able to obtain information from the
2252 system header files.  This command will convert the most commonly used
2253 header files in /usr/include into files that can be easily interpreted
2254 by perl.  These files will be placed in the architecture-dependent
2255 library ($archlib) directory you specified to Configure.
2256
2257 Note:  Due to differences in the C and perl languages, the conversion
2258 of the header files is not perfect.  You will probably have to
2259 hand-edit some of the converted files to get them to parse correctly.
2260 For example, h2ph breaks spectacularly on type casting and certain
2261 structures.
2262
2263 =head1 installhtml --help
2264
2265 Some sites may wish to make perl documentation available in HTML
2266 format.  The installhtml utility can be used to convert pod
2267 documentation into linked HTML files and install them.
2268
2269 Currently, the supplied ./installhtml script does not make use of the
2270 html Configure variables.  This should be fixed in a future release.
2271
2272 The following command-line is an example of one used to convert
2273 perl documentation:
2274
2275   ./installhtml                   \
2276       --podroot=.                 \
2277       --podpath=lib:ext:pod:vms   \
2278       --recurse                   \
2279       --htmldir=/perl/nmanual     \
2280       --htmlroot=/perl/nmanual    \
2281       --splithead=pod/perlipc     \
2282       --splititem=pod/perlfunc    \
2283       --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \
2284       --verbose
2285
2286 See the documentation in installhtml for more details.  It can take
2287 many minutes to execute a large installation and you should expect to
2288 see warnings like "no title", "unexpected directive" and "cannot
2289 resolve" as the files are processed. We are aware of these problems
2290 (and would welcome patches for them).
2291
2292 You may find it helpful to run installhtml twice. That should reduce
2293 the number of "cannot resolve" warnings.
2294
2295 =head1 cd pod && make tex && (process the latex files)
2296
2297 Some sites may also wish to make the documentation in the pod/ directory
2298 available in TeX format.  Type
2299
2300         (cd pod && make tex && <process the latex files>)
2301
2302 =head1 Minimizing the Perl installation
2303
2304 The following section is meant for people worrying about squeezing the
2305 Perl installation into minimal systems (for example when installing
2306 operating systems, or in really small filesystems).
2307
2308 Leaving out as many extensions as possible is an obvious way:
2309 Encode, with its big conversion tables, consumes a lot of
2310 space.  On the other hand, you cannot throw away everything.  The
2311 Fcntl module is pretty essential.  If you need to do network
2312 programming, you'll appreciate the Socket module, and so forth: it all
2313 depends on what do you need to do.
2314
2315 In the following we offer two different slimmed down installation
2316 recipes.  They are informative, not normative: the choice of files
2317 depends on what you need.
2318
2319 Firstly, the bare minimum to run this script
2320
2321   use strict;
2322   use warnings;
2323   foreach my $f (</*>) {
2324      print("$f\n");
2325   }
2326
2327 in Solaris is as follows (under $Config{prefix}):
2328
2329   ./bin/perl
2330   ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/autosplit.ix
2331   ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/dl_expandspec.al
2332   ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/dl_find_symbol_anywhere.al
2333   ./lib/perl5/5.6.1/sun4-solaris-64int/auto/DynaLoader/dl_findfile.al
2334   ./lib/perl5/5.6.1/sun4-solaris-64int/auto/File/Glob/Glob.so
2335   ./lib/perl5/5.6.1/sun4-solaris-64int/auto/File/Glob/autosplit.ix
2336   ./lib/perl5/5.6.1/sun4-solaris-64int/Config.pm
2337   ./lib/perl5/5.6.1/sun4-solaris-64int/XSLoader.pm
2338   ./lib/perl5/5.6.1/sun4-solaris-64int/DynaLoader.pm
2339   ./lib/perl5/5.6.1/sun4-solaris-64int/CORE/libperl.so
2340   ./lib/perl5/5.6.1/strict.pm
2341   ./lib/perl5/5.6.1/warnings.pm
2342   ./lib/perl5/5.6.1/Carp.pm
2343   ./lib/perl5/5.6.1/Exporter.pm
2344   ./lib/perl5/5.6.1/File/Glob.pm
2345   ./lib/perl5/5.6.1/AutoLoader.pm
2346   ./lib/perl5/5.6.1/vars.pm
2347   ./lib/perl5/5.6.1/warnings/register.pm
2348   ./lib/perl5/5.6.1/Carp/Heavy.pm
2349   ./lib/perl5/5.6.1/Exporter/Heavy.pm
2350
2351 Secondly, Debian perl-base package contains the following files,
2352 size about 1.2MB in its i386 version:
2353
2354   /usr/share/doc/perl/Documentation
2355   /usr/share/doc/perl/README.Debian
2356   /usr/share/doc/perl/copyright
2357   /usr/share/doc/perl/AUTHORS.gz
2358   /usr/share/doc/perl/changelog.Debian.gz
2359   /usr/share/man/man1/perl.1.gz
2360   /usr/share/perl/5.6.1/AutoLoader.pm
2361   /usr/share/perl/5.6.1/Carp.pm
2362   /usr/share/perl/5.6.1/Carp/Heavy.pm
2363   /usr/share/perl/5.6.1/Cwd.pm
2364   /usr/share/perl/5.6.1/Exporter.pm
2365   /usr/share/perl/5.6.1/Exporter/Heavy.pm
2366   /usr/share/perl/5.6.1/File/Spec.pm
2367   /usr/share/perl/5.6.1/File/Spec/Unix.pm
2368   /usr/share/perl/5.6.1/FileHandle.pm
2369   /usr/share/perl/5.6.1/Getopt/Long.pm
2370   /usr/share/perl/5.6.1/IO/Socket/INET.pm
2371   /usr/share/perl/5.6.1/IO/Socket/UNIX.pm
2372   /usr/share/perl/5.6.1/IPC/Open2.pm
2373   /usr/share/perl/5.6.1/IPC/Open3.pm
2374   /usr/share/perl/5.6.1/SelectSaver.pm
2375   /usr/share/perl/5.6.1/Symbol.pm
2376   /usr/share/perl/5.6.1/Text/Tabs.pm
2377   /usr/share/perl/5.6.1/Text/Wrap.pm
2378   /usr/share/perl/5.6.1/attributes.pm
2379   /usr/share/perl/5.6.1/auto/Getopt/Long/GetOptions.al
2380   /usr/share/perl/5.6.1/auto/Getopt/Long/FindOption.al
2381   /usr/share/perl/5.6.1/auto/Getopt/Long/Configure.al
2382   /usr/share/perl/5.6.1/auto/Getopt/Long/config.al
2383   /usr/share/perl/5.6.1/auto/Getopt/Long/Croak.al
2384   /usr/share/perl/5.6.1/auto/Getopt/Long/autosplit.ix
2385   /usr/share/perl/5.6.1/base.pm
2386   /usr/share/perl/5.6.1/constant.pm
2387   /usr/share/perl/5.6.1/fields.pm
2388   /usr/share/perl/5.6.1/integer.pm
2389   /usr/share/perl/5.6.1/lib.pm
2390   /usr/share/perl/5.6.1/locale.pm
2391   /usr/share/perl/5.6.1/overload.pm
2392   /usr/share/perl/5.6.1/strict.pm
2393   /usr/share/perl/5.6.1/vars.pm
2394   /usr/share/perl/5.6.1/warnings.pm
2395   /usr/share/perl/5.6.1/warnings/register.pm
2396   /usr/bin/perl
2397   /usr/lib/perl/5.6.1/Config.pm
2398   /usr/lib/perl/5.6.1/Data/Dumper.pm
2399   /usr/lib/perl/5.6.1/DynaLoader.pm
2400   /usr/lib/perl/5.6.1/Errno.pm
2401   /usr/lib/perl/5.6.1/Fcntl.pm
2402   /usr/lib/perl/5.6.1/File/Glob.pm
2403   /usr/lib/perl/5.6.1/IO.pm
2404   /usr/lib/perl/5.6.1/IO/File.pm
2405   /usr/lib/perl/5.6.1/IO/Handle.pm
2406   /usr/lib/perl/5.6.1/IO/Pipe.pm
2407   /usr/lib/perl/5.6.1/IO/Seekable.pm
2408   /usr/lib/perl/5.6.1/IO/Select.pm
2409   /usr/lib/perl/5.6.1/IO/Socket.pm
2410   /usr/lib/perl/5.6.1/POSIX.pm
2411   /usr/lib/perl/5.6.1/Socket.pm
2412   /usr/lib/perl/5.6.1/XSLoader.pm
2413   /usr/lib/perl/5.6.1/auto/Data/Dumper/Dumper.so
2414   /usr/lib/perl/5.6.1/auto/Data/Dumper/Dumper.bs
2415   /usr/lib/perl/5.6.1/auto/DynaLoader/dl_findfile.al
2416   /usr/lib/perl/5.6.1/auto/DynaLoader/dl_expandspec.al
2417   /usr/lib/perl/5.6.1/auto/DynaLoader/dl_find_symbol_anywhere.al
2418   /usr/lib/perl/5.6.1/auto/DynaLoader/autosplit.ix
2419   /usr/lib/perl/5.6.1/auto/DynaLoader/DynaLoader.a
2420   /usr/lib/perl/5.6.1/auto/DynaLoader/extralibs.ld
2421   /usr/lib/perl/5.6.1/auto/Fcntl/Fcntl.so
2422   /usr/lib/perl/5.6.1/auto/Fcntl/Fcntl.bs
2423   /usr/lib/perl/5.6.1/auto/File/Glob/Glob.bs
2424   /usr/lib/perl/5.6.1/auto/File/Glob/Glob.so
2425   /usr/lib/perl/5.6.1/auto/File/Glob/autosplit.ix
2426   /usr/lib/perl/5.6.1/auto/IO/IO.so
2427   /usr/lib/perl/5.6.1/auto/IO/IO.bs
2428   /usr/lib/perl/5.6.1/auto/POSIX/POSIX.bs
2429   /usr/lib/perl/5.6.1/auto/POSIX/POSIX.so
2430   /usr/lib/perl/5.6.1/auto/POSIX/autosplit.ix
2431   /usr/lib/perl/5.6.1/auto/POSIX/load_imports.al
2432   /usr/lib/perl/5.6.1/auto/Socket/Socket.so
2433   /usr/lib/perl/5.6.1/auto/Socket/Socket.bs
2434
2435 =head1 Reporting Problems
2436
2437 If you have difficulty building perl, and none of the advice in this file
2438 helps, and careful reading of the error message and the relevant manual
2439 pages on your system doesn't help either, then you should send a message
2440 to either the comp.lang.perl.misc newsgroup or to perlbug@perl.org with
2441 an accurate description of your problem.
2442
2443 Please include the output of the ./myconfig shell script that comes with
2444 the distribution.  Alternatively, you can use the perlbug program that
2445 comes with the perl distribution, but you need to have perl compiled
2446 before you can use it.  (If you have not installed it yet, you need to
2447 run C<./perl -Ilib utils/perlbug> instead of a plain C<perlbug>.)
2448
2449 Please try to make your message brief but clear.  Trim out unnecessary
2450 information.  Do not include large files (such as config.sh or a complete
2451 Configure or make log) unless absolutely necessary.  Do not include a
2452 complete transcript of your build session.  Just include the failing
2453 commands, the relevant error messages, and whatever preceding commands
2454 are necessary to give the appropriate context.  Plain text should
2455 usually be sufficient--fancy attachments or encodings may actually
2456 reduce the number of people who read your message.  Your message
2457 will get relayed to over 400 subscribers around the world so please
2458 try to keep it brief but clear.
2459
2460 =head1 DOCUMENTATION
2461
2462 Read the manual entries before running perl.  The main documentation
2463 is in the pod/ subdirectory and should have been installed during the
2464 build process.  Type B<man perl> to get started.  Alternatively, you
2465 can type B<perldoc perl> to use the supplied perldoc script.  This is
2466 sometimes useful for finding things in the library modules.
2467
2468 Under UNIX, you can produce a documentation book in postscript form,
2469 along with its table of contents, by going to the pod/ subdirectory and
2470 running (either):
2471
2472         ./roffitall -groff              # If you have GNU groff installed
2473         ./roffitall -psroff             # If you have psroff
2474
2475 This will leave you with two postscript files ready to be printed.
2476 (You may need to fix the roffitall command to use your local troff
2477 set-up.)
2478
2479 Note that you must have performed the installation already before running
2480 the above, since the script collects the installed files to generate
2481 the documentation.
2482
2483 =head1 AUTHOR
2484
2485 Original author:  Andy Dougherty doughera@lafayette.edu , borrowing very
2486 heavily from the original README by Larry Wall, with lots of helpful
2487 feedback and additions from the perl5-porters@perl.org folks.
2488
2489 If you have problems, corrections, or questions, please see
2490 L<"Reporting Problems"> above.
2491
2492 =head1 REDISTRIBUTION
2493
2494 This document is part of the Perl package and may be distributed under
2495 the same terms as perl itself, with the following additional request:
2496 If you are distributing a modified version of perl (perhaps as part of
2497 a larger package) please B<do> modify these installation instructions
2498 and the contact information to match your distribution.