POSIX(3perl)

โœจ NAME โœจ

POSIX โ€” the Perl interface to IEEE Std 1003.1, bestie ๐Ÿ’…

(this is the POSIX(3perl) page from the Perl Programmers Reference Guide, and yes we're reading the whole thing together, no skimming ๐Ÿ™ˆ)


๐ŸŽ€ SYNOPSIS ๐ŸŽ€

okay so here's the vibe upfront, copy-paste energy fr fr:

use POSIX ();
use POSIX qw(setsid);
use POSIX qw(:errno_h :fcntl_h);

printf "EINTR is %d\n", EINTR;

my $sess_id = POSIX::setsid();

my $fd = POSIX::open($path, O_CREAT|O_EXCL|O_WRONLY, 0644);
    # note: that's a filedescriptor, *NOT* a filehandle
that last comment is doing SO much heavy lifting, bestie โ€” it's a filedescriptor, not a filehandle. do not come for me. ๐Ÿซถ

๐ŸŒธ DESCRIPTION ๐ŸŒธ

so the POSIX module lets you access all (or nearly all) of the standard POSIX 1003.1 identifiers. many of those identifiers have been given Perl-ish interfaces, because obviously we're not gonna do things the C way in this house. โœจ

this document gives a condensed list of the features available in the POSIX module. for general info on most of these features, go consult your operating system's manpages, okay? and for functions that are noted as being identical or almost identical to Perl's builtin functions, go consult perlfunc.

the structure is giving organized:

  1. the first section describes POSIX functions from the 1003.1 specification.
  2. the second section describes some classes for signal objects, TTY objects, and other miscellaneous objects.
  3. the remaining sections list various constants and macros in an organization which roughly follows IEEE Std 1003.1b-1993.

also, the notation [C99] marks functions that were added in the ISO/IEC 9899:1999 version of the C language standard. some of those may not be available on your system if it adheres to an earlier standard ๐Ÿ˜ญ and heads up: attempts to use any missing one will result in a fatal runtime error message. not a vibe, but that's the tea.


๐Ÿ’€ CAVEATS ๐Ÿ’€

bestie. sit down. ๐Ÿ“

Everything is exported by default (with a handful of exceptions). this is an unfortunate backwards compatibility feature and its use is strongly discouraged. like, so discouraged. so either:

  • prevent the exporting (by saying use 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 in use POSIX;), you will import hundreds and hundreds of symbols into your namespace. your namespace will simply be full. no cap. ๐Ÿ˜ญ

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 the setjmp() 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 define EDEADLK, or the semantics of the errno values set by open(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 usable ICANON macro after all. this could be construed to be a bug. iconic of them, honestly.

๐Ÿ‘‘ FUNCTIONS ๐Ÿ‘‘

one function at a time, alphabetically, we're so organized:


_exit

This is identical to the C function _exit(). it exits the program immediately, which means among other things buffered I/O is not flushed. ๐Ÿ˜ณ

Note that when using threads and in Linux this is not 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.


abort

This is identical to the C function abort(). it terminates the process with a SIGABRT signal unless caught by a signal handler or if the handler does not return normally (it e.g. does a longjmp).


abs

This is identical to Perl's builtin abs() function, returning the absolute value of its numerical argument โ€” except that POSIX::abs() must be provided an explicit value (rather than relying on an implicit $_):

$absolute_value = POSIX::abs(42);   # good

$absolute_value = POSIX::abs();     # throws exception

access

Determines the accessibility of a file. ๐Ÿ•ต๏ธ

if( POSIX::access( "/", &POSIX::R_OK ) ){
        print "have read permission\n";
}

Returns undef on failure. Note: do not use access() for security purposes. between the access() call and the operation you are preparing for, the permissions might change: a classic race condition. ๐Ÿ’€


acos

This is identical to the C function acos(), returning the arcus cosine of its numerical argument. see also Math::Trig.


acosh

This is identical to the C function acosh(), returning the hyperbolic arcus cosine of its numerical argument [C99]. see also Math::Trig. Added in Perl v5.22. โœจ


alarm

This is identical to Perl's builtin alarm() function, either for arming or disarming the SIGARLM timer โ€” except that POSIX::alarm() must be provided an explicit value (rather than relying on an implicit $_):

POSIX::alarm(3)     # good

POSIX::alarm()      # throws exception

asctime

This is identical to the C function asctime(). 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 equals 0. the $year is 1900-based: 2001 equals 101. $wday and $yday default to zero (and are usually ignored anyway), and $isdst defaults to -1.

Note the result is always in English. use strftime instead to get a result suitable for the current locale โ€” that function's %c format yields the locale's preferred representation. ๐ŸŒˆ


asin

This is identical to the C function asin(), returning the arcus sine of its numerical argument. see also Math::Trig.


asinh

This is identical to the C function asinh(), returning the hyperbolic arcus sine of its numerical argument [C99]. see also Math::Trig. Added in Perl v5.22. โœจ


assert

Unimplemented, but you can use die in perlfunc and the Carp module to achieve similar things. ๐Ÿ™ˆ


atan

This is identical to the C function atan(), returning the arcus tangent of its numerical argument. see also Math::Trig.


atanh

This is identical to the C function atanh(), returning the hyperbolic arcus tangent of its numerical argument [C99]. see also Math::Trig. Added in Perl v5.22. โœจ


atan2

This is identical to Perl's builtin atan2() function, returning the arcus tangent defined by its two numerical arguments, the y coordinate and the x coordinate. see also Math::Trig.


atexit

Not implemented. atexit() is C-specific: use END {} instead, see perlmod.


atof

Not 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.


atoi

Not 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.


atol

Not 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.


bsearch

bsearch() not supplied. for doing binary search on wordlists, see Search::Dict. ๐Ÿ”


calloc

Not implemented. calloc() is C-specific. Perl does memory management transparently. ๐Ÿงš


cbrt

The cube root [C99]. Added in Perl v5.22. โœจ


ceil

This is identical to the C function ceil(), returning the smallest integer value greater than or equal to the given numerical argument.


chdir

This is identical to Perl's builtin chdir() function, allowing one to change the working (default) directory โ€” see "chdir" in perlfunc โ€” with the exception that POSIX::chdir() must be provided an explicit value (rather than relying on an implicit $_):

$rv = POSIX::chdir('path/to/dir');      # good

$rv = POSIX::chdir();                   # throws exception

chmod

This is identical to Perl's builtin chmod() function, allowing one to change file and directory permissions โ€” see "chmod" in perlfunc โ€” with the exception that POSIX::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 exception

as with the built-in chmod(), $file may be a filename or a file handle. ๐Ÿ’…


chown

This is identical to Perl's builtin chown() function, allowing one to change file and directory owners and groups, see "chown" in perlfunc.


clearerr

Not implemented. use the method IO::Handle::clearerr() instead, to reset the error state (if any) and EOF state (if any) of the given stream.


clock

This is identical to the C function clock(), returning the amount of spent processor time in microseconds. โฑ๏ธ


close

Close the file. this uses file descriptors such as those obtained by calling POSIX::open.

$fd = POSIX::open( "foo", &POSIX::O_RDONLY );
POSIX::close( $fd );

Returns undef on failure.

see also "close" in perlfunc.


closedir

This is identical to Perl's builtin closedir() function for closing a directory handle, see "closedir" in perlfunc.


cos

This is identical to Perl's builtin cos() function for returning the cosine of its numerical argument โ€” except that POSIX::cos() must be provided with an explicit value (rather than relying on an implicit $_):

$cosine = POSIX::cos(3);    # good

$cosine = POSIX::cos();     # throws exception

see "cos" in perlfunc; see also Math::Trig.


cosh

This is identical to the C function cosh(), for returning the hyperbolic cosine of its numeric argument. see also Math::Trig.


copysign

Returns x but with the sign of y [C99]. Added in Perl v5.22. โœจ

$x_with_sign_of_y = POSIX::copysign($x, $y);

see also "signbit".

๐ŸŒŸ creat

Spins up a brand-new file for you, bestie. It hands back a file descriptor exactly like the ones POSIX::open returns, and when you're done you close it with POSIX::close. Don't ghost your file descriptors, that's so not it ๐Ÿ’…

$fd = POSIX::creat( "foo", 0611 );
POSIX::close( $fd );

Also go look at sysopen in perlfunc and its O_CREAT flag, iykyk ๐ŸŽ€

๐Ÿ–ฅ๏ธ ctermid

Generates the path name for the controlling terminal. That's the whole job, she's simple and she's thriving โœจ

$path = POSIX::ctermid();

โฐ ctime

Literally identical to the C function ctime(), and it's equivalent to asctime(localtime(...)). Go read asctime and localtime if you want the lore ๐Ÿ’œ

๐Ÿ‘ค cuserid [POSIX.1-1988]

Grabs the login name of the owner of the current process. Cute, right? ๐Ÿซถ

$name = POSIX::cuserid();
โš ๏ธ Heads up bestie: this function has not been specified by POSIX since 1990 and is hanging around purely for backwards compatibility. New code should use getlogin() instead. She's iconic but she's retired ๐Ÿ’€

โŒ› difftime

Identical to the C function difftime(). It returns the time difference (in seconds) between two times, the kind you get back from time(). Go see time ๐ŸŒธ

โž— div

Not implemented. div() is C-specific, so likeโ€ฆ use int in perlfunc on the usual / division and the modulus % instead. We do it differently here, periodt ๐Ÿ’…

๐Ÿ“Ž dup

Similar to the C function dup(), for duplicating a file descriptor. It works with file descriptors such as those you get from calling POSIX::open.

Returns undef on failure ๐Ÿซ 

๐Ÿ“Ž๐Ÿ“Ž dup2

Similar to the C function dup2(), for duplicating a file descriptor onto another known file descriptor. Also uses file descriptors such as those obtained by calling POSIX::open.

Returns undef on failure ๐Ÿ˜ญ

๐Ÿ“ˆ erf

The error function [C99]. Added in Perl v5.22 โœจ

๐Ÿ“‰ erfc

The complementary error function [C99]. Added in Perl v5.22 โœจ

๐Ÿšจ errno

Returns the value of errno, no cap.

$errno = POSIX::errno();

This is identical to the numerical values of $! โ€” go check "$ERRNO" in perlvar ๐Ÿ’œ

๐Ÿšซ execl

Not implemented. execl() is C-specific, see exec in perlfunc.

๐Ÿšซ execle

Not implemented. execle() is C-specific, see exec in perlfunc.

๐Ÿšซ execlp

Not implemented. execlp() is C-specific, see exec in perlfunc.

๐Ÿšซ execv

Not implemented. execv() is C-specific, see exec in perlfunc.

๐Ÿšซ execve

Not implemented. execve() is C-specific, see exec in perlfunc.

๐Ÿšซ execvp

Not implemented. execvp() is C-specific, see exec in perlfunc.

๐Ÿšช exit

Identical to Perl's builtin exit() function for exiting the program. Go see exit in perlfunc ๐Ÿ‘‘

๐ŸŒฑ exp

Identical to Perl's builtin exp() function โ€” it returns the exponent (e-based) of the numerical argument. But here's the catch, bestie: POSIX::exp() must be given an explicit value, it will NOT just vibe off an implicit $_:

$exp = POSIX::exp(3);    # good

$exp = POSIX::exp();     # throws exception

See exp in perlfunc ๐Ÿ’ฅ

๐ŸŒฑโž• expm1

Equivalent to exp(x) - 1, but more precise for small argument values [C99]. Added in Perl v5.22.

See also log1p ๐Ÿฆ‹

๐Ÿ“ fabs

Identical to Perl's builtin abs() function, returning the absolute value of the numerical argument โ€” except that POSIX::fabs() must be handed an explicit value rather than relying on an implicit $_:

$absolute_value = POSIX::fabs(3);    # good

$absolute_value = POSIX::fabs();     # throws exception

See abs in perlfunc โœจ

๐Ÿ—‘๏ธ fclose

Not implemented. Use the method IO::Handle::close() instead, or see close in perlfunc.

๐ŸŽ›๏ธ fcntl

Identical to Perl's builtin fcntl() function, see fcntl in perlfunc.

๐Ÿ—‘๏ธ fdopen

Not implemented. Use the method IO::Handle::new_from_fd() instead, or see open in perlfunc.

๐Ÿ—‘๏ธ feof

Not implemented. Use the method IO::Handle::eof() instead, or see eof in perlfunc.

๐Ÿ—‘๏ธ ferror

Not implemented. Use the method IO::Handle::error() instead.

๐Ÿ—‘๏ธ fflush

Not implemented. Use the method IO::Handle::flush() instead. See also "$OUTPUT_AUTOFLUSH" in perlvar ๐Ÿ’ง

๐Ÿ—‘๏ธ fgetc

Not implemented. Use the method IO::Handle::getc() instead, or see read in perlfunc.

๐Ÿ—‘๏ธ fgetpos

Not implemented. Use the method IO::Seekable::getpos() instead, or see seek in perlfunc.

๐Ÿ—‘๏ธ fgets

Not implemented. Use the method IO::Handle::gets() instead. Similar to <>, also known as readline in perlfunc.

๐Ÿ—‘๏ธ fileno

Not implemented. Use the method IO::Handle::fileno() instead, or see fileno in perlfunc.

๐Ÿข floor

Identical to the C function floor(), returning the largest integer value that's less than or equal to the numerical argument. Round down and slay ๐Ÿ’…

โž– fdim

"Positive difference": it's x - y if x > y, and zero otherwise [C99]. Added in Perl v5.22 โœจ

๐ŸŽฏ fegetround

Returns the current floating point rounding mode, and it's one of these:

FE_TONEAREST FE_TOWARDZERO FE_UPWARD FE_DOWNWARD

FE_TONEAREST is like round, and FE_TOWARDZERO is like trunc [C99]. Added in Perl v5.22 ๐ŸŽ€

๐ŸŽฏ fesetround

Sets the floating point rounding mode, see fegetround [C99]. Added in Perl v5.22 โœจ

โœ–๏ธโž• fma

The "Fused multiply-add" โ€” that's x * y + z, and it's possibly faster (and less lossy) than doing the explicit two operations [C99]. Added in Perl v5.22.

my $fused = POSIX::fma($x, $y, $z);

โฌ†๏ธ fmax

The maximum of x and y โ€” except when either one is NaN, in which case it returns the other one [C99]. Added in Perl v5.22.

my $max = POSIX::fmax($x, $y);

โฌ‡๏ธ fmin

The minimum of x and y โ€” except when either one is NaN, in which case it returns the other one [C99]. Added in Perl v5.22.

my $min = POSIX::fmin($x, $y);

๐Ÿ” fmod

Identical to the C function fmod().

$r = fmod($x, $y);

It returns the remainder $r = $x - $n*$y, where $n = trunc($x/$y). The $r carries the same sign as $x and a magnitude (absolute value) that's less than the magnitude of $y ๐Ÿงฎ

๐Ÿ—‘๏ธ fopen

Not implemented. Use the method IO::File::open() instead, or see open in perlfunc.

๐Ÿด fork

Identical to Perl's builtin fork() function for duplicating the current process, see fork in perlfunc and perlfork if you are in Windows ๐Ÿ‘ฏ

๐Ÿ“‚ fpathconf

Retrieves the value of a configurable limit on a file or directory. This one works with file descriptors such as those you get from calling POSIX::open.

The following will determine the maximum length of the longest allowable pathname on the filesystem that holds /var/foo:

$fd = POSIX::open( "/var/foo", &POSIX::O_RDONLY );
$path_max = POSIX::fpathconf($fd, &POSIX::_PC_PATH_MAX);

Returns undef on failure ๐Ÿซ 

๐Ÿ”ฎ fpclassify

Returns one of these, telling you the class of the argument [C99]:

FP_NORMAL FP_ZERO FP_SUBNORMAL FP_INFINITE FP_NAN

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. Added in Perl v5.22 ๐ŸŒˆ

๐Ÿšซ fprintf

Not implemented. fprintf() is C-specific, see printf in perlfunc instead.

๐Ÿšซ fputc

Not implemented. fputc() is C-specific, see print in perlfunc instead.

๐Ÿšซ fputs

Not implemented. fputs() is C-specific, see print in perlfunc instead.

๐Ÿšซ fread

Not implemented. fread() is C-specific, see read in perlfunc instead.

๐Ÿง  free

Not implemented. free() is C-specific. Perl does memory management transparently, so you literally never have to worry about it. Iconic behaviour honestly ๐Ÿ‘‘

๐Ÿšซ freopen

Not implemented. freopen() is C-specific, see open in perlfunc instead.

๐Ÿ”ฌ frexp

Returns the mantissa and exponent of a floating-point number.

($mantissa, $exponent) = POSIX::frexp( 1.234e56 );

๐Ÿšซ fscanf

Not implemented. fscanf() is C-specific โ€” use <> and regular expressions instead, bestie ๐Ÿ’…

๐Ÿ—‘๏ธ fseek

Not implemented. Use the method IO::Seekable::seek() instead, or see seek in perlfunc.

๐Ÿ—‘๏ธ fsetpos

Not implemented. Use the method IO::Seekable::setpos() instead, or seek "seek" in perlfunc.

๐Ÿ“Š fstat

Get file status, girl. This uses file descriptors such as those obtained by calling POSIX::open. The data you get back is identical to the data from Perl's builtin stat function.

$fd = POSIX::open( "foo", &POSIX::O_RDONLY );
@stats = POSIX::fstat( $fd );

๐Ÿ—‘๏ธ fsync

Not implemented. Use the method IO::Handle::sync() instead.

๐Ÿ—‘๏ธ ftell

Not implemented. Use the method IO::Seekable::tell() instead, or see tell in perlfunc.

๐Ÿšซ fwrite

Not implemented. fwrite() is C-specific, see print in perlfunc instead.

๐Ÿ”ค getc

Identical to Perl's builtin getc() function, see getc in perlfunc.

โŒจ๏ธ getchar

Returns one character from STDIN. Identical to Perl's getc(), see getc in perlfunc.

๐Ÿ“ getcwd

Returns the name of the current working directory. See also Cwd ๐Ÿ’–

๐Ÿ‘ฅ getegid

Returns the effective group identifier. Similar to Perl's builtin variable $(, see "$EGID" in perlvar.

๐ŸŒ getenv

Returns the value of the specified environment variable. The exact same information is available through the %ENV array.

๐Ÿ‘ค geteuid

Returns the effective user identifier. Identical to Perl's builtin $> variable, see "$EUID" in perlvar.

๐Ÿ‘ฅ getgid

Returns the user's real group identifier. Similar to Perl's builtin variable $), see "$GID" in perlvar.

๐Ÿ‘ฅ getgrgid

Identical to Perl's builtin getgrgid() function for returning group entries by group identifiers, see getgrgid in perlfunc.

๐Ÿ‘ฅ getgrnam

Identical to Perl's builtin getgrnam() function for returning group entries by group names, see getgrnam in perlfunc.

๐Ÿ‘ฏ getgroups

Returns the ids of the user's supplementary groups. Similar to Perl's builtin variable $), see "$GID" in perlvar.

