summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/tcsendbreak.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2017/man3p/tcsendbreak.3p')
-rw-r--r--man-pages-posix-2017/man3p/tcsendbreak.3p105
1 files changed, 105 insertions, 0 deletions
diff --git a/man-pages-posix-2017/man3p/tcsendbreak.3p b/man-pages-posix-2017/man3p/tcsendbreak.3p
new file mode 100644
index 0000000..c61032b
--- /dev/null
+++ b/man-pages-posix-2017/man3p/tcsendbreak.3p
@@ -0,0 +1,105 @@
+'\" et
+.TH TCSENDBREAK "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+.\"
+.SH NAME
+tcsendbreak
+\(em send a break for a specific duration
+.SH SYNOPSIS
+.LP
+.nf
+#include <termios.h>
+.P
+int tcsendbreak(int \fIfildes\fP, int \fIduration\fP);
+.fi
+.SH DESCRIPTION
+If the terminal is using asynchronous serial data transmission,
+\fItcsendbreak\fR()
+shall cause transmission of a continuous stream of zero-valued bits for
+a specific duration. If
+.IR duration
+is 0, it shall cause transmission of zero-valued bits for at least 0.25
+seconds, and not more than 0.5 seconds. If
+.IR duration
+is not 0, it shall send zero-valued bits for an
+implementation-defined period of time.
+.P
+The
+.IR fildes
+argument is an open file descriptor associated with a terminal.
+.P
+If the terminal is not using asynchronous serial data transmission, it
+is implementation-defined whether
+\fItcsendbreak\fR()
+sends data to generate a break condition or returns without taking any
+action.
+.P
+Attempts to use
+\fItcsendbreak\fR()
+from a process which is a member of a background process group on a
+.IR fildes
+associated with its controlling terminal shall cause the process group
+to be sent a SIGTTOU signal.
+If the calling thread is blocking SIGTTOU signals or the process is
+ignoring SIGTTOU signals, the process shall be allowed to perform the
+operation, and no signal is sent.
+.SH "RETURN VALUE"
+Upon successful completion, 0 shall be returned. Otherwise, \-1 shall
+be returned and
+.IR errno
+set to indicate the error.
+.SH ERRORS
+The
+\fItcsendbreak\fR()
+function shall fail if:
+.TP
+.BR EBADF
+The
+.IR fildes
+argument is not a valid file descriptor.
+.TP
+.BR EIO
+The process group of the writing process is orphaned, the calling thread
+is not blocking SIGTTOU, and the process is not ignoring SIGTTOU.
+.TP
+.BR ENOTTY
+The file associated with
+.IR fildes
+is not a terminal.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+None.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "Chapter 11" ", " "General Terminal Interface",
+.IR "\fB<termios.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 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 .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .