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