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