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