$\1 and serious bug in evalling

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

diff --git a/INSTALL b/INSTALL
index df4822b..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.
@@ -1330,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)
-
-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.
+=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.
+
+The following command-line is an example of the one we use to convert
+perl documentation:
+
+  ./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)