๐Ÿ™‹ getlogin

Identical to Perl's builtin getlogin() function for returning the user name associated with the current session, see getlogin in perlfunc.

๐Ÿงฌ getpayload

use POSIX ':nan_payload';
getpayload($var)

Okay so this one literally just hands you back the "NaN" payload โœจ Added in Perl v5.24.

Heads up tho bestie, there's an API instability warning over in "setpayload" โ€” go read it before you get attached.

And for the full tea on "NaN", check "nan".


getpgrp

Same energy as Perl's builtin getpgrp() function โ€” it gives you the process group identifier of the current process. See "getpgrp" in perlfunc.

getpid

Returns the process identifier. Identical to Perl's builtin variable $$, see "$PID" in perlvar. ๐Ÿ’…

getppid

Identical to Perl's builtin getppid() function, which returns the process identifier of the parent process of the current process. See "getppid" in perlfunc.

getpwnam

Identical to Perl's builtin getpwnam() function โ€” returns user entries by user names. See "getpwnam" in perlfunc.

getpwuid

Identical to Perl's builtin getpwuid() function โ€” returns user entries by user identifiers. See "getpwuid" in perlfunc.

gets

Returns one line from STDIN, similar to <>, also known as the readline() function. See "readline" in perlfunc.

NOTE: if you have C programs that still use gets(), be very afraid ๐Ÿ˜ญ The gets() function is a source of endless grief because it has no buffer overrun checks. It should never be used. The fgets() function should be preferred instead.

