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