explain_tcflow_or_die(3)

💖 explain_tcflow_or_die — from the Library Functions Manual ✨

okay bestie, pull up a chair, we're doing a 3 page here (that's a library functions manual page, iykyk) and it's all about terminal flow control plus reporting errors like a main character. let's get into it 🫶

---

✨ NAME ✨

explain_tcflow_or_die — terminal flow control and report errors 💅

---

🦋 SYNOPSIS 🦋

#include <libexplain/tcflow.h>
void explain_tcflow_or_die(int fildes, int action);
int explain_tcflow_on_error(int fildes, int action);

---

🌸 DESCRIPTION 🌸

so, explain_tcflow_or_die is the function you call when you wanna hit up the tcflow(3) system call. if it fails? an explanation gets printed to stderr, and that explanation comes from the explain_tcflow(3) function. and then — and this is the dramatic part — the process terminates by calling exit(EXIT_FAILURE). it's giving "we don't do half measures" 💀

explain_tcflow_on_error is the chill sibling. it also calls the tcflow(3) system call, and on failure it also prints an explanation to stderr (again, obtained from the explain_tcflow(3) function), but it still returns to the caller. no exit, no drama, just vibes and a returned error. 🧚

• fildes — the fildes, exactly as to be passed to the tcflow(3) system call. no notes, pass it exactly. ✨
• action — the action, exactly as to be passed to the tcflow(3) system call. same energy, exactly as-is. 💜

---

👑 RETURN VALUE 👑

explain_tcflow_or_die only returns on success — for more info, go look at tcflow(3). on failure it prints an explanation and exits, so like… it does not return. periodt. 😭

explain_tcflow_on_error always returns the value return by the wrapped tcflow(3) system call. (yes, "return by", that's how the page says it, we keep it 💖)

---

🍓 EXAMPLE 🍓

the explain_tcflow_or_die function is intended to be used in a fashion similar to the following example:

explain_tcflow_or_die(fildes, action);

that's it, that's the whole vibe. iconic. 🔥

---

🌈 SEE ALSO 🌈

• tcflow(3) — terminal flow control
• explain_tcflow(3) — explain tcflow(3) errors
• exit(2) — terminate the calling process

---

💜 COPYRIGHT 💜

libexplain version 1.4 Copyright (C) 2009 Peter Miller

---

okay that's the whole page, bestie!! 🎀 go forth, handle your terminal flow control, and remember: if it fails, at least it'll tell you why before it dips. no cap. slay ✨💅🦋

— signed off from the explain_tcflow_or_die(3) corner of the Library Functions Manual, where it's always libexplain version 1.4, Copyright (C) 2009 Peter Miller, and always iconic 🫶