1.\" 2.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for 3.\" permission to reproduce portions of its copyrighted documentation. 4.\" Original documentation from The Open Group can be obtained online at 5.\" http://www.opengroup.org/bookstore/. 6.\" 7.\" The Institute of Electrical and Electronics Engineers and The Open 8.\" Group, have given us permission to reprint portions of their 9.\" documentation. 10.\" 11.\" In the following statement, the phrase ``this text'' refers to portions 12.\" of the system documentation. 13.\" 14.\" Portions of this text are reprinted and reproduced in electronic form 15.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition, 16.\" Standard for Information Technology -- Portable Operating System 17.\" Interface (POSIX), The Open Group Base Specifications Issue 6, 18.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics 19.\" Engineers, Inc and The Open Group. In the event of any discrepancy 20.\" between these versions and the original IEEE and The Open Group 21.\" Standard, the original IEEE and The Open Group Standard is the referee 22.\" document. The original Standard can be obtained online at 23.\" http://www.opengroup.org/unix/online.html. 24.\" 25.\" This notice shall appear on any product containing this material. 26.\" 27.\" The contents of this file are subject to the terms of the 28.\" Common Development and Distribution License (the "License"). 29.\" You may not use this file except in compliance with the License. 30.\" 31.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 32.\" or http://www.opensolaris.org/os/licensing. 33.\" See the License for the specific language governing permissions 34.\" and limitations under the License. 35.\" 36.\" When distributing Covered Code, include this CDDL HEADER in each 37.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 38.\" If applicable, add the following below this CDDL HEADER, with the 39.\" fields enclosed by brackets "[]" replaced with your own identifying 40.\" information: Portions Copyright [yyyy] [name of copyright owner] 41.\" 42.\" 43.\" Copyright 1989 AT&T 44.\" Portions Copyright (c) 1994, X/Open Company Limited. All Rights Reserved. 45.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved. 46.\" Copyright 2022 Oxide Computer Company 47.\" 48.Dd February 5, 2022 49.Dt GRANTPT 3C 50.Os 51.Sh NAME 52.Nm grantpt 53.Nd grant access to the subsidiary device of a pseudo-terminal 54.Sh SYNOPSIS 55.In stdlib.h 56.Ft int 57.Fo grantpt 58.Fa "int fildes" 59.Fc 60.Sh DESCRIPTION 61The 62.Fn grantpt 63function changes the mode and ownership of the pseudo-terminal subsidiary 64device associated with its pseudo-terminal manager counterpart. 65.Pp 66The 67.Fa fildes 68argument is the file descriptor returned from a successful 69.Xr open 2 70of the pseudo-terminal manager device; e.g., by calling 71.Xr posix_openpt 3C 72or by performing an 73.Xr open 2 74of the 75.Xr ptm 4D 76device. 77.Pp 78The user ID owner of the subsidiary device is set to the real user ID of the 79calling process. 80The group ID owner is set to a reserved group. 81.Pp 82The permission mode of the subsidiary device is set to be readable and writable 83by the owner, and writable by the group. 84.Sh RETURN VALUES 85.Rv -std grantpt 86.Sh EXAMPLES 87See 88.Xr posix_openpt 3C 89for an example that includes a call to 90.Fn grantpt . 91.Sh ERRORS 92The 93.Fn grantpt 94function may fail if: 95.Bl -tag -width Er 96.It Er EBADF 97The 98.Fa fildes 99argument is not a valid open file descriptor. 100.It Er EINVAL 101The 102.Fa fildes 103argument is not associated with a pseudo-terminal manager device. 104.It Er EACCES 105The corresponding pseudo-terminal subsidiary device could not be accessed. 106.El 107.Sh INTERFACE STABILITY 108.Sy Committed 109.Sh MT LEVEL 110.Sy Safe 111.Sh SEE ALSO 112.Xr open 2 , 113.Xr posix_openpt 3C , 114.Xr ptsname 3C , 115.Xr unlockpt 3C , 116.Xr ptm 4D , 117.Xr attributes 7 , 118.Xr standards 7 119