bordeauxctl(1)

📦 version 0.9.7, in alpine 3.24

🌸 bordeauxctl(1) — the group-chat guide 🌸

okay so real talk, bestie: this is the manual page for bordeauxctl, living in the General Commands Manual section of your system. It's a whole little vibe. Let's get into it 💅

✨ NAME ✨

bordeauxctl — send a control message to a bordeaux server 🫶

✨ SYNOPSIS ✨

bordeauxctl [options] command [args...]

✨ DESCRIPTION ✨

So what it does is: it sends a command string to a running bordeaux server, and then it literally just waits to be signaled for success or failure. Iconic behavior, honestly 😌

Since command strings are space separated, the shell can be used to pass cli arguments directly — no cap, that's the whole trick fr fr. And if your content has spaces in it? Just wrap it up in a single quote string and you're golden ✨

lowkey the waiting part is the main character energy of this whole tool — it doesn't just fire and forget, it stays there until the server signals back 💖

🎀 OPTIONS 🎀

  • --quiet — only return the exit code, produce no output. silent. mysterious. in her stealth era 🕶️
  • --session — show session status 🌸
  • --timeout=*seconds — wait to be signaled for the specified timeout. the default is 5 seconds ⏱️
  • --help — outputs the help screen for the user. your little rescue blanket 🫶

💀 EXIT STATUS 💀

Exit status can be used to determine command results in shell scripts — so like, yes, you can absolutely build on this 🧚

  1. 0 — command sent and successfully processed. slay. it ate. ✨
  2. 1 — command send resulted in an error or is invalid. not the vibe 😭
  3. 2 — command timed out without any response signaled. she ghosted you 💀
  4. 3 — error sending to fifo. the pipe said no 🙈
  5. 4 — fifo not found or inaccessible. where is she. genuinely where is she 🕵️

Copyright © 2021 Tycho Softworks.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

read that again bestie — NO warranty. none. zero. not even the implied ones. protect yourself, read the source 💜

okay that's the whole page!! 🎀 huge thank you to Tycho Softworks for this one — it's the Bordeaux manual, section bordeauxctl(1), and that's the vibe check complete. go forth and signal your server, bestie 🌈🦋💅

📦 where this page comes from