xref: /freebsd/contrib/libxo/libxo/xo_finish.3 (revision e0c4386e)
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_finish , xo_finish_h
15.Nd finish formatting output
16.Sh LIBRARY
17.Lb libxo
18.Sh SYNOPSIS
19.In libxo/xo.h
20.Ft xo_ssize_t
21.Fn xo_finish "void"
22.Ft xo_ssize_t
23.Fn xo_finish_h "xo_handle_t *xop"
24.Sh DESCRIPTION
25When the program is ready to exit or close a handle, a call to
26.Fn xo_finish
27is required.
28This flushes any buffered data, closes
29open
30.Nm libxo
31constructs, and completes any pending operations.
32.Pp
33Calling this function is
34.Em vital
35to the proper operation of libxo,
36especially for the non-TEXT output styles.
37.Sh SEE ALSO
38.Xr xo_emit 3 ,
39.Xr libxo 3
40.Sh HISTORY
41The
42.Nm libxo
43library first appeared in
44.Fx 11.0 .
45.Sh AUTHORS
46.Nm libxo
47was written by
48.An Phil Shafer Aq Mt phil@freebsd.org .
49
50