Merge branch 'vincent/rvalue_stmt_given' into blead
[p5sagit/p5-mst-13.2.git] / ext / POSIX / POSIX.pod
index 78557da..64852e9 100644 (file)
@@ -125,8 +125,8 @@ and it is called thusly
                           $wday, $yday, $isdst);
 
 The C<$mon> is zero-based: January equals C<0>.  The C<$year> is
-1900-based: 2001 equals C<101>.  The C<$wday>, C<$yday>, and C<$isdst>
-default to zero (and the first two are usually ignored anyway).
+1900-based: 2001 equals C<101>.  C<$wday> and C<$yday> default to zero
+(and are usually ignored anyway), and C<$isdst> defaults to -1.
 
 =item asin
 
@@ -509,7 +509,7 @@ variable C<$(>, see L<perlvar/$EGID>.
 
 =item getenv
 
-Returns the value of the specified enironment variable.
+Returns the value of the specified environment variable.
 The same information is available through the C<%ENV> array.
 
 =item geteuid
@@ -547,7 +547,7 @@ L<perlfunc/getlogin>.
 =item getpgrp
 
 This is identical to Perl's builtin C<getpgrp()> function for
-returning the prcess group identifier of the current process, see
+returning the process group identifier of the current process, see
 L<perlfunc/getpgrp>.
 
 =item getpid
@@ -703,6 +703,14 @@ signals to processes (often to terminate them), see L<perlfunc/kill>.
 (For returning absolute values of long integers.)
 labs() is C-specific, see L<perlfunc/abs> instead.
 
+=item lchown
+
+This is identical to the C function, except the order of arguments is
+consistent with Perl's builtin C<chown()> with the added restriction
+of only one path, not an list of paths.  Does the same thing as the 
+C<chown()> function but changes the owner of a symbolic link instead 
+of the file the symbolic link points to.
+
 =item ldexp
 
 This is identical to the C function C<ldexp()>
@@ -848,7 +856,8 @@ FIFO special files.
        if (mkfifo($path, $mode)) { ....
 
 Returns C<undef> on failure.  The C<$mode> is similar to the
-mode of C<mkdir()>, see L<perlfunc/mkdir>.
+mode of C<mkdir()>, see L<perlfunc/mkdir>, though for C<mkfifo>
+you B<must> specify the C<$mode>.
 
 =item mktime
 
@@ -856,7 +865,7 @@ Convert date/time info to a calendar time.
 
 Synopsis:
 
-       mktime(sec, min, hour, mday, mon, year, wday = 0, yday = 0, isdst = 0)
+       mktime(sec, min, hour, mday, mon, year, wday = 0, yday = 0, isdst = -1)
 
 The month (C<mon>), weekday (C<wday>), and yearday (C<yday>) begin at zero.
 I.e. January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1.  The
@@ -1054,7 +1063,7 @@ see L<perlre>.
 
 Sets the real group identifier and the effective group identifier for
 this process.  Similar to assigning a value to the Perl's builtin
-C<$)> variable, see L<perlvar/$GID>, except that the latter
+C<$)> variable, see L<perlvar/$EGID>, except that the latter
 will change only the real user identifier, and that the setgid()
 uses only a single numeric argument, as opposed to a space-separated
 list of numbers.
@@ -1094,7 +1103,7 @@ Spanish. B<NOTE>: The naming and availability of locales depends on
 your operating system. Please consult L<perllocale> for how to find
 out which locales are available in your system.
 
-       $loc = setlocale( LC_ALL, "es_AR.ISO8859-1" );
+       $loc = setlocale( LC_COLLATE, "es_AR.ISO8859-1" );
 
 =item setpgid
 
@@ -1249,7 +1258,7 @@ see L<perlre>.
 =item stat
 
 This is identical to Perl's builtin C<stat()> function
-for retutning information about files and directories.
+for returning information about files and directories.
 
 =item strcat
 
@@ -1647,7 +1656,7 @@ calling C<POSIX::open>.
 
        $fd = POSIX::open( "foo", &POSIX::O_WRONLY );
        $buf = "hello";
-       $bytes = POSIX::write( $b, $buf, 5 );
+       $bytes = POSIX::write( $fd, $buf, 5 );
 
 Returns C<undef> on failure.
 
@@ -1731,13 +1740,13 @@ Setting the %SIGRT elements is equivalent to calling this:
 
   sub new {
     my ($rtsig, $handler, $flags) = @_;
-    my $sigset = POSIX:SigSet($rtsig);
+    my $sigset = POSIX::SigSet($rtsig);
     my $sigact = POSIX::SigAction->new($handler, $sigset, $flags);
     sigaction($rtsig, $sigact);
   }
 
 The flags default to zero, if you want something different you can
-either use C<local> on $POSIX::RtSig::SIGACTION_FLAGS, or you can
+either use C<local> on $POSIX::SigRt::SIGACTION_FLAGS, or you can
 derive from POSIX::SigRt and define your own C<new()> (the tied hash
 STORE method of the %SIGRT calls C<new($rtsig, $handler, $SIGACTION_FLAGS)>,
 where the $rtsig ranges from zero to SIGRTMAX - SIGRTMIN + 1).
@@ -1840,6 +1849,7 @@ Get terminal control attributes.
 
 Obtain the attributes for stdin.
 
+       $termios->getattr( 0 ) # Recommended for clarity.
        $termios->getattr()
 
 Obtain the attributes for stdout.