Commit | Line | Data |
---|---|---|
b4bc034f GS |
1 | If you read this file _as_is_, just ignore the equal signs on the left. |
2 | This file is written in the POD format (see [.POD]PERLPOD.POD;1) which is | |
3 | specially designed to be readable as is. | |
fb73857a | 4 | |
b4bc034f GS |
5 | =head1 NAME |
6 | ||
7 | README.vms - Configuring, building, testing, and installing perl on VMS | |
8 | ||
9 | =head1 SYNOPSIS | |
10 | ||
11 | To configure, build, test, and install perl on VMS: | |
12 | ||
13 | @ Configure | |
14 | mms | |
15 | mms test | |
16 | mms install | |
17 | ||
18 | mmk may be used in place of mms in the last three steps. | |
19 | ||
20 | =head1 DESCRIPTION | |
21 | ||
22 | =head2 Important safety tip | |
97abc6ad | 23 | |
ec55d5e4 CB |
24 | For best results, make sure you read the "Configuring the Perl Build", |
25 | "Building Perl", and "Installing Perl" sections of this document before | |
26 | you build or install. Also please note other changes in the current | |
27 | release by having a look at L<perldelta/VMS>. | |
97abc6ad | 28 | |
b4bc034f GS |
29 | Also note that, as of Perl version 5.005 and later, an ANSI C compliant |
30 | compiler is required to build Perl. VAX C is *not* ANSI compliant, as it | |
31 | died a natural death some time before the standard was set. Therefore | |
1bc81404 | 32 | VAX C will not compile Perl 5.005 or later. We are sorry about that. |
3bf5f72b | 33 | |
10019e56 CB |
34 | There have been no recent reports of builds using Gnu C, but latent |
35 | (and most likely outdated) support for it is still present in various | |
36 | parts of the sources. Currently the HP (formerly Compaq, and even | |
37 | more formerly DEC) C compiler is the only viable alternative for | |
38 | building Perl. | |
39 | ||
40 | There is minimal support for HP C++ but this support is not complete; | |
e7948fac CB |
41 | if you get it working please write to the vmsperl list (for info see |
42 | L</"Mailing Lists">). | |
3bf5f72b | 43 | |
b4bc034f | 44 | |
a83b6f46 | 45 | =head2 Introduction to Perl on VMS |
fb73857a | 46 | |
47 | The VMS port of Perl is as functionally complete as any other Perl port | |
48 | (and as complete as the ports on some Unix systems). The Perl binaries | |
49 | provide all the Perl system calls that are either available under VMS or | |
b4bc034f GS |
50 | reasonably emulated. There are some incompatibilities in process handling |
51 | (e.g. the fork/exec model for creating subprocesses doesn't do what you | |
fb73857a | 52 | might expect under Unix), mainly because VMS and Unix handle processes and |
53 | sub-processes very differently. | |
54 | ||
b4bc034f | 55 | There are still some unimplemented system functions, and of course we |
fb73857a | 56 | could use modules implementing useful VMS system services, so if you'd like |
b4bc034f | 57 | to lend a hand we'd love to have you. Join the Perl Porting Team Now! |
fb73857a | 58 | |
b4bc034f GS |
59 | There are issues with various versions of DEC C, so if you're not running a |
60 | relatively modern version, check the "DEC C issues" section later on in this | |
fb73857a | 61 | document. |
62 | ||
a83b6f46 | 63 | =head2 Other required software for Compiling Perl on VMS |
b4bc034f GS |
64 | |
65 | In addition to VMS and DCL you will need two things: | |
fb73857a | 66 | |
b4bc034f GS |
67 | =over 4 |
68 | ||
69 | =item 1 A C compiler. | |
70 | ||
10019e56 | 71 | HP (formerly Compaq, more formerly DEC) C for VMS (VAX, Alpha, or Itanium). |
b4bc034f GS |
72 | |
73 | =item 2 A make tool. | |
74 | ||
ec55d5e4 CB |
75 | HP's MMS may work, but MadGoat's free MMS analog MMK (available from |
76 | http://www.kednos.com/kednos/Resources/MMK) has consistently worked | |
77 | better. Gnu Make might work, but it's been so long since anyone's tested | |
78 | it that we're not sure. MMK is free though, so go ahead and use that. | |
b4bc034f GS |
79 | |
80 | =back | |
81 | ||
a83b6f46 | 82 | =head2 Additional software that is optional for Perl on VMS |
fb73857a | 83 | |
9f3f8d50 | 84 | You may also want to have on hand: |
b4bc034f GS |
85 | |
86 | =over 4 | |
87 | ||
88 | =item 1 GUNZIP/GZIP.EXE for VMS | |
89 | ||
90 | A de-compressor for *.gz and *.tgz files available from a number | |
58979ab1 | 91 | of web/ftp sites and is distributed on the OpenVMS Freeware CD-ROM |
10019e56 | 92 | from HP. |
b4bc034f | 93 | |
10019e56 | 94 | http://www.hp.com/go/openvms/freeware/ |
1bc81404 | 95 | http://www.crinoid.com/utils/ |
b4bc034f GS |
96 | |
97 | =item 2 VMS TAR | |
98 | ||
99 | For reading and writing unix tape archives (*.tar files). Vmstar is also | |
58979ab1 | 100 | available from a number of web/ftp sites and is distributed on the OpenVMS |
10019e56 | 101 | Freeware CD-ROM from HP. |
b4bc034f | 102 | |
10019e56 | 103 | http://www.hp.com/go/openvms/freeware/ |
b4bc034f | 104 | |
d83fac45 PP |
105 | Recent versions of VMS tar on ODS-5 volumes may extract tape archive |
106 | files with ^. escaped periods in them. See below for further workarounds. | |
107 | ||
10019e56 CB |
108 | A port of GNU tar is also available as part of the GNV package: |
109 | ||
ec55d5e4 | 110 | http://h71000.www7.hp.com/opensource/gnv.html |
10019e56 | 111 | |
b4bc034f GS |
112 | =item 3 UNZIP.EXE for VMS |
113 | ||
114 | A combination decompressor and archive reader/writer for *.zip files. | |
115 | Unzip is available from a number of web/ftp sites. | |
116 | ||
adc5a9a5 | 117 | http://www.info-zip.org/UnZip.html |
10019e56 CB |
118 | http://www.hp.com/go/openvms/freeware/ |
119 | ftp://ftp.hp.com/pub/openvms | |
10019e56 | 120 | ftp://ftp.process.com/vms-freeware/fileserv |
b4bc034f GS |
121 | |
122 | =item 4 MOST | |
123 | ||
124 | Most is an optional pager that is convenient to use with perldoc (unlike | |
125 | TYPE/PAGE, MOST can go forward and backwards in a document and supports | |
126 | regular expression searching). Most builds with the slang | |
127 | library on VMS. Most and slang are available from: | |
128 | ||
129 | ftp://space.mit.edu/pub/davis/ | |
adc5a9a5 | 130 | ftp://ftp.process.com/vms-freeware/narnia/ |
b4bc034f | 131 | |
1bc81404 CB |
132 | =item 5 GNU PATCH and DIFFUTILS for VMS |
133 | ||
134 | Patches to Perl are usually distributed as GNU unified or contextual diffs. | |
135 | Such patches are created by the GNU diff program (part of the diffutils | |
136 | distribution) and applied with GNU patch. VMS ports of these utilities are | |
137 | available here: | |
138 | ||
ec55d5e4 | 139 | http://www.antinode.info/dec/sw/diffutils.html |
10019e56 | 140 | http://www.hp.com/go/openvms/freeware/ |
1bc81404 | 141 | |
b4bc034f GS |
142 | =back |
143 | ||
9f3f8d50 | 144 | Please note that UNZIP and GUNZIP are not the same thing (they work with |
b4bc034f | 145 | different formats). Many of the useful files from CPAN (the Comprehensive |
58979ab1 PP |
146 | Perl Archive Network) are in *.tar.gz or *.tgz format (this includes copies |
147 | of the source code for perl as well as modules and scripts that you may | |
148 | wish to add later) hence you probably want to have GUNZIP.EXE and | |
149 | VMSTAR.EXE on your VMS machine. | |
fb73857a | 150 | |
b4bc034f GS |
151 | If you want to include socket support, you'll need a TCP/IP stack and either |
152 | DEC C, or socket libraries. See the "Socket Support (optional)" topic | |
153 | for more details. | |
fb73857a | 154 | |
d83fac45 PP |
155 | =head1 Unpacking the Perl source code |
156 | ||
157 | You may need to set up a foreign symbol for the unpacking utility of choice. | |
158 | ||
718752a5 CB |
159 | As of version 5.10.0, Perl will still build and run on ODS-2 volumes, |
160 | including on VAX, but there are a number of modules whose temporary | |
161 | files and tests are much happier residing on ODS-5 volumes. For | |
162 | example, CPANPLUS will fail most of its tests on an ODS-2 volume because | |
163 | it includes files with multiple dots that will have been converted to | |
164 | underscores and the tests will have difficulty finding them. So your | |
165 | best bet is to unpack the Perl source kit on an ODS-5 volume using | |
166 | recent versions of vmstar (e.g. V3.4 or later). Contrary to advice | |
167 | provided with previous versions of Perl, do I<not> use the ODS-2 | |
168 | compatability qualifier. Instead, use a command like the following: | |
169 | ||
170 | vmstar /extract/verbose perl-V^.VIII^.III.tar | |
d83fac45 PP |
171 | |
172 | or: | |
173 | ||
718752a5 | 174 | vmstar -xvf perl-5^.10^.0.tar |
d83fac45 | 175 | |
718752a5 | 176 | Then rename the top-level source directory like so: |
d83fac45 | 177 | |
718752a5 CB |
178 | set security/protection=(o:rwed) perl-5^.10^.0.dir |
179 | rename perl-5^.10^.0.dir perl-5_10_0.dir | |
d83fac45 | 180 | |
718752a5 CB |
181 | The reason for this last step is that while filenames with multiple dots |
182 | are generally supported by Perl on VMS, I<directory> names with multiple | |
183 | dots are a special case with special problems because the dot is the | |
184 | traditional directory delimiter on VMS. Rudimentary support for | |
185 | multi-dot directory names is available, but some of the oldest and most | |
186 | essential parts of Perl (such as searching for and loading library | |
187 | modules) do not yet fully support the ODS-5 caret-escape syntax. | |
d83fac45 | 188 | |
b4bc034f | 189 | =head1 Configuring the Perl build |
fb73857a | 190 | |
97abc6ad | 191 | To configure perl (a necessary first step), issue the command |
fb73857a | 192 | |
b4bc034f | 193 | @ Configure |
fb73857a | 194 | |
b4bc034f GS |
195 | from the top of an unpacked perl source directory. You will be asked a |
196 | series of questions, and the answers to them (along with the capabilities | |
197 | of your C compiler and network stack) will determine how perl is custom | |
198 | built for your machine. | |
fb73857a | 199 | |
b4bc034f GS |
200 | If you have multiple C compilers installed, you'll have your choice of |
201 | which one to use. Various older versions of DEC C had some caveats, so if | |
202 | you're using a version older than 5.2, check the "DEC C Issues" section. | |
fb73857a | 203 | |
b4bc034f GS |
204 | If you have any symbols or logical names in your environment that may |
205 | interfere with the build or regression testing of perl then configure.com | |
206 | will try to warn you about them. If a logical name is causing | |
7bb57f25 GS |
207 | you trouble but is in an LNM table that you do not have write access to |
208 | then try defining your own to a harmless equivalence string in a table | |
209 | such that it is resolved before the other (e.g. if TMP is defined in the | |
b4bc034f GS |
210 | SYSTEM table then try DEFINE TMP "NL:" or somesuch in your process table) |
211 | otherwise simply deassign the dangerous logical names. The potentially | |
212 | troublesome logicals and symbols are: | |
7bb57f25 | 213 | |
b3b333bf PP |
214 | COMP "LOGICAL" |
215 | EXT "LOGICAL" | |
216 | FOO "LOGICAL" | |
217 | LIB "LOGICAL" | |
218 | LIST "LOGICAL" | |
219 | MIME "LOGICAL" | |
220 | POSIX "LOGICAL" | |
221 | SYS "LOGICAL" | |
222 | T "LOGICAL" | |
223 | THREAD "LOGICAL" | |
224 | THREADS "LOGICAL" | |
225 | TIME "LOGICAL" | |
226 | TMP "LOGICAL" | |
227 | UNICODE "LOGICAL" | |
228 | UTIL "LOGICAL" | |
229 | TEST "SYMBOL" | |
fb73857a | 230 | |
97abc6ad HM |
231 | As a handy shortcut, the command: |
232 | ||
b4bc034f GS |
233 | @ Configure "-des" |
234 | ||
235 | (note the quotation marks and case) will choose reasonable defaults | |
236 | automatically (it takes DEC C over Gnu C, DEC C sockets over SOCKETSHR | |
1bc81404 CB |
237 | sockets, and either over no sockets). Some options can be given |
238 | explicitly on the command line; the following example specifies a | |
239 | non-default location for where Perl will be installed: | |
240 | ||
241 | @ Configure "-d" "-Dprefix=dka100:[utils.perl5.]" | |
242 | ||
dab31494 | 243 | Note that the installation location would be by default where you unpacked |
fe05d1a7 | 244 | the source with a "_ROOT." appended. For example if you unpacked the perl |
dab31494 PP |
245 | source into: |
246 | ||
247 | DKA200:[PERL-5_10_2...] | |
248 | ||
adc5a9a5 | 249 | Then the PERL_SETUP.COM that gets written out by CONFIGURE.COM will |
dab31494 PP |
250 | try to DEFINE your installation PERL_ROOT to be: |
251 | ||
fe05d1a7 | 252 | DKA200:[PERL-5_10_2_ROOT.] |
dab31494 | 253 | |
1bc81404 | 254 | More help with configure.com is available from: |
b4bc034f GS |
255 | |
256 | @ Configure "-h" | |
257 | ||
258 | See the "Changing compile-time options (optional)" section below to learn | |
259 | even more details about how to influence the outcome of the important | |
260 | configuration step. If you find yourself reconfiguring and rebuilding | |
261 | then be sure to also follow the advice in the "Cleaning up and starting | |
262 | fresh (optional)" and the checklist of items in the "CAVEATS" sections | |
263 | below. | |
264 | ||
a83b6f46 | 265 | =head2 Changing compile-time options (optional) for Perl on VMS |
b4bc034f GS |
266 | |
267 | Most of the user definable features of Perl are enabled or disabled in | |
adc5a9a5 CB |
268 | configure.com, which processes the hints file config_h.SH. There is |
269 | code in there to Do The Right Thing, but that may end up being the | |
270 | wrong thing for you. Make sure you understand what you are doing since | |
271 | inappropriate changes to configure.com or config_h.SH can render perl | |
272 | unbuildable; odds are that there's nothing in there you'll need to | |
273 | change. | |
b4bc034f | 274 | |
a83b6f46 | 275 | =head2 Socket Support (optional) for Perl on VMS |
b4bc034f GS |
276 | |
277 | Perl includes a number of functions for IP sockets, which are available if | |
278 | you choose to compile Perl with socket support. Since IP networking is an | |
279 | optional addition to VMS, there are several different IP stacks available. | |
280 | How well integrated they are into the system depends on the stack, your | |
281 | version of VMS, and the version of your C compiler. | |
282 | ||
17d4810c | 283 | The default solution available is to use the socket routines built into DEC |
b4bc034f GS |
284 | C. Which routines are available depend on the version of VMS you're |
285 | running, and require proper UCX emulation by your TCP/IP vendor. | |
286 | Relatively current versions of Multinet, TCPWare, Pathway, and UCX all | |
287 | provide the required libraries--check your manuals or release notes to see | |
288 | if your version is new enough. | |
289 | ||
17d4810c JM |
290 | The other solution uses the SOCKETSHR library. Before VAX/VMS 5.5-2 it was |
291 | the most portable solution. The SOCKETSHR library has not been maintained | |
292 | since VAX/VMS 5.5-2, and it is not known if will even compile with the ANSI | |
293 | C that Perl currently requires. It remains an option for historical reasons, | |
294 | just in case someone might find it useful. | |
295 | ||
296 | In combination with either UCX or NetLib, this supported all the major TCP | |
297 | stacks (Multinet, Pathways, TCPWare, UCX, and CMU) on all versions of VMS | |
298 | Perl ran on up to VAX/VMS 6.2 and Alpha VMS 1.5 with all the compilers on | |
299 | both VAX and Alpha. The portion of the socket interface was also consistent | |
300 | across versions of VMS and C compilers. | |
301 | ||
302 | It has a problem with UDP sockets when used with Multinet, though, so you | |
303 | should be aware of that. | |
304 | ||
305 | As of VAX/VMS 5.5-2 and later, CMU is the only TCP/IP program that requires | |
306 | socketshr, and the sources have been lost to the most recent CMU bug fixes, | |
307 | so CMU is limited to OpenVMS/VAX 6.2 or earlier, which is the last release | |
308 | that binaries for the last released patches are known to exist. | |
309 | ||
310 | There is currently no official web site for downloading either CMU or | |
311 | SOCKETSHR; however, copies may be found in the DECUS archives. | |
312 | ||
b4bc034f GS |
313 | =head1 Building Perl |
314 | ||
315 | The configuration script will print out, at the very end, the MMS or MMK | |
316 | command you need to compile perl. Issue it (exactly as printed) to start | |
317 | the build. | |
97abc6ad | 318 | |
b4bc034f GS |
319 | Once you issue your MMS or MMK command, sit back and wait. Perl should |
320 | compile and link without a problem. If a problem does occur check the | |
321 | "CAVEATS" section of this document. If that does not help send some | |
322 | mail to the VMSPERL mailing list. Instructions are in the "Mailing Lists" | |
323 | section of this document. | |
97abc6ad | 324 | |
b4bc034f | 325 | =head1 Testing Perl |
fb73857a | 326 | |
b4bc034f GS |
327 | Once Perl has built cleanly you need to test it to make sure things work. |
328 | This step is very important since there are always things that can go wrong | |
329 | somehow and yield a dysfunctional Perl for you. | |
fb73857a | 330 | |
331 | Testing is very easy, though, as there's a full test suite in the perl | |
b4bc034f | 332 | distribution. To run the tests, enter the *exact* MMS line you used to |
fb73857a | 333 | compile Perl and add the word "test" to the end, like this: |
334 | ||
b4bc034f | 335 | If the compile command was: |
fb73857a | 336 | |
b4bc034f | 337 | MMS |
fb73857a | 338 | |
b4bc034f | 339 | then the test command ought to be: |
fb73857a | 340 | |
b4bc034f | 341 | MMS test |
fb73857a | 342 | |
b4bc034f GS |
343 | MMS (or MMK) will run all the tests. This may take some time, as there are |
344 | a lot of tests. If any tests fail, there will be a note made on-screen. | |
345 | At the end of all the tests, a summary of the tests, the number passed and | |
346 | failed, and the time taken will be displayed. | |
fb73857a | 347 | |
96d6186e CB |
348 | The test driver invoked via MMS TEST has a DCL wrapper ([.VMS]TEST.COM) that |
349 | downgrades privileges to NETMBX, TMPMBX for the duration of the test run, | |
350 | and then restores them to their prior state upon completion of testing. | |
351 | This is done to ensure that the tests run in a private sandbox and can do no | |
352 | harm to your system even in the unlikely event something goes badly wrong in | |
353 | one of the test scripts while running the tests from a privileged account. | |
354 | A side effect of this safety precaution is that the account used to run the | |
355 | test suite must be the owner of the directory tree in which Perl has been | |
356 | built; otherwise the manipulations of temporary files and directories | |
357 | attempted by some of the tests will fail. | |
358 | ||
718752a5 CB |
359 | If any tests fail, it means something is wrong with Perl, or at least |
360 | with the particular module or feature that reported failure. If the test suite | |
fb73857a | 361 | hangs (some tests can take upwards of two or three minutes, or more if |
9f3f8d50 | 362 | you're on an especially slow machine, depending on your machine speed, so |
fb73857a | 363 | don't be hasty), then the test *after* the last one displayed failed. Don't |
364 | install Perl unless you're confident that you're OK. Regardless of how | |
365 | confident you are, make a bug report to the VMSPerl mailing list. | |
366 | ||
b4bc034f GS |
367 | If one or more tests fail, you can get more information on the failure by |
368 | issuing this command sequence: | |
fb73857a | 369 | |
b4bc034f | 370 | @ [.VMS]TEST .typ "" "-v" [.subdir]test.T |
fb73857a | 371 | |
372 | where ".typ" is the file type of the Perl images you just built (if you | |
373 | didn't do anything special, use .EXE), and "[.subdir]test.T" is the test | |
374 | that failed. For example, with a normal Perl build, if the test indicated | |
96d6186e | 375 | that t/op/time failed, then you'd do this: |
fb73857a | 376 | |
b4bc034f | 377 | @ [.VMS]TEST .EXE "" "-v" [.OP]TIME.T |
fb73857a | 378 | |
96d6186e CB |
379 | Note that test names are reported in UNIX syntax and relative to the |
380 | top-level build directory. When supplying them individually to the test | |
381 | driver, you can use either UNIX or VMS syntax, but you must give the path | |
382 | relative to the [.T] directory and you must also add the .T extension to the | |
383 | filename. So, for example if the test lib/Math/Trig fails, you would run: | |
384 | ||
385 | @ [.VMS]TEST .EXE "" -"v" [-.lib.math]trig.t | |
386 | ||
fb73857a | 387 | When you send in a bug report for failed tests, please include the output |
388 | from this command, which is run from the main source directory: | |
389 | ||
b4bc034f GS |
390 | MCR []MINIPERL "-V" |
391 | ||
392 | Note that -"V" really is a capital V in double quotes. This will dump out a | |
393 | couple of screens worth of configuration information, and can help us | |
394 | diagnose the problem. If (and only if) that did not work then try enclosing | |
395 | the output of: | |
396 | ||
397 | MMS printconfig | |
fb73857a | 398 | |
9f3f8d50 PP |
399 | If (and only if) that did not work then try enclosing the output of: |
400 | ||
b4bc034f | 401 | @ [.vms]myconfig |
fb73857a | 402 | |
b4bc034f GS |
403 | You may also be asked to provide your C compiler version ("CC/VERSION NL:" |
404 | with DEC C, "gcc --version" with GNU CC). To obtain the version of MMS or | |
405 | MMK you are running try "MMS/ident" or "MMK /ident". The GNU make version | |
406 | can be identified with "make --version". | |
407 | ||
a83b6f46 | 408 | =head2 Cleaning up and starting fresh (optional) installing Perl on VMS |
fb73857a | 409 | |
410 | If you need to recompile from scratch, you have to make sure you clean up | |
b4bc034f GS |
411 | first. There is a procedure to do it--enter the *exact* MMS line you used |
412 | to compile and add "realclean" at the end, like this: | |
fb73857a | 413 | |
b4bc034f | 414 | if the compile command was: |
fb73857a | 415 | |
b4bc034f | 416 | MMS |
fb73857a | 417 | |
b4bc034f | 418 | then the cleanup command ought to be: |
fb73857a | 419 | |
b4bc034f | 420 | MMS realclean |
fb73857a | 421 | |
b4bc034f GS |
422 | If you do not do this things may behave erratically during the subsequent |
423 | rebuild attempt. They might not, too, so it is best to be sure and do it. | |
fb73857a | 424 | |
b4bc034f | 425 | =head1 Installing Perl |
fb73857a | 426 | |
427 | There are several steps you need to take to get Perl installed and | |
3a385817 | 428 | running. |
fb73857a | 429 | |
a3ef2c6f | 430 | =over 4 |
b4bc034f | 431 | |
a3ef2c6f | 432 | =item 1 |
fb73857a | 433 | |
a3ef2c6f | 434 | Check your default file protections with |
fb73857a | 435 | |
a3ef2c6f | 436 | SHOW PROTECTION /DEFAULT |
fb73857a | 437 | |
a3ef2c6f | 438 | and adjust if necessary with SET PROTECTION=(code)/DEFAULT. |
fb73857a | 439 | |
a3ef2c6f | 440 | =item 2 |
3a385817 | 441 | |
1bc81404 CB |
442 | Decide where you want Perl to be installed (unless you have already done so |
443 | by using the "prefix" configuration parameter -- see the example in the | |
444 | "Configuring the Perl build" section). | |
b4bc034f | 445 | |
1bc81404 CB |
446 | The DCL script PERL_SETUP.COM that is written by CONFIGURE.COM will help you |
447 | with the definition of the PERL_ROOT and PERLSHR logical names and the PERL | |
448 | foreign command symbol. Take a look at PERL_SETUP.COM and modify it if you | |
449 | want to. The installation process will execute PERL_SETUP.COM and copy | |
450 | files to the directory tree pointed to by the PERL_ROOT logical name defined | |
451 | there, so make sure that you have write access to the parent directory of | |
452 | what will become the root of your Perl installation. | |
fb73857a | 453 | |
a3ef2c6f | 454 | =item 3 |
b4bc034f | 455 | |
a3ef2c6f | 456 | Run the install script via: |
b4bc034f | 457 | |
a3ef2c6f | 458 | MMS install |
b4bc034f | 459 | |
a3ef2c6f | 460 | or |
9f3f8d50 | 461 | |
a3ef2c6f | 462 | MMK install |
b4bc034f | 463 | |
a3ef2c6f GS |
464 | If for some reason it complains about target INSTALL being up to date, |
465 | throw a /FORCE switch on the MMS or MMK command. | |
b4bc034f | 466 | |
a3ef2c6f GS |
467 | =back |
468 | ||
1bc81404 CB |
469 | Copy PERL_SETUP.COM to a place accessible to your perl users. |
470 | ||
a3ef2c6f | 471 | For example: |
fb73857a | 472 | |
a3ef2c6f | 473 | COPY PERL_SETUP.COM SYS$LIBRARY: |
b4bc034f | 474 | |
a3ef2c6f GS |
475 | If you want to have everyone on the system have access to perl |
476 | then add a line that reads | |
fb73857a | 477 | |
a3ef2c6f | 478 | $ @sys$library:perl_setup |
491527d0 | 479 | |
a3ef2c6f | 480 | to SYS$MANAGER:SYLOGIN.COM. |
85988417 | 481 | |
a3ef2c6f GS |
482 | Two alternatives to the foreign symbol would be to install PERL into |
483 | DCLTABLES.EXE (Check out the section "Installing Perl into DCLTABLES | |
484 | (optional)" for more information), or put the image in a | |
485 | directory that's in your DCL$PATH (if you're using VMS V6.2 or higher). | |
85988417 | 486 | |
a3ef2c6f GS |
487 | An alternative to having PERL_SETUP.COM define the PERLSHR logical name |
488 | is to simply copy it into the system shareable library directory with: | |
489 | ||
490 | copy perl_root:[000000]perlshr.exe sys$share: | |
85988417 | 491 | |
a3ef2c6f | 492 | See also the "INSTALLing images (optional)" section. |
491527d0 | 493 | |
a83b6f46 | 494 | =head2 Installing Perl into DCLTABLES (optional) on VMS |
fb73857a | 495 | |
9ef4b0a6 | 496 | Execute the following command file to define PERL as a DCL command. |
b4bc034f | 497 | You'll need CMKRNL privilege to install the new dcltables.exe. |
fb73857a | 498 | |
7bb57f25 GS |
499 | $ create perl.cld |
500 | ! | |
501 | ! modify to reflect location of your perl.exe | |
502 | ! | |
503 | define verb perl | |
504 | image perl_root:[000000]perl.exe | |
505 | cliflags (foreign) | |
506 | $! | |
507 | $ set command perl /table=sys$common:[syslib]dcltables.exe - | |
508 | /output=sys$common:[syslib]dcltables.exe | |
509 | $ install replace sys$common:[syslib]dcltables.exe | |
510 | $ exit | |
fb73857a | 511 | |
a83b6f46 | 512 | =head2 INSTALLing Perl images (optional) on VMS |
9f3f8d50 PP |
513 | |
514 | On systems that are using perl quite a bit, and particularly those with | |
515 | minimal RAM, you can boost the performance of perl by INSTALLing it as | |
adc5a9a5 | 516 | a known image. PERLSHR.EXE is typically larger than 3000 blocks |
9f3f8d50 PP |
517 | and that is a reasonably large amount of IO to load each time perl is |
518 | invoked. | |
519 | ||
520 | INSTALL ADD PERLSHR/SHARE | |
b4bc034f | 521 | INSTALL ADD PERL/HEADER |
9f3f8d50 PP |
522 | |
523 | should be enough for PERLSHR.EXE (/share implies /header and /open), | |
524 | while /HEADER should do for PERL.EXE (perl.exe is not a shared image). | |
525 | ||
b4bc034f GS |
526 | If your code 'use's modules, check to see if there is a shareable image for |
527 | them, too. In the base perl build, POSIX, IO, Fcntl, Opcode, SDBM_File, | |
e7948fac CB |
528 | DCLsym, and Stdio, and other extensions all have shared images that can be |
529 | installed /SHARE. | |
9f3f8d50 | 530 | |
b4bc034f | 531 | How much of a win depends on your memory situation, but if you are firing |
9f3f8d50 | 532 | off perl with any regularity (like more than once every 20 seconds or so) |
b4bc034f | 533 | it is probably beneficial to INSTALL at least portions of perl. |
9f3f8d50 PP |
534 | |
535 | While there is code in perl to remove privileges as it runs you are advised | |
536 | to NOT INSTALL PERL.EXE with PRIVs! | |
fb73857a | 537 | |
dab31494 PP |
538 | =head2 Running h2ph to create perl header files (optional) on VMS |
539 | ||
10019e56 CB |
540 | If using HP C, ensure that you have extracted loose versions of your |
541 | compiler's header or *.H files. Be sure to check the contents of: | |
dab31494 PP |
542 | |
543 | SYS$LIBRARY:DECC$RTLDEF.TLB | |
544 | SYS$LIBRARY:SYS$LIB_C.TLB | |
545 | SYS$LIBRARY:SYS$STARLET_C.TLB | |
546 | ||
547 | etcetera. | |
548 | ||
549 | If using GNU cc then also check your GNU_CC:[000000...] tree for the locations | |
550 | of the GNU cc headers. | |
551 | ||
b4bc034f | 552 | =head1 Reporting Bugs |
fb73857a | 553 | |
554 | If you come across what you think might be a bug in Perl, please report | |
555 | it. There's a script in PERL_ROOT:[UTILS], perlbug, that walks you through | |
556 | the process of creating a bug report. This script includes details of your | |
557 | installation, and is very handy. Completed bug reports should go to | |
9f3f8d50 | 558 | perlbug@perl.com. |
fb73857a | 559 | |
b4bc034f | 560 | =head1 CAVEATS |
fb73857a | 561 | |
562 | Probably the single biggest gotcha in compiling Perl is giving the wrong | |
b4bc034f GS |
563 | switches to MMS/MMK when you build. Use *exactly* what the configure.com |
564 | script prints! | |
565 | ||
566 | The next big gotcha is directory depth. Perl can create directories four, | |
567 | five, or even six levels deep during the build, so you don't have to be | |
dab31494 | 568 | too deep to start to hit the RMS 8 level limit (for ODS 2 volumes which were |
ec55d5e4 | 569 | common on versions of VMS prior to V7.2 and even with V7.3 on the VAX). |
dab31494 | 570 | It is best to do: |
b4bc034f GS |
571 | |
572 | DEFINE/TRANS=(CONC,TERM) PERLSRC "disk:[dir.dir.dir.perldir.]" | |
573 | SET DEFAULT PERLSRC:[000000] | |
574 | ||
575 | before building in cases where you have to unpack the distribution so deep | |
576 | (note the trailing period in the definition of PERLSRC). Perl modules | |
577 | from CPAN can be just as bad (or worse), so watch out for them, too. Perl's | |
578 | configuration script will warn if it thinks you are too deep (at least on | |
579 | a VAX or on Alpha versions of VMS prior to 7.2). But MakeMaker will not | |
580 | warn you if you start out building a module too deep in a directory. | |
581 | ||
d83fac45 PP |
582 | As noted above ODS-5 escape sequences such as ^. can break the perl |
583 | build. Solutions include renaming files and directories as needed or | |
584 | being careful to use the -o switch or /ODS2 qualifier with latter | |
585 | versions of the vmstar utility when unpacking perl or CPAN modules | |
586 | on ODS-5 volumes. | |
587 | ||
b4bc034f GS |
588 | Be sure that the process that you use to build perl has a PGFLQ greater |
589 | than 100000. Be sure to have a correct local time zone to UTC offset | |
590 | defined (in seconds) in the logical name SYS$TIMEZONE_DIFFERENTIAL before | |
591 | running the regression test suite. The SYS$MANAGER:UTC$CONFIGURE_TDF.COM | |
592 | procedure will help you set that logical for your system but may require | |
593 | system privileges. For example, a location 5 hours west of UTC (such as | |
594 | the US East coast while not on daylight savings time) would have: | |
595 | ||
596 | DEFINE SYS$TIMEZONE_DIFFERENTIAL "-18000" | |
597 | ||
598 | A final thing that causes trouble is leftover pieces from a failed | |
599 | build. If things go wrong make sure you do a "(MMK|MMS|make) realclean" | |
fb73857a | 600 | before you rebuild. |
601 | ||
a83b6f46 | 602 | =head2 DEC C issues with Perl on VMS |
fb73857a | 603 | |
b4bc034f | 604 | Note to DEC C users: Some early versions (pre-5.2, some pre-4. If you're DEC |
c54e8273 | 605 | C 5.x or higher, with current patches if any, you're fine) of the DECCRTL |
fb73857a | 606 | contained a few bugs which affect Perl performance: |
b4bc034f GS |
607 | |
608 | =over 4 | |
609 | ||
610 | =item - pipes | |
611 | ||
612 | Newlines are lost on I/O through pipes, causing lines to run together. | |
613 | This shows up as RMS RTB errors when reading from a pipe. You can | |
614 | work around this by having one process write data to a file, and | |
615 | then having the other read the file, instead of the pipe. This is | |
616 | fixed in version 4 of DEC C. | |
617 | ||
618 | =item - modf() | |
619 | ||
620 | The modf() routine returns a non-integral value for some values above | |
621 | INT_MAX; the Perl "int" operator will return a non-integral value in | |
622 | these cases. This is fixed in version 4 of DEC C. | |
623 | ||
624 | =item - ALPACRT ECO | |
625 | ||
626 | On the AXP, if SYSNAM privilege is enabled, the CRTL chdir() routine | |
627 | changes the process default device and directory permanently, even | |
628 | though the call specified that the change should not persist after | |
629 | Perl exited. This is fixed by DEC CSC patch ALPACRT04_061 or later. | |
630 | See also: | |
631 | ||
172b4273 | 632 | http://ftp.support.compaq.com/patches/.new/openvms.shtml |
b4bc034f GS |
633 | |
634 | =back | |
635 | ||
636 | Please note that in later versions "DEC C" may also be known as | |
637 | "Compaq C". | |
638 | ||
a83b6f46 | 639 | =head2 GNU issues with Perl on VMS |
b4bc034f GS |
640 | |
641 | It has been a while since the GNU utilities such as GCC or GNU make | |
642 | were used to build perl on VMS. Hence they may require a great deal | |
643 | of source code modification to work again. | |
644 | ||
645 | http://slacvx.slac.stanford.edu/HELP/GCC | |
646 | http://www.progis.de/ | |
b4bc034f GS |
647 | http://www.lp.se/products/gnu.html |
648 | ||
e7948fac CB |
649 | =head2 Floating Point Considerations |
650 | ||
651 | Prior to 5.8.0, Perl simply accepted the default floating point options of the | |
652 | C compiler, namely representing doubles with D_FLOAT on VAX and G_FLOAT on | |
653 | Alpha. Single precision floating point values are represented in F_FLOAT | |
654 | format when either D_FLOAT or G_FLOAT is in use for doubles. Beginning with | |
655 | 5.8.0, Alpha builds now use IEEE floating point formats by default, which in | |
656 | VMS parlance are S_FLOAT for singles and T_FLOAT for doubles. IEEE is not | |
657 | available on VAX, so F_FLOAT and D_FLOAT remain the defaults for singles and | |
658 | doubles respectively. The available non-default options are G_FLOAT on VAX | |
659 | and D_FLOAT or G_FLOAT on Alpha. | |
660 | ||
661 | The use of IEEE on Alpha introduces NaN, infinity, and denormalization | |
662 | capabilities not available with D_FLOAT and G_FLOAT. When using one of those | |
663 | non-IEEE formats, silent underflow and overflow are emulated in the conversion | |
664 | of strings to numbers, but it is preferable to get the real thing by using | |
665 | IEEE where possible. | |
666 | ||
667 | Regardless of what floating point format you consider preferable, be aware | |
668 | that the choice may have an impact on compatibility with external libraries, | |
669 | such as database interfaces, and with existing data, such as data created with | |
670 | the C<pack> function and written to disk, or data stored via the Storable | |
671 | extension. For example, a C<pack("d", $foo)")> will create a D_FLOAT, | |
672 | G_FLOAT, or T_FLOAT depending on what your Perl was configured with. When | |
673 | written to disk, the value can only be retrieved later by a Perl configured | |
674 | with the same floating point option that was in effect when it was created. | |
675 | ||
676 | To obtain a non-IEEE build on Alpha, simply answer no to the "Use IEEE math?" | |
677 | question during the configuration. To obtain an option different from the C | |
678 | compiler default on either VAX or Alpha, put in the option that you want in | |
679 | answer to the "Any additional cc flags?" question. For example, to obtain a | |
680 | G_FLOAT build on VAX, put in C</FLOAT=G_FLOAT>. | |
681 | ||
49fd6f17 PP |
682 | =head2 Multinet issues with Perl on VMS |
683 | ||
684 | Prior to the release of Perl 5.8.0 it was noted that the regression | |
685 | test for lib/Net/hostent (in file [.lib.Net]hostent.t) will fail owing | |
686 | to problems with the hostent structure returned by C calls to either | |
687 | gethostbyname() or gethostbyaddr() using DEC or Compaq C with a | |
688 | Multinet TCP/IP stack. The problem was noted in Multinet 4.3A | |
689 | using either Compaq C 6.5 or DEC C 6.0, and with Multinet 4.2A | |
690 | using DEC C 5.2, but could easily affect other versions of Multinet. | |
c2a352b2 CB |
691 | Process Software Inc. has acknowledged a bug in the Multinet version |
692 | of UCX$IPC_SHR and has provided an ECO for it. The ECO is called | |
693 | UCX_LIBRARY_EMULATION-010_A044 and is available from: | |
49fd6f17 PP |
694 | |
695 | http://www.multinet.process.com/eco.html | |
696 | ||
c2a352b2 CB |
697 | As of this writing, the ECO is only available for Multinet versions |
698 | 4.3A and later. You may determine the version of Multinet that you | |
699 | are running using the command: | |
49fd6f17 PP |
700 | |
701 | multinet show /version | |
702 | ||
703 | from the DCL command prompt. | |
704 | ||
c2a352b2 CB |
705 | If the ECO is unavailable for your version of Multinet and you are |
706 | unable to upgrade, you might try using Perl programming constructs | |
707 | such as: | |
49fd6f17 PP |
708 | |
709 | $address = substr($gethostbyname_addr,0,4); | |
710 | ||
711 | to temporarily work around the problem, or if you are brave | |
712 | and do not mind the possibility of breaking IPv6 addresses, | |
713 | you might modify the pp_sys.c file to add an ad-hoc correction | |
714 | like so: | |
715 | ||
716 | ||
717 | --- pp_sys.c;1 Thu May 30 14:42:17 2002 | |
718 | +++ pp_sys.c Thu May 30 12:54:02 2002 | |
719 | @@ -4684,6 +4684,10 @@ | |
720 | } | |
721 | #endif | |
722 | ||
723 | + if (hent) { | |
724 | + hent->h_length = 4; | |
725 | + } | |
726 | + | |
727 | if (GIMME != G_ARRAY) { | |
728 | PUSHs(sv = sv_newmortal()); | |
729 | if (hent) { | |
730 | ||
731 | then re-compile and re-test your perl. After the installation | |
732 | of the Multinet ECO you ought to back out any such changes though. | |
733 | ||
b4bc034f GS |
734 | =head1 Mailing Lists |
735 | ||
736 | There are several mailing lists available to the Perl porter. For VMS | |
fb73857a | 737 | specific issues (including both Perl questions and installation problems) |
b4bc034f | 738 | there is the VMSPERL mailing list. It is usually a low-volume (10-12 |
fb73857a | 739 | messages a week) mailing list. |
740 | ||
1bc81404 CB |
741 | To subscribe, send a mail message to VMSPERL-SUBSCRIBE@PERL.ORG. The VMSPERL |
742 | mailing list address is VMSPERL@PERL.ORG. Any mail sent there gets echoed | |
743 | to all subscribers of the list. There is a searchable archive of the list | |
744 | on the web at: | |
b4bc034f GS |
745 | |
746 | http://www.xray.mpe.mpg.de/mailing-lists/vmsperl/ | |
a83b6f46 | 747 | |
1bc81404 CB |
748 | To unsubscribe from VMSPERL send a message to VMSPERL-UNSUBSCRIBE@PERL.ORG. |
749 | Be sure to do so from the subscribed account that you are canceling. | |
b4bc034f | 750 | |
a83b6f46 | 751 | =head2 Web sites for Perl on VMS |
b4bc034f GS |
752 | |
753 | Vmsperl pages on the web include: | |
754 | ||
755 | http://www.sidhe.org/vmsperl/index.html | |
468f45d5 | 756 | http://www.cpan.org/modules/by-module/VMS/ |
60d9c7be | 757 | http://www.xray.mpe.mpg.de/mailing-lists/vmsperl/ |
adc5a9a5 | 758 | http://www-ang.kfunigraz.ac.at/~binder/perl.html |
60d9c7be PP |
759 | http://lists.perl.org/showlist.cgi?name=vmsperl |
760 | http://archive.develooper.com/vmsperl@perl.org/ | |
10019e56 | 761 | http://h71000.www7.hp.com/openvms/products/ips/apache/csws_modperl.html |
fb73857a | 762 | |
b4bc034f GS |
763 | =head1 SEE ALSO |
764 | ||
765 | Perl information for users and programmers about the port of perl to VMS is | |
3bc8f799 | 766 | available from the [.POD]PERLVMS.POD file that gets installed as L<perlvms>. |
b4bc034f GS |
767 | For administrators the perlvms document also includes a detailed discussion |
768 | of extending vmsperl with CPAN modules after Perl has been installed. | |
769 | ||
770 | =head1 AUTHORS | |
771 | ||
ec55d5e4 CB |
772 | Originally by Charles Bailey bailey@newman.upenn.edu. See the git repository |
773 | for history. | |
b4bc034f GS |
774 | |
775 | =head1 ACKNOWLEDGEMENTS | |
fb73857a | 776 | |
777 | A real big thanks needs to go to Charles Bailey | |
b4bc034f | 778 | bailey@newman.upenn.edu, who is ultimately responsible for Perl 5.004 |
fb73857a | 779 | running on VMS. Without him, nothing the rest of us have done would be at |
780 | all important. | |
781 | ||
782 | There are, of course, far too many people involved in the porting and testing | |
783 | of Perl to mention everyone who deserves it, so please forgive us if we've | |
784 | missed someone. That said, special thanks are due to the following: | |
b4bc034f GS |
785 | |
786 | Tim Adye T.J.Adye@rl.ac.uk | |
fb73857a | 787 | for the VMS emulations of getpw*() |
b4bc034f | 788 | David Denholm denholm@conmat.phys.soton.ac.uk |
fb73857a | 789 | for extensive testing and provision of pipe and SocketShr code, |
b4bc034f | 790 | Mark Pizzolato mark@infocomm.com |
fb73857a | 791 | for the getredirection() code |
b4bc034f | 792 | Rich Salz rsalz@bbn.com |
fb73857a | 793 | for readdir() and related routines |
b4bc034f | 794 | Peter Prymmer pvhp@best.com |
fb73857a | 795 | for extensive testing, as well as development work on |
796 | configuration and documentation for VMS Perl, | |
b4bc034f | 797 | Dan Sugalski dan@sidhe.org |
fb73857a | 798 | for extensive contributions to recent version support, |
799 | development of VMS-specific extensions, and dissemination | |
800 | of information about VMS Perl, | |
801 | the Stanford Synchrotron Radiation Laboratory and the | |
802 | Laboratory of Nuclear Studies at Cornell University for | |
9f3f8d50 | 803 | the opportunity to test and develop for the AXP, |
a3ef2c6f GS |
804 | John Hasstedt John.Hasstedt@sunysb.edu |
805 | for VAX VMS V7.2 support | |
ec55d5e4 CB |
806 | John Malmberg wb8tyw@qsl.net |
807 | for ODS-5 filename handling and other modernizations | |
b4bc034f | 808 | |
fb73857a | 809 | and to the entire VMSperl group for useful advice and suggestions. In |
810 | addition the perl5-porters deserve credit for their creativity and | |
811 | willingness to work with the VMS newcomers. Finally, the greatest debt of | |
b4bc034f | 812 | gratitude is due to Larry Wall larry@wall.org, for having the ideas which |
fb73857a | 813 | have made our sleepless nights possible. |
814 | ||
815 | Thanks, | |
816 | The VMSperl group | |
b4bc034f GS |
817 | |
818 | =cut | |
819 |