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