LIBXO(3)

✨ LIBXO(3) ✨ — Library Functions Manual 🎀

okay bestie, this is the libxo page, specifically the one about xo_set_flags and xo_clear_flags — the little switches that tell a libxo handle how to act. yes it's a library page, yes it's in section 3, and yes we're gonna get through every single flag together. 💅

---

📛 NAME

xo_set_flags, xo_clear_flags — set operational flags for a libxo handle

📚 LIBRARY

library “libxo” 🫶

✍️ SYNOPSIS

#include <libxo/xo.h>

void
xo_set_flags(xo_handle_t *handle, unsigned flags);

void
xo_clear_flags(xo_handle_t *handle, xo_xof_flags_t flags);

💖 DESCRIPTION

Use the xo_set_flags() function to set the flags for a libxo handle. And if you wanna use the default handle? just pass a NULL handle. easy. no notes. ✨

The set of valid flags include:

• XOF_CLOSE_FP — Close file pointer on xo_destroy(3). This flag will trigger the call of the close_func() (provided via xo_set_writer(3)) when the handle is destroyed. 👋 bye bye file pointer
• XOF_COLOR — Enable color and effects in output regardless of output device. 💅🌈
• XOF_COLOR_ALLOWED — Allow color and effects if the output device is a terminal. (more polite, lowkey)
• XOF_INFO — Display info data attributes (HTML)
• XOF_KEYS — Emit the key attribute (XML) 🔑
• XOF_LOG_GETTEXT — Log (via stderr) each gettext(3) string lookup 📝
• XOF_LOG_SYSLOG — Log (via stderr) each syslog message (via xo_syslog(3)) 📝
• XOF_NO_ENV — Do not use the LIBXO_OPTIONS environment variable. 🚫
• XOF_PRETTY — Make 'pretty printed' output, with the addition of indentation and newlines to enhance the readability of XML, JSON, and HTML output. Text output is not affected. 💅✨
• XOF_UNDERSCORES — Replaces hyphens with underscores
• XOF_UNITS — Display units (XML and HMTL)
• XOF_WARN — Generate warnings for broken calls, triggering diagnostic output (on standard error) when the library notices errors during operations, or with arguments to functions. Without warnings enabled, such conditions are ignored. Warnings allow developers to debug their interaction with libxo. The function xo_failure() can be used as a breakpoint for a debugger, regardless of whether warnings are enabled. 🚨 lowkey the most useful one fr fr
• XOF_WARN_XML — Generate warnings in XML on stdout
• XOF_XPATH — Emit XPath expressions (HTML)
• XOF_COLUMNS — Force xo_emit(3) to return columns used
• XOF_FLUSH — Flush output after each xo_emit(3) call 🚽✨

---

🌸 if the style is XO_STYLE_HTML…

the following additional flags can be used:

• XOF_XPATH — Emit "data-xpath" attributes
• XOF_INFO — Emit additional informational fields for HTML output. See xo_set_info(3) for details.

The XOF_XPATH flag enables the emission of XPath expressions detailing the hierarchy of XML elements used to encode the data field, if the XPATH style of output were requested.

---

🦋 if the style is XO_STYLE_XML…

the following additional flags can be used:

• XOF_KEYS — Add 'key' attribute to the XML encoding for field definitions that use the 'k' modifier. The key attribute has the value "key".

---

And the xo_clear_flags() function turns off the given flags in a specific handle. off they go, iconic behavior 🙈

👀 SEE ALSO

xo_emit(3), libxo(3)

🕰️ HISTORY

The libxo library first appeared in FreeBSD 11.0.

👑 AUTHORS

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

📖 ADDITIONAL DOCUMENTATION

FreeBSD uses libxo version 1.7.5. Complete documentation can be found on github:

https://juniper.github.io/libxo/1.7.5/html/index.html

libxo lives on github as:

https://github.com/Juniper/libxo

The latest release of libxo is available at:

https://github.com/Juniper/libxo/releases

🕰️ HISTORY (yes, again, bestie)

The libxo library was added in FreeBSD 11.0.

✍️ AUTHOR

Phil Shafer

---

🎀 that's the whole page, no cap. this one shipped from Debian, dated December 4, 2014, and it's the LIBXO(3) page you just read. go set some flags, you absolute main character. 💜✨🦋