2 .\" Copyright (c) 1996 Joerg Wunsch
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 .Nd auxiliary functions to obtain a pseudo-terminal
41 .Fn openpty "int *amaster" "int *aslave" "char *name" "struct termios *termp" "struct winsize *winp"
43 .Fn forkpty "int *amaster" "char *name" "struct termios *termp" "struct winsize *winp"
47 attempts to obtain the next available pseudo-terminal from the system (see
49 If it successfully finds one, it subsequently changes the
50 ownership of the slave device to the real UID of the current process,
51 the group membership to the group
53 (if such a group exists in the system), the access permissions for
54 reading and writing by the owner, and for writing by the group, and
55 invalidates any current use of the line by calling
63 copies the pathname of the slave pty to this area.
65 responsible for allocating the required space in this array.
74 initializes the termios and window size settings from the structures
75 these arguments point to, respectively.
77 Upon return, the open file descriptors for the master and slave side
78 of the pty are returned in the locations pointed to by
88 to obtain the next available pseudo-terminal from the system.
90 it forks off a new process.
91 In the child process, it closes the descriptor
92 for the master side of the pty, and calls
95 In the parent process, it closes the descriptor for the
96 slave side of the pty.
103 have the same meaning as described for
108 function returns 0 on success, or -1 on failure.
112 function returns -1 on failure, 0 in the slave process, and the process ID of
113 the slave process in the parent process.
117 function may fail and set the global variable
119 for any of the errors specified for the
131 may set it to any value as described for
149 functions first appeared in
153 writes the slave terminal's name to
155 but does not check that sufficient space is available.
156 It is advisable to use