8928df128cbcad085e6bfb340a18b54cb0934d5e
[p5sagit/p5-mst-13.2.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 or 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 ever
18 be only one such list argument.)  For instance, splice() has three scalar
19 arguments followed by a list, whereas gethostbyname() has four scalar
20 arguments.
21
22 In the syntax descriptions that follow, list operators that expect a
23 list (and provide list context for the elements of the list) are shown
24 with LIST as an argument.  Such a list may consist of any combination
25 of scalar arguments or list values; the list values will be included
26 in the list as if each individual element were interpolated at that
27 point in the list, forming a longer single-dimensional list value.
28 Elements of the LIST should be separated by commas.
29
30 Any function in the list below may be used either with or without
31 parentheses around its arguments.  (The syntax descriptions omit the
32 parentheses.)  If you use the parentheses, the simple (but occasionally
33 surprising) rule is this: It I<looks> like a function, therefore it I<is> a
34 function, and precedence doesn't matter.  Otherwise it's a list
35 operator or unary operator, and precedence does matter.  And whitespace
36 between the function and left parenthesis doesn't count--so you need to
37 be careful sometimes:
38
39     print 1+2+4;        # Prints 7.
40     print(1+2) + 4;     # Prints 3.
41     print (1+2)+4;      # Also prints 3!
42     print +(1+2)+4;     # Prints 7.
43     print ((1+2)+4);    # Prints 7.
44
45 If you run Perl with the B<-w> switch it can warn you about this.  For
46 example, the third line above produces:
47
48     print (...) interpreted as function at - line 1.
49     Useless use of integer addition in void context at - line 1.
50
51 A few functions take no arguments at all, and therefore work as neither
52 unary nor list operators.  These include such functions as C<time>
53 and C<endpwent>.  For example, C<time+86_400> always means
54 C<time() + 86_400>.
55
56 For functions that can be used in either a scalar or list context,
57 nonabortive failure is generally indicated in a scalar context by
58 returning the undefined value, and in a list context by returning the
59 null list.
60
61 Remember the following important rule: There is B<no rule> that relates
62 the behavior of an expression in list context to its behavior in scalar
63 context, or vice versa.  It might do two totally different things.
64 Each operator and function decides which sort of value it would be most
65 appropriate to return in scalar context.  Some operators return the
66 length of the list that would have been returned in list context.  Some
67 operators return the first value in the list.  Some operators return the
68 last value in the list.  Some operators return a count of successful
69 operations.  In general, they do what you want, unless you want
70 consistency.
71
72 An named array in scalar context is quite different from what would at
73 first glance appear to be a list in scalar context.  You can't get a list
74 like C<(1,2,3)> into being in scalar context, because the compiler knows
75 the context at compile time.  It would generate the scalar comma operator
76 there, not the list construction version of the comma.  That means it
77 was never a list to start with.
78
79 In general, functions in Perl that serve as wrappers for system calls
80 of the same name (like chown(2), fork(2), closedir(2), etc.) all return
81 true when they succeed and C<undef> otherwise, as is usually mentioned
82 in the descriptions below.  This is different from the C interfaces,
83 which return C<-1> on failure.  Exceptions to this rule are C<wait>,
84 C<waitpid>, and C<syscall>.  System calls also set the special C<$!>
85 variable on failure.  Other functions do not, except accidentally.
86
87 =head2 Perl Functions by Category
88
89 Here are Perl's functions (including things that look like
90 functions, like some keywords and named operators)
91 arranged by category.  Some functions appear in more
92 than one place.
93
94 =over
95
96 =item Functions for SCALARs or strings
97
98 C<chomp>, C<chop>, C<chr>, C<crypt>, C<hex>, C<index>, C<lc>, C<lcfirst>,
99 C<length>, C<oct>, C<ord>, C<pack>, C<q/STRING/>, C<qq/STRING/>, C<reverse>,
100 C<rindex>, C<sprintf>, C<substr>, C<tr///>, C<uc>, C<ucfirst>, C<y///>
101
102 =item Regular expressions and pattern matching
103
104 C<m//>, C<pos>, C<quotemeta>, C<s///>, C<split>, C<study>, C<qr//>
105
106 =item Numeric functions
107
108 C<abs>, C<atan2>, C<cos>, C<exp>, C<hex>, C<int>, C<log>, C<oct>, C<rand>,
109 C<sin>, C<sqrt>, C<srand>
110
111 =item Functions for real @ARRAYs
112
113 C<pop>, C<push>, C<shift>, C<splice>, C<unshift>
114
115 =item Functions for list data
116
117 C<grep>, C<join>, C<map>, C<qw/STRING/>, C<reverse>, C<sort>, C<unpack>
118
119 =item Functions for real %HASHes
120
121 C<delete>, C<each>, C<exists>, C<keys>, C<values>
122
123 =item Input and output functions
124
125 C<binmode>, C<close>, C<closedir>, C<dbmclose>, C<dbmopen>, C<die>, C<eof>,
126 C<fileno>, C<flock>, C<format>, C<getc>, C<print>, C<printf>, C<read>,
127 C<readdir>, C<rewinddir>, C<seek>, C<seekdir>, C<select>, C<syscall>,
128 C<sysread>, C<sysseek>, C<syswrite>, C<tell>, C<telldir>, C<truncate>,
129 C<warn>, C<write>
130
131 =item Functions for fixed length data or records
132
133 C<pack>, C<read>, C<syscall>, C<sysread>, C<syswrite>, C<unpack>, C<vec>
134
135 =item Functions for filehandles, files, or directories
136
137 C<-I<X>>, C<chdir>, C<chmod>, C<chown>, C<chroot>, C<fcntl>, C<glob>,
138 C<ioctl>, C<link>, C<lstat>, C<mkdir>, C<open>, C<opendir>,
139 C<readlink>, C<rename>, C<rmdir>, C<stat>, C<symlink>, C<umask>,
140 C<unlink>, C<utime>
141
142 =item Keywords related to the control flow of your perl program
143
144 C<caller>, C<continue>, C<die>, C<do>, C<dump>, C<eval>, C<exit>,
145 C<goto>, C<last>, C<next>, C<redo>, C<return>, C<sub>, C<wantarray>
146
147 =item Keywords related to scoping
148
149 C<caller>, C<import>, C<local>, C<my>, C<package>, C<use>
150
151 =item Miscellaneous functions
152
153 C<defined>, C<dump>, C<eval>, C<formline>, C<local>, C<my>, C<reset>,
154 C<scalar>, C<undef>, C<wantarray>
155
156 =item Functions for processes and process groups
157
158 C<alarm>, C<exec>, C<fork>, C<getpgrp>, C<getppid>, C<getpriority>, C<kill>,
159 C<pipe>, C<qx/STRING/>, C<setpgrp>, C<setpriority>, C<sleep>, C<system>,
160 C<times>, C<wait>, C<waitpid>
161
162 =item Keywords related to perl modules
163
164 C<do>, C<import>, C<no>, C<package>, C<require>, C<use>
165
166 =item Keywords related to classes and object-orientedness
167
168 C<bless>, C<dbmclose>, C<dbmopen>, C<package>, C<ref>, C<tie>, C<tied>,
169 C<untie>, C<use>
170
171 =item Low-level socket functions
172
173 C<accept>, C<bind>, C<connect>, C<getpeername>, C<getsockname>,
174 C<getsockopt>, C<listen>, C<recv>, C<send>, C<setsockopt>, C<shutdown>,
175 C<socket>, C<socketpair>
176
177 =item System V interprocess communication functions
178
179 C<msgctl>, C<msgget>, C<msgrcv>, C<msgsnd>, C<semctl>, C<semget>, C<semop>,
180 C<shmctl>, C<shmget>, C<shmread>, C<shmwrite>
181
182 =item Fetching user and group info
183
184 C<endgrent>, C<endhostent>, C<endnetent>, C<endpwent>, C<getgrent>,
185 C<getgrgid>, C<getgrnam>, C<getlogin>, C<getpwent>, C<getpwnam>,
186 C<getpwuid>, C<setgrent>, C<setpwent>
187
188 =item Fetching network info
189
190 C<endprotoent>, C<endservent>, C<gethostbyaddr>, C<gethostbyname>,
191 C<gethostent>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>,
192 C<getprotobyname>, C<getprotobynumber>, C<getprotoent>,
193 C<getservbyname>, C<getservbyport>, C<getservent>, C<sethostent>,
194 C<setnetent>, C<setprotoent>, C<setservent>
195
196 =item Time-related functions
197
198 C<gmtime>, C<localtime>, C<time>, C<times>
199
200 =item Functions new in perl5
201
202 C<abs>, C<bless>, C<chomp>, C<chr>, C<exists>, C<formline>, C<glob>,
203 C<import>, C<lc>, C<lcfirst>, C<map>, C<my>, C<no>, C<prototype>, C<qx>,
204 C<qw>, C<readline>, C<readpipe>, C<ref>, C<sub*>, C<sysopen>, C<tie>,
205 C<tied>, C<uc>, C<ucfirst>, C<untie>, C<use>
206
207 * - C<sub> was a keyword in perl4, but in perl5 it is an
208 operator, which can be used in expressions.
209
210 =item Functions obsoleted in perl5
211
212 C<dbmclose>, C<dbmopen>
213
214 =back
215
216 =head2 Portability
217
218 Perl was born in Unix and can therefore access all common Unix
219 system calls.  In non-Unix environments, the functionality of some
220 Unix system calls may not be available, or details of the available
221 functionality may differ slightly.  The Perl functions affected
222 by this are:
223
224 C<-X>, C<binmode>, C<chmod>, C<chown>, C<chroot>, C<crypt>,
225 C<dbmclose>, C<dbmopen>, C<dump>, C<endgrent>, C<endhostent>,
226 C<endnetent>, C<endprotoent>, C<endpwent>, C<endservent>, C<exec>,
227 C<fcntl>, C<flock>, C<fork>, C<getgrent>, C<getgrgid>, C<gethostent>,
228 C<getlogin>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>,
229 C<getppid>, C<getprgp>, C<getpriority>, C<getprotobynumber>,
230 C<getprotoent>, C<getpwent>, C<getpwnam>, C<getpwuid>,
231 C<getservbyport>, C<getservent>, C<getsockopt>, C<glob>, C<ioctl>,
232 C<kill>, C<link>, C<lstat>, C<msgctl>, C<msgget>, C<msgrcv>,
233 C<msgsnd>, C<open>, C<pipe>, C<readlink>, C<rename>, C<select>, C<semctl>,
234 C<semget>, C<semop>, C<setgrent>, C<sethostent>, C<setnetent>,
235 C<setpgrp>, C<setpriority>, C<setprotoent>, C<setpwent>,
236 C<setservent>, C<setsockopt>, C<shmctl>, C<shmget>, C<shmread>,
237 C<shmwrite>, C<socket>, C<socketpair>, C<stat>, C<symlink>, C<syscall>,
238 C<sysopen>, C<system>, C<times>, C<truncate>, C<umask>, C<unlink>,
239 C<utime>, C<wait>, C<waitpid>
240
241 For more information about the portability of these functions, see
242 L<perlport> and other available platform-specific documentation.
243
244 =head2 Alphabetical Listing of Perl Functions
245
246 =over 8
247
248 =item I<-X> FILEHANDLE
249
250 =item I<-X> EXPR
251
252 =item I<-X>
253
254 A file test, where X is one of the letters listed below.  This unary
255 operator takes one argument, either a filename or a filehandle, and
256 tests the associated file to see if something is true about it.  If the
257 argument is omitted, tests C<$_>, except for C<-t>, which tests STDIN.
258 Unless otherwise documented, it returns C<1> for true and C<''> for false, or
259 the undefined value if the file doesn't exist.  Despite the funny
260 names, precedence is the same as any other named unary operator, and
261 the argument may be parenthesized like any other unary operator.  The
262 operator may be any of:
263 X<-r>X<-w>X<-x>X<-o>X<-R>X<-W>X<-X>X<-O>X<-e>X<-z>X<-s>X<-f>X<-d>X<-l>X<-p>
264 X<-S>X<-b>X<-c>X<-t>X<-u>X<-g>X<-k>X<-T>X<-B>X<-M>X<-A>X<-C>
265
266     -r  File is readable by effective uid/gid.
267     -w  File is writable by effective uid/gid.
268     -x  File is executable by effective uid/gid.
269     -o  File is owned by effective uid.
270
271     -R  File is readable by real uid/gid.
272     -W  File is writable by real uid/gid.
273     -X  File is executable by real uid/gid.
274     -O  File is owned by real uid.
275
276     -e  File exists.
277     -z  File has zero size.
278     -s  File has nonzero size (returns size).
279
280     -f  File is a plain file.
281     -d  File is a directory.
282     -l  File is a symbolic link.
283     -p  File is a named pipe (FIFO), or Filehandle is a pipe.
284     -S  File is a socket.
285     -b  File is a block special file.
286     -c  File is a character special file.
287     -t  Filehandle is opened to a tty.
288
289     -u  File has setuid bit set.
290     -g  File has setgid bit set.
291     -k  File has sticky bit set.
292
293     -T  File is an ASCII text file.
294     -B  File is a "binary" file (opposite of -T).
295
296     -M  Age of file in days when script started.
297     -A  Same for access time.
298     -C  Same for inode change time.
299
300 Example:
301
302     while (<>) {
303         chop;
304         next unless -f $_;      # ignore specials
305         #...
306     }
307
308 The interpretation of the file permission operators C<-r>, C<-R>,
309 C<-w>, C<-W>, C<-x>, and C<-X> is by default based solely on the mode
310 of the file and the uids and gids of the user.  There may be other
311 reasons you can't actually read, write, or execute the file.  Such
312 reasons may be for example network filesystem access controls, ACLs
313 (access control lists), read-only filesystems, and unrecognized
314 executable formats.
315
316 Also note that, for the superuser on the local filesystems, the C<-r>,
317 C<-R>, C<-w>, and C<-W> tests always return 1, and C<-x> and C<-X> return 1
318 if any execute bit is set in the mode.  Scripts run by the superuser
319 may thus need to do a stat() to determine the actual mode of the file,
320 or temporarily set their effective uid to something else.
321
322 If you are using ACLs, there is a pragma called C<filetest> that may
323 produce more accurate results than the bare stat() mode bits.
324 When under the C<use filetest 'access'> the above-mentioned filetests
325 will test whether the permission can (not) be granted using the
326 access() family of system calls.  Also note that the C<-x> and C<-X> may
327 under this pragma return true even if there are no execute permission
328 bits set (nor any extra execute permission ACLs).  This strangeness is
329 due to the underlying system calls' definitions.  Read the
330 documentation for the C<filetest> pragma for more information.
331
332 Note that C<-s/a/b/> does not do a negated substitution.  Saying
333 C<-exp($foo)> still works as expected, however--only single letters
334 following a minus are interpreted as file tests.
335
336 The C<-T> and C<-B> switches work as follows.  The first block or so of the
337 file is examined for odd characters such as strange control codes or
338 characters with the high bit set.  If too many strange characters (E<gt>30%)
339 are found, it's a C<-B> file, otherwise it's a C<-T> file.  Also, any file
340 containing null in the first block is considered a binary file.  If C<-T>
341 or C<-B> is used on a filehandle, the current stdio buffer is examined
342 rather than the first block.  Both C<-T> and C<-B> return true on a null
343 file, or a file at EOF when testing a filehandle.  Because you have to
344 read a file to do the C<-T> test, on most occasions you want to use a C<-f>
345 against the file first, as in C<next unless -f $file && -T $file>.
346
347 If any of the file tests (or either the C<stat> or C<lstat> operators) are given
348 the special filehandle consisting of a solitary underline, then the stat
349 structure of the previous file test (or stat operator) is used, saving
350 a system call.  (This doesn't work with C<-t>, and you need to remember
351 that lstat() and C<-l> will leave values in the stat structure for the
352 symbolic link, not the real file.)  Example:
353
354     print "Can do.\n" if -r $a || -w _ || -x _;
355
356     stat($filename);
357     print "Readable\n" if -r _;
358     print "Writable\n" if -w _;
359     print "Executable\n" if -x _;
360     print "Setuid\n" if -u _;
361     print "Setgid\n" if -g _;
362     print "Sticky\n" if -k _;
363     print "Text\n" if -T _;
364     print "Binary\n" if -B _;
365
366 =item abs VALUE
367
368 =item abs
369
370 Returns the absolute value of its argument.
371 If VALUE is omitted, uses C<$_>.
372
373 =item accept NEWSOCKET,GENERICSOCKET
374
375 Accepts an incoming socket connect, just as the accept(2) system call
376 does.  Returns the packed address if it succeeded, false otherwise.
377 See the example in L<perlipc/"Sockets: Client/Server Communication">.
378
379 =item alarm SECONDS
380
381 =item alarm
382
383 Arranges to have a SIGALRM delivered to this process after the
384 specified number of seconds have elapsed.  If SECONDS is not specified,
385 the value stored in C<$_> is used. (On some machines,
386 unfortunately, the elapsed time may be up to one second less than you
387 specified because of how seconds are counted.)  Only one timer may be
388 counting at once.  Each call disables the previous timer, and an
389 argument of C<0> may be supplied to cancel the previous timer without
390 starting a new one.  The returned value is the amount of time remaining
391 on the previous timer.
392
393 For delays of finer granularity than one second, you may use Perl's
394 four-argument version of select() leaving the first three arguments
395 undefined, or you might be able to use the C<syscall> interface to
396 access setitimer(2) if your system supports it.  The Time::HiRes module
397 from CPAN may also prove useful.
398
399 It is usually a mistake to intermix C<alarm> and C<sleep> calls.
400 (C<sleep> may be internally implemented in your system with C<alarm>)
401
402 If you want to use C<alarm> to time out a system call you need to use an
403 C<eval>/C<die> pair.  You can't rely on the alarm causing the system call to
404 fail with C<$!> set to C<EINTR> because Perl sets up signal handlers to
405 restart system calls on some systems.  Using C<eval>/C<die> always works,
406 modulo the caveats given in L<perlipc/"Signals">.
407
408     eval {
409         local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required
410         alarm $timeout;
411         $nread = sysread SOCKET, $buffer, $size;
412         alarm 0;
413     };
414     if ($@) {
415         die unless $@ eq "alarm\n";   # propagate unexpected errors
416         # timed out
417     }
418     else {
419         # didn't
420     }
421
422 =item atan2 Y,X
423
424 Returns the arctangent of Y/X in the range -PI to PI.
425
426 For the tangent operation, you may use the C<POSIX::tan()>
427 function, or use the familiar relation:
428
429     sub tan { sin($_[0]) / cos($_[0])  }
430
431 =item bind SOCKET,NAME
432
433 Binds a network address to a socket, just as the bind system call
434 does.  Returns true if it succeeded, false otherwise.  NAME should be a
435 packed address of the appropriate type for the socket.  See the examples in
436 L<perlipc/"Sockets: Client/Server Communication">.
437
438 =item binmode FILEHANDLE
439
440 Arranges for FILEHANDLE to be read or written in "binary" mode on
441 systems whose run-time libraries force the programmer to guess
442 between binary and text files.  If FILEHANDLE is an expression, the
443 value is taken as the name of the filehandle.  binmode() should be
444 called after the C<open> but before any I/O is done on the filehandle.
445 The only way to reset binary mode on a filehandle is to reopen the
446 file.
447
448 The operating system, device drivers, C libraries, and Perl run-time
449 system all conspire to let the programmer conveniently treat a
450 simple, one-byte C<\n> as the line terminator, irrespective of its
451 external representation.  On Unix and its brethren, the native file
452 representation exactly matches the internal representation, making
453 everyone's lives unbelievably simpler.  Consequently, L<binmode>
454 has no effect under Unix, Plan9, or Mac OS, all of which use C<\n>
455 to end each line.  (Unix and Plan9 think C<\n> means C<\cJ> and
456 C<\r> means C<\cM>, whereas the Mac goes the other way--it uses
457 C<\cM> for c<\n> and C<\cJ> to mean C<\r>.  But that's ok, because
458 it's only one byte, and the internal and external representations
459 match.)
460
461 In legacy systems like MS-DOS and its embellishments, your program
462 sees a C<\n> as a simple C<\cJ> (just as in Unix), but oddly enough,
463 that's not what's physically stored on disk.  What's worse, these
464 systems refuse to help you with this; it's up to you to remember
465 what to do.  And you mustn't go applying binmode() with wild abandon,
466 either, because if your system does care about binmode(), then using
467 it when you shouldn't is just as perilous as failing to use it when
468 you should.
469
470 That means that on any version of Microsoft WinXX that you might
471 care to name (or not), binmode() causes C<\cM\cJ> sequences on disk
472 to be converted to C<\n> when read into your program, and causes
473 any C<\n> in your program to be converted back to C<\cM\cJ> on
474 output to disk.  This sad discrepancy leads to no end of
475 problems in not just the readline operator, but also when using
476 seek(), tell(), and read() calls.  See L<perlport> for other painful
477 details.  See the C<$/> and C<$\> variables in L<perlvar> for how
478 to manually set your input and output line-termination sequences.
479
480 =item bless REF,CLASSNAME
481
482 =item bless REF
483
484 This function tells the thingy referenced by REF that it is now an object
485 in the CLASSNAME package.  If CLASSNAME is omitted, the current package
486 is used.  Because a C<bless> is often the last thing in a constructor,
487 it returns the reference for convenience.  Always use the two-argument
488 version if the function doing the blessing might be inherited by a
489 derived class.  See L<perltoot> and L<perlobj> for more about the blessing
490 (and blessings) of objects.
491
492 Consider always blessing objects in CLASSNAMEs that are mixed case.
493 Namespaces with all lowercase names are considered reserved for
494 Perl pragmata.  Builtin types have all uppercase names, so to prevent
495 confusion, you may wish to avoid such package names as well.  Make sure
496 that CLASSNAME is a true value.
497
498 See L<perlmod/"Perl Modules">.
499
500 =item caller EXPR
501
502 =item caller
503
504 Returns the context of the current subroutine call.  In scalar context,
505 returns the caller's package name if there is a caller, that is, if
506 we're in a subroutine or C<eval> or C<require>, and the undefined value
507 otherwise.  In list context, returns
508
509     ($package, $filename, $line) = caller;
510
511 With EXPR, it returns some extra information that the debugger uses to
512 print a stack trace.  The value of EXPR indicates how many call frames
513 to go back before the current one.
514
515     ($package, $filename, $line, $subroutine, $hasargs,
516     $wantarray, $evaltext, $is_require, $hints) = caller($i);
517
518 Here $subroutine may be C<(eval)> if the frame is not a subroutine
519 call, but an C<eval>.  In such a case additional elements $evaltext and
520 C<$is_require> are set: C<$is_require> is true if the frame is created by a
521 C<require> or C<use> statement, $evaltext contains the text of the
522 C<eval EXPR> statement.  In particular, for a C<eval BLOCK> statement,
523 $filename is C<(eval)>, but $evaltext is undefined.  (Note also that
524 each C<use> statement creates a C<require> frame inside an C<eval EXPR>)
525 frame.  C<$hints> contains pragmatic hints that the caller was
526 compiled with.  It currently only reflects the hint corresponding to
527 C<use utf8>.
528
529 Furthermore, when called from within the DB package, caller returns more
530 detailed information: it sets the list variable C<@DB::args> to be the
531 arguments with which the subroutine was invoked.
532
533 Be aware that the optimizer might have optimized call frames away before
534 C<caller> had a chance to get the information.  That means that C<caller(N)>
535 might not return information about the call frame you expect it do, for
536 C<N E<gt> 1>.  In particular, C<@DB::args> might have information from the 
537 previous time C<caller> was called.
538
539 =item chdir EXPR
540
541 Changes the working directory to EXPR, if possible.  If EXPR is omitted,
542 changes to the user's home directory.  Returns true upon success,
543 false otherwise.  See the example under C<die>.
544
545 =item chmod LIST
546
547 Changes the permissions of a list of files.  The first element of the
548 list must be the numerical mode, which should probably be an octal
549 number, and which definitely should I<not> a string of octal digits:
550 C<0644> is okay, C<'0644'> is not.  Returns the number of files
551 successfully changed.  See also L</oct>, if all you have is a string.
552
553     $cnt = chmod 0755, 'foo', 'bar';
554     chmod 0755, @executables;
555     $mode = '0644'; chmod $mode, 'foo';      # !!! sets mode to
556                                              # --w----r-T
557     $mode = '0644'; chmod oct($mode), 'foo'; # this is better
558     $mode = 0644;   chmod $mode, 'foo';      # this is best
559
560 =item chomp VARIABLE
561
562 =item chomp LIST
563
564 =item chomp
565
566 This safer version of L</chop> removes any trailing string
567 that corresponds to the current value of C<$/> (also known as
568 $INPUT_RECORD_SEPARATOR in the C<English> module).  It returns the total
569 number of characters removed from all its arguments.  It's often used to
570 remove the newline from the end of an input record when you're worried
571 that the final record may be missing its newline.  When in paragraph
572 mode (C<$/ = "">), it removes all trailing newlines from the string.
573 When in slurp mode (C<$/ = undef>) or fixed-length record mode (C<$/> is
574 a reference to an integer or the like, see L<perlvar>) chomp() won't
575 remove anything.  
576 If VARIABLE is omitted, it chomps C<$_>.  Example:
577
578     while (<>) {
579         chomp;  # avoid \n on last field
580         @array = split(/:/);
581         # ...
582     }
583
584 You can actually chomp anything that's an lvalue, including an assignment:
585
586     chomp($cwd = `pwd`);
587     chomp($answer = <STDIN>);
588
589 If you chomp a list, each element is chomped, and the total number of
590 characters removed is returned.
591
592 =item chop VARIABLE
593
594 =item chop LIST
595
596 =item chop
597
598 Chops off the last character of a string and returns the character
599 chopped.  It's used primarily to remove the newline from the end of an
600 input record, but is much more efficient than C<s/\n//> because it neither
601 scans nor copies the string.  If VARIABLE is omitted, chops C<$_>.
602 Example:
603
604     while (<>) {
605         chop;   # avoid \n on last field
606         @array = split(/:/);
607         #...
608     }
609
610 You can actually chop anything that's an lvalue, including an assignment:
611
612     chop($cwd = `pwd`);
613     chop($answer = <STDIN>);
614
615 If you chop a list, each element is chopped.  Only the value of the
616 last C<chop> is returned.
617
618 Note that C<chop> returns the last character.  To return all but the last
619 character, use C<substr($string, 0, -1)>.
620
621 =item chown LIST
622
623 Changes the owner (and group) of a list of files.  The first two
624 elements of the list must be the I<numeric> uid and gid, in that
625 order.  A value of -1 in either position is interpreted by most
626 systems to leave that value unchanged.  Returns the number of files
627 successfully changed.
628
629     $cnt = chown $uid, $gid, 'foo', 'bar';
630     chown $uid, $gid, @filenames;
631
632 Here's an example that looks up nonnumeric uids in the passwd file:
633
634     print "User: ";
635     chomp($user = <STDIN>);
636     print "Files: ";
637     chomp($pattern = <STDIN>);
638
639     ($login,$pass,$uid,$gid) = getpwnam($user)
640         or die "$user not in passwd file";
641
642     @ary = glob($pattern);      # expand filenames
643     chown $uid, $gid, @ary;
644
645 On most systems, you are not allowed to change the ownership of the
646 file unless you're the superuser, although you should be able to change
647 the group to any of your secondary groups.  On insecure systems, these
648 restrictions may be relaxed, but this is not a portable assumption.
649 On POSIX systems, you can detect this condition this way:
650
651     use POSIX qw(sysconf _PC_CHOWN_RESTRICTED);
652     $can_chown_giveaway = not sysconf(_PC_CHOWN_RESTRICTED);
653
654 =item chr NUMBER
655
656 =item chr
657
658 Returns the character represented by that NUMBER in the character set.
659 For example, C<chr(65)> is C<"A"> in either ASCII or Unicode, and
660 chr(0x263a) is a Unicode smiley face (but only within the scope of
661 a C<use utf8>).  For the reverse, use L</ord>.  
662 See L<utf8> for more about Unicode.
663
664 If NUMBER is omitted, uses C<$_>.
665
666 =item chroot FILENAME
667
668 =item chroot
669
670 This function works like the system call by the same name: it makes the
671 named directory the new root directory for all further pathnames that
672 begin with a C</> by your process and all its children.  (It doesn't
673 change your current working directory, which is unaffected.)  For security
674 reasons, this call is restricted to the superuser.  If FILENAME is
675 omitted, does a C<chroot> to C<$_>.
676
677 =item close FILEHANDLE
678
679 =item close
680
681 Closes the file or pipe associated with the file handle, returning true
682 only if stdio successfully flushes buffers and closes the system file
683 descriptor.  Closes the currently selected filehandle if the argument
684 is omitted.
685
686 You don't have to close FILEHANDLE if you are immediately going to do
687 another C<open> on it, because C<open> will close it for you.  (See
688 C<open>.)  However, an explicit C<close> on an input file resets the line
689 counter (C<$.>), while the implicit close done by C<open> does not.
690
691 If the file handle came from a piped open C<close> will additionally
692 return false if one of the other system calls involved fails or if the
693 program exits with non-zero status.  (If the only problem was that the
694 program exited non-zero C<$!> will be set to C<0>.)  Closing a pipe 
695 also waits for the process executing on the pipe to complete, in case you
696 want to look at the output of the pipe afterwards, and 
697 implicitly puts the exit status value of that command into C<$?>.
698
699 Prematurely closing the read end of a pipe (i.e. before the process
700 writing to it at the other end has closed it) will result in a
701 SIGPIPE being delivered to the writer.  If the other end can't
702 handle that, be sure to read all the data before closing the pipe.
703
704 Example:
705
706     open(OUTPUT, '|sort >foo')  # pipe to sort
707         or die "Can't start sort: $!";
708     #...                        # print stuff to output
709     close OUTPUT                # wait for sort to finish
710         or warn $! ? "Error closing sort pipe: $!"
711                    : "Exit status $? from sort";
712     open(INPUT, 'foo')          # get sort's results
713         or die "Can't open 'foo' for input: $!";
714
715 FILEHANDLE may be an expression whose value can be used as an indirect
716 filehandle, usually the real filehandle name.
717
718 =item closedir DIRHANDLE
719
720 Closes a directory opened by C<opendir> and returns the success of that
721 system call.
722
723 DIRHANDLE may be an expression whose value can be used as an indirect
724 dirhandle, usually the real dirhandle name.
725
726 =item connect SOCKET,NAME
727
728 Attempts to connect to a remote socket, just as the connect system call
729 does.  Returns true if it succeeded, false otherwise.  NAME should be a
730 packed address of the appropriate type for the socket.  See the examples in
731 L<perlipc/"Sockets: Client/Server Communication">.
732
733 =item continue BLOCK
734
735 Actually a flow control statement rather than a function.  If there is a
736 C<continue> BLOCK attached to a BLOCK (typically in a C<while> or
737 C<foreach>), it is always executed just before the conditional is about to
738 be evaluated again, just like the third part of a C<for> loop in C.  Thus
739 it can be used to increment a loop variable, even when the loop has been
740 continued via the C<next> statement (which is similar to the C C<continue>
741 statement).
742
743 C<last>, C<next>, or C<redo> may appear within a C<continue>
744 block.  C<last> and C<redo> will behave as if they had been executed within
745 the main block.  So will C<next>, but since it will execute a C<continue>
746 block, it may be more entertaining.
747
748     while (EXPR) {
749         ### redo always comes here
750         do_something;
751     } continue {
752         ### next always comes here
753         do_something_else;
754         # then back the top to re-check EXPR
755     }
756     ### last always comes here
757
758 Omitting the C<continue> section is semantically equivalent to using an
759 empty one, logically enough.  In that case, C<next> goes directly back
760 to check the condition at the top of the loop.
761
762 =item cos EXPR
763
764 Returns the cosine of EXPR (expressed in radians).  If EXPR is omitted,
765 takes cosine of C<$_>.
766
767 For the inverse cosine operation, you may use the C<POSIX::acos()>
768 function, or use this relation:
769
770     sub acos { atan2( sqrt(1 - $_[0] * $_[0]), $_[0] ) }
771
772 =item crypt PLAINTEXT,SALT
773
774 Encrypts a string exactly like the crypt(3) function in the C library
775 (assuming that you actually have a version there that has not been
776 extirpated as a potential munition).  This can prove useful for checking
777 the password file for lousy passwords, amongst other things.  Only the
778 guys wearing white hats should do this.
779
780 Note that C<crypt> is intended to be a one-way function, much like breaking
781 eggs to make an omelette.  There is no (known) corresponding decrypt
782 function.  As a result, this function isn't all that useful for
783 cryptography.  (For that, see your nearby CPAN mirror.)
784
785 When verifying an existing encrypted string you should use the encrypted
786 text as the salt (like C<crypt($plain, $crypted) eq $crypted>).  This
787 allows your code to work with the standard C<crypt> and with more
788 exotic implementations.  When choosing a new salt create a random two
789 character string whose characters come from the set C<[./0-9A-Za-z]>
790 (like C<join '', ('.', '/', 0..9, 'A'..'Z', 'a'..'z')[rand 64, rand 64]>).
791
792 Here's an example that makes sure that whoever runs this program knows
793 their own password:
794
795     $pwd = (getpwuid($<))[1];
796
797     system "stty -echo";
798     print "Password: ";
799     chomp($word = <STDIN>);
800     print "\n";
801     system "stty echo";
802
803     if (crypt($word, $pwd) ne $pwd) {
804         die "Sorry...\n";
805     } else {
806         print "ok\n";
807     }
808
809 Of course, typing in your own password to whoever asks you
810 for it is unwise.
811
812 The L<crypt> function is unsuitable for encrypting large quantities
813 of data, not least of all because you can't get the information
814 back.  Look at the F<by-module/Crypt> and F<by-module/PGP> directories
815 on your favorite CPAN mirror for a slew of potentially useful
816 modules.
817
818 =item dbmclose HASH
819
820 [This function has been largely superseded by the C<untie> function.]
821
822 Breaks the binding between a DBM file and a hash.
823
824 =item dbmopen HASH,DBNAME,MASK
825
826 [This function has been largely superseded by the C<tie> function.]
827
828 This binds a dbm(3), ndbm(3), sdbm(3), gdbm(3), or Berkeley DB file to a
829 hash.  HASH is the name of the hash.  (Unlike normal C<open>, the first
830 argument is I<not> a filehandle, even though it looks like one).  DBNAME
831 is the name of the database (without the F<.dir> or F<.pag> extension if
832 any).  If the database does not exist, it is created with protection
833 specified by MASK (as modified by the C<umask>).  If your system supports
834 only the older DBM functions, you may perform only one C<dbmopen> in your
835 program.  In older versions of Perl, if your system had neither DBM nor
836 ndbm, calling C<dbmopen> produced a fatal error; it now falls back to
837 sdbm(3).
838
839 If you don't have write access to the DBM file, you can only read hash
840 variables, not set them.  If you want to test whether you can write,
841 either use file tests or try setting a dummy hash entry inside an C<eval>,
842 which will trap the error.
843
844 Note that functions such as C<keys> and C<values> may return huge lists
845 when used on large DBM files.  You may prefer to use the C<each>
846 function to iterate over large DBM files.  Example:
847
848     # print out history file offsets
849     dbmopen(%HIST,'/usr/lib/news/history',0666);
850     while (($key,$val) = each %HIST) {
851         print $key, ' = ', unpack('L',$val), "\n";
852     }
853     dbmclose(%HIST);
854
855 See also L<AnyDBM_File> for a more general description of the pros and
856 cons of the various dbm approaches, as well as L<DB_File> for a particularly
857 rich implementation.
858
859 You can control which DBM library you use by loading that library
860 before you call dbmopen():
861
862     use DB_File;
863     dbmopen(%NS_Hist, "$ENV{HOME}/.netscape/history.db")
864         or die "Can't open netscape history file: $!";
865
866 =item defined EXPR
867
868 =item defined
869
870 Returns a Boolean value telling whether EXPR has a value other than
871 the undefined value C<undef>.  If EXPR is not present, C<$_> will be
872 checked.
873
874 Many operations return C<undef> to indicate failure, end of file,
875 system error, uninitialized variable, and other exceptional
876 conditions.  This function allows you to distinguish C<undef> from
877 other values.  (A simple Boolean test will not distinguish among
878 C<undef>, zero, the empty string, and C<"0">, which are all equally
879 false.)  Note that since C<undef> is a valid scalar, its presence
880 doesn't I<necessarily> indicate an exceptional condition: C<pop>
881 returns C<undef> when its argument is an empty array, I<or> when the
882 element to return happens to be C<undef>.
883
884 You may also use C<defined(&func)> to check whether subroutine C<&func>
885 has ever been defined.  The return value is unaffected by any forward
886 declarations of C<&foo>.
887
888 Use of C<defined> on aggregates (hashes and arrays) is deprecated.  It
889 used to report whether memory for that aggregate has ever been
890 allocated.  This behavior may disappear in future versions of Perl.
891 You should instead use a simple test for size:
892
893     if (@an_array) { print "has array elements\n" }
894     if (%a_hash)   { print "has hash members\n"   }
895
896 When used on a hash element, it tells you whether the value is defined,
897 not whether the key exists in the hash.  Use L</exists> for the latter
898 purpose.
899
900 Examples:
901
902     print if defined $switch{'D'};
903     print "$val\n" while defined($val = pop(@ary));
904     die "Can't readlink $sym: $!"
905         unless defined($value = readlink $sym);
906     sub foo { defined &$bar ? &$bar(@_) : die "No bar"; }
907     $debugging = 0 unless defined $debugging;
908
909 Note:  Many folks tend to overuse C<defined>, and then are surprised to
910 discover that the number C<0> and C<""> (the zero-length string) are, in fact,
911 defined values.  For example, if you say
912
913     "ab" =~ /a(.*)b/;
914
915 The pattern match succeeds, and C<$1> is defined, despite the fact that it
916 matched "nothing".  But it didn't really match nothing--rather, it
917 matched something that happened to be zero characters long.  This is all
918 very above-board and honest.  When a function returns an undefined value,
919 it's an admission that it couldn't give you an honest answer.  So you
920 should use C<defined> only when you're questioning the integrity of what
921 you're trying to do.  At other times, a simple comparison to C<0> or C<""> is
922 what you want.
923
924 See also L</undef>, L</exists>, L</ref>.
925
926 =item delete EXPR
927
928 Deletes the specified key(s) and their associated values from a hash.
929 For each key, returns the deleted value associated with that key, or
930 the undefined value if there was no such key.  Deleting from C<$ENV{}>
931 modifies the environment.  Deleting from a hash tied to a DBM file
932 deletes the entry from the DBM file.  (But deleting from a C<tie>d hash
933 doesn't necessarily return anything.)
934
935 The following deletes all the values of a hash:
936
937     foreach $key (keys %HASH) {
938         delete $HASH{$key};
939     }
940
941 And so does this:
942
943     delete @HASH{keys %HASH}
944
945 But both of these are slower than just assigning the empty list
946 or undefining it:
947
948     %hash = ();         # completely empty %hash
949     undef %hash;        # forget %hash every existed
950
951 Note that the EXPR can be arbitrarily complicated as long as the final
952 operation is a hash element lookup or hash slice:
953
954     delete $ref->[$x][$y]{$key};
955     delete @{$ref->[$x][$y]}{$key1, $key2, @morekeys};
956
957 =item die LIST
958
959 Outside an C<eval>, prints the value of LIST to C<STDERR> and
960 exits with the current value of C<$!> (errno).  If C<$!> is C<0>,
961 exits with the value of C<($? E<gt>E<gt> 8)> (backtick `command`
962 status).  If C<($? E<gt>E<gt> 8)> is C<0>, exits with C<255>.  Inside
963 an C<eval(),> the error message is stuffed into C<$@> and the
964 C<eval> is terminated with the undefined value.  This makes
965 C<die> the way to raise an exception.
966
967 Equivalent examples:
968
969     die "Can't cd to spool: $!\n" unless chdir '/usr/spool/news';
970     chdir '/usr/spool/news' or die "Can't cd to spool: $!\n"
971
972 If the value of EXPR does not end in a newline, the current script line
973 number and input line number (if any) are also printed, and a newline
974 is supplied.  Note that the "input line number" (also known as "chunk")
975 is subject to whatever notion of "line" happens to be currently in
976 effect, and is also available as the special variable C<$.>.
977 See L<perlvar/"$/"> and L<perlvar/"$.">.
978
979 Hint: sometimes appending C<", stopped"> to your message
980 will cause it to make better sense when the string C<"at foo line 123"> is
981 appended.  Suppose you are running script "canasta".
982
983     die "/etc/games is no good";
984     die "/etc/games is no good, stopped";
985
986 produce, respectively
987
988     /etc/games is no good at canasta line 123.
989     /etc/games is no good, stopped at canasta line 123.
990
991 See also exit(), warn(), and the Carp module.
992
993 If LIST is empty and C<$@> already contains a value (typically from a
994 previous eval) that value is reused after appending C<"\t...propagated">.
995 This is useful for propagating exceptions:
996
997     eval { ... };
998     die unless $@ =~ /Expected exception/;
999
1000 If C<$@> is empty then the string C<"Died"> is used.
1001
1002 die() can also be called with a reference argument.  If this happens to be
1003 trapped within an eval(), $@ contains the reference.  This behavior permits
1004 a more elaborate exception handling implementation using objects that
1005 maintain arbitary state about the nature of the exception.  Such a scheme
1006 is sometimes preferable to matching particular string values of $@ using
1007 regular expressions.  Here's an example:
1008
1009     eval { ... ; die Some::Module::Exception->new( FOO => "bar" ) };
1010     if ($@) {
1011         if (ref($@) && UNIVERSAL::isa($@,"Some::Module::Exception")) {
1012             # handle Some::Module::Exception
1013         }
1014         else {
1015             # handle all other possible exceptions
1016         }
1017     }
1018
1019 Because perl will stringify uncaught exception messages before displaying
1020 them, you may want to overload stringification operations on such custom
1021 exception objects.  See L<overload> for details about that.
1022
1023 You can arrange for a callback to be run just before the C<die>
1024 does its deed, by setting the C<$SIG{__DIE__}> hook.  The associated
1025 handler will be called with the error text and can change the error
1026 message, if it sees fit, by calling C<die> again.  See
1027 L<perlvar/$SIG{expr}> for details on setting C<%SIG> entries, and
1028 L<"eval BLOCK"> for some examples.  Although this feature was meant
1029 to be run only right before your program was to exit, this is not
1030 currently the case--the C<$SIG{__DIE__}> hook is currently called
1031 even inside eval()ed blocks/strings!  If one wants the hook to do
1032 nothing in such situations, put
1033
1034         die @_ if $^S;
1035
1036 as the first line of the handler (see L<perlvar/$^S>).  Because
1037 this promotes strange action at a distance, this counterintuitive
1038 behavior may be fixed in a future release.  
1039
1040 =item do BLOCK
1041
1042 Not really a function.  Returns the value of the last command in the
1043 sequence of commands indicated by BLOCK.  When modified by a loop
1044 modifier, executes the BLOCK once before testing the loop condition.
1045 (On other statements the loop modifiers test the conditional first.)
1046
1047 C<do BLOCK> does I<not> count as a loop, so the loop control statements
1048 C<next>, C<last>, or C<redo> cannot be used to leave or restart the block.
1049 See L<perlsyn> for alternative strategies.
1050
1051 =item do SUBROUTINE(LIST)
1052
1053 A deprecated form of subroutine call.  See L<perlsub>.
1054
1055 =item do EXPR
1056
1057 Uses the value of EXPR as a filename and executes the contents of the
1058 file as a Perl script.  Its primary use is to include subroutines
1059 from a Perl subroutine library.
1060
1061     do 'stat.pl';
1062
1063 is just like
1064
1065     scalar eval `cat stat.pl`;
1066
1067 except that it's more efficient and concise, keeps track of the current
1068 filename for error messages, searches the @INC libraries, and updates
1069 C<%INC> if the file is found.  See L<perlvar/Predefined Names> for these
1070 variables.  It also differs in that code evaluated with C<do FILENAME>
1071 cannot see lexicals in the enclosing scope; C<eval STRING> does.  It's the
1072 same, however, in that it does reparse the file every time you call it,
1073 so you probably don't want to do this inside a loop.
1074
1075 If C<do> cannot read the file, it returns undef and sets C<$!> to the
1076 error.  If C<do> can read the file but cannot compile it, it
1077 returns undef and sets an error message in C<$@>.   If the file is
1078 successfully compiled, C<do> returns the value of the last expression
1079 evaluated.
1080
1081 Note that inclusion of library modules is better done with the
1082 C<use> and C<require> operators, which also do automatic error checking
1083 and raise an exception if there's a problem.
1084
1085 You might like to use C<do> to read in a program configuration
1086 file.  Manual error checking can be done this way:
1087
1088     # read in config files: system first, then user 
1089     for $file ("/share/prog/defaults.rc",
1090                "$ENV{HOME}/.someprogrc") 
1091    {
1092         unless ($return = do $file) {
1093             warn "couldn't parse $file: $@" if $@;
1094             warn "couldn't do $file: $!"    unless defined $return;
1095             warn "couldn't run $file"       unless $return;
1096         }
1097     }
1098
1099 =item dump LABEL
1100
1101 =item dump
1102
1103 This function causes an immediate core dump.  See also the B<-u>
1104 command-line switch in L<perlrun>, which does the same thing.
1105 Primarily this is so that you can use the B<undump> program (not
1106 supplied) to turn your core dump into an executable binary after
1107 having initialized all your variables at the beginning of the
1108 program.  When the new binary is executed it will begin by executing
1109 a C<goto LABEL> (with all the restrictions that C<goto> suffers).
1110 Think of it as a goto with an intervening core dump and reincarnation.
1111 If C<LABEL> is omitted, restarts the program from the top.
1112
1113 B<WARNING>: Any files opened at the time of the dump will I<not>
1114 be open any more when the program is reincarnated, with possible
1115 resulting confusion on the part of Perl.  
1116
1117 This function is now largely obsolete, partly because it's very
1118 hard to convert a core file into an executable, and because the
1119 real compiler backends for generating portable bytecode and compilable
1120 C code have superseded it.
1121
1122 If you're looking to use L<dump> to speed up your program, consider
1123 generating bytecode or native C code as described in L<perlcc>.  If
1124 you're just trying to accelerate a CGI script, consider using the
1125 C<mod_perl> extension to B<Apache>, or the CPAN module, Fast::CGI.
1126 You might also consider autoloading or selfloading, which at least
1127 make your program I<appear> to run faster.  
1128
1129 =item each HASH
1130
1131 When called in list context, returns a 2-element list consisting of the
1132 key and value for the next element of a hash, so that you can iterate over
1133 it.  When called in scalar context, returns the key for only the "next"
1134 element in the hash.  (Note: Keys may be C<"0"> or C<"">, which are logically
1135 false; you may wish to avoid constructs like C<while ($k = each %foo) {}>
1136 for this reason.)
1137
1138 Entries are returned in an apparently random order.  The actual random
1139 order is subject to change in future versions of perl, but it is guaranteed
1140 to be in the same order as either the C<keys> or C<values> function
1141 would produce on the same (unmodified) hash.
1142
1143 When the hash is entirely read, a null array is returned in list context
1144 (which when assigned produces a false (C<0>) value), and C<undef> in
1145 scalar context.  The next call to C<each> after that will start iterating
1146 again.  There is a single iterator for each hash, shared by all C<each>,
1147 C<keys>, and C<values> function calls in the program; it can be reset by
1148 reading all the elements from the hash, or by evaluating C<keys HASH> or
1149 C<values HASH>.  If you add or delete elements of a hash while you're
1150 iterating over it, you may get entries skipped or duplicated, so don't.
1151
1152 The following prints out your environment like the printenv(1) program,
1153 only in a different order:
1154
1155     while (($key,$value) = each %ENV) {
1156         print "$key=$value\n";
1157     }
1158
1159 See also C<keys>, C<values> and C<sort>.
1160
1161 =item eof FILEHANDLE
1162
1163 =item eof ()
1164
1165 =item eof
1166
1167 Returns 1 if the next read on FILEHANDLE will return end of file, or if
1168 FILEHANDLE is not open.  FILEHANDLE may be an expression whose value
1169 gives the real filehandle.  (Note that this function actually
1170 reads a character and then C<ungetc>s it, so isn't very useful in an
1171 interactive context.)  Do not read from a terminal file (or call
1172 C<eof(FILEHANDLE)> on it) after end-of-file is reached.  File types such
1173 as terminals may lose the end-of-file condition if you do.
1174
1175 An C<eof> without an argument uses the last file read.  Using C<eof()>
1176 with empty parentheses is very different.  It refers to the pseudo file
1177 formed from the files listed on the command line and accessed via the
1178 C<E<lt>E<gt>> operator.  Since C<E<lt>E<gt>> isn't explicitly opened,
1179 as a normal filehandle is, an C<eof()> before C<E<lt>E<gt>> has been
1180 used will cause C<@ARGV> to be examined to determine if input is
1181 available.
1182
1183 In a C<while (E<lt>E<gt>)> loop, C<eof> or C<eof(ARGV)> can be used to
1184 detect the end of each file, C<eof()> will only detect the end of the
1185 last file.  Examples:
1186
1187     # reset line numbering on each input file
1188     while (<>) {
1189         next if /^\s*#/;        # skip comments 
1190         print "$.\t$_";
1191     } continue {
1192         close ARGV  if eof;     # Not eof()!
1193     }
1194
1195     # insert dashes just before last line of last file
1196     while (<>) {
1197         if (eof()) {            # check for end of current file
1198             print "--------------\n";
1199             close(ARGV);        # close or last; is needed if we
1200                                 # are reading from the terminal
1201         }
1202         print;
1203     }
1204
1205 Practical hint: you almost never need to use C<eof> in Perl, because the
1206 input operators typically return C<undef> when they run out of data, or if
1207 there was an error.
1208
1209 =item eval EXPR
1210
1211 =item eval BLOCK
1212
1213 In the first form, the return value of EXPR is parsed and executed as if it
1214 were a little Perl program.  The value of the expression (which is itself
1215 determined within scalar context) is first parsed, and if there weren't any
1216 errors, executed in the context of the current Perl program, so that any
1217 variable settings or subroutine and format definitions remain afterwards.
1218 Note that the value is parsed every time the eval executes.  If EXPR is
1219 omitted, evaluates C<$_>.  This form is typically used to delay parsing
1220 and subsequent execution of the text of EXPR until run time.
1221
1222 In the second form, the code within the BLOCK is parsed only once--at the
1223 same time the code surrounding the eval itself was parsed--and executed
1224 within the context of the current Perl program.  This form is typically
1225 used to trap exceptions more efficiently than the first (see below), while
1226 also providing the benefit of checking the code within BLOCK at compile
1227 time.
1228
1229 The final semicolon, if any, may be omitted from the value of EXPR or within
1230 the BLOCK.
1231
1232 In both forms, the value returned is the value of the last expression
1233 evaluated inside the mini-program; a return statement may be also used, just
1234 as with subroutines.  The expression providing the return value is evaluated
1235 in void, scalar, or list context, depending on the context of the eval itself.
1236 See L</wantarray> for more on how the evaluation context can be determined.
1237
1238 If there is a syntax error or runtime error, or a C<die> statement is
1239 executed, an undefined value is returned by C<eval>, and C<$@> is set to the
1240 error message.  If there was no error, C<$@> is guaranteed to be a null
1241 string.  Beware that using C<eval> neither silences perl from printing
1242 warnings to STDERR, nor does it stuff the text of warning messages into C<$@>.
1243 To do either of those, you have to use the C<$SIG{__WARN__}> facility.  See
1244 L</warn> and L<perlvar>.
1245
1246 Note that, because C<eval> traps otherwise-fatal errors, it is useful for
1247 determining whether a particular feature (such as C<socket> or C<symlink>)
1248 is implemented.  It is also Perl's exception trapping mechanism, where
1249 the die operator is used to raise exceptions.
1250
1251 If the code to be executed doesn't vary, you may use the eval-BLOCK
1252 form to trap run-time errors without incurring the penalty of
1253 recompiling each time.  The error, if any, is still returned in C<$@>.
1254 Examples:
1255
1256     # make divide-by-zero nonfatal
1257     eval { $answer = $a / $b; }; warn $@ if $@;
1258
1259     # same thing, but less efficient
1260     eval '$answer = $a / $b'; warn $@ if $@;
1261
1262     # a compile-time error
1263     eval { $answer = };                 # WRONG
1264
1265     # a run-time error
1266     eval '$answer =';   # sets $@
1267
1268 Due to the current arguably broken state of C<__DIE__> hooks, when using
1269 the C<eval{}> form as an exception trap in libraries, you may wish not
1270 to trigger any C<__DIE__> hooks that user code may have installed.
1271 You can use the C<local $SIG{__DIE__}> construct for this purpose,
1272 as shown in this example:
1273
1274     # a very private exception trap for divide-by-zero
1275     eval { local $SIG{'__DIE__'}; $answer = $a / $b; };
1276     warn $@ if $@;
1277
1278 This is especially significant, given that C<__DIE__> hooks can call
1279 C<die> again, which has the effect of changing their error messages:
1280
1281     # __DIE__ hooks may modify error messages
1282     {
1283        local $SIG{'__DIE__'} =
1284               sub { (my $x = $_[0]) =~ s/foo/bar/g; die $x };
1285        eval { die "foo lives here" };
1286        print $@ if $@;                # prints "bar lives here"
1287     }
1288
1289 Because this promotes action at a distance, this counterintuitive behavior
1290 may be fixed in a future release.
1291
1292 With an C<eval>, you should be especially careful to remember what's
1293 being looked at when:
1294
1295     eval $x;            # CASE 1
1296     eval "$x";          # CASE 2
1297
1298     eval '$x';          # CASE 3
1299     eval { $x };        # CASE 4
1300
1301     eval "\$$x++";      # CASE 5
1302     $$x++;              # CASE 6
1303
1304 Cases 1 and 2 above behave identically: they run the code contained in
1305 the variable $x.  (Although case 2 has misleading double quotes making
1306 the reader wonder what else might be happening (nothing is).)  Cases 3
1307 and 4 likewise behave in the same way: they run the code C<'$x'>, which
1308 does nothing but return the value of $x.  (Case 4 is preferred for
1309 purely visual reasons, but it also has the advantage of compiling at
1310 compile-time instead of at run-time.)  Case 5 is a place where
1311 normally you I<would> like to use double quotes, except that in this
1312 particular situation, you can just use symbolic references instead, as
1313 in case 6.
1314
1315 C<eval BLOCK> does I<not> count as a loop, so the loop control statements
1316 C<next>, C<last>, or C<redo> cannot be used to leave or restart the block.
1317
1318 =item exec LIST
1319
1320 =item exec PROGRAM LIST
1321
1322 The C<exec> function executes a system command I<and never returns>--
1323 use C<system> instead of C<exec> if you want it to return.  It fails and
1324 returns false only if the command does not exist I<and> it is executed
1325 directly instead of via your system's command shell (see below).
1326
1327 Since it's a common mistake to use C<exec> instead of C<system>, Perl
1328 warns you if there is a following statement which isn't C<die>, C<warn>,
1329 or C<exit> (if C<-w> is set  -  but you always do that).   If you
1330 I<really> want to follow an C<exec> with some other statement, you
1331 can use one of these styles to avoid the warning:
1332
1333     exec ('foo')   or print STDERR "couldn't exec foo: $!";
1334     { exec ('foo') }; print STDERR "couldn't exec foo: $!";
1335
1336 If there is more than one argument in LIST, or if LIST is an array
1337 with more than one value, calls execvp(3) with the arguments in LIST.
1338 If there is only one scalar argument or an array with one element in it,
1339 the argument is checked for shell metacharacters, and if there are any,
1340 the entire argument is passed to the system's command shell for parsing
1341 (this is C</bin/sh -c> on Unix platforms, but varies on other platforms).
1342 If there are no shell metacharacters in the argument, it is split into
1343 words and passed directly to C<execvp>, which is more efficient.  
1344 Examples:
1345
1346     exec '/bin/echo', 'Your arguments are: ', @ARGV;
1347     exec "sort $outfile | uniq";
1348
1349 If you don't really want to execute the first argument, but want to lie
1350 to the program you are executing about its own name, you can specify
1351 the program you actually want to run as an "indirect object" (without a
1352 comma) in front of the LIST.  (This always forces interpretation of the
1353 LIST as a multivalued list, even if there is only a single scalar in
1354 the list.)  Example:
1355
1356     $shell = '/bin/csh';
1357     exec $shell '-sh';          # pretend it's a login shell
1358
1359 or, more directly,
1360
1361     exec {'/bin/csh'} '-sh';    # pretend it's a login shell
1362
1363 When the arguments get executed via the system shell, results will
1364 be subject to its quirks and capabilities.  See L<perlop/"`STRING`">
1365 for details.
1366
1367 Using an indirect object with C<exec> or C<system> is also more
1368 secure.  This usage (which also works fine with system()) forces
1369 interpretation of the arguments as a multivalued list, even if the
1370 list had just one argument.  That way you're safe from the shell
1371 expanding wildcards or splitting up words with whitespace in them.
1372
1373     @args = ( "echo surprise" );
1374
1375     exec @args;               # subject to shell escapes
1376                                 # if @args == 1
1377     exec { $args[0] } @args;  # safe even with one-arg list
1378
1379 The first version, the one without the indirect object, ran the I<echo>
1380 program, passing it C<"surprise"> an argument.  The second version
1381 didn't--it tried to run a program literally called I<"echo surprise">,
1382 didn't find it, and set C<$?> to a non-zero value indicating failure.
1383
1384 Note that C<exec> will not call your C<END> blocks, nor will it call
1385 any C<DESTROY> methods in your objects.
1386
1387 =item exists EXPR
1388
1389 Returns true if the specified hash key exists in its hash, even
1390 if the corresponding value is undefined.
1391
1392     print "Exists\n"    if exists $array{$key};
1393     print "Defined\n"   if defined $array{$key};
1394     print "True\n"      if $array{$key};
1395
1396 A hash element can be true only if it's defined, and defined if
1397 it exists, but the reverse doesn't necessarily hold true.
1398
1399 Note that the EXPR can be arbitrarily complicated as long as the final
1400 operation is a hash key lookup:
1401
1402     if (exists $ref->{A}->{B}->{$key})  { }
1403     if (exists $hash{A}{B}{$key})       { }
1404
1405 Although the last element will not spring into existence just because
1406 its existence was tested, intervening ones will.  Thus C<$ref-E<gt>{"A"}>
1407 and C<$ref-E<gt>{"A"}-E<gt>{"B"}> will spring into existence due to the
1408 existence test for a $key element.  This happens anywhere the arrow
1409 operator is used, including even 
1410
1411     undef $ref;
1412     if (exists $ref->{"Some key"})      { }
1413     print $ref;             # prints HASH(0x80d3d5c)
1414
1415 This surprising autovivification in what does not at first--or even
1416 second--glance appear to be an lvalue context may be fixed in a future
1417 release.
1418
1419 See L<perlref/"Pseudo-hashes"> for specifics on how exists() acts when
1420 used on a pseudo-hash.
1421
1422 =item exit EXPR
1423
1424 Evaluates EXPR and exits immediately with that value.    Example:
1425
1426     $ans = <STDIN>;
1427     exit 0 if $ans =~ /^[Xx]/;
1428
1429 See also C<die>.  If EXPR is omitted, exits with C<0> status.  The only
1430 universally recognized values for EXPR are C<0> for success and C<1>
1431 for error; other values are subject to interpretation depending on the
1432 environment in which the Perl program is running.  For example, exiting
1433 69 (EX_UNAVAILABLE) from a I<sendmail> incoming-mail filter will cause
1434 the mailer to return the item undelivered, but that's not true everywhere.
1435
1436 Don't use C<exit> to abort a subroutine if there's any chance that
1437 someone might want to trap whatever error happened.  Use C<die> instead,
1438 which can be trapped by an C<eval>.
1439
1440 The exit() function does not always exit immediately.  It calls any
1441 defined C<END> routines first, but these C<END> routines may not
1442 themselves abort the exit.  Likewise any object destructors that need to
1443 be called are called before the real exit.  If this is a problem, you
1444 can call C<POSIX:_exit($status)> to avoid END and destructor processing.
1445 See L<perlmod> for details.
1446
1447 =item exp EXPR
1448
1449 =item exp
1450
1451 Returns I<e> (the natural logarithm base) to the power of EXPR.  
1452 If EXPR is omitted, gives C<exp($_)>.
1453
1454 =item fcntl FILEHANDLE,FUNCTION,SCALAR
1455
1456 Implements the fcntl(2) function.  You'll probably have to say
1457
1458     use Fcntl;
1459
1460 first to get the correct constant definitions.  Argument processing and
1461 value return works just like C<ioctl> below.  
1462 For example:
1463
1464     use Fcntl;
1465     fcntl($filehandle, F_GETFL, $packed_return_buffer)
1466         or die "can't fcntl F_GETFL: $!";
1467
1468 You don't have to check for C<defined> on the return from C<fnctl>.
1469 Like C<ioctl>, it maps a C<0> return from the system call into
1470 C<"0 but true"> in Perl.  This string is true in boolean context and C<0>
1471 in numeric context.  It is also exempt from the normal B<-w> warnings
1472 on improper numeric conversions.
1473
1474 Note that C<fcntl> will produce a fatal error if used on a machine that
1475 doesn't implement fcntl(2).  See the Fcntl module or your fcntl(2)
1476 manpage to learn what functions are available on your system.
1477
1478 =item fileno FILEHANDLE
1479
1480 Returns the file descriptor for a filehandle, or undefined if the
1481 filehandle is not open.  This is mainly useful for constructing
1482 bitmaps for C<select> and low-level POSIX tty-handling operations.
1483 If FILEHANDLE is an expression, the value is taken as an indirect
1484 filehandle, generally its name.
1485
1486 You can use this to find out whether two handles refer to the 
1487 same underlying descriptor:
1488
1489     if (fileno(THIS) == fileno(THAT)) {
1490         print "THIS and THAT are dups\n";
1491     } 
1492
1493 =item flock FILEHANDLE,OPERATION
1494
1495 Calls flock(2), or an emulation of it, on FILEHANDLE.  Returns true
1496 for success, false on failure.  Produces a fatal error if used on a
1497 machine that doesn't implement flock(2), fcntl(2) locking, or lockf(3).
1498 C<flock> is Perl's portable file locking interface, although it locks
1499 only entire files, not records.
1500
1501 Two potentially non-obvious but traditional C<flock> semantics are
1502 that it waits indefinitely until the lock is granted, and that its locks
1503 B<merely advisory>.  Such discretionary locks are more flexible, but offer
1504 fewer guarantees.  This means that files locked with C<flock> may be
1505 modified by programs that do not also use C<flock>.  See L<perlport>,
1506 your port's specific documentation, or your system-specific local manpages
1507 for details.  It's best to assume traditional behavior if you're writing
1508 portable programs.  (But if you're not, you should as always feel perfectly
1509 free to write for your own system's idiosyncrasies (sometimes called
1510 "features").  Slavish adherence to portability concerns shouldn't get
1511 in the way of your getting your job done.)
1512
1513 OPERATION is one of LOCK_SH, LOCK_EX, or LOCK_UN, possibly combined with
1514 LOCK_NB.  These constants are traditionally valued 1, 2, 8 and 4, but
1515 you can use the symbolic names if import them from the Fcntl module,
1516 either individually, or as a group using the ':flock' tag.  LOCK_SH
1517 requests a shared lock, LOCK_EX requests an exclusive lock, and LOCK_UN
1518 releases a previously requested lock.  If LOCK_NB is added to LOCK_SH or
1519 LOCK_EX then C<flock> will return immediately rather than blocking
1520 waiting for the lock (check the return status to see if you got it).
1521
1522 To avoid the possibility of miscoordination, Perl now flushes FILEHANDLE
1523 before locking or unlocking it.
1524
1525 Note that the emulation built with lockf(3) doesn't provide shared
1526 locks, and it requires that FILEHANDLE be open with write intent.  These
1527 are the semantics that lockf(3) implements.  Most if not all systems
1528 implement lockf(3) in terms of fcntl(2) locking, though, so the
1529 differing semantics shouldn't bite too many people.
1530
1531 Note also that some versions of C<flock> cannot lock things over the
1532 network; you would need to use the more system-specific C<fcntl> for
1533 that.  If you like you can force Perl to ignore your system's flock(2)
1534 function, and so provide its own fcntl(2)-based emulation, by passing
1535 the switch C<-Ud_flock> to the F<Configure> program when you configure
1536 perl.
1537
1538 Here's a mailbox appender for BSD systems.
1539
1540     use Fcntl ':flock'; # import LOCK_* constants
1541
1542     sub lock {
1543         flock(MBOX,LOCK_EX);
1544         # and, in case someone appended
1545         # while we were waiting...
1546         seek(MBOX, 0, 2);
1547     }
1548
1549     sub unlock {
1550         flock(MBOX,LOCK_UN);
1551     }
1552
1553     open(MBOX, ">>/usr/spool/mail/$ENV{'USER'}")
1554             or die "Can't open mailbox: $!";
1555
1556     lock();
1557     print MBOX $msg,"\n\n";
1558     unlock();
1559
1560 On systems that support a real flock(), locks are inherited across fork()
1561 calls, whereas those that must resort to the more capricious fcntl()
1562 function lose the locks, making it harder to write servers.
1563
1564 See also L<DB_File> for other flock() examples.
1565
1566 =item fork
1567
1568 Does a fork(2) system call to create a new process running the
1569 same program at the same point.  It returns the child pid to the
1570 parent process, C<0> to the child process, or C<undef> if the fork is
1571 unsuccessful.  File descriptors (and sometimes locks on those descriptors)
1572 are shared, while everything else is copied.  On most systems supporting
1573 fork(), great care has gone into making it extremely efficient (for
1574 example, using copy-on-write technology on data pages), making it the
1575 dominant paradigm for multitasking over the last few decades.
1576
1577 All files opened for output are flushed before forking the child process.
1578
1579 If you C<fork> without ever waiting on your children, you will
1580 accumulate zombies.  On some systems, you can avoid this by setting
1581 C<$SIG{CHLD}> to C<"IGNORE">.  See also L<perlipc> for more examples of
1582 forking and reaping moribund children.
1583
1584 Note that if your forked child inherits system file descriptors like
1585 STDIN and STDOUT that are actually connected by a pipe or socket, even
1586 if you exit, then the remote server (such as, say, a CGI script or a
1587 backgrounded job launched from a remote shell) won't think you're done.
1588 You should reopen those to F</dev/null> if it's any issue.
1589
1590 =item format
1591
1592 Declare a picture format for use by the C<write> function.  For
1593 example:
1594
1595     format Something =
1596         Test: @<<<<<<<< @||||| @>>>>>
1597               $str,     $%,    '$' . int($num)
1598     .
1599
1600     $str = "widget";
1601     $num = $cost/$quantity;
1602     $~ = 'Something';
1603     write;
1604
1605 See L<perlform> for many details and examples.
1606
1607 =item formline PICTURE,LIST
1608
1609 This is an internal function used by C<format>s, though you may call it,
1610 too.  It formats (see L<perlform>) a list of values according to the
1611 contents of PICTURE, placing the output into the format output
1612 accumulator, C<$^A> (or C<$ACCUMULATOR> in English).
1613 Eventually, when a C<write> is done, the contents of
1614 C<$^A> are written to some filehandle, but you could also read C<$^A>
1615 yourself and then set C<$^A> back to C<"">.  Note that a format typically
1616 does one C<formline> per line of form, but the C<formline> function itself
1617 doesn't care how many newlines are embedded in the PICTURE.  This means
1618 that the C<~> and C<~~> tokens will treat the entire PICTURE as a single line.
1619 You may therefore need to use multiple formlines to implement a single
1620 record format, just like the format compiler.
1621
1622 Be careful if you put double quotes around the picture, because an C<@>
1623 character may be taken to mean the beginning of an array name.
1624 C<formline> always returns true.  See L<perlform> for other examples.
1625
1626 =item getc FILEHANDLE
1627
1628 =item getc
1629
1630 Returns the next character from the input file attached to FILEHANDLE,
1631 or the undefined value at end of file, or if there was an error.
1632 If FILEHANDLE is omitted, reads from STDIN.  This is not particularly
1633 efficient.  However, it cannot be used by itself to fetch single
1634 characters without waiting for the user to hit enter.  For that, try
1635 something more like:
1636
1637     if ($BSD_STYLE) {
1638         system "stty cbreak </dev/tty >/dev/tty 2>&1";
1639     }
1640     else {
1641         system "stty", '-icanon', 'eol', "\001";
1642     }
1643
1644     $key = getc(STDIN);
1645
1646     if ($BSD_STYLE) {
1647         system "stty -cbreak </dev/tty >/dev/tty 2>&1";
1648     }
1649     else {
1650         system "stty", 'icanon', 'eol', '^@'; # ASCII null
1651     }
1652     print "\n";
1653
1654 Determination of whether $BSD_STYLE should be set
1655 is left as an exercise to the reader.
1656
1657 The C<POSIX::getattr> function can do this more portably on
1658 systems purporting POSIX compliance.  See also the C<Term::ReadKey>
1659 module from your nearest CPAN site; details on CPAN can be found on
1660 L<perlmodlib/CPAN>.
1661
1662 =item getlogin
1663
1664 Implements the C library function of the same name, which on most
1665 systems returns the current login from F</etc/utmp>, if any.  If null,
1666 use C<getpwuid>.
1667
1668     $login = getlogin || getpwuid($<) || "Kilroy";
1669
1670 Do not consider C<getlogin> for authentication: it is not as
1671 secure as C<getpwuid>.
1672
1673 =item getpeername SOCKET
1674
1675 Returns the packed sockaddr address of other end of the SOCKET connection.
1676
1677     use Socket;
1678     $hersockaddr    = getpeername(SOCK);
1679     ($port, $iaddr) = sockaddr_in($hersockaddr);
1680     $herhostname    = gethostbyaddr($iaddr, AF_INET);
1681     $herstraddr     = inet_ntoa($iaddr);
1682
1683 =item getpgrp PID
1684
1685 Returns the current process group for the specified PID.  Use
1686 a PID of C<0> to get the current process group for the
1687 current process.  Will raise an exception if used on a machine that
1688 doesn't implement getpgrp(2).  If PID is omitted, returns process
1689 group of current process.  Note that the POSIX version of C<getpgrp>
1690 does not accept a PID argument, so only C<PID==0> is truly portable.
1691
1692 =item getppid
1693
1694 Returns the process id of the parent process.
1695
1696 =item getpriority WHICH,WHO
1697
1698 Returns the current priority for a process, a process group, or a user.
1699 (See L<getpriority(2)>.)  Will raise a fatal exception if used on a
1700 machine that doesn't implement getpriority(2).
1701
1702 =item getpwnam NAME
1703
1704 =item getgrnam NAME
1705
1706 =item gethostbyname NAME
1707
1708 =item getnetbyname NAME
1709
1710 =item getprotobyname NAME
1711
1712 =item getpwuid UID
1713
1714 =item getgrgid GID
1715
1716 =item getservbyname NAME,PROTO
1717
1718 =item gethostbyaddr ADDR,ADDRTYPE
1719
1720 =item getnetbyaddr ADDR,ADDRTYPE
1721
1722 =item getprotobynumber NUMBER
1723
1724 =item getservbyport PORT,PROTO
1725
1726 =item getpwent
1727
1728 =item getgrent
1729
1730 =item gethostent
1731
1732 =item getnetent
1733
1734 =item getprotoent
1735
1736 =item getservent
1737
1738 =item setpwent
1739
1740 =item setgrent
1741
1742 =item sethostent STAYOPEN
1743
1744 =item setnetent STAYOPEN
1745
1746 =item setprotoent STAYOPEN
1747
1748 =item setservent STAYOPEN
1749
1750 =item endpwent
1751
1752 =item endgrent
1753
1754 =item endhostent
1755
1756 =item endnetent
1757
1758 =item endprotoent
1759
1760 =item endservent
1761
1762 These routines perform the same functions as their counterparts in the
1763 system library.  In list context, the return values from the
1764 various get routines are as follows:
1765
1766     ($name,$passwd,$uid,$gid,
1767        $quota,$comment,$gcos,$dir,$shell,$expire) = getpw*
1768     ($name,$passwd,$gid,$members) = getgr*
1769     ($name,$aliases,$addrtype,$length,@addrs) = gethost*
1770     ($name,$aliases,$addrtype,$net) = getnet*
1771     ($name,$aliases,$proto) = getproto*
1772     ($name,$aliases,$port,$proto) = getserv*
1773
1774 (If the entry doesn't exist you get a null list.)
1775
1776 In scalar context, you get the name, unless the function was a
1777 lookup by name, in which case you get the other thing, whatever it is.
1778 (If the entry doesn't exist you get the undefined value.)  For example:
1779
1780     $uid   = getpwnam($name);
1781     $name  = getpwuid($num);
1782     $name  = getpwent();
1783     $gid   = getgrnam($name);
1784     $name  = getgrgid($num;
1785     $name  = getgrent();
1786     #etc.
1787
1788 In I<getpw*()> the fields $quota, $comment, and $expire are
1789 special cases in the sense that in many systems they are unsupported.
1790 If the $quota is unsupported, it is an empty scalar.  If it is
1791 supported, it usually encodes the disk quota.  If the $comment
1792 field is unsupported, it is an empty scalar.  If it is supported it
1793 usually encodes some administrative comment about the user.  In some
1794 systems the $quota field may be $change or $age, fields that have
1795 to do with password aging.  In some systems the $comment field may
1796 be $class.  The $expire field, if present, encodes the expiration
1797 period of the account or the password.  For the availability and the
1798 exact meaning of these fields in your system, please consult your
1799 getpwnam(3) documentation and your F<pwd.h> file.  You can also find
1800 out from within Perl what your $quota and $comment fields mean
1801 and whether you have the $expire field by using the C<Config> module
1802 and the values C<d_pwquota>, C<d_pwage>, C<d_pwchange>, C<d_pwcomment>,
1803 and C<d_pwexpire>.  Shadow password files are only supported if your
1804 vendor has implemented them in the intuitive fashion that calling the
1805 regular C library routines gets the shadow versions if you're running
1806 under privilege.  Those that incorrectly implement a separate library
1807 call are not supported.
1808
1809 The $members value returned by I<getgr*()> is a space separated list of
1810 the login names of the members of the group.
1811
1812 For the I<gethost*()> functions, if the C<h_errno> variable is supported in
1813 C, it will be returned to you via C<$?> if the function call fails.  The
1814 C<@addrs> value returned by a successful call is a list of the raw
1815 addresses returned by the corresponding system library call.  In the
1816 Internet domain, each address is four bytes long and you can unpack it
1817 by saying something like:
1818
1819     ($a,$b,$c,$d) = unpack('C4',$addr[0]);
1820
1821 The Socket library makes this slightly easier:
1822
1823     use Socket;
1824     $iaddr = inet_aton("127.1"); # or whatever address
1825     $name  = gethostbyaddr($iaddr, AF_INET);
1826
1827     # or going the other way
1828     $straddr = inet_ntoa($iaddr);
1829
1830 If you get tired of remembering which element of the return list
1831 contains which return value, by-name interfaces are provided
1832 in standard modules: C<File::stat>, C<Net::hostent>, C<Net::netent>,
1833 C<Net::protoent>, C<Net::servent>, C<Time::gmtime>, C<Time::localtime>,
1834 and C<User::grent>.  These override the normal built-ins, supplying
1835 versions that return objects with the appropriate names
1836 for each field.  For example:
1837
1838    use File::stat;
1839    use User::pwent;
1840    $is_his = (stat($filename)->uid == pwent($whoever)->uid);
1841
1842 Even though it looks like they're the same method calls (uid), 
1843 they aren't, because a C<File::stat> object is different from 
1844 a C<User::pwent> object.
1845
1846 =item getsockname SOCKET
1847
1848 Returns the packed sockaddr address of this end of the SOCKET connection,
1849 in case you don't know the address because you have several different
1850 IPs that the connection might have come in on.
1851
1852     use Socket;
1853     $mysockaddr = getsockname(SOCK);
1854     ($port, $myaddr) = sockaddr_in($mysockaddr);
1855     printf "Connect to %s [%s]\n", 
1856        scalar gethostbyaddr($myaddr, AF_INET),
1857        inet_ntoa($myaddr);
1858
1859 =item getsockopt SOCKET,LEVEL,OPTNAME
1860
1861 Returns the socket option requested, or undef if there is an error.
1862
1863 =item glob EXPR
1864
1865 =item glob
1866
1867 Returns the value of EXPR with filename expansions such as the
1868 standard Unix shell F</bin/csh> would do.  This is the internal function
1869 implementing the C<E<lt>*.cE<gt>> operator, but you can use it directly.
1870 If EXPR is omitted, C<$_> is used.  The C<E<lt>*.cE<gt>> operator is
1871 discussed in more detail in L<perlop/"I/O Operators">.
1872
1873 =item gmtime EXPR
1874
1875 Converts a time as returned by the time function to a 9-element list
1876 with the time localized for the standard Greenwich time zone.
1877 Typically used as follows:
1878
1879     #  0    1    2     3     4    5     6     7     8
1880     ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
1881                                             gmtime(time);
1882
1883 All list elements are numeric, and come straight out of a struct tm.
1884 In particular this means that $mon has the range C<0..11> and $wday
1885 has the range C<0..6> with sunday as day C<0>.  Also, $year is the
1886 number of years since 1900, that is, $year is C<123> in year 2023,
1887 I<not> simply the last two digits of the year.  If you assume it is,
1888 then you create non-Y2K-compliant programs--and you wouldn't want to do
1889 that, would you?
1890
1891 The proper way to get a complete 4-digit year is simply:
1892
1893         $year += 1900;
1894
1895 And to get the last two digits of the year (e.g., '01' in 2001) do:
1896
1897         $year = sprintf("%02d", $year % 100);
1898
1899 If EXPR is omitted, does C<gmtime(time())>.
1900
1901 In scalar context, returns the ctime(3) value:
1902
1903     $now_string = gmtime;  # e.g., "Thu Oct 13 04:54:34 1994"
1904
1905 Also see the C<timegm> function provided by the C<Time::Local> module,
1906 and the strftime(3) function available via the POSIX module.
1907
1908 This scalar value is B<not> locale dependent (see L<perllocale>), but
1909 is instead a Perl builtin.  Also see the C<Time::Local> module, and the
1910 strftime(3) and mktime(3) functions available via the POSIX module.  To
1911 get somewhat similar but locale dependent date strings, set up your
1912 locale environment variables appropriately (please see L<perllocale>)
1913 and try for example:
1914
1915     use POSIX qw(strftime);
1916     $now_string = strftime "%a %b %e %H:%M:%S %Y", gmtime;
1917
1918 Note that the C<%a> and C<%b> escapes, which represent the short forms
1919 of the day of the week and the month of the year, may not necessarily
1920 be three characters wide in all locales.
1921
1922 =item goto LABEL
1923
1924 =item goto EXPR
1925
1926 =item goto &NAME
1927
1928 The C<goto-LABEL> form finds the statement labeled with LABEL and resumes
1929 execution there.  It may not be used to go into any construct that
1930 requires initialization, such as a subroutine or a C<foreach> loop.  It
1931 also can't be used to go into a construct that is optimized away,
1932 or to get out of a block or subroutine given to C<sort>.
1933 It can be used to go almost anywhere else within the dynamic scope,
1934 including out of subroutines, but it's usually better to use some other
1935 construct such as C<last> or C<die>.  The author of Perl has never felt the
1936 need to use this form of C<goto> (in Perl, that is--C is another matter).
1937
1938 The C<goto-EXPR> form expects a label name, whose scope will be resolved
1939 dynamically.  This allows for computed C<goto>s per FORTRAN, but isn't
1940 necessarily recommended if you're optimizing for maintainability:
1941
1942     goto ("FOO", "BAR", "GLARCH")[$i];
1943
1944 The C<goto-&NAME> form is quite different from the other forms of C<goto>.
1945 In fact, it isn't a goto in the normal sense at all, and doesn't have
1946 the stigma associated with other gotos.  Instead, it
1947 substitutes a call to the named subroutine for the currently running
1948 subroutine.  This is used by C<AUTOLOAD> subroutines that wish to load
1949 another subroutine and then pretend that the other subroutine had been
1950 called in the first place (except that any modifications to C<@_>
1951 in the current subroutine are propagated to the other subroutine.)
1952 After the C<goto>, not even C<caller> will be able to tell that this
1953 routine was called first.
1954
1955 NAME needn't be the name of a subroutine; it can be a scalar variable
1956 containing a code reference, or a block which evaluates to a code
1957 reference.
1958
1959 =item grep BLOCK LIST
1960
1961 =item grep EXPR,LIST
1962
1963 This is similar in spirit to, but not the same as, grep(1) and its
1964 relatives.  In particular, it is not limited to using regular expressions.
1965
1966 Evaluates the BLOCK or EXPR for each element of LIST (locally setting
1967 C<$_> to each element) and returns the list value consisting of those
1968 elements for which the expression evaluated to true.  In scalar
1969 context, returns the number of times the expression was true.
1970
1971     @foo = grep(!/^#/, @bar);    # weed out comments
1972
1973 or equivalently,
1974
1975     @foo = grep {!/^#/} @bar;    # weed out comments
1976
1977 Note that, because C<$_> is a reference into the list value, it can
1978 be used to modify the elements of the array.  While this is useful and
1979 supported, it can cause bizarre results if the LIST is not a named array.
1980 Similarly, grep returns aliases into the original list, much as a for
1981 loop's index variable aliases the list elements.  That is, modifying an
1982 element of a list returned by grep (for example, in a C<foreach>, C<map>
1983 or another C<grep>) actually modifies the element in the original list.
1984 This is usually something to be avoided when writing clear code.
1985
1986 See also L</map> for a list composed of the results of the BLOCK or EXPR.
1987
1988 =item hex EXPR
1989
1990 =item hex
1991
1992 Interprets EXPR as a hex string and returns the corresponding value.
1993 (To convert strings that might start with either 0, 0x, or 0b, see
1994 L</oct>.)  If EXPR is omitted, uses C<$_>.
1995
1996     print hex '0xAf'; # prints '175'
1997     print hex 'aF';   # same
1998
1999 Hex strings may only represent integers.  Strings that would cause
2000 integer overflow trigger a warning.
2001
2002 =item import
2003
2004 There is no builtin C<import> function.  It is just an ordinary
2005 method (subroutine) defined (or inherited) by modules that wish to export
2006 names to another module.  The C<use> function calls the C<import> method
2007 for the package used.  See also L</use()>, L<perlmod>, and L<Exporter>.
2008
2009 =item index STR,SUBSTR,POSITION
2010
2011 =item index STR,SUBSTR
2012
2013 The index function searches for one string within another, but without
2014 the wildcard-like behavior of a full regular-expression pattern match.
2015 It returns the position of the first occurrence of SUBSTR in STR at
2016 or after POSITION.  If POSITION is omitted, starts searching from the
2017 beginning of the string.  The return value is based at C<0> (or whatever
2018 you've set the C<$[> variable to--but don't do that).  If the substring
2019 is not found, returns one less than the base, ordinarily C<-1>.
2020
2021 =item int EXPR
2022
2023 =item int
2024
2025 Returns the integer portion of EXPR.  If EXPR is omitted, uses C<$_>.
2026 You should not use this function for rounding: one because it truncates
2027 towards C<0>, and two because machine representations of floating point
2028 numbers can sometimes produce counterintuitive results.  For example,
2029 C<int(-6.725/0.025)> produces -268 rather than the correct -269; that's
2030 because it's really more like -268.99999999999994315658 instead.  Usually,
2031 the C<sprintf>, C<printf>, or the C<POSIX::floor> and C<POSIX::ceil>
2032 functions will serve you better than will int().
2033
2034 =item ioctl FILEHANDLE,FUNCTION,SCALAR
2035
2036 Implements the ioctl(2) function.  You'll probably first have to say
2037
2038     require "ioctl.ph"; # probably in /usr/local/lib/perl/ioctl.ph
2039
2040 to get the correct function definitions.  If F<ioctl.ph> doesn't
2041 exist or doesn't have the correct definitions you'll have to roll your
2042 own, based on your C header files such as F<E<lt>sys/ioctl.hE<gt>>.
2043 (There is a Perl script called B<h2ph> that comes with the Perl kit that
2044 may help you in this, but it's nontrivial.)  SCALAR will be read and/or
2045 written depending on the FUNCTION--a pointer to the string value of SCALAR
2046 will be passed as the third argument of the actual C<ioctl> call.  (If SCALAR
2047 has no string value but does have a numeric value, that value will be
2048 passed rather than a pointer to the string value.  To guarantee this to be
2049 true, add a C<0> to the scalar before using it.)  The C<pack> and C<unpack>
2050 functions may be needed to manipulate the values of structures used by
2051 C<ioctl>.  
2052
2053 The return value of C<ioctl> (and C<fcntl>) is as follows:
2054
2055         if OS returns:          then Perl returns:
2056             -1                    undefined value
2057              0                  string "0 but true"
2058         anything else               that number
2059
2060 Thus Perl returns true on success and false on failure, yet you can
2061 still easily determine the actual value returned by the operating
2062 system:
2063
2064     $retval = ioctl(...) || -1;
2065     printf "System returned %d\n", $retval;
2066
2067 The special string "C<0> but true" is exempt from B<-w> complaints
2068 about improper numeric conversions.
2069
2070 Here's an example of setting a filehandle named C<REMOTE> to be
2071 non-blocking at the system level.  You'll have to negotiate C<$|>
2072 on your own, though.
2073
2074     use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
2075
2076     $flags = fcntl(REMOTE, F_GETFL, 0)
2077                 or die "Can't get flags for the socket: $!\n";
2078
2079     $flags = fcntl(REMOTE, F_SETFL, $flags | O_NONBLOCK)
2080                 or die "Can't set flags for the socket: $!\n";
2081
2082 =item join EXPR,LIST
2083
2084 Joins the separate strings of LIST into a single string with fields
2085 separated by the value of EXPR, and returns that new string.  Example:
2086
2087     $rec = join(':', $login,$passwd,$uid,$gid,$gcos,$home,$shell);
2088
2089 Beware that unlike C<split>, C<join> doesn't take a pattern as its
2090 first argument.  Compare L</split>.
2091
2092 =item keys HASH
2093
2094 Returns a list consisting of all the keys of the named hash.  (In
2095 scalar context, returns the number of keys.)  The keys are returned in
2096 an apparently random order.  The actual random order is subject to
2097 change in future versions of perl, but it is guaranteed to be the same
2098 order as either the C<values> or C<each> function produces (given
2099 that the hash has not been modified).  As a side effect, it resets
2100 HASH's iterator.
2101
2102 Here is yet another way to print your environment:
2103
2104     @keys = keys %ENV;
2105     @values = values %ENV;
2106     while (@keys) { 
2107         print pop(@keys), '=', pop(@values), "\n";
2108     }
2109
2110 or how about sorted by key:
2111
2112     foreach $key (sort(keys %ENV)) {
2113         print $key, '=', $ENV{$key}, "\n";
2114     }
2115
2116 To sort a hash by value, you'll need to use a C<sort> function.
2117 Here's a descending numeric sort of a hash by its values:
2118
2119     foreach $key (sort { $hash{$b} <=> $hash{$a} } keys %hash) {
2120         printf "%4d %s\n", $hash{$key}, $key;
2121     }
2122
2123 As an lvalue C<keys> allows you to increase the number of hash buckets
2124 allocated for the given hash.  This can gain you a measure of efficiency if
2125 you know the hash is going to get big.  (This is similar to pre-extending
2126 an array by assigning a larger number to $#array.)  If you say
2127
2128     keys %hash = 200;
2129
2130 then C<%hash> will have at least 200 buckets allocated for it--256 of them,
2131 in fact, since it rounds up to the next power of two.  These
2132 buckets will be retained even if you do C<%hash = ()>, use C<undef
2133 %hash> if you want to free the storage while C<%hash> is still in scope.
2134 You can't shrink the number of buckets allocated for the hash using
2135 C<keys> in this way (but you needn't worry about doing this by accident,
2136 as trying has no effect).
2137
2138 See also C<each>, C<values> and C<sort>.
2139
2140 =item kill SIGNAL, LIST
2141
2142 Sends a signal to a list of processes.  Returns the number of
2143 processes successfully signaled (which is not necessarily the
2144 same as the number actually killed).
2145
2146     $cnt = kill 1, $child1, $child2;
2147     kill 9, @goners;
2148
2149 If SIGNAL is zero, no signal is sent to the process.  This is a
2150 useful way to check that the process is alive and hasn't changed
2151 its UID.  See L<perlport> for notes on the portability of this
2152 construct.
2153
2154 Unlike in the shell, if SIGNAL is negative, it kills
2155 process groups instead of processes.  (On System V, a negative I<PROCESS>
2156 number will also kill process groups, but that's not portable.)  That
2157 means you usually want to use positive not negative signals.  You may also
2158 use a signal name in quotes.  See L<perlipc/"Signals"> for details.
2159
2160 =item last LABEL
2161
2162 =item last
2163
2164 The C<last> command is like the C<break> statement in C (as used in
2165 loops); it immediately exits the loop in question.  If the LABEL is
2166 omitted, the command refers to the innermost enclosing loop.  The
2167 C<continue> block, if any, is not executed:
2168
2169     LINE: while (<STDIN>) {
2170         last LINE if /^$/;      # exit when done with header
2171         #...
2172     }
2173
2174 C<last> cannot be used to exit a block which returns a value such as
2175 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
2176 a grep() or map() operation.
2177
2178 Note that a block by itself is semantically identical to a loop
2179 that executes once.  Thus C<last> can be used to effect an early
2180 exit out of such a block.
2181
2182 See also L</continue> for an illustration of how C<last>, C<next>, and
2183 C<redo> work.
2184
2185 =item lc EXPR
2186
2187 =item lc
2188
2189 Returns an lowercased version of EXPR.  This is the internal function
2190 implementing the C<\L> escape in double-quoted strings.
2191 Respects current LC_CTYPE locale if C<use locale> in force.  See L<perllocale>
2192 and L<utf8>.
2193
2194 If EXPR is omitted, uses C<$_>.
2195
2196 =item lcfirst EXPR
2197
2198 =item lcfirst
2199
2200 Returns the value of EXPR with the first character lowercased.  This is
2201 the internal function implementing the C<\l> escape in double-quoted strings.
2202 Respects current LC_CTYPE locale if C<use locale> in force.  See L<perllocale>.
2203
2204 If EXPR is omitted, uses C<$_>.
2205
2206 =item length EXPR
2207
2208 =item length
2209
2210 Returns the length in characters of the value of EXPR.  If EXPR is
2211 omitted, returns length of C<$_>.  Note that this cannot be used on 
2212 an entire array or hash to find out how many elements these have.
2213 For that, use C<scalar @array> and C<scalar keys %hash> respectively.
2214
2215 =item link OLDFILE,NEWFILE
2216
2217 Creates a new filename linked to the old filename.  Returns true for
2218 success, false otherwise. 
2219
2220 =item listen SOCKET,QUEUESIZE
2221
2222 Does the same thing that the listen system call does.  Returns true if
2223 it succeeded, false otherwise.  See the example in L<perlipc/"Sockets: Client/Server Communication">.
2224
2225 =item local EXPR
2226
2227 You really probably want to be using C<my> instead, because C<local> isn't
2228 what most people think of as "local".  See L<perlsub/"Private Variables
2229 via my()"> for details.
2230
2231 A local modifies the listed variables to be local to the enclosing
2232 block, file, or eval.  If more than one value is listed, the list must
2233 be placed in parentheses.  See L<perlsub/"Temporary Values via local()">
2234 for details, including issues with tied arrays and hashes.
2235
2236 =item localtime EXPR
2237
2238 Converts a time as returned by the time function to a 9-element list
2239 with the time analyzed for the local time zone.  Typically used as
2240 follows:
2241
2242     #  0    1    2     3     4    5     6     7     8
2243     ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
2244                                                 localtime(time);
2245
2246 All list elements are numeric, and come straight out of a struct tm.
2247 In particular this means that $mon has the range C<0..11> and $wday
2248 has the range C<0..6> with sunday as day C<0>.  Also, $year is the
2249 number of years since 1900, that is, $year is C<123> in year 2023,
2250 and I<not> simply the last two digits of the year.  If you assume it is,
2251 then you create non-Y2K-compliant programs--and you wouldn't want to do
2252 that, would you?
2253
2254 The proper way to get a complete 4-digit year is simply:
2255
2256         $year += 1900;
2257
2258 And to get the last two digits of the year (e.g., '01' in 2001) do:
2259
2260         $year = sprintf("%02d", $year % 100);
2261
2262 If EXPR is omitted, uses the current time (C<localtime(time)>).
2263
2264 In scalar context, returns the ctime(3) value:
2265
2266     $now_string = localtime;  # e.g., "Thu Oct 13 04:54:34 1994"
2267
2268 This scalar value is B<not> locale dependent, see L<perllocale>, but
2269 instead a Perl builtin.  Also see the C<Time::Local> module
2270 (to convert the second, minutes, hours, ... back to seconds since the
2271 stroke of midnight the 1st of January 1970, the value returned by
2272 time()), and the strftime(3) and mktime(3) function available via the
2273 POSIX module.  To get somewhat similar but locale dependent date
2274 strings, set up your locale environment variables appropriately
2275 (please see L<perllocale>) and try for example:
2276
2277     use POSIX qw(strftime);
2278     $now_string = strftime "%a %b %e %H:%M:%S %Y", localtime;
2279
2280 Note that the C<%a> and C<%b>, the short forms of the day of the week
2281 and the month of the year, may not necessarily be three characters wide.
2282
2283 =item lock
2284
2285     lock I<THING>
2286
2287 This function places an advisory lock on a variable, subroutine,
2288 or referenced object contained in I<THING> until the lock goes out
2289 of scope.  This is a built-in function only if your version of Perl
2290 was built with threading enabled, and if you've said C<use Threads>.
2291 Otherwise a user-defined function by this name will be called.  See
2292 L<Thread>.
2293
2294 =item log EXPR
2295
2296 =item log
2297
2298 Returns the natural logarithm (base I<e>) of EXPR.  If EXPR is omitted,
2299 returns log of C<$_>.  To get the log of another base, use basic algebra:
2300 The base-N log of a number is equal to the natural log of that number
2301 divided by the natural log of N.  For example:
2302
2303     sub log10 {
2304         my $n = shift;
2305         return log($n)/log(10);
2306     } 
2307
2308 See also L</exp> for the inverse operation.
2309
2310 =item lstat FILEHANDLE
2311
2312 =item lstat EXPR
2313
2314 =item lstat
2315
2316 Does the same thing as the C<stat> function (including setting the
2317 special C<_> filehandle) but stats a symbolic link instead of the file
2318 the symbolic link points to.  If symbolic links are unimplemented on
2319 your system, a normal C<stat> is done.
2320
2321 If EXPR is omitted, stats C<$_>.
2322
2323 =item m//
2324
2325 The match operator.  See L<perlop>.
2326
2327 =item map BLOCK LIST
2328
2329 =item map EXPR,LIST
2330
2331 Evaluates the BLOCK or EXPR for each element of LIST (locally setting
2332 C<$_> to each element) and returns the list value composed of the
2333 results of each such evaluation.  In scalar context, returns the
2334 total number of elements so generated.  Evaluates BLOCK or EXPR in
2335 list context, so each element of LIST may produce zero, one, or
2336 more elements in the returned value.
2337
2338     @chars = map(chr, @nums);
2339
2340 translates a list of numbers to the corresponding characters.  And
2341
2342     %hash = map { getkey($_) => $_ } @array;
2343
2344 is just a funny way to write
2345
2346     %hash = ();
2347     foreach $_ (@array) {
2348         $hash{getkey($_)} = $_;
2349     }
2350
2351 Note that, because C<$_> is a reference into the list value, it can
2352 be used to modify the elements of the array.  While this is useful and
2353 supported, it can cause bizarre results if the LIST is not a named array.
2354 Using a regular C<foreach> loop for this purpose would be clearer in
2355 most cases.  See also L</grep> for an array composed of those items of
2356 the original list for which the BLOCK or EXPR evaluates to true.
2357
2358 =item mkdir FILENAME,MASK
2359
2360 Creates the directory specified by FILENAME, with permissions
2361 specified by MASK (as modified by C<umask>).  If it succeeds it
2362 returns true, otherwise it returns false and sets C<$!> (errno).
2363
2364 In general, it is better to create directories with permissive MASK,
2365 and let the user modify that with their C<umask>, than it is to supply
2366 a restrictive MASK and give the user no way to be more permissive.
2367 The exceptions to this rule are when the file or directory should be
2368 kept private (mail files, for instance).  The perlfunc(1) entry on
2369 C<umask> discusses the choice of MASK in more detail.
2370
2371 =item msgctl ID,CMD,ARG
2372
2373 Calls the System V IPC function msgctl(2).  You'll probably have to say
2374
2375     use IPC::SysV;
2376
2377 first to get the correct constant definitions.  If CMD is C<IPC_STAT>,
2378 then ARG must be a variable which will hold the returned C<msqid_ds>
2379 structure.  Returns like C<ioctl>: the undefined value for error,
2380 C<"0 but true"> for zero, or the actual return value otherwise.  See also
2381 C<IPC::SysV> and C<IPC::Semaphore> documentation.
2382
2383 =item msgget KEY,FLAGS
2384
2385 Calls the System V IPC function msgget(2).  Returns the message queue
2386 id, or the undefined value if there is an error.  See also C<IPC::SysV>
2387 and C<IPC::Msg> documentation.
2388
2389 =item msgsnd ID,MSG,FLAGS
2390
2391 Calls the System V IPC function msgsnd to send the message MSG to the
2392 message queue ID.  MSG must begin with the long integer message type,
2393 which may be created with C<pack("l", $type)>.  Returns true if
2394 successful, or false if there is an error.  See also C<IPC::SysV>
2395 and C<IPC::SysV::Msg> documentation.
2396
2397 =item msgrcv ID,VAR,SIZE,TYPE,FLAGS
2398
2399 Calls the System V IPC function msgrcv to receive a message from
2400 message queue ID into variable VAR with a maximum message size of
2401 SIZE.  Note that if a message is received, the message type will be
2402 the first thing in VAR, and the maximum length of VAR is SIZE plus the
2403 size of the message type.  Returns true if successful, or false if
2404 there is an error.  See also C<IPC::SysV> and C<IPC::SysV::Msg> documentation.
2405
2406 =item my EXPR
2407
2408 =item my EXPR : ATTRIBUTES
2409
2410 A C<my> declares the listed variables to be local (lexically) to the
2411 enclosing block, file, or C<eval>.  If
2412 more than one value is listed, the list must be placed in parentheses.  See
2413 L<perlsub/"Private Variables via my()"> for details.
2414
2415 =item next LABEL
2416
2417 =item next
2418
2419 The C<next> command is like the C<continue> statement in C; it starts
2420 the next iteration of the loop:
2421
2422     LINE: while (<STDIN>) {
2423         next LINE if /^#/;      # discard comments
2424         #...
2425     }
2426
2427 Note that if there were a C<continue> block on the above, it would get
2428 executed even on discarded lines.  If the LABEL is omitted, the command
2429 refers to the innermost enclosing loop.
2430
2431 C<next> cannot be used to exit a block which returns a value such as
2432 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
2433 a grep() or map() operation.
2434
2435 Note that a block by itself is semantically identical to a loop
2436 that executes once.  Thus C<next> will exit such a block early.
2437
2438 See also L</continue> for an illustration of how C<last>, C<next>, and
2439 C<redo> work.
2440
2441 =item no Module LIST
2442
2443 See the L</use> function, which C<no> is the opposite of.
2444
2445 =item oct EXPR
2446
2447 =item oct
2448
2449 Interprets EXPR as an octal string and returns the corresponding
2450 value.  (If EXPR happens to start off with C<0x>, interprets it as a
2451 hex string.  If EXPR starts off with C<0b>, it is interpreted as a
2452 binary string.)  The following will handle decimal, binary, octal, and
2453 hex in the standard Perl or C notation:
2454
2455     $val = oct($val) if $val =~ /^0/;
2456
2457 If EXPR is omitted, uses C<$_>.   To go the other way (produce a number
2458 in octal), use sprintf() or printf():
2459
2460     $perms = (stat("filename"))[2] & 07777;
2461     $oct_perms = sprintf "%lo", $perms;
2462
2463 The oct() function is commonly used when a string such as C<644> needs
2464 to be converted into a file mode, for example. (Although perl will
2465 automatically convert strings into numbers as needed, this automatic
2466 conversion assumes base 10.)
2467
2468 =item open FILEHANDLE,MODE,EXPR
2469
2470 =item open FILEHANDLE,EXPR
2471
2472 =item open FILEHANDLE
2473
2474 Opens the file whose filename is given by EXPR, and associates it with
2475 FILEHANDLE.  If FILEHANDLE is an expression, its value is used as the
2476 name of the real filehandle wanted.  If EXPR is omitted, the scalar
2477 variable of the same name as the FILEHANDLE contains the filename.
2478 (Note that lexical variables--those declared with C<my>--will not work
2479 for this purpose; so if you're using C<my>, specify EXPR in your call
2480 to open.)  See L<perlopentut> for a kinder, gentler explanation of opening
2481 files.
2482
2483 If MODE is C<'E<lt>'> or nothing, the file is opened for input.
2484 If MODE is C<'E<gt>'>, the file is truncated and opened for
2485 output, being created if necessary.  If MODE is C<'E<gt>E<gt>'>,
2486 the file is opened for appending, again being created if necessary. 
2487 You can put a C<'+'> in front of the C<'E<gt>'> or C<'E<lt>'> to indicate that
2488 you want both read and write access to the file; thus C<'+E<lt>'> is almost
2489 always preferred for read/write updates--the C<'+E<gt>'> mode would clobber the
2490 file first.  You can't usually use either read-write mode for updating
2491 textfiles, since they have variable length records.  See the B<-i>
2492 switch in L<perlrun> for a better approach.  The file is created with
2493 permissions of C<0666> modified by the process' C<umask> value.
2494
2495 These various prefixes correspond to the fopen(3) modes of C<'r'>, C<'r+'>, C<'w'>,
2496 C<'w+'>, C<'a'>, and C<'a+'>.
2497
2498 In the 2-arguments (and 1-argument) form of the call the mode and
2499 filename should be concatenated (in this order), possibly separated by
2500 spaces.  It is possible to omit the mode if the mode is C<'E<lt>'>.
2501
2502 If the filename begins with C<'|'>, the filename is interpreted as a
2503 command to which output is to be piped, and if the filename ends with a
2504 C<'|'>, the filename is interpreted as a command which pipes output to
2505 us.  See L<perlipc/"Using open() for IPC">
2506 for more examples of this.  (You are not allowed to C<open> to a command
2507 that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>,
2508 and L<perlipc/"Bidirectional Communication"> for alternatives.)
2509
2510 If MODE is C<'|-'>, the filename is interpreted as a
2511 command to which output is to be piped, and if MODE is
2512 C<'-|'>, the filename is interpreted as a command which pipes output to
2513 us.  In the 2-arguments (and 1-argument) form one should replace dash
2514 (C<'-'>) with the command.  See L<perlipc/"Using open() for IPC">
2515 for more examples of this.  (You are not allowed to C<open> to a command
2516 that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>,
2517 and L<perlipc/"Bidirectional Communication"> for alternatives.)
2518
2519 In the 2-arguments (and 1-argument) form opening C<'-'> opens STDIN
2520 and opening C<'E<gt>-'> opens STDOUT.  
2521
2522 Open returns
2523 nonzero upon success, the undefined value otherwise.  If the C<open>
2524 involved a pipe, the return value happens to be the pid of the
2525 subprocess.
2526
2527 If you're unfortunate enough to be running Perl on a system that
2528 distinguishes between text files and binary files (modern operating
2529 systems don't care), then you should check out L</binmode> for tips for
2530 dealing with this.  The key distinction between systems that need C<binmode>
2531 and those that don't is their text file formats.  Systems like Unix, MacOS, and
2532 Plan9, which delimit lines with a single character, and which encode that
2533 character in C as C<"\n">, do not need C<binmode>.  The rest need it.
2534
2535 When opening a file, it's usually a bad idea to continue normal execution
2536 if the request failed, so C<open> is frequently used in connection with
2537 C<die>.  Even if C<die> won't do what you want (say, in a CGI script,
2538 where you want to make a nicely formatted error message (but there are
2539 modules that can help with that problem)) you should always check
2540 the return value from opening a file.  The infrequent exception is when
2541 working with an unopened filehandle is actually what you want to do.
2542
2543 Examples:
2544
2545     $ARTICLE = 100;
2546     open ARTICLE or die "Can't find article $ARTICLE: $!\n";
2547     while (<ARTICLE>) {...
2548
2549     open(LOG, '>>/usr/spool/news/twitlog');     # (log is reserved)
2550     # if the open fails, output is discarded
2551
2552     open(DBASE, '+<', 'dbase.mine')             # open for update
2553         or die "Can't open 'dbase.mine' for update: $!";
2554
2555     open(DBASE, '+<dbase.mine')                 # ditto
2556         or die "Can't open 'dbase.mine' for update: $!";
2557
2558     open(ARTICLE, '-|', "caesar <$article")     # decrypt article
2559         or die "Can't start caesar: $!";
2560
2561     open(ARTICLE, "caesar <$article |")         # ditto
2562         or die "Can't start caesar: $!";
2563
2564     open(EXTRACT, "|sort >/tmp/Tmp$$")          # $$ is our process id
2565         or die "Can't start sort: $!";
2566
2567     # process argument list of files along with any includes
2568
2569     foreach $file (@ARGV) {
2570         process($file, 'fh00');
2571     }
2572
2573     sub process {
2574         my($filename, $input) = @_;
2575         $input++;               # this is a string increment
2576         unless (open($input, $filename)) {
2577             print STDERR "Can't open $filename: $!\n";
2578             return;
2579         }
2580
2581         local $_;
2582         while (<$input>) {              # note use of indirection
2583             if (/^#include "(.*)"/) {
2584                 process($1, $input);
2585                 next;
2586             }
2587             #...                # whatever
2588         }
2589     }
2590
2591 You may also, in the Bourne shell tradition, specify an EXPR beginning
2592 with C<'E<gt>&'>, in which case the rest of the string is interpreted as the
2593 name of a filehandle (or file descriptor, if numeric) to be
2594 duped and opened.  You may use C<&> after C<E<gt>>, C<E<gt>E<gt>>,
2595 C<E<lt>>, C<+E<gt>>, C<+E<gt>E<gt>>, and C<+E<lt>>.  The
2596 mode you specify should match the mode of the original filehandle.
2597 (Duping a filehandle does not take into account any existing contents of
2598 stdio buffers.)  Duping file handles is not yet supported for 3-argument
2599 open().
2600
2601 Here is a script that saves, redirects, and restores STDOUT and
2602 STDERR:
2603
2604     #!/usr/bin/perl
2605     open(OLDOUT, ">&STDOUT");
2606     open(OLDERR, ">&STDERR");
2607
2608     open(STDOUT, '>', "foo.out") || die "Can't redirect stdout";
2609     open(STDERR, ">&STDOUT")     || die "Can't dup stdout";
2610
2611     select(STDERR); $| = 1;     # make unbuffered
2612     select(STDOUT); $| = 1;     # make unbuffered
2613
2614     print STDOUT "stdout 1\n";  # this works for
2615     print STDERR "stderr 1\n";  # subprocesses too
2616
2617     close(STDOUT);
2618     close(STDERR);
2619
2620     open(STDOUT, ">&OLDOUT");
2621     open(STDERR, ">&OLDERR");
2622
2623     print STDOUT "stdout 2\n";
2624     print STDERR "stderr 2\n";
2625
2626 If you specify C<'E<lt>&=N'>, where C<N> is a number, then Perl will do an
2627 equivalent of C's C<fdopen> of that file descriptor; this is more
2628 parsimonious of file descriptors.  For example:
2629
2630     open(FILEHANDLE, "<&=$fd")
2631
2632 Note that this feature depends on the fdopen() C library function.
2633 On many UNIX systems, fdopen() is known to fail when file descriptors
2634 exceed a certain value, typically 255. If you need more file
2635 descriptors than that, consider rebuilding Perl to use the C<sfio>
2636 library.
2637
2638 If you open a pipe on the command C<'-'>, i.e., either C<'|-'> or C<'-|'>
2639 with 2-arguments (or 1-argument) form of open(), then
2640 there is an implicit fork done, and the return value of open is the pid
2641 of the child within the parent process, and C<0> within the child
2642 process.  (Use C<defined($pid)> to determine whether the open was successful.)
2643 The filehandle behaves normally for the parent, but i/o to that
2644 filehandle is piped from/to the STDOUT/STDIN of the child process.
2645 In the child process the filehandle isn't opened--i/o happens from/to
2646 the new STDOUT or STDIN.  Typically this is used like the normal
2647 piped open when you want to exercise more control over just how the
2648 pipe command gets executed, such as when you are running setuid, and
2649 don't want to have to scan shell commands for metacharacters.
2650 The following triples are more or less equivalent:
2651
2652     open(FOO, "|tr '[a-z]' '[A-Z]'");
2653     open(FOO, '|-', "tr '[a-z]' '[A-Z]'");
2654     open(FOO, '|-') || exec 'tr', '[a-z]', '[A-Z]';
2655
2656     open(FOO, "cat -n '$file'|");
2657     open(FOO, '-|', "cat -n '$file'");
2658     open(FOO, '-|') || exec 'cat', '-n', $file;
2659
2660 See L<perlipc/"Safe Pipe Opens"> for more examples of this.
2661
2662 NOTE: On any operation that may do a fork, all files opened for output
2663 are flushed before the fork is attempted.  On systems that support a
2664 close-on-exec flag on files, the flag will be set for the newly opened
2665 file descriptor as determined by the value of $^F.  See L<perlvar/$^F>.
2666
2667 Closing any piped filehandle causes the parent process to wait for the
2668 child to finish, and returns the status value in C<$?>.
2669
2670 The filename passed to 2-argument (or 1-argument) form of open()
2671 will have leading and trailing
2672 whitespace deleted, and the normal redirection characters
2673 honored.  This property, known as "magic open", 
2674 can often be used to good effect.  A user could specify a filename of
2675 F<"rsh cat file |">, or you could change certain filenames as needed:
2676
2677     $filename =~ s/(.*\.gz)\s*$/gzip -dc < $1|/;
2678     open(FH, $filename) or die "Can't open $filename: $!";
2679
2680 Use 3-argument form to open a file with arbitrary weird characters in it,
2681
2682     open(FOO, '<', $file);
2683
2684 otherwise it's necessary to protect any leading and trailing whitespace:
2685
2686     $file =~ s#^(\s)#./$1#;
2687     open(FOO, "< $file\0");
2688
2689 (this may not work on some bizzare filesystems).  One should
2690 conscientiously choose between the the I<magic> and 3-arguments form
2691 of open():
2692
2693     open IN, $ARGV[0];
2694
2695 will allow the user to specify an argument of the form C<"rsh cat file |">,
2696 but will not work on a filename which happens to have a trailing space, while
2697
2698     open IN, '<', $ARGV[0];
2699
2700 will have exactly the opposite restrictions.
2701
2702 If you want a "real" C C<open> (see L<open(2)> on your system), then you
2703 should use the C<sysopen> function, which involves no such magic (but
2704 may use subtly different filemodes than Perl open(), which is mapped
2705 to C fopen()).  This is
2706 another way to protect your filenames from interpretation.  For example:
2707
2708     use IO::Handle;
2709     sysopen(HANDLE, $path, O_RDWR|O_CREAT|O_EXCL)
2710         or die "sysopen $path: $!";
2711     $oldfh = select(HANDLE); $| = 1; select($oldfh);
2712     print HANDLE "stuff $$\n");
2713     seek(HANDLE, 0, 0);
2714     print "File contains: ", <HANDLE>;
2715
2716 Using the constructor from the C<IO::Handle> package (or one of its
2717 subclasses, such as C<IO::File> or C<IO::Socket>), you can generate anonymous
2718 filehandles that have the scope of whatever variables hold references to
2719 them, and automatically close whenever and however you leave that scope:
2720
2721     use IO::File;
2722     #...
2723     sub read_myfile_munged {
2724         my $ALL = shift;
2725         my $handle = new IO::File;
2726         open($handle, "myfile") or die "myfile: $!";
2727         $first = <$handle>
2728             or return ();     # Automatically closed here.
2729         mung $first or die "mung failed";       # Or here.
2730         return $first, <$handle> if $ALL;       # Or here.
2731         $first;                                 # Or here.
2732     }
2733
2734 See L</seek> for some details about mixing reading and writing.
2735
2736 =item opendir DIRHANDLE,EXPR
2737
2738 Opens a directory named EXPR for processing by C<readdir>, C<telldir>,
2739 C<seekdir>, C<rewinddir>, and C<closedir>.  Returns true if successful.
2740 DIRHANDLEs have their own namespace separate from FILEHANDLEs.
2741
2742 =item ord EXPR
2743
2744 =item ord
2745
2746 Returns the numeric (ASCII or Unicode) value of the first character of EXPR.  If
2747 EXPR is omitted, uses C<$_>.  For the reverse, see L</chr>.
2748 See L<utf8> for more about Unicode.
2749
2750 =item our EXPR
2751
2752 An C<our> declares the listed variables to be valid globals within
2753 the enclosing block, file, or C<eval>.  That is, it has the same
2754 scoping rules as a "my" declaration, but does not create a local
2755 variable.  If more than one value is listed, the list must be placed
2756 in parentheses.  The C<our> declaration has no semantic effect unless
2757 "use strict vars" is in effect, in which case it lets you use the
2758 declared global variable without qualifying it with a package name.
2759 (But only within the lexical scope of the C<our> declaration.  In this
2760 it differs from "use vars", which is package scoped.)
2761
2762 =item pack TEMPLATE,LIST
2763
2764 Takes a LIST of values and converts it into a string using the rules
2765 given by the TEMPLATE.  The resulting string is the concatenation of
2766 the converted values.  Typically, each converted value looks
2767 like its machine-level representation.  For example, on 32-bit machines
2768 a converted integer may be represented by a sequence of 4 bytes.
2769
2770 The TEMPLATE is a
2771 sequence of characters that give the order and type of values, as
2772 follows:
2773
2774     a   A string with arbitrary binary data, will be null padded.
2775     A   An ascii string, will be space padded.
2776     Z   A null terminated (asciz) string, will be null padded.
2777
2778     b   A bit string (ascending bit order inside each byte, like vec()).
2779     B   A bit string (descending bit order inside each byte).
2780     h   A hex string (low nybble first).
2781     H   A hex string (high nybble first).
2782
2783     c   A signed char value.
2784     C   An unsigned char value.  Only does bytes.  See U for Unicode.
2785
2786     s   A signed short value.
2787     S   An unsigned short value.
2788           (This 'short' is _exactly_ 16 bits, which may differ from
2789            what a local C compiler calls 'short'.  If you want
2790            native-length shorts, use the '!' suffix.)
2791
2792     i   A signed integer value.
2793     I   An unsigned integer value.
2794           (This 'integer' is _at_least_ 32 bits wide.  Its exact
2795            size depends on what a local C compiler calls 'int',
2796            and may even be larger than the 'long' described in
2797            the next item.)
2798
2799     l   A signed long value.
2800     L   An unsigned long value.
2801           (This 'long' is _exactly_ 32 bits, which may differ from
2802            what a local C compiler calls 'long'.  If you want
2803            native-length longs, use the '!' suffix.)
2804
2805     n   An unsigned short in "network" (big-endian) order.
2806     N   An unsigned long in "network" (big-endian) order.
2807     v   An unsigned short in "VAX" (little-endian) order.
2808     V   An unsigned long in "VAX" (little-endian) order.
2809           (These 'shorts' and 'longs' are _exactly_ 16 bits and
2810            _exactly_ 32 bits, respectively.)
2811
2812     q   A signed quad (64-bit) value.
2813     Q   An unsigned quad value.
2814           (Quads are available only if your system supports 64-bit
2815            integer values _and_ if Perl has been compiled to support those.
2816            Causes a fatal error otherwise.)
2817
2818     f   A single-precision float in the native format.
2819     d   A double-precision float in the native format.
2820
2821     p   A pointer to a null-terminated string.
2822     P   A pointer to a structure (fixed-length string).
2823
2824     u   A uuencoded string.
2825     U   A Unicode character number.  Encodes to UTF-8 internally.
2826         Works even if C<use utf8> is not in effect.
2827
2828     w   A BER compressed integer.  Its bytes represent an unsigned
2829         integer in base 128, most significant digit first, with as
2830         few digits as possible.  Bit eight (the high bit) is set
2831         on each byte except the last.
2832
2833     x   A null byte.
2834     X   Back up a byte.
2835     @   Null fill to absolute position.
2836
2837 The following rules apply:
2838
2839 =over 8
2840
2841 =item *
2842
2843 Each letter may optionally be followed by a number giving a repeat
2844 count.  With all types except C<a>, C<A>, C<Z>, C<b>, C<B>, C<h>,
2845 C<H>, and C<P> the pack function will gobble up that many values from
2846 the LIST.  A C<*> for the repeat count means to use however many items are
2847 left, except for C<@>, C<x>, C<X>, where it is equivalent
2848 to C<0>, and C<u>, where it is equivalent to 1 (or 45, what is the
2849 same).
2850
2851 When used with C<Z>, C<*> results in the addition of a trailing null
2852 byte (so the packed result will be one longer than the byte C<length>
2853 of the item).
2854
2855 The repeat count for C<u> is interpreted as the maximal number of bytes
2856 to encode per line of output, with 0 and 1 replaced by 45.
2857
2858 =item *
2859
2860 The C<a>, C<A>, and C<Z> types gobble just one value, but pack it as a
2861 string of length count, padding with nulls or spaces as necessary.  When
2862 unpacking, C<A> strips trailing spaces and nulls, C<Z> strips everything
2863 after the first null, and C<a> returns data verbatim.  When packing,
2864 C<a>, and C<Z> are equivalent.
2865
2866 If the value-to-pack is too long, it is truncated.  If too long and an
2867 explicit count is provided, C<Z> packs only C<$count-1> bytes, followed
2868 by a null byte.  Thus C<Z> always packs a trailing null byte under
2869 all circumstances.
2870
2871 =item *
2872
2873 Likewise, the C<b> and C<B> fields pack a string that many bits long.
2874 Each byte of the input field of pack() generates 1 bit of the result.
2875 Each result bit is based on the least-significant bit of the corresponding
2876 input byte, i.e., on C<ord($byte)%2>.  In particular, bytes C<"0"> and
2877 C<"1"> generate bits 0 and 1, as do bytes C<"\0"> and C<"\1">.
2878
2879 Starting from the beginning of the input string of pack(), each 8-tuple
2880 of bytes is converted to 1 byte of output.  With format C<b>
2881 the first byte of the 8-tuple determines the least-significant bit of a
2882 byte, and with format C<B> it determines the most-significant bit of
2883 a byte.
2884
2885 If the length of the input string is not exactly divisible by 8, the
2886 remainder is packed as if the input string were padded by null bytes
2887 at the end.  Similarly, during unpack()ing the "extra" bits are ignored.
2888
2889 If the input string of pack() is longer than needed, extra bytes are ignored.
2890 A C<*> for the repeat count of pack() means to use all the bytes of
2891 the input field.  On unpack()ing the bits are converted to a string
2892 of C<"0">s and C<"1">s.
2893
2894 =item *
2895
2896 The C<h> and C<H> fields pack a string that many nybbles (4-bit groups,
2897 representable as hexadecimal digits, 0-9a-f) long.
2898
2899 Each byte of the input field of pack() generates 4 bits of the result.
2900 For non-alphabetical bytes the result is based on the 4 least-significant
2901 bits of the input byte, i.e., on C<ord($byte)%16>.  In particular,
2902 bytes C<"0"> and C<"1"> generate nybbles 0 and 1, as do bytes
2903 C<"\0"> and C<"\1">.  For bytes C<"a".."f"> and C<"A".."F"> the result
2904 is compatible with the usual hexadecimal digits, so that C<"a"> and
2905 C<"A"> both generate the nybble C<0xa==10>.  The result for bytes
2906 C<"g".."z"> and C<"G".."Z"> is not well-defined.
2907
2908 Starting from the beginning of the input string of pack(), each pair
2909 of bytes is converted to 1 byte of output.  With format C<h> the
2910 first byte of the pair determines the least-significant nybble of the
2911 output byte, and with format C<H> it determines the most-significant
2912 nybble.
2913
2914 If the length of the input string is not even, it behaves as if padded
2915 by a null byte at the end.  Similarly, during unpack()ing the "extra"
2916 nybbles are ignored.
2917
2918 If the input string of pack() is longer than needed, extra bytes are ignored.
2919 A C<*> for the repeat count of pack() means to use all the bytes of
2920 the input field.  On unpack()ing the bits are converted to a string
2921 of hexadecimal digits.
2922
2923 =item *
2924
2925 The C<p> type packs a pointer to a null-terminated string.  You are
2926 responsible for ensuring the string is not a temporary value (which can
2927 potentially get deallocated before you get around to using the packed result).
2928 The C<P> type packs a pointer to a structure of the size indicated by the
2929 length.  A NULL pointer is created if the corresponding value for C<p> or
2930 C<P> is C<undef>, similarly for unpack().
2931
2932 =item *
2933
2934 The C</> template character allows packing and unpacking of strings where
2935 the packed structure contains a byte count followed by the string itself.
2936 You write I<length-item>C</>I<string-item>.
2937
2938 The I<length-item> can be any C<pack> template letter,
2939 and describes how the length value is packed.
2940 The ones likely to be of most use are integer-packing ones like
2941 C<n> (for Java strings), C<w> (for ASN.1 or SNMP)
2942 and C<N> (for Sun XDR).
2943
2944 The I<string-item> must, at present, be C<"A*">, C<"a*"> or C<"Z*">.
2945 For C<unpack> the length of the string is obtained from the I<length-item>,
2946 but if you put in the '*' it will be ignored.
2947
2948     unpack 'C/a', "\04Gurusamy";        gives 'Guru'
2949     unpack 'a3/A* A*', '007 Bond  J ';  gives (' Bond','J')
2950     pack 'n/a* w/a*','hello,','world';  gives "\000\006hello,\005world"
2951
2952 The I<length-item> is not returned explicitly from C<unpack>.
2953
2954 Adding a count to the I<length-item> letter is unlikely to do anything
2955 useful, unless that letter is C<A>, C<a> or C<Z>.  Packing with a
2956 I<length-item> of C<a> or C<Z> may introduce C<"\000"> characters,
2957 which Perl does not regard as legal in numeric strings.
2958
2959 =item *
2960
2961 The integer types C<s>, C<S>, C<l>, and C<L> may be
2962 immediately followed by a C<!> suffix to signify native shorts or
2963 longs--as you can see from above for example a bare C<l> does mean
2964 exactly 32 bits, the native C<long> (as seen by the local C compiler)
2965 may be larger.  This is an issue mainly in 64-bit platforms.  You can
2966 see whether using C<!> makes any difference by
2967
2968         print length(pack("s")), " ", length(pack("s!")), "\n";
2969         print length(pack("l")), " ", length(pack("l!")), "\n";
2970
2971 C<i!> and C<I!> also work but only because of completeness;
2972 they are identical to C<i> and C<I>.
2973
2974 The actual sizes (in bytes) of native shorts, ints, longs, and long
2975 longs on the platform where Perl was built are also available via
2976 L<Config>:
2977
2978        use Config;
2979        print $Config{shortsize},    "\n";
2980        print $Config{intsize},      "\n";
2981        print $Config{longsize},     "\n";
2982        print $Config{longlongsize}, "\n";
2983
2984 (The C<$Config{longlongsize}> will be undefine if your system does
2985 not support long longs.) 
2986
2987 =item *
2988
2989 The integer formats C<s>, C<S>, C<i>, C<I>, C<l>, and C<L>
2990 are inherently non-portable between processors and operating systems
2991 because they obey the native byteorder and endianness.  For example a
2992 4-byte integer 0x12345678 (305419896 decimal) be ordered natively
2993 (arranged in and handled by the CPU registers) into bytes as
2994  
2995         0x12 0x34 0x56 0x78     # little-endian
2996         0x78 0x56 0x34 0x12     # big-endian
2997  
2998 Basically, the Intel, Alpha, and VAX CPUs are little-endian, while
2999 everybody else, for example Motorola m68k/88k, PPC, Sparc, HP PA,
3000 Power, and Cray are big-endian.  MIPS can be either: Digital used it
3001 in little-endian mode; SGI uses it in big-endian mode.
3002
3003 The names `big-endian' and `little-endian' are comic references to
3004 the classic "Gulliver's Travels" (via the paper "On Holy Wars and a
3005 Plea for Peace" by Danny Cohen, USC/ISI IEN 137, April 1, 1980) and
3006 the egg-eating habits of the Lilliputians.
3007  
3008 Some systems may have even weirder byte orders such as
3009  
3010         0x56 0x78 0x12 0x34
3011         0x34 0x12 0x78 0x56
3012  
3013 You can see your system's preference with
3014
3015         print join(" ", map { sprintf "%#02x", $_ }
3016                             unpack("C*",pack("L",0x12345678))), "\n";
3017
3018 The byteorder on the platform where Perl was built is also available
3019 via L<Config>:
3020
3021         use Config;
3022         print $Config{byteorder}, "\n";
3023
3024 Byteorders C<'1234'> and C<'12345678'> are little-endian, C<'4321'>
3025 and C<'87654321'> are big-endian.
3026
3027 If you want portable packed integers use the formats C<n>, C<N>,
3028 C<v>, and C<V>, their byte endianness and size is known.
3029 See also L<perlport>.
3030
3031 =item *
3032
3033 Real numbers (floats and doubles) are in the native machine format only;
3034 due to the multiplicity of floating formats around, and the lack of a
3035 standard "network" representation, no facility for interchange has been
3036 made.  This means that packed floating point data written on one machine
3037 may not be readable on another - even if both use IEEE floating point
3038 arithmetic (as the endian-ness of the memory representation is not part
3039 of the IEEE spec).  See also L<perlport>.
3040
3041 Note that Perl uses doubles internally for all numeric calculation, and
3042 converting from double into float and thence back to double again will
3043 lose precision (i.e., C<unpack("f", pack("f", $foo)>) will not in general
3044 equal $foo).
3045
3046 =item *
3047
3048 You must yourself do any alignment or padding by inserting for example
3049 enough C<'x'>es while packing.  There is no way to pack() and unpack()
3050 could know where the bytes are going to or coming from.  Therefore
3051 C<pack> (and C<unpack>) handle their output and input as flat
3052 sequences of bytes.
3053
3054 =item *
3055
3056 A comment in a TEMPLATE starts with C<#> and goes to the end of line.
3057
3058 =item *
3059
3060 If TEMPLATE requires more arguments to pack() than actually given, pack()
3061 assumes additional C<""> arguments.  If TEMPLATE requires less arguments
3062 to pack() than actually given, extra arguments are ignored.
3063
3064 =back
3065
3066 Examples:
3067
3068     $foo = pack("CCCC",65,66,67,68);
3069     # foo eq "ABCD"
3070     $foo = pack("C4",65,66,67,68);
3071     # same thing
3072     $foo = pack("U4",0x24b6,0x24b7,0x24b8,0x24b9);
3073     # same thing with Unicode circled letters
3074
3075     $foo = pack("ccxxcc",65,66,67,68);
3076     # foo eq "AB\0\0CD"
3077
3078     # note: the above examples featuring "C" and "c" are true
3079     # only on ASCII and ASCII-derived systems such as ISO Latin 1
3080     # and UTF-8.  In EBCDIC the first example would be
3081     # $foo = pack("CCCC",193,194,195,196);
3082
3083     $foo = pack("s2",1,2);
3084     # "\1\0\2\0" on little-endian
3085     # "\0\1\0\2" on big-endian
3086
3087     $foo = pack("a4","abcd","x","y","z");
3088     # "abcd"
3089
3090     $foo = pack("aaaa","abcd","x","y","z");
3091     # "axyz"
3092
3093     $foo = pack("a14","abcdefg");
3094     # "abcdefg\0\0\0\0\0\0\0"
3095
3096     $foo = pack("i9pl", gmtime);
3097     # a real struct tm (on my system anyway)
3098
3099     $utmp_template = "Z8 Z8 Z16 L";
3100     $utmp = pack($utmp_template, @utmp1);
3101     # a struct utmp (BSDish)
3102
3103     @utmp2 = unpack($utmp_template, $utmp);
3104     # "@utmp1" eq "@utmp2"
3105
3106     sub bintodec {
3107         unpack("N", pack("B32", substr("0" x 32 . shift, -32)));
3108     }
3109
3110     $foo = pack('sx2l', 12, 34);
3111     # short 12, two zero bytes padding, long 34
3112     $bar = pack('s@4l', 12, 34);
3113     # short 12, zero fill to position 4, long 34
3114     # $foo eq $bar
3115
3116 The same template may generally also be used in unpack().
3117
3118 =item package 
3119
3120 =item package NAMESPACE
3121
3122 Declares the compilation unit as being in the given namespace.  The scope
3123 of the package declaration is from the declaration itself through the end
3124 of the enclosing block, file, or eval (the same as the C<my> operator).
3125 All further unqualified dynamic identifiers will be in this namespace.
3126 A package statement affects only dynamic variables--including those
3127 you've used C<local> on--but I<not> lexical variables, which are created
3128 with C<my>.  Typically it would be the first declaration in a file to
3129 be included by the C<require> or C<use> operator.  You can switch into a
3130 package in more than one place; it merely influences which symbol table
3131 is used by the compiler for the rest of that block.  You can refer to
3132 variables and filehandles in other packages by prefixing the identifier
3133 with the package name and a double colon:  C<$Package::Variable>.
3134 If the package name is null, the C<main> package as assumed.  That is,
3135 C<$::sail> is equivalent to C<$main::sail> (as well as to C<$main'sail>,
3136 still seen in older code).
3137
3138 If NAMESPACE is omitted, then there is no current package, and all
3139 identifiers must be fully qualified or lexicals.  This is stricter
3140 than C<use strict>, since it also extends to function names.
3141
3142 See L<perlmod/"Packages"> for more information about packages, modules,
3143 and classes.  See L<perlsub> for other scoping issues.
3144
3145 =item pipe READHANDLE,WRITEHANDLE
3146
3147 Opens a pair of connected pipes like the corresponding system call.
3148 Note that if you set up a loop of piped processes, deadlock can occur
3149 unless you are very careful.  In addition, note that Perl's pipes use
3150 stdio buffering, so you may need to set C<$|> to flush your WRITEHANDLE
3151 after each command, depending on the application.
3152
3153 See L<IPC::Open2>, L<IPC::Open3>, and L<perlipc/"Bidirectional Communication">
3154 for examples of such things.
3155
3156 On systems that support a close-on-exec flag on files, the flag will be set
3157 for the newly opened file descriptors as determined by the value of $^F.
3158 See L<perlvar/$^F>.
3159
3160 =item pop ARRAY
3161
3162 =item pop
3163
3164 Pops and returns the last value of the array, shortening the array by
3165 one element.  Has an effect similar to
3166
3167     $ARRAY[$#ARRAY--]
3168
3169 If there are no elements in the array, returns the undefined value
3170 (although this may happen at other times as well).  If ARRAY is
3171 omitted, pops the C<@ARGV> array in the main program, and the C<@_>
3172 array in subroutines, just like C<shift>.
3173
3174 =item pos SCALAR
3175
3176 =item pos
3177
3178 Returns the offset of where the last C<m//g> search left off for the variable
3179 is in question (C<$_> is used when the variable is not specified).  May be
3180 modified to change that offset.  Such modification will also influence
3181 the C<\G> zero-width assertion in regular expressions.  See L<perlre> and
3182 L<perlop>.
3183
3184 =item print FILEHANDLE LIST
3185
3186 =item print LIST
3187
3188 =item print
3189
3190 Prints a string or a list of strings.  Returns true if successful.
3191 FILEHANDLE may be a scalar variable name, in which case the variable
3192 contains the name of or a reference to the filehandle, thus introducing
3193 one level of indirection.  (NOTE: If FILEHANDLE is a variable and
3194 the next token is a term, it may be misinterpreted as an operator
3195 unless you interpose a C<+> or put parentheses around the arguments.)
3196 If FILEHANDLE is omitted, prints by default to standard output (or
3197 to the last selected output channel--see L</select>).  If LIST is
3198 also omitted, prints C<$_> to the currently selected output channel.
3199 To set the default output channel to something other than STDOUT
3200 use the select operation.  The current value of C<$,> (if any) is
3201 printed between each LIST item.  The current value of C<$\> (if
3202 any) is printed after the entire LIST has been printed.  Because
3203 print takes a LIST, anything in the LIST is evaluated in list
3204 context, and any subroutine that you call will have one or more of
3205 its expressions evaluated in list context.  Also be careful not to
3206 follow the print keyword with a left parenthesis unless you want
3207 the corresponding right parenthesis to terminate the arguments to
3208 the print--interpose a C<+> or put parentheses around all the
3209 arguments.
3210
3211 Note that if you're storing FILEHANDLES in an array or other expression,
3212 you will have to use a block returning its value instead:
3213
3214     print { $files[$i] } "stuff\n";
3215     print { $OK ? STDOUT : STDERR } "stuff\n";
3216
3217 =item printf FILEHANDLE FORMAT, LIST
3218
3219 =item printf FORMAT, LIST
3220
3221 Equivalent to C<print FILEHANDLE sprintf(FORMAT, LIST)>, except that C<$\>
3222 (the output record separator) is not appended.  The first argument
3223 of the list will be interpreted as the C<printf> format.  If C<use locale> is
3224 in effect, the character used for the decimal point in formatted real numbers
3225 is affected by the LC_NUMERIC locale.  See L<perllocale>.
3226
3227 Don't fall into the trap of using a C<printf> when a simple
3228 C<print> would do.  The C<print> is more efficient and less
3229 error prone.
3230
3231 =item prototype FUNCTION
3232
3233 Returns the prototype of a function as a string (or C<undef> if the
3234 function has no prototype).  FUNCTION is a reference to, or the name of,
3235 the function whose prototype you want to retrieve.
3236
3237 If FUNCTION is a string starting with C<CORE::>, the rest is taken as a
3238 name for Perl builtin.  If the builtin is not I<overridable> (such as
3239 C<qw//>) or its arguments cannot be expressed by a prototype (such as
3240 C<system>) returns C<undef> because the builtin does not really behave
3241 like a Perl function.  Otherwise, the string describing the equivalent
3242 prototype is returned.
3243
3244 =item push ARRAY,LIST
3245
3246 Treats ARRAY as a stack, and pushes the values of LIST
3247 onto the end of ARRAY.  The length of ARRAY increases by the length of
3248 LIST.  Has the same effect as
3249
3250     for $value (LIST) {
3251         $ARRAY[++$#ARRAY] = $value;
3252     }
3253
3254 but is more efficient.  Returns the new number of elements in the array.
3255
3256 =item q/STRING/
3257
3258 =item qq/STRING/
3259
3260 =item qr/STRING/
3261
3262 =item qx/STRING/
3263
3264 =item qw/STRING/
3265
3266 Generalized quotes.  See L<perlop/"Regexp Quote-Like Operators">.
3267
3268 =item quotemeta EXPR
3269
3270 =item quotemeta
3271
3272 Returns the value of EXPR with all non-alphanumeric
3273 characters backslashed.  (That is, all characters not matching
3274 C</[A-Za-z_0-9]/> will be preceded by a backslash in the
3275 returned string, regardless of any locale settings.)
3276 This is the internal function implementing
3277 the C<\Q> escape in double-quoted strings.
3278
3279 If EXPR is omitted, uses C<$_>.
3280
3281 =item rand EXPR
3282
3283 =item rand
3284
3285 Returns a random fractional number greater than or equal to C<0> and less
3286 than the value of EXPR.  (EXPR should be positive.)  If EXPR is
3287 omitted, the value C<1> is used.  Automatically calls C<srand> unless
3288 C<srand> has already been called.  See also C<srand>.
3289
3290 (Note: If your rand function consistently returns numbers that are too
3291 large or too small, then your version of Perl was probably compiled
3292 with the wrong number of RANDBITS.)
3293
3294 =item read FILEHANDLE,SCALAR,LENGTH,OFFSET
3295
3296 =item read FILEHANDLE,SCALAR,LENGTH
3297
3298 Attempts to read LENGTH bytes of data into variable SCALAR from the
3299 specified FILEHANDLE.  Returns the number of bytes actually read,
3300 C<0> at end of file, or undef if there was an error.  SCALAR will be grown
3301 or shrunk to the length actually read.  An OFFSET may be specified to
3302 place the read data at some other place than the beginning of the
3303 string.  This call is actually implemented in terms of stdio's fread(3)
3304 call.  To get a true read(2) system call, see C<sysread>.
3305
3306 =item readdir DIRHANDLE
3307
3308 Returns the next directory entry for a directory opened by C<opendir>.
3309 If used in list context, returns all the rest of the entries in the
3310 directory.  If there are no more entries, returns an undefined value in
3311 scalar context or a null list in list context.
3312
3313 If you're planning to filetest the return values out of a C<readdir>, you'd
3314 better prepend the directory in question.  Otherwise, because we didn't
3315 C<chdir> there, it would have been testing the wrong file.
3316
3317     opendir(DIR, $some_dir) || die "can't opendir $some_dir: $!";
3318     @dots = grep { /^\./ && -f "$some_dir/$_" } readdir(DIR);
3319     closedir DIR;
3320
3321 =item readline EXPR
3322
3323 Reads from the filehandle whose typeglob is contained in EXPR.  In scalar
3324 context, each call reads and returns the next line, until end-of-file is
3325 reached, whereupon the subsequent call returns undef.  In list context,
3326 reads until end-of-file is reached and returns a list of lines.  Note that
3327 the notion of "line" used here is however you may have defined it
3328 with C<$/> or C<$INPUT_RECORD_SEPARATOR>).  See L<perlvar/"$/">.
3329
3330 When C<$/> is set to C<undef>, when readline() is in scalar
3331 context (i.e. file slurp mode), and when an empty file is read, it
3332 returns C<''> the first time, followed by C<undef> subsequently.
3333
3334 This is the internal function implementing the C<E<lt>EXPRE<gt>>
3335 operator, but you can use it directly.  The C<E<lt>EXPRE<gt>>
3336 operator is discussed in more detail in L<perlop/"I/O Operators">.
3337
3338     $line = <STDIN>;
3339     $line = readline(*STDIN);           # same thing
3340
3341 =item readlink EXPR
3342
3343 =item readlink
3344
3345 Returns the value of a symbolic link, if symbolic links are
3346 implemented.  If not, gives a fatal error.  If there is some system
3347 error, returns the undefined value and sets C<$!> (errno).  If EXPR is
3348 omitted, uses C<$_>.
3349
3350 =item readpipe EXPR
3351
3352 EXPR is executed as a system command.
3353 The collected standard output of the command is returned.
3354 In scalar context, it comes back as a single (potentially
3355 multi-line) string.  In list context, returns a list of lines
3356 (however you've defined lines with C<$/> or C<$INPUT_RECORD_SEPARATOR>).
3357 This is the internal function implementing the C<qx/EXPR/>
3358 operator, but you can use it directly.  The C<qx/EXPR/>
3359 operator is discussed in more detail in L<perlop/"I/O Operators">.
3360
3361 =item recv SOCKET,SCALAR,LENGTH,FLAGS
3362
3363 Receives a message on a socket.  Attempts to receive LENGTH bytes of
3364 data into variable SCALAR from the specified SOCKET filehandle.  SCALAR
3365 will be grown or shrunk to the length actually read.  Takes the same
3366 flags as the system call of the same name.  Returns the address of the
3367 sender if SOCKET's protocol supports this; returns an empty string
3368 otherwise.  If there's an error, returns the undefined value.  This call
3369 is actually implemented in terms of recvfrom(2) system call.  See
3370 L<perlipc/"UDP: Message Passing"> for examples.
3371
3372 =item redo LABEL
3373
3374 =item redo
3375
3376 The C<redo> command restarts the loop block without evaluating the
3377 conditional again.  The C<continue> block, if any, is not executed.  If
3378 the LABEL is omitted, the command refers to the innermost enclosing
3379 loop.  This command is normally used by programs that want to lie to
3380 themselves about what was just input:
3381
3382     # a simpleminded Pascal comment stripper
3383     # (warning: assumes no { or } in strings)
3384     LINE: while (<STDIN>) {
3385         while (s|({.*}.*){.*}|$1 |) {}
3386         s|{.*}| |;
3387         if (s|{.*| |) {
3388             $front = $_;
3389             while (<STDIN>) {
3390                 if (/}/) {      # end of comment?
3391                     s|^|$front\{|;
3392                     redo LINE;
3393                 }
3394             }
3395         }
3396         print;
3397     }
3398
3399 C<redo> cannot be used to retry a block which returns a value such as
3400 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
3401 a grep() or map() operation.
3402
3403 Note that a block by itself is semantically identical to a loop
3404 that executes once.  Thus C<redo> inside such a block will effectively
3405 turn it into a looping construct.
3406
3407 See also L</continue> for an illustration of how C<last>, C<next>, and
3408 C<redo> work.
3409
3410 =item ref EXPR
3411
3412 =item ref
3413
3414 Returns a true value if EXPR is a reference, false otherwise.  If EXPR
3415 is not specified, C<$_> will be used.  The value returned depends on the
3416 type of thing the reference is a reference to.
3417 Builtin types include:
3418
3419     SCALAR
3420     ARRAY
3421     HASH
3422     CODE
3423     REF
3424     GLOB
3425     LVALUE
3426
3427 If the referenced object has been blessed into a package, then that package
3428 name is returned instead.  You can think of C<ref> as a C<typeof> operator.
3429
3430     if (ref($r) eq "HASH") {
3431         print "r is a reference to a hash.\n";
3432     }
3433     unless (ref($r)) {
3434         print "r is not a reference at all.\n";
3435     }
3436     if (UNIVERSAL::isa($r, "HASH")) {  # for subclassing
3437         print "r is a reference to something that isa hash.\n";
3438     } 
3439
3440 See also L<perlref>.
3441
3442 =item rename OLDNAME,NEWNAME
3443
3444 Changes the name of a file; an existing file NEWNAME will be
3445 clobbered.  Returns true for success, false otherwise.
3446
3447 Behavior of this function varies wildly depending on your system
3448 implementation.  For example, it will usually not work across file system
3449 boundaries, even though the system I<mv> command sometimes compensates
3450 for this.  Other restrictions include whether it works on directories,
3451 open files, or pre-existing files.  Check L<perlport> and either the
3452 rename(2) manpage or equivalent system documentation for details.
3453
3454 =item require EXPR
3455
3456 =item require
3457
3458 Demands some semantics specified by EXPR, or by C<$_> if EXPR is not
3459 supplied.  If EXPR is numeric, demands that the current version of Perl
3460 (C<$]> or $PERL_VERSION) be equal or greater than EXPR.
3461
3462 Otherwise, demands that a library file be included if it hasn't already
3463 been included.  The file is included via the do-FILE mechanism, which is
3464 essentially just a variety of C<eval>.  Has semantics similar to the following
3465 subroutine:
3466
3467     sub require {
3468         my($filename) = @_;
3469         return 1 if $INC{$filename};
3470         my($realfilename,$result);
3471         ITER: {
3472             foreach $prefix (@INC) {
3473                 $realfilename = "$prefix/$filename";
3474                 if (-f $realfilename) {
3475                     $INC{$filename} = $realfilename;
3476                     $result = do $realfilename;
3477                     last ITER;
3478                 }
3479             }
3480             die "Can't find $filename in \@INC";
3481         }
3482         delete $INC{$filename} if $@ || !$result;
3483         die $@ if $@;
3484         die "$filename did not return true value" unless $result;
3485         return $result;
3486     }
3487
3488 Note that the file will not be included twice under the same specified
3489 name.  The file must return true as the last statement to indicate
3490 successful execution of any initialization code, so it's customary to
3491 end such a file with C<1;> unless you're sure it'll return true
3492 otherwise.  But it's better just to put the C<1;>, in case you add more
3493 statements.
3494
3495 If EXPR is a bareword, the require assumes a "F<.pm>" extension and
3496 replaces "F<::>" with "F</>" in the filename for you,
3497 to make it easy to load standard modules.  This form of loading of
3498 modules does not risk altering your namespace.
3499
3500 In other words, if you try this:
3501
3502         require Foo::Bar;    # a splendid bareword 
3503
3504 The require function will actually look for the "F<Foo/Bar.pm>" file in the 
3505 directories specified in the C<@INC> array.
3506
3507 But if you try this:
3508
3509         $class = 'Foo::Bar';
3510         require $class;      # $class is not a bareword
3511     #or
3512         require "Foo::Bar";  # not a bareword because of the ""
3513
3514 The require function will look for the "F<Foo::Bar>" file in the @INC array and 
3515 will complain about not finding "F<Foo::Bar>" there.  In this case you can do:
3516
3517         eval "require $class";
3518
3519 For a yet-more-powerful import facility, see L</use> and L<perlmod>.
3520
3521 =item reset EXPR
3522
3523 =item reset
3524
3525 Generally used in a C<continue> block at the end of a loop to clear
3526 variables and reset C<??> searches so that they work again.  The
3527 expression is interpreted as a list of single characters (hyphens
3528 allowed for ranges).  All variables and arrays beginning with one of
3529 those letters are reset to their pristine state.  If the expression is
3530 omitted, one-match searches (C<?pattern?>) are reset to match again.  Resets
3531 only variables or searches in the current package.  Always returns
3532 1.  Examples:
3533
3534     reset 'X';          # reset all X variables
3535     reset 'a-z';        # reset lower case variables
3536     reset;              # just reset ?one-time? searches
3537
3538 Resetting C<"A-Z"> is not recommended because you'll wipe out your
3539 C<@ARGV> and C<@INC> arrays and your C<%ENV> hash.  Resets only package
3540 variables--lexical variables are unaffected, but they clean themselves
3541 up on scope exit anyway, so you'll probably want to use them instead.
3542 See L</my>.
3543
3544 =item return EXPR
3545
3546 =item return
3547
3548 Returns from a subroutine, C<eval>, or C<do FILE> with the value 
3549 given in EXPR.  Evaluation of EXPR may be in list, scalar, or void
3550 context, depending on how the return value will be used, and the context
3551 may vary from one execution to the next (see C<wantarray>).  If no EXPR
3552 is given, returns an empty list in list context, the undefined value in
3553 scalar context, and (of course) nothing at all in a void context.
3554
3555 (Note that in the absence of a explicit C<return>, a subroutine, eval,
3556 or do FILE will automatically return the value of the last expression
3557 evaluated.)
3558
3559 =item reverse LIST
3560
3561 In list context, returns a list value consisting of the elements
3562 of LIST in the opposite order.  In scalar context, concatenates the
3563 elements of LIST and returns a string value with all characters
3564 in the opposite order.
3565
3566     print reverse <>;           # line tac, last line first
3567
3568     undef $/;                   # for efficiency of <>
3569     print scalar reverse <>;    # character tac, last line tsrif
3570
3571 This operator is also handy for inverting a hash, although there are some
3572 caveats.  If a value is duplicated in the original hash, only one of those
3573 can be represented as a key in the inverted hash.  Also, this has to
3574 unwind one hash and build a whole new one, which may take some time
3575 on a large hash, such as from a DBM file.
3576
3577     %by_name = reverse %by_address;     # Invert the hash
3578
3579 =item rewinddir DIRHANDLE
3580
3581 Sets the current position to the beginning of the directory for the
3582 C<readdir> routine on DIRHANDLE.
3583
3584 =item rindex STR,SUBSTR,POSITION
3585
3586 =item rindex STR,SUBSTR
3587
3588 Works just like index() except that it returns the position of the LAST
3589 occurrence of SUBSTR in STR.  If POSITION is specified, returns the
3590 last occurrence at or before that position.
3591
3592 =item rmdir FILENAME
3593
3594 =item rmdir
3595
3596 Deletes the directory specified by FILENAME if that directory is empty.  If it
3597 succeeds it returns true, otherwise it returns false and sets C<$!> (errno).  If
3598 FILENAME is omitted, uses C<$_>.
3599
3600 =item s///
3601
3602 The substitution operator.  See L<perlop>.
3603
3604 =item scalar EXPR
3605
3606 Forces EXPR to be interpreted in scalar context and returns the value
3607 of EXPR.
3608
3609     @counts = ( scalar @a, scalar @b, scalar @c );
3610
3611 There is no equivalent operator to force an expression to
3612 be interpolated in list context because in practice, this is never
3613 needed.  If you really wanted to do so, however, you could use
3614 the construction C<@{[ (some expression) ]}>, but usually a simple
3615 C<(some expression)> suffices.
3616
3617 Because C<scalar> is unary operator, if you accidentally use for EXPR a
3618 parenthesized list, this behaves as a scalar comma expression, evaluating
3619 all but the last element in void context and returning the final element
3620 evaluated in scalar context.  This is seldom what you want.
3621
3622 The following single statement:
3623
3624         print uc(scalar(&foo,$bar)),$baz;
3625
3626 is the moral equivalent of these two:
3627
3628         &foo;
3629         print(uc($bar),$baz);
3630
3631 See L<perlop> for more details on unary operators and the comma operator.
3632
3633 =item seek FILEHANDLE,POSITION,WHENCE
3634
3635 Sets FILEHANDLE's position, just like the C<fseek> call of C<stdio>.
3636 FILEHANDLE may be an expression whose value gives the name of the
3637 filehandle.  The values for WHENCE are C<0> to set the new position to
3638 POSITION, C<1> to set it to the current position plus POSITION, and
3639 C<2> to set it to EOF plus POSITION (typically negative).  For WHENCE
3640 you may use the constants C<SEEK_SET>, C<SEEK_CUR>, and C<SEEK_END>
3641 (start of the file, current position, end of the file) from any of the
3642 modules Fcntl, C<IO::Seekable>, or POSIX.  Returns C<1> upon success,
3643 C<0> otherwise.
3644
3645 If you want to position file for C<sysread> or C<syswrite>, don't use
3646 C<seek>--buffering makes its effect on the file's system position
3647 unpredictable and non-portable.  Use C<sysseek> instead.
3648
3649 Due to the rules and rigors of ANSI C, on some systems you have to do a
3650 seek whenever you switch between reading and writing.  Amongst other
3651 things, this may have the effect of calling stdio's clearerr(3).
3652 A WHENCE of C<1> (C<SEEK_CUR>) is useful for not moving the file position:
3653
3654     seek(TEST,0,1);
3655
3656 This is also useful for applications emulating C<tail -f>.  Once you hit
3657 EOF on your read, and then sleep for a while, you might have to stick in a
3658 seek() to reset things.  The C<seek> doesn't change the current position,
3659 but it I<does> clear the end-of-file condition on the handle, so that the
3660 next C<E<lt>FILEE<gt>> makes Perl try again to read something.  We hope.
3661
3662 If that doesn't work (some stdios are particularly cantankerous), then
3663 you may need something more like this:
3664
3665     for (;;) {
3666         for ($curpos = tell(FILE); $_ = <FILE>;
3667              $curpos = tell(FILE)) {
3668             # search for some stuff and put it into files
3669         }
3670         sleep($for_a_while);
3671         seek(FILE, $curpos, 0);
3672     }
3673
3674 =item seekdir DIRHANDLE,POS
3675
3676 Sets the current position for the C<readdir> routine on DIRHANDLE.  POS
3677 must be a value returned by C<telldir>.  Has the same caveats about
3678 possible directory compaction as the corresponding system library
3679 routine.
3680
3681 =item select FILEHANDLE
3682
3683 =item select
3684
3685 Returns the currently selected filehandle.  Sets the current default
3686 filehandle for output, if FILEHANDLE is supplied.  This has two
3687 effects: first, a C<write> or a C<print> without a filehandle will
3688 default to this FILEHANDLE.  Second, references to variables related to
3689 output will refer to this output channel.  For example, if you have to
3690 set the top of form format for more than one output channel, you might
3691 do the following:
3692
3693     select(REPORT1);
3694     $^ = 'report1_top';
3695     select(REPORT2);
3696     $^ = 'report2_top';
3697
3698 FILEHANDLE may be an expression whose value gives the name of the
3699 actual filehandle.  Thus:
3700
3701     $oldfh = select(STDERR); $| = 1; select($oldfh);
3702
3703 Some programmers may prefer to think of filehandles as objects with
3704 methods, preferring to write the last example as:
3705
3706     use IO::Handle;
3707     STDERR->autoflush(1);
3708
3709 =item select RBITS,WBITS,EBITS,TIMEOUT
3710
3711 This calls the select(2) system call with the bit masks specified, which
3712 can be constructed using C<fileno> and C<vec>, along these lines:
3713
3714     $rin = $win = $ein = '';
3715     vec($rin,fileno(STDIN),1) = 1;
3716     vec($win,fileno(STDOUT),1) = 1;
3717     $ein = $rin | $win;
3718
3719 If you want to select on many filehandles you might wish to write a
3720 subroutine:
3721
3722     sub fhbits {
3723         my(@fhlist) = split(' ',$_[0]);
3724         my($bits);
3725         for (@fhlist) {
3726             vec($bits,fileno($_),1) = 1;
3727         }
3728         $bits;
3729     }
3730     $rin = fhbits('STDIN TTY SOCK');
3731
3732 The usual idiom is:
3733
3734     ($nfound,$timeleft) =
3735       select($rout=$rin, $wout=$win, $eout=$ein, $timeout);
3736
3737 or to block until something becomes ready just do this
3738
3739     $nfound = select($rout=$rin, $wout=$win, $eout=$ein, undef);
3740
3741 Most systems do not bother to return anything useful in $timeleft, so
3742 calling select() in scalar context just returns $nfound.
3743
3744 Any of the bit masks can also be undef.  The timeout, if specified, is
3745 in seconds, which may be fractional.  Note: not all implementations are
3746 capable of returning the$timeleft.  If not, they always return
3747 $timeleft equal to the supplied $timeout.
3748
3749 You can effect a sleep of 250 milliseconds this way:
3750
3751     select(undef, undef, undef, 0.25);
3752
3753 B<WARNING>: One should not attempt to mix buffered I/O (like C<read>
3754 or E<lt>FHE<gt>) with C<select>, except as permitted by POSIX, and even
3755 then only on POSIX systems.  You have to use C<sysread> instead.
3756
3757 =item semctl ID,SEMNUM,CMD,ARG
3758
3759 Calls the System V IPC function C<semctl>.  You'll probably have to say
3760
3761     use IPC::SysV;
3762
3763 first to get the correct constant definitions.  If CMD is IPC_STAT or
3764 GETALL, then ARG must be a variable which will hold the returned
3765 semid_ds structure or semaphore value array.  Returns like C<ioctl>: the
3766 undefined value for error, "C<0 but true>" for zero, or the actual return
3767 value otherwise.  See also C<IPC::SysV> and C<IPC::Semaphore> documentation.
3768
3769 =item semget KEY,NSEMS,FLAGS
3770
3771 Calls the System V IPC function semget.  Returns the semaphore id, or
3772 the undefined value if there is an error.  See also C<IPC::SysV> and
3773 C<IPC::SysV::Semaphore> documentation.
3774
3775 =item semop KEY,OPSTRING
3776
3777 Calls the System V IPC function semop to perform semaphore operations
3778 such as signaling and waiting.  OPSTRING must be a packed array of
3779 semop structures.  Each semop structure can be generated with
3780 C<pack("sss", $semnum, $semop, $semflag)>.  The number of semaphore
3781 operations is implied by the length of OPSTRING.  Returns true if
3782 successful, or false if there is an error.  As an example, the
3783 following code waits on semaphore $semnum of semaphore id $semid:
3784
3785     $semop = pack("sss", $semnum, -1, 0);
3786     die "Semaphore trouble: $!\n" unless semop($semid, $semop);
3787
3788 To signal the semaphore, replace C<-1> with C<1>.  See also C<IPC::SysV>
3789 and C<IPC::SysV::Semaphore> documentation.
3790
3791 =item send SOCKET,MSG,FLAGS,TO
3792
3793 =item send SOCKET,MSG,FLAGS
3794
3795 Sends a message on a socket.  Takes the same flags as the system call
3796 of the same name.  On unconnected sockets you must specify a
3797 destination to send TO, in which case it does a C C<sendto>.  Returns
3798 the number of characters sent, or the undefined value if there is an
3799 error.  The C system call sendmsg(2) is currently unimplemented.
3800 See L<perlipc/"UDP: Message Passing"> for examples.
3801
3802 =item setpgrp PID,PGRP
3803
3804 Sets the current process group for the specified PID, C<0> for the current
3805 process.  Will produce a fatal error if used on a machine that doesn't
3806 implement POSIX setpgid(2) or BSD setpgrp(2).  If the arguments are omitted,
3807 it defaults to C<0,0>.  Note that the BSD 4.2 version of C<setpgrp> does not
3808 accept any arguments, so only C<setpgrp(0,0)> is portable.  See also
3809 C<POSIX::setsid()>.
3810
3811 =item setpriority WHICH,WHO,PRIORITY
3812
3813 Sets the current priority for a process, a process group, or a user.
3814 (See setpriority(2).)  Will produce a fatal error if used on a machine
3815 that doesn't implement setpriority(2).
3816
3817 =item setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL
3818
3819 Sets the socket option requested.  Returns undefined if there is an
3820 error.  OPTVAL may be specified as C<undef> if you don't want to pass an
3821 argument.
3822
3823 =item shift ARRAY
3824
3825 =item shift
3826
3827 Shifts the first value of the array off and returns it, shortening the
3828 array by 1 and moving everything down.  If there are no elements in the
3829 array, returns the undefined value.  If ARRAY is omitted, shifts the
3830 C<@_> array within the lexical scope of subroutines and formats, and the
3831 C<@ARGV> array at file scopes or within the lexical scopes established by
3832 the C<eval ''>, C<BEGIN {}>, C<INIT {}>, C<STOP {}>, and C<END {}>
3833 constructs.
3834
3835 See also C<unshift>, C<push>, and C<pop>.  C<Shift()> and C<unshift> do the
3836 same thing to the left end of an array that C<pop> and C<push> do to the
3837 right end.
3838
3839 =item shmctl ID,CMD,ARG
3840
3841 Calls the System V IPC function shmctl.  You'll probably have to say
3842
3843     use IPC::SysV;
3844
3845 first to get the correct constant definitions.  If CMD is C<IPC_STAT>,
3846 then ARG must be a variable which will hold the returned C<shmid_ds>
3847 structure.  Returns like ioctl: the undefined value for error, "C<0> but
3848 true" for zero, or the actual return value otherwise.
3849 See also C<IPC::SysV> documentation.
3850
3851 =item shmget KEY,SIZE,FLAGS
3852
3853 Calls the System V IPC function shmget.  Returns the shared memory
3854 segment id, or the undefined value if there is an error.
3855 See also C<IPC::SysV> documentation.
3856
3857 =item shmread ID,VAR,POS,SIZE
3858
3859 =item shmwrite ID,STRING,POS,SIZE
3860
3861 Reads or writes the System V shared memory segment ID starting at
3862 position POS for size SIZE by attaching to it, copying in/out, and
3863 detaching from it.  When reading, VAR must be a variable that will
3864 hold the data read.  When writing, if STRING is too long, only SIZE
3865 bytes are used; if STRING is too short, nulls are written to fill out
3866 SIZE bytes.  Return true if successful, or false if there is an error.
3867 See also C<IPC::SysV> documentation and the C<IPC::Shareable> module
3868 from CPAN.
3869
3870 =item shutdown SOCKET,HOW
3871
3872 Shuts down a socket connection in the manner indicated by HOW, which
3873 has the same interpretation as in the system call of the same name.
3874
3875     shutdown(SOCKET, 0);    # I/we have stopped reading data
3876     shutdown(SOCKET, 1);    # I/we have stopped writing data
3877     shutdown(SOCKET, 2);    # I/we have stopped using this socket
3878
3879 This is useful with sockets when you want to tell the other
3880 side you're done writing but not done reading, or vice versa.
3881 It's also a more insistent form of close because it also 
3882 disables the file descriptor in any forked copies in other
3883 processes.
3884
3885 =item sin EXPR
3886
3887 =item sin
3888
3889 Returns the sine of EXPR (expressed in radians).  If EXPR is omitted,
3890 returns sine of C<$_>.
3891
3892 For the inverse sine operation, you may use the C<POSIX::asin>
3893 function, or use this relation:
3894
3895     sub asin { atan2($_[0], sqrt(1 - $_[0] * $_[0])) }
3896
3897 =item sleep EXPR
3898
3899 =item sleep
3900
3901 Causes the script to sleep for EXPR seconds, or forever if no EXPR.
3902 May be interrupted if the process receives a signal such as C<SIGALRM>.
3903 Returns the number of seconds actually slept.  You probably cannot
3904 mix C<alarm> and C<sleep> calls, because C<sleep> is often implemented
3905 using C<alarm>.
3906
3907 On some older systems, it may sleep up to a full second less than what
3908 you requested, depending on how it counts seconds.  Most modern systems
3909 always sleep the full amount.  They may appear to sleep longer than that,
3910 however, because your process might not be scheduled right away in a
3911 busy multitasking system.
3912
3913 For delays of finer granularity than one second, you may use Perl's
3914 C<syscall> interface to access setitimer(2) if your system supports
3915 it, or else see L</select> above.  The Time::HiRes module from CPAN
3916 may also help.
3917
3918 See also the POSIX module's C<sigpause> function.
3919
3920 =item socket SOCKET,DOMAIN,TYPE,PROTOCOL
3921
3922 Opens a socket of the specified kind and attaches it to filehandle
3923 SOCKET.  DOMAIN, TYPE, and PROTOCOL are specified the same as for
3924 the system call of the same name.  You should C<use Socket> first
3925 to get the proper definitions imported.  See the examples in
3926 L<perlipc/"Sockets: Client/Server Communication">.
3927
3928 =item socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL
3929
3930 Creates an unnamed pair of sockets in the specified domain, of the
3931 specified type.  DOMAIN, TYPE, and PROTOCOL are specified the same as
3932 for the system call of the same name.  If unimplemented, yields a fatal
3933 error.  Returns true if successful.
3934
3935 Some systems defined C<pipe> in terms of C<socketpair>, in which a call
3936 to C<pipe(Rdr, Wtr)> is essentially:
3937
3938     use Socket;
3939     socketpair(Rdr, Wtr, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
3940     shutdown(Rdr, 1);        # no more writing for reader
3941     shutdown(Wtr, 0);        # no more reading for writer
3942
3943 See L<perlipc> for an example of socketpair use.
3944
3945 =item sort SUBNAME LIST
3946
3947 =item sort BLOCK LIST
3948
3949 =item sort LIST
3950
3951 Sorts the LIST and returns the sorted list value.  If SUBNAME or BLOCK
3952 is omitted, C<sort>s in standard string comparison order.  If SUBNAME is
3953 specified, it gives the name of a subroutine that returns an integer
3954 less than, equal to, or greater than C<0>, depending on how the elements
3955 of the list are to be ordered.  (The C<E<lt>=E<gt>> and C<cmp>
3956 operators are extremely useful in such routines.)  SUBNAME may be a
3957 scalar variable name (unsubscripted), in which case the value provides
3958 the name of (or a reference to) the actual subroutine to use.  In place
3959 of a SUBNAME, you can provide a BLOCK as an anonymous, in-line sort
3960 subroutine.
3961
3962 If the subroutine's prototype is C<($$)>, the elements to be compared
3963 are passed by reference in C<@_>, as for a normal subroutine.  If not,
3964 the normal calling code for subroutines is bypassed in the interests of
3965 efficiency, and the elements to be compared are passed into the subroutine
3966 as the package global variables $a and $b (see example below).  Note that
3967 in the latter case, it is usually counter-productive to declare $a and
3968 $b as lexicals.
3969
3970 In either case, the subroutine may not be recursive.  The values to be
3971 compared are always passed by reference, so don't modify them.
3972
3973 You also cannot exit out of the sort block or subroutine using any of the
3974 loop control operators described in L<perlsyn> or with C<goto>.
3975
3976 When C<use locale> is in effect, C<sort LIST> sorts LIST according to the
3977 current collation locale.  See L<perllocale>.
3978
3979 Examples:
3980
3981     # sort lexically
3982     @articles = sort @files;
3983
3984     # same thing, but with explicit sort routine
3985     @articles = sort {$a cmp $b} @files;
3986
3987     # now case-insensitively
3988     @articles = sort {uc($a) cmp uc($b)} @files;
3989
3990     # same thing in reversed order
3991     @articles = sort {$b cmp $a} @files;
3992
3993     # sort numerically ascending
3994     @articles = sort {$a <=> $b} @files;
3995
3996     # sort numerically descending
3997     @articles = sort {$b <=> $a} @files;
3998
3999     # this sorts the %age hash by value instead of key
4000     # using an in-line function
4001     @eldest = sort { $age{$b} <=> $age{$a} } keys %age;
4002
4003     # sort using explicit subroutine name
4004     sub byage {
4005         $age{$a} <=> $age{$b};  # presuming numeric
4006     }
4007     @sortedclass = sort byage @class;
4008
4009     sub backwards { $b cmp $a }
4010     @harry  = qw(dog cat x Cain Abel);
4011     @george = qw(gone chased yz Punished Axed);
4012     print sort @harry;
4013             # prints AbelCaincatdogx
4014     print sort backwards @harry;
4015             # prints xdogcatCainAbel
4016     print sort @george, 'to', @harry;
4017             # prints AbelAxedCainPunishedcatchaseddoggonetoxyz
4018
4019     # inefficiently sort by descending numeric compare using
4020     # the first integer after the first = sign, or the
4021     # whole record case-insensitively otherwise
4022
4023     @new = sort {
4024         ($b =~ /=(\d+)/)[0] <=> ($a =~ /=(\d+)/)[0]
4025                             ||
4026                     uc($a)  cmp  uc($b)
4027     } @old;
4028
4029     # same thing, but much more efficiently;
4030     # we'll build auxiliary indices instead
4031     # for speed
4032     @nums = @caps = ();
4033     for (@old) {
4034         push @nums, /=(\d+)/;
4035         push @caps, uc($_);
4036     }
4037
4038     @new = @old[ sort {
4039                         $nums[$b] <=> $nums[$a]
4040                                  ||
4041                         $caps[$a] cmp $caps[$b]
4042                        } 0..$#old
4043                ];
4044
4045     # same thing, but without any temps
4046     @new = map { $_->[0] }
4047            sort { $b->[1] <=> $a->[1]
4048                            ||
4049                   $a->[2] cmp $b->[2]
4050            } map { [$_, /=(\d+)/, uc($_)] } @old;
4051     
4052     # using a prototype allows you to use any comparison subroutine
4053     # as a sort subroutine (including other package's subroutines)
4054     package other;
4055     sub backwards ($$) { $_[1] cmp $_[0]; }     # $a and $b are not set here
4056
4057     package main;
4058     @new = sort other::backwards @old;
4059
4060 If you're using strict, you I<must not> declare $a
4061 and $b as lexicals.  They are package globals.  That means
4062 if you're in the C<main> package, it's
4063
4064     @articles = sort {$main::b <=> $main::a} @files;
4065
4066 or just
4067
4068     @articles = sort {$::b <=> $::a} @files;
4069
4070 but if you're in the C<FooPack> package, it's
4071
4072     @articles = sort {$FooPack::b <=> $FooPack::a} @files;
4073
4074 The comparison function is required to behave.  If it returns
4075 inconsistent results (sometimes saying C<$x[1]> is less than C<$x[2]> and
4076 sometimes saying the opposite, for example) the results are not
4077 well-defined.
4078
4079 =item splice ARRAY,OFFSET,LENGTH,LIST
4080
4081 =item splice ARRAY,OFFSET,LENGTH
4082
4083 =item splice ARRAY,OFFSET
4084
4085 Removes the elements designated by OFFSET and LENGTH from an array, and
4086 replaces them with the elements of LIST, if any.  In list context,
4087 returns the elements removed from the array.  In scalar context,
4088 returns the last element removed, or C<undef> if no elements are
4089 removed.  The array grows or shrinks as necessary.
4090 If OFFSET is negative then it starts that far from the end of the array.
4091 If LENGTH is omitted, removes everything from OFFSET onward.
4092 If LENGTH is negative, leave that many elements off the end of the array.
4093 The following equivalences hold (assuming C<$[ == 0>):
4094
4095     push(@a,$x,$y)      splice(@a,@a,0,$x,$y)
4096     pop(@a)             splice(@a,-1)
4097     shift(@a)           splice(@a,0,1)
4098     unshift(@a,$x,$y)   splice(@a,0,0,$x,$y)
4099     $a[$x] = $y         splice(@a,$x,1,$y)
4100
4101 Example, assuming array lengths are passed before arrays:
4102
4103     sub aeq {   # compare two list values
4104         my(@a) = splice(@_,0,shift);
4105         my(@b) = splice(@_,0,shift);
4106         return 0 unless @a == @b;       # same len?
4107         while (@a) {
4108             return 0 if pop(@a) ne pop(@b);
4109         }
4110         return 1;
4111     }
4112     if (&aeq($len,@foo[1..$len],0+@bar,@bar)) { ... }
4113
4114 =item split /PATTERN/,EXPR,LIMIT
4115
4116 =item split /PATTERN/,EXPR
4117
4118 =item split /PATTERN/
4119
4120 =item split
4121
4122 Splits a string into a list of strings and returns that list.  By default,
4123 empty leading fields are preserved, and empty trailing ones are deleted.
4124
4125 If not in list context, returns the number of fields found and splits into
4126 the C<@_> array.  (In list context, you can force the split into C<@_> by
4127 using C<??> as the pattern delimiters, but it still returns the list
4128 value.)  The use of implicit split to C<@_> is deprecated, however, because
4129 it clobbers your subroutine arguments.
4130
4131 If EXPR is omitted, splits the C<$_> string.  If PATTERN is also omitted,
4132 splits on whitespace (after skipping any leading whitespace).  Anything
4133 matching PATTERN is taken to be a delimiter separating the fields.  (Note
4134 that the delimiter may be longer than one character.)
4135
4136 If LIMIT is specified and positive, splits into no more than that
4137 many fields (though it may split into fewer).  If LIMIT is unspecified
4138 or zero, trailing null fields are stripped (which potential users
4139 of C<pop> would do well to remember).  If LIMIT is negative, it is
4140 treated as if an arbitrarily large LIMIT had been specified.
4141
4142 A pattern matching the null string (not to be confused with
4143 a null pattern C<//>, which is just one member of the set of patterns
4144 matching a null string) will split the value of EXPR into separate
4145 characters at each point it matches that way.  For example:
4146
4147     print join(':', split(/ */, 'hi there'));
4148
4149 produces the output 'h:i:t:h:e:r:e'.
4150
4151 The LIMIT parameter can be used to split a line partially
4152
4153     ($login, $passwd, $remainder) = split(/:/, $_, 3);
4154
4155 When assigning to a list, if LIMIT is omitted, Perl supplies a LIMIT
4156 one larger than the number of variables in the list, to avoid
4157 unnecessary work.  For the list above LIMIT would have been 4 by
4158 default.  In time critical applications it behooves you not to split
4159 into more fields than you really need.
4160
4161 If the PATTERN contains parentheses, additional list elements are
4162 created from each matching substring in the delimiter.
4163
4164     split(/([,-])/, "1-10,20", 3);
4165
4166 produces the list value
4167
4168     (1, '-', 10, ',', 20)
4169
4170 If you had the entire header of a normal Unix email message in $header,
4171 you could split it up into fields and their values this way:
4172
4173     $header =~ s/\n\s+/ /g;  # fix continuation lines
4174     %hdrs   =  (UNIX_FROM => split /^(\S*?):\s*/m, $header);
4175
4176 The pattern C</PATTERN/> may be replaced with an expression to specify
4177 patterns that vary at runtime.  (To do runtime compilation only once,
4178 use C</$variable/o>.)
4179
4180 As a special case, specifying a PATTERN of space (C<' '>) will split on
4181 white space just as C<split> with no arguments does.  Thus, C<split(' ')> can
4182 be used to emulate B<awk>'s default behavior, whereas C<split(/ /)>
4183 will give you as many null initial fields as there are leading spaces.
4184 A C<split> on C</\s+/> is like a C<split(' ')> except that any leading
4185 whitespace produces a null first field.  A C<split> with no arguments
4186 really does a C<split(' ', $_)> internally.
4187
4188 Example:
4189
4190     open(PASSWD, '/etc/passwd');
4191     while (<PASSWD>) {
4192         ($login, $passwd, $uid, $gid,
4193          $gcos, $home, $shell) = split(/:/);
4194         #...
4195     }
4196
4197 (Note that $shell above will still have a newline on it.  See L</chop>,
4198 L</chomp>, and L</join>.)
4199
4200 =item sprintf FORMAT, LIST
4201
4202 Returns a string formatted by the usual C<printf> conventions of the
4203 C library function C<sprintf>.  See L<sprintf(3)> or L<printf(3)>
4204 on your system for an explanation of the general principles.
4205
4206 Perl does its own C<sprintf> formatting--it emulates the C
4207 function C<sprintf>, but it doesn't use it (except for floating-point
4208 numbers, and even then only the standard modifiers are allowed).  As a
4209 result, any non-standard extensions in your local C<sprintf> are not
4210 available from Perl.
4211
4212 Perl's C<sprintf> permits the following universally-known conversions:
4213
4214    %%   a percent sign
4215    %c   a character with the given number
4216    %s   a string
4217    %d   a signed integer, in decimal
4218    %u   an unsigned integer, in decimal
4219    %o   an unsigned integer, in octal
4220    %x   an unsigned integer, in hexadecimal
4221    %e   a floating-point number, in scientific notation
4222    %f   a floating-point number, in fixed decimal notation
4223    %g   a floating-point number, in %e or %f notation
4224
4225 In addition, Perl permits the following widely-supported conversions:
4226
4227    %X   like %x, but using upper-case letters
4228    %E   like %e, but using an upper-case "E"
4229    %G   like %g, but with an upper-case "E" (if applicable)
4230    %b   an unsigned integer, in binary
4231    %p   a pointer (outputs the Perl value's address in hexadecimal)
4232    %n   special: *stores* the number of characters output so far
4233         into the next variable in the parameter list 
4234
4235 Finally, for backward (and we do mean "backward") compatibility, Perl
4236 permits these unnecessary but widely-supported conversions:
4237
4238    %i   a synonym for %d
4239    %D   a synonym for %ld
4240    %U   a synonym for %lu
4241    %O   a synonym for %lo
4242    %F   a synonym for %f
4243
4244 Perl permits the following universally-known flags between the C<%>
4245 and the conversion letter:
4246
4247    space   prefix positive number with a space
4248    +       prefix positive number with a plus sign
4249    -       left-justify within the field
4250    0       use zeros, not spaces, to right-justify
4251    #       prefix non-zero octal with "0", non-zero hex with "0x"
4252    number  minimum field width
4253    .number "precision": digits after decimal point for
4254            floating-point, max length for string, minimum length
4255            for integer
4256    l       interpret integer as C type "long" or "unsigned long"
4257    h       interpret integer as C type "short" or "unsigned short"
4258            If no flags, interpret integer as C type "int" or "unsigned"
4259
4260 There is also one Perl-specific flag:
4261
4262    V       interpret integer as Perl's standard integer type
4263
4264 Where a number would appear in the flags, an asterisk (C<*>) may be
4265 used instead, in which case Perl uses the next item in the parameter
4266 list as the given number (that is, as the field width or precision).
4267 If a field width obtained through C<*> is negative, it has the same
4268 effect as the C<-> flag: left-justification.
4269
4270 If C<use locale> is in effect, the character used for the decimal
4271 point in formatted real numbers is affected by the LC_NUMERIC locale.
4272 See L<perllocale>.
4273
4274 If Perl understands "quads" (64-bit integers) (this requires
4275 either that the platform natively supports quads or that Perl
4276 has been specifically compiled to support quads), the characters
4277
4278         d u o x X b i D U O
4279
4280 print quads, and they may optionally be preceded by
4281
4282         ll L q
4283
4284 For example
4285
4286         %lld %16LX %qo
4287
4288 You can find out whether your Perl supports quads via L<Config>:
4289
4290         use Config;
4291         ($Config{use64bits} eq 'define' || $Config{longsize} == 8) &&
4292                 print "quads\n";
4293
4294 If Perl understands "long doubles" (this requires that the platform
4295 supports long doubles), the flags
4296
4297         e f g E F G
4298
4299 may optionally be preceded by
4300
4301         ll L
4302
4303 For example
4304
4305         %llf %Lg
4306
4307 You can find out whether your Perl supports long doubles via L<Config>:
4308
4309         use Config;
4310         $Config{d_longdbl} eq 'define' && print "long doubles\n";
4311
4312 =item sqrt EXPR
4313
4314 =item sqrt
4315
4316 Return the square root of EXPR.  If EXPR is omitted, returns square
4317 root of C<$_>.  Only works on non-negative operands, unless you've
4318 loaded the standard Math::Complex module.
4319
4320     use Math::Complex;
4321     print sqrt(-2);    # prints 1.4142135623731i
4322
4323 =item srand EXPR
4324
4325 =item srand
4326
4327 Sets the random number seed for the C<rand> operator.  If EXPR is
4328 omitted, uses a semi-random value supplied by the kernel (if it supports
4329 the F</dev/urandom> device) or based on the current time and process
4330 ID, among other things.  In versions of Perl prior to 5.004 the default
4331 seed was just the current C<time>.  This isn't a particularly good seed,
4332 so many old programs supply their own seed value (often C<time ^ $$> or
4333 C<time ^ ($$ + ($$ E<lt>E<lt> 15))>), but that isn't necessary any more.
4334
4335 In fact, it's usually not necessary to call C<srand> at all, because if
4336 it is not called explicitly, it is called implicitly at the first use of
4337 the C<rand> operator.  However, this was not the case in version of Perl
4338 before 5.004, so if your script will run under older Perl versions, it
4339 should call C<srand>.
4340
4341 Note that you need something much more random than the default seed for
4342 cryptographic purposes.  Checksumming the compressed output of one or more
4343 rapidly changing operating system status programs is the usual method.  For
4344 example:
4345
4346     srand (time ^ $$ ^ unpack "%L*", `ps axww | gzip`);
4347
4348 If you're particularly concerned with this, see the C<Math::TrulyRandom>
4349 module in CPAN.
4350
4351 Do I<not> call C<srand> multiple times in your program unless you know
4352 exactly what you're doing and why you're doing it.  The point of the
4353 function is to "seed" the C<rand> function so that C<rand> can produce
4354 a different sequence each time you run your program.  Just do it once at the
4355 top of your program, or you I<won't> get random numbers out of C<rand>!
4356
4357 Frequently called programs (like CGI scripts) that simply use
4358
4359     time ^ $$
4360
4361 for a seed can fall prey to the mathematical property that
4362
4363     a^b == (a+1)^(b+1)
4364
4365 one-third of the time.  So don't do that.
4366
4367 =item stat FILEHANDLE
4368
4369 =item stat EXPR
4370
4371 =item stat
4372
4373 Returns a 13-element list giving the status info for a file, either
4374 the file opened via FILEHANDLE, or named by EXPR.  If EXPR is omitted,
4375 it stats C<$_>.  Returns a null list if the stat fails.  Typically used
4376 as follows:
4377
4378     ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
4379        $atime,$mtime,$ctime,$blksize,$blocks)
4380            = stat($filename);
4381
4382 Not all fields are supported on all filesystem types.  Here are the
4383 meaning of the fields:
4384
4385   0 dev      device number of filesystem
4386   1 ino      inode number
4387   2 mode     file mode  (type and permissions)
4388   3 nlink    number of (hard) links to the file
4389   4 uid      numeric user ID of file's owner
4390   5 gid      numeric group ID of file's owner
4391   6 rdev     the device identifier (special files only)
4392   7 size     total size of file, in bytes
4393   8 atime    last access time in seconds since the epoch
4394   9 mtime    last modify time in seconds since the epoch
4395  10 ctime    inode change time (NOT creation time!) in seconds since the epoch
4396  11 blksize  preferred block size for file system I/O
4397  12 blocks   actual number of blocks allocated
4398
4399 (The epoch was at 00:00 January 1, 1970 GMT.)
4400
4401 If stat is passed the special filehandle consisting of an underline, no
4402 stat is done, but the current contents of the stat structure from the
4403 last stat or filetest are returned.  Example:
4404
4405     if (-x $file && (($d) = stat(_)) && $d < 0) {
4406         print "$file is executable NFS file\n";
4407     }
4408
4409 (This works on machines only for which the device number is negative under NFS.)
4410
4411 Because the mode contains both the file type and its permissions, you
4412 should mask off the file type portion and (s)printf using a C<"%o"> 
4413 if you want to see the real permissions.
4414
4415     $mode = (stat($filename))[2];
4416     printf "Permissions are %04o\n", $mode & 07777;
4417
4418 In scalar context, C<stat> returns a boolean value indicating success
4419 or failure, and, if successful, sets the information associated with
4420 the special filehandle C<_>.
4421
4422 The File::stat module provides a convenient, by-name access mechanism:
4423
4424     use File::stat;
4425     $sb = stat($filename);
4426     printf "File is %s, size is %s, perm %04o, mtime %s\n", 
4427         $filename, $sb->size, $sb->mode & 07777,
4428         scalar localtime $sb->mtime;
4429
4430 =item study SCALAR
4431
4432 =item study
4433
4434 Takes extra time to study SCALAR (C<$_> if unspecified) in anticipation of
4435 doing many pattern matches on the string before it is next modified.
4436 This may or may not save time, depending on the nature and number of
4437 patterns you are searching on, and on the distribution of character
4438 frequencies in the string to be searched--you probably want to compare
4439 run times with and without it to see which runs faster.  Those loops
4440 which scan for many short constant strings (including the constant
4441 parts of more complex patterns) will benefit most.  You may have only
4442 one C<study> active at a time--if you study a different scalar the first
4443 is "unstudied".  (The way C<study> works is this: a linked list of every
4444 character in the string to be searched is made, so we know, for
4445 example, where all the C<'k'> characters are.  From each search string,
4446 the rarest character is selected, based on some static frequency tables
4447 constructed from some C programs and English text.  Only those places
4448 that contain this "rarest" character are examined.)
4449
4450 For example, here is a loop that inserts index producing entries
4451 before any line containing a certain pattern:
4452
4453     while (<>) {
4454         study;
4455         print ".IX foo\n"       if /\bfoo\b/;
4456         print ".IX bar\n"       if /\bbar\b/;
4457         print ".IX blurfl\n"    if /\bblurfl\b/;
4458         # ...
4459         print;
4460     }
4461
4462 In searching for C</\bfoo\b/>, only those locations in C<$_> that contain C<f>
4463 will be looked at, because C<f> is rarer than C<o>.  In general, this is
4464 a big win except in pathological cases.  The only question is whether
4465 it saves you more time than it took to build the linked list in the
4466 first place.
4467
4468 Note that if you have to look for strings that you don't know till
4469 runtime, you can build an entire loop as a string and C<eval> that to
4470 avoid recompiling all your patterns all the time.  Together with
4471 undefining C<$/> to input entire files as one record, this can be very
4472 fast, often faster than specialized programs like fgrep(1).  The following
4473 scans a list of files (C<@files>) for a list of words (C<@words>), and prints
4474 out the names of those files that contain a match:
4475
4476     $search = 'while (<>) { study;';
4477     foreach $word (@words) {
4478         $search .= "++\$seen{\$ARGV} if /\\b$word\\b/;\n";
4479     }
4480     $search .= "}";
4481     @ARGV = @files;
4482     undef $/;
4483     eval $search;               # this screams
4484     $/ = "\n";          # put back to normal input delimiter
4485     foreach $file (sort keys(%seen)) {
4486         print $file, "\n";
4487     }
4488
4489 =item sub BLOCK
4490
4491 =item sub NAME
4492
4493 =item sub NAME BLOCK
4494
4495 This is subroutine definition, not a real function I<per se>.  With just a
4496 NAME (and possibly prototypes or attributes), it's just a forward declaration.
4497 Without a NAME, it's an anonymous function declaration, and does actually
4498 return a value: the CODE ref of the closure you just created.  See L<perlsub>
4499 and L<perlref> for details.
4500
4501 =item substr EXPR,OFFSET,LENGTH,REPLACEMENT
4502
4503 =item substr EXPR,OFFSET,LENGTH
4504
4505 =item substr EXPR,OFFSET
4506
4507 Extracts a substring out of EXPR and returns it.  First character is at
4508 offset C<0>, or whatever you've set C<$[> to (but don't do that).
4509 If OFFSET is negative (or more precisely, less than C<$[>), starts
4510 that far from the end of the string.  If LENGTH is omitted, returns
4511 everything to the end of the string.  If LENGTH is negative, leaves that
4512 many characters off the end of the string.
4513
4514 You can use the substr() function as an lvalue, in which case EXPR
4515 must itself be an lvalue.  If you assign something shorter than LENGTH,
4516 the string will shrink, and if you assign something longer than LENGTH,
4517 the string will grow to accommodate it.  To keep the string the same
4518 length you may need to pad or chop your value using C<sprintf>.
4519
4520 If OFFSET and LENGTH specify a substring that is partly outside the
4521 string, only the part within the string is returned.  If the substring
4522 is beyond either end of the string, substr() returns the undefined
4523 value and produces a warning.  When used as an lvalue, specifying a
4524 substring that is entirely outside the string is a fatal error.
4525 Here's an example showing the behavior for boundary cases:
4526
4527     my $name = 'fred';
4528     substr($name, 4) = 'dy';            # $name is now 'freddy'
4529     my $null = substr $name, 6, 2;      # returns '' (no warning)
4530     my $oops = substr $name, 7;         # returns undef, with warning
4531     substr($name, 7) = 'gap';           # fatal error
4532
4533 An alternative to using substr() as an lvalue is to specify the
4534 replacement string as the 4th argument.  This allows you to replace
4535 parts of the EXPR and return what was there before in one operation,
4536 just as you can with splice().
4537
4538 =item symlink OLDFILE,NEWFILE
4539
4540 Creates a new filename symbolically linked to the old filename.
4541 Returns C<1> for success, C<0> otherwise.  On systems that don't support
4542 symbolic links, produces a fatal error at run time.  To check for that,
4543 use eval:
4544
4545     $symlink_exists = eval { symlink("",""); 1 };
4546
4547 =item syscall LIST
4548
4549 Calls the system call specified as the first element of the list,
4550 passing the remaining elements as arguments to the system call.  If
4551 unimplemented, produces a fatal error.  The arguments are interpreted
4552 as follows: if a given argument is numeric, the argument is passed as
4553 an int.  If not, the pointer to the string value is passed.  You are
4554 responsible to make sure a string is pre-extended long enough to
4555 receive any result that might be written into a string.  You can't use a
4556 string literal (or other read-only string) as an argument to C<syscall>
4557 because Perl has to assume that any string pointer might be written
4558 through.  If your
4559 integer arguments are not literals and have never been interpreted in a
4560 numeric context, you may need to add C<0> to them to force them to look
4561 like numbers.  This emulates the C<syswrite> function (or vice versa):
4562
4563     require 'syscall.ph';               # may need to run h2ph
4564     $s = "hi there\n";
4565     syscall(&SYS_write, fileno(STDOUT), $s, length $s);
4566
4567 Note that Perl supports passing of up to only 14 arguments to your system call,
4568 which in practice should usually suffice.
4569
4570 Syscall returns whatever value returned by the system call it calls.
4571 If the system call fails, C<syscall> returns C<-1> and sets C<$!> (errno).
4572 Note that some system calls can legitimately return C<-1>.  The proper
4573 way to handle such calls is to assign C<$!=0;> before the call and
4574 check the value of C<$!> if syscall returns C<-1>.
4575
4576 There's a problem with C<syscall(&SYS_pipe)>: it returns the file
4577 number of the read end of the pipe it creates.  There is no way
4578 to retrieve the file number of the other end.  You can avoid this 
4579 problem by using C<pipe> instead.
4580
4581 =item sysopen FILEHANDLE,FILENAME,MODE
4582
4583 =item sysopen FILEHANDLE,FILENAME,MODE,PERMS
4584
4585 Opens the file whose filename is given by FILENAME, and associates it
4586 with FILEHANDLE.  If FILEHANDLE is an expression, its value is used as
4587 the name of the real filehandle wanted.  This function calls the
4588 underlying operating system's C<open> function with the parameters
4589 FILENAME, MODE, PERMS.
4590
4591 The possible values and flag bits of the MODE parameter are
4592 system-dependent; they are available via the standard module C<Fcntl>.
4593 See the documentation of your operating system's C<open> to see which
4594 values and flag bits are available.  You may combine several flags
4595 using the C<|>-operator.
4596
4597 Some of the most common values are C<O_RDONLY> for opening the file in
4598 read-only mode, C<O_WRONLY> for opening the file in write-only mode,
4599 and C<O_RDWR> for opening the file in read-write mode, and.
4600
4601 For historical reasons, some values work on almost every system
4602 supported by perl: zero means read-only, one means write-only, and two
4603 means read/write.  We know that these values do I<not> work under
4604 OS/390 & VM/ESA Unix and on the Macintosh; you probably don't want to
4605 use them in new code.
4606
4607 If the file named by FILENAME does not exist and the C<open> call creates
4608 it (typically because MODE includes the C<O_CREAT> flag), then the value of
4609 PERMS specifies the permissions of the newly created file.  If you omit
4610 the PERMS argument to C<sysopen>, Perl uses the octal value C<0666>.
4611 These permission values need to be in octal, and are modified by your
4612 process's current C<umask>.
4613
4614 In many systems the C<O_EXCL> flag is available for opening files in
4615 exclusive mode.  This is B<not> locking: exclusiveness means here that
4616 if the file already exists, sysopen() fails.  The C<O_EXCL> wins
4617 C<O_TRUNC>.
4618
4619 Sometimes you may want to truncate an already-existing file: C<O_TRUNC>.
4620
4621 You should seldom if ever use C<0644> as argument to C<sysopen>, because
4622 that takes away the user's option to have a more permissive umask.
4623 Better to omit it.  See the perlfunc(1) entry on C<umask> for more
4624 on this.
4625
4626 Note that C<sysopen> depends on the fdopen() C library function.
4627 On many UNIX systems, fdopen() is known to fail when file descriptors
4628 exceed a certain value, typically 255. If you need more file
4629 descriptors than that, consider rebuilding Perl to use the C<sfio>
4630 library, or perhaps using the POSIX::open() function.
4631
4632 See L<perlopentut> for a kinder, gentler explanation of opening files.
4633
4634 =item sysread FILEHANDLE,SCALAR,LENGTH,OFFSET
4635
4636 =item sysread FILEHANDLE,SCALAR,LENGTH
4637
4638 Attempts to read LENGTH bytes of data into variable SCALAR from the
4639 specified FILEHANDLE, using the system call read(2).  It bypasses stdio,
4640 so mixing this with other kinds of reads, C<print>, C<write>,
4641 C<seek>, C<tell>, or C<eof> can cause confusion because stdio
4642 usually buffers data.  Returns the number of bytes actually read, C<0>
4643 at end of file, or undef if there was an error.  SCALAR will be grown or
4644 shrunk so that the last byte actually read is the last byte of the
4645 scalar after the read.
4646
4647 An OFFSET may be specified to place the read data at some place in the
4648 string other than the beginning.  A negative OFFSET specifies
4649 placement at that many bytes counting backwards from the end of the
4650 string.  A positive OFFSET greater than the length of SCALAR results
4651 in the string being padded to the required size with C<"\0"> bytes before
4652 the result of the read is appended.
4653
4654 There is no syseof() function, which is ok, since eof() doesn't work
4655 very well on device files (like ttys) anyway.  Use sysread() and check
4656 for a return value for 0 to decide whether you're done.
4657
4658 =item sysseek FILEHANDLE,POSITION,WHENCE
4659
4660 Sets FILEHANDLE's system position using the system call lseek(2).  It
4661 bypasses stdio, so mixing this with reads (other than C<sysread>),
4662 C<print>, C<write>, C<seek>, C<tell>, or C<eof> may cause confusion.
4663 FILEHANDLE may be an expression whose value gives the name of the
4664 filehandle.  The values for WHENCE are C<0> to set the new position to
4665 POSITION, C<1> to set the it to the current position plus POSITION,
4666 and C<2> to set it to EOF plus POSITION (typically negative).  For
4667 WHENCE, you may also use the constants C<SEEK_SET>, C<SEEK_CUR>, and
4668 C<SEEK_END> (start of the file, current position, end of the file)
4669 from any of the modules Fcntl, C<IO::Seekable>, or POSIX.
4670
4671 Returns the new position, or the undefined value on failure.  A position
4672 of zero is returned as the string C<"0 but true">; thus C<sysseek> returns
4673 true on success and false on failure, yet you can still easily determine
4674 the new position.
4675
4676 =item system LIST
4677
4678 =item system PROGRAM LIST
4679
4680 Does exactly the same thing as C<exec LIST>, except that a fork is
4681 done first, and the parent process waits for the child process to
4682 complete.  Note that argument processing varies depending on the
4683 number of arguments.  If there is more than one argument in LIST,
4684 or if LIST is an array with more than one value, starts the program
4685 given by the first element of the list with arguments given by the
4686 rest of the list.  If there is only one scalar argument, the argument
4687 is checked for shell metacharacters, and if there are any, the
4688 entire argument is passed to the system's command shell for parsing
4689 (this is C</bin/sh -c> on Unix platforms, but varies on other
4690 platforms).  If there are no shell metacharacters in the argument,
4691 it is split into words and passed directly to C<execvp>, which is
4692 more efficient.
4693
4694 All files opened for output are flushed before attempting the exec().
4695
4696 The return value is the exit status of the program as
4697 returned by the C<wait> call.  To get the actual exit value divide by
4698 256.  See also L</exec>.  This is I<not> what you want to use to capture
4699 the output from a command, for that you should use merely backticks or
4700 C<qx//>, as described in L<perlop/"`STRING`">.  Return value of -1
4701 indicates a failure to start the program (inspect $! for the reason).
4702
4703 Like C<exec>, C<system> allows you to lie to a program about its name if
4704 you use the C<system PROGRAM LIST> syntax.  Again, see L</exec>.
4705
4706 Because C<system> and backticks block C<SIGINT> and C<SIGQUIT>, killing the
4707 program they're running doesn't actually interrupt your program.
4708
4709     @args = ("command", "arg1", "arg2");
4710     system(@args) == 0
4711          or die "system @args failed: $?"
4712
4713 You can check all the failure possibilities by inspecting
4714 C<$?> like this:
4715
4716     $exit_value  = $? >> 8;
4717     $signal_num  = $? & 127;
4718     $dumped_core = $? & 128;
4719
4720 When the arguments get executed via the system shell, results
4721 and return codes will be subject to its quirks and capabilities.
4722 See L<perlop/"`STRING`"> and L</exec> for details.
4723
4724 =item syswrite FILEHANDLE,SCALAR,LENGTH,OFFSET
4725
4726 =item syswrite FILEHANDLE,SCALAR,LENGTH
4727
4728 =item syswrite FILEHANDLE,SCALAR
4729
4730 Attempts to write LENGTH bytes of data from variable SCALAR to the
4731 specified FILEHANDLE, using the system call write(2).  If LENGTH
4732 is not specified, writes whole SCALAR.  It bypasses stdio, so mixing
4733 this with reads (other than C<sysread())>, C<print>, C<write>,
4734 C<seek>, C<tell>, or C<eof> may cause confusion because stdio
4735 usually buffers data.  Returns the number of bytes actually written,
4736 or C<undef> if there was an error.  If the LENGTH is greater than
4737 the available data in the SCALAR after the OFFSET, only as much
4738 data as is available will be written.
4739
4740 An OFFSET may be specified to write the data from some part of the
4741 string other than the beginning.  A negative OFFSET specifies writing
4742 that many bytes counting backwards from the end of the string.  In the
4743 case the SCALAR is empty you can use OFFSET but only zero offset.
4744
4745 =item tell FILEHANDLE
4746
4747 =item tell
4748
4749 Returns the current position for FILEHANDLE.  FILEHANDLE may be an
4750 expression whose value gives the name of the actual filehandle.  If
4751 FILEHANDLE is omitted, assumes the file last read.  
4752
4753 There is no C<systell> function.  Use C<sysseek(FH, 0, 1)> for that.
4754
4755 =item telldir DIRHANDLE
4756
4757 Returns the current position of the C<readdir> routines on DIRHANDLE.
4758 Value may be given to C<seekdir> to access a particular location in a
4759 directory.  Has the same caveats about possible directory compaction as
4760 the corresponding system library routine.
4761
4762 =item tie VARIABLE,CLASSNAME,LIST
4763
4764 This function binds a variable to a package class that will provide the
4765 implementation for the variable.  VARIABLE is the name of the variable
4766 to be enchanted.  CLASSNAME is the name of a class implementing objects
4767 of correct type.  Any additional arguments are passed to the C<new>
4768 method of the class (meaning C<TIESCALAR>, C<TIEHANDLE>, C<TIEARRAY>,
4769 or C<TIEHASH>).  Typically these are arguments such as might be passed
4770 to the C<dbm_open()> function of C.  The object returned by the C<new>
4771 method is also returned by the C<tie> function, which would be useful
4772 if you want to access other methods in CLASSNAME.
4773
4774 Note that functions such as C<keys> and C<values> may return huge lists
4775 when used on large objects, like DBM files.  You may prefer to use the
4776 C<each> function to iterate over such.  Example:
4777
4778     # print out history file offsets
4779     use NDBM_File;
4780     tie(%HIST, 'NDBM_File', '/usr/lib/news/history', 1, 0);
4781     while (($key,$val) = each %HIST) {
4782         print $key, ' = ', unpack('L',$val), "\n";
4783     }
4784     untie(%HIST);
4785
4786 A class implementing a hash should have the following methods:
4787
4788     TIEHASH classname, LIST
4789     FETCH this, key
4790     STORE this, key, value
4791     DELETE this, key
4792     CLEAR this
4793     EXISTS this, key
4794     FIRSTKEY this
4795     NEXTKEY this, lastkey
4796     DESTROY this
4797
4798 A class implementing an ordinary array should have the following methods:
4799
4800     TIEARRAY classname, LIST
4801     FETCH this, key
4802     STORE this, key, value
4803     FETCHSIZE this
4804     STORESIZE this, count
4805     CLEAR this
4806     PUSH this, LIST
4807     POP this
4808     SHIFT this
4809     UNSHIFT this, LIST
4810     SPLICE this, offset, length, LIST
4811     EXTEND this, count
4812     DESTROY this
4813
4814 A class implementing a file handle should have the following methods:
4815
4816     TIEHANDLE classname, LIST
4817     READ this, scalar, length, offset
4818     READLINE this
4819     GETC this
4820     WRITE this, scalar, length, offset
4821     PRINT this, LIST
4822     PRINTF this, format, LIST
4823     CLOSE this
4824     DESTROY this
4825
4826 A class implementing a scalar should have the following methods:
4827
4828     TIESCALAR classname, LIST
4829     FETCH this,
4830     STORE this, value
4831     DESTROY this
4832
4833 Not all methods indicated above need be implemented.  See L<perltie>,
4834 L<Tie::Hash>, L<Tie::Array>, L<Tie::Scalar>, and L<Tie::Handle>.
4835
4836 Unlike C<dbmopen>, the C<tie> function will not use or require a module
4837 for you--you need to do that explicitly yourself.  See L<DB_File>
4838 or the F<Config> module for interesting C<tie> implementations.
4839
4840 For further details see L<perltie>, L<"tied VARIABLE">.
4841
4842 =item tied VARIABLE
4843
4844 Returns a reference to the object underlying VARIABLE (the same value
4845 that was originally returned by the C<tie> call that bound the variable
4846 to a package.)  Returns the undefined value if VARIABLE isn't tied to a
4847 package.
4848
4849 =item time
4850
4851 Returns the number of non-leap seconds since whatever time the system
4852 considers to be the epoch (that's 00:00:00, January 1, 1904 for MacOS,
4853 and 00:00:00 UTC, January 1, 1970 for most other systems).
4854 Suitable for feeding to C<gmtime> and C<localtime>.
4855
4856 For measuring time in better granularity than one second,
4857 you may use either the Time::HiRes module from CPAN, or
4858 if you have gettimeofday(2), you may be able to use the
4859 C<syscall> interface of Perl, see L<perlfaq8> for details.
4860
4861 =item times
4862
4863 Returns a four-element list giving the user and system times, in
4864 seconds, for this process and the children of this process.
4865
4866     ($user,$system,$cuser,$csystem) = times;
4867
4868 =item tr///
4869
4870 The transliteration operator.  Same as C<y///>.  See L<perlop>.
4871
4872 =item truncate FILEHANDLE,LENGTH
4873
4874 =item truncate EXPR,LENGTH
4875
4876 Truncates the file opened on FILEHANDLE, or named by EXPR, to the
4877 specified length.  Produces a fatal error if truncate isn't implemented
4878 on your system.  Returns true if successful, the undefined value
4879 otherwise.
4880
4881 =item uc EXPR
4882
4883 =item uc
4884
4885 Returns an uppercased version of EXPR.  This is the internal function
4886 implementing the C<\U> escape in double-quoted strings.
4887 Respects current LC_CTYPE locale if C<use locale> in force.  See L<perllocale>.
4888 Under Unicode (C<use utf8>) it uses the standard Unicode uppercase mappings.  (It
4889 does not attempt to do titlecase mapping on initial letters.  See C<ucfirst> for that.)
4890
4891 If EXPR is omitted, uses C<$_>.
4892
4893 =item ucfirst EXPR
4894
4895 =item ucfirst
4896
4897 Returns the value of EXPR with the first character
4898 in uppercase (titlecase in Unicode).  This is
4899 the internal function implementing the C<\u> escape in double-quoted strings.
4900 Respects current LC_CTYPE locale if C<use locale> in force.  See L<perllocale>
4901 and L<utf8>.
4902
4903 If EXPR is omitted, uses C<$_>.
4904
4905 =item umask EXPR
4906
4907 =item umask
4908
4909 Sets the umask for the process to EXPR and returns the previous value.
4910 If EXPR is omitted, merely returns the current umask.
4911
4912 The Unix permission C<rwxr-x---> is represented as three sets of three
4913 bits, or three octal digits: C<0750> (the leading 0 indicates octal
4914 and isn't one of the digits).  The C<umask> value is such a number
4915 representing disabled permissions bits.  The permission (or "mode")
4916 values you pass C<mkdir> or C<sysopen> are modified by your umask, so
4917 even if you tell C<sysopen> to create a file with permissions C<0777>,
4918 if your umask is C<0022> then the file will actually be created with
4919 permissions C<0755>.  If your C<umask> were C<0027> (group can't
4920 write; others can't read, write, or execute), then passing
4921 C<sysopen> C<0666> would create a file with mode C<0640> (C<0666 &~
4922 027> is C<0640>).
4923
4924 Here's some advice: supply a creation mode of C<0666> for regular
4925 files (in C<sysopen>) and one of C<0777> for directories (in
4926 C<mkdir>) and executable files.  This gives users the freedom of
4927 choice: if they want protected files, they might choose process umasks
4928 of C<022>, C<027>, or even the particularly antisocial mask of C<077>.
4929 Programs should rarely if ever make policy decisions better left to
4930 the user.  The exception to this is when writing files that should be
4931 kept private: mail files, web browser cookies, I<.rhosts> files, and
4932 so on.
4933
4934 If umask(2) is not implemented on your system and you are trying to
4935 restrict access for I<yourself> (i.e., (EXPR & 0700) > 0), produces a
4936 fatal error at run time.  If umask(2) is not implemented and you are
4937 not trying to restrict access for yourself, returns C<undef>.
4938
4939 Remember that a umask is a number, usually given in octal; it is I<not> a
4940 string of octal digits.  See also L</oct>, if all you have is a string.
4941
4942 =item undef EXPR
4943
4944 =item undef
4945
4946 Undefines the value of EXPR, which must be an lvalue.  Use only on a
4947 scalar value, an array (using C<@>), a hash (using C<%>), a subroutine
4948 (using C<&>), or a typeglob (using <*>).  (Saying C<undef $hash{$key}>
4949 will probably not do what you expect on most predefined variables or
4950 DBM list values, so don't do that; see L<delete>.)  Always returns the
4951 undefined value.  You can omit the EXPR, in which case nothing is
4952 undefined, but you still get an undefined value that you could, for
4953 instance, return from a subroutine, assign to a variable or pass as a
4954 parameter.  Examples:
4955
4956     undef $foo;
4957     undef $bar{'blurfl'};      # Compare to: delete $bar{'blurfl'};
4958     undef @ary;
4959     undef %hash;
4960     undef &mysub;
4961     undef *xyz;       # destroys $xyz, @xyz, %xyz, &xyz, etc.
4962     return (wantarray ? (undef, $errmsg) : undef) if $they_blew_it;
4963     select undef, undef, undef, 0.25;
4964     ($a, $b, undef, $c) = &foo;       # Ignore third value returned
4965
4966 Note that this is a unary operator, not a list operator.
4967
4968 =item unlink LIST
4969
4970 =item unlink
4971
4972 Deletes a list of files.  Returns the number of files successfully
4973 deleted.
4974
4975     $cnt = unlink 'a', 'b', 'c';
4976     unlink @goners;
4977     unlink <*.bak>;
4978
4979 Note: C<unlink> will not delete directories unless you are superuser and
4980 the B<-U> flag is supplied to Perl.  Even if these conditions are
4981 met, be warned that unlinking a directory can inflict damage on your
4982 filesystem.  Use C<rmdir> instead.
4983
4984 If LIST is omitted, uses C<$_>.
4985
4986 =item unpack TEMPLATE,EXPR
4987
4988 C<unpack> does the reverse of C<pack>: it takes a string
4989 and expands it out into a list of values.
4990 (In scalar context, it returns merely the first value produced.)
4991
4992 The string is broken into chunks described by the TEMPLATE.  Each chunk
4993 is converted separately to a value.  Typically, either the string is a result
4994 of C<pack>, or the bytes of the string represent a C structure of some
4995 kind.
4996
4997 The TEMPLATE has the same format as in the C<pack> function.
4998 Here's a subroutine that does substring:
4999
5000     sub substr {
5001         my($what,$where,$howmuch) = @_;
5002         unpack("x$where a$howmuch", $what);
5003     }
5004
5005 and then there's
5006
5007     sub ordinal { unpack("c",$_[0]); } # same as ord()
5008
5009 In addition to fields allowed in pack(), you may prefix a field with
5010 a %E<lt>numberE<gt> to indicate that
5011 you want a E<lt>numberE<gt>-bit checksum of the items instead of the items
5012 themselves.  Default is a 16-bit checksum.  Checksum is calculated by
5013 summing numeric values of expanded values (for string fields the sum of
5014 C<ord($char)> is taken, for bit fields the sum of zeroes and ones).
5015
5016 For example, the following
5017 computes the same number as the System V sum program:
5018
5019     $checksum = do {
5020         local $/;  # slurp!
5021         unpack("%32C*",<>) % 65535;
5022     };
5023
5024 The following efficiently counts the number of set bits in a bit vector:
5025
5026     $setbits = unpack("%32b*", $selectmask);
5027
5028 The C<p> and C<P> formats should be used with care.  Since Perl
5029 has no way of checking whether the value passed to C<unpack()>
5030 corresponds to a valid memory location, passing a pointer value that's
5031 not known to be valid is likely to have disastrous consequences.
5032
5033 If the repeat count of a field is larger than what the remainder of
5034 the input string allows, repeat count is decreased.  If the input string
5035 is longer than one described by the TEMPLATE, the rest is ignored. 
5036
5037 See L</pack> for more examples and notes.
5038
5039 =item untie VARIABLE
5040
5041 Breaks the binding between a variable and a package.  (See C<tie>.)
5042
5043 =item unshift ARRAY,LIST
5044
5045 Does the opposite of a C<shift>.  Or the opposite of a C<push>,
5046 depending on how you look at it.  Prepends list to the front of the
5047 array, and returns the new number of elements in the array.
5048
5049     unshift(ARGV, '-e') unless $ARGV[0] =~ /^-/;
5050
5051 Note the LIST is prepended whole, not one element at a time, so the
5052 prepended elements stay in the same order.  Use C<reverse> to do the
5053 reverse.
5054
5055 =item use Module LIST
5056
5057 =item use Module
5058
5059 =item use Module VERSION LIST
5060
5061 =item use VERSION
5062
5063 Imports some semantics into the current package from the named module,
5064 generally by aliasing certain subroutine or variable names into your
5065 package.  It is exactly equivalent to
5066
5067     BEGIN { require Module; import Module LIST; }
5068
5069 except that Module I<must> be a bareword.
5070
5071 If the first argument to C<use> is a number, it is treated as a version
5072 number instead of a module name.  If the version of the Perl interpreter
5073 is less than VERSION, then an error message is printed and Perl exits
5074 immediately.  This is often useful if you need to check the current
5075 Perl version before C<use>ing library modules that have changed in
5076 incompatible ways from older versions of Perl.  (We try not to do
5077 this more than we have to.)
5078
5079 The C<BEGIN> forces the C<require> and C<import> to happen at compile time.  The
5080 C<require> makes sure the module is loaded into memory if it hasn't been
5081 yet.  The C<import> is not a builtin--it's just an ordinary static method
5082 call into the C<Module> package to tell the module to import the list of
5083 features back into the current package.  The module can implement its
5084 C<import> method any way it likes, though most modules just choose to
5085 derive their C<import> method via inheritance from the C<Exporter> class that
5086 is defined in the C<Exporter> module.  See L<Exporter>.  If no C<import>
5087 method can be found then the error is currently silently ignored.  This
5088 may change to a fatal error in a future version.
5089
5090 If you don't want your namespace altered, explicitly supply an empty list:
5091
5092     use Module ();
5093
5094 That is exactly equivalent to
5095
5096     BEGIN { require Module }
5097
5098 If the VERSION argument is present between Module and LIST, then the
5099 C<use> will call the VERSION method in class Module with the given
5100 version as an argument.  The default VERSION method, inherited from
5101 the Universal class, croaks if the given version is larger than the
5102 value of the variable C<$Module::VERSION>.  (Note that there is not a
5103 comma after VERSION!)
5104
5105 Because this is a wide-open interface, pragmas (compiler directives)
5106 are also implemented this way.  Currently implemented pragmas are:
5107
5108     use integer;
5109     use diagnostics;
5110     use sigtrap  qw(SEGV BUS);
5111     use strict   qw(subs vars refs);
5112     use subs     qw(afunc blurfl);
5113     use warnings qw(all);
5114
5115 Some of these pseudo-modules import semantics into the current
5116 block scope (like C<strict> or C<integer>, unlike ordinary modules,
5117 which import symbols into the current package (which are effective
5118 through the end of the file).
5119
5120 There's a corresponding C<no> command that unimports meanings imported
5121 by C<use>, i.e., it calls C<unimport Module LIST> instead of C<import>.
5122
5123     no integer;
5124     no strict 'refs';
5125     no warnings;
5126
5127 If no C<unimport> method can be found the call fails with a fatal error.
5128
5129 See L<perlmod> for a list of standard modules and pragmas.
5130
5131 =item utime LIST
5132
5133 Changes the access and modification times on each file of a list of
5134 files.  The first two elements of the list must be the NUMERICAL access
5135 and modification times, in that order.  Returns the number of files
5136 successfully changed.  The inode change time of each file is set
5137 to the current time.  This code has the same effect as the C<touch>
5138 command if the files already exist:
5139
5140     #!/usr/bin/perl
5141     $now = time;
5142     utime $now, $now, @ARGV;
5143
5144 =item values HASH
5145
5146 Returns a list consisting of all the values of the named hash.  (In a
5147 scalar context, returns the number of values.)  The values are
5148 returned in an apparently random order.  The actual random order is
5149 subject to change in future versions of perl, but it is guaranteed to
5150 be the same order as either the C<keys> or C<each> function would
5151 produce on the same (unmodified) hash.
5152
5153 Note that you cannot modify the values of a hash this way, because the
5154 returned list is just a copy.  You need to use a hash slice for that, 
5155 since it's lvaluable in a way that values() is not.
5156
5157     for (values %hash)      { s/foo/bar/g }   # FAILS!
5158     for (@hash{keys %hash}) { s/foo/bar/g }   # ok
5159
5160 As a side effect, calling values() resets the HASH's internal iterator.
5161 See also C<keys>, C<each>, and C<sort>.
5162
5163 =item vec EXPR,OFFSET,BITS
5164
5165 Treats the string in EXPR as a bit vector made up of elements of
5166 width BITS, and returns the value of the element specified by OFFSET
5167 as an unsigned integer.  BITS therefore specifies the number of bits
5168 that are reserved for each element in the bit vector.  This must
5169 be a power of two from 1 to 32 (or 64, if your platform supports
5170 that).
5171
5172 If BITS is 8, "elements" coincide with bytes of the input string.  
5173
5174 If BITS is 16 or more, bytes of the input string are grouped into chunks
5175 of size BITS/8, and each group is converted to a number as with
5176 pack()/unpack() with big-endian formats C<n>/C<N> (and analoguously
5177 for BITS==64).  See L<"pack"> for details.
5178
5179 If bits is 4 or less, the string is broken into bytes, then the bits
5180 of each byte are broken into 8/BITS groups.  Bits of a byte are
5181 numbered in a little-endian-ish way, as in C<0x01>, C<0x02>,
5182 C<0x04>, C<0x08>, C<0x10>, C<0x20>, C<0x40>, C<0x80>.  For example,
5183 breaking the single input byte C<chr(0x36)> into two groups gives a list
5184 C<(0x6, 0x3)>; breaking it into 4 groups gives C<(0x2, 0x1, 0x3, 0x0)>.
5185
5186 C<vec> may also be assigned to, in which case parentheses are needed
5187 to give the expression the correct precedence as in
5188
5189     vec($image, $max_x * $x + $y, 8) = 3;
5190
5191 Vectors created with C<vec> can also be manipulated with the logical
5192 operators C<|>, C<&>, and C<^>, which will assume a bit vector
5193 operation is desired when both operands are strings.
5194 See L<perlop/"Bitwise String Operators">.
5195
5196 The following code will build up an ASCII string saying C<'PerlPerlPerl'>.
5197 The comments show the string after each step.  Note that this code works
5198 in the same way on big-endian or little-endian machines.
5199
5200     my $foo = '';
5201     vec($foo,  0, 32) = 0x5065726C;     # 'Perl'
5202
5203     # $foo eq "Perl" eq "\x50\x65\x72\x6C", 32 bits
5204     print vec($foo, 0, 8);              # prints 80 == 0x50 == ord('P')
5205
5206     vec($foo,  2, 16) = 0x5065;         # 'PerlPe'
5207     vec($foo,  3, 16) = 0x726C;         # 'PerlPerl'
5208     vec($foo,  8,  8) = 0x50;           # 'PerlPerlP'
5209     vec($foo,  9,  8) = 0x65;           # 'PerlPerlPe'
5210     vec($foo, 20,  4) = 2;              # 'PerlPerlPe'   . "\x02"
5211     vec($foo, 21,  4) = 7;              # 'PerlPerlPer'
5212                                         # 'r' is "\x72"
5213     vec($foo, 45,  2) = 3;              # 'PerlPerlPer'  . "\x0c"
5214     vec($foo, 93,  1) = 1;              # 'PerlPerlPer'  . "\x2c"
5215     vec($foo, 94,  1) = 1;              # 'PerlPerlPerl'
5216                                         # 'l' is "\x6c"
5217
5218 To transform a bit vector into a string or list of 0's and 1's, use these:
5219
5220     $bits = unpack("b*", $vector);
5221     @bits = split(//, unpack("b*", $vector));
5222
5223 If you know the exact length in bits, it can be used in place of the C<*>.
5224
5225 Here is an example to illustrate how the bits actually fall in place:
5226
5227     #!/usr/bin/perl -wl
5228
5229     print <<'EOT';
5230                                       0         1         2         3  
5231                        unpack("V",$_) 01234567890123456789012345678901
5232     ------------------------------------------------------------------
5233     EOT
5234
5235     for $w (0..3) {
5236         $width = 2**$w;
5237         for ($shift=0; $shift < $width; ++$shift) {
5238             for ($off=0; $off < 32/$width; ++$off) {
5239                 $str = pack("B*", "0"x32);
5240                 $bits = (1<<$shift);
5241                 vec($str, $off, $width) = $bits;
5242                 $res = unpack("b*",$str);
5243                 $val = unpack("V", $str);
5244                 write;
5245             }
5246         }
5247     }
5248
5249     format STDOUT =
5250     vec($_,@#,@#) = @<< == @######### @>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
5251     $off, $width, $bits, $val, $res
5252     .
5253     __END__
5254
5255 Regardless of the machine architecture on which it is run, the above
5256 example should print the following table:
5257
5258                                       0         1         2         3  
5259                        unpack("V",$_) 01234567890123456789012345678901
5260     ------------------------------------------------------------------
5261     vec($_, 0, 1) = 1   ==          1 10000000000000000000000000000000
5262     vec($_, 1, 1) = 1   ==          2 01000000000000000000000000000000
5263     vec($_, 2, 1) = 1   ==          4 00100000000000000000000000000000
5264     vec($_, 3, 1) = 1   ==          8 00010000000000000000000000000000
5265     vec($_, 4, 1) = 1   ==         16 00001000000000000000000000000000
5266     vec($_, 5, 1) = 1   ==         32 00000100000000000000000000000000
5267     vec($_, 6, 1) = 1   ==         64 00000010000000000000000000000000
5268     vec($_, 7, 1) = 1   ==        128 00000001000000000000000000000000
5269     vec($_, 8, 1) = 1   ==        256 00000000100000000000000000000000
5270     vec($_, 9, 1) = 1   ==        512 00000000010000000000000000000000
5271     vec($_,10, 1) = 1   ==       1024 00000000001000000000000000000000
5272     vec($_,11, 1) = 1   ==       2048 00000000000100000000000000000000
5273     vec($_,12, 1) = 1   ==       4096 00000000000010000000000000000000
5274     vec($_,13, 1) = 1   ==       8192 00000000000001000000000000000000
5275     vec($_,14, 1) = 1   ==      16384 00000000000000100000000000000000
5276     vec($_,15, 1) = 1   ==      32768 00000000000000010000000000000000
5277     vec($_,16, 1) = 1   ==      65536 00000000000000001000000000000000
5278     vec($_,17, 1) = 1   ==     131072 00000000000000000100000000000000
5279     vec($_,18, 1) = 1   ==     262144 00000000000000000010000000000000
5280     vec($_,19, 1) = 1   ==     524288 00000000000000000001000000000000
5281     vec($_,20, 1) = 1   ==    1048576 00000000000000000000100000000000
5282     vec($_,21, 1) = 1   ==    2097152 00000000000000000000010000000000
5283     vec($_,22, 1) = 1   ==    4194304 00000000000000000000001000000000
5284     vec($_,23, 1) = 1   ==    8388608 00000000000000000000000100000000
5285     vec($_,24, 1) = 1   ==   16777216 00000000000000000000000010000000
5286     vec($_,25, 1) = 1   ==   33554432 00000000000000000000000001000000
5287     vec($_,26, 1) = 1   ==   67108864 00000000000000000000000000100000
5288     vec($_,27, 1) = 1   ==  134217728 00000000000000000000000000010000
5289     vec($_,28, 1) = 1   ==  268435456 00000000000000000000000000001000
5290     vec($_,29, 1) = 1   ==  536870912 00000000000000000000000000000100
5291     vec($_,30, 1) = 1   == 1073741824 00000000000000000000000000000010
5292     vec($_,31, 1) = 1   == 2147483648 00000000000000000000000000000001
5293     vec($_, 0, 2) = 1   ==          1 10000000000000000000000000000000
5294     vec($_, 1, 2) = 1   ==          4 00100000000000000000000000000000
5295     vec($_, 2, 2) = 1   ==         16 00001000000000000000000000000000
5296     vec($_, 3, 2) = 1   ==         64 00000010000000000000000000000000
5297     vec($_, 4, 2) = 1   ==        256 00000000100000000000000000000000
5298     vec($_, 5, 2) = 1   ==       1024 00000000001000000000000000000000
5299     vec($_, 6, 2) = 1   ==       4096 00000000000010000000000000000000
5300     vec($_, 7, 2) = 1   ==      16384 00000000000000100000000000000000
5301     vec($_, 8, 2) = 1   ==      65536 00000000000000001000000000000000
5302     vec($_, 9, 2) = 1   ==     262144 00000000000000000010000000000000
5303     vec($_,10, 2) = 1   ==    1048576 00000000000000000000100000000000
5304     vec($_,11, 2) = 1   ==    4194304 00000000000000000000001000000000
5305     vec($_,12, 2) = 1   ==   16777216 00000000000000000000000010000000
5306     vec($_,13, 2) = 1   ==   67108864 00000000000000000000000000100000
5307     vec($_,14, 2) = 1   ==  268435456 00000000000000000000000000001000
5308     vec($_,15, 2) = 1   == 1073741824 00000000000000000000000000000010
5309     vec($_, 0, 2) = 2   ==          2 01000000000000000000000000000000
5310     vec($_, 1, 2) = 2   ==          8 00010000000000000000000000000000
5311     vec($_, 2, 2) = 2   ==         32 00000100000000000000000000000000
5312     vec($_, 3, 2) = 2   ==        128 00000001000000000000000000000000
5313     vec($_, 4, 2) = 2   ==        512 00000000010000000000000000000000
5314     vec($_, 5, 2) = 2   ==       2048 00000000000100000000000000000000
5315     vec($_, 6, 2) = 2   ==       8192 00000000000001000000000000000000
5316     vec($_, 7, 2) = 2   ==      32768 00000000000000010000000000000000
5317     vec($_, 8, 2) = 2   ==     131072 00000000000000000100000000000000
5318     vec($_, 9, 2) = 2   ==     524288 00000000000000000001000000000000
5319     vec($_,10, 2) = 2   ==    2097152 00000000000000000000010000000000
5320     vec($_,11, 2) = 2   ==    8388608 00000000000000000000000100000000
5321     vec($_,12, 2) = 2   ==   33554432 00000000000000000000000001000000
5322     vec($_,13, 2) = 2   ==  134217728 00000000000000000000000000010000
5323     vec($_,14, 2) = 2   ==  536870912 00000000000000000000000000000100
5324     vec($_,15, 2) = 2   == 2147483648 00000000000000000000000000000001
5325     vec($_, 0, 4) = 1   ==          1 10000000000000000000000000000000
5326     vec($_, 1, 4) = 1   ==         16 00001000000000000000000000000000
5327     vec($_, 2, 4) = 1   ==        256 00000000100000000000000000000000
5328     vec($_, 3, 4) = 1   ==       4096 00000000000010000000000000000000
5329     vec($_, 4, 4) = 1   ==      65536 00000000000000001000000000000000
5330     vec($_, 5, 4) = 1   ==    1048576 00000000000000000000100000000000
5331     vec($_, 6, 4) = 1   ==   16777216 00000000000000000000000010000000
5332     vec($_, 7, 4) = 1   ==  268435456 00000000000000000000000000001000
5333     vec($_, 0, 4) = 2   ==          2 01000000000000000000000000000000
5334     vec($_, 1, 4) = 2   ==         32 00000100000000000000000000000000
5335     vec($_, 2, 4) = 2   ==        512 00000000010000000000000000000000
5336     vec($_, 3, 4) = 2   ==       8192 00000000000001000000000000000000
5337     vec($_, 4, 4) = 2   ==     131072 00000000000000000100000000000000
5338     vec($_, 5, 4) = 2   ==    2097152 00000000000000000000010000000000
5339     vec($_, 6, 4) = 2   ==   33554432 00000000000000000000000001000000
5340     vec($_, 7, 4) = 2   ==  536870912 00000000000000000000000000000100
5341     vec($_, 0, 4) = 4   ==          4 00100000000000000000000000000000
5342     vec($_, 1, 4) = 4   ==         64 00000010000000000000000000000000
5343     vec($_, 2, 4) = 4   ==       1024 00000000001000000000000000000000
5344     vec($_, 3, 4) = 4   ==      16384 00000000000000100000000000000000
5345     vec($_, 4, 4) = 4   ==     262144 00000000000000000010000000000000
5346     vec($_, 5, 4) = 4   ==    4194304 00000000000000000000001000000000
5347     vec($_, 6, 4) = 4   ==   67108864 00000000000000000000000000100000
5348     vec($_, 7, 4) = 4   == 1073741824 00000000000000000000000000000010
5349     vec($_, 0, 4) = 8   ==          8 00010000000000000000000000000000
5350     vec($_, 1, 4) = 8   ==        128 00000001000000000000000000000000
5351     vec($_, 2, 4) = 8   ==       2048 00000000000100000000000000000000
5352     vec($_, 3, 4) = 8   ==      32768 00000000000000010000000000000000
5353     vec($_, 4, 4) = 8   ==     524288 00000000000000000001000000000000
5354     vec($_, 5, 4) = 8   ==    8388608 00000000000000000000000100000000
5355     vec($_, 6, 4) = 8   ==  134217728 00000000000000000000000000010000
5356     vec($_, 7, 4) = 8   == 2147483648 00000000000000000000000000000001
5357     vec($_, 0, 8) = 1   ==          1 10000000000000000000000000000000
5358     vec($_, 1, 8) = 1   ==        256 00000000100000000000000000000000
5359     vec($_, 2, 8) = 1   ==      65536 00000000000000001000000000000000
5360     vec($_, 3, 8) = 1   ==   16777216 00000000000000000000000010000000
5361     vec($_, 0, 8) = 2   ==          2 01000000000000000000000000000000
5362     vec($_, 1, 8) = 2   ==        512 00000000010000000000000000000000
5363     vec($_, 2, 8) = 2   ==     131072 00000000000000000100000000000000
5364     vec($_, 3, 8) = 2   ==   33554432 00000000000000000000000001000000
5365     vec($_, 0, 8) = 4   ==          4 00100000000000000000000000000000
5366     vec($_, 1, 8) = 4   ==       1024 00000000001000000000000000000000
5367     vec($_, 2, 8) = 4   ==     262144 00000000000000000010000000000000
5368     vec($_, 3, 8) = 4   ==   67108864 00000000000000000000000000100000
5369     vec($_, 0, 8) = 8   ==          8 00010000000000000000000000000000
5370     vec($_, 1, 8) = 8   ==       2048 00000000000100000000000000000000
5371     vec($_, 2, 8) = 8   ==     524288 00000000000000000001000000000000
5372     vec($_, 3, 8) = 8   ==  134217728 00000000000000000000000000010000
5373     vec($_, 0, 8) = 16  ==         16 00001000000000000000000000000000
5374     vec($_, 1, 8) = 16  ==       4096 00000000000010000000000000000000
5375     vec($_, 2, 8) = 16  ==    1048576 00000000000000000000100000000000
5376     vec($_, 3, 8) = 16  ==  268435456 00000000000000000000000000001000
5377     vec($_, 0, 8) = 32  ==         32 00000100000000000000000000000000
5378     vec($_, 1, 8) = 32  ==       8192 00000000000001000000000000000000
5379     vec($_, 2, 8) = 32  ==    2097152 00000000000000000000010000000000
5380     vec($_, 3, 8) = 32  ==  536870912 00000000000000000000000000000100
5381     vec($_, 0, 8) = 64  ==         64 00000010000000000000000000000000
5382     vec($_, 1, 8) = 64  ==      16384 00000000000000100000000000000000
5383     vec($_, 2, 8) = 64  ==    4194304 00000000000000000000001000000000
5384     vec($_, 3, 8) = 64  == 1073741824 00000000000000000000000000000010
5385     vec($_, 0, 8) = 128 ==        128 00000001000000000000000000000000
5386     vec($_, 1, 8) = 128 ==      32768 00000000000000010000000000000000
5387     vec($_, 2, 8) = 128 ==    8388608 00000000000000000000000100000000
5388     vec($_, 3, 8) = 128 == 2147483648 00000000000000000000000000000001
5389
5390 =item wait
5391
5392 Behaves like the wait(2) system call on your system: it waits for a child
5393 process to terminate and returns the pid of the deceased process, or
5394 C<-1> if there are no child processes.  The status is returned in C<$?>.
5395 Note that a return value of C<-1> could mean that child processes are
5396 being automatically reaped, as described in L<perlipc>.
5397
5398 =item waitpid PID,FLAGS
5399
5400 Waits for a particular child process to terminate and returns the pid of
5401 the deceased process, or C<-1> if there is no such child process.  On some
5402 systems, a value of 0 indicates that there are processes still running.
5403 The status is returned in C<$?>.  If you say
5404
5405     use POSIX ":sys_wait_h";
5406     #...
5407     do { 
5408         $kid = waitpid(-1,&WNOHANG);
5409     } until $kid == -1;
5410
5411 then you can do a non-blocking wait for all pending zombie processes.
5412 Non-blocking wait is available on machines supporting either the
5413 waitpid(2) or wait4(2) system calls.  However, waiting for a particular
5414 pid with FLAGS of C<0> is implemented everywhere.  (Perl emulates the
5415 system call by remembering the status values of processes that have
5416 exited but have not been harvested by the Perl script yet.)
5417
5418 Note that on some systems, a return value of C<-1> could mean that child
5419 processes are being automatically reaped.  See L<perlipc> for details,
5420 and for other examples.
5421
5422 =item wantarray
5423
5424 Returns true if the context of the currently executing subroutine is
5425 looking for a list value.  Returns false if the context is looking
5426 for a scalar.  Returns the undefined value if the context is looking
5427 for no value (void context).
5428
5429     return unless defined wantarray;    # don't bother doing more
5430     my @a = complex_calculation();
5431     return wantarray ? @a : "@a";
5432
5433 This function should have been named wantlist() instead.
5434
5435 =item warn LIST
5436
5437 Produces a message on STDERR just like C<die>, but doesn't exit or throw
5438 an exception.
5439
5440 If LIST is empty and C<$@> already contains a value (typically from a
5441 previous eval) that value is used after appending C<"\t...caught">
5442 to C<$@>.  This is useful for staying almost, but not entirely similar to
5443 C<die>.
5444
5445 If C<$@> is empty then the string C<"Warning: Something's wrong"> is used.
5446
5447 No message is printed if there is a C<$SIG{__WARN__}> handler
5448 installed.  It is the handler's responsibility to deal with the message
5449 as it sees fit (like, for instance, converting it into a C<die>).  Most
5450 handlers must therefore make arrangements to actually display the
5451 warnings that they are not prepared to deal with, by calling C<warn>
5452 again in the handler.  Note that this is quite safe and will not
5453 produce an endless loop, since C<__WARN__> hooks are not called from
5454 inside one.
5455
5456 You will find this behavior is slightly different from that of
5457 C<$SIG{__DIE__}> handlers (which don't suppress the error text, but can
5458 instead call C<die> again to change it).
5459
5460 Using a C<__WARN__> handler provides a powerful way to silence all
5461 warnings (even the so-called mandatory ones).  An example:
5462
5463     # wipe out *all* compile-time warnings
5464     BEGIN { $SIG{'__WARN__'} = sub { warn $_[0] if $DOWARN } }
5465     my $foo = 10;
5466     my $foo = 20;          # no warning about duplicate my $foo,
5467                            # but hey, you asked for it!
5468     # no compile-time or run-time warnings before here
5469     $DOWARN = 1;
5470
5471     # run-time warnings enabled after here
5472     warn "\$foo is alive and $foo!";     # does show up
5473
5474 See L<perlvar> for details on setting C<%SIG> entries, and for more
5475 examples.  See the Carp module for other kinds of warnings using its
5476 carp() and cluck() functions.
5477
5478 =item write FILEHANDLE
5479
5480 =item write EXPR
5481
5482 =item write
5483
5484 Writes a formatted record (possibly multi-line) to the specified FILEHANDLE,
5485 using the format associated with that file.  By default the format for
5486 a file is the one having the same name as the filehandle, but the
5487 format for the current output channel (see the C<select> function) may be set
5488 explicitly by assigning the name of the format to the C<$~> variable.
5489
5490 Top of form processing is handled automatically:  if there is
5491 insufficient room on the current page for the formatted record, the
5492 page is advanced by writing a form feed, a special top-of-page format
5493 is used to format the new page header, and then the record is written.
5494 By default the top-of-page format is the name of the filehandle with
5495 "_TOP" appended, but it may be dynamically set to the format of your
5496 choice by assigning the name to the C<$^> variable while the filehandle is
5497 selected.  The number of lines remaining on the current page is in
5498 variable C<$->, which can be set to C<0> to force a new page.
5499
5500 If FILEHANDLE is unspecified, output goes to the current default output
5501 channel, which starts out as STDOUT but may be changed by the
5502 C<select> operator.  If the FILEHANDLE is an EXPR, then the expression
5503 is evaluated and the resulting string is used to look up the name of
5504 the FILEHANDLE at run time.  For more on formats, see L<perlform>.
5505
5506 Note that write is I<not> the opposite of C<read>.  Unfortunately.
5507
5508 =item y///
5509
5510 The transliteration operator.  Same as C<tr///>.  See L<perlop>.
5511
5512 =back