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