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