This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perl5337delta: note that stadtx was removed
[perl5.git] / README.os390
index 6e2d49e..87f1094 100644 (file)
@@ -1,5 +1,5 @@
 This document is written in pod format hence there are punctuation
-characters in odd places.  Do not worry, you've apparently got the
+characters in odd places.  Do not worry, you have 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.
 
@@ -12,11 +12,14 @@ perlos390 - building and installing Perl for OS/390 and z/OS
 This document will help you Configure, build, test and install Perl
 on OS/390 (aka z/OS) Unix System Services.
 
+B<This document needs to be updated, but we don't know what it should say.
+Please submit comments to L<https://github.com/Perl/perl5/issues>.>
+
 =head1 DESCRIPTION
 
 This is a fully ported Perl for OS/390 Version 2 Release 3, 5, 6, 7,
 8, and 9.  It may work on other versions or releases, but those are
-the ones we've tested it on.
+the ones we have tested it on.
 
 You may need to carry out some system configuration tasks before
 running the Configure script for Perl.
@@ -26,7 +29,7 @@ running the Configure script for Perl.
 
 The z/OS Unix Tools and Toys list may prove helpful and contains links
 to ports of much of the software helpful for building Perl.
-http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html
+L<http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html>
 
 
 =head2 Unpacking Perl distribution on OS/390
@@ -47,9 +50,9 @@ or
 
 If you get lots of errors of the form
 
-  tar: FSUM7171 ...: cannot set uid/gid: EDC5139I Operation not permitted.
+ tar: FSUM7171 ...: cannot set uid/gid: EDC5139I Operation not permitted
 
-you didn't read the above and tried to use tar instead of pax, you'll
+you did not read the above and tried to use tar instead of pax, you'll
 first have to remove the (now corrupt) perl directory
 
    rm -rf perl-...
@@ -111,14 +114,12 @@ world readable /tmp directory if you have not already done so (see man chmod).
 
 =head2 Configure Perl on OS/390
 
-Once you've unpacked the distribution, run "sh Configure" (see INSTALL
+Once you have unpacked the distribution, run "sh Configure" (see INSTALL
 for a full discussion of the Configure options).  There is a "hints" file
 for os390 that specifies the correct values for most things.  Some things
 to watch out for include:
 
-=over 4
-
-=item *
+=head3 Shell
 
 A message of the form:
 
@@ -127,19 +128,24 @@ A message of the form:
 
 is nothing to worry about at all.
 
-=item *
+=head3 Samples
 
 Some of the parser default template files in /samples are needed in /etc.
 In particular be sure that you at least copy /samples/yyparse.c to /etc
 before running Perl's Configure.  This step ensures successful extraction
-of EBCDIC versions of parser files such as perly.c, perly.h, and x2p/a2p.c.
+of EBCDIC versions of parser files such as perly.c and perly.h.
 This has to be done before running Configure the first time.  If you failed
 to do so then the easiest way to re-Configure Perl is to delete your
 misconfigured build root and re-extract the source from the tar ball.
 Then you must ensure that /etc/yyparse.c is properly in place before
 attempting to re-run Configure.
 
