xref: /freebsd/contrib/libarchive/libarchive/archive_write_finish_entry.3 (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
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.\" $FreeBSD$
26.\"
27.Dd February 28, 2017
28.Dt ARCHIVE_WRITE_FINISH_ENTRY 3
29.Os
30.Sh NAME
31.Nm archive_write_finish_entry
32.Nd functions for creating archives
33.Sh LIBRARY
34Streaming Archive Library (libarchive, -larchive)
35.Sh SYNOPSIS
36.In archive.h
37.Ft int
38.Fn archive_write_finish_entry "struct archive *"
39.Sh DESCRIPTION
40Close out the entry just written.
41In particular, this writes out the final padding required by some formats.
42Ordinarily, clients never need to call this, as it
43is called automatically by
44.Fn archive_write_header
45and
46.Fn archive_write_close
47as needed.
48For
49.Tn archive_write_disk
50handles, this flushes pending file attribute changes like modification time.
51.\" .Sh EXAMPLE
52.Sh RETURN VALUES
53This function returns
54.Cm ARCHIVE_OK
55on success, or one of several non-zero
56error codes for errors.
57Specific error codes include:
58.Cm ARCHIVE_RETRY
59for operations that might succeed if retried,
60.Cm ARCHIVE_WARN
61for unusual conditions that do not prevent further operations, and
62.Cm ARCHIVE_FATAL
63for serious errors that make remaining operations impossible.
64.\"
65.Sh ERRORS
66Detailed error codes and textual descriptions are available from the
67.Fn archive_errno
68and
69.Fn archive_error_string
70functions.
71.\"
72.Sh SEE ALSO
73.Xr tar 1 ,
74.Xr archive_write_data 3 ,
75.Xr archive_write_set_options 3 ,
76.Xr libarchive 3 ,
77.Xr cpio 5 ,
78.Xr mtree 5 ,
79.Xr tar 5
80