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 2015-07-23 "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 such as
  54 .BR xterm (1),
  55 .BR script (1),
  56 .BR screen (1),
  57 .BR tmux (1),
  58 .BR unbuffer (1),
  59 and
  60 .BR expect (1).
  61
  62 Data flow between master and slave is handled asynchronously,
  63 much like data flow with a physical terminal.
  64 Data written to the slave will be available at the master promptly,
  65 but may not be available immediately.
  66 Similarly, there may be a small processing delay between
  67 a write to the master, and the effect being visible at the slave.
  68
  69 Historically, two pseudoterminal APIs have evolved: BSD and System V.
  70 SUSv1 standardized a pseudoterminal API based on the System V API,
  71 and this API should be employed in all new programs that use
  72 pseudoterminals.
  73
  74 Linux provides both BSD-style and (standardized) System V-style
  75 pseudoterminals.
  76 System V-style terminals are commonly called UNIX 98 pseudoterminals
  77 on Linux systems.
  78 Since kernel 2.6.4, BSD-style pseudoterminals are considered deprecated
  79 (they can be disabled when configuring the kernel);
  80 UNIX 98 pseudoterminals should be used in new applications.
  81 .SS UNIX 98 pseudoterminals
  82 An unused UNIX 98 pseudoterminal master is opened by calling
  83 .BR posix_openpt (3).
  84 (This function opens the master clone device,
  85 .IR /dev/ptmx ;
  86 see
  87 .BR pts (4).)
  88 After performing any program-specific initializations,
  89 changing the ownership and permissions of the slave device using
  90 .BR grantpt (3),
  91 and unlocking the slave using
  92 .BR unlockpt (3)),
  93 the corresponding slave device can be opened by passing
  94 the name returned by
  95 .BR ptsname (3)
  96 in a call to
  97 .BR open (2).
  98
  99 The Linux kernel imposes a limit on the number of available
 100 UNIX 98 pseudoterminals.
 101 In kernels up to and including 2.6.3, this limit is configured
 102 at kernel compilation time
 103 .RB ( CONFIG_UNIX98_PTYS ),
 104 and the permitted number of pseudoterminals can be up to 2048,
 105 with a default setting of 256.
 106 Since kernel 2.6.4, the limit is dynamically adjustable via
 107 .IR /proc/sys/kernel/pty/max ,
 108 and a corresponding file,
 109 .IR /proc/sys/kernel/pty/nr ,
 110 indicates how many pseudoterminals are currently in use.
 111 For further details on these two files, see
 112 .BR proc (5).
 113 .SS BSD pseudoterminals
 114 BSD-style pseudoterminals are provided as precreated pairs, with
 115 names of the form
 116 .I /dev/ptyXY
 117 (master) and
 118 .I /dev/ttyXY
 119 (slave),
 120 where X is a letter from the 16-character set [p-za-e],
 121 and Y is a letter from the 16-character set [0-9a-f].
 122 (The precise range of letters in these two sets varies across UNIX
 123 implementations.)
 124 For example,
 125 .I /dev/ptyp1
 126 and
 127 .I /dev/ttyp1
 128 constitute a BSD pseudoterminal pair.
 129 A process finds an unused pseudoterminal pair by trying to
 130 .BR open (2)
 131 each pseudoterminal master until an open succeeds.
 132 The corresponding pseudoterminal slave (substitute "tty"
 133 for "pty" in the name of the master) can then be opened.
 134 .SH FILES
 135 .I /dev/ptmx
 136 (UNIX 98 master clone device)
 137 .br
 138 .I /dev/pts/*
 139 (UNIX 98 slave devices)
 140 .br
 141 .I /dev/pty[p-za-e][0-9a-f]
 142 (BSD master devices)
 143 .br
 144 .I /dev/tty[p-za-e][0-9a-f]
 145 (BSD slave devices)
 146 .SH NOTES
 147 A description of the
 148 .B TIOCPKT
 149 .BR ioctl (2),
 150 which controls packet mode operation, can be found in
 151 .BR ioctl_tty (2).
 152
 153 The BSD
 154 .BR ioctl (2)
 155 operations
 156 .BR TIOCSTOP ,
 157 .BR TIOCSTART ,
 158 .BR TIOCUCNTL ,
 159 and
 160 .BR TIOCREMOTE
 161 have not been implemented under Linux.
 162 .SH SEE ALSO
 163 .BR ioctl_tty (2),
 164 .BR select (2),
 165 .BR setsid (2),
 166 .BR forkpty (3),
 167 .BR openpty (3),
 168 .BR termios (3),
 169 .BR pts (4),
 170 .BR tty (4)