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