getuid

Returns the user's identifier. Identical to Perl's builtin $< variable, see "$UID" in perlvar. ๐Ÿซถ

gmtime

Identical to Perl's builtin gmtime() function, for converting seconds since the epoch to a date in Greenwich Mean Time. See "gmtime" in perlfunc.

hypot

Equivalent to sqrt(x * x + y * y) except it's wayyy more stable on very large or very small arguments [C99]. Added in Perl v5.22. ๐Ÿฆ‹

ilogb

Integer binary logarithm [C99]. Added in Perl v5.22.

For example ilogb(20) is 4, as an integer.

See also "logb".

Inf

The infinity as a constant, periodt:

use POSIX qw(Inf);
my $pos_inf = +Inf;  # Or just Inf.
my $neg_inf = -Inf;

See also "isinf", and "fpclassify".

isalnum

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:alnum:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isalpha

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:alpha:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isatty

Returns a boolean telling you whether the specified filehandle is connected to a tty. Similar to the -t operator, see "-X" in perlfunc.

iscntrl

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:cntrl:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isdigit

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:digit:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isfinite

Returns true if the argument is a finite number (that is, not an infinity, or the not-a-number) [C99]. Added in Perl v5.22.

See also "isinf", "isnan", and "fpclassify".

isgraph

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:graph:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isgreater

(Also isgreaterequal, isless, islessequal, islessgreater, isunordered)

Floating point comparisons which handle the "NaN" [C99]. Added in Perl v5.22.

isinf

Returns true if the argument is an infinity (positive or negative) [C99]. Added in Perl v5.22.

See also "Inf", "isnan", "isfinite", and "fpclassify".

islower

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:lower:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isnan

Returns true if the argument is "NaN" (not-a-number) [C99]. Added in Perl v5.22. ๐Ÿ’€

Note that you can also test for "NaN"-ness with equality operators (== or !=), as in

print "x is not a NaN\n" if $x == $x;

since the "NaN" is not equal to anything, including itself. (iconic behaviour honestly)

See also "nan", "NaN", "isinf", and "fpclassify".

isnormal

Returns true if the argument is normal (that is, not a subnormal/denormal, and not an infinity, or a not-a-number) [C99]. Added in Perl v5.22.

See also "isfinite", and "fpclassify".

isprint

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:print:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

ispunct

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:punct:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

issignaling

use POSIX ':nan_payload';
issignaling($var, $payload)

Return true if the argument is a signaling NaN. Added in Perl v5.24.

Note the API instability warning in "setpayload".

See "nan" for more discussion about "NaN".

isspace

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:space:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isupper

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:upper:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

isxdigit

This function has been removed as of Perl v5.24. It was very similar to matching against qr/ ^ [[:xdigit:]]+ $ /x, which you should convert to use instead. See "POSIX Character Classes" in perlrecharclass.

j0, j1, jn, y0, y1, yn

The Bessel function of the first kind of the order zero. โœจ

kill

Identical to Perl's builtin kill() function for sending signals to processes (often to terminate them). See "kill" in perlfunc.

labs

Not implemented. (For returning absolute values of long integers.) labs() is C-specific โ€” see "abs" in perlfunc instead.

lchown

Identical to the C function, except the order of arguments is consistent with Perl's builtin chown(), with the added restriction of only one path, not a list of paths. Does the same thing as the chown() function, but changes the owner of a symbolic link instead of the file the symbolic link points to. ๐Ÿ’…

POSIX::lchown($uid, $gid, $file_path);

ldexp

Identical to the C function ldexp() for multiplying floating point numbers with powers of two.

$x_quadrupled = POSIX::ldexp($x, 2);

ldiv

Not implemented. (For computing dividends of long integers.) ldiv() is C-specific โ€” use / and int() instead.

lgamma

The logarithm of the Gamma function [C99]. Added in Perl v5.22.

See also "tgamma".

log1p

Equivalent to log(1 + x), but with more stable results for small argument values [C99]. Added in Perl v5.22. ๐Ÿ“

log2

Logarithm base two [C99]. Added in Perl v5.22.

See also "expm1".

logb

Integer binary logarithm [C99]. Added in Perl v5.22.

For example logb(20) is 4, as a floating point number.

See also "ilogb".

Identical to Perl's builtin link() function for creating hard links into files. See "link" in perlfunc.

localeconv

Get numeric formatting information. Returns a reference to a hash containing the formatting values of the locale that currently underlies the program, regardless of whether or not it is called from within the scope of a use locale. ๐Ÿ’–

If you use this function you should also read perllocale, which gives a comprehensive discussion of Perl locale handling, including a whole section devoted to this function.

Warning, bestie: 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 have a race with a thread that has called "switch_to_global_locale" in perlapi.

Here is how to query the database for the de (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_point
                               thousands_sep
                               grouping
                               int_curr_symbol
                               currency_symbol
                               mon_decimal_point
                               mon_thousands_sep
                               mon_grouping
                               positive_sign
                               negative_sign
                               int_frac_digits
                               frac_digits
                               p_cs_precedes
                               p_sep_by_space
                               n_cs_precedes
                               n_sep_by_space
                               p_sign_posn
                               n_sign_posn
                               int_p_cs_precedes
                               int_p_sep_by_space
                               int_n_cs_precedes
                               int_n_sep_by_space
                               int_p_sign_posn
                               int_n_sign_posn
                       ))
                       {
                               printf qq(%s: "%s",\n),
                                       $property, $lconv->{$property};
                       }

okay so the members whose names start with "int_p_" and "int_n_"? Those got added by POSIX.1-2008, so bestie, they're only living on systems that actually support them ๐Ÿ’…

and if you get a value of -1 back for one of the numeric entries, that's the universe telling you the field is not applicable to the locale. That's rare, fr fr โ€” mostly it happens in the C locale and its little friends, which just don't have most monetary values defined at all. It can also happen, quirkily, in fields that are otherwise boolean, to signal that the value is kinda neither true nor false ๐Ÿซ  and that specifically goes down in "p_cs_precedes" and "int_p_cs_precedes" when the currency symbol neither precedes nor succeeds a positive value but is infixed instead, by replacing the radix character.

heads up! Prior to Perl v5.37.7, empty string fields and numeric fields with value -1 were omitted from the returned hash. So if you're on old Perl, don't go looking for a key that isn't there ๐Ÿ˜ญ

๐ŸŒธ "localtime" ๐ŸŒธ

This one is identical to Perl's builtin localtime() function for converting seconds since the epoch to a date โ€” see "localtime" in perlfunc โ€” EXCEPT that POSIX::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 exception

๐Ÿฆ‹ "log" ๐Ÿฆ‹

Identical to Perl's builtin log() function for returning the natural (e-based) logarithm of the numerical argument โ€” except that POSIX::log() must be given an explicit value (rather than relying on an implicit $_):

$log = POSIX::log(3);    # good

$log = POSIX::log();     # throws exception

see "log" in perlfunc ๐Ÿ’–


โœจ "log10" โœจ

This is identical to the C function log10(), 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 }

๐Ÿ’€ "longjmp" ๐Ÿ’€

Not implemented. longjmp() is C-specific: use "die" in perlfunc instead. like, just die, bestie, it's fine ๐Ÿ™ˆ


๐ŸŒˆ "lseek" ๐ŸŒˆ

Move the file's read/write position. This uses file descriptors such as those obtained by calling "POSIX::open".

$fd = POSIX::open( "foo", &POSIX::O_RDONLY );
$off_t = POSIX::lseek( $fd, 0, &POSIX::SEEK_SET );

Returns "undef" on failure. ๐Ÿ˜ญ


๐ŸŽ€ "lrint" ๐ŸŽ€

Depending 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]. Added in Perl v5.22 ๐Ÿ‘‘

For the rounding mode, see "fegetround".


โญ "lround" โญ

Like "round", but as integer, as opposed to floating point [C99]. Added in Perl v5.22.

See also "ceil", "floor", "trunc".

okay so this is a whole thing: 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. iykyk, go say its name out loud in your use POSIX line ๐Ÿ’…

๐Ÿ“ "malloc" ๐Ÿ“

Not implemented. malloc() is C-specific. Perl does memory management transparently. let it go, girl, Perl's got this ๐Ÿงš


๐Ÿ’œ "mblen" ๐Ÿ’œ

This is the same as the C function mblen() on unthreaded perls. On threaded perls, it transparently (almost) substitutes the more thread-safe "mbrlen(3)", if available, instead of "mblen".

Core Perl does not have any support for wide and multibyte locales, except Unicode UTF-8 locales. This function, in conjunction with "mbtowc" and "wctomb" may be used to roll your own decoding/encoding of other types of multi-byte locales ๐Ÿ‘‘

