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