Patch from Andreas.
[p5sagit/p5-mst-13.2.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index b72e43c..e42fcb8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -25,7 +25,7 @@ experiencing difficulties building perl, you should probably I<not>
 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.
@@ -46,6 +46,9 @@ to get a listing.  To compile with gcc, for example, you can run
 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
 
@@ -57,13 +60,60 @@ the default installation directory, when Configure prompts you or by
 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 and Fcntl 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)
+    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
@@ -82,10 +132,12 @@ Cross compiling is currently not supported.
 
 =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
@@ -159,6 +211,66 @@ F</usr/you>, then you have to include both, namely
 
 =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
@@ -189,10 +301,11 @@ directory of your choice):
     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
+    sh Configure -des
     make
     make test
     make install
@@ -205,7 +318,7 @@ 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
+    sh Configure -des
     make
     make test
     make install
@@ -219,6 +332,21 @@ installed on multiple systems.  Here's one way to do that:
 
 =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   '&-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
@@ -243,7 +371,7 @@ B<gcc>, you should almost always remove your old config.sh.
 =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
 
@@ -273,7 +401,7 @@ lost the next time you run B<Configure>.
 
 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.
 
@@ -291,7 +419,7 @@ The output is stored in F<makefile>.  The only difference between
 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.
@@ -374,6 +502,12 @@ the LD_LIBRARY_PATH environment variable.  Perl should build
 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
@@ -401,7 +535,7 @@ ignore any messages about chown not working.
 
 If you want to see exactly what will happen without installing
 anything, you can run
-       
+
        ./perl installperl -n
        ./perl installman -n
 
@@ -419,6 +553,7 @@ B<make install> will install the following:
        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.
@@ -432,6 +567,13 @@ B<make install> will install the following:
        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.
@@ -454,6 +596,32 @@ to generate the html versions, and
 
 to generate the LaTeX versions.
 
+=head1 Coexistence with earlier versions of perl5.
+
+You can safely install the current version of perl5 and still run
+scripts under the old binaries.  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.)
+
+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.
+
+Most extensions will 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.
+
 =head1 Coexistence with perl4
 
 You can safely install perl5 even if you want to keep perl4 around.
@@ -481,4 +649,6 @@ is sometimes useful for finding things in the library modules.
 Andy Dougherty <doughera@lafcol.lafayette.edu>, borrowing I<very> heavily
 from the original README by Larry Wall.
 
-18 October 1995
+=head 2 LAST MODIFIED
+
+04 January 1996