summaryrefslogtreecommitdiffstats
path: root/man3/getpt.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/getpt.3')
-rw-r--r--man3/getpt.335
1 files changed, 35 insertions, 0 deletions
diff --git a/man3/getpt.3 b/man3/getpt.3
new file mode 100644
index 000000000..a60c8dcba
--- /dev/null
+++ b/man3/getpt.3
@@ -0,0 +1,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)