summaryrefslogtreecommitdiffstats
path: root/man3/unlockpt.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/unlockpt.3')
-rw-r--r--man3/unlockpt.345
1 files changed, 45 insertions, 0 deletions
diff --git a/man3/unlockpt.3 b/man3/unlockpt.3
new file mode 100644
index 000000000..f1d1a6309
--- /dev/null
+++ b/man3/unlockpt.3
@@ -0,0 +1,45 @@
+.\" Hey Emacs! This file is -*- nroff -*- source.
+.\" This page is in the public domain. - aeb
+.\"
+.TH UNLOCKPT 3 "2003-01-30" "PTY Control" "Linux Programmer's Manual"
+.SH NAME
+unlockpt \- unlock a pseudotty master/slave pair
+.SH SYNOPSIS
+.nf
+.B #define _XOPEN_SOURCE
+.br
+.B #include <stdlib.h>
+.sp
+.BI "int unlockpt(int " fd ");"
+.fi
+.SH DESCRIPTION
+The
+.IR unlockpt ()
+function unlocks the slave pseudo-terminal device
+(pty) corresponding to the master pty referred to by
+.IR fd .
+.PP
+.IR unlockpt ()
+should be called before opening the slave side of a pty.
+.SH "RETURN VALUE"
+When successful,
+.IR unlockpt ()
+returns 0. Otherwise, it returns \-1 and sets
+.I errno
+appropriately.
+.SH ERRORS
+.TP
+.B EBADF
+The
+.I fd
+argument is not a file descriptor open for writing.
+.TP
+.B EINVAL
+The
+.I fd
+argument is not associated with a master pty.
+.SH "CONFORMING TO"
+POSIX 1003.1-2001.
+.SH "SEE ALSO"
+.IR grantpt (3),
+.IR ptsname (3)