summaryrefslogtreecommitdiffstats
path: root/man3/getpt.3
blob: a60c8dcba31808bf140e401c7158294b4d178bef (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.\" 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
.B 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"
.B getpt()
returns an open file descriptor upon successful completion. Otherwise, it
returns -1 and sets
.I errno
to indicate the error.
.SH CONFORMING TO
.B getpt()
is specific to GNU Libc.
.SH "SEE ALSO"
.BR grantpt (3),
.BR ptsname (3),
.BR unlockpt (3),
.BR ptmx (4)