xref: /freebsd/contrib/libarchive/libarchive/archive_write_finish_entry.3 (revision 147972555f2c70f64cc54182dc18326456e46b92)
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: head/lib/libarchive/archive_write.3 201110 2009-12-28 03:31:29Z kientzle $
26.\"
27.Dd March 23, 2011
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 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_next_header
43and
44.Fn archive_write_close
45as needed.
46.\" .Sh EXAMPLE
47.Sh RETURN VALUES
48This function returns
49.Cm ARCHIVE_OK
50on success, or one of several non-zero
51error codes for errors.
52Specific error codes include:
53.Cm ARCHIVE_RETRY
54for operations that might succeed if retried,
55.Cm ARCHIVE_WARN
56for unusual conditions that do not prevent further operations, and
57.Cm ARCHIVE_FATAL
58for serious errors that make remaining operations impossible.
59.\"
60.Sh ERRORS
61Detailed error codes and textual descriptions are available from the
62.Fn archive_errno
63and
64.Fn archive_error_string
65functions.
66.\"
67.Sh SEE ALSO
68.Xr tar 1 ,
69.Xr libarchive 3 ,
70.Xr archive_write_data 3 ,
71.Xr archive_write_set_options 3 ,
72.Xr cpio 5 ,
73.Xr mtree 5 ,
74.Xr tar 5
75