Assorted updates to README.vms
authorCraig A. Berry <craigberry@mac.com>
Sat, 6 Apr 2013 03:14:16 +0000 (22:14 -0500)
committerCraig A. Berry <craigberry@mac.com>
Sat, 6 Apr 2013 15:41:13 +0000 (10:41 -0500)
README.vms

index e3746c5..2ea6211 100644 (file)
@@ -10,12 +10,10 @@ perlvms - Configuring, building, testing, and installing perl on VMS
 
 To configure, build, test, and install perl on VMS:
 
-    @ Configure
-    mms
-    mms test
-    mms install
-
-mmk may be used in place of mms in the last three steps.
+    @configure
+    mmk
+    mmk test
+    mmk install
 
 =head1 DESCRIPTION
 
@@ -26,22 +24,6 @@ For best results, make sure you read the "Configuring the Perl Build",
 you build or install.  Also please note other changes in the current
 release by having a look at L<perldelta/VMS>.
 
-Also note that, as of Perl version 5.005 and later, an ANSI C compliant 
-compiler is required to build Perl.  VAX C is I<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.
-
-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">).
-
-
 =head2 Introduction to Perl on VMS
 
 The VMS port of Perl is as functionally complete as any other Perl port
@@ -58,7 +40,7 @@ to lend a hand we'd love to have you.  Join the Perl Porting Team Now!
 
 =head2 Other required software for Compiling Perl on VMS
 
-In addition to VMS and DCL you will need two things:
+In addition to VMS and DCL you will need three things:
 
 =over 4
 
@@ -69,12 +51,30 @@ Various ancient versions of DEC C had some caveats, so if you're using a
 version older than 7.x on Alpha or Itanium or 6.x on VAX, you may need to 
 upgrade to get a successful build.
 
+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.
+
+There is rudimentary but not quite complete support for HP C++; to try it out,
+configure with C<-"Dusecxx" -"Duser_c_flags=/WARN=INFORMATIONAL=NOCTOBUTCONREFM">.
+
 =item 2  A make tool. 
 
