POSIX_OPENPT(2)

πŸ“¦ version 15.1, in freebsd 14.5, freebsd 15.1

πŸ¦‹ POSIX_OPENPT(2) πŸ¦‹

okay bestie, welcome to the System Calls Manual page for posix_openpt(2) β€” we’re opening pseudo-terminal devices today and it’s lowkey iconic πŸ’…βœ¨

🌸 NAME 🌸

posix_openpt β€” open a pseudo-terminal device πŸŽ€

🧚 LIBRARY 🧚

Standard C Library (libc, -lc) 🫢

✨ SYNOPSIS ✨

#include <fcntl.h>
#include <stdlib.h>

int
posix_openpt(int oflag);

πŸ’… DESCRIPTION πŸ’…

So the posix_openpt() function allocates a new pseudo-terminal and establishes a connection with its master device. A slave device shall be created in /dev/pts. After the pseudo-terminal has been allocated, the slave device should have the proper permissions before it can be used (see grantpt(3)). The name of the slave device can be determined by calling ptsname(3) β€” iykyk 🌈

The file status flags and file access modes of the open file description shall be set according to the value of oflag. Values for oflag are constructed by a bitwise-inclusive OR of flags from the following list, defined in <fcntl.h>:

  • O_RDWR β€” Open for reading and writing. slay, both directions πŸ’–
  • O_NOCTTY β€” If set, posix_openpt() shall not cause the terminal device to become the controlling terminal for the process.
  • O_CLOEXEC β€” Set the close-on-exec flag for the new file descriptor. very clean, very mindful 🧼✨
🚨 and bestie, listen: the posix_openpt() function shall fail when oflag contains other values. no extra random flags, periodt πŸ’€

🌟 RETURN VALUES 🌟

Upon successful completion, the posix_openpt() function shall allocate a new pseudo-terminal device and return a non-negative integer representing a file descriptor, which is connected to its master device. Otherwise, -1 shall be returned and errno set to indicate the error. that’s the whole vibe check 😭

πŸ“ ERRORS πŸ“

The posix_openpt() function shall fail if:

  • [ENFILE] β€” The system file table is full.
  • [EINVAL] β€” The value of oflag is not valid.
  • [EAGAIN] β€” Out of pseudo-terminal resources.

πŸ¦‹ SEE ALSO πŸ¦‹

πŸ‘‘ STANDARDS πŸ‘‘

The posix_openpt() function conforms to IEEE Std 1003.1-2001 (β€œPOSIX.1”). The ability to use O_CLOEXEC is an extension to the standard. cute, compliant, and a little extra ✨

🧚 HISTORY 🧚

The posix_openpt() function appeared in FreeBSD 5.0. In FreeBSD 8.0, this function was changed to a system call. glow-up timeline fr fr 🫢

🌈 NOTES 🌈

The flag O_NOCTTY is included for compatibility; in FreeBSD, opening a terminal does not cause it to become a process's controlling terminal. good to know, no cap πŸ’œ

πŸŽ€ AUTHORS πŸŽ€

Ed Schouten <ed@FreeBSD.org> β€” iconic behavior, honestly πŸ‘‘


source/version + date sign-off: this is the Debian edition of POSIX_OPENPT(2), dated September 21, 2016 β€” bye bestie, go open those pseudo-terminals responsibly πŸ’–πŸ«Άβœ¨

πŸ“¦ where this page comes from