jammy (3) getpt.3.gz

Provided by: manpages-dev_5.10-1ubuntu1_all bug

NAME

       getpt - open a new pseudoterminal master

SYNOPSIS

       #define _GNU_SOURCE             /* See feature_test_macros(7) */
       #include <stdlib.h>

       int getpt(void);

DESCRIPTION

       getpt()  opens  a new pseudoterminal device and returns a file descriptor that refers to that device.  It
       is equivalent to opening the pseudoterminal multiplexor device

           open("/dev/ptmx", O_RDWR);

       on Linux systems, though the pseudoterminal multiplexor device is located elsewhere on some systems  that
       use the GNU C library.

RETURN VALUE

       getpt()  returns  an  open file descriptor upon successful completion.  Otherwise, it returns -1 and sets
       errno to indicate the error.

ERRORS

       getpt() can fail with various errors described in open(2).

VERSIONS

       getpt() is provided in glibc since version 2.1.

ATTRIBUTES

       For an explanation of the terms used in this section, see attributes(7).

       ┌──────────┬───────────────┬─────────┐
       │InterfaceAttributeValue   │
       ├──────────┼───────────────┼─────────┤
       │getpt()   │ Thread safety │ MT-Safe │
       └──────────┴───────────────┴─────────┘

CONFORMING TO

       getpt() is glibc-specific; use posix_openpt(3) instead.

SEE ALSO

       grantpt(3), posix_openpt(3), ptsname(3), unlockpt(3), ptmx(4), pty(7)

COLOPHON

       This page is part of release 5.10 of  the  Linux  man-pages  project.   A  description  of  the  project,
       information   about   reporting   bugs,   and   the  latest  version  of  this  page,  can  be  found  at
       https://www.kernel.org/doc/man-pages/.