Sponsor:

Your company here ā€” click to reach over 10,000 unique daily visitors

xo_err - Man Page

emit errors and warnings in multiple output styles

Library

Text, XML, JSON, and HTML Output Emission Library (libxo, -lxo)

Synopsis

#include <libxo/xo.h>

void
xo_warn(const char *fmt, ...);

void
xo_warnx(const char *fmt, ...);

void
xo_warn_c(int code, const char *fmt, ...);

void
xo_warn_hc(xo_handle_t *xop, int code, const char *fmt, ...);

void
xo_err(int eval, const char *fmt, ...);

void
xo_errc(int eval, int code, const char *fmt, ...);

void
xo_errx(int eval, const char *fmt, ...);

Description

Many programs make use of the standard library functions err(3) and warn(3) to generate errors and warnings for the user. libxo wants to pass that information via the current output style, and provides compatible functions to allow this.

The fmt argument is one compatible with printf(3) rather than xo_emit(3) to aid in simple conversion. This means these functions make unstructured data. To generate structured data, use the xo_emit_err(3) functions.

These functions display the program name, a colon, a formatted message based on the arguments, and then optionally a colon and an error message associated with either errno or the code parameter.

    EXAMPLE:
        if (open(filename, O_RDONLY) < 0)
            xo_err(1, "cannot open file '%s'", filename);

See Also

xo_emit(3), xo_emit_err(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.6.0. Complete documentation can be found on github:

https://juniper.github.io/libxo/1.6.0/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

The libxo library was added in FreeBSD 11.0.

Author

Phil Shafer

Referenced By

libxo(3), xo_emit_err(3).

December 4, 2014