Commit | Line | Data |
---|---|---|
e518068a | 1 | =head1 NAME |
2 | ||
3 | perlvms - VMS-specific documentation for Perl | |
4 | ||
5 | =head1 DESCRIPTION | |
a0d0e21e | 6 | |
748a9306 LW |
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 | |
a0d0e21e | 12 | operating system. We haven't tried to duplicate complete |
748a9306 | 13 | descriptions of Perl features from the main Perl |
a0d0e21e | 14 | documentation, which can be found in the F<[.pod]> |
748a9306 | 15 | subdirectory of the Perl distribution. |
a0d0e21e LW |
16 | |
17 | We hope these notes will save you from confusion and lost | |
748a9306 | 18 | sleep when writing Perl scripts on VMS. If you find we've |
a0d0e21e | 19 | missed something you think should appear here, please don't |
9bc98430 | 20 | hesitate to drop a line to vmsperl@perl.org. |
a0d0e21e | 21 | |
4e592037 | 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 | ||
e518068a | 28 | =head1 Organization of Perl Images |
748a9306 | 29 | |
e518068a | 30 | =head2 Core Images |
748a9306 LW |
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 | |
2ceaccd7 | 61 | L<perlxs> for more details.) The Perl code for an |
748a9306 LW |
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 | ||
e518068a | 88 | =head2 Installing static extensions |
748a9306 LW |
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 | ||
e518068a | 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 | |
c07a80fd | 113 | unpacked into a directory tree B<not> under the main Perl source |
e518068a | 114 | directory, and the procedure for building the extension is simply |
115 | ||
e518068a | 116 | $ perl Makefile.PL ! Create Descrip.MMS |
117 | $ mmk ! Build necessary files | |
118 | $ mmk test ! Run test code, if supplied | |
119 | $ mmk install ! Install into public Perl tree | |
120 | ||
c07a80fd | 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 | |
39aca757 | 125 | too deeply in your directory structure, lest you exceed RMS' |
c07a80fd | 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.) | |
e518068a | 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 | |
bbce6d69 | 143 | F<[.lib.site_perl.auto>I<Arch>.I<Extname>F<]> directory of the |
e518068a | 144 | installed Perl directory tree (where I<Arch> is F<VMS_VAX> or |
bbce6d69 | 145 | F<VMS_AXP>, and I<Extname> is the name of the extension, with |
146 | each C<::> translated to C<.>). (See the MakeMaker documentation | |
147 | for more details on installation options for extensions.) | |
4e592037 | 148 | However, it can be manually placed in any of several locations: |
bbce6d69 | 149 | - the F<[.Lib.Auto.>I<Arch>I<$PVers>I<Extname>F<]> subdirectory |
150 | of one of the directories in C<@INC> (where I<PVers> | |
151 | is the version of Perl you're using, as supplied in C<$]>, | |
152 | with '.' converted to '_'), or | |
748a9306 LW |
153 | - one of the directories in C<@INC>, or |
154 | - a directory which the extensions Perl library module | |
155 | passes to the DynaLoader when asking it to map | |
156 | the shareable image, or | |
157 | - F<Sys$Share> or F<Sys$Library>. | |
158 | If the shareable image isn't in any of these places, you'll need | |
159 | to define a logical name I<Extshortname>, where I<Extshortname> | |
160 | is the portion of the extension's name after the last C<::>, which | |
161 | translates to the full file specification of the shareable image. | |
162 | ||
4e592037 | 163 | =head1 File specifications |
748a9306 | 164 | |
4e592037 | 165 | =head2 Syntax |
a0d0e21e | 166 | |
748a9306 | 167 | We have tried to make Perl aware of both VMS-style and Unix- |
a0d0e21e LW |
168 | style file specifications wherever possible. You may use |
169 | either style, or both, on the command line and in scripts, | |
39aca757 | 170 | but you may not combine the two styles within a single file |
1c9f8daa | 171 | specification. VMS Perl interprets Unix pathnames in much |
172 | the same way as the CRTL (I<e.g.> the first component of | |
173 | an absolute path is read as the device name for the | |
174 | VMS file specification). There are a set of functions | |
175 | provided in the C<VMS::Filespec> package for explicit | |
176 | interconversion between VMS and Unix syntax; its | |
177 | documentation provides more details. | |
178 | ||
179 | Filenames are, of course, still case-insensitive. For | |
180 | consistency, most Perl routines return filespecs using | |
181 | lower case letters only, regardless of the case used in | |
182 | the arguments passed to them. (This is true only when | |
183 | running under VMS; Perl respects the case-sensitivity | |
184 | of OSs like Unix.) | |
a0d0e21e | 185 | |
748a9306 | 186 | We've tried to minimize the dependence of Perl library |
a0d0e21e LW |
187 | modules on Unix syntax, but you may find that some of these, |
188 | as well as some scripts written for Unix systems, will | |
189 | require that you use Unix syntax, since they will assume that | |
4e592037 | 190 | '/' is the directory separator, I<etc.> If you find instances |
748a9306 | 191 | of this in the Perl distribution itself, please let us know, |
a0d0e21e LW |
192 | so we can try to work around them. |
193 | ||
4e592037 | 194 | =head2 Wildcard expansion |
195 | ||
196 | File specifications containing wildcards are allowed both on | |
07698885 | 197 | the command line and within Perl globs (e.g. C<E<lt>*.cE<gt>>). If |
4e592037 | 198 | the wildcard filespec uses VMS syntax, the resultant |
199 | filespecs will follow VMS syntax; if a Unix-style filespec is | |
200 | passed in, Unix-style filespecs will be returned. | |
201 | ||
aa779de1 CB |
202 | In both cases, VMS wildcard expansion is performed. (csh-style |
203 | wildcard expansion is available if you use C<File::Glob::glob>.) | |
4e592037 | 204 | If the wildcard filespec contains a device or directory |
205 | specification, then the resultant filespecs will also contain | |
206 | a device and directory; otherwise, device and directory | |
207 | information are removed. VMS-style resultant filespecs will | |
208 | contain a full device and directory, while Unix-style | |
209 | resultant filespecs will contain only as much of a directory | |
210 | path as was present in the input filespec. For example, if | |
211 | your default directory is Perl_Root:[000000], the expansion | |
212 | of C<[.t]*.*> will yield filespecs like | |
213 | "perl_root:[t]base.dir", while the expansion of C<t/*/*> will | |
214 | yield filespecs like "t/base.dir". (This is done to match | |
215 | the behavior of glob expansion performed by Unix shells.) | |
216 | ||
217 | Similarly, the resultant filespec will contain the file version | |
218 | only if one was present in the input filespec. | |
219 | ||
220 | =head2 Pipes | |
221 | ||
222 | Input and output pipes to Perl filehandles are supported; the | |
223 | "file name" is passed to lib$spawn() for asynchronous | |
224 | execution. You should be careful to close any pipes you have | |
225 | opened in a Perl script, lest you leave any "orphaned" | |
226 | subprocesses around when Perl exits. | |
227 | ||
228 | You may also use backticks to invoke a DCL subprocess, whose | |
229 | output is used as the return value of the expression. The | |
aa779de1 CB |
230 | string between the backticks is handled as if it were the |
231 | argument to the C<system> operator (see below). In this case, | |
232 | Perl will wait for the subprocess to complete before continuing. | |
4e592037 | 233 | |
376ae1f1 PP |
234 | The mailbox (MBX) that perl can create to communicate with a pipe |
235 | defaults to a buffer size of 512. The default buffer size is | |
1506e54c | 236 | adjustable via the logical name PERL_MBX_SIZE provided that the |
376ae1f1 PP |
237 | value falls between 128 and the SYSGEN parameter MAXBUF inclusive. |
238 | For example, to double the MBX size from the default within | |
1506e54c | 239 | a Perl program, use C<$ENV{'PERL_MBX_SIZE'} = 1024;> and then |
376ae1f1 PP |
240 | open and use pipe constructs. An alternative would be to issue |
241 | the command: | |
242 | ||
243 | $ Define PERL_MBX_SIZE 1024 | |
244 | ||
245 | before running your wide record pipe program. A larger value may | |
246 | improve performance at the expense of the BYTLM UAF quota. | |
247 | ||
4e592037 | 248 | =head1 PERL5LIB and PERLLIB |
249 | ||
39aca757 | 250 | The PERL5LIB and PERLLIB logical names work as documented in L<perl>, |
4e592037 | 251 | except that the element separator is '|' instead of ':'. The |
252 | directory specifications may use either VMS or Unix syntax. | |
253 | ||
254 | =head1 Command line | |
255 | ||
256 | =head2 I/O redirection and backgrounding | |
a0d0e21e LW |
257 | |
258 | Perl for VMS supports redirection of input and output on the | |
259 | command line, using a subset of Bourne shell syntax: | |
55497cff | 260 | |
07698885 RGS |
261 | =over |
262 | ||
263 | =item * | |
264 | ||
265 | C<E<lt>file> reads stdin from C<file>, | |
266 | ||
267 | =item * | |
268 | ||
269 | C<E<gt>file> writes stdout to C<file>, | |
270 | ||
271 | =item * | |
272 | ||
273 | C<E<gt>E<gt>file> appends stdout to C<file>, | |
274 | ||
275 | =item * | |
276 | ||
277 | C<2E<gt>file> writes stderr to C<file>, and | |
278 | ||
279 | =item * | |
280 | ||
281 | C<2E<gt>E<gt>file> appends stderr to C<file>. | |
282 | ||
283 | =back | |
a0d0e21e LW |
284 | |
285 | In addition, output may be piped to a subprocess, using the | |
286 | character '|'. Anything after this character on the command | |
287 | line is passed to a subprocess for execution; the subprocess | |
748a9306 | 288 | takes the output of Perl as its input. |
a0d0e21e LW |
289 | |
290 | Finally, if the command line ends with '&', the entire | |
291 | command is run in the background as an asynchronous | |
292 | subprocess. | |
293 | ||
4e592037 | 294 | =head2 Command line switches |
a0d0e21e | 295 | |
4e592037 | 296 | The following command line switches behave differently under |
297 | VMS than described in L<perlrun>. Note also that in order | |
298 | to pass uppercase switches to Perl, you need to enclose | |
299 | them in double-quotes on the command line, since the CRTL | |
300 | downcases all unquoted strings. | |
a0d0e21e | 301 | |
55497cff | 302 | =over 4 |
303 | ||
edc7bc49 CB |
304 | =item -i |
305 | ||
306 | If the C<-i> switch is present but no extension for a backup | |
307 | copy is given, then inplace editing creates a new version of | |
308 | a file; the existing copy is not deleted. (Note that if | |
309 | an extension is given, an existing file is renamed to the backup | |
310 | file, as is the case under other operating systems, so it does | |
311 | not remain as a previous version under the original filename.) | |
312 | ||
4e592037 | 313 | =item -S |
a0d0e21e | 314 | |
376ae1f1 PP |
315 | If the C<"-S"> or C<-"S"> switch is present I<and> the script |
316 | name does not contain a directory, then Perl translates the | |
317 | logical name DCL$PATH as a searchlist, using each translation | |
318 | as a directory in which to look for the script. In addition, | |
4e592037 | 319 | if no file type is specified, Perl looks in each directory |
320 | for a file matching the name specified, with a blank type, | |
321 | a type of F<.pl>, and a type of F<.com>, in that order. | |
a0d0e21e | 322 | |
4e592037 | 323 | =item -u |
748a9306 | 324 | |
4e592037 | 325 | The C<-u> switch causes the VMS debugger to be invoked |
326 | after the Perl program is compiled, but before it has | |
327 | run. It does not create a core dump file. | |
748a9306 | 328 | |
55497cff | 329 | =back |
330 | ||
748a9306 | 331 | =head1 Perl functions |
a0d0e21e LW |
332 | |
333 | As of the time this document was last revised, the following | |
748a9306 | 334 | Perl functions were implemented in the VMS port of Perl |
a0d0e21e LW |
335 | (functions marked with * are discussed in more detail below): |
336 | ||
4fdae800 | 337 | file tests*, abs, alarm, atan, backticks*, binmode*, bless, |
a0d0e21e | 338 | caller, chdir, chmod, chown, chomp, chop, chr, |
c07a80fd | 339 | close, closedir, cos, crypt*, defined, delete, |
4e592037 | 340 | die, do, dump*, each, endpwent, eof, eval, exec*, |
41cbbefa | 341 | exists, exit, exp, fileno, getc, getlogin, getppid, |
4e592037 | 342 | getpwent*, getpwnam*, getpwuid*, glob, gmtime*, goto, |
343 | grep, hex, import, index, int, join, keys, kill*, | |
344 | last, lc, lcfirst, length, local, localtime, log, m//, | |
345 | map, mkdir, my, next, no, oct, open, opendir, ord, pack, | |
c07a80fd | 346 | pipe, pop, pos, print, printf, push, q//, qq//, qw//, |
4fdae800 | 347 | qx//*, quotemeta, rand, read, readdir, redo, ref, rename, |
a0d0e21e | 348 | require, reset, return, reverse, rewinddir, rindex, |
e518068a | 349 | rmdir, s///, scalar, seek, seekdir, select(internal), |
350 | select (system call)*, setpwent, shift, sin, sleep, | |
351 | sort, splice, split, sprintf, sqrt, srand, stat, | |
352 | study, substr, sysread, system*, syswrite, tell, | |
353 | telldir, tie, time, times*, tr///, uc, ucfirst, umask, | |
354 | undef, unlink*, unpack, untie, unshift, use, utime*, | |
355 | values, vec, wait, waitpid*, wantarray, warn, write, y/// | |
a0d0e21e LW |
356 | |
357 | The following functions were not implemented in the VMS port, | |
358 | and calling them produces a fatal error (usually) or | |
359 | undefined behavior (rarely, we hope): | |
360 | ||
41cbbefa CB |
361 | chroot, dbmclose, dbmopen, flock, fork*, |
362 | getpgrp, getpriority, getgrent, getgrgid, | |
c07a80fd | 363 | getgrnam, setgrent, endgrent, ioctl, link, lstat, |
364 | msgctl, msgget, msgsend, msgrcv, readlink, semctl, | |
365 | semget, semop, setpgrp, setpriority, shmctl, shmget, | |
bf99883d HM |
366 | shmread, shmwrite, socketpair, symlink, syscall |
367 | ||
35b2760a CB |
368 | The following functions are available on Perls compiled with Dec C |
369 | 5.2 or greater and running VMS 7.0 or greater: | |
bf99883d HM |
370 | |
371 | truncate | |
a0d0e21e | 372 | |
35b2760a CB |
373 | The following functions are available on Perls built on VMS 7.2 or |
374 | greater: | |
375 | ||
376 | fcntl (without locking) | |
377 | ||
a0d0e21e LW |
378 | The following functions may or may not be implemented, |
379 | depending on what type of socket support you've built into | |
748a9306 | 380 | your copy of Perl: |
4e592037 | 381 | |
a0d0e21e LW |
382 | accept, bind, connect, getpeername, |
383 | gethostbyname, getnetbyname, getprotobyname, | |
384 | getservbyname, gethostbyaddr, getnetbyaddr, | |
385 | getprotobynumber, getservbyport, gethostent, | |
386 | getnetent, getprotoent, getservent, sethostent, | |
387 | setnetent, setprotoent, setservent, endhostent, | |
388 | endnetent, endprotoent, endservent, getsockname, | |
c07a80fd | 389 | getsockopt, listen, recv, select(system call)*, |
390 | send, setsockopt, shutdown, socket | |
a0d0e21e | 391 | |
55497cff | 392 | =over 4 |
a0d0e21e LW |
393 | |
394 | =item File tests | |
395 | ||
748a9306 LW |
396 | The tests C<-b>, C<-B>, C<-c>, C<-C>, C<-d>, C<-e>, C<-f>, |
397 | C<-o>, C<-M>, C<-s>, C<-S>, C<-t>, C<-T>, and C<-z> work as | |
398 | advertised. The return values for C<-r>, C<-w>, and C<-x> | |
399 | tell you whether you can actually access the file; this may | |
400 | not reflect the UIC-based file protections. Since real and | |
401 | effective UIC don't differ under VMS, C<-O>, C<-R>, C<-W>, | |
402 | and C<-X> are equivalent to C<-o>, C<-r>, C<-w>, and C<-x>. | |
403 | Similarly, several other tests, including C<-A>, C<-g>, C<-k>, | |
404 | C<-l>, C<-p>, and C<-u>, aren't particularly meaningful under | |
405 | VMS, and the values returned by these tests reflect whatever | |
406 | your CRTL C<stat()> routine does to the equivalent bits in the | |
407 | st_mode field. Finally, C<-d> returns true if passed a device | |
408 | specification without an explicit directory (e.g. C<DUA1:>), as | |
409 | well as if passed a directory. | |
410 | ||
4e592037 | 411 | Note: Some sites have reported problems when using the file-access |
412 | tests (C<-r>, C<-w>, and C<-x>) on files accessed via DEC's DFS. | |
413 | Specifically, since DFS does not currently provide access to the | |
414 | extended file header of files on remote volumes, attempts to | |
415 | examine the ACL fail, and the file tests will return false, | |
416 | with C<$!> indicating that the file does not exist. You can | |
417 | use C<stat> on these files, since that checks UIC-based protection | |
418 | only, and then manually check the appropriate bits, as defined by | |
419 | your C compiler's F<stat.h>, in the mode value it returns, if you | |
420 | need an approximation of the file's protections. | |
421 | ||
4fdae800 | 422 | =item backticks |
423 | ||
424 | Backticks create a subprocess, and pass the enclosed string | |
425 | to it for execution as a DCL command. Since the subprocess is | |
426 | created directly via C<lib$spawn()>, any valid DCL command string | |
427 | may be specified. | |
428 | ||
748a9306 LW |
429 | =item binmode FILEHANDLE |
430 | ||
1c9f8daa | 431 | The C<binmode> operator will attempt to insure that no translation |
432 | of carriage control occurs on input from or output to this filehandle. | |
433 | Since this involves reopening the file and then restoring its | |
434 | file position indicator, if this function returns FALSE, the | |
435 | underlying filehandle may no longer point to an open file, or may | |
436 | point to a different position in the file than before C<binmode> | |
437 | was called. | |
438 | ||
439 | Note that C<binmode> is generally not necessary when using normal | |
440 | filehandles; it is provided so that you can control I/O to existing | |
441 | record-structured files when necessary. You can also use the | |
442 | C<vmsfopen> function in the VMS::Stdio extension to gain finer | |
443 | control of I/O to files and devices with different record structures. | |
a0d0e21e | 444 | |
c07a80fd | 445 | =item crypt PLAINTEXT, USER |
446 | ||
447 | The C<crypt> operator uses the C<sys$hash_password> system | |
448 | service to generate the hashed representation of PLAINTEXT. | |
449 | If USER is a valid username, the algorithm and salt values | |
450 | are taken from that user's UAF record. If it is not, then | |
451 | the preferred algorithm and a salt of 0 are used. The | |
452 | quadword encrypted value is returned as an 8-character string. | |
453 | ||
454 | The value returned by C<crypt> may be compared against | |
455 | the encrypted password from the UAF returned by the C<getpw*> | |
456 | functions, in order to authenticate users. If you're | |
457 | going to do this, remember that the encrypted password in | |
458 | the UAF was generated using uppercase username and | |
459 | password strings; you'll have to upcase the arguments to | |
460 | C<crypt> to insure that you'll get the proper value: | |
461 | ||
376ae1f1 PP |
462 | sub validate_passwd { |
463 | my($user,$passwd) = @_; | |
464 | my($pwdhash); | |
465 | if ( !($pwdhash = (getpwnam($user))[1]) || | |
466 | $pwdhash ne crypt("\U$passwd","\U$name") ) { | |
467 | intruder_alert($name); | |
468 | } | |
469 | return 1; | |
c07a80fd | 470 | } |
c07a80fd | 471 | |
4e592037 | 472 | =item dump |
473 | ||
474 | Rather than causing Perl to abort and dump core, the C<dump> | |
475 | operator invokes the VMS debugger. If you continue to | |
476 | execute the Perl program under the debugger, control will | |
477 | be transferred to the label specified as the argument to | |
478 | C<dump>, or, if no label was specified, back to the | |
479 | beginning of the program. All other state of the program | |
480 | (I<e.g.> values of variables, open file handles) are not | |
481 | affected by calling C<dump>. | |
482 | ||
748a9306 | 483 | =item exec LIST |
a0d0e21e | 484 | |
41cbbefa CB |
485 | A call to C<exec> will cause Perl to exit, and to invoke the command |
486 | given as an argument to C<exec> via C<lib$do_command>. If the | |
487 | argument begins with '@' or '$' (other than as part of a filespec), | |
488 | then it is executed as a DCL command. Otherwise, the first token on | |
489 | the command line is treated as the filespec of an image to run, and | |
490 | an attempt is made to invoke it (using F<.Exe> and the process | |
491 | defaults to expand the filespec) and pass the rest of C<exec>'s | |
492 | argument to it as parameters. If the token has no file type, and | |
493 | matches a file with null type, then an attempt is made to determine | |
494 | whether the file is an executable image which should be invoked | |
495 | using C<MCR> or a text file which should be passed to DCL as a | |
496 | command procedure. | |
a0d0e21e LW |
497 | |
498 | =item fork | |
499 | ||
41cbbefa CB |
500 | While in principle the C<fork> operator could be implemented via |
501 | (and with the same rather severe limitations as) the CRTL C<vfork()> | |
502 | routine, and while some internal support to do just that is in | |
503 | place, the implementation has never been completed, making C<fork> | |
504 | currently unavailable. A true kernel C<fork()> is expected in a | |
505 | future version of VMS, and the pseudo-fork based on interpreter | |
506 | threads may be available in a future version of Perl on VMS (see | |
507 | L<perlfork>). In the meantime, use C<system>, backticks, or piped | |
508 | filehandles to create subprocesses. | |
748a9306 LW |
509 | |
510 | =item getpwent | |
c07a80fd | 511 | |
748a9306 | 512 | =item getpwnam |
c07a80fd | 513 | |
748a9306 LW |
514 | =item getpwuid |
515 | ||
516 | These operators obtain the information described in L<perlfunc>, | |
517 | if you have the privileges necessary to retrieve the named user's | |
518 | UAF information via C<sys$getuai>. If not, then only the C<$name>, | |
519 | C<$uid>, and C<$gid> items are returned. The C<$dir> item contains | |
520 | the login directory in VMS syntax, while the C<$comment> item | |
521 | contains the login directory in Unix syntax. The C<$gcos> item | |
522 | contains the owner field from the UAF record. The C<$quota> | |
523 | item is not used. | |
a0d0e21e | 524 | |
e518068a | 525 | =item gmtime |
526 | ||
527 | The C<gmtime> operator will function properly if you have a | |
528 | working CRTL C<gmtime()> routine, or if the logical name | |
529 | SYS$TIMEZONE_DIFFERENTIAL is defined as the number of seconds | |
530 | which must be added to UTC to yield local time. (This logical | |
531 | name is defined automatically if you are running a version of | |
532 | VMS with built-in UTC support.) If neither of these cases is | |
533 | true, a warning message is printed, and C<undef> is returned. | |
534 | ||
535 | =item kill | |
536 | ||
39aca757 | 537 | In most cases, C<kill> is implemented via the CRTL's C<kill()> |
e518068a | 538 | function, so it will behave according to that function's |
539 | documentation. If you send a SIGKILL, however, the $DELPRC system | |
10a676f8 | 540 | service is called directly. This insures that the target |
e518068a | 541 | process is actually deleted, if at all possible. (The CRTL's C<kill()> |
542 | function is presently implemented via $FORCEX, which is ignored by | |
543 | supervisor-mode images like DCL.) | |
544 | ||
545 | Also, negative signal values don't do anything special under | |
546 | VMS; they're just converted to the corresponding positive value. | |
547 | ||
4fdae800 | 548 | =item qx// |
549 | ||
550 | See the entry on C<backticks> above. | |
551 | ||
e518068a | 552 | =item select (system call) |
553 | ||
554 | If Perl was not built with socket support, the system call | |
555 | version of C<select> is not available at all. If socket | |
556 | support is present, then the system call version of | |
557 | C<select> functions only for file descriptors attached | |
558 | to sockets. It will not provide information about regular | |
559 | files or pipes, since the CRTL C<select()> routine does not | |
560 | provide this functionality. | |
561 | ||
748a9306 | 562 | =item stat EXPR |
a0d0e21e | 563 | |
748a9306 LW |
564 | Since VMS keeps track of files according to a different scheme |
565 | than Unix, it's not really possible to represent the file's ID | |
566 | in the C<st_dev> and C<st_ino> fields of a C<struct stat>. Perl | |
567 | tries its best, though, and the values it uses are pretty unlikely | |
568 | to be the same for two different files. We can't guarantee this, | |
569 | though, so caveat scriptor. | |
570 | ||
571 | =item system LIST | |
572 | ||
573 | The C<system> operator creates a subprocess, and passes its | |
a0d0e21e | 574 | arguments to the subprocess for execution as a DCL command. |
e518068a | 575 | Since the subprocess is created directly via C<lib$spawn()>, any |
aa779de1 CB |
576 | valid DCL command string may be specified. If the string begins with |
577 | '@', it is treated as a DCL command unconditionally. Otherwise, if | |
578 | the first token contains a character used as a delimiter in file | |
579 | specification (e.g. C<:> or C<]>), an attempt is made to expand it | |
580 | using a default type of F<.Exe> and the process defaults, and if | |
581 | successful, the resulting file is invoked via C<MCR>. This allows you | |
582 | to invoke an image directly simply by passing the file specification | |
c93fa817 GS |
583 | to C<system>, a common Unixish idiom. If the token has no file type, |
584 | and matches a file with null type, then an attempt is made to | |
585 | determine whether the file is an executable image which should be | |
586 | invoked using C<MCR> or a text file which should be passed to DCL | |
587 | as a command procedure. | |
588 | ||
589 | If LIST consists of the empty string, C<system> spawns an | |
a2293a43 | 590 | interactive DCL subprocess, in the same fashion as typing |
c93fa817 GS |
591 | B<SPAWN> at the DCL prompt. |
592 | ||
748a9306 | 593 | Perl waits for the subprocess to complete before continuing |
4fdae800 | 594 | execution in the current process. As described in L<perlfunc>, |
595 | the return value of C<system> is a fake "status" which follows | |
c6966fea | 596 | POSIX semantics unless the pragma C<use vmsish 'status'> is in |
1b0c4952 CB |
597 | effect; see the description of C<$?> in this document for more |
598 | detail. | |
a0d0e21e | 599 | |
1c9f8daa | 600 | =item time |
601 | ||
602 | The value returned by C<time> is the offset in seconds from | |
603 | 01-JAN-1970 00:00:00 (just like the CRTL's times() routine), in order | |
604 | to make life easier for code coming in from the POSIX/Unix world. | |
605 | ||
a0d0e21e LW |
606 | =item times |
607 | ||
748a9306 LW |
608 | The array returned by the C<times> operator is divided up |
609 | according to the same rules the CRTL C<times()> routine. | |
a0d0e21e LW |
610 | Therefore, the "system time" elements will always be 0, since |
611 | there is no difference between "user time" and "system" time | |
39aca757 | 612 | under VMS, and the time accumulated by a subprocess may or may |
a0d0e21e | 613 | not appear separately in the "child time" field, depending on |
748a9306 LW |
614 | whether L<times> keeps track of subprocesses separately. Note |
615 | especially that the VAXCRTL (at least) keeps track only of | |
616 | subprocesses spawned using L<fork> and L<exec>; it will not | |
a2293a43 | 617 | accumulate the times of subprocesses spawned via pipes, L<system>, |
748a9306 LW |
618 | or backticks. |
619 | ||
16d20bd9 AD |
620 | =item unlink LIST |
621 | ||
622 | C<unlink> will delete the highest version of a file only; in | |
623 | order to delete all versions, you need to say | |
39aca757 | 624 | |
35b2760a | 625 | 1 while unlink LIST; |
39aca757 | 626 | |
16d20bd9 AD |
627 | You may need to make this change to scripts written for a |
628 | Unix system which expect that after a call to C<unlink>, | |
629 | no files with the names passed to C<unlink> will exist. | |
4633a7c4 LW |
630 | (Note: This can be changed at compile time; if you |
631 | C<use Config> and C<$Config{'d_unlink_all_versions'}> is | |
632 | C<define>, then C<unlink> will delete all versions of a | |
633 | file on the first call.) | |
16d20bd9 AD |
634 | |
635 | C<unlink> will delete a file if at all possible, even if it | |
636 | requires changing file protection (though it won't try to | |
637 | change the protection of the parent directory). You can tell | |
638 | whether you've got explicit delete access to a file by using the | |
639 | C<VMS::Filespec::candelete> operator. For instance, in order | |
640 | to delete only files to which you have delete access, you could | |
641 | say something like | |
4e592037 | 642 | |
16d20bd9 AD |
643 | sub safe_unlink { |
644 | my($file,$num); | |
645 | foreach $file (@_) { | |
646 | next unless VMS::Filespec::candelete($file); | |
647 | $num += unlink $file; | |
648 | } | |
649 | $num; | |
650 | } | |
4e592037 | 651 | |
652 | (or you could just use C<VMS::Stdio::remove>, if you've installed | |
653 | the VMS::Stdio extension distributed with Perl). If C<unlink> has to | |
654 | change the file protection to delete the file, and you interrupt it | |
655 | in midstream, the file may be left intact, but with a changed ACL | |
656 | allowing you delete access. | |
16d20bd9 | 657 | |
748a9306 LW |
658 | =item utime LIST |
659 | ||
660 | Since ODS-2, the VMS file structure for disk files, does not keep | |
661 | track of access times, this operator changes only the modification | |
662 | time of the file (VMS revision date). | |
663 | ||
664 | =item waitpid PID,FLAGS | |
665 | ||
39aca757 | 666 | If PID is a subprocess started by a piped C<open()> (see L<open>), |
376ae1f1 PP |
667 | C<waitpid> will wait for that subprocess, and return its final status |
668 | value in C<$?>. If PID is a subprocess created in some other way (e.g. | |
669 | SPAWNed before Perl was invoked), C<waitpid> will simply check once per | |
670 | second whether the process has completed, and return when it has. (If | |
671 | PID specifies a process that isn't a subprocess of the current process, | |
672 | and you invoked Perl with the C<-w> switch, a warning will be issued.) | |
35b2760a CB |
673 | |
674 | Returns PID on success, -1 on error. The FLAGS argument is ignored | |
675 | in all cases. | |
a0d0e21e | 676 | |
55497cff | 677 | =back |
678 | ||
a5f75d66 AD |
679 | =head1 Perl variables |
680 | ||
55497cff | 681 | The following VMS-specific information applies to the indicated |
682 | "special" Perl variables, in addition to the general information | |
a2293a43 | 683 | in L<perlvar>. Where there is a conflict, this information |
55497cff | 684 | takes precedence. |
685 | ||
686 | =over 4 | |
687 | ||
a5f75d66 AD |
688 | =item %ENV |
689 | ||
f675dbe5 CB |
690 | The operation of the C<%ENV> array depends on the translation |
691 | of the logical name F<PERL_ENV_TABLES>. If defined, it should | |
692 | be a search list, each element of which specifies a location | |
693 | for C<%ENV> elements. If you tell Perl to read or set the | |
694 | element C<$ENV{>I<name>C<}>, then Perl uses the translations of | |
695 | F<PERL_ENV_TABLES> as follows: | |
696 | ||
697 | =over 4 | |
698 | ||
699 | =item CRTL_ENV | |
700 | ||
701 | This string tells Perl to consult the CRTL's internal C<environ> | |
702 | array of key-value pairs, using I<name> as the key. In most cases, | |
703 | this contains only a few keys, but if Perl was invoked via the C | |
704 | C<exec[lv]e()> function, as is the case for CGI processing by some | |
705 | HTTP servers, then the C<environ> array may have been populated by | |
706 | the calling program. | |
707 | ||
708 | =item CLISYM_[LOCAL] | |
709 | ||
710 | A string beginning with C<CLISYM_>tells Perl to consult the CLI's | |
711 | symbol tables, using I<name> as the name of the symbol. When reading | |
712 | an element of C<%ENV>, the local symbol table is scanned first, followed | |
713 | by the global symbol table.. The characters following C<CLISYM_> are | |
714 | significant when an element of C<%ENV> is set or deleted: if the | |
715 | complete string is C<CLISYM_LOCAL>, the change is made in the local | |
39aca757 | 716 | symbol table; otherwise the global symbol table is changed. |
f675dbe5 CB |
717 | |
718 | =item Any other string | |
719 | ||
720 | If an element of F<PERL_ENV_TABLES> translates to any other string, | |
721 | that string is used as the name of a logical name table, which is | |
722 | consulted using I<name> as the logical name. The normal search | |
723 | order of access modes is used. | |
724 | ||
725 | =back | |
726 | ||
727 | F<PERL_ENV_TABLES> is translated once when Perl starts up; any changes | |
728 | you make while Perl is running do not affect the behavior of C<%ENV>. | |
729 | If F<PERL_ENV_TABLES> is not defined, then Perl defaults to consulting | |
730 | first the logical name tables specified by F<LNM$FILE_DEV>, and then | |
731 | the CRTL C<environ> array. | |
732 | ||
733 | In all operations on %ENV, the key string is treated as if it | |
734 | were entirely uppercase, regardless of the case actually | |
735 | specified in the Perl expression. | |
736 | ||
737 | When an element of C<%ENV> is read, the locations to which | |
738 | F<PERL_ENV_TABLES> points are checked in order, and the value | |
739 | obtained from the first successful lookup is returned. If the | |
740 | name of the C<%ENV> element contains a semi-colon, it and | |
741 | any characters after it are removed. These are ignored when | |
742 | the CRTL C<environ> array or a CLI symbol table is consulted. | |
743 | However, the name is looked up in a logical name table, the | |
744 | suffix after the semi-colon is treated as the translation index | |
745 | to be used for the lookup. This lets you look up successive values | |
746 | for search list logical names. For instance, if you say | |
a5f75d66 AD |
747 | |
748 | $ Define STORY once,upon,a,time,there,was | |
749 | $ perl -e "for ($i = 0; $i <= 6; $i++) " - | |
740ce14c | 750 | _$ -e "{ print $ENV{'story;'.$i},' '}" |
a5f75d66 | 751 | |
f675dbe5 CB |
752 | Perl will print C<ONCE UPON A TIME THERE WAS>, assuming, of course, |
753 | that F<PERL_ENV_TABLES> is set up so that the logical name C<story> | |
754 | is found, rather than a CLI symbol or CRTL C<environ> element with | |
755 | the same name. | |
756 | ||
3eeba6fb | 757 | When an element of C<%ENV> is set to a defined string, the |
f675dbe5 CB |
758 | corresponding definition is made in the location to which the |
759 | first translation of F<PERL_ENV_TABLES> points. If this causes a | |
760 | logical name to be created, it is defined in supervisor mode. | |
3eeba6fb CB |
761 | (The same is done if an existing logical name was defined in |
762 | executive or kernel mode; an existing user or supervisor mode | |
763 | logical name is reset to the new value.) If the value is an empty | |
764 | string, the logical name's translation is defined as a single NUL | |
765 | (ASCII 00) character, since a logical name cannot translate to a | |
766 | zero-length string. (This restriction does not apply to CLI symbols | |
767 | or CRTL C<environ> values; they are set to the empty string.) | |
f675dbe5 CB |
768 | An element of the CRTL C<environ> array can be set only if your |
769 | copy of Perl knows about the CRTL's C<setenv()> function. (This is | |
770 | present only in some versions of the DECCRTL; check C<$Config{d_setenv}> | |
771 | to see whether your copy of Perl was built with a CRTL that has this | |
772 | function.) | |
39aca757 | 773 | |
3eeba6fb | 774 | When an element of C<%ENV> is set to C<undef>, |
f675dbe5 CB |
775 | the element is looked up as if it were being read, and if it is |
776 | found, it is deleted. (An item "deleted" from the CRTL C<environ> | |
777 | array is set to the empty string; this can only be done if your | |
778 | copy of Perl knows about the CRTL C<setenv()> function.) Using | |
779 | C<delete> to remove an element from C<%ENV> has a similar effect, | |
780 | but after the element is deleted, another attempt is made to | |
781 | look up the element, so an inner-mode logical name or a name in | |
782 | another location will replace the logical name just deleted. | |
3eeba6fb CB |
783 | In either case, only the first value found searching PERL_ENV_TABLES |
784 | is altered. It is not possible at present to define a search list | |
785 | logical name via %ENV. | |
f675dbe5 CB |
786 | |
787 | The element C<$ENV{DEFAULT}> is special: when read, it returns | |
788 | Perl's current default device and directory, and when set, it | |
789 | resets them, regardless of the definition of F<PERL_ENV_TABLES>. | |
790 | It cannot be cleared or deleted; attempts to do so are silently | |
791 | ignored. | |
b7b1864f CB |
792 | |
793 | Note that if you want to pass on any elements of the | |
794 | C-local environ array to a subprocess which isn't | |
795 | started by fork/exec, or isn't running a C program, you | |
796 | can "promote" them to logical names in the current | |
797 | process, which will then be inherited by all subprocesses, | |
798 | by saying | |
799 | ||
800 | foreach my $key (qw[C-local keys you want promoted]) { | |
376ae1f1 PP |
801 | my $temp = $ENV{$key}; # read from C-local array |
802 | $ENV{$key} = $temp; # and define as logical name | |
b7b1864f CB |
803 | } |
804 | ||
805 | (You can't just say C<$ENV{$key} = $ENV{$key}>, since the | |
806 | Perl optimizer is smart enough to elide the expression.) | |
a5f75d66 | 807 | |
6be8f7a6 JH |
808 | Don't try to clear C<%ENV> by saying C<%ENV = ();>, it will throw |
809 | a fatal error. This is equivalent to doing the following from DCL: | |
810 | ||
811 | DELETE/LOGICAL * | |
812 | ||
813 | You can imagine how bad things would be if, for example, the SYS$MANAGER | |
814 | or SYS$SYSTEM logicals were deleted. | |
4a0d0822 | 815 | |
740ce14c | 816 | At present, the first time you iterate over %ENV using |
edc7bc49 CB |
817 | C<keys>, or C<values>, you will incur a time penalty as all |
818 | logical names are read, in order to fully populate %ENV. | |
819 | Subsequent iterations will not reread logical names, so they | |
820 | won't be as slow, but they also won't reflect any changes | |
f675dbe5 CB |
821 | to logical name tables caused by other programs. |
822 | ||
823 | You do need to be careful with the logicals representing process-permanent | |
824 | files, such as C<SYS$INPUT> and C<SYS$OUTPUT>. The translations for these | |
825 | logicals are prepended with a two-byte binary value (0x1B 0x00) that needs to be | |
39aca757 | 826 | stripped off if you want to use it. (In previous versions of Perl it wasn't |
f675dbe5 CB |
827 | possible to get the values of these logicals, as the null byte acted as an |
828 | end-of-string marker) | |
a5f75d66 | 829 | |
a5f75d66 AD |
830 | =item $! |
831 | ||
832 | The string value of C<$!> is that returned by the CRTL's | |
833 | strerror() function, so it will include the VMS message for | |
834 | VMS-specific errors. The numeric value of C<$!> is the | |
835 | value of C<errno>, except if errno is EVMSERR, in which | |
836 | case C<$!> contains the value of vaxc$errno. Setting C<$!> | |
4e592037 | 837 | always sets errno to the value specified. If this value is |
838 | EVMSERR, it also sets vaxc$errno to 4 (NONAME-F-NOMSG), so | |
839 | that the string value of C<$!> won't reflect the VMS error | |
840 | message from before C<$!> was set. | |
841 | ||
842 | =item $^E | |
843 | ||
844 | This variable provides direct access to VMS status values | |
845 | in vaxc$errno, which are often more specific than the | |
846 | generic Unix-style error messages in C<$!>. Its numeric value | |
847 | is the value of vaxc$errno, and its string value is the | |
848 | corresponding VMS message string, as retrieved by sys$getmsg(). | |
849 | Setting C<$^E> sets vaxc$errno to the value specified. | |
850 | ||
4fdae800 | 851 | =item $? |
852 | ||
853 | The "status value" returned in C<$?> is synthesized from the | |
854 | actual exit status of the subprocess in a way that approximates | |
855 | POSIX wait(5) semantics, in order to allow Perl programs to | |
856 | portably test for successful completion of subprocesses. The | |
857 | low order 8 bits of C<$?> are always 0 under VMS, since the | |
858 | termination status of a process may or may not have been | |
859 | generated by an exception. The next 8 bits are derived from | |
39aca757 | 860 | the severity portion of the subprocess' exit status: if the |
4fdae800 | 861 | severity was success or informational, these bits are all 0; |
9bc98430 CB |
862 | if the severity was warning, they contain a value of 1; if the |
863 | severity was error or fatal error, they contain the actual | |
864 | severity bits, which turns out to be a value of 2 for error | |
865 | and 4 for fatal error. | |
866 | ||
4fdae800 | 867 | As a result, C<$?> will always be zero if the subprocess' exit |
868 | status indicated successful completion, and non-zero if a | |
9bc98430 CB |
869 | warning or error occurred. Conversely, when setting C<$?> in |
870 | an END block, an attempt is made to convert the POSIX value | |
871 | into a native status intelligible to the operating system upon | |
872 | exiting Perl. What this boils down to is that setting C<$?> | |
873 | to zero results in the generic success value SS$_NORMAL, and | |
874 | setting C<$?> to a non-zero value results in the generic | |
875 | failure status SS$_ABORT. See also L<perlport/exit>. | |
4fdae800 | 876 | |
1b0c4952 | 877 | The pragma C<use vmsish 'status'> makes C<$?> reflect the actual |
9bc98430 CB |
878 | VMS exit status instead of the default emulation of POSIX status |
879 | described above. This pragma also disables the conversion of | |
880 | non-zero values to SS$_ABORT when setting C<$?> in an END | |
881 | block (but zero will still be converted to SS$_NORMAL). | |
4fdae800 | 882 | |
4e592037 | 883 | =item $| |
884 | ||
885 | Setting C<$|> for an I/O stream causes data to be flushed | |
886 | all the way to disk on each write (I<i.e.> not just to | |
887 | the underlying RMS buffers for a file). In other words, | |
888 | it's equivalent to calling fflush() and fsync() from C. | |
a5f75d66 | 889 | |
55497cff | 890 | =back |
891 | ||
bf99883d HM |
892 | =head1 Standard modules with VMS-specific differences |
893 | ||
894 | =head2 SDBM_File | |
895 | ||
270c2ced | 896 | SDBM_File works properly on VMS. It has, however, one minor |
4a4eefd0 GS |
897 | difference. The database directory file created has a F<.sdbm_dir> |
898 | extension rather than a F<.dir> extension. F<.dir> files are VMS filesystem | |
bf99883d HM |
899 | directory files, and using them for other purposes could cause unacceptable |
900 | problems. | |
901 | ||
748a9306 | 902 | =head1 Revision date |
a0d0e21e | 903 | |
1506e54c | 904 | This document was last updated on 01-May-2002, for Perl 5, |
9bc98430 | 905 | patchlevel 8. |
e518068a | 906 | |
907 | =head1 AUTHOR | |
908 | ||
376ae1f1 PP |
909 | Charles Bailey bailey@cor.newman.upenn.edu |
910 | Craig Berry craigberry@mac.com | |
911 | Dan Sugalski dan@sidhe.org |