5.003_08: OS/2-specific bugs/enhancements
[p5sagit/p5-mst-13.2.git] / vms / perlvms.pod
CommitLineData
e518068a 1=head1 NAME
2
3perlvms - VMS-specific documentation for Perl
4
5=head1 DESCRIPTION
a0d0e21e 6
748a9306 7Gathered below are notes describing details of Perl 5's
8behavior on VMS. They are a supplement to the regular Perl 5
9documentation, so we have focussed on the ways in which Perl
105 functions differently under VMS than it does under Unix,
11and on the interactions between Perl and the rest of the
a0d0e21e 12operating system. We haven't tried to duplicate complete
748a9306 13descriptions of Perl features from the main Perl
a0d0e21e 14documentation, which can be found in the F<[.pod]>
748a9306 15subdirectory of the Perl distribution.
a0d0e21e 16
17We hope these notes will save you from confusion and lost
748a9306 18sleep when writing Perl scripts on VMS. If you find we've
a0d0e21e 19missed something you think should appear here, please don't
20hesitate to drop a line to vmsperl@genetics.upenn.edu.
21
4e592037 22=head1 Installation
23
24Directions for building and installing Perl 5 can be found in
25the file F<README.vms> in the main source directory of the
26Perl distribution..
27
e518068a 28=head1 Organization of Perl Images
748a9306 29
e518068a 30=head2 Core Images
748a9306 31
32During the installation process, three Perl images are produced.
33F<Miniperl.Exe> is an executable image which contains all of
34the basic functionality of Perl, but cannot take advantage of
35Perl extensions. It is used to generate several files needed
36to build the complete Perl and various extensions. Once you've
37finished installing Perl, you can delete this image.
38
39Most of the complete Perl resides in the shareable image
40F<PerlShr.Exe>, which provides a core to which the Perl executable
41image and all Perl extensions are linked. You should place this
42image in F<Sys$Share>, or define the logical name F<PerlShr> to
43translate to the full file specification of this image. It should
44be world readable. (Remember that if a user has execute only access
45to F<PerlShr>, VMS will treat it as if it were a privileged shareable
46image, and will therefore require all downstream shareable images to be
47INSTALLed, etc.)
48
49
50Finally, F<Perl.Exe> is an executable image containing the main
51entry point for Perl, as well as some initialization code. It
52should be placed in a public directory, and made world executable.
53In order to run Perl with command line arguments, you should
54define a foreign command to invoke this image.
55
56=head2 Perl Extensions
57
58Perl extensions are packages which provide both XS and Perl code
59to add new functionality to perl. (XS is a meta-language which
60simplifies writing C code which interacts with Perl, see
61L<perlapi> for more details.) The Perl code for an
62extension is treated like any other library module - it's
63made available in your script through the appropriate
64C<use> or C<require> statement, and usually defines a Perl
65package containing the extension.
66
67The portion of the extension provided by the XS code may be
68connected to the rest of Perl in either of two ways. In the
69B<static> configuration, the object code for the extension is
70linked directly into F<PerlShr.Exe>, and is initialized whenever
71Perl is invoked. In the B<dynamic> configuration, the extension's
72machine code is placed into a separate shareable image, which is
73mapped by Perl's DynaLoader when the extension is C<use>d or
74C<require>d in your script. This allows you to maintain the
75extension as a separate entity, at the cost of keeping track of the
76additional shareable image. Most extensions can be set up as either
77static or dynamic.
78
79The source code for an extension usually resides in its own
80directory. At least three files are generally provided:
81I<Extshortname>F<.xs> (where I<Extshortname> is the portion of
82the extension's name following the last C<::>), containing
83the XS code, I<Extshortname>F<.pm>, the Perl library module
84for the extension, and F<Makefile.PL>, a Perl script which uses
85the C<MakeMaker> library modules supplied with Perl to generate
86a F<Descrip.MMS> file for the extension.
87
e518068a 88=head2 Installing static extensions
748a9306 89
90Since static extensions are incorporated directly into
91F<PerlShr.Exe>, you'll have to rebuild Perl to incorporate a
92new extension. You should edit the main F<Descrip.MMS> or F<Makefile>
93you use to build Perl, adding the extension's name to the C<ext>
94macro, and the extension's object file to the C<extobj> macro.
95You'll also need to build the extension's object file, either
96by adding dependencies to the main F<Descrip.MMS>, or using a
97separate F<Descrip.MMS> for the extension. Then, rebuild
98F<PerlShr.Exe> to incorporate the new code.
99
100Finally, you'll need to copy the extension's Perl library
101module to the F<[.>I<Extname>F<]> subdirectory under one
102of the directories in C<@INC>, where I<Extname> is the name
103of the extension, with all C<::> replaced by C<.> (e.g.
104the library module for extension Foo::Bar would be copied
105to a F<[.Foo.Bar]> subdirectory).
106
e518068a 107=head2 Installing dynamic extensions
108
109In general, the distributed kit for a Perl extension includes
110a file named Makefile.PL, which is a Perl program which is used
111to create a F<Descrip.MMS> file which can be used to build and
112install the files required by the extension. The kit should be
c07a80fd 113unpacked into a directory tree B<not> under the main Perl source
e518068a 114directory, and the procedure for building the extension is simply
115
e518068a 116 $ perl Makefile.PL ! Create Descrip.MMS
117 $ mmk ! Build necessary files
118 $ mmk test ! Run test code, if supplied
119 $ mmk install ! Install into public Perl tree
120
c07a80fd 121I<N.B.> The procedure by which extensions are built and
122tested creates several levels (at least 4) under the
123directory in which the extension's source files live.
124For this reason, you shouldn't nest the source directory
125too deeply in your directory structure, lest you eccedd RMS'
126maximum of 8 levels of subdirectory in a filespec. (You
127can use rooted logical names to get another 8 levels of
128nesting, if you can't place the files near the top of
129the physical directory structure.)
e518068a 130
131VMS support for this process in the current release of Perl
132is sufficient to handle most extensions. However, it does
133not yet recognize extra libraries required to build shareable
134images which are part of an extension, so these must be added
135to the linker options file for the extension by hand. For
136instance, if the F<PGPLOT> extension to Perl requires the
137F<PGPLOTSHR.EXE> shareable image in order to properly link
138the Perl extension, then the line C<PGPLOTSHR/Share> must
139be added to the linker options file F<PGPLOT.Opt> produced
140during the build process for the Perl extension.
141
142By default, the shareable image for an extension is placed
4e592037 143in the F<[.Lib.Auto.>I<Arch>.I<Extname>F<]> directory of the
e518068a 144installed Perl directory tree (where I<Arch> is F<VMS_VAX> or
4e592037 145F<VMS_AXP>, followed by the Perl version number, and I<Extname>
146is the name of the extension, with each C<::> translated to C<.>).
147However, it can be manually placed in any of several locations:
148 - the F<[.Lib.Auto.>I<Extname>F<]> subdirectory of one of
e518068a 149 the directories in C<@INC>, or
748a9306 150 - one of the directories in C<@INC>, or
151 - a directory which the extensions Perl library module
152 passes to the DynaLoader when asking it to map
153 the shareable image, or
154 - F<Sys$Share> or F<Sys$Library>.
155If the shareable image isn't in any of these places, you'll need
156to define a logical name I<Extshortname>, where I<Extshortname>
157is the portion of the extension's name after the last C<::>, which
158translates to the full file specification of the shareable image.
159
4e592037 160=head1 File specifications
748a9306 161
4e592037 162=head2 Syntax
a0d0e21e 163
748a9306 164We have tried to make Perl aware of both VMS-style and Unix-
a0d0e21e 165style file specifications wherever possible. You may use
166either style, or both, on the command line and in scripts,
167but you may not combine the two styles within a single fle
1c9f8daa 168specification. VMS Perl interprets Unix pathnames in much
169the same way as the CRTL (I<e.g.> the first component of
170an absolute path is read as the device name for the
171VMS file specification). There are a set of functions
172provided in the C<VMS::Filespec> package for explicit
173interconversion between VMS and Unix syntax; its
174documentation provides more details.
175
176Filenames are, of course, still case-insensitive. For
177consistency, most Perl routines return filespecs using
178lower case letters only, regardless of the case used in
179the arguments passed to them. (This is true only when
180running under VMS; Perl respects the case-sensitivity
181of OSs like Unix.)
a0d0e21e 182
748a9306 183We've tried to minimize the dependence of Perl library
a0d0e21e 184modules on Unix syntax, but you may find that some of these,
185as well as some scripts written for Unix systems, will
186require that you use Unix syntax, since they will assume that
4e592037 187'/' is the directory separator, I<etc.> If you find instances
748a9306 188of this in the Perl distribution itself, please let us know,
a0d0e21e 189so we can try to work around them.
190
4e592037 191=head2 Wildcard expansion
192
193File specifications containing wildcards are allowed both on
194the command line and within Perl globs (e.g. <CE<lt>*.cE<gt>>). If
195the wildcard filespec uses VMS syntax, the resultant
196filespecs will follow VMS syntax; if a Unix-style filespec is
197passed in, Unix-style filespecs will be returned.
198
199If the wildcard filespec contains a device or directory
200specification, then the resultant filespecs will also contain
201a device and directory; otherwise, device and directory
202information are removed. VMS-style resultant filespecs will
203contain a full device and directory, while Unix-style
204resultant filespecs will contain only as much of a directory
205path as was present in the input filespec. For example, if
206your default directory is Perl_Root:[000000], the expansion
207of C<[.t]*.*> will yield filespecs like
208"perl_root:[t]base.dir", while the expansion of C<t/*/*> will
209yield filespecs like "t/base.dir". (This is done to match
210the behavior of glob expansion performed by Unix shells.)
211
212Similarly, the resultant filespec will contain the file version
213only if one was present in the input filespec.
214
215=head2 Pipes
216
217Input and output pipes to Perl filehandles are supported; the
218"file name" is passed to lib$spawn() for asynchronous
219execution. You should be careful to close any pipes you have
220opened in a Perl script, lest you leave any "orphaned"
221subprocesses around when Perl exits.
222
223You may also use backticks to invoke a DCL subprocess, whose
224output is used as the return value of the expression. The
225string between the backticks is passed directly to lib$spawn
226as the command to execute. In this case, Perl will wait for
227the subprocess to complete before continuing.
228
229=head1 PERL5LIB and PERLLIB
230
231The PERL5LIB and PERLLIB logical names work as documented L<perl>,
232except that the element separator is '|' instead of ':'. The
233directory specifications may use either VMS or Unix syntax.
234
235=head1 Command line
236
237=head2 I/O redirection and backgrounding
a0d0e21e 238
239Perl for VMS supports redirection of input and output on the
240command line, using a subset of Bourne shell syntax:
55497cff 241
a0d0e21e 242 <F<file> reads stdin from F<file>,
243 >F<file> writes stdout to F<file>,
244 >>F<file> appends stdout to F<file>,
748a9306 245 2>F<file> writes stderr to F<file>, and
a0d0e21e 246 2>>F<file> appends stderr to F<file>.
247
248In addition, output may be piped to a subprocess, using the
249character '|'. Anything after this character on the command
250line is passed to a subprocess for execution; the subprocess
748a9306 251takes the output of Perl as its input.
a0d0e21e 252
253Finally, if the command line ends with '&', the entire
254command is run in the background as an asynchronous
255subprocess.
256
4e592037 257=head2 Command line switches
a0d0e21e 258
4e592037 259The following command line switches behave differently under
260VMS than described in L<perlrun>. Note also that in order
261to pass uppercase switches to Perl, you need to enclose
262them in double-quotes on the command line, since the CRTL
263downcases all unquoted strings.
a0d0e21e 264
55497cff 265=over 4
266
edc7bc49 267=item -i
268
269If the C<-i> switch is present but no extension for a backup
270copy is given, then inplace editing creates a new version of
271a file; the existing copy is not deleted. (Note that if
272an extension is given, an existing file is renamed to the backup
273file, as is the case under other operating systems, so it does
274not remain as a previous version under the original filename.)
275
4e592037 276=item -S
a0d0e21e 277
4e592037 278If the C<-S> switch is present I<and> the script name does
279not contain a directory, then Perl translates the logical
280name DCL$PATH as a searchlist, using each translation as
281a directory in which to look for the script. In addition,
282if no file type is specified, Perl looks in each directory
283for a file matching the name specified, with a blank type,
284a type of F<.pl>, and a type of F<.com>, in that order.
a0d0e21e 285
4e592037 286=item -u
748a9306 287
4e592037 288The C<-u> switch causes the VMS debugger to be invoked
289after the Perl program is compiled, but before it has
290run. It does not create a core dump file.
748a9306 291
55497cff 292=back
293
748a9306 294=head1 Perl functions
a0d0e21e 295
296As of the time this document was last revised, the following
748a9306 297Perl functions were implemented in the VMS port of Perl
a0d0e21e 298(functions marked with * are discussed in more detail below):
299
300 file tests*, abs, alarm, atan, binmode*, bless,
301 caller, chdir, chmod, chown, chomp, chop, chr,
c07a80fd 302 close, closedir, cos, crypt*, defined, delete,
4e592037 303 die, do, dump*, each, endpwent, eof, eval, exec*,
304 exists, exit, exp, fileno, fork*, getc, getlogin,
305 getpwent*, getpwnam*, getpwuid*, glob, gmtime*, goto,
306 grep, hex, import, index, int, join, keys, kill*,
307 last, lc, lcfirst, length, local, localtime, log, m//,
308 map, mkdir, my, next, no, oct, open, opendir, ord, pack,
c07a80fd 309 pipe, pop, pos, print, printf, push, q//, qq//, qw//,
310 qx//, quotemeta, rand, read, readdir, redo, ref, rename,
a0d0e21e 311 require, reset, return, reverse, rewinddir, rindex,
e518068a 312 rmdir, s///, scalar, seek, seekdir, select(internal),
313 select (system call)*, setpwent, shift, sin, sleep,
314 sort, splice, split, sprintf, sqrt, srand, stat,
315 study, substr, sysread, system*, syswrite, tell,
316 telldir, tie, time, times*, tr///, uc, ucfirst, umask,
317 undef, unlink*, unpack, untie, unshift, use, utime*,
318 values, vec, wait, waitpid*, wantarray, warn, write, y///
a0d0e21e 319
320The following functions were not implemented in the VMS port,
321and calling them produces a fatal error (usually) or
322undefined behavior (rarely, we hope):
323
4e592037 324 chroot, dbmclose, dbmopen, fcntl, flock,
c07a80fd 325 getpgrp, getppid, getpriority, getgrent, getgrgid,
326 getgrnam, setgrent, endgrent, ioctl, link, lstat,
327 msgctl, msgget, msgsend, msgrcv, readlink, semctl,
328 semget, semop, setpgrp, setpriority, shmctl, shmget,
329 shmread, shmwrite, socketpair, symlink, syscall, truncate
a0d0e21e 330
331The following functions may or may not be implemented,
332depending on what type of socket support you've built into
748a9306 333your copy of Perl:
4e592037 334
a0d0e21e 335 accept, bind, connect, getpeername,
336 gethostbyname, getnetbyname, getprotobyname,
337 getservbyname, gethostbyaddr, getnetbyaddr,
338 getprotobynumber, getservbyport, gethostent,
339 getnetent, getprotoent, getservent, sethostent,
340 setnetent, setprotoent, setservent, endhostent,
341 endnetent, endprotoent, endservent, getsockname,
c07a80fd 342 getsockopt, listen, recv, select(system call)*,
343 send, setsockopt, shutdown, socket
a0d0e21e 344
55497cff 345=over 4
a0d0e21e 346
347=item File tests
348
748a9306 349The tests C<-b>, C<-B>, C<-c>, C<-C>, C<-d>, C<-e>, C<-f>,
350C<-o>, C<-M>, C<-s>, C<-S>, C<-t>, C<-T>, and C<-z> work as
351advertised. The return values for C<-r>, C<-w>, and C<-x>
352tell you whether you can actually access the file; this may
353not reflect the UIC-based file protections. Since real and
354effective UIC don't differ under VMS, C<-O>, C<-R>, C<-W>,
355and C<-X> are equivalent to C<-o>, C<-r>, C<-w>, and C<-x>.
356Similarly, several other tests, including C<-A>, C<-g>, C<-k>,
357C<-l>, C<-p>, and C<-u>, aren't particularly meaningful under
358VMS, and the values returned by these tests reflect whatever
359your CRTL C<stat()> routine does to the equivalent bits in the
360st_mode field. Finally, C<-d> returns true if passed a device
361specification without an explicit directory (e.g. C<DUA1:>), as
362well as if passed a directory.
363
4e592037 364Note: Some sites have reported problems when using the file-access
365tests (C<-r>, C<-w>, and C<-x>) on files accessed via DEC's DFS.
366Specifically, since DFS does not currently provide access to the
367extended file header of files on remote volumes, attempts to
368examine the ACL fail, and the file tests will return false,
369with C<$!> indicating that the file does not exist. You can
370use C<stat> on these files, since that checks UIC-based protection
371only, and then manually check the appropriate bits, as defined by
372your C compiler's F<stat.h>, in the mode value it returns, if you
373need an approximation of the file's protections.
374
748a9306 375=item binmode FILEHANDLE
376
1c9f8daa 377The C<binmode> operator will attempt to insure that no translation
378of carriage control occurs on input from or output to this filehandle.
379Since this involves reopening the file and then restoring its
380file position indicator, if this function returns FALSE, the
381underlying filehandle may no longer point to an open file, or may
382point to a different position in the file than before C<binmode>
383was called.
384
385Note that C<binmode> is generally not necessary when using normal
386filehandles; it is provided so that you can control I/O to existing
387record-structured files when necessary. You can also use the
388C<vmsfopen> function in the VMS::Stdio extension to gain finer
389control of I/O to files and devices with different record structures.
a0d0e21e 390
c07a80fd 391=item crypt PLAINTEXT, USER
392
393The C<crypt> operator uses the C<sys$hash_password> system
394service to generate the hashed representation of PLAINTEXT.
395If USER is a valid username, the algorithm and salt values
396are taken from that user's UAF record. If it is not, then
397the preferred algorithm and a salt of 0 are used. The
398quadword encrypted value is returned as an 8-character string.
399
400The value returned by C<crypt> may be compared against
401the encrypted password from the UAF returned by the C<getpw*>
402functions, in order to authenticate users. If you're
403going to do this, remember that the encrypted password in
404the UAF was generated using uppercase username and
405password strings; you'll have to upcase the arguments to
406C<crypt> to insure that you'll get the proper value:
407
408 sub validate_passwd {
409 my($user,$passwd) = @_;
410 my($pwdhash);
411 if ( !($pwdhash = (getpwnam($user))[1]) ||
412 $pwdhash ne crypt("\U$passwd","\U$name") ) {
413 intruder_alert($name);
414 }
415 return 1;
416 }
417
4e592037 418=item dump
419
420Rather than causing Perl to abort and dump core, the C<dump>
421operator invokes the VMS debugger. If you continue to
422execute the Perl program under the debugger, control will
423be transferred to the label specified as the argument to
424C<dump>, or, if no label was specified, back to the
425beginning of the program. All other state of the program
426(I<e.g.> values of variables, open file handles) are not
427affected by calling C<dump>.
428
748a9306 429=item exec LIST
a0d0e21e 430
748a9306 431The C<exec> operator behaves in one of two different ways.
432If called after a call to C<fork>, it will invoke the CRTL
433C<execv()> routine, passing its arguments to the subprocess
434created by C<fork> for execution. In this case, it is
435subject to all limitations that affect C<execv()>. (In
a0d0e21e 436particular, this usually means that the command executed in
437the subprocess must be an image compiled from C source code,
438and that your options for passing file descriptors and signal
439handlers to the subprocess are limited.)
440
748a9306 441If the call to C<exec> does not follow a call to C<fork>, it
442will cause Perl to exit, and to invoke the command given as
443an argument to C<exec> via C<lib$do_command>. If the argument
a0d0e21e 444begins with a '$' (other than as part of a filespec), then it
445is executed as a DCL command. Otherwise, the first token on
446the command line is treated as the filespec of an image to
447run, and an attempt is made to invoke it (using F<.Exe> and
448the process defaults to expand the filespec) and pass the
748a9306 449rest of C<exec>'s argument to it as parameters.
a0d0e21e 450
748a9306 451You can use C<exec> in both ways within the same script, as
452long as you call C<fork> and C<exec> in pairs. Perl
453keeps track of how many times C<fork> and C<exec> have been
454called, and will call the CRTL C<execv()> routine if there have
455previously been more calls to C<fork> than to C<exec>.
a0d0e21e 456
457=item fork
458
748a9306 459The C<fork> operator works in the same way as the CRTL
460C<vfork()> routine, which is quite different under VMS than
461under Unix. Specifically, while C<fork> returns 0 after it
462is called and the subprocess PID after C<exec> is called, in
a0d0e21e 463both cases the thread of execution is within the parent
464process, so there is no opportunity to perform operations in
748a9306 465the subprocess before calling C<exec>.
a0d0e21e 466
748a9306 467In general, the use of C<fork> and C<exec> to create
a0d0e21e 468subprocess is not recommended under VMS; wherever possible,
748a9306 469use the C<system> operator or piped filehandles instead.
470
471=item getpwent
c07a80fd 472
748a9306 473=item getpwnam
c07a80fd 474
748a9306 475=item getpwuid
476
477These operators obtain the information described in L<perlfunc>,
478if you have the privileges necessary to retrieve the named user's
479UAF information via C<sys$getuai>. If not, then only the C<$name>,
480C<$uid>, and C<$gid> items are returned. The C<$dir> item contains
481the login directory in VMS syntax, while the C<$comment> item
482contains the login directory in Unix syntax. The C<$gcos> item
483contains the owner field from the UAF record. The C<$quota>
484item is not used.
a0d0e21e 485
e518068a 486=item gmtime
487
488The C<gmtime> operator will function properly if you have a
489working CRTL C<gmtime()> routine, or if the logical name
490SYS$TIMEZONE_DIFFERENTIAL is defined as the number of seconds
491which must be added to UTC to yield local time. (This logical
492name is defined automatically if you are running a version of
493VMS with built-in UTC support.) If neither of these cases is
494true, a warning message is printed, and C<undef> is returned.
495
496=item kill
497
498In most cases, C<kill> kill is implemented via the CRTL's C<kill()>
499function, so it will behave according to that function's
500documentation. If you send a SIGKILL, however, the $DELPRC system
501service is is called directly. This insures that the target
502process is actually deleted, if at all possible. (The CRTL's C<kill()>
503function is presently implemented via $FORCEX, which is ignored by
504supervisor-mode images like DCL.)
505
506Also, negative signal values don't do anything special under
507VMS; they're just converted to the corresponding positive value.
508
509=item select (system call)
510
511If Perl was not built with socket support, the system call
512version of C<select> is not available at all. If socket
513support is present, then the system call version of
514C<select> functions only for file descriptors attached
515to sockets. It will not provide information about regular
516files or pipes, since the CRTL C<select()> routine does not
517provide this functionality.
518
748a9306 519=item stat EXPR
a0d0e21e 520
748a9306 521Since VMS keeps track of files according to a different scheme
522than Unix, it's not really possible to represent the file's ID
523in the C<st_dev> and C<st_ino> fields of a C<struct stat>. Perl
524tries its best, though, and the values it uses are pretty unlikely
525to be the same for two different files. We can't guarantee this,
526though, so caveat scriptor.
527
528=item system LIST
529
530The C<system> operator creates a subprocess, and passes its
a0d0e21e 531arguments to the subprocess for execution as a DCL command.
e518068a 532Since the subprocess is created directly via C<lib$spawn()>, any
748a9306 533valid DCL command string may be specified. If LIST consists
534of the empty string, C<system> spawns an interactive DCL subprocess,
535in the same fashion as typiing B<SPAWN> at the DCL prompt.
536Perl waits for the subprocess to complete before continuing
537execution in the current process.
a0d0e21e 538
1c9f8daa 539=item time
540
541The value returned by C<time> is the offset in seconds from
54201-JAN-1970 00:00:00 (just like the CRTL's times() routine), in order
543to make life easier for code coming in from the POSIX/Unix world.
544
a0d0e21e 545=item times
546
748a9306 547The array returned by the C<times> operator is divided up
548according to the same rules the CRTL C<times()> routine.
a0d0e21e 549Therefore, the "system time" elements will always be 0, since
550there is no difference between "user time" and "system" time
551under VMS, and the time accumulated by subprocess may or may
552not appear separately in the "child time" field, depending on
748a9306 553whether L<times> keeps track of subprocesses separately. Note
554especially that the VAXCRTL (at least) keeps track only of
555subprocesses spawned using L<fork> and L<exec>; it will not
556accumulate the times of suprocesses spawned via pipes, L<system>,
557or backticks.
558
16d20bd9 559=item unlink LIST
560
561C<unlink> will delete the highest version of a file only; in
562order to delete all versions, you need to say
563 1 while (unlink LIST);
564You may need to make this change to scripts written for a
565Unix system which expect that after a call to C<unlink>,
566no files with the names passed to C<unlink> will exist.
4633a7c4 567(Note: This can be changed at compile time; if you
568C<use Config> and C<$Config{'d_unlink_all_versions'}> is
569C<define>, then C<unlink> will delete all versions of a
570file on the first call.)
16d20bd9 571
572C<unlink> will delete a file if at all possible, even if it
573requires changing file protection (though it won't try to
574change the protection of the parent directory). You can tell
575whether you've got explicit delete access to a file by using the
576C<VMS::Filespec::candelete> operator. For instance, in order
577to delete only files to which you have delete access, you could
578say something like
4e592037 579
16d20bd9 580 sub safe_unlink {
581 my($file,$num);
582 foreach $file (@_) {
583 next unless VMS::Filespec::candelete($file);
584 $num += unlink $file;
585 }
586 $num;
587 }
4e592037 588
589(or you could just use C<VMS::Stdio::remove>, if you've installed
590the VMS::Stdio extension distributed with Perl). If C<unlink> has to
591change the file protection to delete the file, and you interrupt it
592in midstream, the file may be left intact, but with a changed ACL
593allowing you delete access.
16d20bd9 594
748a9306 595=item utime LIST
596
597Since ODS-2, the VMS file structure for disk files, does not keep
598track of access times, this operator changes only the modification
599time of the file (VMS revision date).
600
601=item waitpid PID,FLAGS
602
603If PID is a subprocess started by a piped L<open>, C<waitpid>
604will wait for that subprocess, and return its final
605status value. If PID is a subprocess created in some other way
606(e.g. SPAWNed before Perl was invoked), or is not a subprocess of
607the current process, C<waitpid> will check once per second whether
608the process has completed, and when it has, will return 0. (If PID
609specifies a process that isn't a subprocess of the current process,
610and you invoked Perl with the C<-w> switch, a warning will be issued.)
611
612The FLAGS argument is ignored in all cases.
a0d0e21e 613
55497cff 614=back
615
a5f75d66 616=head1 Perl variables
617
55497cff 618The following VMS-specific information applies to the indicated
619"special" Perl variables, in addition to the general information
620in L<perlvar>. Where there is a conflict, this infrmation
621takes precedence.
622
623=over 4
624
a5f75d66 625=item %ENV
626
627Reading the elements of the %ENV array returns the
628translation of the logical name specified by the key,
629according to the normal search order of access modes and
630logical name tables. If you append a semicolon to the
631logical name, followed by an integer, that integer is
632used as the translation index for the logical name,
633so that you can look up successive values for search
634list logical names. For instance, if you say
635
636 $ Define STORY once,upon,a,time,there,was
637 $ perl -e "for ($i = 0; $i <= 6; $i++) " -
740ce14c 638 _$ -e "{ print $ENV{'story;'.$i},' '}"
a5f75d66 639
640Perl will print C<ONCE UPON A TIME THERE WAS>.
641
642The %ENV keys C<home>, C<path>,C<term>, and C<user>
643return the CRTL "environment variables" of the same
644names, if these logical names are not defined. The
645key C<default> returns the current default device
646and directory specification, regardless of whether
647there is a logical name DEFAULT defined..
648
649Setting an element of %ENV defines a supervisor-mode logical
650name in the process logical name table. C<Undef>ing or
651C<delete>ing an element of %ENV deletes the equivalent user-
652mode or supervisor-mode logical name from the process logical
653name table. If you use C<undef>, the %ENV element remains
654empty. If you use C<delete>, another attempt is made at
655logical name translation after the deletion, so an inner-mode
656logical name or a name in another logical name table will
657replace the logical name just deleted. It is not possible
658at present to define a search list logical name via %ENV.
659
740ce14c 660At present, the first time you iterate over %ENV using
edc7bc49 661C<keys>, or C<values>, you will incur a time penalty as all
662logical names are read, in order to fully populate %ENV.
663Subsequent iterations will not reread logical names, so they
664won't be as slow, but they also won't reflect any changes
665to logical name tables caused by other programs. The C<each>
666operator is special: it returns each element I<already> in
667%ENV, but doesn't go out and look for more. Therefore, if
668you've previously used C<keys> or C<values>, you'll see all
669the logical names visible to your process, and if not, you'll
670see only the names you've looked up so far. (This is a
671consequence of the way C<each> is implemented now, and it
672may change in the future, so it wouldn't be a good idea
673to rely on it too much.)
740ce14c 674
a5f75d66 675In all operations on %ENV, the key string is treated as if it
676were entirely uppercase, regardless of the case actually
677specified in the Perl expression.
678
679=item $?
680
681Since VMS status values are 32 bits wide, the value of C<$?>
682is simply the final status value of the last subprocess to
683complete. This differs from the behavior of C<$?> under Unix,
684and under VMS' POSIX environment, in that the low-order 8 bits
685of C<$?> do not specify whether the process terminated normally
686or due to a signal, and you do not need to shift C<$?> 8 bits
687to the right in order to find the process' exit status.
688
689=item $!
690
691The string value of C<$!> is that returned by the CRTL's
692strerror() function, so it will include the VMS message for
693VMS-specific errors. The numeric value of C<$!> is the
694value of C<errno>, except if errno is EVMSERR, in which
695case C<$!> contains the value of vaxc$errno. Setting C<$!>
4e592037 696always sets errno to the value specified. If this value is
697EVMSERR, it also sets vaxc$errno to 4 (NONAME-F-NOMSG), so
698that the string value of C<$!> won't reflect the VMS error
699message from before C<$!> was set.
700
701=item $^E
702
703This variable provides direct access to VMS status values
704in vaxc$errno, which are often more specific than the
705generic Unix-style error messages in C<$!>. Its numeric value
706is the value of vaxc$errno, and its string value is the
707corresponding VMS message string, as retrieved by sys$getmsg().
708Setting C<$^E> sets vaxc$errno to the value specified.
709
710=item $|
711
712Setting C<$|> for an I/O stream causes data to be flushed
713all the way to disk on each write (I<i.e.> not just to
714the underlying RMS buffers for a file). In other words,
715it's equivalent to calling fflush() and fsync() from C.
a5f75d66 716
55497cff 717=back
718
748a9306 719=head1 Revision date
a0d0e21e 720
4e592037 721This document was last updated on 28-Feb-1996, for Perl 5,
e518068a 722patchlevel 2.
723
724=head1 AUTHOR
725
726Charles Bailey bailey@genetics.upenn.edu
727