Use "undef" as the first parameter to this function to get the effect of passing NULL as the first parameter to "mblen". This resets any shift state to its initial value. The return value is undefined if "mbrlen" was substituted, so you should never rely on it.

When the first parameter is a scalar containing a value that either is a PV string or can be forced into one, the return value is the number of bytes occupied by the first character of that string; or 0 if that first character is the wide NUL character; or negative if there is an error. This is based on the locale that currently underlies the program, regardless of whether or not the function is called from Perl code that is within the scope of use locale. Perl makes no attempt at hiding from your code any differences in the "errno" setting between "mblen" and "mbrlen". It does set "errno" to 0 before calling them.

The optional second parameter is ignored if it is larger than the actual length of the first parameter string.


๐ŸŒธ "mbtowc" ๐ŸŒธ

This is the same as the C function mbtowc() on unthreaded perls. On threaded perls, it transparently (almost) substitutes the more thread-safe "mbrtowc(3)", if available, instead of "mbtowc".

Core Perl does not have any support for wide and multibyte locales, except Unicode UTF-8 locales. This function, in conjunction with "mblen" and "wctomb" may be used to roll your own decoding/encoding of other types of multi-byte locales.

The first parameter is a scalar into which, upon success, the wide character represented by the multi-byte string contained in the second parameter is stored. The optional third parameter is ignored if it is larger than the actual length of the second parameter string.

Use "undef" as the second parameter to this function to get the effect of passing NULL as the second parameter to "mbtowc". This ignores the first parameter, and resets any shift state to its initial value. The return value is undefined if "mbrtowc" was substituted, so you should never rely on it.

When the second parameter is a scalar containing a value that either is a PV string or can be forced into one, the return value is the number of bytes occupied by the first character of that string; or 0 if that first character is the wide NUL character; or negative if there is an error. This is based on the locale that currently underlies the program, regardless of whether or not the function is called from Perl code that is within the scope of use locale. Perl makes no attempt at hiding from your code any differences in the "errno" setting between "mbtowc" and "mbrtowc". It does set "errno" to 0 before calling them.


๐Ÿฆ‹ "memchr" ๐Ÿฆ‹

Not implemented. memchr() is C-specific, see "index" in perlfunc instead.


๐Ÿ’… "memcmp" ๐Ÿ’…

Not implemented. memcmp() is C-specific, use "eq" instead, see perlop.


โœจ "memcpy" โœจ

Not implemented. memcpy() is C-specific, use "=", see perlop, or see "substr" in perlfunc.


โœจ "memmove" โœจ

Not implemented. memmove() is C-specific, use "=", see perlop, or see "substr" in perlfunc.


๐ŸŽ€ "memset" ๐ŸŽ€

Not implemented. memset() is C-specific, use "x" instead, see perlop.


๐Ÿ‘‘ "mkdir" ๐Ÿ‘‘

This is identical to Perl's builtin mkdir() function for creating directories, see "mkdir" in perlfunc. slay, directories ๐Ÿซถ


๐ŸŒˆ "mkfifo" ๐ŸŒˆ

This is similar to the C function mkfifo() for creating FIFO special files.

if (mkfifo($path, $mode)) { ....

Returns "undef" on failure. The $mode is similar to the mode of mkdir(), see "mkdir" in perlfunc, though for "mkfifo" you must specify the $mode. no vibing your way out of this one, bestie ๐Ÿ˜ญ


๐Ÿ’– "mktime" ๐Ÿ’–

Convert 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's mktime() 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);

Returns "undef" on failure.


๐Ÿงš "modf" ๐Ÿงš

Return the integral and fractional parts of a floating-point number.

($fractional, $integral) = POSIX::modf( 3.14 );

See also "round".


โญ "NaN" โญ

The not-a-number as a constant:

use POSIX qw(NaN);
my $nan = NaN;

See also "nan", "/isnan", and "fpclassify".


๐Ÿ’œ "nan" ๐Ÿ’œ

my $nan = nan();

Returns "NaN", not-a-number [C99]. Added in Perl v5.22.

The returned NaN is always a quiet NaN, as opposed to signaling. quiet, like me during a group project ๐Ÿซ 

With an argument, nan level-ups into โœจpayload modeโœจ โ€” it can generate a NaN with payload. The argument is first interpreted as a floating point number, 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. ๐Ÿ’…

That result has a genuine dual nature, bestie: it is a NaN, but it also carries the integer inside it. You can pull the integer back out with getpayload. BUT โ€” and this is the tea โ€” 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. rude.) 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, use setpayload 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.


nearbyint

Hands you the nearest integer to the argument, and it respects whatever the current rounding mode is (peep fegetround for that whole situation) [C99]. Added in Perl v5.22. โœจ

nextafter

Gives you the next representable floating point number after x in the direction of y [C99]. Added in Perl v5.22. ๐Ÿฆ‹

my $nextafter = POSIX::nextafter($x, $y);

Like nexttoward, but potentially less accurate. ๐Ÿ˜ฌ

nexttoward

Returns the next representable floating point number after x in the direction of y [C99]. Added in Perl v5.22. ๐ŸŒธ

my $nexttoward = POSIX::nexttoward($x, $y);

Like nextafter, but potentially more accurate. ๐Ÿ‘‘

nice

This is similar to the C function nice(), 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 โ€” so close, bestie, no demanding CPU without the privilege.

Returns undef on failure.

offsetof

Not implemented. offsetof() is C-specific, you probably want to see pack in perlfunc instead.

open

Open a file for reading for writing. This returns file descriptors, not Perl filehandles โ€” so it's giving very low-level ๐Ÿ’…. Use POSIX::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
);

Returns undef on failure.

See also sysopen in perlfunc.

opendir

Open a directory for reading, bestie. ๐ŸŽ€

$dir = POSIX::opendir( "/var" );
@files = POSIX::readdir( $dir );
POSIX::closedir( $dir );

Returns undef on failure.

pathconf

Retrieves the value of a configurable limit on a file or directory. Very nitty, very gritty. ๐Ÿ”

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 );

Returns undef on failure.

pause

This is similar to the C function pause(), which suspends the execution of the current process until a signal is received. Literally the "wait for a text back" of syscalls. ๐Ÿ˜ญ

Returns undef on failure.

perror

This is identical to the C function perror(), which outputs to the standard error stream the specified message followed by ": " and the current error string. Use the warn() function and the $! variable instead, see warn in perlfunc and $ERRNO in perlvar. fr fr, that's the move.

pipe

Create an interprocess channel. This returns file descriptors like those returned by POSIX::open. ๐ŸŒˆ

my ($read, $write) = POSIX::pipe();
POSIX::write( $write, "hello", 5 );
POSIX::read( $read, $buf, 5 );

See also pipe in perlfunc.

pow

Computes $x raised to the power $exponent.

$ret = POSIX::pow( $x, $exponent );

You can also use the ** operator, see perlop. way easier ngl.

printf

Formats and prints the specified arguments to STDOUT. See also printf in perlfunc.

putc

Not implemented. putc() is C-specific, see print in perlfunc instead.

putchar

Not implemented. putchar() is C-specific, see print in perlfunc instead.

puts

Not implemented. puts() is C-specific, see print in perlfunc instead.

qsort

Not implemented. qsort() is C-specific, see sort in perlfunc instead.

raise

Sends the specified signal to the current process. See also kill in perlfunc and the $$ in $PID in perlvar.

rand

Not implemented. rand() is non-portable, see rand in perlfunc instead.

read

Read from a file. This uses file descriptors such as those obtained by calling POSIX::open. If the buffer $buf is not large enough for the read then Perl will extend it to make room for the request โ€” it's so accommodating. ๐Ÿซถ

$fd = POSIX::open( "foo", &POSIX::O_RDONLY );
$bytes = POSIX::read( $fd, $buf, 3 );

Returns undef on failure.

See also sysread in perlfunc.

readdir

This is identical to Perl's builtin readdir() function for reading directory entries, see readdir in perlfunc.

realloc

Not implemented. realloc() is C-specific. Perl does memory management transparently. you simply do not have to think about it ๐Ÿ’…โœจ

remainder

Given x and y, returns the value x - n*y, where n is the integer closest to x/y [C99]. Added in Perl v5.22. ๐ŸŒธ

my $remainder = POSIX::remainder($x, $y)

See also remquo.

remove

Deletes a name from the filesystem. Calls unlink in perlfunc for files and rmdir in perlfunc for directories.

remquo

Like remainder but also returns the low-order bits of the quotient (n) [C99]. Added in Perl v5.22.

(This is quite esoteric interface, mainly used to implement numerical algorithms.) so if you're not building a numerical algorithm, this is not your moment bestie ๐Ÿ™ˆ

rename

This is identical to Perl's builtin rename() function for renaming files, see rename in perlfunc.

rewind

Seeks to the beginning of the file. โช

rewinddir

This is identical to Perl's builtin rewinddir() function for rewinding directory entry streams, see rewinddir in perlfunc.

rint

Identical to lrint.

rmdir

This is identical to Perl's builtin rmdir() function for removing (empty) directories, see rmdir in perlfunc.

round

Returns the integer (but still as floating point) nearest to the argument [C99]. Added in Perl v5.22. ๐ŸŽฏ

See also ceil, floor, lround, modf, and trunc.

scalbn

Returns x * 2**y [C99]. Added in Perl v5.22. โœจ

See also frexp and ldexp.

scanf

Not implemented. scanf() is C-specific, use <> and regular expressions instead, see perlre.

setgid

Sets 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. subtle difference, huge consequences, iykyk ๐Ÿ’…

setjmp

Not implemented. setjmp() is C-specific: use eval {} instead, see eval in perlfunc.

setlocale

