xref: /freebsd/contrib/libxo/libxo/xo_emit.3 (revision 5b9c547c)
1.\" #
2.\" # Copyright (c) 2014, Juniper Networks, Inc.
3.\" # All rights reserved.
4.\" # This SOFTWARE is licensed under the LICENSE provided in the
5.\" # ../Copyright file. By downloading, installing, copying, or
6.\" # using the SOFTWARE, you agree to be bound by the terms of that
7.\" # LICENSE.
8.\" # Phil Shafer, July 2014
9.\"
10.Dd December 4, 2014
11.Dt LIBXO 3
12.Os
13.Sh NAME
14.Nm xo_emit
15.Nd emit formatted output based on format string and arguments
16.Sh LIBRARY
17.Lb libxo
18.Sh SYNOPSIS
19.In libxo/xo.h
20.Ft int
21.Fn xo_emit "const char *fmt"  "..."
22.Ft int
23.Fn xo_emit_h "xo_handle_t *xop" "const char *fmt" "..."
24.Ft int
25.Fn xo_emit_hv "xo_handle_t *xop" "const char *fmt" "va_list vap"
26.Sh DESCRIPTION
27The
28.Fn xo_emit
29function emits formatted output using the description in a format
30string along with a set of zero or more arguments, in a style similar
31to
32.Xr printf 3
33but using a more complex format description string, as described in
34.Xr xo_format 5 .
35.Pp
36.Fn xo_emit
37uses the default output handle, as described in
38.Xr libxo 3 ,
39where
40.Fn xo_emit_h
41uses an explicit handle.
42.Fn xo_emit_hv
43accepts a
44.Fa va_list
45for additional flexibility.
46.Sh ADDITIONAL DOCUMENTATION
47Complete documentation can be found on github:
48.Bd -literal -offset indent
49http://juniper.github.io/libxo/libxo-manual.html
50.Ed
51.Pp
52.Nm libxo
53lives on github as:
54.Bd -literal -offset indent
55https://github.com/Juniper/libxo
56.Ed
57.Pp
58The latest release of libxo is available at:
59.Bd -literal -offset indent
60https://github.com/Juniper/libxo/releases
61.Ed
62.Sh SEE ALSO
63.Xr xo_open_container 3 ,
64.Xr xo_open_list 3 ,
65.Xr xo_format 5
66.Sh HISTORY
67The
68.Nm libxo
69library was added in
70.Fx 11.0 .
71.Sh AUTHOR
72Phil Shafer
73