Copyright (c) 1996 Joerg Wunsch
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
$FreeBSD: head/lib/libutil/pty.3 112541 2003-03-24 16:02:05Z charnier $
"
.Dd December 29, 1996 .Os .Dt PTY 3 .Sh NAME .Nm openpty , .Nm forkpty .Nd auxiliary functions to obtain a pseudo-terminal .Sh LIBRARY .Lb libutil .Sh SYNOPSIS n sys/types.h n sys/ioctl.h n termios.h n libutil.h .Ft int .Fn openpty "int *amaster" "int *aslave" "char *name" "struct termios *termp" "struct winsize *winp" .Ft int .Fn forkpty "int *amaster" "char *name" "struct termios *termp" "struct winsize *winp" .Sh DESCRIPTION The function .Fn openpty attempts to obtain the next available pseudo-terminal from the system (see .Xr pty 4 ) . If it successfully finds one, it subsequently tries to change the ownership of the slave device to the real UID of the current process, the group membership to the group .Dq tty (if such a group exists in the system), the access permissions for reading and writing by the owner, and for writing by the group, and to invalidate any current use of the line by calling .Xr revoke 2 .
p If the argument .Fa name is not .Dv NULL , .Fn openpty copies the pathname of the slave pty to this area. The caller is responsible for allocating the required space in this array.
p If the arguments .Fa termp or .Fa winp are not .Dv NULL , .Fn openpty initializes the termios and window size settings from the structures these arguments point to, respectively.
p Upon return, the open file descriptors for the master and slave side of the pty are returned in the locations pointed to by .Fa amaster and .Fa aslave , respectively.
p The .Fn forkpty function first calls .Fn openpty to obtain the next available pseudo-terminal from the system. Upon success, it forks off a new process. In the child process, it closes the descriptor for the master side of the pty, and calls .Xr login_tty 3 for the slave pty. In the parent process, it closes the descriptor for the slave side of the pty. The arguments .Fa amaster , .Fa name , .Fa termp , and .Fa winp have the same meaning as described for .Fn openpty . .Sh RETURN VALUES The .Fn openpty function returns 0 on success, or -1 on failure.
p The .Fn forkpty function returns -1 on failure, 0 in the slave process, and the process ID of the slave process in the parent process. .Sh ERRORS On failure, .Fn openpty will set the global variable .Dv errno to .Er ENOENT .
p In addition to this, .Fn forkpty may set it to any value as described for .Xr fork 2 . .Sh SEE ALSO .Xr chmod 2 , .Xr chown 2 , .Xr fork 2 , .Xr getuid 2 , .Xr open 2 , .Xr revoke 2 , .Xr login_tty 3 , .Xr pty 4 , .Xr termios 4 , .Xr group 5 .Sh BUGS The calling process must have an effective UID of super-user in order to perform all the intended actions. No notification will occur if .Fn openpty or .Fn forkpty failed to proceed with one of the described steps, as long as they could at least allocate the pty at all (and create the new process in the case of .Fn forkpty ) .