Start anew
[msysgit.git] / lib / perl5 / 5.6.1 / msys / POSIX.pod
blob49761358ca20d2d8041ecae11002852982e7819e
1 =head1 NAME
3 POSIX - Perl interface to IEEE Std 1003.1
5 =head1 SYNOPSIS
7     use POSIX;
8     use POSIX qw(setsid);
9     use POSIX qw(:errno_h :fcntl_h);
11     printf "EINTR is %d\n", EINTR;
13     $sess_id = POSIX::setsid();
15     $fd = POSIX::open($path, O_CREAT|O_EXCL|O_WRONLY, 0644);
16         # note: that's a filedescriptor, *NOT* a filehandle
18 =head1 DESCRIPTION
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.
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.
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.
38 =head1 NOTE
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.
45 =head1 CAVEATS 
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".
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.
62 =head1 FUNCTIONS
64 =over 8
66 =item _exit
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.
71 =item abort
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>).
77 =item abs
79 This is identical to Perl's builtin C<abs()> function, returning
80 the absolute value of its numerical argument.
82 =item access
84 Determines the accessibility of a file.
86         if( POSIX::access( "/", &POSIX::R_OK ) ){
87                 print "have read permission\n";
88         }
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>.
95 =item acos
97 This is identical to the C function C<acos()>, returning
98 the arcus cosine of its numerical argument.  See also L<Math::Trig>.
100 =item alarm
102 This is identical to Perl's builtin C<alarm()> function,
103 either for arming or disarming the C<SIGARLM> timer.
105 =item asctime
107 This is identical to the C function C<asctime()>.  It returns
108 a string of the form
110         "Fri Jun  2 18:22:13 2000\n\0"
112 and it is called thusly
114         $asctime = asctime($sec, $min, $hour, $mday, $mon, $year,
115                            $wday, $yday, $isdst);
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).
121 =item asin
123 This is identical to the C function C<asin()>, returning
124 the arcus sine of its numerical argument.  See also L<Math::Trig>.
126 =item assert
128 Unimplemented, but you can use L<perlfunc/die> and the L<Carp> module
129 to achieve similar things.
131 =item atan
133 This is identical to the C function C<atan()>, returning the
134 arcus tangent of its numerical argument.  See also L<Math::Trig>.
136 =item atan2
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>.
142 =item atexit
144 atexit() is C-specific: use C<END {}> instead, see L<perlsub>.
146 =item atof
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.
151 =item atoi
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>.
157 =item atol
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>.
163 =item bsearch
165 bsearch() not supplied.  For doing binary search on wordlists,
166 see L<Search::Dict>.
168 =item calloc
170 calloc() is C-specific.  Perl does memory management transparently.
172 =item ceil
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.
177 =item chdir
179 This is identical to Perl's builtin C<chdir()> function, allowing
180 one to change the working (default) directory, see L<perlfunc/chdir>.
182 =item chmod
184 This is identical to Perl's builtin C<chmod()> function, allowing
185 one to change file and directory permissions, see L<perlfunc/chmod>.
187 =item chown
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>.
192 =item clearerr
194 Use the method L<IO::Handle::clearerr()> instead, to reset the error
195 state (if any) and EOF state (if any) of the given stream.
197 =item clock
199 This is identical to the C function C<clock()>, returning the
200 amount of spent processor time in microseconds.
202 =item close
204 Close the file.  This uses file descriptors such as those obtained by calling
205 C<POSIX::open>.
207         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
208         POSIX::close( $fd );
210 Returns C<undef> on failure.
212 See also L<perlfunc/close>.
214 =item closedir
216 This is identical to Perl's builtin C<closedir()> function for closing
217 a directory handle, see L<perlfunc/closedir>.
219 =item cos
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>.
225 =item cosh
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>.
230 =item creat
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.
235         $fd = POSIX::creat( "foo", 0611 );
236         POSIX::close( $fd );
238 See also L<perlfunc/sysopen> and its C<O_CREAT> flag.
240 =item ctermid
242 Generates the path name for the controlling terminal.
244         $path = POSIX::ctermid();
246 =item ctime
248 This is identical to the C function C<ctime()> and equivalent
249 to C<asctime(localtime(...))>, see L</asctime> and L</localtime>.
251 =item cuserid
253 Get the login name of the owner of the current process.
255         $name = POSIX::cuserid();
257 =item difftime
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>.
263 =item div
265 div() is C-specific, use L<perlfunc/int> on the usual C</> division and
266 the modulus C<%>.
268 =item dup
270 This is similar to the C function C<dup()>, for duplicating a file
271 descriptor.
273 This uses file descriptors such as those obtained by calling
274 C<POSIX::open>.
276 Returns C<undef> on failure.
278 =item dup2
280 This is similar to the C function C<dup2()>, for duplicating a file
281 descriptor to an another known file descriptor.
283 This uses file descriptors such as those obtained by calling
284 C<POSIX::open>.
286 Returns C<undef> on failure.
288 =item errno
290 Returns the value of errno.
292         $errno = POSIX::errno();
294 This identical to the numerical values of the C<$!>, see L<perlvar/$ERRNO>.
296 =item execl
298 execl() is C-specific, see L<perlfunc/exec>.
300 =item execle
302 execle() is C-specific, see L<perlfunc/exec>.
304 =item execlp
306 execlp() is C-specific, see L<perlfunc/exec>.
308 =item execv
310 execv() is C-specific, see L<perlfunc/exec>.
312 =item execve
314 execve() is C-specific, see L<perlfunc/exec>.
316 =item execvp
318 execvp() is C-specific, see L<perlfunc/exec>.
320 =item exit
322 This is identical to Perl's builtin C<exit()> function for exiting the
323 program, see L<perlfunc/exit>.
325 =item exp
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>.
331 =item fabs
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>.
336 =item fclose
338 Use method C<IO::Handle::close()> instead, or see L<perlfunc/close>.
340 =item fcntl
342 This is identical to Perl's builtin C<fcntl()> function,
343 see L<perlfunc/fcntl>.
345 =item fdopen
347 Use method C<IO::Handle::new_from_fd()> instead, or see L<perlfunc/open>.
349 =item feof
351 Use method C<IO::Handle::eof()> instead, or see L<perlfunc/eof>.
353 =item ferror
355 Use method C<IO::Handle::error()> instead.
357 =item fflush
359 Use method C<IO::Handle::flush()> instead.
360 See also L<perlvar/$OUTPUT_AUTOFLUSH>.
362 =item fgetc
364 Use method C<IO::Handle::getc()> instead, or see L<perlfunc/read>.
366 =item fgetpos
368 Use method C<IO::Seekable::getpos()> instead, or see L<L/seek>.
370 =item fgets
372 Use method C<IO::Handle::gets()> instead.  Similar to E<lt>E<gt>, also known
373 as L<perlfunc/readline>.
375 =item fileno
377 Use method C<IO::Handle::fileno()> instead, or see L<perlfunc/fileno>.
379 =item floor
381 This is identical to the C function C<floor()>, returning the largest
382 integer value less than or equal to the numerical argument.
384 =item fmod
386 This is identical to the C function C<fmod()>.
388         $r = modf($x, $y);
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>.
394 =item fopen
396 Use method C<IO::File::open()> instead, or see L<perlfunc/open>.
398 =item fork
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.
404 =item fpathconf
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>.
409 The following will determine the maximum length of the longest allowable
410 pathname on the filesystem which holds C</tmp/foo>.
412         $fd = POSIX::open( "/tmp/foo", &POSIX::O_RDONLY );
413         $path_max = POSIX::fpathconf( $fd, &POSIX::_PC_PATH_MAX );
415 Returns C<undef> on failure.
417 =item fprintf
419 fprintf() is C-specific, see L<perlfunc/printf> instead.
421 =item fputc
423 fputc() is C-specific, see L<perlfunc/print> instead.
425 =item fputs
427 fputs() is C-specific, see L<perlfunc/print> instead.
429 =item fread
431 fread() is C-specific, see L<perlfunc/read> instead.
433 =item free
435 free() is C-specific.  Perl does memory management transparently.
437 =item freopen
439 freopen() is C-specific, see L<perlfunc/open> instead.
441 =item frexp
443 Return the mantissa and exponent of a floating-point number.
445         ($mantissa, $exponent) = POSIX::frexp( 1.234e56 );
447 =item fscanf
449 fscanf() is C-specific, use E<lt>E<gt> and regular expressions instead.
451 =item fseek
453 Use method C<IO::Seekable::seek()> instead, or see L<perlfunc/seek>.
455 =item fsetpos
457 Use method C<IO::Seekable::setpos()> instead, or seek L<perlfunc/seek>.
459 =item fstat
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.
465         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
466         @stats = POSIX::fstat( $fd );
468 =item ftell
470 Use method C<IO::Seekable::tell()> instead, or see L<perlfunc/tell>.
472 =item fwrite
474 fwrite() is C-specific, see L<perlfunc/print> instead.
476 =item getc
478 This is identical to Perl's builtin C<getc()> function,
479 see L<perlfunc/getc>.
481 =item getchar
483 Returns one character from STDIN.  Identical to Perl's C<getc()>,
484 see L<perlfunc/getc>.
486 =item getcwd
488 Returns the name of the current working directory.
489 See also L<Cwd>.
491 =item getegid
493 Returns the effective group identifier.  Similar to Perl' s builtin
494 variable C<$(>, see L<perlvar/$EGID>.
496 =item getenv
498 Returns the value of the specified enironment variable.
499 The same information is available through the C<%ENV> array.
501 =item geteuid
503 Returns the effective user identifier.  Identical to Perl's builtin C<$E<gt>>
504 variable, see L<perlvar/$EUID>.
506 =item getgid
508 Returns the user's real group identifier.  Similar to Perl's builtin
509 variable C<$)>, see L<perlvar/$GID>.
511 =item getgrgid
513 This is identical to Perl's builtin C<getgrgid()> function for
514 returning group entries by group identifiers, see
515 L<perlfunc/getgrgid>.
517 =item getgrnam
519 This is identical to Perl's builtin C<getgrnam()> function for
520 returning group entries by group names, see L<perlfunc/getgrnam>.
522 =item getgroups
524 Returns the ids of the user's supplementary groups.  Similar to Perl's
525 builtin variable C<$)>, see L<perlvar/$GID>.
527 =item getlogin
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>.
533 =item getpgrp
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>.
539 =item getpid
541 Returns the process identifier.  Identical to Perl's builtin
542 variable C<$$>, see L<perlvar/$PID>.
544 =item getppid
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>.
550 =item getpwnam
552 This is identical to Perl's builtin C<getpwnam()> function for
553 returning user entries by user names, see L<perlfunc/getpwnam>.
555 =item getpwuid
557 This is identical to Perl's builtin C<getpwuid()> function for
558 returning user entries by user identifiers, see L<perlfunc/getpwuid>.
560 =item gets
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>.
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.
570 =item getuid
572 Returns the user's identifier.  Identical to Perl's builtin C<$E<lt>> variable,
573 see L<perlvar/$UID>.
575 =item gmtime
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>.
581 =item isalnum
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</[[:isalnum:]]/> construct instead, or possibly the C</\w/> construct.
587 =item isalpha
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</[[:isalpha:]]/> construct instead.
593 =item isatty
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>.
598 =item iscntrl
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</[[:iscntrl:]]/> construct instead.
604 =item isdigit
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</[[:isdigit:]]/> construct instead, or the C</\d/> construct.
610 =item isgraph
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</[[:isgraph:]]/> construct instead.
616 =item islower
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</[[:islower:]]/> construct instead.  Do B<not> use C</a-z/>.
622 =item isprint
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</[[:isprint:]]/> construct instead.
628 =item ispunct
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</[[:ispunct:]]/> construct instead.
634 =item isspace
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</[[:isspace:]]/> construct instead, or the C</\s/> construct.
640 =item isupper
642 This is identical to the C function, except that it can apply to a single
643 character or to a whole string.  Consider using regular expressions and the
644 C</[[:isupper:]]/> construct instead.  Do B<not> use C</A-Z/>.
646 =item isxdigit
648 This is identical to the C function, except that it can apply to a single
649 character or to a whole string.  Consider using regular expressions and the
650 C</[[:isxdigit:]]/> construct instead, or simply C</[0-9a-f]/i>.
652 =item kill
654 This is identical to Perl's builtin C<kill()> function for sending
655 signals to processes (often to terminate them), see L<perlfunc/kill>.
657 =item labs
659 (For returning absolute values of long integers.)
660 labs() is C-specific, see L<perlfunc/abs> instead.
662 =item ldexp
664 This is identical to the C function C<ldexp()>
665 for multiplying floating point numbers with powers of two.
667         $x_quadrupled = POSIX::ldexp($x, 2);
669 =item ldiv
671 (For computing dividends of long integers.)
672 ldiv() is C-specific, use C</> and C<int()> instead.
674 =item link
676 This is identical to Perl's builtin C<link()> function
677 for creating hard links into files, see L<perlfunc/link>.
679 =item localeconv
681 Get numeric formatting information.  Returns a reference to a hash
682 containing the current locale formatting values.
684 Here is how to query the database for the B<de> (Deutsch or German) locale.
686         $loc = POSIX::setlocale( &POSIX::LC_ALL, "de" );
687         print "Locale = $loc\n";
688         $lconv = POSIX::localeconv();
689         print "decimal_point    = ", $lconv->{decimal_point},   "\n";
690         print "thousands_sep    = ", $lconv->{thousands_sep},   "\n";
691         print "grouping = ", $lconv->{grouping},        "\n";
692         print "int_curr_symbol  = ", $lconv->{int_curr_symbol}, "\n";
693         print "currency_symbol  = ", $lconv->{currency_symbol}, "\n";
694         print "mon_decimal_point = ", $lconv->{mon_decimal_point}, "\n";
695         print "mon_thousands_sep = ", $lconv->{mon_thousands_sep}, "\n";
696         print "mon_grouping     = ", $lconv->{mon_grouping},    "\n";
697         print "positive_sign    = ", $lconv->{positive_sign},   "\n";
698         print "negative_sign    = ", $lconv->{negative_sign},   "\n";
699         print "int_frac_digits  = ", $lconv->{int_frac_digits}, "\n";
700         print "frac_digits      = ", $lconv->{frac_digits},     "\n";
701         print "p_cs_precedes    = ", $lconv->{p_cs_precedes},   "\n";
702         print "p_sep_by_space   = ", $lconv->{p_sep_by_space},  "\n";
703         print "n_cs_precedes    = ", $lconv->{n_cs_precedes},   "\n";
704         print "n_sep_by_space   = ", $lconv->{n_sep_by_space},  "\n";
705         print "p_sign_posn      = ", $lconv->{p_sign_posn},     "\n";
706         print "n_sign_posn      = ", $lconv->{n_sign_posn},     "\n";
708 =item localtime
710 This is identical to Perl's builtin C<localtime()> function for
711 converting seconds since the epoch to a date see L<perlfunc/localtime>.
713 =item log
715 This is identical to Perl's builtin C<log()> function,
716 returning the natural (I<e>-based) logarithm of the numerical argument,
717 see L<perlfunc/log>.
719 =item log10
721 This is identical to the C function C<log10()>,
722 returning the 10-base logarithm of the numerical argument.
723 You can also use
725     sub log10 { log($_[0]) / log(10) }
729     sub log10 { log($_[0]) / 2.30258509299405 }  
733     sub log10 { log($_[0]) * 0.434294481903252 }
735 =item longjmp
737 longjmp() is C-specific: use L<perlfunc/die> instead.
739 =item lseek
741 Move the file's read/write position.  This uses file descriptors such as
742 those obtained by calling C<POSIX::open>.
744         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
745         $off_t = POSIX::lseek( $fd, 0, &POSIX::SEEK_SET );
747 Returns C<undef> on failure.
749 =item malloc
751 malloc() is C-specific.  Perl does memory management transparently.
753 =item mblen
755 This is identical to the C function C<mblen()>.
756 Perl does not have any support for the wide and multibyte
757 characters of the C standards, so this might be a rather 
758 useless function.
760 =item mbstowcs
762 This is identical to the C function C<mbstowcs()>.
763 Perl does not have any support for the wide and multibyte
764 characters of the C standards, so this might be a rather 
765 useless function.
767 =item mbtowc
769 This is identical to the C function C<mbtowc()>.
770 Perl does not have any support for the wide and multibyte
771 characters of the C standards, so this might be a rather 
772 useless function.
774 =item memchr
776 memchr() is C-specific, see L<perlfunc/index> instead.
778 =item memcmp
780 memcmp() is C-specific, use C<eq> instead, see L<perlop>.
782 =item memcpy
784 memcpy() is C-specific, use C<=>, see L<perlop>, or see L<perlfunc/substr>.
786 =item memmove
788 memmove() is C-specific, use C<=>, see L<perlop>, or see L<perlfunc/substr>.
790 =item memset
792 memset() is C-specific, use C<x> instead, see L<perlop>.
794 =item mkdir
796 This is identical to Perl's builtin C<mkdir()> function
797 for creating directories, see L<perlfunc/mkdir>.
799 =item mkfifo
801 This is similar to the C function C<mkfifo()> for creating
802 FIFO special files.
804         if (mkfifo($path, $mode)) { ....
806 Returns C<undef> on failure.  The C<$mode> is similar to the
807 mode of C<mkdir()>, see L<perlfunc/mkdir>.
809 =item mktime
811 Convert date/time info to a calendar time.
813 Synopsis:
815         mktime(sec, min, hour, mday, mon, year, wday = 0, yday = 0, isdst = 0)
817 The month (C<mon>), weekday (C<wday>), and yearday (C<yday>) begin at zero.
818 I.e. January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1.  The
819 year (C<year>) is given in years since 1900.  I.e. The year 1995 is 95; the
820 year 2001 is 101.  Consult your system's C<mktime()> manpage for details
821 about these and the other arguments.
823 Calendar time for December 12, 1995, at 10:30 am.
825         $time_t = POSIX::mktime( 0, 30, 10, 12, 11, 95 );
826         print "Date = ", POSIX::ctime($time_t);
828 Returns C<undef> on failure.
830 =item modf
832 Return the integral and fractional parts of a floating-point number.
834         ($fractional, $integral) = POSIX::modf( 3.14 );
836 =item nice
838 This is similar to the C function C<nice()>, for changing
839 the scheduling preference of the current process.  Positive
840 arguments mean more polite process, negative values more
841 needy process.  Normal user processes can only be more polite.
843 Returns C<undef> on failure.
845 =item offsetof
847 offsetof() is C-specific, you probably want to see L<perlfunc/pack> instead.
849 =item open
851 Open a file for reading for writing.  This returns file descriptors, not
852 Perl filehandles.  Use C<POSIX::close> to close the file.
854 Open a file read-only with mode 0666.
856         $fd = POSIX::open( "foo" );
858 Open a file for read and write.
860         $fd = POSIX::open( "foo", &POSIX::O_RDWR );
862 Open a file for write, with truncation.
864         $fd = POSIX::open( "foo", &POSIX::O_WRONLY | &POSIX::O_TRUNC );
866 Create a new file with mode 0640.  Set up the file for writing.
868         $fd = POSIX::open( "foo", &POSIX::O_CREAT | &POSIX::O_WRONLY, 0640 );
870 Returns C<undef> on failure.
872 See also L<perlfunc/sysopen>.
874 =item opendir
876 Open a directory for reading.
878         $dir = POSIX::opendir( "/tmp" );
879         @files = POSIX::readdir( $dir );
880         POSIX::closedir( $dir );
882 Returns C<undef> on failure.
884 =item pathconf
886 Retrieves the value of a configurable limit on a file or directory.
888 The following will determine the maximum length of the longest allowable
889 pathname on the filesystem which holds C</tmp>.
891         $path_max = POSIX::pathconf( "/tmp", &POSIX::_PC_PATH_MAX );
893 Returns C<undef> on failure.
895 =item pause
897 This is similar to the C function C<pause()>, which suspends
898 the execution of the current process until a signal is received.
900 Returns C<undef> on failure.
902 =item perror
904 This is identical to the C function C<perror()>, which outputs to the
905 standard error stream the specified message followed by ": " and the
906 current error string.  Use the C<warn()> function and the C<$!>
907 variable instead, see L<perlfunc/warn> and L<perlvar/$ERRNO>.
909 =item pipe
911 Create an interprocess channel.  This returns file descriptors like those
912 returned by C<POSIX::open>.
914         ($fd0, $fd1) = POSIX::pipe();
915         POSIX::write( $fd0, "hello", 5 );
916         POSIX::read( $fd1, $buf, 5 );
918 See also L<perlfunc/pipe>.
920 =item pow
922 Computes C<$x> raised to the power C<$exponent>.
924         $ret = POSIX::pow( $x, $exponent );
926 You can also use the C<**> operator, see L<perlop>.
928 =item printf
930 Formats and prints the specified arguments to STDOUT.
931 See also L<perlfunc/printf>.
933 =item putc
935 putc() is C-specific, see L<perlfunc/print> instead.
937 =item putchar
939 putchar() is C-specific, see L<perlfunc/print> instead.
941 =item puts
943 puts() is C-specific, see L<perlfunc/print> instead.
945 =item qsort
947 qsort() is C-specific, see L<perlfunc/sort> instead.
949 =item raise
951 Sends the specified signal to the current process.
952 See also L<perlfunc/kill> and the C<$$> in L<perlvar/$PID>.
954 =item rand
956 C<rand()> is non-portable, see L<perlfunc/rand> instead.
958 =item read
960 Read from a file.  This uses file descriptors such as those obtained by
961 calling C<POSIX::open>.  If the buffer C<$buf> is not large enough for the
962 read then Perl will extend it to make room for the request.
964         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
965         $bytes = POSIX::read( $fd, $buf, 3 );
967 Returns C<undef> on failure.
969 See also L<perlfunc/sysread>.
971 =item readdir
973 This is identical to Perl's builtin C<readdir()> function
974 for reading directory entries, see L<perlfunc/readdir>.
976 =item realloc
978 realloc() is C-specific.  Perl does memory management transparently.
980 =item remove
982 This is identical to Perl's builtin C<unlink()> function
983 for removing files, see L<perlfunc/unlink>.
985 =item rename
987 This is identical to Perl's builtin C<rename()> function
988 for renaming files, see L<perlfunc/rename>.
990 =item rewind
992 Seeks to the beginning of the file.
994 =item rewinddir
996 This is identical to Perl's builtin C<rewinddir()> function for
997 rewinding directory entry streams, see L<perlfunc/rewinddir>.
999 =item rmdir
1001 This is identical to Perl's builtin C<rmdir()> function
1002 for removing (empty) directories, see L<perlfunc/rmdir>.
1004 =item scanf
1006 scanf() is C-specific, use E<lt>E<gt> and regular expressions instead,
1007 see L<perlre>.
1009 =item setgid
1011 Sets the real group identifier for this process.
1012 Identical to assigning a value to the Perl's builtin C<$)> variable,
1013 see L<perlvar/$UID>.
1015 =item setjmp
1017 C<setjmp()> is C-specific: use C<eval {}> instead,
1018 see L<perlfunc/eval>.
1020 =item setlocale
1022 Modifies and queries program's locale.  The following examples assume
1024         use POSIX qw(setlocale LC_ALL LC_CTYPE);
1026 has been issued.
1028 The following will set the traditional UNIX system locale behavior
1029 (the second argument C<"C">).
1031         $loc = setlocale( LC_ALL, "C" );
1033 The following will query the current LC_CTYPE category.  (No second
1034 argument means 'query'.)
1036         $loc = setlocale( LC_CTYPE );
1038 The following will set the LC_CTYPE behaviour according to the locale
1039 environment variables (the second argument C<"">).
1040 Please see your systems L<setlocale(3)> documentation for the locale
1041 environment variables' meaning or consult L<perllocale>.
1043         $loc = setlocale( LC_CTYPE, "" );
1045 The following will set the LC_COLLATE behaviour to Argentinian
1046 Spanish. B<NOTE>: The naming and availability of locales depends on
1047 your operating system. Please consult L<perllocale> for how to find
1048 out which locales are available in your system.
1050         $loc = setlocale( LC_ALL, "es_AR.ISO8859-1" );
1052 =item setpgid
1054 This is similar to the C function C<setpgid()> for
1055 setting the process group identifier of the current process.
1057 Returns C<undef> on failure.
1059 =item setsid
1061 This is identical to the C function C<setsid()> for
1062 setting the session identifier of the current process.
1064 =item setuid
1066 Sets the real user identifier for this process.
1067 Identical to assigning a value to the Perl's builtin C<$E<lt>> variable,
1068 see L<perlvar/$UID>.
1070 =item sigaction
1072 Detailed signal management.  This uses C<POSIX::SigAction> objects for the
1073 C<action> and C<oldaction> arguments.  Consult your system's C<sigaction>
1074 manpage for details.
1076 Synopsis:
1078         sigaction(sig, action, oldaction = 0)
1080 Returns C<undef> on failure.
1082 =item siglongjmp
1084 siglongjmp() is C-specific: use L<perlfunc/die> instead.
1086 =item sigpending
1088 Examine signals that are blocked and pending.  This uses C<POSIX::SigSet>
1089 objects for the C<sigset> argument.  Consult your system's C<sigpending>
1090 manpage for details.
1092 Synopsis:
1094         sigpending(sigset)
1096 Returns C<undef> on failure.
1098 =item sigprocmask
1100 Change and/or examine calling process's signal mask.  This uses
1101 C<POSIX::SigSet> objects for the C<sigset> and C<oldsigset> arguments.
1102 Consult your system's C<sigprocmask> manpage for details.
1104 Synopsis:
1106         sigprocmask(how, sigset, oldsigset = 0)
1108 Returns C<undef> on failure.
1110 =item sigsetjmp
1112 C<sigsetjmp()> is C-specific: use C<eval {}> instead,
1113 see L<perlfunc/eval>.
1115 =item sigsuspend
1117 Install a signal mask and suspend process until signal arrives.  This uses
1118 C<POSIX::SigSet> objects for the C<signal_mask> argument.  Consult your
1119 system's C<sigsuspend> manpage for details.
1121 Synopsis:
1123         sigsuspend(signal_mask)
1125 Returns C<undef> on failure.
1127 =item sin
1129 This is identical to Perl's builtin C<sin()> function
1130 for returning the sine of the numerical argument,
1131 see L<perlfunc/sin>.  See also L<Math::Trig>.
1133 =item sinh
1135 This is identical to the C function C<sinh()>
1136 for returning the hyperbolic sine of the numerical argument.
1137 See also L<Math::Trig>.
1139 =item sleep
1141 This is identical to Perl's builtin C<sleep()> function
1142 for suspending the execution of the current for process
1143 for certain number of seconds, see L<perlfunc/sleep>.
1145 =item sprintf
1147 This is similar to Perl's builtin C<sprintf()> function
1148 for returning a string that has the arguments formatted as requested,
1149 see L<perlfunc/sprintf>.
1151 =item sqrt
1153 This is identical to Perl's builtin C<sqrt()> function.
1154 for returning the square root of the numerical argument,
1155 see L<perlfunc/sqrt>.
1157 =item srand
1159 Give a seed the pseudorandom number generator, see L<perlfunc/srand>.
1161 =item sscanf
1163 sscanf() is C-specific, use regular expressions instead,
1164 see L<perlre>.
1166 =item stat
1168 This is identical to Perl's builtin C<stat()> function
1169 for retutning information about files and directories.
1171 =item strcat
1173 strcat() is C-specific, use C<.=> instead, see L<perlop>.
1175 =item strchr
1177 strchr() is C-specific, see L<perlfunc/index> instead.
1179 =item strcmp
1181 strcmp() is C-specific, use C<eq> or C<cmp> instead, see L<perlop>.
1183 =item strcoll
1185 This is identical to the C function C<strcoll()>
1186 for collating (comparing) strings transformed using
1187 the C<strxfrm()> function.  Not really needed since
1188 Perl can do this transparently, see L<perllocale>.
1190 =item strcpy
1192 strcpy() is C-specific, use C<=> instead, see L<perlop>.
1194 =item strcspn
1196 strcspn() is C-specific, use regular expressions instead,
1197 see L<perlre>.
1199 =item strerror
1201 Returns the error string for the specified errno.
1202 Identical to the string form of the C<$!>, see L<perlvar/$ERRNO>.
1204 =item strftime
1206 Convert date and time information to string.  Returns the string.
1208 Synopsis:
1210         strftime(fmt, sec, min, hour, mday, mon, year, wday = -1, yday = -1, isdst = -1)
1212 The month (C<mon>), weekday (C<wday>), and yearday (C<yday>) begin at zero.
1213 I.e. January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1.  The
1214 year (C<year>) is given in years since 1900.  I.e., the year 1995 is 95; the
1215 year 2001 is 101.  Consult your system's C<strftime()> manpage for details
1216 about these and the other arguments.
1217 If you want your code to be portable, your format (C<fmt>) argument
1218 should use only the conversion specifiers defined by the ANSI C
1219 standard.  These are C<aAbBcdHIjmMpSUwWxXyYZ%>.
1220 The given arguments are made consistent
1221 as though by calling C<mktime()> before calling your system's
1222 C<strftime()> function, except that the C<isdst> value is not affected.
1224 The string for Tuesday, December 12, 1995.
1226         $str = POSIX::strftime( "%A, %B %d, %Y", 0, 0, 0, 12, 11, 95, 2 );
1227         print "$str\n";
1229 =item strlen
1231 strlen() is C-specific, use C<length()> instead, see L<perlfunc/length>.
1233 =item strncat
1235 strncat() is C-specific, use C<.=> instead, see L<perlop>.
1237 =item strncmp
1239 strncmp() is C-specific, use C<eq> instead, see L<perlop>.
1241 =item strncpy
1243 strncpy() is C-specific, use C<=> instead, see L<perlop>.
1245 =item strpbrk
1247 strpbrk() is C-specific, use regular expressions instead,
1248 see L<perlre>.
1250 =item strrchr
1252 strrchr() is C-specific, see L<perlfunc/rindex> instead.
1254 =item strspn
1256 strspn() is C-specific, use regular expressions instead,
1257 see L<perlre>.
1259 =item strstr
1261 This is identical to Perl's builtin C<index()> function,
1262 see L<perlfunc/index>.
1264 =item strtod
1266 String to double translation. Returns the parsed number and the number
1267 of characters in the unparsed portion of the string.  Truly
1268 POSIX-compliant systems set $! ($ERRNO) to indicate a translation
1269 error, so clear $! before calling strtod.  However, non-POSIX systems
1270 may not check for overflow, and therefore will never set $!.
1272 strtod should respect any POSIX I<setlocale()> settings.
1274 To parse a string $str as a floating point number use
1276     $! = 0;
1277     ($num, $n_unparsed) = POSIX::strtod($str);
1279 The second returned item and $! can be used to check for valid input:
1281     if (($str eq '') || ($n_unparsed != 0) || !$!) {
1282         die "Non-numeric input $str" . $! ? ": $!\n" : "\n";
1283     }
1285 When called in a scalar context strtod returns the parsed number.
1287 =item strtok
1289 strtok() is C-specific, use regular expressions instead, see
1290 L<perlre>, or L<perlfunc/split>.
1292 =item strtol
1294 String to (long) integer translation.  Returns the parsed number and
1295 the number of characters in the unparsed portion of the string.  Truly
1296 POSIX-compliant systems set $! ($ERRNO) to indicate a translation
1297 error, so clear $! before calling strtol.  However, non-POSIX systems
1298 may not check for overflow, and therefore will never set $!.
1300 strtol should respect any POSIX I<setlocale()> settings.
1302 To parse a string $str as a number in some base $base use
1304     $! = 0;
1305     ($num, $n_unparsed) = POSIX::strtol($str, $base);
1307 The base should be zero or between 2 and 36, inclusive.  When the base
1308 is zero or omitted strtol will use the string itself to determine the
1309 base: a leading "0x" or "0X" means hexadecimal; a leading "0" means
1310 octal; any other leading characters mean decimal.  Thus, "1234" is
1311 parsed as a decimal number, "01234" as an octal number, and "0x1234"
1312 as a hexadecimal number.
1314 The second returned item and $! can be used to check for valid input:
1316     if (($str eq '') || ($n_unparsed != 0) || !$!) {
1317         die "Non-numeric input $str" . $! ? ": $!\n" : "\n";
1318     }
1320 When called in a scalar context strtol returns the parsed number.
1322 =item strtoul
1324 String to unsigned (long) integer translation.  strtoul() is identical
1325 to strtol() except that strtoul() only parses unsigned integers.  See
1326 L</strtol> for details.
1328 Note: Some vendors supply strtod() and strtol() but not strtoul().
1329 Other vendors that do supply strtoul() parse "-1" as a valid value.
1331 =item strxfrm
1333 String transformation.  Returns the transformed string.
1335         $dst = POSIX::strxfrm( $src );
1337 Used in conjunction with the C<strcoll()> function, see L</strcoll>.
1339 Not really needed since Perl can do this transparently, see
1340 L<perllocale>.
1342 =item sysconf
1344 Retrieves values of system configurable variables.
1346 The following will get the machine's clock speed.
1348         $clock_ticks = POSIX::sysconf( &POSIX::_SC_CLK_TCK );
1350 Returns C<undef> on failure.
1352 =item system
1354 This is identical to Perl's builtin C<system()> function, see
1355 L<perlfunc/system>.
1357 =item tan
1359 This is identical to the C function C<tan()>, returning the
1360 tangent of the numerical argument.  See also L<Math::Trig>.
1362 =item tanh
1364 This is identical to the C function C<tanh()>, returning the
1365 hyperbolic tangent of the numerical argument.   See also L<Math::Trig>.
1367 =item tcdrain
1369 This is similar to the C function C<tcdrain()> for draining
1370 the output queue of its argument stream.
1372 Returns C<undef> on failure.
1374 =item tcflow
1376 This is similar to the C function C<tcflow()> for controlling
1377 the flow of its argument stream.
1379 Returns C<undef> on failure.
1381 =item tcflush
1383 This is similar to the C function C<tcflush()> for flushing
1384 the I/O buffers of its argumeny stream.
1386 Returns C<undef> on failure.
1388 =item tcgetpgrp
1390 This is identical to the C function C<tcgetpgrp()> for returning the
1391 process group identifier of the foreground process group of the controlling
1392 terminal.
1394 =item tcsendbreak
1396 This is similar to the C function C<tcsendbreak()> for sending
1397 a break on its argument stream.
1399 Returns C<undef> on failure.
1401 =item tcsetpgrp
1403 This is similar to the C function C<tcsetpgrp()> for setting the
1404 process group identifier of the foreground process group of the controlling
1405 terminal.
1407 Returns C<undef> on failure.
1409 =item time
1411 This is identical to Perl's builtin C<time()> function
1412 for returning the number of seconds since the epoch
1413 (whatever it is for the system), see L<perlfunc/time>.
1415 =item times
1417 The times() function returns elapsed realtime since some point in the past
1418 (such as system startup), user and system times for this process, and user
1419 and system times used by child processes.  All times are returned in clock
1420 ticks.
1422     ($realtime, $user, $system, $cuser, $csystem) = POSIX::times();
1424 Note: Perl's builtin C<times()> function returns four values, measured in
1425 seconds.
1427 =item tmpfile
1429 Use method C<IO::File::new_tmpfile()> instead, or see L<File::Temp>.
1431 =item tmpnam
1433 Returns a name for a temporary file.
1435         $tmpfile = POSIX::tmpnam();
1437 For security reasons, which are probably detailed in your system's
1438 documentation for the C library tmpnam() function, this interface
1439 should not be used; instead see L<File::Temp>.
1441 =item tolower
1443 This is identical to the C function, except that it can apply to a single
1444 character or to a whole string.  Consider using the C<lc()> function,
1445 see L<perlfunc/lc>, or the equivalent C<\L> operator inside doublequotish
1446 strings.
1448 =item toupper
1450 This is identical to the C function, except that it can apply to a single
1451 character or to a whole string.  Consider using the C<uc()> function,
1452 see L<perlfunc/uc>, or the equivalent C<\U> operator inside doublequotish
1453 strings.
1455 =item ttyname
1457 This is identical to the C function C<ttyname()> for returning the
1458 name of the current terminal.
1460 =item tzname
1462 Retrieves the time conversion information from the C<tzname> variable.
1464         POSIX::tzset();
1465         ($std, $dst) = POSIX::tzname();
1467 =item tzset
1469 This is identical to the C function C<tzset()> for setting
1470 the current timezone based on the environment variable C<TZ>,
1471 to be used by C<ctime()>, C<localtime()>, C<mktime()>, and C<strftime()>
1472 functions.
1474 =item umask
1476 This is identical to Perl's builtin C<umask()> function
1477 for setting (and querying) the file creation permission mask,
1478 see L<perlfunc/umask>.
1480 =item uname
1482 Get name of current operating system.
1484         ($sysname, $nodename, $release, $version, $machine) = POSIX::uname();
1486 Note that the actual meanings of the various fields are not
1487 that well standardized, do not expect any great portability.
1488 The C<$sysname> might be the name of the operating system,
1489 the C<$nodename> might be the name of the host, the C<$release>
1490 might be the (major) release number of the operating system,
1491 the C<$version> might be the (minor) release number of the
1492 operating system, and the C<$machine> might be a hardware identifier.
1493 Maybe.
1495 =item ungetc
1497 Use method C<IO::Handle::ungetc()> instead.
1499 =item unlink
1501 This is identical to Perl's builtin C<unlink()> function
1502 for removing files, see L<perlfunc/unlink>.
1504 =item utime
1506 This is identical to Perl's builtin C<utime()> function
1507 for changing the time stamps of files and directories,
1508 see L<perlfunc/utime>.
1510 =item vfprintf
1512 vfprintf() is C-specific, see L<perlfunc/printf> instead.
1514 =item vprintf
1516 vprintf() is C-specific, see L<perlfunc/printf> instead.
1518 =item vsprintf
1520 vsprintf() is C-specific, see L<perlfunc/sprintf> instead.
1522 =item wait
1524 This is identical to Perl's builtin C<wait()> function,
1525 see L<perlfunc/wait>.
1527 =item waitpid
1529 Wait for a child process to change state.  This is identical to Perl's
1530 builtin C<waitpid()> function, see L<perlfunc/waitpid>.
1532         $pid = POSIX::waitpid( -1, &POSIX::WNOHANG );
1533         print "status = ", ($? / 256), "\n";
1535 =item wcstombs
1537 This is identical to the C function C<wcstombs()>.
1538 Perl does not have any support for the wide and multibyte
1539 characters of the C standards, so this might be a rather 
1540 useless function.
1542 =item wctomb
1544 This is identical to the C function C<wctomb()>.
1545 Perl does not have any support for the wide and multibyte
1546 characters of the C standards, so this might be a rather 
1547 useless function.
1549 =item write
1551 Write to a file.  This uses file descriptors such as those obtained by
1552 calling C<POSIX::open>.
1554         $fd = POSIX::open( "foo", &POSIX::O_WRONLY );
1555         $buf = "hello";
1556         $bytes = POSIX::write( $b, $buf, 5 );
1558 Returns C<undef> on failure.
1560 See also L<perlfunc/syswrite>.
1562 =back
1564 =head1 CLASSES
1566 =head2 POSIX::SigAction
1568 =over 8
1570 =item new
1572 Creates a new C<POSIX::SigAction> object which corresponds to the C
1573 C<struct sigaction>.  This object will be destroyed automatically when it is
1574 no longer needed.  The first parameter is the fully-qualified name of a sub
1575 which is a signal-handler.  The second parameter is a C<POSIX::SigSet>
1576 object, it defaults to the empty set.  The third parameter contains the
1577 C<sa_flags>, it defaults to 0.
1579         $sigset = POSIX::SigSet->new(SIGINT, SIGQUIT);
1580         $sigaction = POSIX::SigAction->new( 'main::handler', $sigset, &POSIX::SA_NOCLDSTOP );
1582 This C<POSIX::SigAction> object should be used with the C<POSIX::sigaction()>
1583 function.
1585 =back
1587 =head2 POSIX::SigSet
1589 =over 8
1591 =item new
1593 Create a new SigSet object.  This object will be destroyed automatically
1594 when it is no longer needed.  Arguments may be supplied to initialize the
1595 set.
1597 Create an empty set.
1599         $sigset = POSIX::SigSet->new;
1601 Create a set with SIGUSR1.
1603         $sigset = POSIX::SigSet->new( &POSIX::SIGUSR1 );
1605 =item addset
1607 Add a signal to a SigSet object.
1609         $sigset->addset( &POSIX::SIGUSR2 );
1611 Returns C<undef> on failure.
1613 =item delset
1615 Remove a signal from the SigSet object.
1617         $sigset->delset( &POSIX::SIGUSR2 );
1619 Returns C<undef> on failure.
1621 =item emptyset
1623 Initialize the SigSet object to be empty.
1625         $sigset->emptyset();
1627 Returns C<undef> on failure.
1629 =item fillset
1631 Initialize the SigSet object to include all signals.
1633         $sigset->fillset();
1635 Returns C<undef> on failure.
1637 =item ismember
1639 Tests the SigSet object to see if it contains a specific signal.
1641         if( $sigset->ismember( &POSIX::SIGUSR1 ) ){
1642                 print "contains SIGUSR1\n";
1643         }
1645 =back
1647 =head2 POSIX::Termios
1649 =over 8
1651 =item new
1653 Create a new Termios object.  This object will be destroyed automatically
1654 when it is no longer needed.  A Termios object corresponds to the termios
1655 C struct.  new() mallocs a new one, getattr() fills it from a file descriptor,
1656 and setattr() sets a file descriptor's parameters to match Termios' contents.
1658         $termios = POSIX::Termios->new;
1660 =item getattr
1662 Get terminal control attributes.
1664 Obtain the attributes for stdin.
1666         $termios->getattr()
1668 Obtain the attributes for stdout.
1670         $termios->getattr( 1 )
1672 Returns C<undef> on failure.
1674 =item getcc
1676 Retrieve a value from the c_cc field of a termios object.  The c_cc field is
1677 an array so an index must be specified.
1679         $c_cc[1] = $termios->getcc(1);
1681 =item getcflag
1683 Retrieve the c_cflag field of a termios object.
1685         $c_cflag = $termios->getcflag;
1687 =item getiflag
1689 Retrieve the c_iflag field of a termios object.
1691         $c_iflag = $termios->getiflag;
1693 =item getispeed
1695 Retrieve the input baud rate.
1697         $ispeed = $termios->getispeed;
1699 =item getlflag
1701 Retrieve the c_lflag field of a termios object.
1703         $c_lflag = $termios->getlflag;
1705 =item getoflag
1707 Retrieve the c_oflag field of a termios object.
1709         $c_oflag = $termios->getoflag;
1711 =item getospeed
1713 Retrieve the output baud rate.
1715         $ospeed = $termios->getospeed;
1717 =item setattr
1719 Set terminal control attributes.
1721 Set attributes immediately for stdout.
1723         $termios->setattr( 1, &POSIX::TCSANOW );
1725 Returns C<undef> on failure.
1727 =item setcc
1729 Set a value in the c_cc field of a termios object.  The c_cc field is an
1730 array so an index must be specified.
1732         $termios->setcc( &POSIX::VEOF, 1 );
1734 =item setcflag
1736 Set the c_cflag field of a termios object.
1738         $termios->setcflag( $c_cflag | &POSIX::CLOCAL );
1740 =item setiflag
1742 Set the c_iflag field of a termios object.
1744         $termios->setiflag( $c_iflag | &POSIX::BRKINT );
1746 =item setispeed
1748 Set the input baud rate.
1750         $termios->setispeed( &POSIX::B9600 );
1752 Returns C<undef> on failure.
1754 =item setlflag
1756 Set the c_lflag field of a termios object.
1758         $termios->setlflag( $c_lflag | &POSIX::ECHO );
1760 =item setoflag
1762 Set the c_oflag field of a termios object.
1764         $termios->setoflag( $c_oflag | &POSIX::OPOST );
1766 =item setospeed
1768 Set the output baud rate.
1770         $termios->setospeed( &POSIX::B9600 );
1772 Returns C<undef> on failure.
1774 =item Baud rate values
1776 B38400 B75 B200 B134 B300 B1800 B150 B0 B19200 B1200 B9600 B600 B4800 B50 B2400 B110
1778 =item Terminal interface values
1780 TCSADRAIN TCSANOW TCOON TCIOFLUSH TCOFLUSH TCION TCIFLUSH TCSAFLUSH TCIOFF TCOOFF
1782 =item c_cc field values
1784 VEOF VEOL VERASE VINTR VKILL VQUIT VSUSP VSTART VSTOP VMIN VTIME NCCS
1786 =item c_cflag field values
1788 CLOCAL CREAD CSIZE CS5 CS6 CS7 CS8 CSTOPB HUPCL PARENB PARODD
1790 =item c_iflag field values
1792 BRKINT ICRNL IGNBRK IGNCR IGNPAR INLCR INPCK ISTRIP IXOFF IXON PARMRK
1794 =item c_lflag field values
1796 ECHO ECHOE ECHOK ECHONL ICANON IEXTEN ISIG NOFLSH TOSTOP
1798 =item c_oflag field values
1800 OPOST
1802 =back
1804 =head1 PATHNAME CONSTANTS
1806 =over 8
1808 =item Constants
1810 _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
1812 =back
1814 =head1 POSIX CONSTANTS
1816 =over 8
1818 =item Constants
1820 _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
1822 =back
1824 =head1 SYSTEM CONFIGURATION
1826 =over 8
1828 =item Constants
1830 _SC_ARG_MAX _SC_CHILD_MAX _SC_CLK_TCK _SC_JOB_CONTROL _SC_NGROUPS_MAX _SC_OPEN_MAX _SC_SAVED_IDS _SC_STREAM_MAX _SC_TZNAME_MAX _SC_VERSION
1832 =back
1834 =head1 ERRNO
1836 =over 8
1838 =item Constants
1840 E2BIG EACCES EADDRINUSE EADDRNOTAVAIL EAFNOSUPPORT EAGAIN EALREADY EBADF
1841 EBUSY ECHILD ECONNABORTED ECONNREFUSED ECONNRESET EDEADLK EDESTADDRREQ
1842 EDOM EDQUOT EEXIST EFAULT EFBIG EHOSTDOWN EHOSTUNREACH EINPROGRESS EINTR
1843 EINVAL EIO EISCONN EISDIR ELOOP EMFILE EMLINK EMSGSIZE ENAMETOOLONG
1844 ENETDOWN ENETRESET ENETUNREACH ENFILE ENOBUFS ENODEV ENOENT ENOEXEC
1845 ENOLCK ENOMEM ENOPROTOOPT ENOSPC ENOSYS ENOTBLK ENOTCONN ENOTDIR
1846 ENOTEMPTY ENOTSOCK ENOTTY ENXIO EOPNOTSUPP EPERM EPFNOSUPPORT EPIPE
1847 EPROCLIM EPROTONOSUPPORT EPROTOTYPE ERANGE EREMOTE ERESTART EROFS
1848 ESHUTDOWN ESOCKTNOSUPPORT ESPIPE ESRCH ESTALE ETIMEDOUT ETOOMANYREFS
1849 ETXTBSY EUSERS EWOULDBLOCK EXDEV
1851 =back
1853 =head1 FCNTL
1855 =over 8
1857 =item Constants
1859 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
1861 =back
1863 =head1 FLOAT
1865 =over 8
1867 =item Constants
1869 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
1871 =back
1873 =head1 LIMITS
1875 =over 8
1877 =item Constants
1879 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
1881 =back
1883 =head1 LOCALE
1885 =over 8
1887 =item Constants
1889 LC_ALL LC_COLLATE LC_CTYPE LC_MONETARY LC_NUMERIC LC_TIME
1891 =back
1893 =head1 MATH
1895 =over 8
1897 =item Constants
1899 HUGE_VAL
1901 =back
1903 =head1 SIGNAL
1905 =over 8
1907 =item Constants
1909 SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK SA_RESETHAND SA_RESTART
1910 SA_SIGINFO SIGABRT SIGALRM SIGCHLD SIGCONT SIGFPE SIGHUP SIGILL SIGINT
1911 SIGKILL SIGPIPE SIGQUIT SIGSEGV SIGSTOP SIGTERM SIGTSTP SIGTTIN SIGTTOU
1912 SIGUSR1 SIGUSR2 SIG_BLOCK SIG_DFL SIG_ERR SIG_IGN SIG_SETMASK
1913 SIG_UNBLOCK
1915 =back
1917 =head1 STAT
1919 =over 8
1921 =item Constants
1923 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
1925 =item Macros
1927 S_ISBLK S_ISCHR S_ISDIR S_ISFIFO S_ISREG
1929 =back
1931 =head1 STDLIB
1933 =over 8
1935 =item Constants
1937 EXIT_FAILURE EXIT_SUCCESS MB_CUR_MAX RAND_MAX
1939 =back
1941 =head1 STDIO
1943 =over 8
1945 =item Constants
1947 BUFSIZ EOF FILENAME_MAX L_ctermid L_cuserid L_tmpname TMP_MAX
1949 =back
1951 =head1 TIME
1953 =over 8
1955 =item Constants
1957 CLK_TCK CLOCKS_PER_SEC
1959 =back
1961 =head1 UNISTD
1963 =over 8
1965 =item Constants
1967 R_OK SEEK_CUR SEEK_END SEEK_SET STDIN_FILENO STDOUT_FILENO STDERR_FILENO W_OK X_OK
1969 =back
1971 =head1 WAIT
1973 =over 8
1975 =item Constants
1977 WNOHANG WUNTRACED
1979 =item Macros
1981 WIFEXITED WEXITSTATUS WIFSIGNALED WTERMSIG WIFSTOPPED WSTOPSIG
1983 =back