POSIX - Perl interface to IEEE Std 1003.1
use POSIX (); use POSIX qw(setsid); use POSIX qw(:errno_h :fcntl_h); printf "EINTR is %d\n", EINTR; $sess_id = POSIX::setsid(); $fd = POSIX::open($path, O_CREAT|O_EXCL|O_WRONLY, 0644);# note: that's a filedescriptor, *NOT* a filehandleThe POSIX module permits you to access all (or nearly all) the standard POSIX 1003.1 identifiers. Many of these identifiers have been given Perl-ish interfaces.
This document gives a condensed list of the features available in the POSIX module. Consult your operating system's manpages for general information on most features. Consultperlfunc for functions which are noted as being identical or almost identical to Perl's builtin functions.
The first section describes POSIX functions from the 1003.1 specification. The second section describes some classes for signal objects, TTY objects, and other miscellaneous objects. The remaining sections list various constants and macros in an organization which roughly follows IEEE Std 1003.1b-1993.
Everything is exported by default (with a handful of exceptions). This is an unfortunate backwards compatibility feature and its use isstronglydiscouraged. You should either prevent the exporting (by sayinguse POSIX ();, as usual) and then use fully qualified names (e.g.POSIX::SEEK_END), or give an explicit import list. If you do neither and opt for the default (as inuse POSIX;), you will importhundreds and hundreds of symbols into your namespace.
A few functions are not implemented because they are C specific. If you attempt to call these, they will print a message telling you that they aren't implemented, and suggest using the Perl equivalent, should one exist. For example, trying to access thesetjmp() call will elicit the message "setjmp() is C-specific: use eval {} instead".
Furthermore, some evil vendors will claim 1003.1 compliance, but in fact are not so: they will not pass the PCTS (POSIX Compliance Test Suites). For example, one vendor may not defineEDEADLK, or the semantics of the errno values set byopen(2) might not be quite right. Perl does not attempt to verify POSIX compliance. That means you can currently successfully say "use POSIX", and then later in your program you find that your vendor has been lax and there's no usableICANON macro after all. This could be construed to be a bug.
_exitThis is identical to the C function_exit(). It exits the program immediately which means among other things buffered I/O isnot flushed.
Note that when using threads and in Linux this isnot a good way to exit a thread because in Linux processes and threads are kind of the same thing (Note: while this is the situation in early 2003 there are projects under way to have threads with more POSIXly semantics in Linux). If you want not to return from a thread, detach the thread.
abortThis is identical to the C functionabort(). It terminates the process with aSIGABRT signal unless caught by a signal handler or if the handler does not return normally (it e.g. does alongjmp).
absThis is identical to Perl's builtinabs() function, returning the absolute value of its numerical argument (except thatPOSIX::abs() must be provided an explicit value (rather than relying on an implicit$_):
$absolute_value = POSIX::abs(42); # good$absolute_value = POSIX::abs(); # throws exceptionaccessDetermines the accessibility of a file.
if( POSIX::access( "/", &POSIX::R_OK ) ){print "have read permission\n";}Returnsundef on failure. Note: do not useaccess() for security purposes. Between theaccess() call and the operation you are preparing for the permissions might change: a classicrace condition.
acosThis is identical to the C functionacos(), returning the arcus cosine of its numerical argument. See alsoMath::Trig.
acoshThis is identical to the C functionacosh(), returning the hyperbolic arcus cosine of its numerical argument [C99]. See alsoMath::Trig.
alarmThis is identical to Perl's builtinalarm() function, either for arming or disarming theSIGARLM timer, except thatPOSIX::alarm() must be provided an explicit value (rather than relying on an implicit$_):
POSIX::alarm(3) # goodPOSIX::alarm() # throws exceptionasctimeThis is identical to the C functionasctime(). It returns a string of the form
"Fri Jun 2 18:22:13 2000\n\0"and it is called thusly
$asctime = asctime($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst);The$mon is zero-based: January equals0. The$year is 1900-based: 2001 equals101.$wday and$yday default to zero (and are usually ignored anyway), and$isdst defaults to -1.
asinThis is identical to the C functionasin(), returning the arcus sine of its numerical argument. See alsoMath::Trig.
asinhThis is identical to the C functionasinh(), returning the hyperbolic arcus sine of its numerical argument [C99]. See alsoMath::Trig.
assertUnimplemented, but you can use"die" in perlfunc and theCarp module to achieve similar things.
atanThis is identical to the C functionatan(), returning the arcus tangent of its numerical argument. See alsoMath::Trig.
atanhThis is identical to the C functionatanh(), returning the hyperbolic arcus tangent of its numerical argument [C99]. See alsoMath::Trig.
atan2This is identical to Perl's builtinatan2() function, returning the arcus tangent defined by its two numerical arguments, they coordinate and thex coordinate. See alsoMath::Trig.
atexitNot implemented.atexit() is C-specific: useEND {} instead, seeperlmod.
atofNot implemented.atof() is C-specific. Perl converts strings to numbers transparently. If you need to force a scalar to a number, add a zero to it.
atoiNot implemented.atoi() is C-specific. Perl converts strings to numbers transparently. If you need to force a scalar to a number, add a zero to it. If you need to have just the integer part, see"int" in perlfunc.
atolNot implemented.atol() is C-specific. Perl converts strings to numbers transparently. If you need to force a scalar to a number, add a zero to it. If you need to have just the integer part, see"int" in perlfunc.
bsearchbsearch() not supplied. For doing binary search on wordlists, seeSearch::Dict.
callocNot implemented.calloc() is C-specific. Perl does memory management transparently.
cbrtThe cube root [C99].
ceilThis is identical to the C functionceil(), returning the smallest integer value greater than or equal to the given numerical argument.
chdirThis is identical to Perl's builtinchdir() function, allowing one to change the working (default) directory -- see"chdir" in perlfunc -- with the exception thatPOSIX::chdir() must be provided an explicit value (rather than relying on an implicit$_):
$rv = POSIX::chdir('path/to/dir'); # good$rv = POSIX::chdir(); # throws exceptionchmodThis is identical to Perl's builtinchmod() function, allowing one to change file and directory permissions -- see"chmod" in perlfunc -- with the exception thatPOSIX::chmod() can only change one file at a time (rather than a list of files):
$c = chmod 0664, $file1, $file2; # good$c = POSIX::chmod 0664, $file1; # throws exception$c = POSIX::chmod 0664, $file1, $file2; # throws exceptionAs with the built-inchmod(),$file may be a filename or a file handle.
chownThis is identical to Perl's builtinchown() function, allowing one to change file and directory owners and groups, see"chown" in perlfunc.
clearerrNot implemented. Use the methodIO::Handle::clearerr() instead, to reset the error state (if any) and EOF state (if any) of the given stream.
clockThis is identical to the C functionclock(), returning the amount of spent processor time in microseconds.
closeClose the file. This uses file descriptors such as those obtained by callingPOSIX::open.
$fd = POSIX::open( "foo", &POSIX::O_RDONLY );POSIX::close( $fd );Returnsundef on failure.
See also"close" in perlfunc.
closedirThis is identical to Perl's builtinclosedir() function for closing a directory handle, see"closedir" in perlfunc.
cosThis is identical to Perl's builtincos() function, for returning the cosine of its numerical argument, see"cos" in perlfunc. See alsoMath::Trig.
coshThis is identical to the C functioncosh(), for returning the hyperbolic cosine of its numeric argument. See alsoMath::Trig.
copysignReturnsx but with the sign ofy [C99].
$x_with_sign_of_y = POSIX::copysign($x, $y);See also"signbit".
creatCreate a new file. This returns a file descriptor like the ones returned byPOSIX::open. UsePOSIX::close to close the file.
$fd = POSIX::creat( "foo", 0611 );POSIX::close( $fd );See also"sysopen" in perlfunc and itsO_CREAT flag.
ctermidGenerates the path name for the controlling terminal.
$path = POSIX::ctermid();ctimeThis is identical to the C functionctime() and equivalent toasctime(localtime(...)), see"asctime" and"localtime".
cuserid [POSIX.1-1988]Get the login name of the owner of the current process.
$name = POSIX::cuserid();Note: this function has not been specified by POSIX since 1990 and is included only for backwards compatibility. New code should usegetlogin() instead.
difftimeThis is identical to the C functiondifftime(), for returning the time difference (in seconds) between two times (as returned bytime()), see"time".
divNot implemented.div() is C-specific, use"int" in perlfunc on the usual/ division and the modulus%.
dupThis is similar to the C functiondup(), for duplicating a file descriptor.
This uses file descriptors such as those obtained by callingPOSIX::open.
Returnsundef on failure.
dup2This is similar to the C functiondup2(), for duplicating a file descriptor to an another known file descriptor.
This uses file descriptors such as those obtained by callingPOSIX::open.
Returnsundef on failure.
erfThe error function [C99].
erfcThe complementary error function [C99].
errnoReturns the value of errno.
$errno = POSIX::errno();This identical to the numerical values of the$!, see"$ERRNO" in perlvar.
execlNot implemented.execl() is C-specific, see"exec" in perlfunc.
execleNot implemented.execle() is C-specific, see"exec" in perlfunc.
execlpNot implemented.execlp() is C-specific, see"exec" in perlfunc.
execvNot implemented.execv() is C-specific, see"exec" in perlfunc.
execveNot implemented.execve() is C-specific, see"exec" in perlfunc.
execvpNot implemented.execvp() is C-specific, see"exec" in perlfunc.
exitThis is identical to Perl's builtinexit() function for exiting the program, see"exit" in perlfunc.
expThis is identical to Perl's builtinexp() function for returning the exponent (e-based) of the numerical argument, see"exp" in perlfunc.
expm1Equivalent toexp(x) - 1, but more precise for small argument values [C99].
See also"log1p".
fabsThis is identical to Perl's builtinabs() function for returning the absolute value of the numerical argument, see"abs" in perlfunc.
fcloseNot implemented. Use methodIO::Handle::close() instead, or see"close" in perlfunc.
fcntlThis is identical to Perl's builtinfcntl() function, see"fcntl" in perlfunc.
fdopenNot implemented. Use methodIO::Handle::new_from_fd() instead, or see"open" in perlfunc.
feofNot implemented. Use methodIO::Handle::eof() instead, or see"eof" in perlfunc.
ferrorNot implemented. Use methodIO::Handle::error() instead.
fflushNot implemented. Use methodIO::Handle::flush() instead. See also"$OUTPUT_AUTOFLUSH" in perlvar.
fgetcNot implemented. Use methodIO::Handle::getc() instead, or see"read" in perlfunc.
fgetposNot implemented. Use methodIO::Seekable::getpos() instead, or see"seek" in perlfunc.
fgetsNot implemented. Use methodIO::Handle::gets() instead. Similar to <>, also known as"readline" in perlfunc.
filenoNot implemented. Use methodIO::Handle::fileno() instead, or see"fileno" in perlfunc.
floorThis is identical to the C functionfloor(), returning the largest integer value less than or equal to the numerical argument.
fdim"Positive difference",x - y ifx > y, zero otherwise [C99].
fegetroundReturns the current floating point rounding mode, one of
FE_TONEAREST FE_TOWARDZERO FE_UPWARD FE_UPWARDFE_TONEAREST is like"round",FE_TOWARDZERO is like"trunc" [C99].
fesetroundSets the floating point rounding mode, see"fegetround" [C99].
fma"Fused multiply-add",x * y + z, possibly faster (and less lossy) than the explicit two operations [C99].
my $fused = POSIX::fma($x, $y, $z);fmaxMaximum ofx andy, except when either isNaN, returns the other [C99].
my $min = POSIX::fmax($x, $y);fminMinimum ofx andy, except when either isNaN, returns the other [C99].
my $min = POSIX::fmin($x, $y);fmodThis is identical to the C functionfmod().
$r = fmod($x, $y);It returns the remainder$r = $x - $n*$y, where$n = trunc($x/$y). The$r has the same sign as$x and magnitude (absolute value) less than the magnitude of$y.
fopenNot implemented. Use methodIO::File::open() instead, or see"open" in perlfunc.
forkThis is identical to Perl's builtinfork() function for duplicating the current process, see"fork" in perlfunc andperlfork if you are in Windows.
fpathconfRetrieves the value of a configurable limit on a file or directory. This uses file descriptors such as those obtained by callingPOSIX::open.
The following will determine the maximum length of the longest allowable pathname on the filesystem which holds/var/foo.
$fd = POSIX::open( "/var/foo", &POSIX::O_RDONLY );$path_max = POSIX::fpathconf($fd, &POSIX::_PC_PATH_MAX);Returnsundef on failure.
fpclassifyReturns one of
FP_NORMAL FP_ZERO FP_SUBNORMAL FP_INFINITE FP_NANtelling the class of the argument [C99].FP_INFINITE is positive or negative infinity,FP_NAN is not-a-number.FP_SUBNORMAL means subnormal numbers (also known as denormals), very small numbers with low precision.FP_ZERO is zero.FP_NORMAL is all the rest.
fprintfNot implemented.fprintf() is C-specific, see"printf" in perlfunc instead.
fputcNot implemented.fputc() is C-specific, see"print" in perlfunc instead.
fputsNot implemented.fputs() is C-specific, see"print" in perlfunc instead.
freadNot implemented.fread() is C-specific, see"read" in perlfunc instead.
freeNot implemented.free() is C-specific. Perl does memory management transparently.
freopenNot implemented.freopen() is C-specific, see"open" in perlfunc instead.
frexpReturn the mantissa and exponent of a floating-point number.
($mantissa, $exponent) = POSIX::frexp( 1.234e56 );fscanfNot implemented.fscanf() is C-specific, use <> and regular expressions instead.
fseekNot implemented. Use methodIO::Seekable::seek() instead, or see"seek" in perlfunc.
fsetposNot implemented. Use methodIO::Seekable::setpos() instead, or seek"seek" in perlfunc.
fstatGet file status. This uses file descriptors such as those obtained by callingPOSIX::open. The data returned is identical to the data from Perl's builtinstat function.
$fd = POSIX::open( "foo", &POSIX::O_RDONLY );@stats = POSIX::fstat( $fd );fsyncNot implemented. Use methodIO::Handle::sync() instead.
ftellNot implemented. Use methodIO::Seekable::tell() instead, or see"tell" in perlfunc.
fwriteNot implemented.fwrite() is C-specific, see"print" in perlfunc instead.
getcThis is identical to Perl's builtingetc() function, see"getc" in perlfunc.
getcharReturns one character from STDIN. Identical to Perl'sgetc(), see"getc" in perlfunc.
getcwdReturns the name of the current working directory. See alsoCwd.
getegidReturns the effective group identifier. Similar to Perl' s builtin variable$(, see"$EGID" in perlvar.
getenvReturns the value of the specified environment variable. The same information is available through the%ENV array.
geteuidReturns the effective user identifier. Identical to Perl's builtin$> variable, see"$EUID" in perlvar.
getgidReturns the user's real group identifier. Similar to Perl's builtin variable$), see"$GID" in perlvar.
getgrgidThis is identical to Perl's builtingetgrgid() function for returning group entries by group identifiers, see"getgrgid" in perlfunc.
getgrnamThis is identical to Perl's builtingetgrnam() function for returning group entries by group names, see"getgrnam" in perlfunc.
getgroupsReturns the ids of the user's supplementary groups. Similar to Perl's builtin variable$), see"$GID" in perlvar.
getloginThis is identical to Perl's builtingetlogin() function for returning the user name associated with the current session, see"getlogin" in perlfunc.
getpayloaduse POSIX ':nan_payload';getpayload($var)Returns theNaN payload.
Note the API instability warning in"setpayload".
See"nan" for more discussion aboutNaN.
getpgrpThis is identical to Perl's builtingetpgrp() function for returning the process group identifier of the current process, see"getpgrp" in perlfunc.
getpidReturns the process identifier. Identical to Perl's builtin variable$$, see"$PID" in perlvar.
getppidThis is identical to Perl's builtingetppid() function for returning the process identifier of the parent process of the current process , see"getppid" in perlfunc.
getpwnamThis is identical to Perl's builtingetpwnam() function for returning user entries by user names, see"getpwnam" in perlfunc.
getpwuidThis is identical to Perl's builtingetpwuid() function for returning user entries by user identifiers, see"getpwuid" in perlfunc.
getsReturns one line fromSTDIN, similar to <>, also known as thereadline() function, see"readline" in perlfunc.
NOTE: if you have C programs that still usegets(), be very afraid. Thegets() function is a source of endless grief because it has no buffer overrun checks. It shouldnever be used. Thefgets() function should be preferred instead.
getuidReturns the user's identifier. Identical to Perl's builtin$< variable, see"$UID" in perlvar.
gmtimeThis is identical to Perl's builtingmtime() function for converting seconds since the epoch to a date in Greenwich Mean Time, see"gmtime" in perlfunc.
hypotEquivalent tosqrt(x * x + y * y) except more stable on very large or very small arguments [C99].
ilogbInteger binary logarithm [C99]
For exampleilogb(20) is 4, as an integer.
See also"logb".
InfThe infinity as a constant:
use POSIX qw(Inf);my $pos_inf = +Inf; # Or just Inf.my $neg_inf = -Inf;See also"isinf", and"fpclassify".
isalnumThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:alnum:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isalphaThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:alpha:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isattyReturns a boolean indicating whether the specified filehandle is connected to a tty. Similar to the-t operator, see"-X" in perlfunc.
iscntrlThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:cntrl:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isdigitThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:digit:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isfiniteReturns true if the argument is a finite number (that is, not an infinity, or the not-a-number) [C99].
See also"isinf","isnan", and"fpclassify".
isgraphThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:graph:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isgreater(Alsoisgreaterequal,isless,islessequal,islessgreater,isunordered)
Floating point comparisons which handle theNaN [C99].
isinfReturns true if the argument is an infinity (positive or negative) [C99].
See also"Inf","isnan","isfinite", and"fpclassify".
islowerThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:lower:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isnanReturns true if the argument isNaN (not-a-number) [C99].
Note that you cannot test for "NaN-ness" with
$x == $xsince theNaN is not equivalent to anything,including itself.
See also"nan","NaN","isinf", and"fpclassify".
isnormalReturns true if the argument is normal (that is, not a subnormal/denormal, and not an infinity, or a not-a-number) [C99].
See also"isfinite", and"fpclassify".
isprintThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:print:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
ispunctThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:punct:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
issignalinguse POSIX ':nan_payload';issignaling($var, $payload)Return true if the argument is asignaling NaN.
Note the API instability warning in"setpayload".
See"nan" for more discussion aboutNaN.
isspaceThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:space:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isupperThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:upper:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
isxdigitThis function has been removed as of v5.24. It was very similar to matching againstqr/ ^ [[:xdigit:]]+ $ /x, which you should convert to use instead. See"POSIX Character Classes" in perlrecharclass.
j0j1jny0y1ynThe Bessel function of the first kind of the order zero.
killThis is identical to Perl's builtinkill() function for sending signals to processes (often to terminate them), see"kill" in perlfunc.
labsNot implemented. (For returning absolute values of long integers.)labs() is C-specific, see"abs" in perlfunc instead.
lchownThis is identical to the C function, except the order of arguments is consistent with Perl's builtinchown() with the added restriction of only one path, not a list of paths. Does the same thing as thechown() function but changes the owner of a symbolic link instead of the file the symbolic link points to.
POSIX::lchown($uid, $gid, $file_path);ldexpThis is identical to the C functionldexp() for multiplying floating point numbers with powers of two.
$x_quadrupled = POSIX::ldexp($x, 2);ldivNot implemented. (For computing dividends of long integers.)ldiv() is C-specific, use/ andint() instead.
lgammaThe logarithm of the Gamma function [C99].
See also"tgamma".
log1pEquivalent tolog(1 + x), but more stable results for small argument values [C99].
log2Logarithm base two [C99].
See also"expm1".
logbInteger binary logarithm [C99].
For examplelogb(20) is 4, as a floating point number.
See also"ilogb".
linkThis is identical to Perl's builtinlink() function for creating hard links into files, see"link" in perlfunc.
localeconvGet numeric formatting information. Returns a reference to a hash containing the current underlying locale's formatting values. Users of this function should also readperllocale, which provides a comprehensive discussion of Perl locale handling, includinga section devoted to this function. Prior to Perl 5.28, or when operating in a non thread-safe environment, it should not be used in a threaded application unless it's certain that the underlying locale is C or POSIX. This is because it otherwise changes the locale, which globally affects all threads simultaneously. Windows platforms starting with Visual Studio 2005 are mostly thread-safe, but use of this function in those prior to Visual Studio 2015 can interefere with a thread that has called"switch_to_global_locale" in perlapi.
Here is how to query the database for thede (Deutsch or German) locale.
my $loc = POSIX::setlocale( &POSIX::LC_ALL, "de" );print "Locale: \"$loc\"\n";my $lconv = POSIX::localeconv();foreach my $property (qw(decimal_pointthousands_sepgroupingint_curr_symbolcurrency_symbolmon_decimal_pointmon_thousands_sepmon_groupingpositive_signnegative_signint_frac_digitsfrac_digitsp_cs_precedesp_sep_by_spacen_cs_precedesn_sep_by_spacep_sign_posnn_sign_posnint_p_cs_precedesint_p_sep_by_spaceint_n_cs_precedesint_n_sep_by_spaceint_p_sign_posnint_n_sign_posn)){printf qq(%s: "%s",\n),$property, $lconv->{$property};}The members whose names begin withint_p_ andint_n_ were added by POSIX.1-2008 and are only available on systems that support them.
localtimeThis is identical to Perl's builtinlocaltime() function for converting seconds since the epoch to a date see"localtime" in perlfunc except thatPOSIX::localtime() must be provided an explicit value (rather than relying on an implicit$_):
@localtime = POSIX::localtime(time); # good@localtime = localtime(); # good@localtime = POSIX::localtime(); # throws exceptionlogThis is identical to Perl's builtinlog() function, returning the natural (e-based) logarithm of the numerical argument, see"log" in perlfunc.
log10This is identical to the C functionlog10(), returning the 10-base logarithm of the numerical argument. You can also use
sub log10 { log($_[0]) / log(10) }or
sub log10 { log($_[0]) / 2.30258509299405 }or
sub log10 { log($_[0]) * 0.434294481903252 }longjmpNot implemented.longjmp() is C-specific: use"die" in perlfunc instead.
lseekMove the file's read/write position. This uses file descriptors such as those obtained by callingPOSIX::open.
$fd = POSIX::open( "foo", &POSIX::O_RDONLY );$off_t = POSIX::lseek( $fd, 0, &POSIX::SEEK_SET );Returnsundef on failure.
lrintDepending on the current floating point rounding mode, rounds the argument either toward nearest (like"round"), toward zero (like"trunc"), downward (toward negative infinity), or upward (toward positive infinity) [C99].
For the rounding mode, see"fegetround".
lroundLike"round", but as integer, as opposed to floating point [C99].
See also"ceil","floor","trunc".
Owing to an oversight, this is not currently exported by default, or as part of the:math_h_c99 export tag; importing it must therefore be done by explicit name.
mallocNot implemented.malloc() is C-specific. Perl does memory management transparently.
mblenThis is identical to the C functionmblen().
Core Perl does not have any support for the wide and multibyte characters of the C standards, except under UTF-8 locales, so this might be a rather useless function.
However, Perl supports Unicode, seeperluniintro.
mbstowcsThis is identical to the C functionmbstowcs().
See"mblen".
mbtowcThis is identical to the C functionmbtowc().
See"mblen".
memchrNot implemented.memchr() is C-specific, see"index" in perlfunc instead.
memcmpNot implemented.memcmp() is C-specific, useeq instead, seeperlop.
memcpyNot implemented.memcpy() is C-specific, use=, seeperlop, or see"substr" in perlfunc.
memmoveNot implemented.memmove() is C-specific, use=, seeperlop, or see"substr" in perlfunc.
memsetNot implemented.memset() is C-specific, usex instead, seeperlop.
mkdirThis is identical to Perl's builtinmkdir() function for creating directories, see"mkdir" in perlfunc.
mkfifoThis is similar to the C functionmkfifo() for creating FIFO special files.
if (mkfifo($path, $mode)) { ....Returnsundef on failure. The$mode is similar to the mode ofmkdir(), see"mkdir" in perlfunc, though formkfifo youmust specify the$mode.
mktimeConvert date/time info to a calendar time.
Synopsis:
mktime(sec, min, hour, mday, mon, year, wday = 0, yday = 0, isdst = -1)The month (mon), weekday (wday), and yearday (yday) begin at zero,i.e., January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1. The year (year) is given in years since 1900;i.e., the year 1995 is 95; the year 2001 is 101. Consult your system'smktime() manpage for details about these and the other arguments.
Calendar time for December 12, 1995, at 10:30 am.
$time_t = POSIX::mktime( 0, 30, 10, 12, 11, 95 );print "Date = ", POSIX::ctime($time_t);Returnsundef on failure.
modfReturn the integral and fractional parts of a floating-point number.
($fractional, $integral) = POSIX::modf( 3.14 );See also"round".
NaNThe not-a-number as a constant:
use POSIX qw(NaN);my $nan = NaN;See also"nan",/isnan, and"fpclassify".
nanmy $nan = nan();ReturnsNaN, not-a-number [C99].
The returned NaN is always aquiet NaN, as opposed tosignaling.
With an argument, can be used to generate a NaN withpayload. The argument is first interpreted as a floating point number, but then any fractional parts are truncated (towards zero), and the value is interpreted as an unsigned integer. The bits of this integer are stored in the unused bits of the NaN.
The result has a dual nature: it is a NaN, but it also carries the integer inside it. The integer can be retrieved with"getpayload". Note, though, that the payload is not propagated, not even on copies, and definitely not in arithmetic operations.
How many bits fit in the NaN depends on what kind of floating points are being used, but on the most common platforms (64-bit IEEE 754, or the x86 80-bit long doubles) there are 51 and 61 bits available, respectively. (There would be 52 and 62, but the quiet/signaling bit of NaNs takes away one.) However, because of the floating-point-to- integer-and-back conversions, please test carefully whether you get back what you put in. If your integers are only 32 bits wide, you probably should not rely on more than 32 bits of payload.
Whether a "signaling" NaN is in any way different from a "quiet" NaN, depends on the platform. Also note that the payload of the default NaN (no argument to nan()) is not necessarily zero, usesetpayload to explicitly set the payload. On some platforms like the 32-bit x86, (unless using the 80-bit long doubles) the signaling bit is not supported at all.
See also"isnan","NaN","setpayload" and"issignaling".
nearbyintReturns the nearest integer to the argument, according to the current rounding mode (see"fegetround") [C99].
nextafterReturns the next representable floating point number afterx in the direction ofy [C99].
my $nextafter = POSIX::nextafter($x, $y);Like"nexttoward", but potentially less accurate.
nexttowardReturns the next representable floating point number afterx in the direction ofy [C99].
my $nexttoward = POSIX::nexttoward($x, $y);Like"nextafter", but potentially more accurate.
niceThis is similar to the C functionnice(), for changing the scheduling preference of the current process. Positive arguments mean a more polite process, negative values a more needy process. Normal (non-root) user processes can only change towards being more polite.
Returnsundef on failure.
offsetofNot implemented.offsetof() is C-specific, you probably want to see"pack" in perlfunc instead.
openOpen a file for reading for writing. This returns file descriptors, not Perl filehandles. UsePOSIX::close to close the file.
Open a file read-only with mode 0666.
$fd = POSIX::open( "foo" );Open a file for read and write.
$fd = POSIX::open( "foo", &POSIX::O_RDWR );Open a file for write, with truncation.
$fd = POSIX::open("foo", &POSIX::O_WRONLY | &POSIX::O_TRUNC);Create a new file with mode 0640. Set up the file for writing.
$fd = POSIX::open("foo", &POSIX::O_CREAT | &POSIX::O_WRONLY, 0640);Returnsundef on failure.
See also"sysopen" in perlfunc.
opendirOpen a directory for reading.
$dir = POSIX::opendir( "/var" );@files = POSIX::readdir( $dir );POSIX::closedir( $dir );Returnsundef on failure.
pathconfRetrieves the value of a configurable limit on a file or directory.
The following will determine the maximum length of the longest allowable pathname on the filesystem which holds/var.
$path_max = POSIX::pathconf( "/var", &POSIX::_PC_PATH_MAX );Returnsundef on failure.
pauseThis is similar to the C functionpause(), which suspends the execution of the current process until a signal is received.
Returnsundef on failure.
perrorThis is identical to the C functionperror(), which outputs to the standard error stream the specified message followed by": " and the current error string. Use thewarn() function and the$! variable instead, see"warn" in perlfunc and"$ERRNO" in perlvar.
pipeCreate an interprocess channel. This returns file descriptors like those returned byPOSIX::open.
my ($read, $write) = POSIX::pipe();POSIX::write( $write, "hello", 5 );POSIX::read( $read, $buf, 5 );See also"pipe" in perlfunc.
powComputes$x raised to the power$exponent.
$ret = POSIX::pow( $x, $exponent );You can also use the** operator, seeperlop.
printfFormats and prints the specified arguments toSTDOUT. See also"printf" in perlfunc.
putcNot implemented.putc() is C-specific, see"print" in perlfunc instead.
putcharNot implemented.putchar() is C-specific, see"print" in perlfunc instead.
putsNot implemented.puts() is C-specific, see"print" in perlfunc instead.
qsortNot implemented.qsort() is C-specific, see"sort" in perlfunc instead.
raiseSends the specified signal to the current process. See also"kill" in perlfunc and the$$ in"$PID" in perlvar.
randNot implemented.rand() is non-portable, see"rand" in perlfunc instead.
readRead from a file. This uses file descriptors such as those obtained by callingPOSIX::open. If the buffer$buf is not large enough for the read then Perl will extend it to make room for the request.
$fd = POSIX::open( "foo", &POSIX::O_RDONLY );$bytes = POSIX::read( $fd, $buf, 3 );Returnsundef on failure.
See also"sysread" in perlfunc.
readdirThis is identical to Perl's builtinreaddir() function for reading directory entries, see"readdir" in perlfunc.
reallocNot implemented.realloc() is C-specific. Perl does memory management transparently.
remainderGivenx andy, returns the valuex - n*y, wheren is the integer closest tox/y. [C99]
my $remainder = POSIX::remainder($x, $y)See also"remquo".
removeDeletes a name from the filesystem. Calls"unlink" in perlfunc for files and"rmdir" in perlfunc for directories.
remquoLike"remainder" but also returns the low-order bits of the quotient (n) [C99]
(This is quite esoteric interface, mainly used to implement numerical algorithms.)
renameThis is identical to Perl's builtinrename() function for renaming files, see"rename" in perlfunc.
rewindSeeks to the beginning of the file.
rewinddirThis is identical to Perl's builtinrewinddir() function for rewinding directory entry streams, see"rewinddir" in perlfunc.
rintIdentical to"lrint".
rmdirThis is identical to Perl's builtinrmdir() function for removing (empty) directories, see"rmdir" in perlfunc.
roundReturns the integer (but still as floating point) nearest to the argument [C99].
scalbnReturnsx * 2**y [C99].
scanfNot implemented.scanf() is C-specific, use <> and regular expressions instead, seeperlre.
setgidSets the real group identifier and the effective group identifier for this process. Similar to assigning a value to the Perl's builtin$) variable, see"$EGID" in perlvar, except that the latter will change only the real user identifier, and that the setgid() uses only a single numeric argument, as opposed to a space-separated list of numbers.
setjmpNot implemented.setjmp() is C-specific: useeval {} instead, see"eval" in perlfunc.
setlocaleWARNING! Do NOT use this function in athread. The locale will change in all other threads at the same time, and should your thread get paused by the operating system, and another started, that thread will not have the locale it is expecting. On some platforms, there can be a race leading to segfaults if two threads call this function nearly simultaneously.
Modifies and queries the program's underlying locale. Users of this function should readperllocale, whch provides a comprehensive discussion of Perl locale handling, knowledge of which is necessary to properly use this function. It containsa section devoted to this function. The discussion here is merely a summary reference forsetlocale(). Note that Perl itself is almost entirely unaffected by the locale except within the scope of"use locale". (Exceptions are listed in"Not within the scope of "use locale"" in perllocale.)
The following examples assume
use POSIX qw(setlocale LC_ALL LC_CTYPE);has been issued.
The following will set the traditional UNIX system locale behavior (the second argument"C").
$loc = setlocale( LC_ALL, "C" );The following will query the currentLC_CTYPE category. (No second argument means 'query'.)
$loc = setlocale( LC_CTYPE );The following will set theLC_CTYPE behaviour according to the locale environment variables (the second argument""). Please see your system'ssetlocale(3) documentation for the locale environment variables' meaning or consultperllocale.
$loc = setlocale( LC_CTYPE, "" );The following will set theLC_COLLATE behaviour to Argentinian Spanish.NOTE: The naming and availability of locales depends on your operating system. Please consultperllocale for how to find out which locales are available in your system.
$loc = setlocale( LC_COLLATE, "es_AR.ISO8859-1" );setpayloaduse POSIX ':nan_payload';setpayload($var, $payload);Sets theNaN payload of var.
NOTE: the NaN payload APIs are based on the latest (as of June 2015) proposed ISO C interfaces, but they are not yet a standard. Things may change.
See"nan" for more discussion aboutNaN.
See also"setpayloadsig","isnan","getpayload", and"issignaling".
setpayloadsiguse POSIX ':nan_payload';setpayloadsig($var, $payload);Like"setpayload" but also makes the NaNsignaling.
Depending on the platform the NaN may or may not behave differently.
Note the API instability warning in"setpayload".
Note that because how the floating point formats work out, on the most common platforms signaling payload of zero is best avoided, since it might end up being identical to+Inf.
See also"nan","isnan","getpayload", and"issignaling".
setpgidThis is similar to the C functionsetpgid() for setting the process group identifier of the current process.
Returnsundef on failure.
setsidThis is identical to the C functionsetsid() for setting the session identifier of the current process.
setuidSets the real user identifier and the effective user identifier for this process. Similar to assigning a value to the Perl's builtin$< variable, see"$UID" in perlvar, except that the latter will change only the real user identifier.
sigactionDetailed signal management. This usesPOSIX::SigAction objects for theaction andoldaction arguments (the oldaction can also be just a hash reference). Consult your system'ssigaction manpage for details, see alsoPOSIX::SigRt.
Synopsis:
sigaction(signal, action, oldaction = 0)Returnsundef on failure. Thesignal must be a number (likeSIGHUP), not a string (like"SIGHUP"), though Perl does try hard to understand you.
If you use theSA_SIGINFO flag, the signal handler will in addition to the first argument, the signal name, also receive a second argument, a hash reference, inside which are the following keys with the following semantics, as defined by POSIX/SUSv3:
signo the signal numbererrno the error numbercode if this is zero or less, the signal was sent by a user process and the uid and pid make sense, otherwise the signal was sent by the kernelThe constants for specificcode values can be imported individually or using the:signal_h_si_code tag.
The following are also defined by POSIX/SUSv3, but unfortunately not very widely implemented:
pid the process id generating the signaluid the uid of the process id generating the signalstatus exit value or signal for SIGCHLDband band event for SIGPOLLaddr address of faulting instruction or memory reference for SIGILL, SIGFPE, SIGSEGV or SIGBUSA third argument is also passed to the handler, which contains a copy of the raw binary contents of thesiginfo structure: if a system has some non-POSIX fields, this third argument is where tounpack() them from.
Note that not allsiginfo values make sense simultaneously (some are valid only for certain signals, for example), and not all values make sense from Perl perspective, you should to consult your system'ssigaction and possibly alsosiginfo documentation.
siglongjmpNot implemented.siglongjmp() is C-specific: use"die" in perlfunc instead.
signbitReturns zero for positive arguments, non-zero for negative arguments [C99].
sigpendingExamine signals that are blocked and pending. This usesPOSIX::SigSet objects for thesigset argument. Consult your system'ssigpending manpage for details.
Synopsis:
sigpending(sigset)Returnsundef on failure.
sigprocmaskChange and/or examine calling process's signal mask. This usesPOSIX::SigSet objects for thesigset andoldsigset arguments. Consult your system'ssigprocmask manpage for details.
Synopsis:
sigprocmask(how, sigset, oldsigset = 0)Returnsundef on failure.
Note that you can't reliably block or unblock a signal from its own signal handler if you're using safe signals. Other signals can be blocked or unblocked reliably.
sigsetjmpNot implemented.sigsetjmp() is C-specific: useeval {} instead, see"eval" in perlfunc.
sigsuspendInstall a signal mask and suspend process until signal arrives. This usesPOSIX::SigSet objects for thesignal_mask argument. Consult your system'ssigsuspend manpage for details.
Synopsis:
sigsuspend(signal_mask)Returnsundef on failure.
sinThis is identical to Perl's builtinsin() function for returning the sine of the numerical argument, see"sin" in perlfunc. See alsoMath::Trig.
sinhThis is identical to the C functionsinh() for returning the hyperbolic sine of the numerical argument. See alsoMath::Trig.
sleepThis is functionally identical to Perl's builtinsleep() function for suspending the execution of the current for process for certain number of seconds, see"sleep" in perlfunc. There is one significant difference, however:POSIX::sleep() returns the number ofunslept seconds, while theCORE::sleep() returns the number of slept seconds.
sprintfThis is similar to Perl's builtinsprintf() function for returning a string that has the arguments formatted as requested, see"sprintf" in perlfunc.
sqrtThis is identical to Perl's builtinsqrt() function. for returning the square root of the numerical argument, see"sqrt" in perlfunc.
srandGive a seed the pseudorandom number generator, see"srand" in perlfunc.
sscanfNot implemented.sscanf() is C-specific, use regular expressions instead, seeperlre.
statThis is identical to Perl's builtinstat() function for returning information about files and directories.
strcatNot implemented.strcat() is C-specific, use.= instead, seeperlop.
strchrNot implemented.strchr() is C-specific, see"index" in perlfunc instead.
strcmpNot implemented.strcmp() is C-specific, useeq orcmp instead, seeperlop.
strcollThis is identical to the C functionstrcoll() for collating (comparing) strings transformed using thestrxfrm() function. Not really needed since Perl can do this transparently, seeperllocale.
Beware that in a UTF-8 locale, anything you pass to this function must be in UTF-8; and when not in a UTF-8 locale, anything passed must not be UTF-8 encoded.
strcpyNot implemented.strcpy() is C-specific, use= instead, seeperlop.
strcspnNot implemented.strcspn() is C-specific, use regular expressions instead, seeperlre.
strerrorReturns the error string for the specified errno. Identical to the string form of$!, see"$ERRNO" in perlvar.
strftimeConvert date and time information to string. Returns the string.
Synopsis:
strftime(fmt, sec, min, hour, mday, mon, year, wday = -1, yday = -1, isdst = -1)The month (mon), weekday (wday), and yearday (yday) begin at zero,i.e., January is 0, not 1; Sunday is 0, not 1; January 1st is 0, not 1. The year (year) is given in years since 1900,i.e., the year 1995 is 95; the year 2001 is 101. Consult your system'sstrftime() manpage for details about these and the other arguments.
If you want your code to be portable, your format (fmt) argument should use only the conversion specifiers defined by the ANSI C standard (C89, to play safe). These areaAbBcdHIjmMpSUwWxXyYZ%. But even then, theresults of some of the conversion specifiers are non-portable. For example, the specifiersaAbBcpZ change according to the locale settings of the user, and both how to set locales (the locale names) and what output to expect are non-standard. The specifierc changes according to the timezone settings of the user and the timezone computation rules of the operating system. TheZ specifier is notoriously unportable since the names of timezones are non-standard. Sticking to the numeric specifiers is the safest route.
The given arguments are made consistent as though by callingmktime() before calling your system'sstrftime() function, except that theisdst value is not affected.
The string for Tuesday, December 12, 1995.
$str = POSIX::strftime( "%A, %B %d, %Y", 0, 0, 0, 12, 11, 95, 2 );print "$str\n";strlenNot implemented.strlen() is C-specific, uselength() instead, see"length" in perlfunc.
strncatNot implemented.strncat() is C-specific, use.= instead, seeperlop.
strncmpNot implemented.strncmp() is C-specific, useeq instead, seeperlop.
strncpyNot implemented.strncpy() is C-specific, use= instead, seeperlop.
strpbrkNot implemented.strpbrk() is C-specific, use regular expressions instead, seeperlre.
strrchrNot implemented.strrchr() is C-specific, see"rindex" in perlfunc instead.
strspnNot implemented.strspn() is C-specific, use regular expressions instead, seeperlre.
strstrThis is identical to Perl's builtinindex() function, see"index" in perlfunc.
strtodString to double translation. Returns the parsed number and the number of characters in the unparsed portion of the string. Truly POSIX-compliant systems set$! ($ERRNO) to indicate a translation error, so clear$! before callingstrtod. However, non-POSIX systems may not check for overflow, and therefore will never set$!.
strtod respects any POSIXsetlocale()LC_TIME settings, regardless of whether or not it is called from Perl code that is within the scope ofuse locale. This means it should not be used in a threaded application unless it's certain that the underlying locale is C or POSIX. This is because it otherwise changes the locale, which globally affects all threads simultaneously.
To parse a string$str as a floating point number use
$! = 0;($num, $n_unparsed) = POSIX::strtod($str);The second returned item and$! can be used to check for valid input:
if (($str eq '') || ($n_unparsed != 0) || $!) { die "Non-numeric input $str" . ($! ? ": $!\n" : "\n");}When called in a scalar contextstrtod returns the parsed number.
strtokNot implemented.strtok() is C-specific, use regular expressions instead, seeperlre, or"split" in perlfunc.
strtolString to (long) integer translation. Returns the parsed number and the number of characters in the unparsed portion of the string. Truly POSIX-compliant systems set$! ($ERRNO) to indicate a translation error, so clear$! before callingstrtol. However, non-POSIX systems may not check for overflow, and therefore will never set$!.
strtol should respect any POSIXsetlocale() settings.
To parse a string$str as a number in some base$base use
$! = 0;($num, $n_unparsed) = POSIX::strtol($str, $base);The base should be zero or between 2 and 36, inclusive. When the base is zero or omittedstrtol will use the string itself to determine the base: a leading "0x" or "0X" means hexadecimal; a leading "0" means octal; any other leading characters mean decimal. Thus, "1234" is parsed as a decimal number, "01234" as an octal number, and "0x1234" as a hexadecimal number.
The second returned item and$! can be used to check for valid input:
if (($str eq '') || ($n_unparsed != 0) || !$!) { die "Non-numeric input $str" . $! ? ": $!\n" : "\n";}When called in a scalar contextstrtol returns the parsed number.
strtoldLike"strtod" but for long doubles. Defined only if the system supports long doubles.
strtoulString to unsigned (long) integer translation.strtoul() is identical tostrtol() except thatstrtoul() only parses unsigned integers. See"strtol" for details.
Note: Some vendors supplystrtod() andstrtol() but notstrtoul(). Other vendors that do supplystrtoul() parse "-1" as a valid value.
strxfrmString transformation. Returns the transformed string.
$dst = POSIX::strxfrm( $src );Used in conjunction with thestrcoll() function, see"strcoll".
Not really needed since Perl can do this transparently, seeperllocale.
Beware that in a UTF-8 locale, anything you pass to this function must be in UTF-8; and when not in a UTF-8 locale, anything passed must not be UTF-8 encoded.
sysconfRetrieves values of system configurable variables.
The following will get the machine's clock speed.
$clock_ticks = POSIX::sysconf( &POSIX::_SC_CLK_TCK );Returnsundef on failure.
systemThis is identical to Perl's builtinsystem() function, see"system" in perlfunc.
tanThis is identical to the C functiontan(), returning the tangent of the numerical argument. See alsoMath::Trig.
tanhThis is identical to the C functiontanh(), returning the hyperbolic tangent of the numerical argument. See alsoMath::Trig.
tcdrainThis is similar to the C functiontcdrain() for draining the output queue of its argument stream.
Returnsundef on failure.
tcflowThis is similar to the C functiontcflow() for controlling the flow of its argument stream.
Returnsundef on failure.
tcflushThis is similar to the C functiontcflush() for flushing the I/O buffers of its argument stream.
Returnsundef on failure.
tcgetpgrpThis is identical to the C functiontcgetpgrp() for returning the process group identifier of the foreground process group of the controlling terminal.
tcsendbreakThis is similar to the C functiontcsendbreak() for sending a break on its argument stream.
Returnsundef on failure.
tcsetpgrpThis is similar to the C functiontcsetpgrp() for setting the process group identifier of the foreground process group of the controlling terminal.
Returnsundef on failure.
tgammaThe Gamma function [C99].
See also"lgamma".
timeThis is identical to Perl's builtintime() function for returning the number of seconds since the epoch (whatever it is for the system), see"time" in perlfunc.
timesThetimes() function returns elapsed realtime since some point in the past (such as system startup), user and system times for this process, and user and system times used by child processes. All times are returned in clock ticks.
($realtime, $user, $system, $cuser, $csystem)= POSIX::times();Note: Perl's builtintimes() function returns four values, measured in seconds.
tmpfileNot implemented. Use methodIO::File::new_tmpfile() instead, or seeFile::Temp.
tmpnamFor security reasons, which are probably detailed in your system's documentation for the C librarytmpnam() function, this interface is no longer available; instead useFile::Temp.
tolowerThis is identical to the C function, except that it can apply to a single character or to a whole string, and currently operates as if the locale always is "C". Consider using thelc() function, see"lc" in perlfunc, see"lc" in perlfunc, or the equivalent\L operator inside doublequotish strings.
toupperThis is similar to the C function, except that it can apply to a single character or to a whole string, and currently operates as if the locale always is "C". Consider using theuc() function, see"uc" in perlfunc, or the equivalent\U operator inside doublequotish strings.
truncReturns the integer toward zero from the argument [C99].
ttynameThis is identical to the C functionttyname() for returning the name of the current terminal.
tznameRetrieves the time conversion information from thetzname variable.
POSIX::tzset();($std, $dst) = POSIX::tzname();tzsetThis is identical to the C functiontzset() for setting the current timezone based on the environment variableTZ, to be used byctime(),localtime(),mktime(), andstrftime() functions.
umaskThis is identical to Perl's builtinumask() function for setting (and querying) the file creation permission mask, see"umask" in perlfunc.
unameGet name of current operating system.
($sysname, $nodename, $release, $version, $machine)= POSIX::uname();Note that the actual meanings of the various fields are not that well standardized, do not expect any great portability. The$sysname might be the name of the operating system, the$nodename might be the name of the host, the$release might be the (major) release number of the operating system, the$version might be the (minor) release number of the operating system, and the$machine might be a hardware identifier. Maybe.
ungetcNot implemented. Use methodIO::Handle::ungetc() instead.
unlinkThis is identical to Perl's builtinunlink() function for removing files, see"unlink" in perlfunc.
utimeThis is identical to Perl's builtinutime() function for changing the time stamps of files and directories, see"utime" in perlfunc.
vfprintfNot implemented.vfprintf() is C-specific, see"printf" in perlfunc instead.
vprintfNot implemented.vprintf() is C-specific, see"printf" in perlfunc instead.
vsprintfNot implemented.vsprintf() is C-specific, see"sprintf" in perlfunc instead.
waitThis is identical to Perl's builtinwait() function, see"wait" in perlfunc.
waitpidWait for a child process to change state. This is identical to Perl's builtinwaitpid() function, see"waitpid" in perlfunc.
$pid = POSIX::waitpid( -1, POSIX::WNOHANG );print "status = ", ($? / 256), "\n";wcstombsThis is identical to the C functionwcstombs().
See"mblen".
wctombThis is identical to the C functionwctomb().
See"mblen".
writeWrite to a file. This uses file descriptors such as those obtained by callingPOSIX::open.
$fd = POSIX::open( "foo", &POSIX::O_WRONLY );$buf = "hello";$bytes = POSIX::write( $fd, $buf, 5 );Returnsundef on failure.
See also"syswrite" in perlfunc.
POSIX::SigActionnewCreates a newPOSIX::SigAction object which corresponds to the Cstruct sigaction. This object will be destroyed automatically when it is no longer needed. The first parameter is the handler, a sub reference. The second parameter is aPOSIX::SigSet object, it defaults to the empty set. The third parameter contains thesa_flags, it defaults to 0.
$sigset = POSIX::SigSet->new(SIGINT, SIGQUIT);$sigaction = POSIX::SigAction->new(\&handler, $sigset, &POSIX::SA_NOCLDSTOP );ThisPOSIX::SigAction object is intended for use with thePOSIX::sigaction() function.
handlermaskflagsaccessor functions to get/set the values of a SigAction object.
$sigset = $sigaction->mask;$sigaction->flags(&POSIX::SA_RESTART);safeaccessor function for the "safe signals" flag of a SigAction object; seeperlipc for general information on safe (a.k.a. "deferred") signals. If you wish to handle a signal safely, use this accessor to set the "safe" flag in thePOSIX::SigAction object:
$sigaction->safe(1);You may also examine the "safe" flag on the output action object which is filled in when given as the third parameter toPOSIX::sigaction():
sigaction(SIGINT, $new_action, $old_action);if ($old_action->safe) { # previous SIGINT handler used safe signals}POSIX::SigRt%SIGRTA hash of the POSIX realtime signal handlers. It is an extension of the standard%SIG, the$POSIX::SIGRT{SIGRTMIN} is roughly equivalent to$SIG{SIGRTMIN}, but the right POSIX moves (see below) are made with thePOSIX::SigSet andPOSIX::sigaction instead of accessing the%SIG.
You can set the%POSIX::SIGRT elements to set the POSIX realtime signal handlers, usedelete andexists on the elements, and usescalar on the%POSIX::SIGRT to find out how many POSIX realtime signals there are available(SIGRTMAX - SIGRTMIN + 1, theSIGRTMAX is a valid POSIX realtime signal).
Setting the%SIGRT elements is equivalent to calling this:
sub new { my ($rtsig, $handler, $flags) = @_; my $sigset = POSIX::SigSet($rtsig); my $sigact = POSIX::SigAction->new($handler,$sigset,$flags); sigaction($rtsig, $sigact);}The flags default to zero, if you want something different you can either uselocal on$POSIX::SigRt::SIGACTION_FLAGS, or you can derive from POSIX::SigRt and define your ownnew() (the tied hash STORE method of the%SIGRT callsnew($rtsig, $handler, $SIGACTION_FLAGS), where the$rtsig ranges from zero toSIGRTMAX - SIGRTMIN + 1).
Just as with any signal, you can usesigaction($rtsig, undef, $oa) to retrieve the installed signal handler (or, rather, the signal action).
NOTE: whether POSIX realtime signals really work in your system, or whether Perl has been compiled so that it works with them, is outside of this discussion.
SIGRTMINReturn the minimum POSIX realtime signal number available, orundef if no POSIX realtime signals are available.
SIGRTMAXReturn the maximum POSIX realtime signal number available, orundef if no POSIX realtime signals are available.
POSIX::SigSetnewCreate a new SigSet object. This object will be destroyed automatically when it is no longer needed. Arguments may be supplied to initialize the set.
Create an empty set.
$sigset = POSIX::SigSet->new;Create a set withSIGUSR1.
$sigset = POSIX::SigSet->new( &POSIX::SIGUSR1 );addsetAdd a signal to a SigSet object.
$sigset->addset( &POSIX::SIGUSR2 );Returnsundef on failure.
delsetRemove a signal from the SigSet object.
$sigset->delset( &POSIX::SIGUSR2 );Returnsundef on failure.
emptysetInitialize the SigSet object to be empty.
$sigset->emptyset();Returnsundef on failure.
fillsetInitialize the SigSet object to include all signals.
$sigset->fillset();Returnsundef on failure.
ismemberTests the SigSet object to see if it contains a specific signal.
if( $sigset->ismember( &POSIX::SIGUSR1 ) ){print "contains SIGUSR1\n";}POSIX::TermiosnewCreate a new Termios object. This object will be destroyed automatically when it is no longer needed. A Termios object corresponds to thetermios C struct.new() mallocs a new one,getattr() fills it from a file descriptor, andsetattr() sets a file descriptor's parameters to match Termios' contents.
$termios = POSIX::Termios->new;getattrGet terminal control attributes.
Obtain the attributes forstdin.
$termios->getattr( 0 ) # Recommended for clarity.$termios->getattr()Obtain the attributes for stdout.
$termios->getattr( 1 )Returnsundef on failure.
getccRetrieve a value from thec_cc field of atermios object. Thec_cc field is an array so an index must be specified.
$c_cc[1] = $termios->getcc(1);getcflagRetrieve thec_cflag field of atermios object.
$c_cflag = $termios->getcflag;getiflagRetrieve thec_iflag field of atermios object.
$c_iflag = $termios->getiflag;getispeedRetrieve the input baud rate.
$ispeed = $termios->getispeed;getlflagRetrieve thec_lflag field of atermios object.
$c_lflag = $termios->getlflag;getoflagRetrieve thec_oflag field of atermios object.
$c_oflag = $termios->getoflag;getospeedRetrieve the output baud rate.
$ospeed = $termios->getospeed;setattrSet terminal control attributes.
Set attributes immediately for stdout.
$termios->setattr( 1, &POSIX::TCSANOW );Returnsundef on failure.
setccSet a value in thec_cc field of atermios object. Thec_cc field is an array so an index must be specified.
$termios->setcc( &POSIX::VEOF, 1 );setcflagSet thec_cflag field of atermios object.
$termios->setcflag( $c_cflag | &POSIX::CLOCAL );setiflagSet thec_iflag field of atermios object.
$termios->setiflag( $c_iflag | &POSIX::BRKINT );setispeedSet the input baud rate.
$termios->setispeed( &POSIX::B9600 );Returnsundef on failure.
setlflagSet thec_lflag field of atermios object.
$termios->setlflag( $c_lflag | &POSIX::ECHO );setoflagSet thec_oflag field of atermios object.
$termios->setoflag( $c_oflag | &POSIX::OPOST );setospeedSet the output baud rate.
$termios->setospeed( &POSIX::B9600 );Returnsundef on failure.
B38400B75B200B134B300B1800B150B0B19200B1200B9600B600B4800B50B2400B110
TCSADRAINTCSANOWTCOONTCIOFLUSHTCOFLUSHTCIONTCIFLUSHTCSAFLUSHTCIOFFTCOOFF
c_cc field valuesVEOFVEOLVERASEVINTRVKILLVQUITVSUSPVSTARTVSTOPVMINVTIMENCCS
c_cflag field valuesCLOCALCREADCSIZECS5CS6CS7CS8CSTOPBHUPCLPARENBPARODD
c_iflag field valuesBRKINTICRNLIGNBRKIGNCRIGNPARINLCRINPCKISTRIPIXOFFIXONPARMRK
c_lflag field valuesECHOECHOEECHOKECHONLICANONIEXTENISIGNOFLSHTOSTOP
c_oflag field valuesOPOST
_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
_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
Imported with the:sys_resource_h tag.
PRIO_PROCESSPRIO_PGRPPRIO_USER
_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
E2BIGEACCESEADDRINUSEEADDRNOTAVAILEAFNOSUPPORTEAGAINEALREADYEBADFEBADMSGEBUSYECANCELEDECHILDECONNABORTEDECONNREFUSEDECONNRESETEDEADLKEDESTADDRREQEDOMEDQUOTEEXISTEFAULTEFBIGEHOSTDOWNEHOSTUNREACHEIDRMEILSEQEINPROGRESSEINTREINVALEIOEISCONNEISDIRELOOPEMFILEEMLINKEMSGSIZEENAMETOOLONGENETDOWNENETRESETENETUNREACHENFILEENOBUFSENODATAENODEVENOENTENOEXECENOLCKENOLINKENOMEMENOMSGENOPROTOOPTENOSPCENOSRENOSTRENOSYSENOTBLKENOTCONNENOTDIRENOTEMPTYENOTRECOVERABLEENOTSOCKENOTSUPENOTTYENXIOEOPNOTSUPPEOTHEREOVERFLOWEOWNERDEADEPERMEPFNOSUPPORTEPIPEEPROCLIMEPROTOEPROTONOSUPPORTEPROTOTYPEERANGEEREMOTEERESTARTEROFSESHUTDOWNESOCKTNOSUPPORTESPIPEESRCHESTALEETIMEETIMEDOUTETOOMANYREFSETXTBSYEUSERSEWOULDBLOCKEXDEV
FD_CLOEXECF_DUPFDF_GETFDF_GETFLF_GETLKF_OKF_RDLCKF_SETFDF_SETFLF_SETLKF_SETLKWF_UNLCKF_WRLCKO_ACCMODEO_APPENDO_CREATO_EXCLO_NOCTTYO_NONBLOCKO_RDONLYO_RDWRO_TRUNCO_WRONLY
DBL_DIGDBL_EPSILONDBL_MANT_DIGDBL_MAXDBL_MAX_10_EXPDBL_MAX_EXPDBL_MINDBL_MIN_10_EXPDBL_MIN_EXPFLT_DIGFLT_EPSILONFLT_MANT_DIGFLT_MAXFLT_MAX_10_EXPFLT_MAX_EXPFLT_MINFLT_MIN_10_EXPFLT_MIN_EXPFLT_RADIXFLT_ROUNDSLDBL_DIGLDBL_EPSILONLDBL_MANT_DIGLDBL_MAXLDBL_MAX_10_EXPLDBL_MAX_EXPLDBL_MINLDBL_MIN_10_EXPLDBL_MIN_EXP
FE_DOWNWARDFE_TONEARESTFE_TOWARDZEROFE_UPWARD on systems that support them.
ARG_MAXCHAR_BITCHAR_MAXCHAR_MINCHILD_MAXINT_MAXINT_MINLINK_MAXLONG_MAXLONG_MINMAX_CANONMAX_INPUTMB_LEN_MAXNAME_MAXNGROUPS_MAXOPEN_MAXPATH_MAXPIPE_BUFSCHAR_MAXSCHAR_MINSHRT_MAXSHRT_MINSSIZE_MAXSTREAM_MAXTZNAME_MAXUCHAR_MAXUINT_MAXULONG_MAXUSHRT_MAX
LC_ALLLC_COLLATELC_CTYPELC_MONETARYLC_NUMERICLC_TIMELC_MESSAGES on systems that support them.
HUGE_VAL
FP_ILOGB0FP_ILOGBNANFP_INFINITEFP_NANFP_NORMALFP_SUBNORMALFP_ZEROINFINITYNANInfNaNM_1_PIM_2_PIM_2_SQRTPIM_EM_LN10M_LN2M_LOG10EM_LOG2EM_PIM_PI_2M_PI_4M_SQRT1_2M_SQRT2 on systems with C99 support.
SA_NOCLDSTOPSA_NOCLDWAITSA_NODEFERSA_ONSTACKSA_RESETHANDSA_RESTARTSA_SIGINFOSIGABRTSIGALRMSIGCHLDSIGCONTSIGFPESIGHUPSIGILLSIGINTSIGKILLSIGPIPESIGQUITSIGSEGVSIGSTOPSIGTERMSIGTSTPSIGTTINSIGTTOUSIGUSR1SIGUSR2SIG_BLOCKSIG_DFLSIG_ERRSIG_IGNSIG_SETMASKSIG_UNBLOCKILL_ILLOPCILL_ILLOPNILL_ILLADRILL_ILLTRPILL_PRVOPCILL_PRVREGILL_COPROCILL_BADSTKFPE_INTDIVFPE_INTOVFFPE_FLTDIVFPE_FLTOVFFPE_FLTUNDFPE_FLTRESFPE_FLTINVFPE_FLTSUBSEGV_MAPERRSEGV_ACCERRBUS_ADRALNBUS_ADRERRBUS_OBJERRTRAP_BRKPTTRAP_TRACECLD_EXITEDCLD_KILLEDCLD_DUMPEDCLD_TRAPPEDCLD_STOPPEDCLD_CONTINUEDPOLL_INPOLL_OUTPOLL_MSGPOLL_ERRPOLL_PRIPOLL_HUPSI_USERSI_QUEUESI_TIMERSI_ASYNCIOSI_MESGQ
S_IRGRPS_IROTHS_IRUSRS_IRWXGS_IRWXOS_IRWXUS_ISGIDS_ISUIDS_IWGRPS_IWOTHS_IWUSRS_IXGRPS_IXOTHS_IXUSR
S_ISBLKS_ISCHRS_ISDIRS_ISFIFOS_ISREG
EXIT_FAILUREEXIT_SUCCESSMB_CUR_MAXRAND_MAX
BUFSIZEOFFILENAME_MAXL_ctermidL_cuseridTMP_MAX
CLK_TCKCLOCKS_PER_SEC
R_OKSEEK_CURSEEK_ENDSEEK_SETSTDIN_FILENOSTDOUT_FILENOSTDERR_FILENOW_OKX_OK
WNOHANGWUNTRACED
WIFEXITEDWEXITSTATUSWIFSIGNALEDWTERMSIGWIFSTOPPEDWSTOPSIG
WIFEXITEDWIFEXITED(${^CHILD_ERROR_NATIVE}) returns true if the child process exited normally (exit() or by falling off the end ofmain())
WEXITSTATUSWEXITSTATUS(${^CHILD_ERROR_NATIVE}) returns the normal exit status of the child process (only meaningful ifWIFEXITED(${^CHILD_ERROR_NATIVE}) is true)
WIFSIGNALEDWIFSIGNALED(${^CHILD_ERROR_NATIVE}) returns true if the child process terminated because of a signal
WTERMSIGWTERMSIG(${^CHILD_ERROR_NATIVE}) returns the signal the child process terminated for (only meaningful ifWIFSIGNALED(${^CHILD_ERROR_NATIVE}) is true)
WIFSTOPPEDWIFSTOPPED(${^CHILD_ERROR_NATIVE}) returns true if the child process is currently stopped (can happen only if you specified the WUNTRACED flag towaitpid())
WSTOPSIGWSTOPSIG(${^CHILD_ERROR_NATIVE}) returns the signal the child process was stopped for (only meaningful ifWIFSTOPPED(${^CHILD_ERROR_NATIVE}) is true)
(Windows only.)
WSAEINTRWSAEBADFWSAEACCESWSAEFAULTWSAEINVALWSAEMFILEWSAEWOULDBLOCKWSAEINPROGRESSWSAEALREADYWSAENOTSOCKWSAEDESTADDRREQWSAEMSGSIZEWSAEPROTOTYPEWSAENOPROTOOPTWSAEPROTONOSUPPORTWSAESOCKTNOSUPPORTWSAEOPNOTSUPPWSAEPFNOSUPPORTWSAEAFNOSUPPORTWSAEADDRINUSEWSAEADDRNOTAVAILWSAENETDOWNWSAENETUNREACHWSAENETRESETWSAECONNABORTEDWSAECONNRESETWSAENOBUFSWSAEISCONNWSAENOTCONNWSAESHUTDOWNWSAETOOMANYREFSWSAETIMEDOUTWSAECONNREFUSEDWSAELOOPWSAENAMETOOLONGWSAEHOSTDOWNWSAEHOSTUNREACHWSAENOTEMPTYWSAEPROCLIMWSAEUSERSWSAEDQUOTWSAESTALEWSAEREMOTEWSAEDISCONWSAENOMOREWSAECANCELLEDWSAEINVALIDPROCTABLEWSAEINVALIDPROVIDERWSAEPROVIDERFAILEDINITWSAEREFUSED
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.