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