This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
910510804ce68f1d123696977d27ca93c0838bad
[perl5.git] / pod / perlfunc.pod
1 =head1 NAME
2
3 perlfunc - Perl builtin functions
4
5 =head1 DESCRIPTION
6
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
20 arguments.
21
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.
29
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
37 be careful sometimes:
38
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.
44
45 If you run Perl with the B<-w> switch it can warn you about this.  For
46 example, the third line above produces:
47
48     print (...) interpreted as function at - line 1.
49     Useless use of integer addition in void context at - line 1.
50
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
54 C<time() + 86_400>.
55
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
59 null list.
60
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
70 consistency.
71
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.
78
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.
86
87 =head2 Perl Functions by Category
88
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
92 than one place.
93
94 =over
95
96 =item Functions for SCALARs or strings
97
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///>
101
102 =item Regular expressions and pattern matching
103
104 C<m//>, C<pos>, C<quotemeta>, C<s///>, C<split>, C<study>, C<qr//>
105
106 =item Numeric functions
107
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>
110
111 =item Functions for real @ARRAYs
112
113 C<pop>, C<push>, C<shift>, C<splice>, C<unshift>
114
115 =item Functions for list data
116
117 C<grep>, C<join>, C<map>, C<qw/STRING/>, C<reverse>, C<sort>, C<unpack>
118
119 =item Functions for real %HASHes
120
121 C<delete>, C<each>, C<exists>, C<keys>, C<values>
122
123 =item Input and output functions
124
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>,
129 C<warn>, C<write>
130
131 =item Functions for fixed length data or records
132
133 C<pack>, C<read>, C<syscall>, C<sysread>, C<syswrite>, C<unpack>, C<vec>
134
135 =item Functions for filehandles, files, or directories
136
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>,
140 C<unlink>, C<utime>
141
142 =item Keywords related to the control flow of your perl program
143
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>
146
147 =item Keywords related to scoping
148
149 C<caller>, C<import>, C<local>, C<my>, C<package>, C<use>
150
151 =item Miscellaneous functions
152
153 C<defined>, C<dump>, C<eval>, C<formline>, C<local>, C<my>, C<reset>,
154 C<scalar>, C<undef>, C<wantarray>
155
156 =item Functions for processes and process groups
157
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>
161
162 =item Keywords related to perl modules
163
164 C<do>, C<import>, C<no>, C<package>, C<require>, C<use>
165
166 =item Keywords related to classes and object-orientedness
167
168 C<bless>, C<dbmclose>, C<dbmopen>, C<package>, C<ref>, C<tie>, C<tied>,
169 C<untie>, C<use>
170
171 =item Low-level socket functions
172
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>
176
177 =item System V interprocess communication functions
178
179 C<msgctl>, C<msgget>, C<msgrcv>, C<msgsnd>, C<semctl>, C<semget>, C<semop>,
180 C<shmctl>, C<shmget>, C<shmread>, C<shmwrite>
181
182 =item Fetching user and group info
183
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>
187
188 =item Fetching network info
189
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>
195
196 =item Time-related functions
197
198 C<gmtime>, C<localtime>, C<time>, C<times>
199
200 =item Functions new in perl5
201
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>
206
207 * - C<sub> was a keyword in perl4, but in perl5 it is an
208 operator, which can be used in expressions.
209
210 =item Functions obsoleted in perl5
211
212 C<dbmclose>, C<dbmopen>
213
214 =back
215
216 =head2 Portability
217
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
222 by this are:
223
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>
240
241 For more information about the portability of these functions, see
242 L<perlport> and other available platform-specific documentation.
243
244 =head2 Alphabetical Listing of Perl Functions
245
246 =over 8
247
248 =item I<-X> FILEHANDLE
249
250 =item I<-X> EXPR
251
252 =item I<-X>
253
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>
265
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.
270
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.
275
276     -e  File exists.
277     -z  File has zero size.
278     -s  File has nonzero size (returns size).
279
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.
284     -S  File is a socket.
285     -b  File is a block special file.
286     -c  File is a character special file.
287     -t  Filehandle is opened to a tty.
288
289     -u  File has setuid bit set.
290     -g  File has setgid bit set.
291     -k  File has sticky bit set.
292
293     -T  File is an ASCII text file.
294     -B  File is a "binary" file (opposite of -T).
295
296     -M  Age of file in days when script started.
297     -A  Same for access time.
298     -C  Same for inode change time.
299
300 Example:
301
302     while (<>) {
303         chop;
304         next unless -f $_;      # ignore specials
305         #...
306     }
307
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
314 executable formats.
315
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.
321
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.
331
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.
335
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>.
346
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:
353
354     print "Can do.\n" if -r $a || -w _ || -x _;
355
356     stat($filename);
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 _;
365
366 =item abs VALUE
367
368 =item abs
369
370 Returns the absolute value of its argument.
371 If VALUE is omitted, uses C<$_>.
372
373 =item accept NEWSOCKET,GENERICSOCKET
374
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">.
378
379 =item alarm SECONDS
380
381 =item alarm
382
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.
392
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.
398
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>)
401
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">.
407
408     eval {
409         local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required
410         alarm $timeout;
411         $nread = sysread SOCKET, $buffer, $size;
412         alarm 0;
413     };
414     if ($@) {
415         die unless $@ eq "alarm\n";   # propagate unexpected errors
416         # timed out
417     }
418     else {
419         # didn't
420     }
421
422 =item atan2 Y,X
423
424 Returns the arctangent of Y/X in the range -PI to PI.
425
426 For the tangent operation, you may use the C<POSIX::tan()>
427 function, or use the familiar relation:
428
429     sub tan { sin($_[0]) / cos($_[0])  }
430
431 =item bind SOCKET,NAME
432
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">.
437
438 =item binmode FILEHANDLE
439
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
446 file.
447
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
459 match.)
460
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
468 you should.
469
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.
479
480 =item bless REF,CLASSNAME
481
482 =item bless REF
483
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.
491
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.
497
498 See L<perlmod/"Perl Modules">.
499
500 =item caller EXPR
501
502 =item caller
503
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
508
509     ($package, $filename, $line) = caller;
510
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.
514
515     ($package, $filename, $line, $subroutine, $hasargs,
516     $wantarray, $evaltext, $is_require, $hints) = caller($i);
517
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
527 C<use utf8>.
528
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.
532
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.
538
539 =item chdir EXPR
540
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>.
544
545 =item chmod LIST
546
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.
552
553     $cnt = chmod 0755, 'foo', 'bar';
554     chmod 0755, @executables;
555     $mode = '0644'; chmod $mode, 'foo';      # !!! sets mode to
556                                              # --w----r-T
557     $mode = '0644'; chmod oct($mode), 'foo'; # this is better
558     $mode = 0644;   chmod $mode, 'foo';      # this is best
559
560 =item chomp VARIABLE
561
562 =item chomp LIST
563
564 =item chomp
565
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
575 remove anything.  
576 If VARIABLE is omitted, it chomps C<$_>.  Example:
577
578     while (<>) {
579         chomp;  # avoid \n on last field
580         @array = split(/:/);
581         # ...
582     }
583
584 You can actually chomp anything that's an lvalue, including an assignment:
585
586     chomp($cwd = `pwd`);
587     chomp($answer = <STDIN>);
588
589 If you chomp a list, each element is chomped, and the total number of
590 characters removed is returned.
591
592 =item chop VARIABLE
593
594 =item chop LIST
595
596 =item chop
597
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<$_>.
602 Example:
603
604     while (<>) {
605         chop;   # avoid \n on last field
606         @array = split(/:/);
607         #...
608     }
609
610 You can actually chop anything that's an lvalue, including an assignment:
611
612     chop($cwd = `pwd`);
613     chop($answer = <STDIN>);
614
615 If you chop a list, each element is chopped.  Only the value of the
616 last C<chop> is returned.
617
618 Note that C<chop> returns the last character.  To return all but the last
619 character, use C<substr($string, 0, -1)>.
620
621 =item chown LIST
622
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.
628
629     $cnt = chown $uid, $gid, 'foo', 'bar';
630     chown $uid, $gid, @filenames;
631
632 Here's an example that looks up nonnumeric uids in the passwd file:
633
634     print "User: ";
635     chomp($user = <STDIN>);
636     print "Files: ";
637     chomp($pattern = <STDIN>);
638
639     ($login,$pass,$uid,$gid) = getpwnam($user)
640         or die "$user not in passwd file";
641
642     @ary = glob($pattern);      # expand filenames
643     chown $uid, $gid, @ary;
644
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:
650
651     use POSIX qw(sysconf _PC_CHOWN_RESTRICTED);
652     $can_chown_giveaway = not sysconf(_PC_CHOWN_RESTRICTED);
653
654 =item chr NUMBER
655
656 =item chr
657
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.
663
664 If NUMBER is omitted, uses C<$_>.
665
666 =item chroot FILENAME
667
668 =item chroot
669
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<$_>.
676
677 =item close FILEHANDLE
678
679 =item close
680
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
684 is omitted.
685
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.
690
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<$?>.
698
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.
703
704 Example:
705
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: $!";
714
715 FILEHANDLE may be an expression whose value can be used as an indirect
716 filehandle, usually the real filehandle name.
717
718 =item closedir DIRHANDLE
719
720 Closes a directory opened by C<opendir> and returns the success of that
721 system call.
722
723 DIRHANDLE may be an expression whose value can be used as an indirect
724 dirhandle, usually the real dirhandle name.
725
726 =item connect SOCKET,NAME
727
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">.
732
733 =item continue BLOCK
734
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>
741 statement).
742
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.
747
748     while (EXPR) {
749         ### redo always comes here
750         do_something;
751     } continue {
752         ### next always comes here
753         do_something_else;
754         # then back the top to re-check EXPR
755     }
756     ### last always comes here
757
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.
761
762 =item cos EXPR
763
764 Returns the cosine of EXPR (expressed in radians).  If EXPR is omitted,
765 takes cosine of C<$_>.
766
767 For the inverse cosine operation, you may use the C<POSIX::acos()>
768 function, or use this relation:
769
770     sub acos { atan2( sqrt(1 - $_[0] * $_[0]), $_[0] ) }
771
772 =item crypt PLAINTEXT,SALT
773
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.
779
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.)
784
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]>).
791
792 Here's an example that makes sure that whoever runs this program knows
793 their own password:
794
795     $pwd = (getpwuid($<))[1];
796
797     system "stty -echo";
798     print "Password: ";
799     chomp($word = <STDIN>);
800     print "\n";
801     system "stty echo";
802
803     if (crypt($word, $pwd) ne $pwd) {
804         die "Sorry...\n";
805     } else {
806         print "ok\n";
807     }
808
809 Of course, typing in your own password to whoever asks you
810 for it is unwise.
811
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
816 modules.
817
818 =item dbmclose HASH
819
820 [This function has been largely superseded by the C<untie> function.]
821
822 Breaks the binding between a DBM file and a hash.
823
824 =item dbmopen HASH,DBNAME,MASK
825
826 [This function has been largely superseded by the C<tie> function.]
827
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
837 sdbm(3).
838
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.
843
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:
847
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";
852     }
853     dbmclose(%HIST);
854
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
857 rich implementation.
858
859 You can control which DBM library you use by loading that library
860 before you call dbmopen():
861
862     use DB_File;
863     dbmopen(%NS_Hist, "$ENV{HOME}/.netscape/history.db")
864         or die "Can't open netscape history file: $!";
865
866 =item defined EXPR
867
868 =item defined
869
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
872 checked.
873
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>.
883
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>.
887
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:
892
893     if (@an_array) { print "has array elements\n" }
894     if (%a_hash)   { print "has hash members\n"   }
895
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
898 purpose.
899
900 Examples:
901
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;
908
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
912
913     "ab" =~ /a(.*)b/;
914
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
922 what you want.
923
924 See also L</undef>, L</exists>, L</ref>.
925
926 =item delete EXPR
927
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.)
934
935 The following deletes all the values of a hash:
936
937     foreach $key (keys %HASH) {
938         delete $HASH{$key};
939     }
940
941 And so does this:
942
943     delete @HASH{keys %HASH}
944
945 But both of these are slower than just assigning the empty list
946 or undefining it:
947
948     %hash = ();         # completely empty %hash
949     undef %hash;        # forget %hash every existed
950
951 Note that the EXPR can be arbitrarily complicated as long as the final
952 operation is a hash element lookup or hash slice:
953
954     delete $ref->[$x][$y]{$key};
955     delete @{$ref->[$x][$y]}{$key1, $key2, @morekeys};
956
957 =item die LIST
958
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.
966
967 Equivalent examples:
968
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"
971
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/"$.">.
978
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".
982
983     die "/etc/games is no good";
984     die "/etc/games is no good, stopped";
985
986 produce, respectively
987
988     /etc/games is no good at canasta line 123.
989     /etc/games is no good, stopped at canasta line 123.
990
991 See also exit(), warn(), and the Carp module.
992
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:
996
997     eval { ... };
998     die unless $@ =~ /Expected exception/;
999
1000 If C<$@> is empty then the string C<"Died"> is used.
1001
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:
1008
1009     eval { ... ; die Some::Module::Exception->new( FOO => "bar" ) };
1010     if ($@) {
1011         if (ref($@) && UNIVERSAL::isa($@,"Some::Module::Exception")) {
1012             # handle Some::Module::Exception
1013         }
1014         else {
1015             # handle all other possible exceptions
1016         }
1017     }
1018
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.
1022
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
1033
1034         die @_ if $^S;
1035
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.  
1039
1040 =item do BLOCK
1041
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.)
1046
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.
1050
1051 =item do SUBROUTINE(LIST)
1052
1053 A deprecated form of subroutine call.  See L<perlsub>.
1054
1055 =item do EXPR
1056
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.
1060
1061     do 'stat.pl';
1062
1063 is just like
1064
1065     scalar eval `cat stat.pl`;
1066
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.
1074
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
1079 evaluated.
1080
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.
1084
1085 You might like to use C<do> to read in a program configuration
1086 file.  Manual error checking can be done this way:
1087
1088     # read in config files: system first, then user 
1089     for $file ("/share/prog/defaults.rc",
1090                "$ENV{HOME}/.someprogrc") 
1091    {
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;
1096         }
1097     }
1098
1099 =item dump LABEL
1100
1101 =item dump
1102
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.
1112
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.  
1116
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.
1121
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.  
1128
1129 =item each HASH
1130
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) {}>
1136 for this reason.)
1137
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.
1142
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.
1151
1152 The following prints out your environment like the printenv(1) program,
1153 only in a different order:
1154
1155     while (($key,$value) = each %ENV) {
1156         print "$key=$value\n";
1157     }
1158
1159 See also C<keys>, C<values> and C<sort>.
1160
1161 =item eof FILEHANDLE
1162
1163 =item eof ()
1164
1165 =item eof
1166
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.
1174
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:
1182
1183     # reset line numbering on each input file
1184     while (<>) {
1185         next if /^\s*#/;        # skip comments 
1186         print "$.\t$_";
1187     } continue {
1188         close ARGV  if eof;     # Not eof()!
1189     }
1190
1191     # insert dashes just before last line of last file
1192     while (<>) {
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
1197         }
1198         print;
1199     }
1200
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
1203 was an error.
1204
1205 =item eval EXPR
1206
1207 =item eval BLOCK
1208
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.
1217
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
1223 time.
1224
1225 The final semicolon, if any, may be omitted from the value of EXPR or within
1226 the BLOCK.
1227
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.
1233
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>.
1241
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.
1246
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<$@>.
1250 Examples:
1251
1252     # make divide-by-zero nonfatal
1253     eval { $answer = $a / $b; }; warn $@ if $@;
1254
1255     # same thing, but less efficient
1256     eval '$answer = $a / $b'; warn $@ if $@;
1257
1258     # a compile-time error
1259     eval { $answer = };                 # WRONG
1260
1261     # a run-time error
1262     eval '$answer =';   # sets $@
1263
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:
1269
1270     # a very private exception trap for divide-by-zero
1271     eval { local $SIG{'__DIE__'}; $answer = $a / $b; };
1272     warn $@ if $@;
1273
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:
1276
1277     # __DIE__ hooks may modify error messages
1278     {
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"
1283     }
1284
1285 Because this promotes action at a distance, this counterintuitive behavior
1286 may be fixed in a future release.
1287
1288 With an C<eval>, you should be especially careful to remember what's
1289 being looked at when:
1290
1291     eval $x;            # CASE 1
1292     eval "$x";          # CASE 2
1293
1294     eval '$x';          # CASE 3
1295     eval { $x };        # CASE 4
1296
1297     eval "\$$x++";      # CASE 5
1298     $$x++;              # CASE 6
1299
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
1309 in case 6.
1310
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.
1313
1314 =item exec LIST
1315
1316 =item exec PROGRAM LIST
1317
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).
1322
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:
1328
1329     exec ('foo')   or print STDERR "couldn't exec foo: $!";
1330     { exec ('foo') }; print STDERR "couldn't exec foo: $!";
1331
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.  
1340 Examples:
1341
1342     exec '/bin/echo', 'Your arguments are: ', @ARGV;
1343     exec "sort $outfile | uniq";
1344
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
1350 the list.)  Example:
1351
1352     $shell = '/bin/csh';
1353     exec $shell '-sh';          # pretend it's a login shell
1354
1355 or, more directly,
1356
1357     exec {'/bin/csh'} '-sh';    # pretend it's a login shell
1358
1359 When the arguments get executed via the system shell, results will
1360 be subject to its quirks and capabilities.  See L<perlop/"`STRING`">
1361 for details.
1362
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.
1368
1369     @args = ( "echo surprise" );
1370
1371     exec @args;               # subject to shell escapes
1372                                 # if @args == 1
1373     exec { $args[0] } @args;  # safe even with one-arg list
1374
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.
1379
1380 Note that C<exec> will not call your C<END> blocks, nor will it call
1381 any C<DESTROY> methods in your objects.
1382
1383 =item exists EXPR
1384
1385 Returns true if the specified hash key exists in its hash, even
1386 if the corresponding value is undefined.
1387
1388     print "Exists\n"    if exists $array{$key};
1389     print "Defined\n"   if defined $array{$key};
1390     print "True\n"      if $array{$key};
1391
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.
1394
1395 Note that the EXPR can be arbitrarily complicated as long as the final
1396 operation is a hash key lookup:
1397
1398     if (exists $ref->{A}->{B}->{$key})  { }
1399     if (exists $hash{A}{B}{$key})       { }
1400
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 
1406
1407     undef $ref;
1408     if (exists $ref->{"Some key"})      { }
1409     print $ref;             # prints HASH(0x80d3d5c)
1410
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
1413 release.
1414
1415 See L<perlref/"Pseudo-hashes"> for specifics on how exists() acts when
1416 used on a pseudo-hash.
1417
1418 =item exit EXPR
1419
1420 Evaluates EXPR and exits immediately with that value.    Example:
1421
1422     $ans = <STDIN>;
1423     exit 0 if $ans =~ /^[Xx]/;
1424
1425 See also C<die>.  If EXPR is omitted, exits with C<0> status.  The only
1426 universally recognized values for EXPR are C<0> for success and C<1>
1427 for error; other values are subject to interpretation depending on the
1428 environment in which the Perl program is running.  For example, exiting
1429 69 (EX_UNAVAILABLE) from a I<sendmail> incoming-mail filter will cause
1430 the mailer to return the item undelivered, but that's not true everywhere.
1431
1432 Don't use C<exit> to abort a subroutine if there's any chance that
1433 someone might want to trap whatever error happened.  Use C<die> instead,
1434 which can be trapped by an C<eval>.
1435
1436 The exit() function does not always exit immediately.  It calls any
1437 defined C<END> routines first, but these C<END> routines may not
1438 themselves abort the exit.  Likewise any object destructors that need to
1439 be called are called before the real exit.  If this is a problem, you
1440 can call C<POSIX:_exit($status)> to avoid END and destructor processing.
1441 See L<perlmod> for details.
1442
1443 =item exp EXPR
1444
1445 =item exp
1446
1447 Returns I<e> (the natural logarithm base) to the power of EXPR.  
1448 If EXPR is omitted, gives C<exp($_)>.
1449
1450 =item fcntl FILEHANDLE,FUNCTION,SCALAR
1451
1452 Implements the fcntl(2) function.  You'll probably have to say
1453
1454     use Fcntl;
1455
1456 first to get the correct constant definitions.  Argument processing and
1457 value return works just like C<ioctl> below.  
1458 For example:
1459
1460     use Fcntl;
1461     fcntl($filehandle, F_GETFL, $packed_return_buffer)
1462         or die "can't fcntl F_GETFL: $!";
1463
1464 You don't have to check for C<defined> on the return from C<fnctl>.
1465 Like C<ioctl>, it maps a C<0> return from the system call into C<"0
1466 but true"> in Perl.  This string is true in boolean context and C<0>
1467 in numeric context.  It is also exempt from the normal B<-w> warnings
1468 on improper numeric conversions.
1469
1470 Note that C<fcntl> will produce a fatal error if used on a machine that
1471 doesn't implement fcntl(2).  See the Fcntl module or your fcntl(2)
1472 manpage to learn what functions are available on your system.
1473
1474 =item fileno FILEHANDLE
1475
1476 Returns the file descriptor for a filehandle, or undefined if the
1477 filehandle is not open.  This is mainly useful for constructing
1478 bitmaps for C<select> and low-level POSIX tty-handling operations.
1479 If FILEHANDLE is an expression, the value is taken as an indirect
1480 filehandle, generally its name.
1481
1482 You can use this to find out whether two handles refer to the 
1483 same underlying descriptor:
1484
1485     if (fileno(THIS) == fileno(THAT)) {
1486         print "THIS and THAT are dups\n";
1487     } 
1488
1489 =item flock FILEHANDLE,OPERATION
1490
1491 Calls flock(2), or an emulation of it, on FILEHANDLE.  Returns true
1492 for success, false on failure.  Produces a fatal error if used on a
1493 machine that doesn't implement flock(2), fcntl(2) locking, or lockf(3).
1494 C<flock> is Perl's portable file locking interface, although it locks
1495 only entire files, not records.
1496
1497 Two potentially non-obvious but traditional C<flock> semantics are
1498 that it waits indefinitely until the lock is granted, and that its locks
1499 B<merely advisory>.  Such discretionary locks are more flexible, but offer
1500 fewer guarantees.  This means that files locked with C<flock> may be
1501 modified by programs that do not also use C<flock>.  See L<perlport>,
1502 your port's specific documentation, or your system-specific local manpages
1503 for details.  It's best to assume traditional behavior if you're writing
1504 portable programs.  (But if you're not, you should as always feel perfectly
1505 free to write for your own system's idiosyncrasies (sometimes called
1506 "features").  Slavish adherence to portability concerns shouldn't get
1507 in the way of your getting your job done.)
1508
1509 OPERATION is one of LOCK_SH, LOCK_EX, or LOCK_UN, possibly combined with
1510 LOCK_NB.  These constants are traditionally valued 1, 2, 8 and 4, but
1511 you can use the symbolic names if import them from the Fcntl module,
1512 either individually, or as a group using the ':flock' tag.  LOCK_SH
1513 requests a shared lock, LOCK_EX requests an exclusive lock, and LOCK_UN
1514 releases a previously requested lock.  If LOCK_NB is added to LOCK_SH or
1515 LOCK_EX then C<flock> will return immediately rather than blocking
1516 waiting for the lock (check the return status to see if you got it).
1517
1518 To avoid the possibility of miscoordination, Perl now flushes FILEHANDLE
1519 before locking or unlocking it.
1520
1521 Note that the emulation built with lockf(3) doesn't provide shared
1522 locks, and it requires that FILEHANDLE be open with write intent.  These
1523 are the semantics that lockf(3) implements.  Most if not all systems
1524 implement lockf(3) in terms of fcntl(2) locking, though, so the
1525 differing semantics shouldn't bite too many people.
1526
1527 Note also that some versions of C<flock> cannot lock things over the
1528 network; you would need to use the more system-specific C<fcntl> for
1529 that.  If you like you can force Perl to ignore your system's flock(2)
1530 function, and so provide its own fcntl(2)-based emulation, by passing
1531 the switch C<-Ud_flock> to the F<Configure> program when you configure
1532 perl.
1533
1534 Here's a mailbox appender for BSD systems.
1535
1536     use Fcntl ':flock'; # import LOCK_* constants
1537
1538     sub lock {
1539         flock(MBOX,LOCK_EX);
1540         # and, in case someone appended
1541         # while we were waiting...
1542         seek(MBOX, 0, 2);
1543     }
1544
1545     sub unlock {
1546         flock(MBOX,LOCK_UN);
1547     }
1548
1549     open(MBOX, ">>/usr/spool/mail/$ENV{'USER'}")
1550             or die "Can't open mailbox: $!";
1551
1552     lock();
1553     print MBOX $msg,"\n\n";
1554     unlock();
1555
1556 On systems that support a real flock(), locks are inherited across fork()
1557 calls, whereas those that must resort to the more capricious fcntl()
1558 function lose the locks, making it harder to write servers.
1559
1560 See also L<DB_File> for other flock() examples.
1561
1562 =item fork
1563
1564 Does a fork(2) system call to create a new process running the
1565 same program at the same point.  It returns the child pid to the
1566 parent process, C<0> to the child process, or C<undef> if the fork is
1567 unsuccessful.  File descriptors (and sometimes locks on those descriptors)
1568 are shared, while everything else is copied.  On most systems supporting
1569 fork(), great care has gone into making it extremely efficient (for
1570 example, using copy-on-write technology on data pages), making it the
1571 dominant paradigm for multitasking over the last few decades.
1572
1573 All files opened for output are flushed before forking the child process.
1574
1575 If you C<fork> without ever waiting on your children, you will
1576 accumulate zombies.  On some systems, you can avoid this by setting
1577 C<$SIG{CHLD}> to C<"IGNORE">.  See also L<perlipc> for more examples of
1578 forking and reaping moribund children.
1579
1580 Note that if your forked child inherits system file descriptors like
1581 STDIN and STDOUT that are actually connected by a pipe or socket, even
1582 if you exit, then the remote server (such as, say, a CGI script or a
1583 backgrounded job launched from a remote shell) won't think you're done.
1584 You should reopen those to F</dev/null> if it's any issue.
1585
1586 =item format
1587
1588 Declare a picture format for use by the C<write> function.  For
1589 example:
1590
1591     format Something =
1592         Test: @<<<<<<<< @||||| @>>>>>
1593               $str,     $%,    '$' . int($num)
1594     .
1595
1596     $str = "widget";
1597     $num = $cost/$quantity;
1598     $~ = 'Something';
1599     write;
1600
1601 See L<perlform> for many details and examples.
1602
1603 =item formline PICTURE,LIST
1604
1605 This is an internal function used by C<format>s, though you may call it,
1606 too.  It formats (see L<perlform>) a list of values according to the
1607 contents of PICTURE, placing the output into the format output
1608 accumulator, C<$^A> (or C<$ACCUMULATOR> in English).
1609 Eventually, when a C<write> is done, the contents of
1610 C<$^A> are written to some filehandle, but you could also read C<$^A>
1611 yourself and then set C<$^A> back to C<"">.  Note that a format typically
1612 does one C<formline> per line of form, but the C<formline> function itself
1613 doesn't care how many newlines are embedded in the PICTURE.  This means
1614 that the C<~> and C<~~> tokens will treat the entire PICTURE as a single line.
1615 You may therefore need to use multiple formlines to implement a single
1616 record format, just like the format compiler.
1617
1618 Be careful if you put double quotes around the picture, because an C<@>
1619 character may be taken to mean the beginning of an array name.
1620 C<formline> always returns true.  See L<perlform> for other examples.
1621
1622 =item getc FILEHANDLE
1623
1624 =item getc
1625
1626 Returns the next character from the input file attached to FILEHANDLE,
1627 or the undefined value at end of file, or if there was an error.
1628 If FILEHANDLE is omitted, reads from STDIN.  This is not particularly
1629 efficient.  However, it cannot be used by itself to fetch single
1630 characters without waiting for the user to hit enter.  For that, try
1631 something more like:
1632
1633     if ($BSD_STYLE) {
1634         system "stty cbreak </dev/tty >/dev/tty 2>&1";
1635     }
1636     else {
1637         system "stty", '-icanon', 'eol', "\001";
1638     }
1639
1640     $key = getc(STDIN);
1641
1642     if ($BSD_STYLE) {
1643         system "stty -cbreak </dev/tty >/dev/tty 2>&1";
1644     }
1645     else {
1646         system "stty", 'icanon', 'eol', '^@'; # ASCII null
1647     }
1648     print "\n";
1649
1650 Determination of whether $BSD_STYLE should be set
1651 is left as an exercise to the reader.
1652
1653 The C<POSIX::getattr> function can do this more portably on
1654 systems purporting POSIX compliance.  See also the C<Term::ReadKey>
1655 module from your nearest CPAN site; details on CPAN can be found on
1656 L<perlmodlib/CPAN>.
1657
1658 =item getlogin
1659
1660 Implements the C library function of the same name, which on most
1661 systems returns the current login from F</etc/utmp>, if any.  If null,
1662 use C<getpwuid>.
1663
1664     $login = getlogin || getpwuid($<) || "Kilroy";
1665
1666 Do not consider C<getlogin> for authentication: it is not as
1667 secure as C<getpwuid>.
1668
1669 =item getpeername SOCKET
1670
1671 Returns the packed sockaddr address of other end of the SOCKET connection.
1672
1673     use Socket;
1674     $hersockaddr    = getpeername(SOCK);
1675     ($port, $iaddr) = sockaddr_in($hersockaddr);
1676     $herhostname    = gethostbyaddr($iaddr, AF_INET);
1677     $herstraddr     = inet_ntoa($iaddr);
1678
1679 =item getpgrp PID
1680
1681 Returns the current process group for the specified PID.  Use
1682 a PID of C<0> to get the current process group for the
1683 current process.  Will raise an exception if used on a machine that
1684 doesn't implement getpgrp(2).  If PID is omitted, returns process
1685 group of current process.  Note that the POSIX version of C<getpgrp>
1686 does not accept a PID argument, so only C<PID==0> is truly portable.
1687
1688 =item getppid
1689
1690 Returns the process id of the parent process.
1691
1692 =item getpriority WHICH,WHO
1693
1694 Returns the current priority for a process, a process group, or a user.
1695 (See L<getpriority(2)>.)  Will raise a fatal exception if used on a
1696 machine that doesn't implement getpriority(2).
1697
1698 =item getpwnam NAME
1699
1700 =item getgrnam NAME
1701
1702 =item gethostbyname NAME
1703
1704 =item getnetbyname NAME
1705
1706 =item getprotobyname NAME
1707
1708 =item getpwuid UID
1709
1710 =item getgrgid GID
1711
1712 =item getservbyname NAME,PROTO
1713
1714 =item gethostbyaddr ADDR,ADDRTYPE
1715
1716 =item getnetbyaddr ADDR,ADDRTYPE
1717
1718 =item getprotobynumber NUMBER
1719
1720 =item getservbyport PORT,PROTO
1721
1722 =item getpwent
1723
1724 =item getgrent
1725
1726 =item gethostent
1727
1728 =item getnetent
1729
1730 =item getprotoent
1731
1732 =item getservent
1733
1734 =item setpwent
1735
1736 =item setgrent
1737
1738 =item sethostent STAYOPEN
1739
1740 =item setnetent STAYOPEN
1741
1742 =item setprotoent STAYOPEN
1743
1744 =item setservent STAYOPEN
1745
1746 =item endpwent
1747
1748 =item endgrent
1749
1750 =item endhostent
1751
1752 =item endnetent
1753
1754 =item endprotoent
1755
1756 =item endservent
1757
1758 These routines perform the same functions as their counterparts in the
1759 system library.  In list context, the return values from the
1760 various get routines are as follows:
1761
1762     ($name,$passwd,$uid,$gid,
1763        $quota,$comment,$gcos,$dir,$shell,$expire) = getpw*
1764     ($name,$passwd,$gid,$members) = getgr*
1765     ($name,$aliases,$addrtype,$length,@addrs) = gethost*
1766     ($name,$aliases,$addrtype,$net) = getnet*
1767     ($name,$aliases,$proto) = getproto*
1768     ($name,$aliases,$port,$proto) = getserv*
1769
1770 (If the entry doesn't exist you get a null list.)
1771
1772 In scalar context, you get the name, unless the function was a
1773 lookup by name, in which case you get the other thing, whatever it is.
1774 (If the entry doesn't exist you get the undefined value.)  For example:
1775
1776     $uid   = getpwnam($name);
1777     $name  = getpwuid($num);
1778     $name  = getpwent();
1779     $gid   = getgrnam($name);
1780     $name  = getgrgid($num;
1781     $name  = getgrent();
1782     #etc.
1783
1784 In I<getpw*()> the fields $quota, $comment, and $expire are
1785 special cases in the sense that in many systems they are unsupported.
1786 If the $quota is unsupported, it is an empty scalar.  If it is
1787 supported, it usually encodes the disk quota.  If the $comment
1788 field is unsupported, it is an empty scalar.  If it is supported it
1789 usually encodes some administrative comment about the user.  In some
1790 systems the $quota field may be $change or $age, fields that have
1791 to do with password aging.  In some systems the $comment field may
1792 be $class.  The $expire field, if present, encodes the expiration
1793 period of the account or the password.  For the availability and the
1794 exact meaning of these fields in your system, please consult your
1795 getpwnam(3) documentation and your F<pwd.h> file.  You can also find
1796 out from within Perl what your $quota and $comment fields mean
1797 and whether you have the $expire field by using the C<Config> module
1798 and the values C<d_pwquota>, C<d_pwage>, C<d_pwchange>, C<d_pwcomment>,
1799 and C<d_pwexpire>.  Shadow password files are only supported if your
1800 vendor has implemented them in the intuitive fashion that calling the
1801 regular C library routines gets the shadow versions if you're running
1802 under privilege.  Those that incorrectly implement a separate library
1803 call are not supported.
1804
1805 The $members value returned by I<getgr*()> is a space separated list of
1806 the login names of the members of the group.
1807
1808 For the I<gethost*()> functions, if the C<h_errno> variable is supported in
1809 C, it will be returned to you via C<$?> if the function call fails.  The
1810 C<@addrs> value returned by a successful call is a list of the raw
1811 addresses returned by the corresponding system library call.  In the
1812 Internet domain, each address is four bytes long and you can unpack it
1813 by saying something like:
1814
1815     ($a,$b,$c,$d) = unpack('C4',$addr[0]);
1816
1817 The Socket library makes this slightly easier:
1818
1819     use Socket;
1820     $iaddr = inet_aton("127.1"); # or whatever address
1821     $name  = gethostbyaddr($iaddr, AF_INET);
1822
1823     # or going the other way
1824     $straddr = inet_ntoa($iaddr);
1825
1826 If you get tired of remembering which element of the return list
1827 contains which return value, by-name interfaces are provided
1828 in standard modules: C<File::stat>, C<Net::hostent>, C<Net::netent>,
1829 C<Net::protoent>, C<Net::servent>, C<Time::gmtime>, C<Time::localtime>,
1830 and C<User::grent>.  These override the normal built-ins, supplying
1831 versions that return objects with the appropriate names
1832 for each field.  For example:
1833
1834    use File::stat;
1835    use User::pwent;
1836    $is_his = (stat($filename)->uid == pwent($whoever)->uid);
1837
1838 Even though it looks like they're the same method calls (uid), 
1839 they aren't, because a C<File::stat> object is different from 
1840 a C<User::pwent> object.
1841
1842 =item getsockname SOCKET
1843
1844 Returns the packed sockaddr address of this end of the SOCKET connection,
1845 in case you don't know the address because you have several different
1846 IPs that the connection might have come in on.
1847
1848     use Socket;
1849     $mysockaddr = getsockname(SOCK);
1850     ($port, $myaddr) = sockaddr_in($mysockaddr);
1851     printf "Connect to %s [%s]\n", 
1852        scalar gethostbyaddr($myaddr, AF_INET),
1853        inet_ntoa($myaddr);
1854
1855 =item getsockopt SOCKET,LEVEL,OPTNAME
1856
1857 Returns the socket option requested, or undef if there is an error.
1858
1859 =item glob EXPR
1860
1861 =item glob
1862
1863 Returns the value of EXPR with filename expansions such as the
1864 standard Unix shell F</bin/csh> would do.  This is the internal function
1865 implementing the C<E<lt>*.cE<gt>> operator, but you can use it directly.
1866 If EXPR is omitted, C<$_> is used.  The C<E<lt>*.cE<gt>> operator is
1867 discussed in more detail in L<perlop/"I/O Operators">.
1868
1869 =item gmtime EXPR
1870
1871 Converts a time as returned by the time function to a 9-element list
1872 with the time localized for the standard Greenwich time zone.
1873 Typically used as follows:
1874
1875     #  0    1    2     3     4    5     6     7     8
1876     ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
1877                                             gmtime(time);
1878
1879 All list elements are numeric, and come straight out of a struct tm.
1880 In particular this means that $mon has the range C<0..11> and $wday
1881 has the range C<0..6> with sunday as day C<0>.  Also, $year is the
1882 number of years since 1900, that is, $year is C<123> in year 2023,
1883 I<not> simply the last two digits of the year.  If you assume it is,
1884 then you create non-Y2K-compliant programs--and you wouldn't want to do
1885 that, would you?
1886
1887 If EXPR is omitted, does C<gmtime(time())>.
1888
1889 In scalar context, returns the ctime(3) value:
1890
1891     $now_string = gmtime;  # e.g., "Thu Oct 13 04:54:34 1994"
1892
1893 Also see the C<timegm> function provided by the C<Time::Local> module,
1894 and the strftime(3) function available via the POSIX module.
1895
1896 This scalar value is B<not> locale dependent (see L<perllocale>), but
1897 is instead a Perl builtin.  Also see the C<Time::Local> module, and the
1898 strftime(3) and mktime(3) functions available via the POSIX module.  To
1899 get somewhat similar but locale dependent date strings, set up your
1900 locale environment variables appropriately (please see L<perllocale>)
1901 and try for example:
1902
1903     use POSIX qw(strftime);
1904     $now_string = strftime "%a %b %e %H:%M:%S %Y", gmtime;
1905
1906 Note that the C<%a> and C<%b> escapes, which represent the short forms
1907 of the day of the week and the month of the year, may not necessarily
1908 be three characters wide in all locales.
1909
1910 =item goto LABEL
1911
1912 =item goto EXPR
1913
1914 =item goto &NAME
1915
1916 The C<goto-LABEL> form finds the statement labeled with LABEL and resumes
1917 execution there.  It may not be used to go into any construct that
1918 requires initialization, such as a subroutine or a C<foreach> loop.  It
1919 also can't be used to go into a construct that is optimized away,
1920 or to get out of a block or subroutine given to C<sort>.
1921 It can be used to go almost anywhere else within the dynamic scope,
1922 including out of subroutines, but it's usually better to use some other
1923 construct such as C<last> or C<die>.  The author of Perl has never felt the
1924 need to use this form of C<goto> (in Perl, that is--C is another matter).
1925
1926 The C<goto-EXPR> form expects a label name, whose scope will be resolved
1927 dynamically.  This allows for computed C<goto>s per FORTRAN, but isn't
1928 necessarily recommended if you're optimizing for maintainability:
1929
1930     goto ("FOO", "BAR", "GLARCH")[$i];
1931
1932 The C<goto-&NAME> form is highly magical, and substitutes a call to the
1933 named subroutine for the currently running subroutine.  This is used by
1934 C<AUTOLOAD> subroutines that wish to load another subroutine and then
1935 pretend that the other subroutine had been called in the first place
1936 (except that any modifications to C<@_> in the current subroutine are
1937 propagated to the other subroutine.)  After the C<goto>, not even C<caller>
1938 will be able to tell that this routine was called first.
1939
1940 =item grep BLOCK LIST
1941
1942 =item grep EXPR,LIST
1943
1944 This is similar in spirit to, but not the same as, grep(1) and its
1945 relatives.  In particular, it is not limited to using regular expressions.
1946
1947 Evaluates the BLOCK or EXPR for each element of LIST (locally setting
1948 C<$_> to each element) and returns the list value consisting of those
1949 elements for which the expression evaluated to true.  In scalar
1950 context, returns the number of times the expression was true.
1951
1952     @foo = grep(!/^#/, @bar);    # weed out comments
1953
1954 or equivalently,
1955
1956     @foo = grep {!/^#/} @bar;    # weed out comments
1957
1958 Note that, because C<$_> is a reference into the list value, it can
1959 be used to modify the elements of the array.  While this is useful and
1960 supported, it can cause bizarre results if the LIST is not a named array.
1961 Similarly, grep returns aliases into the original list, much as a for
1962 loop's index variable aliases the list elements.  That is, modifying an
1963 element of a list returned by grep (for example, in a C<foreach>, C<map>
1964 or another C<grep>) actually modifies the element in the original list.
1965 This is usually something to be avoided when writing clear code.
1966
1967 See also L</map> for a list composed of the results of the BLOCK or EXPR.
1968
1969 =item hex EXPR
1970
1971 =item hex
1972
1973 Interprets EXPR as a hex string and returns the corresponding value.
1974 (To convert strings that might start with either 0, 0x, or 0b, see
1975 L</oct>.)  If EXPR is omitted, uses C<$_>.
1976
1977     print hex '0xAf'; # prints '175'
1978     print hex 'aF';   # same
1979
1980 Hex strings may only represent integers.  Strings that would cause
1981 integer overflow trigger a mandatory error message.
1982
1983 =item import
1984
1985 There is no builtin C<import> function.  It is just an ordinary
1986 method (subroutine) defined (or inherited) by modules that wish to export
1987 names to another module.  The C<use> function calls the C<import> method
1988 for the package used.  See also L</use()>, L<perlmod>, and L<Exporter>.
1989
1990 =item index STR,SUBSTR,POSITION
1991
1992 =item index STR,SUBSTR
1993
1994 The index function searches for one string within another, but without
1995 the wildcard-like behavior of a full regular-expression pattern match.
1996 It returns the position of the first occurrence of SUBSTR in STR at
1997 or after POSITION.  If POSITION is omitted, starts searching from the
1998 beginning of the string.  The return value is based at C<0> (or whatever
1999 you've set the C<$[> variable to--but don't do that).  If the substring
2000 is not found, returns one less than the base, ordinarily C<-1>.
2001
2002 =item int EXPR
2003
2004 =item int
2005
2006 Returns the integer portion of EXPR.  If EXPR is omitted, uses C<$_>.
2007 You should not use this function for rounding: one because it truncates
2008 towards C<0>, and two because machine representations of floating point
2009 numbers can sometimes produce counterintuitive results.  For example,
2010 C<int(-6.725/0.025)> produces -268 rather than the correct -269; that's
2011 because it's really more like -268.99999999999994315658 instead.  Usually,
2012 the C<sprintf>, C<printf>, or the C<POSIX::floor> and C<POSIX::ceil>
2013 functions will serve you better than will int().
2014
2015 =item ioctl FILEHANDLE,FUNCTION,SCALAR
2016
2017 Implements the ioctl(2) function.  You'll probably first have to say
2018
2019     require "ioctl.ph"; # probably in /usr/local/lib/perl/ioctl.ph
2020
2021 to get the correct function definitions.  If F<ioctl.ph> doesn't
2022 exist or doesn't have the correct definitions you'll have to roll your
2023 own, based on your C header files such as F<E<lt>sys/ioctl.hE<gt>>.
2024 (There is a Perl script called B<h2ph> that comes with the Perl kit that
2025 may help you in this, but it's nontrivial.)  SCALAR will be read and/or
2026 written depending on the FUNCTION--a pointer to the string value of SCALAR
2027 will be passed as the third argument of the actual C<ioctl> call.  (If SCALAR
2028 has no string value but does have a numeric value, that value will be
2029 passed rather than a pointer to the string value.  To guarantee this to be
2030 true, add a C<0> to the scalar before using it.)  The C<pack> and C<unpack>
2031 functions may be needed to manipulate the values of structures used by
2032 C<ioctl>.  
2033
2034 The return value of C<ioctl> (and C<fcntl>) is as follows:
2035
2036         if OS returns:          then Perl returns:
2037             -1                    undefined value
2038              0                  string "0 but true"
2039         anything else               that number
2040
2041 Thus Perl returns true on success and false on failure, yet you can
2042 still easily determine the actual value returned by the operating
2043 system:
2044
2045     $retval = ioctl(...) || -1;
2046     printf "System returned %d\n", $retval;
2047
2048 The special string "C<0> but true" is exempt from B<-w> complaints
2049 about improper numeric conversions.
2050
2051 Here's an example of setting a filehandle named C<REMOTE> to be
2052 non-blocking at the system level.  You'll have to negotiate C<$|>
2053 on your own, though.
2054
2055     use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
2056
2057     $flags = fcntl(REMOTE, F_GETFL, 0)
2058                 or die "Can't get flags for the socket: $!\n";
2059
2060     $flags = fcntl(REMOTE, F_SETFL, $flags | O_NONBLOCK)
2061                 or die "Can't set flags for the socket: $!\n";
2062
2063 =item join EXPR,LIST
2064
2065 Joins the separate strings of LIST into a single string with fields
2066 separated by the value of EXPR, and returns that new string.  Example:
2067
2068     $rec = join(':', $login,$passwd,$uid,$gid,$gcos,$home,$shell);
2069
2070 Beware that unlike C<split>, C<join> doesn't take a pattern as its
2071 first argument.  Compare L</split>.
2072
2073 =item keys HASH
2074
2075 Returns a list consisting of all the keys of the named hash.  (In
2076 scalar context, returns the number of keys.)  The keys are returned in
2077 an apparently random order.  The actual random order is subject to
2078 change in future versions of perl, but it is guaranteed to be the same
2079 order as either the C<values> or C<each> function produces (given
2080 that the hash has not been modified).  As a side effect, it resets
2081 HASH's iterator.
2082
2083 Here is yet another way to print your environment:
2084
2085     @keys = keys %ENV;
2086     @values = values %ENV;
2087     while (@keys) { 
2088         print pop(@keys), '=', pop(@values), "\n";
2089     }
2090
2091 or how about sorted by key:
2092
2093     foreach $key (sort(keys %ENV)) {
2094         print $key, '=', $ENV{$key}, "\n";
2095     }
2096
2097 To sort a hash by value, you'll need to use a C<sort> function.
2098 Here's a descending numeric sort of a hash by its values:
2099
2100     foreach $key (sort { $hash{$b} <=> $hash{$a} } keys %hash) {
2101         printf "%4d %s\n", $hash{$key}, $key;
2102     }
2103
2104 As an lvalue C<keys> allows you to increase the number of hash buckets
2105 allocated for the given hash.  This can gain you a measure of efficiency if
2106 you know the hash is going to get big.  (This is similar to pre-extending
2107 an array by assigning a larger number to $#array.)  If you say
2108
2109     keys %hash = 200;
2110
2111 then C<%hash> will have at least 200 buckets allocated for it--256 of them,
2112 in fact, since it rounds up to the next power of two.  These
2113 buckets will be retained even if you do C<%hash = ()>, use C<undef
2114 %hash> if you want to free the storage while C<%hash> is still in scope.
2115 You can't shrink the number of buckets allocated for the hash using
2116 C<keys> in this way (but you needn't worry about doing this by accident,
2117 as trying has no effect).
2118
2119 See also C<each>, C<values> and C<sort>.
2120
2121 =item kill LIST
2122
2123 Sends a signal to a list of processes.  The first element of
2124 the list must be the signal to send.  Returns the number of
2125 processes successfully signaled (which is not necessarily the
2126 same as the number actually killed).
2127
2128     $cnt = kill 1, $child1, $child2;
2129     kill 9, @goners;
2130
2131 Unlike in the shell, in Perl if the I<SIGNAL> is negative, it kills
2132 process groups instead of processes.  (On System V, a negative I<PROCESS>
2133 number will also kill process groups, but that's not portable.)  That
2134 means you usually want to use positive not negative signals.  You may also
2135 use a signal name in quotes.  See L<perlipc/"Signals"> for details.
2136
2137 =item last LABEL
2138
2139 =item last
2140
2141 The C<last> command is like the C<break> statement in C (as used in
2142 loops); it immediately exits the loop in question.  If the LABEL is
2143 omitted, the command refers to the innermost enclosing loop.  The
2144 C<continue> block, if any, is not executed:
2145
2146     LINE: while (<STDIN>) {
2147         last LINE if /^$/;      # exit when done with header
2148         #...
2149     }
2150
2151 C<last> cannot be used to exit a block which returns a value such as
2152 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
2153 a grep() or map() operation.
2154
2155 Note that a block by itself is semantically identical to a loop
2156 that executes once.  Thus C<last> can be used to effect an early
2157 exit out of such a block.
2158
2159 See also L</continue> for an illustration of how C<last>, C<next>, and
2160 C<redo> work.
2161
2162 =item lc EXPR
2163
2164 =item lc
2165
2166 Returns an lowercased version of EXPR.  This is the internal function
2167 implementing the C<\L> escape in double-quoted strings.
2168 Respects current LC_CTYPE locale if C<use locale> in force.  See L<perllocale>
2169 and L<utf8>.
2170
2171 If EXPR is omitted, uses C<$_>.
2172
2173 =item lcfirst EXPR
2174
2175 =item lcfirst
2176
2177 Returns the value of EXPR with the first character lowercased.  This is
2178 the internal function implementing the C<\l> escape in double-quoted strings.
2179 Respects current LC_CTYPE locale if C<use locale> in force.  See L<perllocale>.
2180
2181 If EXPR is omitted, uses C<$_>.
2182
2183 =item length EXPR
2184
2185 =item length
2186
2187 Returns the length in characters of the value of EXPR.  If EXPR is
2188 omitted, returns length of C<$_>.  Note that this cannot be used on 
2189 an entire array or hash to find out how many elements these have.
2190 For that, use C<scalar @array> and C<scalar keys %hash> respectively.
2191
2192 =item link OLDFILE,NEWFILE
2193
2194 Creates a new filename linked to the old filename.  Returns true for
2195 success, false otherwise. 
2196
2197 =item listen SOCKET,QUEUESIZE
2198
2199 Does the same thing that the listen system call does.  Returns true if
2200 it succeeded, false otherwise.  See the example in L<perlipc/"Sockets: Client/Server Communication">.
2201
2202 =item local EXPR
2203
2204 You really probably want to be using C<my> instead, because C<local> isn't
2205 what most people think of as "local".  See L<perlsub/"Private Variables
2206 via my()"> for details.
2207
2208 A local modifies the listed variables to be local to the enclosing
2209 block, file, or eval.  If more than one value is listed, the list must
2210 be placed in parentheses.  See L<perlsub/"Temporary Values via local()">
2211 for details, including issues with tied arrays and hashes.
2212
2213 =item localtime EXPR
2214
2215 Converts a time as returned by the time function to a 9-element list
2216 with the time analyzed for the local time zone.  Typically used as
2217 follows:
2218
2219     #  0    1    2     3     4    5     6     7     8
2220     ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
2221                                                 localtime(time);
2222
2223 All list elements are numeric, and come straight out of a struct tm.
2224 In particular this means that $mon has the range C<0..11> and $wday
2225 has the range C<0..6> with sunday as day C<0>.  Also, $year is the
2226 number of years since 1900, that is, $year is C<123> in year 2023,
2227 and I<not> simply the last two digits of the year.  If you assume it is,
2228 then you create non-Y2K-compliant programs--and you wouldn't want to do
2229 that, would you?
2230
2231 If EXPR is omitted, uses the current time (C<localtime(time)>).
2232
2233 In scalar context, returns the ctime(3) value:
2234
2235     $now_string = localtime;  # e.g., "Thu Oct 13 04:54:34 1994"
2236
2237 This scalar value is B<not> locale dependent, see L<perllocale>, but
2238 instead a Perl builtin.  Also see the C<Time::Local> module
2239 (to convert the second, minutes, hours, ... back to seconds since the
2240 stroke of midnight the 1st of January 1970, the value returned by
2241 time()), and the strftime(3) and mktime(3) function available via the
2242 POSIX module.  To get somewhat similar but locale dependent date
2243 strings, set up your locale environment variables appropriately
2244 (please see L<perllocale>) and try for example:
2245
2246     use POSIX qw(strftime);
2247     $now_string = strftime "%a %b %e %H:%M:%S %Y", localtime;
2248
2249 Note that the C<%a> and C<%b>, the short forms of the day of the week
2250 and the month of the year, may not necessarily be three characters wide.
2251
2252 =item lock
2253
2254     lock I<THING>
2255
2256 This function places an advisory lock on a variable, subroutine,
2257 or referenced object contained in I<THING> until the lock goes out
2258 of scope.  This is a built-in function only if your version of Perl
2259 was built with threading enabled, and if you've said C<use Threads>.
2260 Otherwise a user-defined function by this name will be called.  See
2261 L<Thread>.
2262
2263 =item log EXPR
2264
2265 =item log
2266
2267 Returns the natural logarithm (base I<e>) of EXPR.  If EXPR is omitted,
2268 returns log of C<$_>.  To get the log of another base, use basic algebra:
2269 The base-N log of a number is equal to the natural log of that number
2270 divided by the natural log of N.  For example:
2271
2272     sub log10 {
2273         my $n = shift;
2274         return log($n)/log(10);
2275     } 
2276
2277 See also L</exp> for the inverse operation.
2278
2279 =item lstat FILEHANDLE
2280
2281 =item lstat EXPR
2282
2283 =item lstat
2284
2285 Does the same thing as the C<stat> function (including setting the
2286 special C<_> filehandle) but stats a symbolic link instead of the file
2287 the symbolic link points to.  If symbolic links are unimplemented on
2288 your system, a normal C<stat> is done.
2289
2290 If EXPR is omitted, stats C<$_>.
2291
2292 =item m//
2293
2294 The match operator.  See L<perlop>.
2295
2296 =item map BLOCK LIST
2297
2298 =item map EXPR,LIST
2299
2300 Evaluates the BLOCK or EXPR for each element of LIST (locally setting
2301 C<$_> to each element) and returns the list value composed of the
2302 results of each such evaluation.  In scalar context, returns the
2303 total number of elements so generated.  Evaluates BLOCK or EXPR in
2304 list context, so each element of LIST may produce zero, one, or
2305 more elements in the returned value.
2306
2307     @chars = map(chr, @nums);
2308
2309 translates a list of numbers to the corresponding characters.  And
2310
2311     %hash = map { getkey($_) => $_ } @array;
2312
2313 is just a funny way to write
2314
2315     %hash = ();
2316     foreach $_ (@array) {
2317         $hash{getkey($_)} = $_;
2318     }
2319
2320 Note that, because C<$_> is a reference into the list value, it can
2321 be used to modify the elements of the array.  While this is useful and
2322 supported, it can cause bizarre results if the LIST is not a named array.
2323 Using a regular C<foreach> loop for this purpose would be clearer in
2324 most cases.  See also L</grep> for an array composed of those items of
2325 the original list for which the BLOCK or EXPR evaluates to true.
2326
2327 =item mkdir FILENAME,MASK
2328
2329 Creates the directory specified by FILENAME, with permissions
2330 specified by MASK (as modified by C<umask>).  If it succeeds it
2331 returns true, otherwise it returns false and sets C<$!> (errno).
2332
2333 In general, it is better to create directories with permissive MASK,
2334 and let the user modify that with their C<umask>, than it is to supply
2335 a restrictive MASK and give the user no way to be more permissive.
2336 The exceptions to this rule are when the file or directory should be
2337 kept private (mail files, for instance).  The perlfunc(1) entry on
2338 C<umask> discusses the choice of MASK in more detail.
2339
2340 =item msgctl ID,CMD,ARG
2341
2342 Calls the System V IPC function msgctl(2).  You'll probably have to say
2343
2344     use IPC::SysV;
2345
2346 first to get the correct constant definitions.  If CMD is C<IPC_STAT>,
2347 then ARG must be a variable which will hold the returned C<msqid_ds>
2348 structure.  Returns like C<ioctl>: the undefined value for error, C<"0 but
2349 true"> for zero, or the actual return value otherwise.  See also
2350 C<IPC::SysV> and C<IPC::Semaphore> documentation.
2351
2352 =item msgget KEY,FLAGS
2353
2354 Calls the System V IPC function msgget(2).  Returns the message queue
2355 id, or the undefined value if there is an error.  See also C<IPC::SysV>
2356 and C<IPC::Msg> documentation.
2357
2358 =item msgsnd ID,MSG,FLAGS
2359
2360 Calls the System V IPC function msgsnd to send the message MSG to the
2361 message queue ID.  MSG must begin with the long integer message type,
2362 which may be created with C<pack("l", $type)>.  Returns true if
2363 successful, or false if there is an error.  See also C<IPC::SysV>
2364 and C<IPC::SysV::Msg> documentation.
2365
2366 =item msgrcv ID,VAR,SIZE,TYPE,FLAGS
2367
2368 Calls the System V IPC function msgrcv to receive a message from
2369 message queue ID into variable VAR with a maximum message size of
2370 SIZE.  Note that if a message is received, the message type will be
2371 the first thing in VAR, and the maximum length of VAR is SIZE plus the
2372 size of the message type.  Returns true if successful, or false if
2373 there is an error.  See also C<IPC::SysV> and C<IPC::SysV::Msg> documentation.
2374
2375 =item my EXPR
2376
2377 =item my EXPR : ATTRIBUTES
2378
2379 A C<my> declares the listed variables to be local (lexically) to the
2380 enclosing block, file, or C<eval>.  If
2381 more than one value is listed, the list must be placed in parentheses.  See
2382 L<perlsub/"Private Variables via my()"> for details.
2383
2384 =item next LABEL
2385
2386 =item next
2387
2388 The C<next> command is like the C<continue> statement in C; it starts
2389 the next iteration of the loop:
2390
2391     LINE: while (<STDIN>) {
2392         next LINE if /^#/;      # discard comments
2393         #...
2394     }
2395
2396 Note that if there were a C<continue> block on the above, it would get
2397 executed even on discarded lines.  If the LABEL is omitted, the command
2398 refers to the innermost enclosing loop.
2399
2400 C<next> cannot be used to exit a block which returns a value such as
2401 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
2402 a grep() or map() operation.
2403
2404 Note that a block by itself is semantically identical to a loop
2405 that executes once.  Thus C<next> will exit such a block early.
2406
2407 See also L</continue> for an illustration of how C<last>, C<next>, and
2408 C<redo> work.
2409
2410 =item no Module LIST
2411
2412 See the L</use> function, which C<no> is the opposite of.
2413
2414 =item oct EXPR
2415
2416 =item oct
2417
2418 Interprets EXPR as an octal string and returns the corresponding
2419 value.  (If EXPR happens to start off with C<0x>, interprets it as a
2420 hex string.  If EXPR starts off with C<0b>, it is interpreted as a
2421 binary string.)  The following will handle decimal, binary, octal, and
2422 hex in the standard Perl or C notation:
2423
2424     $val = oct($val) if $val =~ /^0/;
2425
2426 If EXPR is omitted, uses C<$_>.   To go the other way (produce a number
2427 in octal), use sprintf() or printf():
2428
2429     $perms = (stat("filename"))[2] & 07777;
2430     $oct_perms = sprintf "%lo", $perms;
2431
2432 The oct() function is commonly used when a string such as C<644> needs
2433 to be converted into a file mode, for example. (Although perl will
2434 automatically convert strings into numbers as needed, this automatic
2435 conversion assumes base 10.)
2436
2437 =item open FILEHANDLE,MODE,EXPR
2438
2439 =item open FILEHANDLE,EXPR
2440
2441 =item open FILEHANDLE
2442
2443 Opens the file whose filename is given by EXPR, and associates it with
2444 FILEHANDLE.  If FILEHANDLE is an expression, its value is used as the
2445 name of the real filehandle wanted.  If EXPR is omitted, the scalar
2446 variable of the same name as the FILEHANDLE contains the filename.
2447 (Note that lexical variables--those declared with C<my>--will not work
2448 for this purpose; so if you're using C<my>, specify EXPR in your call
2449 to open.)  See L<perlopentut> for a kinder, gentler explanation of opening
2450 files.
2451
2452 If MODE is C<'E<lt>'> or nothing, the file is opened for input.
2453 If MODE is C<'E<gt>'>, the file is truncated and opened for
2454 output, being created if necessary.  If MODE is C<'E<gt>E<gt>'>,
2455 the file is opened for appending, again being created if necessary. 
2456 You can put a C<'+'> in front of the C<'E<gt>'> or C<'E<lt>'> to indicate that
2457 you want both read and write access to the file; thus C<'+E<lt>'> is almost
2458 always preferred for read/write updates--the C<'+E<gt>'> mode would clobber the
2459 file first.  You can't usually use either read-write mode for updating
2460 textfiles, since they have variable length records.  See the B<-i>
2461 switch in L<perlrun> for a better approach.  The file is created with
2462 permissions of C<0666> modified by the process' C<umask> value.
2463
2464 These various prefixes correspond to the fopen(3) modes of C<'r'>, C<'r+'>, C<'w'>,
2465 C<'w+'>, C<'a'>, and C<'a+'>.
2466
2467 In the 2-arguments (and 1-argument) form of the call the mode and
2468 filename should be concatenated (in this order), possibly separated by
2469 spaces.  It is possible to omit the mode if the mode is C<'E<lt>'>.
2470
2471 If the filename begins with C<'|'>, the filename is interpreted as a
2472 command to which output is to be piped, and if the filename ends with a
2473 C<'|'>, the filename is interpreted as a command which pipes output to
2474 us.  See L<perlipc/"Using open() for IPC">
2475 for more examples of this.  (You are not allowed to C<open> to a command
2476 that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>,
2477 and L<perlipc/"Bidirectional Communication"> for alternatives.)
2478
2479 If MODE is C<'|-'>, the filename is interpreted as a
2480 command to which output is to be piped, and if MODE is
2481 C<'-|'>, the filename is interpreted as a command which pipes output to
2482 us.  In the 2-arguments (and 1-argument) form one should replace dash
2483 (C<'-'>) with the command.  See L<perlipc/"Using open() for IPC">
2484 for more examples of this.  (You are not allowed to C<open> to a command
2485 that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>,
2486 and L<perlipc/"Bidirectional Communication"> for alternatives.)
2487
2488 In the 2-arguments (and 1-argument) form opening C<'-'> opens STDIN
2489 and opening C<'E<gt>-'> opens STDOUT.  
2490
2491 Open returns
2492 nonzero upon success, the undefined value otherwise.  If the C<open>
2493 involved a pipe, the return value happens to be the pid of the
2494 subprocess.
2495
2496 If you're unfortunate enough to be running Perl on a system that
2497 distinguishes between text files and binary files (modern operating
2498 systems don't care), then you should check out L</binmode> for tips for
2499 dealing with this.  The key distinction between systems that need C<binmode>
2500 and those that don't is their text file formats.  Systems like Unix, MacOS, and
2501 Plan9, which delimit lines with a single character, and which encode that
2502 character in C as C<"\n">, do not need C<binmode>.  The rest need it.
2503
2504 When opening a file, it's usually a bad idea to continue normal execution
2505 if the request failed, so C<open> is frequently used in connection with
2506 C<die>.  Even if C<die> won't do what you want (say, in a CGI script,
2507 where you want to make a nicely formatted error message (but there are
2508 modules that can help with that problem)) you should always check
2509 the return value from opening a file.  The infrequent exception is when
2510 working with an unopened filehandle is actually what you want to do.
2511
2512 Examples:
2513
2514     $ARTICLE = 100;
2515     open ARTICLE or die "Can't find article $ARTICLE: $!\n";
2516     while (<ARTICLE>) {...
2517
2518     open(LOG, '>>/usr/spool/news/twitlog');     # (log is reserved)
2519     # if the open fails, output is discarded
2520
2521     open(DBASE, '+<', 'dbase.mine')             # open for update
2522         or die "Can't open 'dbase.mine' for update: $!";
2523
2524     open(DBASE, '+<dbase.mine')                 # ditto
2525         or die "Can't open 'dbase.mine' for update: $!";
2526
2527     open(ARTICLE, '-|', "caesar <$article")     # decrypt article
2528         or die "Can't start caesar: $!";
2529
2530     open(ARTICLE, "caesar <$article |")         # ditto
2531         or die "Can't start caesar: $!";
2532
2533     open(EXTRACT, "|sort >/tmp/Tmp$$")          # $$ is our process id
2534         or die "Can't start sort: $!";
2535
2536     # process argument list of files along with any includes
2537
2538     foreach $file (@ARGV) {
2539         process($file, 'fh00');
2540     }
2541
2542     sub process {
2543         my($filename, $input) = @_;
2544         $input++;               # this is a string increment
2545         unless (open($input, $filename)) {
2546             print STDERR "Can't open $filename: $!\n";
2547             return;
2548         }
2549
2550         local $_;
2551         while (<$input>) {              # note use of indirection
2552             if (/^#include "(.*)"/) {
2553                 process($1, $input);
2554                 next;
2555             }
2556             #...                # whatever
2557         }
2558     }
2559
2560 You may also, in the Bourne shell tradition, specify an EXPR beginning
2561 with C<'E<gt>&'>, in which case the rest of the string is interpreted as the
2562 name of a filehandle (or file descriptor, if numeric) to be
2563 duped and opened.  You may use C<&> after C<E<gt>>, C<E<gt>E<gt>>,
2564 C<E<lt>>, C<+E<gt>>, C<+E<gt>E<gt>>, and C<+E<lt>>.  The
2565 mode you specify should match the mode of the original filehandle.
2566 (Duping a filehandle does not take into account any existing contents of
2567 stdio buffers.)  Duping file handles is not yet supported for 3-argument
2568 open().
2569
2570 Here is a script that saves, redirects, and restores STDOUT and
2571 STDERR:
2572
2573     #!/usr/bin/perl
2574     open(OLDOUT, ">&STDOUT");
2575     open(OLDERR, ">&STDERR");
2576
2577     open(STDOUT, '>', "foo.out") || die "Can't redirect stdout";
2578     open(STDERR, ">&STDOUT")     || die "Can't dup stdout";
2579
2580     select(STDERR); $| = 1;     # make unbuffered
2581     select(STDOUT); $| = 1;     # make unbuffered
2582
2583     print STDOUT "stdout 1\n";  # this works for
2584     print STDERR "stderr 1\n";  # subprocesses too
2585
2586     close(STDOUT);
2587     close(STDERR);
2588
2589     open(STDOUT, ">&OLDOUT");
2590     open(STDERR, ">&OLDERR");
2591
2592     print STDOUT "stdout 2\n";
2593     print STDERR "stderr 2\n";
2594
2595 If you specify C<'E<lt>&=N'>, where C<N> is a number, then Perl will do an
2596 equivalent of C's C<fdopen> of that file descriptor; this is more
2597 parsimonious of file descriptors.  For example:
2598
2599     open(FILEHANDLE, "<&=$fd")
2600
2601 If you open a pipe on the command C<'-'>, i.e., either C<'|-'> or C<'-|'>
2602 with 2-arguments (or 1-argument) form of open(), then
2603 there is an implicit fork done, and the return value of open is the pid
2604 of the child within the parent process, and C<0> within the child
2605 process.  (Use C<defined($pid)> to determine whether the open was successful.)
2606 The filehandle behaves normally for the parent, but i/o to that
2607 filehandle is piped from/to the STDOUT/STDIN of the child process.
2608 In the child process the filehandle isn't opened--i/o happens from/to
2609 the new STDOUT or STDIN.  Typically this is used like the normal
2610 piped open when you want to exercise more control over just how the
2611 pipe command gets executed, such as when you are running setuid, and
2612 don't want to have to scan shell commands for metacharacters.
2613 The following triples are more or less equivalent:
2614
2615     open(FOO, "|tr '[a-z]' '[A-Z]'");
2616     open(FOO, '|-', "tr '[a-z]' '[A-Z]'");
2617     open(FOO, '|-') || exec 'tr', '[a-z]', '[A-Z]';
2618
2619     open(FOO, "cat -n '$file'|");
2620     open(FOO, '-|', "cat -n '$file'");
2621     open(FOO, '-|') || exec 'cat', '-n', $file;
2622
2623 See L<perlipc/"Safe Pipe Opens"> for more examples of this.
2624
2625 NOTE: On any operation that may do a fork, all files opened for output
2626 are flushed before the fork is attempted.  On systems that support a
2627 close-on-exec flag on files, the flag will be set for the newly opened
2628 file descriptor as determined by the value of $^F.  See L<perlvar/$^F>.
2629
2630 Closing any piped filehandle causes the parent process to wait for the
2631 child to finish, and returns the status value in C<$?>.
2632
2633 The filename passed to 2-argument (or 1-argument) form of open()
2634 will have leading and trailing
2635 whitespace deleted, and the normal redirection characters
2636 honored.  This property, known as "magic open", 
2637 can often be used to good effect.  A user could specify a filename of
2638 F<"rsh cat file |">, or you could change certain filenames as needed:
2639
2640     $filename =~ s/(.*\.gz)\s*$/gzip -dc < $1|/;
2641     open(FH, $filename) or die "Can't open $filename: $!";
2642
2643 Use 3-argument form to open a file with arbitrary weird characters in it,
2644
2645     open(FOO, '<', $file);
2646
2647 otherwise it's necessary to protect any leading and trailing whitespace:
2648
2649     $file =~ s#^(\s)#./$1#;
2650     open(FOO, "< $file\0");
2651
2652 (this may not work on some bizzare filesystems).  One should
2653 conscientiously choose between the the I<magic> and 3-arguments form
2654 of open():
2655
2656     open IN, $ARGV[0];
2657
2658 will allow the user to specify an argument of the form C<"rsh cat file |">,
2659 but will not work on a filename which happens to have a trailing space, while
2660
2661     open IN, '<', $ARGV[0];
2662
2663 will have exactly the opposite restrictions.
2664
2665 If you want a "real" C C<open> (see L<open(2)> on your system), then you
2666 should use the C<sysopen> function, which involves no such magic (but
2667 may use subtly different filemodes than Perl open(), which is mapped
2668 to C fopen()).  This is
2669 another way to protect your filenames from interpretation.  For example:
2670
2671     use IO::Handle;
2672     sysopen(HANDLE, $path, O_RDWR|O_CREAT|O_EXCL)
2673         or die "sysopen $path: $!";
2674     $oldfh = select(HANDLE); $| = 1; select($oldfh);
2675     print HANDLE "stuff $$\n");
2676     seek(HANDLE, 0, 0);
2677     print "File contains: ", <HANDLE>;
2678
2679 Using the constructor from the C<IO::Handle> package (or one of its
2680 subclasses, such as C<IO::File> or C<IO::Socket>), you can generate anonymous
2681 filehandles that have the scope of whatever variables hold references to
2682 them, and automatically close whenever and however you leave that scope:
2683
2684     use IO::File;
2685     #...
2686     sub read_myfile_munged {
2687         my $ALL = shift;
2688         my $handle = new IO::File;
2689         open($handle, "myfile") or die "myfile: $!";
2690         $first = <$handle>
2691             or return ();     # Automatically closed here.
2692         mung $first or die "mung failed";       # Or here.
2693         return $first, <$handle> if $ALL;       # Or here.
2694         $first;                                 # Or here.
2695     }
2696
2697 See L</seek> for some details about mixing reading and writing.
2698
2699 =item opendir DIRHANDLE,EXPR
2700
2701 Opens a directory named EXPR for processing by C<readdir>, C<telldir>,
2702 C<seekdir>, C<rewinddir>, and C<closedir>.  Returns true if successful.
2703 DIRHANDLEs have their own namespace separate from FILEHANDLEs.
2704
2705 =item ord EXPR
2706
2707 =item ord
2708
2709 Returns the numeric (ASCII or Unicode) value of the first character of EXPR.  If
2710 EXPR is omitted, uses C<$_>.  For the reverse, see L</chr>.
2711 See L<utf8> for more about Unicode.
2712
2713 =item our EXPR
2714
2715 An C<our> declares the listed variables to be valid globals within
2716 the enclosing block, file, or C<eval>.  That is, it has the same
2717 scoping rules as a "my" declaration, but does not create a local
2718 variable.  If more than one value is listed, the list must be placed
2719 in parentheses.  The C<our> declaration has no semantic effect unless
2720 "use strict vars" is in effect, in which case it lets you use the
2721 declared global variable without qualifying it with a package name.
2722 (But only within the lexical scope of the C<our> declaration.  In this
2723 it differs from "use vars", which is package scoped.)
2724
2725 =item pack TEMPLATE,LIST
2726
2727 Takes a LIST of values and converts it into a string using the rules
2728 given by the TEMPLATE.  The resulting string is the concatenation of
2729 the converted values.  Typically, each converted value looks
2730 like its machine-level representation.  For example, on 32-bit machines
2731 a converted integer may be represented by a sequence of 4 bytes.
2732
2733 The TEMPLATE is a
2734 sequence of characters that give the order and type of values, as
2735 follows:
2736
2737     a   A string with arbitrary binary data, will be null padded.
2738     A   An ascii string, will be space padded.
2739     Z   A null terminated (asciz) string, will be null padded.
2740
2741     b   A bit string (ascending bit order inside each byte, like vec()).
2742     B   A bit string (descending bit order inside each byte).
2743     h   A hex string (low nybble first).
2744     H   A hex string (high nybble first).
2745
2746     c   A signed char value.
2747     C   An unsigned char value.  Only does bytes.  See U for Unicode.
2748
2749     s   A signed short value.
2750     S   An unsigned short value.
2751           (This 'short' is _exactly_ 16 bits, which may differ from
2752            what a local C compiler calls 'short'.  If you want
2753            native-length shorts, use the '!' suffix.)
2754
2755     i   A signed integer value.
2756     I   An unsigned integer value.
2757           (This 'integer' is _at_least_ 32 bits wide.  Its exact
2758            size depends on what a local C compiler calls 'int',
2759            and may even be larger than the 'long' described in
2760            the next item.)
2761
2762     l   A signed long value.
2763     L   An unsigned long value.
2764           (This 'long' is _exactly_ 32 bits, which may differ from
2765            what a local C compiler calls 'long'.  If you want
2766            native-length longs, use the '!' suffix.)
2767
2768     n   A short in "network" (big-endian) order.
2769     N   A long in "network" (big-endian) order.
2770     v   A short in "VAX" (little-endian) order.
2771     V   A long in "VAX" (little-endian) order.
2772           (These 'shorts' and 'longs' are _exactly_ 16 bits and
2773            _exactly_ 32 bits, respectively.)
2774
2775     q   A signed quad (64-bit) value.
2776     Q   An unsigned quad value.
2777           (Quads are available only if your system supports 64-bit
2778            integer values _and_ if Perl has been compiled to support those.
2779            Causes a fatal error otherwise.)
2780
2781     f   A single-precision float in the native format.
2782     d   A double-precision float in the native format.
2783
2784     p   A pointer to a null-terminated string.
2785     P   A pointer to a structure (fixed-length string).
2786
2787     u   A uuencoded string.
2788     U   A Unicode character number.  Encodes to UTF-8 internally.
2789         Works even if C<use utf8> is not in effect.
2790
2791     w   A BER compressed integer.  Its bytes represent an unsigned
2792         integer in base 128, most significant digit first, with as
2793         few digits as possible.  Bit eight (the high bit) is set
2794         on each byte except the last.
2795
2796     x   A null byte.
2797     X   Back up a byte.
2798     @   Null fill to absolute position.
2799
2800 The following rules apply:
2801
2802 =over 8
2803
2804 =item *
2805
2806 Each letter may optionally be followed by a number giving a repeat
2807 count.  With all types except C<"a">, C<"A">, C<"Z">, C<"b">, C<"B">, C<"h">,
2808 C<"H">, and C<"P"> the pack function will gobble up that many values from
2809 the LIST.  A C<*> for the repeat count means to use however many items are
2810 left, except for C<"@">, C<"x">, C<"X">, where it is equivalent
2811 to C<"0">, and C<"u">, where it is equivalent to 1 (or 45, what is the
2812 same).
2813
2814 When used with C<"Z">, C<*> results in the addition of a trailing null
2815 byte (so the packed result will be one longer than the byte C<length>
2816 of the item).
2817
2818 The repeat count for C<"u"> is interpreted as the maximal number of bytes
2819 to encode per line of output, with 0 and 1 replaced by 45.
2820
2821 =item *
2822
2823 The C<"a">, C<"A">, and C<"Z"> types gobble just one value, but pack it as a
2824 string of length count, padding with nulls or spaces as necessary.  When
2825 unpacking, C<"A"> strips trailing spaces and nulls, C<"Z"> strips everything
2826 after the first null, and C<"a"> returns data verbatim.  When packing,
2827 C<"a">, and C<"Z"> are equivalent.
2828
2829 If the value-to-pack is too long, it is truncated.  If too long and an
2830 explicit count is provided, C<"Z"> packs only C<$count-1> bytes, followed
2831 by a null byte.  Thus C<"Z"> always packs a trailing null byte under
2832 all circumstances.
2833
2834 =item *
2835
2836 Likewise, the C<"b"> and C<"B"> fields pack a string that many bits long.
2837 Each byte of the input field generates 1 bit of the result basing on
2838 the least-signifant bit of each input byte, i.e., on C<ord($byte)%2>.
2839 In particular, bytes C<"0"> and C<"1"> generate bits 0 and 1.
2840
2841 Starting from the beginning of the input string, each 8-tuple of bytes
2842 is converted to 1 byte of output.  If the length of the input string
2843 is not divisible by 8, the remainder is packed as if padded by 0s.
2844 Similarly, during unpack()ing the "extra" bits are ignored.
2845
2846 If the input string is longer than needed, extra bytes are ignored.
2847 A C<*> for the repeat count of pack() means to use all the bytes of
2848 the input field.  On unpack()ing the bits are converted to a string
2849 of C<"0">s and C<"1">s.
2850
2851 =item *
2852
2853 The C<"h"> and C<"H"> fields pack a string that many nybbles (4-bit groups,
2854 representable as hexadecimal digits, 0-9a-f) long.
2855
2856 =item *
2857
2858 The C<"p"> type packs a pointer to a null-terminated string.  You are
2859 responsible for ensuring the string is not a temporary value (which can
2860 potentially get deallocated before you get around to using the packed result).
2861 The C<"P"> type packs a pointer to a structure of the size indicated by the
2862 length.  A NULL pointer is created if the corresponding value for C<"p"> or
2863 C<"P"> is C<undef>, similarly for unpack().
2864
2865 =item *
2866
2867 The C<"/"> character allows packing and unpacking of strings where the
2868 packed structure contains a byte count followed by the string itself.
2869 You write I<length-item>C</>I<string-item>.
2870
2871 The I<length-item> can be any C<pack> template letter,
2872 and describes how the length value is packed.
2873 The ones likely to be of most use are integer-packing ones like
2874 C<"n"> (for Java strings), C<"w"> (for ASN.1 or SNMP)
2875 and C<"N"> (for Sun XDR).
2876
2877 The I<string-item> must, at present, be C<"A*">, C<"a*"> or C<"Z*">.
2878 For C<unpack> the length of the string is obtained from the I<length-item>,
2879 but if you put in the '*' it will be ignored.
2880
2881     unpack 'C/a', "\04Gurusamy";        gives 'Guru'
2882     unpack 'a3/A* A*', '007 Bond  J ';  gives (' Bond','J')
2883     pack 'n/a* w/a*','hello,','world';  gives "\000\006hello,\005world"
2884
2885 The I<length-item> is not returned explicitly from C<unpack>.
2886
2887 Adding a count to the I<length-item> letter
2888 is unlikely to do anything useful,
2889 unless that letter is C<"A">, C<"a"> or C<"Z">.
2890 Packing with a I<length-item> of C<"a"> or C<"Z">
2891 may introduce C<"\000"> characters,
2892 which Perl does not regard as legal in numeric strings.
2893
2894 =item *
2895
2896 The integer types C<"s">, C<"S">, C<"l">, and C<"L"> may be
2897 immediately followed by a C<"!"> suffix to signify native shorts or
2898 longs--as you can see from above for example a bare C<"l"> does mean
2899 exactly 32 bits, the native C<long> (as seen by the local C compiler)
2900 may be larger.  This is an issue mainly in 64-bit platforms.  You can
2901 see whether using C<"!"> makes any difference by
2902
2903         print length(pack("s")), " ", length(pack("s!")), "\n";
2904         print length(pack("l")), " ", length(pack("l!")), "\n";
2905
2906 C<"i!"> and C<"I!"> also work but only because of completeness;
2907 they are identical to C<"i"> and C<"I">.
2908
2909 The actual sizes (in bytes) of native shorts, ints, longs, and long
2910 longs on the platform where Perl was built are also available via
2911 L<Config>:
2912
2913        use Config;
2914        print $Config{shortsize},    "\n";
2915        print $Config{intsize},      "\n";
2916        print $Config{longsize},     "\n";
2917        print $Config{longlongsize}, "\n";
2918
2919 (The C<$Config{longlongsize}> will be undefine if your system does
2920 not support long longs.) 
2921
2922 =item *
2923
2924 The integer formats C<"s">, C<"S">, C<"i">, C<"I">, C<"l">, and C<"L">
2925 are inherently non-portable between processors and operating systems
2926 because they obey the native byteorder and endianness.  For example a
2927 4-byte integer 0x12345678 (305419896 decimal) be ordered natively
2928 (arranged in and handled by the CPU registers) into bytes as
2929  
2930         0x12 0x34 0x56 0x78     # little-endian
2931         0x78 0x56 0x34 0x12     # big-endian
2932  
2933 Basically, the Intel, Alpha, and VAX CPUs and little-endian, while
2934 everybody else, for example Motorola m68k/88k, PPC, Sparc, HP PA,
2935 Power, and Cray are big-endian.  MIPS can be either: Digital used it
2936 in little-endian mode; SGI uses it in big-endian mode.
2937
2938 The names `big-endian' and `little-endian' are comic references to
2939 the classic "Gulliver's Travels" (via the paper "On Holy Wars and a
2940 Plea for Peace" by Danny Cohen, USC/ISI IEN 137, April 1, 1980) and
2941 the egg-eating habits of the Lilliputians.
2942  
2943 Some systems may have even weirder byte orders such as
2944  
2945         0x56 0x78 0x12 0x34
2946         0x34 0x12 0x78 0x56
2947  
2948 You can see your system's preference with
2949
2950         print join(" ", map { sprintf "%#02x", $_ }
2951                             unpack("C*",pack("L",0x12345678))), "\n";
2952
2953 The byteorder on the platform where Perl was built is also available
2954 via L<Config>:
2955
2956         use Config;
2957         print $Config{byteorder}, "\n";
2958
2959 Byteorders C<'1234'> and C<'12345678'> are little-endian, C<'4321'>
2960 and C<'87654321'> are big-endian.
2961
2962 If you want portable packed integers use the formats C<"n">, C<"N">,
2963 C<"v">, and C<"V">, their byte endianness and size is known.
2964 See also L<perlport>.
2965
2966 =item *
2967
2968 Real numbers (floats and doubles) are in the native machine format only;
2969 due to the multiplicity of floating formats around, and the lack of a
2970 standard "network" representation, no facility for interchange has been
2971 made.  This means that packed floating point data written on one machine
2972 may not be readable on another - even if both use IEEE floating point
2973 arithmetic (as the endian-ness of the memory representation is not part
2974 of the IEEE spec).  See also L<perlport>.
2975
2976 Note that Perl uses doubles internally for all numeric calculation, and
2977 converting from double into float and thence back to double again will
2978 lose precision (i.e., C<unpack("f", pack("f", $foo)>) will not in general
2979 equal $foo).
2980
2981 =item *
2982
2983 You must yourself do any alignment or padding by inserting for example
2984 enough C<'x'>es while packing.  There is no way to pack() and unpack()
2985 could know where the bytes are going to or coming from.  Therefore
2986 C<pack> (and C<unpack>) handle their output and input as flat
2987 sequences of bytes.
2988
2989 =item *
2990
2991 A comment in a TEMPLATE starts with C<#> and goes to the end of line.
2992
2993 =item *
2994
2995 If TEMPLATE requires more arguments to pack() than actually given, pack()
2996 assumes additional C<""> arguments.  If TEMPLATE requires less arguments
2997 to pack() than actually given, extra arguments are ignored.
2998
2999 =back
3000
3001 Examples:
3002
3003     $foo = pack("CCCC",65,66,67,68);
3004     # foo eq "ABCD"
3005     $foo = pack("C4",65,66,67,68);
3006     # same thing
3007     $foo = pack("U4",0x24b6,0x24b7,0x24b8,0x24b9);
3008     # same thing with Unicode circled letters
3009
3010     $foo = pack("ccxxcc",65,66,67,68);
3011     # foo eq "AB\0\0CD"
3012
3013     # note: the above examples featuring "C" and "c" are true
3014     # only on ASCII and ASCII-derived systems such as ISO Latin 1
3015     # and UTF-8.  In EBCDIC the first example would be
3016     # $foo = pack("CCCC",193,194,195,196);
3017
3018     $foo = pack("s2",1,2);
3019     # "\1\0\2\0" on little-endian
3020     # "\0\1\0\2" on big-endian
3021
3022     $foo = pack("a4","abcd","x","y","z");
3023     # "abcd"
3024
3025     $foo = pack("aaaa","abcd","x","y","z");
3026     # "axyz"
3027
3028     $foo = pack("a14","abcdefg");
3029     # "abcdefg\0\0\0\0\0\0\0"
3030
3031     $foo = pack("i9pl", gmtime);
3032     # a real struct tm (on my system anyway)
3033
3034     $utmp_template = "Z8 Z8 Z16 L";
3035     $utmp = pack($utmp_template, @utmp1);
3036     # a struct utmp (BSDish)
3037
3038     @utmp2 = unpack($utmp_template, $utmp);
3039     # "@utmp1" eq "@utmp2"
3040
3041     sub bintodec {
3042         unpack("N", pack("B32", substr("0" x 32 . shift, -32)));
3043     }
3044
3045     $foo = pack('sx2l', 12, 34);
3046     # short 12, two zero bytes padding, long 34
3047     $bar = pack('s@4l', 12, 34);
3048     # short 12, zero fill to position 4, long 34
3049     # $foo eq $bar
3050
3051 The same template may generally also be used in unpack().
3052
3053 =item package 
3054
3055 =item package NAMESPACE
3056
3057 Declares the compilation unit as being in the given namespace.  The scope
3058 of the package declaration is from the declaration itself through the end
3059 of the enclosing block, file, or eval (the same as the C<my> operator).
3060 All further unqualified dynamic identifiers will be in this namespace.
3061 A package statement affects only dynamic variables--including those
3062 you've used C<local> on--but I<not> lexical variables, which are created
3063 with C<my>.  Typically it would be the first declaration in a file to
3064 be included by the C<require> or C<use> operator.  You can switch into a
3065 package in more than one place; it merely influences which symbol table
3066 is used by the compiler for the rest of that block.  You can refer to
3067 variables and filehandles in other packages by prefixing the identifier
3068 with the package name and a double colon:  C<$Package::Variable>.
3069 If the package name is null, the C<main> package as assumed.  That is,
3070 C<$::sail> is equivalent to C<$main::sail> (as well as to C<$main'sail>,
3071 still seen in older code).
3072
3073 If NAMESPACE is omitted, then there is no current package, and all
3074 identifiers must be fully qualified or lexicals.  This is stricter
3075 than C<use strict>, since it also extends to function names.
3076
3077 See L<perlmod/"Packages"> for more information about packages, modules,
3078 and classes.  See L<perlsub> for other scoping issues.
3079
3080 =item pipe READHANDLE,WRITEHANDLE
3081
3082 Opens a pair of connected pipes like the corresponding system call.
3083 Note that if you set up a loop of piped processes, deadlock can occur
3084 unless you are very careful.  In addition, note that Perl's pipes use
3085 stdio buffering, so you may need to set C<$|> to flush your WRITEHANDLE
3086 after each command, depending on the application.
3087
3088 See L<IPC::Open2>, L<IPC::Open3>, and L<perlipc/"Bidirectional Communication">
3089 for examples of such things.
3090
3091 On systems that support a close-on-exec flag on files, the flag will be set
3092 for the newly opened file descriptors as determined by the value of $^F.
3093 See L<perlvar/$^F>.
3094
3095 =item pop ARRAY
3096
3097 =item pop
3098
3099 Pops and returns the last value of the array, shortening the array by
3100 one element.  Has an effect similar to
3101
3102     $ARRAY[$#ARRAY--]
3103
3104 If there are no elements in the array, returns the undefined value
3105 (although this may happen at other times as well).  If ARRAY is
3106 omitted, pops the C<@ARGV> array in the main program, and the C<@_>
3107 array in subroutines, just like C<shift>.
3108
3109 =item pos SCALAR
3110
3111 =item pos
3112
3113 Returns the offset of where the last C<m//g> search left off for the variable
3114 is in question (C<$_> is used when the variable is not specified).  May be
3115 modified to change that offset.  Such modification will also influence
3116 the C<\G> zero-width assertion in regular expressions.  See L<perlre> and
3117 L<perlop>.
3118
3119 =item print FILEHANDLE LIST
3120
3121 =item print LIST
3122
3123 =item print
3124
3125 Prints a string or a list of strings.  Returns true if successful.
3126 FILEHANDLE may be a scalar variable name, in which case the variable
3127 contains the name of or a reference to the filehandle, thus introducing
3128 one level of indirection.  (NOTE: If FILEHANDLE is a variable and
3129 the next token is a term, it may be misinterpreted as an operator
3130 unless you interpose a C<+> or put parentheses around the arguments.)
3131 If FILEHANDLE is omitted, prints by default to standard output (or
3132 to the last selected output channel--see L</select>).  If LIST is
3133 also omitted, prints C<$_> to the currently selected output channel.
3134 To set the default output channel to something other than STDOUT
3135 use the select operation.  The current value of C<$,> (if any) is
3136 printed between each LIST item.  The current value of C<$\> (if
3137 any) is printed after the entire LIST has been printed.  Because
3138 print takes a LIST, anything in the LIST is evaluated in list
3139 context, and any subroutine that you call will have one or more of
3140 its expressions evaluated in list context.  Also be careful not to
3141 follow the print keyword with a left parenthesis unless you want
3142 the corresponding right parenthesis to terminate the arguments to
3143 the print--interpose a C<+> or put parentheses around all the
3144 arguments.
3145
3146 Note that if you're storing FILEHANDLES in an array or other expression,
3147 you will have to use a block returning its value instead:
3148
3149     print { $files[$i] } "stuff\n";
3150     print { $OK ? STDOUT : STDERR } "stuff\n";
3151
3152 =item printf FILEHANDLE FORMAT, LIST
3153
3154 =item printf FORMAT, LIST
3155
3156 Equivalent to C<print FILEHANDLE sprintf(FORMAT, LIST)>, except that C<$\>
3157 (the output record separator) is not appended.  The first argument
3158 of the list will be interpreted as the C<printf> format.  If C<use locale> is
3159 in effect, the character used for the decimal point in formatted real numbers
3160 is affected by the LC_NUMERIC locale.  See L<perllocale>.
3161
3162 Don't fall into the trap of using a C<printf> when a simple
3163 C<print> would do.  The C<print> is more efficient and less
3164 error prone.
3165
3166 =item prototype FUNCTION
3167
3168 Returns the prototype of a function as a string (or C<undef> if the
3169 function has no prototype).  FUNCTION is a reference to, or the name of,
3170 the function whose prototype you want to retrieve.
3171
3172 If FUNCTION is a string starting with C<CORE::>, the rest is taken as a
3173 name for Perl builtin.  If the builtin is not I<overridable> (such as
3174 C<qw//>) or its arguments cannot be expressed by a prototype (such as
3175 C<system>) returns C<undef> because the builtin does not really behave
3176 like a Perl function.  Otherwise, the string describing the equivalent
3177 prototype is returned.
3178
3179 =item push ARRAY,LIST
3180
3181 Treats ARRAY as a stack, and pushes the values of LIST
3182 onto the end of ARRAY.  The length of ARRAY increases by the length of
3183 LIST.  Has the same effect as
3184
3185     for $value (LIST) {
3186         $ARRAY[++$#ARRAY] = $value;
3187     }
3188
3189 but is more efficient.  Returns the new number of elements in the array.
3190
3191 =item q/STRING/
3192
3193 =item qq/STRING/
3194
3195 =item qr/STRING/
3196
3197 =item qx/STRING/
3198
3199 =item qw/STRING/
3200
3201 Generalized quotes.  See L<perlop/"Regexp Quote-Like Operators">.
3202
3203 =item quotemeta EXPR
3204
3205 =item quotemeta
3206
3207 Returns the value of EXPR with all non-alphanumeric
3208 characters backslashed.  (That is, all characters not matching
3209 C</[A-Za-z_0-9]/> will be preceded by a backslash in the
3210 returned string, regardless of any locale settings.)
3211 This is the internal function implementing
3212 the C<\Q> escape in double-quoted strings.
3213
3214 If EXPR is omitted, uses C<$_>.
3215
3216 =item rand EXPR
3217
3218 =item rand
3219
3220 Returns a random fractional number greater than or equal to C<0> and less
3221 than the value of EXPR.  (EXPR should be positive.)  If EXPR is
3222 omitted, the value C<1> is used.  Automatically calls C<srand> unless
3223 C<srand> has already been called.  See also C<srand>.
3224
3225 (Note: If your rand function consistently returns numbers that are too
3226 large or too small, then your version of Perl was probably compiled
3227 with the wrong number of RANDBITS.)
3228
3229 =item read FILEHANDLE,SCALAR,LENGTH,OFFSET
3230
3231 =item read FILEHANDLE,SCALAR,LENGTH
3232
3233 Attempts to read LENGTH bytes of data into variable SCALAR from the
3234 specified FILEHANDLE.  Returns the number of bytes actually read,
3235 C<0> at end of file, or undef if there was an error.  SCALAR will be grown
3236 or shrunk to the length actually read.  An OFFSET may be specified to
3237 place the read data at some other place than the beginning of the
3238 string.  This call is actually implemented in terms of stdio's fread(3)
3239 call.  To get a true read(2) system call, see C<sysread>.
3240
3241 =item readdir DIRHANDLE
3242
3243 Returns the next directory entry for a directory opened by C<opendir>.
3244 If used in list context, returns all the rest of the entries in the
3245 directory.  If there are no more entries, returns an undefined value in
3246 scalar context or a null list in list context.
3247
3248 If you're planning to filetest the return values out of a C<readdir>, you'd
3249 better prepend the directory in question.  Otherwise, because we didn't
3250 C<chdir> there, it would have been testing the wrong file.
3251
3252     opendir(DIR, $some_dir) || die "can't opendir $some_dir: $!";
3253     @dots = grep { /^\./ && -f "$some_dir/$_" } readdir(DIR);
3254     closedir DIR;
3255
3256 =item readline EXPR
3257
3258 Reads from the filehandle whose typeglob is contained in EXPR.  In scalar
3259 context, each call reads and returns the next line, until end-of-file is
3260 reached, whereupon the subsequent call returns undef.  In list context,
3261 reads until end-of-file is reached and returns a list of lines.  Note that
3262 the notion of "line" used here is however you may have defined it
3263 with C<$/> or C<$INPUT_RECORD_SEPARATOR>).  See L<perlvar/"$/">.
3264
3265 When C<$/> is set to C<undef>, when readline() is in scalar
3266 context (i.e. file slurp mode), and when an empty file is read, it
3267 returns C<''> the first time, followed by C<undef> subsequently.
3268
3269 This is the internal function implementing the C<E<lt>EXPRE<gt>>
3270 operator, but you can use it directly.  The C<E<lt>EXPRE<gt>>
3271 operator is discussed in more detail in L<perlop/"I/O Operators">.
3272
3273     $line = <STDIN>;
3274     $line = readline(*STDIN);           # same thing
3275
3276 =item readlink EXPR
3277
3278 =item readlink
3279
3280 Returns the value of a symbolic link, if symbolic links are
3281 implemented.  If not, gives a fatal error.  If there is some system
3282 error, returns the undefined value and sets C<$!> (errno).  If EXPR is
3283 omitted, uses C<$_>.
3284
3285 =item readpipe EXPR
3286
3287 EXPR is executed as a system command.
3288 The collected standard output of the command is returned.
3289 In scalar context, it comes back as a single (potentially
3290 multi-line) string.  In list context, returns a list of lines
3291 (however you've defined lines with C<$/> or C<$INPUT_RECORD_SEPARATOR>).
3292 This is the internal function implementing the C<qx/EXPR/>
3293 operator, but you can use it directly.  The C<qx/EXPR/>
3294 operator is discussed in more detail in L<perlop/"I/O Operators">.
3295
3296 =item recv SOCKET,SCALAR,LENGTH,FLAGS
3297
3298 Receives a message on a socket.  Attempts to receive LENGTH bytes of
3299 data into variable SCALAR from the specified SOCKET filehandle.  SCALAR
3300 will be grown or shrunk to the length actually read.  Takes the same
3301 flags as the system call of the same name.  Returns the address of the
3302 sender if SOCKET's protocol supports this; returns an empty string
3303 otherwise.  If there's an error, returns the undefined value.  This call
3304 is actually implemented in terms of recvfrom(2) system call.  See
3305 L<perlipc/"UDP: Message Passing"> for examples.
3306
3307 =item redo LABEL
3308
3309 =item redo
3310
3311 The C<redo> command restarts the loop block without evaluating the
3312 conditional again.  The C<continue> block, if any, is not executed.  If
3313 the LABEL is omitted, the command refers to the innermost enclosing
3314 loop.  This command is normally used by programs that want to lie to
3315 themselves about what was just input:
3316
3317     # a simpleminded Pascal comment stripper
3318     # (warning: assumes no { or } in strings)
3319     LINE: while (<STDIN>) {
3320         while (s|({.*}.*){.*}|$1 |) {}
3321         s|{.*}| |;
3322         if (s|{.*| |) {
3323             $front = $_;
3324             while (<STDIN>) {
3325                 if (/}/) {      # end of comment?
3326                     s|^|$front\{|;
3327                     redo LINE;
3328                 }
3329             }
3330         }
3331         print;
3332     }
3333
3334 C<redo> cannot be used to retry a block which returns a value such as
3335 C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit
3336 a grep() or map() operation.
3337
3338 Note that a block by itself is semantically identical to a loop
3339 that executes once.  Thus C<redo> inside such a block will effectively
3340 turn it into a looping construct.
3341
3342 See also L</continue> for an illustration of how C<last>, C<next>, and
3343 C<redo> work.
3344
3345 =item ref EXPR
3346
3347 =item ref
3348
3349 Returns a true value if EXPR is a reference, false otherwise.  If EXPR
3350 is not specified, C<$_> will be used.  The value returned depends on the
3351 type of thing the reference is a reference to.
3352 Builtin types include:
3353
3354     SCALAR
3355     ARRAY
3356     HASH
3357     CODE
3358     REF
3359     GLOB
3360     LVALUE
3361
3362 If the referenced object has been blessed into a package, then that package
3363 name is returned instead.  You can think of C<ref> as a C<typeof> operator.
3364
3365     if (ref($r) eq "HASH") {
3366         print "r is a reference to a hash.\n";
3367     }
3368     unless (ref($r)) {
3369         print "r is not a reference at all.\n";
3370     }
3371     if (UNIVERSAL::isa($r, "HASH")) {  # for subclassing
3372         print "r is a reference to something that isa hash.\n";
3373     } 
3374
3375 See also L<perlref>.
3376
3377 =item rename OLDNAME,NEWNAME
3378
3379 Changes the name of a file; an existing file NEWNAME will be
3380 clobbered.  Returns true for success, false otherwise.
3381
3382 Behavior of this function varies wildly depending on your system
3383 implementation.  For example, it will usually not work across file system
3384 boundaries, even though the system I<mv> command sometimes compensates
3385 for this.  Other restrictions include whether it works on directories,
3386 open files, or pre-existing files.  Check L<perlport> and either the
3387 rename(2) manpage or equivalent system documentation for details.
3388
3389 =item require EXPR
3390
3391 =item require
3392
3393 Demands some semantics specified by EXPR, or by C<$_> if EXPR is not
3394 supplied.  If EXPR is numeric, demands that the current version of Perl
3395 (C<$]> or $PERL_VERSION) be equal or greater than EXPR.
3396
3397 Otherwise, demands that a library file be included if it hasn't already
3398 been included.  The file is included via the do-FILE mechanism, which is
3399 essentially just a variety of C<eval>.  Has semantics similar to the following
3400 subroutine:
3401
3402     sub require {
3403         my($filename) = @_;
3404         return 1 if $INC{$filename};
3405         my($realfilename,$result);
3406         ITER: {
3407             foreach $prefix (@INC) {
3408                 $realfilename = "$prefix/$filename";
3409                 if (-f $realfilename) {
3410                     $result = do $realfilename;
3411                     last ITER;
3412                 }
3413             }
3414             die "Can't find $filename in \@INC";
3415         }
3416         die $@ if $@;
3417         die "$filename did not return true value" unless $result;
3418         $INC{$filename} = $realfilename;
3419         return $result;
3420     }
3421
3422 Note that the file will not be included twice under the same specified
3423 name.  The file must return true as the last statement to indicate
3424 successful execution of any initialization code, so it's customary to
3425 end such a file with C<1;> unless you're sure it'll return true
3426 otherwise.  But it's better just to put the C<1;>, in case you add more
3427 statements.
3428
3429 If EXPR is a bareword, the require assumes a "F<.pm>" extension and
3430 replaces "F<::>" with "F</>" in the filename for you,
3431 to make it easy to load standard modules.  This form of loading of
3432 modules does not risk altering your namespace.
3433
3434 In other words, if you try this:
3435
3436         require Foo::Bar;    # a splendid bareword 
3437
3438 The require function will actually look for the "F<Foo/Bar.pm>" file in the 
3439 directories specified in the C<@INC> array.
3440
3441 But if you try this:
3442
3443         $class = 'Foo::Bar';
3444         require $class;      # $class is not a bareword
3445     #or
3446         require "Foo::Bar";  # not a bareword because of the ""
3447
3448 The require function will look for the "F<Foo::Bar>" file in the @INC array and 
3449 will complain about not finding "F<Foo::Bar>" there.  In this case you can do:
3450
3451         eval "require $class";
3452
3453 For a yet-more-powerful import facility, see L</use> and L<perlmod>.
3454
3455 =item reset EXPR
3456
3457 =item reset
3458
3459 Generally used in a C<continue> block at the end of a loop to clear
3460 variables and reset C<??> searches so that they work again.  The
3461 expression is interpreted as a list of single characters (hyphens
3462 allowed for ranges).  All variables and arrays beginning with one of
3463 those letters are reset to their pristine state.  If the expression is
3464 omitted, one-match searches (C<?pattern?>) are reset to match again.  Resets
3465 only variables or searches in the current package.  Always returns
3466 1.  Examples:
3467
3468     reset 'X';          # reset all X variables
3469     reset 'a-z';        # reset lower case variables
3470     reset;              # just reset ?one-time? searches
3471
3472 Resetting C<"A-Z"> is not recommended because you'll wipe out your
3473 C<@ARGV> and C<@INC> arrays and your C<%ENV> hash.  Resets only package
3474 variables--lexical variables are unaffected, but they clean themselves
3475 up on scope exit anyway, so you'll probably want to use them instead.
3476 See L</my>.
3477
3478 =item return EXPR
3479
3480 =item return
3481
3482 Returns from a subroutine, C<eval>, or C<do FILE> with the value 
3483 given in EXPR.  Evaluation of EXPR may be in list, scalar, or void
3484 context, depending on how the return value will be used, and the context
3485 may vary from one execution to the next (see C<wantarray>).  If no EXPR
3486 is given, returns an empty list in list context, the undefined value in
3487 scalar context, and (of course) nothing at all in a void context.
3488
3489 (Note that in the absence of a explicit C<return>, a subroutine, eval,
3490 or do FILE will automatically return the value of the last expression
3491 evaluated.)
3492
3493 =item reverse LIST
3494
3495 In list context, returns a list value consisting of the elements
3496 of LIST in the opposite order.  In scalar context, concatenates the
3497 elements of LIST and returns a string value with all characters
3498 in the opposite order.
3499
3500     print reverse <>;           # line tac, last line first
3501
3502     undef $/;                   # for efficiency of <>
3503     print scalar reverse <>;    # character tac, last line tsrif
3504
3505 This operator is also handy for inverting a hash, although there are some
3506 caveats.  If a value is duplicated in the original hash, only one of those
3507 can be represented as a key in the inverted hash.  Also, this has to
3508 unwind one hash and build a whole new one, which may take some time
3509 on a large hash, such as from a DBM file.
3510
3511     %by_name = reverse %by_address;     # Invert the hash
3512
3513 =item rewinddir DIRHANDLE
3514
3515 Sets the current position to the beginning of the directory for the
3516 C<readdir> routine on DIRHANDLE.
3517
3518 =item rindex STR,SUBSTR,POSITION
3519
3520 =item rindex STR,SUBSTR
3521
3522 Works just like index() except that it returns the position of the LAST
3523 occurrence of SUBSTR in STR.  If POSITION is specified, returns the
3524 last occurrence at or before that position.
3525
3526 =item rmdir FILENAME
3527
3528 =item rmdir
3529
3530 Deletes the directory specified by FILENAME if that directory is empty.  If it
3531 succeeds it returns true, otherwise it returns false and sets C<$!> (errno).  If
3532 FILENAME is omitted, uses C<$_>.
3533
3534 =item s///
3535
3536 The substitution operator.  See L<perlop>.
3537
3538 =item scalar EXPR
3539
3540 Forces EXPR to be interpreted in scalar context and returns the value
3541 of EXPR.
3542
3543     @counts = ( scalar @a, scalar @b, scalar @c );
3544
3545 There is no equivalent operator to force an expression to
3546 be interpolated in list context because in practice, this is never
3547 needed.  If you really wanted to do so, however, you could use
3548 the construction C<@{[ (some expression) ]}>, but usually a simple
3549 C<(some expression)> suffices.
3550
3551 Because C<scalar> is unary operator, if you accidentally use for EXPR a
3552 parenthesized list, this behaves as a scalar comma expression, evaluating
3553 all but the last element in void context and returning the final element
3554 evaluated in scalar context.  This is seldom what you want.
3555
3556 The following single statement:
3557
3558         print uc(scalar(&foo,$bar)),$baz;
3559
3560 is the moral equivalent of these two:
3561
3562         &foo;
3563         print(uc($bar),$baz);
3564
3565 See L<perlop> for more details on unary operators and the comma operator.
3566
3567 =item seek FILEHANDLE,POSITION,WHENCE
3568
3569 Sets FILEHANDLE's position, just like the C<fseek> call of C<stdio>.
3570 FILEHANDLE may be an expression whose value gives the name of the
3571 filehandle.  The values for WHENCE are C<0> to set the new position to
3572 POSITION, C<1> to set it to the current position plus POSITION, and
3573 C<2> to set it to EOF plus POSITION (typically negative).  For WHENCE
3574 you may use the constants C<SEEK_SET>, C<SEEK_CUR>, and C<SEEK_END>
3575 (start of the file, current position, end of the file) from any of the
3576 modules Fcntl, C<IO::Seekable>, or POSIX.  Returns C<1> upon success,
3577 C<0> otherwise.
3578
3579 If you want to position file for C<sysread> or C<syswrite>, don't use
3580 C<seek>--buffering makes its effect on the file's system position
3581 unpredictable and non-portable.  Use C<sysseek> instead.
3582
3583 Due to the rules and rigors of ANSI C, on some systems you have to do a
3584 seek whenever you switch between reading and writing.  Amongst other
3585 things, this may have the effect of calling stdio's clearerr(3).
3586 A WHENCE of C<1> (C<SEEK_CUR>) is useful for not moving the file position:
3587
3588     seek(TEST,0,1);
3589
3590 This is also useful for applications emulating C<tail -f>.  Once you hit
3591 EOF on your read, and then sleep for a while, you might have to stick in a
3592 seek() to reset things.  The C<seek> doesn't change the current position,
3593 but it I<does> clear the end-of-file condition on the handle, so that the
3594 next C<E<lt>FILEE<gt>> makes Perl try again to read something.  We hope.
3595
3596 If that doesn't work (some stdios are particularly cantankerous), then
3597 you may need something more like this:
3598
3599     for (;;) {
3600         for ($curpos = tell(FILE); $_ = <FILE>;
3601              $curpos = tell(FILE)) {
3602             # search for some stuff and put it into files
3603         }
3604         sleep($for_a_while);
3605         seek(FILE, $curpos, 0);
3606     }
3607
3608 =item seekdir DIRHANDLE,POS
3609
3610 Sets the current position for the C<readdir> routine on DIRHANDLE.  POS
3611 must be a value returned by C<telldir>.  Has the same caveats about
3612 possible directory compaction as the corresponding system library
3613 routine.
3614
3615 =item select FILEHANDLE
3616
3617 =item select
3618
3619 Returns the currently selected filehandle.  Sets the current default
3620 filehandle for output, if FILEHANDLE is supplied.  This has two
3621 effects: first, a C<write> or a C<print> without a filehandle will
3622 default to this FILEHANDLE.  Second, references to variables related to
3623 output will refer to this output channel.  For example, if you have to
3624 set the top of form format for more than one output channel, you might
3625 do the following:
3626
3627     select(REPORT1);
3628     $^ = 'report1_top';
3629     select(REPORT2);
3630     $^ = 'report2_top';
3631
3632 FILEHANDLE may be an expression whose value gives the name of the
3633 actual filehandle.  Thus:
3634
3635     $oldfh = select(STDERR); $| = 1; select($oldfh);
3636
3637 Some programmers may prefer to think of filehandles as objects with
3638 methods, preferring to write the last example as:
3639
3640     use IO::Handle;
3641     STDERR->autoflush(1);
3642
3643 =item select RBITS,WBITS,EBITS,TIMEOUT
3644
3645 This calls the select(2) system call with the bit masks specified, which
3646 can be constructed using C<fileno> and C<vec>, along these lines:
3647
3648     $rin = $win = $ein = '';
3649     vec($rin,fileno(STDIN),1) = 1;
3650     vec($win,fileno(STDOUT),1) = 1;
3651     $ein = $rin | $win;
3652
3653 If you want to select on many filehandles you might wish to write a
3654 subroutine:
3655
3656     sub fhbits {
3657         my(@fhlist) = split(' ',$_[0]);
3658         my($bits);
3659         for (@fhlist) {
3660             vec($bits,fileno($_),1) = 1;
3661         }
3662         $bits;
3663     }
3664     $rin = fhbits('STDIN TTY SOCK');
3665
3666 The usual idiom is:
3667
3668     ($nfound,$timeleft) =
3669       select($rout=$rin, $wout=$win, $eout=$ein, $timeout);
3670
3671 or to block until something becomes ready just do this
3672
3673     $nfound = select($rout=$rin, $wout=$win, $eout=$ein, undef);
3674
3675 Most systems do not bother to return anything useful in $timeleft, so
3676 calling select() in scalar context just returns $nfound.
3677
3678 Any of the bit masks can also be undef.  The timeout, if specified, is
3679 in seconds, which may be fractional.  Note: not all implementations are
3680 capable of returning the$timeleft.  If not, they always return
3681 $timeleft equal to the supplied $timeout.
3682
3683 You can effect a sleep of 250 milliseconds this way:
3684
3685     select(undef, undef, undef, 0.25);
3686
3687 B<WARNING>: One should not attempt to mix buffered I/O (like C<read>
3688 or E<lt>FHE<gt>) with C<select>, except as permitted by POSIX, and even
3689 then only on POSIX systems.  You have to use C<sysread> instead.
3690
3691 =item semctl ID,SEMNUM,CMD,ARG
3692
3693 Calls the System V IPC function C<semctl>.  You'll probably have to say
3694
3695     use IPC::SysV;
3696
3697 first to get the correct constant definitions.  If CMD is IPC_STAT or
3698 GETALL, then ARG must be a variable which will hold the returned
3699 semid_ds structure or semaphore value array.  Returns like C<ioctl>: the
3700 undefined value for error, "C<0 but true>" for zero, or the actual return
3701 value otherwise.  See also C<IPC::SysV> and C<IPC::Semaphore> documentation.
3702
3703 =item semget KEY,NSEMS,FLAGS
3704
3705 Calls the System V IPC function semget.  Returns the semaphore id, or
3706 the undefined value if there is an error.  See also C<IPC::SysV> and
3707 C<IPC::SysV::Semaphore> documentation.
3708
3709 =item semop KEY,OPSTRING
3710
3711 Calls the System V IPC function semop to perform semaphore operations
3712 such as signaling and waiting.  OPSTRING must be a packed array of
3713 semop structures.  Each semop structure can be generated with
3714 C<pack("sss", $semnum, $semop, $semflag)>.  The number of semaphore
3715 operations is implied by the length of OPSTRING.  Returns true if
3716 successful, or false if there is an error.  As an example, the
3717 following code waits on semaphore $semnum of semaphore id $semid:
3718
3719     $semop = pack("sss", $semnum, -1, 0);
3720     die "Semaphore trouble: $!\n" unless semop($semid, $semop);
3721
3722 To signal the semaphore, replace C<-1> with C<1>.  See also C<IPC::SysV>
3723 and C<IPC::SysV::Semaphore> documentation.
3724
3725 =item send SOCKET,MSG,FLAGS,TO
3726
3727 =item send SOCKET,MSG,FLAGS
3728
3729 Sends a message on a socket.  Takes the same flags as the system call
3730 of the same name.  On unconnected sockets you must specify a
3731 destination to send TO, in which case it does a C C<sendto>.  Returns
3732 the number of characters sent, or the undefined value if there is an
3733 error.  The C system call sendmsg(2) is currently unimplemented.
3734 See L<perlipc/"UDP: Message Passing"> for examples.
3735
3736 =item setpgrp PID,PGRP
3737
3738 Sets the current process group for the specified PID, C<0> for the current
3739 process.  Will produce a fatal error if used on a machine that doesn't
3740 implement POSIX setpgid(2) or BSD setpgrp(2).  If the arguments are omitted,
3741 it defaults to C<0,0>.  Note that the BSD 4.2 version of C<setpgrp> does not
3742 accept any arguments, so only C<setpgrp(0,0)> is portable.  See also
3743 C<POSIX::setsid()>.
3744
3745 =item setpriority WHICH,WHO,PRIORITY
3746
3747 Sets the current priority for a process, a process group, or a user.
3748 (See setpriority(2).)  Will produce a fatal error if used on a machine
3749 that doesn't implement setpriority(2).
3750
3751 =item setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL
3752
3753 Sets the socket option requested.  Returns undefined if there is an
3754 error.  OPTVAL may be specified as C<undef> if you don't want to pass an
3755 argument.
3756
3757 =item shift ARRAY
3758
3759 =item shift
3760
3761 Shifts the first value of the array off and returns it, shortening the
3762 array by 1 and moving everything down.  If there are no elements in the
3763 array, returns the undefined value.  If ARRAY is omitted, shifts the
3764 C<@_> array within the lexical scope of subroutines and formats, and the
3765 C<@ARGV> array at file scopes or within the lexical scopes established by
3766 the C<eval ''>, C<BEGIN {}>, C<END {}>, and C<INIT {}> constructs.
3767 See also C<unshift>, C<push>, and C<pop>.  C<Shift()> and C<unshift> do the
3768 same thing to the left end of an array that C<pop> and C<push> do to the
3769 right end.
3770
3771 =item shmctl ID,CMD,ARG
3772
3773 Calls the System V IPC function shmctl.  You'll probably have to say
3774
3775     use IPC::SysV;
3776
3777 first to get the correct constant definitions.  If CMD is C<IPC_STAT>,
3778 then ARG must be a variable which will hold the returned C<shmid_ds>
3779 structure.  Returns like ioctl: the undefined value for error, "C<0> but
3780 true" for zero, or the actual return value otherwise.
3781 See also C<IPC::SysV> documentation.
3782
3783 =item shmget KEY,SIZE,FLAGS
3784
3785 Calls the System V IPC function shmget.  Returns the shared memory
3786 segment id, or the undefined value if there is an error.
3787 See also C<IPC::SysV> documentation.
3788
3789 =item shmread ID,VAR,POS,SIZE
3790
3791 =item shmwrite ID,STRING,POS,SIZE
3792
3793 Reads or writes the System V shared memory segment ID starting at
3794 position POS for size SIZE by attaching to it, copying in/out, and
3795 detaching from it.  When reading, VAR must be a variable that will
3796 hold the data read.  When writing, if STRING is too long, only SIZE
3797 bytes are used; if STRING is too short, nulls are written to fill out
3798 SIZE bytes.  Return true if successful, or false if there is an error.
3799 See also C<IPC::SysV> documentation and the C<IPC::Shareable> module
3800 from CPAN.
3801
3802 =item shutdown SOCKET,HOW
3803
3804 Shuts down a socket connection in the manner indicated by HOW, which
3805 has the same interpretation as in the system call of the same name.
3806
3807     shutdown(SOCKET, 0);    # I/we have stopped reading data
3808     shutdown(SOCKET, 1);    # I/we have stopped writing data
3809     shutdown(SOCKET, 2);    # I/we have stopped using this socket
3810
3811 This is useful with sockets when you want to tell the other
3812 side you're done writing but not done reading, or vice versa.
3813 It's also a more insistent form of close because it also 
3814 disables the file descriptor in any forked copies in other
3815 processes.
3816
3817 =item sin EXPR
3818
3819 =item sin
3820
3821 Returns the sine of EXPR (expressed in radians).  If EXPR is omitted,
3822 returns sine of C<$_>.
3823
3824 For the inverse sine operation, you may use the C<POSIX::asin>
3825 function, or use this relation:
3826
3827     sub asin { atan2($_[0], sqrt(1 - $_[0] * $_[0])) }
3828
3829 =item sleep EXPR
3830
3831 =item sleep
3832
3833 Causes the script to sleep for EXPR seconds, or forever if no EXPR.
3834 May be interrupted if the process receives a signal such as C<SIGALRM>.
3835 Returns the number of seconds actually slept.  You probably cannot
3836 mix C<alarm> and C<sleep> calls, because C<sleep> is often implemented
3837 using C<alarm>.
3838
3839 On some older systems, it may sleep up to a full second less than what
3840 you requested, depending on how it counts seconds.  Most modern systems
3841 always sleep the full amount.  They may appear to sleep longer than that,
3842 however, because your process might not be scheduled right away in a
3843 busy multitasking system.
3844
3845 For delays of finer granularity than one second, you may use Perl's
3846 C<syscall> interface to access setitimer(2) if your system supports
3847 it, or else see L</select> above.  The Time::HiRes module from CPAN
3848 may also help.
3849
3850 See also the POSIX module's C<sigpause> function.
3851
3852 =item socket SOCKET,DOMAIN,TYPE,PROTOCOL
3853
3854 Opens a socket of the specified kind and attaches it to filehandle
3855 SOCKET.  DOMAIN, TYPE, and PROTOCOL are specified the same as for
3856 the system call of the same name.  You should C<use Socket> first
3857 to get the proper definitions imported.  See the examples in
3858 L<perlipc/"Sockets: Client/Server Communication">.
3859
3860 =item socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL
3861
3862 Creates an unnamed pair of sockets in the specified domain, of the
3863 specified type.  DOMAIN, TYPE, and PROTOCOL are specified the same as
3864 for the system call of the same name.  If unimplemented, yields a fatal
3865 error.  Returns true if successful.
3866
3867 Some systems defined C<pipe> in terms of C<socketpair>, in which a call
3868 to C<pipe(Rdr, Wtr)> is essentially:
3869
3870     use Socket;
3871     socketpair(Rdr, Wtr, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
3872     shutdown(Rdr, 1);        # no more writing for reader
3873     shutdown(Wtr, 0);        # no more reading for writer
3874
3875 See L<perlipc> for an example of socketpair use.
3876
3877 =item sort SUBNAME LIST
3878
3879 =item sort BLOCK LIST
3880
3881 =item sort LIST
3882
3883 Sorts the LIST and returns the sorted list value.  If SUBNAME or BLOCK
3884 is omitted, C<sort>s in standard string comparison order.  If SUBNAME is
3885 specified, it gives the name of a subroutine that returns an integer
3886 less than, equal to, or greater than C<0>, depending on how the elements
3887 of the list are to be ordered.  (The C<E<lt>=E<gt>> and C<cmp>
3888 operators are extremely useful in such routines.)  SUBNAME may be a
3889 scalar variable name (unsubscripted), in which case the value provides
3890 the name of (or a reference to) the actual subroutine to use.  In place
3891 of a SUBNAME, you can provide a BLOCK as an anonymous, in-line sort
3892 subroutine.
3893
3894 In the interests of efficiency the normal calling code for subroutines is
3895 bypassed, with the following effects: the subroutine may not be a
3896 recursive subroutine, and the two elements to be compared are passed into
3897 the subroutine not via C<@_> but as the package global variables $a and
3898 $b (see example below).  They are passed by reference, so don't
3899 modify $a and $b.  And don't try to declare them as lexicals either.
3900
3901 You also cannot exit out of the sort block or subroutine using any of the
3902 loop control operators described in L<perlsyn> or with C<goto>.
3903
3904 When C<use locale> is in effect, C<sort LIST> sorts LIST according to the
3905 current collation locale.  See L<perllocale>.
3906
3907 Examples:
3908
3909     # sort lexically
3910     @articles = sort @files;
3911
3912     # same thing, but with explicit sort routine
3913     @articles = sort {$a cmp $b} @files;
3914
3915     # now case-insensitively
3916     @articles = sort {uc($a) cmp uc($b)} @files;
3917
3918     # same thing in reversed order
3919     @articles = sort {$b cmp $a} @files;
3920
3921     # sort numerically ascending
3922     @articles = sort {$a <=> $b} @files;
3923
3924     # sort numerically descending
3925     @articles = sort {$b <=> $a} @files;
3926
3927     # this sorts the %age hash by value instead of key
3928     # using an in-line function
3929     @eldest = sort { $age{$b} <=> $age{$a} } keys %age;
3930
3931     # sort using explicit subroutine name
3932     sub byage {
3933         $age{$a} <=> $age{$b};  # presuming numeric
3934     }
3935     @sortedclass = sort byage @class;
3936
3937     sub backwards { $b cmp $a }
3938     @harry  = qw(dog cat x Cain Abel);
3939     @george = qw(gone chased yz Punished Axed);
3940     print sort @harry;
3941             # prints AbelCaincatdogx
3942     print sort backwards @harry;
3943             # prints xdogcatCainAbel
3944     print sort @george, 'to', @harry;
3945             # prints AbelAxedCainPunishedcatchaseddoggonetoxyz
3946
3947     # inefficiently sort by descending numeric compare using
3948     # the first integer after the first = sign, or the
3949     # whole record case-insensitively otherwise
3950
3951     @new = sort {
3952         ($b =~ /=(\d+)/)[0] <=> ($a =~ /=(\d+)/)[0]
3953                             ||
3954                     uc($a)  cmp  uc($b)
3955     } @old;
3956
3957     # same thing, but much more efficiently;
3958     # we'll build auxiliary indices instead
3959     # for speed
3960     @nums = @caps = ();
3961     for (@old) {
3962         push @nums, /=(\d+)/;
3963         push @caps, uc($_);
3964     }
3965
3966     @new = @old[ sort {
3967                         $nums[$b] <=> $nums[$a]
3968                                  ||
3969                         $caps[$a] cmp $caps[$b]
3970                        } 0..$#old
3971                ];
3972
3973     # same thing, but without any temps
3974     @new = map { $_->[0] }
3975            sort { $b->[1] <=> $a->[1]
3976                            ||
3977                   $a->[2] cmp $b->[2]
3978            } map { [$_, /=(\d+)/, uc($_)] } @old;
3979
3980 If you're using strict, you I<must not> declare $a
3981 and $b as lexicals.  They are package globals.  That means
3982 if you're in the C<main> package, it's
3983
3984     @articles = sort {$main::b <=> $main::a} @files;
3985
3986 or just
3987
3988     @articles = sort {$::b <=> $::a} @files;
3989
3990 but if you're in the C<FooPack> package, it's
3991
3992     @articles = sort {$FooPack::b <=> $FooPack::a} @files;
3993
3994 The comparison function is required to behave.  If it returns
3995 inconsistent results (sometimes saying C<$x[1]> is less than C<$x[2]> and
3996 sometimes saying the opposite, for example) the results are not
3997 well-defined.
3998
3999 =item splice ARRAY,OFFSET,LENGTH,LIST
4000
4001 =item splice ARRAY,OFFSET,LENGTH
4002
4003 =item splice ARRAY,OFFSET
4004
4005 Removes the elements designated by OFFSET and LENGTH from an array, and
4006 replaces them with the elements of LIST, if any.  In list context,
4007 returns the elements removed from the array.  In scalar context,
4008 returns the last element removed, or C<undef> if no elements are
4009 removed.  The array grows or shrinks as necessary.
4010 If OFFSET is negative then it starts that far from the end of the array.
4011 If LENGTH is omitted, removes everything from OFFSET onward.
4012 If LENGTH is negative, leave that many elements off the end of the array.
4013 The following equivalences hold (assuming C<$[ == 0>):
4014
4015     push(@a,$x,$y)      splice(@a,@a,0,$x,$y)
4016     pop(@a)             splice(@a,-1)
4017     shift(@a)           splice(@a,0,1)
4018     unshift(@a,$x,$y)   splice(@a,0,0,$x,$y)
4019     $a[$x] = $y         splice(@a,$x,1,$y)
4020
4021 Example, assuming array lengths are passed before arrays:
4022
4023     sub aeq {   # compare two list values
4024         my(@a) = splice(@_,0,shift);
4025         my(@b) = splice(@_,0,shift);
4026         return 0 unless @a == @b;       # same len?
4027         while (@a) {
4028             return 0 if pop(@a) ne pop(@b);
4029         }
4030         return 1;
4031     }
4032     if (&aeq($len,@foo[1..$len],0+@bar,@bar)) { ... }
4033
4034 =item split /PATTERN/,EXPR,LIMIT
4035
4036 =item split /PATTERN/,EXPR
4037
4038 =item split /PATTERN/
4039
4040 =item split
4041
4042 Splits a string into a list of strings and returns that list.  By default,
4043 empty leading fields are preserved, and empty trailing ones are deleted.
4044
4045 If not in list context, returns the number of fields found and splits into
4046 the C<@_> array.  (In list context, you can force the split into C<@_> by
4047 using C<??> as the pattern delimiters, but it still returns the list
4048 value.)  The use of implicit split to C<@_> is deprecated, however, because
4049 it clobbers your subroutine arguments.
4050
4051 If EXPR is omitted, splits the C<$_> string.  If PATTERN is also omitted,
4052 splits on whitespace (after skipping any leading whitespace).  Anything
4053 matching PATTERN is taken to be a delimiter separating the fields.  (Note
4054 that the delimiter may be longer than one character.)
4055
4056 If LIMIT is specified and positive, splits into no more than that
4057 many fields (though it may split into fewer).  If LIMIT is unspecified
4058 or zero, trailing null fields are stripped (which potential users
4059 of C<pop> would do well to remember).  If LIMIT is negative, it is
4060 treated as if an arbitrarily large LIMIT had been specified.
4061
4062 A pattern matching the null string (not to be confused with
4063 a null pattern C<//>, which is just one member of the set of patterns
4064 matching a null string) will split the value of EXPR into separate
4065 characters at each point it matches that way.  For example:
4066
4067     print join(':', split(/ */, 'hi there'));
4068
4069 produces the output 'h:i:t:h:e:r:e'.
4070
4071 The LIMIT parameter can be used to split a line partially
4072
4073     ($login, $passwd, $remainder) = split(/:/, $_, 3);
4074
4075 When assigning to a list, if LIMIT is omitted, Perl supplies a LIMIT
4076 one larger than the number of variables in the list, to avoid
4077 unnecessary work.  For the list above LIMIT would have been 4 by
4078 default.  In time critical applications it behooves you not to split
4079 into more fields than you really need.
4080
4081 If the PATTERN contains parentheses, additional list elements are
4082 created from each matching substring in the delimiter.
4083
4084     split(/([,-])/, "1-10,20", 3);
4085
4086 produces the list value
4087
4088     (1, '-', 10, ',', 20)
4089
4090 If you had the entire header of a normal Unix email message in $header,
4091 you could split it up into fields and their values this way:
4092
4093     $header =~ s/\n\s+/ /g;  # fix continuation lines
4094     %hdrs   =  (UNIX_FROM => split /^(\S*?):\s*/m, $header);
4095
4096 The pattern C</PATTERN/> may be replaced with an expression to specify
4097 patterns that vary at runtime.  (To do runtime compilation only once,
4098 use C</$variable/o>.)
4099
4100 As a special case, specifying a PATTERN of space (C<' '>) will split on
4101 white space just as C<split> with no arguments does.  Thus, C<split(' ')> can
4102 be used to emulate B<awk>'s default behavior, whereas C<split(/ /)>
4103 will give you as many null initial fields as there are leading spaces.
4104 A C<split> on C</\s+/> is like a C<split(' ')> except that any leading
4105 whitespace produces a null first field.  A C<split> with no arguments
4106 really does a C<split(' ', $_)> internally.
4107
4108 Example:
4109
4110     open(PASSWD, '/etc/passwd');
4111     while (<PASSWD>) {
4112         ($login, $passwd, $uid, $gid,
4113          $gcos, $home, $shell) = split(/:/);
4114         #...
4115     }
4116
4117 (Note that $shell above will still have a newline on it.  See L</chop>,
4118 L</chomp>, and L</join>.)
4119
4120 =item sprintf FORMAT, LIST
4121
4122 Returns a string formatted by the usual C<printf> conventions of the
4123 C library function C<sprintf>.  See L<sprintf(3)> or L<printf(3)>
4124 on your system for an explanation of the general principles.
4125
4126 Perl does its own C<sprintf> formatting--it emulates the C
4127 function C<sprintf>, but it doesn't use it (except for floating-point
4128 numbers, and even then only the standard modifiers are allowed).  As a
4129 result, any non-standard extensions in your local C<sprintf> are not
4130 available from Perl.
4131
4132 Perl's C<sprintf> permits the following universally-known conversions:
4133
4134    %%   a percent sign
4135    %c   a character with the given number
4136    %s   a string
4137    %d   a signed integer, in decimal
4138    %u   an unsigned integer, in decimal
4139    %o   an unsigned integer, in octal
4140    %x   an unsigned integer, in hexadecimal
4141    %e   a floating-point number, in scientific notation
4142    %f   a floating-point number, in fixed decimal notation
4143    %g   a floating-point number, in %e or %f notation
4144
4145 In addition, Perl permits the following widely-supported conversions:
4146
4147    %X   like %x, but using upper-case letters
4148    %E   like %e, but using an upper-case "E"
4149    %G   like %g, but with an upper-case "E" (if applicable)
4150    %b   an unsigned integer, in binary
4151    %p   a pointer (outputs the Perl value's address in hexadecimal)
4152    %n   special: *stores* the number of characters output so far
4153         into the next variable in the parameter list 
4154
4155 Finally, for backward (and we do mean "backward") compatibility, Perl
4156 permits these unnecessary but widely-supported conversions:
4157
4158    %i   a synonym for %d
4159    %D   a synonym for %ld
4160    %U   a synonym for %lu
4161    %O   a synonym for %lo
4162    %F   a synonym for %f
4163
4164 Perl permits the following universally-known flags between the C<%>
4165 and the conversion letter:
4166
4167    space   prefix positive number with a space
4168    +       prefix positive number with a plus sign
4169    -       left-justify within the field
4170    0       use zeros, not spaces, to right-justify
4171    #       prefix non-zero octal with "0", non-zero hex with "0x"
4172    number  minimum field width
4173    .number "precision": digits after decimal point for
4174            floating-point, max length for string, minimum length
4175            for integer
4176    l       interpret integer as C type "long" or "unsigned long"
4177    h       interpret integer as C type "short" or "unsigned short"
4178            If no flags, interpret integer as C type "int" or "unsigned"
4179
4180 There is also one Perl-specific flag:
4181
4182    V       interpret integer as Perl's standard integer type
4183
4184 Where a number would appear in the flags, an asterisk (C<*>) may be
4185 used instead, in which case Perl uses the next item in the parameter
4186 list as the given number (that is, as the field width or precision).
4187 If a field width obtained through C<*> is negative, it has the same
4188 effect as the C<-> flag: left-justification.
4189
4190 If C<use locale> is in effect, the character used for the decimal
4191 point in formatted real numbers is affected by the LC_NUMERIC locale.
4192 See L<perllocale>.
4193
4194 To cope with broken systems that allow the standard locales to be
4195 overridden by malicious users, the return value may be tainted
4196 if any of the floating point formats are used and the conversion
4197 yields something that doesn't look like a normal C-locale floating
4198 point number.  This happens regardless of whether C<use locale> is
4199 in effect or not.
4200
4201 If Perl understands "quads" (64-bit integers) (this requires
4202 either that the platform natively supports quads or that Perl
4203 has been specifically compiled to support quads), the characters
4204
4205         d u o x X b i D U O
4206
4207 print quads, and they may optionally be preceded by
4208
4209         ll L q
4210
4211 For example
4212
4213         %lld %16LX %qo
4214
4215 You can find out whether your Perl supports quads via L<Config>:
4216
4217         use Config;
4218         ($Config{use64bits} eq 'define' || $Config{longsize} == 8) &&
4219                 print "quads\n";
4220
4221 If Perl understands "long doubles" (this requires that the platform
4222 supports long doubles), the flags
4223
4224         e f g E F G
4225
4226 may optionally be preceded by
4227
4228         ll L
4229
4230 For example
4231
4232         %llf %Lg
4233
4234 You can find out whether your Perl supports long doubles via L<Config>:
4235
4236         use Config;
4237         $Config{d_longdbl} eq 'define' && print "long doubles\n";
4238
4239 =item sqrt EXPR
4240
4241 =item sqrt
4242
4243 Return the square root of EXPR.  If EXPR is omitted, returns square
4244 root of C<$_>.  Only works on non-negative operands, unless you've
4245 loaded the standard Math::Complex module.
4246
4247     use Math::Complex;
4248     print sqrt(-2);    # prints 1.4142135623731i
4249
4250 =item srand EXPR
4251
4252 =item srand
4253
4254 Sets the random number seed for the C<rand> operator.  If EXPR is
4255 omitted, uses a semi-random value supplied by the kernel (if it supports
4256 the F</dev/urandom> device) or based on the current time and process
4257 ID, among other things.  In versions of Perl prior to 5.004 the default
4258 seed was just the current C<time>.  This isn't a particularly good seed,
4259 so many old programs supply their own seed value (often C<time ^ $$> or
4260 C<time ^ ($$ + ($$ E<lt>E<lt> 15))>), but that isn't necessary any more.
4261
4262 In fact, it's usually not necessary to call C<srand> at all, because if
4263 it is not called explicitly, it is called implicitly at the first use of
4264 the C<rand> operator.  However, this was not the case in version of Perl
4265 before 5.004, so if your script will run under older Perl versions, it
4266 should call C<srand>.
4267
4268 Note that you need something much more random than the default seed for
4269 cryptographic purposes.  Checksumming the compressed output of one or more
4270 rapidly changing operating system status programs is the usual method.  For
4271 example:
4272
4273     srand (time ^ $$ ^ unpack "%L*", `ps axww | gzip`);
4274
4275 If you're particularly concerned with this, see the C<Math::TrulyRandom>
4276 module in CPAN.
4277
4278 Do I<not> call C<srand> multiple times in your program unless you know
4279 exactly what you're doing and why you're doing it.  The point of the
4280 function is to "seed" the C<rand> function so that C<rand> can produce
4281 a different sequence each time you run your program.  Just do it once at the
4282 top of your program, or you I<won't> get random numbers out of C<rand>!
4283
4284 Frequently called programs (like CGI scripts) that simply use
4285
4286     time ^ $$
4287
4288 for a seed can fall prey to the mathematical property that
4289
4290     a^b == (a+1)^(b+1)
4291
4292 one-third of the time.  So don't do that.
4293
4294 =item stat FILEHANDLE
4295
4296 =item stat EXPR
4297
4298 =item stat
4299
4300 Returns a 13-element list giving the status info for a file, either
4301 the file opened via FILEHANDLE, or named by EXPR.  If EXPR is omitted,
4302 it stats C<$_>.  Returns a null list if the stat fails.  Typically used
4303 as follows:
4304
4305     ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
4306        $atime,$mtime,$ctime,$blksize,$blocks)
4307            = stat($filename);
4308
4309 Not all fields are supported on all filesystem types.  Here are the
4310 meaning of the fields:
4311
4312   0 dev      device number of filesystem
4313   1 ino      inode number
4314   2 mode     file mode  (type and permissions)
4315   3 nlink    number of (hard) links to the file
4316   4 uid      numeric user ID of file's owner
4317   5 gid      numeric group ID of file's owner
4318   6 rdev     the device identifier (special files only)
4319   7 size     total size of file, in bytes
4320   8 atime    last access time since the epoch
4321   9 mtime    last modify time since the epoch
4322  10 ctime    inode change time (NOT creation time!) since the epoch
4323  11 blksize  preferred block size for file system I/O
4324  12 blocks   actual number of blocks allocated
4325
4326 (The epoch was at 00:00 January 1, 1970 GMT.)
4327
4328 If stat is passed the special filehandle consisting of an underline, no
4329 stat is done, but the current contents of the stat structure from the
4330 last stat or filetest are returned.  Example:
4331
4332     if (-x $file && (($d) = stat(_)) && $d < 0) {
4333         print "$file is executable NFS file\n";
4334     }
4335
4336 (This works on machines only for which the device number is negative under NFS.)
4337
4338 Because the mode contains both the file type and its permissions, you
4339 should mask off the file type portion and (s)printf using a C<"%o"> 
4340 if you want to see the real permissions.
4341
4342     $mode = (stat($filename))[2];
4343     printf "Permissions are %04o\n", $mode & 07777;
4344
4345 In scalar context, C<stat> returns a boolean value indicating success
4346 or failure, and, if successful, sets the information associated with
4347 the special filehandle C<_>.
4348
4349 The File::stat module provides a convenient, by-name access mechanism:
4350
4351     use File::stat;
4352     $sb = stat($filename);
4353     printf "File is %s, size is %s, perm %04o, mtime %s\n", 
4354         $filename, $sb->size, $sb->mode & 07777,
4355         scalar localtime $sb->mtime;
4356
4357 =item study SCALAR
4358
4359 =item study
4360
4361 Takes extra time to study SCALAR (C<$_> if unspecified) in anticipation of
4362 doing many pattern matches on the string before it is next modified.
4363 This may or may not save time, depending on the nature and number of
4364 patterns you are searching on, and on the distribution of character
4365 frequencies in the string to be searched--you probably want to compare
4366 run times with and without it to see which runs faster.  Those loops
4367 which scan for many short constant strings (including the constant
4368 parts of more complex patterns) will benefit most.  You may have only
4369 one C<study> active at a time--if you study a different scalar the first
4370 is "unstudied".  (The way C<study> works is this: a linked list of every
4371 character in the string to be searched is made, so we know, for
4372 example, where all the C<'k'> characters are.  From each search string,
4373 the rarest character is selected, based on some static frequency tables
4374 constructed from some C programs and English text.  Only those places
4375 that contain this "rarest" character are examined.)
4376
4377 For example, here is a loop that inserts index producing entries
4378 before any line containing a certain pattern:
4379
4380     while (<>) {
4381         study;
4382         print ".IX foo\n"       if /\bfoo\b/;
4383         print ".IX bar\n"       if /\bbar\b/;
4384         print ".IX blurfl\n"    if /\bblurfl\b/;
4385         # ...
4386         print;
4387     }
4388
4389 In searching for C</\bfoo\b/>, only those locations in C<$_> that contain C<"f">
4390 will be looked at, because C<"f"> is rarer than C<"o">.  In general, this is
4391 a big win except in pathological cases.  The only question is whether
4392 it saves you more time than it took to build the linked list in the
4393 first place.
4394
4395 Note that if you have to look for strings that you don't know till
4396 runtime, you can build an entire loop as a string and C<eval> that to
4397 avoid recompiling all your patterns all the time.  Together with
4398 undefining C<$/> to input entire files as one record, this can be very
4399 fast, often faster than specialized programs like fgrep(1).  The following
4400 scans a list of files (C<@files>) for a list of words (C<@words>), and prints
4401 out the names of those files that contain a match:
4402
4403     $search = 'while (<>) { study;';
4404     foreach $word (@words) {
4405         $search .= "++\$seen{\$ARGV} if /\\b$word\\b/;\n";
4406     }
4407     $search .= "}";
4408     @ARGV = @files;
4409     undef $/;
4410     eval $search;               # this screams
4411     $/ = "\n";          # put back to normal input delimiter
4412     foreach $file (sort keys(%seen)) {
4413         print $file, "\n";
4414     }
4415
4416 =item sub BLOCK
4417
4418 =item sub NAME
4419
4420 =item sub NAME BLOCK
4421
4422 This is subroutine definition, not a real function I<per se>.  With just a
4423 NAME (and possibly prototypes or attributes), it's just a forward declaration.
4424 Without a NAME, it's an anonymous function declaration, and does actually
4425 return a value: the CODE ref of the closure you just created.  See L<perlsub>
4426 and L<perlref> for details.
4427
4428 =item substr EXPR,OFFSET,LENGTH,REPLACEMENT
4429
4430 =item substr EXPR,OFFSET,LENGTH
4431
4432 =item substr EXPR,OFFSET
4433
4434 Extracts a substring out of EXPR and returns it.  First character is at
4435 offset C<0>, or whatever you've set C<$[> to (but don't do that).
4436 If OFFSET is negative (or more precisely, less than C<$[>), starts
4437 that far from the end of the string.  If LENGTH is omitted, returns
4438 everything to the end of the string.  If LENGTH is negative, leaves that
4439 many characters off the end of the string.
4440
4441 You can use the substr() function as an lvalue, in which case EXPR
4442 must itself be an lvalue.  If you assign something shorter than LENGTH,
4443 the string will shrink, and if you assign something longer than LENGTH,
4444 the string will grow to accommodate it.  To keep the string the same
4445 length you may need to pad or chop your value using C<sprintf>.
4446
4447 If OFFSET and LENGTH specify a substring that is partly outside the
4448 string, only the part within the string is returned.  If the substring
4449 is beyond either end of the string, substr() returns the undefined
4450 value and produces a warning.  When used as an lvalue, specifying a
4451 substring that is entirely outside the string is a fatal error.
4452 Here's an example showing the behavior for boundary cases:
4453
4454     my $name = 'fred';
4455     substr($name, 4) = 'dy';            # $name is now 'freddy'
4456     my $null = substr $name, 6, 2;      # returns '' (no warning)
4457     my $oops = substr $name, 7;         # returns undef, with warning
4458     substr($name, 7) = 'gap';           # fatal error
4459
4460 An alternative to using substr() as an lvalue is to specify the
4461 replacement string as the 4th argument.  This allows you to replace
4462 parts of the EXPR and return what was there before in one operation,
4463 just as you can with splice().
4464
4465 =item symlink OLDFILE,NEWFILE
4466
4467 Creates a new filename symbolically linked to the old filename.
4468 Returns C<1> for success, C<0> otherwise.  On systems that don't support
4469 symbolic links, produces a fatal error at run time.  To check for that,
4470 use eval:
4471
4472     $symlink_exists = eval { symlink("",""); 1 };
4473
4474 =item syscall LIST
4475
4476 Calls the system call specified as the first element of the list,
4477 passing the remaining elements as arguments to the system call.  If
4478 unimplemented, produces a fatal error.  The arguments are interpreted
4479 as follows: if a given argument is numeric, the argument is passed as
4480 an int.  If not, the pointer to the string value is passed.  You are
4481 responsible to make sure a string is pre-extended long enough to
4482 receive any result that might be written into a string.  You can't use a
4483 string literal (or other read-only string) as an argument to C<syscall>
4484 because Perl has to assume that any string pointer might be written
4485 through.  If your
4486 integer arguments are not literals and have never been interpreted in a
4487 numeric context, you may need to add C<0> to them to force them to look
4488 like numbers.  This emulates the C<syswrite> function (or vice versa):
4489
4490     require 'syscall.ph';               # may need to run h2ph
4491     $s = "hi there\n";
4492     syscall(&SYS_write, fileno(STDOUT), $s, length $s);
4493
4494 Note that Perl supports passing of up to only 14 arguments to your system call,
4495 which in practice should usually suffice.
4496
4497 Syscall returns whatever value returned by the system call it calls.
4498 If the system call fails, C<syscall> returns C<-1> and sets C<$!> (errno).
4499 Note that some system calls can legitimately return C<-1>.  The proper
4500 way to handle such calls is to assign C<$!=0;> before the call and
4501 check the value of C<$!> if syscall returns C<-1>.
4502
4503 There's a problem with C<syscall(&SYS_pipe)>: it returns the file
4504 number of the read end of the pipe it creates.  There is no way
4505 to retrieve the file number of the other end.  You can avoid this 
4506 problem by using C<pipe> instead.
4507
4508 =item sysopen FILEHANDLE,FILENAME,MODE
4509
4510 =item sysopen FILEHANDLE,FILENAME,MODE,PERMS
4511
4512 Opens the file whose filename is given by FILENAME, and associates it
4513 with FILEHANDLE.  If FILEHANDLE is an expression, its value is used as
4514 the name of the real filehandle wanted.  This function calls the
4515 underlying operating system's C<open> function with the parameters
4516 FILENAME, MODE, PERMS.
4517
4518 The possible values and flag bits of the MODE parameter are
4519 system-dependent; they are available via the standard module C<Fcntl>.
4520 See the documentation of your operating system's C<open> to see which
4521 values and flag bits are available.  You may combine several flags
4522 using the C<|>-operator.
4523
4524 Some of the most common values are C<O_RDONLY> for opening the file in
4525 read-only mode, C<O_WRONLY> for opening the file in write-only mode,
4526 and C<O_RDWR> for opening the file in read-write mode, and.
4527
4528 For historical reasons, some values work on almost every system
4529 supported by perl: zero means read-only, one means write-only, and two
4530 means read/write.  We know that these values do I<not> work under
4531 OS/390 & VM/ESA Unix and on the Macintosh; you probably don't want to
4532 se them in new code, use thhe constants discussed in the preceding
4533 paragraph.
4534
4535 If the file named by FILENAME does not exist and the C<open> call creates
4536 it (typically because MODE includes the C<O_CREAT> flag), then the value of
4537 PERMS specifies the permissions of the newly created file.  If you omit
4538 the PERMS argument to C<sysopen>, Perl uses the octal value C<0666>.
4539 These permission values need to be in octal, and are modified by your
4540 process's current C<umask>.
4541
4542 In many systems the C<O_EXCL> flag is available for opening files in
4543 exclusive mode.  This is B<not> locking: exclusiveness means here that
4544 if the file already exists, sysopen() fails.  The C<O_EXCL> wins
4545 C<O_TRUNC>.
4546
4547 Sometimes you may want to truncate an already-existing file: C<O_TRUNC>.
4548
4549 You should seldom if ever use C<0644> as argument to C<sysopen>, because
4550 that takes away the user's option to have a more permissive umask.
4551 Better to omit it.  See the perlfunc(1) entry on C<umask> for more
4552 on this.
4553
4554 See L<perlopentut> for a kinder, gentler explanation of opening files.
4555
4556 =item sysread FILEHANDLE,SCALAR,LENGTH,OFFSET
4557
4558 =item sysread FILEHANDLE,SCALAR,LENGTH
4559
4560 Attempts to read LENGTH bytes of data into variable SCALAR from the
4561 specified FILEHANDLE, using the system call read(2).  It bypasses stdio,
4562 so mixing this with other kinds of reads, C<print>, C<write>,
4563 C<seek>, C<tell>, or C<eof> can cause confusion because stdio
4564 usually buffers data.  Returns the number of bytes actually read, C<0>
4565 at end of file, or undef if there was an error.  SCALAR will be grown or
4566 shrunk so that the last byte actually read is the last byte of the
4567 scalar after the read.
4568
4569 An OFFSET may be specified to place the read data at some place in the
4570 string other than the beginning.  A negative OFFSET specifies
4571 placement at that many bytes counting backwards from the end of the
4572 string.  A positive OFFSET greater than the length of SCALAR results
4573 in the string being padded to the required size with C<"\0"> bytes before
4574 the result of the read is appended.
4575
4576 There is no syseof() function, which is ok, since eof() doesn't work
4577 very well on device files (like ttys) anyway.  Use sysread() and check
4578 for a return value for 0 to decide whether you're done.
4579
4580 =item sysseek FILEHANDLE,POSITION,WHENCE
4581
4582 Sets FILEHANDLE's system position using the system call lseek(2).  It
4583 bypasses stdio, so mixing this with reads (other than C<sysread>),
4584 C<print>, C<write>, C<seek>, C<tell>, or C<eof> may cause confusion.
4585 FILEHANDLE may be an expression whose value gives the name of the
4586 filehandle.  The values for WHENCE are C<0> to set the new position to
4587 POSITION, C<1> to set the it to the current position plus POSITION,
4588 and C<2> to set it to EOF plus POSITION (typically negative).  For
4589 WHENCE, you may also use the constants C<SEEK_SET>, C<SEEK_CUR>, and
4590 C<SEEK_END> (start of the file, current position, end of the file)
4591 from any of the modules Fcntl, C<IO::Seekable>, or POSIX.
4592
4593 Returns the new position, or the undefined value on failure.  A position
4594 of zero is returned as the string C<"0 but true">; thus C<sysseek> returns
4595 true on success and false on failure, yet you can still easily determine
4596 the new position.
4597
4598 =item system LIST
4599
4600 =item system PROGRAM LIST
4601
4602 Does exactly the same thing as C<exec LIST>, except that a fork is
4603 done first, and the parent process waits for the child process to
4604 complete.  Note that argument processing varies depending on the
4605 number of arguments.  If there is more than one argument in LIST,
4606 or if LIST is an array with more than one value, starts the program
4607 given by the first element of the list with arguments given by the
4608 rest of the list.  If there is only one scalar argument, the argument
4609 is checked for shell metacharacters, and if there are any, the
4610 entire argument is passed to the system's command shell for parsing
4611 (this is C</bin/sh -c> on Unix platforms, but varies on other
4612 platforms).  If there are no shell metacharacters in the argument,
4613 it is split into words and passed directly to C<execvp>, which is
4614 more efficient.
4615
4616 All files opened for output are flushed before attempting the exec().
4617
4618 The return value is the exit status of the program as
4619 returned by the C<wait> call.  To get the actual exit value divide by
4620 256.  See also L</exec>.  This is I<not> what you want to use to capture
4621 the output from a command, for that you should use merely backticks or
4622 C<qx//>, as described in L<perlop/"`STRING`">.  Return value of -1
4623 indicates a failure to start the program (inspect $! for the reason).
4624
4625 Like C<exec>, C<system> allows you to lie to a program about its name if
4626 you use the C<system PROGRAM LIST> syntax.  Again, see L</exec>.
4627
4628 Because C<system> and backticks block C<SIGINT> and C<SIGQUIT>, killing the
4629 program they're running doesn't actually interrupt your program.
4630
4631     @args = ("command", "arg1", "arg2");
4632     system(@args) == 0
4633          or die "system @args failed: $?"
4634
4635 You can check all the failure possibilities by inspecting
4636 C<$?> like this:
4637
4638     $exit_value  = $? >> 8;
4639     $signal_num  = $? & 127;