1 .\" Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Portions of this software were developed under sponsorship from Snow
5 .\" B.V., the Netherlands.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" Portions of this text are reprinted and reproduced in electronic form
29 .\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
30 .\" Portable Operating System Interface (POSIX), The Open Group Base
31 .\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
32 .\" Electrical and Electronics Engineers, Inc and The Open Group. In the
33 .\" event of any discrepancy between this version and the original IEEE and
34 .\" The Open Group Standard, the original IEEE and The Open Group Standard is
35 .\" the referee document. The original Standard can be obtained online at
36 .\" http://www.opengroup.org/unix/online.html.
45 .Nd "open a pseudo-terminal device"
52 .Fn posix_openpt "int oflag"
56 function allocates a new pseudo-terminal and establishes a connection
57 with its master device.
58 A slave device shall be created in
60 After the pseudo-terminal has been allocated, the slave device should
61 have the proper permissions before it can be used (see
63 The name of the slave device can be determined by calling
66 The file status flags and file access modes of the open file description
67 shall be set according to the value of
71 are constructed by a bitwise-inclusive OR of flags from the following
74 .Bl -tag -width ".Dv O_NOCTTY"
76 Open for reading and writing.
80 shall not cause the terminal device to become the controlling terminal
86 function shall fail when
88 contains other values.
90 Upon successful completion, the
92 function shall allocate a new pseudo-terminal device and return a
93 non-negative integer representing a file descriptor, which is connected
95 Otherwise, -1 shall be returned and errno set to indicate the error.
99 function shall fail if:
102 The system file table is full.
108 Out of pseudo-terminal resources.
126 this function was changed to a system call.
130 is included for compatibility; in
132 opening a terminal does not cause it to become a process's controlling
135 .An Ed Schouten Aq ed@FreeBSD.org