| 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 [email protected].
|
|---|
| 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<perlxs> 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 if you are running a version of VMS prior
|
|---|
| 125 | to V7.1 you shouldn't nest the source directory
|
|---|
| 126 | too deeply in your directory structure lest you exceed RMS'
|
|---|
| 127 | maximum of 8 levels of subdirectory in a filespec. (You
|
|---|
| 128 | can use rooted logical names to get another 8 levels of
|
|---|
| 129 | nesting, if you can't place the files near the top of
|
|---|
| 130 | the physical directory structure.)
|
|---|
| 131 |
|
|---|
| 132 | VMS support for this process in the current release of Perl
|
|---|
| 133 | is sufficient to handle most extensions. However, it does
|
|---|
| 134 | not yet recognize extra libraries required to build shareable
|
|---|
| 135 | images which are part of an extension, so these must be added
|
|---|
| 136 | to the linker options file for the extension by hand. For
|
|---|
| 137 | instance, if the F<PGPLOT> extension to Perl requires the
|
|---|
| 138 | F<PGPLOTSHR.EXE> shareable image in order to properly link
|
|---|
| 139 | the Perl extension, then the line C<PGPLOTSHR/Share> must
|
|---|
| 140 | be added to the linker options file F<PGPLOT.Opt> produced
|
|---|
| 141 | during the build process for the Perl extension.
|
|---|
| 142 |
|
|---|
| 143 | By default, the shareable image for an extension is placed in
|
|---|
| 144 | the F<[.lib.site_perl.auto>I<Arch>.I<Extname>F<]> directory of the
|
|---|
| 145 | installed Perl directory tree (where I<Arch> is F<VMS_VAX> or
|
|---|
| 146 | F<VMS_AXP>, and I<Extname> is the name of the extension, with
|
|---|
| 147 | each C<::> translated to C<.>). (See the MakeMaker documentation
|
|---|
| 148 | for more details on installation options for extensions.)
|
|---|
| 149 | However, it can be manually placed in any of several locations:
|
|---|
| 150 |
|
|---|
| 151 | =over 4
|
|---|
| 152 |
|
|---|
| 153 | =item *
|
|---|
| 154 |
|
|---|
| 155 | the F<[.Lib.Auto.>I<Arch>I<$PVers>I<Extname>F<]> subdirectory
|
|---|
| 156 | of one of the directories in C<@INC> (where I<PVers>
|
|---|
| 157 | is the version of Perl you're using, as supplied in C<$]>,
|
|---|
| 158 | with '.' converted to '_'), or
|
|---|
| 159 |
|
|---|
| 160 | =item *
|
|---|
| 161 |
|
|---|
| 162 | one of the directories in C<@INC>, or
|
|---|
| 163 |
|
|---|
| 164 | =item *
|
|---|
| 165 |
|
|---|
| 166 | a directory which the extensions Perl library module
|
|---|
| 167 | passes to the DynaLoader when asking it to map
|
|---|
| 168 | the shareable image, or
|
|---|
| 169 |
|
|---|
| 170 | =item *
|
|---|
| 171 |
|
|---|
| 172 | F<Sys$Share> or F<Sys$Library>.
|
|---|
| 173 |
|
|---|
| 174 | =back
|
|---|
| 175 |
|
|---|
| 176 | If the shareable image isn't in any of these places, you'll need
|
|---|
| 177 | to define a logical name I<Extshortname>, where I<Extshortname>
|
|---|
| 178 | is the portion of the extension's name after the last C<::>, which
|
|---|
| 179 | translates to the full file specification of the shareable image.
|
|---|
| 180 |
|
|---|
| 181 | =head1 File specifications
|
|---|
| 182 |
|
|---|
| 183 | =head2 Syntax
|
|---|
| 184 |
|
|---|
| 185 | We have tried to make Perl aware of both VMS-style and Unix-
|
|---|
| 186 | style file specifications wherever possible. You may use
|
|---|
| 187 | either style, or both, on the command line and in scripts,
|
|---|
| 188 | but you may not combine the two styles within a single file
|
|---|
| 189 | specification. VMS Perl interprets Unix pathnames in much
|
|---|
| 190 | the same way as the CRTL (I<e.g.> the first component of
|
|---|
| 191 | an absolute path is read as the device name for the
|
|---|
| 192 | VMS file specification). There are a set of functions
|
|---|
| 193 | provided in the C<VMS::Filespec> package for explicit
|
|---|
| 194 | interconversion between VMS and Unix syntax; its
|
|---|
| 195 | documentation provides more details.
|
|---|
| 196 |
|
|---|
| 197 | Filenames are, of course, still case-insensitive. For
|
|---|
| 198 | consistency, most Perl routines return filespecs using
|
|---|
| 199 | lower case letters only, regardless of the case used in
|
|---|
| 200 | the arguments passed to them. (This is true only when
|
|---|
| 201 | running under VMS; Perl respects the case-sensitivity
|
|---|
| 202 | of OSs like Unix.)
|
|---|
| 203 |
|
|---|
| 204 | We've tried to minimize the dependence of Perl library
|
|---|
| 205 | modules on Unix syntax, but you may find that some of these,
|
|---|
| 206 | as well as some scripts written for Unix systems, will
|
|---|
| 207 | require that you use Unix syntax, since they will assume that
|
|---|
| 208 | '/' is the directory separator, I<etc.> If you find instances
|
|---|
| 209 | of this in the Perl distribution itself, please let us know,
|
|---|
| 210 | so we can try to work around them.
|
|---|
| 211 |
|
|---|
| 212 | =head2 Wildcard expansion
|
|---|
| 213 |
|
|---|
| 214 | File specifications containing wildcards are allowed both on
|
|---|
| 215 | the command line and within Perl globs (e.g. C<E<lt>*.cE<gt>>). If
|
|---|
| 216 | the wildcard filespec uses VMS syntax, the resultant
|
|---|
| 217 | filespecs will follow VMS syntax; if a Unix-style filespec is
|
|---|
| 218 | passed in, Unix-style filespecs will be returned.
|
|---|
| 219 | Similar to the behavior of wildcard globbing for a Unix shell,
|
|---|
| 220 | one can escape command line wildcards with double quotation
|
|---|
| 221 | marks C<"> around a perl program command line argument. However,
|
|---|
| 222 | owing to the stripping of C<"> characters carried out by the C
|
|---|
| 223 | handling of argv you will need to escape a construct such as
|
|---|
| 224 | this one (in a directory containing the files F<PERL.C>, F<PERL.EXE>,
|
|---|
| 225 | F<PERL.H>, and F<PERL.OBJ>):
|
|---|
| 226 |
|
|---|
| 227 | $ perl -e "print join(' ',@ARGV)" perl.*
|
|---|
| 228 | perl.c perl.exe perl.h perl.obj
|
|---|
| 229 |
|
|---|
| 230 | in the following triple quoted manner:
|
|---|
| 231 |
|
|---|
| 232 | $ perl -e "print join(' ',@ARGV)" """perl.*"""
|
|---|
| 233 | perl.*
|
|---|
| 234 |
|
|---|
| 235 | In both the case of unquoted command line arguments or in calls
|
|---|
| 236 | to C<glob()> VMS wildcard expansion is performed. (csh-style
|
|---|
| 237 | wildcard expansion is available if you use C<File::Glob::glob>.)
|
|---|
| 238 | If the wildcard filespec contains a device or directory
|
|---|
| 239 | specification, then the resultant filespecs will also contain
|
|---|
| 240 | a device and directory; otherwise, device and directory
|
|---|
| 241 | information are removed. VMS-style resultant filespecs will
|
|---|
| 242 | contain a full device and directory, while Unix-style
|
|---|
| 243 | resultant filespecs will contain only as much of a directory
|
|---|
| 244 | path as was present in the input filespec. For example, if
|
|---|
| 245 | your default directory is Perl_Root:[000000], the expansion
|
|---|
| 246 | of C<[.t]*.*> will yield filespecs like
|
|---|
| 247 | "perl_root:[t]base.dir", while the expansion of C<t/*/*> will
|
|---|
| 248 | yield filespecs like "t/base.dir". (This is done to match
|
|---|
| 249 | the behavior of glob expansion performed by Unix shells.)
|
|---|
| 250 |
|
|---|
| 251 | Similarly, the resultant filespec will contain the file version
|
|---|
| 252 | only if one was present in the input filespec.
|
|---|
| 253 |
|
|---|
| 254 | =head2 Pipes
|
|---|
| 255 |
|
|---|
| 256 | Input and output pipes to Perl filehandles are supported; the
|
|---|
| 257 | "file name" is passed to lib$spawn() for asynchronous
|
|---|
| 258 | execution. You should be careful to close any pipes you have
|
|---|
| 259 | opened in a Perl script, lest you leave any "orphaned"
|
|---|
| 260 | subprocesses around when Perl exits.
|
|---|
| 261 |
|
|---|
| 262 | You may also use backticks to invoke a DCL subprocess, whose
|
|---|
| 263 | output is used as the return value of the expression. The
|
|---|
| 264 | string between the backticks is handled as if it were the
|
|---|
| 265 | argument to the C<system> operator (see below). In this case,
|
|---|
| 266 | Perl will wait for the subprocess to complete before continuing.
|
|---|
| 267 |
|
|---|
| 268 | The mailbox (MBX) that perl can create to communicate with a pipe
|
|---|
| 269 | defaults to a buffer size of 512. The default buffer size is
|
|---|
| 270 | adjustable via the logical name PERL_MBX_SIZE provided that the
|
|---|
| 271 | value falls between 128 and the SYSGEN parameter MAXBUF inclusive.
|
|---|
| 272 | For example, to double the MBX size from the default within
|
|---|
| 273 | a Perl program, use C<$ENV{'PERL_MBX_SIZE'} = 1024;> and then
|
|---|
| 274 | open and use pipe constructs. An alternative would be to issue
|
|---|
| 275 | the command:
|
|---|
| 276 |
|
|---|
| 277 | $ Define PERL_MBX_SIZE 1024
|
|---|
| 278 |
|
|---|
| 279 | before running your wide record pipe program. A larger value may
|
|---|
| 280 | improve performance at the expense of the BYTLM UAF quota.
|
|---|
| 281 |
|
|---|
| 282 | =head1 PERL5LIB and PERLLIB
|
|---|
| 283 |
|
|---|
| 284 | The PERL5LIB and PERLLIB logical names work as documented in L<perl>,
|
|---|
| 285 | except that the element separator is '|' instead of ':'. The
|
|---|
| 286 | directory specifications may use either VMS or Unix syntax.
|
|---|
| 287 |
|
|---|
| 288 | =head1 Command line
|
|---|
| 289 |
|
|---|
| 290 | =head2 I/O redirection and backgrounding
|
|---|
| 291 |
|
|---|
| 292 | Perl for VMS supports redirection of input and output on the
|
|---|
| 293 | command line, using a subset of Bourne shell syntax:
|
|---|
| 294 |
|
|---|
| 295 | =over 4
|
|---|
| 296 |
|
|---|
| 297 | =item *
|
|---|
| 298 |
|
|---|
| 299 | C<E<lt>file> reads stdin from C<file>,
|
|---|
| 300 |
|
|---|
| 301 | =item *
|
|---|
| 302 |
|
|---|
| 303 | C<E<gt>file> writes stdout to C<file>,
|
|---|
| 304 |
|
|---|
| 305 | =item *
|
|---|
| 306 |
|
|---|
| 307 | C<E<gt>E<gt>file> appends stdout to C<file>,
|
|---|
| 308 |
|
|---|
| 309 | =item *
|
|---|
| 310 |
|
|---|
| 311 | C<2E<gt>file> writes stderr to C<file>,
|
|---|
| 312 |
|
|---|
| 313 | =item *
|
|---|
| 314 |
|
|---|
| 315 | C<2E<gt>E<gt>file> appends stderr to C<file>, and
|
|---|
| 316 |
|
|---|
| 317 | =item *
|
|---|
| 318 |
|
|---|
| 319 | C<< 2>&1 >> redirects stderr to stdout.
|
|---|
| 320 |
|
|---|
| 321 | =back
|
|---|
| 322 |
|
|---|
| 323 | In addition, output may be piped to a subprocess, using the
|
|---|
| 324 | character '|'. Anything after this character on the command
|
|---|
| 325 | line is passed to a subprocess for execution; the subprocess
|
|---|
| 326 | takes the output of Perl as its input.
|
|---|
| 327 |
|
|---|
| 328 | Finally, if the command line ends with '&', the entire
|
|---|
| 329 | command is run in the background as an asynchronous
|
|---|
| 330 | subprocess.
|
|---|
| 331 |
|
|---|
| 332 | =head2 Command line switches
|
|---|
| 333 |
|
|---|
| 334 | The following command line switches behave differently under
|
|---|
| 335 | VMS than described in L<perlrun>. Note also that in order
|
|---|
| 336 | to pass uppercase switches to Perl, you need to enclose
|
|---|
| 337 | them in double-quotes on the command line, since the CRTL
|
|---|
| 338 | downcases all unquoted strings.
|
|---|
| 339 |
|
|---|
| 340 | =over 4
|
|---|
| 341 |
|
|---|
| 342 | =item -i
|
|---|
| 343 |
|
|---|
| 344 | If the C<-i> switch is present but no extension for a backup
|
|---|
| 345 | copy is given, then inplace editing creates a new version of
|
|---|
| 346 | a file; the existing copy is not deleted. (Note that if
|
|---|
| 347 | an extension is given, an existing file is renamed to the backup
|
|---|
| 348 | file, as is the case under other operating systems, so it does
|
|---|
| 349 | not remain as a previous version under the original filename.)
|
|---|
| 350 |
|
|---|
| 351 | =item -S
|
|---|
| 352 |
|
|---|
| 353 | If the C<"-S"> or C<-"S"> switch is present I<and> the script
|
|---|
| 354 | name does not contain a directory, then Perl translates the
|
|---|
| 355 | logical name DCL$PATH as a searchlist, using each translation
|
|---|
| 356 | as a directory in which to look for the script. In addition,
|
|---|
| 357 | if no file type is specified, Perl looks in each directory
|
|---|
| 358 | for a file matching the name specified, with a blank type,
|
|---|
| 359 | a type of F<.pl>, and a type of F<.com>, in that order.
|
|---|
| 360 |
|
|---|
| 361 | =item -u
|
|---|
| 362 |
|
|---|
| 363 | The C<-u> switch causes the VMS debugger to be invoked
|
|---|
| 364 | after the Perl program is compiled, but before it has
|
|---|
| 365 | run. It does not create a core dump file.
|
|---|
| 366 |
|
|---|
| 367 | =back
|
|---|
| 368 |
|
|---|
| 369 | =head1 Perl functions
|
|---|
| 370 |
|
|---|
| 371 | As of the time this document was last revised, the following
|
|---|
| 372 | Perl functions were implemented in the VMS port of Perl
|
|---|
| 373 | (functions marked with * are discussed in more detail below):
|
|---|
| 374 |
|
|---|
| 375 | file tests*, abs, alarm, atan, backticks*, binmode*, bless,
|
|---|
| 376 | caller, chdir, chmod, chown, chomp, chop, chr,
|
|---|
| 377 | close, closedir, cos, crypt*, defined, delete,
|
|---|
| 378 | die, do, dump*, each, endpwent, eof, eval, exec*,
|
|---|
| 379 | exists, exit, exp, fileno, getc, getlogin, getppid,
|
|---|
| 380 | getpwent*, getpwnam*, getpwuid*, glob, gmtime*, goto,
|
|---|
| 381 | grep, hex, import, index, int, join, keys, kill*,
|
|---|
| 382 | last, lc, lcfirst, length, local, localtime, log, m//,
|
|---|
| 383 | map, mkdir, my, next, no, oct, open, opendir, ord, pack,
|
|---|
| 384 | pipe, pop, pos, print, printf, push, q//, qq//, qw//,
|
|---|
| 385 | qx//*, quotemeta, rand, read, readdir, redo, ref, rename,
|
|---|
| 386 | require, reset, return, reverse, rewinddir, rindex,
|
|---|
| 387 | rmdir, s///, scalar, seek, seekdir, select(internal),
|
|---|
| 388 | select (system call)*, setpwent, shift, sin, sleep,
|
|---|
| 389 | sort, splice, split, sprintf, sqrt, srand, stat,
|
|---|
| 390 | study, substr, sysread, system*, syswrite, tell,
|
|---|
| 391 | telldir, tie, time, times*, tr///, uc, ucfirst, umask,
|
|---|
| 392 | undef, unlink*, unpack, untie, unshift, use, utime*,
|
|---|
| 393 | values, vec, wait, waitpid*, wantarray, warn, write, y///
|
|---|
| 394 |
|
|---|
| 395 | The following functions were not implemented in the VMS port,
|
|---|
| 396 | and calling them produces a fatal error (usually) or
|
|---|
| 397 | undefined behavior (rarely, we hope):
|
|---|
| 398 |
|
|---|
| 399 | chroot, dbmclose, dbmopen, flock, fork*,
|
|---|
| 400 | getpgrp, getpriority, getgrent, getgrgid,
|
|---|
| 401 | getgrnam, setgrent, endgrent, ioctl, link, lstat,
|
|---|
| 402 | msgctl, msgget, msgsend, msgrcv, readlink, semctl,
|
|---|
| 403 | semget, semop, setpgrp, setpriority, shmctl, shmget,
|
|---|
| 404 | shmread, shmwrite, socketpair, symlink, syscall
|
|---|
| 405 |
|
|---|
| 406 | The following functions are available on Perls compiled with Dec C
|
|---|
| 407 | 5.2 or greater and running VMS 7.0 or greater:
|
|---|
| 408 |
|
|---|
| 409 | truncate
|
|---|
| 410 |
|
|---|
| 411 | The following functions are available on Perls built on VMS 7.2 or
|
|---|
| 412 | greater:
|
|---|
| 413 |
|
|---|
| 414 | fcntl (without locking)
|
|---|
| 415 |
|
|---|
| 416 | The following functions may or may not be implemented,
|
|---|
| 417 | depending on what type of socket support you've built into
|
|---|
| 418 | your copy of Perl:
|
|---|
| 419 |
|
|---|
| 420 | accept, bind, connect, getpeername,
|
|---|
| 421 | gethostbyname, getnetbyname, getprotobyname,
|
|---|
| 422 | getservbyname, gethostbyaddr, getnetbyaddr,
|
|---|
| 423 | getprotobynumber, getservbyport, gethostent,
|
|---|
| 424 | getnetent, getprotoent, getservent, sethostent,
|
|---|
| 425 | setnetent, setprotoent, setservent, endhostent,
|
|---|
| 426 | endnetent, endprotoent, endservent, getsockname,
|
|---|
| 427 | getsockopt, listen, recv, select(system call)*,
|
|---|
| 428 | send, setsockopt, shutdown, socket
|
|---|
| 429 |
|
|---|
| 430 | =over 4
|
|---|
| 431 |
|
|---|
| 432 | =item File tests
|
|---|
| 433 |
|
|---|
| 434 | The tests C<-b>, C<-B>, C<-c>, C<-C>, C<-d>, C<-e>, C<-f>,
|
|---|
| 435 | C<-o>, C<-M>, C<-s>, C<-S>, C<-t>, C<-T>, and C<-z> work as
|
|---|
| 436 | advertised. The return values for C<-r>, C<-w>, and C<-x>
|
|---|
| 437 | tell you whether you can actually access the file; this may
|
|---|
| 438 | not reflect the UIC-based file protections. Since real and
|
|---|
| 439 | effective UIC don't differ under VMS, C<-O>, C<-R>, C<-W>,
|
|---|
| 440 | and C<-X> are equivalent to C<-o>, C<-r>, C<-w>, and C<-x>.
|
|---|
| 441 | Similarly, several other tests, including C<-A>, C<-g>, C<-k>,
|
|---|
| 442 | C<-l>, C<-p>, and C<-u>, aren't particularly meaningful under
|
|---|
| 443 | VMS, and the values returned by these tests reflect whatever
|
|---|
| 444 | your CRTL C<stat()> routine does to the equivalent bits in the
|
|---|
| 445 | st_mode field. Finally, C<-d> returns true if passed a device
|
|---|
| 446 | specification without an explicit directory (e.g. C<DUA1:>), as
|
|---|
| 447 | well as if passed a directory.
|
|---|
| 448 |
|
|---|
| 449 | Note: Some sites have reported problems when using the file-access
|
|---|
| 450 | tests (C<-r>, C<-w>, and C<-x>) on files accessed via DEC's DFS.
|
|---|
| 451 | Specifically, since DFS does not currently provide access to the
|
|---|
| 452 | extended file header of files on remote volumes, attempts to
|
|---|
| 453 | examine the ACL fail, and the file tests will return false,
|
|---|
| 454 | with C<$!> indicating that the file does not exist. You can
|
|---|
| 455 | use C<stat> on these files, since that checks UIC-based protection
|
|---|
| 456 | only, and then manually check the appropriate bits, as defined by
|
|---|
| 457 | your C compiler's F<stat.h>, in the mode value it returns, if you
|
|---|
| 458 | need an approximation of the file's protections.
|
|---|
| 459 |
|
|---|
| 460 | =item backticks
|
|---|
| 461 |
|
|---|
| 462 | Backticks create a subprocess, and pass the enclosed string
|
|---|
| 463 | to it for execution as a DCL command. Since the subprocess is
|
|---|
| 464 | created directly via C<lib$spawn()>, any valid DCL command string
|
|---|
| 465 | may be specified.
|
|---|
| 466 |
|
|---|
| 467 | =item binmode FILEHANDLE
|
|---|
| 468 |
|
|---|
| 469 | The C<binmode> operator will attempt to insure that no translation
|
|---|
| 470 | of carriage control occurs on input from or output to this filehandle.
|
|---|
| 471 | Since this involves reopening the file and then restoring its
|
|---|
| 472 | file position indicator, if this function returns FALSE, the
|
|---|
| 473 | underlying filehandle may no longer point to an open file, or may
|
|---|
| 474 | point to a different position in the file than before C<binmode>
|
|---|
| 475 | was called.
|
|---|
| 476 |
|
|---|
| 477 | Note that C<binmode> is generally not necessary when using normal
|
|---|
| 478 | filehandles; it is provided so that you can control I/O to existing
|
|---|
| 479 | record-structured files when necessary. You can also use the
|
|---|
| 480 | C<vmsfopen> function in the VMS::Stdio extension to gain finer
|
|---|
| 481 | control of I/O to files and devices with different record structures.
|
|---|
| 482 |
|
|---|
| 483 | =item crypt PLAINTEXT, USER
|
|---|
| 484 |
|
|---|
| 485 | The C<crypt> operator uses the C<sys$hash_password> system
|
|---|
| 486 | service to generate the hashed representation of PLAINTEXT.
|
|---|
| 487 | If USER is a valid username, the algorithm and salt values
|
|---|
| 488 | are taken from that user's UAF record. If it is not, then
|
|---|
| 489 | the preferred algorithm and a salt of 0 are used. The
|
|---|
| 490 | quadword encrypted value is returned as an 8-character string.
|
|---|
| 491 |
|
|---|
| 492 | The value returned by C<crypt> may be compared against
|
|---|
| 493 | the encrypted password from the UAF returned by the C<getpw*>
|
|---|
| 494 | functions, in order to authenticate users. If you're
|
|---|
| 495 | going to do this, remember that the encrypted password in
|
|---|
| 496 | the UAF was generated using uppercase username and
|
|---|
| 497 | password strings; you'll have to upcase the arguments to
|
|---|
| 498 | C<crypt> to insure that you'll get the proper value:
|
|---|
| 499 |
|
|---|
| 500 | sub validate_passwd {
|
|---|
| 501 | my($user,$passwd) = @_;
|
|---|
| 502 | my($pwdhash);
|
|---|
| 503 | if ( !($pwdhash = (getpwnam($user))[1]) ||
|
|---|
| 504 | $pwdhash ne crypt("\U$passwd","\U$name") ) {
|
|---|
| 505 | intruder_alert($name);
|
|---|
| 506 | }
|
|---|
| 507 | return 1;
|
|---|
| 508 | }
|
|---|
| 509 |
|
|---|
| 510 | =item dump
|
|---|
| 511 |
|
|---|
| 512 | Rather than causing Perl to abort and dump core, the C<dump>
|
|---|
| 513 | operator invokes the VMS debugger. If you continue to
|
|---|
| 514 | execute the Perl program under the debugger, control will
|
|---|
| 515 | be transferred to the label specified as the argument to
|
|---|
| 516 | C<dump>, or, if no label was specified, back to the
|
|---|
| 517 | beginning of the program. All other state of the program
|
|---|
| 518 | (I<e.g.> values of variables, open file handles) are not
|
|---|
| 519 | affected by calling C<dump>.
|
|---|
| 520 |
|
|---|
| 521 | =item exec LIST
|
|---|
| 522 |
|
|---|
| 523 | A call to C<exec> will cause Perl to exit, and to invoke the command
|
|---|
| 524 | given as an argument to C<exec> via C<lib$do_command>. If the
|
|---|
| 525 | argument begins with '@' or '$' (other than as part of a filespec),
|
|---|
| 526 | then it is executed as a DCL command. Otherwise, the first token on
|
|---|
| 527 | the command line is treated as the filespec of an image to run, and
|
|---|
| 528 | an attempt is made to invoke it (using F<.Exe> and the process
|
|---|
| 529 | defaults to expand the filespec) and pass the rest of C<exec>'s
|
|---|
| 530 | argument to it as parameters. If the token has no file type, and
|
|---|
| 531 | matches a file with null type, then an attempt is made to determine
|
|---|
| 532 | whether the file is an executable image which should be invoked
|
|---|
| 533 | using C<MCR> or a text file which should be passed to DCL as a
|
|---|
| 534 | command procedure.
|
|---|
| 535 |
|
|---|
| 536 | =item fork
|
|---|
| 537 |
|
|---|
| 538 | While in principle the C<fork> operator could be implemented via
|
|---|
| 539 | (and with the same rather severe limitations as) the CRTL C<vfork()>
|
|---|
| 540 | routine, and while some internal support to do just that is in
|
|---|
| 541 | place, the implementation has never been completed, making C<fork>
|
|---|
| 542 | currently unavailable. A true kernel C<fork()> is expected in a
|
|---|
| 543 | future version of VMS, and the pseudo-fork based on interpreter
|
|---|
| 544 | threads may be available in a future version of Perl on VMS (see
|
|---|
| 545 | L<perlfork>). In the meantime, use C<system>, backticks, or piped
|
|---|
| 546 | filehandles to create subprocesses.
|
|---|
| 547 |
|
|---|
| 548 | =item getpwent
|
|---|
| 549 |
|
|---|
| 550 | =item getpwnam
|
|---|
| 551 |
|
|---|
| 552 | =item getpwuid
|
|---|
| 553 |
|
|---|
| 554 | These operators obtain the information described in L<perlfunc>,
|
|---|
| 555 | if you have the privileges necessary to retrieve the named user's
|
|---|
| 556 | UAF information via C<sys$getuai>. If not, then only the C<$name>,
|
|---|
| 557 | C<$uid>, and C<$gid> items are returned. The C<$dir> item contains
|
|---|
| 558 | the login directory in VMS syntax, while the C<$comment> item
|
|---|
| 559 | contains the login directory in Unix syntax. The C<$gcos> item
|
|---|
| 560 | contains the owner field from the UAF record. The C<$quota>
|
|---|
| 561 | item is not used.
|
|---|
| 562 |
|
|---|
| 563 | =item gmtime
|
|---|
| 564 |
|
|---|
| 565 | The C<gmtime> operator will function properly if you have a
|
|---|
| 566 | working CRTL C<gmtime()> routine, or if the logical name
|
|---|
| 567 | SYS$TIMEZONE_DIFFERENTIAL is defined as the number of seconds
|
|---|
| 568 | which must be added to UTC to yield local time. (This logical
|
|---|
| 569 | name is defined automatically if you are running a version of
|
|---|
| 570 | VMS with built-in UTC support.) If neither of these cases is
|
|---|
| 571 | true, a warning message is printed, and C<undef> is returned.
|
|---|
| 572 |
|
|---|
| 573 | =item kill
|
|---|
| 574 |
|
|---|
| 575 | In most cases, C<kill> is implemented via the CRTL's C<kill()>
|
|---|
| 576 | function, so it will behave according to that function's
|
|---|
| 577 | documentation. If you send a SIGKILL, however, the $DELPRC system
|
|---|
| 578 | service is called directly. This insures that the target
|
|---|
| 579 | process is actually deleted, if at all possible. (The CRTL's C<kill()>
|
|---|
| 580 | function is presently implemented via $FORCEX, which is ignored by
|
|---|
| 581 | supervisor-mode images like DCL.)
|
|---|
| 582 |
|
|---|
| 583 | Also, negative signal values don't do anything special under
|
|---|
| 584 | VMS; they're just converted to the corresponding positive value.
|
|---|
| 585 |
|
|---|
| 586 | =item qx//
|
|---|
| 587 |
|
|---|
| 588 | See the entry on C<backticks> above.
|
|---|
| 589 |
|
|---|
| 590 | =item select (system call)
|
|---|
| 591 |
|
|---|
| 592 | If Perl was not built with socket support, the system call
|
|---|
| 593 | version of C<select> is not available at all. If socket
|
|---|
| 594 | support is present, then the system call version of
|
|---|
| 595 | C<select> functions only for file descriptors attached
|
|---|
| 596 | to sockets. It will not provide information about regular
|
|---|
| 597 | files or pipes, since the CRTL C<select()> routine does not
|
|---|
| 598 | provide this functionality.
|
|---|
| 599 |
|
|---|
| 600 | =item stat EXPR
|
|---|
| 601 |
|
|---|
| 602 | Since VMS keeps track of files according to a different scheme
|
|---|
| 603 | than Unix, it's not really possible to represent the file's ID
|
|---|
| 604 | in the C<st_dev> and C<st_ino> fields of a C<struct stat>. Perl
|
|---|
| 605 | tries its best, though, and the values it uses are pretty unlikely
|
|---|
| 606 | to be the same for two different files. We can't guarantee this,
|
|---|
| 607 | though, so caveat scriptor.
|
|---|
| 608 |
|
|---|
| 609 | =item system LIST
|
|---|
| 610 |
|
|---|
| 611 | The C<system> operator creates a subprocess, and passes its
|
|---|
| 612 | arguments to the subprocess for execution as a DCL command.
|
|---|
| 613 | Since the subprocess is created directly via C<lib$spawn()>, any
|
|---|
| 614 | valid DCL command string may be specified. If the string begins with
|
|---|
| 615 | '@', it is treated as a DCL command unconditionally. Otherwise, if
|
|---|
| 616 | the first token contains a character used as a delimiter in file
|
|---|
| 617 | specification (e.g. C<:> or C<]>), an attempt is made to expand it
|
|---|
| 618 | using a default type of F<.Exe> and the process defaults, and if
|
|---|
| 619 | successful, the resulting file is invoked via C<MCR>. This allows you
|
|---|
| 620 | to invoke an image directly simply by passing the file specification
|
|---|
| 621 | to C<system>, a common Unixish idiom. If the token has no file type,
|
|---|
| 622 | and matches a file with null type, then an attempt is made to
|
|---|
| 623 | determine whether the file is an executable image which should be
|
|---|
| 624 | invoked using C<MCR> or a text file which should be passed to DCL
|
|---|
| 625 | as a command procedure.
|
|---|
| 626 |
|
|---|
| 627 | If LIST consists of the empty string, C<system> spawns an
|
|---|
| 628 | interactive DCL subprocess, in the same fashion as typing
|
|---|
| 629 | B<SPAWN> at the DCL prompt.
|
|---|
| 630 |
|
|---|
| 631 | Perl waits for the subprocess to complete before continuing
|
|---|
| 632 | execution in the current process. As described in L<perlfunc>,
|
|---|
| 633 | the return value of C<system> is a fake "status" which follows
|
|---|
| 634 | POSIX semantics unless the pragma C<use vmsish 'status'> is in
|
|---|
| 635 | effect; see the description of C<$?> in this document for more
|
|---|
| 636 | detail.
|
|---|
| 637 |
|
|---|
| 638 | =item time
|
|---|
| 639 |
|
|---|
| 640 | The value returned by C<time> is the offset in seconds from
|
|---|
| 641 | 01-JAN-1970 00:00:00 (just like the CRTL's times() routine), in order
|
|---|
| 642 | to make life easier for code coming in from the POSIX/Unix world.
|
|---|
| 643 |
|
|---|
| 644 | =item times
|
|---|
| 645 |
|
|---|
| 646 | The array returned by the C<times> operator is divided up
|
|---|
| 647 | according to the same rules the CRTL C<times()> routine.
|
|---|
| 648 | Therefore, the "system time" elements will always be 0, since
|
|---|
| 649 | there is no difference between "user time" and "system" time
|
|---|
| 650 | under VMS, and the time accumulated by a subprocess may or may
|
|---|
| 651 | not appear separately in the "child time" field, depending on
|
|---|
| 652 | whether L<times> keeps track of subprocesses separately. Note
|
|---|
| 653 | especially that the VAXCRTL (at least) keeps track only of
|
|---|
| 654 | subprocesses spawned using L<fork> and L<exec>; it will not
|
|---|
| 655 | accumulate the times of subprocesses spawned via pipes, L<system>,
|
|---|
| 656 | or backticks.
|
|---|
| 657 |
|
|---|
| 658 | =item unlink LIST
|
|---|
| 659 |
|
|---|
| 660 | C<unlink> will delete the highest version of a file only; in
|
|---|
| 661 | order to delete all versions, you need to say
|
|---|
| 662 |
|
|---|
| 663 | 1 while unlink LIST;
|
|---|
| 664 |
|
|---|
| 665 | You may need to make this change to scripts written for a
|
|---|
| 666 | Unix system which expect that after a call to C<unlink>,
|
|---|
| 667 | no files with the names passed to C<unlink> will exist.
|
|---|
| 668 | (Note: This can be changed at compile time; if you
|
|---|
| 669 | C<use Config> and C<$Config{'d_unlink_all_versions'}> is
|
|---|
| 670 | C<define>, then C<unlink> will delete all versions of a
|
|---|
| 671 | file on the first call.)
|
|---|
| 672 |
|
|---|
| 673 | C<unlink> will delete a file if at all possible, even if it
|
|---|
| 674 | requires changing file protection (though it won't try to
|
|---|
| 675 | change the protection of the parent directory). You can tell
|
|---|
| 676 | whether you've got explicit delete access to a file by using the
|
|---|
| 677 | C<VMS::Filespec::candelete> operator. For instance, in order
|
|---|
| 678 | to delete only files to which you have delete access, you could
|
|---|
| 679 | say something like
|
|---|
| 680 |
|
|---|
| 681 | sub safe_unlink {
|
|---|
| 682 | my($file,$num);
|
|---|
| 683 | foreach $file (@_) {
|
|---|
| 684 | next unless VMS::Filespec::candelete($file);
|
|---|
| 685 | $num += unlink $file;
|
|---|
| 686 | }
|
|---|
| 687 | $num;
|
|---|
| 688 | }
|
|---|
| 689 |
|
|---|
| 690 | (or you could just use C<VMS::Stdio::remove>, if you've installed
|
|---|
| 691 | the VMS::Stdio extension distributed with Perl). If C<unlink> has to
|
|---|
| 692 | change the file protection to delete the file, and you interrupt it
|
|---|
| 693 | in midstream, the file may be left intact, but with a changed ACL
|
|---|
| 694 | allowing you delete access.
|
|---|
| 695 |
|
|---|
| 696 | =item utime LIST
|
|---|
| 697 |
|
|---|
|
|---|