OS/2 update
[p5sagit/p5-mst-13.2.git] / INSTALL
1 =head1 NAME
2
3 Install - Build and Installation guide for perl5.
4
5 =head1 SYNOPSIS
6
7 The basic steps to build and install perl5 on a Unix system are:
8
9         rm -f config.sh Policy.sh
10         sh Configure
11         make
12         make test
13         make install
14
15         # You may also wish to add these:
16         (cd /usr/include && h2ph *.h sys/*.h)
17         (installhtml --help)
18         (cd pod && make tex  && <process the latex files>)
19
20 Each of these is explained in further detail below.
21
22 For information on non-Unix systems, see the section on
23 L<"Porting information"> below.
24
25 For information on what's new in this release, see the
26 pod/perldelta.pod file.  For more detailed information about specific
27 changes, see the Changes file.
28
29 =head1 DESCRIPTION
30
31 This document is written in pod format as an easy way to indicate its
32 structure.  The pod format is described in pod/perlpod.pod, but you can
33 read it as is with any pager or editor.  Headings and items are marked
34 by lines beginning with '='.  The other mark-up used is
35
36     B<text>     embolden text, used for switches, programs or commands
37     C<code>     literal code
38     L<name>     A link (cross reference) to name
39
40 You should probably at least skim through this entire document before
41 proceeding.
42
43 If you're building Perl on a non-Unix system, you should also read
44 the README file specific to your operating system, since this may
45 provide additional or different instructions for building Perl.
46
47 If there is a hint file for your system (in the hints/ directory) you
48 should also read that hint file for specific information for your
49 system.  (Unixware users should use the svr4.sh hint file.)
50
51 =head1 WARNING:  This version is not binary compatible with Perl 5.004.
52
53 Starting with Perl 5.004_50 there were many deep and far-reaching changes
54 to the language internals.  If you have dynamically loaded extensions
55 that you built under perl 5.003 or 5.004, you can continue to use them
56 with 5.004, but you will need to rebuild and reinstall those extensions
57 to use them 5.005.  See the discussions below on
58 L<"Coexistence with earlier versions of perl5"> and
59 L<"Upgrading from 5.004 to 5.005"> for more details.
60
61 The standard extensions supplied with Perl will be handled automatically.
62
63 In a related issue, old extensions may possibly be affected by the
64 changes in the Perl language in the current release.  Please see
65 pod/perldelta.pod for a description of what's changed.
66
67 =head1 Space Requirements
68
69 The complete perl5 source tree takes up about 10 MB of disk space.  The
70 complete tree after completing make takes roughly 20 MB, though the
71 actual total is likely to be quite system-dependent.  The installation
72 directories need something on the order of 10 MB, though again that
73 value is system-dependent.
74
75 =head1 Start with a Fresh Distribution
76
77 If you have built perl before, you should clean out the build directory
78 with the command
79
80         make distclean
81
82 or
83
84         make realclean
85
86 The only difference between the two is that make distclean also removes
87 your old config.sh and Policy.sh files.
88
89 The results of a Configure run are stored in the config.sh and Policy.sh
90 files.  If you are upgrading from a previous version of perl, or if you
91 change systems or compilers or make other significant changes, or if
92 you are experiencing difficulties building perl, you should probably
93 not re-use your old config.sh.  Simply remove it or rename it, e.g.
94
95         mv config.sh config.sh.old
96
97 If you wish to use your old config.sh, be especially attentive to the
98 version and architecture-specific questions and answers.  For example,
99 the default directory for architecture-dependent library modules
100 includes the version name.  By default, Configure will reuse your old
101 name (e.g. /opt/perl/lib/i86pc-solaris/5.003) even if you're running
102 Configure for a different version, e.g. 5.004.  Yes, Configure should
103 probably check and correct for this, but it doesn't, presently.
104 Similarly, if you used a shared libperl.so (see below) with version
105 numbers, you will probably want to adjust them as well.
106
107 Also, be careful to check your architecture name.  Some Linux systems
108 (such as Debian) use i386, while others may use i486, i586, or i686.
109 If you pick up a precompiled binary, it might not use the same name.
110
111 In short, if you wish to use your old config.sh, I recommend running
112 Configure interactively rather than blindly accepting the defaults.
113
114 If your reason to reuse your old config.sh is to save your
115 particular installation choices, then you can probably achieve the
116 same effect by using the new Policy.sh file.  See the section on
117 L<"Site-wide Policy settings"> below.
118
119 =head1 Run Configure
120
121 Configure will figure out various things about your system.  Some
122 things Configure will figure out for itself, other things it will ask
123 you about.  To accept the default, just press RETURN.   The default
124 is almost always okay.  At any Configure prompt, you can type  &-d
125 and Configure will use the defaults from then on.
126
127 After it runs, Configure will perform variable substitution on all the
128 *.SH files and offer to run make depend.
129
130 Configure supports a number of useful options.  Run B<Configure -h> to
131 get a listing.  See the Porting/Glossary file for a complete list of
132 Configure variables you can set and their definitions.
133
134 To compile with gcc, for example, you should run
135
136         sh Configure -Dcc=gcc
137
138 This is the preferred way to specify gcc (or another alternative
139 compiler) so that the hints files can set appropriate defaults.
140
141 If you want to use your old config.sh but override some of the items
142 with command line options, you need to use B<Configure -O>.
143
144 By default, for most systems, perl will be installed in
145 /usr/local/{bin, lib, man}.  You can specify a different 'prefix' for
146 the default installation directory, when Configure prompts you or by
147 using the Configure command line option -Dprefix='/some/directory',
148 e.g.
149
150         sh Configure -Dprefix=/opt/perl
151
152 If your prefix contains the string "perl", then the directories
153 are simplified.  For example, if you use prefix=/opt/perl,
154 then Configure will suggest /opt/perl/lib instead of
155 /opt/perl/lib/perl5/.
156
157 NOTE:  You must not specify an installation directory that is below
158 your perl source directory.  If you do, installperl will attempt
159 infinite recursion.
160
161 It may seem obvious to say, but Perl is useful only when users can
162 easily find it.  It's often a good idea to have both /usr/bin/perl and
163 /usr/local/bin/perl be symlinks to the actual binary.  Be especially
164 careful, however, of overwriting a version of perl supplied by your
165 vendor.  In any case, system administrators are strongly encouraged to
166 put (symlinks to) perl and its accompanying utilities, such as perldoc,
167 into a directory typically found along a user's PATH, or in another
168 obvious and convenient place.
169
170 By default, Configure will compile perl to use dynamic loading if
171 your system supports it.  If you want to force perl to be compiled
172 statically, you can either choose this when Configure prompts you or
173 you can use the Configure command line option -Uusedl.
174
175 If you are willing to accept all the defaults, and you want terse
176 output, you can run
177
178         sh Configure -des
179
180 For my Solaris system, I usually use
181
182         sh Configure -Dprefix=/opt/perl -Doptimize='-xpentium -xO4' -des
183
184 =head2 GNU-style configure
185
186 If you prefer the GNU-style configure command line interface, you can
187 use the supplied configure.gnu command, e.g.
188
189         CC=gcc ./configure.gnu
190
191 The configure.gnu script emulates a few of the more common configure
192 options.  Try
193
194         ./configure.gnu --help
195
196 for a listing.
197
198 Cross compiling is not supported.
199
200 (The file is called configure.gnu to avoid problems on systems
201 that would not distinguish the files "Configure" and "configure".)
202
203 =head2 Extensions
204
205 By default, Configure will offer to build every extension which appears
206 to be supported.  For example, Configure will offer to build GDBM_File
207 only if it is able to find the gdbm library.  (See examples below.)
208 B, DynaLoader, Fcntl, IO, and attrs are always built by default.
209 Configure does not contain code to test for POSIX compliance, so POSIX
210 is always built by default as well.  If you wish to skip POSIX, you can
211 set the Configure variable useposix=false either in a hint file or from
212 the Configure command line.  Similarly, the Opcode extension is always
213 built by default, but you can skip it by setting the Configure variable
214 useopcode=false either in a hint file for from the command line.
215
216 You can learn more about each of these extensions by consulting the
217 documentation in the individual .pm modules, located under the
218 ext/ subdirectory.
219
220 Even if you do not have dynamic loading, you must still build the
221 DynaLoader extension; you should just build the stub dl_none.xs
222 version.  (Configure will suggest this as the default.)
223
224 In summary, here are the Configure command-line variables you can set
225 to turn off each extension:
226
227     B                   (Always included by default)
228     DB_File             i_db
229     DynaLoader          (Must always be included as a static extension)
230     Fcntl               (Always included by default)
231     GDBM_File           i_gdbm
232     IO                  (Always included by default)
233     NDBM_File           i_ndbm
234     ODBM_File           i_dbm
235     POSIX               useposix
236     SDBM_File           (Always included by default)
237     Opcode              useopcode
238     Socket              d_socket
239     Threads             usethreads
240     attrs               (Always included by default)
241
242 Thus to skip the NDBM_File extension, you can use
243
244         sh Configure -Ui_ndbm
245
246 Again, this is taken care of automatically if you don't have the ndbm
247 library.
248
249 Of course, you may always run Configure interactively and select only
250 the extensions you want.
251
252 Note:  The DB_File module will only work with version 1.x of Berkeley
253 DB or newer releases of version 2.  Configure will automatically detect
254 this for you and refuse to try to build DB_File with version 2.
255
256 If you re-use your old config.sh but change your system (e.g. by
257 adding libgdbm) Configure will still offer your old choices of extensions
258 for the default answer, but it will also point out the discrepancy to
259 you.
260
261 Finally, if you have dynamic loading (most modern Unix systems do)
262 remember that these extensions do not increase the size of your perl
263 executable, nor do they impact start-up time, so you probably might as
264 well build all the ones that will work on your system.
265
266 =head2 Including locally-installed libraries
267
268 Perl5 comes with interfaces to number of database extensions, including
269 dbm, ndbm, gdbm, and Berkeley db.  For each extension, if
270 Configure can find the appropriate header files and libraries, it will
271 automatically include that extension.  The gdbm and db libraries
272 are not included with perl.  See the library documentation for
273 how to obtain the libraries.
274
275 Note:  If your database header (.h) files are not in a
276 directory normally searched by your C compiler, then you will need to
277 include the appropriate -I/your/directory option when prompted by
278 Configure.  If your database library (.a) files are not in a directory
279 normally searched by your C compiler and linker, then you will need to
280 include the appropriate -L/your/directory option when prompted by
281 Configure.  See the examples below.
282
283 =head2 Examples
284
285 =over 4
286
287 =item gdbm in /usr/local
288
289 Suppose you have gdbm and want Configure to find it and build the
290 GDBM_File extension.  This examples assumes you have gdbm.h
291 installed in /usr/local/include/gdbm.h and libgdbm.a installed in
292 /usr/local/lib/libgdbm.a.  Configure should figure all the
293 necessary steps out automatically.
294
295 Specifically, when Configure prompts you for flags for
296 your C compiler, you should include  -I/usr/local/include.
297
298 When Configure prompts you for linker flags, you should include
299 -L/usr/local/lib.
300
301 If you are using dynamic loading, then when Configure prompts you for
302 linker flags for dynamic loading, you should again include
303 -L/usr/local/lib.
304
305 Again, this should all happen automatically.  If you want to accept the
306 defaults for all the questions and have Configure print out only terse
307 messages, then you can just run
308
309         sh Configure -des
310
311 and Configure should include the GDBM_File extension automatically.
312
313 This should actually work if you have gdbm installed in any of
314 (/usr/local, /opt/local, /usr/gnu, /opt/gnu, /usr/GNU, or /opt/GNU).
315
316 =item gdbm in /usr/you
317
318 Suppose you have gdbm installed in some place other than /usr/local/,
319 but you still want Configure to find it.  To be specific, assume you
320 have /usr/you/include/gdbm.h and /usr/you/lib/libgdbm.a.  You
321 still have to add -I/usr/you/include to cc flags, but you have to take
322 an extra step to help Configure find libgdbm.a.  Specifically, when
323 Configure prompts you for library directories, you have to add
324 /usr/you/lib to the list.
325
326 It is possible to specify this from the command line too (all on one
327 line):
328
329         sh Configure -des \
330                 -Dlocincpth="/usr/you/include" \
331                 -Dloclibpth="/usr/you/lib"
332
333 locincpth is a space-separated list of include directories to search.
334 Configure will automatically add the appropriate -I directives.
335
336 loclibpth is a space-separated list of library directories to search.
337 Configure will automatically add the appropriate -L directives.  If
338 you have some libraries under /usr/local/ and others under
339 /usr/you, then you have to include both, namely
340
341         sh Configure -des \
342                 -Dlocincpth="/usr/you/include /usr/local/include" \
343                 -Dloclibpth="/usr/you/lib /usr/local/lib"
344
345 =back
346
347 =head2 Installation Directories
348
349 The installation directories can all be changed by answering the
350 appropriate questions in Configure.  For convenience, all the
351 installation questions are near the beginning of Configure.
352
353 I highly recommend running Configure interactively to be sure it puts
354 everything where you want it.  At any point during the Configure
355 process, you can answer a question with  &-d  and Configure
356 will use the defaults from then on.
357
358 By default, Configure will use the following directories for library files
359 for 5.005 (archname is a string like sun4-sunos, determined by Configure).
360
361     Configure variable          Default value
362         $archlib        /usr/local/lib/perl5/5.005/archname
363         $privlib        /usr/local/lib/perl5/5.005
364         $sitearch       /usr/local/lib/perl5/site_perl/5.005/archname
365         $sitelib        /usr/local/lib/perl5/site_perl/5.005
366
367 Some users prefer to append a "/share" to $privlib and $sitelib
368 to emphasize that those directories can be shared among different
369 architectures.
370
371 By default, Configure will use the following directories for manual pages:
372
373     Configure variable          Default value
374         $man1dir        /usr/local/man/man1
375         $man3dir        /usr/local/lib/perl5/man/man3
376
377 (Actually, Configure recognizes the SVR3-style
378 /usr/local/man/l_man/man1 directories, if present, and uses those
379 instead.)
380
381 The module man pages are stuck in that strange spot so that
382 they don't collide with other man pages stored in /usr/local/man/man3,
383 and so that Perl's man pages don't hide system man pages.  On some
384 systems, B<man less> would end up calling up Perl's less.pm module man
385 page, rather than the less program.  (This default location will likely
386 change to /usr/local/man/man3 in a future release of perl.)
387
388 Note:  Many users prefer to store the module man pages in
389 /usr/local/man/man3.  You can do this from the command line with
390
391         sh Configure -Dman3dir=/usr/local/man/man3
392
393 Some users also prefer to use a .3pm suffix.  You can do that with
394
395         sh Configure -Dman3ext=3pm
396
397 If you specify a prefix that contains the string "perl", then the
398 directory structure is simplified.  For example, if you Configure with
399 -Dprefix=/opt/perl, then the defaults for 5.005 are
400
401     Configure variable          Default value
402         $archlib        /opt/perl/lib/5.005/archname
403         $privlib        /opt/perl/lib/5.005
404         $sitearch       /opt/perl/lib/site_perl/5.005/archname
405         $sitelib        /opt/perl/lib/site_perl/5.005
406
407         $man1dir        /opt/perl/man/man1
408         $man3dir        /opt/perl/man/man3
409
410 The perl executable will search the libraries in the order given
411 above.
412
413 The directories under site_perl are empty, but are intended to be used
414 for installing local or site-wide extensions.  Perl will automatically
415 look in these directories.
416
417 In order to support using things like #!/usr/local/bin/perl5.005 after
418 a later version is released, architecture-dependent libraries are
419 stored in a version-specific directory, such as
420 /usr/local/lib/perl5/archname/5.005/.
421
422 Further details about the installation directories, maintenance and
423 development subversions, and about supporting multiple versions are
424 discussed in L<"Coexistence with earlier versions of perl5"> below.
425
426 Again, these are just the defaults, and can be changed as you run
427 Configure.
428
429 =head2 Changing the installation directory
430
431 Configure distinguishes between the directory in which perl (and its
432 associated files) should be installed and the directory in which it
433 will eventually reside.  For most sites, these two are the same; for
434 sites that use AFS, this distinction is handled automatically.
435 However, sites that use software such as depot to manage software
436 packages may also wish to install perl into a different directory and
437 use that management software to move perl to its final destination.
438 This section describes how to do this.  Someday, Configure may support
439 an option -Dinstallprefix=/foo to simplify this.
440
441 Suppose you want to install perl under the /tmp/perl5 directory.  You
442 can edit config.sh and change all the install* variables to point to
443 /tmp/perl5 instead of /usr/local/wherever.  Or, you can automate this
444 process by placing the following lines in a file config.over before you
445 run Configure (replace /tmp/perl5 by a directory of your choice):
446
447     installprefix=/tmp/perl5
448     test -d $installprefix || mkdir $installprefix
449     test -d $installprefix/bin || mkdir $installprefix/bin
450     installarchlib=`echo $installarchlib | sed "s!$prefix!$installprefix!"`
451     installbin=`echo $installbin | sed "s!$prefix!$installprefix!"`
452     installman1dir=`echo $installman1dir | sed "s!$prefix!$installprefix!"`
453     installman3dir=`echo $installman3dir | sed "s!$prefix!$installprefix!"`
454     installprivlib=`echo $installprivlib | sed "s!$prefix!$installprefix!"`
455     installscript=`echo $installscript | sed "s!$prefix!$installprefix!"`
456     installsitelib=`echo $installsitelib | sed "s!$prefix!$installprefix!"`
457     installsitearch=`echo $installsitearch | sed "s!$prefix!$installprefix!"`
458
459 Then, you can Configure and install in the usual way:
460
461     sh Configure -des
462     make
463     make test
464     make install
465
466 Beware, though, that if you go to try to install new add-on
467 extensions, they too will get installed in under '/tmp/perl5' if you
468 follow this example.  The next section shows one way of dealing with
469 that problem.
470
471 =head2 Creating an installable tar archive
472
473 If you need to install perl on many identical systems, it is
474 convenient to compile it once and create an archive that can be
475 installed on multiple systems.  Here's one way to do that:
476
477     # Set up config.over to install perl into a different directory,
478     # e.g. /tmp/perl5 (see previous part).
479     sh Configure -des
480     make
481     make test
482     make install
483     cd /tmp/perl5
484     # Edit $archlib/Config.pm to change all the
485     # install* variables back to reflect where everything will
486     # really be installed.
487     # Edit any of the scripts in $scriptdir to have the correct
488     # #!/wherever/perl line.
489     tar cvf ../perl5-archive.tar .
490     # Then, on each machine where you want to install perl,
491     cd /usr/local  # Or wherever you specified as $prefix
492     tar xvf perl5-archive.tar
493
494 =head2 Site-wide Policy settings
495
496 After Configure runs, it stores a number of common site-wide "policy"
497 answers (such as installation directories and the local perl contact
498 person) in the Policy.sh file.  If you want to build perl on another
499 system using the same policy defaults, simply copy the Policy.sh file
500 to the new system and Configure will use it along with the appropriate
501 hint file for your system.
502
503 Alternatively, if you wish to change some or all of those policy
504 answers, you should
505
506         rm -f Policy.sh
507
508 to ensure that Configure doesn't re-use them.
509
510 Further information is in the Policy_sh.SH file itself.
511
512 =head2 Configure-time Options
513
514 There are several different ways to Configure and build perl for your
515 system.  For most users, the defaults are sensible and will work.
516 Some users, however, may wish to further customize perl.  Here are
517 some of the main things you can change.
518
519 =head2 Threads
520
521 On some platforms, perl5.005 can be compiled to use threads.  To
522 enable this, read the file README.threads, and then try
523
524         sh Configure -Dusethreads
525
526 Currently, you need to specify -Dusethreads on the Configure command
527 line so that the hint files can make appropriate adjustments.
528
529 The default is to compile without thread support.
530
531 =head2 Selecting File IO mechanisms
532
533 Previous versions of perl used the standard IO mechanisms as defined in
534 stdio.h.  Versions 5.003_02 and later of perl allow alternate IO
535 mechanisms via a "PerlIO" abstraction, but the stdio mechanism is still
536 the default and is the only supported mechanism.
537
538 This PerlIO abstraction can be enabled either on the Configure command
539 line with
540
541         sh Configure -Duseperlio
542
543 or interactively at the appropriate Configure prompt.
544
545 If you choose to use the PerlIO abstraction layer, there are two
546 (experimental) possibilities for the underlying IO calls.  These have been
547 tested to some extent on some platforms, but are not guaranteed to work
548 everywhere.
549
550 =over 4
551
552 =item 1.
553
554 AT&T's "sfio".  This has superior performance to stdio.h in many
555 cases, and is extensible by the use of "discipline" modules.  Sfio
556 currently only builds on a subset of the UNIX platforms perl supports.
557 Because the data structures are completely different from stdio, perl
558 extension modules or external libraries may not work.  This
559 configuration exists to allow these issues to be worked on.
560
561 This option requires the 'sfio' package to have been built and installed.
562 A (fairly old) version of sfio is in CPAN.
563
564 You select this option by
565
566         sh Configure -Duseperlio -Dusesfio
567
568 If you have already selected -Duseperlio, and if Configure detects
569 that you have sfio, then sfio will be the default suggested by
570 Configure.
571
572 Note:  On some systems, sfio's iffe configuration script fails
573 to detect that you have an atexit function (or equivalent).
574 Apparently, this is a problem at least for some versions of Linux
575 and SunOS 4.
576
577 You can test if you have this problem by trying the following shell
578 script.  (You may have to add some extra cflags and libraries.  A
579 portable version of this may eventually make its way into Configure.)
580
581     #!/bin/sh
582     cat > try.c <<'EOCP'
583     #include <stdio.h>
584     main() { printf("42\n"); }
585     EOCP
586     cc -o try try.c -lsfio
587     val=`./try`
588     if test X$val = X42; then
589         echo "Your sfio looks ok"
590     else
591         echo "Your sfio has the exit problem."
592     fi
593
594 If you have this problem, the fix is to go back to your sfio sources
595 and correct iffe's guess about atexit.
596
597 There also might be a more recent release of Sfio that fixes your
598 problem.
599
600 =item 2.
601
602 Normal stdio IO, but with all IO going through calls to the PerlIO
603 abstraction layer.  This configuration can be used to check that perl and
604 extension modules have been correctly converted to use the PerlIO
605 abstraction.
606
607 This configuration should work on all platforms (but might not).
608
609 You select this option via:
610
611         sh Configure -Duseperlio -Uusesfio
612
613 If you have already selected -Duseperlio, and if Configure does not
614 detect sfio, then this will be the default suggested by Configure.
615
616 =back
617
618 =head2 Building a shared libperl.so Perl library
619
620 Currently, for most systems, the main perl executable is built by
621 linking the "perl library" libperl.a with perlmain.o, your static
622 extensions (usually just DynaLoader.a) and various extra libraries,
623 such as -lm.
624
625 On some systems that support dynamic loading, it may be possible to
626 replace libperl.a with a shared libperl.so.  If you anticipate building
627 several different perl binaries (e.g. by embedding libperl into
628 different programs, or by using the optional compiler extension), then
629 you might wish to build a shared libperl.so so that all your binaries
630 can share the same library.
631
632 The disadvantages are that there may be a significant performance
633 penalty associated with the shared libperl.so, and that the overall
634 mechanism is still rather fragile with respect to different versions
635 and upgrades.
636
637 In terms of performance, on my test system (Solaris 2.5_x86) the perl
638 test suite took roughly 15% longer to run with the shared libperl.so.
639 Your system and typical applications may well give quite different
640 results.
641
642 The default name for the shared library is typically something like
643 libperl.so.3.2 (for Perl 5.003_02) or libperl.so.302 or simply
644 libperl.so.  Configure tries to guess a sensible naming convention
645 based on your C library name.  Since the library gets installed in a
646 version-specific architecture-dependent directory, the exact name
647 isn't very important anyway, as long as your linker is happy.
648
649 For some systems (mostly SVR4), building a shared libperl is required
650 for dynamic loading to work, and hence is already the default.
651
652 You can elect to build a shared libperl by
653
654         sh Configure -Duseshrplib
655
656 To actually build perl, you must add the current working directory to your
657 LD_LIBRARY_PATH environment variable before running make.  You can do
658 this with
659
660    LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
661
662 for Bourne-style shells, or
663
664    setenv LD_LIBRARY_PATH `pwd`
665
666 for Csh-style shells.  You *MUST* do this before running make.
667 Folks running NeXT OPENSTEP must substitute DYLD_LIBRARY_PATH for
668 LD_LIBRARY_PATH above.
669
670 There is also an potential problem with the shared perl library if you
671 want to have more than one "flavor" of the same version of perl (e.g.
672 with and without -DDEBUGGING).  For example, suppose you build and
673 install a standard Perl 5.004 with a shared library.  Then, suppose you
674 try to build Perl 5.004 with -DDEBUGGING enabled, but everything else
675 the same, including all the installation directories.  How can you
676 ensure that your newly built perl will link with your newly built
677 libperl.so.4 rather with the installed libperl.so.4?  The answer is
678 that you might not be able to.  The installation directory is encoded
679 in the perl binary with the LD_RUN_PATH environment variable (or
680 equivalent ld command-line option).  On Solaris, you can override that
681 with LD_LIBRARY_PATH; on Linux you can't.  On Digital Unix, you can
682 override LD_LIBRARY_PATH by setting the _RLD_ROOT environment variable
683 to point to the perl build directory.
684
685 The only reliable answer is that you should specify a different
686 directory for the architecture-dependent library for your -DDEBUGGING
687 version of perl.  You can do this by changing all the *archlib*
688 variables in config.sh, namely archlib, archlib_exp, and
689 installarchlib, to point to your new architecture-dependent library.
690
691 =head2 Malloc Issues
692
693 Perl relies heavily on malloc(3) to grow data structures as needed, so
694 perl's performance can be noticeably affected by the performance of
695 the malloc function on your system.
696
697 The perl source is shipped with a version of malloc that is very fast but
698 somewhat wasteful of space.  On the other hand, your system's malloc
699 function may be a bit slower but also a bit more frugal.  However,
700 as of 5.004_68, perl's malloc has been optimized for the typical
701 requests from perl, so there's a chance that it may be both faster and
702 use less memory.
703
704 For many uses, speed is probably the most important consideration, so
705 the default behavior (for most systems) is to use the malloc supplied
706 with perl.  However, if you will be running very large applications
707 (e.g. Tk or PDL) or if your system already has an excellent malloc, or
708 if you are experiencing difficulties with extensions that use
709 third-party libraries that call malloc, then you might wish to use
710 your system's malloc.  (Or, you might wish to explore the malloc flags
711 discussed below.)
712
713 To build without perl's malloc, you can use the Configure command
714
715         sh Configure -Uusemymalloc
716
717 or you can answer 'n' at the appropriate interactive Configure prompt.
718
719 =head2 Malloc Performance Flags
720
721 If you are using Perl's malloc, you may add one or more of the following
722 items to your ccflags config.sh variable to change its behavior.  You can
723 find out more about these and other flags by reading the commentary near
724 the top of the malloc.c source.  The defaults should be fine for
725 nearly everyone.
726
727 =over 4
728
729 =item -DNO_FANCY_MALLOC
730
731 Undefined by default.  Defining it returns malloc to the version used
732 in Perl 5.004.
733
734 =item -DPLAIN_MALLOC
735
736 Undefined by default.  Defining it in addition to NO_FANCY_MALLOC returns
737 malloc to the version used in Perl version 5.000.
738
739 =back
740
741 =head2 Building a debugging perl
742
743 You can run perl scripts under the perl debugger at any time with
744 B<perl -d your_script>.  If, however, you want to debug perl itself,
745 you probably want to do
746
747         sh Configure -Doptimize='-g'
748
749 This will do two independent things:  First, it will force compilation
750 to use cc -g so that you can use your system's debugger on the
751 executable.  (Note:  Your system may actually require something like
752 cc -g2.  Check your man pages for cc(1) and also any hint file for your
753 system.)  Second, it will add -DDEBUGGING to your ccflags variable in
754 config.sh so that you can use B<perl -D> to access perl's internal
755 state.  (Note: Configure will only add -DDEBUGGING by
756 default if you are not reusing your old config.sh.  If you want to
757 reuse your old config.sh, then you can just edit it and change the
758 optimize and ccflags variables by hand and then propagate your changes
759 as shown in L<"Propagating your changes to config.sh"> below.)
760
761 You can actually specify -g and -DDEBUGGING independently, but usually
762 it's convenient to have both.
763
764 If you are using a shared libperl, see the warnings about multiple
765 versions of perl under L<Building a shared libperl.so Perl library>.
766
767 =head2 Other Compiler Flags
768
769 For most users, all of the Configure defaults are fine.  However,
770 you can change a number of factors in the way perl is built
771 by adding appropriate -D directives to your ccflags variable in
772 config.sh.
773
774 For example, you can replace the rand() and srand() functions in the
775 perl source by any other random number generator by a trick such as the
776 following:
777
778         sh Configure -Dccflags='-Drand=random -Dsrand=srandom'
779
780 or by adding -Drand=random and -Dsrand=srandom to your ccflags
781 at the appropriate Configure prompt.  (Note:  Although this worked for
782 me, it might not work for you if your system's header files give
783 different prototypes for rand() and random() or srand() and srandom().)
784
785 You should also run Configure interactively to verify that a hint file
786 doesn't inadvertently override your ccflags setting.  (Hints files
787 shouldn't do that, but some might.)
788
789 =head2 What if it doesn't work?
790
791 =over 4
792
793 =item Running Configure Interactively
794
795 If Configure runs into trouble, remember that you can always run
796 Configure interactively so that you can check (and correct) its
797 guesses.
798
799 All the installation questions have been moved to the top, so you don't
800 have to wait for them.  Once you've handled them (and your C compiler and
801 flags) you can type  &-d  at the next Configure prompt and Configure
802 will use the defaults from then on.
803
804 If you find yourself trying obscure command line incantations and
805 config.over tricks, I recommend you run Configure interactively
806 instead.  You'll probably save yourself time in the long run.
807
808 =item Hint files
809
810 The perl distribution includes a number of system-specific hints files
811 in the hints/ directory.  If one of them matches your system, Configure
812 will offer to use that hint file.
813
814 Several of the hint files contain additional important information.
815 If you have any problems, it is a good idea to read the relevant hint file
816 for further information.  See hints/solaris_2.sh for an extensive example.
817 More information about writing good hints is in the hints/README.hints
818 file.
819
820 =item *** WHOA THERE!!! ***
821
822 Occasionally, Configure makes a wrong guess.  For example, on SunOS
823 4.1.3, Configure incorrectly concludes that tzname[] is in the
824 standard C library.  The hint file is set up to correct for this.  You
825 will see a message:
826
827     *** WHOA THERE!!! ***
828         The recommended value for $d_tzname on this machine was "undef"!
829         Keep the recommended value? [y]
830
831 You should always keep the recommended value unless, after reading the
832 relevant section of the hint file, you are sure you want to try
833 overriding it.
834
835 If you are re-using an old config.sh, the word "previous" will be
836 used instead of "recommended".  Again, you will almost always want
837 to keep the previous value, unless you have changed something on your
838 system.
839
840 For example, suppose you have added libgdbm.a to your system
841 and you decide to reconfigure perl to use GDBM_File.  When you run
842 Configure again, you will need to add -lgdbm to the list of libraries.
843 Now, Configure will find your gdbm include file and library and will
844 issue a message:
845
846     *** WHOA THERE!!! ***
847         The previous value for $i_gdbm on this machine was "undef"!
848         Keep the previous value? [y]
849
850 In this case, you do not want to keep the previous value, so you
851 should answer 'n'.  (You'll also have to manually add GDBM_File to
852 the list of dynamic extensions to build.)
853
854 =item Changing Compilers
855
856 If you change compilers or make other significant changes, you should
857 probably not re-use your old config.sh.  Simply remove it or
858 rename it, e.g. mv config.sh config.sh.old.  Then rerun Configure
859 with the options you want to use.
860
861 This is a common source of problems.  If you change from cc to
862 gcc, you should almost always remove your old config.sh.
863
864 =item Propagating your changes to config.sh
865
866 If you make any changes to config.sh, you should propagate
867 them to all the .SH files by running
868
869         sh Configure -S
870
871 You will then have to rebuild by running
872
873         make depend
874         make
875
876 =item config.over
877
878 You can also supply a shell script config.over to over-ride Configure's
879 guesses.  It will get loaded up at the very end, just before config.sh
880 is created.  You have to be careful with this, however, as Configure
881 does no checking that your changes make sense.  See the section on
882 L<"Changing the installation directory"> for an example.
883
884 =item config.h
885
886 Many of the system dependencies are contained in config.h.
887 Configure builds config.h by running the config_h.SH script.
888 The values for the variables are taken from config.sh.
889
890 If there are any problems, you can edit config.h directly.  Beware,
891 though, that the next time you run Configure, your changes will be
892 lost.
893
894 =item cflags
895
896 If you have any additional changes to make to the C compiler command
897 line, they can be made in cflags.SH.  For instance, to turn off the
898 optimizer on toke.c, find the line in the switch structure for
899 toke.c and put the command optimize='-g' before the ;; .  You
900 can also edit cflags directly, but beware that your changes will be
901 lost the next time you run Configure.
902
903 To explore various ways of changing ccflags from within a hint file,
904 see the file hints/README.hints.
905
906 To change the C flags for all the files, edit config.sh and change either
907 $ccflags or $optimize, and then re-run
908
909         sh Configure -S
910         make depend
911
912 =item No sh
913
914 If you don't have sh, you'll have to copy the sample file Porting/config_H
915 to config.h and edit the config.h to reflect your system's peculiarities.
916 You'll probably also have to extensively modify the extension building
917 mechanism.
918
919 =item Porting information
920
921 Specific information for the OS/2, Plan9, VMS and Win32 ports is in the
922 corresponding README files and subdirectories.  Additional information,
923 including a glossary of all those config.sh variables, is in the Porting
924 subdirectory.
925
926 Ports for other systems may also be available.  You should check out
927 http://www.perl.com/CPAN/ports for current information on ports to
928 various other operating systems.
929
930 =back
931
932 =head1 make depend
933
934 This will look for all the includes.  The output is stored in makefile.
935 The only difference between Makefile and makefile is the dependencies at
936 the bottom of makefile.  If you have to make any changes, you should edit
937 makefile, not Makefile since the Unix make command reads makefile first.
938 (On non-Unix systems, the output may be stored in a different file.
939 Check the value of $firstmakefile in your config.sh if in doubt.)
940
941 Configure will offer to do this step for you, so it isn't listed
942 explicitly above.
943
944 =head1 make
945
946 This will attempt to make perl in the current directory.
947
948 If you can't compile successfully, try some of the following ideas.
949 If none of them help, and careful reading of the error message and
950 the relevant manual pages on your system doesn't help, you can
951 send a message to either the comp.lang.perl.misc newsgroup or to
952 perlbug@perl.com with an accurate description of your problem.
953 See L<"Reporting Problems"> below.
954
955 =over 4
956
957 =item hints
958
959 If you used a hint file, try reading the comments in the hint file
960 for further tips and information.
961
962 =item extensions
963
964 If you can successfully build miniperl, but the process crashes
965 during the building of extensions, you should run
966
967         make minitest
968
969 to test your version of miniperl.
970
971 =item locale
972
973 If you have any locale-related environment variables set, try unsetting
974 them.  I have some reports that some versions of IRIX hang while
975 running B<./miniperl configpm> with locales other than the C locale.
976 See the discussion under L<"make test"> below about locales and the
977 whole L<"Locale problems"> section in the file pod/perllocale.pod.
978 The latter is especially useful if you see something like this
979
980         perl: warning: Setting locale failed.
981         perl: warning: Please check that your locale settings:
982                 LC_ALL = "En_US",
983                 LANG = (unset)
984             are supported and installed on your system.
985         perl: warning: Falling back to the standard locale ("C").
986
987 at Perl startup.
988
989 =item malloc duplicates
990
991 If you get duplicates upon linking for malloc et al, add -DEMBEDMYMALLOC
992 to your ccflags variable in config.sh.
993
994 =item varargs
995
996 If you get varargs problems with gcc, be sure that gcc is installed
997 correctly and that you are not passing -I/usr/include to gcc.  When using
998 gcc, you should probably have i_stdarg='define' and i_varargs='undef'
999 in config.sh.  The problem is usually solved by running fixincludes
1000 correctly.  If you do change config.sh, don't forget to propagate
1001 your changes (see L<"Propagating your changes to config.sh"> below).
1002 See also the L<"vsprintf"> item below.
1003
1004 =item util.c
1005
1006 If you get error messages such as the following (the exact line
1007 numbers and function name may vary in different versions of perl):
1008
1009     util.c: In function `Perl_form':
1010     util.c:1107: number of arguments doesn't match prototype
1011     proto.h:125: prototype declaration
1012
1013 it might well be a symptom of the gcc "varargs problem".  See the
1014 previous L<"varargs"> item.
1015
1016 =item Solaris and SunOS dynamic loading
1017
1018 If you have problems with dynamic loading using gcc on SunOS or
1019 Solaris, and you are using GNU as and GNU ld, you may need to add
1020 -B/bin/ (for SunOS) or -B/usr/ccs/bin/ (for Solaris) to your
1021 $ccflags, $ldflags, and $lddlflags so that the system's versions of as
1022 and ld are used.  Note that the trailing '/' is required.
1023 Alternatively, you can use the GCC_EXEC_PREFIX
1024 environment variable to ensure that Sun's as and ld are used.  Consult
1025 your gcc documentation for further information on the -B option and
1026 the GCC_EXEC_PREFIX variable.
1027
1028 One convenient way to ensure you are not using GNU as and ld is to
1029 invoke Configure with
1030
1031     sh Configure -Dcc='gcc -B/usr/ccs/bin/'
1032
1033 for Solaris systems.  For a SunOS system, you must use -B/bin/
1034 instead.
1035
1036 Alternatively, recent versions of GNU ld reportedly work if you
1037 include C<-Wl,-export-dynamic> in the ccdlflags variable in
1038 config.sh.
1039
1040 =item ld.so.1: ./perl: fatal: relocation error:
1041
1042 If you get this message on SunOS or Solaris, and you're using gcc,
1043 it's probably the GNU as or GNU ld problem in the previous item
1044 L<"Solaris and SunOS dynamic loading">.
1045
1046 =item LD_LIBRARY_PATH
1047
1048 If you run into dynamic loading problems, check your setting of
1049 the LD_LIBRARY_PATH environment variable.  If you're creating a static
1050 Perl library (libperl.a rather than libperl.so) it should build
1051 fine with LD_LIBRARY_PATH unset, though that may depend on details
1052 of your local set-up.
1053
1054 =item dlopen: stub interception failed
1055
1056 The primary cause of the 'dlopen: stub interception failed' message is
1057 that the LD_LIBRARY_PATH environment variable includes a directory
1058 which is a symlink to /usr/lib (such as /lib).
1059
1060 The reason this causes a problem is quite subtle.  The file libdl.so.1.0
1061 actually *only* contains functions which generate 'stub interception
1062 failed' errors!  The runtime linker intercepts links to
1063 "/usr/lib/libdl.so.1.0" and links in internal implementation of those
1064 functions instead.  [Thanks to Tim Bunce for this explanation.]
1065
1066 =item nm extraction
1067
1068 If Configure seems to be having trouble finding library functions,
1069 try not using nm extraction.  You can do this from the command line
1070 with
1071
1072         sh Configure -Uusenm
1073
1074 or by answering the nm extraction question interactively.
1075 If you have previously run Configure, you should not reuse your old
1076 config.sh.
1077
1078 =item umask not found
1079
1080 If the build processes encounters errors relating to umask(), the problem
1081 is probably that Configure couldn't find your umask() system call.
1082 Check your config.sh.  You should have d_umask='define'.  If you don't,
1083 this is probably the L<"nm extraction"> problem discussed above.  Also,
1084 try reading the hints file for your system for further information.
1085
1086 =item vsprintf
1087
1088 If you run into problems with vsprintf in compiling util.c, the
1089 problem is probably that Configure failed to detect your system's
1090 version of vsprintf().  Check whether your system has vprintf().
1091 (Virtually all modern Unix systems do.)  Then, check the variable
1092 d_vprintf in config.sh.  If your system has vprintf, it should be:
1093
1094         d_vprintf='define'
1095
1096 If Configure guessed wrong, it is likely that Configure guessed wrong
1097 on a number of other common functions too.  This is probably
1098 the L<"nm extraction"> problem discussed above.
1099
1100 =item do_aspawn
1101
1102 If you run into problems relating to do_aspawn or do_spawn, the
1103 problem is probably that Configure failed to detect your system's
1104 fork() function.  Follow the procedure in the previous item
1105 on L<"nm extraction">.
1106
1107 =item __inet_* errors
1108
1109 If you receive unresolved symbol errors during Perl build and/or test
1110 referring to __inet_* symbols, check to see whether BIND 8.1 is
1111 installed.  It installs a /usr/local/include/arpa/inet.h that refers to
1112 these symbols.  Versions of BIND later than 8.1 do not install inet.h
1113 in that location and avoid the errors.  You should probably update to a
1114 newer version of BIND.  If you can't, you can either link with the
1115 updated resolver library provided with BIND 8.1 or rename
1116 /usr/local/bin/arpa/inet.h during the Perl build and test process to
1117 avoid the problem.
1118
1119 =item Optimizer
1120
1121 If you can't compile successfully, try turning off your compiler's
1122 optimizer.  Edit config.sh and change the line
1123
1124         optimize='-O'
1125
1126 to
1127
1128         optimize=' '
1129
1130 then propagate your changes with B<sh Configure -S> and rebuild
1131 with B<make depend; make>.
1132
1133 =item CRIPPLED_CC
1134
1135 If you still can't compile successfully, try adding a -DCRIPPLED_CC
1136 flag.  (Just because you get no errors doesn't mean it compiled right!)
1137 This simplifies some complicated expressions for compilers that get
1138 indigestion easily.
1139
1140 =item Missing functions
1141
1142 If you have missing routines, you probably need to add some library or
1143 other, or you need to undefine some feature that Configure thought was
1144 there but is defective or incomplete.  Look through config.h for
1145 likely suspects.  If Configure guessed wrong on a number of functions,
1146 you might have the L<"nm extraction"> problem discussed above.
1147
1148 =item toke.c
1149
1150 Some compilers will not compile or optimize the larger files (such as
1151 toke.c) without some extra switches to use larger jump offsets or
1152 allocate larger internal tables.  You can customize the switches for
1153 each file in cflags.  It's okay to insert rules for specific files into
1154 makefile since a default rule only takes effect in the absence of a
1155 specific rule.
1156
1157 =item Missing dbmclose
1158
1159 SCO prior to 3.2.4 may be missing dbmclose().  An upgrade to 3.2.4
1160 that includes libdbm.nfs (which includes dbmclose()) may be available.
1161
1162 =item Note (probably harmless): No library found for -lsomething
1163
1164 If you see such a message during the building of an extension, but
1165 the extension passes its tests anyway (see L<"make test"> below),
1166 then don't worry about the warning message.  The extension
1167 Makefile.PL goes looking for various libraries needed on various
1168 systems; few systems will need all the possible libraries listed.
1169 For example, a system may have -lcposix or -lposix, but it's
1170 unlikely to have both, so most users will see warnings for the one
1171 they don't have.  The phrase 'probably harmless' is intended to
1172 reassure you that nothing unusual is happening, and the build
1173 process is continuing.
1174
1175 On the other hand, if you are building GDBM_File and you get the
1176 message
1177
1178     Note (probably harmless): No library found for -lgdbm
1179
1180 then it's likely you're going to run into trouble somewhere along
1181 the line, since it's hard to see how you can use the GDBM_File
1182 extension without the -lgdbm library.
1183
1184 It is true that, in principle, Configure could have figured all of
1185 this out, but Configure and the extension building process are not
1186 quite that tightly coordinated.
1187
1188 =item sh: ar: not found
1189
1190 This is a message from your shell telling you that the command 'ar'
1191 was not found.  You need to check your PATH environment variable to
1192 make sure that it includes the directory with the 'ar' command.  This
1193 is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin
1194 directory.
1195
1196 =item db-recno failure on tests 51, 53 and 55
1197
1198 Old versions of the DB library (including the DB library which comes
1199 with FreeBSD 2.1) had broken handling of recno databases with modified
1200 bval settings.  Upgrade your DB library or OS.
1201
1202 =item Miscellaneous
1203
1204 Some additional things that have been reported for either perl4 or perl5:
1205
1206 Genix may need to use libc rather than libc_s, or #undef VARARGS.
1207
1208 NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
1209
1210 UTS may need one or more of -DCRIPPLED_CC, -K or -g, and undef LSTAT.
1211
1212 If you get syntax errors on '(', try -DCRIPPLED_CC.
1213
1214 Machines with half-implemented dbm routines will need to #undef I_ODBM
1215
1216 =back
1217
1218 =head1 make test
1219
1220 This will run the regression tests on the perl you just made (you
1221 should run plain 'make' before 'make test' otherwise you won't have a
1222 complete build).  If 'make test' doesn't say "All tests successful"
1223 then something went wrong.  See the file t/README in the t subdirectory.
1224
1225 Note that you can't run the tests in background if this disables
1226 opening of /dev/tty. You can use 'make test-notty' in that case but
1227 a few tty tests will be skipped.
1228
1229 =head2 What if make test doesn't work?
1230
1231 If make test bombs out, just cd to the t directory and run ./TEST
1232 by hand to see if it makes any difference.  If individual tests
1233 bomb, you can run them by hand, e.g.,
1234
1235         ./perl op/groups.t
1236
1237 Another way to get more detailed information about failed tests and
1238 individual subtests is to cd to the t directory and run
1239
1240         ./perl harness
1241
1242 (this assumes that most basic tests succeed, since harness uses
1243 complicated constructs).
1244
1245 You should also read the individual tests to see if there are any helpful
1246 comments that apply to your system.
1247
1248 =over 4
1249
1250 =item locale
1251
1252 Note:  One possible reason for errors is that some external programs
1253 may be broken due to the combination of your environment and the way
1254 B<make test> exercises them.  For example, this may happen if you have
1255 one or more of these environment variables set:  LC_ALL LC_CTYPE
1256 LC_COLLATE LANG.  In some versions of UNIX, the non-English locales
1257 are known to cause programs to exhibit mysterious errors.
1258
1259 If you have any of the above environment variables set, please try
1260
1261         setenv LC_ALL C
1262
1263 (for C shell) or
1264
1265         LC_ALL=C;export LC_ALL
1266
1267 for Bourne or Korn shell) from the command line and then retry
1268 make test.  If the tests then succeed, you may have a broken program that
1269 is confusing the testing.  Please run the troublesome test by hand as
1270 shown above and see whether you can locate the program.  Look for
1271 things like:  exec, `backquoted command`, system, open("|...") or
1272 open("...|").  All these mean that Perl is trying to run some
1273 external program.
1274
1275 =item Out of memory
1276
1277 On some systems, particularly those with smaller amounts of RAM, some
1278 of the tests in t/op/pat.t may fail with an "Out of memory" message.
1279 Specifically, in perl5.004_64, tests 74 and 78 have been reported to
1280 fail on some systems.  On my SparcStation IPC with 8 MB of RAM, test 78
1281 will fail if the system is running any other significant tasks at the
1282 same time.
1283
1284 Try stopping other jobs on the system and then running the test by itself:
1285
1286         cd t; ./perl op/pat.t
1287
1288 to see if you have any better luck.  If your perl still fails this
1289 test, it does not necessarily mean you have a broken perl.  This test
1290 tries to exercise the regular expression subsystem quite thoroughly,
1291 and may well be far more demanding than your normal usage.
1292
1293 =back
1294
1295 =head1 make install
1296
1297 This will put perl into the public directory you specified to
1298 Configure; by default this is /usr/local/bin.  It will also try
1299 to put the man pages in a reasonable place.  It will not nroff the man
1300 pages, however.  You may need to be root to run B<make install>.  If you
1301 are not root, you must own the directories in question and you should
1302 ignore any messages about chown not working.
1303
1304 =head2 Installing perl under different names
1305
1306 If you want to install perl under a name other than "perl" (for example,
1307 when installing perl with special features enabled, such as debugging),
1308 indicate the alternate name on the "make install" line, such as:
1309
1310     make install PERLNAME=myperl
1311
1312 =head2 Installed files
1313
1314 If you want to see exactly what will happen without installing
1315 anything, you can run
1316
1317         ./perl installperl -n
1318         ./perl installman -n
1319
1320 make install will install the following:
1321
1322         perl,
1323             perl5.nnn   where nnn is the current release number.  This
1324                         will be a link to perl.
1325         suidperl,
1326             sperl5.nnn  If you requested setuid emulation.
1327         a2p             awk-to-perl translator
1328         cppstdin        This is used by perl -P, if your cc -E can't
1329                         read from stdin.
1330         c2ph, pstruct   Scripts for handling C structures in header files.
1331         s2p             sed-to-perl translator
1332         find2perl       find-to-perl translator
1333         h2ph            Extract constants and simple macros from C headers
1334         h2xs            Converts C .h header files to Perl extensions.
1335         perlbug         Tool to report bugs in Perl.
1336         perldoc         Tool to read perl's pod documentation.
1337         pl2pm           Convert Perl 4 .pl files to Perl 5 .pm modules
1338         pod2html,       Converters from perl's pod documentation format
1339         pod2latex,      to other useful formats.
1340         pod2man, and
1341         pod2text
1342         splain          Describe Perl warnings and errors
1343
1344         library files   in $privlib and $archlib specified to
1345                         Configure, usually under /usr/local/lib/perl5/.
1346         man pages       in the location specified to Configure, usually
1347                         something like /usr/local/man/man1.
1348         module          in the location specified to Configure, usually
1349         man pages       under /usr/local/lib/perl5/man/man3.
1350         pod/*.pod       in $privlib/pod/.
1351
1352 Installperl will also create the library directories $siteperl and
1353 $sitearch listed in config.sh.  Usually, these are something like
1354
1355         /usr/local/lib/perl5/site_perl/5.005
1356         /usr/local/lib/perl5/site_perl/5.005/archname
1357
1358 where archname is something like sun4-sunos.  These directories
1359 will be used for installing extensions.
1360
1361 Perl's *.h header files and the libperl.a library are also installed
1362 under $archlib so that any user may later build new extensions, run the
1363 optional Perl compiler, or embed the perl interpreter into another
1364 program even if the Perl source is no longer available.
1365
1366 =head1 Coexistence with earlier versions of perl5
1367
1368 WARNING:  The upgrade from 5.004_0x to 5.005 is going to be a bit
1369 tricky.  See L<"Upgrading from 5.004 to 5.005">  below.
1370
1371 In general, you can usually safely upgrade from one version of Perl (e.g.
1372 5.004_04) to another similar version (e.g. 5.004_05) without re-compiling
1373 all of your add-on extensions.  You can also safely leave the old version
1374 around in case the new version causes you problems for some reason.
1375 For example, if you want to be sure that your script continues to run
1376 with 5.004_04, simply replace the '#!/usr/local/bin/perl' line at the
1377 top of the script with the particular version you want to run, e.g.
1378 #!/usr/local/bin/perl5.00404.
1379
1380 Most extensions will probably not need to be recompiled to use
1381 with a newer version of perl.   Here is how it is supposed to work.
1382 (These examples assume you accept all the Configure defaults.)
1383
1384 The directories searched by version 5.005 will be
1385
1386     Configure variable          Default value
1387         $archlib        /usr/local/lib/perl5/5.005/archname
1388         $privlib        /usr/local/lib/perl5/5.005
1389         $sitearch       /usr/local/lib/perl5/site_perl/5.005/archname
1390         $sitelib        /usr/local/lib/perl5/site_perl/5.005
1391
1392 while the directories searched by version 5.005_01 will be
1393
1394         $archlib        /usr/local/lib/perl5/5.00501/archname
1395         $privlib        /usr/local/lib/perl5/5.00501
1396         $sitearch       /usr/local/lib/perl5/site_perl/5.005/archname
1397         $sitelib        /usr/local/lib/perl5/site_perl/5.005
1398
1399 When you install an add-on extension, it gets installed into $sitelib (or
1400 $sitearch if it is architecture-specific).  This directory deliberately
1401 does NOT include the sub-version number (01) so that both 5.005 and
1402 5.005_01 can use the extension.  Only when a perl version changes to
1403 break backwards compatibility will the default suggestions for the
1404 $sitearch and $sitelib version numbers be increased.
1405
1406 However, if you do run into problems, and you want to continue to use the
1407 old version of perl along with your extension, move those extension files
1408 to the appropriate version directory, such as $privlib (or $archlib).
1409 (The extension's .packlist file lists the files installed with that
1410 extension.  For the Tk extension, for example, the list of files installed
1411 is in $sitearch/auto/Tk/.packlist.)  Then use your newer version of perl
1412 to rebuild and re-install the extension into $sitelib.  This way, Perl
1413 5.005 will find your files in the 5.005 directory, and newer versions
1414 of perl will find your newer extension in the $sitelib directory.
1415 (This is also why perl searches the site-specific libraries last.)
1416
1417 Alternatively, if you are willing to reinstall all your extensions
1418 every time you upgrade perl, then you can include the subversion
1419 number in $sitearch and $sitelib when you run Configure.
1420
1421 =head2 Maintaining completely separate versions
1422
1423 Many users prefer to keep all versions of perl in completely
1424 separate directories.  One convenient way to do this is by
1425 using a separate prefix for each version, such as
1426
1427         sh Configure -Dprefix=/opt/perl5.004
1428
1429 and adding /opt/perl5.004/bin to the shell PATH variable.  Such users
1430 may also wish to add a symbolic link /usr/local/bin/perl so that
1431 scripts can still start with #!/usr/local/bin/perl.
1432
1433 Others might share a common directory for maintenance sub-versions
1434 (e.g. 5.004 for all 5.004_0x versions), but change directory with
1435 each major version.
1436
1437 If you are installing a development subversion, you probably ought to
1438 seriously consider using a separate directory, since development
1439 subversions may not have all the compatibility wrinkles ironed out
1440 yet.
1441
1442 =head2 Upgrading from 5.004 to 5.005
1443
1444 Extensions built and installed with versions of perl prior to 5.004_50
1445 will need to be recompiled to be used with 5.004_50 and later.  You will,
1446 however, be able to continue using 5.004 even after you install 5.005.
1447 The 5.004 binary will still be able to find the extensions built under
1448 5.004; the 5.005 binary will look in the new $sitearch and $sitelib
1449 directories, and will not find them.
1450
1451 =head1 Coexistence with perl4
1452
1453 You can safely install perl5 even if you want to keep perl4 around.
1454
1455 By default, the perl5 libraries go into /usr/local/lib/perl5/, so
1456 they don't override the perl4 libraries in /usr/local/lib/perl/.
1457
1458 In your /usr/local/bin directory, you should have a binary named
1459 perl4.036.  That will not be touched by the perl5 installation
1460 process.  Most perl4 scripts should run just fine under perl5.
1461 However, if you have any scripts that require perl4, you can replace
1462 the #! line at the top of them by #!/usr/local/bin/perl4.036
1463 (or whatever the appropriate pathname is).  See pod/perltrap.pod
1464 for possible problems running perl4 scripts under perl5.
1465
1466 =head1 cd /usr/include; h2ph *.h sys/*.h
1467
1468 Some perl scripts need to be able to obtain information from
1469 the system header files.  This command will convert the most commonly used
1470 header files in /usr/include into files that can be easily interpreted
1471 by perl.  These files will be placed in the architecture-dependent library
1472 ($archlib) directory you specified to Configure.
1473
1474 Note:  Due to differences in the C and perl languages, the
1475 conversion of the header files is not perfect.  You will probably have
1476 to hand-edit some of the converted files to get them to parse
1477 correctly.  For example, h2ph breaks spectacularly on type casting and
1478 certain structures.
1479
1480 =head1 installhtml --help
1481
1482 Some sites may wish to make perl documentation available in HTML
1483 format.  The installhtml utility can be used to convert pod
1484 documentation into linked HTML files and install them.
1485
1486 The following command-line is an example of one used to convert
1487 perl documentation:
1488
1489   ./installhtml                   \
1490       --podroot=.                 \
1491       --podpath=lib:ext:pod:vms   \
1492       --recurse                   \
1493       --htmldir=/perl/nmanual     \
1494       --htmlroot=/perl/nmanual    \
1495       --splithead=pod/perlipc     \
1496       --splititem=pod/perlfunc    \
1497       --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \
1498       --verbose
1499
1500 See the documentation in installhtml for more details.  It can take
1501 many minutes to execute a large installation and you should expect to
1502 see warnings like "no title", "unexpected directive" and "cannot
1503 resolve" as the files are processed. We are aware of these problems
1504 (and would welcome patches for them).
1505
1506 You may find it helpful to run installhtml twice. That should reduce
1507 the number of "cannot resolve" warnings.
1508
1509 =head1 cd pod && make tex && (process the latex files)
1510
1511 Some sites may also wish to make the documentation in the pod/ directory
1512 available in TeX format.  Type
1513
1514         (cd pod && make tex && <process the latex files>)
1515
1516 =head1 Reporting Problems
1517
1518 If you have difficulty building perl, and none of the advice in this file
1519 helps, and careful reading of the error message and the relevant manual
1520 pages on your system doesn't help either, then you should send a message
1521 to either the comp.lang.perl.misc newsgroup or to perlbug@perl.com with
1522 an accurate description of your problem.
1523
1524 Please include the output of the ./myconfig shell script that comes with
1525 the distribution.  Alternatively, you can use the perlbug program that
1526 comes with the perl distribution, but you need to have perl compiled
1527 before you can use it.  (If you have not installed it yet, you need to
1528 run C<./perl -Ilib utils/perlbug> instead of a plain C<perlbug>.)
1529
1530 You might also find helpful information in the Porting directory of the
1531 perl distribution.
1532
1533 =head1 DOCUMENTATION
1534
1535 Read the manual entries before running perl.  The main documentation
1536 is in the pod/ subdirectory and should have been installed during the
1537 build process.  Type B<man perl> to get started.  Alternatively, you
1538 can type B<perldoc perl> to use the supplied perldoc script.  This is
1539 sometimes useful for finding things in the library modules.
1540
1541 Under UNIX, you can produce a documentation book in postscript form,
1542 along with its table of contents, by going to the pod/ subdirectory and
1543 running (either):
1544
1545         ./roffitall -groff              # If you have GNU groff installed
1546         ./roffitall -psroff             # If you have psroff
1547
1548 This will leave you with two postscript files ready to be printed.
1549 (You may need to fix the roffitall command to use your local troff
1550 set-up.)
1551
1552 Note that you must have performed the installation already before running
1553 the above, since the script collects the installed files to generate
1554 the documentation.
1555
1556 =head1 AUTHOR
1557
1558 Original author:  Andy Dougherty doughera@lafayette.edu , borrowing very
1559 heavily from the original README by Larry Wall, with lots of helpful
1560 feedback and additions from the perl5-porters@perl.org folks.
1561
1562 If you have problems, corrections, or questions, please see
1563 L<"Reporting Problems"> above.
1564
1565 =head1 REDISTRIBUTION
1566
1567 This document is part of the Perl package and may be distributed under
1568 the same terms as perl itself.
1569
1570 If you are distributing a modified version of perl (perhaps as part of
1571 a larger package) please do modify these installation instructions and
1572 the contact information to match your distribution.
1573
1574 =head1 LAST MODIFIED
1575
1576 $Id: INSTALL,v 1.40 1998/07/06 14:49:02 doughera Released $