stringify looses integerness
[p5sagit/p5-mst-13.2.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 451c6da..fa6c823 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -14,16 +14,17 @@ The basic steps to build and install perl5 on a Unix system are:
 
        # You may also wish to add these:
        (cd /usr/include && h2ph *.h sys/*.h)
-       (cd pod && make html && mv *.html <www home dir>)
+       (installhtml --help)
        (cd pod && make tex  && <process the latex files>)
 
 Each of these is explained in further detail below.
 
-For information on non-Unix systems, see L<"Porting information"> below.
+For information on non-Unix systems, see the section on
+L<"Porting information"> below.
 
-For information on what's new in this release, see the pod/perldelta.pod
-file.  For more detailed information about specific changes, see the
-Changes file.
+For information on what's new in this release, see the
+pod/perldelta.pod file.  For more detailed information about specific
+changes, see the Changes file.
 
 =head1 DESCRIPTION
 
@@ -299,10 +300,10 @@ 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.
 
-It is highly recommend that you running Configure interactively
-to be sure it puts everything where you want it.  At any point
-during the Configure process, you can answer a question with
-C<&-d> and Configure will use the defaults from then on.
+I highly recommend running Configure interactively to be sure it puts
+everything where you want it.  At any point during the Configure
+process, you can answer a question with  &-d  and Configure
+will use the defaults from then on.
 
 By default, Configure uses the following directories for
 library files  (archname is a string like sun4-sunos, determined
@@ -380,13 +381,11 @@ use that management software to move perl to its final destination.
 This section describes how to do this.  Someday, Configure may support
 an option -Dinstallprefix=/foo to simplify this.
 
-Suppose you want to install perl under the /tmp/perl5 directory.
-You can edit config.sh and change all the install* variables to
-point to /tmp/perl5 instead of /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
-config.over before you run Configure (replace /tmp/perl5 by a
-directory of your choice):
+Suppose you want to install perl under the /tmp/perl5 directory.  You
+can edit config.sh and change all the install* variables to point to
+/tmp/perl5 instead of /usr/local/wherever.  Or, you can automate this
+process by placing the following lines in a file config.over before you
+run Configure (replace /tmp/perl5 by a directory of your choice):
 
     installprefix=/tmp/perl5
     test -d $installprefix || mkdir $installprefix
@@ -617,7 +616,9 @@ libperl.so.4 rather with the installed libperl.so.4?  The answer is
 that you might not be able to.  The installation directory is encoded
 in the perl binary with the LD_RUN_PATH environment variable (or
 equivalent ld command-line option).  On Solaris, you can override that
-with LD_LIBRARY_PATH; on Linux you can't.
+with LD_LIBRARY_PATH; on Linux you can't.  On Digital Unix, you can
+override LD_LIBRARY_PATH by setting the _RLD_ROOT environment variable
+to point to the perl build directory.
 
 The only reliable answer is that you should specify a different
 directory for the architecture-dependent library for your -DDEBUGGING
@@ -971,11 +972,20 @@ 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/bin/ (for SunOS) or -B/usr/ccs/bin/ (for Solaris) to your
 $ccflags, $ldflags, and $lddlflags so that the system's versions of as
-and ld are used.  Alternatively, you can use the GCC_EXEC_PREFIX
+and ld are used.  Note that the trailing '/' is required.
+Alternatively, you can use the GCC_EXEC_PREFIX
 environment variable to ensure that Sun's as and ld are used.  Consult
 your gcc documentation for further information on the -B option and
 the GCC_EXEC_PREFIX variable.
 
+One convenient way to ensure you are not using GNU as and ld is to
+invoke Configure with
+
+    sh Configure -Dcc='gcc -B/usr/ccs/bin/'
+
+for Solaris systems.  For a SunOS system, you must use -B/bin/
+instead.
+
 =item ld.so.1: ./perl: fatal: relocation error:
 
 If you get this message on SunOS or Solaris, and you're using gcc,
@@ -1283,6 +1293,11 @@ and adding /opt/perl5.004/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.
 
+If you are installing a development subversion, you probably ought to
+seriously consider using a separate directory, since development
+subversions may not have all the compatibility wrinkles ironed out
+yet.
+
 =head1 Coexistence with perl4
 
 You can safely install perl5 even if you want to keep perl4 around.
@@ -1315,14 +1330,31 @@ 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)
+=head installhtml --help
+
+Some sites may wish to make perl documentation available in HTML
+format.  The installhtml utility can be used to convert pod
+documentation into linked HTML files and install install them.
 
-Some sites may wish to make the documentation in the pod/ directory
-available in HTML format.  Type
+The following command-line is an example of the one we use to convert
+perl documentation:
 
-       cd pod && make html && mv *.html <www home dir>
+  ./installhtml                   \
+      --podroot=.                 \
+      --podpath=lib:ext:pod:vms   \
+      --recurse                   \
+      --htmldir=/perl/nmanual     \
+      --htmlroot=/perl/nmanual    \
+      --splithead=pod/perlipc     \
+      --splititem=pod/perlfunc    \
+      --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \
+      --verbose
 
-where F<www home dir> is wherever your site keeps HTML files.
+See the documentation in installhtml for more details.  It can take
+many minutes to execute a large installation and you should expect to
+see warnings like "no title", "unexpected directive" and "cannot
+resolve" as the files are processed. We are aware of these problems
+(and would welcome patches for them).
 
 =head1 cd pod && make tex && (process the latex files)
 
@@ -1378,4 +1410,4 @@ feedback from the perl5-porters@perl.org folks.
 
 =head1 LAST MODIFIED
 
-$Id: INSTALL,v 1.13 1997/04/03 18:29:14 doughera Released $
+$Id: INSTALL,v 1.18 1997/05/29 18:24:10 doughera Exp $