getpt(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | VERSIONS | ATTRIBUTES | CONFORMING TO | SEE ALSO | COLOPHON

GETPT(3)                  Linux Programmer's Manual                 GETPT(3)

NAME         top

       getpt - open a new pseudoterminal master

SYNOPSIS         top

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

       int getpt(void);

DESCRIPTION         top

       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         top

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

ERRORS         top

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

VERSIONS         top

       getpt() is provided in glibc since version 2.1.

ATTRIBUTES         top

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

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

CONFORMING TO         top

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

SEE ALSO         top

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

COLOPHON         top

       This page is part of release 5.08 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/.

GNU                              2020-08-13                         GETPT(3)

Pages that refer to this page: posix_openpt(3)ptmx(4)pts(4)