]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/openpty.3
err.3: EXAMPLES: use EXIT_FAILURE rather than 1 as exit status
[thirdparty/man-pages.git] / man3 / openpty.3
index d07db6436ca79af91ed42a7743ca0ee16b7bb4db..56c8b4411c8b55c2339f0829dc0e3385bee39e92 100644 (file)
 .\"
 .\" Added -lutil remark, 030718
 .\"
-.TH OPENPTY 3  2015-04-19 "GNU" "Linux Programmer's Manual"
+.TH OPENPTY 3  2017-09-15 "GNU" "Linux Programmer's Manual"
 .SH NAME
 openpty, login_tty, forkpty \- terminal utility functions
 .SH SYNOPSIS
 .nf
 .B #include <pty.h>
-.sp
+.PP
 .BI "int openpty(int *" amaster ", int *" aslave ", char *" name ,
 .BI "            const struct termios *" termp ,
 .BI "            const struct winsize *" winp );
-.sp
+.PP
 .BI "pid_t forkpty(int *" amaster ", char *" name ,
 .BI "              const struct termios *" termp ,
 .BI "              const struct winsize *" winp );
-.sp
+
 .B #include <utmp.h>
-.sp
+.PP
 .BI "int login_tty(int " fd );
-.sp
+.PP
 Link with \fI\-lutil\fP.
 .fi
 .SH DESCRIPTION
@@ -73,7 +73,7 @@ If
 .I winp
 is not NULL, the window size of the slave will be set to the values in
 .IR winp .
-
+.PP
 The
 .BR login_tty ()
 function prepares for a login on the terminal
@@ -88,7 +88,7 @@ the controlling terminal for the calling process, setting
 to be the standard input, output, and error streams of the current
 process, and closing
 .IR fd .
-
+.PP
 The
 .BR forkpty ()
 function combines
@@ -99,10 +99,11 @@ and
 to create a new process operating in a pseudoterminal.
 The file
 descriptor of the master side of the pseudoterminal is returned in
-.IR amaster ,
-and the filename of the slave in
+.IR amaster .
+If
 .I name
-if it is not NULL.
+is not NULL, the buffer it points to is used to return the
+filename of the slave.
 The
 .I termp
 and
@@ -129,20 +130,20 @@ return 0, and the parent process of
 returns the process ID of the child process.
 .SH ERRORS
 .BR openpty ()
-will fail if:
+fails if:
 .TP
 .B ENOENT
 There are no available terminals.
-.LP
+.PP
 .BR login_tty ()
-will fail if
+fails if
 .BR ioctl (2)
 fails to set
 .I fd
 to the controlling terminal of the calling process.
-.LP
+.PP
 .BR forkpty ()
-will fail if either
+fails if either
 .BR openpty ()
 or
 .BR fork (2)
@@ -163,7 +164,7 @@ T{
 .BR login_tty ()
 T}     Thread safety   MT-Unsafe race:ttyname
 .TE
-
+.sp 1
 .SH CONFORMING TO
 These are BSD functions, present in glibc.
 They are not standardized in POSIX.
@@ -175,7 +176,7 @@ modifiers were added to the structure pointer arguments of
 and
 .BR forkpty ()
 in glibc 2.8.
-
+.PP
 In versions of glibc before 2.0.92,
 .BR openpty ()
 returns file descriptors for a BSD pseudoterminal pair;