ext/POSIX/POSIX.pod

   1 =head1 NAME
   2
   3 POSIX - Perl interface to IEEE Std 1003.1
   4
   5 =head1 SYNOPSIS
   6
   7     use POSIX;
   8     use POSIX qw(setsid);
   9     use POSIX qw(:errno_h :fcntl_h);
  10
  11     printf "EINTR is %d\n", EINTR;
  12
  13     $sess_id = POSIX::setsid();
  14
  15     $fd = POSIX::open($path, O_CREAT|O_EXCL|O_WRONLY, 0644);
  16         # note: that's a filedescriptor, *NOT* a filehandle
  17
  18 =head1 DESCRIPTION
  19
  20 The POSIX module permits you to access all (or nearly all) the standard
  21 POSIX 1003.1 identifiers.  Many of these identifiers have been given Perl-ish
  22 interfaces.
  23
  24 I<Everything is exported by default> with the exception of any POSIX
  25 functions with the same name as a built-in Perl function, such as
  26 C<abs>, C<alarm>, C<rmdir>, C<write>, etc.., which will be exported
  27 only if you ask for them explicitly.  This is an unfortunate backwards
  28 compatibility feature.  You can stop the exporting by saying C<use
  29 POSIX ()> and then use the fully qualified names (ie. C<POSIX::SEEK_END>).
  30
  31 This document gives a condensed list of the features available in the POSIX
  32 module.  Consult your operating system's manpages for general information on
  33 most features.  Consult L<perlfunc> for functions which are noted as being
  34 identical to Perl's builtin functions.
  35
  36 The first section describes POSIX functions from the 1003.1 specification.
  37 The second section describes some classes for signal objects, TTY objects,
  38 and other miscellaneous objects.  The remaining sections list various
  39 constants and macros in an organization which roughly follows IEEE Std
  40 1003.1b-1993.
  41
  42 =head1 NOTE
  43
  44 The POSIX module is probably the most complex Perl module supplied with
  45 the standard distribution.  It incorporates autoloading, namespace games,
  46 and dynamic loading of code that's in Perl, C, or both.  It's a great
  47 source of wisdom.
  48
  49 =head1 CAVEATS
  50
  51 A few functions are not implemented because they are C specific.  If you
  52 attempt to call these, they will print a message telling you that they
  53 aren't implemented, and suggest using the Perl equivalent should one
  54 exist.  For example, trying to access the setjmp() call will elicit the
  55 message "setjmp() is C-specific: use eval {} instead".
  56
  57 Furthermore, some evil vendors will claim 1003.1 compliance, but in fact
  58 are not so: they will not pass the PCTS (POSIX Compliance Test Suites).
  59 For example, one vendor may not define EDEADLK, or the semantics of the
  60 errno values set by open(2) might not be quite right.  Perl does not
  61 attempt to verify POSIX compliance.  That means you can currently
  62 successfully say "use POSIX",  and then later in your program you find
  63 that your vendor has been lax and there's no usable ICANON macro after
  64 all.  This could be construed to be a bug.
  65
  66 =head1 FUNCTIONS
  67
  68 =over 8
  69
  70 =item _exit
  71
  72 This is identical to the C function C<_exit()>.  It exits the program
  73 immediately which means among other things buffered I/O is B<not> flushed.
  74
  75 Note that when using threads and in Linux this is B<not> a good way to
  76 exit a thread because in Linux processes and threads are kind of the
  77 same thing (Note: while this is the situation in early 2003 there are
  78 projects under way to have threads with more POSIXly semantics in Linux).
  79 If you want not to return from a thread, detach the thread.
  80
  81 =item abort
  82
  83 This is identical to the C function C<abort()>.  It terminates the
  84 process with a C<SIGABRT> signal unless caught by a signal handler or
  85 if the handler does not return normally (it e.g.  does a C<longjmp>).
  86
  87 =item abs
  88
  89 This is identical to Perl's builtin C<abs()> function, returning
  90 the absolute value of its numerical argument.
  91
  92 =item access
  93
  94 Determines the accessibility of a file.
  95
  96         if( POSIX::access( "/", &POSIX::R_OK ) ){
  97                 print "have read permission\n";
  98         }
  99
 100 Returns C<undef> on failure.  Note: do not use C<access()> for
 101 security purposes.  Between the C<access()> call and the operation
 102 you are preparing for the permissions might change: a classic
 103 I<race condition>.
 104
 105 =item acos
 106
 107 This is identical to the C function C<acos()>, returning
 108 the arcus cosine of its numerical argument.  See also L<Math::Trig>.
 109
 110 =item alarm
 111
 112 This is identical to Perl's builtin C<alarm()> function,
 113 either for arming or disarming the C<SIGARLM> timer.
 114
 115 =item asctime
 116
 117 This is identical to the C function C<asctime()>.  It returns
 118 a string of the form
 119
 120         "Fri Jun  2 18:22:13 2000\n\0"
 121
 122 and it is called thusly
 123
 124         $asctime = asctime($sec, $min, $hour, $mday, $mon, $year,
 125                            $wday, $yday, $isdst);
 126
 127 The C<$mon> is zero-based: January equals C<0>.  The C<$year> is
 128 1900-based: 2001 equals C<101>.  The C<$wday>, C<$yday>, and C<$isdst>
 129 default to zero (and the first two are usually ignored anyway).
 130
 131 =item asin
 132
 133 This is identical to the C function C<asin()>, returning
 134 the arcus sine of its numerical argument.  See also L<Math::Trig>.
 135
 136 =item assert
 137
 138 Unimplemented, but you can use L<perlfunc/die> and the L<Carp> module
 139 to achieve similar things.
 140
 141 =item atan
 142
 143 This is identical to the C function C<atan()>, returning the
 144 arcus tangent of its numerical argument.  See also L<Math::Trig>.
 145
 146 =item atan2
 147
 148 This is identical to Perl's builtin C<atan2()> function, returning
 149 the arcus tangent defined by its two numerical arguments, the I<y>
 150 coordinate and the I<x> coordinate.  See also L<Math::Trig>.
 151
 152 =item atexit
 153
 154 atexit() is C-specific: use C<END {}> instead, see L<perlsub>.
 155
 156 =item atof
 157
 158 atof() is C-specific.  Perl converts strings to numbers transparently.
 159 If you need to force a scalar to a number, add a zero to it.
 160
 161 =item atoi
 162
 163 atoi() is C-specific.  Perl converts strings to numbers transparently.
 164 If you need to force a scalar to a number, add a zero to it.
 165 If you need to have just the integer part, see L<perlfunc/int>.
 166
 167 =item atol
 168
 169 atol() is C-specific.  Perl converts strings to numbers transparently.
 170 If you need to force a scalar to a number, add a zero to it.
 171 If you need to have just the integer part, see L<perlfunc/int>.
 172
 173 =item bsearch
 174
 175 bsearch() not supplied.  For doing binary search on wordlists,
 176 see L<Search::Dict>.
 177
 178 =item calloc
 179
 180 calloc() is C-specific.  Perl does memory management transparently.
 181
 182 =item ceil
 183
 184 This is identical to the C function C<ceil()>, returning the smallest
 185 integer value greater than or equal to the given numerical argument.
 186
 187 =item chdir
 188
 189 This is identical to Perl's builtin C<chdir()> function, allowing
 190 one to change the working (default) directory, see L<perlfunc/chdir>.
 191
 192 =item chmod
 193
 194 This is identical to Perl's builtin C<chmod()> function, allowing
 195 one to change file and directory permissions, see L<perlfunc/chmod>.
 196
 197 =item chown
 198
 199 This is identical to Perl's builtin C<chown()> function, allowing one
 200 to change file and directory owners and groups, see L<perlfunc/chown>.
 201
 202 =item clearerr
 203
 204 Use the method C<IO::Handle::clearerr()> instead, to reset the error
 205 state (if any) and EOF state (if any) of the given stream.
 206
 207 =item clock
 208
 209 This is identical to the C function C<clock()>, returning the
 210 amount of spent processor time in microseconds.
 211
 212 =item close
 213
 214 Close the file.  This uses file descriptors such as those obtained by calling
 215 C<POSIX::open>.
 216
 217         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
 218         POSIX::close( $fd );
 219
 220 Returns C<undef> on failure.
 221
 222 See also L<perlfunc/close>.
 223
 224 =item closedir
 225
 226 This is identical to Perl's builtin C<closedir()> function for closing
 227 a directory handle, see L<perlfunc/closedir>.
 228
 229 =item cos
 230
 231 This is identical to Perl's builtin C<cos()> function, for returning
 232 the cosine of its numerical argument, see L<perlfunc/cos>.
 233 See also L<Math::Trig>.
 234
 235 =item cosh
 236
 237 This is identical to the C function C<cosh()>, for returning
 238 the hyperbolic cosine of its numeric argument.  See also L<Math::Trig>.
 239
 240 =item creat
 241
 242 Create a new file.  This returns a file descriptor like the ones returned by
 243 C<POSIX::open>.  Use C<POSIX::close> to close the file.
 244
 245         $fd = POSIX::creat( "foo", 0611 );
 246         POSIX::close( $fd );
 247
 248 See also L<perlfunc/sysopen> and its C<O_CREAT> flag.
 249
 250 =item ctermid
 251
 252 Generates the path name for the controlling terminal.
 253
 254         $path = POSIX::ctermid();
 255
 256 =item ctime
 257
 258 This is identical to the C function C<ctime()> and equivalent
 259 to C<asctime(localtime(...))>, see L</asctime> and L</localtime>.
 260
 261 =item cuserid
 262
 263 Get the login name of the owner of the current process.
 264
 265         $name = POSIX::cuserid();
 266
 267 =item difftime
 268
 269 This is identical to the C function C<difftime()>, for returning
 270 the time difference (in seconds) between two times (as returned
 271 by C<time()>), see L</time>.
 272
 273 =item div
 274
 275 div() is C-specific, use L<perlfunc/int> on the usual C</> division and
 276 the modulus C<%>.
 277
 278 =item dup
 279
 280 This is similar to the C function C<dup()>, for duplicating a file
 281 descriptor.
 282
 283 This uses file descriptors such as those obtained by calling
 284 C<POSIX::open>.
 285
 286 Returns C<undef> on failure.
 287
 288 =item dup2
 289
 290 This is similar to the C function C<dup2()>, for duplicating a file
 291 descriptor to an another known file descriptor.
 292
 293 This uses file descriptors such as those obtained by calling
 294 C<POSIX::open>.
 295
 296 Returns C<undef> on failure.
 297
 298 =item errno
 299
 300 Returns the value of errno.
 301
 302         $errno = POSIX::errno();
 303
 304 This identical to the numerical values of the C<$!>, see L<perlvar/$ERRNO>.
 305
 306 =item execl
 307
 308 execl() is C-specific, see L<perlfunc/exec>.
 309
 310 =item execle
 311
 312 execle() is C-specific, see L<perlfunc/exec>.
 313
 314 =item execlp
 315
 316 execlp() is C-specific, see L<perlfunc/exec>.
 317
 318 =item execv
 319
 320 execv() is C-specific, see L<perlfunc/exec>.
 321
 322 =item execve
 323
 324 execve() is C-specific, see L<perlfunc/exec>.
 325
 326 =item execvp
 327
 328 execvp() is C-specific, see L<perlfunc/exec>.
 329
 330 =item exit
 331
 332 This is identical to Perl's builtin C<exit()> function for exiting the
 333 program, see L<perlfunc/exit>.
 334
 335 =item exp
 336
 337 This is identical to Perl's builtin C<exp()> function for
 338 returning the exponent (I<e>-based) of the numerical argument,
 339 see L<perlfunc/exp>.
 340
 341 =item fabs
 342
 343 This is identical to Perl's builtin C<abs()> function for returning
 344 the absolute value of the numerical argument, see L<perlfunc/abs>.
 345
 346 =item fclose
 347
 348 Use method C<IO::Handle::close()> instead, or see L<perlfunc/close>.
 349
 350 =item fcntl
 351
 352 This is identical to Perl's builtin C<fcntl()> function,
 353 see L<perlfunc/fcntl>.
 354
 355 =item fdopen
 356
 357 Use method C<IO::Handle::new_from_fd()> instead, or see L<perlfunc/open>.
 358
 359 =item feof
 360
 361 Use method C<IO::Handle::eof()> instead, or see L<perlfunc/eof>.
 362
 363 =item ferror
 364
 365 Use method C<IO::Handle::error()> instead.
 366
 367 =item fflush
 368
 369 Use method C<IO::Handle::flush()> instead.
 370 See also L<perlvar/$OUTPUT_AUTOFLUSH>.
 371
 372 =item fgetc
 373
 374 Use method C<IO::Handle::getc()> instead, or see L<perlfunc/read>.
 375
 376 =item fgetpos
 377
 378 Use method C<IO::Seekable::getpos()> instead, or see L<L/seek>.
 379
 380 =item fgets
 381
 382 Use method C<IO::Handle::gets()> instead.  Similar to E<lt>E<gt>, also known
 383 as L<perlfunc/readline>.
 384
 385 =item fileno
 386
 387 Use method C<IO::Handle::fileno()> instead, or see L<perlfunc/fileno>.
 388
 389 =item floor
 390
 391 This is identical to the C function C<floor()>, returning the largest
 392 integer value less than or equal to the numerical argument.
 393
 394 =item fmod
 395
 396 This is identical to the C function C<fmod()>.
 397
 398         $r = fmod($x, $y);
 399
 400 It returns the remainder C<$r = $x - $n*$y>, where C<$n = trunc($x/$y)>.
 401 The C<$r> has the same sign as C<$x> and magnitude (absolute value)
 402 less than the magnitude of C<$y>.
 403
 404 =item fopen
 405
 406 Use method C<IO::File::open()> instead, or see L<perlfunc/open>.
 407
 408 =item fork
 409
 410 This is identical to Perl's builtin C<fork()> function
 411 for duplicating the current process, see L<perlfunc/fork>
 412 and L<perlfork> if you are in Windows.
 413
 414 =item fpathconf
 415
 416 Retrieves the value of a configurable limit on a file or directory.  This
 417 uses file descriptors such as those obtained by calling C<POSIX::open>.
 418
 419 The following will determine the maximum length of the longest allowable
 420 pathname on the filesystem which holds C</var/foo>.
 421
 422         $fd = POSIX::open( "/var/foo", &POSIX::O_RDONLY );
 423         $path_max = POSIX::fpathconf( $fd, &POSIX::_PC_PATH_MAX );
 424
 425 Returns C<undef> on failure.
 426
 427 =item fprintf
 428
 429 fprintf() is C-specific, see L<perlfunc/printf> instead.
 430
 431 =item fputc
 432
 433 fputc() is C-specific, see L<perlfunc/print> instead.
 434
 435 =item fputs
 436
 437 fputs() is C-specific, see L<perlfunc/print> instead.
 438
 439 =item fread
 440
 441 fread() is C-specific, see L<perlfunc/read> instead.
 442
 443 =item free
 444
 445 free() is C-specific.  Perl does memory management transparently.
 446
 447 =item freopen
 448
 449 freopen() is C-specific, see L<perlfunc/open> instead.
 450
 451 =item frexp
 452
 453 Return the mantissa and exponent of a floating-point number.
 454
 455         ($mantissa, $exponent) = POSIX::frexp( 1.234e56 );
 456
 457 =item fscanf
 458
 459 fscanf() is C-specific, use E<lt>E<gt> and regular expressions instead.
 460
 461 =item fseek
 462
 463 Use method C<IO::Seekable::seek()> instead, or see L<perlfunc/seek>.
 464
 465 =item fsetpos
 466
 467 Use method C<IO::Seekable::setpos()> instead, or seek L<perlfunc/seek>.
 468
 469 =item fstat
 470
 471 Get file status.  This uses file descriptors such as those obtained by
 472 calling C<POSIX::open>.  The data returned is identical to the data from
 473 Perl's builtin C<stat> function.
 474
 475         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
 476         @stats = POSIX::fstat( $fd );
 477
 478 =item fsync
 479
 480 Use method C<IO::Handle::sync()> instead.
 481
 482 =item ftell
 483
 484 Use method C<IO::Seekable::tell()> instead, or see L<perlfunc/tell>.
 485
 486 =item fwrite
 487
 488 fwrite() is C-specific, see L<perlfunc/print> instead.
 489
 490 =item getc
 491
 492 This is identical to Perl's builtin C<getc()> function,
 493 see L<perlfunc/getc>.
 494
 495 =item getchar
 496
 497 Returns one character from STDIN.  Identical to Perl's C<getc()>,
 498 see L<perlfunc/getc>.
 499
 500 =item getcwd
 501
 502 Returns the name of the current working directory.
 503 See also L<Cwd>.
 504
 505 =item getegid
 506
 507 Returns the effective group identifier.  Similar to Perl' s builtin
 508 variable C<$(>, see L<perlvar/$EGID>.
 509
 510 =item getenv
 511
 512 Returns the value of the specified environment variable.
 513 The same information is available through the C<%ENV> array.
 514
 515 =item geteuid
 516
 517 Returns the effective user identifier.  Identical to Perl's builtin C<$E<gt>>
 518 variable, see L<perlvar/$EUID>.
 519
 520 =item getgid
 521
 522 Returns the user's real group identifier.  Similar to Perl's builtin
 523 variable C<$)>, see L<perlvar/$GID>.
 524
 525 =item getgrgid
 526
 527 This is identical to Perl's builtin C<getgrgid()> function for
 528 returning group entries by group identifiers, see
 529 L<perlfunc/getgrgid>.
 530
 531 =item getgrnam
 532
 533 This is identical to Perl's builtin C<getgrnam()> function for
 534 returning group entries by group names, see L<perlfunc/getgrnam>.
 535
 536 =item getgroups
 537
 538 Returns the ids of the user's supplementary groups.  Similar to Perl's
 539 builtin variable C<$)>, see L<perlvar/$GID>.
 540
 541 =item getlogin
 542
 543 This is identical to Perl's builtin C<getlogin()> function for
 544 returning the user name associated with the current session, see
 545 L<perlfunc/getlogin>.
 546
 547 =item getpgrp
 548
 549 This is identical to Perl's builtin C<getpgrp()> function for
 550 returning the process group identifier of the current process, see
 551 L<perlfunc/getpgrp>.
 552
 553 =item getpid
 554
 555 Returns the process identifier.  Identical to Perl's builtin
 556 variable C<$$>, see L<perlvar/$PID>.
 557
 558 =item getppid
 559
 560 This is identical to Perl's builtin C<getppid()> function for
 561 returning the process identifier of the parent process of the current
 562 process , see L<perlfunc/getppid>.
 563
 564 =item getpwnam
 565
 566 This is identical to Perl's builtin C<getpwnam()> function for
 567 returning user entries by user names, see L<perlfunc/getpwnam>.
 568
 569 =item getpwuid
 570
 571 This is identical to Perl's builtin C<getpwuid()> function for
 572 returning user entries by user identifiers, see L<perlfunc/getpwuid>.
 573
 574 =item gets
 575
 576 Returns one line from C<STDIN>, similar to E<lt>E<gt>, also known
 577 as the C<readline()> function, see L<perlfunc/readline>.
 578
 579 B<NOTE>: if you have C programs that still use C<gets()>, be very
 580 afraid.  The C<gets()> function is a source of endless grief because
 581 it has no buffer overrun checks.  It should B<never> be used.  The
 582 C<fgets()> function should be preferred instead.
 583
 584 =item getuid
 585
 586 Returns the user's identifier.  Identical to Perl's builtin C<$E<lt>> variable,
 587 see L<perlvar/$UID>.
 588
 589 =item gmtime
 590
 591 This is identical to Perl's builtin C<gmtime()> function for
 592 converting seconds since the epoch to a date in Greenwich Mean Time,
 593 see L<perlfunc/gmtime>.
 594
 595 =item isalnum
 596
 597 This is identical to the C function, except that it can apply to a
 598 single character or to a whole string.  Note that locale settings may
 599 affect what characters are considered C<isalnum>.  Does not work on
 600 Unicode characters code point 256 or higher.  Consider using regular
 601 expressions and the C</[[:alnum:]]/> construct instead, or possibly
 602 the C</\w/> construct.
 603
 604 =item isalpha
 605
 606 This is identical to the C function, except that it can apply to
 607 a single character or to a whole string.  Note that locale settings
 608 may affect what characters are considered C<isalpha>.  Does not work
 609 on Unicode characters code point 256 or higher.  Consider using regular
 610 expressions and the C</[[:alpha:]]/> construct instead.
 611
 612 =item isatty
 613
 614 Returns a boolean indicating whether the specified filehandle is connected
 615 to a tty.  Similar to the C<-t> operator, see L<perlfunc/-X>.
 616
 617 =item iscntrl
 618
 619 This is identical to the C function, except that it can apply to
 620 a single character or to a whole string.  Note that locale settings
 621 may affect what characters are considered C<iscntrl>.  Does not work
 622 on Unicode characters code point 256 or higher.  Consider using regular
 623 expressions and the C</[[:cntrl:]]/> construct instead.
 624
 625 =item isdigit
 626
 627 This is identical to the C function, except that it can apply to
 628 a single character or to a whole string.  Note that locale settings
 629 may affect what characters are considered C<isdigit> (unlikely, but
 630 still possible). Does not work on Unicode characters code point 256
 631 or higher.  Consider using regular expressions and the C</[[:digit:]]/>
 632 construct instead, or the C</\d/> construct.
 633
 634 =item isgraph
 635
 636 This is identical to the C function, except that it can apply to
 637 a single character or to a whole string.  Note that locale settings
 638 may affect what characters are considered C<isgraph>.  Does not work
 639 on Unicode characters code point 256 or higher.  Consider using regular
 640 expressions and the C</[[:graph:]]/> construct instead.
 641
 642 =item islower
 643
 644 This is identical to the C function, except that it can apply to
 645 a single character or to a whole string.  Note that locale settings
 646 may affect what characters are considered C<islower>.  Does not work
 647 on Unicode characters code point 256 or higher.  Consider using regular
 648 expressions and the C</[[:lower:]]/> construct instead.  Do B<not> use
 649 C</[a-z]/>.
 650
 651 =item isprint
 652
 653 This is identical to the C function, except that it can apply to
 654 a single character or to a whole string.  Note that locale settings
 655 may affect what characters are considered C<isprint>.  Does not work
 656 on Unicode characters code point 256 or higher.  Consider using regular
 657 expressions and the C</[[:print:]]/> construct instead.
 658
 659 =item ispunct
 660
 661 This is identical to the C function, except that it can apply to
 662 a single character or to a whole string.  Note that locale settings
 663 may affect what characters are considered C<ispunct>.  Does not work
 664 on Unicode characters code point 256 or higher.  Consider using regular
 665 expressions and the C</[[:punct:]]/> construct instead.
 666
 667 =item isspace
 668
 669 This is identical to the C function, except that it can apply to
 670 a single character or to a whole string.  Note that locale settings
 671 may affect what characters are considered C<isspace>.  Does not work
 672 on Unicode characters code point 256 or higher.  Consider using regular
 673 expressions and the C</[[:space:]]/> construct instead, or the C</\s/>
 674 construct.  (Note that C</\s/> and C</[[:space:]]/> are slightly
 675 different in that C</[[:space:]]/> can normally match a vertical tab,
 676 while C</\s/> does not.)
 677
 678 =item isupper
 679
 680 This is identical to the C function, except that it can apply to
 681 a single character or to a whole string.  Note that locale settings
 682 may affect what characters are considered C<isupper>.  Does not work
 683 on Unicode characters code point 256 or higher.  Consider using regular
 684 expressions and the C</[[:upper:]]/> construct instead.  Do B<not> use
 685 C</[A-Z]/>.
 686
 687 =item isxdigit
 688
 689 This is identical to the C function, except that it can apply to a single
 690 character or to a whole string.  Note that locale settings may affect what
 691 characters are considered C<isxdigit> (unlikely, but still possible).
 692 Does not work on Unicode characters code point 256 or higher.
 693 Consider using regular expressions and the C</[[:xdigit:]]/>
 694 construct instead, or simply C</[0-9a-f]/i>.
 695
 696 =item kill
 697
 698 This is identical to Perl's builtin C<kill()> function for sending
 699 signals to processes (often to terminate them), see L<perlfunc/kill>.
 700
 701 =item labs
 702
 703 (For returning absolute values of long integers.)
 704 labs() is C-specific, see L<perlfunc/abs> instead.
 705
 706 =item ldexp
 707
 708 This is identical to the C function C<ldexp()>
 709 for multiplying floating point numbers with powers of two.
 710
 711         $x_quadrupled = POSIX::ldexp($x, 2);
 712
 713 =item ldiv
 714
 715 (For computing dividends of long integers.)
 716 ldiv() is C-specific, use C</> and C<int()> instead.
 717
 718 =item link
 719
 720 This is identical to Perl's builtin C<link()> function
 721 for creating hard links into files, see L<perlfunc/link>.
 722
 723 =item localeconv
 724
 725 Get numeric formatting information.  Returns a reference to a hash
 726 containing the current locale formatting values.
 727
 728 Here is how to query the database for the B<de> (Deutsch or German) locale.
 729
 730         $loc = POSIX::setlocale( &POSIX::LC_ALL, "de" );
 731         print "Locale = $loc\n";
 732         $lconv = POSIX::localeconv();
 733         print "decimal_point    = ", $lconv->{decimal_point},   "\n";
 734         print "thousands_sep    = ", $lconv->{thousands_sep},   "\n";
 735         print "grouping = ", $lconv->{grouping},        "\n";
 736         print "int_curr_symbol  = ", $lconv->{int_curr_symbol}, "\n";
 737         print "currency_symbol  = ", $lconv->{currency_symbol}, "\n";
 738         print "mon_decimal_point = ", $lconv->{mon_decimal_point}, "\n";
 739         print "mon_thousands_sep = ", $lconv->{mon_thousands_sep}, "\n";
 740         print "mon_grouping     = ", $lconv->{mon_grouping},    "\n";
 741         print "positive_sign    = ", $lconv->{positive_sign},   "\n";
 742         print "negative_sign    = ", $lconv->{negative_sign},   "\n";
 743         print "int_frac_digits  = ", $lconv->{int_frac_digits}, "\n";
 744         print "frac_digits      = ", $lconv->{frac_digits},     "\n";
 745         print "p_cs_precedes    = ", $lconv->{p_cs_precedes},   "\n";
 746         print "p_sep_by_space   = ", $lconv->{p_sep_by_space},  "\n";
 747         print "n_cs_precedes    = ", $lconv->{n_cs_precedes},   "\n";
 748         print "n_sep_by_space   = ", $lconv->{n_sep_by_space},  "\n";
 749         print "p_sign_posn      = ", $lconv->{p_sign_posn},     "\n";
 750         print "n_sign_posn      = ", $lconv->{n_sign_posn},     "\n";
 751
 752 =item localtime
 753
 754 This is identical to Perl's builtin C<localtime()> function for
 755 converting seconds since the epoch to a date see L<perlfunc/localtime>.
 756
 757 =item log
 758
 759 This is identical to Perl's builtin C<log()> function,
 760 returning the natural (I<e>-based) logarithm of the numerical argument,
 761 see L<perlfunc/log>.
 762
 763 =item log10
 764
 765 This is identical to the C function C<log10()>,
 766 returning the 10-base logarithm of the numerical argument.
 767 You can also use
 768
 769     sub log10 { log($_[0]) / log(10) }
 770
 771 or
 772
 773     sub log10 { log($_[0]) / 2.30258509299405 }
 774
 775 or
 776
 777     sub log10 { log($_[0]) * 0.434294481903252 }
 778
 779 =item longjmp
 780
 781 longjmp() is C-specific: use L<perlfunc/die> instead.
 782
 783 =item lseek
 784
 785 Move the file's read/write position.  This uses file descriptors such as
 786 those obtained by calling C<POSIX::open>.
 787
 788         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
 789         $off_t = POSIX::lseek( $fd, 0, &POSIX::SEEK_SET );
 790
 791 Returns C<undef> on failure.
 792
 793 =item malloc
 794
 795 malloc() is C-specific.  Perl does memory management transparently.
 796
 797 =item mblen
 798
 799 This is identical to the C function C<mblen()>.
 800 Perl does not have any support for the wide and multibyte
 801 characters of the C standards, so this might be a rather
 802 useless function.
 803
 804 =item mbstowcs
 805
 806 This is identical to the C function C<mbstowcs()>.
 807 Perl does not have any support for the wide and multibyte
 808 characters of the C standards, so this might be a rather
 809 useless function.
 810
 811 =item mbtowc
 812
 813 This is identical to the C function C<mbtowc()>.
 814 Perl does not have any support for the wide and multibyte
 815 characters of the C standards, so this might be a rather
 816 useless function.
 817
 818 =item memchr
 819
 820 memchr() is C-specific, see L<perlfunc/index> instead.
 821
 822 =item memcmp
 823
 824 memcmp() is C-specific, use C<eq> instead, see L<perlop>.
 825
 826 =item memcpy
 827
 828 memcpy() is C-specific, use C<=>, see L<perlop>, or see L<perlfunc/substr>.
 829
 830 =item memmove
 831
 832 memmove() is C-specific, use C<=>, see L<perlop>, or see L<perlfunc/substr>.
 833
 834 =item memset
 835
 836 memset() is C-specific, use C<x> instead, see L<perlop>.
 837
 838 =item mkdir
 839
 840 This is identical to Perl's builtin C<mkdir()> function
 841 for creating directories, see L<perlfunc/mkdir>.
 842
 843 =item mkfifo
 844
 845 This is similar to the C function C<mkfifo()> for creating
 846 FIFO special files.
 847
 848         if (mkfifo($path, $mode)) { ....
 849
 850 Returns C<undef> on failure.  The C<$mode> is similar to the
 851 mode of C<mkdir()>, see L<perlfunc/mkdir>.
 852
 853 =item mktime
 854
 855 Convert date/time info to a calendar time.
 856
 857 Synopsis:
 858
 859         mktime(sec, min, hour, mday, mon, year, wday = 0, yday = 0, isdst = 0)
 860
 861 The month (C<mon>), weekday (C<wday>), and yearday (C<yday>) begin at zero.
 862 I.e. January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1.  The
 863 year (C<year>) is given in years since 1900.  I.e. The year 1995 is 95; the
 864 year 2001 is 101.  Consult your system's C<mktime()> manpage for details
 865 about these and the other arguments.
 866
 867 Calendar time for December 12, 1995, at 10:30 am.
 868
 869         $time_t = POSIX::mktime( 0, 30, 10, 12, 11, 95 );
 870         print "Date = ", POSIX::ctime($time_t);
 871
 872 Returns C<undef> on failure.
 873
 874 =item modf
 875
 876 Return the integral and fractional parts of a floating-point number.
 877
 878         ($fractional, $integral) = POSIX::modf( 3.14 );
 879
 880 =item nice
 881
 882 This is similar to the C function C<nice()>, for changing
 883 the scheduling preference of the current process.  Positive
 884 arguments mean more polite process, negative values more
 885 needy process.  Normal user processes can only be more polite.
 886
 887 Returns C<undef> on failure.
 888
 889 =item offsetof
 890
 891 offsetof() is C-specific, you probably want to see L<perlfunc/pack> instead.
 892
 893 =item open
 894
 895 Open a file for reading for writing.  This returns file descriptors, not
 896 Perl filehandles.  Use C<POSIX::close> to close the file.
 897
 898 Open a file read-only with mode 0666.
 899
 900         $fd = POSIX::open( "foo" );
 901
 902 Open a file for read and write.
 903
 904         $fd = POSIX::open( "foo", &POSIX::O_RDWR );
 905
 906 Open a file for write, with truncation.
 907
 908         $fd = POSIX::open( "foo", &POSIX::O_WRONLY | &POSIX::O_TRUNC );
 909
 910 Create a new file with mode 0640.  Set up the file for writing.
 911
 912         $fd = POSIX::open( "foo", &POSIX::O_CREAT | &POSIX::O_WRONLY, 0640 );
 913
 914 Returns C<undef> on failure.
 915
 916 See also L<perlfunc/sysopen>.
 917
 918 =item opendir
 919
 920 Open a directory for reading.
 921
 922         $dir = POSIX::opendir( "/var" );
 923         @files = POSIX::readdir( $dir );
 924         POSIX::closedir( $dir );
 925
 926 Returns C<undef> on failure.
 927
 928 =item pathconf
 929
 930 Retrieves the value of a configurable limit on a file or directory.
 931
 932 The following will determine the maximum length of the longest allowable
 933 pathname on the filesystem which holds C</var>.
 934
 935         $path_max = POSIX::pathconf( "/var", &POSIX::_PC_PATH_MAX );
 936
 937 Returns C<undef> on failure.
 938
 939 =item pause
 940
 941 This is similar to the C function C<pause()>, which suspends
 942 the execution of the current process until a signal is received.
 943
 944 Returns C<undef> on failure.
 945
 946 =item perror
 947
 948 This is identical to the C function C<perror()>, which outputs to the
 949 standard error stream the specified message followed by ": " and the
 950 current error string.  Use the C<warn()> function and the C<$!>
 951 variable instead, see L<perlfunc/warn> and L<perlvar/$ERRNO>.
 952
 953 =item pipe
 954
 955 Create an interprocess channel.  This returns file descriptors like those
 956 returned by C<POSIX::open>.
 957
 958         my ($read, $write) = POSIX::pipe();
 959         POSIX::write( $write, "hello", 5 );
 960         POSIX::read( $read, $buf, 5 );
 961
 962 See also L<perlfunc/pipe>.
 963
 964 =item pow
 965
 966 Computes C<$x> raised to the power C<$exponent>.
 967
 968         $ret = POSIX::pow( $x, $exponent );
 969
 970 You can also use the C<**> operator, see L<perlop>.
 971
 972 =item printf
 973
 974 Formats and prints the specified arguments to STDOUT.
 975 See also L<perlfunc/printf>.
 976
 977 =item putc
 978
 979 putc() is C-specific, see L<perlfunc/print> instead.
 980
 981 =item putchar
 982
 983 putchar() is C-specific, see L<perlfunc/print> instead.
 984
 985 =item puts
 986
 987 puts() is C-specific, see L<perlfunc/print> instead.
 988
 989 =item qsort
 990
 991 qsort() is C-specific, see L<perlfunc/sort> instead.
 992
 993 =item raise
 994
 995 Sends the specified signal to the current process.
 996 See also L<perlfunc/kill> and the C<$$> in L<perlvar/$PID>.
 997
 998 =item rand
 999
1000 C<rand()> is non-portable, see L<perlfunc/rand> instead.
1001
1002 =item read
1003
1004 Read from a file.  This uses file descriptors such as those obtained by
1005 calling C<POSIX::open>.  If the buffer C<$buf> is not large enough for the
1006 read then Perl will extend it to make room for the request.
1007
1008         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
1009         $bytes = POSIX::read( $fd, $buf, 3 );
1010
1011 Returns C<undef> on failure.
1012
1013 See also L<perlfunc/sysread>.
1014
1015 =item readdir
1016
1017 This is identical to Perl's builtin C<readdir()> function
1018 for reading directory entries, see L<perlfunc/readdir>.
1019
1020 =item realloc
1021
1022 realloc() is C-specific.  Perl does memory management transparently.
1023
1024 =item remove
1025
1026 This is identical to Perl's builtin C<unlink()> function
1027 for removing files, see L<perlfunc/unlink>.
1028
1029 =item rename
1030
1031 This is identical to Perl's builtin C<rename()> function
1032 for renaming files, see L<perlfunc/rename>.
1033
1034 =item rewind
1035
1036 Seeks to the beginning of the file.
1037
1038 =item rewinddir
1039
1040 This is identical to Perl's builtin C<rewinddir()> function for
1041 rewinding directory entry streams, see L<perlfunc/rewinddir>.
1042
1043 =item rmdir
1044
1045 This is identical to Perl's builtin C<rmdir()> function
1046 for removing (empty) directories, see L<perlfunc/rmdir>.
1047
1048 =item scanf
1049
1050 scanf() is C-specific, use E<lt>E<gt> and regular expressions instead,
1051 see L<perlre>.
1052
1053 =item setgid
1054
1055 Sets the real group identifier and the effective group identifier for
1056 this process.  Similar to assigning a value to the Perl's builtin
1057 C<$)> variable, see L<perlvar/$GID>, except that the latter
1058 will change only the real user identifier, and that the setgid()
1059 uses only a single numeric argument, as opposed to a space-separated
1060 list of numbers.
1061
1062 =item setjmp
1063
1064 C<setjmp()> is C-specific: use C<eval {}> instead,
1065 see L<perlfunc/eval>.
1066
1067 =item setlocale
1068
1069 Modifies and queries program's locale.  The following examples assume
1070
1071         use POSIX qw(setlocale LC_ALL LC_CTYPE);
1072
1073 has been issued.
1074
1075 The following will set the traditional UNIX system locale behavior
1076 (the second argument C<"C">).
1077
1078         $loc = setlocale( LC_ALL, "C" );
1079
1080 The following will query the current LC_CTYPE category.  (No second
1081 argument means 'query'.)
1082
1083         $loc = setlocale( LC_CTYPE );
1084
1085 The following will set the LC_CTYPE behaviour according to the locale
1086 environment variables (the second argument C<"">).
1087 Please see your systems C<setlocale(3)> documentation for the locale
1088 environment variables' meaning or consult L<perllocale>.
1089
1090         $loc = setlocale( LC_CTYPE, "" );
1091
1092 The following will set the LC_COLLATE behaviour to Argentinian
1093 Spanish. B<NOTE>: The naming and availability of locales depends on
1094 your operating system. Please consult L<perllocale> for how to find
1095 out which locales are available in your system.
1096
1097         $loc = setlocale( LC_ALL, "es_AR.ISO8859-1" );
1098
1099 =item setpgid
1100
1101 This is similar to the C function C<setpgid()> for
1102 setting the process group identifier of the current process.
1103
1104 Returns C<undef> on failure.
1105
1106 =item setsid
1107
1108 This is identical to the C function C<setsid()> for
1109 setting the session identifier of the current process.
1110
1111 =item setuid
1112
1113 Sets the real user identifier and the effective user identifier for
1114 this process.  Similar to assigning a value to the Perl's builtin
1115 C<$E<lt>> variable, see L<perlvar/$UID>, except that the latter
1116 will change only the real user identifier.
1117
1118 =item sigaction
1119
1120 Detailed signal management.  This uses C<POSIX::SigAction> objects for
1121 the C<action> and C<oldaction> arguments (the oldaction can also be
1122 just a hash reference).  Consult your system's C<sigaction> manpage
1123 for details, see also C<POSIX::SigRt>.
1124
1125 Synopsis:
1126
1127         sigaction(signal, action, oldaction = 0)
1128
1129 Returns C<undef> on failure.  The C<signal> must be a number (like
1130 SIGHUP), not a string (like "SIGHUP"), though Perl does try hard
1131 to understand you.
1132
1133 If you use the SA_SIGINFO flag, the signal handler will in addition to
1134 the first argument, the signal name, also receive a second argument, a
1135 hash reference, inside which are the following keys with the following
1136 semantics, as defined by POSIX/SUSv3:
1137
1138     signo       the signal number
1139     errno       the error number
1140     code        if this is zero or less, the signal was sent by
1141                 a user process and the uid and pid make sense,
1142                 otherwise the signal was sent by the kernel
1143
1144 The following are also defined by POSIX/SUSv3, but unfortunately
1145 not very widely implemented:
1146
1147     pid         the process id generating the signal
1148     uid         the uid of the process id generating the signal
1149     status      exit value or signal for SIGCHLD
1150     band        band event for SIGPOLL
1151
1152 A third argument is also passed to the handler, which contains a copy
1153 of the raw binary contents of the siginfo structure: if a system has
1154 some non-POSIX fields, this third argument is where to unpack() them
1155 from.
1156
1157 Note that not all siginfo values make sense simultaneously (some are
1158 valid only for certain signals, for example), and not all values make
1159 sense from Perl perspective, you should to consult your system's
1160 C<sigaction> and possibly also C<siginfo> documentation.
1161
1162 =item siglongjmp
1163
1164 siglongjmp() is C-specific: use L<perlfunc/die> instead.
1165
1166 =item sigpending
1167
1168 Examine signals that are blocked and pending.  This uses C<POSIX::SigSet>
1169 objects for the C<sigset> argument.  Consult your system's C<sigpending>
1170 manpage for details.
1171
1172 Synopsis:
1173
1174         sigpending(sigset)
1175
1176 Returns C<undef> on failure.
1177
1178 =item sigprocmask
1179
1180 Change and/or examine calling process's signal mask.  This uses
1181 C<POSIX::SigSet> objects for the C<sigset> and C<oldsigset> arguments.
1182 Consult your system's C<sigprocmask> manpage for details.
1183
1184 Synopsis:
1185
1186         sigprocmask(how, sigset, oldsigset = 0)
1187
1188 Returns C<undef> on failure.
1189
1190 =item sigsetjmp
1191
1192 C<sigsetjmp()> is C-specific: use C<eval {}> instead,
1193 see L<perlfunc/eval>.
1194
1195 =item sigsuspend
1196
1197 Install a signal mask and suspend process until signal arrives.  This uses
1198 C<POSIX::SigSet> objects for the C<signal_mask> argument.  Consult your
1199 system's C<sigsuspend> manpage for details.
1200
1201 Synopsis:
1202
1203         sigsuspend(signal_mask)
1204
1205 Returns C<undef> on failure.
1206
1207 =item sin
1208
1209 This is identical to Perl's builtin C<sin()> function
1210 for returning the sine of the numerical argument,
1211 see L<perlfunc/sin>.  See also L<Math::Trig>.
1212
1213 =item sinh
1214
1215 This is identical to the C function C<sinh()>
1216 for returning the hyperbolic sine of the numerical argument.
1217 See also L<Math::Trig>.
1218
1219 =item sleep
1220
1221 This is functionally identical to Perl's builtin C<sleep()> function
1222 for suspending the execution of the current for process for certain
1223 number of seconds, see L<perlfunc/sleep>.  There is one significant
1224 difference, however: C<POSIX::sleep()> returns the number of
1225 B<unslept> seconds, while the C<CORE::sleep()> returns the
1226 number of slept seconds.
1227
1228 =item sprintf
1229
1230 This is similar to Perl's builtin C<sprintf()> function
1231 for returning a string that has the arguments formatted as requested,
1232 see L<perlfunc/sprintf>.
1233
1234 =item sqrt
1235
1236 This is identical to Perl's builtin C<sqrt()> function.
1237 for returning the square root of the numerical argument,
1238 see L<perlfunc/sqrt>.
1239
1240 =item srand
1241
1242 Give a seed the pseudorandom number generator, see L<perlfunc/srand>.
1243
1244 =item sscanf
1245
1246 sscanf() is C-specific, use regular expressions instead,
1247 see L<perlre>.
1248
1249 =item stat
1250
1251 This is identical to Perl's builtin C<stat()> function
1252 for returning information about files and directories.
1253
1254 =item strcat
1255
1256 strcat() is C-specific, use C<.=> instead, see L<perlop>.
1257
1258 =item strchr
1259
1260 strchr() is C-specific, see L<perlfunc/index> instead.
1261
1262 =item strcmp
1263
1264 strcmp() is C-specific, use C<eq> or C<cmp> instead, see L<perlop>.
1265
1266 =item strcoll
1267
1268 This is identical to the C function C<strcoll()>
1269 for collating (comparing) strings transformed using
1270 the C<strxfrm()> function.  Not really needed since
1271 Perl can do this transparently, see L<perllocale>.
1272
1273 =item strcpy
1274
1275 strcpy() is C-specific, use C<=> instead, see L<perlop>.
1276
1277 =item strcspn
1278
1279 strcspn() is C-specific, use regular expressions instead,
1280 see L<perlre>.
1281
1282 =item strerror
1283
1284 Returns the error string for the specified errno.
1285 Identical to the string form of the C<$!>, see L<perlvar/$ERRNO>.
1286
1287 =item strftime
1288
1289 Convert date and time information to string.  Returns the string.
1290
1291 Synopsis:
1292
1293         strftime(fmt, sec, min, hour, mday, mon, year, wday = -1, yday = -1, isdst = -1)
1294
1295 The month (C<mon>), weekday (C<wday>), and yearday (C<yday>) begin at zero.
1296 I.e. January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1.  The
1297 year (C<year>) is given in years since 1900.  I.e., the year 1995 is 95; the
1298 year 2001 is 101.  Consult your system's C<strftime()> manpage for details
1299 about these and the other arguments.
1300
1301 If you want your code to be portable, your format (C<fmt>) argument
1302 should use only the conversion specifiers defined by the ANSI C
1303 standard (C89, to play safe).  These are C<aAbBcdHIjmMpSUwWxXyYZ%>.
1304 But even then, the B<results> of some of the conversion specifiers are
1305 non-portable.  For example, the specifiers C<aAbBcpZ> change according
1306 to the locale settings of the user, and both how to set locales (the
1307 locale names) and what output to expect are non-standard.
1308 The specifier C<c> changes according to the timezone settings of the
1309 user and the timezone computation rules of the operating system.
1310 The C<Z> specifier is notoriously unportable since the names of
1311 timezones are non-standard. Sticking to the numeric specifiers is the
1312 safest route.
1313
1314 The given arguments are made consistent as though by calling
1315 C<mktime()> before calling your system's C<strftime()> function,
1316 except that the C<isdst> value is not affected.
1317
1318 The string for Tuesday, December 12, 1995.
1319
1320         $str = POSIX::strftime( "%A, %B %d, %Y", 0, 0, 0, 12, 11, 95, 2 );
1321         print "$str\n";
1322
1323 =item strlen
1324
1325 strlen() is C-specific, use C<length()> instead, see L<perlfunc/length>.
1326
1327 =item strncat
1328
1329 strncat() is C-specific, use C<.=> instead, see L<perlop>.
1330
1331 =item strncmp
1332
1333 strncmp() is C-specific, use C<eq> instead, see L<perlop>.
1334
1335 =item strncpy
1336
1337 strncpy() is C-specific, use C<=> instead, see L<perlop>.
1338
1339 =item strpbrk
1340
1341 strpbrk() is C-specific, use regular expressions instead,
1342 see L<perlre>.
1343
1344 =item strrchr
1345
1346 strrchr() is C-specific, see L<perlfunc/rindex> instead.
1347
1348 =item strspn
1349
1350 strspn() is C-specific, use regular expressions instead,
1351 see L<perlre>.
1352
1353 =item strstr
1354
1355 This is identical to Perl's builtin C<index()> function,
1356 see L<perlfunc/index>.
1357
1358 =item strtod
1359
1360 String to double translation. Returns the parsed number and the number
1361 of characters in the unparsed portion of the string.  Truly
1362 POSIX-compliant systems set $! ($ERRNO) to indicate a translation
1363 error, so clear $! before calling strtod.  However, non-POSIX systems
1364 may not check for overflow, and therefore will never set $!.
1365
1366 strtod should respect any POSIX I<setlocale()> settings.
1367
1368 To parse a string $str as a floating point number use
1369
1370     $! = 0;
1371     ($num, $n_unparsed) = POSIX::strtod($str);
1372
1373 The second returned item and $! can be used to check for valid input:
1374
1375     if (($str eq '') || ($n_unparsed != 0) || $!) {
1376         die "Non-numeric input $str" . ($! ? ": $!\n" : "\n");
1377     }
1378
1379 When called in a scalar context strtod returns the parsed number.
1380
1381 =item strtok
1382
1383 strtok() is C-specific, use regular expressions instead, see
1384 L<perlre>, or L<perlfunc/split>.
1385
1386 =item strtol
1387
1388 String to (long) integer translation.  Returns the parsed number and
1389 the number of characters in the unparsed portion of the string.  Truly
1390 POSIX-compliant systems set $! ($ERRNO) to indicate a translation
1391 error, so clear $! before calling strtol.  However, non-POSIX systems
1392 may not check for overflow, and therefore will never set $!.
1393
1394 strtol should respect any POSIX I<setlocale()> settings.
1395
1396 To parse a string $str as a number in some base $base use
1397
1398     $! = 0;
1399     ($num, $n_unparsed) = POSIX::strtol($str, $base);
1400
1401 The base should be zero or between 2 and 36, inclusive.  When the base
1402 is zero or omitted strtol will use the string itself to determine the
1403 base: a leading "0x" or "0X" means hexadecimal; a leading "0" means
1404 octal; any other leading characters mean decimal.  Thus, "1234" is
1405 parsed as a decimal number, "01234" as an octal number, and "0x1234"
1406 as a hexadecimal number.
1407
1408 The second returned item and $! can be used to check for valid input:
1409
1410     if (($str eq '') || ($n_unparsed != 0) || !$!) {
1411         die "Non-numeric input $str" . $! ? ": $!\n" : "\n";
1412     }
1413
1414 When called in a scalar context strtol returns the parsed number.
1415
1416 =item strtoul
1417
1418 String to unsigned (long) integer translation.  strtoul() is identical
1419 to strtol() except that strtoul() only parses unsigned integers.  See
1420 L</strtol> for details.
1421
1422 Note: Some vendors supply strtod() and strtol() but not strtoul().
1423 Other vendors that do supply strtoul() parse "-1" as a valid value.
1424
1425 =item strxfrm
1426
1427 String transformation.  Returns the transformed string.
1428
1429         $dst = POSIX::strxfrm( $src );
1430
1431 Used in conjunction with the C<strcoll()> function, see L</strcoll>.
1432
1433 Not really needed since Perl can do this transparently, see
1434 L<perllocale>.
1435
1436 =item sysconf
1437
1438 Retrieves values of system configurable variables.
1439
1440 The following will get the machine's clock speed.
1441
1442         $clock_ticks = POSIX::sysconf( &POSIX::_SC_CLK_TCK );
1443
1444 Returns C<undef> on failure.
1445
1446 =item system
1447
1448 This is identical to Perl's builtin C<system()> function, see
1449 L<perlfunc/system>.
1450
1451 =item tan
1452
1453 This is identical to the C function C<tan()>, returning the
1454 tangent of the numerical argument.  See also L<Math::Trig>.
1455
1456 =item tanh
1457
1458 This is identical to the C function C<tanh()>, returning the
1459 hyperbolic tangent of the numerical argument.   See also L<Math::Trig>.
1460
1461 =item tcdrain
1462
1463 This is similar to the C function C<tcdrain()> for draining
1464 the output queue of its argument stream.
1465
1466 Returns C<undef> on failure.
1467
1468 =item tcflow
1469
1470 This is similar to the C function C<tcflow()> for controlling
1471 the flow of its argument stream.
1472
1473 Returns C<undef> on failure.
1474
1475 =item tcflush
1476
1477 This is similar to the C function C<tcflush()> for flushing
1478 the I/O buffers of its argument stream.
1479
1480 Returns C<undef> on failure.
1481
1482 =item tcgetpgrp
1483
1484 This is identical to the C function C<tcgetpgrp()> for returning the
1485 process group identifier of the foreground process group of the controlling
1486 terminal.
1487
1488 =item tcsendbreak
1489
1490 This is similar to the C function C<tcsendbreak()> for sending
1491 a break on its argument stream.
1492
1493 Returns C<undef> on failure.
1494
1495 =item tcsetpgrp
1496
1497 This is similar to the C function C<tcsetpgrp()> for setting the
1498 process group identifier of the foreground process group of the controlling
1499 terminal.
1500
1501 Returns C<undef> on failure.
1502
1503 =item time
1504
1505 This is identical to Perl's builtin C<time()> function
1506 for returning the number of seconds since the epoch
1507 (whatever it is for the system), see L<perlfunc/time>.
1508
1509 =item times
1510
1511 The times() function returns elapsed realtime since some point in the past
1512 (such as system startup), user and system times for this process, and user
1513 and system times used by child processes.  All times are returned in clock
1514 ticks.
1515
1516     ($realtime, $user, $system, $cuser, $csystem) = POSIX::times();
1517
1518 Note: Perl's builtin C<times()> function returns four values, measured in
1519 seconds.
1520
1521 =item tmpfile
1522
1523 Use method C<IO::File::new_tmpfile()> instead, or see L<File::Temp>.
1524
1525 =item tmpnam
1526
1527 Returns a name for a temporary file.
1528
1529         $tmpfile = POSIX::tmpnam();
1530
1531 For security reasons, which are probably detailed in your system's
1532 documentation for the C library tmpnam() function, this interface
1533 should not be used; instead see L<File::Temp>.
1534
1535 =item tolower
1536
1537 This is identical to the C function, except that it can apply to a single
1538 character or to a whole string.  Consider using the C<lc()> function,
1539 see L<perlfunc/lc>, or the equivalent C<\L> operator inside doublequotish
1540 strings.
1541
1542 =item toupper
1543
1544 This is identical to the C function, except that it can apply to a single
1545 character or to a whole string.  Consider using the C<uc()> function,
1546 see L<perlfunc/uc>, or the equivalent C<\U> operator inside doublequotish
1547 strings.
1548
1549 =item ttyname
1550
1551 This is identical to the C function C<ttyname()> for returning the
1552 name of the current terminal.
1553
1554 =item tzname
1555
1556 Retrieves the time conversion information from the C<tzname> variable.
1557
1558         POSIX::tzset();
1559         ($std, $dst) = POSIX::tzname();
1560
1561 =item tzset
1562
1563 This is identical to the C function C<tzset()> for setting
1564 the current timezone based on the environment variable C<TZ>,
1565 to be used by C<ctime()>, C<localtime()>, C<mktime()>, and C<strftime()>
1566 functions.
1567
1568 =item umask
1569
1570 This is identical to Perl's builtin C<umask()> function
1571 for setting (and querying) the file creation permission mask,
1572 see L<perlfunc/umask>.
1573
1574 =item uname
1575
1576 Get name of current operating system.
1577
1578         ($sysname, $nodename, $release, $version, $machine) = POSIX::uname();
1579
1580 Note that the actual meanings of the various fields are not
1581 that well standardized, do not expect any great portability.
1582 The C<$sysname> might be the name of the operating system,
1583 the C<$nodename> might be the name of the host, the C<$release>
1584 might be the (major) release number of the operating system,
1585 the C<$version> might be the (minor) release number of the
1586 operating system, and the C<$machine> might be a hardware identifier.
1587 Maybe.
1588
1589 =item ungetc
1590
1591 Use method C<IO::Handle::ungetc()> instead.
1592
1593 =item unlink
1594
1595 This is identical to Perl's builtin C<unlink()> function
1596 for removing files, see L<perlfunc/unlink>.
1597
1598 =item utime
1599
1600 This is identical to Perl's builtin C<utime()> function
1601 for changing the time stamps of files and directories,
1602 see L<perlfunc/utime>.
1603
1604 =item vfprintf
1605
1606 vfprintf() is C-specific, see L<perlfunc/printf> instead.
1607
1608 =item vprintf
1609
1610 vprintf() is C-specific, see L<perlfunc/printf> instead.
1611
1612 =item vsprintf
1613
1614 vsprintf() is C-specific, see L<perlfunc/sprintf> instead.
1615
1616 =item wait
1617
1618 This is identical to Perl's builtin C<wait()> function,
1619 see L<perlfunc/wait>.
1620
1621 =item waitpid
1622
1623 Wait for a child process to change state.  This is identical to Perl's
1624 builtin C<waitpid()> function, see L<perlfunc/waitpid>.
1625
1626         $pid = POSIX::waitpid( -1, POSIX::WNOHANG );
1627         print "status = ", ($? / 256), "\n";
1628
1629 =item wcstombs
1630
1631 This is identical to the C function C<wcstombs()>.
1632 Perl does not have any support for the wide and multibyte
1633 characters of the C standards, so this might be a rather
1634 useless function.
1635
1636 =item wctomb
1637
1638 This is identical to the C function C<wctomb()>.
1639 Perl does not have any support for the wide and multibyte
1640 characters of the C standards, so this might be a rather
1641 useless function.
1642
1643 =item write
1644
1645 Write to a file.  This uses file descriptors such as those obtained by
1646 calling C<POSIX::open>.
1647
1648         $fd = POSIX::open( "foo", &POSIX::O_WRONLY );
1649         $buf = "hello";
1650         $bytes = POSIX::write( $b, $buf, 5 );
1651
1652 Returns C<undef> on failure.
1653
1654 See also L<perlfunc/syswrite>.
1655
1656 =back
1657
1658 =head1 CLASSES
1659
1660 =head2 POSIX::SigAction
1661
1662 =over 8
1663
1664 =item new
1665
1666 Creates a new C<POSIX::SigAction> object which corresponds to the C
1667 C<struct sigaction>.  This object will be destroyed automatically when
1668 it is no longer needed.  The first parameter is the handler, a sub
1669 reference.  The second parameter is a C<POSIX::SigSet> object, it
1670 defaults to the empty set.  The third parameter contains the
1671 C<sa_flags>, it defaults to 0.
1672
1673         $sigset = POSIX::SigSet->new(SIGINT, SIGQUIT);
1674         $sigaction = POSIX::SigAction->new( \&handler, $sigset, &POSIX::SA_NOCLDSTOP );
1675
1676 This C<POSIX::SigAction> object is intended for use with the C<POSIX::sigaction()>
1677 function.
1678
1679 =back
1680
1681 =over 8
1682
1683 =item handler
1684
1685 =item mask
1686
1687 =item flags
1688
1689 accessor functions to get/set the values of a SigAction object.
1690
1691         $sigset = $sigaction->mask;
1692         $sigaction->flags(&POSIX::SA_RESTART);
1693
1694 =item safe
1695
1696 accessor function for the "safe signals" flag of a SigAction object; see
1697 L<perlipc> for general information on safe (a.k.a. "deferred") signals.  If
1698 you wish to handle a signal safely, use this accessor to set the "safe" flag
1699 in the C<POSIX::SigAction> object:
1700
1701         $sigaction->safe(1);
1702
1703 You may also examine the "safe" flag on the output action object which is
1704 filled in when given as the third parameter to C<POSIX::sigaction()>:
1705
1706         sigaction(SIGINT, $new_action, $old_action);
1707         if ($old_action->safe) {
1708             # previous SIGINT handler used safe signals
1709         }
1710
1711 =back
1712
1713 =head2 POSIX::SigRt
1714
1715 =over 8
1716
1717 =item %SIGRT
1718
1719 A hash of the POSIX realtime signal handlers.  It is an extension of
1720 the standard %SIG, the $POSIX::SIGRT{SIGRTMIN} is roughly equivalent
1721 to $SIG{SIGRTMIN}, but the right POSIX moves (see below) are made with
1722 the POSIX::SigSet and POSIX::sigaction instead of accessing the %SIG.
1723
1724 You can set the %POSIX::SIGRT elements to set the POSIX realtime
1725 signal handlers, use C<delete> and C<exists> on the elements, and use
1726 C<scalar> on the C<%POSIX::SIGRT> to find out how many POSIX realtime
1727 signals there are available (SIGRTMAX - SIGRTMIN + 1, the SIGRTMAX is
1728 a valid POSIX realtime signal).
1729
1730 Setting the %SIGRT elements is equivalent to calling this:
1731
1732   sub new {
1733     my ($rtsig, $handler, $flags) = @_;
1734     my $sigset = POSIX:SigSet($rtsig);
1735     my $sigact = POSIX::SigAction->new($handler, $sigset, $flags);
1736     sigaction($rtsig, $sigact);
1737   }
1738
1739 The flags default to zero, if you want something different you can
1740 either use C<local> on $POSIX::RtSig::SIGACTION_FLAGS, or you can
1741 derive from POSIX::SigRt and define your own C<new()> (the tied hash
1742 STORE method of the %SIGRT calls C<new($rtsig, $handler, $SIGACTION_FLAGS)>,
1743 where the $rtsig ranges from zero to SIGRTMAX - SIGRTMIN + 1).
1744
1745 Just as with any signal, you can use sigaction($rtsig, undef, $oa) to
1746 retrieve the installed signal handler (or, rather, the signal action).
1747
1748 B<NOTE:> whether POSIX realtime signals really work in your system, or
1749 whether Perl has been compiled so that it works with them, is outside
1750 of this discussion.
1751
1752 =item SIGRTMIN
1753
1754 Return the minimum POSIX realtime signal number available, or C<undef>
1755 if no POSIX realtime signals are available.
1756
1757 =item SIGRTMAX
1758
1759 Return the maximum POSIX realtime signal number available, or C<undef>
1760 if no POSIX realtime signals are available.
1761
1762 =back
1763
1764 =head2 POSIX::SigSet
1765
1766 =over 8
1767
1768 =item new
1769
1770 Create a new SigSet object.  This object will be destroyed automatically
1771 when it is no longer needed.  Arguments may be supplied to initialize the
1772 set.
1773
1774 Create an empty set.
1775
1776         $sigset = POSIX::SigSet->new;
1777
1778 Create a set with SIGUSR1.
1779
1780         $sigset = POSIX::SigSet->new( &POSIX::SIGUSR1 );
1781
1782 =item addset
1783
1784 Add a signal to a SigSet object.
1785
1786         $sigset->addset( &POSIX::SIGUSR2 );
1787
1788 Returns C<undef> on failure.
1789
1790 =item delset
1791
1792 Remove a signal from the SigSet object.
1793
1794         $sigset->delset( &POSIX::SIGUSR2 );
1795
1796 Returns C<undef> on failure.
1797
1798 =item emptyset
1799
1800 Initialize the SigSet object to be empty.
1801
1802         $sigset->emptyset();
1803
1804 Returns C<undef> on failure.
1805
1806 =item fillset
1807
1808 Initialize the SigSet object to include all signals.
1809
1810         $sigset->fillset();
1811
1812 Returns C<undef> on failure.
1813
1814 =item ismember
1815
1816 Tests the SigSet object to see if it contains a specific signal.
1817
1818         if( $sigset->ismember( &POSIX::SIGUSR1 ) ){
1819                 print "contains SIGUSR1\n";
1820         }
1821
1822 =back
1823
1824 =head2 POSIX::Termios
1825
1826 =over 8
1827
1828 =item new
1829
1830 Create a new Termios object.  This object will be destroyed automatically
1831 when it is no longer needed.  A Termios object corresponds to the termios
1832 C struct.  new() mallocs a new one, getattr() fills it from a file descriptor,
1833 and setattr() sets a file descriptor's parameters to match Termios' contents.
1834
1835         $termios = POSIX::Termios->new;
1836
1837 =item getattr
1838
1839 Get terminal control attributes.
1840
1841 Obtain the attributes for stdin.
1842
1843         $termios->getattr()
1844
1845 Obtain the attributes for stdout.
1846
1847         $termios->getattr( 1 )
1848
1849 Returns C<undef> on failure.
1850
1851 =item getcc
1852
1853 Retrieve a value from the c_cc field of a termios object.  The c_cc field is
1854 an array so an index must be specified.
1855
1856         $c_cc[1] = $termios->getcc(1);
1857
1858 =item getcflag
1859
1860 Retrieve the c_cflag field of a termios object.
1861
1862         $c_cflag = $termios->getcflag;
1863
1864 =item getiflag
1865
1866 Retrieve the c_iflag field of a termios object.
1867
1868         $c_iflag = $termios->getiflag;
1869
1870 =item getispeed
1871
1872 Retrieve the input baud rate.
1873
1874         $ispeed = $termios->getispeed;
1875
1876 =item getlflag
1877
1878 Retrieve the c_lflag field of a termios object.
1879
1880         $c_lflag = $termios->getlflag;
1881
1882 =item getoflag
1883
1884 Retrieve the c_oflag field of a termios object.
1885
1886         $c_oflag = $termios->getoflag;
1887
1888 =item getospeed
1889
1890 Retrieve the output baud rate.
1891
1892         $ospeed = $termios->getospeed;
1893
1894 =item setattr
1895
1896 Set terminal control attributes.
1897
1898 Set attributes immediately for stdout.
1899
1900         $termios->setattr( 1, &POSIX::TCSANOW );
1901
1902 Returns C<undef> on failure.
1903
1904 =item setcc
1905
1906 Set a value in the c_cc field of a termios object.  The c_cc field is an
1907 array so an index must be specified.
1908
1909         $termios->setcc( &POSIX::VEOF, 1 );
1910
1911 =item setcflag
1912
1913 Set the c_cflag field of a termios object.
1914
1915         $termios->setcflag( $c_cflag | &POSIX::CLOCAL );
1916
1917 =item setiflag
1918
1919 Set the c_iflag field of a termios object.
1920
1921         $termios->setiflag( $c_iflag | &POSIX::BRKINT );
1922
1923 =item setispeed
1924
1925 Set the input baud rate.
1926
1927         $termios->setispeed( &POSIX::B9600 );
1928
1929 Returns C<undef> on failure.
1930
1931 =item setlflag
1932
1933 Set the c_lflag field of a termios object.
1934
1935         $termios->setlflag( $c_lflag | &POSIX::ECHO );
1936
1937 =item setoflag
1938
1939 Set the c_oflag field of a termios object.
1940
1941         $termios->setoflag( $c_oflag | &POSIX::OPOST );
1942
1943 =item setospeed
1944
1945 Set the output baud rate.
1946
1947         $termios->setospeed( &POSIX::B9600 );
1948
1949 Returns C<undef> on failure.
1950
1951 =item Baud rate values
1952
1953 B38400 B75 B200 B134 B300 B1800 B150 B0 B19200 B1200 B9600 B600 B4800 B50 B2400 B110
1954
1955 =item Terminal interface values
1956
1957 TCSADRAIN TCSANOW TCOON TCIOFLUSH TCOFLUSH TCION TCIFLUSH TCSAFLUSH TCIOFF TCOOFF
1958
1959 =item c_cc field values
1960
1961 VEOF VEOL VERASE VINTR VKILL VQUIT VSUSP VSTART VSTOP VMIN VTIME NCCS
1962
1963 =item c_cflag field values
1964
1965 CLOCAL CREAD CSIZE CS5 CS6 CS7 CS8 CSTOPB HUPCL PARENB PARODD
1966
1967 =item c_iflag field values
1968
1969 BRKINT ICRNL IGNBRK IGNCR IGNPAR INLCR INPCK ISTRIP IXOFF IXON PARMRK
1970
1971 =item c_lflag field values
1972
1973 ECHO ECHOE ECHOK ECHONL ICANON IEXTEN ISIG NOFLSH TOSTOP
1974
1975 =item c_oflag field values
1976
1977 OPOST
1978
1979 =back
1980
1981 =head1 PATHNAME CONSTANTS
1982
1983 =over 8
1984
1985 =item Constants
1986
1987 _PC_CHOWN_RESTRICTED _PC_LINK_MAX _PC_MAX_CANON _PC_MAX_INPUT _PC_NAME_MAX _PC_NO_TRUNC _PC_PATH_MAX _PC_PIPE_BUF _PC_VDISABLE
1988
1989 =back
1990
1991 =head1 POSIX CONSTANTS
1992
1993 =over 8
1994
1995 =item Constants
1996
1997 _POSIX_ARG_MAX _POSIX_CHILD_MAX _POSIX_CHOWN_RESTRICTED _POSIX_JOB_CONTROL _POSIX_LINK_MAX _POSIX_MAX_CANON _POSIX_MAX_INPUT _POSIX_NAME_MAX _POSIX_NGROUPS_MAX _POSIX_NO_TRUNC _POSIX_OPEN_MAX _POSIX_PATH_MAX _POSIX_PIPE_BUF _POSIX_SAVED_IDS _POSIX_SSIZE_MAX _POSIX_STREAM_MAX _POSIX_TZNAME_MAX _POSIX_VDISABLE _POSIX_VERSION
1998
1999 =back
2000
2001 =head1 SYSTEM CONFIGURATION
2002
2003 =over 8
2004
2005 =item Constants
2006
2007 _SC_ARG_MAX _SC_CHILD_MAX _SC_CLK_TCK _SC_JOB_CONTROL _SC_NGROUPS_MAX _SC_OPEN_MAX _SC_PAGESIZE _SC_SAVED_IDS _SC_STREAM_MAX _SC_TZNAME_MAX _SC_VERSION
2008
2009 =back
2010
2011 =head1 ERRNO
2012
2013 =over 8
2014
2015 =item Constants
2016
2017 E2BIG EACCES EADDRINUSE EADDRNOTAVAIL EAFNOSUPPORT EAGAIN EALREADY EBADF
2018 EBUSY ECHILD ECONNABORTED ECONNREFUSED ECONNRESET EDEADLK EDESTADDRREQ
2019 EDOM EDQUOT EEXIST EFAULT EFBIG EHOSTDOWN EHOSTUNREACH EINPROGRESS EINTR
2020 EINVAL EIO EISCONN EISDIR ELOOP EMFILE EMLINK EMSGSIZE ENAMETOOLONG
2021 ENETDOWN ENETRESET ENETUNREACH ENFILE ENOBUFS ENODEV ENOENT ENOEXEC
2022 ENOLCK ENOMEM ENOPROTOOPT ENOSPC ENOSYS ENOTBLK ENOTCONN ENOTDIR
2023 ENOTEMPTY ENOTSOCK ENOTTY ENXIO EOPNOTSUPP EPERM EPFNOSUPPORT EPIPE
2024 EPROCLIM EPROTONOSUPPORT EPROTOTYPE ERANGE EREMOTE ERESTART EROFS
2025 ESHUTDOWN ESOCKTNOSUPPORT ESPIPE ESRCH ESTALE ETIMEDOUT ETOOMANYREFS
2026 ETXTBSY EUSERS EWOULDBLOCK EXDEV
2027
2028 =back
2029
2030 =head1 FCNTL
2031
2032 =over 8
2033
2034 =item Constants
2035
2036 FD_CLOEXEC F_DUPFD F_GETFD F_GETFL F_GETLK F_OK F_RDLCK F_SETFD F_SETFL F_SETLK F_SETLKW F_UNLCK F_WRLCK O_ACCMODE O_APPEND O_CREAT O_EXCL O_NOCTTY O_NONBLOCK O_RDONLY O_RDWR O_TRUNC O_WRONLY
2037
2038 =back
2039
2040 =head1 FLOAT
2041
2042 =over 8
2043
2044 =item Constants
2045
2046 DBL_DIG DBL_EPSILON DBL_MANT_DIG DBL_MAX DBL_MAX_10_EXP DBL_MAX_EXP DBL_MIN DBL_MIN_10_EXP DBL_MIN_EXP FLT_DIG FLT_EPSILON FLT_MANT_DIG FLT_MAX FLT_MAX_10_EXP FLT_MAX_EXP FLT_MIN FLT_MIN_10_EXP FLT_MIN_EXP FLT_RADIX FLT_ROUNDS LDBL_DIG LDBL_EPSILON LDBL_MANT_DIG LDBL_MAX LDBL_MAX_10_EXP LDBL_MAX_EXP LDBL_MIN LDBL_MIN_10_EXP LDBL_MIN_EXP
2047
2048 =back
2049
2050 =head1 LIMITS
2051
2052 =over 8
2053
2054 =item Constants
2055
2056 ARG_MAX CHAR_BIT CHAR_MAX CHAR_MIN CHILD_MAX INT_MAX INT_MIN LINK_MAX LONG_MAX LONG_MIN MAX_CANON MAX_INPUT MB_LEN_MAX NAME_MAX NGROUPS_MAX OPEN_MAX PATH_MAX PIPE_BUF SCHAR_MAX SCHAR_MIN SHRT_MAX SHRT_MIN SSIZE_MAX STREAM_MAX TZNAME_MAX UCHAR_MAX UINT_MAX ULONG_MAX USHRT_MAX
2057
2058 =back
2059
2060 =head1 LOCALE
2061
2062 =over 8
2063
2064 =item Constants
2065
2066 LC_ALL LC_COLLATE LC_CTYPE LC_MONETARY LC_NUMERIC LC_TIME
2067
2068 =back
2069
2070 =head1 MATH
2071
2072 =over 8
2073
2074 =item Constants
2075
2076 HUGE_VAL
2077
2078 =back
2079
2080 =head1 SIGNAL
2081
2082 =over 8
2083
2084 =item Constants
2085
2086 SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK SA_RESETHAND SA_RESTART
2087 SA_SIGINFO SIGABRT SIGALRM SIGCHLD SIGCONT SIGFPE SIGHUP SIGILL SIGINT
2088 SIGKILL SIGPIPE SIGQUIT SIGSEGV SIGSTOP SIGTERM SIGTSTP SIGTTIN SIGTTOU
2089 SIGUSR1 SIGUSR2 SIG_BLOCK SIG_DFL SIG_ERR SIG_IGN SIG_SETMASK
2090 SIG_UNBLOCK
2091
2092 =back
2093
2094 =head1 STAT
2095
2096 =over 8
2097
2098 =item Constants
2099
2100 S_IRGRP S_IROTH S_IRUSR S_IRWXG S_IRWXO S_IRWXU S_ISGID S_ISUID S_IWGRP S_IWOTH S_IWUSR S_IXGRP S_IXOTH S_IXUSR
2101
2102 =item Macros
2103
2104 S_ISBLK S_ISCHR S_ISDIR S_ISFIFO S_ISREG
2105
2106 =back
2107
2108 =head1 STDLIB
2109
2110 =over 8
2111
2112 =item Constants
2113
2114 EXIT_FAILURE EXIT_SUCCESS MB_CUR_MAX RAND_MAX
2115
2116 =back
2117
2118 =head1 STDIO
2119
2120 =over 8
2121
2122 =item Constants
2123
2124 BUFSIZ EOF FILENAME_MAX L_ctermid L_cuserid L_tmpname TMP_MAX
2125
2126 =back
2127
2128 =head1 TIME
2129
2130 =over 8
2131
2132 =item Constants
2133
2134 CLK_TCK CLOCKS_PER_SEC
2135
2136 =back
2137
2138 =head1 UNISTD
2139
2140 =over 8
2141
2142 =item Constants
2143
2144 R_OK SEEK_CUR SEEK_END SEEK_SET STDIN_FILENO STDOUT_FILENO STDERR_FILENO W_OK X_OK
2145
2146 =back
2147
2148 =head1 WAIT
2149
2150 =over 8
2151
2152 =item Constants
2153
2154 WNOHANG WUNTRACED
2155
2156 =over 16
2157
2158 =item WNOHANG
2159
2160 Do not suspend the calling process until a child process
2161 changes state but instead return immediately.
2162
2163 =item WUNTRACED
2164
2165 Catch stopped child processes.
2166
2167 =back
2168
2169 =item Macros
2170
2171 WIFEXITED WEXITSTATUS WIFSIGNALED WTERMSIG WIFSTOPPED WSTOPSIG
2172
2173 =over 16
2174
2175 =item WIFEXITED
2176
2177 WIFEXITED($?) returns true if the child process exited normally
2178 (C<exit()> or by falling off the end of C<main()>)
2179
2180 =item WEXITSTATUS
2181
2182 WEXITSTATUS($?) returns the normal exit status of the child process
2183 (only meaningful if WIFEXITED($?) is true)
2184
2185 =item WIFSIGNALED
2186
2187 WIFSIGNALED($?) returns true if the child process terminated because
2188 of a signal
2189
2190 =item WTERMSIG
2191
2192 WTERMSIG($?) returns the signal the child process terminated for
2193 (only meaningful if WIFSIGNALED($?) is true)
2194
2195 =item WIFSTOPPED
2196
2197 WIFSTOPPED($?) returns true if the child process is currently stopped
2198 (can happen only if you specified the WUNTRACED flag to waitpid())
2199
2200 =item WSTOPSIG
2201
2202 WSTOPSIG($?) returns the signal the child process was stopped for
2203 (only meaningful if WIFSTOPPED($?) is true)
2204
2205 =back
2206
2207 =back
2208