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