perl 5.003_07: lib/ExtUtils/xsubpp
[perl.git] / pod / perlfunc.pod
1 =head1 NAME
2
3 perlfunc - Perl builtin functions
4
5 =head1 DESCRIPTION
6
7 The functions in this section can serve as terms in an expression.
8 They fall into two major categories: list operators and named unary
9 operators.  These differ in their precedence relationship with a
10 following comma.  (See the precedence table in L<perlop>.)  List
11 operators take more than one argument, while unary operators can never
12 take more than one argument.  Thus, a comma terminates the argument of
13 a unary operator, but merely separates the arguments of a list
14 operator.  A unary operator generally provides a scalar context to its
15 argument, while a list operator may provide either scalar and list
16 contexts for its arguments.  If it does both, the scalar arguments will
17 be first, and the list argument will follow.  (Note that there can only
18 ever be one list argument.)  For instance, splice() has three scalar
19 arguments followed by a list.
20
21 In the syntax descriptions that follow, list operators that expect a
22 list (and provide list context for the elements of the list) are shown
23 with LIST as an argument.  Such a list may consist of any combination
24 of scalar arguments or list values; the list values will be included
25 in the list as if each individual element were interpolated at that
26 point in the list, forming a longer single-dimensional list value.
27 Elements of the LIST should be separated by commas.
28
29 Any function in the list below may be used either with or without
30 parentheses around its arguments.  (The syntax descriptions omit the
31 parens.)  If you use the parens, the simple (but occasionally
32 surprising) rule is this: It I<LOOKS> like a function, therefore it I<IS> a
33 function, and precedence doesn't matter.  Otherwise it's a list
34 operator or unary operator, and precedence does matter.  And whitespace
35 between the function and left parenthesis doesn't count--so you need to
36 be careful sometimes:
37
38     print 1+2+3;        # Prints 6.
39     print(1+2) + 3;     # Prints 3.
40     print (1+2)+3;      # Also prints 3!
41     print +(1+2)+3;     # Prints 6.
42     print ((1+2)+3);    # Prints 6.
43
44 If you run Perl with the B<-w> switch it can warn you about this.  For
45 example, the third line above produces:
46
47     print (...) interpreted as function at - line 1.
48     Useless use of integer addition in void context at - line 1.
49
50 For functions that can be used in either a scalar or list context,
51 non-abortive failure is generally indicated in a scalar context by
52 returning the undefined value, and in a list context by returning the
53 null list.
54
55 Remember the following rule:
56
57 =over 8
58
59 =item  
60
61 I<THERE IS NO GENERAL RULE FOR CONVERTING A LIST INTO A SCALAR!>
62
63 =back
64
65 Each operator and function decides which sort of value it would be most
66 appropriate to return in a scalar context.  Some operators return the
67 length of the list that would have been returned in a list context.  Some
68 operators return the first value in the list.  Some operators return the
69 last value in the list.  Some operators return a count of successful
70 operations.  In general, they do what you want, unless you want
71 consistency.
72
73 =head2 Perl Functions by Category
74
75 Here are Perl's functions (including things that look like
76 functions, like some of the keywords and named operators)
77 arranged by category.  Some functions appear in more
78 than one place.
79
80 =over
81
82 =item Functions for SCALARs or strings
83
84 chomp, chop, chr, crypt, hex, index, lc, lcfirst, length,
85 oct, ord, pack, q/STRING/, qq/STRING/, reverse, rindex,
86 sprintf, substr, tr///, uc, ucfirst, y///
87
88 =item Regular expressions and pattern matching
89
90 m//, pos, quotemeta, s///, split, study
91
92 =item Numeric functions
93
94 abs, atan2, cos, exp, hex, int, log, oct, rand, sin, sqrt,
95 srand
96
97 =item Functions for real @ARRAYs
98
99 pop, push, shift, splice, unshift
100
101 =item Functions for list data
102
103 grep, join, map, qw/STRING/, reverse, sort, unpack
104
105 =item Functions for real %HASHes
106
107 delete, each, exists, keys, values
108
109 =item Input and output functions
110
111 binmode, close, closedir, dbmclose, dbmopen, die, eof,
112 fileno, flock, format, getc, print, printf, read, readdir,
113 rewinddir, seek, seekdir, select, syscall, sysread,
114 syswrite, tell, telldir, truncate, warn, write
115
116 =item Functions for fixed length data or records
117
118 pack, read, syscall, sysread, syswrite, unpack, vec
119
120 =item Functions for filehandles, files, or directories
121
122 I<-X>, chdir, chmod, chown, chroot, fcntl, glob, ioctl, link,
123 lstat, mkdir, open, opendir, readlink, rename, rmdir,
124 stat, symlink, umask, unlink, utime
125
126 =item Keywords related to the control flow of your perl program
127
128 caller, continue, die, do, dump, eval, exit, goto, last,
129 next, redo, return, sub, wantarray
130
131 =item Keywords related to scoping 
132
133 caller, import, local, my, package, use
134
135 =item Miscellaneous functions
136
137 defined, dump, eval, formline, local, my, reset, scalar,
138 undef, wantarray
139
140 =item Functions for processes and process groups
141
142 alarm, exec, fork, getpgrp, getppid, getpriority, kill,
143 pipe, qx/STRING/, setpgrp, setpriority, sleep, system,
144 times, wait, waitpid
145
146 =item Keywords related to perl modules
147
148 do, import, no, package, require, use
149
150 =item Keywords related to classes and object-orientedness
151
152 bless, dbmclose, dbmopen, package, ref, tie, tied, untie, use
153
154 =item Low-level socket functions
155
156 accept, bind, connect, getpeername, getsockname,
157 getsockopt, listen, recv, send, setsockopt, shutdown,
158 socket, socketpair
159
160 =item System V interprocess communication functions
161
162 msgctl, msgget, msgrcv, msgsnd, semctl, semget, semop,
163 shmctl, shmget, shmread, shmwrite
164
165 =item Fetching user and group info
166
167 endgrent, endhostent, endnetent, endpwent, getgrent,
168 getgrgid, getgrnam, getlogin, getpwent, getpwnam,
169 getpwuid, setgrent, setpwent
170
171 =item Fetching network info
172
173 endprotoent, endservent, gethostbyaddr, gethostbyname,
174 gethostent, getnetbyaddr, getnetbyname, getnetent,
175 getprotobyname, getprotobynumber, getprotoent,
176 getservbyname, getservbyport, getservent, sethostent,
177 setnetent, setprotoent, setservent
178
179 =item Time-related functions
180
181 gmtime, localtime, time, times
182
183 =item Functions new in perl5
184
185 abs, bless, chomp, chr, exists, formline, glob, import, lc,
186 lcfirst, map, my, no, prototype, qx, qw, readline, readpipe,
187 ref, sub*, sysopen, tie, tied, uc, ucfirst, untie, use
188
189 * - C<sub> was a keyword in perl4, but in perl5 it is an
190 operator which can be used in expressions.
191
192 =item Functions obsoleted in perl5
193
194 dbmclose, dbmopen
195
196
197 =back
198
199 =head2 Alphabetical Listing of Perl Functions
200
201
202 =over 8
203
204 =item -X FILEHANDLE
205
206 =item -X EXPR
207
208 =item -X
209
210 A file test, where X is one of the letters listed below.  This unary
211 operator takes one argument, either a filename or a filehandle, and
212 tests the associated file to see if something is true about it.  If the
213 argument is omitted, tests $_, except for C<-t>, which tests STDIN.
214 Unless otherwise documented, it returns C<1> for TRUE and C<''> for FALSE, or
215 the undefined value if the file doesn't exist.  Despite the funny
216 names, precedence is the same as any other named unary operator, and
217 the argument may be parenthesized like any other unary operator.  The
218 operator may be any of:
219
220     -r  File is readable by effective uid/gid.
221     -w  File is writable by effective uid/gid.
222     -x  File is executable by effective uid/gid.
223     -o  File is owned by effective uid.
224
225     -R  File is readable by real uid/gid.
226     -W  File is writable by real uid/gid.
227     -X  File is executable by real uid/gid.
228     -O  File is owned by real uid.
229
230     -e  File exists.
231     -z  File has zero size.
232     -s  File has non-zero size (returns size).
233
234     -f  File is a plain file.
235     -d  File is a directory.
236     -l  File is a symbolic link.
237     -p  File is a named pipe (FIFO).
238     -S  File is a socket.
239     -b  File is a block special file.
240     -c  File is a character special file.
241     -t  Filehandle is opened to a tty.
242
243     -u  File has setuid bit set.
244     -g  File has setgid bit set.
245     -k  File has sticky bit set.
246
247     -T  File is a text file.
248     -B  File is a binary file (opposite of -T).
249
250     -M  Age of file in days when script started.
251     -A  Same for access time.
252     -C  Same for inode change time.
253
254 The interpretation of the file permission operators C<-r>, C<-R>, C<-w>,
255 C<-W>, C<-x> and C<-X> is based solely on the mode of the file and the
256 uids and gids of the user.  There may be other reasons you can't actually
257 read, write or execute the file.  Also note that, for the superuser,
258 C<-r>, C<-R>, C<-w> and C<-W> always return 1, and C<-x> and C<-X> return
259 1 if any execute bit is set in the mode.  Scripts run by the superuser may
260 thus need to do a stat() in order to determine the actual mode of the
261 file, or temporarily set the uid to something else.
262
263 Example:
264
265     while (<>) {
266         chop;
267         next unless -f $_;      # ignore specials
268         ...
269     }
270
271 Note that C<-s/a/b/> does not do a negated substitution.  Saying
272 C<-exp($foo)> still works as expected, however--only single letters
273 following a minus are interpreted as file tests.
274
275 The C<-T> and C<-B> switches work as follows.  The first block or so of the
276 file is examined for odd characters such as strange control codes or
277 characters with the high bit set.  If too many odd characters (E<gt>30%)
278 are found, it's a C<-B> file, otherwise it's a C<-T> file.  Also, any file
279 containing null in the first block is considered a binary file.  If C<-T>
280 or C<-B> is used on a filehandle, the current stdio buffer is examined
281 rather than the first block.  Both C<-T> and C<-B> return TRUE on a null
282 file, or a file at EOF when testing a filehandle.  Because you have to 
283 read a file to do the C<-T> test, on most occasions you want to use a C<-f>
284 against the file first, as in C<next unless -f $file && -T $file>.
285
286 If any of the file tests (or either the stat() or lstat() operators) are given the
287 special filehandle consisting of a solitary underline, then the stat
288 structure of the previous file test (or stat operator) is used, saving
289 a system call.  (This doesn't work with C<-t>, and you need to remember
290 that lstat() and C<-l> will leave values in the stat structure for the
291 symbolic link, not the real file.)  Example:
292
293     print "Can do.\n" if -r $a || -w _ || -x _;
294
295     stat($filename);
296     print "Readable\n" if -r _;
297     print "Writable\n" if -w _;
298     print "Executable\n" if -x _;
299     print "Setuid\n" if -u _;
300     print "Setgid\n" if -g _;
301     print "Sticky\n" if -k _;
302     print "Text\n" if -T _;
303     print "Binary\n" if -B _;
304
305 =item abs VALUE
306
307 Returns the absolute value of its argument.
308
309 =item accept NEWSOCKET,GENERICSOCKET
310
311 Accepts an incoming socket connect, just as the accept(2) system call
312 does.  Returns the packed address if it succeeded, FALSE otherwise.
313 See example in L<perlipc/"Sockets: Client/Server Communication">.
314
315 =item alarm SECONDS
316
317 Arranges to have a SIGALRM delivered to this process after the
318 specified number of seconds have elapsed.  (On some machines,
319 unfortunately, the elapsed time may be up to one second less than you
320 specified because of how seconds are counted.)  Only one timer may be
321 counting at once.  Each call disables the previous timer, and an
322 argument of 0 may be supplied to cancel the previous timer without
323 starting a new one.  The returned value is the amount of time remaining
324 on the previous timer.
325
326 For delays of finer granularity than one second, you may use Perl's
327 syscall() interface to access setitimer(2) if your system supports it, 
328 or else see L</select()> below.  It is not advised to intermix alarm() 
329 and sleep() calls.
330
331 =item atan2 Y,X
332
333 Returns the arctangent of Y/X in the range -PI to PI.
334
335 =item bind SOCKET,NAME
336
337 Binds a network address to a socket, just as the bind system call
338 does.  Returns TRUE if it succeeded, FALSE otherwise.  NAME should be a
339 packed address of the appropriate type for the socket.  See the examples in
340 L<perlipc/"Sockets: Client/Server Communication">.
341
342 =item binmode FILEHANDLE
343
344 Arranges for the file to be read or written in "binary" mode in operating
345 systems that distinguish between binary and text files.  Files that are
346 not in binary mode have CR LF sequences translated to LF on input and LF
347 translated to CR LF on output.  Binmode has no effect under Unix; in DOS
348 and similarly archaic systems, it may be imperative--otherwise your
349 DOS-damaged C library may mangle your file.  The key distinction between
350 systems that need binmode and those that don't is their text file
351 formats.  Systems like Unix and Plan9 that delimit lines with a single
352 character, and that encode that character in C as '\n', do not need
353 C<binmode>.  The rest need it.  If FILEHANDLE is an expression, the value
354 is taken as the name of the filehandle.
355
356 =item bless REF,CLASSNAME
357
358 =item bless REF
359
360 This function tells the referenced object (passed as REF) that it is now
361 an object in the CLASSNAME package--or the current package if no CLASSNAME
362 is specified, which is often the case.  It returns the reference for
363 convenience, since a bless() is often the last thing in a constructor.
364 Always use the two-argument version if the function doing the blessing
365 might be inherited by a derived class.  See L<perlobj> for more about the
366 blessing (and blessings) of objects.
367
368 =item caller EXPR
369
370 =item caller
371
372 Returns the context of the current subroutine call.  In a scalar context,
373 returns TRUE if there is a caller, that is, if we're in a subroutine or
374 eval() or require(), and FALSE otherwise.  In a list context, returns
375
376     ($package, $filename, $line) = caller;
377
378 With EXPR, it returns some extra information that the debugger uses to
379 print a stack trace.  The value of EXPR indicates how many call frames
380 to go back before the current one.
381
382     ($package, $filename, $line,
383      $subroutine, $hasargs, $wantargs) = caller($i);
384
385 Furthermore, when called from within the DB package, caller returns more
386 detailed information: it sets the list variable @DB::args to be the
387 arguments with which that subroutine was invoked.
388
389 =item chdir EXPR
390
391 Changes the working directory to EXPR, if possible.  If EXPR is
392 omitted, changes to home directory.  Returns TRUE upon success, FALSE
393 otherwise.  See example under die().
394
395 =item chmod LIST
396
397 Changes the permissions of a list of files.  The first element of the
398 list must be the numerical mode, which should probably be an octal
399 number.  Returns the number of files successfully changed.
400
401     $cnt = chmod 0755, 'foo', 'bar';
402     chmod 0755, @executables;
403
404 =item chomp VARIABLE
405
406 =item chomp LIST
407
408 =item chomp
409
410 This is a slightly safer version of chop (see below).  It removes any
411 line ending that corresponds to the current value of C<$/> (also known as
412 $INPUT_RECORD_SEPARATOR in the C<English> module).  It returns the number
413 of characters removed.  It's often used to remove the newline from the
414 end of an input record when you're worried that the final record may be
415 missing its newline.  When in paragraph mode (C<$/ = "">), it removes all
416 trailing newlines from the string.  If VARIABLE is omitted, it chomps
417 $_.  Example:
418
419     while (<>) {
420         chomp;  # avoid \n on last field
421         @array = split(/:/);
422         ...
423     }
424
425 You can actually chomp anything that's an lvalue, including an assignment:
426
427     chomp($cwd = `pwd`);
428     chomp($answer = <STDIN>);
429
430 If you chomp a list, each element is chomped, and the total number of
431 characters removed is returned.
432
433 =item chop VARIABLE
434
435 =item chop LIST
436
437 =item chop
438
439 Chops off the last character of a string and returns the character
440 chopped.  It's used primarily to remove the newline from the end of an
441 input record, but is much more efficient than C<s/\n//> because it neither
442 scans nor copies the string.  If VARIABLE is omitted, chops $_.
443 Example:
444
445     while (<>) {
446         chop;   # avoid \n on last field
447         @array = split(/:/);
448         ...
449     }
450
451 You can actually chop anything that's an lvalue, including an assignment:
452
453     chop($cwd = `pwd`);
454     chop($answer = <STDIN>);
455
456 If you chop a list, each element is chopped.  Only the value of the
457 last chop is returned.
458
459 Note that chop returns the last character.  To return all but the last
460 character, use C<substr($string, 0, -1)>.
461
462 =item chown LIST
463
464 Changes the owner (and group) of a list of files.  The first two
465 elements of the list must be the I<NUMERICAL> uid and gid, in that order.
466 Returns the number of files successfully changed.
467
468     $cnt = chown $uid, $gid, 'foo', 'bar';
469     chown $uid, $gid, @filenames;
470
471 Here's an example that looks up non-numeric uids in the passwd file:
472
473     print "User: ";
474     chop($user = <STDIN>);
475     print "Files: "
476     chop($pattern = <STDIN>);
477
478     ($login,$pass,$uid,$gid) = getpwnam($user)
479         or die "$user not in passwd file";
480
481     @ary = <${pattern}>;        # expand filenames
482     chown $uid, $gid, @ary;
483
484 On most systems, you are not allowed to change the ownership of the 
485 file unless you're the superuser, although you should be able to change
486 the group to any of your secondary groups.  On insecure systems, these
487 restrictions may be relaxed, but this is not a portable assumption.
488
489 =item chr NUMBER
490
491 Returns the character represented by that NUMBER in the character set.
492 For example, C<chr(65)> is "A" in ASCII.
493
494 =item chroot FILENAME
495
496 This function works as the system call by the same name: it makes the
497 named directory the new root directory for all further pathnames that
498 begin with a "/" by your process and all of its children.  (It doesn't
499 change your current working directory is unaffected.)  For security
500 reasons, this call is restricted to the superuser.  If FILENAME is
501 omitted, does chroot to $_.
502
503 =item close FILEHANDLE
504
505 Closes the file or pipe associated with the file handle, returning TRUE
506 only if stdio successfully flushes buffers and closes the system file
507 descriptor.  You don't have to close FILEHANDLE if you are immediately
508 going to do another open() on it, since open() will close it for you.  (See
509 open().)  However, an explicit close on an input file resets the line
510 counter ($.), while the implicit close done by open() does not.  Also,
511 closing a pipe will wait for the process executing on the pipe to
512 complete, in case you want to look at the output of the pipe
513 afterwards.  Closing a pipe explicitly also puts the status value of
514 the command into C<$?>.  Example:
515
516     open(OUTPUT, '|sort >foo'); # pipe to sort
517     ...                         # print stuff to output
518     close OUTPUT;               # wait for sort to finish
519     open(INPUT, 'foo');         # get sort's results
520
521 FILEHANDLE may be an expression whose value gives the real filehandle name.
522
523 =item closedir DIRHANDLE
524
525 Closes a directory opened by opendir().
526
527 =item connect SOCKET,NAME
528
529 Attempts to connect to a remote socket, just as the connect system call
530 does.  Returns TRUE if it succeeded, FALSE otherwise.  NAME should be a
531 packed address of the appropriate type for the socket.  See the examples in
532 L<perlipc/"Sockets: Client/Server Communication">.
533
534 =item continue BLOCK
535
536 Actually a flow control statement rather than a function.  If there is a
537 C<continue> BLOCK attached to a BLOCK (typically in a C<while> or
538 C<foreach>), it is always executed just before the conditional is about to
539 be evaluated again, just like the third part of a C<for> loop in C.  Thus
540 it can be used to increment a loop variable, even when the loop has been
541 continued via the C<next> statement (which is similar to the C C<continue>
542 statement).
543
544 =item cos EXPR
545
546 Returns the cosine of EXPR (expressed in radians).  If EXPR is omitted
547 takes cosine of $_.
548
549 =item crypt PLAINTEXT,SALT
550
551 Encrypts a string exactly like the crypt(3) function in the C library
552 (assuming that you actually have a version there that has not been
553 extirpated as a potential munition).  This can prove useful for checking
554 the password file for lousy passwords, amongst other things.  Only the
555 guys wearing white hats should do this.
556
557 Here's an example that makes sure that whoever runs this program knows
558 their own password:
559
560     $pwd = (getpwuid($<))[1];
561     $salt = substr($pwd, 0, 2);
562
563     system "stty -echo";
564     print "Password: ";
565     chop($word = <STDIN>);
566     print "\n";
567     system "stty echo";
568
569     if (crypt($word, $salt) ne $pwd) {
570         die "Sorry...\n";
571     } else {
572         print "ok\n";
573     } 
574
575 Of course, typing in your own password to whoever asks you 
576 for it is unwise.
577
578 =item dbmclose ASSOC_ARRAY
579
580 [This function has been superseded by the untie() function.]
581
582 Breaks the binding between a DBM file and an associative array.
583
584 =item dbmopen ASSOC,DBNAME,MODE
585
586 [This function has been superseded by the tie() function.]
587
588 This binds a dbm(3), ndbm(3), sdbm(3), gdbm(), or Berkeley DB file to an
589 associative array.  ASSOC is the name of the associative array.  (Unlike
590 normal open, the first argument is I<NOT> a filehandle, even though it
591 looks like one).  DBNAME is the name of the database (without the F<.dir>
592 or F<.pag> extension if any).  If the database does not exist, it is
593 created with protection specified by MODE (as modified by the umask()).
594 If your system only supports the older DBM functions, you may perform only
595 one dbmopen() in your program.  In older versions of Perl, if your system
596 had neither DBM nor ndbm, calling dbmopen() produced a fatal error; it now
597 falls back to sdbm(3).
598
599 If you don't have write access to the DBM file, you can only read
600 associative array variables, not set them.  If you want to test whether
601 you can write, either use file tests or try setting a dummy array entry
602 inside an eval(), which will trap the error.
603
604 Note that functions such as keys() and values() may return huge array
605 values when used on large DBM files.  You may prefer to use the each()
606 function to iterate over large DBM files.  Example:
607
608     # print out history file offsets
609     dbmopen(%HIST,'/usr/lib/news/history',0666);
610     while (($key,$val) = each %HIST) {
611         print $key, ' = ', unpack('L',$val), "\n";
612     }
613     dbmclose(%HIST);
614
615 See also L<AnyDBM_File> for a more general description of the pros and
616 cons of the various dbm approaches, as well as L<DB_File> for a particularly
617 rich implementation.
618
619 =item defined EXPR
620
621 Returns a boolean value saying whether EXPR has a real value
622 or not.  Many operations return the undefined value under exceptional
623 conditions, such as end of file, uninitialized variable, system error
624 and such.  This function allows you to distinguish between an undefined
625 null scalar and a defined null scalar with operations that might return
626 a real null string, such as referencing elements of an array.  You may
627 also check to see if arrays or subroutines exist.  Use of defined on
628 predefined variables is not guaranteed to produce intuitive results.
629
630 When used on a hash array element, it tells you whether the value
631 is defined, not whether the key exists in the hash.  Use exists() for that.
632
633 Examples:
634
635     print if defined $switch{'D'};
636     print "$val\n" while defined($val = pop(@ary));
637     die "Can't readlink $sym: $!"
638         unless defined($value = readlink $sym);
639     eval '@foo = ()' if defined(@foo);
640     die "No XYZ package defined" unless defined %_XYZ;
641     sub foo { defined &$bar ? &$bar(@_) : die "No bar"; }
642
643 See also undef().
644
645 Note: many folks tend to overuse defined(), and then are surprised to
646 discover that the number 0 and the null string are, in fact, defined
647 concepts.  For example, if you say
648
649     "ab" =~ /a(.*)b/;
650
651 the pattern match succeeds, and $1 is defined, despite the fact that it
652 matched "nothing".  But it didn't really match nothing--rather, it
653 matched something that happened to be 0 characters long.  This is all
654 very above-board and honest.  When a function returns an undefined value,
655 it's an admission that it couldn't give you an honest answer.  So
656 you should only use defined() when you're questioning the integrity
657 of what you're trying to do.  At other times, a simple comparison to
658 0 or "" is what you want.
659
660 =item delete EXPR
661
662 Deletes the specified value from its hash array.  Returns the deleted
663 value, or the undefined value if nothing was deleted.  Deleting from
664 C<$ENV{}> modifies the environment.  Deleting from an array tied to a DBM
665 file deletes the entry from the DBM file.  (But deleting from a tie()d
666 hash doesn't necessarily return anything.)
667
668 The following deletes all the values of an associative array:
669
670     foreach $key (keys %ARRAY) {
671         delete $ARRAY{$key};
672     }
673
674 (But it would be faster to use the undef() command.)  Note that the
675 EXPR can be arbitrarily complicated as long as the final operation is
676 a hash key lookup:
677
678     delete $ref->[$x][$y]{$key};
679
680 =item die LIST
681
682 Outside of an eval(), prints the value of LIST to C<STDERR> and exits with
683 the current value of C<$!> (errno).  If C<$!> is 0, exits with the value of
684 C<($? E<gt>E<gt> 8)> (backtick `command` status).  If C<($? E<gt>E<gt> 8)> is 0,
685 exits with 255.  Inside an eval(), the error message is stuffed into C<$@>,
686 and the eval() is terminated with the undefined value; this makes die()
687 the way to raise an exception.
688
689 Equivalent examples:
690
691     die "Can't cd to spool: $!\n" unless chdir '/usr/spool/news';
692     chdir '/usr/spool/news' or die "Can't cd to spool: $!\n" 
693
694 If the value of EXPR does not end in a newline, the current script line
695 number and input line number (if any) are also printed, and a newline
696 is supplied.  Hint: sometimes appending ", stopped" to your message
697 will cause it to make better sense when the string "at foo line 123" is
698 appended.  Suppose you are running script "canasta".
699
700     die "/etc/games is no good";
701     die "/etc/games is no good, stopped";
702
703 produce, respectively
704
705     /etc/games is no good at canasta line 123.
706     /etc/games is no good, stopped at canasta line 123.
707
708 See also exit() and warn().
709
710 =item do BLOCK
711
712 Not really a function.  Returns the value of the last command in the
713 sequence of commands indicated by BLOCK.  When modified by a loop
714 modifier, executes the BLOCK once before testing the loop condition.
715 (On other statements the loop modifiers test the conditional first.)
716
717 =item do SUBROUTINE(LIST)
718
719 A deprecated form of subroutine call.  See L<perlsub>.
720
721 =item do EXPR
722
723 Uses the value of EXPR as a filename and executes the contents of the
724 file as a Perl script.  Its primary use is to include subroutines
725 from a Perl subroutine library.
726
727     do 'stat.pl';
728
729 is just like
730
731     eval `cat stat.pl`;
732
733 except that it's more efficient, more concise, keeps track of the
734 current filename for error messages, and searches all the B<-I>
735 libraries if the file isn't in the current directory (see also the @INC
736 array in L<perlvar/Predefined Names>).  It's the same, however, in that it does
737 reparse the file every time you call it, so you probably don't want to
738 do this inside a loop.
739
740 Note that inclusion of library modules is better done with the
741 use() and require() operators, which also do error checking
742 and raise an exception if there's a problem.
743
744 =item dump LABEL
745
746 This causes an immediate core dump.  Primarily this is so that you can
747 use the B<undump> program to turn your core dump into an executable binary
748 after having initialized all your variables at the beginning of the
749 program.  When the new binary is executed it will begin by executing a
750 C<goto LABEL> (with all the restrictions that C<goto> suffers).  Think of
751 it as a goto with an intervening core dump and reincarnation.  If LABEL
752 is omitted, restarts the program from the top.  WARNING: any files
753 opened at the time of the dump will NOT be open any more when the
754 program is reincarnated, with possible resulting confusion on the part
755 of Perl.  See also B<-u> option in L<perlrun>.
756
757 Example:
758
759     #!/usr/bin/perl
760     require 'getopt.pl';
761     require 'stat.pl';
762     %days = (
763         'Sun' => 1,
764         'Mon' => 2,
765         'Tue' => 3,
766         'Wed' => 4,
767         'Thu' => 5,
768         'Fri' => 6,
769         'Sat' => 7,
770     );
771
772     dump QUICKSTART if $ARGV[0] eq '-d';
773
774     QUICKSTART:
775     Getopt('f');
776
777 =item each ASSOC_ARRAY
778
779 When called in a list context, returns a 2-element array consisting
780 of the key and value for the next element of an associative array,
781 so that you can iterate over it.  When called in a scalar context,
782 returns the key only for the next element in the associative array.
783 Entries are returned in an apparently random order.  When the array is
784 entirely read, a null array is returned in list context (which when
785 assigned produces a FALSE (0) value), and C<undef> is returned in a
786 scalar context.  The next call to each() after that will start
787 iterating again.  The iterator can be reset only by reading all the
788 elements from the array.  You should not add elements to an array while
789 you're iterating over it.  There is a single iterator for each
790 associative array, shared by all each(), keys() and values() function
791 calls in the program.  The following prints out your environment like
792 the printenv(1) program, only in a different order:
793
794     while (($key,$value) = each %ENV) {
795         print "$key=$value\n";
796     }
797
798 See also keys() and values().
799
800 =item eof FILEHANDLE
801
802 =item eof ()
803
804 =item eof
805
806 Returns 1 if the next read on FILEHANDLE will return end of file, or if
807 FILEHANDLE is not open.  FILEHANDLE may be an expression whose value
808 gives the real filehandle name.  (Note that this function actually
809 reads a character and then ungetc()s it, so it is not very useful in an
810 interactive context.)  Do not read from a terminal file (or call
811 C<eof(FILEHANDLE)> on it) after end-of-file is reached.  Filetypes such
812 as terminals may lose the end-of-file condition if you do.
813
814 An C<eof> without an argument uses the last file read as argument.
815 Empty parentheses () may be used to indicate
816 the pseudofile formed of the files listed on the command line, i.e.
817 C<eof()> is reasonable to use inside a while (E<lt>E<gt>) loop to detect the end
818 of only the last file.  Use C<eof(ARGV)> or eof without the parentheses to
819 test I<EACH> file in a while (E<lt>E<gt>) loop.  Examples:
820
821     # reset line numbering on each input file
822     while (<>) {
823         print "$.\t$_";
824         close(ARGV) if (eof);   # Not eof().
825     }
826
827     # insert dashes just before last line of last file
828     while (<>) {
829         if (eof()) {
830             print "--------------\n";
831             close(ARGV);        # close or break; is needed if we
832                                 # are reading from the terminal
833         }
834         print;
835     }
836
837 Practical hint: you almost never need to use C<eof> in Perl, because the
838 input operators return undef when they run out of data.  
839
840 =item eval EXPR
841
842 =item eval BLOCK
843
844 EXPR is parsed and executed as if it were a little Perl program.  It
845 is executed in the context of the current Perl program, so that any
846 variable settings, subroutine or format definitions remain afterwards.
847 The value returned is the value of the last expression evaluated, or a
848 return statement may be used, just as with subroutines.
849
850 If there is a syntax error or runtime error, or a die() statement is
851 executed, an undefined value is returned by eval(), and C<$@> is set to the
852 error message.  If there was no error, C<$@> is guaranteed to be a null
853 string.  If EXPR is omitted, evaluates $_.  The final semicolon, if
854 any, may be omitted from the expression.
855
856 Note that, since eval() traps otherwise-fatal errors, it is useful for
857 determining whether a particular feature (such as socket() or symlink())
858 is implemented.  It is also Perl's exception trapping mechanism, where
859 the die operator is used to raise exceptions.
860
861 If the code to be executed doesn't vary, you may use the eval-BLOCK
862 form to trap run-time errors without incurring the penalty of
863 recompiling each time.  The error, if any, is still returned in C<$@>.
864 Examples:
865
866     # make divide-by-zero non-fatal
867     eval { $answer = $a / $b; }; warn $@ if $@;
868
869     # same thing, but less efficient
870     eval '$answer = $a / $b'; warn $@ if $@;
871
872     # a compile-time error
873     eval { $answer = };
874
875     # a run-time error
876     eval '$answer =';   # sets $@
877
878 With an eval(), you should be especially careful to remember what's 
879 being looked at when:
880
881     eval $x;            # CASE 1
882     eval "$x";          # CASE 2
883
884     eval '$x';          # CASE 3
885     eval { $x };        # CASE 4
886
887     eval "\$$x++"       # CASE 5
888     $$x++;              # CASE 6
889
890 Cases 1 and 2 above behave identically: they run the code contained in the
891 variable $x.  (Although case 2 has misleading double quotes making the
892 reader wonder what else might be happening (nothing is).) Cases 3 and 4
893 likewise behave in the same way: they run the code E<lt>$xE<gt>, which does
894 nothing at all.  (Case 4 is preferred for purely visual reasons.) Case 5
895 is a place where normally you I<WOULD> like to use double quotes, except
896 that in that particular situation, you can just use symbolic references
897 instead, as in case 6.
898
899 =item exec LIST
900
901 The exec() function executes a system command I<AND NEVER RETURNS>.  Use
902 the system() function if you want it to return.
903
904 If there is more than one argument in LIST, or if LIST is an array with
905 more than one value, calls execvp(3) with the arguments in LIST.  If
906 there is only one scalar argument, the argument is checked for shell
907 metacharacters.  If there are any, the entire argument is passed to
908 C</bin/sh -c> for parsing.  If there are none, the argument is split
909 into words and passed directly to execvp(), which is more efficient.
910 Note: exec() and system() do not flush your output buffer, so you may
911 need to set C<$|> to avoid lost output.  Examples:
912
913     exec '/bin/echo', 'Your arguments are: ', @ARGV;
914     exec "sort $outfile | uniq";
915
916 If you don't really want to execute the first argument, but want to lie
917 to the program you are executing about its own name, you can specify
918 the program you actually want to run as an "indirect object" (without a
919 comma) in front of the LIST.  (This always forces interpretation of the
920 LIST as a multi-valued list, even if there is only a single scalar in
921 the list.)  Example:
922
923     $shell = '/bin/csh';
924     exec $shell '-sh';          # pretend it's a login shell
925
926 or, more directly,
927
928     exec {'/bin/csh'} '-sh';    # pretend it's a login shell
929
930 =item exists EXPR
931
932 Returns TRUE if the specified hash key exists in its hash array, even
933 if the corresponding value is undefined.
934
935     print "Exists\n" if exists $array{$key};
936     print "Defined\n" if defined $array{$key};
937     print "True\n" if $array{$key};
938
939 A hash element can only be TRUE if it's defined, and defined if
940 it exists, but the reverse doesn't necessarily hold true.
941
942 Note that the EXPR can be arbitrarily complicated as long as the final
943 operation is a hash key lookup:
944
945     if (exists $ref->[$x][$y]{$key}) { ... }
946
947 =item exit EXPR
948
949 Evaluates EXPR and exits immediately with that value.  (Actually, it
950 calls any defined C<END> routines first, but the C<END> routines may not
951 abort the exit.  Likewise any object destructors that need to be called
952 are called before exit.)  Example:
953
954     $ans = <STDIN>;
955     exit 0 if $ans =~ /^[Xx]/;
956
957 See also die().  If EXPR is omitted, exits with 0 status.
958
959 =item exp EXPR
960
961 Returns I<e> (the natural logarithm base) to the power of EXPR.  
962 If EXPR is omitted, gives C<exp($_)>.
963
964 =item fcntl FILEHANDLE,FUNCTION,SCALAR
965
966 Implements the fcntl(2) function.  You'll probably have to say
967
968     use Fcntl;
969
970 first to get the correct function definitions.  Argument processing and
971 value return works just like ioctl() below.  Note that fcntl() will produce
972 a fatal error if used on a machine that doesn't implement fcntl(2).
973 For example:
974
975     use Fcntl;
976     fcntl($filehandle, F_GETLK, $packed_return_buffer);
977
978 =item fileno FILEHANDLE
979
980 Returns the file descriptor for a filehandle.  This is useful for
981 constructing bitmaps for select().  If FILEHANDLE is an expression, the
982 value is taken as the name of the filehandle.
983
984 =item flock FILEHANDLE,OPERATION
985
986 Calls flock(2) on FILEHANDLE.  See L<flock(2)> for definition of
987 OPERATION.  Returns TRUE for success, FALSE on failure.  Will produce a
988 fatal error if used on a machine that doesn't implement either flock(2) or
989 fcntl(2). The fcntl(2) system call will be automatically used if flock(2)
990 is missing from your system.  This makes flock() the portable file locking
991 strategy, although it will only lock entire files, not records.  Note also
992 that some versions of flock() cannot lock things over the network; you
993 would need to use the more system-specific fcntl() for that.
994
995 Here's a mailbox appender for BSD systems.
996
997     $LOCK_SH = 1;
998     $LOCK_EX = 2;
999     $LOCK_NB = 4;
1000     $LOCK_UN = 8;
1001
1002     sub lock {
1003         flock(MBOX,$LOCK_EX);
1004         # and, in case someone appended
1005         # while we were waiting...
1006         seek(MBOX, 0, 2);
1007     }
1008
1009     sub unlock {
1010         flock(MBOX,$LOCK_UN);
1011     }
1012
1013     open(MBOX, ">>/usr/spool/mail/$ENV{'USER'}")
1014             or die "Can't open mailbox: $!";
1015
1016     lock();
1017     print MBOX $msg,"\n\n";
1018     unlock();
1019
1020 See also L<DB_File> for other flock() examples.
1021
1022 =item fork
1023
1024 Does a fork(2) system call.  Returns the child pid to the parent process
1025 and 0 to the child process, or C<undef> if the fork is unsuccessful.
1026 Note: unflushed buffers remain unflushed in both processes, which means
1027 you may need to set C<$|> ($AUTOFLUSH in English) or call the 
1028 autoflush() FileHandle method to avoid duplicate output.
1029
1030 If you fork() without ever waiting on your children, you will accumulate
1031 zombies:
1032
1033     $SIG{CHLD} = sub { wait };
1034
1035 There's also the double-fork trick (error checking on 
1036 fork() returns omitted);
1037
1038     unless ($pid = fork) {
1039         unless (fork) {
1040             exec "what you really wanna do";
1041             die "no exec";
1042             # ... or ...
1043             ## (some_perl_code_here)
1044             exit 0;
1045         }
1046         exit 0;
1047     }
1048     waitpid($pid,0);
1049
1050 See also L<perlipc> for more examples of forking and reaping
1051 moribund children.
1052
1053 =item format
1054
1055 Declare a picture format with use by the write() function.  For
1056 example:
1057
1058     format Something = 
1059         Test: @<<<<<<<< @||||| @>>>>>
1060               $str,     $%,    '$' . int($num)
1061     .
1062
1063     $str = "widget";
1064     $num = $cost/$quantity;
1065     $~ = 'Something';
1066     write;
1067
1068 See L<perlform> for many details and examples.
1069
1070
1071 =item formline PICTURE, LIST
1072
1073 This is an internal function used by C<format>s, though you may call it
1074 too.  It formats (see L<perlform>) a list of values according to the
1075 contents of PICTURE, placing the output into the format output
1076 accumulator, C<$^A> (or $ACCUMULATOR in English).
1077 Eventually, when a write() is done, the contents of
1078 C<$^A> are written to some filehandle, but you could also read C<$^A>
1079 yourself and then set C<$^A> back to "".  Note that a format typically
1080 does one formline() per line of form, but the formline() function itself
1081 doesn't care how many newlines are embedded in the PICTURE.  This means
1082 that the C<~> and C<~~> tokens will treat the entire PICTURE as a single line.
1083 You may therefore need to use multiple formlines to implement a single
1084 record format, just like the format compiler.
1085
1086 Be careful if you put double quotes around the picture, since an "C<@>"
1087 character may be taken to mean the beginning of an array name.
1088 formline() always returns TRUE.  See L<perlform> for other examples.
1089
1090 =item getc FILEHANDLE
1091
1092 =item getc
1093
1094 Returns the next character from the input file attached to FILEHANDLE,
1095 or a null string at end of file.  If FILEHANDLE is omitted, reads from STDIN.
1096 This is not particularly efficient.  It cannot be used to get unbuffered
1097 single-characters, however.  For that, try something more like:
1098
1099     if ($BSD_STYLE) {
1100         system "stty cbreak </dev/tty >/dev/tty 2>&1";
1101     }
1102     else {
1103         system "stty", '-icanon', 'eol', "\001"; 
1104     }
1105
1106     $key = getc(STDIN);
1107
1108     if ($BSD_STYLE) {
1109         system "stty -cbreak </dev/tty >/dev/tty 2>&1";
1110     }
1111     else {
1112         system "stty", 'icanon', 'eol', '^@'; # ascii null
1113     }
1114     print "\n";
1115
1116 Determination of whether to whether $BSD_STYLE should be set 
1117 is left as an exercise to the reader.  
1118
1119 See also the C<Term::ReadKey> module from your nearest CPAN site;
1120 details on CPAN can be found on L<perlmod/CPAN> 
1121
1122 =item getlogin
1123
1124 Returns the current login from F</etc/utmp>, if any.  If null, use
1125 getpwuid().  
1126
1127     $login = getlogin || (getpwuid($<))[0] || "Kilroy";
1128
1129 Do not consider getlogin() for authentication: it is not as
1130 secure as getpwuid().
1131
1132 =item getpeername SOCKET
1133
1134 Returns the packed sockaddr address of other end of the SOCKET connection.
1135
1136     use Socket;
1137     $hersockaddr    = getpeername(SOCK);
1138     ($port, $iaddr) = unpack_sockaddr_in($hersockaddr);
1139     $herhostname    = gethostbyaddr($iaddr, AF_INET);
1140     $herstraddr     = inet_ntoa($iaddr);
1141
1142 =item getpgrp PID
1143
1144 Returns the current process group for the specified PID.  Use
1145 a PID of 0 to get the current process group for the
1146 current process.  Will raise an exception if used on a machine that
1147 doesn't implement getpgrp(2).  If PID is omitted, returns process
1148 group of current process.  Note that the POSIX version of getpgrp()
1149 does not accept a PID argument, so only PID==0 is truly portable.
1150
1151 =item getppid
1152
1153 Returns the process id of the parent process.
1154
1155 =item getpriority WHICH,WHO
1156
1157 Returns the current priority for a process, a process group, or a user.
1158 (See L<getpriority(2)>.)  Will raise a fatal exception if used on a
1159 machine that doesn't implement getpriority(2).
1160
1161 =item getpwnam NAME
1162
1163 =item getgrnam NAME
1164
1165 =item gethostbyname NAME
1166
1167 =item getnetbyname NAME
1168
1169 =item getprotobyname NAME
1170
1171 =item getpwuid UID
1172
1173 =item getgrgid GID
1174
1175 =item getservbyname NAME,PROTO
1176
1177 =item gethostbyaddr ADDR,ADDRTYPE
1178
1179 =item getnetbyaddr ADDR,ADDRTYPE
1180
1181 =item getprotobynumber NUMBER
1182
1183 =item getservbyport PORT,PROTO
1184
1185 =item getpwent
1186
1187 =item getgrent
1188
1189 =item gethostent
1190
1191 =item getnetent
1192
1193 =item getprotoent
1194
1195 =item getservent
1196
1197 =item setpwent
1198
1199 =item setgrent
1200
1201 =item sethostent STAYOPEN
1202
1203 =item setnetent STAYOPEN
1204
1205 =item setprotoent STAYOPEN
1206
1207 =item setservent STAYOPEN
1208
1209 =item endpwent
1210
1211 =item endgrent
1212
1213 =item endhostent
1214
1215 =item endnetent
1216
1217 =item endprotoent
1218
1219 =item endservent
1220
1221 These routines perform the same functions as their counterparts in the
1222 system library.  Within a list context, the return values from the
1223 various get routines are as follows:
1224
1225     ($name,$passwd,$uid,$gid,
1226        $quota,$comment,$gcos,$dir,$shell) = getpw*
1227     ($name,$passwd,$gid,$members) = getgr*
1228     ($name,$aliases,$addrtype,$length,@addrs) = gethost*
1229     ($name,$aliases,$addrtype,$net) = getnet*
1230     ($name,$aliases,$proto) = getproto*
1231     ($name,$aliases,$port,$proto) = getserv*
1232
1233 (If the entry doesn't exist you get a null list.)
1234
1235 Within a scalar context, you get the name, unless the function was a
1236 lookup by name, in which case you get the other thing, whatever it is.
1237 (If the entry doesn't exist you get the undefined value.)  For example:
1238
1239     $uid = getpwnam
1240     $name = getpwuid
1241     $name = getpwent
1242     $gid = getgrnam
1243     $name = getgrgid
1244     $name = getgrent
1245     etc.
1246
1247 The $members value returned by I<getgr*()> is a space separated list of
1248 the login names of the members of the group.
1249
1250 For the I<gethost*()> functions, if the C<h_errno> variable is supported in
1251 C, it will be returned to you via C<$?> if the function call fails.  The
1252 @addrs value returned by a successful call is a list of the raw
1253 addresses returned by the corresponding system library call.  In the
1254 Internet domain, each address is four bytes long and you can unpack it
1255 by saying something like:
1256
1257     ($a,$b,$c,$d) = unpack('C4',$addr[0]);
1258
1259 =item getsockname SOCKET
1260
1261 Returns the packed sockaddr address of this end of the SOCKET connection.
1262
1263     use Socket;
1264     $mysockaddr = getsockname(SOCK);
1265     ($port, $myaddr) = unpack_sockaddr_in($mysockaddr);
1266
1267 =item getsockopt SOCKET,LEVEL,OPTNAME
1268
1269 Returns the socket option requested, or undefined if there is an error.
1270
1271 =item glob EXPR
1272
1273 Returns the value of EXPR with filename expansions such as a shell
1274 would do.  This is the internal function implementing the E<lt>*.*E<gt>
1275 operator, except it's easier to use.
1276
1277 =item gmtime EXPR
1278
1279 Converts a time as returned by the time function to a 9-element array
1280 with the time localized for the standard Greenwich timezone.  
1281 Typically used as follows:
1282
1283
1284     ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
1285                                             gmtime(time);
1286
1287 All array elements are numeric, and come straight out of a struct tm.
1288 In particular this means that $mon has the range 0..11 and $wday has
1289 the range 0..6.  If EXPR is omitted, does C<gmtime(time())>.
1290
1291 =item goto LABEL
1292
1293 =item goto EXPR
1294
1295 =item goto &NAME
1296
1297 The goto-LABEL form finds the statement labeled with LABEL and resumes
1298 execution there.  It may not be used to go into any construct that
1299 requires initialization, such as a subroutine or a foreach loop.  It
1300 also can't be used to go into a construct that is optimized away.  It
1301 can be used to go almost anywhere else within the dynamic scope,
1302 including out of subroutines, but it's usually better to use some other
1303 construct such as last or die.  The author of Perl has never felt the
1304 need to use this form of goto (in Perl, that is--C is another matter).
1305
1306 The goto-EXPR form expects a label name, whose scope will be resolved
1307 dynamically.  This allows for computed gotos per FORTRAN, but isn't
1308 necessarily recommended if you're optimizing for maintainability:
1309
1310     goto ("FOO", "BAR", "GLARCH")[$i];
1311
1312 The goto-&NAME form is highly magical, and substitutes a call to the
1313 named subroutine for the currently running subroutine.  This is used by
1314 AUTOLOAD subroutines that wish to load another subroutine and then
1315 pretend that the other subroutine had been called in the first place
1316 (except that any modifications to @_ in the current subroutine are
1317 propagated to the other subroutine.)  After the goto, not even caller()
1318 will be able to tell that this routine was called first.
1319
1320 =item grep BLOCK LIST
1321
1322 =item grep EXPR,LIST
1323
1324 Evaluates the BLOCK or EXPR for each element of LIST (locally setting
1325 $_ to each element) and returns the list value consisting of those
1326 elements for which the expression evaluated to TRUE.  In a scalar
1327 context, returns the number of times the expression was TRUE.
1328
1329     @foo = grep(!/^#/, @bar);    # weed out comments
1330
1331 or equivalently,
1332
1333     @foo = grep {!/^#/} @bar;    # weed out comments
1334
1335 Note that, since $_ is a reference into the list value, it can be used
1336 to modify the elements of the array.  While this is useful and
1337 supported, it can cause bizarre results if the LIST is not a named
1338 array.
1339
1340 =item hex EXPR
1341
1342 Interprets EXPR as a hex string and returns the corresponding decimal
1343 value.  (To convert strings that might start with 0 or 0x see
1344 oct().)  If EXPR is omitted, uses $_.
1345
1346 =item import
1347
1348 There is no built-in import() function.  It is merely an ordinary
1349 method (subroutine) defined (or inherited) by modules that wish to export
1350 names to another module.  The use() function calls the import() method
1351 for the package used.  See also L</use>, L<perlmod>, and L<Exporter>.
1352
1353 =item index STR,SUBSTR,POSITION
1354
1355 =item index STR,SUBSTR
1356
1357 Returns the position of the first occurrence of SUBSTR in STR at or after
1358 POSITION.  If POSITION is omitted, starts searching from the beginning of
1359 the string.  The return value is based at 0 (or whatever you've set the C<$[>
1360 variable to--but don't do that).  If the substring is not found, returns
1361 one less than the base, ordinarily -1.
1362
1363 =item int EXPR
1364
1365 Returns the integer portion of EXPR.  If EXPR is omitted, uses $_.
1366
1367 =item ioctl FILEHANDLE,FUNCTION,SCALAR
1368
1369 Implements the ioctl(2) function.  You'll probably have to say
1370
1371     require "ioctl.ph"; # probably in /usr/local/lib/perl/ioctl.ph
1372
1373 first to get the correct function definitions.  If F<ioctl.ph> doesn't
1374 exist or doesn't have the correct definitions you'll have to roll your
1375 own, based on your C header files such as F<E<lt>sys/ioctl.hE<gt>>.
1376 (There is a Perl script called B<h2ph> that comes with the Perl kit which
1377 may help you in this, but it's non-trivial.)  SCALAR will be read and/or
1378 written depending on the FUNCTION--a pointer to the string value of SCALAR
1379 will be passed as the third argument of the actual ioctl call.  (If SCALAR
1380 has no string value but does have a numeric value, that value will be
1381 passed rather than a pointer to the string value.  To guarantee this to be
1382 TRUE, add a 0 to the scalar before using it.)  The pack() and unpack()
1383 functions are useful for manipulating the values of structures used by
1384 ioctl().  The following example sets the erase character to DEL.
1385
1386     require 'ioctl.ph';
1387     $getp = &TIOCGETP;
1388     die "NO TIOCGETP" if $@ || !$getp;
1389     $sgttyb_t = "ccccs";                # 4 chars and a short
1390     if (ioctl(STDIN,$getp,$sgttyb)) {
1391         @ary = unpack($sgttyb_t,$sgttyb);
1392         $ary[2] = 127;
1393         $sgttyb = pack($sgttyb_t,@ary);
1394         ioctl(STDIN,&TIOCSETP,$sgttyb)
1395             || die "Can't ioctl: $!";
1396     }
1397
1398 The return value of ioctl (and fcntl) is as follows:
1399
1400         if OS returns:          then Perl returns:
1401             -1                    undefined value
1402              0                  string "0 but true"
1403         anything else               that number
1404
1405 Thus Perl returns TRUE on success and FALSE on failure, yet you can
1406 still easily determine the actual value returned by the operating
1407 system:
1408
1409     ($retval = ioctl(...)) || ($retval = -1);
1410     printf "System returned %d\n", $retval;
1411
1412 =item join EXPR,LIST
1413
1414 Joins the separate strings of LIST or ARRAY into a single string with
1415 fields separated by the value of EXPR, and returns the string.
1416 Example:
1417
1418     $_ = join(':', $login,$passwd,$uid,$gid,$gcos,$home,$shell);
1419
1420 See L<perlfunc/split>.
1421
1422 =item keys ASSOC_ARRAY
1423
1424 Returns a normal array consisting of all the keys of the named
1425 associative array.  (In a scalar context, returns the number of keys.)
1426 The keys are returned in an apparently random order, but it is the same
1427 order as either the values() or each() function produces (given that
1428 the associative array has not been modified).  Here is yet another way
1429 to print your environment:
1430
1431     @keys = keys %ENV;
1432     @values = values %ENV;
1433     while ($#keys >= 0) {
1434         print pop(@keys), '=', pop(@values), "\n";
1435     }
1436
1437 or how about sorted by key:
1438
1439     foreach $key (sort(keys %ENV)) {
1440         print $key, '=', $ENV{$key}, "\n";
1441     }
1442
1443 To sort an array by value, you'll need to use a C<sort{}>
1444 function.  Here's a descending numeric sort of a hash by its values:
1445
1446     foreach $key (sort { $hash{$b} <=> $hash{$a} } keys %hash)) {
1447         printf "%4d %s\n", $hash{$key}, $key;
1448     }
1449
1450 =item kill LIST
1451
1452 Sends a signal to a list of processes.  The first element of 
1453 the list must be the signal to send.  Returns the number of 
1454 processes successfully signaled.
1455
1456     $cnt = kill 1, $child1, $child2;
1457     kill 9, @goners;
1458
1459 Unlike in the shell, in Perl if the I<SIGNAL> is negative, it kills
1460 process groups instead of processes.  (On System V, a negative I<PROCESS>
1461 number will also kill process groups, but that's not portable.)  That
1462 means you usually want to use positive not negative signals.  You may also
1463 use a signal name in quotes.  See L<perlipc/"Signals"> for details.
1464
1465 =item last LABEL
1466
1467 =item last
1468
1469 The C<last> command is like the C<break> statement in C (as used in
1470 loops); it immediately exits the loop in question.  If the LABEL is
1471 omitted, the command refers to the innermost enclosing loop.  The
1472 C<continue> block, if any, is not executed:
1473
1474     LINE: while (<STDIN>) {
1475         last LINE if /^$/;      # exit when done with header
1476         ...
1477     }
1478
1479 =item lc EXPR
1480
1481 Returns an lowercased version of EXPR.  This is the internal function
1482 implementing the \L escape in double-quoted strings.  
1483 Should respect any POSIX setlocale() settings.
1484
1485 =item lcfirst EXPR
1486
1487 Returns the value of EXPR with the first character lowercased.  This is
1488 the internal function implementing the \l escape in double-quoted strings.
1489 Should respect any POSIX setlocale() settings.
1490
1491 =item length EXPR
1492
1493 Returns the length in characters of the value of EXPR.  If EXPR is
1494 omitted, returns length of $_.
1495
1496 =item link OLDFILE,NEWFILE
1497
1498 Creates a new filename linked to the old filename.  Returns 1 for
1499 success, 0 otherwise.
1500
1501 =item listen SOCKET,QUEUESIZE
1502
1503 Does the same thing that the listen system call does.  Returns TRUE if
1504 it succeeded, FALSE otherwise.  See example in L<perlipc/"Sockets: Client/Server Communication">.
1505
1506 =item local EXPR
1507
1508 A local modifies the listed variables to be local to the enclosing block,
1509 subroutine, C<eval{}> or C<do>.  If more than one value is listed, the
1510 list must be placed in parens.  See L<perlsub/"Temporary Values via
1511 local()"> for details.
1512
1513 But you really probably want to be using my() instead, because local() isn't
1514 what most people think of as "local").  See L<perlsub/"Private Variables
1515 via my()"> for details.
1516
1517 =item localtime EXPR
1518
1519 Converts a time as returned by the time function to a 9-element array
1520 with the time analyzed for the local timezone.  Typically used as
1521 follows:
1522
1523     ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
1524                                                 localtime(time);
1525
1526 All array elements are numeric, and come straight out of a struct tm.
1527 In particular this means that $mon has the range 0..11 and $wday has
1528 the range 0..6.  If EXPR is omitted, does localtime(time).
1529
1530 In a scalar context, prints out the ctime(3) value:
1531
1532     $now_string = localtime;  # e.g. "Thu Oct 13 04:54:34 1994"
1533
1534 Also see the F<timelocal.pl> library, and the strftime(3) function available
1535 via the POSIX module.
1536
1537 =item log EXPR
1538
1539 Returns logarithm (base I<e>) of EXPR.  If EXPR is omitted, returns log
1540 of $_.
1541
1542 =item lstat FILEHANDLE
1543
1544 =item lstat EXPR
1545
1546 Does the same thing as the stat() function, but stats a symbolic link
1547 instead of the file the symbolic link points to.  If symbolic links are
1548 unimplemented on your system, a normal stat() is done.
1549
1550 =item m//
1551
1552 The match operator.  See L<perlop>.
1553
1554 =item map BLOCK LIST
1555
1556 =item map EXPR,LIST
1557
1558 Evaluates the BLOCK or EXPR for each element of LIST (locally setting $_ to each
1559 element) and returns the list value composed of the results of each such
1560 evaluation.  Evaluates BLOCK or EXPR in a list context, so each element of LIST
1561 may produce zero, one, or more elements in the returned value.
1562
1563     @chars = map(chr, @nums);
1564
1565 translates a list of numbers to the corresponding characters.  And
1566
1567     %hash = map { getkey($_) => $_ } @array;
1568
1569 is just a funny way to write
1570
1571     %hash = ();
1572     foreach $_ (@array) {
1573         $hash{getkey($_)} = $_;
1574     }
1575
1576 =item mkdir FILENAME,MODE
1577
1578 Creates the directory specified by FILENAME, with permissions specified
1579 by MODE (as modified by umask).  If it succeeds it returns 1, otherwise
1580 it returns 0 and sets C<$!> (errno).
1581
1582 =item msgctl ID,CMD,ARG
1583
1584 Calls the System V IPC function msgctl(2).  If CMD is &IPC_STAT, then ARG
1585 must be a variable which will hold the returned msqid_ds structure.
1586 Returns like ioctl: the undefined value for error, "0 but true" for
1587 zero, or the actual return value otherwise.
1588
1589 =item msgget KEY,FLAGS
1590
1591 Calls the System V IPC function msgget(2).  Returns the message queue id,
1592 or the undefined value if there is an error.
1593
1594 =item msgsnd ID,MSG,FLAGS
1595
1596 Calls the System V IPC function msgsnd to send the message MSG to the
1597 message queue ID.  MSG must begin with the long integer message type,
1598 which may be created with C<pack("l", $type)>.  Returns TRUE if
1599 successful, or FALSE if there is an error.
1600
1601 =item msgrcv ID,VAR,SIZE,TYPE,FLAGS
1602
1603 Calls the System V IPC function msgrcv to receive a message from
1604 message queue ID into variable VAR with a maximum message size of
1605 SIZE.  Note that if a message is received, the message type will be the
1606 first thing in VAR, and the maximum length of VAR is SIZE plus the size
1607 of the message type.  Returns TRUE if successful, or FALSE if there is
1608 an error.
1609
1610 =item my EXPR
1611
1612 A "my" declares the listed variables to be local (lexically) to the
1613 enclosing block, subroutine, C<eval>, or C<do/require/use>'d file.  If
1614 more than one value is listed, the list must be placed in parens.  See
1615 L<perlsub/"Private Variables via my()"> for details.
1616
1617 =item next LABEL
1618
1619 =item next
1620
1621 The C<next> command is like the C<continue> statement in C; it starts
1622 the next iteration of the loop:
1623
1624     LINE: while (<STDIN>) {
1625         next LINE if /^#/;      # discard comments
1626         ...
1627     }
1628
1629 Note that if there were a C<continue> block on the above, it would get
1630 executed even on discarded lines.  If the LABEL is omitted, the command
1631 refers to the innermost enclosing loop.
1632
1633 =item no Module LIST
1634
1635 See the "use" function, which "no" is the opposite of.
1636
1637 =item oct EXPR
1638
1639 Interprets EXPR as an octal string and returns the corresponding
1640 decimal value.  (If EXPR happens to start off with 0x, interprets it as
1641 a hex string instead.)  The following will handle decimal, octal, and
1642 hex in the standard Perl or C notation:
1643
1644     $val = oct($val) if $val =~ /^0/;
1645
1646 If EXPR is omitted, uses $_.
1647
1648 =item open FILEHANDLE,EXPR
1649
1650 =item open FILEHANDLE
1651
1652 Opens the file whose filename is given by EXPR, and associates it with
1653 FILEHANDLE.  If FILEHANDLE is an expression, its value is used as the name
1654 of the real filehandle wanted.  If EXPR is omitted, the scalar variable of
1655 the same name as the FILEHANDLE contains the filename.  If the filename
1656 begins with "E<lt>" or nothing, the file is opened for input.  If the filename
1657 begins with "E<gt>", the file is opened for output.  If the filename begins
1658 with "E<gt>E<gt>", the file is opened for appending.  You can put a '+' in
1659 front of the 'E<gt>' or 'E<lt>' to indicate that you want both read and write
1660 access to the file; thus '+E<lt>' is usually preferred for read/write
1661 updates--the '+E<gt>' mode would clobber the file first.  These correspond to
1662 the fopen(3) modes of 'r', 'r+', 'w', 'w+', 'a', and 'a+'.
1663
1664 If the filename begins with "|", the filename is interpreted
1665 as a command to which output is to be piped, and if the filename ends with
1666 a "|", the filename is interpreted See L<perlipc/"Using open() for IPC">
1667 for more examples of this.  as command which pipes input to us.  (You may
1668 not have a raw open() to a command that pipes both in I<and> out, but see L<open2>,
1669 L<open3>, and L<perlipc/"Bidirectional Communication"> for alternatives.)
1670
1671 Opening '-' opens STDIN and opening 'E<gt>-' opens STDOUT.  Open returns
1672 non-zero upon success, the undefined value otherwise.  If the open
1673 involved a pipe, the return value happens to be the pid of the
1674 subprocess.  
1675
1676 If you're unfortunate enough to be running Perl on a system that
1677 distinguishes between text files and binary files (modern operating
1678 systems don't care), then you should check out L</binmode> for tips for
1679 dealing with this.  The key distinction between systems that need binmode
1680 and those that don't is their text file formats.  Systems like Unix and
1681 Plan9 that delimit lines with a single character, and that encode that
1682 character in C as '\n', do not need C<binmode>.  The rest need it.
1683
1684 Examples:
1685
1686     $ARTICLE = 100;
1687     open ARTICLE or die "Can't find article $ARTICLE: $!\n";
1688     while (<ARTICLE>) {...
1689
1690     open(LOG, '>>/usr/spool/news/twitlog'); # (log is reserved)
1691
1692     open(DBASE, '+<dbase.mine');            # open for update
1693
1694     open(ARTICLE, "caesar <$article |");    # decrypt article
1695
1696     open(EXTRACT, "|sort >/tmp/Tmp$$");     # $$ is our process id
1697
1698     # process argument list of files along with any includes
1699
1700     foreach $file (@ARGV) {
1701         process($file, 'fh00');
1702     }
1703
1704     sub process {
1705         local($filename, $input) = @_;
1706         $input++;               # this is a string increment
1707         unless (open($input, $filename)) {
1708             print STDERR "Can't open $filename: $!\n";
1709             return;
1710         }
1711
1712         while (<$input>) {              # note use of indirection
1713             if (/^#include "(.*)"/) {
1714                 process($1, $input);
1715                 next;
1716             }
1717             ...         # whatever
1718         }
1719     }
1720
1721 You may also, in the Bourne shell tradition, specify an EXPR beginning
1722 with "E<gt>&", in which case the rest of the string is interpreted as the
1723 name of a filehandle (or file descriptor, if numeric) which is to be
1724 duped and opened.  You may use & after E<gt>, E<gt>E<gt>, E<lt>, +E<gt>,
1725 +E<gt>E<gt> and +E<lt>.  The
1726 mode you specify should match the mode of the original filehandle.
1727 (Duping a filehandle does not take into account any existing contents of
1728 stdio buffers.)
1729 Here is a script that saves, redirects, and restores STDOUT and
1730 STDERR:
1731
1732     #!/usr/bin/perl
1733     open(SAVEOUT, ">&STDOUT");
1734     open(SAVEERR, ">&STDERR");
1735
1736     open(STDOUT, ">foo.out") || die "Can't redirect stdout";
1737     open(STDERR, ">&STDOUT") || die "Can't dup stdout";
1738
1739     select(STDERR); $| = 1;     # make unbuffered
1740     select(STDOUT); $| = 1;     # make unbuffered
1741
1742     print STDOUT "stdout 1\n";  # this works for
1743     print STDERR "stderr 1\n";  # subprocesses too
1744
1745     close(STDOUT);
1746     close(STDERR);
1747
1748     open(STDOUT, ">&SAVEOUT");
1749     open(STDERR, ">&SAVEERR");
1750
1751     print STDOUT "stdout 2\n";
1752     print STDERR "stderr 2\n";
1753
1754
1755 If you specify "E<lt>&=N", where N is a number, then Perl will do an
1756 equivalent of C's fdopen() of that file descriptor; this is more
1757 parsimonious of file descriptors.  For example:
1758
1759     open(FILEHANDLE, "<&=$fd")
1760
1761 If you open a pipe on the command "-", i.e. either "|-" or "-|", then
1762 there is an implicit fork done, and the return value of open is the pid
1763 of the child within the parent process, and 0 within the child
1764 process.  (Use C<defined($pid)> to determine whether the open was successful.)
1765 The filehandle behaves normally for the parent, but i/o to that
1766 filehandle is piped from/to the STDOUT/STDIN of the child process.
1767 In the child process the filehandle isn't opened--i/o happens from/to
1768 the new STDOUT or STDIN.  Typically this is used like the normal
1769 piped open when you want to exercise more control over just how the
1770 pipe command gets executed, such as when you are running setuid, and
1771 don't want to have to scan shell commands for metacharacters.  
1772 The following pairs are more or less equivalent:
1773
1774     open(FOO, "|tr '[a-z]' '[A-Z]'");
1775     open(FOO, "|-") || exec 'tr', '[a-z]', '[A-Z]';
1776
1777     open(FOO, "cat -n '$file'|");
1778     open(FOO, "-|") || exec 'cat', '-n', $file;
1779
1780 See L<perlipc/"Safe Pipe Opens"> for more examples of this.
1781
1782 Explicitly closing any piped filehandle causes the parent process to
1783 wait for the child to finish, and returns the status value in C<$?>.
1784 Note: on any operation which may do a fork, unflushed buffers remain
1785 unflushed in both processes, which means you may need to set C<$|> to
1786 avoid duplicate output.
1787
1788 Using the FileHandle constructor from the FileHandle package,
1789 you can generate anonymous filehandles which have the scope of whatever
1790 variables hold references to them, and automatically close whenever
1791 and however you leave that scope:
1792
1793     use FileHandle;
1794     ...
1795     sub read_myfile_munged {
1796         my $ALL = shift;
1797         my $handle = new FileHandle;
1798         open($handle, "myfile") or die "myfile: $!";
1799         $first = <$handle>
1800             or return ();     # Automatically closed here.
1801         mung $first or die "mung failed";       # Or here.
1802         return $first, <$handle> if $ALL;       # Or here.
1803         $first;                                 # Or here.
1804     }
1805
1806 The filename that is passed to open will have leading and trailing
1807 whitespace deleted.  In order to open a file with arbitrary weird
1808 characters in it, it's necessary to protect any leading and trailing
1809 whitespace thusly:
1810
1811     $file =~ s#^(\s)#./$1#;
1812     open(FOO, "< $file\0");
1813
1814 If you want a "real" C open() (see L<open(2)> on your system), then
1815 you should use the sysopen() function.  This is another way to
1816 protect your filenames from interpretation.  For example:
1817
1818     use FileHandle;
1819     sysopen(HANDLE, $path, O_RDWR|O_CREAT|O_EXCL, 0700)
1820         or die "sysopen $path: $!";
1821     HANDLE->autoflush(1);
1822     HANDLE->print("stuff $$\n");
1823     seek(HANDLE, 0, 0);
1824     print "File contains: ", <HANDLE>;
1825
1826 See L</seek()> for some details about mixing reading and writing.
1827
1828 =item opendir DIRHANDLE,EXPR
1829
1830 Opens a directory named EXPR for processing by readdir(), telldir(),
1831 seekdir(), rewinddir() and closedir().  Returns TRUE if successful.
1832 DIRHANDLEs have their own namespace separate from FILEHANDLEs.
1833
1834 =item ord EXPR
1835
1836 Returns the numeric ascii value of the first character of EXPR.  If
1837 EXPR is omitted, uses $_.
1838
1839 =item pack TEMPLATE,LIST
1840
1841 Takes an array or list of values and packs it into a binary structure,
1842 returning the string containing the structure.  The TEMPLATE is a
1843 sequence of characters that give the order and type of values, as
1844 follows:
1845
1846     A   An ascii string, will be space padded.
1847     a   An ascii string, will be null padded.
1848     b   A bit string (ascending bit order, like vec()).
1849     B   A bit string (descending bit order).
1850     h   A hex string (low nybble first).
1851     H   A hex string (high nybble first).
1852
1853     c   A signed char value.
1854     C   An unsigned char value.
1855     s   A signed short value.
1856     S   An unsigned short value.
1857     i   A signed integer value.
1858     I   An unsigned integer value.
1859     l   A signed long value.
1860     L   An unsigned long value.
1861
1862     n   A short in "network" order.
1863     N   A long in "network" order.
1864     v   A short in "VAX" (little-endian) order.
1865     V   A long in "VAX" (little-endian) order.
1866
1867     f   A single-precision float in the native format.
1868     d   A double-precision float in the native format.
1869
1870     p   A pointer to a null-terminated string.
1871     P   A pointer to a structure (fixed-length string).
1872
1873     u   A uuencoded string.
1874
1875     x   A null byte.
1876     X   Back up a byte.
1877     @   Null fill to absolute position.
1878
1879 Each letter may optionally be followed by a number which gives a repeat
1880 count.  With all types except "a", "A", "b", "B", "h" and "H", and "P" the
1881 pack function will gobble up that many values from the LIST.  A * for the
1882 repeat count means to use however many items are left.  The "a" and "A"
1883 types gobble just one value, but pack it as a string of length count,
1884 padding with nulls or spaces as necessary.  (When unpacking, "A" strips
1885 trailing spaces and nulls, but "a" does not.)  Likewise, the "b" and "B"
1886 fields pack a string that many bits long.  The "h" and "H" fields pack a
1887 string that many nybbles long.  The "P" packs a pointer to a structure of
1888 the size indicated by the length.  Real numbers (floats and doubles) are
1889 in the native machine format only; due to the multiplicity of floating
1890 formats around, and the lack of a standard "network" representation, no
1891 facility for interchange has been made.  This means that packed floating
1892 point data written on one machine may not be readable on another - even if
1893 both use IEEE floating point arithmetic (as the endian-ness of the memory
1894 representation is not part of the IEEE spec).  Note that Perl uses doubles
1895 internally for all numeric calculation, and converting from double into
1896 float and thence back to double again will lose precision (i.e.
1897 C<unpack("f", pack("f", $foo)>) will not in general equal $foo).
1898
1899 Examples:
1900
1901     $foo = pack("cccc",65,66,67,68);
1902     # foo eq "ABCD"
1903     $foo = pack("c4",65,66,67,68);
1904     # same thing
1905
1906     $foo = pack("ccxxcc",65,66,67,68);
1907     # foo eq "AB\0\0CD"
1908
1909     $foo = pack("s2",1,2);
1910     # "\1\0\2\0" on little-endian
1911     # "\0\1\0\2" on big-endian
1912
1913     $foo = pack("a4","abcd","x","y","z");
1914     # "abcd"
1915
1916     $foo = pack("aaaa","abcd","x","y","z");
1917     # "axyz"
1918
1919     $foo = pack("a14","abcdefg");
1920     # "abcdefg\0\0\0\0\0\0\0"
1921
1922     $foo = pack("i9pl", gmtime);
1923     # a real struct tm (on my system anyway)
1924
1925     sub bintodec {
1926         unpack("N", pack("B32", substr("0" x 32 . shift, -32)));
1927     }
1928
1929 The same template may generally also be used in the unpack function.
1930
1931 =item package NAMESPACE
1932
1933 Declares the compilation unit as being in the given namespace.  The scope
1934 of the package declaration is from the declaration itself through the end of
1935 the enclosing block (the same scope as the local() operator).  All further
1936 unqualified dynamic identifiers will be in this namespace.  A package
1937 statement only affects dynamic variables--including those you've used
1938 local() on--but I<not> lexical variables created with my().  Typically it
1939 would be the first declaration in a file to be included by the C<require>
1940 or C<use> operator.  You can switch into a package in more than one place;
1941 it merely influences which symbol table is used by the compiler for the
1942 rest of that block.  You can refer to variables and filehandles in other
1943 packages by prefixing the identifier with the package name and a double
1944 colon:  C<$Package::Variable>.  If the package name is null, the C<main>
1945 package as assumed.  That is, C<$::sail> is equivalent to C<$main::sail>.
1946
1947 See L<perlmod/"Packages"> for more information about packages, modules,
1948 and classes.  See L<perlsub> for other scoping issues.
1949
1950 =item pipe READHANDLE,WRITEHANDLE
1951
1952 Opens a pair of connected pipes like the corresponding system call.
1953 Note that if you set up a loop of piped processes, deadlock can occur
1954 unless you are very careful.  In addition, note that Perl's pipes use
1955 stdio buffering, so you may need to set C<$|> to flush your WRITEHANDLE
1956 after each command, depending on the application.
1957
1958 See L<open2>, L<open3>, and L<perlipc/"Bidirectional Communication">
1959 for examples of such things.
1960
1961 =item pop ARRAY
1962
1963 Pops and returns the last value of the array, shortening the array by
1964 1.  Has a similar effect to
1965
1966     $tmp = $ARRAY[$#ARRAY--];
1967
1968 If there are no elements in the array, returns the undefined value.
1969 If ARRAY is omitted, pops the
1970 @ARGV array in the main program, and the @_ array in subroutines, just
1971 like shift().
1972
1973 =item pos SCALAR
1974
1975 Returns the offset of where the last C<m//g> search left off for the variable
1976 in question.  May be modified to change that offset.
1977
1978 =item print FILEHANDLE LIST
1979
1980 =item print LIST
1981
1982 =item print
1983
1984 Prints a string or a comma-separated list of strings.  Returns TRUE
1985 if successful.  FILEHANDLE may be a scalar variable name, in which case
1986 the variable contains the name of or a reference to the filehandle, thus introducing one
1987 level of indirection.  (NOTE: If FILEHANDLE is a variable and the next
1988 token is a term, it may be misinterpreted as an operator unless you
1989 interpose a + or put parens around the arguments.)  If FILEHANDLE is
1990 omitted, prints by default to standard output (or to the last selected
1991 output channel--see L</select>).  If LIST is also omitted, prints $_ to
1992 STDOUT.  To set the default output channel to something other than
1993 STDOUT use the select operation.  Note that, because print takes a
1994 LIST, anything in the LIST is evaluated in a list context, and any
1995 subroutine that you call will have one or more of its expressions
1996 evaluated in a list context.  Also be careful not to follow the print
1997 keyword with a left parenthesis unless you want the corresponding right
1998 parenthesis to terminate the arguments to the print--interpose a + or
1999 put parens around all the arguments.
2000
2001 Note that if you're storing FILEHANDLES in an array or other expression,
2002 you will have to use a block returning its value instead:
2003
2004     print { $files[$i] } "stuff\n";
2005     print { $OK ? STDOUT : STDERR } "stuff\n";
2006
2007 =item printf FILEHANDLE LIST
2008
2009 =item printf LIST
2010
2011 Equivalent to a "print FILEHANDLE sprintf(LIST)".  The first argument
2012 of the list will be interpreted as the printf format.
2013
2014 =item prototype FUNCTION
2015
2016 Returns the prototype of a function as a string (or C<undef> if the
2017 function has no prototype).  FUNCTION is a reference to the the
2018 function whose prototype you want to retrieve.
2019
2020 =item push ARRAY,LIST
2021
2022 Treats ARRAY as a stack, and pushes the values of LIST
2023 onto the end of ARRAY.  The length of ARRAY increases by the length of
2024 LIST.  Has the same effect as
2025
2026     for $value (LIST) {
2027         $ARRAY[++$#ARRAY] = $value;
2028     }
2029
2030 but is more efficient.  Returns the new number of elements in the array.
2031
2032 =item q/STRING/
2033
2034 =item qq/STRING/
2035
2036 =item qx/STRING/
2037
2038 =item qw/STRING/
2039
2040 Generalized quotes.  See L<perlop>.
2041
2042 =item quotemeta EXPR
2043
2044 Returns the value of EXPR with with all regular expression
2045 metacharacters backslashed.  This is the internal function implementing
2046 the \Q escape in double-quoted strings.
2047
2048 =item rand EXPR
2049
2050 =item rand
2051
2052 Returns a random fractional number between 0 and the value of EXPR.
2053 (EXPR should be positive.)  If EXPR is omitted, returns a value between 
2054 0 and 1.  This function produces repeatable sequences unless srand() 
2055 is invoked.  See also srand().
2056
2057 (Note: if your rand function consistently returns numbers that are too
2058 large or too small, then your version of Perl was probably compiled
2059 with the wrong number of RANDBITS.  As a workaround, you can usually
2060 multiply EXPR by the correct power of 2 to get the range you want.
2061 This will make your script unportable, however.  It's better to recompile
2062 if you can.)
2063
2064 =item read FILEHANDLE,SCALAR,LENGTH,OFFSET
2065
2066 =item read FILEHANDLE,SCALAR,LENGTH
2067
2068 Attempts to read LENGTH bytes of data into variable SCALAR from the
2069 specified FILEHANDLE.  Returns the number of bytes actually read, or
2070 undef if there was an error.  SCALAR will be grown or shrunk to the
2071 length actually read.  An OFFSET may be specified to place the read
2072 data at some other place than the beginning of the string.  This call
2073 is actually implemented in terms of stdio's fread call.  To get a true
2074 read system call, see sysread().
2075
2076 =item readdir DIRHANDLE
2077
2078 Returns the next directory entry for a directory opened by opendir().
2079 If used in a list context, returns all the rest of the entries in the
2080 directory.  If there are no more entries, returns an undefined value in
2081 a scalar context or a null list in a list context.
2082
2083 If you're planning to filetest the return values out of a readdir(), you'd
2084 better prepend the directory in question.  Otherwise, since we didn't
2085 chdir() there, it would have been testing the wrong file.
2086
2087     opendir(DIR, $some_dir) || die "can't opendir $some_dir: $!";
2088     @dots = grep { /^\./ && -f "$some_dir/$_" } readdir(DIR);
2089     closedir DIR;
2090
2091 =item readlink EXPR
2092
2093 Returns the value of a symbolic link, if symbolic links are
2094 implemented.  If not, gives a fatal error.  If there is some system
2095 error, returns the undefined value and sets C<$!> (errno).  If EXPR is
2096 omitted, uses $_.
2097
2098 =item recv SOCKET,SCALAR,LEN,FLAGS
2099
2100 Receives a message on a socket.  Attempts to receive LENGTH bytes of
2101 data into variable SCALAR from the specified SOCKET filehandle.
2102 Actually does a C recvfrom(), so that it can returns the address of the
2103 sender.  Returns the undefined value if there's an error.  SCALAR will
2104 be grown or shrunk to the length actually read.  Takes the same flags
2105 as the system call of the same name.  
2106 See L<perlipc/"UDP: Message Passing"> for examples.
2107
2108 =item redo LABEL
2109
2110 =item redo
2111
2112 The C<redo> command restarts the loop block without evaluating the
2113 conditional again.  The C<continue> block, if any, is not executed.  If
2114 the LABEL is omitted, the command refers to the innermost enclosing
2115 loop.  This command is normally used by programs that want to lie to
2116 themselves about what was just input:
2117
2118     # a simpleminded Pascal comment stripper
2119     # (warning: assumes no { or } in strings)
2120     LINE: while (<STDIN>) {
2121         while (s|({.*}.*){.*}|$1 |) {}
2122         s|{.*}| |;
2123         if (s|{.*| |) {
2124             $front = $_;
2125             while (<STDIN>) {
2126                 if (/}/) {      # end of comment?
2127                     s|^|$front{|;
2128                     redo LINE;
2129                 }
2130             }
2131         }
2132         print;
2133     }
2134
2135 =item ref EXPR
2136
2137 Returns a TRUE value if EXPR is a reference, FALSE otherwise.  The value
2138 returned depends on the type of thing the reference is a reference to.
2139 Builtin types include:
2140
2141     REF
2142     SCALAR
2143     ARRAY
2144     HASH
2145     CODE
2146     GLOB
2147
2148 If the referenced object has been blessed into a package, then that package 
2149 name is returned instead.  You can think of ref() as a typeof() operator.
2150
2151     if (ref($r) eq "HASH") {
2152         print "r is a reference to an associative array.\n";
2153     } 
2154     if (!ref ($r) {
2155         print "r is not a reference at all.\n";
2156     } 
2157
2158 See also L<perlref>.
2159
2160 =item rename OLDNAME,NEWNAME
2161
2162 Changes the name of a file.  Returns 1 for success, 0 otherwise.  Will
2163 not work across filesystem boundaries.
2164
2165 =item require EXPR
2166
2167 =item require
2168
2169 Demands some semantics specified by EXPR, or by $_ if EXPR is not
2170 supplied.  If EXPR is numeric, demands that the current version of Perl
2171 (C<$]> or $PERL_VERSION) be equal or greater than EXPR.
2172
2173 Otherwise, demands that a library file be included if it hasn't already
2174 been included.  The file is included via the do-FILE mechanism, which is
2175 essentially just a variety of eval().  Has semantics similar to the following
2176 subroutine:
2177
2178     sub require {
2179         local($filename) = @_;
2180         return 1 if $INC{$filename};
2181         local($realfilename,$result);
2182         ITER: {
2183             foreach $prefix (@INC) {
2184                 $realfilename = "$prefix/$filename";
2185                 if (-f $realfilename) {
2186                     $result = do $realfilename;
2187                     last ITER;
2188                 }
2189             }
2190             die "Can't find $filename in \@INC";
2191         }
2192         die $@ if $@;
2193         die "$filename did not return true value" unless $result;
2194         $INC{$filename} = $realfilename;
2195         $result;
2196     }
2197
2198 Note that the file will not be included twice under the same specified
2199 name.  The file must return TRUE as the last statement to indicate
2200 successful execution of any initialization code, so it's customary to
2201 end such a file with "1;" unless you're sure it'll return TRUE
2202 otherwise.  But it's better just to put the "C<1;>", in case you add more
2203 statements.
2204
2205 If EXPR is a bare word, the require assumes a "F<.pm>" extension and
2206 replaces "F<::>" with "F</>" in the filename for you,
2207 to make it easy to load standard modules.  This form of loading of 
2208 modules does not risk altering your namespace.
2209
2210 For a yet-more-powerful import facility, see L</use> and 
2211 L<perlmod>.
2212
2213 =item reset EXPR
2214
2215 =item reset
2216
2217 Generally used in a C<continue> block at the end of a loop to clear
2218 variables and reset ?? searches so that they work again.  The
2219 expression is interpreted as a list of single characters (hyphens
2220 allowed for ranges).  All variables and arrays beginning with one of
2221 those letters are reset to their pristine state.  If the expression is
2222 omitted, one-match searches (?pattern?) are reset to match again.  Only
2223 resets variables or searches in the current package.  Always returns
2224 1.  Examples:
2225
2226     reset 'X';          # reset all X variables
2227     reset 'a-z';        # reset lower case variables
2228     reset;              # just reset ?? searches
2229
2230 Resetting "A-Z" is not recommended since you'll wipe out your
2231 ARGV and ENV arrays.  Only resets package variables--lexical variables
2232 are unaffected, but they clean themselves up on scope exit anyway,
2233 so you'll probably want to use them instead.  See L</my>.
2234
2235 =item return LIST
2236
2237 Returns from a subroutine or eval with the value specified.  (Note that
2238 in the absence of a return a subroutine or eval() will automatically
2239 return the value of the last expression evaluated.)
2240
2241 =item reverse LIST
2242
2243 In a list context, returns a list value consisting of the elements
2244 of LIST in the opposite order.  In a scalar context, returns a string
2245 value consisting of the bytes of the first element of LIST in the
2246 opposite order.   
2247
2248     print reverse <>;                   # line tac 
2249
2250     undef $/;
2251     print scalar reverse scalar <>;     # byte tac
2252
2253 =item rewinddir DIRHANDLE
2254
2255 Sets the current position to the beginning of the directory for the
2256 readdir() routine on DIRHANDLE.
2257
2258 =item rindex STR,SUBSTR,POSITION
2259
2260 =item rindex STR,SUBSTR
2261
2262 Works just like index except that it returns the position of the LAST
2263 occurrence of SUBSTR in STR.  If POSITION is specified, returns the
2264 last occurrence at or before that position.
2265
2266 =item rmdir FILENAME
2267
2268 Deletes the directory specified by FILENAME if it is empty.  If it
2269 succeeds it returns 1, otherwise it returns 0 and sets C<$!> (errno).  If
2270 FILENAME is omitted, uses $_.
2271
2272 =item s///
2273
2274 The substitution operator.  See L<perlop>.
2275
2276 =item scalar EXPR
2277
2278 Forces EXPR to be interpreted in a scalar context and returns the value
2279 of EXPR.  
2280
2281     @counts = ( scalar @a, scalar @b, scalar @c );
2282
2283 There is no equivalent operator to force an expression to 
2284 be interpolated in a list context because it's in practice never
2285 needed.  If you really wanted to do so, however, you could use
2286 the construction C<@{[ (some expression) ]}>, but usually a simple
2287 C<(some expression)> suffices.
2288
2289 =item seek FILEHANDLE,POSITION,WHENCE
2290
2291 Randomly positions the file pointer for FILEHANDLE, just like the fseek()
2292 call of stdio.  FILEHANDLE may be an expression whose value gives the name
2293 of the filehandle.  The values for WHENCE are 0 to set the file pointer to
2294 POSITION, 1 to set the it to current plus POSITION, and 2 to set it to EOF
2295 plus offset.  You may use the values SEEK_SET, SEEK_CUR, and SEEK_END for
2296 this from POSIX module.  Returns 1 upon success, 0 otherwise.
2297
2298 On some systems you have to do a seek whenever you switch between reading
2299 and writing.  Amongst other things, this may have the effect of calling
2300 stdio's clearerr(3).  A "whence" of 1 (SEEK_CUR) is useful for not moving
2301 the file pointer:
2302
2303     seek(TEST,0,1);
2304
2305 This is also useful for applications emulating C<tail -f>.  Once you hit
2306 EOF on your read, and then sleep for a while, you might have to stick in a
2307 seek() to reset things.  First the simple trick listed above to clear the
2308 filepointer.  The seek() doesn't change the current position, but it
2309 I<does> clear the end-of-file condition on the handle, so that the next
2310 C<E<lt>FILEE<gt>> makes Perl try again to read something.  Hopefully.
2311
2312 If that doesn't work (some stdios are particularly cantankerous), then
2313 you may need something more like this:
2314
2315     for (;;) {
2316         for ($curpos = tell(FILE); $_ = <FILE>; $curpos = tell(FILE)) {
2317             # search for some stuff and put it into files
2318         }
2319         sleep($for_a_while);
2320         seek(FILE, $curpos, 0);
2321     }
2322
2323 =item seekdir DIRHANDLE,POS
2324
2325 Sets the current position for the readdir() routine on DIRHANDLE.  POS
2326 must be a value returned by telldir().  Has the same caveats about
2327 possible directory compaction as the corresponding system library
2328 routine.
2329
2330 =item select FILEHANDLE
2331
2332 =item select
2333
2334 Returns the currently selected filehandle.  Sets the current default
2335 filehandle for output, if FILEHANDLE is supplied.  This has two
2336 effects: first, a C<write> or a C<print> without a filehandle will
2337 default to this FILEHANDLE.  Second, references to variables related to
2338 output will refer to this output channel.  For example, if you have to
2339 set the top of form format for more than one output channel, you might
2340 do the following:
2341
2342     select(REPORT1);
2343     $^ = 'report1_top';
2344     select(REPORT2);
2345     $^ = 'report2_top';
2346
2347 FILEHANDLE may be an expression whose value gives the name of the
2348 actual filehandle.  Thus:
2349
2350     $oldfh = select(STDERR); $| = 1; select($oldfh);
2351
2352 Some programmers may prefer to think of filehandles as objects with
2353 methods, preferring to write the last example as:
2354
2355     use FileHandle;
2356     STDERR->autoflush(1);
2357
2358 =item select RBITS,WBITS,EBITS,TIMEOUT
2359
2360 This calls the select(2) system call with the bitmasks specified, which
2361 can be constructed using fileno() and vec(), along these lines:
2362
2363     $rin = $win = $ein = '';
2364     vec($rin,fileno(STDIN),1) = 1;
2365     vec($win,fileno(STDOUT),1) = 1;
2366     $ein = $rin | $win;
2367
2368 If you want to select on many filehandles you might wish to write a
2369 subroutine:
2370
2371     sub fhbits {
2372         local(@fhlist) = split(' ',$_[0]);
2373         local($bits);
2374         for (@fhlist) {
2375             vec($bits,fileno($_),1) = 1;
2376         }
2377         $bits;
2378     }
2379     $rin = fhbits('STDIN TTY SOCK');
2380
2381 The usual idiom is:
2382
2383     ($nfound,$timeleft) =
2384       select($rout=$rin, $wout=$win, $eout=$ein, $timeout);
2385
2386 or to block until something becomes ready just do this 
2387
2388     $nfound = select($rout=$rin, $wout=$win, $eout=$ein, undef);
2389
2390 Most systems do not both to return anything useful in $timeleft, so
2391 calling select() in a scalar context just returns $nfound.
2392
2393 Any of the bitmasks can also be undef.  The timeout, if specified, is
2394 in seconds, which may be fractional.  Note: not all implementations are
2395 capable of returning the $timeleft.  If not, they always return
2396 $timeleft equal to the supplied $timeout.
2397
2398 You can effect a 250-millisecond sleep this way:
2399
2400     select(undef, undef, undef, 0.25);
2401
2402 B<WARNING>: Do not attempt to mix buffered I/O (like read() or E<lt>FHE<gt>)
2403 with select().  You have to use sysread() instead.
2404
2405 =item semctl ID,SEMNUM,CMD,ARG
2406
2407 Calls the System V IPC function semctl.  If CMD is &IPC_STAT or
2408 &GETALL, then ARG must be a variable which will hold the returned
2409 semid_ds structure or semaphore value array.  Returns like ioctl: the
2410 undefined value for error, "0 but true" for zero, or the actual return
2411 value otherwise.
2412
2413 =item semget KEY,NSEMS,FLAGS
2414
2415 Calls the System V IPC function semget.  Returns the semaphore id, or
2416 the undefined value if there is an error.
2417
2418 =item semop KEY,OPSTRING
2419
2420 Calls the System V IPC function semop to perform semaphore operations
2421 such as signaling and waiting.  OPSTRING must be a packed array of
2422 semop structures.  Each semop structure can be generated with
2423 C<pack("sss", $semnum, $semop, $semflag)>.  The number of semaphore
2424 operations is implied by the length of OPSTRING.  Returns TRUE if
2425 successful, or FALSE if there is an error.  As an example, the
2426 following code waits on semaphore $semnum of semaphore id $semid:
2427
2428     $semop = pack("sss", $semnum, -1, 0);
2429     die "Semaphore trouble: $!\n" unless semop($semid, $semop);
2430
2431 To signal the semaphore, replace "-1" with "1".
2432
2433 =item send SOCKET,MSG,FLAGS,TO
2434
2435 =item send SOCKET,MSG,FLAGS
2436
2437 Sends a message on a socket.  Takes the same flags as the system call
2438 of the same name.  On unconnected sockets you must specify a
2439 destination to send TO, in which case it does a C sendto().  Returns
2440 the number of characters sent, or the undefined value if there is an
2441 error.
2442 See L<perlipc/"UDP: Message Passing"> for examples.
2443
2444 =item setpgrp PID,PGRP
2445
2446 Sets the current process group for the specified PID, 0 for the current
2447 process.  Will produce a fatal error if used on a machine that doesn't
2448 implement setpgrp(2).  If the arguments are ommitted, it defaults to
2449 0,0.  Note that the POSIX version of setpgrp() does not accept any
2450 arguments, so only setpgrp 0,0 is portable.
2451
2452 =item setpriority WHICH,WHO,PRIORITY
2453
2454 Sets the current priority for a process, a process group, or a user.
2455 (See setpriority(2).)  Will produce a fatal error if used on a machine
2456 that doesn't implement setpriority(2).
2457
2458 =item setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL
2459
2460 Sets the socket option requested.  Returns undefined if there is an
2461 error.  OPTVAL may be specified as undef if you don't want to pass an
2462 argument.
2463
2464 =item shift ARRAY
2465
2466 =item shift
2467
2468 Shifts the first value of the array off and returns it, shortening the
2469 array by 1 and moving everything down.  If there are no elements in the
2470 array, returns the undefined value.  If ARRAY is omitted, shifts the
2471 @ARGV array in the main program, and the @_ array in subroutines.
2472 (This is determined lexically.)  See also unshift(), push(), and pop().
2473 Shift() and unshift() do the same thing to the left end of an array
2474 that push() and pop() do to the right end.
2475
2476 =item shmctl ID,CMD,ARG
2477
2478 Calls the System V IPC function shmctl.  If CMD is &IPC_STAT, then ARG
2479 must be a variable which will hold the returned shmid_ds structure.
2480 Returns like ioctl: the undefined value for error, "0 but true" for
2481 zero, or the actual return value otherwise.
2482
2483 =item shmget KEY,SIZE,FLAGS
2484
2485 Calls the System V IPC function shmget.  Returns the shared memory
2486 segment id, or the undefined value if there is an error.
2487
2488 =item shmread ID,VAR,POS,SIZE
2489
2490 =item shmwrite ID,STRING,POS,SIZE
2491
2492 Reads or writes the System V shared memory segment ID starting at
2493 position POS for size SIZE by attaching to it, copying in/out, and
2494 detaching from it.  When reading, VAR must be a variable which will
2495 hold the data read.  When writing, if STRING is too long, only SIZE
2496 bytes are used; if STRING is too short, nulls are written to fill out
2497 SIZE bytes.  Return TRUE if successful, or FALSE if there is an error.
2498
2499 =item shutdown SOCKET,HOW
2500
2501 Shuts down a socket connection in the manner indicated by HOW, which
2502 has the same interpretation as in the system call of the same name.
2503
2504 =item sin EXPR
2505
2506 Returns the sine of EXPR (expressed in radians).  If EXPR is omitted,
2507 returns sine of $_.
2508
2509 =item sleep EXPR
2510
2511 =item sleep
2512
2513 Causes the script to sleep for EXPR seconds, or forever if no EXPR.
2514 May be interrupted by sending the process a SIGALRM.  Returns the
2515 number of seconds actually slept.  You probably cannot mix alarm() and
2516 sleep() calls, since sleep() is often implemented using alarm().
2517
2518 On some older systems, it may sleep up to a full second less than what
2519 you requested, depending on how it counts seconds.  Most modern systems
2520 always sleep the full amount.
2521
2522 For delays of finer granularity than one second, you may use Perl's
2523 syscall() interface to access setitimer(2) if your system supports it, 
2524 or else see L</select()> below.  
2525
2526 =item socket SOCKET,DOMAIN,TYPE,PROTOCOL
2527
2528 Opens a socket of the specified kind and attaches it to filehandle
2529 SOCKET.  DOMAIN, TYPE and PROTOCOL are specified the same as for the
2530 system call of the same name.  You should "use Socket;" first to get
2531 the proper definitions imported.  See the example in L<perlipc/"Sockets: Client/Server Communication">.
2532
2533 =item socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL
2534
2535 Creates an unnamed pair of sockets in the specified domain, of the
2536 specified type.  DOMAIN, TYPE and PROTOCOL are specified the same as
2537 for the system call of the same name.  If unimplemented, yields a fatal
2538 error.  Returns TRUE if successful.
2539
2540 =item sort SUBNAME LIST
2541
2542 =item sort BLOCK LIST
2543
2544 =item sort LIST
2545
2546 Sorts the LIST and returns the sorted list value.  Nonexistent values
2547 of arrays are stripped out.  If SUBNAME or BLOCK is omitted, sorts
2548 in standard string comparison order.  If SUBNAME is specified, it
2549 gives the name of a subroutine that returns an integer less than, equal
2550 to, or greater than 0, depending on how the elements of the array are
2551 to be ordered.  (The E<lt>=E<gt> and cmp operators are extremely useful in such
2552 routines.)  SUBNAME may be a scalar variable name, in which case the
2553 value provides the name of the subroutine to use.  In place of a
2554 SUBNAME, you can provide a BLOCK as an anonymous, in-line sort
2555 subroutine.
2556
2557 In the interests of efficiency the normal calling code for subroutines is
2558 bypassed, with the following effects: the subroutine may not be a
2559 recursive subroutine, and the two elements to be compared are passed into
2560 the subroutine not via @_ but as the package global variables $a and
2561 $b (see example below).  They are passed by reference, so don't
2562 modify $a and $b.  And don't try to declare them as lexicals either.
2563
2564 Examples:
2565
2566     # sort lexically
2567     @articles = sort @files;
2568
2569     # same thing, but with explicit sort routine
2570     @articles = sort {$a cmp $b} @files;
2571
2572     # now case-insensitively
2573     @articles = sort { uc($a) cmp uc($b)} @files;
2574
2575     # same thing in reversed order
2576     @articles = sort {$b cmp $a} @files;
2577
2578     # sort numerically ascending
2579     @articles = sort {$a <=> $b} @files;
2580
2581     # sort numerically descending
2582     @articles = sort {$b <=> $a} @files;
2583
2584     # sort using explicit subroutine name
2585     sub byage {
2586         $age{$a} <=> $age{$b};  # presuming integers
2587     }
2588     @sortedclass = sort byage @class;
2589
2590     # this sorts the %age associative arrays by value 
2591     # instead of key using an inline function
2592     @eldest = sort { $age{$b} <=> $age{$a} } keys %age;
2593
2594     sub backwards { $b cmp $a; }
2595     @harry = ('dog','cat','x','Cain','Abel');
2596     @george = ('gone','chased','yz','Punished','Axed');
2597     print sort @harry;
2598             # prints AbelCaincatdogx
2599     print sort backwards @harry;
2600             # prints xdogcatCainAbel
2601     print sort @george, 'to', @harry;
2602             # prints AbelAxedCainPunishedcatchaseddoggonetoxyz
2603
2604     # inefficiently sort by descending numeric compare using 
2605     # the first integer after the first = sign, or the 
2606     # whole record case-insensitively otherwise
2607
2608     @new = sort {
2609         ($b =~ /=(\d+)/)[0] <=> ($a =~ /=(\d+)/)[0]
2610                             ||
2611                     uc($a)  cmp  uc($b)
2612     } @old;
2613
2614     # same thing, but much more efficiently;
2615     # we'll build auxiliary indices instead
2616     # for speed
2617     @nums = @caps = ();
2618     for (@old) { 
2619         push @nums, /=(\d+)/;
2620         push @caps, uc($_);
2621     } 
2622
2623     @new = @old[ sort {
2624                         $nums[$b] <=> $nums[$a]
2625                                  ||
2626                         $caps[$a] cmp $caps[$b]
2627                        } 0..$#old
2628                ];
2629
2630     # same thing using a Schwartzian Transform (no temps)
2631     @new = map { $_->[0] }
2632         sort { $b->[1] <=> $a->[1]
2633                         ||
2634                $a->[2] cmp $b->[2]
2635         } map { [$_, /=(\d+)/, uc($_)] } @old;
2636
2637 If you're using strict, you I<MUST NOT> declare $a
2638 and $b as lexicals.  They are package globals.  That means
2639 if you're in the C<main> package, it's
2640
2641     @articles = sort {$main::b <=> $main::a} @files;
2642
2643 or just
2644
2645     @articles = sort {$::b <=> $::a} @files;
2646
2647 but if you're in the C<FooPack> package, it's
2648
2649     @articles = sort {$FooPack::b <=> $FooPack::a} @files;
2650
2651 =item splice ARRAY,OFFSET,LENGTH,LIST
2652
2653 =item splice ARRAY,OFFSET,LENGTH
2654
2655 =item splice ARRAY,OFFSET
2656
2657 Removes the elements designated by OFFSET and LENGTH from an array, and
2658 replaces them with the elements of LIST, if any.  Returns the elements
2659 removed from the array.  The array grows or shrinks as necessary.  If
2660 LENGTH is omitted, removes everything from OFFSET onward.  The
2661 following equivalencies hold (assuming C<$[ == 0>):
2662
2663     push(@a,$x,$y)      splice(@a,$#a+1,0,$x,$y)
2664     pop(@a)             splice(@a,-1)
2665     shift(@a)           splice(@a,0,1)
2666     unshift(@a,$x,$y)   splice(@a,0,0,$x,$y)
2667     $a[$x] = $y         splice(@a,$x,1,$y);
2668
2669 Example, assuming array lengths are passed before arrays:
2670
2671     sub aeq {   # compare two list values
2672         local(@a) = splice(@_,0,shift);
2673         local(@b) = splice(@_,0,shift);
2674         return 0 unless @a == @b;       # same len?
2675         while (@a) {
2676             return 0 if pop(@a) ne pop(@b);
2677         }
2678         return 1;
2679     }
2680     if (&aeq($len,@foo[1..$len],0+@bar,@bar)) { ... }
2681
2682 =item split /PATTERN/,EXPR,LIMIT
2683
2684 =item split /PATTERN/,EXPR
2685
2686 =item split /PATTERN/
2687
2688 =item split
2689
2690 Splits a string into an array of strings, and returns it.
2691
2692 If not in a list context, returns the number of fields found and splits into
2693 the @_ array.  (In a list context, you can force the split into @_ by
2694 using C<??> as the pattern delimiters, but it still returns the array
2695 value.)  The use of implicit split to @_ is deprecated, however.
2696
2697 If EXPR is omitted, splits the $_ string.  If PATTERN is also omitted,
2698 splits on whitespace (after skipping any leading whitespace).  Anything
2699 matching PATTERN is taken to be a delimiter separating the fields.  (Note
2700 that the delimiter may be longer than one character.)  If LIMIT is
2701 specified and is not negative, splits into no more than that many fields
2702 (though it may split into fewer).  If LIMIT is unspecified, trailing null
2703 fields are stripped (which potential users of pop() would do well to
2704 remember).  If LIMIT is negative, it is treated as if an arbitrarily large
2705 LIMIT had been specified.
2706
2707 A pattern matching the null string (not to be confused with
2708 a null pattern C<//>, which is just one member of the set of patterns
2709 matching a null string) will split the value of EXPR into separate
2710 characters at each point it matches that way.  For example:
2711
2712     print join(':', split(/ */, 'hi there'));
2713
2714 produces the output 'h:i:t:h:e:r:e'.
2715
2716 The LIMIT parameter can be used to partially split a line
2717
2718     ($login, $passwd, $remainder) = split(/:/, $_, 3);
2719
2720 When assigning to a list, if LIMIT is omitted, Perl supplies a LIMIT
2721 one larger than the number of variables in the list, to avoid
2722 unnecessary work.  For the list above LIMIT would have been 4 by
2723 default.  In time critical applications it behooves you not to split
2724 into more fields than you really need.
2725
2726 If the PATTERN contains parentheses, additional array elements are
2727 created from each matching substring in the delimiter.
2728
2729     split(/([,-])/, "1-10,20", 3);
2730
2731 produces the list value
2732
2733     (1, '-', 10, ',', 20)
2734
2735 If you had the entire header of a normal Unix email message in $header, 
2736 you could split it up into fields and their values this way:
2737
2738     $header =~ s/\n\s+/ /g;  # fix continuation lines
2739     %hdrs   =  (UNIX_FROM => split /^(.*?):\s*/m, $header);
2740
2741 The pattern C</PATTERN/> may be replaced with an expression to specify
2742 patterns that vary at runtime.  (To do runtime compilation only once,
2743 use C</$variable/o>.)
2744
2745 As a special case, specifying a PATTERN of space (C<' '>) will split on
2746 white space just as split with no arguments does.  Thus, split(' ') can
2747 be used to emulate B<awk>'s default behavior, whereas C<split(/ /)>
2748 will give you as many null initial fields as there are leading spaces.
2749 A split on /\s+/ is like a split(' ') except that any leading
2750 whitespace produces a null first field.  A split with no arguments
2751 really does a C<split(' ', $_)> internally.
2752
2753 Example:
2754
2755     open(passwd, '/etc/passwd');
2756     while (<passwd>) {
2757         ($login, $passwd, $uid, $gid, $gcos, 
2758             $home, $shell) = split(/:/);
2759         ...
2760     }
2761
2762 (Note that $shell above will still have a newline on it.  See L</chop>, 
2763 L</chomp>, and L</join>.)
2764
2765 =item sprintf FORMAT,LIST
2766
2767 Returns a string formatted by the usual printf conventions of the C
2768 language.  See L<sprintf(3)> or L<printf(3)> on your system for details.
2769 (The * character for an indirectly specified length is not
2770 supported, but you can get the same effect by interpolating a variable
2771 into the pattern.)  Some C libraries' implementations of sprintf() can
2772 dump core when fed ludicrous arguments.
2773
2774 =item sqrt EXPR
2775
2776 Return the square root of EXPR.  If EXPR is omitted, returns square
2777 root of $_.
2778
2779 =item srand EXPR
2780
2781 Sets the random number seed for the C<rand> operator.  If EXPR is omitted,
2782 uses a semirandom value based on the current time and process ID, among
2783 other things.  Of course, you'd need something much more random than that for
2784 cryptographic purposes, since it's easy to guess the current time.
2785 Checksumming the compressed output of rapidly changing operating system
2786 status programs is the usual method.  Examples are posted regularly to
2787 the comp.security.unix newsgroup.
2788
2789 =item stat FILEHANDLE
2790
2791 =item stat EXPR
2792
2793 Returns a 13-element array giving the status info for a file, either the
2794 file opened via FILEHANDLE, or named by EXPR.  Returns a null list if
2795 the stat fails.  Typically used as follows:
2796
2797     ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
2798        $atime,$mtime,$ctime,$blksize,$blocks)
2799            = stat($filename);
2800
2801 Not all fields are supported on all filesystem types.  Here are the 
2802 meaning of the fields:
2803
2804   dev       device number of filesystem 
2805   ino       inode number 
2806   mode      file mode  (type and permissions)
2807   nlink     number of (hard) links to the file 
2808   uid       numeric user ID of file's owner 
2809   gid       numer group ID of file's owner 
2810   rdev      the device identifier (special files only)
2811   size      total size of file, in bytes 
2812   atime     last access time since the epoch
2813   mtime     last modify time since the epoch
2814   ctime     inode change time (NOT creation type!) since the epoch
2815   blksize   preferred blocksize for file system I/O
2816   blocks    actual number of blocks allocated
2817
2818 (The epoch was at 00:00 January 1, 1970 GMT.)
2819
2820 If stat is passed the special filehandle consisting of an underline, no
2821 stat is done, but the current contents of the stat structure from the
2822 last stat or filetest are returned.  Example:
2823
2824     if (-x $file && (($d) = stat(_)) && $d < 0) {
2825         print "$file is executable NFS file\n";
2826     }
2827
2828 (This only works on machines for which the device number is negative under NFS.)
2829
2830 =item study SCALAR
2831
2832 =item study
2833
2834 Takes extra time to study SCALAR (C<$_> if unspecified) in anticipation of
2835 doing many pattern matches on the string before it is next modified.
2836 This may or may not save time, depending on the nature and number of
2837 patterns you are searching on, and on the distribution of character
2838 frequencies in the string to be searched--you probably want to compare
2839 runtimes with and without it to see which runs faster.  Those loops
2840 which scan for many short constant strings (including the constant
2841 parts of more complex patterns) will benefit most.  You may have only
2842 one study active at a time--if you study a different scalar the first
2843 is "unstudied".  (The way study works is this: a linked list of every
2844 character in the string to be searched is made, so we know, for
2845 example, where all the 'k' characters are.  From each search string,
2846 the rarest character is selected, based on some static frequency tables
2847 constructed from some C programs and English text.  Only those places
2848 that contain this "rarest" character are examined.)
2849
2850 For example, here is a loop which inserts index producing entries
2851 before any line containing a certain pattern:
2852
2853     while (<>) {
2854         study;
2855         print ".IX foo\n" if /\bfoo\b/;
2856         print ".IX bar\n" if /\bbar\b/;
2857         print ".IX blurfl\n" if /\bblurfl\b/;
2858         ...
2859         print;
2860     }
2861
2862 In searching for /\bfoo\b/, only those locations in $_ that contain "f"
2863 will be looked at, because "f" is rarer than "o".  In general, this is
2864 a big win except in pathological cases.  The only question is whether
2865 it saves you more time than it took to build the linked list in the
2866 first place.
2867
2868 Note that if you have to look for strings that you don't know till
2869 runtime, you can build an entire loop as a string and eval that to
2870 avoid recompiling all your patterns all the time.  Together with
2871 undefining $/ to input entire files as one record, this can be very
2872 fast, often faster than specialized programs like fgrep(1).  The following
2873 scans a list of files (C<@files>) for a list of words (C<@words>), and prints
2874 out the names of those files that contain a match:
2875
2876     $search = 'while (<>) { study;';
2877     foreach $word (@words) {
2878         $search .= "++\$seen{\$ARGV} if /\\b$word\\b/;\n";
2879     }
2880     $search .= "}";
2881     @ARGV = @files;
2882     undef $/;
2883     eval $search;               # this screams
2884     $/ = "\n";          # put back to normal input delim
2885     foreach $file (sort keys(%seen)) {
2886         print $file, "\n";
2887     }
2888
2889 =item sub BLOCK
2890
2891 =item sub NAME
2892
2893 =item sub NAME BLOCK
2894
2895 This is subroutine definition, not a real function I<per se>.  With just a
2896 NAME (and possibly prototypes), it's just a forward declaration.  Without
2897 a NAME, it's an anonymous function declaration, and does actually return a
2898 value: the CODE ref of the closure you just created. See L<perlsub> and
2899 L<perlref> for details.
2900
2901 =item substr EXPR,OFFSET,LEN
2902
2903 =item substr EXPR,OFFSET
2904
2905 Extracts a substring out of EXPR and returns it.  First character is at
2906 offset 0, or whatever you've set $[ to.  If OFFSET is negative, starts
2907 that far from the end of the string.  If LEN is omitted, returns
2908 everything to the end of the string.  If LEN is negative, leaves that
2909 many characters off the end of the string.
2910
2911 You can use the substr() function
2912 as an lvalue, in which case EXPR must be an lvalue.  If you assign
2913 something shorter than LEN, the string will shrink, and if you assign
2914 something longer than LEN, the string will grow to accommodate it.  To
2915 keep the string the same length you may need to pad or chop your value
2916 using sprintf().
2917
2918 =item symlink OLDFILE,NEWFILE
2919
2920 Creates a new filename symbolically linked to the old filename.
2921 Returns 1 for success, 0 otherwise.  On systems that don't support
2922 symbolic links, produces a fatal error at run time.  To check for that,
2923 use eval:
2924
2925     $symlink_exists = (eval 'symlink("","");', $@ eq '');
2926
2927 =item syscall LIST
2928
2929 Calls the system call specified as the first element of the list,
2930 passing the remaining elements as arguments to the system call.  If
2931 unimplemented, produces a fatal error.  The arguments are interpreted
2932 as follows: if a given argument is numeric, the argument is passed as
2933 an int.  If not, the pointer to the string value is passed.  You are
2934 responsible to make sure a string is pre-extended long enough to
2935 receive any result that might be written into a string.  If your
2936 integer arguments are not literals and have never been interpreted in a
2937 numeric context, you may need to add 0 to them to force them to look
2938 like numbers.
2939
2940     require 'syscall.ph';               # may need to run h2ph
2941     syscall(&SYS_write, fileno(STDOUT), "hi there\n", 9);
2942
2943 Note that Perl only supports passing of up to 14 arguments to your system call,
2944 which in practice should usually suffice.
2945
2946 =item sysopen FILEHANDLE,FILENAME,MODE
2947
2948 =item sysopen FILEHANDLE,FILENAME,MODE,PERMS
2949
2950 Opens the file whose filename is given by FILENAME, and associates it
2951 with FILEHANDLE.  If FILEHANDLE is an expression, its value is used as
2952 the name of the real filehandle wanted.  This function calls the
2953 underlying operating system's C<open> function with the parameters
2954 FILENAME, MODE, PERMS.
2955
2956 The possible values and flag bits of the MODE parameter are
2957 system-dependent; they are available via the standard module C<Fcntl>.
2958 However, for historical reasons, some values are universal: zero means
2959 read-only, one means write-only, and two means read/write.
2960
2961 If the file named by FILENAME does not exist and the C<open> call
2962 creates it (typically because MODE includes the O_CREAT flag), then
2963 the value of PERMS specifies the permissions of the newly created
2964 file.  If PERMS is omitted, the default value is 0666, which allows
2965 read and write for all.  This default is reasonable: see C<umask>.
2966
2967 =item sysread FILEHANDLE,SCALAR,LENGTH,OFFSET
2968
2969 =item sysread FILEHANDLE,SCALAR,LENGTH
2970
2971 Attempts to read LENGTH bytes of data into variable SCALAR from the
2972 specified FILEHANDLE, using the system call read(2).  It bypasses
2973 stdio, so mixing this with other kinds of reads may cause confusion.
2974 Returns the number of bytes actually read, or undef if there was an
2975 error.  SCALAR will be grown or shrunk to the length actually read.  An
2976 OFFSET may be specified to place the read data at some other place than
2977 the beginning of the string.
2978
2979 =item system LIST
2980
2981 Does exactly the same thing as "exec LIST" except that a fork is done
2982 first, and the parent process waits for the child process to complete.
2983 Note that argument processing varies depending on the number of
2984 arguments.  The return value is the exit status of the program as
2985 returned by the wait() call.  To get the actual exit value divide by
2986 256.  See also L</exec>.  This is I<NOT> what you want to use to capture 
2987 the output from a command, for that you should merely use backticks, as
2988 described in L<perlop/"`STRING`">.
2989
2990 =item syswrite FILEHANDLE,SCALAR,LENGTH,OFFSET
2991
2992 =item syswrite FILEHANDLE,SCALAR,LENGTH
2993
2994 Attempts to write LENGTH bytes of data from variable SCALAR to the
2995 specified FILEHANDLE, using the system call write(2).  It bypasses
2996 stdio, so mixing this with prints may cause confusion.  Returns the
2997 number of bytes actually written, or undef if there was an error.  An
2998 OFFSET may be specified to get the write data from some other place than
2999 the beginning of the string.
3000
3001 =item tell FILEHANDLE
3002
3003 =item tell
3004
3005 Returns the current file position for FILEHANDLE.  FILEHANDLE may be an
3006 expression whose value gives the name of the actual filehandle.  If
3007 FILEHANDLE is omitted, assumes the file last read.
3008
3009 =item telldir DIRHANDLE
3010
3011 Returns the current position of the readdir() routines on DIRHANDLE.
3012 Value may be given to seekdir() to access a particular location in a
3013 directory.  Has the same caveats about possible directory compaction as
3014 the corresponding system library routine.
3015
3016 =item tie VARIABLE,CLASSNAME,LIST
3017
3018 This function binds a variable to a package class that will provide the
3019 implementation for the variable.  VARIABLE is the name of the variable
3020 to be enchanted.  CLASSNAME is the name of a class implementing objects
3021 of correct type.  Any additional arguments are passed to the "new"
3022 method of the class (meaning TIESCALAR, TIEARRAY, or TIEHASH).
3023 Typically these are arguments such as might be passed to the dbm_open()
3024 function of C.  The object returned by the "new" method is also
3025 returned by the tie() function, which would be useful if you want to
3026 access other methods in CLASSNAME.
3027
3028 Note that functions such as keys() and values() may return huge array
3029 values when used on large objects, like DBM files.  You may prefer to
3030 use the each() function to iterate over such.  Example:
3031
3032     # print out history file offsets
3033     use NDBM_File;
3034     tie(%HIST, 'NDBM_File', '/usr/lib/news/history', 1, 0);
3035     while (($key,$val) = each %HIST) {
3036         print $key, ' = ', unpack('L',$val), "\n";
3037     }
3038     untie(%HIST);
3039
3040 A class implementing an associative array should have the following
3041 methods:
3042
3043     TIEHASH classname, LIST
3044     DESTROY this
3045     FETCH this, key
3046     STORE this, key, value
3047     DELETE this, key
3048     EXISTS this, key
3049     FIRSTKEY this
3050     NEXTKEY this, lastkey
3051
3052 A class implementing an ordinary array should have the following methods:
3053
3054     TIEARRAY classname, LIST
3055     DESTROY this
3056     FETCH this, key
3057     STORE this, key, value
3058     [others TBD]
3059
3060 A class implementing a scalar should have the following methods:
3061
3062     TIESCALAR classname, LIST
3063     DESTROY this
3064     FETCH this, 
3065     STORE this, value
3066
3067 Unlike dbmopen(), the tie() function will not use or require a module
3068 for you--you need to do that explicitly yourself.  See L<DB_File>
3069 or the F<Config> module for interesting tie() implementations.
3070
3071 =item tied VARIABLE
3072
3073 Returns a reference to the object underlying VARIABLE (the same value
3074 that was originally returned by the tie() call which bound the variable
3075 to a package.)  Returns the undefined value if VARIABLE isn't tied to a
3076 package.
3077
3078 =item time
3079
3080 Returns the number of non-leap seconds since whatever time the system
3081 considers to be the epoch (that's 00:00:00, January 1, 1904 for MacOS,
3082 and 00:00:00 UTC, January 1, 1970 for most other systems).
3083 Suitable for feeding to gmtime() and localtime().
3084
3085 =item times
3086
3087 Returns a four-element array giving the user and system times, in
3088 seconds, for this process and the children of this process.
3089
3090     ($user,$system,$cuser,$csystem) = times;
3091
3092 =item tr///
3093
3094 The translation operator.  See L<perlop>.
3095
3096 =item truncate FILEHANDLE,LENGTH
3097
3098 =item truncate EXPR,LENGTH
3099
3100 Truncates the file opened on FILEHANDLE, or named by EXPR, to the
3101 specified length.  Produces a fatal error if truncate isn't implemented
3102 on your system.
3103
3104 =item uc EXPR
3105
3106 Returns an uppercased version of EXPR.  This is the internal function
3107 implementing the \U escape in double-quoted strings.
3108 Should respect any POSIX setlocale() settings.
3109
3110 =item ucfirst EXPR
3111
3112 Returns the value of EXPR with the first character uppercased.  This is
3113 the internal function implementing the \u escape in double-quoted strings.
3114 Should respect any POSIX setlocale() settings.
3115
3116 =item umask EXPR
3117
3118 =item umask
3119
3120 Sets the umask for the process and returns the old one.  If EXPR is
3121 omitted, merely returns current umask.
3122
3123 =item undef EXPR
3124
3125 =item undef
3126
3127 Undefines the value of EXPR, which must be an lvalue.  Use only on a
3128 scalar value, an entire array, or a subroutine name (using "&").  (Using undef()
3129 will probably not do what you expect on most predefined variables or
3130 DBM list values, so don't do that.)  Always returns the undefined value.  You can omit
3131 the EXPR, in which case nothing is undefined, but you still get an
3132 undefined value that you could, for instance, return from a
3133 subroutine.  Examples:
3134
3135     undef $foo;
3136     undef $bar{'blurfl'};
3137     undef @ary;
3138     undef %assoc;
3139     undef &mysub;
3140     return (wantarray ? () : undef) if $they_blew_it;
3141
3142 =item unlink LIST
3143
3144 Deletes a list of files.  Returns the number of files successfully
3145 deleted.
3146
3147     $cnt = unlink 'a', 'b', 'c';
3148     unlink @goners;
3149     unlink <*.bak>;
3150
3151 Note: unlink will not delete directories unless you are superuser and
3152 the B<-U> flag is supplied to Perl.  Even if these conditions are
3153 met, be warned that unlinking a directory can inflict damage on your
3154 filesystem.  Use rmdir instead.
3155
3156 =item unpack TEMPLATE,EXPR
3157
3158 Unpack does the reverse of pack: it takes a string representing a
3159 structure and expands it out into a list value, returning the array
3160 value.  (In a scalar context, it merely returns the first value
3161 produced.)  The TEMPLATE has the same format as in the pack function.
3162 Here's a subroutine that does substring:
3163
3164     sub substr {
3165         local($what,$where,$howmuch) = @_;
3166         unpack("x$where a$howmuch", $what);
3167     }
3168
3169 and then there's
3170
3171     sub ordinal { unpack("c",$_[0]); } # same as ord()
3172
3173 In addition, you may prefix a field with a %E<lt>numberE<gt> to indicate that
3174 you want a E<lt>numberE<gt>-bit checksum of the items instead of the items
3175 themselves.  Default is a 16-bit checksum.  For example, the following
3176 computes the same number as the System V sum program:
3177
3178     while (<>) {
3179         $checksum += unpack("%16C*", $_);
3180     }
3181     $checksum %= 65536;
3182
3183 The following efficiently counts the number of set bits in a bit vector:
3184
3185     $setbits = unpack("%32b*", $selectmask);
3186
3187 =item untie VARIABLE
3188
3189 Breaks the binding between a variable and a package.  (See tie().)
3190
3191 =item unshift ARRAY,LIST
3192
3193 Does the opposite of a C<shift>.  Or the opposite of a C<push>,
3194 depending on how you look at it.  Prepends list to the front of the
3195 array, and returns the new number of elements in the array.
3196
3197     unshift(ARGV, '-e') unless $ARGV[0] =~ /^-/;
3198
3199 Note the LIST is prepended whole, not one element at a time, so the
3200 prepended elements stay in the same order.  Use reverse to do the
3201 reverse.
3202
3203 =item use Module LIST
3204
3205 =item use Module
3206
3207 =item use Module VERSION LIST
3208
3209 =item use VERSION
3210
3211 Imports some semantics into the current package from the named module,
3212 generally by aliasing certain subroutine or variable names into your
3213 package.  It is exactly equivalent to
3214
3215     BEGIN { require Module; import Module LIST; }
3216
3217 except that Module I<must> be a bare word.
3218
3219 If the first argument to C<use> is a number, it is treated as a version
3220 number instead of a module name.  If the version of the Perl interpreter
3221 is less than VERSION, then an error message is printed and Perl exits
3222 immediately.  This is often useful if you need to check the current
3223 Perl version before C<use>ing library modules which have changed in
3224 incompatible ways from older versions of Perl.  (We try not to do
3225 this more than we have to.)
3226
3227 The BEGIN forces the require and import to happen at compile time.  The
3228 require makes sure the module is loaded into memory if it hasn't been
3229 yet.  The import is not a builtin--it's just an ordinary static method
3230 call into the "Module" package to tell the module to import the list of
3231 features back into the current package.  The module can implement its
3232 import method any way it likes, though most modules just choose to
3233 derive their import method via inheritance from the Exporter class that
3234 is defined in the Exporter module. See L<Exporter>.
3235
3236 If you don't want your namespace altered, explicitly supply an empty list:
3237
3238     use Module ();
3239
3240 That is exactly equivalent to
3241
3242     BEGIN { require Module; }
3243
3244 If the VERSION argument is present between Module and LIST, then the
3245 C<use> will fail if the C<$VERSION> variable in package Module is
3246 less than VERSION.
3247
3248 Because this is a wide-open interface, pragmas (compiler directives)
3249 are also implemented this way.  Currently implemented pragmas are:
3250
3251     use integer;
3252     use diagnostics;
3253     use sigtrap qw(SEGV BUS);
3254     use strict  qw(subs vars refs);
3255     use subs    qw(afunc blurfl);
3256
3257 These pseudomodules import semantics into the current block scope, unlike
3258 ordinary modules, which import symbols into the current package (which are
3259 effective through the end of the file).
3260
3261 There's a corresponding "no" command that unimports meanings imported
3262 by use, i.e. it calls C<unimport Module LIST> instead of C<import>.
3263
3264     no integer;
3265     no strict 'refs';
3266
3267 See L<perlmod> for a list of standard modules and pragmas.
3268
3269 =item utime LIST
3270
3271 Changes the access and modification times on each file of a list of
3272 files.  The first two elements of the list must be the NUMERICAL access
3273 and modification times, in that order.  Returns the number of files
3274 successfully changed.  The inode modification time of each file is set
3275 to the current time.  Example of a "touch" command:
3276
3277     #!/usr/bin/perl
3278     $now = time;
3279     utime $now, $now, @ARGV;
3280
3281 =item values ASSOC_ARRAY
3282
3283 Returns a normal array consisting of all the values of the named
3284 associative array.  (In a scalar context, returns the number of
3285 values.)  The values are returned in an apparently random order, but it
3286 is the same order as either the keys() or each() function would produce
3287 on the same array.  See also keys(), each(), and sort().
3288
3289 =item vec EXPR,OFFSET,BITS
3290
3291 Treats the string in EXPR as a vector of unsigned integers, and
3292 returns the value of the bitfield specified by OFFSET.  BITS specifies
3293 the number of bits that are reserved for each entry in the bit
3294 vector. This must be a power of two from 1 to 32. vec() may also be
3295 assigned to, in which case parens are needed to give the expression
3296 the correct precedence as in
3297
3298     vec($image, $max_x * $x + $y, 8) = 3;
3299
3300 Vectors created with vec() can also be manipulated with the logical
3301 operators |, & and ^, which will assume a bit vector operation is
3302 desired when both operands are strings.
3303
3304 To transform a bit vector into a string or array of 0's and 1's, use these:
3305
3306     $bits = unpack("b*", $vector);
3307     @bits = split(//, unpack("b*", $vector));
3308
3309 If you know the exact length in bits, it can be used in place of the *.
3310
3311 =item wait
3312
3313 Waits for a child process to terminate and returns the pid of the
3314 deceased process, or -1 if there are no child processes.  The status is
3315 returned in C<$?>.
3316
3317 =item waitpid PID,FLAGS
3318
3319 Waits for a particular child process to terminate and returns the pid
3320 of the deceased process, or -1 if there is no such child process.  The
3321 status is returned in C<$?>.  If you say
3322
3323     use POSIX ":wait_h";
3324     ...
3325     waitpid(-1,&WNOHANG);
3326
3327 then you can do a non-blocking wait for any process.  Non-blocking wait
3328 is only available on machines supporting either the waitpid(2) or
3329 wait4(2) system calls.  However, waiting for a particular pid with
3330 FLAGS of 0 is implemented everywhere.  (Perl emulates the system call
3331 by remembering the status values of processes that have exited but have
3332 not been harvested by the Perl script yet.)
3333
3334 =item wantarray
3335
3336 Returns TRUE if the context of the currently executing subroutine is
3337 looking for a list value.  Returns FALSE if the context is looking
3338 for a scalar.
3339
3340     return wantarray ? () : undef;
3341
3342 =item warn LIST
3343
3344 Produces a message on STDERR just like die(), but doesn't exit or
3345 on an exception.
3346
3347 =item write FILEHANDLE
3348
3349 =item write EXPR
3350
3351 =item write
3352
3353 Writes a formatted record (possibly multi-line) to the specified file,
3354 using the format associated with that file.  By default the format for
3355 a file is the one having the same name is the filehandle, but the
3356 format for the current output channel (see the select() function) may be set
3357 explicitly by assigning the name of the format to the C<$~> variable.
3358
3359 Top of form processing is handled automatically:  if there is
3360 insufficient room on the current page for the formatted record, the
3361 page is advanced by writing a form feed, a special top-of-page format
3362 is used to format the new page header, and then the record is written.
3363 By default the top-of-page format is the name of the filehandle with
3364 "_TOP" appended, but it may be dynamically set to the format of your
3365 choice by assigning the name to the C<$^> variable while the filehandle is
3366 selected.  The number of lines remaining on the current page is in
3367 variable C<$->, which can be set to 0 to force a new page.
3368
3369 If FILEHANDLE is unspecified, output goes to the current default output
3370 channel, which starts out as STDOUT but may be changed by the
3371 C<select> operator.  If the FILEHANDLE is an EXPR, then the expression
3372 is evaluated and the resulting string is used to look up the name of
3373 the FILEHANDLE at run time.  For more on formats, see L<perlform>.
3374
3375 Note that write is I<NOT> the opposite of read.  Unfortunately.
3376
3377 =item y///
3378
3379 The translation operator.  See L<perlop>.
3380
3381 =back