man-pages/man3/getpt.3

37 lines
955 B
Groff

.\" Hey Emacs! This file is -*- nroff -*- source.
.\" This man page was written by Jeremy Phelps <jphelps@notreached.net>.
.\" Redistribute and modify at will.
.\"
.TH GETPT 3 "2002-10-09" "PTY Control" "Linux Programmer's Manual"
.SH NAME
getpt \- open the pseudo-terminal master (PTM)
.SH SYNOPSIS
.nf
.B #include <stdlib.h>
.sp
.B "int getpt(void)"
.fi
.SH DESCRIPTION
.BR getpt ()
opens a pseudo-terminal master and returns its file descriptor.
It is equivalent to
.BI "open(" \fI"/dev/ptmx" , O_RDWR|O_NOCTTY )
on Linux systems, though the pseudo-terminal master is located
elsewhere on some systems that use GNU Libc.
.SH "RETURN VALUE"
.BR getpt ()
returns an open file descriptor upon successful completion. Otherwise, it
returns \-1 and sets
.I errno
to indicate the error.
.SH CONFORMING TO
.BR getpt ()
is specific to GNU Libc.
.SH "SEE ALSO"
.BR grantpt (3),
.BR ptsname (3),
.BR posix_openpt (3),
.BR unlockpt (3),
.BR ptmx (4),
.BR pty (7)