diff options
Diffstat (limited to 'man3p/tcflush.3p')
-rw-r--r-- | man3p/tcflush.3p | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/man3p/tcflush.3p b/man3p/tcflush.3p new file mode 100644 index 000000000..20f42321c --- /dev/null +++ b/man3p/tcflush.3p @@ -0,0 +1,92 @@ +.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved +.TH "TCFLUSH" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" tcflush +.SH NAME +tcflush \- flush non-transmitted output data, non-read input data, +or both +.SH SYNOPSIS +.LP +\fB#include <termios.h> +.br +.sp +int tcflush(int\fP \fIfildes\fP\fB, int\fP \fIqueue_selector\fP\fB); +.br +\fP +.SH DESCRIPTION +.LP +Upon successful completion, \fItcflush\fP() shall discard data written +to the object referred to by \fIfildes\fP (an open file +descriptor associated with a terminal) but not transmitted, or data +received but not read, depending on the value of +\fIqueue_selector\fP: +.IP " *" 3 +If \fIqueue_selector\fP is TCIFLUSH, it shall flush data received +but not read. +.LP +.IP " *" 3 +If \fIqueue_selector\fP is TCOFLUSH, it shall flush data written but +not transmitted. +.LP +.IP " *" 3 +If \fIqueue_selector\fP is TCIOFLUSH, it shall flush both data received +but not read and data written but not transmitted. +.LP +.LP +Attempts to use \fItcflush\fP() from a process which is a member of +a background process group on a \fIfildes\fP associated +with its controlling terminal shall cause the process group to be +sent a SIGTTOU signal. If the calling process is blocking or +ignoring SIGTTOU signals, the process shall be allowed to perform +the operation, and no signal is sent. +.SH RETURN VALUE +.LP +Upon successful completion, 0 shall be returned. Otherwise, -1 shall +be returned and \fIerrno\fP set to indicate the error. +.SH ERRORS +.LP +The \fItcflush\fP() function shall fail if: +.TP 7 +.B EBADF +The \fIfildes\fP argument is not a valid file descriptor. +.TP 7 +.B EINVAL +The \fIqueue_selector\fP argument is not a supported value. +.TP 7 +.B ENOTTY +The file associated with \fIfildes\fP is not a terminal. +.sp +.LP +The \fItcflush\fP() function may fail if: +.TP 7 +.B EIO +The process group of the writing process is orphaned, and the writing +process is not ignoring or blocking SIGTTOU. +.sp +.LP +\fIThe following sections are informative.\fP +.SH EXAMPLES +.LP +None. +.SH APPLICATION USAGE +.LP +None. +.SH RATIONALE +.LP +None. +.SH FUTURE DIRECTIONS +.LP +None. +.SH SEE ALSO +.LP +\fItcdrain\fP() , the Base Definitions volume of IEEE\ Std\ 1003.1-2001, +Chapter 11, General Terminal Interface, \fI<termios.h>\fP, \fI<unistd.h>\fP +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of +Electrical and Electronics Engineers, Inc and The Open Group. In the +event of any discrepancy between this version and the original IEEE and +The Open Group Standard, the original IEEE and The Open Group Standard +is the referee document. The original Standard can be obtained online at +http://www.opengroup.org/unix/online.html . |