This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Rhapsody/Darwin patches from Wilfredo Sanchez.
[perl5.git] / INSTALL
1 =head1 NAME
2
3 Install - Build and Installation guide for perl5.
4
5 =head1 SYNOPSIS
6
7 First, make sure you are installing an up-to-date version of Perl.   If
8 you didn't get your Perl source from CPAN, check the latest version at
9 <URL:http://www.perl.com/CPAN/src/>.
10
11 The basic steps to build and install perl5 on a Unix system
12 with all the defaults are:
13
14         rm -f config.sh Policy.sh
15         sh Configure -de
16         make
17         make test
18         make install
19
20         # You may also wish to add these:
21         (cd /usr/include && h2ph *.h sys/*.h)
22         (installhtml --help)
23         (cd pod && make tex  && <process the latex files>)
24
25 Each of these is explained in further detail below.
26
27 The above commands will install Perl to /usr/local or /opt, depending
28 on the platform.  If that's not okay with you, use
29
30         rm -f config.sh Policy.sh
31         sh Configure
32         make
33         make test
34         make install
35
36 For information on non-Unix systems, see the section on
37 L<"Porting information"> below.
38
39 If you have problems, corrections, or questions, please see
40 L<"Reporting Problems"> below.
41
42 For information on what's new in this release, see the
43 pod/perldelta.pod file.  For more detailed information about specific
44 changes, see the Changes file.
45
46 =head1 DESCRIPTION
47
48 This document is written in pod format as an easy way to indicate its
49 structure.  The pod format is described in pod/perlpod.pod, but you can
50 read it as is with any pager or editor.  Headings and items are marked
51 by lines beginning with '='.  The other mark-up used is
52
53     B<text>     embolden text, used for switches, programs or commands
54     C<code>     literal code
55     L<name>     A link (cross reference) to name
56
57 Although most of the defaults are probably fine for most users,
58 you should probably at least skim through this entire document before
59 proceeding.
60
61 If you're building Perl on a non-Unix system, you should also read
62 the README file specific to your operating system, since this may
63 provide additional or different instructions for building Perl.
64
65 If there is a hint file for your system (in the hints/ directory) you
66 should also read that hint file for specific information for your
67 system.  (Unixware users should use the svr4.sh hint file.)  If
68 there is a README file for your platform, then you should read
69 that too.  Additional information is in the Porting/ directory.
70
71 =head1 WARNING:  This version requires an extra step to build old extensions.
72
73 5.005_53 and later releases do not export unadorned
74 global symbols anymore.  This means you may need to build older
75 extensions that have not been updated for the new naming convention
76 with:
77
78         perl Makefile.PL POLLUTE=1
79         
80 Alternatively, you can enable CPP symbol pollution wholesale by
81 building perl itself with:
82
83         sh Configure -Accflags=-DPERL_POLLUTE
84
85 pod/perldelta.pod contains more details about this.
86
87 =head1 WARNING:  This version may not be binary compatible with Perl 5.005.
88
89 Using the default Configure options for building perl should get you
90 a perl that will be binary compatible with the 5.005 release.
91
92 However, if you run Configure with any custom options, such as
93 -Dusethreads, -Dusemultiplicity, -Dusemymalloc, -Ubincompat5005 etc.,
94 the resulting perl will not be binary compatible.  Under these
95 circumstances, if you have dynamically loaded extensions that were
96 built under perl 5.005, you will need to rebuild and reinstall all
97 those extensions to use them with 5.6.
98
99 Pure perl modules without XS or C code should continue to work fine
100 without reinstallation.  See the discussions below on
101 L<"Coexistence with earlier versions of perl5"> and
102 L<"Upgrading from 5.005 to 5.6"> for more details.
103
104 The standard extensions supplied with Perl will be handled automatically.
105
106 On a related issue, old modules may possibly be affected by the
107 changes in the Perl language in the current release.  Please see
108 pod/perldelta.pod (and pod/perl500Xdelta.pod) for a description of
109 what's changed.  See your installed copy of the perllocal.pod
110 file for a (possibly incomplete) list of locally installed modules.
111 Also see CPAN::autobundle for one way to make a "bundle" of your
112 currently installed modules.
113
114 =head1 WARNING:  This version requires a compiler that supports ANSI C.
115
116 If you find that your C compiler is not ANSI-capable, try obtaining
117 GCC, available from GNU mirrors worldwide (e.g. ftp://ftp.gnu.org/pub/gnu).
118 Another alternative may be to use a tool like ansi2knr to convert the
119 sources back to K&R style, but there is no guarantee this route will get
120 you anywhere, since the prototypes are not the only ANSI features used
121 in the Perl sources.  ansi2knr is usually found as part of the freely
122 available Ghostscript distribution.  Another similar tool is
123 unprotoize, distributed with GCC.  Since unprotoize requires GCC to
124 run, you may have to run it on a platform where GCC is available, and move
125 the sources back to the platform without GCC.
126
127 If you succeed in automatically converting the sources to a K&R compatible
128 form, be sure to email perlbug@perl.com to let us know the steps you
129 followed.  This will enable us to officially support this option.
130
131 =head1 Space Requirements
132
133 The complete perl5 source tree takes up about 20 MB of disk space.
134 After completing make, it takes up roughly 30 MB, though the actual
135 total is likely to be quite system-dependent.  The installation
136 directories need something on the order of 20 MB, though again that
137 value is system-dependent.
138
139 =head1 Start with a Fresh Distribution
140
141 If you have built perl before, you should clean out the build directory
142 with the command
143
144         make distclean
145
146 or
147
148         make realclean
149
150 The only difference between the two is that make distclean also removes
151 your old config.sh and Policy.sh files.
152
153 The results of a Configure run are stored in the config.sh and Policy.sh
154 files.  If you are upgrading from a previous version of perl, or if you
155 change systems or compilers or make other significant changes, or if
156 you are experiencing difficulties building perl, you should probably
157 not re-use your old config.sh.  Simply remove it
158
159         rm -f config.sh
160
161 If you wish to use your old config.sh, be especially attentive to the
162 version and architecture-specific questions and answers.  For example,
163 the default directory for architecture-dependent library modules
164 includes the version name.  By default, Configure will reuse your old
165 name (e.g. /opt/perl/lib/i86pc-solaris/5.003) even if you're running
166 Configure for a different version, e.g. 5.004.  Yes, Configure should
167 probably check and correct for this, but it doesn't, presently.
168 Similarly, if you used a shared libperl.so (see below) with version
169 numbers, you will probably want to adjust them as well.
170
171 Also, be careful to check your architecture name.  For example, some
172 Linux distributions use i386, while others may use i486.  If you build
173 it yourself, Configure uses the output of the arch command, which
174 might be i586 or i686 instead.  If you pick up a precompiled binary, or
175 compile extensions on different systems, they might not all agree on
176 the architecture name.
177
178 In short, if you wish to use your old config.sh, I recommend running
179 Configure interactively rather than blindly accepting the defaults.
180
181 If your reason to reuse your old config.sh is to save your particular
182 installation choices, then you can probably achieve the same effect by
183 using the Policy.sh file.  See the section on L<"Site-wide Policy
184 settings"> below.  If you wish to start with a fresh distribution, you
185 also need to remove any old Policy.sh files you may have with
186
187         rm -f Policy.sh
188
189 =head1 Run Configure
190
191 Configure will figure out various things about your system.  Some
192 things Configure will figure out for itself, other things it will ask
193 you about.  To accept the default, just press RETURN.   The default is
194 almost always okay.  It is normal for some things to be "NOT found",
195 since Configure often searches for many different ways of performing
196 the same function.
197
198 At any Configure prompt, you can type  &-d and Configure will use the
199 defaults from then on.
200
201 After it runs, Configure will perform variable substitution on all the
202 *.SH files and offer to run make depend.
203
204 =head2 Altering config.sh variables for C compiler switches etc.
205
206 For most users, all of the Configure defaults are fine.  Configure
207 also has several convenient options which are all described below.
208 However, if Configure doesn't have an option to do what you want,
209 you can change Configure variables after the platform hints have been
210 run, by using Configure's -A switch.  For example, here's how to add
211 a couple of extra flags to C compiler invocations:
212
213         sh Configure -Accflags="-DPERL_Y2KWARN -DPERL_POLLUTE_MALLOC"
214
215 For more help on Configure switches, run:
216
217         sh Configure -h
218
219 =head2 Common Configure options
220
221 Configure supports a number of useful options.  Run B<Configure -h> to
222 get a listing.  See the Porting/Glossary file for a complete list of
223 Configure variables you can set and their definitions.
224
225 =over 4
226
227 =item gcc
228
229 To compile with gcc you should run
230
231         sh Configure -Dcc=gcc
232
233 This is the preferred way to specify gcc (or another alternative
234 compiler) so that the hints files can set appropriate defaults.
235
236 =item Installation prefix
237
238 By default, for most systems, perl will be installed in
239 /usr/local/{bin, lib, man}.  (See L<"Installation Directories">
240 and L<"Coexistence with earlier versions of perl5"> below for
241 further details.)
242
243 You can specify a different 'prefix' for the default installation
244 directory, when Configure prompts you or by using the Configure command
245 line option -Dprefix='/some/directory', e.g.
246
247         sh Configure -Dprefix=/opt/perl
248
249 If your prefix contains the string "perl", then the suggested
250 directory structure is simplified.  For example, if you use
251 prefix=/opt/perl, then Configure will suggest /opt/perl/lib instead of
252 /opt/perl/lib/perl5/.  Again, see L<"Installation Directories"> below
253 for more details.
254
255 NOTE:  You must not specify an installation directory that is the same
256 as or below your perl source directory.  If you do, installperl will
257 attempt infinite recursion.
258
259 =item /usr/bin/perl
260
261 It may seem obvious, but Perl is useful only when users can easily
262 find it.  It's often a good idea to have both /usr/bin/perl and
263 /usr/local/bin/perl be symlinks to the actual binary.  Be especially
264 careful, however, not to overwrite a version of perl supplied by your
265 vendor unless you are sure you know what you are doing.
266
267 By default, Configure will arrange for /usr/bin/perl to be linked to
268 the current version of perl.  You can turn off that behavior by running
269
270         Configure -Uinstallusrbinperl
271
272 or by answering 'no' to the appropriate Configure prompt.
273
274 In any case, system administrators are strongly encouraged to
275 put (symlinks to) perl and its accompanying utilities, such as perldoc,
276 into a directory typically found along a user's PATH, or in another
277 obvious and convenient place.
278
279 =item Overriding an old config.sh
280
281 If you want to use your old config.sh but override some of the items
282 with command line options, you need to use B<Configure -O>.
283
284 =back
285
286 If you are willing to accept all the defaults, and you want terse
287 output, you can run
288
289         sh Configure -des
290
291 For my Solaris system, I usually use
292
293         sh Configure -Dprefix=/opt/perl -Doptimize='-xpentium -xO4' -des
294
295 =head2 GNU-style configure
296
297 If you prefer the GNU-style configure command line interface, you can
298 use the supplied configure.gnu command, e.g.
299
300         CC=gcc ./configure.gnu
301
302 The configure.gnu script emulates a few of the more common configure
303 options.  Try
304
305         ./configure.gnu --help
306
307 for a listing.
308
309 Cross compiling and compiling in a different directory are not supported.
310
311 (The file is called configure.gnu to avoid problems on systems
312 that would not distinguish the files "Configure" and "configure".)
313
314 =head2 Installation Directories
315
316 The installation directories can all be changed by answering the
317 appropriate questions in Configure.  For convenience, all the
318 installation questions are near the beginning of Configure.
319 Further, there are a number of additions to the installation
320 directories since 5.005, so reusing your old config.sh may not
321 be sufficient to put everything where you want it.
322
323 I highly recommend running Configure interactively to be sure it puts
324 everything where you want it.  At any point during the Configure
325 process, you can answer a question with  &-d  and Configure will use
326 the defaults from then on.
327
328 The defaults are intended to be reasonable and sensible for most
329 people building from sources.  Those who build and distribute binary
330 distributions or who export perl to a range of systems will probably
331 need to alter them.  If you are content to just accept the defaults,
332 you can safely skip the next section.
333
334 The directories set up by Configure fall into three broad categories.
335
336 =over 4
337
338 =item Directories for the perl distribution
339
340 By default, Configure will use the following directories for 5.6.0.
341 $version is the full perl version number, including subversion, e.g.
342 5.6.0 or 5.6.1, and $archname is a string like sun4-sunos,
343 determined by Configure.  The full definitions of all Configure
344 variables are in the file Porting/Glossary.
345
346     Configure variable  Default value
347     $prefix             /usr/local
348     $bin                $prefix/bin
349     $scriptdir          $prefix/bin
350     $privlib            $prefix/lib/perl5/$version
351     $archlib            $prefix/lib/perl5/$version/$archname
352     $man1dir            $prefix/man/man1
353     $man3dir            $prefix/man/man3
354     $html1dir           (none)
355     $html3dir           (none)
356
357 Actually, Configure recognizes the SVR3-style
358 /usr/local/man/l_man/man1 directories, if present, and uses those
359 instead.  Also, if $prefix contains the string "perl", the library
360 directories are simplified as described below.  For simplicity, only
361 the common style is shown here.
362
363 =item Directories for site-specific add-on files
364
365 After perl is installed, you may later wish to add modules (e.g. from
366 CPAN) or scripts.  Configure will set up the following directories to
367 be used for installing those add-on modules and scripts.
368
369     Configure variable  Default value
370     $siteprefix         $prefix
371     $sitebin            $siteprefix/bin
372     $sitescript         $siteprefix/bin
373     $sitelib            $siteprefix/lib/perl5/site_perl/$version
374     $sitearch           $siteprefix/lib/perl5/site_perl/$version/$archname
375     $siteman1           $siteprefix/man/man1
376     $siteman3           $siteprefix/man/man3
377     $sitehtml1          (none)
378     $sitehtml3          (none)
379
380 By default, ExtUtils::MakeMaker will install architecture-independent
381 modules into $sitelib and architecture-dependent modules into $sitearch.
382
383 =item Directories for vendor-supplied add-on files
384
385 Lastly, if you are building a binary distribution of perl for
386 distribution, Configure can optionally set up the following directories
387 for you to use to distribute add-on modules.
388
389     Configure variable  Default value
390     $vendorprefix       (none)
391     (The next ones are set only if vendorprefix is set.)
392     $vendorbin          $vendorprefix/bin
393     $vendorscript       $vendorprefix/bin
394     $vendorlib          $vendorprefix/lib/perl5/vendor_perl/$version
395     $vendorarch         $vendorprefix/lib/perl5/vendor_perl/$version/$archname
396     $vendorman1         $vendorprefix/man/man1
397     $vendorman3         $vendorprefix/man/man3
398     $vendorhtml1        (none)
399     $vendorhtml3        (none)
400
401 These are normally empty, but may be set as needed.  For example,
402 a vendor might choose the following settings:
403
404         $prefix         /usr/bin
405         $siteprefix     /usr/local/bin
406         $vendorprefix   /usr/bin
407
408 This would have the effect of setting the following:
409
410         $bin            /usr/bin
411         $scriptdir      /usr/bin
412         $privlib        /usr/lib/perl5/$version
413         $archlib        /usr/lib/perl5/$version/$archname
414         $man1dir        /usr/man/man1
415         $man3dir        /usr/man/man3
416
417         $sitebin        /usr/local/bin
418         $sitescript     /usr/local/bin
419         $sitelib        /usr/local/lib/perl5/site_perl/$version
420         $sitearch       /usr/local/lib/perl5/site_perl/$version/$archname
421         $siteman1       /usr/local/man/man1
422         $siteman3       /usr/local/man/man3
423
424         $vendorbin      /usr/bin
425         $vendorscript   /usr/bin
426         $vendorlib      /usr/lib/perl5/vendor_perl/$version
427         $vendorarch     /usr/lib/perl5/vendor_perl/$version/$archname
428         $vendorman1     /usr/man/man1
429         $vendorman3     /usr/man/man3
430
431 Note how in this example, the vendor-supplied directories are in the
432 /usr hierarchy, while the directories reserved for the end-user are in
433 the /usr/local hierarchy.
434
435 The entire installed library hierarchy is installed in locations with
436 version numbers, keeping the installations of different versions distinct.
437 However, later installations of Perl can still be configured to search the
438 installed libraries corresponding to compatible earlier versions.
439 See L<"Coexistence with earlier versions of perl5"> below for more details
440 on how Perl can be made to search older version directories.
441
442 Of course you may use these directories however you see fit.  For
443 example, you may wish to use $siteprefix for site-specific files that
444 are stored locally on your own disk and use $vendorprefix for
445 site-specific files that are stored elsewhere on your organization's
446 network.  One way to do that would be something like
447
448         sh Configure -Dsiteprefix=/usr/local -Dvendorprefix=/usr/share/perl
449
450 =item otherlibdirs
451
452 As a final catch-all, Configure also offers an $otherlibdirs
453 variable.  This variable contains a colon-separated list of additional
454 directories to add to @INC.  By default, it will be set to
455 $prefix/site_perl if Configure detects that you have 5.004-era modules
456 installed there.  However, you can set it to anything you like.
457
458 =item Man Pages
459
460 In versions 5.005_57 and earlier, the default was to store module man
461 pages in a version-specific directory, such as
462 /usr/local/lib/perl5/$version/man/man3.  The default for 5.005_58 and
463 after is /usr/local/man/man3 so that most users can find the man pages
464 without resetting MANPATH.
465
466 You can continue to use the old default from the command line with
467
468         sh Configure -Dman3dir=/usr/local/lib/perl5/5.6.0/man/man3
469
470 Some users also prefer to use a .3pm suffix.  You can do that with
471
472         sh Configure -Dman3ext=3pm
473
474 Again, these are just the defaults, and can be changed as you run
475 Configure.
476
477 =item HTML pages
478
479 As of perl5.005_57, the standard perl installation does not do
480 anything with HTML documentation, but that may change in the future.
481 Further, some add-on modules may wish to install HTML documents.  The
482 html Configure variables listed above are provided if you wish to
483 specify where such documents should be placed.  The default is "none",
484 but will likely eventually change to something useful based on user
485 feedback.
486
487 =back
488
489 Some users prefer to append a "/share" to $privlib and $sitelib
490 to emphasize that those directories can be shared among different
491 architectures.
492
493 Note that these are just the defaults.  You can actually structure the
494 directories any way you like.  They don't even have to be on the same
495 filesystem.
496
497 Further details about the installation directories, maintenance and
498 development subversions, and about supporting multiple versions are
499 discussed in L<"Coexistence with earlier versions of perl5"> below.
500
501 If you specify a prefix that contains the string "perl", then the
502 library directory structure is slightly simplified.  Instead of
503 suggesting $prefix/lib/perl5/, Configure will suggest $prefix/lib.
504
505 Thus, for example, if you Configure with
506 -Dprefix=/opt/perl, then the default library directories for 5.6.0 are
507
508     Configure variable  Default value
509         $privlib        /opt/perl/lib/5.6.0
510         $archlib        /opt/perl/lib/5.6.0/$archname
511         $sitelib        /opt/perl/lib/site_perl/5.6.0
512         $sitearch       /opt/perl/lib/site_perl/5.6.0/$archname
513
514 =head2 Changing the installation directory
515
516 Configure distinguishes between the directory in which perl (and its
517 associated files) should be installed and the directory in which it
518 will eventually reside.  For most sites, these two are the same; for
519 sites that use AFS, this distinction is handled automatically.
520 However, sites that use software such as depot to manage software
521 packages, or users building binary packages for distribution may also
522 wish to install perl into a different directory and use that
523 management software to move perl to its final destination.  This
524 section describes how to do that.
525
526 Suppose you want to install perl under the /tmp/perl5 directory.  You
527 could edit config.sh and change all the install* variables to point to
528 /tmp/perl5 instead of /usr/local, or you could simply use the
529 following command line:
530
531         sh Configure -Dinstallprefix=/tmp/perl5
532
533 (replace /tmp/perl5 by a directory of your choice).
534
535 Beware, though, that if you go to try to install new add-on
536 modules, they too will get installed in under '/tmp/perl5' if you
537 follow this example.  The next section shows one way of dealing with
538 that problem.
539
540 =head2 Creating an installable tar archive
541
542 If you need to install perl on many identical systems, it is
543 convenient to compile it once and create an archive that can be
544 installed on multiple systems.  Suppose, for example, that you want to
545 create an archive that can be installed in /opt/perl.
546 Here's one way to do that:
547
548     # Set up to install perl into a different directory,
549     # e.g. /tmp/perl5 (see previous part).
550     sh Configure -Dinstallprefix=/tmp/perl5 -Dprefix=/opt/perl -des
551     make
552     make test
553     make install   # This will install everything into /tmp/perl5.
554     cd /tmp/perl5
555     # Edit $archlib/Config.pm and $archlib/.packlist to change all the
556     # install* variables back to reflect where everything will
557     # really be installed.  (That is, change /tmp/perl5 to /opt/perl
558     # everywhere in those files.)
559     # Check the scripts in $scriptdir to make sure they have the correct
560     # #!/wherever/perl line.
561     tar cvf ../perl5-archive.tar .
562     # Then, on each machine where you want to install perl,
563     cd /opt/perl # Or wherever you specified as $prefix
564     tar xvf perl5-archive.tar
565
566 =head2 Site-wide Policy settings
567
568 After Configure runs, it stores a number of common site-wide "policy"
569 answers (such as installation directories and the local perl contact
570 person) in the Policy.sh file.  If you want to build perl on another
571 system using the same policy defaults, simply copy the Policy.sh file
572 to the new system and Configure will use it along with the appropriate
573 hint file for your system.
574
575 Alternatively, if you wish to change some or all of those policy
576 answers, you should
577
578         rm -f Policy.sh
579
580 to ensure that Configure doesn't re-use them.
581
582 Further information is in the Policy_sh.SH file itself.
583
584 If the generated Policy.sh file is unsuitable, you may freely edit it
585 to contain any valid shell commands.  It will be run just after the
586 platform-specific hints files.
587
588 Note:  Since the directory hierarchy for 5.6.0 contains a number of
589 new vendor* and site* entries, your Policy.sh file will probably not
590 set them to your desired values.  I encourage you to run Configure
591 interactively to be sure it puts things where you want them.
592
593 =head2 Configure-time Options
594
595 There are several different ways to Configure and build perl for your
596 system.  For most users, the defaults are sensible and will work.
597 Some users, however, may wish to further customize perl.  Here are
598 some of the main things you can change.
599
600 =head2 Threads
601
602 On some platforms, perl5.005 and later can be compiled with
603 experimental support for threads.  To enable this, read the file
604 README.threads, and then try:
605
606         sh Configure -Dusethreads
607
608 Currently, you need to specify -Dusethreads on the Configure command
609 line so that the hint files can make appropriate adjustments.
610
611 The default is to compile without thread support.
612
613 As of v5.5.64, perl has two different internal threads implementations.
614 The 5.005 version (5005threads) and an interpreter-based implementation
615 (ithreads) with one interpreter per thread.  By default, Configure selects
616 ithreads if -Dusethreads is specified.  However, you can select the old
617 5005threads behavior instead by either
618
619         sh Configure -Dusethreads -Duse5005threads
620
621 or by
622         sh Configure -Dusethreads -Uuseithreads
623
624 Eventually (by perl v5.6.0) this internal confusion ought to disappear,
625 and these options may disappear as well.
626
627 =head2 Selecting File IO mechanisms
628
629 Previous versions of perl used the standard IO mechanisms as defined in
630 stdio.h.  Versions 5.003_02 and later of perl allow alternate IO
631 mechanisms via a "PerlIO" abstraction, but the stdio mechanism is still
632 the default and is the only supported mechanism.
633
634 This PerlIO abstraction can be enabled either on the Configure command
635 line with
636
637         sh Configure -Duseperlio
638
639 or interactively at the appropriate Configure prompt.
640
641 If you choose to use the PerlIO abstraction layer, there are two
642 (experimental) possibilities for the underlying IO calls.  These have been
643 tested to some extent on some platforms, but are not guaranteed to work
644 everywhere.
645
646 =over 4
647
648 =item 1.
649
650 AT&T's "sfio".  This has superior performance to stdio.h in many
651 cases, and is extensible by the use of "discipline" modules.  Sfio
652 currently only builds on a subset of the UNIX platforms perl supports.
653 Because the data structures are completely different from stdio, perl
654 extension modules or external libraries may not work.  This
655 configuration exists to allow these issues to be worked on.
656
657 This option requires the 'sfio' package to have been built and installed.
658 A (fairly old) version of sfio is in CPAN.
659
660 You select this option by
661
662         sh Configure -Duseperlio -Dusesfio
663
664 If you have already selected -Duseperlio, and if Configure detects
665 that you have sfio, then sfio will be the default suggested by
666 Configure.
667
668 Note:  On some systems, sfio's iffe configuration script fails to
669 detect that you have an atexit function (or equivalent).  Apparently,
670 this is a problem at least for some versions of Linux and SunOS 4.
671 Configure should detect this problem and warn you about problems with
672 _exit vs. exit.  If you have this problem, the fix is to go back to
673 your sfio sources and correct iffe's guess about atexit.
674
675 There also might be a more recent release of Sfio that fixes your
676 problem.
677
678 =item 2.
679
680 Normal stdio IO, but with all IO going through calls to the PerlIO
681 abstraction layer.  This configuration can be used to check that perl and
682 extension modules have been correctly converted to use the PerlIO
683 abstraction.
684
685 This configuration should work on all platforms (but might not).
686
687 You select this option via:
688
689         sh Configure -Duseperlio -Uusesfio
690
691 If you have already selected -Duseperlio, and if Configure does not
692 detect sfio, then this will be the default suggested by Configure.
693
694 =back
695
696 =head2 Dynamic Loading
697
698 By default, Configure will compile perl to use dynamic loading if
699 your system supports it.  If you want to force perl to be compiled
700 statically, you can either choose this when Configure prompts you or
701 you can use the Configure command line option -Uusedl.
702
703 =head2 Building a shared libperl.so Perl library
704
705 Currently, for most systems, the main perl executable is built by
706 linking the "perl library" libperl.a with perlmain.o, your static
707 extensions (usually just DynaLoader.a) and various extra libraries,
708 such as -lm.
709
710 On some systems that support dynamic loading, it may be possible to
711 replace libperl.a with a shared libperl.so.  If you anticipate building
712 several different perl binaries (e.g. by embedding libperl into
713 different programs, or by using the optional compiler extension), then
714 you might wish to build a shared libperl.so so that all your binaries
715 can share the same library.
716
717 The disadvantages are that there may be a significant performance
718 penalty associated with the shared libperl.so, and that the overall
719 mechanism is still rather fragile with respect to different versions
720 and upgrades.
721
722 In terms of performance, on my test system (Solaris 2.5_x86) the perl
723 test suite took roughly 15% longer to run with the shared libperl.so.
724 Your system and typical applications may well give quite different
725 results.
726
727 The default name for the shared library is typically something like
728 libperl.so.3.2 (for Perl 5.003_02) or libperl.so.302 or simply
729 libperl.so.  Configure tries to guess a sensible naming convention
730 based on your C library name.  Since the library gets installed in a
731 version-specific architecture-dependent directory, the exact name
732 isn't very important anyway, as long as your linker is happy.
733
734 For some systems (mostly SVR4), building a shared libperl is required
735 for dynamic loading to work, and hence is already the default.
736
737 You can elect to build a shared libperl by
738
739         sh Configure -Duseshrplib
740
741 To build a shared libperl, the environment variable controlling shared
742 library search (LD_LIBRARY_PATH in most systems, DYLD_LIBRARY_PATH for
743 NeXTSTEP/OPENSTEP/Darwin, LIBRARY_PATH for BeOS, SHLIB_PATH for
744 HP-UX, LIBPATH for AIX, PATH for Cygwin) must be set up to include
745 the Perl build directory because that's where the shared libperl will
746 be created.  Configure arranges makefile to have the correct shared
747 library search settings.
748
749 However, there are some special cases where manually setting the
750 shared library path might be required.  For example, if you want to run
751 something like the following with the newly-built but not-yet-installed
752 ./perl:
753
754         cd t; ./perl misc/failing_test.t
755 or
756         ./perl -Ilib ~/my_mission_critical_test
757
758 then you need to set up the shared library path explicitly.
759 You can do this with
760
761    LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
762
763 for Bourne-style shells, or
764
765    setenv LD_LIBRARY_PATH `pwd`
766
767 for Csh-style shells.  (This procedure may also be needed if for some
768 unexpected reason Configure fails to set up makefile correctly.)
769
770 You can often recognize failures to build/use a shared libperl from error
771 messages complaining about a missing libperl.so (or libperl.sl in HP-UX),
772 for example:
773 18126:./miniperl: /sbin/loader: Fatal Error: cannot map libperl.so
774
775 There is also an potential problem with the shared perl library if you
776 want to have more than one "flavor" of the same version of perl (e.g.
777 with and without -DDEBUGGING).  For example, suppose you build and
778 install a standard Perl 5.004 with a shared library.  Then, suppose you
779 try to build Perl 5.004 with -DDEBUGGING enabled, but everything else
780 the same, including all the installation directories.  How can you
781 ensure that your newly built perl will link with your newly built
782 libperl.so.4 rather with the installed libperl.so.4?  The answer is
783 that you might not be able to.  The installation directory is encoded
784 in the perl binary with the LD_RUN_PATH environment variable (or
785 equivalent ld command-line option).  On Solaris, you can override that
786 with LD_LIBRARY_PATH; on Linux you can't.  On Digital Unix, you can
787 override LD_LIBRARY_PATH by setting the _RLD_ROOT environment variable
788 to point to the perl build directory.
789
790 The only reliable answer is that you should specify a different
791 directory for the architecture-dependent library for your -DDEBUGGING
792 version of perl.  You can do this by changing all the *archlib*
793 variables in config.sh to point to your new architecture-dependent library.
794
795 =head2 Malloc Issues
796
797 Perl relies heavily on malloc(3) to grow data structures as needed,
798 so perl's performance can be noticeably affected by the performance of
799 the malloc function on your system.  The perl source is shipped with a
800 version of malloc that has been optimized for the typical requests from
801 perl, so there's a chance that it may be both faster and use less memory
802 than your system malloc.
803
804 However, if your system already has an excellent malloc, or if you are
805 experiencing difficulties with extensions that use third-party libraries
806 that call malloc, then you should probably use your system's malloc.
807 (Or, you might wish to explore the malloc flags discussed below.)
808
809 =over 4
810
811 =item Using the system malloc
812
813 To build without perl's malloc, you can use the Configure command
814
815         sh Configure -Uusemymalloc
816
817 or you can answer 'n' at the appropriate interactive Configure prompt.
818
819 =item -DPERL_POLLUTE_MALLOC
820
821 NOTE: This flag is enabled automatically on some platforms if you
822 asked for binary compatibility with version 5.005, or if you just
823 run Configure to accept all the defaults on those platforms.  You
824 can refuse the automatic binary compatibility flags wholesale by
825 running:
826
827         sh Configure -Ubincompat5005
828
829 or by answering 'n' at the appropriate prompt.
830
831 Perl's malloc family of functions are called Perl_malloc(),
832 Perl_realloc(), Perl_calloc() and Perl_mfree().  When this flag is
833 not enabled, the names do not clash with the system versions of
834 these functions.
835
836 If enabled, Perl's malloc family of functions will have the same
837 names as the system versions.  This may be sometimes required when you
838 have libraries that like to free() data that may have been allocated
839 by Perl_malloc() and vice versa.
840
841 Note that enabling this option may sometimes lead to duplicate symbols
842 from the linker for malloc et al.  In such cases, the system probably
843 does not allow its malloc functions to be fully replaced with custom
844 versions.
845
846 =back
847
848 =head2 Building a debugging perl
849
850 You can run perl scripts under the perl debugger at any time with
851 B<perl -d your_script>.  If, however, you want to debug perl itself,
852 you probably want to do
853
854         sh Configure -Doptimize='-g'
855
856 This will do two independent things:  First, it will force compilation
857 to use cc -g so that you can use your system's debugger on the
858 executable.  (Note:  Your system may actually require something like
859 cc -g2.  Check your man pages for cc(1) and also any hint file for
860 your system.)  Second, it will add -DDEBUGGING to your ccflags
861 variable in config.sh so that you can use B<perl -D> to access perl's
862 internal state.  (Note: Configure will only add -DDEBUGGING by default
863 if you are not reusing your old config.sh.  If you want to reuse your
864 old config.sh, then you can just edit it and change the optimize and
865 ccflags variables by hand and then propagate your changes as shown in
866 L<"Propagating your changes to config.sh"> below.)
867
868 You can actually specify -g and -DDEBUGGING independently, but usually
869 it's convenient to have both.
870
871 If you are using a shared libperl, see the warnings about multiple
872 versions of perl under L<Building a shared libperl.so Perl library>.
873
874 =head2 Extensions
875
876 By default, Configure will offer to build every extension which appears
877 to be supported.  For example, Configure will offer to build GDBM_File
878 only if it is able to find the gdbm library.  (See examples below.)
879 B, DynaLoader, Fcntl, IO, and attrs are always built by default.
880 Configure does not contain code to test for POSIX compliance, so POSIX
881 is always built by default as well.  If you wish to skip POSIX, you can
882 set the Configure variable useposix=false either in a hint file or from
883 the Configure command line.  Similarly, the Opcode extension is always
884 built by default, but you can skip it by setting the Configure variable
885 useopcode=false either in a hint file for from the command line.
886
887 If you unpack any additional extensions in the ext/ directory before
888 running Configure, then Configure will offer to build those additional
889 extensions as well.  Most users probably shouldn't have to do this --
890 it is usually easier to build additional extensions later after perl
891 has been installed.  However, if you wish to have those additional
892 extensions statically linked into the perl binary, then this offers a
893 convenient way to do that in one step.  (It is not necessary, however;
894 you can build and install extensions just fine even if you don't have
895 dynamic loading.  See lib/ExtUtils/MakeMaker.pm for more details.)
896
897 You can learn more about each of the supplied extensions by consulting the
898 documentation in the individual .pm modules, located under the
899 ext/ subdirectory.
900
901 Even if you do not have dynamic loading, you must still build the
902 DynaLoader extension; you should just build the stub dl_none.xs
903 version.  (Configure will suggest this as the default.)
904
905 In summary, here are the Configure command-line variables you can set
906 to turn off each extension:
907
908     B                   (Always included by default)
909     DB_File             i_db
910     DynaLoader          (Must always be included as a static extension)
911     Fcntl               (Always included by default)
912     GDBM_File           i_gdbm
913     IO                  (Always included by default)
914     NDBM_File           i_ndbm
915     ODBM_File           i_dbm
916     POSIX               useposix
917     SDBM_File           (Always included by default)
918     Opcode              useopcode
919     Socket              d_socket
920     Threads             use5005threads
921     attrs               (Always included by default)
922
923 Thus to skip the NDBM_File extension, you can use
924
925         sh Configure -Ui_ndbm
926
927 Again, this is taken care of automatically if you don't have the ndbm
928 library.
929
930 Of course, you may always run Configure interactively and select only
931 the extensions you want.
932
933 Note:  The DB_File module will only work with version 1.x of Berkeley
934 DB or newer releases of version 2.  Configure will automatically detect
935 this for you and refuse to try to build DB_File with earlier
936 releases of version 2.
937
938 If you re-use your old config.sh but change your system (e.g. by
939 adding libgdbm) Configure will still offer your old choices of extensions
940 for the default answer, but it will also point out the discrepancy to
941 you.
942
943 Finally, if you have dynamic loading (most modern Unix systems do)
944 remember that these extensions do not increase the size of your perl
945 executable, nor do they impact start-up time, so you probably might as
946 well build all the ones that will work on your system.
947
948 =head2 Including locally-installed libraries
949
950 Perl5 comes with interfaces to number of database extensions, including
951 dbm, ndbm, gdbm, and Berkeley db.  For each extension, if
952 Configure can find the appropriate header files and libraries, it will
953 automatically include that extension.  The gdbm and db libraries
954 are not included with perl.  See the library documentation for
955 how to obtain the libraries.
956
957 If your database header (.h) files are not in a directory normally
958 searched by your C compiler, then you will need to include the
959 appropriate -I/your/directory option when prompted by Configure.  If
960 your database library (.a) files are not in a directory normally
961 searched by your C compiler and linker, then you will need to include
962 the appropriate -L/your/directory option when prompted by Configure.
963 See the examples below.
964
965 =head2 Examples
966
967 =over 4
968
969 =item gdbm in /usr/local
970
971 Suppose you have gdbm and want Configure to find it and build the
972 GDBM_File extension.  This example assumes you have gdbm.h
973 installed in /usr/local/include/gdbm.h and libgdbm.a installed in
974 /usr/local/lib/libgdbm.a.  Configure should figure all the
975 necessary steps out automatically.
976
977 Specifically, when Configure prompts you for flags for
978 your C compiler, you should include  -I/usr/local/include.
979
980 When Configure prompts you for linker flags, you should include
981 -L/usr/local/lib.
982
983 If you are using dynamic loading, then when Configure prompts you for
984 linker flags for dynamic loading, you should again include
985 -L/usr/local/lib.
986
987 Again, this should all happen automatically.  This should also work if
988 you have gdbm installed in any of (/usr/local, /opt/local, /usr/gnu,
989 /opt/gnu, /usr/GNU, or /opt/GNU).
990
991 =item gdbm in /usr/you
992
993 Suppose you have gdbm installed in some place other than /usr/local/,
994 but you still want Configure to find it.  To be specific, assume you
995 have /usr/you/include/gdbm.h and /usr/you/lib/libgdbm.a.  You
996 still have to add -I/usr/you/include to cc flags, but you have to take
997 an extra step to help Configure find libgdbm.a.  Specifically, when
998 Configure prompts you for library directories, you have to add
999 /usr/you/lib to the list.
1000
1001 It is possible to specify this from the command line too (all on one
1002 line):
1003
1004         sh Configure -de \
1005                 -Dlocincpth="/usr/you/include" \
1006                 -Dloclibpth="/usr/you/lib"
1007
1008 locincpth is a space-separated list of include directories to search.
1009 Configure will automatically add the appropriate -I directives.
1010
1011 loclibpth is a space-separated list of library directories to search.
1012 Configure will automatically add the appropriate -L directives.  If
1013 you have some libraries under /usr/local/ and others under
1014 /usr/you, then you have to include both, namely
1015
1016         sh Configure -de \
1017                 -Dlocincpth="/usr/you/include /usr/local/include" \
1018                 -Dloclibpth="/usr/you/lib /usr/local/lib"
1019
1020 =back
1021
1022 =head2 What if it doesn't work?
1023
1024 If you run into problems, try some of the following ideas.
1025 If none of them help, then see L<"Reporting Problems"> below.
1026
1027 =over 4
1028
1029 =item Running Configure Interactively
1030
1031 If Configure runs into trouble, remember that you can always run
1032 Configure interactively so that you can check (and correct) its
1033 guesses.
1034
1035 All the installation questions have been moved to the top, so you don't
1036 have to wait for them.  Once you've handled them (and your C compiler and
1037 flags) you can type  &-d  at the next Configure prompt and Configure
1038 will use the defaults from then on.
1039
1040 If you find yourself trying obscure command line incantations and
1041 config.over tricks, I recommend you run Configure interactively
1042 instead.  You'll probably save yourself time in the long run.
1043
1044 =item Hint files
1045
1046 The perl distribution includes a number of system-specific hints files
1047 in the hints/ directory.  If one of them matches your system, Configure
1048 will offer to use that hint file.
1049
1050 Several of the hint files contain additional important information.
1051 If you have any problems, it is a good idea to read the relevant hint file
1052 for further information.  See hints/solaris_2.sh for an extensive example.
1053 More information about writing good hints is in the hints/README.hints
1054 file.
1055
1056 =item *** WHOA THERE!!! ***
1057
1058 Occasionally, Configure makes a wrong guess.  For example, on SunOS
1059 4.1.3, Configure incorrectly concludes that tzname[] is in the
1060 standard C library.  The hint file is set up to correct for this.  You
1061 will see a message:
1062
1063     *** WHOA THERE!!! ***
1064         The recommended value for $d_tzname on this machine was "undef"!
1065         Keep the recommended value? [y]
1066
1067 You should always keep the recommended value unless, after reading the
1068 relevant section of the hint file, you are sure you want to try
1069 overriding it.
1070
1071 If you are re-using an old config.sh, the word "previous" will be
1072 used instead of "recommended".  Again, you will almost always want
1073 to keep the previous value, unless you have changed something on your
1074 system.
1075
1076 For example, suppose you have added libgdbm.a to your system
1077 and you decide to reconfigure perl to use GDBM_File.  When you run
1078 Configure again, you will need to add -lgdbm to the list of libraries.
1079 Now, Configure will find your gdbm include file and library and will
1080 issue a message:
1081
1082     *** WHOA THERE!!! ***
1083         The previous value for $i_gdbm on this machine was "undef"!
1084         Keep the previous value? [y]
1085
1086 In this case, you do not want to keep the previous value, so you
1087 should answer 'n'.  (You'll also have to manually add GDBM_File to
1088 the list of dynamic extensions to build.)
1089
1090 =item Changing Compilers
1091
1092 If you change compilers or make other significant changes, you should
1093 probably not re-use your old config.sh.  Simply remove it or
1094 rename it, e.g. mv config.sh config.sh.old.  Then rerun Configure
1095 with the options you want to use.
1096
1097 This is a common source of problems.  If you change from cc to
1098 gcc, you should almost always remove your old config.sh.
1099
1100 =item Propagating your changes to config.sh
1101
1102 If you make any changes to config.sh, you should propagate
1103 them to all the .SH files by running
1104
1105         sh Configure -S
1106
1107 You will then have to rebuild by running
1108
1109         make depend
1110         make
1111
1112 =item config.over
1113
1114 You can also supply a shell script config.over to over-ride Configure's
1115 guesses.  It will get loaded up at the very end, just before config.sh
1116 is created.  You have to be careful with this, however, as Configure
1117 does no checking that your changes make sense.
1118
1119 =item config.h
1120
1121 Many of the system dependencies are contained in config.h.
1122 Configure builds config.h by running the config_h.SH script.
1123 The values for the variables are taken from config.sh.
1124
1125 If there are any problems, you can edit config.h directly.  Beware,
1126 though, that the next time you run Configure, your changes will be
1127 lost.
1128
1129 =item cflags
1130
1131 If you have any additional changes to make to the C compiler command
1132 line, they can be made in cflags.SH.  For instance, to turn off the
1133 optimizer on toke.c, find the line in the switch structure for
1134 toke.c and put the command optimize='-g' before the ;; .  You
1135 can also edit cflags directly, but beware that your changes will be
1136 lost the next time you run Configure.
1137
1138 To explore various ways of changing ccflags from within a hint file,
1139 see the file hints/README.hints.
1140
1141 To change the C flags for all the files, edit config.sh and change either
1142 $ccflags or $optimize, and then re-run
1143
1144         sh Configure -S
1145         make depend
1146
1147 =item No sh
1148
1149 If you don't have sh, you'll have to copy the sample file
1150 Porting/config.sh to config.sh and edit your config.sh to reflect your
1151 system's peculiarities.  See Porting/pumpkin.pod for more information.
1152 You'll probably also have to extensively modify the extension building
1153 mechanism.
1154
1155 =item Environment variable clashes
1156
1157 Configure uses a CONFIG variable that is reported to cause trouble on
1158 ReliantUnix 5.44.  If your system sets this variable, you can try
1159 unsetting it before you run Configure.  Configure should eventually
1160 be fixed to avoid polluting the namespace of the environment.
1161
1162 =item Digital UNIX/Tru64 UNIX and BIN_SH
1163
1164 In Digital UNIX/Tru64 UNIX, Configure might abort with
1165
1166 Build a threading Perl? [n]
1167 Configure[2437]: Syntax error at line 1 : `config.sh' is not expected.
1168
1169 This indicates that Configure is being run with a broken Korn shell
1170 (even though you think you are using a Bourne shell by using
1171 "sh Configure" or "./Configure").  The Korn shell bug has been reported
1172 to Compaq as of February 1999 but in the meanwhile, the reason ksh is
1173 being used is that you have the environment variable BIN_SH set to
1174 'xpg4'.  This causes /bin/sh to delegate its duties to /bin/posix/sh
1175 (a ksh).  Unset the environment variable and rerun Configure.
1176
1177 =item HP-UX 11, pthreads, and libgdbm
1178
1179 If you are running Configure with -Dusethreads in HP-UX 11, be warned
1180 that POSIX threads and libgdbm (the GNU dbm library) compiled before
1181 HP-UX 11 do not mix.  This will cause a basic test run by Configure to
1182 fail
1183
1184 Pthread internal error: message: __libc_reinit() failed, file: ../pthreads/pthread.c, line: 1096
1185 Return Pointer is 0xc082bf33
1186 sh: 5345 Quit(coredump)
1187
1188 and Configure will give up.  The cure is to recompile and install
1189 libgdbm under HP-UX 11.
1190
1191 =item Porting information
1192
1193 Specific information for the OS/2, Plan9, VMS and Win32 ports is in the
1194 corresponding README files and subdirectories.  Additional information,
1195 including a glossary of all those config.sh variables, is in the Porting
1196 subdirectory.  Especially Porting/Glossary should come in handy.
1197
1198 Ports for other systems may also be available.  You should check out
1199 http://www.perl.com/CPAN/ports for current information on ports to
1200 various other operating systems.
1201
1202 If you plan to port Perl to a new architecture study carefully the
1203 section titled "Philosophical Issues in Patching and Porting Perl"
1204 in the file Porting/pumpkin.pod and the file Porting/patching.pod.
1205 Study also how other non-UNIX ports have solved problems.
1206
1207 =back
1208
1209 =head1 make depend
1210
1211 This will look for all the includes.  The output is stored in makefile.
1212 The only difference between Makefile and makefile is the dependencies at
1213 the bottom of makefile.  If you have to make any changes, you should edit
1214 makefile, not Makefile since the Unix make command reads makefile first.
1215 (On non-Unix systems, the output may be stored in a different file.
1216 Check the value of $firstmakefile in your config.sh if in doubt.)
1217
1218 Configure will offer to do this step for you, so it isn't listed
1219 explicitly above.
1220
1221 =head1 make
1222
1223 This will attempt to make perl in the current directory.
1224
1225 =head2 What if it doesn't work?
1226
1227 If you can't compile successfully, try some of the following ideas.
1228 If none of them help, and careful reading of the error message and
1229 the relevant manual pages on your system doesn't help,
1230 then see L<"Reporting Problems"> below.
1231
1232 =over 4
1233
1234 =item hints
1235
1236 If you used a hint file, try reading the comments in the hint file
1237 for further tips and information.
1238
1239 =item extensions
1240
1241 If you can successfully build miniperl, but the process crashes
1242 during the building of extensions, you should run
1243
1244         make minitest
1245
1246 to test your version of miniperl.
1247
1248 =item locale
1249
1250 If you have any locale-related environment variables set, try unsetting
1251 them.  I have some reports that some versions of IRIX hang while
1252 running B<./miniperl configpm> with locales other than the C locale.
1253 See the discussion under L<"make test"> below about locales and the
1254 whole L<"Locale problems"> section in the file pod/perllocale.pod.
1255 The latter is especially useful if you see something like this
1256
1257         perl: warning: Setting locale failed.
1258         perl: warning: Please check that your locale settings:
1259                 LC_ALL = "En_US",
1260                 LANG = (unset)
1261             are supported and installed on your system.
1262         perl: warning: Falling back to the standard locale ("C").
1263
1264 at Perl startup.
1265
1266 =item varargs
1267
1268 If you get varargs problems with gcc, be sure that gcc is installed
1269 correctly and that you are not passing -I/usr/include to gcc.  When using
1270 gcc, you should probably have i_stdarg='define' and i_varargs='undef'
1271 in config.sh.  The problem is usually solved by running fixincludes
1272 correctly.  If you do change config.sh, don't forget to propagate
1273 your changes (see L<"Propagating your changes to config.sh"> below).
1274 See also the L<"vsprintf"> item below.
1275
1276 =item util.c
1277
1278 If you get error messages such as the following (the exact line
1279 numbers and function name may vary in different versions of perl):
1280
1281     util.c: In function `Perl_form':
1282     util.c:1107: number of arguments doesn't match prototype
1283     proto.h:125: prototype declaration
1284
1285 it might well be a symptom of the gcc "varargs problem".  See the
1286 previous L<"varargs"> item.
1287
1288 =item Solaris and SunOS dynamic loading
1289
1290 If you have problems with dynamic loading using gcc on SunOS or
1291 Solaris, and you are using GNU as and GNU ld, you may need to add
1292 -B/bin/ (for SunOS) or -B/usr/ccs/bin/ (for Solaris) to your
1293 $ccflags, $ldflags, and $lddlflags so that the system's versions of as
1294 and ld are used.  Note that the trailing '/' is required.
1295 Alternatively, you can use the GCC_EXEC_PREFIX
1296 environment variable to ensure that Sun's as and ld are used.  Consult
1297 your gcc documentation for further information on the -B option and
1298 the GCC_EXEC_PREFIX variable.
1299
1300 One convenient way to ensure you are not using GNU as and ld is to
1301 invoke Configure with
1302
1303     sh Configure -Dcc='gcc -B/usr/ccs/bin/'
1304
1305 for Solaris systems.  For a SunOS system, you must use -B/bin/
1306 instead.
1307
1308 Alternatively, recent versions of GNU ld reportedly work if you
1309 include C<-Wl,-export-dynamic> in the ccdlflags variable in
1310 config.sh.
1311
1312 =item ld.so.1: ./perl: fatal: relocation error:
1313
1314 If you get this message on SunOS or Solaris, and you're using gcc,
1315 it's probably the GNU as or GNU ld problem in the previous item
1316 L<"Solaris and SunOS dynamic loading">.
1317
1318 =item LD_LIBRARY_PATH
1319
1320 If you run into dynamic loading problems, check your setting of
1321 the LD_LIBRARY_PATH environment variable.  If you're creating a static
1322 Perl library (libperl.a rather than libperl.so) it should build
1323 fine with LD_LIBRARY_PATH unset, though that may depend on details
1324 of your local set-up.
1325
1326 =item dlopen: stub interception failed
1327
1328 The primary cause of the 'dlopen: stub interception failed' message is
1329 that the LD_LIBRARY_PATH environment variable includes a directory
1330 which is a symlink to /usr/lib (such as /lib).
1331
1332 The reason this causes a problem is quite subtle.  The file libdl.so.1.0
1333 actually *only* contains functions which generate 'stub interception
1334 failed' errors!  The runtime linker intercepts links to
1335 "/usr/lib/libdl.so.1.0" and links in internal implementation of those
1336 functions instead.  [Thanks to Tim Bunce for this explanation.]
1337
1338 =item nm extraction
1339
1340 If Configure seems to be having trouble finding library functions,
1341 try not using nm extraction.  You can do this from the command line
1342 with
1343
1344         sh Configure -Uusenm
1345
1346 or by answering the nm extraction question interactively.
1347 If you have previously run Configure, you should not reuse your old
1348 config.sh.
1349
1350 =item umask not found
1351
1352 If the build processes encounters errors relating to umask(), the problem
1353 is probably that Configure couldn't find your umask() system call.
1354 Check your config.sh.  You should have d_umask='define'.  If you don't,
1355 this is probably the L<"nm extraction"> problem discussed above.  Also,
1356 try reading the hints file for your system for further information.
1357
1358 =item vsprintf
1359
1360 If you run into problems with vsprintf in compiling util.c, the
1361 problem is probably that Configure failed to detect your system's
1362 version of vsprintf().  Check whether your system has vprintf().
1363 (Virtually all modern Unix systems do.)  Then, check the variable
1364 d_vprintf in config.sh.  If your system has vprintf, it should be:
1365
1366         d_vprintf='define'
1367
1368 If Configure guessed wrong, it is likely that Configure guessed wrong
1369 on a number of other common functions too.  This is probably
1370 the L<"nm extraction"> problem discussed above.
1371
1372 =item do_aspawn
1373
1374 If you run into problems relating to do_aspawn or do_spawn, the
1375 problem is probably that Configure failed to detect your system's
1376 fork() function.  Follow the procedure in the previous item
1377 on L<"nm extraction">.
1378
1379 =item __inet_* errors
1380
1381 If you receive unresolved symbol errors during Perl build and/or test
1382 referring to __inet_* symbols, check to see whether BIND 8.1 is
1383 installed.  It installs a /usr/local/include/arpa/inet.h that refers to
1384 these symbols.  Versions of BIND later than 8.1 do not install inet.h
1385 in that location and avoid the errors.  You should probably update to a
1386 newer version of BIND.  If you can't, you can either link with the
1387 updated resolver library provided with BIND 8.1 or rename
1388 /usr/local/bin/arpa/inet.h during the Perl build and test process to
1389 avoid the problem.
1390
1391 =item #error "No DATAMODEL_NATIVE specified"
1392
1393 This is a common error when trying to build perl on Solaris 2.6 with a
1394 gcc installation from Solaris 2.5 or 2.5.1.  The Solaris header files
1395 changed, so you need to update your gcc installation.  You can either
1396 rerun the fixincludes script from gcc or take the opportunity to
1397 update your gcc installation.
1398
1399 =item Optimizer
1400
1401 If you can't compile successfully, try turning off your compiler's
1402 optimizer.  Edit config.sh and change the line
1403
1404         optimize='-O'
1405
1406 to
1407
1408         optimize=' '
1409
1410 then propagate your changes with B<sh Configure -S> and rebuild
1411 with B<make depend; make>.
1412
1413 =item CRIPPLED_CC
1414
1415 If you still can't compile successfully, try:
1416
1417         sh Configure -Accflags=-DCRIPPLED_CC
1418
1419 This flag simplifies some complicated expressions for compilers that get
1420 indigestion easily.  (Just because you get no errors doesn't mean it
1421 compiled right!)
1422
1423 =item Missing functions
1424
1425 If you have missing routines, you probably need to add some library or
1426 other, or you need to undefine some feature that Configure thought was
1427 there but is defective or incomplete.  Look through config.h for
1428 likely suspects.  If Configure guessed wrong on a number of functions,
1429 you might have the L<"nm extraction"> problem discussed above.
1430
1431 =item toke.c
1432
1433 Some compilers will not compile or optimize the larger files (such as
1434 toke.c) without some extra switches to use larger jump offsets or
1435 allocate larger internal tables.  You can customize the switches for
1436 each file in cflags.  It's okay to insert rules for specific files into
1437 makefile since a default rule only takes effect in the absence of a
1438 specific rule.
1439
1440 =item Missing dbmclose
1441
1442 SCO prior to 3.2.4 may be missing dbmclose().  An upgrade to 3.2.4
1443 that includes libdbm.nfs (which includes dbmclose()) may be available.
1444
1445 =item Note (probably harmless): No library found for -lsomething
1446
1447 If you see such a message during the building of an extension, but
1448 the extension passes its tests anyway (see L<"make test"> below),
1449 then don't worry about the warning message.  The extension
1450 Makefile.PL goes looking for various libraries needed on various
1451 systems; few systems will need all the possible libraries listed.
1452 For example, a system may have -lcposix or -lposix, but it's
1453 unlikely to have both, so most users will see warnings for the one
1454 they don't have.  The phrase 'probably harmless' is intended to
1455 reassure you that nothing unusual is happening, and the build
1456 process is continuing.
1457
1458 On the other hand, if you are building GDBM_File and you get the
1459 message
1460
1461     Note (probably harmless): No library found for -lgdbm
1462
1463 then it's likely you're going to run into trouble somewhere along
1464 the line, since it's hard to see how you can use the GDBM_File
1465 extension without the -lgdbm library.
1466
1467 It is true that, in principle, Configure could have figured all of
1468 this out, but Configure and the extension building process are not
1469 quite that tightly coordinated.
1470
1471 =item sh: ar: not found
1472
1473 This is a message from your shell telling you that the command 'ar'
1474 was not found.  You need to check your PATH environment variable to
1475 make sure that it includes the directory with the 'ar' command.  This
1476 is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin
1477 directory.
1478
1479 =item db-recno failure on tests 51, 53 and 55
1480
1481 Old versions of the DB library (including the DB library which comes
1482 with FreeBSD 2.1) had broken handling of recno databases with modified
1483 bval settings.  Upgrade your DB library or OS.
1484
1485 =item Bad arg length for semctl, is XX, should be ZZZ
1486
1487 If you get this error message from the lib/ipc_sysv test, your System
1488 V IPC may be broken.  The XX typically is 20, and that is what ZZZ
1489 also should be.  Consider upgrading your OS, or reconfiguring your OS
1490 to include the System V semaphores.
1491
1492 =item lib/ipc_sysv........semget: No space left on device
1493
1494 Either your account or the whole system has run out of semaphores.  Or
1495 both.  Either list the semaphores with "ipcs" and remove the unneeded
1496 ones (which ones these are depends on your system and applications)
1497 with "ipcrm -s SEMAPHORE_ID_HERE" or configure more semaphores to your
1498 system.
1499
1500 =item GNU binutils
1501
1502 If you mix GNU binutils (nm, ld, ar) with equivalent vendor-supplied
1503 tools you may be in for some trouble.  For example creating archives
1504 with an old GNU 'ar' and then using a new current vendor-supplied 'ld'
1505 may lead into linking problems.  Either recompile your GNU binutils
1506 under your current operating system release, or modify your PATH not
1507 to include the GNU utils before running Configure, or specify the
1508 vendor-supplied utilities explicitly to Configure, for example by
1509 Configure -Dar=/bin/ar.
1510
1511 =item Miscellaneous
1512
1513 Some additional things that have been reported for either perl4 or perl5:
1514
1515 Genix may need to use libc rather than libc_s, or #undef VARARGS.
1516
1517 NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
1518
1519 UTS may need one or more of -DCRIPPLED_CC, -K or -g, and undef LSTAT.
1520
1521 FreeBSD can fail the lib/ipc_sysv.t test if SysV IPC has not been
1522 configured to the kernel.  Perl tries to detect this, though, and
1523 you will get a message telling what to do.
1524
1525 If you get syntax errors on '(', try -DCRIPPLED_CC.
1526
1527 Machines with half-implemented dbm routines will need to #undef I_ODBM
1528
1529 HP-UX 11 Y2K patch "Y2K-1100 B.11.00.B0125 HP-UX Core OS Year 2000
1530 Patch Bundle" has been reported to break the io/fs test #18 which
1531 tests whether utime() can change timestamps.  The Y2K patch seems to
1532 break utime() so that over NFS the timestamps do not get changed
1533 (on local filesystems utime() still works).
1534
1535 =back
1536
1537 =head1 make test
1538
1539 This will run the regression tests on the perl you just made.  If
1540 'make test' doesn't say "All tests successful" then something went
1541 wrong.  See the file t/README in the t subdirectory.
1542
1543 Note that you can't run the tests in background if this disables
1544 opening of /dev/tty. You can use 'make test-notty' in that case but
1545 a few tty tests will be skipped.
1546
1547 =head2 What if make test doesn't work?
1548
1549 If make test bombs out, just cd to the t directory and run ./TEST
1550 by hand to see if it makes any difference.  If individual tests
1551 bomb, you can run them by hand, e.g.,
1552
1553         ./perl op/groups.t
1554
1555 Another way to get more detailed information about failed tests and
1556 individual subtests is to cd to the t directory and run
1557
1558         ./perl harness
1559
1560 (this assumes that most basic tests succeed, since harness uses
1561 complicated constructs).
1562
1563 You should also read the individual tests to see if there are any helpful
1564 comments that apply to your system.
1565
1566 =over 4
1567
1568 =item locale
1569
1570 Note:  One possible reason for errors is that some external programs
1571 may be broken due to the combination of your environment and the way
1572 B<make test> exercises them.  For example, this may happen if you have
1573 one or more of these environment variables set:  LC_ALL LC_CTYPE
1574 LC_COLLATE LANG.  In some versions of UNIX, the non-English locales
1575 are known to cause programs to exhibit mysterious errors.
1576
1577 If you have any of the above environment variables set, please try
1578
1579         setenv LC_ALL C
1580
1581 (for C shell) or
1582
1583         LC_ALL=C;export LC_ALL
1584
1585 for Bourne or Korn shell) from the command line and then retry
1586 make test.  If the tests then succeed, you may have a broken program that
1587 is confusing the testing.  Please run the troublesome test by hand as
1588 shown above and see whether you can locate the program.  Look for
1589 things like:  exec, `backquoted command`, system, open("|...") or
1590 open("...|").  All these mean that Perl is trying to run some
1591 external program.
1592
1593 =item Out of memory
1594
1595 On some systems, particularly those with smaller amounts of RAM, some
1596 of the tests in t/op/pat.t may fail with an "Out of memory" message.
1597 Specifically, in perl5.004_64, tests 74 and 78 have been reported to
1598 fail on some systems.  On my SparcStation IPC with 8 MB of RAM, test 78
1599 will fail if the system is running any other significant tasks at the
1600 same time.
1601
1602 Try stopping other jobs on the system and then running the test by itself:
1603
1604         cd t; ./perl op/pat.t
1605
1606 to see if you have any better luck.  If your perl still fails this
1607 test, it does not necessarily mean you have a broken perl.  This test
1608 tries to exercise the regular expression subsystem quite thoroughly,
1609 and may well be far more demanding than your normal usage.
1610
1611 =back
1612
1613 =head1 make install
1614
1615 This will put perl into the public directory you specified to
1616 Configure; by default this is /usr/local/bin.  It will also try
1617 to put the man pages in a reasonable place.  It will not nroff the man
1618 pages, however.  You may need to be root to run B<make install>.  If you
1619 are not root, you must own the directories in question and you should
1620 ignore any messages about chown not working.
1621
1622 =head2 Installing perl under different names
1623
1624 If you want to install perl under a name other than "perl" (for example,
1625 when installing perl with special features enabled, such as debugging),
1626 indicate the alternate name on the "make install" line, such as:
1627
1628     make install PERLNAME=myperl
1629
1630 You can separately change the base used for versioned names (like
1631 "perl5.005") by setting PERLNAME_VERBASE, like
1632
1633     make install PERLNAME=perl5 PERLNAME_VERBASE=perl
1634
1635 This can be useful if you have to install perl as "perl5" (due to an
1636 ancient version in /usr/bin supplied by your vendor, eg).  Without this
1637 the versioned binary would be called "perl55.005".
1638
1639 =head2 Installed files
1640
1641 If you want to see exactly what will happen without installing
1642 anything, you can run
1643
1644         ./perl installperl -n
1645         ./perl installman -n
1646
1647 make install will install the following:
1648
1649         perl,
1650             perl5.nnn   where nnn is the current release number.  This
1651                         will be a link to perl.
1652         suidperl,
1653             sperl5.nnn  If you requested setuid emulation.
1654         a2p             awk-to-perl translator
1655         cppstdin        This is used by perl -P, if your cc -E can't
1656                         read from stdin.
1657         c2ph, pstruct   Scripts for handling C structures in header files.
1658         s2p             sed-to-perl translator
1659         find2perl       find-to-perl translator
1660         h2ph            Extract constants and simple macros from C headers
1661         h2xs            Converts C .h header files to Perl extensions.
1662         perlbug         Tool to report bugs in Perl.
1663         perldoc         Tool to read perl's pod documentation.
1664         pl2pm           Convert Perl 4 .pl files to Perl 5 .pm modules
1665         pod2html,       Converters from perl's pod documentation format
1666         pod2latex,      to other useful formats.
1667         pod2man, and
1668         pod2text
1669         splain          Describe Perl warnings and errors
1670         dprofpp         Perl code profile post-processor
1671
1672         library files   in $privlib and $archlib specified to
1673                         Configure, usually under /usr/local/lib/perl5/.
1674         man pages       in $man1dir, usually /usr/local/man/man1.
1675         module man
1676         pages           in $man3dir, usually /usr/local/man/man3.
1677         pod/*.pod       in $privlib/pod/.
1678
1679 Installperl will also create the directories listed above
1680 in L<"Installation Directories">.
1681
1682 Perl's *.h header files and the libperl.a library are also installed
1683 under $archlib so that any user may later build new modules, run the
1684 optional Perl compiler, or embed the perl interpreter into another
1685 program even if the Perl source is no longer available.
1686
1687 =head1 Coexistence with earlier versions of perl5
1688
1689 In general, you can usually safely upgrade from one version of Perl (e.g.
1690 5.004_04) to another similar version (e.g. 5.004_05) without re-compiling
1691 all of your add-on extensions.  You can also safely leave the old version
1692 around in case the new version causes you problems for some reason.
1693 For example, if you want to be sure that your script continues to run
1694 with 5.004_04, simply replace the '#!/usr/local/bin/perl' line at the
1695 top of the script with the particular version you want to run, e.g.
1696 #!/usr/local/bin/perl5.00404.
1697
1698 Most extensions will probably not need to be recompiled to use
1699 with a newer version of perl.   Here is how it is supposed to work.
1700 (These examples assume you accept all the Configure defaults.)
1701
1702 Suppose you already have version 5.005_03 installed.  The directories
1703 searched by 5.005_03 are
1704
1705         /usr/local/lib/perl5/5.00503/$archname
1706         /usr/local/lib/perl5/5.00503
1707         /usr/local/lib/perl5/site_perl/5.005/$archname
1708         /usr/local/lib/perl5/site_perl/5.005
1709
1710 Beginning with 5.6.0 the version number in the site libraries are
1711 fully versioned.  Now, suppose you install version 5.6.0.  The directories
1712 searched by version 5.6.0 will be
1713
1714         /usr/local/lib/perl5/5.6.0/$archname
1715         /usr/local/lib/perl5/5.6.0
1716         /usr/local/lib/perl5/site_perl/5.6.0/$archname
1717         /usr/local/lib/perl5/site_perl/5.6.0
1718
1719         /usr/local/lib/perl5/site_perl/5.005/$archname
1720         /usr/local/lib/perl5/site_perl/5.005
1721         /usr/local/lib/perl5/site_perl/
1722
1723 Notice the last three entries -- Perl understands the default structure
1724 of the $sitelib directories and will look back in older, compatible
1725 directories.  This way, modules installed under 5.005_03 will continue
1726 to be usable by 5.005_03 but will also accessible to 5.6.0.  Further,
1727 suppose that you upgrade a module to one which requires features
1728 present only in 5.6.0.  That new module will get installed into
1729 /usr/local/lib/perl5/site_perl/5.6.0 and will be available to 5.6.0,
1730 but will not interfere with the 5.005_03 version.
1731
1732 The last entry, /usr/local/lib/perl5/site_perl/, is there so that
1733 5.6.0 will look for 5.004-era pure perl modules.
1734
1735 Lastly, suppose you now install version 5.6.1, which we'll assume is
1736 binary compatible with 5.6.0 and 5.005.  The directories searched
1737 by 5.6.1 (if you don't change the Configure defaults) will be:
1738
1739         /usr/local/lib/perl5/5.6.1/$archname
1740         /usr/local/lib/perl5/5.6.1
1741         /usr/local/lib/perl5/site_perl/5.6.1/$archname
1742         /usr/local/lib/perl5/site_perl/5.6.1
1743
1744         /usr/local/lib/perl5/site_perl/5.6.0/$archname
1745         /usr/local/lib/perl5/site_perl/5.6.0
1746
1747         /usr/local/lib/perl5/site_perl/5.005/$archname
1748         /usr/local/lib/perl5/site_perl/5.005
1749         /usr/local/lib/perl5/site_perl/
1750
1751 Assuming the users in your site are still actively using perl 5.6.0 and
1752 5.005 after you installed 5.6.1, you can continue to install add-on
1753 extensions using any of perl 5.6.1, 5.6.0, or 5.005.  The installations
1754 of these different versions remain distinct, but remember that the newer
1755 versions of perl are automatically set up to search the site libraries of
1756 the older ones.  This means that installing a new extension with 5.005
1757 will make it visible to all three versions.  Later, if you install the
1758 same extension using, say, perl 5.6.1, it will override the 5.005-installed
1759 version, but only for perl 5.6.1.
1760
1761 This way, you can choose to share compatible extensions, but also upgrade
1762 to a newer version of an extension that may be incompatible with earlier
1763 versions, without breaking the earlier versions' installations.
1764
1765 =head2 Maintaining completely separate versions
1766
1767 Many users prefer to keep all versions of perl in completely
1768 separate directories.  This guarantees that an update to one version
1769 won't interfere with another version.  (The defaults guarantee this for
1770 libraries after 5.6.0, but not for executables. TODO?)  One convenient
1771 way to do this is by using a separate prefix for each version, such as
1772
1773         sh Configure -Dprefix=/opt/perl5.004
1774
1775 and adding /opt/perl5.004/bin to the shell PATH variable.  Such users
1776 may also wish to add a symbolic link /usr/local/bin/perl so that
1777 scripts can still start with #!/usr/local/bin/perl.
1778
1779 Others might share a common directory for maintenance sub-versions
1780 (e.g. 5.004 for all 5.004_0x versions), but change directory with
1781 each major version.
1782
1783 If you are installing a development subversion, you probably ought to
1784 seriously consider using a separate directory, since development
1785 subversions may not have all the compatibility wrinkles ironed out
1786 yet.
1787
1788 =head2 Upgrading from 5.005 to 5.6.0
1789
1790 Most extensions built and installed with versions of perl
1791 prior to 5.005_50 will not need to be recompiled to be used with
1792 5.6.0.  If you find you do need to rebuild an extension with 5.6.0,
1793 you may safely do so without disturbing the 5.005 installation.
1794 (See L<"Coexistence with earlier versions of perl5"> above.)
1795
1796 See your installed copy of the perllocal.pod file for a (possibly
1797 incomplete) list of locally installed modules.  Note that you want
1798 perllocal.pod not perllocale.pod for installed module information.
1799
1800 =head1 Coexistence with perl4
1801
1802 You can safely install perl5 even if you want to keep perl4 around.
1803
1804 By default, the perl5 libraries go into /usr/local/lib/perl5/, so
1805 they don't override the perl4 libraries in /usr/local/lib/perl/.
1806
1807 In your /usr/local/bin directory, you should have a binary named
1808 perl4.036.  That will not be touched by the perl5 installation
1809 process.  Most perl4 scripts should run just fine under perl5.
1810 However, if you have any scripts that require perl4, you can replace
1811 the #! line at the top of them by #!/usr/local/bin/perl4.036 (or
1812 whatever the appropriate pathname is).  See pod/perltrap.pod for
1813 possible problems running perl4 scripts under perl5.
1814
1815 =head1 cd /usr/include; h2ph *.h sys/*.h
1816
1817 Some perl scripts need to be able to obtain information from the
1818 system header files.  This command will convert the most commonly used
1819 header files in /usr/include into files that can be easily interpreted
1820 by perl.  These files will be placed in the architecture-dependent
1821 library ($archlib) directory you specified to Configure.
1822
1823 Note:  Due to differences in the C and perl languages, the conversion
1824 of the header files is not perfect.  You will probably have to
1825 hand-edit some of the converted files to get them to parse correctly.
1826 For example, h2ph breaks spectacularly on type casting and certain
1827 structures.
1828
1829 =head1 installhtml --help
1830
1831 Some sites may wish to make perl documentation available in HTML
1832 format.  The installhtml utility can be used to convert pod
1833 documentation into linked HTML files and install them.
1834
1835 Currently, the supplied ./installhtml script does not make use of the
1836 html Configure variables.  This should be fixed in a future release.
1837
1838 The following command-line is an example of one used to convert
1839 perl documentation:
1840
1841   ./installhtml                   \
1842       --podroot=.                 \
1843       --podpath=lib:ext:pod:vms   \
1844       --recurse                   \
1845       --htmldir=/perl/nmanual     \
1846       --htmlroot=/perl/nmanual    \
1847       --splithead=pod/perlipc     \
1848       --splititem=pod/perlfunc    \
1849       --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \
1850       --verbose
1851
1852 See the documentation in installhtml for more details.  It can take
1853 many minutes to execute a large installation and you should expect to
1854 see warnings like "no title", "unexpected directive" and "cannot
1855 resolve" as the files are processed. We are aware of these problems
1856 (and would welcome patches for them).
1857
1858 You may find it helpful to run installhtml twice. That should reduce
1859 the number of "cannot resolve" warnings.
1860
1861 =head1 cd pod && make tex && (process the latex files)
1862
1863 Some sites may also wish to make the documentation in the pod/ directory
1864 available in TeX format.  Type
1865
1866         (cd pod && make tex && <process the latex files>)
1867
1868 =head1 Reporting Problems
1869
1870 If you have difficulty building perl, and none of the advice in this file
1871 helps, and careful reading of the error message and the relevant manual
1872 pages on your system doesn't help either, then you should send a message
1873 to either the comp.lang.perl.misc newsgroup or to perlbug@perl.com with
1874 an accurate description of your problem.
1875
1876 Please include the output of the ./myconfig shell script that comes with
1877 the distribution.  Alternatively, you can use the perlbug program that
1878 comes with the perl distribution, but you need to have perl compiled
1879 before you can use it.  (If you have not installed it yet, you need to
1880 run C<./perl -Ilib utils/perlbug> instead of a plain C<perlbug>.)
1881
1882 Please try to make your message brief but clear.  Trim out unnecessary
1883 information.  Do not include large files (such as config.sh or a complete
1884 Configure or make log) unless absolutely necessary.  Do not include a
1885 complete transcript of your build session.  Just include the failing
1886 commands, the relevant error messages, and whatever preceding commands
1887 are necessary to give the appropriate context.  Plain text should
1888 usually be sufficient--fancy attachments or encodings may actually
1889 reduce the number of people who read your message.  Your message
1890 will get relayed to over 400 subscribers around the world so please
1891 try to keep it brief but clear.
1892
1893 =head1 DOCUMENTATION
1894
1895 Read the manual entries before running perl.  The main documentation
1896 is in the pod/ subdirectory and should have been installed during the
1897 build process.  Type B<man perl> to get started.  Alternatively, you
1898 can type B<perldoc perl> to use the supplied perldoc script.  This is
1899 sometimes useful for finding things in the library modules.
1900
1901 Under UNIX, you can produce a documentation book in postscript form,
1902 along with its table of contents, by going to the pod/ subdirectory and
1903 running (either):
1904
1905         ./roffitall -groff              # If you have GNU groff installed
1906         ./roffitall -psroff             # If you have psroff
1907
1908 This will leave you with two postscript files ready to be printed.
1909 (You may need to fix the roffitall command to use your local troff
1910 set-up.)
1911
1912 Note that you must have performed the installation already before running
1913 the above, since the script collects the installed files to generate
1914 the documentation.
1915
1916 =head1 AUTHOR
1917
1918 Original author:  Andy Dougherty doughera@lafayette.edu , borrowing very
1919 heavily from the original README by Larry Wall, with lots of helpful
1920 feedback and additions from the perl5-porters@perl.org folks.
1921
1922 If you have problems, corrections, or questions, please see
1923 L<"Reporting Problems"> above.
1924
1925 =head1 REDISTRIBUTION
1926
1927 This document is part of the Perl package and may be distributed under
1928 the same terms as perl itself, with the following additional request:
1929 If you are distributing a modified version of perl (perhaps as part of
1930 a larger package) please B<do> modify these installation instructions
1931 and the contact information to match your distribution.
1932
1933 =head1 LAST MODIFIED
1934
1935 $Id: INSTALL,v 1.58 1999/07/23 14:43:00 doughera Exp $