]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
man/man3/termios.3, man/man3/tcflow.3: Split tcflow() from termios(3)
authorAlejandro Colomar <alx@kernel.org>
Wed, 1 Jul 2026 13:29:06 +0000 (15:29 +0200)
committerAlejandro Colomar <alx@kernel.org>
Thu, 2 Jul 2026 11:50:26 +0000 (13:50 +0200)
Suggested-by: "H. Peter Anvin" <hpa@zytor.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
man/man3/tcflow.3
man/man3/termios.3

index eb472496ddf84c562e230a80cbe6094e433b97f9..8b96a6238050c4529c361825709de15cd9e4112c 100644 (file)
@@ -1 +1,87 @@
-.so man3/termios.3
+'\" t
+.\" Copyright 2006-2015, Michael Kerrisk <mtk.manpages@gmail.com>
+.\" Copyright, the authors of the Linux man-pages project
+.\"
+.\" SPDX-License-Identifier: GPL-2.0-or-later
+.\"
+.TH tcflow 3 (date) "Linux man-pages (unreleased)"
+.SH NAME
+tcflow
+\-
+suspect transmission or reception of data
+.SH LIBRARY
+Standard C library
+.RI ( libc ,\~ \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <termios.h>
+.P
+.BI "int tcflow(int " fd ", int " action );
+.fi
+.SH DESCRIPTION
+.BR tcflow ()
+suspends transmission or reception of data
+on the object referred to by
+.IR fd ,
+depending on the value of
+.IR action :
+.TP
+.B TCOOFF
+suspends output.
+.TP
+.B TCOON
+restarts suspended output.
+.TP
+.B TCIOFF
+transmits a STOP character,
+which stops the terminal device from
+transmitting data to the system.
+.TP
+.B TCION
+transmits a START character,
+which starts the terminal device
+transmitting data to the system.
+.P
+The default on open of a terminal file is that
+neither its input nor its output is suspended.
+.SH RETURN VALUE
+.TP
+.B 0
+on success.
+.TP
+.B \-1
+on failure and set
+.I errno
+to indicate the error.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section,
+see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.na
+.nh
+.BR tcflow ()
+T}     Thread safety   MT-Safe
+.TE
+.\" FIXME: The markings are different from that in the glibc manual.
+.\" markings in glibc manual are more detailed:
+.\"
+.\"     tcflow: MT-Unsafe race:tcattr(filedes)/bsd
+.\"
+.\" glibc manual says /bsd indicate the preceding marker only applies
+.\" when the underlying kernel is a BSD kernel.
+.\" So, it is safety in Linux kernel.
+.SH STANDARDS
+POSIX.1-2008.
+.SH HISTORY
+POSIX.1-2001.
+.SH SEE ALSO
+.BR tcsendbreak (3),
+.BR tcdrain (3),
+.BR tcflush (3),
+.BR termios (3)
index 27859904e9d2d1b3120e55a716eb16f1ed8f0265..cb7a796d798adb50821599cb56eafa9ad1ed10b7 100644 (file)
@@ -6,7 +6,7 @@
 .\"
 .TH termios 3 (date) "Linux man-pages (unreleased)"
 .SH NAME
-termios, tcflow,
+termios,
 cfgetospeed, cfgetispeed, cfsetispeed, cfsetospeed, cfsetspeed \-
 get and set terminal attributes, line control, get and set baud rate
 .SH LIBRARY
@@ -17,8 +17,6 @@ Standard C library
 .B #include <termios.h>
 .B #include <unistd.h>
 .P
-.BI "int tcflow(int " fd ", int " action );
-.P
 .BI "speed_t cfgetispeed(const struct termios *" termios_p );
 .BI "speed_t cfgetospeed(const struct termios *" termios_p );
 .P
@@ -60,32 +58,8 @@ See
 .BR tcdrain (3)
 .TQ
 .BR tcflush (3)
-.P
-.BR tcflow ()
-suspends transmission or reception of data
-on the object referred to by
-.IR fd ,
-depending on the value of
-.IR action :
-.TP
-.B TCOOFF
-suspends output.
-.TP
-.B TCOON
-restarts suspended output.
-.TP
-.B TCIOFF
-transmits a STOP character,
-which stops the terminal device from
-transmitting data to the system.
-.TP
-.B TCION
-transmits a START character,
-which starts the terminal device
-transmitting data to the system.
-.P
-The default on open of a terminal file is that
-neither its input nor its output is suspended.
+.TQ
+.BR tcflow (3)
 .SS Line speed
 The baud rate functions are provided
 for getting and setting
@@ -299,7 +273,6 @@ Interface   Attribute       Value
 T{
 .na
 .nh
-.BR tcflow (),
 .BR cfgetispeed (),
 .BR cfgetospeed (),
 .BR cfsetispeed (),
@@ -307,18 +280,8 @@ T{
 .BR cfsetspeed ()
 T}     Thread safety   MT-Safe
 .TE
-.\" FIXME: The markings are different from that in the glibc manual.
-.\" markings in glibc manual are more detailed:
-.\"
-.\"     tcflow: MT-Unsafe race:tcattr(filedes)/bsd
-.\"
-.\" glibc manual says /bsd indicate the preceding marker only applies
-.\" when the underlying kernel is a BSD kernel.
-.\" So, it is safety in Linux kernel.
 .SH STANDARDS
 .TP
-.BR tcflow ()
-.TQ
 .BR cfgetispeed ()
 .TQ
 .BR cfgetospeed ()
@@ -332,8 +295,6 @@ POSIX.1-2008.
 BSD.
 .SH HISTORY
 .TP
-.BR tcflow ()
-.TQ
 .BR cfgetispeed ()
 .TQ
 .BR cfgetospeed ()