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 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_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.  This flushes any buffered data, closes
  28 open
  29 .Em libxo
  30 constructs, and completes any pending operations.
  31 .Pp
  32 Calling this function is
  33 .Em vital
  34 to the proper operation of libxo,
  35 especially for the non-TEXT output styles.
  36 .Sh ADDITIONAL DOCUMENTATION
  37 .Pp
  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 libxo lives on github as:
  44 .Bd -literal -offset indent
  45 https://github.com/Juniper/libxo
  46 .Ed
  47 .Pp
  48 The latest release of libxo is available at:
  49 .Bd -literal -offset indent
  50 https://github.com/Juniper/libxo/releases
  51 .Ed
  52 .Sh SEE ALSO
  53 .Xr xo_emit 3
  54 .Sh HISTORY
  55 The
  56 .Fa libxo
  57 library was added in FreeBSD 11.0.
  58 .Sh AUTHOR
  59 Phil Shafer