WARNING! Prior to Perl 5.28 or on a system that does not support thread-safe locale operations, do NOT use this function in a thread. 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. This warning does not apply on unthreaded builds, or on perls where ${^SAFE_LOCALES} exists and is non-zero; namely Perl 5.28 and later compiled to be locale-thread-safe.

Okay bestie, deep breath. This function modifies and queries the program's underlying locale. Users of this function should read perllocale, whch provides a comprehensive discussion of Perl locale handling, knowledge of which is necessary to properly use this function. It contains a section devoted to this function. The discussion here is merely a summary reference for setlocale(). 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, and locale-dependent functions within the POSIX module ARE always affected by the current locale.) ๐Ÿ‘‘

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 current LC_CTYPE category. (No second argument means 'query'.)

$loc = setlocale( LC_CTYPE );

and that's only the query half of this icon, bestie โ€” hold that thought ๐Ÿ’œ

ok so the following sets the LC_CTYPE behaviour based on the locale environment variables (that's the second argument, the empty string "" bestie ๐Ÿ’ซ). Wanna know what those locale env vars even mean? Go read your system's setlocale(3) docs, or pull up perllocale. iykyk.

$loc = setlocale( LC_CTYPE, "" );

And this next one sets the LC_COLLATE behaviour to Argentinian Spanish. NOTE: the naming and availability of locales is fully dependent on your operating system, no cap. Please consult perllocale to find out which locales your system actually has, because guessing is not the vibe. ๐Ÿ™ˆ

$loc = setlocale( LC_COLLATE, "es_AR.ISO8859-1" );

setpayload ๐Ÿ’…

use POSIX ':nan_payload';
setpayload($var, $payload);

Sets the NaN payload of var. Added back in Perl v5.24. โœจ

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 โ€” so don't build your whole personality on them, okay? ๐Ÿ˜ญ

See "nan" for more discussion about NaN.

See also "setpayloadsig", "isnan", "getpayload", and "issignaling".


setpayloadsig ๐Ÿฆ‹

use POSIX ':nan_payload';
setpayloadsig($var, $payload);

Like setpayload but it also makes the NaN signaling. Added in Perl v5.24.

Depending on the platform the NaN may or may not behave differently. ๐Ÿคทโ™€๏ธ

Keep the API instability warning from "setpayload" in mind, fr fr.

Also note: because of how floating point formats work out, on the most common platforms a signaling payload of zero is best avoided, since it might end up being completely identical to +Inf. major yikes.

See also "nan", "isnan", "getpayload", and "issignaling".


setpgid โœจ

This is similar to the C function setpgid() for setting the process group identifier of the current process. Slay.

Returns undef on failure. ๐Ÿ’€


setsid ๐ŸŒธ

This is identical to the C function setsid() for setting the session identifier of the current process. Iconic, no notes.


setuid ๐Ÿ‘‘

Sets the real user identifier and the effective user identifier for this process. Similar to assigning a value to Perl's builtin $< variable โ€” see "$UID" in perlvar โ€” except that the latter will change only the real user identifier. Sneaky difference, bestie.


sigaction ๐Ÿ’…

Detailed signal management, okay? This uses POSIX::SigAction objects for the action and oldaction arguments (and oldaction can also just be a plain hash reference). Consult your system's sigaction manpage for the deets, and see also POSIX::SigRt.

Synopsis:

sigaction(signal, action, oldaction = 0)

Returns undef on failure. The signal must be a number (like SIGHUP), not a string (like "SIGHUP") โ€” though Perl does try really hard to understand you. ๐Ÿฅบ

If you use the SA_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 live the following keys with the following semantics, as defined by POSIX/SUSv3:

  • signo โ€” the signal number
  • errno โ€” the error number
  • code โ€” 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 kernel

The constants for specific code values can be imported individually or using the :signal_h_si_code tag, since Perl v5.24.

The following are also defined by POSIX/SUSv3, but unfortunately not very widely implemented:

  • pid โ€” the process id generating the signal
  • uid โ€” the uid of the process id generating the signal
  • status โ€” exit value or signal for SIGCHLD
  • band โ€” band event for SIGPOLL
  • addr โ€” address of faulting instruction or memory reference for SIGILL, SIGFPE, SIGSEGV or SIGBUS

A third argument is also passed to the handler, which contains a copy of the raw binary contents of the siginfo structure: if a system has some non-POSIX fields, this third argument is where to unpack() them from. ๐Ÿงš

Note that not all siginfo values make sense simultaneously (some are valid only for certain signals, for example), and not all values make sense from the Perl perspective โ€” you should consult your system's sigaction and possibly also siginfo documentation. Do your reading, bestie ๐Ÿ“š.


siglongjmp ๐Ÿซถ

Not implemented. siglongjmp() is C-specific: use die in perlfunc instead.


signbit โญ

Returns zero for positive arguments, non-zero for negative arguments [C99]. Added in Perl v5.22.


sigpending ๐Ÿ’œ

Examines signals that are blocked and pending. This uses POSIX::SigSet objects for the sigset argument. Consult your system's sigpending manpage for details.

Synopsis:

sigpending(sigset)

Returns undef on failure. ๐Ÿ’€


sigprocmask ๐ŸŒˆ

Change and/or examine the calling process's signal mask. This uses POSIX::SigSet objects for the sigset and oldsigset arguments. Consult your system's sigprocmask manpage for details.

Synopsis:

sigprocmask(how, sigset, oldsigset = 0)

Returns undef 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. ๐Ÿšจ

sigsetjmp ๐ŸŽ€

Not implemented. sigsetjmp() is C-specific: use eval {} instead, see eval in perlfunc.


sigsuspend ๐Ÿฆ‹

Install a signal mask and suspend the process until a signal arrives. This uses POSIX::SigSet objects for the signal_mask argument. Consult your system's sigsuspend manpage for details.

Synopsis:

sigsuspend(signal_mask)

Returns undef on failure.


sin โœจ

This is identical to Perl's builtin sin() function, returning the sine of its numerical argument โ€” except that POSIX::sin() must be given an explicit value (no relying on an implicit $_, bestie ๐Ÿ™ˆ):

$sine = POSIX::sin(3);    # good

$sine = POSIX::sin();     # throws exception

See sin in perlfunc; see also Math::Trig.


sinh ๐ŸŒธ

This is identical to the C function sinh() for returning the hyperbolic sine of the numerical argument. See also Math::Trig.


sleep ๐Ÿ˜ด

This is functionally identical to Perl's builtin sleep() function for suspending the execution of the current process for a certain number of seconds โ€” see sleep in perlfunc. But there's one significant difference, and it's giving subtle-but-important: POSIX::sleep() returns the number of unslept seconds, while CORE::sleep() returns the number of slept seconds. Flip-flopped, ik. ๐Ÿ‘€


sprintf ๐Ÿ’–

This is similar to Perl's builtin sprintf() function for returning a string that has the arguments formatted as requested, see sprintf in perlfunc.


sqrt ๐Ÿ”ฅ

This is identical to Perl's builtin sqrt() function for returning the square root of the numerical argument โ€” except that POSIX::sqrt() must be given an explicit value (rather than relying on an implicit $_):

$square_root = POSIX::sqrt(3);    # good

$square_root = POSIX::sqrt();     # throws exception

See sqrt in perlfunc.


srand ๐ŸŽฒ

Give a seed to the pseudorandom number generator, see srand in perlfunc.


sscanf ๐Ÿ’€

Not implemented. sscanf() is C-specific, use regular expressions instead, see perlre. Regex girlies stay winning.


stat ๐Ÿงš

This is identical to Perl's builtin stat() function for returning information about files and directories.


strcat ๐ŸŒŸ

Not implemented. strcat() is C-specific, use .= instead, see perlop.


strchr ๐Ÿ“

Not implemented. strchr() is C-specific, see index in perlfunc instead.


strcmp ๐Ÿ’…

Not implemented. strcmp() is C-specific, use eq or cmp instead, see perlop.


strcoll ๐ŸŒธ

This is identical to the C function strcoll() for collating (comparing) strings that have been transformed using the strxfrm() function. Not really needed, since Perl can do this transparently โ€” see perllocale. Iconic of Perl, honestly.

Beware: 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. ๐Ÿšจ

Also note that it doesn't make sense for a string to be encoded in one locale (say, ISO-8859-6, Arabic) and to be collated based on another (like ISO-8859-7, Greek). The results will be essentially meaningless. ๐Ÿ˜ญ


strcpy ๐ŸŽ€

Not implemented. strcpy() is C-specific, use = instead, see perlop.


strcspn ๐Ÿฆ‹

Not implemented. strcspn() is C-specific, use regular expressions instead, see perlre.


strerror ๐Ÿ‘‘

Returns the error string for the specified errno. Identical to the string form of $!, see $ERRNO in perlvar.


strftime โฐ

Convert date and time information to a string, based on the current underlying locale of the program. Returns the string in a mortalized SV; set to an empty string on error.

my $sv = strftime(fmt, sec, min, hour, mday, mon, year,
                  wday = -1, yday = -1, isdst = -1)

The wday and yday parameters are both ignored. Their values are always determinable from the other parameters anyway, so likeโ€ฆ why. ๐Ÿ™ˆ

More details on the behavior and the specification of the other parameters are described in "sv_strftime_ints" in perlapi.


strlen ๐Ÿ“

Not implemented. strlen() is C-specific, use length() instead, see length in perlfunc.


strncat ๐Ÿ’œ

Not implemented. strncat() is C-specific, use .= instead, see perlop.


strncmp ๐ŸŒˆ

Not implemented. strncmp() is C-specific, use eq instead, see perlop.


strncpy โœจ

Not implemented. strncpy() is C-specific, use = instead, see perlop.


strpbrk ๐Ÿ“

Not implemented. strpbrk() is C-specific, use regular expressions instead, see perlre.

strrchr ๐Ÿ”

Not implemented. strrchr() is C-specific bestie, so hit up "rindex" in perlfunc instead. ๐Ÿ’…

strspn ๐Ÿšซ

Not implemented. strspn() is C-specific, so use regular expressions instead โ€” go peep perlre. ๐ŸŒธ

strstr ๐Ÿงต

This is literally identical to Perl's builtin index() function, run don't walk to "index" in perlfunc.

strtod ๐Ÿ”ข

String to double translation, and it's giving math girlie. It 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 calling strtod. But plot twist: non-POSIX systems may not check for overflow, and therefore will never set $!. ๐Ÿ˜ญ

strtod respects any POSIX setlocale() LC_NUMERIC settings, regardless of whether or not it is called from Perl code that is within the scope of use locale. 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. Why? Because it otherwise changes the locale, which globally affects all threads simultaneously. not the vibe. ๐Ÿ’€

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 context strtod returns the parsed number. โœจ

strtok ๐Ÿช“

Not implemented. strtok() is C-specific, so use regular expressions instead โ€” see perlre โ€” or "split" in perlfunc. ๐Ÿฆ‹

strtol ๐Ÿ”ข

String 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 calling strtol. However, non-POSIX systems may not check for overflow, and therefore will never set $!. ๐Ÿ™ˆ

strtol should respect any POSIX setlocale() 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 omitted strtol 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 way it just knows?? iconic honestly)

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 context strtol returns the parsed number. ๐Ÿ’–

