man.bsd.lv manual page server

Manual Page Search Parameters
LIBXO(3) Library Functions Manual LIBXO(3)

xo_set_flags, xo_clear_flags — set operational flags for a libxo handle

library “libxo”

#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);

Use the () function to set the flags for a libxo handle. To use the default handle, pass a NULL handle.

The set of valid flags include:

 
Close file pointer on xo_destroy(3). This flag will trigger the call of the () (provided via xo_set_writer(3)) when the handle is destroyed.
Enable color and effects in output regardless of output device.
Allow color and effects if the output device is a terminal.
Display info data attributes (HTML)
Emit the key attribute (XML)
Log (via stderr) each gettext(3) string lookup
Log (via stderr) each syslog message (via xo_syslog(3))
Do not use the LIBXO_OPTIONS environment variable.
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.
Replaces hyphens with underscores
Display units (XML and HMTL)
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 () can be used as a breakpoint for a debugger, regardless of whether warnings are enabled.
Generate warnings in XML on stdout
Emit XPath expressions (HTML)
Force xo_emit(3) to return columns used
Flush output after each xo_emit(3) call

If the style is XO_STYLE_HTML, the following additional flags can be used:

 
Emit "data-xpath" attributes
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".

The () function turns off the given flags in a specific handle.

xo_emit(3), libxo(3)

The libxo library first appeared in FreeBSD 11.0.

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

December 4, 2014 FreeBSD-13.0