X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=ext%2FPOSIX%2FPOSIX.pod;h=7263d0a62a090af23befb0133824b3d772ec23a1;hb=8565c31a574ba4f7dc8cd69b66988949074e120d;hp=147f2db989044432e1d280d3019d484bc47a2611;hpb=3609ea0df8ff1318cd5f51cdbcd9bcd6c2a3fce2;p=p5sagit%2Fp5-mst-13.2.git

diff --git a/ext/POSIX/POSIX.pod b/ext/POSIX/POSIX.pod
index 147f2db..7263d0a 100644
--- a/ext/POSIX/POSIX.pod
+++ b/ext/POSIX/POSIX.pod
@@ -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
@@ -848,7 +848,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 +857,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 +1055,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.
@@ -1130,6 +1131,35 @@ Returns C<undef> on failure.  The C<signal> must be a number (like
 SIGHUP), not a string (like "SIGHUP"), though Perl does try hard
 to understand you.
 
+If you use the SA_SIGINFO flag, the signal handler will in addition to
+the first argument, the signal name, also receive a second argument, a
+hash reference, inside which are the following keys with the following
+semantics, as defined by POSIX/SUSv3:
+
+    signo       the signal number
+    errno       the error number
+    code        if this is zero or less, the signal was sent by
+                a user process and the uid and pid make sense,
+                otherwise the signal was sent by the kernel
+
+The following are also defined by POSIX/SUSv3, but unfortunately
+not very widely implemented:
+
+    pid         the process id generating the signal
+    uid         the uid of the process id generating the signal
+    status      exit value or signal for SIGCHLD
+    band        band event for SIGPOLL
+
+A third argument is also passed to the handler, which contains a copy
+of the raw binary contents of the siginfo structure: if a system has
+some non-POSIX fields, this third argument is where to unpack() them
+from.
+
+Note that not all siginfo values make sense simultaneously (some are
+valid only for certain signals, for example), and not all values make
+sense from Perl perspective, you should to consult your system's
+C<sigaction> and possibly also C<siginfo> documentation.
+
 =item siglongjmp
 
 siglongjmp() is C-specific: use L<perlfunc/die> instead.
@@ -1220,7 +1250,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
 
@@ -1618,7 +1648,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.
 
@@ -1702,13 +1732,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).
@@ -1811,6 +1841,7 @@ Get terminal control attributes.
 
 Obtain the attributes for stdin.
 
+	$termios->getattr( 0 ) # Recommended for clarity.
 	$termios->getattr()
 
 Obtain the attributes for stdout.