=head1 SYNOPSIS
- ****************************
- *** NEEDS WORK FOR 5.004 ***
- ****************************
-
The basic steps to build and install perl5 on a Unix system are:
rm -f config.sh
make
make test
make install
- # possibly add these:
- (cd /usr/include && h2ph *.h sys/*.h)
- cd pod; make html && mv *.html <www home dir> && cd ..
- cd pod; make tex && <process the latex files> && cd ..
+ # You may also wish to add these:
+ (cd /usr/include && h2ph *.h sys/*.h)
+ (cd pod && make html && mv *.html <www home dir>)
+ (cd pod && make tex && <process the latex files>)
Each of these is explained in further detail below.
For information on non-Unix systems, see the section on
-L<"Porting Information">, below.
+L<"Porting Information"> below.
=head1 DESCRIPTION
the README file specific to your operating system, since this may
provide additional or different instructions for building Perl.
-=head1 Space Requirements.
+=head1 Space Requirements
The complete perl5 source tree takes up about 7 MB of disk space.
The complete tree after completing C<make> takes roughly
system-dependent. The installation directories need something
on the order of 7 MB, though again that value is system-dependent.
-=head1 Start with a Fresh Distribution.
+=head1 Start with a Fresh Distribution
If you have built perl before, you should clean out the build directory
with the command
In short, if you wish to use your old config.sh, I recommend running
Configure interactively rather than blindly accepting the defaults.
-=head1 Run Configure.
+=head1 Run Configure
Configure will figure out various things about your system. Some
things Configure will figure out for itself, other things it will ask
then Configure will suggest /opt/perl/lib instead of
/opt/perl/lib/perl5/.
-By default, Configure will compile perl to use dynamic loading, if
+By default, Configure will compile perl to use dynamic loading if
your system supports it. If you want to force perl to be compiled
statically, you can either choose this when Configure prompts you or
you can use the Configure command line option -Uusedl.
CC=gcc ./configure
-The B<configure> script emulates several of the more common configure
+The B<configure> script emulates a few of the more common configure
options. Try
./configure --help
for a listing.
-Cross compiling is currently not supported.
+Cross compiling is not supported.
For systems that do not distinguish the files "Configure" and
"configure", Perl includes a copy of B<configure> named
B<configure.gnu>.
-=head2 Binary Compatibility With Earlier Versions of Perl 5
-
-Starting with Perl 5.003, all functions in the Perl C source code have
-been protected by default by the prefix Perl_ (or perl_) so that you
-may link with third-party libraries without fear of namespace
-collisons. This change broke compatability with version 5.002, so
-installing 5.003 or 5.004 over 5.002 or earlier will force you to
-re-build and install all of your dynamically loadable extensions.
-(The standard extensions supplied with Perl are handled
-automatically). You can turn off this namespace protection by adding
--DNO_EMBED to your ccflags variable in config.sh.
-
-Perl 5.003's namespace protection was incomplete, which has been
-rectified in Perl 5.004. However, some sites may need to maintain
-complete binary compatibility with Perl 5.003. If you are building
-Perl for such a site, then when B<Configure> asks if you want binary
-compatibility, answer "y".
-
=head2 Extensions
By default, Configure will offer to build every extension which appears
library.
Of course, you may always run Configure interactively and select only
-the Extensions you want.
+the extensions you want.
Finally, if you have dynamic loading (most modern Unix systems do)
remember that these extensions do not increase the size of your perl
=over 4
-=item gdbm in /usr/local.
+=item gdbm in /usr/local
Suppose you have gdbm and want Configure to find it and build the
GDBM_File extension. This examples assumes you have F<gdbm.h>
=back
-=head2 Installation Directories.
+=head2 Installation Directories
The installation directories can all be changed by answering the
appropriate questions in Configure. For convenience, all the
Again, these are just the defaults, and can be changed as you run
Configure.
+=head2 Changing the installation directory
+
+Configure distinguishes between the directory in which perl (and its
+associated files) should be installed and the directory in which it
+will eventually reside. For most sites, these two are the same; for
+sites that use AFS, this distinction is handled automatically.
+However, sites that use software such as B<depot> to manage software
+packages may also wish to install perl into a different directory and
+use that management software to move perl to its final destination.
+This section describes how to do this. Someday, Configure may support
+an option C<-Dinstallprefix=/foo> to simplify this.
+
+Suppose you want to install perl under the F</tmp/perl5> directory.
+You can edit F<config.sh> and change all the install* variables to
+point to F</tmp/perl5> instead of F</usr/local/wherever>. You could
+also set them all from the Configure command line. Or, you can
+automate this process by placing the following lines in a file
+F<config.over> B<before> you run Configure (replace /tmp/perl5 by a
+directory of your choice):
+
+ installprefix=/tmp/perl5
+ test -d $installprefix || mkdir $installprefix
+ test -d $installprefix/bin || mkdir $installprefix/bin
+ installarchlib=`echo $installarchlib | sed "s!$prefix!$installprefix!"`
+ installbin=`echo $installbin | sed "s!$prefix!$installprefix!"`
+ installman1dir=`echo $installman1dir | sed "s!$prefix!$installprefix!"`
+ installman3dir=`echo $installman3dir | sed "s!$prefix!$installprefix!"`
+ installprivlib=`echo $installprivlib | sed "s!$prefix!$installprefix!"`
+ installscript=`echo $installscript | sed "s!$prefix!$installprefix!"`
+ installsitelib=`echo $installsitelib | sed "s!$prefix!$installprefix!"`
+ installsitearch=`echo $installsitearch | sed "s!$prefix!$installprefix!"`
+
+Then, you can Configure and install in the usual way:
+
+ sh Configure -des
+ make
+ make test
+ make install
+
+=head2 Creating an installable tar archive
+
+If you need to install perl on many identical systems, it is
+convenient to compile it once and create an archive that can be
+installed on multiple systems. Here's one way to do that:
+
+ # Set up config.over to install perl into a different directory,
+ # e.g. /tmp/perl5 (see previous part).
+ sh Configure -des
+ make
+ make test
+ make install
+ cd /tmp/perl5
+ tar cvf ../perl5-archive.tar .
+ # Then, on each machine where you want to install perl,
+ cd /usr/local # Or wherever you specified as $prefix
+ tar xvf perl5-archive.tar
+
+=head2 Configure-time Options
+
+There are several different ways to Configure and build perl for your
+system. For most users, the defaults are sensible and will work.
+Some users, however, may wish to further customize perl. Here are
+some of the main things you can change.
+
+=head2 Binary Compatibility With Earlier Versions of Perl 5
+
+If you have dynamically loaded extensions that you built under
+perl 5.003 and that you wish to continue to use with perl 5.004, then you
+need to ensure that 5.004 remains binary compatible with 5.003.
+
+Starting with Perl 5.003, all functions in the Perl C source code have
+been protected by default by the prefix Perl_ (or perl_) so that you
+may link with third-party libraries without fear of namespace
+collisions. This change broke compatibility with version 5.002, so
+installing 5.003 or 5.004 over 5.002 or earlier will force you to
+re-build and install all of your dynamically loadable extensions.
+(The standard extensions supplied with Perl are handled
+automatically). You can turn off this namespace protection by adding
+-DNO_EMBED to your ccflags variable in config.sh.
+
+Perl 5.003's namespace protection was incomplete, but this has
+been fixed in 5.004. However, some sites may need to maintain
+complete binary compatibility with Perl 5.003. If you are building
+Perl for such a site, then when B<Configure> asks if you want binary
+compatibility, answer "y".
+
+On the other hand, if you are embedding perl into another application
+and want the maximum namespace protection, then you probably ought to
+answer "n" when B<Configure> asks if you want binary compatibility.
+
+The default answer of "y" to maintain binary compatibility is probably
+appropriate for almost everyone.
+
=head2 Selecting File IO mechanisms
Previous versions of perl used the standard IO mechanisms as defined in
=item 1.
AT&T's "sfio". This has superior performance to <stdio.h> in many
-cases, and is extensible by the use of "disipline" modules. Sfio
+cases, and is extensible by the use of "discipline" modules. Sfio
currently only builds on a subset of the UNIX platforms perl supports.
Because the data structures are completely different from stdio, perl
extension modules or external libraries may not work. This
This configuration should work on all platforms (but might not).
-You select this option via :
+You select this option via:
sh Configure -Duseperlio -Uusesfio
=back
-=head2 Changing the installation directory
-
-Configure distinguishes between the directory in which perl (and its
-associated files) should be installed and the directory in which it
-will eventually reside. For most sites, these two are the same; for
-sites that use AFS, this distinction is handled automatically.
-However, sites that use software such as B<depot> to manage software
-packages may also wish to install perl into a different directory and
-use that management software to move perl to its final destination.
-This section describes how to do this. Someday, Configure may support
-an option C<-Dinstallprefix=/foo> to simplify this.
-
-Suppose you want to install perl under the F</tmp/perl5> directory.
-You can edit F<config.sh> and change all the install* variables to
-point to F</tmp/perl5> instead of F</usr/local/wherever>. You could
-also set them all from the Configure command line. Or, you can
-automate this process by placing the following lines in a file
-F<config.over> B<before> you run Configure (replace /tmp/perl5 by a
-directory of your choice):
-
- installprefix=/tmp/perl5
- test -d $installprefix || mkdir $installprefix
- test -d $installprefix/bin || mkdir $installprefix/bin
- installarchlib=`echo $installarchlib | sed "s!$prefix!$installprefix!"`
- installbin=`echo $installbin | sed "s!$prefix!$installprefix!"`
- installman1dir=`echo $installman1dir | sed "s!$prefix!$installprefix!"`
- installman3dir=`echo $installman3dir | sed "s!$prefix!$installprefix!"`
- installprivlib=`echo $installprivlib | sed "s!$prefix!$installprefix!"`
- installscript=`echo $installscript | sed "s!$prefix!$installprefix!"`
- installsitelib=`echo $installsitelib | sed "s!$prefix!$installprefix!"`
- installsitearch=`echo $installsitearch | sed "s!$prefix!$installprefix!"`
-
-Then, you can Configure and install in the usual way:
-
- sh Configure -des
- make
- make test
- make install
-
-=head2 Building a shared libperl.so Perl library.
+=head2 Building a shared libperl.so Perl library
Currently, for most systems, the main perl executable is built by
linking the "perl library" libperl.a with perlmain.o, your static
The disadvantages are that there may be a significant performance
penalty associated with the shared libperl.so, and that the overall
-meachanism is still rather fragile with respect to different versions
+mechanism is still rather fragile with respect to different versions
and upgrades.
In terms of performance, on my test system (Solaris 2.5_x86) the perl
sh Configure -Duseshrplib
To actually build perl, you must add the current working directory to your
-LD_LIBRARY_PATH environtment variable before running make. You can do
+LD_LIBRARY_PATH environment variable before running make. You can do
this with
LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
variables in config.sh, namely archlib, archlib_exp, and
installarchlib, to point to your new architecture-dependent library.
-=head2 Creating an installable tar archive
+=head2 Other Compiler Flags
-If you need to install perl on many identical systems, it is
-convenient to compile it once and create an archive that can be
-installed on multiple systems. Here's one way to do that:
+For most users, all of the Configure defaults are fine. However,
+you can change a number of factors in the way perl is built
+by adding appropriate -D directives to your ccflags variable in
+config.sh.
- # Set up config.over to install perl into a different directory,
- # e.g. /tmp/perl5 (see previous part).
- sh Configure -des
- make
- make test
- make install
- cd /tmp/perl5
- tar cvf ../perl5-archive.tar .
- # Then, on each machine where you want to install perl,
- cd /usr/local # Or wherever you specified as $prefix
- tar xvf perl5-archive.tar
+For example, you can replace the rand() and srand() functions in the
+perl source by any other random number generator by a trick such as the
+following:
+
+ sh Configure -Dccflags='-Drand=random -Dsrand=srandom'
+
+or by adding C<-Drand=random> and C<-Dsrandom=srandom> to your ccflags
+at the appropriate Configure prompt. (You may also have to adjust
+Configure's guess for 'randbits' as well.)
=head2 What if it doesn't work?
guesses.
All the installation questions have been moved to the top, so you don't
-have to wait for them. Once you've handled them (and your C compiler &
-flags) you can type C<&-d> at the next Configure prompt and Configure
+have to wait for them. Once you've handled them (and your C compiler and
+flags) you can type C<&-d> at the next Configure prompt and Configure
will use the defaults from then on.
If you find yourself trying obscure command line incantations and
config.over tricks, I recommend you run Configure interactively
instead. You'll probably save yourself time in the long run.
-=item Hint files.
+=item Hint files
The perl distribution includes a number of system-specific hints files
in the hints/ directory. If one of them matches your system, Configure
and change either C<$ccflags> or C<$optimize>,
and then re-run B<sh Configure -S ; make depend>.
-=item No sh.
+=item No sh
If you don't have sh, you'll have to copy the sample file config_H to
config.h and edit the config.h to reflect your system's peculiarities.
=item Porting information
-Specific information for the OS/2, Plan9, and VMS ports are in the
-corresponing subdirectories. Additional information, including
+Specific information for the OS/2, Plan9, VMS and Win32 ports are in the
+corresponding subdirectories. Additional information, including
a glossary of all those config.sh variables, is in the Porting
subdirectory.
the relevant manual pages on your system doesn't help, you can
send a message to either the comp.lang.perl.misc newsgroup or to
perlbug@perl.com with an accurate description of your problem.
-Please include the I<output> of the B<./myconfig> shell script
-that comes with the distribution.
-
-[The B<perlbug> program that comes with the perl distribution is
-useful for sending in such reports, but you need to have
-perl compiled and installed before you can use it.]
+See L<"Reporting Problems"> below.
=over 4
=item *
-If you get duplicates upon linking for malloc et al, say -DHIDEMYMALLOC.
+If you get duplicates upon linking for malloc et al,
+add -DHIDEMYMALLOC to your ccflags variable in config.sh.
=item varargs
=item *
If you run into dynamic loading problems, check your setting of
-the LD_LIBRARY_PATH environment variable. Perl should build
+the LD_LIBRARY_PATH environment variable. If you're creating a static
+Perl library (libperl.a rather than libperl.so) it should build
fine with LD_LIBRARY_PATH unset, though that may depend on details
of your local set-up.
that the LD_LIBRARY_PATH environment variable includes a directory
which is a symlink to /usr/lib (such as /lib).
-The reason this causes a problem is quite subtle. The file libdl.so.1.0
+The reason this causes a problem is quite subtle. The file libdl.so.1.0
actually *only* contains functions which generate 'stub interception
failed' errors! The runtime linker intercepts links to
"/usr/lib/libdl.so.1.0" and links in internal implementation of those
functions instead. [Thanks to Tim Bunce for this explanation.]
-=item *
+=item nm extraction
If Configure seems to be having trouble finding library functions,
try not using nm extraction. You can do this from the command line
on a number of other common functions too. You are probably better off
re-running Configure without using nm extraction (see previous item).
-=item *
+=item Optimizer
If you can't compile successfully, try turning off your compiler's
-optimizier. Edit config.sh and change the line
+optimizer. Edit config.sh and change the line
optimize='-O'
the extension passes its tests anyway (see L<"make test"> below),
then don't worry about the warning message. The extension
Makefile.PL goes looking for various libraries needed on various
-systems; few systems will need all the possible libries listed.
+systems; few systems will need all the possible libraries listed.
For example, a system may have -lcposix or -lposix, but it's
unlikely to have both, so most users will see warnings for the one
they don't have. The message 'will try anyway' is intended to
this out, but Configure and the extension building process are not
quite that tightly coordinated.
+=item sh: ar: not found
+
+This is a message from your shell telling you that the command 'ar'
+was not found. You need to check your PATH environment variable to
+make sure that it includes the directory with the 'ar' command. This
+is a common problem on Solaris, where 'ar' is in the F</usr/ccs/bin>
+directory.
+
+=item db-recno failure on tests 51, 53 and 55
+
+Old versions of the DB library (including the DB library which comes
+with FreeBSD 2.1) had broken handling of recno databases with modified
+bval settings. Upgrade your DB library or OS.
+
=item *
Some additional things that have been reported for either perl4 or perl5:
Machines with half-implemented dbm routines will need to #undef I_ODBM
-db-recno failure on tests 51, 53 and 55: Old versions of the DB library
-(including the DB library which comes with FreeBSD 2.1) had broken
-handling of recno databases with modified bval settings. Upgrade your
-DB library or OS.
-
=back
=head1 make test
This will run the regression tests on the perl you just made. If it
doesn't say "All tests successful" then something went wrong. See the
-file F<t/README> in the F<t> subdirectory. Note that you can't run it
-in background if this disables opening of /dev/tty.
+file F<t/README> in the F<t> subdirectory. Note that you can't run the
+tests in background if this disables opening of /dev/tty.
If B<make test> bombs out, just B<cd> to the F<t> directory and run
-B<TEST> by hand to see if it makes any difference. If individual tests
+F<./TEST> by hand to see if it makes any difference. If individual tests
bomb, you can run them by hand, e.g.,
./perl op/groups.t
You can also read the individual tests to see if there are any helpful
comments that apply to your system.
-B<Note>: one possible reason for errors is that some external programs
+B<Note>: One possible reason for errors is that some external programs
may be broken due to the combination of your environment and the way
C<make test> exercises them. For example, this may happen if you have
-one or more of these environment variables set: C<LC_ALL LC_CTYPE
+one or more of these environment variables set: C<LC_ALL LC_CTYPE
LC_COLLATE LANG>. In some versions of UNIX, the non-English locales
are known to cause programs to exhibit mysterious errors.
If you have any of the above environment variables set, please try
-C<setenv LC_ALL C> (for C shell) or <LC_ALL=C;export LC_ALL> (for
-Bourne or Korn shell) from the command line and then retry C<make
+
+ setenv LC_ALL C
+
+(for C shell) or
+
+ LC_ALL=C;export LC_ALL
+
+for Bourne or Korn shell) from the command line and then retry C<make
test>. If the tests then succeed, you may have a broken program that
-is confusing the testing. Please run the troublesome test by hand as
+is confusing the testing. Please run the troublesome test by hand as
shown above and see whether you can locate the program. Look for
-things like: C<exec, `backquoted command`, system, open("|...")> or
+things like: C<exec, `backquoted command`, system, open("|...")> or
C<open("...|")>. All these mean that Perl is trying to run some
external program.
This will put perl into the public directory you specified to
B<Configure>; by default this is F</usr/local/bin>. It will also try
to put the man pages in a reasonable place. It will not nroff the man
-page, however. You may need to be root to run B<make install>. If you
+pages, however. You may need to be root to run B<make install>. If you
are not root, you must own the directories in question and you should
ignore any messages about chown not working.
-You may see some harmless error messages and warnings from pod2man.
-You may safely ignore them. (Yes, they should be fixed, but they
-didn't seem important enough to warrant holding up the entire release.)
-
If you want to see exactly what will happen without installing
anything, you can run
c2ph, pstruct Scripts for handling C structures in header files.
s2p sed-to-perl translator
find2perl find-to-perl translator
+ h2ph Extract constants and simple macros from C headers
h2xs Converts C .h header files to Perl extensions.
perlbug Tool to report bugs in Perl.
perldoc Tool to read perl's pod documentation.
+ pl2pm Convert Perl 4 .pl files to Perl 5 .pm modules
pod2html, Converters from perl's pod documentation format
- pod2latex, and to other useful formats.
- pod2man
+ pod2latex, to other useful formats.
+ pod2man, and
+ pod2text
+ splain Describe Perl warnings and errors
library files in $privlib and $archlib specified to
Configure, usually under /usr/local/lib/perl5/.
optional Perl compiler, or embed the perl interpreter into another
program even if the Perl source is no longer available.
-Most of the documentation in the pod/ directory is also available
-in HTML and LaTeX format. Type
-
- cd pod; make html; cd ..
-
-to generate the html versions, and
-
- cd pod; make tex; cd ..
-
-to generate the LaTeX versions.
-
-=head1 cd /usr/include; h2ph *.h sys/*.h
-
-Some of the perl library files need to be able to obtain information from
-the system header files. This command will convert the most commonly used
-header files in F</usr/include> into files that can be easily interpreted
-by perl. These files will be placed in architectural library directory
-you specified to B<Configure>; by default this is
-F</usr/local/lib/perl5/ARCH/VERSION>, where B<ARCH> is your architecture
-(such as C<sun4-solaris>) and B<VERSION> is the version of perl you are
-building (for example, C<5.003>).
-
-B<NOTE:> Due to differences in the C and perl languages, the conversion of
-the header files in not perfect. You may have to hand edit some of the
-converted files to get them to parse correctly. For example, it breaks
-spectacularly on type casting and certain structures.
-
-=head1 Coexistence with earlier versions of perl5.
+=head1 Coexistence with earlier versions of perl5
You can safely install the current version of perl5 and still run scripts
under the old binaries for versions 5.003 and later ONLY. Instead of
The architecture-dependent files are stored in a version-specific
directory (such as F</usr/local/lib/perl5/sun4-sunos/5.004>) so that
-they are still accessible. I<Note:> Perl 5.000 and 5.001 did not
+they are still accessible. I<Note:> Perl 5.000 and 5.001 did not
put their architecture-dependent libraries in a version-specific
directory. They are simply in F</usr/local/lib/perl5/$archname>. If
you will not be using 5.000 or 5.001, you may safely remove those
version of perl. If you do run into problems, and you want to continue
to use the old version of perl along with your extension, simply move
those extension files to the appropriate version directory, such as
-F</usr/local/lib/perl/archname/5.004>. Then Perl 5.004 will find your
-files in the 5.004 directory, and newer versions of perl will find your
+F</usr/local/lib/perl/archname/5.003>. Then Perl 5.003 will find your
+files in the 5.003 directory, and newer versions of perl will find your
newer extension in the site_perl directory.
Some users may prefer to keep all versions of perl in completely
(or whatever the appropriate pathname is). See pod/perltrap.pod
for possible problems running perl4 scripts under perl5.
+=head1 cd /usr/include; h2ph *.h sys/*.h
+
+Some perl scripts need to be able to obtain information from
+the system header files. This command will convert the most commonly used
+header files in F</usr/include> into files that can be easily interpreted
+by perl. These files will be placed in the architectural library directory
+you specified to B<Configure>; by default this is
+F</usr/local/lib/perl5/ARCH/VERSION>, where B<ARCH> is your architecture
+(such as C<sun4-solaris>) and B<VERSION> is the version of perl you are
+building (for example, C<5.004>).
+
+B<Note:> Due to differences in the C and perl languages, the
+conversion of the header files is not perfect. You will probably have
+to hand-edit some of the converted files to get them to parse
+correctly. For example, h2ph breaks spectacularly on type casting and
+certain structures.
+
+=head1 cd pod && make html && mv *.html (www home dir)
+
+Some sites may wish to make the documentation in the pod/ directory
+available in HTML format. Type
+
+ cd pod && make html && mv *.html <www home dir>
+
+where F<www home dir> is wherever your site keeps HTML files.
+
+=head1 cd pod && make tex && (process the latex files)
+
+Some sites may also wish to make the documentation in the pod/ directory
+available in TeX format. Type
+
+ (cd pod && make tex && <process the latex files>)
+
+=head1 Reporting Problems
+
+If you have difficulty building perl, and none of the advice in this
+file helps, and careful reading of the error message and the relevant
+manual pages on your system doesn't help either, then you should send a
+message to either the comp.lang.perl.misc newsgroup or to
+perlbug@perl.com with an accurate description of your problem.
+
+Please include the I<output> of the B<./myconfig> shell script
+that comes with the distribution. Alternatively, you can use the
+B<perlbug> program that comes with the perl distribution,
+but you need to have perl compiled and installed before you can use it.
+
+You might also find helpful information in the F<Porting>
+directory of the perl distribution.
+
=head1 DOCUMENTATION
Read the manual entries before running perl. The main documentation is
and running (either):
./roffitall -groff # If you have GNU groff installed
- ./roffitall -psroff # Otherwise
+ ./roffitall -psroff # If you have psroff
This will leave you with two postscript files ready to be printed.
+(You may need to fix the roffitall command to use your local troff
+set-up.)
Note that you must have performed the installation already before
running the above, since the script collects the installed files to
=head1 LAST MODIFIED
-8 February 1997
+18 February 1997
projects / p5sagit/p5-mst-13.2.git / commitdiff