Each of these is explained in further detail below.
-=head1 BUILDING PERL5
+You should probably at least skim through this entire document before
+proceeding. Special notes specific to this release are identified
+by B<NOTE>.
+
+If you're building Perl on a non-Unix system, you should also read
+the README file specific to your operating system, since this may
+provide additional or different instructions for building Perl.
+
+=head1 DESCRIPTION
+
+The following is the procedures you need to follow in order to successfully
+build perl.
=head1 Start with a Fresh Distribution.
+If you have built perl before, you should clean out the build directory
+with the command
+
+ make realclean
+
The results of a Configure run are stored in the config.sh file. If
you are upgrading from a previous version of perl, or if you change
systems or compilers or make other significant changes, or if you are
re-use your old config.sh. Simply remove it or rename it, e.g.
mv config.sh config.sh.old
-
+
Then run Configure.
=head1 Run Configure.
This is the preferred way to specify gcc (or another alternative
compiler) so that the hints files can set appropriate defaults.
+If you want to use your old config.sh but override some of the items
+with command line options, you need to use B<Configure -O>.
+
If you are willing to accept all the defaults, and you want terse
output, you can run
using the Configure command line option -Dprefix='/some/directory',
e.g.
- Configure -Dprefix=/opt/local
+ sh Configure -Dprefix=/opt/perl
+
+If your prefix contains the string "perl", then the directories
+are simplified. For example, if you use prefix=/opt/perl,
+then Configure will suggest /opt/perl/lib instead of
+/usr/local/lib/perl5/.
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 by
using the Configure command line option -Uusedl.
+=head2 Extensions
+
+By default, Configure will offer to build every extension which appears
+to be supported. For example, Configure will offer to build GDBM_File
+only if it is able to find the gdbm library. (See examples below.)
+DynaLoader, Fcntl and FileHandle are always built by default.
+Configure does not contain code to test for POSIX compliance, so POSIX
+is always built by default as well. If you wish to skip POSIX, you can
+set the Configure variable useposix=false either in a hint file or from
+the Configure command line. Similarly, the Safe extension is always
+built by default, but you can skip it by setting the Configure variable
+usesafe=false either in a hint file for from the command line.
+
+In summary, here are the Configure command-line variables you can set
+to turn off each extension:
+
+ DB_File i_db
+ DynaLoader (Must always be included)
+ Fcntl (Always included by default)
+ FileHandle (Always included by default)
+ GDBM_File i_gdbm
+ NDBM_File i_ndbm
+ ODBM_File i_dbm
+ POSIX useposix
+ SDBM_File (Always included by default)
+ Safe usesafe
+ Socket d_socket
+
+Thus to skip the NDBM_File extension, you can use
+
+ sh Configure -Ui_ndbm
+
+Again, this is taken care of automatically if you don't have the ndbm
+library.
+
+Of course, you may always run Configure interactively and select only
+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
+executable, nor do they impact start-up time, so you probably might as
+well build all the ones that will work on your system.
+
=head2 GNU-style configure
If you prefer the GNU-style B<configure> command line interface, you can
=head2 Including locally-installed libraries
-Perl5 comes with a number of database extensions, including interfaces
-to dbm, ndbm, gdbm, and Berkeley db. For each extension, if Configure
-can find the appropriate header files and libraries, it will automatically
-include that extension.
+Perl5 comes with interfaces to number of database extensions, including
+dbm, ndbm, gdbm, and Berkeley db. For each extension, if
+Configure can find the appropriate header files and libraries, it will
+automatically include that extension. The gdbm and db libraries
+are B<not> included with perl. See the library documentation for
+how to obtain the libraries.
I<Note:> If your database header (.h) files are not in a
directory normally searched by your C compiler, then you will need to
=back
+=head2 Installation Directories.
+
+The installation directories can all be changed by answering the
+appropriate questions in Configure. For convenience, all the
+installation questions are near the beginning of Configure.
+
+By default, Configure uses the following directories for
+library files (archname is a string like sun4-sunos, determined
+by Configure)
+
+ /usr/local/lib/perl5/archname/5.002
+ /usr/local/lib/perl5/
+ /usr/local/lib/perl5/site_perl/archname
+ /usr/local/lib/perl5/site_perl
+
+and the following directories for manual pages:
+
+ /usr/local/man/man1
+ /usr/local/lib/perl5/man/man3
+
+(Actually, Configure recognizes the SVR3-style
+/usr/local/man/l_man/man1 directories, if present, and uses those
+instead.) The module man pages are stuck in that strange spot so that
+they don't collide with other man pages stored in /usr/local/man/man3,
+and so that Perl's man pages don't hide system man pages. On some
+systems, B<man less> would end up calling up Perl's less.pm module man
+page, rather than the B<less> program.
+
+If you specify a prefix that contains the string "perl", then the
+directory structure is simplified. For example, if you Configure
+with -Dprefix=/opt/perl, then the defaults are
+
+ /opt/perl/lib/archname/5.002
+ /opt/perl/lib
+ /opt/perl/lib/site_perl/archname
+ /opt/perl/lib/site_perl
+
+ /opt/perl/man/man1
+ /opt/perl/man/man3
+
+The perl executable will search the libraries in the order given
+above.
+
+The directories site_perl and site_perl/archname are empty, but are
+intended to be used for installing local or site-wide extensions. Perl
+will automatically look in these directories. Previously, most sites
+just put their local extensions in with the standard distribution.
+
+In order to support using things like #!/usr/local/bin/perl5.002 after
+a later version is released, architecture-dependent libraries are
+stored in a version-specific directory, such as
+/usr/local/lib/perl5/archname/5.002/. In 5.000 and 5.001, these files
+were just stored in /usr/local/lib/perl5/archname/. If you will not be
+using 5.001 binaries, you can delete the standard extensions from the
+/usr/local/lib/perl5/archname/ directory. Locally-added extensions can
+be moved to the site_perl and site_perl/archname directories.
+
+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
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!"`
+ shrpdir=`echo $shrpdir | sed "s!$prefix!$installprefix!"`
Then, you can Configure and install in the usual way:
- sh ./Configure -des
+ sh Configure -des
make
make test
make install
# Set up config.over to install perl into a different directory,
# e.g. /tmp/perl5 (see previous part).
- sh ./Configure -des
+ sh Configure -des
make
make test
make install
=over 4
+=item Running Configure Interactively
+
+If Configure runs into trouble, remember that you can always run
+Configure interactively so that you can check (and correct) its
+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
+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.
The perl distribution includes a number of system-specific hints files
file for further information. See F<hints/solaris_2.sh> for an
extensive example.
+=item *** WHOA THERE!!! ***
+
+Occasionally, Configure makes a wrong guess. For example, on SunOS
+4.1.3, Configure incorrectly concludes that tzname[] is in the
+standard C library. The hint file is set up to correct for this. You
+will see a message:
+
+ *** WHOA THERE!!! ***
+ The recommended value for $d_tzname on this machine was "undef"!
+ Keep the recommended value? [y]
+
+You should always keep the recommended value unless, after reading the
+relevant section of the hint file, you are sure you want to try
+overriding it.
+
+If you are re-using an old config.sh, the word "previous" will be
+used instead of "recommended". Again, you will almost always want
+to keep the previous value, unless you have changed something on your
+system.
+
+For example, suppose you have added libgdbm.a to your system
+and you decide to reconfigure perl to use GDBM_File. When you run
+Configure again, you will need to add -lgdbm to the list of libraries.
+Now, Configure will find your gdbm library and will issue a message:
+
+ *** WHOA THERE!!! ***
+ The previous value for $i_gdbm on this machine was "undef"!
+ Keep the previous value? [y]
+
+In this case, you do I<not> want to keep the previous value, so you
+should answer 'n'. (You'll also have to manuually add GDBM_File to
+the list of dynamic extensions to build.)
+
=item Changing Compilers
If you change compilers or make other significant changes, you should
=item Propagating your changes
If you later make any changes to F<config.sh>, you should propagate
-them to all the .SH files by running B<Configure -S>.
+them to all the .SH files by running B<sh Configure -S>.
=item config.over
You can also supply a shell script config.over to over-ride Configure's
guesses. It will get loaded up at the very end, just before config.sh
is created. You have to be careful with this, however, as Configure
-does no checking that your changes make sense.
+does no checking that your changes make sense. See the section on
+changing the installation directory for an example.
=item config.h
To change the C flags for all the files, edit F<config.sh>
and change either C<$ccflags> or C<$optimize>,
-and then re-run B<Configure -S ; make depend>.
+and then re-run B<sh Configure -S ; make depend>.
=item No sh.
F<Makefile> and F<makefile> is the dependencies at the bottom of
F<makefile>. If you have to make any changes, you should edit
F<makefile>, not F<Makefile> since the Unix B<make> command reads
-F<makefile>.
+F<makefile> first.
Configure will offer to do this step for you, so it isn't listed
explicitly above.
and i_varags='undef' in config.sh. The problem is usually solved
by running fixincludes correctly.
-If you wish to use dynamic loading on SunOS or Solaris, and you
-have GNU as and GNU ld installed, you may need to add B<-B/bin/> to
-your $ccflags and $ldflags so that the system's versions of as
+If you have problems with dynamic loading using gcc on SunOS or
+Solaris, and you are using GNU as and GNU ld, you may need to add
+B<-B/bin/> (for SunOS) or B<-B/usr/ccs/bin/> (for Solaris) to your
+$ccflags, $ldflags, and $lddlflags so that the system's versions of as
and ld are used.
If you run into dynamic loading problems, check your setting of
fine with LD_LIBRARY_PATH unset, though that may depend on details
of your local set-up.
+If Configure seems to be having trouble finding library functions,
+try not using nm extraction. You can do this from the command line
+with
+
+ sh Configure -Uusenm
+
=back
=head1 make test
./perl op/groups.t
+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. This may happen for example if you have
+one or more of these environment variables set:
+C<LC_ALL LC_CTYPE LANG>. In certain UNIXes especially 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> or <LC_ALL=C;export LC_ALL>, for C<csh>-style and
+C<Bourne>-style shells, respectively, 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 shown above and see whether you can locate the program.
+Look for things like:
+C<exec, `backquoted command`, system, open("|...")> or C<open("...|")>.
+All these mean that Perl is trying to run some external program.
+
=head1 INSTALLING PERL5
=head1 make install
are not root, you must own the directories in question and you should
ignore any messages about chown not working.
+B<NOTE:> In the 5.002 release, you will 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 5.002 release.)
+
If you want to see exactly what will happen without installing
anything, you can run
-
+
./perl installperl -n
./perl installman -n
s2p sed-to-perl translator
find2perl find-to-perl translator
h2xs Converts C .h header files to Perl extensions.
+ perlbug Tool to report bugs in Perl.
perldoc Tool to read perl's pod documentation.
pod2html, Converters from perl's pod documentation format
pod2latex, and to other useful formats.
man pages under /usr/local/lib/perl5/man/man3.
pod/*.pod in $privlib/pod/.
+Installperl will also create the library directories $siteperl and
+$sitearch listed in config.sh. Usually, these are something like
+ /usr/local/lib/perl5/site_perl/
+ /usr/local/lib/perl5/site_perl/$archname
+where $archname is something like sun4-sunos. These directories
+will be used for installing extensions.
+
Perl's *.h header files and the libperl.a library are also
installed under $archlib so that any user may later build new
extensions even if the Perl source is no longer available.
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.
+
+You can safely install the current version of perl5 and still run scripts
+under the old binaries for versions 5.002 and later ONLY. Instead of
+starting your script with #!/usr/local/bin/perl, just start it with
+#!/usr/local/bin/perl5.001 (or whatever version you want to run.)
+If you want to retain a version of perl5 prior to perl5.002, you'll
+need to install the current version in a separate directory tree,
+since some of the architecture-independent library files have changed
+in incompatible ways.
+
+The architecture-dependent files are stored in a version-specific
+directory (such as F</usr/local/lib/perl5/sun4-sunos/5.002>) so that
+they are still accessible. I<Note:> perl5.000 and perl5.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
+files.
+
+The standard library files in F</usr/local/lib/perl5>
+should be useable by all versions of perl5 since perl5.002.
+
+Most extensions will probably not need to be recompiled to use with a newer
+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.002>. Then perl5.002 will find your
+files in the 5.002 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
+separate directories. One convenient way to do this is by
+using a separate prefix for each version, such as
+
+ sh Configure -Dprefix=/opt/perl5.002
+
+and adding /opt/perl5.002/bin to the shell PATH variable. Such users
+may also wish to add a symbolic link /usr/local/bin/perl so that
+scripts can still start with #!/usr/local/bin/perl.
+
+B<NOTE>: Starting with 5.002_01, all functions in the perl C source
+code are protected by default by the prefix Perl_ (or perl_) so that
+you may link with third-party libraries without fear of namespace
+collisons. This breaks compatability with the initially released
+version of 5.002, so once you install 5.002_01 (or higher) you will
+need 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. This is a one-time
+change. In the future, we certainly hope that most extensions won't
+need to be recompiled for use with a newer version of perl.
+
=head1 Coexistence with perl4
You can safely install perl5 even if you want to keep perl4 around.
process. Most perl4 scripts should run just fine under perl5.
However, if you have any scripts that require perl4, you can replace
the C<#!> line at the top of them by C<#!/usr/local/bin/perl4.036>
-(or whatever the appropriate pathname is).
+(or whatever the appropriate pathname is). See pod/perltrap.pod
+for possible problems running perl4 scripts under perl5.
=head1 DOCUMENTATION
Andy Dougherty <doughera@lafcol.lafayette.edu>, borrowing I<very> heavily
from the original README by Larry Wall.
-18 October 1995
+=head1 LAST MODIFIED
+
+07 July 1996
projects / p5sagit/p5-mst-13.2.git / blobdiff