REMCTL_COMMAND(3)

💖 REMCTL_COMMAND — sending commands to your remctl server like the icon you are 💖

okay bestie, so this is the remctl library reference page for remctl_command and remctl_commandv, fr fr. two lil functions, one big job: yeeting a command at a remctl server. let's get into it 🫶

---

✨ NAME ✨

remctl_command, remctl_commandv — Send a command to a remctl server

---

✨ SYNOPSIS ✨

#include <remctl.h>

int remctl_command(struct remctl *r, const char **command);

#include <sys/uio.h>

int remctl_commandv(struct remctl *r, const struct iovec *iov,
                    size_t count);

---

🌸 DESCRIPTION 🌸

so remctl_command() and remctl_commandv() send a command to a remote remctl server. iconic behaviour honestly.

your remctl client object r — the one you made with remctl_new() — should have already been handed over to remctl_open() first, so you've got an actual open connection to the server. no connection, no vibes, no command. that's the rule 💅

remctl_command() takes the command as a NULL-terminated array of NUL-terminated strings — literally the same layout as an argv array. this one is your bestie when you're passing simple text commands, super convenient, no notes ✨

remctl_commandv() takes the command as an array of iovec structs of length count. this one is the moment when you're passing arbitrary data to the command, because the iovec struct holds a pointer and a length for each chunk of data. for the exact layout of the iovec struct, go peek at writev(2). slay 🦋

wanna control the network timeout for sending the command? that's a whole separate thing, go look at remctl_set_timeout(3). 👑

and after you call one of these functions? you call remctl_output() to get the results of the command. do not skip this step, that's where the actual tea is ☕

---

⭐ RETURN VALUE ⭐

remctl_command() and remctl_commandv() return true on success and false on failure.

on failure, the caller should call remctl_error() to retrieve the error message. yes, actually call it — it's right there, it's telling you what went wrong, let it speak 🗣️

---

🌈 COMPATIBILITY 🌈

these interfaces have been provided by the remctl client library since its initial release in version 2.0. day one. original main character energy. periodt 💅

---

👑 AUTHOR 👑

Russ Allbery <eagle@eyrie.org>

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright 2007, 2009, 2014 The Board of Trustees of the Leland Stanford Junior University

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.

SPDX-License-Identifier: FSFAP

no cap, "without any warranty" means exactly what it says — as-is, bestie, no promises 🙈

---

🧚 SEE ALSO 🧚

• remctl_new(3)
• remctl_open(3)
• remctl_output(3)
• remctl_error(3)

The current version of the remctl library and complete details of the remctl protocol are available from its web page at <https://www.eyrie.org/~eagle/software/remctl/>. go read it, iykyk 💜

---

and that's the whole page!! this was remctl Library Reference, version 3.18, dated 2022-05-09 — tysm for reading, go send some commands, you're doing amazing sweetie 🍓✨💖