Patch by Gerard Goosen to avoid building man pages for extensions
[p5sagit/p5-mst-13.2.git] / README.vms
index 06deb13..87402eb 100644 (file)
@@ -32,9 +32,13 @@ compiler is required to build Perl.  VAX C is *not* ANSI compliant, as it
 died a natural death some time before the standard was set.  Therefore 
 VAX C will not compile Perl 5.005 or later.  We are sorry about that.
 
-If you are stuck without Compaq (formerly DEC) C consider trying Gnu C
-instead, though there have been no recent reports of builds using Gnu C. 
-There is minimal support for Compaq C++ but this support is not complete;
+There have been no recent reports of builds using Gnu C, but latent
+(and most likely outdated) support for it is still present in various
+parts of the sources.  Currently the HP (formerly Compaq, and even 
+more formerly DEC) C compiler is the only viable alternative for
+building Perl.
+
+There is minimal support for HP C++ but this support is not complete;
 if you get it working please write to the vmsperl list (for info see
 L</"Mailing Lists">).
 
@@ -53,11 +57,6 @@ There are still some unimplemented system functions, and of course we
 could use modules implementing useful VMS system services, so if you'd like
 to lend a hand we'd love to have you.  Join the Perl Porting Team Now!
 
-The current sources and build procedures have been tested on a VAX using
-DEC C, and on an AXP using DEC C. If you run into problems with
-other compilers, please let us know.  (Note: DEC C was renamed to Compaq C
-around version 6.2).
-
 There are issues with various versions of DEC C, so if you're not running a
 relatively modern version, check the "DEC C issues" section later on in this
 document.
@@ -70,7 +69,7 @@ In addition to VMS and DCL you will need two things:
 
 =item 1  A C compiler. 
 
-DEC (now Compaq) C or gcc for VMS (AXP or VAX).
+HP (formerly Compaq, more formerly DEC) C for VMS (VAX, Alpha, or Itanium).
 
 =item 2  A make tool. 
 
@@ -92,20 +91,25 @@ You may also want to have on hand:
 
 A de-compressor for *.gz and *.tgz files available from a number 
 of web/ftp sites and is distributed on the OpenVMS Freeware CD-ROM 
-from Compaq.
+from HP.
 
-    http://www.fsf.org/order/ftp.html
-    http://www.openvms.compaq.com/freeware/
+    http://www.hp.com/go/openvms/freeware/
     http://www.crinoid.com/utils/
 
 =item 2  VMS TAR 
 
 For reading and writing unix tape archives (*.tar files).  Vmstar is also 
 available from a number of web/ftp sites and is distributed on the OpenVMS
-Freeware CD-ROM from Compaq.
+Freeware CD-ROM from HP.
+
+    http://www.hp.com/go/openvms/freeware/
+
+Recent versions of VMS tar on ODS-5 volumes may extract tape archive
+files with ^. escaped periods in them.  See below for further workarounds.
+
+A port of GNU tar is also available as part of the GNV package:
 
-    ftp://ftp.lp.se/vms/
-    http://www.openvms.compaq.com/freeware/
+    http://gnv.sourceforge.net/
 
 =item 3  UNZIP.EXE for VMS
 
@@ -113,10 +117,10 @@ A combination decompressor and archive reader/writer for *.zip files.
 Unzip is available from a number of web/ftp sites.
 
     http://www.info-zip.org/UnZip.html
-    http://www.openvms.compaq.com/freeware/
-    ftp://ftp.openvms.compaq.com/
+    http://www.hp.com/go/openvms/freeware/
+    ftp://ftp.hp.com/pub/openvms
     ftp://ftp.madgoat.com/madgoat/
-    ftp://ftp.process.com/vms-freeware/
+    ftp://ftp.process.com/vms-freeware/fileserv
 
 =item 4  MOST
 
@@ -136,7 +140,7 @@ distribution) and applied with GNU patch.  VMS ports of these utilities are
 available here:
 
     http://www.crinoid.com/utils/
-    http://www.openvms.compaq.com/freeware/
+    http://www.hp.com/go/openvms/freeware/
 
 =back
 
@@ -151,6 +155,33 @@ If you want to include socket support, you'll need a TCP/IP stack and either
 DEC C, or socket libraries.  See the "Socket Support (optional)" topic 
 for more details.
 
+=head1 Unpacking the Perl source code
+
+You may need to set up a foreign symbol for the unpacking utility of choice.
+
+If you unpack a perl source kit with a name containing multiple periods on
+an ODS-5 volume using recent versions of vmstar (e.g. V3.4 or later) you may
+need to be especially careful in unpacking the tape archive file.  Try to use
+the ODS-2 compatability qualifiers such as:
+
+    vmstar /extract/verbose/ods2 perl-V^.VIII^.III.tar
+
+or:
+
+    vmstar -xvof perl-5^.8^.3.tar
+
+If you neglected to use the /ODS2 qualifier or the -o switch then you
+could rename the source directory:
+
+    set security/protection=(o:rwed) perl-5^.8^.3.dir
+    rename perl-5^.8^.3.dir perl-5_8_3.dir
+
+Perl on VMS as of 5.8.3 does not completely handle extended file
+parse styles such as are encountered on ODS-5.  While it can be built,
+installed, and run on ODS-5 filesystems; it may encounter
+trouble with characters that are otherwise illegal on ODS-2
+volumes (notably the ^. escaped period sequence).
+
 =head1 Configuring the Perl build
 
 To configure perl (a necessary first step), issue the command