-=item *
+=head3 Dynamic loading
+
+Dynamic loading is required if you want to use XS modules from CPAN (like
+DBI (and DBD's), JSON::XS, and Text::CSV_XS) or update CORE modules from
+CPAN with newer versions (like Encode) without rebuilding all of the perl
+binary.
 
 This port will support dynamic loading, but it is not selected by
 default.  If you would like to experiment with dynamic loading then
@@ -151,19 +157,31 @@ for perl to work.  See the config.sh file for the value of $archlibexp.
 If in trying to use Perl you see an error message similar to:
 
  CEE3501S The module libperl.dll was not found.
-         From entry point __dllstaticinit at compile unit offset +00000194 at
+   From entry point __dllstaticinit at compile unit offset +00000194
+   at
 
 then your LIBPATH does not have the location of libperl.x and either
 libperl.dll or libperl.so in it.  Add that directory to your LIBPATH and
 proceed.
 
-=item *
+In hints/os390.sh, selecting -Dusedl will default to *also* select
+-Duseshrplib.  Having a shared plib not only requires LIBPATH to be set to
+the correct location of libperl.so but also makes it close to impossible
+to run more than one different perl that was built this way at the same
+time.
+
+All objects that are involved in -Dusedl builds should be compiled for
+this, probably by adding to all ccflags
+
+ -qexportall -qxplink -qdll -Wc,XPLINK,dll,EXPORTALL -Wl,XPLINK,dll
+
+=head3 Optimizing
 
 Do not turn on the compiler optimization flag "-O".  There is
 a bug in either the optimizer or perl that causes perl to
 not work correctly when the optimizer is on.
 
-=item *
+=head3 Config files
 
 Some of the configuration files in /etc used by the
 networking APIs are either missing or have the wrong
@@ -176,8 +194,6 @@ You may have to look for things like HOSTNAME and DOMAINORIGIN
 in the "//'SYS1.TCPPARMS(TCPDATA)'" PDS member in order to
 properly set up your /etc networking files.
 
-=back
-
 =head2 Build, Test, Install Perl on OS/390
 
 Simply put:
@@ -199,6 +215,9 @@ or not you have write access to the directories you specified.
 "Out of memory!" messages during the build of Perl are most often fixed
 by re building the GNU make utility for OS/390 from a source code kit.
 
+Building debugging-enabled binaries (with -g or -g3) will increase the
+chance of getting these errors. Prevent -g if possible.
+
 Another memory limiting item to check is your MAXASSIZE parameter in your
 'SYS1.PARMLIB(BPXPRMxx)' data set (note too that as of V2R8 address space
 limits can be set on a per user ID basis in the USS segment of a RACF
@@ -225,9 +244,7 @@ installation.  You might encounter STDERR messages even during a successful
 run of "make test".  Here is a guide to some of the more commonly seen
 anomalies:
 
-=over 4
-
-=item *
+=head3 Signals
 
 A message of the form:
 
@@ -239,26 +256,25 @@ A message of the form:
 indicates that the t/io/openpid.t test of Perl has passed but done so
 with extraneous messages on stderr from CEE.
 
-=item *
+=head3 File::Temp
 
 A message of the form:
 
- lib/ftmp-security....File::Temp::_gettemp: Parent directory (/tmp/) is not safe
- (sticky bit not set when world writable?) at lib/ftmp-security.t line 100
- File::Temp::_gettemp: Parent directory (/tmp/) is not safe (sticky bit not
- set when world writable?) at lib/ftmp-security.t line 100
+ lib/ftmp-security....File::Temp::_gettemp: Parent directory (/tmp/)
+ is not safe (sticky bit not set when world writable?) at
+ lib/ftmp-security.t line 100
+ File::Temp::_gettemp: Parent directory (/tmp/) is not safe (sticky
+ bit not set when world writable?) at lib/ftmp-security.t line 100
  ok
 
 indicates a problem with the permissions on your /tmp directory within the HFS.
 To correct that problem issue the command:
 
-     chmod a+t /tmp
+    chmod a+t /tmp
 
 from an account with write access to the directory entry for /tmp.
 
-=item *
-
-Out of Memory!
+=head3 Out of Memory!
 
 Recent perl test suite is quite memory hungry. In addition to the comments
 above on memory limitations it is also worth checking for _CEE_RUNOPTS
@@ -284,9 +300,6 @@ case something like:
 
 is needed to get through the test suite.
 
-
-=back
-
 =head2 Installation Anomalies with Perl on OS/390
 
 The installman script will try to run on OS/390.  There will be fewer errors
@@ -351,7 +364,7 @@ The problem can be further examined in a roughly equivalent C program:
 
 =head2 Modules and Extensions for Perl on OS/390
 
-Pure pure (that is non xs) modules may be installed via the usual:
+Pure Perl (that is non XS) modules may be installed via the usual:
 
     perl Makefile.PL
     make
@@ -359,11 +372,11 @@ Pure pure (that is non xs) modules may be installed via the usual:
     make install
 
 If you built perl with dynamic loading capability then that would also
-be the way to build xs based extensions.  However, if you built perl with
-the default static linking you can still build xs based extensions for OS/390
+be the way to build XS based extensions.  However, if you built perl with
+the default static linking you can still build XS based extensions for OS/390
 but you will need to follow the instructions in ExtUtils::MakeMaker for
 building statically linked perl binaries.  In the simplest configurations
-building a static perl + xs extension boils down to:
+building a static perl + XS extension boils down to:
 
     perl Makefile.PL
     make
@@ -374,7 +387,7 @@ building a static perl + xs extension boils down to:
 
 In most cases people have reported better results with GNU make rather
 than the system's /bin/make program, whether for plain modules or for
-xs based extensions.
+XS based extensions.
 
 If the make process encounters trouble with either compilation or
 linking then try setting the _C89_CCMODE to 1.  Assuming sh is your
@@ -396,32 +409,31 @@ Thanks to John Goodyear for dynamic loading help.
 
 L<INSTALL>, L<perlport>, L<perlebcdic>, L<ExtUtils::MakeMaker>.
 
   http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html
+ http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1toy.html
 
   http://www.redbooks.ibm.com/redbooks/SG245944.html
+ http://www.redbooks.ibm.com/redbooks/SG245944.html
 
   http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1ty1.html#opensrc
+ http://www.ibm.com/servers/eserver/zseries/zos/unix/bpxa1ty1.html#opensrc
 
   http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/
+ http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/
 
   http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/ceea3030/
+ http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/ceea3030/
 
   http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/CBCUG030/
+ http://publibz.boulder.ibm.com:80/cgi-bin/bookmgr_OS390/BOOKS/CBCUG030/
 
 =head2 Mailing list for Perl on OS/390
 
-If you are interested in the VM/ESA, z/OS (formerly known as OS/390)
+If you are interested in the z/OS (formerly known as OS/390)
 and POSIX-BC (BS2000) ports of Perl then see the perl-mvs mailing list.
 To subscribe, send an empty message to perl-mvs-subscribe@perl.org.
 
 See also:
 
-    http://lists.perl.org/list/perl-mvs.html
+    https://lists.perl.org/list/perl-mvs.html
 
 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/
+    https://www.nntp.perl.org/group/perl.mvs/
 
 =head1 HISTORY
 
@@ -430,15 +442,17 @@ release of Perl.
 
 This document was podified for the 5.005_03 release of Perl 11 March 1999.
 
-Updated 28 November 2001 for broken URLs.
-
 Updated 12 November 2000 for the 5.7.1 release of Perl.
 
-Updated 15 January 2001 for the 5.7.1 release of Perl.
+Updated 15 January  2001 for the 5.7.1 release of Perl.
+
+Updated 24 January  2001 to mention dynamic loading.
 
-Updated 24 January 2001 to mention dynamic loading.
+Updated 12 March    2001 to mention //'SYS1.TCPPARMS(TCPDATA)'.
+
+Updated 28 November 2001 for broken URLs.
 
-Updated 12 March 2001 to mention //'SYS1.TCPPARMS(TCPDATA)'.
+Updated 03 October  2019 for perl-5.33.3+
 
 =cut