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