summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/unlockpt.3p
blob: 5933a43a5250e862734164af8146c7ae48b03751 (plain)
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
'\" et
.TH UNLOCKPT "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
unlockpt
\(em unlock a pseudo-terminal master/slave pair
.SH SYNOPSIS
.LP
.nf
#include <stdlib.h>
.P
int unlockpt(int \fIfildes\fP);
.fi
.SH DESCRIPTION
The
\fIunlockpt\fR()
function shall unlock the slave pseudo-terminal device associated with
the master to which
.IR fildes
refers.
.P
Conforming applications shall ensure that they call
\fIunlockpt\fR()
before opening the slave side of a pseudo-terminal device.
.SH "RETURN VALUE"
Upon successful completion,
\fIunlockpt\fR()
shall return 0. Otherwise, it shall return \-1 and set
.IR errno
to indicate the error.
.SH ERRORS
The
\fIunlockpt\fR()
function may fail if:
.TP
.BR EBADF
The
.IR fildes
argument is not a file descriptor open for writing.
.TP
.BR EINVAL
The
.IR fildes
argument is not associated with a master pseudo-terminal device.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
See the RATIONALE section for
.IR "\fIposix_openpt\fR\^(\|)".
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIgrantpt\fR\^(\|)",
.IR "\fIopen\fR\^(\|)",
.IR "\fIposix_openpt\fR\^(\|)",
.IR "\fIptsname\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<stdlib.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .