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