X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperlfunc.pod;h=67c305ca6bc727253bc0356ea0caa9f30e1e8194;hb=03d70c897754d6af90de9d0ffe2857d000d6f2d7;hp=ca14939c6d62fb4293bda37f5f5fa99b22a7e069;hpb=ac634a9a38fe527f538270bb24c9a19cd88f5947;p=p5sagit%2Fp5-mst-13.2.git
diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index ca14939..67c305c 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -96,9 +96,8 @@ than one place.
=item Functions for SCALARs or strings
C, C, C, C, C, C, C, C,
-C, C, C, C, C , C , C ,
-C, C, C, C, C , C, C,
-C
+C, C, C, C, C , C , C,
+C, C, C, C , C, C, C
=item Regular expressions and pattern matching
@@ -173,7 +172,7 @@ C, C
C, C, C, C, C,
C, C, C, C, C, C,
-C, C
+C, C, C
=item System V interprocess communication functions
@@ -201,7 +200,7 @@ C, C, C, C
=item Functions new in perl5
C, C, C, C, C, C, C,
-C, C, C, C, C, C, C, C,
+C, C, C, C, C, C, C, C,
C, C, C, C, C[, C], C, C,
C, C, C, C, C
@@ -235,8 +234,9 @@ C, C, C, C, C, C, C,
C, C, C, C, C,
C, C, C, C,
C, C, C, C, C,
-C, C, C, C, C, C,
-C, C, C, C, C, C,
+C, C, C, C,
+C, C, C, C, C,
+C, C, C, C,
C, C, C
For more information about the portability of these functions, see
@@ -301,7 +301,7 @@ X<-S>X<-b>X<-c>X<-t>X<-u>X<-g>X<-k>X<-T>X<-B>X<-M>X<-A>X<-C>
Example:
while (<>) {
- chop;
+ chomp;
next unless -f $_; # ignore specials
#...
}
@@ -398,8 +398,9 @@ on the previous timer.
For delays of finer granularity than one second, you may use Perl's
four-argument version of select() leaving the first three arguments
undefined, or you might be able to use the C interface to
-access setitimer(2) if your system supports it. The Time::HiRes module
-from CPAN may also prove useful.
+access setitimer(2) if your system supports it. The Time::HiRes
+module (from CPAN, and starting from Perl 5.8 part of the standard
+distribution) may also prove useful.
It is usually a mistake to intermix C and C calls.
(C may be internally implemented in your system with C)
@@ -474,17 +475,17 @@ representation matches the internal representation, but on some
platforms the external representation of C<\n> is made up of more than
one character.
-Mac OS and all variants of Unix use a single character to end each line
-in the external representation of text (even though that single
-character is not necessarily the same across these platforms).
-Consequently binmode() has no effect on these operating systems. In
-other systems like VMS, MS-DOS and the various flavors of MS-Windows
-your program sees a C<\n> as a simple C<\cJ>, but what's stored in text
-files are the two characters C<\cM\cJ>. That means that, if you don't
-use binmode() on these systems, C<\cM\cJ> sequences on disk will be
-converted to C<\n> on input, and any C<\n> in your program will be
-converted back to C<\cM\cJ> on output. This is what you want for text
-files, but it can be disastrous for binary files.
+Mac OS, all variants of Unix, and Stream_LF files on VMS use a single
+character to end each line in the external representation of text (even
+though that single character is CARRIAGE RETURN on Mac OS and LINE FEED
+on Unix and most VMS files). Consequently binmode() has no effect on
+these operating systems. In other systems like OS/2, DOS and the various
+flavors of MS-Windows your program sees a C<\n> as a simple C<\cJ>, but
+what's stored in text files are the two characters C<\cM\cJ>. That means
+that, if you don't use binmode() on these systems, C<\cM\cJ> sequences on
+disk will be converted to C<\n> on input, and any C<\n> in your program
+will be converted back to C<\cM\cJ> on output. This is what you want for
+text files, but it can be disastrous for binary files.
Another consequence of using binmode() (on some systems) is that
special end-of-file markers will be seen as part of the data stream.
@@ -555,7 +556,7 @@ arguments with which the subroutine was invoked.
Be aware that the optimizer might have optimized call frames away before
C had a chance to get the information. That means that C
might not return information about the call frame you expect it do, for
-C<< N > 1 >>. In particular, C<@DB::args> might have information from the
+C<< N > 1 >>. In particular, C<@DB::args> might have information from the
previous time C was called.
=item chdir EXPR
@@ -604,7 +605,7 @@ that the final record may be missing its newline. When in paragraph
mode (C<$/ = "">), it removes all trailing newlines from the string.
When in slurp mode (C<$/ = undef>) or fixed-length record mode (C<$/> is
a reference to an integer or the like, see L) chomp() won't
-remove anything.
+remove anything.
If VARIABLE is omitted, it chomps C<$_>. Example:
while (<>) {
@@ -630,23 +631,11 @@ characters removed is returned.
=item chop
Chops off the last character of a string and returns the character
-chopped. It's used primarily to remove the newline from the end of an
-input record, but is much more efficient than C because it neither
+chopped. It is much more efficient than C because it neither
scans nor copies the string. If VARIABLE is omitted, chops C<$_>.
-Example:
-
- while (<>) {
- chop; # avoid \n on last field
- @array = split(/:/);
- #...
- }
-
If VARIABLE is a hash, it chops the hash's values, but not its keys.
-You can actually chop anything that's an lvalue, including an assignment:
-
- chop($cwd = `pwd`);
- chop($answer = );
+You can actually chop anything that's an lvalue, including an assignment.
If you chop a list, each element is chopped. Only the value of the
last C is returned.
@@ -693,11 +682,11 @@ On POSIX systems, you can detect this condition this way:
Returns the character represented by that NUMBER in the character set.
For example, C is C<"A"> in either ASCII or Unicode, and
-chr(0x263a) is a Unicode smiley face. Within the scope of C,
+chr(0x263a) is a Unicode smiley face. Within the scope of C,
characters higher than 127 are encoded in Unicode; if you don't want
this, temporarily C or use C
-For the reverse, use L .
+For the reverse, use L .
See L for more about Unicode.
If NUMBER is omitted, uses C<$_>.
@@ -730,9 +719,9 @@ counter (C<$.>), while the implicit close done by C does not.
If the file handle came from a piped open C will additionally
return false if one of the other system calls involved fails or if the
program exits with non-zero status. (If the only problem was that the
-program exited non-zero C<$!> will be set to C<0>.) Closing a pipe
+program exited non-zero C<$!> will be set to C<0>.) Closing a pipe
also waits for the process executing on the pipe to complete, in case you
-want to look at the output of the pipe afterwards, and
+want to look at the output of the pipe afterwards, and
implicitly puts the exit status value of that command into C<$?>.
Prematurely closing the read end of a pipe (i.e. before the process
@@ -972,7 +961,7 @@ See also L, L, L.
Given an expression that specifies a hash element, array element, hash slice,
or array slice, deletes the specified element(s) from the hash or array.
In the case of an array, if the array elements happen to be at the end,
-the size of the array will shrink to the highest element that tests
+the size of the array will shrink to the highest element that tests
true for exists() (or 0 if no such element exists).
Returns each element so deleted or the undefined value if there was no such
@@ -1102,7 +1091,7 @@ nothing in such situations, put
as the first line of the handler (see L). Because
this promotes strange action at a distance, this counterintuitive
-behavior may be fixed in a future release.
+behavior may be fixed in a future release.
=item do BLOCK
@@ -1129,7 +1118,7 @@ from a Perl subroutine library.
is just like
- scalar eval `cat stat.pl`;
+ eval `cat stat.pl`;
except that it's more efficient and concise, keeps track of the current
filename for error messages, searches the @INC libraries, and updates
@@ -1152,9 +1141,9 @@ and raise an exception if there's a problem.
You might like to use C to read in a program configuration
file. Manual error checking can be done this way:
- # read in config files: system first, then user
+ # read in config files: system first, then user
for $file ("/share/prog/defaults.rc",
- "$ENV{HOME}/.someprogrc")
+ "$ENV{HOME}/.someprogrc")
{
unless ($return = do $file) {
warn "couldn't parse $file: $@" if $@;
@@ -1179,7 +1168,7 @@ If C is omitted, restarts the program from the top.
B: Any files opened at the time of the dump will I
be open any more when the program is reincarnated, with possible
-resulting confusion on the part of Perl.
+resulting confusion on the part of Perl.
This function is now largely obsolete, partly because it's very
hard to convert a core file into an executable, and because the
@@ -1191,7 +1180,7 @@ generating bytecode or native C code as described in L. If
you're just trying to accelerate a CGI script, consider using the
C extension to B, or the CPAN module, Fast::CGI.
You might also consider autoloading or selfloading, which at least
-make your program I to run faster.
+make your program I to run faster.
=item each HASH
@@ -1258,7 +1247,7 @@ last file. Examples:
# reset line numbering on each input file
while (<>) {
- next if /^\s*#/; # skip comments
+ next if /^\s*#/; # skip comments
print "$.\t$_";
} continue {
close ARGV if eof; # Not eof()!
@@ -1412,7 +1401,7 @@ the argument is checked for shell metacharacters, and if there are any,
the entire argument is passed to the system's command shell for parsing
(this is C on Unix platforms, but varies on other platforms).
If there are no shell metacharacters in the argument, it is split into
-words and passed directly to C, which is more efficient.
+words and passed directly to C, which is more efficient.
Examples:
exec '/bin/echo', 'Your arguments are: ', @ARGV;
@@ -1554,7 +1543,7 @@ See L for details.
=item exp
-Returns I (the natural logarithm base) to the power of EXPR.
+Returns I (the natural logarithm base) to the power of EXPR.
If EXPR is omitted, gives C.
=item fcntl FILEHANDLE,FUNCTION,SCALAR
@@ -1564,7 +1553,7 @@ Implements the fcntl(2) function. You'll probably have to say
use Fcntl;
first to get the correct constant definitions. Argument processing and
-value return works just like C below.
+value return works just like C below.
For example:
use Fcntl;
@@ -1589,12 +1578,16 @@ bitmaps for C and low-level POSIX tty-handling operations.
If FILEHANDLE is an expression, the value is taken as an indirect
filehandle, generally its name.
-You can use this to find out whether two handles refer to the
+You can use this to find out whether two handles refer to the
same underlying descriptor:
if (fileno(THIS) == fileno(THAT)) {
print "THIS and THAT are dups\n";
- }
+ }
+
+(Filehandles connected to memory objects via new features of C may
+return undefined even though they are open.)
+
=item flock FILEHANDLE,OPERATION
@@ -1958,8 +1951,8 @@ for each field. For example:
use User::pwent;
$is_his = (stat($filename)->uid == pwent($whoever)->uid);
-Even though it looks like they're the same method calls (uid),
-they aren't, because a C object is different from
+Even though it looks like they're the same method calls (uid),
+they aren't, because a C object is different from
a C object.
=item getsockname SOCKET
@@ -1971,7 +1964,7 @@ IPs that the connection might have come in on.
use Socket;
$mysockaddr = getsockname(SOCK);
($port, $myaddr) = sockaddr_in($mysockaddr);
- printf "Connect to %s [%s]\n",
+ printf "Connect to %s [%s]\n",
scalar gethostbyaddr($myaddr, AF_INET),
inet_ntoa($myaddr);
@@ -1998,7 +1991,7 @@ Converts a time as returned by the time function to a 8-element list
with the time localized for the standard Greenwich time zone.
Typically used as follows:
- # 0 1 2 3 4 5 6 7
+ # 0 1 2 3 4 5 6 7
($sec,$min,$hour,$mday,$mon,$year,$wday,$yday) =
gmtime(time);
@@ -2009,7 +2002,7 @@ itself, in the range C<0..11> with 0 indicating January and 11
indicating December. $year is the number of years since 1900. That
is, $year is C<123> in year 2023. $wday is the day of the week, with
0 indicating Sunday and 3 indicating Wednesday. $yday is the day of
-the year, in the range C<0..364> (or C<0..365> in leap years.)
+the year, in the range C<0..364> (or C<0..365> in leap years.)
Note that the $year element is I simply the last two digits of
the year. If you assume it is, then you create non-Y2K-compliant
@@ -2131,7 +2124,7 @@ integer overflow trigger a warning.
There is no builtin C function. It is just an ordinary
method (subroutine) defined (or inherited) by modules that wish to export
names to another module. The C function calls the C method
-for the package used. See also L , L, and L.
+for the package used. See also L, L, and L.
=item index STR,SUBSTR,POSITION
@@ -2175,7 +2168,7 @@ has no string value but does have a numeric value, that value will be
passed rather than a pointer to the string value. To guarantee this to be
true, add a C<0> to the scalar before using it.) The C and C
functions may be needed to manipulate the values of structures used by
-C.
+C.
The return value of C (and C) is as follows:
@@ -2230,7 +2223,7 @@ Here is yet another way to print your environment:
@keys = keys %ENV;
@values = values %ENV;
- while (@keys) {
+ while (@keys) {
print pop(@keys), '=', pop(@values), "\n";
}
@@ -2338,24 +2331,25 @@ If EXPR is omitted, uses C<$_>.
=item length
Returns the length in characters of the value of EXPR. If EXPR is
-omitted, returns length of C<$_>. Note that this cannot be used on
+omitted, returns length of C<$_>. Note that this cannot be used on
an entire array or hash to find out how many elements these have.
For that, use C and C respectively.
=item link OLDFILE,NEWFILE
Creates a new filename linked to the old filename. Returns true for
-success, false otherwise.
+success, false otherwise.
=item listen SOCKET,QUEUESIZE
Does the same thing that the listen system call does. Returns true if
-it succeeded, false otherwise. See the example in L.
+it succeeded, false otherwise. See the example in
+L.
=item local EXPR
You really probably want to be using C instead, because C isn't
-what most people think of as "local". See
+what most people think of as "local". See
L for details.
A local modifies the listed variables to be local to the enclosing
@@ -2440,7 +2434,7 @@ divided by the natural log of N. For example:
sub log10 {
my $n = shift;
return log($n)/log(10);
- }
+ }
See also L for the inverse operation.
@@ -2504,7 +2498,7 @@ such as using a unary C<+> to give perl some help:
%hash = map { ("\L$_", 1) } @array # this also works
%hash = map { lc($_), 1 } @array # as does this.
%hash = map +( lc($_), 1 ), @array # this is EXPR and works!
-
+
%hash = map ( lc($_), 1 ), @array # evaluates to (1, @array)
or to force an anon hash constructor use C<+{>
@@ -2635,15 +2629,18 @@ to be converted into a file mode, for example. (Although perl will
automatically convert strings into numbers as needed, this automatic
conversion assumes base 10.)
-=item open FILEHANDLE,MODE,LIST
-
=item open FILEHANDLE,EXPR
+=item open FILEHANDLE,MODE,EXPR
+
+=item open FILEHANDLE,MODE,EXPR,LIST
+
=item open FILEHANDLE
Opens the file whose filename is given by EXPR, and associates it with
-FILEHANDLE. If FILEHANDLE is an expression, its value is used as the
-name of the real filehandle wanted. (This is considered a symbolic
+FILEHANDLE. If FILEHANDLE is an undefined lexical (C) variable the variable is
+assigned a reference to a new anonymous filehandle, otherwise if FILEHANDLE is an expression,
+its value is used as the name of the real filehandle wanted. (This is considered a symbolic
reference, so C should I be in effect.)
If EXPR is omitted, the scalar
@@ -2653,10 +2650,11 @@ for this purpose; so if you're using C, specify EXPR in your call
to open.) See L for a kinder, gentler explanation of opening
files.
-If MODE is C<< '<' >> or nothing, the file is opened for input.
+If three or more arguments are specified then the mode of opening and the file name
+are separate. If MODE is C<< '<' >> or nothing, the file is opened for input.
If MODE is C<< '>' >>, the file is truncated and opened for
output, being created if necessary. If MODE is C<<< '>>' >>>,
-the file is opened for appending, again being created if necessary.
+the file is opened for appending, again being created if necessary.
You can put a C<'+'> in front of the C<< '>' >> or C<< '<' >> to indicate that
you want both read and write access to the file; thus C<< '+<' >> is almost
always preferred for read/write updates--the C<< '+>' >> mode would clobber the
@@ -2670,7 +2668,8 @@ C<'w'>, C<'w+'>, C<'a'>, and C<'a+'>.
In the 2-arguments (and 1-argument) form of the call the mode and
filename should be concatenated (in this order), possibly separated by
-spaces. It is possible to omit the mode if the mode is C<< '<' >>.
+spaces. It is possible to omit the mode in these forms if the mode is
+C<< '<' >>.
If the filename begins with C<'|'>, the filename is interpreted as a
command to which output is to be piped, and if the filename ends with a
@@ -2681,17 +2680,21 @@ that pipes both in I out, but see L, L,
and L
for alternatives.)
-If MODE is C<'|-'>, the filename is interpreted as a
+For three or more arguments if MODE is C<'|-'>, the filename is interpreted as a
command to which output is to be piped, and if MODE is
C<'-|'>, the filename is interpreted as a command which pipes output to
us. In the 2-arguments (and 1-argument) form one should replace dash
(C<'-'>) with the command. See L
for more examples of this. (You are not allowed to C to a command
that pipes both in I out, but see L, L,
-and L for alternatives.)
+and L for alternatives.) In 3+ arg form of
+pipe opens then if LIST is specified (extra arguments after the command name) then
+LIST becomes arguments to the command invoked if the platform supports it.
+The meaning of C with more than three arguments for non-pipe modes
+is not yet specified. Experimental "layers" may give extra LIST arguments meaning.
In the 2-arguments (and 1-argument) form opening C<'-'> opens STDIN
-and opening C<< '>-' >> opens STDOUT.
+and opening C<< '>-' >> opens STDOUT.
Open returns
nonzero upon success, the undefined value otherwise. If the C
@@ -2706,6 +2709,10 @@ and those that don't is their text file formats. Systems like Unix, MacOS, and
Plan9, which delimit lines with a single character, and which encode that
character in C as C<"\n">, do not need C. The rest need it.
+In the three argument form MODE may also contain a list of IO "layers" (see L and
+L for more details) to be applied to the handle. This can be used to achieve the
+effect of C as well as more complex behaviours.
+
When opening a file, it's usually a bad idea to continue normal execution
if the request failed, so C is frequently used in connection with
C. Even if C won't do what you want (say, in a CGI script,
@@ -2714,6 +2721,14 @@ modules that can help with that problem)) you should always check
the return value from opening a file. The infrequent exception is when
working with an unopened filehandle is actually what you want to do.
+As a special case the 3 arg form with a read/write mode and the third argument
+being C:
+
+ open(TMP, "+>", undef) or die ...
+
+opens a filehandle to an anonymous temporary file.
+
+
Examples:
$ARTICLE = 100;
@@ -2769,14 +2784,14 @@ duped and opened. You may use C<&> after C<< > >>, C<<< >> >>>,
C<< < >>, C<< +> >>, C<<< +>> >>>, and C<< +< >>. The
mode you specify should match the mode of the original filehandle.
(Duping a filehandle does not take into account any existing contents of
-stdio buffers.) Duping file handles is not yet supported for 3-argument
-open().
+stdio buffers.) If you use the 3 arg form then you can pass either a number,
+the name of a filehandle or the normal "reference to a glob".
Here is a script that saves, redirects, and restores STDOUT and
STDERR:
#!/usr/bin/perl
- open(OLDOUT, ">&STDOUT");
+ open(my $oldout, ">&", \*STDOUT);
open(OLDERR, ">&STDERR");
open(STDOUT, '>', "foo.out") || die "Can't redirect stdout";
@@ -2797,17 +2812,24 @@ STDERR:
print STDOUT "stdout 2\n";
print STDERR "stderr 2\n";
-If you specify C<< '<&=N' >>, where C is a number, then Perl will do an
-equivalent of C's C of that file descriptor; this is more
-parsimonious of file descriptors. For example:
+If you specify C<< '<&=N' >>, where C is a number, then Perl will
+do an equivalent of C's C of that file descriptor; this is
+more parsimonious of file descriptors. For example:
open(FILEHANDLE, "<&=$fd")
-Note that this feature depends on the fdopen() C library function.
-On many UNIX systems, fdopen() is known to fail when file descriptors
+or
+
+ open(FILEHANDLE, "<&=", $fd)
+
+Note that if Perl is using the standard C libraries' fdopen() then on
+many UNIX systems, fdopen() is known to fail when file descriptors
exceed a certain value, typically 255. If you need more file
-descriptors than that, consider rebuilding Perl to use the C
-library.
+descriptors than that, consider rebuilding Perl to use the C.
+
+You can see whether Perl has been compiled with PerlIO or not by
+running C and looking for C line. If C
+is C, you have PerlIO, otherwise you don't.
If you open a pipe on the command C<'-'>, i.e., either C<'|-'> or C<'-|'>
with 2-arguments (or 1-argument) form of open(), then
@@ -2826,10 +2848,15 @@ The following triples are more or less equivalent:
open(FOO, "|tr '[a-z]' '[A-Z]'");
open(FOO, '|-', "tr '[a-z]' '[A-Z]'");
open(FOO, '|-') || exec 'tr', '[a-z]', '[A-Z]';
+ open(FOO, '|-', "tr", '[a-z]', '[A-Z]');
open(FOO, "cat -n '$file'|");
open(FOO, '-|', "cat -n '$file'");
open(FOO, '-|') || exec 'cat', '-n', $file;
+ open(FOO, '-|', "cat", '-n', $file);
+
+The last example in each block shows the pipe as "list form", which is
+not yet supported on all platforms.
See L for more examples of this.
@@ -2849,7 +2876,7 @@ child to finish, and returns the status value in C<$?>.
The filename passed to 2-argument (or 1-argument) form of open()
will have leading and trailing
whitespace deleted, and the normal redirection characters
-honored. This property, known as "magic open",
+honored. This property, known as "magic open",
can often be used to good effect. A user could specify a filename of
F<"rsh cat file |">, or you could change certain filenames as needed:
@@ -2928,6 +2955,8 @@ See L for more about Unicode.
=item our EXPR
+=item our EXPR : ATTRIBUTES
+
An C declares the listed variables to be valid globals within
the enclosing block, file, or C. That is, it has the same
scoping rules as a "my" declaration, but does not create a local
@@ -2966,6 +2995,28 @@ package, Perl will emit warnings if you have asked for them.
our $bar; # emits warning
+An C declaration may also have a list of attributes associated
+with it. B: This is an experimental feature that may be
+changed or removed in future releases of Perl. It should not be
+relied upon.
+
+The only currently recognized attribute is C which indicates
+that a single copy of the global is to be used by all interpreters
+should the program happen to be running in a multi-interpreter
+environment. (The default behaviour would be for each interpreter to
+have its own copy of the global.) In such an environment, this
+attribute also has the effect of making the global readonly.
+Examples:
+
+ our @EXPORT : shared = qw(foo);
+ our %EXPORT_TAGS : shared = (bar => [qw(aa bb cc)]);
+ our $VERSION : shared = "1.00";
+
+Multi-interpreter environments can come to being either through the
+fork() emulation on Windows platforms, or by embedding perl in a
+multi-threaded application. The C attribute does nothing in
+all other environments.
+
=item pack TEMPLATE,LIST
Takes a LIST of values and converts it into a string using the rules
@@ -3189,14 +3240,14 @@ L:
print $Config{longlongsize}, "\n";
(The C<$Config{longlongsize}> will be undefine if your system does
-not support long longs.)
+not support long longs.)
=item *
The integer formats C, C, C, C, C, and C
are inherently non-portable between processors and operating systems
because they obey the native byteorder and endianness. For example a
-4-byte integer 0x12345678 (305419896 decimal) be ordered natively
+4-byte integer 0x12345678 (305419896 decimal) would be ordered natively
(arranged in and handled by the CPU registers) into bytes as
0x12 0x34 0x56 0x78 # big-endian
@@ -3205,7 +3256,8 @@ because they obey the native byteorder and endianness. For example a
Basically, the Intel and VAX CPUs are little-endian, while everybody
else, for example Motorola m68k/88k, PPC, Sparc, HP PA, Power, and
Cray are big-endian. Alpha and MIPS can be either: Digital/Compaq
-used/uses them in little-endian mode; SGI/Cray uses them in big-endian mode.
+used/uses them in little-endian mode; SGI/Cray uses them in big-endian
+mode.
The names `big-endian' and `little-endian' are comic references to
the classic "Gulliver's Travels" (via the paper "On Holy Wars and a
@@ -3232,7 +3284,7 @@ Byteorders C<'1234'> and C<'12345678'> are little-endian, C<'4321'>
and C<'87654321'> are big-endian.
If you want portable packed integers use the formats C, C,
-C, and C, their byte endianness and size is known.
+C, and C, their byte endianness and size are known.
See also L.
=item *
@@ -3333,7 +3385,7 @@ The same template may generally also be used in unpack().
=item package NAMESPACE
-=item package
+=item package
Declares the compilation unit as being in the given namespace. The scope
of the package declaration is from the declaration itself through the end
@@ -3475,12 +3527,10 @@ but is more efficient. Returns the new number of elements in the array.
=item qr/STRING/
-=item qu/STRING/
+=item qx/STRING/
=item qw/STRING/
-=item qx/STRING/
-
Generalized quotes. See L.
=item quotemeta EXPR
@@ -3502,8 +3552,15 @@ If EXPR is omitted, uses C<$_>.
Returns a random fractional number greater than or equal to C<0> and less
than the value of EXPR. (EXPR should be positive.) If EXPR is
-omitted, the value C<1> is used. Automatically calls C unless
-C has already been called. See also C.
+omitted, or a C<0>, the value C<1> is used. Automatically calls C
+unless C has already been called. See also C.
+
+Apply C to the value returned by C if you want random
+integers instead of random fractional numbers. For example,
+
+ int(rand(10))
+
+returns a random integer between C<0> and C<9>, inclusive.
(Note: If your rand function consistently returns numbers that are too
large or too small, then your version of Perl was probably compiled
@@ -3654,7 +3711,7 @@ name is returned instead. You can think of C[ as a C] operator.
}
if (UNIVERSAL::isa($r, "HASH")) { # for subclassing
print "r is a reference to something that isa hash.\n";
- }
+ }
See also L.
@@ -3730,9 +3787,9 @@ modules does not risk altering your namespace.
In other words, if you try this:
- require Foo::Bar; # a splendid bareword
+ require Foo::Bar; # a splendid bareword
-The require function will actually look for the "F" file in the
+The require function will actually look for the "F" file in the
directories specified in the C<@INC> array.
But if you try this:
@@ -3742,7 +3799,7 @@ But if you try this:
#or
require "Foo::Bar"; # not a bareword because of the ""
-The require function will look for the "F" file in the @INC array and
+The require function will look for the "F" file in the @INC array and
will complain about not finding "F" there. In this case you can do:
eval "require $class";
@@ -3776,7 +3833,7 @@ See L .
=item return
-Returns from a subroutine, C, or C with the value
+Returns from a subroutine, C, or C with the value
given in EXPR. Evaluation of EXPR may be in list, scalar, or void
context, depending on how the return value will be used, and the context
may vary from one execution to the next (see C). If no EXPR
@@ -4113,7 +4170,7 @@ has the same interpretation as in the system call of the same name.
This is useful with sockets when you want to tell the other
side you're done writing but not done reading, or vice versa.
-It's also a more insistent form of close because it also
+It's also a more insistent form of close because it also
disables the file descriptor in any forked copies in other
processes.
@@ -4147,11 +4204,32 @@ busy multitasking system.
For delays of finer granularity than one second, you may use Perl's
C interface to access setitimer(2) if your system supports
-it, or else see L above. The Time::HiRes module from CPAN
-may also help.
+it, or else see L above. The Time::HiRes module (from CPAN,
+and starting from Perl 5.8 part of the standard distribution) may also
+help.
See also the POSIX module's C function.
+=item sockatmark SOCKET
+
+Returns true if the socket is positioned at the out-of-band mark
+(also known as the urgent data mark), false otherwise. Use right
+after reading from the socket.
+
+Not available directly, one has to import the function from
+the IO::Socket extension
+
+ use IO::Socket 'sockatmark';
+
+Even this doesn't guarantee that sockatmark() really is available,
+though, because sockatmark() is a relatively recent addition to
+the family of socket functions. If it is unavailable, attempt to
+use it will fail
+
+ IO::Socket::atmark not implemented on this architecture ...
+
+See also L.
+
=item socket SOCKET,DOMAIN,TYPE,PROTOCOL
Opens a socket of the specified kind and attaches it to filehandle
@@ -4219,6 +4297,12 @@ loop control operators described in L or with C.
When C is in effect, C sorts LIST according to the
current collation locale. See L.
+Perl does B guarantee that sort is stable. (A I sort
+preserves the input order of elements that compare equal.) 5.7 and
+5.8 happen to use a stable mergesort, but 5.6 and earlier used quicksort,
+which is not stable. Do not assume that future perls will continue to
+use a stable sort.
+
Examples:
# sort lexically
@@ -4375,11 +4459,15 @@ splits on whitespace (after skipping any leading whitespace). Anything
matching PATTERN is taken to be a delimiter separating the fields. (Note
that the delimiter may be longer than one character.)
-If LIMIT is specified and positive, splits into no more than that
-many fields (though it may split into fewer). If LIMIT is unspecified
-or zero, trailing null fields are stripped (which potential users
-of C would do well to remember). If LIMIT is negative, it is
-treated as if an arbitrarily large LIMIT had been specified.
+If LIMIT is specified and positive, it represents the maximum number
+of fields the EXPR will be split into, though the actual number of
+fields returned depends on the number of times PATTERN matches within
+EXPR. If LIMIT is unspecified or zero, trailing null fields are
+stripped (which potential users of C would do well to remember).
+If LIMIT is negative, it is treated as if an arbitrarily large LIMIT
+had been specified. Note that splitting an EXPR that evaluates to the
+empty string always returns the empty list, regardless of the LIMIT
+specified.
A pattern matching the null string (not to be confused with
a null pattern C/>, which is just one member of the set of patterns
@@ -4443,13 +4531,12 @@ Example:
open(PASSWD, '/etc/passwd');
while () {
- ($login, $passwd, $uid, $gid,
+ chomp;
+ ($login, $passwd, $uid, $gid,
$gcos, $home, $shell) = split(/:/);
#...
}
-(Note that $shell above will still have a newline on it. See L ,
-L , and L.)
=item sprintf FORMAT, LIST
@@ -4499,7 +4586,7 @@ In addition, Perl permits the following widely-supported conversions:
%b an unsigned integer, in binary
%p a pointer (outputs the Perl value's address in hexadecimal)
%n special: *stores* the number of characters output so far
- into the next variable in the parameter list
+ into the next variable in the parameter list
Finally, for backward (and we do mean "backward") compatibility, Perl
permits these unnecessary but widely-supported conversions:
@@ -4714,7 +4801,7 @@ last stat or filetest are returned. Example:
under NFS.)
Because the mode contains both the file type and its permissions, you
-should mask off the file type portion and (s)printf using a C<"%o">
+should mask off the file type portion and (s)printf using a C<"%o">
if you want to see the real permissions.
$mode = (stat($filename))[2];
@@ -4728,7 +4815,7 @@ The File::stat module provides a convenient, by-name access mechanism:
use File::stat;
$sb = stat($filename);
- printf "File is %s, size is %s, perm %04o, mtime %s\n",
+ printf "File is %s, size is %s, perm %04o, mtime %s\n",
$filename, $sb->size, $sb->mode & 07777,
scalar localtime $sb->mtime;
@@ -4775,7 +4862,7 @@ and the S_IF* functions are
and the setuid/setgid/sticky bits
S_IFMT($mode) the part of $mode containing the file type
- which can be bit-anded with e.g. S_IFREG
+ which can be bit-anded with e.g. S_IFREG
or with the following functions
# The operators -f, -d, -l, -b, -c, -p, and -s.
@@ -4940,7 +5027,7 @@ check the value of C<$!> if syscall returns C<-1>.
There's a problem with C: it returns the file
number of the read end of the pipe it creates. There is no way
-to retrieve the file number of the other end. You can avoid this
+to retrieve the file number of the other end. You can avoid this
problem by using C instead.
=item sysopen FILEHANDLE,FILENAME,MODE
@@ -5117,7 +5204,7 @@ case the SCALAR is empty you can use OFFSET but only zero offset.
Returns the current position for FILEHANDLE, or -1 on error. FILEHANDLE
may be an expression whose value gives the name of the actual filehandle.
-If FILEHANDLE is omitted, assumes the file last read.
+If FILEHANDLE is omitted, assumes the file last read.
The return value of tell() for the standard streams like the STDIN
depends on the operating system: it may return -1 or something else.
@@ -5415,7 +5502,7 @@ not known to be valid is likely to have disastrous consequences.
If the repeat count of a field is larger than what the remainder of
the input string allows, repeat count is decreased. If the input string
-is longer than one described by the TEMPLATE, the rest is ignored.
+is longer than one described by the TEMPLATE, the rest is ignored.
See L for more examples and notes.
@@ -5429,7 +5516,7 @@ Does the opposite of a C. Or the opposite of a C,
depending on how you look at it. Prepends list to the front of the
array, and returns the new number of elements in the array.
- unshift(ARGV, '-e') unless $ARGV[0] =~ /^-/;
+ unshift(@ARGV, '-e') unless $ARGV[0] =~ /^-/;
Note the LIST is prepended whole, not one element at a time, so the
prepended elements stay in the same order. Use C to do the
@@ -5493,7 +5580,7 @@ If the VERSION argument is present between Module and LIST, then the
C will call the VERSION method in class Module with the given
version as an argument. The default VERSION method, inherited from
the UNIVERSAL class, croaks if the given version is larger than the
-value of the variable C<$Module::VERSION>.
+value of the variable C<$Module::VERSION>.
Again, there is a distinction between omitting LIST (C called
with no arguments) and an explicit empty LIST C<()> (C not
@@ -5541,6 +5628,13 @@ command if the files already exist:
$now = time;
utime $now, $now, @ARGV;
+If the first two elements of the list are C, then the utime(2)
+function in the C library will be called with a null second argument.
+On most systems, this will set the file's access and modification
+times to the current time. (i.e. equivalent to the example above.)
+
+ utime undef, undef, @ARGV;
+
=item values HASH
Returns a list consisting of all the values of the named hash. (In a
@@ -5568,7 +5662,7 @@ that are reserved for each element in the bit vector. This must
be a power of two from 1 to 32 (or 64, if your platform supports
that).
-If BITS is 8, "elements" coincide with bytes of the input string.
+If BITS is 8, "elements" coincide with bytes of the input string.
If BITS is 16 or more, bytes of the input string are grouped into chunks
of size BITS/8, and each group is converted to a number as with
@@ -5639,7 +5733,7 @@ Here is an example to illustrate how the bits actually fall in place:
#!/usr/bin/perl -wl
print <<'EOT';
- 0 1 2 3
+ 0 1 2 3
unpack("V",$_) 01234567890123456789012345678901
------------------------------------------------------------------
EOT
@@ -5667,7 +5761,7 @@ Here is an example to illustrate how the bits actually fall in place:
Regardless of the machine architecture on which it is run, the above
example should print the following table:
- 0 1 2 3
+ 0 1 2 3
unpack("V",$_) 01234567890123456789012345678901
------------------------------------------------------------------
vec($_, 0, 1) = 1 == 1 10000000000000000000000000000000
@@ -5816,7 +5910,7 @@ The status is returned in C<$?>. If you say
use POSIX ":sys_wait_h";
#...
- do {
+ do {
$kid = waitpid(-1,&WNOHANG);
} until $kid == -1;