xpacmdadd(3)

💖 xpacmdadd(3) — the SAORD Documentation glow-up 💖

okay bestie, welcome to the manual page for xpacmdadd, straight out of the SAORD Documentation fam. this is a C library thing, it lives in section 3, and it's about to make your XPA command access point ✨populated✨. let's get into it 🫶

---

🌸 NAME 🌸

XPACmdAdd — add a command to an XPA command public access point. that's it, that's the whole vibe. one job, does it well 💅

---

🦋 SYNOPSIS 🦋

#include <xpa.h>

XPACmd XPACmdAdd(XPA xpa, char *name, char *help,
                 int (*send_callback)(),
                 void *send_data, char *send_mode,
                 int (*rec_callback)(),
                 void *rec_data,  char *rec_mode);

like. look at all those args. nine of them. she's thorough 💀 but every single one matters, so let's go.

---

✨ DESCRIPTION ✨

so the whole point of XPACmdAdd is literally right there in the name: you're adding a command to an XPA command access point. think of it like adding a new item to the menu at your fave cafe 🍓 the cafe exists already, you're just giving it one more thing it can make.

the XPA argument? that's the XPA struct you already got back from a call to XPANewCmd(). yes, you gotta have the access point first. no skipping steps, bestie.

the name argument is — shocker — the name of the command. cute, simple, iconic.

now the rest of the arguments? they work identically to the arguments in the XPANew() command. like, truly identical. the send_callback and rec_callback routines have the exact same calling sequences as their XPANew() counterparts — with the exceptions noted below, because of course there are exceptions, it's C 🙈

---

🎀 how the help works 🎀

when help gets requested for a command access point using:

xpaget -h class:name

you get all of the command help strings listed. the whole squad. every command's help, all at once, no cap 💖

but if you want help for just one specific command? you gotta be more specific, girl:

xpaget -h class:name cmd

there we go. targeted. focused. main character energy for that one command 👑

---

🧚 the acl thing (read this part, fr fr) 🧚

okay this is the important tea ☕ so listen up:

the acl keyword in the send_mode and receive_mode strings is global to the access point — it is not local to the command. like, it belongs to the whole party, not to one guest.

so that means the value for the acl mode should be the same in all send_mode (or receive_mode) strings for each command in a command access point. keep it consistent, bestie, don't be out here setting different acls per command, that's not the move.

tiny plot twist though: the acl for send_mode does not need to be the same as the acl for receive_mode. those two can be different! so like, consistent within each one, but the send side and the receive side are allowed to disagree. iykyk 💅

---

🌈 SEE ALSO 🌈

• See xpa(n) for a list of XPA help pages — go read those too, they're the rest of the lore 📚

---

and that's the whole page, bestie!! no crumbs left, we ate 🍽️✨

version 2.1.15 · July 23, 2013 — yeah she's an older queen but she still slays 💜 mwah, go add some commands 🎀🦋🌸