xref: /minix3/lib/libc/stdlib/grantpt.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\" $NetBSD: grantpt.3,v 1.4 2008/04/30 13:10:51 martin Exp $
2*2fe8fb19SBen Gras.\"
3*2fe8fb19SBen Gras.\" Copyright (c) 2004 The NetBSD Foundation, Inc.
4*2fe8fb19SBen Gras.\" All rights reserved.
5*2fe8fb19SBen Gras.\"
6*2fe8fb19SBen Gras.\" This code is derived from software contributed to The NetBSD Foundation
7*2fe8fb19SBen Gras.\" by Christos Zoulas.
8*2fe8fb19SBen Gras.\"
9*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
10*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
11*2fe8fb19SBen Gras.\" are met:
12*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
13*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
14*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
15*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
16*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
17*2fe8fb19SBen Gras.\"
18*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19*2fe8fb19SBen Gras.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20*2fe8fb19SBen Gras.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21*2fe8fb19SBen Gras.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22*2fe8fb19SBen Gras.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23*2fe8fb19SBen Gras.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24*2fe8fb19SBen Gras.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25*2fe8fb19SBen Gras.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26*2fe8fb19SBen Gras.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27*2fe8fb19SBen Gras.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28*2fe8fb19SBen Gras.\" POSSIBILITY OF SUCH DAMAGE.
29*2fe8fb19SBen Gras.\"
30*2fe8fb19SBen Gras.Dd May 25, 2004
31*2fe8fb19SBen Gras.Dt GRANTPT 3
32*2fe8fb19SBen Gras.Os
33*2fe8fb19SBen Gras.Sh NAME
34*2fe8fb19SBen Gras.Nm grantpt
35*2fe8fb19SBen Gras.Nd grant access to a slave pseudo-terminal device
36*2fe8fb19SBen Gras.Sh LIBRARY
37*2fe8fb19SBen Gras.Lb libc
38*2fe8fb19SBen Gras.Sh SYNOPSIS
39*2fe8fb19SBen Gras.In stdlib.h
40*2fe8fb19SBen Gras.Ft int
41*2fe8fb19SBen Gras.Fn grantpt "int fildes"
42*2fe8fb19SBen Gras.Sh DESCRIPTION
43*2fe8fb19SBen GrasThe
44*2fe8fb19SBen Gras.Fn grantpt
45*2fe8fb19SBen Grasfunction changes the mode and ownership of the slave pseudo-terminal device
46*2fe8fb19SBen Grasthat corresponds to the master pseudo-terminal device associated with
47*2fe8fb19SBen Gras.Fa fildes
48*2fe8fb19SBen Grasto be owned by the real user id of the calling process, group id of
49*2fe8fb19SBen Gras.Dv tty .
50*2fe8fb19SBen GrasThe permissions are set to readable and writable by owner, and writable by
51*2fe8fb19SBen Grasgroup.
52*2fe8fb19SBen GrasIf the slave pseudo-terminal device was being accessed by other file
53*2fe8fb19SBen Grasdescriptors at the time, all such access will be revoked.
54*2fe8fb19SBen Gras.Sh RETURN VALUES
55*2fe8fb19SBen GrasIf successful,
56*2fe8fb19SBen Gras.Fn grantpt
57*2fe8fb19SBen Grasreturns 0; otherwise a value of \-1 is returned and
58*2fe8fb19SBen Gras.Va errno
59*2fe8fb19SBen Grasis set to indicate the error.
60*2fe8fb19SBen Gras.Sh ERRORS
61*2fe8fb19SBen GrasThe
62*2fe8fb19SBen Gras.Fn grantpt
63*2fe8fb19SBen Grasfunction will fail if:
64*2fe8fb19SBen Gras.Bl -tag -width Er
65*2fe8fb19SBen Gras.It Bq Er EACCESS
66*2fe8fb19SBen Grasthe corresponding pseudo-terminal device could not be accessed.
67*2fe8fb19SBen Gras.It Bq Er EBADF
68*2fe8fb19SBen Gras.Fa fildes
69*2fe8fb19SBen Grasis not a valid descriptor.
70*2fe8fb19SBen Gras.It Bq Er EINVAL
71*2fe8fb19SBen Gras.Fa fildes
72*2fe8fb19SBen Grasis not associated with a master pseudo-terminal device.
73*2fe8fb19SBen Gras.El
74*2fe8fb19SBen Gras.Sh NOTES
75*2fe8fb19SBen GrasSetting the group to
76*2fe8fb19SBen Gras.Dv tty
77*2fe8fb19SBen Grasand revoking accesses by other file descriptors are
78*2fe8fb19SBen Gras.Nx
79*2fe8fb19SBen Grasextensions.
80*2fe8fb19SBen GrasCalling
81*2fe8fb19SBen Gras.Fn grantpt
82*2fe8fb19SBen Grasis equivalent to:
83*2fe8fb19SBen Gras.Bd -literal
84*2fe8fb19SBen Gras	ioctl(fildes, TIOCGRANTPT, 0);
85*2fe8fb19SBen Gras.Ed
86*2fe8fb19SBen Gras.Sh SEE ALSO
87*2fe8fb19SBen Gras.Xr ioctl 2 ,
88*2fe8fb19SBen Gras.Xr posix_openpt 3 ,
89*2fe8fb19SBen Gras.Xr ptsname 3 ,
90*2fe8fb19SBen Gras.Xr unlockpt 3
91*2fe8fb19SBen Gras.Sh STANDARDS
92*2fe8fb19SBen GrasThe
93*2fe8fb19SBen Gras.Fn grantpt
94*2fe8fb19SBen Grasfunction conforms to
95*2fe8fb19SBen Gras.St -p1003.1-2001 .
96*2fe8fb19SBen GrasIts first release was in
97*2fe8fb19SBen Gras.St -xpg4.2 .
98