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