strtold ๐Ÿซถ

Like strtod but for long doubles. Defined only if the system supports long doubles.

strtoul ๐Ÿ”ข

String to unsigned (long) integer translation. strtoul() is identical to strtol() except that strtoul() only parses unsigned integers. See "strtol" for details.

Note: Some vendors supply strtod() and strtol() but not strtoul(). Other vendors that do supply strtoul() parse -1 as a valid value. ๐Ÿ™ƒ

strxfrm ๐Ÿช„

String transformation, and it returns the transformed string. slay.

    $dst = POSIX::strxfrm( $src );

Used with eq or cmp as an alternative to strcoll.

Not really needed since Perl can do this transparently, see perllocale.

Unlike the libc strxfrm, this allows NUL characters in the input $src. ๐ŸŒŸ

It doesn't make sense for a string to be encoded in one locale (say, ISO-8859-6, Arabic) and to collate it based on another (like ISO-8859-7, Greek). Perl assumes that the current LC_CTYPE locale correctly represents the encoding of $src, and ignores the value of LC_COLLATE. ๐Ÿ˜ญ

sysconf โš™๏ธ

Retrieves values of system configurable variables.

The following will get the machine's clock speed. โฐ

    $clock_ticks = POSIX::sysconf( &POSIX::_SC_CLK_TCK );

Returns undef on failure.

system ๐Ÿ’ป

This is identical to Perl's builtin system() function, see "system" in perlfunc.

tan ๐Ÿ“

This is identical to the C function tan(), returning the tangent of the numerical argument. See also Math::Trig.

tanh ๐Ÿ“ˆ

This is identical to the C function tanh(), returning the hyperbolic tangent of the numerical argument. See also Math::Trig.

tcdrain ๐Ÿšฐ

This is similar to the C function tcdrain() for draining the output queue of its argument stream.

Returns undef on failure.

tcflow ๐ŸŒŠ

This is similar to the C function tcflow() for controlling the flow of its argument stream.

Returns undef on failure.

tcflush ๐Ÿงผ

This is similar to the C function tcflush() for flushing the I/O buffers of its argument stream.

Returns undef on failure.

tcgetpgrp ๐Ÿ‘‘

This is identical to the C function tcgetpgrp() for returning the process group identifier of the foreground process group of the controlling terminal. main character energy fr fr.

tcsendbreak ๐Ÿ’ฅ

This is similar to the C function tcsendbreak() for sending a break on its argument stream.

Returns undef on failure.

tcsetpgrp ๐ŸŽ€

This is similar to the C function tcsetpgrp() for setting the process group identifier of the foreground process group of the controlling terminal.

Returns undef on failure.

tgamma ๐Ÿงฎ

The Gamma function [C99]. Added in Perl v5.22.

See also "lgamma".

time โณ

This is identical to Perl's builtin time() function for returning the number of seconds since the epoch (whatever it is for the system), see "time" in perlfunc.

times ๐Ÿ•ฐ๏ธ

