3 perlfunc - Perl builtin functions
7 The functions in this section can serve as terms in an expression.
8 They fall into two major categories: list operators and named unary
9 operators. These differ in their precedence relationship with a
10 following comma. (See the precedence table in L<perlop>.) List
11 operators take more than one argument, while unary operators can never
12 take more than one argument. Thus, a comma terminates the argument of
13 a unary operator, but merely separates the arguments of a list
14 operator. A unary operator generally provides a scalar context to its
15 argument, while a list operator may provide either scalar or list
16 contexts for its arguments. If it does both, the scalar arguments will
17 be first, and the list argument will follow. (Note that there can ever
18 be only one such list argument.) For instance, splice() has three scalar
19 arguments followed by a list, whereas gethostbyname() has four scalar
22 In the syntax descriptions that follow, list operators that expect a
23 list (and provide list context for the elements of the list) are shown
24 with LIST as an argument. Such a list may consist of any combination
25 of scalar arguments or list values; the list values will be included
26 in the list as if each individual element were interpolated at that
27 point in the list, forming a longer single-dimensional list value.
28 Elements of the LIST should be separated by commas.
30 Any function in the list below may be used either with or without
31 parentheses around its arguments. (The syntax descriptions omit the
32 parentheses.) If you use the parentheses, the simple (but occasionally
33 surprising) rule is this: It I<looks> like a function, therefore it I<is> a
34 function, and precedence doesn't matter. Otherwise it's a list
35 operator or unary operator, and precedence does matter. And whitespace
36 between the function and left parenthesis doesn't count--so you need to
39 print 1+2+4; # Prints 7.
40 print(1+2) + 4; # Prints 3.
41 print (1+2)+4; # Also prints 3!
42 print +(1+2)+4; # Prints 7.
43 print ((1+2)+4); # Prints 7.
45 If you run Perl with the B<-w> switch it can warn you about this. For
46 example, the third line above produces:
48 print (...) interpreted as function at - line 1.
49 Useless use of integer addition in void context at - line 1.
51 A few functions take no arguments at all, and therefore work as neither
52 unary nor list operators. These include such functions as C<time>
53 and C<endpwent>. For example, C<time+86_400> always means
56 For functions that can be used in either a scalar or list context,
57 nonabortive failure is generally indicated in a scalar context by
58 returning the undefined value, and in a list context by returning the
61 Remember the following important rule: There is B<no rule> that relates
62 the behavior of an expression in list context to its behavior in scalar
63 context, or vice versa. It might do two totally different things.
64 Each operator and function decides which sort of value it would be most
65 appropriate to return in scalar context. Some operators return the
66 length of the list that would have been returned in list context. Some
67 operators return the first value in the list. Some operators return the
68 last value in the list. Some operators return a count of successful
69 operations. In general, they do what you want, unless you want
72 An named array in scalar context is quite different from what would at
73 first glance appear to be a list in scalar context. You can't get a list
74 like C<(1,2,3)> into being in scalar context, because the compiler knows
75 the context at compile time. It would generate the scalar comma operator
76 there, not the list construction version of the comma. That means it
77 was never a list to start with.
79 In general, functions in Perl that serve as wrappers for system calls
80 of the same name (like chown(2), fork(2), closedir(2), etc.) all return
81 true when they succeed and C<undef> otherwise, as is usually mentioned
82 in the descriptions below. This is different from the C interfaces,
83 which return C<-1> on failure. Exceptions to this rule are C<wait>,
84 C<waitpid>, and C<syscall>. System calls also set the special C<$!>
85 variable on failure. Other functions do not, except accidentally.
87 =head2 Perl Functions by Category
89 Here are Perl's functions (including things that look like
90 functions, like some keywords and named operators)
91 arranged by category. Some functions appear in more
96 =item Functions for SCALARs or strings
98 C<chomp>, C<chop>, C<chr>, C<crypt>, C<hex>, C<index>, C<lc>, C<lcfirst>,
99 C<length>, C<oct>, C<ord>, C<pack>, C<q/STRING/>, C<qq/STRING/>, C<reverse>,
100 C<rindex>, C<sprintf>, C<substr>, C<tr///>, C<uc>, C<ucfirst>, C<y///>
102 =item Regular expressions and pattern matching
104 C<m//>, C<pos>, C<quotemeta>, C<s///>, C<split>, C<study>, C<qr//>
106 =item Numeric functions
108 C<abs>, C<atan2>, C<cos>, C<exp>, C<hex>, C<int>, C<log>, C<oct>, C<rand>,
109 C<sin>, C<sqrt>, C<srand>
111 =item Functions for real @ARRAYs
113 C<pop>, C<push>, C<shift>, C<splice>, C<unshift>
115 =item Functions for list data
117 C<grep>, C<join>, C<map>, C<qw/STRING/>, C<reverse>, C<sort>, C<unpack>
119 =item Functions for real %HASHes
121 C<delete>, C<each>, C<exists>, C<keys>, C<values>
123 =item Input and output functions
125 C<binmode>, C<close>, C<closedir>, C<dbmclose>, C<dbmopen>, C<die>, C<eof>,
126 C<fileno>, C<flock>, C<format>, C<getc>, C<print>, C<printf>, C<read>,
127 C<readdir>, C<rewinddir>, C<seek>, C<seekdir>, C<select>, C<syscall>,
128 C<sysread>, C<sysseek>, C<syswrite>, C<tell>, C<telldir>, C<truncate>,
131 =item Functions for fixed length data or records
133 C<pack>, C<read>, C<syscall>, C<sysread>, C<syswrite>, C<unpack>, C<vec>
135 =item Functions for filehandles, files, or directories
137 C<-I<X>>, C<chdir>, C<chmod>, C<chown>, C<chroot>, C<fcntl>, C<glob>,
138 C<ioctl>, C<link>, C<lstat>, C<mkdir>, C<open>, C<opendir>,
139 C<readlink>, C<rename>, C<rmdir>, C<stat>, C<symlink>, C<umask>,
142 =item Keywords related to the control flow of your perl program
144 C<caller>, C<continue>, C<die>, C<do>, C<dump>, C<eval>, C<exit>,
145 C<goto>, C<last>, C<next>, C<redo>, C<return>, C<sub>, C<wantarray>
147 =item Keywords related to scoping
149 C<caller>, C<import>, C<local>, C<my>, C<package>, C<use>
151 =item Miscellaneous functions
153 C<defined>, C<dump>, C<eval>, C<formline>, C<local>, C<my>, C<reset>,
154 C<scalar>, C<undef>, C<wantarray>
156 =item Functions for processes and process groups
158 C<alarm>, C<exec>, C<fork>, C<getpgrp>, C<getppid>, C<getpriority>, C<kill>,
159 C<pipe>, C<qx/STRING/>, C<setpgrp>, C<setpriority>, C<sleep>, C<system>,
160 C<times>, C<wait>, C<waitpid>
162 =item Keywords related to perl modules
164 C<do>, C<import>, C<no>, C<package>, C<require>, C<use>
166 =item Keywords related to classes and object-orientedness
168 C<bless>, C<dbmclose>, C<dbmopen>, C<package>, C<ref>, C<tie>, C<tied>,
171 =item Low-level socket functions
173 C<accept>, C<bind>, C<connect>, C<getpeername>, C<getsockname>,
174 C<getsockopt>, C<listen>, C<recv>, C<send>, C<setsockopt>, C<shutdown>,
175 C<socket>, C<socketpair>
177 =item System V interprocess communication functions
179 C<msgctl>, C<msgget>, C<msgrcv>, C<msgsnd>, C<semctl>, C<semget>, C<semop>,
180 C<shmctl>, C<shmget>, C<shmread>, C<shmwrite>
182 =item Fetching user and group info
184 C<endgrent>, C<endhostent>, C<endnetent>, C<endpwent>, C<getgrent>,
185 C<getgrgid>, C<getgrnam>, C<getlogin>, C<getpwent>, C<getpwnam>,
186 C<getpwuid>, C<setgrent>, C<setpwent>
188 =item Fetching network info
190 C<endprotoent>, C<endservent>, C<gethostbyaddr>, C<gethostbyname>,
191 C<gethostent>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>,
192 C<getprotobyname>, C<getprotobynumber>, C<getprotoent>,
193 C<getservbyname>, C<getservbyport>, C<getservent>, C<sethostent>,
194 C<setnetent>, C<setprotoent>, C<setservent>
196 =item Time-related functions
198 C<gmtime>, C<localtime>, C<time>, C<times>
200 =item Functions new in perl5
202 C<abs>, C<bless>, C<chomp>, C<chr>, C<exists>, C<formline>, C<glob>,
203 C<import>, C<lc>, C<lcfirst>, C<map>, C<my>, C<no>, C<prototype>, C<qx>,
204 C<qw>, C<readline>, C<readpipe>, C<ref>, C<sub*>, C<sysopen>, C<tie>,
205 C<tied>, C<uc>, C<ucfirst>, C<untie>, C<use>
207 * - C<sub> was a keyword in perl4, but in perl5 it is an
208 operator, which can be used in expressions.
210 =item Functions obsoleted in perl5
212 C<dbmclose>, C<dbmopen>
218 Perl was born in Unix and can therefore access all common Unix
219 system calls. In non-Unix environments, the functionality of some
220 Unix system calls may not be available, or details of the available
221 functionality may differ slightly. The Perl functions affected
224 C<-X>, C<binmode>, C<chmod>, C<chown>, C<chroot>, C<crypt>,
225 C<dbmclose>, C<dbmopen>, C<dump>, C<endgrent>, C<endhostent>,
226 C<endnetent>, C<endprotoent>, C<endpwent>, C<endservent>, C<exec>,
227 C<fcntl>, C<flock>, C<fork>, C<getgrent>, C<getgrgid>, C<gethostent>,
228 C<getlogin>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>,
229 C<getppid>, C<getprgp>, C<getpriority>, C<getprotobynumber>,
230 C<getprotoent>, C<getpwent>, C<getpwnam>, C<getpwuid>,
231 C<getservbyport>, C<getservent>, C<getsockopt>, C<glob>, C<ioctl>,
232 C<kill>, C<link>, C<lstat>, C<msgctl>, C<msgget>, C<msgrcv>,
233 C<msgsnd>, C<open>, C<pipe>, C<readlink>, C<rename>, C<select>, C<semctl>,
234 C<semget>, C<semop>, C<setgrent>, C<sethostent>, C<setnetent>,
235 C<setpgrp>, C<setpriority>, C<setprotoent>, C<setpwent>,
236 C<setservent>, C<setsockopt>, C<shmctl>, C<shmget>, C<shmread>,
237 C<shmwrite>, C<socket>, C<socketpair>, C<stat>, C<symlink>, C<syscall>,
238 C<sysopen>, C<system>, C<times>, C<truncate>, C<umask>, C<unlink>,
239 C<utime>, C<wait>, C<waitpid>
241 For more information about the portability of these functions, see
242 L<perlport> and other available platform-specific documentation.
244 =head2 Alphabetical Listing of Perl Functions
248 =item I<-X> FILEHANDLE
254 A file test, where X is one of the letters listed below. This unary
255 operator takes one argument, either a filename or a filehandle, and
256 tests the associated file to see if something is true about it. If the
257 argument is omitted, tests C<$_>, except for C<-t>, which tests STDIN.
258 Unless otherwise documented, it returns C<1> for true and C<''> for false, or
259 the undefined value if the file doesn't exist. Despite the funny
260 names, precedence is the same as any other named unary operator, and
261 the argument may be parenthesized like any other unary operator. The
262 operator may be any of:
263 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>
264 X<-S>X<-b>X<-c>X<-t>X<-u>X<-g>X<-k>X<-T>X<-B>X<-M>X<-A>X<-C>
266 -r File is readable by effective uid/gid.
267 -w File is writable by effective uid/gid.
268 -x File is executable by effective uid/gid.
269 -o File is owned by effective uid.
271 -R File is readable by real uid/gid.
272 -W File is writable by real uid/gid.
273 -X File is executable by real uid/gid.
274 -O File is owned by real uid.
277 -z File has zero size.
278 -s File has nonzero size (returns size).
280 -f File is a plain file.
281 -d File is a directory.
282 -l File is a symbolic link.
283 -p File is a named pipe (FIFO), or Filehandle is a pipe.
285 -b File is a block special file.
286 -c File is a character special file.
287 -t Filehandle is opened to a tty.
289 -u File has setuid bit set.
290 -g File has setgid bit set.
291 -k File has sticky bit set.
293 -T File is an ASCII text file.
294 -B File is a "binary" file (opposite of -T).
296 -M Age of file in days when script started.
297 -A Same for access time.
298 -C Same for inode change time.
304 next unless -f $_; # ignore specials
308 The interpretation of the file permission operators C<-r>, C<-R>,
309 C<-w>, C<-W>, C<-x>, and C<-X> is by default based solely on the mode
310 of the file and the uids and gids of the user. There may be other
311 reasons you can't actually read, write, or execute the file. Such
312 reasons may be for example network filesystem access controls, ACLs
313 (access control lists), read-only filesystems, and unrecognized
316 Also note that, for the superuser on the local filesystems, the C<-r>,
317 C<-R>, C<-w>, and C<-W> tests always return 1, and C<-x> and C<-X> return 1
318 if any execute bit is set in the mode. Scripts run by the superuser
319 may thus need to do a stat() to determine the actual mode of the file,
320 or temporarily set their effective uid to something else.
322 If you are using ACLs, there is a pragma called C<filetest> that may
323 produce more accurate results than the bare stat() mode bits.
324 When under the C<use filetest 'access'> the above-mentioned filetests
325 will test whether the permission can (not) be granted using the
326 access() family of system calls. Also note that the C<-x> and C<-X> may
327 under this pragma return true even if there are no execute permission
328 bits set (nor any extra execute permission ACLs). This strangeness is
329 due to the underlying system calls' definitions. Read the
330 documentation for the C<filetest> pragma for more information.
332 Note that C<-s/a/b/> does not do a negated substitution. Saying
333 C<-exp($foo)> still works as expected, however--only single letters
334 following a minus are interpreted as file tests.
336 The C<-T> and C<-B> switches work as follows. The first block or so of the
337 file is examined for odd characters such as strange control codes or
338 characters with the high bit set. If too many strange characters (E<gt>30%)
339 are found, it's a C<-B> file, otherwise it's a C<-T> file. Also, any file
340 containing null in the first block is considered a binary file. If C<-T>
341 or C<-B> is used on a filehandle, the current stdio buffer is examined
342 rather than the first block. Both C<-T> and C<-B> return true on a null
343 file, or a file at EOF when testing a filehandle. Because you have to
344 read a file to do the C<-T> test, on most occasions you want to use a C<-f>
345 against the file first, as in C<next unless -f $file && -T $file>.
347 If any of the file tests (or either the C<stat> or C<lstat> operators) are given
348 the special filehandle consisting of a solitary underline, then the stat
349 structure of the previous file test (or stat operator) is used, saving
350 a system call. (This doesn't work with C<-t>, and you need to remember
351 that lstat() and C<-l> will leave values in the stat structure for the
352 symbolic link, not the real file.) Example:
354 print "Can do.\n" if -r $a || -w _ || -x _;
357 print "Readable\n" if -r _;
358 print "Writable\n" if -w _;
359 print "Executable\n" if -x _;
360 print "Setuid\n" if -u _;
361 print "Setgid\n" if -g _;
362 print "Sticky\n" if -k _;
363 print "Text\n" if -T _;
364 print "Binary\n" if -B _;
370 Returns the absolute value of its argument.
371 If VALUE is omitted, uses C<$_>.
373 =item accept NEWSOCKET,GENERICSOCKET
375 Accepts an incoming socket connect, just as the accept(2) system call
376 does. Returns the packed address if it succeeded, false otherwise.
377 See the example in L<perlipc/"Sockets: Client/Server Communication">.
383 Arranges to have a SIGALRM delivered to this process after the
384 specified number of seconds have elapsed. If SECONDS is not specified,
385 the value stored in C<$_> is used. (On some machines,
386 unfortunately, the elapsed time may be up to one second less than you
387 specified because of how seconds are counted.) Only one timer may be
388 counting at once. Each call disables the previous timer, and an
389 argument of C<0> may be supplied to cancel the previous timer without
390 starting a new one. The returned value is the amount of time remaining
391 on the previous timer.
393 For delays of finer granularity than one second, you may use Perl's
394 four-argument version of select() leaving the first three arguments
395 undefined, or you might be able to use the C<syscall> interface to
396 access setitimer(2) if your system supports it. The Time::HiRes module
397 from CPAN may also prove useful.
399 It is usually a mistake to intermix C<alarm> and C<sleep> calls.
400 (C<sleep> may be internally implemented in your system with C<alarm>)
402 If you want to use C<alarm> to time out a system call you need to use an
403 C<eval>/C<die> pair. You can't rely on the alarm causing the system call to
404 fail with C<$!> set to C<EINTR> because Perl sets up signal handlers to
405 restart system calls on some systems. Using C<eval>/C<die> always works,
406 modulo the caveats given in L<perlipc/"Signals">.
409 local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required
411 $nread = sysread SOCKET, $buffer, $size;
415 die unless $@ eq "alarm\n"; # propagate unexpected errors
424 Returns the arctangent of Y/X in the range -PI to PI.
426 For the tangent operation, you may use the C<POSIX::tan()>
427 function, or use the familiar relation:
429 sub tan { sin($_[0]) / cos($_[0]) }
431 =item bind SOCKET,NAME
433 Binds a network address to a socket, just as the bind system call
434 does. Returns true if it succeeded, false otherwise. NAME should be a
435 packed address of the appropriate type for the socket. See the examples in
436 L<perlipc/"Sockets: Client/Server Communication">.
438 =item binmode FILEHANDLE
440 Arranges for FILEHANDLE to be read or written in "binary" mode on
441 systems whose run-time libraries force the programmer to guess
442 between binary and text files. If FILEHANDLE is an expression, the
443 value is taken as the name of the filehandle. binmode() should be
444 called after the C<open> but before any I/O is done on the filehandle.
445 The only way to reset binary mode on a filehandle is to reopen the
448 The operating system, device drivers, C libraries, and Perl run-time
449 system all conspire to let the programmer conveniently treat a
450 simple, one-byte C<\n> as the line terminator, irrespective of its
451 external representation. On Unix and its brethren, the native file
452 representation exactly matches the internal representation, making
453 everyone's lives unbelievably simpler. Consequently, L<binmode>
454 has no effect under Unix, Plan9, or Mac OS, all of which use C<\n>
455 to end each line. (Unix and Plan9 think C<\n> means C<\cJ> and
456 C<\r> means C<\cM>, whereas the Mac goes the other way--it uses
457 C<\cM> for c<\n> and C<\cJ> to mean C<\r>. But that's ok, because
458 it's only one byte, and the internal and external representations
461 In legacy systems like MS-DOS and its embellishments, your program
462 sees a C<\n> as a simple C<\cJ> (just as in Unix), but oddly enough,
463 that's not what's physically stored on disk. What's worse, these
464 systems refuse to help you with this; it's up to you to remember
465 what to do. And you mustn't go applying binmode() with wild abandon,
466 either, because if your system does care about binmode(), then using
467 it when you shouldn't is just as perilous as failing to use it when
470 That means that on any version of Microsoft WinXX that you might
471 care to name (or not), binmode() causes C<\cM\cJ> sequences on disk
472 to be converted to C<\n> when read into your program, and causes
473 any C<\n> in your program to be converted back to C<\cM\cJ> on
474 output to disk. This sad discrepancy leads to no end of
475 problems in not just the readline operator, but also when using
476 seek(), tell(), and read() calls. See L<perlport> for other painful
477 details. See the C<$/> and C<$\> variables in L<perlvar> for how
478 to manually set your input and output line-termination sequences.
480 =item bless REF,CLASSNAME
484 This function tells the thingy referenced by REF that it is now an object
485 in the CLASSNAME package. If CLASSNAME is omitted, the current package
486 is used. Because a C<bless> is often the last thing in a constructor,
487 it returns the reference for convenience. Always use the two-argument
488 version if the function doing the blessing might be inherited by a
489 derived class. See L<perltoot> and L<perlobj> for more about the blessing
490 (and blessings) of objects.
492 Consider always blessing objects in CLASSNAMEs that are mixed case.
493 Namespaces with all lowercase names are considered reserved for
494 Perl pragmata. Builtin types have all uppercase names, so to prevent
495 confusion, you may wish to avoid such package names as well. Make sure
496 that CLASSNAME is a true value.
498 See L<perlmod/"Perl Modules">.
504 Returns the context of the current subroutine call. In scalar context,
505 returns the caller's package name if there is a caller, that is, if
506 we're in a subroutine or C<eval> or C<require>, and the undefined value
507 otherwise. In list context, returns
509 ($package, $filename, $line) = caller;
511 With EXPR, it returns some extra information that the debugger uses to
512 print a stack trace. The value of EXPR indicates how many call frames
513 to go back before the current one.
515 ($package, $filename, $line, $subroutine, $hasargs,
516 $wantarray, $evaltext, $is_require, $hints) = caller($i);
518 Here $subroutine may be C<"(eval)"> if the frame is not a subroutine
519 call, but an C<eval>. In such a case additional elements $evaltext and
520 C<$is_require> are set: C<$is_require> is true if the frame is created by a
521 C<require> or C<use> statement, $evaltext contains the text of the
522 C<eval EXPR> statement. In particular, for a C<eval BLOCK> statement,
523 $filename is C<"(eval)">, but $evaltext is undefined. (Note also that
524 each C<use> statement creates a C<require> frame inside an C<eval EXPR>)
525 frame. C<$hints> contains pragmatic hints that the caller was
526 compiled with. It currently only reflects the hint corresponding to
529 Furthermore, when called from within the DB package, caller returns more
530 detailed information: it sets the list variable C<@DB::args> to be the
531 arguments with which the subroutine was invoked.
533 Be aware that the optimizer might have optimized call frames away before
534 C<caller> had a chance to get the information. That means that C<caller(N)>
535 might not return information about the call frame you expect it do, for
536 C<N E<gt> 1>. In particular, C<@DB::args> might have information from the
537 previous time C<caller> was called.
541 Changes the working directory to EXPR, if possible. If EXPR is omitted,
542 changes to the user's home directory. Returns true upon success,
543 false otherwise. See the example under C<die>.
547 Changes the permissions of a list of files. The first element of the
548 list must be the numerical mode, which should probably be an octal
549 number, and which definitely should I<not> a string of octal digits:
550 C<0644> is okay, C<'0644'> is not. Returns the number of files
551 successfully changed. See also L</oct>, if all you have is a string.
553 $cnt = chmod 0755, 'foo', 'bar';
554 chmod 0755, @executables;
555 $mode = '0644'; chmod $mode, 'foo'; # !!! sets mode to
557 $mode = '0644'; chmod oct($mode), 'foo'; # this is better
558 $mode = 0644; chmod $mode, 'foo'; # this is best
566 This safer version of L</chop> removes any trailing string
567 that corresponds to the current value of C<$/> (also known as
568 $INPUT_RECORD_SEPARATOR in the C<English> module). It returns the total
569 number of characters removed from all its arguments. It's often used to
570 remove the newline from the end of an input record when you're worried
571 that the final record may be missing its newline. When in paragraph
572 mode (C<$/ = "">), it removes all trailing newlines from the string.
573 When in slurp mode (C<$/ = undef>) or fixed-length record mode (C<$/> is
574 a reference to an integer or the like, see L<perlvar>) chomp() won't
576 If VARIABLE is omitted, it chomps C<$_>. Example:
579 chomp; # avoid \n on last field
584 You can actually chomp anything that's an lvalue, including an assignment:
587 chomp($answer = <STDIN>);
589 If you chomp a list, each element is chomped, and the total number of
590 characters removed is returned.
598 Chops off the last character of a string and returns the character
599 chopped. It's used primarily to remove the newline from the end of an
600 input record, but is much more efficient than C<s/\n//> because it neither
601 scans nor copies the string. If VARIABLE is omitted, chops C<$_>.
605 chop; # avoid \n on last field
610 You can actually chop anything that's an lvalue, including an assignment:
613 chop($answer = <STDIN>);
615 If you chop a list, each element is chopped. Only the value of the
616 last C<chop> is returned.
618 Note that C<chop> returns the last character. To return all but the last
619 character, use C<substr($string, 0, -1)>.
623 Changes the owner (and group) of a list of files. The first two
624 elements of the list must be the I<numeric> uid and gid, in that
625 order. A value of -1 in either position is interpreted by most
626 systems to leave that value unchanged. Returns the number of files
627 successfully changed.
629 $cnt = chown $uid, $gid, 'foo', 'bar';
630 chown $uid, $gid, @filenames;
632 Here's an example that looks up nonnumeric uids in the passwd file:
635 chomp($user = <STDIN>);
637 chomp($pattern = <STDIN>);
639 ($login,$pass,$uid,$gid) = getpwnam($user)
640 or die "$user not in passwd file";
642 @ary = glob($pattern); # expand filenames
643 chown $uid, $gid, @ary;
645 On most systems, you are not allowed to change the ownership of the
646 file unless you're the superuser, although you should be able to change
647 the group to any of your secondary groups. On insecure systems, these
648 restrictions may be relaxed, but this is not a portable assumption.
649 On POSIX systems, you can detect this condition this way:
651 use POSIX qw(sysconf _PC_CHOWN_RESTRICTED);
652 $can_chown_giveaway = not sysconf(_PC_CHOWN_RESTRICTED);
658 Returns the character represented by that NUMBER in the character set.
659 For example, C<chr(65)> is C<"A"> in either ASCII or Unicode, and
660 chr(0x263a) is a Unicode smiley face (but only within the scope of
661 a C<use utf8>). For the reverse, use L</ord>.
662 See L<utf8> for more about Unicode.
664 If NUMBER is omitted, uses C<$_>.
666 =item chroot FILENAME
670 This function works like the system call by the same name: it makes the
671 named directory the new root directory for all further pathnames that
672 begin with a C<"/"> by your process and all its children. (It doesn't
673 change your current working directory, which is unaffected.) For security
674 reasons, this call is restricted to the superuser. If FILENAME is
675 omitted, does a C<chroot> to C<$_>.
677 =item close FILEHANDLE
681 Closes the file or pipe associated with the file handle, returning true
682 only if stdio successfully flushes buffers and closes the system file
683 descriptor. Closes the currently selected filehandle if the argument
686 You don't have to close FILEHANDLE if you are immediately going to do
687 another C<open> on it, because C<open> will close it for you. (See
688 C<open>.) However, an explicit C<close> on an input file resets the line
689 counter (C<$.>), while the implicit close done by C<open> does not.
691 If the file handle came from a piped open C<close> will additionally
692 return false if one of the other system calls involved fails or if the
693 program exits with non-zero status. (If the only problem was that the
694 program exited non-zero C<$!> will be set to C<0>.) Closing a pipe
695 also waits for the process executing on the pipe to complete, in case you
696 want to look at the output of the pipe afterwards, and
697 implicitly puts the exit status value of that command into C<$?>.
699 Prematurely closing the read end of a pipe (i.e. before the process
700 writing to it at the other end has closed it) will result in a
701 SIGPIPE being delivered to the writer. If the other end can't
702 handle that, be sure to read all the data before closing the pipe.
706 open(OUTPUT, '|sort >foo') # pipe to sort
707 or die "Can't start sort: $!";
708 #... # print stuff to output
709 close OUTPUT # wait for sort to finish
710 or warn $! ? "Error closing sort pipe: $!"
711 : "Exit status $? from sort";
712 open(INPUT, 'foo') # get sort's results
713 or die "Can't open 'foo' for input: $!";
715 FILEHANDLE may be an expression whose value can be used as an indirect
716 filehandle, usually the real filehandle name.
718 =item closedir DIRHANDLE
720 Closes a directory opened by C<opendir> and returns the success of that
723 DIRHANDLE may be an expression whose value can be used as an indirect
724 dirhandle, usually the real dirhandle name.
726 =item connect SOCKET,NAME
728 Attempts to connect to a remote socket, just as the connect system call
729 does. Returns true if it succeeded, false otherwise. NAME should be a
730 packed address of the appropriate type for the socket. See the examples in
731 L<perlipc/"Sockets: Client/Server Communication">.
735 Actually a flow control statement rather than a function. If there is a
736 C<continue> BLOCK attached to a BLOCK (typically in a C<while> or
737 C<foreach>), it is always executed just before the conditional is about to
738 be evaluated again, just like the third part of a C<for> loop in C. Thus
739 it can be used to increment a loop variable, even when the loop has been
740 continued via the C<next> statement (which is similar to the C C<continue>
743 C<last>, C<next>, or C<redo> may appear within a C<continue>
744 block. C<last> and C<redo> will behave as if they had been executed within
745 the main block. So will C<next>, but since it will execute a C<continue>
746 block, it may be more entertaining.
749 ### redo always comes here
752 ### next always comes here
754 # then back the top to re-check EXPR
756 ### last always comes here
758 Omitting the C<continue> section is semantically equivalent to using an
759 empty one, logically enough. In that case, C<next> goes directly back
760 to check the condition at the top of the loop.
764 Returns the cosine of EXPR (expressed in radians). If EXPR is omitted,
765 takes cosine of C<$_>.
767 For the inverse cosine operation, you may use the C<POSIX::acos()>
768 function, or use this relation:
770 sub acos { atan2( sqrt(1 - $_[0] * $_[0]), $_[0] ) }
772 =item crypt PLAINTEXT,SALT
774 Encrypts a string exactly like the crypt(3) function in the C library
775 (assuming that you actually have a version there that has not been
776 extirpated as a potential munition). This can prove useful for checking
777 the password file for lousy passwords, amongst other things. Only the
778 guys wearing white hats should do this.
780 Note that C<crypt> is intended to be a one-way function, much like breaking
781 eggs to make an omelette. There is no (known) corresponding decrypt
782 function. As a result, this function isn't all that useful for
783 cryptography. (For that, see your nearby CPAN mirror.)
785 When verifying an existing encrypted string you should use the encrypted
786 text as the salt (like C<crypt($plain, $crypted) eq $crypted>). This
787 allows your code to work with the standard C<crypt> and with more
788 exotic implementations. When choosing a new salt create a random two
789 character string whose characters come from the set C<[./0-9A-Za-z]>
790 (like C<join '', ('.', '/', 0..9, 'A'..'Z', 'a'..'z')[rand 64, rand 64]>).
792 Here's an example that makes sure that whoever runs this program knows
795 $pwd = (getpwuid($<))[1];
799 chomp($word = <STDIN>);
803 if (crypt($word, $pwd) ne $pwd) {
809 Of course, typing in your own password to whoever asks you
812 The L<crypt> function is unsuitable for encrypting large quantities
813 of data, not least of all because you can't get the information
814 back. Look at the F<by-module/Crypt> and F<by-module/PGP> directories
815 on your favorite CPAN mirror for a slew of potentially useful
820 [This function has been largely superseded by the C<untie> function.]
822 Breaks the binding between a DBM file and a hash.
824 =item dbmopen HASH,DBNAME,MASK
826 [This function has been largely superseded by the C<tie> function.]
828 This binds a dbm(3), ndbm(3), sdbm(3), gdbm(3), or Berkeley DB file to a
829 hash. HASH is the name of the hash. (Unlike normal C<open>, the first
830 argument is I<not> a filehandle, even though it looks like one). DBNAME
831 is the name of the database (without the F<.dir> or F<.pag> extension if
832 any). If the database does not exist, it is created with protection
833 specified by MASK (as modified by the C<umask>). If your system supports
834 only the older DBM functions, you may perform only one C<dbmopen> in your
835 program. In older versions of Perl, if your system had neither DBM nor
836 ndbm, calling C<dbmopen> produced a fatal error; it now falls back to
839 If you don't have write access to the DBM file, you can only read hash
840 variables, not set them. If you want to test whether you can write,
841 either use file tests or try setting a dummy hash entry inside an C<eval>,
842 which will trap the error.
844 Note that functions such as C<keys> and C<values> may return huge lists
845 when used on large DBM files. You may prefer to use the C<each>
846 function to iterate over large DBM files. Example:
848 # print out history file offsets
849 dbmopen(%HIST,'/usr/lib/news/history',0666);
850 while (($key,$val) = each %HIST) {
851 print $key, ' = ', unpack('L',$val), "\n";
855 See also L<AnyDBM_File> for a more general description of the pros and
856 cons of the various dbm approaches, as well as L<DB_File> for a particularly
859 You can control which DBM library you use by loading that library
860 before you call dbmopen():
863 dbmopen(%NS_Hist, "$ENV{HOME}/.netscape/history.db")
864 or die "Can't open netscape history file: $!";
870 Returns a Boolean value telling whether EXPR has a value other than
871 the undefined value C<undef>. If EXPR is not present, C<$_> will be
874 Many operations return C<undef> to indicate failure, end of file,
875 system error, uninitialized variable, and other exceptional
876 conditions. This function allows you to distinguish C<undef> from
877 other values. (A simple Boolean test will not distinguish among
878 C<undef>, zero, the empty string, and C<"0">, which are all equally
879 false.) Note that since C<undef> is a valid scalar, its presence
880 doesn't I<necessarily> indicate an exceptional condition: C<pop>
881 returns C<undef> when its argument is an empty array, I<or> when the
882 element to return happens to be C<undef>.
884 You may also use C<defined(&func)> to check whether subroutine C<&func>
885 has ever been defined. The return value is unaffected by any forward
886 declarations of C<&foo>.
888 Use of C<defined> on aggregates (hashes and arrays) is deprecated. It
889 used to report whether memory for that aggregate has ever been
890 allocated. This behavior may disappear in future versions of Perl.
891 You should instead use a simple test for size:
893 if (@an_array) { print "has array elements\n" }
894 if (%a_hash) { print "has hash members\n" }
896 When used on a hash element, it tells you whether the value is defined,
897 not whether the key exists in the hash. Use L</exists> for the latter
902 print if defined $switch{'D'};
903 print "$val\n" while defined($val = pop(@ary));
904 die "Can't readlink $sym: $!"
905 unless defined($value = readlink $sym);
906 sub foo { defined &$bar ? &$bar(@_) : die "No bar"; }
907 $debugging = 0 unless defined $debugging;
909 Note: Many folks tend to overuse C<defined>, and then are surprised to
910 discover that the number C<0> and C<""> (the zero-length string) are, in fact,
911 defined values. For example, if you say
915 The pattern match succeeds, and C<$1> is defined, despite the fact that it
916 matched "nothing". But it didn't really match nothing--rather, it
917 matched something that happened to be zero characters long. This is all
918 very above-board and honest. When a function returns an undefined value,
919 it's an admission that it couldn't give you an honest answer. So you
920 should use C<defined> only when you're questioning the integrity of what
921 you're trying to do. At other times, a simple comparison to C<0> or C<""> is
924 See also L</undef>, L</exists>, L</ref>.
928 Deletes the specified key(s) and their associated values from a hash.
929 For each key, returns the deleted value associated with that key, or
930 the undefined value if there was no such key. Deleting from C<$ENV{}>
931 modifies the environment. Deleting from a hash tied to a DBM file
932 deletes the entry from the DBM file. (But deleting from a C<tie>d hash
933 doesn't necessarily return anything.)
935 The following deletes all the values of a hash:
937 foreach $key (keys %HASH) {
943 delete @HASH{keys %HASH}
945 But both of these are slower than just assigning the empty list
948 %hash = (); # completely empty %hash
949 undef %hash; # forget %hash every existed
951 Note that the EXPR can be arbitrarily complicated as long as the final
952 operation is a hash element lookup or hash slice:
954 delete $ref->[$x][$y]{$key};
955 delete @{$ref->[$x][$y]}{$key1, $key2, @morekeys};
959 Outside an C<eval>, prints the value of LIST to C<STDERR> and
960 exits with the current value of C<$!> (errno). If C<$!> is C<0>,
961 exits with the value of C<($? E<gt>E<gt> 8)> (backtick `command`
962 status). If C<($? E<gt>E<gt> 8)> is C<0>, exits with C<255>. Inside
963 an C<eval(),> the error message is stuffed into C<$@> and the
964 C<eval> is terminated with the undefined value. This makes
965 C<die> the way to raise an exception.
969 die "Can't cd to spool: $!\n" unless chdir '/usr/spool/news';
970 chdir '/usr/spool/news' or die "Can't cd to spool: $!\n"
972 If the value of EXPR does not end in a newline, the current script line
973 number and input line number (if any) are also printed, and a newline
974 is supplied. Note that the "input line number" (also known as "chunk")
975 is subject to whatever notion of "line" happens to be currently in
976 effect, and is also available as the special variable C<$.>.
977 See L<perlvar/"$/"> and L<perlvar/"$.">.
979 Hint: sometimes appending C<", stopped"> to your message
980 will cause it to make better sense when the string C<"at foo line 123"> is
981 appended. Suppose you are running script "canasta".
983 die "/etc/games is no good";
984 die "/etc/games is no good, stopped";
986 produce, respectively
988 /etc/games is no good at canasta line 123.
989 /etc/games is no good, stopped at canasta line 123.
991 See also exit(), warn(), and the Carp module.
993 If LIST is empty and C<$@> already contains a value (typically from a
994 previous eval) that value is reused after appending C<"\t...propagated">.
995 This is useful for propagating exceptions:
998 die unless $@ =~ /Expected exception/;
1000 If C<$@> is empty then the string C<"Died"> is used.
1002 die() can also be called with a reference argument. If this happens to be
1003 trapped within an eval(), $@ contains the reference. This behavior permits
1004 a more elaborate exception handling implementation using objects that
1005 maintain arbitary state about the nature of the exception. Such a scheme
1006 is sometimes preferable to matching particular string values of $@ using
1007 regular expressions. Here's an example:
1009 eval { ... ; die Some::Module::Exception->new( FOO => "bar" ) };
1011 if (ref($@) && UNIVERSAL::isa($@,"Some::Module::Exception")) {
1012 # handle Some::Module::Exception
1015 # handle all other possible exceptions
1019 Because perl will stringify uncaught exception messages before displaying
1020 them, you may want to overload stringification operations on such custom
1021 exception objects. See L<overload> for details about that.
1023 You can arrange for a callback to be run just before the C<die>
1024 does its deed, by setting the C<$SIG{__DIE__}> hook. The associated
1025 handler will be called with the error text and can change the error
1026 message, if it sees fit, by calling C<die> again. See
1027 L<perlvar/$SIG{expr}> for details on setting C<%SIG> entries, and
1028 L<"eval BLOCK"> for some examples. Although this feature was meant
1029 to be run only right before your program was to exit, this is not
1030 currently the case--the C<$SIG{__DIE__}> hook is currently called
1031 even inside eval()ed blocks/strings! If one wants the hook to do
1032 nothing in such situations, put
1036 as the first line of the handler (see L<perlvar/$^S>). Because
1037 this promotes strange action at a distance, this counterintuitive
1038 behavior may be fixed in a future release.
1042 Not really a function. Returns the value of the last command in the
1043 sequence of commands indicated by BLOCK. When modified by a loop
1044 modifier, executes the BLOCK once before testing the loop condition.
1045 (On other statements the loop modifiers test the conditional first.)
1047 C<do BLOCK> does I<not> count as a loop, so the loop control statements
1048 C<next>, C<last>, or C<redo> cannot be used to leave or restart the block.
1049 See L<perlsyn> for alternative strategies.
1051 =item do SUBROUTINE(LIST)
1053 A deprecated form of subroutine call. See L<perlsub>.
1057 Uses the value of EXPR as a filename and executes the contents of the
1058 file as a Perl script. Its primary use is to include subroutines
1059 from a Perl subroutine library.
1065 scalar eval `cat stat.pl`;
1067 except that it's more efficient and concise, keeps track of the current
1068 filename for error messages, searches the @INC libraries, and updates
1069 C<%INC> if the file is found. See L<perlvar/Predefined Names> for these
1070 variables. It also differs in that code evaluated with C<do FILENAME>
1071 cannot see lexicals in the enclosing scope; C<eval STRING> does. It's the
1072 same, however, in that it does reparse the file every time you call it,
1073 so you probably don't want to do this inside a loop.
1075 If C<do> cannot read the file, it returns undef and sets C<$!> to the
1076 error. If C<do> can read the file but cannot compile it, it
1077 returns undef and sets an error message in C<$@>. If the file is
1078 successfully compiled, C<do> returns the value of the last expression
1081 Note that inclusion of library modules is better done with the
1082 C<use> and C<require> operators, which also do automatic error checking
1083 and raise an exception if there's a problem.
1085 You might like to use C<do> to read in a program configuration
1086 file. Manual error checking can be done this way:
1088 # read in config files: system first, then user
1089 for $file ("/share/prog/defaults.rc",
1090 "$ENV{HOME}/.someprogrc")
1092 unless ($return = do $file) {
1093 warn "couldn't parse $file: $@" if $@;
1094 warn "couldn't do $file: $!" unless defined $return;
1095 warn "couldn't run $file" unless $return;
1103 This function causes an immediate core dump. See also the B<-u>
1104 command-line switch in L<perlrun>, which does the same thing.
1105 Primarily this is so that you can use the B<undump> program (not
1106 supplied) to turn your core dump into an executable binary after
1107 having initialized all your variables at the beginning of the
1108 program. When the new binary is executed it will begin by executing
1109 a C<goto LABEL> (with all the restrictions that C<goto> suffers).
1110 Think of it as a goto with an intervening core dump and reincarnation.
1111 If C<LABEL> is omitted, restarts the program from the top.
1113 B<WARNING>: Any files opened at the time of the dump will I<not>
1114 be open any more when the program is reincarnated, with possible
1115 resulting confusion on the part of Perl.
1117 This function is now largely obsolete, partly because it's very
1118 hard to convert a core file into an executable, and because the
1119 real compiler backends for generating portable bytecode and compilable
1120 C code have superseded it.
1122 If you're looking to use L<dump> to speed up your program, consider
1123 generating bytecode or native C code as described in L<perlcc>. If
1124 you're just trying to accelerate a CGI script, consider using the
1125 C<mod_perl> extension to B<Apache>, or the CPAN module, Fast::CGI.
1126 You might also consider autoloading or selfloading, which at least
1127 make your program I<appear> to run faster.
1131 When called in list context, returns a 2-element list consisting of the
1132 key and value for the next element of a hash, so that you can iterate over
1133 it. When called in scalar context, returns the key for only the "next"
1134 element in the hash. (Note: Keys may be C<"0"> or C<"">, which are logically
1135 false; you may wish to avoid constructs like C<while ($k = each %foo) {}>
1138 Entries are returned in an apparently random order. The actual random
1139 order is subject to change in future versions of perl, but it is guaranteed
1140 to be in the same order as either the C<keys> or C<values> function
1141 would produce on the same (unmodified) hash.
1143 When the hash is entirely read, a null array is returned in list context
1144 (which when assigned produces a false (C<0>) value), and C<undef> in
1145 scalar context. The next call to C<each> after that will start iterating
1146 again. There is a single iterator for each hash, shared by all C<each>,
1147 C<keys>, and C<values> function calls in the program; it can be reset by
1148 reading all the elements from the hash, or by evaluating C<keys HASH> or
1149 C<values HASH>. If you add or delete elements of a hash while you're
1150 iterating over it, you may get entries skipped or duplicated, so don't.
1152 The following prints out your environment like the printenv(1) program,
1153 only in a different order:
1155 while (($key,$value) = each %ENV) {
1156 print "$key=$value\n";
1159 See also C<keys>, C<values> and C<sort>.
1161 =item eof FILEHANDLE
1167 Returns 1 if the next read on FILEHANDLE will return end of file, or if
1168 FILEHANDLE is not open. FILEHANDLE may be an expression whose value
1169 gives the real filehandle. (Note that this function actually
1170 reads a character and then C<ungetc>s it, so isn't very useful in an
1171 interactive context.) Do not read from a terminal file (or call
1172 C<eof(FILEHANDLE)> on it) after end-of-file is reached. File types such
1173 as terminals may lose the end-of-file condition if you do.
1175 An C<eof> without an argument uses the last file read as argument.
1176 Using C<eof()> with empty parentheses is very different. It indicates
1177 the pseudo file formed of the files listed on the command line,
1178 i.e., C<eof()> is reasonable to use inside a C<while (E<lt>E<gt>)>
1179 loop to detect the end of only the last file. Use C<eof(ARGV)> or
1180 C<eof> without the parentheses to test I<each> file in a while
1181 (E<lt>E<gt>) loop. Examples:
1183 # reset line numbering on each input file
1185 next if /^\s*#/; # skip comments
1188 close ARGV if eof; # Not eof()!
1191 # insert dashes just before last line of last file
1193 if (eof()) { # check for end of current file
1194 print "--------------\n";
1195 close(ARGV); # close or last; is needed if we
1196 # are reading from the terminal
1201 Practical hint: you almost never need to use C<eof> in Perl, because the
1202 input operators return false values when they run out of data, or if there
1209 In the first form, the return value of EXPR is parsed and executed as if it
1210 were a little Perl program. The value of the expression (which is itself
1211 determined within scalar context) is first parsed, and if there weren't any
1212 errors, executed in the context of the current Perl program, so that any
1213 variable settings or subroutine and format definitions remain afterwards.
1214 Note that the value is parsed every time the eval executes. If EXPR is
1215 omitted, evaluates C<$_>. This form is typically used to delay parsing
1216 and subsequent execution of the text of EXPR until run time.
1218 In the second form, the code within the BLOCK is parsed only once--at the
1219 same time the code surrounding the eval itself was parsed--and executed
1220 within the context of the current Perl program. This form is typically
1221 used to trap exceptions more efficiently than the first (see below), while
1222 also providing the benefit of checking the code within BLOCK at compile
1225 The final semicolon, if any, may be omitted from the value of EXPR or within
1228 In both forms, the value returned is the value of the last expression
1229 evaluated inside the mini-program; a return statement may be also used, just
1230 as with subroutines. The expression providing the return value is evaluated
1231 in void, scalar, or list context, depending on the context of the eval itself.
1232 See L</wantarray> for more on how the evaluation context can be determined.
1234 If there is a syntax error or runtime error, or a C<die> statement is
1235 executed, an undefined value is returned by C<eval>, and C<$@> is set to the
1236 error message. If there was no error, C<$@> is guaranteed to be a null
1237 string. Beware that using C<eval> neither silences perl from printing
1238 warnings to STDERR, nor does it stuff the text of warning messages into C<$@>.
1239 To do either of those, you have to use the C<$SIG{__WARN__}> facility. See
1240 L</warn> and L<perlvar>.
1242 Note that, because C<eval> traps otherwise-fatal errors, it is useful for
1243 determining whether a particular feature (such as C<socket> or C<symlink>)
1244 is implemented. It is also Perl's exception trapping mechanism, where
1245 the die operator is used to raise exceptions.
1247 If the code to be executed doesn't vary, you may use the eval-BLOCK
1248 form to trap run-time errors without incurring the penalty of
1249 recompiling each time. The error, if any, is still returned in C<$@>.
1252 # make divide-by-zero nonfatal
1253 eval { $answer = $a / $b; }; warn $@ if $@;
1255 # same thing, but less efficient
1256 eval '$answer = $a / $b'; warn $@ if $@;
1258 # a compile-time error
1259 eval { $answer = }; # WRONG
1262 eval '$answer ='; # sets $@
1264 Due to the current arguably broken state of C<__DIE__> hooks, when using
1265 the C<eval{}> form as an exception trap in libraries, you may wish not
1266 to trigger any C<__DIE__> hooks that user code may have installed.
1267 You can use the C<local $SIG{__DIE__}> construct for this purpose,
1268 as shown in this example:
1270 # a very private exception trap for divide-by-zero
1271 eval { local $SIG{'__DIE__'}; $answer = $a / $b; };
1274 This is especially significant, given that C<__DIE__> hooks can call
1275 C<die> again, which has the effect of changing their error messages:
1277 # __DIE__ hooks may modify error messages
1279 local $SIG{'__DIE__'} =
1280 sub { (my $x = $_[0]) =~ s/foo/bar/g; die $x };
1281 eval { die "foo lives here" };
1282 print $@ if $@; # prints "bar lives here"
1285 Because this promotes action at a distance, this counterintuitive behavior
1286 may be fixed in a future release.
1288 With an C<eval>, you should be especially careful to remember what's
1289 being looked at when:
1295 eval { $x }; # CASE 4
1297 eval "\$$x++"; # CASE 5
1300 Cases 1 and 2 above behave identically: they run the code contained in
1301 the variable $x. (Although case 2 has misleading double quotes making
1302 the reader wonder what else might be happening (nothing is).) Cases 3
1303 and 4 likewise behave in the same way: they run the code C<'$x'>, which
1304 does nothing but return the value of $x. (Case 4 is preferred for
1305 purely visual reasons, but it also has the advantage of compiling at
1306 compile-time instead of at run-time.) Case 5 is a place where
1307 normally you I<would> like to use double quotes, except that in this
1308 particular situation, you can just use symbolic references instead, as
1311 C<eval BLOCK> does I<not> count as a loop, so the loop control statements
1312 C<next>, C<last>, or C<redo> cannot be used to leave or restart the block.
1316 =item exec PROGRAM LIST
1318 The C<exec> function executes a system command I<and never returns>--
1319 use C<system> instead of C<exec> if you want it to return. It fails and
1320 returns false only if the command does not exist I<and> it is executed
1321 directly instead of via your system's command shell (see below).
1323 Since it's a common mistake to use C<exec> instead of C<system>, Perl
1324 warns you if there is a following statement which isn't C<die>, C<warn>,
1325 or C<exit> (if C<-w> is set - but you always do that). If you
1326 I<really> want to follow an C<exec> with some other statement, you
1327 can use one of these styles to avoid the warning:
1329 exec ('foo') or print STDERR "couldn't exec foo: $!";
1330 { exec ('foo') }; print STDERR "couldn't exec foo: $!";
1332 If there is more than one argument in LIST, or if LIST is an array
1333 with more than one value, calls execvp(3) with the arguments in LIST.
1334 If there is only one scalar argument or an array with one element in it,
1335 the argument is checked for shell metacharacters, and if there are any,
1336 the entire argument is passed to the system's command shell for parsing
1337 (this is C</bin/sh -c> on Unix platforms, but varies on other platforms).
1338 If there are no shell metacharacters in the argument, it is split into
1339 words and passed directly to C<execvp>, which is more efficient.
1342 exec '/bin/echo', 'Your arguments are: ', @ARGV;
1343 exec "sort $outfile | uniq";
1345 If you don't really want to execute the first argument, but want to lie
1346 to the program you are executing about its own name, you can specify
1347 the program you actually want to run as an "indirect object" (without a
1348 comma) in front of the LIST. (This always forces interpretation of the
1349 LIST as a multivalued list, even if there is only a single scalar in
1352 $shell = '/bin/csh';
1353 exec $shell '-sh'; # pretend it's a login shell
1357 exec {'/bin/csh'} '-sh'; # pretend it's a login shell
1359 When the arguments get executed via the system shell, results will
1360 be subject to its quirks and capabilities. See L<perlop/"`STRING`">
1363 Using an indirect object with C<exec> or C<system> is also more
1364 secure. This usage (which also works fine with system()) forces
1365 interpretation of the arguments as a multivalued list, even if the
1366 list had just one argument. That way you're safe from the shell
1367 expanding wildcards or splitting up words with whitespace in them.
1369 @args = ( "echo surprise" );
1371 exec @args; # subject to shell escapes
1373 exec { $args[0] } @args; # safe even with one-arg list
1375 The first version, the one without the indirect object, ran the I<echo>
1376 program, passing it C<"surprise"> an argument. The second version
1377 didn't--it tried to run a program literally called I<"echo surprise">,
1378 didn't find it, and set C<$?> to a non-zero value indicating failure.
1380 Note that C<exec> will not call your C<END> blocks, nor will it call
1381 any C<DESTROY> methods in your objects.
1385 Returns true if the specified hash key exists in its hash, even
1386 if the corresponding value is undefined.
1388 print "Exists\n" if exists $array{$key};
1389 print "Defined\n" if defined $array{$key};
1390 print "True\n" if $array{$key};
1392 A hash element can be true only if it's defined, and defined if
1393 it exists, but the reverse doesn't necessarily hold true.
1395 Note that the EXPR can be arbitrarily complicated as long as the final
1396 operation is a hash key lookup:
1398 if (exists $ref->{A}->{B}->{$key}) { }
1399 if (exists $hash{A}{B}{$key}) { }
1401 Although the last element will not spring into existence just because
1402 its existence was tested, intervening ones will. Thus C<$ref-E<gt>{"A"}>
1403 and C<$ref-E<gt>{"A"}-E<gt>{"B"}> will spring into existence due to the
1404 existence test for a $key element. This happens anywhere the arrow
1405 operator is used, including even
1408 if (exists $ref->{"Some key"}) { }
1409 print $ref; # prints HASH(0x80d3d5c)
1411 This surprising autovivification in what does not at first--or even
1412 second--glance appear to be an lvalue context may be fixed in a future
1417 Evaluates EXPR and exits immediately with that value. Example:
1420 exit 0 if $ans =~ /^[Xx]/;
1422 See also C<die>. If EXPR is omitted, exits with C<0> status. The only
1423 universally recognized values for EXPR are C<0> for success and C<1>
1424 for error; other values are subject to interpretation depending on the
1425 environment in which the Perl program is running. For example, exiting
1426 69 (EX_UNAVAILABLE) from a I<sendmail> incoming-mail filter will cause
1427 the mailer to return the item undelivered, but that's not true everywhere.
1429 Don't use C<exit> to abort a subroutine if there's any chance that
1430 someone might want to trap whatever error happened. Use C<die> instead,
1431 which can be trapped by an C<eval>.
1433 The exit() function does not always exit immediately. It calls any
1434 defined C<END> routines first, but these C<END> routines may not
1435 themselves abort the exit. Likewise any object destructors that need to
1436 be called are called before the real exit. If this is a problem, you
1437 can call C<POSIX:_exit($status)> to avoid END and destructor processing.
1438 See L<perlmod> for details.
1444 Returns I<e> (the natural logarithm base) to the power of EXPR.
1445 If EXPR is omitted, gives C<exp($_)>.
1447 =item fcntl FILEHANDLE,FUNCTION,SCALAR
1449 Implements the fcntl(2) function. You'll probably have to say
1453 first to get the correct constant definitions. Argument processing and
1454 value return works just like C<ioctl> below.
1458 fcntl($filehandle, F_GETFL, $packed_return_buffer)
1459 or die "can't fcntl F_GETFL: $!";
1461 You don't have to check for C<defined> on the return from C<fnctl>.
1462 Like C<ioctl>, it maps a C<0> return from the system call into C<"0
1463 but true"> in Perl. This string is true in boolean context and C<0>
1464 in numeric context. It is also exempt from the normal B<-w> warnings
1465 on improper numeric conversions.
1467 Note that C<fcntl> will produce a fatal error if used on a machine that
1468 doesn't implement fcntl(2). See the Fcntl module or your fcntl(2)
1469 manpage to learn what functions are available on your system.
1471 =item fileno FILEHANDLE
1473 Returns the file descriptor for a filehandle, or undefined if the
1474 filehandle is not open. This is mainly useful for constructing
1475 bitmaps for C<select> and low-level POSIX tty-handling operations.
1476 If FILEHANDLE is an expression, the value is taken as an indirect
1477 filehandle, generally its name.
1479 You can use this to find out whether two handles refer to the
1480 same underlying descriptor:
1482 if (fileno(THIS) == fileno(THAT)) {
1483 print "THIS and THAT are dups\n";
1486 =item flock FILEHANDLE,OPERATION
1488 Calls flock(2), or an emulation of it, on FILEHANDLE. Returns true
1489 for success, false on failure. Produces a fatal error if used on a
1490 machine that doesn't implement flock(2), fcntl(2) locking, or lockf(3).
1491 C<flock> is Perl's portable file locking interface, although it locks
1492 only entire files, not records.
1494 Two potentially non-obvious but traditional C<flock> semantics are
1495 that it waits indefinitely until the lock is granted, and that its locks
1496 B<merely advisory>. Such discretionary locks are more flexible, but offer
1497 fewer guarantees. This means that files locked with C<flock> may be
1498 modified by programs that do not also use C<flock>. See L<perlport>,
1499 your port's specific documentation, or your system-specific local manpages
1500 for details. It's best to assume traditional behavior if you're writing
1501 portable programs. (But if you're not, you should as always feel perfectly
1502 free to write for your own system's idiosyncrasies (sometimes called
1503 "features"). Slavish adherence to portability concerns shouldn't get
1504 in the way of your getting your job done.)
1506 OPERATION is one of LOCK_SH, LOCK_EX, or LOCK_UN, possibly combined with
1507 LOCK_NB. These constants are traditionally valued 1, 2, 8 and 4, but
1508 you can use the symbolic names if import them from the Fcntl module,
1509 either individually, or as a group using the ':flock' tag. LOCK_SH
1510 requests a shared lock, LOCK_EX requests an exclusive lock, and LOCK_UN
1511 releases a previously requested lock. If LOCK_NB is added to LOCK_SH or
1512 LOCK_EX then C<flock> will return immediately rather than blocking
1513 waiting for the lock (check the return status to see if you got it).
1515 To avoid the possibility of miscoordination, Perl now flushes FILEHANDLE
1516 before locking or unlocking it.
1518 Note that the emulation built with lockf(3) doesn't provide shared
1519 locks, and it requires that FILEHANDLE be open with write intent. These
1520 are the semantics that lockf(3) implements. Most if not all systems
1521 implement lockf(3) in terms of fcntl(2) locking, though, so the
1522 differing semantics shouldn't bite too many people.
1524 Note also that some versions of C<flock> cannot lock things over the
1525 network; you would need to use the more system-specific C<fcntl> for
1526 that. If you like you can force Perl to ignore your system's flock(2)
1527 function, and so provide its own fcntl(2)-based emulation, by passing
1528 the switch C<-Ud_flock> to the F<Configure> program when you configure
1531 Here's a mailbox appender for BSD systems.
1533 use Fcntl ':flock'; # import LOCK_* constants
1536 flock(MBOX,LOCK_EX);
1537 # and, in case someone appended
1538 # while we were waiting...
1543 flock(MBOX,LOCK_UN);
1546 open(MBOX, ">>/usr/spool/mail/$ENV{'USER'}")
1547 or die "Can't open mailbox: $!";
1550 print MBOX $msg,"\n\n";
1553 On systems that support a real flock(), locks are inherited across fork()
1554 calls, whereas those that must resort to the more capricious fcntl()
1555 function lose the locks, making it harder to write servers.
1557 See also L<DB_File> for other flock() examples.
1561 Does a fork(2) system call to create a new process running the
1562 same program at the same point. It returns the child pid to the
1563 parent process, C<0> to the child process, or C<undef> if the fork is
1564 unsuccessful. File descriptors (and sometimes locks on those descriptors)
1565 are shared, while everything else is copied. On most systems supporting
1566 fork(), great care has gone into making it extremely efficient (for
1567 example, using copy-on-write technology on data pages), making it the
1568 dominant paradigm for multitasking over the last few decades.
1570 All files opened for output are flushed before forking the child process.
1572 If you C<fork> without ever waiting on your children, you will
1573 accumulate zombies. On some systems, you can avoid this by setting
1574 C<$SIG{CHLD}> to C<"IGNORE">. See also L<perlipc> for more examples of
1575 forking and reaping moribund children.
1577 Note that if your forked child inherits system file descriptors like
1578 STDIN and STDOUT that are actually connected by a pipe or socket, even
1579 if you exit, then the remote server (such as, say, a CGI script or a
1580 backgrounded job launched from a remote shell) won't think you're done.
1581 You should reopen those to F</dev/null> if it's any issue.
1585 Declare a picture format for use by the C<write> function. For
1589 Test: @<<<<<<<< @||||| @>>>>>
1590 $str, $%, '$' . int($num)
1594 $num = $cost/$quantity;
1598 See L<perlform> for many details and examples.
1600 =item formline PICTURE,LIST
1602 This is an internal function used by C<format>s, though you may call it,
1603 too. It formats (see L<perlform>) a list of values according to the
1604 contents of PICTURE, placing the output into the format output
1605 accumulator, C<$^A> (or C<$ACCUMULATOR> in English).
1606 Eventually, when a C<write> is done, the contents of
1607 C<$^A> are written to some filehandle, but you could also read C<$^A>
1608 yourself and then set C<$^A> back to C<"">. Note that a format typically
1609 does one C<formline> per line of form, but the C<formline> function itself
1610 doesn't care how many newlines are embedded in the PICTURE. This means
1611 that the C<~> and C<~~> tokens will treat the entire PICTURE as a single line.
1612 You may therefore need to use multiple formlines to implement a single
1613 record format, just like the format compiler.
1615 Be careful if you put double quotes around the picture, because an C<@>
1616 character may be taken to mean the beginning of an array name.
1617 C<formline> always returns true. See L<perlform> for other examples.
1619 =item getc FILEHANDLE
1623 Returns the next character from the input file attached to FILEHANDLE,
1624 or the undefined value at end of file, or if there was an error.
1625 If FILEHANDLE is omitted, reads from STDIN. This is not particularly
1626 efficient. However, it cannot be used by itself to fetch single
1627 characters without waiting for the user to hit enter. For that, try
1628 something more like:
1631 system "stty cbreak </dev/tty >/dev/tty 2>&1";
1634 system "stty", '-icanon', 'eol', "\001";
1640 system "stty -cbreak </dev/tty >/dev/tty 2>&1";
1643 system "stty", 'icanon', 'eol', '^@'; # ASCII null
1647 Determination of whether $BSD_STYLE should be set
1648 is left as an exercise to the reader.
1650 The C<POSIX::getattr> function can do this more portably on
1651 systems purporting POSIX compliance. See also the C<Term::ReadKey>
1652 module from your nearest CPAN site; details on CPAN can be found on
1657 Implements the C library function of the same name, which on most
1658 systems returns the current login from F</etc/utmp>, if any. If null,
1661 $login = getlogin || getpwuid($<) || "Kilroy";
1663 Do not consider C<getlogin> for authentication: it is not as
1664 secure as C<getpwuid>.
1666 =item getpeername SOCKET
1668 Returns the packed sockaddr address of other end of the SOCKET connection.
1671 $hersockaddr = getpeername(SOCK);
1672 ($port, $iaddr) = sockaddr_in($hersockaddr);
1673 $herhostname = gethostbyaddr($iaddr, AF_INET);
1674 $herstraddr = inet_ntoa($iaddr);
1678 Returns the current process group for the specified PID. Use
1679 a PID of C<0> to get the current process group for the
1680 current process. Will raise an exception if used on a machine that
1681 doesn't implement getpgrp(2). If PID is omitted, returns process
1682 group of current process. Note that the POSIX version of C<getpgrp>
1683 does not accept a PID argument, so only C<PID==0> is truly portable.
1687 Returns the process id of the parent process.
1689 =item getpriority WHICH,WHO
1691 Returns the current priority for a process, a process group, or a user.
1692 (See L<getpriority(2)>.) Will raise a fatal exception if used on a
1693 machine that doesn't implement getpriority(2).
1699 =item gethostbyname NAME
1701 =item getnetbyname NAME
1703 =item getprotobyname NAME
1709 =item getservbyname NAME,PROTO
1711 =item gethostbyaddr ADDR,ADDRTYPE
1713 =item getnetbyaddr ADDR,ADDRTYPE
1715 =item getprotobynumber NUMBER
1717 =item getservbyport PORT,PROTO
1735 =item sethostent STAYOPEN
1737 =item setnetent STAYOPEN
1739 =item setprotoent STAYOPEN
1741 =item setservent STAYOPEN
1755 These routines perform the same functions as their counterparts in the
1756 system library. In list context, the return values from the
1757 various get routines are as follows:
1759 ($name,$passwd,$uid,$gid,
1760 $quota,$comment,$gcos,$dir,$shell,$expire) = getpw*
1761 ($name,$passwd,$gid,$members) = getgr*
1762 ($name,$aliases,$addrtype,$length,@addrs) = gethost*
1763 ($name,$aliases,$addrtype,$net) = getnet*
1764 ($name,$aliases,$proto) = getproto*
1765 ($name,$aliases,$port,$proto) = getserv*
1767 (If the entry doesn't exist you get a null list.)
1769 In scalar context, you get the name, unless the function was a
1770 lookup by name, in which case you get the other thing, whatever it is.
1771 (If the entry doesn't exist you get the undefined value.) For example:
1773 $uid = getpwnam($name);
1774 $name = getpwuid($num);
1776 $gid = getgrnam($name);
1777 $name = getgrgid($num;
1781 In I<getpw*()> the fields $quota, $comment, and $expire are
1782 special cases in the sense that in many systems they are unsupported.
1783 If the $quota is unsupported, it is an empty scalar. If it is
1784 supported, it usually encodes the disk quota. If the $comment
1785 field is unsupported, it is an empty scalar. If it is supported it
1786 usually encodes some administrative comment about the user. In some
1787 systems the $quota field may be $change or $age, fields that have
1788 to do with password aging. In some systems the $comment field may
1789 be $class. The $expire field, if present, encodes the expiration
1790 period of the account or the password. For the availability and the
1791 exact meaning of these fields in your system, please consult your
1792 getpwnam(3) documentation and your F<pwd.h> file. You can also find
1793 out from within Perl what your $quota and $comment fields mean
1794 and whether you have the $expire field by using the C<Config> module
1795 and the values C<d_pwquota>, C<d_pwage>, C<d_pwchange>, C<d_pwcomment>,
1796 and C<d_pwexpire>. Shadow password files are only supported if your
1797 vendor has implemented them in the intuitive fashion that calling the
1798 regular C library routines gets the shadow versions if you're running
1799 under privilege. Those that incorrectly implement a separate library
1800 call are not supported.
1802 The $members value returned by I<getgr*()> is a space separated list of
1803 the login names of the members of the group.
1805 For the I<gethost*()> functions, if the C<h_errno> variable is supported in
1806 C, it will be returned to you via C<$?> if the function call fails. The
1807 C<@addrs> value returned by a successful call is a list of the raw
1808 addresses returned by the corresponding system library call. In the
1809 Internet domain, each address is four bytes long and you can unpack it
1810 by saying something like:
1812 ($a,$b,$c,$d) = unpack('C4',$addr[0]);
1814 The Socket library makes this slightly easier:
1817 $iaddr = inet_aton("127.1"); # or whatever address
1818 $name = gethostbyaddr($iaddr, AF_INET);
1820 # or going the other way
1821 $straddr = inet_ntoa($iaddr);
1823 If you get tired of remembering which element of the return list
1824 contains which return value, by-name interfaces are provided
1825 in standard modules: C<File::stat>, C<Net::hostent>, C<Net::netent>,
1826 C<Net::protoent>, C<Net::servent>, C<Time::gmtime>, C<Time::localtime>,
1827 and C<User::grent>. These override the normal built-ins, supplying
1828 versions that return objects with the appropriate names
1829 for each field. For example:
1833 $is_his = (stat($filename)->uid == pwent($whoever)->uid);
1835 Even though it looks like they're the same method calls (uid),
1836 they aren't, because a C<File::stat> object is different from
1837 a C<User::pwent> object.
1839 =item getsockname SOCKET
1841 Returns the packed sockaddr address of this end of the SOCKET connection,
1842 in case you don't know the address because you have several different
1843 IPs that the connection might have come in on.
1846 $mysockaddr = getsockname(SOCK);
1847 ($port, $myaddr) = sockaddr_in($mysockaddr);
1848 printf "Connect to %s [%s]\n",
1849 scalar gethostbyaddr($myaddr, AF_INET),
1852 =item getsockopt SOCKET,LEVEL,OPTNAME
1854 Returns the socket option requested, or undef if there is an error.
1860 Returns the value of EXPR with filename expansions such as the
1861 standard Unix shell F</bin/csh> would do. This is the internal function
1862 implementing the C<E<lt>*.cE<gt>> operator, but you can use it directly.
1863 If EXPR is omitted, C<$_> is used. The C<E<lt>*.cE<gt>> operator is
1864 discussed in more detail in L<perlop/"I/O Operators">.
1868 Converts a time as returned by the time function to a 9-element list
1869 with the time localized for the standard Greenwich time zone.
1870 Typically used as follows:
1873 ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
1876 All list elements are numeric, and come straight out of a struct tm.
1877 In particular this means that $mon has the range C<0..11> and $wday
1878 has the range C<0..6> with sunday as day C<0>. Also, $year is the
1879 number of years since 1900, that is, $year is C<123> in year 2023,
1880 I<not> simply the last two digits of the year. If you assume it is,
1881 then you create non-Y2K-compliant programs--and you wouldn't want to do
1884 If EXPR is omitted, does C<gmtime(time())>.
1886 In scalar context, returns the ctime(3) value:
1888 $now_string = gmtime; # e.g., "Thu Oct 13 04:54:34 1994"
1890 Also see the C<timegm> function provided by the C<Time::Local> module,
1891 and the strftime(3) function available via the POSIX module.
1893 This scalar value is B<not> locale dependent (see L<perllocale>), but
1894 is instead a Perl builtin. Also see the C<Time::Local> module, and the
1895 strftime(3) and mktime(3) functions available via the POSIX module. To
1896 get somewhat similar but locale dependent date strings, set up your
1897 locale environment variables appropriately (please see L<perllocale>)
1898 and try for example:
1900 use POSIX qw(strftime);
1901 $now_string = strftime "%a %b %e %H:%M:%S %Y", gmtime;
1903 Note that the C<%a> and C<%b> escapes, which represent the short forms
1904 of the day of the week and the month of the year, may not necessarily
1905 be three characters wide in all locales.
1913 The C<goto-LABEL> form finds the statement labeled with LABEL and resumes
1914 execution there. It may not be used to go into any construct that
1915 requires initialization, such as a subroutine or a C<foreach> loop. It
1916 also can't be used to go into a construct that is optimized away,
1917 or to get out of a block or subroutine given to C<sort>.
1918 It can be used to go almost anywhere else within the dynamic scope,
1919 including out of subroutines, but it's usually better to use some other
1920 construct such as C<last> or C<die>. The author of Perl has never felt the
1921 need to use this form of C<goto> (in Perl, that is--C is another matter).
1923 The C<goto-EXPR> form expects a label name, whose scope will be resolved
1924 dynamically. This allows for computed C<goto>s per FORTRAN, but isn't
1925 necessarily recommended if you're optimizing for maintainability:
1927 goto ("FOO", "BAR", "GLARCH")[$i];
1929 The C<goto-&NAME> form is highly magical, and substitutes a call to the
1930 named subroutine for the currently running subroutine. This is used by
1931 C<AUTOLOAD> subroutines that wish to load another subroutine and then
1932 pretend that the other subroutine had been called in the first place
1933 (except that any modifications to C<@_> in the current subroutine are
1934 propagated to the other subroutine.) After the C<goto>, not even C<caller>
1935 will be able to tell that this routine was called first.
1937 =item grep BLOCK LIST
1939 =item grep EXPR,LIST
1941 This is similar in spirit to, but not the same as, grep(1) and its
1942 relatives. In particular, it is not limited to using regular expressions.
1944 Evaluates the BLOCK or EXPR for each element of LIST (locally setting
1945 C<$_> to each element) and returns the list value consisting of those
1946 elements for which the expression evaluated to true. In scalar
1947 context, returns the number of times the expression was true.
1949 @foo = grep(!/^#/, @bar); # weed out comments
1953 @foo = grep {!/^#/} @bar; # weed out comments
1955 Note that, because C<$_> is a reference into the list value, it can
1956 be used to modify the elements of the array. While this is useful and
1957 supported, it can cause bizarre results if the LIST is not a named array.
1958 Similarly, grep returns aliases into the original list, much as a for
1959 loop's index variable aliases the list elements. That is, modifying an
1960 element of a list returned by grep (for example, in a C<foreach>, C<map>
1961 or another C<grep>) actually modifies the element in the original list.
1962 This is usually something to be avoided when writing clear code.
1964 See also L</map> for a list composed of the results of the BLOCK or EXPR.
1970 Interprets EXPR as a hex string and returns the corresponding value.
1971 (To convert strings that might start with either 0, 0x, or 0b, see
1972 L</oct>.) If EXPR is omitted, uses C<$_>.
1974 print hex '0xAf'; # prints '175'
1975 print hex 'aF'; # same
1977 Hex strings may only represent integers. Strings that would cause
1978 integer overflow trigger a mandatory error message.
1982 There is no builtin C<import> function. It is just an ordinary
1983 method (subroutine) defined (or inherited) by modules that wish to export
1984 names to another module. The C<use> function calls the C<import> method
1985 for the package used. See also L</use()>, L<perlmod>, and L<Exporter>.
1987 =item index STR,SUBSTR,POSITION
1989 =item index STR,SUBSTR
1991 The index function searches for one string within another, but without
1992 the wildcard-like behavior of a full regular-expression pattern match.
1993 It returns the position of the first occurrence of SUBSTR in STR at
1994 or after POSITION. If POSITION is omitted, starts searching from the
1995 beginning of the string. The return value is based at C<0> (or whatever
1996 you've set the C<$[> variable to--but don't do that). If the substring
1997 is not found, returns one less than the base, ordinarily C<-1>.
2003 Returns the integer portion of EXPR. If EXPR is omitted, uses C<$_>.
2004 You should not use this function for rounding: one because it truncates
2005 towards C<0>, and two because machine representations of floating point
2006 numbers can sometimes produce counterintuitive results. For example,
2007 C<int(-6.725/0.025)> produces -268 rather than the correct -269; that's
2008 because it's really more like -268.99999999999994315658 instead. Usually,
2009 the C<sprintf>, C<printf>, or the C<POSIX::floor> and C<POSIX::ceil>
2010 functions will serve you better than will int().
2012 =item ioctl FILEHANDLE,FUNCTION,SCALAR
2014 Implements the ioctl(2) function. You'll probably first have to say
2016 require "ioctl.ph"; # probably in /usr/local/lib/perl/ioctl.ph
2018 to get the correct function definitions. If F<ioctl.ph> doesn't
2019 exist or doesn't have the correct definitions you'll have to roll your
2020 own, based on your C header files such as F<E<lt>sys/ioctl.hE<gt>>.
2021 (There is a Perl script called B<h2ph> that comes with the Perl kit that
2022 may help you in this, but it's nontrivial.) SCALAR will be read and/or
2023 written depending on the FUNCTION--a pointer to the string value of SCALAR
2024 will be passed as the third argument of the actual C<ioctl> call. (If SCALAR
2025 has no string value but does have a numeric value, that value will be
2026 passed rather than a pointer to the string value. To guarantee this to be
2027 true, add a C<0> to the scalar before using it.) The C<pack> and C<unpack>
2028 functions may be needed to manipulate the values of structures used by
2031 The return value of C<ioctl> (and C<fcntl>) is as follows:
2033 if OS returns: then Perl returns:
2035 0 string "0 but true"
2036 anything else that number
2038 Thus Perl returns true on success and false on failure, yet you can
2039 still easily determine the actual value returned by the operating
2042 $retval = ioctl(...) || -1;
2043 printf "System returned %d\n", $retval;
2045 The special string "C<0> but true" is exempt from B<-w> complaints
2046 about improper numeric conversions.
2048 Here's an example of setting a filehandle named C<REMOTE> to be
2049 non-blocking at the system level. You'll have to negotiate C<$|>
2050 on your own, though.
2052 use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
2054 $flags = fcntl(REMOTE, F_GETFL, 0)
2055 or die "Can't get flags for the socket: $!\n";
2057 $flags = fcntl(REMOTE, F_SETFL, $flags | O_NONBLOCK)
2058 or die "Can't set flags for the socket: $!\n";
2060 =item join EXPR,LIST
2062 Joins the separate strings of LIST into a single string with fields
2063 separated by the value of EXPR, and returns that new string. Example:
2065 $rec = join(':', $login,$passwd,$uid,$gid,$gcos,$home,$shell);
2071 Returns a list consisting of all the keys of the named hash. (In
2072 scalar context, returns the number of keys.) The keys are returned in
2073 an apparently random order. The actual random order is subject to
2074 change in future versions of perl, but it is guaranteed to be the same
2075 order as either the C<values> or C<each> function produces (given
2076 that the hash has not been modified). As a side effect, it resets
2079 Here is yet another way to print your environment:
2082 @values = values %ENV;
2084 print pop(@keys), '=', pop(@values), "\n";
2087 or how about sorted by key:
2089 foreach $key (sort(keys %ENV)) {
2090 print $key, '=', $ENV{$key}, "\n";
2093 To sort a hash by value, you'll need to use a C<sort> function.
2094 Here's a descending numeric sort of a hash by its values:
2096 foreach $key (sort { $hash{$b} <=> $hash{$a} } keys %hash) {
2097 printf "%4d %s\n", $hash{$key}, $key;
2100 As an lvalue C<keys> allows you to increase the number of hash buckets
2101 allocated for the given hash. This can gain you a measure of efficiency if
2102 you know the hash is going to get big. (This is similar to pre-extending
2103 an array by assigning a larger number to $#array.) If you say
2107 then C<%hash> will have at least 200 buckets allocated for it--256 of them,
2108 in fact, since it rounds up to the next power of two. These
2109 buckets will be retained even if you do C<%hash = ()>, use C<undef
2110 %hash> if you want to free the storage while C<%hash> is still in scope.
2111 You can't shrink the number of buckets allocated for the hash using
2112 C<keys> in this way (but you needn't worry about doing this by accident,
2113 as trying has no effect).
2115 See also C<each>, C<values> and C<sort>.
2119 Sends a signal to a list of processes. The first element of
2120 the list must be the signal to send. Returns the number of
2121 processes successfully signaled (which is not necessarily the
2122 same as the number actually killed).
2124 $cnt = kill 1, $child1, $child2;
2127 Unlike in the shell, in Perl if the I<SIGNAL> is negative, it kills
2128 process groups instead of processes. (On System V, a negative I<PROCESS>
2129 number will also kill process groups, but that's not portable.) That
2130 means you usually want to use positive not negative signals. You may also
2131 use a signal name in quotes. See L<perlipc/"Signals"> for details.
2137 The C<last> command is like the C<break> statement in C (as used in
2138 loops); it immediately exits the loop in question. If the LABEL is
2139 omitted, the command refers to the innermost enclosing loop. The
2140 C<continue> block, if any, is not executed:
2142 LINE: while (<STDIN>) {
2143 last LINE if /^$/; # exit when done with header
2147 C<last> cannot be used to exit a block which returns a value such as
2148 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
2149 a grep() or map() operation.
2151 See also L</continue> for an illustration of how C<last>, C<next>, and
2158 Returns an lowercased version of EXPR. This is the internal function
2159 implementing the C<\L> escape in double-quoted strings.
2160 Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale>
2163 If EXPR is omitted, uses C<$_>.
2169 Returns the value of EXPR with the first character lowercased. This is
2170 the internal function implementing the C<\l> escape in double-quoted strings.
2171 Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale>.
2173 If EXPR is omitted, uses C<$_>.
2179 Returns the length in characters of the value of EXPR. If EXPR is
2180 omitted, returns length of C<$_>. Note that this cannot be used on
2181 an entire array or hash to find out how many elements these have.
2182 For that, use C<scalar @array> and C<scalar keys %hash> respectively.
2184 =item link OLDFILE,NEWFILE
2186 Creates a new filename linked to the old filename. Returns true for
2187 success, false otherwise.
2189 =item listen SOCKET,QUEUESIZE
2191 Does the same thing that the listen system call does. Returns true if
2192 it succeeded, false otherwise. See the example in L<perlipc/"Sockets: Client/Server Communication">.
2196 You really probably want to be using C<my> instead, because C<local> isn't
2197 what most people think of as "local". See L<perlsub/"Private Variables
2198 via my()"> for details.
2200 A local modifies the listed variables to be local to the enclosing
2201 block, file, or eval. If more than one value is listed, the list must
2202 be placed in parentheses. See L<perlsub/"Temporary Values via local()">
2203 for details, including issues with tied arrays and hashes.
2205 =item localtime EXPR
2207 Converts a time as returned by the time function to a 9-element list
2208 with the time analyzed for the local time zone. Typically used as
2212 ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
2215 All list elements are numeric, and come straight out of a struct tm.
2216 In particular this means that $mon has the range C<0..11> and $wday
2217 has the range C<0..6> with sunday as day C<0>. Also, $year is the
2218 number of years since 1900, that is, $year is C<123> in year 2023,
2219 and I<not> simply the last two digits of the year. If you assume it is,
2220 then you create non-Y2K-compliant programs--and you wouldn't want to do
2223 If EXPR is omitted, uses the current time (C<localtime(time)>).
2225 In scalar context, returns the ctime(3) value:
2227 $now_string = localtime; # e.g., "Thu Oct 13 04:54:34 1994"
2229 This scalar value is B<not> locale dependent, see L<perllocale>, but
2230 instead a Perl builtin. Also see the C<Time::Local> module
2231 (to convert the second, minutes, hours, ... back to seconds since the
2232 stroke of midnight the 1st of January 1970, the value returned by
2233 time()), and the strftime(3) and mktime(3) function available via the
2234 POSIX module. To get somewhat similar but locale dependent date
2235 strings, set up your locale environment variables appropriately
2236 (please see L<perllocale>) and try for example:
2238 use POSIX qw(strftime);
2239 $now_string = strftime "%a %b %e %H:%M:%S %Y", localtime;
2241 Note that the C<%a> and C<%b>, the short forms of the day of the week
2242 and the month of the year, may not necessarily be three characters wide.
2248 This function places an advisory lock on a variable, subroutine,
2249 or referenced object contained in I<THING> until the lock goes out
2250 of scope. This is a built-in function only if your version of Perl
2251 was built with threading enabled, and if you've said C<use Threads>.
2252 Otherwise a user-defined function by this name will be called. See
2259 Returns the natural logarithm (base I<e>) of EXPR. If EXPR is omitted,
2260 returns log of C<$_>. To get the log of another base, use basic algebra:
2261 The base-N log of a number is equal to the natural log of that number
2262 divided by the natural log of N. For example:
2266 return log($n)/log(10);
2269 See also L</exp> for the inverse operation.
2271 =item lstat FILEHANDLE
2277 Does the same thing as the C<stat> function (including setting the
2278 special C<_> filehandle) but stats a symbolic link instead of the file
2279 the symbolic link points to. If symbolic links are unimplemented on
2280 your system, a normal C<stat> is done.
2282 If EXPR is omitted, stats C<$_>.
2286 The match operator. See L<perlop>.
2288 =item map BLOCK LIST
2292 Evaluates the BLOCK or EXPR for each element of LIST (locally setting
2293 C<$_> to each element) and returns the list value composed of the
2294 results of each such evaluation. In scalar context, returns the
2295 total number of elements so generated. Evaluates BLOCK or EXPR in
2296 list context, so each element of LIST may produce zero, one, or
2297 more elements in the returned value.
2299 @chars = map(chr, @nums);
2301 translates a list of numbers to the corresponding characters. And
2303 %hash = map { getkey($_) => $_ } @array;
2305 is just a funny way to write
2308 foreach $_ (@array) {
2309 $hash{getkey($_)} = $_;
2312 Note that, because C<$_> is a reference into the list value, it can
2313 be used to modify the elements of the array. While this is useful and
2314 supported, it can cause bizarre results if the LIST is not a named array.
2315 Using a regular C<foreach> loop for this purpose would be clearer in
2316 most cases. See also L</grep> for an array composed of those items of
2317 the original list for which the BLOCK or EXPR evaluates to true.
2319 =item mkdir FILENAME,MASK
2321 Creates the directory specified by FILENAME, with permissions
2322 specified by MASK (as modified by C<umask>). If it succeeds it
2323 returns true, otherwise it returns false and sets C<$!> (errno).
2325 In general, it is better to create directories with permissive MASK,
2326 and let the user modify that with their C<umask>, than it is to supply
2327 a restrictive MASK and give the user no way to be more permissive.
2328 The exceptions to this rule are when the file or directory should be
2329 kept private (mail files, for instance). The perlfunc(1) entry on
2330 C<umask> discusses the choice of MASK in more detail.
2332 =item msgctl ID,CMD,ARG
2334 Calls the System V IPC function msgctl(2). You'll probably have to say
2338 first to get the correct constant definitions. If CMD is C<IPC_STAT>,
2339 then ARG must be a variable which will hold the returned C<msqid_ds>
2340 structure. Returns like C<ioctl>: the undefined value for error, C<"0 but
2341 true"> for zero, or the actual return value otherwise. See also
2342 C<IPC::SysV> and C<IPC::Semaphore> documentation.
2344 =item msgget KEY,FLAGS
2346 Calls the System V IPC function msgget(2). Returns the message queue
2347 id, or the undefined value if there is an error. See also C<IPC::SysV>
2348 and C<IPC::Msg> documentation.
2350 =item msgsnd ID,MSG,FLAGS
2352 Calls the System V IPC function msgsnd to send the message MSG to the
2353 message queue ID. MSG must begin with the long integer message type,
2354 which may be created with C<pack("l", $type)>. Returns true if
2355 successful, or false if there is an error. See also C<IPC::SysV>
2356 and C<IPC::SysV::Msg> documentation.
2358 =item msgrcv ID,VAR,SIZE,TYPE,FLAGS
2360 Calls the System V IPC function msgrcv to receive a message from
2361 message queue ID into variable VAR with a maximum message size of
2362 SIZE. Note that if a message is received, the message type will be
2363 the first thing in VAR, and the maximum length of VAR is SIZE plus the
2364 size of the message type. Returns true if successful, or false if
2365 there is an error. See also C<IPC::SysV> and C<IPC::SysV::Msg> documentation.
2369 A C<my> declares the listed variables to be local (lexically) to the
2370 enclosing block, file, or C<eval>. If
2371 more than one value is listed, the list must be placed in parentheses. See
2372 L<perlsub/"Private Variables via my()"> for details.
2378 The C<next> command is like the C<continue> statement in C; it starts
2379 the next iteration of the loop:
2381 LINE: while (<STDIN>) {
2382 next LINE if /^#/; # discard comments
2386 Note that if there were a C<continue> block on the above, it would get
2387 executed even on discarded lines. If the LABEL is omitted, the command
2388 refers to the innermost enclosing loop.
2390 C<next> cannot be used to exit a block which returns a value such as
2391 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
2392 a grep() or map() operation.
2394 See also L</continue> for an illustration of how C<last>, C<next>, and
2397 =item no Module LIST
2399 See the L</use> function, which C<no> is the opposite of.
2405 Interprets EXPR as an octal string and returns the corresponding
2406 value. (If EXPR happens to start off with C<0x>, interprets it as a
2407 hex string. If EXPR starts off with C<0b>, it is interpreted as a
2408 binary string.) The following will handle decimal, binary, octal, and
2409 hex in the standard Perl or C notation:
2411 $val = oct($val) if $val =~ /^0/;
2413 If EXPR is omitted, uses C<$_>. To go the other way (produce a number
2414 in octal), use sprintf() or printf():
2416 $perms = (stat("filename"))[2] & 07777;
2417 $oct_perms = sprintf "%lo", $perms;
2419 The oct() function is commonly used when a string such as C<644> needs
2420 to be converted into a file mode, for example. (Although perl will
2421 automatically convert strings into numbers as needed, this automatic
2422 conversion assumes base 10.)
2424 =item open FILEHANDLE,MODE,EXPR
2426 =item open FILEHANDLE,EXPR
2428 =item open FILEHANDLE
2430 Opens the file whose filename is given by EXPR, and associates it with
2431 FILEHANDLE. If FILEHANDLE is an expression, its value is used as the
2432 name of the real filehandle wanted. If EXPR is omitted, the scalar
2433 variable of the same name as the FILEHANDLE contains the filename.
2434 (Note that lexical variables--those declared with C<my>--will not work
2435 for this purpose; so if you're using C<my>, specify EXPR in your call
2436 to open.) See L<perlopentut> for a kinder, gentler explanation of opening
2439 If MODE is C<'E<lt>'> or nothing, the file is opened for input.
2440 If MODE is C<'E<gt>'>, the file is truncated and opened for
2441 output, being created if necessary. If MODE is C<'E<gt>E<gt>'>,
2442 the file is opened for appending, again being created if necessary.
2443 You can put a C<'+'> in front of the C<'E<gt>'> or C<'E<lt>'> to indicate that
2444 you want both read and write access to the file; thus C<'+E<lt>'> is almost
2445 always preferred for read/write updates--the C<'+E<gt>'> mode would clobber the
2446 file first. You can't usually use either read-write mode for updating
2447 textfiles, since they have variable length records. See the B<-i>
2448 switch in L<perlrun> for a better approach. The file is created with
2449 permissions of C<0666> modified by the process' C<umask> value.
2451 These various prefixes correspond to the fopen(3) modes of C<'r'>, C<'r+'>, C<'w'>,
2452 C<'w+'>, C<'a'>, and C<'a+'>.
2454 In the 2-arguments (and 1-argument) form of the call the mode and
2455 filename should be concatenated (in this order), possibly separated by
2456 spaces. It is possible to omit the mode if the mode is C<'E<lt>'>.
2458 If the filename begins with C<'|'>, the filename is interpreted as a
2459 command to which output is to be piped, and if the filename ends with a
2460 C<'|'>, the filename is interpreted as a command which pipes output to
2461 us. See L<perlipc/"Using open() for IPC">
2462 for more examples of this. (You are not allowed to C<open> to a command
2463 that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>,
2464 and L<perlipc/"Bidirectional Communication"> for alternatives.)
2466 If MODE is C<'|-'>, the filename is interpreted as a
2467 command to which output is to be piped, and if MODE is
2468 C<'-|'>, the filename is interpreted as a command which pipes output to
2469 us. In the 2-arguments (and 1-argument) form one should replace dash
2470 (C<'-'>) with the command. See L<perlipc/"Using open() for IPC">
2471 for more examples of this. (You are not allowed to C<open> to a command
2472 that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>,
2473 and L<perlipc/"Bidirectional Communication"> for alternatives.)
2475 In the 2-arguments (and 1-argument) form opening C<'-'> opens STDIN
2476 and opening C<'E<gt>-'> opens STDOUT.
2479 nonzero upon success, the undefined value otherwise. If the C<open>
2480 involved a pipe, the return value happens to be the pid of the
2483 If you're unfortunate enough to be running Perl on a system that
2484 distinguishes between text files and binary files (modern operating
2485 systems don't care), then you should check out L</binmode> for tips for
2486 dealing with this. The key distinction between systems that need C<binmode>
2487 and those that don't is their text file formats. Systems like Unix, MacOS, and
2488 Plan9, which delimit lines with a single character, and which encode that
2489 character in C as C<"\n">, do not need C<binmode>. The rest need it.
2491 When opening a file, it's usually a bad idea to continue normal execution
2492 if the request failed, so C<open> is frequently used in connection with
2493 C<die>. Even if C<die> won't do what you want (say, in a CGI script,
2494 where you want to make a nicely formatted error message (but there are
2495 modules that can help with that problem)) you should always check
2496 the return value from opening a file. The infrequent exception is when
2497 working with an unopened filehandle is actually what you want to do.
2502 open ARTICLE or die "Can't find article $ARTICLE: $!\n";
2503 while (<ARTICLE>) {...
2505 open(LOG, '>>/usr/spool/news/twitlog'); # (log is reserved)
2506 # if the open fails, output is discarded
2508 open(DBASE, '+<', 'dbase.mine') # open for update
2509 or die "Can't open 'dbase.mine' for update: $!";
2511 open(DBASE, '+<dbase.mine') # ditto
2512 or die "Can't open 'dbase.mine' for update: $!";
2514 open(ARTICLE, '-|', "caesar <$article") # decrypt article
2515 or die "Can't start caesar: $!";
2517 open(ARTICLE, "caesar <$article |") # ditto
2518 or die "Can't start caesar: $!";
2520 open(EXTRACT, "|sort >/tmp/Tmp$$") # $$ is our process id
2521 or die "Can't start sort: $!";
2523 # process argument list of files along with any includes
2525 foreach $file (@ARGV) {
2526 process($file, 'fh00');
2530 my($filename, $input) = @_;
2531 $input++; # this is a string increment
2532 unless (open($input, $filename)) {
2533 print STDERR "Can't open $filename: $!\n";
2538 while (<$input>) { # note use of indirection
2539 if (/^#include "(.*)"/) {
2540 process($1, $input);
2547 You may also, in the Bourne shell tradition, specify an EXPR beginning
2548 with C<'E<gt>&'>, in which case the rest of the string is interpreted as the
2549 name of a filehandle (or file descriptor, if numeric) to be
2550 duped and opened. You may use C<&> after C<E<gt>>, C<E<gt>E<gt>>,
2551 C<E<lt>>, C<+E<gt>>, C<+E<gt>E<gt>>, and C<+E<lt>>. The
2552 mode you specify should match the mode of the original filehandle.
2553 (Duping a filehandle does not take into account any existing contents of
2554 stdio buffers.) Duping file handles is not yet supported for 3-argument
2557 Here is a script that saves, redirects, and restores STDOUT and
2561 open(OLDOUT, ">&STDOUT");
2562 open(OLDERR, ">&STDERR");
2564 open(STDOUT, '>', "foo.out") || die "Can't redirect stdout";
2565 open(STDERR, ">&STDOUT") || die "Can't dup stdout";
2567 select(STDERR); $| = 1; # make unbuffered
2568 select(STDOUT); $| = 1; # make unbuffered
2570 print STDOUT "stdout 1\n"; # this works for
2571 print STDERR "stderr 1\n"; # subprocesses too
2576 open(STDOUT, ">&OLDOUT");
2577 open(STDERR, ">&OLDERR");
2579 print STDOUT "stdout 2\n";
2580 print STDERR "stderr 2\n";
2582 If you specify C<'E<lt>&=N'>, where C<N> is a number, then Perl will do an
2583 equivalent of C's C<fdopen> of that file descriptor; this is more
2584 parsimonious of file descriptors. For example:
2586 open(FILEHANDLE, "<&=$fd")
2588 If you open a pipe on the command C<'-'>, i.e., either C<'|-'> or C<'-|'>
2589 with 2-arguments (or 1-argument) form of open(), then
2590 there is an implicit fork done, and the return value of open is the pid
2591 of the child within the parent process, and C<0> within the child
2592 process. (Use C<defined($pid)> to determine whether the open was successful.)
2593 The filehandle behaves normally for the parent, but i/o to that
2594 filehandle is piped from/to the STDOUT/STDIN of the child process.
2595 In the child process the filehandle isn't opened--i/o happens from/to
2596 the new STDOUT or STDIN. Typically this is used like the normal
2597 piped open when you want to exercise more control over just how the
2598 pipe command gets executed, such as when you are running setuid, and
2599 don't want to have to scan shell commands for metacharacters.
2600 The following triples are more or less equivalent:
2602 open(FOO, "|tr '[a-z]' '[A-Z]'");
2603 open(FOO, '|-', "tr '[a-z]' '[A-Z]'");
2604 open(FOO, '|-') || exec 'tr', '[a-z]', '[A-Z]';
2606 open(FOO, "cat -n '$file'|");
2607 open(FOO, '-|', "cat -n '$file'");
2608 open(FOO, '-|') || exec 'cat', '-n', $file;
2610 See L<perlipc/"Safe Pipe Opens"> for more examples of this.
2612 NOTE: On any operation that may do a fork, all files opened for output
2613 are flushed before the fork is attempted. On systems that support a
2614 close-on-exec flag on files, the flag will be set for the newly opened
2615 file descriptor as determined by the value of $^F. See L<perlvar/$^F>.
2617 Closing any piped filehandle causes the parent process to wait for the
2618 child to finish, and returns the status value in C<$?>.
2620 The filename passed to 2-argument (or 1-argument) form of open()
2621 will have leading and trailing
2622 whitespace deleted, and the normal redirection characters
2623 honored. This property, known as "magic open",
2624 can often be used to good effect. A user could specify a filename of
2625 F<"rsh cat file |">, or you could change certain filenames as needed:
2627 $filename =~ s/(.*\.gz)\s*$/gzip -dc < $1|/;
2628 open(FH, $filename) or die "Can't open $filename: $!";
2630 Use 3-argument form to open a file with arbitrary weird characters in it,
2632 open(FOO, '<', $file);
2634 otherwise it's necessary to protect any leading and trailing whitespace:
2636 $file =~ s#^(\s)#./$1#;
2637 open(FOO, "< $file\0");
2639 (this may not work on some bizzare filesystems). One should
2640 conscientiously choose between the the I<magic> and 3-arguments form
2645 will allow the user to specify an argument of the form C<"rsh cat file |">,
2646 but will not work on a filename which happens to have a trailing space, while
2648 open IN, '<', $ARGV[0];
2650 will have exactly the opposite restrictions.
2652 If you want a "real" C C<open> (see L<open(2)> on your system), then you
2653 should use the C<sysopen> function, which involves no such magic (but
2654 may use subtly different filemodes than Perl open(), which is mapped
2655 to C fopen()). This is
2656 another way to protect your filenames from interpretation. For example:
2659 sysopen(HANDLE, $path, O_RDWR|O_CREAT|O_EXCL)
2660 or die "sysopen $path: $!";
2661 $oldfh = select(HANDLE); $| = 1; select($oldfh);
2662 print HANDLE "stuff $$\n");
2664 print "File contains: ", <HANDLE>;
2666 Using the constructor from the C<IO::Handle> package (or one of its
2667 subclasses, such as C<IO::File> or C<IO::Socket>), you can generate anonymous
2668 filehandles that have the scope of whatever variables hold references to
2669 them, and automatically close whenever and however you leave that scope:
2673 sub read_myfile_munged {
2675 my $handle = new IO::File;
2676 open($handle, "myfile") or die "myfile: $!";
2678 or return (); # Automatically closed here.
2679 mung $first or die "mung failed"; # Or here.
2680 return $first, <$handle> if $ALL; # Or here.
2684 See L</seek> for some details about mixing reading and writing.
2686 =item opendir DIRHANDLE,EXPR
2688 Opens a directory named EXPR for processing by C<readdir>, C<telldir>,
2689 C<seekdir>, C<rewinddir>, and C<closedir>. Returns true if successful.
2690 DIRHANDLEs have their own namespace separate from FILEHANDLEs.
2696 Returns the numeric (ASCII or Unicode) value of the first character of EXPR. If
2697 EXPR is omitted, uses C<$_>. For the reverse, see L</chr>.
2698 See L<utf8> for more about Unicode.
2700 =item pack TEMPLATE,LIST
2702 Takes a list of values and packs it into a binary structure,
2703 returning the string containing the structure. The TEMPLATE is a
2704 sequence of characters that give the order and type of values, as
2707 a A string with arbitrary binary data, will be null padded.
2708 A An ascii string, will be space padded.
2709 Z A null terminated (asciz) string, will be null padded.
2711 b A bit string (ascending bit order, like vec()).
2712 B A bit string (descending bit order).
2713 h A hex string (low nybble first).
2714 H A hex string (high nybble first).
2716 c A signed char value.
2717 C An unsigned char value. Only does bytes. See U for Unicode.
2719 s A signed short value.
2720 S An unsigned short value.
2721 (This 'short' is _exactly_ 16 bits, which may differ from
2722 what a local C compiler calls 'short'. If you want
2723 native-length shorts, use the '!' suffix.)
2725 i A signed integer value.
2726 I An unsigned integer value.
2727 (This 'integer' is _at_least_ 32 bits wide. Its exact
2728 size depends on what a local C compiler calls 'int',
2729 and may even be larger than the 'long' described in
2732 l A signed long value.
2733 L An unsigned long value.
2734 (This 'long' is _exactly_ 32 bits, which may differ from
2735 what a local C compiler calls 'long'. If you want
2736 native-length longs, use the '!' suffix.)
2738 n A short in "network" (big-endian) order.
2739 N A long in "network" (big-endian) order.
2740 v A short in "VAX" (little-endian) order.
2741 V A long in "VAX" (little-endian) order.
2742 (These 'shorts' and 'longs' are _exactly_ 16 bits and
2743 _exactly_ 32 bits, respectively.)
2745 q A signed quad (64-bit) value.
2746 Q An unsigned quad value.
2747 (Quads are available only if your system supports 64-bit
2748 integer values _and_ if Perl has been compiled to support those.
2749 Causes a fatal error otherwise.)
2751 f A single-precision float in the native format.
2752 d A double-precision float in the native format.
2754 p A pointer to a null-terminated string.
2755 P A pointer to a structure (fixed-length string).
2757 u A uuencoded string.
2758 U A Unicode character number. Encodes to UTF-8 internally.
2759 Works even if C<use utf8> is not in effect.
2761 w A BER compressed integer. Its bytes represent an unsigned
2762 integer in base 128, most significant digit first, with as
2763 few digits as possible. Bit eight (the high bit) is set
2764 on each byte except the last.
2768 @ Null fill to absolute position.
2770 The following rules apply:
2776 Each letter may optionally be followed by a number giving a repeat
2777 count. With all types except C<"a">, C<"A">, C<"Z">, C<"b">, C<"B">, C<"h">,
2778 C<"H">, and C<"P"> the pack function will gobble up that many values from
2779 the LIST. A C<*> for the repeat count means to use however many items are
2784 The C<"a">, C<"A">, and C<"Z"> types gobble just one value, but pack it as a
2785 string of length count, padding with nulls or spaces as necessary. When
2786 unpacking, C<"A"> strips trailing spaces and nulls, C<"Z"> strips everything
2787 after the first null, and C<"a"> returns data verbatim.
2791 Likewise, the C<"b"> and C<"B"> fields pack a string that many bits long.
2795 The C<"h"> and C<"H"> fields pack a string that many nybbles (4-bit groups,
2796 representable as hexadecimal digits, 0-9a-f) long.
2800 The C<"p"> type packs a pointer to a null-terminated string. You are
2801 responsible for ensuring the string is not a temporary value (which can
2802 potentially get deallocated before you get around to using the packed result).
2803 The C<"P"> type packs a pointer to a structure of the size indicated by the
2804 length. A NULL pointer is created if the corresponding value for C<"p"> or
2809 The C<"#"> character allows packing and unpacking of strings where the
2810 packed structure contains a byte count followed by the string itself.
2811 You write I<length-item>C<#>I<string-item>.
2813 The I<length-item> can be any C<pack> template letter,
2814 and describes how the length value is packed.
2815 The ones likely to be of most use are integer-packing ones like
2816 C<"n"> (for Java strings), C<"w"> (for ASN.1 or SNMP)
2817 and C<"N"> (for Sun XDR).
2819 The I<string-item> must, at present, be C<"A*">, C<"a*"> or C<"Z*">.
2820 For C<unpack> the length of the string is obtained from the I<length-item>,
2821 but if you put in the '*' it will be ignored.
2823 unpack 'C#a', "\04Gurusamy"; gives 'Guru'
2824 unpack 'a3#A* A*', '007 Bond J '; gives (' Bond','J')
2825 pack 'n#a* w#a*','hello,','world'; gives "\000\006hello,\005world"
2827 The I<length-item> is not returned explicitly from C<unpack>.
2829 Adding a count to the I<length-item> letter
2830 is unlikely to do anything useful,
2831 unless that letter is C<"A">, C<"a"> or C<"Z">.
2832 Packing with a I<length-item> of C<"a"> or C<"Z">
2833 may introduce C<"\000"> characters,
2834 which Perl does not regard as legal in numeric strings.
2838 The integer types C<"s">, C<"S">, C<"l">, and C<"L"> may be
2839 immediately followed by a C<"!"> suffix to signify native shorts or
2840 longs--as you can see from above for example a bare C<"l"> does mean
2841 exactly 32 bits, the native C<long> (as seen by the local C compiler)
2842 may be larger. This is an issue mainly in 64-bit platforms. You can
2843 see whether using C<"!"> makes any difference by
2845 print length(pack("s")), " ", length(pack("s!")), "\n";
2846 print length(pack("l")), " ", length(pack("l!")), "\n";
2848 C<"i!"> and C<"I!"> also work but only because of completeness;
2849 they are identical to C<"i"> and C<"I">.
2851 The actual sizes (in bytes) of native shorts, ints, longs, and long
2852 longs on the platform where Perl was built are also available via
2856 print $Config{shortsize}, "\n";
2857 print $Config{intsize}, "\n";
2858 print $Config{longsize}, "\n";
2859 print $Config{longlongsize}, "\n";
2861 (The C<$Config{longlongsize}> will be empty if your system does
2862 not support long longs.)
2866 The integer formats C<"s">, C<"S">, C<"i">, C<"I">, C<"l">, and C<"L">
2867 are inherently non-portable between processors and operating systems
2868 because they obey the native byteorder and endianness. For example a
2869 4-byte integer 0x87654321 (2271560481 decimal) be ordered natively
2870 (arranged in and handled by the CPU registers) into bytes as
2872 0x12 0x34 0x56 0x78 # little-endian
2873 0x78 0x56 0x34 0x12 # big-endian
2875 Basically, the Intel, Alpha, and VAX CPUs and little-endian, while
2876 everybody else, for example Motorola m68k/88k, PPC, Sparc, HP PA,
2877 Power, and Cray are big-endian. MIPS can be either: Digital used it
2878 in little-endian mode; SGI uses it in big-endian mode.
2880 The names `big-endian' and `little-endian' are comic references to
2881 the classic "Gulliver's Travels" (via the paper "On Holy Wars and a
2882 Plea for Peace" by Danny Cohen, USC/ISI IEN 137, April 1, 1980) and
2883 the egg-eating habits of the Lilliputians.
2885 Some systems may even have weird byte orders such as
2890 You can see your system's preference with
2892 print join(" ", map { sprintf "%#02x", $_ }
2893 unpack("C*",pack("L",0x12345678))), "\n";
2895 The byteorder on the platform where Perl was built is also available
2899 print $Config{byteorder}, "\n";
2901 Byteorders C<'1234'> and C<'12345678'> are little-endian, C<'4321'>
2902 and C<'87654321'> are big-endian.
2904 If you want portable packed integers use the formats C<"n">, C<"N">,
2905 C<"v">, and C<"V">, their byte endianness and size is known.
2906 See also L<perlport>.
2910 Real numbers (floats and doubles) are in the native machine format only;
2911 due to the multiplicity of floating formats around, and the lack of a
2912 standard "network" representation, no facility for interchange has been
2913 made. This means that packed floating point data written on one machine
2914 may not be readable on another - even if both use IEEE floating point
2915 arithmetic (as the endian-ness of the memory representation is not part
2916 of the IEEE spec). See also L<perlport>.
2918 Note that Perl uses doubles internally for all numeric calculation, and
2919 converting from double into float and thence back to double again will
2920 lose precision (i.e., C<unpack("f", pack("f", $foo)>) will not in general
2925 You must yourself do any alignment or padding by inserting for example
2926 enough C<'x'>es while packing. There is no way to pack() and unpack()
2927 could know where the bytes are going to or coming from. Therefore
2928 C<pack> (and C<unpack>) handle their output and input as flat
2935 $foo = pack("CCCC",65,66,67,68);
2937 $foo = pack("C4",65,66,67,68);
2939 $foo = pack("U4",0x24b6,0x24b7,0x24b8,0x24b9);
2940 # same thing with Unicode circled letters
2942 $foo = pack("ccxxcc",65,66,67,68);
2945 # note: the above examples featuring "C" and "c" are true
2946 # only on ASCII and ASCII-derived systems such as ISO Latin 1
2947 # and UTF-8. In EBCDIC the first example would be
2948 # $foo = pack("CCCC",193,194,195,196);
2950 $foo = pack("s2",1,2);
2951 # "\1\0\2\0" on little-endian
2952 # "\0\1\0\2" on big-endian
2954 $foo = pack("a4","abcd","x","y","z");
2957 $foo = pack("aaaa","abcd","x","y","z");
2960 $foo = pack("a14","abcdefg");
2961 # "abcdefg\0\0\0\0\0\0\0"
2963 $foo = pack("i9pl", gmtime);
2964 # a real struct tm (on my system anyway)
2966 $utmp_template = "Z8 Z8 Z16 L";
2967 $utmp = pack($utmp_template, @utmp1);
2968 # a struct utmp (BSDish)
2970 @utmp2 = unpack($utmp_template, $utmp);
2971 # "@utmp1" eq "@utmp2"
2974 unpack("N", pack("B32", substr("0" x 32 . shift, -32)));
2977 $foo = pack('sx2l', 12, 34);
2978 # short 12, two zero bytes padding, long 34
2979 $bar = pack('s@4l', 12, 34);
2980 # short 12, zero fill to position 4, long 34
2983 The same template may generally also be used in unpack().
2987 =item package NAMESPACE
2989 Declares the compilation unit as being in the given namespace. The scope
2990 of the package declaration is from the declaration itself through the end
2991 of the enclosing block, file, or eval (the same as the C<my> operator).
2992 All further unqualified dynamic identifiers will be in this namespace.
2993 A package statement affects only dynamic variables--including those
2994 you've used C<local> on--but I<not> lexical variables, which are created
2995 with C<my>. Typically it would be the first declaration in a file to
2996 be included by the C<require> or C<use> operator. You can switch into a
2997 package in more than one place; it merely influences which symbol table
2998 is used by the compiler for the rest of that block. You can refer to
2999 variables and filehandles in other packages by prefixing the identifier
3000 with the package name and a double colon: C<$Package::Variable>.
3001 If the package name is null, the C<main> package as assumed. That is,
3002 C<$::sail> is equivalent to C<$main::sail> (as well as to C<$main'sail>,
3003 still seen in older code).
3005 If NAMESPACE is omitted, then there is no current package, and all
3006 identifiers must be fully qualified or lexicals. This is stricter
3007 than C<use strict>, since it also extends to function names.
3009 See L<perlmod/"Packages"> for more information about packages, modules,
3010 and classes. See L<perlsub> for other scoping issues.
3012 =item pipe READHANDLE,WRITEHANDLE
3014 Opens a pair of connected pipes like the corresponding system call.
3015 Note that if you set up a loop of piped processes, deadlock can occur
3016 unless you are very careful. In addition, note that Perl's pipes use
3017 stdio buffering, so you may need to set C<$|> to flush your WRITEHANDLE
3018 after each command, depending on the application.
3020 See L<IPC::Open2>, L<IPC::Open3>, and L<perlipc/"Bidirectional Communication">
3021 for examples of such things.
3023 On systems that support a close-on-exec flag on files, the flag will be set
3024 for the newly opened file descriptors as determined by the value of $^F.
3031 Pops and returns the last value of the array, shortening the array by
3032 one element. Has an effect similar to
3036 If there are no elements in the array, returns the undefined value
3037 (although this may happen at other times as well). If ARRAY is
3038 omitted, pops the C<@ARGV> array in the main program, and the C<@_>
3039 array in subroutines, just like C<shift>.
3045 Returns the offset of where the last C<m//g> search left off for the variable
3046 is in question (C<$_> is used when the variable is not specified). May be
3047 modified to change that offset. Such modification will also influence
3048 the C<\G> zero-width assertion in regular expressions. See L<perlre> and
3051 =item print FILEHANDLE LIST
3057 Prints a string or a list of strings. Returns true if successful.
3058 FILEHANDLE may be a scalar variable name, in which case the variable
3059 contains the name of or a reference to the filehandle, thus introducing
3060 one level of indirection. (NOTE: If FILEHANDLE is a variable and
3061 the next token is a term, it may be misinterpreted as an operator
3062 unless you interpose a C<+> or put parentheses around the arguments.)
3063 If FILEHANDLE is omitted, prints by default to standard output (or
3064 to the last selected output channel--see L</select>). If LIST is
3065 also omitted, prints C<$_> to the currently selected output channel.
3066 To set the default output channel to something other than STDOUT
3067 use the select operation. The current value of C<$,> (if any) is
3068 printed between each LIST item. The current value of C<$\> (if
3069 any) is printed after the entire LIST has been printed. Because
3070 print takes a LIST, anything in the LIST is evaluated in list
3071 context, and any subroutine that you call will have one or more of
3072 its expressions evaluated in list context. Also be careful not to
3073 follow the print keyword with a left parenthesis unless you want
3074 the corresponding right parenthesis to terminate the arguments to
3075 the print--interpose a C<+> or put parentheses around all the
3078 Note that if you're storing FILEHANDLES in an array or other expression,
3079 you will have to use a block returning its value instead:
3081 print { $files[$i] } "stuff\n";
3082 print { $OK ? STDOUT : STDERR } "stuff\n";
3084 =item printf FILEHANDLE FORMAT, LIST
3086 =item printf FORMAT, LIST
3088 Equivalent to C<print FILEHANDLE sprintf(FORMAT, LIST)>, except that C<$\>
3089 (the output record separator) is not appended. The first argument
3090 of the list will be interpreted as the C<printf> format. If C<use locale> is
3091 in effect, the character used for the decimal point in formatted real numbers
3092 is affected by the LC_NUMERIC locale. See L<perllocale>.
3094 Don't fall into the trap of using a C<printf> when a simple
3095 C<print> would do. The C<print> is more efficient and less
3098 =item prototype FUNCTION
3100 Returns the prototype of a function as a string (or C<undef> if the
3101 function has no prototype). FUNCTION is a reference to, or the name of,
3102 the function whose prototype you want to retrieve.
3104 If FUNCTION is a string starting with C<CORE::>, the rest is taken as a
3105 name for Perl builtin. If the builtin is not I<overridable> (such as
3106 C<qw//>) or its arguments cannot be expressed by a prototype (such as
3107 C<system>) returns C<undef> because the builtin does not really behave
3108 like a Perl function. Otherwise, the string describing the equivalent
3109 prototype is returned.
3111 =item push ARRAY,LIST
3113 Treats ARRAY as a stack, and pushes the values of LIST
3114 onto the end of ARRAY. The length of ARRAY increases by the length of
3115 LIST. Has the same effect as
3118 $ARRAY[++$#ARRAY] = $value;
3121 but is more efficient. Returns the new number of elements in the array.
3133 Generalized quotes. See L<perlop/"Regexp Quote-Like Operators">.
3135 =item quotemeta EXPR
3139 Returns the value of EXPR with all non-alphanumeric
3140 characters backslashed. (That is, all characters not matching
3141 C</[A-Za-z_0-9]/> will be preceded by a backslash in the
3142 returned string, regardless of any locale settings.)
3143 This is the internal function implementing
3144 the C<\Q> escape in double-quoted strings.
3146 If EXPR is omitted, uses C<$_>.
3152 Returns a random fractional number greater than or equal to C<0> and less
3153 than the value of EXPR. (EXPR should be positive.) If EXPR is
3154 omitted, the value C<1> is used. Automatically calls C<srand> unless
3155 C<srand> has already been called. See also C<srand>.
3157 (Note: If your rand function consistently returns numbers that are too
3158 large or too small, then your version of Perl was probably compiled
3159 with the wrong number of RANDBITS.)
3161 =item read FILEHANDLE,SCALAR,LENGTH,OFFSET
3163 =item read FILEHANDLE,SCALAR,LENGTH
3165 Attempts to read LENGTH bytes of data into variable SCALAR from the
3166 specified FILEHANDLE. Returns the number of bytes actually read,
3167 C<0> at end of file, or undef if there was an error. SCALAR will be grown
3168 or shrunk to the length actually read. An OFFSET may be specified to
3169 place the read data at some other place than the beginning of the
3170 string. This call is actually implemented in terms of stdio's fread(3)
3171 call. To get a true read(2) system call, see C<sysread>.
3173 =item readdir DIRHANDLE
3175 Returns the next directory entry for a directory opened by C<opendir>.
3176 If used in list context, returns all the rest of the entries in the
3177 directory. If there are no more entries, returns an undefined value in
3178 scalar context or a null list in list context.
3180 If you're planning to filetest the return values out of a C<readdir>, you'd
3181 better prepend the directory in question. Otherwise, because we didn't
3182 C<chdir> there, it would have been testing the wrong file.
3184 opendir(DIR, $some_dir) || die "can't opendir $some_dir: $!";
3185 @dots = grep { /^\./ && -f "$some_dir/$_" } readdir(DIR);
3190 Reads from the filehandle whose typeglob is contained in EXPR. In scalar
3191 context, each call reads and returns the next line, until end-of-file is
3192 reached, whereupon the subsequent call returns undef. In list context,
3193 reads until end-of-file is reached and returns a list of lines. Note that
3194 the notion of "line" used here is however you may have defined it
3195 with C<$/> or C<$INPUT_RECORD_SEPARATOR>). See L<perlvar/"$/">.
3197 When C<$/> is set to C<undef>, when readline() is in scalar
3198 context (i.e. file slurp mode), and when an empty file is read, it
3199 returns C<''> the first time, followed by C<undef> subsequently.
3201 This is the internal function implementing the C<E<lt>EXPRE<gt>>
3202 operator, but you can use it directly. The C<E<lt>EXPRE<gt>>
3203 operator is discussed in more detail in L<perlop/"I/O Operators">.
3206 $line = readline(*STDIN); # same thing
3212 Returns the value of a symbolic link, if symbolic links are
3213 implemented. If not, gives a fatal error. If there is some system
3214 error, returns the undefined value and sets C<$!> (errno). If EXPR is
3215 omitted, uses C<$_>.
3219 EXPR is executed as a system command.
3220 The collected standard output of the command is returned.
3221 In scalar context, it comes back as a single (potentially
3222 multi-line) string. In list context, returns a list of lines
3223 (however you've defined lines with C<$/> or C<$INPUT_RECORD_SEPARATOR>).
3224 This is the internal function implementing the C<qx/EXPR/>
3225 operator, but you can use it directly. The C<qx/EXPR/>
3226 operator is discussed in more detail in L<perlop/"I/O Operators">.
3228 =item recv SOCKET,SCALAR,LENGTH,FLAGS
3230 Receives a message on a socket. Attempts to receive LENGTH bytes of
3231 data into variable SCALAR from the specified SOCKET filehandle.
3232 Actually does a C C<recvfrom>, so that it can return the address of the
3233 sender. Returns the undefined value if there's an error. SCALAR will
3234 be grown or shrunk to the length actually read. Takes the same flags
3235 as the system call of the same name.
3236 See L<perlipc/"UDP: Message Passing"> for examples.
3242 The C<redo> command restarts the loop block without evaluating the
3243 conditional again. The C<continue> block, if any, is not executed. If
3244 the LABEL is omitted, the command refers to the innermost enclosing
3245 loop. This command is normally used by programs that want to lie to
3246 themselves about what was just input:
3248 # a simpleminded Pascal comment stripper
3249 # (warning: assumes no { or } in strings)
3250 LINE: while (<STDIN>) {
3251 while (s|({.*}.*){.*}|$1 |) {}
3256 if (/}/) { # end of comment?
3265 C<redo> cannot be used to retry a block which returns a value such as
3266 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
3267 a grep() or map() operation.
3269 See also L</continue> for an illustration of how C<last>, C<next>, and
3276 Returns a true value if EXPR is a reference, false otherwise. If EXPR
3277 is not specified, C<$_> will be used. The value returned depends on the
3278 type of thing the reference is a reference to.
3279 Builtin types include:
3289 If the referenced object has been blessed into a package, then that package
3290 name is returned instead. You can think of C<ref> as a C<typeof> operator.
3292 if (ref($r) eq "HASH") {
3293 print "r is a reference to a hash.\n";
3296 print "r is not a reference at all.\n";
3298 if (UNIVERSAL::isa($r, "HASH")) { # for subclassing
3299 print "r is a reference to something that isa hash.\n";
3302 See also L<perlref>.
3304 =item rename OLDNAME,NEWNAME
3306 Changes the name of a file; an existing file NEWNAME will be
3307 clobbered. Returns true for success, false otherwise.
3309 Behavior of this function varies wildly depending on your system
3310 implementation. For example, it will usually not work across file system
3311 boundaries, even though the system I<mv> command sometimes compensates
3312 for this. Other restrictions include whether it works on directories,
3313 open files, or pre-existing files. Check L<perlport> and either the
3314 rename(2) manpage or equivalent system documentation for details.
3320 Demands some semantics specified by EXPR, or by C<$_> if EXPR is not
3321 supplied. If EXPR is numeric, demands that the current version of Perl
3322 (C<$]> or $PERL_VERSION) be equal or greater than EXPR.
3324 Otherwise, demands that a library file be included if it hasn't already
3325 been included. The file is included via the do-FILE mechanism, which is
3326 essentially just a variety of C<eval>. Has semantics similar to the following
3331 return 1 if $INC{$filename};
3332 my($realfilename,$result);
3334 foreach $prefix (@INC) {
3335 $realfilename = "$prefix/$filename";
3336 if (-f $realfilename) {
3337 $result = do $realfilename;
3341 die "Can't find $filename in \@INC";
3344 die "$filename did not return true value" unless $result;
3345 $INC{$filename} = $realfilename;
3349 Note that the file will not be included twice under the same specified
3350 name. The file must return true as the last statement to indicate
3351 successful execution of any initialization code, so it's customary to
3352 end such a file with C<1;> unless you're sure it'll return true
3353 otherwise. But it's better just to put the C<1;>, in case you add more
3356 If EXPR is a bareword, the require assumes a "F<.pm>" extension and
3357 replaces "F<::>" with "F</>" in the filename for you,
3358 to make it easy to load standard modules. This form of loading of
3359 modules does not risk altering your namespace.
3361 In other words, if you try this:
3363 require Foo::Bar; # a splendid bareword
3365 The require function will actually look for the "F<Foo/Bar.pm>" file in the
3366 directories specified in the C<@INC> array.
3368 But if you try this:
3370 $class = 'Foo::Bar';
3371 require $class; # $class is not a bareword
3373 require "Foo::Bar"; # not a bareword because of the ""
3375 The require function will look for the "F<Foo::Bar>" file in the @INC array and
3376 will complain about not finding "F<Foo::Bar>" there. In this case you can do:
3378 eval "require $class";
3380 For a yet-more-powerful import facility, see L</use> and L<perlmod>.
3386 Generally used in a C<continue> block at the end of a loop to clear
3387 variables and reset C<??> searches so that they work again. The
3388 expression is interpreted as a list of single characters (hyphens
3389 allowed for ranges). All variables and arrays beginning with one of
3390 those letters are reset to their pristine state. If the expression is
3391 omitted, one-match searches (C<?pattern?>) are reset to match again. Resets
3392 only variables or searches in the current package. Always returns
3395 reset 'X'; # reset all X variables
3396 reset 'a-z'; # reset lower case variables
3397 reset; # just reset ?one-time? searches
3399 Resetting C<"A-Z"> is not recommended because you'll wipe out your
3400 C<@ARGV> and C<@INC> arrays and your C<%ENV> hash. Resets only package
3401 variables--lexical variables are unaffected, but they clean themselves
3402 up on scope exit anyway, so you'll probably want to use them instead.
3409 Returns from a subroutine, C<eval>, or C<do FILE> with the value
3410 given in EXPR. Evaluation of EXPR may be in list, scalar, or void
3411 context, depending on how the return value will be used, and the context
3412 may vary from one execution to the next (see C<wantarray>). If no EXPR
3413 is given, returns an empty list in list context, the undefined value in
3414 scalar context, and (of course) nothing at all in a void context.
3416 (Note that in the absence of a explicit C<return>, a subroutine, eval,
3417 or do FILE will automatically return the value of the last expression
3422 In list context, returns a list value consisting of the elements
3423 of LIST in the opposite order. In scalar context, concatenates the
3424 elements of LIST and returns a string value with all characters
3425 in the opposite order.
3427 print reverse <>; # line tac, last line first
3429 undef $/; # for efficiency of <>
3430 print scalar reverse <>; # character tac, last line tsrif
3432 This operator is also handy for inverting a hash, although there are some
3433 caveats. If a value is duplicated in the original hash, only one of those
3434 can be represented as a key in the inverted hash. Also, this has to
3435 unwind one hash and build a whole new one, which may take some time
3436 on a large hash, such as from a DBM file.
3438 %by_name = reverse %by_address; # Invert the hash
3440 =item rewinddir DIRHANDLE
3442 Sets the current position to the beginning of the directory for the
3443 C<readdir> routine on DIRHANDLE.
3445 =item rindex STR,SUBSTR,POSITION
3447 =item rindex STR,SUBSTR
3449 Works just like index() except that it returns the position of the LAST
3450 occurrence of SUBSTR in STR. If POSITION is specified, returns the
3451 last occurrence at or before that position.
3453 =item rmdir FILENAME
3457 Deletes the directory specified by FILENAME if that directory is empty. If it
3458 succeeds it returns true, otherwise it returns false and sets C<$!> (errno). If
3459 FILENAME is omitted, uses C<$_>.
3463 The substitution operator. See L<perlop>.
3467 Forces EXPR to be interpreted in scalar context and returns the value
3470 @counts = ( scalar @a, scalar @b, scalar @c );
3472 There is no equivalent operator to force an expression to
3473 be interpolated in list context because in practice, this is never
3474 needed. If you really wanted to do so, however, you could use
3475 the construction C<@{[ (some expression) ]}>, but usually a simple
3476 C<(some expression)> suffices.
3478 Because C<scalar> is unary operator, if you accidentally use for EXPR a
3479 parenthesized list, this behaves as a scalar comma expression, evaluating
3480 all but the last element in void context and returning the final element
3481 evaluated in scalar context. This is seldom what you want.
3483 The following single statement:
3485 print uc(scalar(&foo,$bar)),$baz;
3487 is the moral equivalent of these two:
3490 print(uc($bar),$baz);
3492 See L<perlop> for more details on unary operators and the comma operator.
3494 =item seek FILEHANDLE,POSITION,WHENCE
3496 Sets FILEHANDLE's position, just like the C<fseek> call of C<stdio>.
3497 FILEHANDLE may be an expression whose value gives the name of the
3498 filehandle. The values for WHENCE are C<0> to set the new position to
3499 POSITION, C<1> to set it to the current position plus POSITION, and
3500 C<2> to set it to EOF plus POSITION (typically negative). For WHENCE
3501 you may use the constants C<SEEK_SET>, C<SEEK_CUR>, and C<SEEK_END>
3502 (start of the file, current position, end of the file) from any of the
3503 modules Fcntl, C<IO::Seekable>, or POSIX. Returns C<1> upon success,
3506 If you want to position file for C<sysread> or C<syswrite>, don't use
3507 C<seek>--buffering makes its effect on the file's system position
3508 unpredictable and non-portable. Use C<sysseek> instead.
3510 Due to the rules and rigors of ANSI C, on some systems you have to do a
3511 seek whenever you switch between reading and writing. Amongst other
3512 things, this may have the effect of calling stdio's clearerr(3).
3513 A WHENCE of C<1> (C<SEEK_CUR>) is useful for not moving the file position:
3517 This is also useful for applications emulating C<tail -f>. Once you hit
3518 EOF on your read, and then sleep for a while, you might have to stick in a
3519 seek() to reset things. The C<seek> doesn't change the current position,
3520 but it I<does> clear the end-of-file condition on the handle, so that the
3521 next C<E<lt>FILEE<gt>> makes Perl try again to read something. We hope.
3523 If that doesn't work (some stdios are particularly cantankerous), then
3524 you may need something more like this:
3527 for ($curpos = tell(FILE); $_ = <FILE>;
3528 $curpos = tell(FILE)) {
3529 # search for some stuff and put it into files
3531 sleep($for_a_while);
3532 seek(FILE, $curpos, 0);
3535 =item seekdir DIRHANDLE,POS
3537 Sets the current position for the C<readdir> routine on DIRHANDLE. POS
3538 must be a value returned by C<telldir>. Has the same caveats about
3539 possible directory compaction as the corresponding system library
3542 =item select FILEHANDLE
3546 Returns the currently selected filehandle. Sets the current default
3547 filehandle for output, if FILEHANDLE is supplied. This has two
3548 effects: first, a C<write> or a C<print> without a filehandle will
3549 default to this FILEHANDLE. Second, references to variables related to
3550 output will refer to this output channel. For example, if you have to
3551 set the top of form format for more than one output channel, you might
3559 FILEHANDLE may be an expression whose value gives the name of the
3560 actual filehandle. Thus:
3562 $oldfh = select(STDERR); $| = 1; select($oldfh);
3564 Some programmers may prefer to think of filehandles as objects with
3565 methods, preferring to write the last example as:
3568 STDERR->autoflush(1);
3570 =item select RBITS,WBITS,EBITS,TIMEOUT
3572 This calls the select(2) system call with the bit masks specified, which
3573 can be constructed using C<fileno> and C<vec>, along these lines:
3575 $rin = $win = $ein = '';
3576 vec($rin,fileno(STDIN),1) = 1;
3577 vec($win,fileno(STDOUT),1) = 1;
3580 If you want to select on many filehandles you might wish to write a
3584 my(@fhlist) = split(' ',$_[0]);
3587 vec($bits,fileno($_),1) = 1;
3591 $rin = fhbits('STDIN TTY SOCK');
3595 ($nfound,$timeleft) =
3596 select($rout=$rin, $wout=$win, $eout=$ein, $timeout);
3598 or to block until something becomes ready just do this
3600 $nfound = select($rout=$rin, $wout=$win, $eout=$ein, undef);
3602 Most systems do not bother to return anything useful in $timeleft, so
3603 calling select() in scalar context just returns $nfound.
3605 Any of the bit masks can also be undef. The timeout, if specified, is
3606 in seconds, which may be fractional. Note: not all implementations are
3607 capable of returning the$timeleft. If not, they always return
3608 $timeleft equal to the supplied $timeout.
3610 You can effect a sleep of 250 milliseconds this way:
3612 select(undef, undef, undef, 0.25);
3614 B<WARNING>: One should not attempt to mix buffered I/O (like C<read>
3615 or E<lt>FHE<gt>) with C<select>, except as permitted by POSIX, and even
3616 then only on POSIX systems. You have to use C<sysread> instead.
3618 =item semctl ID,SEMNUM,CMD,ARG
3620 Calls the System V IPC function C<semctl>. You'll probably have to say
3624 first to get the correct constant definitions. If CMD is IPC_STAT or
3625 GETALL, then ARG must be a variable which will hold the returned
3626 semid_ds structure or semaphore value array. Returns like C<ioctl>: the
3627 undefined value for error, "C<0 but true>" for zero, or the actual return
3628 value otherwise. See also C<IPC::SysV> and C<IPC::Semaphore> documentation.
3630 =item semget KEY,NSEMS,FLAGS
3632 Calls the System V IPC function semget. Returns the semaphore id, or
3633 the undefined value if there is an error. See also C<IPC::SysV> and
3634 C<IPC::SysV::Semaphore> documentation.
3636 =item semop KEY,OPSTRING
3638 Calls the System V IPC function semop to perform semaphore operations
3639 such as signaling and waiting. OPSTRING must be a packed array of
3640 semop structures. Each semop structure can be generated with
3641 C<pack("sss", $semnum, $semop, $semflag)>. The number of semaphore
3642 operations is implied by the length of OPSTRING. Returns true if
3643 successful, or false if there is an error. As an example, the
3644 following code waits on semaphore $semnum of semaphore id $semid:
3646 $semop = pack("sss", $semnum, -1, 0);
3647 die "Semaphore trouble: $!\n" unless semop($semid, $semop);
3649 To signal the semaphore, replace C<-1> with C<1>. See also C<IPC::SysV>
3650 and C<IPC::SysV::Semaphore> documentation.
3652 =item send SOCKET,MSG,FLAGS,TO
3654 =item send SOCKET,MSG,FLAGS
3656 Sends a message on a socket. Takes the same flags as the system call
3657 of the same name. On unconnected sockets you must specify a
3658 destination to send TO, in which case it does a C C<sendto>. Returns
3659 the number of characters sent, or the undefined value if there is an
3660 error. The C system call sendmsg(2) is currently unimplemented.
3661 See L<perlipc/"UDP: Message Passing"> for examples.
3663 =item setpgrp PID,PGRP
3665 Sets the current process group for the specified PID, C<0> for the current
3666 process. Will produce a fatal error if used on a machine that doesn't
3667 implement setpgrp(2). If the arguments are omitted, it defaults to
3668 C<0,0>. Note that the POSIX version of C<setpgrp> does not accept any
3669 arguments, so only C<setpgrp(0,0)> is portable. See also C<POSIX::setsid()>.
3671 =item setpriority WHICH,WHO,PRIORITY
3673 Sets the current priority for a process, a process group, or a user.
3674 (See setpriority(2).) Will produce a fatal error if used on a machine
3675 that doesn't implement setpriority(2).
3677 =item setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL
3679 Sets the socket option requested. Returns undefined if there is an
3680 error. OPTVAL may be specified as C<undef> if you don't want to pass an
3687 Shifts the first value of the array off and returns it, shortening the
3688 array by 1 and moving everything down. If there are no elements in the
3689 array, returns the undefined value. If ARRAY is omitted, shifts the
3690 C<@_> array within the lexical scope of subroutines and formats, and the
3691 C<@ARGV> array at file scopes or within the lexical scopes established by
3692 the C<eval ''>, C<BEGIN {}>, C<END {}>, and C<INIT {}> constructs.
3693 See also C<unshift>, C<push>, and C<pop>. C<Shift()> and C<unshift> do the
3694 same thing to the left end of an array that C<pop> and C<push> do to the
3697 =item shmctl ID,CMD,ARG
3699 Calls the System V IPC function shmctl. You'll probably have to say
3703 first to get the correct constant definitions. If CMD is C<IPC_STAT>,
3704 then ARG must be a variable which will hold the returned C<shmid_ds>
3705 structure. Returns like ioctl: the undefined value for error, "C<0> but
3706 true" for zero, or the actual return value otherwise.
3707 See also C<IPC::SysV> documentation.
3709 =item shmget KEY,SIZE,FLAGS
3711 Calls the System V IPC function shmget. Returns the shared memory
3712 segment id, or the undefined value if there is an error.
3713 See also C<IPC::SysV> documentation.
3715 =item shmread ID,VAR,POS,SIZE
3717 =item shmwrite ID,STRING,POS,SIZE
3719 Reads or writes the System V shared memory segment ID starting at
3720 position POS for size SIZE by attaching to it, copying in/out, and
3721 detaching from it. When reading, VAR must be a variable that will
3722 hold the data read. When writing, if STRING is too long, only SIZE
3723 bytes are used; if STRING is too short, nulls are written to fill out
3724 SIZE bytes. Return true if successful, or false if there is an error.
3725 See also C<IPC::SysV> documentation and the C<IPC::Shareable> module
3728 =item shutdown SOCKET,HOW
3730 Shuts down a socket connection in the manner indicated by HOW, which
3731 has the same interpretation as in the system call of the same name.
3733 shutdown(SOCKET, 0); # I/we have stopped reading data
3734 shutdown(SOCKET, 1); # I/we have stopped writing data
3735 shutdown(SOCKET, 2); # I/we have stopped using this socket
3737 This is useful with sockets when you want to tell the other
3738 side you're done writing but not done reading, or vice versa.
3739 It's also a more insistent form of close because it also
3740 disables the file descriptor in any forked copies in other
3747 Returns the sine of EXPR (expressed in radians). If EXPR is omitted,
3748 returns sine of C<$_>.
3750 For the inverse sine operation, you may use the C<POSIX::asin>
3751 function, or use this relation:
3753 sub asin { atan2($_[0], sqrt(1 - $_[0] * $_[0])) }
3759 Causes the script to sleep for EXPR seconds, or forever if no EXPR.
3760 May be interrupted if the process receives a signal such as C<SIGALRM>.
3761 Returns the number of seconds actually slept. You probably cannot
3762 mix C<alarm> and C<sleep> calls, because C<sleep> is often implemented
3765 On some older systems, it may sleep up to a full second less than what
3766 you requested, depending on how it counts seconds. Most modern systems
3767 always sleep the full amount. They may appear to sleep longer than that,
3768 however, because your process might not be scheduled right away in a
3769 busy multitasking system.
3771 For delays of finer granularity than one second, you may use Perl's
3772 C<syscall> interface to access setitimer(2) if your system supports
3773 it, or else see L</select> above. The Time::HiRes module from CPAN
3776 See also the POSIX module's C<sigpause> function.
3778 =item socket SOCKET,DOMAIN,TYPE,PROTOCOL
3780 Opens a socket of the specified kind and attaches it to filehandle
3781 SOCKET. DOMAIN, TYPE, and PROTOCOL are specified the same as for
3782 the system call of the same name. You should C<use Socket> first
3783 to get the proper definitions imported. See the examples in
3784 L<perlipc/"Sockets: Client/Server Communication">.
3786 =item socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL
3788 Creates an unnamed pair of sockets in the specified domain, of the
3789 specified type. DOMAIN, TYPE, and PROTOCOL are specified the same as
3790 for the system call of the same name. If unimplemented, yields a fatal
3791 error. Returns true if successful.
3793 Some systems defined C<pipe> in terms of C<socketpair>, in which a call
3794 to C<pipe(Rdr, Wtr)> is essentially:
3797 socketpair(Rdr, Wtr, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
3798 shutdown(Rdr, 1); # no more writing for reader
3799 shutdown(Wtr, 0); # no more reading for writer
3801 See L<perlipc> for an example of socketpair use.
3803 =item sort SUBNAME LIST
3805 =item sort BLOCK LIST
3809 Sorts the LIST and returns the sorted list value. If SUBNAME or BLOCK
3810 is omitted, C<sort>s in standard string comparison order. If SUBNAME is
3811 specified, it gives the name of a subroutine that returns an integer
3812 less than, equal to, or greater than C<0>, depending on how the elements
3813 of the list are to be ordered. (The C<E<lt>=E<gt>> and C<cmp>
3814 operators are extremely useful in such routines.) SUBNAME may be a
3815 scalar variable name (unsubscripted), in which case the value provides
3816 the name of (or a reference to) the actual subroutine to use. In place
3817 of a SUBNAME, you can provide a BLOCK as an anonymous, in-line sort
3820 In the interests of efficiency the normal calling code for subroutines is
3821 bypassed, with the following effects: the subroutine may not be a
3822 recursive subroutine, and the two elements to be compared are passed into
3823 the subroutine not via C<@_> but as the package global variables $a and
3824 $b (see example below). They are passed by reference, so don't
3825 modify $a and $b. And don't try to declare them as lexicals either.
3827 You also cannot exit out of the sort block or subroutine using any of the
3828 loop control operators described in L<perlsyn> or with C<goto>.
3830 When C<use locale> is in effect, C<sort LIST> sorts LIST according to the
3831 current collation locale. See L<perllocale>.
3836 @articles = sort @files;
3838 # same thing, but with explicit sort routine
3839 @articles = sort {$a cmp $b} @files;
3841 # now case-insensitively
3842 @articles = sort {uc($a) cmp uc($b)} @files;
3844 # same thing in reversed order
3845 @articles = sort {$b cmp $a} @files;
3847 # sort numerically ascending
3848 @articles = sort {$a <=> $b} @files;
3850 # sort numerically descending
3851 @articles = sort {$b <=> $a} @files;
3853 # this sorts the %age hash by value instead of key
3854 # using an in-line function
3855 @eldest = sort { $age{$b} <=> $age{$a} } keys %age;
3857 # sort using explicit subroutine name
3859 $age{$a} <=> $age{$b}; # presuming numeric
3861 @sortedclass = sort byage @class;
3863 sub backwards { $b cmp $a }
3864 @harry = qw(dog cat x Cain Abel);
3865 @george = qw(gone chased yz Punished Axed);
3867 # prints AbelCaincatdogx
3868 print sort backwards @harry;
3869 # prints xdogcatCainAbel
3870 print sort @george, 'to', @harry;
3871 # prints AbelAxedCainPunishedcatchaseddoggonetoxyz
3873 # inefficiently sort by descending numeric compare using
3874 # the first integer after the first = sign, or the
3875 # whole record case-insensitively otherwise
3878 ($b =~ /=(\d+)/)[0] <=> ($a =~ /=(\d+)/)[0]
3883 # same thing, but much more efficiently;
3884 # we'll build auxiliary indices instead
3888 push @nums, /=(\d+)/;
3893 $nums[$b] <=> $nums[$a]
3895 $caps[$a] cmp $caps[$b]
3899 # same thing, but without any temps
3900 @new = map { $_->[0] }
3901 sort { $b->[1] <=> $a->[1]
3904 } map { [$_, /=(\d+)/, uc($_)] } @old;
3906 If you're using strict, you I<must not> declare $a
3907 and $b as lexicals. They are package globals. That means
3908 if you're in the C<main> package, it's
3910 @articles = sort {$main::b <=> $main::a} @files;
3914 @articles = sort {$::b <=> $::a} @files;
3916 but if you're in the C<FooPack> package, it's
3918 @articles = sort {$FooPack::b <=> $FooPack::a} @files;
3920 The comparison function is required to behave. If it returns
3921 inconsistent results (sometimes saying C<$x[1]> is less than C<$x[2]> and
3922 sometimes saying the opposite, for example) the results are not
3925 =item splice ARRAY,OFFSET,LENGTH,LIST
3927 =item splice ARRAY,OFFSET,LENGTH
3929 =item splice ARRAY,OFFSET
3931 Removes the elements designated by OFFSET and LENGTH from an array, and
3932 replaces them with the elements of LIST, if any. In list context,
3933 returns the elements removed from the array. In scalar context,
3934 returns the last element removed, or C<undef> if no elements are
3935 removed. The array grows or shrinks as necessary.
3936 If OFFSET is negative then it starts that far from the end of the array.
3937 If LENGTH is omitted, removes everything from OFFSET onward.
3938 If LENGTH is negative, leave that many elements off the end of the array.
3939 The following equivalences hold (assuming C<$[ == 0>):
3941 push(@a,$x,$y) splice(@a,@a,0,$x,$y)
3942 pop(@a) splice(@a,-1)
3943 shift(@a) splice(@a,0,1)
3944 unshift(@a,$x,$y) splice(@a,0,0,$x,$y)
3945 $a[$x] = $y splice(@a,$x,1,$y)
3947 Example, assuming array lengths are passed before arrays:
3949 sub aeq { # compare two list values
3950 my(@a) = splice(@_,0,shift);
3951 my(@b) = splice(@_,0,shift);
3952 return 0 unless @a == @b; # same len?
3954 return 0 if pop(@a) ne pop(@b);
3958 if (&aeq($len,@foo[1..$len],0+@bar,@bar)) { ... }
3960 =item split /PATTERN/,EXPR,LIMIT
3962 =item split /PATTERN/,EXPR
3964 =item split /PATTERN/
3968 Splits a string into a list of strings and returns that list. By default,
3969 empty leading fields are preserved, and empty trailing ones are deleted.
3971 If not in list context, returns the number of fields found and splits into
3972 the C<@_> array. (In list context, you can force the split into C<@_> by
3973 using C<??> as the pattern delimiters, but it still returns the list
3974 value.) The use of implicit split to C<@_> is deprecated, however, because
3975 it clobbers your subroutine arguments.
3977 If EXPR is omitted, splits the C<$_> string. If PATTERN is also omitted,
3978 splits on whitespace (after skipping any leading whitespace). Anything
3979 matching PATTERN is taken to be a delimiter separating the fields. (Note
3980 that the delimiter may be longer than one character.)
3982 If LIMIT is specified and positive, splits into no more than that
3983 many fields (though it may split into fewer). If LIMIT is unspecified
3984 or zero, trailing null fields are stripped (which potential users
3985 of C<pop> would do well to remember). If LIMIT is negative, it is
3986 treated as if an arbitrarily large LIMIT had been specified.
3988 A pattern matching the null string (not to be confused with
3989 a null pattern C<//>, which is just one member of the set of patterns
3990 matching a null string) will split the value of EXPR into separate
3991 characters at each point it matches that way. For example:
3993 print join(':', split(/ */, 'hi there'));
3995 produces the output 'h:i:t:h:e:r:e'.
3997 The LIMIT parameter can be used to split a line partially
3999 ($login, $passwd, $remainder) = split(/:/, $_, 3);
4001 When assigning to a list, if LIMIT is omitted, Perl supplies a LIMIT
4002 one larger than the number of variables in the list, to avoid
4003 unnecessary work. For the list above LIMIT would have been 4 by
4004 default. In time critical applications it behooves you not to split
4005 into more fields than you really need.
4007 If the PATTERN contains parentheses, additional list elements are
4008 created from each matching substring in the delimiter.
4010 split(/([,-])/, "1-10,20", 3);
4012 produces the list value
4014 (1, '-', 10, ',', 20)
4016 If you had the entire header of a normal Unix email message in $header,
4017 you could split it up into fields and their values this way:
4019 $header =~ s/\n\s+/ /g; # fix continuation lines
4020 %hdrs = (UNIX_FROM => split /^(\S*?):\s*/m, $header);
4022 The pattern C</PATTERN/> may be replaced with an expression to specify
4023 patterns that vary at runtime. (To do runtime compilation only once,
4024 use C</$variable/o>.)
4026 As a special case, specifying a PATTERN of space (C<' '>) will split on
4027 white space just as C<split> with no arguments does. Thus, C<split(' ')> can
4028 be used to emulate B<awk>'s default behavior, whereas C<split(/ /)>
4029 will give you as many null initial fields as there are leading spaces.
4030 A C<split> on C</\s+/> is like a C<split(' ')> except that any leading
4031 whitespace produces a null first field. A C<split> with no arguments
4032 really does a C<split(' ', $_)> internally.
4036 open(PASSWD, '/etc/passwd');
4038 ($login, $passwd, $uid, $gid,
4039 $gcos, $home, $shell) = split(/:/);
4043 (Note that $shell above will still have a newline on it. See L</chop>,
4044 L</chomp>, and L</join>.)
4046 =item sprintf FORMAT, LIST
4048 Returns a string formatted by the usual C<printf> conventions of the
4049 C library function C<sprintf>. See L<sprintf(3)> or L<printf(3)>
4050 on your system for an explanation of the general principles.
4052 Perl does its own C<sprintf> formatting--it emulates the C
4053 function C<sprintf>, but it doesn't use it (except for floating-point
4054 numbers, and even then only the standard modifiers are allowed). As a
4055 result, any non-standard extensions in your local C<sprintf> are not
4056 available from Perl.
4058 Perl's C<sprintf> permits the following universally-known conversions:
4061 %c a character with the given number
4063 %d a signed integer, in decimal
4064 %u an unsigned integer, in decimal
4065 %o an unsigned integer, in octal
4066 %x an unsigned integer, in hexadecimal
4067 %e a floating-point number, in scientific notation
4068 %f a floating-point number, in fixed decimal notation
4069 %g a floating-point number, in %e or %f notation
4071 In addition, Perl permits the following widely-supported conversions:
4073 %X like %x, but using upper-case letters
4074 %E like %e, but using an upper-case "E"
4075 %G like %g, but with an upper-case "E" (if applicable)
4076 %b an unsigned integer, in binary
4077 %p a pointer (outputs the Perl value's address in hexadecimal)
4078 %n special: *stores* the number of characters output so far
4079 into the next variable in the parameter list
4081 Finally, for backward (and we do mean "backward") compatibility, Perl
4082 permits these unnecessary but widely-supported conversions:
4085 %D a synonym for %ld
4086 %U a synonym for %lu
4087 %O a synonym for %lo
4090 Perl permits the following universally-known flags between the C<%>
4091 and the conversion letter:
4093 space prefix positive number with a space
4094 + prefix positive number with a plus sign
4095 - left-justify within the field
4096 0 use zeros, not spaces, to right-justify
4097 # prefix non-zero octal with "0", non-zero hex with "0x"
4098 number minimum field width
4099 .number "precision": digits after decimal point for
4100 floating-point, max length for string, minimum length
4102 l interpret integer as C type "long" or "unsigned long"
4103 h interpret integer as C type "short" or "unsigned short"
4105 There is also one Perl-specific flag:
4107 V interpret integer as Perl's standard integer type
4109 Where a number would appear in the flags, an asterisk (C<*>) may be
4110 used instead, in which case Perl uses the next item in the parameter
4111 list as the given number (that is, as the field width or precision).
4112 If a field width obtained through C<*> is negative, it has the same
4113 effect as the C<-> flag: left-justification.
4115 If C<use locale> is in effect, the character used for the decimal
4116 point in formatted real numbers is affected by the LC_NUMERIC locale.
4119 If Perl understands "quads" (64-bit integers) (this requires
4120 either that the platform natively supports quads or that Perl
4121 has been specifically compiled to support quads), the flags
4125 print quads, and they may optionally be preceded by
4133 You can find out whether your Perl supports quads via L<Config>:
4136 ($Config{use64bits} eq 'define' || $Config{longsize} == 8) &&
4139 If Perl understands "long doubles" (this requires that the platform
4140 supports long doubles), the flags
4144 may optionally be preceded by
4152 You can find out whether your Perl supports long doubles via L<Config>:
4155 $Config{d_longdbl} eq 'define' && print "long doubles\n";
4161 Return the square root of EXPR. If EXPR is omitted, returns square
4162 root of C<$_>. Only works on non-negative operands, unless you've
4163 loaded the standard Math::Complex module.
4166 print sqrt(-2); # prints 1.4142135623731i
4172 Sets the random number seed for the C<rand> operator. If EXPR is
4173 omitted, uses a semi-random value supplied by the kernel (if it supports
4174 the F</dev/urandom> device) or based on the current time and process
4175 ID, among other things. In versions of Perl prior to 5.004 the default
4176 seed was just the current C<time>. This isn't a particularly good seed,
4177 so many old programs supply their own seed value (often C<time ^ $$> or
4178 C<time ^ ($$ + ($$ E<lt>E<lt> 15))>), but that isn't necessary any more.
4180 In fact, it's usually not necessary to call C<srand> at all, because if
4181 it is not called explicitly, it is called implicitly at the first use of
4182 the C<rand> operator. However, this was not the case in version of Perl
4183 before 5.004, so if your script will run under older Perl versions, it
4184 should call C<srand>.
4186 Note that you need something much more random than the default seed for
4187 cryptographic purposes. Checksumming the compressed output of one or more
4188 rapidly changing operating system status programs is the usual method. For
4191 srand (time ^ $$ ^ unpack "%L*", `ps axww | gzip`);
4193 If you're particularly concerned with this, see the C<Math::TrulyRandom>
4196 Do I<not> call C<srand> multiple times in your program unless you know
4197 exactly what you're doing and why you're doing it. The point of the
4198 function is to "seed" the C<rand> function so that C<rand> can produce
4199 a different sequence each time you run your program. Just do it once at the
4200 top of your program, or you I<won't> get random numbers out of C<rand>!
4202 Frequently called programs (like CGI scripts) that simply use
4206 for a seed can fall prey to the mathematical property that
4210 one-third of the time. So don't do that.
4212 =item stat FILEHANDLE
4218 Returns a 13-element list giving the status info for a file, either
4219 the file opened via FILEHANDLE, or named by EXPR. If EXPR is omitted,
4220 it stats C<$_>. Returns a null list if the stat fails. Typically used
4223 ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
4224 $atime,$mtime,$ctime,$blksize,$blocks)
4227 Not all fields are supported on all filesystem types. Here are the
4228 meaning of the fields:
4230 0 dev device number of filesystem
4232 2 mode file mode (type and permissions)
4233 3 nlink number of (hard) links to the file
4234 4 uid numeric user ID of file's owner
4235 5 gid numeric group ID of file's owner
4236 6 rdev the device identifier (special files only)
4237 7 size total size of file, in bytes
4238 8 atime last access time since the epoch
4239 9 mtime last modify time since the epoch
4240 10 ctime inode change time (NOT creation time!) since the epoch
4241 11 blksize preferred block size for file system I/O
4242 12 blocks actual number of blocks allocated
4244 (The epoch was at 00:00 January 1, 1970 GMT.)
4246 If stat is passed the special filehandle consisting of an underline, no
4247 stat is done, but the current contents of the stat structure from the
4248 last stat or filetest are returned. Example:
4250 if (-x $file && (($d) = stat(_)) && $d < 0) {
4251 print "$file is executable NFS file\n";
4254 (This works on machines only for which the device number is negative under NFS.)
4256 Because the mode contains both the file type and its permissions, you
4257 should mask off the file type portion and (s)printf using a C<"%o">
4258 if you want to see the real permissions.
4260 $mode = (stat($filename))[2];
4261 printf "Permissions are %04o\n", $mode & 07777;
4263 In scalar context, C<stat> returns a boolean value indicating success
4264 or failure, and, if successful, sets the information associated with
4265 the special filehandle C<_>.
4267 The File::stat module provides a convenient, by-name access mechanism:
4270 $sb = stat($filename);
4271 printf "File is %s, size is %s, perm %04o, mtime %s\n",
4272 $filename, $sb->size, $sb->mode & 07777,
4273 scalar localtime $sb->mtime;
4279 Takes extra time to study SCALAR (C<$_> if unspecified) in anticipation of
4280 doing many pattern matches on the string before it is next modified.
4281 This may or may not save time, depending on the nature and number of
4282 patterns you are searching on, and on the distribution of character
4283 frequencies in the string to be searched--you probably want to compare
4284 run times with and without it to see which runs faster. Those loops
4285 which scan for many short constant strings (including the constant
4286 parts of more complex patterns) will benefit most. You may have only
4287 one C<study> active at a time--if you study a different scalar the first
4288 is "unstudied". (The way C<study> works is this: a linked list of every
4289 character in the string to be searched is made, so we know, for
4290 example, where all the C<'k'> characters are. From each search string,
4291 the rarest character is selected, based on some static frequency tables
4292 constructed from some C programs and English text. Only those places
4293 that contain this "rarest" character are examined.)
4295 For example, here is a loop that inserts index producing entries
4296 before any line containing a certain pattern:
4300 print ".IX foo\n" if /\bfoo\b/;
4301 print ".IX bar\n" if /\bbar\b/;
4302 print ".IX blurfl\n" if /\bblurfl\b/;
4307 In searching for C</\bfoo\b/>, only those locations in C<$_> that contain C<"f">
4308 will be looked at, because C<"f"> is rarer than C<"o">. In general, this is
4309 a big win except in pathological cases. The only question is whether
4310 it saves you more time than it took to build the linked list in the
4313 Note that if you have to look for strings that you don't know till
4314 runtime, you can build an entire loop as a string and C<eval> that to
4315 avoid recompiling all your patterns all the time. Together with
4316 undefining C<$/> to input entire files as one record, this can be very
4317 fast, often faster than specialized programs like fgrep(1). The following
4318 scans a list of files (C<@files>) for a list of words (C<@words>), and prints
4319 out the names of those files that contain a match:
4321 $search = 'while (<>) { study;';
4322 foreach $word (@words) {
4323 $search .= "++\$seen{\$ARGV} if /\\b$word\\b/;\n";
4328 eval $search; # this screams
4329 $/ = "\n"; # put back to normal input delimiter
4330 foreach $file (sort keys(%seen)) {
4338 =item sub NAME BLOCK
4340 This is subroutine definition, not a real function I<per se>. With just a
4341 NAME (and possibly prototypes), it's just a forward declaration. Without
4342 a NAME, it's an anonymous function declaration, and does actually return a
4343 value: the CODE ref of the closure you just created. See L<perlsub> and
4344 L<perlref> for details.
4346 =item substr EXPR,OFFSET,LENGTH,REPLACEMENT
4348 =item substr EXPR,OFFSET,LENGTH
4350 =item substr EXPR,OFFSET
4352 Extracts a substring out of EXPR and returns it. First character is at
4353 offset C<0>, or whatever you've set C<$[> to (but don't do that).
4354 If OFFSET is negative (or more precisely, less than C<$[>), starts
4355 that far from the end of the string. If LENGTH is omitted, returns
4356 everything to the end of the string. If LENGTH is negative, leaves that
4357 many characters off the end of the string.
4359 You can use the substr() function as an lvalue, in which case EXPR
4360 must itself be an lvalue. If you assign something shorter than LENGTH,
4361 the string will shrink, and if you assign something longer than LENGTH,
4362 the string will grow to accommodate it. To keep the string the same
4363 length you may need to pad or chop your value using C<sprintf>.
4365 If OFFSET and LENGTH specify a substring that is partly outside the
4366 string, only the part within the string is returned. If the substring
4367 is beyond either end of the string, substr() returns the undefined
4368 value and produces a warning. When used as an lvalue, specifying a
4369 substring that is entirely outside the string is a fatal error.
4370 Here's an example showing the behavior for boundary cases:
4373 substr($name, 4) = 'dy'; # $name is now 'freddy'
4374 my $null = substr $name, 6, 2; # returns '' (no warning)
4375 my $oops = substr $name, 7; # returns undef, with warning
4376 substr($name, 7) = 'gap'; # fatal error
4378 An alternative to using substr() as an lvalue is to specify the
4379 replacement string as the 4th argument. This allows you to replace
4380 parts of the EXPR and return what was there before in one operation,
4381 just as you can with splice().
4383 =item symlink OLDFILE,NEWFILE
4385 Creates a new filename symbolically linked to the old filename.
4386 Returns C<1> for success, C<0> otherwise. On systems that don't support
4387 symbolic links, produces a fatal error at run time. To check for that,
4390 $symlink_exists = eval { symlink("",""); 1 };
4394 Calls the system call specified as the first element of the list,
4395 passing the remaining elements as arguments to the system call. If
4396 unimplemented, produces a fatal error. The arguments are interpreted
4397 as follows: if a given argument is numeric, the argument is passed as
4398 an int. If not, the pointer to the string value is passed. You are
4399 responsible to make sure a string is pre-extended long enough to
4400 receive any result that might be written into a string. You can't use a
4401 string literal (or other read-only string) as an argument to C<syscall>
4402 because Perl has to assume that any string pointer might be written
4404 integer arguments are not literals and have never been interpreted in a
4405 numeric context, you may need to add C<0> to them to force them to look
4406 like numbers. This emulates the C<syswrite> function (or vice versa):
4408 require 'syscall.ph'; # may need to run h2ph
4410 syscall(&SYS_write, fileno(STDOUT), $s, length $s);
4412 Note that Perl supports passing of up to only 14 arguments to your system call,
4413 which in practice should usually suffice.
4415 Syscall returns whatever value returned by the system call it calls.
4416 If the system call fails, C<syscall> returns C<-1> and sets C<$!> (errno).
4417 Note that some system calls can legitimately return C<-1>. The proper
4418 way to handle such calls is to assign C<$!=0;> before the call and
4419 check the value of C<$!> if syscall returns C<-1>.
4421 There's a problem with C<syscall(&SYS_pipe)>: it returns the file
4422 number of the read end of the pipe it creates. There is no way
4423 to retrieve the file number of the other end. You can avoid this
4424 problem by using C<pipe> instead.
4426 =item sysopen FILEHANDLE,FILENAME,MODE
4428 =item sysopen FILEHANDLE,FILENAME,MODE,PERMS
4430 Opens the file whose filename is given by FILENAME, and associates it
4431 with FILEHANDLE. If FILEHANDLE is an expression, its value is used as
4432 the name of the real filehandle wanted. This function calls the
4433 underlying operating system's C<open> function with the parameters
4434 FILENAME, MODE, PERMS.
4436 The possible values and flag bits of the MODE parameter are
4437 system-dependent; they are available via the standard module C<Fcntl>.
4438 See the documentation of your operating system's C<open> to see which
4439 values and flag bits are available. You may combine several flags
4440 using the C<|>-operator.
4442 Some of the most common values are C<O_RDONLY> for opening the file in
4443 read-only mode, C<O_WRONLY> for opening the file in write-only mode,
4444 and C<O_RDWR> for opening the file in read-write mode, and.
4446 For historical reasons, some values work on almost every system
4447 supported by perl: zero means read-only, one means write-only, and two
4448 means read/write. We know that these values do I<not> work under
4449 OS/390 & VM/ESA Unix and on the Macintosh; you probably don't want to
4450 se them in new code, use thhe constants discussed in the preceding
4453 If the file named by FILENAME does not exist and the C<open> call creates
4454 it (typically because MODE includes the C<O_CREAT> flag), then the value of
4455 PERMS specifies the permissions of the newly created file. If you omit
4456 the PERMS argument to C<sysopen>, Perl uses the octal value C<0666>.
4457 These permission values need to be in octal, and are modified by your
4458 process's current C<umask>.
4460 In many systems the C<O_EXCL> flag is available for opening files in
4461 exclusive mode. This is B<not> locking: exclusiveness means here that
4462 if the file already exists, sysopen() fails. The C<O_EXCL> wins
4465 Sometimes you may want to truncate an already-existing file: C<O_TRUNC>.
4467 You should seldom if ever use C<0644> as argument to C<sysopen>, because
4468 that takes away the user's option to have a more permissive umask.
4469 Better to omit it. See the perlfunc(1) entry on C<umask> for more
4472 See L<perlopentut> for a kinder, gentler explanation of opening files.
4474 =item sysread FILEHANDLE,SCALAR,LENGTH,OFFSET
4476 =item sysread FILEHANDLE,SCALAR,LENGTH
4478 Attempts to read LENGTH bytes of data into variable SCALAR from the
4479 specified FILEHANDLE, using the system call read(2). It bypasses stdio,
4480 so mixing this with other kinds of reads, C<print>, C<write>,
4481 C<seek>, C<tell>, or C<eof> can cause confusion because stdio
4482 usually buffers data. Returns the number of bytes actually read, C<0>
4483 at end of file, or undef if there was an error. SCALAR will be grown or
4484 shrunk so that the last byte actually read is the last byte of the
4485 scalar after the read.
4487 An OFFSET may be specified to place the read data at some place in the
4488 string other than the beginning. A negative OFFSET specifies
4489 placement at that many bytes counting backwards from the end of the
4490 string. A positive OFFSET greater than the length of SCALAR results
4491 in the string being padded to the required size with C<"\0"> bytes before
4492 the result of the read is appended.
4494 There is no syseof() function, which is ok, since eof() doesn't work
4495 very well on device files (like ttys) anyway. Use sysread() and check
4496 for a return value for 0 to decide whether you're done.
4498 =item sysseek FILEHANDLE,POSITION,WHENCE
4500 Sets FILEHANDLE's system position using the system call lseek(2). It
4501 bypasses stdio, so mixing this with reads (other than C<sysread>),
4502 C<print>, C<write>, C<seek>, C<tell>, or C<eof> may cause confusion.
4503 FILEHANDLE may be an expression whose value gives the name of the
4504 filehandle. The values for WHENCE are C<0> to set the new position to
4505 POSITION, C<1> to set the it to the current position plus POSITION,
4506 and C<2> to set it to EOF plus POSITION (typically negative). For
4507 WHENCE, you may also use the constants C<SEEK_SET>, C<SEEK_CUR>, and
4508 C<SEEK_END> (start of the file, current position, end of the file)
4509 from any of the modules Fcntl, C<IO::Seekable>, or POSIX.
4511 Returns the new position, or the undefined value on failure. A position
4512 of zero is returned as the string C<"0 but true">; thus C<sysseek> returns
4513 true on success and false on failure, yet you can still easily determine
4518 =item system PROGRAM LIST
4520 Does exactly the same thing as C<exec LIST>, except that a fork is
4521 done first, and the parent process waits for the child process to
4522 complete. Note that argument processing varies depending on the
4523 number of arguments. If there is more than one argument in LIST,
4524 or if LIST is an array with more than one value, starts the program
4525 given by the first element of the list with arguments given by the
4526 rest of the list. If there is only one scalar argument, the argument
4527 is checked for shell metacharacters, and if there are any, the
4528 entire argument is passed to the system's command shell for parsing
4529 (this is C</bin/sh -c> on Unix platforms, but varies on other
4530 platforms). If there are no shell metacharacters in the argument,
4531 it is split into words and passed directly to C<execvp>, which is
4534 All files opened for output are flushed before attempting the exec().
4536 The return value is the exit status of the program as
4537 returned by the C<wait> call. To get the actual exit value divide by
4538 256. See also L</exec>. This is I<not> what you want to use to capture
4539 the output from a command, for that you should use merely backticks or
4540 C<qx//>, as described in L<perlop/"`STRING`">. Return value of -1
4541 indicates a failure to start the program (inspect $! for the reason).
4543 Like C<exec>, C<system> allows you to lie to a program about its name if
4544 you use the C<system PROGRAM LIST> syntax. Again, see L</exec>.
4546 Because C<system> and backticks block C<SIGINT> and C<SIGQUIT>, killing the
4547 program they're running doesn't actually interrupt your program.
4549 @args = ("command", "arg1", "arg2");
4551 or die "system @args failed: $?"
4553 You can check all the failure possibilities by inspecting
4556 $exit_value = $? >> 8;
4557 $signal_num = $? & 127;
4558 $dumped_core = $? & 128;
4560 When the arguments get executed via the system shell, results
4561 and return codes will be subject to its quirks and capabilities.
4562 See L<perlop/"`STRING`"> and L</exec> for details.
4564 =item syswrite FILEHANDLE,SCALAR,LENGTH,OFFSET
4566 =item syswrite FILEHANDLE,SCALAR,LENGTH
4568 =item syswrite FILEHANDLE,SCALAR
4570 Attempts to write LENGTH bytes of data from variable SCALAR to the
4571 specified FILEHANDLE, using the system call write(2). If LENGTH
4572 is not specified, writes whole SCALAR. It bypasses stdio, so mixing
4573 this with reads (other than C<sysread())>, C<print>, C<write>,
4574 C<seek>, C<tell>, or C<eof> may cause confusion because stdio
4575 usually buffers data. Returns the number of bytes actually written,
4576 or C<undef> if there was an error. If the LENGTH is greater than
4577 the available data in the SCALAR after the OFFSET, only as much
4578 data as is available will be written.
4580 An OFFSET may be specified to write the data from some part of the
4581 string other than the beginning. A negative OFFSET specifies writing
4582 that many bytes counting backwards from the end of the string. In the
4583 case the SCALAR is empty you can use OFFSET but only zero offset.
4585 =item tell FILEHANDLE
4589 Returns the current position for FILEHANDLE. FILEHANDLE may be an
4590 expression whose value gives the name of the actual filehandle. If
4591 FILEHANDLE is omitted, assumes the file last read.
4593 There is no C<systell> function. Use C<sysseek(FH, 0, 1)> for that.
4595 =item telldir DIRHANDLE
4597 Returns the current position of the C<readdir> routines on DIRHANDLE.
4598 Value may be given to C<seekdir> to access a particular location in a
4599 directory. Has the same caveats about possible directory compaction as
4600 the corresponding system library routine.
4602 =item tie VARIABLE,CLASSNAME,LIST
4604 This function binds a variable to a package class that will provide the
4605 implementation for the variable. VARIABLE is the name of the variable
4606 to be enchanted. CLASSNAME is the name of a class implementing objects
4607 of correct type. Any additional arguments are passed to the C<new>
4608 method of the class (meaning C<TIESCALAR>, C<TIEHANDLE>, C<TIEARRAY>,
4609 or C<TIEHASH>). Typically these are arguments such as might be passed
4610 to the C<dbm_open()> function of C. The object returned by the C<new>
4611 method is also returned by the C<tie> function, which would be useful
4612 if you want to access other methods in CLASSNAME.
4614 Note that functions such as C<keys> and C<values> may return huge lists
4615 when used on large objects, like DBM files. You may prefer to use the
4616 C<each> function to iterate over such. Example:
4618 # print out history file offsets
4620 tie(%HIST, 'NDBM_File', '/usr/lib/news/history', 1, 0);
4621 while (($key,$val) = each %HIST) {
4622 print $key, ' = ', unpack('L',$val), "\n";
4626 A class implementing a hash should have the following methods:
4628 TIEHASH classname, LIST
4630 STORE this, key, value
4635 NEXTKEY this, lastkey
4638 A class implementing an ordinary array should have the following methods:
4640 TIEARRAY classname, LIST
4642 STORE this, key, value
4644 STORESIZE this, count
4650 SPLICE this, offset, length, LIST
4654 A class implementing a file handle should have the following methods:
4656 TIEHANDLE classname, LIST
4657 READ this, scalar, length, offset
4660 WRITE this, scalar, length, offset
4662 PRINTF this, format, LIST
4666 A class implementing a scalar should have the following methods:
4668 TIESCALAR classname, LIST
4673 Not all methods indicated above need be implemented. See L<perltie>,
4674 L<Tie::Hash>, L<Tie::Array>, L<Tie::Scalar>, and L<Tie::Handle>.
4676 Unlike C<dbmopen>, the C<tie> function will not use or require a module
4677 for you--you need to do that explicitly yourself. See L<DB_File>
4678 or the F<Config> module for interesting C<tie> implementations.
4680 For further details see L<perltie>, L<"tied VARIABLE">.
4684 Returns a reference to the object underlying VARIABLE (the same value
4685 that was originally returned by the C<tie> call that bound the variable
4686 to a package.) Returns the undefined value if VARIABLE isn't tied to a
4691 Returns the number of non-leap seconds since whatever time the system
4692 considers to be the epoch (that's 00:00:00, January 1, 1904 for MacOS,
4693 and 00:00:00 UTC, January 1, 1970 for most other systems).
4694 Suitable for feeding to C<gmtime> and C<localtime>.
4696 For measuring time in better granularity than one second,
4697 you may use either the Time::HiRes module from CPAN, or
4698 if you have gettimeofday(2), you may be able to use the
4699 C<syscall> interface of Perl, see L<perlfaq8> for details.
4703 Returns a four-element list giving the user and system times, in
4704 seconds, for this process and the children of this process.
4706 ($user,$system,$cuser,$csystem) = times;
4710 The transliteration operator. Same as C<y///>. See L<perlop>.
4712 =item truncate FILEHANDLE,LENGTH
4714 =item truncate EXPR,LENGTH
4716 Truncates the file opened on FILEHANDLE, or named by EXPR, to the
4717 specified length. Produces a fatal error if truncate isn't implemented
4718 on your system. Returns true if successful, the undefined value
4725 Returns an uppercased version of EXPR. This is the internal function
4726 implementing the C<\U> escape in double-quoted strings.
4727 Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale>.
4728 Under Unicode (C<use utf8>) it uses the standard Unicode uppercase mappings. (It
4729 does not attempt to do titlecase mapping on initial letters. See C<ucfirst> for that.)
4731 If EXPR is omitted, uses C<$_>.
4737 Returns the value of EXPR with the first character
4738 in uppercase (titlecase in Unicode). This is
4739 the internal function implementing the C<\u> escape in double-quoted strings.
4740 Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale>
4743 If EXPR is omitted, uses C<$_>.
4749 Sets the umask for the process to EXPR and returns the previous value.
4750 If EXPR is omitted, merely returns the current umask.
4752 The Unix permission C<rwxr-x---> is represented as three sets of three
4753 bits, or three octal digits: C<0750> (the leading 0 indicates octal
4754 and isn't one of the digits). The C<umask> value is such a number
4755 representing disabled permissions bits. The permission (or "mode")
4756 values you pass C<mkdir> or C<sysopen> are modified by your umask, so
4757 even if you tell C<sysopen> to create a file with permissions C<0777>,
4758 if your umask is C<0022> then the file will actually be created with
4759 permissions C<0755>. If your C<umask> were C<0027> (group can't
4760 write; others can't read, write, or execute), then passing
4761 C<sysopen> C<0666> would create a file with mode C<0640> (C<0666 &~
4764 Here's some advice: supply a creation mode of C<0666> for regular
4765 files (in C<sysopen>) and one of C<0777> for directories (in
4766 C<mkdir>) and executable files. This gives users the freedom of
4767 choice: if they want protected files, they might choose process umasks
4768 of C<022>, C<027>, or even the particularly antisocial mask of C<077>.
4769 Programs should rarely if ever make policy decisions better left to
4770 the user. The exception to this is when writing files that should be
4771 kept private: mail files, web browser cookies, I<.rhosts> files, and
4774 If umask(2) is not implemented on your system and you are trying to
4775 restrict access for I<yourself> (i.e., (EXPR & 0700) > 0), produces a
4776 fatal error at run time. If umask(2) is not implemented and you are
4777 not trying to restrict access for yourself, returns C<undef>.
4779 Remember that a umask is a number, usually given in octal; it is I<not> a
4780 string of octal digits. See also L</oct>, if all you have is a string.
4786 Undefines the value of EXPR, which must be an lvalue. Use only on a
4787 scalar value, an array (using C<@>), a hash (using C<%>), a subroutine
4788 (using C<&>), or a typeglob (using <*>). (Saying C<undef $hash{$key}>
4789 will probably not do what you expect on most predefined variables or
4790 DBM list values, so don't do that; see L<delete>.) Always returns the
4791 undefined value. You can omit the EXPR, in which case nothing is
4792 undefined, but you still get an undefined value that you could, for
4793 instance, return from a subroutine, assign to a variable or pass as a
4794 parameter. Examples:
4797 undef $bar{'blurfl'}; # Compare to: delete $bar{'blurfl'};
4801 undef *xyz; # destroys $xyz, @xyz, %xyz, &xyz, etc.
4802 return (wantarray ? (undef, $errmsg) : undef) if $they_blew_it;
4803 select undef, undef, undef, 0.25;
4804 ($a, $b, undef, $c) = &foo; # Ignore third value returned
4806 Note that this is a unary operator, not a list operator.
4812 Deletes a list of files. Returns the number of files successfully
4815 $cnt = unlink 'a', 'b', 'c';
4819 Note: C<unlink> will not delete directories unless you are superuser and
4820 the B<-U> flag is supplied to Perl. Even if these conditions are
4821 met, be warned that unlinking a directory can inflict damage on your
4822 filesystem. Use C<rmdir> instead.
4824 If LIST is omitted, uses C<$_>.
4826 =item unpack TEMPLATE,EXPR
4828 C<unpack> does the reverse of C<pack>: it takes a string
4829 representing a structure and expands it out into a list of values.
4830 (In scalar context, it returns merely the first value produced.)
4831 The TEMPLATE has the same format as in the C<pack> function.
4832 Here's a subroutine that does substring:
4835 my($what,$where,$howmuch) = @_;
4836 unpack("x$where a$howmuch", $what);
4841 sub ordinal { unpack("c",$_[0]); } # same as ord()
4843 In addition, you may prefix a field with a %E<lt>numberE<gt> to indicate that
4844 you want a E<lt>numberE<gt>-bit checksum of the items instead of the items
4845 themselves. Default is a 16-bit checksum. For example, the following
4846 computes the same number as the System V sum program:
4850 unpack("%32C*",<>) % 65535;
4853 The following efficiently counts the number of set bits in a bit vector:
4855 $setbits = unpack("%32b*", $selectmask);
4857 The C<"p"> and C<"P"> formats should be used with care. Since Perl
4858 has no way of checking whether the value passed to C<unpack()>
4859 corresponds to a valid memory location, passing a pointer value that's
4860 not known to be valid is likely to have disastrous consequences.
4862 See L</pack> for more examples and notes.
4864 =item untie VARIABLE
4866 Breaks the binding between a variable and a package. (See C<tie>.)
4868 =item unshift ARRAY,LIST
4870 Does the opposite of a C<shift>. Or the opposite of a C<push>,
4871 depending on how you look at it. Prepends list to the front of the
4872 array, and returns the new number of elements in the array.
4874 unshift(ARGV, '-e') unless $ARGV[0] =~ /^-/;
4876 Note the LIST is prepended whole, not one element at a time, so the
4877 prepended elements stay in the same order. Use C<reverse> to do the
4880 =item use Module LIST
4884 =item use Module VERSION LIST
4888 Imports some semantics into the current package from the named module,
4889 generally by aliasing certain subroutine or variable names into your
4890 package. It is exactly equivalent to
4892 BEGIN { require Module; import Module LIST; }
4894 except that Module I<must> be a bareword.
4896 If the first argument to C<use> is a number, it is treated as a version
4897 number instead of a module name. If the version of the Perl interpreter
4898 is less than VERSION, then an error message is printed and Perl exits
4899 immediately. This is often useful if you need to check the current
4900 Perl version before C<use>ing library modules that have changed in
4901 incompatible ways from older versions of Perl. (We try not to do
4902 this more than we have to.)
4904 The C<BEGIN> forces the C<require> and C<import> to happen at compile time. The
4905 C<require> makes sure the module is loaded into memory if it hasn't been
4906 yet. The C<import> is not a builtin--it's just an ordinary static method
4907 call into the C<Module> package to tell the module to import the list of
4908 features back into the current package. The module can implement its
4909 C<import> method any way it likes, though most modules just choose to
4910 derive their C<import> method via inheritance from the C<Exporter> class that
4911 is defined in the C<Exporter> module. See L<Exporter>. If no C<import>
4912 method can be found then the error is currently silently ignored. This
4913 may change to a fatal error in a future version.
4915 If you don't want your namespace altered, explicitly supply an empty list:
4919 That is exactly equivalent to
4921 BEGIN { require Module }
4923 If the VERSION argument is present between Module and LIST, then the
4924 C<use> will call the VERSION method in class Module with the given
4925 version as an argument. The default VERSION method, inherited from
4926 the Universal class, croaks if the given version is larger than the
4927 value of the variable C<$Module::VERSION>. (Note that there is not a
4928 comma after VERSION!)
4930 Because this is a wide-open interface, pragmas (compiler directives)
4931 are also implemented this way. Currently implemented pragmas are:
4935 use sigtrap qw(SEGV BUS);
4936 use strict qw(subs vars refs);
4937 use subs qw(afunc blurfl);
4938 use warning qw(all);
4940 Some of these pseudo-modules import semantics into the current
4941 block scope (like C<strict> or C<integer>, unlike ordinary modules,
4942 which import symbols into the current package (which are effective
4943 through the end of the file).
4945 There's a corresponding C<no> command that unimports meanings imported
4946 by C<use>, i.e., it calls C<unimport Module LIST> instead of C<import>.
4952 If no C<unimport> method can be found the call fails with a fatal error.
4954 See L<perlmod> for a list of standard modules and pragmas.
4958 Changes the access and modification times on each file of a list of
4959 files. The first two elements of the list must be the NUMERICAL access
4960 and modification times, in that order. Returns the number of files
4961 successfully changed. The inode change time of each file is set
4962 to the current time. This code has the same effect as the C<touch>
4963 command if the files already exist:
4967 utime $now, $now, @ARGV;
4971 Returns a list consisting of all the values of the named hash. (In a
4972 scalar context, returns the number of values.) The values are
4973 returned in an apparently random order. The actual random order is
4974 subject to change in future versions of perl, but it is guaranteed to
4975 be the same order as either the C<keys> or C<each> function would
4976 produce on the same (unmodified) hash.
4978 Note that you cannot modify the values of a hash this way, because the
4979 returned list is just a copy. You need to use a hash slice for that,
4980 since it's lvaluable in a way that values() is not.
4982 for (values %hash) { s/foo/bar/g } # FAILS!
4983 for (@hash{keys %hash}) { s/foo/bar/g } # ok
4985 As a side effect, calling values() resets the HASH's internal iterator.
4986 See also C<keys>, C<each>, and C<sort>.
4988 =item vec EXPR,OFFSET,BITS
4990 Treats the string in EXPR as a vector of unsigned integers, and
4991 returns the value of the bit field specified by OFFSET. BITS specifies
4992 the number of bits that are reserved for each entry in the bit
4993 vector. This must be a power of two from 1 to 32. C<vec> may also be
4994 assigned to, in which case parentheses are needed to give the expression
4995 the correct precedence as in
4997 vec($image, $max_x * $x + $y, 8) = 3;
4999 Vectors created with C<vec> can also be manipulated with the logical
5000 operators C<|>, C<&>, and C<^>, which will assume a bit vector operation is
5001 desired when both operands are strings. See L<perlop/"Bitwise String Operators">.
5003 The following code will build up an ASCII string saying C<'PerlPerlPerl'>.
5004 The comments show the string after each step. Note that this code works
5005 in the same way on big-endian or little-endian machines.
5008 vec($foo, 0, 32) = 0x5065726C; # 'Perl'
5009 vec($foo, 2, 16) = 0x5065; # 'PerlPe'
5010 vec($foo, 3, 16) = 0x726C; # 'PerlPerl'
5011 vec($foo, 8, 8) = 0x50; # 'PerlPerlP'
5012 vec($foo, 9, 8) = 0x65; # 'PerlPerlPe'
5013 vec($foo, 20, 4) = 2; # 'PerlPerlPe' . "\x02"
5014 vec($foo, 21, 4) = 7; # 'PerlPerlPer'
5016 vec($foo, 45, 2) = 3; # 'PerlPerlPer' . "\x0c"
5017 vec($foo, 93, 1) = 1; # 'PerlPerlPer' . "\x2c"
5018 vec($foo, 94, 1) = 1; # 'PerlPerlPerl'
5021 To transform a bit vector into a string or list of 0's and 1's, use these:
5023 $bits = unpack("b*", $vector);
5024 @bits = split(//, unpack("b*", $vector));
5026 If you know the exact length in bits, it can be used in place of the C<*>.
5030 Behaves like the wait(2) system call on your system: it waits for a child
5031 process to terminate and returns the pid of the deceased process, or
5032 C<-1> if there are no child processes. The status is returned in C<$?>.
5033 Note that a return value of C<-1> could mean that child processes are
5034 being automatically reaped, as described in L<perlipc>.
5036 =item waitpid PID,FLAGS
5038 Waits for a particular child process to terminate and returns the pid of
5039 the deceased process, or C<-1> if there is no such child process. On some
5040 systems, a value of 0 indicates that there are processes still running.
5041 The status is returned in C<$?>. If you say
5043 use POSIX ":sys_wait_h";
5046 $kid = waitpid(-1,&WNOHANG);
5049 then you can do a non-blocking wait for all pending zombie processes.
5050 Non-blocking wait is available on machines supporting either the
5051 waitpid(2) or wait4(2) system calls. However, waiting for a particular
5052 pid with FLAGS of C<0> is implemented everywhere. (Perl emulates the
5053 system call by remembering the status values of processes that have
5054 exited but have not been harvested by the Perl script yet.)
5056 Note that on some systems, a return value of C<-1> could mean that child
5057 processes are being automatically reaped. See L<perlipc> for details,
5058 and for other examples.
5062 Returns true if the context of the currently executing subroutine is
5063 looking for a list value. Returns false if the context is looking
5064 for a scalar. Returns the undefined value if the context is looking
5065 for no value (void context).
5067 return unless defined wantarray; # don't bother doing more
5068 my @a = complex_calculation();
5069 return wantarray ? @a : "@a";
5071 This function should have been named wantlist() instead.
5075 Produces a message on STDERR just like C<die>, but doesn't exit or throw
5078 If LIST is empty and C<$@> already contains a value (typically from a
5079 previous eval) that value is used after appending C<"\t...caught">
5080 to C<$@>. This is useful for staying almost, but not entirely similar to
5083 If C<$@> is empty then the string C<"Warning: Something's wrong"> is used.
5085 No message is printed if there is a C<$SIG{__WARN__}> handler
5086 installed. It is the handler's responsibility to deal with the message
5087 as it sees fit (like, for instance, converting it into a C<die>). Most
5088 handlers must therefore make arrangements to actually display the
5089 warnings that they are not prepared to deal with, by calling C<warn>
5090 again in the handler. Note that this is quite safe and will not
5091 produce an endless loop, since C<__WARN__> hooks are not called from
5094 You will find this behavior is slightly different from that of
5095 C<$SIG{__DIE__}> handlers (which don't suppress the error text, but can
5096 instead call C<die> again to change it).
5098 Using a C<__WARN__> handler provides a powerful way to silence all
5099 warnings (even the so-called mandatory ones). An example:
5101 # wipe out *all* compile-time warnings
5102 BEGIN { $SIG{'__WARN__'} = sub { warn $_[0] if $DOWARN } }
5104 my $foo = 20; # no warning about duplicate my $foo,
5105 # but hey, you asked for it!
5106 # no compile-time or run-time warnings before here
5109 # run-time warnings enabled after here
5110 warn "\$foo is alive and $foo!"; # does show up
5112 See L<perlvar> for details on setting C<%SIG> entries, and for more
5113 examples. See the Carp module for other kinds of warnings using its
5114 carp() and cluck() functions.
5116 =item write FILEHANDLE
5122 Writes a formatted record (possibly multi-line) to the specified FILEHANDLE,
5123 using the format associated with that file. By default the format for
5124 a file is the one having the same name as the filehandle, but the
5125 format for the current output channel (see the C<select> function) may be set
5126 explicitly by assigning the name of the format to the C<$~> variable.
5128 Top of form processing is handled automatically: if there is
5129 insufficient room on the current page for the formatted record, the
5130 page is advanced by writing a form feed, a special top-of-page format
5131 is used to format the new page header, and then the record is written.
5132 By default the top-of-page format is the name of the filehandle with
5133 "_TOP" appended, but it may be dynamically set to the format of your
5134 choice by assigning the name to the C<$^> variable while the filehandle is
5135 selected. The number of lines remaining on the current page is in
5136 variable C<$->, which can be set to C<0> to force a new page.
5138 If FILEHANDLE is unspecified, output goes to the current default output
5139 channel, which starts out as STDOUT but may be changed by the
5140 C<select> operator. If the FILEHANDLE is an EXPR, then the expression
5141 is evaluated and the resulting string is used to look up the name of
5142 the FILEHANDLE at run time. For more on formats, see L<perlform>.
5144 Note that write is I<not> the opposite of C<read>. Unfortunately.
5148 The transliteration operator. Same as C<tr///>. See L<perlop>.