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