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