aboutsummaryrefslogtreecommitdiffstats
path: root/man3/unlockpt.3
diff options
authorMichael Kerrisk <mtk.manpages@gmail.com>2020-07-28 22:12:08 +0200
committerMichael Kerrisk <mtk.manpages@gmail.com>2020-07-29 11:19:07 +0200
commit5e3bcef1ae44ef6789f61e000f67a2214fd07582 (patch)
tree4310e56b1bf31dc311e7ba30e4f89e5e0125ca6a /man3/unlockpt.3
parentb38481347944c76617d0bc144649457901898cc7 (diff)
downloadman-pages-pty_lang_fixup.tar.gz
ioctl_tty.2, poll.2, getpt.3, grantpt.3, openpty.3, posix_openpt.3, ptsname.3, ttyname.3, unlockpt.3, pts.4, pty.7: Eliminate problematic "master-slave" terminologypty_lang_fixup
The "master-slave" terminology used in describing pseudoterminals is problematic, and not even very technically descriptive. Rewrite various manual pages to eliminate that language. The following replacement terms are used: slave ==> "terminal device" (or "terminal end of the pseudoterminal device pair") master ==> "pseudoterminal device" (or "pseudoterminal end of the pseudoterminal device pair") pseudoterminal (device) ==> "pseudoterminal device pair" Another notable wording change is the use of phrasings such as "the corresponding terminal device", when emphasizing the linkage between the pseudoterminal and terminal ends of a pseudoterminal device pair. The terminology originates in golang (which made a similar terminology change in 2019), and was suggested for Linux man-pages by Elliot Hughes. Reported-by: Elliott Hughes <enh@google.com> Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man3/unlockpt.3')
-rw-r--r--man3/unlockpt.311
1 files changed, 6 insertions, 5 deletions
diff --git a/man3/unlockpt.3 b/man3/unlockpt.3
index 26333ef6d3..c3d67f4a2c 100644
--- a/man3/unlockpt.3
+++ b/man3/unlockpt.3
@@ -4,7 +4,7 @@
.\"
.TH UNLOCKPT 3 2017-07-13 "" "Linux Programmer's Manual"
.SH NAME
-unlockpt \- unlock a pseudoterminal master/slave pair
+unlockpt \- unlock a pseudoterminal device pair
.SH SYNOPSIS
.B #define _XOPEN_SOURCE
.br
@@ -32,12 +32,13 @@ Glibc 2.23 and earlier:
.SH DESCRIPTION
The
.BR unlockpt ()
-function unlocks the slave pseudoterminal device
-corresponding to the master pseudoterminal referred to by the file descriptor
+function unlocks the terminal device
+corresponding to the pseudoterminal device referred to by the file descriptor
.IR fd .
.PP
.BR unlockpt ()
-should be called before opening the slave side of a pseudoterminal.
+should be called before opening the terminal end of
+a pseudoterminal device pair.
.SH RETURN VALUE
When successful,
.BR unlockpt ()
@@ -55,7 +56,7 @@ argument is not a file descriptor open for writing.
.B EINVAL
The
.I fd
-argument is not associated with a master pseudoterminal.
+argument is not associated with a pseudoterminal device.
.SH VERSIONS
.BR unlockpt ()
is provided in glibc since version 2.1.