do, warn, use
[p5sagit/p5-mst-13.2.git] / 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 L<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 = modf($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</[[:isalnum:]]/> 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</[[:isalpha:]]/> 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</[[:iscntrl:]]/> 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</[[:isdigit:]]/> 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</[[:isgraph:]]/> 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</[[:islower:]]/> 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</[[:isprint:]]/> 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</[[:ispunct:]]/> 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</[[:isspace:]]/> construct instead, or the C</\s/> construct.
639
640 =item isupper
641
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/>.
645
646 =item isxdigit
647
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>.
651
652 =item kill
653
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>.
656
657 =item labs
658
659 (For returning absolute values of long integers.)
660 labs() is C-specific, see L<perlfunc/abs> instead.
661
662 =item ldexp
663
664 This is identical to the C function C<ldexp()>
665 for multiplying floating point numbers with powers of two.
666
667         $x_quadrupled = POSIX::ldexp($x, 2);
668
669 =item ldiv
670
671 (For computing dividends of long integers.)
672 ldiv() is C-specific, use C</> and C<int()> instead.
673
674 =item link
675
676 This is identical to Perl's builtin C<link()> function
677 for creating hard links into files, see L<perlfunc/link>.
678
679 =item localeconv
680
681 Get numeric formatting information.  Returns a reference to a hash
682 containing the current locale formatting values.
683
684 Here is how to query the database for the B<de> (Deutsch or German) locale.
685
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";
707
708 =item localtime
709
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>.
712
713 =item log
714
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>.
718
719 =item log10
720
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
724
725     sub log10 { log($_[0]) / log(10) }
726
727 or
728
729     sub log10 { log($_[0]) / 2.30258509299405 }  
730
731 or
732
733     sub log10 { log($_[0]) * 0.434294481903252 }
734
735 =item longjmp
736
737 longjmp() is C-specific: use L<perlfunc/die> instead.
738
739 =item lseek
740
741 Move the file's read/write position.  This uses file descriptors such as
742 those obtained by calling C<POSIX::open>.
743
744         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
745         $off_t = POSIX::lseek( $fd, 0, &POSIX::SEEK_SET );
746
747 Returns C<undef> on failure.
748
749 =item malloc
750
751 malloc() is C-specific.  Perl does memory management transparently.
752
753 =item mblen
754
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.
759
760 =item mbstowcs
761
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.
766
767 =item mbtowc
768
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.
773
774 =item memchr
775
776 memchr() is C-specific, see L<perlfunc/index> instead.
777
778 =item memcmp
779
780 memcmp() is C-specific, use C<eq> instead, see L<perlop>.
781
782 =item memcpy
783
784 memcpy() is C-specific, use C<=>, see L<perlop>, or see L<perlfunc/substr>.
785
786 =item memmove
787
788 memmove() is C-specific, use C<=>, see L<perlop>, or see L<perlfunc/substr>.
789
790 =item memset
791
792 memset() is C-specific, use C<x> instead, see L<perlop>.
793
794 =item mkdir
795
796 This is identical to Perl's builtin C<mkdir()> function
797 for creating directories, see L<perlfunc/mkdir>.
798
799 =item mkfifo
800
801 This is similar to the C function C<mkfifo()> for creating
802 FIFO special files.
803
804         if (mkfifo($path, $mode)) { ....
805
806 Returns C<undef> on failure.  The C<$mode> is similar to the
807 mode of C<mkdir()>, see L<perlfunc/mkdir>.
808
809 =item mktime
810
811 Convert date/time info to a calendar time.
812
813 Synopsis:
814
815         mktime(sec, min, hour, mday, mon, year, wday = 0, yday = 0, isdst = 0)
816
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.
822
823 Calendar time for December 12, 1995, at 10:30 am.
824
825         $time_t = POSIX::mktime( 0, 30, 10, 12, 11, 95 );
826         print "Date = ", POSIX::ctime($time_t);
827
828 Returns C<undef> on failure.
829
830 =item modf
831
832 Return the integral and fractional parts of a floating-point number.
833
834         ($fractional, $integral) = POSIX::modf( 3.14 );
835
836 =item nice
837
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.
842
843 Returns C<undef> on failure.
844
845 =item offsetof
846
847 offsetof() is C-specific, you probably want to see L<perlfunc/pack> instead.
848
849 =item open
850
851 Open a file for reading for writing.  This returns file descriptors, not
852 Perl filehandles.  Use C<POSIX::close> to close the file.
853
854 Open a file read-only with mode 0666.
855
856         $fd = POSIX::open( "foo" );
857
858 Open a file for read and write.
859
860         $fd = POSIX::open( "foo", &POSIX::O_RDWR );
861
862 Open a file for write, with truncation.
863
864         $fd = POSIX::open( "foo", &POSIX::O_WRONLY | &POSIX::O_TRUNC );
865
866 Create a new file with mode 0640.  Set up the file for writing.
867
868         $fd = POSIX::open( "foo", &POSIX::O_CREAT | &POSIX::O_WRONLY, 0640 );
869
870 Returns C<undef> on failure.
871
872 See also L<perlfunc/sysopen>.
873
874 =item opendir
875
876 Open a directory for reading.
877
878         $dir = POSIX::opendir( "/tmp" );
879         @files = POSIX::readdir( $dir );
880         POSIX::closedir( $dir );
881
882 Returns C<undef> on failure.
883
884 =item pathconf
885
886 Retrieves the value of a configurable limit on a file or directory.
887
888 The following will determine the maximum length of the longest allowable
889 pathname on the filesystem which holds C</tmp>.
890
891         $path_max = POSIX::pathconf( "/tmp", &POSIX::_PC_PATH_MAX );
892
893 Returns C<undef> on failure.
894
895 =item pause
896
897 This is similar to the C function C<pause()>, which suspends
898 the execution of the current process until a signal is received.
899
900 Returns C<undef> on failure.
901
902 =item perror
903
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>.
908
909 =item pipe
910
911 Create an interprocess channel.  This returns file descriptors like those
912 returned by C<POSIX::open>.
913
914         ($fd0, $fd1) = POSIX::pipe();
915         POSIX::write( $fd0, "hello", 5 );
916         POSIX::read( $fd1, $buf, 5 );
917
918 See also L<perlfunc/pipe>.
919
920 =item pow
921
922 Computes C<$x> raised to the power C<$exponent>.
923
924         $ret = POSIX::pow( $x, $exponent );
925
926 You can also use the C<**> operator, see L<perlop>.
927
928 =item printf
929
930 Formats and prints the specified arguments to STDOUT.
931 See also L<perlfunc/printf>.
932
933 =item putc
934
935 putc() is C-specific, see L<perlfunc/print> instead.
936
937 =item putchar
938
939 putchar() is C-specific, see L<perlfunc/print> instead.
940
941 =item puts
942
943 puts() is C-specific, see L<perlfunc/print> instead.
944
945 =item qsort
946
947 qsort() is C-specific, see L<perlfunc/sort> instead.
948
949 =item raise
950
951 Sends the specified signal to the current process.
952 See also L<perlfunc/kill> and the C<$$> in L<perlvar/$PID>.
953
954 =item rand
955
956 C<rand()> is non-portable, see L<perlfunc/rand> instead.
957
958 =item read
959
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.
963
964         $fd = POSIX::open( "foo", &POSIX::O_RDONLY );
965         $bytes = POSIX::read( $fd, $buf, 3 );
966
967 Returns C<undef> on failure.
968
969 See also L<perlfunc/sysread>.
970
971 =item readdir
972
973 This is identical to Perl's builtin C<readdir()> function
974 for reading directory entries, see L<perlfunc/readdir>.
975
976 =item realloc
977
978 realloc() is C-specific.  Perl does memory management transparently.
979
980 =item remove
981
982 This is identical to Perl's builtin C<unlink()> function
983 for removing files, see L<perlfunc/unlink>.
984
985 =item rename
986
987 This is identical to Perl's builtin C<rename()> function
988 for renaming files, see L<perlfunc/rename>.
989
990 =item rewind
991
992 Seeks to the beginning of the file.
993
994 =item rewinddir
995
996 This is identical to Perl's builtin C<rewinddir()> function for
997 rewinding directory entry streams, see L<perlfunc/rewinddir>.
998
999 =item rmdir
1000
1001 This is identical to Perl's builtin C<rmdir()> function
1002 for removing (empty) directories, see L<perlfunc/rmdir>.
1003
1004 =item scanf
1005
1006 scanf() is C-specific, use E<lt>E<gt> and regular expressions instead,
1007 see L<perlre>.
1008
1009 =item setgid
1010
1011 Sets the real group identifier and the effective group identifier for
1012 this process.  Similar to assigning a value to the Perl's builtin
1013 C<$)> variable, see L<perlvar/$GID>, except that the latter
1014 will change only the real user identifier, and that the setgid()
1015 uses only a single numeric argument, as opposed to a space-separated
1016 list of numbers.
1017
1018 =item setjmp
1019
1020 C<setjmp()> is C-specific: use C<eval {}> instead,
1021 see L<perlfunc/eval>.
1022
1023 =item setlocale
1024
1025 Modifies and queries program's locale.  The following examples assume
1026
1027         use POSIX qw(setlocale LC_ALL LC_CTYPE);
1028
1029 has been issued.
1030
1031 The following will set the traditional UNIX system locale behavior
1032 (the second argument C<"C">).
1033
1034         $loc = setlocale( LC_ALL, "C" );
1035
1036 The following will query the current LC_CTYPE category.  (No second
1037 argument means 'query'.)
1038
1039         $loc = setlocale( LC_CTYPE );
1040
1041 The following will set the LC_CTYPE behaviour according to the locale
1042 environment variables (the second argument C<"">).
1043 Please see your systems L<setlocale(3)> documentation for the locale
1044 environment variables' meaning or consult L<perllocale>.
1045
1046         $loc = setlocale( LC_CTYPE, "" );
1047
1048 The following will set the LC_COLLATE behaviour to Argentinian
1049 Spanish. B<NOTE>: The naming and availability of locales depends on
1050 your operating system. Please consult L<perllocale> for how to find
1051 out which locales are available in your system.
1052
1053         $loc = setlocale( LC_ALL, "es_AR.ISO8859-1" );
1054
1055 =item setpgid
1056
1057 This is similar to the C function C<setpgid()> for
1058 setting the process group identifier of the current process.
1059
1060 Returns C<undef> on failure.
1061
1062 =item setsid
1063
1064 This is identical to the C function C<setsid()> for
1065 setting the session identifier of the current process.
1066
1067 =item setuid
1068
1069 Sets the real user identifier and the effective user identifier for
1070 this process.  Similar to assigning a value to the Perl's builtin
1071 C<$E<lt>> variable, see L<perlvar/$UID>, except that the latter
1072 will change only the real user identifier.
1073
1074 =item sigaction
1075
1076 Detailed signal management.  This uses C<POSIX::SigAction> objects for the
1077 C<action> and C<oldaction> arguments.  Consult your system's C<sigaction>
1078 manpage for details.
1079
1080 Synopsis:
1081
1082         sigaction(sig, action, oldaction = 0)
1083
1084 Returns C<undef> on failure.
1085
1086 =item siglongjmp
1087
1088 siglongjmp() is C-specific: use L<perlfunc/die> instead.
1089
1090 =item sigpending
1091
1092 Examine signals that are blocked and pending.  This uses C<POSIX::SigSet>
1093 objects for the C<sigset> argument.  Consult your system's C<sigpending>
1094 manpage for details.
1095
1096 Synopsis:
1097
1098         sigpending(sigset)
1099
1100 Returns C<undef> on failure.
1101
1102 =item sigprocmask
1103
1104 Change and/or examine calling process's signal mask.  This uses
1105 C<POSIX::SigSet> objects for the C<sigset> and C<oldsigset> arguments.
1106 Consult your system's C<sigprocmask> manpage for details.
1107
1108 Synopsis:
1109
1110         sigprocmask(how, sigset, oldsigset = 0)
1111
1112 Returns C<undef> on failure.
1113
1114 =item sigsetjmp
1115
1116 C<sigsetjmp()> is C-specific: use C<eval {}> instead,
1117 see L<perlfunc/eval>.
1118
1119 =item sigsuspend
1120
1121 Install a signal mask and suspend process until signal arrives.  This uses
1122 C<POSIX::SigSet> objects for the C<signal_mask> argument.  Consult your
1123 system's C<sigsuspend> manpage for details.
1124
1125 Synopsis:
1126
1127         sigsuspend(signal_mask)
1128
1129 Returns C<undef> on failure.
1130
1131 =item sin
1132
1133 This is identical to Perl's builtin C<sin()> function
1134 for returning the sine of the numerical argument,
1135 see L<perlfunc/sin>.  See also L<Math::Trig>.
1136
1137 =item sinh
1138
1139 This is identical to the C function C<sinh()>
1140 for returning the hyperbolic sine of the numerical argument.
1141 See also L<Math::Trig>.
1142
1143 =item sleep
1144
1145 This is identical to Perl's builtin C<sleep()> function
1146 for suspending the execution of the current for process
1147 for certain number of seconds, see L<perlfunc/sleep>.
1148
1149 =item sprintf
1150
1151 This is similar to Perl's builtin C<sprintf()> function
1152 for returning a string that has the arguments formatted as requested,
1153 see L<perlfunc/sprintf>.
1154
1155 =item sqrt
1156
1157 This is identical to Perl's builtin C<sqrt()> function.
1158 for returning the square root of the numerical argument,
1159 see L<perlfunc/sqrt>.
1160
1161 =item srand
1162
1163 Give a seed the pseudorandom number generator, see L<perlfunc/srand>.
1164
1165 =item sscanf
1166
1167 sscanf() is C-specific, use regular expressions instead,
1168 see L<perlre>.
1169
1170 =item stat
1171
1172 This is identical to Perl's builtin C<stat()> function
1173 for retutning information about files and directories.
1174
1175 =item strcat
1176
1177 strcat() is C-specific, use C<.=> instead, see L<perlop>.
1178
1179 =item strchr
1180
1181 strchr() is C-specific, see L<perlfunc/index> instead.
1182
1183 =item strcmp
1184
1185 strcmp() is C-specific, use C<eq> or C<cmp> instead, see L<perlop>.
1186
1187 =item strcoll
1188
1189 This is identical to the C function C<strcoll()>
1190 for collating (comparing) strings transformed using
1191 the C<strxfrm()> function.  Not really needed since
1192 Perl can do this transparently, see L<perllocale>.
1193
1194 =item strcpy
1195
1196 strcpy() is C-specific, use C<=> instead, see L<perlop>.
1197
1198 =item strcspn
1199
1200 strcspn() is C-specific, use regular expressions instead,
1201 see L<perlre>.
1202
1203 =item strerror
1204
1205 Returns the error string for the specified errno.
1206 Identical to the string form of the C<$!>, see L<perlvar/$ERRNO>.
1207
1208 =item strftime
1209
1210 Convert date and time information to string.  Returns the string.
1211
1212 Synopsis:
1213
1214         strftime(fmt, sec, min, hour, mday, mon, year, wday = -1, yday = -1, isdst = -1)
1215
1216 The month (C<mon>), weekday (C<wday>), and yearday (C<yday>) begin at zero.
1217 I.e. January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1.  The
1218 year (C<year>) is given in years since 1900.  I.e., the year 1995 is 95; the
1219 year 2001 is 101.  Consult your system's C<strftime()> manpage for details
1220 about these and the other arguments.
1221 If you want your code to be portable, your format (C<fmt>) argument
1222 should use only the conversion specifiers defined by the ANSI C
1223 standard.  These are C<aAbBcdHIjmMpSUwWxXyYZ%>.
1224 The given arguments are made consistent
1225 as though by calling C<mktime()> before calling your system's
1226 C<strftime()> function, except that the C<isdst> value is not affected.
1227
1228 The string for Tuesday, December 12, 1995.
1229
1230         $str = POSIX::strftime( "%A, %B %d, %Y", 0, 0, 0, 12, 11, 95, 2 );
1231         print "$str\n";
1232
1233 =item strlen
1234
1235 strlen() is C-specific, use C<length()> instead, see L<perlfunc/length>.
1236
1237 =item strncat
1238
1239 strncat() is C-specific, use C<.=> instead, see L<perlop>.
1240
1241 =item strncmp
1242
1243 strncmp() is C-specific, use C<eq> instead, see L<perlop>.
1244
1245 =item strncpy
1246
1247 strncpy() is C-specific, use C<=> instead, see L<perlop>.
1248
1249 =item strpbrk
1250
1251 strpbrk() is C-specific, use regular expressions instead,
1252 see L<perlre>.
1253
1254 =item strrchr
1255
1256 strrchr() is C-specific, see L<perlfunc/rindex> instead.
1257
1258 =item strspn
1259
1260 strspn() is C-specific, use regular expressions instead,
1261 see L<perlre>.
1262
1263 =item strstr
1264
1265 This is identical to Perl's builtin C<index()> function,
1266 see L<perlfunc/index>.
1267
1268 =item strtod
1269
1270 String to double translation. Returns the parsed number and the number
1271 of characters in the unparsed portion of the string.  Truly
1272 POSIX-compliant systems set $! ($ERRNO) to indicate a translation
1273 error, so clear $! before calling strtod.  However, non-POSIX systems
1274 may not check for overflow, and therefore will never set $!.
1275
1276 strtod should respect any POSIX I<setlocale()> settings.
1277
1278 To parse a string $str as a floating point number use
1279
1280     $! = 0;
1281     ($num, $n_unparsed) = POSIX::strtod($str);
1282
1283 The second returned item and $! can be used to check for valid input:
1284
1285     if (($str eq '') || ($n_unparsed != 0) || !$!) {
1286         die "Non-numeric input $str" . $! ? ": $!\n" : "\n";
1287     }
1288
1289 When called in a scalar context strtod returns the parsed number.
1290
1291 =item strtok
1292
1293 strtok() is C-specific, use regular expressions instead, see
1294 L<perlre>, or L<perlfunc/split>.
1295
1296 =item strtol
1297
1298 String to (long) integer translation.  Returns the parsed number and
1299 the number of characters in the unparsed portion of the string.  Truly
1300 POSIX-compliant systems set $! ($ERRNO) to indicate a translation
1301 error, so clear $! before calling strtol.  However, non-POSIX systems
1302 may not check for overflow, and therefore will never set $!.
1303
1304 strtol should respect any POSIX I<setlocale()> settings.
1305
1306 To parse a string $str as a number in some base $base use
1307
1308     $! = 0;
1309     ($num, $n_unparsed) = POSIX::strtol($str, $base);
1310
1311 The base should be zero or between 2 and 36, inclusive.  When the base
1312 is zero or omitted strtol will use the string itself to determine the
1313 base: a leading "0x" or "0X" means hexadecimal; a leading "0" means
1314 octal; any other leading characters mean decimal.  Thus, "1234" is
1315 parsed as a decimal number, "01234" as an octal number, and "0x1234"
1316 as a hexadecimal number.
1317
1318 The second returned item and $! can be used to check for valid input:
1319
1320     if (($str eq '') || ($n_unparsed != 0) || !$!) {
1321         die "Non-numeric input $str" . $! ? ": $!\n" : "\n";
1322     }
1323
1324 When called in a scalar context strtol returns the parsed number.
1325
1326 =item strtoul
1327
1328 String to unsigned (long) integer translation.  strtoul() is identical
1329 to strtol() except that strtoul() only parses unsigned integers.  See
1330 L</strtol> for details.
1331
1332 Note: Some vendors supply strtod() and strtol() but not strtoul().
1333 Other vendors that do supply strtoul() parse "-1" as a valid value.
1334
1335 =item strxfrm
1336
1337 String transformation.  Returns the transformed string.
1338
1339         $dst = POSIX::strxfrm( $src );
1340
1341 Used in conjunction with the C<strcoll()> function, see L</strcoll>.
1342
1343 Not really needed since Perl can do this transparently, see
1344 L<perllocale>.
1345
1346 =item sysconf
1347
1348 Retrieves values of system configurable variables.
1349
1350 The following will get the machine's clock speed.
1351
1352         $clock_ticks = POSIX::sysconf( &POSIX::_SC_CLK_TCK );
1353
1354 Returns C<undef> on failure.
1355
1356 =item system
1357
1358 This is identical to Perl's builtin C<system()> function, see
1359 L<perlfunc/system>.
1360
1361 =item tan
1362
1363 This is identical to the C function C<tan()>, returning the
1364 tangent of the numerical argument.  See also L<Math::Trig>.
1365
1366 =item tanh
1367
1368 This is identical to the C function C<tanh()>, returning the
1369 hyperbolic tangent of the numerical argument.   See also L<Math::Trig>.
1370
1371 =item tcdrain
1372
1373 This is similar to the C function C<tcdrain()> for draining
1374 the output queue of its argument stream.
1375
1376 Returns C<undef> on failure.
1377
1378 =item tcflow
1379
1380 This is similar to the C function C<tcflow()> for controlling
1381 the flow of its argument stream.
1382
1383 Returns C<undef> on failure.
1384
1385 =item tcflush
1386
1387 This is similar to the C function C<tcflush()> for flushing
1388 the I/O buffers of its argumeny stream.
1389
1390 Returns C<undef> on failure.
1391
1392 =item tcgetpgrp
1393
1394 This is identical to the C function C<tcgetpgrp()> for returning the
1395 process group identifier of the foreground process group of the controlling
1396 terminal.
1397
1398 =item tcsendbreak
1399
1400 This is similar to the C function C<tcsendbreak()> for sending
1401 a break on its argument stream.
1402
1403 Returns C<undef> on failure.
1404
1405 =item tcsetpgrp
1406
1407 This is similar to the C function C<tcsetpgrp()> for setting the
1408 process group identifier of the foreground process group of the controlling
1409 terminal.
1410
1411 Returns C<undef> on failure.
1412
1413 =item time
1414
1415 This is identical to Perl's builtin C<time()> function
1416 for returning the number of seconds since the epoch
1417 (whatever it is for the system), see L<perlfunc/time>.
1418
1419 =item times
1420
1421 The times() function returns elapsed realtime since some point in the past
1422 (such as system startup), user and system times for this process, and user
1423 and system times used by child processes.  All times are returned in clock
1424 ticks.
1425
1426     ($realtime, $user, $system, $cuser, $csystem) = POSIX::times();
1427
1428 Note: Perl's builtin C<times()> function returns four values, measured in
1429 seconds.
1430
1431 =item tmpfile
1432
1433 Use method C<IO::File::new_tmpfile()> instead, or see L<File::Temp>.
1434
1435 =item tmpnam
1436
1437 Returns a name for a temporary file.
1438
1439         $tmpfile = POSIX::tmpnam();
1440
1441 For security reasons, which are probably detailed in your system's
1442 documentation for the C library tmpnam() function, this interface
1443 should not be used; instead see L<File::Temp>.
1444
1445 =item tolower
1446
1447 This is identical to the C function, except that it can apply to a single
1448 character or to a whole string.  Consider using the C<lc()> function,
1449 see L<perlfunc/lc>, or the equivalent C<\L> operator inside doublequotish
1450 strings.
1451
1452 =item toupper
1453
1454 This is identical to the C function, except that it can apply to a single
1455 character or to a whole string.  Consider using the C<uc()> function,
1456 see L<perlfunc/uc>, or the equivalent C<\U> operator inside doublequotish
1457 strings.
1458
1459 =item ttyname
1460
1461 This is identical to the C function C<ttyname()> for returning the
1462 name of the current terminal.
1463
1464 =item tzname
1465
1466 Retrieves the time conversion information from the C<tzname> variable.
1467
1468         POSIX::tzset();
1469         ($std, $dst) = POSIX::tzname();
1470
1471 =item tzset
1472
1473 This is identical to the C function C<tzset()> for setting
1474 the current timezone based on the environment variable C<TZ>,
1475 to be used by C<ctime()>, C<localtime()>, C<mktime()>, and C<strftime()>
1476 functions.
1477
1478 =item umask
1479
1480 This is identical to Perl's builtin C<umask()> function
1481 for setting (and querying) the file creation permission mask,
1482 see L<perlfunc/umask>.
1483
1484 =item uname
1485
1486 Get name of current operating system.
1487
1488         ($sysname, $nodename, $release, $version, $machine) = POSIX::uname();
1489
1490 Note that the actual meanings of the various fields are not
1491 that well standardized, do not expect any great portability.
1492 The C<$sysname> might be the name of the operating system,
1493 the C<$nodename> might be the name of the host, the C<$release>
1494 might be the (major) release number of the operating system,
1495 the C<$version> might be the (minor) release number of the
1496 operating system, and the C<$machine> might be a hardware identifier.
1497 Maybe.
1498
1499 =item ungetc
1500
1501 Use method C<IO::Handle::ungetc()> instead.
1502
1503 =item unlink
1504
1505 This is identical to Perl's builtin C<unlink()> function
1506 for removing files, see L<perlfunc/unlink>.
1507
1508 =item utime
1509
1510 This is identical to Perl's builtin C<utime()> function
1511 for changing the time stamps of files and directories,
1512 see L<perlfunc/utime>.
1513
1514 =item vfprintf
1515
1516 vfprintf() is C-specific, see L<perlfunc/printf> instead.
1517
1518 =item vprintf
1519
1520 vprintf() is C-specific, see L<perlfunc/printf> instead.
1521
1522 =item vsprintf
1523
1524 vsprintf() is C-specific, see L<perlfunc/sprintf> instead.
1525
1526 =item wait
1527
1528 This is identical to Perl's builtin C<wait()> function,
1529 see L<perlfunc/wait>.
1530
1531 =item waitpid
1532
1533 Wait for a child process to change state.  This is identical to Perl's
1534 builtin C<waitpid()> function, see L<perlfunc/waitpid>.
1535
1536         $pid = POSIX::waitpid( -1, &POSIX::WNOHANG );
1537         print "status = ", ($? / 256), "\n";
1538
1539 =item wcstombs
1540
1541 This is identical to the C function C<wcstombs()>.
1542 Perl does not have any support for the wide and multibyte
1543 characters of the C standards, so this might be a rather 
1544 useless function.
1545
1546 =item wctomb
1547
1548 This is identical to the C function C<wctomb()>.
1549 Perl does not have any support for the wide and multibyte
1550 characters of the C standards, so this might be a rather 
1551 useless function.
1552
1553 =item write
1554
1555 Write to a file.  This uses file descriptors such as those obtained by
1556 calling C<POSIX::open>.
1557
1558         $fd = POSIX::open( "foo", &POSIX::O_WRONLY );
1559         $buf = "hello";
1560         $bytes = POSIX::write( $b, $buf, 5 );
1561
1562 Returns C<undef> on failure.
1563
1564 See also L<perlfunc/syswrite>.
1565
1566 =back
1567
1568 =head1 CLASSES
1569
1570 =head2 POSIX::SigAction
1571
1572 =over 8
1573
1574 =item new
1575
1576 Creates a new C<POSIX::SigAction> object which corresponds to the C
1577 C<struct sigaction>.  This object will be destroyed automatically when it is
1578 no longer needed.  The first parameter is the fully-qualified name of a sub
1579 which is a signal-handler.  The second parameter is a C<POSIX::SigSet>
1580 object, it defaults to the empty set.  The third parameter contains the
1581 C<sa_flags>, it defaults to 0.
1582
1583         $sigset = POSIX::SigSet->new(SIGINT, SIGQUIT);
1584         $sigaction = POSIX::SigAction->new( 'main::handler', $sigset, &POSIX::SA_NOCLDSTOP );
1585
1586 This C<POSIX::SigAction> object should be used with the C<POSIX::sigaction()>
1587 function.
1588
1589 =back
1590
1591 =head2 POSIX::SigSet
1592
1593 =over 8
1594
1595 =item new
1596
1597 Create a new SigSet object.  This object will be destroyed automatically
1598 when it is no longer needed.  Arguments may be supplied to initialize the
1599 set.
1600
1601 Create an empty set.
1602
1603         $sigset = POSIX::SigSet->new;
1604
1605 Create a set with SIGUSR1.
1606
1607         $sigset = POSIX::SigSet->new( &POSIX::SIGUSR1 );
1608
1609 =item addset
1610
1611 Add a signal to a SigSet object.
1612
1613         $sigset->addset( &POSIX::SIGUSR2 );
1614
1615 Returns C<undef> on failure.
1616
1617 =item delset
1618
1619 Remove a signal from the SigSet object.
1620
1621         $sigset->delset( &POSIX::SIGUSR2 );
1622
1623 Returns C<undef> on failure.
1624
1625 =item emptyset
1626
1627 Initialize the SigSet object to be empty.
1628
1629         $sigset->emptyset();
1630
1631 Returns C<undef> on failure.
1632
1633 =item fillset
1634
1635 Initialize the SigSet object to include all signals.
1636
1637         $sigset->fillset();
1638
1639 Returns C<undef> on failure.
1640
1641 =item ismember
1642
1643 Tests the SigSet object to see if it contains a specific signal.
1644
1645         if( $sigset->ismember( &POSIX::SIGUSR1 ) ){
1646                 print "contains SIGUSR1\n";
1647         }
1648
1649 =back
1650
1651 =head2 POSIX::Termios
1652
1653 =over 8
1654
1655 =item new
1656
1657 Create a new Termios object.  This object will be destroyed automatically
1658 when it is no longer needed.  A Termios object corresponds to the termios
1659 C struct.  new() mallocs a new one, getattr() fills it from a file descriptor,
1660 and setattr() sets a file descriptor's parameters to match Termios' contents.
1661
1662         $termios = POSIX::Termios->new;
1663
1664 =item getattr
1665
1666 Get terminal control attributes.
1667
1668 Obtain the attributes for stdin.
1669
1670         $termios->getattr()
1671
1672 Obtain the attributes for stdout.
1673
1674         $termios->getattr( 1 )
1675
1676 Returns C<undef> on failure.
1677
1678 =item getcc
1679
1680 Retrieve a value from the c_cc field of a termios object.  The c_cc field is
1681 an array so an index must be specified.
1682
1683         $c_cc[1] = $termios->getcc(1);
1684
1685 =item getcflag
1686
1687 Retrieve the c_cflag field of a termios object.
1688
1689         $c_cflag = $termios->getcflag;
1690
1691 =item getiflag
1692
1693 Retrieve the c_iflag field of a termios object.
1694
1695         $c_iflag = $termios->getiflag;
1696
1697 =item getispeed
1698
1699 Retrieve the input baud rate.
1700
1701         $ispeed = $termios->getispeed;
1702
1703 =item getlflag
1704
1705 Retrieve the c_lflag field of a termios object.
1706
1707         $c_lflag = $termios->getlflag;
1708
1709 =item getoflag
1710
1711 Retrieve the c_oflag field of a termios object.
1712
1713         $c_oflag = $termios->getoflag;
1714
1715 =item getospeed
1716
1717 Retrieve the output baud rate.
1718
1719         $ospeed = $termios->getospeed;
1720
1721 =item setattr
1722
1723 Set terminal control attributes.
1724
1725 Set attributes immediately for stdout.
1726
1727         $termios->setattr( 1, &POSIX::TCSANOW );
1728
1729 Returns C<undef> on failure.
1730
1731 =item setcc
1732
1733 Set a value in the c_cc field of a termios object.  The c_cc field is an
1734 array so an index must be specified.
1735
1736         $termios->setcc( &POSIX::VEOF, 1 );
1737
1738 =item setcflag
1739
1740 Set the c_cflag field of a termios object.
1741
1742         $termios->setcflag( $c_cflag | &POSIX::CLOCAL );
1743
1744 =item setiflag
1745
1746 Set the c_iflag field of a termios object.
1747
1748         $termios->setiflag( $c_iflag | &POSIX::BRKINT );
1749
1750 =item setispeed
1751
1752 Set the input baud rate.
1753
1754         $termios->setispeed( &POSIX::B9600 );
1755
1756 Returns C<undef> on failure.
1757
1758 =item setlflag
1759
1760 Set the c_lflag field of a termios object.
1761
1762         $termios->setlflag( $c_lflag | &POSIX::ECHO );
1763
1764 =item setoflag
1765
1766 Set the c_oflag field of a termios object.
1767
1768         $termios->setoflag( $c_oflag | &POSIX::OPOST );
1769
1770 =item setospeed
1771
1772 Set the output baud rate.
1773
1774         $termios->setospeed( &POSIX::B9600 );
1775
1776 Returns C<undef> on failure.
1777
1778 =item Baud rate values
1779
1780 B38400 B75 B200 B134 B300 B1800 B150 B0 B19200 B1200 B9600 B600 B4800 B50 B2400 B110
1781
1782 =item Terminal interface values
1783
1784 TCSADRAIN TCSANOW TCOON TCIOFLUSH TCOFLUSH TCION TCIFLUSH TCSAFLUSH TCIOFF TCOOFF
1785
1786 =item c_cc field values
1787
1788 VEOF VEOL VERASE VINTR VKILL VQUIT VSUSP VSTART VSTOP VMIN VTIME NCCS
1789
1790 =item c_cflag field values
1791
1792 CLOCAL CREAD CSIZE CS5 CS6 CS7 CS8 CSTOPB HUPCL PARENB PARODD
1793
1794 =item c_iflag field values
1795
1796 BRKINT ICRNL IGNBRK IGNCR IGNPAR INLCR INPCK ISTRIP IXOFF IXON PARMRK
1797
1798 =item c_lflag field values
1799
1800 ECHO ECHOE ECHOK ECHONL ICANON IEXTEN ISIG NOFLSH TOSTOP
1801
1802 =item c_oflag field values
1803
1804 OPOST
1805
1806 =back
1807
1808 =head1 PATHNAME CONSTANTS
1809
1810 =over 8
1811
1812 =item Constants
1813
1814 _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
1815
1816 =back
1817
1818 =head1 POSIX CONSTANTS
1819
1820 =over 8
1821
1822 =item Constants
1823
1824 _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
1825
1826 =back
1827
1828 =head1 SYSTEM CONFIGURATION
1829
1830 =over 8
1831
1832 =item Constants
1833
1834 _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
1835
1836 =back
1837
1838 =head1 ERRNO
1839
1840 =over 8
1841
1842 =item Constants
1843
1844 E2BIG EACCES EADDRINUSE EADDRNOTAVAIL EAFNOSUPPORT EAGAIN EALREADY EBADF
1845 EBUSY ECHILD ECONNABORTED ECONNREFUSED ECONNRESET EDEADLK EDESTADDRREQ
1846 EDOM EDQUOT EEXIST EFAULT EFBIG EHOSTDOWN EHOSTUNREACH EINPROGRESS EINTR
1847 EINVAL EIO EISCONN EISDIR ELOOP EMFILE EMLINK EMSGSIZE ENAMETOOLONG
1848 ENETDOWN ENETRESET ENETUNREACH ENFILE ENOBUFS ENODEV ENOENT ENOEXEC
1849 ENOLCK ENOMEM ENOPROTOOPT ENOSPC ENOSYS ENOTBLK ENOTCONN ENOTDIR
1850 ENOTEMPTY ENOTSOCK ENOTTY ENXIO EOPNOTSUPP EPERM EPFNOSUPPORT EPIPE
1851 EPROCLIM EPROTONOSUPPORT EPROTOTYPE ERANGE EREMOTE ERESTART EROFS
1852 ESHUTDOWN ESOCKTNOSUPPORT ESPIPE ESRCH ESTALE ETIMEDOUT ETOOMANYREFS
1853 ETXTBSY EUSERS EWOULDBLOCK EXDEV
1854
1855 =back
1856
1857 =head1 FCNTL
1858
1859 =over 8
1860
1861 =item Constants
1862
1863 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
1864
1865 =back
1866
1867 =head1 FLOAT
1868
1869 =over 8
1870
1871 =item Constants
1872
1873 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
1874
1875 =back
1876
1877 =head1 LIMITS
1878
1879 =over 8
1880
1881 =item Constants
1882
1883 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
1884
1885 =back
1886
1887 =head1 LOCALE
1888
1889 =over 8
1890
1891 =item Constants
1892
1893 LC_ALL LC_COLLATE LC_CTYPE LC_MONETARY LC_NUMERIC LC_TIME
1894
1895 =back
1896
1897 =head1 MATH
1898
1899 =over 8
1900
1901 =item Constants
1902
1903 HUGE_VAL
1904
1905 =back
1906
1907 =head1 SIGNAL
1908
1909 =over 8
1910
1911 =item Constants
1912
1913 SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK SA_RESETHAND SA_RESTART
1914 SA_SIGINFO SIGABRT SIGALRM SIGCHLD SIGCONT SIGFPE SIGHUP SIGILL SIGINT
1915 SIGKILL SIGPIPE SIGQUIT SIGSEGV SIGSTOP SIGTERM SIGTSTP SIGTTIN SIGTTOU
1916 SIGUSR1 SIGUSR2 SIG_BLOCK SIG_DFL SIG_ERR SIG_IGN SIG_SETMASK
1917 SIG_UNBLOCK
1918
1919 =back
1920
1921 =head1 STAT
1922
1923 =over 8
1924
1925 =item Constants
1926
1927 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
1928
1929 =item Macros
1930
1931 S_ISBLK S_ISCHR S_ISDIR S_ISFIFO S_ISREG
1932
1933 =back
1934
1935 =head1 STDLIB
1936
1937 =over 8
1938
1939 =item Constants
1940
1941 EXIT_FAILURE EXIT_SUCCESS MB_CUR_MAX RAND_MAX
1942
1943 =back
1944
1945 =head1 STDIO
1946
1947 =over 8
1948
1949 =item Constants
1950
1951 BUFSIZ EOF FILENAME_MAX L_ctermid L_cuserid L_tmpname TMP_MAX
1952
1953 =back
1954
1955 =head1 TIME
1956
1957 =over 8
1958
1959 =item Constants
1960
1961 CLK_TCK CLOCKS_PER_SEC
1962
1963 =back
1964
1965 =head1 UNISTD
1966
1967 =over 8
1968
1969 =item Constants
1970
1971 R_OK SEEK_CUR SEEK_END SEEK_SET STDIN_FILENO STDOUT_FILENO STDERR_FILENO W_OK X_OK
1972
1973 =back
1974
1975 =head1 WAIT
1976
1977 =over 8
1978
1979 =item Constants
1980
1981 WNOHANG WUNTRACED
1982
1983 =item Macros
1984
1985 WIFEXITED WEXITSTATUS WIFSIGNALED WTERMSIG WIFSTOPPED WSTOPSIG
1986
1987 =back
1988