Print this page
14249 pseudo-terminal nomenclature should reflect POSIX
Change-Id: Ib4a3cef899ff4c71b09cb0dc6878863c5e8357bc
@@ -1,57 +1,49 @@
UNLOCKPT(3C) Standard C Library Functions UNLOCKPT(3C)
NAME
- unlockpt - unlock a pseudo-terminal master/slave pair
+ unlockpt - unlock a pseudo-terminal device pair
SYNOPSIS
#include <stdlib.h>
- int unlockpt(int fildes);
+ int
+ unlockpt(int fildes);
-
DESCRIPTION
- The unlockpt() function unlocks the slave pseudo-terminal device
- associated with the master to which fildes refers.
+ When a pseudo-terminal manager device is opened, whether through
+ posix_openpt(3C) or open(2) on a ptm(7D) device, the subsidiary device
+ begins operation in a locked state. The unlockpt() function unlocks the
+ pseudo-terminal subsidiary device associated with the manager device to
+ which fildes refers.
+ Portable applications must call unlockpt() before opening the pseudo-
+ terminal subsidiary device.
- Portable applications must call unlockpt() before opening the slave
- side of a pseudo-terminal device.
-
RETURN VALUES
- Upon successful completion, unlockpt() returns 0. Otherwise, it returns
- -1 and sets errno to indicate the error.
+ The unlockpt() function returns the value 0 if successful; otherwise the
+ value -1 is returned and the global variable errno is set to indicate the
+ error.
+EXAMPLES
+ See posix_openpt(3C) for an example that includes a call to unlockpt().
+
ERRORS
The unlockpt() function may fail if:
- EBADF
- The fildes argument is not a file descriptor open for
+ EBADF The fildes argument is not a file descriptor open for
writing.
+ EINVAL EINVAL The fildes argument is not associated with a
+ pseudo-terminal manager device.
- EINVAL
- The fildes argument is not associated with a master pseudo-
- terminal device.
+INTERFACE STABILITY
+ Committed
+MT LEVEL
+ Safe
-ATTRIBUTES
- See attributes(5) for descriptions of the following attributes:
-
-
-
-
- +--------------------+-----------------+
- | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
- +--------------------+-----------------+
- |Interface Stability | Standard |
- +--------------------+-----------------+
- |MT-Level | Safe |
- +--------------------+-----------------+
-
SEE ALSO
- open(2), grantpt(3C), ptsname(3C), attributes(5), standards(5)
+ open(2), grantpt(3C), posix_openpt(3C), ptsname(3C), attributes(5),
+ standards(5), ptm(7D)
-
- STREAMS Programming Guide
-
- August 14, 2002 UNLOCKPT(3C)
+illumos February 5, 2022 illumos