aboutsummaryrefslogtreecommitdiff
path: root/contrib/libxo/libxo/xo_set_style.3
blob: 83371ac71b15acc00718c5f81eda4836b4b92c7e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.\" #
.\" # Copyright (c) 2014, Juniper Networks, Inc.
.\" # All rights reserved.
.\" # This SOFTWARE is licensed under the LICENSE provided in the
.\" # ../Copyright file. By downloading, installing, copying, or 
.\" # using the SOFTWARE, you agree to be bound by the terms of that
.\" # LICENSE.
.\" # Phil Shafer, July 2014
.\" 
.Dd July, 2014
.Dt LIBXO 3
.Os
.Sh NAME
.Nm xo_emit
.Nd emit formatted output based on format string and arguments
.Sh LIBRARY
.Lb libxo
.Sh SYNOPSIS
.In libxo/xo.h
.Ft void
.Fn xo_set_style "xo_handle_t *handle" "unsigned style"
.Ft int
.Fn xo_set_style_name "xo_handle_t *handle" "const char *style"
.Sh DESCRIPTION
Use the
.Fn xo_set_style
function to set the output style for a handle.
To use the default handle, pass a NULL handle.
The set of output styles used by
.Em libxo
is:
.Bl -column "XO_STYLE_TEXT12"
.It Sy "Flag          Description"
.It "XO_STYLE_TEXT  Traditional text output"
.It "XO_STYLE_XML   XML encoded data"
.It "XO_STYLE_JSON  JSON encoded data"
.It "XO_STYLE_HTML  HTML encoded data"
.El
.Pp
The
.Fn xo_set_style_name
function can be used to set the style based on a name
encoded as a string.
The name can be any of the styles: "text", "xml", "json", or "html".
.Bd -literal -offset indent
    EXAMPLE:
        xo_set_style_name(NULL, "html");
.Ed
.Sh ADDITIONAL DOCUMENTATION
.Pp
Complete documentation can be found on github:
.Bd -literal -offset indent
http://juniper.github.io/libxo/libxo-manual.html
.Ed
.Pp
libxo lives on github as:
.Bd -literal -offset indent
https://github.com/Juniper/libxo
.Ed
.Pp
The latest release of libxo is available at:
.Bd -literal -offset indent
https://github.com/Juniper/libxo/releases
.Ed
.Sh SEE ALSO
.Xr xo_emit 3
.Sh HISTORY
The
.Fa libxo
library was added in FreeBSD 11.0.
.Sh AUTHOR
Phil Shafer