-HP's MMS may work, but MadGoat's free MMS analog MMK (available from
-http://www.kednos.com/kednos/Resources/MMK) has consistently worked
-better. Gnu Make might work, but it's been so long since anyone's tested
-it that we're not sure.  MMK is free though, so go ahead and use that.
+You will need the free MMS analog MMK (available from
+L<http://ftp.endlesssoftware.com.au/mmk/kits/> or 
+L<https://github.com/endlesssoftware/mmk>). HP's MMS has not been known to work for
+some time as Perl's automatically-generated description files are too complex for it,
+but MMS support may return in the future.  Gnu Make might work, but it's been so long
+since anyone's tested it that we're not sure.
+
+=item 3  ODS-5 and Extended Parse
+
+All development and testing of Perl on VMS takes place on ODS-5 volumes with
+extended parse enabled in the environment via the command C<SET PROCESS/PARSE=EXTENDED>.
+Latent support for ODS-2 volumes (including on VAX) is still present, but the number
+of components that require ODS-5 features is steadily growing and ODS-2 support may be
+completely removed in a future release.
+
 
 =back
 
@@ -84,51 +84,48 @@ You may also want to have on hand:
 
 =over 4
 
-=item 1  GUNZIP/GZIP for VMS 
+=item 1  gunzip/gzip for VMS 
 
 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 HP.
-
-    http://www.hp.com/go/openvms/freeware/
+of web/ftp sites such as:
 
-=item 2  VMS TAR 
+    L<http://www.antinode.info/dec/sw/gzip.html>
+    L<http://vms.process.com/scripts/fileserv/fileserv.com?GZIP>
 
-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 HP.
+=item 2  VMS tar 
 
-    http://www.hp.com/go/openvms/freeware/
+For reading and writing Unix tape archives (*.tar files).  Vmstar is also 
+available from a number of sites such as:
 
-Recent versions of VMS tar on ODS-5 volumes may extract tape archive
-files with ^. escaped periods in them.  See below for further workarounds.
+    L<http://www.antinode.info/dec/sw/vmstar.html>
+    L<http://vms.process.com/scripts/fileserv/fileserv.com?VMSTAR>
 
 A port of GNU tar is also available as part of the GNV package:
 
-    http://h71000.www7.hp.com/opensource/gnv.html
+    L<http://h71000.www7.hp.com/opensource/gnv.html>
 
-=item 3  UNZIP for VMS
+=item 3  unzip for VMS
 
 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.hp.com/go/openvms/freeware/
-    ftp://ftp.process.com/vms-freeware/fileserv/
+    L<http://www.info-zip.org/UnZip.html>
+    L<http://www.hp.com/go/openvms/freeware/>
+    L<http://vms.process.com/fileserv-software.html>
 
-=item 5 GNU PATCH and DIFFUTILS for VMS
+=item 5 GNU patch and diffutils for VMS
 
 Patches to Perl are usually distributed as GNU unified or contextual diffs. 
 Such patches are created by the GNU diff program (part of the diffutils
 distribution) and applied with GNU patch.  VMS ports of these utilities are
 available here:
 
-    http://www.antinode.info/dec/sw/diffutils.html
-    http://www.hp.com/go/openvms/freeware/
+    L<http://www.antinode.info/dec/sw/diffutils.html>
+    L<http://vms.pdv-systeme.de/users/martinv/gnupatch.zip>
 
 =back
 
-Please note that UNZIP and GUNZIP are not the same thing (they work with
+Please note that unzip and gunzip are not the same thing (they work with
 different formats).  Many of the useful files from CPAN (the Comprehensive
 Perl Archive Network) are in *.tar.gz or *.tgz format (this includes copies 
 of the source code for perl as well as modules and scripts that you may 
@@ -141,54 +138,39 @@ for more details.
 
 =head1 Unpacking the Perl source code
 
-You may need to set up a foreign symbol for the unpacking utility of choice.
-
-As of version 5.10.0, Perl will still build and run on ODS-2 volumes,
-including on VAX, but there are a number of modules whose temporary
-files and tests are much happier residing on ODS-5 volumes.  For
-example, CPANPLUS will fail most of its tests on an ODS-2 volume because
-it includes files with multiple dots that will have been converted to
-underscores and the tests will have difficulty finding them.  So your
-best bet is to unpack the Perl source kit on an ODS-5 volume using
-recent versions of vmstar (e.g. V3.4 or later).  Contrary to advice
-provided with previous versions of Perl, do I<not> use the ODS-2
-compatibility qualifier.  Instead, use a command like the following:
+You may need to set up a foreign symbol for the unpacking utility of
+choice.  Once you have done so, use a command like the following to
+unpack the archive:
 
     vmstar -xvf perl-5^.17^.11.tar
 
-Then rename the top-level source directory like so:
+Then set default to the top-level source directory like so:
+
+    set default [.perl-5^.17^.11]
 
-    set security/protection=(o:rwed) perl-5^.17^.11.dir
-    rename perl-5^.17^.11.dir perl-5_17_11.dir
+and proceed with configuration as described in the next section.
 
-The reason for this last step is that while filenames with multiple dots
-are generally supported by Perl on VMS, I<directory> names with multiple
-dots are a special case with special problems because the dot is the
-traditional directory delimiter on VMS.  Rudimentary support for
-multi-dot directory names is available, but some of the oldest and most
-essential parts of Perl (such as searching for and loading library
-modules) do not yet fully support the ODS-5 caret-escape syntax.
 
 =head1 Configuring the Perl build
 
 To configure perl (a necessary first step), issue the command
 
-   @ Configure
+   @configure.com
 
 from the top of an unpacked perl source directory.  You will be asked a 
 series of questions, and the answers to them (along with the capabilities 
-of your C compiler and network stack) will determine how perl is custom 
+of your C compiler and network stack) will determine how perl is custom-
 built for your machine.
 
 If you have any symbols or logical names in your environment that may 
-interfere with the build or regression testing of perl then configure.com 
+interfere with the build or regression testing of perl then F<configure.com> 
 will try to warn you about them.  If a logical name is causing
 you trouble but is in an LNM table that you do not have write access to
 then try defining your own to a harmless equivalence string in a table 
 such that it is resolved before the other (e.g. if TMP is defined in the
 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:
+troublesome logicals and symbols include:
 
     COMP    "LOGICAL"
     EXT     "LOGICAL"
@@ -209,46 +191,44 @@ troublesome logicals and symbols are:
 
 As a handy shortcut, the command:
 
-    @ Configure "-des"
+    @configure "-des"
 
 (note the quotation marks and case) will choose reasonable defaults 
 automatically.  Some options can be given explicitly on the command line;
 the following example specifies a non-default location for where Perl
 will be installed:
 
-    @ Configure "-d" "-Dprefix=dka100:[utils.perl5.]"
+    @configure "-d" "-Dprefix=dka100:[utils.perl5.]"
 
 Note that the installation location would be by default where you unpacked 
 the source with a "_ROOT." appended.  For example if you unpacked the perl 
 source into:
 
-   DKA200:[PERL-5_10_2...]
+   F<DKA200:[PERL-5^.18^.0...]>
 
-Then the PERL_SETUP.COM that gets written out by CONFIGURE.COM will
+Then the F<PERL_SETUP.COM> that gets written out by F<configure.com> will
 try to DEFINE your installation PERL_ROOT to be:
 
-   DKA200:[PERL-5_10_2_ROOT.]
+   F<DKA200:[PERL-5^.18^.0_ROOT.]>
 
 More help with configure.com is available from:
 
-    @ Configure "-h"
+    @configure "-h"
 
-See the "Changing compile-time options (optional)" section below to learn
-even more details about how to influence the outcome of the important 
-configuration step.  If you find yourself reconfiguring and rebuilding 
-then be sure to also follow the advice in the "Cleaning up and starting 
-fresh (optional)" and the checklist of items in the "CAVEATS" sections 
-below.
+If you find yourself reconfiguring and rebuilding  then be sure to also follow
+the advice in the "Cleaning up and starting  fresh (optional)" and the checklist
+of items in the "CAVEATS" sections below.
 
 =head2 Changing compile-time options (optional) for Perl on VMS
 
-Most of the user definable features of Perl are enabled or disabled in
+Most of the user-definable features of Perl are enabled or disabled in
 configure.com, which processes the hints file config_h.SH.  There is
 code in there to Do The Right Thing, but that  may end up being the
 wrong thing for you.  Make sure you understand what you are doing since
 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.
+change. Note also that non-default options are tested less than default
+options, so you may end up being more of a pioneer than you intend to be.
 
 =head2 Socket Support (optional) for Perl on VMS
 
@@ -266,7 +246,7 @@ the build.
 Once you issue your MMS or MMK command, sit back and wait.  Perl should 
 compile and link without a problem.  If a problem does occur check the 
 "CAVEATS" section of this document.  If that does not help send some 
-mail to the VMSPERL mailing list.  Instructions are in the "Mailing Lists" 
+mail to the VMSPERL mailing list.  Instructions are in the L<"Mailing Lists"> 
 section of this document.
 
 =head1 Testing Perl
@@ -281,18 +261,18 @@ compile Perl and add the word "test" to the end, like this:
 
 If the compile command was:
 
-    MMS
+    MMK
 
 then the test command ought to be:
 
-    MMS test
+    MMK test
 
-MMS (or MMK) will run all the tests.  This may take some time, as there are 
+MMK (or MMS) will run all the tests.  This may take some time, as there are 
 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
+The test driver invoked via MMK 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
@@ -314,38 +294,38 @@ confident you are, make a bug report to the VMSPerl mailing list.
 If one or more tests fail, you can get more information on the failure by 
 issuing this command sequence:
 
-    @ [.VMS]TEST .typ "" "-v" [.subdir]test.T
+    @[.vms]test .typ "" "-v" [.subdir]test.t
 
 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
+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 t/op/time failed, then you'd do this:
 
-    @ [.VMS]TEST .EXE "" "-v" [.OP]TIME.T
+    @ .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
+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
+    @[.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:
 
-    MCR []MINIPERL "-V"
+    MCR []MINIPERL "-Ilib" "-V"
 
 Note that -"V" really is a capital V in double quotes. This will dump out a
 couple of screens worth of configuration information, and can help us 
 diagnose the problem.  If (and only if) that did not work then try enclosing 
 the output of:
 
-    MMS printconfig
+    MMK printconfig
 
 If (and only if) that did not work then try enclosing the output of:
 
-    @ [.vms]myconfig
+    @[.vms]myconfig
 
 You may also be asked to provide your C compiler version ("CC/VERSION NL:" 
 with DEC C, "gcc --version" with GNU CC).  To obtain the version of MMS or 
@@ -355,16 +335,16 @@ can be identified with "make --version".
 =head2 Cleaning up and starting fresh (optional) installing Perl on VMS
 
 If you need to recompile from scratch, you have to make sure you clean up
-first.  There is a procedure to do it--enter the I<exact> MMS line you used 
+first.  There is a procedure to do it--enter the I<exact> MMK line you used 
 to compile and add "realclean" at the end, like this:
 
 if the compile command was:
 
-    MMS
+    MMK
 
 then the cleanup command ought to be:
 
-    MMS realclean
+    MMK realclean
 
 If you do not do this things may behave erratically during the subsequent 
 rebuild attempt.  They might not, too, so it is best to be sure and do it.
@@ -382,7 +362,7 @@ Check your default file protections with
 
      SHOW PROTECTION /DEFAULT
 
-and adjust if necessary with SET PROTECTION=(code)/DEFAULT.
+and adjust if necessary with C<SET PROTECTION=(code)/DEFAULT>.
 
 =item 2
 
@@ -390,7 +370,7 @@ Decide where you want Perl to be installed (unless you have already done so
 by using the "prefix" configuration parameter -- see the example in the
 "Configuring the Perl build" section).
 
-The DCL script PERL_SETUP.COM that is written by CONFIGURE.COM will help you
+The DCL script PERL_SETUP.COM that is written by configure.com will help you
 with the definition of the PERL_ROOT and PERLSHR logical names and the PERL
 foreign command  symbol.  Take a look at PERL_SETUP.COM and modify it if you
 want to.  The installation process will execute PERL_SETUP.COM and copy
@@ -402,10 +382,6 @@ what will become the root of your Perl installation.
 
 Run the install script via:
 
-    MMS install
-
-or
-
     MMK install
 
 If for some reason it complains about target INSTALL being up to date,
@@ -417,21 +393,21 @@ Copy PERL_SETUP.COM to a place accessible to your perl users.
 
 For example:
 
-    COPY PERL_SETUP.COM SYS$LIBRARY: 
+    COPY PERL_SETUP.COM SYS$STARTUP:>
 
 If you want to have everyone on the system have access to perl
 then add a line that reads
 
-    $ @sys$library:perl_setup
+    $ @sys$startup:perl_setup
 
-to SYS$MANAGER:SYLOGIN.COM.
+to F<SYS$MANAGER:SYLOGIN.COM>.
 
 Two alternatives to the foreign symbol would be to install PERL into 
 DCLTABLES.EXE (Check out the section "Installing Perl into DCLTABLES 
 (optional)" for more information), or put the image in a 
-directory that's in your DCL$PATH (if you're using VMS V6.2 or higher).
+directory that's in your DCL$PATH.
 
-An alternative to having PERL_SETUP.COM define the PERLSHR logical name
+An alternative to having F<PERL_SETUP.COM> define the PERLSHR logical name
 is to simply copy it into the system shareable library directory with:
 
     copy perl_root:[000000]perlshr.exe sys$share:
@@ -467,8 +443,8 @@ invoked.
    INSTALL ADD PERLSHR/SHARE
    INSTALL ADD PERL/HEADER
 
-should be enough for PERLSHR.EXE (/share implies /header and /open), 
-while /HEADER should do for PERL.EXE (perl.exe is not a shared image).
+should be enough for F<PERLSHR.EXE> (/share implies /header and /open), 
+while /HEADER should do for FPERL.EXE> (perl.exe is not a shared image).
 
 If your code 'use's modules, check to see if there is a shareable image for
 them, too.  In the base perl build, POSIX, IO, Fcntl, Opcode, SDBM_File,
@@ -480,7 +456,7 @@ off perl with any regularity (like more than once every 20 seconds or so)
 it is probably beneficial to INSTALL at least portions of perl.
 
 While there is code in perl to remove privileges as it runs you are advised
-to NOT INSTALL PERL.EXE with PRIVs!
+to NOT INSTALL F<PERL.EXE> with PRIVs!
 
 =head2 Running h2ph to create perl header files (optional) on VMS
 
@@ -510,26 +486,6 @@ Probably the single biggest gotcha in compiling Perl is giving the wrong
 switches to MMS/MMK when you build. Use I<exactly> what the configure.com 
 script prints!
 
-The next big gotcha is directory depth.  Perl can create directories four,
-five, or even six levels deep during the build, so you don't have to be 
-too deep to start to hit the RMS 8 level limit (for ODS 2 volumes which were
-common on versions of VMS prior to V7.2 and even with V7.3 on the VAX).  
-It is best to do:
-
-    DEFINE/TRANS=(CONC,TERM) PERLSRC "disk:[dir.dir.dir.perldir.]"
-    SET DEFAULT PERLSRC:[000000]
-
-before building in cases where you have to unpack the distribution so deep
-(note the trailing period in the definition of PERLSRC).  Perl modules 
-from CPAN can be just as bad (or worse), so watch out for them, too. Perl's
-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 
-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
@@ -550,8 +506,6 @@ It has been a while since the GNU utilities such as GCC or GNU make
 were used to build perl on VMS.  Hence they may require a great deal
 of source code modification to work again.
 
-    http://www.progis.de/
-
 =head2 Floating Point Considerations
 
 Prior to 5.8.0, Perl simply accepted the default floating point options of the
@@ -580,11 +534,11 @@ G_FLOAT, or T_FLOAT depending on what your Perl was configured with.  When
 written to disk, the value can only be retrieved later by a Perl configured
 with the same floating point option that was in effect when it was created.
 
-To obtain a non-IEEE build on Alpha, simply answer no to the "Use IEEE math?"
-question during the configuration.  To obtain an option different from the C
-compiler default on either VAX or Alpha, put in the option that you want in
-answer to the "Any additional cc flags?" question.  For example, to obtain a
-G_FLOAT build on VAX, put in C</FLOAT=G_FLOAT>.
+To obtain a non-IEEE build on Alpha or Itanium, simply answer no to the
+"Use IEEE math?" question during the configuration.  To obtain an option
+different from the C compiler default on any platform, put in the option that
+you want in answer to the "Any additional cc flags?" question.  For example, to
+obtain a G_FLOAT build on VAX, put in C</FLOAT=G_FLOAT>.
 
 =head1 Mailing Lists
 
@@ -598,7 +552,7 @@ mailing list address is VMSPERL@PERL.ORG.  Any mail sent there gets echoed
 to all subscribers of the list.  There is a searchable archive of the list
 on the web at:
 
-    http://www.xray.mpe.mpg.de/mailing-lists/vmsperl/
+    L<http://www.xray.mpe.mpg.de/mailing-lists/vmsperl/>
 
 To unsubscribe from VMSPERL send a message to VMSPERL-UNSUBSCRIBE@PERL.ORG.
 Be sure to do so from the subscribed account that you are canceling.
@@ -607,12 +561,11 @@ Be sure to do so from the subscribed account that you are canceling.
 
 Vmsperl pages on the web include:
 
-    http://www.sidhe.org/vmsperl/index.html
-    http://www.cpan.org/modules/by-module/VMS/
-    http://www.xray.mpe.mpg.de/mailing-lists/vmsperl/
-    http://www-ang.kfunigraz.ac.at/~binder/perl.html
-    http://archive.develooper.com/vmsperl@perl.org/
-    http://h71000.www7.hp.com/openvms/products/ips/apache/csws_modperl.html
+    L<http://www.sidhe.org/vmsperl/index.html>
+    L<http://www.cpan.org/modules/by-module/VMS/>
+    L<http://www.xray.mpe.mpg.de/mailing-lists/vmsperl/>
+    L<http://archive.develooper.com/vmsperl@perl.org/>
+    L<http://h71000.www7.hp.com/openvms/products/ips/apache/csws_modperl.html>
 
 =head1 SEE ALSO