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