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