1.\" $NetBSD: unlockpt.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 UNLOCKPT 3 39.Os 40.Sh NAME 41.Nm unlockpt 42.Nd unlock the slave pseudo-terminal device 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In stdlib.h 47.Ft int 48.Fn unlockpt "int fildes" 49.Sh DESCRIPTION 50The 51.Fn unlockpt 52unlocks access to the pseudo-terminal device corresponding to the 53master pseudo-terminal device associated with 54.Fa fildes . 55Conforming applications must call this function before opening the 56slave pseudo-terminal device. 57.Sh RETURN VALUES 58If successful, 59.Fn unlockpt 60returns 0; otherwise a value of \-1 is returned and 61.Va errno 62is set to indicate the error. 63.Sh ERRORS 64The 65.Fn unlockpt 66function will fail if: 67.Bl -tag -width Er 68.It Bq Er EACCESS 69the corresponding pseudo-terminal device could not be accessed. 70.It Bq Er EBADF 71.Fa fildes 72is not a valid descriptor. 73.It Bq Er EINVAL 74.Fa fildes 75is not associated with a master pseudo-terminal device. 76.El 77.Sh NOTES 78In 79.Nx 80.Fn unlockpt 81does nothing. 82.Sh SEE ALSO 83.Xr ioctl 2 , 84.Xr grantpt 3 , 85.Xr posix_openpt 3 , 86.Xr ptsname 3 87.Sh STANDARDS 88The 89.Fn unlockpt 90function conforms to 91.St -p1003.1-2001 . 92Its first release was in 93.St -xpg4.2 . 94