OSDN Git Service

(split) LDP: Update original to LDP v3.65
[linuxjm/LDP_man-pages.git] / original / man7 / pty.7
1 .\" Copyright (C) 2005 Michael Kerrisk <mtk.manpages@gmail.com>
2 .\"
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
7 .\"
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
12 .\"
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein.  The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
19 .\" professionally.
20 .\"
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" %%%LICENSE_END
24 .\"
25 .TH PTY 7 2005-10-10 "Linux" "Linux Programmer's Manual"
26 .SH NAME
27 pty \- pseudoterminal interfaces
28 .SH DESCRIPTION
29 A pseudoterminal (sometimes abbreviated "pty")
30 is a pair of virtual character devices that
31 provide a bidirectional communication channel.
32 One end of the channel is called the
33 .IR master ;
34 the other end is called the
35 .IR slave .
36 The slave end of the pseudoterminal provides an interface
37 that behaves exactly like a classical terminal.
38 A process that expects to be connected to a terminal,
39 can open the slave end of a pseudoterminal and
40 then be driven by a program that has opened the master end.
41 Anything that is written on the master end is provided to the process
42 on the slave end as though it was input typed on a terminal.
43 For example, writing the interrupt character (usually control-C)
44 to the master device would cause an interrupt signal
45 .RB ( SIGINT )
46 to be generated for the foreground process group
47 that is connected to the slave.
48 Conversely, anything that is written to the slave end of the
49 pseudoterminal can be read by the process that is connected to
50 the master end.
51 Pseudoterminals are used by applications such as network login services
52 .RB ( ssh "(1), " rlogin "(1), " telnet (1)),
53 terminal emulators,
54 .BR script (1),
55 .BR screen (1),
56 and
57 .BR expect (1).
58
59 Historically, two pseudoterminal APIs have evolved: BSD and System V.
60 SUSv1 standardized a pseudoterminal API based on the System V API,
61 and this API should be employed in all new programs that use
62 pseudoterminals.
63
64 Linux provides both BSD-style and (standardized) System V-style
65 pseudoterminals.
66 System V-style terminals are commonly called UNIX 98 pseudoterminals
67 on Linux systems.
68 Since kernel 2.6.4, BSD-style pseudoterminals are considered deprecated
69 (they can be disabled when configuring the kernel);
70 UNIX 98 pseudoterminals should be used in new applications.
71 .SS UNIX 98 pseudoterminals
72 An unused UNIX 98 pseudoterminal master is opened by calling
73 .BR posix_openpt (3).
74 (This function opens the master clone device,
75 .IR /dev/ptmx ;
76 see
77 .BR pts (4).)
78 After performing any program-specific initializations,
79 changing the ownership and permissions of the slave device using
80 .BR grantpt (3),
81 and unlocking the slave using
82 .BR unlockpt (3)),
83 the corresponding slave device can be opened by passing
84 the name returned by
85 .BR ptsname (3)
86 in a call to
87 .BR open (2).
88
89 The Linux kernel imposes a limit on the number of available
90 UNIX 98 pseudoterminals.
91 In kernels up to and including 2.6.3, this limit is configured
92 at kernel compilation time
93 .RB ( CONFIG_UNIX98_PTYS ),
94 and the permitted number of pseudoterminals can be up to 2048,
95 with a default setting of 256.
96 Since kernel 2.6.4, the limit is dynamically adjustable via
97 .IR /proc/sys/kernel/pty/max ,
98 and a corresponding file,
99 .IR /proc/sys/kernel/pty/nr ,
100 indicates how many pseudoterminals are currently in use.
101 For further details on these two files, see
102 .BR proc (5).
103 .SS BSD pseudoterminals
104 BSD-style pseudoterminals are provided as precreated pairs, with
105 names of the form
106 .I /dev/ptyXY
107 (master) and
108 .I /dev/ttyXY
109 (slave),
110 where X is a letter from the 16-character set [p-za-e],
111 and Y is a letter from the 16-character set [0-9a-f].
112 (The precise range of letters in these two sets varies across UNIX
113 implementations.)
114 For example,
115 .I /dev/ptyp1
116 and
117 .I /dev/ttyp1
118 constitute a BSD pseudoterminal pair.
119 A process finds an unused pseudoterminal pair by trying to
120 .BR open (2)
121 each pseudoterminal master until an open succeeds.
122 The corresponding pseudoterminal slave (substitute "tty"
123 for "pty" in the name of the master) can then be opened.
124 .SH FILES
125 .I /dev/ptmx
126 (UNIX 98 master clone device)
127 .br
128 .I /dev/pts/*
129 (UNIX 98 slave devices)
130 .br
131 .I /dev/pty[p-za-e][0-9a-f]
132 (BSD master devices)
133 .br
134 .I /dev/tty[p-za-e][0-9a-f]
135 (BSD slave devices)
136 .SH NOTES
137 A description of the
138 .B TIOCPKT
139 .BR ioctl (2),
140 which controls packet mode operation, can be found in
141 .BR tty_ioctl (4).
142
143 The BSD
144 .BR ioctl (2)
145 operations
146 .BR TIOCSTOP ,
147 .BR TIOCSTART ,
148 .BR TIOCUCNTL ,
149 and
150 .BR TIOCREMOTE
151 have not been implemented under Linux.
152 .SH SEE ALSO
153 .BR select (2),
154 .BR setsid (2),
155 .BR forkpty (3),
156 .BR openpty (3),
157 .BR termios (3),
158 .BR pts (4),
159 .BR tty (4),
160 .BR tty_ioctl (4)
161 .SH COLOPHON
162 This page is part of release 3.65 of the Linux
163 .I man-pages
164 project.
165 A description of the project,
166 and information about reporting bugs,
167 can be found at
168 \%http://www.kernel.org/doc/man\-pages/.