$\1 and serious bug in evalling

[p5sagit/p5-mst-13.2.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index cdb18d2..fa6c823 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -14,7 +14,7 @@ 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.
@@ -381,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
@@ -619,7 +617,7 @@ 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.  On Digital Unix, you can
-ovveride LD_LIBRARY_PATH by setting the _RLD_ROOT environment variable
+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
@@ -1332,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 the documentation in the pod/ directory
-available in HTML format.  Type
+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.
 
-       cd pod && make html && mv *.html <www home dir>
+The following command-line is an example of the one we use to convert
+perl documentation:
 
-where F<www home dir> is wherever your site keeps HTML files.
+  ./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
+
+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)
 
@@ -1395,4 +1410,4 @@ feedback from the perl5-porters@perl.org folks.
 
 =head1 LAST MODIFIED
 
-$Id: INSTALL,v 1.17 1997/05/08 21:08:15 doughera Released $
+$Id: INSTALL,v 1.18 1997/05/29 18:24:10 doughera Exp $