46ab065716
Documentation, style, test suite changes and typo fixes. New bsdtar tests for --acls and --fflags options.
80 lines
2.7 KiB
Groff
80 lines
2.7 KiB
Groff
.\" Copyright (c) 2003-2011 Tim Kientzle
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd February 28, 2017
|
|
.Dt ARCHIVE_WRITE_FINISH_ENTRY 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm archive_write_finish_entry
|
|
.Nd functions for creating archives
|
|
.Sh LIBRARY
|
|
Streaming Archive Library (libarchive, -larchive)
|
|
.Sh SYNOPSIS
|
|
.In archive.h
|
|
.Ft int
|
|
.Fn archive_write_finish_entry "struct archive *"
|
|
.Sh DESCRIPTION
|
|
Close out the entry just written.
|
|
In particular, this writes out the final padding required by some formats.
|
|
Ordinarily, clients never need to call this, as it
|
|
is called automatically by
|
|
.Fn archive_write_header
|
|
and
|
|
.Fn archive_write_close
|
|
as needed.
|
|
For
|
|
.Tn archive_write_disk
|
|
handles, this flushes pending file attribute changes like modification time.
|
|
.\" .Sh EXAMPLE
|
|
.Sh RETURN VALUES
|
|
This function returns
|
|
.Cm ARCHIVE_OK
|
|
on success, or one of several non-zero
|
|
error codes for errors.
|
|
Specific error codes include:
|
|
.Cm ARCHIVE_RETRY
|
|
for operations that might succeed if retried,
|
|
.Cm ARCHIVE_WARN
|
|
for unusual conditions that do not prevent further operations, and
|
|
.Cm ARCHIVE_FATAL
|
|
for serious errors that make remaining operations impossible.
|
|
.\"
|
|
.Sh ERRORS
|
|
Detailed error codes and textual descriptions are available from the
|
|
.Fn archive_errno
|
|
and
|
|
.Fn archive_error_string
|
|
functions.
|
|
.\"
|
|
.Sh SEE ALSO
|
|
.Xr tar 1 ,
|
|
.Xr libarchive 3 ,
|
|
.Xr archive_write_data 3 ,
|
|
.Xr archive_write_set_options 3 ,
|
|
.Xr cpio 5 ,
|
|
.Xr mtree 5 ,
|
|
.Xr tar 5
|