Blame man3/unlockpt.3

Packit 7cfc04
.\" %%%LICENSE_START(PUBLIC_DOMAIN)
Packit 7cfc04
.\" This page is in the public domain. - aeb
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH UNLOCKPT 3 2017-07-13 "" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
unlockpt \- unlock a pseudoterminal master/slave pair
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.B #define _XOPEN_SOURCE
Packit 7cfc04
.br
Packit 7cfc04
.B #include <stdlib.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "int unlockpt(int " fd ");"
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.ad l
Packit 7cfc04
.BR unlockpt ():
Packit 7cfc04
.br
Packit 7cfc04
.RS 4
Packit 7cfc04
Since glibc 2.24:
Packit 7cfc04
    _XOPEN_SOURCE\ >=\ 500 ||
Packit 7cfc04
        (_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED)
Packit 7cfc04
.br
Packit 7cfc04
Glibc 2.23 and earlier:
Packit 7cfc04
    _XOPEN_SOURCE
Packit 7cfc04
.RE
Packit 7cfc04
.ad
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR unlockpt ()
Packit 7cfc04
function unlocks the slave pseudoterminal device
Packit 7cfc04
corresponding to the master pseudoterminal referred to by
Packit 7cfc04
.IR fd .
Packit 7cfc04
.PP
Packit 7cfc04
.BR unlockpt ()
Packit 7cfc04
should be called before opening the slave side of a pseudoterminal.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
When successful,
Packit 7cfc04
.BR unlockpt ()
Packit 7cfc04
returns 0.
Packit 7cfc04
Otherwise, it returns \-1 and sets
Packit 7cfc04
.I errno
Packit 7cfc04
appropriately.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.TP
Packit 7cfc04
.B EBADF
Packit 7cfc04
The
Packit 7cfc04
.I fd
Packit 7cfc04
argument is not a file descriptor open for writing.
Packit 7cfc04
.TP
Packit 7cfc04
.B EINVAL
Packit 7cfc04
The
Packit 7cfc04
.I fd
Packit 7cfc04
argument is not associated with a master pseudoterminal.
Packit 7cfc04
.SH VERSIONS
Packit 7cfc04
.BR unlockpt ()
Packit 7cfc04
is provided in glibc since version 2.1.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR unlockpt ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
POSIX.1-2001, POSIX.1-2008.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR grantpt (3),
Packit 7cfc04
.BR posix_openpt (3),
Packit 7cfc04
.BR ptsname (3),
Packit 7cfc04
.BR pts (4),
Packit 7cfc04
.BR pty (7)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.