contrib/libxo/libxo/xo_set_style.3

   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 July, 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 void
  21 .Fn xo_set_style "xo_handle_t *handle" "unsigned style"
  22 .Ft int
  23 .Fn xo_set_style_name "xo_handle_t *handle" "const char *style"
  24 .Sh DESCRIPTION
  25 Use the
  26 .Fn xo_set_style
  27 function to set the output style for a handle.
  28 To use the default handle, pass a NULL handle.
  29 The set of output styles used by
  30 .Em libxo
  31 is:
  32 .Bl -column "XO_STYLE_TEXT12"
  33 .It Sy "Flag          Description"
  34 .It "XO_STYLE_TEXT  Traditional text output"
  35 .It "XO_STYLE_XML   XML encoded data"
  36 .It "XO_STYLE_JSON  JSON encoded data"
  37 .It "XO_STYLE_HTML  HTML encoded data"
  38 .El
  39 .Pp
  40 The
  41 .Fn xo_set_style_name
  42 function can be used to set the style based on a name
  43 encoded as a string.
  44 The name can be any of the styles: "text", "xml", "json", or "html".
  45 .Bd -literal -offset indent
  46     EXAMPLE:
  47         xo_set_style_name(NULL, "html");
  48 .Ed
  49 .Sh ADDITIONAL DOCUMENTATION
  50 .Pp
  51 Complete documentation can be found on github:
  52 .Bd -literal -offset indent
  53 http://juniper.github.io/libxo/libxo-manual.html
  54 .Ed
  55 .Pp
  56 libxo lives on github as:
  57 .Bd -literal -offset indent
  58 https://github.com/Juniper/libxo
  59 .Ed
  60 .Pp
  61 The latest release of libxo is available at:
  62 .Bd -literal -offset indent
  63 https://github.com/Juniper/libxo/releases
  64 .Ed
  65 .Sh SEE ALSO
  66 .Xr xo_emit 3
  67 .Sh HISTORY
  68 The
  69 .Fa libxo
  70 library was added in FreeBSD 11.0.
  71 .Sh AUTHOR
  72 Phil Shafer