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