TCSENDBREAK(3POSIX)

📦 version 2017a, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 TCSENDBREAK(3POSIX) 💖

okay bestie, welcome to the POSIX Programmer's Manual page for tcsendbreak — yes that's the manual name, we're in the 3POSIX section, and we are so about to send some breaks. ✨

🫶 PROLOG

This manual page is part of the POSIX Programmer's Manual. Heads up though: the Linux implementation of this interface may differ — so go peek at the corresponding Linux manual page for the deets on Linux behavior — or honestly, the interface may not even be implemented on Linux at all. 💀

✨ NAME ✨

tcsendbreak — send a break for a specific duration. that's it, that's the job. 🎀

🌸 SYNOPSIS 🌸

#include <termios.h>

int tcsendbreak(int fildes, int duration);

🦋 DESCRIPTION 🦋

okay so picture this: if the terminal is using asynchronous serial data transmission, tcsendbreak() shall cause transmission of a continuous stream of zero-valued bits for a specific duration. it's giving silence, but make it electrical. 💅

Now here's the tea on duration:

  • If duration is 0, it shall cause transmission of zero-valued bits for at least 0.25 seconds, and not more than 0.5 seconds. that's the vibe window, don't @ me.
  • If duration is not 0, it shall send zero-valued bits for an implementation-defined period of time. so like… ask your implementation, bestie, she knows. 🙈

The fildes argument is an open file descriptor associated with a terminal.

If the terminal is not using asynchronous serial data transmission, it is implementation-defined whether tcsendbreak() sends data to generate a break condition or returns without taking any action. truly nobody knows, it's a mystery era. 🌈

now the spicy part 🔥 — attempts to use tcsendbreak() from a process which is a member of a background process group on a fildes associated with its controlling terminal shall cause the process group to be sent a SIGTTOU signal. But! 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. blocked and unbothered, periodt.

👑 RETURN VALUE 👑

Upon successful completion, 0 shall be returned. Otherwise, -1 shall be returned and errno set to indicate the error. that's the whole personality. ✨

💀 ERRORS 💀

The tcsendbreak() function shall fail if:

  • EBADF — The fildes argument is not a valid file descriptor. not a real one, bestie, we can't work with that. 😭
  • EIO — The process group of the writing process is orphaned, the calling thread is not blocking SIGTTOU, and the process is not ignoring SIGTTOU. orphaned AND unprotected? it's giving no support system fr fr.
  • ENOTTY — The file associated with fildes is not a terminal. wrong number, wrong vibe. 🚫

The following sections are informative.

🎀 EXAMPLES 🎀

None. (yes, truly. nothing. we're keeping it minimal, she's mysterious. 💜)

🧚 APPLICATION USAGE 🧚

None. (again! iconically empty. ✨)

🌟 RATIONALE 🌟

None. (the reasoning is vibes only. no cap.)

⭐ FUTURE DIRECTIONS ⭐

None. (the future is unknown, but she's cute about it. 🦋)

💜 SEE ALSO 💜

  • The Base Definitions volume of POSIX.1‐2017, Chapter 11, General Terminal Interface, <termios.h>

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 .

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 .

and that's the whole page, bestie!! 🫶 written by IEEE/The Open Group, dated 2017, and delivered to you with main character energy. now go forth and send those breaks. mwah. 💅✨

📦 where this page comes from