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