LIBXO(3)

💅 LIBXO(3) — xo_parse_args, xo_set_program 💅

okay so bestie, this is LIBXO(3) from the Library Functions Manual. we're about to get into the two functions that detect, parse, and remove arguments for libxo. it's giving utility, it's giving group-chat explainer. 🎀

✨ NAME ✨

xo_parse_args, xo_set_program — detect, parse, and remove arguments for libxo. periodt. 💅

📚 LIBRARY 📚

It's the library “libxo” — yes, that one. 🦋

🛠️ SYNOPSIS 🛠️

#include <libxo/xo.h>

int
xo_parse_args(int argc, char **argv);

int
xo_set_program(const char *name);

🌀 DESCRIPTION 🌀

okay so xo_parse_args() is the function that processes command-line arguments — the ones described in xo_options(7). it processes the libxo-specific options and removes them from the argument list, so the calling application does not need to process them. if it's successful, you get a new value for argc back. on failure, it emits a message and returns -1. 😭

like this, bestie:

argc = xo_parse_args(argc, argv);
if (argc < 0)
    exit(EXIT_FAILURE);

after the call to xo_parse_args(), the application can process the remaining arguments in a normal manner. no cap. 💖

xo_set_program() sets the name of the program as reported by functions like xo_failure(), xo_warn(), xo_err(), etc. the program name is initialized by xo_parse_args(), but subsequent calls to xo_set_program() can override this value. 🌸

⚠️ important note: the value is not copied, so the memory passed to xo_set_program() (and xo_parse_args()) must be maintained by the caller. don't let it get freed, bestie — protect that memory. 🫶

👀 SEE ALSO 👀

• xo_emit(3)
• xo_options(7,)
• libxo(3)

🕰️ HISTORY 🕰️

The libxo library first appeared in FreeBSD 11.0. iconic. ⭐

👑 AUTHORS 👑

libxo was written by Phil Shafer <phil@freebsd.org>. periodt. 💜

---

Debian • November 17, 2020 • LIBXO(3) — that's the footer, bestie, and we are so done. 🎀