@@ -176,12 +207,22 @@ SYSTEM table then try DEFINE TMP "NL:" or somesuch in your process table)
 otherwise simply deassign the dangerous logical names.  The potentially 
 troublesome logicals and symbols are:
 
-    TMP  "LOGICAL"
-    LIB  "LOGICAL"
-    T    "LOGICAL"
-    FOO  "LOGICAL"
-    EXT  "LOGICAL"
-    TEST "SYMBOL"
+    COMP    "LOGICAL"
+    EXT     "LOGICAL"
+    FOO     "LOGICAL"
+    LIB     "LOGICAL"
+    LIST    "LOGICAL"
+    MIME    "LOGICAL"
+    POSIX   "LOGICAL"
+    SYS     "LOGICAL"
+    T       "LOGICAL"
+    THREAD  "LOGICAL"
+    THREADS "LOGICAL"
+    TIME    "LOGICAL"
+    TMP     "LOGICAL"
+    UNICODE "LOGICAL"
+    UTIL    "LOGICAL"
+    TEST    "SYMBOL"
 
 As a handy shortcut, the command:
 
@@ -227,10 +268,6 @@ inappropriate changes to configure.com or config_h.SH can render perl
 unbuildable; odds are that there's nothing in there you'll need to
 change.
 
-The one exception is the various *DIR install locations. Changing those
-requires changes in genconfig.pl as well.  Be really careful if you need to
-change these, as they can cause some fairly subtle problems.
-
 =head2 Socket Support (optional) for Perl on VMS
 
 Perl includes a number of functions for IP sockets, which are available if
@@ -289,6 +326,17 @@ a lot of tests.  If any tests fail, there will be a note made on-screen.
 At the end of all the tests, a summary of the tests, the number passed and 
 failed, and the time taken will be displayed.
 
+The test driver invoked via MMS TEST has a DCL wrapper ([.VMS]TEST.COM) that
+downgrades privileges to NETMBX, TMPMBX for the duration of the test run,
+and then restores them to their prior state upon completion of testing. 
+This is done to ensure that the tests run in a private sandbox and can do no
+harm to your system even in the unlikely event something goes badly wrong in
+one of the test scripts while running the tests from a privileged account. 
+A side effect of this safety precaution is that the account used to run the
+test suite must be the owner of the directory tree in which Perl has been
+built; otherwise the manipulations of temporary files and directories
+attempted by some of the tests will fail.
+
 If any tests fail, it means something is wrong with Perl. If the test suite
 hangs (some tests can take upwards of two or three minutes, or more if
 you're on an especially slow machine, depending on your machine speed, so
@@ -304,10 +352,18 @@ issuing this command sequence:
 where ".typ" is the file type of the Perl images you just built (if you
 didn't do anything special, use .EXE), and "[.subdir]test.T" is the test
 that failed. For example, with a normal Perl build, if the test indicated
-that [.op]time failed, then you'd do this:
+that t/op/time failed, then you'd do this:
 
     @ [.VMS]TEST .EXE "" "-v" [.OP]TIME.T
 
+Note that test names are reported in UNIX syntax and relative to the
+top-level build directory.  When supplying them individually to the test
+driver, you can use either UNIX or VMS syntax, but you must give the path
+relative to the [.T] directory and you must also add the .T extension to the
+filename.  So, for example if the test lib/Math/Trig fails, you would run:
+
+    @ [.VMS]TEST .EXE "" -"v" [-.lib.math]trig.t
+
 When you send in a bug report for failed tests, please include the output
 from this command, which is run from the main source directory:
 
@@ -461,8 +517,8 @@ to NOT INSTALL PERL.EXE with PRIVs!
 
 =head2 Running h2ph to create perl header files (optional) on VMS
 
-If using DEC C or Compaq C ensure that you have extracted loose versions
-of your compiler's header or *.H files.  Be sure to check the contents of:
+If using HP C, ensure that you have extracted loose versions of your 
+compiler's header or *.H files.  Be sure to check the contents of:
 
     SYS$LIBRARY:DECC$RTLDEF.TLB
     SYS$LIBRARY:SYS$LIB_C.TLB
@@ -503,6 +559,12 @@ configuration script will warn if it thinks you are too deep (at least on
 a VAX or on Alpha versions of VMS prior to 7.2).  But MakeMaker will not 
 warn you if you start out building a module too deep in a directory.
 
+As noted above ODS-5 escape sequences such as ^. can break the perl
+build.  Solutions include renaming files and directories as needed or
+being careful to use the -o switch or /ODS2 qualifier with latter
+versions of the vmstar utility when unpacking perl or CPAN modules
+on ODS-5 volumes.
+
 Be sure that the process that you use to build perl has a PGFLQ greater
 than 100000.  Be sure to have a correct local time zone to UTC offset
 defined (in seconds) in the logical name SYS$TIMEZONE_DIFFERENTIAL before
@@ -679,7 +741,7 @@ Vmsperl pages on the web include:
     http://www-ang.kfunigraz.ac.at/~binder/perl.html
     http://lists.perl.org/showlist.cgi?name=vmsperl
     http://archive.develooper.com/vmsperl@perl.org/
-    http://www.openvms.compaq.com/openvms/products/ips/apache/csws_modperl.html
+    http://h71000.www7.hp.com/openvms/products/ips/apache/csws_modperl.html
 
 =head1 SEE ALSO