[patch] -Wall cleanup round 2
[p5sagit/p5-mst-13.2.git] / README.vmesa
1
2 This document is written in pod format hence there are punctuation
3 characters in odd places.  Do not worry, you've apparently got
4 the ASCII->EBCDIC translation worked out correctly.  You can read
5 more about pod in pod/perlpod.pod or the short summary in the
6 INSTALL file.
7
8 =head1 NAME
9
10 README.vmesa - building and installing Perl for VM/ESA.
11
12 =head1 SYNOPSIS
13
14 This document will help you Configure, build, test and install Perl
15 on VM/ESA.
16
17 =head1 DESCRIPTION
18
19 This is a fully ported perl for VM/ESA 2.3.0.  It may work on
20 other versions, but that's the one we've tested it on.
21
22 If you've downloaded the binary distribution, it needs to be
23 installed below /usr/local.  Source code distributions have an
24 automated `make install` step that means you do not need to extract
25 the source code below /usr/local (though that is where it will be
26 installed by default).  You may need to worry about the networking
27 configuration files discussed in the last bullet below.
28
29 =head2 Unpacking
30
31 To extract an ASCII tar archive on VM/ESA, try this:
32
33    pax -o to=IBM-1047,from=ISO8859-1 -r < latest.tar
34
35 =head2 Setup and utilities
36
37 GNU make for VM/ESA, which may be required for the build of perl,
38 is available from:
39
40   http://pucc.princeton.edu/~neale/vmoe.html
41
42 =head2 Configure
43
44 Once you've unpacked the distribution, run Configure (see INSTALL for
45 full discussion of the Configure options), and then run make, then
46 "make test" then "make install" (this last step may require UID=0
47 privileges).
48
49 There is a "hints" file for vmesa that specifies the correct values
50 for most things.  Some things to watch out for are:
51
52 =over 4
53
54 =item *
55
56 this port does support dynamic loading but it's not had much testing
57
58 =item *
59         - Don't turn on the compiler optimization flag "-O".  There's
60           a bug in the compiler (APAR PQ18812) that generates some bad code
61           the optimizer is on.
62
63 =item *
64         - As VM/ESA doesn't fully support the fork() API programs relying on
65           this call will not work. I've replaced fork()/exec() with spawn()
66           and the standalone exec() with spawn(). This has a side effect when
67           opening unnamed pipes in a shell script: there is no child process
68           generated under.
69
70 =item *
71
72 At the moment the hints file for VM/ESA basically bypasses all of the
73 automatic configuration process.  This is because Configure relies on:
74 1. The header files living in the Byte File System (you could put the
75 there if you want); 2. The C preprocessor including the #include 
76 statements in the preprocessor output (.i) file.
77
78 =back
79
80 =head2 testing anomalies
81
82 The `make test` step runs a Perl Verification Procedure, usually before
83 installation.  As the 5.6.1 kit was was being assembled
84 the following "failures" were known to appear on some machines
85 during `make test` (mostly due to ASCII vs. EBCDIC conflicts),
86 your results may differ:
87
88 [the list of failures being compiled]
89
90 =head2 Usage Hints
91         
92 When using perl on VM/ESA please keep in mind that the EBCDIC and ASCII
93 character sets are different.  Perl builtin functions that may behave
94 differently under EBCDIC are mentioned in the perlport.pod document.
95
96 OpenEdition (UNIX System Services) does not (yet) support the #! means
97 of script invocation.
98 See:
99
100     head `whence perldoc`
101
102 for an example of how to use the "eval exec" trick to ask the shell to
103 have perl run your scripts for you.
104
105 =head1 AUTHORS
106
107 Neale Ferguson.
108
109 =head1 SEE ALSO
110
111 L<INSTALL>, L<perlport>, L<perlebcdic>.
112
113 =head2 Mailing list
114
115 If you are interested in the VM and OS/390 ports of perl then see the
116 perl-mvs mailing list: The Perl Institute (http://www.perl.org/)
117 maintains a mailing list of interest to all folks building and/or
118 using perl on EBCDIC platforms.  To subscribe, send a message of:
119
120     subscribe perl-mvs
121
122 to majordomo@perl.org.
123
124    See also:
125
126     http://lists.perl.org/showlist.cgi?name=perl-mvs
127
128 There are web archives of the mailing list at:
129
130     http://www.xray.mpe.mpg.de/mailing-lists/perl-mvs/
131     http://archive.develooper.com/perl-mvs@perl.org/
132
133 =cut
134