NAME
perlvms - VMS-specific documentation for Perl
DESCRIPTION
Gathered below are notes describing details of Perl 5's
behavior on \s-1VMS\s0. They are a supplement to the regular Perl 5
documentation, so we have focussed on the ways in which Perl
5 functions differently under \s-1VMS\s0 than it does under Unix,
and on the interactions between Perl and the rest of the
operating system. We haven't tried to duplicate complete
descriptions of Perl features from the main Perl
documentation, which can be found in the [.pod]
subdirectory of the Perl distribution.
We hope these notes will save you from confusion and lost
sleep when writing Perl scripts on \s-1VMS\s0. If you find we've
missed something you think should appear here, please don't
hesitate to drop a line to vmsperl@perl.org.
Installation
Directions for building and installing Perl 5 can be found in
the file \s-1README\s0.vms in the main source directory of the
Perl distribution..
Organization of Perl Images
Core Images
During the installation process, three Perl images are produced.
Miniperl.Exe is an executable image which contains all of
the basic functionality of Perl, but cannot take advantage of
Perl extensions. It is used to generate several files needed
to build the complete Perl and various extensions. Once you've
finished installing Perl, you can delete this image.
Most of the complete Perl resides in the shareable image
PerlShr.Exe, which provides a core to which the Perl executable
image and all Perl extensions are linked. You should place this
image in Sys$Share, or define the logical name PerlShr to
translate to the full file specification of this image. It should
be world readable. (Remember that if a user has execute only access
to PerlShr, \s-1VMS\s0 will treat it as if it were a privileged shareable
image, and will therefore require all downstream shareable images to be
INSTALLed, etc.)
Finally, Perl.Exe is an executable image containing the main
entry point for Perl, as well as some initialization code. It
should be placed in a public directory, and made world executable.
In order to run Perl with command line arguments, you should
define a foreign command to invoke this image.
Perl Extensions
Perl extensions are packages which provide both \s-1XS\s0 and Perl code
to add new functionality to perl. (\s-1XS\s0 is a meta-language which
simplifies writing C code which interacts with Perl, see
perlxs for more details.) The Perl code for an
extension is treated like any other library module - it's
made available in your script through the appropriate
CWuse or CWrequire statement, and usually defines a Perl
package containing the extension.
The portion of the extension provided by the \s-1XS\s0 code may be
connected to the rest of Perl in either of two ways. In the
static configuration, the object code for the extension is
linked directly into PerlShr.Exe, and is initialized whenever
Perl is invoked. In the dynamic configuration, the extension's
machine code is placed into a separate shareable image, which is
mapped by Perl's DynaLoader when the extension is CWused or
CWrequired in your script. This allows you to maintain the
extension as a separate entity, at the cost of keeping track of the
additional shareable image. Most extensions can be set up as either
static or dynamic.
The source code for an extension usually resides in its own
directory. At least three files are generally provided:
Extshortname.xs (where Extshortname is the portion of
the extension's name following the last CW::), containing
the \s-1XS\s0 code, Extshortname.pm, the Perl library module
for the extension, and Makefile.PL, a Perl script which uses
the CWMakeMaker library modules supplied with Perl to generate
a Descrip.MMS file for the extension.
Installing static extensions
Since static extensions are incorporated directly into
PerlShr.Exe, you'll have to rebuild Perl to incorporate a
new extension. You should edit the main Descrip.MMS or Makefile
you use to build Perl, adding the extension's name to the CWext
macro, and the extension's object file to the CWextobj macro.
You'll also need to build the extension's object file, either
by adding dependencies to the main Descrip.MMS, or using a
separate Descrip.MMS for the extension. Then, rebuild
PerlShr.Exe to incorporate the new code.
Finally, you'll need to copy the extension's Perl library
module to the [.Extname] subdirectory under one
of the directories in CW@INC, where Extname is the name
of the extension, with all CW:: replaced by CW. (e.g.
the library module for extension Foo::Bar would be copied
to a [.Foo.Bar] subdirectory).
Installing dynamic extensions
In general, the distributed kit for a Perl extension includes
a file named Makefile.PL, which is a Perl program which is used
to create a Descrip.MMS file which can be used to build and
install the files required by the extension. The kit should be
unpacked into a directory tree not under the main Perl source
directory, and the procedure for building the extension is simply
$ perl Makefile.PL ! Create Descrip.MMS
$ mmk ! Build necessary files
$ mmk test ! Run test code, if supplied
$ mmk install ! Install into public Perl tree
N.B. The procedure by which extensions are built and
tested creates several levels (at least 4) under the
directory in which the extension's source files live.
For this reason if you are running a version of \s-1VMS\s0 prior
to V7.1 you shouldn't nest the source directory
too deeply in your directory structure lest you exceed \s-1RMS\s0'
maximum of 8 levels of subdirectory in a filespec. (You
can use rooted logical names to get another 8 levels of
nesting, if you can't place the files near the top of
the physical directory structure.)
\s-1VMS\s0 support for this process in the current release of Perl
is sufficient to handle most extensions. However, it does
not yet recognize extra libraries required to build shareable
images which are part of an extension, so these must be added
to the linker options file for the extension by hand. For
instance, if the \s-1PGPLOT\s0 extension to Perl requires the
\s-1PGPLOTSHR\s0.EXE shareable image in order to properly link
the Perl extension, then the line CWPGPLOTSHR/Share must
be added to the linker options file \s-1PGPLOT\s0.Opt produced
during the build process for the Perl extension.
By default, the shareable image for an extension is placed in
the [.lib.site_perl.autoArch.Extname] directory of the
installed Perl directory tree (where Arch is \s-1VMS_VAX\s0 or
\s-1VMS_AXP\s0, and Extname is the name of the extension, with
each CW:: translated to CW.). (See the MakeMaker documentation
for more details on installation options for extensions.)
However, it can be manually placed in any of several locations:
""
the [.Lib.Auto.Arch$PVersExtname] subdirectory
of one of the directories in CW@INC (where PVers
is the version of Perl you're using, as supplied in CW$],
with '.' converted to '_'), or
""
one of the directories in CW@INC, or
""
a directory which the extensions Perl library module
passes to the DynaLoader when asking it to map
the shareable image, or
""
Sys$Share or Sys$Library.
If the shareable image isn't in any of these places, you'll need
to define a logical name Extshortname, where Extshortname
is the portion of the extension's name after the last CW::, which
translates to the full file specification of the shareable image.
File specifications
Syntax
We have tried to make Perl aware of both VMS-style and Unix-
style file specifications wherever possible. You may use
either style, or both, on the command line and in scripts,
but you may not combine the two styles within a single file
specification. \s-1VMS\s0 Perl interprets Unix pathnames in much
the same way as the \s-1CRTL\s0 (e.g. the first component of
an absolute path is read as the device name for the
\s-1VMS\s0 file specification). There are a set of functions
provided in the CWVMS::Filespec package for explicit
interconversion between \s-1VMS\s0 and Unix syntax; its
documentation provides more details.
Filenames are, of course, still case-insensitive. For
consistency, most Perl routines return filespecs using
lower case letters only, regardless of the case used in
the arguments passed to them. (This is true only when
running under \s-1VMS\s0; Perl respects the case-sensitivity
of OSs like Unix.)
We've tried to minimize the dependence of Perl library
modules on Unix syntax, but you may find that some of these,
as well as some scripts written for Unix systems, will
require that you use Unix syntax, since they will assume that
'/' is the directory separator, etc. If you find instances
of this in the Perl distribution itself, please let us know,
so we can try to work around them.
Wildcard expansion
File specifications containing wildcards are allowed both on
the command line and within Perl globs (e.g. CW<*.c>). If
the wildcard filespec uses \s-1VMS\s0 syntax, the resultant
filespecs will follow \s-1VMS\s0 syntax; if a Unix-style filespec is
passed in, Unix-style filespecs will be returned.
Similar to the behavior of wildcard globbing for a Unix shell,
one can escape command line wildcards with double quotation
marks CW" around a perl program command line argument. However,
owing to the stripping of CW" characters carried out by the C
handling of argv you will need to escape a construct such as
this one (in a directory containing the files \s-1PERL\s0.C, \s-1PERL\s0.EXE,
\s-1PERL\s0.H, and \s-1PERL\s0.OBJ):
$ perl -e "print join(' ',@ARGV)" perl.*
perl.c perl.exe perl.h perl.obj
in the following triple quoted manner:
$ perl -e "print join(' ',@ARGV)" """perl.*"""
perl.*
In both the case of unquoted command line arguments or in calls
to CWglob() \s-1VMS\s0 wildcard expansion is performed. (csh-style
wildcard expansion is available if you use CWFile::Glob::glob.)
If the wildcard filespec contains a device or directory
specification, then the resultant filespecs will also contain
a device and directory; otherwise, device and directory
information are removed. VMS-style resultant filespecs will
contain a full device and directory, while Unix-style
resultant filespecs will contain only as much of a directory
path as was present in the input filespec. For example, if
your default directory is Perl_Root:[000000], the expansion
of CW[.t]*.* will yield filespecs like
perl_root:[t]base.dir, while the expansion of CWt/*/* will
yield filespecs like t/base.dir. (This is done to match
the behavior of glob expansion performed by Unix shells.)
Similarly, the resultant filespec will contain the file version
only if one was present in the input filespec.
Pipes
Input and output pipes to Perl filehandles are supported; the
file name is passed to lib$spawn() for asynchronous
execution. You should be careful to close any pipes you have
opened in a Perl script, lest you leave any orphaned
subprocesses around when Perl exits.
You may also use backticks to invoke a \s-1DCL\s0 subprocess, whose
output is used as the return value of the expression. The
string between the backticks is handled as if it were the
argument to the CWsystem operator (see below). In this case,
Perl will wait for the subprocess to complete before continuing.
The mailbox (\s-1MBX\s0) that perl can create to communicate with a pipe
defaults to a buffer size of 512. The default buffer size is
adjustable via the logical name \s-1PERL_MBX_SIZE\s0 provided that the
value falls between 128 and the \s-1SYSGEN\s0 parameter \s-1MAXBUF\s0 inclusive.
For example, to double the \s-1MBX\s0 size from the default within
a Perl program, use CW$ENV{'PERL_MBX_SIZE'} = 1024; and then
open and use pipe constructs. An alternative would be to issue
the command:
$ Define PERL_MBX_SIZE 1024
before running your wide record pipe program. A larger value may
improve performance at the expense of the \s-1BYTLM\s0 \s-1UAF\s0 quota.
PERL5LIB and PERLLIB
The \s-1PERL5LIB\s0 and \s-1PERLLIB\s0 logical names work as documented in perl,
except that the element separator is '|' instead of ':'. The
directory specifications may use either \s-1VMS\s0 or Unix syntax.
Command line
I/O redirection and backgrounding
Perl for \s-1VMS\s0 supports redirection of input and output on the
command line, using a subset of Bourne shell syntax:
""
CW<file reads stdin from CWfile,
""
CW>file writes stdout to CWfile,
""
CW>>file appends stdout to CWfile,
""
CW2>file writes stderr to CWfile,
""
CW2>>file appends stderr to CWfile, and
""
CW2>&1 redirects stderr to stdout.
In addition, output may be piped to a subprocess, using the
character '|'. Anything after this character on the command
line is passed to a subprocess for execution; the subprocess
takes the output of Perl as its input.
Finally, if the command line ends with '&', the entire
command is run in the background as an asynchronous
subprocess.
Command line switches
The following command line switches behave differently under
\s-1VMS\s0 than described in perlrun. Note also that in order
to pass uppercase switches to Perl, you need to enclose
them in double-quotes on the command line, since the \s-1CRTL\s0
downcases all unquoted strings.
"-i"
If the CW-i switch is present but no extension for a backup
copy is given, then inplace editing creates a new version of
a file; the existing copy is not deleted. (Note that if
an extension is given, an existing file is renamed to the backup
file, as is the case under other operating systems, so it does
not remain as a previous version under the original filename.)
"-S"
If the CW"-S" or CW-"S" switch is present and the script
name does not contain a directory, then Perl translates the
logical name \s-1DCL$PATH\s0 as a searchlist, using each translation
as a directory in which to look for the script. In addition,
if no file type is specified, Perl looks in each directory
for a file matching the name specified, with a blank type,
a type of .pl, and a type of .com, in that order.
"-u"
The CW-u switch causes the \s-1VMS\s0 debugger to be invoked
after the Perl program is compiled, but before it has
run. It does not create a core dump file.
Perl functions
As of the time this document was last revised, the following
Perl functions were implemented in the \s-1VMS\s0 port of Perl
(functions marked with * are discussed in more detail below):
file tests*, abs, alarm, atan, backticks*, binmode*, bless,
caller, chdir, chmod, chown, chomp, chop, chr,
close, closedir, cos, crypt*, defined, delete,
die, do, dump*, each, endpwent, eof, eval, exec*,
exists, exit, exp, fileno, getc, getlogin, getppid,
getpwent*, getpwnam*, getpwuid*, glob, gmtime*, goto,
grep, hex, import, index, int, join, keys, kill*,
last, lc, lcfirst, length, local, localtime, log, m//,
map, mkdir, my, next, no, oct, open, opendir, ord, pack,
pipe, pop, pos, print, printf, push, q//, qq//, qw//,
qx//*, quotemeta, rand, read, readdir, redo, ref, rename,
require, reset, return, reverse, rewinddir, rindex,
rmdir, s///, scalar, seek, seekdir, select(internal),
select (system call)*, setpwent, shift, sin, sleep,
sort, splice, split, sprintf, sqrt, srand, stat,
study, substr, sysread, system*, syswrite, tell,
telldir, tie, time, times*, tr///, uc, ucfirst, umask,
undef, unlink*, unpack, untie, unshift, use, utime*,
values, vec, wait, waitpid*, wantarray, warn, write, y///
The following functions were not implemented in the \s-1VMS\s0 port,
and calling them produces a fatal error (usually) or
undefined behavior (rarely, we hope):
chroot, dbmclose, dbmopen, flock, fork*,
getpgrp, getpriority, getgrent, getgrgid,
getgrnam, setgrent, endgrent, ioctl, link, lstat,
msgctl, msgget, msgsend, msgrcv, readlink, semctl,
semget, semop, setpgrp, setpriority, shmctl, shmget,
shmread, shmwrite, socketpair, symlink, syscall
The following functions are available on Perls compiled with Dec C
5.2 or greater and running \s-1VMS\s0 7.0 or greater:
truncate
The following functions are available on Perls built on \s-1VMS\s0 7.2 or
greater:
fcntl (without locking)
The following functions may or may not be implemented,
depending on what type of socket support you've built into
your copy of Perl:
accept, bind, connect, getpeername,
gethostbyname, getnetbyname, getprotobyname,
getservbyname, gethostbyaddr, getnetbyaddr,
getprotobynumber, getservbyport, gethostent,
getnetent, getprotoent, getservent, sethostent,
setnetent, setprotoent, setservent, endhostent,
endnetent, endprotoent, endservent, getsockname,
getsockopt, listen, recv, select(system call)*,
send, setsockopt, shutdown, socket
"File
The tests CW-b, CW-B, CW-c, CW-C, CW-d, CW-e, CW-f,
CW-o, CW-M, CW-s, CW-S, CW-t, CW-T, and CW-z work as
advertised. The return values for CW-r, CW-w, and CW-x
tell you whether you can actually access the file; this may
not reflect the UIC-based file protections. Since real and
effective \s-1UIC\s0 don't differ under \s-1VMS\s0, CW-O, CW-R, CW-W,
and CW-X are equivalent to CW-o, CW-r, CW-w, and CW-x.
Similarly, several other tests, including CW-A, CW-g, CW-k,
CW-l, CW-p, and CW-u, aren't particularly meaningful under
\s-1VMS\s0, and the values returned by these tests reflect whatever
your \s-1CRTL\s0 CWstat() routine does to the equivalent bits in the
st_mode field. Finally, CW-d returns true if passed a device
specification without an explicit directory (e.g. CWDUA1:), as
well as if passed a directory.
Note: Some sites have reported problems when using the file-access
tests (CW-r, CW-w, and CW-x) on files accessed via \s-1DEC\s0's \s-1DFS\s0.
Specifically, since \s-1DFS\s0 does not currently provide access to the
extended file header of files on remote volumes, attempts to
examine the \s-1ACL\s0 fail, and the file tests will return false,
with CW$! indicating that the file does not exist. You can
use CWstat on these files, since that checks UIC-based protection
only, and then manually check the appropriate bits, as defined by
your C compiler's stat.h, in the mode value it returns, if you
need an approximation of the file's protections.
"backticks"
Backticks create a subprocess, and pass the enclosed string
to it for execution as a \s-1DCL\s0 command. Since the subprocess is
created directly via CWlib$spawn(), any valid \s-1DCL\s0 command string
may be specified.
"binmode
The CWbinmode operator will attempt to insure that no translation
of carriage control occurs on input from or output to this filehandle.
Since this involves reopening the file and then restoring its
file position indicator, if this function returns \s-1FALSE\s0, the
underlying filehandle may no longer point to an open file, or may
point to a different position in the file than before CWbinmode
was called.
Note that CWbinmode is generally not necessary when using normal
filehandles; it is provided so that you can control I/O to existing
record-structured files when necessary. You can also use the
CWvmsfopen function in the VMS::Stdio extension to gain finer
control of I/O to files and devices with different record structures.
"crypt
The CWcrypt operator uses the CWsys$hash_password system
service to generate the hashed representation of \s-1PLAINTEXT\s0.
If \s-1USER\s0 is a valid username, the algorithm and salt values
are taken from that user's \s-1UAF\s0 record. If it is not, then
the preferred algorithm and a salt of 0 are used. The
quadword encrypted value is returned as an 8-character string.
The value returned by CWcrypt may be compared against
the encrypted password from the \s-1UAF\s0 returned by the CWgetpw*
functions, in order to authenticate users. If you're
going to do this, remember that the encrypted password in
the \s-1UAF\s0 was generated using uppercase username and
password strings; you'll have to upcase the arguments to
CWcrypt to insure that you'll get the proper value:
sub validate_passwd {
my($user,$passwd) = @_;
my($pwdhash);
if ( !($pwdhash = (getpwnam($user))[1]) ||
$pwdhash ne crypt("\U$passwd","\U$name") ) {
intruder_alert($name);
}
return 1;
}
"dump"
Rather than causing Perl to abort and dump core, the CWdump
operator invokes the \s-1VMS\s0 debugger. If you continue to
execute the Perl program under the debugger, control will
be transferred to the label specified as the argument to
CWdump, or, if no label was specified, back to the
beginning of the program. All other state of the program
(e.g. values of variables, open file handles) are not
affected by calling CWdump.
"exec
A call to CWexec will cause Perl to exit, and to invoke the command
given as an argument to CWexec via CWlib$do_command. If the
argument begins with '@' or '$' (other than as part of a filespec),
then it is executed as a \s-1DCL\s0 command. Otherwise, the first token on
the command line is treated as the filespec of an image to run, and
an attempt is made to invoke it (using .Exe and the process
defaults to expand the filespec) and pass the rest of CWexec's
argument to it as parameters. If the token has no file type, and
matches a file with null type, then an attempt is made to determine
whether the file is an executable image which should be invoked
using CWMCR or a text file which should be passed to \s-1DCL\s0 as a
command procedure.
"fork"
While in principle the CWfork operator could be implemented via
(and with the same rather severe limitations as) the \s-1CRTL\s0 CWvfork()
routine, and while some internal support to do just that is in
place, the implementation has never been completed, making CWfork
currently unavailable. A true kernel CWfork() is expected in a
future version of \s-1VMS\s0, and the pseudo-fork based on interpreter
threads may be available in a future version of Perl on \s-1VMS\s0 (see
perlfork). In the meantime, use CWsystem, backticks, or piped
filehandles to create subprocesses.
"getpwent"
"getpwnam"
"getpwuid"
These operators obtain the information described in perlfunc,
if you have the privileges necessary to retrieve the named user's
\s-1UAF\s0 information via CWsys$getuai. If not, then only the CW$name,
CW$uid, and CW$gid items are returned. The CW$dir item contains
the login directory in \s-1VMS\s0 syntax, while the CW$comment item
contains the login directory in Unix syntax. The CW$gcos item
contains the owner field from the \s-1UAF\s0 record. The CW$quota
item is not used.
"gmtime"
The CWgmtime operator will function properly if you have a
working \s-1CRTL\s0 CWgmtime() routine, or if the logical name
\s-1SYS$TIMEZONE_DIFFERENTIAL\s0 is defined as the number of seconds
which must be added to \s-1UTC\s0 to yield local time. (This logical
name is defined automatically if you are running a version of
\s-1VMS\s0 with built-in \s-1UTC\s0 support.) If neither of these cases is
true, a warning message is printed, and CWundef is returned.
"kill"
In most cases, CWkill is implemented via the \s-1CRTL\s0's CWkill()
function, so it will behave according to that function's
documentation. If you send a \s-1SIGKILL\s0, however, the CW$DELPRC system
service is called directly. This insures that the target
process is actually deleted, if at all possible. (The \s-1CRTL\s0's CWkill()
function is presently implemented via CW$FORCEX, which is ignored by
supervisor-mode images like \s-1DCL\s0.)
Also, negative signal values don't do anything special under
\s-1VMS\s0; they're just converted to the corresponding positive value.
"qx//"
See the entry on CWbackticks above.
"select
If Perl was not built with socket support, the system call
version of CWselect is not available at all. If socket
support is present, then the system call version of
CWselect functions only for file descriptors attached
to sockets. It will not provide information about regular
files or pipes, since the \s-1CRTL\s0 CWselect() routine does not
provide this functionality.
"stat
Since \s-1VMS\s0 keeps track of files according to a different scheme
than Unix, it's not really possible to represent the file's \s-1ID\s0
in the CWst_dev and CWst_ino fields of a CWstruct stat. Perl
tries its best, though, and the values it uses are pretty unlikely
to be the same for two different files. We can't guarantee this,
though, so caveat scriptor.
"system
The CWsystem operator creates a subprocess, and passes its
arguments to the subprocess for execution as a \s-1DCL\s0 command.
Since the subprocess is created directly via CWlib$spawn(), any
valid \s-1DCL\s0 command string may be specified. If the string begins with
'@', it is treated as a \s-1DCL\s0 command unconditionally. Otherwise, if
the first token contains a character used as a delimiter in file
specification (e.g. CW: or CW]), an attempt is made to expand it
using a default type of .Exe and the process defaults, and if
successful, the resulting file is invoked via CWMCR. This allows you
to invoke an image directly simply by passing the file specification
to CWsystem, a common Unixish idiom. If the token has no file type,
and matches a file with null type, then an attempt is made to
determine whether the file is an executable image which should be
invoked using CWMCR or a text file which should be passed to \s-1DCL\s0
as a command procedure.
If \s-1LIST\s0 consists of the empty string, CWsystem spawns an
interactive \s-1DCL\s0 subprocess, in the same fashion as typing
\s-1SPAWN\s0 at the \s-1DCL\s0 prompt.
Perl waits for the subprocess to complete before continuing
execution in the current process. As described in perlfunc,
the return value of CWsystem is a fake status which follows
\s-1POSIX\s0 semantics unless the pragma CWuse vmsish 'status' is in
effect; see the description of CW$? in this document for more
detail.
"time"
The value returned by CWtime is the offset in seconds from
01-JAN-1970 00:00:00 (just like the \s-1CRTL\s0's times() routine), in order
to make life easier for code coming in from the POSIX/Unix world.
"times"
The array returned by the CWtimes operator is divided up
according to the same rules the \s-1CRTL\s0 CWtimes() routine.
Therefore, the system time elements will always be 0, since
there is no difference between user time and system time
under \s-1VMS\s0, and the time accumulated by a subprocess may or may
not appear separately in the child time field, depending on
whether times keeps track of subprocesses separately. Note
especially that the \s-1VAXCRTL\s0 (at least) keeps track only of
subprocesses spawned using fork and exec; it will not
accumulate the times of subprocesses spawned via pipes, system,
or backticks.
"unlink
CWunlink will delete the highest version of a file only; in
order to delete all versions, you need to say
1 while unlink LIST;
You may need to make this change to scripts written for a
Unix system which expect that after a call to CWunlink,
no files with the names passed to CWunlink will exist.
(Note: This can be changed at compile time; if you
CWuse Config and CW$Config{'d_unlink_all_versions'} is
CWdefine, then CWunlink will delete all versions of a
file on the first call.)
CWunlink will delete a file if at all possible, even if it
requires changing file protection (though it won't try to
change the protection of the parent directory). You can tell
whether you've got explicit delete access to a file by using the
CWVMS::Filespec::candelete operator. For instance, in order
to delete only files to which you have delete access, you could
say something like
sub safe_unlink {
my($file,$num);
foreach $file (@_) {
next unless VMS::Filespec::candelete($file);
$num += unlink $file;
}
$num;
}
(or you could just use CWVMS::Stdio::remove, if you've installed
the VMS::Stdio extension distributed with Perl). If CWunlink has to
change the file protection to delete the file, and you interrupt it
in midstream, the file may be left intact, but with a changed \s-1ACL\s0
allowing you delete access.
"utime
Since \s-1ODS-2\s0, the \s-1VMS\s0 file structure for disk files, does not keep
track of access times, this operator changes only the modification
time of the file (\s-1VMS\s0 revision date).
"waitpid
If \s-1PID\s0 is a subprocess started by a piped CWopen() (see open),
CWwaitpid will wait for that subprocess, and return its final status
value in CW$?. If \s-1PID\s0 is a subprocess created in some other way (e.g.
SPAWNed before Perl was invoked), CWwaitpid will simply check once per
second whether the process has completed, and return when it has. (If
\s-1PID\s0 specifies a process that isn't a subprocess of the current process,
and you invoked Perl with the CW-w switch, a warning will be issued.)
Returns \s-1PID\s0 on success, -1 on error. The \s-1FLAGS\s0 argument is ignored
in all cases.
Perl variables
The following VMS-specific information applies to the indicated
special Perl variables, in addition to the general information
in perlvar. Where there is a conflict, this information
takes precedence.
"%ENV"
The operation of the CW%ENV
array depends on the translation
of the logical name
\s-1PERL_ENV_TABLES\s0. If defined, it should
be a search list, each element of which specifies a location
for CW%ENV
elements. If you tell Perl to read or set the
element CW$ENV{
nameCW}, then Perl uses the translations of
\s-1PERL_ENV_TABLES\s0 as follows:
"\s-1CRTL_ENV\s0"
This string tells Perl to consult the \s-1CRTL\s0's internal CWenviron
array of key-value pairs, using name as the key. In most cases,
this contains only a few keys, but if Perl was invoked via the C
CWexec[lv]e() function, as is the case for \s-1CGI\s0 processing by some
\s-1HTTP\s0 servers, then the CWenviron array may have been populated by
the calling program.
"CLISYM_[\s-1LOCAL\s0]"
A string beginning with CWCLISYM_tells Perl to consult the \s-1CLI\s0's
symbol tables, using name as the name of the symbol. When reading
an element of CW%ENV, the local symbol table is scanned first, followed
by the global symbol table.. The characters following CWCLISYM_ are
significant when an element of CW%ENV is set or deleted: if the
complete string is CWCLISYM_LOCAL, the change is made in the local
symbol table; otherwise the global symbol table is changed.
"Any
If an element of
\s-1PERL_ENV_TABLES\s0 translates to any other string,
that string is used as the name of a logical name table, which is
consulted using
name as the logical name. The normal search
order of access modes is used.
\s-1PERL_ENV_TABLES\s0 is translated once when Perl starts up; any changes
you make while Perl is running do not affect the behavior of CW%ENV.
If \s-1PERL_ENV_TABLES\s0 is not defined, then Perl defaults to consulting
first the logical name tables specified by \s-1LNM$FILE_DEV\s0, and then
the \s-1CRTL\s0 CWenviron array.
In all operations on CW%ENV, the key string is treated as if it
were entirely uppercase, regardless of the case actually
specified in the Perl expression.
When an element of CW%ENV is read, the locations to which
\s-1PERL_ENV_TABLES\s0 points are checked in order, and the value
obtained from the first successful lookup is returned. If the
name of the CW%ENV element contains a semi-colon, it and
any characters after it are removed. These are ignored when
the \s-1CRTL\s0 CWenviron array or a \s-1CLI\s0 symbol table is consulted.
However, the name is looked up in a logical name table, the
suffix after the semi-colon is treated as the translation index
to be used for the lookup. This lets you look up successive values
for search list logical names. For instance, if you say
$ Define STORY once,upon,a,time,there,was
$ perl -e "for ($i = 0; $i <= 6; $i++) " -
_$ -e "{ print $ENV{'story;'.$i},' '}"
Perl will print CWONCE UPON A TIME THERE WAS, assuming, of course,
that \s-1PERL_ENV_TABLES\s0 is set up so that the logical name CWstory
is found, rather than a \s-1CLI\s0 symbol or \s-1CRTL\s0 CWenviron element with
the same name.
When an element of CW%ENV is set to a defined string, the
corresponding definition is made in the location to which the
first translation of \s-1PERL_ENV_TABLES\s0 points. If this causes a
logical name to be created, it is defined in supervisor mode.
(The same is done if an existing logical name was defined in
executive or kernel mode; an existing user or supervisor mode
logical name is reset to the new value.) If the value is an empty
string, the logical name's translation is defined as a single \s-1NUL\s0
(\s-1ASCII\s0 00) character, since a logical name cannot translate to a
zero-length string. (This restriction does not apply to \s-1CLI\s0 symbols
or \s-1CRTL\s0 CWenviron values; they are set to the empty string.)
An element of the \s-1CRTL\s0 CWenviron array can be set only if your
copy of Perl knows about the \s-1CRTL\s0's CWsetenv() function. (This is
present only in some versions of the \s-1DECCRTL\s0; check CW$Config{d_setenv}
to see whether your copy of Perl was built with a \s-1CRTL\s0 that has this
function.)
When an element of CW%ENV is set to CWundef,
the element is looked up as if it were being read, and if it is
found, it is deleted. (An item deleted from the \s-1CRTL\s0 CWenviron
array is set to the empty string; this can only be done if your
copy of Perl knows about the \s-1CRTL\s0 CWsetenv() function.) Using
CWdelete to remove an element from CW%ENV has a similar effect,
but after the element is deleted, another attempt is made to
look up the element, so an inner-mode logical name or a name in
another location will replace the logical name just deleted.
In either case, only the first value found searching \s-1PERL_ENV_TABLES\s0
is altered. It is not possible at present to define a search list
logical name via CW%ENV.
The element CW$ENV{DEFAULT} is special: when read, it returns
Perl's current default device and directory, and when set, it
resets them, regardless of the definition of \s-1PERL_ENV_TABLES\s0.
It cannot be cleared or deleted; attempts to do so are silently
ignored.
Note that if you want to pass on any elements of the
C-local environ array to a subprocess which isn't
started by fork/exec, or isn't running a C program, you
can promote them to logical names in the current
process, which will then be inherited by all subprocesses,
by saying
foreach my $key (qw[C-local keys you want promoted]) {
my $temp = $ENV{$key}; # read from C-local array
$ENV{$key} = $temp; # and define as logical name
}
(You can't just say CW$ENV{$key} = $ENV{$key}, since the
Perl optimizer is smart enough to elide the expression.)
Don't try to clear CW%ENV by saying CW%ENV = ();, it will throw
a fatal error. This is equivalent to doing the following from \s-1DCL:\s0
DELETE/LOGICAL *
You can imagine how bad things would be if, for example, the \s-1SYS$MANAGER\s0
or \s-1SYS$SYSTEM\s0 logicals were deleted.
At present, the first time you iterate over CW%ENV using
CWkeys, or CWvalues, you will incur a time penalty as all
logical names are read, in order to fully populate CW%ENV.
Subsequent iterations will not reread logical names, so they
won't be as slow, but they also won't reflect any changes
to logical name tables caused by other programs.
You do need to be careful with the logicals representing process-permanent
files, such as CWSYS$INPUT and CWSYS$OUTPUT. The translations for these
logicals are prepended with a two-byte binary value (0x1B 0x00) that needs to be
stripped off if you want to use it. (In previous versions of Perl it wasn't
possible to get the values of these logicals, as the null byte acted as an
end-of-string marker)
"$!"
The string value of CW$! is that returned by the \s-1CRTL\s0's
strerror() function, so it will include the \s-1VMS\s0 message for
VMS-specific errors. The numeric value of CW$! is the
value of CWerrno, except if errno is \s-1EVMSERR\s0, in which
case CW$! contains the value of vaxc$errno. Setting CW$!
always sets errno to the value specified. If this value is
\s-1EVMSERR\s0, it also sets vaxc$errno to 4 (\s-1NONAME-F-NOMSG\s0), so
that the string value of CW$! won't reflect the \s-1VMS\s0 error
message from before CW$! was set.
"$^E"
This variable provides direct access to \s-1VMS\s0 status values
in vaxc$errno, which are often more specific than the
generic Unix-style error messages in CW$!. Its numeric value
is the value of vaxc$errno, and its string value is the
corresponding \s-1VMS\s0 message string, as retrieved by sys$getmsg().
Setting CW$^E sets vaxc$errno to the value specified.
"$?"
The status value returned in CW$? is synthesized from the
actual exit status of the subprocess in a way that approximates
\s-1POSIX\s0 wait(5) semantics, in order to allow Perl programs to
portably test for successful completion of subprocesses. The
low order 8 bits of CW$? are always 0 under \s-1VMS\s0, since the
termination status of a process may or may not have been
generated by an exception. The next 8 bits are derived from
the severity portion of the subprocess' exit status: if the
severity was success or informational, these bits are all 0;
if the severity was warning, they contain a value of 1; if the
severity was error or fatal error, they contain the actual
severity bits, which turns out to be a value of 2 for error
and 4 for fatal error.
As a result, CW$? will always be zero if the subprocess' exit
status indicated successful completion, and non-zero if a
warning or error occurred. Conversely, when setting CW$? in
an \s-1END\s0 block, an attempt is made to convert the \s-1POSIX\s0 value
into a native status intelligible to the operating system upon
exiting Perl. What this boils down to is that setting CW$?
to zero results in the generic success value \s-1SS$_NORMAL\s0, and
setting CW$? to a non-zero value results in the generic
failure status \s-1SS$_ABORT\s0. See also exit in perlport.
The pragma CWuse vmsish 'status' makes CW$? reflect the actual
\s-1VMS\s0 exit status instead of the default emulation of \s-1POSIX\s0 status
described above. This pragma also disables the conversion of
non-zero values to \s-1SS$_ABORT\s0 when setting CW$? in an \s-1END\s0
block (but zero will still be converted to \s-1SS$_NORMAL\s0).
"$|"
Setting CW$| for an I/O stream causes data to be flushed
all the way to disk on each write (i.e. not just to
the underlying \s-1RMS\s0 buffers for a file). In other words,
it's equivalent to calling fflush() and fsync() from C.
Standard modules with VMS-specific differences
SDBM_File
SDBM_File works properly on \s-1VMS\s0. It has, however, one minor
difference. The database directory file created has a .sdbm_dir
extension rather than a .dir extension. .dir files are \s-1VMS\s0 filesystem
directory files, and using them for other purposes could cause unacceptable
problems.
Revision date
This document was last updated on 01-May-2002, for Perl 5,
patchlevel 8.
AUTHOR
Charles Bailey bailey@cor.newman.upenn.edu
Craig Berry craigberry@mac.com
Dan Sugalski dan@sidhe.org