The times() 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 builtin times() function returns four values, measured in seconds. ๐Ÿ‘€ (do not mix these up bestie, i'm begging)

tmpfile ๐Ÿ“

Not implemented. Use method IO::File::new_tmpfile() instead, or see File::Temp.

tmpnam ๐Ÿ”’

For security reasons, which are probably detailed in your system's documentation for the C library tmpnam() function, this interface is no longer available since Perl v5.26; instead use File::Temp. ๐Ÿ’…

tolower โฌ‡๏ธ

This function has been removed as of Perl v5.26. This 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 the lc() function, see "lc" in perlfunc, see "lc" in perlfunc, or the equivalent \L operator inside doublequotish strings. โœจ

toupper โฌ†๏ธ

This function has been removed as of Perl v5.26. This 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 the uc() function, see "uc" in perlfunc, or the equivalent \U operator inside doublequotish strings. โœจ

trunc โœ‚๏ธ

Returns the integer toward zero from the argument [C99]. Added in Perl v5.22.

See also "ceil", "floor", and "round".

ttyname ๐Ÿ–ฅ๏ธ

This is identical to the C function ttyname() for returning the name of the current terminal.

tzname ๐ŸŒ

Retrieves the time conversion information from the tzname variable.

    POSIX::tzset();
    ($std, $dst) = POSIX::tzname();

tzset ๐Ÿ—บ๏ธ

This is identical to the C function tzset() for setting the current timezone based on the environment variable TZ, to be used by ctime(), localtime(), mktime(), and strftime() functions.

umask ๐ŸŽญ

This is identical to Perl's builtin umask() function for setting (and querying) the file creation permission mask โ€” except that POSIX::umask() must be provided with an explicit value (rather than relying on an implicit $_):

    $current = umask();                 # good

    $now  = POSIX::umask($current);     # good

    $now  = POSIX::umask();             # throws exception

See "umask" in perlfunc. ๐Ÿ’…

uname ๐Ÿง

Get 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. ๐Ÿ™ƒ

ungetc โ†ฉ๏ธ

Not implemented. Use method IO::Handle::ungetc() instead.

This is identical to Perl's builtin unlink() function for removing files, see "unlink" in perlfunc.

utime โฑ๏ธ

This is identical to Perl's builtin utime() function for changing the time stamps of files and directories, see "utime" in perlfunc.

vfprintf ๐Ÿšซ

Not implemented. vfprintf() is C-specific, see "printf" in perlfunc instead.

vprintf ๐Ÿšซ

Not implemented. vprintf() is C-specific, see "printf" in perlfunc instead.

vsprintf ๐Ÿšซ

Not implemented. vsprintf() is C-specific, see "sprintf" in perlfunc instead.

wait โธ๏ธ

This is identical to Perl's builtin wait() function, see "wait" in perlfunc.

waitpid ๐Ÿซถ

Waits for a child process to change state โ€” that's the whole job, no notes ๐Ÿ’…. And bestie, it's identical to Perl's builtin waitpid() function, so if you want the full lore go read "waitpid" in perlfunc.

$pid = POSIX::waitpid( -1, POSIX::WNOHANG );
print "status = ", ($? / 256), "\n";

See "mblen" ๐Ÿฆ‹.


wctomb ๐ŸŒ€

On unthreaded perls this is literally the same as the C function wctomb() โœจ. On threaded perls, it transparently (well, almost) substitutes the more thread-safe wcrtomb(3) in place of wctomb, if that one's available ๐Ÿซถ.

Now, real talk: Core Perl does not have any support for wide and multibyte locales โ€” the one exception being Unicode UTF-8 locales ๐Ÿ˜ญ. That means this function, hanging out with mblen and mbtowc, is how you roll your own decoding/encoding for other types of multi-byte locales. DIY energy, honestly ๐Ÿ‘‘.

Here's the tea on how it behaves:

  • Use undef as the first parameter and you get the effect of passing NULL as the first parameter to wctomb. That ignores the second parameter completely, and resets any shift state back to its initial value. Important: the return value is undefined if wcrtomb was substituted, so you should never rely on it ๐Ÿ™ˆ.
  • When the first parameter is a scalar, the code point contained in the scalar second parameter gets converted into a multi-byte string and stored into that first parameter scalar. This is based on the locale that currently underlies the program โ€” and that holds regardless of whether or not the function is called from Perl code that's within the scope of use locale ๐Ÿ‘€. The return value is the number of bytes stored, or negative if the code point isn't representable in the current locale.

One more thing, and it's lowkey important: Perl makes no attempt at hiding from your code any differences in the errno setting between wctomb and wcrtomb ๐Ÿ’€. It does set errno to 0 before calling them, though ๐Ÿ’–.


write ๐Ÿ“

Write to a file, using file descriptors such as those you got by calling POSIX::open ๐Ÿ”ฅ.

$fd = POSIX::open( "foo", &POSIX::O_WRONLY );
$buf = "hello";
$bytes = POSIX::write( $fd, $buf, 5 );

Returns undef on failure ๐Ÿ˜ญ.

See also "syswrite" in perlfunc โญ.

๐Ÿ‘‘ CLASSES ๐Ÿ‘‘

POSIX::SigAction

new

Bestie, this makes you a brand new POSIX::SigAction object that matches up with the C struct sigaction. ๐Ÿซถ It auto-destroys itself the second you stop needing it โ€” no manual cleanup, we love a low-maintenance icon.

  • Param one: the handler, which is a sub reference.
  • Param two: a POSIX::SigSet object. Defaults to the empty set if you don't pass one.
  • Param three: the sa_flags. Defaults to 0.
$sigset = POSIX::SigSet->new(SIGINT, SIGQUIT);
$sigaction = POSIX::SigAction->new(
                \&handler, $sigset, &POSIX::SA_NOCLDSTOP
             );

This POSIX::SigAction object is meant to be used with the POSIX::sigaction() function. That's its whole job, that's its whole vibe. โœจ

handler, mask, flags

Accessor functions to get and/or set the values of a SigAction object. ๐Ÿ’…

$sigset = $sigaction->mask;
$sigaction->flags(&POSIX::SA_RESTART);

safe

Accessor function for the "safe signals" flag of a SigAction object. If you wanna know the general tea on safe (a.k.a. "deferred") signals, go check perlipc. ๐Ÿ“

So if you want to handle a signal safely, use this accessor to set the safe flag on the POSIX::SigAction object:

$sigaction->safe(1);

You can also peek at the safe flag on the output action object โ€” it gets filled in when you pass it as the third parameter to POSIX::sigaction():

sigaction(SIGINT, $new_action, $old_action);
if ($old_action->safe) {
    # previous SIGINT handler used safe signals
}

POSIX::SigRt

%SIGRT

A hash of the POSIX realtime signal handlers. ๐ŸŒˆ It's an extension of the standard %SIG โ€” like, $POSIX::SIGRT{SIGRTMIN} is roughly equivalent to $SIG{SIGRTMIN}, except the right POSIX moves get made (scroll down for those) with the POSIX::SigSet and POSIX::sigaction instead of reaching into %SIG.

You can set the %POSIX::SIGRT elements to set the POSIX realtime signal handlers, use delete and exists on the elements, and use scalar on the %POSIX::SIGRT to find out how many POSIX realtime signals are available out there (SIGRTMAX - SIGRTMIN + 1, because SIGRTMAX 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, and if you want something different you've got two options: either use local on $POSIX::SigRt::SIGACTION_FLAGS, or derive from POSIX::SigRt and define your own new(). Heads up on the second one: the tied hash STORE method of the %SIGRT calls new($rtsig, $handler, $SIGACTION_FLAGS), where the $rtsig ranges from zero to SIGRTMAX - SIGRTMIN + 1).

Just like with literally any signal, you can use sigaction($rtsig, undef, $oa) to retrieve the installed signal handler โ€” or, more accurately, the signal action. ๐Ÿ™ˆ

NOTE: whether POSIX realtime signals really work on your system, or whether Perl has even been compiled so it works with them, is totally outside of this discussion. Not our problem, bestie. ๐Ÿ’€

SIGRTMIN

Returns the minimum POSIX realtime signal number available, or undef if there are no POSIX realtime signals available at all. ๐Ÿ˜ญ

SIGRTMAX

Returns the maximum POSIX realtime signal number available, or undef if there are no POSIX realtime signals available at all. Same energy. ๐Ÿ˜ญ


POSIX::SigSet

new

Create a new SigSet object. ๐ŸŽ€ It destroys itself automatically when it's no longer needed โ€” iconic behaviour, honestly. You can pass arguments in to initialize the set.

Create an empty set:

$sigset = POSIX::SigSet->new;

Create a set with SIGUSR1:

$sigset = POSIX::SigSet->new( &POSIX::SIGUSR1 );

Throws an error if any of the signals you supplied can't be added to the set. โš ๏ธ

addset

Add a signal to a SigSet object. โž•

$sigset->addset( &POSIX::SIGUSR2 );

Returns undef on failure.

delset

Remove a signal from the SigSet object. โž–

$sigset->delset( &POSIX::SIGUSR2 );

Returns undef on failure.

emptyset

Initialize the SigSet object to be empty. ๐Ÿซง

$sigset->emptyset();

Returns undef on failure.

fillset

Initialize the SigSet object to include all the signals. Literally all of them. ๐Ÿ”ฅ

$sigset->fillset();

Returns undef on failure.

ismember

Tests the SigSet object to see if it contains a specific signal. ๐Ÿ‘€

if( $sigset->ismember( &POSIX::SIGUSR1 ) ){
        print "contains SIGUSR1\n";
}

POSIX::Termios

new

Create a new Termios object. ๐Ÿ’– It gets destroyed automatically once it's not needed anymore. A Termios object corresponds to the termios C struct. Here's the lil lifecycle: new() mallocs a new one, getattr() fills it from a file descriptor, and setattr() sets a file descriptor's parameters to match Termios' contents. Slay. โœจ

$termios = POSIX::Termios->new;

getattr

Get terminal control attributes. ๐ŸŒธ

Obtain the attributes for stdin:

$termios->getattr( 0 ) # Recommended for clarity.
$termios->getattr()

Obtain the attributes for stdout:

$termios->getattr( 1 )

Returns undef on failure.

getcc

Retrieve a value from the c_cc field of a termios object. The c_cc field is an array so you gotta specify an index. ๐Ÿ“Œ

$c_cc[1] = $termios->getcc(1);

getcflag

Retrieve the c_cflag field of a termios object.

$c_cflag = $termios->getcflag;

getiflag

Retrieve the c_iflag field of a termios object.

$c_iflag = $termios->getiflag;

getispeed

Retrieve the input baud rate. ๐ŸŒ๐Ÿ’จ

$ispeed = $termios->getispeed;

getlflag

Retrieve the c_lflag field of a termios object.

$c_lflag = $termios->getlflag;

getoflag

Retrieve the c_oflag field of a termios object.

$c_oflag = $termios->getoflag;

getospeed

Retrieve the output baud rate.

$ospeed = $termios->getospeed;

setattr

Set terminal control attributes. ๐Ÿ’…

Set attributes immediately for stdout:

$termios->setattr( 1, &POSIX::TCSANOW );

Returns undef on failure.

setcc

Set a value in the c_cc field of a termios object. Again, c_cc is an array so an index must be specified. ๐ŸŽฏ

$termios->setcc( &POSIX::VEOF, 1 );

setcflag

Set the c_cflag field of a termios object.

$termios->setcflag( $c_cflag | &POSIX::CLOCAL );

setiflag

Set the c_iflag field of a termios object.

$termios->setiflag( $c_iflag | &POSIX::BRKINT );

setispeed

Set the input baud rate.

$termios->setispeed( &POSIX::B9600 );

Returns undef on failure.

setlflag

Set the c_lflag field of a termios object.

$termios->setlflag( $c_lflag | &POSIX::ECHO );

setoflag

Set the c_oflag field of a termios object.

$termios->setoflag( $c_oflag | &POSIX::OPOST );

setospeed

Set the output baud rate.

$termios->setospeed( &POSIX::B9600 );

Returns undef on failure.

Baud rate values

  • B38400
  • B75
  • B200
  • B134
  • B300
  • B1800
  • B150
  • B0
  • B19200
  • B1200
  • B9600
  • B600
  • B4800
  • B50
  • B2400
  • B110

Terminal interface values

  • TCSADRAIN
  • TCSANOW
  • TCOON
  • TCIOFLUSH
  • TCOFLUSH
  • TCION
  • TCIFLUSH
  • TCSAFLUSH
  • TCIOFF
  • TCOOFF

c_cc field values

  • VEOF
  • VEOL
  • VERASE
  • VINTR
  • VKILL
  • VQUIT
  • VSUSP
  • VSTART
  • VSTOP
  • VMIN
  • VTIME
  • NCCS

c_cflag field values

  • CLOCAL
  • CREAD
  • CSIZE
  • CS5
  • CS6
  • CS7
  • CS8
  • CSTOPB
  • HUPCL
  • PARENB
  • PARODD

c_iflag field values

  • BRKINT
  • ICRNL
  • IGNBRK
  • IGNCR
  • IGNPAR
  • INLCR
  • INPCK
  • ISTRIP
  • IXOFF
  • IXON
  • PARMRK

c_lflag field values

  • ECHO
  • ECHOE
  • ECHOK
  • ECHONL
  • ICANON
  • IEXTEN
  • ISIG
  • NOFLSH
  • TOSTOP

c_oflag field values

  • OPOST

๐Ÿฆ‹ PATHNAME CONSTANTS ๐Ÿฆ‹

Constants

  • _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 CONSTANTS ๐ŸŽ€

Constants

  • _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

๐Ÿ’œ RESOURCE CONSTANTS ๐Ÿ’œ

Imported with the :sys_resource_h tag. ๐Ÿท๏ธ

Constants

Added in Perl v5.28:

  • PRIO_PROCESS
  • PRIO_PGRP
  • PRIO_USER

โญ SYSTEM CONFIGURATION โญ

Constants

  • _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

๐Ÿ’ฅ ERRNO ๐Ÿ’ฅ

Okay so bestie, these are the error number constants, the whole squad of "something went wrong" vibes. They're literally the errno values you get when a syscall fails, and you can check them with $! and friends. No cap.

Constants

E2BIG, EACCES, EADDRINUSE, EADDRNOTAVAIL, EAFNOSUPPORT, EAGAIN, EALREADY, EBADF, EBADMSG, EBUSY, ECANCELED, ECHILD, ECONNABORTED, ECONNREFUSED, ECONNRESET, EDEADLK, EDESTADDRREQ, EDOM, EDQUOT, EEXIST, EFAULT, EFBIG, EHOSTDOWN, EHOSTUNREACH, EIDRM, EILSEQ, EINPROGRESS, EINTR, EINVAL, EIO, EISCONN, EISDIR, ELOOP, EMFILE, EMLINK, EMSGSIZE, ENAMETOOLONG, ENETDOWN, ENETRESET, ENETUNREACH, ENFILE, ENOBUFS, ENODATA, ENODEV, ENOENT, ENOEXEC, ENOLCK, ENOLINK, ENOMEM, ENOMSG, ENOPROTOOPT, ENOSPC, ENOSR, ENOSTR, ENOSYS, ENOTBLK, ENOTCONN, ENOTDIR, ENOTEMPTY, ENOTRECOVERABLE, ENOTSOCK, ENOTSUP, ENOTTY, ENXIO, EOPNOTSUPP, EOTHER, EOVERFLOW, EOWNERDEAD, EPERM, EPFNOSUPPORT, EPIPE, EPROCLIM, EPROTO, EPROTONOSUPPORT, EPROTOTYPE, ERANGE, EREMOTE, ERESTART, EROFS, ESHUTDOWN, ESOCKTNOSUPPORT, ESPIPE, ESRCH, ESTALE, ETIME, ETIMEDOUT, ETOOMANYREFS, ETXTBSY, EUSERS, EWOULDBLOCK, EXDEV


๐Ÿ”“ FCNTL ๐Ÿ”“

These are the constants for fcntl() and open() and all that file control magic. Literally the keys to the file descriptor kingdom.

Constants

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


๐ŸŒŠ FLOAT ๐ŸŒŠ

Floating point constants, the whole floatie squad. These tell you the limits and precision of float, double, and long double on your system.

Constants

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


๐ŸŽ€ FLOATING-POINT ENVIRONMENT ๐ŸŽ€

These constants are all about rounding modes and stuff, but only on systems that support them. No cap, it's giving "check your platform first".

Constants

FE_DOWNWARD, FE_TONEAREST, FE_TOWARDZERO, FE_UPWARD on systems that support them.


๐Ÿ“ LIMITS ๐Ÿ“

System limits, the boundaries of what you can do. These are the numbers that say how big, how many, how long. Iconic.

Constants

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


๐ŸŒ LOCALE ๐ŸŒ

Locale constants, for all your internationalization needs. They're on systems that support them, bestie.

Constants

LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME, LC_MESSAGES on systems that support them.


๐Ÿงฎ MATH ๐Ÿงฎ

Math constants, the real ones. HUGE_VAL is the classic. And then a whole new batch added in Perl v5.22, which is giving C99 energy.

Constants

HUGE_VAL

Added in Perl v5.22:

FP_ILOGB0, FP_ILOGBNAN, FP_INFINITE, FP_NAN, FP_NORMAL, FP_SUBNORMAL, FP_ZERO, INFINITY, NAN, Inf, NaN, M_1_PI, M_2_PI, M_2_SQRTPI, M_E, M_LN10, M_LN2, M_LOG10E, M_LOG2E, M_PI, M_PI_2, M_PI_4, M_SQRT1_2, M_SQRT2 on systems with C99 support.


๐Ÿšจ SIGNAL ๐Ÿšจ

Signal constants, the whole drama of signals. These are the ones you use with kill() and sigaction() and all that. Also added a bunch in Perl v5.24, so keep up.

Constants

SA_NOCLDSTOP, SA_NOCLDWAIT, SA_NODEFER, SA_ONSTACK, SA_RESETHAND, SA_RESTART, SA_SIGINFO, SIGABRT, SIGALRM, SIGCHLD, SIGCONT, SIGFPE, SIGHUP, SIGILL, SIGINT, SIGKILL, SIGPIPE, SIGQUIT, SIGSEGV, SIGSTOP, SIGTERM, SIGTSTP, SIGTTIN, SIGTTOU, SIGUSR1, SIGUSR2, SIG_BLOCK, SIG_DFL, SIG_ERR, SIG_IGN, SIG_SETMASK, SIG_UNBLOCK

Added in Perl v5.24:

ILL_ILLOPC, ILL_ILLOPN, ILL_ILLADR, ILL_ILLTRP, ILL_PRVOPC, ILL_PRVREG, ILL_COPROC, ILL_BADSTK, FPE_INTDIV, FPE_INTOVF, FPE_FLTDIV, FPE_FLTOVF, FPE_FLTUND, FPE_FLTRES, FPE_FLTINV, FPE_FLTSUB, SEGV_MAPERR, SEGV_ACCERR, BUS_ADRALN, BUS_ADRERR, BUS_OBJERR, TRAP_BRKPT, TRAP_TRACE, CLD_EXITED, CLD_KILLED, CLD_DUMPED, CLD_TRAPPED, CLD_STOPPED, CLD_CONTINUED, POLL_IN, POLL_OUT, POLL_MSG, POLL_ERR, POLL_PRI, POLL_HUP, SI_USER, SI_QUEUE, SI_TIMER, SI_ASYNCIO, SI_MESGQ


๐Ÿ“ STAT ๐Ÿ“

Stat constants and macros, for all your file mode and stat structure needs. The constants are the permission bits, and the macros check file types. Slay.

Constants

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

Macros

S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG, S_ISSOCK


๐Ÿงฐ STDLIB ๐Ÿงฐ

Standard library constants, the basics. EXIT_FAILURE and EXIT_SUCCESS are your exit codes, MB_CUR_MAX is for multibyte, and RAND_MAX is the biggest random number you can get from rand().

Constants

EXIT_FAILURE, EXIT_SUCCESS, MB_CUR_MAX, RAND_MAX


๐Ÿ“ STDIO ๐Ÿ“

Standard I/O constants, for buffering and file names and temp files. BUFSIZ is the buffer size, EOF is end of file, FILENAME_MAX is max filename length, L_ctermid and L_cuserid are for terminal and user id strings, and TMP_MAX is max temp files.

Constants

BUFSIZ, EOF, FILENAME_MAX, L_ctermid, L_cuserid, TMP_MAX


โฐ TIME โฐ

Time constants, for clock ticks and clock stuff. CLK_TCK is the number of clock ticks per second, and CLOCKS_PER_SEC is the number of clock ticks per second for clock().

Constants

CLK_TCK, CLOCKS_PER_SEC


๐Ÿš UNISTD ๐Ÿš

Unix standard constants, for access checks and file seeking and standard file descriptors. R_OK, W_OK, X_OK are for access(), SEEK_CUR, SEEK_END, SEEK_SET are for lseek(), and STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO are the file descriptor numbers for standard input, output, and error.

Constants

R_OK, SEEK_CUR, SEEK_END, SEEK_SET, STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, W_OK, X_OK


๐Ÿ‘ถ WAIT ๐Ÿ‘ถ

Wait constants and macros, for waiting on child processes. This is where you check exit statuses and signals. It's giving "parenting your processes".

Constants

WNOHANG, WUNTRACED

  • WNOHANG โ€” Do not suspend the calling process until a child process changes state but instead return immediately.
  • WUNTRACED โ€” Catch stopped child processes.

Macros

WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WIFSTOPPED, WSTOPSIG

  • WIFEXITED โ€” WIFEXITED(${^CHILD_ERROR_NATIVE}) returns true if the child process exited normally (exit() or by falling off the end of main())
  • WEXITSTATUS โ€” WEXITSTATUS(${^CHILD_ERROR_NATIVE}) returns the normal exit status of the child process (only meaningful if WIFEXITED(${^CHILD_ERROR_NATIVE}) is true)
  • WIFSIGNALED โ€” WIFSIGNALED(${^CHILD_ERROR_NATIVE}) returns true if the child process terminated because of a signal
  • WTERMSIG โ€” WTERMSIG(${^CHILD_ERROR_NATIVE}) returns the signal the child process terminated for (only meaningful if WIFSIGNALED(${^CHILD_ERROR_NATIVE}) is true)
  • WIFSTOPPED โ€” WIFSTOPPED(${^CHILD_ERROR_NATIVE}) returns true if the child process is currently stopped (can happen only if you specified the WUNTRACED flag to waitpid())
  • WSTOPSIG โ€” WSTOPSIG(${^CHILD_ERROR_NATIVE}) returns the signal the child process was stopped for (only meaningful if WIFSTOPPED(${^CHILD_ERROR_NATIVE}) is true)

๐ŸชŸ WINSOCK ๐ŸชŸ

(Windows only.) Winsock constants, for all your Windows socket error needs. Added in Perl v5.24, so they're relatively new. No cap.

Constants

Added in Perl v5.24:

WSAEINTR, WSAEBADF, WSAEACCES, WSAEFAULT, WSAEINVAL, WSAEMFILE, WSAEWOULDBLOCK, WSAEINPROGRESS, WSAEALREADY, WSAENOTSOCK, WSAEDESTADDRREQ, WSAEMSGSIZE, WSAEPROTOTYPE, WSAENOPROTOOPT, WSAEPROTONOSUPPORT, WSAESOCKTNOSUPPORT, WSAEOPNOTSUPP, WSAEPFNOSUPPORT, WSAEAFNOSUPPORT, WSAEADDRINUSE, WSAEADDRNOTAVAIL, WSAENETDOWN, WSAENETUNREACH, WSAENETRESET, WSAECONNABORTED, WSAECONNRESET, WSAENOBUFS, WSAEISCONN, WSAENOTCONN, WSAESHUTDOWN, WSAETOOMANYREFS, WSAETIMEDOUT, WSAECONNREFUSED, WSAELOOP, WSAENAMETOOLONG, WSAEHOSTDOWN, WSAEHOSTUNREACH, WSAENOTEMPTY, WSAEPROCLIM, WSAEUSERS, WSAEDQUOT, WSAESTALE, WSAEREMOTE, WSAEDISCON, WSAENOMORE, WSAECANCELLED, WSAEINVALIDPROCTABLE, WSAEINVALIDPROVIDER, WSAEPROVIDERFAILEDINIT, WSAEREFUSED


That's the whole page, bestie! You just read the POSIX(3perl) page from perl v5.44.0, dated 2026-10-17. Slay. ๐Ÿ’…โœจ

๐Ÿ“ฆ where this page comes from
  • arch rolling: perl 5.44.0-1 ยท Artistic-1.0-Perl AND GPL-1.0-or-later
  • ๐Ÿ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms