contrib/libxo/libxo/xo_finish.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 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 void
  21 .Fn xo_finish "void"
  22 .Ft void
  23 .Fn xo_finish_h "xo_handle_t *xop"
  24 .Sh DESCRIPTION
  25 When the program is ready to exit or close a handle, a call to
  26 .Fn xo_finish
  27 is required.
  28 This flushes any buffered data, closes
  29 open
  30 .Nm libxo
  31 constructs, and completes any pending operations.
  32 .Pp
  33 Calling this function is
  34 .Em vital
  35 to the proper operation of libxo,
  36 especially for the non-TEXT output styles.
  37 .Sh ADDITIONAL DOCUMENTATION
  38 Complete documentation can be found on github:
  39 .Bd -literal -offset indent
  40 http://juniper.github.io/libxo/libxo-manual.html
  41 .Ed
  42 .Pp
  43 .Nm libxo
  44 lives on github as:
  45 .Bd -literal -offset indent
  46 https://github.com/Juniper/libxo
  47 .Ed
  48 .Pp
  49 The latest release of
  50 .Nm libxo
  51 is available at:
  52 .Bd -literal -offset indent
  53 https://github.com/Juniper/libxo/releases
  54 .Ed
  55 .Sh SEE ALSO
  56 .Xr xo_emit 3
  57 .Sh HISTORY
  58 The
  59 .Nm libxo
  60 library was added in
  61 .Fx 11.0 .
  62 .Sh AUTHOR
  63 Phil Shafer