Pack Patch (was Re: 5.002 - pack/unpack does not do "I" right)
[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:
241 <F<file> reads stdin from F<file>,
242 >F<file> writes stdout to F<file>,
243 >>F<file> appends stdout to F<file>,
748a9306 244 2>F<file> writes stderr to F<file>, and
a0d0e21e 245 2>>F<file> appends stderr to F<file>.
246
247In addition, output may be piped to a subprocess, using the
248character '|'. Anything after this character on the command
249line is passed to a subprocess for execution; the subprocess
748a9306 250takes the output of Perl as its input.
a0d0e21e 251
252Finally, if the command line ends with '&', the entire
253command is run in the background as an asynchronous
254subprocess.
255
4e592037 256=head2 Command line switches
a0d0e21e 257
4e592037 258The following command line switches behave differently under
259VMS than described in L<perlrun>. Note also that in order
260to pass uppercase switches to Perl, you need to enclose
261them in double-quotes on the command line, since the CRTL
262downcases all unquoted strings.
a0d0e21e 263
4e592037 264=item -S
a0d0e21e 265
4e592037 266If the C<-S> switch is present I<and> the script name does
267not contain a directory, then Perl translates the logical
268name DCL$PATH as a searchlist, using each translation as
269a directory in which to look for the script. In addition,
270if no file type is specified, Perl looks in each directory
271for a file matching the name specified, with a blank type,
272a type of F<.pl>, and a type of F<.com>, in that order.
a0d0e21e 273
4e592037 274=item -u
748a9306 275
4e592037 276The C<-u> switch causes the VMS debugger to be invoked
277after the Perl program is compiled, but before it has
278run. It does not create a core dump file.
748a9306 279
748a9306 280=head1 Perl functions
a0d0e21e 281
282As of the time this document was last revised, the following
748a9306 283Perl functions were implemented in the VMS port of Perl
a0d0e21e 284(functions marked with * are discussed in more detail below):
285
286 file tests*, abs, alarm, atan, binmode*, bless,
287 caller, chdir, chmod, chown, chomp, chop, chr,
c07a80fd 288 close, closedir, cos, crypt*, defined, delete,
4e592037 289 die, do, dump*, each, endpwent, eof, eval, exec*,
290 exists, exit, exp, fileno, fork*, getc, getlogin,
291 getpwent*, getpwnam*, getpwuid*, glob, gmtime*, goto,
292 grep, hex, import, index, int, join, keys, kill*,
293 last, lc, lcfirst, length, local, localtime, log, m//,
294 map, mkdir, my, next, no, oct, open, opendir, ord, pack,
c07a80fd 295 pipe, pop, pos, print, printf, push, q//, qq//, qw//,
296 qx//, quotemeta, rand, read, readdir, redo, ref, rename,
a0d0e21e 297 require, reset, return, reverse, rewinddir, rindex,
e518068a 298 rmdir, s///, scalar, seek, seekdir, select(internal),
299 select (system call)*, setpwent, shift, sin, sleep,
300 sort, splice, split, sprintf, sqrt, srand, stat,
301 study, substr, sysread, system*, syswrite, tell,
302 telldir, tie, time, times*, tr///, uc, ucfirst, umask,
303 undef, unlink*, unpack, untie, unshift, use, utime*,
304 values, vec, wait, waitpid*, wantarray, warn, write, y///
a0d0e21e 305
306The following functions were not implemented in the VMS port,
307and calling them produces a fatal error (usually) or
308undefined behavior (rarely, we hope):
309
4e592037 310 chroot, dbmclose, dbmopen, fcntl, flock,
c07a80fd 311 getpgrp, getppid, getpriority, getgrent, getgrgid,
312 getgrnam, setgrent, endgrent, ioctl, link, lstat,
313 msgctl, msgget, msgsend, msgrcv, readlink, semctl,
314 semget, semop, setpgrp, setpriority, shmctl, shmget,
315 shmread, shmwrite, socketpair, symlink, syscall, truncate
a0d0e21e 316
317The following functions may or may not be implemented,
318depending on what type of socket support you've built into
748a9306 319your copy of Perl:
4e592037 320
a0d0e21e 321 accept, bind, connect, getpeername,
322 gethostbyname, getnetbyname, getprotobyname,
323 getservbyname, gethostbyaddr, getnetbyaddr,
324 getprotobynumber, getservbyport, gethostent,
325 getnetent, getprotoent, getservent, sethostent,
326 setnetent, setprotoent, setservent, endhostent,
327 endnetent, endprotoent, endservent, getsockname,
c07a80fd 328 getsockopt, listen, recv, select(system call)*,
329 send, setsockopt, shutdown, socket
a0d0e21e 330
331
332=item File tests
333
748a9306 334The tests C<-b>, C<-B>, C<-c>, C<-C>, C<-d>, C<-e>, C<-f>,
335C<-o>, C<-M>, C<-s>, C<-S>, C<-t>, C<-T>, and C<-z> work as
336advertised. The return values for C<-r>, C<-w>, and C<-x>
337tell you whether you can actually access the file; this may
338not reflect the UIC-based file protections. Since real and
339effective UIC don't differ under VMS, C<-O>, C<-R>, C<-W>,
340and C<-X> are equivalent to C<-o>, C<-r>, C<-w>, and C<-x>.
341Similarly, several other tests, including C<-A>, C<-g>, C<-k>,
342C<-l>, C<-p>, and C<-u>, aren't particularly meaningful under
343VMS, and the values returned by these tests reflect whatever
344your CRTL C<stat()> routine does to the equivalent bits in the
345st_mode field. Finally, C<-d> returns true if passed a device
346specification without an explicit directory (e.g. C<DUA1:>), as
347well as if passed a directory.
348
4e592037 349Note: Some sites have reported problems when using the file-access
350tests (C<-r>, C<-w>, and C<-x>) on files accessed via DEC's DFS.
351Specifically, since DFS does not currently provide access to the
352extended file header of files on remote volumes, attempts to
353examine the ACL fail, and the file tests will return false,
354with C<$!> indicating that the file does not exist. You can
355use C<stat> on these files, since that checks UIC-based protection
356only, and then manually check the appropriate bits, as defined by
357your C compiler's F<stat.h>, in the mode value it returns, if you
358need an approximation of the file's protections.
359
748a9306 360=item binmode FILEHANDLE
361
1c9f8daa 362The C<binmode> operator will attempt to insure that no translation
363of carriage control occurs on input from or output to this filehandle.
364Since this involves reopening the file and then restoring its
365file position indicator, if this function returns FALSE, the
366underlying filehandle may no longer point to an open file, or may
367point to a different position in the file than before C<binmode>
368was called.
369
370Note that C<binmode> is generally not necessary when using normal
371filehandles; it is provided so that you can control I/O to existing
372record-structured files when necessary. You can also use the
373C<vmsfopen> function in the VMS::Stdio extension to gain finer
374control of I/O to files and devices with different record structures.
a0d0e21e 375
c07a80fd 376=item crypt PLAINTEXT, USER
377
378The C<crypt> operator uses the C<sys$hash_password> system
379service to generate the hashed representation of PLAINTEXT.
380If USER is a valid username, the algorithm and salt values
381are taken from that user's UAF record. If it is not, then
382the preferred algorithm and a salt of 0 are used. The
383quadword encrypted value is returned as an 8-character string.
384
385The value returned by C<crypt> may be compared against
386the encrypted password from the UAF returned by the C<getpw*>
387functions, in order to authenticate users. If you're
388going to do this, remember that the encrypted password in
389the UAF was generated using uppercase username and
390password strings; you'll have to upcase the arguments to
391C<crypt> to insure that you'll get the proper value:
392
393 sub validate_passwd {
394 my($user,$passwd) = @_;
395 my($pwdhash);
396 if ( !($pwdhash = (getpwnam($user))[1]) ||
397 $pwdhash ne crypt("\U$passwd","\U$name") ) {
398 intruder_alert($name);
399 }
400 return 1;
401 }
402
4e592037 403=item dump
404
405Rather than causing Perl to abort and dump core, the C<dump>
406operator invokes the VMS debugger. If you continue to
407execute the Perl program under the debugger, control will
408be transferred to the label specified as the argument to
409C<dump>, or, if no label was specified, back to the
410beginning of the program. All other state of the program
411(I<e.g.> values of variables, open file handles) are not
412affected by calling C<dump>.
413
748a9306 414=item exec LIST
a0d0e21e 415
748a9306 416The C<exec> operator behaves in one of two different ways.
417If called after a call to C<fork>, it will invoke the CRTL
418C<execv()> routine, passing its arguments to the subprocess
419created by C<fork> for execution. In this case, it is
420subject to all limitations that affect C<execv()>. (In
a0d0e21e 421particular, this usually means that the command executed in
422the subprocess must be an image compiled from C source code,
423and that your options for passing file descriptors and signal
424handlers to the subprocess are limited.)
425
748a9306 426If the call to C<exec> does not follow a call to C<fork>, it
427will cause Perl to exit, and to invoke the command given as
428an argument to C<exec> via C<lib$do_command>. If the argument
a0d0e21e 429begins with a '$' (other than as part of a filespec), then it
430is executed as a DCL command. Otherwise, the first token on
431the command line is treated as the filespec of an image to
432run, and an attempt is made to invoke it (using F<.Exe> and
433the process defaults to expand the filespec) and pass the
748a9306 434rest of C<exec>'s argument to it as parameters.
a0d0e21e 435
748a9306 436You can use C<exec> in both ways within the same script, as
437long as you call C<fork> and C<exec> in pairs. Perl
438keeps track of how many times C<fork> and C<exec> have been
439called, and will call the CRTL C<execv()> routine if there have
440previously been more calls to C<fork> than to C<exec>.
a0d0e21e 441
442=item fork
443
748a9306 444The C<fork> operator works in the same way as the CRTL
445C<vfork()> routine, which is quite different under VMS than
446under Unix. Specifically, while C<fork> returns 0 after it
447is called and the subprocess PID after C<exec> is called, in
a0d0e21e 448both cases the thread of execution is within the parent
449process, so there is no opportunity to perform operations in
748a9306 450the subprocess before calling C<exec>.
a0d0e21e 451
748a9306 452In general, the use of C<fork> and C<exec> to create
a0d0e21e 453subprocess is not recommended under VMS; wherever possible,
748a9306 454use the C<system> operator or piped filehandles instead.
455
456=item getpwent
c07a80fd 457
748a9306 458=item getpwnam
c07a80fd 459
748a9306 460=item getpwuid
461
462These operators obtain the information described in L<perlfunc>,
463if you have the privileges necessary to retrieve the named user's
464UAF information via C<sys$getuai>. If not, then only the C<$name>,
465C<$uid>, and C<$gid> items are returned. The C<$dir> item contains
466the login directory in VMS syntax, while the C<$comment> item
467contains the login directory in Unix syntax. The C<$gcos> item
468contains the owner field from the UAF record. The C<$quota>
469item is not used.
a0d0e21e 470
e518068a 471=item gmtime
472
473The C<gmtime> operator will function properly if you have a
474working CRTL C<gmtime()> routine, or if the logical name
475SYS$TIMEZONE_DIFFERENTIAL is defined as the number of seconds
476which must be added to UTC to yield local time. (This logical
477name is defined automatically if you are running a version of
478VMS with built-in UTC support.) If neither of these cases is
479true, a warning message is printed, and C<undef> is returned.
480
481=item kill
482
483In most cases, C<kill> kill is implemented via the CRTL's C<kill()>
484function, so it will behave according to that function's
485documentation. If you send a SIGKILL, however, the $DELPRC system
486service is is called directly. This insures that the target
487process is actually deleted, if at all possible. (The CRTL's C<kill()>
488function is presently implemented via $FORCEX, which is ignored by
489supervisor-mode images like DCL.)
490
491Also, negative signal values don't do anything special under
492VMS; they're just converted to the corresponding positive value.
493
494=item select (system call)
495
496If Perl was not built with socket support, the system call
497version of C<select> is not available at all. If socket
498support is present, then the system call version of
499C<select> functions only for file descriptors attached
500to sockets. It will not provide information about regular
501files or pipes, since the CRTL C<select()> routine does not
502provide this functionality.
503
748a9306 504=item stat EXPR
a0d0e21e 505
748a9306 506Since VMS keeps track of files according to a different scheme
507than Unix, it's not really possible to represent the file's ID
508in the C<st_dev> and C<st_ino> fields of a C<struct stat>. Perl
509tries its best, though, and the values it uses are pretty unlikely
510to be the same for two different files. We can't guarantee this,
511though, so caveat scriptor.
512
513=item system LIST
514
515The C<system> operator creates a subprocess, and passes its
a0d0e21e 516arguments to the subprocess for execution as a DCL command.
e518068a 517Since the subprocess is created directly via C<lib$spawn()>, any
748a9306 518valid DCL command string may be specified. If LIST consists
519of the empty string, C<system> spawns an interactive DCL subprocess,
520in the same fashion as typiing B<SPAWN> at the DCL prompt.
521Perl waits for the subprocess to complete before continuing
522execution in the current process.
a0d0e21e 523
1c9f8daa 524=item time
525
526The value returned by C<time> is the offset in seconds from
52701-JAN-1970 00:00:00 (just like the CRTL's times() routine), in order
528to make life easier for code coming in from the POSIX/Unix world.
529
a0d0e21e 530=item times
531
748a9306 532The array returned by the C<times> operator is divided up
533according to the same rules the CRTL C<times()> routine.
a0d0e21e 534Therefore, the "system time" elements will always be 0, since
535there is no difference between "user time" and "system" time
536under VMS, and the time accumulated by subprocess may or may
537not appear separately in the "child time" field, depending on
748a9306 538whether L<times> keeps track of subprocesses separately. Note
539especially that the VAXCRTL (at least) keeps track only of
540subprocesses spawned using L<fork> and L<exec>; it will not
541accumulate the times of suprocesses spawned via pipes, L<system>,
542or backticks.
543
16d20bd9 544=item unlink LIST
545
546C<unlink> will delete the highest version of a file only; in
547order to delete all versions, you need to say
548 1 while (unlink LIST);
549You may need to make this change to scripts written for a
550Unix system which expect that after a call to C<unlink>,
551no files with the names passed to C<unlink> will exist.
4633a7c4 552(Note: This can be changed at compile time; if you
553C<use Config> and C<$Config{'d_unlink_all_versions'}> is
554C<define>, then C<unlink> will delete all versions of a
555file on the first call.)
16d20bd9 556
557C<unlink> will delete a file if at all possible, even if it
558requires changing file protection (though it won't try to
559change the protection of the parent directory). You can tell
560whether you've got explicit delete access to a file by using the
561C<VMS::Filespec::candelete> operator. For instance, in order
562to delete only files to which you have delete access, you could
563say something like
4e592037 564
16d20bd9 565 sub safe_unlink {
566 my($file,$num);
567 foreach $file (@_) {
568 next unless VMS::Filespec::candelete($file);
569 $num += unlink $file;
570 }
571 $num;
572 }
4e592037 573
574(or you could just use C<VMS::Stdio::remove>, if you've installed
575the VMS::Stdio extension distributed with Perl). If C<unlink> has to
576change the file protection to delete the file, and you interrupt it
577in midstream, the file may be left intact, but with a changed ACL
578allowing you delete access.
16d20bd9 579
748a9306 580=item utime LIST
581
582Since ODS-2, the VMS file structure for disk files, does not keep
583track of access times, this operator changes only the modification
584time of the file (VMS revision date).
585
586=item waitpid PID,FLAGS
587
588If PID is a subprocess started by a piped L<open>, C<waitpid>
589will wait for that subprocess, and return its final
590status value. If PID is a subprocess created in some other way
591(e.g. SPAWNed before Perl was invoked), or is not a subprocess of
592the current process, C<waitpid> will check once per second whether
593the process has completed, and when it has, will return 0. (If PID
594specifies a process that isn't a subprocess of the current process,
595and you invoked Perl with the C<-w> switch, a warning will be issued.)
596
597The FLAGS argument is ignored in all cases.
a0d0e21e 598
a5f75d66 599=head1 Perl variables
600
601=item %ENV
602
603Reading the elements of the %ENV array returns the
604translation of the logical name specified by the key,
605according to the normal search order of access modes and
606logical name tables. If you append a semicolon to the
607logical name, followed by an integer, that integer is
608used as the translation index for the logical name,
609so that you can look up successive values for search
610list logical names. For instance, if you say
611
612 $ Define STORY once,upon,a,time,there,was
613 $ perl -e "for ($i = 0; $i <= 6; $i++) " -
740ce14c 614 _$ -e "{ print $ENV{'story;'.$i},' '}"
a5f75d66 615
616Perl will print C<ONCE UPON A TIME THERE WAS>.
617
618The %ENV keys C<home>, C<path>,C<term>, and C<user>
619return the CRTL "environment variables" of the same
620names, if these logical names are not defined. The
621key C<default> returns the current default device
622and directory specification, regardless of whether
623there is a logical name DEFAULT defined..
624
625Setting an element of %ENV defines a supervisor-mode logical
626name in the process logical name table. C<Undef>ing or
627C<delete>ing an element of %ENV deletes the equivalent user-
628mode or supervisor-mode logical name from the process logical
629name table. If you use C<undef>, the %ENV element remains
630empty. If you use C<delete>, another attempt is made at
631logical name translation after the deletion, so an inner-mode
632logical name or a name in another logical name table will
633replace the logical name just deleted. It is not possible
634at present to define a search list logical name via %ENV.
635
740ce14c 636At present, the first time you iterate over %ENV using
637C<keys>, C<values>, or C<each>, you will incur a time
638penalty as all logical names are read, in order to fully
639populate %ENV. Subsequent iterations will not reread
640logical names, so they won't be as slow, but they also
641won't reflect any changes to logical name tables caused
642by other programs.
643
a5f75d66 644In all operations on %ENV, the key string is treated as if it
645were entirely uppercase, regardless of the case actually
646specified in the Perl expression.
647
648=item $?
649
650Since VMS status values are 32 bits wide, the value of C<$?>
651is simply the final status value of the last subprocess to
652complete. This differs from the behavior of C<$?> under Unix,
653and under VMS' POSIX environment, in that the low-order 8 bits
654of C<$?> do not specify whether the process terminated normally
655or due to a signal, and you do not need to shift C<$?> 8 bits
656to the right in order to find the process' exit status.
657
658=item $!
659
660The string value of C<$!> is that returned by the CRTL's
661strerror() function, so it will include the VMS message for
662VMS-specific errors. The numeric value of C<$!> is the
663value of C<errno>, except if errno is EVMSERR, in which
664case C<$!> contains the value of vaxc$errno. Setting C<$!>
4e592037 665always sets errno to the value specified. If this value is
666EVMSERR, it also sets vaxc$errno to 4 (NONAME-F-NOMSG), so
667that the string value of C<$!> won't reflect the VMS error
668message from before C<$!> was set.
669
670=item $^E
671
672This variable provides direct access to VMS status values
673in vaxc$errno, which are often more specific than the
674generic Unix-style error messages in C<$!>. Its numeric value
675is the value of vaxc$errno, and its string value is the
676corresponding VMS message string, as retrieved by sys$getmsg().
677Setting C<$^E> sets vaxc$errno to the value specified.
678
679=item $|
680
681Setting C<$|> for an I/O stream causes data to be flushed
682all the way to disk on each write (I<i.e.> not just to
683the underlying RMS buffers for a file). In other words,
684it's equivalent to calling fflush() and fsync() from C.
a5f75d66 685
748a9306 686=head1 Revision date
a0d0e21e 687
4e592037 688This document was last updated on 28-Feb-1996, for Perl 5,
e518068a 689patchlevel 2.
690
691=head1 AUTHOR
692
693Charles Bailey bailey@genetics.upenn.edu
694