xref: /freebsd/contrib/libarchive/libarchive/archive_write_finish_entry.3 (revision b9128a37faafede823eb456aa65a11ac69997284)
1.\" Copyright (c) 2003-2011 Tim Kientzle
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd February 28, 2017
26.Dt ARCHIVE_WRITE_FINISH_ENTRY 3
27.Os
28.Sh NAME
29.Nm archive_write_finish_entry
30.Nd functions for creating archives
31.Sh LIBRARY
32Streaming Archive Library (libarchive, -larchive)
33.Sh SYNOPSIS
34.In archive.h
35.Ft int
36.Fn archive_write_finish_entry "struct archive *"
37.Sh DESCRIPTION
38Close out the entry just written.
39In particular, this writes out the final padding required by some formats.
40Ordinarily, clients never need to call this, as it
41is called automatically by
42.Fn archive_write_header
43and
44.Fn archive_write_close
45as needed.
46For
47.Tn archive_write_disk
48handles, this flushes pending file attribute changes like modification time.
49.\" .Sh EXAMPLE
50.Sh RETURN VALUES
51This function returns
52.Cm ARCHIVE_OK
53on success, or one of several non-zero
54error codes for errors.
55Specific error codes include:
56.Cm ARCHIVE_RETRY
57for operations that might succeed if retried,
58.Cm ARCHIVE_WARN
59for unusual conditions that do not prevent further operations, and
60.Cm ARCHIVE_FATAL
61for serious errors that make remaining operations impossible.
62.\"
63.Sh ERRORS
64Detailed error codes and textual descriptions are available from the
65.Fn archive_errno
66and
67.Fn archive_error_string
68functions.
69.\"
70.Sh SEE ALSO
71.Xr tar 1 ,
72.Xr archive_write_data 3 ,
73.Xr archive_write_set_options 3 ,
74.Xr libarchive 3 ,
75.Xr cpio 5 ,
76.Xr mtree 5 ,
77.Xr tar 5
78