The README.vmesa part of #8712 from maintperl.

p4raw-id: //depot/perl@8729

diff --git a/README.vmesa b/README.vmesa
index d3f8516..43c5219 100644 (file)
--- a/README.vmesa
+++ b/README.vmesa
@@ -1,4 +1,20 @@
-README.vmesa
+
+This document is written in pod format hence there are punctuation
+characters in odd places.  Do not worry, you've apparently got
+the ASCII->EBCDIC translation worked out correctly.  You can read
+more about pod in pod/perlpod.pod or the short summary in the
+INSTALL file.
+
+=head1 NAME
+
+README.vmesa - building and installing Perl for VM/ESA.
+
+=head1 SYNOPSIS
+
+This document will help you Configure, build, test and install Perl
+on VM/ESA.
+
+=head1 DESCRIPTION
 
 This is a fully ported perl for VM/ESA 2.3.0.  It may work on
 other versions, but that's the one we've tested it on.
@@ -10,48 +26,75 @@ the source code below /usr/local (though that is where it will be
 installed by default).  You may need to worry about the networking
 configuration files discussed in the last bullet below.
 
+=head2 Unpacking
+
 To extract an ASCII tar archive on VM/ESA, try this:
 
    pax -o to=IBM-1047,from=ISO8859-1 -r < latest.tar
 
+=head2 Setup and utilities
+
 GNU make for VM/ESA, which may be required for the build of perl,
 is available from:
 
   http://pucc.princeton.edu/~neale/vmoe.html
 
+=head2 Configure
+
 Once you've unpacked the distribution, run Configure (see INSTALL for
 full discussion of the Configure options), and then run make, then
 "make test" then "make install" (this last step may require UID=0
-privileges)
+privileges).
 
 There is a "hints" file for vmesa that specifies the correct values
-for most things.  Some things to watch out for are
+for most things.  Some things to watch out for are:
 
-       - this port does support dynamic loading but it's not had much testing
+=over 4
 
+=item *
+
+this port does support dynamic loading but it's not had much testing
+
+=item *
        - Don't turn on the compiler optimization flag "-O".  There's
          a bug in the compiler (APAR PQ18812) that generates some bad code
          the optimizer is on.
 
+=item *
        - As VM/ESA doesn't fully support the fork() API programs relying on
          this call will not work. I've replaced fork()/exec() with spawn()
          and the standalone exec() with spawn(). This has a side effect when
          opening unnamed pipes in a shell script: there is no child process
          generated under.
 
-       - At the moment the hints file for VM/ESA basically bypasses all of the
-         automatic configuration process. This is because Configure relies on:
-         1. The header files living in the Byte File System (you could put the
-            there if you want;
-         2. The C preprocessor including the #include statements in the
-            preprocessor output (.i) file.
+=item *
+
+At the moment the hints file for VM/ESA basically bypasses all of the
+automatic configuration process.  This is because Configure relies on:
+1. The header files living in the Byte File System (you could put the
+there if you want); 2. The C preprocessor including the #include 
+statements in the preprocessor output (.i) file.
+
+=back
+
+=head2 testing anomalies
+
+The `make test` step runs a Perl Verification Procedure, usually before
+installation.  As the 5.6.1 kit was was being assembled
+the following "failures" were known to appear on some machines
+during `make test` (mostly due to ASCII vs. EBCDIC conflicts),
+your results may differ:
+
+[the list of failures being compiled]
+
+=head2 Usage Hints
        
 When using perl on VM/ESA please keep in mind that the EBCDIC and ASCII
 character sets are different.  Perl builtin functions that may behave
 differently under EBCDIC are mentioned in the perlport.pod document.
 
 OpenEdition (UNIX System Services) does not (yet) support the #! means
-of script invokation.
+of script invocation.
 See:
 
     head `whence perldoc`
@@ -59,6 +102,16 @@ See:
 for an example of how to use the "eval exec" trick to ask the shell to
 have perl run your scripts for you.
 
+=head1 AUTHORS
+
+Neale Ferguson.
+
+=head1 SEE ALSO
+
+L<INSTALL>, L<perlport>, L<perlebcdic>.
+
+=head2 Mailing list
+
 If you are interested in the VM and OS/390 ports of perl then see the
 perl-mvs mailing list: The Perl Institute (http://www.perl.org/)
 maintains a mailing list of interest to all folks building and/or
@@ -68,9 +121,14 @@ using perl on EBCDIC platforms.  To subscribe, send a message of:
 
 to majordomo@perl.org.
 
-Regression tests: as the 5.005 kit was was being assembled
-the following "failures" were known to appear on some machines
-during `make test` (mostly due to ASCII vs. EBCDIC conflicts),
-your results may differ:
+   See also:
+
+    http://lists.perl.org/showlist.cgi?name=perl-mvs
+
+There are web archives of the mailing list at:
+
+    http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/
+    http://archive.develooper.com/perl-mvs@perl.org/
+
+=cut
 
-[the list of failures being compiled]