]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man7/pty.7
Start of man-pages-5.02: updating .Announce and .lsm files
[thirdparty/man-pages.git] / man7 / pty.7
index c6d8c35d14943cde8d9d55ad268a907d82293c08..d221c41a7195e6f15ad0453e067f25e817bf22f7 100644 (file)
@@ -1,7 +1,6 @@
-.\" Hey Emacs! This file is -*- nroff -*- source.
-.\"
 .\" Copyright (C) 2005 Michael Kerrisk <mtk.manpages@gmail.com>
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -21,8 +20,9 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
-.TH PTY 7 2005-10-10 "Linux" "Linux Programmer's Manual"
+.TH PTY 7 2017-09-15 "Linux" "Linux Programmer's Manual"
 .SH NAME
 pty \- pseudoterminal interfaces
 .SH DESCRIPTION
@@ -48,19 +48,29 @@ that is connected to the slave.
 Conversely, anything that is written to the slave end of the
 pseudoterminal can be read by the process that is connected to
 the master end.
-Psuedoterminals are used by applications such as network login services
+Pseudoterminals are used by applications such as network login services
 .RB ( ssh "(1), " rlogin "(1), " telnet (1)),
-terminal emulators,
+terminal emulators such as
+.BR xterm (1),
 .BR script (1),
 .BR screen (1),
+.BR tmux (1),
+.BR unbuffer (1),
 and
 .BR expect (1).
-
+.PP
+Data flow between master and slave is handled asynchronously,
+much like data flow with a physical terminal.
+Data written to the slave will be available at the master promptly,
+but may not be available immediately.
+Similarly, there may be a small processing delay between
+a write to the master, and the effect being visible at the slave.
+.PP
 Historically, two pseudoterminal APIs have evolved: BSD and System V.
 SUSv1 standardized a pseudoterminal API based on the System V API,
 and this API should be employed in all new programs that use
 pseudoterminals.
-
+.PP
 Linux provides both BSD-style and (standardized) System V-style
 pseudoterminals.
 System V-style terminals are commonly called UNIX 98 pseudoterminals
@@ -68,7 +78,7 @@ on Linux systems.
 Since kernel 2.6.4, BSD-style pseudoterminals are considered deprecated
 (they can be disabled when configuring the kernel);
 UNIX 98 pseudoterminals should be used in new applications.
-.SS "UNIX 98 pseudoterminals"
+.SS UNIX 98 pseudoterminals
 An unused UNIX 98 pseudoterminal master is opened by calling
 .BR posix_openpt (3).
 (This function opens the master clone device,
@@ -85,7 +95,7 @@ the name returned by
 .BR ptsname (3)
 in a call to
 .BR open (2).
-
+.PP
 The Linux kernel imposes a limit on the number of available
 UNIX 98 pseudoterminals.
 In kernels up to and including 2.6.3, this limit is configured
@@ -100,15 +110,15 @@ and a corresponding file,
 indicates how many pseudoterminals are currently in use.
 For further details on these two files, see
 .BR proc (5).
-.SS "BSD pseudoterminals"
+.SS BSD pseudoterminals
 BSD-style pseudoterminals are provided as precreated pairs, with
 names of the form
 .I /dev/ptyXY
 (master) and
 .I /dev/ttyXY
 (slave),
-where X is a letter from the 16-character set [p-za-e],
-and Y is a letter from the 16-character set [0-9a-f].
+where X is a letter from the 16-character set [p\-za\-e],
+and Y is a letter from the 16-character set [0\-9a\-f].
 (The precise range of letters in these two sets varies across UNIX
 implementations.)
 For example,
@@ -121,25 +131,26 @@ A process finds an unused pseudoterminal pair by trying to
 each pseudoterminal master until an open succeeds.
 The corresponding pseudoterminal slave (substitute "tty"
 for "pty" in the name of the master) can then be opened.
-.SH "FILES"
+.SH FILES
+.TP
 .I /dev/ptmx
-(UNIX 98 master clone device)
-.br
+UNIX 98 master clone device
+.TP
 .I /dev/pts/*
-(UNIX 98 slave devices)
-.br
-.I /dev/pty[p-za-e][0-9a-f]
-(BSD master devices)
-.br
-.I /dev/tty[p-za-e][0-9a-f]
-(BSD slave devices)
-.SH "NOTES"
+UNIX 98 slave devices
+.TP
+.I /dev/pty[p\-za\-e][0\-9a\-f]
+BSD master devices
+.TP
+.I /dev/tty[p\-za\-e][0\-9a\-f]
+BSD slave devices
+.SH NOTES
 A description of the
 .B TIOCPKT
 .BR ioctl (2),
 which controls packet mode operation, can be found in
-.BR tty_ioctl (4).
-
+.BR ioctl_tty (2).
+.PP
 The BSD
 .BR ioctl (2)
 operations
@@ -149,12 +160,12 @@ operations
 and
 .BR TIOCREMOTE
 have not been implemented under Linux.
-.SH "SEE ALSO"
+.SH SEE ALSO
+.BR ioctl_tty (2),
 .BR select (2),
 .BR setsid (2),
 .BR forkpty (3),
 .BR openpty (3),
 .BR termios (3),
 .BR pts (4),
-.BR tty (4),
-.BR tty_ioctl (4)
+.BR tty (4)