Blame man-pages-posix-2013-a/man3p/grantpt.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH GRANTPT "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
grantpt
Packit 7cfc04
\(em grant access to the slave pseudo-terminal device
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <stdlib.h>
Packit 7cfc04
.P
Packit 7cfc04
int grantpt(int \fIfildes\fP);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
\fIgrantpt\fR()
Packit 7cfc04
function shall change the mode and ownership of the slave pseudo-terminal
Packit 7cfc04
device associated with its master pseudo-terminal counterpart. The
Packit 7cfc04
.IR fildes
Packit 7cfc04
argument is a file descriptor that refers to a master
Packit 7cfc04
pseudo-terminal device. The user ID of the slave shall be set to the real
Packit 7cfc04
UID of the calling process and the group ID shall be set to an unspecified
Packit 7cfc04
group ID. The permission mode of the slave pseudo-terminal shall be set to
Packit 7cfc04
readable and writable by the owner, and writable by the group.
Packit 7cfc04
.P
Packit 7cfc04
The behavior of the
Packit 7cfc04
\fIgrantpt\fR()
Packit 7cfc04
function is unspecified if the application has installed a signal
Packit 7cfc04
handler to catch SIGCHLD signals.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
Upon successful completion,
Packit 7cfc04
\fIgrantpt\fR()
Packit 7cfc04
shall return 0; otherwise, it shall return \(mi1 and set
Packit 7cfc04
.IR errno
Packit 7cfc04
to indicate the error.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
The
Packit 7cfc04
\fIgrantpt\fR()
Packit 7cfc04
function may fail if:
Packit 7cfc04
.TP
Packit 7cfc04
.BR EBADF
Packit 7cfc04
The
Packit 7cfc04
.IR fildes
Packit 7cfc04
argument is not a valid open file descriptor.
Packit 7cfc04
.TP
Packit 7cfc04
.BR EINVAL
Packit 7cfc04
The
Packit 7cfc04
.IR fildes
Packit 7cfc04
argument is not associated with a master pseudo-terminal device.
Packit 7cfc04
.TP
Packit 7cfc04
.BR EACCES
Packit 7cfc04
The corresponding slave pseudo-terminal device could not be accessed.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
None.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
See the RATIONALE section for
Packit 7cfc04
.IR "\fIposix_openpt\fR\^(\|)".
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIopen\fR\^(\|)",
Packit 7cfc04
.IR "\fIposix_openpt\fR\^(\|)",
Packit 7cfc04
.IR "\fIptsname\fR\^(\|)",
Packit 7cfc04
.IR "\fIunlockpt\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "\fB<stdlib.h>\fP"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .